From 5ecf148c510023b8bda36a80ad5d82581b8d5fbf Mon Sep 17 00:00:00 2001 From: Adam Bull Date: Wed, 5 Nov 2025 16:38:00 +0000 Subject: [PATCH 1/2] feat: oss --- LICENSE | 94 + README.md | 428 +- examples/custom/README.md | 36 - examples/custom/next-env.d.ts | 6 - examples/custom/next.config.ts | 29 - examples/custom/package.json | 39 - .../custom/public/mistral-try-it-now/deps.js | 41456 ------ .../public/mistral-try-it-now/tsworker.js | 118 - .../public/mistral-try-it-now/types.d.ts | 18932 --- examples/custom/speakeasy.mistral.config.mjs | 59 - examples/custom/speakeasy.pokeapi.config.mjs | 46 - examples/custom/src/app/favicon.ico | Bin 25931 -> 0 bytes examples/custom/src/app/globals.css | 30 - examples/custom/src/app/layout.tsx | 43 - .../app/mistral/api/endpoint/agents/page.mdx | 5592 - .../endpoint/audio/transcriptions/page.mdx | 2038 - .../app/mistral/api/endpoint/batch/page.mdx | 2810 - .../mistral/api/endpoint/beta/agents/page.mdx | 10422 -- .../api/endpoint/beta/conversations/page.mdx | 39978 ----- .../endpoint/beta/libraries/accesses/page.mdx | 2096 - .../beta/libraries/documents/page.mdx | 6567 - .../api/endpoint/beta/libraries/page.mdx | 3786 - .../app/mistral/api/endpoint/chat/page.mdx | 7099 - .../mistral/api/endpoint/classifiers/page.mdx | 8244 - .../mistral/api/endpoint/embeddings/page.mdx | 983 - .../app/mistral/api/endpoint/files/page.mdx | 2637 - .../src/app/mistral/api/endpoint/fim/page.mdx | 3635 - .../mistral/api/endpoint/fine-tuning/page.mdx | 14280 -- .../app/mistral/api/endpoint/models/page.mdx | 5624 - .../src/app/mistral/api/endpoint/ocr/page.mdx | 1976 - examples/custom/src/app/mistral/api/page.mdx | 18 - examples/custom/src/app/mistral/layout.tsx | 26 - examples/custom/src/app/mistral/page.tsx | 5 - .../src/app/mistral/sidebarMetadata.json | 4582 - examples/custom/src/app/page.tsx | 14 - .../app/pokeapi/api/endpoint/berries/page.mdx | 3160 - .../pokeapi/api/endpoint/contests/page.mdx | 2885 - .../pokeapi/api/endpoint/encounters/page.mdx | 3474 - .../pokeapi/api/endpoint/evolution/page.mdx | 1833 - .../app/pokeapi/api/endpoint/games/page.mdx | 4913 - .../app/pokeapi/api/endpoint/items/page.mdx | 5978 - .../pokeapi/api/endpoint/location/page.mdx | 4707 - .../pokeapi/api/endpoint/machines/page.mdx | 971 - .../app/pokeapi/api/endpoint/moves/page.mdx | 7803 - .../app/pokeapi/api/endpoint/pokemon/page.mdx | 20418 --- .../app/pokeapi/api/endpoint/utility/page.mdx | 956 - examples/custom/src/app/pokeapi/api/page.mdx | 33 - examples/custom/src/app/pokeapi/layout.tsx | 26 - examples/custom/src/app/pokeapi/page.tsx | 5 - .../src/app/pokeapi/sidebarMetadata.json | 6209 - examples/custom/src/app/speakeasy.css | 73 - examples/custom/src/components/Sidebar.tsx | 148 - examples/custom/src/components/mdx.tsx | 59 - .../components/speakeasy-custom/Operation.tsx | 66 - .../src/components/speakeasy-custom/index.tsx | 3 - .../custom/src/components/styles.module.css | 58 - examples/custom/src/mdx-components.module.css | 47 - examples/custom/src/mdx-components.tsx | 17 - examples/custom/tsconfig.json | 28 - examples/docusaurus/.gitignore | 20 - examples/docusaurus/README.md | 41 - .../docusaurus/docs/glean/api/_category_.json | 6 - .../docs/glean/api/endpoint/_category_.json | 6 - .../glean/api/endpoint/client/activity.mdx | 2114 - .../docs/glean/api/endpoint/client/agents.mdx | 2509 - .../api/endpoint/client/announcements.mdx | 5301 - .../glean/api/endpoint/client/answers.mdx | 9352 -- .../api/endpoint/client/authentication.mdx | 248 - .../docs/glean/api/endpoint/client/chat.mdx | 5839 - .../glean/api/endpoint/client/collections.mdx | 12345 -- .../glean/api/endpoint/client/documents.mdx | 2187 - .../glean/api/endpoint/client/entities.mdx | 2903 - .../client/governance/data/reports.mdx | 4648 - .../documents/visibilityoverrides.mdx | 737 - .../glean/api/endpoint/client/insights.mdx | 3076 - .../glean/api/endpoint/client/messages.mdx | 1825 - .../docs/glean/api/endpoint/client/pins.mdx | 3152 - .../docs/glean/api/endpoint/client/search.mdx | 16037 -- .../glean/api/endpoint/client/shortcuts.mdx | 5407 - .../docs/glean/api/endpoint/client/tools.mdx | 906 - .../api/endpoint/client/verification.mdx | 1614 - .../api/endpoint/indexing/authentication.mdx | 270 - .../api/endpoint/indexing/datasource.mdx | 333 - .../api/endpoint/indexing/datasources.mdx | 2946 - .../glean/api/endpoint/indexing/documents.mdx | 5691 - .../glean/api/endpoint/indexing/people.mdx | 4636 - .../api/endpoint/indexing/permissions.mdx | 3697 - .../glean/api/endpoint/indexing/shortcuts.mdx | 1137 - examples/docusaurus/docs/glean/api/index.mdx | 40 - .../docs/mistral/api/_category_.json | 6 - .../docs/mistral/api/endpoint/_category_.json | 6 - .../docs/mistral/api/endpoint/agents.mdx | 15328 -- .../api/endpoint/audio/transcriptions.mdx | 4999 - .../docs/mistral/api/endpoint/batch.mdx | 7258 - .../docs/mistral/api/endpoint/beta/agents.mdx | 28289 ---- .../api/endpoint/beta/conversations.mdx | 116057 --------------- .../mistral/api/endpoint/beta/libraries.mdx | 9707 -- .../api/endpoint/beta/libraries/accesses.mdx | 4632 - .../api/endpoint/beta/libraries/documents.mdx | 14964 -- .../docs/mistral/api/endpoint/chat.mdx | 19635 --- .../docs/mistral/api/endpoint/classifiers.mdx | 21801 --- .../docs/mistral/api/endpoint/embeddings.mdx | 2085 - .../docs/mistral/api/endpoint/files.mdx | 4333 - .../docs/mistral/api/endpoint/fim.mdx | 9538 -- .../docs/mistral/api/endpoint/fine-tuning.mdx | 39609 ----- .../docs/mistral/api/endpoint/models.mdx | 13135 -- .../docs/mistral/api/endpoint/ocr.mdx | 4903 - .../docusaurus/docs/mistral/api/index.mdx | 39 - .../docs/pokeapi/api/_category_.json | 6 - .../docs/pokeapi/api/endpoint/_category_.json | 6 - .../docs/pokeapi/api/endpoint/berries.mdx | 2976 - .../docs/pokeapi/api/endpoint/contests.mdx | 2695 - .../docs/pokeapi/api/endpoint/encounters.mdx | 3244 - .../docs/pokeapi/api/endpoint/evolution.mdx | 1708 - .../docs/pokeapi/api/endpoint/games.mdx | 4667 - .../docs/pokeapi/api/endpoint/items.mdx | 5667 - .../docs/pokeapi/api/endpoint/location.mdx | 4461 - .../docs/pokeapi/api/endpoint/machines.mdx | 911 - .../docs/pokeapi/api/endpoint/moves.mdx | 7427 - .../docs/pokeapi/api/endpoint/pokemon.mdx | 19425 --- .../docs/pokeapi/api/endpoint/utility.mdx | 896 - .../docusaurus/docs/pokeapi/api/index.mdx | 39 - examples/docusaurus/docusaurus.config.ts | 173 - examples/docusaurus/package.json | 52 - .../public/glean-try-it-now/deps.js | 24727 --- .../public/glean-try-it-now/tsworker.js | 118 - .../public/glean-try-it-now/types.d.ts | 33387 ----- .../public/mistral-try-it-now/deps.js | 41456 ------ .../mistralai-1.9.11-py3-none-any.whl | 3 - .../public/mistral-try-it-now/pyworker.js | 80 - .../public/mistral-try-it-now/tsworker.js | 118 - .../public/mistral-try-it-now/types.d.ts | 18932 --- examples/docusaurus/sidebars.ts | 33 - .../docusaurus/speakeasy.glean.config.mjs | 24 - .../docusaurus/speakeasy.mistral.config.mjs | 32 - .../docusaurus/speakeasy.pokeapi.config.mjs | 7 - .../src/components/HomepageFeatures/index.tsx | 37 - .../HomepageFeatures/styles.module.css | 6 - .../glean-embeds/contents/action.mdx | 142 - .../glean-embeds/contents/actioncounts.mdx | 242 - .../glean-embeds/contents/activedaycount.mdx | 146 - .../glean-embeds/contents/activities.mdx | 190 - .../glean-embeds/contents/activitycount.mdx | 146 - .../contents/activityinsights.mdx | 228 - .../glean-embeds/contents/actor.mdx | 190 - .../glean-embeds/contents/addedroles.mdx | 180 - .../contents/additionalfields.mdx | 155 - .../contents/additionalquerysuggestions.mdx | 129 - .../glean-embeds/contents/agentconfig.mdx | 123 - .../contents/aggregatevisitcount.mdx | 146 - .../glean-embeds/contents/aiappinsights.mdx | 228 - .../contents/allclusteredresults.mdx | 162 - .../contents/allowedgroupintersections.mdx | 92 - .../glean-embeds/contents/allowedusers.mdx | 136 - .../contents/allowlistoptions.mdx | 98 - .../glean-embeds/contents/announcement.mdx | 757 - .../glean-embeds/contents/answer.mdx | 852 - .../glean-embeds/contents/answerauthor.mdx | 190 - .../glean-embeds/contents/answerboard.mdx | 459 - .../components/glean-embeds/contents/app.mdx | 160 - .../glean-embeds/contents/assignee.mdx | 190 - .../contents/assistantinsights.mdx | 228 - .../glean-embeds/contents/attachments.mdx | 687 - .../glean-embeds/contents/attendees.mdx | 252 - .../glean-embeds/contents/attribution.mdx | 175 - .../glean-embeds/contents/audiencefilters.mdx | 173 - .../glean-embeds/contents/author.mdx | 190 - .../glean-embeds/contents/authtokens.mdx | 192 - .../glean-embeds/contents/backlinkresults.mdx | 672 - .../glean-embeds/contents/banner.mdx | 110 - .../glean-embeds/contents/board.mdx | 470 - .../components/glean-embeds/contents/body.mdx | 136 - .../contents/broadsharingoptions.mdx | 261 - .../glean-embeds/contents/buckets.mdx | 208 - .../contents/candidateverifiers.mdx | 196 - .../glean-embeds/contents/capabilities.mdx | 148 - .../contents/categorytoresultsize.mdx | 42 - .../components/glean-embeds/contents/chat.mdx | 413 - .../glean-embeds/contents/chatsuggestion.mdx | 110 - .../glean-embeds/contents/chattranscript.mdx | 231 - .../chatzerostatesuggestionoptions.mdx | 85 - .../glean-embeds/contents/children.mdx | 723 - .../glean-embeds/contents/citation.mdx | 260 - .../glean-embeds/contents/citations.mdx | 260 - .../glean-embeds/contents/classifications.mdx | 111 - .../glean-embeds/contents/clickcount.mdx | 146 - .../contents/clusteredresults.mdx | 698 - .../components/glean-embeds/contents/code.mdx | 178 - .../glean-embeds/contents/collection.mdx | 757 - .../glean-embeds/contents/collectionitem.mdx | 417 - .../glean-embeds/contents/collections.mdx | 774 - .../contents/combinedanswertext.mdx | 119 - .../glean-embeds/contents/comments.mdx | 270 - .../glean-embeds/contents/company.mdx | 416 - .../glean-embeds/contents/conferencedata.mdx | 123 - .../glean-embeds/contents/config.mdx | 523 - .../contents/containerdocument.mdx | 358 - .../glean-embeds/contents/content.mdx | 104 - .../glean-embeds/contents/context.mdx | 396 - .../glean-embeds/contents/countinfo.mdx | 152 - .../glean-embeds/contents/createdby.mdx | 175 - .../glean-embeds/contents/creator.mdx | 175 - .../glean-embeds/contents/customentity.mdx | 270 - .../glean-embeds/contents/customer.mdx | 375 - .../glean-embeds/contents/customfields.mdx | 159 - .../contents/customproperties.mdx | 117 - .../glean-embeds/contents/customtimerange.mdx | 135 - .../contents/datasourceprofiles.mdx | 202 - .../glean-embeds/contents/debuginfo.mdx | 159 - .../contents/destinationdocument.mdx | 396 - .../glean-embeds/contents/digest.mdx | 188 - .../glean-embeds/contents/disambiguation.mdx | 148 - .../glean-embeds/contents/document.mdx | 396 - .../contents/documentinsights.mdx | 174 - .../glean-embeds/contents/documents.mdx | 402 - .../contents/documentvisitorcount.mdx | 146 - .../glean-embeds/contents/eligiblepins.mdx | 127 - .../glean-embeds/contents/emails.mdx | 130 - .../components/glean-embeds/contents/end.mdx | 110 - .../glean-embeds/contents/event.mdx | 457 - .../glean-embeds/contents/exclusions.mdx | 85 - .../glean-embeds/contents/existingpins.mdx | 141 - .../glean-embeds/contents/externallinks.mdx | 165 - .../contents/externalsharingoptions.mdx | 280 - .../glean-embeds/contents/extractedqna.mdx | 150 - .../contents/facetbucketfilter.mdx | 110 - .../glean-embeds/contents/facetfilters.mdx | 173 - .../glean-embeds/contents/facetfiltersets.mdx | 115 - .../glean-embeds/contents/facetresults.mdx | 243 - .../glean-embeds/contents/favoriteinfo.mdx | 154 - .../components/glean-embeds/contents/file.mdx | 221 - .../glean-embeds/contents/filters.mdx | 173 - .../glean-embeds/contents/followupactions.mdx | 223 - .../glean-embeds/contents/fragments.mdx | 315 - .../contents/generatedattachments.mdx | 280 - .../glean-embeds/contents/generatedqna.mdx | 296 - .../contents/generatedqnaresult.mdx | 296 - .../glean-embeds/contents/gleandataerror.mdx | 35 - .../glean-embeds/contents/group.mdx | 160 - .../glean-embeds/contents/groupattendees.mdx | 158 - .../glean-embeds/contents/hotwords.mdx | 121 - .../components/glean-embeds/contents/icon.mdx | 243 - .../glean-embeds/contents/iconconfig.mdx | 243 - .../glean-embeds/contents/implementations.mdx | 212 - .../contents/inactiveinsights.mdx | 228 - .../glean-embeds/contents/inclusions.mdx | 85 - .../glean-embeds/contents/inputdetails.mdx | 85 - .../glean-embeds/contents/inputoptions.mdx | 238 - .../glean-embeds/contents/interactions.mdx | 130 - .../glean-embeds/contents/items.mdx | 412 - .../glean-embeds/contents/lastreminder.mdx | 205 - .../glean-embeds/contents/lastverifier.mdx | 190 - .../glean-embeds/contents/likedby.mdx | 121 - .../glean-embeds/contents/likes.mdx | 146 - .../glean-embeds/contents/lines.mdx | 140 - .../contents/lowperformingqueryinsights.mdx | 281 - .../glean-embeds/contents/meeting.mdx | 209 - .../glean-embeds/contents/members.mdx | 178 - .../glean-embeds/contents/mergedcustomers.mdx | 337 - .../glean-embeds/contents/messages.mdx | 144 - .../glean-embeds/contents/metadata.mdx | 68 - .../contents/mustincludesuggestions.mdx | 118 - .../glean-embeds/contents/objects.mdx | 127 - .../contents/operatormetadata.mdx | 228 - .../glean-embeds/contents/owner.mdx | 136 - .../glean-embeds/contents/parameters.mdx | 237 - .../glean-embeds/contents/params.mdx | 285 - .../glean-embeds/contents/parentdocument.mdx | 343 - .../glean-embeds/contents/people.mdx | 204 - .../glean-embeds/contents/period.mdx | 180 - .../glean-embeds/contents/permissions.mdx | 102 - .../glean-embeds/contents/person.mdx | 190 - .../glean-embeds/contents/pinmetadata.mdx | 150 - .../components/glean-embeds/contents/pins.mdx | 293 - .../components/glean-embeds/contents/poc.mdx | 181 - .../glean-embeds/contents/possiblevalues.mdx | 123 - .../glean-embeds/contents/primaryentry.mdx | 788 - .../glean-embeds/contents/prompttemplate.mdx | 159 - .../glean-embeds/contents/properties.mdx | 158 - .../contents/propertydefinitions.mdx | 279 - .../glean-embeds/contents/propertygroups.mdx | 123 - .../glean-embeds/contents/proximity.mdx | 97 - .../glean-embeds/contents/queryinsights.mdx | 281 - .../glean-embeds/contents/querysuggestion.mdx | 316 - .../contents/querysuggestions.mdx | 118 - .../glean-embeds/contents/questionresult.mdx | 680 - .../glean-embeds/contents/quicklink.mdx | 240 - .../glean-embeds/contents/ranges.mdx | 203 - .../glean-embeds/contents/referenceranges.mdx | 155 - .../contents/relateddocuments.mdx | 236 - .../glean-embeds/contents/relatedobjects.mdx | 102 - .../glean-embeds/contents/relatedquestion.mdx | 152 - .../glean-embeds/contents/relatedresults.mdx | 225 - .../glean-embeds/contents/relationships.mdx | 123 - .../glean-embeds/contents/reminders.mdx | 211 - .../glean-embeds/contents/removedroles.mdx | 169 - .../glean-embeds/contents/requestoptions.mdx | 571 - .../glean-embeds/contents/requestor.mdx | 190 - .../contents/responsemetadata.mdx | 42 - .../glean-embeds/contents/resultdocuments.mdx | 104 - .../glean-embeds/contents/results.mdx | 757 - .../contents/resultsdescription.mdx | 127 - .../glean-embeds/contents/resulttabs.mdx | 166 - .../contents/rewrittenfacetfilters.mdx | 173 - .../glean-embeds/contents/roles.mdx | 169 - .../glean-embeds/contents/runcount.mdx | 146 - .../glean-embeds/contents/scopes.mdx | 97 - .../glean-embeds/contents/searchcount.mdx | 146 - .../contents/searchedqueryranges.mdx | 203 - .../glean-embeds/contents/searchorcount.mdx | 146 - .../contents/searchproviderinfo.mdx | 135 - .../glean-embeds/contents/searchwarning.mdx | 160 - .../contents/searchwithclickcount.mdx | 146 - .../contents/secondaryentries.mdx | 794 - .../glean-embeds/contents/sections.mdx | 116 - .../contents/sensitivecontentoptions.mdx | 207 - .../contents/sensitiveinfotypes.mdx | 110 - .../contents/sensitiveregexes.mdx | 133 - .../glean-embeds/contents/sensitiveterms.mdx | 133 - .../glean-embeds/contents/sessioninfo.mdx | 160 - .../glean-embeds/contents/shortcut.mdx | 690 - .../contents/shortcutinsights.mdx | 174 - .../glean-embeds/contents/similarqueries.mdx | 237 - .../glean-embeds/contents/snippets.mdx | 233 - .../glean-embeds/contents/socialnetworks.mdx | 148 - .../glean-embeds/contents/sourcedocument.mdx | 396 - .../glean-embeds/contents/sourcefile.mdx | 221 - .../glean-embeds/contents/sourceperson.mdx | 190 - .../glean-embeds/contents/start.mdx | 110 - .../glean-embeds/contents/status.mdx | 249 - .../glean-embeds/contents/structuredlist.mdx | 205 - .../contents/structuredlocation.mdx | 298 - .../contents/structuredresult.mdx | 842 - .../contents/structuredresults.mdx | 805 - .../glean-embeds/contents/suggestions.mdx | 316 - .../glean-embeds/contents/summary.mdx | 142 - .../glean-embeds/contents/target.mdx | 110 - .../components/glean-embeds/contents/team.mdx | 696 - .../glean-embeds/contents/teams.mdx | 148 - .../glean-embeds/contents/textrange.mdx | 203 - .../glean-embeds/contents/thumbnail.mdx | 110 - .../components/glean-embeds/contents/time.mdx | 110 - .../glean-embeds/contents/uiconfig.mdx | 35 - .../glean-embeds/contents/updatedby.mdx | 175 - .../contents/uploadedpermissions.mdx | 238 - .../components/glean-embeds/contents/user.mdx | 190 - .../glean-embeds/contents/value.mdx | 202 - .../glean-embeds/contents/values.mdx | 150 - .../glean-embeds/contents/verification.mdx | 121 - .../glean-embeds/contents/viewcount.mdx | 146 - .../glean-embeds/contents/viewerinfo.mdx | 35 - .../glean-embeds/contents/visitcount.mdx | 146 - .../glean-embeds/contents/visitorcount.mdx | 146 - .../glean-embeds/contents/workflow.mdx | 59 - .../glean-embeds/contents/write.mdx | 173 - .../glean-embeds/loaders/action.tsx | 14 - .../glean-embeds/loaders/actioncounts.tsx | 14 - .../glean-embeds/loaders/activedaycount.tsx | 14 - .../glean-embeds/loaders/activities.tsx | 14 - .../glean-embeds/loaders/activitycount.tsx | 14 - .../glean-embeds/loaders/activityinsights.tsx | 14 - .../components/glean-embeds/loaders/actor.tsx | 14 - .../glean-embeds/loaders/addedroles.tsx | 14 - .../glean-embeds/loaders/additionalfields.tsx | 14 - .../loaders/additionalquerysuggestions.tsx | 14 - .../glean-embeds/loaders/agentconfig.tsx | 14 - .../loaders/aggregatevisitcount.tsx | 14 - .../glean-embeds/loaders/aiappinsights.tsx | 14 - .../loaders/allclusteredresults.tsx | 14 - .../loaders/allowedgroupintersections.tsx | 14 - .../glean-embeds/loaders/allowedusers.tsx | 14 - .../glean-embeds/loaders/allowlistoptions.tsx | 14 - .../glean-embeds/loaders/announcement.tsx | 14 - .../glean-embeds/loaders/answer.tsx | 14 - .../glean-embeds/loaders/answerauthor.tsx | 14 - .../glean-embeds/loaders/answerboard.tsx | 14 - .../components/glean-embeds/loaders/app.tsx | 14 - .../glean-embeds/loaders/assignee.tsx | 14 - .../loaders/assistantinsights.tsx | 14 - .../glean-embeds/loaders/attachments.tsx | 14 - .../glean-embeds/loaders/attendees.tsx | 14 - .../glean-embeds/loaders/attribution.tsx | 14 - .../glean-embeds/loaders/audiencefilters.tsx | 14 - .../glean-embeds/loaders/author.tsx | 14 - .../glean-embeds/loaders/authtokens.tsx | 14 - .../glean-embeds/loaders/backlinkresults.tsx | 14 - .../glean-embeds/loaders/banner.tsx | 14 - .../components/glean-embeds/loaders/board.tsx | 14 - .../components/glean-embeds/loaders/body.tsx | 14 - .../loaders/broadsharingoptions.tsx | 14 - .../glean-embeds/loaders/buckets.tsx | 14 - .../loaders/candidateverifiers.tsx | 14 - .../glean-embeds/loaders/capabilities.tsx | 14 - .../loaders/categorytoresultsize.tsx | 14 - .../components/glean-embeds/loaders/chat.tsx | 14 - .../glean-embeds/loaders/chatsuggestion.tsx | 14 - .../glean-embeds/loaders/chattranscript.tsx | 14 - .../chatzerostatesuggestionoptions.tsx | 14 - .../glean-embeds/loaders/children.tsx | 14 - .../glean-embeds/loaders/citation.tsx | 14 - .../glean-embeds/loaders/citations.tsx | 14 - .../glean-embeds/loaders/classifications.tsx | 14 - .../glean-embeds/loaders/clickcount.tsx | 14 - .../glean-embeds/loaders/clusteredresults.tsx | 14 - .../components/glean-embeds/loaders/code.tsx | 14 - .../glean-embeds/loaders/collection.tsx | 14 - .../glean-embeds/loaders/collectionitem.tsx | 14 - .../glean-embeds/loaders/collections.tsx | 14 - .../loaders/combinedanswertext.tsx | 14 - .../glean-embeds/loaders/comments.tsx | 14 - .../glean-embeds/loaders/company.tsx | 14 - .../glean-embeds/loaders/conferencedata.tsx | 14 - .../glean-embeds/loaders/config.tsx | 14 - .../loaders/containerdocument.tsx | 14 - .../glean-embeds/loaders/content.tsx | 14 - .../glean-embeds/loaders/context.tsx | 14 - .../glean-embeds/loaders/countinfo.tsx | 14 - .../glean-embeds/loaders/createdby.tsx | 14 - .../glean-embeds/loaders/creator.tsx | 14 - .../glean-embeds/loaders/customentity.tsx | 14 - .../glean-embeds/loaders/customer.tsx | 14 - .../glean-embeds/loaders/customfields.tsx | 14 - .../glean-embeds/loaders/customproperties.tsx | 14 - .../glean-embeds/loaders/customtimerange.tsx | 14 - .../loaders/datasourceprofiles.tsx | 14 - .../glean-embeds/loaders/debuginfo.tsx | 14 - .../loaders/destinationdocument.tsx | 14 - .../glean-embeds/loaders/digest.tsx | 14 - .../glean-embeds/loaders/disambiguation.tsx | 14 - .../glean-embeds/loaders/document.tsx | 14 - .../glean-embeds/loaders/documentinsights.tsx | 14 - .../glean-embeds/loaders/documents.tsx | 14 - .../loaders/documentvisitorcount.tsx | 14 - .../glean-embeds/loaders/eligiblepins.tsx | 14 - .../glean-embeds/loaders/emails.tsx | 14 - .../components/glean-embeds/loaders/end.tsx | 14 - .../components/glean-embeds/loaders/event.tsx | 14 - .../glean-embeds/loaders/exclusions.tsx | 14 - .../glean-embeds/loaders/existingpins.tsx | 14 - .../glean-embeds/loaders/externallinks.tsx | 14 - .../loaders/externalsharingoptions.tsx | 14 - .../glean-embeds/loaders/extractedqna.tsx | 14 - .../loaders/facetbucketfilter.tsx | 14 - .../glean-embeds/loaders/facetfilters.tsx | 14 - .../glean-embeds/loaders/facetfiltersets.tsx | 14 - .../glean-embeds/loaders/facetresults.tsx | 14 - .../glean-embeds/loaders/favoriteinfo.tsx | 14 - .../components/glean-embeds/loaders/file.tsx | 14 - .../glean-embeds/loaders/filters.tsx | 14 - .../glean-embeds/loaders/followupactions.tsx | 14 - .../glean-embeds/loaders/fragments.tsx | 14 - .../loaders/generatedattachments.tsx | 14 - .../glean-embeds/loaders/generatedqna.tsx | 14 - .../loaders/generatedqnaresult.tsx | 14 - .../glean-embeds/loaders/gleandataerror.tsx | 14 - .../components/glean-embeds/loaders/group.tsx | 14 - .../glean-embeds/loaders/groupattendees.tsx | 14 - .../glean-embeds/loaders/hotwords.tsx | 14 - .../components/glean-embeds/loaders/icon.tsx | 14 - .../glean-embeds/loaders/iconconfig.tsx | 14 - .../glean-embeds/loaders/implementations.tsx | 14 - .../glean-embeds/loaders/inactiveinsights.tsx | 14 - .../glean-embeds/loaders/inclusions.tsx | 14 - .../glean-embeds/loaders/inputdetails.tsx | 14 - .../glean-embeds/loaders/inputoptions.tsx | 14 - .../glean-embeds/loaders/interactions.tsx | 14 - .../components/glean-embeds/loaders/items.tsx | 14 - .../glean-embeds/loaders/lastreminder.tsx | 14 - .../glean-embeds/loaders/lastverifier.tsx | 14 - .../glean-embeds/loaders/likedby.tsx | 14 - .../components/glean-embeds/loaders/likes.tsx | 14 - .../components/glean-embeds/loaders/lines.tsx | 14 - .../loaders/lowperformingqueryinsights.tsx | 14 - .../glean-embeds/loaders/meeting.tsx | 14 - .../glean-embeds/loaders/members.tsx | 14 - .../glean-embeds/loaders/mergedcustomers.tsx | 14 - .../glean-embeds/loaders/messages.tsx | 14 - .../glean-embeds/loaders/metadata.tsx | 14 - .../loaders/mustincludesuggestions.tsx | 14 - .../glean-embeds/loaders/objects.tsx | 14 - .../glean-embeds/loaders/operatormetadata.tsx | 14 - .../components/glean-embeds/loaders/owner.tsx | 14 - .../glean-embeds/loaders/parameters.tsx | 14 - .../glean-embeds/loaders/params.tsx | 14 - .../glean-embeds/loaders/parentdocument.tsx | 14 - .../glean-embeds/loaders/people.tsx | 14 - .../glean-embeds/loaders/period.tsx | 14 - .../glean-embeds/loaders/permissions.tsx | 14 - .../glean-embeds/loaders/person.tsx | 14 - .../glean-embeds/loaders/pinmetadata.tsx | 14 - .../components/glean-embeds/loaders/pins.tsx | 14 - .../components/glean-embeds/loaders/poc.tsx | 14 - .../glean-embeds/loaders/possiblevalues.tsx | 14 - .../glean-embeds/loaders/primaryentry.tsx | 14 - .../glean-embeds/loaders/prompttemplate.tsx | 14 - .../glean-embeds/loaders/properties.tsx | 14 - .../loaders/propertydefinitions.tsx | 14 - .../glean-embeds/loaders/propertygroups.tsx | 14 - .../glean-embeds/loaders/proximity.tsx | 14 - .../glean-embeds/loaders/queryinsights.tsx | 14 - .../glean-embeds/loaders/querysuggestion.tsx | 14 - .../glean-embeds/loaders/querysuggestions.tsx | 14 - .../glean-embeds/loaders/questionresult.tsx | 14 - .../glean-embeds/loaders/quicklink.tsx | 14 - .../glean-embeds/loaders/ranges.tsx | 14 - .../glean-embeds/loaders/referenceranges.tsx | 14 - .../glean-embeds/loaders/relateddocuments.tsx | 14 - .../glean-embeds/loaders/relatedobjects.tsx | 14 - .../glean-embeds/loaders/relatedquestion.tsx | 14 - .../glean-embeds/loaders/relatedresults.tsx | 14 - .../glean-embeds/loaders/relationships.tsx | 14 - .../glean-embeds/loaders/reminders.tsx | 14 - .../glean-embeds/loaders/removedroles.tsx | 14 - .../glean-embeds/loaders/requestoptions.tsx | 14 - .../glean-embeds/loaders/requestor.tsx | 14 - .../glean-embeds/loaders/responsemetadata.tsx | 14 - .../glean-embeds/loaders/resultdocuments.tsx | 14 - .../glean-embeds/loaders/results.tsx | 14 - .../loaders/resultsdescription.tsx | 14 - .../glean-embeds/loaders/resulttabs.tsx | 14 - .../loaders/rewrittenfacetfilters.tsx | 14 - .../components/glean-embeds/loaders/roles.tsx | 14 - .../glean-embeds/loaders/runcount.tsx | 14 - .../glean-embeds/loaders/scopes.tsx | 14 - .../glean-embeds/loaders/searchcount.tsx | 14 - .../loaders/searchedqueryranges.tsx | 14 - .../glean-embeds/loaders/searchorcount.tsx | 14 - .../loaders/searchproviderinfo.tsx | 14 - .../glean-embeds/loaders/searchwarning.tsx | 14 - .../loaders/searchwithclickcount.tsx | 14 - .../glean-embeds/loaders/secondaryentries.tsx | 14 - .../glean-embeds/loaders/sections.tsx | 14 - .../loaders/sensitivecontentoptions.tsx | 14 - .../loaders/sensitiveinfotypes.tsx | 14 - .../glean-embeds/loaders/sensitiveregexes.tsx | 14 - .../glean-embeds/loaders/sensitiveterms.tsx | 14 - .../glean-embeds/loaders/sessioninfo.tsx | 14 - .../glean-embeds/loaders/shortcut.tsx | 14 - .../glean-embeds/loaders/shortcutinsights.tsx | 14 - .../glean-embeds/loaders/similarqueries.tsx | 14 - .../glean-embeds/loaders/snippets.tsx | 14 - .../glean-embeds/loaders/socialnetworks.tsx | 14 - .../glean-embeds/loaders/sourcedocument.tsx | 14 - .../glean-embeds/loaders/sourcefile.tsx | 14 - .../glean-embeds/loaders/sourceperson.tsx | 14 - .../components/glean-embeds/loaders/start.tsx | 14 - .../glean-embeds/loaders/status.tsx | 14 - .../glean-embeds/loaders/structuredlist.tsx | 14 - .../loaders/structuredlocation.tsx | 14 - .../glean-embeds/loaders/structuredresult.tsx | 14 - .../loaders/structuredresults.tsx | 14 - .../glean-embeds/loaders/suggestions.tsx | 14 - .../glean-embeds/loaders/summary.tsx | 14 - .../glean-embeds/loaders/target.tsx | 14 - .../components/glean-embeds/loaders/team.tsx | 14 - .../components/glean-embeds/loaders/teams.tsx | 14 - .../glean-embeds/loaders/textrange.tsx | 14 - .../glean-embeds/loaders/thumbnail.tsx | 14 - .../components/glean-embeds/loaders/time.tsx | 14 - .../glean-embeds/loaders/uiconfig.tsx | 14 - .../glean-embeds/loaders/updatedby.tsx | 14 - .../loaders/uploadedpermissions.tsx | 14 - .../components/glean-embeds/loaders/user.tsx | 14 - .../components/glean-embeds/loaders/value.tsx | 14 - .../glean-embeds/loaders/values.tsx | 14 - .../glean-embeds/loaders/verification.tsx | 14 - .../glean-embeds/loaders/viewcount.tsx | 14 - .../glean-embeds/loaders/viewerinfo.tsx | 14 - .../glean-embeds/loaders/visitcount.tsx | 14 - .../glean-embeds/loaders/visitorcount.tsx | 14 - .../glean-embeds/loaders/workflow.tsx | 14 - .../components/glean-embeds/loaders/write.tsx | 14 - examples/docusaurus/src/css/custom.css | 30 - .../docusaurus/src/pages/index.module.css | 24 - examples/docusaurus/src/pages/index.tsx | 55 - .../docusaurus/src/pages/markdown-page.md | 7 - examples/docusaurus/tsconfig.json | 8 - examples/nextra/next-env.d.ts | 6 - examples/nextra/next.config.ts | 23 - examples/nextra/package.json | 41 - .../nextra/public/mistral-try-it-now/deps.js | 41456 ------ .../public/mistral-try-it-now/tsworker.js | 118 - .../public/mistral-try-it-now/types.d.ts | 18932 --- examples/nextra/speakeasy.mistral.config.mjs | 25 - examples/nextra/speakeasy.pokeapi.config.mjs | 12 - examples/nextra/src/app/layout.tsx | 51 - examples/nextra/src/app/mistral/api/_meta.ts | 4 - .../app/mistral/api/endpoint/agents/page.mdx | 5597 - .../endpoint/audio/transcriptions/page.mdx | 2043 - .../app/mistral/api/endpoint/batch/page.mdx | 2815 - .../mistral/api/endpoint/beta/agents/page.mdx | 10427 -- .../api/endpoint/beta/conversations/page.mdx | 39983 ----- .../endpoint/beta/libraries/accesses/page.mdx | 2101 - .../beta/libraries/documents/page.mdx | 6572 - .../api/endpoint/beta/libraries/page.mdx | 3791 - .../app/mistral/api/endpoint/chat/page.mdx | 7104 - .../mistral/api/endpoint/classifiers/page.mdx | 8249 - .../mistral/api/endpoint/embeddings/page.mdx | 988 - .../app/mistral/api/endpoint/files/page.mdx | 2642 - .../src/app/mistral/api/endpoint/fim/page.mdx | 3640 - .../mistral/api/endpoint/fine-tuning/page.mdx | 14285 -- .../app/mistral/api/endpoint/models/page.mdx | 5629 - .../src/app/mistral/api/endpoint/ocr/page.mdx | 1981 - examples/nextra/src/app/mistral/api/page.mdx | 23 - examples/nextra/src/app/mistral/page.mdx | 7 - examples/nextra/src/app/page.mdx | 11 - examples/nextra/src/app/pokeapi/api/_meta.ts | 4 - .../app/pokeapi/api/endpoint/berries/page.mdx | 3165 - .../pokeapi/api/endpoint/contests/page.mdx | 2890 - .../pokeapi/api/endpoint/encounters/page.mdx | 3479 - .../pokeapi/api/endpoint/evolution/page.mdx | 1838 - .../app/pokeapi/api/endpoint/games/page.mdx | 4918 - .../app/pokeapi/api/endpoint/items/page.mdx | 5983 - .../pokeapi/api/endpoint/location/page.mdx | 4712 - .../pokeapi/api/endpoint/machines/page.mdx | 976 - .../app/pokeapi/api/endpoint/moves/page.mdx | 7808 - .../app/pokeapi/api/endpoint/pokemon/page.mdx | 20423 --- .../app/pokeapi/api/endpoint/utility/page.mdx | 961 - examples/nextra/src/app/pokeapi/api/page.mdx | 38 - examples/nextra/src/app/pokeapi/page.mdx | 7 - .../nextra/src/components/PropertiesModal.tsx | 28 - examples/nextra/src/components/styles.css | 153 - examples/nextra/src/mdx-components.tsx | 12 - examples/nextra/tsconfig.json | 39 - examples/sdks/glean-typescript.tar.gz | 3 - examples/sdks/mistral-python.tar.gz | 3 - examples/sdks/mistral-typescript.tar.gz | 3 - .../.devcontainer/README.md | 35 - .../.devcontainer/devcontainer.json | 45 - .../mistral-typescript/.devcontainer/setup.sh | 30 - examples/sdks/mistral-typescript/.genignore | 3 - .../sdks/mistral-typescript/.gitattributes | 2 - .../workflows/run_example_scripts.yaml | 32 - .../sdk_generation_mistralai_azure_sdk.yaml | 28 - .../sdk_generation_mistralai_gcp_sdk.yaml | 28 - .../sdk_generation_mistralai_sdk.yaml | 28 - .../sdk_publish_mistralai_azure_sdk.yaml | 19 - .../sdk_publish_mistralai_gcp_sdk.yaml | 19 - .../workflows/sdk_publish_mistralai_sdk.yaml | 20 - .../.github/workflows/test_custom_code.yaml | 30 - examples/sdks/mistral-typescript/.gitignore | 127 - examples/sdks/mistral-typescript/.npmignore | 15 - .../mistral-typescript/.speakeasy/gen.lock | 1482 - .../mistral-typescript/.speakeasy/gen.yaml | 65 - .../.speakeasy/workflow.lock | 91 - .../.speakeasy/workflow.yaml | 45 - .../sdks/mistral-typescript/CONTRIBUTING.md | 26 - examples/sdks/mistral-typescript/FUNCTIONS.md | 90 - examples/sdks/mistral-typescript/LICENSE | 201 - examples/sdks/mistral-typescript/README.md | 819 - examples/sdks/mistral-typescript/RELEASES.md | 281 - examples/sdks/mistral-typescript/RUNTIMES.md | 48 - examples/sdks/mistral-typescript/USAGE.md | 112 - .../docs/lib/utils/retryconfig.md | 24 - .../docs/models/components/agent.md | 33 - .../models/components/agentconversation.md | 26 - .../components/agentconversationobject.md | 15 - .../models/components/agentcreationrequest.md | 24 - .../components/agentcreationrequesttools.md | 54 - .../components/agenthandoffdoneevent.md | 24 - .../components/agenthandoffdoneeventtype.md | 15 - .../models/components/agenthandoffentry.md | 28 - .../components/agenthandoffentryobject.md | 15 - .../components/agenthandoffentrytype.md | 15 - .../components/agenthandoffstartedevent.md | 24 - .../agenthandoffstartedeventtype.md | 15 - .../docs/models/components/agentobject.md | 15 - .../components/agentscompletionrequest.md | 37 - .../agentscompletionrequestmessages.md | 35 - .../components/agentscompletionrequeststop.md | 22 - .../agentscompletionrequesttoolchoice.md | 21 - .../agentscompletionstreamrequest.md | 37 - .../agentscompletionstreamrequestmessages.md | 35 - .../agentscompletionstreamrequeststop.md | 22 - ...agentscompletionstreamrequesttoolchoice.md | 21 - .../docs/models/components/agenttools.md | 54 - .../models/components/agentupdaterequest.md | 21 - .../components/agentupdaterequesttools.md | 54 - .../docs/models/components/apiendpoint.md | 17 - .../models/components/archiveftmodelout.md | 19 - .../components/archiveftmodeloutobject.md | 15 - .../docs/models/components/arguments.md | 21 - .../models/components/assistantmessage.md | 18 - .../components/assistantmessagecontent.md | 17 - .../models/components/assistantmessagerole.md | 15 - .../docs/models/components/audiochunk.md | 18 - .../docs/models/components/audiochunktype.md | 15 - .../components/audiotranscriptionrequest.md | 22 - .../audiotranscriptionrequeststream.md | 22 - .../docs/models/components/basemodelcard.md | 30 - .../models/components/basemodelcardtype.md | 15 - .../docs/models/components/batcherror.md | 18 - .../docs/models/components/batchjobin.md | 25 - .../docs/models/components/batchjobout.md | 46 - .../models/components/batchjoboutobject.md | 15 - .../docs/models/components/batchjobsout.md | 19 - .../models/components/batchjobsoutobject.md | 15 - .../docs/models/components/batchjobstatus.md | 15 - .../models/components/builtinconnectors.md | 15 - .../components/chatclassificationrequest.md | 26 - .../models/components/chatcompletionchoice.md | 21 - .../components/chatcompletionrequest.md | 40 - .../chatcompletionrequesttoolchoice.md | 21 - .../components/chatcompletionresponse.md | 27 - .../components/chatcompletionstreamrequest.md | 40 - .../chatcompletionstreamrequestmessages.md | 35 - .../chatcompletionstreamrequeststop.md | 22 - .../chatcompletionstreamrequesttoolchoice.md | 21 - .../components/chatmoderationrequest.md | 19 - .../components/chatmoderationrequestinputs.md | 26 - .../docs/models/components/checkpointout.md | 21 - .../components/classificationrequest.md | 19 - .../components/classificationrequestinputs.md | 22 - .../components/classificationresponse.md | 28 - .../components/classificationtargetresult.md | 21 - .../components/classifierdetailedjobout.md | 53 - .../classifierdetailedjoboutintegrations.md | 13 - .../classifierdetailedjoboutjobtype.md | 15 - .../classifierdetailedjoboutobject.md | 15 - .../classifierdetailedjoboutstatus.md | 15 - .../models/components/classifierftmodelout.md | 41 - .../classifierftmodeloutmodeltype.md | 15 - .../components/classifierftmodeloutobject.md | 15 - .../models/components/classifierjobout.md | 41 - .../classifierjoboutintegrations.md | 13 - .../components/classifierjoboutjobtype.md | 17 - .../components/classifierjoboutobject.md | 17 - .../components/classifierjoboutstatus.md | 17 - .../models/components/classifiertargetin.md | 25 - .../models/components/classifiertargetout.md | 27 - .../classifiertrainingparameters.md | 20 - .../classifiertrainingparametersin.md | 22 - .../models/components/codeinterpretertool.md | 15 - .../components/codeinterpretertooltype.md | 15 - .../docs/models/components/completionargs.md | 26 - .../models/components/completionargsstop.md | 20 - .../docs/models/components/completionchunk.md | 24 - .../components/completiondetailedjobout.md | 51 - .../completiondetailedjoboutintegrations.md | 13 - .../completiondetailedjoboutjobtype.md | 15 - .../completiondetailedjoboutobject.md | 15 - .../completiondetailedjoboutrepositories.md | 15 - .../completiondetailedjoboutstatus.md | 15 - .../docs/models/components/completionevent.md | 21 - .../models/components/completionftmodelout.md | 39 - .../components/completionftmodeloutobject.md | 15 - .../models/components/completionjobout.md | 44 - .../components/completionjoboutobject.md | 17 - .../completionresponsestreamchoice.md | 21 - ...pletionresponsestreamchoicefinishreason.md | 17 - .../completiontrainingparameters.md | 21 - .../completiontrainingparametersin.md | 23 - .../docs/models/components/content.md | 17 - .../docs/models/components/contentchunk.md | 61 - .../components/conversationappendrequest.md | 30 - ...nversationappendrequesthandoffexecution.md | 15 - .../conversationappendstreamrequest.md | 21 - ...tionappendstreamrequesthandoffexecution.md | 15 - .../models/components/conversationevents.md | 25 - .../components/conversationeventsdata.md | 102 - .../models/components/conversationhistory.md | 29 - .../components/conversationhistoryobject.md | 15 - .../models/components/conversationinputs.md | 24 - .../models/components/conversationmessages.md | 22 - .../components/conversationmessagesobject.md | 15 - .../models/components/conversationrequest.md | 34 - .../models/components/conversationresponse.md | 31 - .../components/conversationresponseobject.md | 15 - .../components/conversationrestartrequest.md | 25 - ...versationrestartrequesthandoffexecution.md | 15 - .../conversationrestartstreamrequest.md | 25 - ...ionrestartstreamrequesthandoffexecution.md | 15 - .../components/conversationstreamrequest.md | 27 - ...nversationstreamrequesthandoffexecution.md | 15 - .../conversationstreamrequesttools.md | 54 - .../components/conversationusageinfo.md | 19 - .../docs/models/components/data.md | 25 - .../docs/models/components/deletefileout.md | 21 - .../docs/models/components/deletemodelout.md | 19 - .../docs/models/components/deltamessage.md | 17 - .../docs/models/components/document.md | 31 - .../models/components/documentlibrarytool.md | 22 - .../components/documentlibrarytooltype.md | 15 - .../docs/models/components/documentout.md | 44 - .../models/components/documenttextcontent.md | 17 - .../models/components/documentupdatein.md | 15 - .../models/components/documenturlchunk.md | 19 - .../models/components/documenturlchunktype.md | 15 - .../docs/models/components/embeddingdtype.md | 15 - .../models/components/embeddingrequest.md | 25 - .../components/embeddingrequestinputs.md | 22 - .../models/components/embeddingresponse.md | 44 - .../components/embeddingresponsedata.md | 25 - .../docs/models/components/encodingformat.md | 15 - .../docs/models/components/entitytype.md | 19 - .../docs/models/components/entries.md | 65 - .../docs/models/components/eventout.md | 20 - .../docs/models/components/filechunk.md | 18 - .../docs/models/components/filepurpose.md | 17 - .../docs/models/components/fileschema.md | 34 - .../docs/models/components/filesignedurl.md | 17 - .../docs/models/components/filet.md | 16 - .../models/components/fimcompletionrequest.md | 28 - .../components/fimcompletionrequeststop.md | 22 - .../components/fimcompletionresponse.md | 33 - .../components/fimcompletionstreamrequest.md | 28 - .../fimcompletionstreamrequeststop.md | 22 - .../components/finetuneablemodeltype.md | 15 - .../docs/models/components/finishreason.md | 17 - .../components/ftclassifierlossfunction.md | 15 - .../components/ftmodelcapabilitiesout.md | 19 - .../docs/models/components/ftmodelcard.md | 37 - .../docs/models/components/ftmodelcardtype.md | 15 - .../docs/models/components/functioncall.md | 19 - .../models/components/functioncallentry.md | 30 - .../components/functioncallentryarguments.md | 21 - .../components/functioncallentryobject.md | 15 - .../components/functioncallentrytype.md | 15 - .../models/components/functioncallevent.md | 26 - .../components/functioncalleventtype.md | 15 - .../docs/models/components/functionname.md | 19 - .../models/components/functionresultentry.md | 24 - .../components/functionresultentryobject.md | 15 - .../components/functionresultentrytype.md | 15 - .../docs/models/components/functiont.md | 23 - .../docs/models/components/functiontool.md | 23 - .../models/components/functiontooltype.md | 15 - .../models/components/githubrepositoryin.md | 24 - .../components/githubrepositoryintype.md | 15 - .../models/components/githubrepositoryout.md | 24 - .../components/githubrepositoryouttype.md | 15 - .../models/components/handoffexecution.md | 15 - .../docs/models/components/hyperparameters.md | 17 - .../models/components/imagegenerationtool.md | 15 - .../components/imagegenerationtooltype.md | 15 - .../docs/models/components/imageurl.md | 18 - .../docs/models/components/imageurlchunk.md | 20 - .../components/imageurlchunkimageurl.md | 19 - .../models/components/imageurlchunktype.md | 15 - .../docs/models/components/inputentries.md | 65 - .../docs/models/components/inputs.md | 21 - .../docs/models/components/instructrequest.md | 22 - .../components/instructrequestinputs.md | 17 - .../instructrequestinputsmessages.md | 35 - .../components/instructrequestmessages.md | 35 - .../docs/models/components/integrations.md | 13 - .../docs/models/components/jobin.md | 30 - .../models/components/jobinintegrations.md | 14 - .../models/components/jobinrepositories.md | 15 - .../docs/models/components/jobmetadataout.md | 21 - .../docs/models/components/jobsout.md | 19 - .../docs/models/components/jobsoutdata.md | 41 - .../docs/models/components/jobsoutobject.md | 15 - .../docs/models/components/jobtype.md | 17 - .../docs/models/components/jsonschema.md | 24 - .../models/components/legacyjobmetadataout.md | 36 - .../components/legacyjobmetadataoutobject.md | 15 - .../docs/models/components/libraryin.md | 19 - .../docs/models/components/libraryinupdate.md | 16 - .../docs/models/components/libraryout.md | 40 - .../docs/models/components/listdocumentout.md | 40 - .../docs/models/components/listfilesout.md | 32 - .../docs/models/components/listlibraryout.md | 29 - .../docs/models/components/listsharingout.md | 17 - .../docs/models/components/loc.md | 17 - .../docs/models/components/messageentries.md | 22 - .../components/messageinputcontentchunks.md | 46 - .../models/components/messageinputentry.md | 27 - .../components/messageinputentrycontent.md | 17 - .../components/messageinputentryrole.md | 15 - .../components/messageinputentrytype.md | 15 - .../components/messageoutputcontentchunks.md | 55 - .../models/components/messageoutputentry.md | 25 - .../components/messageoutputentrycontent.md | 17 - .../components/messageoutputentryobject.md | 15 - .../components/messageoutputentryrole.md | 15 - .../components/messageoutputentrytype.md | 15 - .../models/components/messageoutputevent.md | 29 - .../components/messageoutputeventcontent.md | 20 - .../components/messageoutputeventrole.md | 15 - .../components/messageoutputeventtype.md | 15 - .../docs/models/components/messages.md | 35 - .../docs/models/components/metricout.md | 19 - .../models/components/mistralpromptmode.md | 17 - .../models/components/modelcapabilities.md | 20 - .../models/components/modelconversation.md | 29 - .../components/modelconversationobject.md | 15 - .../components/modelconversationtools.md | 54 - .../docs/models/components/modellist.md | 16 - .../docs/models/components/modeltype.md | 15 - .../models/components/moderationobject.md | 16 - .../models/components/moderationresponse.md | 21 - .../docs/models/components/objectt.md | 15 - .../docs/models/components/ocrimageobject.md | 27 - .../models/components/ocrpagedimensions.md | 21 - .../docs/models/components/ocrpageobject.md | 27 - .../docs/models/components/ocrrequest.md | 28 - .../docs/models/components/ocrresponse.md | 24 - .../docs/models/components/ocrusageinfo.md | 18 - .../docs/models/components/one.md | 35 - .../models/components/outputcontentchunks.md | 55 - .../docs/models/components/outputs.md | 47 - .../docs/models/components/paginationinfo.md | 25 - .../docs/models/components/prediction.md | 16 - .../models/components/processingstatusout.md | 19 - .../docs/models/components/referencechunk.md | 18 - .../models/components/referencechunktype.md | 15 - .../docs/models/components/repositories.md | 15 - .../models/components/responsedoneevent.md | 19 - .../components/responsedoneeventtype.md | 15 - .../models/components/responseerrorevent.md | 21 - .../components/responseerroreventtype.md | 15 - .../docs/models/components/responseformat.md | 16 - .../docs/models/components/responseformats.md | 17 - .../models/components/responsestartedevent.md | 19 - .../components/responsestartedeventtype.md | 15 - .../docs/models/components/retrievefileout.md | 36 - .../docs/models/components/role.md | 15 - .../docs/models/components/sampletype.md | 17 - .../docs/models/components/security.md | 15 - .../docs/models/components/shareenum.md | 17 - .../docs/models/components/sharingdelete.md | 21 - .../docs/models/components/sharingin.md | 23 - .../docs/models/components/sharingout.md | 26 - .../docs/models/components/source.md | 17 - .../docs/models/components/ssetypes.md | 17 - .../docs/models/components/status.md | 17 - .../docs/models/components/stop.md | 22 - .../docs/models/components/systemmessage.md | 18 - .../models/components/systemmessagecontent.md | 22 - .../components/systemmessagecontentchunks.md | 21 - .../docs/models/components/textchunk.md | 18 - .../docs/models/components/textchunktype.md | 15 - .../docs/models/components/thinkchunk.md | 19 - .../docs/models/components/thinkchunktype.md | 15 - .../docs/models/components/thinking.md | 21 - .../models/components/timestampgranularity.md | 15 - .../docs/models/components/tool.md | 23 - .../docs/models/components/toolcall.md | 23 - .../docs/models/components/toolchoice.md | 22 - .../docs/models/components/toolchoiceenum.md | 15 - .../components/toolexecutiondeltaevent.md | 24 - .../components/toolexecutiondeltaeventtype.md | 15 - .../components/toolexecutiondoneevent.md | 23 - .../components/toolexecutiondoneeventtype.md | 15 - .../models/components/toolexecutionentry.md | 25 - .../components/toolexecutionentryobject.md | 15 - .../components/toolexecutionentrytype.md | 15 - .../components/toolexecutionstartedevent.md | 24 - .../toolexecutionstartedeventtype.md | 15 - .../docs/models/components/toolfilechunk.md | 22 - .../models/components/toolfilechunktype.md | 15 - .../docs/models/components/toolmessage.md | 20 - .../models/components/toolmessagecontent.md | 17 - .../docs/models/components/toolmessagerole.md | 15 - .../models/components/toolreferencechunk.md | 23 - .../components/toolreferencechunktype.md | 15 - .../docs/models/components/tools.md | 54 - .../docs/models/components/tooltypes.md | 17 - .../docs/models/components/trainingfile.md | 18 - .../components/transcriptionresponse.md | 25 - .../components/transcriptionsegmentchunk.md | 23 - .../components/transcriptionstreamdone.md | 26 - .../components/transcriptionstreamdonetype.md | 15 - .../components/transcriptionstreamevents.md | 24 - .../transcriptionstreameventsdata.md | 42 - .../transcriptionstreameventtypes.md | 15 - .../components/transcriptionstreamlanguage.md | 19 - .../transcriptionstreamlanguagetype.md | 15 - .../transcriptionstreamsegmentdelta.md | 23 - .../transcriptionstreamsegmentdeltatype.md | 15 - .../transcriptionstreamtextdelta.md | 19 - .../transcriptionstreamtextdeltatype.md | 15 - .../docs/models/components/two.md | 35 - .../docs/models/components/type.md | 15 - .../models/components/unarchiveftmodelout.md | 19 - .../components/unarchiveftmodeloutobject.md | 15 - .../docs/models/components/updateftmodelin.md | 16 - .../docs/models/components/uploadfileout.md | 34 - .../docs/models/components/usageinfo.md | 19 - .../docs/models/components/usermessage.md | 18 - .../models/components/usermessagecontent.md | 17 - .../docs/models/components/usermessagerole.md | 15 - .../docs/models/components/validationerror.md | 23 - .../models/components/wandbintegration.md | 22 - .../models/components/wandbintegrationout.md | 21 - .../components/wandbintegrationouttype.md | 15 - .../models/components/wandbintegrationtype.md | 15 - .../models/components/websearchpremiumtool.md | 15 - .../components/websearchpremiumtooltype.md | 15 - .../docs/models/components/websearchtool.md | 15 - .../models/components/websearchtooltype.md | 15 - .../docs/models/errors/httpvalidationerror.md | 15 - .../operations/agentsapiv1agentsgetrequest.md | 17 - .../agentsapiv1agentslistrequest.md | 16 - .../agentsapiv1agentsupdaterequest.md | 19 - .../agentsapiv1agentsupdateversionrequest.md | 19 - .../agentsapiv1conversationsappendrequest.md | 21 - ...tsapiv1conversationsappendstreamrequest.md | 21 - .../agentsapiv1conversationsgetrequest.md | 17 - ...versationsgetresponsev1conversationsget.md | 29 - .../agentsapiv1conversationshistoryrequest.md | 17 - .../agentsapiv1conversationslistrequest.md | 16 - ...agentsapiv1conversationsmessagesrequest.md | 17 - .../agentsapiv1conversationsrestartrequest.md | 22 - ...sapiv1conversationsrestartstreamrequest.md | 22 - ...deletemodelv1modelsmodeliddeleterequest.md | 17 - .../filesapiroutesdeletefilerequest.md | 17 - .../filesapiroutesdownloadfilerequest.md | 17 - .../filesapiroutesgetsignedurlrequest.md | 18 - .../filesapirouteslistfilesrequest.md | 20 - .../filesapiroutesretrievefilerequest.md | 17 - ...sapiroutesuploadfilemultipartbodyparams.md | 16 - ...jobsapiroutesbatchcancelbatchjobrequest.md | 17 - .../jobsapiroutesbatchgetbatchjobrequest.md | 17 - .../jobsapiroutesbatchgetbatchjobsrequest.md | 22 - ...sfinetuningarchivefinetunedmodelrequest.md | 17 - ...tesfinetuningcancelfinetuningjobrequest.md | 17 - ...esfinetuningcancelfinetuningjobresponse.md | 57 - ...esfinetuningcreatefinetuningjobresponse.md | 44 - ...routesfinetuninggetfinetuningjobrequest.md | 17 - ...outesfinetuninggetfinetuningjobresponse.md | 57 - ...outesfinetuninggetfinetuningjobsrequest.md | 24 - ...utesfinetuningstartfinetuningjobrequest.md | 17 - ...tesfinetuningstartfinetuningjobresponse.md | 57 - ...inetuningunarchivefinetunedmodelrequest.md | 17 - ...esfinetuningupdatefinetunedmodelrequest.md | 19 - ...sfinetuningupdatefinetunedmodelresponse.md | 40 - .../operations/librariesdeletev1request.md | 17 - .../librariesdocumentsdeletev1request.md | 19 - ...mentsgetextractedtextsignedurlv1request.md | 19 - ...librariesdocumentsgetsignedurlv1request.md | 19 - .../librariesdocumentsgetstatusv1request.md | 19 - ...brariesdocumentsgettextcontentv1request.md | 19 - .../librariesdocumentsgetv1request.md | 19 - .../librariesdocumentslistv1request.md | 22 - .../librariesdocumentsreprocessv1request.md | 19 - .../librariesdocumentsupdatev1request.md | 21 - ...ibrariesdocumentsuploadv1documentupload.md | 15 - .../librariesdocumentsuploadv1request.md | 16 - .../operations/librariesgetv1request.md | 17 - .../librariessharecreatev1request.md | 24 - .../librariessharedeletev1request.md | 23 - .../operations/librariessharelistv1request.md | 17 - .../operations/librariesupdatev1request.md | 19 - .../docs/models/operations/one.md | 41 - .../docs/models/operations/responsebody.md | 27 - .../retrievemodelv1modelsmodelidgetrequest.md | 17 - ...responseretrievemodelv1modelsmodelidget.md | 27 - .../docs/models/operations/status.md | 17 - .../docs/sdks/accesses/README.md | 256 - .../docs/sdks/agents/README.md | 189 - .../docs/sdks/audio/README.md | 6 - .../docs/sdks/batch/README.md | 6 - .../docs/sdks/beta/README.md | 6 - .../docs/sdks/chat/README.md | 189 - .../docs/sdks/classifiers/README.md | 355 - .../docs/sdks/conversations/README.md | 835 - .../docs/sdks/documents/README.md | 785 - .../docs/sdks/embeddings/README.md | 92 - .../docs/sdks/files/README.md | 455 - .../docs/sdks/fim/README.md | 173 - .../docs/sdks/finetuning/README.md | 6 - .../docs/sdks/jobs/README.md | 379 - .../docs/sdks/libraries/README.md | 380 - .../docs/sdks/mistral/README.md | 7 - .../docs/sdks/mistralagents/README.md | 386 - .../docs/sdks/mistraljobs/README.md | 305 - .../docs/sdks/models/README.md | 453 - .../docs/sdks/ocr/README.md | 92 - .../docs/sdks/transcriptions/README.md | 163 - .../sdks/mistral-typescript/eslint.config.mjs | 22 - .../mistral-typescript/examples/.env.template | 10 - .../mistral-typescript/examples/.gitignore | 1 - .../mistral-typescript/examples/README.md | 44 - .../examples/package-lock.json | 1352 - .../mistral-typescript/examples/package.json | 32 - .../src/async_audio_transcription_stream.ts | 18 - .../examples/src/async_chat_no_streaming.ts | 15 - .../examples/src/async_chat_prediction.ts | 33 - .../examples/src/async_chat_streaming.ts | 27 - .../src/async_chat_with_image_no_streaming.ts | 27 - .../examples/src/async_conversation_agent.ts | 37 - .../examples/src/async_embeddings.ts | 20 - .../examples/src/async_files.ts | 36 - .../examples/src/async_function_calling.ts | 147 - .../src/async_function_calling_streaming.ts | 179 - .../examples/src/async_jobs.ts | 51 - .../examples/src/async_json_format.ts | 16 - .../examples/src/async_list_models.ts | 14 - .../src/async_ocr_process_from_file.ts | 33 - .../src/async_ocr_process_from_url.ts | 15 - .../examples/src/async_structured_outputs.ts | 70 - .../src/azure/async_chat_no_streaming.ts | 27 - .../examples/src/error_handling.ts | 31 - .../examples/src/file.jsonl | 3 - .../src/gcp/async_chat_no_streaming.ts | 23 - .../mistral-typescript/examples/src/ocr.pdf | Bin 18810 -> 0 bytes .../sdks/mistral-typescript/examples/test.ts | 54 - .../mistral-typescript/examples/tsconfig.json | 37 - examples/sdks/mistral-typescript/jsr.json | 28 - .../sdks/mistral-typescript/package-lock.json | 1877 - examples/sdks/mistral-typescript/package.json | 30 - .../packages/mistralai-azure/.genignore | 4 - .../packages/mistralai-azure/.gitattributes | 2 - .../packages/mistralai-azure/.gitignore | 22 - .../packages/mistralai-azure/.npmignore | 15 - .../mistralai-azure/.speakeasy/gen.lock | 227 - .../mistralai-azure/.speakeasy/gen.yaml | 51 - .../packages/mistralai-azure/CONTRIBUTING.md | 26 - .../packages/mistralai-azure/FUNCTIONS.md | 111 - .../packages/mistralai-azure/LICENSE | 201 - .../packages/mistralai-azure/README.md | 447 - .../packages/mistralai-azure/RELEASES.md | 131 - .../packages/mistralai-azure/RUNTIMES.md | 48 - .../packages/mistralai-azure/USAGE.md | 32 - .../docs/lib/utils/retryconfig.md | 24 - .../docs/models/components/arguments.md | 19 - .../models/components/assistantmessage.md | 18 - .../components/assistantmessagecontent.md | 24 - .../models/components/assistantmessagerole.md | 15 - .../models/components/chatcompletionchoice.md | 21 - .../chatcompletionchoicefinishreason.md | 17 - .../components/chatcompletionrequest.md | 39 - .../chatcompletionrequestmessages.md | 42 - .../components/chatcompletionrequeststop.md | 21 - .../chatcompletionrequesttoolchoice.md | 21 - .../components/chatcompletionresponse.md | 33 - .../components/chatcompletionstreamrequest.md | 39 - .../chatcompletionstreamrequesttoolchoice.md | 21 - .../docs/models/components/completionchunk.md | 30 - .../docs/models/components/completionevent.md | 27 - .../completionresponsestreamchoice.md | 21 - .../docs/models/components/content.md | 22 - .../docs/models/components/contentchunk.md | 31 - .../docs/models/components/deltamessage.md | 17 - .../docs/models/components/document.md | 33 - .../models/components/documenturlchunk.md | 19 - .../models/components/documenturlchunktype.md | 15 - .../docs/models/components/filechunk.md | 18 - .../docs/models/components/finishreason.md | 17 - .../docs/models/components/functioncall.md | 19 - .../docs/models/components/functionname.md | 19 - .../docs/models/components/functiont.md | 23 - .../docs/models/components/imageurl.md | 18 - .../docs/models/components/imageurlchunk.md | 22 - .../components/imageurlchunkimageurl.md | 19 - .../models/components/imageurlchunktype.md | 15 - .../docs/models/components/jsonschema.md | 23 - .../docs/models/components/loc.md | 17 - .../docs/models/components/messages.md | 52 - .../models/components/mistralpromptmode.md | 17 - .../docs/models/components/ocrimageobject.md | 27 - .../models/components/ocrpagedimensions.md | 21 - .../docs/models/components/ocrpageobject.md | 35 - .../docs/models/components/ocrrequest.md | 29 - .../docs/models/components/ocrresponse.md | 43 - .../docs/models/components/ocrusageinfo.md | 18 - .../docs/models/components/prediction.md | 16 - .../docs/models/components/referencechunk.md | 20 - .../models/components/referencechunktype.md | 15 - .../docs/models/components/responseformat.md | 16 - .../docs/models/components/responseformats.md | 17 - .../docs/models/components/role.md | 15 - .../docs/models/components/security.md | 15 - .../docs/models/components/stop.md | 21 - .../docs/models/components/systemmessage.md | 23 - .../models/components/systemmessagecontent.md | 21 - .../docs/models/components/textchunk.md | 18 - .../docs/models/components/tool.md | 23 - .../docs/models/components/toolcall.md | 23 - .../docs/models/components/toolchoice.md | 22 - .../docs/models/components/toolchoiceenum.md | 15 - .../docs/models/components/toolmessage.md | 20 - .../models/components/toolmessagecontent.md | 24 - .../docs/models/components/toolmessagerole.md | 15 - .../docs/models/components/tooltypes.md | 17 - .../docs/models/components/type.md | 15 - .../docs/models/components/usageinfo.md | 19 - .../docs/models/components/usermessage.md | 18 - .../models/components/usermessagecontent.md | 24 - .../docs/models/components/usermessagerole.md | 15 - .../docs/models/components/validationerror.md | 23 - .../docs/models/errors/httpvalidationerror.md | 15 - .../mistralai-azure/docs/sdks/chat/README.md | 114 - .../docs/sdks/mistralazure/README.md | 9 - .../mistralai-azure/eslint.config.mjs | 21 - .../packages/mistralai-azure/jsr.json | 28 - .../mistralai-azure/package-lock.json | 1869 - .../packages/mistralai-azure/package.json | 31 - .../packages/mistralai-azure/src/core.ts | 13 - .../mistralai-azure/src/funcs/chatComplete.ts | 160 - .../mistralai-azure/src/funcs/chatStream.ts | 178 - .../mistralai-azure/src/funcs/ocrProcess.ts | 160 - .../src/hooks/custom_user_agent.ts | 11 - .../mistralai-azure/src/hooks/hooks.ts | 132 - .../mistralai-azure/src/hooks/index.ts | 6 - .../mistralai-azure/src/hooks/registration.ts | 15 - .../mistralai-azure/src/hooks/types.ts | 110 - .../packages/mistralai-azure/src/index.ts | 7 - .../mistralai-azure/src/lib/base64.ts | 37 - .../mistralai-azure/src/lib/config.ts | 62 - .../packages/mistralai-azure/src/lib/dlv.ts | 53 - .../mistralai-azure/src/lib/encodings.ts | 483 - .../packages/mistralai-azure/src/lib/env.ts | 41 - .../mistralai-azure/src/lib/event-streams.ts | 264 - .../packages/mistralai-azure/src/lib/files.ts | 40 - .../packages/mistralai-azure/src/lib/http.ts | 323 - .../src/lib/is-plain-object.ts | 43 - .../mistralai-azure/src/lib/logger.ts | 9 - .../mistralai-azure/src/lib/matchers.ts | 325 - .../mistralai-azure/src/lib/primitives.ts | 150 - .../mistralai-azure/src/lib/retries.ts | 218 - .../mistralai-azure/src/lib/schemas.ts | 91 - .../packages/mistralai-azure/src/lib/sdks.ts | 395 - .../mistralai-azure/src/lib/security.ts | 253 - .../packages/mistralai-azure/src/lib/url.ts | 33 - .../src/models/components/assistantmessage.ts | 185 - .../models/components/chatcompletionchoice.ts | 137 - .../components/chatcompletionrequest.ts | 519 - .../components/chatcompletionresponse.ts | 98 - .../components/chatcompletionstreamrequest.ts | 505 - .../src/models/components/completionchunk.ts | 96 - .../src/models/components/completionevent.ts | 80 - .../completionresponsestreamchoice.ts | 136 - .../src/models/components/contentchunk.ts | 106 - .../src/models/components/deltamessage.ts | 138 - .../src/models/components/documenturlchunk.ts | 115 - .../src/models/components/filechunk.ts | 75 - .../src/models/components/function.ts | 74 - .../src/models/components/functioncall.ts | 112 - .../src/models/components/functionname.ts | 65 - .../src/models/components/imageurl.ts | 66 - .../src/models/components/imageurlchunk.ts | 161 - .../src/models/components/index.ts | 45 - .../src/models/components/jsonschema.ts | 83 - .../models/components/mistralpromptmode.ts | 47 - .../src/models/components/ocrimageobject.ts | 126 - .../models/components/ocrpagedimensions.ts | 83 - .../src/models/components/ocrpageobject.ts | 98 - .../src/models/components/ocrrequest.ts | 229 - .../src/models/components/ocrresponse.ts | 106 - .../src/models/components/ocrusageinfo.ts | 83 - .../src/models/components/prediction.ts | 66 - .../src/models/components/referencechunk.ts | 102 - .../src/models/components/responseformat.ts | 89 - .../src/models/components/responseformats.ts | 40 - .../src/models/components/security.ts | 71 - .../src/models/components/systemmessage.ts | 148 - .../src/models/components/textchunk.ts | 92 - .../src/models/components/tool.ts | 71 - .../src/models/components/toolcall.ts | 85 - .../src/models/components/toolchoice.ts | 83 - .../src/models/components/toolchoiceenum.ts | 35 - .../src/models/components/toolmessage.ts | 170 - .../src/models/components/tooltypes.ts | 47 - .../src/models/components/usageinfo.ts | 103 - .../src/models/components/usermessage.ts | 153 - .../src/models/components/validationerror.ts | 113 - .../src/models/errors/httpclienterrors.ts | 62 - .../src/models/errors/httpvalidationerror.ts | 70 - .../src/models/errors/index.ts | 8 - .../src/models/errors/sdkerror.ts | 27 - .../src/models/errors/sdkvalidationerror.ts | 97 - .../packages/mistralai-azure/src/sdk/chat.ts | 43 - .../packages/mistralai-azure/src/sdk/index.ts | 5 - .../packages/mistralai-azure/src/sdk/ocr.ts | 24 - .../packages/mistralai-azure/src/sdk/sdk.ts | 28 - .../mistralai-azure/src/types/async.ts | 68 - .../mistralai-azure/src/types/blobs.ts | 31 - .../src/types/constdatetime.ts | 15 - .../mistralai-azure/src/types/enums.ts | 16 - .../packages/mistralai-azure/src/types/fp.ts | 50 - .../mistralai-azure/src/types/index.ts | 11 - .../mistralai-azure/src/types/operations.ts | 105 - .../mistralai-azure/src/types/rfcdate.ts | 54 - .../mistralai-azure/src/types/streams.ts | 21 - .../packages/mistralai-azure/tsconfig.json | 41 - .../packages/mistralai-gcp/.genignore | 4 - .../packages/mistralai-gcp/.gitattributes | 2 - .../packages/mistralai-gcp/.gitignore | 22 - .../packages/mistralai-gcp/.npmignore | 15 - .../mistralai-gcp/.speakeasy/gen.lock | 222 - .../mistralai-gcp/.speakeasy/gen.yaml | 51 - .../packages/mistralai-gcp/CONTRIBUTING.md | 26 - .../packages/mistralai-gcp/FUNCTIONS.md | 112 - .../packages/mistralai-gcp/LICENSE | 201 - .../packages/mistralai-gcp/README.md | 455 - .../packages/mistralai-gcp/RELEASES.md | 121 - .../packages/mistralai-gcp/RUNTIMES.md | 48 - .../packages/mistralai-gcp/USAGE.md | 32 - .../docs/lib/utils/retryconfig.md | 24 - .../docs/models/components/arguments.md | 19 - .../models/components/assistantmessage.md | 18 - .../components/assistantmessagecontent.md | 24 - .../models/components/assistantmessagerole.md | 15 - .../models/components/chatcompletionchoice.md | 21 - .../chatcompletionchoicefinishreason.md | 17 - .../components/chatcompletionrequest.md | 38 - .../chatcompletionrequestmessages.md | 42 - .../components/chatcompletionrequeststop.md | 21 - .../chatcompletionrequesttoolchoice.md | 21 - .../components/chatcompletionresponse.md | 37 - .../components/chatcompletionstreamrequest.md | 38 - .../chatcompletionstreamrequesttoolchoice.md | 21 - .../docs/models/components/completionchunk.md | 35 - .../docs/models/components/completionevent.md | 32 - .../completionresponsestreamchoice.md | 21 - .../docs/models/components/content.md | 22 - .../docs/models/components/contentchunk.md | 31 - .../docs/models/components/deltamessage.md | 17 - .../models/components/fimcompletionrequest.md | 28 - .../components/fimcompletionrequeststop.md | 21 - .../components/fimcompletionresponse.md | 37 - .../components/fimcompletionstreamrequest.md | 28 - .../fimcompletionstreamrequeststop.md | 21 - .../docs/models/components/finishreason.md | 17 - .../docs/models/components/functioncall.md | 19 - .../docs/models/components/functionname.md | 19 - .../docs/models/components/functiont.md | 23 - .../docs/models/components/imageurl.md | 18 - .../docs/models/components/imageurlchunk.md | 22 - .../components/imageurlchunkimageurl.md | 19 - .../models/components/imageurlchunktype.md | 15 - .../docs/models/components/jsonschema.md | 23 - .../docs/models/components/loc.md | 17 - .../docs/models/components/messages.md | 52 - .../docs/models/components/prediction.md | 16 - .../docs/models/components/referencechunk.md | 20 - .../models/components/referencechunktype.md | 15 - .../docs/models/components/responseformat.md | 16 - .../docs/models/components/responseformats.md | 17 - .../docs/models/components/role.md | 15 - .../docs/models/components/security.md | 17 - .../docs/models/components/stop.md | 21 - .../docs/models/components/systemmessage.md | 23 - .../models/components/systemmessagecontent.md | 21 - .../docs/models/components/textchunk.md | 18 - .../docs/models/components/tool.md | 23 - .../docs/models/components/toolcall.md | 23 - .../docs/models/components/toolchoice.md | 22 - .../docs/models/components/toolchoiceenum.md | 15 - .../docs/models/components/toolmessage.md | 20 - .../models/components/toolmessagecontent.md | 24 - .../docs/models/components/toolmessagerole.md | 15 - .../docs/models/components/tooltypes.md | 17 - .../docs/models/components/type.md | 15 - .../docs/models/components/usageinfo.md | 21 - .../docs/models/components/usermessage.md | 18 - .../models/components/usermessagecontent.md | 24 - .../docs/models/components/usermessagerole.md | 15 - .../docs/models/components/validationerror.md | 23 - .../docs/models/errors/httpvalidationerror.md | 15 - .../mistralai-gcp/docs/sdks/chat/README.md | 115 - .../mistralai-gcp/docs/sdks/fim/README.md | 58 - .../docs/sdks/mistralgcp/README.md | 9 - .../packages/mistralai-gcp/eslint.config.mjs | 21 - .../packages/mistralai-gcp/jsr.json | 28 - .../packages/mistralai-gcp/package-lock.json | 2121 - .../packages/mistralai-gcp/package.json | 31 - .../packages/mistralai-gcp/src/core.ts | 13 - .../mistralai-gcp/src/funcs/chatComplete.ts | 160 - .../mistralai-gcp/src/funcs/chatStream.ts | 178 - .../mistralai-gcp/src/funcs/fimComplete.ts | 163 - .../mistralai-gcp/src/funcs/fimStream.ts | 178 - .../src/hooks/custom_user_agent.ts | 11 - .../packages/mistralai-gcp/src/hooks/hooks.ts | 132 - .../packages/mistralai-gcp/src/hooks/index.ts | 6 - .../mistralai-gcp/src/hooks/registration.ts | 16 - .../packages/mistralai-gcp/src/hooks/types.ts | 110 - .../packages/mistralai-gcp/src/index.ts | 7 - .../packages/mistralai-gcp/src/lib/base64.ts | 37 - .../packages/mistralai-gcp/src/lib/config.ts | 62 - .../packages/mistralai-gcp/src/lib/dlv.ts | 53 - .../mistralai-gcp/src/lib/encodings.ts | 483 - .../mistralai-gcp/src/lib/event-streams.ts | 264 - .../packages/mistralai-gcp/src/lib/files.ts | 40 - .../packages/mistralai-gcp/src/lib/http.ts | 323 - .../mistralai-gcp/src/lib/is-plain-object.ts | 43 - .../packages/mistralai-gcp/src/lib/logger.ts | 9 - .../mistralai-gcp/src/lib/matchers.ts | 325 - .../mistralai-gcp/src/lib/primitives.ts | 150 - .../packages/mistralai-gcp/src/lib/retries.ts | 218 - .../packages/mistralai-gcp/src/lib/schemas.ts | 91 - .../packages/mistralai-gcp/src/lib/sdks.ts | 391 - .../mistralai-gcp/src/lib/security.ts | 252 - .../packages/mistralai-gcp/src/lib/url.ts | 33 - .../src/models/components/assistantmessage.ts | 185 - .../models/components/chatcompletionchoice.ts | 137 - .../components/chatcompletionrequest.ts | 496 - .../components/chatcompletionresponse.ts | 98 - .../components/chatcompletionstreamrequest.ts | 482 - .../src/models/components/completionchunk.ts | 96 - .../src/models/components/completionevent.ts | 80 - .../completionresponsestreamchoice.ts | 136 - .../src/models/components/contentchunk.ts | 106 - .../src/models/components/deltamessage.ts | 138 - .../models/components/fimcompletionrequest.ts | 204 - .../components/fimcompletionresponse.ts | 98 - .../components/fimcompletionstreamrequest.ts | 203 - .../src/models/components/function.ts | 74 - .../src/models/components/functioncall.ts | 112 - .../src/models/components/functionname.ts | 65 - .../src/models/components/imageurl.ts | 66 - .../src/models/components/imageurlchunk.ts | 161 - .../src/models/components/index.ts | 39 - .../src/models/components/jsonschema.ts | 83 - .../src/models/components/prediction.ts | 66 - .../src/models/components/referencechunk.ts | 102 - .../src/models/components/responseformat.ts | 89 - .../src/models/components/responseformats.ts | 40 - .../src/models/components/security.ts | 71 - .../src/models/components/systemmessage.ts | 148 - .../src/models/components/textchunk.ts | 92 - .../src/models/components/tool.ts | 71 - .../src/models/components/toolcall.ts | 85 - .../src/models/components/toolchoice.ts | 83 - .../src/models/components/toolchoiceenum.ts | 35 - .../src/models/components/toolmessage.ts | 170 - .../src/models/components/tooltypes.ts | 47 - .../src/models/components/usageinfo.ts | 83 - .../src/models/components/usermessage.ts | 153 - .../src/models/components/validationerror.ts | 113 - .../src/models/errors/httpclienterrors.ts | 62 - .../src/models/errors/httpvalidationerror.ts | 70 - .../mistralai-gcp/src/models/errors/index.ts | 8 - .../src/models/errors/sdkerror.ts | 27 - .../src/models/errors/sdkvalidationerror.ts | 97 - .../packages/mistralai-gcp/src/sdk/chat.ts | 43 - .../packages/mistralai-gcp/src/sdk/fim.ts | 46 - .../packages/mistralai-gcp/src/sdk/index.ts | 5 - .../packages/mistralai-gcp/src/sdk/sdk.ts | 129 - .../packages/mistralai-gcp/src/types/async.ts | 68 - .../packages/mistralai-gcp/src/types/blobs.ts | 31 - .../mistralai-gcp/src/types/constdatetime.ts | 15 - .../packages/mistralai-gcp/src/types/enums.ts | 16 - .../packages/mistralai-gcp/src/types/fp.ts | 50 - .../packages/mistralai-gcp/src/types/index.ts | 11 - .../mistralai-gcp/src/types/operations.ts | 105 - .../mistralai-gcp/src/types/rfcdate.ts | 54 - .../mistralai-gcp/src/types/streams.ts | 21 - .../packages/mistralai-gcp/tsconfig.json | 41 - .../scripts/run_examples.sh | 24 - examples/sdks/mistral-typescript/src/core.ts | 13 - .../mistral-typescript/src/extra/README.md | 52 - .../src/extra/structChat.ts | 81 - .../src/funcs/agentsComplete.ts | 166 - .../src/funcs/agentsStream.ts | 182 - .../src/funcs/audioTranscriptionsComplete.ts | 206 - .../src/funcs/audioTranscriptionsStream.ts | 220 - .../src/funcs/batchJobsCancel.ts | 170 - .../src/funcs/batchJobsCreate.ts | 160 - .../src/funcs/batchJobsGet.ts | 170 - .../src/funcs/batchJobsList.ts | 174 - .../src/funcs/betaAgentsCreate.ts | 169 - .../src/funcs/betaAgentsGet.ts | 177 - .../src/funcs/betaAgentsList.ts | 179 - .../src/funcs/betaAgentsUpdate.ts | 180 - .../src/funcs/betaAgentsUpdateVersion.ts | 184 - .../src/funcs/betaConversationsAppend.ts | 182 - .../funcs/betaConversationsAppendStream.ts | 194 - .../src/funcs/betaConversationsGet.ts | 180 - .../src/funcs/betaConversationsGetHistory.ts | 181 - .../src/funcs/betaConversationsGetMessages.ts | 181 - .../src/funcs/betaConversationsList.ts | 177 - .../src/funcs/betaConversationsRestart.ts | 184 - .../funcs/betaConversationsRestartStream.ts | 194 - .../src/funcs/betaConversationsStart.ts | 169 - .../src/funcs/betaConversationsStartStream.ts | 180 - .../src/funcs/betaLibrariesAccessesDelete.ts | 178 - .../src/funcs/betaLibrariesAccessesList.ts | 177 - .../betaLibrariesAccessesUpdateOrCreate.ts | 178 - .../src/funcs/betaLibrariesCreate.ts | 169 - .../src/funcs/betaLibrariesDelete.ts | 176 - .../src/funcs/betaLibrariesDocumentsDelete.ts | 183 - ...ibrariesDocumentsExtractedTextSignedUrl.ts | 185 - .../src/funcs/betaLibrariesDocumentsGet.ts | 183 - .../betaLibrariesDocumentsGetSignedUrl.ts | 185 - .../src/funcs/betaLibrariesDocumentsList.ts | 186 - .../funcs/betaLibrariesDocumentsReprocess.ts | 185 - .../src/funcs/betaLibrariesDocumentsStatus.ts | 185 - .../betaLibrariesDocumentsTextContent.ts | 185 - .../src/funcs/betaLibrariesDocumentsUpdate.ts | 184 - .../src/funcs/betaLibrariesDocumentsUpload.ts | 206 - .../src/funcs/betaLibrariesGet.ts | 176 - .../src/funcs/betaLibrariesList.ts | 142 - .../src/funcs/betaLibrariesUpdate.ts | 177 - .../src/funcs/chatComplete.ts | 166 - .../src/funcs/chatStream.ts | 182 - .../src/funcs/classifiersClassify.ts | 166 - .../src/funcs/classifiersClassifyChat.ts | 166 - .../src/funcs/classifiersModerate.ts | 166 - .../src/funcs/classifiersModerateChat.ts | 166 - .../src/funcs/embeddingsCreate.ts | 169 - .../src/funcs/filesDelete.ts | 168 - .../src/funcs/filesDownload.ts | 168 - .../src/funcs/filesGetSignedUrl.ts | 170 - .../mistral-typescript/src/funcs/filesList.ts | 173 - .../src/funcs/filesRetrieve.ts | 168 - .../src/funcs/filesUpload.ts | 194 - .../src/funcs/fimComplete.ts | 169 - .../mistral-typescript/src/funcs/fimStream.ts | 182 - .../src/funcs/fineTuningJobsCancel.ts | 174 - .../src/funcs/fineTuningJobsCreate.ts | 165 - .../src/funcs/fineTuningJobsGet.ts | 171 - .../src/funcs/fineTuningJobsList.ts | 180 - .../src/funcs/fineTuningJobsStart.ts | 172 - .../src/funcs/modelsArchive.ts | 172 - .../src/funcs/modelsDelete.ts | 179 - .../src/funcs/modelsList.ts | 151 - .../src/funcs/modelsRetrieve.ts | 182 - .../src/funcs/modelsUnarchive.ts | 172 - .../src/funcs/modelsUpdate.ts | 174 - .../src/funcs/ocrProcess.ts | 166 - .../src/hooks/custom_user_agent.ts | 20 - .../src/hooks/deprecation_warning.ts | 19 - .../mistral-typescript/src/hooks/hooks.ts | 132 - .../mistral-typescript/src/hooks/index.ts | 6 - .../src/hooks/registration.ts | 22 - .../mistral-typescript/src/hooks/types.ts | 112 - examples/sdks/mistral-typescript/src/index.ts | 9 - .../sdks/mistral-typescript/src/lib/base64.ts | 37 - .../sdks/mistral-typescript/src/lib/config.ts | 66 - .../sdks/mistral-typescript/src/lib/dlv.ts | 53 - .../mistral-typescript/src/lib/encodings.ts | 483 - .../sdks/mistral-typescript/src/lib/env.ts | 41 - .../src/lib/event-streams.ts | 137 - .../sdks/mistral-typescript/src/lib/files.ts | 82 - .../sdks/mistral-typescript/src/lib/http.ts | 323 - .../src/lib/is-plain-object.ts | 43 - .../sdks/mistral-typescript/src/lib/logger.ts | 9 - .../mistral-typescript/src/lib/matchers.ts | 345 - .../mistral-typescript/src/lib/primitives.ts | 150 - .../mistral-typescript/src/lib/retries.ts | 218 - .../mistral-typescript/src/lib/schemas.ts | 91 - .../sdks/mistral-typescript/src/lib/sdks.ts | 407 - .../mistral-typescript/src/lib/security.ts | 264 - .../sdks/mistral-typescript/src/lib/url.ts | 33 - .../src/models/components/agent.ts | 400 - .../models/components/agentconversation.ts | 138 - .../models/components/agentcreationrequest.ts | 358 - .../components/agenthandoffdoneevent.ts | 131 - .../models/components/agenthandoffentry.ts | 175 - .../components/agenthandoffstartedevent.ts | 135 - .../components/agentscompletionrequest.ts | 499 - .../agentscompletionstreamrequest.ts | 512 - .../models/components/agentupdaterequest.ts | 358 - .../src/models/components/apiendpoint.ts | 56 - .../models/components/archiveftmodelout.ts | 103 - .../src/models/components/assistantmessage.ts | 185 - .../src/models/components/audiochunk.ts | 102 - .../components/audiotranscriptionrequest.ts | 133 - .../audiotranscriptionrequeststream.ts | 135 - .../src/models/components/basemodelcard.ts | 160 - .../src/models/components/batcherror.ts | 66 - .../src/models/components/batchjobin.ts | 100 - .../src/models/components/batchjobout.ts | 197 - .../src/models/components/batchjobsout.ts | 103 - .../src/models/components/batchjobstatus.ts | 38 - .../models/components/builtinconnectors.ts | 36 - .../components/chatclassificationrequest.ts | 88 - .../models/components/chatcompletionchoice.ts | 135 - .../components/chatcompletionrequest.ts | 503 - .../components/chatcompletionresponse.ts | 98 - .../components/chatcompletionstreamrequest.ts | 526 - .../components/chatmoderationrequest.ts | 603 - .../src/models/components/checkpointout.ts | 96 - .../components/classificationrequest.ts | 140 - .../components/classificationresponse.ts | 80 - .../components/classificationtargetresult.ts | 66 - .../components/classifierdetailedjobout.ts | 357 - .../models/components/classifierftmodelout.ts | 214 - .../src/models/components/classifierjobout.ts | 369 - .../models/components/classifiertargetin.ts | 92 - .../models/components/classifiertargetout.ts | 92 - .../classifiertrainingparameters.ts | 105 - .../classifiertrainingparametersin.ts | 120 - .../models/components/codeinterpretertool.ts | 95 - .../src/models/components/completionargs.ts | 145 - .../models/components/completionargsstop.ts | 58 - .../src/models/components/completionchunk.ts | 96 - .../components/completiondetailedjobout.ts | 411 - .../src/models/components/completionevent.ts | 80 - .../models/components/completionftmodelout.ts | 198 - .../src/models/components/completionjobout.ts | 412 - .../completionresponsestreamchoice.ts | 143 - .../completiontrainingparameters.ts | 111 - .../completiontrainingparametersin.ts | 126 - .../src/models/components/contentchunk.ts | 174 - .../components/conversationappendrequest.ts | 145 - .../conversationappendstreamrequest.ts | 153 - .../models/components/conversationevents.ts | 445 - .../models/components/conversationhistory.ts | 256 - .../models/components/conversationinputs.ts | 64 - .../models/components/conversationmessages.ts | 125 - .../models/components/conversationrequest.ts | 402 - .../models/components/conversationresponse.ts | 238 - .../components/conversationrestartrequest.ts | 154 - .../conversationrestartstreamrequest.ts | 162 - .../components/conversationstreamrequest.ts | 422 - .../components/conversationusageinfo.ts | 97 - .../src/models/components/deletefileout.ts | 79 - .../src/models/components/deletemodelout.ts | 79 - .../src/models/components/deltamessage.ts | 138 - .../models/components/documentlibrarytool.ts | 111 - .../src/models/components/documentout.ts | 158 - .../models/components/documenttextcontent.ts | 66 - .../src/models/components/documentupdatein.ts | 66 - .../src/models/components/documenturlchunk.ts | 115 - .../src/models/components/embeddingdtype.ts | 36 - .../src/models/components/embeddingrequest.ts | 169 - .../models/components/embeddingresponse.ts | 94 - .../components/embeddingresponsedata.ts | 74 - .../src/models/components/encodingformat.ts | 33 - .../src/models/components/entitytype.ts | 55 - .../src/models/components/eventout.ts | 85 - .../src/models/components/file.ts | 73 - .../src/models/components/filechunk.ts | 75 - .../src/models/components/filepurpose.ts | 49 - .../src/models/components/fileschema.ts | 147 - .../src/models/components/filesignedurl.ts | 62 - .../models/components/fimcompletionrequest.ts | 204 - .../components/fimcompletionresponse.ts | 98 - .../components/fimcompletionstreamrequest.ts | 203 - .../components/finetuneablemodeltype.ts | 33 - .../components/ftclassifierlossfunction.ts | 35 - .../components/ftmodelcapabilitiesout.ts | 97 - .../src/models/components/ftmodelcard.ts | 175 - .../src/models/components/function.ts | 74 - .../src/models/components/functioncall.ts | 112 - .../models/components/functioncallentry.ts | 171 - .../components/functioncallentryarguments.ts | 58 - .../models/components/functioncallevent.ts | 131 - .../src/models/components/functionname.ts | 65 - .../models/components/functionresultentry.ts | 163 - .../src/models/components/functiontool.ts | 99 - .../models/components/githubrepositoryin.ts | 113 - .../models/components/githubrepositoryout.ts | 124 - .../models/components/imagegenerationtool.ts | 95 - .../src/models/components/imageurl.ts | 66 - .../src/models/components/imageurlchunk.ts | 161 - .../src/models/components/index.ts | 196 - .../src/models/components/inputentries.ts | 116 - .../src/models/components/inputs.ts | 300 - .../src/models/components/instructrequest.ts | 236 - .../src/models/components/jobin.ts | 347 - .../src/models/components/jobmetadataout.ts | 105 - .../src/models/components/jobsout.ts | 214 - .../src/models/components/jsonschema.ts | 83 - .../models/components/legacyjobmetadataout.ts | 184 - .../src/models/components/libraryin.ts | 79 - .../src/models/components/libraryinupdate.ts | 68 - .../src/models/components/libraryout.ts | 153 - .../src/models/components/listdocumentout.ts | 80 - .../src/models/components/listfilesout.ts | 76 - .../src/models/components/listlibraryout.ts | 68 - .../src/models/components/listsharingout.ts | 68 - .../src/models/components/messageentries.ts | 74 - .../components/messageinputcontentchunks.ts | 110 - .../models/components/messageinputentry.ts | 255 - .../components/messageoutputcontentchunks.ts | 120 - .../models/components/messageoutputentry.ts | 261 - .../models/components/messageoutputevent.ts | 225 - .../src/models/components/metricout.ts | 86 - .../models/components/mistralpromptmode.ts | 47 - .../models/components/modelcapabilities.ts | 101 - .../models/components/modelconversation.ts | 409 - .../src/models/components/modellist.ts | 180 - .../src/models/components/moderationobject.ts | 85 - .../models/components/moderationresponse.ts | 80 - .../src/models/components/ocrimageobject.ts | 126 - .../models/components/ocrpagedimensions.ts | 83 - .../src/models/components/ocrpageobject.ts | 98 - .../src/models/components/ocrrequest.ts | 229 - .../src/models/components/ocrresponse.ts | 106 - .../src/models/components/ocrusageinfo.ts | 83 - .../models/components/outputcontentchunks.ts | 120 - .../src/models/components/paginationinfo.ts | 95 - .../src/models/components/prediction.ts | 66 - .../models/components/processingstatusout.ts | 81 - .../src/models/components/referencechunk.ts | 102 - .../models/components/responsedoneevent.ts | 121 - .../models/components/responseerrorevent.ts | 119 - .../src/models/components/responseformat.ts | 89 - .../src/models/components/responseformats.ts | 40 - .../models/components/responsestartedevent.ts | 119 - .../src/models/components/retrievefileout.ts | 153 - .../src/models/components/sampletype.ts | 51 - .../src/models/components/security.ts | 71 - .../src/models/components/shareenum.ts | 48 - .../src/models/components/sharingdelete.ts | 94 - .../src/models/components/sharingin.ts | 103 - .../src/models/components/sharingout.ts | 99 - .../src/models/components/source.ts | 42 - .../src/models/components/ssetypes.ts | 45 - .../src/models/components/systemmessage.ts | 156 - .../components/systemmessagecontentchunks.ts | 92 - .../src/models/components/textchunk.ts | 93 - .../src/models/components/thinkchunk.ts | 162 - .../models/components/timestampgranularity.ts | 32 - .../src/models/components/tool.ts | 71 - .../src/models/components/toolcall.ts | 85 - .../src/models/components/toolchoice.ts | 83 - .../src/models/components/toolchoiceenum.ts | 35 - .../components/toolexecutiondeltaevent.ts | 136 - .../components/toolexecutiondoneevent.ts | 134 - .../models/components/toolexecutionentry.ts | 168 - .../components/toolexecutionstartedevent.ts | 136 - .../src/models/components/toolfilechunk.ts | 123 - .../src/models/components/toolmessage.ts | 170 - .../models/components/toolreferencechunk.ts | 118 - .../src/models/components/tooltypes.ts | 47 - .../src/models/components/trainingfile.ts | 75 - .../components/transcriptionresponse.ts | 112 - .../components/transcriptionsegmentchunk.ts | 122 - .../components/transcriptionstreamdone.ts | 149 - .../components/transcriptionstreamevents.ts | 273 - .../transcriptionstreameventtypes.ts | 37 - .../components/transcriptionstreamlanguage.ts | 128 - .../transcriptionstreamsegmentdelta.ts | 133 - .../transcriptionstreamtextdelta.ts | 123 - .../models/components/unarchiveftmodelout.ts | 103 - .../src/models/components/updateftmodelin.ts | 68 - .../src/models/components/uploadfileout.ts | 147 - .../src/models/components/usageinfo.ts | 103 - .../src/models/components/usermessage.ts | 153 - .../src/models/components/validationerror.ts | 113 - .../src/models/components/wandbintegration.ts | 129 - .../models/components/wandbintegrationout.ts | 126 - .../models/components/websearchpremiumtool.ts | 95 - .../src/models/components/websearchtool.ts | 89 - .../src/models/errors/httpclienterrors.ts | 62 - .../src/models/errors/httpvalidationerror.ts | 80 - .../src/models/errors/index.ts | 9 - .../src/models/errors/mistralerror.ts | 35 - .../models/errors/responsevalidationerror.ts | 50 - .../src/models/errors/sdkerror.ts | 40 - .../src/models/errors/sdkvalidationerror.ts | 109 - .../models/operations/agentsapiv1agentsget.ts | 77 - .../operations/agentsapiv1agentslist.ts | 81 - .../operations/agentsapiv1agentsupdate.ts | 84 - .../agentsapiv1agentsupdateversion.ts | 84 - .../agentsapiv1conversationsappend.ts | 91 - .../agentsapiv1conversationsappendstream.ts | 101 - .../operations/agentsapiv1conversationsget.ts | 160 - .../agentsapiv1conversationshistory.ts | 84 - .../agentsapiv1conversationslist.ts | 141 - .../agentsapiv1conversationsmessages.ts | 89 - .../agentsapiv1conversationsrestart.ts | 93 - .../agentsapiv1conversationsrestartstream.ts | 101 - .../deletemodelv1modelsmodeliddelete.ts | 89 - .../operations/filesapiroutesdeletefile.ts | 77 - .../operations/filesapiroutesdownloadfile.ts | 78 - .../operations/filesapiroutesgetsignedurl.ts | 85 - .../operations/filesapirouteslistfiles.ts | 102 - .../operations/filesapiroutesretrievefile.ts | 78 - .../operations/filesapiroutesuploadfile.ts | 98 - .../src/models/operations/index.ts | 51 - .../jobsapiroutesbatchcancelbatchjob.ts | 86 - .../jobsapiroutesbatchgetbatchjob.ts | 80 - .../jobsapiroutesbatchgetbatchjobs.ts | 119 - ...piroutesfinetuningarchivefinetunedmodel.ts | 92 - ...sapiroutesfinetuningcancelfinetuningjob.ts | 186 - ...sapiroutesfinetuningcreatefinetuningjob.ts | 177 - ...jobsapiroutesfinetuninggetfinetuningjob.ts | 186 - ...obsapiroutesfinetuninggetfinetuningjobs.ts | 208 - ...bsapiroutesfinetuningstartfinetuningjob.ts | 183 - ...routesfinetuningunarchivefinetunedmodel.ts | 92 - ...apiroutesfinetuningupdatefinetunedmodel.ts | 192 - .../models/operations/librariesdeletev1.ts | 75 - .../operations/librariesdocumentsdeletev1.ts | 84 - ...iesdocumentsgetextractedtextsignedurlv1.ts | 95 - .../librariesdocumentsgetsignedurlv1.ts | 92 - .../librariesdocumentsgetstatusv1.ts | 86 - .../librariesdocumentsgettextcontentv1.ts | 93 - .../operations/librariesdocumentsgetv1.ts | 83 - .../operations/librariesdocumentslistv1.ts | 103 - .../librariesdocumentsreprocessv1.ts | 86 - .../operations/librariesdocumentsupdatev1.ts | 91 - .../operations/librariesdocumentsuploadv1.ts | 172 - .../src/models/operations/librariesgetv1.ts | 75 - .../operations/librariessharecreatev1.ts | 84 - .../operations/librariessharedeletev1.ts | 84 - .../models/operations/librariessharelistv1.ts | 77 - .../models/operations/librariesupdatev1.ts | 82 - .../retrievemodelv1modelsmodelidget.ts | 178 - .../mistral-typescript/src/sdk/accesses.ts | 64 - .../sdks/mistral-typescript/src/sdk/agents.ts | 43 - .../sdks/mistral-typescript/src/sdk/audio.ts | 13 - .../sdks/mistral-typescript/src/sdk/batch.ts | 13 - .../sdks/mistral-typescript/src/sdk/beta.ts | 25 - .../sdks/mistral-typescript/src/sdk/chat.ts | 96 - .../mistral-typescript/src/sdk/classifiers.ts | 69 - .../src/sdk/conversations.ts | 191 - .../mistral-typescript/src/sdk/documents.ts | 190 - .../mistral-typescript/src/sdk/embeddings.ts | 27 - .../sdks/mistral-typescript/src/sdk/files.ts | 119 - .../sdks/mistral-typescript/src/sdk/fim.ts | 46 - .../mistral-typescript/src/sdk/finetuning.ts | 13 - .../sdks/mistral-typescript/src/sdk/index.ts | 5 - .../sdks/mistral-typescript/src/sdk/jobs.ts | 102 - .../mistral-typescript/src/sdk/libraries.ts | 110 - .../src/sdk/mistralagents.ts | 100 - .../mistral-typescript/src/sdk/mistraljobs.ts | 82 - .../sdks/mistral-typescript/src/sdk/models.ts | 118 - .../sdks/mistral-typescript/src/sdk/ocr.ts | 24 - .../mistral-typescript/src/sdk/oldclient.ts | 5 - .../sdks/mistral-typescript/src/sdk/sdk.ts | 79 - .../src/sdk/transcriptions.ts | 40 - .../mistral-typescript/src/types/async.ts | 68 - .../mistral-typescript/src/types/blobs.ts | 31 - .../src/types/constdatetime.ts | 15 - .../mistral-typescript/src/types/enums.ts | 16 - .../sdks/mistral-typescript/src/types/fp.ts | 50 - .../mistral-typescript/src/types/index.ts | 11 - .../src/types/operations.ts | 105 - .../mistral-typescript/src/types/rfcdate.ts | 54 - .../mistral-typescript/src/types/streams.ts | 21 - .../tests/extra/structChat.test.ts | 194 - .../mistral-typescript/tests/jest.config.js | 5 - .../tests/package-lock.json | 3847 - .../mistral-typescript/tests/package.json | 17 - .../mistral-typescript/tests/tsconfig.json | 16 - .../sdks/mistral-typescript/tsconfig.json | 41 - examples/specs/glean.yaml | 12470 -- examples/specs/mistral.yaml | 7938 - examples/specs/pokeapi.yml | 9433 -- packages/compiler/package.json | 2 +- packages/react/LICENSE | 21 - packages/react/README.md | 26 - packages/react/package.json | 2 +- packages/shared/package.json | 2 +- packages/web-components/package.json | 2 +- 1833 files changed, 524 insertions(+), 1260784 deletions(-) create mode 100644 LICENSE delete mode 100644 examples/custom/README.md delete mode 100644 examples/custom/next-env.d.ts delete mode 100644 examples/custom/next.config.ts delete mode 100644 examples/custom/package.json delete mode 100644 examples/custom/public/mistral-try-it-now/deps.js delete mode 100644 examples/custom/public/mistral-try-it-now/tsworker.js delete mode 100644 examples/custom/public/mistral-try-it-now/types.d.ts delete mode 100644 examples/custom/speakeasy.mistral.config.mjs delete mode 100644 examples/custom/speakeasy.pokeapi.config.mjs delete mode 100644 examples/custom/src/app/favicon.ico delete mode 100644 examples/custom/src/app/globals.css delete mode 100644 examples/custom/src/app/layout.tsx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/agents/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/batch/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/beta/agents/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/beta/conversations/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/beta/libraries/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/chat/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/classifiers/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/embeddings/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/files/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/fim/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/fine-tuning/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/models/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/endpoint/ocr/page.mdx delete mode 100644 examples/custom/src/app/mistral/api/page.mdx delete mode 100644 examples/custom/src/app/mistral/layout.tsx delete mode 100644 examples/custom/src/app/mistral/page.tsx delete mode 100644 examples/custom/src/app/mistral/sidebarMetadata.json delete mode 100644 examples/custom/src/app/page.tsx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/berries/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/contests/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/encounters/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/evolution/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/games/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/items/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/location/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/machines/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/moves/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/pokemon/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/endpoint/utility/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/api/page.mdx delete mode 100644 examples/custom/src/app/pokeapi/layout.tsx delete mode 100644 examples/custom/src/app/pokeapi/page.tsx delete mode 100644 examples/custom/src/app/pokeapi/sidebarMetadata.json delete mode 100644 examples/custom/src/app/speakeasy.css delete mode 100644 examples/custom/src/components/Sidebar.tsx delete mode 100644 examples/custom/src/components/mdx.tsx delete mode 100644 examples/custom/src/components/speakeasy-custom/Operation.tsx delete mode 100644 examples/custom/src/components/speakeasy-custom/index.tsx delete mode 100644 examples/custom/src/components/styles.module.css delete mode 100644 examples/custom/src/mdx-components.module.css delete mode 100644 examples/custom/src/mdx-components.tsx delete mode 100644 examples/custom/tsconfig.json delete mode 100644 examples/docusaurus/.gitignore delete mode 100644 examples/docusaurus/README.md delete mode 100644 examples/docusaurus/docs/glean/api/_category_.json delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/_category_.json delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/activity.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/agents.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/announcements.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/answers.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/authentication.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/chat.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/collections.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/documents.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/entities.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/governance/data/reports.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/governance/documents/visibilityoverrides.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/insights.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/messages.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/pins.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/search.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/shortcuts.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/tools.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/client/verification.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/authentication.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/datasource.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/datasources.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/documents.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/people.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/permissions.mdx delete mode 100644 examples/docusaurus/docs/glean/api/endpoint/indexing/shortcuts.mdx delete mode 100644 examples/docusaurus/docs/glean/api/index.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/_category_.json delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/_category_.json delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/agents.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/audio/transcriptions.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/batch.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/beta/agents.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/beta/conversations.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/beta/libraries.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/accesses.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/documents.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/chat.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/classifiers.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/embeddings.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/files.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/fim.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/fine-tuning.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/models.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/endpoint/ocr.mdx delete mode 100644 examples/docusaurus/docs/mistral/api/index.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/_category_.json delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/_category_.json delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/berries.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/contests.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/encounters.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/evolution.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/games.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/items.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/location.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/machines.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/moves.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/pokemon.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/endpoint/utility.mdx delete mode 100644 examples/docusaurus/docs/pokeapi/api/index.mdx delete mode 100644 examples/docusaurus/docusaurus.config.ts delete mode 100644 examples/docusaurus/package.json delete mode 100644 examples/docusaurus/public/glean-try-it-now/deps.js delete mode 100644 examples/docusaurus/public/glean-try-it-now/tsworker.js delete mode 100644 examples/docusaurus/public/glean-try-it-now/types.d.ts delete mode 100644 examples/docusaurus/public/mistral-try-it-now/deps.js delete mode 100644 examples/docusaurus/public/mistral-try-it-now/mistralai-1.9.11-py3-none-any.whl delete mode 100644 examples/docusaurus/public/mistral-try-it-now/pyworker.js delete mode 100644 examples/docusaurus/public/mistral-try-it-now/tsworker.js delete mode 100644 examples/docusaurus/public/mistral-try-it-now/types.d.ts delete mode 100644 examples/docusaurus/sidebars.ts delete mode 100644 examples/docusaurus/speakeasy.glean.config.mjs delete mode 100644 examples/docusaurus/speakeasy.mistral.config.mjs delete mode 100644 examples/docusaurus/speakeasy.pokeapi.config.mjs delete mode 100644 examples/docusaurus/src/components/HomepageFeatures/index.tsx delete mode 100644 examples/docusaurus/src/components/HomepageFeatures/styles.module.css delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/action.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/actioncounts.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/activedaycount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/activities.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/activitycount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/activityinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/actor.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/addedroles.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/additionalfields.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/additionalquerysuggestions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/agentconfig.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/aggregatevisitcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/aiappinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/allclusteredresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/allowedgroupintersections.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/allowedusers.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/allowlistoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/announcement.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/answer.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/answerauthor.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/answerboard.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/app.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/assignee.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/assistantinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/attachments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/attendees.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/attribution.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/audiencefilters.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/author.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/authtokens.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/backlinkresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/banner.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/board.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/body.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/broadsharingoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/buckets.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/candidateverifiers.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/capabilities.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/categorytoresultsize.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/chat.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/chatsuggestion.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/chattranscript.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/chatzerostatesuggestionoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/children.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/citation.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/citations.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/classifications.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/clickcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/clusteredresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/code.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/collection.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/collectionitem.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/collections.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/combinedanswertext.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/comments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/company.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/conferencedata.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/config.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/containerdocument.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/content.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/context.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/countinfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/createdby.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/creator.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/customentity.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/customer.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/customfields.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/customproperties.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/customtimerange.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/datasourceprofiles.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/debuginfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/destinationdocument.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/digest.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/disambiguation.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/document.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/documentinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/documents.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/documentvisitorcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/eligiblepins.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/emails.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/end.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/event.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/exclusions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/existingpins.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/externallinks.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/externalsharingoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/extractedqna.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/facetbucketfilter.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/facetfilters.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/facetfiltersets.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/facetresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/favoriteinfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/file.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/filters.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/followupactions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/fragments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/generatedattachments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/generatedqna.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/generatedqnaresult.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/gleandataerror.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/group.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/groupattendees.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/hotwords.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/icon.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/iconconfig.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/implementations.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/inactiveinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/inclusions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/inputdetails.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/inputoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/interactions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/items.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/lastreminder.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/lastverifier.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/likedby.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/likes.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/lines.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/lowperformingqueryinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/meeting.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/members.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/mergedcustomers.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/messages.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/metadata.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/mustincludesuggestions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/objects.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/operatormetadata.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/owner.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/parameters.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/params.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/parentdocument.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/people.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/period.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/permissions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/person.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/pinmetadata.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/pins.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/poc.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/possiblevalues.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/primaryentry.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/prompttemplate.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/properties.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/propertydefinitions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/propertygroups.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/proximity.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/queryinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/querysuggestion.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/querysuggestions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/questionresult.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/quicklink.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/ranges.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/referenceranges.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/relateddocuments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/relatedobjects.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/relatedquestion.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/relatedresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/relationships.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/reminders.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/removedroles.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/requestoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/requestor.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/responsemetadata.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/resultdocuments.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/results.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/resultsdescription.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/resulttabs.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/rewrittenfacetfilters.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/roles.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/runcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/scopes.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchedqueryranges.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchorcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchproviderinfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchwarning.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/searchwithclickcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/secondaryentries.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sections.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sensitivecontentoptions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sensitiveinfotypes.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sensitiveregexes.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sensitiveterms.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sessioninfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/shortcut.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/shortcutinsights.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/similarqueries.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/snippets.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/socialnetworks.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sourcedocument.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sourcefile.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/sourceperson.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/start.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/status.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/structuredlist.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/structuredlocation.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/structuredresult.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/structuredresults.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/suggestions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/summary.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/target.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/team.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/teams.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/textrange.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/thumbnail.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/time.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/uiconfig.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/updatedby.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/uploadedpermissions.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/user.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/value.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/values.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/verification.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/viewcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/viewerinfo.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/visitcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/visitorcount.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/workflow.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/contents/write.mdx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/action.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/actioncounts.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/activedaycount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/activities.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/activitycount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/activityinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/actor.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/addedroles.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/additionalfields.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/additionalquerysuggestions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/agentconfig.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/aggregatevisitcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/aiappinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/allclusteredresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/allowedgroupintersections.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/allowedusers.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/allowlistoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/announcement.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/answer.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/answerauthor.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/answerboard.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/app.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/assignee.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/assistantinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/attachments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/attendees.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/attribution.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/audiencefilters.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/author.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/authtokens.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/backlinkresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/banner.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/board.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/body.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/broadsharingoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/buckets.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/candidateverifiers.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/capabilities.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/categorytoresultsize.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/chat.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/chatsuggestion.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/chattranscript.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/chatzerostatesuggestionoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/children.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/citation.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/citations.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/classifications.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/clickcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/clusteredresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/code.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/collection.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/collectionitem.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/collections.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/combinedanswertext.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/comments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/company.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/conferencedata.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/config.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/containerdocument.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/content.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/context.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/countinfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/createdby.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/creator.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/customentity.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/customer.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/customfields.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/customproperties.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/customtimerange.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/datasourceprofiles.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/debuginfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/destinationdocument.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/digest.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/disambiguation.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/document.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/documentinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/documents.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/documentvisitorcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/eligiblepins.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/emails.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/end.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/event.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/exclusions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/existingpins.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/externallinks.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/externalsharingoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/extractedqna.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/facetbucketfilter.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/facetfilters.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/facetfiltersets.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/facetresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/favoriteinfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/file.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/filters.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/followupactions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/fragments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/generatedattachments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/generatedqna.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/generatedqnaresult.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/gleandataerror.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/group.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/groupattendees.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/hotwords.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/icon.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/iconconfig.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/implementations.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/inactiveinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/inclusions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/inputdetails.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/inputoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/interactions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/items.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/lastreminder.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/lastverifier.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/likedby.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/likes.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/lines.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/lowperformingqueryinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/meeting.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/members.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/mergedcustomers.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/messages.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/metadata.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/mustincludesuggestions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/objects.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/operatormetadata.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/owner.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/parameters.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/params.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/parentdocument.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/people.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/period.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/permissions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/person.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/pinmetadata.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/pins.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/poc.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/possiblevalues.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/primaryentry.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/prompttemplate.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/properties.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/propertydefinitions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/propertygroups.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/proximity.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/queryinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/querysuggestion.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/querysuggestions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/questionresult.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/quicklink.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/ranges.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/referenceranges.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/relateddocuments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/relatedobjects.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/relatedquestion.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/relatedresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/relationships.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/reminders.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/removedroles.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/requestoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/requestor.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/responsemetadata.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/resultdocuments.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/results.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/resultsdescription.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/resulttabs.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/rewrittenfacetfilters.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/roles.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/runcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/scopes.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchedqueryranges.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchorcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchproviderinfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchwarning.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/searchwithclickcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/secondaryentries.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sections.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sensitivecontentoptions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sensitiveinfotypes.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sensitiveregexes.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sensitiveterms.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sessioninfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/shortcut.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/shortcutinsights.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/similarqueries.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/snippets.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/socialnetworks.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sourcedocument.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sourcefile.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/sourceperson.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/start.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/status.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/structuredlist.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/structuredlocation.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/structuredresult.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/structuredresults.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/suggestions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/summary.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/target.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/team.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/teams.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/textrange.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/thumbnail.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/time.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/uiconfig.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/updatedby.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/uploadedpermissions.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/user.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/value.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/values.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/verification.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/viewcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/viewerinfo.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/visitcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/visitorcount.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/workflow.tsx delete mode 100644 examples/docusaurus/src/components/glean-embeds/loaders/write.tsx delete mode 100644 examples/docusaurus/src/css/custom.css delete mode 100644 examples/docusaurus/src/pages/index.module.css delete mode 100644 examples/docusaurus/src/pages/index.tsx delete mode 100644 examples/docusaurus/src/pages/markdown-page.md delete mode 100644 examples/docusaurus/tsconfig.json delete mode 100644 examples/nextra/next-env.d.ts delete mode 100644 examples/nextra/next.config.ts delete mode 100644 examples/nextra/package.json delete mode 100644 examples/nextra/public/mistral-try-it-now/deps.js delete mode 100644 examples/nextra/public/mistral-try-it-now/tsworker.js delete mode 100644 examples/nextra/public/mistral-try-it-now/types.d.ts delete mode 100644 examples/nextra/speakeasy.mistral.config.mjs delete mode 100644 examples/nextra/speakeasy.pokeapi.config.mjs delete mode 100644 examples/nextra/src/app/layout.tsx delete mode 100644 examples/nextra/src/app/mistral/api/_meta.ts delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/agents/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/batch/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/beta/agents/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/beta/conversations/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/beta/libraries/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/chat/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/classifiers/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/embeddings/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/files/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/fim/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/fine-tuning/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/models/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/endpoint/ocr/page.mdx delete mode 100644 examples/nextra/src/app/mistral/api/page.mdx delete mode 100644 examples/nextra/src/app/mistral/page.mdx delete mode 100644 examples/nextra/src/app/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/_meta.ts delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/berries/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/contests/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/encounters/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/evolution/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/games/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/items/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/location/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/machines/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/moves/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/pokemon/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/endpoint/utility/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/api/page.mdx delete mode 100644 examples/nextra/src/app/pokeapi/page.mdx delete mode 100644 examples/nextra/src/components/PropertiesModal.tsx delete mode 100644 examples/nextra/src/components/styles.css delete mode 100644 examples/nextra/src/mdx-components.tsx delete mode 100644 examples/nextra/tsconfig.json delete mode 100644 examples/sdks/glean-typescript.tar.gz delete mode 100644 examples/sdks/mistral-python.tar.gz delete mode 100644 examples/sdks/mistral-typescript.tar.gz delete mode 100644 examples/sdks/mistral-typescript/.devcontainer/README.md delete mode 100644 examples/sdks/mistral-typescript/.devcontainer/devcontainer.json delete mode 100644 examples/sdks/mistral-typescript/.devcontainer/setup.sh delete mode 100644 examples/sdks/mistral-typescript/.genignore delete mode 100644 examples/sdks/mistral-typescript/.gitattributes delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/run_example_scripts.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_azure_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_gcp_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_azure_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_gcp_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_sdk.yaml delete mode 100644 examples/sdks/mistral-typescript/.github/workflows/test_custom_code.yaml delete mode 100644 examples/sdks/mistral-typescript/.gitignore delete mode 100644 examples/sdks/mistral-typescript/.npmignore delete mode 100644 examples/sdks/mistral-typescript/.speakeasy/gen.lock delete mode 100644 examples/sdks/mistral-typescript/.speakeasy/gen.yaml delete mode 100644 examples/sdks/mistral-typescript/.speakeasy/workflow.lock delete mode 100644 examples/sdks/mistral-typescript/.speakeasy/workflow.yaml delete mode 100644 examples/sdks/mistral-typescript/CONTRIBUTING.md delete mode 100644 examples/sdks/mistral-typescript/FUNCTIONS.md delete mode 100644 examples/sdks/mistral-typescript/LICENSE delete mode 100644 examples/sdks/mistral-typescript/README.md delete mode 100644 examples/sdks/mistral-typescript/RELEASES.md delete mode 100644 examples/sdks/mistral-typescript/RUNTIMES.md delete mode 100644 examples/sdks/mistral-typescript/USAGE.md delete mode 100644 examples/sdks/mistral-typescript/docs/lib/utils/retryconfig.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentconversation.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentconversationobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentcreationrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentcreationrequesttools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffentryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agenttools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentupdaterequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/agentupdaterequesttools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/apiendpoint.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/archiveftmodelout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/archiveftmodeloutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/arguments.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/assistantmessage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/assistantmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/assistantmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/audiochunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/audiochunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequeststream.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/basemodelcard.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/basemodelcardtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batcherror.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjobin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjobout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjoboutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjobsout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjobsoutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/batchjobstatus.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/builtinconnectors.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatclassificationrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequestinputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/checkpointout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classificationrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classificationrequestinputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classificationresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classificationtargetresult.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjobout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutintegrations.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutjobtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutstatus.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierftmodelout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutmodeltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierjobout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierjoboutintegrations.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierjoboutjobtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierjoboutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifierjoboutstatus.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifiertargetin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifiertargetout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparameters.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparametersin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/codeinterpretertool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/codeinterpretertooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionargs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionargsstop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjobout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutintegrations.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutjobtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutrepositories.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutstatus.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionftmodelout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionftmodeloutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionjobout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionjoboutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoicefinishreason.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiontrainingparameters.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/completiontrainingparametersin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/content.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/contentchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationappendrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationappendrequesthandoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequesthandoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationevents.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationeventsdata.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationhistory.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationhistoryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationinputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationmessagesobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationresponseobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequesthandoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequesthandoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesthandoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesttools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/conversationusageinfo.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/data.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/deletefileout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/deletemodelout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/deltamessage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/document.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documentlibrarytool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documentlibrarytooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documentout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documenttextcontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documentupdatein.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documenturlchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/documenturlchunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/embeddingdtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/embeddingrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/embeddingrequestinputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/embeddingresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/embeddingresponsedata.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/encodingformat.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/entitytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/entries.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/eventout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/filechunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/filepurpose.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fileschema.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/filesignedurl.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/filet.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fimcompletionresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/finetuneablemodeltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/finishreason.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ftclassifierlossfunction.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ftmodelcapabilitiesout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ftmodelcard.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ftmodelcardtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncall.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncallentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncallentryarguments.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncallentryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncallentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncallevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functioncalleventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functionname.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functionresultentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functionresultentryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functionresultentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functiont.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functiontool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/functiontooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/githubrepositoryin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/githubrepositoryintype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/githubrepositoryout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/githubrepositoryouttype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/handoffexecution.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/hyperparameters.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imagegenerationtool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imagegenerationtooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imageurl.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imageurlchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imageurlchunkimageurl.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/imageurlchunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/inputentries.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/inputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/instructrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/instructrequestinputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/instructrequestinputsmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/instructrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/integrations.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobinintegrations.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobinrepositories.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobmetadataout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobsout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobsoutdata.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobsoutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jobtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/jsonschema.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataoutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/libraryin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/libraryinupdate.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/libraryout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/listdocumentout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/listfilesout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/listlibraryout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/listsharingout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/loc.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageentries.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageinputcontentchunks.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageinputentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageinputentrycontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageinputentryrole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageinputentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputcontentchunks.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputentrycontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputentryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputentryrole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputeventcontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputeventrole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messageoutputeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/messages.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/metricout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/mistralpromptmode.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modelcapabilities.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modelconversation.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modelconversationobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modelconversationtools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modellist.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/modeltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/moderationobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/moderationresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/objectt.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrimageobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrpagedimensions.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrpageobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ocrusageinfo.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/one.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/outputcontentchunks.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/outputs.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/paginationinfo.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/prediction.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/processingstatusout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/referencechunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/referencechunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/repositories.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responsedoneevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responsedoneeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responseerrorevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responseerroreventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responseformat.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responseformats.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responsestartedevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/responsestartedeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/retrievefileout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/role.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/sampletype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/security.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/shareenum.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/sharingdelete.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/sharingin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/sharingout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/source.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/ssetypes.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/status.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/stop.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/systemmessage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/systemmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/systemmessagecontentchunks.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/textchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/textchunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/thinkchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/thinkchunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/thinking.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/timestampgranularity.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/tool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolcall.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolchoice.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolchoiceenum.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutionentry.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutionentryobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutionentrytype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedevent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedeventtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolfilechunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolfilechunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolmessage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolreferencechunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/toolreferencechunktype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/tools.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/tooltypes.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/trainingfile.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionsegmentchunk.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdone.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdonetype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamevents.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventsdata.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventtypes.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguagetype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdelta.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdeltatype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdelta.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdeltatype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/two.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/type.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodelout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodeloutobject.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/updateftmodelin.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/uploadfileout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/usageinfo.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/usermessage.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/usermessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/usermessagerole.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/validationerror.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/wandbintegration.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/wandbintegrationout.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/wandbintegrationouttype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/wandbintegrationtype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/websearchtool.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/components/websearchtooltype.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/errors/httpvalidationerror.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsgetrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentslistrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdaterequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdateversionrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationshistoryrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationslistrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsmessagesrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/deletemodelv1modelsmodeliddeleterequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdeletefilerequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdownloadfilerequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesgetsignedurlrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapirouteslistfilesrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesretrievefilerequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesuploadfilemultipartbodyparams.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchcancelbatchjobrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobsrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdeletev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsdeletev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetsignedurlv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetstatusv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgettextcontentv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentslistv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsreprocessv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsupdatev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1documentupload.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesgetv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariessharecreatev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariessharedeletev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariessharelistv1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/librariesupdatev1request.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/one.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/responsebody.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetrequest.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md delete mode 100644 examples/sdks/mistral-typescript/docs/models/operations/status.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/accesses/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/agents/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/audio/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/batch/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/beta/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/chat/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/classifiers/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/conversations/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/documents/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/embeddings/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/files/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/fim/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/finetuning/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/jobs/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/libraries/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/mistral/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/mistralagents/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/mistraljobs/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/models/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/ocr/README.md delete mode 100644 examples/sdks/mistral-typescript/docs/sdks/transcriptions/README.md delete mode 100644 examples/sdks/mistral-typescript/eslint.config.mjs delete mode 100644 examples/sdks/mistral-typescript/examples/.env.template delete mode 100644 examples/sdks/mistral-typescript/examples/.gitignore delete mode 100644 examples/sdks/mistral-typescript/examples/README.md delete mode 100644 examples/sdks/mistral-typescript/examples/package-lock.json delete mode 100644 examples/sdks/mistral-typescript/examples/package.json delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_audio_transcription_stream.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_chat_no_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_chat_prediction.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_chat_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_chat_with_image_no_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_conversation_agent.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_embeddings.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_files.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_function_calling.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_function_calling_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_jobs.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_json_format.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_list_models.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_file.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_url.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/async_structured_outputs.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/azure/async_chat_no_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/error_handling.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/file.jsonl delete mode 100644 examples/sdks/mistral-typescript/examples/src/gcp/async_chat_no_streaming.ts delete mode 100644 examples/sdks/mistral-typescript/examples/src/ocr.pdf delete mode 100644 examples/sdks/mistral-typescript/examples/test.ts delete mode 100644 examples/sdks/mistral-typescript/examples/tsconfig.json delete mode 100644 examples/sdks/mistral-typescript/jsr.json delete mode 100644 examples/sdks/mistral-typescript/package-lock.json delete mode 100644 examples/sdks/mistral-typescript/package.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.genignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.gitattributes delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.gitignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.npmignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.lock delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.yaml delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/CONTRIBUTING.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/FUNCTIONS.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/LICENSE delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/RELEASES.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/RUNTIMES.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/USAGE.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/lib/utils/retryconfig.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/arguments.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoicefinishreason.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionresponse.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionevent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionresponsestreamchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/content.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/contentchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/deltamessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/document.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunktype.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/filechunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/finishreason.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functioncall.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functionname.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functiont.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurl.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunkimageurl.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunktype.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/jsonschema.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/loc.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/messages.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/mistralpromptmode.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrimageobject.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpagedimensions.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpageobject.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrresponse.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrusageinfo.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/prediction.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunktype.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformat.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformats.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/role.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/security.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/stop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/textchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tool.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolcall.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoiceenum.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tooltypes.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/type.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usageinfo.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/validationerror.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/errors/httpvalidationerror.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/chat/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/mistralazure/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/eslint.config.mjs delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/jsr.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/package-lock.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/package.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/core.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatComplete.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatStream.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/ocrProcess.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/custom_user_agent.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/hooks.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/registration.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/types.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/base64.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/config.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/dlv.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/encodings.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/env.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/event-streams.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/files.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/http.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/is-plain-object.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/logger.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/matchers.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/primitives.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/retries.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/schemas.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/sdks.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/security.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/url.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/assistantmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionevent.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionresponsestreamchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/contentchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/deltamessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/documenturlchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/filechunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/function.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functioncall.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functionname.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurl.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurlchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/jsonschema.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/mistralpromptmode.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrimageobject.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpagedimensions.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpageobject.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrresponse.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrusageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/prediction.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/referencechunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformat.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformats.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/security.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/systemmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/textchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tool.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolcall.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoiceenum.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tooltypes.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usermessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/validationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpclienterrors.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/chat.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/ocr.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/sdk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/async.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/blobs.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/constdatetime.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/enums.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/fp.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/operations.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/rfcdate.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/streams.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-azure/tsconfig.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.genignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitattributes delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.npmignore delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.lock delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.yaml delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/CONTRIBUTING.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/FUNCTIONS.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/LICENSE delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/RELEASES.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/RUNTIMES.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/USAGE.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/lib/utils/retryconfig.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/arguments.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoicefinishreason.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequestmessages.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionresponse.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequesttoolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionevent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionresponsestreamchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/content.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/contentchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/deltamessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionresponse.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequest.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequeststop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/finishreason.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functioncall.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functionname.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functiont.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurl.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunkimageurl.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunktype.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/jsonschema.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/loc.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/messages.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/prediction.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunktype.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformat.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformats.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/role.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/security.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/stop.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/textchunk.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tool.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolcall.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoice.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoiceenum.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tooltypes.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/type.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usageinfo.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessage.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagecontent.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagerole.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/validationerror.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/errors/httpvalidationerror.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/chat/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/fim/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/eslint.config.mjs delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/jsr.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/package-lock.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/package.json delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/core.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatComplete.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatStream.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimComplete.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimStream.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/custom_user_agent.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/hooks.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/registration.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/types.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/base64.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/config.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/dlv.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/encodings.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/event-streams.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/files.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/http.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/is-plain-object.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/logger.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/matchers.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/primitives.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/retries.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/schemas.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/sdks.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/security.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/url.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/assistantmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionevent.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionresponsestreamchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/contentchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/deltamessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/function.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functioncall.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functionname.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurl.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurlchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/jsonschema.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/prediction.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/referencechunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformat.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformats.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/security.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/systemmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/textchunk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tool.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolcall.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoice.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoiceenum.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolmessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tooltypes.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usermessage.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/validationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpclienterrors.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/chat.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/fim.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/sdk.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/async.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/blobs.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/constdatetime.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/enums.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/fp.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/index.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/operations.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/rfcdate.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/streams.ts delete mode 100644 examples/sdks/mistral-typescript/packages/mistralai-gcp/tsconfig.json delete mode 100755 examples/sdks/mistral-typescript/scripts/run_examples.sh delete mode 100644 examples/sdks/mistral-typescript/src/core.ts delete mode 100644 examples/sdks/mistral-typescript/src/extra/README.md delete mode 100644 examples/sdks/mistral-typescript/src/extra/structChat.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/agentsComplete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/agentsStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsComplete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/batchJobsCancel.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/batchJobsCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/batchJobsGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/batchJobsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaAgentsCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaAgentsGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaAgentsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdateVersion.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsAppend.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsAppendStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsGetHistory.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsGetMessages.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsRestart.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsRestartStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsStart.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaConversationsStartStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesDelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesUpdateOrCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsDelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGetSignedUrl.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsReprocess.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsStatus.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsTextContent.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpload.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/betaLibrariesUpdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/chatComplete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/chatStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/classifiersClassify.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/classifiersClassifyChat.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/classifiersModerate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/classifiersModerateChat.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/embeddingsCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesDelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesDownload.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesGetSignedUrl.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesRetrieve.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/filesUpload.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fimComplete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fimStream.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCancel.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCreate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fineTuningJobsGet.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fineTuningJobsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/fineTuningJobsStart.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsArchive.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsDelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsList.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsRetrieve.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsUnarchive.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/modelsUpdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/funcs/ocrProcess.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/custom_user_agent.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/deprecation_warning.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/hooks.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/registration.ts delete mode 100644 examples/sdks/mistral-typescript/src/hooks/types.ts delete mode 100644 examples/sdks/mistral-typescript/src/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/base64.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/config.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/dlv.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/encodings.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/env.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/event-streams.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/files.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/http.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/is-plain-object.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/logger.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/matchers.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/primitives.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/retries.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/schemas.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/sdks.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/security.ts delete mode 100644 examples/sdks/mistral-typescript/src/lib/url.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agentconversation.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agentcreationrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agenthandoffdoneevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agenthandoffentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agenthandoffstartedevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agentscompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agentscompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/agentupdaterequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/apiendpoint.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/archiveftmodelout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/assistantmessage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/audiochunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequeststream.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/basemodelcard.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/batcherror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/batchjobin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/batchjobout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/batchjobsout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/batchjobstatus.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/builtinconnectors.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatclassificationrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatcompletionchoice.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatcompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatcompletionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatcompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/chatmoderationrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/checkpointout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classificationrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classificationresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classificationtargetresult.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifierdetailedjobout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifierftmodelout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifierjobout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifiertargetin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifiertargetout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifiertrainingparameters.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/classifiertrainingparametersin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/codeinterpretertool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionargs.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionargsstop.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completiondetailedjobout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionftmodelout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionjobout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completionresponsestreamchoice.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completiontrainingparameters.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/completiontrainingparametersin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/contentchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationappendrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationappendstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationevents.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationhistory.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationinputs.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationmessages.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationrestartrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationrestartstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/conversationusageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/deletefileout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/deletemodelout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/deltamessage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/documentlibrarytool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/documentout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/documenttextcontent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/documentupdatein.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/documenturlchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/embeddingdtype.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/embeddingrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/embeddingresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/embeddingresponsedata.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/encodingformat.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/entitytype.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/eventout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/file.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/filechunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/filepurpose.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/fileschema.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/filesignedurl.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/fimcompletionrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/fimcompletionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/fimcompletionstreamrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/finetuneablemodeltype.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ftclassifierlossfunction.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ftmodelcapabilitiesout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ftmodelcard.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/function.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functioncall.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functioncallentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functioncallentryarguments.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functioncallevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functionname.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functionresultentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/functiontool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/githubrepositoryin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/githubrepositoryout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/imagegenerationtool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/imageurl.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/imageurlchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/inputentries.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/inputs.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/instructrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/jobin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/jobmetadataout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/jobsout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/jsonschema.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/legacyjobmetadataout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/libraryin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/libraryinupdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/libraryout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/listdocumentout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/listfilesout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/listlibraryout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/listsharingout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageentries.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageinputcontentchunks.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageinputentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageoutputcontentchunks.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageoutputentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/messageoutputevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/metricout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/mistralpromptmode.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/modelcapabilities.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/modelconversation.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/modellist.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/moderationobject.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/moderationresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrimageobject.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrpagedimensions.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrpageobject.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrrequest.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ocrusageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/outputcontentchunks.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/paginationinfo.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/prediction.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/processingstatusout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/referencechunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/responsedoneevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/responseerrorevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/responseformat.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/responseformats.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/responsestartedevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/retrievefileout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/sampletype.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/security.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/shareenum.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/sharingdelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/sharingin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/sharingout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/source.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/ssetypes.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/systemmessage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/systemmessagecontentchunks.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/textchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/thinkchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/timestampgranularity.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/tool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolcall.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolchoice.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolchoiceenum.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolexecutiondeltaevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolexecutiondoneevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolexecutionentry.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolexecutionstartedevent.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolfilechunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolmessage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/toolreferencechunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/tooltypes.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/trainingfile.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionresponse.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionsegmentchunk.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreamdone.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreamevents.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreameventtypes.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreamlanguage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreamsegmentdelta.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/transcriptionstreamtextdelta.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/unarchiveftmodelout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/updateftmodelin.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/uploadfileout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/usageinfo.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/usermessage.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/validationerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/wandbintegration.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/wandbintegrationout.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/websearchpremiumtool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/components/websearchtool.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/httpclienterrors.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/httpvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/mistralerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/responsevalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/sdkerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/errors/sdkvalidationerror.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsget.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentslist.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdateversion.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappend.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappendstream.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsget.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationshistory.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationslist.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsmessages.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestart.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestartstream.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/deletemodelv1modelsmodeliddelete.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdeletefile.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdownloadfile.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapiroutesgetsignedurl.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapirouteslistfiles.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapiroutesretrievefile.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/filesapiroutesuploadfile.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchcancelbatchjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjobs.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningstartfinetuningjob.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdeletev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsdeletev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetsignedurlv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetstatusv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgettextcontentv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentslistv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsreprocessv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsupdatev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsuploadv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesgetv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariessharecreatev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariessharedeletev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariessharelistv1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/librariesupdatev1.ts delete mode 100644 examples/sdks/mistral-typescript/src/models/operations/retrievemodelv1modelsmodelidget.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/accesses.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/agents.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/audio.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/batch.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/beta.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/chat.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/classifiers.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/conversations.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/documents.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/embeddings.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/files.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/fim.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/finetuning.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/jobs.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/libraries.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/mistralagents.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/mistraljobs.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/models.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/ocr.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/oldclient.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/sdk.ts delete mode 100644 examples/sdks/mistral-typescript/src/sdk/transcriptions.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/async.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/blobs.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/constdatetime.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/enums.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/fp.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/index.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/operations.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/rfcdate.ts delete mode 100644 examples/sdks/mistral-typescript/src/types/streams.ts delete mode 100644 examples/sdks/mistral-typescript/tests/extra/structChat.test.ts delete mode 100644 examples/sdks/mistral-typescript/tests/jest.config.js delete mode 100644 examples/sdks/mistral-typescript/tests/package-lock.json delete mode 100644 examples/sdks/mistral-typescript/tests/package.json delete mode 100644 examples/sdks/mistral-typescript/tests/tsconfig.json delete mode 100644 examples/sdks/mistral-typescript/tsconfig.json delete mode 100644 examples/specs/glean.yaml delete mode 100644 examples/specs/mistral.yaml delete mode 100644 examples/specs/pokeapi.yml delete mode 100644 packages/react/LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..7be32fc6c --- /dev/null +++ b/LICENSE @@ -0,0 +1,94 @@ +Elastic License 2.0 + +URL: https://www.elastic.co/licensing/elastic-license + +## Acceptance + +By using the software, you agree to all of the terms and conditions below. + +## Copyright License + +The licensor grants you a non-exclusive, royalty-free, worldwide, +non-sublicensable, non-transferable license to use, copy, distribute, make +available, and prepare derivative works of the software, in each case subject to +the limitations and conditions below. + +## Limitations + +You may not provide the software to third parties as a hosted or managed +service, where the service provides users with access to any substantial set of +the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality +in the software, and you may not remove or obscure any functionality in the +software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other notices +of the licensor in the software. Any use of the licensor's trademarks is subject +to applicable law. + +## Patents + +The licensor grants you a license, under any patent claims the licensor can +license, or becomes able to license, to make, have made, use, sell, offer for +sale, import and have imported the software, in each case subject to the +limitations and conditions in this license. This license does not cover any +patent claims that you cause to be infringed by modifications or additions to +the software. If you or your company make any written claim that the software +infringes or contributes to infringement of any patent, your patent license for +the software granted under these terms ends immediately. If your company makes +such a claim, your patent license ends immediately for work on behalf of your +company. + +## Notices + +You must ensure that anyone who gets a copy of any part of the software from you +also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the +software prominent notices stating that you have modified the software. + +## No Other Rights + +These terms do not imply any licenses other than those expressly granted in +these terms. + +## Termination + +If you use the software in violation of these terms, such use is not licensed, +and your licenses will automatically terminate. If the licensor provides you +with a notice of your violation, and you cease all violation of this license no +later than 30 days after you receive that notice, your licenses will be +reinstated retroactively. However, if you violate these terms after such +reinstatement, any additional violation of these terms will cause your licenses +to terminate automatically and permanently. + +## No Liability + +*As far as the law allows, the software comes as is, without any warranty or +condition, and the licensor will not be liable to you for any damages arising +out of these terms or the use or nature of the software, under any kind of +legal claim.* + +## Definitions + +The **licensor** is the entity offering these terms, and the **software** is the +software the licensor makes available under these terms, including any portion +of it. + +**you** refers to the individual or entity agreeing to these terms. + +**your company** is any legal entity, sole proprietorship, or other kind of +organization that you work for, plus all organizations that have control over, +are under the control of, or are under common control with that +organization. **control** means ownership of substantially all the assets of an +entity, or the power to direct its management and policies by vote, contract, or +otherwise. Control can be direct or indirect. + +**your licenses** are all the licenses granted to you for the software under +these terms. + +**use** means anything you do with the software requiring one of your licenses. + +**trademark** means trademarks, service marks, and similar rights. + diff --git a/README.md b/README.md index 92780682a..95228d76c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,426 @@ -# docs -API docs implementation +# DocsMD + +> **⚠️ PROJECT SUNSET NOTICE** +> +> This project has been sunset and will not receive any additional development, maintenance, or support. It is provided as-is under the Elastic License 2.0 and may be extended or inherited according to the license constraints. Users are encouraged to fork and continue development if needed. + +## What is DocsMD? + +DocsMD is a powerful documentation compiler that transforms OpenAPI specifications into interactive API documentation for popular documentation frameworks. It bridges the gap between your API specification and production-ready documentation sites with minimal configuration. + +**Key Features:** + +- **Framework Support**: Generate documentation for Docusaurus, Nextra, or create custom renderers for any framework +- **Interactive Code Samples**: Automatically generate code examples in multiple languages (TypeScript, Python, cURL) +- **Try It Now**: Enable browser-based API testing with live code execution for TypeScript and Python SDKs +- **Rich Component Library**: Pre-built React components for displaying API operations, schemas, parameters, and responses +- **Type-Safe**: Full TypeScript support with generated type definitions +- **Customizable**: Override default components and styling to match your brand +- **MDX & Markdown**: Flexible rendering to MDX for React-based frameworks or pure Markdown for LLMs + +## Why DocsMD? + +Traditional API documentation tools often require significant manual effort to maintain or produce generic, static output. DocsMD solves this by: + +1. **Automation**: Generate comprehensive documentation directly from your OpenAPI spec +2. **Consistency**: Ensure your documentation always matches your API specification +3. **Developer Experience**: Provide interactive code samples and live API testing +4. **Flexibility**: Works with modern documentation frameworks or custom solutions +5. **Extensibility**: Override and customize every aspect of the generated documentation + +## Monorepo Structure + +DocsMD is organized as a monorepo with four main packages: + +### 📦 `@speakeasy-api/docs-md` (Compiler) + +The core compiler package that orchestrates the documentation generation process. + +**Purpose**: Parses OpenAPI specifications and generates framework-specific documentation files. + +**Key Exports**: +- CLI tool (`docs-md`) for generating documentation +- `generatePages()` - Programmatic API for generation +- `FrameworkConfig` - Type definitions for custom renderers +- `Settings` - Configuration schema + +**Location**: `packages/compiler/` + +### ⚛️ `@speakeasy-api/docs-md-react` (React Components) + +React component library used in the generated MDX documentation. + +**Purpose**: Provides rich, interactive UI components for displaying API documentation. + +**Key Components**: +- `Operation` - Displays API operations with method, path, and details +- `CodeSample` - Syntax-highlighted code examples +- `TryItNow` - Interactive API testing interface +- `ExpandableSection` - Collapsible sections for schemas and parameters +- `ResponseTabbedSection` - Multi-response display with tabs +- `Pill` - Badges for methods, types, and status codes + +**Location**: `packages/react/` + +### 🔧 `@speakeasy-api/docs-md-shared` (Shared) + +Shared utilities, types, and runtime code used across packages. + +**Purpose**: Common code and type definitions to avoid duplication. + +**Key Exports**: +- TypeScript and Python runtime for Try It Now feature +- cURL parser and runtime +- Type definitions for chunks, logging, and configuration +- ESLint and Prettier configurations + +**Location**: `packages/shared/` + +### 🌐 `@speakeasy-api/docs-md-components` (Web Components) + +Web Components implementation (Lit-based) for framework-agnostic usage. + +**Purpose**: Provide framework-independent components using Web Components standard. + +**Key Exports**: +- `` - Web component version of Pill +- CSS files for Docusaurus and Nextra themes + +**Location**: `packages/web-components/` + +## Compiler Architecture + +### Renderer Types + +DocsMD supports multiple renderer types to accommodate different output formats: + +#### 1. **MDX Renderer** (`rendererType: "mdx"`) + +Generates MDX (Markdown + JSX) files for React-based documentation frameworks. + +**Use Cases**: +- Docusaurus sites +- Nextra (Next.js) documentation +- Custom React-based documentation platforms + +**Features**: +- Embeds React components directly in markdown +- Supports interactive features like Try It Now +- Type-safe component props +- CSS styling integration + +**Configuration**: +```typescript +{ + rendererType: "mdx", + componentPackageName: "@speakeasy-api/docs-md-react", + stringAttributeEscapeStyle: "html" | "react-value" +} +``` + +#### 2. **Markdown Renderer** (`rendererType: "markdown"`) + +Generates pure Markdown output without embedded components. + +**Use Cases**: +- LLM training data +- Documentation that needs to be portable +- Static site generators without React support +- Plain text documentation needs + +**Features**: +- Clean, readable Markdown +- No framework dependencies +- Maximum portability +- SEO-friendly content + +### Core Rendering Process + +The compiler follows this high-level flow: + +1. **Parse OpenAPI Spec**: Load and validate the OpenAPI specification +2. **Generate Data Structures**: Convert OpenAPI into internal "chunks" (operations, schemas, tags, etc.) +3. **Prepare Code Samples**: Generate code examples for configured languages +4. **Render Pages**: Use the appropriate renderer (MDX or Markdown) to create documentation files +5. **Post-Process**: Apply framework-specific transformations and optimizations +6. **Write Output**: Save generated files to the configured output directory + +### Page Generation + +Pages are generated for: + +- **Tags**: Groups of related operations +- **Operations**: Individual API endpoints +- **Schemas**: Data models and object definitions +- **Global Security**: Authentication/authorization documentation +- **About**: API overview and information + +### Extensibility + +Create custom renderers by implementing the `FrameworkConfig` interface: + +```typescript +import type { FrameworkConfig } from '@speakeasy-api/docs-md'; + +const customConfig: FrameworkConfig = { + rendererType: "mdx", + componentPackageName: "my-custom-components", + stringAttributeEscapeStyle: "react-value", + buildPagePath: (slug, options) => { + // Custom path generation logic + }, + buildPagePreamble: (frontMatter) => { + // Custom front matter generation + }, + postProcess: (pageMetadata) => { + // Custom post-processing + } +}; +``` + +## Usage Guide + +### Installation + +Install the DocsMD CLI as a dev dependency in your documentation project: + +```bash +# Using npm +npm install --save-dev @speakeasy-api/docs-md + +# Using yarn +yarn add -D @speakeasy-api/docs-md + +# Using pnpm +pnpm add -D @speakeasy-api/docs-md +``` + +### Basic Configuration + +Create a `speakeasy.config.mjs` (or `.js`, `.ts`, etc.) file in your project root: + +```javascript +export default { + // Path to your OpenAPI specification + spec: "./openapi.yaml", + + output: { + // Where to generate documentation files + pageOutDir: "./docs/api", + + // Framework: "docusaurus", "nextra", or custom config + framework: "docusaurus", + }, +}; +``` + +### Running the Compiler + +```bash +# Using the CLI directly +npx docs-md + +# With options +npx docs-md --clean --verbose + +# Using package.json scripts (recommended) +npm run build-api-docs +``` + +Add to your `package.json`: + +```json +{ + "scripts": { + "build-api-docs": "docs-md --clean" + } +} +``` + +### CLI Options + +``` +Usage: docs-md [options] + +Options: + --help, -h Show this help message + --config, -c Path to config file + --spec, -s Path to OpenAPI spec file + --clean, -C Clean the output directories before generating + --verbose, -v Show debug output +``` + +### Advanced Configuration + +#### Code Samples with Multiple Languages + +```javascript +export default { + spec: "./openapi.yaml", + output: { + pageOutDir: "./docs/api", + framework: "docusaurus", + }, + codeSamples: [ + { + language: "curl", + tryItNow: true, // Enable Try It Now for cURL + }, + { + language: "typescript", + sdkTarballPath: "./sdks/typescript-sdk.tar.gz", + tryItNow: { + outDir: "./public/try-it-now/ts", + urlPrefix: "/try-it-now/ts", + }, + }, + { + language: "python", + sdkFolder: "../python-sdk", + tryItNow: { + outDir: "./public/try-it-now/python", + urlPrefix: "/try-it-now/python", + }, + }, + ], +}; +``` + +#### Custom Display Options + +```javascript +export default { + spec: "./openapi.yaml", + output: { + pageOutDir: "./docs/api", + framework: "nextra", + embedOutDir: "./docs/embeds", // For nested schemas + }, + display: { + maxNestingLevel: 3, // Maximum depth for inline schemas + }, +}; +``` + +#### Using Spec Data Instead of File + +```javascript +import { readFileSync } from 'fs'; + +export default { + specData: readFileSync('./openapi.yaml', 'utf-8'), + output: { + pageOutDir: "./docs/api", + framework: "docusaurus", + }, +}; +``` + +### Overriding React Components + +DocsMD components can be customized, but the approach differs from typical React applications because the generated MDX files import components directly by name. + +#### Understanding Component Imports + +Generated MDX files include imports like this: + +```typescript +import { + Operation, + CodeSample, + TryItNow, + ExpandableSection +} from "@speakeasy-api/docs-md-react"; +``` + +Because components are imported directly by name in each generated file, standard MDX provider overrides **will not work**. + +Create your own component package that re-exports modified versions: + +**Step 1**: Create `my-custom-docs-components` package: + +```typescript +// my-custom-docs-components/src/index.ts + +// Re-export all default components +export * from '@speakeasy-api/docs-md-react'; + +// Override specific components +export { CustomCodeSample as CodeSample } from './CustomCodeSample'; +export { CustomOperation as Operation } from './CustomOperation'; +``` + +**Step 2**: Use custom package in config: + +```javascript +// speakeasy.config.mjs +export default { + spec: "./openapi.yaml", + output: { + pageOutDir: "./docs/api", + framework: { + rendererType: "mdx", + componentPackageName: "my-custom-docs-components", // Your package + stringAttributeEscapeStyle: "react-value", + buildPagePath: (slug) => `${slug}.mdx`, + buildPagePreamble: (frontMatter) => `---\n${JSON.stringify(frontMatter)}\n---`, + }, + }, +}; +``` + +#### Styling Customization + +DocsMD uses CSS custom properties (variables) for theming: + +```css +/* custom.css */ +:root { + /* Override Speakeasy CSS variables */ + --speakeasy-border-color: #e0e0e0; + --speakeasy-code-background-color: #1e1e1e; + --speakeasy-anchor-color: #0066cc; + --speakeasy-pill-primary-background-color: #0066cc; + + /* Add your custom variables */ + --my-custom-spacing: 1.5rem; +} +``` + +For a complete list of available CSS variables, see: +- `packages/web-components/src/docusaurus.css` +- `packages/web-components/src/nextra.css` + +#### Component Architecture + +DocsMD components follow a "slots" pattern for flexibility: + +```tsx + + + ### Responses + + + + 200 OK + + + + Success response content + + +``` + +This allows content to be authored in Markdown while maintaining structure. + +## License + +This project is licensed under the **Elastic License 2.0**. See the [LICENSE](./LICENSE) file for full terms. + +## Contributing + +As this project is sunset, we are not actively accepting contributions. However, you are welcome to fork the repository and continue development independently according to the license terms. + +## Support + +This project is provided as-is without warranty or support. For historical documentation or questions, please refer to the codebase and existing documentation. diff --git a/examples/custom/README.md b/examples/custom/README.md deleted file mode 100644 index e215bc4cc..000000000 --- a/examples/custom/README.md +++ /dev/null @@ -1,36 +0,0 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. diff --git a/examples/custom/next-env.d.ts b/examples/custom/next-env.d.ts deleted file mode 100644 index 830fb594c..000000000 --- a/examples/custom/next-env.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -/// -/// -/// - -// NOTE: This file should not be edited -// see https://nextjs.org/docs/app/api-reference/config/typescript for more information. diff --git a/examples/custom/next.config.ts b/examples/custom/next.config.ts deleted file mode 100644 index 60c8b23ab..000000000 --- a/examples/custom/next.config.ts +++ /dev/null @@ -1,29 +0,0 @@ -import createMDX from "@next/mdx"; -import createLit from "@lit-labs/nextjs"; -import remarkGfm from "remark-gfm"; -import remarkHeadingId from "remark-heading-id"; - -const withMDX = createMDX({ - options: { - remarkPlugins: [remarkGfm, remarkHeadingId], - rehypePlugins: [], - }, -}); - -const withLit = createLit({ - webpackModuleRulesTest: /.*\.(js|jsx|ts|tsx|mdx)$/, -}); - -// Merge MDX config with Next.js config -export default withLit( - withMDX({ - // Configure `pageExtensions` to include markdown and MDX files - pageExtensions: ["js", "jsx", "md", "mdx", "ts", "tsx"], - // Transpile @speakeasy-api packages so they work during SSR - transpilePackages: [ - "@speakeasy-api/docs-md-components", - "@speakeasy-api/docs-md-react", - ], - output: "export", - }) -); diff --git a/examples/custom/package.json b/examples/custom/package.json deleted file mode 100644 index 988af7cea..000000000 --- a/examples/custom/package.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "name": "merged-custom-nextjs", - "version": "0.1.0", - "private": true, - "scripts": { - "dev": "next dev -p 3003", - "build-api-docs": "docs-md -c speakeasy.mistral.config.mjs && docs-md -c speakeasy.pokeapi.config.mjs", - "prebuild": "cd ../../ && make build-packages", - "clean": "rm -rf .next node_modules/.cache out", - "build": "next build", - "lint": "next lint", - "start": "http-server ./out -p 3003" - }, - "dependencies": { - "@lit-labs/nextjs": "^0.2.4", - "@mdx-js/loader": "^3.1.0", - "@mdx-js/react": "^3.1.0", - "@next/mdx": "^15.4.5", - "@speakeasy-api/docs-md": "*", - "@speakeasy-api/docs-md-react": "*", - "@types/mdx": "^2.0.13", - "http-server": "^14.1.1", - "next": "^15.5.3", - "nextra": "^4.3.0", - "nextra-theme-docs": "^4.3.0", - "react": "^19.1.0", - "react-dom": "^19.1.0", - "rehype-slug": "^6.0.0", - "remark-gfm": "^4.0.1", - "remark-heading-id": "^1.0.1" - }, - "devDependencies": { - "@types/node": "^20", - "@types/react": "^19", - "@types/react-dom": "^19", - "@types/remark-heading-id": "^1.0.0", - "typescript": "^5" - } -} \ No newline at end of file diff --git a/examples/custom/public/mistral-try-it-now/deps.js b/examples/custom/public/mistral-try-it-now/deps.js deleted file mode 100644 index 151a02dbc..000000000 --- a/examples/custom/public/mistral-try-it-now/deps.js +++ /dev/null @@ -1,41456 +0,0 @@ -(() => { - var __create = Object.create; - var __defProp = Object.defineProperty; - var __getOwnPropDesc = Object.getOwnPropertyDescriptor; - var __getOwnPropNames = Object.getOwnPropertyNames; - var __getProtoOf = Object.getPrototypeOf; - var __hasOwnProp = Object.prototype.hasOwnProperty; - var __commonJS = (cb, mod) => function __require() { - return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports; - }; - var __copyProps = (to, from, except, desc) => { - if (from && typeof from === "object" || typeof from === "function") { - for (let key of __getOwnPropNames(from)) - if (!__hasOwnProp.call(to, key) && key !== except) - __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); - } - return to; - }; - var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps( - // If the importer is in node compatibility mode or this is not an ESM - // file that has been converted to a CommonJS file using a Babel- - // compatible transform (i.e. "__esModule" has not been set), then set - // "default" to the CommonJS "module.exports" for node compatibility. - isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, - mod - )); - - // node_modules/@mistralai/mistralai/lib/url.js - var require_url = __commonJS({ - "node_modules/@mistralai/mistralai/lib/url.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.pathToFunc = pathToFunc; - var hasOwn = Object.prototype.hasOwnProperty; - function pathToFunc(pathPattern, options) { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - return function buildURLPath(params = {}) { - return pathPattern.replace(paramRE, function(_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error(`Parameter '${placeholder}' must be a string or number`); - } - return options?.charEncoding === "percent" ? encodeURIComponent(`${value}`) : `${value}`; - }); - }; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/config.js - var require_config = __commonJS({ - "node_modules/@mistralai/mistralai/lib/config.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDK_METADATA = exports.ServerList = exports.ServerEu = void 0; - exports.serverURLFromOptions = serverURLFromOptions; - var url_js_1 = require_url(); - exports.ServerEu = "eu"; - exports.ServerList = { - [exports.ServerEu]: "https://api.mistral.ai" - }; - function serverURLFromOptions(options) { - let serverURL = options.serverURL; - const params = {}; - if (!serverURL) { - const server = options.server ?? exports.ServerEu; - serverURL = exports.ServerList[server] || ""; - } - const u = (0, url_js_1.pathToFunc)(serverURL)(params); - return new URL(u); - } - exports.SDK_METADATA = { - language: "typescript", - openapiDocVersion: "1.0.0", - sdkVersion: "1.10.0", - genVersion: "2.687.13", - userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai" - }; - } - }); - - // node_modules/@mistralai/mistralai/lib/files.js - var require_files = __commonJS({ - "node_modules/@mistralai/mistralai/lib/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.readableStreamToArrayBuffer = readableStreamToArrayBuffer; - exports.getContentTypeFromFileName = getContentTypeFromFileName; - async function readableStreamToArrayBuffer(readable) { - const reader = readable.getReader(); - const chunks = []; - let totalLength = 0; - let done = false; - while (!done) { - const { value, done: doneReading } = await reader.read(); - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - return concatenatedChunks.buffer; - } - function getContentTypeFromFileName(fileName) { - if (!fileName) - return null; - const ext = fileName.toLowerCase().split(".").pop(); - if (!ext) - return null; - const mimeTypes = { - json: "application/json", - xml: "application/xml", - html: "text/html", - htm: "text/html", - txt: "text/plain", - csv: "text/csv", - pdf: "application/pdf", - png: "image/png", - jpg: "image/jpeg", - jpeg: "image/jpeg", - gif: "image/gif", - svg: "image/svg+xml", - js: "application/javascript", - css: "text/css", - zip: "application/zip", - tar: "application/x-tar", - gz: "application/gzip", - mp4: "video/mp4", - mp3: "audio/mpeg", - wav: "audio/wav", - webp: "image/webp", - ico: "image/x-icon", - woff: "font/woff", - woff2: "font/woff2", - ttf: "font/ttf", - otf: "font/otf" - }; - return mimeTypes[ext] || null; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/http.js - var require_http = __commonJS({ - "node_modules/@mistralai/mistralai/lib/http.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = void 0; - exports.matchContentType = matchContentType; - exports.matchStatusCode = matchStatusCode; - exports.matchResponse = matchResponse; - exports.isConnectionError = isConnectionError; - exports.isTimeoutError = isTimeoutError; - exports.isAbortError = isAbortError; - var DEFAULT_FETCHER = (input, init) => { - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } - }; - var HTTPClient = class _HTTPClient { - constructor(options = {}) { - this.options = options; - this.requestHooks = []; - this.requestErrorHooks = []; - this.responseHooks = []; - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - async request(request) { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - try { - const res = await this.fetcher(req); - for (const hook of this.responseHooks) { - await hook(res, req); - } - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - throw err; - } - } - addHook(...args) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - removeHook(...args) { - let target; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - return this; - } - clone() { - const child = new _HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - return child; - } - }; - exports.HTTPClient = HTTPClient; - var mediaParamSeparator = /\s*;\s*/g; - function matchContentType(response, pattern) { - if (pattern === "*") { - return true; - } - let contentType = response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - if (wantType.split("/").length !== 2) { - return false; - } - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - if (wantType !== "*/*" && gotType !== wantType && `${type}/*` !== wantType && `*/${subtype}` !== wantType) { - return false; - } - if (gotParams.length < wantParams.length) { - return false; - } - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - return true; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function matchStatusCode(response, codes) { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - return expectedCodes.some((ec) => { - const code = `${ec}`; - if (code === "default") { - return true; - } - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - function matchResponse(response, code, contentTypePattern) { - return matchStatusCode(response, code) && matchContentType(response, contentTypePattern); - } - function isConnectionError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isBrowserErr = err instanceof TypeError && err.message.toLowerCase().startsWith("failed to fetch"); - const isNodeErr = err instanceof TypeError && err.message.toLowerCase().startsWith("fetch failed"); - const isBunErr = "name" in err && err.name === "ConnectionError"; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnreset"; - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; - } - function isTimeoutError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - function isAbortError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/custom_user_agent.js - var require_custom_user_agent = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/custom_user_agent.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CustomUserAgentHook = void 0; - var config_1 = require_config(); - var CustomUserAgentHook = class { - beforeRequest(_, request) { - const version = config_1.SDK_METADATA.sdkVersion; - const ua = `mistral-client-typescript/${version}`; - request.headers.set("user-agent", ua); - if (!request.headers.get("user-agent")) { - request.headers.set("x-mistral-user-agent", ua); - } - return request; - } - }; - exports.CustomUserAgentHook = CustomUserAgentHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/deprecation_warning.js - var require_deprecation_warning = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/deprecation_warning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeprecationWarningHook = void 0; - var HEADER_MODEL_DEPRECATION_TIMESTAMP = "x-model-deprecation-timestamp"; - var DeprecationWarningHook = class { - afterSuccess(_, response) { - if (response.headers.has(HEADER_MODEL_DEPRECATION_TIMESTAMP)) { - response.clone().json().then((body) => { - const model = body.model; - console.warn(`WARNING: The model ${model} is deprecated and will be removed on ${response.headers.get(HEADER_MODEL_DEPRECATION_TIMESTAMP)}. Please refer to https://docs.mistral.ai/getting-started/models/#api-versioning for more information.`); - }); - } - return response; - } - }; - exports.DeprecationWarningHook = DeprecationWarningHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/registration.js - var require_registration = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/registration.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.initHooks = initHooks; - var custom_user_agent_1 = require_custom_user_agent(); - var deprecation_warning_1 = require_deprecation_warning(); - function initHooks(hooks) { - const customUserAgentHook = new custom_user_agent_1.CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook); - const deprecationWarningHook = new deprecation_warning_1.DeprecationWarningHook(); - hooks.registerAfterSuccessHook(deprecationWarningHook); - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/hooks.js - var require_hooks = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/hooks.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKHooks = void 0; - var registration_js_1 = require_registration(); - var SDKHooks = class { - constructor() { - this.sdkInitHooks = []; - this.beforeCreateRequestHooks = []; - this.beforeRequestHooks = []; - this.afterSuccessHooks = []; - this.afterErrorHooks = []; - const presetHooks = []; - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - (0, registration_js_1.initHooks)(this); - } - registerSDKInitHook(hook) { - this.sdkInitHooks.push(hook); - } - registerBeforeCreateRequestHook(hook) { - this.beforeCreateRequestHooks.push(hook); - } - registerBeforeRequestHook(hook) { - this.beforeRequestHooks.push(hook); - } - registerAfterSuccessHook(hook) { - this.afterSuccessHooks.push(hook); - } - registerAfterErrorHook(hook) { - this.afterErrorHooks.push(hook); - } - sdkInit(opts) { - return this.sdkInitHooks.reduce((opts2, hook) => hook.sdkInit(opts2), opts); - } - beforeCreateRequest(hookCtx, input) { - let inp = input; - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - return inp; - } - async beforeRequest(hookCtx, request) { - let req = request; - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - return req; - } - async afterSuccess(hookCtx, response) { - let res = response; - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - return res; - } - async afterError(hookCtx, response, error) { - let res = response; - let err = error; - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - return { response: res, error: err }; - } - }; - exports.SDKHooks = SDKHooks; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js - var require_httpclienterrors = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConnectionError = exports.RequestTimeoutError = exports.RequestAbortedError = exports.InvalidRequestError = exports.UnexpectedClientError = exports.HTTPClientError = void 0; - var HTTPClientError = class extends Error { - constructor(message, opts) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - super(msg, opts); - this.name = "HTTPClientError"; - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } - }; - exports.HTTPClientError = HTTPClientError; - var UnexpectedClientError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "UnexpectedClientError"; - } - }; - exports.UnexpectedClientError = UnexpectedClientError; - var InvalidRequestError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "InvalidRequestError"; - } - }; - exports.InvalidRequestError = InvalidRequestError; - var RequestAbortedError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestAbortedError"; - } - }; - exports.RequestAbortedError = RequestAbortedError; - var RequestTimeoutError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestTimeoutError"; - } - }; - exports.RequestTimeoutError = RequestTimeoutError; - var ConnectionError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "ConnectionError"; - } - }; - exports.ConnectionError = ConnectionError; - } - }); - - // node_modules/@mistralai/mistralai/types/fp.js - var require_fp = __commonJS({ - "node_modules/@mistralai/mistralai/types/fp.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OK = OK; - exports.ERR = ERR; - exports.unwrap = unwrap; - exports.unwrapAsync = unwrapAsync; - function OK(value) { - return { ok: true, value }; - } - function ERR(error) { - return { ok: false, error }; - } - function unwrap(r) { - if (!r.ok) { - throw r.error; - } - return r.value; - } - async function unwrapAsync(pr) { - const r = await pr; - if (!r.ok) { - throw r.error; - } - return r.value; - } - } - }); - - // node_modules/zod/v3/helpers/util.cjs - var require_util = __commonJS({ - "node_modules/zod/v3/helpers/util.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getParsedType = exports.ZodParsedType = exports.objectUtil = exports.util = void 0; - var util; - (function(util2) { - util2.assertEqual = (_) => { - }; - function assertIs(_arg) { - } - util2.assertIs = assertIs; - function assertNever(_x) { - throw new Error(); - } - util2.assertNever = assertNever; - util2.arrayToEnum = (items) => { - const obj = {}; - for (const item of items) { - obj[item] = item; - } - return obj; - }; - util2.getValidEnumValues = (obj) => { - const validKeys = util2.objectKeys(obj).filter((k) => typeof obj[obj[k]] !== "number"); - const filtered = {}; - for (const k of validKeys) { - filtered[k] = obj[k]; - } - return util2.objectValues(filtered); - }; - util2.objectValues = (obj) => { - return util2.objectKeys(obj).map(function(e) { - return obj[e]; - }); - }; - util2.objectKeys = typeof Object.keys === "function" ? (obj) => Object.keys(obj) : (object) => { - const keys = []; - for (const key in object) { - if (Object.prototype.hasOwnProperty.call(object, key)) { - keys.push(key); - } - } - return keys; - }; - util2.find = (arr, checker) => { - for (const item of arr) { - if (checker(item)) - return item; - } - return void 0; - }; - util2.isInteger = typeof Number.isInteger === "function" ? (val) => Number.isInteger(val) : (val) => typeof val === "number" && Number.isFinite(val) && Math.floor(val) === val; - function joinValues(array, separator = " | ") { - return array.map((val) => typeof val === "string" ? `'${val}'` : val).join(separator); - } - util2.joinValues = joinValues; - util2.jsonStringifyReplacer = (_, value) => { - if (typeof value === "bigint") { - return value.toString(); - } - return value; - }; - })(util || (exports.util = util = {})); - var objectUtil; - (function(objectUtil2) { - objectUtil2.mergeShapes = (first, second) => { - return { - ...first, - ...second - // second overwrites first - }; - }; - })(objectUtil || (exports.objectUtil = objectUtil = {})); - exports.ZodParsedType = util.arrayToEnum([ - "string", - "nan", - "number", - "integer", - "float", - "boolean", - "date", - "bigint", - "symbol", - "function", - "undefined", - "null", - "array", - "object", - "unknown", - "promise", - "void", - "never", - "map", - "set" - ]); - var getParsedType = (data) => { - const t = typeof data; - switch (t) { - case "undefined": - return exports.ZodParsedType.undefined; - case "string": - return exports.ZodParsedType.string; - case "number": - return Number.isNaN(data) ? exports.ZodParsedType.nan : exports.ZodParsedType.number; - case "boolean": - return exports.ZodParsedType.boolean; - case "function": - return exports.ZodParsedType.function; - case "bigint": - return exports.ZodParsedType.bigint; - case "symbol": - return exports.ZodParsedType.symbol; - case "object": - if (Array.isArray(data)) { - return exports.ZodParsedType.array; - } - if (data === null) { - return exports.ZodParsedType.null; - } - if (data.then && typeof data.then === "function" && data.catch && typeof data.catch === "function") { - return exports.ZodParsedType.promise; - } - if (typeof Map !== "undefined" && data instanceof Map) { - return exports.ZodParsedType.map; - } - if (typeof Set !== "undefined" && data instanceof Set) { - return exports.ZodParsedType.set; - } - if (typeof Date !== "undefined" && data instanceof Date) { - return exports.ZodParsedType.date; - } - return exports.ZodParsedType.object; - default: - return exports.ZodParsedType.unknown; - } - }; - exports.getParsedType = getParsedType; - } - }); - - // node_modules/zod/v3/ZodError.cjs - var require_ZodError = __commonJS({ - "node_modules/zod/v3/ZodError.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ZodError = exports.quotelessJson = exports.ZodIssueCode = void 0; - var util_js_1 = require_util(); - exports.ZodIssueCode = util_js_1.util.arrayToEnum([ - "invalid_type", - "invalid_literal", - "custom", - "invalid_union", - "invalid_union_discriminator", - "invalid_enum_value", - "unrecognized_keys", - "invalid_arguments", - "invalid_return_type", - "invalid_date", - "invalid_string", - "too_small", - "too_big", - "invalid_intersection_types", - "not_multiple_of", - "not_finite" - ]); - var quotelessJson = (obj) => { - const json = JSON.stringify(obj, null, 2); - return json.replace(/"([^"]+)":/g, "$1:"); - }; - exports.quotelessJson = quotelessJson; - var ZodError = class _ZodError extends Error { - get errors() { - return this.issues; - } - constructor(issues) { - super(); - this.issues = []; - this.addIssue = (sub) => { - this.issues = [...this.issues, sub]; - }; - this.addIssues = (subs = []) => { - this.issues = [...this.issues, ...subs]; - }; - const actualProto = new.target.prototype; - if (Object.setPrototypeOf) { - Object.setPrototypeOf(this, actualProto); - } else { - this.__proto__ = actualProto; - } - this.name = "ZodError"; - this.issues = issues; - } - format(_mapper) { - const mapper = _mapper || function(issue) { - return issue.message; - }; - const fieldErrors = { _errors: [] }; - const processError = (error) => { - for (const issue of error.issues) { - if (issue.code === "invalid_union") { - issue.unionErrors.map(processError); - } else if (issue.code === "invalid_return_type") { - processError(issue.returnTypeError); - } else if (issue.code === "invalid_arguments") { - processError(issue.argumentsError); - } else if (issue.path.length === 0) { - fieldErrors._errors.push(mapper(issue)); - } else { - let curr = fieldErrors; - let i = 0; - while (i < issue.path.length) { - const el = issue.path[i]; - const terminal = i === issue.path.length - 1; - if (!terminal) { - curr[el] = curr[el] || { _errors: [] }; - } else { - curr[el] = curr[el] || { _errors: [] }; - curr[el]._errors.push(mapper(issue)); - } - curr = curr[el]; - i++; - } - } - } - }; - processError(this); - return fieldErrors; - } - static assert(value) { - if (!(value instanceof _ZodError)) { - throw new Error(`Not a ZodError: ${value}`); - } - } - toString() { - return this.message; - } - get message() { - return JSON.stringify(this.issues, util_js_1.util.jsonStringifyReplacer, 2); - } - get isEmpty() { - return this.issues.length === 0; - } - flatten(mapper = (issue) => issue.message) { - const fieldErrors = {}; - const formErrors = []; - for (const sub of this.issues) { - if (sub.path.length > 0) { - const firstEl = sub.path[0]; - fieldErrors[firstEl] = fieldErrors[firstEl] || []; - fieldErrors[firstEl].push(mapper(sub)); - } else { - formErrors.push(mapper(sub)); - } - } - return { formErrors, fieldErrors }; - } - get formErrors() { - return this.flatten(); - } - }; - exports.ZodError = ZodError; - ZodError.create = (issues) => { - const error = new ZodError(issues); - return error; - }; - } - }); - - // node_modules/zod/v3/locales/en.cjs - var require_en = __commonJS({ - "node_modules/zod/v3/locales/en.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - var ZodError_js_1 = require_ZodError(); - var util_js_1 = require_util(); - var errorMap = (issue, _ctx) => { - let message; - switch (issue.code) { - case ZodError_js_1.ZodIssueCode.invalid_type: - if (issue.received === util_js_1.ZodParsedType.undefined) { - message = "Required"; - } else { - message = `Expected ${issue.expected}, received ${issue.received}`; - } - break; - case ZodError_js_1.ZodIssueCode.invalid_literal: - message = `Invalid literal value, expected ${JSON.stringify(issue.expected, util_js_1.util.jsonStringifyReplacer)}`; - break; - case ZodError_js_1.ZodIssueCode.unrecognized_keys: - message = `Unrecognized key(s) in object: ${util_js_1.util.joinValues(issue.keys, ", ")}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union_discriminator: - message = `Invalid discriminator value. Expected ${util_js_1.util.joinValues(issue.options)}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_enum_value: - message = `Invalid enum value. Expected ${util_js_1.util.joinValues(issue.options)}, received '${issue.received}'`; - break; - case ZodError_js_1.ZodIssueCode.invalid_arguments: - message = `Invalid function arguments`; - break; - case ZodError_js_1.ZodIssueCode.invalid_return_type: - message = `Invalid function return type`; - break; - case ZodError_js_1.ZodIssueCode.invalid_date: - message = `Invalid date`; - break; - case ZodError_js_1.ZodIssueCode.invalid_string: - if (typeof issue.validation === "object") { - if ("includes" in issue.validation) { - message = `Invalid input: must include "${issue.validation.includes}"`; - if (typeof issue.validation.position === "number") { - message = `${message} at one or more positions greater than or equal to ${issue.validation.position}`; - } - } else if ("startsWith" in issue.validation) { - message = `Invalid input: must start with "${issue.validation.startsWith}"`; - } else if ("endsWith" in issue.validation) { - message = `Invalid input: must end with "${issue.validation.endsWith}"`; - } else { - util_js_1.util.assertNever(issue.validation); - } - } else if (issue.validation !== "regex") { - message = `Invalid ${issue.validation}`; - } else { - message = "Invalid"; - } - break; - case ZodError_js_1.ZodIssueCode.too_small: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `more than`} ${issue.minimum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `over`} ${issue.minimum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "bigint") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${new Date(Number(issue.minimum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.too_big: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `less than`} ${issue.maximum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `under`} ${issue.maximum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "bigint") - message = `BigInt must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly` : issue.inclusive ? `smaller than or equal to` : `smaller than`} ${new Date(Number(issue.maximum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.custom: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_intersection_types: - message = `Intersection results could not be merged`; - break; - case ZodError_js_1.ZodIssueCode.not_multiple_of: - message = `Number must be a multiple of ${issue.multipleOf}`; - break; - case ZodError_js_1.ZodIssueCode.not_finite: - message = "Number must be finite"; - break; - default: - message = _ctx.defaultError; - util_js_1.util.assertNever(issue); - } - return { message }; - }; - exports.default = errorMap; - } - }); - - // node_modules/zod/v3/errors.cjs - var require_errors = __commonJS({ - "node_modules/zod/v3/errors.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.defaultErrorMap = void 0; - exports.setErrorMap = setErrorMap; - exports.getErrorMap = getErrorMap; - var en_js_1 = __importDefault(require_en()); - exports.defaultErrorMap = en_js_1.default; - var overrideErrorMap = en_js_1.default; - function setErrorMap(map) { - overrideErrorMap = map; - } - function getErrorMap() { - return overrideErrorMap; - } - } - }); - - // node_modules/zod/v3/helpers/parseUtil.cjs - var require_parseUtil = __commonJS({ - "node_modules/zod/v3/helpers/parseUtil.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isAsync = exports.isValid = exports.isDirty = exports.isAborted = exports.OK = exports.DIRTY = exports.INVALID = exports.ParseStatus = exports.EMPTY_PATH = exports.makeIssue = void 0; - exports.addIssueToContext = addIssueToContext; - var errors_js_1 = require_errors(); - var en_js_1 = __importDefault(require_en()); - var makeIssue = (params) => { - const { data, path, errorMaps, issueData } = params; - const fullPath = [...path, ...issueData.path || []]; - const fullIssue = { - ...issueData, - path: fullPath - }; - if (issueData.message !== void 0) { - return { - ...issueData, - path: fullPath, - message: issueData.message - }; - } - let errorMessage = ""; - const maps = errorMaps.filter((m) => !!m).slice().reverse(); - for (const map of maps) { - errorMessage = map(fullIssue, { data, defaultError: errorMessage }).message; - } - return { - ...issueData, - path: fullPath, - message: errorMessage - }; - }; - exports.makeIssue = makeIssue; - exports.EMPTY_PATH = []; - function addIssueToContext(ctx, issueData) { - const overrideMap = (0, errors_js_1.getErrorMap)(); - const issue = (0, exports.makeIssue)({ - issueData, - data: ctx.data, - path: ctx.path, - errorMaps: [ - ctx.common.contextualErrorMap, - // contextual error map is first priority - ctx.schemaErrorMap, - // then schema-bound map if available - overrideMap, - // then global override map - overrideMap === en_js_1.default ? void 0 : en_js_1.default - // then global default map - ].filter((x) => !!x) - }); - ctx.common.issues.push(issue); - } - var ParseStatus = class _ParseStatus { - constructor() { - this.value = "valid"; - } - dirty() { - if (this.value === "valid") - this.value = "dirty"; - } - abort() { - if (this.value !== "aborted") - this.value = "aborted"; - } - static mergeArray(status, results) { - const arrayValue = []; - for (const s of results) { - if (s.status === "aborted") - return exports.INVALID; - if (s.status === "dirty") - status.dirty(); - arrayValue.push(s.value); - } - return { status: status.value, value: arrayValue }; - } - static async mergeObjectAsync(status, pairs) { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value - }); - } - return _ParseStatus.mergeObjectSync(status, syncPairs); - } - static mergeObjectSync(status, pairs) { - const finalObject = {}; - for (const pair of pairs) { - const { key, value } = pair; - if (key.status === "aborted") - return exports.INVALID; - if (value.status === "aborted") - return exports.INVALID; - if (key.status === "dirty") - status.dirty(); - if (value.status === "dirty") - status.dirty(); - if (key.value !== "__proto__" && (typeof value.value !== "undefined" || pair.alwaysSet)) { - finalObject[key.value] = value.value; - } - } - return { status: status.value, value: finalObject }; - } - }; - exports.ParseStatus = ParseStatus; - exports.INVALID = Object.freeze({ - status: "aborted" - }); - var DIRTY = (value) => ({ status: "dirty", value }); - exports.DIRTY = DIRTY; - var OK = (value) => ({ status: "valid", value }); - exports.OK = OK; - var isAborted = (x) => x.status === "aborted"; - exports.isAborted = isAborted; - var isDirty = (x) => x.status === "dirty"; - exports.isDirty = isDirty; - var isValid = (x) => x.status === "valid"; - exports.isValid = isValid; - var isAsync = (x) => typeof Promise !== "undefined" && x instanceof Promise; - exports.isAsync = isAsync; - } - }); - - // node_modules/zod/v3/helpers/typeAliases.cjs - var require_typeAliases = __commonJS({ - "node_modules/zod/v3/helpers/typeAliases.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod/v3/helpers/errorUtil.cjs - var require_errorUtil = __commonJS({ - "node_modules/zod/v3/helpers/errorUtil.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.errorUtil = void 0; - var errorUtil; - (function(errorUtil2) { - errorUtil2.errToObj = (message) => typeof message === "string" ? { message } : message || {}; - errorUtil2.toString = (message) => typeof message === "string" ? message : message?.message; - })(errorUtil || (exports.errorUtil = errorUtil = {})); - } - }); - - // node_modules/zod/v3/types.cjs - var require_types = __commonJS({ - "node_modules/zod/v3/types.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.discriminatedUnion = exports.date = exports.boolean = exports.bigint = exports.array = exports.any = exports.coerce = exports.ZodFirstPartyTypeKind = exports.late = exports.ZodSchema = exports.Schema = exports.ZodReadonly = exports.ZodPipeline = exports.ZodBranded = exports.BRAND = exports.ZodNaN = exports.ZodCatch = exports.ZodDefault = exports.ZodNullable = exports.ZodOptional = exports.ZodTransformer = exports.ZodEffects = exports.ZodPromise = exports.ZodNativeEnum = exports.ZodEnum = exports.ZodLiteral = exports.ZodLazy = exports.ZodFunction = exports.ZodSet = exports.ZodMap = exports.ZodRecord = exports.ZodTuple = exports.ZodIntersection = exports.ZodDiscriminatedUnion = exports.ZodUnion = exports.ZodObject = exports.ZodArray = exports.ZodVoid = exports.ZodNever = exports.ZodUnknown = exports.ZodAny = exports.ZodNull = exports.ZodUndefined = exports.ZodSymbol = exports.ZodDate = exports.ZodBoolean = exports.ZodBigInt = exports.ZodNumber = exports.ZodString = exports.ZodType = void 0; - exports.NEVER = exports.void = exports.unknown = exports.union = exports.undefined = exports.tuple = exports.transformer = exports.symbol = exports.string = exports.strictObject = exports.set = exports.record = exports.promise = exports.preprocess = exports.pipeline = exports.ostring = exports.optional = exports.onumber = exports.oboolean = exports.object = exports.number = exports.nullable = exports.null = exports.never = exports.nativeEnum = exports.nan = exports.map = exports.literal = exports.lazy = exports.intersection = exports.instanceof = exports.function = exports.enum = exports.effect = void 0; - exports.datetimeRegex = datetimeRegex; - exports.custom = custom; - var ZodError_js_1 = require_ZodError(); - var errors_js_1 = require_errors(); - var errorUtil_js_1 = require_errorUtil(); - var parseUtil_js_1 = require_parseUtil(); - var util_js_1 = require_util(); - var ParseInputLazyPath = class { - constructor(parent, value, path, key) { - this._cachedPath = []; - this.parent = parent; - this.data = value; - this._path = path; - this._key = key; - } - get path() { - if (!this._cachedPath.length) { - if (Array.isArray(this._key)) { - this._cachedPath.push(...this._path, ...this._key); - } else { - this._cachedPath.push(...this._path, this._key); - } - } - return this._cachedPath; - } - }; - var handleResult = (ctx, result) => { - if ((0, parseUtil_js_1.isValid)(result)) { - return { success: true, data: result.value }; - } else { - if (!ctx.common.issues.length) { - throw new Error("Validation failed but no issues detected."); - } - return { - success: false, - get error() { - if (this._error) - return this._error; - const error = new ZodError_js_1.ZodError(ctx.common.issues); - this._error = error; - return this._error; - } - }; - } - }; - function processCreateParams(params) { - if (!params) - return {}; - const { errorMap, invalid_type_error, required_error, description } = params; - if (errorMap && (invalid_type_error || required_error)) { - throw new Error(`Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`); - } - if (errorMap) - return { errorMap, description }; - const customMap = (iss, ctx) => { - const { message } = params; - if (iss.code === "invalid_enum_value") { - return { message: message ?? ctx.defaultError }; - } - if (typeof ctx.data === "undefined") { - return { message: message ?? required_error ?? ctx.defaultError }; - } - if (iss.code !== "invalid_type") - return { message: ctx.defaultError }; - return { message: message ?? invalid_type_error ?? ctx.defaultError }; - }; - return { errorMap: customMap, description }; - } - var ZodType = class { - get description() { - return this._def.description; - } - _getType(input) { - return (0, util_js_1.getParsedType)(input.data); - } - _getOrReturnCtx(input, ctx) { - return ctx || { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - }; - } - _processInputParams(input) { - return { - status: new parseUtil_js_1.ParseStatus(), - ctx: { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - } - }; - } - _parseSync(input) { - const result = this._parse(input); - if ((0, parseUtil_js_1.isAsync)(result)) { - throw new Error("Synchronous parse encountered promise."); - } - return result; - } - _parseAsync(input) { - const result = this._parse(input); - return Promise.resolve(result); - } - parse(data, params) { - const result = this.safeParse(data, params); - if (result.success) - return result.data; - throw result.error; - } - safeParse(data, params) { - const ctx = { - common: { - issues: [], - async: params?.async ?? false, - contextualErrorMap: params?.errorMap - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const result = this._parseSync({ data, path: ctx.path, parent: ctx }); - return handleResult(ctx, result); - } - "~validate"(data) { - const ctx = { - common: { - issues: [], - async: !!this["~standard"].async - }, - path: [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - if (!this["~standard"].async) { - try { - const result = this._parseSync({ data, path: [], parent: ctx }); - return (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }; - } catch (err) { - if (err?.message?.toLowerCase()?.includes("encountered")) { - this["~standard"].async = true; - } - ctx.common = { - issues: [], - async: true - }; - } - } - return this._parseAsync({ data, path: [], parent: ctx }).then((result) => (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }); - } - async parseAsync(data, params) { - const result = await this.safeParseAsync(data, params); - if (result.success) - return result.data; - throw result.error; - } - async safeParseAsync(data, params) { - const ctx = { - common: { - issues: [], - contextualErrorMap: params?.errorMap, - async: true - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const maybeAsyncResult = this._parse({ data, path: ctx.path, parent: ctx }); - const result = await ((0, parseUtil_js_1.isAsync)(maybeAsyncResult) ? maybeAsyncResult : Promise.resolve(maybeAsyncResult)); - return handleResult(ctx, result); - } - refine(check, message) { - const getIssueProperties = (val) => { - if (typeof message === "string" || typeof message === "undefined") { - return { message }; - } else if (typeof message === "function") { - return message(val); - } else { - return message; - } - }; - return this._refinement((val, ctx) => { - const result = check(val); - const setError = () => ctx.addIssue({ - code: ZodError_js_1.ZodIssueCode.custom, - ...getIssueProperties(val) - }); - if (typeof Promise !== "undefined" && result instanceof Promise) { - return result.then((data) => { - if (!data) { - setError(); - return false; - } else { - return true; - } - }); - } - if (!result) { - setError(); - return false; - } else { - return true; - } - }); - } - refinement(check, refinementData) { - return this._refinement((val, ctx) => { - if (!check(val)) { - ctx.addIssue(typeof refinementData === "function" ? refinementData(val, ctx) : refinementData); - return false; - } else { - return true; - } - }); - } - _refinement(refinement) { - return new ZodEffects({ - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "refinement", refinement } - }); - } - superRefine(refinement) { - return this._refinement(refinement); - } - constructor(def) { - this.spa = this.safeParseAsync; - this._def = def; - this.parse = this.parse.bind(this); - this.safeParse = this.safeParse.bind(this); - this.parseAsync = this.parseAsync.bind(this); - this.safeParseAsync = this.safeParseAsync.bind(this); - this.spa = this.spa.bind(this); - this.refine = this.refine.bind(this); - this.refinement = this.refinement.bind(this); - this.superRefine = this.superRefine.bind(this); - this.optional = this.optional.bind(this); - this.nullable = this.nullable.bind(this); - this.nullish = this.nullish.bind(this); - this.array = this.array.bind(this); - this.promise = this.promise.bind(this); - this.or = this.or.bind(this); - this.and = this.and.bind(this); - this.transform = this.transform.bind(this); - this.brand = this.brand.bind(this); - this.default = this.default.bind(this); - this.catch = this.catch.bind(this); - this.describe = this.describe.bind(this); - this.pipe = this.pipe.bind(this); - this.readonly = this.readonly.bind(this); - this.isNullable = this.isNullable.bind(this); - this.isOptional = this.isOptional.bind(this); - this["~standard"] = { - version: 1, - vendor: "zod", - validate: (data) => this["~validate"](data) - }; - } - optional() { - return ZodOptional.create(this, this._def); - } - nullable() { - return ZodNullable.create(this, this._def); - } - nullish() { - return this.nullable().optional(); - } - array() { - return ZodArray.create(this); - } - promise() { - return ZodPromise.create(this, this._def); - } - or(option) { - return ZodUnion.create([this, option], this._def); - } - and(incoming) { - return ZodIntersection.create(this, incoming, this._def); - } - transform(transform) { - return new ZodEffects({ - ...processCreateParams(this._def), - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "transform", transform } - }); - } - default(def) { - const defaultValueFunc = typeof def === "function" ? def : () => def; - return new ZodDefault({ - ...processCreateParams(this._def), - innerType: this, - defaultValue: defaultValueFunc, - typeName: ZodFirstPartyTypeKind.ZodDefault - }); - } - brand() { - return new ZodBranded({ - typeName: ZodFirstPartyTypeKind.ZodBranded, - type: this, - ...processCreateParams(this._def) - }); - } - catch(def) { - const catchValueFunc = typeof def === "function" ? def : () => def; - return new ZodCatch({ - ...processCreateParams(this._def), - innerType: this, - catchValue: catchValueFunc, - typeName: ZodFirstPartyTypeKind.ZodCatch - }); - } - describe(description) { - const This = this.constructor; - return new This({ - ...this._def, - description - }); - } - pipe(target) { - return ZodPipeline.create(this, target); - } - readonly() { - return ZodReadonly.create(this); - } - isOptional() { - return this.safeParse(void 0).success; - } - isNullable() { - return this.safeParse(null).success; - } - }; - exports.ZodType = ZodType; - exports.Schema = ZodType; - exports.ZodSchema = ZodType; - var cuidRegex = /^c[^\s-]{8,}$/i; - var cuid2Regex = /^[0-9a-z]+$/; - var ulidRegex = /^[0-9A-HJKMNP-TV-Z]{26}$/i; - var uuidRegex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i; - var nanoidRegex = /^[a-z0-9_-]{21}$/i; - var jwtRegex = /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/; - var durationRegex = /^[-+]?P(?!$)(?:(?:[-+]?\d+Y)|(?:[-+]?\d+[.,]\d+Y$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:(?:[-+]?\d+W)|(?:[-+]?\d+[.,]\d+W$))?(?:(?:[-+]?\d+D)|(?:[-+]?\d+[.,]\d+D$))?(?:T(?=[\d+-])(?:(?:[-+]?\d+H)|(?:[-+]?\d+[.,]\d+H$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:[-+]?\d+(?:[.,]\d+)?S)?)??$/; - var emailRegex = /^(?!\.)(?!.*\.\.)([A-Z0-9_'+\-\.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9\-]*\.)+[A-Z]{2,}$/i; - var _emojiRegex = `^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$`; - var emojiRegex; - var ipv4Regex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/; - var ipv4CidrRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/; - var ipv6Regex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/; - var ipv6CidrRegex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/; - var base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/; - var base64urlRegex = /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/; - var dateRegexSource = `((\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\\d|3[01])|(0[469]|11)-(0[1-9]|[12]\\d|30)|(02)-(0[1-9]|1\\d|2[0-8])))`; - var dateRegex = new RegExp(`^${dateRegexSource}$`); - function timeRegexSource(args) { - let secondsRegexSource = `[0-5]\\d`; - if (args.precision) { - secondsRegexSource = `${secondsRegexSource}\\.\\d{${args.precision}}`; - } else if (args.precision == null) { - secondsRegexSource = `${secondsRegexSource}(\\.\\d+)?`; - } - const secondsQuantifier = args.precision ? "+" : "?"; - return `([01]\\d|2[0-3]):[0-5]\\d(:${secondsRegexSource})${secondsQuantifier}`; - } - function timeRegex(args) { - return new RegExp(`^${timeRegexSource(args)}$`); - } - function datetimeRegex(args) { - let regex = `${dateRegexSource}T${timeRegexSource(args)}`; - const opts = []; - opts.push(args.local ? `Z?` : `Z`); - if (args.offset) - opts.push(`([+-]\\d{2}:?\\d{2})`); - regex = `${regex}(${opts.join("|")})`; - return new RegExp(`^${regex}$`); - } - function isValidIP(ip, version) { - if ((version === "v4" || !version) && ipv4Regex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6Regex.test(ip)) { - return true; - } - return false; - } - function isValidJWT(jwt, alg) { - if (!jwtRegex.test(jwt)) - return false; - try { - const [header] = jwt.split("."); - if (!header) - return false; - const base64 = header.replace(/-/g, "+").replace(/_/g, "/").padEnd(header.length + (4 - header.length % 4) % 4, "="); - const decoded = JSON.parse(atob(base64)); - if (typeof decoded !== "object" || decoded === null) - return false; - if ("typ" in decoded && decoded?.typ !== "JWT") - return false; - if (!decoded.alg) - return false; - if (alg && decoded.alg !== alg) - return false; - return true; - } catch { - return false; - } - } - function isValidCidr(ip, version) { - if ((version === "v4" || !version) && ipv4CidrRegex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6CidrRegex.test(ip)) { - return true; - } - return false; - } - var ZodString = class _ZodString extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = String(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.string) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.string, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.length < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.length > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "length") { - const tooBig = input.data.length > check.value; - const tooSmall = input.data.length < check.value; - if (tooBig || tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - if (tooBig) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } else if (tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } - status.dirty(); - } - } else if (check.kind === "email") { - if (!emailRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "email", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "emoji") { - if (!emojiRegex) { - emojiRegex = new RegExp(_emojiRegex, "u"); - } - if (!emojiRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "emoji", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "uuid") { - if (!uuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "uuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "nanoid") { - if (!nanoidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "nanoid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid") { - if (!cuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid2") { - if (!cuid2Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid2", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ulid") { - if (!ulidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ulid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "url") { - try { - new URL(input.data); - } catch { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "regex") { - check.regex.lastIndex = 0; - const testResult = check.regex.test(input.data); - if (!testResult) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "regex", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "trim") { - input.data = input.data.trim(); - } else if (check.kind === "includes") { - if (!input.data.includes(check.value, check.position)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { includes: check.value, position: check.position }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "toLowerCase") { - input.data = input.data.toLowerCase(); - } else if (check.kind === "toUpperCase") { - input.data = input.data.toUpperCase(); - } else if (check.kind === "startsWith") { - if (!input.data.startsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { startsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "endsWith") { - if (!input.data.endsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { endsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "datetime") { - const regex = datetimeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "datetime", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "date") { - const regex = dateRegex; - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "date", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "time") { - const regex = timeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "time", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "duration") { - if (!durationRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "duration", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ip") { - if (!isValidIP(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ip", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "jwt") { - if (!isValidJWT(input.data, check.alg)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "jwt", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cidr") { - if (!isValidCidr(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cidr", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64") { - if (!base64Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64url") { - if (!base64urlRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _regex(regex, validation, message) { - return this.refinement((data) => regex.test(data), { - validation, - code: ZodError_js_1.ZodIssueCode.invalid_string, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - _addCheck(check) { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - email(message) { - return this._addCheck({ kind: "email", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - url(message) { - return this._addCheck({ kind: "url", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - emoji(message) { - return this._addCheck({ kind: "emoji", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - uuid(message) { - return this._addCheck({ kind: "uuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - nanoid(message) { - return this._addCheck({ kind: "nanoid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid(message) { - return this._addCheck({ kind: "cuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid2(message) { - return this._addCheck({ kind: "cuid2", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - ulid(message) { - return this._addCheck({ kind: "ulid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64(message) { - return this._addCheck({ kind: "base64", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64url(message) { - return this._addCheck({ - kind: "base64url", - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - jwt(options) { - return this._addCheck({ kind: "jwt", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - ip(options) { - return this._addCheck({ kind: "ip", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - cidr(options) { - return this._addCheck({ kind: "cidr", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - datetime(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "datetime", - precision: null, - offset: false, - local: false, - message: options - }); - } - return this._addCheck({ - kind: "datetime", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - offset: options?.offset ?? false, - local: options?.local ?? false, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - date(message) { - return this._addCheck({ kind: "date", message }); - } - time(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "time", - precision: null, - message: options - }); - } - return this._addCheck({ - kind: "time", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - duration(message) { - return this._addCheck({ kind: "duration", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - regex(regex, message) { - return this._addCheck({ - kind: "regex", - regex, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - includes(value, options) { - return this._addCheck({ - kind: "includes", - value, - position: options?.position, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - startsWith(value, message) { - return this._addCheck({ - kind: "startsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - endsWith(value, message) { - return this._addCheck({ - kind: "endsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - min(minLength, message) { - return this._addCheck({ - kind: "min", - value: minLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - max(maxLength, message) { - return this._addCheck({ - kind: "max", - value: maxLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - length(len, message) { - return this._addCheck({ - kind: "length", - value: len, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - /** - * Equivalent to `.min(1)` - */ - nonempty(message) { - return this.min(1, errorUtil_js_1.errorUtil.errToObj(message)); - } - trim() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "trim" }] - }); - } - toLowerCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toLowerCase" }] - }); - } - toUpperCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toUpperCase" }] - }); - } - get isDatetime() { - return !!this._def.checks.find((ch) => ch.kind === "datetime"); - } - get isDate() { - return !!this._def.checks.find((ch) => ch.kind === "date"); - } - get isTime() { - return !!this._def.checks.find((ch) => ch.kind === "time"); - } - get isDuration() { - return !!this._def.checks.find((ch) => ch.kind === "duration"); - } - get isEmail() { - return !!this._def.checks.find((ch) => ch.kind === "email"); - } - get isURL() { - return !!this._def.checks.find((ch) => ch.kind === "url"); - } - get isEmoji() { - return !!this._def.checks.find((ch) => ch.kind === "emoji"); - } - get isUUID() { - return !!this._def.checks.find((ch) => ch.kind === "uuid"); - } - get isNANOID() { - return !!this._def.checks.find((ch) => ch.kind === "nanoid"); - } - get isCUID() { - return !!this._def.checks.find((ch) => ch.kind === "cuid"); - } - get isCUID2() { - return !!this._def.checks.find((ch) => ch.kind === "cuid2"); - } - get isULID() { - return !!this._def.checks.find((ch) => ch.kind === "ulid"); - } - get isIP() { - return !!this._def.checks.find((ch) => ch.kind === "ip"); - } - get isCIDR() { - return !!this._def.checks.find((ch) => ch.kind === "cidr"); - } - get isBase64() { - return !!this._def.checks.find((ch) => ch.kind === "base64"); - } - get isBase64url() { - return !!this._def.checks.find((ch) => ch.kind === "base64url"); - } - get minLength() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxLength() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodString = ZodString; - ZodString.create = (params) => { - return new ZodString({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodString, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - function floatSafeRemainder(val, step) { - const valDecCount = (val.toString().split(".")[1] || "").length; - const stepDecCount = (step.toString().split(".")[1] || "").length; - const decCount = valDecCount > stepDecCount ? valDecCount : stepDecCount; - const valInt = Number.parseInt(val.toFixed(decCount).replace(".", "")); - const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", "")); - return valInt % stepInt / 10 ** decCount; - } - var ZodNumber = class _ZodNumber extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - this.step = this.multipleOf; - } - _parse(input) { - if (this._def.coerce) { - input.data = Number(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.number) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.number, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "int") { - if (!util_js_1.util.isInteger(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: "integer", - received: "float", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (floatSafeRemainder(input.data, check.value) !== 0) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "finite") { - if (!Number.isFinite(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_finite, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodNumber({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodNumber({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - int(message) { - return this._addCheck({ - kind: "int", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - finite(message) { - return this._addCheck({ - kind: "finite", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - safe(message) { - return this._addCheck({ - kind: "min", - inclusive: true, - value: Number.MIN_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - })._addCheck({ - kind: "max", - inclusive: true, - value: Number.MAX_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - get isInt() { - return !!this._def.checks.find((ch) => ch.kind === "int" || ch.kind === "multipleOf" && util_js_1.util.isInteger(ch.value)); - } - get isFinite() { - let max = null; - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "finite" || ch.kind === "int" || ch.kind === "multipleOf") { - return true; - } else if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } else if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return Number.isFinite(min) && Number.isFinite(max); - } - }; - exports.ZodNumber = ZodNumber; - ZodNumber.create = (params) => { - return new ZodNumber({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodNumber, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodBigInt = class _ZodBigInt extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - } - _parse(input) { - if (this._def.coerce) { - try { - input.data = BigInt(input.data); - } catch { - return this._getInvalidInput(input); - } - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.bigint) { - return this._getInvalidInput(input); - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - type: "bigint", - minimum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - type: "bigint", - maximum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (input.data % check.value !== BigInt(0)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _getInvalidInput(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.bigint, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodBigInt({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodBigInt({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodBigInt = ZodBigInt; - ZodBigInt.create = (params) => { - return new ZodBigInt({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodBigInt, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - var ZodBoolean = class extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = Boolean(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.boolean) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.boolean, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodBoolean = ZodBoolean; - ZodBoolean.create = (params) => { - return new ZodBoolean({ - typeName: ZodFirstPartyTypeKind.ZodBoolean, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodDate = class _ZodDate extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = new Date(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.date) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.date, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (Number.isNaN(input.data.getTime())) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_date - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.getTime() < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - message: check.message, - inclusive: true, - exact: false, - minimum: check.value, - type: "date" - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.getTime() > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - message: check.message, - inclusive: true, - exact: false, - maximum: check.value, - type: "date" - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { - status: status.value, - value: new Date(input.data.getTime()) - }; - } - _addCheck(check) { - return new _ZodDate({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - min(minDate, message) { - return this._addCheck({ - kind: "min", - value: minDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - max(maxDate, message) { - return this._addCheck({ - kind: "max", - value: maxDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minDate() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min != null ? new Date(min) : null; - } - get maxDate() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max != null ? new Date(max) : null; - } - }; - exports.ZodDate = ZodDate; - ZodDate.create = (params) => { - return new ZodDate({ - checks: [], - coerce: params?.coerce || false, - typeName: ZodFirstPartyTypeKind.ZodDate, - ...processCreateParams(params) - }); - }; - var ZodSymbol = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.symbol) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.symbol, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodSymbol = ZodSymbol; - ZodSymbol.create = (params) => { - return new ZodSymbol({ - typeName: ZodFirstPartyTypeKind.ZodSymbol, - ...processCreateParams(params) - }); - }; - var ZodUndefined = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.undefined, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUndefined = ZodUndefined; - ZodUndefined.create = (params) => { - return new ZodUndefined({ - typeName: ZodFirstPartyTypeKind.ZodUndefined, - ...processCreateParams(params) - }); - }; - var ZodNull = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.null) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.null, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodNull = ZodNull; - ZodNull.create = (params) => { - return new ZodNull({ - typeName: ZodFirstPartyTypeKind.ZodNull, - ...processCreateParams(params) - }); - }; - var ZodAny = class extends ZodType { - constructor() { - super(...arguments); - this._any = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodAny = ZodAny; - ZodAny.create = (params) => { - return new ZodAny({ - typeName: ZodFirstPartyTypeKind.ZodAny, - ...processCreateParams(params) - }); - }; - var ZodUnknown = class extends ZodType { - constructor() { - super(...arguments); - this._unknown = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUnknown = ZodUnknown; - ZodUnknown.create = (params) => { - return new ZodUnknown({ - typeName: ZodFirstPartyTypeKind.ZodUnknown, - ...processCreateParams(params) - }); - }; - var ZodNever = class extends ZodType { - _parse(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.never, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - }; - exports.ZodNever = ZodNever; - ZodNever.create = (params) => { - return new ZodNever({ - typeName: ZodFirstPartyTypeKind.ZodNever, - ...processCreateParams(params) - }); - }; - var ZodVoid = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.void, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodVoid = ZodVoid; - ZodVoid.create = (params) => { - return new ZodVoid({ - typeName: ZodFirstPartyTypeKind.ZodVoid, - ...processCreateParams(params) - }); - }; - var ZodArray = class _ZodArray extends ZodType { - _parse(input) { - const { ctx, status } = this._processInputParams(input); - const def = this._def; - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (def.exactLength !== null) { - const tooBig = ctx.data.length > def.exactLength.value; - const tooSmall = ctx.data.length < def.exactLength.value; - if (tooBig || tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: tooBig ? ZodError_js_1.ZodIssueCode.too_big : ZodError_js_1.ZodIssueCode.too_small, - minimum: tooSmall ? def.exactLength.value : void 0, - maximum: tooBig ? def.exactLength.value : void 0, - type: "array", - inclusive: true, - exact: true, - message: def.exactLength.message - }); - status.dirty(); - } - } - if (def.minLength !== null) { - if (ctx.data.length < def.minLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.minLength.message - }); - status.dirty(); - } - } - if (def.maxLength !== null) { - if (ctx.data.length > def.maxLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.maxLength.message - }); - status.dirty(); - } - } - if (ctx.common.async) { - return Promise.all([...ctx.data].map((item, i) => { - return def.type._parseAsync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - })).then((result2) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, result2); - }); - } - const result = [...ctx.data].map((item, i) => { - return def.type._parseSync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - }); - return parseUtil_js_1.ParseStatus.mergeArray(status, result); - } - get element() { - return this._def.type; - } - min(minLength, message) { - return new _ZodArray({ - ...this._def, - minLength: { value: minLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxLength, message) { - return new _ZodArray({ - ...this._def, - maxLength: { value: maxLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - length(len, message) { - return new _ZodArray({ - ...this._def, - exactLength: { value: len, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodArray = ZodArray; - ZodArray.create = (schema, params) => { - return new ZodArray({ - type: schema, - minLength: null, - maxLength: null, - exactLength: null, - typeName: ZodFirstPartyTypeKind.ZodArray, - ...processCreateParams(params) - }); - }; - function deepPartialify(schema) { - if (schema instanceof ZodObject) { - const newShape = {}; - for (const key in schema.shape) { - const fieldSchema = schema.shape[key]; - newShape[key] = ZodOptional.create(deepPartialify(fieldSchema)); - } - return new ZodObject({ - ...schema._def, - shape: () => newShape - }); - } else if (schema instanceof ZodArray) { - return new ZodArray({ - ...schema._def, - type: deepPartialify(schema.element) - }); - } else if (schema instanceof ZodOptional) { - return ZodOptional.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodNullable) { - return ZodNullable.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodTuple) { - return ZodTuple.create(schema.items.map((item) => deepPartialify(item))); - } else { - return schema; - } - } - var ZodObject = class _ZodObject extends ZodType { - constructor() { - super(...arguments); - this._cached = null; - this.nonstrict = this.passthrough; - this.augment = this.extend; - } - _getCached() { - if (this._cached !== null) - return this._cached; - const shape = this._def.shape(); - const keys = util_js_1.util.objectKeys(shape); - this._cached = { shape, keys }; - return this._cached; - } - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.object) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const { status, ctx } = this._processInputParams(input); - const { shape, keys: shapeKeys } = this._getCached(); - const extraKeys = []; - if (!(this._def.catchall instanceof ZodNever && this._def.unknownKeys === "strip")) { - for (const key in ctx.data) { - if (!shapeKeys.includes(key)) { - extraKeys.push(key); - } - } - } - const pairs = []; - for (const key of shapeKeys) { - const keyValidator = shape[key]; - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: keyValidator._parse(new ParseInputLazyPath(ctx, value, ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (this._def.catchall instanceof ZodNever) { - const unknownKeys = this._def.unknownKeys; - if (unknownKeys === "passthrough") { - for (const key of extraKeys) { - pairs.push({ - key: { status: "valid", value: key }, - value: { status: "valid", value: ctx.data[key] } - }); - } - } else if (unknownKeys === "strict") { - if (extraKeys.length > 0) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.unrecognized_keys, - keys: extraKeys - }); - status.dirty(); - } - } else if (unknownKeys === "strip") { - } else { - throw new Error(`Internal ZodObject error: invalid unknownKeys value.`); - } - } else { - const catchall = this._def.catchall; - for (const key of extraKeys) { - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: catchall._parse( - new ParseInputLazyPath(ctx, value, ctx.path, key) - //, ctx.child(key), value, getParsedType(value) - ), - alwaysSet: key in ctx.data - }); - } - } - if (ctx.common.async) { - return Promise.resolve().then(async () => { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value, - alwaysSet: pair.alwaysSet - }); - } - return syncPairs; - }).then((syncPairs) => { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, syncPairs); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get shape() { - return this._def.shape(); - } - strict(message) { - errorUtil_js_1.errorUtil.errToObj; - return new _ZodObject({ - ...this._def, - unknownKeys: "strict", - ...message !== void 0 ? { - errorMap: (issue, ctx) => { - const defaultError = this._def.errorMap?.(issue, ctx).message ?? ctx.defaultError; - if (issue.code === "unrecognized_keys") - return { - message: errorUtil_js_1.errorUtil.errToObj(message).message ?? defaultError - }; - return { - message: defaultError - }; - } - } : {} - }); - } - strip() { - return new _ZodObject({ - ...this._def, - unknownKeys: "strip" - }); - } - passthrough() { - return new _ZodObject({ - ...this._def, - unknownKeys: "passthrough" - }); - } - // const AugmentFactory = - // (def: Def) => - // ( - // augmentation: Augmentation - // ): ZodObject< - // extendShape, Augmentation>, - // Def["unknownKeys"], - // Def["catchall"] - // > => { - // return new ZodObject({ - // ...def, - // shape: () => ({ - // ...def.shape(), - // ...augmentation, - // }), - // }) as any; - // }; - extend(augmentation) { - return new _ZodObject({ - ...this._def, - shape: () => ({ - ...this._def.shape(), - ...augmentation - }) - }); - } - /** - * Prior to zod@1.0.12 there was a bug in the - * inferred type of merged objects. Please - * upgrade if you are experiencing issues. - */ - merge(merging) { - const merged = new _ZodObject({ - unknownKeys: merging._def.unknownKeys, - catchall: merging._def.catchall, - shape: () => ({ - ...this._def.shape(), - ...merging._def.shape() - }), - typeName: ZodFirstPartyTypeKind.ZodObject - }); - return merged; - } - // merge< - // Incoming extends AnyZodObject, - // Augmentation extends Incoming["shape"], - // NewOutput extends { - // [k in keyof Augmentation | keyof Output]: k extends keyof Augmentation - // ? Augmentation[k]["_output"] - // : k extends keyof Output - // ? Output[k] - // : never; - // }, - // NewInput extends { - // [k in keyof Augmentation | keyof Input]: k extends keyof Augmentation - // ? Augmentation[k]["_input"] - // : k extends keyof Input - // ? Input[k] - // : never; - // } - // >( - // merging: Incoming - // ): ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"], - // NewOutput, - // NewInput - // > { - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - setKey(key, schema) { - return this.augment({ [key]: schema }); - } - // merge( - // merging: Incoming - // ): //ZodObject = (merging) => { - // ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"] - // > { - // // const mergedShape = objectUtil.mergeShapes( - // // this._def.shape(), - // // merging._def.shape() - // // ); - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - catchall(index) { - return new _ZodObject({ - ...this._def, - catchall: index - }); - } - pick(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(mask)) { - if (mask[key] && this.shape[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - omit(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (!mask[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - /** - * @deprecated - */ - deepPartial() { - return deepPartialify(this); - } - partial(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - const fieldSchema = this.shape[key]; - if (mask && !mask[key]) { - newShape[key] = fieldSchema; - } else { - newShape[key] = fieldSchema.optional(); - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - required(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (mask && !mask[key]) { - newShape[key] = this.shape[key]; - } else { - const fieldSchema = this.shape[key]; - let newField = fieldSchema; - while (newField instanceof ZodOptional) { - newField = newField._def.innerType; - } - newShape[key] = newField; - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - keyof() { - return createZodEnum(util_js_1.util.objectKeys(this.shape)); - } - }; - exports.ZodObject = ZodObject; - ZodObject.create = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.strictCreate = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strict", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.lazycreate = (shape, params) => { - return new ZodObject({ - shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - var ZodUnion = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const options = this._def.options; - function handleResults(results) { - for (const result of results) { - if (result.result.status === "valid") { - return result.result; - } - } - for (const result of results) { - if (result.result.status === "dirty") { - ctx.common.issues.push(...result.ctx.common.issues); - return result.result; - } - } - const unionErrors = results.map((result) => new ZodError_js_1.ZodError(result.ctx.common.issues)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return Promise.all(options.map(async (option) => { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - return { - result: await option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }), - ctx: childCtx - }; - })).then(handleResults); - } else { - let dirty = void 0; - const issues = []; - for (const option of options) { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - const result = option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }); - if (result.status === "valid") { - return result; - } else if (result.status === "dirty" && !dirty) { - dirty = { result, ctx: childCtx }; - } - if (childCtx.common.issues.length) { - issues.push(childCtx.common.issues); - } - } - if (dirty) { - ctx.common.issues.push(...dirty.ctx.common.issues); - return dirty.result; - } - const unionErrors = issues.map((issues2) => new ZodError_js_1.ZodError(issues2)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - } - get options() { - return this._def.options; - } - }; - exports.ZodUnion = ZodUnion; - ZodUnion.create = (types, params) => { - return new ZodUnion({ - options: types, - typeName: ZodFirstPartyTypeKind.ZodUnion, - ...processCreateParams(params) - }); - }; - var getDiscriminator = (type) => { - if (type instanceof ZodLazy) { - return getDiscriminator(type.schema); - } else if (type instanceof ZodEffects) { - return getDiscriminator(type.innerType()); - } else if (type instanceof ZodLiteral) { - return [type.value]; - } else if (type instanceof ZodEnum) { - return type.options; - } else if (type instanceof ZodNativeEnum) { - return util_js_1.util.objectValues(type.enum); - } else if (type instanceof ZodDefault) { - return getDiscriminator(type._def.innerType); - } else if (type instanceof ZodUndefined) { - return [void 0]; - } else if (type instanceof ZodNull) { - return [null]; - } else if (type instanceof ZodOptional) { - return [void 0, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodNullable) { - return [null, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodBranded) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodReadonly) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodCatch) { - return getDiscriminator(type._def.innerType); - } else { - return []; - } - }; - var ZodDiscriminatedUnion = class _ZodDiscriminatedUnion extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const discriminator = this.discriminator; - const discriminatorValue = ctx.data[discriminator]; - const option = this.optionsMap.get(discriminatorValue); - if (!option) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union_discriminator, - options: Array.from(this.optionsMap.keys()), - path: [discriminator] - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } else { - return option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } - } - get discriminator() { - return this._def.discriminator; - } - get options() { - return this._def.options; - } - get optionsMap() { - return this._def.optionsMap; - } - /** - * The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. - * However, it only allows a union of objects, all of which need to share a discriminator property. This property must - * have a different value for each object in the union. - * @param discriminator the name of the discriminator property - * @param types an array of object schemas - * @param params - */ - static create(discriminator, options, params) { - const optionsMap = /* @__PURE__ */ new Map(); - for (const type of options) { - const discriminatorValues = getDiscriminator(type.shape[discriminator]); - if (!discriminatorValues.length) { - throw new Error(`A discriminator value for key \`${discriminator}\` could not be extracted from all schema options`); - } - for (const value of discriminatorValues) { - if (optionsMap.has(value)) { - throw new Error(`Discriminator property ${String(discriminator)} has duplicate value ${String(value)}`); - } - optionsMap.set(value, type); - } - } - return new _ZodDiscriminatedUnion({ - typeName: ZodFirstPartyTypeKind.ZodDiscriminatedUnion, - discriminator, - options, - optionsMap, - ...processCreateParams(params) - }); - } - }; - exports.ZodDiscriminatedUnion = ZodDiscriminatedUnion; - function mergeValues(a, b) { - const aType = (0, util_js_1.getParsedType)(a); - const bType = (0, util_js_1.getParsedType)(b); - if (a === b) { - return { valid: true, data: a }; - } else if (aType === util_js_1.ZodParsedType.object && bType === util_js_1.ZodParsedType.object) { - const bKeys = util_js_1.util.objectKeys(b); - const sharedKeys = util_js_1.util.objectKeys(a).filter((key) => bKeys.indexOf(key) !== -1); - const newObj = { ...a, ...b }; - for (const key of sharedKeys) { - const sharedValue = mergeValues(a[key], b[key]); - if (!sharedValue.valid) { - return { valid: false }; - } - newObj[key] = sharedValue.data; - } - return { valid: true, data: newObj }; - } else if (aType === util_js_1.ZodParsedType.array && bType === util_js_1.ZodParsedType.array) { - if (a.length !== b.length) { - return { valid: false }; - } - const newArray = []; - for (let index = 0; index < a.length; index++) { - const itemA = a[index]; - const itemB = b[index]; - const sharedValue = mergeValues(itemA, itemB); - if (!sharedValue.valid) { - return { valid: false }; - } - newArray.push(sharedValue.data); - } - return { valid: true, data: newArray }; - } else if (aType === util_js_1.ZodParsedType.date && bType === util_js_1.ZodParsedType.date && +a === +b) { - return { valid: true, data: a }; - } else { - return { valid: false }; - } - } - var ZodIntersection = class extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const handleParsed = (parsedLeft, parsedRight) => { - if ((0, parseUtil_js_1.isAborted)(parsedLeft) || (0, parseUtil_js_1.isAborted)(parsedRight)) { - return parseUtil_js_1.INVALID; - } - const merged = mergeValues(parsedLeft.value, parsedRight.value); - if (!merged.valid) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_intersection_types - }); - return parseUtil_js_1.INVALID; - } - if ((0, parseUtil_js_1.isDirty)(parsedLeft) || (0, parseUtil_js_1.isDirty)(parsedRight)) { - status.dirty(); - } - return { status: status.value, value: merged.data }; - }; - if (ctx.common.async) { - return Promise.all([ - this._def.left._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), - this._def.right._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }) - ]).then(([left, right]) => handleParsed(left, right)); - } else { - return handleParsed(this._def.left._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), this._def.right._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - })); - } - } - }; - exports.ZodIntersection = ZodIntersection; - ZodIntersection.create = (left, right, params) => { - return new ZodIntersection({ - left, - right, - typeName: ZodFirstPartyTypeKind.ZodIntersection, - ...processCreateParams(params) - }); - }; - var ZodTuple = class _ZodTuple extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (ctx.data.length < this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - return parseUtil_js_1.INVALID; - } - const rest = this._def.rest; - if (!rest && ctx.data.length > this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - status.dirty(); - } - const items = [...ctx.data].map((item, itemIndex) => { - const schema = this._def.items[itemIndex] || this._def.rest; - if (!schema) - return null; - return schema._parse(new ParseInputLazyPath(ctx, item, ctx.path, itemIndex)); - }).filter((x) => !!x); - if (ctx.common.async) { - return Promise.all(items).then((results) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, results); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeArray(status, items); - } - } - get items() { - return this._def.items; - } - rest(rest) { - return new _ZodTuple({ - ...this._def, - rest - }); - } - }; - exports.ZodTuple = ZodTuple; - ZodTuple.create = (schemas, params) => { - if (!Array.isArray(schemas)) { - throw new Error("You must pass an array of schemas to z.tuple([ ... ])"); - } - return new ZodTuple({ - items: schemas, - typeName: ZodFirstPartyTypeKind.ZodTuple, - rest: null, - ...processCreateParams(params) - }); - }; - var ZodRecord = class _ZodRecord extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const pairs = []; - const keyType = this._def.keyType; - const valueType = this._def.valueType; - for (const key in ctx.data) { - pairs.push({ - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, key)), - value: valueType._parse(new ParseInputLazyPath(ctx, ctx.data[key], ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (ctx.common.async) { - return parseUtil_js_1.ParseStatus.mergeObjectAsync(status, pairs); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get element() { - return this._def.valueType; - } - static create(first, second, third) { - if (second instanceof ZodType) { - return new _ZodRecord({ - keyType: first, - valueType: second, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(third) - }); - } - return new _ZodRecord({ - keyType: ZodString.create(), - valueType: first, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(second) - }); - } - }; - exports.ZodRecord = ZodRecord; - var ZodMap = class extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.map) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.map, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const keyType = this._def.keyType; - const valueType = this._def.valueType; - const pairs = [...ctx.data.entries()].map(([key, value], index) => { - return { - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, [index, "key"])), - value: valueType._parse(new ParseInputLazyPath(ctx, value, ctx.path, [index, "value"])) - }; - }); - if (ctx.common.async) { - const finalMap = /* @__PURE__ */ new Map(); - return Promise.resolve().then(async () => { - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - }); - } else { - const finalMap = /* @__PURE__ */ new Map(); - for (const pair of pairs) { - const key = pair.key; - const value = pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - } - } - }; - exports.ZodMap = ZodMap; - ZodMap.create = (keyType, valueType, params) => { - return new ZodMap({ - valueType, - keyType, - typeName: ZodFirstPartyTypeKind.ZodMap, - ...processCreateParams(params) - }); - }; - var ZodSet = class _ZodSet extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.set) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.set, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const def = this._def; - if (def.minSize !== null) { - if (ctx.data.size < def.minSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.minSize.message - }); - status.dirty(); - } - } - if (def.maxSize !== null) { - if (ctx.data.size > def.maxSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.maxSize.message - }); - status.dirty(); - } - } - const valueType = this._def.valueType; - function finalizeSet(elements2) { - const parsedSet = /* @__PURE__ */ new Set(); - for (const element of elements2) { - if (element.status === "aborted") - return parseUtil_js_1.INVALID; - if (element.status === "dirty") - status.dirty(); - parsedSet.add(element.value); - } - return { status: status.value, value: parsedSet }; - } - const elements = [...ctx.data.values()].map((item, i) => valueType._parse(new ParseInputLazyPath(ctx, item, ctx.path, i))); - if (ctx.common.async) { - return Promise.all(elements).then((elements2) => finalizeSet(elements2)); - } else { - return finalizeSet(elements); - } - } - min(minSize, message) { - return new _ZodSet({ - ...this._def, - minSize: { value: minSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxSize, message) { - return new _ZodSet({ - ...this._def, - maxSize: { value: maxSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - size(size, message) { - return this.min(size, message).max(size, message); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodSet = ZodSet; - ZodSet.create = (valueType, params) => { - return new ZodSet({ - valueType, - minSize: null, - maxSize: null, - typeName: ZodFirstPartyTypeKind.ZodSet, - ...processCreateParams(params) - }); - }; - var ZodFunction = class _ZodFunction extends ZodType { - constructor() { - super(...arguments); - this.validate = this.implement; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.function) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.function, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - function makeArgsIssue(args, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: args, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_arguments, - argumentsError: error - } - }); - } - function makeReturnsIssue(returns, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: returns, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_return_type, - returnTypeError: error - } - }); - } - const params = { errorMap: ctx.common.contextualErrorMap }; - const fn = ctx.data; - if (this._def.returns instanceof ZodPromise) { - const me = this; - return (0, parseUtil_js_1.OK)(async function(...args) { - const error = new ZodError_js_1.ZodError([]); - const parsedArgs = await me._def.args.parseAsync(args, params).catch((e) => { - error.addIssue(makeArgsIssue(args, e)); - throw error; - }); - const result = await Reflect.apply(fn, this, parsedArgs); - const parsedReturns = await me._def.returns._def.type.parseAsync(result, params).catch((e) => { - error.addIssue(makeReturnsIssue(result, e)); - throw error; - }); - return parsedReturns; - }); - } else { - const me = this; - return (0, parseUtil_js_1.OK)(function(...args) { - const parsedArgs = me._def.args.safeParse(args, params); - if (!parsedArgs.success) { - throw new ZodError_js_1.ZodError([makeArgsIssue(args, parsedArgs.error)]); - } - const result = Reflect.apply(fn, this, parsedArgs.data); - const parsedReturns = me._def.returns.safeParse(result, params); - if (!parsedReturns.success) { - throw new ZodError_js_1.ZodError([makeReturnsIssue(result, parsedReturns.error)]); - } - return parsedReturns.data; - }); - } - } - parameters() { - return this._def.args; - } - returnType() { - return this._def.returns; - } - args(...items) { - return new _ZodFunction({ - ...this._def, - args: ZodTuple.create(items).rest(ZodUnknown.create()) - }); - } - returns(returnType) { - return new _ZodFunction({ - ...this._def, - returns: returnType - }); - } - implement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - strictImplement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - static create(args, returns, params) { - return new _ZodFunction({ - args: args ? args : ZodTuple.create([]).rest(ZodUnknown.create()), - returns: returns || ZodUnknown.create(), - typeName: ZodFirstPartyTypeKind.ZodFunction, - ...processCreateParams(params) - }); - } - }; - exports.ZodFunction = ZodFunction; - var ZodLazy = class extends ZodType { - get schema() { - return this._def.getter(); - } - _parse(input) { - const { ctx } = this._processInputParams(input); - const lazySchema = this._def.getter(); - return lazySchema._parse({ data: ctx.data, path: ctx.path, parent: ctx }); - } - }; - exports.ZodLazy = ZodLazy; - ZodLazy.create = (getter, params) => { - return new ZodLazy({ - getter, - typeName: ZodFirstPartyTypeKind.ZodLazy, - ...processCreateParams(params) - }); - }; - var ZodLiteral = class extends ZodType { - _parse(input) { - if (input.data !== this._def.value) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_literal, - expected: this._def.value - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - get value() { - return this._def.value; - } - }; - exports.ZodLiteral = ZodLiteral; - ZodLiteral.create = (value, params) => { - return new ZodLiteral({ - value, - typeName: ZodFirstPartyTypeKind.ZodLiteral, - ...processCreateParams(params) - }); - }; - function createZodEnum(values, params) { - return new ZodEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodEnum, - ...processCreateParams(params) - }); - } - var ZodEnum = class _ZodEnum extends ZodType { - _parse(input) { - if (typeof input.data !== "string") { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(this._def.values); - } - if (!this._cache.has(input.data)) { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get options() { - return this._def.values; - } - get enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Values() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - extract(values, newDef = this._def) { - return _ZodEnum.create(values, { - ...this._def, - ...newDef - }); - } - exclude(values, newDef = this._def) { - return _ZodEnum.create(this.options.filter((opt) => !values.includes(opt)), { - ...this._def, - ...newDef - }); - } - }; - exports.ZodEnum = ZodEnum; - ZodEnum.create = createZodEnum; - var ZodNativeEnum = class extends ZodType { - _parse(input) { - const nativeEnumValues = util_js_1.util.getValidEnumValues(this._def.values); - const ctx = this._getOrReturnCtx(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.string && ctx.parsedType !== util_js_1.ZodParsedType.number) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(util_js_1.util.getValidEnumValues(this._def.values)); - } - if (!this._cache.has(input.data)) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get enum() { - return this._def.values; - } - }; - exports.ZodNativeEnum = ZodNativeEnum; - ZodNativeEnum.create = (values, params) => { - return new ZodNativeEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodNativeEnum, - ...processCreateParams(params) - }); - }; - var ZodPromise = class extends ZodType { - unwrap() { - return this._def.type; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.promise && ctx.common.async === false) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.promise, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const promisified = ctx.parsedType === util_js_1.ZodParsedType.promise ? ctx.data : Promise.resolve(ctx.data); - return (0, parseUtil_js_1.OK)(promisified.then((data) => { - return this._def.type.parseAsync(data, { - path: ctx.path, - errorMap: ctx.common.contextualErrorMap - }); - })); - } - }; - exports.ZodPromise = ZodPromise; - ZodPromise.create = (schema, params) => { - return new ZodPromise({ - type: schema, - typeName: ZodFirstPartyTypeKind.ZodPromise, - ...processCreateParams(params) - }); - }; - var ZodEffects = class extends ZodType { - innerType() { - return this._def.schema; - } - sourceType() { - return this._def.schema._def.typeName === ZodFirstPartyTypeKind.ZodEffects ? this._def.schema.sourceType() : this._def.schema; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const effect = this._def.effect || null; - const checkCtx = { - addIssue: (arg) => { - (0, parseUtil_js_1.addIssueToContext)(ctx, arg); - if (arg.fatal) { - status.abort(); - } else { - status.dirty(); - } - }, - get path() { - return ctx.path; - } - }; - checkCtx.addIssue = checkCtx.addIssue.bind(checkCtx); - if (effect.type === "preprocess") { - const processed = effect.transform(ctx.data, checkCtx); - if (ctx.common.async) { - return Promise.resolve(processed).then(async (processed2) => { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = await this._def.schema._parseAsync({ - data: processed2, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - }); - } else { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = this._def.schema._parseSync({ - data: processed, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - } - } - if (effect.type === "refinement") { - const executeRefinement = (acc) => { - const result = effect.refinement(acc, checkCtx); - if (ctx.common.async) { - return Promise.resolve(result); - } - if (result instanceof Promise) { - throw new Error("Async refinement encountered during synchronous parse operation. Use .parseAsync instead."); - } - return acc; - }; - if (ctx.common.async === false) { - const inner = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - executeRefinement(inner.value); - return { status: status.value, value: inner.value }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((inner) => { - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - return executeRefinement(inner.value).then(() => { - return { status: status.value, value: inner.value }; - }); - }); - } - } - if (effect.type === "transform") { - if (ctx.common.async === false) { - const base = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - const result = effect.transform(base.value, checkCtx); - if (result instanceof Promise) { - throw new Error(`Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead.`); - } - return { status: status.value, value: result }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((base) => { - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - return Promise.resolve(effect.transform(base.value, checkCtx)).then((result) => ({ - status: status.value, - value: result - })); - }); - } - } - util_js_1.util.assertNever(effect); - } - }; - exports.ZodEffects = ZodEffects; - exports.ZodTransformer = ZodEffects; - ZodEffects.create = (schema, effect, params) => { - return new ZodEffects({ - schema, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect, - ...processCreateParams(params) - }); - }; - ZodEffects.createWithPreprocess = (preprocess, schema, params) => { - return new ZodEffects({ - schema, - effect: { type: "preprocess", transform: preprocess }, - typeName: ZodFirstPartyTypeKind.ZodEffects, - ...processCreateParams(params) - }); - }; - var ZodOptional = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.undefined) { - return (0, parseUtil_js_1.OK)(void 0); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodOptional = ZodOptional; - ZodOptional.create = (type, params) => { - return new ZodOptional({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodOptional, - ...processCreateParams(params) - }); - }; - var ZodNullable = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.null) { - return (0, parseUtil_js_1.OK)(null); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodNullable = ZodNullable; - ZodNullable.create = (type, params) => { - return new ZodNullable({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodNullable, - ...processCreateParams(params) - }); - }; - var ZodDefault = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - let data = ctx.data; - if (ctx.parsedType === util_js_1.ZodParsedType.undefined) { - data = this._def.defaultValue(); - } - return this._def.innerType._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - removeDefault() { - return this._def.innerType; - } - }; - exports.ZodDefault = ZodDefault; - ZodDefault.create = (type, params) => { - return new ZodDefault({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodDefault, - defaultValue: typeof params.default === "function" ? params.default : () => params.default, - ...processCreateParams(params) - }); - }; - var ZodCatch = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const newCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - } - }; - const result = this._def.innerType._parse({ - data: newCtx.data, - path: newCtx.path, - parent: { - ...newCtx - } - }); - if ((0, parseUtil_js_1.isAsync)(result)) { - return result.then((result2) => { - return { - status: "valid", - value: result2.status === "valid" ? result2.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - }); - } else { - return { - status: "valid", - value: result.status === "valid" ? result.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - } - } - removeCatch() { - return this._def.innerType; - } - }; - exports.ZodCatch = ZodCatch; - ZodCatch.create = (type, params) => { - return new ZodCatch({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodCatch, - catchValue: typeof params.catch === "function" ? params.catch : () => params.catch, - ...processCreateParams(params) - }); - }; - var ZodNaN = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.nan) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.nan, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - }; - exports.ZodNaN = ZodNaN; - ZodNaN.create = (params) => { - return new ZodNaN({ - typeName: ZodFirstPartyTypeKind.ZodNaN, - ...processCreateParams(params) - }); - }; - exports.BRAND = Symbol("zod_brand"); - var ZodBranded = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const data = ctx.data; - return this._def.type._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - unwrap() { - return this._def.type; - } - }; - exports.ZodBranded = ZodBranded; - var ZodPipeline = class _ZodPipeline extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.common.async) { - const handleAsync = async () => { - const inResult = await this._def.in._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return (0, parseUtil_js_1.DIRTY)(inResult.value); - } else { - return this._def.out._parseAsync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - }; - return handleAsync(); - } else { - const inResult = this._def.in._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return { - status: "dirty", - value: inResult.value - }; - } else { - return this._def.out._parseSync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - } - } - static create(a, b) { - return new _ZodPipeline({ - in: a, - out: b, - typeName: ZodFirstPartyTypeKind.ZodPipeline - }); - } - }; - exports.ZodPipeline = ZodPipeline; - var ZodReadonly = class extends ZodType { - _parse(input) { - const result = this._def.innerType._parse(input); - const freeze = (data) => { - if ((0, parseUtil_js_1.isValid)(data)) { - data.value = Object.freeze(data.value); - } - return data; - }; - return (0, parseUtil_js_1.isAsync)(result) ? result.then((data) => freeze(data)) : freeze(result); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodReadonly = ZodReadonly; - ZodReadonly.create = (type, params) => { - return new ZodReadonly({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodReadonly, - ...processCreateParams(params) - }); - }; - function cleanParams(params, data) { - const p = typeof params === "function" ? params(data) : typeof params === "string" ? { message: params } : params; - const p2 = typeof p === "string" ? { message: p } : p; - return p2; - } - function custom(check, _params = {}, fatal) { - if (check) - return ZodAny.create().superRefine((data, ctx) => { - const r = check(data); - if (r instanceof Promise) { - return r.then((r2) => { - if (!r2) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - }); - } - if (!r) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - return; - }); - return ZodAny.create(); - } - exports.late = { - object: ZodObject.lazycreate - }; - var ZodFirstPartyTypeKind; - (function(ZodFirstPartyTypeKind2) { - ZodFirstPartyTypeKind2["ZodString"] = "ZodString"; - ZodFirstPartyTypeKind2["ZodNumber"] = "ZodNumber"; - ZodFirstPartyTypeKind2["ZodNaN"] = "ZodNaN"; - ZodFirstPartyTypeKind2["ZodBigInt"] = "ZodBigInt"; - ZodFirstPartyTypeKind2["ZodBoolean"] = "ZodBoolean"; - ZodFirstPartyTypeKind2["ZodDate"] = "ZodDate"; - ZodFirstPartyTypeKind2["ZodSymbol"] = "ZodSymbol"; - ZodFirstPartyTypeKind2["ZodUndefined"] = "ZodUndefined"; - ZodFirstPartyTypeKind2["ZodNull"] = "ZodNull"; - ZodFirstPartyTypeKind2["ZodAny"] = "ZodAny"; - ZodFirstPartyTypeKind2["ZodUnknown"] = "ZodUnknown"; - ZodFirstPartyTypeKind2["ZodNever"] = "ZodNever"; - ZodFirstPartyTypeKind2["ZodVoid"] = "ZodVoid"; - ZodFirstPartyTypeKind2["ZodArray"] = "ZodArray"; - ZodFirstPartyTypeKind2["ZodObject"] = "ZodObject"; - ZodFirstPartyTypeKind2["ZodUnion"] = "ZodUnion"; - ZodFirstPartyTypeKind2["ZodDiscriminatedUnion"] = "ZodDiscriminatedUnion"; - ZodFirstPartyTypeKind2["ZodIntersection"] = "ZodIntersection"; - ZodFirstPartyTypeKind2["ZodTuple"] = "ZodTuple"; - ZodFirstPartyTypeKind2["ZodRecord"] = "ZodRecord"; - ZodFirstPartyTypeKind2["ZodMap"] = "ZodMap"; - ZodFirstPartyTypeKind2["ZodSet"] = "ZodSet"; - ZodFirstPartyTypeKind2["ZodFunction"] = "ZodFunction"; - ZodFirstPartyTypeKind2["ZodLazy"] = "ZodLazy"; - ZodFirstPartyTypeKind2["ZodLiteral"] = "ZodLiteral"; - ZodFirstPartyTypeKind2["ZodEnum"] = "ZodEnum"; - ZodFirstPartyTypeKind2["ZodEffects"] = "ZodEffects"; - ZodFirstPartyTypeKind2["ZodNativeEnum"] = "ZodNativeEnum"; - ZodFirstPartyTypeKind2["ZodOptional"] = "ZodOptional"; - ZodFirstPartyTypeKind2["ZodNullable"] = "ZodNullable"; - ZodFirstPartyTypeKind2["ZodDefault"] = "ZodDefault"; - ZodFirstPartyTypeKind2["ZodCatch"] = "ZodCatch"; - ZodFirstPartyTypeKind2["ZodPromise"] = "ZodPromise"; - ZodFirstPartyTypeKind2["ZodBranded"] = "ZodBranded"; - ZodFirstPartyTypeKind2["ZodPipeline"] = "ZodPipeline"; - ZodFirstPartyTypeKind2["ZodReadonly"] = "ZodReadonly"; - })(ZodFirstPartyTypeKind || (exports.ZodFirstPartyTypeKind = ZodFirstPartyTypeKind = {})); - var instanceOfType = (cls, params = { - message: `Input not instance of ${cls.name}` - }) => custom((data) => data instanceof cls, params); - exports.instanceof = instanceOfType; - var stringType = ZodString.create; - exports.string = stringType; - var numberType = ZodNumber.create; - exports.number = numberType; - var nanType = ZodNaN.create; - exports.nan = nanType; - var bigIntType = ZodBigInt.create; - exports.bigint = bigIntType; - var booleanType = ZodBoolean.create; - exports.boolean = booleanType; - var dateType = ZodDate.create; - exports.date = dateType; - var symbolType = ZodSymbol.create; - exports.symbol = symbolType; - var undefinedType = ZodUndefined.create; - exports.undefined = undefinedType; - var nullType = ZodNull.create; - exports.null = nullType; - var anyType = ZodAny.create; - exports.any = anyType; - var unknownType = ZodUnknown.create; - exports.unknown = unknownType; - var neverType = ZodNever.create; - exports.never = neverType; - var voidType = ZodVoid.create; - exports.void = voidType; - var arrayType = ZodArray.create; - exports.array = arrayType; - var objectType = ZodObject.create; - exports.object = objectType; - var strictObjectType = ZodObject.strictCreate; - exports.strictObject = strictObjectType; - var unionType = ZodUnion.create; - exports.union = unionType; - var discriminatedUnionType = ZodDiscriminatedUnion.create; - exports.discriminatedUnion = discriminatedUnionType; - var intersectionType = ZodIntersection.create; - exports.intersection = intersectionType; - var tupleType = ZodTuple.create; - exports.tuple = tupleType; - var recordType = ZodRecord.create; - exports.record = recordType; - var mapType = ZodMap.create; - exports.map = mapType; - var setType = ZodSet.create; - exports.set = setType; - var functionType = ZodFunction.create; - exports.function = functionType; - var lazyType = ZodLazy.create; - exports.lazy = lazyType; - var literalType = ZodLiteral.create; - exports.literal = literalType; - var enumType = ZodEnum.create; - exports.enum = enumType; - var nativeEnumType = ZodNativeEnum.create; - exports.nativeEnum = nativeEnumType; - var promiseType = ZodPromise.create; - exports.promise = promiseType; - var effectsType = ZodEffects.create; - exports.effect = effectsType; - exports.transformer = effectsType; - var optionalType = ZodOptional.create; - exports.optional = optionalType; - var nullableType = ZodNullable.create; - exports.nullable = nullableType; - var preprocessType = ZodEffects.createWithPreprocess; - exports.preprocess = preprocessType; - var pipelineType = ZodPipeline.create; - exports.pipeline = pipelineType; - var ostring = () => stringType().optional(); - exports.ostring = ostring; - var onumber = () => numberType().optional(); - exports.onumber = onumber; - var oboolean = () => booleanType().optional(); - exports.oboolean = oboolean; - exports.coerce = { - string: ((arg) => ZodString.create({ ...arg, coerce: true })), - number: ((arg) => ZodNumber.create({ ...arg, coerce: true })), - boolean: ((arg) => ZodBoolean.create({ - ...arg, - coerce: true - })), - bigint: ((arg) => ZodBigInt.create({ ...arg, coerce: true })), - date: ((arg) => ZodDate.create({ ...arg, coerce: true })) - }; - exports.NEVER = parseUtil_js_1.INVALID; - } - }); - - // node_modules/zod/v3/external.cjs - var require_external = __commonJS({ - "node_modules/zod/v3/external.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_errors(), exports); - __exportStar(require_parseUtil(), exports); - __exportStar(require_typeAliases(), exports); - __exportStar(require_util(), exports); - __exportStar(require_types(), exports); - __exportStar(require_ZodError(), exports); - } - }); - - // node_modules/zod/index.cjs - var require_zod = __commonJS({ - "node_modules/zod/index.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); - } - __setModuleDefault(result, mod); - return result; - }; - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.z = void 0; - var z = __importStar(require_external()); - exports.z = z; - __exportStar(require_external(), exports); - exports.default = z; - } - }); - - // node_modules/@mistralai/mistralai/lib/base64.js - var require_base64 = __commonJS({ - "node_modules/@mistralai/mistralai/lib/base64.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodInbound = exports.zodOutbound = void 0; - exports.bytesToBase64 = bytesToBase64; - exports.bytesFromBase64 = bytesFromBase64; - exports.stringToBytes = stringToBytes; - exports.stringFromBytes = stringFromBytes; - exports.stringToBase64 = stringToBase64; - exports.stringFromBase64 = stringFromBase64; - var z = __importStar(require_zod()); - function bytesToBase64(u8arr) { - return btoa(String.fromCodePoint(...u8arr)); - } - function bytesFromBase64(encoded) { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); - } - function stringToBytes(str) { - return new TextEncoder().encode(str); - } - function stringFromBytes(u8arr) { - return new TextDecoder().decode(u8arr); - } - function stringToBase64(str) { - return bytesToBase64(stringToBytes(str)); - } - function stringFromBase64(b64str) { - return stringFromBytes(bytesFromBase64(b64str)); - } - exports.zodOutbound = z.instanceof(Uint8Array).or(z.string().transform(stringToBytes)); - exports.zodInbound = z.instanceof(Uint8Array).or(z.string().transform(bytesFromBase64)); - } - }); - - // node_modules/@mistralai/mistralai/lib/is-plain-object.js - var require_is_plain_object = __commonJS({ - "node_modules/@mistralai/mistralai/lib/is-plain-object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isPlainObject = isPlainObject; - function isPlainObject(value) { - if (typeof value !== "object" || value === null) { - return false; - } - const prototype = Object.getPrototypeOf(value); - return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/encodings.js - var require_encodings = __commonJS({ - "node_modules/@mistralai/mistralai/lib/encodings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.encodeDeepObjectQuery = exports.encodePipeDelimitedQuery = exports.encodeSpaceDelimitedQuery = exports.encodeFormQuery = exports.encodeJSONQuery = exports.encodeSimple = exports.encodePipeDelimited = exports.encodeSpaceDelimited = exports.encodeForm = exports.EncodingError = void 0; - exports.encodeMatrix = encodeMatrix; - exports.encodeLabel = encodeLabel; - exports.encodeBodyForm = encodeBodyForm; - exports.encodeDeepObject = encodeDeepObject; - exports.encodeDeepObjectObject = encodeDeepObjectObject; - exports.encodeJSON = encodeJSON; - exports.queryJoin = queryJoin; - exports.queryEncoder = queryEncoder; - exports.appendForm = appendForm; - var base64_js_1 = require_base64(); - var is_plain_object_js_1 = require_is_plain_object(); - var EncodingError = class extends Error { - constructor(message) { - super(message); - this.name = "EncodingError"; - } - }; - exports.EncodingError = EncodingError; - function encodeMatrix(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - if (!tmp) { - return; - } - out += `;${tmp}`; - }); - return out; - } - function encodeLabel(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - out += encValue == null ? "" : `.${encValue}`; - }); - return out; - } - function formEncoder(sep) { - return (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - const encodedSep = encodeString(sep); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - }; - } - exports.encodeForm = formEncoder(","); - exports.encodeSpaceDelimited = formEncoder(" "); - exports.encodePipeDelimited = formEncoder("|"); - function encodeBodyForm(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - } - function encodeDeepObject(key, value, options) { - if (value == null) { - return; - } - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Value of parameter '${key}' which uses deepObject encoding must be an object or null`); - } - return encodeDeepObjectObject(key, value, options); - } - function encodeDeepObjectObject(key, value, options) { - if (value == null) { - return; - } - let out = ""; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - const pk = `${key}[${ck}]`; - if ((0, is_plain_object_js_1.isPlainObject)(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - out += objOut == null ? "" : `&${objOut}`; - return; - } - const pairs = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - out += encoded == null ? "" : `&${encoded}`; - }); - return out.slice(1); - } - function encodeJSON(key, value, options) { - if (typeof value === "undefined") { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; - } - var encodeSimple = (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - out += tmp ? `,${tmp}` : ""; - }); - return out.slice(1); - }; - exports.encodeSimple = encodeSimple; - function explode(key, value) { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if ((0, is_plain_object_js_1.isPlainObject)(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } - } - function serializeValue(value) { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - return `${value}`; - } - function jsonReplacer(_, value) { - if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else { - return value; - } - } - function mapDefined(inp, mapper) { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - const m = mapper(v); - if (m == null) { - return acc; - } - acc.push(m); - return acc; - }, []); - return res.length ? res : null; - } - function mapDefinedEntries(inp, mapper) { - const acc = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - const m = mapper([k, v]); - if (m == null) { - continue; - } - acc.push(m); - } - return acc.length ? acc : null; - } - function queryJoin(...args) { - return args.filter(Boolean).join("&"); - } - function queryEncoder(f) { - const bulkEncode = function(values, options) { - const opts = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent" - }; - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - return bulkEncode; - } - exports.encodeJSONQuery = queryEncoder(encodeJSON); - exports.encodeFormQuery = queryEncoder(exports.encodeForm); - exports.encodeSpaceDelimitedQuery = queryEncoder(exports.encodeSpaceDelimited); - exports.encodePipeDelimitedQuery = queryEncoder(exports.encodePipeDelimited); - exports.encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - function appendForm(fd, key, value, fileName) { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/dlv.js - var require_dlv = __commonJS({ - "node_modules/@mistralai/mistralai/lib/dlv.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.dlv = dlv; - function dlv(obj, key, def, p, undef) { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/env.js - var require_env = __commonJS({ - "node_modules/@mistralai/mistralai/lib/env.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.envSchema = void 0; - exports.env = env; - exports.resetEnv = resetEnv; - var dlv_js_1 = require_dlv(); - var z = __importStar(require_zod()); - exports.envSchema = z.object({ - MISTRAL_API_KEY: z.string().optional(), - MISTRAL_DEBUG: z.coerce.boolean().optional() - }); - var envMemo = void 0; - function env() { - if (envMemo) { - return envMemo; - } - envMemo = exports.envSchema.parse((0, dlv_js_1.dlv)(globalThis, "process.env") ?? (0, dlv_js_1.dlv)(globalThis, "Deno.env") ?? {}); - return envMemo; - } - function resetEnv() { - envMemo = void 0; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/retries.js - var require_retries = __commonJS({ - "node_modules/@mistralai/mistralai/lib/retries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TemporaryError = exports.PermanentError = void 0; - exports.retry = retry; - var http_js_1 = require_http(); - var defaultBackoff = { - initialInterval: 500, - maxInterval: 6e4, - exponent: 1.5, - maxElapsedTime: 36e5 - }; - var PermanentError = class _PermanentError extends Error { - constructor(message, options) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - super(msg, options); - this.name = "PermanentError"; - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - Object.setPrototypeOf(this, _PermanentError.prototype); - } - }; - exports.PermanentError = PermanentError; - var TemporaryError = class _TemporaryError extends Error { - constructor(message, response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - Object.setPrototypeOf(this, _TemporaryError.prototype); - } - }; - exports.TemporaryError = TemporaryError; - async function retry(fetchFn, options) { - switch (options.config.strategy) { - case "backoff": - return retryBackoff(wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors - }), options.config.backoff ?? defaultBackoff); - default: - return await fetchFn(); - } - } - function wrapFetcher(fn, options) { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError("Response failed with retryable status code", res); - } - return res; - } catch (err) { - if (err instanceof TemporaryError) { - throw err; - } - if (options.retryConnectionErrors && ((0, http_js_1.isTimeoutError)(err) || (0, http_js_1.isConnectionError)(err))) { - throw err; - } - throw new PermanentError("Permanent error", { cause: err }); - } - }; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function isRetryableResponse(res, statusCodes) { - const actual = `${res.status}`; - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - async function retryBackoff(fn, strategy) { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - const start = Date.now(); - let x = 0; - while (true) { - try { - const res = await fn(); - return res; - } catch (err) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - throw err; - } - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - if (retryInterval <= 0) { - retryInterval = initialInterval * Math.pow(x, exponent) + Math.random() * 1e3; - } - const d = Math.min(retryInterval, maxInterval); - await delay(d); - x++; - } - } - } - function retryIntervalFromResponse(res) { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1e3; - } - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - return 0; - } - async function delay(delay2) { - return new Promise((resolve) => setTimeout(resolve, delay2)); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/sdks.js - var require_sdks = __commonJS({ - "node_modules/@mistralai/mistralai/lib/sdks.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _ClientSDK_httpClient; - var _ClientSDK_hooks; - var _ClientSDK_logger; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClientSDK = void 0; - var hooks_js_1 = require_hooks(); - var httpclienterrors_js_1 = require_httpclienterrors(); - var fp_js_1 = require_fp(); - var base64_js_1 = require_base64(); - var config_js_1 = require_config(); - var encodings_js_1 = require_encodings(); - var env_js_1 = require_env(); - var http_js_1 = require_http(); - var retries_js_1 = require_retries(); - var gt = typeof globalThis === "undefined" ? null : globalThis; - var webWorkerLike = typeof gt === "object" && gt != null && "importScripts" in gt && typeof gt["importScripts"] === "function"; - var isBrowserLike = webWorkerLike || typeof navigator !== "undefined" && "serviceWorker" in navigator || typeof window === "object" && typeof window.document !== "undefined"; - var ClientSDK = class { - constructor(options = {}) { - _ClientSDK_httpClient.set(this, void 0); - _ClientSDK_hooks.set(this, void 0); - _ClientSDK_logger.set(this, void 0); - const opt = options; - if (typeof opt === "object" && opt != null && "hooks" in opt && opt.hooks instanceof hooks_js_1.SDKHooks) { - __classPrivateFieldSet(this, _ClientSDK_hooks, opt.hooks, "f"); - } else { - __classPrivateFieldSet(this, _ClientSDK_hooks, new hooks_js_1.SDKHooks(), "f"); - } - const url = (0, config_js_1.serverURLFromOptions)(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").sdkInit({ - baseURL: url, - client: options.httpClient || new http_js_1.HTTPClient() - }); - this._baseURL = baseURL; - __classPrivateFieldSet(this, _ClientSDK_httpClient, client, "f"); - this._options = { ...options, hooks: __classPrivateFieldGet(this, _ClientSDK_hooks, "f") }; - __classPrivateFieldSet(this, _ClientSDK_logger, this._options.debugLogger, "f"); - if (!__classPrivateFieldGet(this, _ClientSDK_logger, "f") && (0, env_js_1.env)().MISTRAL_DEBUG) { - __classPrivateFieldSet(this, _ClientSDK_logger, console, "f"); - } - } - _createRequest(context, conf, options) { - const { method, path, query, headers: opHeaders, security } = conf; - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - let finalQuery = query || ""; - const secQuery = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = (0, encodings_js_1.encodeForm)(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - const headers = new Headers(opHeaders); - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = (0, base64_js_1.stringToBase64)([username || "", password || ""].join(":")); - headers.set("Authorization", `Basic ${encoded}`); - } - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - const userHeaders = new Headers(options?.headers ?? options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", conf.userAgent ?? config_js_1.SDK_METADATA.userAgent); - } - const fetchOptions = { - ...options?.fetchOptions, - ...options - }; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - fetchOptions.signal = timeoutSignal; - } - if (conf.body instanceof ReadableStream) { - Object.assign(fetchOptions, { duplex: "half" }); - } - let input; - try { - input = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method - } - }); - } catch (err) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Create request hook failed to execute", { - cause: err - })); - } - return (0, fp_js_1.OK)(new Request(input.url, input.options)); - } - async _do(request, options) { - const { context, errorCodes } = options; - return (0, retries_js_1.retry)(async () => { - const req = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeRequest(context, request.clone()); - await logRequest(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log request:", e)); - let response = await __classPrivateFieldGet(this, _ClientSDK_httpClient, "f").request(req); - try { - if ((0, http_js_1.matchStatusCode)(response, errorCodes)) { - const result = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterError(context, response, null); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterSuccess(context, response); - } - } finally { - await logResponse(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), response, req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log response:", e)); - } - return response; - }, { config: options.retryConfig, statusCodes: options.retryCodes }).then((r) => (0, fp_js_1.OK)(r), (err) => { - switch (true) { - case (0, http_js_1.isAbortError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestAbortedError("Request aborted by client", { - cause: err - })); - case (0, http_js_1.isTimeoutError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestTimeoutError("Request timed out", { cause: err })); - case (0, http_js_1.isConnectionError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.ConnectionError("Unable to make request", { cause: err })); - default: - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Unexpected HTTP client error", { - cause: err - })); - } - }); - } - }; - exports.ClientSDK = ClientSDK; - _ClientSDK_httpClient = /* @__PURE__ */ new WeakMap(), _ClientSDK_hooks = /* @__PURE__ */ new WeakMap(), _ClientSDK_logger = /* @__PURE__ */ new WeakMap(); - var jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; - var jsonlLikeContentTypeRE = /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; - async function logRequest(logger, req) { - if (!logger) { - return; - } - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`> Request: ${req.method} ${req.url}`); - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - async function logResponse(logger, res, req) { - if (!logger) { - return; - } - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case ((0, http_js_1.matchContentType)(res, "application/json") || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().json()); - break; - case ((0, http_js_1.matchContentType)(res, "application/jsonl") || jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case (0, http_js_1.matchContentType)(res, "text/*"): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/mistralerror.js - var require_mistralerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/mistralerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralError = void 0; - var MistralError = class extends Error { - constructor(message, httpMeta) { - super(message); - this.statusCode = httpMeta.response.status; - this.body = httpMeta.body; - this.headers = httpMeta.response.headers; - this.contentType = httpMeta.response.headers.get("content-type") || ""; - this.rawResponse = httpMeta.response; - this.name = "MistralError"; - } - }; - exports.MistralError = MistralError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js - var require_sdkvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKValidationError = void 0; - exports.formatZodError = formatZodError; - var z = __importStar(require_zod()); - var SDKValidationError = class extends Error { - // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError` - static [Symbol.hasInstance](instance) { - if (!(instance instanceof Error)) - return false; - if (!("rawValue" in instance)) - return false; - if (!("rawMessage" in instance)) - return false; - if (!("pretty" in instance)) - return false; - if (typeof instance.pretty !== "function") - return false; - return true; - } - constructor(message, cause, rawValue) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.SDKValidationError = SDKValidationError; - function formatZodError(err, level = 0) { - let pre = " ".repeat(level); - pre = level > 0 ? `\u2502${pre}` : pre; - pre += " ".repeat(level); - let message = ""; - const append = (str) => message += ` -${pre}${str}`; - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - if (len) { - append(`\u250C ${headline}:`); - } - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`\u2502 \u2022 [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`\u2502 Want: ${issue.expected}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`\u2502 Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len2 = issue.unionErrors.length; - append(`\u2502 \u2716\uFE0E Attemped to deserialize into one of ${len2} union members:`); - issue.unionErrors.forEach((err2, i) => { - append(`\u2502 \u2716\uFE0E Member ${i + 1} of ${len2}`); - append(`${formatZodError(err2, level + 1)}`); - }); - } - } - } - if (err.issues.length) { - append(`\u2514\u2500*`); - } - return message.slice(1); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js - var require_responsevalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseValidationError = void 0; - var z = __importStar(require_zod()); - var mistralerror_js_1 = require_mistralerror(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var ResponseValidationError = class extends mistralerror_js_1.MistralError { - constructor(message, extra) { - super(message, extra); - this.name = "ResponseValidationError"; - this.cause = extra.cause; - this.rawValue = extra.rawValue; - this.rawMessage = extra.rawMessage; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${(0, sdkvalidationerror_js_1.formatZodError)(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.ResponseValidationError = ResponseValidationError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkerror.js - var require_sdkerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKError = void 0; - var mistralerror_js_1 = require_mistralerror(); - var SDKError = class extends mistralerror_js_1.MistralError { - constructor(message, httpMeta) { - if (message) { - message += `: `; - } - message += `Status ${httpMeta.response.status}`; - const contentType = httpMeta.response.headers.get("content-type") || `""`; - if (contentType !== "application/json") { - message += ` Content-Type ${contentType.includes(" ") ? `"${contentType}"` : contentType}`; - } - const body = httpMeta.body || `""`; - message += body.length > 100 ? "\n" : ". "; - let bodyDisplay = body; - if (body.length > 1e4) { - const truncated = body.substring(0, 1e4); - const remaining = body.length - 1e4; - bodyDisplay = `${truncated}...and ${remaining} more chars`; - } - message += `Body: ${bodyDisplay}`; - message = message.trim(); - super(message, httpMeta); - this.name = "SDKError"; - } - }; - exports.SDKError = SDKError; - } - }); - - // node_modules/@mistralai/mistralai/lib/matchers.js - var require_matchers = __commonJS({ - "node_modules/@mistralai/mistralai/lib/matchers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.jsonErr = jsonErr; - exports.json = json; - exports.jsonl = jsonl; - exports.jsonlErr = jsonlErr; - exports.textErr = textErr; - exports.text = text; - exports.bytesErr = bytesErr; - exports.bytes = bytes; - exports.streamErr = streamErr; - exports.stream = stream; - exports.sseErr = sseErr; - exports.sse = sse; - exports.nilErr = nilErr; - exports.nil = nil; - exports.fail = fail; - exports.match = match; - exports.unpackHeaders = unpackHeaders; - var responsevalidationerror_js_1 = require_responsevalidationerror(); - var sdkerror_js_1 = require_sdkerror(); - var fp_js_1 = require_fp(); - var http_js_1 = require_http(); - var is_plain_object_js_1 = require_is_plain_object(); - var DEFAULT_CONTENT_TYPES = { - jsonl: "application/jsonl", - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*" - }; - function jsonErr(codes, schema, options) { - return { ...options, err: true, enc: "json", codes, schema }; - } - function json(codes, schema, options) { - return { ...options, enc: "json", codes, schema }; - } - function jsonl(codes, schema, options) { - return { ...options, enc: "jsonl", codes, schema }; - } - function jsonlErr(codes, schema, options) { - return { ...options, err: true, enc: "jsonl", codes, schema }; - } - function textErr(codes, schema, options) { - return { ...options, err: true, enc: "text", codes, schema }; - } - function text(codes, schema, options) { - return { ...options, enc: "text", codes, schema }; - } - function bytesErr(codes, schema, options) { - return { ...options, err: true, enc: "bytes", codes, schema }; - } - function bytes(codes, schema, options) { - return { ...options, enc: "bytes", codes, schema }; - } - function streamErr(codes, schema, options) { - return { ...options, err: true, enc: "stream", codes, schema }; - } - function stream(codes, schema, options) { - return { ...options, enc: "stream", codes, schema }; - } - function sseErr(codes, schema, options) { - return { ...options, err: true, enc: "sse", codes, schema }; - } - function sse(codes, schema, options) { - return { ...options, enc: "sse", codes, schema }; - } - function nilErr(codes, schema, options) { - return { ...options, err: true, enc: "nil", codes, schema }; - } - function nil(codes, schema, options) { - return { ...options, enc: "nil", codes, schema }; - } - function fail(codes) { - return { enc: "fail", codes }; - } - function match(...matchers) { - return async function matchFunc(response, request, options) { - let raw; - let matcher; - for (const match2 of matchers) { - const { codes } = match2; - const ctpattern = "ctype" in match2 ? match2.ctype : DEFAULT_CONTENT_TYPES[match2.enc]; - if (ctpattern && (0, http_js_1.matchResponse)(response, codes, ctpattern)) { - matcher = match2; - break; - } else if (!ctpattern && (0, http_js_1.matchStatusCode)(response, codes)) { - matcher = match2; - break; - } - } - if (!matcher) { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("Unexpected Status or Content-Type", { - response, - request, - body: await response.text().catch(() => "") - }) - }, raw]; - } - const encoding = matcher.enc; - let body = ""; - switch (encoding) { - case "json": - body = await response.text(); - raw = JSON.parse(body); - break; - case "jsonl": - raw = response.body; - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - body = await response.text(); - raw = body; - break; - case "sse": - raw = response.body; - break; - case "nil": - body = await response.text(); - raw = void 0; - break; - case "fail": - body = await response.text(); - raw = body; - break; - default: - encoding; - throw new Error(`Unsupported response type: ${encoding}`); - } - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("API error occurred", { request, response, body }) - }, raw]; - } - const resultKey = matcher.key || options?.resultKey; - let data; - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null, - request$: request, - response$: response, - body$: body - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - [resultKey]: raw - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null - }; - } else { - data = raw; - } - if ("err" in matcher) { - const result = safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }), - raw - ]; - } - }; - } - var headerValRE = /, */; - function unpackHeaders(headers) { - const out = {}; - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - return out; - } - function safeParseResponse(rawValue, fn, errorMessage, httpMeta) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new responsevalidationerror_js_1.ResponseValidationError(errorMessage, { - cause: err, - rawValue, - rawMessage: errorMessage, - ...httpMeta - })); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/primitives.js - var require_primitives = __commonJS({ - "node_modules/@mistralai/mistralai/lib/primitives.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.invariant = invariant; - exports.remap = remap; - exports.combineSignals = combineSignals; - exports.abortSignalAny = abortSignalAny; - exports.compactMap = compactMap; - exports.allRequired = allRequired; - var InvariantError = class extends Error { - constructor(message) { - super(message); - this.name = "InvariantError"; - } - }; - function invariant(condition, message) { - if (!condition) { - throw new InvariantError(message); - } - } - function remap(inp, mappings) { - let out = {}; - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - return out; - } - function combineSignals(...signals) { - const filtered = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } - } - function abortSignalAny(signals) { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - if (signals.length === 1) { - return signals[0] || controller.signal; - } - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - function abort() { - controller.abort(this.reason); - clean(); - } - const signalRefs = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - return result; - } - function compactMap(values) { - const out = {}; - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - return out; - } - function allRequired(v) { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - return v; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/schemas.js - var require_schemas = __commonJS({ - "node_modules/@mistralai/mistralai/lib/schemas.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parse = parse; - exports.safeParse = safeParse; - exports.collectExtraKeys = collectExtraKeys; - var zod_1 = require_zod(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var fp_js_1 = require_fp(); - function parse(rawValue, fn, errorMessage) { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof zod_1.ZodError) { - throw new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } - } - function safeParse(rawValue, fn, errorMessage) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue)); - } - } - function collectExtraKeys(obj, extrasKey, optional) { - return obj.transform((val) => { - const extras = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - extras[key] = v; - delete val[key]; - } - if (optional && Object.keys(extras).length === 0) { - return val; - } - return { ...val, [extrasKey]: extras }; - }); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/security.js - var require_security = __commonJS({ - "node_modules/@mistralai/mistralai/lib/security.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SecurityError = exports.SecurityErrorCode = void 0; - exports.resolveSecurity = resolveSecurity; - exports.resolveGlobalSecurity = resolveGlobalSecurity; - exports.extractSecurity = extractSecurity; - var env_js_1 = require_env(); - var SecurityErrorCode; - (function(SecurityErrorCode2) { - SecurityErrorCode2["Incomplete"] = "incomplete"; - SecurityErrorCode2["UnrecognisedSecurityType"] = "unrecognized_security_type"; - })(SecurityErrorCode || (exports.SecurityErrorCode = SecurityErrorCode = {})); - var SecurityError = class _SecurityError extends Error { - constructor(code, message) { - super(message); - this.code = code; - this.name = "SecurityError"; - } - static incomplete() { - return new _SecurityError(SecurityErrorCode.Incomplete, "Security requirements not met in order to perform the operation"); - } - static unrecognizedType(type) { - return new _SecurityError(SecurityErrorCode.UnrecognisedSecurityType, `Unrecognised security type: ${type}`); - } - }; - exports.SecurityError = SecurityError; - function resolveSecurity(...options) { - const state = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" } - }; - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return typeof o.value === "string" && !!o.value; - } else if (o.type === "oauth2:client_credentials") { - if (typeof o.value == "string") { - return !!o.value; - } - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o.value})`); - } - }); - }); - if (option == null) { - return null; - } - option.forEach((spec) => { - if (spec.value == null) { - return; - } - const { type } = spec; - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec; - throw SecurityError.unrecognizedType(type); - } - }); - return state; - } - function applyBasic(state, spec) { - if (spec.value == null) { - return; - } - state.basic = spec.value; - } - function applyBearer(state, spec) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - if (spec.fieldName !== void 0) { - state.headers[spec.fieldName] = value; - } - } - function resolveGlobalSecurity(security) { - return resolveSecurity([ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey ?? (0, env_js_1.env)().MISTRAL_API_KEY - } - ]); - } - async function extractSecurity(sec) { - if (sec == null) { - return; - } - return typeof sec === "function" ? sec() : sec; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js - var require_codeinterpretertool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CodeInterpreterTool$ = exports.CodeInterpreterTool$outboundSchema = exports.CodeInterpreterTool$inboundSchema = exports.CodeInterpreterToolType$ = exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema = exports.CodeInterpreterToolType = void 0; - exports.codeInterpreterToolToJSON = codeInterpreterToolToJSON; - exports.codeInterpreterToolFromJSON = codeInterpreterToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CodeInterpreterToolType = { - CodeInterpreter: "code_interpreter" - }; - exports.CodeInterpreterToolType$inboundSchema = z.nativeEnum(exports.CodeInterpreterToolType); - exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema; - var CodeInterpreterToolType$; - (function(CodeInterpreterToolType$2) { - CodeInterpreterToolType$2.inboundSchema = exports.CodeInterpreterToolType$inboundSchema; - CodeInterpreterToolType$2.outboundSchema = exports.CodeInterpreterToolType$outboundSchema; - })(CodeInterpreterToolType$ || (exports.CodeInterpreterToolType$ = CodeInterpreterToolType$ = {})); - exports.CodeInterpreterTool$inboundSchema = z.object({ - type: exports.CodeInterpreterToolType$inboundSchema.default("code_interpreter") - }); - exports.CodeInterpreterTool$outboundSchema = z.object({ - type: exports.CodeInterpreterToolType$outboundSchema.default("code_interpreter") - }); - var CodeInterpreterTool$; - (function(CodeInterpreterTool$2) { - CodeInterpreterTool$2.inboundSchema = exports.CodeInterpreterTool$inboundSchema; - CodeInterpreterTool$2.outboundSchema = exports.CodeInterpreterTool$outboundSchema; - })(CodeInterpreterTool$ || (exports.CodeInterpreterTool$ = CodeInterpreterTool$ = {})); - function codeInterpreterToolToJSON(codeInterpreterTool) { - return JSON.stringify(exports.CodeInterpreterTool$outboundSchema.parse(codeInterpreterTool)); - } - function codeInterpreterToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CodeInterpreterTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CodeInterpreterTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargsstop.js - var require_completionargsstop = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargsstop.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgsStop$ = exports.CompletionArgsStop$outboundSchema = exports.CompletionArgsStop$inboundSchema = void 0; - exports.completionArgsStopToJSON = completionArgsStopToJSON; - exports.completionArgsStopFromJSON = completionArgsStopFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CompletionArgsStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.CompletionArgsStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var CompletionArgsStop$; - (function(CompletionArgsStop$2) { - CompletionArgsStop$2.inboundSchema = exports.CompletionArgsStop$inboundSchema; - CompletionArgsStop$2.outboundSchema = exports.CompletionArgsStop$outboundSchema; - })(CompletionArgsStop$ || (exports.CompletionArgsStop$ = CompletionArgsStop$ = {})); - function completionArgsStopToJSON(completionArgsStop) { - return JSON.stringify(exports.CompletionArgsStop$outboundSchema.parse(completionArgsStop)); - } - function completionArgsStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgsStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgsStop' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/prediction.js - var require_prediction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/prediction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Prediction$ = exports.Prediction$outboundSchema = exports.Prediction$inboundSchema = void 0; - exports.predictionToJSON = predictionToJSON; - exports.predictionFromJSON = predictionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Prediction$inboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - exports.Prediction$outboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - var Prediction$; - (function(Prediction$2) { - Prediction$2.inboundSchema = exports.Prediction$inboundSchema; - Prediction$2.outboundSchema = exports.Prediction$outboundSchema; - })(Prediction$ || (exports.Prediction$ = Prediction$ = {})); - function predictionToJSON(prediction) { - return JSON.stringify(exports.Prediction$outboundSchema.parse(prediction)); - } - function predictionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Prediction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Prediction' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jsonschema.js - var require_jsonschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jsonschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JsonSchema$ = exports.JsonSchema$outboundSchema = exports.JsonSchema$inboundSchema = void 0; - exports.jsonSchemaToJSON = jsonSchemaToJSON; - exports.jsonSchemaFromJSON = jsonSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JsonSchema$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "schema": "schemaDefinition" - }); - }); - exports.JsonSchema$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - schemaDefinition: "schema" - }); - }); - var JsonSchema$; - (function(JsonSchema$2) { - JsonSchema$2.inboundSchema = exports.JsonSchema$inboundSchema; - JsonSchema$2.outboundSchema = exports.JsonSchema$outboundSchema; - })(JsonSchema$ || (exports.JsonSchema$ = JsonSchema$ = {})); - function jsonSchemaToJSON(jsonSchema) { - return JSON.stringify(exports.JsonSchema$outboundSchema.parse(jsonSchema)); - } - function jsonSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JsonSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JsonSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformats.js - var require_responseformats = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformats.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormats$ = exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema = exports.ResponseFormats = void 0; - var z = __importStar(require_zod()); - exports.ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema" - }; - exports.ResponseFormats$inboundSchema = z.nativeEnum(exports.ResponseFormats); - exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema; - var ResponseFormats$; - (function(ResponseFormats$2) { - ResponseFormats$2.inboundSchema = exports.ResponseFormats$inboundSchema; - ResponseFormats$2.outboundSchema = exports.ResponseFormats$outboundSchema; - })(ResponseFormats$ || (exports.ResponseFormats$ = ResponseFormats$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformat.js - var require_responseformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormat$ = exports.ResponseFormat$outboundSchema = exports.ResponseFormat$inboundSchema = void 0; - exports.responseFormatToJSON = responseFormatToJSON; - exports.responseFormatFromJSON = responseFormatFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var jsonschema_js_1 = require_jsonschema(); - var responseformats_js_1 = require_responseformats(); - exports.ResponseFormat$inboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(jsonschema_js_1.JsonSchema$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "json_schema": "jsonSchema" - }); - }); - exports.ResponseFormat$outboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(jsonschema_js_1.JsonSchema$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jsonSchema: "json_schema" - }); - }); - var ResponseFormat$; - (function(ResponseFormat$2) { - ResponseFormat$2.inboundSchema = exports.ResponseFormat$inboundSchema; - ResponseFormat$2.outboundSchema = exports.ResponseFormat$outboundSchema; - })(ResponseFormat$ || (exports.ResponseFormat$ = ResponseFormat$ = {})); - function responseFormatToJSON(responseFormat) { - return JSON.stringify(exports.ResponseFormat$outboundSchema.parse(responseFormat)); - } - function responseFormatFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseFormat$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseFormat' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js - var require_toolchoiceenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoiceEnum$ = exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema = exports.ToolChoiceEnum = void 0; - var z = __importStar(require_zod()); - exports.ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required" - }; - exports.ToolChoiceEnum$inboundSchema = z.nativeEnum(exports.ToolChoiceEnum); - exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema; - var ToolChoiceEnum$; - (function(ToolChoiceEnum$2) { - ToolChoiceEnum$2.inboundSchema = exports.ToolChoiceEnum$inboundSchema; - ToolChoiceEnum$2.outboundSchema = exports.ToolChoiceEnum$outboundSchema; - })(ToolChoiceEnum$ || (exports.ToolChoiceEnum$ = ToolChoiceEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargs.js - var require_completionargs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgs$ = exports.CompletionArgs$outboundSchema = exports.CompletionArgs$inboundSchema = void 0; - exports.completionArgsToJSON = completionArgsToJSON; - exports.completionArgsFromJSON = completionArgsFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargsstop_js_1 = require_completionargsstop(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - exports.CompletionArgs$inboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$inboundSchema).optional(), - presence_penalty: z.nullable(z.number()).optional(), - frequency_penalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - top_p: z.nullable(z.number()).optional(), - max_tokens: z.nullable(z.number().int()).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$inboundSchema).optional(), - response_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - tool_choice: toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice" - }); - }); - exports.CompletionArgs$outboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$outboundSchema).optional(), - presencePenalty: z.nullable(z.number()).optional(), - frequencyPenalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - topP: z.nullable(z.number()).optional(), - maxTokens: z.nullable(z.number().int()).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$outboundSchema).optional(), - responseFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - toolChoice: toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice" - }); - }); - var CompletionArgs$; - (function(CompletionArgs$2) { - CompletionArgs$2.inboundSchema = exports.CompletionArgs$inboundSchema; - CompletionArgs$2.outboundSchema = exports.CompletionArgs$outboundSchema; - })(CompletionArgs$ || (exports.CompletionArgs$ = CompletionArgs$ = {})); - function completionArgsToJSON(completionArgs) { - return JSON.stringify(exports.CompletionArgs$outboundSchema.parse(completionArgs)); - } - function completionArgsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js - var require_documentlibrarytool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentLibraryTool$ = exports.DocumentLibraryTool$outboundSchema = exports.DocumentLibraryTool$inboundSchema = exports.DocumentLibraryToolType$ = exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema = exports.DocumentLibraryToolType = void 0; - exports.documentLibraryToolToJSON = documentLibraryToolToJSON; - exports.documentLibraryToolFromJSON = documentLibraryToolFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentLibraryToolType = { - DocumentLibrary: "document_library" - }; - exports.DocumentLibraryToolType$inboundSchema = z.nativeEnum(exports.DocumentLibraryToolType); - exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema; - var DocumentLibraryToolType$; - (function(DocumentLibraryToolType$2) { - DocumentLibraryToolType$2.inboundSchema = exports.DocumentLibraryToolType$inboundSchema; - DocumentLibraryToolType$2.outboundSchema = exports.DocumentLibraryToolType$outboundSchema; - })(DocumentLibraryToolType$ || (exports.DocumentLibraryToolType$ = DocumentLibraryToolType$ = {})); - exports.DocumentLibraryTool$inboundSchema = z.object({ - type: exports.DocumentLibraryToolType$inboundSchema.default("document_library"), - library_ids: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_ids": "libraryIds" - }); - }); - exports.DocumentLibraryTool$outboundSchema = z.object({ - type: exports.DocumentLibraryToolType$outboundSchema.default("document_library"), - libraryIds: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryIds: "library_ids" - }); - }); - var DocumentLibraryTool$; - (function(DocumentLibraryTool$2) { - DocumentLibraryTool$2.inboundSchema = exports.DocumentLibraryTool$inboundSchema; - DocumentLibraryTool$2.outboundSchema = exports.DocumentLibraryTool$outboundSchema; - })(DocumentLibraryTool$ || (exports.DocumentLibraryTool$ = DocumentLibraryTool$ = {})); - function documentLibraryToolToJSON(documentLibraryTool) { - return JSON.stringify(exports.DocumentLibraryTool$outboundSchema.parse(documentLibraryTool)); - } - function documentLibraryToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentLibraryTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentLibraryTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/function.js - var require_function = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/function.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionT$ = exports.FunctionT$outboundSchema = exports.FunctionT$inboundSchema = void 0; - exports.functionToJSON = functionToJSON; - exports.functionFromJSON = functionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionT$inboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - exports.FunctionT$outboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - var FunctionT$; - (function(FunctionT$2) { - FunctionT$2.inboundSchema = exports.FunctionT$inboundSchema; - FunctionT$2.outboundSchema = exports.FunctionT$outboundSchema; - })(FunctionT$ || (exports.FunctionT$ = FunctionT$ = {})); - function functionToJSON(functionT) { - return JSON.stringify(exports.FunctionT$outboundSchema.parse(functionT)); - } - function functionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functiontool.js - var require_functiontool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functiontool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionTool$ = exports.FunctionTool$outboundSchema = exports.FunctionTool$inboundSchema = exports.FunctionToolType$ = exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema = exports.FunctionToolType = void 0; - exports.functionToolToJSON = functionToolToJSON; - exports.functionToolFromJSON = functionToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - exports.FunctionToolType = { - Function: "function" - }; - exports.FunctionToolType$inboundSchema = z.nativeEnum(exports.FunctionToolType); - exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema; - var FunctionToolType$; - (function(FunctionToolType$2) { - FunctionToolType$2.inboundSchema = exports.FunctionToolType$inboundSchema; - FunctionToolType$2.outboundSchema = exports.FunctionToolType$outboundSchema; - })(FunctionToolType$ || (exports.FunctionToolType$ = FunctionToolType$ = {})); - exports.FunctionTool$inboundSchema = z.object({ - type: exports.FunctionToolType$inboundSchema.default("function"), - function: function_js_1.FunctionT$inboundSchema - }); - exports.FunctionTool$outboundSchema = z.object({ - type: exports.FunctionToolType$outboundSchema.default("function"), - function: function_js_1.FunctionT$outboundSchema - }); - var FunctionTool$; - (function(FunctionTool$2) { - FunctionTool$2.inboundSchema = exports.FunctionTool$inboundSchema; - FunctionTool$2.outboundSchema = exports.FunctionTool$outboundSchema; - })(FunctionTool$ || (exports.FunctionTool$ = FunctionTool$ = {})); - function functionToolToJSON(functionTool) { - return JSON.stringify(exports.FunctionTool$outboundSchema.parse(functionTool)); - } - function functionToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js - var require_imagegenerationtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageGenerationTool$ = exports.ImageGenerationTool$outboundSchema = exports.ImageGenerationTool$inboundSchema = exports.ImageGenerationToolType$ = exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema = exports.ImageGenerationToolType = void 0; - exports.imageGenerationToolToJSON = imageGenerationToolToJSON; - exports.imageGenerationToolFromJSON = imageGenerationToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageGenerationToolType = { - ImageGeneration: "image_generation" - }; - exports.ImageGenerationToolType$inboundSchema = z.nativeEnum(exports.ImageGenerationToolType); - exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema; - var ImageGenerationToolType$; - (function(ImageGenerationToolType$2) { - ImageGenerationToolType$2.inboundSchema = exports.ImageGenerationToolType$inboundSchema; - ImageGenerationToolType$2.outboundSchema = exports.ImageGenerationToolType$outboundSchema; - })(ImageGenerationToolType$ || (exports.ImageGenerationToolType$ = ImageGenerationToolType$ = {})); - exports.ImageGenerationTool$inboundSchema = z.object({ - type: exports.ImageGenerationToolType$inboundSchema.default("image_generation") - }); - exports.ImageGenerationTool$outboundSchema = z.object({ - type: exports.ImageGenerationToolType$outboundSchema.default("image_generation") - }); - var ImageGenerationTool$; - (function(ImageGenerationTool$2) { - ImageGenerationTool$2.inboundSchema = exports.ImageGenerationTool$inboundSchema; - ImageGenerationTool$2.outboundSchema = exports.ImageGenerationTool$outboundSchema; - })(ImageGenerationTool$ || (exports.ImageGenerationTool$ = ImageGenerationTool$ = {})); - function imageGenerationToolToJSON(imageGenerationTool) { - return JSON.stringify(exports.ImageGenerationTool$outboundSchema.parse(imageGenerationTool)); - } - function imageGenerationToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageGenerationTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageGenerationTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js - var require_websearchpremiumtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchPremiumTool$ = exports.WebSearchPremiumTool$outboundSchema = exports.WebSearchPremiumTool$inboundSchema = exports.WebSearchPremiumToolType$ = exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema = exports.WebSearchPremiumToolType = void 0; - exports.webSearchPremiumToolToJSON = webSearchPremiumToolToJSON; - exports.webSearchPremiumToolFromJSON = webSearchPremiumToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchPremiumToolType = { - WebSearchPremium: "web_search_premium" - }; - exports.WebSearchPremiumToolType$inboundSchema = z.nativeEnum(exports.WebSearchPremiumToolType); - exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - var WebSearchPremiumToolType$; - (function(WebSearchPremiumToolType$2) { - WebSearchPremiumToolType$2.inboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - WebSearchPremiumToolType$2.outboundSchema = exports.WebSearchPremiumToolType$outboundSchema; - })(WebSearchPremiumToolType$ || (exports.WebSearchPremiumToolType$ = WebSearchPremiumToolType$ = {})); - exports.WebSearchPremiumTool$inboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$inboundSchema.default("web_search_premium") - }); - exports.WebSearchPremiumTool$outboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$outboundSchema.default("web_search_premium") - }); - var WebSearchPremiumTool$; - (function(WebSearchPremiumTool$2) { - WebSearchPremiumTool$2.inboundSchema = exports.WebSearchPremiumTool$inboundSchema; - WebSearchPremiumTool$2.outboundSchema = exports.WebSearchPremiumTool$outboundSchema; - })(WebSearchPremiumTool$ || (exports.WebSearchPremiumTool$ = WebSearchPremiumTool$ = {})); - function webSearchPremiumToolToJSON(webSearchPremiumTool) { - return JSON.stringify(exports.WebSearchPremiumTool$outboundSchema.parse(webSearchPremiumTool)); - } - function webSearchPremiumToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchPremiumTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchPremiumTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchtool.js - var require_websearchtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchTool$ = exports.WebSearchTool$outboundSchema = exports.WebSearchTool$inboundSchema = exports.WebSearchToolType$ = exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema = exports.WebSearchToolType = void 0; - exports.webSearchToolToJSON = webSearchToolToJSON; - exports.webSearchToolFromJSON = webSearchToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchToolType = { - WebSearch: "web_search" - }; - exports.WebSearchToolType$inboundSchema = z.nativeEnum(exports.WebSearchToolType); - exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema; - var WebSearchToolType$; - (function(WebSearchToolType$2) { - WebSearchToolType$2.inboundSchema = exports.WebSearchToolType$inboundSchema; - WebSearchToolType$2.outboundSchema = exports.WebSearchToolType$outboundSchema; - })(WebSearchToolType$ || (exports.WebSearchToolType$ = WebSearchToolType$ = {})); - exports.WebSearchTool$inboundSchema = z.object({ - type: exports.WebSearchToolType$inboundSchema.default("web_search") - }); - exports.WebSearchTool$outboundSchema = z.object({ - type: exports.WebSearchToolType$outboundSchema.default("web_search") - }); - var WebSearchTool$; - (function(WebSearchTool$2) { - WebSearchTool$2.inboundSchema = exports.WebSearchTool$inboundSchema; - WebSearchTool$2.outboundSchema = exports.WebSearchTool$outboundSchema; - })(WebSearchTool$ || (exports.WebSearchTool$ = WebSearchTool$ = {})); - function webSearchToolToJSON(webSearchTool) { - return JSON.stringify(exports.WebSearchTool$outboundSchema.parse(webSearchTool)); - } - function webSearchToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agent.js - var require_agent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agent$ = exports.Agent$outboundSchema = exports.Agent$inboundSchema = exports.AgentObject$ = exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema = exports.AgentTools$ = exports.AgentTools$outboundSchema = exports.AgentTools$inboundSchema = exports.AgentObject = void 0; - exports.agentToolsToJSON = agentToolsToJSON; - exports.agentToolsFromJSON = agentToolsFromJSON; - exports.agentToJSON = agentToJSON; - exports.agentFromJSON = agentFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentObject = { - Agent: "agent" - }; - exports.AgentTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentTools$; - (function(AgentTools$2) { - AgentTools$2.inboundSchema = exports.AgentTools$inboundSchema; - AgentTools$2.outboundSchema = exports.AgentTools$outboundSchema; - })(AgentTools$ || (exports.AgentTools$ = AgentTools$ = {})); - function agentToolsToJSON(agentTools) { - return JSON.stringify(exports.AgentTools$outboundSchema.parse(agentTools)); - } - function agentToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentTools' from JSON`); - } - exports.AgentObject$inboundSchema = z.nativeEnum(exports.AgentObject); - exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema; - var AgentObject$; - (function(AgentObject$2) { - AgentObject$2.inboundSchema = exports.AgentObject$inboundSchema; - AgentObject$2.outboundSchema = exports.AgentObject$outboundSchema; - })(AgentObject$ || (exports.AgentObject$ = AgentObject$ = {})); - exports.Agent$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$inboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.Agent$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$outboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var Agent$; - (function(Agent$2) { - Agent$2.inboundSchema = exports.Agent$inboundSchema; - Agent$2.outboundSchema = exports.Agent$outboundSchema; - })(Agent$ || (exports.Agent$ = Agent$ = {})); - function agentToJSON(agent) { - return JSON.stringify(exports.Agent$outboundSchema.parse(agent)); - } - function agentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Agent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Agent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentconversation.js - var require_agentconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentConversation$ = exports.AgentConversation$outboundSchema = exports.AgentConversation$inboundSchema = exports.AgentConversationObject$ = exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema = exports.AgentConversationObject = void 0; - exports.agentConversationToJSON = agentConversationToJSON; - exports.agentConversationFromJSON = agentConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentConversationObject = { - Conversation: "conversation" - }; - exports.AgentConversationObject$inboundSchema = z.nativeEnum(exports.AgentConversationObject); - exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema; - var AgentConversationObject$; - (function(AgentConversationObject$2) { - AgentConversationObject$2.inboundSchema = exports.AgentConversationObject$inboundSchema; - AgentConversationObject$2.outboundSchema = exports.AgentConversationObject$outboundSchema; - })(AgentConversationObject$ || (exports.AgentConversationObject$ = AgentConversationObject$ = {})); - exports.AgentConversation$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "agent_id": "agentId" - }); - }); - exports.AgentConversation$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - agentId: "agent_id" - }); - }); - var AgentConversation$; - (function(AgentConversation$2) { - AgentConversation$2.inboundSchema = exports.AgentConversation$inboundSchema; - AgentConversation$2.outboundSchema = exports.AgentConversation$outboundSchema; - })(AgentConversation$ || (exports.AgentConversation$ = AgentConversation$ = {})); - function agentConversationToJSON(agentConversation) { - return JSON.stringify(exports.AgentConversation$outboundSchema.parse(agentConversation)); - } - function agentConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js - var require_agentcreationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentCreationRequest$ = exports.AgentCreationRequest$outboundSchema = exports.AgentCreationRequest$inboundSchema = exports.AgentCreationRequestTools$ = exports.AgentCreationRequestTools$outboundSchema = exports.AgentCreationRequestTools$inboundSchema = void 0; - exports.agentCreationRequestToolsToJSON = agentCreationRequestToolsToJSON; - exports.agentCreationRequestToolsFromJSON = agentCreationRequestToolsFromJSON; - exports.agentCreationRequestToJSON = agentCreationRequestToJSON; - exports.agentCreationRequestFromJSON = agentCreationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentCreationRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentCreationRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentCreationRequestTools$; - (function(AgentCreationRequestTools$2) { - AgentCreationRequestTools$2.inboundSchema = exports.AgentCreationRequestTools$inboundSchema; - AgentCreationRequestTools$2.outboundSchema = exports.AgentCreationRequestTools$outboundSchema; - })(AgentCreationRequestTools$ || (exports.AgentCreationRequestTools$ = AgentCreationRequestTools$ = {})); - function agentCreationRequestToolsToJSON(agentCreationRequestTools) { - return JSON.stringify(exports.AgentCreationRequestTools$outboundSchema.parse(agentCreationRequestTools)); - } - function agentCreationRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequestTools' from JSON`); - } - exports.AgentCreationRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentCreationRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentCreationRequest$; - (function(AgentCreationRequest$2) { - AgentCreationRequest$2.inboundSchema = exports.AgentCreationRequest$inboundSchema; - AgentCreationRequest$2.outboundSchema = exports.AgentCreationRequest$outboundSchema; - })(AgentCreationRequest$ || (exports.AgentCreationRequest$ = AgentCreationRequest$ = {})); - function agentCreationRequestToJSON(agentCreationRequest) { - return JSON.stringify(exports.AgentCreationRequest$outboundSchema.parse(agentCreationRequest)); - } - function agentCreationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js - var require_agenthandoffdoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffDoneEvent$ = exports.AgentHandoffDoneEvent$outboundSchema = exports.AgentHandoffDoneEvent$inboundSchema = exports.AgentHandoffDoneEventType$ = exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema = exports.AgentHandoffDoneEventType = void 0; - exports.agentHandoffDoneEventToJSON = agentHandoffDoneEventToJSON; - exports.agentHandoffDoneEventFromJSON = agentHandoffDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffDoneEventType = { - AgentHandoffDone: "agent.handoff.done" - }; - exports.AgentHandoffDoneEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffDoneEventType); - exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - var AgentHandoffDoneEventType$; - (function(AgentHandoffDoneEventType$2) { - AgentHandoffDoneEventType$2.inboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - AgentHandoffDoneEventType$2.outboundSchema = exports.AgentHandoffDoneEventType$outboundSchema; - })(AgentHandoffDoneEventType$ || (exports.AgentHandoffDoneEventType$ = AgentHandoffDoneEventType$ = {})); - exports.AgentHandoffDoneEvent$inboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$inboundSchema.default("agent.handoff.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffDoneEvent$outboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$outboundSchema.default("agent.handoff.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffDoneEvent$; - (function(AgentHandoffDoneEvent$2) { - AgentHandoffDoneEvent$2.inboundSchema = exports.AgentHandoffDoneEvent$inboundSchema; - AgentHandoffDoneEvent$2.outboundSchema = exports.AgentHandoffDoneEvent$outboundSchema; - })(AgentHandoffDoneEvent$ || (exports.AgentHandoffDoneEvent$ = AgentHandoffDoneEvent$ = {})); - function agentHandoffDoneEventToJSON(agentHandoffDoneEvent) { - return JSON.stringify(exports.AgentHandoffDoneEvent$outboundSchema.parse(agentHandoffDoneEvent)); - } - function agentHandoffDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js - var require_agenthandoffentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffEntry$ = exports.AgentHandoffEntry$outboundSchema = exports.AgentHandoffEntry$inboundSchema = exports.AgentHandoffEntryType$ = exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema = exports.AgentHandoffEntryObject$ = exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema = exports.AgentHandoffEntryType = exports.AgentHandoffEntryObject = void 0; - exports.agentHandoffEntryToJSON = agentHandoffEntryToJSON; - exports.agentHandoffEntryFromJSON = agentHandoffEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffEntryObject = { - Entry: "entry" - }; - exports.AgentHandoffEntryType = { - AgentHandoff: "agent.handoff" - }; - exports.AgentHandoffEntryObject$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryObject); - exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - var AgentHandoffEntryObject$; - (function(AgentHandoffEntryObject$2) { - AgentHandoffEntryObject$2.inboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - AgentHandoffEntryObject$2.outboundSchema = exports.AgentHandoffEntryObject$outboundSchema; - })(AgentHandoffEntryObject$ || (exports.AgentHandoffEntryObject$ = AgentHandoffEntryObject$ = {})); - exports.AgentHandoffEntryType$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryType); - exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema; - var AgentHandoffEntryType$; - (function(AgentHandoffEntryType$2) { - AgentHandoffEntryType$2.inboundSchema = exports.AgentHandoffEntryType$inboundSchema; - AgentHandoffEntryType$2.outboundSchema = exports.AgentHandoffEntryType$outboundSchema; - })(AgentHandoffEntryType$ || (exports.AgentHandoffEntryType$ = AgentHandoffEntryType$ = {})); - exports.AgentHandoffEntry$inboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$inboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$inboundSchema.default("agent.handoff"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - previous_agent_id: z.string(), - previous_agent_name: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffEntry$outboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$outboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$outboundSchema.default("agent.handoff"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - previousAgentId: z.string(), - previousAgentName: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffEntry$; - (function(AgentHandoffEntry$2) { - AgentHandoffEntry$2.inboundSchema = exports.AgentHandoffEntry$inboundSchema; - AgentHandoffEntry$2.outboundSchema = exports.AgentHandoffEntry$outboundSchema; - })(AgentHandoffEntry$ || (exports.AgentHandoffEntry$ = AgentHandoffEntry$ = {})); - function agentHandoffEntryToJSON(agentHandoffEntry) { - return JSON.stringify(exports.AgentHandoffEntry$outboundSchema.parse(agentHandoffEntry)); - } - function agentHandoffEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js - var require_agenthandoffstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffStartedEvent$ = exports.AgentHandoffStartedEvent$outboundSchema = exports.AgentHandoffStartedEvent$inboundSchema = exports.AgentHandoffStartedEventType$ = exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema = exports.AgentHandoffStartedEventType = void 0; - exports.agentHandoffStartedEventToJSON = agentHandoffStartedEventToJSON; - exports.agentHandoffStartedEventFromJSON = agentHandoffStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffStartedEventType = { - AgentHandoffStarted: "agent.handoff.started" - }; - exports.AgentHandoffStartedEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffStartedEventType); - exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - var AgentHandoffStartedEventType$; - (function(AgentHandoffStartedEventType$2) { - AgentHandoffStartedEventType$2.inboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - AgentHandoffStartedEventType$2.outboundSchema = exports.AgentHandoffStartedEventType$outboundSchema; - })(AgentHandoffStartedEventType$ || (exports.AgentHandoffStartedEventType$ = AgentHandoffStartedEventType$ = {})); - exports.AgentHandoffStartedEvent$inboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$inboundSchema.default("agent.handoff.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - previous_agent_id: z.string(), - previous_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName" - }); - }); - exports.AgentHandoffStartedEvent$outboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$outboundSchema.default("agent.handoff.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - previousAgentId: z.string(), - previousAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name" - }); - }); - var AgentHandoffStartedEvent$; - (function(AgentHandoffStartedEvent$2) { - AgentHandoffStartedEvent$2.inboundSchema = exports.AgentHandoffStartedEvent$inboundSchema; - AgentHandoffStartedEvent$2.outboundSchema = exports.AgentHandoffStartedEvent$outboundSchema; - })(AgentHandoffStartedEvent$ || (exports.AgentHandoffStartedEvent$ = AgentHandoffStartedEvent$ = {})); - function agentHandoffStartedEventToJSON(agentHandoffStartedEvent) { - return JSON.stringify(exports.AgentHandoffStartedEvent$outboundSchema.parse(agentHandoffStartedEvent)); - } - function agentHandoffStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiochunk.js - var require_audiochunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiochunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioChunk$ = exports.AudioChunk$outboundSchema = exports.AudioChunk$inboundSchema = exports.AudioChunkType$ = exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema = exports.AudioChunkType = void 0; - exports.audioChunkToJSON = audioChunkToJSON; - exports.audioChunkFromJSON = audioChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AudioChunkType = { - InputAudio: "input_audio" - }; - exports.AudioChunkType$inboundSchema = z.nativeEnum(exports.AudioChunkType); - exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema; - var AudioChunkType$; - (function(AudioChunkType$2) { - AudioChunkType$2.inboundSchema = exports.AudioChunkType$inboundSchema; - AudioChunkType$2.outboundSchema = exports.AudioChunkType$outboundSchema; - })(AudioChunkType$ || (exports.AudioChunkType$ = AudioChunkType$ = {})); - exports.AudioChunk$inboundSchema = z.object({ - input_audio: z.string(), - type: exports.AudioChunkType$inboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_audio": "inputAudio" - }); - }); - exports.AudioChunk$outboundSchema = z.object({ - inputAudio: z.string(), - type: exports.AudioChunkType$outboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputAudio: "input_audio" - }); - }); - var AudioChunk$; - (function(AudioChunk$2) { - AudioChunk$2.inboundSchema = exports.AudioChunk$inboundSchema; - AudioChunk$2.outboundSchema = exports.AudioChunk$outboundSchema; - })(AudioChunk$ || (exports.AudioChunk$ = AudioChunk$ = {})); - function audioChunkToJSON(audioChunk) { - return JSON.stringify(exports.AudioChunk$outboundSchema.parse(audioChunk)); - } - function audioChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenturlchunk.js - var require_documenturlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenturlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentURLChunk$ = exports.DocumentURLChunk$outboundSchema = exports.DocumentURLChunk$inboundSchema = exports.DocumentURLChunkType$ = exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema = exports.DocumentURLChunkType = void 0; - exports.documentURLChunkToJSON = documentURLChunkToJSON; - exports.documentURLChunkFromJSON = documentURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentURLChunkType = { - DocumentUrl: "document_url" - }; - exports.DocumentURLChunkType$inboundSchema = z.nativeEnum(exports.DocumentURLChunkType); - exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema; - var DocumentURLChunkType$; - (function(DocumentURLChunkType$2) { - DocumentURLChunkType$2.inboundSchema = exports.DocumentURLChunkType$inboundSchema; - DocumentURLChunkType$2.outboundSchema = exports.DocumentURLChunkType$outboundSchema; - })(DocumentURLChunkType$ || (exports.DocumentURLChunkType$ = DocumentURLChunkType$ = {})); - exports.DocumentURLChunk$inboundSchema = z.object({ - document_url: z.string(), - document_name: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$inboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_url": "documentUrl", - "document_name": "documentName" - }); - }); - exports.DocumentURLChunk$outboundSchema = z.object({ - documentUrl: z.string(), - documentName: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$outboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentUrl: "document_url", - documentName: "document_name" - }); - }); - var DocumentURLChunk$; - (function(DocumentURLChunk$2) { - DocumentURLChunk$2.inboundSchema = exports.DocumentURLChunk$inboundSchema; - DocumentURLChunk$2.outboundSchema = exports.DocumentURLChunk$outboundSchema; - })(DocumentURLChunk$ || (exports.DocumentURLChunk$ = DocumentURLChunk$ = {})); - function documentURLChunkToJSON(documentURLChunk) { - return JSON.stringify(exports.DocumentURLChunk$outboundSchema.parse(documentURLChunk)); - } - function documentURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filechunk.js - var require_filechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileChunk$ = exports.FileChunk$outboundSchema = exports.FileChunk$inboundSchema = void 0; - exports.fileChunkToJSON = fileChunkToJSON; - exports.fileChunkFromJSON = fileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FileChunk$inboundSchema = z.object({ - type: z.literal("file").default("file"), - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FileChunk$outboundSchema = z.object({ - type: z.literal("file").default("file"), - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FileChunk$; - (function(FileChunk$2) { - FileChunk$2.inboundSchema = exports.FileChunk$inboundSchema; - FileChunk$2.outboundSchema = exports.FileChunk$outboundSchema; - })(FileChunk$ || (exports.FileChunk$ = FileChunk$ = {})); - function fileChunkToJSON(fileChunk) { - return JSON.stringify(exports.FileChunk$outboundSchema.parse(fileChunk)); - } - function fileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurl.js - var require_imageurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURL$ = exports.ImageURL$outboundSchema = exports.ImageURL$inboundSchema = void 0; - exports.imageURLToJSON = imageURLToJSON; - exports.imageURLFromJSON = imageURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageURL$inboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - exports.ImageURL$outboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - var ImageURL$; - (function(ImageURL$2) { - ImageURL$2.inboundSchema = exports.ImageURL$inboundSchema; - ImageURL$2.outboundSchema = exports.ImageURL$outboundSchema; - })(ImageURL$ || (exports.ImageURL$ = ImageURL$ = {})); - function imageURLToJSON(imageURL) { - return JSON.stringify(exports.ImageURL$outboundSchema.parse(imageURL)); - } - function imageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurlchunk.js - var require_imageurlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURLChunk$ = exports.ImageURLChunk$outboundSchema = exports.ImageURLChunk$inboundSchema = exports.ImageURLChunkType$ = exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema = exports.ImageURLChunkImageURL$ = exports.ImageURLChunkImageURL$outboundSchema = exports.ImageURLChunkImageURL$inboundSchema = exports.ImageURLChunkType = void 0; - exports.imageURLChunkImageURLToJSON = imageURLChunkImageURLToJSON; - exports.imageURLChunkImageURLFromJSON = imageURLChunkImageURLFromJSON; - exports.imageURLChunkToJSON = imageURLChunkToJSON; - exports.imageURLChunkFromJSON = imageURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var imageurl_js_1 = require_imageurl(); - exports.ImageURLChunkType = { - ImageUrl: "image_url" - }; - exports.ImageURLChunkImageURL$inboundSchema = z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]); - exports.ImageURLChunkImageURL$outboundSchema = z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]); - var ImageURLChunkImageURL$; - (function(ImageURLChunkImageURL$2) { - ImageURLChunkImageURL$2.inboundSchema = exports.ImageURLChunkImageURL$inboundSchema; - ImageURLChunkImageURL$2.outboundSchema = exports.ImageURLChunkImageURL$outboundSchema; - })(ImageURLChunkImageURL$ || (exports.ImageURLChunkImageURL$ = ImageURLChunkImageURL$ = {})); - function imageURLChunkImageURLToJSON(imageURLChunkImageURL) { - return JSON.stringify(exports.ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL)); - } - function imageURLChunkImageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunkImageURL' from JSON`); - } - exports.ImageURLChunkType$inboundSchema = z.nativeEnum(exports.ImageURLChunkType); - exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema; - var ImageURLChunkType$; - (function(ImageURLChunkType$2) { - ImageURLChunkType$2.inboundSchema = exports.ImageURLChunkType$inboundSchema; - ImageURLChunkType$2.outboundSchema = exports.ImageURLChunkType$outboundSchema; - })(ImageURLChunkType$ || (exports.ImageURLChunkType$ = ImageURLChunkType$ = {})); - exports.ImageURLChunk$inboundSchema = z.object({ - image_url: z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]), - type: exports.ImageURLChunkType$inboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "image_url": "imageUrl" - }); - }); - exports.ImageURLChunk$outboundSchema = z.object({ - imageUrl: z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]), - type: exports.ImageURLChunkType$outboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - imageUrl: "image_url" - }); - }); - var ImageURLChunk$; - (function(ImageURLChunk$2) { - ImageURLChunk$2.inboundSchema = exports.ImageURLChunk$inboundSchema; - ImageURLChunk$2.outboundSchema = exports.ImageURLChunk$outboundSchema; - })(ImageURLChunk$ || (exports.ImageURLChunk$ = ImageURLChunk$ = {})); - function imageURLChunkToJSON(imageURLChunk) { - return JSON.stringify(exports.ImageURLChunk$outboundSchema.parse(imageURLChunk)); - } - function imageURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/referencechunk.js - var require_referencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/referencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ReferenceChunk$ = exports.ReferenceChunk$outboundSchema = exports.ReferenceChunk$inboundSchema = exports.ReferenceChunkType$ = exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema = exports.ReferenceChunkType = void 0; - exports.referenceChunkToJSON = referenceChunkToJSON; - exports.referenceChunkFromJSON = referenceChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ReferenceChunkType = { - Reference: "reference" - }; - exports.ReferenceChunkType$inboundSchema = z.nativeEnum(exports.ReferenceChunkType); - exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema; - var ReferenceChunkType$; - (function(ReferenceChunkType$2) { - ReferenceChunkType$2.inboundSchema = exports.ReferenceChunkType$inboundSchema; - ReferenceChunkType$2.outboundSchema = exports.ReferenceChunkType$outboundSchema; - })(ReferenceChunkType$ || (exports.ReferenceChunkType$ = ReferenceChunkType$ = {})); - exports.ReferenceChunk$inboundSchema = z.object({ - reference_ids: z.array(z.number().int()), - type: exports.ReferenceChunkType$inboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "reference_ids": "referenceIds" - }); - }); - exports.ReferenceChunk$outboundSchema = z.object({ - referenceIds: z.array(z.number().int()), - type: exports.ReferenceChunkType$outboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - referenceIds: "reference_ids" - }); - }); - var ReferenceChunk$; - (function(ReferenceChunk$2) { - ReferenceChunk$2.inboundSchema = exports.ReferenceChunk$inboundSchema; - ReferenceChunk$2.outboundSchema = exports.ReferenceChunk$outboundSchema; - })(ReferenceChunk$ || (exports.ReferenceChunk$ = ReferenceChunk$ = {})); - function referenceChunkToJSON(referenceChunk) { - return JSON.stringify(exports.ReferenceChunk$outboundSchema.parse(referenceChunk)); - } - function referenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/textchunk.js - var require_textchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/textchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TextChunk$ = exports.TextChunk$outboundSchema = exports.TextChunk$inboundSchema = exports.TextChunkType$ = exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema = exports.TextChunkType = void 0; - exports.textChunkToJSON = textChunkToJSON; - exports.textChunkFromJSON = textChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.TextChunkType = { - Text: "text" - }; - exports.TextChunkType$inboundSchema = z.nativeEnum(exports.TextChunkType); - exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema; - var TextChunkType$; - (function(TextChunkType$2) { - TextChunkType$2.inboundSchema = exports.TextChunkType$inboundSchema; - TextChunkType$2.outboundSchema = exports.TextChunkType$outboundSchema; - })(TextChunkType$ || (exports.TextChunkType$ = TextChunkType$ = {})); - exports.TextChunk$inboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$inboundSchema.default("text") - }); - exports.TextChunk$outboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$outboundSchema.default("text") - }); - var TextChunk$; - (function(TextChunk$2) { - TextChunk$2.inboundSchema = exports.TextChunk$inboundSchema; - TextChunk$2.outboundSchema = exports.TextChunk$outboundSchema; - })(TextChunk$ || (exports.TextChunk$ = TextChunk$ = {})); - function textChunkToJSON(textChunk) { - return JSON.stringify(exports.TextChunk$outboundSchema.parse(textChunk)); - } - function textChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TextChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TextChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/thinkchunk.js - var require_thinkchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/thinkchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ThinkChunk$ = exports.ThinkChunk$outboundSchema = exports.ThinkChunk$inboundSchema = exports.ThinkChunkType$ = exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema = exports.Thinking$ = exports.Thinking$outboundSchema = exports.Thinking$inboundSchema = exports.ThinkChunkType = void 0; - exports.thinkingToJSON = thinkingToJSON; - exports.thinkingFromJSON = thinkingFromJSON; - exports.thinkChunkToJSON = thinkChunkToJSON; - exports.thinkChunkFromJSON = thinkChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - exports.ThinkChunkType = { - Thinking: "thinking" - }; - exports.Thinking$inboundSchema = z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema]); - exports.Thinking$outboundSchema = z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema]); - var Thinking$; - (function(Thinking$2) { - Thinking$2.inboundSchema = exports.Thinking$inboundSchema; - Thinking$2.outboundSchema = exports.Thinking$outboundSchema; - })(Thinking$ || (exports.Thinking$ = Thinking$ = {})); - function thinkingToJSON(thinking) { - return JSON.stringify(exports.Thinking$outboundSchema.parse(thinking)); - } - function thinkingFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Thinking$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Thinking' from JSON`); - } - exports.ThinkChunkType$inboundSchema = z.nativeEnum(exports.ThinkChunkType); - exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema; - var ThinkChunkType$; - (function(ThinkChunkType$2) { - ThinkChunkType$2.inboundSchema = exports.ThinkChunkType$inboundSchema; - ThinkChunkType$2.outboundSchema = exports.ThinkChunkType$outboundSchema; - })(ThinkChunkType$ || (exports.ThinkChunkType$ = ThinkChunkType$ = {})); - exports.ThinkChunk$inboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$inboundSchema.default("thinking") - }); - exports.ThinkChunk$outboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$outboundSchema.default("thinking") - }); - var ThinkChunk$; - (function(ThinkChunk$2) { - ThinkChunk$2.inboundSchema = exports.ThinkChunk$inboundSchema; - ThinkChunk$2.outboundSchema = exports.ThinkChunk$outboundSchema; - })(ThinkChunk$ || (exports.ThinkChunk$ = ThinkChunk$ = {})); - function thinkChunkToJSON(thinkChunk) { - return JSON.stringify(exports.ThinkChunk$outboundSchema.parse(thinkChunk)); - } - function thinkChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ThinkChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ThinkChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/contentchunk.js - var require_contentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/contentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ContentChunk$ = exports.ContentChunk$outboundSchema = exports.ContentChunk$inboundSchema = void 0; - exports.contentChunkToJSON = contentChunkToJSON; - exports.contentChunkFromJSON = contentChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var audiochunk_js_1 = require_audiochunk(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.ContentChunk$inboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$inboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$inboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$inboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$inboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$inboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ContentChunk$outboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$outboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$outboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$outboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$outboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$outboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - var ContentChunk$; - (function(ContentChunk$2) { - ContentChunk$2.inboundSchema = exports.ContentChunk$inboundSchema; - ContentChunk$2.outboundSchema = exports.ContentChunk$outboundSchema; - })(ContentChunk$ || (exports.ContentChunk$ = ContentChunk$ = {})); - function contentChunkToJSON(contentChunk) { - return JSON.stringify(exports.ContentChunk$outboundSchema.parse(contentChunk)); - } - function contentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ContentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ContentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncall.js - var require_functioncall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCall$ = exports.FunctionCall$outboundSchema = exports.FunctionCall$inboundSchema = exports.Arguments$ = exports.Arguments$outboundSchema = exports.Arguments$inboundSchema = void 0; - exports.argumentsToJSON = argumentsToJSON; - exports.argumentsFromJSON = argumentsFromJSON; - exports.functionCallToJSON = functionCallToJSON; - exports.functionCallFromJSON = functionCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Arguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.Arguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var Arguments$; - (function(Arguments$2) { - Arguments$2.inboundSchema = exports.Arguments$inboundSchema; - Arguments$2.outboundSchema = exports.Arguments$outboundSchema; - })(Arguments$ || (exports.Arguments$ = Arguments$ = {})); - function argumentsToJSON(value) { - return JSON.stringify(exports.Arguments$outboundSchema.parse(value)); - } - function argumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Arguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Arguments' from JSON`); - } - exports.FunctionCall$inboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - exports.FunctionCall$outboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - var FunctionCall$; - (function(FunctionCall$2) { - FunctionCall$2.inboundSchema = exports.FunctionCall$inboundSchema; - FunctionCall$2.outboundSchema = exports.FunctionCall$outboundSchema; - })(FunctionCall$ || (exports.FunctionCall$ = FunctionCall$ = {})); - function functionCallToJSON(functionCall) { - return JSON.stringify(exports.FunctionCall$outboundSchema.parse(functionCall)); - } - function functionCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/enums.js - var require_enums = __commonJS({ - "node_modules/@mistralai/mistralai/types/enums.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.catchUnrecognizedEnum = catchUnrecognizedEnum; - function catchUnrecognizedEnum(value) { - return value; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tooltypes.js - var require_tooltypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tooltypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolTypes$ = exports.ToolTypes$outboundSchema = exports.ToolTypes$inboundSchema = exports.ToolTypes = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ToolTypes = { - Function: "function" - }; - exports.ToolTypes$inboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ToolTypes$outboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().and(z.custom()) - ]); - var ToolTypes$; - (function(ToolTypes$2) { - ToolTypes$2.inboundSchema = exports.ToolTypes$inboundSchema; - ToolTypes$2.outboundSchema = exports.ToolTypes$outboundSchema; - })(ToolTypes$ || (exports.ToolTypes$ = ToolTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolcall.js - var require_toolcall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolcall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolCall$ = exports.ToolCall$outboundSchema = exports.ToolCall$inboundSchema = void 0; - exports.toolCallToJSON = toolCallToJSON; - exports.toolCallFromJSON = toolCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functioncall_js_1 = require_functioncall(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolCall$inboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functioncall_js_1.FunctionCall$inboundSchema, - index: z.number().int().default(0) - }); - exports.ToolCall$outboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functioncall_js_1.FunctionCall$outboundSchema, - index: z.number().int().default(0) - }); - var ToolCall$; - (function(ToolCall$2) { - ToolCall$2.inboundSchema = exports.ToolCall$inboundSchema; - ToolCall$2.outboundSchema = exports.ToolCall$outboundSchema; - })(ToolCall$ || (exports.ToolCall$ = ToolCall$ = {})); - function toolCallToJSON(toolCall) { - return JSON.stringify(exports.ToolCall$outboundSchema.parse(toolCall)); - } - function toolCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/assistantmessage.js - var require_assistantmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/assistantmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AssistantMessage$ = exports.AssistantMessage$outboundSchema = exports.AssistantMessage$inboundSchema = exports.AssistantMessageRole$ = exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema = exports.AssistantMessageContent$ = exports.AssistantMessageContent$outboundSchema = exports.AssistantMessageContent$inboundSchema = exports.AssistantMessageRole = void 0; - exports.assistantMessageContentToJSON = assistantMessageContentToJSON; - exports.assistantMessageContentFromJSON = assistantMessageContentFromJSON; - exports.assistantMessageToJSON = assistantMessageToJSON; - exports.assistantMessageFromJSON = assistantMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.AssistantMessageRole = { - Assistant: "assistant" - }; - exports.AssistantMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.AssistantMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var AssistantMessageContent$; - (function(AssistantMessageContent$2) { - AssistantMessageContent$2.inboundSchema = exports.AssistantMessageContent$inboundSchema; - AssistantMessageContent$2.outboundSchema = exports.AssistantMessageContent$outboundSchema; - })(AssistantMessageContent$ || (exports.AssistantMessageContent$ = AssistantMessageContent$ = {})); - function assistantMessageContentToJSON(assistantMessageContent) { - return JSON.stringify(exports.AssistantMessageContent$outboundSchema.parse(assistantMessageContent)); - } - function assistantMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessageContent' from JSON`); - } - exports.AssistantMessageRole$inboundSchema = z.nativeEnum(exports.AssistantMessageRole); - exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema; - var AssistantMessageRole$; - (function(AssistantMessageRole$2) { - AssistantMessageRole$2.inboundSchema = exports.AssistantMessageRole$inboundSchema; - AssistantMessageRole$2.outboundSchema = exports.AssistantMessageRole$outboundSchema; - })(AssistantMessageRole$ || (exports.AssistantMessageRole$ = AssistantMessageRole$ = {})); - exports.AssistantMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$inboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.AssistantMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$outboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var AssistantMessage$; - (function(AssistantMessage$2) { - AssistantMessage$2.inboundSchema = exports.AssistantMessage$inboundSchema; - AssistantMessage$2.outboundSchema = exports.AssistantMessage$outboundSchema; - })(AssistantMessage$ || (exports.AssistantMessage$ = AssistantMessage$ = {})); - function assistantMessageToJSON(assistantMessage) { - return JSON.stringify(exports.AssistantMessage$outboundSchema.parse(assistantMessage)); - } - function assistantMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js - var require_mistralpromptmode = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralPromptMode$ = exports.MistralPromptMode$outboundSchema = exports.MistralPromptMode$inboundSchema = exports.MistralPromptMode = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.MistralPromptMode = { - Reasoning: "reasoning" - }; - exports.MistralPromptMode$inboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.MistralPromptMode$outboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().and(z.custom()) - ]); - var MistralPromptMode$; - (function(MistralPromptMode$2) { - MistralPromptMode$2.inboundSchema = exports.MistralPromptMode$inboundSchema; - MistralPromptMode$2.outboundSchema = exports.MistralPromptMode$outboundSchema; - })(MistralPromptMode$ || (exports.MistralPromptMode$ = MistralPromptMode$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js - var require_systemmessagecontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessageContentChunks$ = exports.SystemMessageContentChunks$outboundSchema = exports.SystemMessageContentChunks$inboundSchema = void 0; - exports.systemMessageContentChunksToJSON = systemMessageContentChunksToJSON; - exports.systemMessageContentChunksFromJSON = systemMessageContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.SystemMessageContentChunks$inboundSchema = z.union([ - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.SystemMessageContentChunks$outboundSchema = z.union([ - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - var SystemMessageContentChunks$; - (function(SystemMessageContentChunks$2) { - SystemMessageContentChunks$2.inboundSchema = exports.SystemMessageContentChunks$inboundSchema; - SystemMessageContentChunks$2.outboundSchema = exports.SystemMessageContentChunks$outboundSchema; - })(SystemMessageContentChunks$ || (exports.SystemMessageContentChunks$ = SystemMessageContentChunks$ = {})); - function systemMessageContentChunksToJSON(systemMessageContentChunks) { - return JSON.stringify(exports.SystemMessageContentChunks$outboundSchema.parse(systemMessageContentChunks)); - } - function systemMessageContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessage.js - var require_systemmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessage$ = exports.SystemMessage$outboundSchema = exports.SystemMessage$inboundSchema = exports.Role$ = exports.Role$outboundSchema = exports.Role$inboundSchema = exports.SystemMessageContent$ = exports.SystemMessageContent$outboundSchema = exports.SystemMessageContent$inboundSchema = exports.Role = void 0; - exports.systemMessageContentToJSON = systemMessageContentToJSON; - exports.systemMessageContentFromJSON = systemMessageContentFromJSON; - exports.systemMessageToJSON = systemMessageToJSON; - exports.systemMessageFromJSON = systemMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var systemmessagecontentchunks_js_1 = require_systemmessagecontentchunks(); - exports.Role = { - System: "system" - }; - exports.SystemMessageContent$inboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema)]); - exports.SystemMessageContent$outboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema)]); - var SystemMessageContent$; - (function(SystemMessageContent$2) { - SystemMessageContent$2.inboundSchema = exports.SystemMessageContent$inboundSchema; - SystemMessageContent$2.outboundSchema = exports.SystemMessageContent$outboundSchema; - })(SystemMessageContent$ || (exports.SystemMessageContent$ = SystemMessageContent$ = {})); - function systemMessageContentToJSON(systemMessageContent) { - return JSON.stringify(exports.SystemMessageContent$outboundSchema.parse(systemMessageContent)); - } - function systemMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContent' from JSON`); - } - exports.Role$inboundSchema = z.nativeEnum(exports.Role); - exports.Role$outboundSchema = exports.Role$inboundSchema; - var Role$; - (function(Role$2) { - Role$2.inboundSchema = exports.Role$inboundSchema; - Role$2.outboundSchema = exports.Role$outboundSchema; - })(Role$ || (exports.Role$ = Role$ = {})); - exports.SystemMessage$inboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema) - ]), - role: exports.Role$inboundSchema.default("system") - }); - exports.SystemMessage$outboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema) - ]), - role: exports.Role$outboundSchema.default("system") - }); - var SystemMessage$; - (function(SystemMessage$2) { - SystemMessage$2.inboundSchema = exports.SystemMessage$inboundSchema; - SystemMessage$2.outboundSchema = exports.SystemMessage$outboundSchema; - })(SystemMessage$ || (exports.SystemMessage$ = SystemMessage$ = {})); - function systemMessageToJSON(systemMessage) { - return JSON.stringify(exports.SystemMessage$outboundSchema.parse(systemMessage)); - } - function systemMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tool.js - var require_tool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Tool$ = exports.Tool$outboundSchema = exports.Tool$inboundSchema = void 0; - exports.toolToJSON = toolToJSON; - exports.toolFromJSON = toolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - var tooltypes_js_1 = require_tooltypes(); - exports.Tool$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: function_js_1.FunctionT$inboundSchema - }); - exports.Tool$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: function_js_1.FunctionT$outboundSchema - }); - var Tool$; - (function(Tool$2) { - Tool$2.inboundSchema = exports.Tool$inboundSchema; - Tool$2.outboundSchema = exports.Tool$outboundSchema; - })(Tool$ || (exports.Tool$ = Tool$ = {})); - function toolToJSON(tool) { - return JSON.stringify(exports.Tool$outboundSchema.parse(tool)); - } - function toolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionname.js - var require_functionname = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionname.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionName$ = exports.FunctionName$outboundSchema = exports.FunctionName$inboundSchema = void 0; - exports.functionNameToJSON = functionNameToJSON; - exports.functionNameFromJSON = functionNameFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionName$inboundSchema = z.object({ - name: z.string() - }); - exports.FunctionName$outboundSchema = z.object({ - name: z.string() - }); - var FunctionName$; - (function(FunctionName$2) { - FunctionName$2.inboundSchema = exports.FunctionName$inboundSchema; - FunctionName$2.outboundSchema = exports.FunctionName$outboundSchema; - })(FunctionName$ || (exports.FunctionName$ = FunctionName$ = {})); - function functionNameToJSON(functionName) { - return JSON.stringify(exports.FunctionName$outboundSchema.parse(functionName)); - } - function functionNameFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionName$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionName' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoice.js - var require_toolchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoice$ = exports.ToolChoice$outboundSchema = exports.ToolChoice$inboundSchema = void 0; - exports.toolChoiceToJSON = toolChoiceToJSON; - exports.toolChoiceFromJSON = toolChoiceFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functionname_js_1 = require_functionname(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolChoice$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functionname_js_1.FunctionName$inboundSchema - }); - exports.ToolChoice$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functionname_js_1.FunctionName$outboundSchema - }); - var ToolChoice$; - (function(ToolChoice$2) { - ToolChoice$2.inboundSchema = exports.ToolChoice$inboundSchema; - ToolChoice$2.outboundSchema = exports.ToolChoice$outboundSchema; - })(ToolChoice$ || (exports.ToolChoice$ = ToolChoice$ = {})); - function toolChoiceToJSON(toolChoice) { - return JSON.stringify(exports.ToolChoice$outboundSchema.parse(toolChoice)); - } - function toolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolmessage.js - var require_toolmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolMessage$ = exports.ToolMessage$outboundSchema = exports.ToolMessage$inboundSchema = exports.ToolMessageRole$ = exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema = exports.ToolMessageContent$ = exports.ToolMessageContent$outboundSchema = exports.ToolMessageContent$inboundSchema = exports.ToolMessageRole = void 0; - exports.toolMessageContentToJSON = toolMessageContentToJSON; - exports.toolMessageContentFromJSON = toolMessageContentFromJSON; - exports.toolMessageToJSON = toolMessageToJSON; - exports.toolMessageFromJSON = toolMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.ToolMessageRole = { - Tool: "tool" - }; - exports.ToolMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.ToolMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var ToolMessageContent$; - (function(ToolMessageContent$2) { - ToolMessageContent$2.inboundSchema = exports.ToolMessageContent$inboundSchema; - ToolMessageContent$2.outboundSchema = exports.ToolMessageContent$outboundSchema; - })(ToolMessageContent$ || (exports.ToolMessageContent$ = ToolMessageContent$ = {})); - function toolMessageContentToJSON(toolMessageContent) { - return JSON.stringify(exports.ToolMessageContent$outboundSchema.parse(toolMessageContent)); - } - function toolMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessageContent' from JSON`); - } - exports.ToolMessageRole$inboundSchema = z.nativeEnum(exports.ToolMessageRole); - exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema; - var ToolMessageRole$; - (function(ToolMessageRole$2) { - ToolMessageRole$2.inboundSchema = exports.ToolMessageRole$inboundSchema; - ToolMessageRole$2.outboundSchema = exports.ToolMessageRole$outboundSchema; - })(ToolMessageRole$ || (exports.ToolMessageRole$ = ToolMessageRole$ = {})); - exports.ToolMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$inboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_call_id": "toolCallId" - }); - }); - exports.ToolMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$outboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCallId: "tool_call_id" - }); - }); - var ToolMessage$; - (function(ToolMessage$2) { - ToolMessage$2.inboundSchema = exports.ToolMessage$inboundSchema; - ToolMessage$2.outboundSchema = exports.ToolMessage$outboundSchema; - })(ToolMessage$ || (exports.ToolMessage$ = ToolMessage$ = {})); - function toolMessageToJSON(toolMessage) { - return JSON.stringify(exports.ToolMessage$outboundSchema.parse(toolMessage)); - } - function toolMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usermessage.js - var require_usermessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usermessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UserMessage$ = exports.UserMessage$outboundSchema = exports.UserMessage$inboundSchema = exports.UserMessageRole$ = exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema = exports.UserMessageContent$ = exports.UserMessageContent$outboundSchema = exports.UserMessageContent$inboundSchema = exports.UserMessageRole = void 0; - exports.userMessageContentToJSON = userMessageContentToJSON; - exports.userMessageContentFromJSON = userMessageContentFromJSON; - exports.userMessageToJSON = userMessageToJSON; - exports.userMessageFromJSON = userMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.UserMessageRole = { - User: "user" - }; - exports.UserMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.UserMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var UserMessageContent$; - (function(UserMessageContent$2) { - UserMessageContent$2.inboundSchema = exports.UserMessageContent$inboundSchema; - UserMessageContent$2.outboundSchema = exports.UserMessageContent$outboundSchema; - })(UserMessageContent$ || (exports.UserMessageContent$ = UserMessageContent$ = {})); - function userMessageContentToJSON(userMessageContent) { - return JSON.stringify(exports.UserMessageContent$outboundSchema.parse(userMessageContent)); - } - function userMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessageContent' from JSON`); - } - exports.UserMessageRole$inboundSchema = z.nativeEnum(exports.UserMessageRole); - exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema; - var UserMessageRole$; - (function(UserMessageRole$2) { - UserMessageRole$2.inboundSchema = exports.UserMessageRole$inboundSchema; - UserMessageRole$2.outboundSchema = exports.UserMessageRole$outboundSchema; - })(UserMessageRole$ || (exports.UserMessageRole$ = UserMessageRole$ = {})); - exports.UserMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - role: exports.UserMessageRole$inboundSchema.default("user") - }); - exports.UserMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - role: exports.UserMessageRole$outboundSchema.default("user") - }); - var UserMessage$; - (function(UserMessage$2) { - UserMessage$2.inboundSchema = exports.UserMessage$inboundSchema; - UserMessage$2.outboundSchema = exports.UserMessage$outboundSchema; - })(UserMessage$ || (exports.UserMessage$ = UserMessage$ = {})); - function userMessageToJSON(userMessage) { - return JSON.stringify(exports.UserMessage$outboundSchema.parse(userMessage)); - } - function userMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js - var require_agentscompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionRequest$ = exports.AgentsCompletionRequest$outboundSchema = exports.AgentsCompletionRequest$inboundSchema = exports.AgentsCompletionRequestToolChoice$ = exports.AgentsCompletionRequestToolChoice$outboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema = exports.AgentsCompletionRequestMessages$ = exports.AgentsCompletionRequestMessages$outboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema = exports.AgentsCompletionRequestStop$ = exports.AgentsCompletionRequestStop$outboundSchema = exports.AgentsCompletionRequestStop$inboundSchema = void 0; - exports.agentsCompletionRequestStopToJSON = agentsCompletionRequestStopToJSON; - exports.agentsCompletionRequestStopFromJSON = agentsCompletionRequestStopFromJSON; - exports.agentsCompletionRequestMessagesToJSON = agentsCompletionRequestMessagesToJSON; - exports.agentsCompletionRequestMessagesFromJSON = agentsCompletionRequestMessagesFromJSON; - exports.agentsCompletionRequestToolChoiceToJSON = agentsCompletionRequestToolChoiceToJSON; - exports.agentsCompletionRequestToolChoiceFromJSON = agentsCompletionRequestToolChoiceFromJSON; - exports.agentsCompletionRequestToJSON = agentsCompletionRequestToJSON; - exports.agentsCompletionRequestFromJSON = agentsCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionRequestStop$; - (function(AgentsCompletionRequestStop$2) { - AgentsCompletionRequestStop$2.inboundSchema = exports.AgentsCompletionRequestStop$inboundSchema; - AgentsCompletionRequestStop$2.outboundSchema = exports.AgentsCompletionRequestStop$outboundSchema; - })(AgentsCompletionRequestStop$ || (exports.AgentsCompletionRequestStop$ = AgentsCompletionRequestStop$ = {})); - function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop) { - return JSON.stringify(exports.AgentsCompletionRequestStop$outboundSchema.parse(agentsCompletionRequestStop)); - } - function agentsCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestStop' from JSON`); - } - exports.AgentsCompletionRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionRequestMessages$; - (function(AgentsCompletionRequestMessages$2) { - AgentsCompletionRequestMessages$2.inboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema; - AgentsCompletionRequestMessages$2.outboundSchema = exports.AgentsCompletionRequestMessages$outboundSchema; - })(AgentsCompletionRequestMessages$ || (exports.AgentsCompletionRequestMessages$ = AgentsCompletionRequestMessages$ = {})); - function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages) { - return JSON.stringify(exports.AgentsCompletionRequestMessages$outboundSchema.parse(agentsCompletionRequestMessages)); - } - function agentsCompletionRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestMessages' from JSON`); - } - exports.AgentsCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionRequestToolChoice$; - (function(AgentsCompletionRequestToolChoice$2) { - AgentsCompletionRequestToolChoice$2.inboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema; - AgentsCompletionRequestToolChoice$2.outboundSchema = exports.AgentsCompletionRequestToolChoice$outboundSchema; - })(AgentsCompletionRequestToolChoice$ || (exports.AgentsCompletionRequestToolChoice$ = AgentsCompletionRequestToolChoice$ = {})); - function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionRequestToolChoice$outboundSchema.parse(agentsCompletionRequestToolChoice)); - } - function agentsCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestToolChoice' from JSON`); - } - exports.AgentsCompletionRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionRequest$; - (function(AgentsCompletionRequest$2) { - AgentsCompletionRequest$2.inboundSchema = exports.AgentsCompletionRequest$inboundSchema; - AgentsCompletionRequest$2.outboundSchema = exports.AgentsCompletionRequest$outboundSchema; - })(AgentsCompletionRequest$ || (exports.AgentsCompletionRequest$ = AgentsCompletionRequest$ = {})); - function agentsCompletionRequestToJSON(agentsCompletionRequest) { - return JSON.stringify(exports.AgentsCompletionRequest$outboundSchema.parse(agentsCompletionRequest)); - } - function agentsCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js - var require_agentscompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionStreamRequest$ = exports.AgentsCompletionStreamRequest$outboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$ = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = exports.AgentsCompletionStreamRequestMessages$ = exports.AgentsCompletionStreamRequestMessages$outboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema = exports.AgentsCompletionStreamRequestStop$ = exports.AgentsCompletionStreamRequestStop$outboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema = void 0; - exports.agentsCompletionStreamRequestStopToJSON = agentsCompletionStreamRequestStopToJSON; - exports.agentsCompletionStreamRequestStopFromJSON = agentsCompletionStreamRequestStopFromJSON; - exports.agentsCompletionStreamRequestMessagesToJSON = agentsCompletionStreamRequestMessagesToJSON; - exports.agentsCompletionStreamRequestMessagesFromJSON = agentsCompletionStreamRequestMessagesFromJSON; - exports.agentsCompletionStreamRequestToolChoiceToJSON = agentsCompletionStreamRequestToolChoiceToJSON; - exports.agentsCompletionStreamRequestToolChoiceFromJSON = agentsCompletionStreamRequestToolChoiceFromJSON; - exports.agentsCompletionStreamRequestToJSON = agentsCompletionStreamRequestToJSON; - exports.agentsCompletionStreamRequestFromJSON = agentsCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionStreamRequestStop$; - (function(AgentsCompletionStreamRequestStop$2) { - AgentsCompletionStreamRequestStop$2.inboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema; - AgentsCompletionStreamRequestStop$2.outboundSchema = exports.AgentsCompletionStreamRequestStop$outboundSchema; - })(AgentsCompletionStreamRequestStop$ || (exports.AgentsCompletionStreamRequestStop$ = AgentsCompletionStreamRequestStop$ = {})); - function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop) { - return JSON.stringify(exports.AgentsCompletionStreamRequestStop$outboundSchema.parse(agentsCompletionStreamRequestStop)); - } - function agentsCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestStop' from JSON`); - } - exports.AgentsCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionStreamRequestMessages$; - (function(AgentsCompletionStreamRequestMessages$2) { - AgentsCompletionStreamRequestMessages$2.inboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema; - AgentsCompletionStreamRequestMessages$2.outboundSchema = exports.AgentsCompletionStreamRequestMessages$outboundSchema; - })(AgentsCompletionStreamRequestMessages$ || (exports.AgentsCompletionStreamRequestMessages$ = AgentsCompletionStreamRequestMessages$ = {})); - function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages) { - return JSON.stringify(exports.AgentsCompletionStreamRequestMessages$outboundSchema.parse(agentsCompletionStreamRequestMessages)); - } - function agentsCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestMessages' from JSON`); - } - exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionStreamRequestToolChoice$; - (function(AgentsCompletionStreamRequestToolChoice$2) { - AgentsCompletionStreamRequestToolChoice$2.inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema; - AgentsCompletionStreamRequestToolChoice$2.outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema; - })(AgentsCompletionStreamRequestToolChoice$ || (exports.AgentsCompletionStreamRequestToolChoice$ = AgentsCompletionStreamRequestToolChoice$ = {})); - function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionStreamRequestToolChoice$outboundSchema.parse(agentsCompletionStreamRequestToolChoice)); - } - function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestToolChoice' from JSON`); - } - exports.AgentsCompletionStreamRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionStreamRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionStreamRequest$; - (function(AgentsCompletionStreamRequest$2) { - AgentsCompletionStreamRequest$2.inboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema; - AgentsCompletionStreamRequest$2.outboundSchema = exports.AgentsCompletionStreamRequest$outboundSchema; - })(AgentsCompletionStreamRequest$ || (exports.AgentsCompletionStreamRequest$ = AgentsCompletionStreamRequest$ = {})); - function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest) { - return JSON.stringify(exports.AgentsCompletionStreamRequest$outboundSchema.parse(agentsCompletionStreamRequest)); - } - function agentsCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js - var require_agentupdaterequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentUpdateRequest$ = exports.AgentUpdateRequest$outboundSchema = exports.AgentUpdateRequest$inboundSchema = exports.AgentUpdateRequestTools$ = exports.AgentUpdateRequestTools$outboundSchema = exports.AgentUpdateRequestTools$inboundSchema = void 0; - exports.agentUpdateRequestToolsToJSON = agentUpdateRequestToolsToJSON; - exports.agentUpdateRequestToolsFromJSON = agentUpdateRequestToolsFromJSON; - exports.agentUpdateRequestToJSON = agentUpdateRequestToJSON; - exports.agentUpdateRequestFromJSON = agentUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentUpdateRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentUpdateRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentUpdateRequestTools$; - (function(AgentUpdateRequestTools$2) { - AgentUpdateRequestTools$2.inboundSchema = exports.AgentUpdateRequestTools$inboundSchema; - AgentUpdateRequestTools$2.outboundSchema = exports.AgentUpdateRequestTools$outboundSchema; - })(AgentUpdateRequestTools$ || (exports.AgentUpdateRequestTools$ = AgentUpdateRequestTools$ = {})); - function agentUpdateRequestToolsToJSON(agentUpdateRequestTools) { - return JSON.stringify(exports.AgentUpdateRequestTools$outboundSchema.parse(agentUpdateRequestTools)); - } - function agentUpdateRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequestTools' from JSON`); - } - exports.AgentUpdateRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentUpdateRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentUpdateRequest$; - (function(AgentUpdateRequest$2) { - AgentUpdateRequest$2.inboundSchema = exports.AgentUpdateRequest$inboundSchema; - AgentUpdateRequest$2.outboundSchema = exports.AgentUpdateRequest$outboundSchema; - })(AgentUpdateRequest$ || (exports.AgentUpdateRequest$ = AgentUpdateRequest$ = {})); - function agentUpdateRequestToJSON(agentUpdateRequest) { - return JSON.stringify(exports.AgentUpdateRequest$outboundSchema.parse(agentUpdateRequest)); - } - function agentUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/apiendpoint.js - var require_apiendpoint = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/apiendpoint.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ApiEndpoint$ = exports.ApiEndpoint$outboundSchema = exports.ApiEndpoint$inboundSchema = exports.ApiEndpoint = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ApiEndpoint = { - RootV1ChatCompletions: "/v1/chat/completions", - RootV1Embeddings: "/v1/embeddings", - RootV1FimCompletions: "/v1/fim/completions", - RootV1Moderations: "/v1/moderations", - RootV1ChatModerations: "/v1/chat/moderations", - RootV1Ocr: "/v1/ocr", - RootV1Classifications: "/v1/classifications", - RootV1ChatClassifications: "/v1/chat/classifications", - RootV1Conversations: "/v1/conversations", - RootV1AudioTranscriptions: "/v1/audio/transcriptions" - }; - exports.ApiEndpoint$inboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ApiEndpoint$outboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().and(z.custom()) - ]); - var ApiEndpoint$; - (function(ApiEndpoint$2) { - ApiEndpoint$2.inboundSchema = exports.ApiEndpoint$inboundSchema; - ApiEndpoint$2.outboundSchema = exports.ApiEndpoint$outboundSchema; - })(ApiEndpoint$ || (exports.ApiEndpoint$ = ApiEndpoint$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js - var require_archiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ArchiveFTModelOut$ = exports.ArchiveFTModelOut$outboundSchema = exports.ArchiveFTModelOut$inboundSchema = exports.ArchiveFTModelOutObject$ = exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema = exports.ArchiveFTModelOutObject = void 0; - exports.archiveFTModelOutToJSON = archiveFTModelOutToJSON; - exports.archiveFTModelOutFromJSON = archiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ArchiveFTModelOutObject = { - Model: "model" - }; - exports.ArchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.ArchiveFTModelOutObject); - exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - var ArchiveFTModelOutObject$; - (function(ArchiveFTModelOutObject$2) { - ArchiveFTModelOutObject$2.inboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - ArchiveFTModelOutObject$2.outboundSchema = exports.ArchiveFTModelOutObject$outboundSchema; - })(ArchiveFTModelOutObject$ || (exports.ArchiveFTModelOutObject$ = ArchiveFTModelOutObject$ = {})); - exports.ArchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(true) - }); - exports.ArchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(true) - }); - var ArchiveFTModelOut$; - (function(ArchiveFTModelOut$2) { - ArchiveFTModelOut$2.inboundSchema = exports.ArchiveFTModelOut$inboundSchema; - ArchiveFTModelOut$2.outboundSchema = exports.ArchiveFTModelOut$outboundSchema; - })(ArchiveFTModelOut$ || (exports.ArchiveFTModelOut$ = ArchiveFTModelOut$ = {})); - function archiveFTModelOutToJSON(archiveFTModelOut) { - return JSON.stringify(exports.ArchiveFTModelOut$outboundSchema.parse(archiveFTModelOut)); - } - function archiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ArchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ArchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/blobs.js - var require_blobs = __commonJS({ - "node_modules/@mistralai/mistralai/types/blobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.blobLikeSchema = void 0; - exports.isBlobLike = isBlobLike; - var z = __importStar(require_zod()); - exports.blobLikeSchema = z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true - }); - function isBlobLike(val) { - if (val instanceof Blob) { - return true; - } - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - return "stream" in val && typeof val.stream === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/file.js - var require_file = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/file.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileT$ = exports.FileT$outboundSchema = exports.FileT$inboundSchema = void 0; - exports.fileToJSON = fileToJSON; - exports.fileFromJSON = fileFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileT$inboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - exports.FileT$outboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - var FileT$; - (function(FileT$2) { - FileT$2.inboundSchema = exports.FileT$inboundSchema; - FileT$2.outboundSchema = exports.FileT$outboundSchema; - })(FileT$ || (exports.FileT$ = FileT$ = {})); - function fileToJSON(fileT) { - return JSON.stringify(exports.FileT$outboundSchema.parse(fileT)); - } - function fileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/timestampgranularity.js - var require_timestampgranularity = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/timestampgranularity.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TimestampGranularity$ = exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema = exports.TimestampGranularity = void 0; - var z = __importStar(require_zod()); - exports.TimestampGranularity = { - Segment: "segment" - }; - exports.TimestampGranularity$inboundSchema = z.nativeEnum(exports.TimestampGranularity); - exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema; - var TimestampGranularity$; - (function(TimestampGranularity$2) { - TimestampGranularity$2.inboundSchema = exports.TimestampGranularity$inboundSchema; - TimestampGranularity$2.outboundSchema = exports.TimestampGranularity$outboundSchema; - })(TimestampGranularity$ || (exports.TimestampGranularity$ = TimestampGranularity$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js - var require_audiotranscriptionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequest$ = exports.AudioTranscriptionRequest$outboundSchema = exports.AudioTranscriptionRequest$inboundSchema = void 0; - exports.audioTranscriptionRequestToJSON = audioTranscriptionRequestToJSON; - exports.audioTranscriptionRequestFromJSON = audioTranscriptionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequest$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequest$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequest$; - (function(AudioTranscriptionRequest$2) { - AudioTranscriptionRequest$2.inboundSchema = exports.AudioTranscriptionRequest$inboundSchema; - AudioTranscriptionRequest$2.outboundSchema = exports.AudioTranscriptionRequest$outboundSchema; - })(AudioTranscriptionRequest$ || (exports.AudioTranscriptionRequest$ = AudioTranscriptionRequest$ = {})); - function audioTranscriptionRequestToJSON(audioTranscriptionRequest) { - return JSON.stringify(exports.AudioTranscriptionRequest$outboundSchema.parse(audioTranscriptionRequest)); - } - function audioTranscriptionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js - var require_audiotranscriptionrequeststream = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequestStream$ = exports.AudioTranscriptionRequestStream$outboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema = void 0; - exports.audioTranscriptionRequestStreamToJSON = audioTranscriptionRequestStreamToJSON; - exports.audioTranscriptionRequestStreamFromJSON = audioTranscriptionRequestStreamFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequestStream$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequestStream$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequestStream$; - (function(AudioTranscriptionRequestStream$2) { - AudioTranscriptionRequestStream$2.inboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema; - AudioTranscriptionRequestStream$2.outboundSchema = exports.AudioTranscriptionRequestStream$outboundSchema; - })(AudioTranscriptionRequestStream$ || (exports.AudioTranscriptionRequestStream$ = AudioTranscriptionRequestStream$ = {})); - function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream) { - return JSON.stringify(exports.AudioTranscriptionRequestStream$outboundSchema.parse(audioTranscriptionRequestStream)); - } - function audioTranscriptionRequestStreamFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequestStream$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequestStream' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelcapabilities.js - var require_modelcapabilities = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelcapabilities.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelCapabilities$ = exports.ModelCapabilities$outboundSchema = exports.ModelCapabilities$inboundSchema = void 0; - exports.modelCapabilitiesToJSON = modelCapabilitiesToJSON; - exports.modelCapabilitiesFromJSON = modelCapabilitiesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModelCapabilities$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(true), - fine_tuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.ModelCapabilities$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(true), - fineTuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var ModelCapabilities$; - (function(ModelCapabilities$2) { - ModelCapabilities$2.inboundSchema = exports.ModelCapabilities$inboundSchema; - ModelCapabilities$2.outboundSchema = exports.ModelCapabilities$outboundSchema; - })(ModelCapabilities$ || (exports.ModelCapabilities$ = ModelCapabilities$ = {})); - function modelCapabilitiesToJSON(modelCapabilities) { - return JSON.stringify(exports.ModelCapabilities$outboundSchema.parse(modelCapabilities)); - } - function modelCapabilitiesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelCapabilities$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelCapabilities' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/basemodelcard.js - var require_basemodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/basemodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BaseModelCard$ = exports.BaseModelCard$outboundSchema = exports.BaseModelCard$inboundSchema = exports.BaseModelCardType$ = exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema = exports.BaseModelCardType = void 0; - exports.baseModelCardToJSON = baseModelCardToJSON; - exports.baseModelCardFromJSON = baseModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.BaseModelCardType = { - Base: "base" - }; - exports.BaseModelCardType$inboundSchema = z.nativeEnum(exports.BaseModelCardType); - exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema; - var BaseModelCardType$; - (function(BaseModelCardType$2) { - BaseModelCardType$2.inboundSchema = exports.BaseModelCardType$inboundSchema; - BaseModelCardType$2.outboundSchema = exports.BaseModelCardType$outboundSchema; - })(BaseModelCardType$ || (exports.BaseModelCardType$ = BaseModelCardType$ = {})); - exports.BaseModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.BaseModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var BaseModelCard$; - (function(BaseModelCard$2) { - BaseModelCard$2.inboundSchema = exports.BaseModelCard$inboundSchema; - BaseModelCard$2.outboundSchema = exports.BaseModelCard$outboundSchema; - })(BaseModelCard$ || (exports.BaseModelCard$ = BaseModelCard$ = {})); - function baseModelCardToJSON(baseModelCard) { - return JSON.stringify(exports.BaseModelCard$outboundSchema.parse(baseModelCard)); - } - function baseModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BaseModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BaseModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batcherror.js - var require_batcherror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batcherror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchError$ = exports.BatchError$outboundSchema = exports.BatchError$inboundSchema = void 0; - exports.batchErrorToJSON = batchErrorToJSON; - exports.batchErrorFromJSON = batchErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.BatchError$inboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - exports.BatchError$outboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - var BatchError$; - (function(BatchError$2) { - BatchError$2.inboundSchema = exports.BatchError$inboundSchema; - BatchError$2.outboundSchema = exports.BatchError$outboundSchema; - })(BatchError$ || (exports.BatchError$ = BatchError$ = {})); - function batchErrorToJSON(batchError) { - return JSON.stringify(exports.BatchError$outboundSchema.parse(batchError)); - } - function batchErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobin.js - var require_batchjobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobIn$ = exports.BatchJobIn$outboundSchema = exports.BatchJobIn$inboundSchema = void 0; - exports.batchJobInToJSON = batchJobInToJSON; - exports.batchJobInFromJSON = batchJobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var apiendpoint_js_1 = require_apiendpoint(); - exports.BatchJobIn$inboundSchema = z.object({ - input_files: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$inboundSchema, - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeout_hours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "timeout_hours": "timeoutHours" - }); - }); - exports.BatchJobIn$outboundSchema = z.object({ - inputFiles: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$outboundSchema, - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeoutHours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - timeoutHours: "timeout_hours" - }); - }); - var BatchJobIn$; - (function(BatchJobIn$2) { - BatchJobIn$2.inboundSchema = exports.BatchJobIn$inboundSchema; - BatchJobIn$2.outboundSchema = exports.BatchJobIn$outboundSchema; - })(BatchJobIn$ || (exports.BatchJobIn$ = BatchJobIn$ = {})); - function batchJobInToJSON(batchJobIn) { - return JSON.stringify(exports.BatchJobIn$outboundSchema.parse(batchJobIn)); - } - function batchJobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobstatus.js - var require_batchjobstatus = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobstatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobStatus$ = exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema = exports.BatchJobStatus = void 0; - var z = __importStar(require_zod()); - exports.BatchJobStatus = { - Queued: "QUEUED", - Running: "RUNNING", - Success: "SUCCESS", - Failed: "FAILED", - TimeoutExceeded: "TIMEOUT_EXCEEDED", - CancellationRequested: "CANCELLATION_REQUESTED", - Cancelled: "CANCELLED" - }; - exports.BatchJobStatus$inboundSchema = z.nativeEnum(exports.BatchJobStatus); - exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema; - var BatchJobStatus$; - (function(BatchJobStatus$2) { - BatchJobStatus$2.inboundSchema = exports.BatchJobStatus$inboundSchema; - BatchJobStatus$2.outboundSchema = exports.BatchJobStatus$outboundSchema; - })(BatchJobStatus$ || (exports.BatchJobStatus$ = BatchJobStatus$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobout.js - var require_batchjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobOut$ = exports.BatchJobOut$outboundSchema = exports.BatchJobOut$inboundSchema = exports.BatchJobOutObject$ = exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema = exports.BatchJobOutObject = void 0; - exports.batchJobOutToJSON = batchJobOutToJSON; - exports.batchJobOutFromJSON = batchJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var batcherror_js_1 = require_batcherror(); - var batchjobstatus_js_1 = require_batchjobstatus(); - exports.BatchJobOutObject = { - Batch: "batch" - }; - exports.BatchJobOutObject$inboundSchema = z.nativeEnum(exports.BatchJobOutObject); - exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema; - var BatchJobOutObject$; - (function(BatchJobOutObject$2) { - BatchJobOutObject$2.inboundSchema = exports.BatchJobOutObject$inboundSchema; - BatchJobOutObject$2.outboundSchema = exports.BatchJobOutObject$outboundSchema; - })(BatchJobOutObject$ || (exports.BatchJobOutObject$ = BatchJobOutObject$ = {})); - exports.BatchJobOut$inboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$inboundSchema.default("batch"), - input_files: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - output_file: z.nullable(z.string()).optional(), - error_file: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$inboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$inboundSchema, - created_at: z.number().int(), - total_requests: z.number().int(), - completed_requests: z.number().int(), - succeeded_requests: z.number().int(), - failed_requests: z.number().int(), - started_at: z.nullable(z.number().int()).optional(), - completed_at: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "output_file": "outputFile", - "error_file": "errorFile", - "created_at": "createdAt", - "total_requests": "totalRequests", - "completed_requests": "completedRequests", - "succeeded_requests": "succeededRequests", - "failed_requests": "failedRequests", - "started_at": "startedAt", - "completed_at": "completedAt" - }); - }); - exports.BatchJobOut$outboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$outboundSchema.default("batch"), - inputFiles: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - outputFile: z.nullable(z.string()).optional(), - errorFile: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$outboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$outboundSchema, - createdAt: z.number().int(), - totalRequests: z.number().int(), - completedRequests: z.number().int(), - succeededRequests: z.number().int(), - failedRequests: z.number().int(), - startedAt: z.nullable(z.number().int()).optional(), - completedAt: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - outputFile: "output_file", - errorFile: "error_file", - createdAt: "created_at", - totalRequests: "total_requests", - completedRequests: "completed_requests", - succeededRequests: "succeeded_requests", - failedRequests: "failed_requests", - startedAt: "started_at", - completedAt: "completed_at" - }); - }); - var BatchJobOut$; - (function(BatchJobOut$2) { - BatchJobOut$2.inboundSchema = exports.BatchJobOut$inboundSchema; - BatchJobOut$2.outboundSchema = exports.BatchJobOut$outboundSchema; - })(BatchJobOut$ || (exports.BatchJobOut$ = BatchJobOut$ = {})); - function batchJobOutToJSON(batchJobOut) { - return JSON.stringify(exports.BatchJobOut$outboundSchema.parse(batchJobOut)); - } - function batchJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobsout.js - var require_batchjobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobsOut$ = exports.BatchJobsOut$outboundSchema = exports.BatchJobsOut$inboundSchema = exports.BatchJobsOutObject$ = exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema = exports.BatchJobsOutObject = void 0; - exports.batchJobsOutToJSON = batchJobsOutToJSON; - exports.batchJobsOutFromJSON = batchJobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var batchjobout_js_1 = require_batchjobout(); - exports.BatchJobsOutObject = { - List: "list" - }; - exports.BatchJobsOutObject$inboundSchema = z.nativeEnum(exports.BatchJobsOutObject); - exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema; - var BatchJobsOutObject$; - (function(BatchJobsOutObject$2) { - BatchJobsOutObject$2.inboundSchema = exports.BatchJobsOutObject$inboundSchema; - BatchJobsOutObject$2.outboundSchema = exports.BatchJobsOutObject$outboundSchema; - })(BatchJobsOutObject$ || (exports.BatchJobsOutObject$ = BatchJobsOutObject$ = {})); - exports.BatchJobsOut$inboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$inboundSchema).optional(), - object: exports.BatchJobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.BatchJobsOut$outboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$outboundSchema).optional(), - object: exports.BatchJobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var BatchJobsOut$; - (function(BatchJobsOut$2) { - BatchJobsOut$2.inboundSchema = exports.BatchJobsOut$inboundSchema; - BatchJobsOut$2.outboundSchema = exports.BatchJobsOut$outboundSchema; - })(BatchJobsOut$ || (exports.BatchJobsOut$ = BatchJobsOut$ = {})); - function batchJobsOutToJSON(batchJobsOut) { - return JSON.stringify(exports.BatchJobsOut$outboundSchema.parse(batchJobsOut)); - } - function batchJobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/builtinconnectors.js - var require_builtinconnectors = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/builtinconnectors.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BuiltInConnectors$ = exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema = exports.BuiltInConnectors = void 0; - var z = __importStar(require_zod()); - exports.BuiltInConnectors = { - WebSearch: "web_search", - WebSearchPremium: "web_search_premium", - CodeInterpreter: "code_interpreter", - ImageGeneration: "image_generation", - DocumentLibrary: "document_library" - }; - exports.BuiltInConnectors$inboundSchema = z.nativeEnum(exports.BuiltInConnectors); - exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema; - var BuiltInConnectors$; - (function(BuiltInConnectors$2) { - BuiltInConnectors$2.inboundSchema = exports.BuiltInConnectors$inboundSchema; - BuiltInConnectors$2.outboundSchema = exports.BuiltInConnectors$outboundSchema; - })(BuiltInConnectors$ || (exports.BuiltInConnectors$ = BuiltInConnectors$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/instructrequest.js - var require_instructrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/instructrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InstructRequest$ = exports.InstructRequest$outboundSchema = exports.InstructRequest$inboundSchema = exports.InstructRequestMessages$ = exports.InstructRequestMessages$outboundSchema = exports.InstructRequestMessages$inboundSchema = void 0; - exports.instructRequestMessagesToJSON = instructRequestMessagesToJSON; - exports.instructRequestMessagesFromJSON = instructRequestMessagesFromJSON; - exports.instructRequestToJSON = instructRequestToJSON; - exports.instructRequestFromJSON = instructRequestFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestMessages$; - (function(InstructRequestMessages$2) { - InstructRequestMessages$2.inboundSchema = exports.InstructRequestMessages$inboundSchema; - InstructRequestMessages$2.outboundSchema = exports.InstructRequestMessages$outboundSchema; - })(InstructRequestMessages$ || (exports.InstructRequestMessages$ = InstructRequestMessages$ = {})); - function instructRequestMessagesToJSON(instructRequestMessages) { - return JSON.stringify(exports.InstructRequestMessages$outboundSchema.parse(instructRequestMessages)); - } - function instructRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestMessages' from JSON`); - } - exports.InstructRequest$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequest$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequest$; - (function(InstructRequest$2) { - InstructRequest$2.inboundSchema = exports.InstructRequest$inboundSchema; - InstructRequest$2.outboundSchema = exports.InstructRequest$outboundSchema; - })(InstructRequest$ || (exports.InstructRequest$ = InstructRequest$ = {})); - function instructRequestToJSON(instructRequest) { - return JSON.stringify(exports.InstructRequest$outboundSchema.parse(instructRequest)); - } - function instructRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputs.js - var require_inputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Inputs$ = exports.Inputs$outboundSchema = exports.Inputs$inboundSchema = exports.InstructRequestInputs$ = exports.InstructRequestInputs$outboundSchema = exports.InstructRequestInputs$inboundSchema = exports.InstructRequestInputsMessages$ = exports.InstructRequestInputsMessages$outboundSchema = exports.InstructRequestInputsMessages$inboundSchema = void 0; - exports.instructRequestInputsMessagesToJSON = instructRequestInputsMessagesToJSON; - exports.instructRequestInputsMessagesFromJSON = instructRequestInputsMessagesFromJSON; - exports.instructRequestInputsToJSON = instructRequestInputsToJSON; - exports.instructRequestInputsFromJSON = instructRequestInputsFromJSON; - exports.inputsToJSON = inputsToJSON; - exports.inputsFromJSON = inputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var instructrequest_js_1 = require_instructrequest(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestInputsMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestInputsMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestInputsMessages$; - (function(InstructRequestInputsMessages$2) { - InstructRequestInputsMessages$2.inboundSchema = exports.InstructRequestInputsMessages$inboundSchema; - InstructRequestInputsMessages$2.outboundSchema = exports.InstructRequestInputsMessages$outboundSchema; - })(InstructRequestInputsMessages$ || (exports.InstructRequestInputsMessages$ = InstructRequestInputsMessages$ = {})); - function instructRequestInputsMessagesToJSON(instructRequestInputsMessages) { - return JSON.stringify(exports.InstructRequestInputsMessages$outboundSchema.parse(instructRequestInputsMessages)); - } - function instructRequestInputsMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputsMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputsMessages' from JSON`); - } - exports.InstructRequestInputs$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequestInputs$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequestInputs$; - (function(InstructRequestInputs$2) { - InstructRequestInputs$2.inboundSchema = exports.InstructRequestInputs$inboundSchema; - InstructRequestInputs$2.outboundSchema = exports.InstructRequestInputs$outboundSchema; - })(InstructRequestInputs$ || (exports.InstructRequestInputs$ = InstructRequestInputs$ = {})); - function instructRequestInputsToJSON(instructRequestInputs) { - return JSON.stringify(exports.InstructRequestInputs$outboundSchema.parse(instructRequestInputs)); - } - function instructRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputs' from JSON`); - } - exports.Inputs$inboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$inboundSchema), - z.array(instructrequest_js_1.InstructRequest$inboundSchema) - ]); - exports.Inputs$outboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$outboundSchema), - z.array(instructrequest_js_1.InstructRequest$outboundSchema) - ]); - var Inputs$; - (function(Inputs$2) { - Inputs$2.inboundSchema = exports.Inputs$inboundSchema; - Inputs$2.outboundSchema = exports.Inputs$outboundSchema; - })(Inputs$ || (exports.Inputs$ = Inputs$ = {})); - function inputsToJSON(inputs) { - return JSON.stringify(exports.Inputs$outboundSchema.parse(inputs)); - } - function inputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Inputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Inputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js - var require_chatclassificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatClassificationRequest$ = exports.ChatClassificationRequest$outboundSchema = exports.ChatClassificationRequest$inboundSchema = void 0; - exports.chatClassificationRequestToJSON = chatClassificationRequestToJSON; - exports.chatClassificationRequestFromJSON = chatClassificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var inputs_js_1 = require_inputs(); - exports.ChatClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: inputs_js_1.Inputs$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: inputs_js_1.Inputs$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatClassificationRequest$; - (function(ChatClassificationRequest$2) { - ChatClassificationRequest$2.inboundSchema = exports.ChatClassificationRequest$inboundSchema; - ChatClassificationRequest$2.outboundSchema = exports.ChatClassificationRequest$outboundSchema; - })(ChatClassificationRequest$ || (exports.ChatClassificationRequest$ = ChatClassificationRequest$ = {})); - function chatClassificationRequestToJSON(chatClassificationRequest) { - return JSON.stringify(exports.ChatClassificationRequest$outboundSchema.parse(chatClassificationRequest)); - } - function chatClassificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js - var require_chatcompletionchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionChoice$ = exports.ChatCompletionChoice$outboundSchema = exports.ChatCompletionChoice$inboundSchema = exports.FinishReason$ = exports.FinishReason$outboundSchema = exports.FinishReason$inboundSchema = exports.FinishReason = void 0; - exports.chatCompletionChoiceToJSON = chatCompletionChoiceToJSON; - exports.chatCompletionChoiceFromJSON = chatCompletionChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var assistantmessage_js_1 = require_assistantmessage(); - exports.FinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.FinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().and(z.custom()) - ]); - var FinishReason$; - (function(FinishReason$2) { - FinishReason$2.inboundSchema = exports.FinishReason$inboundSchema; - FinishReason$2.outboundSchema = exports.FinishReason$outboundSchema; - })(FinishReason$ || (exports.FinishReason$ = FinishReason$ = {})); - exports.ChatCompletionChoice$inboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$inboundSchema, - finish_reason: exports.FinishReason$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.ChatCompletionChoice$outboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$outboundSchema, - finishReason: exports.FinishReason$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var ChatCompletionChoice$; - (function(ChatCompletionChoice$2) { - ChatCompletionChoice$2.inboundSchema = exports.ChatCompletionChoice$inboundSchema; - ChatCompletionChoice$2.outboundSchema = exports.ChatCompletionChoice$outboundSchema; - })(ChatCompletionChoice$ || (exports.ChatCompletionChoice$ = ChatCompletionChoice$ = {})); - function chatCompletionChoiceToJSON(chatCompletionChoice) { - return JSON.stringify(exports.ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice)); - } - function chatCompletionChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js - var require_chatcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionRequest$ = exports.ChatCompletionRequest$outboundSchema = exports.ChatCompletionRequest$inboundSchema = exports.ChatCompletionRequestToolChoice$ = exports.ChatCompletionRequestToolChoice$outboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema = exports.Messages$ = exports.Messages$outboundSchema = exports.Messages$inboundSchema = exports.Stop$ = exports.Stop$outboundSchema = exports.Stop$inboundSchema = void 0; - exports.stopToJSON = stopToJSON; - exports.stopFromJSON = stopFromJSON; - exports.messagesToJSON = messagesToJSON; - exports.messagesFromJSON = messagesFromJSON; - exports.chatCompletionRequestToolChoiceToJSON = chatCompletionRequestToolChoiceToJSON; - exports.chatCompletionRequestToolChoiceFromJSON = chatCompletionRequestToolChoiceFromJSON; - exports.chatCompletionRequestToJSON = chatCompletionRequestToJSON; - exports.chatCompletionRequestFromJSON = chatCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Stop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.Stop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var Stop$; - (function(Stop$2) { - Stop$2.inboundSchema = exports.Stop$inboundSchema; - Stop$2.outboundSchema = exports.Stop$outboundSchema; - })(Stop$ || (exports.Stop$ = Stop$ = {})); - function stopToJSON(stop) { - return JSON.stringify(exports.Stop$outboundSchema.parse(stop)); - } - function stopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Stop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Stop' from JSON`); - } - exports.Messages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Messages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Messages$; - (function(Messages$2) { - Messages$2.inboundSchema = exports.Messages$inboundSchema; - Messages$2.outboundSchema = exports.Messages$outboundSchema; - })(Messages$ || (exports.Messages$ = Messages$ = {})); - function messagesToJSON(messages) { - return JSON.stringify(exports.Messages$outboundSchema.parse(messages)); - } - function messagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Messages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Messages' from JSON`); - } - exports.ChatCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionRequestToolChoice$; - (function(ChatCompletionRequestToolChoice$2) { - ChatCompletionRequestToolChoice$2.inboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema; - ChatCompletionRequestToolChoice$2.outboundSchema = exports.ChatCompletionRequestToolChoice$outboundSchema; - })(ChatCompletionRequestToolChoice$ || (exports.ChatCompletionRequestToolChoice$ = ChatCompletionRequestToolChoice$ = {})); - function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionRequestToolChoice$outboundSchema.parse(chatCompletionRequestToolChoice)); - } - function chatCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`); - } - exports.ChatCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionRequest$; - (function(ChatCompletionRequest$2) { - ChatCompletionRequest$2.inboundSchema = exports.ChatCompletionRequest$inboundSchema; - ChatCompletionRequest$2.outboundSchema = exports.ChatCompletionRequest$outboundSchema; - })(ChatCompletionRequest$ || (exports.ChatCompletionRequest$ = ChatCompletionRequest$ = {})); - function chatCompletionRequestToJSON(chatCompletionRequest) { - return JSON.stringify(exports.ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest)); - } - function chatCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usageinfo.js - var require_usageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UsageInfo$ = exports.UsageInfo$outboundSchema = exports.UsageInfo$inboundSchema = void 0; - exports.usageInfoToJSON = usageInfoToJSON; - exports.usageInfoFromJSON = usageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.UsageInfo$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - prompt_audio_seconds: z.nullable(z.number().int()).optional() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "prompt_audio_seconds": "promptAudioSeconds" - }); - }); - exports.UsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - promptAudioSeconds: z.nullable(z.number().int()).optional(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - promptAudioSeconds: "prompt_audio_seconds", - additionalProperties: null - }) - }; - }); - var UsageInfo$; - (function(UsageInfo$2) { - UsageInfo$2.inboundSchema = exports.UsageInfo$inboundSchema; - UsageInfo$2.outboundSchema = exports.UsageInfo$outboundSchema; - })(UsageInfo$ || (exports.UsageInfo$ = UsageInfo$ = {})); - function usageInfoToJSON(usageInfo) { - return JSON.stringify(exports.UsageInfo$outboundSchema.parse(usageInfo)); - } - function usageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js - var require_chatcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionResponse$ = exports.ChatCompletionResponse$outboundSchema = exports.ChatCompletionResponse$inboundSchema = void 0; - exports.chatCompletionResponseToJSON = chatCompletionResponseToJSON; - exports.chatCompletionResponseFromJSON = chatCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.ChatCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.ChatCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var ChatCompletionResponse$; - (function(ChatCompletionResponse$2) { - ChatCompletionResponse$2.inboundSchema = exports.ChatCompletionResponse$inboundSchema; - ChatCompletionResponse$2.outboundSchema = exports.ChatCompletionResponse$outboundSchema; - })(ChatCompletionResponse$ || (exports.ChatCompletionResponse$ = ChatCompletionResponse$ = {})); - function chatCompletionResponseToJSON(chatCompletionResponse) { - return JSON.stringify(exports.ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse)); - } - function chatCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js - var require_chatcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionStreamRequest$ = exports.ChatCompletionStreamRequest$outboundSchema = exports.ChatCompletionStreamRequest$inboundSchema = exports.ChatCompletionStreamRequestToolChoice$ = exports.ChatCompletionStreamRequestToolChoice$outboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema = exports.ChatCompletionStreamRequestMessages$ = exports.ChatCompletionStreamRequestMessages$outboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema = exports.ChatCompletionStreamRequestStop$ = exports.ChatCompletionStreamRequestStop$outboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema = void 0; - exports.chatCompletionStreamRequestStopToJSON = chatCompletionStreamRequestStopToJSON; - exports.chatCompletionStreamRequestStopFromJSON = chatCompletionStreamRequestStopFromJSON; - exports.chatCompletionStreamRequestMessagesToJSON = chatCompletionStreamRequestMessagesToJSON; - exports.chatCompletionStreamRequestMessagesFromJSON = chatCompletionStreamRequestMessagesFromJSON; - exports.chatCompletionStreamRequestToolChoiceToJSON = chatCompletionStreamRequestToolChoiceToJSON; - exports.chatCompletionStreamRequestToolChoiceFromJSON = chatCompletionStreamRequestToolChoiceFromJSON; - exports.chatCompletionStreamRequestToJSON = chatCompletionStreamRequestToJSON; - exports.chatCompletionStreamRequestFromJSON = chatCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.ChatCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ChatCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ChatCompletionStreamRequestStop$; - (function(ChatCompletionStreamRequestStop$2) { - ChatCompletionStreamRequestStop$2.inboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema; - ChatCompletionStreamRequestStop$2.outboundSchema = exports.ChatCompletionStreamRequestStop$outboundSchema; - })(ChatCompletionStreamRequestStop$ || (exports.ChatCompletionStreamRequestStop$ = ChatCompletionStreamRequestStop$ = {})); - function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop) { - return JSON.stringify(exports.ChatCompletionStreamRequestStop$outboundSchema.parse(chatCompletionStreamRequestStop)); - } - function chatCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestStop' from JSON`); - } - exports.ChatCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.ChatCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var ChatCompletionStreamRequestMessages$; - (function(ChatCompletionStreamRequestMessages$2) { - ChatCompletionStreamRequestMessages$2.inboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema; - ChatCompletionStreamRequestMessages$2.outboundSchema = exports.ChatCompletionStreamRequestMessages$outboundSchema; - })(ChatCompletionStreamRequestMessages$ || (exports.ChatCompletionStreamRequestMessages$ = ChatCompletionStreamRequestMessages$ = {})); - function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages) { - return JSON.stringify(exports.ChatCompletionStreamRequestMessages$outboundSchema.parse(chatCompletionStreamRequestMessages)); - } - function chatCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestMessages' from JSON`); - } - exports.ChatCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionStreamRequestToolChoice$; - (function(ChatCompletionStreamRequestToolChoice$2) { - ChatCompletionStreamRequestToolChoice$2.inboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema; - ChatCompletionStreamRequestToolChoice$2.outboundSchema = exports.ChatCompletionStreamRequestToolChoice$outboundSchema; - })(ChatCompletionStreamRequestToolChoice$ || (exports.ChatCompletionStreamRequestToolChoice$ = ChatCompletionStreamRequestToolChoice$ = {})); - function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionStreamRequestToolChoice$outboundSchema.parse(chatCompletionStreamRequestToolChoice)); - } - function chatCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`); - } - exports.ChatCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionStreamRequest$; - (function(ChatCompletionStreamRequest$2) { - ChatCompletionStreamRequest$2.inboundSchema = exports.ChatCompletionStreamRequest$inboundSchema; - ChatCompletionStreamRequest$2.outboundSchema = exports.ChatCompletionStreamRequest$outboundSchema; - })(ChatCompletionStreamRequest$ || (exports.ChatCompletionStreamRequest$ = ChatCompletionStreamRequest$ = {})); - function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest) { - return JSON.stringify(exports.ChatCompletionStreamRequest$outboundSchema.parse(chatCompletionStreamRequest)); - } - function chatCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js - var require_chatmoderationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatModerationRequest$ = exports.ChatModerationRequest$outboundSchema = exports.ChatModerationRequest$inboundSchema = exports.ChatModerationRequestInputs$ = exports.ChatModerationRequestInputs$outboundSchema = exports.ChatModerationRequestInputs$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = exports.Two$ = exports.Two$outboundSchema = exports.Two$inboundSchema = void 0; - exports.twoToJSON = twoToJSON; - exports.twoFromJSON = twoFromJSON; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.chatModerationRequestInputsToJSON = chatModerationRequestInputsToJSON; - exports.chatModerationRequestInputsFromJSON = chatModerationRequestInputsFromJSON; - exports.chatModerationRequestToJSON = chatModerationRequestToJSON; - exports.chatModerationRequestFromJSON = chatModerationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Two$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Two$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Two$; - (function(Two$2) { - Two$2.inboundSchema = exports.Two$inboundSchema; - Two$2.outboundSchema = exports.Two$outboundSchema; - })(Two$ || (exports.Two$ = Two$ = {})); - function twoToJSON(two) { - return JSON.stringify(exports.Two$outboundSchema.parse(two)); - } - function twoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Two$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Two' from JSON`); - } - exports.One$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.One$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.ChatModerationRequestInputs$inboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - exports.ChatModerationRequestInputs$outboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - var ChatModerationRequestInputs$; - (function(ChatModerationRequestInputs$2) { - ChatModerationRequestInputs$2.inboundSchema = exports.ChatModerationRequestInputs$inboundSchema; - ChatModerationRequestInputs$2.outboundSchema = exports.ChatModerationRequestInputs$outboundSchema; - })(ChatModerationRequestInputs$ || (exports.ChatModerationRequestInputs$ = ChatModerationRequestInputs$ = {})); - function chatModerationRequestInputsToJSON(chatModerationRequestInputs) { - return JSON.stringify(exports.ChatModerationRequestInputs$outboundSchema.parse(chatModerationRequestInputs)); - } - function chatModerationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequestInputs' from JSON`); - } - exports.ChatModerationRequest$inboundSchema = z.object({ - input: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatModerationRequest$outboundSchema = z.object({ - inputs: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatModerationRequest$; - (function(ChatModerationRequest$2) { - ChatModerationRequest$2.inboundSchema = exports.ChatModerationRequest$inboundSchema; - ChatModerationRequest$2.outboundSchema = exports.ChatModerationRequest$outboundSchema; - })(ChatModerationRequest$ || (exports.ChatModerationRequest$ = ChatModerationRequest$ = {})); - function chatModerationRequestToJSON(chatModerationRequest) { - return JSON.stringify(exports.ChatModerationRequest$outboundSchema.parse(chatModerationRequest)); - } - function chatModerationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/metricout.js - var require_metricout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/metricout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MetricOut$ = exports.MetricOut$outboundSchema = exports.MetricOut$inboundSchema = void 0; - exports.metricOutToJSON = metricOutToJSON; - exports.metricOutFromJSON = metricOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.MetricOut$inboundSchema = z.object({ - train_loss: z.nullable(z.number()).optional(), - valid_loss: z.nullable(z.number()).optional(), - valid_mean_token_accuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "train_loss": "trainLoss", - "valid_loss": "validLoss", - "valid_mean_token_accuracy": "validMeanTokenAccuracy" - }); - }); - exports.MetricOut$outboundSchema = z.object({ - trainLoss: z.nullable(z.number()).optional(), - validLoss: z.nullable(z.number()).optional(), - validMeanTokenAccuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainLoss: "train_loss", - validLoss: "valid_loss", - validMeanTokenAccuracy: "valid_mean_token_accuracy" - }); - }); - var MetricOut$; - (function(MetricOut$2) { - MetricOut$2.inboundSchema = exports.MetricOut$inboundSchema; - MetricOut$2.outboundSchema = exports.MetricOut$outboundSchema; - })(MetricOut$ || (exports.MetricOut$ = MetricOut$ = {})); - function metricOutToJSON(metricOut) { - return JSON.stringify(exports.MetricOut$outboundSchema.parse(metricOut)); - } - function metricOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MetricOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MetricOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/checkpointout.js - var require_checkpointout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/checkpointout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CheckpointOut$ = exports.CheckpointOut$outboundSchema = exports.CheckpointOut$inboundSchema = void 0; - exports.checkpointOutToJSON = checkpointOutToJSON; - exports.checkpointOutFromJSON = checkpointOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var metricout_js_1 = require_metricout(); - exports.CheckpointOut$inboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$inboundSchema, - step_number: z.number().int(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "step_number": "stepNumber", - "created_at": "createdAt" - }); - }); - exports.CheckpointOut$outboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$outboundSchema, - stepNumber: z.number().int(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - stepNumber: "step_number", - createdAt: "created_at" - }); - }); - var CheckpointOut$; - (function(CheckpointOut$2) { - CheckpointOut$2.inboundSchema = exports.CheckpointOut$inboundSchema; - CheckpointOut$2.outboundSchema = exports.CheckpointOut$outboundSchema; - })(CheckpointOut$ || (exports.CheckpointOut$ = CheckpointOut$ = {})); - function checkpointOutToJSON(checkpointOut) { - return JSON.stringify(exports.CheckpointOut$outboundSchema.parse(checkpointOut)); - } - function checkpointOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CheckpointOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CheckpointOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationrequest.js - var require_classificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationRequest$ = exports.ClassificationRequest$outboundSchema = exports.ClassificationRequest$inboundSchema = exports.ClassificationRequestInputs$ = exports.ClassificationRequestInputs$outboundSchema = exports.ClassificationRequestInputs$inboundSchema = void 0; - exports.classificationRequestInputsToJSON = classificationRequestInputsToJSON; - exports.classificationRequestInputsFromJSON = classificationRequestInputsFromJSON; - exports.classificationRequestToJSON = classificationRequestToJSON; - exports.classificationRequestFromJSON = classificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassificationRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ClassificationRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ClassificationRequestInputs$; - (function(ClassificationRequestInputs$2) { - ClassificationRequestInputs$2.inboundSchema = exports.ClassificationRequestInputs$inboundSchema; - ClassificationRequestInputs$2.outboundSchema = exports.ClassificationRequestInputs$outboundSchema; - })(ClassificationRequestInputs$ || (exports.ClassificationRequestInputs$ = ClassificationRequestInputs$ = {})); - function classificationRequestInputsToJSON(classificationRequestInputs) { - return JSON.stringify(exports.ClassificationRequestInputs$outboundSchema.parse(classificationRequestInputs)); - } - function classificationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequestInputs' from JSON`); - } - exports.ClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ClassificationRequest$; - (function(ClassificationRequest$2) { - ClassificationRequest$2.inboundSchema = exports.ClassificationRequest$inboundSchema; - ClassificationRequest$2.outboundSchema = exports.ClassificationRequest$outboundSchema; - })(ClassificationRequest$ || (exports.ClassificationRequest$ = ClassificationRequest$ = {})); - function classificationRequestToJSON(classificationRequest) { - return JSON.stringify(exports.ClassificationRequest$outboundSchema.parse(classificationRequest)); - } - function classificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js - var require_classificationtargetresult = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationTargetResult$ = exports.ClassificationTargetResult$outboundSchema = exports.ClassificationTargetResult$inboundSchema = void 0; - exports.classificationTargetResultToJSON = classificationTargetResultToJSON; - exports.classificationTargetResultFromJSON = classificationTargetResultFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ClassificationTargetResult$inboundSchema = z.object({ - scores: z.record(z.number()) - }); - exports.ClassificationTargetResult$outboundSchema = z.object({ - scores: z.record(z.number()) - }); - var ClassificationTargetResult$; - (function(ClassificationTargetResult$2) { - ClassificationTargetResult$2.inboundSchema = exports.ClassificationTargetResult$inboundSchema; - ClassificationTargetResult$2.outboundSchema = exports.ClassificationTargetResult$outboundSchema; - })(ClassificationTargetResult$ || (exports.ClassificationTargetResult$ = ClassificationTargetResult$ = {})); - function classificationTargetResultToJSON(classificationTargetResult) { - return JSON.stringify(exports.ClassificationTargetResult$outboundSchema.parse(classificationTargetResult)); - } - function classificationTargetResultFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationTargetResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationTargetResult' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationresponse.js - var require_classificationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationResponse$ = exports.ClassificationResponse$outboundSchema = exports.ClassificationResponse$inboundSchema = void 0; - exports.classificationResponseToJSON = classificationResponseToJSON; - exports.classificationResponseFromJSON = classificationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classificationtargetresult_js_1 = require_classificationtargetresult(); - exports.ClassificationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$inboundSchema)) - }); - exports.ClassificationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$outboundSchema)) - }); - var ClassificationResponse$; - (function(ClassificationResponse$2) { - ClassificationResponse$2.inboundSchema = exports.ClassificationResponse$inboundSchema; - ClassificationResponse$2.outboundSchema = exports.ClassificationResponse$outboundSchema; - })(ClassificationResponse$ || (exports.ClassificationResponse$ = ClassificationResponse$ = {})); - function classificationResponseToJSON(classificationResponse) { - return JSON.stringify(exports.ClassificationResponse$outboundSchema.parse(classificationResponse)); - } - function classificationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js - var require_ftclassifierlossfunction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTClassifierLossFunction$ = exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema = exports.FTClassifierLossFunction = void 0; - var z = __importStar(require_zod()); - exports.FTClassifierLossFunction = { - SingleClass: "single_class", - MultiClass: "multi_class" - }; - exports.FTClassifierLossFunction$inboundSchema = z.nativeEnum(exports.FTClassifierLossFunction); - exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema; - var FTClassifierLossFunction$; - (function(FTClassifierLossFunction$2) { - FTClassifierLossFunction$2.inboundSchema = exports.FTClassifierLossFunction$inboundSchema; - FTClassifierLossFunction$2.outboundSchema = exports.FTClassifierLossFunction$outboundSchema; - })(FTClassifierLossFunction$ || (exports.FTClassifierLossFunction$ = FTClassifierLossFunction$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetout.js - var require_classifiertargetout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetOut$ = exports.ClassifierTargetOut$outboundSchema = exports.ClassifierTargetOut$inboundSchema = void 0; - exports.classifierTargetOutToJSON = classifierTargetOutToJSON; - exports.classifierTargetOutFromJSON = classifierTargetOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetOut$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - loss_function: ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetOut$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - lossFunction: ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetOut$; - (function(ClassifierTargetOut$2) { - ClassifierTargetOut$2.inboundSchema = exports.ClassifierTargetOut$inboundSchema; - ClassifierTargetOut$2.outboundSchema = exports.ClassifierTargetOut$outboundSchema; - })(ClassifierTargetOut$ || (exports.ClassifierTargetOut$ = ClassifierTargetOut$ = {})); - function classifierTargetOutToJSON(classifierTargetOut) { - return JSON.stringify(exports.ClassifierTargetOut$outboundSchema.parse(classifierTargetOut)); - } - function classifierTargetOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js - var require_classifiertrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParameters$ = exports.ClassifierTrainingParameters$outboundSchema = exports.ClassifierTrainingParameters$inboundSchema = void 0; - exports.classifierTrainingParametersToJSON = classifierTrainingParametersToJSON; - exports.classifierTrainingParametersFromJSON = classifierTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParameters$; - (function(ClassifierTrainingParameters$2) { - ClassifierTrainingParameters$2.inboundSchema = exports.ClassifierTrainingParameters$inboundSchema; - ClassifierTrainingParameters$2.outboundSchema = exports.ClassifierTrainingParameters$outboundSchema; - })(ClassifierTrainingParameters$ || (exports.ClassifierTrainingParameters$ = ClassifierTrainingParameters$ = {})); - function classifierTrainingParametersToJSON(classifierTrainingParameters) { - return JSON.stringify(exports.ClassifierTrainingParameters$outboundSchema.parse(classifierTrainingParameters)); - } - function classifierTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/eventout.js - var require_eventout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/eventout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventOut$ = exports.EventOut$outboundSchema = exports.EventOut$inboundSchema = void 0; - exports.eventOutToJSON = eventOutToJSON; - exports.eventOutFromJSON = eventOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.EventOut$inboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.EventOut$outboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var EventOut$; - (function(EventOut$2) { - EventOut$2.inboundSchema = exports.EventOut$inboundSchema; - EventOut$2.outboundSchema = exports.EventOut$outboundSchema; - })(EventOut$ || (exports.EventOut$ = EventOut$ = {})); - function eventOutToJSON(eventOut) { - return JSON.stringify(exports.EventOut$outboundSchema.parse(eventOut)); - } - function eventOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EventOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EventOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobmetadataout.js - var require_jobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobMetadataOut$ = exports.JobMetadataOut$outboundSchema = exports.JobMetadataOut$inboundSchema = void 0; - exports.jobMetadataOutToJSON = jobMetadataOutToJSON; - exports.jobMetadataOutFromJSON = jobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime" - }); - }); - exports.JobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time" - }); - }); - var JobMetadataOut$; - (function(JobMetadataOut$2) { - JobMetadataOut$2.inboundSchema = exports.JobMetadataOut$inboundSchema; - JobMetadataOut$2.outboundSchema = exports.JobMetadataOut$outboundSchema; - })(JobMetadataOut$ || (exports.JobMetadataOut$ = JobMetadataOut$ = {})); - function jobMetadataOutToJSON(jobMetadataOut) { - return JSON.stringify(exports.JobMetadataOut$outboundSchema.parse(jobMetadataOut)); - } - function jobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js - var require_wandbintegrationout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegrationOut$ = exports.WandbIntegrationOut$outboundSchema = exports.WandbIntegrationOut$inboundSchema = exports.WandbIntegrationOutType$ = exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema = exports.WandbIntegrationOutType = void 0; - exports.wandbIntegrationOutToJSON = wandbIntegrationOutToJSON; - exports.wandbIntegrationOutFromJSON = wandbIntegrationOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationOutType = { - Wandb: "wandb" - }; - exports.WandbIntegrationOutType$inboundSchema = z.nativeEnum(exports.WandbIntegrationOutType); - exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema; - var WandbIntegrationOutType$; - (function(WandbIntegrationOutType$2) { - WandbIntegrationOutType$2.inboundSchema = exports.WandbIntegrationOutType$inboundSchema; - WandbIntegrationOutType$2.outboundSchema = exports.WandbIntegrationOutType$outboundSchema; - })(WandbIntegrationOutType$ || (exports.WandbIntegrationOutType$ = WandbIntegrationOutType$ = {})); - exports.WandbIntegrationOut$inboundSchema = z.object({ - type: exports.WandbIntegrationOutType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - run_name: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "run_name": "runName" - }); - }); - exports.WandbIntegrationOut$outboundSchema = z.object({ - type: exports.WandbIntegrationOutType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - runName: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - runName: "run_name" - }); - }); - var WandbIntegrationOut$; - (function(WandbIntegrationOut$2) { - WandbIntegrationOut$2.inboundSchema = exports.WandbIntegrationOut$inboundSchema; - WandbIntegrationOut$2.outboundSchema = exports.WandbIntegrationOut$outboundSchema; - })(WandbIntegrationOut$ || (exports.WandbIntegrationOut$ = WandbIntegrationOut$ = {})); - function wandbIntegrationOutToJSON(wandbIntegrationOut) { - return JSON.stringify(exports.WandbIntegrationOut$outboundSchema.parse(wandbIntegrationOut)); - } - function wandbIntegrationOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegrationOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegrationOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js - var require_classifierdetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierDetailedJobOut$ = exports.ClassifierDetailedJobOut$outboundSchema = exports.ClassifierDetailedJobOut$inboundSchema = exports.ClassifierDetailedJobOutJobType$ = exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema = exports.ClassifierDetailedJobOutIntegrations$ = exports.ClassifierDetailedJobOutIntegrations$outboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema = exports.ClassifierDetailedJobOutObject$ = exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema = exports.ClassifierDetailedJobOutStatus$ = exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema = exports.ClassifierDetailedJobOutJobType = exports.ClassifierDetailedJobOutObject = exports.ClassifierDetailedJobOutStatus = void 0; - exports.classifierDetailedJobOutIntegrationsToJSON = classifierDetailedJobOutIntegrationsToJSON; - exports.classifierDetailedJobOutIntegrationsFromJSON = classifierDetailedJobOutIntegrationsFromJSON; - exports.classifierDetailedJobOutToJSON = classifierDetailedJobOutToJSON; - exports.classifierDetailedJobOutFromJSON = classifierDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var eventout_js_1 = require_eventout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierDetailedJobOutObject = { - Job: "job" - }; - exports.ClassifierDetailedJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutStatus); - exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - var ClassifierDetailedJobOutStatus$; - (function(ClassifierDetailedJobOutStatus$2) { - ClassifierDetailedJobOutStatus$2.inboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - ClassifierDetailedJobOutStatus$2.outboundSchema = exports.ClassifierDetailedJobOutStatus$outboundSchema; - })(ClassifierDetailedJobOutStatus$ || (exports.ClassifierDetailedJobOutStatus$ = ClassifierDetailedJobOutStatus$ = {})); - exports.ClassifierDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutObject); - exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - var ClassifierDetailedJobOutObject$; - (function(ClassifierDetailedJobOutObject$2) { - ClassifierDetailedJobOutObject$2.inboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - ClassifierDetailedJobOutObject$2.outboundSchema = exports.ClassifierDetailedJobOutObject$outboundSchema; - })(ClassifierDetailedJobOutObject$ || (exports.ClassifierDetailedJobOutObject$ = ClassifierDetailedJobOutObject$ = {})); - exports.ClassifierDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierDetailedJobOutIntegrations$; - (function(ClassifierDetailedJobOutIntegrations$2) { - ClassifierDetailedJobOutIntegrations$2.inboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema; - ClassifierDetailedJobOutIntegrations$2.outboundSchema = exports.ClassifierDetailedJobOutIntegrations$outboundSchema; - })(ClassifierDetailedJobOutIntegrations$ || (exports.ClassifierDetailedJobOutIntegrations$ = ClassifierDetailedJobOutIntegrations$ = {})); - function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations) { - return JSON.stringify(exports.ClassifierDetailedJobOutIntegrations$outboundSchema.parse(classifierDetailedJobOutIntegrations)); - } - function classifierDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOutIntegrations' from JSON`); - } - exports.ClassifierDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutJobType); - exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - var ClassifierDetailedJobOutJobType$; - (function(ClassifierDetailedJobOutJobType$2) { - ClassifierDetailedJobOutJobType$2.inboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - ClassifierDetailedJobOutJobType$2.outboundSchema = exports.ClassifierDetailedJobOutJobType$outboundSchema; - })(ClassifierDetailedJobOutJobType$ || (exports.ClassifierDetailedJobOutJobType$ = ClassifierDetailedJobOutJobType$ = {})); - exports.ClassifierDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierDetailedJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema, - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.ClassifierDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierDetailedJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema, - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var ClassifierDetailedJobOut$; - (function(ClassifierDetailedJobOut$2) { - ClassifierDetailedJobOut$2.inboundSchema = exports.ClassifierDetailedJobOut$inboundSchema; - ClassifierDetailedJobOut$2.outboundSchema = exports.ClassifierDetailedJobOut$outboundSchema; - })(ClassifierDetailedJobOut$ || (exports.ClassifierDetailedJobOut$ = ClassifierDetailedJobOut$ = {})); - function classifierDetailedJobOutToJSON(classifierDetailedJobOut) { - return JSON.stringify(exports.ClassifierDetailedJobOut$outboundSchema.parse(classifierDetailedJobOut)); - } - function classifierDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js - var require_ftmodelcapabilitiesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCapabilitiesOut$ = exports.FTModelCapabilitiesOut$outboundSchema = exports.FTModelCapabilitiesOut$inboundSchema = void 0; - exports.ftModelCapabilitiesOutToJSON = ftModelCapabilitiesOutToJSON; - exports.ftModelCapabilitiesOutFromJSON = ftModelCapabilitiesOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FTModelCapabilitiesOut$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(false), - fine_tuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.FTModelCapabilitiesOut$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(false), - fineTuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var FTModelCapabilitiesOut$; - (function(FTModelCapabilitiesOut$2) { - FTModelCapabilitiesOut$2.inboundSchema = exports.FTModelCapabilitiesOut$inboundSchema; - FTModelCapabilitiesOut$2.outboundSchema = exports.FTModelCapabilitiesOut$outboundSchema; - })(FTModelCapabilitiesOut$ || (exports.FTModelCapabilitiesOut$ = FTModelCapabilitiesOut$ = {})); - function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut) { - return JSON.stringify(exports.FTModelCapabilitiesOut$outboundSchema.parse(ftModelCapabilitiesOut)); - } - function ftModelCapabilitiesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCapabilitiesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCapabilitiesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js - var require_classifierftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierFTModelOut$ = exports.ClassifierFTModelOut$outboundSchema = exports.ClassifierFTModelOut$inboundSchema = exports.ClassifierFTModelOutModelType$ = exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema = exports.ClassifierFTModelOutObject$ = exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema = exports.ClassifierFTModelOutModelType = exports.ClassifierFTModelOutObject = void 0; - exports.classifierFTModelOutToJSON = classifierFTModelOutToJSON; - exports.classifierFTModelOutFromJSON = classifierFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.ClassifierFTModelOutObject = { - Model: "model" - }; - exports.ClassifierFTModelOutModelType = { - Classifier: "classifier" - }; - exports.ClassifierFTModelOutObject$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutObject); - exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - var ClassifierFTModelOutObject$; - (function(ClassifierFTModelOutObject$2) { - ClassifierFTModelOutObject$2.inboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - ClassifierFTModelOutObject$2.outboundSchema = exports.ClassifierFTModelOutObject$outboundSchema; - })(ClassifierFTModelOutObject$ || (exports.ClassifierFTModelOutObject$ = ClassifierFTModelOutObject$ = {})); - exports.ClassifierFTModelOutModelType$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutModelType); - exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - var ClassifierFTModelOutModelType$; - (function(ClassifierFTModelOutModelType$2) { - ClassifierFTModelOutModelType$2.inboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - ClassifierFTModelOutModelType$2.outboundSchema = exports.ClassifierFTModelOutModelType$outboundSchema; - })(ClassifierFTModelOutModelType$ || (exports.ClassifierFTModelOutModelType$ = ClassifierFTModelOutModelType$ = {})); - exports.ClassifierFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema), - model_type: exports.ClassifierFTModelOutModelType$inboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "classifier_targets": "classifierTargets", - "model_type": "modelType" - }); - }); - exports.ClassifierFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema), - modelType: exports.ClassifierFTModelOutModelType$outboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - classifierTargets: "classifier_targets", - modelType: "model_type" - }); - }); - var ClassifierFTModelOut$; - (function(ClassifierFTModelOut$2) { - ClassifierFTModelOut$2.inboundSchema = exports.ClassifierFTModelOut$inboundSchema; - ClassifierFTModelOut$2.outboundSchema = exports.ClassifierFTModelOut$outboundSchema; - })(ClassifierFTModelOut$ || (exports.ClassifierFTModelOut$ = ClassifierFTModelOut$ = {})); - function classifierFTModelOutToJSON(classifierFTModelOut) { - return JSON.stringify(exports.ClassifierFTModelOut$outboundSchema.parse(classifierFTModelOut)); - } - function classifierFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierjobout.js - var require_classifierjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierJobOut$ = exports.ClassifierJobOut$outboundSchema = exports.ClassifierJobOut$inboundSchema = exports.ClassifierJobOutJobType$ = exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema = exports.ClassifierJobOutIntegrations$ = exports.ClassifierJobOutIntegrations$outboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema = exports.ClassifierJobOutObject$ = exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema = exports.ClassifierJobOutStatus$ = exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema = exports.ClassifierJobOutJobType = exports.ClassifierJobOutObject = exports.ClassifierJobOutStatus = void 0; - exports.classifierJobOutIntegrationsToJSON = classifierJobOutIntegrationsToJSON; - exports.classifierJobOutIntegrationsFromJSON = classifierJobOutIntegrationsFromJSON; - exports.classifierJobOutToJSON = classifierJobOutToJSON; - exports.classifierJobOutFromJSON = classifierJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierJobOutObject = { - Job: "job" - }; - exports.ClassifierJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierJobOutStatus); - exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - var ClassifierJobOutStatus$; - (function(ClassifierJobOutStatus$2) { - ClassifierJobOutStatus$2.inboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - ClassifierJobOutStatus$2.outboundSchema = exports.ClassifierJobOutStatus$outboundSchema; - })(ClassifierJobOutStatus$ || (exports.ClassifierJobOutStatus$ = ClassifierJobOutStatus$ = {})); - exports.ClassifierJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierJobOutObject); - exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema; - var ClassifierJobOutObject$; - (function(ClassifierJobOutObject$2) { - ClassifierJobOutObject$2.inboundSchema = exports.ClassifierJobOutObject$inboundSchema; - ClassifierJobOutObject$2.outboundSchema = exports.ClassifierJobOutObject$outboundSchema; - })(ClassifierJobOutObject$ || (exports.ClassifierJobOutObject$ = ClassifierJobOutObject$ = {})); - exports.ClassifierJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierJobOutIntegrations$; - (function(ClassifierJobOutIntegrations$2) { - ClassifierJobOutIntegrations$2.inboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema; - ClassifierJobOutIntegrations$2.outboundSchema = exports.ClassifierJobOutIntegrations$outboundSchema; - })(ClassifierJobOutIntegrations$ || (exports.ClassifierJobOutIntegrations$ = ClassifierJobOutIntegrations$ = {})); - function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations) { - return JSON.stringify(exports.ClassifierJobOutIntegrations$outboundSchema.parse(classifierJobOutIntegrations)); - } - function classifierJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOutIntegrations' from JSON`); - } - exports.ClassifierJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierJobOutJobType); - exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - var ClassifierJobOutJobType$; - (function(ClassifierJobOutJobType$2) { - ClassifierJobOutJobType$2.inboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - ClassifierJobOutJobType$2.outboundSchema = exports.ClassifierJobOutJobType$outboundSchema; - })(ClassifierJobOutJobType$ || (exports.ClassifierJobOutJobType$ = ClassifierJobOutJobType$ = {})); - exports.ClassifierJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.ClassifierJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var ClassifierJobOut$; - (function(ClassifierJobOut$2) { - ClassifierJobOut$2.inboundSchema = exports.ClassifierJobOut$inboundSchema; - ClassifierJobOut$2.outboundSchema = exports.ClassifierJobOut$outboundSchema; - })(ClassifierJobOut$ || (exports.ClassifierJobOut$ = ClassifierJobOut$ = {})); - function classifierJobOutToJSON(classifierJobOut) { - return JSON.stringify(exports.ClassifierJobOut$outboundSchema.parse(classifierJobOut)); - } - function classifierJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetin.js - var require_classifiertargetin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetIn$ = exports.ClassifierTargetIn$outboundSchema = exports.ClassifierTargetIn$inboundSchema = void 0; - exports.classifierTargetInToJSON = classifierTargetInToJSON; - exports.classifierTargetInFromJSON = classifierTargetInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetIn$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - loss_function: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetIn$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - lossFunction: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetIn$; - (function(ClassifierTargetIn$2) { - ClassifierTargetIn$2.inboundSchema = exports.ClassifierTargetIn$inboundSchema; - ClassifierTargetIn$2.outboundSchema = exports.ClassifierTargetIn$outboundSchema; - })(ClassifierTargetIn$ || (exports.ClassifierTargetIn$ = ClassifierTargetIn$ = {})); - function classifierTargetInToJSON(classifierTargetIn) { - return JSON.stringify(exports.ClassifierTargetIn$outboundSchema.parse(classifierTargetIn)); - } - function classifierTargetInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js - var require_classifiertrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParametersIn$ = exports.ClassifierTrainingParametersIn$outboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema = void 0; - exports.classifierTrainingParametersInToJSON = classifierTrainingParametersInToJSON; - exports.classifierTrainingParametersInFromJSON = classifierTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParametersIn$; - (function(ClassifierTrainingParametersIn$2) { - ClassifierTrainingParametersIn$2.inboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema; - ClassifierTrainingParametersIn$2.outboundSchema = exports.ClassifierTrainingParametersIn$outboundSchema; - })(ClassifierTrainingParametersIn$ || (exports.ClassifierTrainingParametersIn$ = ClassifierTrainingParametersIn$ = {})); - function classifierTrainingParametersInToJSON(classifierTrainingParametersIn) { - return JSON.stringify(exports.ClassifierTrainingParametersIn$outboundSchema.parse(classifierTrainingParametersIn)); - } - function classifierTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deltamessage.js - var require_deltamessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deltamessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeltaMessage$ = exports.DeltaMessage$outboundSchema = exports.DeltaMessage$inboundSchema = exports.Content$ = exports.Content$outboundSchema = exports.Content$inboundSchema = void 0; - exports.contentToJSON = contentToJSON; - exports.contentFromJSON = contentFromJSON; - exports.deltaMessageToJSON = deltaMessageToJSON; - exports.deltaMessageFromJSON = deltaMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.Content$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.Content$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var Content$; - (function(Content$2) { - Content$2.inboundSchema = exports.Content$inboundSchema; - Content$2.outboundSchema = exports.Content$outboundSchema; - })(Content$ || (exports.Content$ = Content$ = {})); - function contentToJSON(content) { - return JSON.stringify(exports.Content$outboundSchema.parse(content)); - } - function contentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Content$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Content' from JSON`); - } - exports.DeltaMessage$inboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.DeltaMessage$outboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var DeltaMessage$; - (function(DeltaMessage$2) { - DeltaMessage$2.inboundSchema = exports.DeltaMessage$inboundSchema; - DeltaMessage$2.outboundSchema = exports.DeltaMessage$outboundSchema; - })(DeltaMessage$ || (exports.DeltaMessage$ = DeltaMessage$ = {})); - function deltaMessageToJSON(deltaMessage) { - return JSON.stringify(exports.DeltaMessage$outboundSchema.parse(deltaMessage)); - } - function deltaMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeltaMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeltaMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js - var require_completionresponsestreamchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionResponseStreamChoice$ = exports.CompletionResponseStreamChoice$outboundSchema = exports.CompletionResponseStreamChoice$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$ = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason = void 0; - exports.completionResponseStreamChoiceToJSON = completionResponseStreamChoiceToJSON; - exports.completionResponseStreamChoiceFromJSON = completionResponseStreamChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var deltamessage_js_1 = require_deltamessage(); - exports.CompletionResponseStreamChoiceFinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().and(z.custom()) - ]); - var CompletionResponseStreamChoiceFinishReason$; - (function(CompletionResponseStreamChoiceFinishReason$2) { - CompletionResponseStreamChoiceFinishReason$2.inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema; - CompletionResponseStreamChoiceFinishReason$2.outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema; - })(CompletionResponseStreamChoiceFinishReason$ || (exports.CompletionResponseStreamChoiceFinishReason$ = CompletionResponseStreamChoiceFinishReason$ = {})); - exports.CompletionResponseStreamChoice$inboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$inboundSchema, - finish_reason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.CompletionResponseStreamChoice$outboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$outboundSchema, - finishReason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var CompletionResponseStreamChoice$; - (function(CompletionResponseStreamChoice$2) { - CompletionResponseStreamChoice$2.inboundSchema = exports.CompletionResponseStreamChoice$inboundSchema; - CompletionResponseStreamChoice$2.outboundSchema = exports.CompletionResponseStreamChoice$outboundSchema; - })(CompletionResponseStreamChoice$ || (exports.CompletionResponseStreamChoice$ = CompletionResponseStreamChoice$ = {})); - function completionResponseStreamChoiceToJSON(completionResponseStreamChoice) { - return JSON.stringify(exports.CompletionResponseStreamChoice$outboundSchema.parse(completionResponseStreamChoice)); - } - function completionResponseStreamChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionResponseStreamChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionchunk.js - var require_completionchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionChunk$ = exports.CompletionChunk$outboundSchema = exports.CompletionChunk$inboundSchema = void 0; - exports.completionChunkToJSON = completionChunkToJSON; - exports.completionChunkFromJSON = completionChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionresponsestreamchoice_js_1 = require_completionresponsestreamchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.CompletionChunk$inboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$inboundSchema) - }); - exports.CompletionChunk$outboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$outboundSchema) - }); - var CompletionChunk$; - (function(CompletionChunk$2) { - CompletionChunk$2.inboundSchema = exports.CompletionChunk$inboundSchema; - CompletionChunk$2.outboundSchema = exports.CompletionChunk$outboundSchema; - })(CompletionChunk$ || (exports.CompletionChunk$ = CompletionChunk$ = {})); - function completionChunkToJSON(completionChunk) { - return JSON.stringify(exports.CompletionChunk$outboundSchema.parse(completionChunk)); - } - function completionChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js - var require_completiontrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParameters$ = exports.CompletionTrainingParameters$outboundSchema = exports.CompletionTrainingParameters$inboundSchema = void 0; - exports.completionTrainingParametersToJSON = completionTrainingParametersToJSON; - exports.completionTrainingParametersFromJSON = completionTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParameters$; - (function(CompletionTrainingParameters$2) { - CompletionTrainingParameters$2.inboundSchema = exports.CompletionTrainingParameters$inboundSchema; - CompletionTrainingParameters$2.outboundSchema = exports.CompletionTrainingParameters$outboundSchema; - })(CompletionTrainingParameters$ || (exports.CompletionTrainingParameters$ = CompletionTrainingParameters$ = {})); - function completionTrainingParametersToJSON(completionTrainingParameters) { - return JSON.stringify(exports.CompletionTrainingParameters$outboundSchema.parse(completionTrainingParameters)); - } - function completionTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js - var require_githubrepositoryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryOut$ = exports.GithubRepositoryOut$outboundSchema = exports.GithubRepositoryOut$inboundSchema = exports.GithubRepositoryOutType$ = exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema = exports.GithubRepositoryOutType = void 0; - exports.githubRepositoryOutToJSON = githubRepositoryOutToJSON; - exports.githubRepositoryOutFromJSON = githubRepositoryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryOutType = { - Github: "github" - }; - exports.GithubRepositoryOutType$inboundSchema = z.nativeEnum(exports.GithubRepositoryOutType); - exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema; - var GithubRepositoryOutType$; - (function(GithubRepositoryOutType$2) { - GithubRepositoryOutType$2.inboundSchema = exports.GithubRepositoryOutType$inboundSchema; - GithubRepositoryOutType$2.outboundSchema = exports.GithubRepositoryOutType$outboundSchema; - })(GithubRepositoryOutType$ || (exports.GithubRepositoryOutType$ = GithubRepositoryOutType$ = {})); - exports.GithubRepositoryOut$inboundSchema = z.object({ - type: exports.GithubRepositoryOutType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commit_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "commit_id": "commitId" - }); - }); - exports.GithubRepositoryOut$outboundSchema = z.object({ - type: exports.GithubRepositoryOutType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commitId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - commitId: "commit_id" - }); - }); - var GithubRepositoryOut$; - (function(GithubRepositoryOut$2) { - GithubRepositoryOut$2.inboundSchema = exports.GithubRepositoryOut$inboundSchema; - GithubRepositoryOut$2.outboundSchema = exports.GithubRepositoryOut$outboundSchema; - })(GithubRepositoryOut$ || (exports.GithubRepositoryOut$ = GithubRepositoryOut$ = {})); - function githubRepositoryOutToJSON(githubRepositoryOut) { - return JSON.stringify(exports.GithubRepositoryOut$outboundSchema.parse(githubRepositoryOut)); - } - function githubRepositoryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js - var require_completiondetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionDetailedJobOut$ = exports.CompletionDetailedJobOut$outboundSchema = exports.CompletionDetailedJobOut$inboundSchema = exports.CompletionDetailedJobOutRepositories$ = exports.CompletionDetailedJobOutRepositories$outboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema = exports.CompletionDetailedJobOutJobType$ = exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema = exports.CompletionDetailedJobOutIntegrations$ = exports.CompletionDetailedJobOutIntegrations$outboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema = exports.CompletionDetailedJobOutObject$ = exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema = exports.CompletionDetailedJobOutStatus$ = exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema = exports.CompletionDetailedJobOutJobType = exports.CompletionDetailedJobOutObject = exports.CompletionDetailedJobOutStatus = void 0; - exports.completionDetailedJobOutIntegrationsToJSON = completionDetailedJobOutIntegrationsToJSON; - exports.completionDetailedJobOutIntegrationsFromJSON = completionDetailedJobOutIntegrationsFromJSON; - exports.completionDetailedJobOutRepositoriesToJSON = completionDetailedJobOutRepositoriesToJSON; - exports.completionDetailedJobOutRepositoriesFromJSON = completionDetailedJobOutRepositoriesFromJSON; - exports.completionDetailedJobOutToJSON = completionDetailedJobOutToJSON; - exports.completionDetailedJobOutFromJSON = completionDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var eventout_js_1 = require_eventout(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.CompletionDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionDetailedJobOutObject = { - Job: "job" - }; - exports.CompletionDetailedJobOutJobType = { - Completion: "completion" - }; - exports.CompletionDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutStatus); - exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - var CompletionDetailedJobOutStatus$; - (function(CompletionDetailedJobOutStatus$2) { - CompletionDetailedJobOutStatus$2.inboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - CompletionDetailedJobOutStatus$2.outboundSchema = exports.CompletionDetailedJobOutStatus$outboundSchema; - })(CompletionDetailedJobOutStatus$ || (exports.CompletionDetailedJobOutStatus$ = CompletionDetailedJobOutStatus$ = {})); - exports.CompletionDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutObject); - exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - var CompletionDetailedJobOutObject$; - (function(CompletionDetailedJobOutObject$2) { - CompletionDetailedJobOutObject$2.inboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - CompletionDetailedJobOutObject$2.outboundSchema = exports.CompletionDetailedJobOutObject$outboundSchema; - })(CompletionDetailedJobOutObject$ || (exports.CompletionDetailedJobOutObject$ = CompletionDetailedJobOutObject$ = {})); - exports.CompletionDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.CompletionDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var CompletionDetailedJobOutIntegrations$; - (function(CompletionDetailedJobOutIntegrations$2) { - CompletionDetailedJobOutIntegrations$2.inboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema; - CompletionDetailedJobOutIntegrations$2.outboundSchema = exports.CompletionDetailedJobOutIntegrations$outboundSchema; - })(CompletionDetailedJobOutIntegrations$ || (exports.CompletionDetailedJobOutIntegrations$ = CompletionDetailedJobOutIntegrations$ = {})); - function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations) { - return JSON.stringify(exports.CompletionDetailedJobOutIntegrations$outboundSchema.parse(completionDetailedJobOutIntegrations)); - } - function completionDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutIntegrations' from JSON`); - } - exports.CompletionDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutJobType); - exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - var CompletionDetailedJobOutJobType$; - (function(CompletionDetailedJobOutJobType$2) { - CompletionDetailedJobOutJobType$2.inboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - CompletionDetailedJobOutJobType$2.outboundSchema = exports.CompletionDetailedJobOutJobType$outboundSchema; - })(CompletionDetailedJobOutJobType$ || (exports.CompletionDetailedJobOutJobType$ = CompletionDetailedJobOutJobType$ = {})); - exports.CompletionDetailedJobOutRepositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.CompletionDetailedJobOutRepositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var CompletionDetailedJobOutRepositories$; - (function(CompletionDetailedJobOutRepositories$2) { - CompletionDetailedJobOutRepositories$2.inboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema; - CompletionDetailedJobOutRepositories$2.outboundSchema = exports.CompletionDetailedJobOutRepositories$outboundSchema; - })(CompletionDetailedJobOutRepositories$ || (exports.CompletionDetailedJobOutRepositories$ = CompletionDetailedJobOutRepositories$ = {})); - function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories) { - return JSON.stringify(exports.CompletionDetailedJobOutRepositories$outboundSchema.parse(completionDetailedJobOutRepositories)); - } - function completionDetailedJobOutRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutRepositories' from JSON`); - } - exports.CompletionDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.CompletionDetailedJobOutJobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.CompletionDetailedJobOutJobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionDetailedJobOut$; - (function(CompletionDetailedJobOut$2) { - CompletionDetailedJobOut$2.inboundSchema = exports.CompletionDetailedJobOut$inboundSchema; - CompletionDetailedJobOut$2.outboundSchema = exports.CompletionDetailedJobOut$outboundSchema; - })(CompletionDetailedJobOut$ || (exports.CompletionDetailedJobOut$ = CompletionDetailedJobOut$ = {})); - function completionDetailedJobOutToJSON(completionDetailedJobOut) { - return JSON.stringify(exports.CompletionDetailedJobOut$outboundSchema.parse(completionDetailedJobOut)); - } - function completionDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionevent.js - var require_completionevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionEvent$ = exports.CompletionEvent$outboundSchema = exports.CompletionEvent$inboundSchema = void 0; - exports.completionEventToJSON = completionEventToJSON; - exports.completionEventFromJSON = completionEventFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionchunk_js_1 = require_completionchunk(); - exports.CompletionEvent$inboundSchema = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(completionchunk_js_1.CompletionChunk$inboundSchema) - }); - exports.CompletionEvent$outboundSchema = z.object({ - data: completionchunk_js_1.CompletionChunk$outboundSchema - }); - var CompletionEvent$; - (function(CompletionEvent$2) { - CompletionEvent$2.inboundSchema = exports.CompletionEvent$inboundSchema; - CompletionEvent$2.outboundSchema = exports.CompletionEvent$outboundSchema; - })(CompletionEvent$ || (exports.CompletionEvent$ = CompletionEvent$ = {})); - function completionEventToJSON(completionEvent) { - return JSON.stringify(exports.CompletionEvent$outboundSchema.parse(completionEvent)); - } - function completionEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionftmodelout.js - var require_completionftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionFTModelOut$ = exports.CompletionFTModelOut$outboundSchema = exports.CompletionFTModelOut$inboundSchema = exports.ModelType$ = exports.ModelType$outboundSchema = exports.ModelType$inboundSchema = exports.CompletionFTModelOutObject$ = exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema = exports.ModelType = exports.CompletionFTModelOutObject = void 0; - exports.completionFTModelOutToJSON = completionFTModelOutToJSON; - exports.completionFTModelOutFromJSON = completionFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.CompletionFTModelOutObject = { - Model: "model" - }; - exports.ModelType = { - Completion: "completion" - }; - exports.CompletionFTModelOutObject$inboundSchema = z.nativeEnum(exports.CompletionFTModelOutObject); - exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - var CompletionFTModelOutObject$; - (function(CompletionFTModelOutObject$2) { - CompletionFTModelOutObject$2.inboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - CompletionFTModelOutObject$2.outboundSchema = exports.CompletionFTModelOutObject$outboundSchema; - })(CompletionFTModelOutObject$ || (exports.CompletionFTModelOutObject$ = CompletionFTModelOutObject$ = {})); - exports.ModelType$inboundSchema = z.nativeEnum(exports.ModelType); - exports.ModelType$outboundSchema = exports.ModelType$inboundSchema; - var ModelType$; - (function(ModelType$2) { - ModelType$2.inboundSchema = exports.ModelType$inboundSchema; - ModelType$2.outboundSchema = exports.ModelType$outboundSchema; - })(ModelType$ || (exports.ModelType$ = ModelType$ = {})); - exports.CompletionFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - model_type: exports.ModelType$inboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "model_type": "modelType" - }); - }); - exports.CompletionFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - modelType: exports.ModelType$outboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - modelType: "model_type" - }); - }); - var CompletionFTModelOut$; - (function(CompletionFTModelOut$2) { - CompletionFTModelOut$2.inboundSchema = exports.CompletionFTModelOut$inboundSchema; - CompletionFTModelOut$2.outboundSchema = exports.CompletionFTModelOut$outboundSchema; - })(CompletionFTModelOut$ || (exports.CompletionFTModelOut$ = CompletionFTModelOut$ = {})); - function completionFTModelOutToJSON(completionFTModelOut) { - return JSON.stringify(exports.CompletionFTModelOut$outboundSchema.parse(completionFTModelOut)); - } - function completionFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionjobout.js - var require_completionjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionJobOut$ = exports.CompletionJobOut$outboundSchema = exports.CompletionJobOut$inboundSchema = exports.Repositories$ = exports.Repositories$outboundSchema = exports.Repositories$inboundSchema = exports.JobType$ = exports.JobType$outboundSchema = exports.JobType$inboundSchema = exports.Integrations$ = exports.Integrations$outboundSchema = exports.Integrations$inboundSchema = exports.CompletionJobOutObject$ = exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.JobType = exports.CompletionJobOutObject = exports.Status = void 0; - exports.integrationsToJSON = integrationsToJSON; - exports.integrationsFromJSON = integrationsFromJSON; - exports.repositoriesToJSON = repositoriesToJSON; - exports.repositoriesFromJSON = repositoriesFromJSON; - exports.completionJobOutToJSON = completionJobOutToJSON; - exports.completionJobOutFromJSON = completionJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionJobOutObject = { - Job: "job" - }; - exports.JobType = { - Completion: "completion" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.CompletionJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionJobOutObject); - exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema; - var CompletionJobOutObject$; - (function(CompletionJobOutObject$2) { - CompletionJobOutObject$2.inboundSchema = exports.CompletionJobOutObject$inboundSchema; - CompletionJobOutObject$2.outboundSchema = exports.CompletionJobOutObject$outboundSchema; - })(CompletionJobOutObject$ || (exports.CompletionJobOutObject$ = CompletionJobOutObject$ = {})); - exports.Integrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.Integrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var Integrations$; - (function(Integrations$2) { - Integrations$2.inboundSchema = exports.Integrations$inboundSchema; - Integrations$2.outboundSchema = exports.Integrations$outboundSchema; - })(Integrations$ || (exports.Integrations$ = Integrations$ = {})); - function integrationsToJSON(integrations) { - return JSON.stringify(exports.Integrations$outboundSchema.parse(integrations)); - } - function integrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Integrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Integrations' from JSON`); - } - exports.JobType$inboundSchema = z.nativeEnum(exports.JobType); - exports.JobType$outboundSchema = exports.JobType$inboundSchema; - var JobType$; - (function(JobType$2) { - JobType$2.inboundSchema = exports.JobType$inboundSchema; - JobType$2.outboundSchema = exports.JobType$outboundSchema; - })(JobType$ || (exports.JobType$ = JobType$ = {})); - exports.Repositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.Repositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var Repositories$; - (function(Repositories$2) { - Repositories$2.inboundSchema = exports.Repositories$inboundSchema; - Repositories$2.outboundSchema = exports.Repositories$outboundSchema; - })(Repositories$ || (exports.Repositories$ = Repositories$ = {})); - function repositoriesToJSON(repositories) { - return JSON.stringify(exports.Repositories$outboundSchema.parse(repositories)); - } - function repositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Repositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Repositories' from JSON`); - } - exports.CompletionJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.Status$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.JobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.Status$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.JobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionJobOut$; - (function(CompletionJobOut$2) { - CompletionJobOut$2.inboundSchema = exports.CompletionJobOut$inboundSchema; - CompletionJobOut$2.outboundSchema = exports.CompletionJobOut$outboundSchema; - })(CompletionJobOut$ || (exports.CompletionJobOut$ = CompletionJobOut$ = {})); - function completionJobOutToJSON(completionJobOut) { - return JSON.stringify(exports.CompletionJobOut$outboundSchema.parse(completionJobOut)); - } - function completionJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js - var require_completiontrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParametersIn$ = exports.CompletionTrainingParametersIn$outboundSchema = exports.CompletionTrainingParametersIn$inboundSchema = void 0; - exports.completionTrainingParametersInToJSON = completionTrainingParametersInToJSON; - exports.completionTrainingParametersInFromJSON = completionTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParametersIn$; - (function(CompletionTrainingParametersIn$2) { - CompletionTrainingParametersIn$2.inboundSchema = exports.CompletionTrainingParametersIn$inboundSchema; - CompletionTrainingParametersIn$2.outboundSchema = exports.CompletionTrainingParametersIn$outboundSchema; - })(CompletionTrainingParametersIn$ || (exports.CompletionTrainingParametersIn$ = CompletionTrainingParametersIn$ = {})); - function completionTrainingParametersInToJSON(completionTrainingParametersIn) { - return JSON.stringify(exports.CompletionTrainingParametersIn$outboundSchema.parse(completionTrainingParametersIn)); - } - function completionTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js - var require_functioncallentryarguments = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntryArguments$ = exports.FunctionCallEntryArguments$outboundSchema = exports.FunctionCallEntryArguments$inboundSchema = void 0; - exports.functionCallEntryArgumentsToJSON = functionCallEntryArgumentsToJSON; - exports.functionCallEntryArgumentsFromJSON = functionCallEntryArgumentsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEntryArguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.FunctionCallEntryArguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var FunctionCallEntryArguments$; - (function(FunctionCallEntryArguments$2) { - FunctionCallEntryArguments$2.inboundSchema = exports.FunctionCallEntryArguments$inboundSchema; - FunctionCallEntryArguments$2.outboundSchema = exports.FunctionCallEntryArguments$outboundSchema; - })(FunctionCallEntryArguments$ || (exports.FunctionCallEntryArguments$ = FunctionCallEntryArguments$ = {})); - function functionCallEntryArgumentsToJSON(functionCallEntryArguments) { - return JSON.stringify(exports.FunctionCallEntryArguments$outboundSchema.parse(functionCallEntryArguments)); - } - function functionCallEntryArgumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntryArguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntryArguments' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentry.js - var require_functioncallentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntry$ = exports.FunctionCallEntry$outboundSchema = exports.FunctionCallEntry$inboundSchema = exports.FunctionCallEntryType$ = exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema = exports.FunctionCallEntryObject$ = exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema = exports.FunctionCallEntryType = exports.FunctionCallEntryObject = void 0; - exports.functionCallEntryToJSON = functionCallEntryToJSON; - exports.functionCallEntryFromJSON = functionCallEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var functioncallentryarguments_js_1 = require_functioncallentryarguments(); - exports.FunctionCallEntryObject = { - Entry: "entry" - }; - exports.FunctionCallEntryType = { - FunctionCall: "function.call" - }; - exports.FunctionCallEntryObject$inboundSchema = z.nativeEnum(exports.FunctionCallEntryObject); - exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema; - var FunctionCallEntryObject$; - (function(FunctionCallEntryObject$2) { - FunctionCallEntryObject$2.inboundSchema = exports.FunctionCallEntryObject$inboundSchema; - FunctionCallEntryObject$2.outboundSchema = exports.FunctionCallEntryObject$outboundSchema; - })(FunctionCallEntryObject$ || (exports.FunctionCallEntryObject$ = FunctionCallEntryObject$ = {})); - exports.FunctionCallEntryType$inboundSchema = z.nativeEnum(exports.FunctionCallEntryType); - exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema; - var FunctionCallEntryType$; - (function(FunctionCallEntryType$2) { - FunctionCallEntryType$2.inboundSchema = exports.FunctionCallEntryType$inboundSchema; - FunctionCallEntryType$2.outboundSchema = exports.FunctionCallEntryType$outboundSchema; - })(FunctionCallEntryType$ || (exports.FunctionCallEntryType$ = FunctionCallEntryType$ = {})); - exports.FunctionCallEntry$inboundSchema = z.object({ - object: exports.FunctionCallEntryObject$inboundSchema.default("entry"), - type: exports.FunctionCallEntryType$inboundSchema.default("function.call"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEntry$outboundSchema = z.object({ - object: exports.FunctionCallEntryObject$outboundSchema.default("entry"), - type: exports.FunctionCallEntryType$outboundSchema.default("function.call"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEntry$; - (function(FunctionCallEntry$2) { - FunctionCallEntry$2.inboundSchema = exports.FunctionCallEntry$inboundSchema; - FunctionCallEntry$2.outboundSchema = exports.FunctionCallEntry$outboundSchema; - })(FunctionCallEntry$ || (exports.FunctionCallEntry$ = FunctionCallEntry$ = {})); - function functionCallEntryToJSON(functionCallEntry) { - return JSON.stringify(exports.FunctionCallEntry$outboundSchema.parse(functionCallEntry)); - } - function functionCallEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionresultentry.js - var require_functionresultentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionresultentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionResultEntry$ = exports.FunctionResultEntry$outboundSchema = exports.FunctionResultEntry$inboundSchema = exports.FunctionResultEntryType$ = exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema = exports.FunctionResultEntryObject$ = exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema = exports.FunctionResultEntryType = exports.FunctionResultEntryObject = void 0; - exports.functionResultEntryToJSON = functionResultEntryToJSON; - exports.functionResultEntryFromJSON = functionResultEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionResultEntryObject = { - Entry: "entry" - }; - exports.FunctionResultEntryType = { - FunctionResult: "function.result" - }; - exports.FunctionResultEntryObject$inboundSchema = z.nativeEnum(exports.FunctionResultEntryObject); - exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema; - var FunctionResultEntryObject$; - (function(FunctionResultEntryObject$2) { - FunctionResultEntryObject$2.inboundSchema = exports.FunctionResultEntryObject$inboundSchema; - FunctionResultEntryObject$2.outboundSchema = exports.FunctionResultEntryObject$outboundSchema; - })(FunctionResultEntryObject$ || (exports.FunctionResultEntryObject$ = FunctionResultEntryObject$ = {})); - exports.FunctionResultEntryType$inboundSchema = z.nativeEnum(exports.FunctionResultEntryType); - exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema; - var FunctionResultEntryType$; - (function(FunctionResultEntryType$2) { - FunctionResultEntryType$2.inboundSchema = exports.FunctionResultEntryType$inboundSchema; - FunctionResultEntryType$2.outboundSchema = exports.FunctionResultEntryType$outboundSchema; - })(FunctionResultEntryType$ || (exports.FunctionResultEntryType$ = FunctionResultEntryType$ = {})); - exports.FunctionResultEntry$inboundSchema = z.object({ - object: exports.FunctionResultEntryObject$inboundSchema.default("entry"), - type: exports.FunctionResultEntryType$inboundSchema.default("function.result"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionResultEntry$outboundSchema = z.object({ - object: exports.FunctionResultEntryObject$outboundSchema.default("entry"), - type: exports.FunctionResultEntryType$outboundSchema.default("function.result"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionResultEntry$; - (function(FunctionResultEntry$2) { - FunctionResultEntry$2.inboundSchema = exports.FunctionResultEntry$inboundSchema; - FunctionResultEntry$2.outboundSchema = exports.FunctionResultEntry$outboundSchema; - })(FunctionResultEntry$ || (exports.FunctionResultEntry$ = FunctionResultEntry$ = {})); - function functionResultEntryToJSON(functionResultEntry) { - return JSON.stringify(exports.FunctionResultEntry$outboundSchema.parse(functionResultEntry)); - } - function functionResultEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionResultEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionResultEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolfilechunk.js - var require_toolfilechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolfilechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolFileChunk$ = exports.ToolFileChunk$outboundSchema = exports.ToolFileChunk$inboundSchema = exports.ToolFileChunkType$ = exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema = exports.ToolFileChunkType = void 0; - exports.toolFileChunkToJSON = toolFileChunkToJSON; - exports.toolFileChunkFromJSON = toolFileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolFileChunkType = { - ToolFile: "tool_file" - }; - exports.ToolFileChunkType$inboundSchema = z.nativeEnum(exports.ToolFileChunkType); - exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema; - var ToolFileChunkType$; - (function(ToolFileChunkType$2) { - ToolFileChunkType$2.inboundSchema = exports.ToolFileChunkType$inboundSchema; - ToolFileChunkType$2.outboundSchema = exports.ToolFileChunkType$outboundSchema; - })(ToolFileChunkType$ || (exports.ToolFileChunkType$ = ToolFileChunkType$ = {})); - exports.ToolFileChunk$inboundSchema = z.object({ - type: exports.ToolFileChunkType$inboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - file_id: z.string(), - file_name: z.nullable(z.string()).optional(), - file_type: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId", - "file_name": "fileName", - "file_type": "fileType" - }); - }); - exports.ToolFileChunk$outboundSchema = z.object({ - type: exports.ToolFileChunkType$outboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - fileId: z.string(), - fileName: z.nullable(z.string()).optional(), - fileType: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id", - fileName: "file_name", - fileType: "file_type" - }); - }); - var ToolFileChunk$; - (function(ToolFileChunk$2) { - ToolFileChunk$2.inboundSchema = exports.ToolFileChunk$inboundSchema; - ToolFileChunk$2.outboundSchema = exports.ToolFileChunk$outboundSchema; - })(ToolFileChunk$ || (exports.ToolFileChunk$ = ToolFileChunk$ = {})); - function toolFileChunkToJSON(toolFileChunk) { - return JSON.stringify(exports.ToolFileChunk$outboundSchema.parse(toolFileChunk)); - } - function toolFileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolFileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolFileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js - var require_messageinputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputContentChunks$ = exports.MessageInputContentChunks$outboundSchema = exports.MessageInputContentChunks$inboundSchema = void 0; - exports.messageInputContentChunksToJSON = messageInputContentChunksToJSON; - exports.messageInputContentChunksFromJSON = messageInputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - exports.MessageInputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageInputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageInputContentChunks$; - (function(MessageInputContentChunks$2) { - MessageInputContentChunks$2.inboundSchema = exports.MessageInputContentChunks$inboundSchema; - MessageInputContentChunks$2.outboundSchema = exports.MessageInputContentChunks$outboundSchema; - })(MessageInputContentChunks$ || (exports.MessageInputContentChunks$ = MessageInputContentChunks$ = {})); - function messageInputContentChunksToJSON(messageInputContentChunks) { - return JSON.stringify(exports.MessageInputContentChunks$outboundSchema.parse(messageInputContentChunks)); - } - function messageInputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputentry.js - var require_messageinputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputEntry$ = exports.MessageInputEntry$outboundSchema = exports.MessageInputEntry$inboundSchema = exports.MessageInputEntryContent$ = exports.MessageInputEntryContent$outboundSchema = exports.MessageInputEntryContent$inboundSchema = exports.MessageInputEntryRole$ = exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema = exports.MessageInputEntryType$ = exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema = exports.ObjectT$ = exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema = exports.MessageInputEntryRole = exports.MessageInputEntryType = exports.ObjectT = void 0; - exports.messageInputEntryContentToJSON = messageInputEntryContentToJSON; - exports.messageInputEntryContentFromJSON = messageInputEntryContentFromJSON; - exports.messageInputEntryToJSON = messageInputEntryToJSON; - exports.messageInputEntryFromJSON = messageInputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageinputcontentchunks_js_1 = require_messageinputcontentchunks(); - exports.ObjectT = { - Entry: "entry" - }; - exports.MessageInputEntryType = { - MessageInput: "message.input" - }; - exports.MessageInputEntryRole = { - Assistant: "assistant", - User: "user" - }; - exports.ObjectT$inboundSchema = z.nativeEnum(exports.ObjectT); - exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema; - var ObjectT$; - (function(ObjectT$2) { - ObjectT$2.inboundSchema = exports.ObjectT$inboundSchema; - ObjectT$2.outboundSchema = exports.ObjectT$outboundSchema; - })(ObjectT$ || (exports.ObjectT$ = ObjectT$ = {})); - exports.MessageInputEntryType$inboundSchema = z.nativeEnum(exports.MessageInputEntryType); - exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema; - var MessageInputEntryType$; - (function(MessageInputEntryType$2) { - MessageInputEntryType$2.inboundSchema = exports.MessageInputEntryType$inboundSchema; - MessageInputEntryType$2.outboundSchema = exports.MessageInputEntryType$outboundSchema; - })(MessageInputEntryType$ || (exports.MessageInputEntryType$ = MessageInputEntryType$ = {})); - exports.MessageInputEntryRole$inboundSchema = z.nativeEnum(exports.MessageInputEntryRole); - exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema; - var MessageInputEntryRole$; - (function(MessageInputEntryRole$2) { - MessageInputEntryRole$2.inboundSchema = exports.MessageInputEntryRole$inboundSchema; - MessageInputEntryRole$2.outboundSchema = exports.MessageInputEntryRole$outboundSchema; - })(MessageInputEntryRole$ || (exports.MessageInputEntryRole$ = MessageInputEntryRole$ = {})); - exports.MessageInputEntryContent$inboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema)]); - exports.MessageInputEntryContent$outboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema)]); - var MessageInputEntryContent$; - (function(MessageInputEntryContent$2) { - MessageInputEntryContent$2.inboundSchema = exports.MessageInputEntryContent$inboundSchema; - MessageInputEntryContent$2.outboundSchema = exports.MessageInputEntryContent$outboundSchema; - })(MessageInputEntryContent$ || (exports.MessageInputEntryContent$ = MessageInputEntryContent$ = {})); - function messageInputEntryContentToJSON(messageInputEntryContent) { - return JSON.stringify(exports.MessageInputEntryContent$outboundSchema.parse(messageInputEntryContent)); - } - function messageInputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntryContent' from JSON`); - } - exports.MessageInputEntry$inboundSchema = z.object({ - object: exports.ObjectT$inboundSchema.default("entry"), - type: exports.MessageInputEntryType$inboundSchema.default("message.input"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$inboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.MessageInputEntry$outboundSchema = z.object({ - object: exports.ObjectT$outboundSchema.default("entry"), - type: exports.MessageInputEntryType$outboundSchema.default("message.input"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$outboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var MessageInputEntry$; - (function(MessageInputEntry$2) { - MessageInputEntry$2.inboundSchema = exports.MessageInputEntry$inboundSchema; - MessageInputEntry$2.outboundSchema = exports.MessageInputEntry$outboundSchema; - })(MessageInputEntry$ || (exports.MessageInputEntry$ = MessageInputEntry$ = {})); - function messageInputEntryToJSON(messageInputEntry) { - return JSON.stringify(exports.MessageInputEntry$outboundSchema.parse(messageInputEntry)); - } - function messageInputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js - var require_toolreferencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolReferenceChunk$ = exports.ToolReferenceChunk$outboundSchema = exports.ToolReferenceChunk$inboundSchema = exports.ToolReferenceChunkType$ = exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema = exports.ToolReferenceChunkType = void 0; - exports.toolReferenceChunkToJSON = toolReferenceChunkToJSON; - exports.toolReferenceChunkFromJSON = toolReferenceChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolReferenceChunkType = { - ToolReference: "tool_reference" - }; - exports.ToolReferenceChunkType$inboundSchema = z.nativeEnum(exports.ToolReferenceChunkType); - exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema; - var ToolReferenceChunkType$; - (function(ToolReferenceChunkType$2) { - ToolReferenceChunkType$2.inboundSchema = exports.ToolReferenceChunkType$inboundSchema; - ToolReferenceChunkType$2.outboundSchema = exports.ToolReferenceChunkType$outboundSchema; - })(ToolReferenceChunkType$ || (exports.ToolReferenceChunkType$ = ToolReferenceChunkType$ = {})); - exports.ToolReferenceChunk$inboundSchema = z.object({ - type: exports.ToolReferenceChunkType$inboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.ToolReferenceChunk$outboundSchema = z.object({ - type: exports.ToolReferenceChunkType$outboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var ToolReferenceChunk$; - (function(ToolReferenceChunk$2) { - ToolReferenceChunk$2.inboundSchema = exports.ToolReferenceChunk$inboundSchema; - ToolReferenceChunk$2.outboundSchema = exports.ToolReferenceChunk$outboundSchema; - })(ToolReferenceChunk$ || (exports.ToolReferenceChunk$ = ToolReferenceChunk$ = {})); - function toolReferenceChunkToJSON(toolReferenceChunk) { - return JSON.stringify(exports.ToolReferenceChunk$outboundSchema.parse(toolReferenceChunk)); - } - function toolReferenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js - var require_messageoutputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputContentChunks$ = exports.MessageOutputContentChunks$outboundSchema = exports.MessageOutputContentChunks$inboundSchema = void 0; - exports.messageOutputContentChunksToJSON = messageOutputContentChunksToJSON; - exports.messageOutputContentChunksFromJSON = messageOutputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.MessageOutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageOutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageOutputContentChunks$; - (function(MessageOutputContentChunks$2) { - MessageOutputContentChunks$2.inboundSchema = exports.MessageOutputContentChunks$inboundSchema; - MessageOutputContentChunks$2.outboundSchema = exports.MessageOutputContentChunks$outboundSchema; - })(MessageOutputContentChunks$ || (exports.MessageOutputContentChunks$ = MessageOutputContentChunks$ = {})); - function messageOutputContentChunksToJSON(messageOutputContentChunks) { - return JSON.stringify(exports.MessageOutputContentChunks$outboundSchema.parse(messageOutputContentChunks)); - } - function messageOutputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputentry.js - var require_messageoutputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEntry$ = exports.MessageOutputEntry$outboundSchema = exports.MessageOutputEntry$inboundSchema = exports.MessageOutputEntryContent$ = exports.MessageOutputEntryContent$outboundSchema = exports.MessageOutputEntryContent$inboundSchema = exports.MessageOutputEntryRole$ = exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema = exports.MessageOutputEntryType$ = exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema = exports.MessageOutputEntryObject$ = exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema = exports.MessageOutputEntryRole = exports.MessageOutputEntryType = exports.MessageOutputEntryObject = void 0; - exports.messageOutputEntryContentToJSON = messageOutputEntryContentToJSON; - exports.messageOutputEntryContentFromJSON = messageOutputEntryContentFromJSON; - exports.messageOutputEntryToJSON = messageOutputEntryToJSON; - exports.messageOutputEntryFromJSON = messageOutputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageoutputcontentchunks_js_1 = require_messageoutputcontentchunks(); - exports.MessageOutputEntryObject = { - Entry: "entry" - }; - exports.MessageOutputEntryType = { - MessageOutput: "message.output" - }; - exports.MessageOutputEntryRole = { - Assistant: "assistant" - }; - exports.MessageOutputEntryObject$inboundSchema = z.nativeEnum(exports.MessageOutputEntryObject); - exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema; - var MessageOutputEntryObject$; - (function(MessageOutputEntryObject$2) { - MessageOutputEntryObject$2.inboundSchema = exports.MessageOutputEntryObject$inboundSchema; - MessageOutputEntryObject$2.outboundSchema = exports.MessageOutputEntryObject$outboundSchema; - })(MessageOutputEntryObject$ || (exports.MessageOutputEntryObject$ = MessageOutputEntryObject$ = {})); - exports.MessageOutputEntryType$inboundSchema = z.nativeEnum(exports.MessageOutputEntryType); - exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema; - var MessageOutputEntryType$; - (function(MessageOutputEntryType$2) { - MessageOutputEntryType$2.inboundSchema = exports.MessageOutputEntryType$inboundSchema; - MessageOutputEntryType$2.outboundSchema = exports.MessageOutputEntryType$outboundSchema; - })(MessageOutputEntryType$ || (exports.MessageOutputEntryType$ = MessageOutputEntryType$ = {})); - exports.MessageOutputEntryRole$inboundSchema = z.nativeEnum(exports.MessageOutputEntryRole); - exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema; - var MessageOutputEntryRole$; - (function(MessageOutputEntryRole$2) { - MessageOutputEntryRole$2.inboundSchema = exports.MessageOutputEntryRole$inboundSchema; - MessageOutputEntryRole$2.outboundSchema = exports.MessageOutputEntryRole$outboundSchema; - })(MessageOutputEntryRole$ || (exports.MessageOutputEntryRole$ = MessageOutputEntryRole$ = {})); - exports.MessageOutputEntryContent$inboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema)]); - exports.MessageOutputEntryContent$outboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema)]); - var MessageOutputEntryContent$; - (function(MessageOutputEntryContent$2) { - MessageOutputEntryContent$2.inboundSchema = exports.MessageOutputEntryContent$inboundSchema; - MessageOutputEntryContent$2.outboundSchema = exports.MessageOutputEntryContent$outboundSchema; - })(MessageOutputEntryContent$ || (exports.MessageOutputEntryContent$ = MessageOutputEntryContent$ = {})); - function messageOutputEntryContentToJSON(messageOutputEntryContent) { - return JSON.stringify(exports.MessageOutputEntryContent$outboundSchema.parse(messageOutputEntryContent)); - } - function messageOutputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntryContent' from JSON`); - } - exports.MessageOutputEntry$inboundSchema = z.object({ - object: exports.MessageOutputEntryObject$inboundSchema.default("entry"), - type: exports.MessageOutputEntryType$inboundSchema.default("message.output"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$inboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEntry$outboundSchema = z.object({ - object: exports.MessageOutputEntryObject$outboundSchema.default("entry"), - type: exports.MessageOutputEntryType$outboundSchema.default("message.output"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$outboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - agentId: "agent_id" - }); - }); - var MessageOutputEntry$; - (function(MessageOutputEntry$2) { - MessageOutputEntry$2.inboundSchema = exports.MessageOutputEntry$inboundSchema; - MessageOutputEntry$2.outboundSchema = exports.MessageOutputEntry$outboundSchema; - })(MessageOutputEntry$ || (exports.MessageOutputEntry$ = MessageOutputEntry$ = {})); - function messageOutputEntryToJSON(messageOutputEntry) { - return JSON.stringify(exports.MessageOutputEntry$outboundSchema.parse(messageOutputEntry)); - } - function messageOutputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js - var require_toolexecutionentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionEntry$ = exports.ToolExecutionEntry$outboundSchema = exports.ToolExecutionEntry$inboundSchema = exports.ToolExecutionEntryType$ = exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema = exports.ToolExecutionEntryObject$ = exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema = exports.ToolExecutionEntryType = exports.ToolExecutionEntryObject = void 0; - exports.toolExecutionEntryToJSON = toolExecutionEntryToJSON; - exports.toolExecutionEntryFromJSON = toolExecutionEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionEntryObject = { - Entry: "entry" - }; - exports.ToolExecutionEntryType = { - ToolExecution: "tool.execution" - }; - exports.ToolExecutionEntryObject$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryObject); - exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - var ToolExecutionEntryObject$; - (function(ToolExecutionEntryObject$2) { - ToolExecutionEntryObject$2.inboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - ToolExecutionEntryObject$2.outboundSchema = exports.ToolExecutionEntryObject$outboundSchema; - })(ToolExecutionEntryObject$ || (exports.ToolExecutionEntryObject$ = ToolExecutionEntryObject$ = {})); - exports.ToolExecutionEntryType$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryType); - exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema; - var ToolExecutionEntryType$; - (function(ToolExecutionEntryType$2) { - ToolExecutionEntryType$2.inboundSchema = exports.ToolExecutionEntryType$inboundSchema; - ToolExecutionEntryType$2.outboundSchema = exports.ToolExecutionEntryType$outboundSchema; - })(ToolExecutionEntryType$ || (exports.ToolExecutionEntryType$ = ToolExecutionEntryType$ = {})); - exports.ToolExecutionEntry$inboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$inboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$inboundSchema.default("tool.execution"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.ToolExecutionEntry$outboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$outboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$outboundSchema.default("tool.execution"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var ToolExecutionEntry$; - (function(ToolExecutionEntry$2) { - ToolExecutionEntry$2.inboundSchema = exports.ToolExecutionEntry$inboundSchema; - ToolExecutionEntry$2.outboundSchema = exports.ToolExecutionEntry$outboundSchema; - })(ToolExecutionEntry$ || (exports.ToolExecutionEntry$ = ToolExecutionEntry$ = {})); - function toolExecutionEntryToJSON(toolExecutionEntry) { - return JSON.stringify(exports.ToolExecutionEntry$outboundSchema.parse(toolExecutionEntry)); - } - function toolExecutionEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputentries.js - var require_inputentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InputEntries$ = exports.InputEntries$outboundSchema = exports.InputEntries$inboundSchema = void 0; - exports.inputEntriesToJSON = inputEntriesToJSON; - exports.inputEntriesFromJSON = inputEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.InputEntries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.InputEntries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var InputEntries$; - (function(InputEntries$2) { - InputEntries$2.inboundSchema = exports.InputEntries$inboundSchema; - InputEntries$2.outboundSchema = exports.InputEntries$outboundSchema; - })(InputEntries$ || (exports.InputEntries$ = InputEntries$ = {})); - function inputEntriesToJSON(inputEntries) { - return JSON.stringify(exports.InputEntries$outboundSchema.parse(inputEntries)); - } - function inputEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InputEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InputEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationinputs.js - var require_conversationinputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationinputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationInputs$ = exports.ConversationInputs$outboundSchema = exports.ConversationInputs$inboundSchema = void 0; - exports.conversationInputsToJSON = conversationInputsToJSON; - exports.conversationInputsFromJSON = conversationInputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var inputentries_js_1 = require_inputentries(); - exports.ConversationInputs$inboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$inboundSchema)]); - exports.ConversationInputs$outboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$outboundSchema)]); - var ConversationInputs$; - (function(ConversationInputs$2) { - ConversationInputs$2.inboundSchema = exports.ConversationInputs$inboundSchema; - ConversationInputs$2.outboundSchema = exports.ConversationInputs$outboundSchema; - })(ConversationInputs$ || (exports.ConversationInputs$ = ConversationInputs$ = {})); - function conversationInputsToJSON(conversationInputs) { - return JSON.stringify(exports.ConversationInputs$outboundSchema.parse(conversationInputs)); - } - function conversationInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationInputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js - var require_conversationappendrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendRequest$ = exports.ConversationAppendRequest$outboundSchema = exports.ConversationAppendRequest$inboundSchema = exports.ConversationAppendRequestHandoffExecution$ = exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema = exports.ConversationAppendRequestHandoffExecution = void 0; - exports.conversationAppendRequestToJSON = conversationAppendRequestToJSON; - exports.conversationAppendRequestFromJSON = conversationAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendRequestHandoffExecution); - exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - var ConversationAppendRequestHandoffExecution$; - (function(ConversationAppendRequestHandoffExecution$2) { - ConversationAppendRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - ConversationAppendRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendRequestHandoffExecution$outboundSchema; - })(ConversationAppendRequestHandoffExecution$ || (exports.ConversationAppendRequestHandoffExecution$ = ConversationAppendRequestHandoffExecution$ = {})); - exports.ConversationAppendRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendRequest$; - (function(ConversationAppendRequest$2) { - ConversationAppendRequest$2.inboundSchema = exports.ConversationAppendRequest$inboundSchema; - ConversationAppendRequest$2.outboundSchema = exports.ConversationAppendRequest$outboundSchema; - })(ConversationAppendRequest$ || (exports.ConversationAppendRequest$ = ConversationAppendRequest$ = {})); - function conversationAppendRequestToJSON(conversationAppendRequest) { - return JSON.stringify(exports.ConversationAppendRequest$outboundSchema.parse(conversationAppendRequest)); - } - function conversationAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js - var require_conversationappendstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendStreamRequest$ = exports.ConversationAppendStreamRequest$outboundSchema = exports.ConversationAppendStreamRequest$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$ = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution = void 0; - exports.conversationAppendStreamRequestToJSON = conversationAppendStreamRequestToJSON; - exports.conversationAppendStreamRequestFromJSON = conversationAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendStreamRequestHandoffExecution); - exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - var ConversationAppendStreamRequestHandoffExecution$; - (function(ConversationAppendStreamRequestHandoffExecution$2) { - ConversationAppendStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - ConversationAppendStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema; - })(ConversationAppendStreamRequestHandoffExecution$ || (exports.ConversationAppendStreamRequestHandoffExecution$ = ConversationAppendStreamRequestHandoffExecution$ = {})); - exports.ConversationAppendStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendStreamRequest$; - (function(ConversationAppendStreamRequest$2) { - ConversationAppendStreamRequest$2.inboundSchema = exports.ConversationAppendStreamRequest$inboundSchema; - ConversationAppendStreamRequest$2.outboundSchema = exports.ConversationAppendStreamRequest$outboundSchema; - })(ConversationAppendStreamRequest$ || (exports.ConversationAppendStreamRequest$ = ConversationAppendStreamRequest$ = {})); - function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest) { - return JSON.stringify(exports.ConversationAppendStreamRequest$outboundSchema.parse(conversationAppendStreamRequest)); - } - function conversationAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallevent.js - var require_functioncallevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEvent$ = exports.FunctionCallEvent$outboundSchema = exports.FunctionCallEvent$inboundSchema = exports.FunctionCallEventType$ = exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema = exports.FunctionCallEventType = void 0; - exports.functionCallEventToJSON = functionCallEventToJSON; - exports.functionCallEventFromJSON = functionCallEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEventType = { - FunctionCallDelta: "function.call.delta" - }; - exports.FunctionCallEventType$inboundSchema = z.nativeEnum(exports.FunctionCallEventType); - exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema; - var FunctionCallEventType$; - (function(FunctionCallEventType$2) { - FunctionCallEventType$2.inboundSchema = exports.FunctionCallEventType$inboundSchema; - FunctionCallEventType$2.outboundSchema = exports.FunctionCallEventType$outboundSchema; - })(FunctionCallEventType$ || (exports.FunctionCallEventType$ = FunctionCallEventType$ = {})); - exports.FunctionCallEvent$inboundSchema = z.object({ - type: exports.FunctionCallEventType$inboundSchema.default("function.call.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: z.string(), - tool_call_id: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEvent$outboundSchema = z.object({ - type: exports.FunctionCallEventType$outboundSchema.default("function.call.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: z.string(), - toolCallId: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEvent$; - (function(FunctionCallEvent$2) { - FunctionCallEvent$2.inboundSchema = exports.FunctionCallEvent$inboundSchema; - FunctionCallEvent$2.outboundSchema = exports.FunctionCallEvent$outboundSchema; - })(FunctionCallEvent$ || (exports.FunctionCallEvent$ = FunctionCallEvent$ = {})); - function functionCallEventToJSON(functionCallEvent) { - return JSON.stringify(exports.FunctionCallEvent$outboundSchema.parse(functionCallEvent)); - } - function functionCallEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js - var require_outputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OutputContentChunks$ = exports.OutputContentChunks$outboundSchema = exports.OutputContentChunks$inboundSchema = void 0; - exports.outputContentChunksToJSON = outputContentChunksToJSON; - exports.outputContentChunksFromJSON = outputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.OutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.OutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var OutputContentChunks$; - (function(OutputContentChunks$2) { - OutputContentChunks$2.inboundSchema = exports.OutputContentChunks$inboundSchema; - OutputContentChunks$2.outboundSchema = exports.OutputContentChunks$outboundSchema; - })(OutputContentChunks$ || (exports.OutputContentChunks$ = OutputContentChunks$ = {})); - function outputContentChunksToJSON(outputContentChunks) { - return JSON.stringify(exports.OutputContentChunks$outboundSchema.parse(outputContentChunks)); - } - function outputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputevent.js - var require_messageoutputevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEvent$ = exports.MessageOutputEvent$outboundSchema = exports.MessageOutputEvent$inboundSchema = exports.MessageOutputEventContent$ = exports.MessageOutputEventContent$outboundSchema = exports.MessageOutputEventContent$inboundSchema = exports.MessageOutputEventRole$ = exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema = exports.MessageOutputEventType$ = exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema = exports.MessageOutputEventRole = exports.MessageOutputEventType = void 0; - exports.messageOutputEventContentToJSON = messageOutputEventContentToJSON; - exports.messageOutputEventContentFromJSON = messageOutputEventContentFromJSON; - exports.messageOutputEventToJSON = messageOutputEventToJSON; - exports.messageOutputEventFromJSON = messageOutputEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var outputcontentchunks_js_1 = require_outputcontentchunks(); - exports.MessageOutputEventType = { - MessageOutputDelta: "message.output.delta" - }; - exports.MessageOutputEventRole = { - Assistant: "assistant" - }; - exports.MessageOutputEventType$inboundSchema = z.nativeEnum(exports.MessageOutputEventType); - exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema; - var MessageOutputEventType$; - (function(MessageOutputEventType$2) { - MessageOutputEventType$2.inboundSchema = exports.MessageOutputEventType$inboundSchema; - MessageOutputEventType$2.outboundSchema = exports.MessageOutputEventType$outboundSchema; - })(MessageOutputEventType$ || (exports.MessageOutputEventType$ = MessageOutputEventType$ = {})); - exports.MessageOutputEventRole$inboundSchema = z.nativeEnum(exports.MessageOutputEventRole); - exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema; - var MessageOutputEventRole$; - (function(MessageOutputEventRole$2) { - MessageOutputEventRole$2.inboundSchema = exports.MessageOutputEventRole$inboundSchema; - MessageOutputEventRole$2.outboundSchema = exports.MessageOutputEventRole$outboundSchema; - })(MessageOutputEventRole$ || (exports.MessageOutputEventRole$ = MessageOutputEventRole$ = {})); - exports.MessageOutputEventContent$inboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]); - exports.MessageOutputEventContent$outboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]); - var MessageOutputEventContent$; - (function(MessageOutputEventContent$2) { - MessageOutputEventContent$2.inboundSchema = exports.MessageOutputEventContent$inboundSchema; - MessageOutputEventContent$2.outboundSchema = exports.MessageOutputEventContent$outboundSchema; - })(MessageOutputEventContent$ || (exports.MessageOutputEventContent$ = MessageOutputEventContent$ = {})); - function messageOutputEventContentToJSON(messageOutputEventContent) { - return JSON.stringify(exports.MessageOutputEventContent$outboundSchema.parse(messageOutputEventContent)); - } - function messageOutputEventContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEventContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEventContent' from JSON`); - } - exports.MessageOutputEvent$inboundSchema = z.object({ - type: exports.MessageOutputEventType$inboundSchema.default("message.output.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - content_index: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$inboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "content_index": "contentIndex", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEvent$outboundSchema = z.object({ - type: exports.MessageOutputEventType$outboundSchema.default("message.output.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - contentIndex: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$outboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - contentIndex: "content_index", - agentId: "agent_id" - }); - }); - var MessageOutputEvent$; - (function(MessageOutputEvent$2) { - MessageOutputEvent$2.inboundSchema = exports.MessageOutputEvent$inboundSchema; - MessageOutputEvent$2.outboundSchema = exports.MessageOutputEvent$outboundSchema; - })(MessageOutputEvent$ || (exports.MessageOutputEvent$ = MessageOutputEvent$ = {})); - function messageOutputEventToJSON(messageOutputEvent) { - return JSON.stringify(exports.MessageOutputEvent$outboundSchema.parse(messageOutputEvent)); - } - function messageOutputEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js - var require_conversationusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationUsageInfo$ = exports.ConversationUsageInfo$outboundSchema = exports.ConversationUsageInfo$inboundSchema = void 0; - exports.conversationUsageInfoToJSON = conversationUsageInfoToJSON; - exports.conversationUsageInfoFromJSON = conversationUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ConversationUsageInfo$inboundSchema = z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - connector_tokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "connector_tokens": "connectorTokens" - }); - }); - exports.ConversationUsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - connectorTokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - connectorTokens: "connector_tokens" - }); - }); - var ConversationUsageInfo$; - (function(ConversationUsageInfo$2) { - ConversationUsageInfo$2.inboundSchema = exports.ConversationUsageInfo$inboundSchema; - ConversationUsageInfo$2.outboundSchema = exports.ConversationUsageInfo$outboundSchema; - })(ConversationUsageInfo$ || (exports.ConversationUsageInfo$ = ConversationUsageInfo$ = {})); - function conversationUsageInfoToJSON(conversationUsageInfo) { - return JSON.stringify(exports.ConversationUsageInfo$outboundSchema.parse(conversationUsageInfo)); - } - function conversationUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsedoneevent.js - var require_responsedoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsedoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseDoneEvent$ = exports.ResponseDoneEvent$outboundSchema = exports.ResponseDoneEvent$inboundSchema = exports.ResponseDoneEventType$ = exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema = exports.ResponseDoneEventType = void 0; - exports.responseDoneEventToJSON = responseDoneEventToJSON; - exports.responseDoneEventFromJSON = responseDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - exports.ResponseDoneEventType = { - ConversationResponseDone: "conversation.response.done" - }; - exports.ResponseDoneEventType$inboundSchema = z.nativeEnum(exports.ResponseDoneEventType); - exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema; - var ResponseDoneEventType$; - (function(ResponseDoneEventType$2) { - ResponseDoneEventType$2.inboundSchema = exports.ResponseDoneEventType$inboundSchema; - ResponseDoneEventType$2.outboundSchema = exports.ResponseDoneEventType$outboundSchema; - })(ResponseDoneEventType$ || (exports.ResponseDoneEventType$ = ResponseDoneEventType$ = {})); - exports.ResponseDoneEvent$inboundSchema = z.object({ - type: exports.ResponseDoneEventType$inboundSchema.default("conversation.response.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseDoneEvent$outboundSchema = z.object({ - type: exports.ResponseDoneEventType$outboundSchema.default("conversation.response.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseDoneEvent$; - (function(ResponseDoneEvent$2) { - ResponseDoneEvent$2.inboundSchema = exports.ResponseDoneEvent$inboundSchema; - ResponseDoneEvent$2.outboundSchema = exports.ResponseDoneEvent$outboundSchema; - })(ResponseDoneEvent$ || (exports.ResponseDoneEvent$ = ResponseDoneEvent$ = {})); - function responseDoneEventToJSON(responseDoneEvent) { - return JSON.stringify(exports.ResponseDoneEvent$outboundSchema.parse(responseDoneEvent)); - } - function responseDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseerrorevent.js - var require_responseerrorevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseerrorevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseErrorEvent$ = exports.ResponseErrorEvent$outboundSchema = exports.ResponseErrorEvent$inboundSchema = exports.ResponseErrorEventType$ = exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema = exports.ResponseErrorEventType = void 0; - exports.responseErrorEventToJSON = responseErrorEventToJSON; - exports.responseErrorEventFromJSON = responseErrorEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseErrorEventType = { - ConversationResponseError: "conversation.response.error" - }; - exports.ResponseErrorEventType$inboundSchema = z.nativeEnum(exports.ResponseErrorEventType); - exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema; - var ResponseErrorEventType$; - (function(ResponseErrorEventType$2) { - ResponseErrorEventType$2.inboundSchema = exports.ResponseErrorEventType$inboundSchema; - ResponseErrorEventType$2.outboundSchema = exports.ResponseErrorEventType$outboundSchema; - })(ResponseErrorEventType$ || (exports.ResponseErrorEventType$ = ResponseErrorEventType$ = {})); - exports.ResponseErrorEvent$inboundSchema = z.object({ - type: exports.ResponseErrorEventType$inboundSchema.default("conversation.response.error"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseErrorEvent$outboundSchema = z.object({ - type: exports.ResponseErrorEventType$outboundSchema.default("conversation.response.error"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseErrorEvent$; - (function(ResponseErrorEvent$2) { - ResponseErrorEvent$2.inboundSchema = exports.ResponseErrorEvent$inboundSchema; - ResponseErrorEvent$2.outboundSchema = exports.ResponseErrorEvent$outboundSchema; - })(ResponseErrorEvent$ || (exports.ResponseErrorEvent$ = ResponseErrorEvent$ = {})); - function responseErrorEventToJSON(responseErrorEvent) { - return JSON.stringify(exports.ResponseErrorEvent$outboundSchema.parse(responseErrorEvent)); - } - function responseErrorEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseErrorEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseErrorEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsestartedevent.js - var require_responsestartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsestartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseStartedEvent$ = exports.ResponseStartedEvent$outboundSchema = exports.ResponseStartedEvent$inboundSchema = exports.ResponseStartedEventType$ = exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema = exports.ResponseStartedEventType = void 0; - exports.responseStartedEventToJSON = responseStartedEventToJSON; - exports.responseStartedEventFromJSON = responseStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseStartedEventType = { - ConversationResponseStarted: "conversation.response.started" - }; - exports.ResponseStartedEventType$inboundSchema = z.nativeEnum(exports.ResponseStartedEventType); - exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema; - var ResponseStartedEventType$; - (function(ResponseStartedEventType$2) { - ResponseStartedEventType$2.inboundSchema = exports.ResponseStartedEventType$inboundSchema; - ResponseStartedEventType$2.outboundSchema = exports.ResponseStartedEventType$outboundSchema; - })(ResponseStartedEventType$ || (exports.ResponseStartedEventType$ = ResponseStartedEventType$ = {})); - exports.ResponseStartedEvent$inboundSchema = z.object({ - type: exports.ResponseStartedEventType$inboundSchema.default("conversation.response.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "conversation_id": "conversationId" - }); - }); - exports.ResponseStartedEvent$outboundSchema = z.object({ - type: exports.ResponseStartedEventType$outboundSchema.default("conversation.response.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - conversationId: "conversation_id" - }); - }); - var ResponseStartedEvent$; - (function(ResponseStartedEvent$2) { - ResponseStartedEvent$2.inboundSchema = exports.ResponseStartedEvent$inboundSchema; - ResponseStartedEvent$2.outboundSchema = exports.ResponseStartedEvent$outboundSchema; - })(ResponseStartedEvent$ || (exports.ResponseStartedEvent$ = ResponseStartedEvent$ = {})); - function responseStartedEventToJSON(responseStartedEvent) { - return JSON.stringify(exports.ResponseStartedEvent$outboundSchema.parse(responseStartedEvent)); - } - function responseStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ssetypes.js - var require_ssetypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ssetypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SSETypes$ = exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema = exports.SSETypes = void 0; - var z = __importStar(require_zod()); - exports.SSETypes = { - ConversationResponseStarted: "conversation.response.started", - ConversationResponseDone: "conversation.response.done", - ConversationResponseError: "conversation.response.error", - MessageOutputDelta: "message.output.delta", - ToolExecutionStarted: "tool.execution.started", - ToolExecutionDelta: "tool.execution.delta", - ToolExecutionDone: "tool.execution.done", - AgentHandoffStarted: "agent.handoff.started", - AgentHandoffDone: "agent.handoff.done", - FunctionCallDelta: "function.call.delta" - }; - exports.SSETypes$inboundSchema = z.nativeEnum(exports.SSETypes); - exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema; - var SSETypes$; - (function(SSETypes$2) { - SSETypes$2.inboundSchema = exports.SSETypes$inboundSchema; - SSETypes$2.outboundSchema = exports.SSETypes$outboundSchema; - })(SSETypes$ || (exports.SSETypes$ = SSETypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js - var require_toolexecutiondeltaevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDeltaEvent$ = exports.ToolExecutionDeltaEvent$outboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema = exports.ToolExecutionDeltaEventType$ = exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema = exports.ToolExecutionDeltaEventType = void 0; - exports.toolExecutionDeltaEventToJSON = toolExecutionDeltaEventToJSON; - exports.toolExecutionDeltaEventFromJSON = toolExecutionDeltaEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDeltaEventType = { - ToolExecutionDelta: "tool.execution.delta" - }; - exports.ToolExecutionDeltaEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDeltaEventType); - exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - var ToolExecutionDeltaEventType$; - (function(ToolExecutionDeltaEventType$2) { - ToolExecutionDeltaEventType$2.inboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - ToolExecutionDeltaEventType$2.outboundSchema = exports.ToolExecutionDeltaEventType$outboundSchema; - })(ToolExecutionDeltaEventType$ || (exports.ToolExecutionDeltaEventType$ = ToolExecutionDeltaEventType$ = {})); - exports.ToolExecutionDeltaEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$inboundSchema.default("tool.execution.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDeltaEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$outboundSchema.default("tool.execution.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDeltaEvent$; - (function(ToolExecutionDeltaEvent$2) { - ToolExecutionDeltaEvent$2.inboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema; - ToolExecutionDeltaEvent$2.outboundSchema = exports.ToolExecutionDeltaEvent$outboundSchema; - })(ToolExecutionDeltaEvent$ || (exports.ToolExecutionDeltaEvent$ = ToolExecutionDeltaEvent$ = {})); - function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent) { - return JSON.stringify(exports.ToolExecutionDeltaEvent$outboundSchema.parse(toolExecutionDeltaEvent)); - } - function toolExecutionDeltaEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDeltaEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDeltaEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js - var require_toolexecutiondoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDoneEvent$ = exports.ToolExecutionDoneEvent$outboundSchema = exports.ToolExecutionDoneEvent$inboundSchema = exports.ToolExecutionDoneEventType$ = exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema = exports.ToolExecutionDoneEventType = void 0; - exports.toolExecutionDoneEventToJSON = toolExecutionDoneEventToJSON; - exports.toolExecutionDoneEventFromJSON = toolExecutionDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDoneEventType = { - ToolExecutionDone: "tool.execution.done" - }; - exports.ToolExecutionDoneEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDoneEventType); - exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - var ToolExecutionDoneEventType$; - (function(ToolExecutionDoneEventType$2) { - ToolExecutionDoneEventType$2.inboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - ToolExecutionDoneEventType$2.outboundSchema = exports.ToolExecutionDoneEventType$outboundSchema; - })(ToolExecutionDoneEventType$ || (exports.ToolExecutionDoneEventType$ = ToolExecutionDoneEventType$ = {})); - exports.ToolExecutionDoneEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$inboundSchema.default("tool.execution.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDoneEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$outboundSchema.default("tool.execution.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDoneEvent$; - (function(ToolExecutionDoneEvent$2) { - ToolExecutionDoneEvent$2.inboundSchema = exports.ToolExecutionDoneEvent$inboundSchema; - ToolExecutionDoneEvent$2.outboundSchema = exports.ToolExecutionDoneEvent$outboundSchema; - })(ToolExecutionDoneEvent$ || (exports.ToolExecutionDoneEvent$ = ToolExecutionDoneEvent$ = {})); - function toolExecutionDoneEventToJSON(toolExecutionDoneEvent) { - return JSON.stringify(exports.ToolExecutionDoneEvent$outboundSchema.parse(toolExecutionDoneEvent)); - } - function toolExecutionDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js - var require_toolexecutionstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionStartedEvent$ = exports.ToolExecutionStartedEvent$outboundSchema = exports.ToolExecutionStartedEvent$inboundSchema = exports.ToolExecutionStartedEventType$ = exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema = exports.ToolExecutionStartedEventType = void 0; - exports.toolExecutionStartedEventToJSON = toolExecutionStartedEventToJSON; - exports.toolExecutionStartedEventFromJSON = toolExecutionStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionStartedEventType = { - ToolExecutionStarted: "tool.execution.started" - }; - exports.ToolExecutionStartedEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionStartedEventType); - exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - var ToolExecutionStartedEventType$; - (function(ToolExecutionStartedEventType$2) { - ToolExecutionStartedEventType$2.inboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - ToolExecutionStartedEventType$2.outboundSchema = exports.ToolExecutionStartedEventType$outboundSchema; - })(ToolExecutionStartedEventType$ || (exports.ToolExecutionStartedEventType$ = ToolExecutionStartedEventType$ = {})); - exports.ToolExecutionStartedEvent$inboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$inboundSchema.default("tool.execution.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionStartedEvent$outboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$outboundSchema.default("tool.execution.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionStartedEvent$; - (function(ToolExecutionStartedEvent$2) { - ToolExecutionStartedEvent$2.inboundSchema = exports.ToolExecutionStartedEvent$inboundSchema; - ToolExecutionStartedEvent$2.outboundSchema = exports.ToolExecutionStartedEvent$outboundSchema; - })(ToolExecutionStartedEvent$ || (exports.ToolExecutionStartedEvent$ = ToolExecutionStartedEvent$ = {})); - function toolExecutionStartedEventToJSON(toolExecutionStartedEvent) { - return JSON.stringify(exports.ToolExecutionStartedEvent$outboundSchema.parse(toolExecutionStartedEvent)); - } - function toolExecutionStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationevents.js - var require_conversationevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationEvents$ = exports.ConversationEvents$outboundSchema = exports.ConversationEvents$inboundSchema = exports.ConversationEventsData$ = exports.ConversationEventsData$outboundSchema = exports.ConversationEventsData$inboundSchema = void 0; - exports.conversationEventsDataToJSON = conversationEventsDataToJSON; - exports.conversationEventsDataFromJSON = conversationEventsDataFromJSON; - exports.conversationEventsToJSON = conversationEventsToJSON; - exports.conversationEventsFromJSON = conversationEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffdoneevent_js_1 = require_agenthandoffdoneevent(); - var agenthandoffstartedevent_js_1 = require_agenthandoffstartedevent(); - var functioncallevent_js_1 = require_functioncallevent(); - var messageoutputevent_js_1 = require_messageoutputevent(); - var responsedoneevent_js_1 = require_responsedoneevent(); - var responseerrorevent_js_1 = require_responseerrorevent(); - var responsestartedevent_js_1 = require_responsestartedevent(); - var ssetypes_js_1 = require_ssetypes(); - var toolexecutiondeltaevent_js_1 = require_toolexecutiondeltaevent(); - var toolexecutiondoneevent_js_1 = require_toolexecutiondoneevent(); - var toolexecutionstartedevent_js_1 = require_toolexecutionstartedevent(); - exports.ConversationEventsData$inboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - exports.ConversationEventsData$outboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - var ConversationEventsData$; - (function(ConversationEventsData$2) { - ConversationEventsData$2.inboundSchema = exports.ConversationEventsData$inboundSchema; - ConversationEventsData$2.outboundSchema = exports.ConversationEventsData$outboundSchema; - })(ConversationEventsData$ || (exports.ConversationEventsData$ = ConversationEventsData$ = {})); - function conversationEventsDataToJSON(conversationEventsData) { - return JSON.stringify(exports.ConversationEventsData$outboundSchema.parse(conversationEventsData)); - } - function conversationEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEventsData' from JSON`); - } - exports.ConversationEvents$inboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ type: v.type }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ type: v.type }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ type: v.type }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.ConversationEvents$outboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$outboundSchema, - data: z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]) - }); - var ConversationEvents$; - (function(ConversationEvents$2) { - ConversationEvents$2.inboundSchema = exports.ConversationEvents$inboundSchema; - ConversationEvents$2.outboundSchema = exports.ConversationEvents$outboundSchema; - })(ConversationEvents$ || (exports.ConversationEvents$ = ConversationEvents$ = {})); - function conversationEventsToJSON(conversationEvents) { - return JSON.stringify(exports.ConversationEvents$outboundSchema.parse(conversationEvents)); - } - function conversationEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationhistory.js - var require_conversationhistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationhistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationHistory$ = exports.ConversationHistory$outboundSchema = exports.ConversationHistory$inboundSchema = exports.Entries$ = exports.Entries$outboundSchema = exports.Entries$inboundSchema = exports.ConversationHistoryObject$ = exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema = exports.ConversationHistoryObject = void 0; - exports.entriesToJSON = entriesToJSON; - exports.entriesFromJSON = entriesFromJSON; - exports.conversationHistoryToJSON = conversationHistoryToJSON; - exports.conversationHistoryFromJSON = conversationHistoryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationHistoryObject = { - ConversationHistory: "conversation.history" - }; - exports.ConversationHistoryObject$inboundSchema = z.nativeEnum(exports.ConversationHistoryObject); - exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema; - var ConversationHistoryObject$; - (function(ConversationHistoryObject$2) { - ConversationHistoryObject$2.inboundSchema = exports.ConversationHistoryObject$inboundSchema; - ConversationHistoryObject$2.outboundSchema = exports.ConversationHistoryObject$outboundSchema; - })(ConversationHistoryObject$ || (exports.ConversationHistoryObject$ = ConversationHistoryObject$ = {})); - exports.Entries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Entries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Entries$; - (function(Entries$2) { - Entries$2.inboundSchema = exports.Entries$inboundSchema; - Entries$2.outboundSchema = exports.Entries$outboundSchema; - })(Entries$ || (exports.Entries$ = Entries$ = {})); - function entriesToJSON(entries) { - return JSON.stringify(exports.Entries$outboundSchema.parse(entries)); - } - function entriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Entries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Entries' from JSON`); - } - exports.ConversationHistory$inboundSchema = z.object({ - object: exports.ConversationHistoryObject$inboundSchema.default("conversation.history"), - conversation_id: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationHistory$outboundSchema = z.object({ - object: exports.ConversationHistoryObject$outboundSchema.default("conversation.history"), - conversationId: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationHistory$; - (function(ConversationHistory$2) { - ConversationHistory$2.inboundSchema = exports.ConversationHistory$inboundSchema; - ConversationHistory$2.outboundSchema = exports.ConversationHistory$outboundSchema; - })(ConversationHistory$ || (exports.ConversationHistory$ = ConversationHistory$ = {})); - function conversationHistoryToJSON(conversationHistory) { - return JSON.stringify(exports.ConversationHistory$outboundSchema.parse(conversationHistory)); - } - function conversationHistoryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationHistory$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationHistory' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageentries.js - var require_messageentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageEntries$ = exports.MessageEntries$outboundSchema = exports.MessageEntries$inboundSchema = void 0; - exports.messageEntriesToJSON = messageEntriesToJSON; - exports.messageEntriesFromJSON = messageEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - exports.MessageEntries$inboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.MessageEntries$outboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var MessageEntries$; - (function(MessageEntries$2) { - MessageEntries$2.inboundSchema = exports.MessageEntries$inboundSchema; - MessageEntries$2.outboundSchema = exports.MessageEntries$outboundSchema; - })(MessageEntries$ || (exports.MessageEntries$ = MessageEntries$ = {})); - function messageEntriesToJSON(messageEntries) { - return JSON.stringify(exports.MessageEntries$outboundSchema.parse(messageEntries)); - } - function messageEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationmessages.js - var require_conversationmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationMessages$ = exports.ConversationMessages$outboundSchema = exports.ConversationMessages$inboundSchema = exports.ConversationMessagesObject$ = exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema = exports.ConversationMessagesObject = void 0; - exports.conversationMessagesToJSON = conversationMessagesToJSON; - exports.conversationMessagesFromJSON = conversationMessagesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageentries_js_1 = require_messageentries(); - exports.ConversationMessagesObject = { - ConversationMessages: "conversation.messages" - }; - exports.ConversationMessagesObject$inboundSchema = z.nativeEnum(exports.ConversationMessagesObject); - exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema; - var ConversationMessagesObject$; - (function(ConversationMessagesObject$2) { - ConversationMessagesObject$2.inboundSchema = exports.ConversationMessagesObject$inboundSchema; - ConversationMessagesObject$2.outboundSchema = exports.ConversationMessagesObject$outboundSchema; - })(ConversationMessagesObject$ || (exports.ConversationMessagesObject$ = ConversationMessagesObject$ = {})); - exports.ConversationMessages$inboundSchema = z.object({ - object: exports.ConversationMessagesObject$inboundSchema.default("conversation.messages"), - conversation_id: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationMessages$outboundSchema = z.object({ - object: exports.ConversationMessagesObject$outboundSchema.default("conversation.messages"), - conversationId: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationMessages$; - (function(ConversationMessages$2) { - ConversationMessages$2.inboundSchema = exports.ConversationMessages$inboundSchema; - ConversationMessages$2.outboundSchema = exports.ConversationMessages$outboundSchema; - })(ConversationMessages$ || (exports.ConversationMessages$ = ConversationMessages$ = {})); - function conversationMessagesToJSON(conversationMessages) { - return JSON.stringify(exports.ConversationMessages$outboundSchema.parse(conversationMessages)); - } - function conversationMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationMessages' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrequest.js - var require_conversationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRequest$ = exports.ConversationRequest$outboundSchema = exports.ConversationRequest$inboundSchema = exports.Tools$ = exports.Tools$outboundSchema = exports.Tools$inboundSchema = exports.HandoffExecution$ = exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema = exports.HandoffExecution = void 0; - exports.toolsToJSON = toolsToJSON; - exports.toolsFromJSON = toolsFromJSON; - exports.conversationRequestToJSON = conversationRequestToJSON; - exports.conversationRequestFromJSON = conversationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.HandoffExecution = { - Client: "client", - Server: "server" - }; - exports.HandoffExecution$inboundSchema = z.nativeEnum(exports.HandoffExecution); - exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema; - var HandoffExecution$; - (function(HandoffExecution$2) { - HandoffExecution$2.inboundSchema = exports.HandoffExecution$inboundSchema; - HandoffExecution$2.outboundSchema = exports.HandoffExecution$outboundSchema; - })(HandoffExecution$ || (exports.HandoffExecution$ = HandoffExecution$ = {})); - exports.Tools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Tools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var Tools$; - (function(Tools$2) { - Tools$2.inboundSchema = exports.Tools$inboundSchema; - Tools$2.outboundSchema = exports.Tools$outboundSchema; - })(Tools$ || (exports.Tools$ = Tools$ = {})); - function toolsToJSON(tools) { - return JSON.stringify(exports.Tools$outboundSchema.parse(tools)); - } - function toolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tools' from JSON`); - } - exports.ConversationRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.HandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.HandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationRequest$; - (function(ConversationRequest$2) { - ConversationRequest$2.inboundSchema = exports.ConversationRequest$inboundSchema; - ConversationRequest$2.outboundSchema = exports.ConversationRequest$outboundSchema; - })(ConversationRequest$ || (exports.ConversationRequest$ = ConversationRequest$ = {})); - function conversationRequestToJSON(conversationRequest) { - return JSON.stringify(exports.ConversationRequest$outboundSchema.parse(conversationRequest)); - } - function conversationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationresponse.js - var require_conversationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationResponse$ = exports.ConversationResponse$outboundSchema = exports.ConversationResponse$inboundSchema = exports.Outputs$ = exports.Outputs$outboundSchema = exports.Outputs$inboundSchema = exports.ConversationResponseObject$ = exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema = exports.ConversationResponseObject = void 0; - exports.outputsToJSON = outputsToJSON; - exports.outputsFromJSON = outputsFromJSON; - exports.conversationResponseToJSON = conversationResponseToJSON; - exports.conversationResponseFromJSON = conversationResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - var functioncallentry_js_1 = require_functioncallentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationResponseObject = { - ConversationResponse: "conversation.response" - }; - exports.ConversationResponseObject$inboundSchema = z.nativeEnum(exports.ConversationResponseObject); - exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema; - var ConversationResponseObject$; - (function(ConversationResponseObject$2) { - ConversationResponseObject$2.inboundSchema = exports.ConversationResponseObject$inboundSchema; - ConversationResponseObject$2.outboundSchema = exports.ConversationResponseObject$outboundSchema; - })(ConversationResponseObject$ || (exports.ConversationResponseObject$ = ConversationResponseObject$ = {})); - exports.Outputs$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Outputs$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Outputs$; - (function(Outputs$2) { - Outputs$2.inboundSchema = exports.Outputs$inboundSchema; - Outputs$2.outboundSchema = exports.Outputs$outboundSchema; - })(Outputs$ || (exports.Outputs$ = Outputs$ = {})); - function outputsToJSON(outputs) { - return JSON.stringify(exports.Outputs$outboundSchema.parse(outputs)); - } - function outputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Outputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Outputs' from JSON`); - } - exports.ConversationResponse$inboundSchema = z.object({ - object: exports.ConversationResponseObject$inboundSchema.default("conversation.response"), - conversation_id: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationResponse$outboundSchema = z.object({ - object: exports.ConversationResponseObject$outboundSchema.default("conversation.response"), - conversationId: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationResponse$; - (function(ConversationResponse$2) { - ConversationResponse$2.inboundSchema = exports.ConversationResponse$inboundSchema; - ConversationResponse$2.outboundSchema = exports.ConversationResponse$outboundSchema; - })(ConversationResponse$ || (exports.ConversationResponse$ = ConversationResponse$ = {})); - function conversationResponseToJSON(conversationResponse) { - return JSON.stringify(exports.ConversationResponse$outboundSchema.parse(conversationResponse)); - } - function conversationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js - var require_conversationrestartrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartRequest$ = exports.ConversationRestartRequest$outboundSchema = exports.ConversationRestartRequest$inboundSchema = exports.ConversationRestartRequestHandoffExecution$ = exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema = exports.ConversationRestartRequestHandoffExecution = void 0; - exports.conversationRestartRequestToJSON = conversationRestartRequestToJSON; - exports.conversationRestartRequestFromJSON = conversationRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartRequestHandoffExecution); - exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - var ConversationRestartRequestHandoffExecution$; - (function(ConversationRestartRequestHandoffExecution$2) { - ConversationRestartRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - ConversationRestartRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartRequestHandoffExecution$outboundSchema; - })(ConversationRestartRequestHandoffExecution$ || (exports.ConversationRestartRequestHandoffExecution$ = ConversationRestartRequestHandoffExecution$ = {})); - exports.ConversationRestartRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartRequest$; - (function(ConversationRestartRequest$2) { - ConversationRestartRequest$2.inboundSchema = exports.ConversationRestartRequest$inboundSchema; - ConversationRestartRequest$2.outboundSchema = exports.ConversationRestartRequest$outboundSchema; - })(ConversationRestartRequest$ || (exports.ConversationRestartRequest$ = ConversationRestartRequest$ = {})); - function conversationRestartRequestToJSON(conversationRestartRequest) { - return JSON.stringify(exports.ConversationRestartRequest$outboundSchema.parse(conversationRestartRequest)); - } - function conversationRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js - var require_conversationrestartstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartStreamRequest$ = exports.ConversationRestartStreamRequest$outboundSchema = exports.ConversationRestartStreamRequest$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$ = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution = void 0; - exports.conversationRestartStreamRequestToJSON = conversationRestartStreamRequestToJSON; - exports.conversationRestartStreamRequestFromJSON = conversationRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartStreamRequestHandoffExecution); - exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - var ConversationRestartStreamRequestHandoffExecution$; - (function(ConversationRestartStreamRequestHandoffExecution$2) { - ConversationRestartStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - ConversationRestartStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema; - })(ConversationRestartStreamRequestHandoffExecution$ || (exports.ConversationRestartStreamRequestHandoffExecution$ = ConversationRestartStreamRequestHandoffExecution$ = {})); - exports.ConversationRestartStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartStreamRequest$; - (function(ConversationRestartStreamRequest$2) { - ConversationRestartStreamRequest$2.inboundSchema = exports.ConversationRestartStreamRequest$inboundSchema; - ConversationRestartStreamRequest$2.outboundSchema = exports.ConversationRestartStreamRequest$outboundSchema; - })(ConversationRestartStreamRequest$ || (exports.ConversationRestartStreamRequest$ = ConversationRestartStreamRequest$ = {})); - function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest) { - return JSON.stringify(exports.ConversationRestartStreamRequest$outboundSchema.parse(conversationRestartStreamRequest)); - } - function conversationRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js - var require_conversationstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationStreamRequest$ = exports.ConversationStreamRequest$outboundSchema = exports.ConversationStreamRequest$inboundSchema = exports.ConversationStreamRequestTools$ = exports.ConversationStreamRequestTools$outboundSchema = exports.ConversationStreamRequestTools$inboundSchema = exports.ConversationStreamRequestHandoffExecution$ = exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema = exports.ConversationStreamRequestHandoffExecution = void 0; - exports.conversationStreamRequestToolsToJSON = conversationStreamRequestToolsToJSON; - exports.conversationStreamRequestToolsFromJSON = conversationStreamRequestToolsFromJSON; - exports.conversationStreamRequestToJSON = conversationStreamRequestToJSON; - exports.conversationStreamRequestFromJSON = conversationStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ConversationStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationStreamRequestHandoffExecution); - exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - var ConversationStreamRequestHandoffExecution$; - (function(ConversationStreamRequestHandoffExecution$2) { - ConversationStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - ConversationStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationStreamRequestHandoffExecution$outboundSchema; - })(ConversationStreamRequestHandoffExecution$ || (exports.ConversationStreamRequestHandoffExecution$ = ConversationStreamRequestHandoffExecution$ = {})); - exports.ConversationStreamRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ConversationStreamRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ConversationStreamRequestTools$; - (function(ConversationStreamRequestTools$2) { - ConversationStreamRequestTools$2.inboundSchema = exports.ConversationStreamRequestTools$inboundSchema; - ConversationStreamRequestTools$2.outboundSchema = exports.ConversationStreamRequestTools$outboundSchema; - })(ConversationStreamRequestTools$ || (exports.ConversationStreamRequestTools$ = ConversationStreamRequestTools$ = {})); - function conversationStreamRequestToolsToJSON(conversationStreamRequestTools) { - return JSON.stringify(exports.ConversationStreamRequestTools$outboundSchema.parse(conversationStreamRequestTools)); - } - function conversationStreamRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequestTools' from JSON`); - } - exports.ConversationStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.ConversationStreamRequestHandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.ConversationStreamRequestHandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationStreamRequest$; - (function(ConversationStreamRequest$2) { - ConversationStreamRequest$2.inboundSchema = exports.ConversationStreamRequest$inboundSchema; - ConversationStreamRequest$2.outboundSchema = exports.ConversationStreamRequest$outboundSchema; - })(ConversationStreamRequest$ || (exports.ConversationStreamRequest$ = ConversationStreamRequest$ = {})); - function conversationStreamRequestToJSON(conversationStreamRequest) { - return JSON.stringify(exports.ConversationStreamRequest$outboundSchema.parse(conversationStreamRequest)); - } - function conversationStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletefileout.js - var require_deletefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteFileOut$ = exports.DeleteFileOut$outboundSchema = exports.DeleteFileOut$inboundSchema = void 0; - exports.deleteFileOutToJSON = deleteFileOutToJSON; - exports.deleteFileOutFromJSON = deleteFileOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - exports.DeleteFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - var DeleteFileOut$; - (function(DeleteFileOut$2) { - DeleteFileOut$2.inboundSchema = exports.DeleteFileOut$inboundSchema; - DeleteFileOut$2.outboundSchema = exports.DeleteFileOut$outboundSchema; - })(DeleteFileOut$ || (exports.DeleteFileOut$ = DeleteFileOut$ = {})); - function deleteFileOutToJSON(deleteFileOut) { - return JSON.stringify(exports.DeleteFileOut$outboundSchema.parse(deleteFileOut)); - } - function deleteFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletemodelout.js - var require_deletemodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletemodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelOut$ = exports.DeleteModelOut$outboundSchema = exports.DeleteModelOut$inboundSchema = void 0; - exports.deleteModelOutToJSON = deleteModelOutToJSON; - exports.deleteModelOutFromJSON = deleteModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteModelOut$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - exports.DeleteModelOut$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - var DeleteModelOut$; - (function(DeleteModelOut$2) { - DeleteModelOut$2.inboundSchema = exports.DeleteModelOut$inboundSchema; - DeleteModelOut$2.outboundSchema = exports.DeleteModelOut$outboundSchema; - })(DeleteModelOut$ || (exports.DeleteModelOut$ = DeleteModelOut$ = {})); - function deleteModelOutToJSON(deleteModelOut) { - return JSON.stringify(exports.DeleteModelOut$outboundSchema.parse(deleteModelOut)); - } - function deleteModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentout.js - var require_documentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentOut$ = exports.DocumentOut$outboundSchema = exports.DocumentOut$inboundSchema = void 0; - exports.documentOutToJSON = documentOutToJSON; - exports.documentOutFromJSON = documentOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentOut$inboundSchema = z.object({ - id: z.string(), - library_id: z.string(), - hash: z.string(), - mime_type: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - last_processed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - number_of_pages: z.nullable(z.number().int()).optional(), - processing_status: z.string(), - uploaded_by_id: z.string(), - uploaded_by_type: z.string(), - tokens_processing_main_content: z.nullable(z.number().int()).optional(), - tokens_processing_summary: z.nullable(z.number().int()).optional(), - tokens_processing_total: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "mime_type": "mimeType", - "created_at": "createdAt", - "last_processed_at": "lastProcessedAt", - "number_of_pages": "numberOfPages", - "processing_status": "processingStatus", - "uploaded_by_id": "uploadedById", - "uploaded_by_type": "uploadedByType", - "tokens_processing_main_content": "tokensProcessingMainContent", - "tokens_processing_summary": "tokensProcessingSummary", - "tokens_processing_total": "tokensProcessingTotal" - }); - }); - exports.DocumentOut$outboundSchema = z.object({ - id: z.string(), - libraryId: z.string(), - hash: z.string(), - mimeType: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - createdAt: z.date().transform((v) => v.toISOString()), - lastProcessedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - numberOfPages: z.nullable(z.number().int()).optional(), - processingStatus: z.string(), - uploadedById: z.string(), - uploadedByType: z.string(), - tokensProcessingMainContent: z.nullable(z.number().int()).optional(), - tokensProcessingSummary: z.nullable(z.number().int()).optional(), - tokensProcessingTotal: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - mimeType: "mime_type", - createdAt: "created_at", - lastProcessedAt: "last_processed_at", - numberOfPages: "number_of_pages", - processingStatus: "processing_status", - uploadedById: "uploaded_by_id", - uploadedByType: "uploaded_by_type", - tokensProcessingMainContent: "tokens_processing_main_content", - tokensProcessingSummary: "tokens_processing_summary", - tokensProcessingTotal: "tokens_processing_total" - }); - }); - var DocumentOut$; - (function(DocumentOut$2) { - DocumentOut$2.inboundSchema = exports.DocumentOut$inboundSchema; - DocumentOut$2.outboundSchema = exports.DocumentOut$outboundSchema; - })(DocumentOut$ || (exports.DocumentOut$ = DocumentOut$ = {})); - function documentOutToJSON(documentOut) { - return JSON.stringify(exports.DocumentOut$outboundSchema.parse(documentOut)); - } - function documentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenttextcontent.js - var require_documenttextcontent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenttextcontent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentTextContent$ = exports.DocumentTextContent$outboundSchema = exports.DocumentTextContent$inboundSchema = void 0; - exports.documentTextContentToJSON = documentTextContentToJSON; - exports.documentTextContentFromJSON = documentTextContentFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentTextContent$inboundSchema = z.object({ - text: z.string() - }); - exports.DocumentTextContent$outboundSchema = z.object({ - text: z.string() - }); - var DocumentTextContent$; - (function(DocumentTextContent$2) { - DocumentTextContent$2.inboundSchema = exports.DocumentTextContent$inboundSchema; - DocumentTextContent$2.outboundSchema = exports.DocumentTextContent$outboundSchema; - })(DocumentTextContent$ || (exports.DocumentTextContent$ = DocumentTextContent$ = {})); - function documentTextContentToJSON(documentTextContent) { - return JSON.stringify(exports.DocumentTextContent$outboundSchema.parse(documentTextContent)); - } - function documentTextContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentTextContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentTextContent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentupdatein.js - var require_documentupdatein = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentupdatein.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentUpdateIn$ = exports.DocumentUpdateIn$outboundSchema = exports.DocumentUpdateIn$inboundSchema = void 0; - exports.documentUpdateInToJSON = documentUpdateInToJSON; - exports.documentUpdateInFromJSON = documentUpdateInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentUpdateIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - exports.DocumentUpdateIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - var DocumentUpdateIn$; - (function(DocumentUpdateIn$2) { - DocumentUpdateIn$2.inboundSchema = exports.DocumentUpdateIn$inboundSchema; - DocumentUpdateIn$2.outboundSchema = exports.DocumentUpdateIn$outboundSchema; - })(DocumentUpdateIn$ || (exports.DocumentUpdateIn$ = DocumentUpdateIn$ = {})); - function documentUpdateInToJSON(documentUpdateIn) { - return JSON.stringify(exports.DocumentUpdateIn$outboundSchema.parse(documentUpdateIn)); - } - function documentUpdateInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentUpdateIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentUpdateIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingdtype.js - var require_embeddingdtype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingdtype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingDtype$ = exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema = exports.EmbeddingDtype = void 0; - var z = __importStar(require_zod()); - exports.EmbeddingDtype = { - Float: "float", - Int8: "int8", - Uint8: "uint8", - Binary: "binary", - Ubinary: "ubinary" - }; - exports.EmbeddingDtype$inboundSchema = z.nativeEnum(exports.EmbeddingDtype); - exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema; - var EmbeddingDtype$; - (function(EmbeddingDtype$2) { - EmbeddingDtype$2.inboundSchema = exports.EmbeddingDtype$inboundSchema; - EmbeddingDtype$2.outboundSchema = exports.EmbeddingDtype$outboundSchema; - })(EmbeddingDtype$ || (exports.EmbeddingDtype$ = EmbeddingDtype$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/encodingformat.js - var require_encodingformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/encodingformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EncodingFormat$ = exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema = exports.EncodingFormat = void 0; - var z = __importStar(require_zod()); - exports.EncodingFormat = { - Float: "float", - Base64: "base64" - }; - exports.EncodingFormat$inboundSchema = z.nativeEnum(exports.EncodingFormat); - exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema; - var EncodingFormat$; - (function(EncodingFormat$2) { - EncodingFormat$2.inboundSchema = exports.EncodingFormat$inboundSchema; - EncodingFormat$2.outboundSchema = exports.EncodingFormat$outboundSchema; - })(EncodingFormat$ || (exports.EncodingFormat$ = EncodingFormat$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingrequest.js - var require_embeddingrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingRequest$ = exports.EmbeddingRequest$outboundSchema = exports.EmbeddingRequest$inboundSchema = exports.EmbeddingRequestInputs$ = exports.EmbeddingRequestInputs$outboundSchema = exports.EmbeddingRequestInputs$inboundSchema = void 0; - exports.embeddingRequestInputsToJSON = embeddingRequestInputsToJSON; - exports.embeddingRequestInputsFromJSON = embeddingRequestInputsFromJSON; - exports.embeddingRequestToJSON = embeddingRequestToJSON; - exports.embeddingRequestFromJSON = embeddingRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var embeddingdtype_js_1 = require_embeddingdtype(); - var encodingformat_js_1 = require_encodingformat(); - exports.EmbeddingRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.EmbeddingRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var EmbeddingRequestInputs$; - (function(EmbeddingRequestInputs$2) { - EmbeddingRequestInputs$2.inboundSchema = exports.EmbeddingRequestInputs$inboundSchema; - EmbeddingRequestInputs$2.outboundSchema = exports.EmbeddingRequestInputs$outboundSchema; - })(EmbeddingRequestInputs$ || (exports.EmbeddingRequestInputs$ = EmbeddingRequestInputs$ = {})); - function embeddingRequestInputsToJSON(embeddingRequestInputs) { - return JSON.stringify(exports.EmbeddingRequestInputs$outboundSchema.parse(embeddingRequestInputs)); - } - function embeddingRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequestInputs' from JSON`); - } - exports.EmbeddingRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]), - output_dimension: z.nullable(z.number().int()).optional(), - output_dtype: embeddingdtype_js_1.EmbeddingDtype$inboundSchema.optional(), - encoding_format: encodingformat_js_1.EncodingFormat$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs", - "output_dimension": "outputDimension", - "output_dtype": "outputDtype", - "encoding_format": "encodingFormat" - }); - }); - exports.EmbeddingRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]), - outputDimension: z.nullable(z.number().int()).optional(), - outputDtype: embeddingdtype_js_1.EmbeddingDtype$outboundSchema.optional(), - encodingFormat: encodingformat_js_1.EncodingFormat$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input", - outputDimension: "output_dimension", - outputDtype: "output_dtype", - encodingFormat: "encoding_format" - }); - }); - var EmbeddingRequest$; - (function(EmbeddingRequest$2) { - EmbeddingRequest$2.inboundSchema = exports.EmbeddingRequest$inboundSchema; - EmbeddingRequest$2.outboundSchema = exports.EmbeddingRequest$outboundSchema; - })(EmbeddingRequest$ || (exports.EmbeddingRequest$ = EmbeddingRequest$ = {})); - function embeddingRequestToJSON(embeddingRequest) { - return JSON.stringify(exports.EmbeddingRequest$outboundSchema.parse(embeddingRequest)); - } - function embeddingRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js - var require_embeddingresponsedata = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponseData$ = exports.EmbeddingResponseData$outboundSchema = exports.EmbeddingResponseData$inboundSchema = void 0; - exports.embeddingResponseDataToJSON = embeddingResponseDataToJSON; - exports.embeddingResponseDataFromJSON = embeddingResponseDataFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.EmbeddingResponseData$inboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - exports.EmbeddingResponseData$outboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - var EmbeddingResponseData$; - (function(EmbeddingResponseData$2) { - EmbeddingResponseData$2.inboundSchema = exports.EmbeddingResponseData$inboundSchema; - EmbeddingResponseData$2.outboundSchema = exports.EmbeddingResponseData$outboundSchema; - })(EmbeddingResponseData$ || (exports.EmbeddingResponseData$ = EmbeddingResponseData$ = {})); - function embeddingResponseDataToJSON(embeddingResponseData) { - return JSON.stringify(exports.EmbeddingResponseData$outboundSchema.parse(embeddingResponseData)); - } - function embeddingResponseDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponseData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponseData' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponse.js - var require_embeddingresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponse$ = exports.EmbeddingResponse$outboundSchema = exports.EmbeddingResponse$inboundSchema = void 0; - exports.embeddingResponseToJSON = embeddingResponseToJSON; - exports.embeddingResponseFromJSON = embeddingResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var embeddingresponsedata_js_1 = require_embeddingresponsedata(); - var usageinfo_js_1 = require_usageinfo(); - exports.EmbeddingResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$inboundSchema) - }); - exports.EmbeddingResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$outboundSchema) - }); - var EmbeddingResponse$; - (function(EmbeddingResponse$2) { - EmbeddingResponse$2.inboundSchema = exports.EmbeddingResponse$inboundSchema; - EmbeddingResponse$2.outboundSchema = exports.EmbeddingResponse$outboundSchema; - })(EmbeddingResponse$ || (exports.EmbeddingResponse$ = EmbeddingResponse$ = {})); - function embeddingResponseToJSON(embeddingResponse) { - return JSON.stringify(exports.EmbeddingResponse$outboundSchema.parse(embeddingResponse)); - } - function embeddingResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/entitytype.js - var require_entitytype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/entitytype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EntityType$ = exports.EntityType$outboundSchema = exports.EntityType$inboundSchema = exports.EntityType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.EntityType = { - User: "User", - Workspace: "Workspace", - Org: "Org" - }; - exports.EntityType$inboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.EntityType$outboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().and(z.custom()) - ]); - var EntityType$; - (function(EntityType$2) { - EntityType$2.inboundSchema = exports.EntityType$inboundSchema; - EntityType$2.outboundSchema = exports.EntityType$outboundSchema; - })(EntityType$ || (exports.EntityType$ = EntityType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/filepurpose.js - var require_filepurpose = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filepurpose.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilePurpose$ = exports.FilePurpose$outboundSchema = exports.FilePurpose$inboundSchema = exports.FilePurpose = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.FilePurpose = { - FineTune: "fine-tune", - Batch: "batch", - Ocr: "ocr" - }; - exports.FilePurpose$inboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FilePurpose$outboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().and(z.custom()) - ]); - var FilePurpose$; - (function(FilePurpose$2) { - FilePurpose$2.inboundSchema = exports.FilePurpose$inboundSchema; - FilePurpose$2.outboundSchema = exports.FilePurpose$outboundSchema; - })(FilePurpose$ || (exports.FilePurpose$ = FilePurpose$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sampletype.js - var require_sampletype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sampletype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SampleType$ = exports.SampleType$outboundSchema = exports.SampleType$inboundSchema = exports.SampleType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.SampleType = { - Pretrain: "pretrain", - Instruct: "instruct", - BatchRequest: "batch_request", - BatchResult: "batch_result", - BatchError: "batch_error" - }; - exports.SampleType$inboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.SampleType$outboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().and(z.custom()) - ]); - var SampleType$; - (function(SampleType$2) { - SampleType$2.inboundSchema = exports.SampleType$inboundSchema; - SampleType$2.outboundSchema = exports.SampleType$outboundSchema; - })(SampleType$ || (exports.SampleType$ = SampleType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/source.js - var require_source = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/source.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Source$ = exports.Source$outboundSchema = exports.Source$inboundSchema = exports.Source = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.Source = { - Upload: "upload", - Repository: "repository", - Mistral: "mistral" - }; - exports.Source$inboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.Source$outboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().and(z.custom()) - ]); - var Source$; - (function(Source$2) { - Source$2.inboundSchema = exports.Source$inboundSchema; - Source$2.outboundSchema = exports.Source$outboundSchema; - })(Source$ || (exports.Source$ = Source$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/fileschema.js - var require_fileschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fileschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSchema$ = exports.FileSchema$outboundSchema = exports.FileSchema$inboundSchema = void 0; - exports.fileSchemaToJSON = fileSchemaToJSON; - exports.fileSchemaFromJSON = fileSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.FileSchema$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.FileSchema$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var FileSchema$; - (function(FileSchema$2) { - FileSchema$2.inboundSchema = exports.FileSchema$inboundSchema; - FileSchema$2.outboundSchema = exports.FileSchema$outboundSchema; - })(FileSchema$ || (exports.FileSchema$ = FileSchema$ = {})); - function fileSchemaToJSON(fileSchema) { - return JSON.stringify(exports.FileSchema$outboundSchema.parse(fileSchema)); - } - function fileSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filesignedurl.js - var require_filesignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filesignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSignedURL$ = exports.FileSignedURL$outboundSchema = exports.FileSignedURL$inboundSchema = void 0; - exports.fileSignedURLToJSON = fileSignedURLToJSON; - exports.fileSignedURLFromJSON = fileSignedURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileSignedURL$inboundSchema = z.object({ - url: z.string() - }); - exports.FileSignedURL$outboundSchema = z.object({ - url: z.string() - }); - var FileSignedURL$; - (function(FileSignedURL$2) { - FileSignedURL$2.inboundSchema = exports.FileSignedURL$inboundSchema; - FileSignedURL$2.outboundSchema = exports.FileSignedURL$outboundSchema; - })(FileSignedURL$ || (exports.FileSignedURL$ = FileSignedURL$ = {})); - function fileSignedURLToJSON(fileSignedURL) { - return JSON.stringify(exports.FileSignedURL$outboundSchema.parse(fileSignedURL)); - } - function fileSignedURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSignedURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSignedURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js - var require_fimcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionRequest$ = exports.FIMCompletionRequest$outboundSchema = exports.FIMCompletionRequest$inboundSchema = exports.FIMCompletionRequestStop$ = exports.FIMCompletionRequestStop$outboundSchema = exports.FIMCompletionRequestStop$inboundSchema = void 0; - exports.fimCompletionRequestStopToJSON = fimCompletionRequestStopToJSON; - exports.fimCompletionRequestStopFromJSON = fimCompletionRequestStopFromJSON; - exports.fimCompletionRequestToJSON = fimCompletionRequestToJSON; - exports.fimCompletionRequestFromJSON = fimCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionRequestStop$; - (function(FIMCompletionRequestStop$2) { - FIMCompletionRequestStop$2.inboundSchema = exports.FIMCompletionRequestStop$inboundSchema; - FIMCompletionRequestStop$2.outboundSchema = exports.FIMCompletionRequestStop$outboundSchema; - })(FIMCompletionRequestStop$ || (exports.FIMCompletionRequestStop$ = FIMCompletionRequestStop$ = {})); - function fimCompletionRequestStopToJSON(fimCompletionRequestStop) { - return JSON.stringify(exports.FIMCompletionRequestStop$outboundSchema.parse(fimCompletionRequestStop)); - } - function fimCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequestStop' from JSON`); - } - exports.FIMCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionRequest$; - (function(FIMCompletionRequest$2) { - FIMCompletionRequest$2.inboundSchema = exports.FIMCompletionRequest$inboundSchema; - FIMCompletionRequest$2.outboundSchema = exports.FIMCompletionRequest$outboundSchema; - })(FIMCompletionRequest$ || (exports.FIMCompletionRequest$ = FIMCompletionRequest$ = {})); - function fimCompletionRequestToJSON(fimCompletionRequest) { - return JSON.stringify(exports.FIMCompletionRequest$outboundSchema.parse(fimCompletionRequest)); - } - function fimCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js - var require_fimcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionResponse$ = exports.FIMCompletionResponse$outboundSchema = exports.FIMCompletionResponse$inboundSchema = void 0; - exports.fimCompletionResponseToJSON = fimCompletionResponseToJSON; - exports.fimCompletionResponseFromJSON = fimCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.FIMCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.FIMCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var FIMCompletionResponse$; - (function(FIMCompletionResponse$2) { - FIMCompletionResponse$2.inboundSchema = exports.FIMCompletionResponse$inboundSchema; - FIMCompletionResponse$2.outboundSchema = exports.FIMCompletionResponse$outboundSchema; - })(FIMCompletionResponse$ || (exports.FIMCompletionResponse$ = FIMCompletionResponse$ = {})); - function fimCompletionResponseToJSON(fimCompletionResponse) { - return JSON.stringify(exports.FIMCompletionResponse$outboundSchema.parse(fimCompletionResponse)); - } - function fimCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js - var require_fimcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionStreamRequest$ = exports.FIMCompletionStreamRequest$outboundSchema = exports.FIMCompletionStreamRequest$inboundSchema = exports.FIMCompletionStreamRequestStop$ = exports.FIMCompletionStreamRequestStop$outboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema = void 0; - exports.fimCompletionStreamRequestStopToJSON = fimCompletionStreamRequestStopToJSON; - exports.fimCompletionStreamRequestStopFromJSON = fimCompletionStreamRequestStopFromJSON; - exports.fimCompletionStreamRequestToJSON = fimCompletionStreamRequestToJSON; - exports.fimCompletionStreamRequestFromJSON = fimCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionStreamRequestStop$; - (function(FIMCompletionStreamRequestStop$2) { - FIMCompletionStreamRequestStop$2.inboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema; - FIMCompletionStreamRequestStop$2.outboundSchema = exports.FIMCompletionStreamRequestStop$outboundSchema; - })(FIMCompletionStreamRequestStop$ || (exports.FIMCompletionStreamRequestStop$ = FIMCompletionStreamRequestStop$ = {})); - function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop) { - return JSON.stringify(exports.FIMCompletionStreamRequestStop$outboundSchema.parse(fimCompletionStreamRequestStop)); - } - function fimCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequestStop' from JSON`); - } - exports.FIMCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionStreamRequest$; - (function(FIMCompletionStreamRequest$2) { - FIMCompletionStreamRequest$2.inboundSchema = exports.FIMCompletionStreamRequest$inboundSchema; - FIMCompletionStreamRequest$2.outboundSchema = exports.FIMCompletionStreamRequest$outboundSchema; - })(FIMCompletionStreamRequest$ || (exports.FIMCompletionStreamRequest$ = FIMCompletionStreamRequest$ = {})); - function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest) { - return JSON.stringify(exports.FIMCompletionStreamRequest$outboundSchema.parse(fimCompletionStreamRequest)); - } - function fimCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js - var require_finetuneablemodeltype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuneableModelType$ = exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema = exports.FineTuneableModelType = void 0; - var z = __importStar(require_zod()); - exports.FineTuneableModelType = { - Completion: "completion", - Classifier: "classifier" - }; - exports.FineTuneableModelType$inboundSchema = z.nativeEnum(exports.FineTuneableModelType); - exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema; - var FineTuneableModelType$; - (function(FineTuneableModelType$2) { - FineTuneableModelType$2.inboundSchema = exports.FineTuneableModelType$inboundSchema; - FineTuneableModelType$2.outboundSchema = exports.FineTuneableModelType$outboundSchema; - })(FineTuneableModelType$ || (exports.FineTuneableModelType$ = FineTuneableModelType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcard.js - var require_ftmodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCard$ = exports.FTModelCard$outboundSchema = exports.FTModelCard$inboundSchema = exports.FTModelCardType$ = exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema = exports.FTModelCardType = void 0; - exports.ftModelCardToJSON = ftModelCardToJSON; - exports.ftModelCardFromJSON = ftModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.FTModelCardType = { - FineTuned: "fine-tuned" - }; - exports.FTModelCardType$inboundSchema = z.nativeEnum(exports.FTModelCardType); - exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema; - var FTModelCardType$; - (function(FTModelCardType$2) { - FTModelCardType$2.inboundSchema = exports.FTModelCardType$inboundSchema; - FTModelCardType$2.outboundSchema = exports.FTModelCardType$outboundSchema; - })(FTModelCardType$ || (exports.FTModelCardType$ = FTModelCardType$ = {})); - exports.FTModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.FTModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var FTModelCard$; - (function(FTModelCard$2) { - FTModelCard$2.inboundSchema = exports.FTModelCard$inboundSchema; - FTModelCard$2.outboundSchema = exports.FTModelCard$outboundSchema; - })(FTModelCard$ || (exports.FTModelCard$ = FTModelCard$ = {})); - function ftModelCardToJSON(ftModelCard) { - return JSON.stringify(exports.FTModelCard$outboundSchema.parse(ftModelCard)); - } - function ftModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js - var require_githubrepositoryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryIn$ = exports.GithubRepositoryIn$outboundSchema = exports.GithubRepositoryIn$inboundSchema = exports.GithubRepositoryInType$ = exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema = exports.GithubRepositoryInType = void 0; - exports.githubRepositoryInToJSON = githubRepositoryInToJSON; - exports.githubRepositoryInFromJSON = githubRepositoryInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryInType = { - Github: "github" - }; - exports.GithubRepositoryInType$inboundSchema = z.nativeEnum(exports.GithubRepositoryInType); - exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema; - var GithubRepositoryInType$; - (function(GithubRepositoryInType$2) { - GithubRepositoryInType$2.inboundSchema = exports.GithubRepositoryInType$inboundSchema; - GithubRepositoryInType$2.outboundSchema = exports.GithubRepositoryInType$outboundSchema; - })(GithubRepositoryInType$ || (exports.GithubRepositoryInType$ = GithubRepositoryInType$ = {})); - exports.GithubRepositoryIn$inboundSchema = z.object({ - type: exports.GithubRepositoryInType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - exports.GithubRepositoryIn$outboundSchema = z.object({ - type: exports.GithubRepositoryInType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - var GithubRepositoryIn$; - (function(GithubRepositoryIn$2) { - GithubRepositoryIn$2.inboundSchema = exports.GithubRepositoryIn$inboundSchema; - GithubRepositoryIn$2.outboundSchema = exports.GithubRepositoryIn$outboundSchema; - })(GithubRepositoryIn$ || (exports.GithubRepositoryIn$ = GithubRepositoryIn$ = {})); - function githubRepositoryInToJSON(githubRepositoryIn) { - return JSON.stringify(exports.GithubRepositoryIn$outboundSchema.parse(githubRepositoryIn)); - } - function githubRepositoryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/trainingfile.js - var require_trainingfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/trainingfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TrainingFile$ = exports.TrainingFile$outboundSchema = exports.TrainingFile$inboundSchema = void 0; - exports.trainingFileToJSON = trainingFileToJSON; - exports.trainingFileFromJSON = trainingFileFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TrainingFile$inboundSchema = z.object({ - file_id: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.TrainingFile$outboundSchema = z.object({ - fileId: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var TrainingFile$; - (function(TrainingFile$2) { - TrainingFile$2.inboundSchema = exports.TrainingFile$inboundSchema; - TrainingFile$2.outboundSchema = exports.TrainingFile$outboundSchema; - })(TrainingFile$ || (exports.TrainingFile$ = TrainingFile$ = {})); - function trainingFileToJSON(trainingFile) { - return JSON.stringify(exports.TrainingFile$outboundSchema.parse(trainingFile)); - } - function trainingFileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TrainingFile$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TrainingFile' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegration.js - var require_wandbintegration = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegration.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegration$ = exports.WandbIntegration$outboundSchema = exports.WandbIntegration$inboundSchema = exports.WandbIntegrationType$ = exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema = exports.WandbIntegrationType = void 0; - exports.wandbIntegrationToJSON = wandbIntegrationToJSON; - exports.wandbIntegrationFromJSON = wandbIntegrationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationType = { - Wandb: "wandb" - }; - exports.WandbIntegrationType$inboundSchema = z.nativeEnum(exports.WandbIntegrationType); - exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema; - var WandbIntegrationType$; - (function(WandbIntegrationType$2) { - WandbIntegrationType$2.inboundSchema = exports.WandbIntegrationType$inboundSchema; - WandbIntegrationType$2.outboundSchema = exports.WandbIntegrationType$outboundSchema; - })(WandbIntegrationType$ || (exports.WandbIntegrationType$ = WandbIntegrationType$ = {})); - exports.WandbIntegration$inboundSchema = z.object({ - type: exports.WandbIntegrationType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - api_key: z.string(), - run_name: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "api_key": "apiKey", - "run_name": "runName" - }); - }); - exports.WandbIntegration$outboundSchema = z.object({ - type: exports.WandbIntegrationType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - apiKey: z.string(), - runName: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "api_key", - runName: "run_name" - }); - }); - var WandbIntegration$; - (function(WandbIntegration$2) { - WandbIntegration$2.inboundSchema = exports.WandbIntegration$inboundSchema; - WandbIntegration$2.outboundSchema = exports.WandbIntegration$outboundSchema; - })(WandbIntegration$ || (exports.WandbIntegration$ = WandbIntegration$ = {})); - function wandbIntegrationToJSON(wandbIntegration) { - return JSON.stringify(exports.WandbIntegration$outboundSchema.parse(wandbIntegration)); - } - function wandbIntegrationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegration$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegration' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobin.js - var require_jobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobIn$ = exports.JobIn$outboundSchema = exports.JobIn$inboundSchema = exports.JobInRepositories$ = exports.JobInRepositories$outboundSchema = exports.JobInRepositories$inboundSchema = exports.Hyperparameters$ = exports.Hyperparameters$outboundSchema = exports.Hyperparameters$inboundSchema = exports.JobInIntegrations$ = exports.JobInIntegrations$outboundSchema = exports.JobInIntegrations$inboundSchema = void 0; - exports.jobInIntegrationsToJSON = jobInIntegrationsToJSON; - exports.jobInIntegrationsFromJSON = jobInIntegrationsFromJSON; - exports.hyperparametersToJSON = hyperparametersToJSON; - exports.hyperparametersFromJSON = hyperparametersFromJSON; - exports.jobInRepositoriesToJSON = jobInRepositoriesToJSON; - exports.jobInRepositoriesFromJSON = jobInRepositoriesFromJSON; - exports.jobInToJSON = jobInToJSON; - exports.jobInFromJSON = jobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetin_js_1 = require_classifiertargetin(); - var classifiertrainingparametersin_js_1 = require_classifiertrainingparametersin(); - var completiontrainingparametersin_js_1 = require_completiontrainingparametersin(); - var finetuneablemodeltype_js_1 = require_finetuneablemodeltype(); - var githubrepositoryin_js_1 = require_githubrepositoryin(); - var trainingfile_js_1 = require_trainingfile(); - var wandbintegration_js_1 = require_wandbintegration(); - exports.JobInIntegrations$inboundSchema = wandbintegration_js_1.WandbIntegration$inboundSchema; - exports.JobInIntegrations$outboundSchema = wandbintegration_js_1.WandbIntegration$outboundSchema; - var JobInIntegrations$; - (function(JobInIntegrations$2) { - JobInIntegrations$2.inboundSchema = exports.JobInIntegrations$inboundSchema; - JobInIntegrations$2.outboundSchema = exports.JobInIntegrations$outboundSchema; - })(JobInIntegrations$ || (exports.JobInIntegrations$ = JobInIntegrations$ = {})); - function jobInIntegrationsToJSON(jobInIntegrations) { - return JSON.stringify(exports.JobInIntegrations$outboundSchema.parse(jobInIntegrations)); - } - function jobInIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInIntegrations' from JSON`); - } - exports.Hyperparameters$inboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]); - exports.Hyperparameters$outboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]); - var Hyperparameters$; - (function(Hyperparameters$2) { - Hyperparameters$2.inboundSchema = exports.Hyperparameters$inboundSchema; - Hyperparameters$2.outboundSchema = exports.Hyperparameters$outboundSchema; - })(Hyperparameters$ || (exports.Hyperparameters$ = Hyperparameters$ = {})); - function hyperparametersToJSON(hyperparameters) { - return JSON.stringify(exports.Hyperparameters$outboundSchema.parse(hyperparameters)); - } - function hyperparametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Hyperparameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Hyperparameters' from JSON`); - } - exports.JobInRepositories$inboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema; - exports.JobInRepositories$outboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema; - var JobInRepositories$; - (function(JobInRepositories$2) { - JobInRepositories$2.inboundSchema = exports.JobInRepositories$inboundSchema; - JobInRepositories$2.outboundSchema = exports.JobInRepositories$outboundSchema; - })(JobInRepositories$ || (exports.JobInRepositories$ = JobInRepositories$ = {})); - function jobInRepositoriesToJSON(jobInRepositories) { - return JSON.stringify(exports.JobInRepositories$outboundSchema.parse(jobInRepositories)); - } - function jobInRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInRepositories' from JSON`); - } - exports.JobIn$inboundSchema = z.object({ - model: z.string(), - training_files: z.array(trainingfile_js_1.TrainingFile$inboundSchema).optional(), - validation_files: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$inboundSchema)).optional(), - auto_start: z.boolean().optional(), - invalid_sample_skip_percentage: z.number().default(0), - job_type: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$inboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema)).optional(), - classifier_targets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "auto_start": "autoStart", - "invalid_sample_skip_percentage": "invalidSampleSkipPercentage", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.JobIn$outboundSchema = z.object({ - model: z.string(), - trainingFiles: z.array(trainingfile_js_1.TrainingFile$outboundSchema).optional(), - validationFiles: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$outboundSchema)).optional(), - autoStart: z.boolean().optional(), - invalidSampleSkipPercentage: z.number().default(0), - jobType: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$outboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema)).optional(), - classifierTargets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingFiles: "training_files", - validationFiles: "validation_files", - autoStart: "auto_start", - invalidSampleSkipPercentage: "invalid_sample_skip_percentage", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var JobIn$; - (function(JobIn$2) { - JobIn$2.inboundSchema = exports.JobIn$inboundSchema; - JobIn$2.outboundSchema = exports.JobIn$outboundSchema; - })(JobIn$ || (exports.JobIn$ = JobIn$ = {})); - function jobInToJSON(jobIn) { - return JSON.stringify(exports.JobIn$outboundSchema.parse(jobIn)); - } - function jobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobsout.js - var require_jobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsOut$ = exports.JobsOut$outboundSchema = exports.JobsOut$inboundSchema = exports.JobsOutObject$ = exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema = exports.JobsOutData$ = exports.JobsOutData$outboundSchema = exports.JobsOutData$inboundSchema = exports.JobsOutObject = void 0; - exports.jobsOutDataToJSON = jobsOutDataToJSON; - exports.jobsOutDataFromJSON = jobsOutDataFromJSON; - exports.jobsOutToJSON = jobsOutToJSON; - exports.jobsOutFromJSON = jobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classifierjobout_js_1 = require_classifierjobout(); - var completionjobout_js_1 = require_completionjobout(); - exports.JobsOutObject = { - List: "list" - }; - exports.JobsOutData$inboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsOutData$outboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsOutData$; - (function(JobsOutData$2) { - JobsOutData$2.inboundSchema = exports.JobsOutData$inboundSchema; - JobsOutData$2.outboundSchema = exports.JobsOutData$outboundSchema; - })(JobsOutData$ || (exports.JobsOutData$ = JobsOutData$ = {})); - function jobsOutDataToJSON(jobsOutData) { - return JSON.stringify(exports.JobsOutData$outboundSchema.parse(jobsOutData)); - } - function jobsOutDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOutData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOutData' from JSON`); - } - exports.JobsOutObject$inboundSchema = z.nativeEnum(exports.JobsOutObject); - exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema; - var JobsOutObject$; - (function(JobsOutObject$2) { - JobsOutObject$2.inboundSchema = exports.JobsOutObject$inboundSchema; - JobsOutObject$2.outboundSchema = exports.JobsOutObject$outboundSchema; - })(JobsOutObject$ || (exports.JobsOutObject$ = JobsOutObject$ = {})); - exports.JobsOut$inboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ])).optional(), - object: exports.JobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.JobsOut$outboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ])).optional(), - object: exports.JobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var JobsOut$; - (function(JobsOut$2) { - JobsOut$2.inboundSchema = exports.JobsOut$inboundSchema; - JobsOut$2.outboundSchema = exports.JobsOut$outboundSchema; - })(JobsOut$ || (exports.JobsOut$ = JobsOut$ = {})); - function jobsOutToJSON(jobsOut) { - return JSON.stringify(exports.JobsOut$outboundSchema.parse(jobsOut)); - } - function jobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js - var require_legacyjobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LegacyJobMetadataOut$ = exports.LegacyJobMetadataOut$outboundSchema = exports.LegacyJobMetadataOut$inboundSchema = exports.LegacyJobMetadataOutObject$ = exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema = exports.LegacyJobMetadataOutObject = void 0; - exports.legacyJobMetadataOutToJSON = legacyJobMetadataOutToJSON; - exports.legacyJobMetadataOutFromJSON = legacyJobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LegacyJobMetadataOutObject = { - JobMetadata: "job.metadata" - }; - exports.LegacyJobMetadataOutObject$inboundSchema = z.nativeEnum(exports.LegacyJobMetadataOutObject); - exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - var LegacyJobMetadataOutObject$; - (function(LegacyJobMetadataOutObject$2) { - LegacyJobMetadataOutObject$2.inboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - LegacyJobMetadataOutObject$2.outboundSchema = exports.LegacyJobMetadataOutObject$outboundSchema; - })(LegacyJobMetadataOutObject$ || (exports.LegacyJobMetadataOutObject$ = LegacyJobMetadataOutObject$ = {})); - exports.LegacyJobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - training_steps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$inboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime", - "training_steps": "trainingSteps" - }); - }); - exports.LegacyJobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - trainingSteps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$outboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time", - trainingSteps: "training_steps" - }); - }); - var LegacyJobMetadataOut$; - (function(LegacyJobMetadataOut$2) { - LegacyJobMetadataOut$2.inboundSchema = exports.LegacyJobMetadataOut$inboundSchema; - LegacyJobMetadataOut$2.outboundSchema = exports.LegacyJobMetadataOut$outboundSchema; - })(LegacyJobMetadataOut$ || (exports.LegacyJobMetadataOut$ = LegacyJobMetadataOut$ = {})); - function legacyJobMetadataOutToJSON(legacyJobMetadataOut) { - return JSON.stringify(exports.LegacyJobMetadataOut$outboundSchema.parse(legacyJobMetadataOut)); - } - function legacyJobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LegacyJobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LegacyJobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryin.js - var require_libraryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryIn$ = exports.LibraryIn$outboundSchema = exports.LibraryIn$inboundSchema = void 0; - exports.libraryInToJSON = libraryInToJSON; - exports.libraryInFromJSON = libraryInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryIn$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunk_size: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "chunk_size": "chunkSize" - }); - }); - exports.LibraryIn$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunkSize: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - chunkSize: "chunk_size" - }); - }); - var LibraryIn$; - (function(LibraryIn$2) { - LibraryIn$2.inboundSchema = exports.LibraryIn$inboundSchema; - LibraryIn$2.outboundSchema = exports.LibraryIn$outboundSchema; - })(LibraryIn$ || (exports.LibraryIn$ = LibraryIn$ = {})); - function libraryInToJSON(libraryIn) { - return JSON.stringify(exports.LibraryIn$outboundSchema.parse(libraryIn)); - } - function libraryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryinupdate.js - var require_libraryinupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryinupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryInUpdate$ = exports.LibraryInUpdate$outboundSchema = exports.LibraryInUpdate$inboundSchema = void 0; - exports.libraryInUpdateToJSON = libraryInUpdateToJSON; - exports.libraryInUpdateFromJSON = libraryInUpdateFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.LibraryInUpdate$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.LibraryInUpdate$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var LibraryInUpdate$; - (function(LibraryInUpdate$2) { - LibraryInUpdate$2.inboundSchema = exports.LibraryInUpdate$inboundSchema; - LibraryInUpdate$2.outboundSchema = exports.LibraryInUpdate$outboundSchema; - })(LibraryInUpdate$ || (exports.LibraryInUpdate$ = LibraryInUpdate$ = {})); - function libraryInUpdateToJSON(libraryInUpdate) { - return JSON.stringify(exports.LibraryInUpdate$outboundSchema.parse(libraryInUpdate)); - } - function libraryInUpdateFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryInUpdate$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryInUpdate' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryout.js - var require_libraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryOut$ = exports.LibraryOut$outboundSchema = exports.LibraryOut$inboundSchema = void 0; - exports.libraryOutToJSON = libraryOutToJSON; - exports.libraryOutFromJSON = libraryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryOut$inboundSchema = z.object({ - id: z.string(), - name: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - owner_id: z.string(), - owner_type: z.string(), - total_size: z.number().int(), - nb_documents: z.number().int(), - chunk_size: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generated_name: z.nullable(z.string()).optional(), - generated_description: z.nullable(z.string()).optional(), - explicit_user_members_count: z.nullable(z.number().int()).optional(), - explicit_workspace_members_count: z.nullable(z.number().int()).optional(), - org_sharing_role: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "owner_id": "ownerId", - "owner_type": "ownerType", - "total_size": "totalSize", - "nb_documents": "nbDocuments", - "chunk_size": "chunkSize", - "generated_name": "generatedName", - "generated_description": "generatedDescription", - "explicit_user_members_count": "explicitUserMembersCount", - "explicit_workspace_members_count": "explicitWorkspaceMembersCount", - "org_sharing_role": "orgSharingRole" - }); - }); - exports.LibraryOut$outboundSchema = z.object({ - id: z.string(), - name: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - ownerId: z.string(), - ownerType: z.string(), - totalSize: z.number().int(), - nbDocuments: z.number().int(), - chunkSize: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generatedName: z.nullable(z.string()).optional(), - generatedDescription: z.nullable(z.string()).optional(), - explicitUserMembersCount: z.nullable(z.number().int()).optional(), - explicitWorkspaceMembersCount: z.nullable(z.number().int()).optional(), - orgSharingRole: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - ownerId: "owner_id", - ownerType: "owner_type", - totalSize: "total_size", - nbDocuments: "nb_documents", - chunkSize: "chunk_size", - generatedName: "generated_name", - generatedDescription: "generated_description", - explicitUserMembersCount: "explicit_user_members_count", - explicitWorkspaceMembersCount: "explicit_workspace_members_count", - orgSharingRole: "org_sharing_role" - }); - }); - var LibraryOut$; - (function(LibraryOut$2) { - LibraryOut$2.inboundSchema = exports.LibraryOut$inboundSchema; - LibraryOut$2.outboundSchema = exports.LibraryOut$outboundSchema; - })(LibraryOut$ || (exports.LibraryOut$ = LibraryOut$ = {})); - function libraryOutToJSON(libraryOut) { - return JSON.stringify(exports.LibraryOut$outboundSchema.parse(libraryOut)); - } - function libraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/paginationinfo.js - var require_paginationinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/paginationinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.PaginationInfo$ = exports.PaginationInfo$outboundSchema = exports.PaginationInfo$inboundSchema = void 0; - exports.paginationInfoToJSON = paginationInfoToJSON; - exports.paginationInfoFromJSON = paginationInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.PaginationInfo$inboundSchema = z.object({ - total_items: z.number().int(), - total_pages: z.number().int(), - current_page: z.number().int(), - page_size: z.number().int(), - has_more: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "total_items": "totalItems", - "total_pages": "totalPages", - "current_page": "currentPage", - "page_size": "pageSize", - "has_more": "hasMore" - }); - }); - exports.PaginationInfo$outboundSchema = z.object({ - totalItems: z.number().int(), - totalPages: z.number().int(), - currentPage: z.number().int(), - pageSize: z.number().int(), - hasMore: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - totalItems: "total_items", - totalPages: "total_pages", - currentPage: "current_page", - pageSize: "page_size", - hasMore: "has_more" - }); - }); - var PaginationInfo$; - (function(PaginationInfo$2) { - PaginationInfo$2.inboundSchema = exports.PaginationInfo$inboundSchema; - PaginationInfo$2.outboundSchema = exports.PaginationInfo$outboundSchema; - })(PaginationInfo$ || (exports.PaginationInfo$ = PaginationInfo$ = {})); - function paginationInfoToJSON(paginationInfo) { - return JSON.stringify(exports.PaginationInfo$outboundSchema.parse(paginationInfo)); - } - function paginationInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PaginationInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PaginationInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listdocumentout.js - var require_listdocumentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listdocumentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListDocumentOut$ = exports.ListDocumentOut$outboundSchema = exports.ListDocumentOut$inboundSchema = void 0; - exports.listDocumentOutToJSON = listDocumentOutToJSON; - exports.listDocumentOutFromJSON = listDocumentOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documentout_js_1 = require_documentout(); - var paginationinfo_js_1 = require_paginationinfo(); - exports.ListDocumentOut$inboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$inboundSchema, - data: z.array(documentout_js_1.DocumentOut$inboundSchema) - }); - exports.ListDocumentOut$outboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$outboundSchema, - data: z.array(documentout_js_1.DocumentOut$outboundSchema) - }); - var ListDocumentOut$; - (function(ListDocumentOut$2) { - ListDocumentOut$2.inboundSchema = exports.ListDocumentOut$inboundSchema; - ListDocumentOut$2.outboundSchema = exports.ListDocumentOut$outboundSchema; - })(ListDocumentOut$ || (exports.ListDocumentOut$ = ListDocumentOut$ = {})); - function listDocumentOutToJSON(listDocumentOut) { - return JSON.stringify(exports.ListDocumentOut$outboundSchema.parse(listDocumentOut)); - } - function listDocumentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListDocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListDocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listfilesout.js - var require_listfilesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listfilesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListFilesOut$ = exports.ListFilesOut$outboundSchema = exports.ListFilesOut$inboundSchema = void 0; - exports.listFilesOutToJSON = listFilesOutToJSON; - exports.listFilesOutFromJSON = listFilesOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var fileschema_js_1 = require_fileschema(); - exports.ListFilesOut$inboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$inboundSchema), - object: z.string(), - total: z.number().int() - }); - exports.ListFilesOut$outboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$outboundSchema), - object: z.string(), - total: z.number().int() - }); - var ListFilesOut$; - (function(ListFilesOut$2) { - ListFilesOut$2.inboundSchema = exports.ListFilesOut$inboundSchema; - ListFilesOut$2.outboundSchema = exports.ListFilesOut$outboundSchema; - })(ListFilesOut$ || (exports.ListFilesOut$ = ListFilesOut$ = {})); - function listFilesOutToJSON(listFilesOut) { - return JSON.stringify(exports.ListFilesOut$outboundSchema.parse(listFilesOut)); - } - function listFilesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListFilesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListFilesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listlibraryout.js - var require_listlibraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listlibraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListLibraryOut$ = exports.ListLibraryOut$outboundSchema = exports.ListLibraryOut$inboundSchema = void 0; - exports.listLibraryOutToJSON = listLibraryOutToJSON; - exports.listLibraryOutFromJSON = listLibraryOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var libraryout_js_1 = require_libraryout(); - exports.ListLibraryOut$inboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$inboundSchema) - }); - exports.ListLibraryOut$outboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$outboundSchema) - }); - var ListLibraryOut$; - (function(ListLibraryOut$2) { - ListLibraryOut$2.inboundSchema = exports.ListLibraryOut$inboundSchema; - ListLibraryOut$2.outboundSchema = exports.ListLibraryOut$outboundSchema; - })(ListLibraryOut$ || (exports.ListLibraryOut$ = ListLibraryOut$ = {})); - function listLibraryOutToJSON(listLibraryOut) { - return JSON.stringify(exports.ListLibraryOut$outboundSchema.parse(listLibraryOut)); - } - function listLibraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListLibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListLibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingout.js - var require_sharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingOut$ = exports.SharingOut$outboundSchema = exports.SharingOut$inboundSchema = void 0; - exports.sharingOutToJSON = sharingOutToJSON; - exports.sharingOutFromJSON = sharingOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.SharingOut$inboundSchema = z.object({ - library_id: z.string(), - user_id: z.nullable(z.string()).optional(), - org_id: z.string(), - role: z.string(), - share_with_type: z.string(), - share_with_uuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "user_id": "userId", - "org_id": "orgId", - "share_with_type": "shareWithType", - "share_with_uuid": "shareWithUuid" - }); - }); - exports.SharingOut$outboundSchema = z.object({ - libraryId: z.string(), - userId: z.nullable(z.string()).optional(), - orgId: z.string(), - role: z.string(), - shareWithType: z.string(), - shareWithUuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - userId: "user_id", - orgId: "org_id", - shareWithType: "share_with_type", - shareWithUuid: "share_with_uuid" - }); - }); - var SharingOut$; - (function(SharingOut$2) { - SharingOut$2.inboundSchema = exports.SharingOut$inboundSchema; - SharingOut$2.outboundSchema = exports.SharingOut$outboundSchema; - })(SharingOut$ || (exports.SharingOut$ = SharingOut$ = {})); - function sharingOutToJSON(sharingOut) { - return JSON.stringify(exports.SharingOut$outboundSchema.parse(sharingOut)); - } - function sharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listsharingout.js - var require_listsharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listsharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListSharingOut$ = exports.ListSharingOut$outboundSchema = exports.ListSharingOut$inboundSchema = void 0; - exports.listSharingOutToJSON = listSharingOutToJSON; - exports.listSharingOutFromJSON = listSharingOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var sharingout_js_1 = require_sharingout(); - exports.ListSharingOut$inboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$inboundSchema) - }); - exports.ListSharingOut$outboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$outboundSchema) - }); - var ListSharingOut$; - (function(ListSharingOut$2) { - ListSharingOut$2.inboundSchema = exports.ListSharingOut$inboundSchema; - ListSharingOut$2.outboundSchema = exports.ListSharingOut$outboundSchema; - })(ListSharingOut$ || (exports.ListSharingOut$ = ListSharingOut$ = {})); - function listSharingOutToJSON(listSharingOut) { - return JSON.stringify(exports.ListSharingOut$outboundSchema.parse(listSharingOut)); - } - function listSharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListSharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListSharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelconversation.js - var require_modelconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelConversation$ = exports.ModelConversation$outboundSchema = exports.ModelConversation$inboundSchema = exports.ModelConversationObject$ = exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema = exports.ModelConversationTools$ = exports.ModelConversationTools$outboundSchema = exports.ModelConversationTools$inboundSchema = exports.ModelConversationObject = void 0; - exports.modelConversationToolsToJSON = modelConversationToolsToJSON; - exports.modelConversationToolsFromJSON = modelConversationToolsFromJSON; - exports.modelConversationToJSON = modelConversationToJSON; - exports.modelConversationFromJSON = modelConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ModelConversationObject = { - Conversation: "conversation" - }; - exports.ModelConversationTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ModelConversationTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ModelConversationTools$; - (function(ModelConversationTools$2) { - ModelConversationTools$2.inboundSchema = exports.ModelConversationTools$inboundSchema; - ModelConversationTools$2.outboundSchema = exports.ModelConversationTools$outboundSchema; - })(ModelConversationTools$ || (exports.ModelConversationTools$ = ModelConversationTools$ = {})); - function modelConversationToolsToJSON(modelConversationTools) { - return JSON.stringify(exports.ModelConversationTools$outboundSchema.parse(modelConversationTools)); - } - function modelConversationToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversationTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversationTools' from JSON`); - } - exports.ModelConversationObject$inboundSchema = z.nativeEnum(exports.ModelConversationObject); - exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema; - var ModelConversationObject$; - (function(ModelConversationObject$2) { - ModelConversationObject$2.inboundSchema = exports.ModelConversationObject$inboundSchema; - ModelConversationObject$2.outboundSchema = exports.ModelConversationObject$outboundSchema; - })(ModelConversationObject$ || (exports.ModelConversationObject$ = ModelConversationObject$ = {})); - exports.ModelConversation$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.ModelConversation$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var ModelConversation$; - (function(ModelConversation$2) { - ModelConversation$2.inboundSchema = exports.ModelConversation$inboundSchema; - ModelConversation$2.outboundSchema = exports.ModelConversation$outboundSchema; - })(ModelConversation$ || (exports.ModelConversation$ = ModelConversation$ = {})); - function modelConversationToJSON(modelConversation) { - return JSON.stringify(exports.ModelConversation$outboundSchema.parse(modelConversation)); - } - function modelConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modellist.js - var require_modellist = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modellist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelList$ = exports.ModelList$outboundSchema = exports.ModelList$inboundSchema = exports.Data$ = exports.Data$outboundSchema = exports.Data$inboundSchema = void 0; - exports.dataToJSON = dataToJSON; - exports.dataFromJSON = dataFromJSON; - exports.modelListToJSON = modelListToJSON; - exports.modelListFromJSON = modelListFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var basemodelcard_js_1 = require_basemodelcard(); - var ftmodelcard_js_1 = require_ftmodelcard(); - exports.Data$inboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Data$outboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var Data$; - (function(Data$2) { - Data$2.inboundSchema = exports.Data$inboundSchema; - Data$2.outboundSchema = exports.Data$outboundSchema; - })(Data$ || (exports.Data$ = Data$ = {})); - function dataToJSON(data) { - return JSON.stringify(exports.Data$outboundSchema.parse(data)); - } - function dataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Data$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Data' from JSON`); - } - exports.ModelList$inboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - exports.ModelList$outboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - var ModelList$; - (function(ModelList$2) { - ModelList$2.inboundSchema = exports.ModelList$inboundSchema; - ModelList$2.outboundSchema = exports.ModelList$outboundSchema; - })(ModelList$ || (exports.ModelList$ = ModelList$ = {})); - function modelListToJSON(modelList) { - return JSON.stringify(exports.ModelList$outboundSchema.parse(modelList)); - } - function modelListFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelList$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelList' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationobject.js - var require_moderationobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationObject$ = exports.ModerationObject$outboundSchema = exports.ModerationObject$inboundSchema = void 0; - exports.moderationObjectToJSON = moderationObjectToJSON; - exports.moderationObjectFromJSON = moderationObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModerationObject$inboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - category_scores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "category_scores": "categoryScores" - }); - }); - exports.ModerationObject$outboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - categoryScores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - categoryScores: "category_scores" - }); - }); - var ModerationObject$; - (function(ModerationObject$2) { - ModerationObject$2.inboundSchema = exports.ModerationObject$inboundSchema; - ModerationObject$2.outboundSchema = exports.ModerationObject$outboundSchema; - })(ModerationObject$ || (exports.ModerationObject$ = ModerationObject$ = {})); - function moderationObjectToJSON(moderationObject) { - return JSON.stringify(exports.ModerationObject$outboundSchema.parse(moderationObject)); - } - function moderationObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationresponse.js - var require_moderationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationResponse$ = exports.ModerationResponse$outboundSchema = exports.ModerationResponse$inboundSchema = void 0; - exports.moderationResponseToJSON = moderationResponseToJSON; - exports.moderationResponseFromJSON = moderationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var moderationobject_js_1 = require_moderationobject(); - exports.ModerationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$inboundSchema) - }); - exports.ModerationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$outboundSchema) - }); - var ModerationResponse$; - (function(ModerationResponse$2) { - ModerationResponse$2.inboundSchema = exports.ModerationResponse$inboundSchema; - ModerationResponse$2.outboundSchema = exports.ModerationResponse$outboundSchema; - })(ModerationResponse$ || (exports.ModerationResponse$ = ModerationResponse$ = {})); - function moderationResponseToJSON(moderationResponse) { - return JSON.stringify(exports.ModerationResponse$outboundSchema.parse(moderationResponse)); - } - function moderationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrimageobject.js - var require_ocrimageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrimageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRImageObject$ = exports.OCRImageObject$outboundSchema = exports.OCRImageObject$inboundSchema = void 0; - exports.ocrImageObjectToJSON = ocrImageObjectToJSON; - exports.ocrImageObjectFromJSON = ocrImageObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRImageObject$inboundSchema = z.object({ - id: z.string(), - top_left_x: z.nullable(z.number().int()), - top_left_y: z.nullable(z.number().int()), - bottom_right_x: z.nullable(z.number().int()), - bottom_right_y: z.nullable(z.number().int()), - image_base64: z.nullable(z.string()).optional(), - image_annotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_left_x": "topLeftX", - "top_left_y": "topLeftY", - "bottom_right_x": "bottomRightX", - "bottom_right_y": "bottomRightY", - "image_base64": "imageBase64", - "image_annotation": "imageAnnotation" - }); - }); - exports.OCRImageObject$outboundSchema = z.object({ - id: z.string(), - topLeftX: z.nullable(z.number().int()), - topLeftY: z.nullable(z.number().int()), - bottomRightX: z.nullable(z.number().int()), - bottomRightY: z.nullable(z.number().int()), - imageBase64: z.nullable(z.string()).optional(), - imageAnnotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topLeftX: "top_left_x", - topLeftY: "top_left_y", - bottomRightX: "bottom_right_x", - bottomRightY: "bottom_right_y", - imageBase64: "image_base64", - imageAnnotation: "image_annotation" - }); - }); - var OCRImageObject$; - (function(OCRImageObject$2) { - OCRImageObject$2.inboundSchema = exports.OCRImageObject$inboundSchema; - OCRImageObject$2.outboundSchema = exports.OCRImageObject$outboundSchema; - })(OCRImageObject$ || (exports.OCRImageObject$ = OCRImageObject$ = {})); - function ocrImageObjectToJSON(ocrImageObject) { - return JSON.stringify(exports.OCRImageObject$outboundSchema.parse(ocrImageObject)); - } - function ocrImageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRImageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRImageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js - var require_ocrpagedimensions = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageDimensions$ = exports.OCRPageDimensions$outboundSchema = exports.OCRPageDimensions$inboundSchema = void 0; - exports.ocrPageDimensionsToJSON = ocrPageDimensionsToJSON; - exports.ocrPageDimensionsFromJSON = ocrPageDimensionsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.OCRPageDimensions$inboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - exports.OCRPageDimensions$outboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - var OCRPageDimensions$; - (function(OCRPageDimensions$2) { - OCRPageDimensions$2.inboundSchema = exports.OCRPageDimensions$inboundSchema; - OCRPageDimensions$2.outboundSchema = exports.OCRPageDimensions$outboundSchema; - })(OCRPageDimensions$ || (exports.OCRPageDimensions$ = OCRPageDimensions$ = {})); - function ocrPageDimensionsToJSON(ocrPageDimensions) { - return JSON.stringify(exports.OCRPageDimensions$outboundSchema.parse(ocrPageDimensions)); - } - function ocrPageDimensionsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageDimensions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageDimensions' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpageobject.js - var require_ocrpageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageObject$ = exports.OCRPageObject$outboundSchema = exports.OCRPageObject$inboundSchema = void 0; - exports.ocrPageObjectToJSON = ocrPageObjectToJSON; - exports.ocrPageObjectFromJSON = ocrPageObjectFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var ocrimageobject_js_1 = require_ocrimageobject(); - var ocrpagedimensions_js_1 = require_ocrpagedimensions(); - exports.OCRPageObject$inboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$inboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$inboundSchema) - }); - exports.OCRPageObject$outboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$outboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$outboundSchema) - }); - var OCRPageObject$; - (function(OCRPageObject$2) { - OCRPageObject$2.inboundSchema = exports.OCRPageObject$inboundSchema; - OCRPageObject$2.outboundSchema = exports.OCRPageObject$outboundSchema; - })(OCRPageObject$ || (exports.OCRPageObject$ = OCRPageObject$ = {})); - function ocrPageObjectToJSON(ocrPageObject) { - return JSON.stringify(exports.OCRPageObject$outboundSchema.parse(ocrPageObject)); - } - function ocrPageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrrequest.js - var require_ocrrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRRequest$ = exports.OCRRequest$outboundSchema = exports.OCRRequest$inboundSchema = exports.Document$ = exports.Document$outboundSchema = exports.Document$inboundSchema = void 0; - exports.documentToJSON = documentToJSON; - exports.documentFromJSON = documentFromJSON; - exports.ocrRequestToJSON = ocrRequestToJSON; - exports.ocrRequestFromJSON = ocrRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var responseformat_js_1 = require_responseformat(); - exports.Document$inboundSchema = z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]); - exports.Document$outboundSchema = z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]); - var Document$; - (function(Document$2) { - Document$2.inboundSchema = exports.Document$inboundSchema; - Document$2.outboundSchema = exports.Document$outboundSchema; - })(Document$ || (exports.Document$ = Document$ = {})); - function documentToJSON(document) { - return JSON.stringify(exports.Document$outboundSchema.parse(document)); - } - function documentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Document$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Document' from JSON`); - } - exports.OCRRequest$inboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - include_image_base64: z.nullable(z.boolean()).optional(), - image_limit: z.nullable(z.number().int()).optional(), - image_min_size: z.nullable(z.number().int()).optional(), - bbox_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - document_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "include_image_base64": "includeImageBase64", - "image_limit": "imageLimit", - "image_min_size": "imageMinSize", - "bbox_annotation_format": "bboxAnnotationFormat", - "document_annotation_format": "documentAnnotationFormat" - }); - }); - exports.OCRRequest$outboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - includeImageBase64: z.nullable(z.boolean()).optional(), - imageLimit: z.nullable(z.number().int()).optional(), - imageMinSize: z.nullable(z.number().int()).optional(), - bboxAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - documentAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - includeImageBase64: "include_image_base64", - imageLimit: "image_limit", - imageMinSize: "image_min_size", - bboxAnnotationFormat: "bbox_annotation_format", - documentAnnotationFormat: "document_annotation_format" - }); - }); - var OCRRequest$; - (function(OCRRequest$2) { - OCRRequest$2.inboundSchema = exports.OCRRequest$inboundSchema; - OCRRequest$2.outboundSchema = exports.OCRRequest$outboundSchema; - })(OCRRequest$ || (exports.OCRRequest$ = OCRRequest$ = {})); - function ocrRequestToJSON(ocrRequest) { - return JSON.stringify(exports.OCRRequest$outboundSchema.parse(ocrRequest)); - } - function ocrRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js - var require_ocrusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRUsageInfo$ = exports.OCRUsageInfo$outboundSchema = exports.OCRUsageInfo$inboundSchema = void 0; - exports.ocrUsageInfoToJSON = ocrUsageInfoToJSON; - exports.ocrUsageInfoFromJSON = ocrUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRUsageInfo$inboundSchema = z.object({ - pages_processed: z.number().int(), - doc_size_bytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "pages_processed": "pagesProcessed", - "doc_size_bytes": "docSizeBytes" - }); - }); - exports.OCRUsageInfo$outboundSchema = z.object({ - pagesProcessed: z.number().int(), - docSizeBytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pagesProcessed: "pages_processed", - docSizeBytes: "doc_size_bytes" - }); - }); - var OCRUsageInfo$; - (function(OCRUsageInfo$2) { - OCRUsageInfo$2.inboundSchema = exports.OCRUsageInfo$inboundSchema; - OCRUsageInfo$2.outboundSchema = exports.OCRUsageInfo$outboundSchema; - })(OCRUsageInfo$ || (exports.OCRUsageInfo$ = OCRUsageInfo$ = {})); - function ocrUsageInfoToJSON(ocrUsageInfo) { - return JSON.stringify(exports.OCRUsageInfo$outboundSchema.parse(ocrUsageInfo)); - } - function ocrUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrresponse.js - var require_ocrresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRResponse$ = exports.OCRResponse$outboundSchema = exports.OCRResponse$inboundSchema = void 0; - exports.ocrResponseToJSON = ocrResponseToJSON; - exports.ocrResponseFromJSON = ocrResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ocrpageobject_js_1 = require_ocrpageobject(); - var ocrusageinfo_js_1 = require_ocrusageinfo(); - exports.OCRResponse$inboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$inboundSchema), - model: z.string(), - document_annotation: z.nullable(z.string()).optional(), - usage_info: ocrusageinfo_js_1.OCRUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_annotation": "documentAnnotation", - "usage_info": "usageInfo" - }); - }); - exports.OCRResponse$outboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$outboundSchema), - model: z.string(), - documentAnnotation: z.nullable(z.string()).optional(), - usageInfo: ocrusageinfo_js_1.OCRUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentAnnotation: "document_annotation", - usageInfo: "usage_info" - }); - }); - var OCRResponse$; - (function(OCRResponse$2) { - OCRResponse$2.inboundSchema = exports.OCRResponse$inboundSchema; - OCRResponse$2.outboundSchema = exports.OCRResponse$outboundSchema; - })(OCRResponse$ || (exports.OCRResponse$ = OCRResponse$ = {})); - function ocrResponseToJSON(ocrResponse) { - return JSON.stringify(exports.OCRResponse$outboundSchema.parse(ocrResponse)); - } - function ocrResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/processingstatusout.js - var require_processingstatusout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/processingstatusout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ProcessingStatusOut$ = exports.ProcessingStatusOut$outboundSchema = exports.ProcessingStatusOut$inboundSchema = void 0; - exports.processingStatusOutToJSON = processingStatusOutToJSON; - exports.processingStatusOutFromJSON = processingStatusOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ProcessingStatusOut$inboundSchema = z.object({ - document_id: z.string(), - processing_status: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_id": "documentId", - "processing_status": "processingStatus" - }); - }); - exports.ProcessingStatusOut$outboundSchema = z.object({ - documentId: z.string(), - processingStatus: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentId: "document_id", - processingStatus: "processing_status" - }); - }); - var ProcessingStatusOut$; - (function(ProcessingStatusOut$2) { - ProcessingStatusOut$2.inboundSchema = exports.ProcessingStatusOut$inboundSchema; - ProcessingStatusOut$2.outboundSchema = exports.ProcessingStatusOut$outboundSchema; - })(ProcessingStatusOut$ || (exports.ProcessingStatusOut$ = ProcessingStatusOut$ = {})); - function processingStatusOutToJSON(processingStatusOut) { - return JSON.stringify(exports.ProcessingStatusOut$outboundSchema.parse(processingStatusOut)); - } - function processingStatusOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ProcessingStatusOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ProcessingStatusOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/retrievefileout.js - var require_retrievefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/retrievefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveFileOut$ = exports.RetrieveFileOut$outboundSchema = exports.RetrieveFileOut$inboundSchema = void 0; - exports.retrieveFileOutToJSON = retrieveFileOutToJSON; - exports.retrieveFileOutFromJSON = retrieveFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.RetrieveFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.RetrieveFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var RetrieveFileOut$; - (function(RetrieveFileOut$2) { - RetrieveFileOut$2.inboundSchema = exports.RetrieveFileOut$inboundSchema; - RetrieveFileOut$2.outboundSchema = exports.RetrieveFileOut$outboundSchema; - })(RetrieveFileOut$ || (exports.RetrieveFileOut$ = RetrieveFileOut$ = {})); - function retrieveFileOutToJSON(retrieveFileOut) { - return JSON.stringify(exports.RetrieveFileOut$outboundSchema.parse(retrieveFileOut)); - } - function retrieveFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/security.js - var require_security2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/security.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Security$ = exports.Security$outboundSchema = exports.Security$inboundSchema = void 0; - exports.securityToJSON = securityToJSON; - exports.securityFromJSON = securityFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Security$inboundSchema = z.object({ - ApiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "ApiKey": "apiKey" - }); - }); - exports.Security$outboundSchema = z.object({ - apiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "ApiKey" - }); - }); - var Security$; - (function(Security$2) { - Security$2.inboundSchema = exports.Security$inboundSchema; - Security$2.outboundSchema = exports.Security$outboundSchema; - })(Security$ || (exports.Security$ = Security$ = {})); - function securityToJSON(security) { - return JSON.stringify(exports.Security$outboundSchema.parse(security)); - } - function securityFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Security$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Security' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/shareenum.js - var require_shareenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/shareenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ShareEnum$ = exports.ShareEnum$outboundSchema = exports.ShareEnum$inboundSchema = exports.ShareEnum = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ShareEnum = { - Viewer: "Viewer", - Editor: "Editor" - }; - exports.ShareEnum$inboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ShareEnum$outboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().and(z.custom()) - ]); - var ShareEnum$; - (function(ShareEnum$2) { - ShareEnum$2.inboundSchema = exports.ShareEnum$inboundSchema; - ShareEnum$2.outboundSchema = exports.ShareEnum$outboundSchema; - })(ShareEnum$ || (exports.ShareEnum$ = ShareEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingdelete.js - var require_sharingdelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingdelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingDelete$ = exports.SharingDelete$outboundSchema = exports.SharingDelete$inboundSchema = void 0; - exports.sharingDeleteToJSON = sharingDeleteToJSON; - exports.sharingDeleteFromJSON = sharingDeleteFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - exports.SharingDelete$inboundSchema = z.object({ - org_id: z.string(), - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingDelete$outboundSchema = z.object({ - orgId: z.string(), - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingDelete$; - (function(SharingDelete$2) { - SharingDelete$2.inboundSchema = exports.SharingDelete$inboundSchema; - SharingDelete$2.outboundSchema = exports.SharingDelete$outboundSchema; - })(SharingDelete$ || (exports.SharingDelete$ = SharingDelete$ = {})); - function sharingDeleteToJSON(sharingDelete) { - return JSON.stringify(exports.SharingDelete$outboundSchema.parse(sharingDelete)); - } - function sharingDeleteFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingDelete$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingDelete' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingin.js - var require_sharingin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingIn$ = exports.SharingIn$outboundSchema = exports.SharingIn$inboundSchema = void 0; - exports.sharingInToJSON = sharingInToJSON; - exports.sharingInFromJSON = sharingInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - var shareenum_js_1 = require_shareenum(); - exports.SharingIn$inboundSchema = z.object({ - org_id: z.string(), - level: shareenum_js_1.ShareEnum$inboundSchema, - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingIn$outboundSchema = z.object({ - orgId: z.string(), - level: shareenum_js_1.ShareEnum$outboundSchema, - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingIn$; - (function(SharingIn$2) { - SharingIn$2.inboundSchema = exports.SharingIn$inboundSchema; - SharingIn$2.outboundSchema = exports.SharingIn$outboundSchema; - })(SharingIn$ || (exports.SharingIn$ = SharingIn$ = {})); - function sharingInToJSON(sharingIn) { - return JSON.stringify(exports.SharingIn$outboundSchema.parse(sharingIn)); - } - function sharingInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js - var require_transcriptionsegmentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionSegmentChunk$ = exports.TranscriptionSegmentChunk$outboundSchema = exports.TranscriptionSegmentChunk$inboundSchema = exports.Type$ = exports.Type$outboundSchema = exports.Type$inboundSchema = exports.Type = void 0; - exports.transcriptionSegmentChunkToJSON = transcriptionSegmentChunkToJSON; - exports.transcriptionSegmentChunkFromJSON = transcriptionSegmentChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Type = { - TranscriptionSegment: "transcription_segment" - }; - exports.Type$inboundSchema = z.nativeEnum(exports.Type); - exports.Type$outboundSchema = exports.Type$inboundSchema; - var Type$; - (function(Type$2) { - Type$2.inboundSchema = exports.Type$inboundSchema; - Type$2.outboundSchema = exports.Type$outboundSchema; - })(Type$ || (exports.Type$ = Type$ = {})); - exports.TranscriptionSegmentChunk$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$inboundSchema.default("transcription_segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionSegmentChunk$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$outboundSchema.default("transcription_segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionSegmentChunk$; - (function(TranscriptionSegmentChunk$2) { - TranscriptionSegmentChunk$2.inboundSchema = exports.TranscriptionSegmentChunk$inboundSchema; - TranscriptionSegmentChunk$2.outboundSchema = exports.TranscriptionSegmentChunk$outboundSchema; - })(TranscriptionSegmentChunk$ || (exports.TranscriptionSegmentChunk$ = TranscriptionSegmentChunk$ = {})); - function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk) { - return JSON.stringify(exports.TranscriptionSegmentChunk$outboundSchema.parse(transcriptionSegmentChunk)); - } - function transcriptionSegmentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionSegmentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionSegmentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js - var require_transcriptionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionResponse$ = exports.TranscriptionResponse$outboundSchema = exports.TranscriptionResponse$inboundSchema = void 0; - exports.transcriptionResponseToJSON = transcriptionResponseToJSON; - exports.transcriptionResponseFromJSON = transcriptionResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionResponse$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionResponse$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionResponse$; - (function(TranscriptionResponse$2) { - TranscriptionResponse$2.inboundSchema = exports.TranscriptionResponse$inboundSchema; - TranscriptionResponse$2.outboundSchema = exports.TranscriptionResponse$outboundSchema; - })(TranscriptionResponse$ || (exports.TranscriptionResponse$ = TranscriptionResponse$ = {})); - function transcriptionResponseToJSON(transcriptionResponse) { - return JSON.stringify(exports.TranscriptionResponse$outboundSchema.parse(transcriptionResponse)); - } - function transcriptionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js - var require_transcriptionstreamdone = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamDone$ = exports.TranscriptionStreamDone$outboundSchema = exports.TranscriptionStreamDone$inboundSchema = exports.TranscriptionStreamDoneType$ = exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema = exports.TranscriptionStreamDoneType = void 0; - exports.transcriptionStreamDoneToJSON = transcriptionStreamDoneToJSON; - exports.transcriptionStreamDoneFromJSON = transcriptionStreamDoneFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionStreamDoneType = { - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamDoneType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamDoneType); - exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - var TranscriptionStreamDoneType$; - (function(TranscriptionStreamDoneType$2) { - TranscriptionStreamDoneType$2.inboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - TranscriptionStreamDoneType$2.outboundSchema = exports.TranscriptionStreamDoneType$outboundSchema; - })(TranscriptionStreamDoneType$ || (exports.TranscriptionStreamDoneType$ = TranscriptionStreamDoneType$ = {})); - exports.TranscriptionStreamDone$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - type: exports.TranscriptionStreamDoneType$inboundSchema.default("transcription.done"), - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamDone$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - type: exports.TranscriptionStreamDoneType$outboundSchema.default("transcription.done"), - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamDone$; - (function(TranscriptionStreamDone$2) { - TranscriptionStreamDone$2.inboundSchema = exports.TranscriptionStreamDone$inboundSchema; - TranscriptionStreamDone$2.outboundSchema = exports.TranscriptionStreamDone$outboundSchema; - })(TranscriptionStreamDone$ || (exports.TranscriptionStreamDone$ = TranscriptionStreamDone$ = {})); - function transcriptionStreamDoneToJSON(transcriptionStreamDone) { - return JSON.stringify(exports.TranscriptionStreamDone$outboundSchema.parse(transcriptionStreamDone)); - } - function transcriptionStreamDoneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamDone$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamDone' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js - var require_transcriptionstreameventtypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEventTypes$ = exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema = exports.TranscriptionStreamEventTypes = void 0; - var z = __importStar(require_zod()); - exports.TranscriptionStreamEventTypes = { - TranscriptionLanguage: "transcription.language", - TranscriptionSegment: "transcription.segment", - TranscriptionTextDelta: "transcription.text.delta", - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamEventTypes$inboundSchema = z.nativeEnum(exports.TranscriptionStreamEventTypes); - exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - var TranscriptionStreamEventTypes$; - (function(TranscriptionStreamEventTypes$2) { - TranscriptionStreamEventTypes$2.inboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - TranscriptionStreamEventTypes$2.outboundSchema = exports.TranscriptionStreamEventTypes$outboundSchema; - })(TranscriptionStreamEventTypes$ || (exports.TranscriptionStreamEventTypes$ = TranscriptionStreamEventTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js - var require_transcriptionstreamlanguage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamLanguage$ = exports.TranscriptionStreamLanguage$outboundSchema = exports.TranscriptionStreamLanguage$inboundSchema = exports.TranscriptionStreamLanguageType$ = exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema = exports.TranscriptionStreamLanguageType = void 0; - exports.transcriptionStreamLanguageToJSON = transcriptionStreamLanguageToJSON; - exports.transcriptionStreamLanguageFromJSON = transcriptionStreamLanguageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamLanguageType = { - TranscriptionLanguage: "transcription.language" - }; - exports.TranscriptionStreamLanguageType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamLanguageType); - exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - var TranscriptionStreamLanguageType$; - (function(TranscriptionStreamLanguageType$2) { - TranscriptionStreamLanguageType$2.inboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - TranscriptionStreamLanguageType$2.outboundSchema = exports.TranscriptionStreamLanguageType$outboundSchema; - })(TranscriptionStreamLanguageType$ || (exports.TranscriptionStreamLanguageType$ = TranscriptionStreamLanguageType$ = {})); - exports.TranscriptionStreamLanguage$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - type: exports.TranscriptionStreamLanguageType$inboundSchema.default("transcription.language"), - audio_language: z.string() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "audio_language": "audioLanguage" - }); - }); - exports.TranscriptionStreamLanguage$outboundSchema = z.object({ - type: exports.TranscriptionStreamLanguageType$outboundSchema.default("transcription.language"), - audioLanguage: z.string(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - audioLanguage: "audio_language", - additionalProperties: null - }) - }; - }); - var TranscriptionStreamLanguage$; - (function(TranscriptionStreamLanguage$2) { - TranscriptionStreamLanguage$2.inboundSchema = exports.TranscriptionStreamLanguage$inboundSchema; - TranscriptionStreamLanguage$2.outboundSchema = exports.TranscriptionStreamLanguage$outboundSchema; - })(TranscriptionStreamLanguage$ || (exports.TranscriptionStreamLanguage$ = TranscriptionStreamLanguage$ = {})); - function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage) { - return JSON.stringify(exports.TranscriptionStreamLanguage$outboundSchema.parse(transcriptionStreamLanguage)); - } - function transcriptionStreamLanguageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamLanguage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamLanguage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js - var require_transcriptionstreamsegmentdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamSegmentDelta$ = exports.TranscriptionStreamSegmentDelta$outboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema = exports.TranscriptionStreamSegmentDeltaType$ = exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema = exports.TranscriptionStreamSegmentDeltaType = void 0; - exports.transcriptionStreamSegmentDeltaToJSON = transcriptionStreamSegmentDeltaToJSON; - exports.transcriptionStreamSegmentDeltaFromJSON = transcriptionStreamSegmentDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamSegmentDeltaType = { - TranscriptionSegment: "transcription.segment" - }; - exports.TranscriptionStreamSegmentDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamSegmentDeltaType); - exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - var TranscriptionStreamSegmentDeltaType$; - (function(TranscriptionStreamSegmentDeltaType$2) { - TranscriptionStreamSegmentDeltaType$2.inboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - TranscriptionStreamSegmentDeltaType$2.outboundSchema = exports.TranscriptionStreamSegmentDeltaType$outboundSchema; - })(TranscriptionStreamSegmentDeltaType$ || (exports.TranscriptionStreamSegmentDeltaType$ = TranscriptionStreamSegmentDeltaType$ = {})); - exports.TranscriptionStreamSegmentDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$inboundSchema.default("transcription.segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamSegmentDelta$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$outboundSchema.default("transcription.segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamSegmentDelta$; - (function(TranscriptionStreamSegmentDelta$2) { - TranscriptionStreamSegmentDelta$2.inboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema; - TranscriptionStreamSegmentDelta$2.outboundSchema = exports.TranscriptionStreamSegmentDelta$outboundSchema; - })(TranscriptionStreamSegmentDelta$ || (exports.TranscriptionStreamSegmentDelta$ = TranscriptionStreamSegmentDelta$ = {})); - function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta) { - return JSON.stringify(exports.TranscriptionStreamSegmentDelta$outboundSchema.parse(transcriptionStreamSegmentDelta)); - } - function transcriptionStreamSegmentDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamSegmentDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamSegmentDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js - var require_transcriptionstreamtextdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamTextDelta$ = exports.TranscriptionStreamTextDelta$outboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema = exports.TranscriptionStreamTextDeltaType$ = exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema = exports.TranscriptionStreamTextDeltaType = void 0; - exports.transcriptionStreamTextDeltaToJSON = transcriptionStreamTextDeltaToJSON; - exports.transcriptionStreamTextDeltaFromJSON = transcriptionStreamTextDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamTextDeltaType = { - TranscriptionTextDelta: "transcription.text.delta" - }; - exports.TranscriptionStreamTextDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamTextDeltaType); - exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - var TranscriptionStreamTextDeltaType$; - (function(TranscriptionStreamTextDeltaType$2) { - TranscriptionStreamTextDeltaType$2.inboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - TranscriptionStreamTextDeltaType$2.outboundSchema = exports.TranscriptionStreamTextDeltaType$outboundSchema; - })(TranscriptionStreamTextDeltaType$ || (exports.TranscriptionStreamTextDeltaType$ = TranscriptionStreamTextDeltaType$ = {})); - exports.TranscriptionStreamTextDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$inboundSchema.default("transcription.text.delta") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamTextDelta$outboundSchema = z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$outboundSchema.default("transcription.text.delta"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamTextDelta$; - (function(TranscriptionStreamTextDelta$2) { - TranscriptionStreamTextDelta$2.inboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema; - TranscriptionStreamTextDelta$2.outboundSchema = exports.TranscriptionStreamTextDelta$outboundSchema; - })(TranscriptionStreamTextDelta$ || (exports.TranscriptionStreamTextDelta$ = TranscriptionStreamTextDelta$ = {})); - function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta) { - return JSON.stringify(exports.TranscriptionStreamTextDelta$outboundSchema.parse(transcriptionStreamTextDelta)); - } - function transcriptionStreamTextDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamTextDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamTextDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js - var require_transcriptionstreamevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEvents$ = exports.TranscriptionStreamEvents$outboundSchema = exports.TranscriptionStreamEvents$inboundSchema = exports.TranscriptionStreamEventsData$ = exports.TranscriptionStreamEventsData$outboundSchema = exports.TranscriptionStreamEventsData$inboundSchema = void 0; - exports.transcriptionStreamEventsDataToJSON = transcriptionStreamEventsDataToJSON; - exports.transcriptionStreamEventsDataFromJSON = transcriptionStreamEventsDataFromJSON; - exports.transcriptionStreamEventsToJSON = transcriptionStreamEventsToJSON; - exports.transcriptionStreamEventsFromJSON = transcriptionStreamEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var transcriptionstreamdone_js_1 = require_transcriptionstreamdone(); - var transcriptionstreameventtypes_js_1 = require_transcriptionstreameventtypes(); - var transcriptionstreamlanguage_js_1 = require_transcriptionstreamlanguage(); - var transcriptionstreamsegmentdelta_js_1 = require_transcriptionstreamsegmentdelta(); - var transcriptionstreamtextdelta_js_1 = require_transcriptionstreamtextdelta(); - exports.TranscriptionStreamEventsData$inboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - exports.TranscriptionStreamEventsData$outboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - var TranscriptionStreamEventsData$; - (function(TranscriptionStreamEventsData$2) { - TranscriptionStreamEventsData$2.inboundSchema = exports.TranscriptionStreamEventsData$inboundSchema; - TranscriptionStreamEventsData$2.outboundSchema = exports.TranscriptionStreamEventsData$outboundSchema; - })(TranscriptionStreamEventsData$ || (exports.TranscriptionStreamEventsData$ = TranscriptionStreamEventsData$ = {})); - function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData) { - return JSON.stringify(exports.TranscriptionStreamEventsData$outboundSchema.parse(transcriptionStreamEventsData)); - } - function transcriptionStreamEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEventsData' from JSON`); - } - exports.TranscriptionStreamEvents$inboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ type: v.type }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.TranscriptionStreamEvents$outboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$outboundSchema, - data: z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]) - }); - var TranscriptionStreamEvents$; - (function(TranscriptionStreamEvents$2) { - TranscriptionStreamEvents$2.inboundSchema = exports.TranscriptionStreamEvents$inboundSchema; - TranscriptionStreamEvents$2.outboundSchema = exports.TranscriptionStreamEvents$outboundSchema; - })(TranscriptionStreamEvents$ || (exports.TranscriptionStreamEvents$ = TranscriptionStreamEvents$ = {})); - function transcriptionStreamEventsToJSON(transcriptionStreamEvents) { - return JSON.stringify(exports.TranscriptionStreamEvents$outboundSchema.parse(transcriptionStreamEvents)); - } - function transcriptionStreamEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js - var require_unarchiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UnarchiveFTModelOut$ = exports.UnarchiveFTModelOut$outboundSchema = exports.UnarchiveFTModelOut$inboundSchema = exports.UnarchiveFTModelOutObject$ = exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema = exports.UnarchiveFTModelOutObject = void 0; - exports.unarchiveFTModelOutToJSON = unarchiveFTModelOutToJSON; - exports.unarchiveFTModelOutFromJSON = unarchiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UnarchiveFTModelOutObject = { - Model: "model" - }; - exports.UnarchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.UnarchiveFTModelOutObject); - exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - var UnarchiveFTModelOutObject$; - (function(UnarchiveFTModelOutObject$2) { - UnarchiveFTModelOutObject$2.inboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - UnarchiveFTModelOutObject$2.outboundSchema = exports.UnarchiveFTModelOutObject$outboundSchema; - })(UnarchiveFTModelOutObject$ || (exports.UnarchiveFTModelOutObject$ = UnarchiveFTModelOutObject$ = {})); - exports.UnarchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(false) - }); - exports.UnarchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(false) - }); - var UnarchiveFTModelOut$; - (function(UnarchiveFTModelOut$2) { - UnarchiveFTModelOut$2.inboundSchema = exports.UnarchiveFTModelOut$inboundSchema; - UnarchiveFTModelOut$2.outboundSchema = exports.UnarchiveFTModelOut$outboundSchema; - })(UnarchiveFTModelOut$ || (exports.UnarchiveFTModelOut$ = UnarchiveFTModelOut$ = {})); - function unarchiveFTModelOutToJSON(unarchiveFTModelOut) { - return JSON.stringify(exports.UnarchiveFTModelOut$outboundSchema.parse(unarchiveFTModelOut)); - } - function unarchiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UnarchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UnarchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/updateftmodelin.js - var require_updateftmodelin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/updateftmodelin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UpdateFTModelIn$ = exports.UpdateFTModelIn$outboundSchema = exports.UpdateFTModelIn$inboundSchema = void 0; - exports.updateFTModelInToJSON = updateFTModelInToJSON; - exports.updateFTModelInFromJSON = updateFTModelInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UpdateFTModelIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.UpdateFTModelIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var UpdateFTModelIn$; - (function(UpdateFTModelIn$2) { - UpdateFTModelIn$2.inboundSchema = exports.UpdateFTModelIn$inboundSchema; - UpdateFTModelIn$2.outboundSchema = exports.UpdateFTModelIn$outboundSchema; - })(UpdateFTModelIn$ || (exports.UpdateFTModelIn$ = UpdateFTModelIn$ = {})); - function updateFTModelInToJSON(updateFTModelIn) { - return JSON.stringify(exports.UpdateFTModelIn$outboundSchema.parse(updateFTModelIn)); - } - function updateFTModelInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UpdateFTModelIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UpdateFTModelIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/uploadfileout.js - var require_uploadfileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/uploadfileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UploadFileOut$ = exports.UploadFileOut$outboundSchema = exports.UploadFileOut$inboundSchema = void 0; - exports.uploadFileOutToJSON = uploadFileOutToJSON; - exports.uploadFileOutFromJSON = uploadFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.UploadFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.UploadFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var UploadFileOut$; - (function(UploadFileOut$2) { - UploadFileOut$2.inboundSchema = exports.UploadFileOut$inboundSchema; - UploadFileOut$2.outboundSchema = exports.UploadFileOut$outboundSchema; - })(UploadFileOut$ || (exports.UploadFileOut$ = UploadFileOut$ = {})); - function uploadFileOutToJSON(uploadFileOut) { - return JSON.stringify(exports.UploadFileOut$outboundSchema.parse(uploadFileOut)); - } - function uploadFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UploadFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UploadFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/validationerror.js - var require_validationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/validationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ValidationError$ = exports.ValidationError$outboundSchema = exports.ValidationError$inboundSchema = exports.Loc$ = exports.Loc$outboundSchema = exports.Loc$inboundSchema = void 0; - exports.locToJSON = locToJSON; - exports.locFromJSON = locFromJSON; - exports.validationErrorToJSON = validationErrorToJSON; - exports.validationErrorFromJSON = validationErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Loc$inboundSchema = z.union([z.string(), z.number().int()]); - exports.Loc$outboundSchema = z.union([z.string(), z.number().int()]); - var Loc$; - (function(Loc$2) { - Loc$2.inboundSchema = exports.Loc$inboundSchema; - Loc$2.outboundSchema = exports.Loc$outboundSchema; - })(Loc$ || (exports.Loc$ = Loc$ = {})); - function locToJSON(loc) { - return JSON.stringify(exports.Loc$outboundSchema.parse(loc)); - } - function locFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Loc$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Loc' from JSON`); - } - exports.ValidationError$inboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - exports.ValidationError$outboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - var ValidationError$; - (function(ValidationError$2) { - ValidationError$2.inboundSchema = exports.ValidationError$inboundSchema; - ValidationError$2.outboundSchema = exports.ValidationError$outboundSchema; - })(ValidationError$ || (exports.ValidationError$ = ValidationError$ = {})); - function validationErrorToJSON(validationError) { - return JSON.stringify(exports.ValidationError$outboundSchema.parse(validationError)); - } - function validationErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ValidationError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ValidationError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/index.js - var require_components = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agent(), exports); - __exportStar(require_agentconversation(), exports); - __exportStar(require_agentcreationrequest(), exports); - __exportStar(require_agenthandoffdoneevent(), exports); - __exportStar(require_agenthandoffentry(), exports); - __exportStar(require_agenthandoffstartedevent(), exports); - __exportStar(require_agentscompletionrequest(), exports); - __exportStar(require_agentscompletionstreamrequest(), exports); - __exportStar(require_agentupdaterequest(), exports); - __exportStar(require_apiendpoint(), exports); - __exportStar(require_archiveftmodelout(), exports); - __exportStar(require_assistantmessage(), exports); - __exportStar(require_audiochunk(), exports); - __exportStar(require_audiotranscriptionrequest(), exports); - __exportStar(require_audiotranscriptionrequeststream(), exports); - __exportStar(require_basemodelcard(), exports); - __exportStar(require_batcherror(), exports); - __exportStar(require_batchjobin(), exports); - __exportStar(require_batchjobout(), exports); - __exportStar(require_batchjobsout(), exports); - __exportStar(require_batchjobstatus(), exports); - __exportStar(require_builtinconnectors(), exports); - __exportStar(require_chatclassificationrequest(), exports); - __exportStar(require_chatcompletionchoice(), exports); - __exportStar(require_chatcompletionrequest(), exports); - __exportStar(require_chatcompletionresponse(), exports); - __exportStar(require_chatcompletionstreamrequest(), exports); - __exportStar(require_chatmoderationrequest(), exports); - __exportStar(require_checkpointout(), exports); - __exportStar(require_classificationrequest(), exports); - __exportStar(require_classificationresponse(), exports); - __exportStar(require_classificationtargetresult(), exports); - __exportStar(require_classifierdetailedjobout(), exports); - __exportStar(require_classifierftmodelout(), exports); - __exportStar(require_classifierjobout(), exports); - __exportStar(require_classifiertargetin(), exports); - __exportStar(require_classifiertargetout(), exports); - __exportStar(require_classifiertrainingparameters(), exports); - __exportStar(require_classifiertrainingparametersin(), exports); - __exportStar(require_codeinterpretertool(), exports); - __exportStar(require_completionargs(), exports); - __exportStar(require_completionargsstop(), exports); - __exportStar(require_completionchunk(), exports); - __exportStar(require_completiondetailedjobout(), exports); - __exportStar(require_completionevent(), exports); - __exportStar(require_completionftmodelout(), exports); - __exportStar(require_completionjobout(), exports); - __exportStar(require_completionresponsestreamchoice(), exports); - __exportStar(require_completiontrainingparameters(), exports); - __exportStar(require_completiontrainingparametersin(), exports); - __exportStar(require_contentchunk(), exports); - __exportStar(require_conversationappendrequest(), exports); - __exportStar(require_conversationappendstreamrequest(), exports); - __exportStar(require_conversationevents(), exports); - __exportStar(require_conversationhistory(), exports); - __exportStar(require_conversationinputs(), exports); - __exportStar(require_conversationmessages(), exports); - __exportStar(require_conversationrequest(), exports); - __exportStar(require_conversationresponse(), exports); - __exportStar(require_conversationrestartrequest(), exports); - __exportStar(require_conversationrestartstreamrequest(), exports); - __exportStar(require_conversationstreamrequest(), exports); - __exportStar(require_conversationusageinfo(), exports); - __exportStar(require_deletefileout(), exports); - __exportStar(require_deletemodelout(), exports); - __exportStar(require_deltamessage(), exports); - __exportStar(require_documentlibrarytool(), exports); - __exportStar(require_documentout(), exports); - __exportStar(require_documenttextcontent(), exports); - __exportStar(require_documentupdatein(), exports); - __exportStar(require_documenturlchunk(), exports); - __exportStar(require_embeddingdtype(), exports); - __exportStar(require_embeddingrequest(), exports); - __exportStar(require_embeddingresponse(), exports); - __exportStar(require_embeddingresponsedata(), exports); - __exportStar(require_encodingformat(), exports); - __exportStar(require_entitytype(), exports); - __exportStar(require_eventout(), exports); - __exportStar(require_file(), exports); - __exportStar(require_filechunk(), exports); - __exportStar(require_filepurpose(), exports); - __exportStar(require_fileschema(), exports); - __exportStar(require_filesignedurl(), exports); - __exportStar(require_fimcompletionrequest(), exports); - __exportStar(require_fimcompletionresponse(), exports); - __exportStar(require_fimcompletionstreamrequest(), exports); - __exportStar(require_finetuneablemodeltype(), exports); - __exportStar(require_ftclassifierlossfunction(), exports); - __exportStar(require_ftmodelcapabilitiesout(), exports); - __exportStar(require_ftmodelcard(), exports); - __exportStar(require_function(), exports); - __exportStar(require_functioncall(), exports); - __exportStar(require_functioncallentry(), exports); - __exportStar(require_functioncallentryarguments(), exports); - __exportStar(require_functioncallevent(), exports); - __exportStar(require_functionname(), exports); - __exportStar(require_functionresultentry(), exports); - __exportStar(require_functiontool(), exports); - __exportStar(require_githubrepositoryin(), exports); - __exportStar(require_githubrepositoryout(), exports); - __exportStar(require_imagegenerationtool(), exports); - __exportStar(require_imageurl(), exports); - __exportStar(require_imageurlchunk(), exports); - __exportStar(require_inputentries(), exports); - __exportStar(require_inputs(), exports); - __exportStar(require_instructrequest(), exports); - __exportStar(require_jobin(), exports); - __exportStar(require_jobmetadataout(), exports); - __exportStar(require_jobsout(), exports); - __exportStar(require_jsonschema(), exports); - __exportStar(require_legacyjobmetadataout(), exports); - __exportStar(require_libraryin(), exports); - __exportStar(require_libraryinupdate(), exports); - __exportStar(require_libraryout(), exports); - __exportStar(require_listdocumentout(), exports); - __exportStar(require_listfilesout(), exports); - __exportStar(require_listlibraryout(), exports); - __exportStar(require_listsharingout(), exports); - __exportStar(require_messageentries(), exports); - __exportStar(require_messageinputcontentchunks(), exports); - __exportStar(require_messageinputentry(), exports); - __exportStar(require_messageoutputcontentchunks(), exports); - __exportStar(require_messageoutputentry(), exports); - __exportStar(require_messageoutputevent(), exports); - __exportStar(require_metricout(), exports); - __exportStar(require_mistralpromptmode(), exports); - __exportStar(require_modelcapabilities(), exports); - __exportStar(require_modelconversation(), exports); - __exportStar(require_modellist(), exports); - __exportStar(require_moderationobject(), exports); - __exportStar(require_moderationresponse(), exports); - __exportStar(require_ocrimageobject(), exports); - __exportStar(require_ocrpagedimensions(), exports); - __exportStar(require_ocrpageobject(), exports); - __exportStar(require_ocrrequest(), exports); - __exportStar(require_ocrresponse(), exports); - __exportStar(require_ocrusageinfo(), exports); - __exportStar(require_outputcontentchunks(), exports); - __exportStar(require_paginationinfo(), exports); - __exportStar(require_prediction(), exports); - __exportStar(require_processingstatusout(), exports); - __exportStar(require_referencechunk(), exports); - __exportStar(require_responsedoneevent(), exports); - __exportStar(require_responseerrorevent(), exports); - __exportStar(require_responseformat(), exports); - __exportStar(require_responseformats(), exports); - __exportStar(require_responsestartedevent(), exports); - __exportStar(require_retrievefileout(), exports); - __exportStar(require_sampletype(), exports); - __exportStar(require_security2(), exports); - __exportStar(require_shareenum(), exports); - __exportStar(require_sharingdelete(), exports); - __exportStar(require_sharingin(), exports); - __exportStar(require_sharingout(), exports); - __exportStar(require_source(), exports); - __exportStar(require_ssetypes(), exports); - __exportStar(require_systemmessage(), exports); - __exportStar(require_systemmessagecontentchunks(), exports); - __exportStar(require_textchunk(), exports); - __exportStar(require_thinkchunk(), exports); - __exportStar(require_timestampgranularity(), exports); - __exportStar(require_tool(), exports); - __exportStar(require_toolcall(), exports); - __exportStar(require_toolchoice(), exports); - __exportStar(require_toolchoiceenum(), exports); - __exportStar(require_toolexecutiondeltaevent(), exports); - __exportStar(require_toolexecutiondoneevent(), exports); - __exportStar(require_toolexecutionentry(), exports); - __exportStar(require_toolexecutionstartedevent(), exports); - __exportStar(require_toolfilechunk(), exports); - __exportStar(require_toolmessage(), exports); - __exportStar(require_toolreferencechunk(), exports); - __exportStar(require_tooltypes(), exports); - __exportStar(require_trainingfile(), exports); - __exportStar(require_transcriptionresponse(), exports); - __exportStar(require_transcriptionsegmentchunk(), exports); - __exportStar(require_transcriptionstreamdone(), exports); - __exportStar(require_transcriptionstreamevents(), exports); - __exportStar(require_transcriptionstreameventtypes(), exports); - __exportStar(require_transcriptionstreamlanguage(), exports); - __exportStar(require_transcriptionstreamsegmentdelta(), exports); - __exportStar(require_transcriptionstreamtextdelta(), exports); - __exportStar(require_unarchiveftmodelout(), exports); - __exportStar(require_updateftmodelin(), exports); - __exportStar(require_uploadfileout(), exports); - __exportStar(require_usageinfo(), exports); - __exportStar(require_usermessage(), exports); - __exportStar(require_validationerror(), exports); - __exportStar(require_wandbintegration(), exports); - __exportStar(require_wandbintegrationout(), exports); - __exportStar(require_websearchpremiumtool(), exports); - __exportStar(require_websearchtool(), exports); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js - var require_httpvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPValidationError$ = exports.HTTPValidationError$outboundSchema = exports.HTTPValidationError$inboundSchema = exports.HTTPValidationError = void 0; - var z = __importStar(require_zod()); - var components = __importStar(require_components()); - var mistralerror_js_1 = require_mistralerror(); - var HTTPValidationError = class extends mistralerror_js_1.MistralError { - constructor(err, httpMeta) { - const message = "message" in err && typeof err.message === "string" ? err.message : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - if (err.detail != null) - this.detail = err.detail; - this.name = "HTTPValidationError"; - } - }; - exports.HTTPValidationError = HTTPValidationError; - exports.HTTPValidationError$inboundSchema = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), - request$: z.instanceof(Request), - response$: z.instanceof(Response), - body$: z.string() - }).transform((v) => { - return new HTTPValidationError(v, { - request: v.request$, - response: v.response$, - body: v.body$ - }); - }); - exports.HTTPValidationError$outboundSchema = z.instanceof(HTTPValidationError).transform((v) => v.data$).pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional() - })); - var HTTPValidationError$; - (function(HTTPValidationError$2) { - HTTPValidationError$2.inboundSchema = exports.HTTPValidationError$inboundSchema; - HTTPValidationError$2.outboundSchema = exports.HTTPValidationError$outboundSchema; - })(HTTPValidationError$ || (exports.HTTPValidationError$ = HTTPValidationError$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/index.js - var require_errors2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_httpclienterrors(), exports); - __exportStar(require_httpvalidationerror(), exports); - __exportStar(require_responsevalidationerror(), exports); - __exportStar(require_sdkerror(), exports); - __exportStar(require_sdkvalidationerror(), exports); - } - }); - - // node_modules/@mistralai/mistralai/types/async.js - var require_async = __commonJS({ - "node_modules/@mistralai/mistralai/types/async.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _APIPromise_promise; - var _APIPromise_unwrapped; - var _a; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.APIPromise = void 0; - var APIPromise = class { - constructor(p) { - _APIPromise_promise.set(this, void 0); - _APIPromise_unwrapped.set(this, void 0); - this[_a] = "APIPromise"; - __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f"); - __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value) : Promise.resolve(p[0]), "f"); - } - then(onfulfilled, onrejected) { - return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected); - } - catch(onrejected) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected); - } - finally(onfinally) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally); - } - $inspect() { - return __classPrivateFieldGet(this, _APIPromise_promise, "f"); - } - }; - exports.APIPromise = APIPromise; - _APIPromise_promise = /* @__PURE__ */ new WeakMap(), _APIPromise_unwrapped = /* @__PURE__ */ new WeakMap(), _a = Symbol.toStringTag; - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsComplete.js - var require_agentsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsComplete = agentsComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_completion_v1_agents_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/event-streams.js - var require_event_streams = __commonJS({ - "node_modules/@mistralai/mistralai/lib/event-streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventStream = void 0; - var EventStream = class extends ReadableStream { - constructor(responseBody, parse) { - const upstream = responseBody.getReader(); - let buffer = new Uint8Array(); - super({ - async pull(downstream) { - try { - while (true) { - const match = findBoundary(buffer); - if (!match) { - const chunk = await upstream.read(); - if (chunk.done) - return downstream.close(); - buffer = concatBuffer(buffer, chunk.value); - continue; - } - const message = buffer.slice(0, match.index); - buffer = buffer.slice(match.index + match.length); - const item = parseMessage(message, parse); - if (item?.value) - return downstream.enqueue(item.value); - if (item?.done) { - await upstream.cancel("done"); - return downstream.close(); - } - } - } catch (e) { - downstream.error(e); - await upstream.cancel(e); - } - }, - cancel: (reason) => upstream.cancel(reason) - }); - } - // Polyfill for older browsers - [Symbol.asyncIterator]() { - const fn = ReadableStream.prototype[Symbol.asyncIterator]; - if (typeof fn === "function") - return fn.call(this); - const reader = this.getReader(); - return { - next: async () => { - const r = await reader.read(); - if (r.done) { - reader.releaseLock(); - return { done: true, value: void 0 }; - } - return { done: false, value: r.value }; - }, - throw: async (e) => { - await reader.cancel(e); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - return: async () => { - await reader.cancel("done"); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - [Symbol.asyncIterator]() { - return this; - } - }; - } - }; - exports.EventStream = EventStream; - function concatBuffer(a, b) { - const c = new Uint8Array(a.length + b.length); - c.set(a, 0); - c.set(b, a.length); - return c; - } - function findBoundary(buf) { - const len = buf.length; - for (let i = 0; i < len; i++) { - if (i <= len - 4 && buf[i] === 13 && buf[i + 1] === 10 && buf[i + 2] === 13 && buf[i + 3] === 10) { - return { index: i, length: 4 }; - } - if (i <= len - 2 && buf[i] === 13 && buf[i + 1] === 13) { - return { index: i, length: 2 }; - } - if (i <= len - 2 && buf[i] === 10 && buf[i + 1] === 10) { - return { index: i, length: 2 }; - } - } - return null; - } - function parseMessage(chunk, parse) { - const text = new TextDecoder().decode(chunk); - const lines = text.split(/\r\n|\r|\n/); - const dataLines = []; - const ret = {}; - let ignore = true; - for (const line of lines) { - if (!line || line.startsWith(":")) - continue; - ignore = false; - const i = line.indexOf(":"); - const field = line.slice(0, i); - const value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1); - if (field === "data") - dataLines.push(value); - else if (field === "event") - ret.event = value; - else if (field === "id") - ret.id = value; - else if (field === "retry") { - const n = Number(value); - if (!isNaN(n)) - ret.retry = n; - } - } - if (ignore) - return; - if (dataLines.length) - ret.data = dataLines.join("\n"); - return parse(ret); - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsStream.js - var require_agentsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsStream = agentsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_agents", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/agents.js - var require_agents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/agents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agents = void 0; - var agentsComplete_js_1 = require_agentsComplete(); - var agentsStream_js_1 = require_agentsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Agents = class extends sdks_js_1.ClientSDK { - /** - * Agents Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsComplete_js_1.agentsComplete)(this, request, options)); - } - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsStream_js_1.agentsStream)(this, request, options)); - } - }; - exports.Agents = Agents; - } - }); - - // node_modules/@mistralai/mistralai/types/streams.js - var require_streams = __commonJS({ - "node_modules/@mistralai/mistralai/types/streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isReadableStream = isReadableStream; - function isReadableStream(val) { - if (typeof val !== "object" || val === null) { - return false; - } - const stream = val; - return typeof stream.getReader === "function" && typeof stream.cancel === "function" && typeof stream.tee === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js - var require_audioTranscriptionsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsComplete = audioTranscriptionsComplete; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.TranscriptionResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js - var require_audioTranscriptionsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsStream = audioTranscriptionsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequestStream$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.TranscriptionStreamEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/transcriptions.js - var require_transcriptions = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/transcriptions.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Transcriptions = void 0; - var audioTranscriptionsComplete_js_1 = require_audioTranscriptionsComplete(); - var audioTranscriptionsStream_js_1 = require_audioTranscriptionsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Transcriptions = class extends sdks_js_1.ClientSDK { - /** - * Create Transcription - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsComplete_js_1.audioTranscriptionsComplete)(this, request, options)); - } - /** - * Create streaming transcription (SSE) - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsStream_js_1.audioTranscriptionsStream)(this, request, options)); - } - }; - exports.Transcriptions = Transcriptions; - } - }); - - // node_modules/@mistralai/mistralai/sdk/audio.js - var require_audio = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/audio.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Audio = void 0; - var sdks_js_1 = require_sdks(); - var transcriptions_js_1 = require_transcriptions(); - var Audio = class extends sdks_js_1.ClientSDK { - get transcriptions() { - return this._transcriptions ?? (this._transcriptions = new transcriptions_js_1.Transcriptions(this._options)); - } - }; - exports.Audio = Audio; - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js - var require_agentsapiv1agentsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsGetRequest$ = exports.AgentsApiV1AgentsGetRequest$outboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsGetRequestToJSON = agentsApiV1AgentsGetRequestToJSON; - exports.agentsApiV1AgentsGetRequestFromJSON = agentsApiV1AgentsGetRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsGetRequest$inboundSchema = z.object({ - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsGetRequest$outboundSchema = z.object({ - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsGetRequest$; - (function(AgentsApiV1AgentsGetRequest$2) { - AgentsApiV1AgentsGetRequest$2.inboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema; - AgentsApiV1AgentsGetRequest$2.outboundSchema = exports.AgentsApiV1AgentsGetRequest$outboundSchema; - })(AgentsApiV1AgentsGetRequest$ || (exports.AgentsApiV1AgentsGetRequest$ = AgentsApiV1AgentsGetRequest$ = {})); - function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsGetRequest$outboundSchema.parse(agentsApiV1AgentsGetRequest)); - } - function agentsApiV1AgentsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsGetRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js - var require_agentsapiv1agentslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsListRequest$ = exports.AgentsApiV1AgentsListRequest$outboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsListRequestToJSON = agentsApiV1AgentsListRequestToJSON; - exports.agentsApiV1AgentsListRequestFromJSON = agentsApiV1AgentsListRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1AgentsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1AgentsListRequest$; - (function(AgentsApiV1AgentsListRequest$2) { - AgentsApiV1AgentsListRequest$2.inboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema; - AgentsApiV1AgentsListRequest$2.outboundSchema = exports.AgentsApiV1AgentsListRequest$outboundSchema; - })(AgentsApiV1AgentsListRequest$ || (exports.AgentsApiV1AgentsListRequest$ = AgentsApiV1AgentsListRequest$ = {})); - function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsListRequest$outboundSchema.parse(agentsApiV1AgentsListRequest)); - } - function agentsApiV1AgentsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsListRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js - var require_agentsapiv1agentsupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateRequest$ = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateRequestToJSON = agentsApiV1AgentsUpdateRequestToJSON; - exports.agentsApiV1AgentsUpdateRequestFromJSON = agentsApiV1AgentsUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = z.object({ - agent_id: z.string(), - AgentUpdateRequest: components.AgentUpdateRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId", - "AgentUpdateRequest": "agentUpdateRequest" - }); - }); - exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = z.object({ - agentId: z.string(), - agentUpdateRequest: components.AgentUpdateRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id", - agentUpdateRequest: "AgentUpdateRequest" - }); - }); - var AgentsApiV1AgentsUpdateRequest$; - (function(AgentsApiV1AgentsUpdateRequest$2) { - AgentsApiV1AgentsUpdateRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema; - AgentsApiV1AgentsUpdateRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateRequest$ || (exports.AgentsApiV1AgentsUpdateRequest$ = AgentsApiV1AgentsUpdateRequest$ = {})); - function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(agentsApiV1AgentsUpdateRequest)); - } - function agentsApiV1AgentsUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js - var require_agentsapiv1agentsupdateversion = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateVersionRequest$ = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateVersionRequestToJSON = agentsApiV1AgentsUpdateVersionRequestToJSON; - exports.agentsApiV1AgentsUpdateVersionRequestFromJSON = agentsApiV1AgentsUpdateVersionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = z.object({ - agent_id: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = z.object({ - agentId: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsUpdateVersionRequest$; - (function(AgentsApiV1AgentsUpdateVersionRequest$2) { - AgentsApiV1AgentsUpdateVersionRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema; - AgentsApiV1AgentsUpdateVersionRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateVersionRequest$ || (exports.AgentsApiV1AgentsUpdateVersionRequest$ = AgentsApiV1AgentsUpdateVersionRequest$ = {})); - function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(agentsApiV1AgentsUpdateVersionRequest)); - } - function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateVersionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js - var require_agentsapiv1conversationsappend = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendRequest$ = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendRequestToJSON = agentsApiV1ConversationsAppendRequestToJSON; - exports.agentsApiV1ConversationsAppendRequestFromJSON = agentsApiV1ConversationsAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendRequest: components.ConversationAppendRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendRequest": "conversationAppendRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendRequest: components.ConversationAppendRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendRequest: "ConversationAppendRequest" - }); - }); - var AgentsApiV1ConversationsAppendRequest$; - (function(AgentsApiV1ConversationsAppendRequest$2) { - AgentsApiV1ConversationsAppendRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema; - AgentsApiV1ConversationsAppendRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendRequest$ || (exports.AgentsApiV1ConversationsAppendRequest$ = AgentsApiV1ConversationsAppendRequest$ = {})); - function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(agentsApiV1ConversationsAppendRequest)); - } - function agentsApiV1ConversationsAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js - var require_agentsapiv1conversationsappendstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendStreamRequest$ = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendStreamRequestToJSON = agentsApiV1ConversationsAppendStreamRequestToJSON; - exports.agentsApiV1ConversationsAppendStreamRequestFromJSON = agentsApiV1ConversationsAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendStreamRequest": "conversationAppendStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendStreamRequest: components.ConversationAppendStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendStreamRequest: "ConversationAppendStreamRequest" - }); - }); - var AgentsApiV1ConversationsAppendStreamRequest$; - (function(AgentsApiV1ConversationsAppendStreamRequest$2) { - AgentsApiV1ConversationsAppendStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema; - AgentsApiV1ConversationsAppendStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendStreamRequest$ || (exports.AgentsApiV1ConversationsAppendStreamRequest$ = AgentsApiV1ConversationsAppendStreamRequest$ = {})); - function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(agentsApiV1ConversationsAppendStreamRequest)); - } - function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js - var require_agentsapiv1conversationsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = exports.AgentsApiV1ConversationsGetRequest$ = exports.AgentsApiV1ConversationsGetRequest$outboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsGetRequestToJSON = agentsApiV1ConversationsGetRequestToJSON; - exports.agentsApiV1ConversationsGetRequestFromJSON = agentsApiV1ConversationsGetRequestFromJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsGetRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsGetRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsGetRequest$; - (function(AgentsApiV1ConversationsGetRequest$2) { - AgentsApiV1ConversationsGetRequest$2.inboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema; - AgentsApiV1ConversationsGetRequest$2.outboundSchema = exports.AgentsApiV1ConversationsGetRequest$outboundSchema; - })(AgentsApiV1ConversationsGetRequest$ || (exports.AgentsApiV1ConversationsGetRequest$ = AgentsApiV1ConversationsGetRequest$ = {})); - function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(agentsApiV1ConversationsGetRequest)); - } - function agentsApiV1ConversationsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetRequest' from JSON`); - } - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var AgentsApiV1ConversationsGetResponseV1ConversationsGet$; - (function(AgentsApiV1ConversationsGetResponseV1ConversationsGet$2) { - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.inboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema; - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema; - })(AgentsApiV1ConversationsGetResponseV1ConversationsGet$ || (exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = {})); - function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema.parse(agentsApiV1ConversationsGetResponseV1ConversationsGet)); - } - function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetResponseV1ConversationsGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js - var require_agentsapiv1conversationshistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsHistoryRequest$ = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsHistoryRequestToJSON = agentsApiV1ConversationsHistoryRequestToJSON; - exports.agentsApiV1ConversationsHistoryRequestFromJSON = agentsApiV1ConversationsHistoryRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsHistoryRequest$; - (function(AgentsApiV1ConversationsHistoryRequest$2) { - AgentsApiV1ConversationsHistoryRequest$2.inboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema; - AgentsApiV1ConversationsHistoryRequest$2.outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema; - })(AgentsApiV1ConversationsHistoryRequest$ || (exports.AgentsApiV1ConversationsHistoryRequest$ = AgentsApiV1ConversationsHistoryRequest$ = {})); - function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(agentsApiV1ConversationsHistoryRequest)); - } - function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsHistoryRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js - var require_agentsapiv1conversationslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseBody$ = exports.ResponseBody$outboundSchema = exports.ResponseBody$inboundSchema = exports.AgentsApiV1ConversationsListRequest$ = exports.AgentsApiV1ConversationsListRequest$outboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsListRequestToJSON = agentsApiV1ConversationsListRequestToJSON; - exports.agentsApiV1ConversationsListRequestFromJSON = agentsApiV1ConversationsListRequestFromJSON; - exports.responseBodyToJSON = responseBodyToJSON; - exports.responseBodyFromJSON = responseBodyFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1ConversationsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1ConversationsListRequest$; - (function(AgentsApiV1ConversationsListRequest$2) { - AgentsApiV1ConversationsListRequest$2.inboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema; - AgentsApiV1ConversationsListRequest$2.outboundSchema = exports.AgentsApiV1ConversationsListRequest$outboundSchema; - })(AgentsApiV1ConversationsListRequest$ || (exports.AgentsApiV1ConversationsListRequest$ = AgentsApiV1ConversationsListRequest$ = {})); - function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsListRequest$outboundSchema.parse(agentsApiV1ConversationsListRequest)); - } - function agentsApiV1ConversationsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsListRequest' from JSON`); - } - exports.ResponseBody$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.ResponseBody$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var ResponseBody$; - (function(ResponseBody$2) { - ResponseBody$2.inboundSchema = exports.ResponseBody$inboundSchema; - ResponseBody$2.outboundSchema = exports.ResponseBody$outboundSchema; - })(ResponseBody$ || (exports.ResponseBody$ = ResponseBody$ = {})); - function responseBodyToJSON(responseBody) { - return JSON.stringify(exports.ResponseBody$outboundSchema.parse(responseBody)); - } - function responseBodyFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseBody' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js - var require_agentsapiv1conversationsmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsMessagesRequest$ = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsMessagesRequestToJSON = agentsApiV1ConversationsMessagesRequestToJSON; - exports.agentsApiV1ConversationsMessagesRequestFromJSON = agentsApiV1ConversationsMessagesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsMessagesRequest$; - (function(AgentsApiV1ConversationsMessagesRequest$2) { - AgentsApiV1ConversationsMessagesRequest$2.inboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema; - AgentsApiV1ConversationsMessagesRequest$2.outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema; - })(AgentsApiV1ConversationsMessagesRequest$ || (exports.AgentsApiV1ConversationsMessagesRequest$ = AgentsApiV1ConversationsMessagesRequest$ = {})); - function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(agentsApiV1ConversationsMessagesRequest)); - } - function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsMessagesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js - var require_agentsapiv1conversationsrestart = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartRequest$ = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartRequestToJSON = agentsApiV1ConversationsRestartRequestToJSON; - exports.agentsApiV1ConversationsRestartRequestFromJSON = agentsApiV1ConversationsRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartRequest: components.ConversationRestartRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartRequest": "conversationRestartRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartRequest: components.ConversationRestartRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartRequest: "ConversationRestartRequest" - }); - }); - var AgentsApiV1ConversationsRestartRequest$; - (function(AgentsApiV1ConversationsRestartRequest$2) { - AgentsApiV1ConversationsRestartRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema; - AgentsApiV1ConversationsRestartRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartRequest$ || (exports.AgentsApiV1ConversationsRestartRequest$ = AgentsApiV1ConversationsRestartRequest$ = {})); - function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(agentsApiV1ConversationsRestartRequest)); - } - function agentsApiV1ConversationsRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js - var require_agentsapiv1conversationsrestartstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartStreamRequest$ = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartStreamRequestToJSON = agentsApiV1ConversationsRestartStreamRequestToJSON; - exports.agentsApiV1ConversationsRestartStreamRequestFromJSON = agentsApiV1ConversationsRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartStreamRequest": "conversationRestartStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartStreamRequest: components.ConversationRestartStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartStreamRequest: "ConversationRestartStreamRequest" - }); - }); - var AgentsApiV1ConversationsRestartStreamRequest$; - (function(AgentsApiV1ConversationsRestartStreamRequest$2) { - AgentsApiV1ConversationsRestartStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema; - AgentsApiV1ConversationsRestartStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartStreamRequest$ || (exports.AgentsApiV1ConversationsRestartStreamRequest$ = AgentsApiV1ConversationsRestartStreamRequest$ = {})); - function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(agentsApiV1ConversationsRestartStreamRequest)); - } - function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js - var require_deletemodelv1modelsmodeliddelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$ = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = void 0; - exports.deleteModelV1ModelsModelIdDeleteRequestToJSON = deleteModelV1ModelsModelIdDeleteRequestToJSON; - exports.deleteModelV1ModelsModelIdDeleteRequestFromJSON = deleteModelV1ModelsModelIdDeleteRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var DeleteModelV1ModelsModelIdDeleteRequest$; - (function(DeleteModelV1ModelsModelIdDeleteRequest$2) { - DeleteModelV1ModelsModelIdDeleteRequest$2.inboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema; - DeleteModelV1ModelsModelIdDeleteRequest$2.outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema; - })(DeleteModelV1ModelsModelIdDeleteRequest$ || (exports.DeleteModelV1ModelsModelIdDeleteRequest$ = DeleteModelV1ModelsModelIdDeleteRequest$ = {})); - function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest) { - return JSON.stringify(exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(deleteModelV1ModelsModelIdDeleteRequest)); - } - function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelV1ModelsModelIdDeleteRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js - var require_filesapiroutesdeletefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDeleteFileRequest$ = exports.FilesApiRoutesDeleteFileRequest$outboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDeleteFileRequestToJSON = filesApiRoutesDeleteFileRequestToJSON; - exports.filesApiRoutesDeleteFileRequestFromJSON = filesApiRoutesDeleteFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDeleteFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDeleteFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDeleteFileRequest$; - (function(FilesApiRoutesDeleteFileRequest$2) { - FilesApiRoutesDeleteFileRequest$2.inboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema; - FilesApiRoutesDeleteFileRequest$2.outboundSchema = exports.FilesApiRoutesDeleteFileRequest$outboundSchema; - })(FilesApiRoutesDeleteFileRequest$ || (exports.FilesApiRoutesDeleteFileRequest$ = FilesApiRoutesDeleteFileRequest$ = {})); - function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(filesApiRoutesDeleteFileRequest)); - } - function filesApiRoutesDeleteFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDeleteFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDeleteFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js - var require_filesapiroutesdownloadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDownloadFileRequest$ = exports.FilesApiRoutesDownloadFileRequest$outboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDownloadFileRequestToJSON = filesApiRoutesDownloadFileRequestToJSON; - exports.filesApiRoutesDownloadFileRequestFromJSON = filesApiRoutesDownloadFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDownloadFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDownloadFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDownloadFileRequest$; - (function(FilesApiRoutesDownloadFileRequest$2) { - FilesApiRoutesDownloadFileRequest$2.inboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema; - FilesApiRoutesDownloadFileRequest$2.outboundSchema = exports.FilesApiRoutesDownloadFileRequest$outboundSchema; - })(FilesApiRoutesDownloadFileRequest$ || (exports.FilesApiRoutesDownloadFileRequest$ = FilesApiRoutesDownloadFileRequest$ = {})); - function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(filesApiRoutesDownloadFileRequest)); - } - function filesApiRoutesDownloadFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDownloadFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDownloadFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js - var require_filesapiroutesgetsignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesGetSignedUrlRequest$ = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = void 0; - exports.filesApiRoutesGetSignedUrlRequestToJSON = filesApiRoutesGetSignedUrlRequestToJSON; - exports.filesApiRoutesGetSignedUrlRequestFromJSON = filesApiRoutesGetSignedUrlRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = z.object({ - file_id: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = z.object({ - fileId: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesGetSignedUrlRequest$; - (function(FilesApiRoutesGetSignedUrlRequest$2) { - FilesApiRoutesGetSignedUrlRequest$2.inboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema; - FilesApiRoutesGetSignedUrlRequest$2.outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema; - })(FilesApiRoutesGetSignedUrlRequest$ || (exports.FilesApiRoutesGetSignedUrlRequest$ = FilesApiRoutesGetSignedUrlRequest$ = {})); - function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest) { - return JSON.stringify(exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(filesApiRoutesGetSignedUrlRequest)); - } - function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesGetSignedUrlRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js - var require_filesapirouteslistfiles = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesListFilesRequest$ = exports.FilesApiRoutesListFilesRequest$outboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema = void 0; - exports.filesApiRoutesListFilesRequestToJSON = filesApiRoutesListFilesRequestToJSON; - exports.filesApiRoutesListFilesRequestFromJSON = filesApiRoutesListFilesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.FilesApiRoutesListFilesRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - sample_type: z.nullable(z.array(components.SampleType$inboundSchema)).optional(), - source: z.nullable(z.array(components.Source$inboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "sample_type": "sampleType" - }); - }); - exports.FilesApiRoutesListFilesRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - sampleType: z.nullable(z.array(components.SampleType$outboundSchema)).optional(), - source: z.nullable(z.array(components.Source$outboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - sampleType: "sample_type" - }); - }); - var FilesApiRoutesListFilesRequest$; - (function(FilesApiRoutesListFilesRequest$2) { - FilesApiRoutesListFilesRequest$2.inboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema; - FilesApiRoutesListFilesRequest$2.outboundSchema = exports.FilesApiRoutesListFilesRequest$outboundSchema; - })(FilesApiRoutesListFilesRequest$ || (exports.FilesApiRoutesListFilesRequest$ = FilesApiRoutesListFilesRequest$ = {})); - function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest) { - return JSON.stringify(exports.FilesApiRoutesListFilesRequest$outboundSchema.parse(filesApiRoutesListFilesRequest)); - } - function filesApiRoutesListFilesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesListFilesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesListFilesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js - var require_filesapiroutesretrievefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesRetrieveFileRequest$ = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = void 0; - exports.filesApiRoutesRetrieveFileRequestToJSON = filesApiRoutesRetrieveFileRequestToJSON; - exports.filesApiRoutesRetrieveFileRequestFromJSON = filesApiRoutesRetrieveFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesRetrieveFileRequest$; - (function(FilesApiRoutesRetrieveFileRequest$2) { - FilesApiRoutesRetrieveFileRequest$2.inboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema; - FilesApiRoutesRetrieveFileRequest$2.outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema; - })(FilesApiRoutesRetrieveFileRequest$ || (exports.FilesApiRoutesRetrieveFileRequest$ = FilesApiRoutesRetrieveFileRequest$ = {})); - function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest) { - return JSON.stringify(exports.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(filesApiRoutesRetrieveFileRequest)); - } - function filesApiRoutesRetrieveFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesRetrieveFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesRetrieveFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js - var require_filesapiroutesuploadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = void 0; - exports.filesApiRoutesUploadFileMultiPartBodyParamsToJSON = filesApiRoutesUploadFileMultiPartBodyParamsToJSON; - exports.filesApiRoutesUploadFileMultiPartBodyParamsFromJSON = filesApiRoutesUploadFileMultiPartBodyParamsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = z.object({ - purpose: components.FilePurpose$inboundSchema.optional(), - file: components.FileT$inboundSchema - }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = z.object({ - purpose: components.FilePurpose$outboundSchema.optional(), - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var FilesApiRoutesUploadFileMultiPartBodyParams$; - (function(FilesApiRoutesUploadFileMultiPartBodyParams$2) { - FilesApiRoutesUploadFileMultiPartBodyParams$2.inboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema; - FilesApiRoutesUploadFileMultiPartBodyParams$2.outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema; - })(FilesApiRoutesUploadFileMultiPartBodyParams$ || (exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = FilesApiRoutesUploadFileMultiPartBodyParams$ = {})); - function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams) { - return JSON.stringify(exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(filesApiRoutesUploadFileMultiPartBodyParams)); - } - function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesUploadFileMultiPartBodyParams' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js - var require_jobsapiroutesbatchcancelbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$ = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchCancelBatchJobRequestToJSON = jobsApiRoutesBatchCancelBatchJobRequestToJSON; - exports.jobsApiRoutesBatchCancelBatchJobRequestFromJSON = jobsApiRoutesBatchCancelBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchCancelBatchJobRequest$; - (function(JobsApiRoutesBatchCancelBatchJobRequest$2) { - JobsApiRoutesBatchCancelBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema; - JobsApiRoutesBatchCancelBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchCancelBatchJobRequest$ || (exports.JobsApiRoutesBatchCancelBatchJobRequest$ = JobsApiRoutesBatchCancelBatchJobRequest$ = {})); - function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchCancelBatchJobRequest)); - } - function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchCancelBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js - var require_jobsapiroutesbatchgetbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobRequest$ = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobRequestToJSON = jobsApiRoutesBatchGetBatchJobRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobRequestFromJSON = jobsApiRoutesBatchGetBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchGetBatchJobRequest$; - (function(JobsApiRoutesBatchGetBatchJobRequest$2) { - JobsApiRoutesBatchGetBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobRequest$ || (exports.JobsApiRoutesBatchGetBatchJobRequest$ = JobsApiRoutesBatchGetBatchJobRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobRequest)); - } - function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js - var require_jobsapiroutesbatchgetbatchjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$ = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobsRequestToJSON = jobsApiRoutesBatchGetBatchJobsRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobsRequestFromJSON = jobsApiRoutesBatchGetBatchJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "agent_id": "agentId", - "created_after": "createdAfter", - "created_by_me": "createdByMe" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - agentId: "agent_id", - createdAfter: "created_after", - createdByMe: "created_by_me" - }); - }); - var JobsApiRoutesBatchGetBatchJobsRequest$; - (function(JobsApiRoutesBatchGetBatchJobsRequest$2) { - JobsApiRoutesBatchGetBatchJobsRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobsRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobsRequest$ || (exports.JobsApiRoutesBatchGetBatchJobsRequest$ = JobsApiRoutesBatchGetBatchJobsRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobsRequest)); - } - function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningArchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningArchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningArchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js - var require_jobsapiroutesfinetuningcancelfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningCancelFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobRequest$2) { - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningCancelFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js - var require_jobsapiroutesfinetuningcreatefinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = void 0; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.One$inboundSchema = z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.One$outboundSchema = z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = z.union([ - components.LegacyJobMetadataOut$inboundSchema, - z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]) - ]); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = z.union([ - components.LegacyJobMetadataOut$outboundSchema, - z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]) - ]); - var JobsApiRoutesFineTuningCreateFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCreateFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCreateFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCreateFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCreateFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js - var require_jobsapiroutesfinetuninggetfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = JobsApiRoutesFineTuningGetFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningGetFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningGetFineTuningJobResponse$2) { - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = JobsApiRoutesFineTuningGetFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js - var require_jobsapiroutesfinetuninggetfinetuningjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.Status = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_before: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(exports.Status$inboundSchema).optional(), - wandb_project: z.nullable(z.string()).optional(), - wandb_name: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "created_after": "createdAfter", - "created_before": "createdBefore", - "created_by_me": "createdByMe", - "wandb_project": "wandbProject", - "wandb_name": "wandbName" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdBefore: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(exports.Status$outboundSchema).optional(), - wandbProject: z.nullable(z.string()).optional(), - wandbName: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - createdAfter: "created_after", - createdBefore: "created_before", - createdByMe: "created_by_me", - wandbProject: "wandb_project", - wandbName: "wandb_name" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobsRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobsRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobsRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobsRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js - var require_jobsapiroutesfinetuningstartfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningStartFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningStartFineTuningJobRequest$2) { - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = JobsApiRoutesFineTuningStartFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningStartFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningStartFineTuningJobResponse$2) { - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = JobsApiRoutesFineTuningStartFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningunarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js - var require_jobsapiroutesfinetuningupdatefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string(), - UpdateFTModelIn: components.UpdateFTModelIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId", - "UpdateFTModelIn": "updateFTModelIn" - }); - }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string(), - updateFTModelIn: components.UpdateFTModelIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id", - updateFTModelIn: "UpdateFTModelIn" - }); - }); - var JobsApiRoutesFineTuningUpdateFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = z.union([ - components.ClassifierFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("classifier") }).transform((v) => ({ - modelType: v.model_type - }))), - components.CompletionFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("completion") }).transform((v) => ({ - modelType: v.model_type - }))) - ]); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = z.union([ - components.ClassifierFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("classifier") }).transform((v) => ({ - model_type: v.modelType - }))), - components.CompletionFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("completion") }).transform((v) => ({ - model_type: v.modelType - }))) - ]); - var JobsApiRoutesFineTuningUpdateFineTunedModelResponse$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelResponse)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js - var require_librariesdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDeleteV1Request$ = exports.LibrariesDeleteV1Request$outboundSchema = exports.LibrariesDeleteV1Request$inboundSchema = void 0; - exports.librariesDeleteV1RequestToJSON = librariesDeleteV1RequestToJSON; - exports.librariesDeleteV1RequestFromJSON = librariesDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDeleteV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesDeleteV1Request$; - (function(LibrariesDeleteV1Request$2) { - LibrariesDeleteV1Request$2.inboundSchema = exports.LibrariesDeleteV1Request$inboundSchema; - LibrariesDeleteV1Request$2.outboundSchema = exports.LibrariesDeleteV1Request$outboundSchema; - })(LibrariesDeleteV1Request$ || (exports.LibrariesDeleteV1Request$ = LibrariesDeleteV1Request$ = {})); - function librariesDeleteV1RequestToJSON(librariesDeleteV1Request) { - return JSON.stringify(exports.LibrariesDeleteV1Request$outboundSchema.parse(librariesDeleteV1Request)); - } - function librariesDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js - var require_librariesdocumentsdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsDeleteV1Request$ = exports.LibrariesDocumentsDeleteV1Request$outboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema = void 0; - exports.librariesDocumentsDeleteV1RequestToJSON = librariesDocumentsDeleteV1RequestToJSON; - exports.librariesDocumentsDeleteV1RequestFromJSON = librariesDocumentsDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsDeleteV1Request$; - (function(LibrariesDocumentsDeleteV1Request$2) { - LibrariesDocumentsDeleteV1Request$2.inboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema; - LibrariesDocumentsDeleteV1Request$2.outboundSchema = exports.LibrariesDocumentsDeleteV1Request$outboundSchema; - })(LibrariesDocumentsDeleteV1Request$ || (exports.LibrariesDocumentsDeleteV1Request$ = LibrariesDocumentsDeleteV1Request$ = {})); - function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request) { - return JSON.stringify(exports.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(librariesDocumentsDeleteV1Request)); - } - function librariesDocumentsDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js - var require_librariesdocumentsgetextractedtextsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetExtractedTextSignedUrlV1Request$; - (function(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2) { - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ || (exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = {})); - function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetExtractedTextSignedUrlV1Request)); - } - function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetExtractedTextSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js - var require_librariesdocumentsgetsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetSignedUrlV1Request$ = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetSignedUrlV1RequestToJSON = librariesDocumentsGetSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetSignedUrlV1RequestFromJSON = librariesDocumentsGetSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetSignedUrlV1Request$; - (function(LibrariesDocumentsGetSignedUrlV1Request$2) { - LibrariesDocumentsGetSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetSignedUrlV1Request$ || (exports.LibrariesDocumentsGetSignedUrlV1Request$ = LibrariesDocumentsGetSignedUrlV1Request$ = {})); - function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetSignedUrlV1Request)); - } - function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js - var require_librariesdocumentsgetstatusv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetStatusV1Request$ = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetStatusV1RequestToJSON = librariesDocumentsGetStatusV1RequestToJSON; - exports.librariesDocumentsGetStatusV1RequestFromJSON = librariesDocumentsGetStatusV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetStatusV1Request$; - (function(LibrariesDocumentsGetStatusV1Request$2) { - LibrariesDocumentsGetStatusV1Request$2.inboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema; - LibrariesDocumentsGetStatusV1Request$2.outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema; - })(LibrariesDocumentsGetStatusV1Request$ || (exports.LibrariesDocumentsGetStatusV1Request$ = LibrariesDocumentsGetStatusV1Request$ = {})); - function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(librariesDocumentsGetStatusV1Request)); - } - function librariesDocumentsGetStatusV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetStatusV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetStatusV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js - var require_librariesdocumentsgettextcontentv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetTextContentV1Request$ = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetTextContentV1RequestToJSON = librariesDocumentsGetTextContentV1RequestToJSON; - exports.librariesDocumentsGetTextContentV1RequestFromJSON = librariesDocumentsGetTextContentV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetTextContentV1Request$; - (function(LibrariesDocumentsGetTextContentV1Request$2) { - LibrariesDocumentsGetTextContentV1Request$2.inboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema; - LibrariesDocumentsGetTextContentV1Request$2.outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema; - })(LibrariesDocumentsGetTextContentV1Request$ || (exports.LibrariesDocumentsGetTextContentV1Request$ = LibrariesDocumentsGetTextContentV1Request$ = {})); - function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(librariesDocumentsGetTextContentV1Request)); - } - function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetTextContentV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js - var require_librariesdocumentsgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetV1Request$ = exports.LibrariesDocumentsGetV1Request$outboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetV1RequestToJSON = librariesDocumentsGetV1RequestToJSON; - exports.librariesDocumentsGetV1RequestFromJSON = librariesDocumentsGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetV1Request$; - (function(LibrariesDocumentsGetV1Request$2) { - LibrariesDocumentsGetV1Request$2.inboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema; - LibrariesDocumentsGetV1Request$2.outboundSchema = exports.LibrariesDocumentsGetV1Request$outboundSchema; - })(LibrariesDocumentsGetV1Request$ || (exports.LibrariesDocumentsGetV1Request$ = LibrariesDocumentsGetV1Request$ = {})); - function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetV1Request$outboundSchema.parse(librariesDocumentsGetV1Request)); - } - function librariesDocumentsGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js - var require_librariesdocumentslistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsListV1Request$ = exports.LibrariesDocumentsListV1Request$outboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema = void 0; - exports.librariesDocumentsListV1RequestToJSON = librariesDocumentsListV1RequestToJSON; - exports.librariesDocumentsListV1RequestFromJSON = librariesDocumentsListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsListV1Request$inboundSchema = z.object({ - library_id: z.string(), - search: z.nullable(z.string()).optional(), - page_size: z.number().int().default(100), - page: z.number().int().default(0), - sort_by: z.string().default("created_at"), - sort_order: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "page_size": "pageSize", - "sort_by": "sortBy", - "sort_order": "sortOrder" - }); - }); - exports.LibrariesDocumentsListV1Request$outboundSchema = z.object({ - libraryId: z.string(), - search: z.nullable(z.string()).optional(), - pageSize: z.number().int().default(100), - page: z.number().int().default(0), - sortBy: z.string().default("created_at"), - sortOrder: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - pageSize: "page_size", - sortBy: "sort_by", - sortOrder: "sort_order" - }); - }); - var LibrariesDocumentsListV1Request$; - (function(LibrariesDocumentsListV1Request$2) { - LibrariesDocumentsListV1Request$2.inboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema; - LibrariesDocumentsListV1Request$2.outboundSchema = exports.LibrariesDocumentsListV1Request$outboundSchema; - })(LibrariesDocumentsListV1Request$ || (exports.LibrariesDocumentsListV1Request$ = LibrariesDocumentsListV1Request$ = {})); - function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request) { - return JSON.stringify(exports.LibrariesDocumentsListV1Request$outboundSchema.parse(librariesDocumentsListV1Request)); - } - function librariesDocumentsListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js - var require_librariesdocumentsreprocessv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsReprocessV1Request$ = exports.LibrariesDocumentsReprocessV1Request$outboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema = void 0; - exports.librariesDocumentsReprocessV1RequestToJSON = librariesDocumentsReprocessV1RequestToJSON; - exports.librariesDocumentsReprocessV1RequestFromJSON = librariesDocumentsReprocessV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsReprocessV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsReprocessV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsReprocessV1Request$; - (function(LibrariesDocumentsReprocessV1Request$2) { - LibrariesDocumentsReprocessV1Request$2.inboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema; - LibrariesDocumentsReprocessV1Request$2.outboundSchema = exports.LibrariesDocumentsReprocessV1Request$outboundSchema; - })(LibrariesDocumentsReprocessV1Request$ || (exports.LibrariesDocumentsReprocessV1Request$ = LibrariesDocumentsReprocessV1Request$ = {})); - function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request) { - return JSON.stringify(exports.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(librariesDocumentsReprocessV1Request)); - } - function librariesDocumentsReprocessV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsReprocessV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsReprocessV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js - var require_librariesdocumentsupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUpdateV1Request$ = exports.LibrariesDocumentsUpdateV1Request$outboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema = void 0; - exports.librariesDocumentsUpdateV1RequestToJSON = librariesDocumentsUpdateV1RequestToJSON; - exports.librariesDocumentsUpdateV1RequestFromJSON = librariesDocumentsUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string(), - DocumentUpdateIn: components.DocumentUpdateIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId", - "DocumentUpdateIn": "documentUpdateIn" - }); - }); - exports.LibrariesDocumentsUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string(), - documentUpdateIn: components.DocumentUpdateIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id", - documentUpdateIn: "DocumentUpdateIn" - }); - }); - var LibrariesDocumentsUpdateV1Request$; - (function(LibrariesDocumentsUpdateV1Request$2) { - LibrariesDocumentsUpdateV1Request$2.inboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema; - LibrariesDocumentsUpdateV1Request$2.outboundSchema = exports.LibrariesDocumentsUpdateV1Request$outboundSchema; - })(LibrariesDocumentsUpdateV1Request$ || (exports.LibrariesDocumentsUpdateV1Request$ = LibrariesDocumentsUpdateV1Request$ = {})); - function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(librariesDocumentsUpdateV1Request)); - } - function librariesDocumentsUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js - var require_librariesdocumentsuploadv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUploadV1Request$ = exports.LibrariesDocumentsUploadV1Request$outboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$ = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = void 0; - exports.librariesDocumentsUploadV1DocumentUploadToJSON = librariesDocumentsUploadV1DocumentUploadToJSON; - exports.librariesDocumentsUploadV1DocumentUploadFromJSON = librariesDocumentsUploadV1DocumentUploadFromJSON; - exports.librariesDocumentsUploadV1RequestToJSON = librariesDocumentsUploadV1RequestToJSON; - exports.librariesDocumentsUploadV1RequestFromJSON = librariesDocumentsUploadV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = z.object({ - file: components.FileT$inboundSchema - }); - exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = z.object({ - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var LibrariesDocumentsUploadV1DocumentUpload$; - (function(LibrariesDocumentsUploadV1DocumentUpload$2) { - LibrariesDocumentsUploadV1DocumentUpload$2.inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema; - LibrariesDocumentsUploadV1DocumentUpload$2.outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema; - })(LibrariesDocumentsUploadV1DocumentUpload$ || (exports.LibrariesDocumentsUploadV1DocumentUpload$ = LibrariesDocumentsUploadV1DocumentUpload$ = {})); - function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema.parse(librariesDocumentsUploadV1DocumentUpload)); - } - function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1DocumentUpload' from JSON`); - } - exports.LibrariesDocumentsUploadV1Request$inboundSchema = z.object({ - library_id: z.string(), - RequestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "RequestBody": "requestBody" - }); - }); - exports.LibrariesDocumentsUploadV1Request$outboundSchema = z.object({ - libraryId: z.string(), - requestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - requestBody: "RequestBody" - }); - }); - var LibrariesDocumentsUploadV1Request$; - (function(LibrariesDocumentsUploadV1Request$2) { - LibrariesDocumentsUploadV1Request$2.inboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema; - LibrariesDocumentsUploadV1Request$2.outboundSchema = exports.LibrariesDocumentsUploadV1Request$outboundSchema; - })(LibrariesDocumentsUploadV1Request$ || (exports.LibrariesDocumentsUploadV1Request$ = LibrariesDocumentsUploadV1Request$ = {})); - function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1Request$outboundSchema.parse(librariesDocumentsUploadV1Request)); - } - function librariesDocumentsUploadV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js - var require_librariesgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesGetV1Request$ = exports.LibrariesGetV1Request$outboundSchema = exports.LibrariesGetV1Request$inboundSchema = void 0; - exports.librariesGetV1RequestToJSON = librariesGetV1RequestToJSON; - exports.librariesGetV1RequestFromJSON = librariesGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesGetV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesGetV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesGetV1Request$; - (function(LibrariesGetV1Request$2) { - LibrariesGetV1Request$2.inboundSchema = exports.LibrariesGetV1Request$inboundSchema; - LibrariesGetV1Request$2.outboundSchema = exports.LibrariesGetV1Request$outboundSchema; - })(LibrariesGetV1Request$ || (exports.LibrariesGetV1Request$ = LibrariesGetV1Request$ = {})); - function librariesGetV1RequestToJSON(librariesGetV1Request) { - return JSON.stringify(exports.LibrariesGetV1Request$outboundSchema.parse(librariesGetV1Request)); - } - function librariesGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js - var require_librariessharecreatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareCreateV1Request$ = exports.LibrariesShareCreateV1Request$outboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema = void 0; - exports.librariesShareCreateV1RequestToJSON = librariesShareCreateV1RequestToJSON; - exports.librariesShareCreateV1RequestFromJSON = librariesShareCreateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareCreateV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingIn: components.SharingIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingIn": "sharingIn" - }); - }); - exports.LibrariesShareCreateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingIn: components.SharingIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingIn: "SharingIn" - }); - }); - var LibrariesShareCreateV1Request$; - (function(LibrariesShareCreateV1Request$2) { - LibrariesShareCreateV1Request$2.inboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema; - LibrariesShareCreateV1Request$2.outboundSchema = exports.LibrariesShareCreateV1Request$outboundSchema; - })(LibrariesShareCreateV1Request$ || (exports.LibrariesShareCreateV1Request$ = LibrariesShareCreateV1Request$ = {})); - function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request) { - return JSON.stringify(exports.LibrariesShareCreateV1Request$outboundSchema.parse(librariesShareCreateV1Request)); - } - function librariesShareCreateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareCreateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareCreateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js - var require_librariessharedeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareDeleteV1Request$ = exports.LibrariesShareDeleteV1Request$outboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema = void 0; - exports.librariesShareDeleteV1RequestToJSON = librariesShareDeleteV1RequestToJSON; - exports.librariesShareDeleteV1RequestFromJSON = librariesShareDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingDelete: components.SharingDelete$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingDelete": "sharingDelete" - }); - }); - exports.LibrariesShareDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingDelete: components.SharingDelete$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingDelete: "SharingDelete" - }); - }); - var LibrariesShareDeleteV1Request$; - (function(LibrariesShareDeleteV1Request$2) { - LibrariesShareDeleteV1Request$2.inboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema; - LibrariesShareDeleteV1Request$2.outboundSchema = exports.LibrariesShareDeleteV1Request$outboundSchema; - })(LibrariesShareDeleteV1Request$ || (exports.LibrariesShareDeleteV1Request$ = LibrariesShareDeleteV1Request$ = {})); - function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request) { - return JSON.stringify(exports.LibrariesShareDeleteV1Request$outboundSchema.parse(librariesShareDeleteV1Request)); - } - function librariesShareDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js - var require_librariessharelistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareListV1Request$ = exports.LibrariesShareListV1Request$outboundSchema = exports.LibrariesShareListV1Request$inboundSchema = void 0; - exports.librariesShareListV1RequestToJSON = librariesShareListV1RequestToJSON; - exports.librariesShareListV1RequestFromJSON = librariesShareListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesShareListV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesShareListV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesShareListV1Request$; - (function(LibrariesShareListV1Request$2) { - LibrariesShareListV1Request$2.inboundSchema = exports.LibrariesShareListV1Request$inboundSchema; - LibrariesShareListV1Request$2.outboundSchema = exports.LibrariesShareListV1Request$outboundSchema; - })(LibrariesShareListV1Request$ || (exports.LibrariesShareListV1Request$ = LibrariesShareListV1Request$ = {})); - function librariesShareListV1RequestToJSON(librariesShareListV1Request) { - return JSON.stringify(exports.LibrariesShareListV1Request$outboundSchema.parse(librariesShareListV1Request)); - } - function librariesShareListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js - var require_librariesupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesUpdateV1Request$ = exports.LibrariesUpdateV1Request$outboundSchema = exports.LibrariesUpdateV1Request$inboundSchema = void 0; - exports.librariesUpdateV1RequestToJSON = librariesUpdateV1RequestToJSON; - exports.librariesUpdateV1RequestFromJSON = librariesUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - LibraryInUpdate: components.LibraryInUpdate$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "LibraryInUpdate": "libraryInUpdate" - }); - }); - exports.LibrariesUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - libraryInUpdate: components.LibraryInUpdate$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - libraryInUpdate: "LibraryInUpdate" - }); - }); - var LibrariesUpdateV1Request$; - (function(LibrariesUpdateV1Request$2) { - LibrariesUpdateV1Request$2.inboundSchema = exports.LibrariesUpdateV1Request$inboundSchema; - LibrariesUpdateV1Request$2.outboundSchema = exports.LibrariesUpdateV1Request$outboundSchema; - })(LibrariesUpdateV1Request$ || (exports.LibrariesUpdateV1Request$ = LibrariesUpdateV1Request$ = {})); - function librariesUpdateV1RequestToJSON(librariesUpdateV1Request) { - return JSON.stringify(exports.LibrariesUpdateV1Request$outboundSchema.parse(librariesUpdateV1Request)); - } - function librariesUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js - var require_retrievemodelv1modelsmodelidget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$ = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = void 0; - exports.retrieveModelV1ModelsModelIdGetRequestToJSON = retrieveModelV1ModelsModelIdGetRequestToJSON; - exports.retrieveModelV1ModelsModelIdGetRequestFromJSON = retrieveModelV1ModelsModelIdGetRequestFromJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var RetrieveModelV1ModelsModelIdGetRequest$; - (function(RetrieveModelV1ModelsModelIdGetRequest$2) { - RetrieveModelV1ModelsModelIdGetRequest$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema; - RetrieveModelV1ModelsModelIdGetRequest$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetRequest$ || (exports.RetrieveModelV1ModelsModelIdGetRequest$ = RetrieveModelV1ModelsModelIdGetRequest$ = {})); - function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(retrieveModelV1ModelsModelIdGetRequest)); - } - function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetRequest' from JSON`); - } - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = z.union([ - components.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = z.union([ - components.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$; - (function(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2) { - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema; - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ || (exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = {})); - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema.parse(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet)); - } - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/index.js - var require_operations = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agentsapiv1agentsget(), exports); - __exportStar(require_agentsapiv1agentslist(), exports); - __exportStar(require_agentsapiv1agentsupdate(), exports); - __exportStar(require_agentsapiv1agentsupdateversion(), exports); - __exportStar(require_agentsapiv1conversationsappend(), exports); - __exportStar(require_agentsapiv1conversationsappendstream(), exports); - __exportStar(require_agentsapiv1conversationsget(), exports); - __exportStar(require_agentsapiv1conversationshistory(), exports); - __exportStar(require_agentsapiv1conversationslist(), exports); - __exportStar(require_agentsapiv1conversationsmessages(), exports); - __exportStar(require_agentsapiv1conversationsrestart(), exports); - __exportStar(require_agentsapiv1conversationsrestartstream(), exports); - __exportStar(require_deletemodelv1modelsmodeliddelete(), exports); - __exportStar(require_filesapiroutesdeletefile(), exports); - __exportStar(require_filesapiroutesdownloadfile(), exports); - __exportStar(require_filesapiroutesgetsignedurl(), exports); - __exportStar(require_filesapirouteslistfiles(), exports); - __exportStar(require_filesapiroutesretrievefile(), exports); - __exportStar(require_filesapiroutesuploadfile(), exports); - __exportStar(require_jobsapiroutesbatchcancelbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningcancelfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningcreatefinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningstartfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningunarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningupdatefinetunedmodel(), exports); - __exportStar(require_librariesdeletev1(), exports); - __exportStar(require_librariesdocumentsdeletev1(), exports); - __exportStar(require_librariesdocumentsgetextractedtextsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetstatusv1(), exports); - __exportStar(require_librariesdocumentsgettextcontentv1(), exports); - __exportStar(require_librariesdocumentsgetv1(), exports); - __exportStar(require_librariesdocumentslistv1(), exports); - __exportStar(require_librariesdocumentsreprocessv1(), exports); - __exportStar(require_librariesdocumentsupdatev1(), exports); - __exportStar(require_librariesdocumentsuploadv1(), exports); - __exportStar(require_librariesgetv1(), exports); - __exportStar(require_librariessharecreatev1(), exports); - __exportStar(require_librariessharedeletev1(), exports); - __exportStar(require_librariessharelistv1(), exports); - __exportStar(require_librariesupdatev1(), exports); - __exportStar(require_retrievemodelv1modelsmodelidget(), exports); - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js - var require_batchJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCancel = batchJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_cancel_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js - var require_batchJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCreate = batchJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function batchJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.BatchJobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_create_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsGet.js - var require_batchJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsGet = batchJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsList.js - var require_batchJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsList = batchJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "agent_id": payload?.agent_id, - "created_after": payload?.created_after, - "created_by_me": payload?.created_by_me, - "metadata": payload?.metadata, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistraljobs.js - var require_mistraljobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistraljobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralJobs = void 0; - var batchJobsCancel_js_1 = require_batchJobsCancel(); - var batchJobsCreate_js_1 = require_batchJobsCreate(); - var batchJobsGet_js_1 = require_batchJobsGet(); - var batchJobsList_js_1 = require_batchJobsList(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralJobs = class extends sdks_js_1.ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsList_js_1.batchJobsList)(this, request, options)); - } - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCreate_js_1.batchJobsCreate)(this, request, options)); - } - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsGet_js_1.batchJobsGet)(this, request, options)); - } - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCancel_js_1.batchJobsCancel)(this, request, options)); - } - }; - exports.MistralJobs = MistralJobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/batch.js - var require_batch = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/batch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Batch = void 0; - var sdks_js_1 = require_sdks(); - var mistraljobs_js_1 = require_mistraljobs(); - var Batch = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new mistraljobs_js_1.MistralJobs(this._options)); - } - }; - exports.Batch = Batch; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js - var require_betaConversationsAppend = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppend = betaConversationsAppend; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppend(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js - var require_betaConversationsAppendStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppendStream = betaConversationsAppendStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppendStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js - var require_betaConversationsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGet = betaConversationsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js - var require_betaConversationsGetHistory = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetHistory = betaConversationsGetHistory; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetHistory(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/history")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_history", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationHistory$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js - var require_betaConversationsGetMessages = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetMessages = betaConversationsGetMessages; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetMessages(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/messages")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_messages", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationMessages$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsList.js - var require_betaConversationsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsList = betaConversationsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(operations.ResponseBody$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js - var require_betaConversationsRestart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestart = betaConversationsRestart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js - var require_betaConversationsRestartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestartStream = betaConversationsRestartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js - var require_betaConversationsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStart = betaConversationsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js - var require_betaConversationsStartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStartStream = betaConversationsStartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/conversations.js - var require_conversations = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/conversations.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Conversations = void 0; - var betaConversationsAppend_js_1 = require_betaConversationsAppend(); - var betaConversationsAppendStream_js_1 = require_betaConversationsAppendStream(); - var betaConversationsGet_js_1 = require_betaConversationsGet(); - var betaConversationsGetHistory_js_1 = require_betaConversationsGetHistory(); - var betaConversationsGetMessages_js_1 = require_betaConversationsGetMessages(); - var betaConversationsList_js_1 = require_betaConversationsList(); - var betaConversationsRestart_js_1 = require_betaConversationsRestart(); - var betaConversationsRestartStream_js_1 = require_betaConversationsRestartStream(); - var betaConversationsStart_js_1 = require_betaConversationsStart(); - var betaConversationsStartStream_js_1 = require_betaConversationsStartStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Conversations = class extends sdks_js_1.ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStart_js_1.betaConversationsStart)(this, request, options)); - } - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsList_js_1.betaConversationsList)(this, request, options)); - } - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGet_js_1.betaConversationsGet)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async append(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppend_js_1.betaConversationsAppend)(this, request, options)); - } - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - async getHistory(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetHistory_js_1.betaConversationsGetHistory)(this, request, options)); - } - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - async getMessages(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetMessages_js_1.betaConversationsGetMessages)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restart(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestart_js_1.betaConversationsRestart)(this, request, options)); - } - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async startStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStartStream_js_1.betaConversationsStartStream)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async appendStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppendStream_js_1.betaConversationsAppendStream)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restartStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestartStream_js_1.betaConversationsRestartStream)(this, request, options)); - } - }; - exports.Conversations = Conversations; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js - var require_betaLibrariesCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesCreate = betaLibrariesCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaLibrariesCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.LibraryIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(201, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js - var require_betaLibrariesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDelete = betaLibrariesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js - var require_betaLibrariesGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesGet = betaLibrariesGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js - var require_betaLibrariesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesList = betaLibrariesList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function betaLibrariesList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListLibraryOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js - var require_betaLibrariesUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesUpdate = betaLibrariesUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.LibraryInUpdate, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js - var require_betaLibrariesAccessesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesDelete = betaLibrariesAccessesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingDelete, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js - var require_betaLibrariesAccessesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesList = betaLibrariesAccessesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListSharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js - var require_betaLibrariesAccessesUpdateOrCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesUpdateOrCreate = betaLibrariesAccessesUpdateOrCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesUpdateOrCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareCreateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingIn, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/accesses.js - var require_accesses = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/accesses.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Accesses = void 0; - var betaLibrariesAccessesDelete_js_1 = require_betaLibrariesAccessesDelete(); - var betaLibrariesAccessesList_js_1 = require_betaLibrariesAccessesList(); - var betaLibrariesAccessesUpdateOrCreate_js_1 = require_betaLibrariesAccessesUpdateOrCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Accesses = class extends sdks_js_1.ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesList_js_1.betaLibrariesAccessesList)(this, request, options)); - } - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - async updateOrCreate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesUpdateOrCreate_js_1.betaLibrariesAccessesUpdateOrCreate)(this, request, options)); - } - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesDelete_js_1.betaLibrariesAccessesDelete)(this, request, options)); - } - }; - exports.Accesses = Accesses; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js - var require_betaLibrariesDocumentsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsDelete = betaLibrariesDocumentsDelete; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js - var require_betaLibrariesDocumentsExtractedTextSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsExtractedTextSignedUrl = betaLibrariesDocumentsExtractedTextSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsExtractedTextSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_extracted_text_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js - var require_betaLibrariesDocumentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGet = betaLibrariesDocumentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js - var require_betaLibrariesDocumentsGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGetSignedUrl = betaLibrariesDocumentsGetSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js - var require_betaLibrariesDocumentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsList = betaLibrariesDocumentsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload.page, - "page_size": payload.page_size, - "search": payload.search, - "sort_by": payload.sort_by, - "sort_order": payload.sort_order - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListDocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js - var require_betaLibrariesDocumentsReprocess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsReprocess = betaLibrariesDocumentsReprocess; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsReprocess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/reprocess")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_reprocess_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js - var require_betaLibrariesDocumentsStatus = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsStatus = betaLibrariesDocumentsStatus; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsStatus(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/status")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_status_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ProcessingStatusOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js - var require_betaLibrariesDocumentsTextContent = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsTextContent = betaLibrariesDocumentsTextContent; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsTextContent(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/text_content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_text_content_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentTextContent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js - var require_betaLibrariesDocumentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpdate = betaLibrariesDocumentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.DocumentUpdateIn, { explode: true }); - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js - var require_betaLibrariesDocumentsUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpload = betaLibrariesDocumentsUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function betaLibrariesDocumentsUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUploadV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.RequestBody.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.RequestBody.file); - } else if ((0, streams_js_1.isReadableStream)(payload.RequestBody.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.RequestBody.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.RequestBody.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.RequestBody.file.content], { type: contentType }), payload.RequestBody.file.fileName); - } - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_upload_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json([200, 201], components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/documents.js - var require_documents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/documents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Documents = void 0; - var betaLibrariesDocumentsDelete_js_1 = require_betaLibrariesDocumentsDelete(); - var betaLibrariesDocumentsExtractedTextSignedUrl_js_1 = require_betaLibrariesDocumentsExtractedTextSignedUrl(); - var betaLibrariesDocumentsGet_js_1 = require_betaLibrariesDocumentsGet(); - var betaLibrariesDocumentsGetSignedUrl_js_1 = require_betaLibrariesDocumentsGetSignedUrl(); - var betaLibrariesDocumentsList_js_1 = require_betaLibrariesDocumentsList(); - var betaLibrariesDocumentsReprocess_js_1 = require_betaLibrariesDocumentsReprocess(); - var betaLibrariesDocumentsStatus_js_1 = require_betaLibrariesDocumentsStatus(); - var betaLibrariesDocumentsTextContent_js_1 = require_betaLibrariesDocumentsTextContent(); - var betaLibrariesDocumentsUpdate_js_1 = require_betaLibrariesDocumentsUpdate(); - var betaLibrariesDocumentsUpload_js_1 = require_betaLibrariesDocumentsUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Documents = class extends sdks_js_1.ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsList_js_1.betaLibrariesDocumentsList)(this, request, options)); - } - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpload_js_1.betaLibrariesDocumentsUpload)(this, request, options)); - } - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGet_js_1.betaLibrariesDocumentsGet)(this, request, options)); - } - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpdate_js_1.betaLibrariesDocumentsUpdate)(this, request, options)); - } - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsDelete_js_1.betaLibrariesDocumentsDelete)(this, request, options)); - } - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - async textContent(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsTextContent_js_1.betaLibrariesDocumentsTextContent)(this, request, options)); - } - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - async status(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsStatus_js_1.betaLibrariesDocumentsStatus)(this, request, options)); - } - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGetSignedUrl_js_1.betaLibrariesDocumentsGetSignedUrl)(this, request, options)); - } - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - async extractedTextSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsExtractedTextSignedUrl_js_1.betaLibrariesDocumentsExtractedTextSignedUrl)(this, request, options)); - } - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - async reprocess(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsReprocess_js_1.betaLibrariesDocumentsReprocess)(this, request, options)); - } - }; - exports.Documents = Documents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/libraries.js - var require_libraries = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/libraries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Libraries = void 0; - var betaLibrariesCreate_js_1 = require_betaLibrariesCreate(); - var betaLibrariesDelete_js_1 = require_betaLibrariesDelete(); - var betaLibrariesGet_js_1 = require_betaLibrariesGet(); - var betaLibrariesList_js_1 = require_betaLibrariesList(); - var betaLibrariesUpdate_js_1 = require_betaLibrariesUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var accesses_js_1 = require_accesses(); - var documents_js_1 = require_documents(); - var Libraries = class extends sdks_js_1.ClientSDK { - get documents() { - return this._documents ?? (this._documents = new documents_js_1.Documents(this._options)); - } - get accesses() { - return this._accesses ?? (this._accesses = new accesses_js_1.Accesses(this._options)); - } - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesList_js_1.betaLibrariesList)(this, options)); - } - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesCreate_js_1.betaLibrariesCreate)(this, request, options)); - } - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesGet_js_1.betaLibrariesGet)(this, request, options)); - } - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDelete_js_1.betaLibrariesDelete)(this, request, options)); - } - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesUpdate_js_1.betaLibrariesUpdate)(this, request, options)); - } - }; - exports.Libraries = Libraries; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js - var require_betaAgentsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsCreate = betaAgentsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaAgentsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentCreationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_create", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js - var require_betaAgentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsGet = betaAgentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsList.js - var require_betaAgentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsList = betaAgentsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(components.Agent$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js - var require_betaAgentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdate = betaAgentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.AgentUpdateRequest, { - explode: true - }); - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js - var require_betaAgentsUpdateVersion = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdateVersion = betaAgentsUpdateVersion; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdateVersion(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}/version")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "version": payload.version - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update_version", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistralagents.js - var require_mistralagents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistralagents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralAgents = void 0; - var betaAgentsCreate_js_1 = require_betaAgentsCreate(); - var betaAgentsGet_js_1 = require_betaAgentsGet(); - var betaAgentsList_js_1 = require_betaAgentsList(); - var betaAgentsUpdate_js_1 = require_betaAgentsUpdate(); - var betaAgentsUpdateVersion_js_1 = require_betaAgentsUpdateVersion(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralAgents = class extends sdks_js_1.ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsCreate_js_1.betaAgentsCreate)(this, request, options)); - } - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsList_js_1.betaAgentsList)(this, request, options)); - } - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsGet_js_1.betaAgentsGet)(this, request, options)); - } - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdate_js_1.betaAgentsUpdate)(this, request, options)); - } - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - async updateVersion(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdateVersion_js_1.betaAgentsUpdateVersion)(this, request, options)); - } - }; - exports.MistralAgents = MistralAgents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/beta.js - var require_beta = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/beta.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Beta = void 0; - var sdks_js_1 = require_sdks(); - var conversations_js_1 = require_conversations(); - var libraries_js_1 = require_libraries(); - var mistralagents_js_1 = require_mistralagents(); - var Beta = class extends sdks_js_1.ClientSDK { - get conversations() { - return this._conversations ?? (this._conversations = new conversations_js_1.Conversations(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new mistralagents_js_1.MistralAgents(this._options)); - } - get libraries() { - return this._libraries ?? (this._libraries = new libraries_js_1.Libraries(this._options)); - } - }; - exports.Beta = Beta; - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatComplete.js - var require_chatComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatComplete = chatComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatStream.js - var require_chatStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatStream = chatStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Options.js - var require_Options = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Options.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getDefaultOptions = exports.defaultOptions = exports.jsonDescription = exports.ignoreOverride = void 0; - exports.ignoreOverride = Symbol("Let zodToJsonSchema decide on which parser to use"); - var jsonDescription = (jsonSchema, def) => { - if (def.description) { - try { - return { - ...jsonSchema, - ...JSON.parse(def.description) - }; - } catch { - } - } - return jsonSchema; - }; - exports.jsonDescription = jsonDescription; - exports.defaultOptions = { - name: void 0, - $refStrategy: "root", - basePath: ["#"], - effectStrategy: "input", - pipeStrategy: "all", - dateStrategy: "format:date-time", - mapStrategy: "entries", - removeAdditionalStrategy: "passthrough", - allowedAdditionalProperties: true, - rejectedAdditionalProperties: false, - definitionPath: "definitions", - target: "jsonSchema7", - strictUnions: false, - definitions: {}, - errorMessages: false, - markdownDescription: false, - patternStrategy: "escape", - applyRegexFlags: false, - emailStrategy: "format:email", - base64Strategy: "contentEncoding:base64", - nameStrategy: "ref", - openAiAnyTypeName: "OpenAiAnyType" - }; - var getDefaultOptions = (options) => typeof options === "string" ? { - ...exports.defaultOptions, - name: options - } : { - ...exports.defaultOptions, - ...options - }; - exports.getDefaultOptions = getDefaultOptions; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Refs.js - var require_Refs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Refs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRefs = void 0; - var Options_js_1 = require_Options(); - var getRefs = (options) => { - const _options = (0, Options_js_1.getDefaultOptions)(options); - const currentPath = _options.name !== void 0 ? [..._options.basePath, _options.definitionPath, _options.name] : _options.basePath; - return { - ..._options, - flags: { hasReferencedOpenAiAnyType: false }, - currentPath, - propertyPath: void 0, - seen: new Map(Object.entries(_options.definitions).map(([name, def]) => [ - def._def, - { - def: def._def, - path: [..._options.basePath, _options.definitionPath, name], - // Resolution of references will be forced even though seen, so it's ok that the schema is undefined here for now. - jsonSchema: void 0 - } - ])) - }; - }; - exports.getRefs = getRefs; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/errorMessages.js - var require_errorMessages = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/errorMessages.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.setResponseValueAndErrors = exports.addErrorMessage = void 0; - function addErrorMessage(res, key, errorMessage, refs) { - if (!refs?.errorMessages) - return; - if (errorMessage) { - res.errorMessage = { - ...res.errorMessage, - [key]: errorMessage - }; - } - } - exports.addErrorMessage = addErrorMessage; - function setResponseValueAndErrors(res, key, value, errorMessage, refs) { - res[key] = value; - addErrorMessage(res, key, errorMessage, refs); - } - exports.setResponseValueAndErrors = setResponseValueAndErrors; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js - var require_getRelativePath = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRelativePath = void 0; - var getRelativePath = (pathA, pathB) => { - let i = 0; - for (; i < pathA.length && i < pathB.length; i++) { - if (pathA[i] !== pathB[i]) - break; - } - return [(pathA.length - i).toString(), ...pathB.slice(i)].join("/"); - }; - exports.getRelativePath = getRelativePath; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/any.js - var require_any = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/any.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseAnyDef = void 0; - var getRelativePath_js_1 = require_getRelativePath(); - function parseAnyDef(refs) { - if (refs.target !== "openAi") { - return {}; - } - const anyDefinitionPath = [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ]; - refs.flags.hasReferencedOpenAiAnyType = true; - return { - $ref: refs.$refStrategy === "relative" ? (0, getRelativePath_js_1.getRelativePath)(anyDefinitionPath, refs.currentPath) : anyDefinitionPath.join("/") - }; - } - exports.parseAnyDef = parseAnyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/array.js - var require_array = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/array.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseArrayDef = void 0; - var zod_1 = require_zod(); - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseArrayDef(def, refs) { - const res = { - type: "array" - }; - if (def.type?._def && def.type?._def?.typeName !== zod_1.ZodFirstPartyTypeKind.ZodAny) { - res.items = (0, parseDef_js_1.parseDef)(def.type._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - } - if (def.minLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.minLength.value, def.minLength.message, refs); - } - if (def.maxLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.maxLength.value, def.maxLength.message, refs); - } - if (def.exactLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.exactLength.value, def.exactLength.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.exactLength.value, def.exactLength.message, refs); - } - return res; - } - exports.parseArrayDef = parseArrayDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js - var require_bigint = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBigintDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseBigintDef(def, refs) { - const res = { - type: "integer", - format: "int64" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseBigintDef = parseBigintDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js - var require_boolean = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBooleanDef = void 0; - function parseBooleanDef() { - return { - type: "boolean" - }; - } - exports.parseBooleanDef = parseBooleanDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js - var require_branded = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBrandedDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseBrandedDef(_def, refs) { - return (0, parseDef_js_1.parseDef)(_def.type._def, refs); - } - exports.parseBrandedDef = parseBrandedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js - var require_catch = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseCatchDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseCatchDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseCatchDef = parseCatchDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/date.js - var require_date = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/date.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDateDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseDateDef(def, refs, overrideDateStrategy) { - const strategy = overrideDateStrategy ?? refs.dateStrategy; - if (Array.isArray(strategy)) { - return { - anyOf: strategy.map((item, i) => parseDateDef(def, refs, item)) - }; - } - switch (strategy) { - case "string": - case "format:date-time": - return { - type: "string", - format: "date-time" - }; - case "format:date": - return { - type: "string", - format: "date" - }; - case "integer": - return integerDateParser(def, refs); - } - } - exports.parseDateDef = parseDateDef; - var integerDateParser = (def, refs) => { - const res = { - type: "integer", - format: "unix-time" - }; - if (refs.target === "openApi3") { - return res; - } - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "minimum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "maximum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - } - } - return res; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/default.js - var require_default = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/default.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDefaultDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseDefaultDef(_def, refs) { - return { - ...(0, parseDef_js_1.parseDef)(_def.innerType._def, refs), - default: _def.defaultValue() - }; - } - exports.parseDefaultDef = parseDefaultDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js - var require_effects = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEffectsDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - function parseEffectsDef(_def, refs) { - return refs.effectStrategy === "input" ? (0, parseDef_js_1.parseDef)(_def.schema._def, refs) : (0, any_js_1.parseAnyDef)(refs); - } - exports.parseEffectsDef = parseEffectsDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js - var require_enum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEnumDef = void 0; - function parseEnumDef(def) { - return { - type: "string", - enum: Array.from(def.values) - }; - } - exports.parseEnumDef = parseEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js - var require_intersection = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseIntersectionDef = void 0; - var parseDef_js_1 = require_parseDef(); - var isJsonSchema7AllOfType = (type) => { - if ("type" in type && type.type === "string") - return false; - return "allOf" in type; - }; - function parseIntersectionDef(def, refs) { - const allOf = [ - (0, parseDef_js_1.parseDef)(def.left._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }), - (0, parseDef_js_1.parseDef)(def.right._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "1"] - }) - ].filter((x) => !!x); - let unevaluatedProperties = refs.target === "jsonSchema2019-09" ? { unevaluatedProperties: false } : void 0; - const mergedAllOf = []; - allOf.forEach((schema) => { - if (isJsonSchema7AllOfType(schema)) { - mergedAllOf.push(...schema.allOf); - if (schema.unevaluatedProperties === void 0) { - unevaluatedProperties = void 0; - } - } else { - let nestedSchema = schema; - if ("additionalProperties" in schema && schema.additionalProperties === false) { - const { additionalProperties, ...rest } = schema; - nestedSchema = rest; - } else { - unevaluatedProperties = void 0; - } - mergedAllOf.push(nestedSchema); - } - }); - return mergedAllOf.length ? { - allOf: mergedAllOf, - ...unevaluatedProperties - } : void 0; - } - exports.parseIntersectionDef = parseIntersectionDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js - var require_literal = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseLiteralDef = void 0; - function parseLiteralDef(def, refs) { - const parsedType = typeof def.value; - if (parsedType !== "bigint" && parsedType !== "number" && parsedType !== "boolean" && parsedType !== "string") { - return { - type: Array.isArray(def.value) ? "array" : "object" - }; - } - if (refs.target === "openApi3") { - return { - type: parsedType === "bigint" ? "integer" : parsedType, - enum: [def.value] - }; - } - return { - type: parsedType === "bigint" ? "integer" : parsedType, - const: def.value - }; - } - exports.parseLiteralDef = parseLiteralDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/string.js - var require_string = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/string.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseStringDef = exports.zodPatterns = void 0; - var errorMessages_js_1 = require_errorMessages(); - var emojiRegex = void 0; - exports.zodPatterns = { - /** - * `c` was changed to `[cC]` to replicate /i flag - */ - cuid: /^[cC][^\s-]{8,}$/, - cuid2: /^[0-9a-z]+$/, - ulid: /^[0-9A-HJKMNP-TV-Z]{26}$/, - /** - * `a-z` was added to replicate /i flag - */ - email: /^(?!\.)(?!.*\.\.)([a-zA-Z0-9_'+\-\.]*)[a-zA-Z0-9_+-]@([a-zA-Z0-9][a-zA-Z0-9\-]*\.)+[a-zA-Z]{2,}$/, - /** - * Constructed a valid Unicode RegExp - * - * Lazily instantiate since this type of regex isn't supported - * in all envs (e.g. React Native). - * - * See: - * https://github.com/colinhacks/zod/issues/2433 - * Fix in Zod: - * https://github.com/colinhacks/zod/commit/9340fd51e48576a75adc919bff65dbc4a5d4c99b - */ - emoji: () => { - if (emojiRegex === void 0) { - emojiRegex = RegExp("^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$", "u"); - } - return emojiRegex; - }, - /** - * Unused - */ - uuid: /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/, - /** - * Unused - */ - ipv4: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/, - ipv4Cidr: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/, - /** - * Unused - */ - ipv6: /^(([a-f0-9]{1,4}:){7}|::([a-f0-9]{1,4}:){0,6}|([a-f0-9]{1,4}:){1}:([a-f0-9]{1,4}:){0,5}|([a-f0-9]{1,4}:){2}:([a-f0-9]{1,4}:){0,4}|([a-f0-9]{1,4}:){3}:([a-f0-9]{1,4}:){0,3}|([a-f0-9]{1,4}:){4}:([a-f0-9]{1,4}:){0,2}|([a-f0-9]{1,4}:){5}:([a-f0-9]{1,4}:){0,1})([a-f0-9]{1,4}|(((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2}))\.){3}((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2})))$/, - ipv6Cidr: /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/, - base64: /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/, - base64url: /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/, - nanoid: /^[a-zA-Z0-9_-]{21}$/, - jwt: /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/ - }; - function parseStringDef(def, refs) { - const res = { - type: "string" - }; - if (def.checks) { - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "email": - switch (refs.emailStrategy) { - case "format:email": - addFormat(res, "email", check.message, refs); - break; - case "format:idn-email": - addFormat(res, "idn-email", check.message, refs); - break; - case "pattern:zod": - addPattern(res, exports.zodPatterns.email, check.message, refs); - break; - } - break; - case "url": - addFormat(res, "uri", check.message, refs); - break; - case "uuid": - addFormat(res, "uuid", check.message, refs); - break; - case "regex": - addPattern(res, check.regex, check.message, refs); - break; - case "cuid": - addPattern(res, exports.zodPatterns.cuid, check.message, refs); - break; - case "cuid2": - addPattern(res, exports.zodPatterns.cuid2, check.message, refs); - break; - case "startsWith": - addPattern(res, RegExp(`^${escapeLiteralCheckValue(check.value, refs)}`), check.message, refs); - break; - case "endsWith": - addPattern(res, RegExp(`${escapeLiteralCheckValue(check.value, refs)}$`), check.message, refs); - break; - case "datetime": - addFormat(res, "date-time", check.message, refs); - break; - case "date": - addFormat(res, "date", check.message, refs); - break; - case "time": - addFormat(res, "time", check.message, refs); - break; - case "duration": - addFormat(res, "duration", check.message, refs); - break; - case "length": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "includes": { - addPattern(res, RegExp(escapeLiteralCheckValue(check.value, refs)), check.message, refs); - break; - } - case "ip": { - if (check.version !== "v6") { - addFormat(res, "ipv4", check.message, refs); - } - if (check.version !== "v4") { - addFormat(res, "ipv6", check.message, refs); - } - break; - } - case "base64url": - addPattern(res, exports.zodPatterns.base64url, check.message, refs); - break; - case "jwt": - addPattern(res, exports.zodPatterns.jwt, check.message, refs); - break; - case "cidr": { - if (check.version !== "v6") { - addPattern(res, exports.zodPatterns.ipv4Cidr, check.message, refs); - } - if (check.version !== "v4") { - addPattern(res, exports.zodPatterns.ipv6Cidr, check.message, refs); - } - break; - } - case "emoji": - addPattern(res, exports.zodPatterns.emoji(), check.message, refs); - break; - case "ulid": { - addPattern(res, exports.zodPatterns.ulid, check.message, refs); - break; - } - case "base64": { - switch (refs.base64Strategy) { - case "format:binary": { - addFormat(res, "binary", check.message, refs); - break; - } - case "contentEncoding:base64": { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "contentEncoding", "base64", check.message, refs); - break; - } - case "pattern:zod": { - addPattern(res, exports.zodPatterns.base64, check.message, refs); - break; - } - } - break; - } - case "nanoid": { - addPattern(res, exports.zodPatterns.nanoid, check.message, refs); - } - case "toLowerCase": - case "toUpperCase": - case "trim": - break; - default: - /* @__PURE__ */ ((_) => { - })(check); - } - } - } - return res; - } - exports.parseStringDef = parseStringDef; - function escapeLiteralCheckValue(literal, refs) { - return refs.patternStrategy === "escape" ? escapeNonAlphaNumeric(literal) : literal; - } - var ALPHA_NUMERIC = new Set("ABCDEFGHIJKLMNOPQRSTUVXYZabcdefghijklmnopqrstuvxyz0123456789"); - function escapeNonAlphaNumeric(source) { - let result = ""; - for (let i = 0; i < source.length; i++) { - if (!ALPHA_NUMERIC.has(source[i])) { - result += "\\"; - } - result += source[i]; - } - return result; - } - function addFormat(schema, value, message, refs) { - if (schema.format || schema.anyOf?.some((x) => x.format)) { - if (!schema.anyOf) { - schema.anyOf = []; - } - if (schema.format) { - schema.anyOf.push({ - format: schema.format, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { format: schema.errorMessage.format } - } - }); - delete schema.format; - if (schema.errorMessage) { - delete schema.errorMessage.format; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.anyOf.push({ - format: value, - ...message && refs.errorMessages && { errorMessage: { format: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "format", value, message, refs); - } - } - function addPattern(schema, regex, message, refs) { - if (schema.pattern || schema.allOf?.some((x) => x.pattern)) { - if (!schema.allOf) { - schema.allOf = []; - } - if (schema.pattern) { - schema.allOf.push({ - pattern: schema.pattern, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { pattern: schema.errorMessage.pattern } - } - }); - delete schema.pattern; - if (schema.errorMessage) { - delete schema.errorMessage.pattern; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.allOf.push({ - pattern: stringifyRegExpWithFlags(regex, refs), - ...message && refs.errorMessages && { errorMessage: { pattern: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "pattern", stringifyRegExpWithFlags(regex, refs), message, refs); - } - } - function stringifyRegExpWithFlags(regex, refs) { - if (!refs.applyRegexFlags || !regex.flags) { - return regex.source; - } - const flags = { - i: regex.flags.includes("i"), - m: regex.flags.includes("m"), - s: regex.flags.includes("s") - // `.` matches newlines - }; - const source = flags.i ? regex.source.toLowerCase() : regex.source; - let pattern = ""; - let isEscaped = false; - let inCharGroup = false; - let inCharRange = false; - for (let i = 0; i < source.length; i++) { - if (isEscaped) { - pattern += source[i]; - isEscaped = false; - continue; - } - if (flags.i) { - if (inCharGroup) { - if (source[i].match(/[a-z]/)) { - if (inCharRange) { - pattern += source[i]; - pattern += `${source[i - 2]}-${source[i]}`.toUpperCase(); - inCharRange = false; - } else if (source[i + 1] === "-" && source[i + 2]?.match(/[a-z]/)) { - pattern += source[i]; - inCharRange = true; - } else { - pattern += `${source[i]}${source[i].toUpperCase()}`; - } - continue; - } - } else if (source[i].match(/[a-z]/)) { - pattern += `[${source[i]}${source[i].toUpperCase()}]`; - continue; - } - } - if (flags.m) { - if (source[i] === "^") { - pattern += `(^|(?<=[\r -]))`; - continue; - } else if (source[i] === "$") { - pattern += `($|(?=[\r -]))`; - continue; - } - } - if (flags.s && source[i] === ".") { - pattern += inCharGroup ? `${source[i]}\r -` : `[${source[i]}\r -]`; - continue; - } - pattern += source[i]; - if (source[i] === "\\") { - isEscaped = true; - } else if (inCharGroup && source[i] === "]") { - inCharGroup = false; - } else if (!inCharGroup && source[i] === "[") { - inCharGroup = true; - } - } - try { - new RegExp(pattern); - } catch { - console.warn(`Could not convert regex pattern at ${refs.currentPath.join("/")} to a flag-independent form! Falling back to the flag-ignorant source`); - return regex.source; - } - return pattern; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/record.js - var require_record = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/record.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseRecordDef = void 0; - var zod_1 = require_zod(); - var parseDef_js_1 = require_parseDef(); - var string_js_1 = require_string(); - var branded_js_1 = require_branded(); - var any_js_1 = require_any(); - function parseRecordDef(def, refs) { - if (refs.target === "openAi") { - console.warn("Warning: OpenAI may not support records in schemas! Try an array of key-value pairs instead."); - } - if (refs.target === "openApi3" && def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - type: "object", - required: def.keyType._def.values, - properties: def.keyType._def.values.reduce((acc, key) => ({ - ...acc, - [key]: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", key] - }) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}), - additionalProperties: refs.rejectedAdditionalProperties - }; - } - const schema = { - type: "object", - additionalProperties: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }) ?? refs.allowedAdditionalProperties - }; - if (refs.target === "openApi3") { - return schema; - } - if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.checks?.length) { - const { type, ...keyType } = (0, string_js_1.parseStringDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - ...schema, - propertyNames: { - enum: def.keyType._def.values - } - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodBranded && def.keyType._def.type._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.type._def.checks?.length) { - const { type, ...keyType } = (0, branded_js_1.parseBrandedDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } - return schema; - } - exports.parseRecordDef = parseRecordDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/map.js - var require_map = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/map.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseMapDef = void 0; - var parseDef_js_1 = require_parseDef(); - var record_js_1 = require_record(); - var any_js_1 = require_any(); - function parseMapDef(def, refs) { - if (refs.mapStrategy === "record") { - return (0, record_js_1.parseRecordDef)(def, refs); - } - const keys = (0, parseDef_js_1.parseDef)(def.keyType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "0"] - }) || (0, any_js_1.parseAnyDef)(refs); - const values = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "1"] - }) || (0, any_js_1.parseAnyDef)(refs); - return { - type: "array", - maxItems: 125, - items: { - type: "array", - items: [keys, values], - minItems: 2, - maxItems: 2 - } - }; - } - exports.parseMapDef = parseMapDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js - var require_nativeEnum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNativeEnumDef = void 0; - function parseNativeEnumDef(def) { - const object = def.values; - const actualKeys = Object.keys(def.values).filter((key) => { - return typeof object[object[key]] !== "number"; - }); - const actualValues = actualKeys.map((key) => object[key]); - const parsedTypes = Array.from(new Set(actualValues.map((values) => typeof values))); - return { - type: parsedTypes.length === 1 ? parsedTypes[0] === "string" ? "string" : "number" : ["string", "number"], - enum: actualValues - }; - } - exports.parseNativeEnumDef = parseNativeEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/never.js - var require_never = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/never.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNeverDef = void 0; - var any_js_1 = require_any(); - function parseNeverDef(refs) { - return refs.target === "openAi" ? void 0 : { - not: (0, any_js_1.parseAnyDef)({ - ...refs, - currentPath: [...refs.currentPath, "not"] - }) - }; - } - exports.parseNeverDef = parseNeverDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/null.js - var require_null = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/null.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullDef = void 0; - function parseNullDef(refs) { - return refs.target === "openApi3" ? { - enum: ["null"], - nullable: true - } : { - type: "null" - }; - } - exports.parseNullDef = parseNullDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/union.js - var require_union = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/union.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnionDef = exports.primitiveMappings = void 0; - var parseDef_js_1 = require_parseDef(); - exports.primitiveMappings = { - ZodString: "string", - ZodNumber: "number", - ZodBigInt: "integer", - ZodBoolean: "boolean", - ZodNull: "null" - }; - function parseUnionDef(def, refs) { - if (refs.target === "openApi3") - return asAnyOf(def, refs); - const options = def.options instanceof Map ? Array.from(def.options.values()) : def.options; - if (options.every((x) => x._def.typeName in exports.primitiveMappings && (!x._def.checks || !x._def.checks.length))) { - const types = options.reduce((types2, x) => { - const type = exports.primitiveMappings[x._def.typeName]; - return type && !types2.includes(type) ? [...types2, type] : types2; - }, []); - return { - type: types.length > 1 ? types : types[0] - }; - } else if (options.every((x) => x._def.typeName === "ZodLiteral" && !x.description)) { - const types = options.reduce((acc, x) => { - const type = typeof x._def.value; - switch (type) { - case "string": - case "number": - case "boolean": - return [...acc, type]; - case "bigint": - return [...acc, "integer"]; - case "object": - if (x._def.value === null) - return [...acc, "null"]; - case "symbol": - case "undefined": - case "function": - default: - return acc; - } - }, []); - if (types.length === options.length) { - const uniqueTypes = types.filter((x, i, a) => a.indexOf(x) === i); - return { - type: uniqueTypes.length > 1 ? uniqueTypes : uniqueTypes[0], - enum: options.reduce((acc, x) => { - return acc.includes(x._def.value) ? acc : [...acc, x._def.value]; - }, []) - }; - } - } else if (options.every((x) => x._def.typeName === "ZodEnum")) { - return { - type: "string", - enum: options.reduce((acc, x) => [ - ...acc, - ...x._def.values.filter((x2) => !acc.includes(x2)) - ], []) - }; - } - return asAnyOf(def, refs); - } - exports.parseUnionDef = parseUnionDef; - var asAnyOf = (def, refs) => { - const anyOf = (def.options instanceof Map ? Array.from(def.options.values()) : def.options).map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", `${i}`] - })).filter((x) => !!x && (!refs.strictUnions || typeof x === "object" && Object.keys(x).length > 0)); - return anyOf.length ? { anyOf } : void 0; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js - var require_nullable = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullableDef = void 0; - var parseDef_js_1 = require_parseDef(); - var union_js_1 = require_union(); - function parseNullableDef(def, refs) { - if (["ZodString", "ZodNumber", "ZodBigInt", "ZodBoolean", "ZodNull"].includes(def.innerType._def.typeName) && (!def.innerType._def.checks || !def.innerType._def.checks.length)) { - if (refs.target === "openApi3") { - return { - type: union_js_1.primitiveMappings[def.innerType._def.typeName], - nullable: true - }; - } - return { - type: [ - union_js_1.primitiveMappings[def.innerType._def.typeName], - "null" - ] - }; - } - if (refs.target === "openApi3") { - const base2 = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath] - }); - if (base2 && "$ref" in base2) - return { allOf: [base2], nullable: true }; - return base2 && { ...base2, nullable: true }; - } - const base = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "0"] - }); - return base && { anyOf: [base, { type: "null" }] }; - } - exports.parseNullableDef = parseNullableDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/number.js - var require_number = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/number.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNumberDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseNumberDef(def, refs) { - const res = { - type: "number" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "int": - res.type = "integer"; - (0, errorMessages_js_1.addErrorMessage)(res, "type", check.message, refs); - break; - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseNumberDef = parseNumberDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/object.js - var require_object = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseObjectDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseObjectDef(def, refs) { - const forceOptionalIntoNullable = refs.target === "openAi"; - const result = { - type: "object", - properties: {} - }; - const required = []; - const shape = def.shape(); - for (const propName in shape) { - let propDef = shape[propName]; - if (propDef === void 0 || propDef._def === void 0) { - continue; - } - let propOptional = safeIsOptional(propDef); - if (propOptional && forceOptionalIntoNullable) { - if (propDef._def.typeName === "ZodOptional") { - propDef = propDef._def.innerType; - } - if (!propDef.isNullable()) { - propDef = propDef.nullable(); - } - propOptional = false; - } - const parsedDef = (0, parseDef_js_1.parseDef)(propDef._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", propName], - propertyPath: [...refs.currentPath, "properties", propName] - }); - if (parsedDef === void 0) { - continue; - } - result.properties[propName] = parsedDef; - if (!propOptional) { - required.push(propName); - } - } - if (required.length) { - result.required = required; - } - const additionalProperties = decideAdditionalProperties(def, refs); - if (additionalProperties !== void 0) { - result.additionalProperties = additionalProperties; - } - return result; - } - exports.parseObjectDef = parseObjectDef; - function decideAdditionalProperties(def, refs) { - if (def.catchall._def.typeName !== "ZodNever") { - return (0, parseDef_js_1.parseDef)(def.catchall._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }); - } - switch (def.unknownKeys) { - case "passthrough": - return refs.allowedAdditionalProperties; - case "strict": - return refs.rejectedAdditionalProperties; - case "strip": - return refs.removeAdditionalStrategy === "strict" ? refs.allowedAdditionalProperties : refs.rejectedAdditionalProperties; - } - } - function safeIsOptional(schema) { - try { - return schema.isOptional(); - } catch { - return true; - } - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js - var require_optional = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseOptionalDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - var parseOptionalDef = (def, refs) => { - if (refs.currentPath.toString() === refs.propertyPath?.toString()) { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - } - const innerSchema = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "1"] - }); - return innerSchema ? { - anyOf: [ - { - not: (0, any_js_1.parseAnyDef)(refs) - }, - innerSchema - ] - } : (0, any_js_1.parseAnyDef)(refs); - }; - exports.parseOptionalDef = parseOptionalDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js - var require_pipeline = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePipelineDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parsePipelineDef = (def, refs) => { - if (refs.pipeStrategy === "input") { - return (0, parseDef_js_1.parseDef)(def.in._def, refs); - } else if (refs.pipeStrategy === "output") { - return (0, parseDef_js_1.parseDef)(def.out._def, refs); - } - const a = (0, parseDef_js_1.parseDef)(def.in._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }); - const b = (0, parseDef_js_1.parseDef)(def.out._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", a ? "1" : "0"] - }); - return { - allOf: [a, b].filter((x) => x !== void 0) - }; - }; - exports.parsePipelineDef = parsePipelineDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js - var require_promise = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePromiseDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parsePromiseDef(def, refs) { - return (0, parseDef_js_1.parseDef)(def.type._def, refs); - } - exports.parsePromiseDef = parsePromiseDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/set.js - var require_set = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/set.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseSetDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseSetDef(def, refs) { - const items = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - const schema = { - type: "array", - uniqueItems: true, - items - }; - if (def.minSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "minItems", def.minSize.value, def.minSize.message, refs); - } - if (def.maxSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "maxItems", def.maxSize.value, def.maxSize.message, refs); - } - return schema; - } - exports.parseSetDef = parseSetDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js - var require_tuple = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseTupleDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseTupleDef(def, refs) { - if (def.rest) { - return { - type: "array", - minItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []), - additionalItems: (0, parseDef_js_1.parseDef)(def.rest._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalItems"] - }) - }; - } else { - return { - type: "array", - minItems: def.items.length, - maxItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []) - }; - } - } - exports.parseTupleDef = parseTupleDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js - var require_undefined = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUndefinedDef = void 0; - var any_js_1 = require_any(); - function parseUndefinedDef(refs) { - return { - not: (0, any_js_1.parseAnyDef)(refs) - }; - } - exports.parseUndefinedDef = parseUndefinedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js - var require_unknown = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnknownDef = void 0; - var any_js_1 = require_any(); - function parseUnknownDef(refs) { - return (0, any_js_1.parseAnyDef)(refs); - } - exports.parseUnknownDef = parseUnknownDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js - var require_readonly = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseReadonlyDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseReadonlyDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseReadonlyDef = parseReadonlyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/selectParser.js - var require_selectParser = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/selectParser.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.selectParser = void 0; - var zod_1 = require_zod(); - var any_js_1 = require_any(); - var array_js_1 = require_array(); - var bigint_js_1 = require_bigint(); - var boolean_js_1 = require_boolean(); - var branded_js_1 = require_branded(); - var catch_js_1 = require_catch(); - var date_js_1 = require_date(); - var default_js_1 = require_default(); - var effects_js_1 = require_effects(); - var enum_js_1 = require_enum(); - var intersection_js_1 = require_intersection(); - var literal_js_1 = require_literal(); - var map_js_1 = require_map(); - var nativeEnum_js_1 = require_nativeEnum(); - var never_js_1 = require_never(); - var null_js_1 = require_null(); - var nullable_js_1 = require_nullable(); - var number_js_1 = require_number(); - var object_js_1 = require_object(); - var optional_js_1 = require_optional(); - var pipeline_js_1 = require_pipeline(); - var promise_js_1 = require_promise(); - var record_js_1 = require_record(); - var set_js_1 = require_set(); - var string_js_1 = require_string(); - var tuple_js_1 = require_tuple(); - var undefined_js_1 = require_undefined(); - var union_js_1 = require_union(); - var unknown_js_1 = require_unknown(); - var readonly_js_1 = require_readonly(); - var selectParser = (def, typeName, refs) => { - switch (typeName) { - case zod_1.ZodFirstPartyTypeKind.ZodString: - return (0, string_js_1.parseStringDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNumber: - return (0, number_js_1.parseNumberDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodObject: - return (0, object_js_1.parseObjectDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBigInt: - return (0, bigint_js_1.parseBigintDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBoolean: - return (0, boolean_js_1.parseBooleanDef)(); - case zod_1.ZodFirstPartyTypeKind.ZodDate: - return (0, date_js_1.parseDateDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUndefined: - return (0, undefined_js_1.parseUndefinedDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodNull: - return (0, null_js_1.parseNullDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodArray: - return (0, array_js_1.parseArrayDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnion: - case zod_1.ZodFirstPartyTypeKind.ZodDiscriminatedUnion: - return (0, union_js_1.parseUnionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodIntersection: - return (0, intersection_js_1.parseIntersectionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodTuple: - return (0, tuple_js_1.parseTupleDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodRecord: - return (0, record_js_1.parseRecordDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLiteral: - return (0, literal_js_1.parseLiteralDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodEnum: - return (0, enum_js_1.parseEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNativeEnum: - return (0, nativeEnum_js_1.parseNativeEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNullable: - return (0, nullable_js_1.parseNullableDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodOptional: - return (0, optional_js_1.parseOptionalDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodMap: - return (0, map_js_1.parseMapDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodSet: - return (0, set_js_1.parseSetDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLazy: - return () => def.getter()._def; - case zod_1.ZodFirstPartyTypeKind.ZodPromise: - return (0, promise_js_1.parsePromiseDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNaN: - case zod_1.ZodFirstPartyTypeKind.ZodNever: - return (0, never_js_1.parseNeverDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodEffects: - return (0, effects_js_1.parseEffectsDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodAny: - return (0, any_js_1.parseAnyDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnknown: - return (0, unknown_js_1.parseUnknownDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodDefault: - return (0, default_js_1.parseDefaultDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBranded: - return (0, branded_js_1.parseBrandedDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodReadonly: - return (0, readonly_js_1.parseReadonlyDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodCatch: - return (0, catch_js_1.parseCatchDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodPipeline: - return (0, pipeline_js_1.parsePipelineDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodFunction: - case zod_1.ZodFirstPartyTypeKind.ZodVoid: - case zod_1.ZodFirstPartyTypeKind.ZodSymbol: - return void 0; - default: - return /* @__PURE__ */ ((_) => void 0)(typeName); - } - }; - exports.selectParser = selectParser; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseDef.js - var require_parseDef = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseDef.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDef = void 0; - var Options_js_1 = require_Options(); - var selectParser_js_1 = require_selectParser(); - var getRelativePath_js_1 = require_getRelativePath(); - var any_js_1 = require_any(); - function parseDef(def, refs, forceResolution = false) { - const seenItem = refs.seen.get(def); - if (refs.override) { - const overrideResult = refs.override?.(def, refs, seenItem, forceResolution); - if (overrideResult !== Options_js_1.ignoreOverride) { - return overrideResult; - } - } - if (seenItem && !forceResolution) { - const seenSchema = get$ref(seenItem, refs); - if (seenSchema !== void 0) { - return seenSchema; - } - } - const newItem = { def, path: refs.currentPath, jsonSchema: void 0 }; - refs.seen.set(def, newItem); - const jsonSchemaOrGetter = (0, selectParser_js_1.selectParser)(def, def.typeName, refs); - const jsonSchema = typeof jsonSchemaOrGetter === "function" ? parseDef(jsonSchemaOrGetter(), refs) : jsonSchemaOrGetter; - if (jsonSchema) { - addMeta(def, refs, jsonSchema); - } - if (refs.postProcess) { - const postProcessResult = refs.postProcess(jsonSchema, def, refs); - newItem.jsonSchema = jsonSchema; - return postProcessResult; - } - newItem.jsonSchema = jsonSchema; - return jsonSchema; - } - exports.parseDef = parseDef; - var get$ref = (item, refs) => { - switch (refs.$refStrategy) { - case "root": - return { $ref: item.path.join("/") }; - case "relative": - return { $ref: (0, getRelativePath_js_1.getRelativePath)(refs.currentPath, item.path) }; - case "none": - case "seen": { - if (item.path.length < refs.currentPath.length && item.path.every((value, index) => refs.currentPath[index] === value)) { - console.warn(`Recursive reference detected at ${refs.currentPath.join("/")}! Defaulting to any`); - return (0, any_js_1.parseAnyDef)(refs); - } - return refs.$refStrategy === "seen" ? (0, any_js_1.parseAnyDef)(refs) : void 0; - } - } - }; - var addMeta = (def, refs, jsonSchema) => { - if (def.description) { - jsonSchema.description = def.description; - if (refs.markdownDescription) { - jsonSchema.markdownDescription = def.description; - } - } - return jsonSchema; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseTypes.js - var require_parseTypes = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseTypes.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js - var require_zodToJsonSchema = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodToJsonSchema = void 0; - var parseDef_js_1 = require_parseDef(); - var Refs_js_1 = require_Refs(); - var any_js_1 = require_any(); - var zodToJsonSchema = (schema, options) => { - const refs = (0, Refs_js_1.getRefs)(options); - let definitions = typeof options === "object" && options.definitions ? Object.entries(options.definitions).reduce((acc, [name2, schema2]) => ({ - ...acc, - [name2]: (0, parseDef_js_1.parseDef)(schema2._def, { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name2] - }, true) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}) : void 0; - const name = typeof options === "string" ? options : options?.nameStrategy === "title" ? void 0 : options?.name; - const main = (0, parseDef_js_1.parseDef)(schema._def, name === void 0 ? refs : { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name] - }, false) ?? (0, any_js_1.parseAnyDef)(refs); - const title = typeof options === "object" && options.name !== void 0 && options.nameStrategy === "title" ? options.name : void 0; - if (title !== void 0) { - main.title = title; - } - if (refs.flags.hasReferencedOpenAiAnyType) { - if (!definitions) { - definitions = {}; - } - if (!definitions[refs.openAiAnyTypeName]) { - definitions[refs.openAiAnyTypeName] = { - // Skipping "object" as no properties can be defined and additionalProperties must be "false" - type: ["string", "number", "integer", "boolean", "array", "null"], - items: { - $ref: refs.$refStrategy === "relative" ? "1" : [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ].join("/") - } - }; - } - } - const combined = name === void 0 ? definitions ? { - ...main, - [refs.definitionPath]: definitions - } : main : { - $ref: [ - ...refs.$refStrategy === "relative" ? [] : refs.basePath, - refs.definitionPath, - name - ].join("/"), - [refs.definitionPath]: { - ...definitions, - [name]: main - } - }; - if (refs.target === "jsonSchema7") { - combined.$schema = "http://json-schema.org/draft-07/schema#"; - } else if (refs.target === "jsonSchema2019-09" || refs.target === "openAi") { - combined.$schema = "https://json-schema.org/draft/2019-09/schema#"; - } - if (refs.target === "openAi" && ("anyOf" in combined || "oneOf" in combined || "allOf" in combined || "type" in combined && Array.isArray(combined.type))) { - console.warn("Warning: OpenAI may not support schemas with unions as roots! Try wrapping it in an object property."); - } - return combined; - }; - exports.zodToJsonSchema = zodToJsonSchema; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/index.js - var require_cjs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_Options(), exports); - __exportStar(require_Refs(), exports); - __exportStar(require_errorMessages(), exports); - __exportStar(require_getRelativePath(), exports); - __exportStar(require_parseDef(), exports); - __exportStar(require_parseTypes(), exports); - __exportStar(require_any(), exports); - __exportStar(require_array(), exports); - __exportStar(require_bigint(), exports); - __exportStar(require_boolean(), exports); - __exportStar(require_branded(), exports); - __exportStar(require_catch(), exports); - __exportStar(require_date(), exports); - __exportStar(require_default(), exports); - __exportStar(require_effects(), exports); - __exportStar(require_enum(), exports); - __exportStar(require_intersection(), exports); - __exportStar(require_literal(), exports); - __exportStar(require_map(), exports); - __exportStar(require_nativeEnum(), exports); - __exportStar(require_never(), exports); - __exportStar(require_null(), exports); - __exportStar(require_nullable(), exports); - __exportStar(require_number(), exports); - __exportStar(require_object(), exports); - __exportStar(require_optional(), exports); - __exportStar(require_pipeline(), exports); - __exportStar(require_promise(), exports); - __exportStar(require_readonly(), exports); - __exportStar(require_record(), exports); - __exportStar(require_set(), exports); - __exportStar(require_string(), exports); - __exportStar(require_tuple(), exports); - __exportStar(require_undefined(), exports); - __exportStar(require_union(), exports); - __exportStar(require_unknown(), exports); - __exportStar(require_selectParser(), exports); - __exportStar(require_zodToJsonSchema(), exports); - var zodToJsonSchema_js_1 = require_zodToJsonSchema(); - exports.default = zodToJsonSchema_js_1.zodToJsonSchema; - } - }); - - // node_modules/@mistralai/mistralai/extra/structChat.js - var require_structChat = __commonJS({ - "node_modules/@mistralai/mistralai/extra/structChat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.transformToChatCompletionRequest = transformToChatCompletionRequest; - exports.convertToParsedChatCompletionResponse = convertToParsedChatCompletionResponse; - exports.responseFormatFromZodObject = responseFormatFromZodObject; - var zod_to_json_schema_1 = require_cjs(); - function transformToChatCompletionRequest(parsedRequest) { - const { responseFormat, ...rest } = parsedRequest; - const transformedResponseFormat = responseFormatFromZodObject(responseFormat); - return { - ...rest, - responseFormat: transformedResponseFormat - }; - } - function convertToParsedChatCompletionResponse(response, responseFormat) { - if (response.choices === void 0 || response.choices.length === 0) { - return { - ...response, - choices: response.choices === void 0 ? void 0 : [] - }; - } - const parsedChoices = []; - for (const _choice of response.choices) { - if (_choice.message === null || typeof _choice.message === "undefined") { - parsedChoices.push({ ..._choice, message: void 0 }); - } else { - if (_choice.message.content !== null && typeof _choice.message.content !== "undefined" && !Array.isArray(_choice.message.content)) { - parsedChoices.push({ - ..._choice, - message: { - ..._choice.message, - parsed: responseFormat.safeParse(JSON.parse(_choice.message.content)).data - } - }); - } - } - } - return { - ...response, - choices: parsedChoices - }; - } - function responseFormatFromZodObject(responseFormat) { - const responseJsonSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(responseFormat); - const placeholderName = "placeholderName"; - return { - type: "json_schema", - jsonSchema: { - name: placeholderName, - schemaDefinition: responseJsonSchema, - strict: true - } - }; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/chat.js - var require_chat = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/chat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Chat = void 0; - var chatComplete_js_1 = require_chatComplete(); - var chatStream_js_1 = require_chatStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var structChat_js_1 = require_structChat(); - var Chat = class extends sdks_js_1.ClientSDK { - // #region sdk-class-body - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - async parse(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - const response = await (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, ccr_request, options)); - const parsed_response = (0, structChat_js_1.convertToParsedChatCompletionResponse)(response, request.responseFormat); - return parsed_response; - } - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - async parseStream(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, ccr_request, options)); - } - // #endregion sdk-class-body - /** - * Chat Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, request, options)); - } - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, request, options)); - } - }; - exports.Chat = Chat; - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassify.js - var require_classifiersClassify = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassify.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassify = classifiersClassify; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassify(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "classifications_v1_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js - var require_classifiersClassifyChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassifyChat = classifiersClassifyChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassifyChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_classifications_v1_chat_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerate.js - var require_classifiersModerate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerate = classifiersModerate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "moderations_v1_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js - var require_classifiersModerateChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerateChat = classifiersModerateChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerateChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatModerationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_moderations_v1_chat_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/classifiers.js - var require_classifiers = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/classifiers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Classifiers = void 0; - var classifiersClassify_js_1 = require_classifiersClassify(); - var classifiersClassifyChat_js_1 = require_classifiersClassifyChat(); - var classifiersModerate_js_1 = require_classifiersModerate(); - var classifiersModerateChat_js_1 = require_classifiersModerateChat(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Classifiers = class extends sdks_js_1.ClientSDK { - /** - * Moderations - */ - async moderate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerate_js_1.classifiersModerate)(this, request, options)); - } - /** - * Chat Moderations - */ - async moderateChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerateChat_js_1.classifiersModerateChat)(this, request, options)); - } - /** - * Classifications - */ - async classify(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassify_js_1.classifiersClassify)(this, request, options)); - } - /** - * Chat Classifications - */ - async classifyChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassifyChat_js_1.classifiersClassifyChat)(this, request, options)); - } - }; - exports.Classifiers = Classifiers; - } - }); - - // node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js - var require_embeddingsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.embeddingsCreate = embeddingsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function embeddingsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.EmbeddingRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/embeddings")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "embeddings_v1_embeddings_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.EmbeddingResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/embeddings.js - var require_embeddings = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/embeddings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Embeddings = void 0; - var embeddingsCreate_js_1 = require_embeddingsCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Embeddings = class extends sdks_js_1.ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, embeddingsCreate_js_1.embeddingsCreate)(this, request, options)); - } - }; - exports.Embeddings = Embeddings; - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDelete.js - var require_filesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDelete = filesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_delete_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.DeleteFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDownload.js - var require_filesDownload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDownload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDownload = filesDownload; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDownload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/octet-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_download_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.stream(200, z.instanceof(ReadableStream)), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js - var require_filesGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesGetSignedUrl = filesGetSignedUrl; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/url")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "expiry": payload.expiry - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_get_signed_url", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.FileSignedURL$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesList.js - var require_filesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesList = filesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesListFilesRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size, - "purpose": payload?.purpose, - "sample_type": payload?.sample_type, - "search": payload?.search, - "source": payload?.source - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_list_files", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListFilesOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesRetrieve.js - var require_filesRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesRetrieve = filesRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_retrieve_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.RetrieveFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesUpload.js - var require_filesUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesUpload = filesUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function filesUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - if (payload.purpose !== void 0) { - (0, encodings_js_1.appendForm)(body, "purpose", payload.purpose); - } - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_upload_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UploadFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/files.js - var require_files2 = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Files = void 0; - var filesDelete_js_1 = require_filesDelete(); - var filesDownload_js_1 = require_filesDownload(); - var filesGetSignedUrl_js_1 = require_filesGetSignedUrl(); - var filesList_js_1 = require_filesList(); - var filesRetrieve_js_1 = require_filesRetrieve(); - var filesUpload_js_1 = require_filesUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Files = class extends sdks_js_1.ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesUpload_js_1.filesUpload)(this, request, options)); - } - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesList_js_1.filesList)(this, request, options)); - } - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesRetrieve_js_1.filesRetrieve)(this, request, options)); - } - /** - * Delete File - * - * @remarks - * Delete a file. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDelete_js_1.filesDelete)(this, request, options)); - } - /** - * Download File - * - * @remarks - * Download a file - */ - async download(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDownload_js_1.filesDownload)(this, request, options)); - } - /** - * Get Signed Url - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesGetSignedUrl_js_1.filesGetSignedUrl)(this, request, options)); - } - }; - exports.Files = Files; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimComplete.js - var require_fimComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimComplete = fimComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "fim_completion_v1_fim_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.FIMCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimStream.js - var require_fimStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimStream = fimStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_fim", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/fim.js - var require_fim = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/fim.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Fim = void 0; - var fimComplete_js_1 = require_fimComplete(); - var fimStream_js_1 = require_fimStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Fim = class extends sdks_js_1.ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimComplete_js_1.fimComplete)(this, request, options)); - } - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimStream_js_1.fimStream)(this, request, options)); - } - }; - exports.Fim = Fim; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js - var require_fineTuningJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCancel = fineTuningJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js - var require_fineTuningJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCreate = fineTuningJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.JobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_create_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js - var require_fineTuningJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsGet = fineTuningJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js - var require_fineTuningJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsList = fineTuningJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "created_after": payload?.created_after, - "created_before": payload?.created_before, - "created_by_me": payload?.created_by_me, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status, - "suffix": payload?.suffix, - "wandb_name": payload?.wandb_name, - "wandb_project": payload?.wandb_project - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.JobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js - var require_fineTuningJobsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsStart = fineTuningJobsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/start")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_start_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/jobs.js - var require_jobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/jobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Jobs = void 0; - var fineTuningJobsCancel_js_1 = require_fineTuningJobsCancel(); - var fineTuningJobsCreate_js_1 = require_fineTuningJobsCreate(); - var fineTuningJobsGet_js_1 = require_fineTuningJobsGet(); - var fineTuningJobsList_js_1 = require_fineTuningJobsList(); - var fineTuningJobsStart_js_1 = require_fineTuningJobsStart(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Jobs = class extends sdks_js_1.ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsList_js_1.fineTuningJobsList)(this, request, options)); - } - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCreate_js_1.fineTuningJobsCreate)(this, request, options)); - } - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsGet_js_1.fineTuningJobsGet)(this, request, options)); - } - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCancel_js_1.fineTuningJobsCancel)(this, request, options)); - } - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsStart_js_1.fineTuningJobsStart)(this, request, options)); - } - }; - exports.Jobs = Jobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/finetuning.js - var require_finetuning = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/finetuning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuning = void 0; - var sdks_js_1 = require_sdks(); - var jobs_js_1 = require_jobs(); - var FineTuning = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new jobs_js_1.Jobs(this._options)); - } - }; - exports.FineTuning = FineTuning; - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsArchive.js - var require_modelsArchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsArchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsArchive = modelsArchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsArchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_archive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ArchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsDelete.js - var require_modelsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsDelete = modelsDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "delete_model_v1_models__model_id__delete", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DeleteModelOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsList.js - var require_modelsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsList = modelsList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function modelsList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/models")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "list_models_v1_models_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModelList$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js - var require_modelsRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsRetrieve = modelsRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "retrieve_model_v1_models__model_id__get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js - var require_modelsUnarchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUnarchive = modelsUnarchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUnarchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UnarchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUpdate.js - var require_modelsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUpdate = modelsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.UpdateFTModelIn, { explode: true }); - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_update_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/models.js - var require_models = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/models.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Models = void 0; - var modelsArchive_js_1 = require_modelsArchive(); - var modelsDelete_js_1 = require_modelsDelete(); - var modelsList_js_1 = require_modelsList(); - var modelsRetrieve_js_1 = require_modelsRetrieve(); - var modelsUnarchive_js_1 = require_modelsUnarchive(); - var modelsUpdate_js_1 = require_modelsUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Models = class extends sdks_js_1.ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, modelsList_js_1.modelsList)(this, options)); - } - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsRetrieve_js_1.modelsRetrieve)(this, request, options)); - } - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsDelete_js_1.modelsDelete)(this, request, options)); - } - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUpdate_js_1.modelsUpdate)(this, request, options)); - } - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - async archive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsArchive_js_1.modelsArchive)(this, request, options)); - } - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - async unarchive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUnarchive_js_1.modelsUnarchive)(this, request, options)); - } - }; - exports.Models = Models; - } - }); - - // node_modules/@mistralai/mistralai/funcs/ocrProcess.js - var require_ocrProcess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/ocrProcess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ocrProcess = ocrProcess; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function ocrProcess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.OCRRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/ocr")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "ocr_v1_ocr_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.OCRResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/ocr.js - var require_ocr = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/ocr.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Ocr = void 0; - var ocrProcess_js_1 = require_ocrProcess(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Ocr = class extends sdks_js_1.ClientSDK { - /** - * OCR - */ - async process(request, options) { - return (0, fp_js_1.unwrapAsync)((0, ocrProcess_js_1.ocrProcess)(this, request, options)); - } - }; - exports.Ocr = Ocr; - } - }); - - // node_modules/@mistralai/mistralai/sdk/sdk.js - var require_sdk = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/sdk.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Mistral = void 0; - var sdks_js_1 = require_sdks(); - var agents_js_1 = require_agents(); - var audio_js_1 = require_audio(); - var batch_js_1 = require_batch(); - var beta_js_1 = require_beta(); - var chat_js_1 = require_chat(); - var classifiers_js_1 = require_classifiers(); - var embeddings_js_1 = require_embeddings(); - var files_js_1 = require_files2(); - var fim_js_1 = require_fim(); - var finetuning_js_1 = require_finetuning(); - var models_js_1 = require_models(); - var ocr_js_1 = require_ocr(); - var Mistral = class extends sdks_js_1.ClientSDK { - get models() { - return this._models ?? (this._models = new models_js_1.Models(this._options)); - } - get beta() { - return this._beta ?? (this._beta = new beta_js_1.Beta(this._options)); - } - get files() { - return this._files ?? (this._files = new files_js_1.Files(this._options)); - } - get fineTuning() { - return this._fineTuning ?? (this._fineTuning = new finetuning_js_1.FineTuning(this._options)); - } - get batch() { - return this._batch ?? (this._batch = new batch_js_1.Batch(this._options)); - } - get chat() { - return this._chat ?? (this._chat = new chat_js_1.Chat(this._options)); - } - get fim() { - return this._fim ?? (this._fim = new fim_js_1.Fim(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new agents_js_1.Agents(this._options)); - } - get embeddings() { - return this._embeddings ?? (this._embeddings = new embeddings_js_1.Embeddings(this._options)); - } - get classifiers() { - return this._classifiers ?? (this._classifiers = new classifiers_js_1.Classifiers(this._options)); - } - get ocr() { - return this._ocr ?? (this._ocr = new ocr_js_1.Ocr(this._options)); - } - get audio() { - return this._audio ?? (this._audio = new audio_js_1.Audio(this._options)); - } - }; - exports.Mistral = Mistral; - } - }); - - // node_modules/@mistralai/mistralai/index.js - var require_mistralai = __commonJS({ - "node_modules/@mistralai/mistralai/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = exports.files = void 0; - __exportStar(require_config(), exports); - exports.files = __importStar(require_files()); - var http_js_1 = require_http(); - Object.defineProperty(exports, "HTTPClient", { enumerable: true, get: function() { - return http_js_1.HTTPClient; - } }); - __exportStar(require_sdk(), exports); - } - }); - - // - var _mistralai_mistralai = __toESM(require_mistralai()); - globalThis.__deps__ = globalThis.__deps__ || {}; - globalThis.__deps__._mistralai_mistralai = _mistralai_mistralai; -})(); diff --git a/examples/custom/public/mistral-try-it-now/tsworker.js b/examples/custom/public/mistral-try-it-now/tsworker.js deleted file mode 100644 index f4911c357..000000000 --- a/examples/custom/public/mistral-try-it-now/tsworker.js +++ /dev/null @@ -1,118 +0,0 @@ -// Web Worker for safely executing bundled code This runs in its own isolated -// context to prevent interference with the main thread, and to prevent console -// logs from the main thread from mixing with the logs from the worker. -// Browser-compatible string formatter (replacement for Node.js util.format) -function format(template, ...args) { - let index = 0; - return template.replace(/%([sdifcoO])/g, (match, specifier) => { - if (index >= args.length) - return match; - const arg = args[index++]; - switch (specifier) { - case "s": // string - return String(arg); - case "d": // number - case "i": // integer - return String(Number(arg)); - case "f": // float - return String(Number(arg)); - case "o": // object (simple) - case "O": // object (detailed) - try { - return JSON.stringify(arg); - } - catch { - return String(arg); - } - case "c": // CSS (not supported, just return empty) - return ""; - default: - return match; - } - }); -} -// Helper to enforce strict typing -function sendMessage(message) { - self.postMessage(message); -} -function createConsolePatch(console, level) { - const originalConsoleMethod = console[level]; - // console itself is defined using `any`, so we need to disable the lint - // eslint-disable-next-line @typescript-eslint/no-explicit-any - console[level] = (message, ...optionalParams) => { - const hasSubstitutions = typeof message === "string" && /%[sdifcoO]/.test(message); - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment - originalConsoleMethod.apply(console, [message, ...optionalParams]); - if (hasSubstitutions) { - sendMessage({ - type: "log", - level, - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument - message: format(message, ...optionalParams), - }); - return; - } - sendMessage({ - type: "log", - level, - message, - }); - for (const optionalParam of optionalParams) { - sendMessage({ - type: "log", - level, - message: optionalParam, - }); - } - }; -} -// Listen for messages from the main thread -self.onmessage = function (event) { - if (event.data.type === "execute") { - // Patch console - createConsolePatch(console, "log"); - createConsolePatch(console, "info"); - createConsolePatch(console, "warn"); - createConsolePatch(console, "error"); - createConsolePatch(console, "debug"); - // Listen for unhandled rejections, which includes the API returning an - // error status code - globalThis.addEventListener("unhandledrejection", (event) => { - sendMessage({ - type: "uncaught-reject", - error: event.reason instanceof Error - ? { - message: event.reason.message, - stack: event.reason.stack, - name: event.reason.name, - } - : { message: String(event.reason) }, - }); - }); - // Execute the wrapped code using an indirect eval call for safety. See - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_direct_eval! - try { - // First execute the dependency bundle to populate globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.dependencyBundle}`); - // Then execute the user code which can access dependencies via globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.bundle}`); - } - catch (error) { - // Send back the error - sendMessage({ - type: "uncaught-exception", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - } - } -}; -export {}; -//# sourceMappingURL=worker.js.map \ No newline at end of file diff --git a/examples/custom/public/mistral-try-it-now/types.d.ts b/examples/custom/public/mistral-try-it-now/types.d.ts deleted file mode 100644 index bac18f929..000000000 --- a/examples/custom/public/mistral-try-it-now/types.d.ts +++ /dev/null @@ -1,18932 +0,0 @@ -import * as z from 'zod'; -import { z as z_2 } from 'zod'; - -declare const __brand: unique symbol; - -declare class Accesses extends ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - list(request: operations.LibrariesShareListV1Request, options?: RequestOptions): Promise; - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - updateOrCreate(request: operations.LibrariesShareCreateV1Request, options?: RequestOptions): Promise; - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - delete(request: operations.LibrariesShareDeleteV1Request, options?: RequestOptions): Promise; -} - -declare type AfterErrorContext = HookContext & {}; - -declare interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable_2<{ - response: Response | null; - error: unknown; - }>; -} - -declare type AfterSuccessContext = HookContext & {}; - -declare interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable_2; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Agent$ { - /** @deprecated use `Agent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Agent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Agent$Outbound` instead. */ - type Outbound = Agent$Outbound; -} - -/** @internal */ -declare const Agent$inboundSchema: z.ZodType; - -/** @internal */ -declare type Agent$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object: string; - id: string; - version: number; - created_at: string; - updated_at: string; -}; - -/** @internal */ -declare const Agent$outboundSchema: z.ZodType; - -declare type Agent = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object?: AgentObject | undefined; - id: string; - version: number; - createdAt: Date; - updatedAt: Date; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversation$ { - /** @deprecated use `AgentConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$Outbound` instead. */ - type Outbound = AgentConversation$Outbound; -} - -/** @internal */ -declare const AgentConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentConversation$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - agent_id: string; -}; - -/** @internal */ -declare const AgentConversation$outboundSchema: z.ZodType; - -declare type AgentConversation = { - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: AgentConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - agentId: string; -}; - -declare function agentConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversationObject$ { - /** @deprecated use `AgentConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `AgentConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const AgentConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type AgentConversationObject = ClosedEnum; - -declare function agentConversationToJSON(agentConversation: AgentConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequest$ { - /** @deprecated use `AgentCreationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$Outbound` instead. */ - type Outbound = AgentCreationRequest$Outbound; -} - -/** @internal */ -declare const AgentCreationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentCreationRequest$outboundSchema: z.ZodType; - -declare type AgentCreationRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentCreationRequestFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToJSON(agentCreationRequest: AgentCreationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequestTools$ { - /** @deprecated use `AgentCreationRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$Outbound` instead. */ - type Outbound = AgentCreationRequestTools$Outbound; -} - -/** @internal */ -declare const AgentCreationRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentCreationRequestTools$outboundSchema: z.ZodType; - -declare type AgentCreationRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentCreationRequestToolsFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToolsToJSON(agentCreationRequestTools: AgentCreationRequestTools): string; - -declare function agentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEvent$ { - /** @deprecated use `AgentHandoffDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$Outbound` instead. */ - type Outbound = AgentHandoffDoneEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffDoneEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffDoneEvent = { - type?: AgentHandoffDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffDoneEventFromJSON(jsonString: string): Result; - -declare function agentHandoffDoneEventToJSON(agentHandoffDoneEvent: AgentHandoffDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEventType$ { - /** @deprecated use `AgentHandoffDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; - /** @deprecated use `AgentHandoffDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; -} - -/** @internal */ -declare const AgentHandoffDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffDoneEventType: { - readonly AgentHandoffDone: "agent.handoff.done"; -}; - -declare type AgentHandoffDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntry$ { - /** @deprecated use `AgentHandoffEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$Outbound` instead. */ - type Outbound = AgentHandoffEntry$Outbound; -} - -/** @internal */ -declare const AgentHandoffEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - previous_agent_id: string; - previous_agent_name: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffEntry$outboundSchema: z.ZodType; - -declare type AgentHandoffEntry = { - object?: AgentHandoffEntryObject | undefined; - type?: AgentHandoffEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - previousAgentId: string; - previousAgentName: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryObject$ { - /** @deprecated use `AgentHandoffEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `AgentHandoffEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryObject: { - readonly Entry: "entry"; -}; - -declare type AgentHandoffEntryObject = ClosedEnum; - -declare function agentHandoffEntryToJSON(agentHandoffEntry: AgentHandoffEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryType$ { - /** @deprecated use `AgentHandoffEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; - /** @deprecated use `AgentHandoffEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryType: { - readonly AgentHandoff: "agent.handoff"; -}; - -declare type AgentHandoffEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEvent$ { - /** @deprecated use `AgentHandoffStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$Outbound` instead. */ - type Outbound = AgentHandoffStartedEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - previous_agent_id: string; - previous_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffStartedEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffStartedEvent = { - type?: AgentHandoffStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - previousAgentId: string; - previousAgentName: string; -}; - -declare function agentHandoffStartedEventFromJSON(jsonString: string): Result; - -declare function agentHandoffStartedEventToJSON(agentHandoffStartedEvent: AgentHandoffStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEventType$ { - /** @deprecated use `AgentHandoffStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; - /** @deprecated use `AgentHandoffStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; -} - -/** @internal */ -declare const AgentHandoffStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffStartedEventType: { - readonly AgentHandoffStarted: "agent.handoff.started"; -}; - -declare type AgentHandoffStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentObject$ { - /** @deprecated use `AgentObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; - /** @deprecated use `AgentObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; -} - -/** @internal */ -declare const AgentObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentObject: { - readonly Agent: "agent"; -}; - -declare type AgentObject = ClosedEnum; - -declare class Agents extends ClientSDK { - /** - * Agents Completion - */ - complete(request: components.AgentsCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.AgentsCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsGetRequest$ { - /** @deprecated use `AgentsApiV1AgentsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsGetRequest$Outbound = { - agent_id: string; -}; - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsGetRequest = { - agentId: string; -}; - -declare function agentsApiV1AgentsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest: AgentsApiV1AgentsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsListRequest$ { - /** @deprecated use `AgentsApiV1AgentsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1AgentsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest: AgentsApiV1AgentsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateRequest$Outbound = { - agent_id: string; - AgentUpdateRequest: components.AgentUpdateRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateRequest = { - agentId: string; - agentUpdateRequest: components.AgentUpdateRequest; -}; - -declare function agentsApiV1AgentsUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest: AgentsApiV1AgentsUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateVersionRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateVersionRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateVersionRequest$Outbound = { - agent_id: string; - version: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateVersionRequest = { - agentId: string; - version: number; -}; - -declare function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest: AgentsApiV1AgentsUpdateVersionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendRequest$Outbound = { - conversation_id: string; - ConversationAppendRequest: components.ConversationAppendRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendRequest: components.ConversationAppendRequest; -}; - -declare function agentsApiV1ConversationsAppendRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest: AgentsApiV1ConversationsAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendStreamRequest$Outbound = { - conversation_id: string; - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendStreamRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendStreamRequest: components.ConversationAppendStreamRequest; -}; - -declare function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest: AgentsApiV1ConversationsAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetRequest$ { - /** @deprecated use `AgentsApiV1ConversationsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsGetRequest = { - /** - * ID of the conversation from which we are fetching metadata. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest: AgentsApiV1ConversationsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetResponseV1ConversationsGet$ { - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet = components.ModelConversation | components.AgentConversation; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet: AgentsApiV1ConversationsGetResponseV1ConversationsGet): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsHistoryRequest$ { - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsHistoryRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsHistoryRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsHistoryRequest = { - /** - * ID of the conversation from which we are fetching entries. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest: AgentsApiV1ConversationsHistoryRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsListRequest$ { - /** @deprecated use `AgentsApiV1ConversationsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1ConversationsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest: AgentsApiV1ConversationsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsMessagesRequest$ { - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsMessagesRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsMessagesRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsMessagesRequest = { - /** - * ID of the conversation from which we are fetching messages. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest: AgentsApiV1ConversationsMessagesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartRequest$Outbound = { - conversation_id: string; - ConversationRestartRequest: components.ConversationRestartRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartRequest: components.ConversationRestartRequest; -}; - -declare function agentsApiV1ConversationsRestartRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest: AgentsApiV1ConversationsRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartStreamRequest$Outbound = { - conversation_id: string; - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartStreamRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartStreamRequest: components.ConversationRestartStreamRequest; -}; - -declare function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest: AgentsApiV1ConversationsRestartStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequest$ { - /** @deprecated use `AgentsCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$Outbound` instead. */ - type Outbound = AgentsCompletionRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestMessages$ { - /** @deprecated use `AgentsCompletionRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages: AgentsCompletionRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestStop$ { - /** @deprecated use `AgentsCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionRequestStop = string | Array; - -declare function agentsCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop: AgentsCompletionRequestStop): string; - -declare function agentsCompletionRequestToJSON(agentsCompletionRequest: AgentsCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestToolChoice$ { - /** @deprecated use `AgentsCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice: AgentsCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequest$ { - /** @deprecated use `AgentsCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestMessages$ { - /** @deprecated use `AgentsCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages: AgentsCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestStop$ { - /** @deprecated use `AgentsCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionStreamRequestStop = string | Array; - -declare function agentsCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop: AgentsCompletionStreamRequestStop): string; - -declare function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest: AgentsCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestToolChoice$ { - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice: AgentsCompletionStreamRequestToolChoice): string; - -declare function agentToJSON(agent: Agent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentTools$ { - /** @deprecated use `AgentTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentTools$Outbound` instead. */ - type Outbound = AgentTools$Outbound; -} - -/** @internal */ -declare const AgentTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentTools$outboundSchema: z.ZodType; - -declare type AgentTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentToolsFromJSON(jsonString: string): Result; - -declare function agentToolsToJSON(agentTools: AgentTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequest$ { - /** @deprecated use `AgentUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$Outbound` instead. */ - type Outbound = AgentUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentUpdateRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToJSON(agentUpdateRequest: AgentUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequestTools$ { - /** @deprecated use `AgentUpdateRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$Outbound` instead. */ - type Outbound = AgentUpdateRequestTools$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentUpdateRequestTools$outboundSchema: z.ZodType; - -declare type AgentUpdateRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentUpdateRequestToolsFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToolsToJSON(agentUpdateRequestTools: AgentUpdateRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ApiEndpoint$ { - /** @deprecated use `ApiEndpoint$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ApiEndpoint$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ApiEndpoint$inboundSchema: z.ZodType; - -/** @internal */ -declare const ApiEndpoint$outboundSchema: z.ZodType; - -declare const ApiEndpoint: { - readonly RootV1ChatCompletions: "/v1/chat/completions"; - readonly RootV1Embeddings: "/v1/embeddings"; - readonly RootV1FimCompletions: "/v1/fim/completions"; - readonly RootV1Moderations: "/v1/moderations"; - readonly RootV1ChatModerations: "/v1/chat/moderations"; - readonly RootV1Ocr: "/v1/ocr"; - readonly RootV1Classifications: "/v1/classifications"; - readonly RootV1ChatClassifications: "/v1/chat/classifications"; - readonly RootV1Conversations: "/v1/conversations"; - readonly RootV1AudioTranscriptions: "/v1/audio/transcriptions"; -}; - -declare type ApiEndpoint = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOut$ { - /** @deprecated use `ArchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$Outbound` instead. */ - type Outbound = ArchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const ArchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ArchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const ArchiveFTModelOut$outboundSchema: z.ZodType; - -declare type ArchiveFTModelOut = { - id: string; - object?: ArchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function archiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOutObject$ { - /** @deprecated use `ArchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ArchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ArchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ArchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ArchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ArchiveFTModelOutObject = ClosedEnum; - -declare function archiveFTModelOutToJSON(archiveFTModelOut: ArchiveFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Arguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Arguments$Outbound` instead. */ - type Outbound = Arguments$Outbound; -} - -/** @internal */ -declare const Arguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type Arguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const Arguments$outboundSchema: z.ZodType; - -declare type Arguments = { - [k: string]: any; -} | string; - -declare function argumentsFromJSON(jsonString: string): Result; - -declare function argumentsToJSON(value: Arguments): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - type Outbound = AssistantMessage$Outbound; -} - -/** @internal */ -declare const AssistantMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -declare const AssistantMessage$outboundSchema: z.ZodType; - -declare type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - type Outbound = AssistantMessageContent$Outbound; -} - -/** @internal */ -declare const AssistantMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessageContent$Outbound = string | Array; - -/** @internal */ -declare const AssistantMessageContent$outboundSchema: z.ZodType; - -declare type AssistantMessageContent = string | Array; - -declare function assistantMessageContentFromJSON(jsonString: string): Result; - -declare function assistantMessageContentToJSON(assistantMessageContent: AssistantMessageContent): string; - -declare function assistantMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const AssistantMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AssistantMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const AssistantMessageRole: { - readonly Assistant: "assistant"; -}; - -declare type AssistantMessageRole = ClosedEnum; - -declare function assistantMessageToJSON(assistantMessage: AssistantMessage): string; - -declare class Audio_2 extends ClientSDK { - private _transcriptions?; - get transcriptions(): Transcriptions; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunk$ { - /** @deprecated use `AudioChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$Outbound` instead. */ - type Outbound = AudioChunk$Outbound; -} - -/** @internal */ -declare const AudioChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioChunk$Outbound = { - input_audio: string; - type: string; -}; - -/** @internal */ -declare const AudioChunk$outboundSchema: z.ZodType; - -declare type AudioChunk = { - inputAudio: string; - type?: AudioChunkType | undefined; -}; - -declare function audioChunkFromJSON(jsonString: string): Result; - -declare function audioChunkToJSON(audioChunk: AudioChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunkType$ { - /** @deprecated use `AudioChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; - /** @deprecated use `AudioChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; -} - -/** @internal */ -declare const AudioChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AudioChunkType$outboundSchema: z.ZodNativeEnum; - -declare const AudioChunkType: { - readonly InputAudio: "input_audio"; -}; - -declare type AudioChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequest$ { - /** @deprecated use `AudioTranscriptionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$Outbound` instead. */ - type Outbound = AudioTranscriptionRequest$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequest$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: false; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequest$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequest = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: false | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequestStream$ { - /** @deprecated use `AudioTranscriptionRequestStream$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$Outbound` instead. */ - type Outbound = AudioTranscriptionRequestStream$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequestStream$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequestStream$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: true; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequestStream$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequestStream = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: true | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestStreamFromJSON(jsonString: string): Result; - -declare function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream: AudioTranscriptionRequestStream): string; - -declare function audioTranscriptionRequestToJSON(audioTranscriptionRequest: AudioTranscriptionRequest): string; - -declare type Awaitable = T | Promise; - -declare type Awaitable_2 = T | Promise; - -declare type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCard$ { - /** @deprecated use `BaseModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$Outbound` instead. */ - type Outbound = BaseModelCard$Outbound; -} - -/** @internal */ -declare const BaseModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type BaseModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "base"; -}; - -/** @internal */ -declare const BaseModelCard$outboundSchema: z.ZodType; - -declare type BaseModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "base" | undefined; -}; - -declare function baseModelCardFromJSON(jsonString: string): Result; - -declare function baseModelCardToJSON(baseModelCard: BaseModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCardType$ { - /** @deprecated use `BaseModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; - /** @deprecated use `BaseModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; -} - -/** @internal */ -declare const BaseModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BaseModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const BaseModelCardType: { - readonly Base: "base"; -}; - -declare type BaseModelCardType = ClosedEnum; - -declare class Batch extends ClientSDK { - private _jobs?; - get jobs(): MistralJobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchError$ { - /** @deprecated use `BatchError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchError$Outbound` instead. */ - type Outbound = BatchError$Outbound; -} - -/** @internal */ -declare const BatchError$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchError$Outbound = { - message: string; - count: number; -}; - -/** @internal */ -declare const BatchError$outboundSchema: z.ZodType; - -declare type BatchError = { - message: string; - count?: number | undefined; -}; - -declare function batchErrorFromJSON(jsonString: string): Result; - -declare function batchErrorToJSON(batchError: BatchError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobIn$ { - /** @deprecated use `BatchJobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$Outbound` instead. */ - type Outbound = BatchJobIn$Outbound; -} - -/** @internal */ -declare const BatchJobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobIn$Outbound = { - input_files: Array; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeout_hours: number; -}; - -/** @internal */ -declare const BatchJobIn$outboundSchema: z.ZodType; - -declare type BatchJobIn = { - inputFiles: Array; - endpoint: ApiEndpoint; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeoutHours?: number | undefined; -}; - -declare function batchJobInFromJSON(jsonString: string): Result; - -declare function batchJobInToJSON(batchJobIn: BatchJobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOut$ { - /** @deprecated use `BatchJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$Outbound` instead. */ - type Outbound = BatchJobOut$Outbound; -} - -/** @internal */ -declare const BatchJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobOut$Outbound = { - id: string; - object: string; - input_files: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - output_file?: string | null | undefined; - error_file?: string | null | undefined; - errors: Array; - status: string; - created_at: number; - total_requests: number; - completed_requests: number; - succeeded_requests: number; - failed_requests: number; - started_at?: number | null | undefined; - completed_at?: number | null | undefined; -}; - -/** @internal */ -declare const BatchJobOut$outboundSchema: z.ZodType; - -declare type BatchJobOut = { - id: string; - object?: BatchJobOutObject | undefined; - inputFiles: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agentId?: string | null | undefined; - outputFile?: string | null | undefined; - errorFile?: string | null | undefined; - errors: Array; - status: BatchJobStatus; - createdAt: number; - totalRequests: number; - completedRequests: number; - succeededRequests: number; - failedRequests: number; - startedAt?: number | null | undefined; - completedAt?: number | null | undefined; -}; - -declare function batchJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOutObject$ { - /** @deprecated use `BatchJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; - /** @deprecated use `BatchJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; -} - -/** @internal */ -declare const BatchJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobOutObject: { - readonly Batch: "batch"; -}; - -declare type BatchJobOutObject = ClosedEnum; - -declare function batchJobOutToJSON(batchJobOut: BatchJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOut$ { - /** @deprecated use `BatchJobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$Outbound` instead. */ - type Outbound = BatchJobsOut$Outbound; -} - -/** @internal */ -declare const BatchJobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobsOut$Outbound = { - data?: Array | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const BatchJobsOut$outboundSchema: z.ZodType; - -declare type BatchJobsOut = { - data?: Array | undefined; - object?: BatchJobsOutObject | undefined; - total: number; -}; - -declare function batchJobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOutObject$ { - /** @deprecated use `BatchJobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `BatchJobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const BatchJobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobsOutObject: { - readonly List: "list"; -}; - -declare type BatchJobsOutObject = ClosedEnum; - -declare function batchJobsOutToJSON(batchJobsOut: BatchJobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobStatus$ { - /** @deprecated use `BatchJobStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; - /** @deprecated use `BatchJobStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; -} - -/** @internal */ -declare const BatchJobStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobStatus$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobStatus: { - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; -}; - -declare type BatchJobStatus = ClosedEnum; - -declare type BeforeCreateRequestContext = HookContext & {}; - -declare interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput; -} - -declare type BeforeRequestContext = HookContext & {}; - -declare type BeforeRequestHook = (req: Request) => Awaitable; - -declare interface BeforeRequestHook_2 { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable_2; -} - -declare class Beta extends ClientSDK { - private _conversations?; - get conversations(): Conversations; - private _agents?; - get agents(): MistralAgents; - private _libraries?; - get libraries(): Libraries; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BuiltInConnectors$ { - /** @deprecated use `BuiltInConnectors$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `BuiltInConnectors$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const BuiltInConnectors$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BuiltInConnectors$outboundSchema: z.ZodNativeEnum; - -declare const BuiltInConnectors: { - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; -}; - -declare type BuiltInConnectors = ClosedEnum; - -declare class Chat extends ClientSDK { - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - parse(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - parseStream(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Chat Completion - */ - complete(request: components.ChatCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.ChatCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatClassificationRequest$ { - /** @deprecated use `ChatClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$Outbound` instead. */ - type Outbound = ChatClassificationRequest$Outbound; -} - -/** @internal */ -declare const ChatClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatClassificationRequest$Outbound = { - model: string; - input: Inputs$Outbound; -}; - -/** @internal */ -declare const ChatClassificationRequest$outboundSchema: z.ZodType; - -declare type ChatClassificationRequest = { - model: string; - /** - * Chat to classify - */ - inputs: Inputs; -}; - -declare function chatClassificationRequestFromJSON(jsonString: string): Result; - -declare function chatClassificationRequestToJSON(chatClassificationRequest: ChatClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - type Outbound = ChatCompletionChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -declare const ChatCompletionChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: FinishReason; -}; - -declare function chatCompletionChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionChoiceToJSON(chatCompletionChoice: ChatCompletionChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - type Outbound = ChatCompletionRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionRequestFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToJSON(chatCompletionRequest: ChatCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - type Outbound = ChatCompletionResponse$Outbound; -} - -/** @internal */ -declare const ChatCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const ChatCompletionResponse$outboundSchema: z.ZodType; - -declare type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function chatCompletionResponseFromJSON(jsonString: string): Result; - -declare function chatCompletionResponseToJSON(chatCompletionResponse: ChatCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestMessages$ { - /** @deprecated use `ChatCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function chatCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages: ChatCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestStop$ { - /** @deprecated use `ChatCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const ChatCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type ChatCompletionStreamRequestStop = string | Array; - -declare function chatCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop: ChatCompletionStreamRequestStop): string; - -declare function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest: ChatCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequest$ { - /** @deprecated use `ChatModerationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$Outbound` instead. */ - type Outbound = ChatModerationRequest$Outbound; -} - -/** @internal */ -declare const ChatModerationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequest$Outbound = { - input: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })> | Array>; - model: string; -}; - -/** @internal */ -declare const ChatModerationRequest$outboundSchema: z.ZodType; - -declare type ChatModerationRequest = { - /** - * Chat to classify - */ - inputs: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })> | Array>; - model: string; -}; - -declare function chatModerationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequestInputs$ { - /** @deprecated use `ChatModerationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$Outbound` instead. */ - type Outbound = ChatModerationRequestInputs$Outbound; -} - -/** @internal */ -declare const ChatModerationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequestInputs$Outbound = Array<(SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -})> | Array>; - -/** @internal */ -declare const ChatModerationRequestInputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type ChatModerationRequestInputs = Array<(SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -})> | Array>; - -declare function chatModerationRequestInputsFromJSON(jsonString: string): Result; - -declare function chatModerationRequestInputsToJSON(chatModerationRequestInputs: ChatModerationRequestInputs): string; - -declare function chatModerationRequestToJSON(chatModerationRequest: ChatModerationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CheckpointOut$ { - /** @deprecated use `CheckpointOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$Outbound` instead. */ - type Outbound = CheckpointOut$Outbound; -} - -/** @internal */ -declare const CheckpointOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CheckpointOut$Outbound = { - metrics: MetricOut$Outbound; - step_number: number; - created_at: number; -}; - -/** @internal */ -declare const CheckpointOut$outboundSchema: z.ZodType; - -declare type CheckpointOut = { - /** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ - metrics: MetricOut; - /** - * The step number that the checkpoint was created at. - */ - stepNumber: number; - /** - * The UNIX timestamp (in seconds) for when the checkpoint was created. - */ - createdAt: number; -}; - -declare function checkpointOutFromJSON(jsonString: string): Result; - -declare function checkpointOutToJSON(checkpointOut: CheckpointOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequest$ { - /** @deprecated use `ClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$Outbound` instead. */ - type Outbound = ClassificationRequest$Outbound; -} - -/** @internal */ -declare const ClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequest$Outbound = { - model: string; - input: string | Array; -}; - -/** @internal */ -declare const ClassificationRequest$outboundSchema: z.ZodType; - -declare type ClassificationRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to classify. - */ - inputs: string | Array; -}; - -declare function classificationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequestInputs$ { - /** @deprecated use `ClassificationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$Outbound` instead. */ - type Outbound = ClassificationRequestInputs$Outbound; -} - -/** @internal */ -declare const ClassificationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const ClassificationRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to classify. - */ -declare type ClassificationRequestInputs = string | Array; - -declare function classificationRequestInputsFromJSON(jsonString: string): Result; - -declare function classificationRequestInputsToJSON(classificationRequestInputs: ClassificationRequestInputs): string; - -declare function classificationRequestToJSON(classificationRequest: ClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationResponse$ { - /** @deprecated use `ClassificationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$Outbound` instead. */ - type Outbound = ClassificationResponse$Outbound; -} - -/** @internal */ -declare const ClassificationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationResponse$Outbound = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult$Outbound; - }>; -}; - -/** @internal */ -declare const ClassificationResponse$outboundSchema: z.ZodType; - -declare type ClassificationResponse = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult; - }>; -}; - -declare function classificationResponseFromJSON(jsonString: string): Result; - -declare function classificationResponseToJSON(classificationResponse: ClassificationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationTargetResult$ { - /** @deprecated use `ClassificationTargetResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$Outbound` instead. */ - type Outbound = ClassificationTargetResult$Outbound; -} - -/** @internal */ -declare const ClassificationTargetResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationTargetResult$Outbound = { - scores: { - [k: string]: number; - }; -}; - -/** @internal */ -declare const ClassificationTargetResult$outboundSchema: z.ZodType; - -declare type ClassificationTargetResult = { - scores: { - [k: string]: number; - }; -}; - -declare function classificationTargetResultFromJSON(jsonString: string): Result; - -declare function classificationTargetResultToJSON(classificationTargetResult: ClassificationTargetResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOut$ { - /** @deprecated use `ClassifierDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; - events?: Array | undefined; - checkpoints?: Array | undefined; - classifier_targets: Array; -}; - -/** @internal */ -declare const ClassifierDetailedJobOut$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: ClassifierDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: ClassifierDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: ClassifierDetailedJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; - classifierTargets: Array; -}; - -declare function classifierDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutIntegrations$ { - /** @deprecated use `ClassifierDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function classifierDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations: ClassifierDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutJobType$ { - /** @deprecated use `ClassifierDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutJobType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutObject$ { - /** @deprecated use `ClassifierDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type ClassifierDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutStatus$ { - /** @deprecated use `ClassifierDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type ClassifierDetailedJobOutStatus = ClosedEnum; - -declare function classifierDetailedJobOutToJSON(classifierDetailedJobOut: ClassifierDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOut$ { - /** @deprecated use `ClassifierFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$Outbound` instead. */ - type Outbound = ClassifierFTModelOut$Outbound; -} - -/** @internal */ -declare const ClassifierFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - classifier_targets: Array; - model_type: string; -}; - -/** @internal */ -declare const ClassifierFTModelOut$outboundSchema: z.ZodType; - -declare type ClassifierFTModelOut = { - id: string; - object?: ClassifierFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - classifierTargets: Array; - modelType?: ClassifierFTModelOutModelType | undefined; -}; - -declare function classifierFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutModelType$ { - /** @deprecated use `ClassifierFTModelOutModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierFTModelOutModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutModelType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutModelType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierFTModelOutModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutObject$ { - /** @deprecated use `ClassifierFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ClassifierFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ClassifierFTModelOutObject = ClosedEnum; - -declare function classifierFTModelOutToJSON(classifierFTModelOut: ClassifierFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOut$ { - /** @deprecated use `ClassifierJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$Outbound` instead. */ - type Outbound = ClassifierJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; -}; - -/** @internal */ -declare const ClassifierJobOut$outboundSchema: z.ZodType; - -declare type ClassifierJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: ClassifierJobOutStatus; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: ClassifierJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: ClassifierJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; -}; - -declare function classifierJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutIntegrations$ { - /** @deprecated use `ClassifierJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierJobOutIntegrations = WandbIntegrationOut; - -declare function classifierJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations: ClassifierJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutJobType$ { - /** @deprecated use `ClassifierJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutJobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const ClassifierJobOutJobType: { - readonly Classifier: "classifier"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type ClassifierJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutObject$ { - /** @deprecated use `ClassifierJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const ClassifierJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type ClassifierJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutStatus$ { - /** @deprecated use `ClassifierJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const ClassifierJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type ClassifierJobOutStatus = ClosedEnum; - -declare function classifierJobOutToJSON(classifierJobOut: ClassifierJobOut): string; - -declare class Classifiers extends ClientSDK { - /** - * Moderations - */ - moderate(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Moderations - */ - moderateChat(request: components.ChatModerationRequest, options?: RequestOptions): Promise; - /** - * Classifications - */ - classify(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Classifications - */ - classifyChat(request: components.ChatClassificationRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetIn$ { - /** @deprecated use `ClassifierTargetIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$Outbound` instead. */ - type Outbound = ClassifierTargetIn$Outbound; -} - -/** @internal */ -declare const ClassifierTargetIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetIn$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function?: string | null | undefined; -}; - -/** @internal */ -declare const ClassifierTargetIn$outboundSchema: z.ZodType; - -declare type ClassifierTargetIn = { - name: string; - labels: Array; - weight?: number | undefined; - lossFunction?: FTClassifierLossFunction | null | undefined; -}; - -declare function classifierTargetInFromJSON(jsonString: string): Result; - -declare function classifierTargetInToJSON(classifierTargetIn: ClassifierTargetIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetOut$ { - /** @deprecated use `ClassifierTargetOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$Outbound` instead. */ - type Outbound = ClassifierTargetOut$Outbound; -} - -/** @internal */ -declare const ClassifierTargetOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetOut$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function: string; -}; - -/** @internal */ -declare const ClassifierTargetOut$outboundSchema: z.ZodType; - -declare type ClassifierTargetOut = { - name: string; - labels: Array; - weight: number; - lossFunction: FTClassifierLossFunction; -}; - -declare function classifierTargetOutFromJSON(jsonString: string): Result; - -declare function classifierTargetOutToJSON(classifierTargetOut: ClassifierTargetOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParameters$ { - /** @deprecated use `ClassifierTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$Outbound` instead. */ - type Outbound = ClassifierTrainingParameters$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParameters$outboundSchema: z.ZodType; - -declare type ClassifierTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParametersIn$ { - /** @deprecated use `ClassifierTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$Outbound` instead. */ - type Outbound = ClassifierTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a classifier fine-tune job. - */ -declare type ClassifierTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersInFromJSON(jsonString: string): Result; - -declare function classifierTrainingParametersInToJSON(classifierTrainingParametersIn: ClassifierTrainingParametersIn): string; - -declare function classifierTrainingParametersToJSON(classifierTrainingParameters: ClassifierTrainingParameters): string; - -declare class ClientSDK { - #private; - readonly _baseURL: URL | null; - readonly _options: SDKOptions & { - hooks?: SDKHooks; - }; - constructor(options?: SDKOptions); - _createRequest(context: HookContext, conf: RequestConfig, options?: RequestOptions): Result; - _do(request: Request, options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }): Promise>; -} - -declare type ClosedEnum = T[keyof T]; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterTool$ { - /** @deprecated use `CodeInterpreterTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$Outbound` instead. */ - type Outbound = CodeInterpreterTool$Outbound; -} - -/** @internal */ -declare const CodeInterpreterTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type CodeInterpreterTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const CodeInterpreterTool$outboundSchema: z.ZodType; - -declare type CodeInterpreterTool = { - type?: CodeInterpreterToolType | undefined; -}; - -declare function codeInterpreterToolFromJSON(jsonString: string): Result; - -declare function codeInterpreterToolToJSON(codeInterpreterTool: CodeInterpreterTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterToolType$ { - /** @deprecated use `CodeInterpreterToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; - /** @deprecated use `CodeInterpreterToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; -} - -/** @internal */ -declare const CodeInterpreterToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CodeInterpreterToolType$outboundSchema: z.ZodNativeEnum; - -declare const CodeInterpreterToolType: { - readonly CodeInterpreter: "code_interpreter"; -}; - -declare type CodeInterpreterToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgs$ { - /** @deprecated use `CompletionArgs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$Outbound` instead. */ - type Outbound = CompletionArgs$Outbound; -} - -/** @internal */ -declare const CompletionArgs$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgs$Outbound = { - stop?: CompletionArgsStop$Outbound | null | undefined; - presence_penalty?: number | null | undefined; - frequency_penalty?: number | null | undefined; - temperature?: number | null | undefined; - top_p?: number | null | undefined; - max_tokens?: number | null | undefined; - random_seed?: number | null | undefined; - prediction?: Prediction$Outbound | null | undefined; - response_format?: ResponseFormat$Outbound | null | undefined; - tool_choice?: string | undefined; -}; - -/** @internal */ -declare const CompletionArgs$outboundSchema: z.ZodType; - -/** - * White-listed arguments from the completion API - */ -declare type CompletionArgs = { - stop?: CompletionArgsStop | null | undefined; - presencePenalty?: number | null | undefined; - frequencyPenalty?: number | null | undefined; - temperature?: number | null | undefined; - topP?: number | null | undefined; - maxTokens?: number | null | undefined; - randomSeed?: number | null | undefined; - prediction?: Prediction | null | undefined; - responseFormat?: ResponseFormat | null | undefined; - toolChoice?: ToolChoiceEnum | undefined; -}; - -declare function completionArgsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgsStop$ { - /** @deprecated use `CompletionArgsStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$Outbound` instead. */ - type Outbound = CompletionArgsStop$Outbound; -} - -/** @internal */ -declare const CompletionArgsStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgsStop$Outbound = string | Array; - -/** @internal */ -declare const CompletionArgsStop$outboundSchema: z.ZodType; - -declare type CompletionArgsStop = string | Array; - -declare function completionArgsStopFromJSON(jsonString: string): Result; - -declare function completionArgsStopToJSON(completionArgsStop: CompletionArgsStop): string; - -declare function completionArgsToJSON(completionArgs: CompletionArgs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - type Outbound = CompletionChunk$Outbound; -} - -/** @internal */ -declare const CompletionChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -declare const CompletionChunk$outboundSchema: z.ZodType; - -declare type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -declare function completionChunkFromJSON(jsonString: string): Result; - -declare function completionChunkToJSON(completionChunk: CompletionChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOut$ { - /** @deprecated use `CompletionDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$Outbound` instead. */ - type Outbound = CompletionDetailedJobOut$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -/** @internal */ -declare const CompletionDetailedJobOut$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: CompletionDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: CompletionDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: CompletionDetailedJobOutJobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -declare function completionDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutIntegrations$ { - /** @deprecated use `CompletionDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function completionDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations: CompletionDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutJobType$ { - /** @deprecated use `CompletionDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `CompletionDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutJobType: { - readonly Completion: "completion"; -}; - -declare type CompletionDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutObject$ { - /** @deprecated use `CompletionDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type CompletionDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutRepositories$ { - /** @deprecated use `CompletionDetailedJobOutRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutRepositories$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutRepositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutRepositories = GithubRepositoryOut; - -declare function completionDetailedJobOutRepositoriesFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories: CompletionDetailedJobOutRepositories): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutStatus$ { - /** @deprecated use `CompletionDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `CompletionDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type CompletionDetailedJobOutStatus = ClosedEnum; - -declare function completionDetailedJobOutToJSON(completionDetailedJobOut: CompletionDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - type Outbound = CompletionEvent$Outbound; -} - -/** @internal */ -declare const CompletionEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -declare const CompletionEvent$outboundSchema: z.ZodType; - -declare type CompletionEvent = { - data: CompletionChunk; -}; - -declare function completionEventFromJSON(jsonString: string): Result; - -declare function completionEventToJSON(completionEvent: CompletionEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOut$ { - /** @deprecated use `CompletionFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$Outbound` instead. */ - type Outbound = CompletionFTModelOut$Outbound; -} - -/** @internal */ -declare const CompletionFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - model_type: string; -}; - -/** @internal */ -declare const CompletionFTModelOut$outboundSchema: z.ZodType; - -declare type CompletionFTModelOut = { - id: string; - object?: CompletionFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - modelType?: ModelType | undefined; -}; - -declare function completionFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOutObject$ { - /** @deprecated use `CompletionFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `CompletionFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const CompletionFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionFTModelOutObject: { - readonly Model: "model"; -}; - -declare type CompletionFTModelOutObject = ClosedEnum; - -declare function completionFTModelOutToJSON(completionFTModelOut: CompletionFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOut$ { - /** @deprecated use `CompletionJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$Outbound` instead. */ - type Outbound = CompletionJobOut$Outbound; -} - -/** @internal */ -declare const CompletionJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; -}; - -/** @internal */ -declare const CompletionJobOut$outboundSchema: z.ZodType; - -declare type CompletionJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: Status; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: CompletionJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: JobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; -}; - -declare function completionJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOutObject$ { - /** @deprecated use `CompletionJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const CompletionJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type CompletionJobOutObject = ClosedEnum; - -declare function completionJobOutToJSON(completionJobOut: CompletionJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - type Outbound = CompletionResponseStreamChoice$Outbound; -} - -/** @internal */ -declare const CompletionResponseStreamChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -declare const CompletionResponseStreamChoice$outboundSchema: z.ZodType; - -declare type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: CompletionResponseStreamChoiceFinishReason | null; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoiceFinishReason$ { - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$outboundSchema: z.ZodType; - -declare const CompletionResponseStreamChoiceFinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type CompletionResponseStreamChoiceFinishReason = OpenEnum; - -declare function completionResponseStreamChoiceFromJSON(jsonString: string): Result; - -declare function completionResponseStreamChoiceToJSON(completionResponseStreamChoice: CompletionResponseStreamChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParameters$ { - /** @deprecated use `CompletionTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$Outbound` instead. */ - type Outbound = CompletionTrainingParameters$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParameters$outboundSchema: z.ZodType; - -declare type CompletionTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParametersIn$ { - /** @deprecated use `CompletionTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$Outbound` instead. */ - type Outbound = CompletionTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a fine-tune job. - */ -declare type CompletionTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersInFromJSON(jsonString: string): Result; - -declare function completionTrainingParametersInToJSON(completionTrainingParametersIn: CompletionTrainingParametersIn): string; - -declare function completionTrainingParametersToJSON(completionTrainingParameters: CompletionTrainingParameters): string; - -declare namespace components { - export { - agentToolsToJSON, - agentToolsFromJSON, - agentToJSON, - agentFromJSON, - AgentTools, - AgentObject, - Agent, - AgentTools$inboundSchema, - AgentTools$Outbound, - AgentTools$outboundSchema, - AgentTools$, - AgentObject$inboundSchema, - AgentObject$outboundSchema, - AgentObject$, - Agent$inboundSchema, - Agent$Outbound, - Agent$outboundSchema, - Agent$, - agentConversationToJSON, - agentConversationFromJSON, - AgentConversationObject, - AgentConversation, - AgentConversationObject$inboundSchema, - AgentConversationObject$outboundSchema, - AgentConversationObject$, - AgentConversation$inboundSchema, - AgentConversation$Outbound, - AgentConversation$outboundSchema, - AgentConversation$, - agentCreationRequestToolsToJSON, - agentCreationRequestToolsFromJSON, - agentCreationRequestToJSON, - agentCreationRequestFromJSON, - AgentCreationRequestTools, - AgentCreationRequest, - AgentCreationRequestTools$inboundSchema, - AgentCreationRequestTools$Outbound, - AgentCreationRequestTools$outboundSchema, - AgentCreationRequestTools$, - AgentCreationRequest$inboundSchema, - AgentCreationRequest$Outbound, - AgentCreationRequest$outboundSchema, - AgentCreationRequest$, - agentHandoffDoneEventToJSON, - agentHandoffDoneEventFromJSON, - AgentHandoffDoneEventType, - AgentHandoffDoneEvent, - AgentHandoffDoneEventType$inboundSchema, - AgentHandoffDoneEventType$outboundSchema, - AgentHandoffDoneEventType$, - AgentHandoffDoneEvent$inboundSchema, - AgentHandoffDoneEvent$Outbound, - AgentHandoffDoneEvent$outboundSchema, - AgentHandoffDoneEvent$, - agentHandoffEntryToJSON, - agentHandoffEntryFromJSON, - AgentHandoffEntryObject, - AgentHandoffEntryType, - AgentHandoffEntry, - AgentHandoffEntryObject$inboundSchema, - AgentHandoffEntryObject$outboundSchema, - AgentHandoffEntryObject$, - AgentHandoffEntryType$inboundSchema, - AgentHandoffEntryType$outboundSchema, - AgentHandoffEntryType$, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, - AgentHandoffEntry$, - agentHandoffStartedEventToJSON, - agentHandoffStartedEventFromJSON, - AgentHandoffStartedEventType, - AgentHandoffStartedEvent, - AgentHandoffStartedEventType$inboundSchema, - AgentHandoffStartedEventType$outboundSchema, - AgentHandoffStartedEventType$, - AgentHandoffStartedEvent$inboundSchema, - AgentHandoffStartedEvent$Outbound, - AgentHandoffStartedEvent$outboundSchema, - AgentHandoffStartedEvent$, - agentsCompletionRequestStopToJSON, - agentsCompletionRequestStopFromJSON, - agentsCompletionRequestMessagesToJSON, - agentsCompletionRequestMessagesFromJSON, - agentsCompletionRequestToolChoiceToJSON, - agentsCompletionRequestToolChoiceFromJSON, - agentsCompletionRequestToJSON, - agentsCompletionRequestFromJSON, - AgentsCompletionRequestStop, - AgentsCompletionRequestMessages, - AgentsCompletionRequestToolChoice, - AgentsCompletionRequest, - AgentsCompletionRequestStop$inboundSchema, - AgentsCompletionRequestStop$Outbound, - AgentsCompletionRequestStop$outboundSchema, - AgentsCompletionRequestStop$, - AgentsCompletionRequestMessages$inboundSchema, - AgentsCompletionRequestMessages$Outbound, - AgentsCompletionRequestMessages$outboundSchema, - AgentsCompletionRequestMessages$, - AgentsCompletionRequestToolChoice$inboundSchema, - AgentsCompletionRequestToolChoice$Outbound, - AgentsCompletionRequestToolChoice$outboundSchema, - AgentsCompletionRequestToolChoice$, - AgentsCompletionRequest$inboundSchema, - AgentsCompletionRequest$Outbound, - AgentsCompletionRequest$outboundSchema, - AgentsCompletionRequest$, - agentsCompletionStreamRequestStopToJSON, - agentsCompletionStreamRequestStopFromJSON, - agentsCompletionStreamRequestMessagesToJSON, - agentsCompletionStreamRequestMessagesFromJSON, - agentsCompletionStreamRequestToolChoiceToJSON, - agentsCompletionStreamRequestToolChoiceFromJSON, - agentsCompletionStreamRequestToJSON, - agentsCompletionStreamRequestFromJSON, - AgentsCompletionStreamRequestStop, - AgentsCompletionStreamRequestMessages, - AgentsCompletionStreamRequestToolChoice, - AgentsCompletionStreamRequest, - AgentsCompletionStreamRequestStop$inboundSchema, - AgentsCompletionStreamRequestStop$Outbound, - AgentsCompletionStreamRequestStop$outboundSchema, - AgentsCompletionStreamRequestStop$, - AgentsCompletionStreamRequestMessages$inboundSchema, - AgentsCompletionStreamRequestMessages$Outbound, - AgentsCompletionStreamRequestMessages$outboundSchema, - AgentsCompletionStreamRequestMessages$, - AgentsCompletionStreamRequestToolChoice$inboundSchema, - AgentsCompletionStreamRequestToolChoice$Outbound, - AgentsCompletionStreamRequestToolChoice$outboundSchema, - AgentsCompletionStreamRequestToolChoice$, - AgentsCompletionStreamRequest$inboundSchema, - AgentsCompletionStreamRequest$Outbound, - AgentsCompletionStreamRequest$outboundSchema, - AgentsCompletionStreamRequest$, - agentUpdateRequestToolsToJSON, - agentUpdateRequestToolsFromJSON, - agentUpdateRequestToJSON, - agentUpdateRequestFromJSON, - AgentUpdateRequestTools, - AgentUpdateRequest, - AgentUpdateRequestTools$inboundSchema, - AgentUpdateRequestTools$Outbound, - AgentUpdateRequestTools$outboundSchema, - AgentUpdateRequestTools$, - AgentUpdateRequest$inboundSchema, - AgentUpdateRequest$Outbound, - AgentUpdateRequest$outboundSchema, - AgentUpdateRequest$, - ApiEndpoint, - ApiEndpoint$inboundSchema, - ApiEndpoint$outboundSchema, - ApiEndpoint$, - archiveFTModelOutToJSON, - archiveFTModelOutFromJSON, - ArchiveFTModelOutObject, - ArchiveFTModelOut, - ArchiveFTModelOutObject$inboundSchema, - ArchiveFTModelOutObject$outboundSchema, - ArchiveFTModelOutObject$, - ArchiveFTModelOut$inboundSchema, - ArchiveFTModelOut$Outbound, - ArchiveFTModelOut$outboundSchema, - ArchiveFTModelOut$, - assistantMessageContentToJSON, - assistantMessageContentFromJSON, - assistantMessageToJSON, - assistantMessageFromJSON, - AssistantMessageContent, - AssistantMessageRole, - AssistantMessage, - AssistantMessageContent$inboundSchema, - AssistantMessageContent$Outbound, - AssistantMessageContent$outboundSchema, - AssistantMessageContent$, - AssistantMessageRole$inboundSchema, - AssistantMessageRole$outboundSchema, - AssistantMessageRole$, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, - AssistantMessage$, - audioChunkToJSON, - audioChunkFromJSON, - AudioChunkType, - AudioChunk, - AudioChunkType$inboundSchema, - AudioChunkType$outboundSchema, - AudioChunkType$, - AudioChunk$inboundSchema, - AudioChunk$Outbound, - AudioChunk$outboundSchema, - AudioChunk$, - audioTranscriptionRequestToJSON, - audioTranscriptionRequestFromJSON, - AudioTranscriptionRequest, - AudioTranscriptionRequest$inboundSchema, - AudioTranscriptionRequest$Outbound, - AudioTranscriptionRequest$outboundSchema, - AudioTranscriptionRequest$, - audioTranscriptionRequestStreamToJSON, - audioTranscriptionRequestStreamFromJSON, - AudioTranscriptionRequestStream, - AudioTranscriptionRequestStream$inboundSchema, - AudioTranscriptionRequestStream$Outbound, - AudioTranscriptionRequestStream$outboundSchema, - AudioTranscriptionRequestStream$, - baseModelCardToJSON, - baseModelCardFromJSON, - BaseModelCardType, - BaseModelCard, - BaseModelCardType$inboundSchema, - BaseModelCardType$outboundSchema, - BaseModelCardType$, - BaseModelCard$inboundSchema, - BaseModelCard$Outbound, - BaseModelCard$outboundSchema, - BaseModelCard$, - batchErrorToJSON, - batchErrorFromJSON, - BatchError, - BatchError$inboundSchema, - BatchError$Outbound, - BatchError$outboundSchema, - BatchError$, - batchJobInToJSON, - batchJobInFromJSON, - BatchJobIn, - BatchJobIn$inboundSchema, - BatchJobIn$Outbound, - BatchJobIn$outboundSchema, - BatchJobIn$, - batchJobOutToJSON, - batchJobOutFromJSON, - BatchJobOutObject, - BatchJobOut, - BatchJobOutObject$inboundSchema, - BatchJobOutObject$outboundSchema, - BatchJobOutObject$, - BatchJobOut$inboundSchema, - BatchJobOut$Outbound, - BatchJobOut$outboundSchema, - BatchJobOut$, - batchJobsOutToJSON, - batchJobsOutFromJSON, - BatchJobsOutObject, - BatchJobsOut, - BatchJobsOutObject$inboundSchema, - BatchJobsOutObject$outboundSchema, - BatchJobsOutObject$, - BatchJobsOut$inboundSchema, - BatchJobsOut$Outbound, - BatchJobsOut$outboundSchema, - BatchJobsOut$, - BatchJobStatus, - BatchJobStatus$inboundSchema, - BatchJobStatus$outboundSchema, - BatchJobStatus$, - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, - BuiltInConnectors$, - chatClassificationRequestToJSON, - chatClassificationRequestFromJSON, - ChatClassificationRequest, - ChatClassificationRequest$inboundSchema, - ChatClassificationRequest$Outbound, - ChatClassificationRequest$outboundSchema, - ChatClassificationRequest$, - chatCompletionChoiceToJSON, - chatCompletionChoiceFromJSON, - FinishReason, - ChatCompletionChoice, - FinishReason$inboundSchema, - FinishReason$outboundSchema, - FinishReason$, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, - ChatCompletionChoice$, - stopToJSON, - stopFromJSON, - messagesToJSON, - messagesFromJSON, - chatCompletionRequestToolChoiceToJSON, - chatCompletionRequestToolChoiceFromJSON, - chatCompletionRequestToJSON, - chatCompletionRequestFromJSON, - Stop, - Messages, - ChatCompletionRequestToolChoice, - ChatCompletionRequest, - Stop$inboundSchema, - Stop$Outbound, - Stop$outboundSchema, - Stop$, - Messages$inboundSchema, - Messages$Outbound, - Messages$outboundSchema, - Messages$, - ChatCompletionRequestToolChoice$inboundSchema, - ChatCompletionRequestToolChoice$Outbound, - ChatCompletionRequestToolChoice$outboundSchema, - ChatCompletionRequestToolChoice$, - ChatCompletionRequest$inboundSchema, - ChatCompletionRequest$Outbound, - ChatCompletionRequest$outboundSchema, - ChatCompletionRequest$, - chatCompletionResponseToJSON, - chatCompletionResponseFromJSON, - ChatCompletionResponse, - ChatCompletionResponse$inboundSchema, - ChatCompletionResponse$Outbound, - ChatCompletionResponse$outboundSchema, - ChatCompletionResponse$, - chatCompletionStreamRequestStopToJSON, - chatCompletionStreamRequestStopFromJSON, - chatCompletionStreamRequestMessagesToJSON, - chatCompletionStreamRequestMessagesFromJSON, - chatCompletionStreamRequestToolChoiceToJSON, - chatCompletionStreamRequestToolChoiceFromJSON, - chatCompletionStreamRequestToJSON, - chatCompletionStreamRequestFromJSON, - ChatCompletionStreamRequestStop, - ChatCompletionStreamRequestMessages, - ChatCompletionStreamRequestToolChoice, - ChatCompletionStreamRequest, - ChatCompletionStreamRequestStop$inboundSchema, - ChatCompletionStreamRequestStop$Outbound, - ChatCompletionStreamRequestStop$outboundSchema, - ChatCompletionStreamRequestStop$, - ChatCompletionStreamRequestMessages$inboundSchema, - ChatCompletionStreamRequestMessages$Outbound, - ChatCompletionStreamRequestMessages$outboundSchema, - ChatCompletionStreamRequestMessages$, - ChatCompletionStreamRequestToolChoice$inboundSchema, - ChatCompletionStreamRequestToolChoice$Outbound, - ChatCompletionStreamRequestToolChoice$outboundSchema, - ChatCompletionStreamRequestToolChoice$, - ChatCompletionStreamRequest$inboundSchema, - ChatCompletionStreamRequest$Outbound, - ChatCompletionStreamRequest$outboundSchema, - ChatCompletionStreamRequest$, - twoToJSON, - twoFromJSON, - oneToJSON, - oneFromJSON, - chatModerationRequestInputsToJSON, - chatModerationRequestInputsFromJSON, - chatModerationRequestToJSON, - chatModerationRequestFromJSON, - Two, - One, - ChatModerationRequestInputs, - ChatModerationRequest, - Two$inboundSchema, - Two$Outbound, - Two$outboundSchema, - Two$, - One$inboundSchema, - One$Outbound, - One$outboundSchema, - One$, - ChatModerationRequestInputs$inboundSchema, - ChatModerationRequestInputs$Outbound, - ChatModerationRequestInputs$outboundSchema, - ChatModerationRequestInputs$, - ChatModerationRequest$inboundSchema, - ChatModerationRequest$Outbound, - ChatModerationRequest$outboundSchema, - ChatModerationRequest$, - checkpointOutToJSON, - checkpointOutFromJSON, - CheckpointOut, - CheckpointOut$inboundSchema, - CheckpointOut$Outbound, - CheckpointOut$outboundSchema, - CheckpointOut$, - classificationRequestInputsToJSON, - classificationRequestInputsFromJSON, - classificationRequestToJSON, - classificationRequestFromJSON, - ClassificationRequestInputs, - ClassificationRequest, - ClassificationRequestInputs$inboundSchema, - ClassificationRequestInputs$Outbound, - ClassificationRequestInputs$outboundSchema, - ClassificationRequestInputs$, - ClassificationRequest$inboundSchema, - ClassificationRequest$Outbound, - ClassificationRequest$outboundSchema, - ClassificationRequest$, - classificationResponseToJSON, - classificationResponseFromJSON, - ClassificationResponse, - ClassificationResponse$inboundSchema, - ClassificationResponse$Outbound, - ClassificationResponse$outboundSchema, - ClassificationResponse$, - classificationTargetResultToJSON, - classificationTargetResultFromJSON, - ClassificationTargetResult, - ClassificationTargetResult$inboundSchema, - ClassificationTargetResult$Outbound, - ClassificationTargetResult$outboundSchema, - ClassificationTargetResult$, - classifierDetailedJobOutIntegrationsToJSON, - classifierDetailedJobOutIntegrationsFromJSON, - classifierDetailedJobOutToJSON, - classifierDetailedJobOutFromJSON, - ClassifierDetailedJobOutStatus, - ClassifierDetailedJobOutObject, - ClassifierDetailedJobOutIntegrations, - ClassifierDetailedJobOutJobType, - ClassifierDetailedJobOut, - ClassifierDetailedJobOutStatus$inboundSchema, - ClassifierDetailedJobOutStatus$outboundSchema, - ClassifierDetailedJobOutStatus$, - ClassifierDetailedJobOutObject$inboundSchema, - ClassifierDetailedJobOutObject$outboundSchema, - ClassifierDetailedJobOutObject$, - ClassifierDetailedJobOutIntegrations$inboundSchema, - ClassifierDetailedJobOutIntegrations$Outbound, - ClassifierDetailedJobOutIntegrations$outboundSchema, - ClassifierDetailedJobOutIntegrations$, - ClassifierDetailedJobOutJobType$inboundSchema, - ClassifierDetailedJobOutJobType$outboundSchema, - ClassifierDetailedJobOutJobType$, - ClassifierDetailedJobOut$inboundSchema, - ClassifierDetailedJobOut$Outbound, - ClassifierDetailedJobOut$outboundSchema, - ClassifierDetailedJobOut$, - classifierFTModelOutToJSON, - classifierFTModelOutFromJSON, - ClassifierFTModelOutObject, - ClassifierFTModelOutModelType, - ClassifierFTModelOut, - ClassifierFTModelOutObject$inboundSchema, - ClassifierFTModelOutObject$outboundSchema, - ClassifierFTModelOutObject$, - ClassifierFTModelOutModelType$inboundSchema, - ClassifierFTModelOutModelType$outboundSchema, - ClassifierFTModelOutModelType$, - ClassifierFTModelOut$inboundSchema, - ClassifierFTModelOut$Outbound, - ClassifierFTModelOut$outboundSchema, - ClassifierFTModelOut$, - classifierJobOutIntegrationsToJSON, - classifierJobOutIntegrationsFromJSON, - classifierJobOutToJSON, - classifierJobOutFromJSON, - ClassifierJobOutStatus, - ClassifierJobOutObject, - ClassifierJobOutIntegrations, - ClassifierJobOutJobType, - ClassifierJobOut, - ClassifierJobOutStatus$inboundSchema, - ClassifierJobOutStatus$outboundSchema, - ClassifierJobOutStatus$, - ClassifierJobOutObject$inboundSchema, - ClassifierJobOutObject$outboundSchema, - ClassifierJobOutObject$, - ClassifierJobOutIntegrations$inboundSchema, - ClassifierJobOutIntegrations$Outbound, - ClassifierJobOutIntegrations$outboundSchema, - ClassifierJobOutIntegrations$, - ClassifierJobOutJobType$inboundSchema, - ClassifierJobOutJobType$outboundSchema, - ClassifierJobOutJobType$, - ClassifierJobOut$inboundSchema, - ClassifierJobOut$Outbound, - ClassifierJobOut$outboundSchema, - ClassifierJobOut$, - classifierTargetInToJSON, - classifierTargetInFromJSON, - ClassifierTargetIn, - ClassifierTargetIn$inboundSchema, - ClassifierTargetIn$Outbound, - ClassifierTargetIn$outboundSchema, - ClassifierTargetIn$, - classifierTargetOutToJSON, - classifierTargetOutFromJSON, - ClassifierTargetOut, - ClassifierTargetOut$inboundSchema, - ClassifierTargetOut$Outbound, - ClassifierTargetOut$outboundSchema, - ClassifierTargetOut$, - classifierTrainingParametersToJSON, - classifierTrainingParametersFromJSON, - ClassifierTrainingParameters, - ClassifierTrainingParameters$inboundSchema, - ClassifierTrainingParameters$Outbound, - ClassifierTrainingParameters$outboundSchema, - ClassifierTrainingParameters$, - classifierTrainingParametersInToJSON, - classifierTrainingParametersInFromJSON, - ClassifierTrainingParametersIn, - ClassifierTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$Outbound, - ClassifierTrainingParametersIn$outboundSchema, - ClassifierTrainingParametersIn$, - codeInterpreterToolToJSON, - codeInterpreterToolFromJSON, - CodeInterpreterToolType, - CodeInterpreterTool, - CodeInterpreterToolType$inboundSchema, - CodeInterpreterToolType$outboundSchema, - CodeInterpreterToolType$, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, - CodeInterpreterTool$, - completionArgsToJSON, - completionArgsFromJSON, - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, - CompletionArgs$, - completionArgsStopToJSON, - completionArgsStopFromJSON, - CompletionArgsStop, - CompletionArgsStop$inboundSchema, - CompletionArgsStop$Outbound, - CompletionArgsStop$outboundSchema, - CompletionArgsStop$, - completionChunkToJSON, - completionChunkFromJSON, - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, - CompletionChunk$, - completionDetailedJobOutIntegrationsToJSON, - completionDetailedJobOutIntegrationsFromJSON, - completionDetailedJobOutRepositoriesToJSON, - completionDetailedJobOutRepositoriesFromJSON, - completionDetailedJobOutToJSON, - completionDetailedJobOutFromJSON, - CompletionDetailedJobOutStatus, - CompletionDetailedJobOutObject, - CompletionDetailedJobOutIntegrations, - CompletionDetailedJobOutJobType, - CompletionDetailedJobOutRepositories, - CompletionDetailedJobOut, - CompletionDetailedJobOutStatus$inboundSchema, - CompletionDetailedJobOutStatus$outboundSchema, - CompletionDetailedJobOutStatus$, - CompletionDetailedJobOutObject$inboundSchema, - CompletionDetailedJobOutObject$outboundSchema, - CompletionDetailedJobOutObject$, - CompletionDetailedJobOutIntegrations$inboundSchema, - CompletionDetailedJobOutIntegrations$Outbound, - CompletionDetailedJobOutIntegrations$outboundSchema, - CompletionDetailedJobOutIntegrations$, - CompletionDetailedJobOutJobType$inboundSchema, - CompletionDetailedJobOutJobType$outboundSchema, - CompletionDetailedJobOutJobType$, - CompletionDetailedJobOutRepositories$inboundSchema, - CompletionDetailedJobOutRepositories$Outbound, - CompletionDetailedJobOutRepositories$outboundSchema, - CompletionDetailedJobOutRepositories$, - CompletionDetailedJobOut$inboundSchema, - CompletionDetailedJobOut$Outbound, - CompletionDetailedJobOut$outboundSchema, - CompletionDetailedJobOut$, - completionEventToJSON, - completionEventFromJSON, - CompletionEvent, - CompletionEvent$inboundSchema, - CompletionEvent$Outbound, - CompletionEvent$outboundSchema, - CompletionEvent$, - completionFTModelOutToJSON, - completionFTModelOutFromJSON, - CompletionFTModelOutObject, - ModelType, - CompletionFTModelOut, - CompletionFTModelOutObject$inboundSchema, - CompletionFTModelOutObject$outboundSchema, - CompletionFTModelOutObject$, - ModelType$inboundSchema, - ModelType$outboundSchema, - ModelType$, - CompletionFTModelOut$inboundSchema, - CompletionFTModelOut$Outbound, - CompletionFTModelOut$outboundSchema, - CompletionFTModelOut$, - integrationsToJSON, - integrationsFromJSON, - repositoriesToJSON, - repositoriesFromJSON, - completionJobOutToJSON, - completionJobOutFromJSON, - Status, - CompletionJobOutObject, - Integrations, - JobType, - Repositories, - CompletionJobOut, - Status$inboundSchema, - Status$outboundSchema, - Status$, - CompletionJobOutObject$inboundSchema, - CompletionJobOutObject$outboundSchema, - CompletionJobOutObject$, - Integrations$inboundSchema, - Integrations$Outbound, - Integrations$outboundSchema, - Integrations$, - JobType$inboundSchema, - JobType$outboundSchema, - JobType$, - Repositories$inboundSchema, - Repositories$Outbound, - Repositories$outboundSchema, - Repositories$, - CompletionJobOut$inboundSchema, - CompletionJobOut$Outbound, - CompletionJobOut$outboundSchema, - CompletionJobOut$, - completionResponseStreamChoiceToJSON, - completionResponseStreamChoiceFromJSON, - CompletionResponseStreamChoiceFinishReason, - CompletionResponseStreamChoice, - CompletionResponseStreamChoiceFinishReason$inboundSchema, - CompletionResponseStreamChoiceFinishReason$outboundSchema, - CompletionResponseStreamChoiceFinishReason$, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, - CompletionResponseStreamChoice$, - completionTrainingParametersToJSON, - completionTrainingParametersFromJSON, - CompletionTrainingParameters, - CompletionTrainingParameters$inboundSchema, - CompletionTrainingParameters$Outbound, - CompletionTrainingParameters$outboundSchema, - CompletionTrainingParameters$, - completionTrainingParametersInToJSON, - completionTrainingParametersInFromJSON, - CompletionTrainingParametersIn, - CompletionTrainingParametersIn$inboundSchema, - CompletionTrainingParametersIn$Outbound, - CompletionTrainingParametersIn$outboundSchema, - CompletionTrainingParametersIn$, - contentChunkToJSON, - contentChunkFromJSON, - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, - ContentChunk$, - conversationAppendRequestToJSON, - conversationAppendRequestFromJSON, - ConversationAppendRequestHandoffExecution, - ConversationAppendRequest, - ConversationAppendRequestHandoffExecution$inboundSchema, - ConversationAppendRequestHandoffExecution$outboundSchema, - ConversationAppendRequestHandoffExecution$, - ConversationAppendRequest$inboundSchema, - ConversationAppendRequest$Outbound, - ConversationAppendRequest$outboundSchema, - ConversationAppendRequest$, - conversationAppendStreamRequestToJSON, - conversationAppendStreamRequestFromJSON, - ConversationAppendStreamRequestHandoffExecution, - ConversationAppendStreamRequest, - ConversationAppendStreamRequestHandoffExecution$inboundSchema, - ConversationAppendStreamRequestHandoffExecution$outboundSchema, - ConversationAppendStreamRequestHandoffExecution$, - ConversationAppendStreamRequest$inboundSchema, - ConversationAppendStreamRequest$Outbound, - ConversationAppendStreamRequest$outboundSchema, - ConversationAppendStreamRequest$, - conversationEventsDataToJSON, - conversationEventsDataFromJSON, - conversationEventsToJSON, - conversationEventsFromJSON, - ConversationEventsData, - ConversationEvents, - ConversationEventsData$inboundSchema, - ConversationEventsData$Outbound, - ConversationEventsData$outboundSchema, - ConversationEventsData$, - ConversationEvents$inboundSchema, - ConversationEvents$Outbound, - ConversationEvents$outboundSchema, - ConversationEvents$, - entriesToJSON, - entriesFromJSON, - conversationHistoryToJSON, - conversationHistoryFromJSON, - ConversationHistoryObject, - Entries, - ConversationHistory, - ConversationHistoryObject$inboundSchema, - ConversationHistoryObject$outboundSchema, - ConversationHistoryObject$, - Entries$inboundSchema, - Entries$Outbound, - Entries$outboundSchema, - Entries$, - ConversationHistory$inboundSchema, - ConversationHistory$Outbound, - ConversationHistory$outboundSchema, - ConversationHistory$, - conversationInputsToJSON, - conversationInputsFromJSON, - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, - ConversationInputs$, - conversationMessagesToJSON, - conversationMessagesFromJSON, - ConversationMessagesObject, - ConversationMessages, - ConversationMessagesObject$inboundSchema, - ConversationMessagesObject$outboundSchema, - ConversationMessagesObject$, - ConversationMessages$inboundSchema, - ConversationMessages$Outbound, - ConversationMessages$outboundSchema, - ConversationMessages$, - toolsToJSON, - toolsFromJSON, - conversationRequestToJSON, - conversationRequestFromJSON, - HandoffExecution, - Tools, - ConversationRequest, - HandoffExecution$inboundSchema, - HandoffExecution$outboundSchema, - HandoffExecution$, - Tools$inboundSchema, - Tools$Outbound, - Tools$outboundSchema, - Tools$, - ConversationRequest$inboundSchema, - ConversationRequest$Outbound, - ConversationRequest$outboundSchema, - ConversationRequest$, - outputsToJSON, - outputsFromJSON, - conversationResponseToJSON, - conversationResponseFromJSON, - ConversationResponseObject, - Outputs, - ConversationResponse, - ConversationResponseObject$inboundSchema, - ConversationResponseObject$outboundSchema, - ConversationResponseObject$, - Outputs$inboundSchema, - Outputs$Outbound, - Outputs$outboundSchema, - Outputs$, - ConversationResponse$inboundSchema, - ConversationResponse$Outbound, - ConversationResponse$outboundSchema, - ConversationResponse$, - conversationRestartRequestToJSON, - conversationRestartRequestFromJSON, - ConversationRestartRequestHandoffExecution, - ConversationRestartRequest, - ConversationRestartRequestHandoffExecution$inboundSchema, - ConversationRestartRequestHandoffExecution$outboundSchema, - ConversationRestartRequestHandoffExecution$, - ConversationRestartRequest$inboundSchema, - ConversationRestartRequest$Outbound, - ConversationRestartRequest$outboundSchema, - ConversationRestartRequest$, - conversationRestartStreamRequestToJSON, - conversationRestartStreamRequestFromJSON, - ConversationRestartStreamRequestHandoffExecution, - ConversationRestartStreamRequest, - ConversationRestartStreamRequestHandoffExecution$inboundSchema, - ConversationRestartStreamRequestHandoffExecution$outboundSchema, - ConversationRestartStreamRequestHandoffExecution$, - ConversationRestartStreamRequest$inboundSchema, - ConversationRestartStreamRequest$Outbound, - ConversationRestartStreamRequest$outboundSchema, - ConversationRestartStreamRequest$, - conversationStreamRequestToolsToJSON, - conversationStreamRequestToolsFromJSON, - conversationStreamRequestToJSON, - conversationStreamRequestFromJSON, - ConversationStreamRequestHandoffExecution, - ConversationStreamRequestTools, - ConversationStreamRequest, - ConversationStreamRequestHandoffExecution$inboundSchema, - ConversationStreamRequestHandoffExecution$outboundSchema, - ConversationStreamRequestHandoffExecution$, - ConversationStreamRequestTools$inboundSchema, - ConversationStreamRequestTools$Outbound, - ConversationStreamRequestTools$outboundSchema, - ConversationStreamRequestTools$, - ConversationStreamRequest$inboundSchema, - ConversationStreamRequest$Outbound, - ConversationStreamRequest$outboundSchema, - ConversationStreamRequest$, - conversationUsageInfoToJSON, - conversationUsageInfoFromJSON, - ConversationUsageInfo, - ConversationUsageInfo$inboundSchema, - ConversationUsageInfo$Outbound, - ConversationUsageInfo$outboundSchema, - ConversationUsageInfo$, - deleteFileOutToJSON, - deleteFileOutFromJSON, - DeleteFileOut, - DeleteFileOut$inboundSchema, - DeleteFileOut$Outbound, - DeleteFileOut$outboundSchema, - DeleteFileOut$, - deleteModelOutToJSON, - deleteModelOutFromJSON, - DeleteModelOut, - DeleteModelOut$inboundSchema, - DeleteModelOut$Outbound, - DeleteModelOut$outboundSchema, - DeleteModelOut$, - contentToJSON, - contentFromJSON, - deltaMessageToJSON, - deltaMessageFromJSON, - Content, - DeltaMessage, - Content$inboundSchema, - Content$Outbound, - Content$outboundSchema, - Content$, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, - DeltaMessage$, - documentLibraryToolToJSON, - documentLibraryToolFromJSON, - DocumentLibraryToolType, - DocumentLibraryTool, - DocumentLibraryToolType$inboundSchema, - DocumentLibraryToolType$outboundSchema, - DocumentLibraryToolType$, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, - DocumentLibraryTool$, - documentOutToJSON, - documentOutFromJSON, - DocumentOut, - DocumentOut$inboundSchema, - DocumentOut$Outbound, - DocumentOut$outboundSchema, - DocumentOut$, - documentTextContentToJSON, - documentTextContentFromJSON, - DocumentTextContent, - DocumentTextContent$inboundSchema, - DocumentTextContent$Outbound, - DocumentTextContent$outboundSchema, - DocumentTextContent$, - documentUpdateInToJSON, - documentUpdateInFromJSON, - DocumentUpdateIn, - DocumentUpdateIn$inboundSchema, - DocumentUpdateIn$Outbound, - DocumentUpdateIn$outboundSchema, - DocumentUpdateIn$, - documentURLChunkToJSON, - documentURLChunkFromJSON, - DocumentURLChunkType, - DocumentURLChunk, - DocumentURLChunkType$inboundSchema, - DocumentURLChunkType$outboundSchema, - DocumentURLChunkType$, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, - DocumentURLChunk$, - EmbeddingDtype, - EmbeddingDtype$inboundSchema, - EmbeddingDtype$outboundSchema, - EmbeddingDtype$, - embeddingRequestInputsToJSON, - embeddingRequestInputsFromJSON, - embeddingRequestToJSON, - embeddingRequestFromJSON, - EmbeddingRequestInputs, - EmbeddingRequest, - EmbeddingRequestInputs$inboundSchema, - EmbeddingRequestInputs$Outbound, - EmbeddingRequestInputs$outboundSchema, - EmbeddingRequestInputs$, - EmbeddingRequest$inboundSchema, - EmbeddingRequest$Outbound, - EmbeddingRequest$outboundSchema, - EmbeddingRequest$, - embeddingResponseToJSON, - embeddingResponseFromJSON, - EmbeddingResponse, - EmbeddingResponse$inboundSchema, - EmbeddingResponse$Outbound, - EmbeddingResponse$outboundSchema, - EmbeddingResponse$, - embeddingResponseDataToJSON, - embeddingResponseDataFromJSON, - EmbeddingResponseData, - EmbeddingResponseData$inboundSchema, - EmbeddingResponseData$Outbound, - EmbeddingResponseData$outboundSchema, - EmbeddingResponseData$, - EncodingFormat, - EncodingFormat$inboundSchema, - EncodingFormat$outboundSchema, - EncodingFormat$, - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, - EntityType$, - eventOutToJSON, - eventOutFromJSON, - EventOut, - EventOut$inboundSchema, - EventOut$Outbound, - EventOut$outboundSchema, - EventOut$, - fileToJSON, - fileFromJSON, - FileT, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, - FileT$, - fileChunkToJSON, - fileChunkFromJSON, - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, - FileChunk$, - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, - FilePurpose$, - fileSchemaToJSON, - fileSchemaFromJSON, - FileSchema, - FileSchema$inboundSchema, - FileSchema$Outbound, - FileSchema$outboundSchema, - FileSchema$, - fileSignedURLToJSON, - fileSignedURLFromJSON, - FileSignedURL, - FileSignedURL$inboundSchema, - FileSignedURL$Outbound, - FileSignedURL$outboundSchema, - FileSignedURL$, - fimCompletionRequestStopToJSON, - fimCompletionRequestStopFromJSON, - fimCompletionRequestToJSON, - fimCompletionRequestFromJSON, - FIMCompletionRequestStop, - FIMCompletionRequest, - FIMCompletionRequestStop$inboundSchema, - FIMCompletionRequestStop$Outbound, - FIMCompletionRequestStop$outboundSchema, - FIMCompletionRequestStop$, - FIMCompletionRequest$inboundSchema, - FIMCompletionRequest$Outbound, - FIMCompletionRequest$outboundSchema, - FIMCompletionRequest$, - fimCompletionResponseToJSON, - fimCompletionResponseFromJSON, - FIMCompletionResponse, - FIMCompletionResponse$inboundSchema, - FIMCompletionResponse$Outbound, - FIMCompletionResponse$outboundSchema, - FIMCompletionResponse$, - fimCompletionStreamRequestStopToJSON, - fimCompletionStreamRequestStopFromJSON, - fimCompletionStreamRequestToJSON, - fimCompletionStreamRequestFromJSON, - FIMCompletionStreamRequestStop, - FIMCompletionStreamRequest, - FIMCompletionStreamRequestStop$inboundSchema, - FIMCompletionStreamRequestStop$Outbound, - FIMCompletionStreamRequestStop$outboundSchema, - FIMCompletionStreamRequestStop$, - FIMCompletionStreamRequest$inboundSchema, - FIMCompletionStreamRequest$Outbound, - FIMCompletionStreamRequest$outboundSchema, - FIMCompletionStreamRequest$, - FineTuneableModelType, - FineTuneableModelType$inboundSchema, - FineTuneableModelType$outboundSchema, - FineTuneableModelType$, - FTClassifierLossFunction, - FTClassifierLossFunction$inboundSchema, - FTClassifierLossFunction$outboundSchema, - FTClassifierLossFunction$, - ftModelCapabilitiesOutToJSON, - ftModelCapabilitiesOutFromJSON, - FTModelCapabilitiesOut, - FTModelCapabilitiesOut$inboundSchema, - FTModelCapabilitiesOut$Outbound, - FTModelCapabilitiesOut$outboundSchema, - FTModelCapabilitiesOut$, - ftModelCardToJSON, - ftModelCardFromJSON, - FTModelCardType, - FTModelCard, - FTModelCardType$inboundSchema, - FTModelCardType$outboundSchema, - FTModelCardType$, - FTModelCard$inboundSchema, - FTModelCard$Outbound, - FTModelCard$outboundSchema, - FTModelCard$, - functionToJSON, - functionFromJSON, - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, - FunctionT$, - argumentsToJSON, - argumentsFromJSON, - functionCallToJSON, - functionCallFromJSON, - Arguments, - FunctionCall, - Arguments$inboundSchema, - Arguments$Outbound, - Arguments$outboundSchema, - Arguments$, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, - FunctionCall$, - functionCallEntryToJSON, - functionCallEntryFromJSON, - FunctionCallEntryObject, - FunctionCallEntryType, - FunctionCallEntry, - FunctionCallEntryObject$inboundSchema, - FunctionCallEntryObject$outboundSchema, - FunctionCallEntryObject$, - FunctionCallEntryType$inboundSchema, - FunctionCallEntryType$outboundSchema, - FunctionCallEntryType$, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, - FunctionCallEntry$, - functionCallEntryArgumentsToJSON, - functionCallEntryArgumentsFromJSON, - FunctionCallEntryArguments, - FunctionCallEntryArguments$inboundSchema, - FunctionCallEntryArguments$Outbound, - FunctionCallEntryArguments$outboundSchema, - FunctionCallEntryArguments$, - functionCallEventToJSON, - functionCallEventFromJSON, - FunctionCallEventType, - FunctionCallEvent, - FunctionCallEventType$inboundSchema, - FunctionCallEventType$outboundSchema, - FunctionCallEventType$, - FunctionCallEvent$inboundSchema, - FunctionCallEvent$Outbound, - FunctionCallEvent$outboundSchema, - FunctionCallEvent$, - functionNameToJSON, - functionNameFromJSON, - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, - FunctionName$, - functionResultEntryToJSON, - functionResultEntryFromJSON, - FunctionResultEntryObject, - FunctionResultEntryType, - FunctionResultEntry, - FunctionResultEntryObject$inboundSchema, - FunctionResultEntryObject$outboundSchema, - FunctionResultEntryObject$, - FunctionResultEntryType$inboundSchema, - FunctionResultEntryType$outboundSchema, - FunctionResultEntryType$, - FunctionResultEntry$inboundSchema, - FunctionResultEntry$Outbound, - FunctionResultEntry$outboundSchema, - FunctionResultEntry$, - functionToolToJSON, - functionToolFromJSON, - FunctionToolType, - FunctionTool, - FunctionToolType$inboundSchema, - FunctionToolType$outboundSchema, - FunctionToolType$, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, - FunctionTool$, - githubRepositoryInToJSON, - githubRepositoryInFromJSON, - GithubRepositoryInType, - GithubRepositoryIn, - GithubRepositoryInType$inboundSchema, - GithubRepositoryInType$outboundSchema, - GithubRepositoryInType$, - GithubRepositoryIn$inboundSchema, - GithubRepositoryIn$Outbound, - GithubRepositoryIn$outboundSchema, - GithubRepositoryIn$, - githubRepositoryOutToJSON, - githubRepositoryOutFromJSON, - GithubRepositoryOutType, - GithubRepositoryOut, - GithubRepositoryOutType$inboundSchema, - GithubRepositoryOutType$outboundSchema, - GithubRepositoryOutType$, - GithubRepositoryOut$inboundSchema, - GithubRepositoryOut$Outbound, - GithubRepositoryOut$outboundSchema, - GithubRepositoryOut$, - imageGenerationToolToJSON, - imageGenerationToolFromJSON, - ImageGenerationToolType, - ImageGenerationTool, - ImageGenerationToolType$inboundSchema, - ImageGenerationToolType$outboundSchema, - ImageGenerationToolType$, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, - ImageGenerationTool$, - imageURLToJSON, - imageURLFromJSON, - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, - ImageURL$, - imageURLChunkImageURLToJSON, - imageURLChunkImageURLFromJSON, - imageURLChunkToJSON, - imageURLChunkFromJSON, - ImageURLChunkImageURL, - ImageURLChunkType, - ImageURLChunk, - ImageURLChunkImageURL$inboundSchema, - ImageURLChunkImageURL$Outbound, - ImageURLChunkImageURL$outboundSchema, - ImageURLChunkImageURL$, - ImageURLChunkType$inboundSchema, - ImageURLChunkType$outboundSchema, - ImageURLChunkType$, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, - ImageURLChunk$, - inputEntriesToJSON, - inputEntriesFromJSON, - InputEntries, - InputEntries$inboundSchema, - InputEntries$Outbound, - InputEntries$outboundSchema, - InputEntries$, - instructRequestInputsMessagesToJSON, - instructRequestInputsMessagesFromJSON, - instructRequestInputsToJSON, - instructRequestInputsFromJSON, - inputsToJSON, - inputsFromJSON, - InstructRequestInputsMessages, - InstructRequestInputs, - Inputs, - InstructRequestInputsMessages$inboundSchema, - InstructRequestInputsMessages$Outbound, - InstructRequestInputsMessages$outboundSchema, - InstructRequestInputsMessages$, - InstructRequestInputs$inboundSchema, - InstructRequestInputs$Outbound, - InstructRequestInputs$outboundSchema, - InstructRequestInputs$, - Inputs$inboundSchema, - Inputs$Outbound, - Inputs$outboundSchema, - Inputs$, - instructRequestMessagesToJSON, - instructRequestMessagesFromJSON, - instructRequestToJSON, - instructRequestFromJSON, - InstructRequestMessages, - InstructRequest, - InstructRequestMessages$inboundSchema, - InstructRequestMessages$Outbound, - InstructRequestMessages$outboundSchema, - InstructRequestMessages$, - InstructRequest$inboundSchema, - InstructRequest$Outbound, - InstructRequest$outboundSchema, - InstructRequest$, - jobInIntegrationsToJSON, - jobInIntegrationsFromJSON, - hyperparametersToJSON, - hyperparametersFromJSON, - jobInRepositoriesToJSON, - jobInRepositoriesFromJSON, - jobInToJSON, - jobInFromJSON, - JobInIntegrations, - Hyperparameters, - JobInRepositories, - JobIn, - JobInIntegrations$inboundSchema, - JobInIntegrations$Outbound, - JobInIntegrations$outboundSchema, - JobInIntegrations$, - Hyperparameters$inboundSchema, - Hyperparameters$Outbound, - Hyperparameters$outboundSchema, - Hyperparameters$, - JobInRepositories$inboundSchema, - JobInRepositories$Outbound, - JobInRepositories$outboundSchema, - JobInRepositories$, - JobIn$inboundSchema, - JobIn$Outbound, - JobIn$outboundSchema, - JobIn$, - jobMetadataOutToJSON, - jobMetadataOutFromJSON, - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, - JobMetadataOut$, - jobsOutDataToJSON, - jobsOutDataFromJSON, - jobsOutToJSON, - jobsOutFromJSON, - JobsOutData, - JobsOutObject, - JobsOut, - JobsOutData$inboundSchema, - JobsOutData$Outbound, - JobsOutData$outboundSchema, - JobsOutData$, - JobsOutObject$inboundSchema, - JobsOutObject$outboundSchema, - JobsOutObject$, - JobsOut$inboundSchema, - JobsOut$Outbound, - JobsOut$outboundSchema, - JobsOut$, - jsonSchemaToJSON, - jsonSchemaFromJSON, - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, - JsonSchema$, - legacyJobMetadataOutToJSON, - legacyJobMetadataOutFromJSON, - LegacyJobMetadataOutObject, - LegacyJobMetadataOut, - LegacyJobMetadataOutObject$inboundSchema, - LegacyJobMetadataOutObject$outboundSchema, - LegacyJobMetadataOutObject$, - LegacyJobMetadataOut$inboundSchema, - LegacyJobMetadataOut$Outbound, - LegacyJobMetadataOut$outboundSchema, - LegacyJobMetadataOut$, - libraryInToJSON, - libraryInFromJSON, - LibraryIn, - LibraryIn$inboundSchema, - LibraryIn$Outbound, - LibraryIn$outboundSchema, - LibraryIn$, - libraryInUpdateToJSON, - libraryInUpdateFromJSON, - LibraryInUpdate, - LibraryInUpdate$inboundSchema, - LibraryInUpdate$Outbound, - LibraryInUpdate$outboundSchema, - LibraryInUpdate$, - libraryOutToJSON, - libraryOutFromJSON, - LibraryOut, - LibraryOut$inboundSchema, - LibraryOut$Outbound, - LibraryOut$outboundSchema, - LibraryOut$, - listDocumentOutToJSON, - listDocumentOutFromJSON, - ListDocumentOut, - ListDocumentOut$inboundSchema, - ListDocumentOut$Outbound, - ListDocumentOut$outboundSchema, - ListDocumentOut$, - listFilesOutToJSON, - listFilesOutFromJSON, - ListFilesOut, - ListFilesOut$inboundSchema, - ListFilesOut$Outbound, - ListFilesOut$outboundSchema, - ListFilesOut$, - listLibraryOutToJSON, - listLibraryOutFromJSON, - ListLibraryOut, - ListLibraryOut$inboundSchema, - ListLibraryOut$Outbound, - ListLibraryOut$outboundSchema, - ListLibraryOut$, - listSharingOutToJSON, - listSharingOutFromJSON, - ListSharingOut, - ListSharingOut$inboundSchema, - ListSharingOut$Outbound, - ListSharingOut$outboundSchema, - ListSharingOut$, - messageEntriesToJSON, - messageEntriesFromJSON, - MessageEntries, - MessageEntries$inboundSchema, - MessageEntries$Outbound, - MessageEntries$outboundSchema, - MessageEntries$, - messageInputContentChunksToJSON, - messageInputContentChunksFromJSON, - MessageInputContentChunks, - MessageInputContentChunks$inboundSchema, - MessageInputContentChunks$Outbound, - MessageInputContentChunks$outboundSchema, - MessageInputContentChunks$, - messageInputEntryContentToJSON, - messageInputEntryContentFromJSON, - messageInputEntryToJSON, - messageInputEntryFromJSON, - ObjectT, - MessageInputEntryType, - MessageInputEntryRole, - MessageInputEntryContent, - MessageInputEntry, - ObjectT$inboundSchema, - ObjectT$outboundSchema, - ObjectT$, - MessageInputEntryType$inboundSchema, - MessageInputEntryType$outboundSchema, - MessageInputEntryType$, - MessageInputEntryRole$inboundSchema, - MessageInputEntryRole$outboundSchema, - MessageInputEntryRole$, - MessageInputEntryContent$inboundSchema, - MessageInputEntryContent$Outbound, - MessageInputEntryContent$outboundSchema, - MessageInputEntryContent$, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, - MessageInputEntry$, - messageOutputContentChunksToJSON, - messageOutputContentChunksFromJSON, - MessageOutputContentChunks, - MessageOutputContentChunks$inboundSchema, - MessageOutputContentChunks$Outbound, - MessageOutputContentChunks$outboundSchema, - MessageOutputContentChunks$, - messageOutputEntryContentToJSON, - messageOutputEntryContentFromJSON, - messageOutputEntryToJSON, - messageOutputEntryFromJSON, - MessageOutputEntryObject, - MessageOutputEntryType, - MessageOutputEntryRole, - MessageOutputEntryContent, - MessageOutputEntry, - MessageOutputEntryObject$inboundSchema, - MessageOutputEntryObject$outboundSchema, - MessageOutputEntryObject$, - MessageOutputEntryType$inboundSchema, - MessageOutputEntryType$outboundSchema, - MessageOutputEntryType$, - MessageOutputEntryRole$inboundSchema, - MessageOutputEntryRole$outboundSchema, - MessageOutputEntryRole$, - MessageOutputEntryContent$inboundSchema, - MessageOutputEntryContent$Outbound, - MessageOutputEntryContent$outboundSchema, - MessageOutputEntryContent$, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, - MessageOutputEntry$, - messageOutputEventContentToJSON, - messageOutputEventContentFromJSON, - messageOutputEventToJSON, - messageOutputEventFromJSON, - MessageOutputEventType, - MessageOutputEventRole, - MessageOutputEventContent, - MessageOutputEvent, - MessageOutputEventType$inboundSchema, - MessageOutputEventType$outboundSchema, - MessageOutputEventType$, - MessageOutputEventRole$inboundSchema, - MessageOutputEventRole$outboundSchema, - MessageOutputEventRole$, - MessageOutputEventContent$inboundSchema, - MessageOutputEventContent$Outbound, - MessageOutputEventContent$outboundSchema, - MessageOutputEventContent$, - MessageOutputEvent$inboundSchema, - MessageOutputEvent$Outbound, - MessageOutputEvent$outboundSchema, - MessageOutputEvent$, - metricOutToJSON, - metricOutFromJSON, - MetricOut, - MetricOut$inboundSchema, - MetricOut$Outbound, - MetricOut$outboundSchema, - MetricOut$, - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, - MistralPromptMode$, - modelCapabilitiesToJSON, - modelCapabilitiesFromJSON, - ModelCapabilities, - ModelCapabilities$inboundSchema, - ModelCapabilities$Outbound, - ModelCapabilities$outboundSchema, - ModelCapabilities$, - modelConversationToolsToJSON, - modelConversationToolsFromJSON, - modelConversationToJSON, - modelConversationFromJSON, - ModelConversationTools, - ModelConversationObject, - ModelConversation, - ModelConversationTools$inboundSchema, - ModelConversationTools$Outbound, - ModelConversationTools$outboundSchema, - ModelConversationTools$, - ModelConversationObject$inboundSchema, - ModelConversationObject$outboundSchema, - ModelConversationObject$, - ModelConversation$inboundSchema, - ModelConversation$Outbound, - ModelConversation$outboundSchema, - ModelConversation$, - dataToJSON, - dataFromJSON, - modelListToJSON, - modelListFromJSON, - Data, - ModelList, - Data$inboundSchema, - Data$Outbound, - Data$outboundSchema, - Data$, - ModelList$inboundSchema, - ModelList$Outbound, - ModelList$outboundSchema, - ModelList$, - moderationObjectToJSON, - moderationObjectFromJSON, - ModerationObject, - ModerationObject$inboundSchema, - ModerationObject$Outbound, - ModerationObject$outboundSchema, - ModerationObject$, - moderationResponseToJSON, - moderationResponseFromJSON, - ModerationResponse, - ModerationResponse$inboundSchema, - ModerationResponse$Outbound, - ModerationResponse$outboundSchema, - ModerationResponse$, - ocrImageObjectToJSON, - ocrImageObjectFromJSON, - OCRImageObject, - OCRImageObject$inboundSchema, - OCRImageObject$Outbound, - OCRImageObject$outboundSchema, - OCRImageObject$, - ocrPageDimensionsToJSON, - ocrPageDimensionsFromJSON, - OCRPageDimensions, - OCRPageDimensions$inboundSchema, - OCRPageDimensions$Outbound, - OCRPageDimensions$outboundSchema, - OCRPageDimensions$, - ocrPageObjectToJSON, - ocrPageObjectFromJSON, - OCRPageObject, - OCRPageObject$inboundSchema, - OCRPageObject$Outbound, - OCRPageObject$outboundSchema, - OCRPageObject$, - documentToJSON, - documentFromJSON, - ocrRequestToJSON, - ocrRequestFromJSON, - Document_2 as Document, - OCRRequest, - Document$inboundSchema, - Document$Outbound, - Document$outboundSchema, - Document$, - OCRRequest$inboundSchema, - OCRRequest$Outbound, - OCRRequest$outboundSchema, - OCRRequest$, - ocrResponseToJSON, - ocrResponseFromJSON, - OCRResponse, - OCRResponse$inboundSchema, - OCRResponse$Outbound, - OCRResponse$outboundSchema, - OCRResponse$, - ocrUsageInfoToJSON, - ocrUsageInfoFromJSON, - OCRUsageInfo, - OCRUsageInfo$inboundSchema, - OCRUsageInfo$Outbound, - OCRUsageInfo$outboundSchema, - OCRUsageInfo$, - outputContentChunksToJSON, - outputContentChunksFromJSON, - OutputContentChunks, - OutputContentChunks$inboundSchema, - OutputContentChunks$Outbound, - OutputContentChunks$outboundSchema, - OutputContentChunks$, - paginationInfoToJSON, - paginationInfoFromJSON, - PaginationInfo, - PaginationInfo$inboundSchema, - PaginationInfo$Outbound, - PaginationInfo$outboundSchema, - PaginationInfo$, - predictionToJSON, - predictionFromJSON, - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, - Prediction$, - processingStatusOutToJSON, - processingStatusOutFromJSON, - ProcessingStatusOut, - ProcessingStatusOut$inboundSchema, - ProcessingStatusOut$Outbound, - ProcessingStatusOut$outboundSchema, - ProcessingStatusOut$, - referenceChunkToJSON, - referenceChunkFromJSON, - ReferenceChunkType, - ReferenceChunk, - ReferenceChunkType$inboundSchema, - ReferenceChunkType$outboundSchema, - ReferenceChunkType$, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, - ReferenceChunk$, - responseDoneEventToJSON, - responseDoneEventFromJSON, - ResponseDoneEventType, - ResponseDoneEvent, - ResponseDoneEventType$inboundSchema, - ResponseDoneEventType$outboundSchema, - ResponseDoneEventType$, - ResponseDoneEvent$inboundSchema, - ResponseDoneEvent$Outbound, - ResponseDoneEvent$outboundSchema, - ResponseDoneEvent$, - responseErrorEventToJSON, - responseErrorEventFromJSON, - ResponseErrorEventType, - ResponseErrorEvent, - ResponseErrorEventType$inboundSchema, - ResponseErrorEventType$outboundSchema, - ResponseErrorEventType$, - ResponseErrorEvent$inboundSchema, - ResponseErrorEvent$Outbound, - ResponseErrorEvent$outboundSchema, - ResponseErrorEvent$, - responseFormatToJSON, - responseFormatFromJSON, - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, - ResponseFormat$, - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, - ResponseFormats$, - responseStartedEventToJSON, - responseStartedEventFromJSON, - ResponseStartedEventType, - ResponseStartedEvent, - ResponseStartedEventType$inboundSchema, - ResponseStartedEventType$outboundSchema, - ResponseStartedEventType$, - ResponseStartedEvent$inboundSchema, - ResponseStartedEvent$Outbound, - ResponseStartedEvent$outboundSchema, - ResponseStartedEvent$, - retrieveFileOutToJSON, - retrieveFileOutFromJSON, - RetrieveFileOut, - RetrieveFileOut$inboundSchema, - RetrieveFileOut$Outbound, - RetrieveFileOut$outboundSchema, - RetrieveFileOut$, - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, - SampleType$, - securityToJSON, - securityFromJSON, - Security, - Security$inboundSchema, - Security$Outbound, - Security$outboundSchema, - Security$, - ShareEnum, - ShareEnum$inboundSchema, - ShareEnum$outboundSchema, - ShareEnum$, - sharingDeleteToJSON, - sharingDeleteFromJSON, - SharingDelete, - SharingDelete$inboundSchema, - SharingDelete$Outbound, - SharingDelete$outboundSchema, - SharingDelete$, - sharingInToJSON, - sharingInFromJSON, - SharingIn, - SharingIn$inboundSchema, - SharingIn$Outbound, - SharingIn$outboundSchema, - SharingIn$, - sharingOutToJSON, - sharingOutFromJSON, - SharingOut, - SharingOut$inboundSchema, - SharingOut$Outbound, - SharingOut$outboundSchema, - SharingOut$, - Source, - Source$inboundSchema, - Source$outboundSchema, - Source$, - SSETypes, - SSETypes$inboundSchema, - SSETypes$outboundSchema, - SSETypes$, - systemMessageContentToJSON, - systemMessageContentFromJSON, - systemMessageToJSON, - systemMessageFromJSON, - SystemMessageContent, - Role, - SystemMessage, - SystemMessageContent$inboundSchema, - SystemMessageContent$Outbound, - SystemMessageContent$outboundSchema, - SystemMessageContent$, - Role$inboundSchema, - Role$outboundSchema, - Role$, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, - SystemMessage$, - systemMessageContentChunksToJSON, - systemMessageContentChunksFromJSON, - SystemMessageContentChunks, - SystemMessageContentChunks$inboundSchema, - SystemMessageContentChunks$Outbound, - SystemMessageContentChunks$outboundSchema, - SystemMessageContentChunks$, - textChunkToJSON, - textChunkFromJSON, - TextChunkType, - TextChunk, - TextChunkType$inboundSchema, - TextChunkType$outboundSchema, - TextChunkType$, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, - TextChunk$, - thinkingToJSON, - thinkingFromJSON, - thinkChunkToJSON, - thinkChunkFromJSON, - Thinking, - ThinkChunkType, - ThinkChunk, - Thinking$inboundSchema, - Thinking$Outbound, - Thinking$outboundSchema, - Thinking$, - ThinkChunkType$inboundSchema, - ThinkChunkType$outboundSchema, - ThinkChunkType$, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, - ThinkChunk$, - TimestampGranularity, - TimestampGranularity$inboundSchema, - TimestampGranularity$outboundSchema, - TimestampGranularity$, - toolToJSON, - toolFromJSON, - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, - Tool$, - toolCallToJSON, - toolCallFromJSON, - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, - ToolCall$, - toolChoiceToJSON, - toolChoiceFromJSON, - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, - ToolChoice$, - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, - ToolChoiceEnum$, - toolExecutionDeltaEventToJSON, - toolExecutionDeltaEventFromJSON, - ToolExecutionDeltaEventType, - ToolExecutionDeltaEvent, - ToolExecutionDeltaEventType$inboundSchema, - ToolExecutionDeltaEventType$outboundSchema, - ToolExecutionDeltaEventType$, - ToolExecutionDeltaEvent$inboundSchema, - ToolExecutionDeltaEvent$Outbound, - ToolExecutionDeltaEvent$outboundSchema, - ToolExecutionDeltaEvent$, - toolExecutionDoneEventToJSON, - toolExecutionDoneEventFromJSON, - ToolExecutionDoneEventType, - ToolExecutionDoneEvent, - ToolExecutionDoneEventType$inboundSchema, - ToolExecutionDoneEventType$outboundSchema, - ToolExecutionDoneEventType$, - ToolExecutionDoneEvent$inboundSchema, - ToolExecutionDoneEvent$Outbound, - ToolExecutionDoneEvent$outboundSchema, - ToolExecutionDoneEvent$, - toolExecutionEntryToJSON, - toolExecutionEntryFromJSON, - ToolExecutionEntryObject, - ToolExecutionEntryType, - ToolExecutionEntry, - ToolExecutionEntryObject$inboundSchema, - ToolExecutionEntryObject$outboundSchema, - ToolExecutionEntryObject$, - ToolExecutionEntryType$inboundSchema, - ToolExecutionEntryType$outboundSchema, - ToolExecutionEntryType$, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, - ToolExecutionEntry$, - toolExecutionStartedEventToJSON, - toolExecutionStartedEventFromJSON, - ToolExecutionStartedEventType, - ToolExecutionStartedEvent, - ToolExecutionStartedEventType$inboundSchema, - ToolExecutionStartedEventType$outboundSchema, - ToolExecutionStartedEventType$, - ToolExecutionStartedEvent$inboundSchema, - ToolExecutionStartedEvent$Outbound, - ToolExecutionStartedEvent$outboundSchema, - ToolExecutionStartedEvent$, - toolFileChunkToJSON, - toolFileChunkFromJSON, - ToolFileChunkType, - ToolFileChunk, - ToolFileChunkType$inboundSchema, - ToolFileChunkType$outboundSchema, - ToolFileChunkType$, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, - ToolFileChunk$, - toolMessageContentToJSON, - toolMessageContentFromJSON, - toolMessageToJSON, - toolMessageFromJSON, - ToolMessageContent, - ToolMessageRole, - ToolMessage, - ToolMessageContent$inboundSchema, - ToolMessageContent$Outbound, - ToolMessageContent$outboundSchema, - ToolMessageContent$, - ToolMessageRole$inboundSchema, - ToolMessageRole$outboundSchema, - ToolMessageRole$, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, - ToolMessage$, - toolReferenceChunkToJSON, - toolReferenceChunkFromJSON, - ToolReferenceChunkType, - ToolReferenceChunk, - ToolReferenceChunkType$inboundSchema, - ToolReferenceChunkType$outboundSchema, - ToolReferenceChunkType$, - ToolReferenceChunk$inboundSchema, - ToolReferenceChunk$Outbound, - ToolReferenceChunk$outboundSchema, - ToolReferenceChunk$, - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, - ToolTypes$, - trainingFileToJSON, - trainingFileFromJSON, - TrainingFile, - TrainingFile$inboundSchema, - TrainingFile$Outbound, - TrainingFile$outboundSchema, - TrainingFile$, - transcriptionResponseToJSON, - transcriptionResponseFromJSON, - TranscriptionResponse, - TranscriptionResponse$inboundSchema, - TranscriptionResponse$Outbound, - TranscriptionResponse$outboundSchema, - TranscriptionResponse$, - transcriptionSegmentChunkToJSON, - transcriptionSegmentChunkFromJSON, - Type, - TranscriptionSegmentChunk, - Type$inboundSchema, - Type$outboundSchema, - Type$, - TranscriptionSegmentChunk$inboundSchema, - TranscriptionSegmentChunk$Outbound, - TranscriptionSegmentChunk$outboundSchema, - TranscriptionSegmentChunk$, - transcriptionStreamDoneToJSON, - transcriptionStreamDoneFromJSON, - TranscriptionStreamDoneType, - TranscriptionStreamDone, - TranscriptionStreamDoneType$inboundSchema, - TranscriptionStreamDoneType$outboundSchema, - TranscriptionStreamDoneType$, - TranscriptionStreamDone$inboundSchema, - TranscriptionStreamDone$Outbound, - TranscriptionStreamDone$outboundSchema, - TranscriptionStreamDone$, - transcriptionStreamEventsDataToJSON, - transcriptionStreamEventsDataFromJSON, - transcriptionStreamEventsToJSON, - transcriptionStreamEventsFromJSON, - TranscriptionStreamEventsData, - TranscriptionStreamEvents, - TranscriptionStreamEventsData$inboundSchema, - TranscriptionStreamEventsData$Outbound, - TranscriptionStreamEventsData$outboundSchema, - TranscriptionStreamEventsData$, - TranscriptionStreamEvents$inboundSchema, - TranscriptionStreamEvents$Outbound, - TranscriptionStreamEvents$outboundSchema, - TranscriptionStreamEvents$, - TranscriptionStreamEventTypes, - TranscriptionStreamEventTypes$inboundSchema, - TranscriptionStreamEventTypes$outboundSchema, - TranscriptionStreamEventTypes$, - transcriptionStreamLanguageToJSON, - transcriptionStreamLanguageFromJSON, - TranscriptionStreamLanguageType, - TranscriptionStreamLanguage, - TranscriptionStreamLanguageType$inboundSchema, - TranscriptionStreamLanguageType$outboundSchema, - TranscriptionStreamLanguageType$, - TranscriptionStreamLanguage$inboundSchema, - TranscriptionStreamLanguage$Outbound, - TranscriptionStreamLanguage$outboundSchema, - TranscriptionStreamLanguage$, - transcriptionStreamSegmentDeltaToJSON, - transcriptionStreamSegmentDeltaFromJSON, - TranscriptionStreamSegmentDeltaType, - TranscriptionStreamSegmentDelta, - TranscriptionStreamSegmentDeltaType$inboundSchema, - TranscriptionStreamSegmentDeltaType$outboundSchema, - TranscriptionStreamSegmentDeltaType$, - TranscriptionStreamSegmentDelta$inboundSchema, - TranscriptionStreamSegmentDelta$Outbound, - TranscriptionStreamSegmentDelta$outboundSchema, - TranscriptionStreamSegmentDelta$, - transcriptionStreamTextDeltaToJSON, - transcriptionStreamTextDeltaFromJSON, - TranscriptionStreamTextDeltaType, - TranscriptionStreamTextDelta, - TranscriptionStreamTextDeltaType$inboundSchema, - TranscriptionStreamTextDeltaType$outboundSchema, - TranscriptionStreamTextDeltaType$, - TranscriptionStreamTextDelta$inboundSchema, - TranscriptionStreamTextDelta$Outbound, - TranscriptionStreamTextDelta$outboundSchema, - TranscriptionStreamTextDelta$, - unarchiveFTModelOutToJSON, - unarchiveFTModelOutFromJSON, - UnarchiveFTModelOutObject, - UnarchiveFTModelOut, - UnarchiveFTModelOutObject$inboundSchema, - UnarchiveFTModelOutObject$outboundSchema, - UnarchiveFTModelOutObject$, - UnarchiveFTModelOut$inboundSchema, - UnarchiveFTModelOut$Outbound, - UnarchiveFTModelOut$outboundSchema, - UnarchiveFTModelOut$, - updateFTModelInToJSON, - updateFTModelInFromJSON, - UpdateFTModelIn, - UpdateFTModelIn$inboundSchema, - UpdateFTModelIn$Outbound, - UpdateFTModelIn$outboundSchema, - UpdateFTModelIn$, - uploadFileOutToJSON, - uploadFileOutFromJSON, - UploadFileOut, - UploadFileOut$inboundSchema, - UploadFileOut$Outbound, - UploadFileOut$outboundSchema, - UploadFileOut$, - usageInfoToJSON, - usageInfoFromJSON, - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, - UsageInfo$, - userMessageContentToJSON, - userMessageContentFromJSON, - userMessageToJSON, - userMessageFromJSON, - UserMessageContent, - UserMessageRole, - UserMessage, - UserMessageContent$inboundSchema, - UserMessageContent$Outbound, - UserMessageContent$outboundSchema, - UserMessageContent$, - UserMessageRole$inboundSchema, - UserMessageRole$outboundSchema, - UserMessageRole$, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, - UserMessage$, - locToJSON, - locFromJSON, - validationErrorToJSON, - validationErrorFromJSON, - Loc, - ValidationError, - Loc$inboundSchema, - Loc$Outbound, - Loc$outboundSchema, - Loc$, - ValidationError$inboundSchema, - ValidationError$Outbound, - ValidationError$outboundSchema, - ValidationError$, - wandbIntegrationToJSON, - wandbIntegrationFromJSON, - WandbIntegrationType, - WandbIntegration, - WandbIntegrationType$inboundSchema, - WandbIntegrationType$outboundSchema, - WandbIntegrationType$, - WandbIntegration$inboundSchema, - WandbIntegration$Outbound, - WandbIntegration$outboundSchema, - WandbIntegration$, - wandbIntegrationOutToJSON, - wandbIntegrationOutFromJSON, - WandbIntegrationOutType, - WandbIntegrationOut, - WandbIntegrationOutType$inboundSchema, - WandbIntegrationOutType$outboundSchema, - WandbIntegrationOutType$, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, - WandbIntegrationOut$, - webSearchPremiumToolToJSON, - webSearchPremiumToolFromJSON, - WebSearchPremiumToolType, - WebSearchPremiumTool, - WebSearchPremiumToolType$inboundSchema, - WebSearchPremiumToolType$outboundSchema, - WebSearchPremiumToolType$, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, - WebSearchPremiumTool$, - webSearchToolToJSON, - webSearchToolFromJSON, - WebSearchToolType, - WebSearchTool, - WebSearchToolType$inboundSchema, - WebSearchToolType$outboundSchema, - WebSearchToolType$, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, - WebSearchTool$ - } -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -declare class ConnectionError extends HTTPClientError { - readonly name = "ConnectionError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Content$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Content$Outbound` instead. */ - type Outbound = Content$Outbound; -} - -/** @internal */ -declare const Content$inboundSchema: z.ZodType; - -/** @internal */ -declare type Content$Outbound = string | Array; - -/** @internal */ -declare const Content$outboundSchema: z.ZodType; - -declare type Content = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$Outbound` instead. */ - type Outbound = ContentChunk$Outbound; -} - -/** @internal */ -declare const ContentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ContentChunk$Outbound = (ImageURLChunk$Outbound & { - type: "image_url"; -}) | (DocumentURLChunk$Outbound & { - type: "document_url"; -}) | (TextChunk$Outbound & { - type: "text"; -}) | (ReferenceChunk$Outbound & { - type: "reference"; -}) | (FileChunk$Outbound & { - type: "file"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}) | (AudioChunk$Outbound & { - type: "input_audio"; -}); - -/** @internal */ -declare const ContentChunk$outboundSchema: z.ZodType; - -declare type ContentChunk = (ImageURLChunk & { - type: "image_url"; -}) | (DocumentURLChunk & { - type: "document_url"; -}) | (TextChunk & { - type: "text"; -}) | (ReferenceChunk & { - type: "reference"; -}) | (FileChunk & { - type: "file"; -}) | (ThinkChunk & { - type: "thinking"; -}) | (AudioChunk & { - type: "input_audio"; -}); - -declare function contentChunkFromJSON(jsonString: string): Result; - -declare function contentChunkToJSON(contentChunk: ContentChunk): string; - -declare function contentFromJSON(jsonString: string): Result; - -declare function contentToJSON(content: Content): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequest$ { - /** @deprecated use `ConversationAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$Outbound` instead. */ - type Outbound = ConversationAppendRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendRequestToJSON(conversationAppendRequest: ConversationAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequest$ { - /** @deprecated use `ConversationAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$Outbound` instead. */ - type Outbound = ConversationAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest: ConversationAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEvents$ { - /** @deprecated use `ConversationEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$Outbound` instead. */ - type Outbound = ConversationEvents$Outbound; -} - -/** @internal */ -declare const ConversationEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEvents$Outbound = { - event: string; - data: (FunctionCallEvent$Outbound & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; - }) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; - }); -}; - -/** @internal */ -declare const ConversationEvents$outboundSchema: z.ZodType; - -declare type ConversationEvents = { - /** - * Server side events sent when streaming a conversation response. - */ - event: SSETypes; - data: (FunctionCallEvent & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent & { - type: "conversation.response.error"; - }) | (MessageOutputEvent & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent & { - type: "conversation.response.started"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEventsData$ { - /** @deprecated use `ConversationEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$Outbound` instead. */ - type Outbound = ConversationEventsData$Outbound; -} - -/** @internal */ -declare const ConversationEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEventsData$Outbound = (FunctionCallEvent$Outbound & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; -}) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; -}); - -/** @internal */ -declare const ConversationEventsData$outboundSchema: z.ZodType; - -declare type ConversationEventsData = (FunctionCallEvent & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent & { - type: "conversation.response.error"; -}) | (MessageOutputEvent & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent & { - type: "conversation.response.started"; -}); - -declare function conversationEventsDataFromJSON(jsonString: string): Result; - -declare function conversationEventsDataToJSON(conversationEventsData: ConversationEventsData): string; - -declare function conversationEventsFromJSON(jsonString: string): Result; - -declare function conversationEventsToJSON(conversationEvents: ConversationEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistory$ { - /** @deprecated use `ConversationHistory$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$Outbound` instead. */ - type Outbound = ConversationHistory$Outbound; -} - -/** @internal */ -declare const ConversationHistory$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationHistory$Outbound = { - object: string; - conversation_id: string; - entries: Array; -}; - -/** @internal */ -declare const ConversationHistory$outboundSchema: z.ZodType; - -/** - * Retrieve all entries in a conversation. - */ -declare type ConversationHistory = { - object?: ConversationHistoryObject | undefined; - conversationId: string; - entries: Array; -}; - -declare function conversationHistoryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistoryObject$ { - /** @deprecated use `ConversationHistoryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; - /** @deprecated use `ConversationHistoryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; -} - -/** @internal */ -declare const ConversationHistoryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationHistoryObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationHistoryObject: { - readonly ConversationHistory: "conversation.history"; -}; - -declare type ConversationHistoryObject = ClosedEnum; - -declare function conversationHistoryToJSON(conversationHistory: ConversationHistory): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationInputs$ { - /** @deprecated use `ConversationInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$Outbound` instead. */ - type Outbound = ConversationInputs$Outbound; -} - -/** @internal */ -declare const ConversationInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationInputs$Outbound = string | Array; - -/** @internal */ -declare const ConversationInputs$outboundSchema: z.ZodType; - -declare type ConversationInputs = string | Array; - -declare function conversationInputsFromJSON(jsonString: string): Result; - -declare function conversationInputsToJSON(conversationInputs: ConversationInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessages$ { - /** @deprecated use `ConversationMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$Outbound` instead. */ - type Outbound = ConversationMessages$Outbound; -} - -/** @internal */ -declare const ConversationMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationMessages$Outbound = { - object: string; - conversation_id: string; - messages: Array; -}; - -/** @internal */ -declare const ConversationMessages$outboundSchema: z.ZodType; - -/** - * Similar to the conversation history but only keep the messages - */ -declare type ConversationMessages = { - object?: ConversationMessagesObject | undefined; - conversationId: string; - messages: Array; -}; - -declare function conversationMessagesFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessagesObject$ { - /** @deprecated use `ConversationMessagesObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; - /** @deprecated use `ConversationMessagesObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; -} - -/** @internal */ -declare const ConversationMessagesObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationMessagesObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationMessagesObject: { - readonly ConversationMessages: "conversation.messages"; -}; - -declare type ConversationMessagesObject = ClosedEnum; - -declare function conversationMessagesToJSON(conversationMessages: ConversationMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRequest$ { - /** @deprecated use `ConversationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$Outbound` instead. */ - type Outbound = ConversationRequest$Outbound; -} - -/** @internal */ -declare const ConversationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationRequest$outboundSchema: z.ZodType; - -declare type ConversationRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: HandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationRequestFromJSON(jsonString: string): Result; - -declare function conversationRequestToJSON(conversationRequest: ConversationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponse$ { - /** @deprecated use `ConversationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$Outbound` instead. */ - type Outbound = ConversationResponse$Outbound; -} - -/** @internal */ -declare const ConversationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationResponse$Outbound = { - object: string; - conversation_id: string; - outputs: Array; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ConversationResponse$outboundSchema: z.ZodType; - -/** - * The response after appending new entries to the conversation. - */ -declare type ConversationResponse = { - object?: ConversationResponseObject | undefined; - conversationId: string; - outputs: Array; - usage: ConversationUsageInfo; -}; - -declare function conversationResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponseObject$ { - /** @deprecated use `ConversationResponseObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; - /** @deprecated use `ConversationResponseObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; -} - -/** @internal */ -declare const ConversationResponseObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationResponseObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationResponseObject: { - readonly ConversationResponse: "conversation.response"; -}; - -declare type ConversationResponseObject = ClosedEnum; - -declare function conversationResponseToJSON(conversationResponse: ConversationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequest$ { - /** @deprecated use `ConversationRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$Outbound` instead. */ - type Outbound = ConversationRestartRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartRequestToJSON(conversationRestartRequest: ConversationRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequest$ { - /** @deprecated use `ConversationRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$Outbound` instead. */ - type Outbound = ConversationRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartStreamRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest: ConversationRestartStreamRequest): string; - -declare class Conversations extends ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - start(request: components.ConversationRequest, options?: RequestOptions): Promise; - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1ConversationsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - get(request: operations.AgentsApiV1ConversationsGetRequest, options?: RequestOptions): Promise; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - append(request: operations.AgentsApiV1ConversationsAppendRequest, options?: RequestOptions): Promise; - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - getHistory(request: operations.AgentsApiV1ConversationsHistoryRequest, options?: RequestOptions): Promise; - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - getMessages(request: operations.AgentsApiV1ConversationsMessagesRequest, options?: RequestOptions): Promise; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restart(request: operations.AgentsApiV1ConversationsRestartRequest, options?: RequestOptions): Promise; - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - startStream(request: components.ConversationStreamRequest, options?: RequestOptions): Promise>; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - appendStream(request: operations.AgentsApiV1ConversationsAppendStreamRequest, options?: RequestOptions): Promise>; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restartStream(request: operations.AgentsApiV1ConversationsRestartStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequest$ { - /** @deprecated use `ConversationStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$Outbound` instead. */ - type Outbound = ConversationStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: ConversationStreamRequestHandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationStreamRequestToJSON(conversationStreamRequest: ConversationStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestTools$ { - /** @deprecated use `ConversationStreamRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$Outbound` instead. */ - type Outbound = ConversationStreamRequestTools$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ConversationStreamRequestTools$outboundSchema: z.ZodType; - -declare type ConversationStreamRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function conversationStreamRequestToolsFromJSON(jsonString: string): Result; - -declare function conversationStreamRequestToolsToJSON(conversationStreamRequestTools: ConversationStreamRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationUsageInfo$ { - /** @deprecated use `ConversationUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$Outbound` instead. */ - type Outbound = ConversationUsageInfo$Outbound; -} - -/** @internal */ -declare const ConversationUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationUsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - connector_tokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -/** @internal */ -declare const ConversationUsageInfo$outboundSchema: z.ZodType; - -declare type ConversationUsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - connectorTokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -declare function conversationUsageInfoFromJSON(jsonString: string): Result; - -declare function conversationUsageInfoToJSON(conversationUsageInfo: ConversationUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Data$ { - /** @deprecated use `Data$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Data$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Data$Outbound` instead. */ - type Outbound = Data$Outbound; -} - -/** @internal */ -declare const Data$inboundSchema: z.ZodType; - -/** @internal */ -declare type Data$Outbound = (FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const Data$outboundSchema: z.ZodType; - -declare type Data = (FTModelCard & { - type: "fine-tuned"; -}) | (BaseModelCard & { - type: "base"; -}); - -declare function dataFromJSON(jsonString: string): Result; - -declare function dataToJSON(data: Data): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteFileOut$ { - /** @deprecated use `DeleteFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$Outbound` instead. */ - type Outbound = DeleteFileOut$Outbound; -} - -/** @internal */ -declare const DeleteFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteFileOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteFileOut$outboundSchema: z.ZodType; - -declare type DeleteFileOut = { - /** - * The ID of the deleted file. - */ - id: string; - /** - * The object type that was deleted - */ - object: string; - /** - * The deletion status. - */ - deleted: boolean; -}; - -declare function deleteFileOutFromJSON(jsonString: string): Result; - -declare function deleteFileOutToJSON(deleteFileOut: DeleteFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelOut$ { - /** @deprecated use `DeleteModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$Outbound` instead. */ - type Outbound = DeleteModelOut$Outbound; -} - -/** @internal */ -declare const DeleteModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteModelOut$outboundSchema: z.ZodType; - -declare type DeleteModelOut = { - /** - * The ID of the deleted model. - */ - id: string; - /** - * The object type that was deleted - */ - object?: string | undefined; - /** - * The deletion status - */ - deleted?: boolean | undefined; -}; - -declare function deleteModelOutFromJSON(jsonString: string): Result; - -declare function deleteModelOutToJSON(deleteModelOut: DeleteModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelV1ModelsModelIdDeleteRequest$ { - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$Outbound` instead. */ - type Outbound = DeleteModelV1ModelsModelIdDeleteRequest$Outbound; -} - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelV1ModelsModelIdDeleteRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema: z.ZodType; - -declare type DeleteModelV1ModelsModelIdDeleteRequest = { - /** - * The ID of the model to delete. - */ - modelId: string; -}; - -declare function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString: string): Result; - -declare function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest: DeleteModelV1ModelsModelIdDeleteRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - type Outbound = DeltaMessage$Outbound; -} - -/** @internal */ -declare const DeltaMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -declare const DeltaMessage$outboundSchema: z.ZodType; - -declare type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -declare function deltaMessageFromJSON(jsonString: string): Result; - -declare function deltaMessageToJSON(deltaMessage: DeltaMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Document$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Document$Outbound` instead. */ - type Outbound = Document$Outbound; -} - -/** @internal */ -declare const Document$inboundSchema: z.ZodType; - -/** @internal */ -declare type Document$Outbound = FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - -/** @internal */ -declare const Document$outboundSchema: z.ZodType; - -/** - * Document to run OCR on - */ -declare type Document_2 = FileChunk | DocumentURLChunk | ImageURLChunk; - -declare function documentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryTool$ { - /** @deprecated use `DocumentLibraryTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$Outbound` instead. */ - type Outbound = DocumentLibraryTool$Outbound; -} - -/** @internal */ -declare const DocumentLibraryTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentLibraryTool$Outbound = { - type: string; - library_ids: Array; -}; - -/** @internal */ -declare const DocumentLibraryTool$outboundSchema: z.ZodType; - -declare type DocumentLibraryTool = { - type?: DocumentLibraryToolType | undefined; - /** - * Ids of the library in which to search. - */ - libraryIds: Array; -}; - -declare function documentLibraryToolFromJSON(jsonString: string): Result; - -declare function documentLibraryToolToJSON(documentLibraryTool: DocumentLibraryTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryToolType$ { - /** @deprecated use `DocumentLibraryToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `DocumentLibraryToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const DocumentLibraryToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentLibraryToolType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentLibraryToolType: { - readonly DocumentLibrary: "document_library"; -}; - -declare type DocumentLibraryToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentOut$ { - /** @deprecated use `DocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$Outbound` instead. */ - type Outbound = DocumentOut$Outbound; -} - -/** @internal */ -declare const DocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentOut$Outbound = { - id: string; - library_id: string; - hash: string; - mime_type: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - created_at: string; - last_processed_at?: string | null | undefined; - number_of_pages?: number | null | undefined; - processing_status: string; - uploaded_by_id: string; - uploaded_by_type: string; - tokens_processing_main_content?: number | null | undefined; - tokens_processing_summary?: number | null | undefined; - tokens_processing_total: number; -}; - -/** @internal */ -declare const DocumentOut$outboundSchema: z.ZodType; - -declare type DocumentOut = { - id: string; - libraryId: string; - hash: string; - mimeType: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - createdAt: Date; - lastProcessedAt?: Date | null | undefined; - numberOfPages?: number | null | undefined; - processingStatus: string; - uploadedById: string; - uploadedByType: string; - tokensProcessingMainContent?: number | null | undefined; - tokensProcessingSummary?: number | null | undefined; - tokensProcessingTotal: number; -}; - -declare function documentOutFromJSON(jsonString: string): Result; - -declare function documentOutToJSON(documentOut: DocumentOut): string; - -declare class Documents extends ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - list(request: operations.LibrariesDocumentsListV1Request, options?: RequestOptions): Promise; - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - upload(request: operations.LibrariesDocumentsUploadV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - get(request: operations.LibrariesDocumentsGetV1Request, options?: RequestOptions): Promise; - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - update(request: operations.LibrariesDocumentsUpdateV1Request, options?: RequestOptions): Promise; - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - delete(request: operations.LibrariesDocumentsDeleteV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - textContent(request: operations.LibrariesDocumentsGetTextContentV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - status(request: operations.LibrariesDocumentsGetStatusV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - getSignedUrl(request: operations.LibrariesDocumentsGetSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - extractedTextSignedUrl(request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - reprocess(request: operations.LibrariesDocumentsReprocessV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentTextContent$ { - /** @deprecated use `DocumentTextContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$Outbound` instead. */ - type Outbound = DocumentTextContent$Outbound; -} - -/** @internal */ -declare const DocumentTextContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentTextContent$Outbound = { - text: string; -}; - -/** @internal */ -declare const DocumentTextContent$outboundSchema: z.ZodType; - -declare type DocumentTextContent = { - text: string; -}; - -declare function documentTextContentFromJSON(jsonString: string): Result; - -declare function documentTextContentToJSON(documentTextContent: DocumentTextContent): string; - -declare function documentToJSON(document: Document_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentUpdateIn$ { - /** @deprecated use `DocumentUpdateIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$Outbound` instead. */ - type Outbound = DocumentUpdateIn$Outbound; -} - -/** @internal */ -declare const DocumentUpdateIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentUpdateIn$Outbound = { - name?: string | null | undefined; -}; - -/** @internal */ -declare const DocumentUpdateIn$outboundSchema: z.ZodType; - -declare type DocumentUpdateIn = { - name?: string | null | undefined; -}; - -declare function documentUpdateInFromJSON(jsonString: string): Result; - -declare function documentUpdateInToJSON(documentUpdateIn: DocumentUpdateIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunk$ { - /** @deprecated use `DocumentURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$Outbound` instead. */ - type Outbound = DocumentURLChunk$Outbound; -} - -/** @internal */ -declare const DocumentURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentURLChunk$Outbound = { - document_url: string; - document_name?: string | null | undefined; - type: string; -}; - -/** @internal */ -declare const DocumentURLChunk$outboundSchema: z.ZodType; - -declare type DocumentURLChunk = { - documentUrl: string; - /** - * The filename of the document - */ - documentName?: string | null | undefined; - type?: DocumentURLChunkType | undefined; -}; - -declare function documentURLChunkFromJSON(jsonString: string): Result; - -declare function documentURLChunkToJSON(documentURLChunk: DocumentURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunkType$ { - /** @deprecated use `DocumentURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; - /** @deprecated use `DocumentURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; -} - -/** @internal */ -declare const DocumentURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentURLChunkType: { - readonly DocumentUrl: "document_url"; -}; - -declare type DocumentURLChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingDtype$ { - /** @deprecated use `EmbeddingDtype$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; - /** @deprecated use `EmbeddingDtype$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; -} - -/** @internal */ -declare const EmbeddingDtype$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EmbeddingDtype$outboundSchema: z.ZodNativeEnum; - -declare const EmbeddingDtype: { - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; -}; - -declare type EmbeddingDtype = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequest$ { - /** @deprecated use `EmbeddingRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$Outbound` instead. */ - type Outbound = EmbeddingRequest$Outbound; -} - -/** @internal */ -declare const EmbeddingRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequest$Outbound = { - model: string; - input: string | Array; - output_dimension?: number | null | undefined; - output_dtype?: string | undefined; - encoding_format?: string | undefined; -}; - -/** @internal */ -declare const EmbeddingRequest$outboundSchema: z.ZodType; - -declare type EmbeddingRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to embed. - */ - inputs: string | Array; - /** - * The dimension of the output embeddings. - */ - outputDimension?: number | null | undefined; - outputDtype?: EmbeddingDtype | undefined; - encodingFormat?: EncodingFormat | undefined; -}; - -declare function embeddingRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequestInputs$ { - /** @deprecated use `EmbeddingRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$Outbound` instead. */ - type Outbound = EmbeddingRequestInputs$Outbound; -} - -/** @internal */ -declare const EmbeddingRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const EmbeddingRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to embed. - */ -declare type EmbeddingRequestInputs = string | Array; - -declare function embeddingRequestInputsFromJSON(jsonString: string): Result; - -declare function embeddingRequestInputsToJSON(embeddingRequestInputs: EmbeddingRequestInputs): string; - -declare function embeddingRequestToJSON(embeddingRequest: EmbeddingRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponse$ { - /** @deprecated use `EmbeddingResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$Outbound` instead. */ - type Outbound = EmbeddingResponse$Outbound; -} - -/** @internal */ -declare const EmbeddingResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const EmbeddingResponse$outboundSchema: z.ZodType; - -declare type EmbeddingResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - data: Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponseData$ { - /** @deprecated use `EmbeddingResponseData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$Outbound` instead. */ - type Outbound = EmbeddingResponseData$Outbound; -} - -/** @internal */ -declare const EmbeddingResponseData$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponseData$Outbound = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -/** @internal */ -declare const EmbeddingResponseData$outboundSchema: z.ZodType; - -declare type EmbeddingResponseData = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -declare function embeddingResponseDataFromJSON(jsonString: string): Result; - -declare function embeddingResponseDataToJSON(embeddingResponseData: EmbeddingResponseData): string; - -declare function embeddingResponseFromJSON(jsonString: string): Result; - -declare function embeddingResponseToJSON(embeddingResponse: EmbeddingResponse): string; - -declare class Embeddings extends ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - create(request: components.EmbeddingRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EncodingFormat$ { - /** @deprecated use `EncodingFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; - /** @deprecated use `EncodingFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; -} - -/** @internal */ -declare const EncodingFormat$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EncodingFormat$outboundSchema: z.ZodNativeEnum; - -declare const EncodingFormat: { - readonly Float: "float"; - readonly Base64: "base64"; -}; - -declare type EncodingFormat = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntityType$ { - /** @deprecated use `EntityType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EntityType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const EntityType$inboundSchema: z.ZodType; - -/** @internal */ -declare const EntityType$outboundSchema: z.ZodType; - -/** - * The type of entity, used to share a library. - */ -declare const EntityType: { - readonly User: "User"; - readonly Workspace: "Workspace"; - readonly Org: "Org"; -}; - -/** - * The type of entity, used to share a library. - */ -declare type EntityType = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Entries$ { - /** @deprecated use `Entries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Entries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Entries$Outbound` instead. */ - type Outbound = Entries$Outbound; -} - -/** @internal */ -declare const Entries$inboundSchema: z.ZodType; - -/** @internal */ -declare type Entries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Entries$outboundSchema: z.ZodType; - -declare type Entries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function entriesFromJSON(jsonString: string): Result; - -declare function entriesToJSON(entries: Entries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventOut$ { - /** @deprecated use `EventOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EventOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EventOut$Outbound` instead. */ - type Outbound = EventOut$Outbound; -} - -/** @internal */ -declare const EventOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type EventOut$Outbound = { - name: string; - data?: { - [k: string]: any; - } | null | undefined; - created_at: number; -}; - -/** @internal */ -declare const EventOut$outboundSchema: z.ZodType; - -declare type EventOut = { - /** - * The name of the event. - */ - name: string; - data?: { - [k: string]: any; - } | null | undefined; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; -}; - -declare function eventOutFromJSON(jsonString: string): Result; - -declare function eventOutToJSON(eventOut: EventOut): string; - -declare class EventStream> extends ReadableStream { - constructor(responseBody: ReadableStream, parse: (x: ServerEvent) => IteratorResult); - [Symbol.asyncIterator](): AsyncIterableIterator; -} - -export declare type Fetcher = (input: RequestInfo | URL, init?: RequestInit) => Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileChunk$ { - /** @deprecated use `FileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileChunk$Outbound` instead. */ - type Outbound = FileChunk$Outbound; -} - -/** @internal */ -declare const FileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileChunk$Outbound = { - type: "file"; - file_id: string; -}; - -/** @internal */ -declare const FileChunk$outboundSchema: z.ZodType; - -declare type FileChunk = { - type?: "file" | undefined; - fileId: string; -}; - -declare function fileChunkFromJSON(jsonString: string): Result; - -declare function fileChunkToJSON(fileChunk: FileChunk): string; - -declare function fileFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilePurpose$ { - /** @deprecated use `FilePurpose$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilePurpose$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FilePurpose$inboundSchema: z.ZodType; - -/** @internal */ -declare const FilePurpose$outboundSchema: z.ZodType; - -declare const FilePurpose: { - readonly FineTune: "fine-tune"; - readonly Batch: "batch"; - readonly Ocr: "ocr"; -}; - -declare type FilePurpose = OpenEnum; - -declare class Files extends ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - upload(request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, options?: RequestOptions): Promise; - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - list(request?: operations.FilesApiRoutesListFilesRequest | undefined, options?: RequestOptions): Promise; - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - retrieve(request: operations.FilesApiRoutesRetrieveFileRequest, options?: RequestOptions): Promise; - /** - * Delete File - * - * @remarks - * Delete a file. - */ - delete(request: operations.FilesApiRoutesDeleteFileRequest, options?: RequestOptions): Promise; - /** - * Download File - * - * @remarks - * Download a file - */ - download(request: operations.FilesApiRoutesDownloadFileRequest, options?: RequestOptions): Promise>; - /** - * Get Signed Url - */ - getSignedUrl(request: operations.FilesApiRoutesGetSignedUrlRequest, options?: RequestOptions): Promise; -} - -export declare namespace files { - export { - readableStreamToArrayBuffer, - getContentTypeFromFileName - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDeleteFileRequest$ { - /** @deprecated use `FilesApiRoutesDeleteFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDeleteFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDeleteFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDeleteFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDeleteFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest: FilesApiRoutesDeleteFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDownloadFileRequest$ { - /** @deprecated use `FilesApiRoutesDownloadFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDownloadFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDownloadFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDownloadFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDownloadFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest: FilesApiRoutesDownloadFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesGetSignedUrlRequest$ { - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesGetSignedUrlRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesGetSignedUrlRequest$Outbound = { - file_id: string; - expiry: number; -}; - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesGetSignedUrlRequest = { - fileId: string; - /** - * Number of hours before the url becomes invalid. Defaults to 24h - */ - expiry?: number | undefined; -}; - -declare function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest: FilesApiRoutesGetSignedUrlRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesListFilesRequest$ { - /** @deprecated use `FilesApiRoutesListFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesListFilesRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesListFilesRequest$Outbound = { - page: number; - page_size: number; - sample_type?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: string | null | undefined; -}; - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesListFilesRequest = { - page?: number | undefined; - pageSize?: number | undefined; - sampleType?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: components.FilePurpose | null | undefined; -}; - -declare function filesApiRoutesListFilesRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest: FilesApiRoutesListFilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesRetrieveFileRequest$ { - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesRetrieveFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesRetrieveFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesRetrieveFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesRetrieveFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest: FilesApiRoutesRetrieveFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesUploadFileMultiPartBodyParams$ { - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$Outbound` instead. */ - type Outbound = FilesApiRoutesUploadFileMultiPartBodyParams$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesUploadFileMultiPartBodyParams$Outbound = { - purpose?: string | undefined; - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema: z.ZodType; - -declare type FilesApiRoutesUploadFileMultiPartBodyParams = { - purpose?: components.FilePurpose | undefined; - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString: string): Result; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams: FilesApiRoutesUploadFileMultiPartBodyParams): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSchema$ { - /** @deprecated use `FileSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSchema$Outbound` instead. */ - type Outbound = FileSchema$Outbound; -} - -/** @internal */ -declare const FileSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSchema$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const FileSchema$outboundSchema: z.ZodType; - -declare type FileSchema = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function fileSchemaFromJSON(jsonString: string): Result; - -declare function fileSchemaToJSON(fileSchema: FileSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSignedURL$ { - /** @deprecated use `FileSignedURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$Outbound` instead. */ - type Outbound = FileSignedURL$Outbound; -} - -/** @internal */ -declare const FileSignedURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSignedURL$Outbound = { - url: string; -}; - -/** @internal */ -declare const FileSignedURL$outboundSchema: z.ZodType; - -declare type FileSignedURL = { - url: string; -}; - -declare function fileSignedURLFromJSON(jsonString: string): Result; - -declare function fileSignedURLToJSON(fileSignedURL: FileSignedURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileT$ { - /** @deprecated use `FileT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileT$Outbound` instead. */ - type Outbound = FileT$Outbound; -} - -/** @internal */ -declare const FileT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileT$Outbound = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -declare const FileT$outboundSchema: z.ZodType; - -declare type FileT = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -declare function fileToJSON(fileT: FileT): string; - -declare class Fim extends ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - complete(request: components.FIMCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.FIMCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequest$ { - /** @deprecated use `FIMCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$Outbound` instead. */ - type Outbound = FIMCompletionRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequestStop$ { - /** @deprecated use `FIMCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionRequestStop = string | Array; - -declare function fimCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionRequestStopToJSON(fimCompletionRequestStop: FIMCompletionRequestStop): string; - -declare function fimCompletionRequestToJSON(fimCompletionRequest: FIMCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionResponse$ { - /** @deprecated use `FIMCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$Outbound` instead. */ - type Outbound = FIMCompletionResponse$Outbound; -} - -/** @internal */ -declare const FIMCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const FIMCompletionResponse$outboundSchema: z.ZodType; - -declare type FIMCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function fimCompletionResponseFromJSON(jsonString: string): Result; - -declare function fimCompletionResponseToJSON(fimCompletionResponse: FIMCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequest$ { - /** @deprecated use `FIMCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionStreamRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequestStop$ { - /** @deprecated use `FIMCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionStreamRequestStop = string | Array; - -declare function fimCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop: FIMCompletionStreamRequestStop): string; - -declare function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest: FIMCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FineTuneableModelType$ { - /** @deprecated use `FineTuneableModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; - /** @deprecated use `FineTuneableModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const FineTuneableModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FineTuneableModelType$outboundSchema: z.ZodNativeEnum; - -declare const FineTuneableModelType: { - readonly Completion: "completion"; - readonly Classifier: "classifier"; -}; - -declare type FineTuneableModelType = ClosedEnum; - -declare class FineTuning extends ClientSDK { - private _jobs?; - get jobs(): Jobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const FinishReason$outboundSchema: z.ZodType; - -declare const FinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly ModelLength: "model_length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type FinishReason = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTClassifierLossFunction$ { - /** @deprecated use `FTClassifierLossFunction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; - /** @deprecated use `FTClassifierLossFunction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; -} - -/** @internal */ -declare const FTClassifierLossFunction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTClassifierLossFunction$outboundSchema: z.ZodNativeEnum; - -declare const FTClassifierLossFunction: { - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; -}; - -declare type FTClassifierLossFunction = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCapabilitiesOut$ { - /** @deprecated use `FTModelCapabilitiesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$Outbound` instead. */ - type Outbound = FTModelCapabilitiesOut$Outbound; -} - -/** @internal */ -declare const FTModelCapabilitiesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCapabilitiesOut$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - classification: boolean; -}; - -/** @internal */ -declare const FTModelCapabilitiesOut$outboundSchema: z.ZodType; - -declare type FTModelCapabilitiesOut = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function ftModelCapabilitiesOutFromJSON(jsonString: string): Result; - -declare function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut: FTModelCapabilitiesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCard$ { - /** @deprecated use `FTModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$Outbound` instead. */ - type Outbound = FTModelCard$Outbound; -} - -/** @internal */ -declare const FTModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "fine-tuned"; - job: string; - root: string; - archived: boolean; -}; - -/** @internal */ -declare const FTModelCard$outboundSchema: z.ZodType; - -/** - * Extra fields for fine-tuned models. - */ -declare type FTModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "fine-tuned" | undefined; - job: string; - root: string; - archived?: boolean | undefined; -}; - -declare function ftModelCardFromJSON(jsonString: string): Result; - -declare function ftModelCardToJSON(ftModelCard: FTModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCardType$ { - /** @deprecated use `FTModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; - /** @deprecated use `FTModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; -} - -/** @internal */ -declare const FTModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const FTModelCardType: { - readonly FineTuned: "fine-tuned"; -}; - -declare type FTModelCardType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$Outbound` instead. */ - type Outbound = FunctionCall$Outbound; -} - -/** @internal */ -declare const FunctionCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCall$Outbound = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** @internal */ -declare const FunctionCall$outboundSchema: z.ZodType; - -declare type FunctionCall = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntry$ { - /** @deprecated use `FunctionCallEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$Outbound` instead. */ - type Outbound = FunctionCallEntry$Outbound; -} - -/** @internal */ -declare const FunctionCallEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - name: string; - arguments: FunctionCallEntryArguments$Outbound; -}; - -/** @internal */ -declare const FunctionCallEntry$outboundSchema: z.ZodType; - -declare type FunctionCallEntry = { - object?: FunctionCallEntryObject | undefined; - type?: FunctionCallEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - name: string; - arguments: FunctionCallEntryArguments; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryArguments$ { - /** @deprecated use `FunctionCallEntryArguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$Outbound` instead. */ - type Outbound = FunctionCallEntryArguments$Outbound; -} - -/** @internal */ -declare const FunctionCallEntryArguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntryArguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const FunctionCallEntryArguments$outboundSchema: z.ZodType; - -declare type FunctionCallEntryArguments = { - [k: string]: any; -} | string; - -declare function functionCallEntryArgumentsFromJSON(jsonString: string): Result; - -declare function functionCallEntryArgumentsToJSON(functionCallEntryArguments: FunctionCallEntryArguments): string; - -declare function functionCallEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryObject$ { - /** @deprecated use `FunctionCallEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionCallEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionCallEntryObject = ClosedEnum; - -declare function functionCallEntryToJSON(functionCallEntry: FunctionCallEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryType$ { - /** @deprecated use `FunctionCallEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; - /** @deprecated use `FunctionCallEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryType: { - readonly FunctionCall: "function.call"; -}; - -declare type FunctionCallEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEvent$ { - /** @deprecated use `FunctionCallEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$Outbound` instead. */ - type Outbound = FunctionCallEvent$Outbound; -} - -/** @internal */ -declare const FunctionCallEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - tool_call_id: string; - arguments: string; -}; - -/** @internal */ -declare const FunctionCallEvent$outboundSchema: z.ZodType; - -declare type FunctionCallEvent = { - type?: FunctionCallEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: string; - toolCallId: string; - arguments: string; -}; - -declare function functionCallEventFromJSON(jsonString: string): Result; - -declare function functionCallEventToJSON(functionCallEvent: FunctionCallEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEventType$ { - /** @deprecated use `FunctionCallEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `FunctionCallEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const FunctionCallEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEventType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEventType: { - readonly FunctionCallDelta: "function.call.delta"; -}; - -declare type FunctionCallEventType = ClosedEnum; - -declare function functionCallFromJSON(jsonString: string): Result; - -declare function functionCallToJSON(functionCall: FunctionCall): string; - -declare function functionFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionName$Outbound` instead. */ - type Outbound = FunctionName$Outbound; -} - -/** @internal */ -declare const FunctionName$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -declare const FunctionName$outboundSchema: z.ZodType; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -declare type FunctionName = { - name: string; -}; - -declare function functionNameFromJSON(jsonString: string): Result; - -declare function functionNameToJSON(functionName: FunctionName): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntry$ { - /** @deprecated use `FunctionResultEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$Outbound` instead. */ - type Outbound = FunctionResultEntry$Outbound; -} - -/** @internal */ -declare const FunctionResultEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionResultEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - result: string; -}; - -/** @internal */ -declare const FunctionResultEntry$outboundSchema: z.ZodType; - -declare type FunctionResultEntry = { - object?: FunctionResultEntryObject | undefined; - type?: FunctionResultEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - result: string; -}; - -declare function functionResultEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryObject$ { - /** @deprecated use `FunctionResultEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionResultEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionResultEntryObject = ClosedEnum; - -declare function functionResultEntryToJSON(functionResultEntry: FunctionResultEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryType$ { - /** @deprecated use `FunctionResultEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; - /** @deprecated use `FunctionResultEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryType: { - readonly FunctionResult: "function.result"; -}; - -declare type FunctionResultEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionT$Outbound` instead. */ - type Outbound = FunctionT$Outbound; -} - -/** @internal */ -declare const FunctionT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -/** @internal */ -declare const FunctionT$outboundSchema: z.ZodType; - -declare type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -declare function functionToJSON(functionT: FunctionT): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionTool$ { - /** @deprecated use `FunctionTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$Outbound` instead. */ - type Outbound = FunctionTool$Outbound; -} - -/** @internal */ -declare const FunctionTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionTool$Outbound = { - type: string; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const FunctionTool$outboundSchema: z.ZodType; - -declare type FunctionTool = { - type?: FunctionToolType | undefined; - function: FunctionT; -}; - -declare function functionToolFromJSON(jsonString: string): Result; - -declare function functionToolToJSON(functionTool: FunctionTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionToolType$ { - /** @deprecated use `FunctionToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; - /** @deprecated use `FunctionToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; -} - -/** @internal */ -declare const FunctionToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionToolType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionToolType: { - readonly Function: "function"; -}; - -declare type FunctionToolType = ClosedEnum; - -/** - * Determines the MIME content type based on a file's extension. - * Returns null if the extension is not recognized. - */ -declare function getContentTypeFromFileName(fileName: string): string | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryIn$ { - /** @deprecated use `GithubRepositoryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$Outbound` instead. */ - type Outbound = GithubRepositoryIn$Outbound; -} - -/** @internal */ -declare const GithubRepositoryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryIn$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - token: string; -}; - -/** @internal */ -declare const GithubRepositoryIn$outboundSchema: z.ZodType; - -declare type GithubRepositoryIn = { - type?: GithubRepositoryInType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - token: string; -}; - -declare function githubRepositoryInFromJSON(jsonString: string): Result; - -declare function githubRepositoryInToJSON(githubRepositoryIn: GithubRepositoryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryInType$ { - /** @deprecated use `GithubRepositoryInType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryInType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryInType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryInType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryInType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryInType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOut$ { - /** @deprecated use `GithubRepositoryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$Outbound` instead. */ - type Outbound = GithubRepositoryOut$Outbound; -} - -/** @internal */ -declare const GithubRepositoryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryOut$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - commit_id: string; -}; - -/** @internal */ -declare const GithubRepositoryOut$outboundSchema: z.ZodType; - -declare type GithubRepositoryOut = { - type?: GithubRepositoryOutType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - commitId: string; -}; - -declare function githubRepositoryOutFromJSON(jsonString: string): Result; - -declare function githubRepositoryOutToJSON(githubRepositoryOut: GithubRepositoryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOutType$ { - /** @deprecated use `GithubRepositoryOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryOutType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryOutType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryOutType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace HandoffExecution$ { - /** @deprecated use `HandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `HandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const HandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const HandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const HandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type HandoffExecution = ClosedEnum; - -declare type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes: string[] | null; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; - options: SDKOptions; -}; - -declare interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export declare class HTTPClient { - private options; - private fetcher; - private requestHooks; - private requestErrorHooks; - private responseHooks; - constructor(options?: HTTPClientOptions); - request(request: Request): Promise; - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - clone(): HTTPClient; -} - -/** - * Base class for all HTTP errors. - */ -declare class HTTPClientError extends Error { - /** The underlying cause of the error. */ - readonly cause: unknown; - name: string; - constructor(message: string, opts?: { - cause?: unknown; - }); -} - -export declare interface HTTPClientOptions { - fetcher?: Fetcher; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Hyperparameters$ { - /** @deprecated use `Hyperparameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$Outbound` instead. */ - type Outbound = Hyperparameters$Outbound; -} - -/** @internal */ -declare const Hyperparameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type Hyperparameters$Outbound = CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - -/** @internal */ -declare const Hyperparameters$outboundSchema: z.ZodType; - -declare type Hyperparameters = CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - -declare function hyperparametersFromJSON(jsonString: string): Result; - -declare function hyperparametersToJSON(hyperparameters: Hyperparameters): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationTool$ { - /** @deprecated use `ImageGenerationTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$Outbound` instead. */ - type Outbound = ImageGenerationTool$Outbound; -} - -/** @internal */ -declare const ImageGenerationTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageGenerationTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const ImageGenerationTool$outboundSchema: z.ZodType; - -declare type ImageGenerationTool = { - type?: ImageGenerationToolType | undefined; -}; - -declare function imageGenerationToolFromJSON(jsonString: string): Result; - -declare function imageGenerationToolToJSON(imageGenerationTool: ImageGenerationTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationToolType$ { - /** @deprecated use `ImageGenerationToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; - /** @deprecated use `ImageGenerationToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; -} - -/** @internal */ -declare const ImageGenerationToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageGenerationToolType$outboundSchema: z.ZodNativeEnum; - -declare const ImageGenerationToolType: { - readonly ImageGeneration: "image_generation"; -}; - -declare type ImageGenerationToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURL$Outbound` instead. */ - type Outbound = ImageURL$Outbound; -} - -/** @internal */ -declare const ImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -declare const ImageURL$outboundSchema: z.ZodType; - -declare type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - type Outbound = ImageURLChunk$Outbound; -} - -/** @internal */ -declare const ImageURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -declare const ImageURLChunk$outboundSchema: z.ZodType; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -declare type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -declare function imageURLChunkFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - type Outbound = ImageURLChunkImageURL$Outbound; -} - -/** @internal */ -declare const ImageURLChunkImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -declare const ImageURLChunkImageURL$outboundSchema: z.ZodType; - -declare type ImageURLChunkImageURL = ImageURL | string; - -declare function imageURLChunkImageURLFromJSON(jsonString: string): Result; - -declare function imageURLChunkImageURLToJSON(imageURLChunkImageURL: ImageURLChunkImageURL): string; - -declare function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; -} - -/** @internal */ -declare const ImageURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ImageURLChunkType: { - readonly ImageUrl: "image_url"; -}; - -declare type ImageURLChunkType = ClosedEnum; - -declare function imageURLFromJSON(jsonString: string): Result; - -declare function imageURLToJSON(imageURL: ImageURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InputEntries$ { - /** @deprecated use `InputEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InputEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InputEntries$Outbound` instead. */ - type Outbound = InputEntries$Outbound; -} - -/** @internal */ -declare const InputEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type InputEntries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const InputEntries$outboundSchema: z.ZodType; - -declare type InputEntries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function inputEntriesFromJSON(jsonString: string): Result; - -declare function inputEntriesToJSON(inputEntries: InputEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Inputs$ { - /** @deprecated use `Inputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Inputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Inputs$Outbound` instead. */ - type Outbound = Inputs$Outbound; -} - -/** @internal */ -declare const Inputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Inputs$Outbound = InstructRequestInputs$Outbound | Array; - -/** @internal */ -declare const Inputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type Inputs = InstructRequestInputs | Array; - -declare function inputsFromJSON(jsonString: string): Result; - -declare function inputsToJSON(inputs: Inputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequest$ { - /** @deprecated use `InstructRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$Outbound` instead. */ - type Outbound = InstructRequest$Outbound; -} - -/** @internal */ -declare const InstructRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequest$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequest$outboundSchema: z.ZodType; - -declare type InstructRequest = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputs$ { - /** @deprecated use `InstructRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$Outbound` instead. */ - type Outbound = InstructRequestInputs$Outbound; -} - -/** @internal */ -declare const InstructRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputs$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequestInputs$outboundSchema: z.ZodType; - -declare type InstructRequestInputs = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestInputsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputsMessages$ { - /** @deprecated use `InstructRequestInputsMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$Outbound` instead. */ - type Outbound = InstructRequestInputsMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestInputsMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputsMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestInputsMessages$outboundSchema: z.ZodType; - -declare type InstructRequestInputsMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestInputsMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestInputsMessagesToJSON(instructRequestInputsMessages: InstructRequestInputsMessages): string; - -declare function instructRequestInputsToJSON(instructRequestInputs: InstructRequestInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestMessages$ { - /** @deprecated use `InstructRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$Outbound` instead. */ - type Outbound = InstructRequestMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestMessages$outboundSchema: z.ZodType; - -declare type InstructRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestMessagesToJSON(instructRequestMessages: InstructRequestMessages): string; - -declare function instructRequestToJSON(instructRequest: InstructRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Integrations$ { - /** @deprecated use `Integrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Integrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Integrations$Outbound` instead. */ - type Outbound = Integrations$Outbound; -} - -/** @internal */ -declare const Integrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type Integrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const Integrations$outboundSchema: z.ZodType; - -declare type Integrations = WandbIntegrationOut; - -declare function integrationsFromJSON(jsonString: string): Result; - -declare function integrationsToJSON(integrations: Integrations): string; - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -declare class InvalidRequestError extends HTTPClientError { - name: string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobIn$ { - /** @deprecated use `JobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobIn$Outbound` instead. */ - type Outbound = JobIn$Outbound; -} - -/** @internal */ -declare const JobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobIn$Outbound = { - model: string; - training_files?: Array | undefined; - validation_files?: Array | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - auto_start?: boolean | undefined; - invalid_sample_skip_percentage: number; - job_type?: string | null | undefined; - hyperparameters: CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - repositories?: Array | null | undefined; - classifier_targets?: Array | null | undefined; -}; - -/** @internal */ -declare const JobIn$outboundSchema: z.ZodType; - -declare type JobIn = { - /** - * The name of the model to fine-tune. - */ - model: string; - trainingFiles?: Array | undefined; - /** - * A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - */ - validationFiles?: Array | null | undefined; - /** - * A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - */ - suffix?: string | null | undefined; - /** - * A list of integrations to enable for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * This field will be required in a future release. - */ - autoStart?: boolean | undefined; - invalidSampleSkipPercentage?: number | undefined; - jobType?: FineTuneableModelType | null | undefined; - hyperparameters: CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - repositories?: Array | null | undefined; - classifierTargets?: Array | null | undefined; -}; - -declare function jobInFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInIntegrations$ { - /** @deprecated use `JobInIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$Outbound` instead. */ - type Outbound = JobInIntegrations$Outbound; -} - -/** @internal */ -declare const JobInIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInIntegrations$Outbound = WandbIntegration$Outbound; - -/** @internal */ -declare const JobInIntegrations$outboundSchema: z.ZodType; - -declare type JobInIntegrations = WandbIntegration; - -declare function jobInIntegrationsFromJSON(jsonString: string): Result; - -declare function jobInIntegrationsToJSON(jobInIntegrations: JobInIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInRepositories$ { - /** @deprecated use `JobInRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$Outbound` instead. */ - type Outbound = JobInRepositories$Outbound; -} - -/** @internal */ -declare const JobInRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInRepositories$Outbound = GithubRepositoryIn$Outbound; - -/** @internal */ -declare const JobInRepositories$outboundSchema: z.ZodType; - -declare type JobInRepositories = GithubRepositoryIn; - -declare function jobInRepositoriesFromJSON(jsonString: string): Result; - -declare function jobInRepositoriesToJSON(jobInRepositories: JobInRepositories): string; - -declare function jobInToJSON(jobIn: JobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobMetadataOut$ { - /** @deprecated use `JobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$Outbound` instead. */ - type Outbound = JobMetadataOut$Outbound; -} - -/** @internal */ -declare const JobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; -}; - -/** @internal */ -declare const JobMetadataOut$outboundSchema: z.ZodType; - -declare type JobMetadataOut = { - expectedDurationSeconds?: number | null | undefined; - cost?: number | null | undefined; - costCurrency?: string | null | undefined; - trainTokensPerStep?: number | null | undefined; - trainTokens?: number | null | undefined; - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; -}; - -declare function jobMetadataOutFromJSON(jsonString: string): Result; - -declare function jobMetadataOutToJSON(jobMetadataOut: JobMetadataOut): string; - -declare class Jobs extends ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - create(request: components.JobIn, options?: RequestOptions): Promise; - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - get(request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - cancel(request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - start(request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchCancelBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchCancelBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchCancelBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchCancelBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest: JobsApiRoutesBatchCancelBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest: JobsApiRoutesBatchGetBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobsRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - created_after?: string | null | undefined; - created_by_me: boolean; - status?: Array | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobsRequest = { - page?: number | undefined; - pageSize?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - createdAfter?: Date | null | undefined; - createdByMe?: boolean | undefined; - status?: Array | null | undefined; -}; - -declare function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest: JobsApiRoutesBatchGetBatchJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest = { - /** - * The ID of the model to archive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest: JobsApiRoutesFineTuningArchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest = { - /** - * The ID of the job to cancel. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest: JobsApiRoutesFineTuningCancelFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse: JobsApiRoutesFineTuningCancelFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCreateFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound = components.LegacyJobMetadataOut$Outbound | (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse = components.LegacyJobMetadataOut | (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse: JobsApiRoutesFineTuningCreateFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest = { - /** - * The ID of the job to analyse. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest: JobsApiRoutesFineTuningGetFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse: JobsApiRoutesFineTuningGetFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobsRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - created_after?: string | null | undefined; - created_before?: string | null | undefined; - created_by_me: boolean; - status?: string | null | undefined; - wandb_project?: string | null | undefined; - wandb_name?: string | null | undefined; - suffix?: string | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest = { - /** - * The page number of the results to be returned. - */ - page?: number | undefined; - /** - * The number of items to return per page. - */ - pageSize?: number | undefined; - /** - * The model name used for fine-tuning to filter on. When set, the other results are not displayed. - */ - model?: string | null | undefined; - /** - * The date/time to filter on. When set, the results for previous creation times are not displayed. - */ - createdAfter?: Date | null | undefined; - createdBefore?: Date | null | undefined; - /** - * When set, only return results for jobs created by the API caller. Other results are not displayed. - */ - createdByMe?: boolean | undefined; - /** - * The current job state to filter on. When set, the other results are not displayed. - */ - status?: Status_2 | null | undefined; - /** - * The Weights and Biases project to filter on. When set, the other results are not displayed. - */ - wandbProject?: string | null | undefined; - /** - * The Weight and Biases run name to filter on. When set, the other results are not displayed. - */ - wandbName?: string | null | undefined; - /** - * The model suffix to filter on. When set, the other results are not displayed. - */ - suffix?: string | null | undefined; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest: JobsApiRoutesFineTuningGetFineTuningJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest: JobsApiRoutesFineTuningStartFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse: JobsApiRoutesFineTuningStartFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest = { - /** - * The ID of the model to unarchive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest: JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound = { - model_id: string; - UpdateFTModelIn: components.UpdateFTModelIn$Outbound; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest = { - /** - * The ID of the model to update. - */ - modelId: string; - updateFTModelIn: components.UpdateFTModelIn; -}; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest: JobsApiRoutesFineTuningUpdateFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound = (components.ClassifierFTModelOut$Outbound & { - model_type: "classifier"; -}) | (components.CompletionFTModelOut$Outbound & { - model_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse = (components.ClassifierFTModelOut & { - modelType: "classifier"; -}) | (components.CompletionFTModelOut & { - modelType: "completion"; -}); - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse: JobsApiRoutesFineTuningUpdateFineTunedModelResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOut$ { - /** @deprecated use `JobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOut$Outbound` instead. */ - type Outbound = JobsOut$Outbound; -} - -/** @internal */ -declare const JobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOut$Outbound = { - data?: Array<(ClassifierJobOut$Outbound & { - job_type: "classifier"; - }) | (CompletionJobOut$Outbound & { - job_type: "completion"; - })> | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const JobsOut$outboundSchema: z.ZodType; - -declare type JobsOut = { - data?: Array<(ClassifierJobOut & { - jobType: "classifier"; - }) | (CompletionJobOut & { - jobType: "completion"; - })> | undefined; - object?: JobsOutObject | undefined; - total: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutData$ { - /** @deprecated use `JobsOutData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$Outbound` instead. */ - type Outbound = JobsOutData$Outbound; -} - -/** @internal */ -declare const JobsOutData$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOutData$Outbound = (ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsOutData$outboundSchema: z.ZodType; - -declare type JobsOutData = (ClassifierJobOut & { - jobType: "classifier"; -}) | (CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsOutDataFromJSON(jsonString: string): Result; - -declare function jobsOutDataToJSON(jobsOutData: JobsOutData): string; - -declare function jobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutObject$ { - /** @deprecated use `JobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `JobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const JobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const JobsOutObject: { - readonly List: "list"; -}; - -declare type JobsOutObject = ClosedEnum; - -declare function jobsOutToJSON(jobsOut: JobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobType$ { - /** @deprecated use `JobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `JobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const JobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const JobType: { - readonly Completion: "completion"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type JobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$Outbound` instead. */ - type Outbound = JsonSchema$Outbound; -} - -/** @internal */ -declare const JsonSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -/** @internal */ -declare const JsonSchema$outboundSchema: z.ZodType; - -declare type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -declare function jsonSchemaFromJSON(jsonString: string): Result; - -declare function jsonSchemaToJSON(jsonSchema: JsonSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOut$ { - /** @deprecated use `LegacyJobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$Outbound` instead. */ - type Outbound = LegacyJobMetadataOut$Outbound; -} - -/** @internal */ -declare const LegacyJobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LegacyJobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; - deprecated: boolean; - details: string; - epochs?: number | null | undefined; - training_steps?: number | null | undefined; - object: string; -}; - -/** @internal */ -declare const LegacyJobMetadataOut$outboundSchema: z.ZodType; - -declare type LegacyJobMetadataOut = { - /** - * The approximated time (in seconds) for the fine-tuning process to complete. - */ - expectedDurationSeconds?: number | null | undefined; - /** - * The cost of the fine-tuning job. - */ - cost?: number | null | undefined; - /** - * The currency used for the fine-tuning job cost. - */ - costCurrency?: string | null | undefined; - /** - * The number of tokens consumed by one training step. - */ - trainTokensPerStep?: number | null | undefined; - /** - * The total number of tokens used during the fine-tuning process. - */ - trainTokens?: number | null | undefined; - /** - * The total number of tokens in the training dataset. - */ - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; - deprecated?: boolean | undefined; - details: string; - /** - * The number of complete passes through the entire training dataset. - */ - epochs?: number | null | undefined; - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - object?: LegacyJobMetadataOutObject | undefined; -}; - -declare function legacyJobMetadataOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOutObject$ { - /** @deprecated use `LegacyJobMetadataOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; - /** @deprecated use `LegacyJobMetadataOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; -} - -/** @internal */ -declare const LegacyJobMetadataOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const LegacyJobMetadataOutObject$outboundSchema: z.ZodNativeEnum; - -declare const LegacyJobMetadataOutObject: { - readonly JobMetadata: "job.metadata"; -}; - -declare type LegacyJobMetadataOutObject = ClosedEnum; - -declare function legacyJobMetadataOutToJSON(legacyJobMetadataOut: LegacyJobMetadataOut): string; - -declare class Libraries extends ClientSDK { - private _documents?; - get documents(): Documents; - private _accesses?; - get accesses(): Accesses; - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - list(options?: RequestOptions): Promise; - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - create(request: components.LibraryIn, options?: RequestOptions): Promise; - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - get(request: operations.LibrariesGetV1Request, options?: RequestOptions): Promise; - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - delete(request: operations.LibrariesDeleteV1Request, options?: RequestOptions): Promise; - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - update(request: operations.LibrariesUpdateV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDeleteV1Request$ { - /** @deprecated use `LibrariesDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDeleteV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDeleteV1Request = { - libraryId: string; -}; - -declare function librariesDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDeleteV1RequestToJSON(librariesDeleteV1Request: LibrariesDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsDeleteV1Request$ { - /** @deprecated use `LibrariesDocumentsDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsDeleteV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsDeleteV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request: LibrariesDocumentsDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request: LibrariesDocumentsGetExtractedTextSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request: LibrariesDocumentsGetSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetStatusV1Request$ { - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetStatusV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetStatusV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetStatusV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetStatusV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request: LibrariesDocumentsGetStatusV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetTextContentV1Request$ { - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetTextContentV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetTextContentV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetTextContentV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request: LibrariesDocumentsGetTextContentV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetV1Request$ { - /** @deprecated use `LibrariesDocumentsGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request: LibrariesDocumentsGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsListV1Request$ { - /** @deprecated use `LibrariesDocumentsListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsListV1Request$Outbound = { - library_id: string; - search?: string | null | undefined; - page_size: number; - page: number; - sort_by: string; - sort_order: string; -}; - -/** @internal */ -declare const LibrariesDocumentsListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsListV1Request = { - libraryId: string; - search?: string | null | undefined; - pageSize?: number | undefined; - page?: number | undefined; - sortBy?: string | undefined; - sortOrder?: string | undefined; -}; - -declare function librariesDocumentsListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request: LibrariesDocumentsListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsReprocessV1Request$ { - /** @deprecated use `LibrariesDocumentsReprocessV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsReprocessV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsReprocessV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsReprocessV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsReprocessV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request: LibrariesDocumentsReprocessV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUpdateV1Request$ { - /** @deprecated use `LibrariesDocumentsUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUpdateV1Request$Outbound = { - library_id: string; - document_id: string; - DocumentUpdateIn: components.DocumentUpdateIn$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUpdateV1Request = { - libraryId: string; - documentId: string; - documentUpdateIn: components.DocumentUpdateIn; -}; - -declare function librariesDocumentsUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request: LibrariesDocumentsUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1DocumentUpload$ { - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1DocumentUpload$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1DocumentUpload$Outbound = { - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1DocumentUpload = { - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload: LibrariesDocumentsUploadV1DocumentUpload): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1Request$ { - /** @deprecated use `LibrariesDocumentsUploadV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1Request$Outbound = { - library_id: string; - RequestBody: LibrariesDocumentsUploadV1DocumentUpload$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1Request = { - libraryId: string; - requestBody: LibrariesDocumentsUploadV1DocumentUpload; -}; - -declare function librariesDocumentsUploadV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request: LibrariesDocumentsUploadV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesGetV1Request$ { - /** @deprecated use `LibrariesGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$Outbound` instead. */ - type Outbound = LibrariesGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesGetV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesGetV1Request = { - libraryId: string; -}; - -declare function librariesGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesGetV1RequestToJSON(librariesGetV1Request: LibrariesGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareCreateV1Request$ { - /** @deprecated use `LibrariesShareCreateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$Outbound` instead. */ - type Outbound = LibrariesShareCreateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareCreateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareCreateV1Request$Outbound = { - library_id: string; - SharingIn: components.SharingIn$Outbound; -}; - -/** @internal */ -declare const LibrariesShareCreateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareCreateV1Request = { - libraryId: string; - sharingIn: components.SharingIn; -}; - -declare function librariesShareCreateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request: LibrariesShareCreateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareDeleteV1Request$ { - /** @deprecated use `LibrariesShareDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesShareDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareDeleteV1Request$Outbound = { - library_id: string; - SharingDelete: components.SharingDelete$Outbound; -}; - -/** @internal */ -declare const LibrariesShareDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareDeleteV1Request = { - libraryId: string; - sharingDelete: components.SharingDelete; -}; - -declare function librariesShareDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request: LibrariesShareDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareListV1Request$ { - /** @deprecated use `LibrariesShareListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$Outbound` instead. */ - type Outbound = LibrariesShareListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareListV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesShareListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareListV1Request = { - libraryId: string; -}; - -declare function librariesShareListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareListV1RequestToJSON(librariesShareListV1Request: LibrariesShareListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesUpdateV1Request$ { - /** @deprecated use `LibrariesUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesUpdateV1Request$Outbound = { - library_id: string; - LibraryInUpdate: components.LibraryInUpdate$Outbound; -}; - -/** @internal */ -declare const LibrariesUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesUpdateV1Request = { - libraryId: string; - libraryInUpdate: components.LibraryInUpdate; -}; - -declare function librariesUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesUpdateV1RequestToJSON(librariesUpdateV1Request: LibrariesUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryIn$ { - /** @deprecated use `LibraryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$Outbound` instead. */ - type Outbound = LibraryIn$Outbound; -} - -/** @internal */ -declare const LibraryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryIn$Outbound = { - name: string; - description?: string | null | undefined; - chunk_size?: number | null | undefined; -}; - -/** @internal */ -declare const LibraryIn$outboundSchema: z.ZodType; - -declare type LibraryIn = { - name: string; - description?: string | null | undefined; - chunkSize?: number | null | undefined; -}; - -declare function libraryInFromJSON(jsonString: string): Result; - -declare function libraryInToJSON(libraryIn: LibraryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryInUpdate$ { - /** @deprecated use `LibraryInUpdate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$Outbound` instead. */ - type Outbound = LibraryInUpdate$Outbound; -} - -/** @internal */ -declare const LibraryInUpdate$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryInUpdate$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryInUpdate$outboundSchema: z.ZodType; - -declare type LibraryInUpdate = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function libraryInUpdateFromJSON(jsonString: string): Result; - -declare function libraryInUpdateToJSON(libraryInUpdate: LibraryInUpdate): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryOut$ { - /** @deprecated use `LibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$Outbound` instead. */ - type Outbound = LibraryOut$Outbound; -} - -/** @internal */ -declare const LibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryOut$Outbound = { - id: string; - name: string; - created_at: string; - updated_at: string; - owner_id: string; - owner_type: string; - total_size: number; - nb_documents: number; - chunk_size: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generated_name?: string | null | undefined; - generated_description?: string | null | undefined; - explicit_user_members_count?: number | null | undefined; - explicit_workspace_members_count?: number | null | undefined; - org_sharing_role?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryOut$outboundSchema: z.ZodType; - -declare type LibraryOut = { - id: string; - name: string; - createdAt: Date; - updatedAt: Date; - ownerId: string; - ownerType: string; - totalSize: number; - nbDocuments: number; - chunkSize: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generatedName?: string | null | undefined; - generatedDescription?: string | null | undefined; - explicitUserMembersCount?: number | null | undefined; - explicitWorkspaceMembersCount?: number | null | undefined; - orgSharingRole?: string | null | undefined; -}; - -declare function libraryOutFromJSON(jsonString: string): Result; - -declare function libraryOutToJSON(libraryOut: LibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListDocumentOut$ { - /** @deprecated use `ListDocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$Outbound` instead. */ - type Outbound = ListDocumentOut$Outbound; -} - -/** @internal */ -declare const ListDocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListDocumentOut$Outbound = { - pagination: PaginationInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const ListDocumentOut$outboundSchema: z.ZodType; - -declare type ListDocumentOut = { - pagination: PaginationInfo; - data: Array; -}; - -declare function listDocumentOutFromJSON(jsonString: string): Result; - -declare function listDocumentOutToJSON(listDocumentOut: ListDocumentOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListFilesOut$ { - /** @deprecated use `ListFilesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$Outbound` instead. */ - type Outbound = ListFilesOut$Outbound; -} - -/** @internal */ -declare const ListFilesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListFilesOut$Outbound = { - data: Array; - object: string; - total: number; -}; - -/** @internal */ -declare const ListFilesOut$outboundSchema: z.ZodType; - -declare type ListFilesOut = { - data: Array; - object: string; - total: number; -}; - -declare function listFilesOutFromJSON(jsonString: string): Result; - -declare function listFilesOutToJSON(listFilesOut: ListFilesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListLibraryOut$ { - /** @deprecated use `ListLibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$Outbound` instead. */ - type Outbound = ListLibraryOut$Outbound; -} - -/** @internal */ -declare const ListLibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListLibraryOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListLibraryOut$outboundSchema: z.ZodType; - -declare type ListLibraryOut = { - data: Array; -}; - -declare function listLibraryOutFromJSON(jsonString: string): Result; - -declare function listLibraryOutToJSON(listLibraryOut: ListLibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListSharingOut$ { - /** @deprecated use `ListSharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$Outbound` instead. */ - type Outbound = ListSharingOut$Outbound; -} - -/** @internal */ -declare const ListSharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListSharingOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListSharingOut$outboundSchema: z.ZodType; - -declare type ListSharingOut = { - data: Array; -}; - -declare function listSharingOutFromJSON(jsonString: string): Result; - -declare function listSharingOutToJSON(listSharingOut: ListSharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Loc$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Loc$Outbound` instead. */ - type Outbound = Loc$Outbound; -} - -/** @internal */ -declare const Loc$inboundSchema: z.ZodType; - -/** @internal */ -declare type Loc$Outbound = string | number; - -/** @internal */ -declare const Loc$outboundSchema: z.ZodType; - -declare type Loc = string | number; - -declare function locFromJSON(jsonString: string): Result; - -declare function locToJSON(loc: Loc): string; - -declare interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageEntries$ { - /** @deprecated use `MessageEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$Outbound` instead. */ - type Outbound = MessageEntries$Outbound; -} - -/** @internal */ -declare const MessageEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageEntries$Outbound = MessageInputEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const MessageEntries$outboundSchema: z.ZodType; - -declare type MessageEntries = MessageInputEntry | MessageOutputEntry; - -declare function messageEntriesFromJSON(jsonString: string): Result; - -declare function messageEntriesToJSON(messageEntries: MessageEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputContentChunks$ { - /** @deprecated use `MessageInputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$Outbound` instead. */ - type Outbound = MessageInputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageInputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputContentChunks$Outbound = ToolFileChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageInputContentChunks$outboundSchema: z.ZodType; - -declare type MessageInputContentChunks = ToolFileChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageInputContentChunksFromJSON(jsonString: string): Result; - -declare function messageInputContentChunksToJSON(messageInputContentChunks: MessageInputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntry$ { - /** @deprecated use `MessageInputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$Outbound` instead. */ - type Outbound = MessageInputEntry$Outbound; -} - -/** @internal */ -declare const MessageInputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - role: string; - content: string | Array; - prefix: boolean; -}; - -/** @internal */ -declare const MessageInputEntry$outboundSchema: z.ZodType; - -/** - * Representation of an input message inside the conversation. - */ -declare type MessageInputEntry = { - object?: ObjectT | undefined; - type?: MessageInputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - role: MessageInputEntryRole; - content: string | Array; - prefix?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryContent$ { - /** @deprecated use `MessageInputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$Outbound` instead. */ - type Outbound = MessageInputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageInputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageInputEntryContent$outboundSchema: z.ZodType; - -declare type MessageInputEntryContent = string | Array; - -declare function messageInputEntryContentFromJSON(jsonString: string): Result; - -declare function messageInputEntryContentToJSON(messageInputEntryContent: MessageInputEntryContent): string; - -declare function messageInputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryRole$ { - /** @deprecated use `MessageInputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; - /** @deprecated use `MessageInputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; -} - -/** @internal */ -declare const MessageInputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryRole: { - readonly Assistant: "assistant"; - readonly User: "user"; -}; - -declare type MessageInputEntryRole = ClosedEnum; - -declare function messageInputEntryToJSON(messageInputEntry: MessageInputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryType$ { - /** @deprecated use `MessageInputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; - /** @deprecated use `MessageInputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; -} - -/** @internal */ -declare const MessageInputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryType: { - readonly MessageInput: "message.input"; -}; - -declare type MessageInputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputContentChunks$ { - /** @deprecated use `MessageOutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$Outbound` instead. */ - type Outbound = MessageOutputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageOutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageOutputContentChunks$outboundSchema: z.ZodType; - -declare type MessageOutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageOutputContentChunksFromJSON(jsonString: string): Result; - -declare function messageOutputContentChunksToJSON(messageOutputContentChunks: MessageOutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntry$ { - /** @deprecated use `MessageOutputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$Outbound` instead. */ - type Outbound = MessageOutputEntry$Outbound; -} - -/** @internal */ -declare const MessageOutputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; - role: string; - content: string | Array; -}; - -/** @internal */ -declare const MessageOutputEntry$outboundSchema: z.ZodType; - -declare type MessageOutputEntry = { - object?: MessageOutputEntryObject | undefined; - type?: MessageOutputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; - role?: MessageOutputEntryRole | undefined; - content: string | Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryContent$ { - /** @deprecated use `MessageOutputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$Outbound` instead. */ - type Outbound = MessageOutputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageOutputEntryContent$outboundSchema: z.ZodType; - -declare type MessageOutputEntryContent = string | Array; - -declare function messageOutputEntryContentFromJSON(jsonString: string): Result; - -declare function messageOutputEntryContentToJSON(messageOutputEntryContent: MessageOutputEntryContent): string; - -declare function messageOutputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryObject$ { - /** @deprecated use `MessageOutputEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `MessageOutputEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryObject: { - readonly Entry: "entry"; -}; - -declare type MessageOutputEntryObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryRole$ { - /** @deprecated use `MessageOutputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEntryRole = ClosedEnum; - -declare function messageOutputEntryToJSON(messageOutputEntry: MessageOutputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryType$ { - /** @deprecated use `MessageOutputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; - /** @deprecated use `MessageOutputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryType: { - readonly MessageOutput: "message.output"; -}; - -declare type MessageOutputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEvent$ { - /** @deprecated use `MessageOutputEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$Outbound` instead. */ - type Outbound = MessageOutputEvent$Outbound; -} - -/** @internal */ -declare const MessageOutputEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - content_index: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - role: string; - content: string | OutputContentChunks$Outbound; -}; - -/** @internal */ -declare const MessageOutputEvent$outboundSchema: z.ZodType; - -declare type MessageOutputEvent = { - type?: MessageOutputEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - contentIndex?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - role?: MessageOutputEventRole | undefined; - content: string | OutputContentChunks; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventContent$ { - /** @deprecated use `MessageOutputEventContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$Outbound` instead. */ - type Outbound = MessageOutputEventContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEventContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEventContent$Outbound = string | OutputContentChunks$Outbound; - -/** @internal */ -declare const MessageOutputEventContent$outboundSchema: z.ZodType; - -declare type MessageOutputEventContent = string | OutputContentChunks; - -declare function messageOutputEventContentFromJSON(jsonString: string): Result; - -declare function messageOutputEventContentToJSON(messageOutputEventContent: MessageOutputEventContent): string; - -declare function messageOutputEventFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventRole$ { - /** @deprecated use `MessageOutputEventRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEventRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEventRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEventRole = ClosedEnum; - -declare function messageOutputEventToJSON(messageOutputEvent: MessageOutputEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventType$ { - /** @deprecated use `MessageOutputEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; - /** @deprecated use `MessageOutputEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; -} - -/** @internal */ -declare const MessageOutputEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventType: { - readonly MessageOutputDelta: "message.output.delta"; -}; - -declare type MessageOutputEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Messages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Messages$Outbound` instead. */ - type Outbound = Messages$Outbound; -} - -/** @internal */ -declare const Messages$inboundSchema: z.ZodType; - -/** @internal */ -declare type Messages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Messages$outboundSchema: z.ZodType; - -declare type Messages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function messagesFromJSON(jsonString: string): Result; - -declare function messagesToJSON(messages: Messages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MetricOut$ { - /** @deprecated use `MetricOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MetricOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MetricOut$Outbound` instead. */ - type Outbound = MetricOut$Outbound; -} - -/** @internal */ -declare const MetricOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type MetricOut$Outbound = { - train_loss?: number | null | undefined; - valid_loss?: number | null | undefined; - valid_mean_token_accuracy?: number | null | undefined; -}; - -/** @internal */ -declare const MetricOut$outboundSchema: z.ZodType; - -/** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ -declare type MetricOut = { - trainLoss?: number | null | undefined; - validLoss?: number | null | undefined; - validMeanTokenAccuracy?: number | null | undefined; -}; - -declare function metricOutFromJSON(jsonString: string): Result; - -declare function metricOutToJSON(metricOut: MetricOut): string; - -export declare class Mistral extends ClientSDK { - private _models?; - get models(): Models; - private _beta?; - get beta(): Beta; - private _files?; - get files(): Files; - private _fineTuning?; - get fineTuning(): FineTuning; - private _batch?; - get batch(): Batch; - private _chat?; - get chat(): Chat; - private _fim?; - get fim(): Fim; - private _agents?; - get agents(): Agents; - private _embeddings?; - get embeddings(): Embeddings; - private _classifiers?; - get classifiers(): Classifiers; - private _ocr?; - get ocr(): Ocr; - private _audio?; - get audio(): Audio_2; -} - -declare class MistralAgents extends ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - create(request: components.AgentCreationRequest, options?: RequestOptions): Promise; - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1AgentsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - get(request: operations.AgentsApiV1AgentsGetRequest, options?: RequestOptions): Promise; - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - update(request: operations.AgentsApiV1AgentsUpdateRequest, options?: RequestOptions): Promise; - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - updateVersion(request: operations.AgentsApiV1AgentsUpdateVersionRequest, options?: RequestOptions): Promise; -} - -declare class MistralJobs extends ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - create(request: components.BatchJobIn, options?: RequestOptions): Promise; - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - get(request: operations.JobsApiRoutesBatchGetBatchJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - cancel(request: operations.JobsApiRoutesBatchCancelBatchJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MistralPromptMode$ { - /** @deprecated use `MistralPromptMode$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MistralPromptMode$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const MistralPromptMode$inboundSchema: z.ZodType; - -/** @internal */ -declare const MistralPromptMode$outboundSchema: z.ZodType; - -declare const MistralPromptMode: { - readonly Reasoning: "reasoning"; -}; - -declare type MistralPromptMode = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelCapabilities$ { - /** @deprecated use `ModelCapabilities$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$Outbound` instead. */ - type Outbound = ModelCapabilities$Outbound; -} - -/** @internal */ -declare const ModelCapabilities$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelCapabilities$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - vision: boolean; - classification: boolean; -}; - -/** @internal */ -declare const ModelCapabilities$outboundSchema: z.ZodType; - -declare type ModelCapabilities = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - vision?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function modelCapabilitiesFromJSON(jsonString: string): Result; - -declare function modelCapabilitiesToJSON(modelCapabilities: ModelCapabilities): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversation$ { - /** @deprecated use `ModelConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$Outbound` instead. */ - type Outbound = ModelConversation$Outbound; -} - -/** @internal */ -declare const ModelConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversation$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - model: string; -}; - -/** @internal */ -declare const ModelConversation$outboundSchema: z.ZodType; - -declare type ModelConversation = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: ModelConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - model: string; -}; - -declare function modelConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationObject$ { - /** @deprecated use `ModelConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `ModelConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const ModelConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const ModelConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type ModelConversationObject = ClosedEnum; - -declare function modelConversationToJSON(modelConversation: ModelConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationTools$ { - /** @deprecated use `ModelConversationTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$Outbound` instead. */ - type Outbound = ModelConversationTools$Outbound; -} - -/** @internal */ -declare const ModelConversationTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversationTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ModelConversationTools$outboundSchema: z.ZodType; - -declare type ModelConversationTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function modelConversationToolsFromJSON(jsonString: string): Result; - -declare function modelConversationToolsToJSON(modelConversationTools: ModelConversationTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelList$ { - /** @deprecated use `ModelList$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelList$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelList$Outbound` instead. */ - type Outbound = ModelList$Outbound; -} - -/** @internal */ -declare const ModelList$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelList$Outbound = { - object: string; - data?: Array<(FTModelCard$Outbound & { - type: "fine-tuned"; - }) | (BaseModelCard$Outbound & { - type: "base"; - })> | undefined; -}; - -/** @internal */ -declare const ModelList$outboundSchema: z.ZodType; - -declare type ModelList = { - object?: string | undefined; - data?: Array<(FTModelCard & { - type: "fine-tuned"; - }) | (BaseModelCard & { - type: "base"; - })> | undefined; -}; - -declare function modelListFromJSON(jsonString: string): Result; - -declare function modelListToJSON(modelList: ModelList): string; - -declare class Models extends ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - list(options?: RequestOptions): Promise; - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - retrieve(request: operations.RetrieveModelV1ModelsModelIdGetRequest, options?: RequestOptions): Promise; - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - delete(request: operations.DeleteModelV1ModelsModelIdDeleteRequest, options?: RequestOptions): Promise; - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - update(request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - archive(request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - unarchive(request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelType$ { - /** @deprecated use `ModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `ModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const ModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelType$outboundSchema: z.ZodNativeEnum; - -declare const ModelType: { - readonly Completion: "completion"; -}; - -declare type ModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationObject$ { - /** @deprecated use `ModerationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$Outbound` instead. */ - type Outbound = ModerationObject$Outbound; -} - -/** @internal */ -declare const ModerationObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationObject$Outbound = { - categories?: { - [k: string]: boolean; - } | undefined; - category_scores?: { - [k: string]: number; - } | undefined; -}; - -/** @internal */ -declare const ModerationObject$outboundSchema: z.ZodType; - -declare type ModerationObject = { - /** - * Moderation result thresholds - */ - categories?: { - [k: string]: boolean; - } | undefined; - /** - * Moderation result - */ - categoryScores?: { - [k: string]: number; - } | undefined; -}; - -declare function moderationObjectFromJSON(jsonString: string): Result; - -declare function moderationObjectToJSON(moderationObject: ModerationObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationResponse$ { - /** @deprecated use `ModerationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$Outbound` instead. */ - type Outbound = ModerationResponse$Outbound; -} - -/** @internal */ -declare const ModerationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationResponse$Outbound = { - id: string; - model: string; - results: Array; -}; - -/** @internal */ -declare const ModerationResponse$outboundSchema: z.ZodType; - -declare type ModerationResponse = { - id: string; - model: string; - results: Array; -}; - -declare function moderationResponseFromJSON(jsonString: string): Result; - -declare function moderationResponseToJSON(moderationResponse: ModerationResponse): string; - -declare type OAuth2PasswordFlow = { - username: string; - password: string; - clientID?: string | undefined; - clientSecret?: string | undefined; - tokenURL: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ObjectT$ { - /** @deprecated use `ObjectT$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ObjectT$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ObjectT$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ObjectT$outboundSchema: z.ZodNativeEnum; - -declare const ObjectT: { - readonly Entry: "entry"; -}; - -declare type ObjectT = ClosedEnum; - -declare class Ocr extends ClientSDK { - /** - * OCR - */ - process(request: components.OCRRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRImageObject$ { - /** @deprecated use `OCRImageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$Outbound` instead. */ - type Outbound = OCRImageObject$Outbound; -} - -/** @internal */ -declare const OCRImageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRImageObject$Outbound = { - id: string; - top_left_x: number | null; - top_left_y: number | null; - bottom_right_x: number | null; - bottom_right_y: number | null; - image_base64?: string | null | undefined; - image_annotation?: string | null | undefined; -}; - -/** @internal */ -declare const OCRImageObject$outboundSchema: z.ZodType; - -declare type OCRImageObject = { - /** - * Image ID for extracted image in a page - */ - id: string; - /** - * X coordinate of top-left corner of the extracted image - */ - topLeftX: number | null; - /** - * Y coordinate of top-left corner of the extracted image - */ - topLeftY: number | null; - /** - * X coordinate of bottom-right corner of the extracted image - */ - bottomRightX: number | null; - /** - * Y coordinate of bottom-right corner of the extracted image - */ - bottomRightY: number | null; - /** - * Base64 string of the extracted image - */ - imageBase64?: string | null | undefined; - /** - * Annotation of the extracted image in json str - */ - imageAnnotation?: string | null | undefined; -}; - -declare function ocrImageObjectFromJSON(jsonString: string): Result; - -declare function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageDimensions$ { - /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$Outbound` instead. */ - type Outbound = OCRPageDimensions$Outbound; -} - -/** @internal */ -declare const OCRPageDimensions$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageDimensions$Outbound = { - dpi: number; - height: number; - width: number; -}; - -/** @internal */ -declare const OCRPageDimensions$outboundSchema: z.ZodType; - -declare type OCRPageDimensions = { - /** - * Dots per inch of the page-image - */ - dpi: number; - /** - * Height of the image in pixels - */ - height: number; - /** - * Width of the image in pixels - */ - width: number; -}; - -declare function ocrPageDimensionsFromJSON(jsonString: string): Result; - -declare function ocrPageDimensionsToJSON(ocrPageDimensions: OCRPageDimensions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageObject$ { - /** @deprecated use `OCRPageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$Outbound` instead. */ - type Outbound = OCRPageObject$Outbound; -} - -/** @internal */ -declare const OCRPageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageObject$Outbound = { - index: number; - markdown: string; - images: Array; - dimensions: OCRPageDimensions$Outbound | null; -}; - -/** @internal */ -declare const OCRPageObject$outboundSchema: z.ZodType; - -declare type OCRPageObject = { - /** - * The page index in a pdf document starting from 0 - */ - index: number; - /** - * The markdown string response of the page - */ - markdown: string; - /** - * List of all extracted images in the page - */ - images: Array; - /** - * The dimensions of the PDF Page's screenshot image - */ - dimensions: OCRPageDimensions | null; -}; - -declare function ocrPageObjectFromJSON(jsonString: string): Result; - -declare function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRRequest$ { - /** @deprecated use `OCRRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$Outbound` instead. */ - type Outbound = OCRRequest$Outbound; -} - -/** @internal */ -declare const OCRRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRRequest$Outbound = { - model: string | null; - id?: string | undefined; - document: FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - pages?: Array | null | undefined; - include_image_base64?: boolean | null | undefined; - image_limit?: number | null | undefined; - image_min_size?: number | null | undefined; - bbox_annotation_format?: ResponseFormat$Outbound | null | undefined; - document_annotation_format?: ResponseFormat$Outbound | null | undefined; -}; - -/** @internal */ -declare const OCRRequest$outboundSchema: z.ZodType; - -declare type OCRRequest = { - model: string | null; - id?: string | undefined; - /** - * Document to run OCR on - */ - document: FileChunk | DocumentURLChunk | ImageURLChunk; - /** - * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - */ - pages?: Array | null | undefined; - /** - * Include image URLs in response - */ - includeImageBase64?: boolean | null | undefined; - /** - * Max images to extract - */ - imageLimit?: number | null | undefined; - /** - * Minimum height and width of image to extract - */ - imageMinSize?: number | null | undefined; - /** - * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - */ - bboxAnnotationFormat?: ResponseFormat | null | undefined; - /** - * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - */ - documentAnnotationFormat?: ResponseFormat | null | undefined; -}; - -declare function ocrRequestFromJSON(jsonString: string): Result; - -declare function ocrRequestToJSON(ocrRequest: OCRRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRResponse$ { - /** @deprecated use `OCRResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$Outbound` instead. */ - type Outbound = OCRResponse$Outbound; -} - -/** @internal */ -declare const OCRResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRResponse$Outbound = { - pages: Array; - model: string; - document_annotation?: string | null | undefined; - usage_info: OCRUsageInfo$Outbound; -}; - -/** @internal */ -declare const OCRResponse$outboundSchema: z.ZodType; - -declare type OCRResponse = { - /** - * List of OCR info for pages. - */ - pages: Array; - /** - * The model used to generate the OCR. - */ - model: string; - /** - * Formatted response in the request_format if provided in json str - */ - documentAnnotation?: string | null | undefined; - usageInfo: OCRUsageInfo; -}; - -declare function ocrResponseFromJSON(jsonString: string): Result; - -declare function ocrResponseToJSON(ocrResponse: OCRResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRUsageInfo$ { - /** @deprecated use `OCRUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$Outbound` instead. */ - type Outbound = OCRUsageInfo$Outbound; -} - -/** @internal */ -declare const OCRUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRUsageInfo$Outbound = { - pages_processed: number; - doc_size_bytes?: number | null | undefined; -}; - -/** @internal */ -declare const OCRUsageInfo$outboundSchema: z.ZodType; - -declare type OCRUsageInfo = { - /** - * Number of pages processed - */ - pagesProcessed: number; - /** - * Document size in bytes - */ - docSizeBytes?: number | null | undefined; -}; - -declare function ocrUsageInfoFromJSON(jsonString: string): Result; - -declare function ocrUsageInfoToJSON(ocrUsageInfo: OCRUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$ { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$_2 { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound_2; -} - -/** @internal */ -declare const One$inboundSchema: z.ZodType; - -/** @internal */ -declare const One$inboundSchema_2: z.ZodType; - -/** @internal */ -declare type One$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare type One$Outbound_2 = (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const One$outboundSchema: z.ZodType; - -/** @internal */ -declare const One$outboundSchema_2: z.ZodType; - -declare type One = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare type One_2 = (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function oneFromJSON(jsonString: string): Result; - -declare function oneFromJSON_2(jsonString: string): Result; - -declare function oneToJSON(one: One): string; - -declare function oneToJSON_2(one: One_2): string; - -declare type OpenEnum = Prettify | Unrecognized; - -declare namespace operations { - export { - agentsApiV1AgentsGetRequestToJSON, - agentsApiV1AgentsGetRequestFromJSON, - AgentsApiV1AgentsGetRequest, - AgentsApiV1AgentsGetRequest$inboundSchema, - AgentsApiV1AgentsGetRequest$Outbound, - AgentsApiV1AgentsGetRequest$outboundSchema, - AgentsApiV1AgentsGetRequest$, - agentsApiV1AgentsListRequestToJSON, - agentsApiV1AgentsListRequestFromJSON, - AgentsApiV1AgentsListRequest, - AgentsApiV1AgentsListRequest$inboundSchema, - AgentsApiV1AgentsListRequest$Outbound, - AgentsApiV1AgentsListRequest$outboundSchema, - AgentsApiV1AgentsListRequest$, - agentsApiV1AgentsUpdateRequestToJSON, - agentsApiV1AgentsUpdateRequestFromJSON, - AgentsApiV1AgentsUpdateRequest, - AgentsApiV1AgentsUpdateRequest$inboundSchema, - AgentsApiV1AgentsUpdateRequest$Outbound, - AgentsApiV1AgentsUpdateRequest$outboundSchema, - AgentsApiV1AgentsUpdateRequest$, - agentsApiV1AgentsUpdateVersionRequestToJSON, - agentsApiV1AgentsUpdateVersionRequestFromJSON, - AgentsApiV1AgentsUpdateVersionRequest, - AgentsApiV1AgentsUpdateVersionRequest$inboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$Outbound, - AgentsApiV1AgentsUpdateVersionRequest$outboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$, - agentsApiV1ConversationsAppendRequestToJSON, - agentsApiV1ConversationsAppendRequestFromJSON, - AgentsApiV1ConversationsAppendRequest, - AgentsApiV1ConversationsAppendRequest$inboundSchema, - AgentsApiV1ConversationsAppendRequest$Outbound, - AgentsApiV1ConversationsAppendRequest$outboundSchema, - AgentsApiV1ConversationsAppendRequest$, - agentsApiV1ConversationsAppendStreamRequestToJSON, - agentsApiV1ConversationsAppendStreamRequestFromJSON, - AgentsApiV1ConversationsAppendStreamRequest, - AgentsApiV1ConversationsAppendStreamRequest$inboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$Outbound, - AgentsApiV1ConversationsAppendStreamRequest$outboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$, - agentsApiV1ConversationsGetRequestToJSON, - agentsApiV1ConversationsGetRequestFromJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON, - AgentsApiV1ConversationsGetRequest, - AgentsApiV1ConversationsGetResponseV1ConversationsGet, - AgentsApiV1ConversationsGetRequest$inboundSchema, - AgentsApiV1ConversationsGetRequest$Outbound, - AgentsApiV1ConversationsGetRequest$outboundSchema, - AgentsApiV1ConversationsGetRequest$, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$, - agentsApiV1ConversationsHistoryRequestToJSON, - agentsApiV1ConversationsHistoryRequestFromJSON, - AgentsApiV1ConversationsHistoryRequest, - AgentsApiV1ConversationsHistoryRequest$inboundSchema, - AgentsApiV1ConversationsHistoryRequest$Outbound, - AgentsApiV1ConversationsHistoryRequest$outboundSchema, - AgentsApiV1ConversationsHistoryRequest$, - agentsApiV1ConversationsListRequestToJSON, - agentsApiV1ConversationsListRequestFromJSON, - responseBodyToJSON, - responseBodyFromJSON, - AgentsApiV1ConversationsListRequest, - ResponseBody, - AgentsApiV1ConversationsListRequest$inboundSchema, - AgentsApiV1ConversationsListRequest$Outbound, - AgentsApiV1ConversationsListRequest$outboundSchema, - AgentsApiV1ConversationsListRequest$, - ResponseBody$inboundSchema, - ResponseBody$Outbound, - ResponseBody$outboundSchema, - ResponseBody$, - agentsApiV1ConversationsMessagesRequestToJSON, - agentsApiV1ConversationsMessagesRequestFromJSON, - AgentsApiV1ConversationsMessagesRequest, - AgentsApiV1ConversationsMessagesRequest$inboundSchema, - AgentsApiV1ConversationsMessagesRequest$Outbound, - AgentsApiV1ConversationsMessagesRequest$outboundSchema, - AgentsApiV1ConversationsMessagesRequest$, - agentsApiV1ConversationsRestartRequestToJSON, - agentsApiV1ConversationsRestartRequestFromJSON, - AgentsApiV1ConversationsRestartRequest, - AgentsApiV1ConversationsRestartRequest$inboundSchema, - AgentsApiV1ConversationsRestartRequest$Outbound, - AgentsApiV1ConversationsRestartRequest$outboundSchema, - AgentsApiV1ConversationsRestartRequest$, - agentsApiV1ConversationsRestartStreamRequestToJSON, - agentsApiV1ConversationsRestartStreamRequestFromJSON, - AgentsApiV1ConversationsRestartStreamRequest, - AgentsApiV1ConversationsRestartStreamRequest$inboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$Outbound, - AgentsApiV1ConversationsRestartStreamRequest$outboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$, - deleteModelV1ModelsModelIdDeleteRequestToJSON, - deleteModelV1ModelsModelIdDeleteRequestFromJSON, - DeleteModelV1ModelsModelIdDeleteRequest, - DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$Outbound, - DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$, - filesApiRoutesDeleteFileRequestToJSON, - filesApiRoutesDeleteFileRequestFromJSON, - FilesApiRoutesDeleteFileRequest, - FilesApiRoutesDeleteFileRequest$inboundSchema, - FilesApiRoutesDeleteFileRequest$Outbound, - FilesApiRoutesDeleteFileRequest$outboundSchema, - FilesApiRoutesDeleteFileRequest$, - filesApiRoutesDownloadFileRequestToJSON, - filesApiRoutesDownloadFileRequestFromJSON, - FilesApiRoutesDownloadFileRequest, - FilesApiRoutesDownloadFileRequest$inboundSchema, - FilesApiRoutesDownloadFileRequest$Outbound, - FilesApiRoutesDownloadFileRequest$outboundSchema, - FilesApiRoutesDownloadFileRequest$, - filesApiRoutesGetSignedUrlRequestToJSON, - filesApiRoutesGetSignedUrlRequestFromJSON, - FilesApiRoutesGetSignedUrlRequest, - FilesApiRoutesGetSignedUrlRequest$inboundSchema, - FilesApiRoutesGetSignedUrlRequest$Outbound, - FilesApiRoutesGetSignedUrlRequest$outboundSchema, - FilesApiRoutesGetSignedUrlRequest$, - filesApiRoutesListFilesRequestToJSON, - filesApiRoutesListFilesRequestFromJSON, - FilesApiRoutesListFilesRequest, - FilesApiRoutesListFilesRequest$inboundSchema, - FilesApiRoutesListFilesRequest$Outbound, - FilesApiRoutesListFilesRequest$outboundSchema, - FilesApiRoutesListFilesRequest$, - filesApiRoutesRetrieveFileRequestToJSON, - filesApiRoutesRetrieveFileRequestFromJSON, - FilesApiRoutesRetrieveFileRequest, - FilesApiRoutesRetrieveFileRequest$inboundSchema, - FilesApiRoutesRetrieveFileRequest$Outbound, - FilesApiRoutesRetrieveFileRequest$outboundSchema, - FilesApiRoutesRetrieveFileRequest$, - filesApiRoutesUploadFileMultiPartBodyParamsToJSON, - filesApiRoutesUploadFileMultiPartBodyParamsFromJSON, - FilesApiRoutesUploadFileMultiPartBodyParams, - FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$Outbound, - FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$, - jobsApiRoutesBatchCancelBatchJobRequestToJSON, - jobsApiRoutesBatchCancelBatchJobRequestFromJSON, - JobsApiRoutesBatchCancelBatchJobRequest, - JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$Outbound, - JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobRequestToJSON, - jobsApiRoutesBatchGetBatchJobRequestFromJSON, - JobsApiRoutesBatchGetBatchJobRequest, - JobsApiRoutesBatchGetBatchJobRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$Outbound, - JobsApiRoutesBatchGetBatchJobRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobsRequestToJSON, - jobsApiRoutesBatchGetBatchJobsRequestFromJSON, - JobsApiRoutesBatchGetBatchJobsRequest, - JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$Outbound, - JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningCancelFineTuningJobRequest, - JobsApiRoutesFineTuningCancelFineTuningJobResponse, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$, - oneToJSON_2 as oneToJSON, - oneFromJSON_2 as oneFromJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON, - One_2 as One, - JobsApiRoutesFineTuningCreateFineTuningJobResponse, - One$inboundSchema_2 as One$inboundSchema, - One$Outbound_2 as One$Outbound, - One$outboundSchema_2 as One$outboundSchema, - One$_2 as One$, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningGetFineTuningJobRequest, - JobsApiRoutesFineTuningGetFineTuningJobResponse, - JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$, - JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON, - Status_2 as Status, - JobsApiRoutesFineTuningGetFineTuningJobsRequest, - Status$inboundSchema_2 as Status$inboundSchema, - Status$outboundSchema_2 as Status$outboundSchema, - Status$_2 as Status$, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$, - jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningStartFineTuningJobRequest, - JobsApiRoutesFineTuningStartFineTuningJobResponse, - JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$, - JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$, - librariesDeleteV1RequestToJSON, - librariesDeleteV1RequestFromJSON, - LibrariesDeleteV1Request, - LibrariesDeleteV1Request$inboundSchema, - LibrariesDeleteV1Request$Outbound, - LibrariesDeleteV1Request$outboundSchema, - LibrariesDeleteV1Request$, - librariesDocumentsDeleteV1RequestToJSON, - librariesDocumentsDeleteV1RequestFromJSON, - LibrariesDocumentsDeleteV1Request, - LibrariesDocumentsDeleteV1Request$inboundSchema, - LibrariesDocumentsDeleteV1Request$Outbound, - LibrariesDocumentsDeleteV1Request$outboundSchema, - LibrariesDocumentsDeleteV1Request$, - librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON, - librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$, - librariesDocumentsGetSignedUrlV1RequestToJSON, - librariesDocumentsGetSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetSignedUrlV1Request, - LibrariesDocumentsGetSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$Outbound, - LibrariesDocumentsGetSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$, - librariesDocumentsGetStatusV1RequestToJSON, - librariesDocumentsGetStatusV1RequestFromJSON, - LibrariesDocumentsGetStatusV1Request, - LibrariesDocumentsGetStatusV1Request$inboundSchema, - LibrariesDocumentsGetStatusV1Request$Outbound, - LibrariesDocumentsGetStatusV1Request$outboundSchema, - LibrariesDocumentsGetStatusV1Request$, - librariesDocumentsGetTextContentV1RequestToJSON, - librariesDocumentsGetTextContentV1RequestFromJSON, - LibrariesDocumentsGetTextContentV1Request, - LibrariesDocumentsGetTextContentV1Request$inboundSchema, - LibrariesDocumentsGetTextContentV1Request$Outbound, - LibrariesDocumentsGetTextContentV1Request$outboundSchema, - LibrariesDocumentsGetTextContentV1Request$, - librariesDocumentsGetV1RequestToJSON, - librariesDocumentsGetV1RequestFromJSON, - LibrariesDocumentsGetV1Request, - LibrariesDocumentsGetV1Request$inboundSchema, - LibrariesDocumentsGetV1Request$Outbound, - LibrariesDocumentsGetV1Request$outboundSchema, - LibrariesDocumentsGetV1Request$, - librariesDocumentsListV1RequestToJSON, - librariesDocumentsListV1RequestFromJSON, - LibrariesDocumentsListV1Request, - LibrariesDocumentsListV1Request$inboundSchema, - LibrariesDocumentsListV1Request$Outbound, - LibrariesDocumentsListV1Request$outboundSchema, - LibrariesDocumentsListV1Request$, - librariesDocumentsReprocessV1RequestToJSON, - librariesDocumentsReprocessV1RequestFromJSON, - LibrariesDocumentsReprocessV1Request, - LibrariesDocumentsReprocessV1Request$inboundSchema, - LibrariesDocumentsReprocessV1Request$Outbound, - LibrariesDocumentsReprocessV1Request$outboundSchema, - LibrariesDocumentsReprocessV1Request$, - librariesDocumentsUpdateV1RequestToJSON, - librariesDocumentsUpdateV1RequestFromJSON, - LibrariesDocumentsUpdateV1Request, - LibrariesDocumentsUpdateV1Request$inboundSchema, - LibrariesDocumentsUpdateV1Request$Outbound, - LibrariesDocumentsUpdateV1Request$outboundSchema, - LibrariesDocumentsUpdateV1Request$, - librariesDocumentsUploadV1DocumentUploadToJSON, - librariesDocumentsUploadV1DocumentUploadFromJSON, - librariesDocumentsUploadV1RequestToJSON, - librariesDocumentsUploadV1RequestFromJSON, - LibrariesDocumentsUploadV1DocumentUpload, - LibrariesDocumentsUploadV1Request, - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$Outbound, - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$, - LibrariesDocumentsUploadV1Request$inboundSchema, - LibrariesDocumentsUploadV1Request$Outbound, - LibrariesDocumentsUploadV1Request$outboundSchema, - LibrariesDocumentsUploadV1Request$, - librariesGetV1RequestToJSON, - librariesGetV1RequestFromJSON, - LibrariesGetV1Request, - LibrariesGetV1Request$inboundSchema, - LibrariesGetV1Request$Outbound, - LibrariesGetV1Request$outboundSchema, - LibrariesGetV1Request$, - librariesShareCreateV1RequestToJSON, - librariesShareCreateV1RequestFromJSON, - LibrariesShareCreateV1Request, - LibrariesShareCreateV1Request$inboundSchema, - LibrariesShareCreateV1Request$Outbound, - LibrariesShareCreateV1Request$outboundSchema, - LibrariesShareCreateV1Request$, - librariesShareDeleteV1RequestToJSON, - librariesShareDeleteV1RequestFromJSON, - LibrariesShareDeleteV1Request, - LibrariesShareDeleteV1Request$inboundSchema, - LibrariesShareDeleteV1Request$Outbound, - LibrariesShareDeleteV1Request$outboundSchema, - LibrariesShareDeleteV1Request$, - librariesShareListV1RequestToJSON, - librariesShareListV1RequestFromJSON, - LibrariesShareListV1Request, - LibrariesShareListV1Request$inboundSchema, - LibrariesShareListV1Request$Outbound, - LibrariesShareListV1Request$outboundSchema, - LibrariesShareListV1Request$, - librariesUpdateV1RequestToJSON, - librariesUpdateV1RequestFromJSON, - LibrariesUpdateV1Request, - LibrariesUpdateV1Request$inboundSchema, - LibrariesUpdateV1Request$Outbound, - LibrariesUpdateV1Request$outboundSchema, - LibrariesUpdateV1Request$, - retrieveModelV1ModelsModelIdGetRequestToJSON, - retrieveModelV1ModelsModelIdGetRequestFromJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON, - RetrieveModelV1ModelsModelIdGetRequest, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - RetrieveModelV1ModelsModelIdGetRequest$inboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$Outbound, - RetrieveModelV1ModelsModelIdGetRequest$outboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OutputContentChunks$ { - /** @deprecated use `OutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$Outbound` instead. */ - type Outbound = OutputContentChunks$Outbound; -} - -/** @internal */ -declare const OutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type OutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const OutputContentChunks$outboundSchema: z.ZodType; - -declare type OutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function outputContentChunksFromJSON(jsonString: string): Result; - -declare function outputContentChunksToJSON(outputContentChunks: OutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Outputs$ { - /** @deprecated use `Outputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Outputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Outputs$Outbound` instead. */ - type Outbound = Outputs$Outbound; -} - -/** @internal */ -declare const Outputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Outputs$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Outputs$outboundSchema: z.ZodType; - -declare type Outputs = AgentHandoffEntry | FunctionCallEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function outputsFromJSON(jsonString: string): Result; - -declare function outputsToJSON(outputs: Outputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PaginationInfo$ { - /** @deprecated use `PaginationInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$Outbound` instead. */ - type Outbound = PaginationInfo$Outbound; -} - -/** @internal */ -declare const PaginationInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type PaginationInfo$Outbound = { - total_items: number; - total_pages: number; - current_page: number; - page_size: number; - has_more: boolean; -}; - -/** @internal */ -declare const PaginationInfo$outboundSchema: z.ZodType; - -declare type PaginationInfo = { - totalItems: number; - totalPages: number; - currentPage: number; - pageSize: number; - hasMore: boolean; -}; - -declare function paginationInfoFromJSON(jsonString: string): Result; - -declare function paginationInfoToJSON(paginationInfo: PaginationInfo): string; - -declare type ParsedAssistantMessage = components.AssistantMessage & { - parsed?: z_2.infer | undefined; -}; - -declare type ParsedChatCompletionChoice = Omit & { - message?: ParsedAssistantMessage | undefined; -}; - -declare type ParsedChatCompletionRequest = Omit & { - responseFormat: T; -}; - -declare type ParsedChatCompletionResponse = Omit & { - choices?: Array> | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Prediction$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Prediction$Outbound` instead. */ - type Outbound = Prediction$Outbound; -} - -/** @internal */ -declare const Prediction$inboundSchema: z.ZodType; - -/** @internal */ -declare type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -declare const Prediction$outboundSchema: z.ZodType; - -declare type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -declare function predictionFromJSON(jsonString: string): Result; - -declare function predictionToJSON(prediction: Prediction): string; - -declare type Prettify = { - [K in keyof T]: T[K]; -} & {}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessingStatusOut$ { - /** @deprecated use `ProcessingStatusOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$Outbound` instead. */ - type Outbound = ProcessingStatusOut$Outbound; -} - -/** @internal */ -declare const ProcessingStatusOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessingStatusOut$Outbound = { - document_id: string; - processing_status: string; -}; - -/** @internal */ -declare const ProcessingStatusOut$outboundSchema: z.ZodType; - -declare type ProcessingStatusOut = { - documentId: string; - processingStatus: string; -}; - -declare function processingStatusOutFromJSON(jsonString: string): Result; - -declare function processingStatusOutToJSON(processingStatusOut: ProcessingStatusOut): string; - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -declare function readableStreamToArrayBuffer(readable: ReadableStream): Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - type Outbound = ReferenceChunk$Outbound; -} - -/** @internal */ -declare const ReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -declare const ReferenceChunk$outboundSchema: z.ZodType; - -declare type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -declare function referenceChunkFromJSON(jsonString: string): Result; - -declare function referenceChunkToJSON(referenceChunk: ReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; -} - -/** @internal */ -declare const ReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ReferenceChunkType: { - readonly Reference: "reference"; -}; - -declare type ReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Repositories$ { - /** @deprecated use `Repositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Repositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Repositories$Outbound` instead. */ - type Outbound = Repositories$Outbound; -} - -/** @internal */ -declare const Repositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type Repositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const Repositories$outboundSchema: z.ZodType; - -declare type Repositories = GithubRepositoryOut; - -declare function repositoriesFromJSON(jsonString: string): Result; - -declare function repositoriesToJSON(repositories: Repositories): string; - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -declare class RequestAbortedError extends HTTPClientError { - readonly name = "RequestAbortedError"; -} - -declare type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - userAgent?: string | undefined; - timeoutMs?: number; -}; - -declare type RequestErrorHook = (err: unknown, req: Request) => Awaitable; - -declare type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -declare type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * @deprecated `fetchOptions` has been flattened into `RequestOptions`. - * - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -} & Omit; - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -declare class RequestTimeoutError extends HTTPClientError { - readonly name = "RequestTimeoutError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseBody$ { - /** @deprecated use `ResponseBody$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$Outbound` instead. */ - type Outbound = ResponseBody$Outbound; -} - -/** @internal */ -declare const ResponseBody$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseBody$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const ResponseBody$outboundSchema: z.ZodType; - -declare type ResponseBody = components.ModelConversation | components.AgentConversation; - -declare function responseBodyFromJSON(jsonString: string): Result; - -declare function responseBodyToJSON(responseBody: ResponseBody): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEvent$ { - /** @deprecated use `ResponseDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$Outbound` instead. */ - type Outbound = ResponseDoneEvent$Outbound; -} - -/** @internal */ -declare const ResponseDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ResponseDoneEvent$outboundSchema: z.ZodType; - -declare type ResponseDoneEvent = { - type?: ResponseDoneEventType | undefined; - createdAt?: Date | undefined; - usage: ConversationUsageInfo; -}; - -declare function responseDoneEventFromJSON(jsonString: string): Result; - -declare function responseDoneEventToJSON(responseDoneEvent: ResponseDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEventType$ { - /** @deprecated use `ResponseDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; - /** @deprecated use `ResponseDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; -} - -/** @internal */ -declare const ResponseDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseDoneEventType: { - readonly ConversationResponseDone: "conversation.response.done"; -}; - -declare type ResponseDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEvent$ { - /** @deprecated use `ResponseErrorEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$Outbound` instead. */ - type Outbound = ResponseErrorEvent$Outbound; -} - -/** @internal */ -declare const ResponseErrorEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseErrorEvent$Outbound = { - type: string; - created_at?: string | undefined; - message: string; - code: number; -}; - -/** @internal */ -declare const ResponseErrorEvent$outboundSchema: z.ZodType; - -declare type ResponseErrorEvent = { - type?: ResponseErrorEventType | undefined; - createdAt?: Date | undefined; - message: string; - code: number; -}; - -declare function responseErrorEventFromJSON(jsonString: string): Result; - -declare function responseErrorEventToJSON(responseErrorEvent: ResponseErrorEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEventType$ { - /** @deprecated use `ResponseErrorEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; - /** @deprecated use `ResponseErrorEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; -} - -/** @internal */ -declare const ResponseErrorEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseErrorEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseErrorEventType: { - readonly ConversationResponseError: "conversation.response.error"; -}; - -declare type ResponseErrorEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - type Outbound = ResponseFormat$Outbound; -} - -/** @internal */ -declare const ResponseFormat$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -declare const ResponseFormat$outboundSchema: z.ZodType; - -declare type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -declare function responseFormatFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; -} - -/** @internal */ -declare const ResponseFormats$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseFormats$outboundSchema: z.ZodNativeEnum; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare const ResponseFormats: { - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; -}; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare type ResponseFormats = ClosedEnum; - -declare function responseFormatToJSON(responseFormat: ResponseFormat): string; - -declare type ResponseHook = (res: Response, req: Request) => Awaitable; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEvent$ { - /** @deprecated use `ResponseStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$Outbound` instead. */ - type Outbound = ResponseStartedEvent$Outbound; -} - -/** @internal */ -declare const ResponseStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - conversation_id: string; -}; - -/** @internal */ -declare const ResponseStartedEvent$outboundSchema: z.ZodType; - -declare type ResponseStartedEvent = { - type?: ResponseStartedEventType | undefined; - createdAt?: Date | undefined; - conversationId: string; -}; - -declare function responseStartedEventFromJSON(jsonString: string): Result; - -declare function responseStartedEventToJSON(responseStartedEvent: ResponseStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEventType$ { - /** @deprecated use `ResponseStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; - /** @deprecated use `ResponseStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; -} - -/** @internal */ -declare const ResponseStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseStartedEventType: { - readonly ConversationResponseStarted: "conversation.response.started"; -}; - -declare type ResponseStartedEventType = ClosedEnum; - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -declare type Result = { - ok: true; - value: T; - error?: never; -} | { - ok: false; - value?: never; - error: E; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveFileOut$ { - /** @deprecated use `RetrieveFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$Outbound` instead. */ - type Outbound = RetrieveFileOut$Outbound; -} - -/** @internal */ -declare const RetrieveFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; - deleted: boolean; -}; - -/** @internal */ -declare const RetrieveFileOut$outboundSchema: z.ZodType; - -declare type RetrieveFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; - deleted: boolean; -}; - -declare function retrieveFileOutFromJSON(jsonString: string): Result; - -declare function retrieveFileOutToJSON(retrieveFileOut: RetrieveFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetRequest$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetRequest$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$outboundSchema: z.ZodType; - -declare type RetrieveModelV1ModelsModelIdGetRequest = { - /** - * The ID of the model to retrieve. - */ - modelId: string; -}; - -declare function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest: RetrieveModelV1ModelsModelIdGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound = (components.FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (components.BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet = (components.FTModelCard & { - type: "fine-tuned"; -}) | (components.BaseModelCard & { - type: "base"; -}); - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet: RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet): string; - -declare type RetryConfig = { - strategy: "none"; -} | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; - /** @deprecated use `Role$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; -} - -/** @internal */ -declare const Role$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Role$outboundSchema: z.ZodNativeEnum; - -declare const Role: { - readonly System: "system"; -}; - -declare type Role = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SampleType$ { - /** @deprecated use `SampleType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SampleType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const SampleType$inboundSchema: z.ZodType; - -/** @internal */ -declare const SampleType$outboundSchema: z.ZodType; - -declare const SampleType: { - readonly Pretrain: "pretrain"; - readonly Instruct: "instruct"; - readonly BatchRequest: "batch_request"; - readonly BatchResult: "batch_result"; - readonly BatchError: "batch_error"; -}; - -declare type SampleType = OpenEnum; - -export declare const SDK_METADATA: { - readonly language: "typescript"; - readonly openapiDocVersion: "1.0.0"; - readonly sdkVersion: "1.10.0"; - readonly genVersion: "2.687.13"; - readonly userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai"; -}; - -declare class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[]; - beforeCreateRequestHooks: BeforeCreateRequestHook[]; - beforeRequestHooks: BeforeRequestHook_2[]; - afterSuccessHooks: AfterSuccessHook[]; - afterErrorHooks: AfterErrorHook[]; - constructor(); - registerSDKInitHook(hook: SDKInitHook): void; - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - registerAfterSuccessHook(hook: AfterSuccessHook): void; - registerAfterErrorHook(hook: AfterErrorHook): void; - sdkInit(opts: SDKInitOptions): SDKInitOptions; - beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput; - beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise; - afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise; - afterError(hookCtx: AfterErrorContext, response: Response | null, error: unknown): Promise<{ - response: Response | null; - error: unknown; - }>; -} - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -declare interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -declare type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export declare type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default user agent used by the SDK - */ - userAgent?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -declare class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - readonly rawValue: unknown; - /** - * The raw message that failed validation. - */ - readonly rawMessage: unknown; - static [Symbol.hasInstance](instance: unknown): instance is SDKValidationError; - constructor(message: string, cause: unknown, rawValue: unknown); - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty(): string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Security$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Security$Outbound` instead. */ - type Outbound = Security$Outbound; -} - -/** @internal */ -declare const Security$inboundSchema: z.ZodType; - -/** @internal */ -declare type Security$Outbound = { - ApiKey?: string | undefined; -}; - -/** @internal */ -declare const Security$outboundSchema: z.ZodType; - -declare type Security = { - apiKey?: string | undefined; -}; - -declare function securityFromJSON(jsonString: string): Result; - -declare type SecurityState = { - basic: { - username?: string | undefined; - password?: string | undefined; - }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ - type: "password"; - } & OAuth2PasswordFlow) | { - type: "none"; - }; -}; - -declare function securityToJSON(security: Security): string; - -/** - * EU Production server - */ -export declare const ServerEu = "eu"; - -declare type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - id?: string | undefined; - retry?: number | undefined; -}; - -/** - * Contains the list of servers available to the SDK - */ -export declare const ServerList: { - readonly eu: "https://api.mistral.ai"; -}; - -export declare function serverURLFromOptions(options: SDKOptions): URL | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShareEnum$ { - /** @deprecated use `ShareEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShareEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ShareEnum$inboundSchema: z.ZodType; - -/** @internal */ -declare const ShareEnum$outboundSchema: z.ZodType; - -declare const ShareEnum: { - readonly Viewer: "Viewer"; - readonly Editor: "Editor"; -}; - -declare type ShareEnum = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingDelete$ { - /** @deprecated use `SharingDelete$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$Outbound` instead. */ - type Outbound = SharingDelete$Outbound; -} - -/** @internal */ -declare const SharingDelete$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingDelete$Outbound = { - org_id: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingDelete$outboundSchema: z.ZodType; - -declare type SharingDelete = { - orgId: string; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingDeleteFromJSON(jsonString: string): Result; - -declare function sharingDeleteToJSON(sharingDelete: SharingDelete): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingIn$ { - /** @deprecated use `SharingIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingIn$Outbound` instead. */ - type Outbound = SharingIn$Outbound; -} - -/** @internal */ -declare const SharingIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingIn$Outbound = { - org_id: string; - level: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingIn$outboundSchema: z.ZodType; - -declare type SharingIn = { - orgId: string; - level: ShareEnum; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingInFromJSON(jsonString: string): Result; - -declare function sharingInToJSON(sharingIn: SharingIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingOut$ { - /** @deprecated use `SharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingOut$Outbound` instead. */ - type Outbound = SharingOut$Outbound; -} - -/** @internal */ -declare const SharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingOut$Outbound = { - library_id: string; - user_id?: string | null | undefined; - org_id: string; - role: string; - share_with_type: string; - share_with_uuid: string; -}; - -/** @internal */ -declare const SharingOut$outboundSchema: z.ZodType; - -declare type SharingOut = { - libraryId: string; - userId?: string | null | undefined; - orgId: string; - role: string; - shareWithType: string; - shareWithUuid: string; -}; - -declare function sharingOutFromJSON(jsonString: string): Result; - -declare function sharingOutToJSON(sharingOut: SharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Source$ { - /** @deprecated use `Source$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Source$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const Source$inboundSchema: z.ZodType; - -/** @internal */ -declare const Source$outboundSchema: z.ZodType; - -declare const Source: { - readonly Upload: "upload"; - readonly Repository: "repository"; - readonly Mistral: "mistral"; -}; - -declare type Source = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SSETypes$ { - /** @deprecated use `SSETypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `SSETypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const SSETypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const SSETypes$outboundSchema: z.ZodNativeEnum; - -/** - * Server side events sent when streaming a conversation response. - */ -declare const SSETypes: { - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; -}; - -/** - * Server side events sent when streaming a conversation response. - */ -declare type SSETypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$ { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$_2 { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const Status$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$inboundSchema_2: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema_2: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const Status: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type Status = ClosedEnum; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare const Status_2: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare type Status_2 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Stop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Stop$Outbound` instead. */ - type Outbound = Stop$Outbound; -} - -/** @internal */ -declare const Stop$inboundSchema: z.ZodType; - -/** @internal */ -declare type Stop$Outbound = string | Array; - -/** @internal */ -declare const Stop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type Stop = string | Array; - -declare function stopFromJSON(jsonString: string): Result; - -declare function stopToJSON(stop: Stop): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$Outbound` instead. */ - type Outbound = SystemMessage$Outbound; -} - -/** @internal */ -declare const SystemMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -declare const SystemMessage$outboundSchema: z.ZodType; - -declare type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - type Outbound = SystemMessageContent$Outbound; -} - -/** @internal */ -declare const SystemMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContent$Outbound = string | Array; - -/** @internal */ -declare const SystemMessageContent$outboundSchema: z.ZodType; - -declare type SystemMessageContent = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContentChunks$ { - /** @deprecated use `SystemMessageContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$Outbound` instead. */ - type Outbound = SystemMessageContentChunks$Outbound; -} - -/** @internal */ -declare const SystemMessageContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContentChunks$Outbound = (TextChunk$Outbound & { - type: "text"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}); - -/** @internal */ -declare const SystemMessageContentChunks$outboundSchema: z.ZodType; - -declare type SystemMessageContentChunks = (TextChunk & { - type: "text"; -}) | (ThinkChunk & { - type: "thinking"; -}); - -declare function systemMessageContentChunksFromJSON(jsonString: string): Result; - -declare function systemMessageContentChunksToJSON(systemMessageContentChunks: SystemMessageContentChunks): string; - -declare function systemMessageContentFromJSON(jsonString: string): Result; - -declare function systemMessageContentToJSON(systemMessageContent: SystemMessageContent): string; - -declare function systemMessageFromJSON(jsonString: string): Result; - -declare function systemMessageToJSON(systemMessage: SystemMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TextChunk$Outbound` instead. */ - type Outbound = TextChunk$Outbound; -} - -/** @internal */ -declare const TextChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -declare const TextChunk$outboundSchema: z.ZodType; - -declare type TextChunk = { - text: string; - type?: TextChunkType | undefined; -}; - -declare function textChunkFromJSON(jsonString: string): Result; - -declare function textChunkToJSON(textChunk: TextChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunkType$ { - /** @deprecated use `TextChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; - /** @deprecated use `TextChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; -} - -/** @internal */ -declare const TextChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TextChunkType$outboundSchema: z.ZodNativeEnum; - -declare const TextChunkType: { - readonly Text: "text"; -}; - -declare type TextChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunk$ { - /** @deprecated use `ThinkChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$Outbound` instead. */ - type Outbound = ThinkChunk$Outbound; -} - -/** @internal */ -declare const ThinkChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ThinkChunk$Outbound = { - thinking: Array; - closed?: boolean | undefined; - type: string; -}; - -/** @internal */ -declare const ThinkChunk$outboundSchema: z.ZodType; - -declare type ThinkChunk = { - thinking: Array; - /** - * Whether the thinking chunk is closed or not. Currently only used for prefixing. - */ - closed?: boolean | undefined; - type?: ThinkChunkType | undefined; -}; - -declare function thinkChunkFromJSON(jsonString: string): Result; - -declare function thinkChunkToJSON(thinkChunk: ThinkChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunkType$ { - /** @deprecated use `ThinkChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; - /** @deprecated use `ThinkChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; -} - -/** @internal */ -declare const ThinkChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ThinkChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ThinkChunkType: { - readonly Thinking: "thinking"; -}; - -declare type ThinkChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Thinking$ { - /** @deprecated use `Thinking$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Thinking$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Thinking$Outbound` instead. */ - type Outbound = Thinking$Outbound; -} - -/** @internal */ -declare const Thinking$inboundSchema: z.ZodType; - -/** @internal */ -declare type Thinking$Outbound = ReferenceChunk$Outbound | TextChunk$Outbound; - -/** @internal */ -declare const Thinking$outboundSchema: z.ZodType; - -declare type Thinking = ReferenceChunk | TextChunk; - -declare function thinkingFromJSON(jsonString: string): Result; - -declare function thinkingToJSON(thinking: Thinking): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimestampGranularity$ { - /** @deprecated use `TimestampGranularity$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; - /** @deprecated use `TimestampGranularity$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; -} - -/** @internal */ -declare const TimestampGranularity$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TimestampGranularity$outboundSchema: z.ZodNativeEnum; - -declare const TimestampGranularity: { - readonly Segment: "segment"; -}; - -declare type TimestampGranularity = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tool$Outbound` instead. */ - type Outbound = Tool$Outbound; -} - -/** @internal */ -declare const Tool$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const Tool$outboundSchema: z.ZodType; - -declare type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolCall$Outbound` instead. */ - type Outbound = ToolCall$Outbound; -} - -/** @internal */ -declare const ToolCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -declare const ToolCall$outboundSchema: z.ZodType; - -declare type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -declare function toolCallFromJSON(jsonString: string): Result; - -declare function toolCallToJSON(toolCall: ToolCall): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$Outbound` instead. */ - type Outbound = ToolChoice$Outbound; -} - -/** @internal */ -declare const ToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -declare const ToolChoice$outboundSchema: z.ZodType; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -declare type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; -} - -/** @internal */ -declare const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum; - -declare const ToolChoiceEnum: { - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; -}; - -declare type ToolChoiceEnum = ClosedEnum; - -declare function toolChoiceFromJSON(jsonString: string): Result; - -declare function toolChoiceToJSON(toolChoice: ToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEvent$ { - /** @deprecated use `ToolExecutionDeltaEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$Outbound` instead. */ - type Outbound = ToolExecutionDeltaEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDeltaEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDeltaEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionDeltaEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDeltaEvent = { - type?: ToolExecutionDeltaEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionDeltaEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent: ToolExecutionDeltaEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEventType$ { - /** @deprecated use `ToolExecutionDeltaEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; - /** @deprecated use `ToolExecutionDeltaEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; -} - -/** @internal */ -declare const ToolExecutionDeltaEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDeltaEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDeltaEventType: { - readonly ToolExecutionDelta: "tool.execution.delta"; -}; - -declare type ToolExecutionDeltaEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEvent$ { - /** @deprecated use `ToolExecutionDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$Outbound` instead. */ - type Outbound = ToolExecutionDoneEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionDoneEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDoneEvent = { - type?: ToolExecutionDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionDoneEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDoneEventToJSON(toolExecutionDoneEvent: ToolExecutionDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEventType$ { - /** @deprecated use `ToolExecutionDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; - /** @deprecated use `ToolExecutionDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; -} - -/** @internal */ -declare const ToolExecutionDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDoneEventType: { - readonly ToolExecutionDone: "tool.execution.done"; -}; - -declare type ToolExecutionDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntry$ { - /** @deprecated use `ToolExecutionEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$Outbound` instead. */ - type Outbound = ToolExecutionEntry$Outbound; -} - -/** @internal */ -declare const ToolExecutionEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - name: string; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionEntry$outboundSchema: z.ZodType; - -declare type ToolExecutionEntry = { - object?: ToolExecutionEntryObject | undefined; - type?: ToolExecutionEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - name: BuiltInConnectors; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryObject$ { - /** @deprecated use `ToolExecutionEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ToolExecutionEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryObject: { - readonly Entry: "entry"; -}; - -declare type ToolExecutionEntryObject = ClosedEnum; - -declare function toolExecutionEntryToJSON(toolExecutionEntry: ToolExecutionEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryType$ { - /** @deprecated use `ToolExecutionEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; - /** @deprecated use `ToolExecutionEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryType: { - readonly ToolExecution: "tool.execution"; -}; - -declare type ToolExecutionEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEvent$ { - /** @deprecated use `ToolExecutionStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$Outbound` instead. */ - type Outbound = ToolExecutionStartedEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionStartedEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionStartedEvent = { - type?: ToolExecutionStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionStartedEventFromJSON(jsonString: string): Result; - -declare function toolExecutionStartedEventToJSON(toolExecutionStartedEvent: ToolExecutionStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEventType$ { - /** @deprecated use `ToolExecutionStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; - /** @deprecated use `ToolExecutionStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; -} - -/** @internal */ -declare const ToolExecutionStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionStartedEventType: { - readonly ToolExecutionStarted: "tool.execution.started"; -}; - -declare type ToolExecutionStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunk$ { - /** @deprecated use `ToolFileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$Outbound` instead. */ - type Outbound = ToolFileChunk$Outbound; -} - -/** @internal */ -declare const ToolFileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolFileChunk$Outbound = { - type: string; - tool: string; - file_id: string; - file_name?: string | null | undefined; - file_type?: string | null | undefined; -}; - -/** @internal */ -declare const ToolFileChunk$outboundSchema: z.ZodType; - -declare type ToolFileChunk = { - type?: ToolFileChunkType | undefined; - tool: BuiltInConnectors; - fileId: string; - fileName?: string | null | undefined; - fileType?: string | null | undefined; -}; - -declare function toolFileChunkFromJSON(jsonString: string): Result; - -declare function toolFileChunkToJSON(toolFileChunk: ToolFileChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunkType$ { - /** @deprecated use `ToolFileChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; - /** @deprecated use `ToolFileChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; -} - -/** @internal */ -declare const ToolFileChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolFileChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolFileChunkType: { - readonly ToolFile: "tool_file"; -}; - -declare type ToolFileChunkType = ClosedEnum; - -declare function toolFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$Outbound` instead. */ - type Outbound = ToolMessage$Outbound; -} - -/** @internal */ -declare const ToolMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -declare const ToolMessage$outboundSchema: z.ZodType; - -declare type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - type Outbound = ToolMessageContent$Outbound; -} - -/** @internal */ -declare const ToolMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -declare const ToolMessageContent$outboundSchema: z.ZodType; - -declare type ToolMessageContent = string | Array; - -declare function toolMessageContentFromJSON(jsonString: string): Result; - -declare function toolMessageContentToJSON(toolMessageContent: ToolMessageContent): string; - -declare function toolMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; -} - -/** @internal */ -declare const ToolMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const ToolMessageRole: { - readonly Tool: "tool"; -}; - -declare type ToolMessageRole = ClosedEnum; - -declare function toolMessageToJSON(toolMessage: ToolMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunk$ { - /** @deprecated use `ToolReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$Outbound` instead. */ - type Outbound = ToolReferenceChunk$Outbound; -} - -/** @internal */ -declare const ToolReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolReferenceChunk$Outbound = { - type: string; - tool: string; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const ToolReferenceChunk$outboundSchema: z.ZodType; - -declare type ToolReferenceChunk = { - type?: ToolReferenceChunkType | undefined; - tool: BuiltInConnectors; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function toolReferenceChunkFromJSON(jsonString: string): Result; - -declare function toolReferenceChunkToJSON(toolReferenceChunk: ToolReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunkType$ { - /** @deprecated use `ToolReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; - /** @deprecated use `ToolReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; -} - -/** @internal */ -declare const ToolReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolReferenceChunkType: { - readonly ToolReference: "tool_reference"; -}; - -declare type ToolReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tools$ { - /** @deprecated use `Tools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tools$Outbound` instead. */ - type Outbound = Tools$Outbound; -} - -/** @internal */ -declare const Tools$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const Tools$outboundSchema: z.ZodType; - -declare type Tools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function toolsFromJSON(jsonString: string): Result; - -declare function toolsToJSON(tools: Tools): string; - -declare function toolToJSON(tool: Tool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ToolTypes$inboundSchema: z.ZodType; - -/** @internal */ -declare const ToolTypes$outboundSchema: z.ZodType; - -declare const ToolTypes: { - readonly Function: "function"; -}; - -declare type ToolTypes = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TrainingFile$ { - /** @deprecated use `TrainingFile$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$Outbound` instead. */ - type Outbound = TrainingFile$Outbound; -} - -/** @internal */ -declare const TrainingFile$inboundSchema: z.ZodType; - -/** @internal */ -declare type TrainingFile$Outbound = { - file_id: string; - weight: number; -}; - -/** @internal */ -declare const TrainingFile$outboundSchema: z.ZodType; - -declare type TrainingFile = { - fileId: string; - weight?: number | undefined; -}; - -declare function trainingFileFromJSON(jsonString: string): Result; - -declare function trainingFileToJSON(trainingFile: TrainingFile): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionResponse$ { - /** @deprecated use `TranscriptionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$Outbound` instead. */ - type Outbound = TranscriptionResponse$Outbound; -} - -/** @internal */ -declare const TranscriptionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionResponse$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionResponse$outboundSchema: z.ZodType; - -declare type TranscriptionResponse = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionResponseFromJSON(jsonString: string): Result; - -declare function transcriptionResponseToJSON(transcriptionResponse: TranscriptionResponse): string; - -declare class Transcriptions extends ClientSDK { - /** - * Create Transcription - */ - complete(request: components.AudioTranscriptionRequest, options?: RequestOptions): Promise; - /** - * Create streaming transcription (SSE) - */ - stream(request: components.AudioTranscriptionRequestStream, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionSegmentChunk$ { - /** @deprecated use `TranscriptionSegmentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$Outbound` instead. */ - type Outbound = TranscriptionSegmentChunk$Outbound; -} - -/** @internal */ -declare const TranscriptionSegmentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionSegmentChunk$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionSegmentChunk$outboundSchema: z.ZodType; - -declare type TranscriptionSegmentChunk = { - text: string; - start: number; - end: number; - type?: Type | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionSegmentChunkFromJSON(jsonString: string): Result; - -declare function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk: TranscriptionSegmentChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDone$ { - /** @deprecated use `TranscriptionStreamDone$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$Outbound` instead. */ - type Outbound = TranscriptionStreamDone$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamDone$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamDone$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - type: string; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamDone$outboundSchema: z.ZodType; - -declare type TranscriptionStreamDone = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - type?: TranscriptionStreamDoneType | undefined; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamDoneFromJSON(jsonString: string): Result; - -declare function transcriptionStreamDoneToJSON(transcriptionStreamDone: TranscriptionStreamDone): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDoneType$ { - /** @deprecated use `TranscriptionStreamDoneType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamDoneType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamDoneType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamDoneType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamDoneType: { - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamDoneType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEvents$ { - /** @deprecated use `TranscriptionStreamEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$Outbound` instead. */ - type Outbound = TranscriptionStreamEvents$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEvents$Outbound = { - event: string; - data: (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; - }); -}; - -/** @internal */ -declare const TranscriptionStreamEvents$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEvents = { - event: TranscriptionStreamEventTypes; - data: (TranscriptionStreamDone & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventsData$ { - /** @deprecated use `TranscriptionStreamEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$Outbound` instead. */ - type Outbound = TranscriptionStreamEventsData$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEventsData$Outbound = (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; -}); - -/** @internal */ -declare const TranscriptionStreamEventsData$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEventsData = (TranscriptionStreamDone & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; -}); - -declare function transcriptionStreamEventsDataFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData: TranscriptionStreamEventsData): string; - -declare function transcriptionStreamEventsFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsToJSON(transcriptionStreamEvents: TranscriptionStreamEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventTypes$ { - /** @deprecated use `TranscriptionStreamEventTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamEventTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamEventTypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamEventTypes$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamEventTypes: { - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamEventTypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguage$ { - /** @deprecated use `TranscriptionStreamLanguage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$Outbound` instead. */ - type Outbound = TranscriptionStreamLanguage$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamLanguage$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamLanguage$Outbound = { - type: string; - audio_language: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamLanguage$outboundSchema: z.ZodType; - -declare type TranscriptionStreamLanguage = { - type?: TranscriptionStreamLanguageType | undefined; - audioLanguage: string; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamLanguageFromJSON(jsonString: string): Result; - -declare function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage: TranscriptionStreamLanguage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguageType$ { - /** @deprecated use `TranscriptionStreamLanguageType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; - /** @deprecated use `TranscriptionStreamLanguageType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamLanguageType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamLanguageType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamLanguageType: { - readonly TranscriptionLanguage: "transcription.language"; -}; - -declare type TranscriptionStreamLanguageType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDelta$ { - /** @deprecated use `TranscriptionStreamSegmentDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamSegmentDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamSegmentDelta$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamSegmentDelta = { - text: string; - start: number; - end: number; - type?: TranscriptionStreamSegmentDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamSegmentDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta: TranscriptionStreamSegmentDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDeltaType$ { - /** @deprecated use `TranscriptionStreamSegmentDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; - /** @deprecated use `TranscriptionStreamSegmentDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamSegmentDeltaType: { - readonly TranscriptionSegment: "transcription.segment"; -}; - -declare type TranscriptionStreamSegmentDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDelta$ { - /** @deprecated use `TranscriptionStreamTextDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamTextDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamTextDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamTextDelta$Outbound = { - text: string; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamTextDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamTextDelta = { - text: string; - type?: TranscriptionStreamTextDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamTextDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta: TranscriptionStreamTextDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDeltaType$ { - /** @deprecated use `TranscriptionStreamTextDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; - /** @deprecated use `TranscriptionStreamTextDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamTextDeltaType: { - readonly TranscriptionTextDelta: "transcription.text.delta"; -}; - -declare type TranscriptionStreamTextDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Two$ { - /** @deprecated use `Two$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Two$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Two$Outbound` instead. */ - type Outbound = Two$Outbound; -} - -/** @internal */ -declare const Two$inboundSchema: z.ZodType; - -/** @internal */ -declare type Two$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Two$outboundSchema: z.ZodType; - -declare type Two = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function twoFromJSON(jsonString: string): Result; - -declare function twoToJSON(two: Two): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; - /** @deprecated use `Type$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; -} - -/** @internal */ -declare const Type$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Type$outboundSchema: z.ZodNativeEnum; - -declare const Type: { - readonly TranscriptionSegment: "transcription_segment"; -}; - -declare type Type = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOut$ { - /** @deprecated use `UnarchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$Outbound` instead. */ - type Outbound = UnarchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const UnarchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UnarchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const UnarchiveFTModelOut$outboundSchema: z.ZodType; - -declare type UnarchiveFTModelOut = { - id: string; - object?: UnarchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function unarchiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOutObject$ { - /** @deprecated use `UnarchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `UnarchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const UnarchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UnarchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const UnarchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type UnarchiveFTModelOutObject = ClosedEnum; - -declare function unarchiveFTModelOutToJSON(unarchiveFTModelOut: UnarchiveFTModelOut): string; - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -declare class UnexpectedClientError extends HTTPClientError { - name: string; -} - -declare type Unrecognized = T & { - [__brand]: "unrecognized"; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateFTModelIn$ { - /** @deprecated use `UpdateFTModelIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$Outbound` instead. */ - type Outbound = UpdateFTModelIn$Outbound; -} - -/** @internal */ -declare const UpdateFTModelIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateFTModelIn$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const UpdateFTModelIn$outboundSchema: z.ZodType; - -declare type UpdateFTModelIn = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function updateFTModelInFromJSON(jsonString: string): Result; - -declare function updateFTModelInToJSON(updateFTModelIn: UpdateFTModelIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadFileOut$ { - /** @deprecated use `UploadFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$Outbound` instead. */ - type Outbound = UploadFileOut$Outbound; -} - -/** @internal */ -declare const UploadFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const UploadFileOut$outboundSchema: z.ZodType; - -declare type UploadFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function uploadFileOutFromJSON(jsonString: string): Result; - -declare function uploadFileOutToJSON(uploadFileOut: UploadFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$Outbound` instead. */ - type Outbound = UsageInfo$Outbound; -} - -/** @internal */ -declare const UsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - prompt_audio_seconds?: number | null | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const UsageInfo$outboundSchema: z.ZodType; - -declare type UsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - promptAudioSeconds?: number | null | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function usageInfoFromJSON(jsonString: string): Result; - -declare function usageInfoToJSON(usageInfo: UsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessage$Outbound` instead. */ - type Outbound = UserMessage$Outbound; -} - -/** @internal */ -declare const UserMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -declare const UserMessage$outboundSchema: z.ZodType; - -declare type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - type Outbound = UserMessageContent$Outbound; -} - -/** @internal */ -declare const UserMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessageContent$Outbound = string | Array; - -/** @internal */ -declare const UserMessageContent$outboundSchema: z.ZodType; - -declare type UserMessageContent = string | Array; - -declare function userMessageContentFromJSON(jsonString: string): Result; - -declare function userMessageContentToJSON(userMessageContent: UserMessageContent): string; - -declare function userMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; -} - -/** @internal */ -declare const UserMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UserMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const UserMessageRole: { - readonly User: "user"; -}; - -declare type UserMessageRole = ClosedEnum; - -declare function userMessageToJSON(userMessage: UserMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ValidationError$Outbound` instead. */ - type Outbound = ValidationError$Outbound; -} - -/** @internal */ -declare const ValidationError$inboundSchema: z.ZodType; - -/** @internal */ -declare type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -declare const ValidationError$outboundSchema: z.ZodType; - -declare type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -declare function validationErrorFromJSON(jsonString: string): Result; - -declare function validationErrorToJSON(validationError: ValidationError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegration$ { - /** @deprecated use `WandbIntegration$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$Outbound` instead. */ - type Outbound = WandbIntegration$Outbound; -} - -/** @internal */ -declare const WandbIntegration$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegration$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - api_key: string; - run_name?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegration$outboundSchema: z.ZodType; - -declare type WandbIntegration = { - type?: WandbIntegrationType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - /** - * The WandB API key to use for authentication. - */ - apiKey: string; - runName?: string | null | undefined; -}; - -declare function wandbIntegrationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOut$ { - /** @deprecated use `WandbIntegrationOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$Outbound` instead. */ - type Outbound = WandbIntegrationOut$Outbound; -} - -/** @internal */ -declare const WandbIntegrationOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegrationOut$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - run_name?: string | null | undefined; - url?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegrationOut$outboundSchema: z.ZodType; - -declare type WandbIntegrationOut = { - type?: WandbIntegrationOutType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - runName?: string | null | undefined; - url?: string | null | undefined; -}; - -declare function wandbIntegrationOutFromJSON(jsonString: string): Result; - -declare function wandbIntegrationOutToJSON(wandbIntegrationOut: WandbIntegrationOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOutType$ { - /** @deprecated use `WandbIntegrationOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationOutType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationOutType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationOutType = ClosedEnum; - -declare function wandbIntegrationToJSON(wandbIntegration: WandbIntegration): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationType$ { - /** @deprecated use `WandbIntegrationType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumTool$ { - /** @deprecated use `WebSearchPremiumTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$Outbound` instead. */ - type Outbound = WebSearchPremiumTool$Outbound; -} - -/** @internal */ -declare const WebSearchPremiumTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchPremiumTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchPremiumTool$outboundSchema: z.ZodType; - -declare type WebSearchPremiumTool = { - type?: WebSearchPremiumToolType | undefined; -}; - -declare function webSearchPremiumToolFromJSON(jsonString: string): Result; - -declare function webSearchPremiumToolToJSON(webSearchPremiumTool: WebSearchPremiumTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumToolType$ { - /** @deprecated use `WebSearchPremiumToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; - /** @deprecated use `WebSearchPremiumToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; -} - -/** @internal */ -declare const WebSearchPremiumToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchPremiumToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchPremiumToolType: { - readonly WebSearchPremium: "web_search_premium"; -}; - -declare type WebSearchPremiumToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchTool$ { - /** @deprecated use `WebSearchTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$Outbound` instead. */ - type Outbound = WebSearchTool$Outbound; -} - -/** @internal */ -declare const WebSearchTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchTool$outboundSchema: z.ZodType; - -declare type WebSearchTool = { - type?: WebSearchToolType | undefined; -}; - -declare function webSearchToolFromJSON(jsonString: string): Result; - -declare function webSearchToolToJSON(webSearchTool: WebSearchTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchToolType$ { - /** @deprecated use `WebSearchToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; - /** @deprecated use `WebSearchToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; -} - -/** @internal */ -declare const WebSearchToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchToolType: { - readonly WebSearch: "web_search"; -}; - -declare type WebSearchToolType = ClosedEnum; - -export { } diff --git a/examples/custom/speakeasy.mistral.config.mjs b/examples/custom/speakeasy.mistral.config.mjs deleted file mode 100644 index e1266a045..000000000 --- a/examples/custom/speakeasy.mistral.config.mjs +++ /dev/null @@ -1,59 +0,0 @@ -import { join, resolve } from "node:path"; -import { writeFileSync } from "node:fs"; - -import { getSettings } from "@speakeasy-api/docs-md"; - -/** - * @type {import("@speakeasy-api/docs-md").FrameworkConfig} - */ -const framework = { - rendererType: "mdx", - componentPackageName: "@/components/speakeasy-custom", - stringAttributeEscapeStyle: "react-value", - elementIdSeparator: "_", - - buildPagePath(slug) { - const settings = getSettings(); - return resolve(join(settings.output.pageOutDir, `${slug}/page.mdx`)); - }, - - buildPagePreamble() { - return `import "@/app/speakeasy.css";`; - }, - - postProcess(metadata) { - // Note: the format for this data is very much a quick and dirty - // implementation. It's shape will almost certainly change and become easier - // to work with in the future. - writeFileSync( - "./src/app/mistral/sidebarMetadata.json", - JSON.stringify(metadata, null, " ") - ); - }, -}; - -export default { - spec: "../specs/mistral.yaml", - output: { - pageOutDir: "./src/app/mistral/api", - framework, - }, - codeSamples: [ - { - language: "typescript", - sdkTarballPath: "../sdks/mistral-typescript.tar.gz", - tryItNow: { - outDir: "./public/mistral-try-it-now", - urlPrefix: "/mistral-try-it-now", - }, - }, - { - language: "python", - sdkTarballPath: "../sdks/mistral-python.tar.gz", - }, - { - language: "curl", - tryItNow: true, - }, - ], -}; diff --git a/examples/custom/speakeasy.pokeapi.config.mjs b/examples/custom/speakeasy.pokeapi.config.mjs deleted file mode 100644 index f021af7e0..000000000 --- a/examples/custom/speakeasy.pokeapi.config.mjs +++ /dev/null @@ -1,46 +0,0 @@ -import { join, resolve } from "node:path"; -import { writeFileSync } from "node:fs"; - -import { getSettings } from "@speakeasy-api/docs-md"; - -/** - * @type {import("@speakeasy-api/docs-md").FrameworkConfig} - */ -const framework = { - rendererType: "mdx", - componentPackageName: "@/components/speakeasy-custom", - stringAttributeEscapeStyle: "react-value", - elementIdSeparator: "_", - - buildPagePath(slug) { - const settings = getSettings(); - return resolve(join(settings.output.pageOutDir, `${slug}/page.mdx`)); - }, - - buildPagePreamble() { - return `import "@/app/speakeasy.css";`; - }, - - postProcess(metadata) { - // Note: the format for this data is very much a quick and dirty - // implementation. It's shape will almost certainly change and become easier - // to work with in the future. - writeFileSync( - "./src/app/pokeapi/sidebarMetadata.json", - JSON.stringify(metadata, null, " ") - ); - }, -}; - -export default { - spec: "../specs/pokeapi.yml", - output: { - pageOutDir: "./src/app/pokeapi/api", - framework, - }, - codeSamples: [ - { - language: "curl", - }, - ], -}; diff --git a/examples/custom/src/app/favicon.ico b/examples/custom/src/app/favicon.ico deleted file mode 100644 index 718d6fea4835ec2d246af9800eddb7ffb276240c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 25931 zcmeHv30#a{`}aL_*G&7qml|y<+KVaDM2m#dVr!KsA!#An?kSQM(q<_dDNCpjEux83 zLb9Z^XxbDl(w>%i@8hT6>)&Gu{h#Oeyszu?xtw#Zb1mO{pgX9699l+Qppw7jXaYf~-84xW z)w4x8?=youko|}Vr~(D$UXIbiXABHh`p1?nn8Po~fxRJv}|0e(BPs|G`(TT%kKVJAdg5*Z|x0leQq0 zkdUBvb#>9F()jo|T~kx@OM8$9wzs~t2l;K=woNssA3l6|sx2r3+kdfVW@e^8e*E}v zA1y5{bRi+3Z`uD3{F7LgFJDdvm;nJilkzDku>BwXH(8ItVCXk*-lSJnR?-2UN%hJ){&rlvg`CDTj z)Bzo!3v7Ou#83zEDEFcKt(f1E0~=rqeEbTnMvWR#{+9pg%7G8y>u1OVRUSoox-ovF z2Ydma(;=YuBY(eI|04{hXzZD6_f(v~H;C~y5=DhAC{MMS>2fm~1H_t2$56pc$NH8( z5bH|<)71dV-_oCHIrzrT`2s-5w_+2CM0$95I6X8p^r!gHp+j_gd;9O<1~CEQQGS8) zS9Qh3#p&JM-G8rHekNmKVewU;pJRcTAog68KYo^dRo}(M>36U4Us zfgYWSiHZL3;lpWT=zNAW>Dh#mB!_@Lg%$ms8N-;aPqMn+C2HqZgz&9~Eu z4|Kp<`$q)Uw1R?y(~S>ePdonHxpV1#eSP1B;Ogo+-Pk}6#0GsZZ5!||ev2MGdh}_m z{DeR7?0-1^zVs&`AV6Vt;r3`I`OI_wgs*w=eO%_#7Kepl{B@xiyCANc(l zzIyd4y|c6PXWq9-|KM8(zIk8LPk(>a)zyFWjhT!$HJ$qX1vo@d25W<fvZQ2zUz5WRc(UnFMKHwe1| zWmlB1qdbiA(C0jmnV<}GfbKtmcu^2*P^O?MBLZKt|As~ge8&AAO~2K@zbXelK|4T<{|y4`raF{=72kC2Kn(L4YyenWgrPiv z@^mr$t{#X5VuIMeL!7Ab6_kG$&#&5p*Z{+?5U|TZ`B!7llpVmp@skYz&n^8QfPJzL z0G6K_OJM9x+Wu2gfN45phANGt{7=C>i34CV{Xqlx(fWpeAoj^N0Biu`w+MVcCUyU* zDZuzO0>4Z6fbu^T_arWW5n!E45vX8N=bxTVeFoep_G#VmNlQzAI_KTIc{6>c+04vr zx@W}zE5JNSU>!THJ{J=cqjz+4{L4A{Ob9$ZJ*S1?Ggg3klFp!+Y1@K+pK1DqI|_gq z5ZDXVpge8-cs!o|;K73#YXZ3AShj50wBvuq3NTOZ`M&qtjj#GOFfgExjg8Gn8>Vq5 z`85n+9|!iLCZF5$HJ$Iu($dm?8~-ofu}tEc+-pyke=3!im#6pk_Wo8IA|fJwD&~~F zc16osQ)EBo58U7XDuMexaPRjU@h8tXe%S{fA0NH3vGJFhuyyO!Uyl2^&EOpX{9As0 zWj+P>{@}jxH)8|r;2HdupP!vie{sJ28b&bo!8`D^x}TE$%zXNb^X1p@0PJ86`dZyj z%ce7*{^oo+6%&~I!8hQy-vQ7E)0t0ybH4l%KltWOo~8cO`T=157JqL(oq_rC%ea&4 z2NcTJe-HgFjNg-gZ$6!Y`SMHrlj}Etf7?r!zQTPPSv}{so2e>Fjs1{gzk~LGeesX%r(Lh6rbhSo_n)@@G-FTQy93;l#E)hgP@d_SGvyCp0~o(Y;Ee8{ zdVUDbHm5`2taPUOY^MAGOw*>=s7=Gst=D+p+2yON!0%Hk` zz5mAhyT4lS*T3LS^WSxUy86q&GnoHxzQ6vm8)VS}_zuqG?+3td68_x;etQAdu@sc6 zQJ&5|4(I?~3d-QOAODHpZ=hlSg(lBZ!JZWCtHHSj`0Wh93-Uk)_S%zsJ~aD>{`A0~ z9{AG(e|q3g5B%wYKRxiL2Y$8(4w6bzchKuloQW#e&S3n+P- z8!ds-%f;TJ1>)v)##>gd{PdS2Oc3VaR`fr=`O8QIO(6(N!A?pr5C#6fc~Ge@N%Vvu zaoAX2&(a6eWy_q&UwOhU)|P3J0Qc%OdhzW=F4D|pt0E4osw;%<%Dn58hAWD^XnZD= z>9~H(3bmLtxpF?a7su6J7M*x1By7YSUbxGi)Ot0P77`}P3{)&5Un{KD?`-e?r21!4vTTnN(4Y6Lin?UkSM z`MXCTC1@4A4~mvz%Rh2&EwY))LeoT=*`tMoqcEXI>TZU9WTP#l?uFv+@Dn~b(>xh2 z;>B?;Tz2SR&KVb>vGiBSB`@U7VIWFSo=LDSb9F{GF^DbmWAfpms8Sx9OX4CnBJca3 zlj9(x!dIjN?OG1X4l*imJNvRCk}F%!?SOfiOq5y^mZW)jFL@a|r-@d#f7 z2gmU8L3IZq0ynIws=}~m^#@&C%J6QFo~Mo4V`>v7MI-_!EBMMtb%_M&kvAaN)@ZVw z+`toz&WG#HkWDjnZE!6nk{e-oFdL^$YnbOCN}JC&{$#$O27@|Tn-skXr)2ml2~O!5 zX+gYoxhoc7qoU?C^3~&!U?kRFtnSEecWuH0B0OvLodgUAi}8p1 zrO6RSXHH}DMc$&|?D004DiOVMHV8kXCP@7NKB zgaZq^^O<7PoKEp72kby@W0Z!Y*Ay{&vfg#C&gG@YVR9g?FEocMUi1gSN$+V+ayF45{a zuDZDTN}mS|;BO%gEf}pjBfN2-gIrU#G5~cucA;dokXW89%>AyXJJI z9X4UlIWA|ZYHgbI z5?oFk@A=Ik7lrEQPDH!H+b`7_Y~aDb_qa=B2^Y&Ow41cU=4WDd40dp5(QS-WMN-=Y z9g;6_-JdNU;|6cPwf$ak*aJIcwL@1n$#l~zi{c{EW?T;DaW*E8DYq?Umtz{nJ&w-M zEMyTDrC&9K$d|kZe2#ws6)L=7K+{ zQw{XnV6UC$6-rW0emqm8wJoeZK)wJIcV?dST}Z;G0Arq{dVDu0&4kd%N!3F1*;*pW zR&qUiFzK=@44#QGw7k1`3t_d8&*kBV->O##t|tonFc2YWrL7_eqg+=+k;!F-`^b8> z#KWCE8%u4k@EprxqiV$VmmtiWxDLgnGu$Vs<8rppV5EajBXL4nyyZM$SWVm!wnCj-B!Wjqj5-5dNXukI2$$|Bu3Lrw}z65Lc=1G z^-#WuQOj$hwNGG?*CM_TO8Bg-1+qc>J7k5c51U8g?ZU5n?HYor;~JIjoWH-G>AoUP ztrWWLbRNqIjW#RT*WqZgPJXU7C)VaW5}MiijYbABmzoru6EmQ*N8cVK7a3|aOB#O& zBl8JY2WKfmj;h#Q!pN%9o@VNLv{OUL?rixHwOZuvX7{IJ{(EdPpuVFoQqIOa7giLVkBOKL@^smUA!tZ1CKRK}#SSM)iQHk)*R~?M!qkCruaS!#oIL1c z?J;U~&FfH#*98^G?i}pA{ z9Jg36t4=%6mhY(quYq*vSxptes9qy|7xSlH?G=S@>u>Ebe;|LVhs~@+06N<4CViBk zUiY$thvX;>Tby6z9Y1edAMQaiH zm^r3v#$Q#2T=X>bsY#D%s!bhs^M9PMAcHbCc0FMHV{u-dwlL;a1eJ63v5U*?Q_8JO zT#50!RD619#j_Uf))0ooADz~*9&lN!bBDRUgE>Vud-i5ck%vT=r^yD*^?Mp@Q^v+V zG#-?gKlr}Eeqifb{|So?HM&g91P8|av8hQoCmQXkd?7wIJwb z_^v8bbg`SAn{I*4bH$u(RZ6*xUhuA~hc=8czK8SHEKTzSxgbwi~9(OqJB&gwb^l4+m`k*Q;_?>Y-APi1{k zAHQ)P)G)f|AyjSgcCFps)Fh6Bca*Xznq36!pV6Az&m{O8$wGFD? zY&O*3*J0;_EqM#jh6^gMQKpXV?#1?>$ml1xvh8nSN>-?H=V;nJIwB07YX$e6vLxH( zqYwQ>qxwR(i4f)DLd)-$P>T-no_c!LsN@)8`e;W@)-Hj0>nJ-}Kla4-ZdPJzI&Mce zv)V_j;(3ERN3_@I$N<^|4Lf`B;8n+bX@bHbcZTopEmDI*Jfl)-pFDvo6svPRoo@(x z);_{lY<;);XzT`dBFpRmGrr}z5u1=pC^S-{ce6iXQlLGcItwJ^mZx{m$&DA_oEZ)B{_bYPq-HA zcH8WGoBG(aBU_j)vEy+_71T34@4dmSg!|M8Vf92Zj6WH7Q7t#OHQqWgFE3ARt+%!T z?oLovLVlnf?2c7pTc)~cc^($_8nyKwsN`RA-23ed3sdj(ys%pjjM+9JrctL;dy8a( z@en&CQmnV(()bu|Y%G1-4a(6x{aLytn$T-;(&{QIJB9vMox11U-1HpD@d(QkaJdEb zG{)+6Dos_L+O3NpWo^=gR?evp|CqEG?L&Ut#D*KLaRFOgOEK(Kq1@!EGcTfo+%A&I z=dLbB+d$u{sh?u)xP{PF8L%;YPPW53+@{>5W=Jt#wQpN;0_HYdw1{ksf_XhO4#2F= zyPx6Lx2<92L-;L5PD`zn6zwIH`Jk($?Qw({erA$^bC;q33hv!d!>%wRhj# zal^hk+WGNg;rJtb-EB(?czvOM=H7dl=vblBwAv>}%1@{}mnpUznfq1cE^sgsL0*4I zJ##!*B?=vI_OEVis5o+_IwMIRrpQyT_Sq~ZU%oY7c5JMIADzpD!Upz9h@iWg_>>~j zOLS;wp^i$-E?4<_cp?RiS%Rd?i;f*mOz=~(&3lo<=@(nR!_Rqiprh@weZlL!t#NCc zO!QTcInq|%#>OVgobj{~ixEUec`E25zJ~*DofsQdzIa@5^nOXj2T;8O`l--(QyU^$t?TGY^7#&FQ+2SS3B#qK*k3`ye?8jUYSajE5iBbJls75CCc(m3dk{t?- zopcER9{Z?TC)mk~gpi^kbbu>b-+a{m#8-y2^p$ka4n60w;Sc2}HMf<8JUvhCL0B&Btk)T`ctE$*qNW8L$`7!r^9T+>=<=2qaq-;ll2{`{Rg zc5a0ZUI$oG&j-qVOuKa=*v4aY#IsoM+1|c4Z)<}lEDvy;5huB@1RJPquU2U*U-;gu z=En2m+qjBzR#DEJDO`WU)hdd{Vj%^0V*KoyZ|5lzV87&g_j~NCjwv0uQVqXOb*QrQ zy|Qn`hxx(58c70$E;L(X0uZZ72M1!6oeg)(cdKO ze0gDaTz+ohR-#d)NbAH4x{I(21yjwvBQfmpLu$)|m{XolbgF!pmsqJ#D}(ylp6uC> z{bqtcI#hT#HW=wl7>p!38sKsJ`r8}lt-q%Keqy%u(xk=yiIJiUw6|5IvkS+#?JTBl z8H5(Q?l#wzazujH!8o>1xtn8#_w+397*_cy8!pQGP%K(Ga3pAjsaTbbXJlQF_+m+-UpUUent@xM zg%jqLUExj~o^vQ3Gl*>wh=_gOr2*|U64_iXb+-111aH}$TjeajM+I20xw(((>fej-@CIz4S1pi$(#}P7`4({6QS2CaQS4NPENDp>sAqD z$bH4KGzXGffkJ7R>V>)>tC)uax{UsN*dbeNC*v}#8Y#OWYwL4t$ePR?VTyIs!wea+ z5Urmc)X|^`MG~*dS6pGSbU+gPJoq*^a=_>$n4|P^w$sMBBy@f*Z^Jg6?n5?oId6f{ z$LW4M|4m502z0t7g<#Bx%X;9<=)smFolV&(V^(7Cv2-sxbxopQ!)*#ZRhTBpx1)Fc zNm1T%bONzv6@#|dz(w02AH8OXe>kQ#1FMCzO}2J_mST)+ExmBr9cva-@?;wnmWMOk z{3_~EX_xadgJGv&H@zK_8{(x84`}+c?oSBX*Ge3VdfTt&F}yCpFP?CpW+BE^cWY0^ zb&uBN!Ja3UzYHK-CTyA5=L zEMW{l3Usky#ly=7px648W31UNV@K)&Ub&zP1c7%)`{);I4b0Q<)B}3;NMG2JH=X$U zfIW4)4n9ZM`-yRj67I)YSLDK)qfUJ_ij}a#aZN~9EXrh8eZY2&=uY%2N0UFF7<~%M zsB8=erOWZ>Ct_#^tHZ|*q`H;A)5;ycw*IcmVxi8_0Xk}aJA^ath+E;xg!x+As(M#0=)3!NJR6H&9+zd#iP(m0PIW8$ z1Y^VX`>jm`W!=WpF*{ioM?C9`yOR>@0q=u7o>BP-eSHqCgMDj!2anwH?s%i2p+Q7D zzszIf5XJpE)IG4;d_(La-xenmF(tgAxK`Y4sQ}BSJEPs6N_U2vI{8=0C_F?@7<(G; zo$~G=8p+076G;`}>{MQ>t>7cm=zGtfbdDXm6||jUU|?X?CaE?(<6bKDYKeHlz}DA8 zXT={X=yp_R;HfJ9h%?eWvQ!dRgz&Su*JfNt!Wu>|XfU&68iRikRrHRW|ZxzRR^`eIGt zIeiDgVS>IeExKVRWW8-=A=yA`}`)ZkWBrZD`hpWIxBGkh&f#ijr449~m`j6{4jiJ*C!oVA8ZC?$1RM#K(_b zL9TW)kN*Y4%^-qPpMP7d4)o?Nk#>aoYHT(*g)qmRUb?**F@pnNiy6Fv9rEiUqD(^O zzyS?nBrX63BTRYduaG(0VVG2yJRe%o&rVrLjbxTaAFTd8s;<<@Qs>u(<193R8>}2_ zuwp{7;H2a*X7_jryzriZXMg?bTuegABb^87@SsKkr2)0Gyiax8KQWstw^v#ix45EVrcEhr>!NMhprl$InQMzjSFH54x5k9qHc`@9uKQzvL4ihcq{^B zPrVR=o_ic%Y>6&rMN)hTZsI7I<3&`#(nl+3y3ys9A~&^=4?PL&nd8)`OfG#n zwAMN$1&>K++c{^|7<4P=2y(B{jJsQ0a#U;HTo4ZmWZYvI{+s;Td{Yzem%0*k#)vjpB zia;J&>}ICate44SFYY3vEelqStQWFihx%^vQ@Do(sOy7yR2@WNv7Y9I^yL=nZr3mb zXKV5t@=?-Sk|b{XMhA7ZGB@2hqsx}4xwCW!in#C zI@}scZlr3-NFJ@NFaJlhyfcw{k^vvtGl`N9xSo**rDW4S}i zM9{fMPWo%4wYDG~BZ18BD+}h|GQKc-g^{++3MY>}W_uq7jGHx{mwE9fZiPCoxN$+7 zrODGGJrOkcPQUB(FD5aoS4g~7#6NR^ma7-!>mHuJfY5kTe6PpNNKC9GGRiu^L31uG z$7v`*JknQHsYB!Tm_W{a32TM099djW%5e+j0Ve_ct}IM>XLF1Ap+YvcrLV=|CKo6S zb+9Nl3_YdKP6%Cxy@6TxZ>;4&nTneadr z_ES90ydCev)LV!dN=#(*f}|ZORFdvkYBni^aLbUk>BajeWIOcmHP#8S)*2U~QKI%S zyrLmtPqb&TphJ;>yAxri#;{uyk`JJqODDw%(Z=2`1uc}br^V%>j!gS)D*q*f_-qf8&D;W1dJgQMlaH5er zN2U<%Smb7==vE}dDI8K7cKz!vs^73o9f>2sgiTzWcwY|BMYHH5%Vn7#kiw&eItCqa zIkR2~Q}>X=Ar8W|^Ms41Fm8o6IB2_j60eOeBB1Br!boW7JnoeX6Gs)?7rW0^5psc- zjS16yb>dFn>KPOF;imD}e!enuIniFzv}n$m2#gCCv4jM#ArwlzZ$7@9&XkFxZ4n!V zj3dyiwW4Ki2QG{@i>yuZXQizw_OkZI^-3otXC{!(lUpJF33gI60ak;Uqitp74|B6I zgg{b=Iz}WkhCGj1M=hu4#Aw173YxIVbISaoc z-nLZC*6Tgivd5V`K%GxhBsp@SUU60-rfc$=wb>zdJzXS&-5(NRRodFk;Kxk!S(O(a0e7oY=E( zAyS;Ow?6Q&XA+cnkCb{28_1N8H#?J!*$MmIwLq^*T_9-z^&UE@A(z9oGYtFy6EZef LrJugUA?W`A8`#=m diff --git a/examples/custom/src/app/globals.css b/examples/custom/src/app/globals.css deleted file mode 100644 index 6f87ff013..000000000 --- a/examples/custom/src/app/globals.css +++ /dev/null @@ -1,30 +0,0 @@ -:root { - --foreground: #ffffff; - --background: #171717; -} - -html, -body { - max-width: 100vw; - overflow-x: hidden; - padding: 1rem; -} - -body { - color: var(--foreground); - background: var(--background); - font-family: Arial, Helvetica, sans-serif; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; -} - -* { - box-sizing: border-box; - padding: 0; - margin: 0; -} - -a { - color: inherit; - text-decoration: none; -} diff --git a/examples/custom/src/app/layout.tsx b/examples/custom/src/app/layout.tsx deleted file mode 100644 index ca4563772..000000000 --- a/examples/custom/src/app/layout.tsx +++ /dev/null @@ -1,43 +0,0 @@ -import type { Metadata } from "next"; -import { Geist, Geist_Mono } from "next/font/google"; -import "./globals.css"; -import { Sidebar } from "@/components/Sidebar"; - -const geistSans = Geist({ - variable: "--font-geist-sans", - subsets: ["latin"], -}); - -const geistMono = Geist_Mono({ - variable: "--font-geist-mono", - subsets: ["latin"], -}); - -export const metadata: Metadata = { - title: "Merged Docs Example (Next.js)", - description: "Generated by create next app", -}; - -export default function RootLayout({ - children, -}: Readonly<{ - children: React.ReactNode; -}>) { - return ( - - - {children} - - - ); -} diff --git a/examples/custom/src/app/mistral/api/endpoint/agents/page.mdx b/examples/custom/src/app/mistral/api/endpoint/agents/page.mdx deleted file mode 100644 index 40c888578..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/agents/page.mdx +++ /dev/null @@ -1,5592 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Agents Endpoints - - - - - -Agents API. - - - - - - - - - -## POST /v1/agents/completions \{#operation-agents_completion_v1_agents_completions_post\} - - - - - -Agents Completion - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.agents.complete(messages=[ - { - "content": "Who is the best French painter? Answer in one short sentence.", - "role": "user", - }, - ], agent_id="", stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-agents_completion_v1_agents_completions_post_request-examples\} - - - - - -```json -{ - "agent_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do" - } - ] -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_completion_v1_agents_completions_post_request\} - - - - - - - - - - - -##### agent_id \{#operation-agents_completion_v1_agents_completions_post_request_agent_id\} - - - - - -The ID of the agent to use for this completion. - - - - - - - - - -##### frequency_penalty \{#operation-agents_completion_v1_agents_completions_post_request_frequency_penalty\} - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens \{#operation-agents_completion_v1_agents_completions_post_request_max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-agents_completion_v1_agents_completions_post_request_messages\} - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - - - -#### SystemMessage \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage\} - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_role\} - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_role\} - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_name\} - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_role\} - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_tool_call_id\} - - - - - - - - - - - - - - - - - -##### n \{#operation-agents_completion_v1_agents_completions_post_request_n\} - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - - - -##### parallel_tool_calls \{#operation-agents_completion_v1_agents_completions_post_request_parallel_tool_calls\} - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction \{#operation-agents_completion_v1_agents_completions_post_request_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_completion_v1_agents_completions_post_request_presence_penalty\} - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode \{#operation-agents_completion_v1_agents_completions_post_request_prompt_mode\} - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - - - -##### random_seed \{#operation-agents_completion_v1_agents_completions_post_request_random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format \{#operation-agents_completion_v1_agents_completions_post_request_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_completion_v1_agents_completions_post_request_stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream \{#operation-agents_completion_v1_agents_completions_post_request_stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice\} - - - - - - - - - -#### ToolChoice \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice\} - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -#### FunctionName \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function_functionname\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function_functionname_name\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_type\} - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_completion_v1_agents_completions_post_request_tools\} - - - - - - - - - -#### Tool \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function\} - - - - - - - - - -#### Function \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function\} - - - - - - - - - -##### description \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_request_tools_tool_type\} - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_completion_v1_agents_completions_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_completion_v1_agents_completions_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices\} - - - - - - - - - -#### ChatCompletionChoice \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice\} - - - - - - - - - -##### finish_reason \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason\} - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_index\} - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message\} - - - - - - - - - -#### AssistantMessage \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_created\} - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_model\} - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_object\} - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage\} - - - - - - - - - -#### UsageInfo \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx b/examples/custom/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx deleted file mode 100644 index 04dec57f3..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx +++ /dev/null @@ -1,2038 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Audio Transcriptions Endpoints - - - - - -API for audio transcription. - - - - - - - - - -## POST /v1/audio/transcriptions \{#operation-audio_api_v1_transcriptions_post\} - - - - - -Create Transcription - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.audio.transcriptions.complete(model="Model X") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-audio_api_v1_transcriptions_post_request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-audio_api_v1_transcriptions_post_request\} - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-audio_api_v1_transcriptions_post_request_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File \{#operation-audio_api_v1_transcriptions_post_request_file_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content \{#operation-audio_api_v1_transcriptions_post_request_file_file_content\} - - - - - - - - - -##### fileName \{#operation-audio_api_v1_transcriptions_post_request_file_file_filename\} - - - - - - - - - - - - - - - - - -##### file_id \{#operation-audio_api_v1_transcriptions_post_request_file_id\} - - - - - -ID of a file uploaded to /v1/files - - - - - - - - - -##### file_url \{#operation-audio_api_v1_transcriptions_post_request_file_url\} - - - - - -Url of a file to be transcribed - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_request_language\} - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_request_model\} - - - - - - - - - -##### stream \{#operation-audio_api_v1_transcriptions_post_request_stream\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature \{#operation-audio_api_v1_transcriptions_post_request_temperature\} - - - - - - - - - -##### timestamp_granularities \{#operation-audio_api_v1_transcriptions_post_request_timestamp_granularities\} - - - - - -Granularities of timestamps to include in the response. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-audio_api_v1_transcriptions_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "language": null, - "model": "ipsum eiusmod", - "text": "consequat do", - "usage": {} -} -``` - - - - - - - - - - - - - -### Responses \{#operation-audio_api_v1_transcriptions_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_language\} - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_model\} - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### segments \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments\} - - - - - - - - - -#### TranscriptionSegmentChunk \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk\} - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_end\} - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_start\} - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_text\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_type\} - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_text\} - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage\} - - - - - - - - - -#### UsageInfo \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/audio/transcriptions\#stream \{#operation-audio_api_v1_transcriptions_post_stream\} - - - - - -Create streaming transcription (SSE) - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.audio.transcriptions.stream(model="Camry") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-audio_api_v1_transcriptions_post_stream_request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-audio_api_v1_transcriptions_post_stream_request\} - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-audio_api_v1_transcriptions_post_stream_request_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File \{#operation-audio_api_v1_transcriptions_post_stream_request_file_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content \{#operation-audio_api_v1_transcriptions_post_stream_request_file_file_content\} - - - - - - - - - -##### fileName \{#operation-audio_api_v1_transcriptions_post_stream_request_file_file_filename\} - - - - - - - - - - - - - - - - - -##### file_id \{#operation-audio_api_v1_transcriptions_post_stream_request_file_id\} - - - - - -ID of a file uploaded to /v1/files - - - - - - - - - -##### file_url \{#operation-audio_api_v1_transcriptions_post_stream_request_file_url\} - - - - - -Url of a file to be transcribed - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_stream_request_language\} - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_stream_request_model\} - - - - - - - - - -##### stream \{#operation-audio_api_v1_transcriptions_post_stream_request_stream\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### temperature \{#operation-audio_api_v1_transcriptions_post_stream_request_temperature\} - - - - - - - - - -##### timestamp_granularities \{#operation-audio_api_v1_transcriptions_post_stream_request_timestamp_granularities\} - - - - - -Granularities of timestamps to include in the response. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-audio_api_v1_transcriptions_post_stream_responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-audio_api_v1_transcriptions_post_stream_responses\} - - - - - -200 - - - - - - - -TranscriptionStreamEvents","children":[{"label":"TranscriptionStreamEvents","linkedLabel":"TranscriptionStreamEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Stream of transcription events - - - - - - - - - -#### TranscriptionStreamEvents \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents\} - - - - - -TranscriptionStreamTextDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamLanguage","linkedLabel":"TranscriptionStreamLanguage","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamSegmentDelta","linkedLabel":"TranscriptionStreamSegmentDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamDone","linkedLabel":"TranscriptionStreamDone","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data\} - - - - - - - - - -#### TranscriptionStreamTextDelta \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta\} - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta_text\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta_type\} - - - - - -_Default Value:_ `"transcription.text.delta"` - - - - - - - - - - - - - -#### TranscriptionStreamLanguage \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage\} - - - - - - - - - -##### audio_language \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage_audio_language\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage_type\} - - - - - -_Default Value:_ `"transcription.language"` - - - - - - - - - - - - - -#### TranscriptionStreamSegmentDelta \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta\} - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_end\} - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_start\} - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_text\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_type\} - - - - - -_Default Value:_ `"transcription.segment"` - - - - - - - - - - - - - -#### TranscriptionStreamDone \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone\} - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_language\} - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_model\} - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### segments \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments\} - - - - - - - - - -#### TranscriptionSegmentChunk \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk\} - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_end\} - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_start\} - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_text\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_type\} - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_text\} - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_type\} - - - - - -_Default Value:_ `"transcription.done"` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage\} - - - - - - - - - -#### UsageInfo \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - -##### event \{#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_event\} - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/batch/page.mdx b/examples/custom/src/app/mistral/api/endpoint/batch/page.mdx deleted file mode 100644 index 8a37aa043..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/batch/page.mdx +++ /dev/null @@ -1,2810 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Batch Endpoints - - - - - -Batch API - - - - - - - - - -## GET /v1/batch/jobs \{#operation-jobs_api_routes_batch_get_batch_jobs\} - - - - - -_Get Batch Jobs_ - - - - - -Get a list of batch jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.list(page=0, page_size=100, created_by_me=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_get_batch_jobs_responses-examples\} - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_get_batch_jobs_responses\} - - - - - -200 - - - - - - - -OK - - - - - -BatchJobOut","children":[{"label":"BatchJobOut","linkedLabel":"BatchJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data\} - - - - - - - - - -#### BatchJobOut \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout\} - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_agent_id\} - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_completed_at\} - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_completed_requests\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_created_at\} - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_endpoint\} - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_error_file\} - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### errors \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors\} - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror\} - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror_count\} - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror_message\} - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_failed_requests\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_id\} - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_input_files\} - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_metadata\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_model\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_object\} - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_output_file\} - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_started_at\} - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_status\} - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_succeeded_requests\} - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_total_requests\} - - - - - - - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_object\} - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total \{#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_total\} - - - - - - - - - - - - - - - - - - - -## POST /v1/batch/jobs \{#operation-jobs_api_routes_batch_create_batch_job\} - - - - - -_Create Batch Job_ - - - - - -Create a new batch job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.create(input_files=[ - "fe3343a2-3b8d-404b-ba32-a78dede2614a", - ], endpoint="/v1/moderations", timeout_hours=24) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-jobs_api_routes_batch_create_batch_job_request-examples\} - - - - - -```json -{ - "endpoint": "/v1/chat/completions", - "input_files": [ - "ipsum eiusmod" - ] -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-jobs_api_routes_batch_create_batch_job_request\} - - - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_create_batch_job_request_agent_id\} - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_create_batch_job_request_endpoint\} - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_create_batch_job_request_input_files\} - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_create_batch_job_request_metadata\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_create_batch_job_request_model\} - - - - - - - - - -##### timeout_hours \{#operation-jobs_api_routes_batch_create_batch_job_request_timeout_hours\} - - - - - -_Default Value:_ `24` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_create_batch_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_create_batch_job_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_agent_id\} - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_at\} - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_requests\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_created_at\} - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_endpoint\} - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_error_file\} - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors\} - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror\} - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror_count\} - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror_message\} - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_failed_requests\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_id\} - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_input_files\} - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_metadata\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_model\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_object\} - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_output_file\} - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_started_at\} - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_status\} - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_succeeded_requests\} - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_total_requests\} - - - - - - - - - - - - - - - - - - - -## GET /v1/batch/jobs/\{job\_id\} \{#operation-jobs_api_routes_batch_get_batch_job\} - - - - - -_Get Batch Job_ - - - - - -Get a batch job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.get(job_id="4017dc9f-b629-42f4-9700-8c681b9e7f0f") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_batch_get_batch_job_parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_batch_get_batch_job_parameters_job_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_get_batch_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_get_batch_job_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_agent_id\} - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_at\} - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_requests\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_created_at\} - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_endpoint\} - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_error_file\} - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors\} - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror\} - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror_count\} - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror_message\} - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_failed_requests\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_id\} - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_input_files\} - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_metadata\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_model\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_object\} - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_output_file\} - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_started_at\} - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_status\} - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_succeeded_requests\} - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_total_requests\} - - - - - - - - - - - - - - - - - - - -## POST /v1/batch/jobs/\{job\_id\}/cancel \{#operation-jobs_api_routes_batch_cancel_batch_job\} - - - - - -_Cancel Batch Job_ - - - - - -Request the cancellation of a batch job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.cancel(job_id="4fb29d1c-535b-4f0a-a1cb-2167f86da569") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_batch_cancel_batch_job_parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_batch_cancel_batch_job_parameters_job_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_cancel_batch_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_cancel_batch_job_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_agent_id\} - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_at\} - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_requests\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_created_at\} - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_endpoint\} - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_error_file\} - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors\} - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror\} - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror_count\} - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror_message\} - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_failed_requests\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_id\} - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_input_files\} - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_metadata\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_model\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_object\} - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_output_file\} - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_started_at\} - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_status\} - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_succeeded_requests\} - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_total_requests\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/beta/agents/page.mdx b/examples/custom/src/app/mistral/api/endpoint/beta/agents/page.mdx deleted file mode 100644 index 475fb3096..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/beta/agents/page.mdx +++ /dev/null @@ -1,10422 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Beta Agents Endpoints - - - - - -(beta) Agents API - - - - - - - - - -## GET /v1/agents \{#operation-agents_api_v1_agents_list\} - - - - - -_List agent entities._ - - - - - -Retrieve a list of agent entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.list(page=0, page_size=20) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_agents_list_parameters\} - - - - - - - - - - - -##### page \{#operation-agents_api_v1_agents_list_parameters_page\} - - - - - - - - - -##### page_size \{#operation-agents_api_v1_agents_list_parameters_page_size\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_list_responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_list_responses\} - - - - - -200 - - - - - - - -Agent","children":[{"label":"Agent","linkedLabel":"Agent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### Agent \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent\} - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_handoffs\} - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_object\} - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_updated_at\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_list_responses_200_application-json_agent_version\} - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_list_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/agents \{#operation-agents_api_v1_agents_create\} - - - - - -_Create a agent that can be used within a conversation._ - - - - - -Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.create(model="LeBaron", name="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-agents_api_v1_agents_create_request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod", - "name": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_agents_create_request\} - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_create_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_create_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_request_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_create_request_handoffs\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_create_request_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_create_request_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_request_name\} - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_create_request_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_create_request_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_create_request_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_create_request_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_create_request_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_create_request_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_create_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_create_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_create_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_responses_200_application-json_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_create_responses_200_application-json_handoffs\} - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_create_responses_200_application-json_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_create_responses_200_application-json_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_create_responses_200_application-json_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_responses_200_application-json_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_create_responses_200_application-json_object\} - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_create_responses_200_application-json_updated_at\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_create_responses_200_application-json_version\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_create_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/agents/\{agent\_id\} \{#operation-agents_api_v1_agents_get\} - - - - - -_Retrieve an agent entity._ - - - - - -Given an agent retrieve an agent entity with its attributes. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.get(agent_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_agents_get_parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_get_parameters_agent_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_get_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_get_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_get_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get_responses_200_application-json_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_get_responses_200_application-json_handoffs\} - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_get_responses_200_application-json_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_get_responses_200_application-json_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_get_responses_200_application-json_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get_responses_200_application-json_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_get_responses_200_application-json_object\} - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_get_responses_200_application-json_updated_at\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_get_responses_200_application-json_version\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_get_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PATCH /v1/agents/\{agent\_id\} \{#operation-agents_api_v1_agents_update\} - - - - - -_Update an agent entity._ - - - - - -Update an agent attributes and create a new version. - - - - - - - - - -TypeScript - - - - - -\",\n agentUpdateRequest: {},\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.update(agent_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_agents_update_parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_update_parameters_agent_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-agents_api_v1_agents_update_request-examples\} - - - - - -```json -{} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_agents_update_request\} - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_request_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update_request_handoffs\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update_request_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update_request_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_request_name\} - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update_request_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update_request_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update_request_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update_request_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update_request_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update_request_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_update_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_update_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_update_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_responses_200_application-json_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update_responses_200_application-json_handoffs\} - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_update_responses_200_application-json_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update_responses_200_application-json_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update_responses_200_application-json_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_responses_200_application-json_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_update_responses_200_application-json_object\} - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_update_responses_200_application-json_updated_at\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update_responses_200_application-json_version\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_update_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PATCH /v1/agents/\{agent\_id\}/version \{#operation-agents_api_v1_agents_update_version\} - - - - - -_Update an agent version._ - - - - - -Switch the version of an agent. - - - - - - - - - -TypeScript - - - - - -\",\n version: 157995,\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.update_version(agent_id="", version=157995) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_agents_update_version_parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_update_version_parameters_agent_id\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update_version_parameters_version\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_update_version_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_update_version_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_description\} - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_handoffs\} - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_object\} - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_updated_at\} - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update_version_responses_200_application-json_version\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/beta/conversations/page.mdx b/examples/custom/src/app/mistral/api/endpoint/beta/conversations/page.mdx deleted file mode 100644 index eab29c94d..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/beta/conversations/page.mdx +++ /dev/null @@ -1,39978 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Beta Conversations Endpoints - - - - - -(beta) Conversations API - - - - - - - - - -## GET /v1/conversations \{#operation-agents_api_v1_conversations_list\} - - - - - -_List all created conversations._ - - - - - -Retrieve a list of conversation entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.list(page=0, page_size=100) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_list_parameters\} - - - - - - - - - - - -##### page \{#operation-agents_api_v1_conversations_list_parameters_page\} - - - - - - - - - -##### page_size \{#operation-agents_api_v1_conversations_list_parameters_page_size\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_list_responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_list_responses\} - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation\} - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_description\} - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_name\} - - - - - -Name given to the conversation. - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_object\} - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_updated_at\} - - - - - - - - - - - - - -#### AgentConversation \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_agent_id\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_description\} - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_name\} - - - - - -Name given to the conversation. - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_object\} - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_updated_at\} - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_list_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations \{#operation-agents_api_v1_conversations_start\} - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.start(inputs="", stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_start_request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_start_request\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_request_agent_id\} - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_start_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_request_description\} - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_start_request_handoff_execution\} - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_start_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_start_request_instructions\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_request_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_request_name\} - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_start_request_store\} - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_start_request_stream\} - - - - - -_Default Value:_ `false` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_conversations_start_request_tools\} - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_start_request_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_start_request_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_start_request_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_start_request_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_start_request_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_start_responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_start_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_conversation_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_responses_200_application-json_object\} - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs\} - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_start_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/conversations/\{conversation\_id\} \{#operation-agents_api_v1_conversations_get\} - - - - - -_Retrieve a conversation information._ - - - - - -Given a conversation_id retrieve a conversation entity with its attributes. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_get_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_get_parameters_conversation_id\} - - - - - -ID of the conversation from which we are fetching metadata. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_get_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_get_responses\} - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation\} - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_description\} - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_id\} - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_name\} - - - - - -Name given to the conversation. - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_object\} - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_updated_at\} - - - - - - - - - - - - - -#### AgentConversation \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_agent_id\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_created_at\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_description\} - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_name\} - - - - - -Name given to the conversation. - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_object\} - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_updated_at\} - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_get_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations/\{conversation\_id\} \{#operation-agents_api_v1_conversations_append\} - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - -\",\n conversationAppendRequest: {\n inputs: [],\n },\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.append(conversation_id="", inputs=[], stream=False, store=True, handoff_execution="server") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_append_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_parameters_conversation_id\} - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_append_request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_append_request\} - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_append_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_append_request_handoff_execution\} - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_append_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_append_request_store\} - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_append_request_stream\} - - - - - -_Default Value:_ `false` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_append_responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_append_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_conversation_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_responses_200_application-json_object\} - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs\} - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_append_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/conversations/\{conversation\_id\}/history \{#operation-agents_api_v1_conversations_history\} - - - - - -_Retrieve all entries in a conversation._ - - - - - -Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get_history(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_history_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_history_parameters_conversation_id\} - - - - - -ID of the conversation from which we are fetching entries. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_history_responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "entries": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_history_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_conversation_id\} - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### entries \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history_responses_200_application-json_object\} - - - - - -_Default Value:_ `"conversation.history"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_history_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/conversations/\{conversation\_id\}/messages \{#operation-agents_api_v1_conversations_messages\} - - - - - -_Retrieve all messages in a conversation._ - - - - - -Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get_messages(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_messages_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_messages_parameters_conversation_id\} - - - - - -ID of the conversation from which we are fetching messages. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_messages_responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_messages_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_conversation_id\} - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages_responses_200_application-json_object\} - - - - - -_Default Value:_ `"conversation.messages"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart \{#operation-agents_api_v1_conversations_restart\} - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - -\",\n conversationRestartRequest: {\n inputs: \"\",\n fromEntryId: \"\",\n },\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.restart(conversation_id="", inputs="", from_entry_id="", stream=False, store=True, handoff_execution="server") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_restart_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_parameters_conversation_id\} - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_restart_request-examples\} - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_restart_request\} - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_restart_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### from_entry_id \{#operation-agents_api_v1_conversations_restart_request_from_entry_id\} - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_restart_request_handoff_execution\} - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_restart_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_restart_request_store\} - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_restart_request_stream\} - - - - - -_Default Value:_ `false` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_restart_responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_restart_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_conversation_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_object\} - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs\} - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations\#stream \{#operation-agents_api_v1_conversations_start_stream\} - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - -\",\n previousAgentName: \"\",\n nextAgentId: \"\",\n nextAgentName: \"\",\n },\n ],\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.start_stream(inputs=[ - { - "object": "entry", - "type": "function.result", - "tool_call_id": "", - "result": "", - }, - ], stream=True) - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_start_stream_request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_start_stream_request\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream_request_agent_id\} - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_start_stream_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream_request_description\} - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_start_stream_request_handoff_execution\} - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_start_stream_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_start_stream_request_instructions\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream_request_model\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_request_name\} - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_start_stream_request_store\} - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_start_stream_request_stream\} - - - - - -_Default Value:_ `true` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_conversations_start_stream_request_tools\} - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function\} - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_type\} - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_websearchtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_websearchtool_type\} - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_websearchpremiumtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_websearchpremiumtool_type\} - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_codeinterpretertool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_codeinterpretertool_type\} - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_imagegenerationtool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_imagegenerationtool_type\} - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool\} - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool_library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool_type\} - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_start_stream_responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_start_stream_responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents\} - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data\} - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent\} - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type\} - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type\} - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent\} - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at\} - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type\} - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type\} - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type\} - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type\} - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type\} - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type\} - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type\} - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type\} - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations/\{conversation\_id\}\#stream \{#operation-agents_api_v1_conversations_append_stream\} - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - -\",\n conversationAppendStreamRequest: {\n inputs: \"\",\n },\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.append_stream(conversation_id="", inputs="", stream=True, store=True, handoff_execution="server") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_append_stream_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_stream_parameters_conversation_id\} - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_append_stream_request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_append_stream_request\} - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_append_stream_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_append_stream_request_handoff_execution\} - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_append_stream_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_append_stream_request_store\} - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_append_stream_request_stream\} - - - - - -_Default Value:_ `true` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_append_stream_responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_append_stream_responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents\} - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data\} - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent\} - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type\} - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type\} - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent\} - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at\} - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type\} - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type\} - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type\} - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type\} - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type\} - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type\} - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type\} - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type\} - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart\#stream \{#operation-agents_api_v1_conversations_restart_stream\} - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - -\",\n conversationRestartStreamRequest: {\n inputs: [\n {\n object: \"entry\",\n type: \"message.input\",\n role: \"assistant\",\n content: \"\",\n prefix: false,\n },\n ],\n fromEntryId: \"\",\n },\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.restart_stream(conversation_id="", inputs=[ - { - "object": "entry", - "type": "message.input", - "role": "assistant", - "content": "", - "prefix": False, - }, - ], from_entry_id="", stream=True, store=True, handoff_execution="server") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-agents_api_v1_conversations_restart_stream_parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_stream_parameters_conversation_id\} - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-agents_api_v1_conversations_restart_stream_request-examples\} - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-agents_api_v1_conversations_restart_stream_request\} - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_frequency_penalty\} - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_max_tokens\} - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction\} - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction\} - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_presence_penalty\} - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_random_seed\} - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_stop\} - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_temperature\} - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_tool_choice\} - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_top_p\} - - - - - - - - - - - - - - - - - -##### from_entry_id \{#operation-agents_api_v1_conversations_restart_stream_request_from_entry_id\} - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_restart_stream_request_handoff_execution\} - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_restart_stream_request_inputs\} - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_prefix\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_role\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_type\} - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_agent_id\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_completed_at\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_model\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_type\} - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_id\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_result\} - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_type\} - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_type\} - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_arguments\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_type\} - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry\} - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_completed_at\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_next_agent_name\} - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_object\} - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_type\} - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_restart_stream_request_store\} - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_restart_stream_request_stream\} - - - - - -_Default Value:_ `true` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_restart_stream_responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_restart_stream_responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents\} - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data\} - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent\} - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type\} - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type\} - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage\} - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens\} - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors\} - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent\} - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at\} - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type\} - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type\} - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type\} - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id\} - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type\} - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent\} - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content\} - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk\} - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk\} - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id\} - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name\} - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type\} - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk\} - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description\} - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon\} - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title\} - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type\} - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url\} - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id\} - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type\} - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent\} - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id\} - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type\} - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id\} - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type\} - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent\} - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at\} - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id\} - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id\} - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name\} - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type\} - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx b/examples/custom/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx deleted file mode 100644 index 51c7ba61d..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx +++ /dev/null @@ -1,2096 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Beta Libraries Accesses Endpoints - - - - - -(beta) Libraries API - manage access to a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_list_v1\} - - - - - -_List all of the access to this library._ - - - - - -Given a library, list all of the Entity that have access and to what level. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.list(library_id="d2169833-d8e2-416e-a372-76518d3d99c2") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_share_list_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_list_v1_parameters_library_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_share_list_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_list_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -SharingOut","children":[{"label":"SharingOut","linkedLabel":"SharingOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_share_list_v1_responses_200_application-json_data\} - - - - - - - - - -#### SharingOut \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout\} - - - - - - - - - -##### library_id \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_library_id\} - - - - - - - - - -##### org_id \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_org_id\} - - - - - - - - - -##### role \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_role\} - - - - - - - - - -##### share_with_type \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_share_with_type\} - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_share_with_uuid\} - - - - - - - - - -##### user_id \{#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_user_id\} - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_list_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_list_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PUT /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_create_v1\} - - - - - -_Create or update an access level._ - - - - - -Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.update_or_create(library_id="36de3a24-5b1c-4c8f-9d84-d5642205a976", org_id="aadd9ae1-f285-4437-884a-091c77efa6fd", level="Viewer", share_with_uuid="0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20", share_with_type="User") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_share_create_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_create_v1_parameters_library_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-libraries_share_create_v1_request-examples\} - - - - - -```json -{ - "level": "Viewer", - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_share_create_v1_request\} - - - - - - - - - - - -##### level \{#operation-libraries_share_create_v1_request_level\} - - - - - - - - - -##### org_id \{#operation-libraries_share_create_v1_request_org_id\} - - - - - - - - - -##### share_with_type \{#operation-libraries_share_create_v1_request_share_with_type\} - - - - - -The type of entity, used to share a library. - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_create_v1_request_share_with_uuid\} - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_share_create_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_create_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id \{#operation-libraries_share_create_v1_responses_200_application-json_library_id\} - - - - - - - - - -##### org_id \{#operation-libraries_share_create_v1_responses_200_application-json_org_id\} - - - - - - - - - -##### role \{#operation-libraries_share_create_v1_responses_200_application-json_role\} - - - - - - - - - -##### share_with_type \{#operation-libraries_share_create_v1_responses_200_application-json_share_with_type\} - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_create_v1_responses_200_application-json_share_with_uuid\} - - - - - - - - - -##### user_id \{#operation-libraries_share_create_v1_responses_200_application-json_user_id\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_create_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_create_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## DELETE /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_delete_v1\} - - - - - -_Delete an access level._ - - - - - -Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.delete(library_id="709e3cad-9fb2-4f4e-bf88-143cf1808107", org_id="0814a235-c2d0-4814-875a-4b85f93d3dc7", share_with_uuid="b843cc47-ce8f-4354-8cfc-5fcd7fb2865b", share_with_type="User") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_share_delete_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_delete_v1_parameters_library_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-libraries_share_delete_v1_request-examples\} - - - - - -```json -{ - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_share_delete_v1_request\} - - - - - - - - - - - -##### org_id \{#operation-libraries_share_delete_v1_request_org_id\} - - - - - - - - - -##### share_with_type \{#operation-libraries_share_delete_v1_request_share_with_type\} - - - - - -The type of entity, used to share a library. - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_delete_v1_request_share_with_uuid\} - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_share_delete_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_delete_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id \{#operation-libraries_share_delete_v1_responses_200_application-json_library_id\} - - - - - - - - - -##### org_id \{#operation-libraries_share_delete_v1_responses_200_application-json_org_id\} - - - - - - - - - -##### role \{#operation-libraries_share_delete_v1_responses_200_application-json_role\} - - - - - - - - - -##### share_with_type \{#operation-libraries_share_delete_v1_responses_200_application-json_share_with_type\} - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_delete_v1_responses_200_application-json_share_with_uuid\} - - - - - - - - - -##### user_id \{#operation-libraries_share_delete_v1_responses_200_application-json_user_id\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_delete_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx b/examples/custom/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx deleted file mode 100644 index 7261e79c8..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx +++ /dev/null @@ -1,6567 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Beta Libraries Documents Endpoints - - - - - -(beta) Libraries API - manage documents in a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents \{#operation-libraries_documents_list_v1\} - - - - - -_List document in a given library._ - - - - - -Given a library, lists the document that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.list(library_id="5c3ca4cd-62bc-4c71-ad8a-1531ae80d078", page_size=100, page=0, sort_by="created_at", sort_order="desc") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-libraries_documents_list_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" - } - ], - "pagination": { - "current_page": 56, - "has_more": false, - "page_size": 91, - "total_items": 32, - "total_pages": 78 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_list_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -DocumentOut","children":[{"label":"DocumentOut","linkedLabel":"DocumentOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_documents_list_v1_responses_200_application-json_data\} - - - - - - - - - -#### DocumentOut \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout\} - - - - - - - - - -##### created_at \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_created_at\} - - - - - - - - - -##### extension \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_extension\} - - - - - - - - - -##### hash \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_hash\} - - - - - - - - - -##### id \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_id\} - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_last_processed_at\} - - - - - - - - - -##### library_id \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_library_id\} - - - - - - - - - -##### mime_type \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_mime_type\} - - - - - - - - - -##### name \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_name\} - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_number_of_pages\} - - - - - - - - - -##### processing_status \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_processing_status\} - - - - - - - - - -##### size \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_size\} - - - - - - - - - -##### summary \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_summary\} - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_main_content\} - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_summary\} - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_total\} - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_uploaded_by_id\} - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_uploaded_by_type\} - - - - - - - - - - - - - -PaginationInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pagination \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination\} - - - - - - - - - -#### PaginationInfo \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo\} - - - - - - - - - -##### current_page \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_current_page\} - - - - - - - - - -##### has_more \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_has_more\} - - - - - - - - - -##### page_size \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_page_size\} - - - - - - - - - -##### total_items \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_total_items\} - - - - - - - - - -##### total_pages \{#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_total_pages\} - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_list_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries/\{library\_id\}/documents \{#operation-libraries_documents_upload_v1\} - - - - - -_Upload a new document._ - - - - - -Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.upload(library_id="a02150d9-5ee0-4877-b62c-28b1fcdf3b76", file={ - "file_name": "example.file", - "content": open("example.file", "rb"), - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_upload_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_upload_v1_parameters_library_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-libraries_documents_upload_v1_request-examples\} - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_documents_upload_v1_request\} - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-libraries_documents_upload_v1_request_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File \{#operation-libraries_documents_upload_v1_request_file_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content \{#operation-libraries_documents_upload_v1_request_file_file_content\} - - - - - - - - - -##### fileName \{#operation-libraries_documents_upload_v1_request_file_file_filename\} - - - - - - - - - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_upload_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_upload_v1_responses\} - - - - - -200 - - - - - - - -A document with the same hash was found in this library. Returns the existing document. - - - - - - - - - -##### created_at \{#operation-libraries_documents_upload_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### extension \{#operation-libraries_documents_upload_v1_responses_200_application-json_extension\} - - - - - - - - - -##### hash \{#operation-libraries_documents_upload_v1_responses_200_application-json_hash\} - - - - - - - - - -##### id \{#operation-libraries_documents_upload_v1_responses_200_application-json_id\} - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_upload_v1_responses_200_application-json_last_processed_at\} - - - - - - - - - -##### library_id \{#operation-libraries_documents_upload_v1_responses_200_application-json_library_id\} - - - - - - - - - -##### mime_type \{#operation-libraries_documents_upload_v1_responses_200_application-json_mime_type\} - - - - - - - - - -##### name \{#operation-libraries_documents_upload_v1_responses_200_application-json_name\} - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_upload_v1_responses_200_application-json_number_of_pages\} - - - - - - - - - -##### processing_status \{#operation-libraries_documents_upload_v1_responses_200_application-json_processing_status\} - - - - - - - - - -##### size \{#operation-libraries_documents_upload_v1_responses_200_application-json_size\} - - - - - - - - - -##### summary \{#operation-libraries_documents_upload_v1_responses_200_application-json_summary\} - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_main_content\} - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_summary\} - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_total\} - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_id\} - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_type\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_upload_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_get_v1\} - - - - - -_Retrieve the metadata of a specific document._ - - - - - -Given a library and a document in this library, you can retrieve the metadata of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.get(library_id="03d908c8-90a1-44fd-bf3a-8490fb7c9a03", document_id="90973aec-0508-4375-8b00-91d732414745") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_get_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at \{#operation-libraries_documents_get_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### extension \{#operation-libraries_documents_get_v1_responses_200_application-json_extension\} - - - - - - - - - -##### hash \{#operation-libraries_documents_get_v1_responses_200_application-json_hash\} - - - - - - - - - -##### id \{#operation-libraries_documents_get_v1_responses_200_application-json_id\} - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_get_v1_responses_200_application-json_last_processed_at\} - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_v1_responses_200_application-json_library_id\} - - - - - - - - - -##### mime_type \{#operation-libraries_documents_get_v1_responses_200_application-json_mime_type\} - - - - - - - - - -##### name \{#operation-libraries_documents_get_v1_responses_200_application-json_name\} - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_get_v1_responses_200_application-json_number_of_pages\} - - - - - - - - - -##### processing_status \{#operation-libraries_documents_get_v1_responses_200_application-json_processing_status\} - - - - - - - - - -##### size \{#operation-libraries_documents_get_v1_responses_200_application-json_size\} - - - - - - - - - -##### summary \{#operation-libraries_documents_get_v1_responses_200_application-json_summary\} - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_main_content\} - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_summary\} - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_total\} - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_id\} - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_type\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PUT /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_update_v1\} - - - - - -_Update the metadata of a specific document._ - - - - - -Given a library and a document in that library, update the name of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.update(library_id="3ddd8d93-dca5-4a6d-980d-173226c35742", document_id="2a25e44c-b160-40ca-b5c2-b65fb2fcae34") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_update_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_update_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_update_v1_parameters_document_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-libraries_documents_update_v1_request-examples\} - - - - - -```json -{} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_documents_update_v1_request\} - - - - - - - - - - - -##### name \{#operation-libraries_documents_update_v1_request_name\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_update_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_update_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at \{#operation-libraries_documents_update_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### extension \{#operation-libraries_documents_update_v1_responses_200_application-json_extension\} - - - - - - - - - -##### hash \{#operation-libraries_documents_update_v1_responses_200_application-json_hash\} - - - - - - - - - -##### id \{#operation-libraries_documents_update_v1_responses_200_application-json_id\} - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_update_v1_responses_200_application-json_last_processed_at\} - - - - - - - - - -##### library_id \{#operation-libraries_documents_update_v1_responses_200_application-json_library_id\} - - - - - - - - - -##### mime_type \{#operation-libraries_documents_update_v1_responses_200_application-json_mime_type\} - - - - - - - - - -##### name \{#operation-libraries_documents_update_v1_responses_200_application-json_name\} - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_update_v1_responses_200_application-json_number_of_pages\} - - - - - - - - - -##### processing_status \{#operation-libraries_documents_update_v1_responses_200_application-json_processing_status\} - - - - - - - - - -##### size \{#operation-libraries_documents_update_v1_responses_200_application-json_size\} - - - - - - - - - -##### summary \{#operation-libraries_documents_update_v1_responses_200_application-json_summary\} - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_main_content\} - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_summary\} - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_total\} - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_id\} - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_type\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_update_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## DELETE /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_delete_v1\} - - - - - -_Delete a document._ - - - - - -Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - mistral.beta.libraries.documents.delete(library_id="005daae9-d42e-407d-82d7-2261c6a1496c", document_id="edc236b0-baff-49a9-884b-4ca36a258da4") - - # Use the SDK ... - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_delete_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_delete_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_delete_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_delete_v1_responses-examples\} - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_documents_delete_v1_responses\} - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_delete_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/text\_content \{#operation-libraries_documents_get_text_content_v1\} - - - - - -_Retrieve the text content of a specific document._ - - - - - -Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.text_content(library_id="1d177215-3b6b-45ba-9fa9-baf773223bec", document_id="60214c91-2aba-4692-a4e6-a53365de8caf") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_get_text_content_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_text_content_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_text_content_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_text_content_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "text": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_text_content_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### text \{#operation-libraries_documents_get_text_content_v1_responses_200_application-json_text\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/status \{#operation-libraries_documents_get_status_v1\} - - - - - -_Retrieve the processing status of a specific document._ - - - - - -Given a library and a document in that library, retrieve the processing status of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.status(library_id="e6906f70-368f-4155-80da-c1718f01bc43", document_id="2c904915-d831-4e9d-a345-8ce405bcef66") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_get_status_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_status_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_status_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_status_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "document_id": "ipsum eiusmod", - "processing_status": "consequat do" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_status_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_status_v1_responses_200_application-json_document_id\} - - - - - - - - - -##### processing_status \{#operation-libraries_documents_get_status_v1_responses_200_application-json_processing_status\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_status_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/signed-url \{#operation-libraries_documents_get_signed_url_v1\} - - - - - -_Retrieve the signed URL of a specific document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.get_signed_url(library_id="23cf6904-a602-4ee8-9f5b-8efc557c336d", document_id="48598486-df71-4994-acbb-1133c72efa8c") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_get_signed_url_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_signed_url_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_signed_url_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_signed_url_v1_responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_signed_url_v1_responses\} - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/extracted-text-signed-url \{#operation-libraries_documents_get_extracted_text_signed_url_v1\} - - - - - -_Retrieve the signed URL of text extracted from a given document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.extracted_text_signed_url(library_id="a6f15de3-1e82-4f95-af82-851499042ef8", document_id="9749d4f9-24e5-4ca2-99a3-a406863f805d") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses\} - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries/\{library\_id\}/documents/\{document\_id\}/reprocess \{#operation-libraries_documents_reprocess_v1\} - - - - - -_Reprocess a document._ - - - - - -Given a library and a document in that library, reprocess that document, it will be billed again. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - mistral.beta.libraries.documents.reprocess(library_id="51b29371-de8f-4ba4-932b-a0bafb3a7f64", document_id="3052422c-49ca-45ac-a918-cadb35d61fd8") - - # Use the SDK ... - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_documents_reprocess_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_reprocess_v1_parameters_library_id\} - - - - - - - - - -##### document_id \{#operation-libraries_documents_reprocess_v1_parameters_document_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_documents_reprocess_v1_responses-examples\} - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_documents_reprocess_v1_responses\} - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/page.mdx b/examples/custom/src/app/mistral/api/endpoint/beta/libraries/page.mdx deleted file mode 100644 index c77e2008e..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/beta/libraries/page.mdx +++ /dev/null @@ -1,3786 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Beta Libraries Endpoints - - - - - -(beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - - - - - - - - - -## GET /v1/libraries \{#operation-libraries_list_v1\} - - - - - -_List all libraries you have access to._ - - - - - -List all libraries that you have created or have been shared with you. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.list() - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-libraries_list_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_list_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -LibraryOut","children":[{"label":"LibraryOut","linkedLabel":"LibraryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_list_v1_responses_200_application-json_data\} - - - - - - - - - -#### LibraryOut \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout\} - - - - - - - - - -##### chunk_size \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_chunk_size\} - - - - - - - - - -##### created_at \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_created_at\} - - - - - - - - - -##### description \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_description\} - - - - - - - - - -##### emoji \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_emoji\} - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_explicit_user_members_count\} - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_explicit_workspace_members_count\} - - - - - - - - - -##### generated_description \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_generated_description\} - - - - - - - - - -##### generated_name \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_generated_name\} - - - - - - - - - -##### id \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_id\} - - - - - - - - - -##### name \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_name\} - - - - - - - - - -##### nb_documents \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_nb_documents\} - - - - - - - - - -##### org_sharing_role \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_org_sharing_role\} - - - - - - - - - -##### owner_id \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_owner_id\} - - - - - - - - - -##### owner_type \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_owner_type\} - - - - - - - - - -##### total_size \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_total_size\} - - - - - - - - - -##### updated_at \{#operation-libraries_list_v1_responses_200_application-json_data_libraryout_updated_at\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries \{#operation-libraries_create_v1\} - - - - - -_Create a new Library._ - - - - - -Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.create(name="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-libraries_create_v1_request-examples\} - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_create_v1_request\} - - - - - - - - - - - -##### chunk_size \{#operation-libraries_create_v1_request_chunk_size\} - - - - - - - - - -##### description \{#operation-libraries_create_v1_request_description\} - - - - - - - - - -##### name \{#operation-libraries_create_v1_request_name\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_create_v1_responses-examples\} - - - - - -201 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_create_v1_responses\} - - - - - -201 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_create_v1_responses_201_application-json_chunk_size\} - - - - - - - - - -##### created_at \{#operation-libraries_create_v1_responses_201_application-json_created_at\} - - - - - - - - - -##### description \{#operation-libraries_create_v1_responses_201_application-json_description\} - - - - - - - - - -##### emoji \{#operation-libraries_create_v1_responses_201_application-json_emoji\} - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_create_v1_responses_201_application-json_explicit_user_members_count\} - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_create_v1_responses_201_application-json_explicit_workspace_members_count\} - - - - - - - - - -##### generated_description \{#operation-libraries_create_v1_responses_201_application-json_generated_description\} - - - - - - - - - -##### generated_name \{#operation-libraries_create_v1_responses_201_application-json_generated_name\} - - - - - - - - - -##### id \{#operation-libraries_create_v1_responses_201_application-json_id\} - - - - - - - - - -##### name \{#operation-libraries_create_v1_responses_201_application-json_name\} - - - - - - - - - -##### nb_documents \{#operation-libraries_create_v1_responses_201_application-json_nb_documents\} - - - - - - - - - -##### org_sharing_role \{#operation-libraries_create_v1_responses_201_application-json_org_sharing_role\} - - - - - - - - - -##### owner_id \{#operation-libraries_create_v1_responses_201_application-json_owner_id\} - - - - - - - - - -##### owner_type \{#operation-libraries_create_v1_responses_201_application-json_owner_type\} - - - - - - - - - -##### total_size \{#operation-libraries_create_v1_responses_201_application-json_total_size\} - - - - - - - - - -##### updated_at \{#operation-libraries_create_v1_responses_201_application-json_updated_at\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_create_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_create_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_create_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/libraries/\{library\_id\} \{#operation-libraries_get_v1\} - - - - - -_Detailed information about a specific Library._ - - - - - -Given a library id, details information about that Library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.get(library_id="d0d23a1e-bfe5-45e7-b7bb-22a4ea78d47f") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_get_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_get_v1_parameters_library_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_get_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_get_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_get_v1_responses_200_application-json_chunk_size\} - - - - - - - - - -##### created_at \{#operation-libraries_get_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-libraries_get_v1_responses_200_application-json_description\} - - - - - - - - - -##### emoji \{#operation-libraries_get_v1_responses_200_application-json_emoji\} - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_get_v1_responses_200_application-json_explicit_user_members_count\} - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_get_v1_responses_200_application-json_explicit_workspace_members_count\} - - - - - - - - - -##### generated_description \{#operation-libraries_get_v1_responses_200_application-json_generated_description\} - - - - - - - - - -##### generated_name \{#operation-libraries_get_v1_responses_200_application-json_generated_name\} - - - - - - - - - -##### id \{#operation-libraries_get_v1_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-libraries_get_v1_responses_200_application-json_name\} - - - - - - - - - -##### nb_documents \{#operation-libraries_get_v1_responses_200_application-json_nb_documents\} - - - - - - - - - -##### org_sharing_role \{#operation-libraries_get_v1_responses_200_application-json_org_sharing_role\} - - - - - - - - - -##### owner_id \{#operation-libraries_get_v1_responses_200_application-json_owner_id\} - - - - - - - - - -##### owner_type \{#operation-libraries_get_v1_responses_200_application-json_owner_type\} - - - - - - - - - -##### total_size \{#operation-libraries_get_v1_responses_200_application-json_total_size\} - - - - - - - - - -##### updated_at \{#operation-libraries_get_v1_responses_200_application-json_updated_at\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_get_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_get_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_get_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PUT /v1/libraries/\{library\_id\} \{#operation-libraries_update_v1\} - - - - - -_Update a library._ - - - - - -Given a library id, you can update the name and description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.update(library_id="e01880c3-d0b5-4a29-8b1b-abdb8ce917e4") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_update_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_update_v1_parameters_library_id\} - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-libraries_update_v1_request-examples\} - - - - - -```json -{} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-libraries_update_v1_request\} - - - - - - - - - - - -##### description \{#operation-libraries_update_v1_request_description\} - - - - - - - - - -##### name \{#operation-libraries_update_v1_request_name\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_update_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_update_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_update_v1_responses_200_application-json_chunk_size\} - - - - - - - - - -##### created_at \{#operation-libraries_update_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-libraries_update_v1_responses_200_application-json_description\} - - - - - - - - - -##### emoji \{#operation-libraries_update_v1_responses_200_application-json_emoji\} - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_update_v1_responses_200_application-json_explicit_user_members_count\} - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_update_v1_responses_200_application-json_explicit_workspace_members_count\} - - - - - - - - - -##### generated_description \{#operation-libraries_update_v1_responses_200_application-json_generated_description\} - - - - - - - - - -##### generated_name \{#operation-libraries_update_v1_responses_200_application-json_generated_name\} - - - - - - - - - -##### id \{#operation-libraries_update_v1_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-libraries_update_v1_responses_200_application-json_name\} - - - - - - - - - -##### nb_documents \{#operation-libraries_update_v1_responses_200_application-json_nb_documents\} - - - - - - - - - -##### org_sharing_role \{#operation-libraries_update_v1_responses_200_application-json_org_sharing_role\} - - - - - - - - - -##### owner_id \{#operation-libraries_update_v1_responses_200_application-json_owner_id\} - - - - - - - - - -##### owner_type \{#operation-libraries_update_v1_responses_200_application-json_owner_type\} - - - - - - - - - -##### total_size \{#operation-libraries_update_v1_responses_200_application-json_total_size\} - - - - - - - - - -##### updated_at \{#operation-libraries_update_v1_responses_200_application-json_updated_at\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_update_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_update_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_update_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## DELETE /v1/libraries/\{library\_id\} \{#operation-libraries_delete_v1\} - - - - - -_Delete a library and all of it's document._ - - - - - -Given a library id, deletes it together with all documents that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.delete(library_id="6cad0b6e-fd2e-4d11-a48b-21d30fb7c17a") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-libraries_delete_v1_parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_delete_v1_parameters_library_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-libraries_delete_v1_responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_delete_v1_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_delete_v1_responses_200_application-json_chunk_size\} - - - - - - - - - -##### created_at \{#operation-libraries_delete_v1_responses_200_application-json_created_at\} - - - - - - - - - -##### description \{#operation-libraries_delete_v1_responses_200_application-json_description\} - - - - - - - - - -##### emoji \{#operation-libraries_delete_v1_responses_200_application-json_emoji\} - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_delete_v1_responses_200_application-json_explicit_user_members_count\} - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_delete_v1_responses_200_application-json_explicit_workspace_members_count\} - - - - - - - - - -##### generated_description \{#operation-libraries_delete_v1_responses_200_application-json_generated_description\} - - - - - - - - - -##### generated_name \{#operation-libraries_delete_v1_responses_200_application-json_generated_name\} - - - - - - - - - -##### id \{#operation-libraries_delete_v1_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-libraries_delete_v1_responses_200_application-json_name\} - - - - - - - - - -##### nb_documents \{#operation-libraries_delete_v1_responses_200_application-json_nb_documents\} - - - - - - - - - -##### org_sharing_role \{#operation-libraries_delete_v1_responses_200_application-json_org_sharing_role\} - - - - - - - - - -##### owner_id \{#operation-libraries_delete_v1_responses_200_application-json_owner_id\} - - - - - - - - - -##### owner_type \{#operation-libraries_delete_v1_responses_200_application-json_owner_type\} - - - - - - - - - -##### total_size \{#operation-libraries_delete_v1_responses_200_application-json_total_size\} - - - - - - - - - -##### updated_at \{#operation-libraries_delete_v1_responses_200_application-json_updated_at\} - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_delete_v1_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_delete_v1_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/chat/page.mdx b/examples/custom/src/app/mistral/api/endpoint/chat/page.mdx deleted file mode 100644 index 6d754cae5..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/chat/page.mdx +++ /dev/null @@ -1,7099 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Chat Endpoints - - - - - -Chat Completion API. - - - - - - - - - -## POST /v1/chat/completions \{#operation-chat_completion_v1_chat_completions_post\} - - - - - -Chat Completion - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.chat.complete(model="mistral-small-latest", messages=[ - { - "content": "Who is the best French painter? Answer in one short sentence.", - "role": "user", - }, - ], stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-chat_completion_v1_chat_completions_post_request-examples\} - - - - - -```json -{ - "messages": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "mistral-small-latest" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-chat_completion_v1_chat_completions_post_request\} - - - - - - - - - - - -##### frequency_penalty \{#operation-chat_completion_v1_chat_completions_post_request_frequency_penalty\} - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens \{#operation-chat_completion_v1_chat_completions_post_request_max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-chat_completion_v1_chat_completions_post_request_messages\} - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - - - -#### SystemMessage \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage\} - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_role\} - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_role\} - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_name\} - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_role\} - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_tool_call_id\} - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post_request_model\} - - - - - -ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### n \{#operation-chat_completion_v1_chat_completions_post_request_n\} - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - - - -##### parallel_tool_calls \{#operation-chat_completion_v1_chat_completions_post_request_parallel_tool_calls\} - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction \{#operation-chat_completion_v1_chat_completions_post_request_prediction\} - - - - - - - - - -#### Prediction \{#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction\} - - - - - - - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction_content\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction_type\} - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-chat_completion_v1_chat_completions_post_request_presence_penalty\} - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode \{#operation-chat_completion_v1_chat_completions_post_request_prompt_mode\} - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - - - -##### random_seed \{#operation-chat_completion_v1_chat_completions_post_request_random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format \{#operation-chat_completion_v1_chat_completions_post_request_response_format\} - - - - - - - - - -#### ResponseFormat \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### safe_prompt \{#operation-chat_completion_v1_chat_completions_post_request_safe_prompt\} - - - - - -Whether to inject a safety prompt before all conversations. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### stop \{#operation-chat_completion_v1_chat_completions_post_request_stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream \{#operation-chat_completion_v1_chat_completions_post_request_stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature \{#operation-chat_completion_v1_chat_completions_post_request_temperature\} - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice\} - - - - - - - - - -#### ToolChoice \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice\} - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -#### FunctionName \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function_functionname\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function_functionname_name\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_type\} - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-chat_completion_v1_chat_completions_post_request_tools\} - - - - - - - - - -#### Tool \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool\} - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function\} - - - - - - - - - -#### Function \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function\} - - - - - - - - - -##### description \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_description\} - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_name\} - - - - - - - - - -##### parameters \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_parameters\} - - - - - - - - - -##### strict \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_request_tools_tool_type\} - - - - - - - - - - - - - - - - - -##### top_p \{#operation-chat_completion_v1_chat_completions_post_request_top_p\} - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - -_Default Value:_ `1` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-chat_completion_v1_chat_completions_post_responses-examples\} - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_completion_v1_chat_completions_post_responses\} - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices\} - - - - - - - - - -#### ChatCompletionChoice \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice\} - - - - - - - - - -##### finish_reason \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason\} - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_index\} - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message\} - - - - - - - - - -#### AssistantMessage \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_created\} - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_model\} - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_object\} - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage\} - - - - - - - - - -#### UsageInfo \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent\} - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data\} - - - - - - - - - -#### CompletionChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk\} - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices\} - - - - - - - - - -#### CompletionResponseStreamChoice \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice\} - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta\} - - - - - - - - - -#### DeltaMessage \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_role\} - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_finish_reason\} - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_index\} - - - - - - - - - - - - - - - - - -##### created \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_created\} - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_id\} - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_model\} - - - - - - - - - -##### object \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_object\} - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage\} - - - - - - - - - -#### UsageInfo \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/classifiers/page.mdx b/examples/custom/src/app/mistral/api/endpoint/classifiers/page.mdx deleted file mode 100644 index f006529d5..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/classifiers/page.mdx +++ /dev/null @@ -1,8244 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Classifiers Endpoints - - - - - -Classifiers API. - - - - - - - - - -## POST /v1/moderations \{#operation-moderations_v1_moderations_post\} - - - - - -Moderations - - - - - - - - - -TypeScript - - - - - -\",\n \"\",\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.moderate(model="Durango", inputs=[ - "", - "", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-moderations_v1_moderations_post_request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-moderations_v1_moderations_post_request\} - - - - - - - - - - - -##### input \{#operation-moderations_v1_moderations_post_request_input\} - - - - - -Text to classify. - - - - - - - - - -##### model \{#operation-moderations_v1_moderations_post_request_model\} - - - - - -ID of the model to use. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-moderations_v1_moderations_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-moderations_v1_moderations_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-moderations_v1_moderations_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-moderations_v1_moderations_post_responses_200_application-json_model\} - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-moderations_v1_moderations_post_responses_200_application-json_results\} - - - - - - - - - -#### ModerationObject \{#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject\} - - - - - - - - - -##### categories \{#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject_categories\} - - - - - -Moderation result thresholds - - - - - - - - - -##### category_scores \{#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject_category_scores\} - - - - - -Moderation result - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-moderations_v1_moderations_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/chat/moderations \{#operation-chat_moderations_v1_chat_moderations_post\} - - - - - -Chat Moderations - - - - - - - - - -TypeScript - - - - - -\",\n role: \"tool\",\n },\n ],\n model: \"LeBaron\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.moderate_chat(inputs=[ - { - "content": "", - "role": "tool", - }, - ], model="LeBaron") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-chat_moderations_v1_chat_moderations_post_request-examples\} - - - - - -```json -{ - "input": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-chat_moderations_v1_chat_moderations_post_request\} - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"union","children":[{"label":"array","linkedLabel":"union","children":[{"label":"union","linkedLabel":"union","children":[{"label":"SystemMessage","linkedLabel":"SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input \{#operation-chat_moderations_v1_chat_moderations_post_request_input\} - - - - - -Chat to classify - - - - - - - - - -#### SystemMessage \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage\} - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_role\} - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_role\} - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_name\} - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_role\} - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_tool_call_id\} - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_moderations_v1_chat_moderations_post_request_model\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-chat_moderations_v1_chat_moderations_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_moderations_v1_chat_moderations_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_model\} - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results\} - - - - - - - - - -#### ModerationObject \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject\} - - - - - - - - - -##### categories \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject_categories\} - - - - - -Moderation result thresholds - - - - - - - - - -##### category_scores \{#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject_category_scores\} - - - - - -Moderation result - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/classifications \{#operation-classifications_v1_classifications_post\} - - - - - -Classifications - - - - - - - - - -TypeScript - - - - - -\",\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.classify(model="Silverado", inputs=[ - "", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-classifications_v1_classifications_post_request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-classifications_v1_classifications_post_request\} - - - - - - - - - - - -##### input \{#operation-classifications_v1_classifications_post_request_input\} - - - - - -Text to classify. - - - - - - - - - -##### model \{#operation-classifications_v1_classifications_post_request_model\} - - - - - -ID of the model to use. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-classifications_v1_classifications_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-classifications_v1_classifications_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-classifications_v1_classifications_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-classifications_v1_classifications_post_responses_200_application-json_model\} - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-classifications_v1_classifications_post_responses_200_application-json_results\} - - - - - - - - - -#### ClassificationTargetResult \{#operation-classifications_v1_classifications_post_responses_200_application-json_results_classificationtargetresult\} - - - - - - - - - -##### scores \{#operation-classifications_v1_classifications_post_responses_200_application-json_results_classificationtargetresult_scores\} - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-classifications_v1_classifications_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/chat/classifications \{#operation-chat_classifications_v1_chat_classifications_post\} - - - - - -Chat Classifications - - - - - - - - - -TypeScript - - - - - -\",\n role: \"system\",\n },\n ],\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.classify_chat(model="Camry", inputs=[ - { - "messages": [ - { - "content": "", - "role": "system", - }, - ], - }, - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-chat_classifications_v1_chat_classifications_post_request-examples\} - - - - - -```json -{ - "input": { - "messages": [ - { - "content": "ipsum eiusmod" - } - ] - }, - "model": "consequat do" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-chat_classifications_v1_chat_classifications_post_request\} - - - - - - - -InstructRequest","children":[],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"InstructRequest","children":[{"label":"InstructRequest","linkedLabel":"InstructRequest","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input \{#operation-chat_classifications_v1_chat_classifications_post_request_input\} - - - - - -Chat to classify - - - - - - - - - -#### InstructRequest \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest\} - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### messages \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages\} - - - - - - - - - -#### SystemMessage \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage\} - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_role\} - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_role\} - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_name\} - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_role\} - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_tool_call_id\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_classifications_v1_chat_classifications_post_request_model\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-chat_classifications_v1_chat_classifications_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_classifications_v1_chat_classifications_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_model\} - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results\} - - - - - - - - - -#### ClassificationTargetResult \{#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results_classificationtargetresult\} - - - - - - - - - -##### scores \{#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results_classificationtargetresult_scores\} - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/embeddings/page.mdx b/examples/custom/src/app/mistral/api/endpoint/embeddings/page.mdx deleted file mode 100644 index 9a241aadc..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/embeddings/page.mdx +++ /dev/null @@ -1,983 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Embeddings Endpoints - - - - - -Embeddings API. - - - - - - - - - -## POST /v1/embeddings \{#operation-embeddings_v1_embeddings_post\} - - - - - -_Embeddings_ - - - - - -Embeddings - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.embeddings.create(model="mistral-embed", inputs=[ - "Embed this sentence.", - "As well as this one.", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-embeddings_v1_embeddings_post_request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "mistral-embed" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-embeddings_v1_embeddings_post_request\} - - - - - - - - - - - -##### input \{#operation-embeddings_v1_embeddings_post_request_input\} - - - - - -Text to embed. - - - - - - - - - -##### model \{#operation-embeddings_v1_embeddings_post_request_model\} - - - - - -ID of the model to use. - - - - - -_Example:_ - -``` -mistral-embed -``` - - - - - - - - - -##### output_dimension \{#operation-embeddings_v1_embeddings_post_request_output_dimension\} - - - - - -The dimension of the output embeddings. - - - - - - - - - -##### output_dtype \{#operation-embeddings_v1_embeddings_post_request_output_dtype\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-embeddings_v1_embeddings_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - {} - ], - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-embeddings_v1_embeddings_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -EmbeddingResponseData","children":[{"label":"EmbeddingResponseData","linkedLabel":"EmbeddingResponseData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_data\} - - - - - - - - - -#### EmbeddingResponseData \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata\} - - - - - - - - - -##### embedding \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_embedding\} - - - - - - - - - -##### index \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_index\} - - - - - -_Example:_ - -``` -0 -``` - - - - - - - - - -##### object \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_object\} - - - - - -_Example:_ - -``` -embedding -``` - - - - - - - - - - - - - - - - - -##### id \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_model\} - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_object\} - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage\} - - - - - - - - - -#### UsageInfo \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/files/page.mdx b/examples/custom/src/app/mistral/api/endpoint/files/page.mdx deleted file mode 100644 index 452fee708..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/files/page.mdx +++ /dev/null @@ -1,2637 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Files Endpoints - - - - - -Files API - - - - - - - - - -## GET /v1/files \{#operation-files_api_routes_list_files\} - - - - - -_List Files_ - - - - - -Returns a list of files that belong to the user's organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.list(page=0, page_size=100) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-files_api_routes_list_files_responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" - } - ], - "object": "occaecat dolor sit", - "total": 56 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_list_files_responses\} - - - - - -200 - - - - - - - -OK - - - - - -FileSchema","children":[{"label":"FileSchema","linkedLabel":"FileSchema","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-files_api_routes_list_files_responses_200_application-json_data\} - - - - - - - - - -#### FileSchema \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema\} - - - - - - - - - -##### bytes \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### filename \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_mimetype\} - - - - - - - - - -##### num_lines \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_num_lines\} - - - - - - - - - -##### object \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_purpose\} - - - - - - - - - -##### sample_type \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_sample_type\} - - - - - - - - - -##### signature \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_signature\} - - - - - - - - - -##### source \{#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_source\} - - - - - - - - - - - - - - - - - -##### object \{#operation-files_api_routes_list_files_responses_200_application-json_object\} - - - - - - - - - -##### total \{#operation-files_api_routes_list_files_responses_200_application-json_total\} - - - - - - - - - - - - - - - - - - - -## POST /v1/files \{#operation-files_api_routes_upload_file\} - - - - - -_Upload File_ - - - - - -Upload a file that can be used across various endpoints. - -The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - -Please contact us if you need to increase these storage limits. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.upload(file={ - "file_name": "example.file", - "content": open("example.file", "rb"), - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-files_api_routes_upload_file_request-examples\} - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-files_api_routes_upload_file_request\} - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-files_api_routes_upload_file_request_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File \{#operation-files_api_routes_upload_file_request_file_file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content \{#operation-files_api_routes_upload_file_request_file_file_content\} - - - - - - - - - -##### fileName \{#operation-files_api_routes_upload_file_request_file_file_filename\} - - - - - - - - - - - - - - - - - -##### purpose \{#operation-files_api_routes_upload_file_request_purpose\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-files_api_routes_upload_file_responses-examples\} - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_upload_file_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes \{#operation-files_api_routes_upload_file_responses_200_application-json_bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at \{#operation-files_api_routes_upload_file_responses_200_application-json_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### filename \{#operation-files_api_routes_upload_file_responses_200_application-json_filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id \{#operation-files_api_routes_upload_file_responses_200_application-json_id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype \{#operation-files_api_routes_upload_file_responses_200_application-json_mimetype\} - - - - - - - - - -##### num_lines \{#operation-files_api_routes_upload_file_responses_200_application-json_num_lines\} - - - - - - - - - -##### object \{#operation-files_api_routes_upload_file_responses_200_application-json_object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose \{#operation-files_api_routes_upload_file_responses_200_application-json_purpose\} - - - - - - - - - -##### sample_type \{#operation-files_api_routes_upload_file_responses_200_application-json_sample_type\} - - - - - - - - - -##### signature \{#operation-files_api_routes_upload_file_responses_200_application-json_signature\} - - - - - - - - - -##### source \{#operation-files_api_routes_upload_file_responses_200_application-json_source\} - - - - - - - - - - - - - - - - - - - -## GET /v1/files/\{file\_id\} \{#operation-files_api_routes_retrieve_file\} - - - - - -_Retrieve File_ - - - - - -Returns information about a specific file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.retrieve(file_id="f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-files_api_routes_retrieve_file_parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_retrieve_file_parameters_file_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-files_api_routes_retrieve_file_responses-examples\} - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "deleted": false, - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_retrieve_file_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes \{#operation-files_api_routes_retrieve_file_responses_200_application-json_bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at \{#operation-files_api_routes_retrieve_file_responses_200_application-json_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### deleted \{#operation-files_api_routes_retrieve_file_responses_200_application-json_deleted\} - - - - - - - - - -##### filename \{#operation-files_api_routes_retrieve_file_responses_200_application-json_filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id \{#operation-files_api_routes_retrieve_file_responses_200_application-json_id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype \{#operation-files_api_routes_retrieve_file_responses_200_application-json_mimetype\} - - - - - - - - - -##### num_lines \{#operation-files_api_routes_retrieve_file_responses_200_application-json_num_lines\} - - - - - - - - - -##### object \{#operation-files_api_routes_retrieve_file_responses_200_application-json_object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose \{#operation-files_api_routes_retrieve_file_responses_200_application-json_purpose\} - - - - - - - - - -##### sample_type \{#operation-files_api_routes_retrieve_file_responses_200_application-json_sample_type\} - - - - - - - - - -##### signature \{#operation-files_api_routes_retrieve_file_responses_200_application-json_signature\} - - - - - - - - - -##### source \{#operation-files_api_routes_retrieve_file_responses_200_application-json_source\} - - - - - - - - - - - - - - - - - - - -## DELETE /v1/files/\{file\_id\} \{#operation-files_api_routes_delete_file\} - - - - - -_Delete File_ - - - - - -Delete a file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.delete(file_id="3b6d45eb-e30b-416f-8019-f47e2e93d930") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-files_api_routes_delete_file_parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_delete_file_parameters_file_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-files_api_routes_delete_file_responses-examples\} - - - - - -200 - - - - - -```json -{ - "deleted": "false", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_delete_file_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### deleted \{#operation-files_api_routes_delete_file_responses_200_application-json_deleted\} - - - - - -The deletion status. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### id \{#operation-files_api_routes_delete_file_responses_200_application-json_id\} - - - - - -The ID of the deleted file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### object \{#operation-files_api_routes_delete_file_responses_200_application-json_object\} - - - - - -The object type that was deleted - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - - - - - - - - - - - -## GET /v1/files/\{file\_id\}/content \{#operation-files_api_routes_download_file\} - - - - - -_Download File_ - - - - - -Download a file - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.download(file_id="f8919994-a4a1-46b2-8b5b-06335a4300ce") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-files_api_routes_download_file_parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_download_file_parameters_file_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-files_api_routes_download_file_responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_download_file_responses\} - - - - - -200 - - - - - - - - - - - - - -OK - - - - - - - - - - - - - - - -## GET /v1/files/\{file\_id\}/url \{#operation-files_api_routes_get_signed_url\} - - - - - -Get Signed Url - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.get_signed_url(file_id="06a020ab-355c-49a6-b19d-304b7c01699f", expiry=24) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-files_api_routes_get_signed_url_parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_get_signed_url_parameters_file_id\} - - - - - - - - - -##### expiry \{#operation-files_api_routes_get_signed_url_parameters_expiry\} - - - - - -Number of hours before the url becomes invalid. Defaults to 24h - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-files_api_routes_get_signed_url_responses-examples\} - - - - - -200 - - - - - -```json -{ - "url": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_get_signed_url_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### url \{#operation-files_api_routes_get_signed_url_responses_200_application-json_url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/fim/page.mdx b/examples/custom/src/app/mistral/api/endpoint/fim/page.mdx deleted file mode 100644 index ea3eaa265..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/fim/page.mdx +++ /dev/null @@ -1,3635 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Fim Endpoints - - - - - -Fill-in-the-middle API. - - - - - - - - - -## POST /v1/fim/completions \{#operation-fim_completion_v1_fim_completions_post\} - - - - - -_Fim Completion_ - - - - - -FIM completion. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fim.complete(model="codestral-2405", prompt="def", top_p=1, stream=False, suffix="return a+b") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-fim_completion_v1_fim_completions_post_request-examples\} - - - - - -```json -{ - "prompt": "def" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-fim_completion_v1_fim_completions_post_request\} - - - - - - - - - - - -##### max_tokens \{#operation-fim_completion_v1_fim_completions_post_request_max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - - - - - -##### min_tokens \{#operation-fim_completion_v1_fim_completions_post_request_min_tokens\} - - - - - -The minimum number of tokens to generate in the completion. - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post_request_model\} - - - - - -ID of the model to use. Only compatible for now with: - - `codestral-2405` - - `codestral-latest` - - - - - -_Example:_ - -``` -codestral-2405 -``` - - - - - -_Default Value:_ `"codestral-2405"` - - - - - - - - - -##### prompt \{#operation-fim_completion_v1_fim_completions_post_request_prompt\} - - - - - -The text/code to complete. - - - - - -_Example:_ - -``` -def -``` - - - - - - - - - -##### random_seed \{#operation-fim_completion_v1_fim_completions_post_request_random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - - - - - -##### stop \{#operation-fim_completion_v1_fim_completions_post_request_stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream \{#operation-fim_completion_v1_fim_completions_post_request_stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### suffix \{#operation-fim_completion_v1_fim_completions_post_request_suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - -_Example:_ - -``` -return a+b -``` - - - - - - - - - -##### temperature \{#operation-fim_completion_v1_fim_completions_post_request_temperature\} - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - - - - - -##### top_p \{#operation-fim_completion_v1_fim_completions_post_request_top_p\} - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - -_Default Value:_ `1` - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-fim_completion_v1_fim_completions_post_responses-examples\} - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "codestral-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-fim_completion_v1_fim_completions_post_responses\} - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices\} - - - - - - - - - -#### ChatCompletionChoice \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice\} - - - - - - - - - -##### finish_reason \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason\} - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_index\} - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message\} - - - - - - - - - -#### AssistantMessage \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content\} - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role\} - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_created\} - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_id\} - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_model\} - - - - - -_Example:_ - -``` -codestral-latest -``` - - - - - - - - - -##### object \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_object\} - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage\} - - - - - - - - - -#### UsageInfo \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent\} - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data\} - - - - - - - - - -#### CompletionChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk\} - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices\} - - - - - - - - - -#### CompletionResponseStreamChoice \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice\} - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta\} - - - - - - - - - -#### DeltaMessage \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage\} - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content\} - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk\} - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_text\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk\} - - - - - - - - - -##### file_id \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk\} - - - - - - - - - -##### closed \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking\} - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk\} - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_reference_ids\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_type\} - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk\} - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_text\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_type\} - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_type\} - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk\} - - - - - - - - - -##### input_audio \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_input_audio\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_type\} - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_role\} - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls\} - - - - - - - - - -#### ToolCall \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall\} - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function\} - - - - - - - - - -#### FunctionCall \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall\} - - - - - - - - - -##### arguments \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_arguments\} - - - - - - - - - -##### name \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_name\} - - - - - - - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_id\} - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_index\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_type\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_finish_reason\} - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_index\} - - - - - - - - - - - - - - - - - -##### created \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_created\} - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_id\} - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_model\} - - - - - - - - - -##### object \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_object\} - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage\} - - - - - - - - - -#### UsageInfo \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo\} - - - - - - - - - -##### completion_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_completion_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_audio_seconds\} - - - - - - - - - -##### prompt_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_total_tokens\} - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/fine-tuning/page.mdx b/examples/custom/src/app/mistral/api/endpoint/fine-tuning/page.mdx deleted file mode 100644 index 22e7dc950..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/fine-tuning/page.mdx +++ /dev/null @@ -1,14280 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Fine Tuning Endpoints - - - - - -Fine-tuning API - - - - - - - - - -## GET /v1/fine\_tuning/jobs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs\} - - - - - -_Get Fine Tuning Jobs_ - - - - - -Get a list of fine-tuning jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.list(page=0, page_size=100, created_by_me=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses-examples\} - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses\} - - - - - -200 - - - - - - - -OK - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data\} - - - - - - - - - -#### CompletionJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_auto_start\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_id\} - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_object\} - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories\} - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout\} - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_commit_id\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_ref\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_status\} - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### ClassifierJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_auto_start\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters\} - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_id\} - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_object\} - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_status\} - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_object\} - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_total\} - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/jobs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job\} - - - - - -_Create Fine Tuning Job_ - - - - - -Create a new fine-tuning job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.create(model="Camaro", hyperparameters={ - "learning_rate": 0.0001, - }, invalid_sample_skip_percentage=0) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters\} - - - - - - - - - - - -##### dry_run \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters_dry_run\} - - - - - -* If `true` the job is not spawned, instead the query returns a handful of useful metadata - for the user to perform sanity checks (see `LegacyJobMetadataOut` response). -* Otherwise, the job is started and the query returns the job ID along with some of the - input parameters (see `JobOut` response). - - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request-examples\} - - - - - -```json -{ - "hyperparameters": {}, - "model": "ministral-3b-latest" -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request\} - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_auto_start\} - - - - - -This field will be required in a future release. - - - - - -ClassifierTargetIn","children":[{"label":"ClassifierTargetIn","linkedLabel":"ClassifierTargetIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets\} - - - - - - - - - -#### ClassifierTargetIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin\} - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_labels\} - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_loss_function\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_name\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - -CompletionTrainingParametersIn","children":[],"breakoutSubTypes":{}},{"label":"ClassifierTrainingParametersIn","linkedLabel":"ClassifierTrainingParametersIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParametersIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin\} - - - - - -The fine-tuning hyperparameter settings used in a fine-tune job. - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_learning_rate\} - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_warmup_fraction\} - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_weight_decay\} - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - - - - - - - -#### ClassifierTrainingParametersIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin\} - - - - - -The fine-tuning hyperparameter settings used in a classifier fine-tune job. - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_learning_rate\} - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_warmup_fraction\} - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_weight_decay\} - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - - - - - - - -WandbIntegration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations\} - - - - - -A list of integrations to enable for your fine-tuning job. - - - - - - - - - -#### WandbIntegration \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration\} - - - - - - - - - -##### api_key \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_api_key\} - - - - - -The WandB API key to use for authentication. - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - - - - - - - - - -##### invalid_sample_skip_percentage \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_invalid_sample_skip_percentage\} - - - - - -_Default Value:_ `0` - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_job_type\} - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_model\} - - - - - -The name of the model to fine-tune. - - - - - -GithubRepositoryIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories\} - - - - - - - - - -#### GithubRepositoryIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_ref\} - - - - - - - - - -##### token \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_token\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_suffix\} - - - - - -A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - - - - - -TrainingFile","children":[{"label":"TrainingFile","linkedLabel":"TrainingFile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files\} - - - - - - - - - -#### TrainingFile \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile\} - - - - - - - - - -##### file_id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile_file_id\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses\} - - - - - -200 - - - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"LegacyJobMetadataOut","linkedLabel":"LegacyJobMetadataOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionJobOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_auto_start\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_id\} - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_object\} - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories\} - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout\} - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_commit_id\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_ref\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_status\} - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### ClassifierJobOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_auto_start\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters\} - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_id\} - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_object\} - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_status\} - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### LegacyJobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_cost\} - - - - - -The cost of the fine-tuning job. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_cost_currency\} - - - - - -The currency used for the fine-tuning job cost. - - - - - -_Example:_ - -``` -EUR -``` - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_data_tokens\} - - - - - -The total number of tokens in the training dataset. - - - - - -_Example:_ - -``` -305375 -``` - - - - - - - - - -##### deprecated \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_deprecated\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### details \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_details\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_epochs\} - - - - - -The number of complete passes through the entire training dataset. - - - - - -_Example:_ - -``` -4.2922 -``` - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_expected_duration_seconds\} - - - - - -The approximated time (in seconds) for the fine-tuning process to complete. - - - - - -_Example:_ - -``` -220 -``` - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_object\} - - - - - -_Default Value:_ `"job.metadata"` - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_train_tokens\} - - - - - -The total number of tokens used during the fine-tuning process. - - - - - -_Example:_ - -``` -1310720 -``` - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_train_tokens_per_step\} - - - - - -The number of tokens consumed by one training step. - - - - - -_Example:_ - -``` -131072 -``` - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/fine\_tuning/jobs/\{job\_id\} \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job\} - - - - - -_Get Fine Tuning Job_ - - - - - -Get a fine-tuned job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.get(job_id="c167a961-ffca-4bcf-93ac-6169468dd389") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters_job_id\} - - - - - -The ID of the job to analyse. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model\} - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type\} - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories\} - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout\} - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files\} - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets\} - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout\} - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels\} - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model\} - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters\} - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type\} - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files\} - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/cancel \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job\} - - - - - -_Cancel Fine Tuning Job_ - - - - - -Request the cancellation of a fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.cancel(job_id="6188a2f6-7513-4e0f-89cc-3f8088523a49") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters_job_id\} - - - - - -The ID of the job to cancel. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model\} - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type\} - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories\} - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout\} - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files\} - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets\} - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout\} - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels\} - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model\} - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters\} - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type\} - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files\} - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job\} - - - - - -_Start Fine Tuning Job_ - - - - - -Request the start of a validated fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.start(job_id="56553e4d-0679-471e-b9ac-59a77d671103") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters_job_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model\} - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters\} - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs\} - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type\} - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories\} - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout\} - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name\} - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner\} - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type\} - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight\} - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files\} - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout\} - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start\} - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints\} - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss\} - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss\} - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy\} - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets\} - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout\} - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels\} - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight\} - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at\} - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout\} - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name\} - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model\} - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters\} - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters\} - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs\} - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate\} - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len\} - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps\} - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction\} - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay\} - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id\} - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations\} - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name\} - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type\} - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url\} - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type\} - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata\} - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout\} - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost\} - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency\} - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens\} - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time\} - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds\} - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens\} - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step\} - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model\} - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object\} - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status\} - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix\} - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens\} - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files\} - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files\} - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/models/page.mdx b/examples/custom/src/app/mistral/api/endpoint/models/page.mdx deleted file mode 100644 index bc9de6fab..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/models/page.mdx +++ /dev/null @@ -1,5624 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Models Endpoints - - - - - -Model Management API - - - - - - - - - -## GET /v1/models \{#operation-list_models_v1_models_get\} - - - - - -_List Models_ - - - - - -List all models available to the user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.list() - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-list_models_v1_models_get_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-list_models_v1_models_get_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-list_models_v1_models_get_responses_200_application-json_data\} - - - - - - - - - -#### BaseModelCard \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard\} - - - - - - - - - -##### aliases \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_aliases\} - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities\} - - - - - - - - - -#### ModelCapabilities \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities\} - - - - - - - - - -##### classification \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_function_calling\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_vision\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_created\} - - - - - - - - - -##### default_model_temperature \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_default_model_temperature\} - - - - - - - - - -##### deprecation \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_deprecation\} - - - - - - - - - -##### deprecation_replacement_model \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_deprecation_replacement_model\} - - - - - - - - - -##### description \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_description\} - - - - - - - - - -##### id \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_id\} - - - - - - - - - -##### max_context_length \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_name\} - - - - - - - - - -##### object \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_owned_by\} - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type \{#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_type\} - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard\} - - - - - -Extra fields for fine-tuned models. - - - - - - - - - -##### aliases \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_aliases\} - - - - - - - - - -##### archived \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_archived\} - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities\} - - - - - - - - - -#### ModelCapabilities \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities\} - - - - - - - - - -##### classification \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_function_calling\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_vision\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_created\} - - - - - - - - - -##### default_model_temperature \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_default_model_temperature\} - - - - - - - - - -##### deprecation \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_deprecation\} - - - - - - - - - -##### deprecation_replacement_model \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_deprecation_replacement_model\} - - - - - - - - - -##### description \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_description\} - - - - - - - - - -##### id \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_id\} - - - - - - - - - -##### job \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_job\} - - - - - - - - - -##### max_context_length \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_name\} - - - - - - - - - -##### object \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_owned_by\} - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_root\} - - - - - - - - - -##### type \{#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_type\} - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - - - -##### object \{#operation-list_models_v1_models_get_responses_200_application-json_object\} - - - - - -_Default Value:_ `"list"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-list_models_v1_models_get_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-list_models_v1_models_get_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/models/\{model\_id\} \{#operation-retrieve_model_v1_models_model_id_get\} - - - - - -_Retrieve Model_ - - - - - -Retrieve information about a model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.retrieve(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-retrieve_model_v1_models_model_id_get_parameters\} - - - - - - - - - - - -##### model_id \{#operation-retrieve_model_v1_models_model_id_get_parameters_model_id\} - - - - - -The ID of the model to retrieve. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-retrieve_model_v1_models_model_id_get_responses-examples\} - - - - - -200 - - - - - -```json -{ - "capabilities": {}, - "id": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-retrieve_model_v1_models_model_id_get_responses\} - - - - - -200 - - - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### BaseModelCard \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard\} - - - - - - - - - -##### aliases \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_aliases\} - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities\} - - - - - - - - - -#### ModelCapabilities \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities\} - - - - - - - - - -##### classification \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_function_calling\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_vision\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_created\} - - - - - - - - - -##### default_model_temperature \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_default_model_temperature\} - - - - - - - - - -##### deprecation \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_deprecation\} - - - - - - - - - -##### deprecation_replacement_model \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_deprecation_replacement_model\} - - - - - - - - - -##### description \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_description\} - - - - - - - - - -##### id \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_id\} - - - - - - - - - -##### max_context_length \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_name\} - - - - - - - - - -##### object \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_owned_by\} - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_type\} - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard\} - - - - - -Extra fields for fine-tuned models. - - - - - - - - - -##### aliases \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_aliases\} - - - - - - - - - -##### archived \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_archived\} - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities\} - - - - - - - - - -#### ModelCapabilities \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities\} - - - - - - - - - -##### classification \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_function_calling\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_vision\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_created\} - - - - - - - - - -##### default_model_temperature \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_default_model_temperature\} - - - - - - - - - -##### deprecation \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_deprecation\} - - - - - - - - - -##### deprecation_replacement_model \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_deprecation_replacement_model\} - - - - - - - - - -##### description \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_description\} - - - - - - - - - -##### id \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_id\} - - - - - - - - - -##### job \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_job\} - - - - - - - - - -##### max_context_length \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_name\} - - - - - - - - - -##### object \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_owned_by\} - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_root\} - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_type\} - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## DELETE /v1/models/\{model\_id\} \{#operation-delete_model_v1_models_model_id_delete\} - - - - - -_Delete Model_ - - - - - -Delete a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.delete(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-delete_model_v1_models_model_id_delete_parameters\} - - - - - - - - - - - -##### model_id \{#operation-delete_model_v1_models_model_id_delete_parameters_model_id\} - - - - - -The ID of the model to delete. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-delete_model_v1_models_model_id_delete_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ft:open-mistral-7b:587a6b29:20240514:7e773925" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-delete_model_v1_models_model_id_delete_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### deleted \{#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_deleted\} - - - - - -The deletion status - - - - - -_Example:_ - -``` -true -``` - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id \{#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_id\} - - - - - -The ID of the deleted model. - - - - - -_Example:_ - -``` -ft:open-mistral-7b:587a6b29:20240514:7e773925 -``` - - - - - - - - - -##### object \{#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_object\} - - - - - -The object type that was deleted - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## PATCH /v1/fine\_tuning/models/\{model\_id\} \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model\} - - - - - -_Update Fine Tuned Model_ - - - - - -Update a model name or description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.update(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters_model_id\} - - - - - -The ID of the model to update. - - - - - - - - - -
- - - - - -
- - - -### Request Example \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request-examples\} - - - - - -```json -{} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request\} - - - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_description\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_name\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses-examples\} - - - - - -200 - - - - - -```json -{ - "archived": false, - "capabilities": {}, - "created": 87, - "id": "ipsum eiusmod", - "job": "consequat do", - "owned_by": "reprehenderit ut dolore", - "root": "occaecat dolor sit", - "root_version": "nostrud", - "workspace_id": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses\} - - - - - -200 - - - - - - - -CompletionFTModelOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierFTModelOut","linkedLabel":"ClassifierFTModelOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionFTModelOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout\} - - - - - - - - - -##### aliases \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_aliases\} - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_archived\} - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities\} - - - - - - - - - -#### FTModelCapabilitiesOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout\} - - - - - - - - - -##### classification \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_function_calling\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_created\} - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_description\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_id\} - - - - - - - - - -##### job \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_job\} - - - - - - - - - -##### max_context_length \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_model_type\} - - - - - -_Default Value:_ `"completion"` - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_name\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_owned_by\} - - - - - - - - - -##### root \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_root\} - - - - - - - - - -##### root_version \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_root_version\} - - - - - - - - - -##### workspace_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_workspace_id\} - - - - - - - - - - - - - -#### ClassifierFTModelOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout\} - - - - - - - - - -##### aliases \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_aliases\} - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_archived\} - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities\} - - - - - - - - - -#### FTModelCapabilitiesOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout\} - - - - - - - - - -##### classification \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_classification\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_completion_chat\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_completion_fim\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_fine_tuning\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_function_calling\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets\} - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout\} - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_labels\} - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_loss_function\} - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_name\} - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_weight\} - - - - - - - - - - - - - - - - - -##### created \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_created\} - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_description\} - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_id\} - - - - - - - - - -##### job \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_job\} - - - - - - - - - -##### max_context_length \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_max_context_length\} - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_model_type\} - - - - - -_Default Value:_ `"classifier"` - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_name\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_owned_by\} - - - - - - - - - -##### root \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_root\} - - - - - - - - - -##### root_version \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_root_version\} - - - - - - - - - -##### workspace_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_workspace_id\} - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/models/\{model\_id\}/archive \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model\} - - - - - -_Archive Fine Tuned Model_ - - - - - -Archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.archive(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters_model_id\} - - - - - -The ID of the model to archive. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_archived\} - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_id\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - - - - - - - -## DELETE /v1/fine\_tuning/models/\{model\_id\}/archive \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model\} - - - - - -_Unarchive Fine Tuned Model_ - - - - - -Un-archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.unarchive(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters_model_id\} - - - - - -The ID of the model to unarchive. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_archived\} - - - - - -_Default Value:_ `false` - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_id\} - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_object\} - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/endpoint/ocr/page.mdx b/examples/custom/src/app/mistral/api/endpoint/ocr/page.mdx deleted file mode 100644 index af1f2a5b7..000000000 --- a/examples/custom/src/app/mistral/api/endpoint/ocr/page.mdx +++ /dev/null @@ -1,1976 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@/components/speakeasy-custom"; - - - - - -# Ocr Endpoints - - - - - -OCR API - - - - - - - - - -## POST /v1/ocr \{#operation-ocr_v1_ocr_post\} - - - - - -OCR - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.ocr.process(model="CX-9", document={ - "image_url": { - "url": "https://measly-scrap.com", - }, - "type": "image_url", - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
- - - -### Request Example \{#operation-ocr_v1_ocr_post_request-examples\} - - - - - -```json -{ - "document": { - "file_id": "ipsum eiusmod" - }, - "model": null -} -``` - - - -
- - - - - -
- - - -### Request Body \{#operation-ocr_v1_ocr_post_request\} - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### bbox_annotation_format \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format\} - - - - - - - - - -#### ResponseFormat \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - -FileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document \{#operation-ocr_v1_ocr_post_request_document\} - - - - - -Document to run OCR on - - - - - - - - - -#### FileChunk \{#operation-ocr_v1_ocr_post_request_document_filechunk\} - - - - - - - - - -##### file_id \{#operation-ocr_v1_ocr_post_request_document_filechunk_file_id\} - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_request_document_filechunk_type\} - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-ocr_v1_ocr_post_request_document_documenturlchunk\} - - - - - - - - - -##### document_name \{#operation-ocr_v1_ocr_post_request_document_documenturlchunk_document_name\} - - - - - -The filename of the document - - - - - - - - - -##### document_url \{#operation-ocr_v1_ocr_post_request_document_documenturlchunk_document_url\} - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_request_document_documenturlchunk_type\} - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url\} - - - - - - - - - -#### ImageURL \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl\} - - - - - - - - - -##### detail \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl_detail\} - - - - - - - - - -##### url \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl_url\} - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_request_document_imageurlchunk_type\} - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document_annotation_format \{#operation-ocr_v1_ocr_post_request_document_annotation_format\} - - - - - - - - - -#### ResponseFormat \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat\} - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema\} - - - - - - - - - -#### JsonSchema \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema\} - - - - - - - - - -##### description \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_description\} - - - - - - - - - -##### name \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_name\} - - - - - - - - - -##### schema_definition \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_schema_definition\} - - - - - - - - - -##### strict \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_strict\} - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### id \{#operation-ocr_v1_ocr_post_request_id\} - - - - - - - - - -##### image_limit \{#operation-ocr_v1_ocr_post_request_image_limit\} - - - - - -Max images to extract - - - - - - - - - -##### image_min_size \{#operation-ocr_v1_ocr_post_request_image_min_size\} - - - - - -Minimum height and width of image to extract - - - - - - - - - -##### include_image_base64 \{#operation-ocr_v1_ocr_post_request_include_image_base64\} - - - - - -Include image URLs in response - - - - - - - - - -##### model \{#operation-ocr_v1_ocr_post_request_model\} - - - - - - - - - -##### pages \{#operation-ocr_v1_ocr_post_request_pages\} - - - - - -Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-ocr_v1_ocr_post_responses-examples\} - - - - - -200 - - - - - -```json -{ - "model": "ipsum eiusmod", - "pages": [ - { - "dimensions": null, - "images": [ - { - "bottom_right_x": null, - "bottom_right_y": null, - "id": "consequat do", - "top_left_x": null, - "top_left_y": null - } - ], - "index": 87, - "markdown": "reprehenderit ut dolore" - } - ], - "usage_info": { - "pages_processed": 14 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-ocr_v1_ocr_post_responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_annotation \{#operation-ocr_v1_ocr_post_responses_200_application-json_document_annotation\} - - - - - -Formatted response in the request_format if provided in json str - - - - - - - - - -##### model \{#operation-ocr_v1_ocr_post_responses_200_application-json_model\} - - - - - -The model used to generate the OCR. - - - - - -OCRPageObject","children":[{"label":"OCRPageObject","linkedLabel":"OCRPageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pages \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages\} - - - - - -List of OCR info for pages. - - - - - - - - - -#### OCRPageObject \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject\} - - - - - -OCRPageDimensions","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### dimensions \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions\} - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - - - -#### OCRPageDimensions \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions\} - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - - - -##### dpi \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_dpi\} - - - - - -Dots per inch of the page-image - - - - - - - - - -##### height \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_height\} - - - - - -Height of the image in pixels - - - - - - - - - -##### width \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_width\} - - - - - -Width of the image in pixels - - - - - - - - - - - - - -OCRImageObject","children":[{"label":"OCRImageObject","linkedLabel":"OCRImageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### images \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images\} - - - - - -List of all extracted images in the page - - - - - - - - - -#### OCRImageObject \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject\} - - - - - - - - - -##### bottom_right_x \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_bottom_right_x\} - - - - - -X coordinate of bottom-right corner of the extracted image - - - - - - - - - -##### bottom_right_y \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_bottom_right_y\} - - - - - -Y coordinate of bottom-right corner of the extracted image - - - - - - - - - -##### id \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_id\} - - - - - -Image ID for extracted image in a page - - - - - - - - - -##### image_annotation \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_image_annotation\} - - - - - -Annotation of the extracted image in json str - - - - - - - - - -##### image_base64 \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_image_base64\} - - - - - -Base64 string of the extracted image - - - - - - - - - -##### top_left_x \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_top_left_x\} - - - - - -X coordinate of top-left corner of the extracted image - - - - - - - - - -##### top_left_y \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_top_left_y\} - - - - - -Y coordinate of top-left corner of the extracted image - - - - - - - - - - - - - - - - - -##### index \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_index\} - - - - - -The page index in a pdf document starting from 0 - - - - - - - - - -##### markdown \{#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_markdown\} - - - - - -The markdown string response of the page - - - - - - - - - - - - - -OCRUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage_info \{#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info\} - - - - - - - - - -#### OCRUsageInfo \{#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo\} - - - - - - - - - -##### doc_size_bytes \{#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo_doc_size_bytes\} - - - - - -Document size in bytes - - - - - - - - - -##### pages_processed \{#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo_pages_processed\} - - - - - -Number of pages processed - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata\} - - - - - - - - - -##### Request \{#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata_request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata_response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-ocr_v1_ocr_post_responses_422_application-json_detail\} - - - - - - - - - -#### ValidationError \{#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror\} - - - - - - - - - -##### loc \{#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_loc\} - - - - - - - - - -##### msg \{#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_msg\} - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_type\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/mistral/api/page.mdx b/examples/custom/src/app/mistral/api/page.mdx deleted file mode 100644 index 56e34ccfb..000000000 --- a/examples/custom/src/app/mistral/api/page.mdx +++ /dev/null @@ -1,18 +0,0 @@ -import "@/app/speakeasy.css"; -import { - Pill -} from "@/components/speakeasy-custom"; - -# About Mistral AI API - -_Version: 1.0.0_ - -Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -Servers - -- https://api.mistral.ai - -## Global Security - -### ApiKey bearer http \{#ApiKey\} \ No newline at end of file diff --git a/examples/custom/src/app/mistral/layout.tsx b/examples/custom/src/app/mistral/layout.tsx deleted file mode 100644 index 505e091e2..000000000 --- a/examples/custom/src/app/mistral/layout.tsx +++ /dev/null @@ -1,26 +0,0 @@ -import React from "react"; -import sidebarMetadata from "./sidebarMetadata.json"; -import { Sidebar } from "@/components/Sidebar"; - -export default function RootLayout({ - children, -}: Readonly<{ - children: React.ReactNode; -}>) { - return ( - <> -
- -
-
{children}
- - ); -} diff --git a/examples/custom/src/app/mistral/page.tsx b/examples/custom/src/app/mistral/page.tsx deleted file mode 100644 index f95f03d31..000000000 --- a/examples/custom/src/app/mistral/page.tsx +++ /dev/null @@ -1,5 +0,0 @@ -import { redirect } from "next/navigation"; - -export default function Page() { - redirect("/mistral/api"); -} diff --git a/examples/custom/src/app/mistral/sidebarMetadata.json b/examples/custom/src/app/mistral/sidebarMetadata.json deleted file mode 100644 index ca7bbd727..000000000 --- a/examples/custom/src/app/mistral/sidebarMetadata.json +++ /dev/null @@ -1,4582 +0,0 @@ -[ - { - "sidebarLabel": "About", - "slug": "", - "tags": [] - }, - { - "sidebarLabel": "Agents", - "slug": "endpoint/agents", - "tags": [ - { - "name": "agents", - "operations": [ - { - "elementId": "operation-agents_completion_v1_agents_completions_post", - "method": "post", - "path": "/v1/agents/completions", - "operationId": "agents_completion_v1_agents_completions_post", - "summary": "Agents Completion", - "description": "", - "security": { - "elementId": "operation-agents_completion_v1_agents_completions_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_completion_v1_agents_completions_post_request", - "properties": [ - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_frequency_penalty", - "name": "frequency_penalty" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_max_tokens", - "name": "max_tokens" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_messages", - "name": "messages" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_n", - "name": "n" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_parallel_tool_calls", - "name": "parallel_tool_calls" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_prediction", - "name": "prediction" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_presence_penalty", - "name": "presence_penalty" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_prompt_mode", - "name": "prompt_mode" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_random_seed", - "name": "random_seed" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_response_format", - "name": "response_format" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_stop", - "name": "stop" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_stream", - "name": "stream" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_tool_choice", - "name": "tool_choice" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_request_tools", - "name": "tools" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices", - "name": "choices" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_created", - "name": "created" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Audio Transcriptions", - "slug": "endpoint/audio/transcriptions", - "tags": [ - { - "name": "audio/transcriptions", - "operations": [ - { - "elementId": "operation-audio_api_v1_transcriptions_post", - "method": "post", - "path": "/v1/audio/transcriptions", - "operationId": "audio_api_v1_transcriptions_post", - "summary": "Create Transcription", - "description": "", - "security": { - "elementId": "operation-audio_api_v1_transcriptions_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-audio_api_v1_transcriptions_post_request", - "properties": [ - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_file", - "name": "file" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_file_id", - "name": "file_id" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_file_url", - "name": "file_url" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_language", - "name": "language" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_model", - "name": "model" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_stream", - "name": "stream" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_temperature", - "name": "temperature" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_request_timestamp_granularities", - "name": "timestamp_granularities" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json_language", - "name": "language" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments", - "name": "segments" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json_text", - "name": "text" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage", - "name": "usage" - } - ] - } - } - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream", - "method": "post", - "path": "/v1/audio/transcriptions#stream", - "operationId": "audio_api_v1_transcriptions_post_stream", - "summary": "Create streaming transcription (SSE)", - "description": "", - "security": { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request", - "properties": [ - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_file", - "name": "file" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_file_id", - "name": "file_id" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_file_url", - "name": "file_url" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_language", - "name": "language" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_model", - "name": "model" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_stream", - "name": "stream" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_temperature", - "name": "temperature" - }, - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_request_timestamp_granularities", - "name": "timestamp_granularities" - } - ] - }, - "responses": { - "200-text/event-stream": { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents", - "name": "TranscriptionStreamEvents" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Batch", - "slug": "endpoint/batch", - "tags": [ - { - "name": "batch", - "operations": [ - { - "elementId": "operation-jobs_api_routes_batch_get_batch_jobs", - "method": "get", - "path": "/v1/batch/jobs", - "operationId": "jobs_api_routes_batch_get_batch_jobs", - "summary": "Get Batch Jobs", - "description": "Get a list of batch jobs for your organization and user.", - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_total", - "name": "total" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job", - "method": "post", - "path": "/v1/batch/jobs", - "operationId": "jobs_api_routes_batch_create_batch_job", - "summary": "Create Batch Job", - "description": "Create a new batch job, it will be queued for processing.", - "security": { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_endpoint", - "name": "endpoint" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_input_files", - "name": "input_files" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_metadata", - "name": "metadata" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_model", - "name": "model" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_request_timeout_hours", - "name": "timeout_hours" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_at", - "name": "completed_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_requests", - "name": "completed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_endpoint", - "name": "endpoint" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_error_file", - "name": "error_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors", - "name": "errors" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_failed_requests", - "name": "failed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_input_files", - "name": "input_files" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_metadata", - "name": "metadata" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_output_file", - "name": "output_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_started_at", - "name": "started_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_status", - "name": "status" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_succeeded_requests", - "name": "succeeded_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_total_requests", - "name": "total_requests" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job", - "method": "get", - "path": "/v1/batch/jobs/{job_id}", - "operationId": "jobs_api_routes_batch_get_batch_job", - "summary": "Get Batch Job", - "description": "Get a batch job details by its UUID.", - "parameters": { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_parameters_job_id", - "name": "job_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_at", - "name": "completed_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_requests", - "name": "completed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_endpoint", - "name": "endpoint" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_error_file", - "name": "error_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors", - "name": "errors" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_failed_requests", - "name": "failed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_input_files", - "name": "input_files" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_metadata", - "name": "metadata" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_output_file", - "name": "output_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_started_at", - "name": "started_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_status", - "name": "status" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_succeeded_requests", - "name": "succeeded_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_total_requests", - "name": "total_requests" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job", - "method": "post", - "path": "/v1/batch/jobs/{job_id}/cancel", - "operationId": "jobs_api_routes_batch_cancel_batch_job", - "summary": "Cancel Batch Job", - "description": "Request the cancellation of a batch job.", - "parameters": { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_parameters_job_id", - "name": "job_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_at", - "name": "completed_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_requests", - "name": "completed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_endpoint", - "name": "endpoint" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_error_file", - "name": "error_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors", - "name": "errors" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_failed_requests", - "name": "failed_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_input_files", - "name": "input_files" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_metadata", - "name": "metadata" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_output_file", - "name": "output_file" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_started_at", - "name": "started_at" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_status", - "name": "status" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_succeeded_requests", - "name": "succeeded_requests" - }, - { - "elementId": "operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_total_requests", - "name": "total_requests" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Beta Agents", - "slug": "endpoint/beta/agents", - "tags": [ - { - "name": "beta/agents", - "operations": [ - { - "elementId": "operation-agents_api_v1_agents_list", - "method": "get", - "path": "/v1/agents", - "operationId": "agents_api_v1_agents_list", - "summary": "List agent entities.", - "description": "Retrieve a list of agent entities sorted by creation time.", - "parameters": { - "elementId": "operation-agents_api_v1_agents_list_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_list_parameters_page", - "name": "page" - }, - { - "elementId": "operation-agents_api_v1_agents_list_parameters_page_size", - "name": "page_size" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_agents_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_list_responses_200_application-json_agent", - "name": "Agent" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_agents_list_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_agents_list_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_agents_create", - "method": "post", - "path": "/v1/agents", - "operationId": "agents_api_v1_agents_create", - "summary": "Create a agent that can be used within a conversation.", - "description": "Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used.", - "security": { - "elementId": "operation-agents_api_v1_agents_create_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_agents_create_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_create_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_create_request_tools", - "name": "tools" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_tools", - "name": "tools" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_updated_at", - "name": "updated_at" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_200_application-json_version", - "name": "version" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_agents_create_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_agents_create_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_agents_get", - "method": "get", - "path": "/v1/agents/{agent_id}", - "operationId": "agents_api_v1_agents_get", - "summary": "Retrieve an agent entity.", - "description": "Given an agent retrieve an agent entity with its attributes.", - "parameters": { - "elementId": "operation-agents_api_v1_agents_get_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_get_parameters_agent_id", - "name": "agent_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_tools", - "name": "tools" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_updated_at", - "name": "updated_at" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_200_application-json_version", - "name": "version" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_agents_get_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_agents_get_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_agents_update", - "method": "patch", - "path": "/v1/agents/{agent_id}", - "operationId": "agents_api_v1_agents_update", - "summary": "Update an agent entity.", - "description": "Update an agent attributes and create a new version.", - "parameters": { - "elementId": "operation-agents_api_v1_agents_update_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_parameters_agent_id", - "name": "agent_id" - } - ] - }, - "security": { - "elementId": "operation-agents_api_v1_agents_update_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_agents_update_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_update_request_tools", - "name": "tools" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_tools", - "name": "tools" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_updated_at", - "name": "updated_at" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_200_application-json_version", - "name": "version" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_agents_update_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_agents_update_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_agents_update_version", - "method": "patch", - "path": "/v1/agents/{agent_id}/version", - "operationId": "agents_api_v1_agents_update_version", - "summary": "Update an agent version.", - "description": "Switch the version of an agent.", - "parameters": { - "elementId": "operation-agents_api_v1_agents_update_version_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_version_parameters_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_parameters_version", - "name": "version" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_handoffs", - "name": "handoffs" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_tools", - "name": "tools" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_updated_at", - "name": "updated_at" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_200_application-json_version", - "name": "version" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_agents_update_version_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_agents_update_version_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Beta Conversations", - "slug": "endpoint/beta/conversations", - "tags": [ - { - "name": "beta/conversations", - "operations": [ - { - "elementId": "operation-agents_api_v1_conversations_list", - "method": "get", - "path": "/v1/conversations", - "operationId": "agents_api_v1_conversations_list", - "summary": "List all created conversations.", - "description": "Retrieve a list of conversation entities sorted by creation time.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_list_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_list_parameters_page", - "name": "page" - }, - { - "elementId": "operation-agents_api_v1_conversations_list_parameters_page_size", - "name": "page_size" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation", - "name": "ModelConversation" - }, - { - "elementId": "operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation", - "name": "AgentConversation" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_list_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_list_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_start", - "method": "post", - "path": "/v1/conversations", - "operationId": "agents_api_v1_conversations_start", - "summary": "Create a conversation and append entries to it.", - "description": "Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation.", - "security": { - "elementId": "operation-agents_api_v1_conversations_start_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_start_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_request_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_stream", - "name": "stream" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_request_tools", - "name": "tools" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_start_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_responses_200_application-json_conversation_id", - "name": "conversation_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_responses_200_application-json_outputs", - "name": "outputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_start_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_get", - "method": "get", - "path": "/v1/conversations/{conversation_id}", - "operationId": "agents_api_v1_conversations_get", - "summary": "Retrieve a conversation information.", - "description": "Given a conversation_id retrieve a conversation entity with its attributes.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_get_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_get_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_get_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation", - "name": "ModelConversation" - }, - { - "elementId": "operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation", - "name": "AgentConversation" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_get_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_get_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_append", - "method": "post", - "path": "/v1/conversations/{conversation_id}", - "operationId": "agents_api_v1_conversations_append", - "summary": "Append new entries to an existing conversation.", - "description": "Run completion on the history of the conversation and the user entries. Return the new created entries.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_append_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "security": { - "elementId": "operation-agents_api_v1_conversations_append_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_append_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_request_stream", - "name": "stream" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_append_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_responses_200_application-json_conversation_id", - "name": "conversation_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_responses_200_application-json_outputs", - "name": "outputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_append_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_history", - "method": "get", - "path": "/v1/conversations/{conversation_id}/history", - "operationId": "agents_api_v1_conversations_history", - "summary": "Retrieve all entries in a conversation.", - "description": "Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_history_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_history_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_history_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_history_responses_200_application-json_conversation_id", - "name": "conversation_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_history_responses_200_application-json_entries", - "name": "entries" - }, - { - "elementId": "operation-agents_api_v1_conversations_history_responses_200_application-json_object", - "name": "object" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_history_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_history_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_messages", - "method": "get", - "path": "/v1/conversations/{conversation_id}/messages", - "operationId": "agents_api_v1_conversations_messages", - "summary": "Retrieve all messages in a conversation.", - "description": "Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_messages_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_messages_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_messages_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_messages_responses_200_application-json_conversation_id", - "name": "conversation_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_messages_responses_200_application-json_messages", - "name": "messages" - }, - { - "elementId": "operation-agents_api_v1_conversations_messages_responses_200_application-json_object", - "name": "object" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_messages_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_messages_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_restart", - "method": "post", - "path": "/v1/conversations/{conversation_id}/restart", - "operationId": "agents_api_v1_conversations_restart", - "summary": "Restart a conversation starting from a given entry.", - "description": "Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_restart_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "security": { - "elementId": "operation-agents_api_v1_conversations_restart_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_restart_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_request_from_entry_id", - "name": "from_entry_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_request_stream", - "name": "stream" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-agents_api_v1_conversations_restart_responses_200_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_200_application-json_conversation_id", - "name": "conversation_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs", - "name": "outputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_restart_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream", - "method": "post", - "path": "/v1/conversations#stream", - "operationId": "agents_api_v1_conversations_start_stream", - "summary": "Create a conversation and append entries to it.", - "description": "Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation.", - "security": { - "elementId": "operation-agents_api_v1_conversations_start_stream_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_start_stream_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_agent_id", - "name": "agent_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_description", - "name": "description" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_instructions", - "name": "instructions" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_model", - "name": "model" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_name", - "name": "name" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_stream", - "name": "stream" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_request_tools", - "name": "tools" - } - ] - }, - "responses": { - "200-text/event-stream": { - "elementId": "operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents", - "name": "ConversationEvents" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_start_stream_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream", - "method": "post", - "path": "/v1/conversations/{conversation_id}#stream", - "operationId": "agents_api_v1_conversations_append_stream", - "summary": "Append new entries to an existing conversation.", - "description": "Run completion on the history of the conversation and the user entries. Return the new created entries.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_append_stream_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_stream_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "security": { - "elementId": "operation-agents_api_v1_conversations_append_stream_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_append_stream_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_stream_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream_request_stream", - "name": "stream" - } - ] - }, - "responses": { - "200-text/event-stream": { - "elementId": "operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents", - "name": "ConversationEvents" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_append_stream_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream", - "method": "post", - "path": "/v1/conversations/{conversation_id}/restart#stream", - "operationId": "agents_api_v1_conversations_restart_stream", - "summary": "Restart a conversation starting from a given entry.", - "description": "Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.", - "parameters": { - "elementId": "operation-agents_api_v1_conversations_restart_stream_parameters", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_parameters_conversation_id", - "name": "conversation_id" - } - ] - }, - "security": { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_completion_args", - "name": "completion_args" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_from_entry_id", - "name": "from_entry_id" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_handoff_execution", - "name": "handoff_execution" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_inputs", - "name": "inputs" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_store", - "name": "store" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_request_stream", - "name": "stream" - } - ] - }, - "responses": { - "200-text/event-stream": { - "elementId": "operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents", - "name": "ConversationEvents" - } - ] - }, - "422-application/json": { - "elementId": "operation-agents_api_v1_conversations_restart_stream_responses_422_application-json", - "properties": [ - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Beta Libraries", - "slug": "endpoint/beta/libraries", - "tags": [ - { - "name": "beta/libraries", - "operations": [ - { - "elementId": "operation-libraries_list_v1", - "method": "get", - "path": "/v1/libraries", - "operationId": "libraries_list_v1", - "summary": "List all libraries you have access to.", - "description": "List all libraries that you have created or have been shared with you.", - "responses": { - "200-application/json": { - "elementId": "operation-libraries_list_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_list_v1_responses_200_application-json_data", - "name": "data" - } - ] - } - } - }, - { - "elementId": "operation-libraries_create_v1", - "method": "post", - "path": "/v1/libraries", - "operationId": "libraries_create_v1", - "summary": "Create a new Library.", - "description": "Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you.", - "security": { - "elementId": "operation-libraries_create_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_create_v1_request", - "properties": [ - { - "elementId": "operation-libraries_create_v1_request_chunk_size", - "name": "chunk_size" - }, - { - "elementId": "operation-libraries_create_v1_request_description", - "name": "description" - }, - { - "elementId": "operation-libraries_create_v1_request_name", - "name": "name" - } - ] - }, - "responses": { - "201-application/json": { - "elementId": "operation-libraries_create_v1_responses_201_application-json", - "properties": [ - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_chunk_size", - "name": "chunk_size" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_description", - "name": "description" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_emoji", - "name": "emoji" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_explicit_user_members_count", - "name": "explicit_user_members_count" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_explicit_workspace_members_count", - "name": "explicit_workspace_members_count" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_generated_description", - "name": "generated_description" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_generated_name", - "name": "generated_name" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_nb_documents", - "name": "nb_documents" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_org_sharing_role", - "name": "org_sharing_role" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_owner_id", - "name": "owner_id" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_owner_type", - "name": "owner_type" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_total_size", - "name": "total_size" - }, - { - "elementId": "operation-libraries_create_v1_responses_201_application-json_updated_at", - "name": "updated_at" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_create_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_create_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_create_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_get_v1", - "method": "get", - "path": "/v1/libraries/{library_id}", - "operationId": "libraries_get_v1", - "summary": "Detailed information about a specific Library.", - "description": "Given a library id, details information about that Library.", - "parameters": { - "elementId": "operation-libraries_get_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_get_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_get_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_chunk_size", - "name": "chunk_size" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_emoji", - "name": "emoji" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_explicit_user_members_count", - "name": "explicit_user_members_count" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_explicit_workspace_members_count", - "name": "explicit_workspace_members_count" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_generated_description", - "name": "generated_description" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_generated_name", - "name": "generated_name" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_nb_documents", - "name": "nb_documents" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_org_sharing_role", - "name": "org_sharing_role" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_owner_id", - "name": "owner_id" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_owner_type", - "name": "owner_type" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_total_size", - "name": "total_size" - }, - { - "elementId": "operation-libraries_get_v1_responses_200_application-json_updated_at", - "name": "updated_at" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_get_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_get_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_get_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_update_v1", - "method": "put", - "path": "/v1/libraries/{library_id}", - "operationId": "libraries_update_v1", - "summary": "Update a library.", - "description": "Given a library id, you can update the name and description.", - "parameters": { - "elementId": "operation-libraries_update_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_update_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "security": { - "elementId": "operation-libraries_update_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_update_v1_request", - "properties": [ - { - "elementId": "operation-libraries_update_v1_request_description", - "name": "description" - }, - { - "elementId": "operation-libraries_update_v1_request_name", - "name": "name" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_update_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_chunk_size", - "name": "chunk_size" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_emoji", - "name": "emoji" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_explicit_user_members_count", - "name": "explicit_user_members_count" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_explicit_workspace_members_count", - "name": "explicit_workspace_members_count" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_generated_description", - "name": "generated_description" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_generated_name", - "name": "generated_name" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_nb_documents", - "name": "nb_documents" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_org_sharing_role", - "name": "org_sharing_role" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_owner_id", - "name": "owner_id" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_owner_type", - "name": "owner_type" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_total_size", - "name": "total_size" - }, - { - "elementId": "operation-libraries_update_v1_responses_200_application-json_updated_at", - "name": "updated_at" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_update_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_update_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_update_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_delete_v1", - "method": "delete", - "path": "/v1/libraries/{library_id}", - "operationId": "libraries_delete_v1", - "summary": "Delete a library and all of it's document.", - "description": "Given a library id, deletes it together with all documents that have been uploaded to that library.", - "parameters": { - "elementId": "operation-libraries_delete_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_delete_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_delete_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_chunk_size", - "name": "chunk_size" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_description", - "name": "description" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_emoji", - "name": "emoji" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_explicit_user_members_count", - "name": "explicit_user_members_count" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_explicit_workspace_members_count", - "name": "explicit_workspace_members_count" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_generated_description", - "name": "generated_description" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_generated_name", - "name": "generated_name" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_nb_documents", - "name": "nb_documents" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_org_sharing_role", - "name": "org_sharing_role" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_owner_id", - "name": "owner_id" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_owner_type", - "name": "owner_type" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_total_size", - "name": "total_size" - }, - { - "elementId": "operation-libraries_delete_v1_responses_200_application-json_updated_at", - "name": "updated_at" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_delete_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_delete_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_delete_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Beta Libraries Accesses", - "slug": "endpoint/beta/libraries/accesses", - "tags": [ - { - "name": "beta/libraries/accesses", - "operations": [ - { - "elementId": "operation-libraries_share_list_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/share", - "operationId": "libraries_share_list_v1", - "summary": "List all of the access to this library.", - "description": "Given a library, list all of the Entity that have access and to what level.", - "parameters": { - "elementId": "operation-libraries_share_list_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_share_list_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_share_list_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_list_v1_responses_200_application-json_data", - "name": "data" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_share_list_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_list_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_share_list_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_share_create_v1", - "method": "put", - "path": "/v1/libraries/{library_id}/share", - "operationId": "libraries_share_create_v1", - "summary": "Create or update an access level.", - "description": "Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization.", - "parameters": { - "elementId": "operation-libraries_share_create_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_share_create_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "security": { - "elementId": "operation-libraries_share_create_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_share_create_v1_request", - "properties": [ - { - "elementId": "operation-libraries_share_create_v1_request_level", - "name": "level" - }, - { - "elementId": "operation-libraries_share_create_v1_request_org_id", - "name": "org_id" - }, - { - "elementId": "operation-libraries_share_create_v1_request_share_with_type", - "name": "share_with_type" - }, - { - "elementId": "operation-libraries_share_create_v1_request_share_with_uuid", - "name": "share_with_uuid" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_org_id", - "name": "org_id" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_role", - "name": "role" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_share_with_type", - "name": "share_with_type" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_share_with_uuid", - "name": "share_with_uuid" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_200_application-json_user_id", - "name": "user_id" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_share_create_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_create_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_share_create_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_share_delete_v1", - "method": "delete", - "path": "/v1/libraries/{library_id}/share", - "operationId": "libraries_share_delete_v1", - "summary": "Delete an access level.", - "description": "Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours.", - "parameters": { - "elementId": "operation-libraries_share_delete_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_share_delete_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "security": { - "elementId": "operation-libraries_share_delete_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_share_delete_v1_request", - "properties": [ - { - "elementId": "operation-libraries_share_delete_v1_request_org_id", - "name": "org_id" - }, - { - "elementId": "operation-libraries_share_delete_v1_request_share_with_type", - "name": "share_with_type" - }, - { - "elementId": "operation-libraries_share_delete_v1_request_share_with_uuid", - "name": "share_with_uuid" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_org_id", - "name": "org_id" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_role", - "name": "role" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_share_with_type", - "name": "share_with_type" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_share_with_uuid", - "name": "share_with_uuid" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_200_application-json_user_id", - "name": "user_id" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_share_delete_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_share_delete_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_share_delete_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Beta Libraries Documents", - "slug": "endpoint/beta/libraries/documents", - "tags": [ - { - "name": "beta/libraries/documents", - "operations": [ - { - "elementId": "operation-libraries_documents_list_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents", - "operationId": "libraries_documents_list_v1", - "summary": "List document in a given library.", - "description": "Given a library, lists the document that have been uploaded to that library.", - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_list_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_list_v1_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-libraries_documents_list_v1_responses_200_application-json_pagination", - "name": "pagination" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_list_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_list_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_list_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_upload_v1", - "method": "post", - "path": "/v1/libraries/{library_id}/documents", - "operationId": "libraries_documents_upload_v1", - "summary": "Upload a new document.", - "description": "Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search", - "parameters": { - "elementId": "operation-libraries_documents_upload_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_upload_v1_parameters_library_id", - "name": "library_id" - } - ] - }, - "security": { - "elementId": "operation-libraries_documents_upload_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_documents_upload_v1_request", - "properties": [ - { - "elementId": "operation-libraries_documents_upload_v1_request_file", - "name": "file" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_extension", - "name": "extension" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_hash", - "name": "hash" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_last_processed_at", - "name": "last_processed_at" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_mime_type", - "name": "mime_type" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_number_of_pages", - "name": "number_of_pages" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_processing_status", - "name": "processing_status" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_size", - "name": "size" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_summary", - "name": "summary" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_main_content", - "name": "tokens_processing_main_content" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_summary", - "name": "tokens_processing_summary" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_total", - "name": "tokens_processing_total" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_id", - "name": "uploaded_by_id" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_type", - "name": "uploaded_by_type" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_upload_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_upload_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_get_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents/{document_id}", - "operationId": "libraries_documents_get_v1", - "summary": "Retrieve the metadata of a specific document.", - "description": "Given a library and a document in this library, you can retrieve the metadata of that document.", - "parameters": { - "elementId": "operation-libraries_documents_get_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_get_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_extension", - "name": "extension" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_hash", - "name": "hash" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_last_processed_at", - "name": "last_processed_at" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_mime_type", - "name": "mime_type" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_number_of_pages", - "name": "number_of_pages" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_processing_status", - "name": "processing_status" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_size", - "name": "size" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_summary", - "name": "summary" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_main_content", - "name": "tokens_processing_main_content" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_summary", - "name": "tokens_processing_summary" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_total", - "name": "tokens_processing_total" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_id", - "name": "uploaded_by_id" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_type", - "name": "uploaded_by_type" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_get_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_get_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_update_v1", - "method": "put", - "path": "/v1/libraries/{library_id}/documents/{document_id}", - "operationId": "libraries_documents_update_v1", - "summary": "Update the metadata of a specific document.", - "description": "Given a library and a document in that library, update the name of that document.", - "parameters": { - "elementId": "operation-libraries_documents_update_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_update_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_update_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "security": { - "elementId": "operation-libraries_documents_update_v1_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-libraries_documents_update_v1_request", - "properties": [ - { - "elementId": "operation-libraries_documents_update_v1_request_name", - "name": "name" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_extension", - "name": "extension" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_hash", - "name": "hash" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_last_processed_at", - "name": "last_processed_at" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_mime_type", - "name": "mime_type" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_number_of_pages", - "name": "number_of_pages" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_processing_status", - "name": "processing_status" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_size", - "name": "size" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_summary", - "name": "summary" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_main_content", - "name": "tokens_processing_main_content" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_summary", - "name": "tokens_processing_summary" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_total", - "name": "tokens_processing_total" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_id", - "name": "uploaded_by_id" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_type", - "name": "uploaded_by_type" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_update_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_update_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_update_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_delete_v1", - "method": "delete", - "path": "/v1/libraries/{library_id}/documents/{document_id}", - "operationId": "libraries_documents_delete_v1", - "summary": "Delete a document.", - "description": "Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index.", - "parameters": { - "elementId": "operation-libraries_documents_delete_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_delete_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_delete_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "422-application/json": { - "elementId": "operation-libraries_documents_delete_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_delete_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_get_text_content_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents/{document_id}/text_content", - "operationId": "libraries_documents_get_text_content_v1", - "summary": "Retrieve the text content of a specific document.", - "description": "Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR.", - "parameters": { - "elementId": "operation-libraries_documents_get_text_content_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_get_text_content_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_text_content_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_get_text_content_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_text_content_v1_responses_200_application-json_text", - "name": "text" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_get_text_content_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_get_status_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents/{document_id}/status", - "operationId": "libraries_documents_get_status_v1", - "summary": "Retrieve the processing status of a specific document.", - "description": "Given a library and a document in that library, retrieve the processing status of that document.", - "parameters": { - "elementId": "operation-libraries_documents_get_status_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_get_status_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_status_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_get_status_v1_responses_200_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_status_v1_responses_200_application-json_document_id", - "name": "document_id" - }, - { - "elementId": "operation-libraries_documents_get_status_v1_responses_200_application-json_processing_status", - "name": "processing_status" - } - ] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_get_status_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_get_status_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_get_signed_url_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents/{document_id}/signed-url", - "operationId": "libraries_documents_get_signed_url_v1", - "summary": "Retrieve the signed URL of a specific document.", - "description": "Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link.", - "parameters": { - "elementId": "operation-libraries_documents_get_signed_url_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_get_signed_url_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_signed_url_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_get_signed_url_v1_responses_200_application-json", - "properties": [] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_get_signed_url_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1", - "method": "get", - "path": "/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url", - "operationId": "libraries_documents_get_extracted_text_signed_url_v1", - "summary": "Retrieve the signed URL of text extracted from a given document.", - "description": "Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries.", - "parameters": { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_responses_200_application-json", - "properties": [] - }, - "422-application/json": { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-libraries_documents_reprocess_v1", - "method": "post", - "path": "/v1/libraries/{library_id}/documents/{document_id}/reprocess", - "operationId": "libraries_documents_reprocess_v1", - "summary": "Reprocess a document.", - "description": "Given a library and a document in that library, reprocess that document, it will be billed again.", - "parameters": { - "elementId": "operation-libraries_documents_reprocess_v1_parameters", - "properties": [ - { - "elementId": "operation-libraries_documents_reprocess_v1_parameters_library_id", - "name": "library_id" - }, - { - "elementId": "operation-libraries_documents_reprocess_v1_parameters_document_id", - "name": "document_id" - } - ] - }, - "responses": { - "422-application/json": { - "elementId": "operation-libraries_documents_reprocess_v1_responses_422_application-json", - "properties": [ - { - "elementId": "operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-libraries_documents_reprocess_v1_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Chat", - "slug": "endpoint/chat", - "tags": [ - { - "name": "chat", - "operations": [ - { - "elementId": "operation-chat_completion_v1_chat_completions_post", - "method": "post", - "path": "/v1/chat/completions", - "operationId": "chat_completion_v1_chat_completions_post", - "summary": "Chat Completion", - "description": "", - "security": { - "elementId": "operation-chat_completion_v1_chat_completions_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-chat_completion_v1_chat_completions_post_request", - "properties": [ - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_frequency_penalty", - "name": "frequency_penalty" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_max_tokens", - "name": "max_tokens" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_messages", - "name": "messages" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_model", - "name": "model" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_n", - "name": "n" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_parallel_tool_calls", - "name": "parallel_tool_calls" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_prediction", - "name": "prediction" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_presence_penalty", - "name": "presence_penalty" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_prompt_mode", - "name": "prompt_mode" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_random_seed", - "name": "random_seed" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_response_format", - "name": "response_format" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_safe_prompt", - "name": "safe_prompt" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_stop", - "name": "stop" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_stream", - "name": "stream" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_temperature", - "name": "temperature" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_tool_choice", - "name": "tool_choice" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_tools", - "name": "tools" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_request_top_p", - "name": "top_p" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices", - "name": "choices" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_created", - "name": "created" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "200-text/event-stream": { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent", - "name": "CompletionEvent" - } - ] - }, - "422-application/json": { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Classifiers", - "slug": "endpoint/classifiers", - "tags": [ - { - "name": "classifiers", - "operations": [ - { - "elementId": "operation-moderations_v1_moderations_post", - "method": "post", - "path": "/v1/moderations", - "operationId": "moderations_v1_moderations_post", - "summary": "Moderations", - "description": "", - "security": { - "elementId": "operation-moderations_v1_moderations_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-moderations_v1_moderations_post_request", - "properties": [ - { - "elementId": "operation-moderations_v1_moderations_post_request_input", - "name": "input" - }, - { - "elementId": "operation-moderations_v1_moderations_post_request_model", - "name": "model" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-moderations_v1_moderations_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-moderations_v1_moderations_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-moderations_v1_moderations_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-moderations_v1_moderations_post_responses_200_application-json_results", - "name": "results" - } - ] - }, - "422-application/json": { - "elementId": "operation-moderations_v1_moderations_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-moderations_v1_moderations_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post", - "method": "post", - "path": "/v1/chat/moderations", - "operationId": "chat_moderations_v1_chat_moderations_post", - "summary": "Chat Moderations", - "description": "", - "security": { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_request", - "properties": [ - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_request_input", - "name": "input" - }, - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_request_model", - "name": "model" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results", - "name": "results" - } - ] - }, - "422-application/json": { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-classifications_v1_classifications_post", - "method": "post", - "path": "/v1/classifications", - "operationId": "classifications_v1_classifications_post", - "summary": "Classifications", - "description": "", - "security": { - "elementId": "operation-classifications_v1_classifications_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-classifications_v1_classifications_post_request", - "properties": [ - { - "elementId": "operation-classifications_v1_classifications_post_request_input", - "name": "input" - }, - { - "elementId": "operation-classifications_v1_classifications_post_request_model", - "name": "model" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-classifications_v1_classifications_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-classifications_v1_classifications_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-classifications_v1_classifications_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-classifications_v1_classifications_post_responses_200_application-json_results", - "name": "results" - } - ] - }, - "422-application/json": { - "elementId": "operation-classifications_v1_classifications_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-classifications_v1_classifications_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post", - "method": "post", - "path": "/v1/chat/classifications", - "operationId": "chat_classifications_v1_chat_classifications_post", - "summary": "Chat Classifications", - "description": "", - "security": { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_request", - "properties": [ - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_request_input", - "name": "input" - }, - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_request_model", - "name": "model" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results", - "name": "results" - } - ] - }, - "422-application/json": { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Embeddings", - "slug": "endpoint/embeddings", - "tags": [ - { - "name": "embeddings", - "operations": [ - { - "elementId": "operation-embeddings_v1_embeddings_post", - "method": "post", - "path": "/v1/embeddings", - "operationId": "embeddings_v1_embeddings_post", - "summary": "Embeddings", - "description": "Embeddings", - "security": { - "elementId": "operation-embeddings_v1_embeddings_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-embeddings_v1_embeddings_post_request", - "properties": [ - { - "elementId": "operation-embeddings_v1_embeddings_post_request_input", - "name": "input" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_request_model", - "name": "model" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_request_output_dimension", - "name": "output_dimension" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_request_output_dtype", - "name": "output_dtype" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "422-application/json": { - "elementId": "operation-embeddings_v1_embeddings_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-embeddings_v1_embeddings_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Files", - "slug": "endpoint/files", - "tags": [ - { - "name": "files", - "operations": [ - { - "elementId": "operation-files_api_routes_list_files", - "method": "get", - "path": "/v1/files", - "operationId": "files_api_routes_list_files", - "summary": "List Files", - "description": "Returns a list of files that belong to the user's organization.", - "responses": { - "200-application/json": { - "elementId": "operation-files_api_routes_list_files_responses_200_application-json", - "properties": [ - { - "elementId": "operation-files_api_routes_list_files_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-files_api_routes_list_files_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-files_api_routes_list_files_responses_200_application-json_total", - "name": "total" - } - ] - } - } - }, - { - "elementId": "operation-files_api_routes_upload_file", - "method": "post", - "path": "/v1/files", - "operationId": "files_api_routes_upload_file", - "summary": "Upload File", - "description": "Upload a file that can be used across various endpoints.\n\nThe size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files.\n\nPlease contact us if you need to increase these storage limits.", - "security": { - "elementId": "operation-files_api_routes_upload_file_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-files_api_routes_upload_file_request", - "properties": [ - { - "elementId": "operation-files_api_routes_upload_file_request_file", - "name": "file" - }, - { - "elementId": "operation-files_api_routes_upload_file_request_purpose", - "name": "purpose" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json", - "properties": [ - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_bytes", - "name": "bytes" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_filename", - "name": "filename" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_mimetype", - "name": "mimetype" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_num_lines", - "name": "num_lines" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_purpose", - "name": "purpose" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_sample_type", - "name": "sample_type" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_signature", - "name": "signature" - }, - { - "elementId": "operation-files_api_routes_upload_file_responses_200_application-json_source", - "name": "source" - } - ] - } - } - }, - { - "elementId": "operation-files_api_routes_retrieve_file", - "method": "get", - "path": "/v1/files/{file_id}", - "operationId": "files_api_routes_retrieve_file", - "summary": "Retrieve File", - "description": "Returns information about a specific file.", - "parameters": { - "elementId": "operation-files_api_routes_retrieve_file_parameters", - "properties": [ - { - "elementId": "operation-files_api_routes_retrieve_file_parameters_file_id", - "name": "file_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json", - "properties": [ - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_bytes", - "name": "bytes" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_created_at", - "name": "created_at" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_deleted", - "name": "deleted" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_filename", - "name": "filename" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_mimetype", - "name": "mimetype" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_num_lines", - "name": "num_lines" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_purpose", - "name": "purpose" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_sample_type", - "name": "sample_type" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_signature", - "name": "signature" - }, - { - "elementId": "operation-files_api_routes_retrieve_file_responses_200_application-json_source", - "name": "source" - } - ] - } - } - }, - { - "elementId": "operation-files_api_routes_delete_file", - "method": "delete", - "path": "/v1/files/{file_id}", - "operationId": "files_api_routes_delete_file", - "summary": "Delete File", - "description": "Delete a file.", - "parameters": { - "elementId": "operation-files_api_routes_delete_file_parameters", - "properties": [ - { - "elementId": "operation-files_api_routes_delete_file_parameters_file_id", - "name": "file_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-files_api_routes_delete_file_responses_200_application-json", - "properties": [ - { - "elementId": "operation-files_api_routes_delete_file_responses_200_application-json_deleted", - "name": "deleted" - }, - { - "elementId": "operation-files_api_routes_delete_file_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-files_api_routes_delete_file_responses_200_application-json_object", - "name": "object" - } - ] - } - } - }, - { - "elementId": "operation-files_api_routes_download_file", - "method": "get", - "path": "/v1/files/{file_id}/content", - "operationId": "files_api_routes_download_file", - "summary": "Download File", - "description": "Download a file", - "parameters": { - "elementId": "operation-files_api_routes_download_file_parameters", - "properties": [ - { - "elementId": "operation-files_api_routes_download_file_parameters_file_id", - "name": "file_id" - } - ] - }, - "responses": { - "200-application/octet-stream": { - "elementId": "operation-files_api_routes_download_file_responses_200_application-octet-stream", - "properties": [] - } - } - }, - { - "elementId": "operation-files_api_routes_get_signed_url", - "method": "get", - "path": "/v1/files/{file_id}/url", - "operationId": "files_api_routes_get_signed_url", - "summary": "Get Signed Url", - "description": "", - "parameters": { - "elementId": "operation-files_api_routes_get_signed_url_parameters", - "properties": [ - { - "elementId": "operation-files_api_routes_get_signed_url_parameters_file_id", - "name": "file_id" - }, - { - "elementId": "operation-files_api_routes_get_signed_url_parameters_expiry", - "name": "expiry" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-files_api_routes_get_signed_url_responses_200_application-json", - "properties": [ - { - "elementId": "operation-files_api_routes_get_signed_url_responses_200_application-json_url", - "name": "url" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Fim", - "slug": "endpoint/fim", - "tags": [ - { - "name": "fim", - "operations": [ - { - "elementId": "operation-fim_completion_v1_fim_completions_post", - "method": "post", - "path": "/v1/fim/completions", - "operationId": "fim_completion_v1_fim_completions_post", - "summary": "Fim Completion", - "description": "FIM completion.", - "security": { - "elementId": "operation-fim_completion_v1_fim_completions_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-fim_completion_v1_fim_completions_post_request", - "properties": [ - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_max_tokens", - "name": "max_tokens" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_min_tokens", - "name": "min_tokens" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_model", - "name": "model" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_prompt", - "name": "prompt" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_random_seed", - "name": "random_seed" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_stop", - "name": "stop" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_stream", - "name": "stream" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_suffix", - "name": "suffix" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_temperature", - "name": "temperature" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_request_top_p", - "name": "top_p" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices", - "name": "choices" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_created", - "name": "created" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage", - "name": "usage" - } - ] - }, - "200-text/event-stream": { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream", - "properties": [ - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent", - "name": "CompletionEvent" - } - ] - }, - "422-application/json": { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Fine Tuning", - "slug": "endpoint/fine-tuning", - "tags": [ - { - "name": "fine-tuning", - "operations": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - "method": "get", - "path": "/v1/fine_tuning/jobs", - "operationId": "jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - "summary": "Get Fine Tuning Jobs", - "description": "Get a list of fine-tuning jobs for your organization and user.", - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_object", - "name": "object" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_total", - "name": "total" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job", - "method": "post", - "path": "/v1/fine_tuning/jobs", - "operationId": "jobs_api_routes_fine_tuning_create_fine_tuning_job", - "summary": "Create Fine Tuning Job", - "description": "Create a new fine-tuning job, it will be queued for processing.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters_dry_run", - "name": "dry_run" - } - ] - }, - "security": { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_auto_start", - "name": "auto_start" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets", - "name": "classifier_targets" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters", - "name": "hyperparameters" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations", - "name": "integrations" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_invalid_sample_skip_percentage", - "name": "invalid_sample_skip_percentage" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_job_type", - "name": "job_type" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_model", - "name": "model" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories", - "name": "repositories" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_suffix", - "name": "suffix" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files", - "name": "training_files" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_validation_files", - "name": "validation_files" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout", - "name": "CompletionJobOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout", - "name": "ClassifierJobOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout", - "name": "LegacyJobMetadataOut" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job", - "method": "get", - "path": "/v1/fine_tuning/jobs/{job_id}", - "operationId": "jobs_api_routes_fine_tuning_get_fine_tuning_job", - "summary": "Get Fine Tuning Job", - "description": "Get a fine-tuned job details by its UUID.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters_job_id", - "name": "job_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout", - "name": "CompletionDetailedJobOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout", - "name": "ClassifierDetailedJobOut" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - "method": "post", - "path": "/v1/fine_tuning/jobs/{job_id}/cancel", - "operationId": "jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - "summary": "Cancel Fine Tuning Job", - "description": "Request the cancellation of a fine tuning job.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters_job_id", - "name": "job_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout", - "name": "CompletionDetailedJobOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout", - "name": "ClassifierDetailedJobOut" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job", - "method": "post", - "path": "/v1/fine_tuning/jobs/{job_id}/start", - "operationId": "jobs_api_routes_fine_tuning_start_fine_tuning_job", - "summary": "Start Fine Tuning Job", - "description": "Request the start of a validated fine tuning job.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters_job_id", - "name": "job_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout", - "name": "CompletionDetailedJobOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout", - "name": "ClassifierDetailedJobOut" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Models", - "slug": "endpoint/models", - "tags": [ - { - "name": "models", - "operations": [ - { - "elementId": "operation-list_models_v1_models_get", - "method": "get", - "path": "/v1/models", - "operationId": "list_models_v1_models_get", - "summary": "List Models", - "description": "List all models available to the user.", - "responses": { - "200-application/json": { - "elementId": "operation-list_models_v1_models_get_responses_200_application-json", - "properties": [ - { - "elementId": "operation-list_models_v1_models_get_responses_200_application-json_data", - "name": "data" - }, - { - "elementId": "operation-list_models_v1_models_get_responses_200_application-json_object", - "name": "object" - } - ] - }, - "422-application/json": { - "elementId": "operation-list_models_v1_models_get_responses_422_application-json", - "properties": [ - { - "elementId": "operation-list_models_v1_models_get_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-list_models_v1_models_get_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-retrieve_model_v1_models_model_id_get", - "method": "get", - "path": "/v1/models/{model_id}", - "operationId": "retrieve_model_v1_models__model_id__get", - "summary": "Retrieve Model", - "description": "Retrieve information about a model.", - "parameters": { - "elementId": "operation-retrieve_model_v1_models_model_id_get_parameters", - "properties": [ - { - "elementId": "operation-retrieve_model_v1_models_model_id_get_parameters_model_id", - "name": "model_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_200_application-json", - "properties": [ - { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard", - "name": "BaseModelCard" - }, - { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard", - "name": "FTModelCard" - } - ] - }, - "422-application/json": { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_422_application-json", - "properties": [ - { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-delete_model_v1_models_model_id_delete", - "method": "delete", - "path": "/v1/models/{model_id}", - "operationId": "delete_model_v1_models__model_id__delete", - "summary": "Delete Model", - "description": "Delete a fine-tuned model.", - "parameters": { - "elementId": "operation-delete_model_v1_models_model_id_delete_parameters", - "properties": [ - { - "elementId": "operation-delete_model_v1_models_model_id_delete_parameters_model_id", - "name": "model_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_200_application-json", - "properties": [ - { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_200_application-json_deleted", - "name": "deleted" - }, - { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_200_application-json_object", - "name": "object" - } - ] - }, - "422-application/json": { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_422_application-json", - "properties": [ - { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model", - "method": "patch", - "path": "/v1/fine_tuning/models/{model_id}", - "operationId": "jobs_api_routes_fine_tuning_update_fine_tuned_model", - "summary": "Update Fine Tuned Model", - "description": "Update a model name or description.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters_model_id", - "name": "model_id" - } - ] - }, - "security": { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_description", - "name": "description" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_name", - "name": "name" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout", - "name": "CompletionFTModelOut" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout", - "name": "ClassifierFTModelOut" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model", - "method": "post", - "path": "/v1/fine_tuning/models/{model_id}/archive", - "operationId": "jobs_api_routes_fine_tuning_archive_fine_tuned_model", - "summary": "Archive Fine Tuned Model", - "description": "Archive a fine-tuned model.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters_model_id", - "name": "model_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_archived", - "name": "archived" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_object", - "name": "object" - } - ] - } - } - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - "method": "delete", - "path": "/v1/fine_tuning/models/{model_id}/archive", - "operationId": "jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - "summary": "Unarchive Fine Tuned Model", - "description": "Un-archive a fine-tuned model.", - "parameters": { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters_model_id", - "name": "model_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json", - "properties": [ - { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_archived", - "name": "archived" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_object", - "name": "object" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Ocr", - "slug": "endpoint/ocr", - "tags": [ - { - "name": "ocr", - "operations": [ - { - "elementId": "operation-ocr_v1_ocr_post", - "method": "post", - "path": "/v1/ocr", - "operationId": "ocr_v1_ocr_post", - "summary": "OCR", - "description": "", - "security": { - "elementId": "operation-ocr_v1_ocr_post_request-examples", - "properties": [] - }, - "requestBody": { - "elementId": "operation-ocr_v1_ocr_post_request", - "properties": [ - { - "elementId": "operation-ocr_v1_ocr_post_request_bbox_annotation_format", - "name": "bbox_annotation_format" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_document", - "name": "document" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_document_annotation_format", - "name": "document_annotation_format" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_id", - "name": "id" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_image_limit", - "name": "image_limit" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_image_min_size", - "name": "image_min_size" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_include_image_base64", - "name": "include_image_base64" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_model", - "name": "model" - }, - { - "elementId": "operation-ocr_v1_ocr_post_request_pages", - "name": "pages" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-ocr_v1_ocr_post_responses_200_application-json", - "properties": [ - { - "elementId": "operation-ocr_v1_ocr_post_responses_200_application-json_document_annotation", - "name": "document_annotation" - }, - { - "elementId": "operation-ocr_v1_ocr_post_responses_200_application-json_model", - "name": "model" - }, - { - "elementId": "operation-ocr_v1_ocr_post_responses_200_application-json_pages", - "name": "pages" - }, - { - "elementId": "operation-ocr_v1_ocr_post_responses_200_application-json_usage_info", - "name": "usage_info" - } - ] - }, - "422-application/json": { - "elementId": "operation-ocr_v1_ocr_post_responses_422_application-json", - "properties": [ - { - "elementId": "operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta", - "name": "HttpMeta" - }, - { - "elementId": "operation-ocr_v1_ocr_post_responses_422_application-json_detail", - "name": "detail" - } - ] - } - } - } - ] - } - ] - } -] \ No newline at end of file diff --git a/examples/custom/src/app/page.tsx b/examples/custom/src/app/page.tsx deleted file mode 100644 index dadbba0f1..000000000 --- a/examples/custom/src/app/page.tsx +++ /dev/null @@ -1,14 +0,0 @@ -export default function Home() { - return ( -
- -
- ); -} diff --git a/examples/custom/src/app/pokeapi/api/endpoint/berries/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/berries/page.mdx deleted file mode 100644 index 64ea2392d..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/berries/page.mdx +++ /dev/null @@ -1,3160 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Berries Endpoints - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -## GET /api/v2/berry/ \{#operation-api_v2_berry_list\} - - - - - -_List berries_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_list_responses_200_application-json_results\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/berry/\{id\}/ \{#operation-api_v2_berry_retrieve\} - - - - - -_Get a berry_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "firmness": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "flavors": [ - { - "flavor": {}, - "potency": "10" - } - ], - "growth_time": 14, - "id": 56, - "item": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "max_harvest": 91, - "name": "nostrud", - "natural_gift_power": 32, - "natural_gift_type": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "size": 78, - "smoothness": 5, - "soil_dryness": 69 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_retrieve_responses\} - - - - - -200 - - - - - - - -BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### firmness \{#operation-api_v2_berry_retrieve_responses_200_application-json_firmness\} - - - - - - - - - -#### BerryFirmnessSummary \{#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary_url\} - - - - - - - - - - - - - -flavor","children":[{"label":"flavor","linkedLabel":"flavor","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavors \{#operation-api_v2_berry_retrieve_responses_200_application-json_flavors\} - - - - - - - - - -#### flavor \{#operation-api_v2_berry_retrieve_responses_200_application-json_flavors_flavor\} - - - - - - - - - -##### potency \{#operation-api_v2_berry_retrieve_responses_200_application-json_flavors_flavor_potency\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### growth_time \{#operation-api_v2_berry_retrieve_responses_200_application-json_growth_time\} - - - - - - - - - -##### id \{#operation-api_v2_berry_retrieve_responses_200_application-json_id\} - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item \{#operation-api_v2_berry_retrieve_responses_200_application-json_item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary_url\} - - - - - - - - - - - - - - - - - -##### max_harvest \{#operation-api_v2_berry_retrieve_responses_200_application-json_max_harvest\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve_responses_200_application-json_name\} - - - - - - - - - -##### natural_gift_power \{#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_power\} - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### natural_gift_type \{#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary_url\} - - - - - - - - - - - - - - - - - -##### size \{#operation-api_v2_berry_retrieve_responses_200_application-json_size\} - - - - - - - - - -##### smoothness \{#operation-api_v2_berry_retrieve_responses_200_application-json_smoothness\} - - - - - - - - - -##### soil_dryness \{#operation-api_v2_berry_retrieve_responses_200_application-json_soil_dryness\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/berry-firmness/ \{#operation-api_v2_berry_firmness_list\} - - - - - -_List berry firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-firmness/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_firmness_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_firmness_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_firmness_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_firmness_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_firmness_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_firmness_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_firmness_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_firmness_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_firmness_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_firmness_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_firmness_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_firmness_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFirmnessSummary","children":[{"label":"BerryFirmnessSummary","linkedLabel":"BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_firmness_list_responses_200_application-json_results\} - - - - - - - - - -#### BerryFirmnessSummary \{#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/berry-firmness/\{id\}/ \{#operation-api_v2_berry_firmness_retrieve\} - - - - - -_Get berry by firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-firmness/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_firmness_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_firmness_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_firmness_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_firmness_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_firmness_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_firmness_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_firmness_retrieve_responses\} - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_name\} - - - - - -BerryFirmnessName","children":[{"label":"BerryFirmnessName","linkedLabel":"BerryFirmnessName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### BerryFirmnessName \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/berry-flavor/ \{#operation-api_v2_berry_flavor_list\} - - - - - -_List berry flavors_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-flavor/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_flavor_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_flavor_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_flavor_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_flavor_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_flavor_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_flavor_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_flavor_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_flavor_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_flavor_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_flavor_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_flavor_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_flavor_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFlavorSummary","children":[{"label":"BerryFlavorSummary","linkedLabel":"BerryFlavorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_flavor_list_responses_200_application-json_results\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/berry-flavor/\{id\}/ \{#operation-api_v2_berry_flavor_retrieve\} - - - - - -_Get berries by flavor_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-flavor/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_berry_flavor_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_flavor_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_flavor_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_berry_flavor_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_flavor_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_berry_flavor_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "berry": {}, - "potency": "10" - } - ], - "contest_type": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 14, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_flavor_retrieve_responses\} - - - - - -200 - - - - - - - -berry","children":[{"label":"berry","linkedLabel":"berry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries\} - - - - - - - - - -#### berry \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries_berry\} - - - - - - - - - -##### potency \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries_berry_potency\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_name\} - - - - - -BerryFlavorName","children":[{"label":"BerryFlavorName","linkedLabel":"BerryFlavorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### BerryFlavorName \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_name\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/contests/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/contests/page.mdx deleted file mode 100644 index 69f4cb97d..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/contests/page.mdx +++ /dev/null @@ -1,2885 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Contests Endpoints - - - - - - - - - -## GET /api/v2/contest-type/ \{#operation-api_v2_contest_type_list\} - - - - - -_List contest types_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-type/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_contest_type_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_type_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_type_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_contest_type_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_contest_type_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_contest_type_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_contest_type_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_contest_type_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_type_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_contest_type_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_contest_type_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_contest_type_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestTypeSummary","children":[{"label":"ContestTypeSummary","linkedLabel":"ContestTypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_contest_type_list_responses_200_application-json_results\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/contest-type/\{id\}/ \{#operation-api_v2_contest_type_retrieve\} - - - - - -_Get contest type_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-type/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_contest_type_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_type_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_type_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_contest_type_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_contest_type_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_contest_type_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "berry_flavor": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "color": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_type_retrieve_responses\} - - - - - -200 - - - - - - - -berry_flavor","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berry_flavor \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_berry_flavor\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_name\} - - - - - -ContestTypeName","children":[{"label":"ContestTypeName","linkedLabel":"ContestTypeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### ContestTypeName \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename\} - - - - - - - - - -##### color \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_color\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/contest-effect/ \{#operation-api_v2_contest_effect_list\} - - - - - -_List contest effects_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-effect/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_contest_effect_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_effect_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_effect_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_contest_effect_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_contest_effect_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_contest_effect_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_contest_effect_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_contest_effect_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_effect_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_contest_effect_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_contest_effect_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_contest_effect_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestEffectSummary","children":[{"label":"ContestEffectSummary","linkedLabel":"ContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_contest_effect_list_responses_200_application-json_results\} - - - - - - - - - -#### ContestEffectSummary \{#operation-api_v2_contest_effect_list_responses_200_application-json_results_contesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_list_responses_200_application-json_results_contesteffectsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/contest-effect/\{id\}/ \{#operation-api_v2_contest_effect_retrieve\} - - - - - -_Get contest effect_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_contest_effect_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_effect_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_effect_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_contest_effect_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_contest_effect_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_contest_effect_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "flavor_text_entries": [ - { - "flavor_text": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - } - ], - "id": 14, - "jam": 56 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_effect_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### appeal \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_appeal\} - - - - - -ContestEffectEffectText","children":[{"label":"ContestEffectEffectText","linkedLabel":"ContestEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries\} - - - - - - - - - -#### ContestEffectEffectText \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - -ContestEffectFlavorText","children":[{"label":"ContestEffectFlavorText","linkedLabel":"ContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### ContestEffectFlavorText \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### jam \{#operation-api_v2_contest_effect_retrieve_responses_200_application-json_jam\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/super-contest-effect/ \{#operation-api_v2_super_contest_effect_list\} - - - - - -_List super contest effects_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/super-contest-effect/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_super_contest_effect_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_super_contest_effect_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_super_contest_effect_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_super_contest_effect_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_super_contest_effect_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_super_contest_effect_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_super_contest_effect_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_super_contest_effect_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_super_contest_effect_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -SuperContestEffectSummary","children":[{"label":"SuperContestEffectSummary","linkedLabel":"SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_results\} - - - - - - - - - -#### SuperContestEffectSummary \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_results_supercontesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_list_responses_200_application-json_results_supercontesteffectsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/super-contest-effect/\{id\}/ \{#operation-api_v2_super_contest_effect_retrieve\} - - - - - -_Get super contest effect_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/super-contest-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_super_contest_effect_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_super_contest_effect_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_super_contest_effect_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_super_contest_effect_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_super_contest_effect_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_super_contest_effect_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "flavor_text_entries": [ - { - "flavor_text": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 14, - "moves": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_super_contest_effect_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### appeal \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_appeal\} - - - - - -SuperContestEffectFlavorText","children":[{"label":"SuperContestEffectFlavorText","linkedLabel":"SuperContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### SuperContestEffectFlavorText \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary_url\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/encounters/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/encounters/page.mdx deleted file mode 100644 index 8db0fa3de..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/encounters/page.mdx +++ /dev/null @@ -1,3474 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Encounters Endpoints - - - - - - - - - -## GET /api/v2/encounter-method/ \{#operation-api_v2_encounter_method_list\} - - - - - -_List encounter methods_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-method/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_method_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_method_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_method_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_method_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_method_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_method_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_method_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_method_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_method_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_method_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_method_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_method_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterMethodSummary","children":[{"label":"EncounterMethodSummary","linkedLabel":"EncounterMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_method_list_responses_200_application-json_results\} - - - - - - - - - -#### EncounterMethodSummary \{#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/encounter-method/\{id\}/ \{#operation-api_v2_encounter_method_retrieve\} - - - - - -_Get encounter method_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-method/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_method_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_method_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_method_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_method_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_method_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_method_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_method_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_name\} - - - - - -EncounterMethodName","children":[{"label":"EncounterMethodName","linkedLabel":"EncounterMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### EncounterMethodName \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_name\} - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_encounter_method_retrieve_responses_200_application-json_order\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/encounter-condition/ \{#operation-api_v2_encounter_condition_list\} - - - - - -_List encounter conditions_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_condition_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_condition_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_condition_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_condition_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_condition_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_condition_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_condition_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_condition_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionSummary","children":[{"label":"EncounterConditionSummary","linkedLabel":"EncounterConditionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_condition_list_responses_200_application-json_results\} - - - - - - - - - -#### EncounterConditionSummary \{#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/encounter-condition/\{id\}/ \{#operation-api_v2_encounter_condition_retrieve\} - - - - - -_Get encounter condition_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_condition_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_condition_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "values": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_name\} - - - - - -EncounterConditionName","children":[{"label":"EncounterConditionName","linkedLabel":"EncounterConditionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### EncounterConditionName \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_name\} - - - - - - - - - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### values \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values\} - - - - - - - - - -#### EncounterConditionValueSummary \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/encounter-condition-value/ \{#operation-api_v2_encounter_condition_value_list\} - - - - - -_List encounter condition values_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition-value/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_condition_value_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_value_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_value_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_condition_value_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_condition_value_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_condition_value_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_condition_value_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_value_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_value_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results\} - - - - - - - - - -#### EncounterConditionValueSummary \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/encounter-condition-value/\{id\}/ \{#operation-api_v2_encounter_condition_value_retrieve\} - - - - - -_Get encounter condition value_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition-value/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_encounter_condition_value_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_value_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_value_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_encounter_condition_value_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_value_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_value_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "condition": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_value_retrieve_responses\} - - - - - -200 - - - - - - - -EncounterConditionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### condition \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition\} - - - - - - - - - -#### EncounterConditionSummary \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_name\} - - - - - -EncounterConditionValueName","children":[{"label":"EncounterConditionValueName","linkedLabel":"EncounterConditionValueName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### EncounterConditionValueName \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon/\{pokemon\_id\}/encounters \{#operation-api_v2_pokemon_encounters_retrieve\} - - - - - -_Get pokemon encounter_ - - - - - -Handles Pokemon Encounters as a sub-resource. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/{pokemon_id}/encounters \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_encounters_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_encounters_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_encounters_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_encounters_retrieve_parameters\} - - - - - - - - - - - -##### pokemon_id \{#operation-api_v2_pokemon_encounters_retrieve_parameters_pokemon_id\} - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_encounters_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "location_area": { - "name": "cerulean-city-area", - "url": "https://pokeapi.co/api/v2/location-area/281/" - }, - "version_details": [ - { - "encounter_details": [ - { - "chance": "100", - "condition_values": [ - { - "name": "story-progress-beat-red", - "url": "https://pokeapi.co/api/v2/encounter-condition-value/55/" - } - ], - "max_level": "10", - "method": { - "name": "gift", - "url": "https://pokeapi.co/api/v2/encounter-method/18/" - }, - "min_level": "10" - } - ], - "max_chance": "100", - "version": { - "name": "red", - "url": "https://pokeapi.co/api/v2/version/1/" - } - } - ] - } -] -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_encounters_retrieve_responses\} - - - - - -200 - - - - - - - -ResponseBody","children":[{"label":"ResponseBody","linkedLabel":"ResponseBody","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - - - - - -#### ResponseBody \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody\} - - - - - -location_area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### location_area \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_location_area\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail\} - - - - - -encounter_detail","children":[{"label":"encounter_detail","linkedLabel":"encounter_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details\} - - - - - - - - - -#### encounter\_detail \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail\} - - - - - - - - - -##### chance \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_chance\} - - - - - -_Example:_ - -``` -100 -``` - - - - - -condition_value","children":[{"label":"condition_value","linkedLabel":"condition_value","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### condition_values \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values\} - - - - - - - - - -#### condition\_value \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value_name\} - - - - - -_Example:_ - -``` -story-progress-beat-red -``` - - - - - - - - - -##### url \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/encounter-condition-value/55/ -``` - - - - - - - - - - - - - - - - - -##### max_level \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_max_level\} - - - - - -_Example:_ - -``` -10 -``` - - - - - -method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### method \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_method\} - - - - - - - - - - - - - -##### min_level \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_min_level\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### max_chance \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_max_chance\} - - - - - -_Example:_ - -``` -100 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/evolution/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/evolution/page.mdx deleted file mode 100644 index 8c792afbe..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/evolution/page.mdx +++ /dev/null @@ -1,1833 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Evolution Endpoints - - - - - -Evolution is a process in which a Pokémon changes into a different species of Pokémon. - - - - - - - - - -## GET /api/v2/evolution-chain/ \{#operation-api_v2_evolution_chain_list\} - - - - - -_List evolution chains_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-chain/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_evolution_chain_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_chain_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_chain_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_evolution_chain_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_evolution_chain_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_evolution_chain_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_evolution_chain_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_chain_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_chain_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_evolution_chain_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_evolution_chain_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_evolution_chain_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionChainSummary","children":[{"label":"EvolutionChainSummary","linkedLabel":"EvolutionChainSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_evolution_chain_list_responses_200_application-json_results\} - - - - - - - - - -#### EvolutionChainSummary \{#operation-api_v2_evolution_chain_list_responses_200_application-json_results_evolutionchainsummary\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_chain_list_responses_200_application-json_results_evolutionchainsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/evolution-chain/\{id\}/ \{#operation-api_v2_evolution_chain_retrieve\} - - - - - -_Get evolution chain_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-chain/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_evolution_chain_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_chain_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_chain_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_evolution_chain_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_chain_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_chain_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "baby_trigger_item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "chain": { - "evolution_details": [ - null - ], - "evolves_to": [ - { - "evolution_details": [ - { - "gender": null, - "held_item": null, - "item": null, - "known_move": null, - "known_move_type": null, - "location": null, - "min_affection": null, - "min_beauty": null, - "min_happiness": null, - "min_level": null, - "needs_overworld_rain": null, - "party_species": null, - "party_type": null, - "relative_physical_stats": null, - "time_of_day": "reprehenderit ut dolore", - "trade_species": null, - "trigger": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "turn_upside_down": false - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - }, - "id": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_chain_retrieve_responses\} - - - - - -200 - - - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_item \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary_url\} - - - - - - - - - - - - - -chain","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chain \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_chain\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_id\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/evolution-trigger/ \{#operation-api_v2_evolution_trigger_list\} - - - - - -_List evolution triggers_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-trigger/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_evolution_trigger_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_trigger_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_trigger_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_evolution_trigger_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_evolution_trigger_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_evolution_trigger_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_evolution_trigger_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_trigger_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_trigger_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionTriggerSummary","children":[{"label":"EvolutionTriggerSummary","linkedLabel":"EvolutionTriggerSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_results\} - - - - - - - - - -#### EvolutionTriggerSummary \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/evolution-trigger/\{id\}/ \{#operation-api_v2_evolution_trigger_retrieve\} - - - - - -_Get evolution trigger_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-trigger/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_evolution_trigger_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_trigger_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_trigger_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_evolution_trigger_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_trigger_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_trigger_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "ivysaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/2/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_trigger_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_name\} - - - - - -EvolutionTriggerName","children":[{"label":"EvolutionTriggerName","linkedLabel":"EvolutionTriggerName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### EvolutionTriggerName \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_name\} - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### pokemon\_specie \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_name\} - - - - - -_Example:_ - -``` -ivysaur -``` - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/2/ -``` - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/games/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/games/page.mdx deleted file mode 100644 index 8f587c474..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/games/page.mdx +++ /dev/null @@ -1,4913 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Games Endpoints - - - - - -The Pokémon games are all video games in the Pokémon franchise. - - - - - - - - - -## GET /api/v2/generation/ \{#operation-api_v2_generation_list\} - - - - - -_List genrations_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/generation/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_generation_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_generation_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_generation_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_generation_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_generation_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_generation_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_generation_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_generation_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_generation_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_generation_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_generation_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_generation_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenerationSummary","children":[{"label":"GenerationSummary","linkedLabel":"GenerationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_generation_list_responses_200_application-json_results\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/generation/\{id\}/ \{#operation-api_v2_generation_retrieve\} - - - - - -_Get genration_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/generation/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_generation_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_generation_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_generation_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_generation_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_generation_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_generation_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "abilities": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "main_region": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "moves": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ], - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_species": [ - { - "name": "do do sint mollit", - "url": "occaecat" - } - ], - "types": [ - { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - ], - "version_groups": [ - { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_generation_retrieve_responses\} - - - - - -200 - - - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities \{#operation-api_v2_generation_retrieve_responses_200_application-json_abilities\} - - - - - - - - - -#### AbilitySummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_generation_retrieve_responses_200_application-json_id\} - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_region \{#operation-api_v2_generation_retrieve_responses_200_application-json_main_region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary_url\} - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_generation_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_name\} - - - - - -GenerationName","children":[{"label":"GenerationName","linkedLabel":"GenerationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_generation_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### GenerationName \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_generation_retrieve_responses_200_application-json_types\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary_url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokedex/ \{#operation-api_v2_pokedex_list\} - - - - - -_List pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokedex/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokedex_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokedex_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokedex_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokedex_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokedex_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokedex_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokedex_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokedex_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokedex_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokedex_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokedex_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokedex_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokedex_list_responses_200_application-json_results\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokedex/\{id\}/ \{#operation-api_v2_pokedex_retrieve\} - - - - - -_Get pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokedex/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokedex_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokedex_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokedex_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokedex_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokedex_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokedex_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pokemon_entries": [ - { - "entry_number": "1", - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - } - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version_groups": [ - { - "name": "the-teal-mask", - "url": "https://pokeapi.co/api/v2/version-group/26/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokedex_retrieve_responses\} - - - - - -200 - - - - - - - -PokedexDescription","children":[{"label":"PokedexDescription","linkedLabel":"PokedexDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### PokedexDescription \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription\} - - - - - - - - - -##### description \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_main_series \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_is_main_series\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_name\} - - - - - -PokedexName","children":[{"label":"PokedexName","linkedLabel":"PokedexName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### PokedexName \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_name\} - - - - - - - - - - - - - -pokemon_entry","children":[{"label":"pokemon_entry","linkedLabel":"pokemon_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_entries \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries\} - - - - - - - - - -#### pokemon\_entry \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry\} - - - - - - - - - -##### entry_number \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry_entry_number\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry_pokemon_species\} - - - - - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary_url\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group_name\} - - - - - -_Example:_ - -``` -the-teal-mask -``` - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/26/ -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/version/ \{#operation-api_v2_version_list\} - - - - - -_List versions_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_version_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_version_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_version_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_version_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_version_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_version_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_version_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_version_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_version_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_version_list_responses_200_application-json_results\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_version_list_responses_200_application-json_results_versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_list_responses_200_application-json_results_versionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_list_responses_200_application-json_results_versionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/version/\{id\}/ \{#operation-api_v2_version_retrieve\} - - - - - -_Get version_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_version_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_version_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_version_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_version_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_retrieve_responses\} - - - - - -200 - - - - - - - -Should have a link to Version Group info but the Circular -dependency and compilation order fight eachother and I'm -not sure how to add anything other than a hyperlink - - - - - - - - - -##### id \{#operation-api_v2_version_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve_responses_200_application-json_name\} - - - - - -VersionName","children":[{"label":"VersionName","linkedLabel":"VersionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_version_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### VersionName \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_name\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_version_retrieve_responses_200_application-json_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/version-group/ \{#operation-api_v2_version_group_list\} - - - - - -_List version groups_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version-group/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_version_group_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_group_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_group_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_version_group_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_version_group_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_version_group_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_version_group_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_version_group_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_group_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_version_group_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_version_group_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_version_group_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_version_group_list_responses_200_application-json_results\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/version-group/\{id\}/ \{#operation-api_v2_version_group_retrieve\} - - - - - -_Get version group_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version-group/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_version_group_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_group_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_group_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_version_group_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_version_group_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_version_group_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "generation": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "move_learn_methods": [ - { - "name": "level-up", - "url": "https://pokeapi.co/api/v2/move-learn-method/1/" - } - ], - "name": "nostrud", - "pokedexes": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/pokedex/2/" - } - ], - "regions": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/region/1/" - } - ], - "versions": [ - { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_group_retrieve_responses\} - - - - - -200 - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_version_group_retrieve_responses_200_application-json_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_version_group_retrieve_responses_200_application-json_id\} - - - - - -move_learn_method","children":[{"label":"move_learn_method","linkedLabel":"move_learn_method","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_learn_methods \{#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods\} - - - - - - - - - -#### move\_learn\_method \{#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method_name\} - - - - - -_Example:_ - -``` -level-up -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move-learn-method/1/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_name\} - - - - - - - - - -##### order \{#operation-api_v2_version_group_retrieve_responses_200_application-json_order\} - - - - - -pokedex","children":[{"label":"pokedex","linkedLabel":"pokedex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes \{#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes\} - - - - - - - - - -#### pokedex \{#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex_name\} - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokedex/2/ -``` - - - - - - - - - - - - - -region","children":[{"label":"region","linkedLabel":"region","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### regions \{#operation-api_v2_version_group_retrieve_responses_200_application-json_regions\} - - - - - - - - - -#### region \{#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region_name\} - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/region/1/ -``` - - - - - - - - - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### versions \{#operation-api_v2_version_group_retrieve_responses_200_application-json_versions\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/items/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/items/page.mdx deleted file mode 100644 index d3115f1bf..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/items/page.mdx +++ /dev/null @@ -1,5978 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Items Endpoints - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -## GET /api/v2/item/ \{#operation-api_v2_item_list\} - - - - - -_List items_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_list_responses_200_application-json_results\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_list_responses_200_application-json_results_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_list_responses_200_application-json_results_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_list_responses_200_application-json_results_itemsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item/\{id\}/ \{#operation-api_v2_item_retrieve\} - - - - - -_Get item_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "attributes": [ - { - "name": "countable", - "url": "https://pokeapi.co/api/v2/item-attribute/1/" - } - ], - "baby_trigger_for": { - "url": "https://pokeapi.co/api/v2/evolution-chain/51/" - }, - "category": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "language": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "text": "occaecat", - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "fling_effect": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "ut sint", - "url": "dolor voluptate eu" - } - } - ], - "held_by_pokemon": [ - { - "pokemon": { - "name": "farfetchd", - "url": "https://pokeapi.co/api/v2/pokemon/83/" - }, - "version-details": [ - { - "rarity": "5", - "version": { - "name": "ruby", - "url": "https://pokeapi.co/api/v2/version/7/" - } - } - ] - } - ], - "id": 56, - "machines": [ - { - "machine": "https://pokeapi.co/api/v2/machine/1/", - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/20/" - } - } - ], - "name": "ullamco", - "names": [ - { - "language": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "name": "in consectetur excepteur sint" - } - ], - "sprites": { - "default": "https://pokeapi.co/media/sprites/items/master-ball.png" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_retrieve_responses\} - - - - - -200 - - - - - - - -attribute","children":[{"label":"attribute","linkedLabel":"attribute","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attributes \{#operation-api_v2_item_retrieve_responses_200_application-json_attributes\} - - - - - - - - - -#### attribute \{#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute_name\} - - - - - -_Example:_ - -``` -countable -``` - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item-attribute/1/ -``` - - - - - - - - - - - - - -baby_trigger_for","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_for \{#operation-api_v2_item_retrieve_responses_200_application-json_baby_trigger_for\} - - - - - - - - - -ItemCategorySummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### category \{#operation-api_v2_item_retrieve_responses_200_application-json_category\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary_url\} - - - - - - - - - - - - - - - - - -##### cost \{#operation-api_v2_item_retrieve_responses_200_application-json_cost\} - - - - - -ItemEffectText","children":[{"label":"ItemEffectText","linkedLabel":"ItemEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries\} - - - - - - - - - -#### ItemEffectText \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_short_effect\} - - - - - - - - - - - - - -ItemFlavorText","children":[{"label":"ItemFlavorText","linkedLabel":"ItemFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### ItemFlavorText \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### text \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_text\} - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - -ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### fling_effect \{#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect\} - - - - - - - - - -#### ItemFlingEffectSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary_url\} - - - - - - - - - - - - - - - - - -##### fling_power \{#operation-api_v2_item_retrieve_responses_200_application-json_fling_power\} - - - - - -ItemGameIndex","children":[{"label":"ItemGameIndex","linkedLabel":"ItemGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices\} - - - - - - - - - -#### ItemGameIndex \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - - - - - -held_by_pokemon","children":[{"label":"held_by_pokemon","linkedLabel":"held_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_by_pokemon \{#operation-api_v2_item_retrieve_responses_200_application-json_held_by_pokemon\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_retrieve_responses_200_application-json_id\} - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines \{#operation-api_v2_item_retrieve_responses_200_application-json_machines\} - - - - - - - - - -#### machine \{#operation-api_v2_item_retrieve_responses_200_application-json_machines_machine\} - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_item_retrieve_responses_200_application-json_machines_machine_version_group\} - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_name\} - - - - - -ItemName","children":[{"label":"ItemName","linkedLabel":"ItemName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### ItemName \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_name\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_item_retrieve_responses_200_application-json_sprites\} - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-category/ \{#operation-api_v2_item_category_list\} - - - - - -_List item categories_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-category/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_category_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_category_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_category_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_category_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_category_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_category_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_category_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_category_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_category_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_category_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_category_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_category_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_category_list_responses_200_application-json_results\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-category/\{id\}/ \{#operation-api_v2_item_category_retrieve\} - - - - - -_Get item category_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-category/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_category_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_category_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_category_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_category_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_category_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_category_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "items": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pocket": { - "name": "irure", - "url": "dolor" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_category_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_item_category_retrieve_responses_200_application-json_id\} - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_category_retrieve_responses_200_application-json_items\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve_responses_200_application-json_name\} - - - - - -ItemCategoryName","children":[{"label":"ItemCategoryName","linkedLabel":"ItemCategoryName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### ItemCategoryName \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_name\} - - - - - - - - - - - - - -ItemPocketSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pocket \{#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket\} - - - - - - - - - -#### ItemPocketSummary \{#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-attribute/ \{#operation-api_v2_item_attribute_list\} - - - - - -_List item attributes_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-attribute/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_attribute_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_attribute_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_attribute_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_attribute_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_attribute_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_attribute_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_attribute_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_attribute_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_attribute_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_attribute_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_attribute_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_attribute_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemAttributeSummary","children":[{"label":"ItemAttributeSummary","linkedLabel":"ItemAttributeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_attribute_list_responses_200_application-json_results\} - - - - - - - - - -#### ItemAttributeSummary \{#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-attribute/\{id\}/ \{#operation-api_v2_item_attribute_retrieve\} - - - - - -_Get item attribute_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-attribute/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_attribute_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_attribute_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_attribute_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_attribute_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_attribute_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_attribute_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "items": [ - { - "name": "master-ball", - "url": "https://pokeapi.co/api/v2/item/1/" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_attribute_retrieve_responses\} - - - - - -200 - - - - - - - -ItemAttributeDescription","children":[{"label":"ItemAttributeDescription","linkedLabel":"ItemAttributeDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### ItemAttributeDescription \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription\} - - - - - - - - - -##### description \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_id\} - - - - - -item","children":[{"label":"item","linkedLabel":"item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items\} - - - - - - - - - -#### item \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item_name\} - - - - - -_Example:_ - -``` -master-ball -``` - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item/1/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_name\} - - - - - -ItemAttributeName","children":[{"label":"ItemAttributeName","linkedLabel":"ItemAttributeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### ItemAttributeName \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-fling-effect/ \{#operation-api_v2_item_fling_effect_list\} - - - - - -_List item fling effects_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-fling-effect/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_fling_effect_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_fling_effect_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_fling_effect_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_fling_effect_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_fling_effect_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_fling_effect_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_fling_effect_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_fling_effect_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_fling_effect_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemFlingEffectSummary","children":[{"label":"ItemFlingEffectSummary","linkedLabel":"ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_results\} - - - - - - - - - -#### ItemFlingEffectSummary \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-fling-effect/\{id\}/ \{#operation-api_v2_item_fling_effect_retrieve\} - - - - - -_Get item fling effect_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-fling-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_fling_effect_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_fling_effect_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_fling_effect_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_fling_effect_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_fling_effect_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_fling_effect_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 87, - "items": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ], - "name": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_fling_effect_retrieve_responses\} - - - - - -200 - - - - - - - -ItemFlingEffectEffectText","children":[{"label":"ItemFlingEffectEffectText","linkedLabel":"ItemFlingEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries\} - - - - - - - - - -#### ItemFlingEffectEffectText \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_id\} - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_name\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-pocket/ \{#operation-api_v2_item_pocket_list\} - - - - - -_List item pockets_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-pocket/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_pocket_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_pocket_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_pocket_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_pocket_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_pocket_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_pocket_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_pocket_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_pocket_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_pocket_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_pocket_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_pocket_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_pocket_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemPocketSummary","children":[{"label":"ItemPocketSummary","linkedLabel":"ItemPocketSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_pocket_list_responses_200_application-json_results\} - - - - - - - - - -#### ItemPocketSummary \{#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/item-pocket/\{id\}/ \{#operation-api_v2_item_pocket_retrieve\} - - - - - -_Get item pocket_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-pocket/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_item_pocket_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_pocket_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_pocket_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_item_pocket_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_pocket_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_item_pocket_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "categories": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_pocket_retrieve_responses\} - - - - - -200 - - - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### categories \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_name\} - - - - - -ItemPocketName","children":[{"label":"ItemPocketName","linkedLabel":"ItemPocketName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### ItemPocketName \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_name\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/location/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/location/page.mdx deleted file mode 100644 index d408f5dbd..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/location/page.mdx +++ /dev/null @@ -1,4707 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Location Endpoints - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -## GET /api/v2/location/ \{#operation-api_v2_location_list\} - - - - - -_List locations_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_location_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_location_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_location_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_location_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_location_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_location_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_location_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_location_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_location_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_location_list_responses_200_application-json_results\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_location_list_responses_200_application-json_results_locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_list_responses_200_application-json_results_locationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_list_responses_200_application-json_results_locationsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/location/\{id\}/ \{#operation-api_v2_location_retrieve\} - - - - - -_Get location_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_location_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_location_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_location_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_location_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "areas": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - } - ], - "id": 14, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_retrieve_responses\} - - - - - -200 - - - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### areas \{#operation-api_v2_location_retrieve_responses_200_application-json_areas\} - - - - - - - - - -#### LocationAreaSummary \{#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary_url\} - - - - - - - - - - - - - -LocationGameIndex","children":[{"label":"LocationGameIndex","linkedLabel":"LocationGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices\} - - - - - - - - - -#### LocationGameIndex \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_location_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_name\} - - - - - -LocationName","children":[{"label":"LocationName","linkedLabel":"LocationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_location_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### LocationName \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_name\} - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region \{#operation-api_v2_location_retrieve_responses_200_application-json_region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/location-area/ \{#operation-api_v2_location_area_list\} - - - - - -_List location areas_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location-area/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_location_area_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_area_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_area_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_location_area_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_location_area_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_location_area_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_location_area_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_area_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_location_area_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_location_area_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_location_area_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_location_area_list_responses_200_application-json_results\} - - - - - - - - - -#### LocationAreaSummary \{#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/location-area/\{id\}/ \{#operation-api_v2_location_area_retrieve\} - - - - - -_Get location area_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location-area/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_location_area_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_area_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_area_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_location_area_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_location_area_retrieve_parameters_id\} - - - - - -A unique integer value identifying this location area. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_location_area_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "encounter_method_rates": [ - { - "encounter_method": { - "name": "old-rod", - "url": "https://pokeapi.co/api/v2/encounter-method/2/" - }, - "version_details": [ - { - "rate": "5", - "version": { - "name": "platinum", - "url": "https://pokeapi.co/api/v2/version/14/" - } - } - ] - } - ], - "game_index": 14, - "id": 56, - "location": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_encounters": [ - { - "pokemon": { - "name": "tentacool", - "url": "https://pokeapi.co/api/v2/pokemon/72/" - }, - "version_details": [ - { - "encounter_details": { - "chance": "60", - "max_level": "30", - "method": { - "name": "surf", - "url": "https://pokeapi.co/api/v2/encounter-method/5/" - }, - "min_level": "20" - }, - "max_chance": "60", - "version": { - "name": "diamond", - "url": "https://pokeapi.co/api/v2/version/12/" - } - } - ] - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_area_retrieve_responses\} - - - - - -200 - - - - - - - -encounter_method_rate","children":[{"label":"encounter_method_rate","linkedLabel":"encounter_method_rate","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### encounter_method_rates \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates\} - - - - - - - - - -#### encounter\_method\_rate \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate\} - - - - - -encounter_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_method \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_encounter_method\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail\} - - - - - - - - - -##### rate \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail_rate\} - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail_version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### game_index \{#operation-api_v2_location_area_retrieve_responses_200_application-json_game_index\} - - - - - - - - - -##### id \{#operation-api_v2_location_area_retrieve_responses_200_application-json_id\} - - - - - -LocationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### location \{#operation-api_v2_location_area_retrieve_responses_200_application-json_location\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve_responses_200_application-json_name\} - - - - - -LocationAreaName","children":[{"label":"LocationAreaName","linkedLabel":"LocationAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### LocationAreaName \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_name\} - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters\} - - - - - - - - - -#### pokemon\_encounter \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter\} - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_pokemon\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail\} - - - - - -encounter_details","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_encounter_details\} - - - - - - - - - - - - - -##### max_chance \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_max_chance\} - - - - - -_Example:_ - -``` -60 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pal-park-area/ \{#operation-api_v2_pal_park_area_list\} - - - - - -_List pal park areas_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pal-park-area/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pal_park_area_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pal_park_area_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pal_park_area_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pal_park_area_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pal_park_area_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pal_park_area_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pal_park_area_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pal_park_area_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pal_park_area_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pal_park_area_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pal_park_area_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pal_park_area_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PalParkAreaSummary","children":[{"label":"PalParkAreaSummary","linkedLabel":"PalParkAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pal_park_area_list_responses_200_application-json_results\} - - - - - - - - - -#### PalParkAreaSummary \{#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pal-park-area/\{id\}/ \{#operation-api_v2_pal_park_area_retrieve\} - - - - - -_Get pal park area_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pal-park-area/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pal_park_area_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pal_park_area_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pal_park_area_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pal_park_area_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pal_park_area_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pal_park_area_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_encounters": [ - { - "base_score": "50", - "pokemon-species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "30" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pal_park_area_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_name\} - - - - - -PalParkAreaName","children":[{"label":"PalParkAreaName","linkedLabel":"PalParkAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### PalParkAreaName \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_name\} - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters\} - - - - - - - - - -#### pokemon\_encounter \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter\} - - - - - - - - - -##### base_score \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_base_score\} - - - - - -_Example:_ - -``` -50 -``` - - - - - -pokemon-species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon-species \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_pokemon-species\} - - - - - - - - - - - - - -##### rate \{#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_rate\} - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/region/ \{#operation-api_v2_region_list\} - - - - - -_List regions_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/region/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_region_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_region_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_region_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_region_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_region_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_region_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_region_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_region_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_region_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_region_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_region_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_region_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -RegionSummary","children":[{"label":"RegionSummary","linkedLabel":"RegionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_region_list_responses_200_application-json_results\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_region_list_responses_200_application-json_results_regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_list_responses_200_application-json_results_regionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_region_list_responses_200_application-json_results_regionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/region/\{id\}/ \{#operation-api_v2_region_retrieve\} - - - - - -_Get region_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/region/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_region_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_region_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_region_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_region_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_region_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_region_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "locations": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "main_generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "pokedexes": [ - { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_region_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_region_retrieve_responses_200_application-json_id\} - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### locations \{#operation-api_v2_region_retrieve_responses_200_application-json_locations\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary_url\} - - - - - - - - - - - - - -main_generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_generation \{#operation-api_v2_region_retrieve_responses_200_application-json_main_generation\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_name\} - - - - - -RegionName","children":[{"label":"RegionName","linkedLabel":"RegionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_region_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### RegionName \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_name\} - - - - - - - - - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes \{#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary_url\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_region_retrieve_responses_200_application-json_version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group_name\} - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/machines/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/machines/page.mdx deleted file mode 100644 index b6224bc82..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/machines/page.mdx +++ /dev/null @@ -1,971 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Machines Endpoints - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -## GET /api/v2/machine/ \{#operation-api_v2_machine_list\} - - - - - -_List machines_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/machine/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_machine_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_machine_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_machine_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_machine_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_machine_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_machine_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_machine_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_machine_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_machine_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_machine_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_machine_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_machine_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MachineSummary","children":[{"label":"MachineSummary","linkedLabel":"MachineSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_machine_list_responses_200_application-json_results\} - - - - - - - - - -#### MachineSummary \{#operation-api_v2_machine_list_responses_200_application-json_results_machinesummary\} - - - - - - - - - -##### url \{#operation-api_v2_machine_list_responses_200_application-json_results_machinesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/machine/\{id\}/ \{#operation-api_v2_machine_retrieve\} - - - - - -_Get machine_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/machine/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_machine_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_machine_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_machine_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_machine_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_machine_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_machine_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "move": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_machine_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_machine_retrieve_responses_200_application-json_id\} - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item \{#operation-api_v2_machine_retrieve_responses_200_application-json_item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary_url\} - - - - - - - - - - - - - -MoveSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move \{#operation-api_v2_machine_retrieve_responses_200_application-json_move\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary_url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_machine_retrieve_responses_200_application-json_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/moves/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/moves/page.mdx deleted file mode 100644 index 4742164a4..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/moves/page.mdx +++ /dev/null @@ -1,7803 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Moves Endpoints - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -## GET /api/v2/move/ \{#operation-api_v2_move_list\} - - - - - -_List moves_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_list_responses_200_application-json_results_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_list_responses_200_application-json_results_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_list_responses_200_application-json_results_movesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move/\{id\}/ \{#operation-api_v2_move_retrieve\} - - - - - -_Get move_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "contest_combos": { - "normal": { - "use_after": null, - "use_before": null - }, - "super": { - "use_after": null, - "use_before": null - } - }, - "contest_effect": { - "url": "ipsum eiusmod" - }, - "contest_type": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "damage_class": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_chance": 87, - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "Hits Pokémon under the effects of dig and fly.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "version_group": { - "name": "gold-silver", - "url": "https://pokeapi.co/api/v2/version-group/3/" - } - } - ], - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nostrud anim", - "language": { - "name": "exercitation aliqua sint", - "url": "ut sint" - }, - "version_group": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - } - } - ], - "generation": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "id": 14, - "learned_by_pokemon": [ - { - "name": "clefairy", - "url": "https://pokeapi.co/api/v2/pokemon/35/" - } - ], - "machines": [ - { - "machine": { - "url": "https://pokeapi.co/api/v2/machine/1/" - }, - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - } - ], - "meta": { - "ailment": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "category": { - "name": "in consectetur excepteur sint", - "url": "sunt amet" - } - }, - "name": "duis ea", - "names": [ - { - "language": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "name": "magna est commodo officia" - } - ], - "past_values": [ - { - "effect_chance": 56, - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "type": { - "name": "ad occaecat elit proident ea", - "url": "cillum culpa aute minim" - }, - "version_group": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "stat_changes": [ - { - "change": "2", - "stat": { - "name": "attack", - "url": "https://pokeapi.co/api/v2/stat/1/" - } - } - ], - "super_contest_effect": { - "url": "nostrud" - }, - "target": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "type": { - "name": "dolor", - "url": "sunt" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### accuracy \{#operation-api_v2_move_retrieve_responses_200_application-json_accuracy\} - - - - - -contest_combos","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_combos \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_combos\} - - - - - - - - - -ContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_effect \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect\} - - - - - - - - - -#### ContestEffectSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect_contesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect_contesteffectsummary_url\} - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_type\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary_url\} - - - - - - - - - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_class \{#operation-api_v2_move_retrieve_responses_200_application-json_damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary_url\} - - - - - - - - - - - - - - - - - -##### effect_chance \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_chance\} - - - - - -effect_change","children":[{"label":"effect_change","linkedLabel":"effect_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes\} - - - - - - - - - -#### effect\_change \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change\} - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry_effect\} - - - - - -_Example:_ - -``` -Hits Pokémon under the effects of dig and fly. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry_language\} - - - - - - - - - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_version_group\} - - - - - - - - - - - - - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_effect\} - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_language\} - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_short_effect\} - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - -MoveFlavorText","children":[{"label":"MoveFlavorText","linkedLabel":"MoveFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### MoveFlavorText \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary_url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_move_retrieve_responses_200_application-json_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_retrieve_responses_200_application-json_id\} - - - - - -learned_by_pokemon","children":[{"label":"learned_by_pokemon","linkedLabel":"learned_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### learned_by_pokemon \{#operation-api_v2_move_retrieve_responses_200_application-json_learned_by_pokemon\} - - - - - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines \{#operation-api_v2_move_retrieve_responses_200_application-json_machines\} - - - - - - - - - -#### machine \{#operation-api_v2_move_retrieve_responses_200_application-json_machines_machine\} - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve_responses_200_application-json_machines_machine_version_group\} - - - - - - - - - - - - - - - - - -meta","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### meta \{#operation-api_v2_move_retrieve_responses_200_application-json_meta\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_name\} - - - - - -MoveName","children":[{"label":"MoveName","linkedLabel":"MoveName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveName \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_name\} - - - - - - - - - - - - - -MoveChange","children":[{"label":"MoveChange","linkedLabel":"MoveChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_values \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values\} - - - - - - - - - -#### MoveChange \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange\} - - - - - - - - - -##### accuracy \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_accuracy\} - - - - - - - - - -##### effect_chance \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_chance\} - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_effect\} - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_language\} - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_short_effect\} - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - - - - - -##### power \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_power\} - - - - - - - - - -##### pp \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_pp\} - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### type \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary_url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### power \{#operation-api_v2_move_retrieve_responses_200_application-json_power\} - - - - - - - - - -##### pp \{#operation-api_v2_move_retrieve_responses_200_application-json_pp\} - - - - - - - - - -##### priority \{#operation-api_v2_move_retrieve_responses_200_application-json_priority\} - - - - - -stat_change","children":[{"label":"stat_change","linkedLabel":"stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stat_changes \{#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes\} - - - - - - - - - -#### stat\_change \{#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change\} - - - - - - - - - -##### change \{#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change_change\} - - - - - -_Example:_ - -``` -2 -``` - - - - - -stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat \{#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change_stat\} - - - - - - - - - - - - - - - - - -SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### super_contest_effect \{#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect\} - - - - - - - - - -#### SuperContestEffectSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect_supercontesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect_supercontesteffectsummary_url\} - - - - - - - - - - - - - -MoveTargetSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### target \{#operation-api_v2_move_retrieve_responses_200_application-json_target\} - - - - - - - - - -#### MoveTargetSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary_url\} - - - - - - - - - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### type \{#operation-api_v2_move_retrieve_responses_200_application-json_type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-ailment/ \{#operation-api_v2_move_ailment_list\} - - - - - -_List move meta ailments_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-ailment/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_ailment_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_ailment_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_ailment_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_ailment_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_ailment_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_ailment_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_ailment_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_ailment_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_ailment_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_ailment_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_ailment_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_ailment_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaAilmentSummary","children":[{"label":"MoveMetaAilmentSummary","linkedLabel":"MoveMetaAilmentSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_ailment_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveMetaAilmentSummary \{#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-ailment/\{id\}/ \{#operation-api_v2_move_ailment_retrieve\} - - - - - -_Get move meta ailment_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-ailment/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_ailment_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_ailment_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_ailment_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_ailment_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_ailment_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_ailment_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "moves": [ - { - "name": "thunder-punch", - "url": "https://pokeapi.co/api/v2/move/9/" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_ailment_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_id\} - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### move \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move_name\} - - - - - -_Example:_ - -``` -thunder-punch -``` - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/9/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_name\} - - - - - -MoveMetaAilmentName","children":[{"label":"MoveMetaAilmentName","linkedLabel":"MoveMetaAilmentName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveMetaAilmentName \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-battle-style/ \{#operation-api_v2_move_battle_style_list\} - - - - - -_List move battle styles_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-battle-style/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_battle_style_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_battle_style_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_battle_style_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_battle_style_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_battle_style_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_battle_style_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_battle_style_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_battle_style_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_battle_style_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_battle_style_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_battle_style_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_battle_style_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveBattleStyleSummary","children":[{"label":"MoveBattleStyleSummary","linkedLabel":"MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_battle_style_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveBattleStyleSummary \{#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-battle-style/\{id\}/ \{#operation-api_v2_move_battle_style_retrieve\} - - - - - -_Get move battle style_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-battle-style/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_battle_style_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_battle_style_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_battle_style_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_battle_style_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_battle_style_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_battle_style_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_battle_style_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_name\} - - - - - -MoveBattleStyleName","children":[{"label":"MoveBattleStyleName","linkedLabel":"MoveBattleStyleName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveBattleStyleName \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-category/ \{#operation-api_v2_move_category_list\} - - - - - -_List move meta categories_ - - - - - -Very general categories that loosely group move effects. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-category/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_category_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_category_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_category_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_category_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_category_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_category_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_category_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_category_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_category_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_category_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_category_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_category_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaCategorySummary","children":[{"label":"MoveMetaCategorySummary","linkedLabel":"MoveMetaCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_category_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveMetaCategorySummary \{#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-category/\{id\}/ \{#operation-api_v2_move_category_retrieve\} - - - - - -_Get move meta category_ - - - - - -Very general categories that loosely group move effects. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-category/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_category_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_category_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_category_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_category_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_category_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_category_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "sing", - "url": "https://pokeapi.co/api/v2/move/47/" - } - ], - "name": "nostrud" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_category_retrieve_responses\} - - - - - -200 - - - - - - - -MoveMetaCategoryDescription","children":[{"label":"MoveMetaCategoryDescription","linkedLabel":"MoveMetaCategoryDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### MoveMetaCategoryDescription \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_category_retrieve_responses_200_application-json_id\} - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_category_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### move \{#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move_name\} - - - - - -_Example:_ - -``` -sing -``` - - - - - - - - - -##### url \{#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/47/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve_responses_200_application-json_name\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-learn-method/ \{#operation-api_v2_move_learn_method_list\} - - - - - -_List move learn methods_ - - - - - -Methods by which Pokémon can learn moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-learn-method/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_learn_method_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_learn_method_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_learn_method_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_learn_method_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_learn_method_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_learn_method_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_learn_method_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_learn_method_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_learn_method_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_learn_method_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_learn_method_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_learn_method_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveLearnMethodSummary","children":[{"label":"MoveLearnMethodSummary","linkedLabel":"MoveLearnMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_learn_method_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveLearnMethodSummary \{#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-learn-method/\{id\}/ \{#operation-api_v2_move_learn_method_retrieve\} - - - - - -_Get move learn method_ - - - - - -Methods by which Pokémon can learn moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-learn-method/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_learn_method_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_learn_method_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_learn_method_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_learn_method_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_learn_method_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_learn_method_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_learn_method_retrieve_responses\} - - - - - -200 - - - - - - - -MoveLearnMethodDescription","children":[{"label":"MoveLearnMethodDescription","linkedLabel":"MoveLearnMethodDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### MoveLearnMethodDescription \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_name\} - - - - - -MoveLearnMethodName","children":[{"label":"MoveLearnMethodName","linkedLabel":"MoveLearnMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveLearnMethodName \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_name\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group_name\} - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-target/ \{#operation-api_v2_move_target_list\} - - - - - -_List move targets_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-target/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_target_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_target_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_target_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_target_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_target_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_target_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_target_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_target_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_target_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_target_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_target_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_target_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveTargetSummary","children":[{"label":"MoveTargetSummary","linkedLabel":"MoveTargetSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_target_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveTargetSummary \{#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-target/\{id\}/ \{#operation-api_v2_move_target_retrieve\} - - - - - -_Get move target_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-target/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_target_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_target_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_target_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_target_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_target_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_target_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_target_retrieve_responses\} - - - - - -200 - - - - - - - -MoveTargetDescription","children":[{"label":"MoveTargetDescription","linkedLabel":"MoveTargetDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### MoveTargetDescription \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_target_retrieve_responses_200_application-json_id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_target_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve_responses_200_application-json_name\} - - - - - -MoveTargetName","children":[{"label":"MoveTargetName","linkedLabel":"MoveTargetName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveTargetName \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_name\} - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/pokemon/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/pokemon/page.mdx deleted file mode 100644 index 0c012122d..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/pokemon/page.mdx +++ /dev/null @@ -1,20418 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Pokemon Endpoints - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -## GET /api/v2/ability/ \{#operation-api_v2_ability_list\} - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/ability/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_ability_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_ability_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_ability_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_ability_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_ability_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_ability_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_ability_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_ability_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_ability_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_ability_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_ability_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_ability_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_ability_list_responses_200_application-json_results\} - - - - - - - - - -#### AbilitySummary \{#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/ability/\{id\}/ \{#operation-api_v2_ability_retrieve\} - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/ability/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_ability_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_ability_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_ability_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_ability_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_ability_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_ability_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "version_group": { - "name": "occaecat dolor sit", - "url": "nostrud" - } - } - ], - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nisi minim commodo irure minim", - "language": { - "name": "do do sint mollit", - "url": "occaecat" - }, - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 87, - "name": "ut sint", - "names": [ - { - "language": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "name": "et voluptate" - } - ], - "pokemon": [ - { - "is_hidden": false, - "pokemon": { - "name": "gloom", - "url": "https://pokeapi.co/api/v2/pokemon/44/" - }, - "slot": "3" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_ability_retrieve_responses\} - - - - - -200 - - - - - - - -AbilityChange","children":[{"label":"AbilityChange","linkedLabel":"AbilityChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes\} - - - - - - - - - -#### AbilityChange \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange\} - - - - - -AbilityChangeEffectText","children":[{"label":"AbilityChangeEffectText","linkedLabel":"AbilityChangeEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries\} - - - - - - - - - -#### AbilityChangeEffectText \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - -AbilityEffectText","children":[{"label":"AbilityEffectText","linkedLabel":"AbilityEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries\} - - - - - - - - - -#### AbilityEffectText \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_short_effect\} - - - - - - - - - - - - - -AbilityFlavorText","children":[{"label":"AbilityFlavorText","linkedLabel":"AbilityFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### AbilityFlavorText \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary_url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_ability_retrieve_responses_200_application-json_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_ability_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_main_series \{#operation-api_v2_ability_retrieve_responses_200_application-json_is_main_series\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_name\} - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_ability_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### AbilityName \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_name\} - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_ability_retrieve_responses_200_application-json_pokemon\} - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/characteristic/ \{#operation-api_v2_characteristic_list\} - - - - - -_List charecterictics_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/characteristic/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_characteristic_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_characteristic_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_characteristic_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_characteristic_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_characteristic_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_characteristic_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_characteristic_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_characteristic_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_characteristic_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_characteristic_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_characteristic_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_characteristic_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_characteristic_list_responses_200_application-json_results\} - - - - - - - - - -#### CharacteristicSummary \{#operation-api_v2_characteristic_list_responses_200_application-json_results_characteristicsummary\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_list_responses_200_application-json_results_characteristicsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/characteristic/\{id\}/ \{#operation-api_v2_characteristic_retrieve\} - - - - - -_Get characteristic_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/characteristic/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_characteristic_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_characteristic_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_characteristic_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_characteristic_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_characteristic_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_characteristic_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "gene_modulo": 87, - "highest_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "id": 14, - "possible_values": [ - 56 - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_characteristic_retrieve_responses\} - - - - - -200 - - - - - - - -CharacteristicDescription","children":[{"label":"CharacteristicDescription","linkedLabel":"CharacteristicDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### CharacteristicDescription \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription\} - - - - - - - - - -##### description \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### gene_modulo \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_gene_modulo\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### highest_stat \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### possible_values \{#operation-api_v2_characteristic_retrieve_responses_200_application-json_possible_values\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/egg-group/ \{#operation-api_v2_egg_group_list\} - - - - - -_List egg groups_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/egg-group/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_egg_group_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_egg_group_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_egg_group_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_egg_group_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_egg_group_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_egg_group_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_egg_group_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_egg_group_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_egg_group_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_egg_group_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_egg_group_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_egg_group_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EggGroupSummary","children":[{"label":"EggGroupSummary","linkedLabel":"EggGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_egg_group_list_responses_200_application-json_results\} - - - - - - - - - -#### EggGroupSummary \{#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/egg-group/\{id\}/ \{#operation-api_v2_egg_group_retrieve\} - - - - - -_Get egg group_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/egg-group/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_egg_group_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_egg_group_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_egg_group_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_egg_group_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_egg_group_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_egg_group_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - {} - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_egg_group_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_name\} - - - - - -EggGroupName","children":[{"label":"EggGroupName","linkedLabel":"EggGroupName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### EggGroupName \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_name\} - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### pokemon\_specie \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_name\} - - - - - -Pokemon species name. - - - - - -_Example:_ - -``` -bulbasaur -``` - - - - - - - - - -##### url \{#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_url\} - - - - - -The URL to get more information about the species - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/1/ -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/gender/ \{#operation-api_v2_gender_list\} - - - - - -_List genders_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/gender/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_gender_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_gender_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_gender_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_gender_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_gender_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_gender_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_gender_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_gender_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_gender_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_gender_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_gender_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_gender_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenderSummary","children":[{"label":"GenderSummary","linkedLabel":"GenderSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_gender_list_responses_200_application-json_results\} - - - - - - - - - -#### GenderSummary \{#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary\} - - - - - - - - - -##### name \{#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/gender/\{id\}/ \{#operation-api_v2_gender_retrieve\} - - - - - -_Get gender_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/gender/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_gender_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_gender_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_gender_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_gender_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_gender_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_gender_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "pokemon_species_details": [ - { - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "1" - } - ], - "required_for_evolution": [ - { - "name": "wormadam", - "url": "https://pokeapi.co/api/v2/pokemon-species/413/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_gender_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_gender_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_gender_retrieve_responses_200_application-json_name\} - - - - - -pokemon_species_detail","children":[{"label":"pokemon_species_detail","linkedLabel":"pokemon_species_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species_details \{#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details\} - - - - - - - - - -#### pokemon\_species\_detail \{#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail\} - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species \{#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail_pokemon_species\} - - - - - - - - - - - - - -##### rate \{#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail_rate\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -required_for_evolution","children":[{"label":"required_for_evolution","linkedLabel":"required_for_evolution","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### required_for_evolution \{#operation-api_v2_gender_retrieve_responses_200_application-json_required_for_evolution\} - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/growth-rate/ \{#operation-api_v2_growth_rate_list\} - - - - - -_List growth rates_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/growth-rate/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_growth_rate_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_growth_rate_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_growth_rate_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_growth_rate_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_growth_rate_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_growth_rate_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_growth_rate_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_growth_rate_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_growth_rate_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_growth_rate_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_growth_rate_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_growth_rate_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GrowthRateSummary","children":[{"label":"GrowthRateSummary","linkedLabel":"GrowthRateSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_growth_rate_list_responses_200_application-json_results\} - - - - - - - - - -#### GrowthRateSummary \{#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/growth-rate/\{id\}/ \{#operation-api_v2_growth_rate_retrieve\} - - - - - -_Get growth rate_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/growth-rate/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_growth_rate_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_growth_rate_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_growth_rate_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_growth_rate_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_growth_rate_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_growth_rate_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "formula": "reprehenderit ut dolore", - "id": 87, - "levels": [ - { - "experience": 14, - "level": 56 - } - ], - "name": "occaecat dolor sit", - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_growth_rate_retrieve_responses\} - - - - - -200 - - - - - - - -GrowthRateDescription","children":[{"label":"GrowthRateDescription","linkedLabel":"GrowthRateDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### GrowthRateDescription \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription\} - - - - - - - - - -##### description \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### formula \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_formula\} - - - - - - - - - -##### id \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_id\} - - - - - -Experience","children":[{"label":"Experience","linkedLabel":"Experience","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### levels \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels\} - - - - - - - - - -#### Experience \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience\} - - - - - - - - - -##### experience \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience_experience\} - - - - - - - - - -##### level \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience_level\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_name\} - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-damage-class/ \{#operation-api_v2_move_damage_class_list\} - - - - - -_List move damage classes_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-damage-class/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_damage_class_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_damage_class_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_damage_class_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_damage_class_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_damage_class_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_damage_class_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_damage_class_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_damage_class_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_damage_class_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_damage_class_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_damage_class_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_damage_class_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveDamageClassSummary","children":[{"label":"MoveDamageClassSummary","linkedLabel":"MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_damage_class_list_responses_200_application-json_results\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/move-damage-class/\{id\}/ \{#operation-api_v2_move_damage_class_retrieve\} - - - - - -_Get move damage class_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-damage-class/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_move_damage_class_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_damage_class_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_damage_class_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_move_damage_class_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_damage_class_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_move_damage_class_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_damage_class_retrieve_responses\} - - - - - -200 - - - - - - - -MoveDamageClassDescription","children":[{"label":"MoveDamageClassDescription","linkedLabel":"MoveDamageClassDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions\} - - - - - - - - - -#### MoveDamageClassDescription \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_name\} - - - - - -MoveDamageClassName","children":[{"label":"MoveDamageClassName","linkedLabel":"MoveDamageClassName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### MoveDamageClassName \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/nature/ \{#operation-api_v2_nature_list\} - - - - - -_List natures_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/nature/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_nature_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_nature_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_nature_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_nature_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_nature_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_nature_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_nature_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_nature_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_nature_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_nature_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_nature_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_nature_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -NatureSummary","children":[{"label":"NatureSummary","linkedLabel":"NatureSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_nature_list_responses_200_application-json_results\} - - - - - - - - - -#### NatureSummary \{#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/nature/\{id\}/ \{#operation-api_v2_nature_retrieve\} - - - - - -_Get nature_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/nature/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_nature_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_nature_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_nature_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_nature_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_nature_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_nature_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "decreased_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "hates_flavor": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "id": 87, - "increased_stat": { - "name": "irure", - "url": "dolor" - }, - "likes_flavor": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "move_battle_style_preferences": [ - { - "high_hp_preference": 14, - "low_hp_preference": 56, - "move_battle_style": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "name": "fugiat", - "names": [ - { - "language": { - "name": "non nisi proident Lorem", - "url": "nostrud anim" - }, - "name": "exercitation aliqua sint" - } - ], - "pokeathlon_stat_changes": [ - { - "max_change": "1", - "pokeathlon_stat": { - "name": "power", - "url": "https://pokeapi.co/api/v2/pokeathlon-stat/2/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_nature_retrieve_responses\} - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_nature_retrieve_responses_200_application-json_berries\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary_url\} - - - - - - - - - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### decreased_stat \{#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary_url\} - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hates_flavor \{#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_nature_retrieve_responses_200_application-json_id\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### increased_stat \{#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary_url\} - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes_flavor \{#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary_url\} - - - - - - - - - - - - - -NatureBattleStylePreference","children":[{"label":"NatureBattleStylePreference","linkedLabel":"NatureBattleStylePreference","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_battle_style_preferences \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences\} - - - - - - - - - -#### NatureBattleStylePreference \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference\} - - - - - - - - - -##### high_hp_preference \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_high_hp_preference\} - - - - - - - - - -##### low_hp_preference \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_low_hp_preference\} - - - - - -MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_battle_style \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style\} - - - - - - - - - -#### MoveBattleStyleSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_name\} - - - - - -NatureName","children":[{"label":"NatureName","linkedLabel":"NatureName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_nature_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### NatureName \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_name\} - - - - - - - - - - - - - -pokeathlon_stat_change","children":[{"label":"pokeathlon_stat_change","linkedLabel":"pokeathlon_stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokeathlon_stat_changes \{#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes\} - - - - - - - - - -#### pokeathlon\_stat\_change \{#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change\} - - - - - - - - - -##### max_change \{#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change_max_change\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokeathlon_stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokeathlon_stat \{#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change_pokeathlon_stat\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon/ \{#operation-api_v2_pokemon_list\} - - - - - -_List pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSummary","children":[{"label":"PokemonSummary","linkedLabel":"PokemonSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonSummary \{#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon/\{id\}/ \{#operation-api_v2_pokemon_retrieve\} - - - - - -_Get pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 1, - "name": "Rambo", - "base_experience": 64, - "height": 7, - "is_legendary": false, - "is_mythical": false, - "order": 1, - "weight": 60 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_retrieve_responses\} - - - - - -200 - - - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities\} - - - - - - - - - -#### ability \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability\} - - - - - - - - - -##### is_hidden \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability_is_hidden\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability_slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### base_experience \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_base_experience\} - - - - - -cries","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### cries \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_cries\} - - - - - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### forms \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms\} - - - - - - - - - -#### PokemonFormSummary \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary_url\} - - - - - - - - - - - - - -PokemonGameIndex","children":[{"label":"PokemonGameIndex","linkedLabel":"PokemonGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices\} - - - - - - - - - -#### PokemonGameIndex \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_game_index\} - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### height \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_height\} - - - - - -held_item","children":[{"label":"held_item","linkedLabel":"held_item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_items \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items\} - - - - - - - - - -#### held\_item \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item\} - - - - - -item","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### item \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_item\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail\} - - - - - - - - - -##### rarity \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail_rarity\} - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail_version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_is_default\} - - - - - - - - - -##### location_area_encounters \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_location_area_encounters\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon/1/encounters -``` - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### move \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move\} - - - - - -version_group_detail","children":[{"label":"version_group_detail","linkedLabel":"version_group_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group_details \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details\} - - - - - - - - - -#### version\_group\_detail \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail\} - - - - - - - - - -##### level_learned_at \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_level_learned_at\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -move_learn_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_learn_method \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_move_learn_method\} - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_version_group\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_name\} - - - - - - - - - -##### order \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_order\} - - - - - -past_ability","children":[{"label":"past_ability","linkedLabel":"past_ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_abilities \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities\} - - - - - - - - - -#### past\_ability \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability\} - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### abilities \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities\} - - - - - - - - - -#### ability \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability\} - - - - - - - - - -##### is_hidden \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability_is_hidden\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability_slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_generation\} - - - - - - - - - - - - - - - - - -past_type","children":[{"label":"past_type","linkedLabel":"past_type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_types \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types\} - - - - - - - - - -#### past\_type \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type\} - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_generation\} - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### types \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types_type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types_type_slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### species \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_sprites\} - - - - - - - - - -PokemonStat","children":[{"label":"PokemonStat","linkedLabel":"PokemonStat","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stats \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats\} - - - - - - - - - -#### PokemonStat \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat\} - - - - - - - - - -##### base_stat \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_base_stat\} - - - - - - - - - -##### effort \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_effort\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary_url\} - - - - - - - - - - - - - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_types_type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_types_type_slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### weight \{#operation-api_v2_pokemon_retrieve_responses_200_application-json_weight\} - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-color/ \{#operation-api_v2_pokemon_color_list\} - - - - - -_List pokemon colors_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-color/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_color_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_color_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_color_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_color_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_color_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_color_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_color_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_color_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_color_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_color_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_color_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_color_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonColorSummary","children":[{"label":"PokemonColorSummary","linkedLabel":"PokemonColorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_color_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonColorSummary \{#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-color/\{id\}/ \{#operation-api_v2_pokemon_color_retrieve\} - - - - - -_Get pokemon color_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-color/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_color_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_color_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_color_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_color_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_color_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_color_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_color_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_name\} - - - - - -PokemonColorName","children":[{"label":"PokemonColorName","linkedLabel":"PokemonColorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### PokemonColorName \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-form/ \{#operation-api_v2_pokemon_form_list\} - - - - - -_List pokemon forms_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-form/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_form_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_form_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_form_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_form_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_form_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_form_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_form_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_form_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_form_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_form_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_form_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_form_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_form_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonFormSummary \{#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-form/\{id\}/ \{#operation-api_v2_pokemon_form_retrieve\} - - - - - -_Get pokemon form_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-form/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_form_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_form_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_form_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_form_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_form_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_form_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "form_name": "ipsum eiusmod", - "form_names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "id": 87, - "name": "nostrud", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "pokemon": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "sprites": {}, - "types": [ - { - "slot": "1", - "type": { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - } - ], - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_form_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### form_name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_name\} - - - - - -form_name","children":[{"label":"form_name","linkedLabel":"form_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_names \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names\} - - - - - - - - - -#### form\_name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name_language\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name_name\} - - - - - -_Example:_ - -``` -Plant Cloak -``` - - - - - - - - - - - - - - - - - -##### form_order \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_order\} - - - - - - - - - -##### id \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_battle_only \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_battle_only\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_default\} - - - - - - - - - -##### is_mega \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_mega\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names_name_language\} - - - - - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_order\} - - - - - -PokemonSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon\} - - - - - - - - - -#### PokemonSummary \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary_url\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_sprites\} - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types_type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types_type_slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-habitat/ \{#operation-api_v2_pokemon_habitat_list\} - - - - - -_List pokemom habitas_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-habitat/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_habitat_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_habitat_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_habitat_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_habitat_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_habitat_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_habitat_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_habitat_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_habitat_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_habitat_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonHabitatSummary","children":[{"label":"PokemonHabitatSummary","linkedLabel":"PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonHabitatSummary \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-habitat/\{id\}/ \{#operation-api_v2_pokemon_habitat_retrieve\} - - - - - -_Get pokemom habita_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-habitat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_habitat_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_habitat_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_habitat_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_habitat_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_habitat_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_habitat_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_habitat_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_name\} - - - - - -PokemonHabitatName","children":[{"label":"PokemonHabitatName","linkedLabel":"PokemonHabitatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### PokemonHabitatName \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-shape/ \{#operation-api_v2_pokemon_shape_list\} - - - - - -_List pokemon shapes_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-shape/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_shape_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_shape_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_shape_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_shape_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_shape_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_shape_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_shape_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_shape_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_shape_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonShapeSummary","children":[{"label":"PokemonShapeSummary","linkedLabel":"PokemonShapeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonShapeSummary \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-shape/\{id\}/ \{#operation-api_v2_pokemon_shape_retrieve\} - - - - - -_Get pokemon shape_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-shape/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_shape_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_shape_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_shape_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_shape_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_shape_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_shape_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "awesome_names": [ - { - "awesome_name": "Pomaceous", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "id": 87, - "name": "occaecat dolor sit", - "names": [ - { - "name": "Ball", - "url": "https://pokeapi.co/api/v2/language/9/" - } - ], - "pokemon_species": [ - { - "name": "irure", - "url": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_shape_retrieve_responses\} - - - - - -200 - - - - - - - -awesome_name","children":[{"label":"awesome_name","linkedLabel":"awesome_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### awesome_names \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names\} - - - - - - - - - -#### awesome\_name \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names_awesome_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names_awesome_name_language\} - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names_name_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/language/9/ -``` - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-species/ \{#operation-api_v2_pokemon_species_list\} - - - - - -_List pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-species/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_species_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_species_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_species_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_species_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_species_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_species_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_species_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_species_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_species_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_species_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_species_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_species_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_species_list_responses_200_application-json_results\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokemon-species/\{id\}/ \{#operation-api_v2_pokemon_species_retrieve\} - - - - - -_Get pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-species/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokemon_species_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_species_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_species_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokemon_species_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_species_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_species_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "color": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "egg_groups": [ - { - "name": "monster", - "url": "https://pokeapi.co/api/v2/egg-group/1/" - } - ], - "evolution_chain": { - "url": "nostrud" - }, - "evolves_from_species": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "flavor_text_entries": [ - { - "flavor_text": "dolor", - "language": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "form_descriptions": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "genera": [ - { - "genus": "Seed Pokémon", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "generation": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "growth_rate": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "habitat": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "id": 87, - "name": "proident", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "bulbasaur" - } - ], - "pal_park_encounters": [ - { - "area": { - "name": "field", - "url": "https://pokeapi.co/api/v2/pal-park-area/2/" - }, - "base_score": "50", - "rate": "30" - } - ], - "pokedex_numbers": [ - { - "entry_number": 91, - "pokedex": { - "name": "sunt amet", - "url": "duis ea" - } - } - ], - "shape": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "varieties": [ - { - "is_default": false, - "pokemon": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon/1/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_species_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### base_happiness \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_base_happiness\} - - - - - - - - - -##### capture_rate \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_capture_rate\} - - - - - -PokemonColorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### color \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color\} - - - - - - - - - -#### PokemonColorSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary_url\} - - - - - - - - - - - - - -egg_group","children":[{"label":"egg_group","linkedLabel":"egg_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### egg_groups \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups\} - - - - - - - - - -#### egg\_group \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group_name\} - - - - - -_Example:_ - -``` -monster -``` - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group_url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/egg-group/1/ -``` - - - - - - - - - - - - - -EvolutionChainSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolution_chain \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain\} - - - - - - - - - -#### EvolutionChainSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain_evolutionchainsummary\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain_evolutionchainsummary_url\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolves_from_species \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary_url\} - - - - - - - - - - - - - -PokemonSpeciesFlavorText","children":[{"label":"PokemonSpeciesFlavorText","linkedLabel":"PokemonSpeciesFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries\} - - - - - - - - - -#### PokemonSpeciesFlavorText \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary_url\} - - - - - - - - - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary_url\} - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesDescription","children":[{"label":"PokemonSpeciesDescription","linkedLabel":"PokemonSpeciesDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_descriptions \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions\} - - - - - - - - - -#### PokemonSpeciesDescription \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription\} - - - - - - - - - -##### description \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### forms_switchable \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_forms_switchable\} - - - - - - - - - -##### gender_rate \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_gender_rate\} - - - - - -genus","children":[{"label":"genus","linkedLabel":"genus","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### genera \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera\} - - - - - - - - - -#### genus \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera_genus\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera_genus_language\} - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary_url\} - - - - - - - - - - - - - -GrowthRateSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### growth_rate \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate\} - - - - - - - - - -#### GrowthRateSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary_url\} - - - - - - - - - - - - - -PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### habitat \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat\} - - - - - - - - - -#### PokemonHabitatSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary_url\} - - - - - - - - - - - - - - - - - -##### has_gender_differences \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_has_gender_differences\} - - - - - - - - - -##### hatch_counter \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_hatch_counter\} - - - - - - - - - -##### id \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_baby \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_baby\} - - - - - - - - - -##### is_legendary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_legendary\} - - - - - - - - - -##### is_mythical \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_mythical\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names_name_language\} - - - - - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_order\} - - - - - -pal_park_encounter","children":[{"label":"pal_park_encounter","linkedLabel":"pal_park_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pal_park_encounters \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters\} - - - - - - - - - -#### pal\_park\_encounter \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter\} - - - - - -area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### area \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_area\} - - - - - - - - - - - - - -##### base_score \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_base_score\} - - - - - -_Example:_ - -``` -50 -``` - - - - - - - - - -##### rate \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_rate\} - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - -PokemonDexEntry","children":[{"label":"PokemonDexEntry","linkedLabel":"PokemonDexEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedex_numbers \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers\} - - - - - - - - - -#### PokemonDexEntry \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry\} - - - - - - - - - -##### entry_number \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_entry_number\} - - - - - -PokedexSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokedex \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary_url\} - - - - - - - - - - - - - - - - - - - - - -PokemonShapeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shape \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape\} - - - - - - - - - -#### PokemonShapeSummary \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary_url\} - - - - - - - - - - - - - -variety","children":[{"label":"variety","linkedLabel":"variety","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### varieties \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties\} - - - - - - - - - -#### variety \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety_is_default\} - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon \{#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety_pokemon\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokeathlon-stat/ \{#operation-api_v2_pokeathlon_stat_list\} - - - - - -_List pokeathlon stats_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokeathlon-stat/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokeathlon_stat_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokeathlon_stat_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokeathlon_stat_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokeathlon_stat_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokeathlon_stat_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokeathlon_stat_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokeathlon_stat_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokeathlon_stat_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokeathlon_stat_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokeathlonStatSummary","children":[{"label":"PokeathlonStatSummary","linkedLabel":"PokeathlonStatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results\} - - - - - - - - - -#### PokeathlonStatSummary \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/pokeathlon-stat/\{id\}/ \{#operation-api_v2_pokeathlon_stat_retrieve\} - - - - - -_Get pokeathlon stat_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokeathlon-stat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_pokeathlon_stat_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokeathlon_stat_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokeathlon_stat_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_pokeathlon_stat_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokeathlon_stat_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_pokeathlon_stat_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "affecting_natures": { - "decrease": [ - { - "max_change": "-1", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ], - "increase": [ - { - "max_change": "2", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ] - }, - "id": 56, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokeathlon_stat_retrieve_responses\} - - - - - -200 - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_affecting_natures\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_name\} - - - - - -PokeathlonStatName","children":[{"label":"PokeathlonStatName","linkedLabel":"PokeathlonStatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### PokeathlonStatName \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/stat/ \{#operation-api_v2_stat_list\} - - - - - -_List stats_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/stat/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_stat_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_stat_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_stat_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_stat_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_stat_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_stat_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_stat_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_stat_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_stat_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_stat_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_stat_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_stat_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -StatSummary","children":[{"label":"StatSummary","linkedLabel":"StatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_stat_list_responses_200_application-json_results\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_stat_list_responses_200_application-json_results_statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_list_responses_200_application-json_results_statsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_list_responses_200_application-json_results_statsummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/stat/\{id\}/ \{#operation-api_v2_stat_retrieve\} - - - - - -_Get stat_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/stat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_stat_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_stat_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_stat_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_stat_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_stat_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_stat_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "affecting_moves": { - "decrease": [ - { - "change": "5", - "move": { - "name": "growl", - "url": "https://pokeapi.co/api/v2/move/45/" - } - } - ], - "increase": [ - { - "change": "-1", - "move": { - "name": "swords-dance", - "url": "https://pokeapi.co/api/v2/move/14/" - } - } - ] - }, - "affecting_natures": { - "decrease": [ - { - "name": "bold", - "url": "https://pokeapi.co/api/v2/nature/2/" - } - ], - "increase": [ - { - "name": "lonely", - "url": "https://pokeapi.co/api/v2/nature/6/" - } - ] - }, - "characteristics": [ - { - "url": "sunt" - } - ], - "game_index": 56, - "id": 91, - "move_damage_class": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "name": "occaecat", - "names": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - }, - "name": "nostrud anim" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_stat_retrieve_responses\} - - - - - -200 - - - - - - - -affecting_moves","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_moves \{#operation-api_v2_stat_retrieve_responses_200_application-json_affecting_moves\} - - - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures \{#operation-api_v2_stat_retrieve_responses_200_application-json_affecting_natures\} - - - - - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### characteristics \{#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics\} - - - - - - - - - -#### CharacteristicSummary \{#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics_characteristicsummary\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics_characteristicsummary_url\} - - - - - - - - - - - - - - - - - -##### game_index \{#operation-api_v2_stat_retrieve_responses_200_application-json_game_index\} - - - - - - - - - -##### id \{#operation-api_v2_stat_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### is_battle_only \{#operation-api_v2_stat_retrieve_responses_200_application-json_is_battle_only\} - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class \{#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve_responses_200_application-json_name\} - - - - - -StatName","children":[{"label":"StatName","linkedLabel":"StatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_stat_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### StatName \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_name\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/type/ \{#operation-api_v2_type_list\} - - - - - -_List types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/type/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_type_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_type_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_type_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_type_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_type_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_type_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_type_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_type_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_type_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_type_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_type_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_type_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_type_list_responses_200_application-json_results\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_type_list_responses_200_application-json_results_typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_list_responses_200_application-json_results_typesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_list_responses_200_application-json_results_typesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/type/\{id\}/ \{#operation-api_v2_type_retrieve\} - - - - - -_Get types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/type/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_type_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_type_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_type_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_type_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_type_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_type_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 14, - "move_damage_class": { - "name": "ut sint", - "url": "dolor voluptate eu" - }, - "moves": [ - { - "name": "quis minim non magna quis", - "url": "et voluptate" - } - ], - "name": "commodo labore aliqua ad", - "names": [ - { - "language": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "name": "proident" - } - ], - "past_damage_relations": [ - { - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "generation": { - "name": "generation-v", - "url": "https://pokeapi.co/api/v2/generation/5/" - } - } - ], - "pokemon": [ - {} - ], - "sprites": [ - [ - {} - ] - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_type_retrieve_responses\} - - - - - -200 - - - - - - - -Serializer for the Type resource - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_relations \{#operation-api_v2_type_retrieve_responses_200_application-json_damage_relations\} - - - - - - - - - -TypeGameIndex","children":[{"label":"TypeGameIndex","linkedLabel":"TypeGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices\} - - - - - - - - - -#### TypeGameIndex \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_type_retrieve_responses_200_application-json_generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary_url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_type_retrieve_responses_200_application-json_id\} - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class \{#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_url\} - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_type_retrieve_responses_200_application-json_moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_name\} - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_type_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### AbilityName \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_name\} - - - - - - - - - - - - - -past_damage_relation","children":[{"label":"past_damage_relation","linkedLabel":"past_damage_relation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_damage_relations \{#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations\} - - - - - - - - - -#### past\_damage\_relation \{#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation\} - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### damage_relations \{#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation_damage_relations\} - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation_generation\} - - - - - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_type_retrieve_responses_200_application-json_pokemon\} - - - - - - - - - -sprites","children":[{"label":"map","linkedLabel":"sprites","children":[{"label":"sprites","linkedLabel":"sprites","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_type_retrieve_responses_200_application-json_sprites\} - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/endpoint/utility/page.mdx b/examples/custom/src/app/pokeapi/api/endpoint/utility/page.mdx deleted file mode 100644 index 95bbfea28..000000000 --- a/examples/custom/src/app/pokeapi/api/endpoint/utility/page.mdx +++ /dev/null @@ -1,956 +0,0 @@ -import "@/app/speakeasy.css"; -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@/components/speakeasy-custom"; - - - - - -# Utility Endpoints - - - - - - - - - -## GET /api/v2/language/ \{#operation-api_v2_language_list\} - - - - - -_List languages_ - - - - - -Languages for translations of API resource information. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/language/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_language_list_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_language_list_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_language_list_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_language_list_parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_language_list_parameters_limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_language_list_parameters_offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_language_list_parameters_q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_language_list_responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_language_list_responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_language_list_responses_200_application-json_count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_language_list_responses_200_application-json_next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_language_list_responses_200_application-json_previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LanguageSummary","children":[{"label":"LanguageSummary","linkedLabel":"LanguageSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_language_list_responses_200_application-json_results\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_language_list_responses_200_application-json_results_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_language_list_responses_200_application-json_results_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_language_list_responses_200_application-json_results_languagesummary_url\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /api/v2/language/\{id\}/ \{#operation-api_v2_language_retrieve\} - - - - - -_Get language_ - - - - - -Languages for translations of API resource information. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/language/{id}/ \ - -X GET -``` - - - - - - - - - - - -
- - - -### Security \{#operation-api_v2_language_retrieve_security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_language_retrieve_security_cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_language_retrieve_security_basicauth\} - - - - - - - - - -
- - - - - -
- - - -### Parameters \{#operation-api_v2_language_retrieve_parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_language_retrieve_parameters_id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
- - - - - - - - - -### Responses Examples \{#operation-api_v2_language_retrieve_responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "iso3166": "ipsum eiusmod", - "iso639": "consequat do", - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_language_retrieve_responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_language_retrieve_responses_200_application-json_id\} - - - - - - - - - -##### iso3166 \{#operation-api_v2_language_retrieve_responses_200_application-json_iso3166\} - - - - - - - - - -##### iso639 \{#operation-api_v2_language_retrieve_responses_200_application-json_iso639\} - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve_responses_200_application-json_name\} - - - - - -LanguageName","children":[{"label":"LanguageName","linkedLabel":"LanguageName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_language_retrieve_responses_200_application-json_names\} - - - - - - - - - -#### LanguageName \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary_name\} - - - - - - - - - -##### url \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary_url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_name\} - - - - - - - - - - - - - - - - - -##### official \{#operation-api_v2_language_retrieve_responses_200_application-json_official\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/api/page.mdx b/examples/custom/src/app/pokeapi/api/page.mdx deleted file mode 100644 index 788333e91..000000000 --- a/examples/custom/src/app/pokeapi/api/page.mdx +++ /dev/null @@ -1,33 +0,0 @@ -import "@/app/speakeasy.css"; -import { - Pill -} from "@/components/speakeasy-custom"; - -# About PokéAPI - -_Version: 2.7.0_ - -All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API. - -## What is this? - -This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series. - -We've covered everything from Pokémon to Berry Flavors. - -## Where do I start? - -We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started. - -This API will always be publicly available and will never require any extensive setup process to consume. - -Created by [**Paul Hallett**](https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo. - - -Servers - -- https://pokeapi.co - -## Global Security - -### cookieAuth cookie apiKey \{#cookieAuth\} \ No newline at end of file diff --git a/examples/custom/src/app/pokeapi/layout.tsx b/examples/custom/src/app/pokeapi/layout.tsx deleted file mode 100644 index 34bca511b..000000000 --- a/examples/custom/src/app/pokeapi/layout.tsx +++ /dev/null @@ -1,26 +0,0 @@ -import React from "react"; -import sidebarMetadata from "./sidebarMetadata.json"; -import { Sidebar } from "@/components/Sidebar"; - -export default function RootLayout({ - children, -}: Readonly<{ - children: React.ReactNode; -}>) { - return ( - <> -
- -
-
{children}
- - ); -} diff --git a/examples/custom/src/app/pokeapi/page.tsx b/examples/custom/src/app/pokeapi/page.tsx deleted file mode 100644 index 3c48a5eb1..000000000 --- a/examples/custom/src/app/pokeapi/page.tsx +++ /dev/null @@ -1,5 +0,0 @@ -import { redirect, RedirectType } from "next/navigation"; - -export default function Page() { - redirect("/pokeapi/api", RedirectType.replace); -} diff --git a/examples/custom/src/app/pokeapi/sidebarMetadata.json b/examples/custom/src/app/pokeapi/sidebarMetadata.json deleted file mode 100644 index d95209551..000000000 --- a/examples/custom/src/app/pokeapi/sidebarMetadata.json +++ /dev/null @@ -1,6209 +0,0 @@ -[ - { - "sidebarLabel": "About", - "slug": "", - "tags": [] - }, - { - "sidebarLabel": "Berries", - "slug": "endpoint/berries", - "tags": [ - { - "name": "berries", - "operations": [ - { - "elementId": "operation-api_v2_berry_list", - "method": "get", - "path": "/api/v2/berry/", - "operationId": "api_v2_berry_list", - "summary": "List berries", - "description": "Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_list_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_berry_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_berry_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_berry_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_berry_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_berry_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_berry_retrieve", - "method": "get", - "path": "/api/v2/berry/{id}/", - "operationId": "api_v2_berry_retrieve", - "summary": "Get a berry", - "description": "Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_firmness", - "name": "firmness" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_flavors", - "name": "flavors" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_growth_time", - "name": "growth_time" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_item", - "name": "item" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_max_harvest", - "name": "max_harvest" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_power", - "name": "natural_gift_power" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type", - "name": "natural_gift_type" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_size", - "name": "size" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_smoothness", - "name": "smoothness" - }, - { - "elementId": "operation-api_v2_berry_retrieve_responses_200_application-json_soil_dryness", - "name": "soil_dryness" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_berry_firmness_list", - "method": "get", - "path": "/api/v2/berry-firmness/", - "operationId": "api_v2_berry_firmness_list", - "summary": "List berry firmness", - "description": "Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_firmness_list_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_firmness_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_firmness_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_berry_firmness_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_berry_firmness_retrieve", - "method": "get", - "path": "/api/v2/berry-firmness/{id}/", - "operationId": "api_v2_berry_firmness_retrieve", - "summary": "Get berry by firmness", - "description": "Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_firmness_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_firmness_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_firmness_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_firmness_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries", - "name": "berries" - }, - { - "elementId": "operation-api_v2_berry_firmness_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_berry_firmness_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_berry_flavor_list", - "method": "get", - "path": "/api/v2/berry-flavor/", - "operationId": "api_v2_berry_flavor_list", - "summary": "List berry flavors", - "description": "Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_flavor_list_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_flavor_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_flavor_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_berry_flavor_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve", - "method": "get", - "path": "/api/v2/berry-flavor/{id}/", - "operationId": "api_v2_berry_flavor_retrieve", - "summary": "Get berries by flavor", - "description": "Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.", - "security": { - "elementId": "operation-api_v2_berry_flavor_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_berry_flavor_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries", - "name": "berries" - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type", - "name": "contest_type" - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Contests", - "slug": "endpoint/contests", - "tags": [ - { - "name": "contests", - "operations": [ - { - "elementId": "operation-api_v2_contest_type_list", - "method": "get", - "path": "/api/v2/contest-type/", - "operationId": "api_v2_contest_type_list", - "summary": "List contest types", - "description": "Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail.", - "security": { - "elementId": "operation-api_v2_contest_type_list_security", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_contest_type_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_contest_type_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_contest_type_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_contest_type_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_contest_type_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_contest_type_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_contest_type_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_contest_type_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_contest_type_retrieve", - "method": "get", - "path": "/api/v2/contest-type/{id}/", - "operationId": "api_v2_contest_type_retrieve", - "summary": "Get contest type", - "description": "Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail.", - "security": { - "elementId": "operation-api_v2_contest_type_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_contest_type_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_contest_type_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_contest_type_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_contest_type_retrieve_responses_200_application-json_berry_flavor", - "name": "berry_flavor" - }, - { - "elementId": "operation-api_v2_contest_type_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_contest_type_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_contest_type_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_contest_effect_list", - "method": "get", - "path": "/api/v2/contest-effect/", - "operationId": "api_v2_contest_effect_list", - "summary": "List contest effects", - "description": "Contest effects refer to the effects of moves when used in contests.", - "security": { - "elementId": "operation-api_v2_contest_effect_list_security", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_contest_effect_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_contest_effect_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_contest_effect_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_contest_effect_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_contest_effect_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_contest_effect_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_contest_effect_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_contest_effect_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve", - "method": "get", - "path": "/api/v2/contest-effect/{id}/", - "operationId": "api_v2_contest_effect_retrieve", - "summary": "Get contest effect", - "description": "Contest effects refer to the effects of moves when used in contests.", - "security": { - "elementId": "operation-api_v2_contest_effect_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_contest_effect_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json_appeal", - "name": "appeal" - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries", - "name": "effect_entries" - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_contest_effect_retrieve_responses_200_application-json_jam", - "name": "jam" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_super_contest_effect_list", - "method": "get", - "path": "/api/v2/super-contest-effect/", - "operationId": "api_v2_super_contest_effect_list", - "summary": "List super contest effects", - "description": "Super contest effects refer to the effects of moves when used in super contests.", - "security": { - "elementId": "operation-api_v2_super_contest_effect_list_security", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_super_contest_effect_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_super_contest_effect_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_super_contest_effect_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_super_contest_effect_retrieve", - "method": "get", - "path": "/api/v2/super-contest-effect/{id}/", - "operationId": "api_v2_super_contest_effect_retrieve", - "summary": "Get super contest effect", - "description": "Super contest effects refer to the effects of moves when used in super contests.", - "security": { - "elementId": "operation-api_v2_super_contest_effect_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_super_contest_effect_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_super_contest_effect_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_appeal", - "name": "appeal" - }, - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves", - "name": "moves" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Encounters", - "slug": "endpoint/encounters", - "tags": [ - { - "name": "encounters", - "operations": [ - { - "elementId": "operation-api_v2_encounter_method_list", - "method": "get", - "path": "/api/v2/encounter-method/", - "operationId": "api_v2_encounter_method_list", - "summary": "List encounter methods", - "description": "Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail.", - "security": { - "elementId": "operation-api_v2_encounter_method_list_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_method_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_method_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_encounter_method_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_encounter_method_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_method_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_encounter_method_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_encounter_method_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_encounter_method_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_encounter_method_retrieve", - "method": "get", - "path": "/api/v2/encounter-method/{id}/", - "operationId": "api_v2_encounter_method_retrieve", - "summary": "Get encounter method", - "description": "Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail.", - "security": { - "elementId": "operation-api_v2_encounter_method_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_method_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_method_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_method_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_method_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_encounter_method_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_encounter_method_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_encounter_method_retrieve_responses_200_application-json_order", - "name": "order" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_encounter_condition_list", - "method": "get", - "path": "/api/v2/encounter-condition/", - "operationId": "api_v2_encounter_condition_list", - "summary": "List encounter conditions", - "description": "Conditions which affect what pokemon might appear in the wild, e.g., day or night.", - "security": { - "elementId": "operation-api_v2_encounter_condition_list_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_condition_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_condition_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_encounter_condition_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_encounter_condition_retrieve", - "method": "get", - "path": "/api/v2/encounter-condition/{id}/", - "operationId": "api_v2_encounter_condition_retrieve", - "summary": "Get encounter condition", - "description": "Conditions which affect what pokemon might appear in the wild, e.g., day or night.", - "security": { - "elementId": "operation-api_v2_encounter_condition_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_condition_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_condition_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_condition_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_encounter_condition_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values", - "name": "values" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list", - "method": "get", - "path": "/api/v2/encounter-condition-value/", - "operationId": "api_v2_encounter_condition_value_list", - "summary": "List encounter condition values", - "description": "Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night.", - "security": { - "elementId": "operation-api_v2_encounter_condition_value_list_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_condition_value_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_condition_value_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve", - "method": "get", - "path": "/api/v2/encounter-condition-value/{id}/", - "operationId": "api_v2_encounter_condition_value_retrieve", - "summary": "Get encounter condition value", - "description": "Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night.", - "security": { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition", - "name": "condition" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_encounters_retrieve", - "method": "get", - "path": "/api/v2/pokemon/{pokemon_id}/encounters", - "operationId": "api_v2_pokemon_encounters_retrieve", - "summary": "Get pokemon encounter", - "description": "Handles Pokemon Encounters as a sub-resource.", - "security": { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_parameters_pokemon_id", - "name": "pokemon_id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody", - "name": "ResponseBody" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Evolution", - "slug": "endpoint/evolution", - "tags": [ - { - "name": "evolution", - "operations": [ - { - "elementId": "operation-api_v2_evolution_chain_list", - "method": "get", - "path": "/api/v2/evolution-chain/", - "operationId": "api_v2_evolution_chain_list", - "summary": "List evolution chains", - "description": "Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.", - "security": { - "elementId": "operation-api_v2_evolution_chain_list_security", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_evolution_chain_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_evolution_chain_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_evolution_chain_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_evolution_chain_retrieve", - "method": "get", - "path": "/api/v2/evolution-chain/{id}/", - "operationId": "api_v2_evolution_chain_retrieve", - "summary": "Get evolution chain", - "description": "Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.", - "security": { - "elementId": "operation-api_v2_evolution_chain_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_evolution_chain_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_evolution_chain_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_evolution_chain_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item", - "name": "baby_trigger_item" - }, - { - "elementId": "operation-api_v2_evolution_chain_retrieve_responses_200_application-json_chain", - "name": "chain" - }, - { - "elementId": "operation-api_v2_evolution_chain_retrieve_responses_200_application-json_id", - "name": "id" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_evolution_trigger_list", - "method": "get", - "path": "/api/v2/evolution-trigger/", - "operationId": "api_v2_evolution_trigger_list", - "summary": "List evolution triggers", - "description": "Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.", - "security": { - "elementId": "operation-api_v2_evolution_trigger_list_security", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_evolution_trigger_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_evolution_trigger_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_evolution_trigger_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_evolution_trigger_retrieve", - "method": "get", - "path": "/api/v2/evolution-trigger/{id}/", - "operationId": "api_v2_evolution_trigger_retrieve", - "summary": "Get evolution trigger", - "description": "Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.", - "security": { - "elementId": "operation-api_v2_evolution_trigger_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_evolution_trigger_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_evolution_trigger_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Games", - "slug": "endpoint/games", - "tags": [ - { - "name": "games", - "operations": [ - { - "elementId": "operation-api_v2_generation_list", - "method": "get", - "path": "/api/v2/generation/", - "operationId": "api_v2_generation_list", - "summary": "List genrations", - "description": "A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.", - "security": { - "elementId": "operation-api_v2_generation_list_security", - "properties": [ - { - "elementId": "operation-api_v2_generation_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_generation_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_generation_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_generation_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_generation_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_generation_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_generation_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_generation_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_generation_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_generation_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_generation_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_generation_retrieve", - "method": "get", - "path": "/api/v2/generation/{id}/", - "operationId": "api_v2_generation_retrieve", - "summary": "Get genration", - "description": "A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.", - "security": { - "elementId": "operation-api_v2_generation_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_generation_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_generation_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_generation_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_generation_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_abilities", - "name": "abilities" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_main_region", - "name": "main_region" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_types", - "name": "types" - }, - { - "elementId": "operation-api_v2_generation_retrieve_responses_200_application-json_version_groups", - "name": "version_groups" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokedex_list", - "method": "get", - "path": "/api/v2/pokedex/", - "operationId": "api_v2_pokedex_list", - "summary": "List pokedex", - "description": "A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokedex_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokedex_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokedex_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokedex_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokedex_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokedex_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokedex_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokedex_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokedex_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokedex_retrieve", - "method": "get", - "path": "/api/v2/pokedex/{id}/", - "operationId": "api_v2_pokedex_retrieve", - "summary": "Get pokedex", - "description": "A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokedex_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokedex_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_is_main_series", - "name": "is_main_series" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries", - "name": "pokemon_entries" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_region", - "name": "region" - }, - { - "elementId": "operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups", - "name": "version_groups" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_version_list", - "method": "get", - "path": "/api/v2/version/", - "operationId": "api_v2_version_list", - "summary": "List versions", - "description": "Versions of the games, e.g., Red, Blue or Yellow.", - "security": { - "elementId": "operation-api_v2_version_list_security", - "properties": [ - { - "elementId": "operation-api_v2_version_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_version_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_version_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_version_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_version_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_version_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_version_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_version_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_version_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_version_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_version_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_version_retrieve", - "method": "get", - "path": "/api/v2/version/{id}/", - "operationId": "api_v2_version_retrieve", - "summary": "Get version", - "description": "Versions of the games, e.g., Red, Blue or Yellow.", - "security": { - "elementId": "operation-api_v2_version_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_version_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_version_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_version_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_version_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_version_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_version_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_version_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_version_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_version_retrieve_responses_200_application-json_version_group", - "name": "version_group" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_version_group_list", - "method": "get", - "path": "/api/v2/version-group/", - "operationId": "api_v2_version_group_list", - "summary": "List version groups", - "description": "Version groups categorize highly similar versions of the games.", - "security": { - "elementId": "operation-api_v2_version_group_list_security", - "properties": [ - { - "elementId": "operation-api_v2_version_group_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_version_group_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_version_group_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_version_group_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_version_group_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_version_group_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_version_group_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_version_group_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_version_group_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_version_group_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_version_group_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_version_group_retrieve", - "method": "get", - "path": "/api/v2/version-group/{id}/", - "operationId": "api_v2_version_group_retrieve", - "summary": "Get version group", - "description": "Version groups categorize highly similar versions of the games.", - "security": { - "elementId": "operation-api_v2_version_group_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_version_group_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_version_group_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_version_group_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_generation", - "name": "generation" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods", - "name": "move_learn_methods" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_order", - "name": "order" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes", - "name": "pokedexes" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_regions", - "name": "regions" - }, - { - "elementId": "operation-api_v2_version_group_retrieve_responses_200_application-json_versions", - "name": "versions" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Items", - "slug": "endpoint/items", - "tags": [ - { - "name": "items", - "operations": [ - { - "elementId": "operation-api_v2_item_list", - "method": "get", - "path": "/api/v2/item/", - "operationId": "api_v2_item_list", - "summary": "List items", - "description": "An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.", - "security": { - "elementId": "operation-api_v2_item_list_security", - "properties": [ - { - "elementId": "operation-api_v2_item_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_item_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_item_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_item_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_item_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_item_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_retrieve", - "method": "get", - "path": "/api/v2/item/{id}/", - "operationId": "api_v2_item_retrieve", - "summary": "Get item", - "description": "An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.", - "security": { - "elementId": "operation-api_v2_item_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_item_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_attributes", - "name": "attributes" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_baby_trigger_for", - "name": "baby_trigger_for" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_category", - "name": "category" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_cost", - "name": "cost" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_effect_entries", - "name": "effect_entries" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_fling_effect", - "name": "fling_effect" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_fling_power", - "name": "fling_power" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_game_indices", - "name": "game_indices" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_held_by_pokemon", - "name": "held_by_pokemon" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_machines", - "name": "machines" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_item_retrieve_responses_200_application-json_sprites", - "name": "sprites" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_category_list", - "method": "get", - "path": "/api/v2/item-category/", - "operationId": "api_v2_item_category_list", - "summary": "List item categories", - "description": "Item categories determine where items will be placed in the players bag.", - "security": { - "elementId": "operation-api_v2_item_category_list_security", - "properties": [ - { - "elementId": "operation-api_v2_item_category_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_category_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_category_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_category_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_item_category_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_item_category_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_category_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_category_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_item_category_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_item_category_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_item_category_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_category_retrieve", - "method": "get", - "path": "/api/v2/item-category/{id}/", - "operationId": "api_v2_item_category_retrieve", - "summary": "Get item category", - "description": "Item categories determine where items will be placed in the players bag.", - "security": { - "elementId": "operation-api_v2_item_category_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_item_category_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_category_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_category_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_category_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json_items", - "name": "items" - }, - { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_item_category_retrieve_responses_200_application-json_pocket", - "name": "pocket" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_attribute_list", - "method": "get", - "path": "/api/v2/item-attribute/", - "operationId": "api_v2_item_attribute_list", - "summary": "List item attributes", - "description": "Item attributes define particular aspects of items, e.g.\"usable in battle\" or \"consumable\".", - "security": { - "elementId": "operation-api_v2_item_attribute_list_security", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_attribute_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_attribute_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_item_attribute_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_item_attribute_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_attribute_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_item_attribute_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_item_attribute_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_item_attribute_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve", - "method": "get", - "path": "/api/v2/item-attribute/{id}/", - "operationId": "api_v2_item_attribute_retrieve", - "summary": "Get item attribute", - "description": "Item attributes define particular aspects of items, e.g.\"usable in battle\" or \"consumable\".", - "security": { - "elementId": "operation-api_v2_item_attribute_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_attribute_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json_items", - "name": "items" - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_item_attribute_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_fling_effect_list", - "method": "get", - "path": "/api/v2/item-fling-effect/", - "operationId": "api_v2_item_fling_effect_list", - "summary": "List item fling effects", - "description": "The various effects of the move\"Fling\" when used with different items.", - "security": { - "elementId": "operation-api_v2_item_fling_effect_list_security", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_fling_effect_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_fling_effect_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_item_fling_effect_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_fling_effect_retrieve", - "method": "get", - "path": "/api/v2/item-fling-effect/{id}/", - "operationId": "api_v2_item_fling_effect_retrieve", - "summary": "Get item fling effect", - "description": "The various effects of the move\"Fling\" when used with different items.", - "security": { - "elementId": "operation-api_v2_item_fling_effect_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_fling_effect_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_fling_effect_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries", - "name": "effect_entries" - }, - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items", - "name": "items" - }, - { - "elementId": "operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_name", - "name": "name" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_pocket_list", - "method": "get", - "path": "/api/v2/item-pocket/", - "operationId": "api_v2_item_pocket_list", - "summary": "List item pockets", - "description": "Pockets within the players bag used for storing items by category.", - "security": { - "elementId": "operation-api_v2_item_pocket_list_security", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_pocket_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_pocket_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_item_pocket_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_item_pocket_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_pocket_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_item_pocket_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_item_pocket_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_item_pocket_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_item_pocket_retrieve", - "method": "get", - "path": "/api/v2/item-pocket/{id}/", - "operationId": "api_v2_item_pocket_retrieve", - "summary": "Get item pocket", - "description": "Pockets within the players bag used for storing items by category.", - "security": { - "elementId": "operation-api_v2_item_pocket_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_item_pocket_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_item_pocket_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_item_pocket_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories", - "name": "categories" - }, - { - "elementId": "operation-api_v2_item_pocket_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_item_pocket_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_item_pocket_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Location", - "slug": "endpoint/location", - "tags": [ - { - "name": "location", - "operations": [ - { - "elementId": "operation-api_v2_location_list", - "method": "get", - "path": "/api/v2/location/", - "operationId": "api_v2_location_list", - "summary": "List locations", - "description": "Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.", - "security": { - "elementId": "operation-api_v2_location_list_security", - "properties": [ - { - "elementId": "operation-api_v2_location_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_location_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_location_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_location_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_location_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_location_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_location_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_location_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_location_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_location_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_location_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_location_retrieve", - "method": "get", - "path": "/api/v2/location/{id}/", - "operationId": "api_v2_location_retrieve", - "summary": "Get location", - "description": "Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.", - "security": { - "elementId": "operation-api_v2_location_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_location_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_location_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_location_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_location_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_areas", - "name": "areas" - }, - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_game_indices", - "name": "game_indices" - }, - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_location_retrieve_responses_200_application-json_region", - "name": "region" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_location_area_list", - "method": "get", - "path": "/api/v2/location-area/", - "operationId": "api_v2_location_area_list", - "summary": "List location areas", - "description": "Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.", - "security": { - "elementId": "operation-api_v2_location_area_list_security", - "properties": [ - { - "elementId": "operation-api_v2_location_area_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_location_area_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_location_area_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_location_area_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_location_area_list_parameters_offset", - "name": "offset" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_location_area_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_location_area_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_location_area_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_location_area_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_location_area_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_location_area_retrieve", - "method": "get", - "path": "/api/v2/location-area/{id}/", - "operationId": "api_v2_location_area_retrieve", - "summary": "Get location area", - "description": "Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.", - "security": { - "elementId": "operation-api_v2_location_area_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_location_area_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_location_area_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_location_area_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates", - "name": "encounter_method_rates" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_game_index", - "name": "game_index" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_location", - "name": "location" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters", - "name": "pokemon_encounters" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pal_park_area_list", - "method": "get", - "path": "/api/v2/pal-park-area/", - "operationId": "api_v2_pal_park_area_list", - "summary": "List pal park areas", - "description": "Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.", - "security": { - "elementId": "operation-api_v2_pal_park_area_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pal_park_area_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pal_park_area_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pal_park_area_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pal_park_area_retrieve", - "method": "get", - "path": "/api/v2/pal-park-area/{id}/", - "operationId": "api_v2_pal_park_area_retrieve", - "summary": "Get pal park area", - "description": "Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.", - "security": { - "elementId": "operation-api_v2_pal_park_area_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pal_park_area_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pal_park_area_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pal_park_area_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pal_park_area_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pal_park_area_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters", - "name": "pokemon_encounters" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_region_list", - "method": "get", - "path": "/api/v2/region/", - "operationId": "api_v2_region_list", - "summary": "List regions", - "description": "A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.", - "security": { - "elementId": "operation-api_v2_region_list_security", - "properties": [ - { - "elementId": "operation-api_v2_region_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_region_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_region_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_region_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_region_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_region_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_region_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_region_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_region_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_region_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_region_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_region_retrieve", - "method": "get", - "path": "/api/v2/region/{id}/", - "operationId": "api_v2_region_retrieve", - "summary": "Get region", - "description": "A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.", - "security": { - "elementId": "operation-api_v2_region_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_region_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_region_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_region_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_region_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_locations", - "name": "locations" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_main_generation", - "name": "main_generation" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_pokedexes", - "name": "pokedexes" - }, - { - "elementId": "operation-api_v2_region_retrieve_responses_200_application-json_version_groups", - "name": "version_groups" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Machines", - "slug": "endpoint/machines", - "tags": [ - { - "name": "machines", - "operations": [ - { - "elementId": "operation-api_v2_machine_list", - "method": "get", - "path": "/api/v2/machine/", - "operationId": "api_v2_machine_list", - "summary": "List machines", - "description": "Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine.", - "security": { - "elementId": "operation-api_v2_machine_list_security", - "properties": [ - { - "elementId": "operation-api_v2_machine_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_machine_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_machine_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_machine_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_machine_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_machine_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_machine_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_machine_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_machine_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_machine_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_machine_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_machine_retrieve", - "method": "get", - "path": "/api/v2/machine/{id}/", - "operationId": "api_v2_machine_retrieve", - "summary": "Get machine", - "description": "Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine.", - "security": { - "elementId": "operation-api_v2_machine_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_machine_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_machine_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_machine_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_machine_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_machine_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_machine_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_machine_retrieve_responses_200_application-json_item", - "name": "item" - }, - { - "elementId": "operation-api_v2_machine_retrieve_responses_200_application-json_move", - "name": "move" - }, - { - "elementId": "operation-api_v2_machine_retrieve_responses_200_application-json_version_group", - "name": "version_group" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Moves", - "slug": "endpoint/moves", - "tags": [ - { - "name": "moves", - "operations": [ - { - "elementId": "operation-api_v2_move_list", - "method": "get", - "path": "/api/v2/move/", - "operationId": "api_v2_move_list", - "summary": "List moves", - "description": "Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas.", - "security": { - "elementId": "operation-api_v2_move_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_retrieve", - "method": "get", - "path": "/api/v2/move/{id}/", - "operationId": "api_v2_move_retrieve", - "summary": "Get move", - "description": "Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas.", - "security": { - "elementId": "operation-api_v2_move_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_accuracy", - "name": "accuracy" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_contest_combos", - "name": "contest_combos" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_contest_effect", - "name": "contest_effect" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_contest_type", - "name": "contest_type" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_damage_class", - "name": "damage_class" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_effect_chance", - "name": "effect_chance" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_effect_changes", - "name": "effect_changes" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_effect_entries", - "name": "effect_entries" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_generation", - "name": "generation" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_learned_by_pokemon", - "name": "learned_by_pokemon" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_machines", - "name": "machines" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_meta", - "name": "meta" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_past_values", - "name": "past_values" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_power", - "name": "power" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_pp", - "name": "pp" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_priority", - "name": "priority" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_stat_changes", - "name": "stat_changes" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect", - "name": "super_contest_effect" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_target", - "name": "target" - }, - { - "elementId": "operation-api_v2_move_retrieve_responses_200_application-json_type", - "name": "type" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_ailment_list", - "method": "get", - "path": "/api/v2/move-ailment/", - "operationId": "api_v2_move_ailment_list", - "summary": "List move meta ailments", - "description": "Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail.", - "security": { - "elementId": "operation-api_v2_move_ailment_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_ailment_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_ailment_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_ailment_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_ailment_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_ailment_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_ailment_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_ailment_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_ailment_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_ailment_retrieve", - "method": "get", - "path": "/api/v2/move-ailment/{id}/", - "operationId": "api_v2_move_ailment_retrieve", - "summary": "Get move meta ailment", - "description": "Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail.", - "security": { - "elementId": "operation-api_v2_move_ailment_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_ailment_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_ailment_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_ailment_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_ailment_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_move_ailment_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_ailment_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_battle_style_list", - "method": "get", - "path": "/api/v2/move-battle-style/", - "operationId": "api_v2_move_battle_style_list", - "summary": "List move battle styles", - "description": "Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail.", - "security": { - "elementId": "operation-api_v2_move_battle_style_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_battle_style_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_battle_style_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_battle_style_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_battle_style_retrieve", - "method": "get", - "path": "/api/v2/move-battle-style/{id}/", - "operationId": "api_v2_move_battle_style_retrieve", - "summary": "Get move battle style", - "description": "Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail.", - "security": { - "elementId": "operation-api_v2_move_battle_style_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_battle_style_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_battle_style_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_battle_style_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_battle_style_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_battle_style_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_category_list", - "method": "get", - "path": "/api/v2/move-category/", - "operationId": "api_v2_move_category_list", - "summary": "List move meta categories", - "description": "Very general categories that loosely group move effects.", - "security": { - "elementId": "operation-api_v2_move_category_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_category_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_category_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_category_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_category_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_category_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_category_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_category_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_category_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_category_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_category_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_category_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_category_retrieve", - "method": "get", - "path": "/api/v2/move-category/{id}/", - "operationId": "api_v2_move_category_retrieve", - "summary": "Get move meta category", - "description": "Very general categories that loosely group move effects.", - "security": { - "elementId": "operation-api_v2_move_category_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_category_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_category_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_category_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_category_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_category_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_move_category_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_category_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_move_category_retrieve_responses_200_application-json_name", - "name": "name" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_learn_method_list", - "method": "get", - "path": "/api/v2/move-learn-method/", - "operationId": "api_v2_move_learn_method_list", - "summary": "List move learn methods", - "description": "Methods by which Pokémon can learn moves.", - "security": { - "elementId": "operation-api_v2_move_learn_method_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_learn_method_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_learn_method_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_learn_method_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve", - "method": "get", - "path": "/api/v2/move-learn-method/{id}/", - "operationId": "api_v2_move_learn_method_retrieve", - "summary": "Get move learn method", - "description": "Methods by which Pokémon can learn moves.", - "security": { - "elementId": "operation-api_v2_move_learn_method_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_learn_method_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups", - "name": "version_groups" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_target_list", - "method": "get", - "path": "/api/v2/move-target/", - "operationId": "api_v2_move_target_list", - "summary": "List move targets", - "description": "Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.", - "security": { - "elementId": "operation-api_v2_move_target_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_target_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_target_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_target_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_target_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_target_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_target_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_target_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_target_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_target_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_target_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_target_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_target_retrieve", - "method": "get", - "path": "/api/v2/move-target/{id}/", - "operationId": "api_v2_move_target_retrieve", - "summary": "Get move target", - "description": "Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves.", - "security": { - "elementId": "operation-api_v2_move_target_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_target_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_target_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_target_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_target_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_target_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Pokemon", - "slug": "endpoint/pokemon", - "tags": [ - { - "name": "pokemon", - "operations": [ - { - "elementId": "operation-api_v2_ability_list", - "method": "get", - "path": "/api/v2/ability/", - "operationId": "api_v2_ability_list", - "summary": "Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail.", - "description": "", - "security": { - "elementId": "operation-api_v2_ability_list_security", - "properties": [ - { - "elementId": "operation-api_v2_ability_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_ability_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_ability_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_ability_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_ability_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_ability_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_ability_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_ability_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_ability_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_ability_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_ability_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_ability_retrieve", - "method": "get", - "path": "/api/v2/ability/{id}/", - "operationId": "api_v2_ability_retrieve", - "summary": "Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail.", - "description": "", - "security": { - "elementId": "operation-api_v2_ability_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_ability_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_ability_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_ability_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_ability_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes", - "name": "effect_changes" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries", - "name": "effect_entries" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_generation", - "name": "generation" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_is_main_series", - "name": "is_main_series" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_ability_retrieve_responses_200_application-json_pokemon", - "name": "pokemon" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_characteristic_list", - "method": "get", - "path": "/api/v2/characteristic/", - "operationId": "api_v2_characteristic_list", - "summary": "List charecterictics", - "description": "Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail.", - "security": { - "elementId": "operation-api_v2_characteristic_list_security", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_characteristic_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_characteristic_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_characteristic_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_characteristic_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_characteristic_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_characteristic_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_characteristic_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_characteristic_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_characteristic_retrieve", - "method": "get", - "path": "/api/v2/characteristic/{id}/", - "operationId": "api_v2_characteristic_retrieve", - "summary": "Get characteristic", - "description": "Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail.", - "security": { - "elementId": "operation-api_v2_characteristic_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_characteristic_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_characteristic_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json_gene_modulo", - "name": "gene_modulo" - }, - { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat", - "name": "highest_stat" - }, - { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_characteristic_retrieve_responses_200_application-json_possible_values", - "name": "possible_values" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_egg_group_list", - "method": "get", - "path": "/api/v2/egg-group/", - "operationId": "api_v2_egg_group_list", - "summary": "List egg groups", - "description": "Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail.", - "security": { - "elementId": "operation-api_v2_egg_group_list_security", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_egg_group_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_egg_group_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_egg_group_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_egg_group_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_egg_group_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_egg_group_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_egg_group_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_egg_group_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_egg_group_retrieve", - "method": "get", - "path": "/api/v2/egg-group/{id}/", - "operationId": "api_v2_egg_group_retrieve", - "summary": "Get egg group", - "description": "Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail.", - "security": { - "elementId": "operation-api_v2_egg_group_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_egg_group_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_egg_group_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_egg_group_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_egg_group_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_egg_group_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_egg_group_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_gender_list", - "method": "get", - "path": "/api/v2/gender/", - "operationId": "api_v2_gender_list", - "summary": "List genders", - "description": "Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail.", - "security": { - "elementId": "operation-api_v2_gender_list_security", - "properties": [ - { - "elementId": "operation-api_v2_gender_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_gender_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_gender_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_gender_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_gender_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_gender_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_gender_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_gender_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_gender_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_gender_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_gender_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_gender_retrieve", - "method": "get", - "path": "/api/v2/gender/{id}/", - "operationId": "api_v2_gender_retrieve", - "summary": "Get gender", - "description": "Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail.", - "security": { - "elementId": "operation-api_v2_gender_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_gender_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_gender_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_gender_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_gender_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_gender_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_gender_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_gender_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details", - "name": "pokemon_species_details" - }, - { - "elementId": "operation-api_v2_gender_retrieve_responses_200_application-json_required_for_evolution", - "name": "required_for_evolution" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_growth_rate_list", - "method": "get", - "path": "/api/v2/growth-rate/", - "operationId": "api_v2_growth_rate_list", - "summary": "List growth rates", - "description": "Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail.", - "security": { - "elementId": "operation-api_v2_growth_rate_list_security", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_growth_rate_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_growth_rate_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_growth_rate_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_growth_rate_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_growth_rate_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_growth_rate_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_growth_rate_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_growth_rate_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve", - "method": "get", - "path": "/api/v2/growth-rate/{id}/", - "operationId": "api_v2_growth_rate_retrieve", - "summary": "Get growth rate", - "description": "Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail.", - "security": { - "elementId": "operation-api_v2_growth_rate_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_growth_rate_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_formula", - "name": "formula" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels", - "name": "levels" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_damage_class_list", - "method": "get", - "path": "/api/v2/move-damage-class/", - "operationId": "api_v2_move_damage_class_list", - "summary": "List move damage classes", - "description": "Damage classes moves can have, e.g. physical, special, or non-damaging.", - "security": { - "elementId": "operation-api_v2_move_damage_class_list_security", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_damage_class_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_damage_class_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_move_damage_class_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve", - "method": "get", - "path": "/api/v2/move-damage-class/{id}/", - "operationId": "api_v2_move_damage_class_retrieve", - "summary": "Get move damage class", - "description": "Damage classes moves can have, e.g. physical, special, or non-damaging.", - "security": { - "elementId": "operation-api_v2_move_damage_class_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_move_damage_class_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions", - "name": "descriptions" - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_nature_list", - "method": "get", - "path": "/api/v2/nature/", - "operationId": "api_v2_nature_list", - "summary": "List natures", - "description": "Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail.", - "security": { - "elementId": "operation-api_v2_nature_list_security", - "properties": [ - { - "elementId": "operation-api_v2_nature_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_nature_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_nature_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_nature_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_nature_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_nature_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_nature_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_nature_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_nature_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_nature_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_nature_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_nature_retrieve", - "method": "get", - "path": "/api/v2/nature/{id}/", - "operationId": "api_v2_nature_retrieve", - "summary": "Get nature", - "description": "Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail.", - "security": { - "elementId": "operation-api_v2_nature_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_nature_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_nature_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_nature_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_nature_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_berries", - "name": "berries" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat", - "name": "decreased_stat" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor", - "name": "hates_flavor" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat", - "name": "increased_stat" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor", - "name": "likes_flavor" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences", - "name": "move_battle_style_preferences" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes", - "name": "pokeathlon_stat_changes" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_list", - "method": "get", - "path": "/api/v2/pokemon/", - "operationId": "api_v2_pokemon_list", - "summary": "List pokemon", - "description": "Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokemon_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_retrieve", - "method": "get", - "path": "/api/v2/pokemon/{id}/", - "operationId": "api_v2_pokemon_retrieve", - "summary": "Get pokemon", - "description": "Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokemon_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities", - "name": "abilities" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_base_experience", - "name": "base_experience" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_cries", - "name": "cries" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_forms", - "name": "forms" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices", - "name": "game_indices" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_height", - "name": "height" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items", - "name": "held_items" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_is_default", - "name": "is_default" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_location_area_encounters", - "name": "location_area_encounters" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_order", - "name": "order" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities", - "name": "past_abilities" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types", - "name": "past_types" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_species", - "name": "species" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_sprites", - "name": "sprites" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_stats", - "name": "stats" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_types", - "name": "types" - }, - { - "elementId": "operation-api_v2_pokemon_retrieve_responses_200_application-json_weight", - "name": "weight" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_color_list", - "method": "get", - "path": "/api/v2/pokemon-color/", - "operationId": "api_v2_pokemon_color_list", - "summary": "List pokemon colors", - "description": "Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown.", - "security": { - "elementId": "operation-api_v2_pokemon_color_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_color_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_color_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_color_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_color_retrieve", - "method": "get", - "path": "/api/v2/pokemon-color/{id}/", - "operationId": "api_v2_pokemon_color_retrieve", - "summary": "Get pokemon color", - "description": "Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown.", - "security": { - "elementId": "operation-api_v2_pokemon_color_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_color_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_color_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_color_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_color_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_color_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_form_list", - "method": "get", - "path": "/api/v2/pokemon-form/", - "operationId": "api_v2_pokemon_form_list", - "summary": "List pokemon forms", - "description": "Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety.", - "security": { - "elementId": "operation-api_v2_pokemon_form_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_form_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_form_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_form_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve", - "method": "get", - "path": "/api/v2/pokemon-form/{id}/", - "operationId": "api_v2_pokemon_form_retrieve", - "summary": "Get pokemon form", - "description": "Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety.", - "security": { - "elementId": "operation-api_v2_pokemon_form_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_form_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_name", - "name": "form_name" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names", - "name": "form_names" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_order", - "name": "form_order" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_battle_only", - "name": "is_battle_only" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_default", - "name": "is_default" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_mega", - "name": "is_mega" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_order", - "name": "order" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon", - "name": "pokemon" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_sprites", - "name": "sprites" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types", - "name": "types" - }, - { - "elementId": "operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group", - "name": "version_group" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list", - "method": "get", - "path": "/api/v2/pokemon-habitat/", - "operationId": "api_v2_pokemon_habitat_list", - "summary": "List pokemom habitas", - "description": "Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon.", - "security": { - "elementId": "operation-api_v2_pokemon_habitat_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_habitat_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_habitat_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve", - "method": "get", - "path": "/api/v2/pokemon-habitat/{id}/", - "operationId": "api_v2_pokemon_habitat_retrieve", - "summary": "Get pokemom habita", - "description": "Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon.", - "security": { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_shape_list", - "method": "get", - "path": "/api/v2/pokemon-shape/", - "operationId": "api_v2_pokemon_shape_list", - "summary": "List pokemon shapes", - "description": "Shapes used for sorting Pokémon in a Pokédex.", - "security": { - "elementId": "operation-api_v2_pokemon_shape_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_shape_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_shape_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_shape_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve", - "method": "get", - "path": "/api/v2/pokemon-shape/{id}/", - "operationId": "api_v2_pokemon_shape_retrieve", - "summary": "Get pokemon shape", - "description": "Shapes used for sorting Pokémon in a Pokédex.", - "security": { - "elementId": "operation-api_v2_pokemon_shape_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_shape_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names", - "name": "awesome_names" - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species", - "name": "pokemon_species" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_species_list", - "method": "get", - "path": "/api/v2/pokemon-species/", - "operationId": "api_v2_pokemon_species_list", - "summary": "List pokemon species", - "description": "A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant.", - "security": { - "elementId": "operation-api_v2_pokemon_species_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_species_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_species_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokemon_species_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve", - "method": "get", - "path": "/api/v2/pokemon-species/{id}/", - "operationId": "api_v2_pokemon_species_retrieve", - "summary": "Get pokemon species", - "description": "A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant.", - "security": { - "elementId": "operation-api_v2_pokemon_species_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokemon_species_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_base_happiness", - "name": "base_happiness" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_capture_rate", - "name": "capture_rate" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color", - "name": "color" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups", - "name": "egg_groups" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain", - "name": "evolution_chain" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species", - "name": "evolves_from_species" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries", - "name": "flavor_text_entries" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions", - "name": "form_descriptions" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_forms_switchable", - "name": "forms_switchable" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_gender_rate", - "name": "gender_rate" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera", - "name": "genera" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation", - "name": "generation" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate", - "name": "growth_rate" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat", - "name": "habitat" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_has_gender_differences", - "name": "has_gender_differences" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_hatch_counter", - "name": "hatch_counter" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_baby", - "name": "is_baby" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_legendary", - "name": "is_legendary" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_mythical", - "name": "is_mythical" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_order", - "name": "order" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters", - "name": "pal_park_encounters" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers", - "name": "pokedex_numbers" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape", - "name": "shape" - }, - { - "elementId": "operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties", - "name": "varieties" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list", - "method": "get", - "path": "/api/v2/pokeathlon-stat/", - "operationId": "api_v2_pokeathlon_stat_list", - "summary": "List pokeathlon stats", - "description": "Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokeathlon_stat_list_security", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokeathlon_stat_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokeathlon_stat_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve", - "method": "get", - "path": "/api/v2/pokeathlon-stat/{id}/", - "operationId": "api_v2_pokeathlon_stat_retrieve", - "summary": "Get pokeathlon stat", - "description": "Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail.", - "security": { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_affecting_natures", - "name": "affecting_natures" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_stat_list", - "method": "get", - "path": "/api/v2/stat/", - "operationId": "api_v2_stat_list", - "summary": "List stats", - "description": "Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles.", - "security": { - "elementId": "operation-api_v2_stat_list_security", - "properties": [ - { - "elementId": "operation-api_v2_stat_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_stat_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_stat_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_stat_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_stat_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_stat_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_stat_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_stat_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_stat_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_stat_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_stat_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_stat_retrieve", - "method": "get", - "path": "/api/v2/stat/{id}/", - "operationId": "api_v2_stat_retrieve", - "summary": "Get stat", - "description": "Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles.", - "security": { - "elementId": "operation-api_v2_stat_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_stat_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_stat_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_stat_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_stat_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_affecting_moves", - "name": "affecting_moves" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_affecting_natures", - "name": "affecting_natures" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_characteristics", - "name": "characteristics" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_game_index", - "name": "game_index" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_is_battle_only", - "name": "is_battle_only" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class", - "name": "move_damage_class" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_stat_retrieve_responses_200_application-json_names", - "name": "names" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_type_list", - "method": "get", - "path": "/api/v2/type/", - "operationId": "api_v2_type_list", - "summary": "List types", - "description": "Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against.", - "security": { - "elementId": "operation-api_v2_type_list_security", - "properties": [ - { - "elementId": "operation-api_v2_type_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_type_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_type_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_type_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_type_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_type_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_type_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_type_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_type_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_type_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_type_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_type_retrieve", - "method": "get", - "path": "/api/v2/type/{id}/", - "operationId": "api_v2_type_retrieve", - "summary": "Get types", - "description": "Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against.", - "security": { - "elementId": "operation-api_v2_type_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_type_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_type_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_type_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_type_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_damage_relations", - "name": "damage_relations" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_game_indices", - "name": "game_indices" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_generation", - "name": "generation" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class", - "name": "move_damage_class" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_moves", - "name": "moves" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations", - "name": "past_damage_relations" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_pokemon", - "name": "pokemon" - }, - { - "elementId": "operation-api_v2_type_retrieve_responses_200_application-json_sprites", - "name": "sprites" - } - ] - } - } - } - ] - } - ] - }, - { - "sidebarLabel": "Utility", - "slug": "endpoint/utility", - "tags": [ - { - "name": "utility", - "operations": [ - { - "elementId": "operation-api_v2_language_list", - "method": "get", - "path": "/api/v2/language/", - "operationId": "api_v2_language_list", - "summary": "List languages", - "description": "Languages for translations of API resource information.", - "security": { - "elementId": "operation-api_v2_language_list_security", - "properties": [ - { - "elementId": "operation-api_v2_language_list_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_language_list_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_language_list_parameters", - "properties": [ - { - "elementId": "operation-api_v2_language_list_parameters_limit", - "name": "limit" - }, - { - "elementId": "operation-api_v2_language_list_parameters_offset", - "name": "offset" - }, - { - "elementId": "operation-api_v2_language_list_parameters_q", - "name": "q" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_language_list_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_language_list_responses_200_application-json_count", - "name": "count" - }, - { - "elementId": "operation-api_v2_language_list_responses_200_application-json_next", - "name": "next" - }, - { - "elementId": "operation-api_v2_language_list_responses_200_application-json_previous", - "name": "previous" - }, - { - "elementId": "operation-api_v2_language_list_responses_200_application-json_results", - "name": "results" - } - ] - } - } - }, - { - "elementId": "operation-api_v2_language_retrieve", - "method": "get", - "path": "/api/v2/language/{id}/", - "operationId": "api_v2_language_retrieve", - "summary": "Get language", - "description": "Languages for translations of API resource information.", - "security": { - "elementId": "operation-api_v2_language_retrieve_security", - "properties": [ - { - "elementId": "operation-api_v2_language_retrieve_security_cookieauth", - "name": "cookieAuth" - }, - { - "elementId": "operation-api_v2_language_retrieve_security_basicauth", - "name": "basicAuth" - } - ] - }, - "parameters": { - "elementId": "operation-api_v2_language_retrieve_parameters", - "properties": [ - { - "elementId": "operation-api_v2_language_retrieve_parameters_id", - "name": "id" - } - ] - }, - "responses": { - "200-application/json": { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json", - "properties": [ - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_id", - "name": "id" - }, - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_iso3166", - "name": "iso3166" - }, - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_iso639", - "name": "iso639" - }, - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_name", - "name": "name" - }, - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_names", - "name": "names" - }, - { - "elementId": "operation-api_v2_language_retrieve_responses_200_application-json_official", - "name": "official" - } - ] - } - } - } - ] - } - ] - } -] \ No newline at end of file diff --git a/examples/custom/src/app/speakeasy.css b/examples/custom/src/app/speakeasy.css deleted file mode 100644 index 69d570f74..000000000 --- a/examples/custom/src/app/speakeasy.css +++ /dev/null @@ -1,73 +0,0 @@ -:root { - --mistral-warning-color: rgb(240, 73, 0); - --mistral-error-color: rgb(170, 33, 47); - --mistral-info-color: rgb(78, 84, 91); - --mistral-success-color: rgb(52, 152, 219); - --mistral-primary-color: rgb(227, 152, 106); - --mistral-secondary-color: rgb(217, 217, 217); - - /* Generic variables */ - --speakeasy-border-color: rgb(185 194 198); - --speakeasy-border-width: 1px; - --speakeasy-border-radius-sm: 0.2rem; - --speakeasy-border-radius-md: 0.5rem; - --speakeasy-border-radius-lg: 1rem; - --speakeasy-font-mono: "Geist", "ui-sans-serif", "system-ui", "sans-serif", "apple color emoji", "segoe ui emoji", "segoe ui symbol", "noto color emoji"; - --speakeasy-anchor-color: white; - - /* Expandable specific variables */ - --speakeasy-expandable-button-radius: var(--speakeasy-border-radius-sm); - --speakeasy-expandable-line-color: color-mix(in oklab, var(--speakeasy-border-color), black 25%); - --speakeasy-expandable-line-color-active: color-mix(in oklab, var(--speakeasy-border-color), black 50%); - --speakeasy-expandable-cell-size: 1rem; - --speakeasy-expandable-cell-height-multiplier: 1.3; - --speakeasy-expandable-treetoper-diameter: 8px; - - /* Pill specific variables */ - --speakeasy-pill-border-radius: var(--speakeasy-border-radius-sm); - --speakeasy-pill-padding: 2px 4px; - --speakeasy-pill-font-family: var(--speakeasy-font-mono); - --speakeasy-pill-font-size: 80%; - --speakeasy-pill-warning-background-color: color-mix(in oklab, var(--mistral-warning-color) 5%, transparent); - --speakeasy-pill-warning-color: color-mix(in oklab, var(--mistral-warning-color) 80%, transparent); - --speakeasy-pill-warning-border-color: var(--speakeasy-pill-warning-color); - --speakeasy-pill-error-background-color: color-mix(in oklab, var(--mistral-error-color) 5%, transparent); - --speakeasy-pill-error-color: color-mix(in oklab, var(--mistral-error-color) 80%, transparent); - --speakeasy-pill-error-border-color: var(--speakeasy-pill-error-color); - --speakeasy-pill-info-background-color: color-mix(in oklab, var(--mistral-info-color) 5%, transparent); - --speakeasy-pill-info-color: color-mix(in oklab, var(--mistral-info-color) 80%, transparent); - --speakeasy-pill-info-border-color: var(--speakeasy-pill-info-color); - --speakeasy-pill-success-background-color: color-mix(in oklab, var(--mistral-success-color) 5%, transparent); - --speakeasy-pill-success-color: color-mix(in oklab, var(--mistral-success-color) 80%, transparent); - --speakeasy-pill-success-border-color: var(--speakeasy-pill-success-color); - --speakeasy-pill-primary-background-color: color-mix(in oklab, var(--mistral-primary-color) 5%, transparent); - --speakeasy-pill-primary-color: color-mix(in oklab, var(--mistral-primary-color) 80%, transparent); - --speakeasy-pill-primary-border-color: var(--speakeasy-pill-primary-color); - --speakeasy-pill-secondary-background-color: color-mix(in oklab, var(--mistral-secondary-color) 5%, transparent); - --speakeasy-pill-secondary-color: color-mix(in oklab, var(--mistral-secondary-color) 80%, transparent); - --speakeasy-pill-secondary-border-color: var(--speakeasy-pill-secondary-color); - - /* Tab specific variables */ - --speakeasy-tab-button-border-radius: var(--speakeasy-border-radius-md); - - --speakeasy-tab-button-color-inactive: white; - --speakeasy-tab-button-color-inactive-hover: white; - --speakeasy-tab-button-background-inactive: color-mix(in oklab, var(--mistral-secondary-color) 40%, transparent); - --speakeasy-tab-button-background-inactive-hover: color-mix(in oklab, var(--mistral-secondary-color) 50%, transparent); - --speakeasy-tab-button-border-inactive: none; - --speakeasy-tab-button-border-inactive-hover: none; - - --speakeasy-tab-button-color-active: white; - --speakeasy-tab-button-color-active-hover: white; - --speakeasy-tab-button-background-active: color-mix(in oklab, var(--mistral-primary-color) 85%, transparent); - --speakeasy-tab-button-background-active-hover: color-mix(in oklab, var(--mistral-primary-color) 100%, transparent); - --speakeasy-tab-button-border-active: none; - --speakeasy-tab-button-border-active-hover: none; - - /* Property specific variables */ - --speakeasy-property-type-font-size: var(--speakeasy-pill-font-size); - --speakeasy-property-type-color: white; - --speakeasy-property-type-background-color: color-mix(in oklab, var(--mistral-secondary-color) 10%, transparent); - --speakeasy-property-type-border-radius: var(--speakeasy-border-radius-sm); - --speakeasy-property-type-border-color: color-mix(in oklab, var(--mistral-secondary-color) 50%, transparent); -}; diff --git a/examples/custom/src/components/Sidebar.tsx b/examples/custom/src/components/Sidebar.tsx deleted file mode 100644 index b863445d2..000000000 --- a/examples/custom/src/components/Sidebar.tsx +++ /dev/null @@ -1,148 +0,0 @@ -"use client"; - -import Link from "next/link"; -import { useMemo, useState } from "react"; -import styles from "./styles.module.css"; -import { ExpandableCellIcon } from "@speakeasy-api/docs-md-react"; -import path from "path"; - -type SidebarMetadataItem = { - slug: string; - sidebarLabel: string; - tags: { - operations: { - method: string; - path: string; - elementId: string; - }[]; - }[]; -}; - -type SideBarTreeNode = { - label: string; - href?: string; - children: Record; -}; - -function useSidebarMetadata( - sidebarMetadata: SidebarMetadataItem[], - pathPrefix = "" -) { - return useMemo(() => { - const sidebarTreeData: Record = {}; - - for (const item of sidebarMetadata) { - const slugParts = item.slug.split("/"); - const lastSlugPart = slugParts[slugParts.length - 1]; - const parentSlugParts = slugParts.slice(0, slugParts.length - 1); - - // Create the parent nodes, if needed - let currentNode = sidebarTreeData; - for (const parentSlugPart of parentSlugParts) { - if (!currentNode[parentSlugPart]) { - currentNode[parentSlugPart] = { - label: - parentSlugPart.slice(0, 1).toUpperCase() + - parentSlugPart.slice(1), - children: {}, - }; - } - currentNode = currentNode[parentSlugPart].children; - } - - const node: SideBarTreeNode = { - label: item.sidebarLabel, - href: `/${pathPrefix !== "" ? `${pathPrefix}/` : ""}api/${item.slug}`, - children: {}, - }; - - currentNode[lastSlugPart] = node; - - for (const tag of item.tags) { - for (const operation of tag.operations) { - const displayName = `${operation.method.toUpperCase()} ${operation.path}`; - node.children[displayName] = { - label: displayName, - href: `/${pathPrefix !== "" ? `${pathPrefix}/` : ""}api/${item.slug}#${operation.elementId}`, - children: {}, - }; - } - } - } - return sidebarTreeData; - }, [sidebarMetadata, pathPrefix]); -} - -function ListEntry({ - value, - level, -}: { - value: SideBarTreeNode; - level: number; -}) { - const [isOpen, setIsOpen] = useState(level === 0); - const hasChildren = Object.keys(value.children).length > 0; - return ( -
  • -
    -
    - {value.href ? ( - {value.label} - ) : ( - value.label - )} -
    - {hasChildren && ( - - )} -
    - {hasChildren && isOpen && ( - - )} -
    • - ); -} - -function List({ - items, - level = 0, -}: { - items: Record; - level?: number; -}) { - return ( -
      - {Object.entries(items).map(([key, value]) => ( - - ))} -
    - ); -} - -export function Sidebar({ - sidebarMetadata, - pathPrefix, -}: { - sidebarMetadata: SidebarMetadataItem[]; - pathPrefix?: string; -}) { - const sidebarTreeData = useSidebarMetadata(sidebarMetadata, pathPrefix); - return ( -
    - -
    - ); -} diff --git a/examples/custom/src/components/mdx.tsx b/examples/custom/src/components/mdx.tsx deleted file mode 100644 index ec7d530ae..000000000 --- a/examples/custom/src/components/mdx.tsx +++ /dev/null @@ -1,59 +0,0 @@ -"use client"; - -import { ComponentProps } from "react"; -import styles from "./styles.module.css"; - -type HeadingProps = ComponentProps<"h1"> & { - id?: string; -}; - -// Inline Link icon SVG component -const LinkIcon = ({ size = 16 }: { size?: number }) => ( - - - - -); - -export const HeadingWrapper = ({ - children, - id, - className, - tag: Tag = "h1", -}: HeadingProps & { tag?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" }) => { - const copyToClipboard = () => { - if (id) { - const url = `${window.location.origin}${window.location.pathname}#${id}`; - navigator.clipboard.writeText(url); - // Also set the fragment in the current URL - window.location.hash = id; - } - }; - - return ( -
    - - {children} - {id && ( - - )} - -
    - ); -}; diff --git a/examples/custom/src/components/speakeasy-custom/Operation.tsx b/examples/custom/src/components/speakeasy-custom/Operation.tsx deleted file mode 100644 index 47a9584eb..000000000 --- a/examples/custom/src/components/speakeasy-custom/Operation.tsx +++ /dev/null @@ -1,66 +0,0 @@ -import { - OperationProps, - useChildren, - useUniqueChild, -} from "@speakeasy-api/docs-md-react"; - -export function Operation({ children }: OperationProps) { - const titleChild = useUniqueChild(children, "title"); - const summaryChildren = useChildren(children, "summary"); - const descriptionChildren = useChildren(children, "description"); - const codeSamplesChildren = useChildren(children, "code-samples"); - const securityChildren = useChildren(children, "security"); - const parametersChildren = useChildren(children, "parameters"); - const requestBodyExamplesChildren = useChildren( - children, - "request-body-examples" - ); - const requestBodyChildren = useChildren(children, "request-body"); - const responseBodyExamplesChildren = useChildren( - children, - "response-body-examples" - ); - const responseBodyChildren = useChildren(children, "response-body"); - return ( - <> -
    - {titleChild} -
    - {summaryChildren} - {descriptionChildren} -
    -
    - {securityChildren} - {parametersChildren} - {requestBodyChildren} -
    -
    - {responseBodyChildren} -
    -
    - - ); -} diff --git a/examples/custom/src/components/speakeasy-custom/index.tsx b/examples/custom/src/components/speakeasy-custom/index.tsx deleted file mode 100644 index a966944fc..000000000 --- a/examples/custom/src/components/speakeasy-custom/index.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export * from "@speakeasy-api/docs-md-react"; - -export { Operation } from "./Operation"; diff --git a/examples/custom/src/components/styles.module.css b/examples/custom/src/components/styles.module.css deleted file mode 100644 index fe239f65a..000000000 --- a/examples/custom/src/components/styles.module.css +++ /dev/null @@ -1,58 +0,0 @@ -.headingContainer { - display: inline; -} - -.copyLinkButton { - margin-left: 0.5rem; - padding: 0.25rem; - background: transparent; - border: none; - cursor: pointer; - opacity: 0; - transition: opacity 0.2s ease; - color: #6b7280; - border-radius: 0.25rem; -} - -.copyLinkButton:hover { - color: #374151; -} - -/* Show copy button on heading container hover */ -.headingContainer:hover .copyLinkButton { - opacity: 1; -} - -.list { - list-style-type: none; -} - -.listEntry { - padding: 0.5rem; - border: 1px solid transparent; - display: flex; - flex-direction: row; -} - -.listEntryLabel { - flex-grow: 1; -} - -.listEntryButton { - padding-inline: 0.5rem; - background: none; - border: none; - color: white -} - -.listEntry:hover { - border: 1px solid #444; - border-radius: var(--speakeasy-border-radius-sm); -} - -.expandableChevron { - transition: transform 0.2s ease-in-out; - transform-origin: center; - color: var(--speakeasy-expandable-line-color); - height: 1rem; -} diff --git a/examples/custom/src/mdx-components.module.css b/examples/custom/src/mdx-components.module.css deleted file mode 100644 index 6f9273ca9..000000000 --- a/examples/custom/src/mdx-components.module.css +++ /dev/null @@ -1,47 +0,0 @@ -/* Common styles for all headings */ -.h1, .h2, .h3, .h4, .h5, .h6 { - font-weight: 400; -} - -.h1 { - margin-top: 0.5rem; - font-size: 2.25rem; - line-height: 2.5rem; -} - -.h2 { - margin-top: 2.5rem; - font-size: 1.875rem; - line-height: 2.25rem; -} - -.h3, .h4, .h5, .h6 { - margin-top: 2rem; -} - -.h3 { - font-size: 1.5rem; - line-height: 2rem; -} - -.h4, .h5 { - line-height: 1.75rem; -} - -.h4 { - font-size: 1.25rem; -} - -.h5 { - font-size: 1.125rem; -} - -.h6 { - font-size: 1rem; - line-height: 1.5rem; -} - -.p { - margin-top: 1.25em; - margin-bottom: 1.25em; -} \ No newline at end of file diff --git a/examples/custom/src/mdx-components.tsx b/examples/custom/src/mdx-components.tsx deleted file mode 100644 index 46ccc858a..000000000 --- a/examples/custom/src/mdx-components.tsx +++ /dev/null @@ -1,17 +0,0 @@ -import type { MDXComponents } from "mdx/types"; -import styles from "./mdx-components.module.css"; -import { HeadingWrapper } from "./components/mdx"; - -const components: MDXComponents = { - h1: (props) => , - h2: (props) => , - h3: (props) => , - h4: (props) => , - h5: (props) => , - h6: (props) => , - p: (props) =>

    , -}; - -export function useMDXComponents(): MDXComponents { - return components; -} diff --git a/examples/custom/tsconfig.json b/examples/custom/tsconfig.json deleted file mode 100644 index 588a1e705..000000000 --- a/examples/custom/tsconfig.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2017", - "lib": ["dom", "dom.iterable", "esnext"], - "allowJs": true, - "skipLibCheck": true, - "strict": true, - "noEmit": true, - "esModuleInterop": true, - "module": "esnext", - "moduleResolution": "bundler", - "resolveJsonModule": true, - "isolatedModules": true, - "jsx": "preserve", - "incremental": true, - "plugins": [ - { - "name": "next" - } - ], - "paths": { - "@/*": ["./src/*"] - }, - "experimentalDecorators": true, - }, - "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], - "exclude": ["node_modules"] -} diff --git a/examples/docusaurus/.gitignore b/examples/docusaurus/.gitignore deleted file mode 100644 index b2d6de306..000000000 --- a/examples/docusaurus/.gitignore +++ /dev/null @@ -1,20 +0,0 @@ -# Dependencies -/node_modules - -# Production -/build - -# Generated files -.docusaurus -.cache-loader - -# Misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* diff --git a/examples/docusaurus/README.md b/examples/docusaurus/README.md deleted file mode 100644 index b28211a9b..000000000 --- a/examples/docusaurus/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Website - -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. - -## Installation - -```bash -yarn -``` - -## Local Development - -```bash -yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -## Build - -```bash -yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```bash -USE_SSH=true yarn deploy -``` - -Not using SSH: - -```bash -GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/examples/docusaurus/docs/glean/api/_category_.json b/examples/docusaurus/docs/glean/api/_category_.json deleted file mode 100644 index 99bb6e4fd..000000000 --- a/examples/docusaurus/docs/glean/api/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 2, - "label": "API Reference", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/_category_.json b/examples/docusaurus/docs/glean/api/endpoint/_category_.json deleted file mode 100644 index 180b4a4cb..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 3, - "label": "Operations", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/activity.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/activity.mdx deleted file mode 100644 index 3e55be39e..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/activity.mdx +++ /dev/null @@ -1,2114 +0,0 @@ ---- -sidebar_position: 3.0 -sidebar_label: Client Activity ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedparams from "../../../../../src/components/glean-embeds/loaders/params.tsx"; -import Embedchattranscript from "../../../../../src/components/glean-embeds/loaders/chattranscript.tsx"; -import Embedimplementations from "../../../../../src/components/glean-embeds/loaders/implementations.tsx"; - - - - - - - -# Client Activity Endpoints - - - - - - - - - -## POST /rest/api/v1/activity \{#operation-activity\} - - - - - -_Report document activity_ - - - - - -Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/activity \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "events": [ - { - "action": "VIEW", - "timestamp": "2025-10-07T20:56:01.974Z", - "url": "ipsum eiusmod" - } - ] -}' -``` - - - - - - - - - - - -

    - - - -### Request Example \{#operation-activity+request-examples\} - - - - - -```json -{ - "events": [ - { - "action": "VIEW", - "timestamp": "2025-10-07T20:56:01.974Z", - "url": "ipsum eiusmod" - } - ] -} -``` - - - -
    - - - - - -
    - - - -### Request Body \{#operation-activity+request\} - - - - - - - -ActivityEvent","children":[{"label":"ActivityEvent","linkedLabel":"ActivityEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### events \{#operation-activity+request+events\} - - - - - - - - - -#### ActivityEvent \{#operation-activity+request+events+activityevent\} - - - - - - - - - -##### action \{#operation-activity+request+events+activityevent+action\} - - - - - -The type of activity this represents. - - - - - - - - - -##### id \{#operation-activity+request+events+activityevent+id\} - - - - - -Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - - - - - -ActivityEventParams","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### params \{#operation-activity+request+events+activityevent+params\} - - - - - - - - - - - - - - - - - - - - - - - -##### timestamp \{#operation-activity+request+events+activityevent+timestamp\} - - - - - -The ISO 8601 timestamp when the activity began. - - - - - - - - - -##### url \{#operation-activity+request+events+activityevent+url\} - - - - - -The URL of the activity. - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -## POST /rest/api/v1/feedback \{#operation-feedback\} - - - - - -_Report client activity_ - - - - - -Report events that happen to results within a Glean client UI, such as search result views and clicks. This signal improves search quality. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/feedback \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "event": "CLICK", - "trackingTokens": [ - "ipsum eiusmod" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-feedback+parameters\} - - - - - - - - - - - -##### feedbackQueryParameter \{#operation-feedback+parameters+feedbackqueryparameter\} - - - - - -A URL encoded versions of Feedback. This is useful for requests. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-feedback+request-examples\} - - - - - -```json -{ - "event": "CLICK", - "trackingTokens": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-feedback+request\} - - - - - - - - - - - -##### agentId \{#operation-feedback+request+agentid\} - - - - - -The agent ID of the client that sent the feedback event. - - - - - - - - - -##### applicationId \{#operation-feedback+request+applicationid\} - - - - - -The application ID of the client that sent the feedback event. - - - - - - - - - -##### category \{#operation-feedback+request+category\} - - - - - -The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. - - - - - - - - - -##### channels \{#operation-feedback+request+channels\} - - - - - -Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean. - - - - - - - - - -##### event \{#operation-feedback+request+event\} - - - - - -The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. - - - - - - - - - -##### id \{#operation-feedback+request+id\} - - - - - -Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - - - - - -ManualFeedbackInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### manualFeedbackInfo \{#operation-feedback+request+manualfeedbackinfo\} - - - - - - - - - -#### ManualFeedbackInfo \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo\} - - - - - - - - - -##### activeTab \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+activetab\} - - - - - -Which tabs the user had chosen at the time of the Feedback.event.MANUAL_FEEDBACK event. For search feedback events only. - - - - - -FeedbackChatExchange","children":[{"label":"FeedbackChatExchange","linkedLabel":"FeedbackChatExchange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chatTranscript \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+chattranscript\} - - - - - -Array of previous request/response exchanges, ordered by oldest to newest. - - - - - - - - - - - - - - - - - - - - - - - -##### comments \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+comments\} - - - - - -The comments users can optionally add to the Feedback.event.MANUAL_FEEDBACK events. - - - - - - - - - -##### email \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+email\} - - - - - -The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event. - - - - - - - - - -##### imageUrls \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+imageurls\} - - - - - -URLs of images uploaded by user when providing feedback - - - - - - - - - -##### issue \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+issue\} - - - - - -The issue the user indicated in the feedback. - - - - - - - - - -##### issues \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+issues\} - - - - - -The issue(s) the user indicated in the feedback. - - - - - - - - - -##### numQueriesFromFirstRun \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+numqueriesfromfirstrun\} - - - - - -How many times this query has been run in the past. - - - - - - - - - -##### obscuredQuery \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+obscuredquery\} - - - - - -The query associated with the Feedback.event.MANUAL_FEEDBACK event, but obscured such that the vowels are replaced with special characters. For search feedback events only. - - - - - - - - - -##### previousMessages \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+previousmessages\} - - - - - -The array of previous messages in a chat session, ordered by oldest to newest. - - - - - - - - - -##### query \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+query\} - - - - - -The query associated with the Feedback.event.MANUAL_FEEDBACK event. - - - - - - - - - -##### rating \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+rating\} - - - - - -A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. - - - - - - - - - -##### ratingKey \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+ratingkey\} - - - - - -A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied". - - - - - - - - - -##### ratingScale \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+ratingscale\} - - - - - -The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2. - - - - - - - - - -##### searchResults \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+searchresults\} - - - - - -The array of search result Glean Document IDs, ordered by top to bottom result. - - - - - - - - - -##### source \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+source\} - - - - - -The source associated with the Feedback.event.MANUAL_FEEDBACK event. - - - - - - - - - -##### vote \{#operation-feedback+request+manualfeedbackinfo+manualfeedbackinfo+vote\} - - - - - -The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - - - - - - - - - - - - - -ManualFeedbackSideBySideInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### manualFeedbackSideBySideInfo \{#operation-feedback+request+manualfeedbacksidebysideinfo\} - - - - - - - - - -#### ManualFeedbackSideBySideInfo \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo\} - - - - - - - - - -##### comments \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+comments\} - - - - - -Specific feedback comments for this implementation. - - - - - - - - - -##### email \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+email\} - - - - - -The email address of the user who submitted the side-by-side feedback. - - - - - - - - - -##### evaluationSessionId \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+evaluationsessionid\} - - - - - -Unique identifier for this evaluation session to group related feedback events. - - - - - - - - - -##### implementationId \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+implementationid\} - - - - - -The ID of the implementation this specific feedback event is for. - - - - - -SideBySideImplementation","children":[{"label":"SideBySideImplementation","linkedLabel":"SideBySideImplementation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### implementations \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+implementations\} - - - - - -Array of implementations that were compared side-by-side. - - - - - - - - - - - - - - - - - - - - - - - -##### query \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+query\} - - - - - -The query or prompt that was evaluated across multiple implementations. - - - - - - - - - -##### source \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+source\} - - - - - -The source associated with the side-by-side feedback event. - - - - - - - - - -##### vote \{#operation-feedback+request+manualfeedbacksidebysideinfo+manualfeedbacksidebysideinfo+vote\} - - - - - -The vote for this specific implementation. - - - - - - - - - - - - - - - - - -##### pathname \{#operation-feedback+request+pathname\} - - - - - -The path the client was at when the feedback event triggered. - - - - - - - - - -##### payload \{#operation-feedback+request+payload\} - - - - - -For type MANUAL_FEEDBACK, contains string of user feedback. For autocomplete, partial query string. For feed, string of user feedback in addition to manual feedback signals extracted from all suggested content. - - - - - - - - - -##### position \{#operation-feedback+request+position\} - - - - - -Position of the element in the case that the client controls order (such as feed and autocomplete). - - - - - -SeenFeedbackInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### seenFeedbackInfo \{#operation-feedback+request+seenfeedbackinfo\} - - - - - - - - - -#### SeenFeedbackInfo \{#operation-feedback+request+seenfeedbackinfo+seenfeedbackinfo\} - - - - - - - - - -##### isExplicit \{#operation-feedback+request+seenfeedbackinfo+seenfeedbackinfo+isexplicit\} - - - - - -The confidence of the user seeing the object is high because they explicitly interacted with it e.g. answer impression in SERP with additional user interaction. - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-feedback+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-feedback+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-feedback+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-feedback+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-feedback+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-feedback+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### timestamp \{#operation-feedback+request+timestamp\} - - - - - -The ISO 8601 timestamp when the event occured. - - - - - - - - - -##### trackingTokens \{#operation-feedback+request+trackingtokens\} - - - - - -A list of server-generated trackingTokens to which this event applies. - - - - - - - - - -##### uiElement \{#operation-feedback+request+uielement\} - - - - - -The UI element associated with the event, if any. - - - - - - - - - -##### uiTree \{#operation-feedback+request+uitree\} - - - - - -The UI element tree associated with the event, if any. - - - - - - - - - -##### url \{#operation-feedback+request+url\} - - - - - -The URL the client was at when the feedback event triggered. - - - - - -User","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### user \{#operation-feedback+request+user\} - - - - - - - - - -#### User \{#operation-feedback+request+user+user\} - - - - - - - - - -##### origID \{#operation-feedback+request+user+user+origid\} - - - - - -An opaque user ID for the authenticated user (ignores actas). - - - - - - - - - -##### userID \{#operation-feedback+request+user+user+userid\} - - - - - -An opaque user ID for the claimed authority (i.e., the actas param, or the origid if actas is not specified). - - - - - - - - - - - - - -UserViewInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### userViewInfo \{#operation-feedback+request+userviewinfo\} - - - - - - - - - -#### UserViewInfo \{#operation-feedback+request+userviewinfo+userviewinfo\} - - - - - - - - - -##### docId \{#operation-feedback+request+userviewinfo+userviewinfo+docid\} - - - - - -Unique Glean Document ID of the associated document. - - - - - - - - - -##### docTitle \{#operation-feedback+request+userviewinfo+userviewinfo+doctitle\} - - - - - -Title of associated document. - - - - - - - - - -##### docUrl \{#operation-feedback+request+userviewinfo+userviewinfo+docurl\} - - - - - -URL of associated document. - - - - - - - - - - - - - -WorkflowFeedbackInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### workflowFeedbackInfo \{#operation-feedback+request+workflowfeedbackinfo\} - - - - - - - - - -#### WorkflowFeedbackInfo \{#operation-feedback+request+workflowfeedbackinfo+workflowfeedbackinfo\} - - - - - - - - - -##### source \{#operation-feedback+request+workflowfeedbackinfo+workflowfeedbackinfo+source\} - - - - - -Where the feedback of the workflow originated from - - - - - - - - - - - - - - - - - -
    - -     - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/agents.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/agents.mdx deleted file mode 100644 index ab735b64d..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/agents.mdx +++ /dev/null @@ -1,2509 +0,0 @@ ---- -sidebar_position: 3.1 -sidebar_label: Client Agents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedcapabilities from "../../../../../src/components/glean-embeds/loaders/capabilities.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedcontent from "../../../../../src/components/glean-embeds/loaders/content.tsx"; -import Embedmessages from "../../../../../src/components/glean-embeds/loaders/messages.tsx"; - - - - - - - -# Client Agents Endpoints - - - - - - - - - -## GET /rest/api/v1/agents/\{agent\_id\} \{#operation-get_agent\} - - - - - -_Retrieve an agent_ - - - - - -Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/agents/{agent_id} \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-get_agent+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-get_agent+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -##### agent_id \{#operation-get_agent+parameters+agent_id\} - - - - - -The ID of the agent. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-get_agent+responses-examples\} - - - - - -200 - - - - - -```json -{ - "agent_id": "mho4lwzylcozgoc2", - "capabilities": {}, - "name": "HR Policy Agent" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-get_agent+responses\} - - - - - -200 - - - - - - - -Success - - - - - - - - - -##### agent_id \{#operation-get_agent+responses+200+application-json+agent_id\} - - - - - -The ID of the agent. - - - - - -_Example:_ - -``` -mho4lwzylcozgoc2 -``` - - - - - -Agent Capabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### capabilities \{#operation-get_agent+responses+200+application-json+capabilities\} - - - - - -Describes features that the agent supports. example: \{ - "ap.io.messages": true, - "ap.io.streaming": true -\} - - - - - - - - - -#### Agent Capabilities \{#operation-get_agent+responses+200+application-json+capabilities+agent capabilities\} - - - - - -Describes features that the agent supports. example: \{ - "ap.io.messages": true, - "ap.io.streaming": true -\} - - - - - - - - - -##### AdditionalProperties \{#operation-get_agent+responses+200+application-json+capabilities+agent capabilities+additionalproperties\} - - - - - - - - - -##### ap.io.messages \{#operation-get_agent+responses+200+application-json+capabilities+agent capabilities+ap.io.messages\} - - - - - -Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent. - - - - - - - - - -##### ap.io.streaming \{#operation-get_agent+responses+200+application-json+capabilities+agent capabilities+ap.io.streaming\} - - - - - -Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming. - - - - - - - - - - - - - - - - - -##### description \{#operation-get_agent+responses+200+application-json+description\} - - - - - -The description of the agent. - - - - - -_Example:_ - -``` -This agent answers questions about the current company HR policies. -``` - - - - - -Metadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#operation-get_agent+responses+200+application-json+metadata\} - - - - - -The agent metadata. Currently not implemented. - - - - - - - - - -#### Metadata \{#operation-get_agent+responses+200+application-json+metadata+metadata\} - - - - - -The agent metadata. Currently not implemented. - - - - - - - - - - - - - -##### name \{#operation-get_agent+responses+200+application-json+name\} - - - - - -The name of the agent - - - - - -_Example:_ - -``` -HR Policy Agent -``` - - - - - - - - - - - - - -     - - - - - -## GET /rest/api/v1/agents/\{agent\_id\}/schemas \{#operation-get_agent_schemas\} - - - - - -_List an agent's schemas_ - - - - - -Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/agents/{agent_id}/schemas \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-get_agent_schemas+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-get_agent_schemas+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -##### agent_id \{#operation-get_agent_schemas+parameters+agent_id\} - - - - - -The ID of the agent. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-get_agent_schemas+responses-examples\} - - - - - -200 - - - - - -```json -{ - "agent_id": "mho4lwzylcozgoc2", - "input_schema": {}, - "output_schema": {} -} -``` - - - - - - - - - - - - - -### Responses \{#operation-get_agent_schemas+responses\} - - - - - -200 - - - - - - - -Success - - - - - - - - - -##### agent_id \{#operation-get_agent_schemas+responses+200+application-json+agent_id\} - - - - - -The ID of the agent. - - - - - -_Example:_ - -``` -mho4lwzylcozgoc2 -``` - - - - - -Input Schema","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input_schema \{#operation-get_agent_schemas+responses+200+application-json+input_schema\} - - - - - -The schema for the agent input. In JSON Schema format. - - - - - - - - - -#### Input Schema \{#operation-get_agent_schemas+responses+200+application-json+input_schema+input schema\} - - - - - -The schema for the agent input. In JSON Schema format. - - - - - - - - - -Output Schema","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### output_schema \{#operation-get_agent_schemas+responses+200+application-json+output_schema\} - - - - - -The schema for the agent output. In JSON Schema format. - - - - - - - - - -#### Output Schema \{#operation-get_agent_schemas+responses+200+application-json+output_schema+output schema\} - - - - - -The schema for the agent output. In JSON Schema format. - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/agents/search \{#operation-search_agents\} - - - - - -_Search agents_ - - - - - -Search for [agents](https://developers.glean.com/agents/agents-api) by agent name. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/agents/search \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-search_agents+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-search_agents+request\} - - - - - - - - - - - -##### name \{#operation-search_agents+request+name\} - - - - - -Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter. - - - - - -_Example:_ - -``` -HR Policy Agent -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-search_agents+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-search_agents+responses\} - - - - - -200 - - - - - - - -Success - - - - - -Agent","children":[{"label":"Agent","linkedLabel":"Agent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### agents \{#operation-search_agents+responses+200+application-json+agents\} - - - - - - - - - -#### Agent \{#operation-search_agents+responses+200+application-json+agents+agent\} - - - - - - - - - -##### agent_id \{#operation-search_agents+responses+200+application-json+agents+agent+agent_id\} - - - - - -The ID of the agent. - - - - - -_Example:_ - -``` -mho4lwzylcozgoc2 -``` - - - - - -Agent Capabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-search_agents+responses+200+application-json+agents+agent+capabilities\} - - - - - -Describes features that the agent supports. example: \{ - "ap.io.messages": true, - "ap.io.streaming": true -\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-search_agents+responses+200+application-json+agents+agent+description\} - - - - - -The description of the agent. - - - - - -_Example:_ - -``` -This agent answers questions about the current company HR policies. -``` - - - - - -Metadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-search_agents+responses+200+application-json+agents+agent+metadata\} - - - - - -The agent metadata. Currently not implemented. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-search_agents+responses+200+application-json+agents+agent+name\} - - - - - -The name of the agent - - - - - -_Example:_ - -``` -HR Policy Agent -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/agents/runs/stream \{#operation-create_and_stream_run\} - - - - - -_Create an agent run and stream the response_ - - - - - -Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/agents/runs/stream \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "agent_id": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-create_and_stream_run+request-examples\} - - - - - -```json -{ - "agent_id": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-create_and_stream_run+request\} - - - - - - - -Payload for creating a run. - - - - - - - - - -##### agent_id \{#operation-create_and_stream_run+request+agent_id\} - - - - - -The ID of the agent to run. - - - - - - - - - -##### input \{#operation-create_and_stream_run+request+input\} - - - - - -The input to the agent. - - - - - -Message","children":[{"label":"Message","linkedLabel":"Message","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-create_and_stream_run+request+messages\} - - - - - -The messages to pass an input to the agent. - - - - - - - - - -#### Message \{#operation-create_and_stream_run+request+messages+message\} - - - - - -MessageTextBlock","children":[{"label":"MessageTextBlock","linkedLabel":"MessageTextBlock","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-create_and_stream_run+request+messages+message+content\} - - - - - -The content of the message. - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-create_and_stream_run+request+messages+message+role\} - - - - - -The role of the message. - - - - - -_Example:_ - -``` -USER -``` - - - - - - - - - - - - - - - - - -##### metadata \{#operation-create_and_stream_run+request+metadata\} - - - - - -The metadata to pass to the agent. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-create_and_stream_run+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-create_and_stream_run+responses\} - - - - - -200 - - - - - - - - - - - - - -Success - - - - - - - - - -     - - - - - -## POST /rest/api/v1/agents/runs/wait \{#operation-create_and_wait_run\} - - - - - -_Create an agent run and wait for the response_ - - - - - -Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/agents/runs/wait \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "agent_id": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-create_and_wait_run+request-examples\} - - - - - -```json -{ - "agent_id": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-create_and_wait_run+request\} - - - - - - - -Payload for creating a run. - - - - - - - - - -##### agent_id \{#operation-create_and_wait_run+request+agent_id\} - - - - - -The ID of the agent to run. - - - - - - - - - -##### input \{#operation-create_and_wait_run+request+input\} - - - - - -The input to the agent. - - - - - -Message","children":[{"label":"Message","linkedLabel":"Message","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-create_and_wait_run+request+messages\} - - - - - -The messages to pass an input to the agent. - - - - - - - - - -#### Message \{#operation-create_and_wait_run+request+messages+message\} - - - - - -MessageTextBlock","children":[{"label":"MessageTextBlock","linkedLabel":"MessageTextBlock","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-create_and_wait_run+request+messages+message+content\} - - - - - -The content of the message. - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-create_and_wait_run+request+messages+message+role\} - - - - - -The role of the message. - - - - - -_Example:_ - -``` -USER -``` - - - - - - - - - - - - - - - - - -##### metadata \{#operation-create_and_wait_run+request+metadata\} - - - - - -The metadata to pass to the agent. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-create_and_wait_run+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-create_and_wait_run+responses\} - - - - - -200 - - - - - - - -Success - - - - - -Message","children":[{"label":"Message","linkedLabel":"Message","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-create_and_wait_run+responses+200+application-json+messages\} - - - - - -The messages to pass an input to the agent. - - - - - - - - - -#### Message \{#operation-create_and_wait_run+responses+200+application-json+messages+message\} - - - - - -MessageTextBlock","children":[{"label":"MessageTextBlock","linkedLabel":"MessageTextBlock","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-create_and_wait_run+responses+200+application-json+messages+message+content\} - - - - - -The content of the message. - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-create_and_wait_run+responses+200+application-json+messages+message+role\} - - - - - -The role of the message. - - - - - -_Example:_ - -``` -USER -``` - - - - - - - - - - - - - -AgentRun","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### run \{#operation-create_and_wait_run+responses+200+application-json+run\} - - - - - -Payload for creating a run. - - - - - - - - - -#### AgentRun \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun\} - - - - - -Payload for creating a run. - - - - - - - - - -##### agent_id \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun+agent_id\} - - - - - -The ID of the agent to run. - - - - - - - - - -##### input \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun+input\} - - - - - -The input to the agent. - - - - - -Message","children":[{"label":"Message","linkedLabel":"Message","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### messages \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun+messages\} - - - - - -The messages to pass an input to the agent. - - - - - - - - - - - - - - - - - - - - - - - -##### metadata \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun+metadata\} - - - - - -The metadata to pass to the agent. - - - - - - - - - -##### status \{#operation-create_and_wait_run+responses+200+application-json+run+agentrun+status\} - - - - - -The status of the run. One of 'error', 'success'. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/announcements.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/announcements.mdx deleted file mode 100644 index 4cb64e45a..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/announcements.mdx +++ /dev/null @@ -1,5301 +0,0 @@ ---- -sidebar_position: 3.2 -sidebar_label: Client Announcements ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedstructuredlist from "../../../../../src/components/glean-embeds/loaders/structuredlist.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedwrite from "../../../../../src/components/glean-embeds/loaders/write.tsx"; -import Embedcontainerdocument from "../../../../../src/components/glean-embeds/loaders/containerdocument.tsx"; -import Embedcontent from "../../../../../src/components/glean-embeds/loaders/content.tsx"; -import Embedparentdocument from "../../../../../src/components/glean-embeds/loaders/parentdocument.tsx"; -import Embedsections from "../../../../../src/components/glean-embeds/loaders/sections.tsx"; - - - - - - - -# Client Announcements Endpoints - - - - - - - - - -## POST /rest/api/v1/createannouncement \{#operation-createannouncement\} - - - - - -_Create Announcement_ - - - - - -Create a textual announcement visible to some set of users based on department and location. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/createannouncement \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "endTime": "2025-10-07T20:56:01.974Z", - "startTime": "2025-10-07T20:56:01.974Z", - "title": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createannouncement+request-examples\} - - - - - -```json -{ - "endTime": "2025-10-07T20:56:01.974Z", - "startTime": "2025-10-07T20:56:01.974Z", - "title": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createannouncement+request\} - - - - - - - -Announcement content - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-createannouncement+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-createannouncement+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-createannouncement+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-createannouncement+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-createannouncement+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### body \{#operation-createannouncement+request+body\} - - - - - - - - - -#### StructuredText \{#operation-createannouncement+request+body+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-createannouncement+request+body+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-createannouncement+request+body+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### channel \{#operation-createannouncement+request+channel\} - - - - - -This determines whether this is a Social Feed post or a regular announcement. - - - - - - - - - -##### emoji \{#operation-createannouncement+request+emoji\} - - - - - -An emoji used to indicate the nature of the announcement. - - - - - - - - - -##### endTime \{#operation-createannouncement+request+endtime\} - - - - - -The date and time at which the announcement expires. - - - - - - - - - -##### hideAttribution \{#operation-createannouncement+request+hideattribution\} - - - - - -Whether or not to hide an author attribution. - - - - - - - - - -##### isPrioritized \{#operation-createannouncement+request+isprioritized\} - - - - - -Used by the Social Feed to pin posts to the front of the feed. - - - - - - - - - -##### postType \{#operation-createannouncement+request+posttype\} - - - - - -This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - - - - - - - - - -##### sourceDocumentId \{#operation-createannouncement+request+sourcedocumentid\} - - - - - -The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - - - - - - - - - -##### startTime \{#operation-createannouncement+request+starttime\} - - - - - -The date and time at which the announcement becomes active. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-createannouncement+request+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-createannouncement+request+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-createannouncement+request+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-createannouncement+request+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -##### title \{#operation-createannouncement+request+title\} - - - - - -The headline of the announcement. - - - - - - - - - -##### viewUrl \{#operation-createannouncement+request+viewurl\} - - - - - -URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createannouncement+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-createannouncement+responses\} - - - - - -200 - - - - - - - -OK - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-createannouncement+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-createannouncement+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-createannouncement+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-createannouncement+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-createannouncement+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### author \{#operation-createannouncement+responses+200+application-json+author\} - - - - - - - - - -#### Person \{#operation-createannouncement+responses+200+application-json+author+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createannouncement+responses+200+application-json+author+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-createannouncement+responses+200+application-json+author+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-createannouncement+responses+200+application-json+author+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-createannouncement+responses+200+application-json+author+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### body \{#operation-createannouncement+responses+200+application-json+body\} - - - - - - - - - -#### StructuredText \{#operation-createannouncement+responses+200+application-json+body+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-createannouncement+responses+200+application-json+body+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-createannouncement+responses+200+application-json+body+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### channel \{#operation-createannouncement+responses+200+application-json+channel\} - - - - - -This determines whether this is a Social Feed post or a regular announcement. - - - - - - - - - -##### createTimestamp \{#operation-createannouncement+responses+200+application-json+createtimestamp\} - - - - - -Server Unix timestamp of the creation time (in seconds since epoch UTC). - - - - - - - - - -##### draftId \{#operation-createannouncement+responses+200+application-json+draftid\} - - - - - -The opaque id of the associated draft. - - - - - - - - - -##### emoji \{#operation-createannouncement+responses+200+application-json+emoji\} - - - - - -An emoji used to indicate the nature of the announcement. - - - - - - - - - -##### endTime \{#operation-createannouncement+responses+200+application-json+endtime\} - - - - - -The date and time at which the announcement expires. - - - - - - - - - -##### hideAttribution \{#operation-createannouncement+responses+200+application-json+hideattribution\} - - - - - -Whether or not to hide an author attribution. - - - - - - - - - -##### id \{#operation-createannouncement+responses+200+application-json+id\} - - - - - -The opaque id of the announcement. - - - - - - - - - -##### isPrioritized \{#operation-createannouncement+responses+200+application-json+isprioritized\} - - - - - -Used by the Social Feed to pin posts to the front of the feed. - - - - - - - - - -##### isPublished \{#operation-createannouncement+responses+200+application-json+ispublished\} - - - - - -Whether or not the announcement is published. - - - - - - - - - -##### lastUpdateTimestamp \{#operation-createannouncement+responses+200+application-json+lastupdatetimestamp\} - - - - - -Server Unix timestamp of the last update time (in seconds since epoch UTC). - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-createannouncement+responses+200+application-json+permissions\} - - - - - - - - - -#### ObjectPermissions \{#operation-createannouncement+responses+200+application-json+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#operation-createannouncement+responses+200+application-json+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### postType \{#operation-createannouncement+responses+200+application-json+posttype\} - - - - - -This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-createannouncement+responses+200+application-json+sourcedocument\} - - - - - - - - - -#### Document \{#operation-createannouncement+responses+200+application-json+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-createannouncement+responses+200+application-json+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### sourceDocumentId \{#operation-createannouncement+responses+200+application-json+sourcedocumentid\} - - - - - -The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - - - - - - - - - -##### startTime \{#operation-createannouncement+responses+200+application-json+starttime\} - - - - - -The date and time at which the announcement becomes active. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-createannouncement+responses+200+application-json+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-createannouncement+responses+200+application-json+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-createannouncement+responses+200+application-json+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-createannouncement+responses+200+application-json+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -##### title \{#operation-createannouncement+responses+200+application-json+title\} - - - - - -The headline of the announcement. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-createannouncement+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-createannouncement+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createannouncement+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-createannouncement+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-createannouncement+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-createannouncement+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### viewUrl \{#operation-createannouncement+responses+200+application-json+viewurl\} - - - - - -URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - - - - - -viewerInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### viewerInfo \{#operation-createannouncement+responses+200+application-json+viewerinfo\} - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deleteannouncement \{#operation-deleteannouncement\} - - - - - -_Delete Announcement_ - - - - - -Delete an existing user-generated announcement. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deleteannouncement \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": 87 -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-deleteannouncement+request-examples\} - - - - - -```json -{ - "id": 87 -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deleteannouncement+request\} - - - - - - - -Delete announcement request - - - - - - - - - -##### id \{#operation-deleteannouncement+request+id\} - - - - - -The opaque id of the announcement to be deleted. - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/updateannouncement \{#operation-updateannouncement\} - - - - - -_Update Announcement_ - - - - - -Update a textual announcement visible to some set of users based on department and location. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/updateannouncement \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "endTime": "2025-10-07T20:56:01.974Z", - "id": 87, - "startTime": "2025-10-07T20:56:01.974Z", - "title": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-updateannouncement+request-examples\} - - - - - -```json -{ - "endTime": "2025-10-07T20:56:01.974Z", - "id": 87, - "startTime": "2025-10-07T20:56:01.974Z", - "title": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-updateannouncement+request\} - - - - - - - -Announcement content. Id need to be specified for the announcement. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-updateannouncement+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-updateannouncement+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-updateannouncement+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-updateannouncement+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-updateannouncement+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### body \{#operation-updateannouncement+request+body\} - - - - - - - - - -#### StructuredText \{#operation-updateannouncement+request+body+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-updateannouncement+request+body+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-updateannouncement+request+body+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### channel \{#operation-updateannouncement+request+channel\} - - - - - -This determines whether this is a Social Feed post or a regular announcement. - - - - - - - - - -##### emoji \{#operation-updateannouncement+request+emoji\} - - - - - -An emoji used to indicate the nature of the announcement. - - - - - - - - - -##### endTime \{#operation-updateannouncement+request+endtime\} - - - - - -The date and time at which the announcement expires. - - - - - - - - - -##### hideAttribution \{#operation-updateannouncement+request+hideattribution\} - - - - - -Whether or not to hide an author attribution. - - - - - - - - - -##### id \{#operation-updateannouncement+request+id\} - - - - - -The opaque id of the announcement. - - - - - - - - - -##### isPrioritized \{#operation-updateannouncement+request+isprioritized\} - - - - - -Used by the Social Feed to pin posts to the front of the feed. - - - - - - - - - -##### postType \{#operation-updateannouncement+request+posttype\} - - - - - -This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - - - - - - - - - -##### sourceDocumentId \{#operation-updateannouncement+request+sourcedocumentid\} - - - - - -The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - - - - - - - - - -##### startTime \{#operation-updateannouncement+request+starttime\} - - - - - -The date and time at which the announcement becomes active. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-updateannouncement+request+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-updateannouncement+request+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-updateannouncement+request+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-updateannouncement+request+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -##### title \{#operation-updateannouncement+request+title\} - - - - - -The headline of the announcement. - - - - - - - - - -##### viewUrl \{#operation-updateannouncement+request+viewurl\} - - - - - -URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-updateannouncement+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-updateannouncement+responses\} - - - - - -200 - - - - - - - -OK - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-updateannouncement+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-updateannouncement+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-updateannouncement+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-updateannouncement+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-updateannouncement+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### author \{#operation-updateannouncement+responses+200+application-json+author\} - - - - - - - - - -#### Person \{#operation-updateannouncement+responses+200+application-json+author+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-updateannouncement+responses+200+application-json+author+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-updateannouncement+responses+200+application-json+author+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-updateannouncement+responses+200+application-json+author+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-updateannouncement+responses+200+application-json+author+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### body \{#operation-updateannouncement+responses+200+application-json+body\} - - - - - - - - - -#### StructuredText \{#operation-updateannouncement+responses+200+application-json+body+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-updateannouncement+responses+200+application-json+body+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-updateannouncement+responses+200+application-json+body+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### channel \{#operation-updateannouncement+responses+200+application-json+channel\} - - - - - -This determines whether this is a Social Feed post or a regular announcement. - - - - - - - - - -##### createTimestamp \{#operation-updateannouncement+responses+200+application-json+createtimestamp\} - - - - - -Server Unix timestamp of the creation time (in seconds since epoch UTC). - - - - - - - - - -##### draftId \{#operation-updateannouncement+responses+200+application-json+draftid\} - - - - - -The opaque id of the associated draft. - - - - - - - - - -##### emoji \{#operation-updateannouncement+responses+200+application-json+emoji\} - - - - - -An emoji used to indicate the nature of the announcement. - - - - - - - - - -##### endTime \{#operation-updateannouncement+responses+200+application-json+endtime\} - - - - - -The date and time at which the announcement expires. - - - - - - - - - -##### hideAttribution \{#operation-updateannouncement+responses+200+application-json+hideattribution\} - - - - - -Whether or not to hide an author attribution. - - - - - - - - - -##### id \{#operation-updateannouncement+responses+200+application-json+id\} - - - - - -The opaque id of the announcement. - - - - - - - - - -##### isPrioritized \{#operation-updateannouncement+responses+200+application-json+isprioritized\} - - - - - -Used by the Social Feed to pin posts to the front of the feed. - - - - - - - - - -##### isPublished \{#operation-updateannouncement+responses+200+application-json+ispublished\} - - - - - -Whether or not the announcement is published. - - - - - - - - - -##### lastUpdateTimestamp \{#operation-updateannouncement+responses+200+application-json+lastupdatetimestamp\} - - - - - -Server Unix timestamp of the last update time (in seconds since epoch UTC). - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-updateannouncement+responses+200+application-json+permissions\} - - - - - - - - - -#### ObjectPermissions \{#operation-updateannouncement+responses+200+application-json+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#operation-updateannouncement+responses+200+application-json+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### postType \{#operation-updateannouncement+responses+200+application-json+posttype\} - - - - - -This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-updateannouncement+responses+200+application-json+sourcedocument\} - - - - - - - - - -#### Document \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-updateannouncement+responses+200+application-json+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### sourceDocumentId \{#operation-updateannouncement+responses+200+application-json+sourcedocumentid\} - - - - - -The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - - - - - - - - - -##### startTime \{#operation-updateannouncement+responses+200+application-json+starttime\} - - - - - -The date and time at which the announcement becomes active. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-updateannouncement+responses+200+application-json+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-updateannouncement+responses+200+application-json+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-updateannouncement+responses+200+application-json+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-updateannouncement+responses+200+application-json+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -##### title \{#operation-updateannouncement+responses+200+application-json+title\} - - - - - -The headline of the announcement. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-updateannouncement+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-updateannouncement+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-updateannouncement+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-updateannouncement+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-updateannouncement+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-updateannouncement+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### viewUrl \{#operation-updateannouncement+responses+200+application-json+viewurl\} - - - - - -URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - - - - - -viewerInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### viewerInfo \{#operation-updateannouncement+responses+200+application-json+viewerinfo\} - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/answers.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/answers.mdx deleted file mode 100644 index d3070e904..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/answers.mdx +++ /dev/null @@ -1,9352 +0,0 @@ ---- -sidebar_position: 3.3 -sidebar_label: Client Answers ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../../../../../src/components/glean-embeds/loaders/addedroles.tsx"; -import Embedaudiencefilters from "../../../../../src/components/glean-embeds/loaders/audiencefilters.tsx"; -import Embedcombinedanswertext from "../../../../../src/components/glean-embeds/loaders/combinedanswertext.tsx"; -import Embedremovedroles from "../../../../../src/components/glean-embeds/loaders/removedroles.tsx"; -import Embedroles from "../../../../../src/components/glean-embeds/loaders/roles.tsx"; -import Embedgroup from "../../../../../src/components/glean-embeds/loaders/group.tsx"; -import Embedperson from "../../../../../src/components/glean-embeds/loaders/person.tsx"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedcreator from "../../../../../src/components/glean-embeds/loaders/creator.tsx"; -import Embedpermissions from "../../../../../src/components/glean-embeds/loaders/permissions.tsx"; -import Embedupdatedby from "../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; -import Embedchildren from "../../../../../src/components/glean-embeds/loaders/children.tsx"; -import Embeditems from "../../../../../src/components/glean-embeds/loaders/items.tsx"; -import Embedpinmetadata from "../../../../../src/components/glean-embeds/loaders/pinmetadata.tsx"; -import Embedthumbnail from "../../../../../src/components/glean-embeds/loaders/thumbnail.tsx"; -import Embedstructuredlist from "../../../../../src/components/glean-embeds/loaders/structuredlist.tsx"; -import Embedlikedby from "../../../../../src/components/glean-embeds/loaders/likedby.tsx"; -import Embedwrite from "../../../../../src/components/glean-embeds/loaders/write.tsx"; -import Embedcontainerdocument from "../../../../../src/components/glean-embeds/loaders/containerdocument.tsx"; -import Embedcontent from "../../../../../src/components/glean-embeds/loaders/content.tsx"; -import Embedparentdocument from "../../../../../src/components/glean-embeds/loaders/parentdocument.tsx"; -import Embedsections from "../../../../../src/components/glean-embeds/loaders/sections.tsx"; -import Embedanswer from "../../../../../src/components/glean-embeds/loaders/answer.tsx"; -import Embedanswerauthor from "../../../../../src/components/glean-embeds/loaders/answerauthor.tsx"; - - - - - - - -# Client Answers Endpoints - - - - - - - - - -## POST /rest/api/v1/createanswer \{#operation-createanswer\} - - - - - -_Create Answer_ - - - - - -Create a user-generated Answer that contains a question and answer. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/createanswer \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "data": {} -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createanswer+request-examples\} - - - - - -```json -{ - "data": {} -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createanswer+request\} - - - - - - - -CreateAnswer request - - - - - -AnswerCreationData","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-createanswer+request+data\} - - - - - - - - - -#### AnswerCreationData \{#operation-createanswer+request+data+answercreationdata\} - - - - - - - - - -##### addedCollections \{#operation-createanswer+request+data+answercreationdata+addedcollections\} - - - - - -IDs of Collections to which a document is added. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-createanswer+request+data+answercreationdata+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-createanswer+request+data+answercreationdata+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### boardId \{#operation-createanswer+request+data+answercreationdata+boardid\} - - - - - -The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - - - - - - - - - -##### bodyText \{#operation-createanswer+request+data+answercreationdata+bodytext\} - - - - - -The plain text answer to the question. - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - -StructuredTextMutableProperties","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### combinedAnswerText \{#operation-createanswer+request+data+answercreationdata+combinedanswertext\} - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-createanswer+request+data+answercreationdata+question\} - - - - - -_Example:_ - -``` -Why is the sky blue? -``` - - - - - - - - - -##### questionVariations \{#operation-createanswer+request+data+answercreationdata+questionvariations\} - - - - - -Additional ways of phrasing this question. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-createanswer+request+data+answercreationdata+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-createanswer+request+data+answercreationdata+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### sourceDocumentSpec \{#operation-createanswer+request+data+answercreationdata+sourcedocumentspec\} - - - - - - - - - -##### sourceType \{#operation-createanswer+request+data+answercreationdata+sourcetype\} - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createanswer+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "3" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-createanswer+responses\} - - - - - -200 - - - - - - - -OK - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-createanswer+responses+200+application-json+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-createanswer+responses+200+application-json+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-createanswer+responses+200+application-json+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-createanswer+responses+200+application-json+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-createanswer+responses+200+application-json+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-createanswer+responses+200+application-json+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-createanswer+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-createanswer+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-createanswer+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-createanswer+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-createanswer+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### author \{#operation-createanswer+responses+200+application-json+author\} - - - - - - - - - -#### Person \{#operation-createanswer+responses+200+application-json+author+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createanswer+responses+200+application-json+author+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-createanswer+responses+200+application-json+author+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-createanswer+responses+200+application-json+author+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-createanswer+responses+200+application-json+author+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### board \{#operation-createanswer+responses+200+application-json+board\} - - - - - - - - - -#### AnswerBoard \{#operation-createanswer+responses+200+application-json+board+answerboard\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-createanswer+responses+200+application-json+board+answerboard+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-createanswer+responses+200+application-json+board+answerboard+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-createanswer+responses+200+application-json+board+answerboard+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-createanswer+responses+200+application-json+board+answerboard+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-createanswer+responses+200+application-json+board+answerboard+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### id \{#operation-createanswer+responses+200+application-json+board+answerboard+id\} - - - - - -The unique ID of the Answer Board. - - - - - - - - - -##### itemCount \{#operation-createanswer+responses+200+application-json+board+answerboard+itemcount\} - - - - - -The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - - - - - - - - - -##### name \{#operation-createanswer+responses+200+application-json+board+answerboard+name\} - - - - - -The unique name of the Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-createanswer+responses+200+application-json+board+answerboard+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-createanswer+responses+200+application-json+board+answerboard+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-createanswer+responses+200+application-json+board+answerboard+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-createanswer+responses+200+application-json+board+answerboard+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-createanswer+responses+200+application-json+board+answerboard+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### boardId \{#operation-createanswer+responses+200+application-json+boardid\} - - - - - -The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - - - - - - - - - -##### bodyText \{#operation-createanswer+responses+200+application-json+bodytext\} - - - - - -The plain text answer to the question. - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collections \{#operation-createanswer+responses+200+application-json+collections\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#operation-createanswer+responses+200+application-json+collections+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-createanswer+responses+200+application-json+collections+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-createanswer+responses+200+application-json+collections+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-createanswer+responses+200+application-json+collections+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-createanswer+responses+200+application-json+collections+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-createanswer+responses+200+application-json+collections+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-createanswer+responses+200+application-json+collections+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-createanswer+responses+200+application-json+collections+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-createanswer+responses+200+application-json+collections+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-createanswer+responses+200+application-json+collections+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-createanswer+responses+200+application-json+collections+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-createanswer+responses+200+application-json+collections+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-createanswer+responses+200+application-json+collections+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-createanswer+responses+200+application-json+collections+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-createanswer+responses+200+application-json+collections+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-createanswer+responses+200+application-json+collections+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-createanswer+responses+200+application-json+collections+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-createanswer+responses+200+application-json+collections+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-createanswer+responses+200+application-json+collections+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-createanswer+responses+200+application-json+collections+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-createanswer+responses+200+application-json+collections+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-createanswer+responses+200+application-json+collections+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-createanswer+responses+200+application-json+collections+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-createanswer+responses+200+application-json+collections+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### combinedAnswerText \{#operation-createanswer+responses+200+application-json+combinedanswertext\} - - - - - - - - - -#### StructuredText \{#operation-createanswer+responses+200+application-json+combinedanswertext+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-createanswer+responses+200+application-json+combinedanswertext+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-createanswer+responses+200+application-json+combinedanswertext+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### createTime \{#operation-createanswer+responses+200+application-json+createtime\} - - - - - -The time the answer was created in ISO format (ISO 8601). - - - - - - - - - -##### docId \{#operation-createanswer+responses+200+application-json+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### documentCategory \{#operation-createanswer+responses+200+application-json+documentcategory\} - - - - - -The document's document_category(.proto). - - - - - - - - - -##### id \{#operation-createanswer+responses+200+application-json+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - -AnswerLikes","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes \{#operation-createanswer+responses+200+application-json+likes\} - - - - - - - - - -#### AnswerLikes \{#operation-createanswer+responses+200+application-json+likes+answerlikes\} - - - - - -AnswerLike","children":[{"label":"AnswerLike","linkedLabel":"AnswerLike","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### likedBy \{#operation-createanswer+responses+200+application-json+likes+answerlikes+likedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### likedByUser \{#operation-createanswer+responses+200+application-json+likes+answerlikes+likedbyuser\} - - - - - -Whether the user in context liked the answer. - - - - - - - - - -##### numLikes \{#operation-createanswer+responses+200+application-json+likes+answerlikes+numlikes\} - - - - - -The total number of likes for the answer. - - - - - - - - - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-createanswer+responses+200+application-json+permissions\} - - - - - - - - - -#### ObjectPermissions \{#operation-createanswer+responses+200+application-json+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#operation-createanswer+responses+200+application-json+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-createanswer+responses+200+application-json+question\} - - - - - -_Example:_ - -``` -Why is the sky blue? -``` - - - - - - - - - -##### questionVariations \{#operation-createanswer+responses+200+application-json+questionvariations\} - - - - - -Additional ways of phrasing this question. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-createanswer+responses+200+application-json+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-createanswer+responses+200+application-json+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-createanswer+responses+200+application-json+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-createanswer+responses+200+application-json+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-createanswer+responses+200+application-json+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-createanswer+responses+200+application-json+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### roles \{#operation-createanswer+responses+200+application-json+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-createanswer+responses+200+application-json+roles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-createanswer+responses+200+application-json+roles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-createanswer+responses+200+application-json+roles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-createanswer+responses+200+application-json+roles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-createanswer+responses+200+application-json+roles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-createanswer+responses+200+application-json+sourcedocument\} - - - - - - - - - -#### Document \{#operation-createanswer+responses+200+application-json+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-createanswer+responses+200+application-json+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-createanswer+responses+200+application-json+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-createanswer+responses+200+application-json+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-createanswer+responses+200+application-json+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-createanswer+responses+200+application-json+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-createanswer+responses+200+application-json+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createanswer+responses+200+application-json+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-createanswer+responses+200+application-json+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-createanswer+responses+200+application-json+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-createanswer+responses+200+application-json+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-createanswer+responses+200+application-json+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### sourceDocumentSpec \{#operation-createanswer+responses+200+application-json+sourcedocumentspec\} - - - - - - - - - -##### sourceType \{#operation-createanswer+responses+200+application-json+sourcetype\} - - - - - - - - - -##### updateTime \{#operation-createanswer+responses+200+application-json+updatetime\} - - - - - -The time the answer was last updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-createanswer+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-createanswer+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createanswer+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-createanswer+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-createanswer+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-createanswer+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Verification","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### verification \{#operation-createanswer+responses+200+application-json+verification\} - - - - - - - - - -#### Verification \{#operation-createanswer+responses+200+application-json+verification+verification\} - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-createanswer+responses+200+application-json+verification+verification+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#operation-createanswer+responses+200+application-json+verification+verification+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deleteanswer \{#operation-deleteanswer\} - - - - - -_Delete Answer_ - - - - - -Delete an existing user-generated Answer. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deleteanswer \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "3" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-deleteanswer+request-examples\} - - - - - -```json -{ - "id": "3" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deleteanswer+request\} - - - - - - - -DeleteAnswer request - - - - - - - - - -##### docId \{#operation-deleteanswer+request+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### id \{#operation-deleteanswer+request+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/editanswer \{#operation-editanswer\} - - - - - -_Update Answer_ - - - - - -Update an existing user-generated Answer. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/editanswer \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "3" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-editanswer+request-examples\} - - - - - -```json -{ - "id": "3" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-editanswer+request\} - - - - - - - -EditAnswer request - - - - - - - - - -##### addedCollections \{#operation-editanswer+request+addedcollections\} - - - - - -IDs of Collections to which a document is added. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-editanswer+request+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+request+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+request+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+request+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+request+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+request+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editanswer+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editanswer+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editanswer+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editanswer+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editanswer+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### boardId \{#operation-editanswer+request+boardid\} - - - - - -The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - - - - - - - - - -##### bodyText \{#operation-editanswer+request+bodytext\} - - - - - -The plain text answer to the question. - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - -StructuredTextMutableProperties","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### combinedAnswerText \{#operation-editanswer+request+combinedanswertext\} - - - - - - - - - -#### StructuredTextMutableProperties \{#operation-editanswer+request+combinedanswertext+structuredtextmutableproperties\} - - - - - - - - - -##### text \{#operation-editanswer+request+combinedanswertext+structuredtextmutableproperties+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### docId \{#operation-editanswer+request+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### id \{#operation-editanswer+request+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - - - - - -##### question \{#operation-editanswer+request+question\} - - - - - -_Example:_ - -``` -Why is the sky blue? -``` - - - - - - - - - -##### questionVariations \{#operation-editanswer+request+questionvariations\} - - - - - -Additional ways of phrasing this question. - - - - - - - - - -##### removedCollections \{#operation-editanswer+request+removedcollections\} - - - - - -IDs of Collections from which a document is removed. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-editanswer+request+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+request+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+request+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+request+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+request+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+request+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### roles \{#operation-editanswer+request+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+request+roles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+request+roles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+request+roles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+request+roles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+request+roles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+request+sourcedocumentspec\} - - - - - - - - - -##### sourceType \{#operation-editanswer+request+sourcetype\} - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-editanswer+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "3" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-editanswer+responses\} - - - - - -200 - - - - - - - -OK - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-editanswer+responses+200+application-json+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+responses+200+application-json+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+responses+200+application-json+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+responses+200+application-json+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+responses+200+application-json+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+responses+200+application-json+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editanswer+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editanswer+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editanswer+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editanswer+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editanswer+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### author \{#operation-editanswer+responses+200+application-json+author\} - - - - - - - - - -#### Person \{#operation-editanswer+responses+200+application-json+author+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editanswer+responses+200+application-json+author+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editanswer+responses+200+application-json+author+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editanswer+responses+200+application-json+author+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editanswer+responses+200+application-json+author+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### board \{#operation-editanswer+responses+200+application-json+board\} - - - - - - - - - -#### AnswerBoard \{#operation-editanswer+responses+200+application-json+board+answerboard\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-editanswer+responses+200+application-json+board+answerboard+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-editanswer+responses+200+application-json+board+answerboard+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editanswer+responses+200+application-json+board+answerboard+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-editanswer+responses+200+application-json+board+answerboard+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editanswer+responses+200+application-json+board+answerboard+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### id \{#operation-editanswer+responses+200+application-json+board+answerboard+id\} - - - - - -The unique ID of the Answer Board. - - - - - - - - - -##### itemCount \{#operation-editanswer+responses+200+application-json+board+answerboard+itemcount\} - - - - - -The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - - - - - - - - - -##### name \{#operation-editanswer+responses+200+application-json+board+answerboard+name\} - - - - - -The unique name of the Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-editanswer+responses+200+application-json+board+answerboard+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-editanswer+responses+200+application-json+board+answerboard+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-editanswer+responses+200+application-json+board+answerboard+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editanswer+responses+200+application-json+board+answerboard+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-editanswer+responses+200+application-json+board+answerboard+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### boardId \{#operation-editanswer+responses+200+application-json+boardid\} - - - - - -The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - - - - - - - - - -##### bodyText \{#operation-editanswer+responses+200+application-json+bodytext\} - - - - - -The plain text answer to the question. - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collections \{#operation-editanswer+responses+200+application-json+collections\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#operation-editanswer+responses+200+application-json+collections+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-editanswer+responses+200+application-json+collections+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editanswer+responses+200+application-json+collections+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editanswer+responses+200+application-json+collections+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-editanswer+responses+200+application-json+collections+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-editanswer+responses+200+application-json+collections+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-editanswer+responses+200+application-json+collections+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editanswer+responses+200+application-json+collections+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-editanswer+responses+200+application-json+collections+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editanswer+responses+200+application-json+collections+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-editanswer+responses+200+application-json+collections+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editanswer+responses+200+application-json+collections+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-editanswer+responses+200+application-json+collections+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-editanswer+responses+200+application-json+collections+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editanswer+responses+200+application-json+collections+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editanswer+responses+200+application-json+collections+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-editanswer+responses+200+application-json+collections+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-editanswer+responses+200+application-json+collections+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-editanswer+responses+200+application-json+collections+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-editanswer+responses+200+application-json+collections+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-editanswer+responses+200+application-json+collections+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-editanswer+responses+200+application-json+collections+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editanswer+responses+200+application-json+collections+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-editanswer+responses+200+application-json+collections+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### combinedAnswerText \{#operation-editanswer+responses+200+application-json+combinedanswertext\} - - - - - - - - - -#### StructuredText \{#operation-editanswer+responses+200+application-json+combinedanswertext+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#operation-editanswer+responses+200+application-json+combinedanswertext+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-editanswer+responses+200+application-json+combinedanswertext+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editanswer+responses+200+application-json+createtime\} - - - - - -The time the answer was created in ISO format (ISO 8601). - - - - - - - - - -##### docId \{#operation-editanswer+responses+200+application-json+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### documentCategory \{#operation-editanswer+responses+200+application-json+documentcategory\} - - - - - -The document's document_category(.proto). - - - - - - - - - -##### id \{#operation-editanswer+responses+200+application-json+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - -AnswerLikes","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes \{#operation-editanswer+responses+200+application-json+likes\} - - - - - - - - - -#### AnswerLikes \{#operation-editanswer+responses+200+application-json+likes+answerlikes\} - - - - - -AnswerLike","children":[{"label":"AnswerLike","linkedLabel":"AnswerLike","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### likedBy \{#operation-editanswer+responses+200+application-json+likes+answerlikes+likedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### likedByUser \{#operation-editanswer+responses+200+application-json+likes+answerlikes+likedbyuser\} - - - - - -Whether the user in context liked the answer. - - - - - - - - - -##### numLikes \{#operation-editanswer+responses+200+application-json+likes+answerlikes+numlikes\} - - - - - -The total number of likes for the answer. - - - - - - - - - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-editanswer+responses+200+application-json+permissions\} - - - - - - - - - -#### ObjectPermissions \{#operation-editanswer+responses+200+application-json+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#operation-editanswer+responses+200+application-json+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-editanswer+responses+200+application-json+question\} - - - - - -_Example:_ - -``` -Why is the sky blue? -``` - - - - - - - - - -##### questionVariations \{#operation-editanswer+responses+200+application-json+questionvariations\} - - - - - -Additional ways of phrasing this question. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-editanswer+responses+200+application-json+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+responses+200+application-json+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+responses+200+application-json+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+responses+200+application-json+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+responses+200+application-json+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+responses+200+application-json+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### roles \{#operation-editanswer+responses+200+application-json+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editanswer+responses+200+application-json+roles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editanswer+responses+200+application-json+roles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editanswer+responses+200+application-json+roles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editanswer+responses+200+application-json+roles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+responses+200+application-json+roles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-editanswer+responses+200+application-json+sourcedocument\} - - - - - - - - - -#### Document \{#operation-editanswer+responses+200+application-json+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-editanswer+responses+200+application-json+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-editanswer+responses+200+application-json+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-editanswer+responses+200+application-json+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-editanswer+responses+200+application-json+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-editanswer+responses+200+application-json+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-editanswer+responses+200+application-json+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editanswer+responses+200+application-json+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-editanswer+responses+200+application-json+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-editanswer+responses+200+application-json+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-editanswer+responses+200+application-json+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-editanswer+responses+200+application-json+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### sourceDocumentSpec \{#operation-editanswer+responses+200+application-json+sourcedocumentspec\} - - - - - - - - - -##### sourceType \{#operation-editanswer+responses+200+application-json+sourcetype\} - - - - - - - - - -##### updateTime \{#operation-editanswer+responses+200+application-json+updatetime\} - - - - - -The time the answer was last updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-editanswer+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-editanswer+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editanswer+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editanswer+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editanswer+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editanswer+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Verification","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### verification \{#operation-editanswer+responses+200+application-json+verification\} - - - - - - - - - -#### Verification \{#operation-editanswer+responses+200+application-json+verification+verification\} - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editanswer+responses+200+application-json+verification+verification+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#operation-editanswer+responses+200+application-json+verification+verification+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getanswer \{#operation-getanswer\} - - - - - -_Read Answer_ - - - - - -Read the details of a particular Answer given its ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getanswer \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getanswer+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getanswer+request\} - - - - - - - -GetAnswer request - - - - - - - - - -##### docId \{#operation-getanswer+request+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### id \{#operation-getanswer+request+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getanswer+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getanswer+responses\} - - - - - -200 - - - - - - - -OK - - - - - -AnswerResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answerResult \{#operation-getanswer+responses+200+application-json+answerresult\} - - - - - - - - - -#### AnswerResult \{#operation-getanswer+responses+200+application-json+answerresult+answerresult\} - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#operation-getanswer+responses+200+application-json+answerresult+answerresult+answer\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-getanswer+responses+200+application-json+answerresult+answerresult+trackingtoken\} - - - - - -An opaque token that represents this particular Answer. To be used for `/feedback` reporting. - - - - - - - - - - - - - -GetAnswerError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-getanswer+responses+200+application-json+error\} - - - - - - - - - -#### GetAnswerError \{#operation-getanswer+responses+200+application-json+error+getanswererror\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerAuthor \{#operation-getanswer+responses+200+application-json+error+getanswererror+answerauthor\} - - - - - - - - - - - - - - - - - - - - - - - -##### errorType \{#operation-getanswer+responses+200+application-json+error+getanswererror+errortype\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listanswers \{#operation-listanswers\} - - - - - -_List Answers_ - - - - - -List Answers created by the current user. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listanswers \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-listanswers+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-listanswers+request\} - - - - - - - -ListAnswers request - - - - - - - - - -##### boardId \{#operation-listanswers+request+boardid\} - - - - - -The Answer Board Id to list answers on. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listanswers+responses-examples\} - - - - - -200 - - - - - -```json -{ - "answerResults": [ - { - "answer": { - "id": "3" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-listanswers+responses\} - - - - - -200 - - - - - - - -OK - - - - - -AnswerResult","children":[{"label":"AnswerResult","linkedLabel":"AnswerResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answerResults \{#operation-listanswers+responses+200+application-json+answerresults\} - - - - - -List of answers with tracking tokens. - - - - - - - - - -#### AnswerResult \{#operation-listanswers+responses+200+application-json+answerresults+answerresult\} - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#operation-listanswers+responses+200+application-json+answerresults+answerresult+answer\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-listanswers+responses+200+application-json+answerresults+answerresult+trackingtoken\} - - - - - -An opaque token that represents this particular Answer. To be used for `/feedback` reporting. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/authentication.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/authentication.mdx deleted file mode 100644 index d1c198ea2..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/authentication.mdx +++ /dev/null @@ -1,248 +0,0 @@ ---- -sidebar_position: 3.4 -sidebar_label: Client Authentication ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableProperty, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Client Authentication Endpoints - - - - - - - - - -## POST /rest/api/v1/createauthtoken \{#operation-createauthtoken\} - - - - - -_Create authentication token_ - - - - - -Creates an authentication token for the authenticated user. These are -specifically intended to be used with the [Web SDK](https://developers.glean.com/web). - -Note: The tokens generated from this endpoint are **not** valid tokens -for use with the Client API (e.g. `/rest/api/v1/*`). - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/createauthtoken \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - - - - - -### Responses Examples \{#operation-createauthtoken+responses-examples\} - - - - - -200 - - - - - -```json -{ - "expirationTime": 87, - "token": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-createauthtoken+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### expirationTime \{#operation-createauthtoken+responses+200+application-json+expirationtime\} - - - - - -Unix timestamp for when this token expires (in seconds since epoch UTC). - - - - - - - - - -##### token \{#operation-createauthtoken+responses+200+application-json+token\} - - - - - -An authentication token that can be passed to any endpoint via Bearer Authentication - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/chat.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/chat.mdx deleted file mode 100644 index 5d6b02d93..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/chat.mdx +++ /dev/null @@ -1,5839 +0,0 @@ ---- -sidebar_position: 3.5 -sidebar_label: Client Chat ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedagentconfig from "../../../../../src/components/glean-embeds/loaders/agentconfig.tsx"; -import Embedcitations from "../../../../../src/components/glean-embeds/loaders/citations.tsx"; -import Embedfragments from "../../../../../src/components/glean-embeds/loaders/fragments.tsx"; -import Embedchat from "../../../../../src/components/glean-embeds/loaders/chat.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; - - - - - - - -# Client Chat Endpoints - - - - - - - - - -## POST /rest/api/v1/chat \{#operation-chat\} - - - - - -_Chat_ - - - - - -Have a conversation with Glean AI. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/chat \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "messages": [ - {} - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-chat+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-chat+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Examples \{#operation-chat+request-examples\} - - - - - -```json -{ - "messages": [ - { - "author": "USER", - "messageType": "CONTENT", - "fragments": [ - { - "text": "What are the company holidays this year?" - } - ] - } - ] -} -``` - -```json -{ - "agentConfig": { - "agent": "GPT" - }, - "messages": [ - { - "author": "USER", - "messageType": "CONTENT", - "fragments": [ - { - "text": "Who was the first person to land on the moon?" - } - ] - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-chat+request\} - - - - - - - -Includes chat history for Glean AI to respond to. - - - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### agentConfig \{#operation-chat+request+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -#### AgentConfig \{#operation-chat+request+agentconfig+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -##### agent \{#operation-chat+request+agentconfig+agentconfig+agent\} - - - - - -Name of the agent. - - - - - - - - - -##### mode \{#operation-chat+request+agentconfig+agentconfig+mode\} - - - - - -Top level modes to run GleanChat in. - - - - - - - - - - - - - - - - - -##### agentId \{#operation-chat+request+agentid\} - - - - - -The ID of the Agent that should process this chat request. Only Agents with trigger set to 'User chat message' are invokable through this API. If not specified, the default chat experience will be used. - - - - - - - - - -##### applicationId \{#operation-chat+request+applicationid\} - - - - - -The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used. - - - - - - - - - -##### chatId \{#operation-chat+request+chatid\} - - - - - -The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true. - - - - - -ChatRestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### exclusions \{#operation-chat+request+exclusions\} - - - - - - - - - -#### ChatRestrictionFilters \{#operation-chat+request+exclusions+chatrestrictionfilters\} - - - - - - - - - -##### containerSpecs \{#operation-chat+request+exclusions+chatrestrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### datasourceInstances \{#operation-chat+request+exclusions+chatrestrictionfilters+datasourceinstances\} - - - - - - - - - -##### documentSpecs \{#operation-chat+request+exclusions+chatrestrictionfilters+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - -ChatRestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inclusions \{#operation-chat+request+inclusions\} - - - - - - - - - -#### ChatRestrictionFilters \{#operation-chat+request+inclusions+chatrestrictionfilters\} - - - - - - - - - -##### containerSpecs \{#operation-chat+request+inclusions+chatrestrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### datasourceInstances \{#operation-chat+request+inclusions+chatrestrictionfilters+datasourceinstances\} - - - - - - - - - -##### documentSpecs \{#operation-chat+request+inclusions+chatrestrictionfilters+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - -ChatMessage","children":[{"label":"ChatMessage","linkedLabel":"ChatMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-chat+request+messages\} - - - - - -A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - - - - - - - - - -#### ChatMessage \{#operation-chat+request+messages+chatmessage\} - - - - - -A message that is rendered as one coherent unit with one given sender. - - - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### agentConfig \{#operation-chat+request+messages+chatmessage+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - - - - - - - - - - - - - - - -##### author \{#operation-chat+request+messages+chatmessage+author\} - - - - - -_Default Value:_ `"USER"` - - - - - -ChatMessageCitation","children":[{"label":"ChatMessageCitation","linkedLabel":"ChatMessageCitation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### citations \{#operation-chat+request+messages+chatmessage+citations\} - - - - - -A list of Citations that were used to generate the response. - - - - - - - - - - - - - - - - - - - -ChatMessageFragment","children":[{"label":"ChatMessageFragment","linkedLabel":"ChatMessageFragment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### fragments \{#operation-chat+request+messages+chatmessage+fragments\} - - - - - -A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - - - - - - - - - - - - - - - - - - - - - - - -##### hasMoreFragments \{#operation-chat+request+messages+chatmessage+hasmorefragments\} - - - - - -Signals there are additional response fragments incoming. - - - - - - - - - -##### messageId \{#operation-chat+request+messages+chatmessage+messageid\} - - - - - -A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - - - - - - - - - -##### messageTrackingToken \{#operation-chat+request+messages+chatmessage+messagetrackingtoken\} - - - - - -Opaque tracking token generated server-side. - - - - - - - - - -##### messageType \{#operation-chat+request+messages+chatmessage+messagetype\} - - - - - -Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - - - - - -_Default Value:_ `"CONTENT"` - - - - - - - - - -##### ts \{#operation-chat+request+messages+chatmessage+ts\} - - - - - -Response timestamp of the message. - - - - - - - - - -##### uploadedFileIds \{#operation-chat+request+messages+chatmessage+uploadedfileids\} - - - - - -IDs of files uploaded in the message that are referenced to generate the answer. - - - - - - - - - - - - - - - - - -##### saveChat \{#operation-chat+request+savechat\} - - - - - -Save the current interaction as a Chat for the user to access and potentially continue later. - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-chat+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-chat+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-chat+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-chat+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-chat+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-chat+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### stream \{#operation-chat+request+stream\} - - - - - -If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be. - - - - - - - - - -##### timeoutMillis \{#operation-chat+request+timeoutmillis\} - - - - - -Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - - - - - -_Example:_ - -``` -30000 -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-chat+responses-examples\} - - - - - -200 - - - - - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "hasMoreFragments": false, - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "fragments": [ - { - "text": "There are no holidays!" - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": null - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": null - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": [ - { - "text": "e are" - } - ] - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": [ - { - "text": "no hol" - } - ] - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": false - }, - "fragments": [ - { - "text": "idays!" - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "UPDATE", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "fragments": [ - { - "text": "**Reading:**" - }, - { - "structuredResults": [ - { - "document": { - "id": "123", - "title": "Company Handbook" - } - } - ] - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "citations": [ - { - "sourceDocument": { - "id": "123", - "title": "Company Handbook", - "referenceRanges": [ - { - "textRange": { - "startIndex": 0, - "endIndex": 12, - "type": "CITATION" - } - } - ] - } - } - ] - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### backendTimeMillis \{#operation-chat+responses+200+application-json+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - - - - - -##### chatId \{#operation-chat+responses+200+application-json+chatid\} - - - - - -The id of the associated Chat the messages belong to, if one exists. - - - - - - - - - -##### chatSessionTrackingToken \{#operation-chat+responses+200+application-json+chatsessiontrackingtoken\} - - - - - -A token that is used to track the session. - - - - - - - - - -##### followUpPrompts \{#operation-chat+responses+200+application-json+followupprompts\} - - - - - -Follow-up prompts for the user to potentially use - - - - - -ChatMessage","children":[{"label":"ChatMessage","linkedLabel":"ChatMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-chat+responses+200+application-json+messages\} - - - - - -A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - - - - - - - - - -#### ChatMessage \{#operation-chat+responses+200+application-json+messages+chatmessage\} - - - - - -A message that is rendered as one coherent unit with one given sender. - - - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### agentConfig \{#operation-chat+responses+200+application-json+messages+chatmessage+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - - - - - - - - - - - - - - - -##### author \{#operation-chat+responses+200+application-json+messages+chatmessage+author\} - - - - - -_Default Value:_ `"USER"` - - - - - -ChatMessageCitation","children":[{"label":"ChatMessageCitation","linkedLabel":"ChatMessageCitation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### citations \{#operation-chat+responses+200+application-json+messages+chatmessage+citations\} - - - - - -A list of Citations that were used to generate the response. - - - - - - - - - - - - - - - - - - - -ChatMessageFragment","children":[{"label":"ChatMessageFragment","linkedLabel":"ChatMessageFragment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### fragments \{#operation-chat+responses+200+application-json+messages+chatmessage+fragments\} - - - - - -A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - - - - - - - - - - - - - - - - - - - - - - - -##### hasMoreFragments \{#operation-chat+responses+200+application-json+messages+chatmessage+hasmorefragments\} - - - - - -Signals there are additional response fragments incoming. - - - - - - - - - -##### messageId \{#operation-chat+responses+200+application-json+messages+chatmessage+messageid\} - - - - - -A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - - - - - - - - - -##### messageTrackingToken \{#operation-chat+responses+200+application-json+messages+chatmessage+messagetrackingtoken\} - - - - - -Opaque tracking token generated server-side. - - - - - - - - - -##### messageType \{#operation-chat+responses+200+application-json+messages+chatmessage+messagetype\} - - - - - -Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - - - - - -_Default Value:_ `"CONTENT"` - - - - - - - - - -##### ts \{#operation-chat+responses+200+application-json+messages+chatmessage+ts\} - - - - - -Response timestamp of the message. - - - - - - - - - -##### uploadedFileIds \{#operation-chat+responses+200+application-json+messages+chatmessage+uploadedfileids\} - - - - - -IDs of files uploaded in the message that are referenced to generate the answer. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deleteallchats \{#operation-deleteallchats\} - - - - - -_Deletes all saved Chats owned by a user_ - - - - - -Deletes all saved Chats a user has had and all their contained conversational content. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deleteallchats \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-deleteallchats+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-deleteallchats+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/deletechats \{#operation-deletechats\} - - - - - -_Deletes saved Chats_ - - - - - -Deletes saved Chats and all their contained conversational content. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deletechats \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "ids": [ - "ipsum eiusmod" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-deletechats+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-deletechats+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-deletechats+request-examples\} - - - - - -```json -{ - "ids": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deletechats+request\} - - - - - - - - - - - -##### ids \{#operation-deletechats+request+ids\} - - - - - -A non-empty list of ids of the Chats to be deleted. - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/getchat \{#operation-getchat\} - - - - - -_Retrieves a Chat_ - - - - - -Retrieves the chat history between Glean Assistant and the user for a given Chat. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getchat \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getchat+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-getchat+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-getchat+request-examples\} - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getchat+request\} - - - - - - - - - - - -##### id \{#operation-getchat+request+id\} - - - - - -The id of the Chat to be retrieved. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getchat+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getchat+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ChatResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chatResult \{#operation-getchat+responses+200+application-json+chatresult\} - - - - - - - - - -#### ChatResult \{#operation-getchat+responses+200+application-json+chatresult+chatresult\} - - - - - -Chat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chat \{#operation-getchat+responses+200+application-json+chatresult+chatresult+chat\} - - - - - -A historical representation of a series of chat messages a user had with Glean Assistant. - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-getchat+responses+200+application-json+chatresult+chatresult+trackingtoken\} - - - - - -An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listchats \{#operation-listchats\} - - - - - -_Retrieves all saved Chats_ - - - - - -Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listchats \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-listchats+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-listchats+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listchats+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-listchats+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ChatMetadataResult","children":[{"label":"ChatMetadataResult","linkedLabel":"ChatMetadataResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chatResults \{#operation-listchats+responses+200+application-json+chatresults\} - - - - - - - - - -#### ChatMetadataResult \{#operation-listchats+responses+200+application-json+chatresults+chatmetadataresult\} - - - - - -ChatMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chat \{#operation-listchats+responses+200+application-json+chatresults+chatmetadataresult+chat\} - - - - - -Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-listchats+responses+200+application-json+chatresults+chatmetadataresult+trackingtoken\} - - - - - -An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getchatapplication \{#operation-getchatapplication\} - - - - - -_Gets the metadata for a custom Chat application_ - - - - - -Gets the Chat application details for the specified application ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getchatapplication \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getchatapplication+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-getchatapplication+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-getchatapplication+request-examples\} - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getchatapplication+request\} - - - - - - - - - - - -##### id \{#operation-getchatapplication+request+id\} - - - - - -The id of the Chat application to be retrieved. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getchatapplication+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getchatapplication+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### application \{#operation-getchatapplication+responses+200+application-json+application\} - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/uploadchatfiles \{#operation-uploadchatfiles\} - - - - - -_Upload files for Chat._ - - - - - -Upload files for Chat. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/uploadchatfiles \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "files": [ - { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-uploadchatfiles+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-uploadchatfiles+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-uploadchatfiles+request-examples\} - - - - - -```json -{ - "files": [ - { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-uploadchatfiles+request\} - - - - - - - -file","children":[{"label":"file","linkedLabel":"file","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### files \{#operation-uploadchatfiles+request+files\} - - - - - -Raw files to be uploaded for chat in binary format. - - - - - - - - - -#### file \{#operation-uploadchatfiles+request+files+file\} - - - - - - - - - -##### content \{#operation-uploadchatfiles+request+files+file+content\} - - - - - - - - - -##### fileName \{#operation-uploadchatfiles+request+files+file+filename\} - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-uploadchatfiles+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-uploadchatfiles+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ChatFile","children":[{"label":"ChatFile","linkedLabel":"ChatFile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### files \{#operation-uploadchatfiles+responses+200+application-json+files\} - - - - - -Files uploaded for chat. - - - - - - - - - -#### ChatFile \{#operation-uploadchatfiles+responses+200+application-json+files+chatfile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -##### id \{#operation-uploadchatfiles+responses+200+application-json+files+chatfile+id\} - - - - - -Unique identifier of the file. - - - - - -_Example:_ - -``` -FILE_1234 -``` - - - - - -ChatFileMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-uploadchatfiles+responses+200+application-json+files+chatfile+metadata\} - - - - - -Metadata of a file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-uploadchatfiles+responses+200+application-json+files+chatfile+name\} - - - - - -Name of the uploaded file. - - - - - -_Example:_ - -``` -sample.pdf -``` - - - - - - - - - -##### url \{#operation-uploadchatfiles+responses+200+application-json+files+chatfile+url\} - - - - - -Url of the file. - - - - - -_Example:_ - -``` -www.google.com -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getchatfiles \{#operation-getchatfiles\} - - - - - -_Get files uploaded by a user for Chat._ - - - - - -Get files uploaded by a user for Chat. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getchatfiles \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "fileIds": [ - "ipsum eiusmod" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getchatfiles+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-getchatfiles+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-getchatfiles+request-examples\} - - - - - -```json -{ - "fileIds": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getchatfiles+request\} - - - - - - - - - - - -##### chatId \{#operation-getchatfiles+request+chatid\} - - - - - -The ID of the chat that contains the chat file. - - - - - - - - - -##### fileIds \{#operation-getchatfiles+request+fileids\} - - - - - -IDs of files to fetch. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getchatfiles+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getchatfiles+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ChatFile","children":[{"label":"ChatFile","linkedLabel":"ChatFile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### files \{#operation-getchatfiles+responses+200+application-json+files\} - - - - - -A map of file IDs to ChatFile structs. - - - - - - - - - -#### ChatFile \{#operation-getchatfiles+responses+200+application-json+files+chatfile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -##### id \{#operation-getchatfiles+responses+200+application-json+files+chatfile+id\} - - - - - -Unique identifier of the file. - - - - - -_Example:_ - -``` -FILE_1234 -``` - - - - - -ChatFileMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-getchatfiles+responses+200+application-json+files+chatfile+metadata\} - - - - - -Metadata of a file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-getchatfiles+responses+200+application-json+files+chatfile+name\} - - - - - -Name of the uploaded file. - - - - - -_Example:_ - -``` -sample.pdf -``` - - - - - - - - - -##### url \{#operation-getchatfiles+responses+200+application-json+files+chatfile+url\} - - - - - -Url of the file. - - - - - -_Example:_ - -``` -www.google.com -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deletechatfiles \{#operation-deletechatfiles\} - - - - - -_Delete files uploaded by a user for chat._ - - - - - -Delete files uploaded by a user for Chat. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deletechatfiles \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "fileIds": [ - "ipsum eiusmod" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-deletechatfiles+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-deletechatfiles+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-deletechatfiles+request-examples\} - - - - - -```json -{ - "fileIds": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deletechatfiles+request\} - - - - - - - - - - - -##### fileIds \{#operation-deletechatfiles+request+fileids\} - - - - - -IDs of files to delete. - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/chat\#stream \{#operation-chat_stream\} - - - - - -_Chat_ - - - - - -Have a conversation with Glean AI. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/chat#stream \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "messages": [ - {} - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-chat_stream+parameters\} - - - - - - - - - - - -##### timezoneOffset \{#operation-chat_stream+parameters+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Examples \{#operation-chat_stream+request-examples\} - - - - - -```json -{ - "messages": [ - { - "author": "USER", - "messageType": "CONTENT", - "fragments": [ - { - "text": "What are the company holidays this year?" - } - ] - } - ] -} -``` - -```json -{ - "agentConfig": { - "agent": "GPT" - }, - "messages": [ - { - "author": "USER", - "messageType": "CONTENT", - "fragments": [ - { - "text": "Who was the first person to land on the moon?" - } - ] - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-chat_stream+request\} - - - - - - - -Includes chat history for Glean AI to respond to. - - - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### agentConfig \{#operation-chat_stream+request+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -#### AgentConfig \{#operation-chat_stream+request+agentconfig+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -##### agent \{#operation-chat_stream+request+agentconfig+agentconfig+agent\} - - - - - -Name of the agent. - - - - - - - - - -##### mode \{#operation-chat_stream+request+agentconfig+agentconfig+mode\} - - - - - -Top level modes to run GleanChat in. - - - - - - - - - - - - - - - - - -##### agentId \{#operation-chat_stream+request+agentid\} - - - - - -The ID of the Agent that should process this chat request. Only Agents with trigger set to 'User chat message' are invokable through this API. If not specified, the default chat experience will be used. - - - - - - - - - -##### applicationId \{#operation-chat_stream+request+applicationid\} - - - - - -The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used. - - - - - - - - - -##### chatId \{#operation-chat_stream+request+chatid\} - - - - - -The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true. - - - - - -ChatRestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### exclusions \{#operation-chat_stream+request+exclusions\} - - - - - - - - - -#### ChatRestrictionFilters \{#operation-chat_stream+request+exclusions+chatrestrictionfilters\} - - - - - - - - - -##### containerSpecs \{#operation-chat_stream+request+exclusions+chatrestrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### datasourceInstances \{#operation-chat_stream+request+exclusions+chatrestrictionfilters+datasourceinstances\} - - - - - - - - - -##### documentSpecs \{#operation-chat_stream+request+exclusions+chatrestrictionfilters+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - -ChatRestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inclusions \{#operation-chat_stream+request+inclusions\} - - - - - - - - - -#### ChatRestrictionFilters \{#operation-chat_stream+request+inclusions+chatrestrictionfilters\} - - - - - - - - - -##### containerSpecs \{#operation-chat_stream+request+inclusions+chatrestrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### datasourceInstances \{#operation-chat_stream+request+inclusions+chatrestrictionfilters+datasourceinstances\} - - - - - - - - - -##### documentSpecs \{#operation-chat_stream+request+inclusions+chatrestrictionfilters+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - -ChatMessage","children":[{"label":"ChatMessage","linkedLabel":"ChatMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-chat_stream+request+messages\} - - - - - -A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - - - - - - - - - -#### ChatMessage \{#operation-chat_stream+request+messages+chatmessage\} - - - - - -A message that is rendered as one coherent unit with one given sender. - - - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### agentConfig \{#operation-chat_stream+request+messages+chatmessage+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - - - - - - - - - - - - - - - -##### author \{#operation-chat_stream+request+messages+chatmessage+author\} - - - - - -_Default Value:_ `"USER"` - - - - - -ChatMessageCitation","children":[{"label":"ChatMessageCitation","linkedLabel":"ChatMessageCitation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### citations \{#operation-chat_stream+request+messages+chatmessage+citations\} - - - - - -A list of Citations that were used to generate the response. - - - - - - - - - - - - - - - - - - - -ChatMessageFragment","children":[{"label":"ChatMessageFragment","linkedLabel":"ChatMessageFragment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### fragments \{#operation-chat_stream+request+messages+chatmessage+fragments\} - - - - - -A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - - - - - - - - - - - - - - - - - - - - - - - -##### hasMoreFragments \{#operation-chat_stream+request+messages+chatmessage+hasmorefragments\} - - - - - -Signals there are additional response fragments incoming. - - - - - - - - - -##### messageId \{#operation-chat_stream+request+messages+chatmessage+messageid\} - - - - - -A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - - - - - - - - - -##### messageTrackingToken \{#operation-chat_stream+request+messages+chatmessage+messagetrackingtoken\} - - - - - -Opaque tracking token generated server-side. - - - - - - - - - -##### messageType \{#operation-chat_stream+request+messages+chatmessage+messagetype\} - - - - - -Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - - - - - -_Default Value:_ `"CONTENT"` - - - - - - - - - -##### ts \{#operation-chat_stream+request+messages+chatmessage+ts\} - - - - - -Response timestamp of the message. - - - - - - - - - -##### uploadedFileIds \{#operation-chat_stream+request+messages+chatmessage+uploadedfileids\} - - - - - -IDs of files uploaded in the message that are referenced to generate the answer. - - - - - - - - - - - - - - - - - -##### saveChat \{#operation-chat_stream+request+savechat\} - - - - - -Save the current interaction as a Chat for the user to access and potentially continue later. - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-chat_stream+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-chat_stream+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-chat_stream+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-chat_stream+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-chat_stream+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-chat_stream+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### stream \{#operation-chat_stream+request+stream\} - - - - - -If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be. - - - - - - - - - -##### timeoutMillis \{#operation-chat_stream+request+timeoutmillis\} - - - - - -Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - - - - - -_Example:_ - -``` -30000 -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-chat_stream+responses-examples\} - - - - - -200 - - - - - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "hasMoreFragments": false, - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "fragments": [ - { - "text": "There are no holidays!" - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": null - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": null - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": [ - { - "text": "e are" - } - ] - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": true - }, - "fragments": [ - { - "text": "no hol" - } - ] - }, - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT", - "hasMoreFragments": false - }, - "fragments": [ - { - "text": "idays!" - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "UPDATE", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "fragments": [ - { - "text": "**Reading:**" - }, - { - "structuredResults": [ - { - "document": { - "id": "123", - "title": "Company Handbook" - } - } - ] - } - ] - } - ] -} -``` - -```json -{ - "messages": [ - { - "author": "GLEAN_AI", - "messageType": "CONTENT", - "agentConfig": { - "agent": "DEFAULT", - "mode": "DEFAULT" - }, - "citations": [ - { - "sourceDocument": { - "id": "123", - "title": "Company Handbook", - "referenceRanges": [ - { - "textRange": { - "startIndex": 0, - "endIndex": 12, - "type": "CITATION" - } - } - ] - } - } - ] - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_stream+responses\} - - - - - -200 - - - - - - - - - - - - - -OK - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/collections.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/collections.mdx deleted file mode 100644 index 0e1e7106c..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/collections.mdx +++ /dev/null @@ -1,12345 +0,0 @@ ---- -sidebar_position: 3.6 -sidebar_label: Client Collections ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../../../../../src/components/glean-embeds/loaders/addedroles.tsx"; -import Embedaudiencefilters from "../../../../../src/components/glean-embeds/loaders/audiencefilters.tsx"; -import Embedchildren from "../../../../../src/components/glean-embeds/loaders/children.tsx"; -import Embedcreator from "../../../../../src/components/glean-embeds/loaders/creator.tsx"; -import Embeditems from "../../../../../src/components/glean-embeds/loaders/items.tsx"; -import Embedpermissions from "../../../../../src/components/glean-embeds/loaders/permissions.tsx"; -import Embedpinmetadata from "../../../../../src/components/glean-embeds/loaders/pinmetadata.tsx"; -import Embedremovedroles from "../../../../../src/components/glean-embeds/loaders/removedroles.tsx"; -import Embedroles from "../../../../../src/components/glean-embeds/loaders/roles.tsx"; -import Embedthumbnail from "../../../../../src/components/glean-embeds/loaders/thumbnail.tsx"; -import Embedupdatedby from "../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; -import Embedgroup from "../../../../../src/components/glean-embeds/loaders/group.tsx"; -import Embedperson from "../../../../../src/components/glean-embeds/loaders/person.tsx"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedcollection from "../../../../../src/components/glean-embeds/loaders/collection.tsx"; -import Embedcreatedby from "../../../../../src/components/glean-embeds/loaders/createdby.tsx"; -import Embeddocument from "../../../../../src/components/glean-embeds/loaders/document.tsx"; -import Embedshortcut from "../../../../../src/components/glean-embeds/loaders/shortcut.tsx"; -import Embedwrite from "../../../../../src/components/glean-embeds/loaders/write.tsx"; -import Embedeligiblepins from "../../../../../src/components/glean-embeds/loaders/eligiblepins.tsx"; -import Embedexistingpins from "../../../../../src/components/glean-embeds/loaders/existingpins.tsx"; - - - - - - - -# Client Collections Endpoints - - - - - - - - - -## POST /rest/api/v1/addcollectionitems \{#operation-addcollectionitems\} - - - - - -_Add Collection item_ - - - - - -Add items to a Collection. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/addcollectionitems \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "collectionId": 87 -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-addcollectionitems+request-examples\} - - - - - -```json -{ - "collectionId": 87 -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-addcollectionitems+request\} - - - - - - - -Data describing the add operation. - - - - - -CollectionItemDescriptor","children":[{"label":"CollectionItemDescriptor","linkedLabel":"CollectionItemDescriptor","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedCollectionItemDescriptors \{#operation-addcollectionitems+request+addedcollectionitemdescriptors\} - - - - - -The CollectionItemDescriptors of the items being added. - - - - - - - - - -#### CollectionItemDescriptor \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor\} - - - - - - - - - -##### description \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+description\} - - - - - -A helpful description of why this CollectionItem is in the Collection that it's in. - - - - - - - - - -##### documentId \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+documentid\} - - - - - -The Glean Document ID of the item being added if it's an indexed document. - - - - - - - - - -##### icon \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+icon\} - - - - - -The emoji icon for this CollectionItem. Only used for Text type items. - - - - - - - - - -##### itemType \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+itemtype\} - - - - - - - - - -##### name \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+name\} - - - - - -The optional name of the Collection item. - - - - - - - - - -##### newNextItemId \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+newnextitemid\} - - - - - -The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection - - - - - - - - - -##### url \{#operation-addcollectionitems+request+addedcollectionitemdescriptors+collectionitemdescriptor+url\} - - - - - -The URL of the item being added. - - - - - - - - - - - - - - - - - -##### collectionId \{#operation-addcollectionitems+request+collectionid\} - - - - - -The ID of the Collection to add items to. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-addcollectionitems+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-addcollectionitems+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#operation-addcollectionitems+responses+200+application-json+collection\} - - - - - - - - - -#### Collection \{#operation-addcollectionitems+responses+200+application-json+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-addcollectionitems+responses+200+application-json+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-addcollectionitems+responses+200+application-json+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-addcollectionitems+responses+200+application-json+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-addcollectionitems+responses+200+application-json+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-addcollectionitems+responses+200+application-json+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-addcollectionitems+responses+200+application-json+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-addcollectionitems+responses+200+application-json+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-addcollectionitems+responses+200+application-json+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-addcollectionitems+responses+200+application-json+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-addcollectionitems+responses+200+application-json+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-addcollectionitems+responses+200+application-json+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-addcollectionitems+responses+200+application-json+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-addcollectionitems+responses+200+application-json+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-addcollectionitems+responses+200+application-json+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-addcollectionitems+responses+200+application-json+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-addcollectionitems+responses+200+application-json+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-addcollectionitems+responses+200+application-json+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-addcollectionitems+responses+200+application-json+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-addcollectionitems+responses+200+application-json+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-addcollectionitems+responses+200+application-json+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-addcollectionitems+responses+200+application-json+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-addcollectionitems+responses+200+application-json+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-addcollectionitems+responses+200+application-json+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddCollectionItemsError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-addcollectionitems+responses+200+application-json+error\} - - - - - - - - - -#### AddCollectionItemsError \{#operation-addcollectionitems+responses+200+application-json+error+addcollectionitemserror\} - - - - - - - - - -##### errorType \{#operation-addcollectionitems+responses+200+application-json+error+addcollectionitemserror+errortype\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/createcollection \{#operation-createcollection\} - - - - - -_Create Collection_ - - - - - -Create a publicly visible (empty) Collection of documents. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/createcollection \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "name": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createcollection+request-examples\} - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createcollection+request\} - - - - - - - -Collection content plus any additional metadata for the request. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-createcollection+request+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-createcollection+request+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-createcollection+request+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-createcollection+request+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-createcollection+request+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-createcollection+request+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-createcollection+request+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-createcollection+request+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-createcollection+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-createcollection+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-createcollection+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-createcollection+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-createcollection+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-createcollection+request+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-createcollection+request+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### name \{#operation-createcollection+request+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### newNextItemId \{#operation-createcollection+request+newnextitemid\} - - - - - -The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified. - - - - - - - - - -##### parentId \{#operation-createcollection+request+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-createcollection+request+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-createcollection+request+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-createcollection+request+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-createcollection+request+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-createcollection+request+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-createcollection+request+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-createcollection+request+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-createcollection+request+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-createcollection+request+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-createcollection+request+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createcollection+responses-examples\} - - - - - -200 - - - - - -```json -{ - "collection": { - "description": "ipsum eiusmod", - "id": 87, - "name": "consequat do" - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - }, - "errorCode": "NAME_EXISTS" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-createcollection+responses\} - - - - - -200 - - - - - - - - - - - - - -OK - - - - - - - -422 - - - - - - - -Semantic error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-createcollection+responses+422+application-json+httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-createcollection+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - - - -##### Request \{#operation-createcollection+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-createcollection+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - - - - - -##### errorCode \{#operation-createcollection+responses+422+application-json+errorcode\} - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deletecollection \{#operation-deletecollection\} - - - - - -_Delete Collection_ - - - - - -Delete a Collection given the Collection's ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deletecollection \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "ids": [ - 87 - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-deletecollection+request-examples\} - - - - - -```json -{ - "ids": [ - 87 - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deletecollection+request\} - - - - - - - -DeleteCollection request - - - - - - - - - -##### allowedDatasource \{#operation-deletecollection+request+alloweddatasource\} - - - - - -The datasource allowed in the Collection to be deleted. - - - - - - - - - -##### ids \{#operation-deletecollection+request+ids\} - - - - - -The IDs of the Collections to delete. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-deletecollection+responses-examples\} - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - }, - "errorCode": "NAME_EXISTS" -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-deletecollection+responses\} - - - - - -422 - - - - - - - -Semantic error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-deletecollection+responses+422+application-json+httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-deletecollection+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - - - -##### Request \{#operation-deletecollection+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-deletecollection+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - - - - - -##### errorCode \{#operation-deletecollection+responses+422+application-json+errorcode\} - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deletecollectionitem \{#operation-deletecollectionitem\} - - - - - -_Delete Collection item_ - - - - - -Delete a single item from a Collection. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deletecollectionitem \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "collectionId": 87, - "itemId": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-deletecollectionitem+request-examples\} - - - - - -```json -{ - "collectionId": 87, - "itemId": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deletecollectionitem+request\} - - - - - - - -Data describing the delete operation. - - - - - - - - - -##### collectionId \{#operation-deletecollectionitem+request+collectionid\} - - - - - -The ID of the Collection to remove an item in. - - - - - - - - - -##### documentId \{#operation-deletecollectionitem+request+documentid\} - - - - - -The (optional) Glean Document ID of the CollectionItem to remove from this Collection if this is an indexed document. - - - - - - - - - -##### itemId \{#operation-deletecollectionitem+request+itemid\} - - - - - -The item ID of the CollectionItem to remove from this Collection. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-deletecollectionitem+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-deletecollectionitem+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#operation-deletecollectionitem+responses+200+application-json+collection\} - - - - - - - - - -#### Collection \{#operation-deletecollectionitem+responses+200+application-json+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-deletecollectionitem+responses+200+application-json+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/editcollection \{#operation-editcollection\} - - - - - -_Update Collection_ - - - - - -Update the properties of an existing Collection. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/editcollection \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": 87, - "name": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-editcollection+request-examples\} - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-editcollection+request\} - - - - - - - -Collection content plus any additional metadata for the request. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-editcollection+request+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editcollection+request+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editcollection+request+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editcollection+request+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editcollection+request+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editcollection+request+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editcollection+request+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editcollection+request+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editcollection+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editcollection+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editcollection+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editcollection+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editcollection+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollection+request+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-editcollection+request+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editcollection+request+id\} - - - - - -The ID of the Collection to modify. - - - - - - - - - -##### name \{#operation-editcollection+request+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editcollection+request+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-editcollection+request+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editcollection+request+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editcollection+request+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editcollection+request+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editcollection+request+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editcollection+request+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-editcollection+request+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-editcollection+request+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-editcollection+request+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-editcollection+request+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-editcollection+responses-examples\} - - - - - -200 - - - - - -```json -{ - "description": "ipsum eiusmod", - "errorCode": "NAME_EXISTS", - "id": 87, - "name": "consequat do" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - }, - "errorCode": "NAME_EXISTS" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-editcollection+responses\} - - - - - -200 - - - - - - - -OK - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-editcollection+responses+200+application-json+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editcollection+responses+200+application-json+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editcollection+responses+200+application-json+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editcollection+responses+200+application-json+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editcollection+responses+200+application-json+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editcollection+responses+200+application-json+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editcollection+responses+200+application-json+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editcollection+responses+200+application-json+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editcollection+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editcollection+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editcollection+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editcollection+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editcollection+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-editcollection+responses+200+application-json+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### children \{#operation-editcollection+responses+200+application-json+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#operation-editcollection+responses+200+application-json+children+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-editcollection+responses+200+application-json+children+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editcollection+responses+200+application-json+children+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editcollection+responses+200+application-json+children+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-editcollection+responses+200+application-json+children+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-editcollection+responses+200+application-json+children+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - - - - - -##### createTime \{#operation-editcollection+responses+200+application-json+children+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-editcollection+responses+200+application-json+children+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollection+responses+200+application-json+children+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-editcollection+responses+200+application-json+children+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editcollection+responses+200+application-json+children+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-editcollection+responses+200+application-json+children+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-editcollection+responses+200+application-json+children+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+children+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editcollection+responses+200+application-json+children+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-editcollection+responses+200+application-json+children+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-editcollection+responses+200+application-json+children+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-editcollection+responses+200+application-json+children+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-editcollection+responses+200+application-json+children+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-editcollection+responses+200+application-json+children+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-editcollection+responses+200+application-json+children+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editcollection+responses+200+application-json+children+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-editcollection+responses+200+application-json+children+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#operation-editcollection+responses+200+application-json+collection\} - - - - - - - - - -#### Collection \{#operation-editcollection+responses+200+application-json+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-editcollection+responses+200+application-json+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editcollection+responses+200+application-json+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editcollection+responses+200+application-json+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-editcollection+responses+200+application-json+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-editcollection+responses+200+application-json+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-editcollection+responses+200+application-json+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editcollection+responses+200+application-json+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-editcollection+responses+200+application-json+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollection+responses+200+application-json+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-editcollection+responses+200+application-json+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editcollection+responses+200+application-json+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-editcollection+responses+200+application-json+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-editcollection+responses+200+application-json+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editcollection+responses+200+application-json+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-editcollection+responses+200+application-json+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-editcollection+responses+200+application-json+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-editcollection+responses+200+application-json+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-editcollection+responses+200+application-json+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-editcollection+responses+200+application-json+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-editcollection+responses+200+application-json+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editcollection+responses+200+application-json+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-editcollection+responses+200+application-json+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editcollection+responses+200+application-json+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### creator \{#operation-editcollection+responses+200+application-json+creator\} - - - - - - - - - -#### Person \{#operation-editcollection+responses+200+application-json+creator+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editcollection+responses+200+application-json+creator+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+creator+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editcollection+responses+200+application-json+creator+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editcollection+responses+200+application-json+creator+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollection+responses+200+application-json+description\} - - - - - -A brief summary of the Collection's contents. - - - - - -CollectionError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-editcollection+responses+200+application-json+error\} - - - - - - - - - -#### CollectionError \{#operation-editcollection+responses+200+application-json+error+collectionerror\} - - - - - - - - - -##### errorCode \{#operation-editcollection+responses+200+application-json+error+collectionerror+errorcode\} - - - - - - - - - - - - - - - - - -##### errorCode \{#operation-editcollection+responses+200+application-json+errorcode\} - - - - - - - - - -##### icon \{#operation-editcollection+responses+200+application-json+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editcollection+responses+200+application-json+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-editcollection+responses+200+application-json+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-editcollection+responses+200+application-json+items\} - - - - - -The items in this Collection. - - - - - - - - - -#### CollectionItem \{#operation-editcollection+responses+200+application-json+items+collectionitem\} - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#operation-editcollection+responses+200+application-json+items+collectionitem+collection\} - - - - - - - - - - - - - - - - - - - - - - - -##### collectionId \{#operation-editcollection+responses+200+application-json+items+collectionitem+collectionid\} - - - - - -The Collection ID of the Collection that this CollectionItem belongs in. - - - - - - - - - -##### createdAt \{#operation-editcollection+responses+200+application-json+items+collectionitem+createdat\} - - - - - -Unix timestamp for when the item was first added (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-editcollection+responses+200+application-json+items+collectionitem+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollection+responses+200+application-json+items+collectionitem+description\} - - - - - -A helpful description of why this CollectionItem is in the Collection that it's in. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-editcollection+responses+200+application-json+items+collectionitem+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### documentId \{#operation-editcollection+responses+200+application-json+items+collectionitem+documentid\} - - - - - -If this CollectionItem is indexed, the Glean Document ID of that document. - - - - - - - - - -##### icon \{#operation-editcollection+responses+200+application-json+items+collectionitem+icon\} - - - - - -The emoji icon for this CollectionItem. Only used for Text type items. - - - - - - - - - -##### itemId \{#operation-editcollection+responses+200+application-json+items+collectionitem+itemid\} - - - - - -Unique identifier for the item within the Collection it belongs to. - - - - - - - - - -##### itemType \{#operation-editcollection+responses+200+application-json+items+collectionitem+itemtype\} - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+items+collectionitem+name\} - - - - - -The optional name of the Collection item. - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#operation-editcollection+responses+200+application-json+items+collectionitem+shortcut\} - - - - - - - - - - - - - - - - - - - - - - - -##### url \{#operation-editcollection+responses+200+application-json+items+collectionitem+url\} - - - - - -The URL of this CollectionItem. - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editcollection+responses+200+application-json+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-editcollection+responses+200+application-json+permissions\} - - - - - - - - - -#### ObjectPermissions \{#operation-editcollection+responses+200+application-json+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#operation-editcollection+responses+200+application-json+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pinMetadata \{#operation-editcollection+responses+200+application-json+pinmetadata\} - - - - - - - - - -#### CollectionPinnedMetadata \{#operation-editcollection+responses+200+application-json+pinmetadata+collectionpinnedmetadata\} - - - - - -CollectionPinMetadata","children":[{"label":"CollectionPinMetadata","linkedLabel":"CollectionPinMetadata","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### eligiblePins \{#operation-editcollection+responses+200+application-json+pinmetadata+collectionpinnedmetadata+eligiblepins\} - - - - - -List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - - - - - - - - - - - - - - - - - - - -CollectionPinTarget","children":[{"label":"CollectionPinTarget","linkedLabel":"CollectionPinTarget","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### existingPins \{#operation-editcollection+responses+200+application-json+pinmetadata+collectionpinnedmetadata+existingpins\} - - - - - -List of targets this Collection is pinned to. - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-editcollection+responses+200+application-json+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editcollection+responses+200+application-json+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editcollection+responses+200+application-json+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editcollection+responses+200+application-json+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editcollection+responses+200+application-json+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editcollection+responses+200+application-json+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### roles \{#operation-editcollection+responses+200+application-json+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-editcollection+responses+200+application-json+roles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-editcollection+responses+200+application-json+roles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-editcollection+responses+200+application-json+roles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-editcollection+responses+200+application-json+roles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-editcollection+responses+200+application-json+roles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-editcollection+responses+200+application-json+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#operation-editcollection+responses+200+application-json+thumbnail\} - - - - - - - - - -#### Thumbnail \{#operation-editcollection+responses+200+application-json+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#operation-editcollection+responses+200+application-json+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#operation-editcollection+responses+200+application-json+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editcollection+responses+200+application-json+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-editcollection+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-editcollection+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editcollection+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollection+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editcollection+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editcollection+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Semantic error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-editcollection+responses+422+application-json+httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-editcollection+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - - - -##### Request \{#operation-editcollection+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-editcollection+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - - - - - -##### errorCode \{#operation-editcollection+responses+422+application-json+errorcode\} - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/editcollectionitem \{#operation-editcollectionitem\} - - - - - -_Update Collection item_ - - - - - -Update the URL, Glean Document ID, description of an item within a Collection given its ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/editcollectionitem \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "collectionId": 87, - "itemId": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-editcollectionitem+request-examples\} - - - - - -```json -{ - "collectionId": 87, - "itemId": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-editcollectionitem+request\} - - - - - - - -Edit Collection Items request - - - - - - - - - -##### collectionId \{#operation-editcollectionitem+request+collectionid\} - - - - - -The ID of the Collection to edit CollectionItems in. - - - - - - - - - -##### description \{#operation-editcollectionitem+request+description\} - - - - - -A helpful description of why this CollectionItem is in the Collection that it's in. - - - - - - - - - -##### icon \{#operation-editcollectionitem+request+icon\} - - - - - -The emoji icon for this CollectionItem. Only used for Text type items. - - - - - - - - - -##### itemId \{#operation-editcollectionitem+request+itemid\} - - - - - -The ID of the CollectionItem to edit. - - - - - - - - - -##### name \{#operation-editcollectionitem+request+name\} - - - - - -The optional name of the Collection item. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-editcollectionitem+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-editcollectionitem+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#operation-editcollectionitem+responses+200+application-json+collection\} - - - - - - - - - -#### Collection \{#operation-editcollectionitem+responses+200+application-json+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-editcollectionitem+responses+200+application-json+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-editcollectionitem+responses+200+application-json+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-editcollectionitem+responses+200+application-json+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-editcollectionitem+responses+200+application-json+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-editcollectionitem+responses+200+application-json+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-editcollectionitem+responses+200+application-json+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editcollectionitem+responses+200+application-json+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-editcollectionitem+responses+200+application-json+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-editcollectionitem+responses+200+application-json+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-editcollectionitem+responses+200+application-json+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-editcollectionitem+responses+200+application-json+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-editcollectionitem+responses+200+application-json+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-editcollectionitem+responses+200+application-json+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editcollectionitem+responses+200+application-json+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-editcollectionitem+responses+200+application-json+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-editcollectionitem+responses+200+application-json+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-editcollectionitem+responses+200+application-json+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-editcollectionitem+responses+200+application-json+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-editcollectionitem+responses+200+application-json+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-editcollectionitem+responses+200+application-json+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-editcollectionitem+responses+200+application-json+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-editcollectionitem+responses+200+application-json+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-editcollectionitem+responses+200+application-json+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getcollection \{#operation-getcollection\} - - - - - -_Read Collection_ - - - - - -Read the details of a Collection given its ID. Does not fetch items in this Collection. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getcollection \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": 87 -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getcollection+request-examples\} - - - - - -```json -{ - "id": 87 -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getcollection+request\} - - - - - - - -GetCollection request - - - - - - - - - -##### allowedDatasource \{#operation-getcollection+request+alloweddatasource\} - - - - - -The datasource allowed in the Collection returned. - - - - - - - - - -##### id \{#operation-getcollection+request+id\} - - - - - -The ID of the Collection to be retrieved. - - - - - - - - - -##### withHierarchy \{#operation-getcollection+request+withhierarchy\} - - - - - -Whether or not to include the top level Collection in this Collection's hierarchy. - - - - - - - - - -##### withItems \{#operation-getcollection+request+withitems\} - - - - - -Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getcollection+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getcollection+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#operation-getcollection+responses+200+application-json+collection\} - - - - - - - - - -#### Collection \{#operation-getcollection+responses+200+application-json+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-getcollection+responses+200+application-json+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-getcollection+responses+200+application-json+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-getcollection+responses+200+application-json+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-getcollection+responses+200+application-json+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-getcollection+responses+200+application-json+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-getcollection+responses+200+application-json+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-getcollection+responses+200+application-json+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-getcollection+responses+200+application-json+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-getcollection+responses+200+application-json+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-getcollection+responses+200+application-json+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-getcollection+responses+200+application-json+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-getcollection+responses+200+application-json+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-getcollection+responses+200+application-json+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-getcollection+responses+200+application-json+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-getcollection+responses+200+application-json+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-getcollection+responses+200+application-json+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-getcollection+responses+200+application-json+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-getcollection+responses+200+application-json+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-getcollection+responses+200+application-json+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-getcollection+responses+200+application-json+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-getcollection+responses+200+application-json+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-getcollection+responses+200+application-json+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-getcollection+responses+200+application-json+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - -CollectionError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-getcollection+responses+200+application-json+error\} - - - - - - - - - -#### CollectionError \{#operation-getcollection+responses+200+application-json+error+collectionerror\} - - - - - - - - - -##### errorCode \{#operation-getcollection+responses+200+application-json+error+collectionerror+errorcode\} - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### rootCollection \{#operation-getcollection+responses+200+application-json+rootcollection\} - - - - - - - - - -#### Collection \{#operation-getcollection+responses+200+application-json+rootcollection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-getcollection+responses+200+application-json+rootcollection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-getcollection+responses+200+application-json+rootcollection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-getcollection+responses+200+application-json+rootcollection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-getcollection+responses+200+application-json+rootcollection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-getcollection+responses+200+application-json+rootcollection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-getcollection+responses+200+application-json+rootcollection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-getcollection+responses+200+application-json+rootcollection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-getcollection+responses+200+application-json+rootcollection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-getcollection+responses+200+application-json+rootcollection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-getcollection+responses+200+application-json+rootcollection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-getcollection+responses+200+application-json+rootcollection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-getcollection+responses+200+application-json+rootcollection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-getcollection+responses+200+application-json+rootcollection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-getcollection+responses+200+application-json+rootcollection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-getcollection+responses+200+application-json+rootcollection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-getcollection+responses+200+application-json+rootcollection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-getcollection+responses+200+application-json+rootcollection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-getcollection+responses+200+application-json+rootcollection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-getcollection+responses+200+application-json+rootcollection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-getcollection+responses+200+application-json+rootcollection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-getcollection+responses+200+application-json+rootcollection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-getcollection+responses+200+application-json+rootcollection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-getcollection+responses+200+application-json+rootcollection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-getcollection+responses+200+application-json+trackingtoken\} - - - - - -An opaque token that represents this particular Collection. To be used for `/feedback` reporting. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listcollections \{#operation-listcollections\} - - - - - -_List Collections_ - - - - - -List all existing Collections. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listcollections \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-listcollections+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-listcollections+request\} - - - - - - - -ListCollections request - - - - - - - - - -##### allowedDatasource \{#operation-listcollections+request+alloweddatasource\} - - - - - -The datasource type this Collection can hold. -ANSWERS - for Collections representing answer boards - - - - - - - - - -##### includeAudience \{#operation-listcollections+request+includeaudience\} - - - - - -Whether to include the audience filters with the listed Collections. - - - - - - - - - -##### includeRoles \{#operation-listcollections+request+includeroles\} - - - - - -Whether to include the editor roles with the listed Collections. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listcollections+responses-examples\} - - - - - -200 - - - - - -```json -{ - "collections": [ - { - "description": "ipsum eiusmod", - "id": 87, - "name": "consequat do" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-listcollections+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collections \{#operation-listcollections+responses+200+application-json+collections\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#operation-listcollections+responses+200+application-json+collections+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-listcollections+responses+200+application-json+collections+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#operation-listcollections+responses+200+application-json+collections+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#operation-listcollections+responses+200+application-json+collections+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-listcollections+responses+200+application-json+collections+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#operation-listcollections+responses+200+application-json+collections+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#operation-listcollections+responses+200+application-json+collections+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-listcollections+responses+200+application-json+collections+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#operation-listcollections+responses+200+application-json+collections+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-listcollections+responses+200+application-json+collections+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#operation-listcollections+responses+200+application-json+collections+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#operation-listcollections+responses+200+application-json+collections+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#operation-listcollections+responses+200+application-json+collections+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-listcollections+responses+200+application-json+collections+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-listcollections+responses+200+application-json+collections+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#operation-listcollections+responses+200+application-json+collections+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-listcollections+responses+200+application-json+collections+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#operation-listcollections+responses+200+application-json+collections+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-listcollections+responses+200+application-json+collections+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-listcollections+responses+200+application-json+collections+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#operation-listcollections+responses+200+application-json+collections+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#operation-listcollections+responses+200+application-json+collections+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#operation-listcollections+responses+200+application-json+collections+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-listcollections+responses+200+application-json+collections+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/documents.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/documents.mdx deleted file mode 100644 index e4ff05e60..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/documents.mdx +++ /dev/null @@ -1,2187 +0,0 @@ ---- -sidebar_position: 3.7 -sidebar_label: Client Documents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../../../../../src/components/glean-embeds/loaders/containerdocument.tsx"; -import Embedcontent from "../../../../../src/components/glean-embeds/loaders/content.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedparentdocument from "../../../../../src/components/glean-embeds/loaders/parentdocument.tsx"; -import Embedsections from "../../../../../src/components/glean-embeds/loaders/sections.tsx"; -import Embedfilters from "../../../../../src/components/glean-embeds/loaders/filters.tsx"; - - - - - - - -# Client Documents Endpoints - - - - - - - - - -## POST /rest/api/v1/getdocpermissions \{#operation-getdocpermissions\} - - - - - -_Read document permissions_ - - - - - -Read the emails of all users who have access to the given document. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getdocpermissions \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getdocpermissions+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getdocpermissions+request\} - - - - - - - -Document permissions request - - - - - - - - - -##### documentId \{#operation-getdocpermissions+request+documentid\} - - - - - -The Glean Document ID to retrieve permissions for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getdocpermissions+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getdocpermissions+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### allowedUserEmails \{#operation-getdocpermissions+responses+200+application-json+alloweduseremails\} - - - - - -A list of emails of users who have access to the document. If the document is visible to all Glean users, a list with only a single value of 'VISIBLE_TO_ALL'. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getdocuments \{#operation-getdocuments\} - - - - - -_Read documents_ - - - - - -Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getdocuments \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "documentSpecs": [ - { - "url": "ipsum eiusmod" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getdocuments+request-examples\} - - - - - -```json -{ - "documentSpecs": [ - { - "url": "ipsum eiusmod" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getdocuments+request\} - - - - - - - -Information about documents requested. - - - - - - - - - -##### documentSpecs \{#operation-getdocuments+request+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### includeFields \{#operation-getdocuments+request+includefields\} - - - - - -List of Document fields to return (that aren't returned by default) - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getdocuments+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getdocuments+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-getdocuments+responses+200+application-json+documents\} - - - - - -The document details or the error if document is not found. - - - - - - - - - -#### Document \{#operation-getdocuments+responses+200+application-json+documents+document\} - - - - - - - - - -##### connectorType \{#operation-getdocuments+responses+200+application-json+documents+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-getdocuments+responses+200+application-json+documents+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-getdocuments+responses+200+application-json+documents+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-getdocuments+responses+200+application-json+documents+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-getdocuments+responses+200+application-json+documents+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-getdocuments+responses+200+application-json+documents+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-getdocuments+responses+200+application-json+documents+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-getdocuments+responses+200+application-json+documents+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-getdocuments+responses+200+application-json+documents+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-getdocuments+responses+200+application-json+documents+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-getdocuments+responses+200+application-json+documents+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getdocumentsbyfacets \{#operation-getdocumentsbyfacets\} - - - - - -_Read documents by facets_ - - - - - -Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) macthing the given facet conditions. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getdocumentsbyfacets \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "filterSets": [ - {} - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getdocumentsbyfacets+request-examples\} - - - - - -```json -{ - "filterSets": [ - {} - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getdocumentsbyfacets+request\} - - - - - - - -Information about facet conditions for documents to be retrieved. - - - - - - - - - -##### cursor \{#operation-getdocumentsbyfacets+request+cursor\} - - - - - -Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - - - - - - - - - -##### datasourcesFilter \{#operation-getdocumentsbyfacets+request+datasourcesfilter\} - - - - - -Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - - - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### filterSets \{#operation-getdocumentsbyfacets+request+filtersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - -#### FacetFilterSet \{#operation-getdocumentsbyfacets+request+filtersets+facetfilterset\} - - - - - -Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### filters \{#operation-getdocumentsbyfacets+request+filtersets+facetfilterset+filters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getdocumentsbyfacets+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getdocumentsbyfacets+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### cursor \{#operation-getdocumentsbyfacets+responses+200+application-json+cursor\} - - - - - -Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - - - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-getdocumentsbyfacets+responses+200+application-json+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - -#### Document \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document\} - - - - - - - - - -##### connectorType \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-getdocumentsbyfacets+responses+200+application-json+documents+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### hasMoreResults \{#operation-getdocumentsbyfacets+responses+200+application-json+hasmoreresults\} - - - - - -Whether more results are available. Use cursor to retrieve them. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/summarize \{#operation-summarize\} - - - - - -_Summarize documents_ - - - - - -Generate an AI summary of the requested documents. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/summarize \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "documentSpecs": [ - { - "url": "ipsum eiusmod" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-summarize+request-examples\} - - - - - -```json -{ - "documentSpecs": [ - { - "url": "ipsum eiusmod" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-summarize+request\} - - - - - - - -Includes request params such as the query and specs of the documents to summarize. - - - - - - - - - -##### documentSpecs \{#operation-summarize+request+documentspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - -##### preferredSummaryLength \{#operation-summarize+request+preferredsummarylength\} - - - - - -Optional length of summary output. If not given, defaults to 500 chars. - - - - - - - - - -##### query \{#operation-summarize+request+query\} - - - - - -Optional query that the summary should be about - - - - - - - - - -##### timestamp \{#operation-summarize+request+timestamp\} - - - - - -The ISO 8601 timestamp associated with the client request. - - - - - - - - - -##### trackingToken \{#operation-summarize+request+trackingtoken\} - - - - - -An opaque token that represents this particular result. To be used for /feedback reporting. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-summarize+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-summarize+responses\} - - - - - -200 - - - - - - - -OK - - - - - -error","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-summarize+responses+200+application-json+error\} - - - - - - - - - -Summary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### summary \{#operation-summarize+responses+200+application-json+summary\} - - - - - - - - - -#### Summary \{#operation-summarize+responses+200+application-json+summary+summary\} - - - - - - - - - -##### followUpPrompts \{#operation-summarize+responses+200+application-json+summary+summary+followupprompts\} - - - - - -Follow-up prompts based on the summarized doc - - - - - - - - - -##### text \{#operation-summarize+responses+200+application-json+summary+summary+text\} - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-summarize+responses+200+application-json+trackingtoken\} - - - - - -An opaque token that represents this summary in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/entities.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/entities.mdx deleted file mode 100644 index bdd767a6a..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/entities.mdx +++ /dev/null @@ -1,2903 +0,0 @@ ---- -sidebar_position: 3.8 -sidebar_label: Client Entities ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedpermissions from "../../../../../src/components/glean-embeds/loaders/permissions.tsx"; -import Embedroles from "../../../../../src/components/glean-embeds/loaders/roles.tsx"; -import Embedbuckets from "../../../../../src/components/glean-embeds/loaders/buckets.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedcustomfields from "../../../../../src/components/glean-embeds/loaders/customfields.tsx"; -import Embeddatasourceprofiles from "../../../../../src/components/glean-embeds/loaders/datasourceprofiles.tsx"; -import Embedemails from "../../../../../src/components/glean-embeds/loaders/emails.tsx"; -import Embedmembers from "../../../../../src/components/glean-embeds/loaders/members.tsx"; -import Embedrelatedobjects from "../../../../../src/components/glean-embeds/loaders/relatedobjects.tsx"; -import Embeddocuments from "../../../../../src/components/glean-embeds/loaders/documents.tsx"; -import Embedquerysuggestion from "../../../../../src/components/glean-embeds/loaders/querysuggestion.tsx"; -import Embedresults from "../../../../../src/components/glean-embeds/loaders/results.tsx"; - - - - - - - -# Client Entities Endpoints - - - - - - - - - -## POST /rest/api/v1/listentities \{#operation-listentities\} - - - - - -_List entities_ - - - - - -List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listentities \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-listentities+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-listentities+request\} - - - - - - - -List people request - - - - - - - - - -##### cursor \{#operation-listentities+request+cursor\} - - - - - -Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - - - - - - - - - -##### datasource \{#operation-listentities+request+datasource\} - - - - - -The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES - - - - - - - - - -##### entityType \{#operation-listentities+request+entitytype\} - - - - - -_Default Value:_ `"PEOPLE"` - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### filter \{#operation-listentities+request+filter\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-listentities+request+filter+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-listentities+request+filter+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-listentities+request+filter+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-listentities+request+filter+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### includeFields \{#operation-listentities+request+includefields\} - - - - - -List of entity fields to return (that aren't returned by default) - - - - - - - - - -##### pageSize \{#operation-listentities+request+pagesize\} - - - - - -Hint to the server about how many results to send back. Server may return less. - - - - - -_Example:_ - -``` -100 -``` - - - - - - - - - -##### query \{#operation-listentities+request+query\} - - - - - -A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities. - - - - - - - - - -##### requestType \{#operation-listentities+request+requesttype\} - - - - - -The type of request being made. - - - - - -_Default Value:_ `"STANDARD"` - - - - - -SortOptions","children":[{"label":"SortOptions","linkedLabel":"SortOptions","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sort \{#operation-listentities+request+sort\} - - - - - -Use EntitiesSortOrder enum for SortOptions.sortBy - - - - - - - - - -#### SortOptions \{#operation-listentities+request+sort+sortoptions\} - - - - - - - - - -##### orderBy \{#operation-listentities+request+sort+sortoptions+orderby\} - - - - - - - - - -##### sortBy \{#operation-listentities+request+sort+sortoptions+sortby\} - - - - - - - - - - - - - - - - - -##### source \{#operation-listentities+request+source\} - - - - - -A string denoting the search surface from which the endpoint is called. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listentities+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-listentities+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### cursor \{#operation-listentities+responses+200+application-json+cursor\} - - - - - -Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - - - - - -CustomEntity","children":[{"label":"CustomEntity","linkedLabel":"CustomEntity","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customEntityResults \{#operation-listentities+responses+200+application-json+customentityresults\} - - - - - - - - - -#### CustomEntity \{#operation-listentities+responses+200+application-json+customentityresults+customentity\} - - - - - - - - - -##### datasource \{#operation-listentities+responses+200+application-json+customentityresults+customentity+datasource\} - - - - - -The datasource the custom entity is from. - - - - - - - - - -##### id \{#operation-listentities+responses+200+application-json+customentityresults+customentity+id\} - - - - - -Unique identifier. - - - - - -CustomEntityMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-listentities+responses+200+application-json+customentityresults+customentity+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### objectType \{#operation-listentities+responses+200+application-json+customentityresults+customentity+objecttype\} - - - - - -The type of the entity. Interpretation is specific to each datasource - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-listentities+responses+200+application-json+customentityresults+customentity+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-listentities+responses+200+application-json+customentityresults+customentity+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-listentities+responses+200+application-json+customentityresults+customentity+title\} - - - - - -Title or name of the custom entity. - - - - - - - - - - - - - - - - - -##### customFacetNames \{#operation-listentities+responses+200+application-json+customfacetnames\} - - - - - -list of Person attributes that are custom setup by deployment - - - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#operation-listentities+responses+200+application-json+facetresults\} - - - - - - - - - -#### FacetResult \{#operation-listentities+responses+200+application-json+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#operation-listentities+responses+200+application-json+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#operation-listentities+responses+200+application-json+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#operation-listentities+responses+200+application-json+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#operation-listentities+responses+200+application-json+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#operation-listentities+responses+200+application-json+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - - - - - -##### hasMoreResults \{#operation-listentities+responses+200+application-json+hasmoreresults\} - - - - - -Whether or not more entities can be fetched. - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-listentities+responses+200+application-json+results\} - - - - - -A list of POC for company. - - - - - - - - - -#### Person \{#operation-listentities+responses+200+application-json+results+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-listentities+responses+200+application-json+results+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-listentities+responses+200+application-json+results+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-listentities+responses+200+application-json+results+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-listentities+responses+200+application-json+results+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### sortOptions \{#operation-listentities+responses+200+application-json+sortoptions\} - - - - - -Sort options from EntitiesSortOrder supported for this response. Default is empty list. - - - - - -Team","children":[{"label":"Team","linkedLabel":"Team","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### teamResults \{#operation-listentities+responses+200+application-json+teamresults\} - - - - - - - - - -#### Team \{#operation-listentities+responses+200+application-json+teamresults+team\} - - - - - - - - - -##### bannerUrl \{#operation-listentities+responses+200+application-json+teamresults+team+bannerurl\} - - - - - -A link to the team's banner photo. - - - - - - - - - -##### businessUnit \{#operation-listentities+responses+200+application-json+teamresults+team+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - - - - - -##### canBeDeleted \{#operation-listentities+responses+200+application-json+teamresults+team+canbedeleted\} - - - - - -can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot - - - - - -_Default Value:_ `true` - - - - - - - - - -##### createdFrom \{#operation-listentities+responses+200+application-json+teamresults+team+createdfrom\} - - - - - -For teams created from docs, the doc title. Otherwise empty. - - - - - -CustomFieldData","children":[{"label":"CustomFieldData","linkedLabel":"CustomFieldData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customFields \{#operation-listentities+responses+200+application-json+teamresults+team+customfields\} - - - - - -Customizable fields for additional team information. - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-listentities+responses+200+application-json+teamresults+team+datasource\} - - - - - -the data source of the team, e.g. GDRIVE - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#operation-listentities+responses+200+application-json+teamresults+team+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#operation-listentities+responses+200+application-json+teamresults+team+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### description \{#operation-listentities+responses+200+application-json+teamresults+team+description\} - - - - - -A description of the team - - - - - -TeamEmail","children":[{"label":"TeamEmail","linkedLabel":"TeamEmail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### emails \{#operation-listentities+responses+200+application-json+teamresults+team+emails\} - - - - - -The emails for this team - - - - - - - - - - - - - - - - - - - - - - - -##### externalLink \{#operation-listentities+responses+200+application-json+teamresults+team+externallink\} - - - - - -Link to a team page on the internet or your company's intranet - - - - - - - - - -##### id \{#operation-listentities+responses+200+application-json+teamresults+team+id\} - - - - - -Unique identifier - - - - - - - - - -##### lastUpdatedAt \{#operation-listentities+responses+200+application-json+teamresults+team+lastupdatedat\} - - - - - -when this team was last updated. - - - - - - - - - -##### loggingId \{#operation-listentities+responses+200+application-json+teamresults+team+loggingid\} - - - - - -The logging id of the team used in scrubbed logs, client analytics, and metrics. - - - - - - - - - -##### memberCount \{#operation-listentities+responses+200+application-json+teamresults+team+membercount\} - - - - - -Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team) - - - - - -PersonToTeamRelationship","children":[{"label":"PersonToTeamRelationship","linkedLabel":"PersonToTeamRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### members \{#operation-listentities+responses+200+application-json+teamresults+team+members\} - - - - - -The members on this team - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-listentities+responses+200+application-json+teamresults+team+name\} - - - - - -Team name - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-listentities+responses+200+application-json+teamresults+team+permissions\} - - - - - - - - - - - - - - - - - - - - - - - -##### photoUrl \{#operation-listentities+responses+200+application-json+teamresults+team+photourl\} - - - - - -A link to the team's photo. - - - - - -RelatedObjectEdge","children":[{"label":"RelatedObjectEdge","linkedLabel":"RelatedObjectEdge","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedObjects \{#operation-listentities+responses+200+application-json+teamresults+team+relatedobjects\} - - - - - -A list of objects related to a source object. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-listentities+responses+200+application-json+teamresults+team+status\} - - - - - -whether this team is fully processed or there are still unprocessed operations that'll affect it - - - - - -_Default Value:_ `"PROCESSED"` - - - - - - - - - - - - - - - - - -##### totalCount \{#operation-listentities+responses+200+application-json+totalcount\} - - - - - -The total number of entities available - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/people \{#operation-people\} - - - - - -_Read people_ - - - - - -Read people details for the given IDs. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/people \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-people+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-people+request\} - - - - - - - -People request - - - - - - - - - -##### emailIds \{#operation-people+request+emailids\} - - - - - -The email IDs to retrieve. The result is the deduplicated union of emailIds and obfuscatedIds. - - - - - - - - - -##### includeFields \{#operation-people+request+includefields\} - - - - - -List of PersonMetadata fields to return (that aren't returned by default) - - - - - - - - - -##### includeTypes \{#operation-people+request+includetypes\} - - - - - -The types of people entities to include in the response in addition to those returned by default. - - - - - - - - - -##### obfuscatedIds \{#operation-people+request+obfuscatedids\} - - - - - -The Person IDs to retrieve. If no IDs are requested, the current user's details are returned. - - - - - - - - - -##### source \{#operation-people+request+source\} - - - - - -A string denoting the search surface from which the endpoint is called. - - - - - - - - - -##### timezoneOffset \{#operation-people+request+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-people+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-people+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### errors \{#operation-people+responses+200+application-json+errors\} - - - - - -A list of IDs that could not be found. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relatedDocuments \{#operation-people+responses+200+application-json+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - -#### RelatedDocuments \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments\} - - - - - - - - - -##### associatedEntityId \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments+associatedentityid\} - - - - - -Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - - - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documents \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - - - - - - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments+querysuggestion\} - - - - - - - - - - - - - - - - - - - - - - - -##### relation \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments+relation\} - - - - - -How this document relates to the including entity. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### results \{#operation-people+responses+200+application-json+relateddocuments+relateddocuments+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-people+responses+200+application-json+results\} - - - - - -A list of POC for company. - - - - - - - - - -#### Person \{#operation-people+responses+200+application-json+results+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-people+responses+200+application-json+results+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-people+responses+200+application-json+results+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-people+responses+200+application-json+results+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-people+responses+200+application-json+results+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/governance/data/reports.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/governance/data/reports.mdx deleted file mode 100644 index 6640860cf..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/governance/data/reports.mdx +++ /dev/null @@ -1,4648 +0,0 @@ ---- -sidebar_position: 3.9 -sidebar_label: Client Governance Data Reports ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedconfig from "../../../../../../../src/components/glean-embeds/loaders/config.tsx"; -import Embedcreatedby from "../../../../../../../src/components/glean-embeds/loaders/createdby.tsx"; -import Embedupdatedby from "../../../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; -import Embedallowlistoptions from "../../../../../../../src/components/glean-embeds/loaders/allowlistoptions.tsx"; -import Embedbroadsharingoptions from "../../../../../../../src/components/glean-embeds/loaders/broadsharingoptions.tsx"; -import Embedexternalsharingoptions from "../../../../../../../src/components/glean-embeds/loaders/externalsharingoptions.tsx"; -import Embedinputoptions from "../../../../../../../src/components/glean-embeds/loaders/inputoptions.tsx"; -import Embedsensitivecontentoptions from "../../../../../../../src/components/glean-embeds/loaders/sensitivecontentoptions.tsx"; -import Embedsensitiveinfotypes from "../../../../../../../src/components/glean-embeds/loaders/sensitiveinfotypes.tsx"; - - - - - - - -# Client Governance Data Reports Endpoints - - - - - - - - - -## GET /rest/api/v1/governance/data/policies/\{id\} \{#operation-getpolicy\} - - - - - -_Gets specified policy_ - - - - - -Fetches the specified policy version, or the latest if no version is provided. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/policies/{id} \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getpolicy+parameters\} - - - - - - - - - - - -##### id \{#operation-getpolicy+parameters+id\} - - - - - -The id of the policy to fetch. - - - - - - - - - -##### version \{#operation-getpolicy+parameters+version\} - - - - - -The version of the policy to fetch. Each time a policy is updated, the older version is still stored. If this is left empty, the latest policy is fetched. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getpolicy+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getpolicy+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DlpReport","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### report \{#operation-getpolicy+responses+200+application-json+report\} - - - - - -Full policy information that will be used for scans. - - - - - - - - - -#### DlpReport \{#operation-getpolicy+responses+200+application-json+report+dlpreport\} - - - - - -Full policy information that will be used for scans. - - - - - - - - - -##### autoHideDocs \{#operation-getpolicy+responses+200+application-json+report+dlpreport+autohidedocs\} - - - - - -Auto hide documents with findings in the policy. - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### config \{#operation-getpolicy+responses+200+application-json+report+dlpreport+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-getpolicy+responses+200+application-json+report+dlpreport+createdat\} - - - - - -Timestamp at which the policy was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-getpolicy+responses+200+application-json+report+dlpreport+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-getpolicy+responses+200+application-json+report+dlpreport+frequency\} - - - - - -Interval between scans. DAILY is deprecated. - - - - - - - - - -##### id \{#operation-getpolicy+responses+200+application-json+report+dlpreport+id\} - - - - - - - - - -##### lastScanStartTime \{#operation-getpolicy+responses+200+application-json+report+dlpreport+lastscanstarttime\} - - - - - -The timestamp at which the report's last run/scan began. - - - - - - - - - -##### lastScanStatus \{#operation-getpolicy+responses+200+application-json+report+dlpreport+lastscanstatus\} - - - - - - - - - -##### lastUpdatedAt \{#operation-getpolicy+responses+200+application-json+report+dlpreport+lastupdatedat\} - - - - - -Timestamp at which the policy was last updated. - - - - - - - - - -##### name \{#operation-getpolicy+responses+200+application-json+report+dlpreport+name\} - - - - - - - - - -##### status \{#operation-getpolicy+responses+200+application-json+report+dlpreport+status\} - - - - - -The status of the policy/report. Only ACTIVE status will be picked for scans. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-getpolicy+responses+200+application-json+report+dlpreport+updatedby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/governance/data/policies/\{id\} \{#operation-updatepolicy\} - - - - - -_Updates an existing policy_ - - - - - -Updates an existing policy. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/policies/{id} \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-updatepolicy+parameters\} - - - - - - - - - - - -##### id \{#operation-updatepolicy+parameters+id\} - - - - - -The id of the policy to fetch. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-updatepolicy+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-updatepolicy+request\} - - - - - - - - - - - -##### autoHideDocs \{#operation-updatepolicy+request+autohidedocs\} - - - - - -The new autoHideDoc boolean the policy will be updated to if provided. - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### config \{#operation-updatepolicy+request+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - -#### DlpConfig \{#operation-updatepolicy+request+config+dlpconfig\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - -AllowlistOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowlistOptions \{#operation-updatepolicy+request+config+dlpconfig+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - - - - - - - - - - - - - - - -##### autoHideDocs \{#operation-updatepolicy+request+config+dlpconfig+autohidedocs\} - - - - - -auto hide documents with findings in the report - - - - - -SharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### broadSharingOptions \{#operation-updatepolicy+request+config+dlpconfig+broadsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-updatepolicy+request+config+dlpconfig+createdat\} - - - - - -Timestamp at which this configuration was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-updatepolicy+request+config+dlpconfig+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - -ExternalSharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### externalSharingOptions \{#operation-updatepolicy+request+config+dlpconfig+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-updatepolicy+request+config+dlpconfig+frequency\} - - - - - -Interval between scans. - - - - - -InputOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputOptions \{#operation-updatepolicy+request+config+dlpconfig+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - - - - - - - - - - - - - - - - - - - -##### redactQuote \{#operation-updatepolicy+request+config+dlpconfig+redactquote\} - - - - - -redact quote in findings of the report - - - - - - - - - -##### reportName \{#operation-updatepolicy+request+config+dlpconfig+reportname\} - - - - - -SensitiveContentOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveContentOptions \{#operation-updatepolicy+request+config+dlpconfig+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - - - - - - - - - - - - - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveInfoTypes \{#operation-updatepolicy+request+config+dlpconfig+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - - - - - - - - - - - - - - - -##### version \{#operation-updatepolicy+request+config+dlpconfig+version\} - - - - - -Synonymous with report/policy id. - - - - - - - - - - - - - - - - - -##### frequency \{#operation-updatepolicy+request+frequency\} - - - - - -Interval between scans. DAILY is deprecated. - - - - - - - - - -##### reportName \{#operation-updatepolicy+request+reportname\} - - - - - -The new name of the policy if provided. - - - - - - - - - -##### status \{#operation-updatepolicy+request+status\} - - - - - -The status of the policy/report. Only ACTIVE status will be picked for scans. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-updatepolicy+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-updatepolicy+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### result \{#operation-updatepolicy+responses+200+application-json; charset=utf-8+result\} - - - - - - - - - - - - - -     - - - - - -## GET /rest/api/v1/governance/data/policies \{#operation-listpolicies\} - - - - - -_Lists policies_ - - - - - -Lists policies with filtering. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/policies \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-listpolicies+parameters\} - - - - - - - - - - - -##### autoHide \{#operation-listpolicies+parameters+autohide\} - - - - - -Filter to return reports with a given value of auto-hide. - - - - - - - - - -##### frequency \{#operation-listpolicies+parameters+frequency\} - - - - - -Filter to return reports with a given frequency. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listpolicies+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-listpolicies+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DlpReport","children":[{"label":"DlpReport","linkedLabel":"DlpReport","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### reports \{#operation-listpolicies+responses+200+application-json+reports\} - - - - - - - - - -#### DlpReport \{#operation-listpolicies+responses+200+application-json+reports+dlpreport\} - - - - - -Full policy information that will be used for scans. - - - - - - - - - -##### autoHideDocs \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+autohidedocs\} - - - - - -Auto hide documents with findings in the policy. - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### config \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+createdat\} - - - - - -Timestamp at which the policy was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+frequency\} - - - - - -Interval between scans. DAILY is deprecated. - - - - - - - - - -##### id \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+id\} - - - - - - - - - -##### lastScanStartTime \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+lastscanstarttime\} - - - - - -The timestamp at which the report's last run/scan began. - - - - - - - - - -##### lastScanStatus \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+lastscanstatus\} - - - - - - - - - -##### lastUpdatedAt \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+lastupdatedat\} - - - - - -Timestamp at which the policy was last updated. - - - - - - - - - -##### name \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+name\} - - - - - - - - - -##### status \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+status\} - - - - - -The status of the policy/report. Only ACTIVE status will be picked for scans. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-listpolicies+responses+200+application-json+reports+dlpreport+updatedby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/governance/data/policies \{#operation-createpolicy\} - - - - - -_Creates new policy_ - - - - - -Creates a new policy with specified specifications and returns its id. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/policies \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createpolicy+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createpolicy+request\} - - - - - - - - - - - -##### autoHideDocs \{#operation-createpolicy+request+autohidedocs\} - - - - - -Controls whether the policy should hide documents with violations. - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### config \{#operation-createpolicy+request+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - -#### DlpConfig \{#operation-createpolicy+request+config+dlpconfig\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - -AllowlistOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowlistOptions \{#operation-createpolicy+request+config+dlpconfig+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - - - - - - - - - - - - - - - -##### autoHideDocs \{#operation-createpolicy+request+config+dlpconfig+autohidedocs\} - - - - - -auto hide documents with findings in the report - - - - - -SharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### broadSharingOptions \{#operation-createpolicy+request+config+dlpconfig+broadsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-createpolicy+request+config+dlpconfig+createdat\} - - - - - -Timestamp at which this configuration was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-createpolicy+request+config+dlpconfig+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - -ExternalSharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### externalSharingOptions \{#operation-createpolicy+request+config+dlpconfig+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-createpolicy+request+config+dlpconfig+frequency\} - - - - - -Interval between scans. - - - - - -InputOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputOptions \{#operation-createpolicy+request+config+dlpconfig+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - - - - - - - - - - - - - - - - - - - -##### redactQuote \{#operation-createpolicy+request+config+dlpconfig+redactquote\} - - - - - -redact quote in findings of the report - - - - - - - - - -##### reportName \{#operation-createpolicy+request+config+dlpconfig+reportname\} - - - - - -SensitiveContentOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveContentOptions \{#operation-createpolicy+request+config+dlpconfig+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - - - - - - - - - - - - - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveInfoTypes \{#operation-createpolicy+request+config+dlpconfig+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - - - - - - - - - - - - - - - -##### version \{#operation-createpolicy+request+config+dlpconfig+version\} - - - - - -Synonymous with report/policy id. - - - - - - - - - - - - - - - - - -##### frequency \{#operation-createpolicy+request+frequency\} - - - - - -Interval between scans. DAILY is deprecated. - - - - - - - - - -##### name \{#operation-createpolicy+request+name\} - - - - - -Name of the policy being created. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createpolicy+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-createpolicy+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DlpReport","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### report \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report\} - - - - - -Full policy information that will be used for scans. - - - - - - - - - -#### DlpReport \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport\} - - - - - -Full policy information that will be used for scans. - - - - - - - - - -##### autoHideDocs \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+autohidedocs\} - - - - - -Auto hide documents with findings in the policy. - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### config \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+createdat\} - - - - - -Timestamp at which the policy was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+frequency\} - - - - - -Interval between scans. DAILY is deprecated. - - - - - - - - - -##### id \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+id\} - - - - - - - - - -##### lastScanStartTime \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+lastscanstarttime\} - - - - - -The timestamp at which the report's last run/scan began. - - - - - - - - - -##### lastScanStatus \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+lastscanstatus\} - - - - - - - - - -##### lastUpdatedAt \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+lastupdatedat\} - - - - - -Timestamp at which the policy was last updated. - - - - - - - - - -##### name \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+name\} - - - - - - - - - -##### status \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+status\} - - - - - -The status of the policy/report. Only ACTIVE status will be picked for scans. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-createpolicy+responses+200+application-json; charset=utf-8+report+dlpreport+updatedby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /rest/api/v1/governance/data/policies/\{id\}/download \{#operation-downloadpolicycsv\} - - - - - -_Downloads violations CSV for policy_ - - - - - -Downloads CSV violations report for a specific policy id. This does not support continuous policies. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/policies/{id}/download \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-downloadpolicycsv+parameters\} - - - - - - - - - - - -##### id \{#operation-downloadpolicycsv+parameters+id\} - - - - - -The id of the policy to download violations for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-downloadpolicycsv+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Responses \{#operation-downloadpolicycsv+responses\} - - - - - -200 - - - - - - - - - - - - - -Downloads csv of batch policy violations. - - - - - - - - - -     - - - - - -## POST /rest/api/v1/governance/data/reports \{#operation-createreport\} - - - - - -_Creates new one-time report_ - - - - - -Creates a new one-time report and executes its batch job. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/reports \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createreport+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createreport+request\} - - - - - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### config \{#operation-createreport+request+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - -#### DlpConfig \{#operation-createreport+request+config+dlpconfig\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - -AllowlistOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowlistOptions \{#operation-createreport+request+config+dlpconfig+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - - - - - - - - - - - - - - - -##### autoHideDocs \{#operation-createreport+request+config+dlpconfig+autohidedocs\} - - - - - -auto hide documents with findings in the report - - - - - -SharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### broadSharingOptions \{#operation-createreport+request+config+dlpconfig+broadsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#operation-createreport+request+config+dlpconfig+createdat\} - - - - - -Timestamp at which this configuration was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-createreport+request+config+dlpconfig+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - -ExternalSharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### externalSharingOptions \{#operation-createreport+request+config+dlpconfig+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#operation-createreport+request+config+dlpconfig+frequency\} - - - - - -Interval between scans. - - - - - -InputOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputOptions \{#operation-createreport+request+config+dlpconfig+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - - - - - - - - - - - - - - - - - - - -##### redactQuote \{#operation-createreport+request+config+dlpconfig+redactquote\} - - - - - -redact quote in findings of the report - - - - - - - - - -##### reportName \{#operation-createreport+request+config+dlpconfig+reportname\} - - - - - -SensitiveContentOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveContentOptions \{#operation-createreport+request+config+dlpconfig+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - - - - - - - - - - - - - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveInfoTypes \{#operation-createreport+request+config+dlpconfig+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - - - - - - - - - - - - - - - -##### version \{#operation-createreport+request+config+dlpconfig+version\} - - - - - -Synonymous with report/policy id. - - - - - - - - - - - - - - - - - -##### frequency \{#operation-createreport+request+frequency\} - - - - - -Only "ONCE" is supported for reports. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createreport+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-createreport+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### reportId \{#operation-createreport+responses+200+application-json; charset=utf-8+reportid\} - - - - - -The id of the report that was just created and run. - - - - - - - - - -##### result \{#operation-createreport+responses+200+application-json; charset=utf-8+result\} - - - - - - - - - - - - - -     - - - - - -## GET /rest/api/v1/governance/data/reports/\{id\}/download \{#operation-downloadreportcsv\} - - - - - -_Downloads violations CSV for report_ - - - - - -Downloads CSV violations report for a specific report id. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/reports/{id}/download \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-downloadreportcsv+parameters\} - - - - - - - - - - - -##### id \{#operation-downloadreportcsv+parameters+id\} - - - - - -The id of the report to download violations for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-downloadreportcsv+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Responses \{#operation-downloadreportcsv+responses\} - - - - - -200 - - - - - - - - - - - - - -Downloads csv of one-time report violations. - - - - - - - - - -     - - - - - -## GET /rest/api/v1/governance/data/reports/\{id\}/status \{#operation-getreportstatus\} - - - - - -_Fetches report run status_ - - - - - -Fetches the status of the run corresponding to the report-id. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/data/reports/{id}/status \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getreportstatus+parameters\} - - - - - - - - - - - -##### id \{#operation-getreportstatus+parameters+id\} - - - - - -The id of the report to get run status for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getreportstatus+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getreportstatus+responses\} - - - - - -200 - - - - - - - -Fetches status of report run. - - - - - - - - - -##### startTime \{#operation-getreportstatus+responses+200+application-json; charset=utf-8+starttime\} - - - - - -The timestamp at which the report's run/scan began. - - - - - - - - - -##### status \{#operation-getreportstatus+responses+200+application-json; charset=utf-8+status\} - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/governance/documents/visibilityoverrides.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/governance/documents/visibilityoverrides.mdx deleted file mode 100644 index 65583406e..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/governance/documents/visibilityoverrides.mdx +++ /dev/null @@ -1,737 +0,0 @@ ---- -sidebar_position: 3.10 -sidebar_label: Client Governance Documents Visibilityoverrides ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Client Governance Documents Visibilityoverrides Endpoints - - - - - - - - - -## GET /rest/api/v1/governance/documents/visibilityoverrides \{#operation-getdocvisibility\} - - - - - -_Fetches documents visibility_ - - - - - -Fetches the visibility override status of the documents passed. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/documents/visibilityoverrides \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-getdocvisibility+parameters\} - - - - - - - - - - - -##### docIds \{#operation-getdocvisibility+parameters+docids\} - - - - - -List of doc-ids which will have their hide status fetched. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getdocvisibility+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getdocvisibility+responses\} - - - - - -200 - - - - - - - -The visibility status of documents - - - - - -DocumentVisibilityOverride","children":[{"label":"DocumentVisibilityOverride","linkedLabel":"DocumentVisibilityOverride","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### visibilityOverrides \{#operation-getdocvisibility+responses+200+application-json; charset=utf-8+visibilityoverrides\} - - - - - - - - - -#### DocumentVisibilityOverride \{#operation-getdocvisibility+responses+200+application-json; charset=utf-8+visibilityoverrides+documentvisibilityoverride\} - - - - - - - - - -##### docId \{#operation-getdocvisibility+responses+200+application-json; charset=utf-8+visibilityoverrides+documentvisibilityoverride+docid\} - - - - - - - - - -##### override \{#operation-getdocvisibility+responses+200+application-json; charset=utf-8+visibilityoverrides+documentvisibilityoverride+override\} - - - - - -The visibility-override state of the document. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/governance/documents/visibilityoverrides \{#operation-setdocvisibility\} - - - - - -_Hide or unhide docs_ - - - - - -Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/governance/documents/visibilityoverrides \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-setdocvisibility+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-setdocvisibility+request\} - - - - - - - -DocumentVisibilityOverride","children":[{"label":"DocumentVisibilityOverride","linkedLabel":"DocumentVisibilityOverride","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### visibilityOverrides \{#operation-setdocvisibility+request+visibilityoverrides\} - - - - - - - - - -#### DocumentVisibilityOverride \{#operation-setdocvisibility+request+visibilityoverrides+documentvisibilityoverride\} - - - - - - - - - -##### docId \{#operation-setdocvisibility+request+visibilityoverrides+documentvisibilityoverride+docid\} - - - - - - - - - -##### override \{#operation-setdocvisibility+request+visibilityoverrides+documentvisibilityoverride+override\} - - - - - -The visibility-override state of the document. - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-setdocvisibility+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-setdocvisibility+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DocumentVisibilityUpdateResult","children":[{"label":"DocumentVisibilityUpdateResult","linkedLabel":"DocumentVisibilityUpdateResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-setdocvisibility+responses+200+application-json; charset=utf-8+results\} - - - - - -The documents and whether their visibility was successfully updated. - - - - - - - - - -#### DocumentVisibilityUpdateResult \{#operation-setdocvisibility+responses+200+application-json; charset=utf-8+results+documentvisibilityupdateresult\} - - - - - - - - - -##### docId \{#operation-setdocvisibility+responses+200+application-json; charset=utf-8+results+documentvisibilityupdateresult+docid\} - - - - - - - - - -##### override \{#operation-setdocvisibility+responses+200+application-json; charset=utf-8+results+documentvisibilityupdateresult+override\} - - - - - -The visibility-override state of the document. - - - - - - - - - -##### success \{#operation-setdocvisibility+responses+200+application-json; charset=utf-8+results+documentvisibilityupdateresult+success\} - - - - - -Whether this document was successfully set to its desired visibility state. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/insights.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/insights.mdx deleted file mode 100644 index f2c5974e3..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/insights.mdx +++ /dev/null @@ -1,3076 +0,0 @@ ---- -sidebar_position: 3.11 -sidebar_label: Client Insights ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedend from "../../../../../src/components/glean-embeds/loaders/end.tsx"; -import Embedstart from "../../../../../src/components/glean-embeds/loaders/start.tsx"; -import Embedassistantinsights from "../../../../../src/components/glean-embeds/loaders/assistantinsights.tsx"; -import Embedactioncounts from "../../../../../src/components/glean-embeds/loaders/actioncounts.tsx"; -import Embedaiappinsights from "../../../../../src/components/glean-embeds/loaders/aiappinsights.tsx"; -import Embeddocumentinsights from "../../../../../src/components/glean-embeds/loaders/documentinsights.tsx"; -import Embedactivityinsights from "../../../../../src/components/glean-embeds/loaders/activityinsights.tsx"; -import Embedlowperformingqueryinsights from "../../../../../src/components/glean-embeds/loaders/lowperformingqueryinsights.tsx"; -import Embedqueryinsights from "../../../../../src/components/glean-embeds/loaders/queryinsights.tsx"; -import Embedshortcutinsights from "../../../../../src/components/glean-embeds/loaders/shortcutinsights.tsx"; -import Embedcountinfo from "../../../../../src/components/glean-embeds/loaders/countinfo.tsx"; -import Embedinactiveinsights from "../../../../../src/components/glean-embeds/loaders/inactiveinsights.tsx"; - - - - - - - -# Client Insights Endpoints - - - - - - - - - -## POST /rest/api/v1/insights \{#operation-insights\} - - - - - -_Read insights_ - - - - - -Reads the aggregate information for each user, query, and content. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/insights \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "categories": [ - "AGENTS" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-insights+request-examples\} - - - - - -```json -{ - "categories": [ - "AGENTS" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-insights+request\} - - - - - - - -Includes request params for insights dashboard data. - - - - - -InsightsAgentsRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### agentsRequestOptions \{#operation-insights+request+agentsrequestoptions\} - - - - - - - - - -#### InsightsAgentsRequestOptions \{#operation-insights+request+agentsrequestoptions+insightsagentsrequestoptions\} - - - - - - - - - -##### agentIds \{#operation-insights+request+agentsrequestoptions+insightsagentsrequestoptions+agentids\} - - - - - -IDs of the Agents for which Insights should be returned. An empty array signifies all. - - - - - - - - - - - - - -InsightsAiAppRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### aiAppRequestOptions \{#operation-insights+request+aiapprequestoptions\} - - - - - - - - - -#### InsightsAiAppRequestOptions \{#operation-insights+request+aiapprequestoptions+insightsaiapprequestoptions\} - - - - - - - - - -##### aiAppIds \{#operation-insights+request+aiapprequestoptions+insightsaiapprequestoptions+aiappids\} - - - - - -IDs of the AI Apps for which Insights should be returned. An empty array signifies all. - - - - - - - - - - - - - - - - - -##### assistantActivityTypes \{#operation-insights+request+assistantactivitytypes\} - - - - - -Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category. - - - - - - - - - -##### categories \{#operation-insights+request+categories\} - - - - - -Categories of data requested. Request can include single or multiple types. - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### dayRange \{#operation-insights+request+dayrange\} - - - - - - - - - -#### Period \{#operation-insights+request+dayrange+period\} - - - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### end \{#operation-insights+request+dayrange+period+end\} - - - - - - - - - - - - - - - - - - - - - - - -##### maxDaysFromNow \{#operation-insights+request+dayrange+period+maxdaysfromnow\} - - - - - -DEPRECATED - The number of days from now in the past to define lower boundary of time period. - - - - - - - - - -##### minDaysFromNow \{#operation-insights+request+dayrange+period+mindaysfromnow\} - - - - - -DEPRECATED - The number of days from now in the past to define upper boundary of time period. - - - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### start \{#operation-insights+request+dayrange+period+start\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### departments \{#operation-insights+request+departments\} - - - - - -Departments that the data is requested for. If this is empty, corresponds to whole company. - - - - - - - - - -##### disablePerUserInsights \{#operation-insights+request+disableperuserinsights\} - - - - - -If true, suppresses the generation of per-user Insights in the response. Default is false. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-insights+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-insights+responses\} - - - - - -200 - - - - - - - -OK - - - - - -AiInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### ai \{#operation-insights+responses+200+application-json+ai\} - - - - - - - - - -#### AiInsightsResponse \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse\} - - - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### assistantInsights \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+assistantinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - - - - - - - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+departments\} - - - - - -list of departments applicable for users tab. - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### totalActiveAssistantUsers \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalactiveassistantusers\} - - - - - -Total number of Active Assistant users (chat, summary, AIA) in requested period. - - - - - - - - - -##### totalAiAnswers \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalaianswers\} - - - - - -Total number of AI Answers generated in the requested period. - - - - - - - - - -##### totalAiSummarizations \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalaisummarizations\} - - - - - -Total number of AI Document Summarizations invoked in the requested period. - - - - - - - - - -##### totalChatMessages \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalchatmessages\} - - - - - -Total number of Chat messages sent in requested period. - - - - - - - - - -##### totalDownvotes \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totaldownvotes\} - - - - - -Total number of Chat messages which received downvotes by the user. - - - - - - - - - -##### totalGleanbotResponses \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalgleanbotresponses\} - - - - - -Total number of Gleanbot responses, both proactive and reactive. - - - - - - - - - -##### totalGleanbotResponsesNotHelpful \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalgleanbotresponsesnothelpful\} - - - - - -Total number of Glean responses rejected as not helpful (downvoted). - - - - - - - - - -##### totalGleanbotResponsesShared \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalgleanbotresponsesshared\} - - - - - -Total number of Gleanbot responses shared publicly (upvoted). - - - - - - - - - -##### totalUpvotes \{#operation-insights+responses+200+application-json+ai+aiinsightsresponse+totalupvotes\} - - - - - -Total number of Chat messages which received upvotes by the user. - - - - - - - - - - - - - -AiAppsInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### aiApps \{#operation-insights+responses+200+application-json+aiapps\} - - - - - - - - - -#### AiAppsInsightsResponse \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse\} - - - - - -AiAppActionCounts","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### actionCounts \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse+actioncounts\} - - - - - -Map from action to frequency. - - - - - - - - - - - - - - - - - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### aiAppInsights \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse+aiappinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - - - - - - - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse+departments\} - - - - - -list of departments applicable for users tab. - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### totalActiveUsers \{#operation-insights+responses+200+application-json+aiapps+aiappsinsightsresponse+totalactiveusers\} - - - - - -Total number of active users on the Ai App in the requested period. - - - - - - - - - - - - - -ContentInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### announcements \{#operation-insights+responses+200+application-json+announcements\} - - - - - - - - - -#### ContentInsightsResponse \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse+departments\} - - - - - -list of departments applicable for contents tab. - - - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentInsights \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minDepartmentSizeThreshold \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse+mindepartmentsizethreshold\} - - - - - -Min threshold in size of departments while populating results, otherwise 0. - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+announcements+contentinsightsresponse+minvisitorthreshold\} - - - - - -Minimum number of visitors to a document required to be included in insights. - - - - - - - - - - - - - -ContentInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answers \{#operation-insights+responses+200+application-json+answers\} - - - - - - - - - -#### ContentInsightsResponse \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse+departments\} - - - - - -list of departments applicable for contents tab. - - - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentInsights \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minDepartmentSizeThreshold \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse+mindepartmentsizethreshold\} - - - - - -Min threshold in size of departments while populating results, otherwise 0. - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+answers+contentinsightsresponse+minvisitorthreshold\} - - - - - -Minimum number of visitors to a document required to be included in insights. - - - - - - - - - - - - - -ContentInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collections \{#operation-insights+responses+200+application-json+collections\} - - - - - - - - - -#### ContentInsightsResponse \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse+departments\} - - - - - -list of departments applicable for contents tab. - - - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentInsights \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minDepartmentSizeThreshold \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse+mindepartmentsizethreshold\} - - - - - -Min threshold in size of departments while populating results, otherwise 0. - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+collections+contentinsightsresponse+minvisitorthreshold\} - - - - - -Minimum number of visitors to a document required to be included in insights. - - - - - - - - - - - - - -ContentInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collectionsV2 \{#operation-insights+responses+200+application-json+collectionsv2\} - - - - - - - - - -#### ContentInsightsResponse \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse+departments\} - - - - - -list of departments applicable for contents tab. - - - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentInsights \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minDepartmentSizeThreshold \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse+mindepartmentsizethreshold\} - - - - - -Min threshold in size of departments while populating results, otherwise 0. - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+collectionsv2+contentinsightsresponse+minvisitorthreshold\} - - - - - -Minimum number of visitors to a document required to be included in insights. - - - - - - - - - - - - - -ContentInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### content \{#operation-insights+responses+200+application-json+content\} - - - - - - - - - -#### ContentInsightsResponse \{#operation-insights+responses+200+application-json+content+contentinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+content+contentinsightsresponse+departments\} - - - - - -list of departments applicable for contents tab. - - - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentInsights \{#operation-insights+responses+200+application-json+content+contentinsightsresponse+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+content+contentinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minDepartmentSizeThreshold \{#operation-insights+responses+200+application-json+content+contentinsightsresponse+mindepartmentsizethreshold\} - - - - - -Min threshold in size of departments while populating results, otherwise 0. - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+content+contentinsightsresponse+minvisitorthreshold\} - - - - - -Minimum number of visitors to a document required to be included in insights. - - - - - - - - - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+departments\} - - - - - -list of all departments. - - - - - -GleanAssistInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### gleanAssist \{#operation-insights+responses+200+application-json+gleanassist\} - - - - - - - - - -#### GleanAssistInsightsResponse \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse\} - - - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityInsights \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse+activityinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceInstances \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse+datasourceinstances\} - - - - - -List of datasource instances for which glean assist is enabled. - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse+departments\} - - - - - -List of departments applicable for users tab. - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### totalActiveUsers \{#operation-insights+responses+200+application-json+gleanassist+gleanassistinsightsresponse+totalactiveusers\} - - - - - -Total number of active users in the requested period. - - - - - - - - - - - - - -QueryInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### queries \{#operation-insights+responses+200+application-json+queries\} - - - - - - - - - -#### QueryInsightsResponse \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse+departments\} - - - - - -list of departments applicable for queries tab. - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lowPerformingQueryInsights \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse+lowperformingqueryinsights\} - - - - - -Insights for queries. - - - - - - - - - - - - - - - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse+minvisitorthreshold\} - - - - - -Min threshold in number of visitors while populating results, otherwise 0. - - - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### queryInsights \{#operation-insights+responses+200+application-json+queries+queryinsightsresponse+queryinsights\} - - - - - -Insights for queries. - - - - - - - - - - - - - - - - - - - - - - - - - - - -ShortcutInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcuts \{#operation-insights+responses+200+application-json+shortcuts\} - - - - - - - - - -#### ShortcutInsightsResponse \{#operation-insights+responses+200+application-json+shortcuts+shortcutinsightsresponse\} - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+shortcuts+shortcutinsightsresponse+departments\} - - - - - -list of departments applicable for shortcuts tab. - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+shortcuts+shortcutinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### minVisitorThreshold \{#operation-insights+responses+200+application-json+shortcuts+shortcutinsightsresponse+minvisitorthreshold\} - - - - - -Min threshold in number of visitors while populating results, otherwise 0. - - - - - -ShortcutInsight","children":[{"label":"ShortcutInsight","linkedLabel":"ShortcutInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcutInsights \{#operation-insights+responses+200+application-json+shortcuts+shortcutinsightsresponse+shortcutinsights\} - - - - - -Insights for shortcuts. - - - - - - - - - - - - - - - - - - - - - - - - - - - -LabeledCountInfo","children":[{"label":"LabeledCountInfo","linkedLabel":"LabeledCountInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### timeseries \{#operation-insights+responses+200+application-json+timeseries\} - - - - - -List of timeseries to make charts (if applicable). - - - - - - - - - -#### LabeledCountInfo \{#operation-insights+responses+200+application-json+timeseries+labeledcountinfo\} - - - - - -CountInfo","children":[{"label":"CountInfo","linkedLabel":"CountInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### countInfo \{#operation-insights+responses+200+application-json+timeseries+labeledcountinfo+countinfo\} - - - - - -Number of visitors to the document during included time periods. - - - - - - - - - - - - - - - - - - - - - - - -##### label \{#operation-insights+responses+200+application-json+timeseries+labeledcountinfo+label\} - - - - - -Label for the included count information. - - - - - - - - - - - - - -UserInsightsResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### users \{#operation-insights+responses+200+application-json+users\} - - - - - - - - - -#### UserInsightsResponse \{#operation-insights+responses+200+application-json+users+userinsightsresponse\} - - - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityInsights \{#operation-insights+responses+200+application-json+users+userinsightsresponse+activityinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - - - - - - - - - - - - - - - -##### departments \{#operation-insights+responses+200+application-json+users+userinsightsresponse+departments\} - - - - - -list of departments applicable for users tab. - - - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inactiveInsights \{#operation-insights+responses+200+application-json+users+userinsightsresponse+inactiveinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - - - - - - - - - - - - - - - -##### lastLogTimestamp \{#operation-insights+responses+200+application-json+users+userinsightsresponse+lastlogtimestamp\} - - - - - -Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - - - - - - - - - -##### totalActiveUsers \{#operation-insights+responses+200+application-json+users+userinsightsresponse+totalactiveusers\} - - - - - -Total number of active users in the requested period. - - - - - - - - - -##### totalTeammates \{#operation-insights+responses+200+application-json+users+userinsightsresponse+totalteammates\} - - - - - -Total number of teammates that have logged in to the product, that are still valid teammates. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/messages.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/messages.mdx deleted file mode 100644 index efbd28df7..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/messages.mdx +++ /dev/null @@ -1,1825 +0,0 @@ ---- -sidebar_position: 3.12 -sidebar_label: Client Messages ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedallclusteredresults from "../../../../../src/components/glean-embeds/loaders/allclusteredresults.tsx"; -import Embedattachments from "../../../../../src/components/glean-embeds/loaders/attachments.tsx"; -import Embedbacklinkresults from "../../../../../src/components/glean-embeds/loaders/backlinkresults.tsx"; -import Embedclusteredresults from "../../../../../src/components/glean-embeds/loaders/clusteredresults.tsx"; -import Embeddocument from "../../../../../src/components/glean-embeds/loaders/document.tsx"; -import Embedmustincludesuggestions from "../../../../../src/components/glean-embeds/loaders/mustincludesuggestions.tsx"; -import Embedpins from "../../../../../src/components/glean-embeds/loaders/pins.tsx"; -import Embedquerysuggestion from "../../../../../src/components/glean-embeds/loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../../../../../src/components/glean-embeds/loaders/relatedresults.tsx"; -import Embedsnippets from "../../../../../src/components/glean-embeds/loaders/snippets.tsx"; -import Embedstructuredresults from "../../../../../src/components/glean-embeds/loaders/structuredresults.tsx"; -import Embedgleandataerror from "../../../../../src/components/glean-embeds/loaders/gleandataerror.tsx"; -import Embedfacetresults from "../../../../../src/components/glean-embeds/loaders/facetresults.tsx"; -import Embedgeneratedqnaresult from "../../../../../src/components/glean-embeds/loaders/generatedqnaresult.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedresulttabs from "../../../../../src/components/glean-embeds/loaders/resulttabs.tsx"; -import Embedresults from "../../../../../src/components/glean-embeds/loaders/results.tsx"; -import Embedresultsdescription from "../../../../../src/components/glean-embeds/loaders/resultsdescription.tsx"; -import Embedrewrittenfacetfilters from "../../../../../src/components/glean-embeds/loaders/rewrittenfacetfilters.tsx"; -import Embedsessioninfo from "../../../../../src/components/glean-embeds/loaders/sessioninfo.tsx"; - - - - - - - -# Client Messages Endpoints - - - - - - - - - -## POST /rest/api/v1/messages \{#operation-messages\} - - - - - -_Read messages_ - - - - - -Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams). - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/messages \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "ipsum eiusmod", - "idType": "CHANNEL_NAME" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-messages+request-examples\} - - - - - -```json -{ - "id": "ipsum eiusmod", - "idType": "CHANNEL_NAME" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-messages+request\} - - - - - - - -Includes request params such as the id for channel/message and direction. - - - - - - - - - -##### datasource \{#operation-messages+request+datasource\} - - - - - -The type of the data source. Missing field defaults to SLACK. - - - - - - - - - -##### datasourceInstanceDisplayName \{#operation-messages+request+datasourceinstancedisplayname\} - - - - - -The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances. - - - - - - - - - -##### direction \{#operation-messages+request+direction\} - - - - - -The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. - - - - - - - - - -##### id \{#operation-messages+request+id\} - - - - - -ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID. - - - - - - - - - -##### idType \{#operation-messages+request+idtype\} - - - - - -Type of the id in the incoming request. - - - - - - - - - -##### includeRootMessage \{#operation-messages+request+includerootmessage\} - - - - - -Whether to include root message in response. - - - - - - - - - -##### timestampMillis \{#operation-messages+request+timestampmillis\} - - - - - -Timestamp in millis of the reference message. Only applicable when using a message_id. - - - - - - - - - -##### workspaceId \{#operation-messages+request+workspaceid\} - - - - - -Id for the for the workspace in case of multiple workspaces. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-messages+responses-examples\} - - - - - -200 - - - - - -```json -{ - "hasMore": false -} -``` - - - - - - - - - - - - - -### Responses \{#operation-messages+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### hasMore \{#operation-messages+responses+200+application-json+hasmore\} - - - - - -Whether there are more results for client to continue requesting. - - - - - -SearchResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### rootMessage \{#operation-messages+responses+200+application-json+rootmessage\} - - - - - - - - - -#### SearchResult \{#operation-messages+responses+200+application-json+rootmessage+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#operation-messages+responses+200+application-json+rootmessage+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - - - - - - - - - - - -##### attachmentContext \{#operation-messages+responses+200+application-json+rootmessage+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#operation-messages+responses+200+application-json+rootmessage+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#operation-messages+responses+200+application-json+rootmessage+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#operation-messages+responses+200+application-json+rootmessage+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#operation-messages+responses+200+application-json+rootmessage+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#operation-messages+responses+200+application-json+rootmessage+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-messages+responses+200+application-json+rootmessage+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#operation-messages+responses+200+application-json+rootmessage+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#operation-messages+responses+200+application-json+rootmessage+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#operation-messages+responses+200+application-json+rootmessage+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#operation-messages+responses+200+application-json+rootmessage+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#operation-messages+responses+200+application-json+rootmessage+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-messages+responses+200+application-json+rootmessage+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-messages+responses+200+application-json+rootmessage+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#operation-messages+responses+200+application-json+rootmessage+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-messages+responses+200+application-json+rootmessage+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#operation-messages+responses+200+application-json+rootmessage+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-messages+responses+200+application-json+rootmessage+searchresult+title\} - - - - - - - - - -##### trackingToken \{#operation-messages+responses+200+application-json+rootmessage+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#operation-messages+responses+200+application-json+rootmessage+searchresult+url\} - - - - - - - - - - - - - -SearchResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchResponse \{#operation-messages+responses+200+application-json+searchresponse\} - - - - - - - - - -#### SearchResponse \{#operation-messages+responses+200+application-json+searchresponse+searchresponse\} - - - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### GleanDataError \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+gleandataerror\} - - - - - - - - - - - - - - - - - - - - - - - -##### backendTimeMillis \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - - - - - -##### cursor \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+cursor\} - - - - - -Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - - - - - - - - - -##### experimentIds \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+experimentids\} - - - - - -List of experiment ids for the corresponding request. - - - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetResults \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+facetresults\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQnaResult \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+generatedqnaresult\} - - - - - - - - - - - - - - - - - - - - - - - -##### hasMoreResults \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+hasmoreresults\} - - - - - -Whether more results are available. Use cursor to retrieve them. - - - - - -SearchResponseMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### requestID \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+requestid\} - - - - - -A platform-generated request ID to correlate backend logs. - - - - - - - - - -##### resultTabIds \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+resulttabids\} - - - - - -The unique IDs of the result tabs to which this response belongs. - - - - - -ResultTab","children":[{"label":"ResultTab","linkedLabel":"ResultTab","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### resultTabs \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+resulttabs\} - - - - - -All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### results \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -ResultsDescription","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### resultsDescription \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+resultsdescription\} - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### rewrittenFacetFilters \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+rewrittenfacetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sessionInfo \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+sessioninfo\} - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-messages+responses+200+application-json+searchresponse+searchresponse+trackingtoken\} - - - - - -A token that should be passed for additional requests related to this request (such as more results requests). - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/pins.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/pins.mdx deleted file mode 100644 index 16ecf7b30..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/pins.mdx +++ /dev/null @@ -1,3152 +0,0 @@ ---- -sidebar_position: 3.13 -sidebar_label: Client Pins ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedattribution from "../../../../../src/components/glean-embeds/loaders/attribution.tsx"; -import Embedaudiencefilters from "../../../../../src/components/glean-embeds/loaders/audiencefilters.tsx"; -import Embedupdatedby from "../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; - - - - - - - -# Client Pins Endpoints - - - - - - - - - -## POST /rest/api/v1/editpin \{#operation-editpin\} - - - - - -_Update pin_ - - - - - -Update an existing user-generated pin. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/editpin \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-editpin+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-editpin+request\} - - - - - - - -Edit pins request - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editpin+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editpin+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editpin+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editpin+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editpin+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-editpin+request+id\} - - - - - -The opaque id of the pin to be edited. - - - - - - - - - -##### queries \{#operation-editpin+request+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-editpin+responses-examples\} - - - - - -200 - - - - - -```json -{ - "documentId": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-editpin+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attribution \{#operation-editpin+responses+200+application-json+attribution\} - - - - - - - - - -#### Person \{#operation-editpin+responses+200+application-json+attribution+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editpin+responses+200+application-json+attribution+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editpin+responses+200+application-json+attribution+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editpin+responses+200+application-json+attribution+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editpin+responses+200+application-json+attribution+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-editpin+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-editpin+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-editpin+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-editpin+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-editpin+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-editpin+responses+200+application-json+createtime\} - - - - - - - - - -##### documentId \{#operation-editpin+responses+200+application-json+documentid\} - - - - - -The document which should be a pinned result. - - - - - - - - - -##### id \{#operation-editpin+responses+200+application-json+id\} - - - - - -The opaque id of the pin. - - - - - - - - - -##### queries \{#operation-editpin+responses+200+application-json+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -##### updateTime \{#operation-editpin+responses+200+application-json+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-editpin+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-editpin+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-editpin+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-editpin+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-editpin+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-editpin+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/getpin \{#operation-getpin\} - - - - - -_Read pin_ - - - - - -Read pin details given its ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getpin \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getpin+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getpin+request\} - - - - - - - -Get pin request - - - - - - - - - -##### id \{#operation-getpin+request+id\} - - - - - -The opaque id of the pin to be fetched. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getpin+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getpin+responses\} - - - - - -200 - - - - - - - -OK - - - - - -PinDocument","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pin \{#operation-getpin+responses+200+application-json+pin\} - - - - - - - - - -#### PinDocument \{#operation-getpin+responses+200+application-json+pin+pindocument\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attribution \{#operation-getpin+responses+200+application-json+pin+pindocument+attribution\} - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-getpin+responses+200+application-json+pin+pindocument+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-getpin+responses+200+application-json+pin+pindocument+createtime\} - - - - - - - - - -##### documentId \{#operation-getpin+responses+200+application-json+pin+pindocument+documentid\} - - - - - -The document which should be a pinned result. - - - - - - - - - -##### id \{#operation-getpin+responses+200+application-json+pin+pindocument+id\} - - - - - -The opaque id of the pin. - - - - - - - - - -##### queries \{#operation-getpin+responses+200+application-json+pin+pindocument+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -##### updateTime \{#operation-getpin+responses+200+application-json+pin+pindocument+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-getpin+responses+200+application-json+pin+pindocument+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listpins \{#operation-listpins\} - - - - - -_List pins_ - - - - - -Lists all pins. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listpins \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-listpins+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-listpins+request\} - - - - - - - -List pins request - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listpins+responses-examples\} - - - - - -200 - - - - - -```json -{ - "pins": [ - { - "documentId": "ipsum eiusmod" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-listpins+responses\} - - - - - -200 - - - - - - - -OK - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pins \{#operation-listpins+responses+200+application-json+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - -#### PinDocument \{#operation-listpins+responses+200+application-json+pins+pindocument\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attribution \{#operation-listpins+responses+200+application-json+pins+pindocument+attribution\} - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#operation-listpins+responses+200+application-json+pins+pindocument+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-listpins+responses+200+application-json+pins+pindocument+createtime\} - - - - - - - - - -##### documentId \{#operation-listpins+responses+200+application-json+pins+pindocument+documentid\} - - - - - -The document which should be a pinned result. - - - - - - - - - -##### id \{#operation-listpins+responses+200+application-json+pins+pindocument+id\} - - - - - -The opaque id of the pin. - - - - - - - - - -##### queries \{#operation-listpins+responses+200+application-json+pins+pindocument+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -##### updateTime \{#operation-listpins+responses+200+application-json+pins+pindocument+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-listpins+responses+200+application-json+pins+pindocument+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/pin \{#operation-pin\} - - - - - -_Create pin_ - - - - - -Pin a document as a result for a given search query.Pin results that are known to be a good match. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/pin \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-pin+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-pin+request\} - - - - - - - -Details about the document and query for the pin. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-pin+request+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-pin+request+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-pin+request+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-pin+request+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-pin+request+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### documentId \{#operation-pin+request+documentid\} - - - - - -The document to be pinned. - - - - - - - - - -##### queries \{#operation-pin+request+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-pin+responses-examples\} - - - - - -200 - - - - - -```json -{ - "documentId": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-pin+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attribution \{#operation-pin+responses+200+application-json+attribution\} - - - - - - - - - -#### Person \{#operation-pin+responses+200+application-json+attribution+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-pin+responses+200+application-json+attribution+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-pin+responses+200+application-json+attribution+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-pin+responses+200+application-json+attribution+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-pin+responses+200+application-json+attribution+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#operation-pin+responses+200+application-json+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-pin+responses+200+application-json+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-pin+responses+200+application-json+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-pin+responses+200+application-json+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-pin+responses+200+application-json+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#operation-pin+responses+200+application-json+createtime\} - - - - - - - - - -##### documentId \{#operation-pin+responses+200+application-json+documentid\} - - - - - -The document which should be a pinned result. - - - - - - - - - -##### id \{#operation-pin+responses+200+application-json+id\} - - - - - -The opaque id of the pin. - - - - - - - - - -##### queries \{#operation-pin+responses+200+application-json+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -##### updateTime \{#operation-pin+responses+200+application-json+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#operation-pin+responses+200+application-json+updatedby\} - - - - - - - - - -#### Person \{#operation-pin+responses+200+application-json+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-pin+responses+200+application-json+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-pin+responses+200+application-json+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#operation-pin+responses+200+application-json+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-pin+responses+200+application-json+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/unpin \{#operation-unpin\} - - - - - -_Delete pin_ - - - - - -Unpin a previously pinned result. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/unpin \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-unpin+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-unpin+request\} - - - - - - - -Details about the pin being unpinned. - - - - - - - - - -##### id \{#operation-unpin+request+id\} - - - - - -The opaque id of the pin to be unpinned. - - - - - - - - - -
    - -     - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/search.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/search.mdx deleted file mode 100644 index 93d9ed7e7..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/search.mdx +++ /dev/null @@ -1,16037 +0,0 @@ ---- -sidebar_position: 3.14 -sidebar_label: Client Search ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedauthtokens from "../../../../../src/components/glean-embeds/loaders/authtokens.tsx"; -import Embedexclusions from "../../../../../src/components/glean-embeds/loaders/exclusions.tsx"; -import Embedfacetbucketfilter from "../../../../../src/components/glean-embeds/loaders/facetbucketfilter.tsx"; -import Embedfacetfiltersets from "../../../../../src/components/glean-embeds/loaders/facetfiltersets.tsx"; -import Embedfacetfilters from "../../../../../src/components/glean-embeds/loaders/facetfilters.tsx"; -import Embedinclusions from "../../../../../src/components/glean-embeds/loaders/inclusions.tsx"; -import Embedcontainerdocument from "../../../../../src/components/glean-embeds/loaders/containerdocument.tsx"; -import Embedcontent from "../../../../../src/components/glean-embeds/loaders/content.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; -import Embedparentdocument from "../../../../../src/components/glean-embeds/loaders/parentdocument.tsx"; -import Embedsections from "../../../../../src/components/glean-embeds/loaders/sections.tsx"; -import Embedbuckets from "../../../../../src/components/glean-embeds/loaders/buckets.tsx"; -import Embedfollowupactions from "../../../../../src/components/glean-embeds/loaders/followupactions.tsx"; -import Embedranges from "../../../../../src/components/glean-embeds/loaders/ranges.tsx"; -import Embedadditionalquerysuggestions from "../../../../../src/components/glean-embeds/loaders/additionalquerysuggestions.tsx"; -import Embedquerysuggestion from "../../../../../src/components/glean-embeds/loaders/querysuggestion.tsx"; -import Embedsearchwarning from "../../../../../src/components/glean-embeds/loaders/searchwarning.tsx"; -import Embedsearchedqueryranges from "../../../../../src/components/glean-embeds/loaders/searchedqueryranges.tsx"; -import Embedallclusteredresults from "../../../../../src/components/glean-embeds/loaders/allclusteredresults.tsx"; -import Embedattachments from "../../../../../src/components/glean-embeds/loaders/attachments.tsx"; -import Embedbacklinkresults from "../../../../../src/components/glean-embeds/loaders/backlinkresults.tsx"; -import Embedclusteredresults from "../../../../../src/components/glean-embeds/loaders/clusteredresults.tsx"; -import Embeddocument from "../../../../../src/components/glean-embeds/loaders/document.tsx"; -import Embedmustincludesuggestions from "../../../../../src/components/glean-embeds/loaders/mustincludesuggestions.tsx"; -import Embedpins from "../../../../../src/components/glean-embeds/loaders/pins.tsx"; -import Embedrelatedresults from "../../../../../src/components/glean-embeds/loaders/relatedresults.tsx"; -import Embedsnippets from "../../../../../src/components/glean-embeds/loaders/snippets.tsx"; -import Embedstructuredresults from "../../../../../src/components/glean-embeds/loaders/structuredresults.tsx"; -import Embediconconfig from "../../../../../src/components/glean-embeds/loaders/iconconfig.tsx"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedanswer from "../../../../../src/components/glean-embeds/loaders/answer.tsx"; -import Embedanswerboard from "../../../../../src/components/glean-embeds/loaders/answerboard.tsx"; -import Embedapp from "../../../../../src/components/glean-embeds/loaders/app.tsx"; -import Embedcode from "../../../../../src/components/glean-embeds/loaders/code.tsx"; -import Embedcollection from "../../../../../src/components/glean-embeds/loaders/collection.tsx"; -import Embedcustomentity from "../../../../../src/components/glean-embeds/loaders/customentity.tsx"; -import Embedcustomer from "../../../../../src/components/glean-embeds/loaders/customer.tsx"; -import Embeddisambiguation from "../../../../../src/components/glean-embeds/loaders/disambiguation.tsx"; -import Embedextractedqna from "../../../../../src/components/glean-embeds/loaders/extractedqna.tsx"; -import Embedgeneratedqna from "../../../../../src/components/glean-embeds/loaders/generatedqna.tsx"; -import Embedmeeting from "../../../../../src/components/glean-embeds/loaders/meeting.tsx"; -import Embedperson from "../../../../../src/components/glean-embeds/loaders/person.tsx"; -import Embedquerysuggestions from "../../../../../src/components/glean-embeds/loaders/querysuggestions.tsx"; -import Embedrelateddocuments from "../../../../../src/components/glean-embeds/loaders/relateddocuments.tsx"; -import Embedrelatedquestion from "../../../../../src/components/glean-embeds/loaders/relatedquestion.tsx"; -import Embedshortcut from "../../../../../src/components/glean-embeds/loaders/shortcut.tsx"; -import Embedteam from "../../../../../src/components/glean-embeds/loaders/team.tsx"; -import Embedoperatormetadata from "../../../../../src/components/glean-embeds/loaders/operatormetadata.tsx"; -import Embedquicklink from "../../../../../src/components/glean-embeds/loaders/quicklink.tsx"; -import Embedstructuredresult from "../../../../../src/components/glean-embeds/loaders/structuredresult.tsx"; -import Embedcategorytoresultsize from "../../../../../src/components/glean-embeds/loaders/categorytoresultsize.tsx"; -import Embedchatzerostatesuggestionoptions from "../../../../../src/components/glean-embeds/loaders/chatzerostatesuggestionoptions.tsx"; -import Embedprimaryentry from "../../../../../src/components/glean-embeds/loaders/primaryentry.tsx"; -import Embedsecondaryentries from "../../../../../src/components/glean-embeds/loaders/secondaryentries.tsx"; -import Embedcontext from "../../../../../src/components/glean-embeds/loaders/context.tsx"; - - - - - - - -# Client Search Endpoints - - - - - - - - - -## POST /rest/api/v1/adminsearch \{#operation-adminsearch\} - - - - - -_Search the index (admin)_ - - - - - -Retrieves results for search query without respect for permissions. This is available only to privileged users. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/adminsearch \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "query": "vacation policy" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-adminsearch+request-examples\} - - - - - -```json -{ - "query": "vacation policy" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-adminsearch+request\} - - - - - - - -Admin search request - - - - - - - - - -##### cursor \{#operation-adminsearch+request+cursor\} - - - - - -Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - - - - - - - - - -##### disableSpellcheck \{#operation-adminsearch+request+disablespellcheck\} - - - - - -Whether or not to disable spellcheck. - - - - - -SearchRequestInputDetails","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputDetails \{#operation-adminsearch+request+inputdetails\} - - - - - - - - - -#### SearchRequestInputDetails \{#operation-adminsearch+request+inputdetails+searchrequestinputdetails\} - - - - - - - - - -##### hasCopyPaste \{#operation-adminsearch+request+inputdetails+searchrequestinputdetails+hascopypaste\} - - - - - -Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - - - - - - - - - - - - - - - - - -##### maxSnippetSize \{#operation-adminsearch+request+maxsnippetsize\} - - - - - -Hint to the server about how many characters long a snippet may be. Server may return less or more. - - - - - -_Example:_ - -``` -400 -``` - - - - - - - - - -##### pageSize \{#operation-adminsearch+request+pagesize\} - - - - - -Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - - - - - -_Example:_ - -``` -100 -``` - - - - - - - - - -##### query \{#operation-adminsearch+request+query\} - - - - - -The search terms. - - - - - -_Example:_ - -``` -vacation policy -``` - - - - - -SearchRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestOptions \{#operation-adminsearch+request+requestoptions\} - - - - - - - - - -#### SearchRequestOptions \{#operation-adminsearch+request+requestoptions+searchrequestoptions\} - - - - - -AuthToken","children":[{"label":"AuthToken","linkedLabel":"AuthToken","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### authTokens \{#operation-adminsearch+request+requestoptions+searchrequestoptions+authtokens\} - - - - - -Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceFilter \{#operation-adminsearch+request+requestoptions+searchrequestoptions+datasourcefilter\} - - - - - -Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### datasourcesFilter \{#operation-adminsearch+request+requestoptions+searchrequestoptions+datasourcesfilter\} - - - - - -Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### defaultFacets \{#operation-adminsearch+request+requestoptions+searchrequestoptions+defaultfacets\} - - - - - -Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - - - - - - - - - -##### disableQueryAutocorrect \{#operation-adminsearch+request+requestoptions+searchrequestoptions+disablequeryautocorrect\} - - - - - -Disables automatic adjustment of the input query for spelling corrections or other reasons. - - - - - - - - - -##### disableSpellcheck \{#operation-adminsearch+request+requestoptions+searchrequestoptions+disablespellcheck\} - - - - - -Whether or not to disable spellcheck. - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### exclusions \{#operation-adminsearch+request+requestoptions+searchrequestoptions+exclusions\} - - - - - - - - - - - - - - - - - - - -FacetBucketFilter","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetBucketFilter \{#operation-adminsearch+request+requestoptions+searchrequestoptions+facetbucketfilter\} - - - - - - - - - - - - - - - - - - - - - - - -##### facetBucketSize \{#operation-adminsearch+request+requestoptions+searchrequestoptions+facetbucketsize\} - - - - - -The maximum number of FacetBuckets to return in each FacetResult. - - - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilterSets \{#operation-adminsearch+request+requestoptions+searchrequestoptions+facetfiltersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilters \{#operation-adminsearch+request+requestoptions+searchrequestoptions+facetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### fetchAllDatasourceCounts \{#operation-adminsearch+request+requestoptions+searchrequestoptions+fetchalldatasourcecounts\} - - - - - -Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inclusions \{#operation-adminsearch+request+requestoptions+searchrequestoptions+inclusions\} - - - - - - - - - - - - - - - - - - - - - - - -##### queryOverridesFacetFilters \{#operation-adminsearch+request+requestoptions+searchrequestoptions+queryoverridesfacetfilters\} - - - - - -If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - - - - - - - - - -##### responseHints \{#operation-adminsearch+request+requestoptions+searchrequestoptions+responsehints\} - - - - - -Array of hints containing which fields should be populated in the response. - - - - - - - - - -##### returnLlmContentOverSnippets \{#operation-adminsearch+request+requestoptions+searchrequestoptions+returnllmcontentoversnippets\} - - - - - -Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - - - - - - - - - -##### timezoneOffset \{#operation-adminsearch+request+requestoptions+searchrequestoptions+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - - - - - - - - - -##### resultTabIds \{#operation-adminsearch+request+resulttabids\} - - - - - -The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict. - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-adminsearch+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-adminsearch+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-adminsearch+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-adminsearch+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-adminsearch+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-adminsearch+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-adminsearch+request+sourcedocument\} - - - - - - - - - -#### Document \{#operation-adminsearch+request+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-adminsearch+request+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-adminsearch+request+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-adminsearch+request+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-adminsearch+request+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-adminsearch+request+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-adminsearch+request+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-adminsearch+request+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-adminsearch+request+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-adminsearch+request+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-adminsearch+request+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-adminsearch+request+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### timeoutMillis \{#operation-adminsearch+request+timeoutmillis\} - - - - - -Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - - - - - -_Example:_ - -``` -5000 -``` - - - - - - - - - -##### timestamp \{#operation-adminsearch+request+timestamp\} - - - - - -The ISO 8601 timestamp associated with the client request. - - - - - - - - - -##### trackingToken \{#operation-adminsearch+request+trackingtoken\} - - - - - -A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-adminsearch+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - -403 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-adminsearch+responses\} - - - - - -200 - - - - - - - -OK - - - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### GleanDataError \{#operation-adminsearch+responses+200+application-json+gleandataerror\} - - - - - - - - - - - - - -##### backendTimeMillis \{#operation-adminsearch+responses+200+application-json+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - - - - - -##### cursor \{#operation-adminsearch+responses+200+application-json+cursor\} - - - - - -Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - - - - - - - - - -##### experimentIds \{#operation-adminsearch+responses+200+application-json+experimentids\} - - - - - -List of experiment ids for the corresponding request. - - - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#operation-adminsearch+responses+200+application-json+facetresults\} - - - - - - - - - -#### FacetResult \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#operation-adminsearch+responses+200+application-json+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedQnaResult \{#operation-adminsearch+responses+200+application-json+generatedqnaresult\} - - - - - - - - - -#### GeneratedQna \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna\} - - - - - - - - - -##### answer \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+answer\} - - - - - -Answer generated for the given query or the generated question. - - - - - - - - - -##### cursor \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+cursor\} - - - - - -An opaque cursor representing the search request - - - - - - - - - -##### followUpPrompts \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+followupprompts\} - - - - - -List of all follow-up prompts generated for the given query or the generated question. - - - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### followupActions \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+question\} - - - - - -Search query rephrased into a question. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+status\} - - - - - -Status of backend generating the answer - - - - - - - - - -##### trackingToken \{#operation-adminsearch+responses+200+application-json+generatedqnaresult+generatedqna+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### hasMoreResults \{#operation-adminsearch+responses+200+application-json+hasmoreresults\} - - - - - -Whether more results are available. Use cursor to retrieve them. - - - - - -SearchResponseMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#operation-adminsearch+responses+200+application-json+metadata\} - - - - - - - - - -#### SearchResponseMetadata \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata\} - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalQuerySuggestions \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+additionalquerysuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### isNoQuotesSuggestion \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+isnoquotessuggestion\} - - - - - -Whether the query was modified to remove quotes - - - - - - - - - -##### modifiedQueryWasUsed \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+modifiedquerywasused\} - - - - - -A different query was performed than the one requested. - - - - - - - - - -##### negatedTerms \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+negatedterms\} - - - - - -A list of terms that were negated when processing the query. - - - - - - - - - -##### originalQuery \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+originalquery\} - - - - - -The query text sent by the client in the request. - - - - - - - - - -##### originalQueryHadNoResults \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+originalqueryhadnoresults\} - - - - - -No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based. - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+querysuggestion\} - - - - - - - - - - - - - - - - - - - - - - - -##### rewrittenQuery \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+rewrittenquery\} - - - - - -A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators. - - - - - -SearchWarning","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchWarning \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+searchwarning\} - - - - - - - - - - - - - - - - - - - - - - - -##### searchedQuery \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+searchedquery\} - - - - - -The actual query used to perform search and return results. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchedQueryRanges \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+searchedqueryranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### searchedQueryWithoutNegation \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+searchedquerywithoutnegation\} - - - - - -The query used to perform search and return results, with negated terms and facets removed. - - - - - - - - - -##### triggeredExpertDetection \{#operation-adminsearch+responses+200+application-json+metadata+searchresponsemetadata+triggeredexpertdetection\} - - - - - -Whether the query triggered expert detection results in the People tab. - - - - - - - - - - - - - - - - - -##### requestID \{#operation-adminsearch+responses+200+application-json+requestid\} - - - - - -A platform-generated request ID to correlate backend logs. - - - - - - - - - -##### resultTabIds \{#operation-adminsearch+responses+200+application-json+resulttabids\} - - - - - -The unique IDs of the result tabs to which this response belongs. - - - - - -ResultTab","children":[{"label":"ResultTab","linkedLabel":"ResultTab","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultTabs \{#operation-adminsearch+responses+200+application-json+resulttabs\} - - - - - -All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - - - - - - - - - -#### ResultTab \{#operation-adminsearch+responses+200+application-json+resulttabs+resulttab\} - - - - - - - - - -##### count \{#operation-adminsearch+responses+200+application-json+resulttabs+resulttab+count\} - - - - - -The number of results in this tab for the current query. - - - - - - - - - -##### datasource \{#operation-adminsearch+responses+200+application-json+resulttabs+resulttab+datasource\} - - - - - -The datasource associated with the tab, if any. - - - - - - - - - -##### datasourceInstance \{#operation-adminsearch+responses+200+application-json+resulttabs+resulttab+datasourceinstance\} - - - - - -The datasource instance associated with the tab, if any. - - - - - - - - - -##### id \{#operation-adminsearch+responses+200+application-json+resulttabs+resulttab+id\} - - - - - -The unique ID of the tab. Can be passed in a search request to get results for that tab. - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-adminsearch+responses+200+application-json+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#operation-adminsearch+responses+200+application-json+results+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#operation-adminsearch+responses+200+application-json+results+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - - - - - - - - - - - -##### attachmentContext \{#operation-adminsearch+responses+200+application-json+results+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#operation-adminsearch+responses+200+application-json+results+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#operation-adminsearch+responses+200+application-json+results+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#operation-adminsearch+responses+200+application-json+results+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#operation-adminsearch+responses+200+application-json+results+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#operation-adminsearch+responses+200+application-json+results+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-adminsearch+responses+200+application-json+results+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#operation-adminsearch+responses+200+application-json+results+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#operation-adminsearch+responses+200+application-json+results+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#operation-adminsearch+responses+200+application-json+results+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#operation-adminsearch+responses+200+application-json+results+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#operation-adminsearch+responses+200+application-json+results+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-adminsearch+responses+200+application-json+results+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-adminsearch+responses+200+application-json+results+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#operation-adminsearch+responses+200+application-json+results+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-adminsearch+responses+200+application-json+results+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#operation-adminsearch+responses+200+application-json+results+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-adminsearch+responses+200+application-json+results+searchresult+title\} - - - - - - - - - -##### trackingToken \{#operation-adminsearch+responses+200+application-json+results+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#operation-adminsearch+responses+200+application-json+results+searchresult+url\} - - - - - - - - - - - - - -ResultsDescription","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultsDescription \{#operation-adminsearch+responses+200+application-json+resultsdescription\} - - - - - - - - - -#### ResultsDescription \{#operation-adminsearch+responses+200+application-json+resultsdescription+resultsdescription\} - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#operation-adminsearch+responses+200+application-json+resultsdescription+resultsdescription+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-adminsearch+responses+200+application-json+resultsdescription+resultsdescription+text\} - - - - - -Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab. - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### rewrittenFacetFilters \{#operation-adminsearch+responses+200+application-json+rewrittenfacetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-adminsearch+responses+200+application-json+rewrittenfacetfilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-adminsearch+responses+200+application-json+rewrittenfacetfilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-adminsearch+responses+200+application-json+rewrittenfacetfilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-adminsearch+responses+200+application-json+rewrittenfacetfilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-adminsearch+responses+200+application-json+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-adminsearch+responses+200+application-json+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-adminsearch+responses+200+application-json+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-adminsearch+responses+200+application-json+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-adminsearch+responses+200+application-json+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-adminsearch+responses+200+application-json+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredResults \{#operation-adminsearch+responses+200+application-json+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - -#### StructuredResult \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+answer\} - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerBoard \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+answerboard\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+app\} - - - - - - - - - - - - - - - - - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### code \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+code\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+collection\} - - - - - - - - - - - - - - - - - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customEntity \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+customentity\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+customer\} - - - - - - - - - - - - - - - - - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### disambiguation \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+document\} - - - - - - - - - - - - - - - - - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### extractedQnA \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+extractedqna\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQna \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+generatedqna\} - - - - - - - - - - - - - - - - - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### meeting \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+meeting\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestions \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+querysuggestions\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedQuestion \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+relatedquestion\} - - - - - - - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+shortcut\} - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - - - - - -##### source \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+source\} - - - - - -Source context for this result. Possible values depend on the result type. - - - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### team \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+team\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-adminsearch+responses+200+application-json+structuredresults+structuredresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-adminsearch+responses+200+application-json+trackingtoken\} - - - - - -A token that should be passed for additional requests related to this request (such as more results requests). - - - - - - - - - - - -403 - - - - - - - -Forbidden - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-adminsearch+responses+403+application-json+httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-adminsearch+responses+403+application-json+httpmeta+httpmetadata\} - - - - - - - - - -##### Request \{#operation-adminsearch+responses+403+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-adminsearch+responses+403+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - - - - - -##### badGmailToken \{#operation-adminsearch+responses+403+application-json+badgmailtoken\} - - - - - -Indicates the gmail results could not be fetched due to bad token. - - - - - - - - - -##### badOutlookToken \{#operation-adminsearch+responses+403+application-json+badoutlooktoken\} - - - - - -Indicates the outlook results could not be fetched due to bad token. - - - - - -ErrorMessage","children":[{"label":"ErrorMessage","linkedLabel":"ErrorMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errorMessages \{#operation-adminsearch+responses+403+application-json+errormessages\} - - - - - - - - - -#### ErrorMessage \{#operation-adminsearch+responses+403+application-json+errormessages+errormessage\} - - - - - - - - - -##### errorMessage \{#operation-adminsearch+responses+403+application-json+errormessages+errormessage+errormessage\} - - - - - - - - - -##### source \{#operation-adminsearch+responses+403+application-json+errormessages+errormessage+source\} - - - - - -The datasource this message relates to. - - - - - - - - - - - - - -InvalidOperatorValueError","children":[{"label":"InvalidOperatorValueError","linkedLabel":"InvalidOperatorValueError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### invalidOperators \{#operation-adminsearch+responses+403+application-json+invalidoperators\} - - - - - -Indicates results could not be fetched due to invalid operators in the query. - - - - - - - - - -#### InvalidOperatorValueError \{#operation-adminsearch+responses+403+application-json+invalidoperators+invalidoperatorvalueerror\} - - - - - - - - - -##### key \{#operation-adminsearch+responses+403+application-json+invalidoperators+invalidoperatorvalueerror+key\} - - - - - -The operator key that has an invalid value. - - - - - - - - - -##### value \{#operation-adminsearch+responses+403+application-json+invalidoperators+invalidoperatorvalueerror+value\} - - - - - -The invalid operator value. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/autocomplete \{#operation-autocomplete\} - - - - - -_Autocomplete_ - - - - - -Retrieve query suggestions, operators and documents for the given partially typed query. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/autocomplete \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-autocomplete+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-autocomplete+request\} - - - - - - - -Autocomplete request - - - - - -AuthToken","children":[{"label":"AuthToken","linkedLabel":"AuthToken","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### authTokens \{#operation-autocomplete+request+authtokens\} - - - - - -Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - - - - - - - - - -#### AuthToken \{#operation-autocomplete+request+authtokens+authtoken\} - - - - - - - - - -##### accessToken \{#operation-autocomplete+request+authtokens+authtoken+accesstoken\} - - - - - - - - - -##### authUser \{#operation-autocomplete+request+authtokens+authtoken+authuser\} - - - - - -Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin. - - - - - - - - - -##### datasource \{#operation-autocomplete+request+authtokens+authtoken+datasource\} - - - - - - - - - -##### expiration \{#operation-autocomplete+request+authtokens+authtoken+expiration\} - - - - - -Unix timestamp when this token expires (in seconds since epoch UTC). - - - - - - - - - -##### scope \{#operation-autocomplete+request+authtokens+authtoken+scope\} - - - - - - - - - -##### tokenType \{#operation-autocomplete+request+authtokens+authtoken+tokentype\} - - - - - - - - - - - - - - - - - -##### datasource \{#operation-autocomplete+request+datasource\} - - - - - -Filter to only return results relevant to the given datasource. - - - - - - - - - -##### datasourcesFilter \{#operation-autocomplete+request+datasourcesfilter\} - - - - - -Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing. - - - - - - - - - -##### query \{#operation-autocomplete+request+query\} - - - - - -Partially typed query. - - - - - -_Example:_ - -``` -San Fra -``` - - - - - - - - - -##### resultSize \{#operation-autocomplete+request+resultsize\} - - - - - -Maximum number of results to be returned. If no value is provided, the backend will cap at 200. - - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - -##### resultTypes \{#operation-autocomplete+request+resulttypes\} - - - - - -Filter to only return results of the given type(s). All types may be returned if omitted. - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-autocomplete+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-autocomplete+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-autocomplete+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-autocomplete+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-autocomplete+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-autocomplete+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-autocomplete+request+trackingtoken\} - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-autocomplete+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-autocomplete+responses\} - - - - - -200 - - - - - - - -OK - - - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### GleanDataError \{#operation-autocomplete+responses+200+application-json+gleandataerror\} - - - - - - - - - - - - - -##### backendTimeMillis \{#operation-autocomplete+responses+200+application-json+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - - - - - -##### experimentIds \{#operation-autocomplete+responses+200+application-json+experimentids\} - - - - - -List of experiment ids for the corresponding request. - - - - - -AutocompleteResultGroup","children":[{"label":"AutocompleteResultGroup","linkedLabel":"AutocompleteResultGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### groups \{#operation-autocomplete+responses+200+application-json+groups\} - - - - - -Subsections of the results list from which distinct sections should be created. - - - - - - - - - -#### AutocompleteResultGroup \{#operation-autocomplete+responses+200+application-json+groups+autocompleteresultgroup\} - - - - - -A subsection of the results list from which distinct sections should be created. - - - - - - - - - -##### endIndex \{#operation-autocomplete+responses+200+application-json+groups+autocompleteresultgroup+endindex\} - - - - - -The exclusive end index of the range. - - - - - - - - - -##### startIndex \{#operation-autocomplete+responses+200+application-json+groups+autocompleteresultgroup+startindex\} - - - - - -The inclusive start index of the range. - - - - - - - - - -##### title \{#operation-autocomplete+responses+200+application-json+groups+autocompleteresultgroup+title\} - - - - - -The title of the result group to be displayed. Empty means no title. - - - - - - - - - - - - - -AutocompleteResult","children":[{"label":"AutocompleteResult","linkedLabel":"AutocompleteResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-autocomplete+responses+200+application-json+results\} - - - - - - - - - -#### AutocompleteResult \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult\} - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### keywords \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+keywords\} - - - - - -A list of all possible keywords for given result. - - - - - -OperatorMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### operatorMetadata \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+operatormetadata\} - - - - - - - - - - - - - - - - - - - -Quicklink","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### quicklink \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+quicklink\} - - - - - -An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - - - - - - - - - - - - - - - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### result \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+result\} - - - - - - - - - -##### resultType \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+resulttype\} - - - - - - - - - -##### score \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+score\} - - - - - -Higher indicates a more confident match. - - - - - -StructuredResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResult \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+trackingtoken\} - - - - - -A token to be passed in /feedback events associated with this autocomplete result. - - - - - - - - - -##### url \{#operation-autocomplete+responses+200+application-json+results+autocompleteresult+url\} - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-autocomplete+responses+200+application-json+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-autocomplete+responses+200+application-json+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-autocomplete+responses+200+application-json+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-autocomplete+responses+200+application-json+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-autocomplete+responses+200+application-json+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-autocomplete+responses+200+application-json+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-autocomplete+responses+200+application-json+trackingtoken\} - - - - - -An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/feed \{#operation-feed\} - - - - - -_Feed of documents and events_ - - - - - -The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/feed \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-feed+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-feed+request\} - - - - - - - -Includes request params, client data and more for making user's feed. - - - - - - - - - -##### categories \{#operation-feed+request+categories\} - - - - - -Categories of content requested. An allowlist gives flexibility to request content separately or together. - - - - - -FeedRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestOptions \{#operation-feed+request+requestoptions\} - - - - - - - - - -#### FeedRequestOptions \{#operation-feed+request+requestoptions+feedrequestoptions\} - - - - - -categoryToResultSize","children":[{"label":"categoryToResultSize","linkedLabel":"categoryToResultSize","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### categoryToResultSize \{#operation-feed+request+requestoptions+feedrequestoptions+categorytoresultsize\} - - - - - -Mapping from category to number of results asked for the category. - - - - - - - - - - - - - - - - - - - -ChatZeroStateSuggestionOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chatZeroStateSuggestionOptions \{#operation-feed+request+requestoptions+feedrequestoptions+chatzerostatesuggestionoptions\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceFilter \{#operation-feed+request+requestoptions+feedrequestoptions+datasourcefilter\} - - - - - -Datasources for which content should be included. Empty is for all. - - - - - - - - - -##### resultSize \{#operation-feed+request+requestoptions+feedrequestoptions+resultsize\} - - - - - -Number of results asked in response. If a result is a collection, counts as one. - - - - - - - - - -##### timezoneOffset \{#operation-feed+request+requestoptions+feedrequestoptions+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-feed+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-feed+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-feed+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-feed+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-feed+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-feed+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - - - - -##### timeoutMillis \{#operation-feed+request+timeoutmillis\} - - - - - -Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - - - - - -_Example:_ - -``` -5000 -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-feed+responses-examples\} - - - - - -200 - - - - - -```json -{ - "serverTimestamp": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-feed+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### experimentIds \{#operation-feed+responses+200+application-json+experimentids\} - - - - - -List of experiment ids for the corresponding request. - - - - - -FacetResult","children":[{"label":"array","linkedLabel":"FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#operation-feed+responses+200+application-json+facetresults\} - - - - - -Map from category to the list of facets that can be used to filter the entry's content. - - - - - - - - - -#### FacetResult \{#operation-feed+responses+200+application-json+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#operation-feed+responses+200+application-json+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#operation-feed+responses+200+application-json+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#operation-feed+responses+200+application-json+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#operation-feed+responses+200+application-json+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#operation-feed+responses+200+application-json+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - - - - - -##### mentionsTimeWindowInHours \{#operation-feed+responses+200+application-json+mentionstimewindowinhours\} - - - - - -The time window (in hours) used for generating user mentions. - - - - - -FeedResult","children":[{"label":"FeedResult","linkedLabel":"FeedResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-feed+responses+200+application-json+results\} - - - - - - - - - -#### FeedResult \{#operation-feed+responses+200+application-json+results+feedresult\} - - - - - - - - - -##### category \{#operation-feed+responses+200+application-json+results+feedresult+category\} - - - - - -Category of the result, one of the requested categories in incoming request. - - - - - -FeedEntry","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### primaryEntry \{#operation-feed+responses+200+application-json+results+feedresult+primaryentry\} - - - - - - - - - - - - - - - - - - - - - - - -##### rank \{#operation-feed+responses+200+application-json+results+feedresult+rank\} - - - - - -Rank of the result. Rank is suggested by server. Client side rank may differ. - - - - - -FeedEntry","children":[{"label":"FeedEntry","linkedLabel":"FeedEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### secondaryEntries \{#operation-feed+responses+200+application-json+results+feedresult+secondaryentries\} - - - - - -Secondary entries for the result e.g. suggested docs for the calendar, carousel. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### serverTimestamp \{#operation-feed+responses+200+application-json+servertimestamp\} - - - - - -Server unix timestamp (in seconds since epoch UTC). - - - - - - - - - -##### trackingToken \{#operation-feed+responses+200+application-json+trackingtoken\} - - - - - -An opaque token that represents this particular feed response. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/recommendations \{#operation-recommendations\} - - - - - -_Recommend documents_ - - - - - -Retrieve recommended documents for the given URL or Glean Document ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/recommendations \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-recommendations+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-recommendations+request\} - - - - - - - -Recommendations request - - - - - - - - - -##### maxSnippetSize \{#operation-recommendations+request+maxsnippetsize\} - - - - - -Hint to the server about how many characters long a snippet may be. Server may return less or more. - - - - - -_Example:_ - -``` -400 -``` - - - - - - - - - -##### pageSize \{#operation-recommendations+request+pagesize\} - - - - - -Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - - - - - -_Example:_ - -``` -100 -``` - - - - - - - - - -##### recommendationDocumentSpec \{#operation-recommendations+request+recommendationdocumentspec\} - - - - - -RecommendationsRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestOptions \{#operation-recommendations+request+requestoptions\} - - - - - - - - - -#### RecommendationsRequestOptions \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions\} - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### context \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions+context\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceFilter \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions+datasourcefilter\} - - - - - -Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### datasourcesFilter \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions+datasourcesfilter\} - - - - - -Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). All results are returned if missing. - - - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilterSets \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions+facetfiltersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - - - - - - - - - - - - - - - -##### resultProminence \{#operation-recommendations+request+requestoptions+recommendationsrequestoptions+resultprominence\} - - - - - -The types of prominence wanted in results returned. Default is any type. - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-recommendations+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-recommendations+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-recommendations+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-recommendations+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-recommendations+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-recommendations+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-recommendations+request+sourcedocument\} - - - - - - - - - -#### Document \{#operation-recommendations+request+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-recommendations+request+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-recommendations+request+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-recommendations+request+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-recommendations+request+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-recommendations+request+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-recommendations+request+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-recommendations+request+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-recommendations+request+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-recommendations+request+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-recommendations+request+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-recommendations+request+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### timestamp \{#operation-recommendations+request+timestamp\} - - - - - -The ISO 8601 timestamp associated with the client request. - - - - - - - - - -##### trackingToken \{#operation-recommendations+request+trackingtoken\} - - - - - -A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-recommendations+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-recommendations+responses\} - - - - - -200 - - - - - - - -OK - - - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### GleanDataError \{#operation-recommendations+responses+200+application-json+gleandataerror\} - - - - - - - - - - - - - -##### backendTimeMillis \{#operation-recommendations+responses+200+application-json+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedQnaResult \{#operation-recommendations+responses+200+application-json+generatedqnaresult\} - - - - - - - - - -#### GeneratedQna \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna\} - - - - - - - - - -##### answer \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+answer\} - - - - - -Answer generated for the given query or the generated question. - - - - - - - - - -##### cursor \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+cursor\} - - - - - -An opaque cursor representing the search request - - - - - - - - - -##### followUpPrompts \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+followupprompts\} - - - - - -List of all follow-up prompts generated for the given query or the generated question. - - - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### followupActions \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+question\} - - - - - -Search query rephrased into a question. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+status\} - - - - - -Status of backend generating the answer - - - - - - - - - -##### trackingToken \{#operation-recommendations+responses+200+application-json+generatedqnaresult+generatedqna+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### requestID \{#operation-recommendations+responses+200+application-json+requestid\} - - - - - -A platform-generated request ID to correlate backend logs. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-recommendations+responses+200+application-json+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#operation-recommendations+responses+200+application-json+results+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#operation-recommendations+responses+200+application-json+results+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - - - - - - - - - - - -##### attachmentContext \{#operation-recommendations+responses+200+application-json+results+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#operation-recommendations+responses+200+application-json+results+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#operation-recommendations+responses+200+application-json+results+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#operation-recommendations+responses+200+application-json+results+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#operation-recommendations+responses+200+application-json+results+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#operation-recommendations+responses+200+application-json+results+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-recommendations+responses+200+application-json+results+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#operation-recommendations+responses+200+application-json+results+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#operation-recommendations+responses+200+application-json+results+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#operation-recommendations+responses+200+application-json+results+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#operation-recommendations+responses+200+application-json+results+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#operation-recommendations+responses+200+application-json+results+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-recommendations+responses+200+application-json+results+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-recommendations+responses+200+application-json+results+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#operation-recommendations+responses+200+application-json+results+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-recommendations+responses+200+application-json+results+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#operation-recommendations+responses+200+application-json+results+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-recommendations+responses+200+application-json+results+searchresult+title\} - - - - - - - - - -##### trackingToken \{#operation-recommendations+responses+200+application-json+results+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#operation-recommendations+responses+200+application-json+results+searchresult+url\} - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-recommendations+responses+200+application-json+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-recommendations+responses+200+application-json+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-recommendations+responses+200+application-json+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-recommendations+responses+200+application-json+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-recommendations+responses+200+application-json+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-recommendations+responses+200+application-json+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredResults \{#operation-recommendations+responses+200+application-json+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - -#### StructuredResult \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+answer\} - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerBoard \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+answerboard\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+app\} - - - - - - - - - - - - - - - - - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### code \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+code\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+collection\} - - - - - - - - - - - - - - - - - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customEntity \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+customentity\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+customer\} - - - - - - - - - - - - - - - - - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### disambiguation \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+document\} - - - - - - - - - - - - - - - - - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### extractedQnA \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+extractedqna\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQna \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+generatedqna\} - - - - - - - - - - - - - - - - - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### meeting \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+meeting\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestions \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+querysuggestions\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedQuestion \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+relatedquestion\} - - - - - - - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+shortcut\} - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - - - - - -##### source \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+source\} - - - - - -Source context for this result. Possible values depend on the result type. - - - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### team \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+team\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-recommendations+responses+200+application-json+structuredresults+structuredresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-recommendations+responses+200+application-json+trackingtoken\} - - - - - -A token that should be passed for additional requests related to this request (such as more results requests). - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/search \{#operation-search\} - - - - - -_Search_ - - - - - -Retrieve results from the index for the given query and filters. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/search \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "query": "vacation policy" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-search+request-examples\} - - - - - -```json -{ - "query": "vacation policy" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-search+request\} - - - - - - - -Search request - - - - - - - - - -##### cursor \{#operation-search+request+cursor\} - - - - - -Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - - - - - - - - - -##### disableSpellcheck \{#operation-search+request+disablespellcheck\} - - - - - -Whether or not to disable spellcheck. - - - - - -SearchRequestInputDetails","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputDetails \{#operation-search+request+inputdetails\} - - - - - - - - - -#### SearchRequestInputDetails \{#operation-search+request+inputdetails+searchrequestinputdetails\} - - - - - - - - - -##### hasCopyPaste \{#operation-search+request+inputdetails+searchrequestinputdetails+hascopypaste\} - - - - - -Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - - - - - - - - - - - - - - - - - -##### maxSnippetSize \{#operation-search+request+maxsnippetsize\} - - - - - -Hint to the server about how many characters long a snippet may be. Server may return less or more. - - - - - -_Example:_ - -``` -400 -``` - - - - - - - - - -##### pageSize \{#operation-search+request+pagesize\} - - - - - -Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - - - - - -_Example:_ - -``` -100 -``` - - - - - - - - - -##### query \{#operation-search+request+query\} - - - - - -The search terms. - - - - - -_Example:_ - -``` -vacation policy -``` - - - - - -SearchRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestOptions \{#operation-search+request+requestoptions\} - - - - - - - - - -#### SearchRequestOptions \{#operation-search+request+requestoptions+searchrequestoptions\} - - - - - -AuthToken","children":[{"label":"AuthToken","linkedLabel":"AuthToken","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### authTokens \{#operation-search+request+requestoptions+searchrequestoptions+authtokens\} - - - - - -Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceFilter \{#operation-search+request+requestoptions+searchrequestoptions+datasourcefilter\} - - - - - -Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### datasourcesFilter \{#operation-search+request+requestoptions+searchrequestoptions+datasourcesfilter\} - - - - - -Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### defaultFacets \{#operation-search+request+requestoptions+searchrequestoptions+defaultfacets\} - - - - - -Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - - - - - - - - - -##### disableQueryAutocorrect \{#operation-search+request+requestoptions+searchrequestoptions+disablequeryautocorrect\} - - - - - -Disables automatic adjustment of the input query for spelling corrections or other reasons. - - - - - - - - - -##### disableSpellcheck \{#operation-search+request+requestoptions+searchrequestoptions+disablespellcheck\} - - - - - -Whether or not to disable spellcheck. - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### exclusions \{#operation-search+request+requestoptions+searchrequestoptions+exclusions\} - - - - - - - - - - - - - - - - - - - -FacetBucketFilter","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetBucketFilter \{#operation-search+request+requestoptions+searchrequestoptions+facetbucketfilter\} - - - - - - - - - - - - - - - - - - - - - - - -##### facetBucketSize \{#operation-search+request+requestoptions+searchrequestoptions+facetbucketsize\} - - - - - -The maximum number of FacetBuckets to return in each FacetResult. - - - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilterSets \{#operation-search+request+requestoptions+searchrequestoptions+facetfiltersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilters \{#operation-search+request+requestoptions+searchrequestoptions+facetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### fetchAllDatasourceCounts \{#operation-search+request+requestoptions+searchrequestoptions+fetchalldatasourcecounts\} - - - - - -Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inclusions \{#operation-search+request+requestoptions+searchrequestoptions+inclusions\} - - - - - - - - - - - - - - - - - - - - - - - -##### queryOverridesFacetFilters \{#operation-search+request+requestoptions+searchrequestoptions+queryoverridesfacetfilters\} - - - - - -If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - - - - - - - - - -##### responseHints \{#operation-search+request+requestoptions+searchrequestoptions+responsehints\} - - - - - -Array of hints containing which fields should be populated in the response. - - - - - - - - - -##### returnLlmContentOverSnippets \{#operation-search+request+requestoptions+searchrequestoptions+returnllmcontentoversnippets\} - - - - - -Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - - - - - - - - - -##### timezoneOffset \{#operation-search+request+requestoptions+searchrequestoptions+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - - - - - - - - - -##### resultTabIds \{#operation-search+request+resulttabids\} - - - - - -The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict. - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-search+request+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-search+request+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-search+request+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-search+request+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-search+request+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-search+request+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#operation-search+request+sourcedocument\} - - - - - - - - - -#### Document \{#operation-search+request+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#operation-search+request+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#operation-search+request+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-search+request+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-search+request+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#operation-search+request+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#operation-search+request+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-search+request+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#operation-search+request+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#operation-search+request+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-search+request+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#operation-search+request+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - - - - -##### timeoutMillis \{#operation-search+request+timeoutmillis\} - - - - - -Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - - - - - -_Example:_ - -``` -5000 -``` - - - - - - - - - -##### timestamp \{#operation-search+request+timestamp\} - - - - - -The ISO 8601 timestamp associated with the client request. - - - - - - - - - -##### trackingToken \{#operation-search+request+trackingtoken\} - - - - - -A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-search+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - -403 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-search+responses\} - - - - - -200 - - - - - - - -OK - - - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### GleanDataError \{#operation-search+responses+200+application-json+gleandataerror\} - - - - - - - - - - - - - -##### backendTimeMillis \{#operation-search+responses+200+application-json+backendtimemillis\} - - - - - -Time in milliseconds the backend took to respond to the request. - - - - - -_Example:_ - -``` -1100 -``` - - - - - - - - - -##### cursor \{#operation-search+responses+200+application-json+cursor\} - - - - - -Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - - - - - - - - - -##### experimentIds \{#operation-search+responses+200+application-json+experimentids\} - - - - - -List of experiment ids for the corresponding request. - - - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#operation-search+responses+200+application-json+facetresults\} - - - - - - - - - -#### FacetResult \{#operation-search+responses+200+application-json+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#operation-search+responses+200+application-json+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#operation-search+responses+200+application-json+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#operation-search+responses+200+application-json+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#operation-search+responses+200+application-json+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#operation-search+responses+200+application-json+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedQnaResult \{#operation-search+responses+200+application-json+generatedqnaresult\} - - - - - - - - - -#### GeneratedQna \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna\} - - - - - - - - - -##### answer \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+answer\} - - - - - -Answer generated for the given query or the generated question. - - - - - - - - - -##### cursor \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+cursor\} - - - - - -An opaque cursor representing the search request - - - - - - - - - -##### followUpPrompts \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+followupprompts\} - - - - - -List of all follow-up prompts generated for the given query or the generated question. - - - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### followupActions \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+question\} - - - - - -Search query rephrased into a question. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+status\} - - - - - -Status of backend generating the answer - - - - - - - - - -##### trackingToken \{#operation-search+responses+200+application-json+generatedqnaresult+generatedqna+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### hasMoreResults \{#operation-search+responses+200+application-json+hasmoreresults\} - - - - - -Whether more results are available. Use cursor to retrieve them. - - - - - -SearchResponseMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#operation-search+responses+200+application-json+metadata\} - - - - - - - - - -#### SearchResponseMetadata \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata\} - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalQuerySuggestions \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+additionalquerysuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### isNoQuotesSuggestion \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+isnoquotessuggestion\} - - - - - -Whether the query was modified to remove quotes - - - - - - - - - -##### modifiedQueryWasUsed \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+modifiedquerywasused\} - - - - - -A different query was performed than the one requested. - - - - - - - - - -##### negatedTerms \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+negatedterms\} - - - - - -A list of terms that were negated when processing the query. - - - - - - - - - -##### originalQuery \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+originalquery\} - - - - - -The query text sent by the client in the request. - - - - - - - - - -##### originalQueryHadNoResults \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+originalqueryhadnoresults\} - - - - - -No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based. - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+querysuggestion\} - - - - - - - - - - - - - - - - - - - - - - - -##### rewrittenQuery \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+rewrittenquery\} - - - - - -A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators. - - - - - -SearchWarning","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchWarning \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+searchwarning\} - - - - - - - - - - - - - - - - - - - - - - - -##### searchedQuery \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+searchedquery\} - - - - - -The actual query used to perform search and return results. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchedQueryRanges \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+searchedqueryranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### searchedQueryWithoutNegation \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+searchedquerywithoutnegation\} - - - - - -The query used to perform search and return results, with negated terms and facets removed. - - - - - - - - - -##### triggeredExpertDetection \{#operation-search+responses+200+application-json+metadata+searchresponsemetadata+triggeredexpertdetection\} - - - - - -Whether the query triggered expert detection results in the People tab. - - - - - - - - - - - - - - - - - -##### requestID \{#operation-search+responses+200+application-json+requestid\} - - - - - -A platform-generated request ID to correlate backend logs. - - - - - - - - - -##### resultTabIds \{#operation-search+responses+200+application-json+resulttabids\} - - - - - -The unique IDs of the result tabs to which this response belongs. - - - - - -ResultTab","children":[{"label":"ResultTab","linkedLabel":"ResultTab","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultTabs \{#operation-search+responses+200+application-json+resulttabs\} - - - - - -All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - - - - - - - - - -#### ResultTab \{#operation-search+responses+200+application-json+resulttabs+resulttab\} - - - - - - - - - -##### count \{#operation-search+responses+200+application-json+resulttabs+resulttab+count\} - - - - - -The number of results in this tab for the current query. - - - - - - - - - -##### datasource \{#operation-search+responses+200+application-json+resulttabs+resulttab+datasource\} - - - - - -The datasource associated with the tab, if any. - - - - - - - - - -##### datasourceInstance \{#operation-search+responses+200+application-json+resulttabs+resulttab+datasourceinstance\} - - - - - -The datasource instance associated with the tab, if any. - - - - - - - - - -##### id \{#operation-search+responses+200+application-json+resulttabs+resulttab+id\} - - - - - -The unique ID of the tab. Can be passed in a search request to get results for that tab. - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-search+responses+200+application-json+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#operation-search+responses+200+application-json+results+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#operation-search+responses+200+application-json+results+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - - - - - - - - - - - -##### attachmentContext \{#operation-search+responses+200+application-json+results+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#operation-search+responses+200+application-json+results+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#operation-search+responses+200+application-json+results+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#operation-search+responses+200+application-json+results+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#operation-search+responses+200+application-json+results+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#operation-search+responses+200+application-json+results+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-search+responses+200+application-json+results+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#operation-search+responses+200+application-json+results+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#operation-search+responses+200+application-json+results+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#operation-search+responses+200+application-json+results+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#operation-search+responses+200+application-json+results+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#operation-search+responses+200+application-json+results+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-search+responses+200+application-json+results+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#operation-search+responses+200+application-json+results+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#operation-search+responses+200+application-json+results+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-search+responses+200+application-json+results+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#operation-search+responses+200+application-json+results+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-search+responses+200+application-json+results+searchresult+title\} - - - - - - - - - -##### trackingToken \{#operation-search+responses+200+application-json+results+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#operation-search+responses+200+application-json+results+searchresult+url\} - - - - - - - - - - - - - -ResultsDescription","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultsDescription \{#operation-search+responses+200+application-json+resultsdescription\} - - - - - - - - - -#### ResultsDescription \{#operation-search+responses+200+application-json+resultsdescription+resultsdescription\} - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#operation-search+responses+200+application-json+resultsdescription+resultsdescription+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#operation-search+responses+200+application-json+resultsdescription+resultsdescription+text\} - - - - - -Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab. - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### rewrittenFacetFilters \{#operation-search+responses+200+application-json+rewrittenfacetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-search+responses+200+application-json+rewrittenfacetfilters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-search+responses+200+application-json+rewrittenfacetfilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-search+responses+200+application-json+rewrittenfacetfilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-search+responses+200+application-json+rewrittenfacetfilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#operation-search+responses+200+application-json+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#operation-search+responses+200+application-json+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#operation-search+responses+200+application-json+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#operation-search+responses+200+application-json+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#operation-search+responses+200+application-json+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#operation-search+responses+200+application-json+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredResults \{#operation-search+responses+200+application-json+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - -#### StructuredResult \{#operation-search+responses+200+application-json+structuredresults+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#operation-search+responses+200+application-json+structuredresults+structuredresult+answer\} - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerBoard \{#operation-search+responses+200+application-json+structuredresults+structuredresult+answerboard\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#operation-search+responses+200+application-json+structuredresults+structuredresult+app\} - - - - - - - - - - - - - - - - - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### code \{#operation-search+responses+200+application-json+structuredresults+structuredresult+code\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#operation-search+responses+200+application-json+structuredresults+structuredresult+collection\} - - - - - - - - - - - - - - - - - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customEntity \{#operation-search+responses+200+application-json+structuredresults+structuredresult+customentity\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#operation-search+responses+200+application-json+structuredresults+structuredresult+customer\} - - - - - - - - - - - - - - - - - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### disambiguation \{#operation-search+responses+200+application-json+structuredresults+structuredresult+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-search+responses+200+application-json+structuredresults+structuredresult+document\} - - - - - - - - - - - - - - - - - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### extractedQnA \{#operation-search+responses+200+application-json+structuredresults+structuredresult+extractedqna\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQna \{#operation-search+responses+200+application-json+structuredresults+structuredresult+generatedqna\} - - - - - - - - - - - - - - - - - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### meeting \{#operation-search+responses+200+application-json+structuredresults+structuredresult+meeting\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-search+responses+200+application-json+structuredresults+structuredresult+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#operation-search+responses+200+application-json+structuredresults+structuredresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestions \{#operation-search+responses+200+application-json+structuredresults+structuredresult+querysuggestions\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#operation-search+responses+200+application-json+structuredresults+structuredresult+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedQuestion \{#operation-search+responses+200+application-json+structuredresults+structuredresult+relatedquestion\} - - - - - - - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#operation-search+responses+200+application-json+structuredresults+structuredresult+shortcut\} - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#operation-search+responses+200+application-json+structuredresults+structuredresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - - - - - -##### source \{#operation-search+responses+200+application-json+structuredresults+structuredresult+source\} - - - - - -Source context for this result. Possible values depend on the result type. - - - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### team \{#operation-search+responses+200+application-json+structuredresults+structuredresult+team\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-search+responses+200+application-json+structuredresults+structuredresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - - - - -##### trackingToken \{#operation-search+responses+200+application-json+trackingtoken\} - - - - - -A token that should be passed for additional requests related to this request (such as more results requests). - - - - - - - - - - - -403 - - - - - - - -Forbidden - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-search+responses+403+application-json+httpmeta\} - - - - - - - - - -#### HTTPMetadata \{#operation-search+responses+403+application-json+httpmeta+httpmetadata\} - - - - - - - - - -##### Request \{#operation-search+responses+403+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response \{#operation-search+responses+403+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - - - - - -##### badGmailToken \{#operation-search+responses+403+application-json+badgmailtoken\} - - - - - -Indicates the gmail results could not be fetched due to bad token. - - - - - - - - - -##### badOutlookToken \{#operation-search+responses+403+application-json+badoutlooktoken\} - - - - - -Indicates the outlook results could not be fetched due to bad token. - - - - - -ErrorMessage","children":[{"label":"ErrorMessage","linkedLabel":"ErrorMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errorMessages \{#operation-search+responses+403+application-json+errormessages\} - - - - - - - - - -#### ErrorMessage \{#operation-search+responses+403+application-json+errormessages+errormessage\} - - - - - - - - - -##### errorMessage \{#operation-search+responses+403+application-json+errormessages+errormessage+errormessage\} - - - - - - - - - -##### source \{#operation-search+responses+403+application-json+errormessages+errormessage+source\} - - - - - -The datasource this message relates to. - - - - - - - - - - - - - -InvalidOperatorValueError","children":[{"label":"InvalidOperatorValueError","linkedLabel":"InvalidOperatorValueError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### invalidOperators \{#operation-search+responses+403+application-json+invalidoperators\} - - - - - -Indicates results could not be fetched due to invalid operators in the query. - - - - - - - - - -#### InvalidOperatorValueError \{#operation-search+responses+403+application-json+invalidoperators+invalidoperatorvalueerror\} - - - - - - - - - -##### key \{#operation-search+responses+403+application-json+invalidoperators+invalidoperatorvalueerror+key\} - - - - - -The operator key that has an invalid value. - - - - - - - - - -##### value \{#operation-search+responses+403+application-json+invalidoperators+invalidoperatorvalueerror+value\} - - - - - -The invalid operator value. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/shortcuts.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/shortcuts.mdx deleted file mode 100644 index b10a58d3e..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/shortcuts.mdx +++ /dev/null @@ -1,5407 +0,0 @@ ---- -sidebar_position: 3.15 -sidebar_label: Client Shortcuts ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyDisplayTypeSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../../../../../src/components/glean-embeds/loaders/addedroles.tsx"; -import Embedremovedroles from "../../../../../src/components/glean-embeds/loaders/removedroles.tsx"; -import Embedcreatedby from "../../../../../src/components/glean-embeds/loaders/createdby.tsx"; -import Embeddestinationdocument from "../../../../../src/components/glean-embeds/loaders/destinationdocument.tsx"; -import Embedpermissions from "../../../../../src/components/glean-embeds/loaders/permissions.tsx"; -import Embedroles from "../../../../../src/components/glean-embeds/loaders/roles.tsx"; -import Embedupdatedby from "../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; -import Embedvalues from "../../../../../src/components/glean-embeds/loaders/values.tsx"; -import Embedbuckets from "../../../../../src/components/glean-embeds/loaders/buckets.tsx"; -import Embedgroup from "../../../../../src/components/glean-embeds/loaders/group.tsx"; -import Embedperson from "../../../../../src/components/glean-embeds/loaders/person.tsx"; - - - - - - - -# Client Shortcuts Endpoints - - - - - - - - - -## POST /rest/api/v1/createshortcut \{#operation-createshortcut\} - - - - - -_Create shortcut_ - - - - - -Create a user-generated shortcut that contains an alias and destination URL. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/createshortcut \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "data": {} -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-createshortcut+request-examples\} - - - - - -```json -{ - "data": {} -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-createshortcut+request\} - - - - - - - -CreateShortcut request - - - - - -ShortcutMutableProperties","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-createshortcut+request+data\} - - - - - - - - - -#### ShortcutMutableProperties \{#operation-createshortcut+request+data+shortcutmutableproperties\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-createshortcut+request+data+shortcutmutableproperties+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-createshortcut+request+data+shortcutmutableproperties+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - - - - - -##### destinationDocumentId \{#operation-createshortcut+request+data+shortcutmutableproperties+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-createshortcut+request+data+shortcutmutableproperties+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### inputAlias \{#operation-createshortcut+request+data+shortcutmutableproperties+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-createshortcut+request+data+shortcutmutableproperties+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### unlisted \{#operation-createshortcut+request+data+shortcutmutableproperties+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### urlTemplate \{#operation-createshortcut+request+data+shortcutmutableproperties+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-createshortcut+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-createshortcut+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ShortcutError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-createshortcut+responses+200+application-json+error\} - - - - - - - - - -#### ShortcutError \{#operation-createshortcut+responses+200+application-json+error+shortcuterror\} - - - - - - - - - -##### errorType \{#operation-createshortcut+responses+200+application-json+error+shortcuterror+errortype\} - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcut \{#operation-createshortcut+responses+200+application-json+shortcut\} - - - - - - - - - -#### Shortcut \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### alias \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+alias\} - - - - - -canonical link text following go/ prefix where hyphen/underscore is removed. - - - - - - - - - -##### createTime \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+createtime\} - - - - - -The time the shortcut was created in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### destinationDocument \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+destinationdocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### destinationDocumentId \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### id \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - - - - - -##### intermediateUrl \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. Full replacement for https://go/\{inputAlias\}. - - - - - - - - - -##### isExternal \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+isexternal\} - - - - - -Indicates whether a shortcut is native or external. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+title\} - - - - - -Title for the Go Link - - - - - - - - - -##### unlisted \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### updateTime \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+updatetime\} - - - - - -The time the shortcut was updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### urlTemplate \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -##### viewPrefix \{#operation-createshortcut+responses+200+application-json+shortcut+shortcut+viewprefix\} - - - - - -The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/deleteshortcut \{#operation-deleteshortcut\} - - - - - -_Delete shortcut_ - - - - - -Delete an existing user-generated shortcut. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/deleteshortcut \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": 87 -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-deleteshortcut+request-examples\} - - - - - -```json -{ - "id": 87 -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-deleteshortcut+request\} - - - - - - - -DeleteShortcut request - - - - - - - - - -##### id \{#operation-deleteshortcut+request+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -
    - -     - -     - - - - - -## POST /rest/api/v1/getshortcut \{#operation-getshortcut\} - - - - - -_Read shortcut_ - - - - - -Read a particular shortcut's details given its ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/getshortcut \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-getshortcut+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-getshortcut+request\} - - - - - - - -UserGeneratedContentId","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -GetShortcut request - - - - - - - - - -#### UserGeneratedContentId \{#operation-getshortcut+request+usergeneratedcontentid\} - - - - - - - - - -##### id \{#operation-getshortcut+request+usergeneratedcontentid+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-getshortcut+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-getshortcut+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ShortcutError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-getshortcut+responses+200+application-json+error\} - - - - - - - - - -#### ShortcutError \{#operation-getshortcut+responses+200+application-json+error+shortcuterror\} - - - - - - - - - -##### errorType \{#operation-getshortcut+responses+200+application-json+error+shortcuterror+errortype\} - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcut \{#operation-getshortcut+responses+200+application-json+shortcut\} - - - - - - - - - -#### Shortcut \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### alias \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+alias\} - - - - - -canonical link text following go/ prefix where hyphen/underscore is removed. - - - - - - - - - -##### createTime \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+createtime\} - - - - - -The time the shortcut was created in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### destinationDocument \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+destinationdocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### destinationDocumentId \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### id \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - - - - - -##### intermediateUrl \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. Full replacement for https://go/\{inputAlias\}. - - - - - - - - - -##### isExternal \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+isexternal\} - - - - - -Indicates whether a shortcut is native or external. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+title\} - - - - - -Title for the Go Link - - - - - - - - - -##### unlisted \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### updateTime \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+updatetime\} - - - - - -The time the shortcut was updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### urlTemplate \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -##### viewPrefix \{#operation-getshortcut+responses+200+application-json+shortcut+shortcut+viewprefix\} - - - - - -The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listshortcuts \{#operation-listshortcuts\} - - - - - -_List shortcuts_ - - - - - -List shortcuts editable/owned by the currently authenticated user. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listshortcuts \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "pageSize": "10" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-listshortcuts+request-examples\} - - - - - -```json -{ - "pageSize": "10" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-listshortcuts+request\} - - - - - - - -Filters, sorters, paging params required for pagination - - - - - - - - - -##### cursor \{#operation-listshortcuts+request+cursor\} - - - - - -A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination) - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### filters \{#operation-listshortcuts+request+filters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#operation-listshortcuts+request+filters+facetfilter\} - - - - - - - - - -##### fieldName \{#operation-listshortcuts+request+filters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#operation-listshortcuts+request+filters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#operation-listshortcuts+request+filters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### includeFields \{#operation-listshortcuts+request+includefields\} - - - - - -Array of fields/data to be included in response that are not included by default - - - - - - - - - -##### pageSize \{#operation-listshortcuts+request+pagesize\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - -##### query \{#operation-listshortcuts+request+query\} - - - - - -Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts. - - - - - -SortOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sort \{#operation-listshortcuts+request+sort\} - - - - - - - - - -#### SortOptions \{#operation-listshortcuts+request+sort+sortoptions\} - - - - - - - - - -##### orderBy \{#operation-listshortcuts+request+sort+sortoptions+orderby\} - - - - - - - - - -##### sortBy \{#operation-listshortcuts+request+sort+sortoptions+sortby\} - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listshortcuts+responses-examples\} - - - - - -200 - - - - - -```json -{ - "meta": {}, - "shortcuts": [ - { - "inputAlias": "ipsum eiusmod" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-listshortcuts+responses\} - - - - - -200 - - - - - - - -OK - - - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#operation-listshortcuts+responses+200+application-json+facetresults\} - - - - - - - - - -#### FacetResult \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#operation-listshortcuts+responses+200+application-json+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - -ShortcutsPaginationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### meta \{#operation-listshortcuts+responses+200+application-json+meta\} - - - - - - - - - -#### ShortcutsPaginationMetadata \{#operation-listshortcuts+responses+200+application-json+meta+shortcutspaginationmetadata\} - - - - - - - - - -##### cursor \{#operation-listshortcuts+responses+200+application-json+meta+shortcutspaginationmetadata+cursor\} - - - - - -Cursor indicates the start of the next page of results - - - - - - - - - -##### hasNextPage \{#operation-listshortcuts+responses+200+application-json+meta+shortcutspaginationmetadata+hasnextpage\} - - - - - - - - - -##### totalItemCount \{#operation-listshortcuts+responses+200+application-json+meta+shortcutspaginationmetadata+totalitemcount\} - - - - - - - - - - - - - -Shortcut","children":[{"label":"Shortcut","linkedLabel":"Shortcut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcuts \{#operation-listshortcuts+responses+200+application-json+shortcuts\} - - - - - -A list of shortcuts of which destination URL is for the document. - - - - - - - - - -#### Shortcut \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### alias \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+alias\} - - - - - -canonical link text following go/ prefix where hyphen/underscore is removed. - - - - - - - - - -##### createTime \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+createtime\} - - - - - -The time the shortcut was created in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### destinationDocument \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+destinationdocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### destinationDocumentId \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### id \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - - - - - -##### intermediateUrl \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. Full replacement for https://go/\{inputAlias\}. - - - - - - - - - -##### isExternal \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+isexternal\} - - - - - -Indicates whether a shortcut is native or external. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+title\} - - - - - -Title for the Go Link - - - - - - - - - -##### unlisted \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### updateTime \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+updatetime\} - - - - - -The time the shortcut was updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### urlTemplate \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -##### viewPrefix \{#operation-listshortcuts+responses+200+application-json+shortcuts+shortcut+viewprefix\} - - - - - -The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/updateshortcut \{#operation-updateshortcut\} - - - - - -_Update shortcut_ - - - - - -Updates the shortcut with the given ID. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/updateshortcut \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": 87 -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-updateshortcut+request-examples\} - - - - - -```json -{ - "id": 87 -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-updateshortcut+request\} - - - - - - - -Shortcut content. Id need to be specified for the shortcut. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#operation-updateshortcut+request+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-updateshortcut+request+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-updateshortcut+request+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-updateshortcut+request+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-updateshortcut+request+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-updateshortcut+request+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### description \{#operation-updateshortcut+request+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - - - - - -##### destinationDocumentId \{#operation-updateshortcut+request+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-updateshortcut+request+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### id \{#operation-updateshortcut+request+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#operation-updateshortcut+request+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#operation-updateshortcut+request+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#operation-updateshortcut+request+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#operation-updateshortcut+request+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#operation-updateshortcut+request+removedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#operation-updateshortcut+request+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#operation-updateshortcut+request+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - - - - -##### unlisted \{#operation-updateshortcut+request+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### urlTemplate \{#operation-updateshortcut+request+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-updateshortcut+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-updateshortcut+responses\} - - - - - -200 - - - - - - - -OK - - - - - -ShortcutError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### error \{#operation-updateshortcut+responses+200+application-json+error\} - - - - - - - - - -#### ShortcutError \{#operation-updateshortcut+responses+200+application-json+error+shortcuterror\} - - - - - - - - - -##### errorType \{#operation-updateshortcut+responses+200+application-json+error+shortcuterror+errortype\} - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcut \{#operation-updateshortcut+responses+200+application-json+shortcut\} - - - - - - - - - -#### Shortcut \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### alias \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+alias\} - - - - - -canonical link text following go/ prefix where hyphen/underscore is removed. - - - - - - - - - -##### createTime \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+createtime\} - - - - - -The time the shortcut was created in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### destinationDocument \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+destinationdocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### destinationDocumentId \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### id \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - - - - - -##### intermediateUrl \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. Full replacement for https://go/\{inputAlias\}. - - - - - - - - - -##### isExternal \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+isexternal\} - - - - - -Indicates whether a shortcut is native or external. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+title\} - - - - - -Title for the Go Link - - - - - - - - - -##### unlisted \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### updateTime \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+updatetime\} - - - - - -The time the shortcut was updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### urlTemplate \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -##### viewPrefix \{#operation-updateshortcut+responses+200+application-json+shortcut+shortcut+viewprefix\} - - - - - -The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/tools.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/tools.mdx deleted file mode 100644 index 4da170cc7..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/tools.mdx +++ /dev/null @@ -1,906 +0,0 @@ ---- -sidebar_position: 3.16 -sidebar_label: Client Tools ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedparameters from "../../../../../src/components/glean-embeds/loaders/parameters.tsx"; -import Embeditems from "../../../../../src/components/glean-embeds/loaders/items.tsx"; -import Embedproperties from "../../../../../src/components/glean-embeds/loaders/properties.tsx"; - - - - - - - -# Client Tools Endpoints - - - - - - - - - -## GET /rest/api/v1/tools/list \{#operation-get_rest_api_v1_tools_list\} - - - - - -_List available tools_ - - - - - -Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/tools/list \ - -X GET \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-get_rest_api_v1_tools_list+parameters\} - - - - - - - - - - - -##### toolNames \{#operation-get_rest_api_v1_tools_list+parameters+toolnames\} - - - - - -Optional array of tool names to filter by - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-get_rest_api_v1_tools_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-get_rest_api_v1_tools_list+responses\} - - - - - -200 - - - - - - - -Successful operation - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools\} - - - - - - - - - -#### Tool \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool\} - - - - - - - - - -##### description \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool+description\} - - - - - -LLM friendly description of the tool - - - - - - - - - -##### displayName \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool+displayname\} - - - - - -Human-readable name - - - - - - - - - -##### name \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool+name\} - - - - - -Unique identifier for the tool - - - - - -ToolParameter","children":[{"label":"ToolParameter","linkedLabel":"ToolParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parameters \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool+parameters\} - - - - - -The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - - - - - - - - - - - - - - - - - - - - - - - -##### type \{#operation-get_rest_api_v1_tools_list+responses+200+application-json+tools+tool+type\} - - - - - -Type of tool (READ, WRITE) - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/tools/call \{#operation-post_rest_api_v1_tools_call\} - - - - - -_Execute the specified tool_ - - - - - -Execute the specified tool with provided parameters - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/tools/call \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "name": "ipsum eiusmod", - "parameters": [ - { - "name": "consequat do", - "value": "reprehenderit ut dolore" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_rest_api_v1_tools_call+request-examples\} - - - - - -```json -{ - "name": "ipsum eiusmod", - "parameters": [ - { - "name": "consequat do", - "value": "reprehenderit ut dolore" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_rest_api_v1_tools_call+request\} - - - - - - - - - - - -##### name \{#operation-post_rest_api_v1_tools_call+request+name\} - - - - - -Required name of the tool to execute - - - - - -ToolsCallParameter","children":[{"label":"ToolsCallParameter","linkedLabel":"ToolsCallParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### parameters \{#operation-post_rest_api_v1_tools_call+request+parameters\} - - - - - -The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - - - - - - - - - -#### ToolsCallParameter \{#operation-post_rest_api_v1_tools_call+request+parameters+toolscallparameter\} - - - - - -ToolsCallParameter","children":[{"label":"ToolsCallParameter","linkedLabel":"ToolsCallParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#operation-post_rest_api_v1_tools_call+request+parameters+toolscallparameter+items\} - - - - - -The value of the parameter (for array types) - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-post_rest_api_v1_tools_call+request+parameters+toolscallparameter+name\} - - - - - -The name of the parameter - - - - - -ToolsCallParameter","children":[{"label":"ToolsCallParameter","linkedLabel":"ToolsCallParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### properties \{#operation-post_rest_api_v1_tools_call+request+parameters+toolscallparameter+properties\} - - - - - -The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - - - - - - - - - - - - - - - - - - - - - - - -##### value \{#operation-post_rest_api_v1_tools_call+request+parameters+toolscallparameter+value\} - - - - - -The value of the parameter (for primitive types) - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_rest_api_v1_tools_call+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_rest_api_v1_tools_call+responses\} - - - - - -200 - - - - - - - -Successful operation - - - - - - - - - -##### error \{#operation-post_rest_api_v1_tools_call+responses+200+application-json+error\} - - - - - -The error message if applicable - - - - - - - - - -##### rawResponse \{#operation-post_rest_api_v1_tools_call+responses+200+application-json+rawresponse\} - - - - - -The raw response from the tool - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/client/verification.mdx b/examples/docusaurus/docs/glean/api/endpoint/client/verification.mdx deleted file mode 100644 index 41bcb01ae..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/client/verification.mdx +++ /dev/null @@ -1,1614 +0,0 @@ ---- -sidebar_position: 3.17 -sidebar_label: Client Verification ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedcandidateverifiers from "../../../../../src/components/glean-embeds/loaders/candidateverifiers.tsx"; -import Embeddocument from "../../../../../src/components/glean-embeds/loaders/document.tsx"; -import Embedlastreminder from "../../../../../src/components/glean-embeds/loaders/lastreminder.tsx"; -import Embedlastverifier from "../../../../../src/components/glean-embeds/loaders/lastverifier.tsx"; -import Embedreminders from "../../../../../src/components/glean-embeds/loaders/reminders.tsx"; -import Embedvisitorcount from "../../../../../src/components/glean-embeds/loaders/visitorcount.tsx"; -import Embedmetadata from "../../../../../src/components/glean-embeds/loaders/metadata.tsx"; - - - - - - - -# Client Verification Endpoints - - - - - - - - - -## POST /rest/api/v1/addverificationreminder \{#operation-addverificationreminder\} - - - - - -_Create verification_ - - - - - -Creates a verification reminder for the document. Users can create verification reminders from different product surfaces. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/addverificationreminder \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "documentId": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-addverificationreminder+request-examples\} - - - - - -```json -{ - "documentId": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-addverificationreminder+request\} - - - - - - - -Details about the reminder. - - - - - - - - - -##### assignee \{#operation-addverificationreminder+request+assignee\} - - - - - -The obfuscated id of the person this verification is assigned to. - - - - - - - - - -##### documentId \{#operation-addverificationreminder+request+documentid\} - - - - - -The document which the verification is for new reminders and/or update. - - - - - - - - - -##### reason \{#operation-addverificationreminder+request+reason\} - - - - - -An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - - - - - - - - - -##### remindInDays \{#operation-addverificationreminder+request+remindindays\} - - - - - -Reminder for the next verifications in terms of days. For deletion, this will be omitted. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-addverificationreminder+responses-examples\} - - - - - -200 - - - - - -```json -{ - "state": "UNVERIFIED" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-addverificationreminder+responses\} - - - - - -200 - - - - - - - -OK - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#operation-addverificationreminder+responses+200+application-json+metadata\} - - - - - - - - - -#### VerificationMetadata \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata\} - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### candidateVerifiers \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+candidateverifiers\} - - - - - -A list of POC for company. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### expirationTs \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+expirationts\} - - - - - -The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC). - - - - - -Reminder","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lastReminder \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+lastreminder\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastVerificationTs \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+lastverificationts\} - - - - - -The unix timestamp of the verification (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lastVerifier \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+lastverifier\} - - - - - - - - - - - - - - - - - - - -Reminder","children":[{"label":"Reminder","linkedLabel":"Reminder","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### reminders \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+reminders\} - - - - - -Info about all outstanding verification reminders for the document if exists. - - - - - - - - - - - - - - - - - - - -CountInfo","children":[{"label":"CountInfo","linkedLabel":"CountInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### visitorCount \{#operation-addverificationreminder+responses+200+application-json+metadata+verificationmetadata+visitorcount\} - - - - - -Number of visitors to the document during included time periods. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#operation-addverificationreminder+responses+200+application-json+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/listverifications \{#operation-listverifications\} - - - - - -_List verifications_ - - - - - -Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/listverifications \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-listverifications+parameters\} - - - - - - - - - - - -##### count \{#operation-listverifications+parameters+count\} - - - - - -Maximum number of documents to return - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-listverifications+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-listverifications+responses\} - - - - - -200 - - - - - - - -OK - - - - - -Verification","children":[{"label":"Verification","linkedLabel":"Verification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-listverifications+responses+200+application-json+documents\} - - - - - -List of document infos that include verification related information for them. - - - - - - - - - -#### Verification \{#operation-listverifications+responses+200+application-json+documents+verification\} - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-listverifications+responses+200+application-json+documents+verification+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#operation-listverifications+responses+200+application-json+documents+verification+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /rest/api/v1/verify \{#operation-verify\} - - - - - -_Update verification_ - - - - - -Verify documents to keep the knowledge up to date within customer corpus. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/rest/api/v1/verify \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "documentId": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-verify+request-examples\} - - - - - -```json -{ - "documentId": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-verify+request\} - - - - - - - -Details about the verification request. - - - - - - - - - -##### action \{#operation-verify+request+action\} - - - - - -The verification action requested. - - - - - - - - - -##### documentId \{#operation-verify+request+documentid\} - - - - - -The document which is verified. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-verify+responses-examples\} - - - - - -200 - - - - - -```json -{ - "state": "UNVERIFIED" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-verify+responses\} - - - - - -200 - - - - - - - -OK - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#operation-verify+responses+200+application-json+metadata\} - - - - - - - - - -#### VerificationMetadata \{#operation-verify+responses+200+application-json+metadata+verificationmetadata\} - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### candidateVerifiers \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+candidateverifiers\} - - - - - -A list of POC for company. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### expirationTs \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+expirationts\} - - - - - -The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC). - - - - - -Reminder","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lastReminder \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+lastreminder\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastVerificationTs \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+lastverificationts\} - - - - - -The unix timestamp of the verification (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lastVerifier \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+lastverifier\} - - - - - - - - - - - - - - - - - - - -Reminder","children":[{"label":"Reminder","linkedLabel":"Reminder","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### reminders \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+reminders\} - - - - - -Info about all outstanding verification reminders for the document if exists. - - - - - - - - - - - - - - - - - - - -CountInfo","children":[{"label":"CountInfo","linkedLabel":"CountInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### visitorCount \{#operation-verify+responses+200+application-json+metadata+verificationmetadata+visitorcount\} - - - - - -Number of visitors to the document during included time periods. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#operation-verify+responses+200+application-json+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/authentication.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/authentication.mdx deleted file mode 100644 index 95201ee4b..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/authentication.mdx +++ /dev/null @@ -1,270 +0,0 @@ ---- -sidebar_position: 3.18 -sidebar_label: Indexing Authentication ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableProperty, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Indexing Authentication Endpoints - - - - - - - - - -## POST /api/index/v1/rotatetoken \{#operation-post_api_index_v1_rotatetoken\} - - - - - -_Rotate token_ - - - - - -Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/rotatetoken \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_rotatetoken+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_rotatetoken+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### createdAt \{#operation-post_api_index_v1_rotatetoken+responses+200+application-json+createdat\} - - - - - -Unix timestamp in seconds when the new secret value is assigned to the token. The token needs to be rotated before `rotationPeriodMinutes` past the createdAt timestamp otherwise it would be rendered unusable. - - - - - - - - - -##### rawSecret \{#operation-post_api_index_v1_rotatetoken+responses+200+application-json+rawsecret\} - - - - - -New raw secret - - - - - - - - - -##### rotationPeriodMinutes \{#operation-post_api_index_v1_rotatetoken+responses+200+application-json+rotationperiodminutes\} - - - - - -Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified `rotationPeriodMinutes` after each `/rotatetoken` call, otherwise the tokens would expire. Note that the token would still expire at `expiresAt` timestamp provided during token creation even if the token is being regularly rotated. `rotationPeriodMinutes` property is inherited from the parent token being rotated - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/datasource.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/datasource.mdx deleted file mode 100644 index 52bca1cb9..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/datasource.mdx +++ /dev/null @@ -1,333 +0,0 @@ ---- -sidebar_position: 3.19 -sidebar_label: Indexing Datasource ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Indexing Datasource Endpoints - - - - - - - - - -## POST /api/index/v1/debug/\{datasource\}/status \{#operation-post_api_index_v1_debug_datasource_status\} - - - - - -_Beta: Get datasource status -_ - - - - - -Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. - -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/debug/{datasource}/status \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-post_api_index_v1_debug_datasource_status+parameters\} - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_debug_datasource_status+parameters+datasource\} - - - - - -The datasource to get debug status for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_debug_datasource_status+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_debug_datasource_status+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### datasourceVisibility \{#operation-post_api_index_v1_debug_datasource_status+responses+200+application-json; charset=utf-8+datasourcevisibility\} - - - - - -The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE - - - - - -_Example:_ - -``` -ENABLED_FOR_ALL -``` - - - - - -documents","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-post_api_index_v1_debug_datasource_status+responses+200+application-json; charset=utf-8+documents\} - - - - - - - - - -identity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### identity \{#operation-post_api_index_v1_debug_datasource_status+responses+200+application-json; charset=utf-8+identity\} - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/datasources.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/datasources.mdx deleted file mode 100644 index 57d442b3a..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/datasources.mdx +++ /dev/null @@ -1,2946 +0,0 @@ ---- -sidebar_position: 3.20 -sidebar_label: Indexing Datasources ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedpropertydefinitions from "../../../../../src/components/glean-embeds/loaders/propertydefinitions.tsx"; -import Embedpropertygroups from "../../../../../src/components/glean-embeds/loaders/propertygroups.tsx"; -import Embediconconfig from "../../../../../src/components/glean-embeds/loaders/iconconfig.tsx"; - - - - - - - -# Indexing Datasources Endpoints - - - - - - - - - -## POST /api/index/v1/adddatasource \{#operation-post_api_index_v1_adddatasource\} - - - - - -_Add or update datasource_ - - - - - -Add or update a custom datasource and its schema. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/adddatasource \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "name": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_adddatasource+request-examples\} - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_adddatasource+request\} - - - - - - - -Structure describing config properties of a custom datasource - - - - - - - - - -##### aliases \{#operation-post_api_index_v1_adddatasource+request+aliases\} - - - - - -Aliases that can be used as `app` operator-values. - - - - - -CanonicalizingRegexType","children":[{"label":"CanonicalizingRegexType","linkedLabel":"CanonicalizingRegexType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### canonicalizingTitleRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingtitleregex\} - - - - - -A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - - - - - - - - - -#### CanonicalizingRegexType \{#operation-post_api_index_v1_adddatasource+request+canonicalizingtitleregex+canonicalizingregextype\} - - - - - -Regular expression to apply to an arbitrary string to transform it into a canonical string. - - - - - - - - - -##### matchRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingtitleregex+canonicalizingregextype+matchregex\} - - - - - -Regular expression to match to an arbitrary string. - - - - - - - - - -##### rewriteRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingtitleregex+canonicalizingregextype+rewriteregex\} - - - - - -Regular expression to transform into a canonical string. - - - - - - - - - - - - - -CanonicalizingRegexType","children":[{"label":"CanonicalizingRegexType","linkedLabel":"CanonicalizingRegexType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### canonicalizingURLRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingurlregex\} - - - - - -A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - - - - - - - - - -#### CanonicalizingRegexType \{#operation-post_api_index_v1_adddatasource+request+canonicalizingurlregex+canonicalizingregextype\} - - - - - -Regular expression to apply to an arbitrary string to transform it into a canonical string. - - - - - - - - - -##### matchRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingurlregex+canonicalizingregextype+matchregex\} - - - - - -Regular expression to match to an arbitrary string. - - - - - - - - - -##### rewriteRegex \{#operation-post_api_index_v1_adddatasource+request+canonicalizingurlregex+canonicalizingregextype+rewriteregex\} - - - - - -Regular expression to transform into a canonical string. - - - - - - - - - - - - - - - - - -##### connectorType \{#operation-post_api_index_v1_adddatasource+request+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - - - - - -##### crawlerSeedUrls \{#operation-post_api_index_v1_adddatasource+request+crawlerseedurls\} - - - - - -This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling. - - - - - - - - - -##### datasourceCategory \{#operation-post_api_index_v1_adddatasource+request+datasourcecategory\} - - - - - -The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - - - - - -_Default Value:_ `"UNCATEGORIZED"` - - - - - - - - - -##### displayName \{#operation-post_api_index_v1_adddatasource+request+displayname\} - - - - - -The user-friendly instance label to display. If omitted, falls back to the title-cased `name`. - - - - - - - - - -##### hideBuiltInFacets \{#operation-post_api_index_v1_adddatasource+request+hidebuiltinfacets\} - - - - - -List of built-in facet types that should be hidden for the datasource. - - - - - - - - - -##### homeUrl \{#operation-post_api_index_v1_adddatasource+request+homeurl\} - - - - - -The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page. - - - - - - - - - -##### iconDarkUrl \{#operation-post_api_index_v1_adddatasource+request+icondarkurl\} - - - - - -The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - - - - - - - - - -##### iconUrl \{#operation-post_api_index_v1_adddatasource+request+iconurl\} - - - - - -The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - - - - - - - - - -##### identityDatasourceName \{#operation-post_api_index_v1_adddatasource+request+identitydatasourcename\} - - - - - -If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already. - - - - - - - - - -##### includeUtmSource \{#operation-post_api_index_v1_adddatasource+request+includeutmsource\} - - - - - -If true, a utm_source query param will be added to outbound links to this datasource within Glean. - - - - - - - - - -##### isEntityDatasource \{#operation-post_api_index_v1_adddatasource+request+isentitydatasource\} - - - - - -True if this datasource is used to push custom entities. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### isOnPrem \{#operation-post_api_index_v1_adddatasource+request+isonprem\} - - - - - -Whether or not this datasource is hosted on-premise. - - - - - - - - - -##### isTestDatasource \{#operation-post_api_index_v1_adddatasource+request+istestdatasource\} - - - - - -True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### isUserReferencedByEmail \{#operation-post_api_index_v1_adddatasource+request+isuserreferencedbyemail\} - - - - - -whether email is used to reference users in document ACLs and in group memberships. - - - - - - - - - -##### name \{#operation-post_api_index_v1_adddatasource+request+name\} - - - - - -Unique identifier of datasource instance to which this config applies. - - - - - -ObjectDefinition","children":[{"label":"ObjectDefinition","linkedLabel":"ObjectDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### objectDefinitions \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions\} - - - - - -The list of top-level `objectType`s for the datasource. - - - - - - - - - -#### ObjectDefinition \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition\} - - - - - -The definition for an `DocumentMetadata.objectType` within a datasource. - - - - - - - - - -##### displayLabel \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+displaylabel\} - - - - - -The user-friendly name of the object for display. - - - - - - - - - -##### docCategory \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+doccategory\} - - - - - -The document category of this object type. - - - - - - - - - -##### name \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+name\} - - - - - -Unique identifier for this `DocumentMetadata.objectType`. If omitted, this definition is used as a default for all unmatched `DocumentMetadata.objectType`s in this datasource. - - - - - -PropertyDefinition","children":[{"label":"PropertyDefinition","linkedLabel":"PropertyDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### propertyDefinitions \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+propertydefinitions\} - - - - - - - - - - - - - - - - - - - -PropertyGroup","children":[{"label":"PropertyGroup","linkedLabel":"PropertyGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### propertyGroups \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+propertygroups\} - - - - - -A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI. - - - - - - - - - - - - - - - - - - - - - - - -##### summarizable \{#operation-post_api_index_v1_adddatasource+request+objectdefinitions+objectdefinition+summarizable\} - - - - - -Whether or not the object is summarizable - - - - - - - - - - - - - - - - - -##### productAccessGroup \{#operation-post_api_index_v1_adddatasource+request+productaccessgroup\} - - - - - -If the datasource uses a specific product access group, then the name of that group. - - - - - -Quicklink","children":[{"label":"Quicklink","linkedLabel":"Quicklink","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### quicklinks \{#operation-post_api_index_v1_adddatasource+request+quicklinks\} - - - - - -List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira - - - - - - - - - -#### Quicklink \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink\} - - - - - -An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+id\} - - - - - -Unique identifier of this quicklink - - - - - - - - - -##### name \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+name\} - - - - - -Full action name. Used in autocomplete. - - - - - - - - - -##### scopes \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+scopes\} - - - - - -The scopes for which this quicklink is applicable - - - - - - - - - -##### shortName \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+shortname\} - - - - - -Shortened name. Used in app cards. - - - - - - - - - -##### url \{#operation-post_api_index_v1_adddatasource+request+quicklinks+quicklink+url\} - - - - - -The URL of the action. - - - - - - - - - - - - - - - - - -##### redlistTitleRegex \{#operation-post_api_index_v1_adddatasource+request+redlisttitleregex\} - - - - - -A regex that identifies titles that should not be indexed - - - - - - - - - -##### renderConfigPreset \{#operation-post_api_index_v1_adddatasource+request+renderconfigpreset\} - - - - - -The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details - - - - - - - - - -##### stripFragmentInCanonicalUrl \{#operation-post_api_index_v1_adddatasource+request+stripfragmentincanonicalurl\} - - - - - -If true, the fragment part of the URL will be stripped when converting to a canonical url. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### suggestionText \{#operation-post_api_index_v1_adddatasource+request+suggestiontext\} - - - - - -Example text for what to search for in this datasource - - - - - - - - - -##### trustUrlRegexForViewActivity \{#operation-post_api_index_v1_adddatasource+request+trusturlregexforviewactivity\} - - - - - -True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### urlRegex \{#operation-post_api_index_v1_adddatasource+request+urlregex\} - - - - - -Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.** - - - - - -_Example:_ - -``` -https://example-company.datasource.com/.* -``` - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/getdatasourceconfig \{#operation-post_api_index_v1_getdatasourceconfig\} - - - - - -_Get datasource config_ - - - - - -Fetches the datasource config for the specified custom datasource. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/getdatasourceconfig \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_getdatasourceconfig+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_getdatasourceconfig+request\} - - - - - - - -Describes the request body of the /getdatasourceconfig API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_getdatasourceconfig+request+datasource\} - - - - - -Datasource name for which config is needed. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_getdatasourceconfig+responses-examples\} - - - - - -200 - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_getdatasourceconfig+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### aliases \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+aliases\} - - - - - -Aliases that can be used as `app` operator-values. - - - - - -CanonicalizingRegexType","children":[{"label":"CanonicalizingRegexType","linkedLabel":"CanonicalizingRegexType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### canonicalizingTitleRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingtitleregex\} - - - - - -A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - - - - - - - - - -#### CanonicalizingRegexType \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingtitleregex+canonicalizingregextype\} - - - - - -Regular expression to apply to an arbitrary string to transform it into a canonical string. - - - - - - - - - -##### matchRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingtitleregex+canonicalizingregextype+matchregex\} - - - - - -Regular expression to match to an arbitrary string. - - - - - - - - - -##### rewriteRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingtitleregex+canonicalizingregextype+rewriteregex\} - - - - - -Regular expression to transform into a canonical string. - - - - - - - - - - - - - -CanonicalizingRegexType","children":[{"label":"CanonicalizingRegexType","linkedLabel":"CanonicalizingRegexType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### canonicalizingURLRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingurlregex\} - - - - - -A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - - - - - - - - - -#### CanonicalizingRegexType \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingurlregex+canonicalizingregextype\} - - - - - -Regular expression to apply to an arbitrary string to transform it into a canonical string. - - - - - - - - - -##### matchRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingurlregex+canonicalizingregextype+matchregex\} - - - - - -Regular expression to match to an arbitrary string. - - - - - - - - - -##### rewriteRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+canonicalizingurlregex+canonicalizingregextype+rewriteregex\} - - - - - -Regular expression to transform into a canonical string. - - - - - - - - - - - - - - - - - -##### connectorType \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - - - - - -##### crawlerSeedUrls \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+crawlerseedurls\} - - - - - -This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling. - - - - - - - - - -##### datasourceCategory \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+datasourcecategory\} - - - - - -The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - - - - - -_Default Value:_ `"UNCATEGORIZED"` - - - - - - - - - -##### displayName \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+displayname\} - - - - - -The user-friendly instance label to display. If omitted, falls back to the title-cased `name`. - - - - - - - - - -##### hideBuiltInFacets \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+hidebuiltinfacets\} - - - - - -List of built-in facet types that should be hidden for the datasource. - - - - - - - - - -##### homeUrl \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+homeurl\} - - - - - -The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page. - - - - - - - - - -##### iconDarkUrl \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+icondarkurl\} - - - - - -The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - - - - - - - - - -##### iconUrl \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+iconurl\} - - - - - -The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - - - - - - - - - -##### identityDatasourceName \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+identitydatasourcename\} - - - - - -If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already. - - - - - - - - - -##### includeUtmSource \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+includeutmsource\} - - - - - -If true, a utm_source query param will be added to outbound links to this datasource within Glean. - - - - - - - - - -##### isEntityDatasource \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+isentitydatasource\} - - - - - -True if this datasource is used to push custom entities. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### isOnPrem \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+isonprem\} - - - - - -Whether or not this datasource is hosted on-premise. - - - - - - - - - -##### isTestDatasource \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+istestdatasource\} - - - - - -True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### isUserReferencedByEmail \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+isuserreferencedbyemail\} - - - - - -whether email is used to reference users in document ACLs and in group memberships. - - - - - - - - - -##### name \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+name\} - - - - - -Unique identifier of datasource instance to which this config applies. - - - - - -ObjectDefinition","children":[{"label":"ObjectDefinition","linkedLabel":"ObjectDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### objectDefinitions \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions\} - - - - - -The list of top-level `objectType`s for the datasource. - - - - - - - - - -#### ObjectDefinition \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition\} - - - - - -The definition for an `DocumentMetadata.objectType` within a datasource. - - - - - - - - - -##### displayLabel \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+displaylabel\} - - - - - -The user-friendly name of the object for display. - - - - - - - - - -##### docCategory \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+doccategory\} - - - - - -The document category of this object type. - - - - - - - - - -##### name \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+name\} - - - - - -Unique identifier for this `DocumentMetadata.objectType`. If omitted, this definition is used as a default for all unmatched `DocumentMetadata.objectType`s in this datasource. - - - - - -PropertyDefinition","children":[{"label":"PropertyDefinition","linkedLabel":"PropertyDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### propertyDefinitions \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+propertydefinitions\} - - - - - - - - - - - - - - - - - - - -PropertyGroup","children":[{"label":"PropertyGroup","linkedLabel":"PropertyGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### propertyGroups \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+propertygroups\} - - - - - -A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI. - - - - - - - - - - - - - - - - - - - - - - - -##### summarizable \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+objectdefinitions+objectdefinition+summarizable\} - - - - - -Whether or not the object is summarizable - - - - - - - - - - - - - - - - - -##### productAccessGroup \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+productaccessgroup\} - - - - - -If the datasource uses a specific product access group, then the name of that group. - - - - - -Quicklink","children":[{"label":"Quicklink","linkedLabel":"Quicklink","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### quicklinks \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks\} - - - - - -List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira - - - - - - - - - -#### Quicklink \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink\} - - - - - -An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+id\} - - - - - -Unique identifier of this quicklink - - - - - - - - - -##### name \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+name\} - - - - - -Full action name. Used in autocomplete. - - - - - - - - - -##### scopes \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+scopes\} - - - - - -The scopes for which this quicklink is applicable - - - - - - - - - -##### shortName \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+shortname\} - - - - - -Shortened name. Used in app cards. - - - - - - - - - -##### url \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+quicklinks+quicklink+url\} - - - - - -The URL of the action. - - - - - - - - - - - - - - - - - -##### redlistTitleRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+redlisttitleregex\} - - - - - -A regex that identifies titles that should not be indexed - - - - - - - - - -##### renderConfigPreset \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+renderconfigpreset\} - - - - - -The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details - - - - - - - - - -##### stripFragmentInCanonicalUrl \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+stripfragmentincanonicalurl\} - - - - - -If true, the fragment part of the URL will be stripped when converting to a canonical url. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### suggestionText \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+suggestiontext\} - - - - - -Example text for what to search for in this datasource - - - - - - - - - -##### trustUrlRegexForViewActivity \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+trusturlregexforviewactivity\} - - - - - -True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### urlRegex \{#operation-post_api_index_v1_getdatasourceconfig+responses+200+application-json+urlregex\} - - - - - -Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.** - - - - - -_Example:_ - -``` -https://example-company.datasource.com/.* -``` - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/documents.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/documents.mdx deleted file mode 100644 index 7799548f2..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/documents.mdx +++ /dev/null @@ -1,5691 +0,0 @@ ---- -sidebar_position: 3.21 -sidebar_label: Indexing Documents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedauthor from "../../../../../src/components/glean-embeds/loaders/author.tsx"; -import Embedbody from "../../../../../src/components/glean-embeds/loaders/body.tsx"; -import Embedcomments from "../../../../../src/components/glean-embeds/loaders/comments.tsx"; -import Embedcustomproperties from "../../../../../src/components/glean-embeds/loaders/customproperties.tsx"; -import Embedinteractions from "../../../../../src/components/glean-embeds/loaders/interactions.tsx"; -import Embedowner from "../../../../../src/components/glean-embeds/loaders/owner.tsx"; -import Embedpermissions from "../../../../../src/components/glean-embeds/loaders/permissions.tsx"; -import Embedsummary from "../../../../../src/components/glean-embeds/loaders/summary.tsx"; -import Embedupdatedby from "../../../../../src/components/glean-embeds/loaders/updatedby.tsx"; -import Embedallowedgroupintersections from "../../../../../src/components/glean-embeds/loaders/allowedgroupintersections.tsx"; -import Embedallowedusers from "../../../../../src/components/glean-embeds/loaders/allowedusers.tsx"; -import Embeddebuginfo from "../../../../../src/components/glean-embeds/loaders/debuginfo.tsx"; - - - - - - - -# Indexing Documents Endpoints - - - - - - - - - -## POST /api/index/v1/indexdocument \{#operation-post_api_index_v1_indexdocument\} - - - - - -_Index document_ - - - - - -Adds a document to the index or updates an existing document. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexdocument \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "document": { - "datasource": "ipsum eiusmod" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexdocument+request-examples\} - - - - - -```json -{ - "document": { - "datasource": "ipsum eiusmod" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexdocument+request\} - - - - - - - -Describes the request body of the /indexdocument API call - - - - - -DocumentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document \{#operation-post_api_index_v1_indexdocument+request+document\} - - - - - -Indexable document structure - - - - - - - - - -#### DocumentDefinition \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition\} - - - - - -Indexable document structure - - - - - - - - - -##### additionalUrls \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+additionalurls\} - - - - - -Additional variations of the URL that this document points to. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+author\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### body \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+body\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - -CommentDefinition","children":[{"label":"CommentDefinition","linkedLabel":"CommentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### comments \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+comments\} - - - - - -Comments associated with the document. - - - - - - - - - - - - - - - - - - - - - - - -##### container \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+container\} - - - - - -The container name for the content (Folder for example for file content). - - - - - - - - - -##### containerDatasourceId \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+containerdatasourceid\} - - - - - -This represents the datasource sepcific id of the container. - - - - - - - - - -##### containerObjectType \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+containerobjecttype\} - - - - - -This represents the object type of the container. It cannot have spaces or _ - - - - - - - - - -##### createdAt \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+createdat\} - - - - - -The creation time, in epoch seconds. - - - - - -CustomProperty","children":[{"label":"CustomProperty","linkedLabel":"CustomProperty","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customProperties \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+customproperties\} - - - - - -Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+datasource\} - - - - - - - - - -##### filename \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+filename\} - - - - - -Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file. - - - - - - - - - -##### id \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+id\} - - - - - -The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - - - - - -DocumentInteractionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### interactions \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+interactions\} - - - - - -describes the interactions on the document - - - - - - - - - - - - - - - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+objecttype\} - - - - - -The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### owner \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+owner\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+permissions\} - - - - - -describes the access control details of the document - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+status\} - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### summary \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+summary\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - - - - - -##### tags \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+tags\} - - - - - -Labels associated with the document. - - - - - - - - - -##### title \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+title\} - - - - - -Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. - - - - - - - - - -##### updatedAt \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+updatedat\} - - - - - -The last update time, in epoch seconds. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+updatedby\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - - - - - -##### viewURL \{#operation-post_api_index_v1_indexdocument+request+document+documentdefinition+viewurl\} - - - - - -The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**' - - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexdocument+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/indexdocuments \{#operation-post_api_index_v1_indexdocuments\} - - - - - -_Index documents_ - - - - - -Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexdocuments \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "documents": [ - { - "datasource": "consequat do" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexdocuments+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "documents": [ - { - "datasource": "consequat do" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexdocuments+request\} - - - - - - - -Describes the request body of the /indexdocuments API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexdocuments+request+datasource\} - - - - - -Datasource of the documents - - - - - -DocumentDefinition","children":[{"label":"DocumentDefinition","linkedLabel":"DocumentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-post_api_index_v1_indexdocuments+request+documents\} - - - - - -Batch of documents being added/updated - - - - - - - - - -#### DocumentDefinition \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition\} - - - - - -Indexable document structure - - - - - - - - - -##### additionalUrls \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+additionalurls\} - - - - - -Additional variations of the URL that this document points to. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+author\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### body \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+body\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - -CommentDefinition","children":[{"label":"CommentDefinition","linkedLabel":"CommentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### comments \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+comments\} - - - - - -Comments associated with the document. - - - - - - - - - - - - - - - - - - - - - - - -##### container \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+container\} - - - - - -The container name for the content (Folder for example for file content). - - - - - - - - - -##### containerDatasourceId \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+containerdatasourceid\} - - - - - -This represents the datasource sepcific id of the container. - - - - - - - - - -##### containerObjectType \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+containerobjecttype\} - - - - - -This represents the object type of the container. It cannot have spaces or _ - - - - - - - - - -##### createdAt \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+createdat\} - - - - - -The creation time, in epoch seconds. - - - - - -CustomProperty","children":[{"label":"CustomProperty","linkedLabel":"CustomProperty","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customProperties \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+customproperties\} - - - - - -Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+datasource\} - - - - - - - - - -##### filename \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+filename\} - - - - - -Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file. - - - - - - - - - -##### id \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+id\} - - - - - -The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - - - - - -DocumentInteractionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### interactions \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+interactions\} - - - - - -describes the interactions on the document - - - - - - - - - - - - - - - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+objecttype\} - - - - - -The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### owner \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+owner\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+permissions\} - - - - - -describes the access control details of the document - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+status\} - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### summary \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+summary\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - - - - - -##### tags \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+tags\} - - - - - -Labels associated with the document. - - - - - - - - - -##### title \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+title\} - - - - - -Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. - - - - - - - - - -##### updatedAt \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+updatedat\} - - - - - -The last update time, in epoch seconds. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+updatedby\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - - - - - -##### viewURL \{#operation-post_api_index_v1_indexdocuments+request+documents+documentdefinition+viewurl\} - - - - - -The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**' - - - - - - - - - - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_indexdocuments+request+uploadid\} - - - - - -Optional id parameter to identify and track a batch of documents. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexdocuments \{#operation-post_api_index_v1_bulkindexdocuments\} - - - - - -_Bulk index documents_ - - - - - -Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexdocuments \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "documents": [ - { - "datasource": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexdocuments+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "documents": [ - { - "datasource": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexdocuments+request\} - - - - - - - -Describes the request body of the /bulkindexdocuments API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_bulkindexdocuments+request+datasource\} - - - - - -Datasource of the documents - - - - - - - - - -##### disableStaleDocumentDeletionCheck \{#operation-post_api_index_v1_bulkindexdocuments+request+disablestaledocumentdeletioncheck\} - - - - - -True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when `isLastPage = true` - - - - - -DocumentDefinition","children":[{"label":"DocumentDefinition","linkedLabel":"DocumentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#operation-post_api_index_v1_bulkindexdocuments+request+documents\} - - - - - -Batch of documents being added/updated - - - - - - - - - -#### DocumentDefinition \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition\} - - - - - -Indexable document structure - - - - - - - - - -##### additionalUrls \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+additionalurls\} - - - - - -Additional variations of the URL that this document points to. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+author\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### body \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+body\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - -CommentDefinition","children":[{"label":"CommentDefinition","linkedLabel":"CommentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### comments \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+comments\} - - - - - -Comments associated with the document. - - - - - - - - - - - - - - - - - - - - - - - -##### container \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+container\} - - - - - -The container name for the content (Folder for example for file content). - - - - - - - - - -##### containerDatasourceId \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+containerdatasourceid\} - - - - - -This represents the datasource sepcific id of the container. - - - - - - - - - -##### containerObjectType \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+containerobjecttype\} - - - - - -This represents the object type of the container. It cannot have spaces or _ - - - - - - - - - -##### createdAt \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+createdat\} - - - - - -The creation time, in epoch seconds. - - - - - -CustomProperty","children":[{"label":"CustomProperty","linkedLabel":"CustomProperty","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customProperties \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+customproperties\} - - - - - -Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+datasource\} - - - - - - - - - -##### filename \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+filename\} - - - - - -Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file. - - - - - - - - - -##### id \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+id\} - - - - - -The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - - - - - -DocumentInteractionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### interactions \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+interactions\} - - - - - -describes the interactions on the document - - - - - - - - - - - - - - - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+objecttype\} - - - - - -The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### owner \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+owner\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+permissions\} - - - - - -describes the access control details of the document - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+status\} - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### summary \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+summary\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - - - - - -##### tags \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+tags\} - - - - - -Labels associated with the document. - - - - - - - - - -##### title \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+title\} - - - - - -Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. - - - - - - - - - -##### updatedAt \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+updatedat\} - - - - - -The last update time, in epoch seconds. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+updatedby\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - - - - - -##### viewURL \{#operation-post_api_index_v1_bulkindexdocuments+request+documents+documentdefinition+viewurl\} - - - - - -The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**' - - - - - - - - - - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexdocuments+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexdocuments+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexdocuments+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexdocuments+request+uploadid\} - - - - - -Unique id that must be used for this bulk upload instance - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/processalldocuments \{#operation-post_api_index_v1_processalldocuments\} - - - - - -_Schedules the processing of uploaded documents_ - - - - - -Schedules the immediate processing of documents uploaded through the indexing API. By default the uploaded documents will be processed asynchronously but this API can be used to schedule processing of all documents on demand. - -If a `datasource` parameter is specified, processing is limited to that custom datasource. Without it, processing applies to all documents across all custom datasources. -#### Rate Limits -This endpoint is rate-limited to one usage every 3 hours. Exceeding this limit results in a 429 response code. Here's how the rate limit works: -1. Calling `/processalldocuments` for datasource `foo` prevents another call for `foo` for 3 hours. -2. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for `bar`. -3. Calling `/processalldocuments` for all datasources prevents any datasource calls for 3 hours. -4. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for all datasources. - -For more frequent document processing, contact Glean support. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/processalldocuments \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_processalldocuments+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_processalldocuments+request\} - - - - - - - -Describes the request body of the /processalldocuments API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_processalldocuments+request+datasource\} - - - - - -If provided, process documents only for this custom datasource. Otherwise all uploaded documents are processed. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/deletedocument \{#operation-post_api_index_v1_deletedocument\} - - - - - -_Delete document_ - - - - - -Deletes the specified document from the index. Succeeds if document is not present. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deletedocument \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "id": "consequat do", - "objectType": "reprehenderit ut dolore" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deletedocument+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "id": "consequat do", - "objectType": "reprehenderit ut dolore" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deletedocument+request\} - - - - - - - -Describes the request body of the /deletedocument API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_deletedocument+request+datasource\} - - - - - -datasource of the document - - - - - - - - - -##### id \{#operation-post_api_index_v1_deletedocument+request+id\} - - - - - -The id of the document - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_deletedocument+request+objecttype\} - - - - - -object type of the document - - - - - - - - - -##### version \{#operation-post_api_index_v1_deletedocument+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/debug/\{datasource\}/document \{#operation-post_api_index_v1_debug_datasource_document\} - - - - - -_Beta: Get document information -_ - - - - - -Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. - -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/debug/{datasource}/document \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "docId": "art123", - "objectType": "Article" -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-post_api_index_v1_debug_datasource_document+parameters\} - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_debug_datasource_document+parameters+datasource\} - - - - - -The datasource to which the document belongs - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_debug_datasource_document+request-examples\} - - - - - -```json -{ - "docId": "art123", - "objectType": "Article" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_debug_datasource_document+request\} - - - - - - - -Describes the request body of the /debug/\{datasource\}/document API call. - - - - - - - - - -##### docId \{#operation-post_api_index_v1_debug_datasource_document+request+docid\} - - - - - -Glean Document ID within the datasource to get the status for. - - - - - -_Example:_ - -``` -art123 -``` - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_debug_datasource_document+request+objecttype\} - - - - - -Object type of the document to get the status for. - - - - - -_Example:_ - -``` -Article -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_debug_datasource_document+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_debug_datasource_document+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DocumentStatusResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### status \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status\} - - - - - -Describes the document status response body - - - - - - - - - -#### DocumentStatusResponse \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse\} - - - - - -Describes the document status response body - - - - - - - - - -##### indexingStatus \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse+indexingstatus\} - - - - - -Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - - - - - -_Example:_ - -``` -INDEXED -``` - - - - - - - - - -##### lastIndexedAt \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse+lastindexedat\} - - - - - -Time of last successful indexing for the document, in ISO 8601 format - - - - - -_Example:_ - -``` -2021-08-06T17:58:01.000Z -``` - - - - - - - - - -##### lastUploadedAt \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse+lastuploadedat\} - - - - - -Time of last successful upload for the document, in ISO 8601 format - - - - - -_Example:_ - -``` -2021-08-06T17:58:01.000Z -``` - - - - - - - - - -##### permissionIdentityStatus \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse+permissionidentitystatus\} - - - - - -Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`. - - - - - -_Example:_ - -``` -UPLOADED -``` - - - - - - - - - -##### uploadStatus \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+status+documentstatusresponse+uploadstatus\} - - - - - -Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - - - - - -_Example:_ - -``` -UPLOADED -``` - - - - - - - - - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### uploadedPermissions \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions\} - - - - - -describes the access control details of the document - - - - - - - - - -#### DocumentPermissionsDefinition \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition\} - - - - - -describes the access control details of the document - - - - - - - - - -##### allowAllDatasourceUsersAccess \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition+allowalldatasourceusersaccess\} - - - - - -If true, then any user who has an account in the datasource can view the document. - - - - - - - - - -##### allowAnonymousAccess \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition+allowanonymousaccess\} - - - - - -If true, then any Glean user can view the document - - - - - -PermissionsGroupIntersectionDefinition","children":[{"label":"PermissionsGroupIntersectionDefinition","linkedLabel":"PermissionsGroupIntersectionDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedGroupIntersections \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition+allowedgroupintersections\} - - - - - -List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - - - - - - - - - - - - - - - - - - - - - - - -##### allowedGroups \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition+allowedgroups\} - - - - - -List of groups that can view the document - - - - - -UserReferenceDefinition","children":[{"label":"UserReferenceDefinition","linkedLabel":"UserReferenceDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedUsers \{#operation-post_api_index_v1_debug_datasource_document+responses+200+application-json; charset=utf-8+uploadedpermissions+documentpermissionsdefinition+allowedusers\} - - - - - -List of users who can view the document - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/debug/\{datasource\}/documents \{#operation-post_api_index_v1_debug_datasource_documents\} - - - - - -_Beta: Get information of a batch of documents -_ - - - - - -Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. - -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/debug/{datasource}/documents \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "debugDocuments": [ - { - "docId": "art123", - "objectType": "Article" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-post_api_index_v1_debug_datasource_documents+parameters\} - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_debug_datasource_documents+parameters+datasource\} - - - - - -The datasource to which the document belongs - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_debug_datasource_documents+request-examples\} - - - - - -```json -{ - "debugDocuments": [ - { - "docId": "art123", - "objectType": "Article" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_debug_datasource_documents+request\} - - - - - - - -Describes the request body of the /debug/\{datasource\}/documents API call. - - - - - -DebugDocumentRequest","children":[{"label":"DebugDocumentRequest","linkedLabel":"DebugDocumentRequest","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### debugDocuments \{#operation-post_api_index_v1_debug_datasource_documents+request+debugdocuments\} - - - - - -Documents to fetch debug information for - - - - - - - - - -#### DebugDocumentRequest \{#operation-post_api_index_v1_debug_datasource_documents+request+debugdocuments+debugdocumentrequest\} - - - - - -Describes the request body of the /debug/\{datasource\}/document API call. - - - - - - - - - -##### docId \{#operation-post_api_index_v1_debug_datasource_documents+request+debugdocuments+debugdocumentrequest+docid\} - - - - - -Glean Document ID within the datasource to get the status for. - - - - - -_Example:_ - -``` -art123 -``` - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_debug_datasource_documents+request+debugdocuments+debugdocumentrequest+objecttype\} - - - - - -Object type of the document to get the status for. - - - - - -_Example:_ - -``` -Article -``` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_debug_datasource_documents+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_debug_datasource_documents+responses\} - - - - - -200 - - - - - - - -OK - - - - - -DebugDocumentsResponseItem","children":[{"label":"DebugDocumentsResponseItem","linkedLabel":"DebugDocumentsResponseItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documentStatuses \{#operation-post_api_index_v1_debug_datasource_documents+responses+200+application-json; charset=utf-8+documentstatuses\} - - - - - -List of document ids/urls and their debug information - - - - - - - - - -#### DebugDocumentsResponseItem \{#operation-post_api_index_v1_debug_datasource_documents+responses+200+application-json; charset=utf-8+documentstatuses+debugdocumentsresponseitem\} - - - - - -Describes the response body of a single document in the /debug/\{datasource\}/documents API call - - - - - -DebugDocumentResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### debugInfo \{#operation-post_api_index_v1_debug_datasource_documents+responses+200+application-json; charset=utf-8+documentstatuses+debugdocumentsresponseitem+debuginfo\} - - - - - -Describes the response body of the /debug/\{datasource\}/document API call - - - - - - - - - - - - - - - - - - - - - - - -##### docId \{#operation-post_api_index_v1_debug_datasource_documents+responses+200+application-json; charset=utf-8+documentstatuses+debugdocumentsresponseitem+docid\} - - - - - -Id of the document - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_debug_datasource_documents+responses+200+application-json; charset=utf-8+documentstatuses+debugdocumentsresponseitem+objecttype\} - - - - - -objectType of the document - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/checkdocumentaccess \{#operation-post_api_index_v1_checkdocumentaccess\} - - - - - -_Check document access_ - - - - - -Check if a given user has access to access a document in a custom datasource - -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/checkdocumentaccess \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "docId": "consequat do", - "objectType": "reprehenderit ut dolore", - "userEmail": "occaecat dolor sit" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_checkdocumentaccess+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "docId": "consequat do", - "objectType": "reprehenderit ut dolore", - "userEmail": "occaecat dolor sit" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_checkdocumentaccess+request\} - - - - - - - -Describes the request body of the /checkdocumentaccess API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_checkdocumentaccess+request+datasource\} - - - - - -Datasource of document to check access for. - - - - - - - - - -##### docId \{#operation-post_api_index_v1_checkdocumentaccess+request+docid\} - - - - - -Glean Document ID to check access for. - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_checkdocumentaccess+request+objecttype\} - - - - - -Object type of document to check access for. - - - - - - - - - -##### userEmail \{#operation-post_api_index_v1_checkdocumentaccess+request+useremail\} - - - - - -Email of user to check access for. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_checkdocumentaccess+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_checkdocumentaccess+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### hasAccess \{#operation-post_api_index_v1_checkdocumentaccess+responses+200+application-json+hasaccess\} - - - - - -If true, user has access to document for search - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/getdocumentstatus \{#operation-post_api_index_v1_getdocumentstatus\} - - - - - -_Get document upload and indexing status_ - - - - - -Intended for debugging/validation. Fetches the current upload and indexing status of documents. - -Tip: Use [/debug/\{datasource\}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/getdocumentstatus \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "docId": "consequat do", - "objectType": "reprehenderit ut dolore" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_getdocumentstatus+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "docId": "consequat do", - "objectType": "reprehenderit ut dolore" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_getdocumentstatus+request\} - - - - - - - -Describes the request body for /getdocumentstatus API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_getdocumentstatus+request+datasource\} - - - - - -Datasource to get fetch document status for - - - - - - - - - -##### docId \{#operation-post_api_index_v1_getdocumentstatus+request+docid\} - - - - - -Glean Document ID within the datasource to get the status for. - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_getdocumentstatus+request+objecttype\} - - - - - -Object type of the document to get the status for - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_getdocumentstatus+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_getdocumentstatus+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### indexingStatus \{#operation-post_api_index_v1_getdocumentstatus+responses+200+application-json+indexingstatus\} - - - - - -Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - - - - - - - - - -##### lastIndexedAt \{#operation-post_api_index_v1_getdocumentstatus+responses+200+application-json+lastindexedat\} - - - - - -Time of last successful indexing, in epoch seconds - - - - - - - - - -##### lastUploadedAt \{#operation-post_api_index_v1_getdocumentstatus+responses+200+application-json+lastuploadedat\} - - - - - -Time of last successful upload, in epoch seconds - - - - - - - - - -##### uploadStatus \{#operation-post_api_index_v1_getdocumentstatus+responses+200+application-json+uploadstatus\} - - - - - -Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/getdocumentcount \{#operation-post_api_index_v1_getdocumentcount\} - - - - - -_Get document count_ - - - - - -Fetches document count for the specified custom datasource. - -Tip: Use [/debug/\{datasource\}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/getdocumentcount \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_getdocumentcount+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_getdocumentcount+request\} - - - - - - - -Describes the request body of the /getdocumentcount API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_getdocumentcount+request+datasource\} - - - - - -Datasource name for which document count is needed. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_getdocumentcount+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_getdocumentcount+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### documentCount \{#operation-post_api_index_v1_getdocumentcount+responses+200+application-json+documentcount\} - - - - - -Number of documents corresponding to the specified custom datasource. - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/people.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/people.mdx deleted file mode 100644 index 7d76ff230..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/people.mdx +++ /dev/null @@ -1,4636 +0,0 @@ ---- -sidebar_position: 3.22 -sidebar_label: Indexing People ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedadditionalfields from "../../../../../src/components/glean-embeds/loaders/additionalfields.tsx"; -import Embeddatasourceprofiles from "../../../../../src/components/glean-embeds/loaders/datasourceprofiles.tsx"; -import Embedrelationships from "../../../../../src/components/glean-embeds/loaders/relationships.tsx"; -import Embedsocialnetworks from "../../../../../src/components/glean-embeds/loaders/socialnetworks.tsx"; -import Embedstructuredlocation from "../../../../../src/components/glean-embeds/loaders/structuredlocation.tsx"; -import Embedteams from "../../../../../src/components/glean-embeds/loaders/teams.tsx"; -import Embedemails from "../../../../../src/components/glean-embeds/loaders/emails.tsx"; -import Embedmembers from "../../../../../src/components/glean-embeds/loaders/members.tsx"; - - - - - - - -# Indexing People Endpoints - - - - - - - - - -## POST /api/index/v1/debug/\{datasource\}/user \{#operation-post_api_index_v1_debug_datasource_user\} - - - - - -_Beta: Get user information -_ - - - - - -Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. - -Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/debug/{datasource}/user \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "email": "u1@foo.com" -}' -``` - - - - - - - - - - - -
    - - - -### Parameters \{#operation-post_api_index_v1_debug_datasource_user+parameters\} - - - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_debug_datasource_user+parameters+datasource\} - - - - - -The datasource to which the user belongs - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_debug_datasource_user+request-examples\} - - - - - -```json -{ - "email": "u1@foo.com" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_debug_datasource_user+request\} - - - - - - - -Describes the request body of the /debug/\{datasource\}/user API call - - - - - - - - - -##### email \{#operation-post_api_index_v1_debug_datasource_user+request+email\} - - - - - -Email ID of the user to get the status for - - - - - -_Example:_ - -``` -u1@foo.com -``` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_debug_datasource_user+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_debug_datasource_user+responses\} - - - - - -200 - - - - - - - -OK - - - - - -UserStatusResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### status \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+status\} - - - - - -Describes the user status response body - - - - - - - - - -#### UserStatusResponse \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+status+userstatusresponse\} - - - - - -Describes the user status response body - - - - - - - - - -##### isActiveUser \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+status+userstatusresponse+isactiveuser\} - - - - - -Whether the user is active or not - - - - - -_Example:_ - -``` -true -``` - - - - - - - - - -##### lastUploadedAt \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+status+userstatusresponse+lastuploadedat\} - - - - - -Time of last successful upload for the user, in ISO 8601 format - - - - - -_Example:_ - -``` -2021-08-06T17:58:01.000Z -``` - - - - - - - - - -##### uploadStatus \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+status+userstatusresponse+uploadstatus\} - - - - - -Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - - - - - -_Example:_ - -``` -UPLOADED -``` - - - - - - - - - - - - - -DatasourceGroupDefinition","children":[{"label":"DatasourceGroupDefinition","linkedLabel":"DatasourceGroupDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### uploadedGroups \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+uploadedgroups\} - - - - - -batch of groups for the datasource - - - - - - - - - -#### DatasourceGroupDefinition \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+uploadedgroups+datasourcegroupdefinition\} - - - - - -describes a group in the datasource - - - - - - - - - -##### name \{#operation-post_api_index_v1_debug_datasource_user+responses+200+application-json; charset=utf-8+uploadedgroups+datasourcegroupdefinition+name\} - - - - - -name of the group. Should be unique among all groups for the datasource, and cannot have spaces. - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/getusercount \{#operation-post_api_index_v1_getusercount\} - - - - - -_Get user count_ - - - - - -Fetches user count for the specified custom datasource. - -Tip: Use [/debug/\{datasource\}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/getusercount \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_getusercount+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_getusercount+request\} - - - - - - - -Describes the request body of the /getusercount API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_getusercount+request+datasource\} - - - - - -Datasource name for which user count is needed. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-post_api_index_v1_getusercount+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-post_api_index_v1_getusercount+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### userCount \{#operation-post_api_index_v1_getusercount+responses+200+application-json+usercount\} - - - - - -Number of users corresponding to the specified custom datasource. - - - - - - - - - - - - - -     - - - - - -## POST /api/index/v1/indexemployee \{#operation-post_api_index_v1_indexemployee\} - - - - - -_Index employee_ - - - - - -Adds an employee or updates information about an employee - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexemployee \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "employee": { - "department": "ipsum eiusmod", - "email": "consequat do" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexemployee+request-examples\} - - - - - -```json -{ - "employee": { - "department": "ipsum eiusmod", - "email": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexemployee+request\} - - - - - - - -Info about an employee and optional version for that info - - - - - -EmployeeInfoDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### employee \{#operation-post_api_index_v1_indexemployee+request+employee\} - - - - - -Describes employee info - - - - - - - - - -#### EmployeeInfoDefinition \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition\} - - - - - -Describes employee info - - - - - -AdditionalFieldDefinition","children":[{"label":"AdditionalFieldDefinition","linkedLabel":"AdditionalFieldDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalFields \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+additionalfields\} - - - - - -List of additional fields with more information about the employee. - - - - - - - - - - - - - - - - - - - - - - - -##### alsoKnownAs \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+alsoknownas\} - - - - - -Other names associated with the employee. - - - - - - - - - -##### bio \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+bio\} - - - - - -Short biography or mission statement of the employee. - - - - - - - - - -##### businessUnit \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### email \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+email\} - - - - - -The employee's email - - - - - - - - - -##### endDate \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+enddate\} - - - - - -If a former employee, the last date of employment. - - - - - - - - - -##### firstName \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+firstname\} - - - - - -The first name of the employee. **Note**: The value cannot be empty - - - - - - - - - - -##### id \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+id\} - - - - - -**[Advanced]** A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`. - - - - - - - - - - -##### lastName \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+lastname\} - - - - - -The last name of the employee. **Note**: The value cannot be empty - - - - - - - - - - -##### location \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+location\} - - - - - -The employee's location (city/office name etc). - - - - - - - - - -##### managerEmail \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+manageremail\} - - - - - -The email of the employee's manager - - - - - - - - - -##### managerId \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+managerid\} - - - - - -**[Advanced]** A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`. - - - - - - - - - - -##### phoneNumber \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+phonenumber\} - - - - - -The employee's phone number. - - - - - - - - - -##### photoUrl \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+photourl\} - - - - - -The employee's profile pic - - - - - - - - - -##### preferredName \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+preferredname\} - - - - - -The preferred name or nickname of the employee - - - - - - - - - -##### profileUrl \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+profileurl\} - - - - - -Link to internal company person profile. - - - - - - - - - -##### pronoun \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+pronoun\} - - - - - -She/her, He/his or other pronoun. - - - - - -EntityRelationship","children":[{"label":"EntityRelationship","linkedLabel":"EntityRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relationships \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+relationships\} - - - - - -List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile. - - - - - - - - - - - - - - - - - - - -SocialNetworkDefinition","children":[{"label":"SocialNetworkDefinition","linkedLabel":"SocialNetworkDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### socialNetworks \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+socialnetworks\} - - - - - -List of social network profiles. - - - - - - - - - - - - - - - - - - - - - - - -##### startDate \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+startdate\} - - - - - -The date when the employee started - - - - - - - - - -##### status \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+status\} - - - - - -The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` - - - - - -_Default Value:_ `"CURRENT"` - - - - - -StructuredLocation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredLocation \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+structuredlocation\} - - - - - -Detailed location with information about country, state, city etc. - - - - - - - - - - - - - - - - - - - -EmployeeTeamInfo","children":[{"label":"EmployeeTeamInfo","linkedLabel":"EmployeeTeamInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### teams \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+teams\} - - - - - -Info about the employee's team(s) - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+title\} - - - - - -The employee's role title. - - - - - - - - - -##### type \{#operation-post_api_index_v1_indexemployee+request+employee+employeeinfodefinition+type\} - - - - - -The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE` - - - - - -_Default Value:_ `"FULL_TIME"` - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexemployee+request+version\} - - - - - -Version number for the employee object. If absent or 0 then no version checks are done - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexemployees \{#operation-post_api_index_v1_bulkindexemployees\} - - - - - -_Bulk index employees_ - - - - - -Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexemployees \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "employees": [ - { - "department": "ipsum eiusmod", - "email": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexemployees+request-examples\} - - - - - -```json -{ - "employees": [ - { - "department": "ipsum eiusmod", - "email": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexemployees+request\} - - - - - - - -Describes the request body of the /bulkindexemployees API call - - - - - - - - - -##### disableStaleDataDeletionCheck \{#operation-post_api_index_v1_bulkindexemployees+request+disablestaledatadeletioncheck\} - - - - - -True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when `isLastPage = true` - - - - - -EmployeeInfoDefinition","children":[{"label":"EmployeeInfoDefinition","linkedLabel":"EmployeeInfoDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### employees \{#operation-post_api_index_v1_bulkindexemployees+request+employees\} - - - - - -Batch of employee information - - - - - - - - - -#### EmployeeInfoDefinition \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition\} - - - - - -Describes employee info - - - - - -AdditionalFieldDefinition","children":[{"label":"AdditionalFieldDefinition","linkedLabel":"AdditionalFieldDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalFields \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+additionalfields\} - - - - - -List of additional fields with more information about the employee. - - - - - - - - - - - - - - - - - - - - - - - -##### alsoKnownAs \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+alsoknownas\} - - - - - -Other names associated with the employee. - - - - - - - - - -##### bio \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+bio\} - - - - - -Short biography or mission statement of the employee. - - - - - - - - - -##### businessUnit \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### email \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+email\} - - - - - -The employee's email - - - - - - - - - -##### endDate \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+enddate\} - - - - - -If a former employee, the last date of employment. - - - - - - - - - -##### firstName \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+firstname\} - - - - - -The first name of the employee. **Note**: The value cannot be empty - - - - - - - - - - -##### id \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+id\} - - - - - -**[Advanced]** A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`. - - - - - - - - - - -##### lastName \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+lastname\} - - - - - -The last name of the employee. **Note**: The value cannot be empty - - - - - - - - - - -##### location \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+location\} - - - - - -The employee's location (city/office name etc). - - - - - - - - - -##### managerEmail \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+manageremail\} - - - - - -The email of the employee's manager - - - - - - - - - -##### managerId \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+managerid\} - - - - - -**[Advanced]** A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`. - - - - - - - - - - -##### phoneNumber \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+phonenumber\} - - - - - -The employee's phone number. - - - - - - - - - -##### photoUrl \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+photourl\} - - - - - -The employee's profile pic - - - - - - - - - -##### preferredName \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+preferredname\} - - - - - -The preferred name or nickname of the employee - - - - - - - - - -##### profileUrl \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+profileurl\} - - - - - -Link to internal company person profile. - - - - - - - - - -##### pronoun \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+pronoun\} - - - - - -She/her, He/his or other pronoun. - - - - - -EntityRelationship","children":[{"label":"EntityRelationship","linkedLabel":"EntityRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relationships \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+relationships\} - - - - - -List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile. - - - - - - - - - - - - - - - - - - - -SocialNetworkDefinition","children":[{"label":"SocialNetworkDefinition","linkedLabel":"SocialNetworkDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### socialNetworks \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+socialnetworks\} - - - - - -List of social network profiles. - - - - - - - - - - - - - - - - - - - - - - - -##### startDate \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+startdate\} - - - - - -The date when the employee started - - - - - - - - - -##### status \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+status\} - - - - - -The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` - - - - - -_Default Value:_ `"CURRENT"` - - - - - -StructuredLocation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredLocation \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+structuredlocation\} - - - - - -Detailed location with information about country, state, city etc. - - - - - - - - - - - - - - - - - - - -EmployeeTeamInfo","children":[{"label":"EmployeeTeamInfo","linkedLabel":"EmployeeTeamInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### teams \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+teams\} - - - - - -Info about the employee's team(s) - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+title\} - - - - - -The employee's role title. - - - - - - - - - -##### type \{#operation-post_api_index_v1_bulkindexemployees+request+employees+employeeinfodefinition+type\} - - - - - -The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE` - - - - - -_Default Value:_ `"FULL_TIME"` - - - - - - - - - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexemployees+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexemployees+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexemployees+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexemployees+request+uploadid\} - - - - - -Unique id that must be used for this bulk upload instance - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/processallemployeesandteams \{#operation-post_api_index_v1_processallemployeesandteams\} - - - - - -_Schedules the processing of uploaded employees and teams_ - - - - - -Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/processallemployeesandteams \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' -``` - - - - - - - - - - - - - - - -## POST /api/index/v1/deleteemployee \{#operation-post_api_index_v1_deleteemployee\} - - - - - -_Delete employee_ - - - - - -Delete an employee. Silently succeeds if employee is not present. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deleteemployee \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "employeeEmail": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deleteemployee+request-examples\} - - - - - -```json -{ - "employeeEmail": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deleteemployee+request\} - - - - - - - -Describes the request body of the /deleteemployee API call - - - - - - - - - -##### employeeEmail \{#operation-post_api_index_v1_deleteemployee+request+employeeemail\} - - - - - -The deleted employee's email - - - - - - - - - -##### version \{#operation-post_api_index_v1_deleteemployee+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/indexteam \{#operation-post_api_index_v1_indexteam\} - - - - - -_Index team_ - - - - - -Adds a team or updates information about a team - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexteam \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "team": { - "id": "ipsum eiusmod", - "members": [ - { - "email": "consequat do" - } - ], - "name": "reprehenderit ut dolore" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexteam+request-examples\} - - - - - -```json -{ - "team": { - "id": "ipsum eiusmod", - "members": [ - { - "email": "consequat do" - } - ], - "name": "reprehenderit ut dolore" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexteam+request\} - - - - - - - -Info about a team and optional version for that info - - - - - -TeamInfoDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### team \{#operation-post_api_index_v1_indexteam+request+team\} - - - - - -Information about an employee's team - - - - - - - - - -#### TeamInfoDefinition \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition\} - - - - - -Information about an employee's team - - - - - -AdditionalFieldDefinition","children":[{"label":"AdditionalFieldDefinition","linkedLabel":"AdditionalFieldDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalFields \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+additionalfields\} - - - - - -List of additional fields with more information about the employee. - - - - - - - - - - - - - - - - - - - - - - - -##### businessUnit \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### description \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+description\} - - - - - -The description of this team - - - - - -TeamEmail","children":[{"label":"TeamEmail","linkedLabel":"TeamEmail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### emails \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+emails\} - - - - - -The emails for this team - - - - - - - - - - - - - - - - - - - - - - - -##### externalLink \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+externallink\} - - - - - -A link to an external team page. If set, team results will link to it. - - - - - - - - - - -##### id \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+id\} - - - - - -The unique ID of the team - - - - - -TeamMember","children":[{"label":"TeamMember","linkedLabel":"TeamMember","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### members \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+members\} - - - - - -The members of the team - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+name\} - - - - - -Human-readable team name - - - - - - - - - -##### photoUrl \{#operation-post_api_index_v1_indexteam+request+team+teaminfodefinition+photourl\} - - - - - -A link to the team's photo - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexteam+request+version\} - - - - - -Version number for the team object. If absent or 0 then no version checks are done - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/deleteteam \{#operation-post_api_index_v1_deleteteam\} - - - - - -_Delete team_ - - - - - -Delete a team based on provided id. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deleteteam \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "id": "ipsum eiusmod" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deleteteam+request-examples\} - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deleteteam+request\} - - - - - - - -Describes the request body of the /deleteteam API call - - - - - - - - - -##### id \{#operation-post_api_index_v1_deleteteam+request+id\} - - - - - -The deleted team's id - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexteams \{#operation-post_api_index_v1_bulkindexteams\} - - - - - -_Bulk index teams_ - - - - - -Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexteams \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "teams": [ - { - "id": "ipsum eiusmod", - "members": [ - { - "email": "consequat do" - } - ], - "name": "reprehenderit ut dolore" - } - ], - "uploadId": "occaecat dolor sit" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexteams+request-examples\} - - - - - -```json -{ - "teams": [ - { - "id": "ipsum eiusmod", - "members": [ - { - "email": "consequat do" - } - ], - "name": "reprehenderit ut dolore" - } - ], - "uploadId": "occaecat dolor sit" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexteams+request\} - - - - - - - -Describes the request body of the /bulkindexteams API call - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexteams+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexteams+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexteams+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - -TeamInfoDefinition","children":[{"label":"TeamInfoDefinition","linkedLabel":"TeamInfoDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### teams \{#operation-post_api_index_v1_bulkindexteams+request+teams\} - - - - - -Batch of team information - - - - - - - - - -#### TeamInfoDefinition \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition\} - - - - - -Information about an employee's team - - - - - -AdditionalFieldDefinition","children":[{"label":"AdditionalFieldDefinition","linkedLabel":"AdditionalFieldDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### additionalFields \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+additionalfields\} - - - - - -List of additional fields with more information about the employee. - - - - - - - - - - - - - - - - - - - - - - - -##### businessUnit \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### description \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+description\} - - - - - -The description of this team - - - - - -TeamEmail","children":[{"label":"TeamEmail","linkedLabel":"TeamEmail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### emails \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+emails\} - - - - - -The emails for this team - - - - - - - - - - - - - - - - - - - - - - - -##### externalLink \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+externallink\} - - - - - -A link to an external team page. If set, team results will link to it. - - - - - - - - - - -##### id \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+id\} - - - - - -The unique ID of the team - - - - - -TeamMember","children":[{"label":"TeamMember","linkedLabel":"TeamMember","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### members \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+members\} - - - - - -The members of the team - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+name\} - - - - - -Human-readable team name - - - - - - - - - -##### photoUrl \{#operation-post_api_index_v1_bulkindexteams+request+teams+teaminfodefinition+photourl\} - - - - - -A link to the team's photo - - - - - - - - - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexteams+request+uploadid\} - - - - - -Unique id that must be used for this bulk upload instance - - - - - - - - - -
    - -     - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/permissions.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/permissions.mdx deleted file mode 100644 index 4bbcdf12b..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/permissions.mdx +++ /dev/null @@ -1,3697 +0,0 @@ ---- -sidebar_position: 3.23 -sidebar_label: Indexing Permissions ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - Embed, - EmbedProvider, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; -import Embedallowedgroupintersections from "../../../../../src/components/glean-embeds/loaders/allowedgroupintersections.tsx"; -import Embedallowedusers from "../../../../../src/components/glean-embeds/loaders/allowedusers.tsx"; - - - - - - - -# Indexing Permissions Endpoints - - - - - - - - - -## POST /api/index/v1/updatepermissions \{#operation-post_api_index_v1_updatepermissions\} - - - - - -_Update document permissions_ - - - - - -Updates the permissions for a given document without modifying document content. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/updatepermissions \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "permissions": {} -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_updatepermissions+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "permissions": {} -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_updatepermissions+request\} - - - - - - - -Describes the request body of the /updatepermissions API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_updatepermissions+request+datasource\} - - - - - - - - - -##### id \{#operation-post_api_index_v1_updatepermissions+request+id\} - - - - - -The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - - - - - - - - - -##### objectType \{#operation-post_api_index_v1_updatepermissions+request+objecttype\} - - - - - -The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#operation-post_api_index_v1_updatepermissions+request+permissions\} - - - - - -describes the access control details of the document - - - - - - - - - -#### DocumentPermissionsDefinition \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition\} - - - - - -describes the access control details of the document - - - - - - - - - -##### allowAllDatasourceUsersAccess \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition+allowalldatasourceusersaccess\} - - - - - -If true, then any user who has an account in the datasource can view the document. - - - - - - - - - -##### allowAnonymousAccess \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition+allowanonymousaccess\} - - - - - -If true, then any Glean user can view the document - - - - - -PermissionsGroupIntersectionDefinition","children":[{"label":"PermissionsGroupIntersectionDefinition","linkedLabel":"PermissionsGroupIntersectionDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedGroupIntersections \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition+allowedgroupintersections\} - - - - - -List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - - - - - - - - - - - - - - - - - - - - - - - -##### allowedGroups \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition+allowedgroups\} - - - - - -List of groups that can view the document - - - - - -UserReferenceDefinition","children":[{"label":"UserReferenceDefinition","linkedLabel":"UserReferenceDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedUsers \{#operation-post_api_index_v1_updatepermissions+request+permissions+documentpermissionsdefinition+allowedusers\} - - - - - -List of users who can view the document - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### viewURL \{#operation-post_api_index_v1_updatepermissions+request+viewurl\} - - - - - -The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**' - - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/indexuser \{#operation-post_api_index_v1_indexuser\} - - - - - -_Index user_ - - - - - -Adds a datasource user or updates an existing user. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexuser \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "user": { - "email": "consequat do", - "name": "reprehenderit ut dolore" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexuser+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "user": { - "email": "consequat do", - "name": "reprehenderit ut dolore" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexuser+request\} - - - - - - - -Describes the request body of the /indexuser API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexuser+request+datasource\} - - - - - -The datasource for which the user is added - - - - - -DatasourceUserDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### user \{#operation-post_api_index_v1_indexuser+request+user\} - - - - - -describes a user in the datasource - - - - - - - - - -#### DatasourceUserDefinition \{#operation-post_api_index_v1_indexuser+request+user+datasourceuserdefinition\} - - - - - -describes a user in the datasource - - - - - - - - - -##### email \{#operation-post_api_index_v1_indexuser+request+user+datasourceuserdefinition+email\} - - - - - - - - - -##### isActive \{#operation-post_api_index_v1_indexuser+request+user+datasourceuserdefinition+isactive\} - - - - - -set to false if the user is a former employee or a bot - - - - - - - - - -##### name \{#operation-post_api_index_v1_indexuser+request+user+datasourceuserdefinition+name\} - - - - - - - - - -##### userId \{#operation-post_api_index_v1_indexuser+request+user+datasourceuserdefinition+userid\} - - - - - -To be supplied if the user id in the datasource is not the email - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexuser+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexusers \{#operation-post_api_index_v1_bulkindexusers\} - - - - - -_Bulk index users_ - - - - - -Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexusers \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "uploadId": "consequat do", - "users": [ - { - "email": "reprehenderit ut dolore", - "name": "occaecat dolor sit" - } - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexusers+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "uploadId": "consequat do", - "users": [ - { - "email": "reprehenderit ut dolore", - "name": "occaecat dolor sit" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexusers+request\} - - - - - - - -Describes the request body for the /bulkindexusers API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_bulkindexusers+request+datasource\} - - - - - -datasource of the users - - - - - - - - - -##### disableStaleDataDeletionCheck \{#operation-post_api_index_v1_bulkindexusers+request+disablestaledatadeletioncheck\} - - - - - -True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexusers+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexusers+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexusers+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexusers+request+uploadid\} - - - - - -Unique id that must be used for this instance of datasource users upload - - - - - -DatasourceUserDefinition","children":[{"label":"DatasourceUserDefinition","linkedLabel":"DatasourceUserDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### users \{#operation-post_api_index_v1_bulkindexusers+request+users\} - - - - - -batch of users for the datasource - - - - - - - - - -#### DatasourceUserDefinition \{#operation-post_api_index_v1_bulkindexusers+request+users+datasourceuserdefinition\} - - - - - -describes a user in the datasource - - - - - - - - - -##### email \{#operation-post_api_index_v1_bulkindexusers+request+users+datasourceuserdefinition+email\} - - - - - - - - - -##### isActive \{#operation-post_api_index_v1_bulkindexusers+request+users+datasourceuserdefinition+isactive\} - - - - - -set to false if the user is a former employee or a bot - - - - - - - - - -##### name \{#operation-post_api_index_v1_bulkindexusers+request+users+datasourceuserdefinition+name\} - - - - - - - - - -##### userId \{#operation-post_api_index_v1_bulkindexusers+request+users+datasourceuserdefinition+userid\} - - - - - -To be supplied if the user id in the datasource is not the email - - - - - - - - - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/indexgroup \{#operation-post_api_index_v1_indexgroup\} - - - - - -_Index group_ - - - - - -Add or update a group in the datasource. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexgroup \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "group": { - "name": "consequat do" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexgroup+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "group": { - "name": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexgroup+request\} - - - - - - - -Describes the request body of the /indexgroup API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexgroup+request+datasource\} - - - - - -The datasource for which the group is added - - - - - -DatasourceGroupDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### group \{#operation-post_api_index_v1_indexgroup+request+group\} - - - - - -describes a group in the datasource - - - - - - - - - -#### DatasourceGroupDefinition \{#operation-post_api_index_v1_indexgroup+request+group+datasourcegroupdefinition\} - - - - - -describes a group in the datasource - - - - - - - - - -##### name \{#operation-post_api_index_v1_indexgroup+request+group+datasourcegroupdefinition+name\} - - - - - -name of the group. Should be unique among all groups for the datasource, and cannot have spaces. - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexgroup+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexgroups \{#operation-post_api_index_v1_bulkindexgroups\} - - - - - -_Bulk index groups_ - - - - - -Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexgroups \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "groups": [ - { - "name": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexgroups+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "groups": [ - { - "name": "consequat do" - } - ], - "uploadId": "reprehenderit ut dolore" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexgroups+request\} - - - - - - - -Describes the request body for the /bulkindexgroups API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_bulkindexgroups+request+datasource\} - - - - - -datasource of the groups - - - - - - - - - -##### disableStaleDataDeletionCheck \{#operation-post_api_index_v1_bulkindexgroups+request+disablestaledatadeletioncheck\} - - - - - -True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexgroups+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - -DatasourceGroupDefinition","children":[{"label":"DatasourceGroupDefinition","linkedLabel":"DatasourceGroupDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### groups \{#operation-post_api_index_v1_bulkindexgroups+request+groups\} - - - - - -batch of groups for the datasource - - - - - - - - - -#### DatasourceGroupDefinition \{#operation-post_api_index_v1_bulkindexgroups+request+groups+datasourcegroupdefinition\} - - - - - -describes a group in the datasource - - - - - - - - - -##### name \{#operation-post_api_index_v1_bulkindexgroups+request+groups+datasourcegroupdefinition+name\} - - - - - -name of the group. Should be unique among all groups for the datasource, and cannot have spaces. - - - - - - - - - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexgroups+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexgroups+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexgroups+request+uploadid\} - - - - - -Unique id that must be used for this instance of datasource groups upload - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/indexmembership \{#operation-post_api_index_v1_indexmembership\} - - - - - -_Index membership_ - - - - - -Add the memberships of a group in the datasource. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/indexmembership \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "membership": { - "groupName": "consequat do" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_indexmembership+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "membership": { - "groupName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_indexmembership+request\} - - - - - - - -Describes the request body of the /indexmembership API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_indexmembership+request+datasource\} - - - - - -The datasource for which the membership is added - - - - - -DatasourceMembershipDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### membership \{#operation-post_api_index_v1_indexmembership+request+membership\} - - - - - -describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - - - - - - - - - -#### DatasourceMembershipDefinition \{#operation-post_api_index_v1_indexmembership+request+membership+datasourcemembershipdefinition\} - - - - - -describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - - - - - - - - - -##### groupName \{#operation-post_api_index_v1_indexmembership+request+membership+datasourcemembershipdefinition+groupname\} - - - - - -The group for which the membership is specified - - - - - - - - - -##### memberGroupName \{#operation-post_api_index_v1_indexmembership+request+membership+datasourcemembershipdefinition+membergroupname\} - - - - - -If the member is a group, then the name of the member group - - - - - - - - - -##### memberUserId \{#operation-post_api_index_v1_indexmembership+request+membership+datasourcemembershipdefinition+memberuserid\} - - - - - -If the member is a user, then the email or datasource id for the user - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_indexmembership+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/bulkindexmemberships \{#operation-post_api_index_v1_bulkindexmemberships\} - - - - - -_Bulk index memberships for a group_ - - - - - -Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexmemberships \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "memberships": [ - {} - ], - "uploadId": "consequat do" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexmemberships+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "memberships": [ - {} - ], - "uploadId": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexmemberships+request\} - - - - - - - -Describes the request body for the /bulkindexmemberships API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_bulkindexmemberships+request+datasource\} - - - - - -datasource of the memberships - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexmemberships+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### group \{#operation-post_api_index_v1_bulkindexmemberships+request+group\} - - - - - -group who's memberships are specified - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexmemberships+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexmemberships+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - -DatasourceBulkMembershipDefinition","children":[{"label":"DatasourceBulkMembershipDefinition","linkedLabel":"DatasourceBulkMembershipDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### memberships \{#operation-post_api_index_v1_bulkindexmemberships+request+memberships\} - - - - - -batch of memberships for the group - - - - - - - - - -#### DatasourceBulkMembershipDefinition \{#operation-post_api_index_v1_bulkindexmemberships+request+memberships+datasourcebulkmembershipdefinition\} - - - - - -describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified. - - - - - - - - - -##### memberGroupName \{#operation-post_api_index_v1_bulkindexmemberships+request+memberships+datasourcebulkmembershipdefinition+membergroupname\} - - - - - -If the member is a group, then the name of the member group - - - - - - - - - -##### memberUserId \{#operation-post_api_index_v1_bulkindexmemberships+request+memberships+datasourcebulkmembershipdefinition+memberuserid\} - - - - - -If the member is a user, then the email or datasource id for the user - - - - - - - - - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexmemberships+request+uploadid\} - - - - - -Unique id that must be used for this instance of datasource group memberships upload - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/processallmemberships \{#operation-post_api_index_v1_processallmemberships\} - - - - - -_Schedules the processing of group memberships_ - - - - - -Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand. - - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/processallmemberships \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_processallmemberships+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_processallmemberships+request\} - - - - - - - -Describes the request body of the /processallmemberships API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_processallmemberships+request+datasource\} - - - - - -If provided, process group memberships only for this custom datasource. Otherwise all uploaded memberships are processed. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/deleteuser \{#operation-post_api_index_v1_deleteuser\} - - - - - -_Delete user_ - - - - - -Delete the user from the datasource. Silently succeeds if user is not present. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deleteuser \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "email": "consequat do" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deleteuser+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "email": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deleteuser+request\} - - - - - - - -Describes the request body of the /deleteuser API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_deleteuser+request+datasource\} - - - - - -The datasource for which the user is removed - - - - - - - - - -##### email \{#operation-post_api_index_v1_deleteuser+request+email\} - - - - - -The email of the user to be deleted - - - - - - - - - -##### version \{#operation-post_api_index_v1_deleteuser+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/deletegroup \{#operation-post_api_index_v1_deletegroup\} - - - - - -_Delete group_ - - - - - -Delete group from the datasource. Silently succeeds if group is not present. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deletegroup \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "groupName": "consequat do" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deletegroup+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "groupName": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deletegroup+request\} - - - - - - - -Describes the request body of the /deletegroup API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_deletegroup+request+datasource\} - - - - - -The datasource for which the group is removed - - - - - - - - - -##### groupName \{#operation-post_api_index_v1_deletegroup+request+groupname\} - - - - - -the name of the group to be deleted - - - - - - - - - -##### version \{#operation-post_api_index_v1_deletegroup+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/deletemembership \{#operation-post_api_index_v1_deletemembership\} - - - - - -_Delete membership_ - - - - - -Delete membership to a group in the specified datasource. Silently succeeds if membership is not present. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/deletemembership \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "membership": { - "groupName": "consequat do" - } -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_deletemembership+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "membership": { - "groupName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_deletemembership+request\} - - - - - - - -Describes the request body of the /deletemembership API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_deletemembership+request+datasource\} - - - - - -The datasource for which the membership is removed - - - - - -DatasourceMembershipDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### membership \{#operation-post_api_index_v1_deletemembership+request+membership\} - - - - - -describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - - - - - - - - - -#### DatasourceMembershipDefinition \{#operation-post_api_index_v1_deletemembership+request+membership+datasourcemembershipdefinition\} - - - - - -describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - - - - - - - - - -##### groupName \{#operation-post_api_index_v1_deletemembership+request+membership+datasourcemembershipdefinition+groupname\} - - - - - -The group for which the membership is specified - - - - - - - - - -##### memberGroupName \{#operation-post_api_index_v1_deletemembership+request+membership+datasourcemembershipdefinition+membergroupname\} - - - - - -If the member is a group, then the name of the member group - - - - - - - - - -##### memberUserId \{#operation-post_api_index_v1_deletemembership+request+membership+datasourcemembershipdefinition+memberuserid\} - - - - - -If the member is a user, then the email or datasource id for the user - - - - - - - - - - - - - - - - - -##### version \{#operation-post_api_index_v1_deletemembership+request+version\} - - - - - -Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/betausers \{#operation-post_api_index_v1_betausers\} - - - - - -_Beta users_ - - - - - -Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/betausers \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "datasource": "ipsum eiusmod", - "emails": [ - "consequat do" - ] -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_betausers+request-examples\} - - - - - -```json -{ - "datasource": "ipsum eiusmod", - "emails": [ - "consequat do" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_betausers+request\} - - - - - - - -Describes the request body of the /betausers API call - - - - - - - - - -##### datasource \{#operation-post_api_index_v1_betausers+request+datasource\} - - - - - -Datasource which needs to be made visible to users specified in the `emails` field. - - - - - - - - - -##### emails \{#operation-post_api_index_v1_betausers+request+emails\} - - - - - -The emails of the beta users - - - - - - - - - -
    - -     - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/endpoint/indexing/shortcuts.mdx b/examples/docusaurus/docs/glean/api/endpoint/indexing/shortcuts.mdx deleted file mode 100644 index ce337fbe8..000000000 --- a/examples/docusaurus/docs/glean/api/endpoint/indexing/shortcuts.mdx +++ /dev/null @@ -1,1137 +0,0 @@ ---- -sidebar_position: 3.24 -sidebar_label: Indexing Shortcuts ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Indexing Shortcuts Endpoints - - - - - - - - - -## POST /api/index/v1/bulkindexshortcuts \{#operation-post_api_index_v1_bulkindexshortcuts\} - - - - - -_Bulk index external shortcuts_ - - - - - -Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the `/uploadshortcuts` endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to [this](https://help.glean.com/en/articles/5628838-how-go-links-work) page. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/bulkindexshortcuts \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "shortcuts": [ - { - "createdBy": "ipsum eiusmod", - "destinationUrl": "consequat do", - "inputAlias": "reprehenderit ut dolore", - "intermediateUrl": "occaecat dolor sit" - } - ], - "uploadId": "nostrud" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_bulkindexshortcuts+request-examples\} - - - - - -```json -{ - "shortcuts": [ - { - "createdBy": "ipsum eiusmod", - "destinationUrl": "consequat do", - "inputAlias": "reprehenderit ut dolore", - "intermediateUrl": "occaecat dolor sit" - } - ], - "uploadId": "nostrud" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_bulkindexshortcuts+request\} - - - - - - - -Describes the request body of the /bulkindexshortcuts API call - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_bulkindexshortcuts+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_bulkindexshortcuts+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_bulkindexshortcuts+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - -ExternalShortcut","children":[{"label":"ExternalShortcut","linkedLabel":"ExternalShortcut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcuts \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts\} - - - - - -Batch of shortcuts information - - - - - - - - - -#### ExternalShortcut \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut\} - - - - - - - - - -##### createTime \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+createtime\} - - - - - -The time the shortcut was created in epoch seconds. - - - - - - - - - -##### createdBy \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+createdby\} - - - - - -Email of the user who created this shortcut. - - - - - - - - - -##### decayedVisitScore \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+decayedvisitscore\} - - - - - -decayed visits score for ranking - - - - - - - - - -##### description \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - - - - - -##### destinationUrl \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+destinationurl\} - - - - - -destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### inputAlias \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+inputalias\} - - - - - -link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias. - - - - - - - - - -##### intermediateUrl \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. - - - - - - - - - -##### title \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+title\} - - - - - -Title of the golink - - - - - - - - - -##### updateTime \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+updatetime\} - - - - - -The time the shortcut was updated in epoch seconds. - - - - - - - - - -##### updatedBy \{#operation-post_api_index_v1_bulkindexshortcuts+request+shortcuts+externalshortcut+updatedby\} - - - - - -Email of the user who last updated this shortcut. - - - - - - - - - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_bulkindexshortcuts+request+uploadid\} - - - - - -Unique id that must be used for this bulk upload instance - - - - - - - - - -
    - -     - -     - - - - - -## POST /api/index/v1/uploadshortcuts \{#operation-post_api_index_v1_uploadshortcuts\} - - - - - -_Upload shortcuts_ - - - - - -Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded. - - - - - - - - - -TypeScript - - - - - - - - - - - -cURL - - - - - - - -```curl -curl https://{instance}-be.glean.com/api/index/v1/uploadshortcuts \ - -X POST \ - -H 'Authorization: Bearer YOUR_APITOKEN_HERE' \ - -d '{ - "shortcuts": [ - { - "createdBy": "ipsum eiusmod", - "destinationUrl": "consequat do", - "inputAlias": "reprehenderit ut dolore" - } - ], - "uploadId": "occaecat dolor sit" -}' -``` - - - - - - - - - - - -
    - - - -### Request Example \{#operation-post_api_index_v1_uploadshortcuts+request-examples\} - - - - - -```json -{ - "shortcuts": [ - { - "createdBy": "ipsum eiusmod", - "destinationUrl": "consequat do", - "inputAlias": "reprehenderit ut dolore" - } - ], - "uploadId": "occaecat dolor sit" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-post_api_index_v1_uploadshortcuts+request\} - - - - - - - -Describes the request body of the /uploadshortcuts API call - - - - - - - - - -##### forceRestartUpload \{#operation-post_api_index_v1_uploadshortcuts+request+forcerestartupload\} - - - - - -Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - - - - - - - - - -##### isFirstPage \{#operation-post_api_index_v1_uploadshortcuts+request+isfirstpage\} - - - - - -true if this is the first page of the upload. Defaults to false - - - - - - - - - -##### isLastPage \{#operation-post_api_index_v1_uploadshortcuts+request+islastpage\} - - - - - -true if this is the last page of the upload. Defaults to false - - - - - -IndexingShortcut","children":[{"label":"IndexingShortcut","linkedLabel":"IndexingShortcut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcuts \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts\} - - - - - -Batch of shortcuts information - - - - - - - - - -#### IndexingShortcut \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut\} - - - - - - - - - -##### createTime \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+createtime\} - - - - - -The time the shortcut was created in epoch seconds. - - - - - - - - - -##### createdBy \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+createdby\} - - - - - -Email of the user who created this shortcut. - - - - - - - - - -##### description \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - - - - - -##### destinationUrl \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+destinationurl\} - - - - - -destination URL for the shortcut. - - - - - - - - - -##### inputAlias \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+inputalias\} - - - - - -link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias. - - - - - - - - - -##### unlisted \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author and admins only. - - - - - - - - - -##### updateTime \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+updatetime\} - - - - - -The time the shortcut was updated in epoch seconds. - - - - - - - - - -##### updatedBy \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+updatedby\} - - - - - -Email of the user who last updated this shortcut. - - - - - - - - - -##### urlTemplate \{#operation-post_api_index_v1_uploadshortcuts+request+shortcuts+indexingshortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - - - - - - - - - -##### uploadId \{#operation-post_api_index_v1_uploadshortcuts+request+uploadid\} - - - - - -Unique id that must be used for this bulk upload instance - - - - - - - - - -
    - -     - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/glean/api/index.mdx b/examples/docusaurus/docs/glean/api/index.mdx deleted file mode 100644 index 63c5834ef..000000000 --- a/examples/docusaurus/docs/glean/api/index.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: About ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - Pill -} from "@speakeasy-api/docs-md-react"; - -# About Glean API - -_Version: 0.9.0_ - -# Introduction -In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean. - -# Usage guidelines -This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along -with a 6-month sunset period for anything that requires developers to adopt the new versions. - -# API Clients -Official API clients for the Glean Indexing API are available in multiple languages: - -- [Python](https://github.com/gleanwork/api-client-python) -- [TypeScript](https://github.com/gleanwork/api-client-typescript) -- [Go](https://github.com/gleanwork/api-client-go) -- [Java](https://github.com/gleanwork/api-client-java) - -These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice. - - -Servers - -- https://\{instance\}-be.glean.com - -## Global Security - -### APIToken bearer http \{#APIToken\} \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/_category_.json b/examples/docusaurus/docs/mistral/api/_category_.json deleted file mode 100644 index 99bb6e4fd..000000000 --- a/examples/docusaurus/docs/mistral/api/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 2, - "label": "API Reference", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/_category_.json b/examples/docusaurus/docs/mistral/api/endpoint/_category_.json deleted file mode 100644 index 180b4a4cb..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 3, - "label": "Operations", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/agents.mdx b/examples/docusaurus/docs/mistral/api/endpoint/agents.mdx deleted file mode 100644 index 6fda549cf..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/agents.mdx +++ /dev/null @@ -1,15328 +0,0 @@ ---- -sidebar_position: 3.0 -sidebar_label: Agents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Agents Endpoints - - - - - -Agents API. - - - - - - - - - -## POST /v1/agents/completions \{#operation-agents_completion_v1_agents_completions_post\} - - - - - -Agents Completion - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-agents_completion_v1_agents_completions_post+request-examples\} - - - - - -```json -{ - "agent_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_completion_v1_agents_completions_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_completion_v1_agents_completions_post+request+agent_id\} - - - - - -The ID of the agent to use for this completion. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_completion_v1_agents_completions_post+request+frequency_penalty\} - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens \{#operation-agents_completion_v1_agents_completions_post+request+max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-agents_completion_v1_agents_completions_post+request+messages\} - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### SystemMessage \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post+request+messages+systemmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post+request+messages+usermessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-agents_completion_v1_agents_completions_post+request+messages+toolmessage+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### n \{#operation-agents_completion_v1_agents_completions_post+request+n\} - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parallel_tool_calls \{#operation-agents_completion_v1_agents_completions_post+request+parallel_tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction \{#operation-agents_completion_v1_agents_completions_post+request+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_completion_v1_agents_completions_post+request+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+request+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_completion_v1_agents_completions_post+request+presence_penalty\} - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode \{#operation-agents_completion_v1_agents_completions_post+request+prompt_mode\} - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_completion_v1_agents_completions_post+request+random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format \{#operation-agents_completion_v1_agents_completions_post+request+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_completion_v1_agents_completions_post+request+stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-agents_completion_v1_agents_completions_post+request+stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolChoice \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice+toolchoice\} - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice+toolchoice+function\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionName \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice+toolchoice+function+functionname\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice+toolchoice+function+functionname+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+tool_choice+toolchoice+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_completion_v1_agents_completions_post+request+tools\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Tool \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+request+tools+tool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_completion_v1_agents_completions_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_completion_v1_agents_completions_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ChatCompletionChoice \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### finish_reason \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+finish_reason\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -stop -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -0 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### AssistantMessage \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_completion_v1_agents_completions_post+responses+200+application-json+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_completion_v1_agents_completions_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/audio/transcriptions.mdx b/examples/docusaurus/docs/mistral/api/endpoint/audio/transcriptions.mdx deleted file mode 100644 index d71473b40..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/audio/transcriptions.mdx +++ /dev/null @@ -1,4999 +0,0 @@ ---- -sidebar_position: 3.1 -sidebar_label: Audio Transcriptions ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Audio Transcriptions Endpoints - - - - - -API for audio transcription. - - - - - - - - - -## POST /v1/audio/transcriptions \{#operation-audio_api_v1_transcriptions_post\} - - - - - -Create Transcription - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-audio_api_v1_transcriptions_post+request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-audio_api_v1_transcriptions_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-audio_api_v1_transcriptions_post+request+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### File \{#operation-audio_api_v1_transcriptions_post+request+file+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-audio_api_v1_transcriptions_post+request+file+file+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fileName \{#operation-audio_api_v1_transcriptions_post+request+file+file+filename\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### file_id \{#operation-audio_api_v1_transcriptions_post+request+file_id\} - - - - - -ID of a file uploaded to /v1/files - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_url \{#operation-audio_api_v1_transcriptions_post+request+file_url\} - - - - - -Url of a file to be transcribed - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post+request+language\} - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-audio_api_v1_transcriptions_post+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature \{#operation-audio_api_v1_transcriptions_post+request+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### timestamp_granularities \{#operation-audio_api_v1_transcriptions_post+request+timestamp_granularities\} - - - - - -Granularities of timestamps to include in the response. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-audio_api_v1_transcriptions_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "language": null, - "model": "ipsum eiusmod", - "text": "consequat do", - "usage": {} -} -``` - - - - - - - - - - - - - -### Responses \{#operation-audio_api_v1_transcriptions_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+language\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### segments \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TranscriptionSegmentChunk \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments+transcriptionsegmentchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments+transcriptionsegmentchunk+end\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments+transcriptionsegmentchunk+start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments+transcriptionsegmentchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+segments+transcriptionsegmentchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-audio_api_v1_transcriptions_post+responses+200+application-json+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/audio/transcriptions\#stream \{#operation-audio_api_v1_transcriptions_post_stream\} - - - - - -Create streaming transcription (SSE) - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-audio_api_v1_transcriptions_post_stream+request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-audio_api_v1_transcriptions_post_stream+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-audio_api_v1_transcriptions_post_stream+request+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### File \{#operation-audio_api_v1_transcriptions_post_stream+request+file+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-audio_api_v1_transcriptions_post_stream+request+file+file+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fileName \{#operation-audio_api_v1_transcriptions_post_stream+request+file+file+filename\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### file_id \{#operation-audio_api_v1_transcriptions_post_stream+request+file_id\} - - - - - -ID of a file uploaded to /v1/files - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_url \{#operation-audio_api_v1_transcriptions_post_stream+request+file_url\} - - - - - -Url of a file to be transcribed - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_stream+request+language\} - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_stream+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-audio_api_v1_transcriptions_post_stream+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### temperature \{#operation-audio_api_v1_transcriptions_post_stream+request+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### timestamp_granularities \{#operation-audio_api_v1_transcriptions_post_stream+request+timestamp_granularities\} - - - - - -Granularities of timestamps to include in the response. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-audio_api_v1_transcriptions_post_stream+responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-audio_api_v1_transcriptions_post_stream+responses\} - - - - - -200 - - - - - - - -TranscriptionStreamEvents","children":[{"label":"TranscriptionStreamEvents","linkedLabel":"TranscriptionStreamEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Stream of transcription events - - - - - - - - - -#### TranscriptionStreamEvents \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TranscriptionStreamTextDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamLanguage","linkedLabel":"TranscriptionStreamLanguage","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamSegmentDelta","linkedLabel":"TranscriptionStreamSegmentDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamDone","linkedLabel":"TranscriptionStreamDone","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TranscriptionStreamTextDelta \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamtextdelta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamtextdelta+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamtextdelta+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription.text.delta"` - - - - - - - - - - - - - -#### TranscriptionStreamLanguage \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamlanguage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### audio_language \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamlanguage+audio_language\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamlanguage+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription.language"` - - - - - - - - - - - - - -#### TranscriptionStreamSegmentDelta \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamsegmentdelta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamsegmentdelta+end\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamsegmentdelta+start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamsegmentdelta+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamsegmentdelta+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription.segment"` - - - - - - - - - - - - - -#### TranscriptionStreamDone \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### language \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+language\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### segments \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TranscriptionSegmentChunk \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments+transcriptionsegmentchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### end \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments+transcriptionsegmentchunk+end\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### start \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments+transcriptionsegmentchunk+start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments+transcriptionsegmentchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+segments+transcriptionsegmentchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"transcription.done"` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+data+transcriptionstreamdone+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - -##### event \{#operation-audio_api_v1_transcriptions_post_stream+responses+200+text-event-stream+transcriptionstreamevents+event\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/batch.mdx b/examples/docusaurus/docs/mistral/api/endpoint/batch.mdx deleted file mode 100644 index 5b68d78f8..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/batch.mdx +++ /dev/null @@ -1,7258 +0,0 @@ ---- -sidebar_position: 3.2 -sidebar_label: Batch ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Batch Endpoints - - - - - -Batch API - - - - - - - - - -## GET /v1/batch/jobs \{#operation-jobs_api_routes_batch_get_batch_jobs\} - - - - - -_Get Batch Jobs_ - - - - - -Get a list of batch jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_get_batch_jobs+responses-examples\} - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_get_batch_jobs+responses\} - - - - - -200 - - - - - - - -OK - - - - - -BatchJobOut","children":[{"label":"BatchJobOut","linkedLabel":"BatchJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BatchJobOut \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+completed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+endpoint\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+error_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### errors \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+errors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+errors+batcherror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+errors+batcherror+count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+errors+batcherror+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+failed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+input_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+output_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+started_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+succeeded_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+data+batchjobout+total_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total \{#operation-jobs_api_routes_batch_get_batch_jobs+responses+200+application-json+total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -## POST /v1/batch/jobs \{#operation-jobs_api_routes_batch_create_batch_job\} - - - - - -_Create Batch Job_ - - - - - -Create a new batch job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-jobs_api_routes_batch_create_batch_job+request-examples\} - - - - - -```json -{ - "endpoint": "/v1/chat/completions", - "input_files": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-jobs_api_routes_batch_create_batch_job+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_create_batch_job+request+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_create_batch_job+request+endpoint\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_create_batch_job+request+input_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_create_batch_job+request+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_create_batch_job+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### timeout_hours \{#operation-jobs_api_routes_batch_create_batch_job+request+timeout_hours\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `24` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_create_batch_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_create_batch_job+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+completed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+endpoint\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+error_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+errors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+errors+batcherror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+errors+batcherror+count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+errors+batcherror+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+failed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+input_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+output_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+started_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+succeeded_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_create_batch_job+responses+200+application-json+total_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/batch/jobs/\{job\_id\} \{#operation-jobs_api_routes_batch_get_batch_job\} - - - - - -_Get Batch Job_ - - - - - -Get a batch job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_batch_get_batch_job+parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_batch_get_batch_job+parameters+job_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_get_batch_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_get_batch_job+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+completed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+endpoint\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+error_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+errors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+errors+batcherror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+errors+batcherror+count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+errors+batcherror+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+failed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+input_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+output_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+started_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+succeeded_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_get_batch_job+responses+200+application-json+total_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/batch/jobs/\{job\_id\}/cancel \{#operation-jobs_api_routes_batch_cancel_batch_job\} - - - - - -_Cancel Batch Job_ - - - - - -Request the cancellation of a batch job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_batch_cancel_batch_job+parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_batch_cancel_batch_job+parameters+job_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_batch_cancel_batch_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_batch_cancel_batch_job+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_requests \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+completed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### endpoint \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+endpoint\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### error_file \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+error_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+errors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BatchError \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+errors+batcherror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### count \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+errors+batcherror+count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+errors+batcherror+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### failed_requests \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+failed_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_files \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+input_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### metadata \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+output_file\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### started_at \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+started_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### succeeded_requests \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+succeeded_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_requests \{#operation-jobs_api_routes_batch_cancel_batch_job+responses+200+application-json+total_requests\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/beta/agents.mdx b/examples/docusaurus/docs/mistral/api/endpoint/beta/agents.mdx deleted file mode 100644 index d23cc3f45..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/beta/agents.mdx +++ /dev/null @@ -1,28289 +0,0 @@ ---- -sidebar_position: 3.3 -sidebar_label: Beta Agents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Agents Endpoints - - - - - -(beta) Agents API - - - - - - - - - -## GET /v1/agents \{#operation-agents_api_v1_agents_list\} - - - - - -_List agent entities._ - - - - - -Retrieve a list of agent entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_agents_list+parameters\} - - - - - - - - - - - -##### page \{#operation-agents_api_v1_agents_list+parameters+page\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### page_size \{#operation-agents_api_v1_agents_list+parameters+page_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_list+responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_list+responses\} - - - - - -200 - - - - - - - -Agent","children":[{"label":"Agent","linkedLabel":"Agent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### Agent \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_list+responses+200+application-json+agent+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_list+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_list+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_list+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_list+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_list+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_list+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_list+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_list+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_list+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/agents \{#operation-agents_api_v1_agents_create\} - - - - - -_Create a agent that can be used within a conversation._ - - - - - -Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-agents_api_v1_agents_create+request-examples\} - - - - - -```json -{ - "model": "ipsum eiusmod", - "name": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_agents_create+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_create+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_create+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_create+request+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_create+request+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_create+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_create+request+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_create+request+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create+request+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_create+request+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_create+request+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_create+request+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_create+request+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_create+request+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_create+request+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+request+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_create+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_create+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_create+responses+200+application-json+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_create+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_create+responses+200+application-json+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_create+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_create+responses+200+application-json+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_create+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_create+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+200+application-json+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_create+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_create+responses+200+application-json+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_create+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_create+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_create+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_create+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_create+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_create+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_create+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_create+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_create+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/agents/\{agent\_id\} \{#operation-agents_api_v1_agents_get\} - - - - - -_Retrieve an agent entity._ - - - - - -Given an agent retrieve an agent entity with its attributes. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_agents_get+parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_get+parameters+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_get+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_get+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_get+responses+200+application-json+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_get+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_get+responses+200+application-json+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_get+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_get+responses+200+application-json+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_get+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_get+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+200+application-json+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_get+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_get+responses+200+application-json+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_get+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_get+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_get+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_get+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_get+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_get+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_get+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_get+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_get+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/agents/\{agent\_id\} \{#operation-agents_api_v1_agents_update\} - - - - - -_Update an agent entity._ - - - - - -Update an agent attributes and create a new version. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_agents_update+parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_update+parameters+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-agents_api_v1_agents_update+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_agents_update+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update+request+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update+request+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update+request+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update+request+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update+request+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update+request+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update+request+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update+request+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update+request+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update+request+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update+request+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+request+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_update+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_update+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update+responses+200+application-json+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_update+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update+responses+200+application-json+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_update+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update+responses+200+application-json+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_update+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+200+application-json+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_update+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update+responses+200+application-json+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_update+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_update+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_update+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_update+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_update+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_update+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_update+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_update+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/agents/\{agent\_id\}/version \{#operation-agents_api_v1_agents_update_version\} - - - - - -_Update an agent version._ - - - - - -Switch the version of an agent. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_agents_update_version+parameters\} - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_agents_update_version+parameters+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update_version+parameters+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_agents_update_version+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_agents_update_version+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoffs \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+handoffs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### version \{#operation-agents_api_v1_agents_update_version+responses+200+application-json+version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_agents_update_version+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/beta/conversations.mdx b/examples/docusaurus/docs/mistral/api/endpoint/beta/conversations.mdx deleted file mode 100644 index 0369eca99..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/beta/conversations.mdx +++ /dev/null @@ -1,116057 +0,0 @@ ---- -sidebar_position: 3.4 -sidebar_label: Beta Conversations ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Conversations Endpoints - - - - - -(beta) Conversations API - - - - - - - - - -## GET /v1/conversations \{#operation-agents_api_v1_conversations_list\} - - - - - -_List all created conversations._ - - - - - -Retrieve a list of conversation entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_list+parameters\} - - - - - - - - - - - -##### page \{#operation-agents_api_v1_conversations_list+parameters+page\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### page_size \{#operation-agents_api_v1_conversations_list+parameters+page_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_list+responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_list+responses\} - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+description\} - - - - - -Description of the what the conversation is about. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+name\} - - - - - -Name given to the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_list+responses+200+application-json+modelconversation+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### AgentConversation \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+description\} - - - - - -Description of the what the conversation is about. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+name\} - - - - - -Name given to the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_list+responses+200+application-json+agentconversation+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_list+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_list+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_list+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_list+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_list+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_list+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_list+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_list+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_list+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations \{#operation-agents_api_v1_conversations_start\} - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_start+request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_start+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start+request+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_start+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_start+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_start+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_start+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_start+request+instructions\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_start+request+store\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_start+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_conversations_start+request+tools\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_start+request+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_start+request+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_start+request+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_start+request+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_start+request+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_start+request+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_start+request+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+request+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_start+responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_start+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+200+application-json+outputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_start+responses+200+application-json+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_start+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_start+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_start+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_start+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_start+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_start+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_start+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_start+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\} \{#operation-agents_api_v1_conversations_get\} - - - - - -_Retrieve a conversation information._ - - - - - -Given a conversation_id retrieve a conversation entity with its attributes. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_get+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_get+parameters+conversation_id\} - - - - - -ID of the conversation from which we are fetching metadata. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_get+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_get+responses\} - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+description\} - - - - - -Description of the what the conversation is about. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+instructions\} - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+name\} - - - - - -Name given to the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools\} - - - - - -List of tools which are available to the model during the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_get+responses+200+application-json+modelconversation+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### AgentConversation \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+description\} - - - - - -Description of the what the conversation is about. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+name\} - - - - - -Name given to the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at \{#operation-agents_api_v1_conversations_get+responses+200+application-json+agentconversation+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_get+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_get+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_get+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_get+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_get+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_get+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_get+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_get+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_get+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\} \{#operation-agents_api_v1_conversations_append\} - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_append+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append+parameters+conversation_id\} - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_append+request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_append+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_append+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_append+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_append+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_append+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_append+request+store\} - - - - - -Whether to store the results into our servers or not. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_append+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_append+responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_append+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+200+application-json+outputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_append+responses+200+application-json+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_append+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_append+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_append+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_append+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_append+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_append+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_append+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_append+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\}/history \{#operation-agents_api_v1_conversations_history\} - - - - - -_Retrieve all entries in a conversation._ - - - - - -Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_history+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_history+parameters+conversation_id\} - - - - - -ID of the conversation from which we are fetching entries. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_history+responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "entries": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_history+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### entries \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+200+application-json+entries+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_history+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.history"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_history+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_history+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_history+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_history+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_history+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_history+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_history+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_history+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_history+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\}/messages \{#operation-agents_api_v1_conversations_messages\} - - - - - -_Retrieve all messages in a conversation._ - - - - - -Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_messages+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_messages+parameters+conversation_id\} - - - - - -ID of the conversation from which we are fetching messages. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_messages+responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_messages+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+messages+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_messages+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.messages"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_messages+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart \{#operation-agents_api_v1_conversations_restart\} - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_restart+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart+parameters+conversation_id\} - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_restart+request-examples\} - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_restart+request\} - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_restart+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_restart+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### from_entry_id \{#operation-agents_api_v1_conversations_restart+request+from_entry_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_restart+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_restart+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_restart+request+store\} - - - - - -Whether to store the results into our servers or not. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_restart+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_restart+responses-examples\} - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-agents_api_v1_conversations_restart+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+outputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_restart+responses+200+application-json+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations\#stream \{#operation-agents_api_v1_conversations_start_stream\} - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_start_stream+request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_start_stream+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream+request+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_start_stream+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_start_stream+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_start_stream+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_start_stream+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions \{#operation-agents_api_v1_conversations_start_stream+request+instructions\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_start_stream+request+store\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_start_stream+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-agents_api_v1_conversations_start_stream+request+tools\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+functiontool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+websearchtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+websearchtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+websearchpremiumtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+websearchpremiumtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+codeinterpretertool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+codeinterpretertool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+imagegenerationtool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+imagegenerationtool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool \{#operation-agents_api_v1_conversations_start_stream+request+tools+documentlibrarytool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_ids \{#operation-agents_api_v1_conversations_start_stream+request+tools+documentlibrarytool+library_ids\} - - - - - -Ids of the library in which to search. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+request+tools+documentlibrarytool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_start_stream+responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_start_stream+responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+code\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_start_stream+responses+200+text-event-stream+conversationevents+event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_start_stream+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}\#stream \{#operation-agents_api_v1_conversations_append_stream\} - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_append_stream+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_stream+parameters+conversation_id\} - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_append_stream+request-examples\} - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_append_stream+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_append_stream+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_append_stream+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_append_stream+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_append_stream+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_append_stream+request+store\} - - - - - -Whether to store the results into our servers or not. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_append_stream+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_append_stream+responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_append_stream+responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+code\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_append_stream+responses+200+text-event-stream+conversationevents+event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_append_stream+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart\#stream \{#operation-agents_api_v1_conversations_restart_stream\} - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-agents_api_v1_conversations_restart_stream+parameters\} - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_stream+parameters+conversation_id\} - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-agents_api_v1_conversations_restart_stream+request-examples\} - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-agents_api_v1_conversations_restart_stream+request\} - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionArgs \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs\} - - - - - -White-listed arguments from the completion API - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+frequency_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_tokens \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+max_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+presence_penalty\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+random_seed\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### stop \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+stop\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_choice \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-agents_api_v1_conversations_restart_stream+request+completion_args+completionargs+top_p\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### from_entry_id \{#operation-agents_api_v1_conversations_restart_stream+request+from_entry_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### handoff_execution \{#operation-agents_api_v1_conversations_restart_stream+request+handoff_execution\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs \{#operation-agents_api_v1_conversations_restart_stream+request+inputs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MessageInputEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry\} - - - - - -Representation of an input message inside the conversation. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+prefix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageinputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+messageoutputentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+result\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functionresultentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+functioncallentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+toolexecutionentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completed_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+completed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+request+inputs+agenthandoffentry+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store \{#operation-agents_api_v1_conversations_restart_stream+request+store\} - - - - - -Whether to store the results into our servers or not. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream \{#operation-agents_api_v1_conversations_restart_stream+request+stream\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-agents_api_v1_conversations_restart_stream+responses-examples\} - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-agents_api_v1_conversations_restart_stream+responses\} - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseStartedEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### conversation_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+conversation_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsestartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ConversationUsageInfo \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connector_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### connectors \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+connectors\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responsedoneevent+usage+conversationusageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### code \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+code\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### message \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+responseerrorevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutionstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondeltaevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### info \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+toolexecutiondoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### agent_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+file_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolfilechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### favicon \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+favicon\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### title \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+title\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tool \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content+toolreferencechunk+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### content_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+content_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+messageoutputevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+functioncallevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### previous_agent_name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+previous_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffstartedevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_id \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### next_agent_name \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+next_agent_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_index \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+output_index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+data+agenthandoffdoneevent+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event \{#operation-agents_api_v1_conversations_restart_stream+responses+200+text-event-stream+conversationevents+event\} - - - - - -Server side events sent when streaming a conversation response. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-agents_api_v1_conversations_restart_stream+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries.mdx b/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries.mdx deleted file mode 100644 index 4cea70623..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries.mdx +++ /dev/null @@ -1,9707 +0,0 @@ ---- -sidebar_position: 3.5 -sidebar_label: Beta Libraries ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Endpoints - - - - - -(beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - - - - - - - - - -## GET /v1/libraries \{#operation-libraries_list_v1\} - - - - - -_List all libraries you have access to._ - - - - - -List all libraries that you have created or have been shared with you. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-libraries_list_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_list_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -LibraryOut","children":[{"label":"LibraryOut","linkedLabel":"LibraryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_list_v1+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### LibraryOut \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### chunk_size \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### emoji \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+emoji\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+explicit_user_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+explicit_workspace_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_description \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+generated_description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_name \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+generated_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### nb_documents \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+nb_documents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_sharing_role \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+org_sharing_role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_id \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+owner_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_type \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+owner_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_size \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+total_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### updated_at \{#operation-libraries_list_v1+responses+200+application-json+data+libraryout+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries \{#operation-libraries_create_v1\} - - - - - -_Create a new Library._ - - - - - -Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-libraries_create_v1+request-examples\} - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_create_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### chunk_size \{#operation-libraries_create_v1+request+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_create_v1+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_create_v1+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_create_v1+responses-examples\} - - - - - -201 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_create_v1+responses\} - - - - - -201 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_create_v1+responses+201+application-json+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_create_v1+responses+201+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_create_v1+responses+201+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### emoji \{#operation-libraries_create_v1+responses+201+application-json+emoji\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_create_v1+responses+201+application-json+explicit_user_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_create_v1+responses+201+application-json+explicit_workspace_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_description \{#operation-libraries_create_v1+responses+201+application-json+generated_description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_name \{#operation-libraries_create_v1+responses+201+application-json+generated_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_create_v1+responses+201+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_create_v1+responses+201+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### nb_documents \{#operation-libraries_create_v1+responses+201+application-json+nb_documents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_sharing_role \{#operation-libraries_create_v1+responses+201+application-json+org_sharing_role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_id \{#operation-libraries_create_v1+responses+201+application-json+owner_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_type \{#operation-libraries_create_v1+responses+201+application-json+owner_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_size \{#operation-libraries_create_v1+responses+201+application-json+total_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### updated_at \{#operation-libraries_create_v1+responses+201+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_create_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_create_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_create_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_create_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_create_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_create_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_create_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_create_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_create_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\} \{#operation-libraries_get_v1\} - - - - - -_Detailed information about a specific Library._ - - - - - -Given a library id, details information about that Library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_get_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_get_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_get_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_get_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_get_v1+responses+200+application-json+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_get_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_get_v1+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### emoji \{#operation-libraries_get_v1+responses+200+application-json+emoji\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_get_v1+responses+200+application-json+explicit_user_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_get_v1+responses+200+application-json+explicit_workspace_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_description \{#operation-libraries_get_v1+responses+200+application-json+generated_description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_name \{#operation-libraries_get_v1+responses+200+application-json+generated_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_get_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_get_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### nb_documents \{#operation-libraries_get_v1+responses+200+application-json+nb_documents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_sharing_role \{#operation-libraries_get_v1+responses+200+application-json+org_sharing_role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_id \{#operation-libraries_get_v1+responses+200+application-json+owner_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_type \{#operation-libraries_get_v1+responses+200+application-json+owner_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_size \{#operation-libraries_get_v1+responses+200+application-json+total_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### updated_at \{#operation-libraries_get_v1+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_get_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_get_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_get_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_get_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_get_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_get_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_get_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_get_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_get_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\} \{#operation-libraries_update_v1\} - - - - - -_Update a library._ - - - - - -Given a library id, you can update the name and description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_update_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_update_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-libraries_update_v1+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_update_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### description \{#operation-libraries_update_v1+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_update_v1+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_update_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_update_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_update_v1+responses+200+application-json+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_update_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_update_v1+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### emoji \{#operation-libraries_update_v1+responses+200+application-json+emoji\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_update_v1+responses+200+application-json+explicit_user_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_update_v1+responses+200+application-json+explicit_workspace_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_description \{#operation-libraries_update_v1+responses+200+application-json+generated_description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_name \{#operation-libraries_update_v1+responses+200+application-json+generated_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_update_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_update_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### nb_documents \{#operation-libraries_update_v1+responses+200+application-json+nb_documents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_sharing_role \{#operation-libraries_update_v1+responses+200+application-json+org_sharing_role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_id \{#operation-libraries_update_v1+responses+200+application-json+owner_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_type \{#operation-libraries_update_v1+responses+200+application-json+owner_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_size \{#operation-libraries_update_v1+responses+200+application-json+total_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### updated_at \{#operation-libraries_update_v1+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_update_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_update_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_update_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_update_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_update_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_update_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_update_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_update_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_update_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\} \{#operation-libraries_delete_v1\} - - - - - -_Delete a library and all of it's document._ - - - - - -Given a library id, deletes it together with all documents that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_delete_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_delete_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_delete_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_delete_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size \{#operation-libraries_delete_v1+responses+200+application-json+chunk_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_delete_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-libraries_delete_v1+responses+200+application-json+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### emoji \{#operation-libraries_delete_v1+responses+200+application-json+emoji\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_user_members_count \{#operation-libraries_delete_v1+responses+200+application-json+explicit_user_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### explicit_workspace_members_count \{#operation-libraries_delete_v1+responses+200+application-json+explicit_workspace_members_count\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_description \{#operation-libraries_delete_v1+responses+200+application-json+generated_description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### generated_name \{#operation-libraries_delete_v1+responses+200+application-json+generated_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_delete_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_delete_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### nb_documents \{#operation-libraries_delete_v1+responses+200+application-json+nb_documents\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_sharing_role \{#operation-libraries_delete_v1+responses+200+application-json+org_sharing_role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_id \{#operation-libraries_delete_v1+responses+200+application-json+owner_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner_type \{#operation-libraries_delete_v1+responses+200+application-json+owner_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_size \{#operation-libraries_delete_v1+responses+200+application-json+total_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### updated_at \{#operation-libraries_delete_v1+responses+200+application-json+updated_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_delete_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_delete_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_delete_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_delete_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_delete_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_delete_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_delete_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_delete_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_delete_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/accesses.mdx b/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/accesses.mdx deleted file mode 100644 index 60dc912d3..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/accesses.mdx +++ /dev/null @@ -1,4632 +0,0 @@ ---- -sidebar_position: 3.6 -sidebar_label: Beta Libraries Accesses ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Accesses Endpoints - - - - - -(beta) Libraries API - manage access to a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_list_v1\} - - - - - -_List all of the access to this library._ - - - - - -Given a library, list all of the Entity that have access and to what level. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_share_list_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_list_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_share_list_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_list_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -SharingOut","children":[{"label":"SharingOut","linkedLabel":"SharingOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_share_list_v1+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### SharingOut \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_id \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_id \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+org_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_type \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+share_with_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+share_with_uuid\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### user_id \{#operation-libraries_share_list_v1+responses+200+application-json+data+sharingout+user_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_list_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_list_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_share_list_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_share_list_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_list_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_share_list_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_share_list_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_share_list_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_share_list_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_create_v1\} - - - - - -_Create or update an access level._ - - - - - -Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_share_create_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_create_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-libraries_share_create_v1+request-examples\} - - - - - -```json -{ - "level": "Viewer", - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_share_create_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### level \{#operation-libraries_share_create_v1+request+level\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_id \{#operation-libraries_share_create_v1+request+org_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_type \{#operation-libraries_share_create_v1+request+share_with_type\} - - - - - -The type of entity, used to share a library. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_create_v1+request+share_with_uuid\} - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_share_create_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_create_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id \{#operation-libraries_share_create_v1+responses+200+application-json+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_id \{#operation-libraries_share_create_v1+responses+200+application-json+org_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-libraries_share_create_v1+responses+200+application-json+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_type \{#operation-libraries_share_create_v1+responses+200+application-json+share_with_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_create_v1+responses+200+application-json+share_with_uuid\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### user_id \{#operation-libraries_share_create_v1+responses+200+application-json+user_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_create_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_create_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_share_create_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_share_create_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_create_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_share_create_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_share_create_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_share_create_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_share_create_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\}/share \{#operation-libraries_share_delete_v1\} - - - - - -_Delete an access level._ - - - - - -Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_share_delete_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_share_delete_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-libraries_share_delete_v1+request-examples\} - - - - - -```json -{ - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_share_delete_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### org_id \{#operation-libraries_share_delete_v1+request+org_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_type \{#operation-libraries_share_delete_v1+request+share_with_type\} - - - - - -The type of entity, used to share a library. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_delete_v1+request+share_with_uuid\} - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_share_delete_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_share_delete_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id \{#operation-libraries_share_delete_v1+responses+200+application-json+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### org_id \{#operation-libraries_share_delete_v1+responses+200+application-json+org_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-libraries_share_delete_v1+responses+200+application-json+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_type \{#operation-libraries_share_delete_v1+responses+200+application-json+share_with_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### share_with_uuid \{#operation-libraries_share_delete_v1+responses+200+application-json+share_with_uuid\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### user_id \{#operation-libraries_share_delete_v1+responses+200+application-json+user_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_share_delete_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_share_delete_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_share_delete_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_share_delete_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_share_delete_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_share_delete_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_share_delete_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_share_delete_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_share_delete_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/documents.mdx b/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/documents.mdx deleted file mode 100644 index 3e89e2b1b..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/beta/libraries/documents.mdx +++ /dev/null @@ -1,14964 +0,0 @@ ---- -sidebar_position: 3.7 -sidebar_label: Beta Libraries Documents ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Documents Endpoints - - - - - -(beta) Libraries API - manage documents in a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents \{#operation-libraries_documents_list_v1\} - - - - - -_List document in a given library._ - - - - - -Given a library, lists the document that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-libraries_documents_list_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" - } - ], - "pagination": { - "current_page": 56, - "has_more": false, - "page_size": 91, - "total_items": 32, - "total_pages": 78 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_list_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -DocumentOut","children":[{"label":"DocumentOut","linkedLabel":"DocumentOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-libraries_documents_list_v1+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### DocumentOut \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### extension \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+extension\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### hash \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+hash\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+last_processed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mime_type \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+mime_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+number_of_pages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### processing_status \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+processing_status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### size \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### summary \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+tokens_processing_main_content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+tokens_processing_summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+tokens_processing_total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+uploaded_by_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_list_v1+responses+200+application-json+data+documentout+uploaded_by_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -PaginationInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pagination \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### PaginationInfo \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### current_page \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo+current_page\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### has_more \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo+has_more\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### page_size \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo+page_size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_items \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo+total_items\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total_pages \{#operation-libraries_documents_list_v1+responses+200+application-json+pagination+paginationinfo+total_pages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_list_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_list_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_list_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_list_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_list_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_list_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_list_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_list_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_list_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries/\{library\_id\}/documents \{#operation-libraries_documents_upload_v1\} - - - - - -_Upload a new document._ - - - - - -Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_upload_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_upload_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-libraries_documents_upload_v1+request-examples\} - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_documents_upload_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-libraries_documents_upload_v1+request+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### File \{#operation-libraries_documents_upload_v1+request+file+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-libraries_documents_upload_v1+request+file+file+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fileName \{#operation-libraries_documents_upload_v1+request+file+file+filename\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_upload_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_upload_v1+responses\} - - - - - -200 - - - - - - - -A document with the same hash was found in this library. Returns the existing document. - - - - - - - - - -##### created_at \{#operation-libraries_documents_upload_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### extension \{#operation-libraries_documents_upload_v1+responses+200+application-json+extension\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### hash \{#operation-libraries_documents_upload_v1+responses+200+application-json+hash\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_documents_upload_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_upload_v1+responses+200+application-json+last_processed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_upload_v1+responses+200+application-json+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mime_type \{#operation-libraries_documents_upload_v1+responses+200+application-json+mime_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_documents_upload_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_upload_v1+responses+200+application-json+number_of_pages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### processing_status \{#operation-libraries_documents_upload_v1+responses+200+application-json+processing_status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### size \{#operation-libraries_documents_upload_v1+responses+200+application-json+size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### summary \{#operation-libraries_documents_upload_v1+responses+200+application-json+summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_upload_v1+responses+200+application-json+tokens_processing_main_content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_upload_v1+responses+200+application-json+tokens_processing_summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_upload_v1+responses+200+application-json+tokens_processing_total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_upload_v1+responses+200+application-json+uploaded_by_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_upload_v1+responses+200+application-json+uploaded_by_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_upload_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_upload_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_upload_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_upload_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_upload_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_upload_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_upload_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_upload_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_upload_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_get_v1\} - - - - - -_Retrieve the metadata of a specific document._ - - - - - -Given a library and a document in this library, you can retrieve the metadata of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_get_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at \{#operation-libraries_documents_get_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### extension \{#operation-libraries_documents_get_v1+responses+200+application-json+extension\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### hash \{#operation-libraries_documents_get_v1+responses+200+application-json+hash\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_documents_get_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_get_v1+responses+200+application-json+last_processed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_v1+responses+200+application-json+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mime_type \{#operation-libraries_documents_get_v1+responses+200+application-json+mime_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_documents_get_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_get_v1+responses+200+application-json+number_of_pages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### processing_status \{#operation-libraries_documents_get_v1+responses+200+application-json+processing_status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### size \{#operation-libraries_documents_get_v1+responses+200+application-json+size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### summary \{#operation-libraries_documents_get_v1+responses+200+application-json+summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_get_v1+responses+200+application-json+tokens_processing_main_content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_get_v1+responses+200+application-json+tokens_processing_summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_get_v1+responses+200+application-json+tokens_processing_total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_get_v1+responses+200+application-json+uploaded_by_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_get_v1+responses+200+application-json+uploaded_by_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_get_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_get_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_get_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_get_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_get_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_update_v1\} - - - - - -_Update the metadata of a specific document._ - - - - - -Given a library and a document in that library, update the name of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_update_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_update_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_update_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-libraries_documents_update_v1+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-libraries_documents_update_v1+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### name \{#operation-libraries_documents_update_v1+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_update_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_update_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at \{#operation-libraries_documents_update_v1+responses+200+application-json+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### extension \{#operation-libraries_documents_update_v1+responses+200+application-json+extension\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### hash \{#operation-libraries_documents_update_v1+responses+200+application-json+hash\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-libraries_documents_update_v1+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### last_processed_at \{#operation-libraries_documents_update_v1+responses+200+application-json+last_processed_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_update_v1+responses+200+application-json+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mime_type \{#operation-libraries_documents_update_v1+responses+200+application-json+mime_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-libraries_documents_update_v1+responses+200+application-json+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### number_of_pages \{#operation-libraries_documents_update_v1+responses+200+application-json+number_of_pages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### processing_status \{#operation-libraries_documents_update_v1+responses+200+application-json+processing_status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### size \{#operation-libraries_documents_update_v1+responses+200+application-json+size\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### summary \{#operation-libraries_documents_update_v1+responses+200+application-json+summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_main_content \{#operation-libraries_documents_update_v1+responses+200+application-json+tokens_processing_main_content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_summary \{#operation-libraries_documents_update_v1+responses+200+application-json+tokens_processing_summary\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### tokens_processing_total \{#operation-libraries_documents_update_v1+responses+200+application-json+tokens_processing_total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_id \{#operation-libraries_documents_update_v1+responses+200+application-json+uploaded_by_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### uploaded_by_type \{#operation-libraries_documents_update_v1+responses+200+application-json+uploaded_by_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_update_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_update_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_update_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_update_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_update_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_update_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_update_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_update_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_update_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\}/documents/\{document\_id\} \{#operation-libraries_documents_delete_v1\} - - - - - -_Delete a document._ - - - - - -Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_delete_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_delete_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_delete_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_delete_v1+responses-examples\} - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_documents_delete_v1+responses\} - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_delete_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_delete_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_delete_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_delete_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_delete_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_delete_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_delete_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_delete_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_delete_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/text\_content \{#operation-libraries_documents_get_text_content_v1\} - - - - - -_Retrieve the text content of a specific document._ - - - - - -Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_get_text_content_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_text_content_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_text_content_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_text_content_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "text": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_text_content_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### text \{#operation-libraries_documents_get_text_content_v1+responses+200+application-json+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_get_text_content_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/status \{#operation-libraries_documents_get_status_v1\} - - - - - -_Retrieve the processing status of a specific document._ - - - - - -Given a library and a document in that library, retrieve the processing status of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_get_status_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_status_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_status_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_status_v1+responses-examples\} - - - - - -200 - - - - - -```json -{ - "document_id": "ipsum eiusmod", - "processing_status": "consequat do" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_status_v1+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_status_v1+responses+200+application-json+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### processing_status \{#operation-libraries_documents_get_status_v1+responses+200+application-json+processing_status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_status_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_status_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_get_status_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_get_status_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_status_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_status_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_get_status_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_get_status_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_get_status_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/signed-url \{#operation-libraries_documents_get_signed_url_v1\} - - - - - -_Retrieve the signed URL of a specific document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_get_signed_url_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_signed_url_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_signed_url_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_signed_url_v1+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_signed_url_v1+responses\} - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_get_signed_url_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/extracted-text-signed-url \{#operation-libraries_documents_get_extracted_text_signed_url_v1\} - - - - - -_Retrieve the signed URL of text extracted from a given document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_get_extracted_text_signed_url_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_get_extracted_text_signed_url_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_get_extracted_text_signed_url_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses\} - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_get_extracted_text_signed_url_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/libraries/\{library\_id\}/documents/\{document\_id\}/reprocess \{#operation-libraries_documents_reprocess_v1\} - - - - - -_Reprocess a document._ - - - - - -Given a library and a document in that library, reprocess that document, it will be billed again. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-libraries_documents_reprocess_v1+parameters\} - - - - - - - - - - - -##### library_id \{#operation-libraries_documents_reprocess_v1+parameters+library_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### document_id \{#operation-libraries_documents_reprocess_v1+parameters+document_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-libraries_documents_reprocess_v1+responses-examples\} - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events \{#operation-libraries_documents_reprocess_v1+responses\} - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-libraries_documents_reprocess_v1+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/chat.mdx b/examples/docusaurus/docs/mistral/api/endpoint/chat.mdx deleted file mode 100644 index 8cdcf3d33..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/chat.mdx +++ /dev/null @@ -1,19635 +0,0 @@ ---- -sidebar_position: 3.8 -sidebar_label: Chat ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Chat Endpoints - - - - - -Chat Completion API. - - - - - - - - - -## POST /v1/chat/completions \{#operation-chat_completion_v1_chat_completions_post\} - - - - - -Chat Completion - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-chat_completion_v1_chat_completions_post+request-examples\} - - - - - -```json -{ - "messages": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "mistral-small-latest" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-chat_completion_v1_chat_completions_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### frequency_penalty \{#operation-chat_completion_v1_chat_completions_post+request+frequency_penalty\} - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens \{#operation-chat_completion_v1_chat_completions_post+request+max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#operation-chat_completion_v1_chat_completions_post+request+messages\} - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### SystemMessage \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+request+messages+systemmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+request+messages+usermessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_completion_v1_chat_completions_post+request+messages+toolmessage+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post+request+model\} - - - - - -ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### n \{#operation-chat_completion_v1_chat_completions_post+request+n\} - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parallel_tool_calls \{#operation-chat_completion_v1_chat_completions_post+request+parallel_tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction \{#operation-chat_completion_v1_chat_completions_post+request+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Prediction \{#operation-chat_completion_v1_chat_completions_post+request+prediction+prediction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+request+prediction+prediction+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+prediction+prediction+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty \{#operation-chat_completion_v1_chat_completions_post+request+presence_penalty\} - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode \{#operation-chat_completion_v1_chat_completions_post+request+prompt_mode\} - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-chat_completion_v1_chat_completions_post+request+random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format \{#operation-chat_completion_v1_chat_completions_post+request+response_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+response_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### safe_prompt \{#operation-chat_completion_v1_chat_completions_post+request+safe_prompt\} - - - - - -Whether to inject a safety prompt before all conversations. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### stop \{#operation-chat_completion_v1_chat_completions_post+request+stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-chat_completion_v1_chat_completions_post+request+stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature \{#operation-chat_completion_v1_chat_completions_post+request+temperature\} - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolChoice \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice+toolchoice\} - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice+toolchoice+function\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionName \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice+toolchoice+function+functionname\} - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice+toolchoice+function+functionname+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+tool_choice+toolchoice+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools \{#operation-chat_completion_v1_chat_completions_post+request+tools\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Tool \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### Function \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function+function+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function+function+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### parameters \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function+function+parameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+function+function+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+request+tools+tool+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### top_p \{#operation-chat_completion_v1_chat_completions_post+request+top_p\} - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-chat_completion_v1_chat_completions_post+responses-examples\} - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_completion_v1_chat_completions_post+responses\} - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ChatCompletionChoice \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### finish_reason \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+finish_reason\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -stop -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -0 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+application-json+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionResponseStreamChoice \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### DeltaMessage \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+finish_reason\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-chat_completion_v1_chat_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_completion_v1_chat_completions_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/classifiers.mdx b/examples/docusaurus/docs/mistral/api/endpoint/classifiers.mdx deleted file mode 100644 index 993eca3c5..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/classifiers.mdx +++ /dev/null @@ -1,21801 +0,0 @@ ---- -sidebar_position: 3.9 -sidebar_label: Classifiers ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Classifiers Endpoints - - - - - -Classifiers API. - - - - - - - - - -## POST /v1/moderations \{#operation-moderations_v1_moderations_post\} - - - - - -Moderations - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-moderations_v1_moderations_post+request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-moderations_v1_moderations_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### input \{#operation-moderations_v1_moderations_post+request+input\} - - - - - -Text to classify. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-moderations_v1_moderations_post+request+model\} - - - - - -ID of the model to use. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-moderations_v1_moderations_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-moderations_v1_moderations_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-moderations_v1_moderations_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-moderations_v1_moderations_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-moderations_v1_moderations_post+responses+200+application-json+results\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModerationObject \{#operation-moderations_v1_moderations_post+responses+200+application-json+results+moderationobject\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### categories \{#operation-moderations_v1_moderations_post+responses+200+application-json+results+moderationobject+categories\} - - - - - -Moderation result thresholds - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### category_scores \{#operation-moderations_v1_moderations_post+responses+200+application-json+results+moderationobject+category_scores\} - - - - - -Moderation result - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-moderations_v1_moderations_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-moderations_v1_moderations_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-moderations_v1_moderations_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-moderations_v1_moderations_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-moderations_v1_moderations_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-moderations_v1_moderations_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-moderations_v1_moderations_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-moderations_v1_moderations_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-moderations_v1_moderations_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/chat/moderations \{#operation-chat_moderations_v1_chat_moderations_post\} - - - - - -Chat Moderations - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-chat_moderations_v1_chat_moderations_post+request-examples\} - - - - - -```json -{ - "input": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-chat_moderations_v1_chat_moderations_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"union","children":[{"label":"array","linkedLabel":"union","children":[{"label":"union","linkedLabel":"union","children":[{"label":"SystemMessage","linkedLabel":"SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input \{#operation-chat_moderations_v1_chat_moderations_post+request+input\} - - - - - -Chat to classify - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### SystemMessage \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post+request+input+systemmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post+request+input+usermessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_moderations_v1_chat_moderations_post+request+input+toolmessage+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_moderations_v1_chat_moderations_post+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-chat_moderations_v1_chat_moderations_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_moderations_v1_chat_moderations_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+results\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModerationObject \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+results+moderationobject\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### categories \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+results+moderationobject+categories\} - - - - - -Moderation result thresholds - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### category_scores \{#operation-chat_moderations_v1_chat_moderations_post+responses+200+application-json+results+moderationobject+category_scores\} - - - - - -Moderation result - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_moderations_v1_chat_moderations_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/classifications \{#operation-classifications_v1_classifications_post\} - - - - - -Classifications - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-classifications_v1_classifications_post+request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-classifications_v1_classifications_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### input \{#operation-classifications_v1_classifications_post+request+input\} - - - - - -Text to classify. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-classifications_v1_classifications_post+request+model\} - - - - - -ID of the model to use. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-classifications_v1_classifications_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-classifications_v1_classifications_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-classifications_v1_classifications_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-classifications_v1_classifications_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-classifications_v1_classifications_post+responses+200+application-json+results\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassificationTargetResult \{#operation-classifications_v1_classifications_post+responses+200+application-json+results+classificationtargetresult\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### scores \{#operation-classifications_v1_classifications_post+responses+200+application-json+results+classificationtargetresult+scores\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-classifications_v1_classifications_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-classifications_v1_classifications_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-classifications_v1_classifications_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-classifications_v1_classifications_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-classifications_v1_classifications_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-classifications_v1_classifications_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-classifications_v1_classifications_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-classifications_v1_classifications_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-classifications_v1_classifications_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/chat/classifications \{#operation-chat_classifications_v1_chat_classifications_post\} - - - - - -Chat Classifications - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-chat_classifications_v1_chat_classifications_post+request-examples\} - - - - - -```json -{ - "input": { - "messages": [ - { - "content": "ipsum eiusmod" - } - ] - }, - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-chat_classifications_v1_chat_classifications_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -InstructRequest","children":[],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"InstructRequest","children":[{"label":"InstructRequest","linkedLabel":"InstructRequest","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input \{#operation-chat_classifications_v1_chat_classifications_post+request+input\} - - - - - -Chat to classify - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### InstructRequest \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### messages \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### SystemMessage \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+systemmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+usermessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### role \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id \{#operation-chat_classifications_v1_chat_classifications_post+request+input+instructrequest+messages+toolmessage+tool_call_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### model \{#operation-chat_classifications_v1_chat_classifications_post+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-chat_classifications_v1_chat_classifications_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-chat_classifications_v1_chat_classifications_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id \{#operation-chat_classifications_v1_chat_classifications_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-chat_classifications_v1_chat_classifications_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-chat_classifications_v1_chat_classifications_post+responses+200+application-json+results\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassificationTargetResult \{#operation-chat_classifications_v1_chat_classifications_post+responses+200+application-json+results+classificationtargetresult\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### scores \{#operation-chat_classifications_v1_chat_classifications_post+responses+200+application-json+results+classificationtargetresult+scores\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-chat_classifications_v1_chat_classifications_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/embeddings.mdx b/examples/docusaurus/docs/mistral/api/endpoint/embeddings.mdx deleted file mode 100644 index c8fb49b78..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/embeddings.mdx +++ /dev/null @@ -1,2085 +0,0 @@ ---- -sidebar_position: 3.10 -sidebar_label: Embeddings ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Embeddings Endpoints - - - - - -Embeddings API. - - - - - - - - - -## POST /v1/embeddings \{#operation-embeddings_v1_embeddings_post\} - - - - - -_Embeddings_ - - - - - -Embeddings - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-embeddings_v1_embeddings_post+request-examples\} - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "mistral-embed" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-embeddings_v1_embeddings_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### input \{#operation-embeddings_v1_embeddings_post+request+input\} - - - - - -Text to embed. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-embeddings_v1_embeddings_post+request+model\} - - - - - -ID of the model to use. - - - - - -_Example:_ - -``` -mistral-embed -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_dimension \{#operation-embeddings_v1_embeddings_post+request+output_dimension\} - - - - - -The dimension of the output embeddings. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### output_dtype \{#operation-embeddings_v1_embeddings_post+request+output_dtype\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-embeddings_v1_embeddings_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - {} - ], - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-embeddings_v1_embeddings_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -EmbeddingResponseData","children":[{"label":"EmbeddingResponseData","linkedLabel":"EmbeddingResponseData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EmbeddingResponseData \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+data+embeddingresponsedata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### embedding \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+data+embeddingresponsedata+embedding\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+data+embeddingresponsedata+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -0 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+data+embeddingresponsedata+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -embedding -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-embeddings_v1_embeddings_post+responses+200+application-json+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-embeddings_v1_embeddings_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/files.mdx b/examples/docusaurus/docs/mistral/api/endpoint/files.mdx deleted file mode 100644 index 72b342b4c..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/files.mdx +++ /dev/null @@ -1,4333 +0,0 @@ ---- -sidebar_position: 3.11 -sidebar_label: Files ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Files Endpoints - - - - - -Files API - - - - - - - - - -## GET /v1/files \{#operation-files_api_routes_list_files\} - - - - - -_List Files_ - - - - - -Returns a list of files that belong to the user's organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-files_api_routes_list_files+responses-examples\} - - - - - -200 - - - - - -```json -{ - "data": [ - { - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" - } - ], - "object": "occaecat dolor sit", - "total": 56 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_list_files+responses\} - - - - - -200 - - - - - - - -OK - - - - - -FileSchema","children":[{"label":"FileSchema","linkedLabel":"FileSchema","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-files_api_routes_list_files+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FileSchema \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### bytes \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### filename \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mimetype \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+mimetype\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### num_lines \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+num_lines\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### purpose \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+purpose\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### sample_type \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+sample_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### signature \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+signature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### source \{#operation-files_api_routes_list_files+responses+200+application-json+data+fileschema+source\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### object \{#operation-files_api_routes_list_files+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### total \{#operation-files_api_routes_list_files+responses+200+application-json+total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -## POST /v1/files \{#operation-files_api_routes_upload_file\} - - - - - -_Upload File_ - - - - - -Upload a file that can be used across various endpoints. - -The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - -Please contact us if you need to increase these storage limits. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-files_api_routes_upload_file+request-examples\} - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-files_api_routes_upload_file+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#operation-files_api_routes_upload_file+request+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### File \{#operation-files_api_routes_upload_file+request+file+file\} - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### content \{#operation-files_api_routes_upload_file+request+file+file+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fileName \{#operation-files_api_routes_upload_file+request+file+file+filename\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### purpose \{#operation-files_api_routes_upload_file+request+purpose\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-files_api_routes_upload_file+responses-examples\} - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_upload_file+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes \{#operation-files_api_routes_upload_file+responses+200+application-json+bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-files_api_routes_upload_file+responses+200+application-json+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### filename \{#operation-files_api_routes_upload_file+responses+200+application-json+filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-files_api_routes_upload_file+responses+200+application-json+id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mimetype \{#operation-files_api_routes_upload_file+responses+200+application-json+mimetype\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### num_lines \{#operation-files_api_routes_upload_file+responses+200+application-json+num_lines\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-files_api_routes_upload_file+responses+200+application-json+object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### purpose \{#operation-files_api_routes_upload_file+responses+200+application-json+purpose\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### sample_type \{#operation-files_api_routes_upload_file+responses+200+application-json+sample_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### signature \{#operation-files_api_routes_upload_file+responses+200+application-json+signature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### source \{#operation-files_api_routes_upload_file+responses+200+application-json+source\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\} \{#operation-files_api_routes_retrieve_file\} - - - - - -_Retrieve File_ - - - - - -Returns information about a specific file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-files_api_routes_retrieve_file+parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_retrieve_file+parameters+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-files_api_routes_retrieve_file+responses-examples\} - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "deleted": false, - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_retrieve_file+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes \{#operation-files_api_routes_retrieve_file+responses+200+application-json+bytes\} - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-files_api_routes_retrieve_file+responses+200+application-json+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deleted \{#operation-files_api_routes_retrieve_file+responses+200+application-json+deleted\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### filename \{#operation-files_api_routes_retrieve_file+responses+200+application-json+filename\} - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-files_api_routes_retrieve_file+responses+200+application-json+id\} - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### mimetype \{#operation-files_api_routes_retrieve_file+responses+200+application-json+mimetype\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### num_lines \{#operation-files_api_routes_retrieve_file+responses+200+application-json+num_lines\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-files_api_routes_retrieve_file+responses+200+application-json+object\} - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### purpose \{#operation-files_api_routes_retrieve_file+responses+200+application-json+purpose\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### sample_type \{#operation-files_api_routes_retrieve_file+responses+200+application-json+sample_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### signature \{#operation-files_api_routes_retrieve_file+responses+200+application-json+signature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### source \{#operation-files_api_routes_retrieve_file+responses+200+application-json+source\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/files/\{file\_id\} \{#operation-files_api_routes_delete_file\} - - - - - -_Delete File_ - - - - - -Delete a file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-files_api_routes_delete_file+parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_delete_file+parameters+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-files_api_routes_delete_file+responses-examples\} - - - - - -200 - - - - - -```json -{ - "deleted": "false", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_delete_file+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### deleted \{#operation-files_api_routes_delete_file+responses+200+application-json+deleted\} - - - - - -The deletion status. - - - - - -_Example:_ - -``` -false -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-files_api_routes_delete_file+responses+200+application-json+id\} - - - - - -The ID of the deleted file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-files_api_routes_delete_file+responses+200+application-json+object\} - - - - - -The object type that was deleted - - - - - -_Example:_ - -``` -file -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\}/content \{#operation-files_api_routes_download_file\} - - - - - -_Download File_ - - - - - -Download a file - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-files_api_routes_download_file+parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_download_file+parameters+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-files_api_routes_download_file+responses-examples\} - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_download_file+responses\} - - - - - -200 - - - - - - - - - - - - - -OK - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\}/url \{#operation-files_api_routes_get_signed_url\} - - - - - -Get Signed Url - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-files_api_routes_get_signed_url+parameters\} - - - - - - - - - - - -##### file_id \{#operation-files_api_routes_get_signed_url+parameters+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### expiry \{#operation-files_api_routes_get_signed_url+parameters+expiry\} - - - - - -Number of hours before the url becomes invalid. Defaults to 24h - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-files_api_routes_get_signed_url+responses-examples\} - - - - - -200 - - - - - -```json -{ - "url": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-files_api_routes_get_signed_url+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### url \{#operation-files_api_routes_get_signed_url+responses+200+application-json+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/fim.mdx b/examples/docusaurus/docs/mistral/api/endpoint/fim.mdx deleted file mode 100644 index 1356018be..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/fim.mdx +++ /dev/null @@ -1,9538 +0,0 @@ ---- -sidebar_position: 3.12 -sidebar_label: Fim ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Fim Endpoints - - - - - -Fill-in-the-middle API. - - - - - - - - - -## POST /v1/fim/completions \{#operation-fim_completion_v1_fim_completions_post\} - - - - - -_Fim Completion_ - - - - - -FIM completion. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-fim_completion_v1_fim_completions_post+request-examples\} - - - - - -```json -{ - "prompt": "def" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-fim_completion_v1_fim_completions_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### max_tokens \{#operation-fim_completion_v1_fim_completions_post+request+max_tokens\} - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### min_tokens \{#operation-fim_completion_v1_fim_completions_post+request+min_tokens\} - - - - - -The minimum number of tokens to generate in the completion. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post+request+model\} - - - - - -ID of the model to use. Only compatible for now with: - - `codestral-2405` - - `codestral-latest` - - - - - -_Example:_ - -``` -codestral-2405 -``` - - - - - -_Default Value:_ `"codestral-2405"` - - - - - - - - - -##### prompt \{#operation-fim_completion_v1_fim_completions_post+request+prompt\} - - - - - -The text/code to complete. - - - - - -_Example:_ - -``` -def -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### random_seed \{#operation-fim_completion_v1_fim_completions_post+request+random_seed\} - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stop \{#operation-fim_completion_v1_fim_completions_post+request+stop\} - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### stream \{#operation-fim_completion_v1_fim_completions_post+request+stream\} - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### suffix \{#operation-fim_completion_v1_fim_completions_post+request+suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - -_Example:_ - -``` -return a+b -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### temperature \{#operation-fim_completion_v1_fim_completions_post+request+temperature\} - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_p \{#operation-fim_completion_v1_fim_completions_post+request+top_p\} - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-fim_completion_v1_fim_completions_post+responses-examples\} - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "codestral-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-fim_completion_v1_fim_completions_post+responses\} - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ChatCompletionChoice \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### finish_reason \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+finish_reason\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -stop -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -0 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### AssistantMessage \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+prefix\} - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+choices+chatcompletionchoice+message+assistantmessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -codestral-latest -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+application-json+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionResponseStreamChoice \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### DeltaMessage \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### closed \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+closed\} - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ReferenceChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### reference_ids \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk+reference_ids\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+referencechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### text \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk+text\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+thinking+textchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+thinkchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### input_audio \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk+input_audio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+content+audiochunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+role\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ToolCall \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FunctionCall \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### arguments \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall+arguments\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+function+functioncall+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+delta+deltamessage+tool_calls+toolcall+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+finish_reason\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### index \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+choices+completionresponsestreamchoice+index\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### UsageInfo \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### completion_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+completion_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+prompt_audio_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### prompt_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+prompt_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens \{#operation-fim_completion_v1_fim_completions_post+responses+200+text-event-stream+completionevent+data+completionchunk+usage+usageinfo+total_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-fim_completion_v1_fim_completions_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/fine-tuning.mdx b/examples/docusaurus/docs/mistral/api/endpoint/fine-tuning.mdx deleted file mode 100644 index 0f1de4958..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/fine-tuning.mdx +++ /dev/null @@ -1,39609 +0,0 @@ ---- -sidebar_position: 3.13 -sidebar_label: Fine Tuning ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Fine Tuning Endpoints - - - - - -Fine-tuning API - - - - - - - - - -## GET /v1/fine\_tuning/jobs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs\} - - - - - -_Get Fine Tuning Jobs_ - - - - - -Get a list of fine-tuning jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses-examples\} - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses\} - - - - - -200 - - - - - - - -OK - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+hyperparameters+completiontrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+id\} - - - - - -The ID of the job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+object\} - - - - - -The object type of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+commit_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+repositories+githubrepositoryout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+status\} - - - - - -The current status of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+completionjobout+validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+hyperparameters+classifiertrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+id\} - - - - - -The ID of the job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+object\} - - - - - -The object type of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+status\} - - - - - -The current status of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+data+classifierjobout+validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs+responses+200+application-json+total\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/jobs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job\} - - - - - -_Create Fine Tuning Job_ - - - - - -Create a new fine-tuning job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+parameters\} - - - - - - - - - - - -##### dry_run \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+parameters+dry_run\} - - - - - -* If `true` the job is not spawned, instead the query returns a handful of useful metadata - for the user to perform sanity checks (see `LegacyJobMetadataOut` response). -* Otherwise, the job is started and the query returns the job ID along with some of the - input parameters (see `JobOut` response). - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request-examples\} - - - - - -```json -{ - "hyperparameters": {}, - "model": "ministral-3b-latest" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+auto_start\} - - - - - -This field will be required in a future release. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTargetIn","children":[{"label":"ClassifierTargetIn","linkedLabel":"ClassifierTargetIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTargetIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets+classifiertargetin\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets+classifiertargetin+labels\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets+classifiertargetin+loss_function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets+classifiertargetin+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+classifier_targets+classifiertargetin+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - -CompletionTrainingParametersIn","children":[],"breakoutSubTypes":{}},{"label":"ClassifierTrainingParametersIn","linkedLabel":"ClassifierTrainingParametersIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParametersIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin\} - - - - - -The fine-tuning hyperparameter settings used in a fine-tune job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+learning_rate\} - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+warmup_fraction\} - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+completiontrainingparametersin+weight_decay\} - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierTrainingParametersIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin\} - - - - - -The fine-tuning hyperparameter settings used in a classifier fine-tune job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+learning_rate\} - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+warmup_fraction\} - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+hyperparameters+classifiertrainingparametersin+weight_decay\} - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -WandbIntegration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations\} - - - - - -A list of integrations to enable for your fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegration \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### api_key \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration+api_key\} - - - - - -The WandB API key to use for authentication. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+integrations+wandbintegration+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - - - - - - - - - -##### invalid_sample_skip_percentage \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+invalid_sample_skip_percentage\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0` - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -GithubRepositoryIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryIn \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### token \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+token\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+repositories+githubrepositoryin+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+suffix\} - - - - - -A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -TrainingFile","children":[{"label":"TrainingFile","linkedLabel":"TrainingFile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### TrainingFile \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+training_files+trainingfile\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+training_files+trainingfile+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+training_files+trainingfile+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+request+validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses\} - - - - - -200 - - - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"LegacyJobMetadataOut","linkedLabel":"LegacyJobMetadataOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionJobOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+hyperparameters+completiontrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+id\} - - - - - -The ID of the job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+object\} - - - - - -The object type of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+commit_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+repositories+githubrepositoryout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+status\} - - - - - -The current status of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+completionjobout+validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierJobOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+fine_tuned_model\} - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+hyperparameters+classifiertrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+id\} - - - - - -The ID of the job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations\} - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+job_type\} - - - - - -The type of job (`FT` for fine-tuning). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+modified_at\} - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+object\} - - - - - -The object type of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+status\} - - - - - -The current status of the fine-tuning job. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+suffix\} - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+trained_tokens\} - - - - - -Total number of tokens trained. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+training_files\} - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+classifierjobout+validation_files\} - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### LegacyJobMetadataOut \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+cost\} - - - - - -The cost of the fine-tuning job. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+cost_currency\} - - - - - -The currency used for the fine-tuning job cost. - - - - - -_Example:_ - -``` -EUR -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+data_tokens\} - - - - - -The total number of tokens in the training dataset. - - - - - -_Example:_ - -``` -305375 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecated \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+deprecated\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### details \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+details\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+epochs\} - - - - - -The number of complete passes through the entire training dataset. - - - - - -_Example:_ - -``` -4.2922 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+expected_duration_seconds\} - - - - - -The approximated time (in seconds) for the fine-tuning process to complete. - - - - - -_Example:_ - -``` -220 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job.metadata"` - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+train_tokens\} - - - - - -The total number of tokens used during the fine-tuning process. - - - - - -_Example:_ - -``` -1310720 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+train_tokens_per_step\} - - - - - -The number of tokens consumed by one training step. - - - - - -_Example:_ - -``` -131072 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job+responses+200+application-json+legacyjobmetadataout+training_steps\} - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/fine\_tuning/jobs/\{job\_id\} \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job\} - - - - - -_Get Fine Tuning Job_ - - - - - -Get a fine-tuned job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+parameters+job_id\} - - - - - -The ID of the job to analyse. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+commit_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+completiondetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+labels\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+loss_function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/cancel \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job\} - - - - - -_Cancel Fine Tuning Job_ - - - - - -Request the cancellation of a fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+parameters+job_id\} - - - - - -The ID of the job to cancel. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+commit_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+completiondetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+labels\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+loss_function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job\} - - - - - -_Start Fine Tuning Job_ - - - - - -Request the start of a validated fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+parameters\} - - - - - - - - - - - -##### job_id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+parameters+job_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses-examples\} - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses\} - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CompletionTrainingParameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### fim_ratio \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+fim_ratio\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+hyperparameters+completiontrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### GithubRepositoryOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### commit_id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+commit_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### owner \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+owner\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### ref \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+ref\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+repositories+githubrepositoryout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+completiondetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierDetailedJobOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### auto_start \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+auto_start\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### CheckpointOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+created_at\} - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### MetricOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout\} - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+train_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_loss \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_loss\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### valid_mean_token_accuracy \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+metrics+metricout+valid_mean_token_accuracy\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### step_number \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+checkpoints+checkpointout+step_number\} - - - - - -The step number that the checkpoint was created at. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+labels\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+loss_function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+classifier_targets+classifiertargetout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+created_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events\} - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### EventOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### created_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+created_at\} - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+events+eventout+name\} - - - - - -The name of the event. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### fine_tuned_model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+fine_tuned_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTrainingParameters \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### epochs \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+epochs\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### learning_rate \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+learning_rate\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+seq_len\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_steps \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+training_steps\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### warmup_fraction \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+warmup_fraction\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight_decay \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+hyperparameters+classifiertrainingparameters+weight_decay\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### WandbIntegrationOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+name\} - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### project \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+project\} - - - - - -The name of the project that the new run will be created under. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### run_name \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+run_name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+integrations+wandbintegrationout+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### job_type \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+job_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JobMetadataOut \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### cost_currency \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+cost_currency\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### data_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+data_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### estimated_start_time \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+estimated_start_time\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### expected_duration_seconds \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+expected_duration_seconds\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### train_tokens_per_step \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+metadata+jobmetadataout+train_tokens_per_step\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### model \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+model\} - - - - - -The name of the model to fine-tune. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### modified_at \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+modified_at\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+status\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### suffix \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+suffix\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### trained_tokens \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+trained_tokens\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### training_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+training_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### validation_files \{#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job+responses+200+application-json+classifierdetailedjobout+validation_files\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/models.mdx b/examples/docusaurus/docs/mistral/api/endpoint/models.mdx deleted file mode 100644 index 856c0a113..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/models.mdx +++ /dev/null @@ -1,13135 +0,0 @@ ---- -sidebar_position: 3.14 -sidebar_label: Models ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Models Endpoints - - - - - -Model Management API - - - - - - - - - -## GET /v1/models \{#operation-list_models_v1_models_get\} - - - - - -_List Models_ - - - - - -List all models available to the user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples \{#operation-list_models_v1_models_get+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-list_models_v1_models_get+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data \{#operation-list_models_v1_models_get+responses+200+application-json+data\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### BaseModelCard \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModelCapabilities \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+capabilities+modelcapabilities+vision\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### default_model_temperature \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+default_model_temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+deprecation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation_replacement_model \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+deprecation_replacement_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type \{#operation-list_models_v1_models_get+responses+200+application-json+data+basemodelcard+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard\} - - - - - -Extra fields for fine-tuned models. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### archived \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModelCapabilities \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+capabilities+modelcapabilities+vision\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### default_model_temperature \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+default_model_temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+deprecation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation_replacement_model \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+deprecation_replacement_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### job \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+job\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+root\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-list_models_v1_models_get+responses+200+application-json+data+ftmodelcard+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - - - -##### object \{#operation-list_models_v1_models_get+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"list"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-list_models_v1_models_get+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-list_models_v1_models_get+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-list_models_v1_models_get+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-list_models_v1_models_get+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-list_models_v1_models_get+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-list_models_v1_models_get+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-list_models_v1_models_get+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-list_models_v1_models_get+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-list_models_v1_models_get+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/models/\{model\_id\} \{#operation-retrieve_model_v1_models_model_id_get\} - - - - - -_Retrieve Model_ - - - - - -Retrieve information about a model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-retrieve_model_v1_models_model_id_get+parameters\} - - - - - - - - - - - -##### model_id \{#operation-retrieve_model_v1_models_model_id_get+parameters+model_id\} - - - - - -The ID of the model to retrieve. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-retrieve_model_v1_models_model_id_get+responses-examples\} - - - - - -200 - - - - - -```json -{ - "capabilities": {}, - "id": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-retrieve_model_v1_models_model_id_get+responses\} - - - - - -200 - - - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### BaseModelCard \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModelCapabilities \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+capabilities+modelcapabilities+vision\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### default_model_temperature \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+default_model_temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+deprecation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation_replacement_model \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+deprecation_replacement_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+basemodelcard+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard\} - - - - - -Extra fields for fine-tuned models. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### archived \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ModelCapabilities \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+capabilities+modelcapabilities+vision\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### default_model_temperature \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+default_model_temperature\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+deprecation\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### deprecation_replacement_model \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+deprecation_replacement_model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### job \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+job\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+root\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get+responses+200+application-json+ftmodelcard+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-retrieve_model_v1_models_model_id_get+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/models/\{model\_id\} \{#operation-delete_model_v1_models_model_id_delete\} - - - - - -_Delete Model_ - - - - - -Delete a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-delete_model_v1_models_model_id_delete+parameters\} - - - - - - - - - - - -##### model_id \{#operation-delete_model_v1_models_model_id_delete+parameters+model_id\} - - - - - -The ID of the model to delete. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-delete_model_v1_models_model_id_delete+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ft:open-mistral-7b:587a6b29:20240514:7e773925" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-delete_model_v1_models_model_id_delete+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### deleted \{#operation-delete_model_v1_models_model_id_delete+responses+200+application-json+deleted\} - - - - - -The deletion status - - - - - -_Example:_ - -``` -true -``` - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id \{#operation-delete_model_v1_models_model_id_delete+responses+200+application-json+id\} - - - - - -The ID of the deleted model. - - - - - -_Example:_ - -``` -ft:open-mistral-7b:587a6b29:20240514:7e773925 -``` - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-delete_model_v1_models_model_id_delete+responses+200+application-json+object\} - - - - - -The object type that was deleted - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-delete_model_v1_models_model_id_delete+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/fine\_tuning/models/\{model\_id\} \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model\} - - - - - -_Update Fine Tuned Model_ - - - - - -Update a model name or description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+parameters+model_id\} - - - - - -The ID of the model to update. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+request-examples\} - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+request+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+request+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses-examples\} - - - - - -200 - - - - - -```json -{ - "archived": false, - "capabilities": {}, - "created": 87, - "id": "ipsum eiusmod", - "job": "consequat do", - "owned_by": "reprehenderit ut dolore", - "root": "occaecat dolor sit", - "root_version": "nostrud", - "workspace_id": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses\} - - - - - -200 - - - - - - - -CompletionFTModelOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierFTModelOut","linkedLabel":"ClassifierFTModelOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionFTModelOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FTModelCapabilitiesOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+capabilities+ftmodelcapabilitiesout+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### job \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+job\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+model_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"completion"` - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### root \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+root\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### root_version \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+root_version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### workspace_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+completionftmodelout+workspace_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -#### ClassifierFTModelOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### aliases \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+aliases\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FTModelCapabilitiesOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### classification \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout+classification\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout+completion_chat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout+completion_fim\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout+fine_tuning\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+capabilities+ftmodelcapabilitiesout+function_calling\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ClassifierTargetOut \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets+classifiertargetout\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### labels \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets+classifiertargetout+labels\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loss_function \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets+classifiertargetout+loss_function\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets+classifiertargetout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### weight \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+classifier_targets+classifiertargetout+weight\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### created \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+created\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### job \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+job\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### max_context_length \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+max_context_length\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+model_type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"classifier"` - - - - - - - - - -##### name \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+owned_by\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### root \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+root\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### root_version \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+root_version\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### workspace_id \{#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model+responses+200+application-json+classifierftmodelout+workspace_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/models/\{model\_id\}/archive \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model\} - - - - - -_Archive Fine Tuned Model_ - - - - - -Archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+parameters+model_id\} - - - - - -The ID of the model to archive. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+responses+200+application-json+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/fine\_tuning/models/\{model\_id\}/archive \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model\} - - - - - -_Unarchive Fine Tuned Model_ - - - - - -Un-archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+parameters\} - - - - - - - - - - - -##### model_id \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+parameters+model_id\} - - - - - -The ID of the model to unarchive. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+responses\} - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+responses+200+application-json+archived\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - -##### id \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+responses+200+application-json+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### object \{#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model+responses+200+application-json+object\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/endpoint/ocr.mdx b/examples/docusaurus/docs/mistral/api/endpoint/ocr.mdx deleted file mode 100644 index dc5ad2783..000000000 --- a/examples/docusaurus/docs/mistral/api/endpoint/ocr.mdx +++ /dev/null @@ -1,4903 +0,0 @@ ---- -sidebar_position: 3.15 -sidebar_label: Ocr ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - CodeSampleTab, - CodeSampleTabbedSection, - DebugPlaceholder, - ExpandableBreakout, - ExpandableBreakoutDefaultValue, - ExpandableBreakoutDescription, - ExpandableBreakoutExamples, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Ocr Endpoints - - - - - -OCR API - - - - - - - - - -## POST /v1/ocr \{#operation-ocr_v1_ocr_post\} - - - - - -OCR - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example \{#operation-ocr_v1_ocr_post+request-examples\} - - - - - -```json -{ - "document": { - "file_id": "ipsum eiusmod" - }, - "model": null -} -``` - - - -
    - -     - - - -
    - - - -### Request Body \{#operation-ocr_v1_ocr_post+request\} - - - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### bbox_annotation_format \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+request+bbox_annotation_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -FileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document \{#operation-ocr_v1_ocr_post+request+document\} - - - - - -Document to run OCR on - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### FileChunk \{#operation-ocr_v1_ocr_post+request+document+filechunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### file_id \{#operation-ocr_v1_ocr_post+request+document+filechunk+file_id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+request+document+filechunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### DocumentURLChunk \{#operation-ocr_v1_ocr_post+request+document+documenturlchunk\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_name \{#operation-ocr_v1_ocr_post+request+document+documenturlchunk+document_name\} - - - - - -The filename of the document - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### document_url \{#operation-ocr_v1_ocr_post+request+document+documenturlchunk+document_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+request+document+documenturlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ImageURLChunk \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk\} - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk+image_url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ImageURL \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk+image_url+imageurl\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### detail \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk+image_url+imageurl+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### url \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk+image_url+imageurl+url\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+request+document+imageurlchunk+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document_annotation_format \{#operation-ocr_v1_ocr_post+request+document_annotation_format\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ResponseFormat \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### JsonSchema \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema+jsonschema\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### description \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema+jsonschema+description\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### name \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema+jsonschema+name\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### schema_definition \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema+jsonschema+schema_definition\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### strict \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+json_schema+jsonschema+strict\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+request+document_annotation_format+responseformat+type\} - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### id \{#operation-ocr_v1_ocr_post+request+id\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### image_limit \{#operation-ocr_v1_ocr_post+request+image_limit\} - - - - - -Max images to extract - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### image_min_size \{#operation-ocr_v1_ocr_post+request+image_min_size\} - - - - - -Minimum height and width of image to extract - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### include_image_base64 \{#operation-ocr_v1_ocr_post+request+include_image_base64\} - - - - - -Include image URLs in response - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-ocr_v1_ocr_post+request+model\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### pages \{#operation-ocr_v1_ocr_post+request+pages\} - - - - - -Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-ocr_v1_ocr_post+responses-examples\} - - - - - -200 - - - - - -```json -{ - "model": "ipsum eiusmod", - "pages": [ - { - "dimensions": null, - "images": [ - { - "bottom_right_x": null, - "bottom_right_y": null, - "id": "consequat do", - "top_left_x": null, - "top_left_y": null - } - ], - "index": 87, - "markdown": "reprehenderit ut dolore" - } - ], - "usage_info": { - "pages_processed": 14 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-ocr_v1_ocr_post+responses\} - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_annotation \{#operation-ocr_v1_ocr_post+responses+200+application-json+document_annotation\} - - - - - -Formatted response in the request_format if provided in json str - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### model \{#operation-ocr_v1_ocr_post+responses+200+application-json+model\} - - - - - -The model used to generate the OCR. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -OCRPageObject","children":[{"label":"OCRPageObject","linkedLabel":"OCRPageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pages \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages\} - - - - - -List of OCR info for pages. - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### OCRPageObject \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - -OCRPageDimensions","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### dimensions \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+dimensions\} - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### OCRPageDimensions \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+dimensions+ocrpagedimensions\} - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### dpi \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+dimensions+ocrpagedimensions+dpi\} - - - - - -Dots per inch of the page-image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### height \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+dimensions+ocrpagedimensions+height\} - - - - - -Height of the image in pixels - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### width \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+dimensions+ocrpagedimensions+width\} - - - - - -Width of the image in pixels - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -OCRImageObject","children":[{"label":"OCRImageObject","linkedLabel":"OCRImageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### images \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images\} - - - - - -List of all extracted images in the page - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### OCRImageObject \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### bottom_right_x \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+bottom_right_x\} - - - - - -X coordinate of bottom-right corner of the extracted image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### bottom_right_y \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+bottom_right_y\} - - - - - -Y coordinate of bottom-right corner of the extracted image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### id \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+id\} - - - - - -Image ID for extracted image in a page - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### image_annotation \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+image_annotation\} - - - - - -Annotation of the extracted image in json str - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### image_base64 \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+image_base64\} - - - - - -Base64 string of the extracted image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_left_x \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+top_left_x\} - - - - - -X coordinate of top-left corner of the extracted image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### top_left_y \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+images+ocrimageobject+top_left_y\} - - - - - -Y coordinate of top-left corner of the extracted image - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - -##### index \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+index\} - - - - - -The page index in a pdf document starting from 0 - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### markdown \{#operation-ocr_v1_ocr_post+responses+200+application-json+pages+ocrpageobject+markdown\} - - - - - -The markdown string response of the page - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -OCRUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage_info \{#operation-ocr_v1_ocr_post+responses+200+application-json+usage_info\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### OCRUsageInfo \{#operation-ocr_v1_ocr_post+responses+200+application-json+usage_info+ocrusageinfo\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### doc_size_bytes \{#operation-ocr_v1_ocr_post+responses+200+application-json+usage_info+ocrusageinfo+doc_size_bytes\} - - - - - -Document size in bytes - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### pages_processed \{#operation-ocr_v1_ocr_post+responses+200+application-json+usage_info+ocrusageinfo+pages_processed\} - - - - - -Number of pages processed - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta \{#operation-ocr_v1_ocr_post+responses+422+application-json+httpmeta\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### HTTPMetadata \{#operation-ocr_v1_ocr_post+responses+422+application-json+httpmeta+httpmetadata\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Request \{#operation-ocr_v1_ocr_post+responses+422+application-json+httpmeta+httpmetadata+request\} - - - - - -Raw HTTP request; suitable for debugging - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### Response \{#operation-ocr_v1_ocr_post+responses+422+application-json+httpmeta+httpmetadata+response\} - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail \{#operation-ocr_v1_ocr_post+responses+422+application-json+detail\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -#### ValidationError \{#operation-ocr_v1_ocr_post+responses+422+application-json+detail+validationerror\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### loc \{#operation-ocr_v1_ocr_post+responses+422+application-json+detail+validationerror+loc\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### msg \{#operation-ocr_v1_ocr_post+responses+422+application-json+detail+validationerror+msg\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - -##### type \{#operation-ocr_v1_ocr_post+responses+422+application-json+detail+validationerror+type\} - - - - - - - -No description provided - -_OpenAPI example:_ - -``` -description: My awesome description -``` - - - - - - - - - -No examples provided - -_OpenAPI example:_ - -``` -examples: - - MyExampleValue -``` - - - - - - - - - -No default value provided - -_OpenAPI example:_ - -``` -defaultValue: MyDefaultValue -``` - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/mistral/api/index.mdx b/examples/docusaurus/docs/mistral/api/index.mdx deleted file mode 100644 index 4f5bc2ad4..000000000 --- a/examples/docusaurus/docs/mistral/api/index.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: About ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - DebugPlaceholder, - Pill -} from "@speakeasy-api/docs-md-react"; - -# About Mistral AI API - -_Version: 1.0.0_ - -Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -Servers - -- https://api.mistral.ai - -## Global Security - -### ApiKey bearer http \{#ApiKey\} - - - -No description provided - -_OpenAPI example:_ - -``` -securitySchemes: - APIKey: - description: My API key description -``` - - \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/_category_.json b/examples/docusaurus/docs/pokeapi/api/_category_.json deleted file mode 100644 index 99bb6e4fd..000000000 --- a/examples/docusaurus/docs/pokeapi/api/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 2, - "label": "API Reference", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/_category_.json b/examples/docusaurus/docs/pokeapi/api/endpoint/_category_.json deleted file mode 100644 index 180b4a4cb..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "position": 3, - "label": "Operations", - "collapsible": true, - "collapsed": false -} \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/berries.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/berries.mdx deleted file mode 100644 index 6ebf001d8..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/berries.mdx +++ /dev/null @@ -1,2976 +0,0 @@ ---- -sidebar_position: 3.0 -sidebar_label: Berries ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Berries Endpoints - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -## GET /api/v2/berry/ \{#operation-api_v2_berry_list\} - - - - - -_List berries_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_list+responses+200+application-json+results\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_berry_list+responses+200+application-json+results+berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_list+responses+200+application-json+results+berrysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_list+responses+200+application-json+results+berrysummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry/\{id\}/ \{#operation-api_v2_berry_retrieve\} - - - - - -_Get a berry_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "firmness": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "flavors": [ - { - "flavor": {}, - "potency": "10" - } - ], - "growth_time": 14, - "id": 56, - "item": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "max_harvest": 91, - "name": "nostrud", - "natural_gift_power": 32, - "natural_gift_type": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "size": 78, - "smoothness": 5, - "soil_dryness": 69 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_retrieve+responses\} - - - - - -200 - - - - - - - -BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### firmness \{#operation-api_v2_berry_retrieve+responses+200+application-json+firmness\} - - - - - - - - - -#### BerryFirmnessSummary \{#operation-api_v2_berry_retrieve+responses+200+application-json+firmness+berryfirmnesssummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve+responses+200+application-json+firmness+berryfirmnesssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve+responses+200+application-json+firmness+berryfirmnesssummary+url\} - - - - - - - - - - - - - -flavor","children":[{"label":"flavor","linkedLabel":"flavor","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavors \{#operation-api_v2_berry_retrieve+responses+200+application-json+flavors\} - - - - - - - - - -#### flavor \{#operation-api_v2_berry_retrieve+responses+200+application-json+flavors+flavor\} - - - - - - - - - -##### potency \{#operation-api_v2_berry_retrieve+responses+200+application-json+flavors+flavor+potency\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### growth_time \{#operation-api_v2_berry_retrieve+responses+200+application-json+growth_time\} - - - - - - - - - -##### id \{#operation-api_v2_berry_retrieve+responses+200+application-json+id\} - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item \{#operation-api_v2_berry_retrieve+responses+200+application-json+item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_berry_retrieve+responses+200+application-json+item+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve+responses+200+application-json+item+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve+responses+200+application-json+item+itemsummary+url\} - - - - - - - - - - - - - - - - - -##### max_harvest \{#operation-api_v2_berry_retrieve+responses+200+application-json+max_harvest\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve+responses+200+application-json+name\} - - - - - - - - - -##### natural_gift_power \{#operation-api_v2_berry_retrieve+responses+200+application-json+natural_gift_power\} - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### natural_gift_type \{#operation-api_v2_berry_retrieve+responses+200+application-json+natural_gift_type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_berry_retrieve+responses+200+application-json+natural_gift_type+typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_retrieve+responses+200+application-json+natural_gift_type+typesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_retrieve+responses+200+application-json+natural_gift_type+typesummary+url\} - - - - - - - - - - - - - - - - - -##### size \{#operation-api_v2_berry_retrieve+responses+200+application-json+size\} - - - - - - - - - -##### smoothness \{#operation-api_v2_berry_retrieve+responses+200+application-json+smoothness\} - - - - - - - - - -##### soil_dryness \{#operation-api_v2_berry_retrieve+responses+200+application-json+soil_dryness\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-firmness/ \{#operation-api_v2_berry_firmness_list\} - - - - - -_List berry firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_firmness_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_firmness_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_firmness_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_firmness_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_firmness_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_firmness_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_firmness_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_firmness_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_firmness_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_firmness_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_firmness_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_firmness_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFirmnessSummary","children":[{"label":"BerryFirmnessSummary","linkedLabel":"BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_firmness_list+responses+200+application-json+results\} - - - - - - - - - -#### BerryFirmnessSummary \{#operation-api_v2_berry_firmness_list+responses+200+application-json+results+berryfirmnesssummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_list+responses+200+application-json+results+berryfirmnesssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_list+responses+200+application-json+results+berryfirmnesssummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-firmness/\{id\}/ \{#operation-api_v2_berry_firmness_retrieve\} - - - - - -_Get berry by firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_firmness_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_firmness_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_firmness_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_firmness_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_firmness_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_firmness_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_firmness_retrieve+responses\} - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+berries\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+berries+berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+berries+berrysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+berries+berrysummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+name\} - - - - - -BerryFirmnessName","children":[{"label":"BerryFirmnessName","linkedLabel":"BerryFirmnessName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### BerryFirmnessName \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_berry_firmness_retrieve+responses+200+application-json+names+berryfirmnessname+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-flavor/ \{#operation-api_v2_berry_flavor_list\} - - - - - -_List berry flavors_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_flavor_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_flavor_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_flavor_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_flavor_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_berry_flavor_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_berry_flavor_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_berry_flavor_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_flavor_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_flavor_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_berry_flavor_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_berry_flavor_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_berry_flavor_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFlavorSummary","children":[{"label":"BerryFlavorSummary","linkedLabel":"BerryFlavorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_berry_flavor_list+responses+200+application-json+results\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_berry_flavor_list+responses+200+application-json+results+berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_list+responses+200+application-json+results+berryflavorsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_list+responses+200+application-json+results+berryflavorsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-flavor/\{id\}/ \{#operation-api_v2_berry_flavor_retrieve\} - - - - - -_Get berries by flavor_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_berry_flavor_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_berry_flavor_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_berry_flavor_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_berry_flavor_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_berry_flavor_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_berry_flavor_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "berry": {}, - "potency": "10" - } - ], - "contest_type": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 14, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_berry_flavor_retrieve+responses\} - - - - - -200 - - - - - - - -berry","children":[{"label":"berry","linkedLabel":"berry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+berries\} - - - - - - - - - -#### berry \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+berries+berry\} - - - - - - - - - -##### potency \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+berries+berry+potency\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+contest_type\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+contest_type+contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+contest_type+contesttypesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+contest_type+contesttypesummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+name\} - - - - - -BerryFlavorName","children":[{"label":"BerryFlavorName","linkedLabel":"BerryFlavorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### BerryFlavorName \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_berry_flavor_retrieve+responses+200+application-json+names+berryflavorname+name\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/contests.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/contests.mdx deleted file mode 100644 index 99473c8c5..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/contests.mdx +++ /dev/null @@ -1,2695 +0,0 @@ ---- -sidebar_position: 3.1 -sidebar_label: Contests ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Contests Endpoints - - - - - - - - - -## GET /api/v2/contest-type/ \{#operation-api_v2_contest_type_list\} - - - - - -_List contest types_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_contest_type_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_type_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_type_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_contest_type_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_contest_type_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_contest_type_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_contest_type_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_contest_type_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_type_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_contest_type_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_contest_type_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_contest_type_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestTypeSummary","children":[{"label":"ContestTypeSummary","linkedLabel":"ContestTypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_contest_type_list+responses+200+application-json+results\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_contest_type_list+responses+200+application-json+results+contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_list+responses+200+application-json+results+contesttypesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_type_list+responses+200+application-json+results+contesttypesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-type/\{id\}/ \{#operation-api_v2_contest_type_retrieve\} - - - - - -_Get contest type_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_contest_type_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_type_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_type_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_contest_type_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_contest_type_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_contest_type_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "berry_flavor": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "color": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_type_retrieve+responses\} - - - - - -200 - - - - - - - -berry_flavor","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berry_flavor \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+berry_flavor\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+name\} - - - - - -ContestTypeName","children":[{"label":"ContestTypeName","linkedLabel":"ContestTypeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### ContestTypeName \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename\} - - - - - - - - - -##### color \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+color\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_contest_type_retrieve+responses+200+application-json+names+contesttypename+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-effect/ \{#operation-api_v2_contest_effect_list\} - - - - - -_List contest effects_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - -
    - - - -### Security \{#operation-api_v2_contest_effect_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_effect_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_effect_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_contest_effect_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_contest_effect_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_contest_effect_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_contest_effect_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_contest_effect_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_effect_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_contest_effect_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_contest_effect_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_contest_effect_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestEffectSummary","children":[{"label":"ContestEffectSummary","linkedLabel":"ContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_contest_effect_list+responses+200+application-json+results\} - - - - - - - - - -#### ContestEffectSummary \{#operation-api_v2_contest_effect_list+responses+200+application-json+results+contesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_list+responses+200+application-json+results+contesteffectsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-effect/\{id\}/ \{#operation-api_v2_contest_effect_retrieve\} - - - - - -_Get contest effect_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - -
    - - - -### Security \{#operation-api_v2_contest_effect_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_contest_effect_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_contest_effect_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_contest_effect_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_contest_effect_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_contest_effect_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "flavor_text_entries": [ - { - "flavor_text": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - } - ], - "id": 14, - "jam": 56 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_contest_effect_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### appeal \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+appeal\} - - - - - -ContestEffectEffectText","children":[{"label":"ContestEffectEffectText","linkedLabel":"ContestEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries\} - - - - - - - - - -#### ContestEffectEffectText \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext+effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+effect_entries+contesteffecteffecttext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - -ContestEffectFlavorText","children":[{"label":"ContestEffectFlavorText","linkedLabel":"ContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### ContestEffectFlavorText \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext+flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+contesteffectflavortext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### jam \{#operation-api_v2_contest_effect_retrieve+responses+200+application-json+jam\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/super-contest-effect/ \{#operation-api_v2_super_contest_effect_list\} - - - - - -_List super contest effects_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - -
    - - - -### Security \{#operation-api_v2_super_contest_effect_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_super_contest_effect_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_super_contest_effect_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_super_contest_effect_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_super_contest_effect_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_super_contest_effect_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_super_contest_effect_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_super_contest_effect_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_super_contest_effect_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -SuperContestEffectSummary","children":[{"label":"SuperContestEffectSummary","linkedLabel":"SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+results\} - - - - - - - - - -#### SuperContestEffectSummary \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+results+supercontesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_list+responses+200+application-json+results+supercontesteffectsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/super-contest-effect/\{id\}/ \{#operation-api_v2_super_contest_effect_retrieve\} - - - - - -_Get super contest effect_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - -
    - - - -### Security \{#operation-api_v2_super_contest_effect_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_super_contest_effect_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_super_contest_effect_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_super_contest_effect_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_super_contest_effect_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_super_contest_effect_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "flavor_text_entries": [ - { - "flavor_text": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 14, - "moves": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_super_contest_effect_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### appeal \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+appeal\} - - - - - -SuperContestEffectFlavorText","children":[{"label":"SuperContestEffectFlavorText","linkedLabel":"SuperContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### SuperContestEffectFlavorText \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext+flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+flavor_text_entries+supercontesteffectflavortext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+moves+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+moves+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_super_contest_effect_retrieve+responses+200+application-json+moves+movesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/encounters.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/encounters.mdx deleted file mode 100644 index bdfad1051..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/encounters.mdx +++ /dev/null @@ -1,3244 +0,0 @@ ---- -sidebar_position: 3.2 -sidebar_label: Encounters ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Encounters Endpoints - - - - - - - - - -## GET /api/v2/encounter-method/ \{#operation-api_v2_encounter_method_list\} - - - - - -_List encounter methods_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_method_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_method_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_method_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_method_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_method_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_method_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_method_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_method_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_method_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_method_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_method_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_method_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterMethodSummary","children":[{"label":"EncounterMethodSummary","linkedLabel":"EncounterMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_method_list+responses+200+application-json+results\} - - - - - - - - - -#### EncounterMethodSummary \{#operation-api_v2_encounter_method_list+responses+200+application-json+results+encountermethodsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_list+responses+200+application-json+results+encountermethodsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_method_list+responses+200+application-json+results+encountermethodsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-method/\{id\}/ \{#operation-api_v2_encounter_method_retrieve\} - - - - - -_Get encounter method_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_method_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_method_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_method_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_method_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_method_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_method_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_method_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+name\} - - - - - -EncounterMethodName","children":[{"label":"EncounterMethodName","linkedLabel":"EncounterMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### EncounterMethodName \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+names+encountermethodname+name\} - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_encounter_method_retrieve+responses+200+application-json+order\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition/ \{#operation-api_v2_encounter_condition_list\} - - - - - -_List encounter conditions_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_condition_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_condition_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_condition_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_condition_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_condition_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_condition_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_condition_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_condition_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionSummary","children":[{"label":"EncounterConditionSummary","linkedLabel":"EncounterConditionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_condition_list+responses+200+application-json+results\} - - - - - - - - - -#### EncounterConditionSummary \{#operation-api_v2_encounter_condition_list+responses+200+application-json+results+encounterconditionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_list+responses+200+application-json+results+encounterconditionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_list+responses+200+application-json+results+encounterconditionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition/\{id\}/ \{#operation-api_v2_encounter_condition_retrieve\} - - - - - -_Get encounter condition_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_condition_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_condition_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "values": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+name\} - - - - - -EncounterConditionName","children":[{"label":"EncounterConditionName","linkedLabel":"EncounterConditionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### EncounterConditionName \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+names+encounterconditionname+name\} - - - - - - - - - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### values \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+values\} - - - - - - - - - -#### EncounterConditionValueSummary \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+values+encounterconditionvaluesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+values+encounterconditionvaluesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_retrieve+responses+200+application-json+values+encounterconditionvaluesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition-value/ \{#operation-api_v2_encounter_condition_value_list\} - - - - - -_List encounter condition values_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_condition_value_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_value_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_value_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_condition_value_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_encounter_condition_value_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_encounter_condition_value_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_encounter_condition_value_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_value_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_value_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+results\} - - - - - - - - - -#### EncounterConditionValueSummary \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+results+encounterconditionvaluesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+results+encounterconditionvaluesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_list+responses+200+application-json+results+encounterconditionvaluesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition-value/\{id\}/ \{#operation-api_v2_encounter_condition_value_retrieve\} - - - - - -_Get encounter condition value_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - -
    - - - -### Security \{#operation-api_v2_encounter_condition_value_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_encounter_condition_value_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_encounter_condition_value_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_encounter_condition_value_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_value_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_encounter_condition_value_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "condition": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_encounter_condition_value_retrieve+responses\} - - - - - -200 - - - - - - - -EncounterConditionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### condition \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+condition\} - - - - - - - - - -#### EncounterConditionSummary \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+condition+encounterconditionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+condition+encounterconditionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+condition+encounterconditionsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+name\} - - - - - -EncounterConditionValueName","children":[{"label":"EncounterConditionValueName","linkedLabel":"EncounterConditionValueName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### EncounterConditionValueName \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_encounter_condition_value_retrieve+responses+200+application-json+names+encounterconditionvaluename+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/\{pokemon\_id\}/encounters \{#operation-api_v2_pokemon_encounters_retrieve\} - - - - - -_Get pokemon encounter_ - - - - - -Handles Pokemon Encounters as a sub-resource. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_encounters_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_encounters_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_encounters_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_encounters_retrieve+parameters\} - - - - - - - - - - - -##### pokemon_id \{#operation-api_v2_pokemon_encounters_retrieve+parameters+pokemon_id\} - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_encounters_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -[ - { - "location_area": { - "name": "cerulean-city-area", - "url": "https://pokeapi.co/api/v2/location-area/281/" - }, - "version_details": [ - { - "encounter_details": [ - { - "chance": "100", - "condition_values": [ - { - "name": "story-progress-beat-red", - "url": "https://pokeapi.co/api/v2/encounter-condition-value/55/" - } - ], - "max_level": "10", - "method": { - "name": "gift", - "url": "https://pokeapi.co/api/v2/encounter-method/18/" - }, - "min_level": "10" - } - ], - "max_chance": "100", - "version": { - "name": "red", - "url": "https://pokeapi.co/api/v2/version/1/" - } - } - ] - } -] -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_encounters_retrieve+responses\} - - - - - -200 - - - - - - - -ResponseBody","children":[{"label":"ResponseBody","linkedLabel":"ResponseBody","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - - - - - -#### ResponseBody \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody\} - - - - - -location_area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### location_area \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+location_area\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail\} - - - - - -encounter_detail","children":[{"label":"encounter_detail","linkedLabel":"encounter_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details\} - - - - - - - - - -#### encounter\_detail \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail\} - - - - - - - - - -##### chance \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+chance\} - - - - - -_Example:_ - -``` -100 -``` - - - - - -condition_value","children":[{"label":"condition_value","linkedLabel":"condition_value","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### condition_values \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+condition_values\} - - - - - - - - - -#### condition\_value \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+condition_values+condition_value\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+condition_values+condition_value+name\} - - - - - -_Example:_ - -``` -story-progress-beat-red -``` - - - - - - - - - -##### url \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+condition_values+condition_value+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/encounter-condition-value/55/ -``` - - - - - - - - - - - - - - - - - -##### max_level \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+max_level\} - - - - - -_Example:_ - -``` -10 -``` - - - - - -method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### method \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+method\} - - - - - - - - - - - - - -##### min_level \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+encounter_details+encounter_detail+min_level\} - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### max_chance \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+max_chance\} - - - - - -_Example:_ - -``` -100 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_encounters_retrieve+responses+200+application-json+responsebody+version_details+version_detail+version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/evolution.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/evolution.mdx deleted file mode 100644 index effd5220d..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/evolution.mdx +++ /dev/null @@ -1,1708 +0,0 @@ ---- -sidebar_position: 3.3 -sidebar_label: Evolution ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Evolution Endpoints - - - - - -Evolution is a process in which a Pokémon changes into a different species of Pokémon. - - - - - - - - - -## GET /api/v2/evolution-chain/ \{#operation-api_v2_evolution_chain_list\} - - - - - -_List evolution chains_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - -
    - - - -### Security \{#operation-api_v2_evolution_chain_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_chain_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_chain_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_evolution_chain_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_evolution_chain_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_evolution_chain_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_evolution_chain_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_chain_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_chain_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_evolution_chain_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_evolution_chain_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_evolution_chain_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionChainSummary","children":[{"label":"EvolutionChainSummary","linkedLabel":"EvolutionChainSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_evolution_chain_list+responses+200+application-json+results\} - - - - - - - - - -#### EvolutionChainSummary \{#operation-api_v2_evolution_chain_list+responses+200+application-json+results+evolutionchainsummary\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_chain_list+responses+200+application-json+results+evolutionchainsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-chain/\{id\}/ \{#operation-api_v2_evolution_chain_retrieve\} - - - - - -_Get evolution chain_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - -
    - - - -### Security \{#operation-api_v2_evolution_chain_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_chain_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_chain_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_evolution_chain_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_chain_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_chain_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "baby_trigger_item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "chain": { - "evolution_details": [ - null - ], - "evolves_to": [ - { - "evolution_details": [ - { - "gender": null, - "held_item": null, - "item": null, - "known_move": null, - "known_move_type": null, - "location": null, - "min_affection": null, - "min_beauty": null, - "min_happiness": null, - "min_level": null, - "needs_overworld_rain": null, - "party_species": null, - "party_type": null, - "relative_physical_stats": null, - "time_of_day": "reprehenderit ut dolore", - "trade_species": null, - "trigger": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "turn_upside_down": false - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - }, - "id": 87 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_chain_retrieve+responses\} - - - - - -200 - - - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_item \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+baby_trigger_item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+baby_trigger_item+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+baby_trigger_item+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+baby_trigger_item+itemsummary+url\} - - - - - - - - - - - - - -chain","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chain \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+chain\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_chain_retrieve+responses+200+application-json+id\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-trigger/ \{#operation-api_v2_evolution_trigger_list\} - - - - - -_List evolution triggers_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_evolution_trigger_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_trigger_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_trigger_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_evolution_trigger_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_evolution_trigger_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_evolution_trigger_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_evolution_trigger_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_trigger_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_trigger_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionTriggerSummary","children":[{"label":"EvolutionTriggerSummary","linkedLabel":"EvolutionTriggerSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+results\} - - - - - - - - - -#### EvolutionTriggerSummary \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+results+evolutiontriggersummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+results+evolutiontriggersummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_list+responses+200+application-json+results+evolutiontriggersummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-trigger/\{id\}/ \{#operation-api_v2_evolution_trigger_retrieve\} - - - - - -_Get evolution trigger_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_evolution_trigger_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_evolution_trigger_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_evolution_trigger_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_evolution_trigger_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_trigger_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_evolution_trigger_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "ivysaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/2/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_evolution_trigger_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+name\} - - - - - -EvolutionTriggerName","children":[{"label":"EvolutionTriggerName","linkedLabel":"EvolutionTriggerName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### EvolutionTriggerName \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+names+evolutiontriggername+name\} - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### pokemon\_specie \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+pokemon_species+pokemon_specie\} - - - - - - - - - -##### name \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+pokemon_species+pokemon_specie+name\} - - - - - -_Example:_ - -``` -ivysaur -``` - - - - - - - - - -##### url \{#operation-api_v2_evolution_trigger_retrieve+responses+200+application-json+pokemon_species+pokemon_specie+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/2/ -``` - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/games.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/games.mdx deleted file mode 100644 index 1251443b5..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/games.mdx +++ /dev/null @@ -1,4667 +0,0 @@ ---- -sidebar_position: 3.4 -sidebar_label: Games ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Games Endpoints - - - - - -The Pokémon games are all video games in the Pokémon franchise. - - - - - - - - - -## GET /api/v2/generation/ \{#operation-api_v2_generation_list\} - - - - - -_List genrations_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - -
    - - - -### Security \{#operation-api_v2_generation_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_generation_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_generation_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_generation_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_generation_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_generation_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_generation_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_generation_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_generation_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_generation_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_generation_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_generation_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenerationSummary","children":[{"label":"GenerationSummary","linkedLabel":"GenerationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_generation_list+responses+200+application-json+results\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_generation_list+responses+200+application-json+results+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_list+responses+200+application-json+results+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_list+responses+200+application-json+results+generationsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/generation/\{id\}/ \{#operation-api_v2_generation_retrieve\} - - - - - -_Get genration_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - -
    - - - -### Security \{#operation-api_v2_generation_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_generation_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_generation_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_generation_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_generation_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_generation_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "abilities": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "main_region": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "moves": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ], - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_species": [ - { - "name": "do do sint mollit", - "url": "occaecat" - } - ], - "types": [ - { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - ], - "version_groups": [ - { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_generation_retrieve+responses\} - - - - - -200 - - - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities \{#operation-api_v2_generation_retrieve+responses+200+application-json+abilities\} - - - - - - - - - -#### AbilitySummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+abilities+abilitysummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+abilities+abilitysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+abilities+abilitysummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_generation_retrieve+responses+200+application-json+id\} - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_region \{#operation-api_v2_generation_retrieve+responses+200+application-json+main_region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+main_region+regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+main_region+regionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+main_region+regionsummary+url\} - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_generation_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+moves+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+moves+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+moves+movesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+name\} - - - - - -GenerationName","children":[{"label":"GenerationName","linkedLabel":"GenerationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_generation_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### GenerationName \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+names+generationname+name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_generation_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_generation_retrieve+responses+200+application-json+types\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+types+typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+types+typesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+types+typesummary+url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_generation_retrieve+responses+200+application-json+version_groups\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_generation_retrieve+responses+200+application-json+version_groups+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_generation_retrieve+responses+200+application-json+version_groups+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_generation_retrieve+responses+200+application-json+version_groups+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokedex/ \{#operation-api_v2_pokedex_list\} - - - - - -_List pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokedex_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokedex_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokedex_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokedex_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokedex_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokedex_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokedex_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokedex_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokedex_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokedex_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokedex_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokedex_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokedex_list+responses+200+application-json+results\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_pokedex_list+responses+200+application-json+results+pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_list+responses+200+application-json+results+pokedexsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_list+responses+200+application-json+results+pokedexsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokedex/\{id\}/ \{#operation-api_v2_pokedex_retrieve\} - - - - - -_Get pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokedex_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokedex_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokedex_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokedex_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokedex_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokedex_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pokemon_entries": [ - { - "entry_number": "1", - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - } - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version_groups": [ - { - "name": "the-teal-mask", - "url": "https://pokeapi.co/api/v2/version-group/26/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokedex_retrieve+responses\} - - - - - -200 - - - - - - - -PokedexDescription","children":[{"label":"PokedexDescription","linkedLabel":"PokedexDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### PokedexDescription \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription\} - - - - - - - - - -##### description \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+descriptions+pokedexdescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_main_series \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+is_main_series\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+name\} - - - - - -PokedexName","children":[{"label":"PokedexName","linkedLabel":"PokedexName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### PokedexName \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+names+pokedexname+name\} - - - - - - - - - - - - - -pokemon_entry","children":[{"label":"pokemon_entry","linkedLabel":"pokemon_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_entries \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+pokemon_entries\} - - - - - - - - - -#### pokemon\_entry \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+pokemon_entries+pokemon_entry\} - - - - - - - - - -##### entry_number \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+pokemon_entries+pokemon_entry+entry_number\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+pokemon_entries+pokemon_entry+pokemon_species\} - - - - - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+region+regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+region+regionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+region+regionsummary+url\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+version_groups+version_group\} - - - - - - - - - -##### name \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+version_groups+version_group+name\} - - - - - -_Example:_ - -``` -the-teal-mask -``` - - - - - - - - - -##### url \{#operation-api_v2_pokedex_retrieve+responses+200+application-json+version_groups+version_group+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/26/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version/ \{#operation-api_v2_version_list\} - - - - - -_List versions_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - -
    - - - -### Security \{#operation-api_v2_version_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_version_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_version_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_version_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_version_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_version_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_version_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_version_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_version_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_version_list+responses+200+application-json+results\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_version_list+responses+200+application-json+results+versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_list+responses+200+application-json+results+versionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_list+responses+200+application-json+results+versionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version/\{id\}/ \{#operation-api_v2_version_retrieve\} - - - - - -_Get version_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - -
    - - - -### Security \{#operation-api_v2_version_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_version_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_version_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_version_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_retrieve+responses\} - - - - - -200 - - - - - - - -Should have a link to Version Group info but the Circular -dependency and compilation order fight eachother and I'm -not sure how to add anything other than a hyperlink - - - - - - - - - -##### id \{#operation-api_v2_version_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve+responses+200+application-json+name\} - - - - - -VersionName","children":[{"label":"VersionName","linkedLabel":"VersionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_version_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### VersionName \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve+responses+200+application-json+names+versionname+name\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_version_retrieve+responses+200+application-json+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_version_retrieve+responses+200+application-json+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_retrieve+responses+200+application-json+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_retrieve+responses+200+application-json+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version-group/ \{#operation-api_v2_version_group_list\} - - - - - -_List version groups_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - -
    - - - -### Security \{#operation-api_v2_version_group_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_group_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_group_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_version_group_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_version_group_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_version_group_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_version_group_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_version_group_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_group_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_version_group_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_version_group_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_version_group_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_version_group_list+responses+200+application-json+results\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_version_group_list+responses+200+application-json+results+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_list+responses+200+application-json+results+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_list+responses+200+application-json+results+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version-group/\{id\}/ \{#operation-api_v2_version_group_retrieve\} - - - - - -_Get version group_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - -
    - - - -### Security \{#operation-api_v2_version_group_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_version_group_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_version_group_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_version_group_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_version_group_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_version_group_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "generation": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "move_learn_methods": [ - { - "name": "level-up", - "url": "https://pokeapi.co/api/v2/move-learn-method/1/" - } - ], - "name": "nostrud", - "pokedexes": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/pokedex/2/" - } - ], - "regions": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/region/1/" - } - ], - "versions": [ - { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_version_group_retrieve+responses\} - - - - - -200 - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_version_group_retrieve+responses+200+application-json+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_version_group_retrieve+responses+200+application-json+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve+responses+200+application-json+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_version_group_retrieve+responses+200+application-json+id\} - - - - - -move_learn_method","children":[{"label":"move_learn_method","linkedLabel":"move_learn_method","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_learn_methods \{#operation-api_v2_version_group_retrieve+responses+200+application-json+move_learn_methods\} - - - - - - - - - -#### move\_learn\_method \{#operation-api_v2_version_group_retrieve+responses+200+application-json+move_learn_methods+move_learn_method\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+move_learn_methods+move_learn_method+name\} - - - - - -_Example:_ - -``` -level-up -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve+responses+200+application-json+move_learn_methods+move_learn_method+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move-learn-method/1/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+name\} - - - - - - - - - -##### order \{#operation-api_v2_version_group_retrieve+responses+200+application-json+order\} - - - - - -pokedex","children":[{"label":"pokedex","linkedLabel":"pokedex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes \{#operation-api_v2_version_group_retrieve+responses+200+application-json+pokedexes\} - - - - - - - - - -#### pokedex \{#operation-api_v2_version_group_retrieve+responses+200+application-json+pokedexes+pokedex\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+pokedexes+pokedex+name\} - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve+responses+200+application-json+pokedexes+pokedex+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokedex/2/ -``` - - - - - - - - - - - - - -region","children":[{"label":"region","linkedLabel":"region","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### regions \{#operation-api_v2_version_group_retrieve+responses+200+application-json+regions\} - - - - - - - - - -#### region \{#operation-api_v2_version_group_retrieve+responses+200+application-json+regions+region\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+regions+region+name\} - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve+responses+200+application-json+regions+region+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/region/1/ -``` - - - - - - - - - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### versions \{#operation-api_v2_version_group_retrieve+responses+200+application-json+versions\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_version_group_retrieve+responses+200+application-json+versions+versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_version_group_retrieve+responses+200+application-json+versions+versionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_version_group_retrieve+responses+200+application-json+versions+versionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/items.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/items.mdx deleted file mode 100644 index dfc4b4bcc..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/items.mdx +++ /dev/null @@ -1,5667 +0,0 @@ ---- -sidebar_position: 3.5 -sidebar_label: Items ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Items Endpoints - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -## GET /api/v2/item/ \{#operation-api_v2_item_list\} - - - - - -_List items_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - -
    - - - -### Security \{#operation-api_v2_item_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_list+responses+200+application-json+results\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_list+responses+200+application-json+results+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_list+responses+200+application-json+results+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_list+responses+200+application-json+results+itemsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item/\{id\}/ \{#operation-api_v2_item_retrieve\} - - - - - -_Get item_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - -
    - - - -### Security \{#operation-api_v2_item_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "attributes": [ - { - "name": "countable", - "url": "https://pokeapi.co/api/v2/item-attribute/1/" - } - ], - "baby_trigger_for": { - "url": "https://pokeapi.co/api/v2/evolution-chain/51/" - }, - "category": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "language": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "text": "occaecat", - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "fling_effect": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "ut sint", - "url": "dolor voluptate eu" - } - } - ], - "held_by_pokemon": [ - { - "pokemon": { - "name": "farfetchd", - "url": "https://pokeapi.co/api/v2/pokemon/83/" - }, - "version-details": [ - { - "rarity": "5", - "version": { - "name": "ruby", - "url": "https://pokeapi.co/api/v2/version/7/" - } - } - ] - } - ], - "id": 56, - "machines": [ - { - "machine": "https://pokeapi.co/api/v2/machine/1/", - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/20/" - } - } - ], - "name": "ullamco", - "names": [ - { - "language": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "name": "in consectetur excepteur sint" - } - ], - "sprites": { - "default": "https://pokeapi.co/media/sprites/items/master-ball.png" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_retrieve+responses\} - - - - - -200 - - - - - - - -attribute","children":[{"label":"attribute","linkedLabel":"attribute","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attributes \{#operation-api_v2_item_retrieve+responses+200+application-json+attributes\} - - - - - - - - - -#### attribute \{#operation-api_v2_item_retrieve+responses+200+application-json+attributes+attribute\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+attributes+attribute+name\} - - - - - -_Example:_ - -``` -countable -``` - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+attributes+attribute+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item-attribute/1/ -``` - - - - - - - - - - - - - -baby_trigger_for","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_for \{#operation-api_v2_item_retrieve+responses+200+application-json+baby_trigger_for\} - - - - - - - - - -ItemCategorySummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### category \{#operation-api_v2_item_retrieve+responses+200+application-json+category\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_retrieve+responses+200+application-json+category+itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+category+itemcategorysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+category+itemcategorysummary+url\} - - - - - - - - - - - - - - - - - -##### cost \{#operation-api_v2_item_retrieve+responses+200+application-json+cost\} - - - - - -ItemEffectText","children":[{"label":"ItemEffectText","linkedLabel":"ItemEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries\} - - - - - - - - - -#### ItemEffectText \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_item_retrieve+responses+200+application-json+effect_entries+itemeffecttext+short_effect\} - - - - - - - - - - - - - -ItemFlavorText","children":[{"label":"ItemFlavorText","linkedLabel":"ItemFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### ItemFlavorText \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### text \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+text\} - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+flavor_text_entries+itemflavortext+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### fling_effect \{#operation-api_v2_item_retrieve+responses+200+application-json+fling_effect\} - - - - - - - - - -#### ItemFlingEffectSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+fling_effect+itemflingeffectsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+fling_effect+itemflingeffectsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+fling_effect+itemflingeffectsummary+url\} - - - - - - - - - - - - - - - - - -##### fling_power \{#operation-api_v2_item_retrieve+responses+200+application-json+fling_power\} - - - - - -ItemGameIndex","children":[{"label":"ItemGameIndex","linkedLabel":"ItemGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices\} - - - - - - - - - -#### ItemGameIndex \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex+game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+game_indices+itemgameindex+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - - - - - -held_by_pokemon","children":[{"label":"held_by_pokemon","linkedLabel":"held_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_by_pokemon \{#operation-api_v2_item_retrieve+responses+200+application-json+held_by_pokemon\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_retrieve+responses+200+application-json+id\} - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines \{#operation-api_v2_item_retrieve+responses+200+application-json+machines\} - - - - - - - - - -#### machine \{#operation-api_v2_item_retrieve+responses+200+application-json+machines+machine\} - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_item_retrieve+responses+200+application-json+machines+machine+version_group\} - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+name\} - - - - - -ItemName","children":[{"label":"ItemName","linkedLabel":"ItemName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### ItemName \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_retrieve+responses+200+application-json+names+itemname+name\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_item_retrieve+responses+200+application-json+sprites\} - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-category/ \{#operation-api_v2_item_category_list\} - - - - - -_List item categories_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - -
    - - - -### Security \{#operation-api_v2_item_category_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_category_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_category_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_category_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_category_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_category_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_category_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_category_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_category_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_category_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_category_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_category_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_category_list+responses+200+application-json+results\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_category_list+responses+200+application-json+results+itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_list+responses+200+application-json+results+itemcategorysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_list+responses+200+application-json+results+itemcategorysummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-category/\{id\}/ \{#operation-api_v2_item_category_retrieve\} - - - - - -_Get item category_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - -
    - - - -### Security \{#operation-api_v2_item_category_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_category_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_category_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_category_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_category_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_category_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "items": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pocket": { - "name": "irure", - "url": "dolor" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_category_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_item_category_retrieve+responses+200+application-json+id\} - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_category_retrieve+responses+200+application-json+items\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_category_retrieve+responses+200+application-json+items+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve+responses+200+application-json+items+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve+responses+200+application-json+items+itemsummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve+responses+200+application-json+name\} - - - - - -ItemCategoryName","children":[{"label":"ItemCategoryName","linkedLabel":"ItemCategoryName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### ItemCategoryName \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve+responses+200+application-json+names+itemcategoryname+name\} - - - - - - - - - - - - - -ItemPocketSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pocket \{#operation-api_v2_item_category_retrieve+responses+200+application-json+pocket\} - - - - - - - - - -#### ItemPocketSummary \{#operation-api_v2_item_category_retrieve+responses+200+application-json+pocket+itempocketsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_category_retrieve+responses+200+application-json+pocket+itempocketsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_category_retrieve+responses+200+application-json+pocket+itempocketsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-attribute/ \{#operation-api_v2_item_attribute_list\} - - - - - -_List item attributes_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - -
    - - - -### Security \{#operation-api_v2_item_attribute_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_attribute_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_attribute_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_attribute_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_attribute_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_attribute_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_attribute_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_attribute_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_attribute_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_attribute_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_attribute_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_attribute_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemAttributeSummary","children":[{"label":"ItemAttributeSummary","linkedLabel":"ItemAttributeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_attribute_list+responses+200+application-json+results\} - - - - - - - - - -#### ItemAttributeSummary \{#operation-api_v2_item_attribute_list+responses+200+application-json+results+itemattributesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_list+responses+200+application-json+results+itemattributesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_list+responses+200+application-json+results+itemattributesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-attribute/\{id\}/ \{#operation-api_v2_item_attribute_retrieve\} - - - - - -_Get item attribute_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - -
    - - - -### Security \{#operation-api_v2_item_attribute_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_attribute_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_attribute_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_attribute_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_attribute_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_attribute_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "items": [ - { - "name": "master-ball", - "url": "https://pokeapi.co/api/v2/item/1/" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_attribute_retrieve+responses\} - - - - - -200 - - - - - - - -ItemAttributeDescription","children":[{"label":"ItemAttributeDescription","linkedLabel":"ItemAttributeDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### ItemAttributeDescription \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription\} - - - - - - - - - -##### description \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+descriptions+itemattributedescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+id\} - - - - - -item","children":[{"label":"item","linkedLabel":"item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+items\} - - - - - - - - - -#### item \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+items+item\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+items+item+name\} - - - - - -_Example:_ - -``` -master-ball -``` - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+items+item+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item/1/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+name\} - - - - - -ItemAttributeName","children":[{"label":"ItemAttributeName","linkedLabel":"ItemAttributeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### ItemAttributeName \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_attribute_retrieve+responses+200+application-json+names+itemattributename+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-fling-effect/ \{#operation-api_v2_item_fling_effect_list\} - - - - - -_List item fling effects_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - -
    - - - -### Security \{#operation-api_v2_item_fling_effect_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_fling_effect_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_fling_effect_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_fling_effect_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_fling_effect_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_fling_effect_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_fling_effect_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_fling_effect_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_fling_effect_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemFlingEffectSummary","children":[{"label":"ItemFlingEffectSummary","linkedLabel":"ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+results\} - - - - - - - - - -#### ItemFlingEffectSummary \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+results+itemflingeffectsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+results+itemflingeffectsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_list+responses+200+application-json+results+itemflingeffectsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-fling-effect/\{id\}/ \{#operation-api_v2_item_fling_effect_retrieve\} - - - - - -_Get item fling effect_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - -
    - - - -### Security \{#operation-api_v2_item_fling_effect_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_fling_effect_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_fling_effect_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_fling_effect_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_fling_effect_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_fling_effect_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 87, - "items": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ], - "name": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_fling_effect_retrieve+responses\} - - - - - -200 - - - - - - - -ItemFlingEffectEffectText","children":[{"label":"ItemFlingEffectEffectText","linkedLabel":"ItemFlingEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries\} - - - - - - - - - -#### ItemFlingEffectEffectText \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext+effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+effect_entries+itemflingeffecteffecttext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+id\} - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+items\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+items+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+items+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+items+itemsummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_fling_effect_retrieve+responses+200+application-json+name\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-pocket/ \{#operation-api_v2_item_pocket_list\} - - - - - -_List item pockets_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - -
    - - - -### Security \{#operation-api_v2_item_pocket_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_pocket_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_pocket_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_pocket_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_item_pocket_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_item_pocket_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_item_pocket_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_pocket_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_pocket_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_item_pocket_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_item_pocket_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_item_pocket_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemPocketSummary","children":[{"label":"ItemPocketSummary","linkedLabel":"ItemPocketSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_item_pocket_list+responses+200+application-json+results\} - - - - - - - - - -#### ItemPocketSummary \{#operation-api_v2_item_pocket_list+responses+200+application-json+results+itempocketsummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_list+responses+200+application-json+results+itempocketsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_list+responses+200+application-json+results+itempocketsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-pocket/\{id\}/ \{#operation-api_v2_item_pocket_retrieve\} - - - - - -_Get item pocket_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - -
    - - - -### Security \{#operation-api_v2_item_pocket_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_item_pocket_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_item_pocket_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_item_pocket_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_item_pocket_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_item_pocket_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "categories": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_item_pocket_retrieve+responses\} - - - - - -200 - - - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### categories \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+categories\} - - - - - - - - - -#### ItemCategorySummary \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+categories+itemcategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+categories+itemcategorysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+categories+itemcategorysummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+name\} - - - - - -ItemPocketName","children":[{"label":"ItemPocketName","linkedLabel":"ItemPocketName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### ItemPocketName \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_item_pocket_retrieve+responses+200+application-json+names+itempocketname+name\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/location.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/location.mdx deleted file mode 100644 index 3f511a5dd..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/location.mdx +++ /dev/null @@ -1,4461 +0,0 @@ ---- -sidebar_position: 3.6 -sidebar_label: Location ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Location Endpoints - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -## GET /api/v2/location/ \{#operation-api_v2_location_list\} - - - - - -_List locations_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - -
    - - - -### Security \{#operation-api_v2_location_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_location_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_location_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_location_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_location_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_location_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_location_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_location_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_location_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_location_list+responses+200+application-json+results\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_location_list+responses+200+application-json+results+locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_list+responses+200+application-json+results+locationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_list+responses+200+application-json+results+locationsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location/\{id\}/ \{#operation-api_v2_location_retrieve\} - - - - - -_Get location_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - -
    - - - -### Security \{#operation-api_v2_location_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_location_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_location_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_location_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "areas": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - } - ], - "id": 14, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_retrieve+responses\} - - - - - -200 - - - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### areas \{#operation-api_v2_location_retrieve+responses+200+application-json+areas\} - - - - - - - - - -#### LocationAreaSummary \{#operation-api_v2_location_retrieve+responses+200+application-json+areas+locationareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+areas+locationareasummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve+responses+200+application-json+areas+locationareasummary+url\} - - - - - - - - - - - - - -LocationGameIndex","children":[{"label":"LocationGameIndex","linkedLabel":"LocationGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices\} - - - - - - - - - -#### LocationGameIndex \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex+game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve+responses+200+application-json+game_indices+locationgameindex+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_location_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+name\} - - - - - -LocationName","children":[{"label":"LocationName","linkedLabel":"LocationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_location_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### LocationName \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+names+locationname+name\} - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region \{#operation-api_v2_location_retrieve+responses+200+application-json+region\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_location_retrieve+responses+200+application-json+region+regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_retrieve+responses+200+application-json+region+regionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_retrieve+responses+200+application-json+region+regionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location-area/ \{#operation-api_v2_location_area_list\} - - - - - -_List location areas_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - -
    - - - -### Security \{#operation-api_v2_location_area_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_area_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_area_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_location_area_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_location_area_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_location_area_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_location_area_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_area_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_location_area_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_location_area_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_location_area_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_location_area_list+responses+200+application-json+results\} - - - - - - - - - -#### LocationAreaSummary \{#operation-api_v2_location_area_list+responses+200+application-json+results+locationareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_list+responses+200+application-json+results+locationareasummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_list+responses+200+application-json+results+locationareasummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location-area/\{id\}/ \{#operation-api_v2_location_area_retrieve\} - - - - - -_Get location area_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - -
    - - - -### Security \{#operation-api_v2_location_area_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_location_area_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_location_area_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_location_area_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_location_area_retrieve+parameters+id\} - - - - - -A unique integer value identifying this location area. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_location_area_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "encounter_method_rates": [ - { - "encounter_method": { - "name": "old-rod", - "url": "https://pokeapi.co/api/v2/encounter-method/2/" - }, - "version_details": [ - { - "rate": "5", - "version": { - "name": "platinum", - "url": "https://pokeapi.co/api/v2/version/14/" - } - } - ] - } - ], - "game_index": 14, - "id": 56, - "location": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_encounters": [ - { - "pokemon": { - "name": "tentacool", - "url": "https://pokeapi.co/api/v2/pokemon/72/" - }, - "version_details": [ - { - "encounter_details": { - "chance": "60", - "max_level": "30", - "method": { - "name": "surf", - "url": "https://pokeapi.co/api/v2/encounter-method/5/" - }, - "min_level": "20" - }, - "max_chance": "60", - "version": { - "name": "diamond", - "url": "https://pokeapi.co/api/v2/version/12/" - } - } - ] - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_location_area_retrieve+responses\} - - - - - -200 - - - - - - - -encounter_method_rate","children":[{"label":"encounter_method_rate","linkedLabel":"encounter_method_rate","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### encounter_method_rates \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates\} - - - - - - - - - -#### encounter\_method\_rate \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate\} - - - - - -encounter_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_method \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate+encounter_method\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate+version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate+version_details+version_detail\} - - - - - - - - - -##### rate \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate+version_details+version_detail+rate\} - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_location_area_retrieve+responses+200+application-json+encounter_method_rates+encounter_method_rate+version_details+version_detail+version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### game_index \{#operation-api_v2_location_area_retrieve+responses+200+application-json+game_index\} - - - - - - - - - -##### id \{#operation-api_v2_location_area_retrieve+responses+200+application-json+id\} - - - - - -LocationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### location \{#operation-api_v2_location_area_retrieve+responses+200+application-json+location\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_location_area_retrieve+responses+200+application-json+location+locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve+responses+200+application-json+location+locationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_retrieve+responses+200+application-json+location+locationsummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve+responses+200+application-json+name\} - - - - - -LocationAreaName","children":[{"label":"LocationAreaName","linkedLabel":"LocationAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### LocationAreaName \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_location_area_retrieve+responses+200+application-json+names+locationareaname+name\} - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters\} - - - - - - - - - -#### pokemon\_encounter \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter\} - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+pokemon\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+version_details+version_detail\} - - - - - -encounter_details","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+version_details+version_detail+encounter_details\} - - - - - - - - - - - - - -##### max_chance \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+version_details+version_detail+max_chance\} - - - - - -_Example:_ - -``` -60 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_location_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+version_details+version_detail+version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pal-park-area/ \{#operation-api_v2_pal_park_area_list\} - - - - - -_List pal park areas_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - -
    - - - -### Security \{#operation-api_v2_pal_park_area_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pal_park_area_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pal_park_area_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pal_park_area_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pal_park_area_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pal_park_area_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pal_park_area_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pal_park_area_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pal_park_area_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pal_park_area_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pal_park_area_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pal_park_area_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PalParkAreaSummary","children":[{"label":"PalParkAreaSummary","linkedLabel":"PalParkAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pal_park_area_list+responses+200+application-json+results\} - - - - - - - - - -#### PalParkAreaSummary \{#operation-api_v2_pal_park_area_list+responses+200+application-json+results+palparkareasummary\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_list+responses+200+application-json+results+palparkareasummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pal_park_area_list+responses+200+application-json+results+palparkareasummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pal-park-area/\{id\}/ \{#operation-api_v2_pal_park_area_retrieve\} - - - - - -_Get pal park area_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - -
    - - - -### Security \{#operation-api_v2_pal_park_area_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pal_park_area_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pal_park_area_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pal_park_area_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pal_park_area_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pal_park_area_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_encounters": [ - { - "base_score": "50", - "pokemon-species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "30" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pal_park_area_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+name\} - - - - - -PalParkAreaName","children":[{"label":"PalParkAreaName","linkedLabel":"PalParkAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### PalParkAreaName \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+names+palparkareaname+name\} - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+pokemon_encounters\} - - - - - - - - - -#### pokemon\_encounter \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter\} - - - - - - - - - -##### base_score \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+base_score\} - - - - - -_Example:_ - -``` -50 -``` - - - - - -pokemon-species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon-species \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+pokemon-species\} - - - - - - - - - - - - - -##### rate \{#operation-api_v2_pal_park_area_retrieve+responses+200+application-json+pokemon_encounters+pokemon_encounter+rate\} - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/region/ \{#operation-api_v2_region_list\} - - - - - -_List regions_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - -
    - - - -### Security \{#operation-api_v2_region_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_region_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_region_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_region_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_region_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_region_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_region_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_region_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_region_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_region_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_region_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_region_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -RegionSummary","children":[{"label":"RegionSummary","linkedLabel":"RegionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_region_list+responses+200+application-json+results\} - - - - - - - - - -#### RegionSummary \{#operation-api_v2_region_list+responses+200+application-json+results+regionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_list+responses+200+application-json+results+regionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_region_list+responses+200+application-json+results+regionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/region/\{id\}/ \{#operation-api_v2_region_retrieve\} - - - - - -_Get region_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - -
    - - - -### Security \{#operation-api_v2_region_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_region_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_region_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_region_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_region_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_region_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "locations": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "main_generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "pokedexes": [ - { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_region_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_region_retrieve+responses+200+application-json+id\} - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### locations \{#operation-api_v2_region_retrieve+responses+200+application-json+locations\} - - - - - - - - - -#### LocationSummary \{#operation-api_v2_region_retrieve+responses+200+application-json+locations+locationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+locations+locationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve+responses+200+application-json+locations+locationsummary+url\} - - - - - - - - - - - - - -main_generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_generation \{#operation-api_v2_region_retrieve+responses+200+application-json+main_generation\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+name\} - - - - - -RegionName","children":[{"label":"RegionName","linkedLabel":"RegionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_region_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### RegionName \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+names+regionname+name\} - - - - - - - - - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes \{#operation-api_v2_region_retrieve+responses+200+application-json+pokedexes\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_region_retrieve+responses+200+application-json+pokedexes+pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+pokedexes+pokedexsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve+responses+200+application-json+pokedexes+pokedexsummary+url\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_region_retrieve+responses+200+application-json+version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_region_retrieve+responses+200+application-json+version_groups+version_group\} - - - - - - - - - -##### name \{#operation-api_v2_region_retrieve+responses+200+application-json+version_groups+version_group+name\} - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url \{#operation-api_v2_region_retrieve+responses+200+application-json+version_groups+version_group+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/machines.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/machines.mdx deleted file mode 100644 index 46fa5c77e..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/machines.mdx +++ /dev/null @@ -1,911 +0,0 @@ ---- -sidebar_position: 3.7 -sidebar_label: Machines ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Machines Endpoints - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -## GET /api/v2/machine/ \{#operation-api_v2_machine_list\} - - - - - -_List machines_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - -
    - - - -### Security \{#operation-api_v2_machine_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_machine_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_machine_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_machine_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_machine_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_machine_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_machine_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_machine_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_machine_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_machine_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_machine_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_machine_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MachineSummary","children":[{"label":"MachineSummary","linkedLabel":"MachineSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_machine_list+responses+200+application-json+results\} - - - - - - - - - -#### MachineSummary \{#operation-api_v2_machine_list+responses+200+application-json+results+machinesummary\} - - - - - - - - - -##### url \{#operation-api_v2_machine_list+responses+200+application-json+results+machinesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/machine/\{id\}/ \{#operation-api_v2_machine_retrieve\} - - - - - -_Get machine_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - -
    - - - -### Security \{#operation-api_v2_machine_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_machine_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_machine_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_machine_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_machine_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_machine_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "move": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_machine_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_machine_retrieve+responses+200+application-json+id\} - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item \{#operation-api_v2_machine_retrieve+responses+200+application-json+item\} - - - - - - - - - -#### ItemSummary \{#operation-api_v2_machine_retrieve+responses+200+application-json+item+itemsummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve+responses+200+application-json+item+itemsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve+responses+200+application-json+item+itemsummary+url\} - - - - - - - - - - - - - -MoveSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move \{#operation-api_v2_machine_retrieve+responses+200+application-json+move\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_machine_retrieve+responses+200+application-json+move+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve+responses+200+application-json+move+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve+responses+200+application-json+move+movesummary+url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_machine_retrieve+responses+200+application-json+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_machine_retrieve+responses+200+application-json+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_machine_retrieve+responses+200+application-json+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_machine_retrieve+responses+200+application-json+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/moves.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/moves.mdx deleted file mode 100644 index 6709e5fcb..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/moves.mdx +++ /dev/null @@ -1,7427 +0,0 @@ ---- -sidebar_position: 3.8 -sidebar_label: Moves ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Moves Endpoints - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -## GET /api/v2/move/ \{#operation-api_v2_move_list\} - - - - - -_List moves_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - -
    - - - -### Security \{#operation-api_v2_move_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_list+responses+200+application-json+results+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_list+responses+200+application-json+results+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_list+responses+200+application-json+results+movesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move/\{id\}/ \{#operation-api_v2_move_retrieve\} - - - - - -_Get move_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - -
    - - - -### Security \{#operation-api_v2_move_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "contest_combos": { - "normal": { - "use_after": null, - "use_before": null - }, - "super": { - "use_after": null, - "use_before": null - } - }, - "contest_effect": { - "url": "ipsum eiusmod" - }, - "contest_type": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "damage_class": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_chance": 87, - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "Hits Pokémon under the effects of dig and fly.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "version_group": { - "name": "gold-silver", - "url": "https://pokeapi.co/api/v2/version-group/3/" - } - } - ], - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nostrud anim", - "language": { - "name": "exercitation aliqua sint", - "url": "ut sint" - }, - "version_group": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - } - } - ], - "generation": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "id": 14, - "learned_by_pokemon": [ - { - "name": "clefairy", - "url": "https://pokeapi.co/api/v2/pokemon/35/" - } - ], - "machines": [ - { - "machine": { - "url": "https://pokeapi.co/api/v2/machine/1/" - }, - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - } - ], - "meta": { - "ailment": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "category": { - "name": "in consectetur excepteur sint", - "url": "sunt amet" - } - }, - "name": "duis ea", - "names": [ - { - "language": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "name": "magna est commodo officia" - } - ], - "past_values": [ - { - "effect_chance": 56, - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "type": { - "name": "ad occaecat elit proident ea", - "url": "cillum culpa aute minim" - }, - "version_group": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "stat_changes": [ - { - "change": "2", - "stat": { - "name": "attack", - "url": "https://pokeapi.co/api/v2/stat/1/" - } - } - ], - "super_contest_effect": { - "url": "nostrud" - }, - "target": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "type": { - "name": "dolor", - "url": "sunt" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### accuracy \{#operation-api_v2_move_retrieve+responses+200+application-json+accuracy\} - - - - - -contest_combos","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_combos \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_combos\} - - - - - - - - - -ContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_effect \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_effect\} - - - - - - - - - -#### ContestEffectSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_effect+contesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_effect+contesteffectsummary+url\} - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_type\} - - - - - - - - - -#### ContestTypeSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_type+contesttypesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_type+contesttypesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+contest_type+contesttypesummary+url\} - - - - - - - - - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_class \{#operation-api_v2_move_retrieve+responses+200+application-json+damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+damage_class+movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+damage_class+movedamageclasssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+damage_class+movedamageclasssummary+url\} - - - - - - - - - - - - - - - - - -##### effect_chance \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_chance\} - - - - - -effect_change","children":[{"label":"effect_change","linkedLabel":"effect_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes\} - - - - - - - - - -#### effect\_change \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change\} - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change+effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change+effect_entries+effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change+effect_entries+effect_entry+effect\} - - - - - -_Example:_ - -``` -Hits Pokémon under the effects of dig and fly. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change+effect_entries+effect_entry+language\} - - - - - - - - - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_changes+effect_change+version_group\} - - - - - - - - - - - - - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_entries+effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_entries+effect_entry+effect\} - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_entries+effect_entry+language\} - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_move_retrieve+responses+200+application-json+effect_entries+effect_entry+short_effect\} - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - -MoveFlavorText","children":[{"label":"MoveFlavorText","linkedLabel":"MoveFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### MoveFlavorText \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+language+languagesummary+url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+flavor_text_entries+moveflavortext+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_move_retrieve+responses+200+application-json+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_retrieve+responses+200+application-json+id\} - - - - - -learned_by_pokemon","children":[{"label":"learned_by_pokemon","linkedLabel":"learned_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### learned_by_pokemon \{#operation-api_v2_move_retrieve+responses+200+application-json+learned_by_pokemon\} - - - - - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines \{#operation-api_v2_move_retrieve+responses+200+application-json+machines\} - - - - - - - - - -#### machine \{#operation-api_v2_move_retrieve+responses+200+application-json+machines+machine\} - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve+responses+200+application-json+machines+machine+version_group\} - - - - - - - - - - - - - - - - - -meta","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### meta \{#operation-api_v2_move_retrieve+responses+200+application-json+meta\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+name\} - - - - - -MoveName","children":[{"label":"MoveName","linkedLabel":"MoveName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveName \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+names+movename+name\} - - - - - - - - - - - - - -MoveChange","children":[{"label":"MoveChange","linkedLabel":"MoveChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_values \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values\} - - - - - - - - - -#### MoveChange \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange\} - - - - - - - - - -##### accuracy \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+accuracy\} - - - - - - - - - -##### effect_chance \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_chance\} - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_entries\} - - - - - - - - - -#### effect\_entry \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_entries+effect_entry\} - - - - - - - - - -##### effect \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_entries+effect_entry+effect\} - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_entries+effect_entry+language\} - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+effect_entries+effect_entry+short_effect\} - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - - - - - -##### power \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+power\} - - - - - - - - - -##### pp \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+pp\} - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### type \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+type+typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+type+typesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+type+typesummary+url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+past_values+movechange+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### power \{#operation-api_v2_move_retrieve+responses+200+application-json+power\} - - - - - - - - - -##### pp \{#operation-api_v2_move_retrieve+responses+200+application-json+pp\} - - - - - - - - - -##### priority \{#operation-api_v2_move_retrieve+responses+200+application-json+priority\} - - - - - -stat_change","children":[{"label":"stat_change","linkedLabel":"stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stat_changes \{#operation-api_v2_move_retrieve+responses+200+application-json+stat_changes\} - - - - - - - - - -#### stat\_change \{#operation-api_v2_move_retrieve+responses+200+application-json+stat_changes+stat_change\} - - - - - - - - - -##### change \{#operation-api_v2_move_retrieve+responses+200+application-json+stat_changes+stat_change+change\} - - - - - -_Example:_ - -``` -2 -``` - - - - - -stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat \{#operation-api_v2_move_retrieve+responses+200+application-json+stat_changes+stat_change+stat\} - - - - - - - - - - - - - - - - - -SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### super_contest_effect \{#operation-api_v2_move_retrieve+responses+200+application-json+super_contest_effect\} - - - - - - - - - -#### SuperContestEffectSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+super_contest_effect+supercontesteffectsummary\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+super_contest_effect+supercontesteffectsummary+url\} - - - - - - - - - - - - - -MoveTargetSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### target \{#operation-api_v2_move_retrieve+responses+200+application-json+target\} - - - - - - - - - -#### MoveTargetSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+target+movetargetsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+target+movetargetsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+target+movetargetsummary+url\} - - - - - - - - - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### type \{#operation-api_v2_move_retrieve+responses+200+application-json+type\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_move_retrieve+responses+200+application-json+type+typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_retrieve+responses+200+application-json+type+typesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_retrieve+responses+200+application-json+type+typesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-ailment/ \{#operation-api_v2_move_ailment_list\} - - - - - -_List move meta ailments_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_move_ailment_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_ailment_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_ailment_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_ailment_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_ailment_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_ailment_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_ailment_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_ailment_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_ailment_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_ailment_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_ailment_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_ailment_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaAilmentSummary","children":[{"label":"MoveMetaAilmentSummary","linkedLabel":"MoveMetaAilmentSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_ailment_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveMetaAilmentSummary \{#operation-api_v2_move_ailment_list+responses+200+application-json+results+movemetaailmentsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_list+responses+200+application-json+results+movemetaailmentsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_list+responses+200+application-json+results+movemetaailmentsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-ailment/\{id\}/ \{#operation-api_v2_move_ailment_retrieve\} - - - - - -_Get move meta ailment_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_move_ailment_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_ailment_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_ailment_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_ailment_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_ailment_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_ailment_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "moves": [ - { - "name": "thunder-punch", - "url": "https://pokeapi.co/api/v2/move/9/" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_ailment_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+id\} - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### move \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+moves+move\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+moves+move+name\} - - - - - -_Example:_ - -``` -thunder-punch -``` - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+moves+move+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/9/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+name\} - - - - - -MoveMetaAilmentName","children":[{"label":"MoveMetaAilmentName","linkedLabel":"MoveMetaAilmentName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveMetaAilmentName \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_ailment_retrieve+responses+200+application-json+names+movemetaailmentname+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-battle-style/ \{#operation-api_v2_move_battle_style_list\} - - - - - -_List move battle styles_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_move_battle_style_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_battle_style_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_battle_style_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_battle_style_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_battle_style_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_battle_style_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_battle_style_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_battle_style_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_battle_style_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_battle_style_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_battle_style_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_battle_style_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveBattleStyleSummary","children":[{"label":"MoveBattleStyleSummary","linkedLabel":"MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_battle_style_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveBattleStyleSummary \{#operation-api_v2_move_battle_style_list+responses+200+application-json+results+movebattlestylesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_list+responses+200+application-json+results+movebattlestylesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_battle_style_list+responses+200+application-json+results+movebattlestylesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-battle-style/\{id\}/ \{#operation-api_v2_move_battle_style_retrieve\} - - - - - -_Get move battle style_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_move_battle_style_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_battle_style_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_battle_style_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_battle_style_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_battle_style_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_battle_style_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_battle_style_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+name\} - - - - - -MoveBattleStyleName","children":[{"label":"MoveBattleStyleName","linkedLabel":"MoveBattleStyleName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveBattleStyleName \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_battle_style_retrieve+responses+200+application-json+names+movebattlestylename+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-category/ \{#operation-api_v2_move_category_list\} - - - - - -_List move meta categories_ - - - - - -Very general categories that loosely group move effects. - - - - - -
    - - - -### Security \{#operation-api_v2_move_category_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_category_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_category_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_category_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_category_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_category_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_category_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_category_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_category_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_category_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_category_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_category_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaCategorySummary","children":[{"label":"MoveMetaCategorySummary","linkedLabel":"MoveMetaCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_category_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveMetaCategorySummary \{#operation-api_v2_move_category_list+responses+200+application-json+results+movemetacategorysummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_list+responses+200+application-json+results+movemetacategorysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_category_list+responses+200+application-json+results+movemetacategorysummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-category/\{id\}/ \{#operation-api_v2_move_category_retrieve\} - - - - - -_Get move meta category_ - - - - - -Very general categories that loosely group move effects. - - - - - -
    - - - -### Security \{#operation-api_v2_move_category_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_category_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_category_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_category_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_category_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_category_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "sing", - "url": "https://pokeapi.co/api/v2/move/47/" - } - ], - "name": "nostrud" -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_category_retrieve+responses\} - - - - - -200 - - - - - - - -MoveMetaCategoryDescription","children":[{"label":"MoveMetaCategoryDescription","linkedLabel":"MoveMetaCategoryDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### MoveMetaCategoryDescription \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_category_retrieve+responses+200+application-json+descriptions+movemetacategorydescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_category_retrieve+responses+200+application-json+id\} - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_category_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### move \{#operation-api_v2_move_category_retrieve+responses+200+application-json+moves+move\} - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve+responses+200+application-json+moves+move+name\} - - - - - -_Example:_ - -``` -sing -``` - - - - - - - - - -##### url \{#operation-api_v2_move_category_retrieve+responses+200+application-json+moves+move+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/47/ -``` - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_category_retrieve+responses+200+application-json+name\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-learn-method/ \{#operation-api_v2_move_learn_method_list\} - - - - - -_List move learn methods_ - - - - - -Methods by which Pokémon can learn moves. - - - - - -
    - - - -### Security \{#operation-api_v2_move_learn_method_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_learn_method_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_learn_method_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_learn_method_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_learn_method_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_learn_method_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_learn_method_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_learn_method_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_learn_method_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_learn_method_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_learn_method_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_learn_method_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveLearnMethodSummary","children":[{"label":"MoveLearnMethodSummary","linkedLabel":"MoveLearnMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_learn_method_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveLearnMethodSummary \{#operation-api_v2_move_learn_method_list+responses+200+application-json+results+movelearnmethodsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_list+responses+200+application-json+results+movelearnmethodsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_list+responses+200+application-json+results+movelearnmethodsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-learn-method/\{id\}/ \{#operation-api_v2_move_learn_method_retrieve\} - - - - - -_Get move learn method_ - - - - - -Methods by which Pokémon can learn moves. - - - - - -
    - - - -### Security \{#operation-api_v2_move_learn_method_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_learn_method_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_learn_method_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_learn_method_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_learn_method_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_learn_method_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_learn_method_retrieve+responses\} - - - - - -200 - - - - - - - -MoveLearnMethodDescription","children":[{"label":"MoveLearnMethodDescription","linkedLabel":"MoveLearnMethodDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### MoveLearnMethodDescription \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+descriptions+movelearnmethoddescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+name\} - - - - - -MoveLearnMethodName","children":[{"label":"MoveLearnMethodName","linkedLabel":"MoveLearnMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveLearnMethodName \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+names+movelearnmethodname+name\} - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+version_groups\} - - - - - - - - - -#### version\_group \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+version_groups+version_group\} - - - - - - - - - -##### name \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+version_groups+version_group+name\} - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url \{#operation-api_v2_move_learn_method_retrieve+responses+200+application-json+version_groups+version_group+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-target/ \{#operation-api_v2_move_target_list\} - - - - - -_List move targets_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - -
    - - - -### Security \{#operation-api_v2_move_target_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_target_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_target_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_target_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_target_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_target_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_target_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_target_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_target_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_target_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_target_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_target_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveTargetSummary","children":[{"label":"MoveTargetSummary","linkedLabel":"MoveTargetSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_target_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveTargetSummary \{#operation-api_v2_move_target_list+responses+200+application-json+results+movetargetsummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_list+responses+200+application-json+results+movetargetsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_list+responses+200+application-json+results+movetargetsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-target/\{id\}/ \{#operation-api_v2_move_target_retrieve\} - - - - - -_Get move target_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - -
    - - - -### Security \{#operation-api_v2_move_target_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_target_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_target_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_target_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_target_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_target_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_target_retrieve+responses\} - - - - - -200 - - - - - - - -MoveTargetDescription","children":[{"label":"MoveTargetDescription","linkedLabel":"MoveTargetDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### MoveTargetDescription \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve+responses+200+application-json+descriptions+movetargetdescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_target_retrieve+responses+200+application-json+id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_target_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_target_retrieve+responses+200+application-json+moves+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve+responses+200+application-json+moves+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve+responses+200+application-json+moves+movesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve+responses+200+application-json+name\} - - - - - -MoveTargetName","children":[{"label":"MoveTargetName","linkedLabel":"MoveTargetName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveTargetName \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_target_retrieve+responses+200+application-json+names+movetargetname+name\} - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/pokemon.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/pokemon.mdx deleted file mode 100644 index fa3bf3e77..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/pokemon.mdx +++ /dev/null @@ -1,19425 +0,0 @@ ---- -sidebar_position: 3.9 -sidebar_label: Pokemon ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Pokemon Endpoints - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -## GET /api/v2/ability/ \{#operation-api_v2_ability_list\} - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_ability_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_ability_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_ability_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_ability_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_ability_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_ability_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_ability_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_ability_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_ability_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_ability_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_ability_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_ability_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_ability_list+responses+200+application-json+results\} - - - - - - - - - -#### AbilitySummary \{#operation-api_v2_ability_list+responses+200+application-json+results+abilitysummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_list+responses+200+application-json+results+abilitysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_list+responses+200+application-json+results+abilitysummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/ability/\{id\}/ \{#operation-api_v2_ability_retrieve\} - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_ability_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_ability_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_ability_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_ability_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_ability_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_ability_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "version_group": { - "name": "occaecat dolor sit", - "url": "nostrud" - } - } - ], - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nisi minim commodo irure minim", - "language": { - "name": "do do sint mollit", - "url": "occaecat" - }, - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 87, - "name": "ut sint", - "names": [ - { - "language": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "name": "et voluptate" - } - ], - "pokemon": [ - { - "is_hidden": false, - "pokemon": { - "name": "gloom", - "url": "https://pokeapi.co/api/v2/pokemon/44/" - }, - "slot": "3" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_ability_retrieve+responses\} - - - - - -200 - - - - - - - -AbilityChange","children":[{"label":"AbilityChange","linkedLabel":"AbilityChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes\} - - - - - - - - - -#### AbilityChange \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange\} - - - - - -AbilityChangeEffectText","children":[{"label":"AbilityChangeEffectText","linkedLabel":"AbilityChangeEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries\} - - - - - - - - - -#### AbilityChangeEffectText \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext+effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+effect_entries+abilitychangeeffecttext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_changes+abilitychange+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -AbilityEffectText","children":[{"label":"AbilityEffectText","linkedLabel":"AbilityEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries\} - - - - - - - - - -#### AbilityEffectText \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext\} - - - - - - - - - -##### effect \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+effect\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### short_effect \{#operation-api_v2_ability_retrieve+responses+200+application-json+effect_entries+abilityeffecttext+short_effect\} - - - - - - - - - - - - - -AbilityFlavorText","children":[{"label":"AbilityFlavorText","linkedLabel":"AbilityFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### AbilityFlavorText \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+language+languagesummary+url\} - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+flavor_text_entries+abilityflavortext+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_ability_retrieve+responses+200+application-json+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_ability_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_main_series \{#operation-api_v2_ability_retrieve+responses+200+application-json+is_main_series\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+name\} - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_ability_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### AbilityName \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_ability_retrieve+responses+200+application-json+names+abilityname+name\} - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_ability_retrieve+responses+200+application-json+pokemon\} - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/characteristic/ \{#operation-api_v2_characteristic_list\} - - - - - -_List charecterictics_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_characteristic_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_characteristic_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_characteristic_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_characteristic_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_characteristic_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_characteristic_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_characteristic_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_characteristic_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_characteristic_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_characteristic_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_characteristic_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_characteristic_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_characteristic_list+responses+200+application-json+results\} - - - - - - - - - -#### CharacteristicSummary \{#operation-api_v2_characteristic_list+responses+200+application-json+results+characteristicsummary\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_list+responses+200+application-json+results+characteristicsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/characteristic/\{id\}/ \{#operation-api_v2_characteristic_retrieve\} - - - - - -_Get characteristic_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_characteristic_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_characteristic_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_characteristic_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_characteristic_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_characteristic_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_characteristic_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "gene_modulo": 87, - "highest_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "id": 14, - "possible_values": [ - 56 - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_characteristic_retrieve+responses\} - - - - - -200 - - - - - - - -CharacteristicDescription","children":[{"label":"CharacteristicDescription","linkedLabel":"CharacteristicDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### CharacteristicDescription \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription\} - - - - - - - - - -##### description \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+descriptions+characteristicdescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### gene_modulo \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+gene_modulo\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### highest_stat \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+highest_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+highest_stat+statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+highest_stat+statsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+highest_stat+statsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### possible_values \{#operation-api_v2_characteristic_retrieve+responses+200+application-json+possible_values\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/egg-group/ \{#operation-api_v2_egg_group_list\} - - - - - -_List egg groups_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_egg_group_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_egg_group_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_egg_group_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_egg_group_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_egg_group_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_egg_group_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_egg_group_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_egg_group_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_egg_group_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_egg_group_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_egg_group_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_egg_group_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EggGroupSummary","children":[{"label":"EggGroupSummary","linkedLabel":"EggGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_egg_group_list+responses+200+application-json+results\} - - - - - - - - - -#### EggGroupSummary \{#operation-api_v2_egg_group_list+responses+200+application-json+results+egggroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_list+responses+200+application-json+results+egggroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_egg_group_list+responses+200+application-json+results+egggroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/egg-group/\{id\}/ \{#operation-api_v2_egg_group_retrieve\} - - - - - -_Get egg group_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_egg_group_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_egg_group_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_egg_group_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_egg_group_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_egg_group_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_egg_group_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - {} - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_egg_group_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+name\} - - - - - -EggGroupName","children":[{"label":"EggGroupName","linkedLabel":"EggGroupName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### EggGroupName \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+names+egggroupname+name\} - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### pokemon\_specie \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+pokemon_species+pokemon_specie\} - - - - - - - - - -##### name \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+pokemon_species+pokemon_specie+name\} - - - - - -Pokemon species name. - - - - - -_Example:_ - -``` -bulbasaur -``` - - - - - - - - - -##### url \{#operation-api_v2_egg_group_retrieve+responses+200+application-json+pokemon_species+pokemon_specie+url\} - - - - - -The URL to get more information about the species - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/gender/ \{#operation-api_v2_gender_list\} - - - - - -_List genders_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_gender_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_gender_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_gender_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_gender_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_gender_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_gender_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_gender_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_gender_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_gender_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_gender_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_gender_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_gender_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenderSummary","children":[{"label":"GenderSummary","linkedLabel":"GenderSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_gender_list+responses+200+application-json+results\} - - - - - - - - - -#### GenderSummary \{#operation-api_v2_gender_list+responses+200+application-json+results+gendersummary\} - - - - - - - - - -##### name \{#operation-api_v2_gender_list+responses+200+application-json+results+gendersummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_gender_list+responses+200+application-json+results+gendersummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/gender/\{id\}/ \{#operation-api_v2_gender_retrieve\} - - - - - -_Get gender_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_gender_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_gender_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_gender_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_gender_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_gender_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_gender_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "pokemon_species_details": [ - { - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "1" - } - ], - "required_for_evolution": [ - { - "name": "wormadam", - "url": "https://pokeapi.co/api/v2/pokemon-species/413/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_gender_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_gender_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_gender_retrieve+responses+200+application-json+name\} - - - - - -pokemon_species_detail","children":[{"label":"pokemon_species_detail","linkedLabel":"pokemon_species_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species_details \{#operation-api_v2_gender_retrieve+responses+200+application-json+pokemon_species_details\} - - - - - - - - - -#### pokemon\_species\_detail \{#operation-api_v2_gender_retrieve+responses+200+application-json+pokemon_species_details+pokemon_species_detail\} - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species \{#operation-api_v2_gender_retrieve+responses+200+application-json+pokemon_species_details+pokemon_species_detail+pokemon_species\} - - - - - - - - - - - - - -##### rate \{#operation-api_v2_gender_retrieve+responses+200+application-json+pokemon_species_details+pokemon_species_detail+rate\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -required_for_evolution","children":[{"label":"required_for_evolution","linkedLabel":"required_for_evolution","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### required_for_evolution \{#operation-api_v2_gender_retrieve+responses+200+application-json+required_for_evolution\} - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/growth-rate/ \{#operation-api_v2_growth_rate_list\} - - - - - -_List growth rates_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_growth_rate_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_growth_rate_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_growth_rate_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_growth_rate_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_growth_rate_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_growth_rate_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_growth_rate_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_growth_rate_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_growth_rate_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_growth_rate_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_growth_rate_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_growth_rate_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GrowthRateSummary","children":[{"label":"GrowthRateSummary","linkedLabel":"GrowthRateSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_growth_rate_list+responses+200+application-json+results\} - - - - - - - - - -#### GrowthRateSummary \{#operation-api_v2_growth_rate_list+responses+200+application-json+results+growthratesummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_list+responses+200+application-json+results+growthratesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_list+responses+200+application-json+results+growthratesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/growth-rate/\{id\}/ \{#operation-api_v2_growth_rate_retrieve\} - - - - - -_Get growth rate_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_growth_rate_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_growth_rate_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_growth_rate_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_growth_rate_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_growth_rate_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_growth_rate_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "formula": "reprehenderit ut dolore", - "id": 87, - "levels": [ - { - "experience": 14, - "level": 56 - } - ], - "name": "occaecat dolor sit", - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_growth_rate_retrieve+responses\} - - - - - -200 - - - - - - - -GrowthRateDescription","children":[{"label":"GrowthRateDescription","linkedLabel":"GrowthRateDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### GrowthRateDescription \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription\} - - - - - - - - - -##### description \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+descriptions+growthratedescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### formula \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+formula\} - - - - - - - - - -##### id \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+id\} - - - - - -Experience","children":[{"label":"Experience","linkedLabel":"Experience","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### levels \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+levels\} - - - - - - - - - -#### Experience \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+levels+experience\} - - - - - - - - - -##### experience \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+levels+experience+experience\} - - - - - - - - - -##### level \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+levels+experience+level\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+name\} - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_growth_rate_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-damage-class/ \{#operation-api_v2_move_damage_class_list\} - - - - - -_List move damage classes_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - -
    - - - -### Security \{#operation-api_v2_move_damage_class_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_damage_class_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_damage_class_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_damage_class_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_move_damage_class_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_move_damage_class_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_move_damage_class_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_damage_class_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_damage_class_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_move_damage_class_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_move_damage_class_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_move_damage_class_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveDamageClassSummary","children":[{"label":"MoveDamageClassSummary","linkedLabel":"MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_move_damage_class_list+responses+200+application-json+results\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_move_damage_class_list+responses+200+application-json+results+movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_list+responses+200+application-json+results+movedamageclasssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_list+responses+200+application-json+results+movedamageclasssummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-damage-class/\{id\}/ \{#operation-api_v2_move_damage_class_retrieve\} - - - - - -_Get move damage class_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - -
    - - - -### Security \{#operation-api_v2_move_damage_class_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_move_damage_class_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_move_damage_class_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_move_damage_class_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_move_damage_class_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_move_damage_class_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_move_damage_class_retrieve+responses\} - - - - - -200 - - - - - - - -MoveDamageClassDescription","children":[{"label":"MoveDamageClassDescription","linkedLabel":"MoveDamageClassDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions\} - - - - - - - - - -#### MoveDamageClassDescription \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription\} - - - - - - - - - -##### description \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+descriptions+movedamageclassdescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+id\} - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+moves+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+moves+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+moves+movesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+name\} - - - - - -MoveDamageClassName","children":[{"label":"MoveDamageClassName","linkedLabel":"MoveDamageClassName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### MoveDamageClassName \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_move_damage_class_retrieve+responses+200+application-json+names+movedamageclassname+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/nature/ \{#operation-api_v2_nature_list\} - - - - - -_List natures_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_nature_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_nature_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_nature_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_nature_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_nature_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_nature_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_nature_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_nature_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_nature_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_nature_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_nature_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_nature_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -NatureSummary","children":[{"label":"NatureSummary","linkedLabel":"NatureSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_nature_list+responses+200+application-json+results\} - - - - - - - - - -#### NatureSummary \{#operation-api_v2_nature_list+responses+200+application-json+results+naturesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_list+responses+200+application-json+results+naturesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_list+responses+200+application-json+results+naturesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/nature/\{id\}/ \{#operation-api_v2_nature_retrieve\} - - - - - -_Get nature_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_nature_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_nature_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_nature_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_nature_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_nature_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_nature_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "decreased_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "hates_flavor": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "id": 87, - "increased_stat": { - "name": "irure", - "url": "dolor" - }, - "likes_flavor": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "move_battle_style_preferences": [ - { - "high_hp_preference": 14, - "low_hp_preference": 56, - "move_battle_style": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "name": "fugiat", - "names": [ - { - "language": { - "name": "non nisi proident Lorem", - "url": "nostrud anim" - }, - "name": "exercitation aliqua sint" - } - ], - "pokeathlon_stat_changes": [ - { - "max_change": "1", - "pokeathlon_stat": { - "name": "power", - "url": "https://pokeapi.co/api/v2/pokeathlon-stat/2/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_nature_retrieve+responses\} - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries \{#operation-api_v2_nature_retrieve+responses+200+application-json+berries\} - - - - - - - - - -#### BerrySummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+berries+berrysummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+berries+berrysummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+berries+berrysummary+url\} - - - - - - - - - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### decreased_stat \{#operation-api_v2_nature_retrieve+responses+200+application-json+decreased_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+decreased_stat+statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+decreased_stat+statsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+decreased_stat+statsummary+url\} - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hates_flavor \{#operation-api_v2_nature_retrieve+responses+200+application-json+hates_flavor\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+hates_flavor+berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+hates_flavor+berryflavorsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+hates_flavor+berryflavorsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_nature_retrieve+responses+200+application-json+id\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### increased_stat \{#operation-api_v2_nature_retrieve+responses+200+application-json+increased_stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+increased_stat+statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+increased_stat+statsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+increased_stat+statsummary+url\} - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes_flavor \{#operation-api_v2_nature_retrieve+responses+200+application-json+likes_flavor\} - - - - - - - - - -#### BerryFlavorSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+likes_flavor+berryflavorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+likes_flavor+berryflavorsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+likes_flavor+berryflavorsummary+url\} - - - - - - - - - - - - - -NatureBattleStylePreference","children":[{"label":"NatureBattleStylePreference","linkedLabel":"NatureBattleStylePreference","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_battle_style_preferences \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences\} - - - - - - - - - -#### NatureBattleStylePreference \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference\} - - - - - - - - - -##### high_hp_preference \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+high_hp_preference\} - - - - - - - - - -##### low_hp_preference \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+low_hp_preference\} - - - - - -MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_battle_style \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+move_battle_style\} - - - - - - - - - -#### MoveBattleStyleSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+move_battle_style+movebattlestylesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+move_battle_style+movebattlestylesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+move_battle_style_preferences+naturebattlestylepreference+move_battle_style+movebattlestylesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+name\} - - - - - -NatureName","children":[{"label":"NatureName","linkedLabel":"NatureName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_nature_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### NatureName \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_nature_retrieve+responses+200+application-json+names+naturename+name\} - - - - - - - - - - - - - -pokeathlon_stat_change","children":[{"label":"pokeathlon_stat_change","linkedLabel":"pokeathlon_stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokeathlon_stat_changes \{#operation-api_v2_nature_retrieve+responses+200+application-json+pokeathlon_stat_changes\} - - - - - - - - - -#### pokeathlon\_stat\_change \{#operation-api_v2_nature_retrieve+responses+200+application-json+pokeathlon_stat_changes+pokeathlon_stat_change\} - - - - - - - - - -##### max_change \{#operation-api_v2_nature_retrieve+responses+200+application-json+pokeathlon_stat_changes+pokeathlon_stat_change+max_change\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokeathlon_stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokeathlon_stat \{#operation-api_v2_nature_retrieve+responses+200+application-json+pokeathlon_stat_changes+pokeathlon_stat_change+pokeathlon_stat\} - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/ \{#operation-api_v2_pokemon_list\} - - - - - -_List pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSummary","children":[{"label":"PokemonSummary","linkedLabel":"PokemonSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonSummary \{#operation-api_v2_pokemon_list+responses+200+application-json+results+pokemonsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_list+responses+200+application-json+results+pokemonsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_list+responses+200+application-json+results+pokemonsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/\{id\}/ \{#operation-api_v2_pokemon_retrieve\} - - - - - -_Get pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 1, - "name": "Rambo", - "base_experience": 64, - "height": 7, - "is_legendary": false, - "is_mythical": false, - "order": 1, - "weight": 60 -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_retrieve+responses\} - - - - - -200 - - - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+abilities\} - - - - - - - - - -#### ability \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+abilities+ability\} - - - - - - - - - -##### is_hidden \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+abilities+ability+is_hidden\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+abilities+ability+slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### base_experience \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+base_experience\} - - - - - -cries","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### cries \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+cries\} - - - - - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### forms \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+forms\} - - - - - - - - - -#### PokemonFormSummary \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+forms+pokemonformsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+forms+pokemonformsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+forms+pokemonformsummary+url\} - - - - - - - - - - - - - -PokemonGameIndex","children":[{"label":"PokemonGameIndex","linkedLabel":"PokemonGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices\} - - - - - - - - - -#### PokemonGameIndex \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex+game_index\} - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex+version\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex+version+versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex+version+versionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+game_indices+pokemongameindex+version+versionsummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### height \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+height\} - - - - - -held_item","children":[{"label":"held_item","linkedLabel":"held_item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_items \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items\} - - - - - - - - - -#### held\_item \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item\} - - - - - -item","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### item \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item+item\} - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item+version_details\} - - - - - - - - - -#### version\_detail \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item+version_details+version_detail\} - - - - - - - - - -##### rarity \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item+version_details+version_detail+rarity\} - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+held_items+held_item+version_details+version_detail+version\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+is_default\} - - - - - - - - - -##### location_area_encounters \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+location_area_encounters\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon/1/encounters -``` - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### move \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move\} - - - - - -version_group_detail","children":[{"label":"version_group_detail","linkedLabel":"version_group_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group_details \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move+version_group_details\} - - - - - - - - - -#### version\_group\_detail \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move+version_group_details+version_group_detail\} - - - - - - - - - -##### level_learned_at \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move+version_group_details+version_group_detail+level_learned_at\} - - - - - -_Example:_ - -``` -1 -``` - - - - - -move_learn_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_learn_method \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move+version_group_details+version_group_detail+move_learn_method\} - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+moves+move+version_group_details+version_group_detail+version_group\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+name\} - - - - - - - - - -##### order \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+order\} - - - - - -past_ability","children":[{"label":"past_ability","linkedLabel":"past_ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_abilities \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities\} - - - - - - - - - -#### past\_ability \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability\} - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### abilities \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability+abilities\} - - - - - - - - - -#### ability \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability+abilities+ability\} - - - - - - - - - -##### is_hidden \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability+abilities+ability+is_hidden\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability+abilities+ability+slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_abilities+past_ability+generation\} - - - - - - - - - - - - - - - - - -past_type","children":[{"label":"past_type","linkedLabel":"past_type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_types \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types\} - - - - - - - - - -#### past\_type \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types+past_type\} - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types+past_type+generation\} - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### types \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types+past_type+types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types+past_type+types+type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+past_types+past_type+types+type+slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### species \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+species+pokemonspeciessummary+url\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+sprites\} - - - - - - - - - -PokemonStat","children":[{"label":"PokemonStat","linkedLabel":"PokemonStat","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stats \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats\} - - - - - - - - - -#### PokemonStat \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat\} - - - - - - - - - -##### base_stat \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+base_stat\} - - - - - - - - - -##### effort \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+effort\} - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+stat\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+stat+statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+stat+statsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+stats+pokemonstat+stat+statsummary+url\} - - - - - - - - - - - - - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+types+type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+types+type+slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### weight \{#operation-api_v2_pokemon_retrieve+responses+200+application-json+weight\} - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-color/ \{#operation-api_v2_pokemon_color_list\} - - - - - -_List pokemon colors_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_color_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_color_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_color_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_color_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_color_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_color_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_color_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_color_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_color_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_color_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_color_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_color_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonColorSummary","children":[{"label":"PokemonColorSummary","linkedLabel":"PokemonColorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_color_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonColorSummary \{#operation-api_v2_pokemon_color_list+responses+200+application-json+results+pokemoncolorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_list+responses+200+application-json+results+pokemoncolorsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_list+responses+200+application-json+results+pokemoncolorsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-color/\{id\}/ \{#operation-api_v2_pokemon_color_retrieve\} - - - - - -_Get pokemon color_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_color_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_color_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_color_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_color_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_color_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_color_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_color_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+name\} - - - - - -PokemonColorName","children":[{"label":"PokemonColorName","linkedLabel":"PokemonColorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### PokemonColorName \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+names+pokemoncolorname+name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_color_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-form/ \{#operation-api_v2_pokemon_form_list\} - - - - - -_List pokemon forms_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_form_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_form_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_form_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_form_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_form_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_form_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_form_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_form_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_form_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_form_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_form_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_form_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_form_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonFormSummary \{#operation-api_v2_pokemon_form_list+responses+200+application-json+results+pokemonformsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_list+responses+200+application-json+results+pokemonformsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_list+responses+200+application-json+results+pokemonformsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-form/\{id\}/ \{#operation-api_v2_pokemon_form_retrieve\} - - - - - -_Get pokemon form_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_form_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_form_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_form_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_form_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_form_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_form_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "form_name": "ipsum eiusmod", - "form_names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "id": 87, - "name": "nostrud", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "pokemon": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "sprites": {}, - "types": [ - { - "slot": "1", - "type": { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - } - ], - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_form_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### form_name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_name\} - - - - - -form_name","children":[{"label":"form_name","linkedLabel":"form_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_names \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_names\} - - - - - - - - - -#### form\_name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_names+form_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_names+form_name+language\} - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_names+form_name+name\} - - - - - -_Example:_ - -``` -Plant Cloak -``` - - - - - - - - - - - - - - - - - -##### form_order \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+form_order\} - - - - - - - - - -##### id \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_battle_only \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+is_battle_only\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+is_default\} - - - - - - - - - -##### is_mega \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+is_mega\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+names+name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+names+name+language\} - - - - - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+order\} - - - - - -PokemonSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+pokemon\} - - - - - - - - - -#### PokemonSummary \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+pokemon+pokemonsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+pokemon+pokemonsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+pokemon+pokemonsummary+url\} - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+sprites\} - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+types\} - - - - - - - - - -#### type \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+types+type\} - - - - - - - - - -##### slot \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+types+type+slot\} - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+version_group\} - - - - - - - - - -#### VersionGroupSummary \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+version_group+versiongroupsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+version_group+versiongroupsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_form_retrieve+responses+200+application-json+version_group+versiongroupsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-habitat/ \{#operation-api_v2_pokemon_habitat_list\} - - - - - -_List pokemom habitas_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_habitat_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_habitat_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_habitat_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_habitat_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_habitat_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_habitat_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_habitat_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_habitat_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_habitat_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonHabitatSummary","children":[{"label":"PokemonHabitatSummary","linkedLabel":"PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonHabitatSummary \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+results+pokemonhabitatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+results+pokemonhabitatsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_list+responses+200+application-json+results+pokemonhabitatsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-habitat/\{id\}/ \{#operation-api_v2_pokemon_habitat_retrieve\} - - - - - -_Get pokemom habita_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_habitat_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_habitat_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_habitat_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_habitat_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_habitat_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_habitat_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_habitat_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+name\} - - - - - -PokemonHabitatName","children":[{"label":"PokemonHabitatName","linkedLabel":"PokemonHabitatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### PokemonHabitatName \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+names+pokemonhabitatname+name\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_habitat_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-shape/ \{#operation-api_v2_pokemon_shape_list\} - - - - - -_List pokemon shapes_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_shape_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_shape_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_shape_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_shape_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_shape_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_shape_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_shape_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_shape_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_shape_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonShapeSummary","children":[{"label":"PokemonShapeSummary","linkedLabel":"PokemonShapeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonShapeSummary \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+results+pokemonshapesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+results+pokemonshapesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_list+responses+200+application-json+results+pokemonshapesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-shape/\{id\}/ \{#operation-api_v2_pokemon_shape_retrieve\} - - - - - -_Get pokemon shape_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_shape_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_shape_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_shape_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_shape_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_shape_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_shape_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "awesome_names": [ - { - "awesome_name": "Pomaceous", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "id": 87, - "name": "occaecat dolor sit", - "names": [ - { - "name": "Ball", - "url": "https://pokeapi.co/api/v2/language/9/" - } - ], - "pokemon_species": [ - { - "name": "irure", - "url": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_shape_retrieve+responses\} - - - - - -200 - - - - - - - -awesome_name","children":[{"label":"awesome_name","linkedLabel":"awesome_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### awesome_names \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+awesome_names\} - - - - - - - - - -#### awesome\_name \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+awesome_names+awesome_name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+awesome_names+awesome_name+language\} - - - - - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+names+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+names+name+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/language/9/ -``` - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+pokemon_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_shape_retrieve+responses+200+application-json+pokemon_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-species/ \{#operation-api_v2_pokemon_species_list\} - - - - - -_List pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_species_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_species_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_species_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_species_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokemon_species_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokemon_species_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokemon_species_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_species_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_species_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokemon_species_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokemon_species_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokemon_species_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokemon_species_list+responses+200+application-json+results\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_species_list+responses+200+application-json+results+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_list+responses+200+application-json+results+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_list+responses+200+application-json+results+pokemonspeciessummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-species/\{id\}/ \{#operation-api_v2_pokemon_species_retrieve\} - - - - - -_Get pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - -
    - - - -### Security \{#operation-api_v2_pokemon_species_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokemon_species_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokemon_species_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokemon_species_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokemon_species_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokemon_species_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "color": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "egg_groups": [ - { - "name": "monster", - "url": "https://pokeapi.co/api/v2/egg-group/1/" - } - ], - "evolution_chain": { - "url": "nostrud" - }, - "evolves_from_species": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "flavor_text_entries": [ - { - "flavor_text": "dolor", - "language": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "form_descriptions": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "genera": [ - { - "genus": "Seed Pokémon", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "generation": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "growth_rate": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "habitat": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "id": 87, - "name": "proident", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "bulbasaur" - } - ], - "pal_park_encounters": [ - { - "area": { - "name": "field", - "url": "https://pokeapi.co/api/v2/pal-park-area/2/" - }, - "base_score": "50", - "rate": "30" - } - ], - "pokedex_numbers": [ - { - "entry_number": 91, - "pokedex": { - "name": "sunt amet", - "url": "duis ea" - } - } - ], - "shape": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "varieties": [ - { - "is_default": false, - "pokemon": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon/1/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokemon_species_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### base_happiness \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+base_happiness\} - - - - - - - - - -##### capture_rate \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+capture_rate\} - - - - - -PokemonColorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### color \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+color\} - - - - - - - - - -#### PokemonColorSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+color+pokemoncolorsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+color+pokemoncolorsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+color+pokemoncolorsummary+url\} - - - - - - - - - - - - - -egg_group","children":[{"label":"egg_group","linkedLabel":"egg_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### egg_groups \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+egg_groups\} - - - - - - - - - -#### egg\_group \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+egg_groups+egg_group\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+egg_groups+egg_group+name\} - - - - - -_Example:_ - -``` -monster -``` - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+egg_groups+egg_group+url\} - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/egg-group/1/ -``` - - - - - - - - - - - - - -EvolutionChainSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolution_chain \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolution_chain\} - - - - - - - - - -#### EvolutionChainSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolution_chain+evolutionchainsummary\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolution_chain+evolutionchainsummary+url\} - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolves_from_species \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolves_from_species\} - - - - - - - - - -#### PokemonSpeciesSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolves_from_species+pokemonspeciessummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolves_from_species+pokemonspeciessummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+evolves_from_species+pokemonspeciessummary+url\} - - - - - - - - - - - - - -PokemonSpeciesFlavorText","children":[{"label":"PokemonSpeciesFlavorText","linkedLabel":"PokemonSpeciesFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries\} - - - - - - - - - -#### PokemonSpeciesFlavorText \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext\} - - - - - - - - - -##### flavor_text \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+flavor_text\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+language+languagesummary+url\} - - - - - - - - - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+version\} - - - - - - - - - -#### VersionSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+version+versionsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+version+versionsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+flavor_text_entries+pokemonspeciesflavortext+version+versionsummary+url\} - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesDescription","children":[{"label":"PokemonSpeciesDescription","linkedLabel":"PokemonSpeciesDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_descriptions \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions\} - - - - - - - - - -#### PokemonSpeciesDescription \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription\} - - - - - - - - - -##### description \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription+description\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+form_descriptions+pokemonspeciesdescription+language+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - - - - - -##### forms_switchable \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+forms_switchable\} - - - - - - - - - -##### gender_rate \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+gender_rate\} - - - - - -genus","children":[{"label":"genus","linkedLabel":"genus","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### genera \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+genera\} - - - - - - - - - -#### genus \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+genera+genus\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+genera+genus+language\} - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+generation+generationsummary+url\} - - - - - - - - - - - - - -GrowthRateSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### growth_rate \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+growth_rate\} - - - - - - - - - -#### GrowthRateSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+growth_rate+growthratesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+growth_rate+growthratesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+growth_rate+growthratesummary+url\} - - - - - - - - - - - - - -PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### habitat \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+habitat\} - - - - - - - - - -#### PokemonHabitatSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+habitat+pokemonhabitatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+habitat+pokemonhabitatsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+habitat+pokemonhabitatsummary+url\} - - - - - - - - - - - - - - - - - -##### has_gender_differences \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+has_gender_differences\} - - - - - - - - - -##### hatch_counter \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+hatch_counter\} - - - - - - - - - -##### id \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_baby \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+is_baby\} - - - - - - - - - -##### is_legendary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+is_legendary\} - - - - - - - - - -##### is_mythical \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+is_mythical\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+name\} - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+names+name\} - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+names+name+language\} - - - - - - - - - - - - - - - - - - - - - -##### order \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+order\} - - - - - -pal_park_encounter","children":[{"label":"pal_park_encounter","linkedLabel":"pal_park_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pal_park_encounters \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pal_park_encounters\} - - - - - - - - - -#### pal\_park\_encounter \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pal_park_encounters+pal_park_encounter\} - - - - - -area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### area \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pal_park_encounters+pal_park_encounter+area\} - - - - - - - - - - - - - -##### base_score \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pal_park_encounters+pal_park_encounter+base_score\} - - - - - -_Example:_ - -``` -50 -``` - - - - - - - - - -##### rate \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pal_park_encounters+pal_park_encounter+rate\} - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - -PokemonDexEntry","children":[{"label":"PokemonDexEntry","linkedLabel":"PokemonDexEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedex_numbers \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers\} - - - - - - - - - -#### PokemonDexEntry \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry\} - - - - - - - - - -##### entry_number \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry+entry_number\} - - - - - -PokedexSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokedex \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry+pokedex\} - - - - - - - - - -#### PokedexSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry+pokedex+pokedexsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry+pokedex+pokedexsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+pokedex_numbers+pokemondexentry+pokedex+pokedexsummary+url\} - - - - - - - - - - - - - - - - - - - - - -PokemonShapeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shape \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+shape\} - - - - - - - - - -#### PokemonShapeSummary \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+shape+pokemonshapesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+shape+pokemonshapesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+shape+pokemonshapesummary+url\} - - - - - - - - - - - - - -variety","children":[{"label":"variety","linkedLabel":"variety","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### varieties \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+varieties\} - - - - - - - - - -#### variety \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+varieties+variety\} - - - - - - - - - -##### is_default \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+varieties+variety+is_default\} - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon \{#operation-api_v2_pokemon_species_retrieve+responses+200+application-json+varieties+variety+pokemon\} - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokeathlon-stat/ \{#operation-api_v2_pokeathlon_stat_list\} - - - - - -_List pokeathlon stats_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokeathlon_stat_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokeathlon_stat_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokeathlon_stat_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokeathlon_stat_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_pokeathlon_stat_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_pokeathlon_stat_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_pokeathlon_stat_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokeathlon_stat_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokeathlon_stat_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokeathlonStatSummary","children":[{"label":"PokeathlonStatSummary","linkedLabel":"PokeathlonStatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+results\} - - - - - - - - - -#### PokeathlonStatSummary \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+results+pokeathlonstatsummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+results+pokeathlonstatsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokeathlon_stat_list+responses+200+application-json+results+pokeathlonstatsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokeathlon-stat/\{id\}/ \{#operation-api_v2_pokeathlon_stat_retrieve\} - - - - - -_Get pokeathlon stat_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - -
    - - - -### Security \{#operation-api_v2_pokeathlon_stat_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_pokeathlon_stat_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_pokeathlon_stat_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_pokeathlon_stat_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_pokeathlon_stat_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_pokeathlon_stat_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "affecting_natures": { - "decrease": [ - { - "max_change": "-1", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ], - "increase": [ - { - "max_change": "2", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ] - }, - "id": 56, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_pokeathlon_stat_retrieve+responses\} - - - - - -200 - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+affecting_natures\} - - - - - - - - - - - - - -##### id \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+name\} - - - - - -PokeathlonStatName","children":[{"label":"PokeathlonStatName","linkedLabel":"PokeathlonStatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### PokeathlonStatName \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_pokeathlon_stat_retrieve+responses+200+application-json+names+pokeathlonstatname+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/stat/ \{#operation-api_v2_stat_list\} - - - - - -_List stats_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - -
    - - - -### Security \{#operation-api_v2_stat_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_stat_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_stat_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_stat_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_stat_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_stat_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_stat_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_stat_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_stat_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_stat_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_stat_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_stat_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -StatSummary","children":[{"label":"StatSummary","linkedLabel":"StatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_stat_list+responses+200+application-json+results\} - - - - - - - - - -#### StatSummary \{#operation-api_v2_stat_list+responses+200+application-json+results+statsummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_list+responses+200+application-json+results+statsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_list+responses+200+application-json+results+statsummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/stat/\{id\}/ \{#operation-api_v2_stat_retrieve\} - - - - - -_Get stat_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - -
    - - - -### Security \{#operation-api_v2_stat_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_stat_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_stat_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_stat_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_stat_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_stat_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "affecting_moves": { - "decrease": [ - { - "change": "5", - "move": { - "name": "growl", - "url": "https://pokeapi.co/api/v2/move/45/" - } - } - ], - "increase": [ - { - "change": "-1", - "move": { - "name": "swords-dance", - "url": "https://pokeapi.co/api/v2/move/14/" - } - } - ] - }, - "affecting_natures": { - "decrease": [ - { - "name": "bold", - "url": "https://pokeapi.co/api/v2/nature/2/" - } - ], - "increase": [ - { - "name": "lonely", - "url": "https://pokeapi.co/api/v2/nature/6/" - } - ] - }, - "characteristics": [ - { - "url": "sunt" - } - ], - "game_index": 56, - "id": 91, - "move_damage_class": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "name": "occaecat", - "names": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - }, - "name": "nostrud anim" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_stat_retrieve+responses\} - - - - - -200 - - - - - - - -affecting_moves","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_moves \{#operation-api_v2_stat_retrieve+responses+200+application-json+affecting_moves\} - - - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures \{#operation-api_v2_stat_retrieve+responses+200+application-json+affecting_natures\} - - - - - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### characteristics \{#operation-api_v2_stat_retrieve+responses+200+application-json+characteristics\} - - - - - - - - - -#### CharacteristicSummary \{#operation-api_v2_stat_retrieve+responses+200+application-json+characteristics+characteristicsummary\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve+responses+200+application-json+characteristics+characteristicsummary+url\} - - - - - - - - - - - - - - - - - -##### game_index \{#operation-api_v2_stat_retrieve+responses+200+application-json+game_index\} - - - - - - - - - -##### id \{#operation-api_v2_stat_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### is_battle_only \{#operation-api_v2_stat_retrieve+responses+200+application-json+is_battle_only\} - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class \{#operation-api_v2_stat_retrieve+responses+200+application-json+move_damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_stat_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve+responses+200+application-json+name\} - - - - - -StatName","children":[{"label":"StatName","linkedLabel":"StatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_stat_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### StatName \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_stat_retrieve+responses+200+application-json+names+statname+name\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/type/ \{#operation-api_v2_type_list\} - - - - - -_List types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - -
    - - - -### Security \{#operation-api_v2_type_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_type_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_type_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_type_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_type_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_type_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_type_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_type_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_type_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_type_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_type_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_type_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_type_list+responses+200+application-json+results\} - - - - - - - - - -#### TypeSummary \{#operation-api_v2_type_list+responses+200+application-json+results+typesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_list+responses+200+application-json+results+typesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_list+responses+200+application-json+results+typesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/type/\{id\}/ \{#operation-api_v2_type_retrieve\} - - - - - -_Get types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - -
    - - - -### Security \{#operation-api_v2_type_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_type_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_type_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_type_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_type_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_type_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 14, - "move_damage_class": { - "name": "ut sint", - "url": "dolor voluptate eu" - }, - "moves": [ - { - "name": "quis minim non magna quis", - "url": "et voluptate" - } - ], - "name": "commodo labore aliqua ad", - "names": [ - { - "language": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "name": "proident" - } - ], - "past_damage_relations": [ - { - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "generation": { - "name": "generation-v", - "url": "https://pokeapi.co/api/v2/generation/5/" - } - } - ], - "pokemon": [ - {} - ], - "sprites": [ - [ - {} - ] - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_type_retrieve+responses\} - - - - - -200 - - - - - - - -Serializer for the Type resource - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_relations \{#operation-api_v2_type_retrieve+responses+200+application-json+damage_relations\} - - - - - - - - - -TypeGameIndex","children":[{"label":"TypeGameIndex","linkedLabel":"TypeGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices\} - - - - - - - - - -#### TypeGameIndex \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex\} - - - - - - - - - -##### game_index \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex+game_index\} - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve+responses+200+application-json+game_indices+typegameindex+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation \{#operation-api_v2_type_retrieve+responses+200+application-json+generation\} - - - - - - - - - -#### GenerationSummary \{#operation-api_v2_type_retrieve+responses+200+application-json+generation+generationsummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+generation+generationsummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve+responses+200+application-json+generation+generationsummary+url\} - - - - - - - - - - - - - - - - - -##### id \{#operation-api_v2_type_retrieve+responses+200+application-json+id\} - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class \{#operation-api_v2_type_retrieve+responses+200+application-json+move_damage_class\} - - - - - - - - - -#### MoveDamageClassSummary \{#operation-api_v2_type_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve+responses+200+application-json+move_damage_class+movedamageclasssummary+url\} - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves \{#operation-api_v2_type_retrieve+responses+200+application-json+moves\} - - - - - - - - - -#### MoveSummary \{#operation-api_v2_type_retrieve+responses+200+application-json+moves+movesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+moves+movesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve+responses+200+application-json+moves+movesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+name\} - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_type_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### AbilityName \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_type_retrieve+responses+200+application-json+names+abilityname+name\} - - - - - - - - - - - - - -past_damage_relation","children":[{"label":"past_damage_relation","linkedLabel":"past_damage_relation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_damage_relations \{#operation-api_v2_type_retrieve+responses+200+application-json+past_damage_relations\} - - - - - - - - - -#### past\_damage\_relation \{#operation-api_v2_type_retrieve+responses+200+application-json+past_damage_relations+past_damage_relation\} - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### damage_relations \{#operation-api_v2_type_retrieve+responses+200+application-json+past_damage_relations+past_damage_relation+damage_relations\} - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation \{#operation-api_v2_type_retrieve+responses+200+application-json+past_damage_relations+past_damage_relation+generation\} - - - - - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon \{#operation-api_v2_type_retrieve+responses+200+application-json+pokemon\} - - - - - - - - - -sprites","children":[{"label":"map","linkedLabel":"sprites","children":[{"label":"sprites","linkedLabel":"sprites","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites \{#operation-api_v2_type_retrieve+responses+200+application-json+sprites\} - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/endpoint/utility.mdx b/examples/docusaurus/docs/pokeapi/api/endpoint/utility.mdx deleted file mode 100644 index 65d087949..000000000 --- a/examples/docusaurus/docs/pokeapi/api/endpoint/utility.mdx +++ /dev/null @@ -1,896 +0,0 @@ ---- -sidebar_position: 3.10 -sidebar_label: Utility ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Utility Endpoints - - - - - - - - - -## GET /api/v2/language/ \{#operation-api_v2_language_list\} - - - - - -_List languages_ - - - - - -Languages for translations of API resource information. - - - - - -
    - - - -### Security \{#operation-api_v2_language_list+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_language_list+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_language_list+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_language_list+parameters\} - - - - - - - - - - - -##### limit \{#operation-api_v2_language_list+parameters+limit\} - - - - - -Number of results to return per page. - - - - - - - - - -##### offset \{#operation-api_v2_language_list+parameters+offset\} - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q \{#operation-api_v2_language_list+parameters+q\} - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_language_list+responses-examples\} - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_language_list+responses\} - - - - - -200 - - - - - - - - - - - -##### count \{#operation-api_v2_language_list+responses+200+application-json+count\} - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next \{#operation-api_v2_language_list+responses+200+application-json+next\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous \{#operation-api_v2_language_list+responses+200+application-json+previous\} - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LanguageSummary","children":[{"label":"LanguageSummary","linkedLabel":"LanguageSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#operation-api_v2_language_list+responses+200+application-json+results\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_language_list+responses+200+application-json+results+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_language_list+responses+200+application-json+results+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_language_list+responses+200+application-json+results+languagesummary+url\} - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/language/\{id\}/ \{#operation-api_v2_language_retrieve\} - - - - - -_Get language_ - - - - - -Languages for translations of API resource information. - - - - - -
    - - - -### Security \{#operation-api_v2_language_retrieve+security\} - - - - - - - - - - - -##### cookieAuth \{#operation-api_v2_language_retrieve+security+cookieauth\} - - - - - - - - - -##### basicAuth \{#operation-api_v2_language_retrieve+security+basicauth\} - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters \{#operation-api_v2_language_retrieve+parameters\} - - - - - - - - - - - -##### id \{#operation-api_v2_language_retrieve+parameters+id\} - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples \{#operation-api_v2_language_retrieve+responses-examples\} - - - - - -200 - - - - - -```json -{ - "id": 87, - "iso3166": "ipsum eiusmod", - "iso639": "consequat do", - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses \{#operation-api_v2_language_retrieve+responses\} - - - - - -200 - - - - - - - - - - - -##### id \{#operation-api_v2_language_retrieve+responses+200+application-json+id\} - - - - - - - - - -##### iso3166 \{#operation-api_v2_language_retrieve+responses+200+application-json+iso3166\} - - - - - - - - - -##### iso639 \{#operation-api_v2_language_retrieve+responses+200+application-json+iso639\} - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve+responses+200+application-json+name\} - - - - - -LanguageName","children":[{"label":"LanguageName","linkedLabel":"LanguageName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names \{#operation-api_v2_language_retrieve+responses+200+application-json+names\} - - - - - - - - - -#### LanguageName \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename\} - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename+language\} - - - - - - - - - -#### LanguageSummary \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename+language+languagesummary\} - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename+language+languagesummary+name\} - - - - - - - - - -##### url \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename+language+languagesummary+url\} - - - - - - - - - - - - - - - - - -##### name \{#operation-api_v2_language_retrieve+responses+200+application-json+names+languagename+name\} - - - - - - - - - - - - - - - - - -##### official \{#operation-api_v2_language_retrieve+responses+200+application-json+official\} - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/docusaurus/docs/pokeapi/api/index.mdx b/examples/docusaurus/docs/pokeapi/api/index.mdx deleted file mode 100644 index bc0b86267..000000000 --- a/examples/docusaurus/docs/pokeapi/api/index.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: About ---- - -import "@speakeasy-api/docs-md-react/docusaurus.css"; - -import { - Pill -} from "@speakeasy-api/docs-md-react"; - -# About PokéAPI - -_Version: 2.7.0_ - -All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API. - -## What is this? - -This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series. - -We've covered everything from Pokémon to Berry Flavors. - -## Where do I start? - -We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started. - -This API will always be publicly available and will never require any extensive setup process to consume. - -Created by [**Paul Hallett**](https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo. - - -Servers - -- https://pokeapi.co - -## Global Security - -### cookieAuth cookie apiKey \{#cookieAuth\} \ No newline at end of file diff --git a/examples/docusaurus/docusaurus.config.ts b/examples/docusaurus/docusaurus.config.ts deleted file mode 100644 index 75a5861f3..000000000 --- a/examples/docusaurus/docusaurus.config.ts +++ /dev/null @@ -1,173 +0,0 @@ -import { themes as prismThemes } from "prism-react-renderer"; -import type { Config } from "@docusaurus/types"; -import type * as Preset from "@docusaurus/preset-classic"; - -// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) - -const config: Config = { - title: "My Site", - tagline: "Dinosaurs are cool", - favicon: "img/favicon.ico", - - // Set the production url of your site here - url: "https://your-docusaurus-site.example.com", - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' - baseUrl: "/", - - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: "facebook", // Usually your GitHub org/user name. - projectName: "docusaurus", // Usually your repo name. - - onBrokenLinks: "throw", - - // Even if you don't use internationalization, you can use this field to set - // useful metadata like html lang. For example, if your site is Chinese, you - // may want to replace "en" with "zh-Hans". - i18n: { - defaultLocale: "en", - locales: ["en"], - }, - - staticDirectories: ["public", "static"], - - presets: [ - [ - "classic", - { - docs: { - path: "docs/pokeapi", - routeBasePath: "pokeapi", - sidebarPath: "./sidebars.ts", - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", - }, - theme: { - customCss: "./src/css/custom.css", - }, - } satisfies Preset.Options, - ], - ], - - plugins: [ - // Process source maps from workspace packages and embed source content - function webpackSourceMapsPlugin() { - return { - name: "webpack-source-maps-plugin", - configureWebpack(config, isServer, utils) { - if (isServer) { - return {}; - } - - const path = require("path"); - const packagesDir = path.resolve(__dirname, "../../packages"); - - return { - devtool: "eval-source-map", - module: { - rules: [ - { - test: /\.(js|mjs|jsx|ts|tsx)$/, - // Process files from workspace packages - include: packagesDir, - enforce: "pre", - use: [ - { - loader: require.resolve("source-map-loader"), - }, - ], - }, - ], - }, - }; - }, - }; - }, - [ - "@docusaurus/plugin-content-docs", - { - id: "glean", - path: "docs/glean", - routeBasePath: "glean", - sidebarPath: "./sidebars.ts", - // ... other options - }, - ], - [ - "@docusaurus/plugin-content-docs", - { - id: "mistral", - path: "docs/mistral", - routeBasePath: "mistral", - sidebarPath: "./sidebars.ts", - // ... other options - }, - ], - ], - - themeConfig: { - // Replace with your project's social card - image: "img/docusaurus-social-card.jpg", - colorMode: { - respectPrefersColorScheme: true, - }, - navbar: { - title: "My Site", - items: [ - { - label: "PokeAPI", - to: "/pokeapi/api", - }, - { - label: "Glean", - to: "/glean/api", - }, - { - label: "Mistral", - to: "/mistral/api", - }, - ], - }, - footer: { - style: "dark", - links: [ - { - title: "Community", - items: [ - { - label: "Stack Overflow", - href: "https://stackoverflow.com/questions/tagged/docusaurus", - }, - { - label: "Discord", - href: "https://discordapp.com/invite/docusaurus", - }, - { - label: "X", - href: "https://x.com/docusaurus", - }, - ], - }, - { - title: "More", - items: [ - { - label: "GitHub", - href: "https://github.com/facebook/docusaurus", - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - }, - } satisfies Preset.ThemeConfig, -}; - -export default config; diff --git a/examples/docusaurus/package.json b/examples/docusaurus/package.json deleted file mode 100644 index 5581187ec..000000000 --- a/examples/docusaurus/package.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "name": "docusaurus-example", - "version": "0.0.0", - "private": true, - "scripts": { - "docusaurus": "docusaurus", - "dev": "rm -rf .docusaurus node_modules/.cache && docusaurus start --no-open -p 3001", - "start": "http-server build -p 3001", - "build-api-docs": "docs-md -c speakeasy.glean.config.mjs && docs-md -c speakeasy.mistral.config.mjs && docs-md -c speakeasy.pokeapi.config.mjs", - "clean": "rm -rf .docusaurus node_modules/.cache build", - "prebuild": "cd ../../ && make build-packages", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "docusaurus deploy", - "clear": "docusaurus clear", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" - }, - "dependencies": { - "@codesandbox/sandpack-client": "^2.19.8", - "@codesandbox/sandpack-react": "^2.20.0", - "@docusaurus/core": "^3.7.0", - "@docusaurus/plugin-client-redirects": "^3.9.1", - "@docusaurus/plugin-content-docs": "^3.9.1", - "@docusaurus/preset-classic": "^3.7.0", - "@speakeasy-api/docs-md": "*", - "@speakeasy-api/docs-md-react": "*", - "http-server": "^14.1.1" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "^3.7.0", - "@docusaurus/tsconfig": "^3.7.0", - "@docusaurus/types": "^3.7.0", - "source-map-loader": "^5.0.0" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 3 chrome version", - "last 3 firefox version", - "last 5 safari version" - ] - }, - "engines": { - "node": ">=18.0" - } -} \ No newline at end of file diff --git a/examples/docusaurus/public/glean-try-it-now/deps.js b/examples/docusaurus/public/glean-try-it-now/deps.js deleted file mode 100644 index 19d5d02f0..000000000 --- a/examples/docusaurus/public/glean-try-it-now/deps.js +++ /dev/null @@ -1,24727 +0,0 @@ -(() => { - var __defProp = Object.defineProperty; - var __export = (target, all) => { - for (var name in all) - __defProp(target, name, { get: all[name], enumerable: true }); - }; - - // node_modules/@gleanwork/api-client/dist/esm/index.js - var esm_exports = {}; - __export(esm_exports, { - Glean: () => Glean, - HTTPClient: () => HTTPClient, - SDK_METADATA: () => SDK_METADATA, - ServerList: () => ServerList, - files: () => files_exports, - serverURLFromOptions: () => serverURLFromOptions - }); - - // node_modules/@gleanwork/api-client/dist/esm/lib/url.js - var hasOwn = Object.prototype.hasOwnProperty; - function pathToFunc(pathPattern, options) { - const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g; - return function buildURLPath(params = {}) { - return pathPattern.replace(paramRE, function(_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error(`Parameter '${placeholder}' must be a string or number`); - } - return options?.charEncoding === "percent" ? encodeURIComponent(`${value}`) : `${value}`; - }); - }; - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/config.js - var ServerList = [ - "https://{instance}-be.glean.com" - ]; - function serverURLFromOptions(options) { - let serverURL = options.serverURL; - const serverParams = [ - { - "instance": options.instance ?? "instance-name" - } - ]; - let params = {}; - if (!serverURL) { - const serverIdx = options.serverIdx ?? 0; - if (serverIdx < 0 || serverIdx >= ServerList.length) { - throw new Error(`Invalid server index ${serverIdx}`); - } - serverURL = ServerList[serverIdx] || ""; - params = serverParams[serverIdx] || {}; - } - const u = pathToFunc(serverURL)(params); - return new URL(u); - } - var SDK_METADATA = { - language: "typescript", - openapiDocVersion: "0.9.0", - sdkVersion: "0.11.2", - genVersion: "2.720.1", - userAgent: "speakeasy-sdk/typescript 0.11.2 2.720.1 0.9.0 @gleanwork/api-client" - }; - - // node_modules/@gleanwork/api-client/dist/esm/lib/files.js - var files_exports = {}; - __export(files_exports, { - getContentTypeFromFileName: () => getContentTypeFromFileName, - readableStreamToArrayBuffer: () => readableStreamToArrayBuffer - }); - async function readableStreamToArrayBuffer(readable) { - const reader = readable.getReader(); - const chunks = []; - let totalLength = 0; - let done = false; - while (!done) { - const { value, done: doneReading } = await reader.read(); - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - return concatenatedChunks.buffer; - } - function getContentTypeFromFileName(fileName) { - if (!fileName) - return null; - const ext = fileName.toLowerCase().split(".").pop(); - if (!ext) - return null; - const mimeTypes = { - json: "application/json", - xml: "application/xml", - html: "text/html", - htm: "text/html", - txt: "text/plain", - csv: "text/csv", - pdf: "application/pdf", - png: "image/png", - jpg: "image/jpeg", - jpeg: "image/jpeg", - gif: "image/gif", - svg: "image/svg+xml", - js: "application/javascript", - css: "text/css", - zip: "application/zip", - tar: "application/x-tar", - gz: "application/gzip", - mp4: "video/mp4", - mp3: "audio/mpeg", - wav: "audio/wav", - webp: "image/webp", - ico: "image/x-icon", - woff: "font/woff", - woff2: "font/woff2", - ttf: "font/ttf", - otf: "font/otf" - }; - return mimeTypes[ext] || null; - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/http.js - var DEFAULT_FETCHER = (input, init) => { - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } - }; - var HTTPClient = class _HTTPClient { - constructor(options = {}) { - this.options = options; - this.requestHooks = []; - this.requestErrorHooks = []; - this.responseHooks = []; - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - async request(request) { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - try { - const res = await this.fetcher(req); - for (const hook of this.responseHooks) { - await hook(res, req); - } - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - throw err; - } - } - addHook(...args) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - removeHook(...args) { - let target; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - return this; - } - clone() { - const child = new _HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - return child; - } - }; - var mediaParamSeparator = /\s*;\s*/g; - function matchContentType(response, pattern) { - if (pattern === "*") { - return true; - } - let contentType = response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - if (wantType.split("/").length !== 2) { - return false; - } - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - if (wantType !== "*/*" && gotType !== wantType && `${type}/*` !== wantType && `*/${subtype}` !== wantType) { - return false; - } - if (gotParams.length < wantParams.length) { - return false; - } - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - return true; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function matchStatusCode(response, codes) { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - return expectedCodes.some((ec) => { - const code = `${ec}`; - if (code === "default") { - return true; - } - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - function matchResponse(response, code, contentTypePattern) { - return matchStatusCode(response, code) && matchContentType(response, contentTypePattern); - } - function isConnectionError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isBrowserErr = err instanceof TypeError && err.message.toLowerCase().startsWith("failed to fetch"); - const isNodeErr = err instanceof TypeError && err.message.toLowerCase().startsWith("fetch failed"); - const isBunErr = "name" in err && err.name === "ConnectionError"; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnreset"; - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; - } - function isTimeoutError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - function isAbortError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - - // node_modules/@gleanwork/api-client/dist/esm/hooks/registration.js - function initHooks(hooks) { - } - - // node_modules/@gleanwork/api-client/dist/esm/hooks/hooks.js - var SDKHooks = class { - constructor() { - this.sdkInitHooks = []; - this.beforeCreateRequestHooks = []; - this.beforeRequestHooks = []; - this.afterSuccessHooks = []; - this.afterErrorHooks = []; - const presetHooks = []; - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - initHooks(this); - } - registerSDKInitHook(hook) { - this.sdkInitHooks.push(hook); - } - registerBeforeCreateRequestHook(hook) { - this.beforeCreateRequestHooks.push(hook); - } - registerBeforeRequestHook(hook) { - this.beforeRequestHooks.push(hook); - } - registerAfterSuccessHook(hook) { - this.afterSuccessHooks.push(hook); - } - registerAfterErrorHook(hook) { - this.afterErrorHooks.push(hook); - } - sdkInit(opts) { - return this.sdkInitHooks.reduce((opts2, hook) => hook.sdkInit(opts2), opts); - } - beforeCreateRequest(hookCtx, input) { - let inp = input; - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - return inp; - } - async beforeRequest(hookCtx, request) { - let req = request; - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - return req; - } - async afterSuccess(hookCtx, response) { - let res = response; - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - return res; - } - async afterError(hookCtx, response, error) { - let res = response; - let err = error; - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - return { response: res, error: err }; - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/httpclienterrors.js - var HTTPClientError = class extends Error { - constructor(message, opts) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - super(msg, opts); - this.name = "HTTPClientError"; - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } - }; - var UnexpectedClientError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "UnexpectedClientError"; - } - }; - var InvalidRequestError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "InvalidRequestError"; - } - }; - var RequestAbortedError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestAbortedError"; - } - }; - var RequestTimeoutError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestTimeoutError"; - } - }; - var ConnectionError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "ConnectionError"; - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/types/fp.js - function OK(value) { - return { ok: true, value }; - } - function ERR(error) { - return { ok: false, error }; - } - async function unwrapAsync(pr) { - const r = await pr; - if (!r.ok) { - throw r.error; - } - return r.value; - } - - // node_modules/zod/v3/helpers/util.js - var util; - (function(util2) { - util2.assertEqual = (_) => { - }; - function assertIs(_arg) { - } - util2.assertIs = assertIs; - function assertNever(_x) { - throw new Error(); - } - util2.assertNever = assertNever; - util2.arrayToEnum = (items) => { - const obj = {}; - for (const item of items) { - obj[item] = item; - } - return obj; - }; - util2.getValidEnumValues = (obj) => { - const validKeys = util2.objectKeys(obj).filter((k) => typeof obj[obj[k]] !== "number"); - const filtered = {}; - for (const k of validKeys) { - filtered[k] = obj[k]; - } - return util2.objectValues(filtered); - }; - util2.objectValues = (obj) => { - return util2.objectKeys(obj).map(function(e) { - return obj[e]; - }); - }; - util2.objectKeys = typeof Object.keys === "function" ? (obj) => Object.keys(obj) : (object) => { - const keys = []; - for (const key in object) { - if (Object.prototype.hasOwnProperty.call(object, key)) { - keys.push(key); - } - } - return keys; - }; - util2.find = (arr, checker) => { - for (const item of arr) { - if (checker(item)) - return item; - } - return void 0; - }; - util2.isInteger = typeof Number.isInteger === "function" ? (val) => Number.isInteger(val) : (val) => typeof val === "number" && Number.isFinite(val) && Math.floor(val) === val; - function joinValues(array, separator = " | ") { - return array.map((val) => typeof val === "string" ? `'${val}'` : val).join(separator); - } - util2.joinValues = joinValues; - util2.jsonStringifyReplacer = (_, value) => { - if (typeof value === "bigint") { - return value.toString(); - } - return value; - }; - })(util || (util = {})); - var objectUtil; - (function(objectUtil2) { - objectUtil2.mergeShapes = (first, second) => { - return { - ...first, - ...second - // second overwrites first - }; - }; - })(objectUtil || (objectUtil = {})); - var ZodParsedType = util.arrayToEnum([ - "string", - "nan", - "number", - "integer", - "float", - "boolean", - "date", - "bigint", - "symbol", - "function", - "undefined", - "null", - "array", - "object", - "unknown", - "promise", - "void", - "never", - "map", - "set" - ]); - var getParsedType = (data) => { - const t = typeof data; - switch (t) { - case "undefined": - return ZodParsedType.undefined; - case "string": - return ZodParsedType.string; - case "number": - return Number.isNaN(data) ? ZodParsedType.nan : ZodParsedType.number; - case "boolean": - return ZodParsedType.boolean; - case "function": - return ZodParsedType.function; - case "bigint": - return ZodParsedType.bigint; - case "symbol": - return ZodParsedType.symbol; - case "object": - if (Array.isArray(data)) { - return ZodParsedType.array; - } - if (data === null) { - return ZodParsedType.null; - } - if (data.then && typeof data.then === "function" && data.catch && typeof data.catch === "function") { - return ZodParsedType.promise; - } - if (typeof Map !== "undefined" && data instanceof Map) { - return ZodParsedType.map; - } - if (typeof Set !== "undefined" && data instanceof Set) { - return ZodParsedType.set; - } - if (typeof Date !== "undefined" && data instanceof Date) { - return ZodParsedType.date; - } - return ZodParsedType.object; - default: - return ZodParsedType.unknown; - } - }; - - // node_modules/zod/v3/ZodError.js - var ZodIssueCode = util.arrayToEnum([ - "invalid_type", - "invalid_literal", - "custom", - "invalid_union", - "invalid_union_discriminator", - "invalid_enum_value", - "unrecognized_keys", - "invalid_arguments", - "invalid_return_type", - "invalid_date", - "invalid_string", - "too_small", - "too_big", - "invalid_intersection_types", - "not_multiple_of", - "not_finite" - ]); - var ZodError = class _ZodError extends Error { - get errors() { - return this.issues; - } - constructor(issues) { - super(); - this.issues = []; - this.addIssue = (sub) => { - this.issues = [...this.issues, sub]; - }; - this.addIssues = (subs = []) => { - this.issues = [...this.issues, ...subs]; - }; - const actualProto = new.target.prototype; - if (Object.setPrototypeOf) { - Object.setPrototypeOf(this, actualProto); - } else { - this.__proto__ = actualProto; - } - this.name = "ZodError"; - this.issues = issues; - } - format(_mapper) { - const mapper = _mapper || function(issue) { - return issue.message; - }; - const fieldErrors = { _errors: [] }; - const processError = (error) => { - for (const issue of error.issues) { - if (issue.code === "invalid_union") { - issue.unionErrors.map(processError); - } else if (issue.code === "invalid_return_type") { - processError(issue.returnTypeError); - } else if (issue.code === "invalid_arguments") { - processError(issue.argumentsError); - } else if (issue.path.length === 0) { - fieldErrors._errors.push(mapper(issue)); - } else { - let curr = fieldErrors; - let i = 0; - while (i < issue.path.length) { - const el = issue.path[i]; - const terminal = i === issue.path.length - 1; - if (!terminal) { - curr[el] = curr[el] || { _errors: [] }; - } else { - curr[el] = curr[el] || { _errors: [] }; - curr[el]._errors.push(mapper(issue)); - } - curr = curr[el]; - i++; - } - } - } - }; - processError(this); - return fieldErrors; - } - static assert(value) { - if (!(value instanceof _ZodError)) { - throw new Error(`Not a ZodError: ${value}`); - } - } - toString() { - return this.message; - } - get message() { - return JSON.stringify(this.issues, util.jsonStringifyReplacer, 2); - } - get isEmpty() { - return this.issues.length === 0; - } - flatten(mapper = (issue) => issue.message) { - const fieldErrors = {}; - const formErrors = []; - for (const sub of this.issues) { - if (sub.path.length > 0) { - const firstEl = sub.path[0]; - fieldErrors[firstEl] = fieldErrors[firstEl] || []; - fieldErrors[firstEl].push(mapper(sub)); - } else { - formErrors.push(mapper(sub)); - } - } - return { formErrors, fieldErrors }; - } - get formErrors() { - return this.flatten(); - } - }; - ZodError.create = (issues) => { - const error = new ZodError(issues); - return error; - }; - - // node_modules/zod/v3/locales/en.js - var errorMap = (issue, _ctx) => { - let message; - switch (issue.code) { - case ZodIssueCode.invalid_type: - if (issue.received === ZodParsedType.undefined) { - message = "Required"; - } else { - message = `Expected ${issue.expected}, received ${issue.received}`; - } - break; - case ZodIssueCode.invalid_literal: - message = `Invalid literal value, expected ${JSON.stringify(issue.expected, util.jsonStringifyReplacer)}`; - break; - case ZodIssueCode.unrecognized_keys: - message = `Unrecognized key(s) in object: ${util.joinValues(issue.keys, ", ")}`; - break; - case ZodIssueCode.invalid_union: - message = `Invalid input`; - break; - case ZodIssueCode.invalid_union_discriminator: - message = `Invalid discriminator value. Expected ${util.joinValues(issue.options)}`; - break; - case ZodIssueCode.invalid_enum_value: - message = `Invalid enum value. Expected ${util.joinValues(issue.options)}, received '${issue.received}'`; - break; - case ZodIssueCode.invalid_arguments: - message = `Invalid function arguments`; - break; - case ZodIssueCode.invalid_return_type: - message = `Invalid function return type`; - break; - case ZodIssueCode.invalid_date: - message = `Invalid date`; - break; - case ZodIssueCode.invalid_string: - if (typeof issue.validation === "object") { - if ("includes" in issue.validation) { - message = `Invalid input: must include "${issue.validation.includes}"`; - if (typeof issue.validation.position === "number") { - message = `${message} at one or more positions greater than or equal to ${issue.validation.position}`; - } - } else if ("startsWith" in issue.validation) { - message = `Invalid input: must start with "${issue.validation.startsWith}"`; - } else if ("endsWith" in issue.validation) { - message = `Invalid input: must end with "${issue.validation.endsWith}"`; - } else { - util.assertNever(issue.validation); - } - } else if (issue.validation !== "regex") { - message = `Invalid ${issue.validation}`; - } else { - message = "Invalid"; - } - break; - case ZodIssueCode.too_small: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `more than`} ${issue.minimum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `over`} ${issue.minimum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "bigint") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${new Date(Number(issue.minimum))}`; - else - message = "Invalid input"; - break; - case ZodIssueCode.too_big: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `less than`} ${issue.maximum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `under`} ${issue.maximum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "bigint") - message = `BigInt must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly` : issue.inclusive ? `smaller than or equal to` : `smaller than`} ${new Date(Number(issue.maximum))}`; - else - message = "Invalid input"; - break; - case ZodIssueCode.custom: - message = `Invalid input`; - break; - case ZodIssueCode.invalid_intersection_types: - message = `Intersection results could not be merged`; - break; - case ZodIssueCode.not_multiple_of: - message = `Number must be a multiple of ${issue.multipleOf}`; - break; - case ZodIssueCode.not_finite: - message = "Number must be finite"; - break; - default: - message = _ctx.defaultError; - util.assertNever(issue); - } - return { message }; - }; - var en_default = errorMap; - - // node_modules/zod/v3/errors.js - var overrideErrorMap = en_default; - function getErrorMap() { - return overrideErrorMap; - } - - // node_modules/zod/v3/helpers/parseUtil.js - var makeIssue = (params) => { - const { data, path, errorMaps, issueData } = params; - const fullPath = [...path, ...issueData.path || []]; - const fullIssue = { - ...issueData, - path: fullPath - }; - if (issueData.message !== void 0) { - return { - ...issueData, - path: fullPath, - message: issueData.message - }; - } - let errorMessage = ""; - const maps = errorMaps.filter((m) => !!m).slice().reverse(); - for (const map of maps) { - errorMessage = map(fullIssue, { data, defaultError: errorMessage }).message; - } - return { - ...issueData, - path: fullPath, - message: errorMessage - }; - }; - function addIssueToContext(ctx, issueData) { - const overrideMap = getErrorMap(); - const issue = makeIssue({ - issueData, - data: ctx.data, - path: ctx.path, - errorMaps: [ - ctx.common.contextualErrorMap, - // contextual error map is first priority - ctx.schemaErrorMap, - // then schema-bound map if available - overrideMap, - // then global override map - overrideMap === en_default ? void 0 : en_default - // then global default map - ].filter((x) => !!x) - }); - ctx.common.issues.push(issue); - } - var ParseStatus = class _ParseStatus { - constructor() { - this.value = "valid"; - } - dirty() { - if (this.value === "valid") - this.value = "dirty"; - } - abort() { - if (this.value !== "aborted") - this.value = "aborted"; - } - static mergeArray(status, results) { - const arrayValue = []; - for (const s of results) { - if (s.status === "aborted") - return INVALID; - if (s.status === "dirty") - status.dirty(); - arrayValue.push(s.value); - } - return { status: status.value, value: arrayValue }; - } - static async mergeObjectAsync(status, pairs) { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value - }); - } - return _ParseStatus.mergeObjectSync(status, syncPairs); - } - static mergeObjectSync(status, pairs) { - const finalObject = {}; - for (const pair of pairs) { - const { key, value } = pair; - if (key.status === "aborted") - return INVALID; - if (value.status === "aborted") - return INVALID; - if (key.status === "dirty") - status.dirty(); - if (value.status === "dirty") - status.dirty(); - if (key.value !== "__proto__" && (typeof value.value !== "undefined" || pair.alwaysSet)) { - finalObject[key.value] = value.value; - } - } - return { status: status.value, value: finalObject }; - } - }; - var INVALID = Object.freeze({ - status: "aborted" - }); - var DIRTY = (value) => ({ status: "dirty", value }); - var OK2 = (value) => ({ status: "valid", value }); - var isAborted = (x) => x.status === "aborted"; - var isDirty = (x) => x.status === "dirty"; - var isValid = (x) => x.status === "valid"; - var isAsync = (x) => typeof Promise !== "undefined" && x instanceof Promise; - - // node_modules/zod/v3/helpers/errorUtil.js - var errorUtil; - (function(errorUtil2) { - errorUtil2.errToObj = (message) => typeof message === "string" ? { message } : message || {}; - errorUtil2.toString = (message) => typeof message === "string" ? message : message?.message; - })(errorUtil || (errorUtil = {})); - - // node_modules/zod/v3/types.js - var ParseInputLazyPath = class { - constructor(parent, value, path, key) { - this._cachedPath = []; - this.parent = parent; - this.data = value; - this._path = path; - this._key = key; - } - get path() { - if (!this._cachedPath.length) { - if (Array.isArray(this._key)) { - this._cachedPath.push(...this._path, ...this._key); - } else { - this._cachedPath.push(...this._path, this._key); - } - } - return this._cachedPath; - } - }; - var handleResult = (ctx, result) => { - if (isValid(result)) { - return { success: true, data: result.value }; - } else { - if (!ctx.common.issues.length) { - throw new Error("Validation failed but no issues detected."); - } - return { - success: false, - get error() { - if (this._error) - return this._error; - const error = new ZodError(ctx.common.issues); - this._error = error; - return this._error; - } - }; - } - }; - function processCreateParams(params) { - if (!params) - return {}; - const { errorMap: errorMap2, invalid_type_error, required_error, description } = params; - if (errorMap2 && (invalid_type_error || required_error)) { - throw new Error(`Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`); - } - if (errorMap2) - return { errorMap: errorMap2, description }; - const customMap = (iss, ctx) => { - const { message } = params; - if (iss.code === "invalid_enum_value") { - return { message: message ?? ctx.defaultError }; - } - if (typeof ctx.data === "undefined") { - return { message: message ?? required_error ?? ctx.defaultError }; - } - if (iss.code !== "invalid_type") - return { message: ctx.defaultError }; - return { message: message ?? invalid_type_error ?? ctx.defaultError }; - }; - return { errorMap: customMap, description }; - } - var ZodType = class { - get description() { - return this._def.description; - } - _getType(input) { - return getParsedType(input.data); - } - _getOrReturnCtx(input, ctx) { - return ctx || { - common: input.parent.common, - data: input.data, - parsedType: getParsedType(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - }; - } - _processInputParams(input) { - return { - status: new ParseStatus(), - ctx: { - common: input.parent.common, - data: input.data, - parsedType: getParsedType(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - } - }; - } - _parseSync(input) { - const result = this._parse(input); - if (isAsync(result)) { - throw new Error("Synchronous parse encountered promise."); - } - return result; - } - _parseAsync(input) { - const result = this._parse(input); - return Promise.resolve(result); - } - parse(data, params) { - const result = this.safeParse(data, params); - if (result.success) - return result.data; - throw result.error; - } - safeParse(data, params) { - const ctx = { - common: { - issues: [], - async: params?.async ?? false, - contextualErrorMap: params?.errorMap - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: getParsedType(data) - }; - const result = this._parseSync({ data, path: ctx.path, parent: ctx }); - return handleResult(ctx, result); - } - "~validate"(data) { - const ctx = { - common: { - issues: [], - async: !!this["~standard"].async - }, - path: [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: getParsedType(data) - }; - if (!this["~standard"].async) { - try { - const result = this._parseSync({ data, path: [], parent: ctx }); - return isValid(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }; - } catch (err) { - if (err?.message?.toLowerCase()?.includes("encountered")) { - this["~standard"].async = true; - } - ctx.common = { - issues: [], - async: true - }; - } - } - return this._parseAsync({ data, path: [], parent: ctx }).then((result) => isValid(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }); - } - async parseAsync(data, params) { - const result = await this.safeParseAsync(data, params); - if (result.success) - return result.data; - throw result.error; - } - async safeParseAsync(data, params) { - const ctx = { - common: { - issues: [], - contextualErrorMap: params?.errorMap, - async: true - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: getParsedType(data) - }; - const maybeAsyncResult = this._parse({ data, path: ctx.path, parent: ctx }); - const result = await (isAsync(maybeAsyncResult) ? maybeAsyncResult : Promise.resolve(maybeAsyncResult)); - return handleResult(ctx, result); - } - refine(check, message) { - const getIssueProperties = (val) => { - if (typeof message === "string" || typeof message === "undefined") { - return { message }; - } else if (typeof message === "function") { - return message(val); - } else { - return message; - } - }; - return this._refinement((val, ctx) => { - const result = check(val); - const setError = () => ctx.addIssue({ - code: ZodIssueCode.custom, - ...getIssueProperties(val) - }); - if (typeof Promise !== "undefined" && result instanceof Promise) { - return result.then((data) => { - if (!data) { - setError(); - return false; - } else { - return true; - } - }); - } - if (!result) { - setError(); - return false; - } else { - return true; - } - }); - } - refinement(check, refinementData) { - return this._refinement((val, ctx) => { - if (!check(val)) { - ctx.addIssue(typeof refinementData === "function" ? refinementData(val, ctx) : refinementData); - return false; - } else { - return true; - } - }); - } - _refinement(refinement) { - return new ZodEffects({ - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "refinement", refinement } - }); - } - superRefine(refinement) { - return this._refinement(refinement); - } - constructor(def) { - this.spa = this.safeParseAsync; - this._def = def; - this.parse = this.parse.bind(this); - this.safeParse = this.safeParse.bind(this); - this.parseAsync = this.parseAsync.bind(this); - this.safeParseAsync = this.safeParseAsync.bind(this); - this.spa = this.spa.bind(this); - this.refine = this.refine.bind(this); - this.refinement = this.refinement.bind(this); - this.superRefine = this.superRefine.bind(this); - this.optional = this.optional.bind(this); - this.nullable = this.nullable.bind(this); - this.nullish = this.nullish.bind(this); - this.array = this.array.bind(this); - this.promise = this.promise.bind(this); - this.or = this.or.bind(this); - this.and = this.and.bind(this); - this.transform = this.transform.bind(this); - this.brand = this.brand.bind(this); - this.default = this.default.bind(this); - this.catch = this.catch.bind(this); - this.describe = this.describe.bind(this); - this.pipe = this.pipe.bind(this); - this.readonly = this.readonly.bind(this); - this.isNullable = this.isNullable.bind(this); - this.isOptional = this.isOptional.bind(this); - this["~standard"] = { - version: 1, - vendor: "zod", - validate: (data) => this["~validate"](data) - }; - } - optional() { - return ZodOptional.create(this, this._def); - } - nullable() { - return ZodNullable.create(this, this._def); - } - nullish() { - return this.nullable().optional(); - } - array() { - return ZodArray.create(this); - } - promise() { - return ZodPromise.create(this, this._def); - } - or(option) { - return ZodUnion.create([this, option], this._def); - } - and(incoming) { - return ZodIntersection.create(this, incoming, this._def); - } - transform(transform) { - return new ZodEffects({ - ...processCreateParams(this._def), - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "transform", transform } - }); - } - default(def) { - const defaultValueFunc = typeof def === "function" ? def : () => def; - return new ZodDefault({ - ...processCreateParams(this._def), - innerType: this, - defaultValue: defaultValueFunc, - typeName: ZodFirstPartyTypeKind.ZodDefault - }); - } - brand() { - return new ZodBranded({ - typeName: ZodFirstPartyTypeKind.ZodBranded, - type: this, - ...processCreateParams(this._def) - }); - } - catch(def) { - const catchValueFunc = typeof def === "function" ? def : () => def; - return new ZodCatch({ - ...processCreateParams(this._def), - innerType: this, - catchValue: catchValueFunc, - typeName: ZodFirstPartyTypeKind.ZodCatch - }); - } - describe(description) { - const This = this.constructor; - return new This({ - ...this._def, - description - }); - } - pipe(target) { - return ZodPipeline.create(this, target); - } - readonly() { - return ZodReadonly.create(this); - } - isOptional() { - return this.safeParse(void 0).success; - } - isNullable() { - return this.safeParse(null).success; - } - }; - var cuidRegex = /^c[^\s-]{8,}$/i; - var cuid2Regex = /^[0-9a-z]+$/; - var ulidRegex = /^[0-9A-HJKMNP-TV-Z]{26}$/i; - var uuidRegex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i; - var nanoidRegex = /^[a-z0-9_-]{21}$/i; - var jwtRegex = /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/; - var durationRegex = /^[-+]?P(?!$)(?:(?:[-+]?\d+Y)|(?:[-+]?\d+[.,]\d+Y$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:(?:[-+]?\d+W)|(?:[-+]?\d+[.,]\d+W$))?(?:(?:[-+]?\d+D)|(?:[-+]?\d+[.,]\d+D$))?(?:T(?=[\d+-])(?:(?:[-+]?\d+H)|(?:[-+]?\d+[.,]\d+H$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:[-+]?\d+(?:[.,]\d+)?S)?)??$/; - var emailRegex = /^(?!\.)(?!.*\.\.)([A-Z0-9_'+\-\.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9\-]*\.)+[A-Z]{2,}$/i; - var _emojiRegex = `^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$`; - var emojiRegex; - var ipv4Regex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/; - var ipv4CidrRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/; - var ipv6Regex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/; - var ipv6CidrRegex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/; - var base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/; - var base64urlRegex = /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/; - var dateRegexSource = `((\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\\d|3[01])|(0[469]|11)-(0[1-9]|[12]\\d|30)|(02)-(0[1-9]|1\\d|2[0-8])))`; - var dateRegex = new RegExp(`^${dateRegexSource}$`); - function timeRegexSource(args) { - let secondsRegexSource = `[0-5]\\d`; - if (args.precision) { - secondsRegexSource = `${secondsRegexSource}\\.\\d{${args.precision}}`; - } else if (args.precision == null) { - secondsRegexSource = `${secondsRegexSource}(\\.\\d+)?`; - } - const secondsQuantifier = args.precision ? "+" : "?"; - return `([01]\\d|2[0-3]):[0-5]\\d(:${secondsRegexSource})${secondsQuantifier}`; - } - function timeRegex(args) { - return new RegExp(`^${timeRegexSource(args)}$`); - } - function datetimeRegex(args) { - let regex = `${dateRegexSource}T${timeRegexSource(args)}`; - const opts = []; - opts.push(args.local ? `Z?` : `Z`); - if (args.offset) - opts.push(`([+-]\\d{2}:?\\d{2})`); - regex = `${regex}(${opts.join("|")})`; - return new RegExp(`^${regex}$`); - } - function isValidIP(ip, version) { - if ((version === "v4" || !version) && ipv4Regex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6Regex.test(ip)) { - return true; - } - return false; - } - function isValidJWT(jwt, alg) { - if (!jwtRegex.test(jwt)) - return false; - try { - const [header] = jwt.split("."); - if (!header) - return false; - const base64 = header.replace(/-/g, "+").replace(/_/g, "/").padEnd(header.length + (4 - header.length % 4) % 4, "="); - const decoded = JSON.parse(atob(base64)); - if (typeof decoded !== "object" || decoded === null) - return false; - if ("typ" in decoded && decoded?.typ !== "JWT") - return false; - if (!decoded.alg) - return false; - if (alg && decoded.alg !== alg) - return false; - return true; - } catch { - return false; - } - } - function isValidCidr(ip, version) { - if ((version === "v4" || !version) && ipv4CidrRegex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6CidrRegex.test(ip)) { - return true; - } - return false; - } - var ZodString = class _ZodString extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = String(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.string) { - const ctx2 = this._getOrReturnCtx(input); - addIssueToContext(ctx2, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.string, - received: ctx2.parsedType - }); - return INVALID; - } - const status = new ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.length < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.length > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "length") { - const tooBig = input.data.length > check.value; - const tooSmall = input.data.length < check.value; - if (tooBig || tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - if (tooBig) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } else if (tooSmall) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } - status.dirty(); - } - } else if (check.kind === "email") { - if (!emailRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "email", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "emoji") { - if (!emojiRegex) { - emojiRegex = new RegExp(_emojiRegex, "u"); - } - if (!emojiRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "emoji", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "uuid") { - if (!uuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "uuid", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "nanoid") { - if (!nanoidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "nanoid", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid") { - if (!cuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "cuid", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid2") { - if (!cuid2Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "cuid2", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ulid") { - if (!ulidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "ulid", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "url") { - try { - new URL(input.data); - } catch { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "url", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "regex") { - check.regex.lastIndex = 0; - const testResult = check.regex.test(input.data); - if (!testResult) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "regex", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "trim") { - input.data = input.data.trim(); - } else if (check.kind === "includes") { - if (!input.data.includes(check.value, check.position)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: { includes: check.value, position: check.position }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "toLowerCase") { - input.data = input.data.toLowerCase(); - } else if (check.kind === "toUpperCase") { - input.data = input.data.toUpperCase(); - } else if (check.kind === "startsWith") { - if (!input.data.startsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: { startsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "endsWith") { - if (!input.data.endsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: { endsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "datetime") { - const regex = datetimeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: "datetime", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "date") { - const regex = dateRegex; - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: "date", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "time") { - const regex = timeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_string, - validation: "time", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "duration") { - if (!durationRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "duration", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ip") { - if (!isValidIP(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "ip", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "jwt") { - if (!isValidJWT(input.data, check.alg)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "jwt", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cidr") { - if (!isValidCidr(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "cidr", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64") { - if (!base64Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "base64", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64url") { - if (!base64urlRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - validation: "base64url", - code: ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else { - util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _regex(regex, validation, message) { - return this.refinement((data) => regex.test(data), { - validation, - code: ZodIssueCode.invalid_string, - ...errorUtil.errToObj(message) - }); - } - _addCheck(check) { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - email(message) { - return this._addCheck({ kind: "email", ...errorUtil.errToObj(message) }); - } - url(message) { - return this._addCheck({ kind: "url", ...errorUtil.errToObj(message) }); - } - emoji(message) { - return this._addCheck({ kind: "emoji", ...errorUtil.errToObj(message) }); - } - uuid(message) { - return this._addCheck({ kind: "uuid", ...errorUtil.errToObj(message) }); - } - nanoid(message) { - return this._addCheck({ kind: "nanoid", ...errorUtil.errToObj(message) }); - } - cuid(message) { - return this._addCheck({ kind: "cuid", ...errorUtil.errToObj(message) }); - } - cuid2(message) { - return this._addCheck({ kind: "cuid2", ...errorUtil.errToObj(message) }); - } - ulid(message) { - return this._addCheck({ kind: "ulid", ...errorUtil.errToObj(message) }); - } - base64(message) { - return this._addCheck({ kind: "base64", ...errorUtil.errToObj(message) }); - } - base64url(message) { - return this._addCheck({ - kind: "base64url", - ...errorUtil.errToObj(message) - }); - } - jwt(options) { - return this._addCheck({ kind: "jwt", ...errorUtil.errToObj(options) }); - } - ip(options) { - return this._addCheck({ kind: "ip", ...errorUtil.errToObj(options) }); - } - cidr(options) { - return this._addCheck({ kind: "cidr", ...errorUtil.errToObj(options) }); - } - datetime(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "datetime", - precision: null, - offset: false, - local: false, - message: options - }); - } - return this._addCheck({ - kind: "datetime", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - offset: options?.offset ?? false, - local: options?.local ?? false, - ...errorUtil.errToObj(options?.message) - }); - } - date(message) { - return this._addCheck({ kind: "date", message }); - } - time(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "time", - precision: null, - message: options - }); - } - return this._addCheck({ - kind: "time", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - ...errorUtil.errToObj(options?.message) - }); - } - duration(message) { - return this._addCheck({ kind: "duration", ...errorUtil.errToObj(message) }); - } - regex(regex, message) { - return this._addCheck({ - kind: "regex", - regex, - ...errorUtil.errToObj(message) - }); - } - includes(value, options) { - return this._addCheck({ - kind: "includes", - value, - position: options?.position, - ...errorUtil.errToObj(options?.message) - }); - } - startsWith(value, message) { - return this._addCheck({ - kind: "startsWith", - value, - ...errorUtil.errToObj(message) - }); - } - endsWith(value, message) { - return this._addCheck({ - kind: "endsWith", - value, - ...errorUtil.errToObj(message) - }); - } - min(minLength, message) { - return this._addCheck({ - kind: "min", - value: minLength, - ...errorUtil.errToObj(message) - }); - } - max(maxLength, message) { - return this._addCheck({ - kind: "max", - value: maxLength, - ...errorUtil.errToObj(message) - }); - } - length(len, message) { - return this._addCheck({ - kind: "length", - value: len, - ...errorUtil.errToObj(message) - }); - } - /** - * Equivalent to `.min(1)` - */ - nonempty(message) { - return this.min(1, errorUtil.errToObj(message)); - } - trim() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "trim" }] - }); - } - toLowerCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toLowerCase" }] - }); - } - toUpperCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toUpperCase" }] - }); - } - get isDatetime() { - return !!this._def.checks.find((ch) => ch.kind === "datetime"); - } - get isDate() { - return !!this._def.checks.find((ch) => ch.kind === "date"); - } - get isTime() { - return !!this._def.checks.find((ch) => ch.kind === "time"); - } - get isDuration() { - return !!this._def.checks.find((ch) => ch.kind === "duration"); - } - get isEmail() { - return !!this._def.checks.find((ch) => ch.kind === "email"); - } - get isURL() { - return !!this._def.checks.find((ch) => ch.kind === "url"); - } - get isEmoji() { - return !!this._def.checks.find((ch) => ch.kind === "emoji"); - } - get isUUID() { - return !!this._def.checks.find((ch) => ch.kind === "uuid"); - } - get isNANOID() { - return !!this._def.checks.find((ch) => ch.kind === "nanoid"); - } - get isCUID() { - return !!this._def.checks.find((ch) => ch.kind === "cuid"); - } - get isCUID2() { - return !!this._def.checks.find((ch) => ch.kind === "cuid2"); - } - get isULID() { - return !!this._def.checks.find((ch) => ch.kind === "ulid"); - } - get isIP() { - return !!this._def.checks.find((ch) => ch.kind === "ip"); - } - get isCIDR() { - return !!this._def.checks.find((ch) => ch.kind === "cidr"); - } - get isBase64() { - return !!this._def.checks.find((ch) => ch.kind === "base64"); - } - get isBase64url() { - return !!this._def.checks.find((ch) => ch.kind === "base64url"); - } - get minLength() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxLength() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - ZodString.create = (params) => { - return new ZodString({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodString, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - function floatSafeRemainder(val, step) { - const valDecCount = (val.toString().split(".")[1] || "").length; - const stepDecCount = (step.toString().split(".")[1] || "").length; - const decCount = valDecCount > stepDecCount ? valDecCount : stepDecCount; - const valInt = Number.parseInt(val.toFixed(decCount).replace(".", "")); - const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", "")); - return valInt % stepInt / 10 ** decCount; - } - var ZodNumber = class _ZodNumber extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - this.step = this.multipleOf; - } - _parse(input) { - if (this._def.coerce) { - input.data = Number(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.number) { - const ctx2 = this._getOrReturnCtx(input); - addIssueToContext(ctx2, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.number, - received: ctx2.parsedType - }); - return INVALID; - } - let ctx = void 0; - const status = new ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "int") { - if (!util.isInteger(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: "integer", - received: "float", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (floatSafeRemainder(input.data, check.value) !== 0) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "finite") { - if (!Number.isFinite(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.not_finite, - message: check.message - }); - status.dirty(); - } - } else { - util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodNumber({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodNumber({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - int(message) { - return this._addCheck({ - kind: "int", - message: errorUtil.toString(message) - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: false, - message: errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: false, - message: errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: true, - message: errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: true, - message: errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil.toString(message) - }); - } - finite(message) { - return this._addCheck({ - kind: "finite", - message: errorUtil.toString(message) - }); - } - safe(message) { - return this._addCheck({ - kind: "min", - inclusive: true, - value: Number.MIN_SAFE_INTEGER, - message: errorUtil.toString(message) - })._addCheck({ - kind: "max", - inclusive: true, - value: Number.MAX_SAFE_INTEGER, - message: errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - get isInt() { - return !!this._def.checks.find((ch) => ch.kind === "int" || ch.kind === "multipleOf" && util.isInteger(ch.value)); - } - get isFinite() { - let max = null; - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "finite" || ch.kind === "int" || ch.kind === "multipleOf") { - return true; - } else if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } else if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return Number.isFinite(min) && Number.isFinite(max); - } - }; - ZodNumber.create = (params) => { - return new ZodNumber({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodNumber, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodBigInt = class _ZodBigInt extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - } - _parse(input) { - if (this._def.coerce) { - try { - input.data = BigInt(input.data); - } catch { - return this._getInvalidInput(input); - } - } - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.bigint) { - return this._getInvalidInput(input); - } - let ctx = void 0; - const status = new ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - type: "bigint", - minimum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - type: "bigint", - maximum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (input.data % check.value !== BigInt(0)) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else { - util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _getInvalidInput(input) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.bigint, - received: ctx.parsedType - }); - return INVALID; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodBigInt({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodBigInt({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: false, - message: errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: false, - message: errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: true, - message: errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: true, - message: errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - ZodBigInt.create = (params) => { - return new ZodBigInt({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodBigInt, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - var ZodBoolean = class extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = Boolean(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.boolean) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.boolean, - received: ctx.parsedType - }); - return INVALID; - } - return OK2(input.data); - } - }; - ZodBoolean.create = (params) => { - return new ZodBoolean({ - typeName: ZodFirstPartyTypeKind.ZodBoolean, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodDate = class _ZodDate extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = new Date(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.date) { - const ctx2 = this._getOrReturnCtx(input); - addIssueToContext(ctx2, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.date, - received: ctx2.parsedType - }); - return INVALID; - } - if (Number.isNaN(input.data.getTime())) { - const ctx2 = this._getOrReturnCtx(input); - addIssueToContext(ctx2, { - code: ZodIssueCode.invalid_date - }); - return INVALID; - } - const status = new ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.getTime() < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - message: check.message, - inclusive: true, - exact: false, - minimum: check.value, - type: "date" - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.getTime() > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - message: check.message, - inclusive: true, - exact: false, - maximum: check.value, - type: "date" - }); - status.dirty(); - } - } else { - util.assertNever(check); - } - } - return { - status: status.value, - value: new Date(input.data.getTime()) - }; - } - _addCheck(check) { - return new _ZodDate({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - min(minDate, message) { - return this._addCheck({ - kind: "min", - value: minDate.getTime(), - message: errorUtil.toString(message) - }); - } - max(maxDate, message) { - return this._addCheck({ - kind: "max", - value: maxDate.getTime(), - message: errorUtil.toString(message) - }); - } - get minDate() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min != null ? new Date(min) : null; - } - get maxDate() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max != null ? new Date(max) : null; - } - }; - ZodDate.create = (params) => { - return new ZodDate({ - checks: [], - coerce: params?.coerce || false, - typeName: ZodFirstPartyTypeKind.ZodDate, - ...processCreateParams(params) - }); - }; - var ZodSymbol = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.symbol) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.symbol, - received: ctx.parsedType - }); - return INVALID; - } - return OK2(input.data); - } - }; - ZodSymbol.create = (params) => { - return new ZodSymbol({ - typeName: ZodFirstPartyTypeKind.ZodSymbol, - ...processCreateParams(params) - }); - }; - var ZodUndefined = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.undefined, - received: ctx.parsedType - }); - return INVALID; - } - return OK2(input.data); - } - }; - ZodUndefined.create = (params) => { - return new ZodUndefined({ - typeName: ZodFirstPartyTypeKind.ZodUndefined, - ...processCreateParams(params) - }); - }; - var ZodNull = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.null) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.null, - received: ctx.parsedType - }); - return INVALID; - } - return OK2(input.data); - } - }; - ZodNull.create = (params) => { - return new ZodNull({ - typeName: ZodFirstPartyTypeKind.ZodNull, - ...processCreateParams(params) - }); - }; - var ZodAny = class extends ZodType { - constructor() { - super(...arguments); - this._any = true; - } - _parse(input) { - return OK2(input.data); - } - }; - ZodAny.create = (params) => { - return new ZodAny({ - typeName: ZodFirstPartyTypeKind.ZodAny, - ...processCreateParams(params) - }); - }; - var ZodUnknown = class extends ZodType { - constructor() { - super(...arguments); - this._unknown = true; - } - _parse(input) { - return OK2(input.data); - } - }; - ZodUnknown.create = (params) => { - return new ZodUnknown({ - typeName: ZodFirstPartyTypeKind.ZodUnknown, - ...processCreateParams(params) - }); - }; - var ZodNever = class extends ZodType { - _parse(input) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.never, - received: ctx.parsedType - }); - return INVALID; - } - }; - ZodNever.create = (params) => { - return new ZodNever({ - typeName: ZodFirstPartyTypeKind.ZodNever, - ...processCreateParams(params) - }); - }; - var ZodVoid = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.void, - received: ctx.parsedType - }); - return INVALID; - } - return OK2(input.data); - } - }; - ZodVoid.create = (params) => { - return new ZodVoid({ - typeName: ZodFirstPartyTypeKind.ZodVoid, - ...processCreateParams(params) - }); - }; - var ZodArray = class _ZodArray extends ZodType { - _parse(input) { - const { ctx, status } = this._processInputParams(input); - const def = this._def; - if (ctx.parsedType !== ZodParsedType.array) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.array, - received: ctx.parsedType - }); - return INVALID; - } - if (def.exactLength !== null) { - const tooBig = ctx.data.length > def.exactLength.value; - const tooSmall = ctx.data.length < def.exactLength.value; - if (tooBig || tooSmall) { - addIssueToContext(ctx, { - code: tooBig ? ZodIssueCode.too_big : ZodIssueCode.too_small, - minimum: tooSmall ? def.exactLength.value : void 0, - maximum: tooBig ? def.exactLength.value : void 0, - type: "array", - inclusive: true, - exact: true, - message: def.exactLength.message - }); - status.dirty(); - } - } - if (def.minLength !== null) { - if (ctx.data.length < def.minLength.value) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: def.minLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.minLength.message - }); - status.dirty(); - } - } - if (def.maxLength !== null) { - if (ctx.data.length > def.maxLength.value) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: def.maxLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.maxLength.message - }); - status.dirty(); - } - } - if (ctx.common.async) { - return Promise.all([...ctx.data].map((item, i) => { - return def.type._parseAsync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - })).then((result2) => { - return ParseStatus.mergeArray(status, result2); - }); - } - const result = [...ctx.data].map((item, i) => { - return def.type._parseSync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - }); - return ParseStatus.mergeArray(status, result); - } - get element() { - return this._def.type; - } - min(minLength, message) { - return new _ZodArray({ - ...this._def, - minLength: { value: minLength, message: errorUtil.toString(message) } - }); - } - max(maxLength, message) { - return new _ZodArray({ - ...this._def, - maxLength: { value: maxLength, message: errorUtil.toString(message) } - }); - } - length(len, message) { - return new _ZodArray({ - ...this._def, - exactLength: { value: len, message: errorUtil.toString(message) } - }); - } - nonempty(message) { - return this.min(1, message); - } - }; - ZodArray.create = (schema, params) => { - return new ZodArray({ - type: schema, - minLength: null, - maxLength: null, - exactLength: null, - typeName: ZodFirstPartyTypeKind.ZodArray, - ...processCreateParams(params) - }); - }; - function deepPartialify(schema) { - if (schema instanceof ZodObject) { - const newShape = {}; - for (const key in schema.shape) { - const fieldSchema = schema.shape[key]; - newShape[key] = ZodOptional.create(deepPartialify(fieldSchema)); - } - return new ZodObject({ - ...schema._def, - shape: () => newShape - }); - } else if (schema instanceof ZodArray) { - return new ZodArray({ - ...schema._def, - type: deepPartialify(schema.element) - }); - } else if (schema instanceof ZodOptional) { - return ZodOptional.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodNullable) { - return ZodNullable.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodTuple) { - return ZodTuple.create(schema.items.map((item) => deepPartialify(item))); - } else { - return schema; - } - } - var ZodObject = class _ZodObject extends ZodType { - constructor() { - super(...arguments); - this._cached = null; - this.nonstrict = this.passthrough; - this.augment = this.extend; - } - _getCached() { - if (this._cached !== null) - return this._cached; - const shape = this._def.shape(); - const keys = util.objectKeys(shape); - this._cached = { shape, keys }; - return this._cached; - } - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.object) { - const ctx2 = this._getOrReturnCtx(input); - addIssueToContext(ctx2, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.object, - received: ctx2.parsedType - }); - return INVALID; - } - const { status, ctx } = this._processInputParams(input); - const { shape, keys: shapeKeys } = this._getCached(); - const extraKeys = []; - if (!(this._def.catchall instanceof ZodNever && this._def.unknownKeys === "strip")) { - for (const key in ctx.data) { - if (!shapeKeys.includes(key)) { - extraKeys.push(key); - } - } - } - const pairs = []; - for (const key of shapeKeys) { - const keyValidator = shape[key]; - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: keyValidator._parse(new ParseInputLazyPath(ctx, value, ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (this._def.catchall instanceof ZodNever) { - const unknownKeys = this._def.unknownKeys; - if (unknownKeys === "passthrough") { - for (const key of extraKeys) { - pairs.push({ - key: { status: "valid", value: key }, - value: { status: "valid", value: ctx.data[key] } - }); - } - } else if (unknownKeys === "strict") { - if (extraKeys.length > 0) { - addIssueToContext(ctx, { - code: ZodIssueCode.unrecognized_keys, - keys: extraKeys - }); - status.dirty(); - } - } else if (unknownKeys === "strip") { - } else { - throw new Error(`Internal ZodObject error: invalid unknownKeys value.`); - } - } else { - const catchall = this._def.catchall; - for (const key of extraKeys) { - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: catchall._parse( - new ParseInputLazyPath(ctx, value, ctx.path, key) - //, ctx.child(key), value, getParsedType(value) - ), - alwaysSet: key in ctx.data - }); - } - } - if (ctx.common.async) { - return Promise.resolve().then(async () => { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value, - alwaysSet: pair.alwaysSet - }); - } - return syncPairs; - }).then((syncPairs) => { - return ParseStatus.mergeObjectSync(status, syncPairs); - }); - } else { - return ParseStatus.mergeObjectSync(status, pairs); - } - } - get shape() { - return this._def.shape(); - } - strict(message) { - errorUtil.errToObj; - return new _ZodObject({ - ...this._def, - unknownKeys: "strict", - ...message !== void 0 ? { - errorMap: (issue, ctx) => { - const defaultError = this._def.errorMap?.(issue, ctx).message ?? ctx.defaultError; - if (issue.code === "unrecognized_keys") - return { - message: errorUtil.errToObj(message).message ?? defaultError - }; - return { - message: defaultError - }; - } - } : {} - }); - } - strip() { - return new _ZodObject({ - ...this._def, - unknownKeys: "strip" - }); - } - passthrough() { - return new _ZodObject({ - ...this._def, - unknownKeys: "passthrough" - }); - } - // const AugmentFactory = - // (def: Def) => - // ( - // augmentation: Augmentation - // ): ZodObject< - // extendShape, Augmentation>, - // Def["unknownKeys"], - // Def["catchall"] - // > => { - // return new ZodObject({ - // ...def, - // shape: () => ({ - // ...def.shape(), - // ...augmentation, - // }), - // }) as any; - // }; - extend(augmentation) { - return new _ZodObject({ - ...this._def, - shape: () => ({ - ...this._def.shape(), - ...augmentation - }) - }); - } - /** - * Prior to zod@1.0.12 there was a bug in the - * inferred type of merged objects. Please - * upgrade if you are experiencing issues. - */ - merge(merging) { - const merged = new _ZodObject({ - unknownKeys: merging._def.unknownKeys, - catchall: merging._def.catchall, - shape: () => ({ - ...this._def.shape(), - ...merging._def.shape() - }), - typeName: ZodFirstPartyTypeKind.ZodObject - }); - return merged; - } - // merge< - // Incoming extends AnyZodObject, - // Augmentation extends Incoming["shape"], - // NewOutput extends { - // [k in keyof Augmentation | keyof Output]: k extends keyof Augmentation - // ? Augmentation[k]["_output"] - // : k extends keyof Output - // ? Output[k] - // : never; - // }, - // NewInput extends { - // [k in keyof Augmentation | keyof Input]: k extends keyof Augmentation - // ? Augmentation[k]["_input"] - // : k extends keyof Input - // ? Input[k] - // : never; - // } - // >( - // merging: Incoming - // ): ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"], - // NewOutput, - // NewInput - // > { - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - setKey(key, schema) { - return this.augment({ [key]: schema }); - } - // merge( - // merging: Incoming - // ): //ZodObject = (merging) => { - // ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"] - // > { - // // const mergedShape = objectUtil.mergeShapes( - // // this._def.shape(), - // // merging._def.shape() - // // ); - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - catchall(index) { - return new _ZodObject({ - ...this._def, - catchall: index - }); - } - pick(mask) { - const shape = {}; - for (const key of util.objectKeys(mask)) { - if (mask[key] && this.shape[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - omit(mask) { - const shape = {}; - for (const key of util.objectKeys(this.shape)) { - if (!mask[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - /** - * @deprecated - */ - deepPartial() { - return deepPartialify(this); - } - partial(mask) { - const newShape = {}; - for (const key of util.objectKeys(this.shape)) { - const fieldSchema = this.shape[key]; - if (mask && !mask[key]) { - newShape[key] = fieldSchema; - } else { - newShape[key] = fieldSchema.optional(); - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - required(mask) { - const newShape = {}; - for (const key of util.objectKeys(this.shape)) { - if (mask && !mask[key]) { - newShape[key] = this.shape[key]; - } else { - const fieldSchema = this.shape[key]; - let newField = fieldSchema; - while (newField instanceof ZodOptional) { - newField = newField._def.innerType; - } - newShape[key] = newField; - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - keyof() { - return createZodEnum(util.objectKeys(this.shape)); - } - }; - ZodObject.create = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.strictCreate = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strict", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.lazycreate = (shape, params) => { - return new ZodObject({ - shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - var ZodUnion = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const options = this._def.options; - function handleResults(results) { - for (const result of results) { - if (result.result.status === "valid") { - return result.result; - } - } - for (const result of results) { - if (result.result.status === "dirty") { - ctx.common.issues.push(...result.ctx.common.issues); - return result.result; - } - } - const unionErrors = results.map((result) => new ZodError(result.ctx.common.issues)); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_union, - unionErrors - }); - return INVALID; - } - if (ctx.common.async) { - return Promise.all(options.map(async (option) => { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - return { - result: await option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }), - ctx: childCtx - }; - })).then(handleResults); - } else { - let dirty = void 0; - const issues = []; - for (const option of options) { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - const result = option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }); - if (result.status === "valid") { - return result; - } else if (result.status === "dirty" && !dirty) { - dirty = { result, ctx: childCtx }; - } - if (childCtx.common.issues.length) { - issues.push(childCtx.common.issues); - } - } - if (dirty) { - ctx.common.issues.push(...dirty.ctx.common.issues); - return dirty.result; - } - const unionErrors = issues.map((issues2) => new ZodError(issues2)); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_union, - unionErrors - }); - return INVALID; - } - } - get options() { - return this._def.options; - } - }; - ZodUnion.create = (types, params) => { - return new ZodUnion({ - options: types, - typeName: ZodFirstPartyTypeKind.ZodUnion, - ...processCreateParams(params) - }); - }; - var getDiscriminator = (type) => { - if (type instanceof ZodLazy) { - return getDiscriminator(type.schema); - } else if (type instanceof ZodEffects) { - return getDiscriminator(type.innerType()); - } else if (type instanceof ZodLiteral) { - return [type.value]; - } else if (type instanceof ZodEnum) { - return type.options; - } else if (type instanceof ZodNativeEnum) { - return util.objectValues(type.enum); - } else if (type instanceof ZodDefault) { - return getDiscriminator(type._def.innerType); - } else if (type instanceof ZodUndefined) { - return [void 0]; - } else if (type instanceof ZodNull) { - return [null]; - } else if (type instanceof ZodOptional) { - return [void 0, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodNullable) { - return [null, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodBranded) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodReadonly) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodCatch) { - return getDiscriminator(type._def.innerType); - } else { - return []; - } - }; - var ZodDiscriminatedUnion = class _ZodDiscriminatedUnion extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.object) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.object, - received: ctx.parsedType - }); - return INVALID; - } - const discriminator = this.discriminator; - const discriminatorValue = ctx.data[discriminator]; - const option = this.optionsMap.get(discriminatorValue); - if (!option) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_union_discriminator, - options: Array.from(this.optionsMap.keys()), - path: [discriminator] - }); - return INVALID; - } - if (ctx.common.async) { - return option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } else { - return option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } - } - get discriminator() { - return this._def.discriminator; - } - get options() { - return this._def.options; - } - get optionsMap() { - return this._def.optionsMap; - } - /** - * The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. - * However, it only allows a union of objects, all of which need to share a discriminator property. This property must - * have a different value for each object in the union. - * @param discriminator the name of the discriminator property - * @param types an array of object schemas - * @param params - */ - static create(discriminator, options, params) { - const optionsMap = /* @__PURE__ */ new Map(); - for (const type of options) { - const discriminatorValues = getDiscriminator(type.shape[discriminator]); - if (!discriminatorValues.length) { - throw new Error(`A discriminator value for key \`${discriminator}\` could not be extracted from all schema options`); - } - for (const value of discriminatorValues) { - if (optionsMap.has(value)) { - throw new Error(`Discriminator property ${String(discriminator)} has duplicate value ${String(value)}`); - } - optionsMap.set(value, type); - } - } - return new _ZodDiscriminatedUnion({ - typeName: ZodFirstPartyTypeKind.ZodDiscriminatedUnion, - discriminator, - options, - optionsMap, - ...processCreateParams(params) - }); - } - }; - function mergeValues(a, b) { - const aType = getParsedType(a); - const bType = getParsedType(b); - if (a === b) { - return { valid: true, data: a }; - } else if (aType === ZodParsedType.object && bType === ZodParsedType.object) { - const bKeys = util.objectKeys(b); - const sharedKeys = util.objectKeys(a).filter((key) => bKeys.indexOf(key) !== -1); - const newObj = { ...a, ...b }; - for (const key of sharedKeys) { - const sharedValue = mergeValues(a[key], b[key]); - if (!sharedValue.valid) { - return { valid: false }; - } - newObj[key] = sharedValue.data; - } - return { valid: true, data: newObj }; - } else if (aType === ZodParsedType.array && bType === ZodParsedType.array) { - if (a.length !== b.length) { - return { valid: false }; - } - const newArray = []; - for (let index = 0; index < a.length; index++) { - const itemA = a[index]; - const itemB = b[index]; - const sharedValue = mergeValues(itemA, itemB); - if (!sharedValue.valid) { - return { valid: false }; - } - newArray.push(sharedValue.data); - } - return { valid: true, data: newArray }; - } else if (aType === ZodParsedType.date && bType === ZodParsedType.date && +a === +b) { - return { valid: true, data: a }; - } else { - return { valid: false }; - } - } - var ZodIntersection = class extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const handleParsed = (parsedLeft, parsedRight) => { - if (isAborted(parsedLeft) || isAborted(parsedRight)) { - return INVALID; - } - const merged = mergeValues(parsedLeft.value, parsedRight.value); - if (!merged.valid) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_intersection_types - }); - return INVALID; - } - if (isDirty(parsedLeft) || isDirty(parsedRight)) { - status.dirty(); - } - return { status: status.value, value: merged.data }; - }; - if (ctx.common.async) { - return Promise.all([ - this._def.left._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), - this._def.right._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }) - ]).then(([left, right]) => handleParsed(left, right)); - } else { - return handleParsed(this._def.left._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), this._def.right._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - })); - } - } - }; - ZodIntersection.create = (left, right, params) => { - return new ZodIntersection({ - left, - right, - typeName: ZodFirstPartyTypeKind.ZodIntersection, - ...processCreateParams(params) - }); - }; - var ZodTuple = class _ZodTuple extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.array) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.array, - received: ctx.parsedType - }); - return INVALID; - } - if (ctx.data.length < this._def.items.length) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - return INVALID; - } - const rest = this._def.rest; - if (!rest && ctx.data.length > this._def.items.length) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - status.dirty(); - } - const items = [...ctx.data].map((item, itemIndex) => { - const schema = this._def.items[itemIndex] || this._def.rest; - if (!schema) - return null; - return schema._parse(new ParseInputLazyPath(ctx, item, ctx.path, itemIndex)); - }).filter((x) => !!x); - if (ctx.common.async) { - return Promise.all(items).then((results) => { - return ParseStatus.mergeArray(status, results); - }); - } else { - return ParseStatus.mergeArray(status, items); - } - } - get items() { - return this._def.items; - } - rest(rest) { - return new _ZodTuple({ - ...this._def, - rest - }); - } - }; - ZodTuple.create = (schemas, params) => { - if (!Array.isArray(schemas)) { - throw new Error("You must pass an array of schemas to z.tuple([ ... ])"); - } - return new ZodTuple({ - items: schemas, - typeName: ZodFirstPartyTypeKind.ZodTuple, - rest: null, - ...processCreateParams(params) - }); - }; - var ZodRecord = class _ZodRecord extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.object) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.object, - received: ctx.parsedType - }); - return INVALID; - } - const pairs = []; - const keyType = this._def.keyType; - const valueType = this._def.valueType; - for (const key in ctx.data) { - pairs.push({ - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, key)), - value: valueType._parse(new ParseInputLazyPath(ctx, ctx.data[key], ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (ctx.common.async) { - return ParseStatus.mergeObjectAsync(status, pairs); - } else { - return ParseStatus.mergeObjectSync(status, pairs); - } - } - get element() { - return this._def.valueType; - } - static create(first, second, third) { - if (second instanceof ZodType) { - return new _ZodRecord({ - keyType: first, - valueType: second, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(third) - }); - } - return new _ZodRecord({ - keyType: ZodString.create(), - valueType: first, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(second) - }); - } - }; - var ZodMap = class extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.map) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.map, - received: ctx.parsedType - }); - return INVALID; - } - const keyType = this._def.keyType; - const valueType = this._def.valueType; - const pairs = [...ctx.data.entries()].map(([key, value], index) => { - return { - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, [index, "key"])), - value: valueType._parse(new ParseInputLazyPath(ctx, value, ctx.path, [index, "value"])) - }; - }); - if (ctx.common.async) { - const finalMap = /* @__PURE__ */ new Map(); - return Promise.resolve().then(async () => { - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - }); - } else { - const finalMap = /* @__PURE__ */ new Map(); - for (const pair of pairs) { - const key = pair.key; - const value = pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - } - } - }; - ZodMap.create = (keyType, valueType, params) => { - return new ZodMap({ - valueType, - keyType, - typeName: ZodFirstPartyTypeKind.ZodMap, - ...processCreateParams(params) - }); - }; - var ZodSet = class _ZodSet extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.set) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.set, - received: ctx.parsedType - }); - return INVALID; - } - const def = this._def; - if (def.minSize !== null) { - if (ctx.data.size < def.minSize.value) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_small, - minimum: def.minSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.minSize.message - }); - status.dirty(); - } - } - if (def.maxSize !== null) { - if (ctx.data.size > def.maxSize.value) { - addIssueToContext(ctx, { - code: ZodIssueCode.too_big, - maximum: def.maxSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.maxSize.message - }); - status.dirty(); - } - } - const valueType = this._def.valueType; - function finalizeSet(elements2) { - const parsedSet = /* @__PURE__ */ new Set(); - for (const element of elements2) { - if (element.status === "aborted") - return INVALID; - if (element.status === "dirty") - status.dirty(); - parsedSet.add(element.value); - } - return { status: status.value, value: parsedSet }; - } - const elements = [...ctx.data.values()].map((item, i) => valueType._parse(new ParseInputLazyPath(ctx, item, ctx.path, i))); - if (ctx.common.async) { - return Promise.all(elements).then((elements2) => finalizeSet(elements2)); - } else { - return finalizeSet(elements); - } - } - min(minSize, message) { - return new _ZodSet({ - ...this._def, - minSize: { value: minSize, message: errorUtil.toString(message) } - }); - } - max(maxSize, message) { - return new _ZodSet({ - ...this._def, - maxSize: { value: maxSize, message: errorUtil.toString(message) } - }); - } - size(size, message) { - return this.min(size, message).max(size, message); - } - nonempty(message) { - return this.min(1, message); - } - }; - ZodSet.create = (valueType, params) => { - return new ZodSet({ - valueType, - minSize: null, - maxSize: null, - typeName: ZodFirstPartyTypeKind.ZodSet, - ...processCreateParams(params) - }); - }; - var ZodFunction = class _ZodFunction extends ZodType { - constructor() { - super(...arguments); - this.validate = this.implement; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.function) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.function, - received: ctx.parsedType - }); - return INVALID; - } - function makeArgsIssue(args, error) { - return makeIssue({ - data: args, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, getErrorMap(), en_default].filter((x) => !!x), - issueData: { - code: ZodIssueCode.invalid_arguments, - argumentsError: error - } - }); - } - function makeReturnsIssue(returns, error) { - return makeIssue({ - data: returns, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, getErrorMap(), en_default].filter((x) => !!x), - issueData: { - code: ZodIssueCode.invalid_return_type, - returnTypeError: error - } - }); - } - const params = { errorMap: ctx.common.contextualErrorMap }; - const fn = ctx.data; - if (this._def.returns instanceof ZodPromise) { - const me = this; - return OK2(async function(...args) { - const error = new ZodError([]); - const parsedArgs = await me._def.args.parseAsync(args, params).catch((e) => { - error.addIssue(makeArgsIssue(args, e)); - throw error; - }); - const result = await Reflect.apply(fn, this, parsedArgs); - const parsedReturns = await me._def.returns._def.type.parseAsync(result, params).catch((e) => { - error.addIssue(makeReturnsIssue(result, e)); - throw error; - }); - return parsedReturns; - }); - } else { - const me = this; - return OK2(function(...args) { - const parsedArgs = me._def.args.safeParse(args, params); - if (!parsedArgs.success) { - throw new ZodError([makeArgsIssue(args, parsedArgs.error)]); - } - const result = Reflect.apply(fn, this, parsedArgs.data); - const parsedReturns = me._def.returns.safeParse(result, params); - if (!parsedReturns.success) { - throw new ZodError([makeReturnsIssue(result, parsedReturns.error)]); - } - return parsedReturns.data; - }); - } - } - parameters() { - return this._def.args; - } - returnType() { - return this._def.returns; - } - args(...items) { - return new _ZodFunction({ - ...this._def, - args: ZodTuple.create(items).rest(ZodUnknown.create()) - }); - } - returns(returnType) { - return new _ZodFunction({ - ...this._def, - returns: returnType - }); - } - implement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - strictImplement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - static create(args, returns, params) { - return new _ZodFunction({ - args: args ? args : ZodTuple.create([]).rest(ZodUnknown.create()), - returns: returns || ZodUnknown.create(), - typeName: ZodFirstPartyTypeKind.ZodFunction, - ...processCreateParams(params) - }); - } - }; - var ZodLazy = class extends ZodType { - get schema() { - return this._def.getter(); - } - _parse(input) { - const { ctx } = this._processInputParams(input); - const lazySchema = this._def.getter(); - return lazySchema._parse({ data: ctx.data, path: ctx.path, parent: ctx }); - } - }; - ZodLazy.create = (getter, params) => { - return new ZodLazy({ - getter, - typeName: ZodFirstPartyTypeKind.ZodLazy, - ...processCreateParams(params) - }); - }; - var ZodLiteral = class extends ZodType { - _parse(input) { - if (input.data !== this._def.value) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - received: ctx.data, - code: ZodIssueCode.invalid_literal, - expected: this._def.value - }); - return INVALID; - } - return { status: "valid", value: input.data }; - } - get value() { - return this._def.value; - } - }; - ZodLiteral.create = (value, params) => { - return new ZodLiteral({ - value, - typeName: ZodFirstPartyTypeKind.ZodLiteral, - ...processCreateParams(params) - }); - }; - function createZodEnum(values, params) { - return new ZodEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodEnum, - ...processCreateParams(params) - }); - } - var ZodEnum = class _ZodEnum extends ZodType { - _parse(input) { - if (typeof input.data !== "string") { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - addIssueToContext(ctx, { - expected: util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodIssueCode.invalid_type - }); - return INVALID; - } - if (!this._cache) { - this._cache = new Set(this._def.values); - } - if (!this._cache.has(input.data)) { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - addIssueToContext(ctx, { - received: ctx.data, - code: ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return INVALID; - } - return OK2(input.data); - } - get options() { - return this._def.values; - } - get enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Values() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - extract(values, newDef = this._def) { - return _ZodEnum.create(values, { - ...this._def, - ...newDef - }); - } - exclude(values, newDef = this._def) { - return _ZodEnum.create(this.options.filter((opt) => !values.includes(opt)), { - ...this._def, - ...newDef - }); - } - }; - ZodEnum.create = createZodEnum; - var ZodNativeEnum = class extends ZodType { - _parse(input) { - const nativeEnumValues = util.getValidEnumValues(this._def.values); - const ctx = this._getOrReturnCtx(input); - if (ctx.parsedType !== ZodParsedType.string && ctx.parsedType !== ZodParsedType.number) { - const expectedValues = util.objectValues(nativeEnumValues); - addIssueToContext(ctx, { - expected: util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodIssueCode.invalid_type - }); - return INVALID; - } - if (!this._cache) { - this._cache = new Set(util.getValidEnumValues(this._def.values)); - } - if (!this._cache.has(input.data)) { - const expectedValues = util.objectValues(nativeEnumValues); - addIssueToContext(ctx, { - received: ctx.data, - code: ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return INVALID; - } - return OK2(input.data); - } - get enum() { - return this._def.values; - } - }; - ZodNativeEnum.create = (values, params) => { - return new ZodNativeEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodNativeEnum, - ...processCreateParams(params) - }); - }; - var ZodPromise = class extends ZodType { - unwrap() { - return this._def.type; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== ZodParsedType.promise && ctx.common.async === false) { - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.promise, - received: ctx.parsedType - }); - return INVALID; - } - const promisified = ctx.parsedType === ZodParsedType.promise ? ctx.data : Promise.resolve(ctx.data); - return OK2(promisified.then((data) => { - return this._def.type.parseAsync(data, { - path: ctx.path, - errorMap: ctx.common.contextualErrorMap - }); - })); - } - }; - ZodPromise.create = (schema, params) => { - return new ZodPromise({ - type: schema, - typeName: ZodFirstPartyTypeKind.ZodPromise, - ...processCreateParams(params) - }); - }; - var ZodEffects = class extends ZodType { - innerType() { - return this._def.schema; - } - sourceType() { - return this._def.schema._def.typeName === ZodFirstPartyTypeKind.ZodEffects ? this._def.schema.sourceType() : this._def.schema; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const effect = this._def.effect || null; - const checkCtx = { - addIssue: (arg) => { - addIssueToContext(ctx, arg); - if (arg.fatal) { - status.abort(); - } else { - status.dirty(); - } - }, - get path() { - return ctx.path; - } - }; - checkCtx.addIssue = checkCtx.addIssue.bind(checkCtx); - if (effect.type === "preprocess") { - const processed = effect.transform(ctx.data, checkCtx); - if (ctx.common.async) { - return Promise.resolve(processed).then(async (processed2) => { - if (status.value === "aborted") - return INVALID; - const result = await this._def.schema._parseAsync({ - data: processed2, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return INVALID; - if (result.status === "dirty") - return DIRTY(result.value); - if (status.value === "dirty") - return DIRTY(result.value); - return result; - }); - } else { - if (status.value === "aborted") - return INVALID; - const result = this._def.schema._parseSync({ - data: processed, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return INVALID; - if (result.status === "dirty") - return DIRTY(result.value); - if (status.value === "dirty") - return DIRTY(result.value); - return result; - } - } - if (effect.type === "refinement") { - const executeRefinement = (acc) => { - const result = effect.refinement(acc, checkCtx); - if (ctx.common.async) { - return Promise.resolve(result); - } - if (result instanceof Promise) { - throw new Error("Async refinement encountered during synchronous parse operation. Use .parseAsync instead."); - } - return acc; - }; - if (ctx.common.async === false) { - const inner = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inner.status === "aborted") - return INVALID; - if (inner.status === "dirty") - status.dirty(); - executeRefinement(inner.value); - return { status: status.value, value: inner.value }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((inner) => { - if (inner.status === "aborted") - return INVALID; - if (inner.status === "dirty") - status.dirty(); - return executeRefinement(inner.value).then(() => { - return { status: status.value, value: inner.value }; - }); - }); - } - } - if (effect.type === "transform") { - if (ctx.common.async === false) { - const base = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (!isValid(base)) - return INVALID; - const result = effect.transform(base.value, checkCtx); - if (result instanceof Promise) { - throw new Error(`Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead.`); - } - return { status: status.value, value: result }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((base) => { - if (!isValid(base)) - return INVALID; - return Promise.resolve(effect.transform(base.value, checkCtx)).then((result) => ({ - status: status.value, - value: result - })); - }); - } - } - util.assertNever(effect); - } - }; - ZodEffects.create = (schema, effect, params) => { - return new ZodEffects({ - schema, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect, - ...processCreateParams(params) - }); - }; - ZodEffects.createWithPreprocess = (preprocess, schema, params) => { - return new ZodEffects({ - schema, - effect: { type: "preprocess", transform: preprocess }, - typeName: ZodFirstPartyTypeKind.ZodEffects, - ...processCreateParams(params) - }); - }; - var ZodOptional = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === ZodParsedType.undefined) { - return OK2(void 0); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - ZodOptional.create = (type, params) => { - return new ZodOptional({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodOptional, - ...processCreateParams(params) - }); - }; - var ZodNullable = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === ZodParsedType.null) { - return OK2(null); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - ZodNullable.create = (type, params) => { - return new ZodNullable({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodNullable, - ...processCreateParams(params) - }); - }; - var ZodDefault = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - let data = ctx.data; - if (ctx.parsedType === ZodParsedType.undefined) { - data = this._def.defaultValue(); - } - return this._def.innerType._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - removeDefault() { - return this._def.innerType; - } - }; - ZodDefault.create = (type, params) => { - return new ZodDefault({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodDefault, - defaultValue: typeof params.default === "function" ? params.default : () => params.default, - ...processCreateParams(params) - }); - }; - var ZodCatch = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const newCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - } - }; - const result = this._def.innerType._parse({ - data: newCtx.data, - path: newCtx.path, - parent: { - ...newCtx - } - }); - if (isAsync(result)) { - return result.then((result2) => { - return { - status: "valid", - value: result2.status === "valid" ? result2.value : this._def.catchValue({ - get error() { - return new ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - }); - } else { - return { - status: "valid", - value: result.status === "valid" ? result.value : this._def.catchValue({ - get error() { - return new ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - } - } - removeCatch() { - return this._def.innerType; - } - }; - ZodCatch.create = (type, params) => { - return new ZodCatch({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodCatch, - catchValue: typeof params.catch === "function" ? params.catch : () => params.catch, - ...processCreateParams(params) - }); - }; - var ZodNaN = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== ZodParsedType.nan) { - const ctx = this._getOrReturnCtx(input); - addIssueToContext(ctx, { - code: ZodIssueCode.invalid_type, - expected: ZodParsedType.nan, - received: ctx.parsedType - }); - return INVALID; - } - return { status: "valid", value: input.data }; - } - }; - ZodNaN.create = (params) => { - return new ZodNaN({ - typeName: ZodFirstPartyTypeKind.ZodNaN, - ...processCreateParams(params) - }); - }; - var BRAND = Symbol("zod_brand"); - var ZodBranded = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const data = ctx.data; - return this._def.type._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - unwrap() { - return this._def.type; - } - }; - var ZodPipeline = class _ZodPipeline extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.common.async) { - const handleAsync = async () => { - const inResult = await this._def.in._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return DIRTY(inResult.value); - } else { - return this._def.out._parseAsync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - }; - return handleAsync(); - } else { - const inResult = this._def.in._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return { - status: "dirty", - value: inResult.value - }; - } else { - return this._def.out._parseSync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - } - } - static create(a, b) { - return new _ZodPipeline({ - in: a, - out: b, - typeName: ZodFirstPartyTypeKind.ZodPipeline - }); - } - }; - var ZodReadonly = class extends ZodType { - _parse(input) { - const result = this._def.innerType._parse(input); - const freeze = (data) => { - if (isValid(data)) { - data.value = Object.freeze(data.value); - } - return data; - }; - return isAsync(result) ? result.then((data) => freeze(data)) : freeze(result); - } - unwrap() { - return this._def.innerType; - } - }; - ZodReadonly.create = (type, params) => { - return new ZodReadonly({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodReadonly, - ...processCreateParams(params) - }); - }; - function cleanParams(params, data) { - const p = typeof params === "function" ? params(data) : typeof params === "string" ? { message: params } : params; - const p2 = typeof p === "string" ? { message: p } : p; - return p2; - } - function custom(check, _params = {}, fatal) { - if (check) - return ZodAny.create().superRefine((data, ctx) => { - const r = check(data); - if (r instanceof Promise) { - return r.then((r2) => { - if (!r2) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - }); - } - if (!r) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - return; - }); - return ZodAny.create(); - } - var late = { - object: ZodObject.lazycreate - }; - var ZodFirstPartyTypeKind; - (function(ZodFirstPartyTypeKind2) { - ZodFirstPartyTypeKind2["ZodString"] = "ZodString"; - ZodFirstPartyTypeKind2["ZodNumber"] = "ZodNumber"; - ZodFirstPartyTypeKind2["ZodNaN"] = "ZodNaN"; - ZodFirstPartyTypeKind2["ZodBigInt"] = "ZodBigInt"; - ZodFirstPartyTypeKind2["ZodBoolean"] = "ZodBoolean"; - ZodFirstPartyTypeKind2["ZodDate"] = "ZodDate"; - ZodFirstPartyTypeKind2["ZodSymbol"] = "ZodSymbol"; - ZodFirstPartyTypeKind2["ZodUndefined"] = "ZodUndefined"; - ZodFirstPartyTypeKind2["ZodNull"] = "ZodNull"; - ZodFirstPartyTypeKind2["ZodAny"] = "ZodAny"; - ZodFirstPartyTypeKind2["ZodUnknown"] = "ZodUnknown"; - ZodFirstPartyTypeKind2["ZodNever"] = "ZodNever"; - ZodFirstPartyTypeKind2["ZodVoid"] = "ZodVoid"; - ZodFirstPartyTypeKind2["ZodArray"] = "ZodArray"; - ZodFirstPartyTypeKind2["ZodObject"] = "ZodObject"; - ZodFirstPartyTypeKind2["ZodUnion"] = "ZodUnion"; - ZodFirstPartyTypeKind2["ZodDiscriminatedUnion"] = "ZodDiscriminatedUnion"; - ZodFirstPartyTypeKind2["ZodIntersection"] = "ZodIntersection"; - ZodFirstPartyTypeKind2["ZodTuple"] = "ZodTuple"; - ZodFirstPartyTypeKind2["ZodRecord"] = "ZodRecord"; - ZodFirstPartyTypeKind2["ZodMap"] = "ZodMap"; - ZodFirstPartyTypeKind2["ZodSet"] = "ZodSet"; - ZodFirstPartyTypeKind2["ZodFunction"] = "ZodFunction"; - ZodFirstPartyTypeKind2["ZodLazy"] = "ZodLazy"; - ZodFirstPartyTypeKind2["ZodLiteral"] = "ZodLiteral"; - ZodFirstPartyTypeKind2["ZodEnum"] = "ZodEnum"; - ZodFirstPartyTypeKind2["ZodEffects"] = "ZodEffects"; - ZodFirstPartyTypeKind2["ZodNativeEnum"] = "ZodNativeEnum"; - ZodFirstPartyTypeKind2["ZodOptional"] = "ZodOptional"; - ZodFirstPartyTypeKind2["ZodNullable"] = "ZodNullable"; - ZodFirstPartyTypeKind2["ZodDefault"] = "ZodDefault"; - ZodFirstPartyTypeKind2["ZodCatch"] = "ZodCatch"; - ZodFirstPartyTypeKind2["ZodPromise"] = "ZodPromise"; - ZodFirstPartyTypeKind2["ZodBranded"] = "ZodBranded"; - ZodFirstPartyTypeKind2["ZodPipeline"] = "ZodPipeline"; - ZodFirstPartyTypeKind2["ZodReadonly"] = "ZodReadonly"; - })(ZodFirstPartyTypeKind || (ZodFirstPartyTypeKind = {})); - var instanceOfType = (cls, params = { - message: `Input not instance of ${cls.name}` - }) => custom((data) => data instanceof cls, params); - var stringType = ZodString.create; - var numberType = ZodNumber.create; - var nanType = ZodNaN.create; - var bigIntType = ZodBigInt.create; - var booleanType = ZodBoolean.create; - var dateType = ZodDate.create; - var symbolType = ZodSymbol.create; - var undefinedType = ZodUndefined.create; - var nullType = ZodNull.create; - var anyType = ZodAny.create; - var unknownType = ZodUnknown.create; - var neverType = ZodNever.create; - var voidType = ZodVoid.create; - var arrayType = ZodArray.create; - var objectType = ZodObject.create; - var strictObjectType = ZodObject.strictCreate; - var unionType = ZodUnion.create; - var discriminatedUnionType = ZodDiscriminatedUnion.create; - var intersectionType = ZodIntersection.create; - var tupleType = ZodTuple.create; - var recordType = ZodRecord.create; - var mapType = ZodMap.create; - var setType = ZodSet.create; - var functionType = ZodFunction.create; - var lazyType = ZodLazy.create; - var literalType = ZodLiteral.create; - var enumType = ZodEnum.create; - var nativeEnumType = ZodNativeEnum.create; - var promiseType = ZodPromise.create; - var effectsType = ZodEffects.create; - var optionalType = ZodOptional.create; - var nullableType = ZodNullable.create; - var preprocessType = ZodEffects.createWithPreprocess; - var pipelineType = ZodPipeline.create; - var coerce = { - string: ((arg) => ZodString.create({ ...arg, coerce: true })), - number: ((arg) => ZodNumber.create({ ...arg, coerce: true })), - boolean: ((arg) => ZodBoolean.create({ - ...arg, - coerce: true - })), - bigint: ((arg) => ZodBigInt.create({ ...arg, coerce: true })), - date: ((arg) => ZodDate.create({ ...arg, coerce: true })) - }; - - // node_modules/@gleanwork/api-client/dist/esm/lib/base64.js - function bytesToBase64(u8arr) { - return btoa(String.fromCodePoint(...u8arr)); - } - function bytesFromBase64(encoded) { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); - } - function stringToBytes(str) { - return new TextEncoder().encode(str); - } - function stringToBase64(str) { - return bytesToBase64(stringToBytes(str)); - } - var zodOutbound = instanceOfType(Uint8Array).or(stringType().transform(stringToBytes)); - var zodInbound = instanceOfType(Uint8Array).or(stringType().transform(bytesFromBase64)); - - // node_modules/@gleanwork/api-client/dist/esm/lib/is-plain-object.js - function isPlainObject(value) { - if (typeof value !== "object" || value === null) { - return false; - } - const prototype = Object.getPrototypeOf(value); - return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value); - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/encodings.js - var EncodingError = class extends Error { - constructor(message) { - super(message); - this.name = "EncodingError"; - } - }; - function formEncoder(sep) { - return (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - const encodedSep = encodeString(sep); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if (isPlainObject(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - }; - } - var encodeForm = formEncoder(","); - var encodeSpaceDelimited = formEncoder(" "); - var encodePipeDelimited = formEncoder("|"); - function encodeDeepObject(key, value, options) { - if (value == null) { - return; - } - if (!isPlainObject(value)) { - throw new EncodingError(`Value of parameter '${key}' which uses deepObject encoding must be an object or null`); - } - return encodeDeepObjectObject(key, value, options); - } - function encodeDeepObjectObject(key, value, options) { - if (value == null) { - return; - } - let out = ""; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - if (!isPlainObject(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - const pk = `${key}[${ck}]`; - if (isPlainObject(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - out += objOut == null ? "" : `&${objOut}`; - return; - } - const pairs = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - out += encoded == null ? "" : `&${encoded}`; - }); - return out.slice(1); - } - function encodeJSON(key, value, options) { - if (typeof value === "undefined") { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; - } - var encodeSimple = (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && isPlainObject(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - out += tmp ? `,${tmp}` : ""; - }); - return out.slice(1); - }; - function explode(key, value) { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if (isPlainObject(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } - } - function serializeValue(value) { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - return `${value}`; - } - function jsonReplacer(_, value) { - if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else { - return value; - } - } - function mapDefined(inp, mapper) { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - const m = mapper(v); - if (m == null) { - return acc; - } - acc.push(m); - return acc; - }, []); - return res.length ? res : null; - } - function mapDefinedEntries(inp, mapper) { - const acc = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - const m = mapper([k, v]); - if (m == null) { - continue; - } - acc.push(m); - } - return acc.length ? acc : null; - } - function queryJoin(...args) { - return args.filter(Boolean).join("&"); - } - function queryEncoder(f) { - const bulkEncode = function(values, options) { - const opts = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent" - }; - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - return bulkEncode; - } - var encodeJSONQuery = queryEncoder(encodeJSON); - var encodeFormQuery = queryEncoder(encodeForm); - var encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited); - var encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited); - var encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - function appendForm(fd, key, value, fileName) { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/dlv.js - function dlv(obj, key, def, p, undef) { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/env.js - var envSchema = objectType({ - GLEAN_API_TOKEN: stringType().optional(), - GLEAN_DEBUG: coerce.boolean().optional() - }); - var envMemo = void 0; - function env() { - if (envMemo) { - return envMemo; - } - envMemo = envSchema.parse(dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {}); - return envMemo; - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/retries.js - var defaultBackoff = { - initialInterval: 500, - maxInterval: 6e4, - exponent: 1.5, - maxElapsedTime: 36e5 - }; - var PermanentError = class _PermanentError extends Error { - constructor(message, options) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - super(msg, options); - this.name = "PermanentError"; - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - Object.setPrototypeOf(this, _PermanentError.prototype); - } - }; - var TemporaryError = class _TemporaryError extends Error { - constructor(message, response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - Object.setPrototypeOf(this, _TemporaryError.prototype); - } - }; - async function retry(fetchFn, options) { - switch (options.config.strategy) { - case "backoff": - return retryBackoff(wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors - }), options.config.backoff ?? defaultBackoff); - default: - return await fetchFn(); - } - } - function wrapFetcher(fn, options) { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError("Response failed with retryable status code", res); - } - return res; - } catch (err) { - if (err instanceof TemporaryError) { - throw err; - } - if (options.retryConnectionErrors && (isTimeoutError(err) || isConnectionError(err))) { - throw err; - } - throw new PermanentError("Permanent error", { cause: err }); - } - }; - } - var codeRangeRE2 = new RegExp("^[0-9]xx$", "i"); - function isRetryableResponse(res, statusCodes) { - const actual = `${res.status}`; - return statusCodes.some((code) => { - if (!codeRangeRE2.test(code)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - async function retryBackoff(fn, strategy) { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - const start = Date.now(); - let x = 0; - while (true) { - try { - const res = await fn(); - return res; - } catch (err) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - throw err; - } - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - if (retryInterval <= 0) { - retryInterval = initialInterval * Math.pow(x, exponent) + Math.random() * 1e3; - } - const d = Math.min(retryInterval, maxInterval); - await delay(d); - x++; - } - } - } - function retryIntervalFromResponse(res) { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1e3; - } - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - return 0; - } - async function delay(delay2) { - return new Promise((resolve) => setTimeout(resolve, delay2)); - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/sdks.js - var __classPrivateFieldSet = function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _ClientSDK_httpClient; - var _ClientSDK_hooks; - var _ClientSDK_logger; - var gt = typeof globalThis === "undefined" ? null : globalThis; - var webWorkerLike = typeof gt === "object" && gt != null && "importScripts" in gt && typeof gt["importScripts"] === "function"; - var isBrowserLike = webWorkerLike || typeof navigator !== "undefined" && "serviceWorker" in navigator || typeof window === "object" && typeof window.document !== "undefined"; - var ClientSDK = class { - constructor(options = {}) { - _ClientSDK_httpClient.set(this, void 0); - _ClientSDK_hooks.set(this, void 0); - _ClientSDK_logger.set(this, void 0); - const opt = options; - if (typeof opt === "object" && opt != null && "hooks" in opt && opt.hooks instanceof SDKHooks) { - __classPrivateFieldSet(this, _ClientSDK_hooks, opt.hooks, "f"); - } else { - __classPrivateFieldSet(this, _ClientSDK_hooks, new SDKHooks(), "f"); - } - const url = serverURLFromOptions(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").sdkInit({ - baseURL: url, - client: options.httpClient || new HTTPClient() - }); - this._baseURL = baseURL; - __classPrivateFieldSet(this, _ClientSDK_httpClient, client, "f"); - this._options = { ...options, hooks: __classPrivateFieldGet(this, _ClientSDK_hooks, "f") }; - __classPrivateFieldSet(this, _ClientSDK_logger, this._options.debugLogger, "f"); - if (!__classPrivateFieldGet(this, _ClientSDK_logger, "f") && env().GLEAN_DEBUG) { - __classPrivateFieldSet(this, _ClientSDK_logger, console, "f"); - } - } - _createRequest(context, conf, options) { - const { method, path, query, headers: opHeaders, security } = conf; - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return ERR(new InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - let finalQuery = query || ""; - const secQuery = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = encodeForm(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - const headers = new Headers(opHeaders); - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = stringToBase64([username || "", password || ""].join(":")); - headers.set("Authorization", `Basic ${encoded}`); - } - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - const userHeaders = new Headers(options?.headers ?? options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", conf.userAgent ?? SDK_METADATA.userAgent); - } - const fetchOptions = { - ...options?.fetchOptions, - ...options - }; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - fetchOptions.signal = timeoutSignal; - } - if (conf.body instanceof ReadableStream) { - Object.assign(fetchOptions, { duplex: "half" }); - } - let input; - try { - input = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method - } - }); - } catch (err) { - return ERR(new UnexpectedClientError("Create request hook failed to execute", { - cause: err - })); - } - return OK(new Request(input.url, input.options)); - } - async _do(request, options) { - const { context, errorCodes } = options; - return retry(async () => { - const req = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeRequest(context, request.clone()); - await logRequest(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log request:", e)); - let response = await __classPrivateFieldGet(this, _ClientSDK_httpClient, "f").request(req); - try { - if (matchStatusCode(response, errorCodes)) { - const result = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterError(context, response, null); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterSuccess(context, response); - } - } finally { - await logResponse(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), response, req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log response:", e)); - } - return response; - }, { config: options.retryConfig, statusCodes: options.retryCodes }).then((r) => OK(r), (err) => { - switch (true) { - case isAbortError(err): - return ERR(new RequestAbortedError("Request aborted by client", { - cause: err - })); - case isTimeoutError(err): - return ERR(new RequestTimeoutError("Request timed out", { cause: err })); - case isConnectionError(err): - return ERR(new ConnectionError("Unable to make request", { cause: err })); - default: - return ERR(new UnexpectedClientError("Unexpected HTTP client error", { - cause: err - })); - } - }); - } - }; - _ClientSDK_httpClient = /* @__PURE__ */ new WeakMap(), _ClientSDK_hooks = /* @__PURE__ */ new WeakMap(), _ClientSDK_logger = /* @__PURE__ */ new WeakMap(); - var jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; - var jsonlLikeContentTypeRE = /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; - async function logRequest(logger, req) { - if (!logger) { - return; - } - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`> Request: ${req.method} ${req.url}`); - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - async function logResponse(logger, res, req) { - if (!logger) { - return; - } - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case (matchContentType(res, "application/json") || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().json()); - break; - case (matchContentType(res, "application/jsonl") || jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case matchContentType(res, "text/*"): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/gleanbaseerror.js - var GleanBaseError = class extends Error { - constructor(message, httpMeta) { - super(message); - this.statusCode = httpMeta.response.status; - this.body = httpMeta.body; - this.headers = httpMeta.response.headers; - this.contentType = httpMeta.response.headers.get("content-type") || ""; - this.rawResponse = httpMeta.response; - this.name = "GleanBaseError"; - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/gleanerror.js - var GleanError = class extends GleanBaseError { - constructor(message, httpMeta) { - if (message) { - message += `: `; - } - message += `Status ${httpMeta.response.status}`; - const contentType = httpMeta.response.headers.get("content-type") || `""`; - if (contentType !== "application/json") { - message += ` Content-Type ${contentType.includes(" ") ? `"${contentType}"` : contentType}`; - } - const body = httpMeta.body || `""`; - message += body.length > 100 ? "\n" : ". "; - let bodyDisplay = body; - if (body.length > 1e4) { - const truncated = body.substring(0, 1e4); - const remaining = body.length - 1e4; - bodyDisplay = `${truncated}...and ${remaining} more chars`; - } - message += `Body: ${bodyDisplay}`; - message = message.trim(); - super(message, httpMeta); - this.name = "GleanError"; - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/sdkvalidationerror.js - var SDKValidationError = class extends Error { - // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError` - static [Symbol.hasInstance](instance) { - if (!(instance instanceof Error)) - return false; - if (!("rawValue" in instance)) - return false; - if (!("rawMessage" in instance)) - return false; - if (!("pretty" in instance)) - return false; - if (typeof instance.pretty !== "function") - return false; - return true; - } - constructor(message, cause, rawValue) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof ZodError) { - return `${this.rawMessage} -${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } - }; - function formatZodError(err, level = 0) { - let pre = " ".repeat(level); - pre = level > 0 ? `\u2502${pre}` : pre; - pre += " ".repeat(level); - let message = ""; - const append = (str) => message += ` -${pre}${str}`; - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - if (len) { - append(`\u250C ${headline}:`); - } - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`\u2502 \u2022 [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`\u2502 Want: ${issue.expected}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`\u2502 Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len2 = issue.unionErrors.length; - append(`\u2502 \u2716\uFE0E Attemped to deserialize into one of ${len2} union members:`); - issue.unionErrors.forEach((err2, i) => { - append(`\u2502 \u2716\uFE0E Member ${i + 1} of ${len2}`); - append(`${formatZodError(err2, level + 1)}`); - }); - } - } - } - if (err.issues.length) { - append(`\u2514\u2500*`); - } - return message.slice(1); - } - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/responsevalidationerror.js - var ResponseValidationError = class extends GleanBaseError { - constructor(message, extra) { - super(message, extra); - this.name = "ResponseValidationError"; - this.cause = extra.cause; - this.rawValue = extra.rawValue; - this.rawMessage = extra.rawMessage; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof ZodError) { - return `${this.rawMessage} -${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/lib/matchers.js - var DEFAULT_CONTENT_TYPES = { - jsonl: "application/jsonl", - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*" - }; - function jsonErr(codes, schema, options) { - return { ...options, err: true, enc: "json", codes, schema }; - } - function json(codes, schema, options) { - return { ...options, enc: "json", codes, schema }; - } - function text(codes, schema, options) { - return { ...options, enc: "text", codes, schema }; - } - function nil(codes, schema, options) { - return { ...options, enc: "nil", codes, schema }; - } - function fail(codes) { - return { enc: "fail", codes }; - } - function match(...matchers) { - return async function matchFunc(response, request, options) { - let raw; - let matcher; - for (const match2 of matchers) { - const { codes } = match2; - const ctpattern = "ctype" in match2 ? match2.ctype : DEFAULT_CONTENT_TYPES[match2.enc]; - if (ctpattern && matchResponse(response, codes, ctpattern)) { - matcher = match2; - break; - } else if (!ctpattern && matchStatusCode(response, codes)) { - matcher = match2; - break; - } - } - if (!matcher) { - return [{ - ok: false, - error: new GleanError("Unexpected Status or Content-Type", { - response, - request, - body: await response.text().catch(() => "") - }) - }, raw]; - } - const encoding = matcher.enc; - let body = ""; - switch (encoding) { - case "json": - body = await response.text(); - raw = JSON.parse(body); - break; - case "jsonl": - raw = response.body; - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - body = await response.text(); - raw = body; - break; - case "sse": - raw = response.body; - break; - case "nil": - body = await response.text(); - raw = void 0; - break; - case "fail": - body = await response.text(); - raw = body; - break; - default: - encoding; - throw new Error(`Unsupported response type: ${encoding}`); - } - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new GleanError("API error occurred", { - request, - response, - body - }) - }, raw]; - } - const resultKey = matcher.key || options?.resultKey; - let data; - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...isPlainObject(raw) ? raw : null, - request$: request, - response$: response, - body$: body - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - [resultKey]: raw - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...isPlainObject(raw) ? raw : null - }; - } else { - data = raw; - } - if ("err" in matcher) { - const result = safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }), - raw - ]; - } - }; - } - var headerValRE = /, */; - function unpackHeaders(headers) { - const out = {}; - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - return out; - } - function safeParseResponse(rawValue, fn, errorMessage, httpMeta) { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR(new ResponseValidationError(errorMessage, { - cause: err, - rawValue, - rawMessage: errorMessage, - ...httpMeta - })); - } - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/primitives.js - function remap(inp, mappings) { - let out = {}; - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - return out; - } - function compactMap(values) { - const out = {}; - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - return out; - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/schemas.js - function safeParse(rawValue, fn, errorMessage) { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR(new SDKValidationError(errorMessage, err, rawValue)); - } - } - function collectExtraKeys(obj, extrasKey, optional) { - return obj.transform((val) => { - const extras = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - extras[key] = v; - delete val[key]; - } - if (optional && Object.keys(extras).length === 0) { - return val; - } - return { ...val, [extrasKey]: extras }; - }); - } - - // node_modules/@gleanwork/api-client/dist/esm/lib/security.js - var SecurityErrorCode; - (function(SecurityErrorCode2) { - SecurityErrorCode2["Incomplete"] = "incomplete"; - SecurityErrorCode2["UnrecognisedSecurityType"] = "unrecognized_security_type"; - })(SecurityErrorCode || (SecurityErrorCode = {})); - var SecurityError = class _SecurityError extends Error { - constructor(code, message) { - super(message); - this.code = code; - this.name = "SecurityError"; - } - static incomplete() { - return new _SecurityError(SecurityErrorCode.Incomplete, "Security requirements not met in order to perform the operation"); - } - static unrecognizedType(type) { - return new _SecurityError(SecurityErrorCode.UnrecognisedSecurityType, `Unrecognised security type: ${type}`); - } - }; - function resolveSecurity(...options) { - const state = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" } - }; - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return typeof o.value === "string" && !!o.value; - } else if (o.type === "oauth2:client_credentials") { - if (typeof o.value == "string") { - return !!o.value; - } - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o.value})`); - } - }); - }); - if (option == null) { - return null; - } - option.forEach((spec) => { - if (spec.value == null) { - return; - } - const { type } = spec; - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec; - throw SecurityError.unrecognizedType(type); - } - }); - return state; - } - function applyBasic(state, spec) { - if (spec.value == null) { - return; - } - state.basic = spec.value; - } - function applyBearer(state, spec) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - if (spec.fieldName !== void 0) { - state.headers[spec.fieldName] = value; - } - } - function resolveGlobalSecurity(security) { - return resolveSecurity([ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiToken ?? env().GLEAN_API_TOKEN - } - ]); - } - async function extractSecurity(sec) { - if (sec == null) { - return; - } - return typeof sec === "function" ? sec() : sec; - } - - // node_modules/@gleanwork/api-client/dist/esm/models/components/activityeventparams.js - var ActivityEventParams$inboundSchema = objectType({ - bodyContent: stringType().optional(), - datasourceInstance: stringType().optional(), - datasource: stringType().optional(), - instanceOnlyName: stringType().optional(), - duration: numberType().int().optional(), - query: stringType().optional(), - referrer: stringType().optional(), - title: stringType().optional(), - truncated: booleanType().optional() - }); - var ActivityEventParams$outboundSchema = objectType({ - bodyContent: stringType().optional(), - datasourceInstance: stringType().optional(), - datasource: stringType().optional(), - instanceOnlyName: stringType().optional(), - duration: numberType().int().optional(), - query: stringType().optional(), - referrer: stringType().optional(), - title: stringType().optional(), - truncated: booleanType().optional() - }); - var ActivityEventParams$; - (function(ActivityEventParams$2) { - ActivityEventParams$2.inboundSchema = ActivityEventParams$inboundSchema; - ActivityEventParams$2.outboundSchema = ActivityEventParams$outboundSchema; - })(ActivityEventParams$ || (ActivityEventParams$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/activityevent.js - var ActivityEventAction = { - View: "VIEW", - Edit: "EDIT", - Search: "SEARCH", - Comment: "COMMENT", - Crawl: "CRAWL", - HistoricalSearch: "HISTORICAL_SEARCH", - HistoricalView: "HISTORICAL_VIEW" - }; - var ActivityEventAction$inboundSchema = nativeEnumType(ActivityEventAction); - var ActivityEventAction$outboundSchema = ActivityEventAction$inboundSchema; - var ActivityEventAction$; - (function(ActivityEventAction$2) { - ActivityEventAction$2.inboundSchema = ActivityEventAction$inboundSchema; - ActivityEventAction$2.outboundSchema = ActivityEventAction$outboundSchema; - })(ActivityEventAction$ || (ActivityEventAction$ = {})); - var ActivityEvent$inboundSchema = objectType({ - id: stringType().optional(), - action: ActivityEventAction$inboundSchema, - params: ActivityEventParams$inboundSchema.optional(), - timestamp: stringType().datetime({ offset: true }).transform((v) => new Date(v)), - url: stringType() - }); - var ActivityEvent$outboundSchema = objectType({ - id: stringType().optional(), - action: ActivityEventAction$outboundSchema, - params: ActivityEventParams$outboundSchema.optional(), - timestamp: dateType().transform((v) => v.toISOString()), - url: stringType() - }); - var ActivityEvent$; - (function(ActivityEvent$2) { - ActivityEvent$2.inboundSchema = ActivityEvent$inboundSchema; - ActivityEvent$2.outboundSchema = ActivityEvent$outboundSchema; - })(ActivityEvent$ || (ActivityEvent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/activity.js - var Activity$inboundSchema = objectType({ - events: arrayType(ActivityEvent$inboundSchema) - }); - var Activity$outboundSchema = objectType({ - events: arrayType(ActivityEvent$outboundSchema) - }); - var Activity$; - (function(Activity$2) { - Activity$2.inboundSchema = Activity$inboundSchema; - Activity$2.outboundSchema = Activity$outboundSchema; - })(Activity$ || (Activity$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/addcollectionitemserror.js - var AddCollectionItemsErrorErrorType = { - ExistingItem: "EXISTING_ITEM" - }; - var AddCollectionItemsErrorErrorType$inboundSchema = nativeEnumType(AddCollectionItemsErrorErrorType); - var AddCollectionItemsErrorErrorType$outboundSchema = AddCollectionItemsErrorErrorType$inboundSchema; - var AddCollectionItemsErrorErrorType$; - (function(AddCollectionItemsErrorErrorType$2) { - AddCollectionItemsErrorErrorType$2.inboundSchema = AddCollectionItemsErrorErrorType$inboundSchema; - AddCollectionItemsErrorErrorType$2.outboundSchema = AddCollectionItemsErrorErrorType$outboundSchema; - })(AddCollectionItemsErrorErrorType$ || (AddCollectionItemsErrorErrorType$ = {})); - var AddCollectionItemsError$inboundSchema = objectType({ - errorType: AddCollectionItemsErrorErrorType$inboundSchema.optional() - }); - var AddCollectionItemsError$outboundSchema = objectType({ - errorType: AddCollectionItemsErrorErrorType$outboundSchema.optional() - }); - var AddCollectionItemsError$; - (function(AddCollectionItemsError$2) { - AddCollectionItemsError$2.inboundSchema = AddCollectionItemsError$inboundSchema; - AddCollectionItemsError$2.outboundSchema = AddCollectionItemsError$outboundSchema; - })(AddCollectionItemsError$ || (AddCollectionItemsError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionitemdescriptor.js - var CollectionItemDescriptorItemType = { - Document: "DOCUMENT", - Text: "TEXT", - Url: "URL" - }; - var CollectionItemDescriptorItemType$inboundSchema = nativeEnumType(CollectionItemDescriptorItemType); - var CollectionItemDescriptorItemType$outboundSchema = CollectionItemDescriptorItemType$inboundSchema; - var CollectionItemDescriptorItemType$; - (function(CollectionItemDescriptorItemType$2) { - CollectionItemDescriptorItemType$2.inboundSchema = CollectionItemDescriptorItemType$inboundSchema; - CollectionItemDescriptorItemType$2.outboundSchema = CollectionItemDescriptorItemType$outboundSchema; - })(CollectionItemDescriptorItemType$ || (CollectionItemDescriptorItemType$ = {})); - var CollectionItemDescriptor$inboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - url: stringType().optional(), - documentId: stringType().optional(), - newNextItemId: stringType().optional(), - itemType: CollectionItemDescriptorItemType$inboundSchema.optional() - }); - var CollectionItemDescriptor$outboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - url: stringType().optional(), - documentId: stringType().optional(), - newNextItemId: stringType().optional(), - itemType: CollectionItemDescriptorItemType$outboundSchema.optional() - }); - var CollectionItemDescriptor$; - (function(CollectionItemDescriptor$2) { - CollectionItemDescriptor$2.inboundSchema = CollectionItemDescriptor$inboundSchema; - CollectionItemDescriptor$2.outboundSchema = CollectionItemDescriptor$outboundSchema; - })(CollectionItemDescriptor$ || (CollectionItemDescriptor$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/addcollectionitemsrequest.js - var AddCollectionItemsRequest$inboundSchema = objectType({ - collectionId: numberType(), - addedCollectionItemDescriptors: arrayType(CollectionItemDescriptor$inboundSchema).optional() - }); - var AddCollectionItemsRequest$outboundSchema = objectType({ - collectionId: numberType(), - addedCollectionItemDescriptors: arrayType(CollectionItemDescriptor$outboundSchema).optional() - }); - var AddCollectionItemsRequest$; - (function(AddCollectionItemsRequest$2) { - AddCollectionItemsRequest$2.inboundSchema = AddCollectionItemsRequest$inboundSchema; - AddCollectionItemsRequest$2.outboundSchema = AddCollectionItemsRequest$outboundSchema; - })(AddCollectionItemsRequest$ || (AddCollectionItemsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/connectortype.js - var ConnectorType = { - ApiCrawl: "API_CRAWL", - BrowserCrawl: "BROWSER_CRAWL", - BrowserHistory: "BROWSER_HISTORY", - Builtin: "BUILTIN", - FederatedSearch: "FEDERATED_SEARCH", - PushApi: "PUSH_API", - WebCrawl: "WEB_CRAWL", - NativeHistory: "NATIVE_HISTORY" - }; - var ConnectorType$inboundSchema = nativeEnumType(ConnectorType); - var ConnectorType$outboundSchema = ConnectorType$inboundSchema; - var ConnectorType$; - (function(ConnectorType$2) { - ConnectorType$2.inboundSchema = ConnectorType$inboundSchema; - ConnectorType$2.outboundSchema = ConnectorType$outboundSchema; - })(ConnectorType$ || (ConnectorType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentcontent.js - var DocumentContent$inboundSchema = objectType({ - fullTextList: arrayType(stringType()).optional() - }); - var DocumentContent$outboundSchema = objectType({ - fullTextList: arrayType(stringType()).optional() - }); - var DocumentContent$; - (function(DocumentContent$2) { - DocumentContent$2.inboundSchema = DocumentContent$inboundSchema; - DocumentContent$2.outboundSchema = DocumentContent$outboundSchema; - })(DocumentContent$ || (DocumentContent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/timepoint.js - var TimePoint$inboundSchema = objectType({ - epochSeconds: numberType().int().optional(), - daysFromNow: numberType().int().optional() - }); - var TimePoint$outboundSchema = objectType({ - epochSeconds: numberType().int().optional(), - daysFromNow: numberType().int().optional() - }); - var TimePoint$; - (function(TimePoint$2) { - TimePoint$2.inboundSchema = TimePoint$inboundSchema; - TimePoint$2.outboundSchema = TimePoint$outboundSchema; - })(TimePoint$ || (TimePoint$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/period.js - var Period$inboundSchema = objectType({ - minDaysFromNow: numberType().int().optional(), - maxDaysFromNow: numberType().int().optional(), - start: TimePoint$inboundSchema.optional(), - end: TimePoint$inboundSchema.optional() - }); - var Period$outboundSchema = objectType({ - minDaysFromNow: numberType().int().optional(), - maxDaysFromNow: numberType().int().optional(), - start: TimePoint$outboundSchema.optional(), - end: TimePoint$outboundSchema.optional() - }); - var Period$; - (function(Period$2) { - Period$2.inboundSchema = Period$inboundSchema; - Period$2.outboundSchema = Period$outboundSchema; - })(Period$ || (Period$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/countinfo.js - var CountInfo$inboundSchema = objectType({ - count: numberType().int(), - period: Period$inboundSchema.optional(), - org: stringType().optional() - }); - var CountInfo$outboundSchema = objectType({ - count: numberType().int(), - period: Period$outboundSchema.optional(), - org: stringType().optional() - }); - var CountInfo$; - (function(CountInfo$2) { - CountInfo$2.inboundSchema = CountInfo$inboundSchema; - CountInfo$2.outboundSchema = CountInfo$outboundSchema; - })(CountInfo$ || (CountInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customdatavalue.js - var CustomDataValue$inboundSchema = objectType({ - displayLabel: stringType().optional(), - stringValue: stringType().optional(), - stringListValue: arrayType(stringType()).optional(), - numberValue: numberType().optional(), - booleanValue: booleanType().optional() - }); - var CustomDataValue$outboundSchema = objectType({ - displayLabel: stringType().optional(), - stringValue: stringType().optional(), - stringListValue: arrayType(stringType()).optional(), - numberValue: numberType().optional(), - booleanValue: booleanType().optional() - }); - var CustomDataValue$; - (function(CustomDataValue$2) { - CustomDataValue$2.inboundSchema = CustomDataValue$inboundSchema; - CustomDataValue$2.outboundSchema = CustomDataValue$outboundSchema; - })(CustomDataValue$ || (CustomDataValue$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/types/rfcdate.js - var dateRE = /^\d{4}-\d{2}-\d{2}$/; - var RFCDate = class _RFCDate { - /** - * Creates a new RFCDate instance using today's date. - */ - static today() { - return new _RFCDate(/* @__PURE__ */ new Date()); - } - /** - * Creates a new RFCDate instance using the provided input. - * If a string is used then in must be in the format YYYY-MM-DD. - * - * @param date A Date object or a date string in YYYY-MM-DD format - * @example - * new RFCDate("2022-01-01") - * @example - * new RFCDate(new Date()) - */ - constructor(date) { - if (typeof date === "string" && !dateRE.test(date)) { - throw new RangeError("RFCDate: date strings must be in the format YYYY-MM-DD: " + date); - } - const value = new Date(date); - if (isNaN(+value)) { - throw new RangeError("RFCDate: invalid date provided: " + date); - } - this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length); - if (!dateRE.test(this.serialized)) { - throw new TypeError(`RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`); - } - } - toJSON() { - return this.toString(); - } - toString() { - return this.serialized; - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/models/components/timeinterval.js - var TimeInterval$inboundSchema = objectType({ - start: stringType(), - end: stringType() - }); - var TimeInterval$outboundSchema = objectType({ - start: stringType(), - end: stringType() - }); - var TimeInterval$; - (function(TimeInterval$2) { - TimeInterval$2.inboundSchema = TimeInterval$inboundSchema; - TimeInterval$2.outboundSchema = TimeInterval$outboundSchema; - })(TimeInterval$ || (TimeInterval$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/anonymousevent.js - var AnonymousEventEventType = { - Default: "DEFAULT", - OutOfOffice: "OUT_OF_OFFICE" - }; - var AnonymousEventEventType$inboundSchema = nativeEnumType(AnonymousEventEventType); - var AnonymousEventEventType$outboundSchema = AnonymousEventEventType$inboundSchema; - var AnonymousEventEventType$; - (function(AnonymousEventEventType$2) { - AnonymousEventEventType$2.inboundSchema = AnonymousEventEventType$inboundSchema; - AnonymousEventEventType$2.outboundSchema = AnonymousEventEventType$outboundSchema; - })(AnonymousEventEventType$ || (AnonymousEventEventType$ = {})); - var AnonymousEvent$inboundSchema = objectType({ - time: TimeInterval$inboundSchema.optional(), - eventType: AnonymousEventEventType$inboundSchema.optional() - }); - var AnonymousEvent$outboundSchema = objectType({ - time: TimeInterval$outboundSchema.optional(), - eventType: AnonymousEventEventType$outboundSchema.optional() - }); - var AnonymousEvent$; - (function(AnonymousEvent$2) { - AnonymousEvent$2.inboundSchema = AnonymousEvent$inboundSchema; - AnonymousEvent$2.outboundSchema = AnonymousEvent$outboundSchema; - })(AnonymousEvent$ || (AnonymousEvent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/iconconfig.js - var IconType = { - Collection: "COLLECTION", - Custom: "CUSTOM", - Datasource: "DATASOURCE", - DatasourceInstance: "DATASOURCE_INSTANCE", - Favicon: "FAVICON", - FileType: "FILE_TYPE", - GeneratedBackground: "GENERATED_BACKGROUND", - Glyph: "GLYPH", - MimeType: "MIME_TYPE", - NoIcon: "NO_ICON", - Person: "PERSON", - Reactions: "REACTIONS", - Url: "URL" - }; - var IconType$inboundSchema = nativeEnumType(IconType); - var IconType$outboundSchema = IconType$inboundSchema; - var IconType$; - (function(IconType$2) { - IconType$2.inboundSchema = IconType$inboundSchema; - IconType$2.outboundSchema = IconType$outboundSchema; - })(IconType$ || (IconType$ = {})); - var IconConfig$inboundSchema = objectType({ - generatedBackgroundColorKey: stringType().optional(), - backgroundColor: stringType().optional(), - color: stringType().optional(), - key: stringType().optional(), - iconType: IconType$inboundSchema.optional(), - masked: booleanType().optional(), - name: stringType().optional(), - url: stringType().optional() - }); - var IconConfig$outboundSchema = objectType({ - generatedBackgroundColorKey: stringType().optional(), - backgroundColor: stringType().optional(), - color: stringType().optional(), - key: stringType().optional(), - iconType: IconType$outboundSchema.optional(), - masked: booleanType().optional(), - name: stringType().optional(), - url: stringType().optional() - }); - var IconConfig$; - (function(IconConfig$2) { - IconConfig$2.inboundSchema = IconConfig$inboundSchema; - IconConfig$2.outboundSchema = IconConfig$outboundSchema; - })(IconConfig$ || (IconConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/badge.js - var Badge$inboundSchema = objectType({ - key: stringType().optional(), - displayName: stringType().optional(), - iconConfig: IconConfig$inboundSchema.optional(), - pinned: booleanType().optional() - }); - var Badge$outboundSchema = objectType({ - key: stringType().optional(), - displayName: stringType().optional(), - iconConfig: IconConfig$outboundSchema.optional(), - pinned: booleanType().optional() - }); - var Badge$; - (function(Badge$2) { - Badge$2.inboundSchema = Badge$inboundSchema; - Badge$2.outboundSchema = Badge$outboundSchema; - })(Badge$ || (Badge$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customfieldvaluehyperlink.js - var CustomFieldValueHyperlink$inboundSchema = objectType({ - urlAnchor: stringType().optional(), - urlLink: stringType().optional() - }); - var CustomFieldValueHyperlink$outboundSchema = objectType({ - urlAnchor: stringType().optional(), - urlLink: stringType().optional() - }); - var CustomFieldValueHyperlink$; - (function(CustomFieldValueHyperlink$2) { - CustomFieldValueHyperlink$2.inboundSchema = CustomFieldValueHyperlink$inboundSchema; - CustomFieldValueHyperlink$2.outboundSchema = CustomFieldValueHyperlink$outboundSchema; - })(CustomFieldValueHyperlink$ || (CustomFieldValueHyperlink$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customfieldvalueperson.js - var CustomFieldValuePerson$inboundSchema = objectType({ - person: lazyType(() => Person$inboundSchema).optional() - }); - var CustomFieldValuePerson$outboundSchema = objectType({ - person: lazyType(() => Person$outboundSchema).optional() - }); - var CustomFieldValuePerson$; - (function(CustomFieldValuePerson$2) { - CustomFieldValuePerson$2.inboundSchema = CustomFieldValuePerson$inboundSchema; - CustomFieldValuePerson$2.outboundSchema = CustomFieldValuePerson$outboundSchema; - })(CustomFieldValuePerson$ || (CustomFieldValuePerson$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customfieldvaluestr.js - var CustomFieldValueStr$inboundSchema = objectType({ - strText: stringType().optional() - }); - var CustomFieldValueStr$outboundSchema = objectType({ - strText: stringType().optional() - }); - var CustomFieldValueStr$; - (function(CustomFieldValueStr$2) { - CustomFieldValueStr$2.inboundSchema = CustomFieldValueStr$inboundSchema; - CustomFieldValueStr$2.outboundSchema = CustomFieldValueStr$outboundSchema; - })(CustomFieldValueStr$ || (CustomFieldValueStr$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customfieldvalue.js - var CustomFieldValue$inboundSchema = unionType([ - CustomFieldValueStr$inboundSchema, - CustomFieldValueHyperlink$inboundSchema, - lazyType(() => CustomFieldValuePerson$inboundSchema) - ]); - var CustomFieldValue$outboundSchema = unionType([ - CustomFieldValueStr$outboundSchema, - CustomFieldValueHyperlink$outboundSchema, - lazyType(() => CustomFieldValuePerson$outboundSchema) - ]); - var CustomFieldValue$; - (function(CustomFieldValue$2) { - CustomFieldValue$2.inboundSchema = CustomFieldValue$inboundSchema; - CustomFieldValue$2.outboundSchema = CustomFieldValue$outboundSchema; - })(CustomFieldValue$ || (CustomFieldValue$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customfielddata.js - var CustomFieldData$inboundSchema = objectType({ - label: stringType(), - values: arrayType(lazyType(() => CustomFieldValue$inboundSchema)), - displayable: booleanType().default(true) - }); - var CustomFieldData$outboundSchema = objectType({ - label: stringType(), - values: arrayType(lazyType(() => CustomFieldValue$outboundSchema)), - displayable: booleanType().default(true) - }); - var CustomFieldData$; - (function(CustomFieldData$2) { - CustomFieldData$2.inboundSchema = CustomFieldData$inboundSchema; - CustomFieldData$2.outboundSchema = CustomFieldData$outboundSchema; - })(CustomFieldData$ || (CustomFieldData$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourceprofile.js - var DatasourceProfile$inboundSchema = objectType({ - datasource: stringType(), - handle: stringType(), - url: stringType().optional(), - nativeAppUrl: stringType().optional(), - isUserGenerated: booleanType().optional() - }); - var DatasourceProfile$outboundSchema = objectType({ - datasource: stringType(), - handle: stringType(), - url: stringType().optional(), - nativeAppUrl: stringType().optional(), - isUserGenerated: booleanType().optional() - }); - var DatasourceProfile$; - (function(DatasourceProfile$2) { - DatasourceProfile$2.inboundSchema = DatasourceProfile$inboundSchema; - DatasourceProfile$2.outboundSchema = DatasourceProfile$outboundSchema; - })(DatasourceProfile$ || (DatasourceProfile$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/communicationchannel.js - var CommunicationChannel = { - CommunicationChannelEmail: "COMMUNICATION_CHANNEL_EMAIL", - CommunicationChannelSlack: "COMMUNICATION_CHANNEL_SLACK" - }; - var CommunicationChannel$inboundSchema = nativeEnumType(CommunicationChannel); - var CommunicationChannel$outboundSchema = CommunicationChannel$inboundSchema; - var CommunicationChannel$; - (function(CommunicationChannel$2) { - CommunicationChannel$2.inboundSchema = CommunicationChannel$inboundSchema; - CommunicationChannel$2.outboundSchema = CommunicationChannel$outboundSchema; - })(CommunicationChannel$ || (CommunicationChannel$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/channelinviteinfo.js - var ChannelInviteInfo$inboundSchema = objectType({ - channel: CommunicationChannel$inboundSchema.optional(), - isAutoInvite: booleanType().optional(), - inviter: lazyType(() => Person$inboundSchema).optional(), - inviteTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - reminderTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var ChannelInviteInfo$outboundSchema = objectType({ - channel: CommunicationChannel$outboundSchema.optional(), - isAutoInvite: booleanType().optional(), - inviter: lazyType(() => Person$outboundSchema).optional(), - inviteTime: dateType().transform((v) => v.toISOString()).optional(), - reminderTime: dateType().transform((v) => v.toISOString()).optional() - }); - var ChannelInviteInfo$; - (function(ChannelInviteInfo$2) { - ChannelInviteInfo$2.inboundSchema = ChannelInviteInfo$inboundSchema; - ChannelInviteInfo$2.outboundSchema = ChannelInviteInfo$outboundSchema; - })(ChannelInviteInfo$ || (ChannelInviteInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/inviteinfo.js - var InviteInfo$inboundSchema = objectType({ - signUpTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - invites: arrayType(lazyType(() => ChannelInviteInfo$inboundSchema)).optional(), - inviter: lazyType(() => Person$inboundSchema).optional(), - inviteTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - reminderTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var InviteInfo$outboundSchema = objectType({ - signUpTime: dateType().transform((v) => v.toISOString()).optional(), - invites: arrayType(lazyType(() => ChannelInviteInfo$outboundSchema)).optional(), - inviter: lazyType(() => Person$outboundSchema).optional(), - inviteTime: dateType().transform((v) => v.toISOString()).optional(), - reminderTime: dateType().transform((v) => v.toISOString()).optional() - }); - var InviteInfo$; - (function(InviteInfo$2) { - InviteInfo$2.inboundSchema = InviteInfo$inboundSchema; - InviteInfo$2.outboundSchema = InviteInfo$outboundSchema; - })(InviteInfo$ || (InviteInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/scopetype.js - var ScopeType = { - Global: "GLOBAL", - Own: "OWN" - }; - var ScopeType$inboundSchema = nativeEnumType(ScopeType); - var ScopeType$outboundSchema = ScopeType$inboundSchema; - var ScopeType$; - (function(ScopeType$2) { - ScopeType$2.inboundSchema = ScopeType$inboundSchema; - ScopeType$2.outboundSchema = ScopeType$outboundSchema; - })(ScopeType$ || (ScopeType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/grantpermission.js - var GrantPermission$inboundSchema = objectType({ - scopeType: ScopeType$inboundSchema.optional() - }); - var GrantPermission$outboundSchema = objectType({ - scopeType: ScopeType$outboundSchema.optional() - }); - var GrantPermission$; - (function(GrantPermission$2) { - GrantPermission$2.inboundSchema = GrantPermission$inboundSchema; - GrantPermission$2.outboundSchema = GrantPermission$outboundSchema; - })(GrantPermission$ || (GrantPermission$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/readpermission.js - var ReadPermission$inboundSchema = objectType({ - scopeType: ScopeType$inboundSchema.optional() - }); - var ReadPermission$outboundSchema = objectType({ - scopeType: ScopeType$outboundSchema.optional() - }); - var ReadPermission$; - (function(ReadPermission$2) { - ReadPermission$2.inboundSchema = ReadPermission$inboundSchema; - ReadPermission$2.outboundSchema = ReadPermission$outboundSchema; - })(ReadPermission$ || (ReadPermission$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/writepermission.js - var WritePermission$inboundSchema = objectType({ - scopeType: ScopeType$inboundSchema.optional(), - create: booleanType().optional(), - update: booleanType().optional(), - delete: booleanType().optional() - }); - var WritePermission$outboundSchema = objectType({ - scopeType: ScopeType$outboundSchema.optional(), - create: booleanType().optional(), - update: booleanType().optional(), - delete: booleanType().optional() - }); - var WritePermission$; - (function(WritePermission$2) { - WritePermission$2.inboundSchema = WritePermission$inboundSchema; - WritePermission$2.outboundSchema = WritePermission$outboundSchema; - })(WritePermission$ || (WritePermission$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/permissions.js - var Permissions$inboundSchema = objectType({ - canAdminSearch: booleanType().optional(), - canAdminClientApiGlobalTokens: booleanType().optional(), - canDlp: booleanType().optional(), - read: recordType(arrayType(ReadPermission$inboundSchema)).optional(), - write: recordType(arrayType(WritePermission$inboundSchema)).optional(), - grant: recordType(arrayType(GrantPermission$inboundSchema)).optional(), - role: stringType().optional(), - roles: arrayType(stringType()).optional() - }); - var Permissions$outboundSchema = objectType({ - canAdminSearch: booleanType().optional(), - canAdminClientApiGlobalTokens: booleanType().optional(), - canDlp: booleanType().optional(), - read: recordType(arrayType(ReadPermission$outboundSchema)).optional(), - write: recordType(arrayType(WritePermission$outboundSchema)).optional(), - grant: recordType(arrayType(GrantPermission$outboundSchema)).optional(), - role: stringType().optional(), - roles: arrayType(stringType()).optional() - }); - var Permissions$; - (function(Permissions$2) { - Permissions$2.inboundSchema = Permissions$inboundSchema; - Permissions$2.outboundSchema = Permissions$outboundSchema; - })(Permissions$ || (Permissions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/persondistance.js - var PersonDistance$inboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - distance: numberType() - }); - var PersonDistance$outboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - distance: numberType() - }); - var PersonDistance$; - (function(PersonDistance$2) { - PersonDistance$2.inboundSchema = PersonDistance$inboundSchema; - PersonDistance$2.outboundSchema = PersonDistance$outboundSchema; - })(PersonDistance$ || (PersonDistance$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/personteam.js - var PersonTeamRelationship = { - Member: "MEMBER", - Manager: "MANAGER", - Lead: "LEAD", - PointOfContact: "POINT_OF_CONTACT", - Other: "OTHER" - }; - var PersonTeamRelationship$inboundSchema = nativeEnumType(PersonTeamRelationship); - var PersonTeamRelationship$outboundSchema = PersonTeamRelationship$inboundSchema; - var PersonTeamRelationship$; - (function(PersonTeamRelationship$2) { - PersonTeamRelationship$2.inboundSchema = PersonTeamRelationship$inboundSchema; - PersonTeamRelationship$2.outboundSchema = PersonTeamRelationship$outboundSchema; - })(PersonTeamRelationship$ || (PersonTeamRelationship$ = {})); - var PersonTeam$inboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - externalLink: stringType().optional(), - relationship: PersonTeamRelationship$inboundSchema.default("MEMBER"), - joinDate: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var PersonTeam$outboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - externalLink: stringType().optional(), - relationship: PersonTeamRelationship$outboundSchema.default("MEMBER"), - joinDate: dateType().transform((v) => v.toISOString()).optional() - }); - var PersonTeam$; - (function(PersonTeam$2) { - PersonTeam$2.inboundSchema = PersonTeam$inboundSchema; - PersonTeam$2.outboundSchema = PersonTeam$outboundSchema; - })(PersonTeam$ || (PersonTeam$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchproviderinfo.js - var SearchProviderInfo$inboundSchema = objectType({ - name: stringType().optional(), - logoUrl: stringType().optional(), - searchLinkUrlTemplate: stringType().optional() - }); - var SearchProviderInfo$outboundSchema = objectType({ - name: stringType().optional(), - logoUrl: stringType().optional(), - searchLinkUrlTemplate: stringType().optional() - }); - var SearchProviderInfo$; - (function(SearchProviderInfo$2) { - SearchProviderInfo$2.inboundSchema = SearchProviderInfo$inboundSchema; - SearchProviderInfo$2.outboundSchema = SearchProviderInfo$outboundSchema; - })(SearchProviderInfo$ || (SearchProviderInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchrequestinputdetails.js - var SearchRequestInputDetails$inboundSchema = objectType({ - hasCopyPaste: booleanType().optional() - }); - var SearchRequestInputDetails$outboundSchema = objectType({ - hasCopyPaste: booleanType().optional() - }); - var SearchRequestInputDetails$; - (function(SearchRequestInputDetails$2) { - SearchRequestInputDetails$2.inboundSchema = SearchRequestInputDetails$inboundSchema; - SearchRequestInputDetails$2.outboundSchema = SearchRequestInputDetails$outboundSchema; - })(SearchRequestInputDetails$ || (SearchRequestInputDetails$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/authtoken.js - var AuthToken$inboundSchema = objectType({ - accessToken: stringType(), - datasource: stringType(), - scope: stringType().optional(), - tokenType: stringType().optional(), - authUser: stringType().optional(), - expiration: numberType().int().optional() - }); - var AuthToken$outboundSchema = objectType({ - accessToken: stringType(), - datasource: stringType(), - scope: stringType().optional(), - tokenType: stringType().optional(), - authUser: stringType().optional(), - expiration: numberType().int().optional() - }); - var AuthToken$; - (function(AuthToken$2) { - AuthToken$2.inboundSchema = AuthToken$inboundSchema; - AuthToken$2.outboundSchema = AuthToken$outboundSchema; - })(AuthToken$ || (AuthToken$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetbucketfilter.js - var FacetBucketFilter$inboundSchema = objectType({ - facet: stringType().optional(), - prefix: stringType().optional() - }); - var FacetBucketFilter$outboundSchema = objectType({ - facet: stringType().optional(), - prefix: stringType().optional() - }); - var FacetBucketFilter$; - (function(FacetBucketFilter$2) { - FacetBucketFilter$2.inboundSchema = FacetBucketFilter$inboundSchema; - FacetBucketFilter$2.outboundSchema = FacetBucketFilter$outboundSchema; - })(FacetBucketFilter$ || (FacetBucketFilter$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetfiltervalue.js - var RelationType = { - Equals: "EQUALS", - IdEquals: "ID_EQUALS", - Lt: "LT", - Gt: "GT", - NotEquals: "NOT_EQUALS" - }; - var RelationType$inboundSchema = nativeEnumType(RelationType); - var RelationType$outboundSchema = RelationType$inboundSchema; - var RelationType$; - (function(RelationType$2) { - RelationType$2.inboundSchema = RelationType$inboundSchema; - RelationType$2.outboundSchema = RelationType$outboundSchema; - })(RelationType$ || (RelationType$ = {})); - var FacetFilterValue$inboundSchema = objectType({ - value: stringType().optional(), - relationType: RelationType$inboundSchema.optional(), - isNegated: booleanType().optional() - }); - var FacetFilterValue$outboundSchema = objectType({ - value: stringType().optional(), - relationType: RelationType$outboundSchema.optional(), - isNegated: booleanType().optional() - }); - var FacetFilterValue$; - (function(FacetFilterValue$2) { - FacetFilterValue$2.inboundSchema = FacetFilterValue$inboundSchema; - FacetFilterValue$2.outboundSchema = FacetFilterValue$outboundSchema; - })(FacetFilterValue$ || (FacetFilterValue$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetfilter.js - var FacetFilter$inboundSchema = objectType({ - fieldName: stringType().optional(), - values: arrayType(FacetFilterValue$inboundSchema).optional(), - groupName: stringType().optional() - }); - var FacetFilter$outboundSchema = objectType({ - fieldName: stringType().optional(), - values: arrayType(FacetFilterValue$outboundSchema).optional(), - groupName: stringType().optional() - }); - var FacetFilter$; - (function(FacetFilter$2) { - FacetFilter$2.inboundSchema = FacetFilter$inboundSchema; - FacetFilter$2.outboundSchema = FacetFilter$outboundSchema; - })(FacetFilter$ || (FacetFilter$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetfilterset.js - var FacetFilterSet$inboundSchema = objectType({ - filters: arrayType(FacetFilter$inboundSchema).optional() - }); - var FacetFilterSet$outboundSchema = objectType({ - filters: arrayType(FacetFilter$outboundSchema).optional() - }); - var FacetFilterSet$; - (function(FacetFilterSet$2) { - FacetFilterSet$2.inboundSchema = FacetFilterSet$inboundSchema; - FacetFilterSet$2.outboundSchema = FacetFilterSet$outboundSchema; - })(FacetFilterSet$ || (FacetFilterSet$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentspecunion.js - var DocumentSpecUgcType2 = { - Announcements: "ANNOUNCEMENTS", - Answers: "ANSWERS", - Collections: "COLLECTIONS", - Shortcuts: "SHORTCUTS", - Chats: "CHATS" - }; - var DocumentSpecUgcType1 = { - Announcements: "ANNOUNCEMENTS", - Answers: "ANSWERS", - Collections: "COLLECTIONS", - Shortcuts: "SHORTCUTS", - Chats: "CHATS" - }; - var DocumentSpecUgcType2$inboundSchema = nativeEnumType(DocumentSpecUgcType2); - var DocumentSpecUgcType2$outboundSchema = DocumentSpecUgcType2$inboundSchema; - var DocumentSpecUgcType2$; - (function(DocumentSpecUgcType2$2) { - DocumentSpecUgcType2$2.inboundSchema = DocumentSpecUgcType2$inboundSchema; - DocumentSpecUgcType2$2.outboundSchema = DocumentSpecUgcType2$outboundSchema; - })(DocumentSpecUgcType2$ || (DocumentSpecUgcType2$ = {})); - var DocumentSpec4$inboundSchema = objectType({ - ugcType: DocumentSpecUgcType2$inboundSchema, - ugcId: stringType(), - docType: stringType().optional() - }); - var DocumentSpec4$outboundSchema = objectType({ - ugcType: DocumentSpecUgcType2$outboundSchema, - ugcId: stringType(), - docType: stringType().optional() - }); - var DocumentSpec4$; - (function(DocumentSpec4$2) { - DocumentSpec4$2.inboundSchema = DocumentSpec4$inboundSchema; - DocumentSpec4$2.outboundSchema = DocumentSpec4$outboundSchema; - })(DocumentSpec4$ || (DocumentSpec4$ = {})); - var DocumentSpecUgcType1$inboundSchema = nativeEnumType(DocumentSpecUgcType1); - var DocumentSpecUgcType1$outboundSchema = DocumentSpecUgcType1$inboundSchema; - var DocumentSpecUgcType1$; - (function(DocumentSpecUgcType1$2) { - DocumentSpecUgcType1$2.inboundSchema = DocumentSpecUgcType1$inboundSchema; - DocumentSpecUgcType1$2.outboundSchema = DocumentSpecUgcType1$outboundSchema; - })(DocumentSpecUgcType1$ || (DocumentSpecUgcType1$ = {})); - var DocumentSpec3$inboundSchema = objectType({ - ugcType: DocumentSpecUgcType1$inboundSchema, - contentId: numberType().int(), - docType: stringType().optional() - }); - var DocumentSpec3$outboundSchema = objectType({ - ugcType: DocumentSpecUgcType1$outboundSchema, - contentId: numberType().int(), - docType: stringType().optional() - }); - var DocumentSpec3$; - (function(DocumentSpec3$2) { - DocumentSpec3$2.inboundSchema = DocumentSpec3$inboundSchema; - DocumentSpec3$2.outboundSchema = DocumentSpec3$outboundSchema; - })(DocumentSpec3$ || (DocumentSpec3$ = {})); - var DocumentSpec2$inboundSchema = objectType({ - id: stringType() - }); - var DocumentSpec2$outboundSchema = objectType({ - id: stringType() - }); - var DocumentSpec2$; - (function(DocumentSpec2$2) { - DocumentSpec2$2.inboundSchema = DocumentSpec2$inboundSchema; - DocumentSpec2$2.outboundSchema = DocumentSpec2$outboundSchema; - })(DocumentSpec2$ || (DocumentSpec2$ = {})); - var DocumentSpec1$inboundSchema = objectType({ - url: stringType() - }); - var DocumentSpec1$outboundSchema = objectType({ - url: stringType() - }); - var DocumentSpec1$; - (function(DocumentSpec1$2) { - DocumentSpec1$2.inboundSchema = DocumentSpec1$inboundSchema; - DocumentSpec1$2.outboundSchema = DocumentSpec1$outboundSchema; - })(DocumentSpec1$ || (DocumentSpec1$ = {})); - var DocumentSpecUnion$inboundSchema = unionType([ - lazyType(() => DocumentSpec3$inboundSchema), - lazyType(() => DocumentSpec4$inboundSchema), - lazyType(() => DocumentSpec1$inboundSchema), - lazyType(() => DocumentSpec2$inboundSchema) - ]); - var DocumentSpecUnion$outboundSchema = unionType([ - lazyType(() => DocumentSpec3$outboundSchema), - lazyType(() => DocumentSpec4$outboundSchema), - lazyType(() => DocumentSpec1$outboundSchema), - lazyType(() => DocumentSpec2$outboundSchema) - ]); - var DocumentSpecUnion$; - (function(DocumentSpecUnion$2) { - DocumentSpecUnion$2.inboundSchema = DocumentSpecUnion$inboundSchema; - DocumentSpecUnion$2.outboundSchema = DocumentSpecUnion$outboundSchema; - })(DocumentSpecUnion$ || (DocumentSpecUnion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/restrictionfilters.js - var RestrictionFilters$inboundSchema = objectType({ - containerSpecs: arrayType(DocumentSpecUnion$inboundSchema).optional() - }); - var RestrictionFilters$outboundSchema = objectType({ - containerSpecs: arrayType(DocumentSpecUnion$outboundSchema).optional() - }); - var RestrictionFilters$; - (function(RestrictionFilters$2) { - RestrictionFilters$2.inboundSchema = RestrictionFilters$inboundSchema; - RestrictionFilters$2.outboundSchema = RestrictionFilters$outboundSchema; - })(RestrictionFilters$ || (RestrictionFilters$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchrequestoptions.js - var ResponseHint = { - AllResultCounts: "ALL_RESULT_COUNTS", - FacetResults: "FACET_RESULTS", - QueryMetadata: "QUERY_METADATA", - Results: "RESULTS", - SpellcheckMetadata: "SPELLCHECK_METADATA" - }; - var ResponseHint$inboundSchema = nativeEnumType(ResponseHint); - var ResponseHint$outboundSchema = ResponseHint$inboundSchema; - var ResponseHint$; - (function(ResponseHint$2) { - ResponseHint$2.inboundSchema = ResponseHint$inboundSchema; - ResponseHint$2.outboundSchema = ResponseHint$outboundSchema; - })(ResponseHint$ || (ResponseHint$ = {})); - var SearchRequestOptions$inboundSchema = objectType({ - datasourceFilter: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - queryOverridesFacetFilters: booleanType().optional(), - facetFilters: arrayType(FacetFilter$inboundSchema).optional(), - facetFilterSets: arrayType(FacetFilterSet$inboundSchema).optional(), - facetBucketFilter: FacetBucketFilter$inboundSchema.optional(), - facetBucketSize: numberType().int(), - defaultFacets: arrayType(stringType()).optional(), - authTokens: arrayType(AuthToken$inboundSchema).optional(), - fetchAllDatasourceCounts: booleanType().optional(), - responseHints: arrayType(ResponseHint$inboundSchema).optional(), - timezoneOffset: numberType().int().optional(), - disableSpellcheck: booleanType().optional(), - disableQueryAutocorrect: booleanType().optional(), - returnLlmContentOverSnippets: booleanType().optional(), - inclusions: RestrictionFilters$inboundSchema.optional(), - exclusions: RestrictionFilters$inboundSchema.optional() - }); - var SearchRequestOptions$outboundSchema = objectType({ - datasourceFilter: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - queryOverridesFacetFilters: booleanType().optional(), - facetFilters: arrayType(FacetFilter$outboundSchema).optional(), - facetFilterSets: arrayType(FacetFilterSet$outboundSchema).optional(), - facetBucketFilter: FacetBucketFilter$outboundSchema.optional(), - facetBucketSize: numberType().int(), - defaultFacets: arrayType(stringType()).optional(), - authTokens: arrayType(AuthToken$outboundSchema).optional(), - fetchAllDatasourceCounts: booleanType().optional(), - responseHints: arrayType(ResponseHint$outboundSchema).optional(), - timezoneOffset: numberType().int().optional(), - disableSpellcheck: booleanType().optional(), - disableQueryAutocorrect: booleanType().optional(), - returnLlmContentOverSnippets: booleanType().optional(), - inclusions: RestrictionFilters$outboundSchema.optional(), - exclusions: RestrictionFilters$outboundSchema.optional() - }); - var SearchRequestOptions$; - (function(SearchRequestOptions$2) { - SearchRequestOptions$2.inboundSchema = SearchRequestOptions$inboundSchema; - SearchRequestOptions$2.outboundSchema = SearchRequestOptions$outboundSchema; - })(SearchRequestOptions$ || (SearchRequestOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/textrange.js - var TextRangeType = { - Bold: "BOLD", - Citation: "CITATION", - Highlight: "HIGHLIGHT", - Link: "LINK" - }; - var TextRangeType$inboundSchema = nativeEnumType(TextRangeType); - var TextRangeType$outboundSchema = TextRangeType$inboundSchema; - var TextRangeType$; - (function(TextRangeType$2) { - TextRangeType$2.inboundSchema = TextRangeType$inboundSchema; - TextRangeType$2.outboundSchema = TextRangeType$outboundSchema; - })(TextRangeType$ || (TextRangeType$ = {})); - var TextRange$inboundSchema = objectType({ - startIndex: numberType().int(), - endIndex: numberType().int().optional(), - type: TextRangeType$inboundSchema.optional(), - url: stringType().optional(), - document: lazyType(() => Document$inboundSchema).optional() - }); - var TextRange$outboundSchema = objectType({ - startIndex: numberType().int(), - endIndex: numberType().int().optional(), - type: TextRangeType$outboundSchema.optional(), - url: stringType().optional(), - document: lazyType(() => Document$outboundSchema).optional() - }); - var TextRange$; - (function(TextRange$2) { - TextRange$2.inboundSchema = TextRange$inboundSchema; - TextRange$2.outboundSchema = TextRange$outboundSchema; - })(TextRange$ || (TextRange$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/querysuggestion.js - var QuerySuggestion$inboundSchema = objectType({ - missingTerm: stringType().optional(), - query: stringType(), - searchProviderInfo: SearchProviderInfo$inboundSchema.optional(), - label: stringType().optional(), - datasource: stringType().optional(), - requestOptions: SearchRequestOptions$inboundSchema.optional(), - ranges: arrayType(lazyType(() => TextRange$inboundSchema)).optional(), - inputDetails: SearchRequestInputDetails$inboundSchema.optional() - }); - var QuerySuggestion$outboundSchema = objectType({ - missingTerm: stringType().optional(), - query: stringType(), - searchProviderInfo: SearchProviderInfo$outboundSchema.optional(), - label: stringType().optional(), - datasource: stringType().optional(), - requestOptions: SearchRequestOptions$outboundSchema.optional(), - ranges: arrayType(lazyType(() => TextRange$outboundSchema)).optional(), - inputDetails: SearchRequestInputDetails$outboundSchema.optional() - }); - var QuerySuggestion$; - (function(QuerySuggestion$2) { - QuerySuggestion$2.inboundSchema = QuerySuggestion$inboundSchema; - QuerySuggestion$2.outboundSchema = QuerySuggestion$outboundSchema; - })(QuerySuggestion$ || (QuerySuggestion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/querysuggestionlist.js - var QuerySuggestionList$inboundSchema = objectType({ - suggestions: arrayType(lazyType(() => QuerySuggestion$inboundSchema)).optional(), - person: lazyType(() => Person$inboundSchema).optional() - }); - var QuerySuggestionList$outboundSchema = objectType({ - suggestions: arrayType(lazyType(() => QuerySuggestion$outboundSchema)).optional(), - person: lazyType(() => Person$outboundSchema).optional() - }); - var QuerySuggestionList$; - (function(QuerySuggestionList$2) { - QuerySuggestionList$2.inboundSchema = QuerySuggestionList$inboundSchema; - QuerySuggestionList$2.outboundSchema = QuerySuggestionList$outboundSchema; - })(QuerySuggestionList$ || (QuerySuggestionList$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/socialnetwork.js - var SocialNetwork$inboundSchema = objectType({ - name: stringType(), - profileName: stringType().optional(), - profileUrl: stringType() - }); - var SocialNetwork$outboundSchema = objectType({ - name: stringType(), - profileName: stringType().optional(), - profileUrl: stringType() - }); - var SocialNetwork$; - (function(SocialNetwork$2) { - SocialNetwork$2.inboundSchema = SocialNetwork$inboundSchema; - SocialNetwork$2.outboundSchema = SocialNetwork$outboundSchema; - })(SocialNetwork$ || (SocialNetwork$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredlocation.js - var StructuredLocation$inboundSchema = objectType({ - deskLocation: stringType().optional(), - timezone: stringType().optional(), - address: stringType().optional(), - city: stringType().optional(), - state: stringType().optional(), - region: stringType().optional(), - zipCode: stringType().optional(), - country: stringType().optional(), - countryCode: stringType().optional() - }); - var StructuredLocation$outboundSchema = objectType({ - deskLocation: stringType().optional(), - timezone: stringType().optional(), - address: stringType().optional(), - city: stringType().optional(), - state: stringType().optional(), - region: stringType().optional(), - zipCode: stringType().optional(), - country: stringType().optional(), - countryCode: stringType().optional() - }); - var StructuredLocation$; - (function(StructuredLocation$2) { - StructuredLocation$2.inboundSchema = StructuredLocation$inboundSchema; - StructuredLocation$2.outboundSchema = StructuredLocation$outboundSchema; - })(StructuredLocation$ || (StructuredLocation$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/personmetadata.js - var PersonMetadataType = { - FullTime: "FULL_TIME", - Contractor: "CONTRACTOR", - NonEmployee: "NON_EMPLOYEE", - FormerEmployee: "FORMER_EMPLOYEE" - }; - var PersonMetadataType$inboundSchema = nativeEnumType(PersonMetadataType); - var PersonMetadataType$outboundSchema = PersonMetadataType$inboundSchema; - var PersonMetadataType$; - (function(PersonMetadataType$2) { - PersonMetadataType$2.inboundSchema = PersonMetadataType$inboundSchema; - PersonMetadataType$2.outboundSchema = PersonMetadataType$outboundSchema; - })(PersonMetadataType$ || (PersonMetadataType$ = {})); - var PersonMetadata$inboundSchema = objectType({ - type: PersonMetadataType$inboundSchema.optional(), - firstName: stringType().optional(), - lastName: stringType().optional(), - title: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - teams: arrayType(PersonTeam$inboundSchema).optional(), - departmentCount: numberType().int().optional(), - email: stringType().optional(), - aliasEmails: arrayType(stringType()).optional(), - location: stringType().optional(), - structuredLocation: StructuredLocation$inboundSchema.optional(), - externalProfileLink: stringType().optional(), - manager: lazyType(() => Person$inboundSchema).optional(), - managementChain: arrayType(lazyType(() => Person$inboundSchema)).optional(), - phone: stringType().optional(), - timezone: stringType().optional(), - timezoneOffset: numberType().int().optional(), - photoUrl: stringType().optional(), - uneditedPhotoUrl: stringType().optional(), - bannerUrl: stringType().optional(), - reports: arrayType(lazyType(() => Person$inboundSchema)).optional(), - startDate: stringType().transform((v) => new RFCDate(v)).optional(), - endDate: stringType().transform((v) => new RFCDate(v)).optional(), - bio: stringType().optional(), - pronoun: stringType().optional(), - orgSizeCount: numberType().int().optional(), - directReportsCount: numberType().int().optional(), - preferredName: stringType().optional(), - socialNetwork: arrayType(SocialNetwork$inboundSchema).optional(), - datasourceProfile: arrayType(DatasourceProfile$inboundSchema).optional(), - querySuggestions: lazyType(() => QuerySuggestionList$inboundSchema).optional(), - peopleDistance: arrayType(PersonDistance$inboundSchema).optional(), - inviteInfo: lazyType(() => InviteInfo$inboundSchema).optional(), - isSignedUp: booleanType().optional(), - lastExtensionUse: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - permissions: Permissions$inboundSchema.optional(), - customFields: arrayType(lazyType(() => CustomFieldData$inboundSchema)).optional(), - loggingId: stringType().optional(), - startDatePercentile: numberType().optional(), - busyEvents: arrayType(AnonymousEvent$inboundSchema).optional(), - profileBoolSettings: recordType(booleanType()).optional(), - badges: arrayType(Badge$inboundSchema).optional(), - isOrgRoot: booleanType().optional() - }); - var PersonMetadata$outboundSchema = objectType({ - type: PersonMetadataType$outboundSchema.optional(), - firstName: stringType().optional(), - lastName: stringType().optional(), - title: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - teams: arrayType(PersonTeam$outboundSchema).optional(), - departmentCount: numberType().int().optional(), - email: stringType().optional(), - aliasEmails: arrayType(stringType()).optional(), - location: stringType().optional(), - structuredLocation: StructuredLocation$outboundSchema.optional(), - externalProfileLink: stringType().optional(), - manager: lazyType(() => Person$outboundSchema).optional(), - managementChain: arrayType(lazyType(() => Person$outboundSchema)).optional(), - phone: stringType().optional(), - timezone: stringType().optional(), - timezoneOffset: numberType().int().optional(), - photoUrl: stringType().optional(), - uneditedPhotoUrl: stringType().optional(), - bannerUrl: stringType().optional(), - reports: arrayType(lazyType(() => Person$outboundSchema)).optional(), - startDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - endDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - bio: stringType().optional(), - pronoun: stringType().optional(), - orgSizeCount: numberType().int().optional(), - directReportsCount: numberType().int().optional(), - preferredName: stringType().optional(), - socialNetwork: arrayType(SocialNetwork$outboundSchema).optional(), - datasourceProfile: arrayType(DatasourceProfile$outboundSchema).optional(), - querySuggestions: lazyType(() => QuerySuggestionList$outboundSchema).optional(), - peopleDistance: arrayType(PersonDistance$outboundSchema).optional(), - inviteInfo: lazyType(() => InviteInfo$outboundSchema).optional(), - isSignedUp: booleanType().optional(), - lastExtensionUse: dateType().transform((v) => v.toISOString()).optional(), - permissions: Permissions$outboundSchema.optional(), - customFields: arrayType(lazyType(() => CustomFieldData$outboundSchema)).optional(), - loggingId: stringType().optional(), - startDatePercentile: numberType().optional(), - busyEvents: arrayType(AnonymousEvent$outboundSchema).optional(), - profileBoolSettings: recordType(booleanType()).optional(), - badges: arrayType(Badge$outboundSchema).optional(), - isOrgRoot: booleanType().optional() - }); - var PersonMetadata$; - (function(PersonMetadata$2) { - PersonMetadata$2.inboundSchema = PersonMetadata$inboundSchema; - PersonMetadata$2.outboundSchema = PersonMetadata$outboundSchema; - })(PersonMetadata$ || (PersonMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/clustertypeenum.js - var ClusterTypeEnum = { - Similar: "SIMILAR", - Freshness: "FRESHNESS", - Title: "TITLE", - Content: "CONTENT", - None: "NONE", - ThreadReply: "THREAD_REPLY", - ThreadRoot: "THREAD_ROOT", - Prefix: "PREFIX", - Suffix: "SUFFIX", - AuthorPrefix: "AUTHOR_PREFIX", - AuthorSuffix: "AUTHOR_SUFFIX" - }; - var ClusterTypeEnum$inboundSchema = nativeEnumType(ClusterTypeEnum); - var ClusterTypeEnum$outboundSchema = ClusterTypeEnum$inboundSchema; - var ClusterTypeEnum$; - (function(ClusterTypeEnum$2) { - ClusterTypeEnum$2.inboundSchema = ClusterTypeEnum$inboundSchema; - ClusterTypeEnum$2.outboundSchema = ClusterTypeEnum$outboundSchema; - })(ClusterTypeEnum$ || (ClusterTypeEnum$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/clustergroup.js - var ClusterGroup$inboundSchema = objectType({ - clusteredResults: arrayType(lazyType(() => SearchResult$inboundSchema)).optional(), - clusterType: ClusterTypeEnum$inboundSchema.optional(), - visibleCountHint: numberType().int() - }); - var ClusterGroup$outboundSchema = objectType({ - clusteredResults: arrayType(lazyType(() => SearchResult$outboundSchema)).optional(), - clusterType: ClusterTypeEnum$outboundSchema.optional(), - visibleCountHint: numberType().int() - }); - var ClusterGroup$; - (function(ClusterGroup$2) { - ClusterGroup$2.inboundSchema = ClusterGroup$inboundSchema; - ClusterGroup$2.outboundSchema = ClusterGroup$outboundSchema; - })(ClusterGroup$ || (ClusterGroup$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/pindocument.js - var PinDocument$inboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - id: stringType().optional(), - documentId: stringType(), - attribution: lazyType(() => Person$inboundSchema).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var PinDocument$outboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - id: stringType().optional(), - documentId: stringType(), - attribution: lazyType(() => Person$outboundSchema).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional() - }); - var PinDocument$; - (function(PinDocument$2) { - PinDocument$2.inboundSchema = PinDocument$inboundSchema; - PinDocument$2.outboundSchema = PinDocument$outboundSchema; - })(PinDocument$ || (PinDocument$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchresultprominenceenum.js - var SearchResultProminenceEnum = { - Hero: "HERO", - Promoted: "PROMOTED", - Standard: "STANDARD" - }; - var SearchResultProminenceEnum$inboundSchema = nativeEnumType(SearchResultProminenceEnum); - var SearchResultProminenceEnum$outboundSchema = SearchResultProminenceEnum$inboundSchema; - var SearchResultProminenceEnum$; - (function(SearchResultProminenceEnum$2) { - SearchResultProminenceEnum$2.inboundSchema = SearchResultProminenceEnum$inboundSchema; - SearchResultProminenceEnum$2.outboundSchema = SearchResultProminenceEnum$outboundSchema; - })(SearchResultProminenceEnum$ || (SearchResultProminenceEnum$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchresultsnippet.js - var SearchResultSnippet$inboundSchema = objectType({ - mimeType: stringType().optional(), - text: stringType().optional(), - snippetTextOrdering: numberType().int().optional(), - ranges: arrayType(lazyType(() => TextRange$inboundSchema)).optional(), - url: stringType().optional(), - snippet: stringType() - }); - var SearchResultSnippet$outboundSchema = objectType({ - mimeType: stringType().optional(), - text: stringType().optional(), - snippetTextOrdering: numberType().int().optional(), - ranges: arrayType(lazyType(() => TextRange$outboundSchema)).optional(), - url: stringType().optional(), - snippet: stringType() - }); - var SearchResultSnippet$; - (function(SearchResultSnippet$2) { - SearchResultSnippet$2.inboundSchema = SearchResultSnippet$inboundSchema; - SearchResultSnippet$2.outboundSchema = SearchResultSnippet$outboundSchema; - })(SearchResultSnippet$ || (SearchResultSnippet$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/objectpermissions.js - var ObjectPermissions$inboundSchema = objectType({ - write: WritePermission$inboundSchema.optional() - }); - var ObjectPermissions$outboundSchema = objectType({ - write: WritePermission$outboundSchema.optional() - }); - var ObjectPermissions$; - (function(ObjectPermissions$2) { - ObjectPermissions$2.inboundSchema = ObjectPermissions$inboundSchema; - ObjectPermissions$2.outboundSchema = ObjectPermissions$outboundSchema; - })(ObjectPermissions$ || (ObjectPermissions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/grouptype.js - var GroupType = { - Department: "DEPARTMENT", - All: "ALL", - Team: "TEAM", - JobTitle: "JOB_TITLE", - RoleType: "ROLE_TYPE", - Location: "LOCATION", - Region: "REGION", - ExternalGroup: "EXTERNAL_GROUP" - }; - var GroupType$inboundSchema = nativeEnumType(GroupType); - var GroupType$outboundSchema = GroupType$inboundSchema; - var GroupType$; - (function(GroupType$2) { - GroupType$2.inboundSchema = GroupType$inboundSchema; - GroupType$2.outboundSchema = GroupType$outboundSchema; - })(GroupType$ || (GroupType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/group.js - var Group$inboundSchema = objectType({ - type: GroupType$inboundSchema, - id: stringType(), - name: stringType().optional(), - datasourceInstance: stringType().optional(), - provisioningId: stringType().optional() - }); - var Group$outboundSchema = objectType({ - type: GroupType$outboundSchema, - id: stringType(), - name: stringType().optional(), - datasourceInstance: stringType().optional(), - provisioningId: stringType().optional() - }); - var Group$; - (function(Group$2) { - Group$2.inboundSchema = Group$inboundSchema; - Group$2.outboundSchema = Group$outboundSchema; - })(Group$ || (Group$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userrole.js - var UserRole = { - Owner: "OWNER", - Viewer: "VIEWER", - AnswerModerator: "ANSWER_MODERATOR", - Editor: "EDITOR", - Verifier: "VERIFIER" - }; - var UserRole$inboundSchema = nativeEnumType(UserRole); - var UserRole$outboundSchema = UserRole$inboundSchema; - var UserRole$; - (function(UserRole$2) { - UserRole$2.inboundSchema = UserRole$inboundSchema; - UserRole$2.outboundSchema = UserRole$outboundSchema; - })(UserRole$ || (UserRole$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userrolespecification.js - var UserRoleSpecification$inboundSchema = objectType({ - sourceDocumentSpec: DocumentSpecUnion$inboundSchema.optional(), - person: lazyType(() => Person$inboundSchema).optional(), - group: Group$inboundSchema.optional(), - role: UserRole$inboundSchema - }); - var UserRoleSpecification$outboundSchema = objectType({ - sourceDocumentSpec: DocumentSpecUnion$outboundSchema.optional(), - person: lazyType(() => Person$outboundSchema).optional(), - group: Group$outboundSchema.optional(), - role: UserRole$outboundSchema - }); - var UserRoleSpecification$; - (function(UserRoleSpecification$2) { - UserRoleSpecification$2.inboundSchema = UserRoleSpecification$inboundSchema; - UserRoleSpecification$2.outboundSchema = UserRoleSpecification$outboundSchema; - })(UserRoleSpecification$ || (UserRoleSpecification$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answerboard.js - var AnswerBoard$inboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: numberType().int(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - creator: lazyType(() => Person$inboundSchema).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - itemCount: numberType().int().optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional() - }); - var AnswerBoard$outboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: numberType().int(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - creator: lazyType(() => Person$outboundSchema).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - itemCount: numberType().int().optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional() - }); - var AnswerBoard$; - (function(AnswerBoard$2) { - AnswerBoard$2.inboundSchema = AnswerBoard$inboundSchema; - AnswerBoard$2.outboundSchema = AnswerBoard$outboundSchema; - })(AnswerBoard$ || (AnswerBoard$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answerlike.js - var AnswerLike$inboundSchema = objectType({ - user: lazyType(() => Person$inboundSchema).optional(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var AnswerLike$outboundSchema = objectType({ - user: lazyType(() => Person$outboundSchema).optional(), - createTime: dateType().transform((v) => v.toISOString()).optional() - }); - var AnswerLike$; - (function(AnswerLike$2) { - AnswerLike$2.inboundSchema = AnswerLike$inboundSchema; - AnswerLike$2.outboundSchema = AnswerLike$outboundSchema; - })(AnswerLike$ || (AnswerLike$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answerlikes.js - var AnswerLikes$inboundSchema = objectType({ - likedBy: arrayType(lazyType(() => AnswerLike$inboundSchema)), - likedByUser: booleanType(), - numLikes: numberType().int() - }); - var AnswerLikes$outboundSchema = objectType({ - likedBy: arrayType(lazyType(() => AnswerLike$outboundSchema)), - likedByUser: booleanType(), - numLikes: numberType().int() - }); - var AnswerLikes$; - (function(AnswerLikes$2) { - AnswerLikes$2.inboundSchema = AnswerLikes$inboundSchema; - AnswerLikes$2.outboundSchema = AnswerLikes$outboundSchema; - })(AnswerLikes$ || (AnswerLikes$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredtextitem.js - var StructuredTextItem$inboundSchema = objectType({ - link: stringType().optional(), - document: lazyType(() => Document$inboundSchema).optional(), - text: stringType().optional(), - structuredResult: lazyType(() => StructuredResult$inboundSchema).optional() - }); - var StructuredTextItem$outboundSchema = objectType({ - link: stringType().optional(), - document: lazyType(() => Document$outboundSchema).optional(), - text: stringType().optional(), - structuredResult: lazyType(() => StructuredResult$outboundSchema).optional() - }); - var StructuredTextItem$; - (function(StructuredTextItem$2) { - StructuredTextItem$2.inboundSchema = StructuredTextItem$inboundSchema; - StructuredTextItem$2.outboundSchema = StructuredTextItem$outboundSchema; - })(StructuredTextItem$ || (StructuredTextItem$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredtext.js - var StructuredText$inboundSchema = objectType({ - text: stringType(), - structuredList: arrayType(lazyType(() => StructuredTextItem$inboundSchema)).optional() - }); - var StructuredText$outboundSchema = objectType({ - text: stringType(), - structuredList: arrayType(lazyType(() => StructuredTextItem$outboundSchema)).optional() - }); - var StructuredText$; - (function(StructuredText$2) { - StructuredText$2.inboundSchema = StructuredText$inboundSchema; - StructuredText$2.outboundSchema = StructuredText$outboundSchema; - })(StructuredText$ || (StructuredText$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/reminder.js - var Reminder$inboundSchema = objectType({ - assignee: lazyType(() => Person$inboundSchema), - requestor: lazyType(() => Person$inboundSchema).optional(), - remindAt: numberType().int(), - createdAt: numberType().int().optional(), - reason: stringType().optional() - }); - var Reminder$outboundSchema = objectType({ - assignee: lazyType(() => Person$outboundSchema), - requestor: lazyType(() => Person$outboundSchema).optional(), - remindAt: numberType().int(), - createdAt: numberType().int().optional(), - reason: stringType().optional() - }); - var Reminder$; - (function(Reminder$2) { - Reminder$2.inboundSchema = Reminder$inboundSchema; - Reminder$2.outboundSchema = Reminder$outboundSchema; - })(Reminder$ || (Reminder$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/verificationmetadata.js - var VerificationMetadata$inboundSchema = objectType({ - lastVerifier: lazyType(() => Person$inboundSchema).optional(), - lastVerificationTs: numberType().int().optional(), - expirationTs: numberType().int().optional(), - document: lazyType(() => Document$inboundSchema).optional(), - reminders: arrayType(lazyType(() => Reminder$inboundSchema)).optional(), - lastReminder: lazyType(() => Reminder$inboundSchema).optional(), - visitorCount: arrayType(CountInfo$inboundSchema).optional(), - candidateVerifiers: arrayType(lazyType(() => Person$inboundSchema)).optional() - }); - var VerificationMetadata$outboundSchema = objectType({ - lastVerifier: lazyType(() => Person$outboundSchema).optional(), - lastVerificationTs: numberType().int().optional(), - expirationTs: numberType().int().optional(), - document: lazyType(() => Document$outboundSchema).optional(), - reminders: arrayType(lazyType(() => Reminder$outboundSchema)).optional(), - lastReminder: lazyType(() => Reminder$outboundSchema).optional(), - visitorCount: arrayType(CountInfo$outboundSchema).optional(), - candidateVerifiers: arrayType(lazyType(() => Person$outboundSchema)).optional() - }); - var VerificationMetadata$; - (function(VerificationMetadata$2) { - VerificationMetadata$2.inboundSchema = VerificationMetadata$inboundSchema; - VerificationMetadata$2.outboundSchema = VerificationMetadata$outboundSchema; - })(VerificationMetadata$ || (VerificationMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/verification.js - var State = { - Unverified: "UNVERIFIED", - Verified: "VERIFIED", - Deprecated: "DEPRECATED" - }; - var State$inboundSchema = nativeEnumType(State); - var State$outboundSchema = State$inboundSchema; - var State$; - (function(State$2) { - State$2.inboundSchema = State$inboundSchema; - State$2.outboundSchema = State$outboundSchema; - })(State$ || (State$ = {})); - var Verification$inboundSchema = objectType({ - state: State$inboundSchema, - metadata: lazyType(() => VerificationMetadata$inboundSchema).optional() - }); - var Verification$outboundSchema = objectType({ - state: State$outboundSchema, - metadata: lazyType(() => VerificationMetadata$outboundSchema).optional() - }); - var Verification$; - (function(Verification$2) { - Verification$2.inboundSchema = Verification$inboundSchema; - Verification$2.outboundSchema = Verification$outboundSchema; - })(Verification$ || (Verification$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answer.js - var AnswerSourceType = { - Document: "DOCUMENT", - Assistant: "ASSISTANT" - }; - var AnswerSourceType$inboundSchema = nativeEnumType(AnswerSourceType); - var AnswerSourceType$outboundSchema = AnswerSourceType$inboundSchema; - var AnswerSourceType$; - (function(AnswerSourceType$2) { - AnswerSourceType$2.inboundSchema = AnswerSourceType$inboundSchema; - AnswerSourceType$2.outboundSchema = AnswerSourceType$outboundSchema; - })(AnswerSourceType$ || (AnswerSourceType$ = {})); - var Answer$inboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional(), - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - sourceDocumentSpec: DocumentSpecUnion$inboundSchema.optional(), - sourceType: AnswerSourceType$inboundSchema.optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - combinedAnswerText: lazyType(() => StructuredText$inboundSchema).optional(), - likes: lazyType(() => AnswerLikes$inboundSchema).optional(), - author: lazyType(() => Person$inboundSchema).optional(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - verification: lazyType(() => Verification$inboundSchema).optional(), - board: lazyType(() => AnswerBoard$inboundSchema).optional(), - collections: arrayType(lazyType(() => Collection$inboundSchema)).optional(), - documentCategory: stringType().optional(), - sourceDocument: lazyType(() => Document$inboundSchema).optional() - }); - var Answer$outboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional(), - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - sourceDocumentSpec: DocumentSpecUnion$outboundSchema.optional(), - sourceType: AnswerSourceType$outboundSchema.optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - combinedAnswerText: lazyType(() => StructuredText$outboundSchema).optional(), - likes: lazyType(() => AnswerLikes$outboundSchema).optional(), - author: lazyType(() => Person$outboundSchema).optional(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - verification: lazyType(() => Verification$outboundSchema).optional(), - board: lazyType(() => AnswerBoard$outboundSchema).optional(), - collections: arrayType(lazyType(() => Collection$outboundSchema)).optional(), - documentCategory: stringType().optional(), - sourceDocument: lazyType(() => Document$outboundSchema).optional() - }); - var Answer$; - (function(Answer$2) { - Answer$2.inboundSchema = Answer$inboundSchema; - Answer$2.outboundSchema = Answer$outboundSchema; - })(Answer$ || (Answer$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/appresult.js - var AppResult$inboundSchema = objectType({ - datasource: stringType(), - docType: stringType().optional(), - mimeType: stringType().optional(), - iconUrl: stringType().optional() - }); - var AppResult$outboundSchema = objectType({ - datasource: stringType(), - docType: stringType().optional(), - mimeType: stringType().optional(), - iconUrl: stringType().optional() - }); - var AppResult$; - (function(AppResult$2) { - AppResult$2.inboundSchema = AppResult$inboundSchema; - AppResult$2.outboundSchema = AppResult$outboundSchema; - })(AppResult$ || (AppResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/codeline.js - var CodeLine$inboundSchema = objectType({ - lineNumber: numberType().int().optional(), - content: stringType().optional(), - ranges: arrayType(lazyType(() => TextRange$inboundSchema)).optional() - }); - var CodeLine$outboundSchema = objectType({ - lineNumber: numberType().int().optional(), - content: stringType().optional(), - ranges: arrayType(lazyType(() => TextRange$outboundSchema)).optional() - }); - var CodeLine$; - (function(CodeLine$2) { - CodeLine$2.inboundSchema = CodeLine$inboundSchema; - CodeLine$2.outboundSchema = CodeLine$outboundSchema; - })(CodeLine$ || (CodeLine$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/code.js - var Code$inboundSchema = objectType({ - repoName: stringType().optional(), - fileName: stringType().optional(), - fileUrl: stringType().optional(), - lines: arrayType(lazyType(() => CodeLine$inboundSchema)).optional(), - isLastMatch: booleanType().optional() - }); - var Code$outboundSchema = objectType({ - repoName: stringType().optional(), - fileName: stringType().optional(), - fileUrl: stringType().optional(), - lines: arrayType(lazyType(() => CodeLine$outboundSchema)).optional(), - isLastMatch: booleanType().optional() - }); - var Code$; - (function(Code$2) { - Code$2.inboundSchema = Code$inboundSchema; - Code$2.outboundSchema = Code$outboundSchema; - })(Code$ || (Code$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customentitymetadata.js - var CustomEntityMetadata$inboundSchema = objectType({ - customData: recordType(CustomDataValue$inboundSchema).optional() - }); - var CustomEntityMetadata$outboundSchema = objectType({ - customData: recordType(CustomDataValue$outboundSchema).optional() - }); - var CustomEntityMetadata$; - (function(CustomEntityMetadata$2) { - CustomEntityMetadata$2.inboundSchema = CustomEntityMetadata$inboundSchema; - CustomEntityMetadata$2.outboundSchema = CustomEntityMetadata$outboundSchema; - })(CustomEntityMetadata$ || (CustomEntityMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customentity.js - var CustomEntity$inboundSchema = objectType({ - permissions: ObjectPermissions$inboundSchema.optional(), - id: stringType().optional(), - title: stringType().optional(), - datasource: stringType().optional(), - objectType: stringType().optional(), - metadata: CustomEntityMetadata$inboundSchema.optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional() - }); - var CustomEntity$outboundSchema = objectType({ - permissions: ObjectPermissions$outboundSchema.optional(), - id: stringType().optional(), - title: stringType().optional(), - datasource: stringType().optional(), - objectType: stringType().optional(), - metadata: CustomEntityMetadata$outboundSchema.optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional() - }); - var CustomEntity$; - (function(CustomEntity$2) { - CustomEntity$2.inboundSchema = CustomEntity$inboundSchema; - CustomEntity$2.outboundSchema = CustomEntity$outboundSchema; - })(CustomEntity$ || (CustomEntity$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/company.js - var Company$inboundSchema = objectType({ - name: stringType(), - profileUrl: stringType().optional(), - websiteUrls: arrayType(stringType()).optional(), - logoUrl: stringType().optional(), - location: stringType().optional(), - phone: stringType().optional(), - fax: stringType().optional(), - industry: stringType().optional(), - annualRevenue: numberType().optional(), - numberOfEmployees: numberType().int().optional(), - stockSymbol: stringType().optional(), - foundedDate: stringType().transform((v) => new RFCDate(v)).optional(), - about: stringType().optional() - }); - var Company$outboundSchema = objectType({ - name: stringType(), - profileUrl: stringType().optional(), - websiteUrls: arrayType(stringType()).optional(), - logoUrl: stringType().optional(), - location: stringType().optional(), - phone: stringType().optional(), - fax: stringType().optional(), - industry: stringType().optional(), - annualRevenue: numberType().optional(), - numberOfEmployees: numberType().int().optional(), - stockSymbol: stringType().optional(), - foundedDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - about: stringType().optional() - }); - var Company$; - (function(Company$2) { - Company$2.inboundSchema = Company$inboundSchema; - Company$2.outboundSchema = Company$outboundSchema; - })(Company$ || (Company$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customermetadata.js - var CustomerMetadata$inboundSchema = objectType({ - datasourceId: stringType().optional(), - customData: recordType(CustomDataValue$inboundSchema).optional() - }); - var CustomerMetadata$outboundSchema = objectType({ - datasourceId: stringType().optional(), - customData: recordType(CustomDataValue$outboundSchema).optional() - }); - var CustomerMetadata$; - (function(CustomerMetadata$2) { - CustomerMetadata$2.inboundSchema = CustomerMetadata$inboundSchema; - CustomerMetadata$2.outboundSchema = CustomerMetadata$outboundSchema; - })(CustomerMetadata$ || (CustomerMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customer.js - var Customer$inboundSchema = objectType({ - id: stringType(), - domains: arrayType(stringType()).optional(), - company: Company$inboundSchema, - documentCounts: recordType(numberType().int()).optional(), - poc: arrayType(lazyType(() => Person$inboundSchema)).optional(), - metadata: CustomerMetadata$inboundSchema.optional(), - mergedCustomers: arrayType(lazyType(() => Customer$inboundSchema)).optional(), - startDate: stringType().transform((v) => new RFCDate(v)).optional(), - contractAnnualRevenue: numberType().optional(), - notes: stringType().optional() - }); - var Customer$outboundSchema = objectType({ - id: stringType(), - domains: arrayType(stringType()).optional(), - company: Company$outboundSchema, - documentCounts: recordType(numberType().int()).optional(), - poc: arrayType(lazyType(() => Person$outboundSchema)).optional(), - metadata: CustomerMetadata$outboundSchema.optional(), - mergedCustomers: arrayType(lazyType(() => Customer$outboundSchema)).optional(), - startDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - contractAnnualRevenue: numberType().optional(), - notes: stringType().optional() - }); - var Customer$; - (function(Customer$2) { - Customer$2.inboundSchema = Customer$inboundSchema; - Customer$2.outboundSchema = Customer$outboundSchema; - })(Customer$ || (Customer$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/entitytype.js - var EntityType = { - Person: "PERSON", - Project: "PROJECT", - Customer: "CUSTOMER" - }; - var EntityType$inboundSchema = nativeEnumType(EntityType); - var EntityType$outboundSchema = EntityType$inboundSchema; - var EntityType$; - (function(EntityType$2) { - EntityType$2.inboundSchema = EntityType$inboundSchema; - EntityType$2.outboundSchema = EntityType$outboundSchema; - })(EntityType$ || (EntityType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/disambiguation.js - var Disambiguation$inboundSchema = objectType({ - name: stringType().optional(), - id: stringType().optional(), - type: EntityType$inboundSchema.optional() - }); - var Disambiguation$outboundSchema = objectType({ - name: stringType().optional(), - id: stringType().optional(), - type: EntityType$outboundSchema.optional() - }); - var Disambiguation$; - (function(Disambiguation$2) { - Disambiguation$2.inboundSchema = Disambiguation$inboundSchema; - Disambiguation$2.outboundSchema = Disambiguation$outboundSchema; - })(Disambiguation$ || (Disambiguation$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/extractedqna.js - var ExtractedQnA$inboundSchema = objectType({ - heading: stringType().optional(), - question: stringType().optional(), - questionResult: lazyType(() => SearchResult$inboundSchema).optional() - }); - var ExtractedQnA$outboundSchema = objectType({ - heading: stringType().optional(), - question: stringType().optional(), - questionResult: lazyType(() => SearchResult$outboundSchema).optional() - }); - var ExtractedQnA$; - (function(ExtractedQnA$2) { - ExtractedQnA$2.inboundSchema = ExtractedQnA$inboundSchema; - ExtractedQnA$2.outboundSchema = ExtractedQnA$outboundSchema; - })(ExtractedQnA$ || (ExtractedQnA$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/followupaction.js - var FollowupAction$inboundSchema = objectType({ - actionRunId: stringType().optional(), - actionInstanceId: stringType().optional(), - actionId: stringType().optional(), - parameters: recordType(stringType()).optional(), - recommendationText: stringType().optional(), - actionLabel: stringType().optional(), - userConfirmationRequired: booleanType().optional() - }); - var FollowupAction$outboundSchema = objectType({ - actionRunId: stringType().optional(), - actionInstanceId: stringType().optional(), - actionId: stringType().optional(), - parameters: recordType(stringType()).optional(), - recommendationText: stringType().optional(), - actionLabel: stringType().optional(), - userConfirmationRequired: booleanType().optional() - }); - var FollowupAction$; - (function(FollowupAction$2) { - FollowupAction$2.inboundSchema = FollowupAction$inboundSchema; - FollowupAction$2.outboundSchema = FollowupAction$outboundSchema; - })(FollowupAction$ || (FollowupAction$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/generatedqna.js - var GeneratedQnaStatus = { - Computing: "COMPUTING", - Disabled: "DISABLED", - Failed: "FAILED", - NoAnswer: "NO_ANSWER", - Skipped: "SKIPPED", - Streaming: "STREAMING", - Succeeded: "SUCCEEDED", - Timeout: "TIMEOUT" - }; - var GeneratedQnaStatus$inboundSchema = nativeEnumType(GeneratedQnaStatus); - var GeneratedQnaStatus$outboundSchema = GeneratedQnaStatus$inboundSchema; - var GeneratedQnaStatus$; - (function(GeneratedQnaStatus$2) { - GeneratedQnaStatus$2.inboundSchema = GeneratedQnaStatus$inboundSchema; - GeneratedQnaStatus$2.outboundSchema = GeneratedQnaStatus$outboundSchema; - })(GeneratedQnaStatus$ || (GeneratedQnaStatus$ = {})); - var GeneratedQna$inboundSchema = objectType({ - question: stringType().optional(), - answer: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional(), - followupActions: arrayType(FollowupAction$inboundSchema).optional(), - ranges: arrayType(lazyType(() => TextRange$inboundSchema)).optional(), - status: GeneratedQnaStatus$inboundSchema.optional(), - cursor: stringType().optional(), - trackingToken: stringType().optional() - }); - var GeneratedQna$outboundSchema = objectType({ - question: stringType().optional(), - answer: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional(), - followupActions: arrayType(FollowupAction$outboundSchema).optional(), - ranges: arrayType(lazyType(() => TextRange$outboundSchema)).optional(), - status: GeneratedQnaStatus$outboundSchema.optional(), - cursor: stringType().optional(), - trackingToken: stringType().optional() - }); - var GeneratedQna$; - (function(GeneratedQna$2) { - GeneratedQna$2.inboundSchema = GeneratedQna$inboundSchema; - GeneratedQna$2.outboundSchema = GeneratedQna$outboundSchema; - })(GeneratedQna$ || (GeneratedQna$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/calendarattendee.js - var ResponseStatus = { - Accepted: "ACCEPTED", - Declined: "DECLINED", - NoResponse: "NO_RESPONSE", - Tentative: "TENTATIVE" - }; - var ResponseStatus$inboundSchema = nativeEnumType(ResponseStatus); - var ResponseStatus$outboundSchema = ResponseStatus$inboundSchema; - var ResponseStatus$; - (function(ResponseStatus$2) { - ResponseStatus$2.inboundSchema = ResponseStatus$inboundSchema; - ResponseStatus$2.outboundSchema = ResponseStatus$outboundSchema; - })(ResponseStatus$ || (ResponseStatus$ = {})); - var CalendarAttendee$inboundSchema = objectType({ - isOrganizer: booleanType().optional(), - isInGroup: booleanType().optional(), - person: lazyType(() => Person$inboundSchema), - groupAttendees: arrayType(lazyType(() => CalendarAttendee$inboundSchema)).optional(), - responseStatus: ResponseStatus$inboundSchema.optional() - }); - var CalendarAttendee$outboundSchema = objectType({ - isOrganizer: booleanType().optional(), - isInGroup: booleanType().optional(), - person: lazyType(() => Person$outboundSchema), - groupAttendees: arrayType(lazyType(() => CalendarAttendee$outboundSchema)).optional(), - responseStatus: ResponseStatus$outboundSchema.optional() - }); - var CalendarAttendee$; - (function(CalendarAttendee$2) { - CalendarAttendee$2.inboundSchema = CalendarAttendee$inboundSchema; - CalendarAttendee$2.outboundSchema = CalendarAttendee$outboundSchema; - })(CalendarAttendee$ || (CalendarAttendee$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/calendarattendees.js - var CalendarAttendees$inboundSchema = objectType({ - people: arrayType(lazyType(() => CalendarAttendee$inboundSchema)).optional(), - isLimit: booleanType().optional(), - total: numberType().int().optional(), - numAccepted: numberType().int().optional(), - numDeclined: numberType().int().optional(), - numNoResponse: numberType().int().optional(), - numTentative: numberType().int().optional() - }); - var CalendarAttendees$outboundSchema = objectType({ - people: arrayType(lazyType(() => CalendarAttendee$outboundSchema)).optional(), - isLimit: booleanType().optional(), - total: numberType().int().optional(), - numAccepted: numberType().int().optional(), - numDeclined: numberType().int().optional(), - numNoResponse: numberType().int().optional(), - numTentative: numberType().int().optional() - }); - var CalendarAttendees$; - (function(CalendarAttendees$2) { - CalendarAttendees$2.inboundSchema = CalendarAttendees$inboundSchema; - CalendarAttendees$2.outboundSchema = CalendarAttendees$outboundSchema; - })(CalendarAttendees$ || (CalendarAttendees$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/meeting.js - var Meeting$inboundSchema = objectType({ - id: stringType().optional(), - title: stringType().optional(), - description: stringType().optional(), - url: stringType().optional(), - startTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - endTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - attendees: lazyType(() => CalendarAttendees$inboundSchema).optional() - }); - var Meeting$outboundSchema = objectType({ - id: stringType().optional(), - title: stringType().optional(), - description: stringType().optional(), - url: stringType().optional(), - startTime: dateType().transform((v) => v.toISOString()).optional(), - endTime: dateType().transform((v) => v.toISOString()).optional(), - attendees: lazyType(() => CalendarAttendees$outboundSchema).optional() - }); - var Meeting$; - (function(Meeting$2) { - Meeting$2.inboundSchema = Meeting$inboundSchema; - Meeting$2.outboundSchema = Meeting$outboundSchema; - })(Meeting$ || (Meeting$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/relatedquestion.js - var RelatedQuestion$inboundSchema = objectType({ - question: stringType().optional(), - answer: stringType().optional(), - ranges: arrayType(lazyType(() => TextRange$inboundSchema)).optional() - }); - var RelatedQuestion$outboundSchema = objectType({ - question: stringType().optional(), - answer: stringType().optional(), - ranges: arrayType(lazyType(() => TextRange$outboundSchema)).optional() - }); - var RelatedQuestion$; - (function(RelatedQuestion$2) { - RelatedQuestion$2.inboundSchema = RelatedQuestion$inboundSchema; - RelatedQuestion$2.outboundSchema = RelatedQuestion$outboundSchema; - })(RelatedQuestion$ || (RelatedQuestion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcut.js - var Shortcut$inboundSchema = objectType({ - id: numberType().int().optional(), - inputAlias: stringType(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - createdBy: lazyType(() => Person$inboundSchema).optional(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - destinationDocument: lazyType(() => Document$inboundSchema).optional(), - intermediateUrl: stringType().optional(), - viewPrefix: stringType().optional(), - isExternal: booleanType().optional(), - editUrl: stringType().optional(), - alias: stringType().optional(), - title: stringType().optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional() - }); - var Shortcut$outboundSchema = objectType({ - id: numberType().int().optional(), - inputAlias: stringType(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - createdBy: lazyType(() => Person$outboundSchema).optional(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - destinationDocument: lazyType(() => Document$outboundSchema).optional(), - intermediateUrl: stringType().optional(), - viewPrefix: stringType().optional(), - isExternal: booleanType().optional(), - editUrl: stringType().optional(), - alias: stringType().optional(), - title: stringType().optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional() - }); - var Shortcut$; - (function(Shortcut$2) { - Shortcut$2.inboundSchema = Shortcut$inboundSchema; - Shortcut$2.outboundSchema = Shortcut$outboundSchema; - })(Shortcut$ || (Shortcut$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/persontoteamrelationship.js - var PersonToTeamRelationshipRelationship = { - Member: "MEMBER", - Manager: "MANAGER", - Lead: "LEAD", - PointOfContact: "POINT_OF_CONTACT", - Other: "OTHER" - }; - var PersonToTeamRelationshipRelationship$inboundSchema = nativeEnumType(PersonToTeamRelationshipRelationship); - var PersonToTeamRelationshipRelationship$outboundSchema = PersonToTeamRelationshipRelationship$inboundSchema; - var PersonToTeamRelationshipRelationship$; - (function(PersonToTeamRelationshipRelationship$2) { - PersonToTeamRelationshipRelationship$2.inboundSchema = PersonToTeamRelationshipRelationship$inboundSchema; - PersonToTeamRelationshipRelationship$2.outboundSchema = PersonToTeamRelationshipRelationship$outboundSchema; - })(PersonToTeamRelationshipRelationship$ || (PersonToTeamRelationshipRelationship$ = {})); - var PersonToTeamRelationship$inboundSchema = objectType({ - person: lazyType(() => Person$inboundSchema), - relationship: PersonToTeamRelationshipRelationship$inboundSchema.default("MEMBER"), - customRelationshipStr: stringType().optional(), - joinDate: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var PersonToTeamRelationship$outboundSchema = objectType({ - person: lazyType(() => Person$outboundSchema), - relationship: PersonToTeamRelationshipRelationship$outboundSchema.default("MEMBER"), - customRelationshipStr: stringType().optional(), - joinDate: dateType().transform((v) => v.toISOString()).optional() - }); - var PersonToTeamRelationship$; - (function(PersonToTeamRelationship$2) { - PersonToTeamRelationship$2.inboundSchema = PersonToTeamRelationship$inboundSchema; - PersonToTeamRelationship$2.outboundSchema = PersonToTeamRelationship$outboundSchema; - })(PersonToTeamRelationship$ || (PersonToTeamRelationship$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/relatedobject.js - var RelatedObjectMetadata$inboundSchema = objectType({ - name: stringType().optional() - }); - var RelatedObjectMetadata$outboundSchema = objectType({ - name: stringType().optional() - }); - var RelatedObjectMetadata$; - (function(RelatedObjectMetadata$2) { - RelatedObjectMetadata$2.inboundSchema = RelatedObjectMetadata$inboundSchema; - RelatedObjectMetadata$2.outboundSchema = RelatedObjectMetadata$outboundSchema; - })(RelatedObjectMetadata$ || (RelatedObjectMetadata$ = {})); - var RelatedObject$inboundSchema = objectType({ - id: stringType(), - metadata: lazyType(() => RelatedObjectMetadata$inboundSchema).optional() - }); - var RelatedObject$outboundSchema = objectType({ - id: stringType(), - metadata: lazyType(() => RelatedObjectMetadata$outboundSchema).optional() - }); - var RelatedObject$; - (function(RelatedObject$2) { - RelatedObject$2.inboundSchema = RelatedObject$inboundSchema; - RelatedObject$2.outboundSchema = RelatedObject$outboundSchema; - })(RelatedObject$ || (RelatedObject$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/relatedobjectedge.js - var RelatedObjectEdge$inboundSchema = objectType({ - objects: arrayType(RelatedObject$inboundSchema).optional() - }); - var RelatedObjectEdge$outboundSchema = objectType({ - objects: arrayType(RelatedObject$outboundSchema).optional() - }); - var RelatedObjectEdge$; - (function(RelatedObjectEdge$2) { - RelatedObjectEdge$2.inboundSchema = RelatedObjectEdge$inboundSchema; - RelatedObjectEdge$2.outboundSchema = RelatedObjectEdge$outboundSchema; - })(RelatedObjectEdge$ || (RelatedObjectEdge$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/teamemail.js - var TeamEmail$inboundSchema = objectType({ - email: stringType(), - type: stringType().default("OTHER") - }); - var TeamEmail$outboundSchema = objectType({ - email: stringType(), - type: stringType().default("OTHER") - }); - var TeamEmail$; - (function(TeamEmail$2) { - TeamEmail$2.inboundSchema = TeamEmail$inboundSchema; - TeamEmail$2.outboundSchema = TeamEmail$outboundSchema; - })(TeamEmail$ || (TeamEmail$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/team.js - var TeamStatus = { - Processed: "PROCESSED", - QueuedForCreation: "QUEUED_FOR_CREATION", - QueuedForDeletion: "QUEUED_FOR_DELETION" - }; - var TeamStatus$inboundSchema = nativeEnumType(TeamStatus); - var TeamStatus$outboundSchema = TeamStatus$inboundSchema; - var TeamStatus$; - (function(TeamStatus$2) { - TeamStatus$2.inboundSchema = TeamStatus$inboundSchema; - TeamStatus$2.outboundSchema = TeamStatus$outboundSchema; - })(TeamStatus$ || (TeamStatus$ = {})); - var Team$inboundSchema = objectType({ - relatedObjects: recordType(RelatedObjectEdge$inboundSchema).optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: stringType(), - name: stringType(), - description: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - photoUrl: stringType().optional(), - bannerUrl: stringType().optional(), - externalLink: stringType().optional(), - members: arrayType(lazyType(() => PersonToTeamRelationship$inboundSchema)).optional(), - memberCount: numberType().int().optional(), - emails: arrayType(TeamEmail$inboundSchema).optional(), - customFields: arrayType(lazyType(() => CustomFieldData$inboundSchema)).optional(), - datasourceProfiles: arrayType(DatasourceProfile$inboundSchema).optional(), - datasource: stringType().optional(), - createdFrom: stringType().optional(), - lastUpdatedAt: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - status: TeamStatus$inboundSchema.default("PROCESSED"), - canBeDeleted: booleanType().default(true), - loggingId: stringType().optional() - }); - var Team$outboundSchema = objectType({ - relatedObjects: recordType(RelatedObjectEdge$outboundSchema).optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: stringType(), - name: stringType(), - description: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - photoUrl: stringType().optional(), - bannerUrl: stringType().optional(), - externalLink: stringType().optional(), - members: arrayType(lazyType(() => PersonToTeamRelationship$outboundSchema)).optional(), - memberCount: numberType().int().optional(), - emails: arrayType(TeamEmail$outboundSchema).optional(), - customFields: arrayType(lazyType(() => CustomFieldData$outboundSchema)).optional(), - datasourceProfiles: arrayType(DatasourceProfile$outboundSchema).optional(), - datasource: stringType().optional(), - createdFrom: stringType().optional(), - lastUpdatedAt: dateType().transform((v) => v.toISOString()).optional(), - status: TeamStatus$outboundSchema.default("PROCESSED"), - canBeDeleted: booleanType().default(true), - loggingId: stringType().optional() - }); - var Team$; - (function(Team$2) { - Team$2.inboundSchema = Team$inboundSchema; - Team$2.outboundSchema = Team$outboundSchema; - })(Team$ || (Team$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredresult.js - var Prominence = { - Hero: "HERO", - Promoted: "PROMOTED", - Standard: "STANDARD" - }; - var StructuredResultSource = { - ExpertDetection: "EXPERT_DETECTION", - EntityNlq: "ENTITY_NLQ" - }; - var Prominence$inboundSchema = nativeEnumType(Prominence); - var Prominence$outboundSchema = Prominence$inboundSchema; - var Prominence$; - (function(Prominence$2) { - Prominence$2.inboundSchema = Prominence$inboundSchema; - Prominence$2.outboundSchema = Prominence$outboundSchema; - })(Prominence$ || (Prominence$ = {})); - var StructuredResultSource$inboundSchema = nativeEnumType(StructuredResultSource); - var StructuredResultSource$outboundSchema = StructuredResultSource$inboundSchema; - var StructuredResultSource$; - (function(StructuredResultSource$2) { - StructuredResultSource$2.inboundSchema = StructuredResultSource$inboundSchema; - StructuredResultSource$2.outboundSchema = StructuredResultSource$outboundSchema; - })(StructuredResultSource$ || (StructuredResultSource$ = {})); - var StructuredResult$inboundSchema = objectType({ - document: lazyType(() => Document$inboundSchema).optional(), - person: lazyType(() => Person$inboundSchema).optional(), - customer: lazyType(() => Customer$inboundSchema).optional(), - team: lazyType(() => Team$inboundSchema).optional(), - customEntity: lazyType(() => CustomEntity$inboundSchema).optional(), - answer: lazyType(() => Answer$inboundSchema).optional(), - generatedQna: lazyType(() => GeneratedQna$inboundSchema).optional(), - extractedQnA: lazyType(() => ExtractedQnA$inboundSchema).optional(), - meeting: lazyType(() => Meeting$inboundSchema).optional(), - app: AppResult$inboundSchema.optional(), - collection: lazyType(() => Collection$inboundSchema).optional(), - answerBoard: lazyType(() => AnswerBoard$inboundSchema).optional(), - code: lazyType(() => Code$inboundSchema).optional(), - shortcut: lazyType(() => Shortcut$inboundSchema).optional(), - querySuggestions: lazyType(() => QuerySuggestionList$inboundSchema).optional(), - relatedDocuments: arrayType(lazyType(() => RelatedDocuments$inboundSchema)).optional(), - relatedQuestion: lazyType(() => RelatedQuestion$inboundSchema).optional(), - disambiguation: Disambiguation$inboundSchema.optional(), - snippets: arrayType(lazyType(() => SearchResultSnippet$inboundSchema)).optional(), - trackingToken: stringType().optional(), - prominence: Prominence$inboundSchema.optional(), - source: StructuredResultSource$inboundSchema.optional() - }); - var StructuredResult$outboundSchema = objectType({ - document: lazyType(() => Document$outboundSchema).optional(), - person: lazyType(() => Person$outboundSchema).optional(), - customer: lazyType(() => Customer$outboundSchema).optional(), - team: lazyType(() => Team$outboundSchema).optional(), - customEntity: lazyType(() => CustomEntity$outboundSchema).optional(), - answer: lazyType(() => Answer$outboundSchema).optional(), - generatedQna: lazyType(() => GeneratedQna$outboundSchema).optional(), - extractedQnA: lazyType(() => ExtractedQnA$outboundSchema).optional(), - meeting: lazyType(() => Meeting$outboundSchema).optional(), - app: AppResult$outboundSchema.optional(), - collection: lazyType(() => Collection$outboundSchema).optional(), - answerBoard: lazyType(() => AnswerBoard$outboundSchema).optional(), - code: lazyType(() => Code$outboundSchema).optional(), - shortcut: lazyType(() => Shortcut$outboundSchema).optional(), - querySuggestions: lazyType(() => QuerySuggestionList$outboundSchema).optional(), - relatedDocuments: arrayType(lazyType(() => RelatedDocuments$outboundSchema)).optional(), - relatedQuestion: lazyType(() => RelatedQuestion$outboundSchema).optional(), - disambiguation: Disambiguation$outboundSchema.optional(), - snippets: arrayType(lazyType(() => SearchResultSnippet$outboundSchema)).optional(), - trackingToken: stringType().optional(), - prominence: Prominence$outboundSchema.optional(), - source: StructuredResultSource$outboundSchema.optional() - }); - var StructuredResult$; - (function(StructuredResult$2) { - StructuredResult$2.inboundSchema = StructuredResult$inboundSchema; - StructuredResult$2.outboundSchema = StructuredResult$outboundSchema; - })(StructuredResult$ || (StructuredResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchresult.js - var SearchResult$inboundSchema = objectType({ - structuredResults: arrayType(lazyType(() => StructuredResult$inboundSchema)).optional(), - trackingToken: stringType().optional(), - document: lazyType(() => Document$inboundSchema).optional(), - title: stringType().optional(), - url: stringType(), - nativeAppUrl: stringType().optional(), - snippets: arrayType(lazyType(() => SearchResultSnippet$inboundSchema)).optional(), - fullText: stringType().optional(), - fullTextList: arrayType(stringType()).optional(), - relatedResults: arrayType(lazyType(() => RelatedDocuments$inboundSchema)).optional(), - clusteredResults: arrayType(lazyType(() => SearchResult$inboundSchema)).optional(), - allClusteredResults: arrayType(lazyType(() => ClusterGroup$inboundSchema)).optional(), - attachmentCount: numberType().int().optional(), - attachments: arrayType(lazyType(() => SearchResult$inboundSchema)).optional(), - backlinkResults: arrayType(lazyType(() => SearchResult$inboundSchema)).optional(), - clusterType: ClusterTypeEnum$inboundSchema.optional(), - mustIncludeSuggestions: lazyType(() => QuerySuggestionList$inboundSchema).optional(), - querySuggestion: lazyType(() => QuerySuggestion$inboundSchema).optional(), - prominence: SearchResultProminenceEnum$inboundSchema.optional(), - attachmentContext: stringType().optional(), - pins: arrayType(lazyType(() => PinDocument$inboundSchema)).optional() - }); - var SearchResult$outboundSchema = objectType({ - structuredResults: arrayType(lazyType(() => StructuredResult$outboundSchema)).optional(), - trackingToken: stringType().optional(), - document: lazyType(() => Document$outboundSchema).optional(), - title: stringType().optional(), - url: stringType(), - nativeAppUrl: stringType().optional(), - snippets: arrayType(lazyType(() => SearchResultSnippet$outboundSchema)).optional(), - fullText: stringType().optional(), - fullTextList: arrayType(stringType()).optional(), - relatedResults: arrayType(lazyType(() => RelatedDocuments$outboundSchema)).optional(), - clusteredResults: arrayType(lazyType(() => SearchResult$outboundSchema)).optional(), - allClusteredResults: arrayType(lazyType(() => ClusterGroup$outboundSchema)).optional(), - attachmentCount: numberType().int().optional(), - attachments: arrayType(lazyType(() => SearchResult$outboundSchema)).optional(), - backlinkResults: arrayType(lazyType(() => SearchResult$outboundSchema)).optional(), - clusterType: ClusterTypeEnum$outboundSchema.optional(), - mustIncludeSuggestions: lazyType(() => QuerySuggestionList$outboundSchema).optional(), - querySuggestion: lazyType(() => QuerySuggestion$outboundSchema).optional(), - prominence: SearchResultProminenceEnum$outboundSchema.optional(), - attachmentContext: stringType().optional(), - pins: arrayType(lazyType(() => PinDocument$outboundSchema)).optional() - }); - var SearchResult$; - (function(SearchResult$2) { - SearchResult$2.inboundSchema = SearchResult$inboundSchema; - SearchResult$2.outboundSchema = SearchResult$outboundSchema; - })(SearchResult$ || (SearchResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/relateddocuments.js - var Relation = { - Attachment: "ATTACHMENT", - Canonical: "CANONICAL", - Case: "CASE", - ContactLower: "contact", - ContactUpper: "CONTACT", - ConversationMessages: "CONVERSATION_MESSAGES", - Expert: "EXPERT", - From: "FROM", - Highlight: "HIGHLIGHT", - OpportunityLower: "opportunity", - OpportunityUpper: "OPPORTUNITY", - Recent: "RECENT", - Source: "SOURCE", - Ticket: "TICKET", - Transcript: "TRANSCRIPT", - With: "WITH" - }; - var Relation$inboundSchema = nativeEnumType(Relation); - var Relation$outboundSchema = Relation$inboundSchema; - var Relation$; - (function(Relation$2) { - Relation$2.inboundSchema = Relation$inboundSchema; - Relation$2.outboundSchema = Relation$outboundSchema; - })(Relation$ || (Relation$ = {})); - var RelatedDocuments$inboundSchema = objectType({ - relation: Relation$inboundSchema.optional(), - associatedEntityId: stringType().optional(), - querySuggestion: lazyType(() => QuerySuggestion$inboundSchema).optional(), - documents: arrayType(lazyType(() => Document$inboundSchema)).optional(), - results: arrayType(lazyType(() => SearchResult$inboundSchema)).optional() - }); - var RelatedDocuments$outboundSchema = objectType({ - relation: Relation$outboundSchema.optional(), - associatedEntityId: stringType().optional(), - querySuggestion: lazyType(() => QuerySuggestion$outboundSchema).optional(), - documents: arrayType(lazyType(() => Document$outboundSchema)).optional(), - results: arrayType(lazyType(() => SearchResult$outboundSchema)).optional() - }); - var RelatedDocuments$; - (function(RelatedDocuments$2) { - RelatedDocuments$2.inboundSchema = RelatedDocuments$inboundSchema; - RelatedDocuments$2.outboundSchema = RelatedDocuments$outboundSchema; - })(RelatedDocuments$ || (RelatedDocuments$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/person.js - var Person$inboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - relatedDocuments: arrayType(lazyType(() => RelatedDocuments$inboundSchema)).optional(), - metadata: lazyType(() => PersonMetadata$inboundSchema).optional() - }); - var Person$outboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - relatedDocuments: arrayType(lazyType(() => RelatedDocuments$outboundSchema)).optional(), - metadata: lazyType(() => PersonMetadata$outboundSchema).optional() - }); - var Person$; - (function(Person$2) { - Person$2.inboundSchema = Person$inboundSchema; - Person$2.outboundSchema = Person$outboundSchema; - })(Person$ || (Person$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/reaction.js - var Reaction$inboundSchema = objectType({ - type: stringType().optional(), - count: numberType().int().optional(), - reactors: arrayType(lazyType(() => Person$inboundSchema)).optional(), - reactedByViewer: booleanType().optional() - }); - var Reaction$outboundSchema = objectType({ - type: stringType().optional(), - count: numberType().int().optional(), - reactors: arrayType(lazyType(() => Person$outboundSchema)).optional(), - reactedByViewer: booleanType().optional() - }); - var Reaction$; - (function(Reaction$2) { - Reaction$2.inboundSchema = Reaction$inboundSchema; - Reaction$2.outboundSchema = Reaction$outboundSchema; - })(Reaction$ || (Reaction$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/share.js - var Share$inboundSchema = objectType({ - numDaysAgo: numberType().int(), - sharer: lazyType(() => Person$inboundSchema).optional(), - sharingDocument: lazyType(() => Document$inboundSchema).optional() - }); - var Share$outboundSchema = objectType({ - numDaysAgo: numberType().int(), - sharer: lazyType(() => Person$outboundSchema).optional(), - sharingDocument: lazyType(() => Document$outboundSchema).optional() - }); - var Share$; - (function(Share$2) { - Share$2.inboundSchema = Share$inboundSchema; - Share$2.outboundSchema = Share$outboundSchema; - })(Share$ || (Share$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentinteractions.js - var DocumentInteractions$inboundSchema = objectType({ - numComments: numberType().int().optional(), - numReactions: numberType().int().optional(), - reactions: arrayType(stringType()).optional(), - reacts: arrayType(lazyType(() => Reaction$inboundSchema)).optional(), - shares: arrayType(lazyType(() => Share$inboundSchema)).optional(), - visitorCount: CountInfo$inboundSchema.optional() - }); - var DocumentInteractions$outboundSchema = objectType({ - numComments: numberType().int().optional(), - numReactions: numberType().int().optional(), - reactions: arrayType(stringType()).optional(), - reacts: arrayType(lazyType(() => Reaction$outboundSchema)).optional(), - shares: arrayType(lazyType(() => Share$outboundSchema)).optional(), - visitorCount: CountInfo$outboundSchema.optional() - }); - var DocumentInteractions$; - (function(DocumentInteractions$2) { - DocumentInteractions$2.inboundSchema = DocumentInteractions$inboundSchema; - DocumentInteractions$2.outboundSchema = DocumentInteractions$outboundSchema; - })(DocumentInteractions$ || (DocumentInteractions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentvisibility.js - var DocumentVisibility = { - Private: "PRIVATE", - SpecificPeopleAndGroups: "SPECIFIC_PEOPLE_AND_GROUPS", - DomainLink: "DOMAIN_LINK", - DomainVisible: "DOMAIN_VISIBLE", - PublicLink: "PUBLIC_LINK", - PublicVisible: "PUBLIC_VISIBLE" - }; - var DocumentVisibility$inboundSchema = nativeEnumType(DocumentVisibility); - var DocumentVisibility$outboundSchema = DocumentVisibility$inboundSchema; - var DocumentVisibility$; - (function(DocumentVisibility$2) { - DocumentVisibility$2.inboundSchema = DocumentVisibility$inboundSchema; - DocumentVisibility$2.outboundSchema = DocumentVisibility$outboundSchema; - })(DocumentVisibility$ || (DocumentVisibility$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexstatus.js - var IndexStatus$inboundSchema = objectType({ - lastCrawledTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - lastIndexedTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var IndexStatus$outboundSchema = objectType({ - lastCrawledTime: dateType().transform((v) => v.toISOString()).optional(), - lastIndexedTime: dateType().transform((v) => v.toISOString()).optional() - }); - var IndexStatus$; - (function(IndexStatus$2) { - IndexStatus$2.inboundSchema = IndexStatus$inboundSchema; - IndexStatus$2.outboundSchema = IndexStatus$outboundSchema; - })(IndexStatus$ || (IndexStatus$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/thumbnail.js - var Thumbnail$inboundSchema = objectType({ - photoId: stringType().optional(), - url: stringType().optional() - }); - var Thumbnail$outboundSchema = objectType({ - photoId: stringType().optional(), - url: stringType().optional() - }); - var Thumbnail$; - (function(Thumbnail$2) { - Thumbnail$2.inboundSchema = Thumbnail$inboundSchema; - Thumbnail$2.outboundSchema = Thumbnail$outboundSchema; - })(Thumbnail$ || (Thumbnail$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/viewerinfo.js - var Role = { - AnswerModerator: "ANSWER_MODERATOR", - Owner: "OWNER", - Viewer: "VIEWER" - }; - var Role$inboundSchema = nativeEnumType(Role); - var Role$outboundSchema = Role$inboundSchema; - var Role$; - (function(Role$2) { - Role$2.inboundSchema = Role$inboundSchema; - Role$2.outboundSchema = Role$outboundSchema; - })(Role$ || (Role$ = {})); - var ViewerInfo$inboundSchema = objectType({ - role: Role$inboundSchema.optional(), - lastViewedTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }); - var ViewerInfo$outboundSchema = objectType({ - role: Role$outboundSchema.optional(), - lastViewedTime: dateType().transform((v) => v.toISOString()).optional() - }); - var ViewerInfo$; - (function(ViewerInfo$2) { - ViewerInfo$2.inboundSchema = ViewerInfo$inboundSchema; - ViewerInfo$2.outboundSchema = ViewerInfo$outboundSchema; - })(ViewerInfo$ || (ViewerInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentmetadata.js - var DocumentMetadata$inboundSchema = objectType({ - datasource: stringType().optional(), - datasourceInstance: stringType().optional(), - objectType: stringType().optional(), - container: stringType().optional(), - containerId: stringType().optional(), - superContainerId: stringType().optional(), - parentId: stringType().optional(), - mimeType: stringType().optional(), - documentId: stringType().optional(), - loggingId: stringType().optional(), - documentIdHash: stringType().optional(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - author: lazyType(() => Person$inboundSchema).optional(), - owner: lazyType(() => Person$inboundSchema).optional(), - mentionedPeople: arrayType(lazyType(() => Person$inboundSchema)).optional(), - visibility: DocumentVisibility$inboundSchema.optional(), - components: arrayType(stringType()).optional(), - status: stringType().optional(), - statusCategory: stringType().optional(), - pins: arrayType(lazyType(() => PinDocument$inboundSchema)).optional(), - priority: stringType().optional(), - assignedTo: lazyType(() => Person$inboundSchema).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - labels: arrayType(stringType()).optional(), - collections: arrayType(lazyType(() => Collection$inboundSchema)).optional(), - datasourceId: stringType().optional(), - interactions: lazyType(() => DocumentInteractions$inboundSchema).optional(), - verification: lazyType(() => Verification$inboundSchema).optional(), - viewerInfo: ViewerInfo$inboundSchema.optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - visitCount: CountInfo$inboundSchema.optional(), - shortcuts: arrayType(lazyType(() => Shortcut$inboundSchema)).optional(), - path: stringType().optional(), - customData: recordType(CustomDataValue$inboundSchema).optional(), - documentCategory: stringType().optional(), - contactPerson: lazyType(() => Person$inboundSchema).optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - indexStatus: IndexStatus$inboundSchema.optional(), - ancestors: arrayType(lazyType(() => Document$inboundSchema)).optional() - }); - var DocumentMetadata$outboundSchema = objectType({ - datasource: stringType().optional(), - datasourceInstance: stringType().optional(), - objectType: stringType().optional(), - container: stringType().optional(), - containerId: stringType().optional(), - superContainerId: stringType().optional(), - parentId: stringType().optional(), - mimeType: stringType().optional(), - documentId: stringType().optional(), - loggingId: stringType().optional(), - documentIdHash: stringType().optional(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - author: lazyType(() => Person$outboundSchema).optional(), - owner: lazyType(() => Person$outboundSchema).optional(), - mentionedPeople: arrayType(lazyType(() => Person$outboundSchema)).optional(), - visibility: DocumentVisibility$outboundSchema.optional(), - components: arrayType(stringType()).optional(), - status: stringType().optional(), - statusCategory: stringType().optional(), - pins: arrayType(lazyType(() => PinDocument$outboundSchema)).optional(), - priority: stringType().optional(), - assignedTo: lazyType(() => Person$outboundSchema).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - labels: arrayType(stringType()).optional(), - collections: arrayType(lazyType(() => Collection$outboundSchema)).optional(), - datasourceId: stringType().optional(), - interactions: lazyType(() => DocumentInteractions$outboundSchema).optional(), - verification: lazyType(() => Verification$outboundSchema).optional(), - viewerInfo: ViewerInfo$outboundSchema.optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - visitCount: CountInfo$outboundSchema.optional(), - shortcuts: arrayType(lazyType(() => Shortcut$outboundSchema)).optional(), - path: stringType().optional(), - customData: recordType(CustomDataValue$outboundSchema).optional(), - documentCategory: stringType().optional(), - contactPerson: lazyType(() => Person$outboundSchema).optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - indexStatus: IndexStatus$outboundSchema.optional(), - ancestors: arrayType(lazyType(() => Document$outboundSchema)).optional() - }); - var DocumentMetadata$; - (function(DocumentMetadata$2) { - DocumentMetadata$2.inboundSchema = DocumentMetadata$inboundSchema; - DocumentMetadata$2.outboundSchema = DocumentMetadata$outboundSchema; - })(DocumentMetadata$ || (DocumentMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentsection.js - var DocumentSection$inboundSchema = objectType({ - title: stringType().optional(), - url: stringType().optional() - }); - var DocumentSection$outboundSchema = objectType({ - title: stringType().optional(), - url: stringType().optional() - }); - var DocumentSection$; - (function(DocumentSection$2) { - DocumentSection$2.inboundSchema = DocumentSection$inboundSchema; - DocumentSection$2.outboundSchema = DocumentSection$outboundSchema; - })(DocumentSection$ || (DocumentSection$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/document.js - var Document$inboundSchema = objectType({ - id: stringType().optional(), - datasource: stringType().optional(), - connectorType: ConnectorType$inboundSchema.optional(), - docType: stringType().optional(), - content: DocumentContent$inboundSchema.optional(), - containerDocument: lazyType(() => Document$inboundSchema).optional(), - parentDocument: lazyType(() => Document$inboundSchema).optional(), - title: stringType().optional(), - url: stringType().optional(), - metadata: lazyType(() => DocumentMetadata$inboundSchema).optional(), - sections: arrayType(DocumentSection$inboundSchema).optional() - }); - var Document$outboundSchema = objectType({ - id: stringType().optional(), - datasource: stringType().optional(), - connectorType: ConnectorType$outboundSchema.optional(), - docType: stringType().optional(), - content: DocumentContent$outboundSchema.optional(), - containerDocument: lazyType(() => Document$outboundSchema).optional(), - parentDocument: lazyType(() => Document$outboundSchema).optional(), - title: stringType().optional(), - url: stringType().optional(), - metadata: lazyType(() => DocumentMetadata$outboundSchema).optional(), - sections: arrayType(DocumentSection$outboundSchema).optional() - }); - var Document$; - (function(Document$2) { - Document$2.inboundSchema = Document$inboundSchema; - Document$2.outboundSchema = Document$outboundSchema; - })(Document$ || (Document$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionitem.js - var CollectionItemItemType = { - Document: "DOCUMENT", - Text: "TEXT", - Url: "URL", - Collection: "COLLECTION" - }; - var CollectionItemItemType$inboundSchema = nativeEnumType(CollectionItemItemType); - var CollectionItemItemType$outboundSchema = CollectionItemItemType$inboundSchema; - var CollectionItemItemType$; - (function(CollectionItemItemType$2) { - CollectionItemItemType$2.inboundSchema = CollectionItemItemType$inboundSchema; - CollectionItemItemType$2.outboundSchema = CollectionItemItemType$outboundSchema; - })(CollectionItemItemType$ || (CollectionItemItemType$ = {})); - var CollectionItem$inboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - collectionId: numberType().int(), - documentId: stringType().optional(), - url: stringType().optional(), - itemId: stringType().optional(), - createdBy: lazyType(() => Person$inboundSchema).optional(), - createdAt: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - document: lazyType(() => Document$inboundSchema).optional(), - shortcut: lazyType(() => Shortcut$inboundSchema).optional(), - collection: lazyType(() => Collection$inboundSchema).optional(), - itemType: CollectionItemItemType$inboundSchema - }); - var CollectionItem$outboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - collectionId: numberType().int(), - documentId: stringType().optional(), - url: stringType().optional(), - itemId: stringType().optional(), - createdBy: lazyType(() => Person$outboundSchema).optional(), - createdAt: dateType().transform((v) => v.toISOString()).optional(), - document: lazyType(() => Document$outboundSchema).optional(), - shortcut: lazyType(() => Shortcut$outboundSchema).optional(), - collection: lazyType(() => Collection$outboundSchema).optional(), - itemType: CollectionItemItemType$outboundSchema - }); - var CollectionItem$; - (function(CollectionItem$2) { - CollectionItem$2.inboundSchema = CollectionItem$inboundSchema; - CollectionItem$2.outboundSchema = CollectionItem$outboundSchema; - })(CollectionItem$ || (CollectionItem$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionpinnablecategories.js - var CollectionPinnableCategories = { - CompanyResource: "COMPANY_RESOURCE", - DepartmentResource: "DEPARTMENT_RESOURCE", - TeamResource: "TEAM_RESOURCE" - }; - var CollectionPinnableCategories$inboundSchema = nativeEnumType(CollectionPinnableCategories); - var CollectionPinnableCategories$outboundSchema = CollectionPinnableCategories$inboundSchema; - var CollectionPinnableCategories$; - (function(CollectionPinnableCategories$2) { - CollectionPinnableCategories$2.inboundSchema = CollectionPinnableCategories$inboundSchema; - CollectionPinnableCategories$2.outboundSchema = CollectionPinnableCategories$outboundSchema; - })(CollectionPinnableCategories$ || (CollectionPinnableCategories$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionpinnabletargets.js - var CollectionPinnableTargets = { - ResourceCard: "RESOURCE_CARD", - TeamProfilePage: "TEAM_PROFILE_PAGE" - }; - var CollectionPinnableTargets$inboundSchema = nativeEnumType(CollectionPinnableTargets); - var CollectionPinnableTargets$outboundSchema = CollectionPinnableTargets$inboundSchema; - var CollectionPinnableTargets$; - (function(CollectionPinnableTargets$2) { - CollectionPinnableTargets$2.inboundSchema = CollectionPinnableTargets$inboundSchema; - CollectionPinnableTargets$2.outboundSchema = CollectionPinnableTargets$outboundSchema; - })(CollectionPinnableTargets$ || (CollectionPinnableTargets$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionpintarget.js - var CollectionPinTarget$inboundSchema = objectType({ - category: CollectionPinnableCategories$inboundSchema, - value: stringType().optional(), - target: CollectionPinnableTargets$inboundSchema.optional() - }); - var CollectionPinTarget$outboundSchema = objectType({ - category: CollectionPinnableCategories$outboundSchema, - value: stringType().optional(), - target: CollectionPinnableTargets$outboundSchema.optional() - }); - var CollectionPinTarget$; - (function(CollectionPinTarget$2) { - CollectionPinTarget$2.inboundSchema = CollectionPinTarget$inboundSchema; - CollectionPinTarget$2.outboundSchema = CollectionPinTarget$outboundSchema; - })(CollectionPinTarget$ || (CollectionPinTarget$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionpinmetadata.js - var CollectionPinMetadata$inboundSchema = objectType({ - id: numberType().int(), - target: CollectionPinTarget$inboundSchema - }); - var CollectionPinMetadata$outboundSchema = objectType({ - id: numberType().int(), - target: CollectionPinTarget$outboundSchema - }); - var CollectionPinMetadata$; - (function(CollectionPinMetadata$2) { - CollectionPinMetadata$2.inboundSchema = CollectionPinMetadata$inboundSchema; - CollectionPinMetadata$2.outboundSchema = CollectionPinMetadata$outboundSchema; - })(CollectionPinMetadata$ || (CollectionPinMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionpinnedmetadata.js - var CollectionPinnedMetadata$inboundSchema = objectType({ - existingPins: arrayType(CollectionPinTarget$inboundSchema).optional(), - eligiblePins: arrayType(CollectionPinMetadata$inboundSchema).optional() - }); - var CollectionPinnedMetadata$outboundSchema = objectType({ - existingPins: arrayType(CollectionPinTarget$outboundSchema).optional(), - eligiblePins: arrayType(CollectionPinMetadata$outboundSchema).optional() - }); - var CollectionPinnedMetadata$; - (function(CollectionPinnedMetadata$2) { - CollectionPinnedMetadata$2.inboundSchema = CollectionPinnedMetadata$inboundSchema; - CollectionPinnedMetadata$2.outboundSchema = CollectionPinnedMetadata$outboundSchema; - })(CollectionPinnedMetadata$ || (CollectionPinnedMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collection.js - var Collection$inboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - allowedDatasource: stringType().optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: numberType().int(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - creator: lazyType(() => Person$inboundSchema).optional(), - updatedBy: lazyType(() => Person$inboundSchema).optional(), - itemCount: numberType().int().optional(), - childCount: numberType().int().optional(), - items: arrayType(lazyType(() => CollectionItem$inboundSchema)).optional(), - pinMetadata: CollectionPinnedMetadata$inboundSchema.optional(), - shortcuts: arrayType(stringType()).optional(), - children: arrayType(lazyType(() => Collection$inboundSchema)).optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$inboundSchema)).optional() - }); - var Collection$outboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - removedRoles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - allowedDatasource: stringType().optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: numberType().int(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - creator: lazyType(() => Person$outboundSchema).optional(), - updatedBy: lazyType(() => Person$outboundSchema).optional(), - itemCount: numberType().int().optional(), - childCount: numberType().int().optional(), - items: arrayType(lazyType(() => CollectionItem$outboundSchema)).optional(), - pinMetadata: CollectionPinnedMetadata$outboundSchema.optional(), - shortcuts: arrayType(stringType()).optional(), - children: arrayType(lazyType(() => Collection$outboundSchema)).optional(), - roles: arrayType(lazyType(() => UserRoleSpecification$outboundSchema)).optional() - }); - var Collection$; - (function(Collection$2) { - Collection$2.inboundSchema = Collection$inboundSchema; - Collection$2.outboundSchema = Collection$outboundSchema; - })(Collection$ || (Collection$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/addcollectionitemsresponse.js - var AddCollectionItemsResponse$inboundSchema = objectType({ - collection: Collection$inboundSchema.optional(), - error: AddCollectionItemsError$inboundSchema.optional() - }); - var AddCollectionItemsResponse$outboundSchema = objectType({ - collection: Collection$outboundSchema.optional(), - error: AddCollectionItemsError$outboundSchema.optional() - }); - var AddCollectionItemsResponse$; - (function(AddCollectionItemsResponse$2) { - AddCollectionItemsResponse$2.inboundSchema = AddCollectionItemsResponse$inboundSchema; - AddCollectionItemsResponse$2.outboundSchema = AddCollectionItemsResponse$outboundSchema; - })(AddCollectionItemsResponse$ || (AddCollectionItemsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/additionalfielddefinition.js - var Value$inboundSchema = objectType({}); - var Value$outboundSchema = objectType({}); - var Value$; - (function(Value$2) { - Value$2.inboundSchema = Value$inboundSchema; - Value$2.outboundSchema = Value$outboundSchema; - })(Value$ || (Value$ = {})); - var AdditionalFieldDefinition$inboundSchema = objectType({ - key: stringType().optional(), - value: arrayType(lazyType(() => Value$inboundSchema)).optional() - }); - var AdditionalFieldDefinition$outboundSchema = objectType({ - key: stringType().optional(), - value: arrayType(lazyType(() => Value$outboundSchema)).optional() - }); - var AdditionalFieldDefinition$; - (function(AdditionalFieldDefinition$2) { - AdditionalFieldDefinition$2.inboundSchema = AdditionalFieldDefinition$inboundSchema; - AdditionalFieldDefinition$2.outboundSchema = AdditionalFieldDefinition$outboundSchema; - })(AdditionalFieldDefinition$ || (AdditionalFieldDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agent.js - var AgentMetadata$inboundSchema = objectType({}); - var AgentMetadata$outboundSchema = objectType({}); - var AgentMetadata$; - (function(AgentMetadata$2) { - AgentMetadata$2.inboundSchema = AgentMetadata$inboundSchema; - AgentMetadata$2.outboundSchema = AgentMetadata$outboundSchema; - })(AgentMetadata$ || (AgentMetadata$ = {})); - var AgentCapabilities$inboundSchema = collectExtraKeys(objectType({ - "ap.io.messages": booleanType().optional(), - "ap.io.streaming": booleanType().optional() - }).catchall(anyType()), "additionalProperties", true).transform((v) => { - return remap(v, { - "ap.io.messages": "apIoMessages", - "ap.io.streaming": "apIoStreaming" - }); - }); - var AgentCapabilities$outboundSchema = objectType({ - apIoMessages: booleanType().optional(), - apIoStreaming: booleanType().optional(), - additionalProperties: recordType(anyType()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...remap(v, { - apIoMessages: "ap.io.messages", - apIoStreaming: "ap.io.streaming", - additionalProperties: null - }) - }; - }); - var AgentCapabilities$; - (function(AgentCapabilities$2) { - AgentCapabilities$2.inboundSchema = AgentCapabilities$inboundSchema; - AgentCapabilities$2.outboundSchema = AgentCapabilities$outboundSchema; - })(AgentCapabilities$ || (AgentCapabilities$ = {})); - var Agent$inboundSchema = objectType({ - agent_id: stringType(), - name: stringType(), - description: stringType().optional(), - metadata: lazyType(() => AgentMetadata$inboundSchema).optional(), - capabilities: lazyType(() => AgentCapabilities$inboundSchema) - }).transform((v) => { - return remap(v, { - "agent_id": "agentId" - }); - }); - var Agent$outboundSchema = objectType({ - agentId: stringType(), - name: stringType(), - description: stringType().optional(), - metadata: lazyType(() => AgentMetadata$outboundSchema).optional(), - capabilities: lazyType(() => AgentCapabilities$outboundSchema) - }).transform((v) => { - return remap(v, { - agentId: "agent_id" - }); - }); - var Agent$; - (function(Agent$2) { - Agent$2.inboundSchema = Agent$inboundSchema; - Agent$2.outboundSchema = Agent$outboundSchema; - })(Agent$ || (Agent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolsets.js - var ToolSets$inboundSchema = objectType({ - enableWebSearch: booleanType().optional(), - enableCompanyTools: booleanType().optional() - }); - var ToolSets$outboundSchema = objectType({ - enableWebSearch: booleanType().optional(), - enableCompanyTools: booleanType().optional() - }); - var ToolSets$; - (function(ToolSets$2) { - ToolSets$2.inboundSchema = ToolSets$inboundSchema; - ToolSets$2.outboundSchema = ToolSets$outboundSchema; - })(ToolSets$ || (ToolSets$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentconfig.js - var AgentEnum = { - Default: "DEFAULT", - Gpt: "GPT", - Universal: "UNIVERSAL", - Fast: "FAST", - Advanced: "ADVANCED" - }; - var Mode = { - Default: "DEFAULT", - Quick: "QUICK" - }; - var AgentEnum$inboundSchema = nativeEnumType(AgentEnum); - var AgentEnum$outboundSchema = AgentEnum$inboundSchema; - var AgentEnum$; - (function(AgentEnum$2) { - AgentEnum$2.inboundSchema = AgentEnum$inboundSchema; - AgentEnum$2.outboundSchema = AgentEnum$outboundSchema; - })(AgentEnum$ || (AgentEnum$ = {})); - var Mode$inboundSchema = nativeEnumType(Mode); - var Mode$outboundSchema = Mode$inboundSchema; - var Mode$; - (function(Mode$2) { - Mode$2.inboundSchema = Mode$inboundSchema; - Mode$2.outboundSchema = Mode$outboundSchema; - })(Mode$ || (Mode$ = {})); - var AgentConfig$inboundSchema = objectType({ - agent: AgentEnum$inboundSchema.optional(), - toolSets: ToolSets$inboundSchema.optional(), - mode: Mode$inboundSchema.optional() - }); - var AgentConfig$outboundSchema = objectType({ - agent: AgentEnum$outboundSchema.optional(), - toolSets: ToolSets$outboundSchema.optional(), - mode: Mode$outboundSchema.optional() - }); - var AgentConfig$; - (function(AgentConfig$2) { - AgentConfig$2.inboundSchema = AgentConfig$inboundSchema; - AgentConfig$2.outboundSchema = AgentConfig$outboundSchema; - })(AgentConfig$ || (AgentConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentexecutionstatus.js - var AgentExecutionStatus = { - Error: "error", - Success: "success" - }; - var AgentExecutionStatus$inboundSchema = nativeEnumType(AgentExecutionStatus); - var AgentExecutionStatus$outboundSchema = AgentExecutionStatus$inboundSchema; - var AgentExecutionStatus$; - (function(AgentExecutionStatus$2) { - AgentExecutionStatus$2.inboundSchema = AgentExecutionStatus$inboundSchema; - AgentExecutionStatus$2.outboundSchema = AgentExecutionStatus$outboundSchema; - })(AgentExecutionStatus$ || (AgentExecutionStatus$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/contenttype.js - var ContentType = { - Text: "text" - }; - var ContentType$inboundSchema = nativeEnumType(ContentType); - var ContentType$outboundSchema = ContentType$inboundSchema; - var ContentType$; - (function(ContentType$2) { - ContentType$2.inboundSchema = ContentType$inboundSchema; - ContentType$2.outboundSchema = ContentType$outboundSchema; - })(ContentType$ || (ContentType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/message.js - var MessageTextBlock$inboundSchema = objectType({ - text: stringType(), - type: ContentType$inboundSchema - }); - var MessageTextBlock$outboundSchema = objectType({ - text: stringType(), - type: ContentType$outboundSchema - }); - var MessageTextBlock$; - (function(MessageTextBlock$2) { - MessageTextBlock$2.inboundSchema = MessageTextBlock$inboundSchema; - MessageTextBlock$2.outboundSchema = MessageTextBlock$outboundSchema; - })(MessageTextBlock$ || (MessageTextBlock$ = {})); - var Message$inboundSchema = objectType({ - role: stringType().optional(), - content: arrayType(lazyType(() => MessageTextBlock$inboundSchema)).optional() - }); - var Message$outboundSchema = objectType({ - role: stringType().optional(), - content: arrayType(lazyType(() => MessageTextBlock$outboundSchema)).optional() - }); - var Message$; - (function(Message$2) { - Message$2.inboundSchema = Message$inboundSchema; - Message$2.outboundSchema = Message$outboundSchema; - })(Message$ || (Message$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentrun.js - var AgentRun$inboundSchema = objectType({ - agent_id: stringType(), - input: recordType(anyType()).optional(), - messages: arrayType(Message$inboundSchema).optional(), - metadata: recordType(anyType()).optional(), - status: AgentExecutionStatus$inboundSchema.optional() - }).transform((v) => { - return remap(v, { - "agent_id": "agentId" - }); - }); - var AgentRun$outboundSchema = objectType({ - agentId: stringType(), - input: recordType(anyType()).optional(), - messages: arrayType(Message$outboundSchema).optional(), - metadata: recordType(anyType()).optional(), - status: AgentExecutionStatus$outboundSchema.optional() - }).transform((v) => { - return remap(v, { - agentId: "agent_id" - }); - }); - var AgentRun$; - (function(AgentRun$2) { - AgentRun$2.inboundSchema = AgentRun$inboundSchema; - AgentRun$2.outboundSchema = AgentRun$outboundSchema; - })(AgentRun$ || (AgentRun$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentruncreate.js - var AgentRunCreate$inboundSchema = objectType({ - agent_id: stringType(), - input: recordType(anyType()).optional(), - messages: arrayType(Message$inboundSchema).optional(), - metadata: recordType(anyType()).optional() - }).transform((v) => { - return remap(v, { - "agent_id": "agentId" - }); - }); - var AgentRunCreate$outboundSchema = objectType({ - agentId: stringType(), - input: recordType(anyType()).optional(), - messages: arrayType(Message$outboundSchema).optional(), - metadata: recordType(anyType()).optional() - }).transform((v) => { - return remap(v, { - agentId: "agent_id" - }); - }); - var AgentRunCreate$; - (function(AgentRunCreate$2) { - AgentRunCreate$2.inboundSchema = AgentRunCreate$inboundSchema; - AgentRunCreate$2.outboundSchema = AgentRunCreate$outboundSchema; - })(AgentRunCreate$ || (AgentRunCreate$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentrunwaitresponse.js - var AgentRunWaitResponse$inboundSchema = objectType({ - run: AgentRun$inboundSchema.optional(), - messages: arrayType(Message$inboundSchema).optional() - }); - var AgentRunWaitResponse$outboundSchema = objectType({ - run: AgentRun$outboundSchema.optional(), - messages: arrayType(Message$outboundSchema).optional() - }); - var AgentRunWaitResponse$; - (function(AgentRunWaitResponse$2) { - AgentRunWaitResponse$2.inboundSchema = AgentRunWaitResponse$inboundSchema; - AgentRunWaitResponse$2.outboundSchema = AgentRunWaitResponse$outboundSchema; - })(AgentRunWaitResponse$ || (AgentRunWaitResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentschemas.js - var InputSchema$inboundSchema = objectType({}); - var InputSchema$outboundSchema = objectType({}); - var InputSchema$; - (function(InputSchema$2) { - InputSchema$2.inboundSchema = InputSchema$inboundSchema; - InputSchema$2.outboundSchema = InputSchema$outboundSchema; - })(InputSchema$ || (InputSchema$ = {})); - var OutputSchema$inboundSchema = objectType({}); - var OutputSchema$outboundSchema = objectType({}); - var OutputSchema$; - (function(OutputSchema$2) { - OutputSchema$2.inboundSchema = OutputSchema$inboundSchema; - OutputSchema$2.outboundSchema = OutputSchema$outboundSchema; - })(OutputSchema$ || (OutputSchema$ = {})); - var AgentSchemas$inboundSchema = objectType({ - agent_id: stringType(), - input_schema: lazyType(() => InputSchema$inboundSchema), - output_schema: lazyType(() => OutputSchema$inboundSchema) - }).transform((v) => { - return remap(v, { - "agent_id": "agentId", - "input_schema": "inputSchema", - "output_schema": "outputSchema" - }); - }); - var AgentSchemas$outboundSchema = objectType({ - agentId: stringType(), - inputSchema: lazyType(() => InputSchema$outboundSchema), - outputSchema: lazyType(() => OutputSchema$outboundSchema) - }).transform((v) => { - return remap(v, { - agentId: "agent_id", - inputSchema: "input_schema", - outputSchema: "output_schema" - }); - }); - var AgentSchemas$; - (function(AgentSchemas$2) { - AgentSchemas$2.inboundSchema = AgentSchemas$inboundSchema; - AgentSchemas$2.outboundSchema = AgentSchemas$outboundSchema; - })(AgentSchemas$ || (AgentSchemas$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/agentsinsightsv2request.js - var AgentsInsightsV2Request$inboundSchema = objectType({ - agentIds: arrayType(stringType()).optional(), - departments: arrayType(stringType()).optional(), - dayRange: Period$inboundSchema.optional() - }); - var AgentsInsightsV2Request$outboundSchema = objectType({ - agentIds: arrayType(stringType()).optional(), - departments: arrayType(stringType()).optional(), - dayRange: Period$outboundSchema.optional() - }); - var AgentsInsightsV2Request$; - (function(AgentsInsightsV2Request$2) { - AgentsInsightsV2Request$2.inboundSchema = AgentsInsightsV2Request$inboundSchema; - AgentsInsightsV2Request$2.outboundSchema = AgentsInsightsV2Request$outboundSchema; - })(AgentsInsightsV2Request$ || (AgentsInsightsV2Request$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/aiappactioncounts.js - var AiAppActionCounts$inboundSchema = collectExtraKeys(objectType({ - totalSlackbotResponses: numberType().int().optional(), - totalSlackbotResponsesShared: numberType().int().optional(), - totalSlackbotResponsesNotHelpful: numberType().int().optional(), - totalChatMessages: numberType().int().optional(), - totalUpvotes: numberType().int().optional(), - totalDownvotes: numberType().int().optional() - }).catchall(numberType().int()), "additionalProperties", true); - var AiAppActionCounts$outboundSchema = objectType({ - totalSlackbotResponses: numberType().int().optional(), - totalSlackbotResponsesShared: numberType().int().optional(), - totalSlackbotResponsesNotHelpful: numberType().int().optional(), - totalChatMessages: numberType().int().optional(), - totalUpvotes: numberType().int().optional(), - totalDownvotes: numberType().int().optional(), - additionalProperties: recordType(numberType().int()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...remap(v, { - additionalProperties: null - }) - }; - }); - var AiAppActionCounts$; - (function(AiAppActionCounts$2) { - AiAppActionCounts$2.inboundSchema = AiAppActionCounts$inboundSchema; - AiAppActionCounts$2.outboundSchema = AiAppActionCounts$outboundSchema; - })(AiAppActionCounts$ || (AiAppActionCounts$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/useractivityinsight.js - var ActivityEnum = { - All: "ALL", - Search: "SEARCH" - }; - var ActivityEnum$inboundSchema = nativeEnumType(ActivityEnum); - var ActivityEnum$outboundSchema = ActivityEnum$inboundSchema; - var ActivityEnum$; - (function(ActivityEnum$2) { - ActivityEnum$2.inboundSchema = ActivityEnum$inboundSchema; - ActivityEnum$2.outboundSchema = ActivityEnum$outboundSchema; - })(ActivityEnum$ || (ActivityEnum$ = {})); - var UserActivityInsight$inboundSchema = objectType({ - user: Person$inboundSchema, - activity: ActivityEnum$inboundSchema, - lastActivityTimestamp: numberType().int().optional(), - activityCount: CountInfo$inboundSchema.optional(), - activeDayCount: CountInfo$inboundSchema.optional() - }); - var UserActivityInsight$outboundSchema = objectType({ - user: Person$outboundSchema, - activity: ActivityEnum$outboundSchema, - lastActivityTimestamp: numberType().int().optional(), - activityCount: CountInfo$outboundSchema.optional(), - activeDayCount: CountInfo$outboundSchema.optional() - }); - var UserActivityInsight$; - (function(UserActivityInsight$2) { - UserActivityInsight$2.inboundSchema = UserActivityInsight$inboundSchema; - UserActivityInsight$2.outboundSchema = UserActivityInsight$outboundSchema; - })(UserActivityInsight$ || (UserActivityInsight$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/aiappsinsightsresponse.js - var AiAppsInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - aiAppInsights: arrayType(UserActivityInsight$inboundSchema).optional(), - totalActiveUsers: numberType().int().optional(), - actionCounts: AiAppActionCounts$inboundSchema.optional(), - departments: arrayType(stringType()).optional() - }); - var AiAppsInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - aiAppInsights: arrayType(UserActivityInsight$outboundSchema).optional(), - totalActiveUsers: numberType().int().optional(), - actionCounts: AiAppActionCounts$outboundSchema.optional(), - departments: arrayType(stringType()).optional() - }); - var AiAppsInsightsResponse$; - (function(AiAppsInsightsResponse$2) { - AiAppsInsightsResponse$2.inboundSchema = AiAppsInsightsResponse$inboundSchema; - AiAppsInsightsResponse$2.outboundSchema = AiAppsInsightsResponse$outboundSchema; - })(AiAppsInsightsResponse$ || (AiAppsInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/aiinsightsresponse.js - var AiInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - assistantInsights: arrayType(UserActivityInsight$inboundSchema).optional(), - totalActiveAssistantUsers: numberType().int().optional(), - totalChatMessages: numberType().int().optional(), - totalAiSummarizations: numberType().int().optional(), - totalAiAnswers: numberType().int().optional(), - totalUpvotes: numberType().int().optional(), - totalDownvotes: numberType().int().optional(), - totalGleanbotResponses: numberType().int().optional(), - totalGleanbotResponsesShared: numberType().int().optional(), - totalGleanbotResponsesNotHelpful: numberType().int().optional(), - departments: arrayType(stringType()).optional() - }); - var AiInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - assistantInsights: arrayType(UserActivityInsight$outboundSchema).optional(), - totalActiveAssistantUsers: numberType().int().optional(), - totalChatMessages: numberType().int().optional(), - totalAiSummarizations: numberType().int().optional(), - totalAiAnswers: numberType().int().optional(), - totalUpvotes: numberType().int().optional(), - totalDownvotes: numberType().int().optional(), - totalGleanbotResponses: numberType().int().optional(), - totalGleanbotResponsesShared: numberType().int().optional(), - totalGleanbotResponsesNotHelpful: numberType().int().optional(), - departments: arrayType(stringType()).optional() - }); - var AiInsightsResponse$; - (function(AiInsightsResponse$2) { - AiInsightsResponse$2.inboundSchema = AiInsightsResponse$inboundSchema; - AiInsightsResponse$2.outboundSchema = AiInsightsResponse$outboundSchema; - })(AiInsightsResponse$ || (AiInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/allowlistoptions.js - var AllowlistOptions$inboundSchema = objectType({ - terms: arrayType(stringType()).optional() - }); - var AllowlistOptions$outboundSchema = objectType({ - terms: arrayType(stringType()).optional() - }); - var AllowlistOptions$; - (function(AllowlistOptions$2) { - AllowlistOptions$2.inboundSchema = AllowlistOptions$inboundSchema; - AllowlistOptions$2.outboundSchema = AllowlistOptions$outboundSchema; - })(AllowlistOptions$ || (AllowlistOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/announcement.js - var AnnouncementChannel = { - Main: "MAIN", - SocialFeed: "SOCIAL_FEED" - }; - var AnnouncementPostType = { - Text: "TEXT", - Link: "LINK" - }; - var AnnouncementChannel$inboundSchema = nativeEnumType(AnnouncementChannel); - var AnnouncementChannel$outboundSchema = AnnouncementChannel$inboundSchema; - var AnnouncementChannel$; - (function(AnnouncementChannel$2) { - AnnouncementChannel$2.inboundSchema = AnnouncementChannel$inboundSchema; - AnnouncementChannel$2.outboundSchema = AnnouncementChannel$outboundSchema; - })(AnnouncementChannel$ || (AnnouncementChannel$ = {})); - var AnnouncementPostType$inboundSchema = nativeEnumType(AnnouncementPostType); - var AnnouncementPostType$outboundSchema = AnnouncementPostType$inboundSchema; - var AnnouncementPostType$; - (function(AnnouncementPostType$2) { - AnnouncementPostType$2.inboundSchema = AnnouncementPostType$inboundSchema; - AnnouncementPostType$2.outboundSchema = AnnouncementPostType$outboundSchema; - })(AnnouncementPostType$ || (AnnouncementPostType$ = {})); - var AnnouncementViewerInfo$inboundSchema = objectType({ - isDismissed: booleanType().optional(), - isRead: booleanType().optional() - }); - var AnnouncementViewerInfo$outboundSchema = objectType({ - isDismissed: booleanType().optional(), - isRead: booleanType().optional() - }); - var AnnouncementViewerInfo$; - (function(AnnouncementViewerInfo$2) { - AnnouncementViewerInfo$2.inboundSchema = AnnouncementViewerInfo$inboundSchema; - AnnouncementViewerInfo$2.outboundSchema = AnnouncementViewerInfo$outboundSchema; - })(AnnouncementViewerInfo$ || (AnnouncementViewerInfo$ = {})); - var Announcement$inboundSchema = objectType({ - startTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - endTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - title: stringType().optional(), - body: StructuredText$inboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - banner: Thumbnail$inboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: AnnouncementChannel$inboundSchema.optional(), - postType: AnnouncementPostType$inboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional(), - draftId: numberType().int().optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: numberType().int().optional(), - author: Person$inboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - updatedBy: Person$inboundSchema.optional(), - viewerInfo: lazyType(() => AnnouncementViewerInfo$inboundSchema).optional(), - sourceDocument: Document$inboundSchema.optional(), - isPublished: booleanType().optional() - }); - var Announcement$outboundSchema = objectType({ - startTime: dateType().transform((v) => v.toISOString()).optional(), - endTime: dateType().transform((v) => v.toISOString()).optional(), - title: stringType().optional(), - body: StructuredText$outboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - banner: Thumbnail$outboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: AnnouncementChannel$outboundSchema.optional(), - postType: AnnouncementPostType$outboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional(), - draftId: numberType().int().optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: numberType().int().optional(), - author: Person$outboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - updatedBy: Person$outboundSchema.optional(), - viewerInfo: lazyType(() => AnnouncementViewerInfo$outboundSchema).optional(), - sourceDocument: Document$outboundSchema.optional(), - isPublished: booleanType().optional() - }); - var Announcement$; - (function(Announcement$2) { - Announcement$2.inboundSchema = Announcement$inboundSchema; - Announcement$2.outboundSchema = Announcement$outboundSchema; - })(Announcement$ || (Announcement$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredtextmutableproperties.js - var StructuredTextMutableProperties$inboundSchema = objectType({ - text: stringType() - }); - var StructuredTextMutableProperties$outboundSchema = objectType({ - text: stringType() - }); - var StructuredTextMutableProperties$; - (function(StructuredTextMutableProperties$2) { - StructuredTextMutableProperties$2.inboundSchema = StructuredTextMutableProperties$inboundSchema; - StructuredTextMutableProperties$2.outboundSchema = StructuredTextMutableProperties$outboundSchema; - })(StructuredTextMutableProperties$ || (StructuredTextMutableProperties$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answercreationdata.js - var AnswerCreationDataSourceType = { - Document: "DOCUMENT", - Assistant: "ASSISTANT" - }; - var AnswerCreationDataSourceType$inboundSchema = nativeEnumType(AnswerCreationDataSourceType); - var AnswerCreationDataSourceType$outboundSchema = AnswerCreationDataSourceType$inboundSchema; - var AnswerCreationDataSourceType$; - (function(AnswerCreationDataSourceType$2) { - AnswerCreationDataSourceType$2.inboundSchema = AnswerCreationDataSourceType$inboundSchema; - AnswerCreationDataSourceType$2.outboundSchema = AnswerCreationDataSourceType$outboundSchema; - })(AnswerCreationDataSourceType$ || (AnswerCreationDataSourceType$ = {})); - var AnswerCreationData$inboundSchema = objectType({ - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - roles: arrayType(UserRoleSpecification$inboundSchema).optional(), - sourceDocumentSpec: DocumentSpecUnion$inboundSchema.optional(), - sourceType: AnswerCreationDataSourceType$inboundSchema.optional(), - addedCollections: arrayType(numberType().int()).optional(), - combinedAnswerText: StructuredTextMutableProperties$inboundSchema.optional() - }); - var AnswerCreationData$outboundSchema = objectType({ - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - roles: arrayType(UserRoleSpecification$outboundSchema).optional(), - sourceDocumentSpec: DocumentSpecUnion$outboundSchema.optional(), - sourceType: AnswerCreationDataSourceType$outboundSchema.optional(), - addedCollections: arrayType(numberType().int()).optional(), - combinedAnswerText: StructuredTextMutableProperties$outboundSchema.optional() - }); - var AnswerCreationData$; - (function(AnswerCreationData$2) { - AnswerCreationData$2.inboundSchema = AnswerCreationData$inboundSchema; - AnswerCreationData$2.outboundSchema = AnswerCreationData$outboundSchema; - })(AnswerCreationData$ || (AnswerCreationData$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/answerresult.js - var AnswerResult$inboundSchema = objectType({ - answer: Answer$inboundSchema, - trackingToken: stringType().optional() - }); - var AnswerResult$outboundSchema = objectType({ - answer: Answer$outboundSchema, - trackingToken: stringType().optional() - }); - var AnswerResult$; - (function(AnswerResult$2) { - AnswerResult$2.inboundSchema = AnswerResult$inboundSchema; - AnswerResult$2.outboundSchema = AnswerResult$outboundSchema; - })(AnswerResult$ || (AnswerResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/authconfig.js - var AuthConfigType = { - None: "NONE", - OauthUser: "OAUTH_USER", - OauthAdmin: "OAUTH_ADMIN", - ApiKey: "API_KEY", - BasicAuth: "BASIC_AUTH", - Dwd: "DWD" - }; - var GrantType = { - AuthCode: "AUTH_CODE", - ClientCredentials: "CLIENT_CREDENTIALS" - }; - var AuthConfigStatus = { - AwaitingAuth: "AWAITING_AUTH", - Authorized: "AUTHORIZED", - AuthDisabled: "AUTH_DISABLED" - }; - var AuthConfigType$inboundSchema = nativeEnumType(AuthConfigType); - var AuthConfigType$outboundSchema = AuthConfigType$inboundSchema; - var AuthConfigType$; - (function(AuthConfigType$2) { - AuthConfigType$2.inboundSchema = AuthConfigType$inboundSchema; - AuthConfigType$2.outboundSchema = AuthConfigType$outboundSchema; - })(AuthConfigType$ || (AuthConfigType$ = {})); - var GrantType$inboundSchema = nativeEnumType(GrantType); - var GrantType$outboundSchema = GrantType$inboundSchema; - var GrantType$; - (function(GrantType$2) { - GrantType$2.inboundSchema = GrantType$inboundSchema; - GrantType$2.outboundSchema = GrantType$outboundSchema; - })(GrantType$ || (GrantType$ = {})); - var AuthConfigStatus$inboundSchema = nativeEnumType(AuthConfigStatus); - var AuthConfigStatus$outboundSchema = AuthConfigStatus$inboundSchema; - var AuthConfigStatus$; - (function(AuthConfigStatus$2) { - AuthConfigStatus$2.inboundSchema = AuthConfigStatus$inboundSchema; - AuthConfigStatus$2.outboundSchema = AuthConfigStatus$outboundSchema; - })(AuthConfigStatus$ || (AuthConfigStatus$ = {})); - var AuthConfig$inboundSchema = objectType({ - isOnPrem: booleanType().optional(), - usesCentralAuth: booleanType().optional(), - type: AuthConfigType$inboundSchema.optional(), - grantType: GrantType$inboundSchema.optional(), - status: AuthConfigStatus$inboundSchema.optional(), - client_url: stringType().optional(), - scopes: arrayType(stringType()).optional(), - audiences: arrayType(stringType()).optional(), - authorization_url: stringType().optional(), - lastAuthorizedAt: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional() - }).transform((v) => { - return remap(v, { - "client_url": "clientUrl", - "authorization_url": "authorizationUrl" - }); - }); - var AuthConfig$outboundSchema = objectType({ - isOnPrem: booleanType().optional(), - usesCentralAuth: booleanType().optional(), - type: AuthConfigType$outboundSchema.optional(), - grantType: GrantType$outboundSchema.optional(), - status: AuthConfigStatus$outboundSchema.optional(), - clientUrl: stringType().optional(), - scopes: arrayType(stringType()).optional(), - audiences: arrayType(stringType()).optional(), - authorizationUrl: stringType().optional(), - lastAuthorizedAt: dateType().transform((v) => v.toISOString()).optional() - }).transform((v) => { - return remap(v, { - clientUrl: "client_url", - authorizationUrl: "authorization_url" - }); - }); - var AuthConfig$; - (function(AuthConfig$2) { - AuthConfig$2.inboundSchema = AuthConfig$inboundSchema; - AuthConfig$2.outboundSchema = AuthConfig$outboundSchema; - })(AuthConfig$ || (AuthConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sessioninfo.js - var SessionInfo$inboundSchema = objectType({ - sessionTrackingToken: stringType().optional(), - tabId: stringType().optional(), - lastSeen: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - lastQuery: stringType().optional() - }); - var SessionInfo$outboundSchema = objectType({ - sessionTrackingToken: stringType().optional(), - tabId: stringType().optional(), - lastSeen: dateType().transform((v) => v.toISOString()).optional(), - lastQuery: stringType().optional() - }); - var SessionInfo$; - (function(SessionInfo$2) { - SessionInfo$2.inboundSchema = SessionInfo$inboundSchema; - SessionInfo$2.outboundSchema = SessionInfo$outboundSchema; - })(SessionInfo$ || (SessionInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/autocompleterequest.js - var AutocompleteRequestResultType = { - AdditionalDocument: "ADDITIONAL_DOCUMENT", - App: "APP", - BrowserHistory: "BROWSER_HISTORY", - Datasource: "DATASOURCE", - Document: "DOCUMENT", - Entity: "ENTITY", - Golink: "GOLINK", - History: "HISTORY", - NewChat: "NEW_CHAT", - Operator: "OPERATOR", - OperatorValue: "OPERATOR_VALUE", - Quicklink: "QUICKLINK", - Suggestion: "SUGGESTION" - }; - var AutocompleteRequestResultType$inboundSchema = nativeEnumType(AutocompleteRequestResultType); - var AutocompleteRequestResultType$outboundSchema = AutocompleteRequestResultType$inboundSchema; - var AutocompleteRequestResultType$; - (function(AutocompleteRequestResultType$2) { - AutocompleteRequestResultType$2.inboundSchema = AutocompleteRequestResultType$inboundSchema; - AutocompleteRequestResultType$2.outboundSchema = AutocompleteRequestResultType$outboundSchema; - })(AutocompleteRequestResultType$ || (AutocompleteRequestResultType$ = {})); - var AutocompleteRequest$inboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - query: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - datasource: stringType().optional(), - resultTypes: arrayType(AutocompleteRequestResultType$inboundSchema).optional(), - resultSize: numberType().int().optional(), - authTokens: arrayType(AuthToken$inboundSchema).optional() - }); - var AutocompleteRequest$outboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - query: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - datasource: stringType().optional(), - resultTypes: arrayType(AutocompleteRequestResultType$outboundSchema).optional(), - resultSize: numberType().int().optional(), - authTokens: arrayType(AuthToken$outboundSchema).optional() - }); - var AutocompleteRequest$; - (function(AutocompleteRequest$2) { - AutocompleteRequest$2.inboundSchema = AutocompleteRequest$inboundSchema; - AutocompleteRequest$2.outboundSchema = AutocompleteRequest$outboundSchema; - })(AutocompleteRequest$ || (AutocompleteRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/operatorscope.js - var OperatorScope$inboundSchema = objectType({ - datasource: stringType().optional(), - docType: stringType().optional() - }); - var OperatorScope$outboundSchema = objectType({ - datasource: stringType().optional(), - docType: stringType().optional() - }); - var OperatorScope$; - (function(OperatorScope$2) { - OperatorScope$2.inboundSchema = OperatorScope$inboundSchema; - OperatorScope$2.outboundSchema = OperatorScope$outboundSchema; - })(OperatorScope$ || (OperatorScope$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/operatormetadata.js - var OperatorType = { - Text: "TEXT", - Double: "DOUBLE", - Date: "DATE", - User: "USER" - }; - var OperatorType$inboundSchema = nativeEnumType(OperatorType); - var OperatorType$outboundSchema = OperatorType$inboundSchema; - var OperatorType$; - (function(OperatorType$2) { - OperatorType$2.inboundSchema = OperatorType$inboundSchema; - OperatorType$2.outboundSchema = OperatorType$outboundSchema; - })(OperatorType$ || (OperatorType$ = {})); - var OperatorMetadata$inboundSchema = objectType({ - name: stringType(), - isCustom: booleanType().optional(), - operatorType: OperatorType$inboundSchema.optional(), - helpText: stringType().optional(), - scopes: arrayType(OperatorScope$inboundSchema).optional(), - value: stringType().optional(), - displayValue: stringType().optional() - }); - var OperatorMetadata$outboundSchema = objectType({ - name: stringType(), - isCustom: booleanType().optional(), - operatorType: OperatorType$outboundSchema.optional(), - helpText: stringType().optional(), - scopes: arrayType(OperatorScope$outboundSchema).optional(), - value: stringType().optional(), - displayValue: stringType().optional() - }); - var OperatorMetadata$; - (function(OperatorMetadata$2) { - OperatorMetadata$2.inboundSchema = OperatorMetadata$inboundSchema; - OperatorMetadata$2.outboundSchema = OperatorMetadata$outboundSchema; - })(OperatorMetadata$ || (OperatorMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/quicklink.js - var Scope = { - AppCard: "APP_CARD", - AutocompleteExactMatch: "AUTOCOMPLETE_EXACT_MATCH", - AutocompleteFuzzyMatch: "AUTOCOMPLETE_FUZZY_MATCH", - AutocompleteZeroQuery: "AUTOCOMPLETE_ZERO_QUERY", - NewTabPage: "NEW_TAB_PAGE" - }; - var Scope$inboundSchema = nativeEnumType(Scope); - var Scope$outboundSchema = Scope$inboundSchema; - var Scope$; - (function(Scope$2) { - Scope$2.inboundSchema = Scope$inboundSchema; - Scope$2.outboundSchema = Scope$outboundSchema; - })(Scope$ || (Scope$ = {})); - var Quicklink$inboundSchema = objectType({ - name: stringType().optional(), - shortName: stringType().optional(), - url: stringType().optional(), - iconConfig: IconConfig$inboundSchema.optional(), - id: stringType().optional(), - scopes: arrayType(Scope$inboundSchema).optional() - }); - var Quicklink$outboundSchema = objectType({ - name: stringType().optional(), - shortName: stringType().optional(), - url: stringType().optional(), - iconConfig: IconConfig$outboundSchema.optional(), - id: stringType().optional(), - scopes: arrayType(Scope$outboundSchema).optional() - }); - var Quicklink$; - (function(Quicklink$2) { - Quicklink$2.inboundSchema = Quicklink$inboundSchema; - Quicklink$2.outboundSchema = Quicklink$outboundSchema; - })(Quicklink$ || (Quicklink$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/autocompleteresult.js - var AutocompleteResultResultType = { - AdditionalDocument: "ADDITIONAL_DOCUMENT", - App: "APP", - BrowserHistory: "BROWSER_HISTORY", - Datasource: "DATASOURCE", - Document: "DOCUMENT", - Entity: "ENTITY", - Golink: "GOLINK", - History: "HISTORY", - NewChat: "NEW_CHAT", - Operator: "OPERATOR", - OperatorValue: "OPERATOR_VALUE", - Quicklink: "QUICKLINK", - Suggestion: "SUGGESTION" - }; - var AutocompleteResultResultType$inboundSchema = nativeEnumType(AutocompleteResultResultType); - var AutocompleteResultResultType$outboundSchema = AutocompleteResultResultType$inboundSchema; - var AutocompleteResultResultType$; - (function(AutocompleteResultResultType$2) { - AutocompleteResultResultType$2.inboundSchema = AutocompleteResultResultType$inboundSchema; - AutocompleteResultResultType$2.outboundSchema = AutocompleteResultResultType$outboundSchema; - })(AutocompleteResultResultType$ || (AutocompleteResultResultType$ = {})); - var AutocompleteResult$inboundSchema = objectType({ - result: stringType(), - keywords: arrayType(stringType()).optional(), - resultType: AutocompleteResultResultType$inboundSchema.optional(), - score: numberType().optional(), - operatorMetadata: OperatorMetadata$inboundSchema.optional(), - quicklink: Quicklink$inboundSchema.optional(), - document: Document$inboundSchema.optional(), - url: stringType().optional(), - structuredResult: StructuredResult$inboundSchema.optional(), - trackingToken: stringType().optional(), - ranges: arrayType(TextRange$inboundSchema).optional() - }); - var AutocompleteResult$outboundSchema = objectType({ - result: stringType(), - keywords: arrayType(stringType()).optional(), - resultType: AutocompleteResultResultType$outboundSchema.optional(), - score: numberType().optional(), - operatorMetadata: OperatorMetadata$outboundSchema.optional(), - quicklink: Quicklink$outboundSchema.optional(), - document: Document$outboundSchema.optional(), - url: stringType().optional(), - structuredResult: StructuredResult$outboundSchema.optional(), - trackingToken: stringType().optional(), - ranges: arrayType(TextRange$outboundSchema).optional() - }); - var AutocompleteResult$; - (function(AutocompleteResult$2) { - AutocompleteResult$2.inboundSchema = AutocompleteResult$inboundSchema; - AutocompleteResult$2.outboundSchema = AutocompleteResult$outboundSchema; - })(AutocompleteResult$ || (AutocompleteResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/autocompleteresultgroup.js - var AutocompleteResultGroup$inboundSchema = objectType({ - startIndex: numberType().int().optional(), - endIndex: numberType().int().optional(), - title: stringType().optional() - }); - var AutocompleteResultGroup$outboundSchema = objectType({ - startIndex: numberType().int().optional(), - endIndex: numberType().int().optional(), - title: stringType().optional() - }); - var AutocompleteResultGroup$; - (function(AutocompleteResultGroup$2) { - AutocompleteResultGroup$2.inboundSchema = AutocompleteResultGroup$inboundSchema; - AutocompleteResultGroup$2.outboundSchema = AutocompleteResultGroup$outboundSchema; - })(AutocompleteResultGroup$ || (AutocompleteResultGroup$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/errormessage.js - var ErrorMessage$inboundSchema = objectType({ - source: stringType().optional(), - errorMessage: stringType().optional() - }); - var ErrorMessage$outboundSchema = objectType({ - source: stringType().optional(), - errorMessage: stringType().optional() - }); - var ErrorMessage$; - (function(ErrorMessage$2) { - ErrorMessage$2.inboundSchema = ErrorMessage$inboundSchema; - ErrorMessage$2.outboundSchema = ErrorMessage$outboundSchema; - })(ErrorMessage$ || (ErrorMessage$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/invalidoperatorvalueerror.js - var InvalidOperatorValueError$inboundSchema = objectType({ - key: stringType().optional(), - value: stringType().optional() - }); - var InvalidOperatorValueError$outboundSchema = objectType({ - key: stringType().optional(), - value: stringType().optional() - }); - var InvalidOperatorValueError$; - (function(InvalidOperatorValueError$2) { - InvalidOperatorValueError$2.inboundSchema = InvalidOperatorValueError$inboundSchema; - InvalidOperatorValueError$2.outboundSchema = InvalidOperatorValueError$outboundSchema; - })(InvalidOperatorValueError$ || (InvalidOperatorValueError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/gleandataerror.js - var GleanDataError$inboundSchema = objectType({ - badGmailToken: booleanType().optional(), - badOutlookToken: booleanType().optional(), - invalidOperators: arrayType(InvalidOperatorValueError$inboundSchema).optional(), - errorMessages: arrayType(ErrorMessage$inboundSchema).optional() - }); - var GleanDataError$outboundSchema = objectType({ - badGmailToken: booleanType().optional(), - badOutlookToken: booleanType().optional(), - invalidOperators: arrayType(InvalidOperatorValueError$outboundSchema).optional(), - errorMessages: arrayType(ErrorMessage$outboundSchema).optional() - }); - var GleanDataError$; - (function(GleanDataError$3) { - GleanDataError$3.inboundSchema = GleanDataError$inboundSchema; - GleanDataError$3.outboundSchema = GleanDataError$outboundSchema; - })(GleanDataError$ || (GleanDataError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/autocompleteresponse.js - var AutocompleteResponse$inboundSchema = objectType({ - experimentIds: arrayType(numberType().int()).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - results: arrayType(AutocompleteResult$inboundSchema).optional(), - groups: arrayType(AutocompleteResultGroup$inboundSchema).optional(), - errorInfo: GleanDataError$inboundSchema.optional(), - backendTimeMillis: numberType().int().optional() - }).transform((v) => { - return remap(v, { - "errorInfo": "gleanDataError" - }); - }); - var AutocompleteResponse$outboundSchema = objectType({ - experimentIds: arrayType(numberType().int()).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - results: arrayType(AutocompleteResult$outboundSchema).optional(), - groups: arrayType(AutocompleteResultGroup$outboundSchema).optional(), - gleanDataError: GleanDataError$outboundSchema.optional(), - backendTimeMillis: numberType().int().optional() - }).transform((v) => { - return remap(v, { - gleanDataError: "errorInfo" - }); - }); - var AutocompleteResponse$; - (function(AutocompleteResponse$2) { - AutocompleteResponse$2.inboundSchema = AutocompleteResponse$inboundSchema; - AutocompleteResponse$2.outboundSchema = AutocompleteResponse$outboundSchema; - })(AutocompleteResponse$ || (AutocompleteResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/contentdefinition.js - var ContentDefinition$inboundSchema = objectType({ - mimeType: stringType(), - textContent: stringType().optional(), - binaryContent: stringType().optional() - }); - var ContentDefinition$outboundSchema = objectType({ - mimeType: stringType(), - textContent: stringType().optional(), - binaryContent: stringType().optional() - }); - var ContentDefinition$; - (function(ContentDefinition$2) { - ContentDefinition$2.inboundSchema = ContentDefinition$inboundSchema; - ContentDefinition$2.outboundSchema = ContentDefinition$outboundSchema; - })(ContentDefinition$ || (ContentDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userreferencedefinition.js - var UserReferenceDefinition$inboundSchema = objectType({ - email: stringType().optional(), - datasourceUserId: stringType().optional(), - name: stringType().optional() - }); - var UserReferenceDefinition$outboundSchema = objectType({ - email: stringType().optional(), - datasourceUserId: stringType().optional(), - name: stringType().optional() - }); - var UserReferenceDefinition$; - (function(UserReferenceDefinition$2) { - UserReferenceDefinition$2.inboundSchema = UserReferenceDefinition$inboundSchema; - UserReferenceDefinition$2.outboundSchema = UserReferenceDefinition$outboundSchema; - })(UserReferenceDefinition$ || (UserReferenceDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/commentdefinition.js - var CommentDefinition$inboundSchema = objectType({ - id: stringType(), - author: UserReferenceDefinition$inboundSchema.optional(), - content: ContentDefinition$inboundSchema.optional(), - createdAt: numberType().int().optional(), - updatedAt: numberType().int().optional(), - updatedBy: UserReferenceDefinition$inboundSchema.optional() - }); - var CommentDefinition$outboundSchema = objectType({ - id: stringType(), - author: UserReferenceDefinition$outboundSchema.optional(), - content: ContentDefinition$outboundSchema.optional(), - createdAt: numberType().int().optional(), - updatedAt: numberType().int().optional(), - updatedBy: UserReferenceDefinition$outboundSchema.optional() - }); - var CommentDefinition$; - (function(CommentDefinition$2) { - CommentDefinition$2.inboundSchema = CommentDefinition$inboundSchema; - CommentDefinition$2.outboundSchema = CommentDefinition$outboundSchema; - })(CommentDefinition$ || (CommentDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customproperty.js - var CustomProperty$inboundSchema = objectType({ - name: stringType().optional(), - value: anyType().optional() - }); - var CustomProperty$outboundSchema = objectType({ - name: stringType().optional(), - value: anyType().optional() - }); - var CustomProperty$; - (function(CustomProperty$2) { - CustomProperty$2.inboundSchema = CustomProperty$inboundSchema; - CustomProperty$2.outboundSchema = CustomProperty$outboundSchema; - })(CustomProperty$ || (CustomProperty$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentinteractionsdefinition.js - var DocumentInteractionsDefinition$inboundSchema = objectType({ - numViews: numberType().int().optional(), - numLikes: numberType().int().optional(), - numComments: numberType().int().optional() - }); - var DocumentInteractionsDefinition$outboundSchema = objectType({ - numViews: numberType().int().optional(), - numLikes: numberType().int().optional(), - numComments: numberType().int().optional() - }); - var DocumentInteractionsDefinition$; - (function(DocumentInteractionsDefinition$2) { - DocumentInteractionsDefinition$2.inboundSchema = DocumentInteractionsDefinition$inboundSchema; - DocumentInteractionsDefinition$2.outboundSchema = DocumentInteractionsDefinition$outboundSchema; - })(DocumentInteractionsDefinition$ || (DocumentInteractionsDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/permissionsgroupintersectiondefinition.js - var PermissionsGroupIntersectionDefinition$inboundSchema = objectType({ - requiredGroups: arrayType(stringType()).optional() - }); - var PermissionsGroupIntersectionDefinition$outboundSchema = objectType({ - requiredGroups: arrayType(stringType()).optional() - }); - var PermissionsGroupIntersectionDefinition$; - (function(PermissionsGroupIntersectionDefinition$2) { - PermissionsGroupIntersectionDefinition$2.inboundSchema = PermissionsGroupIntersectionDefinition$inboundSchema; - PermissionsGroupIntersectionDefinition$2.outboundSchema = PermissionsGroupIntersectionDefinition$outboundSchema; - })(PermissionsGroupIntersectionDefinition$ || (PermissionsGroupIntersectionDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentpermissionsdefinition.js - var DocumentPermissionsDefinition$inboundSchema = objectType({ - allowedUsers: arrayType(UserReferenceDefinition$inboundSchema).optional(), - allowedGroups: arrayType(stringType()).optional(), - allowedGroupIntersections: arrayType(PermissionsGroupIntersectionDefinition$inboundSchema).optional(), - allowAnonymousAccess: booleanType().optional(), - allowAllDatasourceUsersAccess: booleanType().optional() - }); - var DocumentPermissionsDefinition$outboundSchema = objectType({ - allowedUsers: arrayType(UserReferenceDefinition$outboundSchema).optional(), - allowedGroups: arrayType(stringType()).optional(), - allowedGroupIntersections: arrayType(PermissionsGroupIntersectionDefinition$outboundSchema).optional(), - allowAnonymousAccess: booleanType().optional(), - allowAllDatasourceUsersAccess: booleanType().optional() - }); - var DocumentPermissionsDefinition$; - (function(DocumentPermissionsDefinition$2) { - DocumentPermissionsDefinition$2.inboundSchema = DocumentPermissionsDefinition$inboundSchema; - DocumentPermissionsDefinition$2.outboundSchema = DocumentPermissionsDefinition$outboundSchema; - })(DocumentPermissionsDefinition$ || (DocumentPermissionsDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentdefinition.js - var DocumentDefinition$inboundSchema = objectType({ - title: stringType().optional(), - filename: stringType().optional(), - container: stringType().optional(), - containerDatasourceId: stringType().optional(), - containerObjectType: stringType().optional(), - datasource: stringType(), - objectType: stringType().optional(), - viewURL: stringType().optional(), - id: stringType().optional(), - summary: ContentDefinition$inboundSchema.optional(), - body: ContentDefinition$inboundSchema.optional(), - author: UserReferenceDefinition$inboundSchema.optional(), - owner: UserReferenceDefinition$inboundSchema.optional(), - permissions: DocumentPermissionsDefinition$inboundSchema.optional(), - createdAt: numberType().int().optional(), - updatedAt: numberType().int().optional(), - updatedBy: UserReferenceDefinition$inboundSchema.optional(), - tags: arrayType(stringType()).optional(), - interactions: DocumentInteractionsDefinition$inboundSchema.optional(), - status: stringType().optional(), - additionalUrls: arrayType(stringType()).optional(), - comments: arrayType(CommentDefinition$inboundSchema).optional(), - customProperties: arrayType(CustomProperty$inboundSchema).optional() - }); - var DocumentDefinition$outboundSchema = objectType({ - title: stringType().optional(), - filename: stringType().optional(), - container: stringType().optional(), - containerDatasourceId: stringType().optional(), - containerObjectType: stringType().optional(), - datasource: stringType(), - objectType: stringType().optional(), - viewURL: stringType().optional(), - id: stringType().optional(), - summary: ContentDefinition$outboundSchema.optional(), - body: ContentDefinition$outboundSchema.optional(), - author: UserReferenceDefinition$outboundSchema.optional(), - owner: UserReferenceDefinition$outboundSchema.optional(), - permissions: DocumentPermissionsDefinition$outboundSchema.optional(), - createdAt: numberType().int().optional(), - updatedAt: numberType().int().optional(), - updatedBy: UserReferenceDefinition$outboundSchema.optional(), - tags: arrayType(stringType()).optional(), - interactions: DocumentInteractionsDefinition$outboundSchema.optional(), - status: stringType().optional(), - additionalUrls: arrayType(stringType()).optional(), - comments: arrayType(CommentDefinition$outboundSchema).optional(), - customProperties: arrayType(CustomProperty$outboundSchema).optional() - }); - var DocumentDefinition$; - (function(DocumentDefinition$2) { - DocumentDefinition$2.inboundSchema = DocumentDefinition$inboundSchema; - DocumentDefinition$2.outboundSchema = DocumentDefinition$outboundSchema; - })(DocumentDefinition$ || (DocumentDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexdocumentsrequest.js - var BulkIndexDocumentsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - documents: arrayType(DocumentDefinition$inboundSchema), - disableStaleDocumentDeletionCheck: booleanType().optional() - }); - var BulkIndexDocumentsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - documents: arrayType(DocumentDefinition$outboundSchema), - disableStaleDocumentDeletionCheck: booleanType().optional() - }); - var BulkIndexDocumentsRequest$; - (function(BulkIndexDocumentsRequest$2) { - BulkIndexDocumentsRequest$2.inboundSchema = BulkIndexDocumentsRequest$inboundSchema; - BulkIndexDocumentsRequest$2.outboundSchema = BulkIndexDocumentsRequest$outboundSchema; - })(BulkIndexDocumentsRequest$ || (BulkIndexDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/employeeteaminfo.js - var EmployeeTeamInfo$inboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - url: stringType().optional() - }); - var EmployeeTeamInfo$outboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - url: stringType().optional() - }); - var EmployeeTeamInfo$; - (function(EmployeeTeamInfo$2) { - EmployeeTeamInfo$2.inboundSchema = EmployeeTeamInfo$inboundSchema; - EmployeeTeamInfo$2.outboundSchema = EmployeeTeamInfo$outboundSchema; - })(EmployeeTeamInfo$ || (EmployeeTeamInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/entityrelationship.js - var EntityRelationship$inboundSchema = objectType({ - name: stringType(), - email: stringType() - }); - var EntityRelationship$outboundSchema = objectType({ - name: stringType(), - email: stringType() - }); - var EntityRelationship$; - (function(EntityRelationship$2) { - EntityRelationship$2.inboundSchema = EntityRelationship$inboundSchema; - EntityRelationship$2.outboundSchema = EntityRelationship$outboundSchema; - })(EntityRelationship$ || (EntityRelationship$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/socialnetworkdefinition.js - var SocialNetworkDefinition$inboundSchema = objectType({ - name: stringType().optional(), - profileName: stringType().optional(), - profileUrl: stringType().optional() - }); - var SocialNetworkDefinition$outboundSchema = objectType({ - name: stringType().optional(), - profileName: stringType().optional(), - profileUrl: stringType().optional() - }); - var SocialNetworkDefinition$; - (function(SocialNetworkDefinition$2) { - SocialNetworkDefinition$2.inboundSchema = SocialNetworkDefinition$inboundSchema; - SocialNetworkDefinition$2.outboundSchema = SocialNetworkDefinition$outboundSchema; - })(SocialNetworkDefinition$ || (SocialNetworkDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/employeeinfodefinition.js - var EmployeeInfoDefinition$inboundSchema = objectType({ - email: stringType(), - firstName: stringType().optional(), - lastName: stringType().optional(), - preferredName: stringType().optional(), - id: stringType().optional(), - phoneNumber: stringType().optional(), - location: stringType().optional(), - structuredLocation: StructuredLocation$inboundSchema.optional(), - title: stringType().optional(), - photoUrl: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType(), - datasourceProfiles: arrayType(DatasourceProfile$inboundSchema).optional(), - teams: arrayType(EmployeeTeamInfo$inboundSchema).optional(), - startDate: stringType().transform((v) => new RFCDate(v)).optional(), - endDate: stringType().transform((v) => new RFCDate(v)).optional(), - bio: stringType().optional(), - pronoun: stringType().optional(), - alsoKnownAs: arrayType(stringType()).optional(), - profileUrl: stringType().optional(), - socialNetworks: arrayType(SocialNetworkDefinition$inboundSchema).optional(), - managerEmail: stringType().optional(), - managerId: stringType().optional(), - type: stringType().default("FULL_TIME"), - relationships: arrayType(EntityRelationship$inboundSchema).optional(), - status: stringType().default("CURRENT"), - additionalFields: arrayType(AdditionalFieldDefinition$inboundSchema).optional() - }); - var EmployeeInfoDefinition$outboundSchema = objectType({ - email: stringType(), - firstName: stringType().optional(), - lastName: stringType().optional(), - preferredName: stringType().optional(), - id: stringType().optional(), - phoneNumber: stringType().optional(), - location: stringType().optional(), - structuredLocation: StructuredLocation$outboundSchema.optional(), - title: stringType().optional(), - photoUrl: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType(), - datasourceProfiles: arrayType(DatasourceProfile$outboundSchema).optional(), - teams: arrayType(EmployeeTeamInfo$outboundSchema).optional(), - startDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - endDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional(), - bio: stringType().optional(), - pronoun: stringType().optional(), - alsoKnownAs: arrayType(stringType()).optional(), - profileUrl: stringType().optional(), - socialNetworks: arrayType(SocialNetworkDefinition$outboundSchema).optional(), - managerEmail: stringType().optional(), - managerId: stringType().optional(), - type: stringType().default("FULL_TIME"), - relationships: arrayType(EntityRelationship$outboundSchema).optional(), - status: stringType().default("CURRENT"), - additionalFields: arrayType(AdditionalFieldDefinition$outboundSchema).optional() - }); - var EmployeeInfoDefinition$; - (function(EmployeeInfoDefinition$2) { - EmployeeInfoDefinition$2.inboundSchema = EmployeeInfoDefinition$inboundSchema; - EmployeeInfoDefinition$2.outboundSchema = EmployeeInfoDefinition$outboundSchema; - })(EmployeeInfoDefinition$ || (EmployeeInfoDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexemployeesrequest.js - var BulkIndexEmployeesRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - employees: arrayType(EmployeeInfoDefinition$inboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexEmployeesRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - employees: arrayType(EmployeeInfoDefinition$outboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexEmployeesRequest$; - (function(BulkIndexEmployeesRequest$2) { - BulkIndexEmployeesRequest$2.inboundSchema = BulkIndexEmployeesRequest$inboundSchema; - BulkIndexEmployeesRequest$2.outboundSchema = BulkIndexEmployeesRequest$outboundSchema; - })(BulkIndexEmployeesRequest$ || (BulkIndexEmployeesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourcegroupdefinition.js - var DatasourceGroupDefinition$inboundSchema = objectType({ - name: stringType() - }); - var DatasourceGroupDefinition$outboundSchema = objectType({ - name: stringType() - }); - var DatasourceGroupDefinition$; - (function(DatasourceGroupDefinition$2) { - DatasourceGroupDefinition$2.inboundSchema = DatasourceGroupDefinition$inboundSchema; - DatasourceGroupDefinition$2.outboundSchema = DatasourceGroupDefinition$outboundSchema; - })(DatasourceGroupDefinition$ || (DatasourceGroupDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexgroupsrequest.js - var BulkIndexGroupsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - groups: arrayType(DatasourceGroupDefinition$inboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexGroupsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - groups: arrayType(DatasourceGroupDefinition$outboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexGroupsRequest$; - (function(BulkIndexGroupsRequest$2) { - BulkIndexGroupsRequest$2.inboundSchema = BulkIndexGroupsRequest$inboundSchema; - BulkIndexGroupsRequest$2.outboundSchema = BulkIndexGroupsRequest$outboundSchema; - })(BulkIndexGroupsRequest$ || (BulkIndexGroupsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourcebulkmembershipdefinition.js - var DatasourceBulkMembershipDefinition$inboundSchema = objectType({ - memberUserId: stringType().optional(), - memberGroupName: stringType().optional() - }); - var DatasourceBulkMembershipDefinition$outboundSchema = objectType({ - memberUserId: stringType().optional(), - memberGroupName: stringType().optional() - }); - var DatasourceBulkMembershipDefinition$; - (function(DatasourceBulkMembershipDefinition$2) { - DatasourceBulkMembershipDefinition$2.inboundSchema = DatasourceBulkMembershipDefinition$inboundSchema; - DatasourceBulkMembershipDefinition$2.outboundSchema = DatasourceBulkMembershipDefinition$outboundSchema; - })(DatasourceBulkMembershipDefinition$ || (DatasourceBulkMembershipDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexmembershipsrequest.js - var BulkIndexMembershipsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - group: stringType().optional(), - memberships: arrayType(DatasourceBulkMembershipDefinition$inboundSchema) - }); - var BulkIndexMembershipsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - group: stringType().optional(), - memberships: arrayType(DatasourceBulkMembershipDefinition$outboundSchema) - }); - var BulkIndexMembershipsRequest$; - (function(BulkIndexMembershipsRequest$2) { - BulkIndexMembershipsRequest$2.inboundSchema = BulkIndexMembershipsRequest$inboundSchema; - BulkIndexMembershipsRequest$2.outboundSchema = BulkIndexMembershipsRequest$outboundSchema; - })(BulkIndexMembershipsRequest$ || (BulkIndexMembershipsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/externalshortcut.js - var ExternalShortcut$inboundSchema = objectType({ - inputAlias: stringType(), - description: stringType().optional(), - destinationUrl: stringType(), - createdBy: stringType(), - createTime: numberType().int().optional(), - updatedBy: stringType().optional(), - updateTime: numberType().int().optional(), - title: stringType().optional(), - intermediateUrl: stringType(), - decayedVisitScore: numberType().optional(), - editUrl: stringType().optional() - }); - var ExternalShortcut$outboundSchema = objectType({ - inputAlias: stringType(), - description: stringType().optional(), - destinationUrl: stringType(), - createdBy: stringType(), - createTime: numberType().int().optional(), - updatedBy: stringType().optional(), - updateTime: numberType().int().optional(), - title: stringType().optional(), - intermediateUrl: stringType(), - decayedVisitScore: numberType().optional(), - editUrl: stringType().optional() - }); - var ExternalShortcut$; - (function(ExternalShortcut$2) { - ExternalShortcut$2.inboundSchema = ExternalShortcut$inboundSchema; - ExternalShortcut$2.outboundSchema = ExternalShortcut$outboundSchema; - })(ExternalShortcut$ || (ExternalShortcut$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexshortcutsrequest.js - var BulkIndexShortcutsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - shortcuts: arrayType(ExternalShortcut$inboundSchema) - }); - var BulkIndexShortcutsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - shortcuts: arrayType(ExternalShortcut$outboundSchema) - }); - var BulkIndexShortcutsRequest$; - (function(BulkIndexShortcutsRequest$2) { - BulkIndexShortcutsRequest$2.inboundSchema = BulkIndexShortcutsRequest$inboundSchema; - BulkIndexShortcutsRequest$2.outboundSchema = BulkIndexShortcutsRequest$outboundSchema; - })(BulkIndexShortcutsRequest$ || (BulkIndexShortcutsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/teammember.js - var TeamMember$inboundSchema = objectType({ - email: stringType(), - relationship: stringType().default("MEMBER"), - join_date: stringType().transform((v) => new RFCDate(v)).optional() - }).transform((v) => { - return remap(v, { - "join_date": "joinDate" - }); - }); - var TeamMember$outboundSchema = objectType({ - email: stringType(), - relationship: stringType().default("MEMBER"), - joinDate: instanceOfType(RFCDate).transform((v) => v.toString()).optional() - }).transform((v) => { - return remap(v, { - joinDate: "join_date" - }); - }); - var TeamMember$; - (function(TeamMember$2) { - TeamMember$2.inboundSchema = TeamMember$inboundSchema; - TeamMember$2.outboundSchema = TeamMember$outboundSchema; - })(TeamMember$ || (TeamMember$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/teaminfodefinition.js - var TeamInfoDefinition$inboundSchema = objectType({ - id: stringType(), - name: stringType(), - description: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - photoUrl: stringType().optional(), - externalLink: stringType().optional(), - emails: arrayType(TeamEmail$inboundSchema).optional(), - datasourceProfiles: arrayType(DatasourceProfile$inboundSchema).optional(), - members: arrayType(TeamMember$inboundSchema), - additionalFields: arrayType(AdditionalFieldDefinition$inboundSchema).optional() - }); - var TeamInfoDefinition$outboundSchema = objectType({ - id: stringType(), - name: stringType(), - description: stringType().optional(), - businessUnit: stringType().optional(), - department: stringType().optional(), - photoUrl: stringType().optional(), - externalLink: stringType().optional(), - emails: arrayType(TeamEmail$outboundSchema).optional(), - datasourceProfiles: arrayType(DatasourceProfile$outboundSchema).optional(), - members: arrayType(TeamMember$outboundSchema), - additionalFields: arrayType(AdditionalFieldDefinition$outboundSchema).optional() - }); - var TeamInfoDefinition$; - (function(TeamInfoDefinition$2) { - TeamInfoDefinition$2.inboundSchema = TeamInfoDefinition$inboundSchema; - TeamInfoDefinition$2.outboundSchema = TeamInfoDefinition$outboundSchema; - })(TeamInfoDefinition$ || (TeamInfoDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexteamsrequest.js - var BulkIndexTeamsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - teams: arrayType(TeamInfoDefinition$inboundSchema) - }); - var BulkIndexTeamsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - teams: arrayType(TeamInfoDefinition$outboundSchema) - }); - var BulkIndexTeamsRequest$; - (function(BulkIndexTeamsRequest$2) { - BulkIndexTeamsRequest$2.inboundSchema = BulkIndexTeamsRequest$inboundSchema; - BulkIndexTeamsRequest$2.outboundSchema = BulkIndexTeamsRequest$outboundSchema; - })(BulkIndexTeamsRequest$ || (BulkIndexTeamsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourceuserdefinition.js - var DatasourceUserDefinition$inboundSchema = objectType({ - email: stringType(), - userId: stringType().optional(), - name: stringType(), - isActive: booleanType().optional() - }); - var DatasourceUserDefinition$outboundSchema = objectType({ - email: stringType(), - userId: stringType().optional(), - name: stringType(), - isActive: booleanType().optional() - }); - var DatasourceUserDefinition$; - (function(DatasourceUserDefinition$2) { - DatasourceUserDefinition$2.inboundSchema = DatasourceUserDefinition$inboundSchema; - DatasourceUserDefinition$2.outboundSchema = DatasourceUserDefinition$outboundSchema; - })(DatasourceUserDefinition$ || (DatasourceUserDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkindexusersrequest.js - var BulkIndexUsersRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - users: arrayType(DatasourceUserDefinition$inboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexUsersRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - datasource: stringType(), - users: arrayType(DatasourceUserDefinition$outboundSchema), - disableStaleDataDeletionCheck: booleanType().optional() - }); - var BulkIndexUsersRequest$; - (function(BulkIndexUsersRequest$2) { - BulkIndexUsersRequest$2.inboundSchema = BulkIndexUsersRequest$inboundSchema; - BulkIndexUsersRequest$2.outboundSchema = BulkIndexUsersRequest$outboundSchema; - })(BulkIndexUsersRequest$ || (BulkIndexUsersRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/bulkuploadhistoryevent.js - var BulkUploadHistoryEventStatus = { - Active: "ACTIVE", - Successful: "SUCCESSFUL" - }; - var ProcessingState = { - Unavailable: "UNAVAILABLE", - UploadStarted: "UPLOAD STARTED", - UploadInProgress: "UPLOAD IN PROGRESS", - UploadCompleted: "UPLOAD COMPLETED", - DeletionPaused: "DELETION PAUSED", - IndexingCompleted: "INDEXING COMPLETED" - }; - var BulkUploadHistoryEventStatus$inboundSchema = nativeEnumType(BulkUploadHistoryEventStatus); - var BulkUploadHistoryEventStatus$outboundSchema = BulkUploadHistoryEventStatus$inboundSchema; - var BulkUploadHistoryEventStatus$; - (function(BulkUploadHistoryEventStatus$2) { - BulkUploadHistoryEventStatus$2.inboundSchema = BulkUploadHistoryEventStatus$inboundSchema; - BulkUploadHistoryEventStatus$2.outboundSchema = BulkUploadHistoryEventStatus$outboundSchema; - })(BulkUploadHistoryEventStatus$ || (BulkUploadHistoryEventStatus$ = {})); - var ProcessingState$inboundSchema = nativeEnumType(ProcessingState); - var ProcessingState$outboundSchema = ProcessingState$inboundSchema; - var ProcessingState$; - (function(ProcessingState$2) { - ProcessingState$2.inboundSchema = ProcessingState$inboundSchema; - ProcessingState$2.outboundSchema = ProcessingState$outboundSchema; - })(ProcessingState$ || (ProcessingState$ = {})); - var BulkUploadHistoryEvent$inboundSchema = objectType({ - uploadId: stringType().optional(), - startTime: stringType().optional(), - endTime: stringType().optional(), - status: BulkUploadHistoryEventStatus$inboundSchema.optional(), - processingState: ProcessingState$inboundSchema.optional() - }); - var BulkUploadHistoryEvent$outboundSchema = objectType({ - uploadId: stringType().optional(), - startTime: stringType().optional(), - endTime: stringType().optional(), - status: BulkUploadHistoryEventStatus$outboundSchema.optional(), - processingState: ProcessingState$outboundSchema.optional() - }); - var BulkUploadHistoryEvent$; - (function(BulkUploadHistoryEvent$2) { - BulkUploadHistoryEvent$2.inboundSchema = BulkUploadHistoryEvent$inboundSchema; - BulkUploadHistoryEvent$2.outboundSchema = BulkUploadHistoryEvent$outboundSchema; - })(BulkUploadHistoryEvent$ || (BulkUploadHistoryEvent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/conferencedata.js - var Provider = { - Zoom: "ZOOM", - Hangouts: "HANGOUTS" - }; - var ConferenceDataSource = { - NativeConference: "NATIVE_CONFERENCE", - Location: "LOCATION", - Description: "DESCRIPTION" - }; - var Provider$inboundSchema = nativeEnumType(Provider); - var Provider$outboundSchema = Provider$inboundSchema; - var Provider$; - (function(Provider$2) { - Provider$2.inboundSchema = Provider$inboundSchema; - Provider$2.outboundSchema = Provider$outboundSchema; - })(Provider$ || (Provider$ = {})); - var ConferenceDataSource$inboundSchema = nativeEnumType(ConferenceDataSource); - var ConferenceDataSource$outboundSchema = ConferenceDataSource$inboundSchema; - var ConferenceDataSource$; - (function(ConferenceDataSource$2) { - ConferenceDataSource$2.inboundSchema = ConferenceDataSource$inboundSchema; - ConferenceDataSource$2.outboundSchema = ConferenceDataSource$outboundSchema; - })(ConferenceDataSource$ || (ConferenceDataSource$ = {})); - var ConferenceData$inboundSchema = objectType({ - provider: Provider$inboundSchema, - uri: stringType(), - source: ConferenceDataSource$inboundSchema.optional() - }); - var ConferenceData$outboundSchema = objectType({ - provider: Provider$outboundSchema, - uri: stringType(), - source: ConferenceDataSource$outboundSchema.optional() - }); - var ConferenceData$; - (function(ConferenceData$2) { - ConferenceData$2.inboundSchema = ConferenceData$inboundSchema; - ConferenceData$2.outboundSchema = ConferenceData$outboundSchema; - })(ConferenceData$ || (ConferenceData$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/eventclassificationname.js - var EventClassificationName = { - ExternalEvent: "External Event" - }; - var EventClassificationName$inboundSchema = nativeEnumType(EventClassificationName); - var EventClassificationName$outboundSchema = EventClassificationName$inboundSchema; - var EventClassificationName$; - (function(EventClassificationName$2) { - EventClassificationName$2.inboundSchema = EventClassificationName$inboundSchema; - EventClassificationName$2.outboundSchema = EventClassificationName$outboundSchema; - })(EventClassificationName$ || (EventClassificationName$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/eventstrategyname.js - var EventStrategyName = { - CustomerCard: "customerCard", - News: "news", - Call: "call", - Email: "email", - MeetingNotes: "meetingNotes", - LinkedIn: "linkedIn", - RelevantDocuments: "relevantDocuments", - ChatFollowUps: "chatFollowUps", - Conversations: "conversations" - }; - var EventStrategyName$inboundSchema = nativeEnumType(EventStrategyName); - var EventStrategyName$outboundSchema = EventStrategyName$inboundSchema; - var EventStrategyName$; - (function(EventStrategyName$2) { - EventStrategyName$2.inboundSchema = EventStrategyName$inboundSchema; - EventStrategyName$2.outboundSchema = EventStrategyName$outboundSchema; - })(EventStrategyName$ || (EventStrategyName$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/eventclassification.js - var EventClassification$inboundSchema = objectType({ - name: EventClassificationName$inboundSchema.optional(), - strategies: arrayType(EventStrategyName$inboundSchema).optional() - }); - var EventClassification$outboundSchema = objectType({ - name: EventClassificationName$outboundSchema.optional(), - strategies: arrayType(EventStrategyName$outboundSchema).optional() - }); - var EventClassification$; - (function(EventClassification$2) { - EventClassification$2.inboundSchema = EventClassification$inboundSchema; - EventClassification$2.outboundSchema = EventClassification$outboundSchema; - })(EventClassification$ || (EventClassification$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/generatedattachmentcontent.js - var GeneratedAttachmentContent$inboundSchema = objectType({ - displayHeader: stringType().optional(), - text: stringType().optional() - }); - var GeneratedAttachmentContent$outboundSchema = objectType({ - displayHeader: stringType().optional(), - text: stringType().optional() - }); - var GeneratedAttachmentContent$; - (function(GeneratedAttachmentContent$2) { - GeneratedAttachmentContent$2.inboundSchema = GeneratedAttachmentContent$inboundSchema; - GeneratedAttachmentContent$2.outboundSchema = GeneratedAttachmentContent$outboundSchema; - })(GeneratedAttachmentContent$ || (GeneratedAttachmentContent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/structuredlink.js - var StructuredLink$inboundSchema = objectType({ - name: stringType().optional(), - url: stringType().optional(), - iconConfig: IconConfig$inboundSchema.optional() - }); - var StructuredLink$outboundSchema = objectType({ - name: stringType().optional(), - url: stringType().optional(), - iconConfig: IconConfig$outboundSchema.optional() - }); - var StructuredLink$; - (function(StructuredLink$2) { - StructuredLink$2.inboundSchema = StructuredLink$inboundSchema; - StructuredLink$2.outboundSchema = StructuredLink$outboundSchema; - })(StructuredLink$ || (StructuredLink$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/generatedattachment.js - var GeneratedAttachment$inboundSchema = objectType({ - strategyName: EventStrategyName$inboundSchema.optional(), - documents: arrayType(Document$inboundSchema).optional(), - person: Person$inboundSchema.optional(), - customer: Customer$inboundSchema.optional(), - externalLinks: arrayType(StructuredLink$inboundSchema).optional(), - content: arrayType(GeneratedAttachmentContent$inboundSchema).optional() - }); - var GeneratedAttachment$outboundSchema = objectType({ - strategyName: EventStrategyName$outboundSchema.optional(), - documents: arrayType(Document$outboundSchema).optional(), - person: Person$outboundSchema.optional(), - customer: Customer$outboundSchema.optional(), - externalLinks: arrayType(StructuredLink$outboundSchema).optional(), - content: arrayType(GeneratedAttachmentContent$outboundSchema).optional() - }); - var GeneratedAttachment$; - (function(GeneratedAttachment$2) { - GeneratedAttachment$2.inboundSchema = GeneratedAttachment$inboundSchema; - GeneratedAttachment$2.outboundSchema = GeneratedAttachment$outboundSchema; - })(GeneratedAttachment$ || (GeneratedAttachment$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/calendarevent.js - var CalendarEventEventType = { - Default: "DEFAULT", - OutOfOffice: "OUT_OF_OFFICE" - }; - var CalendarEventEventType$inboundSchema = nativeEnumType(CalendarEventEventType); - var CalendarEventEventType$outboundSchema = CalendarEventEventType$inboundSchema; - var CalendarEventEventType$; - (function(CalendarEventEventType$2) { - CalendarEventEventType$2.inboundSchema = CalendarEventEventType$inboundSchema; - CalendarEventEventType$2.outboundSchema = CalendarEventEventType$outboundSchema; - })(CalendarEventEventType$ || (CalendarEventEventType$ = {})); - var CalendarEvent$inboundSchema = objectType({ - time: TimeInterval$inboundSchema.optional(), - eventType: CalendarEventEventType$inboundSchema.optional(), - id: stringType(), - url: stringType(), - attendees: CalendarAttendees$inboundSchema.optional(), - location: stringType().optional(), - conferenceData: ConferenceData$inboundSchema.optional(), - description: stringType().optional(), - datasource: stringType().optional(), - hasTranscript: booleanType().optional(), - transcriptUrl: stringType().optional(), - classifications: arrayType(EventClassification$inboundSchema).optional(), - generatedAttachments: arrayType(GeneratedAttachment$inboundSchema).optional() - }); - var CalendarEvent$outboundSchema = objectType({ - time: TimeInterval$outboundSchema.optional(), - eventType: CalendarEventEventType$outboundSchema.optional(), - id: stringType(), - url: stringType(), - attendees: CalendarAttendees$outboundSchema.optional(), - location: stringType().optional(), - conferenceData: ConferenceData$outboundSchema.optional(), - description: stringType().optional(), - datasource: stringType().optional(), - hasTranscript: booleanType().optional(), - transcriptUrl: stringType().optional(), - classifications: arrayType(EventClassification$outboundSchema).optional(), - generatedAttachments: arrayType(GeneratedAttachment$outboundSchema).optional() - }); - var CalendarEvent$; - (function(CalendarEvent$2) { - CalendarEvent$2.inboundSchema = CalendarEvent$inboundSchema; - CalendarEvent$2.outboundSchema = CalendarEvent$outboundSchema; - })(CalendarEvent$ || (CalendarEvent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/canonicalizingregextype.js - var CanonicalizingRegexType$inboundSchema = objectType({ - matchRegex: stringType().optional(), - rewriteRegex: stringType().optional() - }); - var CanonicalizingRegexType$outboundSchema = objectType({ - matchRegex: stringType().optional(), - rewriteRegex: stringType().optional() - }); - var CanonicalizingRegexType$; - (function(CanonicalizingRegexType$2) { - CanonicalizingRegexType$2.inboundSchema = CanonicalizingRegexType$inboundSchema; - CanonicalizingRegexType$2.outboundSchema = CanonicalizingRegexType$outboundSchema; - })(CanonicalizingRegexType$ || (CanonicalizingRegexType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatfilefailurereason.js - var ChatFileFailureReason = { - ParseFailed: "PARSE_FAILED", - AvScanFailed: "AV_SCAN_FAILED", - FileTooSmall: "FILE_TOO_SMALL", - FileTooLarge: "FILE_TOO_LARGE", - FileExtensionUnsupported: "FILE_EXTENSION_UNSUPPORTED", - FileMetadataValidationFail: "FILE_METADATA_VALIDATION_FAIL", - FileProcessingTimedOut: "FILE_PROCESSING_TIMED_OUT" - }; - var ChatFileFailureReason$inboundSchema = nativeEnumType(ChatFileFailureReason); - var ChatFileFailureReason$outboundSchema = ChatFileFailureReason$inboundSchema; - var ChatFileFailureReason$; - (function(ChatFileFailureReason$2) { - ChatFileFailureReason$2.inboundSchema = ChatFileFailureReason$inboundSchema; - ChatFileFailureReason$2.outboundSchema = ChatFileFailureReason$outboundSchema; - })(ChatFileFailureReason$ || (ChatFileFailureReason$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatfilestatus.js - var ChatFileStatus = { - Processing: "PROCESSING", - Processed: "PROCESSED", - Failed: "FAILED", - Deleted: "DELETED" - }; - var ChatFileStatus$inboundSchema = nativeEnumType(ChatFileStatus); - var ChatFileStatus$outboundSchema = ChatFileStatus$inboundSchema; - var ChatFileStatus$; - (function(ChatFileStatus$2) { - ChatFileStatus$2.inboundSchema = ChatFileStatus$inboundSchema; - ChatFileStatus$2.outboundSchema = ChatFileStatus$outboundSchema; - })(ChatFileStatus$ || (ChatFileStatus$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatfilemetadata.js - var ChatFileMetadata$inboundSchema = objectType({ - status: ChatFileStatus$inboundSchema.optional(), - uploadTime: numberType().int().optional(), - processedSize: numberType().int().optional(), - failureReason: ChatFileFailureReason$inboundSchema.optional(), - mimeType: stringType().optional() - }); - var ChatFileMetadata$outboundSchema = objectType({ - status: ChatFileStatus$outboundSchema.optional(), - uploadTime: numberType().int().optional(), - processedSize: numberType().int().optional(), - failureReason: ChatFileFailureReason$outboundSchema.optional(), - mimeType: stringType().optional() - }); - var ChatFileMetadata$; - (function(ChatFileMetadata$2) { - ChatFileMetadata$2.inboundSchema = ChatFileMetadata$inboundSchema; - ChatFileMetadata$2.outboundSchema = ChatFileMetadata$outboundSchema; - })(ChatFileMetadata$ || (ChatFileMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatfile.js - var ChatFile$inboundSchema = objectType({ - id: stringType().optional(), - url: stringType().optional(), - name: stringType().optional(), - metadata: ChatFileMetadata$inboundSchema.optional() - }); - var ChatFile$outboundSchema = objectType({ - id: stringType().optional(), - url: stringType().optional(), - name: stringType().optional(), - metadata: ChatFileMetadata$outboundSchema.optional() - }); - var ChatFile$; - (function(ChatFile$2) { - ChatFile$2.inboundSchema = ChatFile$inboundSchema; - ChatFile$2.outboundSchema = ChatFile$outboundSchema; - })(ChatFile$ || (ChatFile$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/referencerange.js - var ReferenceRange$inboundSchema = objectType({ - textRange: TextRange$inboundSchema.optional(), - snippets: arrayType(SearchResultSnippet$inboundSchema).optional() - }); - var ReferenceRange$outboundSchema = objectType({ - textRange: TextRange$outboundSchema.optional(), - snippets: arrayType(SearchResultSnippet$outboundSchema).optional() - }); - var ReferenceRange$; - (function(ReferenceRange$2) { - ReferenceRange$2.inboundSchema = ReferenceRange$inboundSchema; - ReferenceRange$2.outboundSchema = ReferenceRange$outboundSchema; - })(ReferenceRange$ || (ReferenceRange$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatmessagecitation.js - var ChatMessageCitation$inboundSchema = objectType({ - trackingToken: stringType().optional(), - sourceDocument: Document$inboundSchema.optional(), - sourceFile: ChatFile$inboundSchema.optional(), - sourcePerson: Person$inboundSchema.optional(), - referenceRanges: arrayType(ReferenceRange$inboundSchema).optional() - }); - var ChatMessageCitation$outboundSchema = objectType({ - trackingToken: stringType().optional(), - sourceDocument: Document$outboundSchema.optional(), - sourceFile: ChatFile$outboundSchema.optional(), - sourcePerson: Person$outboundSchema.optional(), - referenceRanges: arrayType(ReferenceRange$outboundSchema).optional() - }); - var ChatMessageCitation$; - (function(ChatMessageCitation$2) { - ChatMessageCitation$2.inboundSchema = ChatMessageCitation$inboundSchema; - ChatMessageCitation$2.outboundSchema = ChatMessageCitation$outboundSchema; - })(ChatMessageCitation$ || (ChatMessageCitation$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/personobject.js - var PersonObject$inboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType() - }); - var PersonObject$outboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType() - }); - var PersonObject$; - (function(PersonObject$2) { - PersonObject$2.inboundSchema = PersonObject$inboundSchema; - PersonObject$2.outboundSchema = PersonObject$outboundSchema; - })(PersonObject$ || (PersonObject$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolmetadata.js - var ToolMetadataType = { - Retrieval: "RETRIEVAL", - Action: "ACTION" - }; - var KnowledgeType = { - NeutralKnowledge: "NEUTRAL_KNOWLEDGE", - CompanyKnowledge: "COMPANY_KNOWLEDGE", - WorldKnowledge: "WORLD_KNOWLEDGE" - }; - var WriteActionType = { - Redirect: "REDIRECT", - Execution: "EXECUTION" - }; - var AuthType = { - None: "NONE", - OauthUser: "OAUTH_USER", - OauthAdmin: "OAUTH_ADMIN", - ApiKey: "API_KEY", - BasicAuth: "BASIC_AUTH", - Dwd: "DWD" - }; - var ToolMetadataType$inboundSchema = nativeEnumType(ToolMetadataType); - var ToolMetadataType$outboundSchema = ToolMetadataType$inboundSchema; - var ToolMetadataType$; - (function(ToolMetadataType$2) { - ToolMetadataType$2.inboundSchema = ToolMetadataType$inboundSchema; - ToolMetadataType$2.outboundSchema = ToolMetadataType$outboundSchema; - })(ToolMetadataType$ || (ToolMetadataType$ = {})); - var KnowledgeType$inboundSchema = nativeEnumType(KnowledgeType); - var KnowledgeType$outboundSchema = KnowledgeType$inboundSchema; - var KnowledgeType$; - (function(KnowledgeType$2) { - KnowledgeType$2.inboundSchema = KnowledgeType$inboundSchema; - KnowledgeType$2.outboundSchema = KnowledgeType$outboundSchema; - })(KnowledgeType$ || (KnowledgeType$ = {})); - var WriteActionType$inboundSchema = nativeEnumType(WriteActionType); - var WriteActionType$outboundSchema = WriteActionType$inboundSchema; - var WriteActionType$; - (function(WriteActionType$2) { - WriteActionType$2.inboundSchema = WriteActionType$inboundSchema; - WriteActionType$2.outboundSchema = WriteActionType$outboundSchema; - })(WriteActionType$ || (WriteActionType$ = {})); - var AuthType$inboundSchema = nativeEnumType(AuthType); - var AuthType$outboundSchema = AuthType$inboundSchema; - var AuthType$; - (function(AuthType$2) { - AuthType$2.inboundSchema = AuthType$inboundSchema; - AuthType$2.outboundSchema = AuthType$outboundSchema; - })(AuthType$ || (AuthType$ = {})); - var ToolMetadata$inboundSchema = objectType({ - type: ToolMetadataType$inboundSchema, - name: stringType(), - displayName: stringType(), - toolId: stringType().optional(), - displayDescription: stringType(), - logoUrl: stringType().optional(), - objectName: stringType().optional(), - knowledgeType: KnowledgeType$inboundSchema.optional(), - createdBy: PersonObject$inboundSchema.optional(), - lastUpdatedBy: PersonObject$inboundSchema.optional(), - createdAt: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - lastUpdatedAt: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - writeActionType: WriteActionType$inboundSchema.optional(), - authType: AuthType$inboundSchema.optional(), - auth: AuthConfig$inboundSchema.optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - usageInstructions: stringType().optional(), - isSetupFinished: booleanType().optional() - }); - var ToolMetadata$outboundSchema = objectType({ - type: ToolMetadataType$outboundSchema, - name: stringType(), - displayName: stringType(), - toolId: stringType().optional(), - displayDescription: stringType(), - logoUrl: stringType().optional(), - objectName: stringType().optional(), - knowledgeType: KnowledgeType$outboundSchema.optional(), - createdBy: PersonObject$outboundSchema.optional(), - lastUpdatedBy: PersonObject$outboundSchema.optional(), - createdAt: dateType().transform((v) => v.toISOString()).optional(), - lastUpdatedAt: dateType().transform((v) => v.toISOString()).optional(), - writeActionType: WriteActionType$outboundSchema.optional(), - authType: AuthType$outboundSchema.optional(), - auth: AuthConfig$outboundSchema.optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - usageInstructions: stringType().optional(), - isSetupFinished: booleanType().optional() - }); - var ToolMetadata$; - (function(ToolMetadata$2) { - ToolMetadata$2.inboundSchema = ToolMetadata$inboundSchema; - ToolMetadata$2.outboundSchema = ToolMetadata$outboundSchema; - })(ToolMetadata$ || (ToolMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/possiblevalue.js - var PossibleValue$inboundSchema = objectType({ - value: stringType().optional(), - label: stringType().optional() - }); - var PossibleValue$outboundSchema = objectType({ - value: stringType().optional(), - label: stringType().optional() - }); - var PossibleValue$; - (function(PossibleValue$2) { - PossibleValue$2.inboundSchema = PossibleValue$inboundSchema; - PossibleValue$2.outboundSchema = PossibleValue$outboundSchema; - })(PossibleValue$ || (PossibleValue$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/writeactionparameter.js - var WriteActionParameterType = { - Unknown: "UNKNOWN", - Integer: "INTEGER", - String: "STRING", - Boolean: "BOOLEAN" - }; - var WriteActionParameterType$inboundSchema = nativeEnumType(WriteActionParameterType); - var WriteActionParameterType$outboundSchema = WriteActionParameterType$inboundSchema; - var WriteActionParameterType$; - (function(WriteActionParameterType$2) { - WriteActionParameterType$2.inboundSchema = WriteActionParameterType$inboundSchema; - WriteActionParameterType$2.outboundSchema = WriteActionParameterType$outboundSchema; - })(WriteActionParameterType$ || (WriteActionParameterType$ = {})); - var WriteActionParameter$inboundSchema = objectType({ - type: WriteActionParameterType$inboundSchema.optional(), - displayName: stringType().optional(), - value: stringType().optional(), - isRequired: booleanType().optional(), - description: stringType().optional(), - possibleValues: arrayType(PossibleValue$inboundSchema).optional() - }); - var WriteActionParameter$outboundSchema = objectType({ - type: WriteActionParameterType$outboundSchema.optional(), - displayName: stringType().optional(), - value: stringType().optional(), - isRequired: booleanType().optional(), - description: stringType().optional(), - possibleValues: arrayType(PossibleValue$outboundSchema).optional() - }); - var WriteActionParameter$; - (function(WriteActionParameter$2) { - WriteActionParameter$2.inboundSchema = WriteActionParameter$inboundSchema; - WriteActionParameter$2.outboundSchema = WriteActionParameter$outboundSchema; - })(WriteActionParameter$ || (WriteActionParameter$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolinfo.js - var ToolInfo$inboundSchema = objectType({ - metadata: ToolMetadata$inboundSchema.optional(), - parameters: recordType(WriteActionParameter$inboundSchema).optional() - }); - var ToolInfo$outboundSchema = objectType({ - metadata: ToolMetadata$outboundSchema.optional(), - parameters: recordType(WriteActionParameter$outboundSchema).optional() - }); - var ToolInfo$; - (function(ToolInfo$2) { - ToolInfo$2.inboundSchema = ToolInfo$inboundSchema; - ToolInfo$2.outboundSchema = ToolInfo$outboundSchema; - })(ToolInfo$ || (ToolInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatmessagefragment.js - var ChatMessageFragment$inboundSchema = objectType({ - structuredResults: arrayType(StructuredResult$inboundSchema).optional(), - trackingToken: stringType().optional(), - text: stringType().optional(), - querySuggestion: QuerySuggestion$inboundSchema.optional(), - file: ChatFile$inboundSchema.optional(), - action: ToolInfo$inboundSchema.optional(), - citation: ChatMessageCitation$inboundSchema.optional() - }); - var ChatMessageFragment$outboundSchema = objectType({ - structuredResults: arrayType(StructuredResult$outboundSchema).optional(), - trackingToken: stringType().optional(), - text: stringType().optional(), - querySuggestion: QuerySuggestion$outboundSchema.optional(), - file: ChatFile$outboundSchema.optional(), - action: ToolInfo$outboundSchema.optional(), - citation: ChatMessageCitation$outboundSchema.optional() - }); - var ChatMessageFragment$; - (function(ChatMessageFragment$2) { - ChatMessageFragment$2.inboundSchema = ChatMessageFragment$inboundSchema; - ChatMessageFragment$2.outboundSchema = ChatMessageFragment$outboundSchema; - })(ChatMessageFragment$ || (ChatMessageFragment$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatmessage.js - var Author = { - User: "USER", - GleanAi: "GLEAN_AI" - }; - var MessageType = { - Update: "UPDATE", - Content: "CONTENT", - Context: "CONTEXT", - Debug: "DEBUG", - DebugExternal: "DEBUG_EXTERNAL", - Error: "ERROR", - Heading: "HEADING", - Warning: "WARNING", - ServerTool: "SERVER_TOOL" - }; - var Author$inboundSchema = nativeEnumType(Author); - var Author$outboundSchema = Author$inboundSchema; - var Author$; - (function(Author$2) { - Author$2.inboundSchema = Author$inboundSchema; - Author$2.outboundSchema = Author$outboundSchema; - })(Author$ || (Author$ = {})); - var MessageType$inboundSchema = nativeEnumType(MessageType); - var MessageType$outboundSchema = MessageType$inboundSchema; - var MessageType$; - (function(MessageType$2) { - MessageType$2.inboundSchema = MessageType$inboundSchema; - MessageType$2.outboundSchema = MessageType$outboundSchema; - })(MessageType$ || (MessageType$ = {})); - var ChatMessage$inboundSchema = objectType({ - agentConfig: AgentConfig$inboundSchema.optional(), - author: Author$inboundSchema.default("USER"), - citations: arrayType(ChatMessageCitation$inboundSchema).optional(), - uploadedFileIds: arrayType(stringType()).optional(), - fragments: arrayType(ChatMessageFragment$inboundSchema).optional(), - ts: stringType().optional(), - messageId: stringType().optional(), - messageTrackingToken: stringType().optional(), - messageType: MessageType$inboundSchema.default("CONTENT"), - hasMoreFragments: booleanType().optional() - }); - var ChatMessage$outboundSchema = objectType({ - agentConfig: AgentConfig$outboundSchema.optional(), - author: Author$outboundSchema.default("USER"), - citations: arrayType(ChatMessageCitation$outboundSchema).optional(), - uploadedFileIds: arrayType(stringType()).optional(), - fragments: arrayType(ChatMessageFragment$outboundSchema).optional(), - ts: stringType().optional(), - messageId: stringType().optional(), - messageTrackingToken: stringType().optional(), - messageType: MessageType$outboundSchema.default("CONTENT"), - hasMoreFragments: booleanType().optional() - }); - var ChatMessage$; - (function(ChatMessage$2) { - ChatMessage$2.inboundSchema = ChatMessage$inboundSchema; - ChatMessage$2.outboundSchema = ChatMessage$outboundSchema; - })(ChatMessage$ || (ChatMessage$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chat.js - var Chat$inboundSchema = objectType({ - id: stringType().optional(), - createTime: numberType().int().optional(), - createdBy: Person$inboundSchema.optional(), - updateTime: numberType().int().optional(), - name: stringType().optional(), - applicationId: stringType().optional(), - applicationName: stringType().optional(), - icon: IconConfig$inboundSchema.optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - messages: arrayType(ChatMessage$inboundSchema).optional(), - roles: arrayType(UserRoleSpecification$inboundSchema).optional() - }); - var Chat$outboundSchema = objectType({ - id: stringType().optional(), - createTime: numberType().int().optional(), - createdBy: Person$outboundSchema.optional(), - updateTime: numberType().int().optional(), - name: stringType().optional(), - applicationId: stringType().optional(), - applicationName: stringType().optional(), - icon: IconConfig$outboundSchema.optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - messages: arrayType(ChatMessage$outboundSchema).optional(), - roles: arrayType(UserRoleSpecification$outboundSchema).optional() - }); - var Chat$; - (function(Chat$2) { - Chat$2.inboundSchema = Chat$inboundSchema; - Chat$2.outboundSchema = Chat$outboundSchema; - })(Chat$ || (Chat$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatmetadata.js - var ChatMetadata$inboundSchema = objectType({ - id: stringType().optional(), - createTime: numberType().int().optional(), - createdBy: Person$inboundSchema.optional(), - updateTime: numberType().int().optional(), - name: stringType().optional(), - applicationId: stringType().optional(), - applicationName: stringType().optional(), - icon: IconConfig$inboundSchema.optional() - }); - var ChatMetadata$outboundSchema = objectType({ - id: stringType().optional(), - createTime: numberType().int().optional(), - createdBy: Person$outboundSchema.optional(), - updateTime: numberType().int().optional(), - name: stringType().optional(), - applicationId: stringType().optional(), - applicationName: stringType().optional(), - icon: IconConfig$outboundSchema.optional() - }); - var ChatMetadata$; - (function(ChatMetadata$2) { - ChatMetadata$2.inboundSchema = ChatMetadata$inboundSchema; - ChatMetadata$2.outboundSchema = ChatMetadata$outboundSchema; - })(ChatMetadata$ || (ChatMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatmetadataresult.js - var ChatMetadataResult$inboundSchema = objectType({ - chat: ChatMetadata$inboundSchema.optional(), - trackingToken: stringType().optional() - }); - var ChatMetadataResult$outboundSchema = objectType({ - chat: ChatMetadata$outboundSchema.optional(), - trackingToken: stringType().optional() - }); - var ChatMetadataResult$; - (function(ChatMetadataResult$2) { - ChatMetadataResult$2.inboundSchema = ChatMetadataResult$inboundSchema; - ChatMetadataResult$2.outboundSchema = ChatMetadataResult$outboundSchema; - })(ChatMetadataResult$ || (ChatMetadataResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatrestrictionfilters.js - var ChatRestrictionFilters$inboundSchema = objectType({ - containerSpecs: arrayType(DocumentSpecUnion$inboundSchema).optional(), - documentSpecs: arrayType(DocumentSpecUnion$inboundSchema).optional(), - datasourceInstances: arrayType(stringType()).optional() - }); - var ChatRestrictionFilters$outboundSchema = objectType({ - containerSpecs: arrayType(DocumentSpecUnion$outboundSchema).optional(), - documentSpecs: arrayType(DocumentSpecUnion$outboundSchema).optional(), - datasourceInstances: arrayType(stringType()).optional() - }); - var ChatRestrictionFilters$; - (function(ChatRestrictionFilters$2) { - ChatRestrictionFilters$2.inboundSchema = ChatRestrictionFilters$inboundSchema; - ChatRestrictionFilters$2.outboundSchema = ChatRestrictionFilters$outboundSchema; - })(ChatRestrictionFilters$ || (ChatRestrictionFilters$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatrequest.js - var ChatRequest$inboundSchema = objectType({ - saveChat: booleanType().optional(), - chatId: stringType().optional(), - messages: arrayType(ChatMessage$inboundSchema), - agentConfig: AgentConfig$inboundSchema.optional(), - inclusions: ChatRestrictionFilters$inboundSchema.optional(), - exclusions: ChatRestrictionFilters$inboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - applicationId: stringType().optional(), - agentId: stringType().optional(), - stream: booleanType().optional() - }); - var ChatRequest$outboundSchema = objectType({ - saveChat: booleanType().optional(), - chatId: stringType().optional(), - messages: arrayType(ChatMessage$outboundSchema), - agentConfig: AgentConfig$outboundSchema.optional(), - inclusions: ChatRestrictionFilters$outboundSchema.optional(), - exclusions: ChatRestrictionFilters$outboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - applicationId: stringType().optional(), - agentId: stringType().optional(), - stream: booleanType().optional() - }); - var ChatRequest$; - (function(ChatRequest$3) { - ChatRequest$3.inboundSchema = ChatRequest$inboundSchema; - ChatRequest$3.outboundSchema = ChatRequest$outboundSchema; - })(ChatRequest$ || (ChatRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatresponse.js - var ChatResponse$inboundSchema = objectType({ - messages: arrayType(ChatMessage$inboundSchema).optional(), - chatId: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional(), - backendTimeMillis: numberType().int().optional(), - chatSessionTrackingToken: stringType().optional() - }); - var ChatResponse$outboundSchema = objectType({ - messages: arrayType(ChatMessage$outboundSchema).optional(), - chatId: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional(), - backendTimeMillis: numberType().int().optional(), - chatSessionTrackingToken: stringType().optional() - }); - var ChatResponse$; - (function(ChatResponse$2) { - ChatResponse$2.inboundSchema = ChatResponse$inboundSchema; - ChatResponse$2.outboundSchema = ChatResponse$outboundSchema; - })(ChatResponse$ || (ChatResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatresult.js - var ChatResult$inboundSchema = objectType({ - chat: Chat$inboundSchema.optional(), - trackingToken: stringType().optional() - }); - var ChatResult$outboundSchema = objectType({ - chat: Chat$outboundSchema.optional(), - trackingToken: stringType().optional() - }); - var ChatResult$; - (function(ChatResult$2) { - ChatResult$2.inboundSchema = ChatResult$inboundSchema; - ChatResult$2.outboundSchema = ChatResult$outboundSchema; - })(ChatResult$ || (ChatResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatsuggestion.js - var ChatSuggestion$inboundSchema = objectType({ - query: stringType().optional(), - feature: stringType().optional() - }); - var ChatSuggestion$outboundSchema = objectType({ - query: stringType().optional(), - feature: stringType().optional() - }); - var ChatSuggestion$; - (function(ChatSuggestion$2) { - ChatSuggestion$2.inboundSchema = ChatSuggestion$inboundSchema; - ChatSuggestion$2.outboundSchema = ChatSuggestion$outboundSchema; - })(ChatSuggestion$ || (ChatSuggestion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/chatzerostatesuggestionoptions.js - var ChatZeroStateSuggestionOptions$inboundSchema = objectType({ - applicationId: stringType().optional() - }); - var ChatZeroStateSuggestionOptions$outboundSchema = objectType({ - applicationId: stringType().optional() - }); - var ChatZeroStateSuggestionOptions$; - (function(ChatZeroStateSuggestionOptions$2) { - ChatZeroStateSuggestionOptions$2.inboundSchema = ChatZeroStateSuggestionOptions$inboundSchema; - ChatZeroStateSuggestionOptions$2.outboundSchema = ChatZeroStateSuggestionOptions$outboundSchema; - })(ChatZeroStateSuggestionOptions$ || (ChatZeroStateSuggestionOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/checkdocumentaccessrequest.js - var CheckDocumentAccessRequest$inboundSchema = objectType({ - datasource: stringType(), - objectType: stringType(), - docId: stringType(), - userEmail: stringType() - }); - var CheckDocumentAccessRequest$outboundSchema = objectType({ - datasource: stringType(), - objectType: stringType(), - docId: stringType(), - userEmail: stringType() - }); - var CheckDocumentAccessRequest$; - (function(CheckDocumentAccessRequest$2) { - CheckDocumentAccessRequest$2.inboundSchema = CheckDocumentAccessRequest$inboundSchema; - CheckDocumentAccessRequest$2.outboundSchema = CheckDocumentAccessRequest$outboundSchema; - })(CheckDocumentAccessRequest$ || (CheckDocumentAccessRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/checkdocumentaccessresponse.js - var CheckDocumentAccessResponse$inboundSchema = objectType({ - hasAccess: booleanType().optional() - }); - var CheckDocumentAccessResponse$outboundSchema = objectType({ - hasAccess: booleanType().optional() - }); - var CheckDocumentAccessResponse$; - (function(CheckDocumentAccessResponse$2) { - CheckDocumentAccessResponse$2.inboundSchema = CheckDocumentAccessResponse$inboundSchema; - CheckDocumentAccessResponse$2.outboundSchema = CheckDocumentAccessResponse$outboundSchema; - })(CheckDocumentAccessResponse$ || (CheckDocumentAccessResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/collectionerror.js - var CollectionErrorErrorCode = { - NameExists: "NAME_EXISTS", - NotFound: "NOT_FOUND", - CollectionPinned: "COLLECTION_PINNED", - ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT", - HeightViolation: "HEIGHT_VIOLATION", - WidthViolation: "WIDTH_VIOLATION", - NoPermissions: "NO_PERMISSIONS" - }; - var CollectionErrorErrorCode$inboundSchema = nativeEnumType(CollectionErrorErrorCode); - var CollectionErrorErrorCode$outboundSchema = CollectionErrorErrorCode$inboundSchema; - var CollectionErrorErrorCode$; - (function(CollectionErrorErrorCode$2) { - CollectionErrorErrorCode$2.inboundSchema = CollectionErrorErrorCode$inboundSchema; - CollectionErrorErrorCode$2.outboundSchema = CollectionErrorErrorCode$outboundSchema; - })(CollectionErrorErrorCode$ || (CollectionErrorErrorCode$ = {})); - var CollectionError$inboundSchema = objectType({ - errorCode: CollectionErrorErrorCode$inboundSchema - }); - var CollectionError$outboundSchema = objectType({ - errorCode: CollectionErrorErrorCode$outboundSchema - }); - var CollectionError$; - (function(CollectionError$3) { - CollectionError$3.inboundSchema = CollectionError$inboundSchema; - CollectionError$3.outboundSchema = CollectionError$outboundSchema; - })(CollectionError$ || (CollectionError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentinsight.js - var DocumentInsight$inboundSchema = objectType({ - document: Document$inboundSchema, - viewCount: CountInfo$inboundSchema.optional(), - visitorCount: CountInfo$inboundSchema.optional() - }); - var DocumentInsight$outboundSchema = objectType({ - document: Document$outboundSchema, - viewCount: CountInfo$outboundSchema.optional(), - visitorCount: CountInfo$outboundSchema.optional() - }); - var DocumentInsight$; - (function(DocumentInsight$2) { - DocumentInsight$2.inboundSchema = DocumentInsight$inboundSchema; - DocumentInsight$2.outboundSchema = DocumentInsight$outboundSchema; - })(DocumentInsight$ || (DocumentInsight$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/contentinsightsresponse.js - var ContentInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - documentInsights: arrayType(DocumentInsight$inboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minDepartmentSizeThreshold: numberType().int().optional(), - minVisitorThreshold: numberType().int().optional() - }); - var ContentInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - documentInsights: arrayType(DocumentInsight$outboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minDepartmentSizeThreshold: numberType().int().optional(), - minVisitorThreshold: numberType().int().optional() - }); - var ContentInsightsResponse$; - (function(ContentInsightsResponse$2) { - ContentInsightsResponse$2.inboundSchema = ContentInsightsResponse$inboundSchema; - ContentInsightsResponse$2.outboundSchema = ContentInsightsResponse$outboundSchema; - })(ContentInsightsResponse$ || (ContentInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createannouncementrequest.js - var CreateAnnouncementRequestChannel = { - Main: "MAIN", - SocialFeed: "SOCIAL_FEED" - }; - var CreateAnnouncementRequestPostType = { - Text: "TEXT", - Link: "LINK" - }; - var CreateAnnouncementRequestChannel$inboundSchema = nativeEnumType(CreateAnnouncementRequestChannel); - var CreateAnnouncementRequestChannel$outboundSchema = CreateAnnouncementRequestChannel$inboundSchema; - var CreateAnnouncementRequestChannel$; - (function(CreateAnnouncementRequestChannel$2) { - CreateAnnouncementRequestChannel$2.inboundSchema = CreateAnnouncementRequestChannel$inboundSchema; - CreateAnnouncementRequestChannel$2.outboundSchema = CreateAnnouncementRequestChannel$outboundSchema; - })(CreateAnnouncementRequestChannel$ || (CreateAnnouncementRequestChannel$ = {})); - var CreateAnnouncementRequestPostType$inboundSchema = nativeEnumType(CreateAnnouncementRequestPostType); - var CreateAnnouncementRequestPostType$outboundSchema = CreateAnnouncementRequestPostType$inboundSchema; - var CreateAnnouncementRequestPostType$; - (function(CreateAnnouncementRequestPostType$2) { - CreateAnnouncementRequestPostType$2.inboundSchema = CreateAnnouncementRequestPostType$inboundSchema; - CreateAnnouncementRequestPostType$2.outboundSchema = CreateAnnouncementRequestPostType$outboundSchema; - })(CreateAnnouncementRequestPostType$ || (CreateAnnouncementRequestPostType$ = {})); - var CreateAnnouncementRequest$inboundSchema = objectType({ - startTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)), - endTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)), - title: stringType(), - body: StructuredText$inboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - banner: Thumbnail$inboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: CreateAnnouncementRequestChannel$inboundSchema.optional(), - postType: CreateAnnouncementRequestPostType$inboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional() - }); - var CreateAnnouncementRequest$outboundSchema = objectType({ - startTime: dateType().transform((v) => v.toISOString()), - endTime: dateType().transform((v) => v.toISOString()), - title: stringType(), - body: StructuredText$outboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - banner: Thumbnail$outboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: CreateAnnouncementRequestChannel$outboundSchema.optional(), - postType: CreateAnnouncementRequestPostType$outboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional() - }); - var CreateAnnouncementRequest$; - (function(CreateAnnouncementRequest$2) { - CreateAnnouncementRequest$2.inboundSchema = CreateAnnouncementRequest$inboundSchema; - CreateAnnouncementRequest$2.outboundSchema = CreateAnnouncementRequest$outboundSchema; - })(CreateAnnouncementRequest$ || (CreateAnnouncementRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createanswerrequest.js - var CreateAnswerRequest$inboundSchema = objectType({ - data: AnswerCreationData$inboundSchema - }); - var CreateAnswerRequest$outboundSchema = objectType({ - data: AnswerCreationData$outboundSchema - }); - var CreateAnswerRequest$; - (function(CreateAnswerRequest$2) { - CreateAnswerRequest$2.inboundSchema = CreateAnswerRequest$inboundSchema; - CreateAnswerRequest$2.outboundSchema = CreateAnswerRequest$outboundSchema; - })(CreateAnswerRequest$ || (CreateAnswerRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createauthtokenresponse.js - var CreateAuthTokenResponse$inboundSchema = objectType({ - token: stringType(), - expirationTime: numberType().int() - }); - var CreateAuthTokenResponse$outboundSchema = objectType({ - token: stringType(), - expirationTime: numberType().int() - }); - var CreateAuthTokenResponse$; - (function(CreateAuthTokenResponse$2) { - CreateAuthTokenResponse$2.inboundSchema = CreateAuthTokenResponse$inboundSchema; - CreateAuthTokenResponse$2.outboundSchema = CreateAuthTokenResponse$outboundSchema; - })(CreateAuthTokenResponse$ || (CreateAuthTokenResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createcollectionrequest.js - var CreateCollectionRequest$inboundSchema = objectType({ - name: stringType(), - description: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - allowedDatasource: stringType().optional(), - newNextItemId: stringType().optional() - }); - var CreateCollectionRequest$outboundSchema = objectType({ - name: stringType(), - description: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - allowedDatasource: stringType().optional(), - newNextItemId: stringType().optional() - }); - var CreateCollectionRequest$; - (function(CreateCollectionRequest$2) { - CreateCollectionRequest$2.inboundSchema = CreateCollectionRequest$inboundSchema; - CreateCollectionRequest$2.outboundSchema = CreateCollectionRequest$outboundSchema; - })(CreateCollectionRequest$ || (CreateCollectionRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlppersonmetadata.js - var DlpPersonMetadata$inboundSchema = objectType({ - firstName: stringType().optional(), - email: stringType().optional() - }); - var DlpPersonMetadata$outboundSchema = objectType({ - firstName: stringType().optional(), - email: stringType().optional() - }); - var DlpPersonMetadata$; - (function(DlpPersonMetadata$2) { - DlpPersonMetadata$2.inboundSchema = DlpPersonMetadata$inboundSchema; - DlpPersonMetadata$2.outboundSchema = DlpPersonMetadata$outboundSchema; - })(DlpPersonMetadata$ || (DlpPersonMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpperson.js - var DlpPerson$inboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - metadata: DlpPersonMetadata$inboundSchema.optional() - }); - var DlpPerson$outboundSchema = objectType({ - name: stringType(), - obfuscatedId: stringType(), - metadata: DlpPersonMetadata$outboundSchema.optional() - }); - var DlpPerson$; - (function(DlpPerson$2) { - DlpPerson$2.inboundSchema = DlpPerson$inboundSchema; - DlpPerson$2.outboundSchema = DlpPerson$outboundSchema; - })(DlpPerson$ || (DlpPerson$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/externalsharingoptions.js - var ExternalSharingOptions$inboundSchema = objectType({ - enabled: booleanType().optional(), - threshold: numberType().int().optional(), - thresholdEnabled: booleanType().optional(), - anyoneWithLinkEnabled: booleanType().optional(), - anyoneInternalEnabled: booleanType().optional(), - anonymousAccessEnabled: booleanType().optional(), - userAccessEnabled: booleanType().optional(), - userIds: arrayType(stringType()).optional(), - domainAccessEnabled: booleanType().optional() - }); - var ExternalSharingOptions$outboundSchema = objectType({ - enabled: booleanType().optional(), - threshold: numberType().int().optional(), - thresholdEnabled: booleanType().optional(), - anyoneWithLinkEnabled: booleanType().optional(), - anyoneInternalEnabled: booleanType().optional(), - anonymousAccessEnabled: booleanType().optional(), - userAccessEnabled: booleanType().optional(), - userIds: arrayType(stringType()).optional(), - domainAccessEnabled: booleanType().optional() - }); - var ExternalSharingOptions$; - (function(ExternalSharingOptions$2) { - ExternalSharingOptions$2.inboundSchema = ExternalSharingOptions$inboundSchema; - ExternalSharingOptions$2.outboundSchema = ExternalSharingOptions$outboundSchema; - })(ExternalSharingOptions$ || (ExternalSharingOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/timerange.js - var TimeRange$inboundSchema = objectType({ - startTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - endTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - lastNDaysValue: numberType().int().optional() - }); - var TimeRange$outboundSchema = objectType({ - startTime: dateType().transform((v) => v.toISOString()).optional(), - endTime: dateType().transform((v) => v.toISOString()).optional(), - lastNDaysValue: numberType().int().optional() - }); - var TimeRange$; - (function(TimeRange$2) { - TimeRange$2.inboundSchema = TimeRange$inboundSchema; - TimeRange$2.outboundSchema = TimeRange$outboundSchema; - })(TimeRange$ || (TimeRange$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/inputoptions.js - var DatasourcesType = { - All: "ALL", - Custom: "CUSTOM" - }; - var TimePeriodType = { - AllTime: "ALL_TIME", - PastYear: "PAST_YEAR", - PastDay: "PAST_DAY", - Custom: "CUSTOM", - LastNDays: "LAST_N_DAYS" - }; - var DatasourcesType$inboundSchema = nativeEnumType(DatasourcesType); - var DatasourcesType$outboundSchema = DatasourcesType$inboundSchema; - var DatasourcesType$; - (function(DatasourcesType$2) { - DatasourcesType$2.inboundSchema = DatasourcesType$inboundSchema; - DatasourcesType$2.outboundSchema = DatasourcesType$outboundSchema; - })(DatasourcesType$ || (DatasourcesType$ = {})); - var TimePeriodType$inboundSchema = nativeEnumType(TimePeriodType); - var TimePeriodType$outboundSchema = TimePeriodType$inboundSchema; - var TimePeriodType$; - (function(TimePeriodType$2) { - TimePeriodType$2.inboundSchema = TimePeriodType$inboundSchema; - TimePeriodType$2.outboundSchema = TimePeriodType$outboundSchema; - })(TimePeriodType$ || (TimePeriodType$ = {})); - var InputOptions$inboundSchema = objectType({ - urlGreenlist: arrayType(stringType()).optional(), - datasourcesType: DatasourcesType$inboundSchema.optional(), - datasources: arrayType(stringType()).optional(), - datasourceInstances: arrayType(stringType()).optional(), - timePeriodType: TimePeriodType$inboundSchema.optional(), - customTimeRange: TimeRange$inboundSchema.optional() - }); - var InputOptions$outboundSchema = objectType({ - urlGreenlist: arrayType(stringType()).optional(), - datasourcesType: DatasourcesType$outboundSchema.optional(), - datasources: arrayType(stringType()).optional(), - datasourceInstances: arrayType(stringType()).optional(), - timePeriodType: TimePeriodType$outboundSchema.optional(), - customTimeRange: TimeRange$outboundSchema.optional() - }); - var InputOptions$; - (function(InputOptions$2) { - InputOptions$2.inboundSchema = InputOptions$inboundSchema; - InputOptions$2.outboundSchema = InputOptions$outboundSchema; - })(InputOptions$ || (InputOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/hotwordproximity.js - var HotwordProximity$inboundSchema = objectType({ - windowBefore: numberType().int().optional(), - windowAfter: numberType().int().optional() - }); - var HotwordProximity$outboundSchema = objectType({ - windowBefore: numberType().int().optional(), - windowAfter: numberType().int().optional() - }); - var HotwordProximity$; - (function(HotwordProximity$2) { - HotwordProximity$2.inboundSchema = HotwordProximity$inboundSchema; - HotwordProximity$2.outboundSchema = HotwordProximity$outboundSchema; - })(HotwordProximity$ || (HotwordProximity$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/hotword.js - var Hotword$inboundSchema = objectType({ - regex: stringType().optional(), - proximity: HotwordProximity$inboundSchema.optional() - }); - var Hotword$outboundSchema = objectType({ - regex: stringType().optional(), - proximity: HotwordProximity$outboundSchema.optional() - }); - var Hotword$; - (function(Hotword$2) { - Hotword$2.inboundSchema = Hotword$inboundSchema; - Hotword$2.outboundSchema = Hotword$outboundSchema; - })(Hotword$ || (Hotword$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sensitiveexpression.js - var SensitiveExpression$inboundSchema = objectType({ - expression: stringType().optional(), - hotwords: arrayType(Hotword$inboundSchema).optional() - }); - var SensitiveExpression$outboundSchema = objectType({ - expression: stringType().optional(), - hotwords: arrayType(Hotword$outboundSchema).optional() - }); - var SensitiveExpression$; - (function(SensitiveExpression$2) { - SensitiveExpression$2.inboundSchema = SensitiveExpression$inboundSchema; - SensitiveExpression$2.outboundSchema = SensitiveExpression$outboundSchema; - })(SensitiveExpression$ || (SensitiveExpression$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sensitiveinfotype.js - var LikelihoodThreshold = { - Likely: "LIKELY", - VeryLikely: "VERY_LIKELY" - }; - var LikelihoodThreshold$inboundSchema = nativeEnumType(LikelihoodThreshold); - var LikelihoodThreshold$outboundSchema = LikelihoodThreshold$inboundSchema; - var LikelihoodThreshold$; - (function(LikelihoodThreshold$2) { - LikelihoodThreshold$2.inboundSchema = LikelihoodThreshold$inboundSchema; - LikelihoodThreshold$2.outboundSchema = LikelihoodThreshold$outboundSchema; - })(LikelihoodThreshold$ || (LikelihoodThreshold$ = {})); - var SensitiveInfoType$inboundSchema = objectType({ - likelihoodThreshold: LikelihoodThreshold$inboundSchema.optional(), - infoType: stringType().optional() - }); - var SensitiveInfoType$outboundSchema = objectType({ - likelihoodThreshold: LikelihoodThreshold$outboundSchema.optional(), - infoType: stringType().optional() - }); - var SensitiveInfoType$; - (function(SensitiveInfoType$2) { - SensitiveInfoType$2.inboundSchema = SensitiveInfoType$inboundSchema; - SensitiveInfoType$2.outboundSchema = SensitiveInfoType$outboundSchema; - })(SensitiveInfoType$ || (SensitiveInfoType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sensitivecontentoptions.js - var SensitiveContentOptions$inboundSchema = objectType({ - sensitiveInfoTypes: arrayType(SensitiveInfoType$inboundSchema).optional(), - sensitiveTerms: arrayType(SensitiveExpression$inboundSchema).optional(), - sensitiveRegexes: arrayType(SensitiveExpression$inboundSchema).optional() - }); - var SensitiveContentOptions$outboundSchema = objectType({ - sensitiveInfoTypes: arrayType(SensitiveInfoType$outboundSchema).optional(), - sensitiveTerms: arrayType(SensitiveExpression$outboundSchema).optional(), - sensitiveRegexes: arrayType(SensitiveExpression$outboundSchema).optional() - }); - var SensitiveContentOptions$; - (function(SensitiveContentOptions$2) { - SensitiveContentOptions$2.inboundSchema = SensitiveContentOptions$inboundSchema; - SensitiveContentOptions$2.outboundSchema = SensitiveContentOptions$outboundSchema; - })(SensitiveContentOptions$ || (SensitiveContentOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sharingoptions.js - var SharingOptions$inboundSchema = objectType({ - enabled: booleanType().optional(), - threshold: numberType().int().optional(), - thresholdEnabled: booleanType().optional(), - anyoneWithLinkEnabled: booleanType().optional(), - anyoneInternalEnabled: booleanType().optional(), - anonymousAccessEnabled: booleanType().optional(), - userAccessEnabled: booleanType().optional(), - userIds: arrayType(stringType()).optional() - }); - var SharingOptions$outboundSchema = objectType({ - enabled: booleanType().optional(), - threshold: numberType().int().optional(), - thresholdEnabled: booleanType().optional(), - anyoneWithLinkEnabled: booleanType().optional(), - anyoneInternalEnabled: booleanType().optional(), - anonymousAccessEnabled: booleanType().optional(), - userAccessEnabled: booleanType().optional(), - userIds: arrayType(stringType()).optional() - }); - var SharingOptions$; - (function(SharingOptions$2) { - SharingOptions$2.inboundSchema = SharingOptions$inboundSchema; - SharingOptions$2.outboundSchema = SharingOptions$outboundSchema; - })(SharingOptions$ || (SharingOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpconfig.js - var DlpConfig$inboundSchema = objectType({ - version: numberType().int().optional(), - sensitiveInfoTypes: arrayType(SensitiveInfoType$inboundSchema).optional(), - inputOptions: InputOptions$inboundSchema.optional(), - externalSharingOptions: ExternalSharingOptions$inboundSchema.optional(), - broadSharingOptions: SharingOptions$inboundSchema.optional(), - sensitiveContentOptions: SensitiveContentOptions$inboundSchema.optional(), - reportName: stringType().optional(), - frequency: stringType().optional(), - createdBy: DlpPerson$inboundSchema.optional(), - createdAt: stringType().optional(), - redactQuote: booleanType().optional(), - autoHideDocs: booleanType().optional(), - allowlistOptions: AllowlistOptions$inboundSchema.optional() - }); - var DlpConfig$outboundSchema = objectType({ - version: numberType().int().optional(), - sensitiveInfoTypes: arrayType(SensitiveInfoType$outboundSchema).optional(), - inputOptions: InputOptions$outboundSchema.optional(), - externalSharingOptions: ExternalSharingOptions$outboundSchema.optional(), - broadSharingOptions: SharingOptions$outboundSchema.optional(), - sensitiveContentOptions: SensitiveContentOptions$outboundSchema.optional(), - reportName: stringType().optional(), - frequency: stringType().optional(), - createdBy: DlpPerson$outboundSchema.optional(), - createdAt: stringType().optional(), - redactQuote: booleanType().optional(), - autoHideDocs: booleanType().optional(), - allowlistOptions: AllowlistOptions$outboundSchema.optional() - }); - var DlpConfig$; - (function(DlpConfig$2) { - DlpConfig$2.inboundSchema = DlpConfig$inboundSchema; - DlpConfig$2.outboundSchema = DlpConfig$outboundSchema; - })(DlpConfig$ || (DlpConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpfrequency.js - var DlpFrequency = { - Once: "ONCE", - Daily: "DAILY", - Weekly: "WEEKLY", - Continuous: "CONTINUOUS", - None: "NONE" - }; - var DlpFrequency$inboundSchema = nativeEnumType(DlpFrequency); - var DlpFrequency$outboundSchema = DlpFrequency$inboundSchema; - var DlpFrequency$; - (function(DlpFrequency$2) { - DlpFrequency$2.inboundSchema = DlpFrequency$inboundSchema; - DlpFrequency$2.outboundSchema = DlpFrequency$outboundSchema; - })(DlpFrequency$ || (DlpFrequency$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createdlpreportrequest.js - var CreateDlpReportRequest$inboundSchema = objectType({ - name: stringType().optional(), - config: DlpConfig$inboundSchema.optional(), - frequency: DlpFrequency$inboundSchema.optional(), - autoHideDocs: booleanType().optional() - }); - var CreateDlpReportRequest$outboundSchema = objectType({ - name: stringType().optional(), - config: DlpConfig$outboundSchema.optional(), - frequency: DlpFrequency$outboundSchema.optional(), - autoHideDocs: booleanType().optional() - }); - var CreateDlpReportRequest$; - (function(CreateDlpReportRequest$2) { - CreateDlpReportRequest$2.inboundSchema = CreateDlpReportRequest$inboundSchema; - CreateDlpReportRequest$2.outboundSchema = CreateDlpReportRequest$outboundSchema; - })(CreateDlpReportRequest$ || (CreateDlpReportRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpreportstatus.js - var DlpReportStatus = { - Active: "ACTIVE", - Inactive: "INACTIVE", - Cancelled: "CANCELLED", - None: "NONE" - }; - var DlpReportStatus$inboundSchema = nativeEnumType(DlpReportStatus); - var DlpReportStatus$outboundSchema = DlpReportStatus$inboundSchema; - var DlpReportStatus$; - (function(DlpReportStatus$2) { - DlpReportStatus$2.inboundSchema = DlpReportStatus$inboundSchema; - DlpReportStatus$2.outboundSchema = DlpReportStatus$outboundSchema; - })(DlpReportStatus$ || (DlpReportStatus$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpreport.js - var LastScanStatus = { - Pending: "PENDING", - Success: "SUCCESS", - Failure: "FAILURE", - Cancelled: "CANCELLED", - Cancelling: "CANCELLING", - Active: "ACTIVE" - }; - var LastScanStatus$inboundSchema = nativeEnumType(LastScanStatus); - var LastScanStatus$outboundSchema = LastScanStatus$inboundSchema; - var LastScanStatus$; - (function(LastScanStatus$2) { - LastScanStatus$2.inboundSchema = LastScanStatus$inboundSchema; - LastScanStatus$2.outboundSchema = LastScanStatus$outboundSchema; - })(LastScanStatus$ || (LastScanStatus$ = {})); - var DlpReport$inboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - config: DlpConfig$inboundSchema.optional(), - frequency: DlpFrequency$inboundSchema.optional(), - status: DlpReportStatus$inboundSchema.optional(), - createdBy: DlpPerson$inboundSchema.optional(), - createdAt: stringType().optional(), - lastUpdatedAt: stringType().optional(), - autoHideDocs: booleanType().optional(), - lastScanStatus: LastScanStatus$inboundSchema.optional(), - lastScanStartTime: stringType().optional(), - updatedBy: DlpPerson$inboundSchema.optional() - }); - var DlpReport$outboundSchema = objectType({ - id: stringType().optional(), - name: stringType().optional(), - config: DlpConfig$outboundSchema.optional(), - frequency: DlpFrequency$outboundSchema.optional(), - status: DlpReportStatus$outboundSchema.optional(), - createdBy: DlpPerson$outboundSchema.optional(), - createdAt: stringType().optional(), - lastUpdatedAt: stringType().optional(), - autoHideDocs: booleanType().optional(), - lastScanStatus: LastScanStatus$outboundSchema.optional(), - lastScanStartTime: stringType().optional(), - updatedBy: DlpPerson$outboundSchema.optional() - }); - var DlpReport$; - (function(DlpReport$2) { - DlpReport$2.inboundSchema = DlpReport$inboundSchema; - DlpReport$2.outboundSchema = DlpReport$outboundSchema; - })(DlpReport$ || (DlpReport$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createdlpreportresponse.js - var CreateDlpReportResponse$inboundSchema = objectType({ - report: DlpReport$inboundSchema.optional() - }); - var CreateDlpReportResponse$outboundSchema = objectType({ - report: DlpReport$outboundSchema.optional() - }); - var CreateDlpReportResponse$; - (function(CreateDlpReportResponse$2) { - CreateDlpReportResponse$2.inboundSchema = CreateDlpReportResponse$inboundSchema; - CreateDlpReportResponse$2.outboundSchema = CreateDlpReportResponse$outboundSchema; - })(CreateDlpReportResponse$ || (CreateDlpReportResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcutmutableproperties.js - var ShortcutMutableProperties$inboundSchema = objectType({ - inputAlias: stringType().optional(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional() - }); - var ShortcutMutableProperties$outboundSchema = objectType({ - inputAlias: stringType().optional(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional() - }); - var ShortcutMutableProperties$; - (function(ShortcutMutableProperties$2) { - ShortcutMutableProperties$2.inboundSchema = ShortcutMutableProperties$inboundSchema; - ShortcutMutableProperties$2.outboundSchema = ShortcutMutableProperties$outboundSchema; - })(ShortcutMutableProperties$ || (ShortcutMutableProperties$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createshortcutrequest.js - var CreateShortcutRequest$inboundSchema = objectType({ - data: ShortcutMutableProperties$inboundSchema - }); - var CreateShortcutRequest$outboundSchema = objectType({ - data: ShortcutMutableProperties$outboundSchema - }); - var CreateShortcutRequest$; - (function(CreateShortcutRequest$2) { - CreateShortcutRequest$2.inboundSchema = CreateShortcutRequest$inboundSchema; - CreateShortcutRequest$2.outboundSchema = CreateShortcutRequest$outboundSchema; - })(CreateShortcutRequest$ || (CreateShortcutRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcuterror.js - var ShortcutErrorErrorType = { - NoPermission: "NO_PERMISSION", - InvalidId: "INVALID_ID", - ExistingShortcut: "EXISTING_SHORTCUT", - InvalidChars: "INVALID_CHARS" - }; - var ShortcutErrorErrorType$inboundSchema = nativeEnumType(ShortcutErrorErrorType); - var ShortcutErrorErrorType$outboundSchema = ShortcutErrorErrorType$inboundSchema; - var ShortcutErrorErrorType$; - (function(ShortcutErrorErrorType$2) { - ShortcutErrorErrorType$2.inboundSchema = ShortcutErrorErrorType$inboundSchema; - ShortcutErrorErrorType$2.outboundSchema = ShortcutErrorErrorType$outboundSchema; - })(ShortcutErrorErrorType$ || (ShortcutErrorErrorType$ = {})); - var ShortcutError$inboundSchema = objectType({ - errorType: ShortcutErrorErrorType$inboundSchema.optional() - }); - var ShortcutError$outboundSchema = objectType({ - errorType: ShortcutErrorErrorType$outboundSchema.optional() - }); - var ShortcutError$; - (function(ShortcutError$2) { - ShortcutError$2.inboundSchema = ShortcutError$inboundSchema; - ShortcutError$2.outboundSchema = ShortcutError$outboundSchema; - })(ShortcutError$ || (ShortcutError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/createshortcutresponse.js - var CreateShortcutResponse$inboundSchema = objectType({ - shortcut: Shortcut$inboundSchema.optional(), - error: ShortcutError$inboundSchema.optional() - }); - var CreateShortcutResponse$outboundSchema = objectType({ - shortcut: Shortcut$outboundSchema.optional(), - error: ShortcutError$outboundSchema.optional() - }); - var CreateShortcutResponse$; - (function(CreateShortcutResponse$2) { - CreateShortcutResponse$2.inboundSchema = CreateShortcutResponse$inboundSchema; - CreateShortcutResponse$2.outboundSchema = CreateShortcutResponse$outboundSchema; - })(CreateShortcutResponse$ || (CreateShortcutResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/propertydefinition.js - var PropertyType = { - Text: "TEXT", - Date: "DATE", - Int: "INT", - Userid: "USERID", - Picklist: "PICKLIST", - Textlist: "TEXTLIST", - Multipicklist: "MULTIPICKLIST" - }; - var UiOptions = { - None: "NONE", - SearchResult: "SEARCH_RESULT", - DocHovercard: "DOC_HOVERCARD" - }; - var PropertyType$inboundSchema = nativeEnumType(PropertyType); - var PropertyType$outboundSchema = PropertyType$inboundSchema; - var PropertyType$; - (function(PropertyType$2) { - PropertyType$2.inboundSchema = PropertyType$inboundSchema; - PropertyType$2.outboundSchema = PropertyType$outboundSchema; - })(PropertyType$ || (PropertyType$ = {})); - var UiOptions$inboundSchema = nativeEnumType(UiOptions); - var UiOptions$outboundSchema = UiOptions$inboundSchema; - var UiOptions$; - (function(UiOptions$2) { - UiOptions$2.inboundSchema = UiOptions$inboundSchema; - UiOptions$2.outboundSchema = UiOptions$outboundSchema; - })(UiOptions$ || (UiOptions$ = {})); - var PropertyDefinition$inboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional(), - displayLabelPlural: stringType().optional(), - propertyType: PropertyType$inboundSchema.optional(), - uiOptions: UiOptions$inboundSchema.optional(), - hideUiFacet: booleanType().optional(), - uiFacetOrder: numberType().int().optional(), - skipIndexing: booleanType().optional(), - group: stringType().optional() - }); - var PropertyDefinition$outboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional(), - displayLabelPlural: stringType().optional(), - propertyType: PropertyType$outboundSchema.optional(), - uiOptions: UiOptions$outboundSchema.optional(), - hideUiFacet: booleanType().optional(), - uiFacetOrder: numberType().int().optional(), - skipIndexing: booleanType().optional(), - group: stringType().optional() - }); - var PropertyDefinition$; - (function(PropertyDefinition$2) { - PropertyDefinition$2.inboundSchema = PropertyDefinition$inboundSchema; - PropertyDefinition$2.outboundSchema = PropertyDefinition$outboundSchema; - })(PropertyDefinition$ || (PropertyDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/propertygroup.js - var PropertyGroup$inboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional() - }); - var PropertyGroup$outboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional() - }); - var PropertyGroup$; - (function(PropertyGroup$2) { - PropertyGroup$2.inboundSchema = PropertyGroup$inboundSchema; - PropertyGroup$2.outboundSchema = PropertyGroup$outboundSchema; - })(PropertyGroup$ || (PropertyGroup$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/objectdefinition.js - var DocCategory = { - Uncategorized: "UNCATEGORIZED", - Tickets: "TICKETS", - Crm: "CRM", - PublishedContent: "PUBLISHED_CONTENT", - CollaborativeContent: "COLLABORATIVE_CONTENT", - QuestionAnswer: "QUESTION_ANSWER", - Messaging: "MESSAGING", - CodeRepository: "CODE_REPOSITORY", - ChangeManagement: "CHANGE_MANAGEMENT", - People: "PEOPLE", - Email: "EMAIL", - Sso: "SSO", - Ats: "ATS", - KnowledgeHub: "KNOWLEDGE_HUB", - ExternalShortcut: "EXTERNAL_SHORTCUT", - Entity: "ENTITY", - Calendar: "CALENDAR", - Agents: "AGENTS" - }; - var DocCategory$inboundSchema = nativeEnumType(DocCategory); - var DocCategory$outboundSchema = DocCategory$inboundSchema; - var DocCategory$; - (function(DocCategory$2) { - DocCategory$2.inboundSchema = DocCategory$inboundSchema; - DocCategory$2.outboundSchema = DocCategory$outboundSchema; - })(DocCategory$ || (DocCategory$ = {})); - var ObjectDefinition$inboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional(), - docCategory: DocCategory$inboundSchema.optional(), - propertyDefinitions: arrayType(PropertyDefinition$inboundSchema).optional(), - propertyGroups: arrayType(PropertyGroup$inboundSchema).optional(), - summarizable: booleanType().optional() - }); - var ObjectDefinition$outboundSchema = objectType({ - name: stringType().optional(), - displayLabel: stringType().optional(), - docCategory: DocCategory$outboundSchema.optional(), - propertyDefinitions: arrayType(PropertyDefinition$outboundSchema).optional(), - propertyGroups: arrayType(PropertyGroup$outboundSchema).optional(), - summarizable: booleanType().optional() - }); - var ObjectDefinition$; - (function(ObjectDefinition$2) { - ObjectDefinition$2.inboundSchema = ObjectDefinition$inboundSchema; - ObjectDefinition$2.outboundSchema = ObjectDefinition$outboundSchema; - })(ObjectDefinition$ || (ObjectDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/customdatasourceconfig.js - var DatasourceCategory = { - Uncategorized: "UNCATEGORIZED", - Tickets: "TICKETS", - Crm: "CRM", - PublishedContent: "PUBLISHED_CONTENT", - CollaborativeContent: "COLLABORATIVE_CONTENT", - QuestionAnswer: "QUESTION_ANSWER", - Messaging: "MESSAGING", - CodeRepository: "CODE_REPOSITORY", - ChangeManagement: "CHANGE_MANAGEMENT", - People: "PEOPLE", - Email: "EMAIL", - Sso: "SSO", - Ats: "ATS", - KnowledgeHub: "KNOWLEDGE_HUB", - ExternalShortcut: "EXTERNAL_SHORTCUT", - Entity: "ENTITY", - Calendar: "CALENDAR", - Agents: "AGENTS" - }; - var HideBuiltInFacet = { - Type: "TYPE", - Tag: "TAG", - Author: "AUTHOR", - Owner: "OWNER" - }; - var CustomDatasourceConfigConnectorType = { - ApiCrawl: "API_CRAWL", - BrowserCrawl: "BROWSER_CRAWL", - BrowserHistory: "BROWSER_HISTORY", - Builtin: "BUILTIN", - FederatedSearch: "FEDERATED_SEARCH", - PushApi: "PUSH_API", - WebCrawl: "WEB_CRAWL", - NativeHistory: "NATIVE_HISTORY" - }; - var DatasourceCategory$inboundSchema = nativeEnumType(DatasourceCategory); - var DatasourceCategory$outboundSchema = DatasourceCategory$inboundSchema; - var DatasourceCategory$; - (function(DatasourceCategory$2) { - DatasourceCategory$2.inboundSchema = DatasourceCategory$inboundSchema; - DatasourceCategory$2.outboundSchema = DatasourceCategory$outboundSchema; - })(DatasourceCategory$ || (DatasourceCategory$ = {})); - var HideBuiltInFacet$inboundSchema = nativeEnumType(HideBuiltInFacet); - var HideBuiltInFacet$outboundSchema = HideBuiltInFacet$inboundSchema; - var HideBuiltInFacet$; - (function(HideBuiltInFacet$2) { - HideBuiltInFacet$2.inboundSchema = HideBuiltInFacet$inboundSchema; - HideBuiltInFacet$2.outboundSchema = HideBuiltInFacet$outboundSchema; - })(HideBuiltInFacet$ || (HideBuiltInFacet$ = {})); - var CustomDatasourceConfigConnectorType$inboundSchema = nativeEnumType(CustomDatasourceConfigConnectorType); - var CustomDatasourceConfigConnectorType$outboundSchema = CustomDatasourceConfigConnectorType$inboundSchema; - var CustomDatasourceConfigConnectorType$; - (function(CustomDatasourceConfigConnectorType$2) { - CustomDatasourceConfigConnectorType$2.inboundSchema = CustomDatasourceConfigConnectorType$inboundSchema; - CustomDatasourceConfigConnectorType$2.outboundSchema = CustomDatasourceConfigConnectorType$outboundSchema; - })(CustomDatasourceConfigConnectorType$ || (CustomDatasourceConfigConnectorType$ = {})); - var CustomDatasourceConfig$inboundSchema = objectType({ - name: stringType(), - displayName: stringType().optional(), - datasourceCategory: DatasourceCategory$inboundSchema.default("UNCATEGORIZED"), - urlRegex: stringType().optional(), - iconUrl: stringType().optional(), - objectDefinitions: arrayType(ObjectDefinition$inboundSchema).optional(), - suggestionText: stringType().optional(), - homeUrl: stringType().optional(), - crawlerSeedUrls: arrayType(stringType()).optional(), - iconDarkUrl: stringType().optional(), - hideBuiltInFacets: arrayType(HideBuiltInFacet$inboundSchema).optional(), - canonicalizingURLRegex: arrayType(CanonicalizingRegexType$inboundSchema).optional(), - canonicalizingTitleRegex: arrayType(CanonicalizingRegexType$inboundSchema).optional(), - redlistTitleRegex: stringType().optional(), - connectorType: CustomDatasourceConfigConnectorType$inboundSchema.optional(), - quicklinks: arrayType(Quicklink$inboundSchema).optional(), - renderConfigPreset: stringType().optional(), - aliases: arrayType(stringType()).optional(), - isOnPrem: booleanType().optional(), - trustUrlRegexForViewActivity: booleanType().default(true), - includeUtmSource: booleanType().optional(), - stripFragmentInCanonicalUrl: booleanType().default(true), - identityDatasourceName: stringType().optional(), - productAccessGroup: stringType().optional(), - isUserReferencedByEmail: booleanType().optional(), - isEntityDatasource: booleanType().default(false), - isTestDatasource: booleanType().default(false) - }); - var CustomDatasourceConfig$outboundSchema = objectType({ - name: stringType(), - displayName: stringType().optional(), - datasourceCategory: DatasourceCategory$outboundSchema.default("UNCATEGORIZED"), - urlRegex: stringType().optional(), - iconUrl: stringType().optional(), - objectDefinitions: arrayType(ObjectDefinition$outboundSchema).optional(), - suggestionText: stringType().optional(), - homeUrl: stringType().optional(), - crawlerSeedUrls: arrayType(stringType()).optional(), - iconDarkUrl: stringType().optional(), - hideBuiltInFacets: arrayType(HideBuiltInFacet$outboundSchema).optional(), - canonicalizingURLRegex: arrayType(CanonicalizingRegexType$outboundSchema).optional(), - canonicalizingTitleRegex: arrayType(CanonicalizingRegexType$outboundSchema).optional(), - redlistTitleRegex: stringType().optional(), - connectorType: CustomDatasourceConfigConnectorType$outboundSchema.optional(), - quicklinks: arrayType(Quicklink$outboundSchema).optional(), - renderConfigPreset: stringType().optional(), - aliases: arrayType(stringType()).optional(), - isOnPrem: booleanType().optional(), - trustUrlRegexForViewActivity: booleanType().default(true), - includeUtmSource: booleanType().optional(), - stripFragmentInCanonicalUrl: booleanType().default(true), - identityDatasourceName: stringType().optional(), - productAccessGroup: stringType().optional(), - isUserReferencedByEmail: booleanType().optional(), - isEntityDatasource: booleanType().default(false), - isTestDatasource: booleanType().default(false) - }); - var CustomDatasourceConfig$; - (function(CustomDatasourceConfig$2) { - CustomDatasourceConfig$2.inboundSchema = CustomDatasourceConfig$inboundSchema; - CustomDatasourceConfig$2.outboundSchema = CustomDatasourceConfig$outboundSchema; - })(CustomDatasourceConfig$ || (CustomDatasourceConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourcemembershipdefinition.js - var DatasourceMembershipDefinition$inboundSchema = objectType({ - groupName: stringType(), - memberUserId: stringType().optional(), - memberGroupName: stringType().optional() - }); - var DatasourceMembershipDefinition$outboundSchema = objectType({ - groupName: stringType(), - memberUserId: stringType().optional(), - memberGroupName: stringType().optional() - }); - var DatasourceMembershipDefinition$; - (function(DatasourceMembershipDefinition$2) { - DatasourceMembershipDefinition$2.inboundSchema = DatasourceMembershipDefinition$inboundSchema; - DatasourceMembershipDefinition$2.outboundSchema = DatasourceMembershipDefinition$outboundSchema; - })(DatasourceMembershipDefinition$ || (DatasourceMembershipDefinition$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/datasourceobjecttypedocumentcountentry.js - var DatasourceObjectTypeDocumentCountEntry$inboundSchema = objectType({ - objectType: stringType().optional(), - count: numberType().int().optional() - }); - var DatasourceObjectTypeDocumentCountEntry$outboundSchema = objectType({ - objectType: stringType().optional(), - count: numberType().int().optional() - }); - var DatasourceObjectTypeDocumentCountEntry$; - (function(DatasourceObjectTypeDocumentCountEntry$2) { - DatasourceObjectTypeDocumentCountEntry$2.inboundSchema = DatasourceObjectTypeDocumentCountEntry$inboundSchema; - DatasourceObjectTypeDocumentCountEntry$2.outboundSchema = DatasourceObjectTypeDocumentCountEntry$outboundSchema; - })(DatasourceObjectTypeDocumentCountEntry$ || (DatasourceObjectTypeDocumentCountEntry$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdatasourcestatusidentityresponsecomponent.js - var DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema = objectType({ - uploaded: numberType().int().optional() - }); - var DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema = objectType({ - uploaded: numberType().int().optional() - }); - var DebugDatasourceStatusIdentityResponseComponentCounts$; - (function(DebugDatasourceStatusIdentityResponseComponentCounts$2) { - DebugDatasourceStatusIdentityResponseComponentCounts$2.inboundSchema = DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema; - DebugDatasourceStatusIdentityResponseComponentCounts$2.outboundSchema = DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema; - })(DebugDatasourceStatusIdentityResponseComponentCounts$ || (DebugDatasourceStatusIdentityResponseComponentCounts$ = {})); - var DebugDatasourceStatusIdentityResponseComponent$inboundSchema = objectType({ - bulkUploadHistory: arrayType(BulkUploadHistoryEvent$inboundSchema).optional(), - counts: lazyType(() => DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema).optional() - }); - var DebugDatasourceStatusIdentityResponseComponent$outboundSchema = objectType({ - bulkUploadHistory: arrayType(BulkUploadHistoryEvent$outboundSchema).optional(), - counts: lazyType(() => DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema).optional() - }); - var DebugDatasourceStatusIdentityResponseComponent$; - (function(DebugDatasourceStatusIdentityResponseComponent$2) { - DebugDatasourceStatusIdentityResponseComponent$2.inboundSchema = DebugDatasourceStatusIdentityResponseComponent$inboundSchema; - DebugDatasourceStatusIdentityResponseComponent$2.outboundSchema = DebugDatasourceStatusIdentityResponseComponent$outboundSchema; - })(DebugDatasourceStatusIdentityResponseComponent$ || (DebugDatasourceStatusIdentityResponseComponent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/processinghistoryevent.js - var ProcessingHistoryEvent$inboundSchema = objectType({ - startTime: stringType().optional(), - endTime: stringType().optional() - }); - var ProcessingHistoryEvent$outboundSchema = objectType({ - startTime: stringType().optional(), - endTime: stringType().optional() - }); - var ProcessingHistoryEvent$; - (function(ProcessingHistoryEvent$2) { - ProcessingHistoryEvent$2.inboundSchema = ProcessingHistoryEvent$inboundSchema; - ProcessingHistoryEvent$2.outboundSchema = ProcessingHistoryEvent$outboundSchema; - })(ProcessingHistoryEvent$ || (ProcessingHistoryEvent$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdatasourcestatusresponse.js - var DatasourceVisibility = { - EnabledForAll: "ENABLED_FOR_ALL", - EnabledForTestGroup: "ENABLED_FOR_TEST_GROUP", - NotEnabled: "NOT_ENABLED" - }; - var DebugDatasourceStatusResponseCounts$inboundSchema = objectType({ - uploaded: arrayType(DatasourceObjectTypeDocumentCountEntry$inboundSchema).optional(), - indexed: arrayType(DatasourceObjectTypeDocumentCountEntry$inboundSchema).optional() - }); - var DebugDatasourceStatusResponseCounts$outboundSchema = objectType({ - uploaded: arrayType(DatasourceObjectTypeDocumentCountEntry$outboundSchema).optional(), - indexed: arrayType(DatasourceObjectTypeDocumentCountEntry$outboundSchema).optional() - }); - var DebugDatasourceStatusResponseCounts$; - (function(DebugDatasourceStatusResponseCounts$2) { - DebugDatasourceStatusResponseCounts$2.inboundSchema = DebugDatasourceStatusResponseCounts$inboundSchema; - DebugDatasourceStatusResponseCounts$2.outboundSchema = DebugDatasourceStatusResponseCounts$outboundSchema; - })(DebugDatasourceStatusResponseCounts$ || (DebugDatasourceStatusResponseCounts$ = {})); - var Documents$inboundSchema = objectType({ - bulkUploadHistory: arrayType(BulkUploadHistoryEvent$inboundSchema).optional(), - counts: lazyType(() => DebugDatasourceStatusResponseCounts$inboundSchema).optional(), - processingHistory: arrayType(ProcessingHistoryEvent$inboundSchema).optional() - }); - var Documents$outboundSchema = objectType({ - bulkUploadHistory: arrayType(BulkUploadHistoryEvent$outboundSchema).optional(), - counts: lazyType(() => DebugDatasourceStatusResponseCounts$outboundSchema).optional(), - processingHistory: arrayType(ProcessingHistoryEvent$outboundSchema).optional() - }); - var Documents$; - (function(Documents$2) { - Documents$2.inboundSchema = Documents$inboundSchema; - Documents$2.outboundSchema = Documents$outboundSchema; - })(Documents$ || (Documents$ = {})); - var Identity$inboundSchema = objectType({ - processingHistory: arrayType(ProcessingHistoryEvent$inboundSchema).optional(), - users: DebugDatasourceStatusIdentityResponseComponent$inboundSchema.optional(), - groups: DebugDatasourceStatusIdentityResponseComponent$inboundSchema.optional(), - memberships: DebugDatasourceStatusIdentityResponseComponent$inboundSchema.optional() - }); - var Identity$outboundSchema = objectType({ - processingHistory: arrayType(ProcessingHistoryEvent$outboundSchema).optional(), - users: DebugDatasourceStatusIdentityResponseComponent$outboundSchema.optional(), - groups: DebugDatasourceStatusIdentityResponseComponent$outboundSchema.optional(), - memberships: DebugDatasourceStatusIdentityResponseComponent$outboundSchema.optional() - }); - var Identity$; - (function(Identity$2) { - Identity$2.inboundSchema = Identity$inboundSchema; - Identity$2.outboundSchema = Identity$outboundSchema; - })(Identity$ || (Identity$ = {})); - var DatasourceVisibility$inboundSchema = nativeEnumType(DatasourceVisibility); - var DatasourceVisibility$outboundSchema = DatasourceVisibility$inboundSchema; - var DatasourceVisibility$; - (function(DatasourceVisibility$2) { - DatasourceVisibility$2.inboundSchema = DatasourceVisibility$inboundSchema; - DatasourceVisibility$2.outboundSchema = DatasourceVisibility$outboundSchema; - })(DatasourceVisibility$ || (DatasourceVisibility$ = {})); - var DebugDatasourceStatusResponse$inboundSchema = objectType({ - documents: lazyType(() => Documents$inboundSchema).optional(), - identity: lazyType(() => Identity$inboundSchema).optional(), - datasourceVisibility: DatasourceVisibility$inboundSchema.optional() - }); - var DebugDatasourceStatusResponse$outboundSchema = objectType({ - documents: lazyType(() => Documents$outboundSchema).optional(), - identity: lazyType(() => Identity$outboundSchema).optional(), - datasourceVisibility: DatasourceVisibility$outboundSchema.optional() - }); - var DebugDatasourceStatusResponse$; - (function(DebugDatasourceStatusResponse$2) { - DebugDatasourceStatusResponse$2.inboundSchema = DebugDatasourceStatusResponse$inboundSchema; - DebugDatasourceStatusResponse$2.outboundSchema = DebugDatasourceStatusResponse$outboundSchema; - })(DebugDatasourceStatusResponse$ || (DebugDatasourceStatusResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdocumentrequest.js - var DebugDocumentRequest$inboundSchema = objectType({ - objectType: stringType(), - docId: stringType() - }); - var DebugDocumentRequest$outboundSchema = objectType({ - objectType: stringType(), - docId: stringType() - }); - var DebugDocumentRequest$; - (function(DebugDocumentRequest$2) { - DebugDocumentRequest$2.inboundSchema = DebugDocumentRequest$inboundSchema; - DebugDocumentRequest$2.outboundSchema = DebugDocumentRequest$outboundSchema; - })(DebugDocumentRequest$ || (DebugDocumentRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentstatusresponse.js - var DocumentStatusResponse$inboundSchema = objectType({ - uploadStatus: stringType().optional(), - lastUploadedAt: stringType().optional(), - indexingStatus: stringType().optional(), - lastIndexedAt: stringType().optional(), - permissionIdentityStatus: stringType().optional() - }); - var DocumentStatusResponse$outboundSchema = objectType({ - uploadStatus: stringType().optional(), - lastUploadedAt: stringType().optional(), - indexingStatus: stringType().optional(), - lastIndexedAt: stringType().optional(), - permissionIdentityStatus: stringType().optional() - }); - var DocumentStatusResponse$; - (function(DocumentStatusResponse$2) { - DocumentStatusResponse$2.inboundSchema = DocumentStatusResponse$inboundSchema; - DocumentStatusResponse$2.outboundSchema = DocumentStatusResponse$outboundSchema; - })(DocumentStatusResponse$ || (DocumentStatusResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdocumentresponse.js - var DebugDocumentResponse$inboundSchema = objectType({ - status: DocumentStatusResponse$inboundSchema.optional(), - uploadedPermissions: DocumentPermissionsDefinition$inboundSchema.optional() - }); - var DebugDocumentResponse$outboundSchema = objectType({ - status: DocumentStatusResponse$outboundSchema.optional(), - uploadedPermissions: DocumentPermissionsDefinition$outboundSchema.optional() - }); - var DebugDocumentResponse$; - (function(DebugDocumentResponse$2) { - DebugDocumentResponse$2.inboundSchema = DebugDocumentResponse$inboundSchema; - DebugDocumentResponse$2.outboundSchema = DebugDocumentResponse$outboundSchema; - })(DebugDocumentResponse$ || (DebugDocumentResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdocumentsrequest.js - var DebugDocumentsRequest$inboundSchema = objectType({ - debugDocuments: arrayType(DebugDocumentRequest$inboundSchema) - }); - var DebugDocumentsRequest$outboundSchema = objectType({ - debugDocuments: arrayType(DebugDocumentRequest$outboundSchema) - }); - var DebugDocumentsRequest$; - (function(DebugDocumentsRequest$2) { - DebugDocumentsRequest$2.inboundSchema = DebugDocumentsRequest$inboundSchema; - DebugDocumentsRequest$2.outboundSchema = DebugDocumentsRequest$outboundSchema; - })(DebugDocumentsRequest$ || (DebugDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdocumentsresponseitem.js - var DebugDocumentsResponseItem$inboundSchema = objectType({ - docId: stringType().optional(), - objectType: stringType().optional(), - debugInfo: DebugDocumentResponse$inboundSchema.optional() - }); - var DebugDocumentsResponseItem$outboundSchema = objectType({ - docId: stringType().optional(), - objectType: stringType().optional(), - debugInfo: DebugDocumentResponse$outboundSchema.optional() - }); - var DebugDocumentsResponseItem$; - (function(DebugDocumentsResponseItem$2) { - DebugDocumentsResponseItem$2.inboundSchema = DebugDocumentsResponseItem$inboundSchema; - DebugDocumentsResponseItem$2.outboundSchema = DebugDocumentsResponseItem$outboundSchema; - })(DebugDocumentsResponseItem$ || (DebugDocumentsResponseItem$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debugdocumentsresponse.js - var DebugDocumentsResponse$inboundSchema = objectType({ - documentStatuses: arrayType(DebugDocumentsResponseItem$inboundSchema).optional() - }); - var DebugDocumentsResponse$outboundSchema = objectType({ - documentStatuses: arrayType(DebugDocumentsResponseItem$outboundSchema).optional() - }); - var DebugDocumentsResponse$; - (function(DebugDocumentsResponse$2) { - DebugDocumentsResponse$2.inboundSchema = DebugDocumentsResponse$inboundSchema; - DebugDocumentsResponse$2.outboundSchema = DebugDocumentsResponse$outboundSchema; - })(DebugDocumentsResponse$ || (DebugDocumentsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debuguserrequest.js - var DebugUserRequest$inboundSchema = objectType({ - email: stringType() - }); - var DebugUserRequest$outboundSchema = objectType({ - email: stringType() - }); - var DebugUserRequest$; - (function(DebugUserRequest$2) { - DebugUserRequest$2.inboundSchema = DebugUserRequest$inboundSchema; - DebugUserRequest$2.outboundSchema = DebugUserRequest$outboundSchema; - })(DebugUserRequest$ || (DebugUserRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/uploadstatusenum.js - var UploadStatusEnum = { - Uploaded: "UPLOADED", - NotUploaded: "NOT_UPLOADED", - StatusUnknown: "STATUS_UNKNOWN" - }; - var UploadStatusEnum$inboundSchema = nativeEnumType(UploadStatusEnum); - var UploadStatusEnum$outboundSchema = UploadStatusEnum$inboundSchema; - var UploadStatusEnum$; - (function(UploadStatusEnum$2) { - UploadStatusEnum$2.inboundSchema = UploadStatusEnum$inboundSchema; - UploadStatusEnum$2.outboundSchema = UploadStatusEnum$outboundSchema; - })(UploadStatusEnum$ || (UploadStatusEnum$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userstatusresponse.js - var UserStatusResponse$inboundSchema = objectType({ - isActiveUser: booleanType().optional(), - uploadStatus: UploadStatusEnum$inboundSchema.optional(), - lastUploadedAt: stringType().optional() - }); - var UserStatusResponse$outboundSchema = objectType({ - isActiveUser: booleanType().optional(), - uploadStatus: UploadStatusEnum$outboundSchema.optional(), - lastUploadedAt: stringType().optional() - }); - var UserStatusResponse$; - (function(UserStatusResponse$2) { - UserStatusResponse$2.inboundSchema = UserStatusResponse$inboundSchema; - UserStatusResponse$2.outboundSchema = UserStatusResponse$outboundSchema; - })(UserStatusResponse$ || (UserStatusResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/debuguserresponse.js - var DebugUserResponse$inboundSchema = objectType({ - status: UserStatusResponse$inboundSchema.optional(), - uploadedGroups: arrayType(DatasourceGroupDefinition$inboundSchema).optional() - }); - var DebugUserResponse$outboundSchema = objectType({ - status: UserStatusResponse$outboundSchema.optional(), - uploadedGroups: arrayType(DatasourceGroupDefinition$outboundSchema).optional() - }); - var DebugUserResponse$; - (function(DebugUserResponse$2) { - DebugUserResponse$2.inboundSchema = DebugUserResponse$inboundSchema; - DebugUserResponse$2.outboundSchema = DebugUserResponse$outboundSchema; - })(DebugUserResponse$ || (DebugUserResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteannouncementrequest.js - var DeleteAnnouncementRequest$inboundSchema = objectType({ - id: numberType().int() - }); - var DeleteAnnouncementRequest$outboundSchema = objectType({ - id: numberType().int() - }); - var DeleteAnnouncementRequest$; - (function(DeleteAnnouncementRequest$2) { - DeleteAnnouncementRequest$2.inboundSchema = DeleteAnnouncementRequest$inboundSchema; - DeleteAnnouncementRequest$2.outboundSchema = DeleteAnnouncementRequest$outboundSchema; - })(DeleteAnnouncementRequest$ || (DeleteAnnouncementRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteanswerrequest.js - var DeleteAnswerRequest$inboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional() - }); - var DeleteAnswerRequest$outboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional() - }); - var DeleteAnswerRequest$; - (function(DeleteAnswerRequest$2) { - DeleteAnswerRequest$2.inboundSchema = DeleteAnswerRequest$inboundSchema; - DeleteAnswerRequest$2.outboundSchema = DeleteAnswerRequest$outboundSchema; - })(DeleteAnswerRequest$ || (DeleteAnswerRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletechatfilesrequest.js - var DeleteChatFilesRequest$inboundSchema = objectType({ - fileIds: arrayType(stringType()) - }); - var DeleteChatFilesRequest$outboundSchema = objectType({ - fileIds: arrayType(stringType()) - }); - var DeleteChatFilesRequest$; - (function(DeleteChatFilesRequest$2) { - DeleteChatFilesRequest$2.inboundSchema = DeleteChatFilesRequest$inboundSchema; - DeleteChatFilesRequest$2.outboundSchema = DeleteChatFilesRequest$outboundSchema; - })(DeleteChatFilesRequest$ || (DeleteChatFilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletechatsrequest.js - var DeleteChatsRequest$inboundSchema = objectType({ - ids: arrayType(stringType()) - }); - var DeleteChatsRequest$outboundSchema = objectType({ - ids: arrayType(stringType()) - }); - var DeleteChatsRequest$; - (function(DeleteChatsRequest$2) { - DeleteChatsRequest$2.inboundSchema = DeleteChatsRequest$inboundSchema; - DeleteChatsRequest$2.outboundSchema = DeleteChatsRequest$outboundSchema; - })(DeleteChatsRequest$ || (DeleteChatsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletecollectionitemrequest.js - var DeleteCollectionItemRequest$inboundSchema = objectType({ - collectionId: numberType(), - itemId: stringType(), - documentId: stringType().optional() - }); - var DeleteCollectionItemRequest$outboundSchema = objectType({ - collectionId: numberType(), - itemId: stringType(), - documentId: stringType().optional() - }); - var DeleteCollectionItemRequest$; - (function(DeleteCollectionItemRequest$2) { - DeleteCollectionItemRequest$2.inboundSchema = DeleteCollectionItemRequest$inboundSchema; - DeleteCollectionItemRequest$2.outboundSchema = DeleteCollectionItemRequest$outboundSchema; - })(DeleteCollectionItemRequest$ || (DeleteCollectionItemRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletecollectionitemresponse.js - var DeleteCollectionItemResponse$inboundSchema = objectType({ - collection: Collection$inboundSchema.optional() - }); - var DeleteCollectionItemResponse$outboundSchema = objectType({ - collection: Collection$outboundSchema.optional() - }); - var DeleteCollectionItemResponse$; - (function(DeleteCollectionItemResponse$2) { - DeleteCollectionItemResponse$2.inboundSchema = DeleteCollectionItemResponse$inboundSchema; - DeleteCollectionItemResponse$2.outboundSchema = DeleteCollectionItemResponse$outboundSchema; - })(DeleteCollectionItemResponse$ || (DeleteCollectionItemResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletecollectionrequest.js - var DeleteCollectionRequest$inboundSchema = objectType({ - ids: arrayType(numberType().int()), - allowedDatasource: stringType().optional() - }); - var DeleteCollectionRequest$outboundSchema = objectType({ - ids: arrayType(numberType().int()), - allowedDatasource: stringType().optional() - }); - var DeleteCollectionRequest$; - (function(DeleteCollectionRequest$2) { - DeleteCollectionRequest$2.inboundSchema = DeleteCollectionRequest$inboundSchema; - DeleteCollectionRequest$2.outboundSchema = DeleteCollectionRequest$outboundSchema; - })(DeleteCollectionRequest$ || (DeleteCollectionRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletedocumentrequest.js - var DeleteDocumentRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - objectType: stringType(), - id: stringType() - }); - var DeleteDocumentRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - objectType: stringType(), - id: stringType() - }); - var DeleteDocumentRequest$; - (function(DeleteDocumentRequest$2) { - DeleteDocumentRequest$2.inboundSchema = DeleteDocumentRequest$inboundSchema; - DeleteDocumentRequest$2.outboundSchema = DeleteDocumentRequest$outboundSchema; - })(DeleteDocumentRequest$ || (DeleteDocumentRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteemployeerequest.js - var DeleteEmployeeRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - employeeEmail: stringType() - }); - var DeleteEmployeeRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - employeeEmail: stringType() - }); - var DeleteEmployeeRequest$; - (function(DeleteEmployeeRequest$2) { - DeleteEmployeeRequest$2.inboundSchema = DeleteEmployeeRequest$inboundSchema; - DeleteEmployeeRequest$2.outboundSchema = DeleteEmployeeRequest$outboundSchema; - })(DeleteEmployeeRequest$ || (DeleteEmployeeRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletegrouprequest.js - var DeleteGroupRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - groupName: stringType() - }); - var DeleteGroupRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - groupName: stringType() - }); - var DeleteGroupRequest$; - (function(DeleteGroupRequest$2) { - DeleteGroupRequest$2.inboundSchema = DeleteGroupRequest$inboundSchema; - DeleteGroupRequest$2.outboundSchema = DeleteGroupRequest$outboundSchema; - })(DeleteGroupRequest$ || (DeleteGroupRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deletemembershiprequest.js - var DeleteMembershipRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - membership: DatasourceMembershipDefinition$inboundSchema - }); - var DeleteMembershipRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - membership: DatasourceMembershipDefinition$outboundSchema - }); - var DeleteMembershipRequest$; - (function(DeleteMembershipRequest$2) { - DeleteMembershipRequest$2.inboundSchema = DeleteMembershipRequest$inboundSchema; - DeleteMembershipRequest$2.outboundSchema = DeleteMembershipRequest$outboundSchema; - })(DeleteMembershipRequest$ || (DeleteMembershipRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteshortcutrequest.js - var DeleteShortcutRequest$inboundSchema = objectType({ - id: numberType().int() - }); - var DeleteShortcutRequest$outboundSchema = objectType({ - id: numberType().int() - }); - var DeleteShortcutRequest$; - (function(DeleteShortcutRequest$2) { - DeleteShortcutRequest$2.inboundSchema = DeleteShortcutRequest$inboundSchema; - DeleteShortcutRequest$2.outboundSchema = DeleteShortcutRequest$outboundSchema; - })(DeleteShortcutRequest$ || (DeleteShortcutRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteteamrequest.js - var DeleteTeamRequest$inboundSchema = objectType({ - id: stringType() - }); - var DeleteTeamRequest$outboundSchema = objectType({ - id: stringType() - }); - var DeleteTeamRequest$; - (function(DeleteTeamRequest$2) { - DeleteTeamRequest$2.inboundSchema = DeleteTeamRequest$inboundSchema; - DeleteTeamRequest$2.outboundSchema = DeleteTeamRequest$outboundSchema; - })(DeleteTeamRequest$ || (DeleteTeamRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/deleteuserrequest.js - var DeleteUserRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - email: stringType() - }); - var DeleteUserRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - email: stringType() - }); - var DeleteUserRequest$; - (function(DeleteUserRequest$2) { - DeleteUserRequest$2.inboundSchema = DeleteUserRequest$inboundSchema; - DeleteUserRequest$2.outboundSchema = DeleteUserRequest$outboundSchema; - })(DeleteUserRequest$ || (DeleteUserRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatetype.js - var UpdateType = { - Actionable: "ACTIONABLE", - Informative: "INFORMATIVE" - }; - var UpdateType$inboundSchema = nativeEnumType(UpdateType); - var UpdateType$outboundSchema = UpdateType$inboundSchema; - var UpdateType$; - (function(UpdateType$2) { - UpdateType$2.inboundSchema = UpdateType$inboundSchema; - UpdateType$2.outboundSchema = UpdateType$outboundSchema; - })(UpdateType$ || (UpdateType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/digestupdate.js - var DigestUpdate$inboundSchema = objectType({ - url: stringType().optional(), - title: stringType().optional(), - datasource: stringType().optional(), - summary: stringType().optional(), - type: UpdateType$inboundSchema.optional() - }); - var DigestUpdate$outboundSchema = objectType({ - url: stringType().optional(), - title: stringType().optional(), - datasource: stringType().optional(), - summary: stringType().optional(), - type: UpdateType$outboundSchema.optional() - }); - var DigestUpdate$; - (function(DigestUpdate$2) { - DigestUpdate$2.inboundSchema = DigestUpdate$inboundSchema; - DigestUpdate$2.outboundSchema = DigestUpdate$outboundSchema; - })(DigestUpdate$ || (DigestUpdate$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sectiontype.js - var SectionType = { - Channel: "CHANNEL", - Mentions: "MENTIONS", - Topic: "TOPIC" - }; - var SectionType$inboundSchema = nativeEnumType(SectionType); - var SectionType$outboundSchema = SectionType$inboundSchema; - var SectionType$; - (function(SectionType$2) { - SectionType$2.inboundSchema = SectionType$inboundSchema; - SectionType$2.outboundSchema = SectionType$outboundSchema; - })(SectionType$ || (SectionType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/digestsection.js - var DigestSection$inboundSchema = objectType({ - id: stringType(), - type: SectionType$inboundSchema, - displayName: stringType().optional(), - channelName: stringType().optional(), - channelType: stringType().optional(), - instanceId: stringType().optional(), - url: stringType().optional(), - updates: arrayType(DigestUpdate$inboundSchema) - }); - var DigestSection$outboundSchema = objectType({ - id: stringType(), - type: SectionType$outboundSchema, - displayName: stringType().optional(), - channelName: stringType().optional(), - channelType: stringType().optional(), - instanceId: stringType().optional(), - url: stringType().optional(), - updates: arrayType(DigestUpdate$outboundSchema) - }); - var DigestSection$; - (function(DigestSection$2) { - DigestSection$2.inboundSchema = DigestSection$inboundSchema; - DigestSection$2.outboundSchema = DigestSection$outboundSchema; - })(DigestSection$ || (DigestSection$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/digest.js - var Digest$inboundSchema = objectType({ - podcastFileId: stringType().optional(), - podcastDuration: numberType().optional(), - digestDate: stringType().optional(), - sections: arrayType(DigestSection$inboundSchema).optional() - }); - var Digest$outboundSchema = objectType({ - podcastFileId: stringType().optional(), - podcastDuration: numberType().optional(), - digestDate: stringType().optional(), - sections: arrayType(DigestSection$outboundSchema).optional() - }); - var Digest$; - (function(Digest$2) { - Digest$2.inboundSchema = Digest$inboundSchema; - Digest$2.outboundSchema = Digest$outboundSchema; - })(Digest$ || (Digest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/displayablelistitemuiconfig.js - var DisplayableListItemUIConfig$inboundSchema = objectType({ - showNewIndicator: booleanType().optional() - }); - var DisplayableListItemUIConfig$outboundSchema = objectType({ - showNewIndicator: booleanType().optional() - }); - var DisplayableListItemUIConfig$; - (function(DisplayableListItemUIConfig$2) { - DisplayableListItemUIConfig$2.inboundSchema = DisplayableListItemUIConfig$inboundSchema; - DisplayableListItemUIConfig$2.outboundSchema = DisplayableListItemUIConfig$outboundSchema; - })(DisplayableListItemUIConfig$ || (DisplayableListItemUIConfig$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/dlpsimpleresult.js - var DlpSimpleResult = { - Success: "SUCCESS", - Failure: "FAILURE" - }; - var DlpSimpleResult$inboundSchema = nativeEnumType(DlpSimpleResult); - var DlpSimpleResult$outboundSchema = DlpSimpleResult$inboundSchema; - var DlpSimpleResult$; - (function(DlpSimpleResult$2) { - DlpSimpleResult$2.inboundSchema = DlpSimpleResult$inboundSchema; - DlpSimpleResult$2.outboundSchema = DlpSimpleResult$outboundSchema; - })(DlpSimpleResult$ || (DlpSimpleResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentorerrorunion.js - var DocumentOrError$inboundSchema = objectType({ - error: stringType().optional() - }); - var DocumentOrError$outboundSchema = objectType({ - error: stringType().optional() - }); - var DocumentOrError$; - (function(DocumentOrError$2) { - DocumentOrError$2.inboundSchema = DocumentOrError$inboundSchema; - DocumentOrError$2.outboundSchema = DocumentOrError$outboundSchema; - })(DocumentOrError$ || (DocumentOrError$ = {})); - var DocumentOrErrorUnion$inboundSchema = unionType([ - Document$inboundSchema, - lazyType(() => DocumentOrError$inboundSchema) - ]); - var DocumentOrErrorUnion$outboundSchema = unionType([ - Document$outboundSchema, - lazyType(() => DocumentOrError$outboundSchema) - ]); - var DocumentOrErrorUnion$; - (function(DocumentOrErrorUnion$2) { - DocumentOrErrorUnion$2.inboundSchema = DocumentOrErrorUnion$inboundSchema; - DocumentOrErrorUnion$2.outboundSchema = DocumentOrErrorUnion$outboundSchema; - })(DocumentOrErrorUnion$ || (DocumentOrErrorUnion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentvisibilityoverride.js - var DocumentVisibilityOverrideOverride = { - None: "NONE", - HideFromAll: "HIDE_FROM_ALL", - HideFromGroups: "HIDE_FROM_GROUPS", - HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER" - }; - var DocumentVisibilityOverrideOverride$inboundSchema = nativeEnumType(DocumentVisibilityOverrideOverride); - var DocumentVisibilityOverrideOverride$outboundSchema = DocumentVisibilityOverrideOverride$inboundSchema; - var DocumentVisibilityOverrideOverride$; - (function(DocumentVisibilityOverrideOverride$2) { - DocumentVisibilityOverrideOverride$2.inboundSchema = DocumentVisibilityOverrideOverride$inboundSchema; - DocumentVisibilityOverrideOverride$2.outboundSchema = DocumentVisibilityOverrideOverride$outboundSchema; - })(DocumentVisibilityOverrideOverride$ || (DocumentVisibilityOverrideOverride$ = {})); - var DocumentVisibilityOverride$inboundSchema = objectType({ - docId: stringType().optional(), - override: DocumentVisibilityOverrideOverride$inboundSchema.optional() - }); - var DocumentVisibilityOverride$outboundSchema = objectType({ - docId: stringType().optional(), - override: DocumentVisibilityOverrideOverride$outboundSchema.optional() - }); - var DocumentVisibilityOverride$; - (function(DocumentVisibilityOverride$2) { - DocumentVisibilityOverride$2.inboundSchema = DocumentVisibilityOverride$inboundSchema; - DocumentVisibilityOverride$2.outboundSchema = DocumentVisibilityOverride$outboundSchema; - })(DocumentVisibilityOverride$ || (DocumentVisibilityOverride$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/documentvisibilityupdateresult.js - var DocumentVisibilityUpdateResultOverride = { - None: "NONE", - HideFromAll: "HIDE_FROM_ALL", - HideFromGroups: "HIDE_FROM_GROUPS", - HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER" - }; - var DocumentVisibilityUpdateResultOverride$inboundSchema = nativeEnumType(DocumentVisibilityUpdateResultOverride); - var DocumentVisibilityUpdateResultOverride$outboundSchema = DocumentVisibilityUpdateResultOverride$inboundSchema; - var DocumentVisibilityUpdateResultOverride$; - (function(DocumentVisibilityUpdateResultOverride$2) { - DocumentVisibilityUpdateResultOverride$2.inboundSchema = DocumentVisibilityUpdateResultOverride$inboundSchema; - DocumentVisibilityUpdateResultOverride$2.outboundSchema = DocumentVisibilityUpdateResultOverride$outboundSchema; - })(DocumentVisibilityUpdateResultOverride$ || (DocumentVisibilityUpdateResultOverride$ = {})); - var DocumentVisibilityUpdateResult$inboundSchema = objectType({ - docId: stringType().optional(), - override: DocumentVisibilityUpdateResultOverride$inboundSchema.optional(), - success: booleanType().optional() - }); - var DocumentVisibilityUpdateResult$outboundSchema = objectType({ - docId: stringType().optional(), - override: DocumentVisibilityUpdateResultOverride$outboundSchema.optional(), - success: booleanType().optional() - }); - var DocumentVisibilityUpdateResult$; - (function(DocumentVisibilityUpdateResult$2) { - DocumentVisibilityUpdateResult$2.inboundSchema = DocumentVisibilityUpdateResult$inboundSchema; - DocumentVisibilityUpdateResult$2.outboundSchema = DocumentVisibilityUpdateResult$outboundSchema; - })(DocumentVisibilityUpdateResult$ || (DocumentVisibilityUpdateResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editanswerrequest.js - var EditAnswerRequestSourceType = { - Document: "DOCUMENT", - Assistant: "ASSISTANT" - }; - var EditAnswerRequestSourceType$inboundSchema = nativeEnumType(EditAnswerRequestSourceType); - var EditAnswerRequestSourceType$outboundSchema = EditAnswerRequestSourceType$inboundSchema; - var EditAnswerRequestSourceType$; - (function(EditAnswerRequestSourceType$2) { - EditAnswerRequestSourceType$2.inboundSchema = EditAnswerRequestSourceType$inboundSchema; - EditAnswerRequestSourceType$2.outboundSchema = EditAnswerRequestSourceType$outboundSchema; - })(EditAnswerRequestSourceType$ || (EditAnswerRequestSourceType$ = {})); - var EditAnswerRequest$inboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional(), - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - roles: arrayType(UserRoleSpecification$inboundSchema).optional(), - sourceDocumentSpec: DocumentSpecUnion$inboundSchema.optional(), - sourceType: EditAnswerRequestSourceType$inboundSchema.optional(), - addedCollections: arrayType(numberType().int()).optional(), - removedCollections: arrayType(numberType().int()).optional(), - combinedAnswerText: StructuredTextMutableProperties$inboundSchema.optional() - }); - var EditAnswerRequest$outboundSchema = objectType({ - id: numberType().int(), - docId: stringType().optional(), - question: stringType().optional(), - questionVariations: arrayType(stringType()).optional(), - bodyText: stringType().optional(), - boardId: numberType().int().optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - roles: arrayType(UserRoleSpecification$outboundSchema).optional(), - sourceDocumentSpec: DocumentSpecUnion$outboundSchema.optional(), - sourceType: EditAnswerRequestSourceType$outboundSchema.optional(), - addedCollections: arrayType(numberType().int()).optional(), - removedCollections: arrayType(numberType().int()).optional(), - combinedAnswerText: StructuredTextMutableProperties$outboundSchema.optional() - }); - var EditAnswerRequest$; - (function(EditAnswerRequest$2) { - EditAnswerRequest$2.inboundSchema = EditAnswerRequest$inboundSchema; - EditAnswerRequest$2.outboundSchema = EditAnswerRequest$outboundSchema; - })(EditAnswerRequest$ || (EditAnswerRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editcollectionitemrequest.js - var EditCollectionItemRequest$inboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - collectionId: numberType().int(), - itemId: stringType() - }); - var EditCollectionItemRequest$outboundSchema = objectType({ - name: stringType().optional(), - description: stringType().optional(), - icon: stringType().optional(), - collectionId: numberType().int(), - itemId: stringType() - }); - var EditCollectionItemRequest$; - (function(EditCollectionItemRequest$2) { - EditCollectionItemRequest$2.inboundSchema = EditCollectionItemRequest$inboundSchema; - EditCollectionItemRequest$2.outboundSchema = EditCollectionItemRequest$outboundSchema; - })(EditCollectionItemRequest$ || (EditCollectionItemRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editcollectionitemresponse.js - var EditCollectionItemResponse$inboundSchema = objectType({ - collection: Collection$inboundSchema.optional() - }); - var EditCollectionItemResponse$outboundSchema = objectType({ - collection: Collection$outboundSchema.optional() - }); - var EditCollectionItemResponse$; - (function(EditCollectionItemResponse$2) { - EditCollectionItemResponse$2.inboundSchema = EditCollectionItemResponse$inboundSchema; - EditCollectionItemResponse$2.outboundSchema = EditCollectionItemResponse$outboundSchema; - })(EditCollectionItemResponse$ || (EditCollectionItemResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editcollectionrequest.js - var EditCollectionRequest$inboundSchema = objectType({ - name: stringType(), - description: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - allowedDatasource: stringType().optional(), - id: numberType().int() - }); - var EditCollectionRequest$outboundSchema = objectType({ - name: stringType(), - description: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - allowedDatasource: stringType().optional(), - id: numberType().int() - }); - var EditCollectionRequest$; - (function(EditCollectionRequest$2) { - EditCollectionRequest$2.inboundSchema = EditCollectionRequest$inboundSchema; - EditCollectionRequest$2.outboundSchema = EditCollectionRequest$outboundSchema; - })(EditCollectionRequest$ || (EditCollectionRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editcollectionresponse.js - var EditCollectionResponseErrorCode = { - NameExists: "NAME_EXISTS", - NotFound: "NOT_FOUND", - CollectionPinned: "COLLECTION_PINNED", - ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT", - HeightViolation: "HEIGHT_VIOLATION", - WidthViolation: "WIDTH_VIOLATION", - NoPermissions: "NO_PERMISSIONS" - }; - var EditCollectionResponseErrorCode$inboundSchema = nativeEnumType(EditCollectionResponseErrorCode); - var EditCollectionResponseErrorCode$outboundSchema = EditCollectionResponseErrorCode$inboundSchema; - var EditCollectionResponseErrorCode$; - (function(EditCollectionResponseErrorCode$2) { - EditCollectionResponseErrorCode$2.inboundSchema = EditCollectionResponseErrorCode$inboundSchema; - EditCollectionResponseErrorCode$2.outboundSchema = EditCollectionResponseErrorCode$outboundSchema; - })(EditCollectionResponseErrorCode$ || (EditCollectionResponseErrorCode$ = {})); - var EditCollectionResponse$inboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - allowedDatasource: stringType().optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: numberType().int(), - createTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - updateTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - creator: Person$inboundSchema.optional(), - updatedBy: Person$inboundSchema.optional(), - itemCount: numberType().int().optional(), - childCount: numberType().int().optional(), - items: arrayType(CollectionItem$inboundSchema).optional(), - pinMetadata: CollectionPinnedMetadata$inboundSchema.optional(), - shortcuts: arrayType(stringType()).optional(), - children: arrayType(Collection$inboundSchema).optional(), - roles: arrayType(UserRoleSpecification$inboundSchema).optional(), - errorCode: EditCollectionResponseErrorCode$inboundSchema, - collection: Collection$inboundSchema.optional(), - error: CollectionError$inboundSchema.optional() - }); - var EditCollectionResponse$outboundSchema = objectType({ - name: stringType(), - description: stringType(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - icon: stringType().optional(), - adminLocked: booleanType().optional(), - parentId: numberType().int().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - allowedDatasource: stringType().optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: numberType().int(), - createTime: dateType().transform((v) => v.toISOString()).optional(), - updateTime: dateType().transform((v) => v.toISOString()).optional(), - creator: Person$outboundSchema.optional(), - updatedBy: Person$outboundSchema.optional(), - itemCount: numberType().int().optional(), - childCount: numberType().int().optional(), - items: arrayType(CollectionItem$outboundSchema).optional(), - pinMetadata: CollectionPinnedMetadata$outboundSchema.optional(), - shortcuts: arrayType(stringType()).optional(), - children: arrayType(Collection$outboundSchema).optional(), - roles: arrayType(UserRoleSpecification$outboundSchema).optional(), - errorCode: EditCollectionResponseErrorCode$outboundSchema, - collection: Collection$outboundSchema.optional(), - error: CollectionError$outboundSchema.optional() - }); - var EditCollectionResponse$; - (function(EditCollectionResponse$2) { - EditCollectionResponse$2.inboundSchema = EditCollectionResponse$inboundSchema; - EditCollectionResponse$2.outboundSchema = EditCollectionResponse$outboundSchema; - })(EditCollectionResponse$ || (EditCollectionResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/editpinrequest.js - var EditPinRequest$inboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - id: stringType().optional() - }); - var EditPinRequest$outboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - id: stringType().optional() - }); - var EditPinRequest$; - (function(EditPinRequest$2) { - EditPinRequest$2.inboundSchema = EditPinRequest$inboundSchema; - EditPinRequest$2.outboundSchema = EditPinRequest$outboundSchema; - })(EditPinRequest$ || (EditPinRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/entitiessortorder.js - var EntitiesSortOrder = { - EntityName: "ENTITY_NAME", - FirstName: "FIRST_NAME", - LastName: "LAST_NAME", - OrgSizeCount: "ORG_SIZE_COUNT", - StartDate: "START_DATE", - TeamSize: "TEAM_SIZE", - Relevance: "RELEVANCE" - }; - var EntitiesSortOrder$inboundSchema = nativeEnumType(EntitiesSortOrder); - var EntitiesSortOrder$outboundSchema = EntitiesSortOrder$inboundSchema; - var EntitiesSortOrder$; - (function(EntitiesSortOrder$2) { - EntitiesSortOrder$2.inboundSchema = EntitiesSortOrder$inboundSchema; - EntitiesSortOrder$2.outboundSchema = EntitiesSortOrder$outboundSchema; - })(EntitiesSortOrder$ || (EntitiesSortOrder$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetvalue.js - var FacetValue$inboundSchema = objectType({ - stringValue: stringType().optional(), - integerValue: numberType().int().optional(), - displayLabel: stringType().optional(), - iconConfig: IconConfig$inboundSchema.optional() - }); - var FacetValue$outboundSchema = objectType({ - stringValue: stringType().optional(), - integerValue: numberType().int().optional(), - displayLabel: stringType().optional(), - iconConfig: IconConfig$outboundSchema.optional() - }); - var FacetValue$; - (function(FacetValue$2) { - FacetValue$2.inboundSchema = FacetValue$inboundSchema; - FacetValue$2.outboundSchema = FacetValue$outboundSchema; - })(FacetValue$ || (FacetValue$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetbucket.js - var FacetBucket$inboundSchema = objectType({ - count: numberType().int().optional(), - datasource: stringType().optional(), - percentage: numberType().int().optional(), - value: FacetValue$inboundSchema.optional() - }); - var FacetBucket$outboundSchema = objectType({ - count: numberType().int().optional(), - datasource: stringType().optional(), - percentage: numberType().int().optional(), - value: FacetValue$outboundSchema.optional() - }); - var FacetBucket$; - (function(FacetBucket$2) { - FacetBucket$2.inboundSchema = FacetBucket$inboundSchema; - FacetBucket$2.outboundSchema = FacetBucket$outboundSchema; - })(FacetBucket$ || (FacetBucket$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/facetresult.js - var FacetResult$inboundSchema = objectType({ - sourceName: stringType().optional(), - operatorName: stringType().optional(), - buckets: arrayType(FacetBucket$inboundSchema).optional(), - hasMoreBuckets: booleanType().optional(), - groupName: stringType().optional() - }); - var FacetResult$outboundSchema = objectType({ - sourceName: stringType().optional(), - operatorName: stringType().optional(), - buckets: arrayType(FacetBucket$outboundSchema).optional(), - hasMoreBuckets: booleanType().optional(), - groupName: stringType().optional() - }); - var FacetResult$; - (function(FacetResult$2) { - FacetResult$2.inboundSchema = FacetResult$inboundSchema; - FacetResult$2.outboundSchema = FacetResult$outboundSchema; - })(FacetResult$ || (FacetResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/ugctype.js - var UgcType = { - AnnouncementsType: "ANNOUNCEMENTS_TYPE", - AnswersType: "ANSWERS_TYPE", - CollectionsType: "COLLECTIONS_TYPE", - ShortcutsType: "SHORTCUTS_TYPE", - WorkflowsType: "WORKFLOWS_TYPE", - PromptTemplatesType: "PROMPT_TEMPLATES_TYPE" - }; - var UgcType$inboundSchema = nativeEnumType(UgcType); - var UgcType$outboundSchema = UgcType$inboundSchema; - var UgcType$; - (function(UgcType$2) { - UgcType$2.inboundSchema = UgcType$inboundSchema; - UgcType$2.outboundSchema = UgcType$outboundSchema; - })(UgcType$ || (UgcType$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/favoriteinfo.js - var FavoriteInfo$inboundSchema = objectType({ - ugcType: UgcType$inboundSchema.optional(), - id: stringType().optional(), - count: numberType().int().optional(), - favoritedByUser: booleanType().optional() - }); - var FavoriteInfo$outboundSchema = objectType({ - ugcType: UgcType$outboundSchema.optional(), - id: stringType().optional(), - count: numberType().int().optional(), - favoritedByUser: booleanType().optional() - }); - var FavoriteInfo$; - (function(FavoriteInfo$2) { - FavoriteInfo$2.inboundSchema = FavoriteInfo$inboundSchema; - FavoriteInfo$2.outboundSchema = FavoriteInfo$outboundSchema; - })(FavoriteInfo$ || (FavoriteInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedbackchatexchange.js - var ResultDocument$inboundSchema = objectType({ - title: stringType().optional(), - url: stringType().optional() - }); - var ResultDocument$outboundSchema = objectType({ - title: stringType().optional(), - url: stringType().optional() - }); - var ResultDocument$; - (function(ResultDocument$2) { - ResultDocument$2.inboundSchema = ResultDocument$inboundSchema; - ResultDocument$2.outboundSchema = ResultDocument$outboundSchema; - })(ResultDocument$ || (ResultDocument$ = {})); - var FeedbackChatExchange$inboundSchema = objectType({ - timestamp: numberType().int().optional(), - agent: stringType().optional(), - userQuery: stringType().optional(), - searchQuery: stringType().optional(), - resultDocuments: arrayType(lazyType(() => ResultDocument$inboundSchema)).optional(), - response: stringType().optional() - }); - var FeedbackChatExchange$outboundSchema = objectType({ - timestamp: numberType().int().optional(), - agent: stringType().optional(), - userQuery: stringType().optional(), - searchQuery: stringType().optional(), - resultDocuments: arrayType(lazyType(() => ResultDocument$outboundSchema)).optional(), - response: stringType().optional() - }); - var FeedbackChatExchange$; - (function(FeedbackChatExchange$2) { - FeedbackChatExchange$2.inboundSchema = FeedbackChatExchange$inboundSchema; - FeedbackChatExchange$2.outboundSchema = FeedbackChatExchange$outboundSchema; - })(FeedbackChatExchange$ || (FeedbackChatExchange$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/manualfeedbackinfo.js - var ManualFeedbackInfoSource = { - Autocomplete: "AUTOCOMPLETE", - Calendar: "CALENDAR", - Chat: "CHAT", - ChatGeneral: "CHAT_GENERAL", - ConceptCard: "CONCEPT_CARD", - DesktopApp: "DESKTOP_APP", - DisambiguationCard: "DISAMBIGUATION_CARD", - ExpertDetection: "EXPERT_DETECTION", - Feed: "FEED", - GeneratedQAndA: "GENERATED_Q_AND_A", - InlineMenu: "INLINE_MENU", - NativeResult: "NATIVE_RESULT", - QAndA: "Q_AND_A", - RelatedQuestions: "RELATED_QUESTIONS", - ReportIssue: "REPORT_ISSUE", - Sciobot: "SCIOBOT", - Search: "SEARCH", - Sidebar: "SIDEBAR", - Summary: "SUMMARY", - Tasks: "TASKS" - }; - var Issue = { - InaccurateResponse: "INACCURATE_RESPONSE", - IncompleteOrNoAnswer: "INCOMPLETE_OR_NO_ANSWER", - IncorrectCitation: "INCORRECT_CITATION", - MissingCitation: "MISSING_CITATION", - Other: "OTHER", - OutdatedResponse: "OUTDATED_RESPONSE", - ResultMissing: "RESULT_MISSING", - ResultShouldNotAppear: "RESULT_SHOULD_NOT_APPEAR", - ResultsHelpful: "RESULTS_HELPFUL", - ResultsPoorOrder: "RESULTS_POOR_ORDER", - TooMuchOneKind: "TOO_MUCH_ONE_KIND" - }; - var ManualFeedbackInfoVote = { - Upvote: "UPVOTE", - Downvote: "DOWNVOTE" - }; - var ManualFeedbackInfoSource$inboundSchema = nativeEnumType(ManualFeedbackInfoSource); - var ManualFeedbackInfoSource$outboundSchema = ManualFeedbackInfoSource$inboundSchema; - var ManualFeedbackInfoSource$; - (function(ManualFeedbackInfoSource$2) { - ManualFeedbackInfoSource$2.inboundSchema = ManualFeedbackInfoSource$inboundSchema; - ManualFeedbackInfoSource$2.outboundSchema = ManualFeedbackInfoSource$outboundSchema; - })(ManualFeedbackInfoSource$ || (ManualFeedbackInfoSource$ = {})); - var Issue$inboundSchema = nativeEnumType(Issue); - var Issue$outboundSchema = Issue$inboundSchema; - var Issue$; - (function(Issue$2) { - Issue$2.inboundSchema = Issue$inboundSchema; - Issue$2.outboundSchema = Issue$outboundSchema; - })(Issue$ || (Issue$ = {})); - var ManualFeedbackInfoVote$inboundSchema = nativeEnumType(ManualFeedbackInfoVote); - var ManualFeedbackInfoVote$outboundSchema = ManualFeedbackInfoVote$inboundSchema; - var ManualFeedbackInfoVote$; - (function(ManualFeedbackInfoVote$2) { - ManualFeedbackInfoVote$2.inboundSchema = ManualFeedbackInfoVote$inboundSchema; - ManualFeedbackInfoVote$2.outboundSchema = ManualFeedbackInfoVote$outboundSchema; - })(ManualFeedbackInfoVote$ || (ManualFeedbackInfoVote$ = {})); - var ManualFeedbackInfo$inboundSchema = objectType({ - email: stringType().optional(), - source: ManualFeedbackInfoSource$inboundSchema.optional(), - issue: stringType().optional(), - issues: arrayType(Issue$inboundSchema).optional(), - imageUrls: arrayType(stringType()).optional(), - query: stringType().optional(), - obscuredQuery: stringType().optional(), - activeTab: stringType().optional(), - comments: stringType().optional(), - searchResults: arrayType(stringType()).optional(), - previousMessages: arrayType(stringType()).optional(), - chatTranscript: arrayType(FeedbackChatExchange$inboundSchema).optional(), - numQueriesFromFirstRun: numberType().int().optional(), - vote: ManualFeedbackInfoVote$inboundSchema.optional(), - rating: numberType().int().optional(), - ratingKey: stringType().optional(), - ratingScale: numberType().int().optional() - }); - var ManualFeedbackInfo$outboundSchema = objectType({ - email: stringType().optional(), - source: ManualFeedbackInfoSource$outboundSchema.optional(), - issue: stringType().optional(), - issues: arrayType(Issue$outboundSchema).optional(), - imageUrls: arrayType(stringType()).optional(), - query: stringType().optional(), - obscuredQuery: stringType().optional(), - activeTab: stringType().optional(), - comments: stringType().optional(), - searchResults: arrayType(stringType()).optional(), - previousMessages: arrayType(stringType()).optional(), - chatTranscript: arrayType(FeedbackChatExchange$outboundSchema).optional(), - numQueriesFromFirstRun: numberType().int().optional(), - vote: ManualFeedbackInfoVote$outboundSchema.optional(), - rating: numberType().int().optional(), - ratingKey: stringType().optional(), - ratingScale: numberType().int().optional() - }); - var ManualFeedbackInfo$; - (function(ManualFeedbackInfo$2) { - ManualFeedbackInfo$2.inboundSchema = ManualFeedbackInfo$inboundSchema; - ManualFeedbackInfo$2.outboundSchema = ManualFeedbackInfo$outboundSchema; - })(ManualFeedbackInfo$ || (ManualFeedbackInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sidebysideimplementation.js - var ResponseMetadata$inboundSchema = objectType({ - latencyMs: numberType().int().optional(), - tokenCount: numberType().int().optional(), - modelUsed: stringType().optional() - }); - var ResponseMetadata$outboundSchema = objectType({ - latencyMs: numberType().int().optional(), - tokenCount: numberType().int().optional(), - modelUsed: stringType().optional() - }); - var ResponseMetadata$; - (function(ResponseMetadata$2) { - ResponseMetadata$2.inboundSchema = ResponseMetadata$inboundSchema; - ResponseMetadata$2.outboundSchema = ResponseMetadata$outboundSchema; - })(ResponseMetadata$ || (ResponseMetadata$ = {})); - var SideBySideImplementation$inboundSchema = objectType({ - implementationId: stringType().optional(), - implementationName: stringType().optional(), - searchParams: recordType(stringType()).optional(), - response: stringType().optional(), - responseMetadata: lazyType(() => ResponseMetadata$inboundSchema).optional() - }); - var SideBySideImplementation$outboundSchema = objectType({ - implementationId: stringType().optional(), - implementationName: stringType().optional(), - searchParams: recordType(stringType()).optional(), - response: stringType().optional(), - responseMetadata: lazyType(() => ResponseMetadata$outboundSchema).optional() - }); - var SideBySideImplementation$; - (function(SideBySideImplementation$2) { - SideBySideImplementation$2.inboundSchema = SideBySideImplementation$inboundSchema; - SideBySideImplementation$2.outboundSchema = SideBySideImplementation$outboundSchema; - })(SideBySideImplementation$ || (SideBySideImplementation$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/manualfeedbacksidebysideinfo.js - var ManualFeedbackSideBySideInfoSource = { - LiveEval: "LIVE_EVAL", - Chat: "CHAT", - Search: "SEARCH" - }; - var ManualFeedbackSideBySideInfoVote = { - Upvote: "UPVOTE", - Downvote: "DOWNVOTE", - Neutral: "NEUTRAL" - }; - var ManualFeedbackSideBySideInfoSource$inboundSchema = nativeEnumType(ManualFeedbackSideBySideInfoSource); - var ManualFeedbackSideBySideInfoSource$outboundSchema = ManualFeedbackSideBySideInfoSource$inboundSchema; - var ManualFeedbackSideBySideInfoSource$; - (function(ManualFeedbackSideBySideInfoSource$2) { - ManualFeedbackSideBySideInfoSource$2.inboundSchema = ManualFeedbackSideBySideInfoSource$inboundSchema; - ManualFeedbackSideBySideInfoSource$2.outboundSchema = ManualFeedbackSideBySideInfoSource$outboundSchema; - })(ManualFeedbackSideBySideInfoSource$ || (ManualFeedbackSideBySideInfoSource$ = {})); - var ManualFeedbackSideBySideInfoVote$inboundSchema = nativeEnumType(ManualFeedbackSideBySideInfoVote); - var ManualFeedbackSideBySideInfoVote$outboundSchema = ManualFeedbackSideBySideInfoVote$inboundSchema; - var ManualFeedbackSideBySideInfoVote$; - (function(ManualFeedbackSideBySideInfoVote$2) { - ManualFeedbackSideBySideInfoVote$2.inboundSchema = ManualFeedbackSideBySideInfoVote$inboundSchema; - ManualFeedbackSideBySideInfoVote$2.outboundSchema = ManualFeedbackSideBySideInfoVote$outboundSchema; - })(ManualFeedbackSideBySideInfoVote$ || (ManualFeedbackSideBySideInfoVote$ = {})); - var ManualFeedbackSideBySideInfo$inboundSchema = objectType({ - email: stringType().optional(), - source: ManualFeedbackSideBySideInfoSource$inboundSchema.optional(), - query: stringType().optional(), - implementations: arrayType(SideBySideImplementation$inboundSchema).optional(), - evaluationSessionId: stringType().optional(), - implementationId: stringType().optional(), - vote: ManualFeedbackSideBySideInfoVote$inboundSchema.optional(), - comments: stringType().optional() - }); - var ManualFeedbackSideBySideInfo$outboundSchema = objectType({ - email: stringType().optional(), - source: ManualFeedbackSideBySideInfoSource$outboundSchema.optional(), - query: stringType().optional(), - implementations: arrayType(SideBySideImplementation$outboundSchema).optional(), - evaluationSessionId: stringType().optional(), - implementationId: stringType().optional(), - vote: ManualFeedbackSideBySideInfoVote$outboundSchema.optional(), - comments: stringType().optional() - }); - var ManualFeedbackSideBySideInfo$; - (function(ManualFeedbackSideBySideInfo$2) { - ManualFeedbackSideBySideInfo$2.inboundSchema = ManualFeedbackSideBySideInfo$inboundSchema; - ManualFeedbackSideBySideInfo$2.outboundSchema = ManualFeedbackSideBySideInfo$outboundSchema; - })(ManualFeedbackSideBySideInfo$ || (ManualFeedbackSideBySideInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/seenfeedbackinfo.js - var SeenFeedbackInfo$inboundSchema = objectType({ - isExplicit: booleanType().optional() - }); - var SeenFeedbackInfo$outboundSchema = objectType({ - isExplicit: booleanType().optional() - }); - var SeenFeedbackInfo$; - (function(SeenFeedbackInfo$2) { - SeenFeedbackInfo$2.inboundSchema = SeenFeedbackInfo$inboundSchema; - SeenFeedbackInfo$2.outboundSchema = SeenFeedbackInfo$outboundSchema; - })(SeenFeedbackInfo$ || (SeenFeedbackInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/user.js - var User$inboundSchema = objectType({ - userID: stringType().optional(), - origID: stringType().optional() - }); - var User$outboundSchema = objectType({ - userID: stringType().optional(), - origID: stringType().optional() - }); - var User$; - (function(User$2) { - User$2.inboundSchema = User$inboundSchema; - User$2.outboundSchema = User$outboundSchema; - })(User$ || (User$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userviewinfo.js - var UserViewInfo$inboundSchema = objectType({ - docId: stringType().optional(), - docTitle: stringType().optional(), - docUrl: stringType().optional() - }); - var UserViewInfo$outboundSchema = objectType({ - docId: stringType().optional(), - docTitle: stringType().optional(), - docUrl: stringType().optional() - }); - var UserViewInfo$; - (function(UserViewInfo$2) { - UserViewInfo$2.inboundSchema = UserViewInfo$inboundSchema; - UserViewInfo$2.outboundSchema = UserViewInfo$outboundSchema; - })(UserViewInfo$ || (UserViewInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/workflowfeedbackinfo.js - var WorkflowFeedbackInfoSource = { - ZeroState: "ZERO_STATE", - Library: "LIBRARY", - Homepage: "HOMEPAGE" - }; - var WorkflowFeedbackInfoSource$inboundSchema = nativeEnumType(WorkflowFeedbackInfoSource); - var WorkflowFeedbackInfoSource$outboundSchema = WorkflowFeedbackInfoSource$inboundSchema; - var WorkflowFeedbackInfoSource$; - (function(WorkflowFeedbackInfoSource$2) { - WorkflowFeedbackInfoSource$2.inboundSchema = WorkflowFeedbackInfoSource$inboundSchema; - WorkflowFeedbackInfoSource$2.outboundSchema = WorkflowFeedbackInfoSource$outboundSchema; - })(WorkflowFeedbackInfoSource$ || (WorkflowFeedbackInfoSource$ = {})); - var WorkflowFeedbackInfo$inboundSchema = objectType({ - source: WorkflowFeedbackInfoSource$inboundSchema.optional() - }); - var WorkflowFeedbackInfo$outboundSchema = objectType({ - source: WorkflowFeedbackInfoSource$outboundSchema.optional() - }); - var WorkflowFeedbackInfo$; - (function(WorkflowFeedbackInfo$2) { - WorkflowFeedbackInfo$2.inboundSchema = WorkflowFeedbackInfo$inboundSchema; - WorkflowFeedbackInfo$2.outboundSchema = WorkflowFeedbackInfo$outboundSchema; - })(WorkflowFeedbackInfo$ || (WorkflowFeedbackInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedback.js - var FeedbackCategory = { - Announcement: "ANNOUNCEMENT", - Autocomplete: "AUTOCOMPLETE", - Collections: "COLLECTIONS", - Feed: "FEED", - Search: "SEARCH", - Chat: "CHAT", - Ntp: "NTP", - Workflows: "WORKFLOWS", - Summary: "SUMMARY", - General: "GENERAL", - Prompts: "PROMPTS" - }; - var Event = { - Click: "CLICK", - ContainerClick: "CONTAINER_CLICK", - CopyLink: "COPY_LINK", - Create: "CREATE", - Dismiss: "DISMISS", - Downvote: "DOWNVOTE", - Email: "EMAIL", - Execute: "EXECUTE", - Filter: "FILTER", - FirstToken: "FIRST_TOKEN", - FocusIn: "FOCUS_IN", - LastToken: "LAST_TOKEN", - ManualFeedback: "MANUAL_FEEDBACK", - ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE", - MarkAsRead: "MARK_AS_READ", - Message: "MESSAGE", - MiddleClick: "MIDDLE_CLICK", - PageBlur: "PAGE_BLUR", - PageFocus: "PAGE_FOCUS", - PageLeave: "PAGE_LEAVE", - Preview: "PREVIEW", - RelatedClick: "RELATED_CLICK", - RightClick: "RIGHT_CLICK", - SectionClick: "SECTION_CLICK", - Seen: "SEEN", - Share: "SHARE", - ShowMore: "SHOW_MORE", - Upvote: "UPVOTE", - View: "VIEW", - Visible: "VISIBLE" - }; - var FeedbackChannel = { - Company: "COMPANY", - Glean: "GLEAN" - }; - var FeedbackCategory$inboundSchema = nativeEnumType(FeedbackCategory); - var FeedbackCategory$outboundSchema = FeedbackCategory$inboundSchema; - var FeedbackCategory$; - (function(FeedbackCategory$2) { - FeedbackCategory$2.inboundSchema = FeedbackCategory$inboundSchema; - FeedbackCategory$2.outboundSchema = FeedbackCategory$outboundSchema; - })(FeedbackCategory$ || (FeedbackCategory$ = {})); - var Event$inboundSchema = nativeEnumType(Event); - var Event$outboundSchema = Event$inboundSchema; - var Event$; - (function(Event$2) { - Event$2.inboundSchema = Event$inboundSchema; - Event$2.outboundSchema = Event$outboundSchema; - })(Event$ || (Event$ = {})); - var FeedbackChannel$inboundSchema = nativeEnumType(FeedbackChannel); - var FeedbackChannel$outboundSchema = FeedbackChannel$inboundSchema; - var FeedbackChannel$; - (function(FeedbackChannel$2) { - FeedbackChannel$2.inboundSchema = FeedbackChannel$inboundSchema; - FeedbackChannel$2.outboundSchema = FeedbackChannel$outboundSchema; - })(FeedbackChannel$ || (FeedbackChannel$ = {})); - var Feedback$inboundSchema = objectType({ - id: stringType().optional(), - category: FeedbackCategory$inboundSchema.optional(), - trackingTokens: arrayType(stringType()), - event: Event$inboundSchema, - position: numberType().int().optional(), - payload: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - timestamp: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - user: User$inboundSchema.optional(), - pathname: stringType().optional(), - channels: arrayType(FeedbackChannel$inboundSchema).optional(), - url: stringType().optional(), - uiTree: arrayType(stringType()).optional(), - uiElement: stringType().optional(), - manualFeedbackInfo: ManualFeedbackInfo$inboundSchema.optional(), - manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo$inboundSchema.optional(), - seenFeedbackInfo: SeenFeedbackInfo$inboundSchema.optional(), - userViewInfo: UserViewInfo$inboundSchema.optional(), - workflowFeedbackInfo: WorkflowFeedbackInfo$inboundSchema.optional(), - applicationId: stringType().optional(), - agentId: stringType().optional() - }); - var Feedback$outboundSchema = objectType({ - id: stringType().optional(), - category: FeedbackCategory$outboundSchema.optional(), - trackingTokens: arrayType(stringType()), - event: Event$outboundSchema, - position: numberType().int().optional(), - payload: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - timestamp: dateType().transform((v) => v.toISOString()).optional(), - user: User$outboundSchema.optional(), - pathname: stringType().optional(), - channels: arrayType(FeedbackChannel$outboundSchema).optional(), - url: stringType().optional(), - uiTree: arrayType(stringType()).optional(), - uiElement: stringType().optional(), - manualFeedbackInfo: ManualFeedbackInfo$outboundSchema.optional(), - manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo$outboundSchema.optional(), - seenFeedbackInfo: SeenFeedbackInfo$outboundSchema.optional(), - userViewInfo: UserViewInfo$outboundSchema.optional(), - workflowFeedbackInfo: WorkflowFeedbackInfo$outboundSchema.optional(), - applicationId: stringType().optional(), - agentId: stringType().optional() - }); - var Feedback$; - (function(Feedback$2) { - Feedback$2.inboundSchema = Feedback$inboundSchema; - Feedback$2.outboundSchema = Feedback$outboundSchema; - })(Feedback$ || (Feedback$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/prompttemplate.js - var PromptTemplate$inboundSchema = objectType({ - name: stringType().optional(), - template: stringType(), - applicationId: stringType().optional(), - inclusions: ChatRestrictionFilters$inboundSchema.optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: stringType().optional(), - author: Person$inboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - lastUpdatedBy: Person$inboundSchema.optional(), - roles: arrayType(UserRoleSpecification$inboundSchema).optional() - }); - var PromptTemplate$outboundSchema = objectType({ - name: stringType().optional(), - template: stringType(), - applicationId: stringType().optional(), - inclusions: ChatRestrictionFilters$outboundSchema.optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: stringType().optional(), - author: Person$outboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - lastUpdatedBy: Person$outboundSchema.optional(), - roles: arrayType(UserRoleSpecification$outboundSchema).optional() - }); - var PromptTemplate$; - (function(PromptTemplate$2) { - PromptTemplate$2.inboundSchema = PromptTemplate$inboundSchema; - PromptTemplate$2.outboundSchema = PromptTemplate$outboundSchema; - })(PromptTemplate$ || (PromptTemplate$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/prompttemplateresult.js - var PromptTemplateResult$inboundSchema = objectType({ - promptTemplate: PromptTemplate$inboundSchema.optional(), - trackingToken: stringType().optional(), - favoriteInfo: FavoriteInfo$inboundSchema.optional(), - runCount: CountInfo$inboundSchema.optional() - }); - var PromptTemplateResult$outboundSchema = objectType({ - promptTemplate: PromptTemplate$outboundSchema.optional(), - trackingToken: stringType().optional(), - favoriteInfo: FavoriteInfo$outboundSchema.optional(), - runCount: CountInfo$outboundSchema.optional() - }); - var PromptTemplateResult$; - (function(PromptTemplateResult$2) { - PromptTemplateResult$2.inboundSchema = PromptTemplateResult$inboundSchema; - PromptTemplateResult$2.outboundSchema = PromptTemplateResult$outboundSchema; - })(PromptTemplateResult$ || (PromptTemplateResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/useractivity.js - var UserActivityAction = { - Add: "ADD", - AddReminder: "ADD_REMINDER", - Click: "CLICK", - Comment: "COMMENT", - Delete: "DELETE", - Dismiss: "DISMISS", - Edit: "EDIT", - Mention: "MENTION", - Move: "MOVE", - Other: "OTHER", - Restore: "RESTORE", - Unknown: "UNKNOWN", - Verify: "VERIFY", - View: "VIEW" - }; - var UserActivityAction$inboundSchema = nativeEnumType(UserActivityAction); - var UserActivityAction$outboundSchema = UserActivityAction$inboundSchema; - var UserActivityAction$; - (function(UserActivityAction$2) { - UserActivityAction$2.inboundSchema = UserActivityAction$inboundSchema; - UserActivityAction$2.outboundSchema = UserActivityAction$outboundSchema; - })(UserActivityAction$ || (UserActivityAction$ = {})); - var UserActivity$inboundSchema = objectType({ - actor: Person$inboundSchema.optional(), - timestamp: numberType().int().optional(), - action: UserActivityAction$inboundSchema.optional(), - aggregateVisitCount: CountInfo$inboundSchema.optional() - }); - var UserActivity$outboundSchema = objectType({ - actor: Person$outboundSchema.optional(), - timestamp: numberType().int().optional(), - action: UserActivityAction$outboundSchema.optional(), - aggregateVisitCount: CountInfo$outboundSchema.optional() - }); - var UserActivity$; - (function(UserActivity$2) { - UserActivity$2.inboundSchema = UserActivity$inboundSchema; - UserActivity$2.outboundSchema = UserActivity$outboundSchema; - })(UserActivity$ || (UserActivity$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/workflow.js - var Workflow$inboundSchema = objectType({ - name: stringType().optional(), - author: Person$inboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - lastUpdatedBy: Person$inboundSchema.optional(), - permissions: ObjectPermissions$inboundSchema.optional(), - id: stringType().optional() - }); - var Workflow$outboundSchema = objectType({ - name: stringType().optional(), - author: Person$outboundSchema.optional(), - createTimestamp: numberType().int().optional(), - lastUpdateTimestamp: numberType().int().optional(), - lastUpdatedBy: Person$outboundSchema.optional(), - permissions: ObjectPermissions$outboundSchema.optional(), - id: stringType().optional() - }); - var Workflow$; - (function(Workflow$2) { - Workflow$2.inboundSchema = Workflow$inboundSchema; - Workflow$2.outboundSchema = Workflow$outboundSchema; - })(Workflow$ || (Workflow$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/workflowresult.js - var WorkflowResult$inboundSchema = objectType({ - workflow: Workflow$inboundSchema - }); - var WorkflowResult$outboundSchema = objectType({ - workflow: Workflow$outboundSchema - }); - var WorkflowResult$; - (function(WorkflowResult$2) { - WorkflowResult$2.inboundSchema = WorkflowResult$inboundSchema; - WorkflowResult$2.outboundSchema = WorkflowResult$outboundSchema; - })(WorkflowResult$ || (WorkflowResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedentry.js - var Format = { - List: "LIST" - }; - var JustificationType = { - FrequentlyAccessed: "FREQUENTLY_ACCESSED", - RecentlyAccessed: "RECENTLY_ACCESSED", - TrendingDocument: "TRENDING_DOCUMENT", - VerificationReminder: "VERIFICATION_REMINDER", - SuggestedDocument: "SUGGESTED_DOCUMENT", - EmptyStateSuggestion: "EMPTY_STATE_SUGGESTION", - FrecencyScored: "FRECENCY_SCORED", - ServerGenerated: "SERVER_GENERATED", - UseCase: "USE_CASE", - UpdateSinceLastView: "UPDATE_SINCE_LAST_VIEW", - RecentlyStarted: "RECENTLY_STARTED", - Event: "EVENT", - UserMention: "USER_MENTION", - Announcement: "ANNOUNCEMENT", - ExternalAnnouncement: "EXTERNAL_ANNOUNCEMENT", - PopularityBasedTrending: "POPULARITY_BASED_TRENDING", - CompanyResource: "COMPANY_RESOURCE", - EventDocumentFromContent: "EVENT_DOCUMENT_FROM_CONTENT", - EventDocumentFromSearch: "EVENT_DOCUMENT_FROM_SEARCH", - VisitAffinityScored: "VISIT_AFFINITY_SCORED", - SuggestedApp: "SUGGESTED_APP", - SuggestedPerson: "SUGGESTED_PERSON", - ActivityHighlight: "ACTIVITY_HIGHLIGHT", - SavedSearch: "SAVED_SEARCH", - SuggestedChannel: "SUGGESTED_CHANNEL", - PeopleCelebrations: "PEOPLE_CELEBRATIONS", - SocialLink: "SOCIAL_LINK", - ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION", - ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION", - ZeroStatePromptTemplateSuggestion: "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION", - ZeroStateStaticWorkflowSuggestion: "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION", - ZeroStateAgentSuggestion: "ZERO_STATE_AGENT_SUGGESTION", - PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION", - DailyDigest: "DAILY_DIGEST" - }; - var Format$inboundSchema = nativeEnumType(Format); - var Format$outboundSchema = Format$inboundSchema; - var Format$; - (function(Format$2) { - Format$2.inboundSchema = Format$inboundSchema; - Format$2.outboundSchema = Format$outboundSchema; - })(Format$ || (Format$ = {})); - var UiConfig$inboundSchema = objectType({ - format: Format$inboundSchema.optional(), - additionalFlags: DisplayableListItemUIConfig$inboundSchema.optional() - }); - var UiConfig$outboundSchema = objectType({ - format: Format$outboundSchema.optional(), - additionalFlags: DisplayableListItemUIConfig$outboundSchema.optional() - }); - var UiConfig$; - (function(UiConfig$2) { - UiConfig$2.inboundSchema = UiConfig$inboundSchema; - UiConfig$2.outboundSchema = UiConfig$outboundSchema; - })(UiConfig$ || (UiConfig$ = {})); - var JustificationType$inboundSchema = nativeEnumType(JustificationType); - var JustificationType$outboundSchema = JustificationType$inboundSchema; - var JustificationType$; - (function(JustificationType$2) { - JustificationType$2.inboundSchema = JustificationType$inboundSchema; - JustificationType$2.outboundSchema = JustificationType$outboundSchema; - })(JustificationType$ || (JustificationType$ = {})); - var FeedEntry$inboundSchema = objectType({ - entryId: stringType().optional(), - title: stringType(), - thumbnail: Thumbnail$inboundSchema.optional(), - createdBy: Person$inboundSchema.optional(), - uiConfig: lazyType(() => UiConfig$inboundSchema).optional(), - justificationType: JustificationType$inboundSchema.optional(), - justification: stringType().optional(), - trackingToken: stringType().optional(), - viewUrl: stringType().optional(), - document: Document$inboundSchema.optional(), - event: CalendarEvent$inboundSchema.optional(), - announcement: Announcement$inboundSchema.optional(), - digest: Digest$inboundSchema.optional(), - collection: Collection$inboundSchema.optional(), - collectionItem: CollectionItem$inboundSchema.optional(), - person: Person$inboundSchema.optional(), - app: AppResult$inboundSchema.optional(), - chatSuggestion: ChatSuggestion$inboundSchema.optional(), - promptTemplate: PromptTemplateResult$inboundSchema.optional(), - workflow: WorkflowResult$inboundSchema.optional(), - activities: arrayType(UserActivity$inboundSchema).optional(), - documentVisitorCount: CountInfo$inboundSchema.optional() - }); - var FeedEntry$outboundSchema = objectType({ - entryId: stringType().optional(), - title: stringType(), - thumbnail: Thumbnail$outboundSchema.optional(), - createdBy: Person$outboundSchema.optional(), - uiConfig: lazyType(() => UiConfig$outboundSchema).optional(), - justificationType: JustificationType$outboundSchema.optional(), - justification: stringType().optional(), - trackingToken: stringType().optional(), - viewUrl: stringType().optional(), - document: Document$outboundSchema.optional(), - event: CalendarEvent$outboundSchema.optional(), - announcement: Announcement$outboundSchema.optional(), - digest: Digest$outboundSchema.optional(), - collection: Collection$outboundSchema.optional(), - collectionItem: CollectionItem$outboundSchema.optional(), - person: Person$outboundSchema.optional(), - app: AppResult$outboundSchema.optional(), - chatSuggestion: ChatSuggestion$outboundSchema.optional(), - promptTemplate: PromptTemplateResult$outboundSchema.optional(), - workflow: WorkflowResult$outboundSchema.optional(), - activities: arrayType(UserActivity$outboundSchema).optional(), - documentVisitorCount: CountInfo$outboundSchema.optional() - }); - var FeedEntry$; - (function(FeedEntry$2) { - FeedEntry$2.inboundSchema = FeedEntry$inboundSchema; - FeedEntry$2.outboundSchema = FeedEntry$outboundSchema; - })(FeedEntry$ || (FeedEntry$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedrequestoptions.js - var CategoryToResultSize$inboundSchema = objectType({ - resultSize: numberType().int().optional() - }); - var CategoryToResultSize$outboundSchema = objectType({ - resultSize: numberType().int().optional() - }); - var CategoryToResultSize$; - (function(CategoryToResultSize$2) { - CategoryToResultSize$2.inboundSchema = CategoryToResultSize$inboundSchema; - CategoryToResultSize$2.outboundSchema = CategoryToResultSize$outboundSchema; - })(CategoryToResultSize$ || (CategoryToResultSize$ = {})); - var FeedRequestOptions$inboundSchema = objectType({ - resultSize: numberType().int(), - timezoneOffset: numberType().int().optional(), - categoryToResultSize: recordType(lazyType(() => CategoryToResultSize$inboundSchema)).optional(), - datasourceFilter: arrayType(stringType()).optional(), - chatZeroStateSuggestionOptions: ChatZeroStateSuggestionOptions$inboundSchema.optional() - }); - var FeedRequestOptions$outboundSchema = objectType({ - resultSize: numberType().int(), - timezoneOffset: numberType().int().optional(), - categoryToResultSize: recordType(lazyType(() => CategoryToResultSize$outboundSchema)).optional(), - datasourceFilter: arrayType(stringType()).optional(), - chatZeroStateSuggestionOptions: ChatZeroStateSuggestionOptions$outboundSchema.optional() - }); - var FeedRequestOptions$; - (function(FeedRequestOptions$2) { - FeedRequestOptions$2.inboundSchema = FeedRequestOptions$inboundSchema; - FeedRequestOptions$2.outboundSchema = FeedRequestOptions$outboundSchema; - })(FeedRequestOptions$ || (FeedRequestOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedrequest.js - var FeedRequestCategory = { - DocumentSuggestion: "DOCUMENT_SUGGESTION", - DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO", - TrendingDocument: "TRENDING_DOCUMENT", - VerificationReminder: "VERIFICATION_REMINDER", - Event: "EVENT", - Announcement: "ANNOUNCEMENT", - Mention: "MENTION", - DatasourceAffinity: "DATASOURCE_AFFINITY", - Recent: "RECENT", - CompanyResource: "COMPANY_RESOURCE", - Experimental: "EXPERIMENTAL", - PeopleCelebrations: "PEOPLE_CELEBRATIONS", - DisplayableList: "DISPLAYABLE_LIST", - SocialLink: "SOCIAL_LINK", - ExternalTasks: "EXTERNAL_TASKS", - WorkflowCollections: "WORKFLOW_COLLECTIONS", - ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION", - ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION", - ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME", - ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES", - ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR", - ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION", - PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION", - DailyDigest: "DAILY_DIGEST" - }; - var FeedRequestCategory$inboundSchema = nativeEnumType(FeedRequestCategory); - var FeedRequestCategory$outboundSchema = FeedRequestCategory$inboundSchema; - var FeedRequestCategory$; - (function(FeedRequestCategory$2) { - FeedRequestCategory$2.inboundSchema = FeedRequestCategory$inboundSchema; - FeedRequestCategory$2.outboundSchema = FeedRequestCategory$outboundSchema; - })(FeedRequestCategory$ || (FeedRequestCategory$ = {})); - var FeedRequest$inboundSchema = objectType({ - categories: arrayType(FeedRequestCategory$inboundSchema).optional(), - requestOptions: FeedRequestOptions$inboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - sessionInfo: SessionInfo$inboundSchema.optional() - }); - var FeedRequest$outboundSchema = objectType({ - categories: arrayType(FeedRequestCategory$outboundSchema).optional(), - requestOptions: FeedRequestOptions$outboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - sessionInfo: SessionInfo$outboundSchema.optional() - }); - var FeedRequest$; - (function(FeedRequest$2) { - FeedRequest$2.inboundSchema = FeedRequest$inboundSchema; - FeedRequest$2.outboundSchema = FeedRequest$outboundSchema; - })(FeedRequest$ || (FeedRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedresult.js - var FeedResultCategory = { - DocumentSuggestion: "DOCUMENT_SUGGESTION", - DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO", - TrendingDocument: "TRENDING_DOCUMENT", - UseCase: "USE_CASE", - VerificationReminder: "VERIFICATION_REMINDER", - Event: "EVENT", - Announcement: "ANNOUNCEMENT", - Mention: "MENTION", - DatasourceAffinity: "DATASOURCE_AFFINITY", - Recent: "RECENT", - CompanyResource: "COMPANY_RESOURCE", - Experimental: "EXPERIMENTAL", - PeopleCelebrations: "PEOPLE_CELEBRATIONS", - SocialLink: "SOCIAL_LINK", - ExternalTasks: "EXTERNAL_TASKS", - DisplayableList: "DISPLAYABLE_LIST", - ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION", - ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION", - ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME", - ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES", - ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR", - ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION", - PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION", - DailyDigest: "DAILY_DIGEST" - }; - var FeedResultCategory$inboundSchema = nativeEnumType(FeedResultCategory); - var FeedResultCategory$outboundSchema = FeedResultCategory$inboundSchema; - var FeedResultCategory$; - (function(FeedResultCategory$2) { - FeedResultCategory$2.inboundSchema = FeedResultCategory$inboundSchema; - FeedResultCategory$2.outboundSchema = FeedResultCategory$outboundSchema; - })(FeedResultCategory$ || (FeedResultCategory$ = {})); - var FeedResult$inboundSchema = objectType({ - category: FeedResultCategory$inboundSchema, - primaryEntry: FeedEntry$inboundSchema, - secondaryEntries: arrayType(FeedEntry$inboundSchema).optional(), - rank: numberType().int().optional() - }); - var FeedResult$outboundSchema = objectType({ - category: FeedResultCategory$outboundSchema, - primaryEntry: FeedEntry$outboundSchema, - secondaryEntries: arrayType(FeedEntry$outboundSchema).optional(), - rank: numberType().int().optional() - }); - var FeedResult$; - (function(FeedResult$2) { - FeedResult$2.inboundSchema = FeedResult$inboundSchema; - FeedResult$2.outboundSchema = FeedResult$outboundSchema; - })(FeedResult$ || (FeedResult$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/feedresponse.js - var FeedResponse$inboundSchema = objectType({ - experimentIds: arrayType(numberType().int()).optional(), - trackingToken: stringType().optional(), - serverTimestamp: numberType().int(), - results: arrayType(FeedResult$inboundSchema).optional(), - facetResults: recordType(arrayType(FacetResult$inboundSchema)).optional(), - mentionsTimeWindowInHours: numberType().int().optional() - }); - var FeedResponse$outboundSchema = objectType({ - experimentIds: arrayType(numberType().int()).optional(), - trackingToken: stringType().optional(), - serverTimestamp: numberType().int(), - results: arrayType(FeedResult$outboundSchema).optional(), - facetResults: recordType(arrayType(FacetResult$outboundSchema)).optional(), - mentionsTimeWindowInHours: numberType().int().optional() - }); - var FeedResponse$; - (function(FeedResponse$2) { - FeedResponse$2.inboundSchema = FeedResponse$inboundSchema; - FeedResponse$2.outboundSchema = FeedResponse$outboundSchema; - })(FeedResponse$ || (FeedResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getanswererror.js - var GetAnswerErrorErrorType = { - NoPermission: "NO_PERMISSION", - InvalidId: "INVALID_ID" - }; - var GetAnswerErrorErrorType$inboundSchema = nativeEnumType(GetAnswerErrorErrorType); - var GetAnswerErrorErrorType$outboundSchema = GetAnswerErrorErrorType$inboundSchema; - var GetAnswerErrorErrorType$; - (function(GetAnswerErrorErrorType$2) { - GetAnswerErrorErrorType$2.inboundSchema = GetAnswerErrorErrorType$inboundSchema; - GetAnswerErrorErrorType$2.outboundSchema = GetAnswerErrorErrorType$outboundSchema; - })(GetAnswerErrorErrorType$ || (GetAnswerErrorErrorType$ = {})); - var GetAnswerError$inboundSchema = objectType({ - errorType: GetAnswerErrorErrorType$inboundSchema.optional(), - answerAuthor: Person$inboundSchema.optional() - }); - var GetAnswerError$outboundSchema = objectType({ - errorType: GetAnswerErrorErrorType$outboundSchema.optional(), - answerAuthor: Person$outboundSchema.optional() - }); - var GetAnswerError$; - (function(GetAnswerError$2) { - GetAnswerError$2.inboundSchema = GetAnswerError$inboundSchema; - GetAnswerError$2.outboundSchema = GetAnswerError$outboundSchema; - })(GetAnswerError$ || (GetAnswerError$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getanswerrequest.js - var GetAnswerRequest$inboundSchema = objectType({ - id: numberType().int().optional(), - docId: stringType().optional() - }); - var GetAnswerRequest$outboundSchema = objectType({ - id: numberType().int().optional(), - docId: stringType().optional() - }); - var GetAnswerRequest$; - (function(GetAnswerRequest$2) { - GetAnswerRequest$2.inboundSchema = GetAnswerRequest$inboundSchema; - GetAnswerRequest$2.outboundSchema = GetAnswerRequest$outboundSchema; - })(GetAnswerRequest$ || (GetAnswerRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getanswerresponse.js - var GetAnswerResponse$inboundSchema = objectType({ - answerResult: AnswerResult$inboundSchema.optional(), - error: GetAnswerError$inboundSchema.optional() - }); - var GetAnswerResponse$outboundSchema = objectType({ - answerResult: AnswerResult$outboundSchema.optional(), - error: GetAnswerError$outboundSchema.optional() - }); - var GetAnswerResponse$; - (function(GetAnswerResponse$2) { - GetAnswerResponse$2.inboundSchema = GetAnswerResponse$inboundSchema; - GetAnswerResponse$2.outboundSchema = GetAnswerResponse$outboundSchema; - })(GetAnswerResponse$ || (GetAnswerResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatapplicationrequest.js - var GetChatApplicationRequest$inboundSchema = objectType({ - id: stringType() - }); - var GetChatApplicationRequest$outboundSchema = objectType({ - id: stringType() - }); - var GetChatApplicationRequest$; - (function(GetChatApplicationRequest$2) { - GetChatApplicationRequest$2.inboundSchema = GetChatApplicationRequest$inboundSchema; - GetChatApplicationRequest$2.outboundSchema = GetChatApplicationRequest$outboundSchema; - })(GetChatApplicationRequest$ || (GetChatApplicationRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatapplicationresponse.js - var GetChatApplicationResponse$inboundSchema = objectType({ - application: anyType().optional() - }); - var GetChatApplicationResponse$outboundSchema = objectType({ - application: anyType().optional() - }); - var GetChatApplicationResponse$; - (function(GetChatApplicationResponse$2) { - GetChatApplicationResponse$2.inboundSchema = GetChatApplicationResponse$inboundSchema; - GetChatApplicationResponse$2.outboundSchema = GetChatApplicationResponse$outboundSchema; - })(GetChatApplicationResponse$ || (GetChatApplicationResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatfilesrequest.js - var GetChatFilesRequest$inboundSchema = objectType({ - fileIds: arrayType(stringType()), - chatId: stringType().optional() - }); - var GetChatFilesRequest$outboundSchema = objectType({ - fileIds: arrayType(stringType()), - chatId: stringType().optional() - }); - var GetChatFilesRequest$; - (function(GetChatFilesRequest$2) { - GetChatFilesRequest$2.inboundSchema = GetChatFilesRequest$inboundSchema; - GetChatFilesRequest$2.outboundSchema = GetChatFilesRequest$outboundSchema; - })(GetChatFilesRequest$ || (GetChatFilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatfilesresponse.js - var GetChatFilesResponse$inboundSchema = objectType({ - files: recordType(ChatFile$inboundSchema).optional() - }); - var GetChatFilesResponse$outboundSchema = objectType({ - files: recordType(ChatFile$outboundSchema).optional() - }); - var GetChatFilesResponse$; - (function(GetChatFilesResponse$2) { - GetChatFilesResponse$2.inboundSchema = GetChatFilesResponse$inboundSchema; - GetChatFilesResponse$2.outboundSchema = GetChatFilesResponse$outboundSchema; - })(GetChatFilesResponse$ || (GetChatFilesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatrequest.js - var GetChatRequest$inboundSchema = objectType({ - id: stringType() - }); - var GetChatRequest$outboundSchema = objectType({ - id: stringType() - }); - var GetChatRequest$; - (function(GetChatRequest$2) { - GetChatRequest$2.inboundSchema = GetChatRequest$inboundSchema; - GetChatRequest$2.outboundSchema = GetChatRequest$outboundSchema; - })(GetChatRequest$ || (GetChatRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getchatresponse.js - var GetChatResponse$inboundSchema = objectType({ - chatResult: ChatResult$inboundSchema.optional() - }); - var GetChatResponse$outboundSchema = objectType({ - chatResult: ChatResult$outboundSchema.optional() - }); - var GetChatResponse$; - (function(GetChatResponse$2) { - GetChatResponse$2.inboundSchema = GetChatResponse$inboundSchema; - GetChatResponse$2.outboundSchema = GetChatResponse$outboundSchema; - })(GetChatResponse$ || (GetChatResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getcollectionrequest.js - var GetCollectionRequest$inboundSchema = objectType({ - id: numberType().int(), - withItems: booleanType().optional(), - withHierarchy: booleanType().optional(), - allowedDatasource: stringType().optional() - }); - var GetCollectionRequest$outboundSchema = objectType({ - id: numberType().int(), - withItems: booleanType().optional(), - withHierarchy: booleanType().optional(), - allowedDatasource: stringType().optional() - }); - var GetCollectionRequest$; - (function(GetCollectionRequest$2) { - GetCollectionRequest$2.inboundSchema = GetCollectionRequest$inboundSchema; - GetCollectionRequest$2.outboundSchema = GetCollectionRequest$outboundSchema; - })(GetCollectionRequest$ || (GetCollectionRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getcollectionresponse.js - var GetCollectionResponse$inboundSchema = objectType({ - collection: Collection$inboundSchema.optional(), - rootCollection: Collection$inboundSchema.optional(), - trackingToken: stringType().optional(), - error: CollectionError$inboundSchema.optional() - }); - var GetCollectionResponse$outboundSchema = objectType({ - collection: Collection$outboundSchema.optional(), - rootCollection: Collection$outboundSchema.optional(), - trackingToken: stringType().optional(), - error: CollectionError$outboundSchema.optional() - }); - var GetCollectionResponse$; - (function(GetCollectionResponse$2) { - GetCollectionResponse$2.inboundSchema = GetCollectionResponse$inboundSchema; - GetCollectionResponse$2.outboundSchema = GetCollectionResponse$outboundSchema; - })(GetCollectionResponse$ || (GetCollectionResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdatasourceconfigrequest.js - var GetDatasourceConfigRequest$inboundSchema = objectType({ - datasource: stringType() - }); - var GetDatasourceConfigRequest$outboundSchema = objectType({ - datasource: stringType() - }); - var GetDatasourceConfigRequest$; - (function(GetDatasourceConfigRequest$2) { - GetDatasourceConfigRequest$2.inboundSchema = GetDatasourceConfigRequest$inboundSchema; - GetDatasourceConfigRequest$2.outboundSchema = GetDatasourceConfigRequest$outboundSchema; - })(GetDatasourceConfigRequest$ || (GetDatasourceConfigRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdlpreportresponse.js - var GetDlpReportResponse$inboundSchema = objectType({ - report: DlpReport$inboundSchema.optional() - }); - var GetDlpReportResponse$outboundSchema = objectType({ - report: DlpReport$outboundSchema.optional() - }); - var GetDlpReportResponse$; - (function(GetDlpReportResponse$2) { - GetDlpReportResponse$2.inboundSchema = GetDlpReportResponse$inboundSchema; - GetDlpReportResponse$2.outboundSchema = GetDlpReportResponse$outboundSchema; - })(GetDlpReportResponse$ || (GetDlpReportResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocpermissionsrequest.js - var GetDocPermissionsRequest$inboundSchema = objectType({ - documentId: stringType().optional() - }); - var GetDocPermissionsRequest$outboundSchema = objectType({ - documentId: stringType().optional() - }); - var GetDocPermissionsRequest$; - (function(GetDocPermissionsRequest$2) { - GetDocPermissionsRequest$2.inboundSchema = GetDocPermissionsRequest$inboundSchema; - GetDocPermissionsRequest$2.outboundSchema = GetDocPermissionsRequest$outboundSchema; - })(GetDocPermissionsRequest$ || (GetDocPermissionsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocpermissionsresponse.js - var GetDocPermissionsResponse$inboundSchema = objectType({ - allowedUserEmails: arrayType(stringType()).optional() - }); - var GetDocPermissionsResponse$outboundSchema = objectType({ - allowedUserEmails: arrayType(stringType()).optional() - }); - var GetDocPermissionsResponse$; - (function(GetDocPermissionsResponse$2) { - GetDocPermissionsResponse$2.inboundSchema = GetDocPermissionsResponse$inboundSchema; - GetDocPermissionsResponse$2.outboundSchema = GetDocPermissionsResponse$outboundSchema; - })(GetDocPermissionsResponse$ || (GetDocPermissionsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentcountrequest.js - var GetDocumentCountRequest$inboundSchema = objectType({ - datasource: stringType() - }); - var GetDocumentCountRequest$outboundSchema = objectType({ - datasource: stringType() - }); - var GetDocumentCountRequest$; - (function(GetDocumentCountRequest$2) { - GetDocumentCountRequest$2.inboundSchema = GetDocumentCountRequest$inboundSchema; - GetDocumentCountRequest$2.outboundSchema = GetDocumentCountRequest$outboundSchema; - })(GetDocumentCountRequest$ || (GetDocumentCountRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentcountresponse.js - var GetDocumentCountResponse$inboundSchema = objectType({ - documentCount: numberType().int().optional() - }); - var GetDocumentCountResponse$outboundSchema = objectType({ - documentCount: numberType().int().optional() - }); - var GetDocumentCountResponse$; - (function(GetDocumentCountResponse$2) { - GetDocumentCountResponse$2.inboundSchema = GetDocumentCountResponse$inboundSchema; - GetDocumentCountResponse$2.outboundSchema = GetDocumentCountResponse$outboundSchema; - })(GetDocumentCountResponse$ || (GetDocumentCountResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentsbyfacetsrequest.js - var GetDocumentsByFacetsRequest$inboundSchema = objectType({ - datasourcesFilter: arrayType(stringType()).optional(), - filterSets: arrayType(FacetFilterSet$inboundSchema), - cursor: stringType().optional() - }); - var GetDocumentsByFacetsRequest$outboundSchema = objectType({ - datasourcesFilter: arrayType(stringType()).optional(), - filterSets: arrayType(FacetFilterSet$outboundSchema), - cursor: stringType().optional() - }); - var GetDocumentsByFacetsRequest$; - (function(GetDocumentsByFacetsRequest$2) { - GetDocumentsByFacetsRequest$2.inboundSchema = GetDocumentsByFacetsRequest$inboundSchema; - GetDocumentsByFacetsRequest$2.outboundSchema = GetDocumentsByFacetsRequest$outboundSchema; - })(GetDocumentsByFacetsRequest$ || (GetDocumentsByFacetsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentsbyfacetsresponse.js - var GetDocumentsByFacetsResponse$inboundSchema = objectType({ - documents: arrayType(Document$inboundSchema).optional(), - hasMoreResults: booleanType().optional(), - cursor: stringType().optional() - }); - var GetDocumentsByFacetsResponse$outboundSchema = objectType({ - documents: arrayType(Document$outboundSchema).optional(), - hasMoreResults: booleanType().optional(), - cursor: stringType().optional() - }); - var GetDocumentsByFacetsResponse$; - (function(GetDocumentsByFacetsResponse$2) { - GetDocumentsByFacetsResponse$2.inboundSchema = GetDocumentsByFacetsResponse$inboundSchema; - GetDocumentsByFacetsResponse$2.outboundSchema = GetDocumentsByFacetsResponse$outboundSchema; - })(GetDocumentsByFacetsResponse$ || (GetDocumentsByFacetsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentsrequest.js - var GetDocumentsRequestIncludeField = { - LastViewedAt: "LAST_VIEWED_AT", - VisitorsCount: "VISITORS_COUNT", - RecentShares: "RECENT_SHARES", - DocumentContent: "DOCUMENT_CONTENT" - }; - var GetDocumentsRequestIncludeField$inboundSchema = nativeEnumType(GetDocumentsRequestIncludeField); - var GetDocumentsRequestIncludeField$outboundSchema = GetDocumentsRequestIncludeField$inboundSchema; - var GetDocumentsRequestIncludeField$; - (function(GetDocumentsRequestIncludeField$2) { - GetDocumentsRequestIncludeField$2.inboundSchema = GetDocumentsRequestIncludeField$inboundSchema; - GetDocumentsRequestIncludeField$2.outboundSchema = GetDocumentsRequestIncludeField$outboundSchema; - })(GetDocumentsRequestIncludeField$ || (GetDocumentsRequestIncludeField$ = {})); - var GetDocumentsRequest$inboundSchema = objectType({ - documentSpecs: arrayType(DocumentSpecUnion$inboundSchema), - includeFields: arrayType(GetDocumentsRequestIncludeField$inboundSchema).optional() - }); - var GetDocumentsRequest$outboundSchema = objectType({ - documentSpecs: arrayType(DocumentSpecUnion$outboundSchema), - includeFields: arrayType(GetDocumentsRequestIncludeField$outboundSchema).optional() - }); - var GetDocumentsRequest$; - (function(GetDocumentsRequest$2) { - GetDocumentsRequest$2.inboundSchema = GetDocumentsRequest$inboundSchema; - GetDocumentsRequest$2.outboundSchema = GetDocumentsRequest$outboundSchema; - })(GetDocumentsRequest$ || (GetDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentsresponse.js - var GetDocumentsResponse$inboundSchema = objectType({ - documents: recordType(DocumentOrErrorUnion$inboundSchema).optional() - }); - var GetDocumentsResponse$outboundSchema = objectType({ - documents: recordType(DocumentOrErrorUnion$outboundSchema).optional() - }); - var GetDocumentsResponse$; - (function(GetDocumentsResponse$2) { - GetDocumentsResponse$2.inboundSchema = GetDocumentsResponse$inboundSchema; - GetDocumentsResponse$2.outboundSchema = GetDocumentsResponse$outboundSchema; - })(GetDocumentsResponse$ || (GetDocumentsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentstatusrequest.js - var GetDocumentStatusRequest$inboundSchema = objectType({ - datasource: stringType(), - objectType: stringType(), - docId: stringType() - }); - var GetDocumentStatusRequest$outboundSchema = objectType({ - datasource: stringType(), - objectType: stringType(), - docId: stringType() - }); - var GetDocumentStatusRequest$; - (function(GetDocumentStatusRequest$2) { - GetDocumentStatusRequest$2.inboundSchema = GetDocumentStatusRequest$inboundSchema; - GetDocumentStatusRequest$2.outboundSchema = GetDocumentStatusRequest$outboundSchema; - })(GetDocumentStatusRequest$ || (GetDocumentStatusRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentstatusresponse.js - var GetDocumentStatusResponse$inboundSchema = objectType({ - uploadStatus: stringType().optional(), - lastUploadedAt: numberType().int().optional(), - indexingStatus: stringType().optional(), - lastIndexedAt: numberType().int().optional() - }); - var GetDocumentStatusResponse$outboundSchema = objectType({ - uploadStatus: stringType().optional(), - lastUploadedAt: numberType().int().optional(), - indexingStatus: stringType().optional(), - lastIndexedAt: numberType().int().optional() - }); - var GetDocumentStatusResponse$; - (function(GetDocumentStatusResponse$2) { - GetDocumentStatusResponse$2.inboundSchema = GetDocumentStatusResponse$inboundSchema; - GetDocumentStatusResponse$2.outboundSchema = GetDocumentStatusResponse$outboundSchema; - })(GetDocumentStatusResponse$ || (GetDocumentStatusResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getdocumentvisibilityoverridesresponse.js - var GetDocumentVisibilityOverridesResponse$inboundSchema = objectType({ - visibilityOverrides: arrayType(DocumentVisibilityOverride$inboundSchema).optional() - }); - var GetDocumentVisibilityOverridesResponse$outboundSchema = objectType({ - visibilityOverrides: arrayType(DocumentVisibilityOverride$outboundSchema).optional() - }); - var GetDocumentVisibilityOverridesResponse$; - (function(GetDocumentVisibilityOverridesResponse$2) { - GetDocumentVisibilityOverridesResponse$2.inboundSchema = GetDocumentVisibilityOverridesResponse$inboundSchema; - GetDocumentVisibilityOverridesResponse$2.outboundSchema = GetDocumentVisibilityOverridesResponse$outboundSchema; - })(GetDocumentVisibilityOverridesResponse$ || (GetDocumentVisibilityOverridesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getpinrequest.js - var GetPinRequest$inboundSchema = objectType({ - id: stringType().optional() - }); - var GetPinRequest$outboundSchema = objectType({ - id: stringType().optional() - }); - var GetPinRequest$; - (function(GetPinRequest$2) { - GetPinRequest$2.inboundSchema = GetPinRequest$inboundSchema; - GetPinRequest$2.outboundSchema = GetPinRequest$outboundSchema; - })(GetPinRequest$ || (GetPinRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getpinresponse.js - var GetPinResponse$inboundSchema = objectType({ - pin: PinDocument$inboundSchema.optional() - }); - var GetPinResponse$outboundSchema = objectType({ - pin: PinDocument$outboundSchema.optional() - }); - var GetPinResponse$; - (function(GetPinResponse$2) { - GetPinResponse$2.inboundSchema = GetPinResponse$inboundSchema; - GetPinResponse$2.outboundSchema = GetPinResponse$outboundSchema; - })(GetPinResponse$ || (GetPinResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/usergeneratedcontentid.js - var UserGeneratedContentId$inboundSchema = objectType({ - id: numberType().int().optional() - }); - var UserGeneratedContentId$outboundSchema = objectType({ - id: numberType().int().optional() - }); - var UserGeneratedContentId$; - (function(UserGeneratedContentId$2) { - UserGeneratedContentId$2.inboundSchema = UserGeneratedContentId$inboundSchema; - UserGeneratedContentId$2.outboundSchema = UserGeneratedContentId$outboundSchema; - })(UserGeneratedContentId$ || (UserGeneratedContentId$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getshortcutrequestunion.js - var GetShortcutRequest$inboundSchema = objectType({ - alias: stringType() - }); - var GetShortcutRequest$outboundSchema = objectType({ - alias: stringType() - }); - var GetShortcutRequest$; - (function(GetShortcutRequest$2) { - GetShortcutRequest$2.inboundSchema = GetShortcutRequest$inboundSchema; - GetShortcutRequest$2.outboundSchema = GetShortcutRequest$outboundSchema; - })(GetShortcutRequest$ || (GetShortcutRequest$ = {})); - var GetShortcutRequestUnion$inboundSchema = unionType([ - lazyType(() => GetShortcutRequest$inboundSchema), - UserGeneratedContentId$inboundSchema - ]); - var GetShortcutRequestUnion$outboundSchema = unionType([ - lazyType(() => GetShortcutRequest$outboundSchema), - UserGeneratedContentId$outboundSchema - ]); - var GetShortcutRequestUnion$; - (function(GetShortcutRequestUnion$2) { - GetShortcutRequestUnion$2.inboundSchema = GetShortcutRequestUnion$inboundSchema; - GetShortcutRequestUnion$2.outboundSchema = GetShortcutRequestUnion$outboundSchema; - })(GetShortcutRequestUnion$ || (GetShortcutRequestUnion$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getshortcutresponse.js - var GetShortcutResponse$inboundSchema = objectType({ - shortcut: Shortcut$inboundSchema.optional(), - error: ShortcutError$inboundSchema.optional() - }); - var GetShortcutResponse$outboundSchema = objectType({ - shortcut: Shortcut$outboundSchema.optional(), - error: ShortcutError$outboundSchema.optional() - }); - var GetShortcutResponse$; - (function(GetShortcutResponse$2) { - GetShortcutResponse$2.inboundSchema = GetShortcutResponse$inboundSchema; - GetShortcutResponse$2.outboundSchema = GetShortcutResponse$outboundSchema; - })(GetShortcutResponse$ || (GetShortcutResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getusercountrequest.js - var GetUserCountRequest$inboundSchema = objectType({ - datasource: stringType() - }); - var GetUserCountRequest$outboundSchema = objectType({ - datasource: stringType() - }); - var GetUserCountRequest$; - (function(GetUserCountRequest$2) { - GetUserCountRequest$2.inboundSchema = GetUserCountRequest$inboundSchema; - GetUserCountRequest$2.outboundSchema = GetUserCountRequest$outboundSchema; - })(GetUserCountRequest$ || (GetUserCountRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/getusercountresponse.js - var GetUserCountResponse$inboundSchema = objectType({ - userCount: numberType().int().optional() - }); - var GetUserCountResponse$outboundSchema = objectType({ - userCount: numberType().int().optional() - }); - var GetUserCountResponse$; - (function(GetUserCountResponse$2) { - GetUserCountResponse$2.inboundSchema = GetUserCountResponse$inboundSchema; - GetUserCountResponse$2.outboundSchema = GetUserCountResponse$outboundSchema; - })(GetUserCountResponse$ || (GetUserCountResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/gleanassistinsightsresponse.js - var GleanAssistInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - activityInsights: arrayType(UserActivityInsight$inboundSchema).optional(), - totalActiveUsers: numberType().int().optional(), - datasourceInstances: arrayType(stringType()).optional(), - departments: arrayType(stringType()).optional() - }); - var GleanAssistInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - activityInsights: arrayType(UserActivityInsight$outboundSchema).optional(), - totalActiveUsers: numberType().int().optional(), - datasourceInstances: arrayType(stringType()).optional(), - departments: arrayType(stringType()).optional() - }); - var GleanAssistInsightsResponse$; - (function(GleanAssistInsightsResponse$2) { - GleanAssistInsightsResponse$2.inboundSchema = GleanAssistInsightsResponse$inboundSchema; - GleanAssistInsightsResponse$2.outboundSchema = GleanAssistInsightsResponse$outboundSchema; - })(GleanAssistInsightsResponse$ || (GleanAssistInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/greenlistusersrequest.js - var GreenlistUsersRequest$inboundSchema = objectType({ - datasource: stringType(), - emails: arrayType(stringType()) - }); - var GreenlistUsersRequest$outboundSchema = objectType({ - datasource: stringType(), - emails: arrayType(stringType()) - }); - var GreenlistUsersRequest$; - (function(GreenlistUsersRequest$2) { - GreenlistUsersRequest$2.inboundSchema = GreenlistUsersRequest$inboundSchema; - GreenlistUsersRequest$2.outboundSchema = GreenlistUsersRequest$outboundSchema; - })(GreenlistUsersRequest$ || (GreenlistUsersRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexdocumentrequest.js - var IndexDocumentRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - document: DocumentDefinition$inboundSchema - }); - var IndexDocumentRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - document: DocumentDefinition$outboundSchema - }); - var IndexDocumentRequest$; - (function(IndexDocumentRequest$2) { - IndexDocumentRequest$2.inboundSchema = IndexDocumentRequest$inboundSchema; - IndexDocumentRequest$2.outboundSchema = IndexDocumentRequest$outboundSchema; - })(IndexDocumentRequest$ || (IndexDocumentRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexdocumentsrequest.js - var IndexDocumentsRequest$inboundSchema = objectType({ - uploadId: stringType().optional(), - datasource: stringType(), - documents: arrayType(DocumentDefinition$inboundSchema) - }); - var IndexDocumentsRequest$outboundSchema = objectType({ - uploadId: stringType().optional(), - datasource: stringType(), - documents: arrayType(DocumentDefinition$outboundSchema) - }); - var IndexDocumentsRequest$; - (function(IndexDocumentsRequest$2) { - IndexDocumentsRequest$2.inboundSchema = IndexDocumentsRequest$inboundSchema; - IndexDocumentsRequest$2.outboundSchema = IndexDocumentsRequest$outboundSchema; - })(IndexDocumentsRequest$ || (IndexDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexemployeerequest.js - var IndexEmployeeRequest$inboundSchema = objectType({ - employee: EmployeeInfoDefinition$inboundSchema, - version: numberType().int().optional() - }); - var IndexEmployeeRequest$outboundSchema = objectType({ - employee: EmployeeInfoDefinition$outboundSchema, - version: numberType().int().optional() - }); - var IndexEmployeeRequest$; - (function(IndexEmployeeRequest$2) { - IndexEmployeeRequest$2.inboundSchema = IndexEmployeeRequest$inboundSchema; - IndexEmployeeRequest$2.outboundSchema = IndexEmployeeRequest$outboundSchema; - })(IndexEmployeeRequest$ || (IndexEmployeeRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexgrouprequest.js - var IndexGroupRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - group: DatasourceGroupDefinition$inboundSchema - }); - var IndexGroupRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - group: DatasourceGroupDefinition$outboundSchema - }); - var IndexGroupRequest$; - (function(IndexGroupRequest$2) { - IndexGroupRequest$2.inboundSchema = IndexGroupRequest$inboundSchema; - IndexGroupRequest$2.outboundSchema = IndexGroupRequest$outboundSchema; - })(IndexGroupRequest$ || (IndexGroupRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexingshortcut.js - var IndexingShortcut$inboundSchema = objectType({ - inputAlias: stringType(), - description: stringType().optional(), - destinationUrl: stringType(), - createdBy: stringType(), - createTime: numberType().int().optional(), - updatedBy: stringType().optional(), - updateTime: numberType().int().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional() - }); - var IndexingShortcut$outboundSchema = objectType({ - inputAlias: stringType(), - description: stringType().optional(), - destinationUrl: stringType(), - createdBy: stringType(), - createTime: numberType().int().optional(), - updatedBy: stringType().optional(), - updateTime: numberType().int().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional() - }); - var IndexingShortcut$; - (function(IndexingShortcut$2) { - IndexingShortcut$2.inboundSchema = IndexingShortcut$inboundSchema; - IndexingShortcut$2.outboundSchema = IndexingShortcut$outboundSchema; - })(IndexingShortcut$ || (IndexingShortcut$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexmembershiprequest.js - var IndexMembershipRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - membership: DatasourceMembershipDefinition$inboundSchema - }); - var IndexMembershipRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - membership: DatasourceMembershipDefinition$outboundSchema - }); - var IndexMembershipRequest$; - (function(IndexMembershipRequest$2) { - IndexMembershipRequest$2.inboundSchema = IndexMembershipRequest$inboundSchema; - IndexMembershipRequest$2.outboundSchema = IndexMembershipRequest$outboundSchema; - })(IndexMembershipRequest$ || (IndexMembershipRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexteamrequest.js - var IndexTeamRequest$inboundSchema = objectType({ - team: TeamInfoDefinition$inboundSchema, - version: numberType().int().optional() - }); - var IndexTeamRequest$outboundSchema = objectType({ - team: TeamInfoDefinition$outboundSchema, - version: numberType().int().optional() - }); - var IndexTeamRequest$; - (function(IndexTeamRequest$2) { - IndexTeamRequest$2.inboundSchema = IndexTeamRequest$inboundSchema; - IndexTeamRequest$2.outboundSchema = IndexTeamRequest$outboundSchema; - })(IndexTeamRequest$ || (IndexTeamRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/indexuserrequest.js - var IndexUserRequest$inboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - user: DatasourceUserDefinition$inboundSchema - }); - var IndexUserRequest$outboundSchema = objectType({ - version: numberType().int().optional(), - datasource: stringType(), - user: DatasourceUserDefinition$outboundSchema - }); - var IndexUserRequest$; - (function(IndexUserRequest$2) { - IndexUserRequest$2.inboundSchema = IndexUserRequest$inboundSchema; - IndexUserRequest$2.outboundSchema = IndexUserRequest$outboundSchema; - })(IndexUserRequest$ || (IndexUserRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsagentsrequestoptions.js - var InsightsAgentsRequestOptions$inboundSchema = objectType({ - agentIds: arrayType(stringType()).optional() - }); - var InsightsAgentsRequestOptions$outboundSchema = objectType({ - agentIds: arrayType(stringType()).optional() - }); - var InsightsAgentsRequestOptions$; - (function(InsightsAgentsRequestOptions$2) { - InsightsAgentsRequestOptions$2.inboundSchema = InsightsAgentsRequestOptions$inboundSchema; - InsightsAgentsRequestOptions$2.outboundSchema = InsightsAgentsRequestOptions$outboundSchema; - })(InsightsAgentsRequestOptions$ || (InsightsAgentsRequestOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsaiapprequestoptions.js - var InsightsAiAppRequestOptions$inboundSchema = objectType({ - aiAppIds: arrayType(stringType()).optional() - }); - var InsightsAiAppRequestOptions$outboundSchema = objectType({ - aiAppIds: arrayType(stringType()).optional() - }); - var InsightsAiAppRequestOptions$; - (function(InsightsAiAppRequestOptions$2) { - InsightsAiAppRequestOptions$2.inboundSchema = InsightsAiAppRequestOptions$inboundSchema; - InsightsAiAppRequestOptions$2.outboundSchema = InsightsAiAppRequestOptions$outboundSchema; - })(InsightsAiAppRequestOptions$ || (InsightsAiAppRequestOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsassistantrequest.js - var InsightsAssistantRequest$inboundSchema = objectType({ - departments: arrayType(stringType()).optional(), - dayRange: Period$inboundSchema.optional() - }); - var InsightsAssistantRequest$outboundSchema = objectType({ - departments: arrayType(stringType()).optional(), - dayRange: Period$outboundSchema.optional() - }); - var InsightsAssistantRequest$; - (function(InsightsAssistantRequest$2) { - InsightsAssistantRequest$2.inboundSchema = InsightsAssistantRequest$inboundSchema; - InsightsAssistantRequest$2.outboundSchema = InsightsAssistantRequest$outboundSchema; - })(InsightsAssistantRequest$ || (InsightsAssistantRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsoverviewrequest.js - var InsightsOverviewRequest$inboundSchema = objectType({ - departments: arrayType(stringType()).optional(), - dayRange: Period$inboundSchema.optional() - }); - var InsightsOverviewRequest$outboundSchema = objectType({ - departments: arrayType(stringType()).optional(), - dayRange: Period$outboundSchema.optional() - }); - var InsightsOverviewRequest$; - (function(InsightsOverviewRequest$2) { - InsightsOverviewRequest$2.inboundSchema = InsightsOverviewRequest$inboundSchema; - InsightsOverviewRequest$2.outboundSchema = InsightsOverviewRequest$outboundSchema; - })(InsightsOverviewRequest$ || (InsightsOverviewRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsrequest.js - var InsightsRequestCategory = { - Agents: "AGENTS", - AgentUsers: "AGENT_USERS", - TopAgents: "TOP_AGENTS", - AgentsUsageByDepartment: "AGENTS_USAGE_BY_DEPARTMENT", - Ai: "AI", - AiApps: "AI_APPS", - Announcements: "ANNOUNCEMENTS", - Answers: "ANSWERS", - Collections: "COLLECTIONS", - Content: "CONTENT", - GleanAssist: "GLEAN_ASSIST", - Queries: "QUERIES", - Shortcuts: "SHORTCUTS", - Users: "USERS" - }; - var AssistantActivityType = { - GleanChat: "GLEAN_CHAT", - AiSummary: "AI_SUMMARY", - AiAnswer: "AI_ANSWER", - GleanbotResponse: "GLEANBOT_RESPONSE" - }; - var InsightsRequestCategory$inboundSchema = nativeEnumType(InsightsRequestCategory); - var InsightsRequestCategory$outboundSchema = InsightsRequestCategory$inboundSchema; - var InsightsRequestCategory$; - (function(InsightsRequestCategory$2) { - InsightsRequestCategory$2.inboundSchema = InsightsRequestCategory$inboundSchema; - InsightsRequestCategory$2.outboundSchema = InsightsRequestCategory$outboundSchema; - })(InsightsRequestCategory$ || (InsightsRequestCategory$ = {})); - var AssistantActivityType$inboundSchema = nativeEnumType(AssistantActivityType); - var AssistantActivityType$outboundSchema = AssistantActivityType$inboundSchema; - var AssistantActivityType$; - (function(AssistantActivityType$2) { - AssistantActivityType$2.inboundSchema = AssistantActivityType$inboundSchema; - AssistantActivityType$2.outboundSchema = AssistantActivityType$outboundSchema; - })(AssistantActivityType$ || (AssistantActivityType$ = {})); - var InsightsRequest$inboundSchema = objectType({ - overviewRequest: InsightsOverviewRequest$inboundSchema.optional(), - assistantRequest: InsightsAssistantRequest$inboundSchema.optional(), - agentsRequest: AgentsInsightsV2Request$inboundSchema.optional(), - disablePerUserInsights: booleanType().optional(), - categories: arrayType(InsightsRequestCategory$inboundSchema).optional(), - departments: arrayType(stringType()).optional(), - dayRange: Period$inboundSchema.optional(), - aiAppRequestOptions: InsightsAiAppRequestOptions$inboundSchema.optional(), - agentsRequestOptions: InsightsAgentsRequestOptions$inboundSchema.optional(), - assistantActivityTypes: arrayType(AssistantActivityType$inboundSchema).optional() - }); - var InsightsRequest$outboundSchema = objectType({ - overviewRequest: InsightsOverviewRequest$outboundSchema.optional(), - assistantRequest: InsightsAssistantRequest$outboundSchema.optional(), - agentsRequest: AgentsInsightsV2Request$outboundSchema.optional(), - disablePerUserInsights: booleanType().optional(), - categories: arrayType(InsightsRequestCategory$outboundSchema).optional(), - departments: arrayType(stringType()).optional(), - dayRange: Period$outboundSchema.optional(), - aiAppRequestOptions: InsightsAiAppRequestOptions$outboundSchema.optional(), - agentsRequestOptions: InsightsAgentsRequestOptions$outboundSchema.optional(), - assistantActivityTypes: arrayType(AssistantActivityType$outboundSchema).optional() - }); - var InsightsRequest$; - (function(InsightsRequest$2) { - InsightsRequest$2.inboundSchema = InsightsRequest$inboundSchema; - InsightsRequest$2.outboundSchema = InsightsRequest$outboundSchema; - })(InsightsRequest$ || (InsightsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/labeledcountinfo.js - var LabeledCountInfo$inboundSchema = objectType({ - label: stringType(), - countInfo: arrayType(CountInfo$inboundSchema).optional() - }); - var LabeledCountInfo$outboundSchema = objectType({ - label: stringType(), - countInfo: arrayType(CountInfo$outboundSchema).optional() - }); - var LabeledCountInfo$; - (function(LabeledCountInfo$2) { - LabeledCountInfo$2.inboundSchema = LabeledCountInfo$inboundSchema; - LabeledCountInfo$2.outboundSchema = LabeledCountInfo$outboundSchema; - })(LabeledCountInfo$ || (LabeledCountInfo$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/queryinsight.js - var QueryInsight$inboundSchema = objectType({ - query: stringType(), - searchCount: CountInfo$inboundSchema.optional(), - searchorCount: CountInfo$inboundSchema.optional(), - searchWithClickCount: CountInfo$inboundSchema.optional(), - clickCount: CountInfo$inboundSchema.optional(), - similarQueries: arrayType(lazyType(() => QueryInsight$inboundSchema)).optional() - }); - var QueryInsight$outboundSchema = objectType({ - query: stringType(), - searchCount: CountInfo$outboundSchema.optional(), - searchorCount: CountInfo$outboundSchema.optional(), - searchWithClickCount: CountInfo$outboundSchema.optional(), - clickCount: CountInfo$outboundSchema.optional(), - similarQueries: arrayType(lazyType(() => QueryInsight$outboundSchema)).optional() - }); - var QueryInsight$; - (function(QueryInsight$2) { - QueryInsight$2.inboundSchema = QueryInsight$inboundSchema; - QueryInsight$2.outboundSchema = QueryInsight$outboundSchema; - })(QueryInsight$ || (QueryInsight$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/queryinsightsresponse.js - var QueryInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - queryInsights: arrayType(QueryInsight$inboundSchema).optional(), - lowPerformingQueryInsights: arrayType(QueryInsight$inboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minVisitorThreshold: numberType().int().optional() - }); - var QueryInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - queryInsights: arrayType(QueryInsight$outboundSchema).optional(), - lowPerformingQueryInsights: arrayType(QueryInsight$outboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minVisitorThreshold: numberType().int().optional() - }); - var QueryInsightsResponse$; - (function(QueryInsightsResponse$2) { - QueryInsightsResponse$2.inboundSchema = QueryInsightsResponse$inboundSchema; - QueryInsightsResponse$2.outboundSchema = QueryInsightsResponse$outboundSchema; - })(QueryInsightsResponse$ || (QueryInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcutinsight.js - var ShortcutInsight$inboundSchema = objectType({ - shortcut: Shortcut$inboundSchema, - visitCount: CountInfo$inboundSchema.optional(), - visitorCount: CountInfo$inboundSchema.optional() - }); - var ShortcutInsight$outboundSchema = objectType({ - shortcut: Shortcut$outboundSchema, - visitCount: CountInfo$outboundSchema.optional(), - visitorCount: CountInfo$outboundSchema.optional() - }); - var ShortcutInsight$; - (function(ShortcutInsight$2) { - ShortcutInsight$2.inboundSchema = ShortcutInsight$inboundSchema; - ShortcutInsight$2.outboundSchema = ShortcutInsight$outboundSchema; - })(ShortcutInsight$ || (ShortcutInsight$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcutinsightsresponse.js - var ShortcutInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - shortcutInsights: arrayType(ShortcutInsight$inboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minVisitorThreshold: numberType().int().optional() - }); - var ShortcutInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - shortcutInsights: arrayType(ShortcutInsight$outboundSchema).optional(), - departments: arrayType(stringType()).optional(), - minVisitorThreshold: numberType().int().optional() - }); - var ShortcutInsightsResponse$; - (function(ShortcutInsightsResponse$2) { - ShortcutInsightsResponse$2.inboundSchema = ShortcutInsightsResponse$inboundSchema; - ShortcutInsightsResponse$2.outboundSchema = ShortcutInsightsResponse$outboundSchema; - })(ShortcutInsightsResponse$ || (ShortcutInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/userinsightsresponse.js - var UserInsightsResponse$inboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - activityInsights: arrayType(UserActivityInsight$inboundSchema).optional(), - inactiveInsights: arrayType(UserActivityInsight$inboundSchema).optional(), - totalTeammates: numberType().int().optional(), - totalActiveUsers: numberType().int().optional(), - departments: arrayType(stringType()).optional() - }); - var UserInsightsResponse$outboundSchema = objectType({ - lastLogTimestamp: numberType().int().optional(), - activityInsights: arrayType(UserActivityInsight$outboundSchema).optional(), - inactiveInsights: arrayType(UserActivityInsight$outboundSchema).optional(), - totalTeammates: numberType().int().optional(), - totalActiveUsers: numberType().int().optional(), - departments: arrayType(stringType()).optional() - }); - var UserInsightsResponse$; - (function(UserInsightsResponse$2) { - UserInsightsResponse$2.inboundSchema = UserInsightsResponse$inboundSchema; - UserInsightsResponse$2.outboundSchema = UserInsightsResponse$outboundSchema; - })(UserInsightsResponse$ || (UserInsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/insightsresponse.js - var InsightsResponse$inboundSchema = objectType({ - timeseries: arrayType(LabeledCountInfo$inboundSchema).optional(), - users: UserInsightsResponse$inboundSchema.optional(), - content: ContentInsightsResponse$inboundSchema.optional(), - queries: QueryInsightsResponse$inboundSchema.optional(), - collections: ContentInsightsResponse$inboundSchema.optional(), - collectionsV2: ContentInsightsResponse$inboundSchema.optional(), - shortcuts: ShortcutInsightsResponse$inboundSchema.optional(), - announcements: ContentInsightsResponse$inboundSchema.optional(), - answers: ContentInsightsResponse$inboundSchema.optional(), - ai: AiInsightsResponse$inboundSchema.optional(), - aiApps: AiAppsInsightsResponse$inboundSchema.optional(), - gleanAssist: GleanAssistInsightsResponse$inboundSchema.optional(), - departments: arrayType(stringType()).optional() - }); - var InsightsResponse$outboundSchema = objectType({ - timeseries: arrayType(LabeledCountInfo$outboundSchema).optional(), - users: UserInsightsResponse$outboundSchema.optional(), - content: ContentInsightsResponse$outboundSchema.optional(), - queries: QueryInsightsResponse$outboundSchema.optional(), - collections: ContentInsightsResponse$outboundSchema.optional(), - collectionsV2: ContentInsightsResponse$outboundSchema.optional(), - shortcuts: ShortcutInsightsResponse$outboundSchema.optional(), - announcements: ContentInsightsResponse$outboundSchema.optional(), - answers: ContentInsightsResponse$outboundSchema.optional(), - ai: AiInsightsResponse$outboundSchema.optional(), - aiApps: AiAppsInsightsResponse$outboundSchema.optional(), - gleanAssist: GleanAssistInsightsResponse$outboundSchema.optional(), - departments: arrayType(stringType()).optional() - }); - var InsightsResponse$; - (function(InsightsResponse$2) { - InsightsResponse$2.inboundSchema = InsightsResponse$inboundSchema; - InsightsResponse$2.outboundSchema = InsightsResponse$outboundSchema; - })(InsightsResponse$ || (InsightsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listanswersrequest.js - var ListAnswersRequest$inboundSchema = objectType({ - boardId: numberType().int().optional() - }); - var ListAnswersRequest$outboundSchema = objectType({ - boardId: numberType().int().optional() - }); - var ListAnswersRequest$; - (function(ListAnswersRequest$2) { - ListAnswersRequest$2.inboundSchema = ListAnswersRequest$inboundSchema; - ListAnswersRequest$2.outboundSchema = ListAnswersRequest$outboundSchema; - })(ListAnswersRequest$ || (ListAnswersRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listanswersresponse.js - var ListAnswersResponse$inboundSchema = objectType({ - answerResults: arrayType(AnswerResult$inboundSchema) - }); - var ListAnswersResponse$outboundSchema = objectType({ - answerResults: arrayType(AnswerResult$outboundSchema) - }); - var ListAnswersResponse$; - (function(ListAnswersResponse$2) { - ListAnswersResponse$2.inboundSchema = ListAnswersResponse$inboundSchema; - ListAnswersResponse$2.outboundSchema = ListAnswersResponse$outboundSchema; - })(ListAnswersResponse$ || (ListAnswersResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listchatsresponse.js - var ListChatsResponse$inboundSchema = objectType({ - chatResults: arrayType(ChatMetadataResult$inboundSchema).optional() - }); - var ListChatsResponse$outboundSchema = objectType({ - chatResults: arrayType(ChatMetadataResult$outboundSchema).optional() - }); - var ListChatsResponse$; - (function(ListChatsResponse$2) { - ListChatsResponse$2.inboundSchema = ListChatsResponse$inboundSchema; - ListChatsResponse$2.outboundSchema = ListChatsResponse$outboundSchema; - })(ListChatsResponse$ || (ListChatsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listcollectionsrequest.js - var ListCollectionsRequest$inboundSchema = objectType({ - includeAudience: booleanType().optional(), - includeRoles: booleanType().optional(), - allowedDatasource: stringType().optional() - }); - var ListCollectionsRequest$outboundSchema = objectType({ - includeAudience: booleanType().optional(), - includeRoles: booleanType().optional(), - allowedDatasource: stringType().optional() - }); - var ListCollectionsRequest$; - (function(ListCollectionsRequest$2) { - ListCollectionsRequest$2.inboundSchema = ListCollectionsRequest$inboundSchema; - ListCollectionsRequest$2.outboundSchema = ListCollectionsRequest$outboundSchema; - })(ListCollectionsRequest$ || (ListCollectionsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listcollectionsresponse.js - var ListCollectionsResponse$inboundSchema = objectType({ - collections: arrayType(Collection$inboundSchema) - }); - var ListCollectionsResponse$outboundSchema = objectType({ - collections: arrayType(Collection$outboundSchema) - }); - var ListCollectionsResponse$; - (function(ListCollectionsResponse$2) { - ListCollectionsResponse$2.inboundSchema = ListCollectionsResponse$inboundSchema; - ListCollectionsResponse$2.outboundSchema = ListCollectionsResponse$outboundSchema; - })(ListCollectionsResponse$ || (ListCollectionsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listdlpreportsresponse.js - var ListDlpReportsResponse$inboundSchema = objectType({ - reports: arrayType(DlpReport$inboundSchema).optional() - }); - var ListDlpReportsResponse$outboundSchema = objectType({ - reports: arrayType(DlpReport$outboundSchema).optional() - }); - var ListDlpReportsResponse$; - (function(ListDlpReportsResponse$2) { - ListDlpReportsResponse$2.inboundSchema = ListDlpReportsResponse$inboundSchema; - ListDlpReportsResponse$2.outboundSchema = ListDlpReportsResponse$outboundSchema; - })(ListDlpReportsResponse$ || (ListDlpReportsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/sortoptions.js - var OrderBy = { - Asc: "ASC", - Desc: "DESC" - }; - var OrderBy$inboundSchema = nativeEnumType(OrderBy); - var OrderBy$outboundSchema = OrderBy$inboundSchema; - var OrderBy$; - (function(OrderBy$2) { - OrderBy$2.inboundSchema = OrderBy$inboundSchema; - OrderBy$2.outboundSchema = OrderBy$outboundSchema; - })(OrderBy$ || (OrderBy$ = {})); - var SortOptions$inboundSchema = objectType({ - orderBy: OrderBy$inboundSchema.optional(), - sortBy: stringType().optional() - }); - var SortOptions$outboundSchema = objectType({ - orderBy: OrderBy$outboundSchema.optional(), - sortBy: stringType().optional() - }); - var SortOptions$; - (function(SortOptions$2) { - SortOptions$2.inboundSchema = SortOptions$inboundSchema; - SortOptions$2.outboundSchema = SortOptions$outboundSchema; - })(SortOptions$ || (SortOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listentitiesrequest.js - var ListEntitiesRequestEntityType = { - People: "PEOPLE", - Teams: "TEAMS", - CustomEntities: "CUSTOM_ENTITIES" - }; - var ListEntitiesRequestIncludeField = { - People: "PEOPLE", - Teams: "TEAMS", - PeopleDistance: "PEOPLE_DISTANCE", - Permissions: "PERMISSIONS", - Facets: "FACETS", - InviteInfo: "INVITE_INFO", - LastExtensionUse: "LAST_EXTENSION_USE", - ManagementDetails: "MANAGEMENT_DETAILS", - UnprocessedTeams: "UNPROCESSED_TEAMS" - }; - var RequestType = { - Standard: "STANDARD", - FullDirectory: "FULL_DIRECTORY" - }; - var ListEntitiesRequestEntityType$inboundSchema = nativeEnumType(ListEntitiesRequestEntityType); - var ListEntitiesRequestEntityType$outboundSchema = ListEntitiesRequestEntityType$inboundSchema; - var ListEntitiesRequestEntityType$; - (function(ListEntitiesRequestEntityType$2) { - ListEntitiesRequestEntityType$2.inboundSchema = ListEntitiesRequestEntityType$inboundSchema; - ListEntitiesRequestEntityType$2.outboundSchema = ListEntitiesRequestEntityType$outboundSchema; - })(ListEntitiesRequestEntityType$ || (ListEntitiesRequestEntityType$ = {})); - var ListEntitiesRequestIncludeField$inboundSchema = nativeEnumType(ListEntitiesRequestIncludeField); - var ListEntitiesRequestIncludeField$outboundSchema = ListEntitiesRequestIncludeField$inboundSchema; - var ListEntitiesRequestIncludeField$; - (function(ListEntitiesRequestIncludeField$2) { - ListEntitiesRequestIncludeField$2.inboundSchema = ListEntitiesRequestIncludeField$inboundSchema; - ListEntitiesRequestIncludeField$2.outboundSchema = ListEntitiesRequestIncludeField$outboundSchema; - })(ListEntitiesRequestIncludeField$ || (ListEntitiesRequestIncludeField$ = {})); - var RequestType$inboundSchema = nativeEnumType(RequestType); - var RequestType$outboundSchema = RequestType$inboundSchema; - var RequestType$; - (function(RequestType$2) { - RequestType$2.inboundSchema = RequestType$inboundSchema; - RequestType$2.outboundSchema = RequestType$outboundSchema; - })(RequestType$ || (RequestType$ = {})); - var ListEntitiesRequest$inboundSchema = objectType({ - filter: arrayType(FacetFilter$inboundSchema).optional(), - sort: arrayType(SortOptions$inboundSchema).optional(), - entityType: ListEntitiesRequestEntityType$inboundSchema.default("PEOPLE"), - datasource: stringType().optional(), - query: stringType().optional(), - includeFields: arrayType(ListEntitiesRequestIncludeField$inboundSchema).optional(), - pageSize: numberType().int().optional(), - cursor: stringType().optional(), - source: stringType().optional(), - requestType: RequestType$inboundSchema.default("STANDARD") - }); - var ListEntitiesRequest$outboundSchema = objectType({ - filter: arrayType(FacetFilter$outboundSchema).optional(), - sort: arrayType(SortOptions$outboundSchema).optional(), - entityType: ListEntitiesRequestEntityType$outboundSchema.default("PEOPLE"), - datasource: stringType().optional(), - query: stringType().optional(), - includeFields: arrayType(ListEntitiesRequestIncludeField$outboundSchema).optional(), - pageSize: numberType().int().optional(), - cursor: stringType().optional(), - source: stringType().optional(), - requestType: RequestType$outboundSchema.default("STANDARD") - }); - var ListEntitiesRequest$; - (function(ListEntitiesRequest$2) { - ListEntitiesRequest$2.inboundSchema = ListEntitiesRequest$inboundSchema; - ListEntitiesRequest$2.outboundSchema = ListEntitiesRequest$outboundSchema; - })(ListEntitiesRequest$ || (ListEntitiesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listentitiesresponse.js - var ListEntitiesResponse$inboundSchema = objectType({ - results: arrayType(Person$inboundSchema).optional(), - teamResults: arrayType(Team$inboundSchema).optional(), - customEntityResults: arrayType(CustomEntity$inboundSchema).optional(), - facetResults: arrayType(FacetResult$inboundSchema).optional(), - cursor: stringType().optional(), - totalCount: numberType().int().optional(), - hasMoreResults: booleanType().optional(), - sortOptions: arrayType(EntitiesSortOrder$inboundSchema).optional(), - customFacetNames: arrayType(stringType()).optional() - }); - var ListEntitiesResponse$outboundSchema = objectType({ - results: arrayType(Person$outboundSchema).optional(), - teamResults: arrayType(Team$outboundSchema).optional(), - customEntityResults: arrayType(CustomEntity$outboundSchema).optional(), - facetResults: arrayType(FacetResult$outboundSchema).optional(), - cursor: stringType().optional(), - totalCount: numberType().int().optional(), - hasMoreResults: booleanType().optional(), - sortOptions: arrayType(EntitiesSortOrder$outboundSchema).optional(), - customFacetNames: arrayType(stringType()).optional() - }); - var ListEntitiesResponse$; - (function(ListEntitiesResponse$2) { - ListEntitiesResponse$2.inboundSchema = ListEntitiesResponse$inboundSchema; - ListEntitiesResponse$2.outboundSchema = ListEntitiesResponse$outboundSchema; - })(ListEntitiesResponse$ || (ListEntitiesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listpinsresponse.js - var ListPinsResponse$inboundSchema = objectType({ - pins: arrayType(PinDocument$inboundSchema) - }); - var ListPinsResponse$outboundSchema = objectType({ - pins: arrayType(PinDocument$outboundSchema) - }); - var ListPinsResponse$; - (function(ListPinsResponse$2) { - ListPinsResponse$2.inboundSchema = ListPinsResponse$inboundSchema; - ListPinsResponse$2.outboundSchema = ListPinsResponse$outboundSchema; - })(ListPinsResponse$ || (ListPinsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listshortcutspaginatedrequest.js - var ListShortcutsPaginatedRequestIncludeField = { - Facets: "FACETS", - PeopleDetails: "PEOPLE_DETAILS" - }; - var ListShortcutsPaginatedRequestIncludeField$inboundSchema = nativeEnumType(ListShortcutsPaginatedRequestIncludeField); - var ListShortcutsPaginatedRequestIncludeField$outboundSchema = ListShortcutsPaginatedRequestIncludeField$inboundSchema; - var ListShortcutsPaginatedRequestIncludeField$; - (function(ListShortcutsPaginatedRequestIncludeField$2) { - ListShortcutsPaginatedRequestIncludeField$2.inboundSchema = ListShortcutsPaginatedRequestIncludeField$inboundSchema; - ListShortcutsPaginatedRequestIncludeField$2.outboundSchema = ListShortcutsPaginatedRequestIncludeField$outboundSchema; - })(ListShortcutsPaginatedRequestIncludeField$ || (ListShortcutsPaginatedRequestIncludeField$ = {})); - var ListShortcutsPaginatedRequest$inboundSchema = objectType({ - includeFields: arrayType(ListShortcutsPaginatedRequestIncludeField$inboundSchema).optional(), - pageSize: numberType().int(), - cursor: stringType().optional(), - filters: arrayType(FacetFilter$inboundSchema).optional(), - sort: SortOptions$inboundSchema.optional(), - query: stringType().optional() - }); - var ListShortcutsPaginatedRequest$outboundSchema = objectType({ - includeFields: arrayType(ListShortcutsPaginatedRequestIncludeField$outboundSchema).optional(), - pageSize: numberType().int(), - cursor: stringType().optional(), - filters: arrayType(FacetFilter$outboundSchema).optional(), - sort: SortOptions$outboundSchema.optional(), - query: stringType().optional() - }); - var ListShortcutsPaginatedRequest$; - (function(ListShortcutsPaginatedRequest$2) { - ListShortcutsPaginatedRequest$2.inboundSchema = ListShortcutsPaginatedRequest$inboundSchema; - ListShortcutsPaginatedRequest$2.outboundSchema = ListShortcutsPaginatedRequest$outboundSchema; - })(ListShortcutsPaginatedRequest$ || (ListShortcutsPaginatedRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/shortcutspaginationmetadata.js - var ShortcutsPaginationMetadata$inboundSchema = objectType({ - cursor: stringType().optional(), - hasNextPage: booleanType().optional(), - totalItemCount: numberType().int().optional() - }); - var ShortcutsPaginationMetadata$outboundSchema = objectType({ - cursor: stringType().optional(), - hasNextPage: booleanType().optional(), - totalItemCount: numberType().int().optional() - }); - var ShortcutsPaginationMetadata$; - (function(ShortcutsPaginationMetadata$2) { - ShortcutsPaginationMetadata$2.inboundSchema = ShortcutsPaginationMetadata$inboundSchema; - ShortcutsPaginationMetadata$2.outboundSchema = ShortcutsPaginationMetadata$outboundSchema; - })(ShortcutsPaginationMetadata$ || (ShortcutsPaginationMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/listshortcutspaginatedresponse.js - var ListShortcutsPaginatedResponse$inboundSchema = objectType({ - shortcuts: arrayType(Shortcut$inboundSchema), - facetResults: arrayType(FacetResult$inboundSchema).optional(), - meta: ShortcutsPaginationMetadata$inboundSchema - }); - var ListShortcutsPaginatedResponse$outboundSchema = objectType({ - shortcuts: arrayType(Shortcut$outboundSchema), - facetResults: arrayType(FacetResult$outboundSchema).optional(), - meta: ShortcutsPaginationMetadata$outboundSchema - }); - var ListShortcutsPaginatedResponse$; - (function(ListShortcutsPaginatedResponse$2) { - ListShortcutsPaginatedResponse$2.inboundSchema = ListShortcutsPaginatedResponse$inboundSchema; - ListShortcutsPaginatedResponse$2.outboundSchema = ListShortcutsPaginatedResponse$outboundSchema; - })(ListShortcutsPaginatedResponse$ || (ListShortcutsPaginatedResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/messagesrequest.js - var IdType = { - ChannelName: "CHANNEL_NAME", - ThreadId: "THREAD_ID", - ConversationId: "CONVERSATION_ID" - }; - var Direction = { - Older: "OLDER", - Newer: "NEWER" - }; - var Datasource = { - Slack: "SLACK", - Microsoftteams: "MICROSOFTTEAMS", - Facebookworkplace: "FACEBOOKWORKPLACE" - }; - var IdType$inboundSchema = nativeEnumType(IdType); - var IdType$outboundSchema = IdType$inboundSchema; - var IdType$; - (function(IdType$2) { - IdType$2.inboundSchema = IdType$inboundSchema; - IdType$2.outboundSchema = IdType$outboundSchema; - })(IdType$ || (IdType$ = {})); - var Direction$inboundSchema = nativeEnumType(Direction); - var Direction$outboundSchema = Direction$inboundSchema; - var Direction$; - (function(Direction$2) { - Direction$2.inboundSchema = Direction$inboundSchema; - Direction$2.outboundSchema = Direction$outboundSchema; - })(Direction$ || (Direction$ = {})); - var Datasource$inboundSchema = nativeEnumType(Datasource); - var Datasource$outboundSchema = Datasource$inboundSchema; - var Datasource$; - (function(Datasource$2) { - Datasource$2.inboundSchema = Datasource$inboundSchema; - Datasource$2.outboundSchema = Datasource$outboundSchema; - })(Datasource$ || (Datasource$ = {})); - var MessagesRequest$inboundSchema = objectType({ - idType: IdType$inboundSchema, - id: stringType(), - workspaceId: stringType().optional(), - direction: Direction$inboundSchema.optional(), - timestampMillis: numberType().int().optional(), - includeRootMessage: booleanType().optional(), - datasource: Datasource$inboundSchema.optional(), - datasourceInstanceDisplayName: stringType().optional() - }); - var MessagesRequest$outboundSchema = objectType({ - idType: IdType$outboundSchema, - id: stringType(), - workspaceId: stringType().optional(), - direction: Direction$outboundSchema.optional(), - timestampMillis: numberType().int().optional(), - includeRootMessage: booleanType().optional(), - datasource: Datasource$outboundSchema.optional(), - datasourceInstanceDisplayName: stringType().optional() - }); - var MessagesRequest$; - (function(MessagesRequest$2) { - MessagesRequest$2.inboundSchema = MessagesRequest$inboundSchema; - MessagesRequest$2.outboundSchema = MessagesRequest$outboundSchema; - })(MessagesRequest$ || (MessagesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/resultsdescription.js - var ResultsDescription$inboundSchema = objectType({ - text: stringType().optional(), - iconConfig: IconConfig$inboundSchema.optional() - }); - var ResultsDescription$outboundSchema = objectType({ - text: stringType().optional(), - iconConfig: IconConfig$outboundSchema.optional() - }); - var ResultsDescription$; - (function(ResultsDescription$2) { - ResultsDescription$2.inboundSchema = ResultsDescription$inboundSchema; - ResultsDescription$2.outboundSchema = ResultsDescription$outboundSchema; - })(ResultsDescription$ || (ResultsDescription$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/resulttab.js - var ResultTab$inboundSchema = objectType({ - id: stringType().optional(), - count: numberType().int().optional(), - datasource: stringType().optional(), - datasourceInstance: stringType().optional() - }); - var ResultTab$outboundSchema = objectType({ - id: stringType().optional(), - count: numberType().int().optional(), - datasource: stringType().optional(), - datasourceInstance: stringType().optional() - }); - var ResultTab$; - (function(ResultTab$2) { - ResultTab$2.inboundSchema = ResultTab$inboundSchema; - ResultTab$2.outboundSchema = ResultTab$outboundSchema; - })(ResultTab$ || (ResultTab$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchwarning.js - var WarningType = { - LongQuery: "LONG_QUERY", - QuotedPunctuation: "QUOTED_PUNCTUATION", - PunctuationOnly: "PUNCTUATION_ONLY", - CopypastedQuotes: "COPYPASTED_QUOTES", - InvalidOperator: "INVALID_OPERATOR", - MaybeInvalidFacetQuery: "MAYBE_INVALID_FACET_QUERY", - TooManyDatasourceGroups: "TOO_MANY_DATASOURCE_GROUPS" - }; - var WarningType$inboundSchema = nativeEnumType(WarningType); - var WarningType$outboundSchema = WarningType$inboundSchema; - var WarningType$; - (function(WarningType$2) { - WarningType$2.inboundSchema = WarningType$inboundSchema; - WarningType$2.outboundSchema = WarningType$outboundSchema; - })(WarningType$ || (WarningType$ = {})); - var SearchWarning$inboundSchema = objectType({ - warningType: WarningType$inboundSchema, - lastUsedTerm: stringType().optional(), - quotesIgnoredQuery: stringType().optional(), - ignoredTerms: arrayType(stringType()).optional() - }); - var SearchWarning$outboundSchema = objectType({ - warningType: WarningType$outboundSchema, - lastUsedTerm: stringType().optional(), - quotesIgnoredQuery: stringType().optional(), - ignoredTerms: arrayType(stringType()).optional() - }); - var SearchWarning$; - (function(SearchWarning$2) { - SearchWarning$2.inboundSchema = SearchWarning$inboundSchema; - SearchWarning$2.outboundSchema = SearchWarning$outboundSchema; - })(SearchWarning$ || (SearchWarning$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchresponsemetadata.js - var SearchResponseMetadata$inboundSchema = objectType({ - rewrittenQuery: stringType().optional(), - searchedQuery: stringType().optional(), - searchedQueryWithoutNegation: stringType().optional(), - searchedQueryRanges: arrayType(TextRange$inboundSchema).optional(), - originalQuery: stringType().optional(), - querySuggestion: QuerySuggestion$inboundSchema.optional(), - additionalQuerySuggestions: QuerySuggestionList$inboundSchema.optional(), - negatedTerms: arrayType(stringType()).optional(), - modifiedQueryWasUsed: booleanType().optional(), - originalQueryHadNoResults: booleanType().optional(), - searchWarning: SearchWarning$inboundSchema.optional(), - triggeredExpertDetection: booleanType().optional(), - isNoQuotesSuggestion: booleanType().optional() - }); - var SearchResponseMetadata$outboundSchema = objectType({ - rewrittenQuery: stringType().optional(), - searchedQuery: stringType().optional(), - searchedQueryWithoutNegation: stringType().optional(), - searchedQueryRanges: arrayType(TextRange$outboundSchema).optional(), - originalQuery: stringType().optional(), - querySuggestion: QuerySuggestion$outboundSchema.optional(), - additionalQuerySuggestions: QuerySuggestionList$outboundSchema.optional(), - negatedTerms: arrayType(stringType()).optional(), - modifiedQueryWasUsed: booleanType().optional(), - originalQueryHadNoResults: booleanType().optional(), - searchWarning: SearchWarning$outboundSchema.optional(), - triggeredExpertDetection: booleanType().optional(), - isNoQuotesSuggestion: booleanType().optional() - }); - var SearchResponseMetadata$; - (function(SearchResponseMetadata$2) { - SearchResponseMetadata$2.inboundSchema = SearchResponseMetadata$inboundSchema; - SearchResponseMetadata$2.outboundSchema = SearchResponseMetadata$outboundSchema; - })(SearchResponseMetadata$ || (SearchResponseMetadata$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchresponse.js - var SearchResponse$inboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - results: arrayType(SearchResult$inboundSchema).optional(), - structuredResults: arrayType(StructuredResult$inboundSchema).optional(), - generatedQnaResult: GeneratedQna$inboundSchema.optional(), - errorInfo: GleanDataError$inboundSchema.optional(), - requestID: stringType().optional(), - backendTimeMillis: numberType().int().optional(), - experimentIds: arrayType(numberType().int()).optional(), - metadata: SearchResponseMetadata$inboundSchema.optional(), - facetResults: arrayType(FacetResult$inboundSchema).optional(), - resultTabs: arrayType(ResultTab$inboundSchema).optional(), - resultTabIds: arrayType(stringType()).optional(), - resultsDescription: ResultsDescription$inboundSchema.optional(), - rewrittenFacetFilters: arrayType(FacetFilter$inboundSchema).optional(), - cursor: stringType().optional(), - hasMoreResults: booleanType().optional() - }).transform((v) => { - return remap(v, { - "errorInfo": "gleanDataError" - }); - }); - var SearchResponse$outboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - results: arrayType(SearchResult$outboundSchema).optional(), - structuredResults: arrayType(StructuredResult$outboundSchema).optional(), - generatedQnaResult: GeneratedQna$outboundSchema.optional(), - gleanDataError: GleanDataError$outboundSchema.optional(), - requestID: stringType().optional(), - backendTimeMillis: numberType().int().optional(), - experimentIds: arrayType(numberType().int()).optional(), - metadata: SearchResponseMetadata$outboundSchema.optional(), - facetResults: arrayType(FacetResult$outboundSchema).optional(), - resultTabs: arrayType(ResultTab$outboundSchema).optional(), - resultTabIds: arrayType(stringType()).optional(), - resultsDescription: ResultsDescription$outboundSchema.optional(), - rewrittenFacetFilters: arrayType(FacetFilter$outboundSchema).optional(), - cursor: stringType().optional(), - hasMoreResults: booleanType().optional() - }).transform((v) => { - return remap(v, { - gleanDataError: "errorInfo" - }); - }); - var SearchResponse$; - (function(SearchResponse$2) { - SearchResponse$2.inboundSchema = SearchResponse$inboundSchema; - SearchResponse$2.outboundSchema = SearchResponse$outboundSchema; - })(SearchResponse$ || (SearchResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/messagesresponse.js - var MessagesResponse$inboundSchema = objectType({ - hasMore: booleanType(), - searchResponse: SearchResponse$inboundSchema.optional(), - rootMessage: SearchResult$inboundSchema.optional() - }); - var MessagesResponse$outboundSchema = objectType({ - hasMore: booleanType(), - searchResponse: SearchResponse$outboundSchema.optional(), - rootMessage: SearchResult$outboundSchema.optional() - }); - var MessagesResponse$; - (function(MessagesResponse$2) { - MessagesResponse$2.inboundSchema = MessagesResponse$inboundSchema; - MessagesResponse$2.outboundSchema = MessagesResponse$outboundSchema; - })(MessagesResponse$ || (MessagesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/peoplerequest.js - var PeopleRequestIncludeField = { - Badges: "BADGES", - BusyEvents: "BUSY_EVENTS", - DocumentActivity: "DOCUMENT_ACTIVITY", - InviteInfo: "INVITE_INFO", - PeopleDistance: "PEOPLE_DISTANCE", - Permissions: "PERMISSIONS", - PeopleDetails: "PEOPLE_DETAILS", - ManagementDetails: "MANAGEMENT_DETAILS", - PeopleProfileSettings: "PEOPLE_PROFILE_SETTINGS", - PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER" - }; - var IncludeType = { - PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER", - InvalidEntities: "INVALID_ENTITIES" - }; - var PeopleRequestIncludeField$inboundSchema = nativeEnumType(PeopleRequestIncludeField); - var PeopleRequestIncludeField$outboundSchema = PeopleRequestIncludeField$inboundSchema; - var PeopleRequestIncludeField$; - (function(PeopleRequestIncludeField$2) { - PeopleRequestIncludeField$2.inboundSchema = PeopleRequestIncludeField$inboundSchema; - PeopleRequestIncludeField$2.outboundSchema = PeopleRequestIncludeField$outboundSchema; - })(PeopleRequestIncludeField$ || (PeopleRequestIncludeField$ = {})); - var IncludeType$inboundSchema = nativeEnumType(IncludeType); - var IncludeType$outboundSchema = IncludeType$inboundSchema; - var IncludeType$; - (function(IncludeType$2) { - IncludeType$2.inboundSchema = IncludeType$inboundSchema; - IncludeType$2.outboundSchema = IncludeType$outboundSchema; - })(IncludeType$ || (IncludeType$ = {})); - var PeopleRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - obfuscatedIds: arrayType(stringType()).optional(), - emailIds: arrayType(stringType()).optional(), - includeFields: arrayType(PeopleRequestIncludeField$inboundSchema).optional(), - includeTypes: arrayType(IncludeType$inboundSchema).optional(), - source: stringType().optional() - }); - var PeopleRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - obfuscatedIds: arrayType(stringType()).optional(), - emailIds: arrayType(stringType()).optional(), - includeFields: arrayType(PeopleRequestIncludeField$outboundSchema).optional(), - includeTypes: arrayType(IncludeType$outboundSchema).optional(), - source: stringType().optional() - }); - var PeopleRequest$; - (function(PeopleRequest$2) { - PeopleRequest$2.inboundSchema = PeopleRequest$inboundSchema; - PeopleRequest$2.outboundSchema = PeopleRequest$outboundSchema; - })(PeopleRequest$ || (PeopleRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/peopleresponse.js - var PeopleResponse$inboundSchema = objectType({ - results: arrayType(Person$inboundSchema).optional(), - relatedDocuments: arrayType(RelatedDocuments$inboundSchema).optional(), - errors: arrayType(stringType()).optional() - }); - var PeopleResponse$outboundSchema = objectType({ - results: arrayType(Person$outboundSchema).optional(), - relatedDocuments: arrayType(RelatedDocuments$outboundSchema).optional(), - errors: arrayType(stringType()).optional() - }); - var PeopleResponse$; - (function(PeopleResponse$2) { - PeopleResponse$2.inboundSchema = PeopleResponse$inboundSchema; - PeopleResponse$2.outboundSchema = PeopleResponse$outboundSchema; - })(PeopleResponse$ || (PeopleResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/pinrequest.js - var PinRequest$inboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - documentId: stringType().optional() - }); - var PinRequest$outboundSchema = objectType({ - queries: arrayType(stringType()).optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - documentId: stringType().optional() - }); - var PinRequest$; - (function(PinRequest$2) { - PinRequest$2.inboundSchema = PinRequest$inboundSchema; - PinRequest$2.outboundSchema = PinRequest$outboundSchema; - })(PinRequest$ || (PinRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/processalldocumentsrequest.js - var ProcessAllDocumentsRequest$inboundSchema = objectType({ - datasource: stringType().optional() - }); - var ProcessAllDocumentsRequest$outboundSchema = objectType({ - datasource: stringType().optional() - }); - var ProcessAllDocumentsRequest$; - (function(ProcessAllDocumentsRequest$2) { - ProcessAllDocumentsRequest$2.inboundSchema = ProcessAllDocumentsRequest$inboundSchema; - ProcessAllDocumentsRequest$2.outboundSchema = ProcessAllDocumentsRequest$outboundSchema; - })(ProcessAllDocumentsRequest$ || (ProcessAllDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/processallmembershipsrequest.js - var ProcessAllMembershipsRequest$inboundSchema = objectType({ - datasource: stringType().optional() - }); - var ProcessAllMembershipsRequest$outboundSchema = objectType({ - datasource: stringType().optional() - }); - var ProcessAllMembershipsRequest$; - (function(ProcessAllMembershipsRequest$2) { - ProcessAllMembershipsRequest$2.inboundSchema = ProcessAllMembershipsRequest$inboundSchema; - ProcessAllMembershipsRequest$2.outboundSchema = ProcessAllMembershipsRequest$outboundSchema; - })(ProcessAllMembershipsRequest$ || (ProcessAllMembershipsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/recommendationsrequestoptions.js - var RecommendationsRequestOptions$inboundSchema = objectType({ - datasourceFilter: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - facetFilterSets: arrayType(FacetFilterSet$inboundSchema).optional(), - context: Document$inboundSchema.optional(), - resultProminence: arrayType(SearchResultProminenceEnum$inboundSchema).optional() - }); - var RecommendationsRequestOptions$outboundSchema = objectType({ - datasourceFilter: stringType().optional(), - datasourcesFilter: arrayType(stringType()).optional(), - facetFilterSets: arrayType(FacetFilterSet$outboundSchema).optional(), - context: Document$outboundSchema.optional(), - resultProminence: arrayType(SearchResultProminenceEnum$outboundSchema).optional() - }); - var RecommendationsRequestOptions$; - (function(RecommendationsRequestOptions$2) { - RecommendationsRequestOptions$2.inboundSchema = RecommendationsRequestOptions$inboundSchema; - RecommendationsRequestOptions$2.outboundSchema = RecommendationsRequestOptions$outboundSchema; - })(RecommendationsRequestOptions$ || (RecommendationsRequestOptions$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/recommendationsrequest.js - var RecommendationsRequest$inboundSchema = objectType({ - timestamp: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - sourceDocument: Document$inboundSchema.optional(), - pageSize: numberType().int().optional(), - maxSnippetSize: numberType().int().optional(), - recommendationDocumentSpec: DocumentSpecUnion$inboundSchema.optional(), - requestOptions: RecommendationsRequestOptions$inboundSchema.optional() - }); - var RecommendationsRequest$outboundSchema = objectType({ - timestamp: dateType().transform((v) => v.toISOString()).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - sourceDocument: Document$outboundSchema.optional(), - pageSize: numberType().int().optional(), - maxSnippetSize: numberType().int().optional(), - recommendationDocumentSpec: DocumentSpecUnion$outboundSchema.optional(), - requestOptions: RecommendationsRequestOptions$outboundSchema.optional() - }); - var RecommendationsRequest$; - (function(RecommendationsRequest$2) { - RecommendationsRequest$2.inboundSchema = RecommendationsRequest$inboundSchema; - RecommendationsRequest$2.outboundSchema = RecommendationsRequest$outboundSchema; - })(RecommendationsRequest$ || (RecommendationsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/reminderrequest.js - var ReminderRequest$inboundSchema = objectType({ - documentId: stringType(), - assignee: stringType().optional(), - remindInDays: numberType().int().optional(), - reason: stringType().optional() - }); - var ReminderRequest$outboundSchema = objectType({ - documentId: stringType(), - assignee: stringType().optional(), - remindInDays: numberType().int().optional(), - reason: stringType().optional() - }); - var ReminderRequest$; - (function(ReminderRequest$2) { - ReminderRequest$2.inboundSchema = ReminderRequest$inboundSchema; - ReminderRequest$2.outboundSchema = ReminderRequest$outboundSchema; - })(ReminderRequest$ || (ReminderRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/reportstatusresponse.js - var ReportStatusResponseStatus = { - Pending: "PENDING", - Success: "SUCCESS", - Failure: "FAILURE", - Cancelled: "CANCELLED", - Cancelling: "CANCELLING", - Active: "ACTIVE" - }; - var ReportStatusResponseStatus$inboundSchema = nativeEnumType(ReportStatusResponseStatus); - var ReportStatusResponseStatus$outboundSchema = ReportStatusResponseStatus$inboundSchema; - var ReportStatusResponseStatus$; - (function(ReportStatusResponseStatus$2) { - ReportStatusResponseStatus$2.inboundSchema = ReportStatusResponseStatus$inboundSchema; - ReportStatusResponseStatus$2.outboundSchema = ReportStatusResponseStatus$outboundSchema; - })(ReportStatusResponseStatus$ || (ReportStatusResponseStatus$ = {})); - var ReportStatusResponse$inboundSchema = objectType({ - status: ReportStatusResponseStatus$inboundSchema.optional(), - startTime: stringType().optional() - }); - var ReportStatusResponse$outboundSchema = objectType({ - status: ReportStatusResponseStatus$outboundSchema.optional(), - startTime: stringType().optional() - }); - var ReportStatusResponse$; - (function(ReportStatusResponse$2) { - ReportStatusResponse$2.inboundSchema = ReportStatusResponse$inboundSchema; - ReportStatusResponse$2.outboundSchema = ReportStatusResponse$outboundSchema; - })(ReportStatusResponse$ || (ReportStatusResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/resultsresponse.js - var ResultsResponse$inboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - results: arrayType(SearchResult$inboundSchema).optional(), - structuredResults: arrayType(StructuredResult$inboundSchema).optional(), - generatedQnaResult: GeneratedQna$inboundSchema.optional(), - errorInfo: GleanDataError$inboundSchema.optional(), - requestID: stringType().optional(), - backendTimeMillis: numberType().int().optional() - }).transform((v) => { - return remap(v, { - "errorInfo": "gleanDataError" - }); - }); - var ResultsResponse$outboundSchema = objectType({ - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - results: arrayType(SearchResult$outboundSchema).optional(), - structuredResults: arrayType(StructuredResult$outboundSchema).optional(), - generatedQnaResult: GeneratedQna$outboundSchema.optional(), - gleanDataError: GleanDataError$outboundSchema.optional(), - requestID: stringType().optional(), - backendTimeMillis: numberType().int().optional() - }).transform((v) => { - return remap(v, { - gleanDataError: "errorInfo" - }); - }); - var ResultsResponse$; - (function(ResultsResponse$2) { - ResultsResponse$2.inboundSchema = ResultsResponse$inboundSchema; - ResultsResponse$2.outboundSchema = ResultsResponse$outboundSchema; - })(ResultsResponse$ || (ResultsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/rotatetokenresponse.js - var RotateTokenResponse$inboundSchema = objectType({ - rawSecret: stringType().optional(), - createdAt: numberType().int().optional(), - rotationPeriodMinutes: numberType().int().optional() - }); - var RotateTokenResponse$outboundSchema = objectType({ - rawSecret: stringType().optional(), - createdAt: numberType().int().optional(), - rotationPeriodMinutes: numberType().int().optional() - }); - var RotateTokenResponse$; - (function(RotateTokenResponse$2) { - RotateTokenResponse$2.inboundSchema = RotateTokenResponse$inboundSchema; - RotateTokenResponse$2.outboundSchema = RotateTokenResponse$outboundSchema; - })(RotateTokenResponse$ || (RotateTokenResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchagentsrequest.js - var SearchAgentsRequest$inboundSchema = objectType({ - name: stringType().optional() - }); - var SearchAgentsRequest$outboundSchema = objectType({ - name: stringType().optional() - }); - var SearchAgentsRequest$; - (function(SearchAgentsRequest$2) { - SearchAgentsRequest$2.inboundSchema = SearchAgentsRequest$inboundSchema; - SearchAgentsRequest$2.outboundSchema = SearchAgentsRequest$outboundSchema; - })(SearchAgentsRequest$ || (SearchAgentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchagentsresponse.js - var SearchAgentsResponse$inboundSchema = objectType({ - agents: arrayType(Agent$inboundSchema).optional() - }); - var SearchAgentsResponse$outboundSchema = objectType({ - agents: arrayType(Agent$outboundSchema).optional() - }); - var SearchAgentsResponse$; - (function(SearchAgentsResponse$2) { - SearchAgentsResponse$2.inboundSchema = SearchAgentsResponse$inboundSchema; - SearchAgentsResponse$2.outboundSchema = SearchAgentsResponse$outboundSchema; - })(SearchAgentsResponse$ || (SearchAgentsResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/searchrequest.js - var SearchRequest$inboundSchema = objectType({ - timestamp: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$inboundSchema.optional(), - sourceDocument: Document$inboundSchema.optional(), - pageSize: numberType().int().optional(), - maxSnippetSize: numberType().int().optional(), - query: stringType(), - cursor: stringType().optional(), - resultTabIds: arrayType(stringType()).optional(), - inputDetails: SearchRequestInputDetails$inboundSchema.optional(), - requestOptions: SearchRequestOptions$inboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - disableSpellcheck: booleanType().optional() - }); - var SearchRequest$outboundSchema = objectType({ - timestamp: dateType().transform((v) => v.toISOString()).optional(), - trackingToken: stringType().optional(), - sessionInfo: SessionInfo$outboundSchema.optional(), - sourceDocument: Document$outboundSchema.optional(), - pageSize: numberType().int().optional(), - maxSnippetSize: numberType().int().optional(), - query: stringType(), - cursor: stringType().optional(), - resultTabIds: arrayType(stringType()).optional(), - inputDetails: SearchRequestInputDetails$outboundSchema.optional(), - requestOptions: SearchRequestOptions$outboundSchema.optional(), - timeoutMillis: numberType().int().optional(), - disableSpellcheck: booleanType().optional() - }); - var SearchRequest$; - (function(SearchRequest$2) { - SearchRequest$2.inboundSchema = SearchRequest$inboundSchema; - SearchRequest$2.outboundSchema = SearchRequest$outboundSchema; - })(SearchRequest$ || (SearchRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/security.js - var Security$inboundSchema = objectType({ - APIToken: stringType().optional() - }).transform((v) => { - return remap(v, { - "APIToken": "apiToken" - }); - }); - var Security$outboundSchema = objectType({ - apiToken: stringType().optional() - }).transform((v) => { - return remap(v, { - apiToken: "APIToken" - }); - }); - var Security$; - (function(Security$2) { - Security$2.inboundSchema = Security$inboundSchema; - Security$2.outboundSchema = Security$outboundSchema; - })(Security$ || (Security$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/summarizerequest.js - var SummarizeRequest$inboundSchema = objectType({ - timestamp: stringType().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - query: stringType().optional(), - preferredSummaryLength: numberType().int().optional(), - documentSpecs: arrayType(DocumentSpecUnion$inboundSchema), - trackingToken: stringType().optional() - }); - var SummarizeRequest$outboundSchema = objectType({ - timestamp: dateType().transform((v) => v.toISOString()).optional(), - query: stringType().optional(), - preferredSummaryLength: numberType().int().optional(), - documentSpecs: arrayType(DocumentSpecUnion$outboundSchema), - trackingToken: stringType().optional() - }); - var SummarizeRequest$; - (function(SummarizeRequest$2) { - SummarizeRequest$2.inboundSchema = SummarizeRequest$inboundSchema; - SummarizeRequest$2.outboundSchema = SummarizeRequest$outboundSchema; - })(SummarizeRequest$ || (SummarizeRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/summary.js - var Summary$inboundSchema = objectType({ - text: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional() - }); - var Summary$outboundSchema = objectType({ - text: stringType().optional(), - followUpPrompts: arrayType(stringType()).optional() - }); - var Summary$; - (function(Summary$2) { - Summary$2.inboundSchema = Summary$inboundSchema; - Summary$2.outboundSchema = Summary$outboundSchema; - })(Summary$ || (Summary$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/summarizeresponse.js - var ErrorT$inboundSchema = objectType({ - message: stringType().optional() - }); - var ErrorT$outboundSchema = objectType({ - message: stringType().optional() - }); - var ErrorT$; - (function(ErrorT$2) { - ErrorT$2.inboundSchema = ErrorT$inboundSchema; - ErrorT$2.outboundSchema = ErrorT$outboundSchema; - })(ErrorT$ || (ErrorT$ = {})); - var SummarizeResponse$inboundSchema = objectType({ - error: lazyType(() => ErrorT$inboundSchema).optional(), - summary: Summary$inboundSchema.optional(), - trackingToken: stringType().optional() - }); - var SummarizeResponse$outboundSchema = objectType({ - error: lazyType(() => ErrorT$outboundSchema).optional(), - summary: Summary$outboundSchema.optional(), - trackingToken: stringType().optional() - }); - var SummarizeResponse$; - (function(SummarizeResponse$2) { - SummarizeResponse$2.inboundSchema = SummarizeResponse$inboundSchema; - SummarizeResponse$2.outboundSchema = SummarizeResponse$outboundSchema; - })(SummarizeResponse$ || (SummarizeResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolparameter.js - var ToolParameterType = { - String: "string", - Number: "number", - Boolean: "boolean", - Object: "object", - Array: "array" - }; - var ToolParameterType$inboundSchema = nativeEnumType(ToolParameterType); - var ToolParameterType$outboundSchema = ToolParameterType$inboundSchema; - var ToolParameterType$; - (function(ToolParameterType$2) { - ToolParameterType$2.inboundSchema = ToolParameterType$inboundSchema; - ToolParameterType$2.outboundSchema = ToolParameterType$outboundSchema; - })(ToolParameterType$ || (ToolParameterType$ = {})); - var ToolParameter$inboundSchema = objectType({ - type: ToolParameterType$inboundSchema.optional(), - name: stringType().optional(), - description: stringType().optional(), - isRequired: booleanType().optional(), - possibleValues: arrayType(stringType()).optional(), - items: lazyType(() => ToolParameter$inboundSchema).optional(), - properties: recordType(lazyType(() => ToolParameter$inboundSchema)).optional() - }); - var ToolParameter$outboundSchema = objectType({ - type: ToolParameterType$outboundSchema.optional(), - name: stringType().optional(), - description: stringType().optional(), - isRequired: booleanType().optional(), - possibleValues: arrayType(stringType()).optional(), - items: lazyType(() => ToolParameter$outboundSchema).optional(), - properties: recordType(lazyType(() => ToolParameter$outboundSchema)).optional() - }); - var ToolParameter$; - (function(ToolParameter$2) { - ToolParameter$2.inboundSchema = ToolParameter$inboundSchema; - ToolParameter$2.outboundSchema = ToolParameter$outboundSchema; - })(ToolParameter$ || (ToolParameter$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/tool.js - var ToolType = { - Read: "READ", - Write: "WRITE" - }; - var ToolType$inboundSchema = nativeEnumType(ToolType); - var ToolType$outboundSchema = ToolType$inboundSchema; - var ToolType$; - (function(ToolType$2) { - ToolType$2.inboundSchema = ToolType$inboundSchema; - ToolType$2.outboundSchema = ToolType$outboundSchema; - })(ToolType$ || (ToolType$ = {})); - var Tool$inboundSchema = objectType({ - type: ToolType$inboundSchema.optional(), - name: stringType().optional(), - displayName: stringType().optional(), - description: stringType().optional(), - parameters: recordType(ToolParameter$inboundSchema).optional() - }); - var Tool$outboundSchema = objectType({ - type: ToolType$outboundSchema.optional(), - name: stringType().optional(), - displayName: stringType().optional(), - description: stringType().optional(), - parameters: recordType(ToolParameter$outboundSchema).optional() - }); - var Tool$; - (function(Tool$2) { - Tool$2.inboundSchema = Tool$inboundSchema; - Tool$2.outboundSchema = Tool$outboundSchema; - })(Tool$ || (Tool$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolscallparameter.js - var ToolsCallParameter$inboundSchema = objectType({ - name: stringType(), - value: stringType(), - items: arrayType(lazyType(() => ToolsCallParameter$inboundSchema)).optional(), - properties: recordType(lazyType(() => ToolsCallParameter$inboundSchema)).optional() - }); - var ToolsCallParameter$outboundSchema = objectType({ - name: stringType(), - value: stringType(), - items: arrayType(lazyType(() => ToolsCallParameter$outboundSchema)).optional(), - properties: recordType(lazyType(() => ToolsCallParameter$outboundSchema)).optional() - }); - var ToolsCallParameter$; - (function(ToolsCallParameter$2) { - ToolsCallParameter$2.inboundSchema = ToolsCallParameter$inboundSchema; - ToolsCallParameter$2.outboundSchema = ToolsCallParameter$outboundSchema; - })(ToolsCallParameter$ || (ToolsCallParameter$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolscallrequest.js - var ToolsCallRequest$inboundSchema = objectType({ - name: stringType(), - parameters: recordType(ToolsCallParameter$inboundSchema) - }); - var ToolsCallRequest$outboundSchema = objectType({ - name: stringType(), - parameters: recordType(ToolsCallParameter$outboundSchema) - }); - var ToolsCallRequest$; - (function(ToolsCallRequest$2) { - ToolsCallRequest$2.inboundSchema = ToolsCallRequest$inboundSchema; - ToolsCallRequest$2.outboundSchema = ToolsCallRequest$outboundSchema; - })(ToolsCallRequest$ || (ToolsCallRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolscallresponse.js - var ToolsCallResponse$inboundSchema = objectType({ - rawResponse: recordType(anyType()).optional(), - error: stringType().optional() - }); - var ToolsCallResponse$outboundSchema = objectType({ - rawResponse: recordType(anyType()).optional(), - error: stringType().optional() - }); - var ToolsCallResponse$; - (function(ToolsCallResponse$2) { - ToolsCallResponse$2.inboundSchema = ToolsCallResponse$inboundSchema; - ToolsCallResponse$2.outboundSchema = ToolsCallResponse$outboundSchema; - })(ToolsCallResponse$ || (ToolsCallResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/toolslistresponse.js - var ToolsListResponse$inboundSchema = objectType({ - tools: arrayType(Tool$inboundSchema).optional() - }); - var ToolsListResponse$outboundSchema = objectType({ - tools: arrayType(Tool$outboundSchema).optional() - }); - var ToolsListResponse$; - (function(ToolsListResponse$2) { - ToolsListResponse$2.inboundSchema = ToolsListResponse$inboundSchema; - ToolsListResponse$2.outboundSchema = ToolsListResponse$outboundSchema; - })(ToolsListResponse$ || (ToolsListResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/unpin.js - var Unpin$inboundSchema = objectType({ - id: stringType().optional() - }); - var Unpin$outboundSchema = objectType({ - id: stringType().optional() - }); - var Unpin$; - (function(Unpin$2) { - Unpin$2.inboundSchema = Unpin$inboundSchema; - Unpin$2.outboundSchema = Unpin$outboundSchema; - })(Unpin$ || (Unpin$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updateannouncementrequest.js - var UpdateAnnouncementRequestChannel = { - Main: "MAIN", - SocialFeed: "SOCIAL_FEED" - }; - var UpdateAnnouncementRequestPostType = { - Text: "TEXT", - Link: "LINK" - }; - var UpdateAnnouncementRequestChannel$inboundSchema = nativeEnumType(UpdateAnnouncementRequestChannel); - var UpdateAnnouncementRequestChannel$outboundSchema = UpdateAnnouncementRequestChannel$inboundSchema; - var UpdateAnnouncementRequestChannel$; - (function(UpdateAnnouncementRequestChannel$2) { - UpdateAnnouncementRequestChannel$2.inboundSchema = UpdateAnnouncementRequestChannel$inboundSchema; - UpdateAnnouncementRequestChannel$2.outboundSchema = UpdateAnnouncementRequestChannel$outboundSchema; - })(UpdateAnnouncementRequestChannel$ || (UpdateAnnouncementRequestChannel$ = {})); - var UpdateAnnouncementRequestPostType$inboundSchema = nativeEnumType(UpdateAnnouncementRequestPostType); - var UpdateAnnouncementRequestPostType$outboundSchema = UpdateAnnouncementRequestPostType$inboundSchema; - var UpdateAnnouncementRequestPostType$; - (function(UpdateAnnouncementRequestPostType$2) { - UpdateAnnouncementRequestPostType$2.inboundSchema = UpdateAnnouncementRequestPostType$inboundSchema; - UpdateAnnouncementRequestPostType$2.outboundSchema = UpdateAnnouncementRequestPostType$outboundSchema; - })(UpdateAnnouncementRequestPostType$ || (UpdateAnnouncementRequestPostType$ = {})); - var UpdateAnnouncementRequest$inboundSchema = objectType({ - startTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)), - endTime: stringType().datetime({ offset: true }).transform((v) => new Date(v)), - title: stringType(), - body: StructuredText$inboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$inboundSchema.optional(), - banner: Thumbnail$inboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$inboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: UpdateAnnouncementRequestChannel$inboundSchema.optional(), - postType: UpdateAnnouncementRequestPostType$inboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional(), - id: numberType().int() - }); - var UpdateAnnouncementRequest$outboundSchema = objectType({ - startTime: dateType().transform((v) => v.toISOString()), - endTime: dateType().transform((v) => v.toISOString()), - title: stringType(), - body: StructuredText$outboundSchema.optional(), - emoji: stringType().optional(), - thumbnail: Thumbnail$outboundSchema.optional(), - banner: Thumbnail$outboundSchema.optional(), - audienceFilters: arrayType(FacetFilter$outboundSchema).optional(), - sourceDocumentId: stringType().optional(), - hideAttribution: booleanType().optional(), - channel: UpdateAnnouncementRequestChannel$outboundSchema.optional(), - postType: UpdateAnnouncementRequestPostType$outboundSchema.optional(), - isPrioritized: booleanType().optional(), - viewUrl: stringType().optional(), - id: numberType().int() - }); - var UpdateAnnouncementRequest$; - (function(UpdateAnnouncementRequest$2) { - UpdateAnnouncementRequest$2.inboundSchema = UpdateAnnouncementRequest$inboundSchema; - UpdateAnnouncementRequest$2.outboundSchema = UpdateAnnouncementRequest$outboundSchema; - })(UpdateAnnouncementRequest$ || (UpdateAnnouncementRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedlpconfigrequest.js - var UpdateDlpConfigRequest$inboundSchema = objectType({ - config: DlpConfig$inboundSchema.optional(), - frequency: stringType().optional() - }); - var UpdateDlpConfigRequest$outboundSchema = objectType({ - config: DlpConfig$outboundSchema.optional(), - frequency: stringType().optional() - }); - var UpdateDlpConfigRequest$; - (function(UpdateDlpConfigRequest$2) { - UpdateDlpConfigRequest$2.inboundSchema = UpdateDlpConfigRequest$inboundSchema; - UpdateDlpConfigRequest$2.outboundSchema = UpdateDlpConfigRequest$outboundSchema; - })(UpdateDlpConfigRequest$ || (UpdateDlpConfigRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedlpconfigresponse.js - var UpdateDlpConfigResponse$inboundSchema = objectType({ - result: DlpSimpleResult$inboundSchema.optional(), - reportId: stringType().optional() - }); - var UpdateDlpConfigResponse$outboundSchema = objectType({ - result: DlpSimpleResult$outboundSchema.optional(), - reportId: stringType().optional() - }); - var UpdateDlpConfigResponse$; - (function(UpdateDlpConfigResponse$2) { - UpdateDlpConfigResponse$2.inboundSchema = UpdateDlpConfigResponse$inboundSchema; - UpdateDlpConfigResponse$2.outboundSchema = UpdateDlpConfigResponse$outboundSchema; - })(UpdateDlpConfigResponse$ || (UpdateDlpConfigResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedlpreportrequest.js - var UpdateDlpReportRequest$inboundSchema = objectType({ - config: DlpConfig$inboundSchema.optional(), - frequency: DlpFrequency$inboundSchema.optional(), - status: DlpReportStatus$inboundSchema.optional(), - autoHideDocs: booleanType().optional(), - reportName: stringType().optional() - }); - var UpdateDlpReportRequest$outboundSchema = objectType({ - config: DlpConfig$outboundSchema.optional(), - frequency: DlpFrequency$outboundSchema.optional(), - status: DlpReportStatus$outboundSchema.optional(), - autoHideDocs: booleanType().optional(), - reportName: stringType().optional() - }); - var UpdateDlpReportRequest$; - (function(UpdateDlpReportRequest$2) { - UpdateDlpReportRequest$2.inboundSchema = UpdateDlpReportRequest$inboundSchema; - UpdateDlpReportRequest$2.outboundSchema = UpdateDlpReportRequest$outboundSchema; - })(UpdateDlpReportRequest$ || (UpdateDlpReportRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedlpreportresponse.js - var UpdateDlpReportResponse$inboundSchema = objectType({ - result: DlpSimpleResult$inboundSchema.optional() - }); - var UpdateDlpReportResponse$outboundSchema = objectType({ - result: DlpSimpleResult$outboundSchema.optional() - }); - var UpdateDlpReportResponse$; - (function(UpdateDlpReportResponse$2) { - UpdateDlpReportResponse$2.inboundSchema = UpdateDlpReportResponse$inboundSchema; - UpdateDlpReportResponse$2.outboundSchema = UpdateDlpReportResponse$outboundSchema; - })(UpdateDlpReportResponse$ || (UpdateDlpReportResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedocumentvisibilityoverridesrequest.js - var UpdateDocumentVisibilityOverridesRequest$inboundSchema = objectType({ - visibilityOverrides: arrayType(DocumentVisibilityOverride$inboundSchema).optional() - }); - var UpdateDocumentVisibilityOverridesRequest$outboundSchema = objectType({ - visibilityOverrides: arrayType(DocumentVisibilityOverride$outboundSchema).optional() - }); - var UpdateDocumentVisibilityOverridesRequest$; - (function(UpdateDocumentVisibilityOverridesRequest$2) { - UpdateDocumentVisibilityOverridesRequest$2.inboundSchema = UpdateDocumentVisibilityOverridesRequest$inboundSchema; - UpdateDocumentVisibilityOverridesRequest$2.outboundSchema = UpdateDocumentVisibilityOverridesRequest$outboundSchema; - })(UpdateDocumentVisibilityOverridesRequest$ || (UpdateDocumentVisibilityOverridesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatedocumentvisibilityoverridesresponse.js - var UpdateDocumentVisibilityOverridesResponse$inboundSchema = objectType({ - results: arrayType(DocumentVisibilityUpdateResult$inboundSchema).optional() - }); - var UpdateDocumentVisibilityOverridesResponse$outboundSchema = objectType({ - results: arrayType(DocumentVisibilityUpdateResult$outboundSchema).optional() - }); - var UpdateDocumentVisibilityOverridesResponse$; - (function(UpdateDocumentVisibilityOverridesResponse$2) { - UpdateDocumentVisibilityOverridesResponse$2.inboundSchema = UpdateDocumentVisibilityOverridesResponse$inboundSchema; - UpdateDocumentVisibilityOverridesResponse$2.outboundSchema = UpdateDocumentVisibilityOverridesResponse$outboundSchema; - })(UpdateDocumentVisibilityOverridesResponse$ || (UpdateDocumentVisibilityOverridesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updatepermissionsrequest.js - var UpdatePermissionsRequest$inboundSchema = objectType({ - datasource: stringType(), - objectType: stringType().optional(), - id: stringType().optional(), - viewURL: stringType().optional(), - permissions: DocumentPermissionsDefinition$inboundSchema - }); - var UpdatePermissionsRequest$outboundSchema = objectType({ - datasource: stringType(), - objectType: stringType().optional(), - id: stringType().optional(), - viewURL: stringType().optional(), - permissions: DocumentPermissionsDefinition$outboundSchema - }); - var UpdatePermissionsRequest$; - (function(UpdatePermissionsRequest$2) { - UpdatePermissionsRequest$2.inboundSchema = UpdatePermissionsRequest$inboundSchema; - UpdatePermissionsRequest$2.outboundSchema = UpdatePermissionsRequest$outboundSchema; - })(UpdatePermissionsRequest$ || (UpdatePermissionsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updateshortcutrequest.js - var UpdateShortcutRequest$inboundSchema = objectType({ - id: numberType().int(), - inputAlias: stringType().optional(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$inboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$inboundSchema).optional() - }); - var UpdateShortcutRequest$outboundSchema = objectType({ - id: numberType().int(), - inputAlias: stringType().optional(), - destinationUrl: stringType().optional(), - destinationDocumentId: stringType().optional(), - description: stringType().optional(), - unlisted: booleanType().optional(), - urlTemplate: stringType().optional(), - addedRoles: arrayType(UserRoleSpecification$outboundSchema).optional(), - removedRoles: arrayType(UserRoleSpecification$outboundSchema).optional() - }); - var UpdateShortcutRequest$; - (function(UpdateShortcutRequest$2) { - UpdateShortcutRequest$2.inboundSchema = UpdateShortcutRequest$inboundSchema; - UpdateShortcutRequest$2.outboundSchema = UpdateShortcutRequest$outboundSchema; - })(UpdateShortcutRequest$ || (UpdateShortcutRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/updateshortcutresponse.js - var UpdateShortcutResponse$inboundSchema = objectType({ - shortcut: Shortcut$inboundSchema.optional(), - error: ShortcutError$inboundSchema.optional() - }); - var UpdateShortcutResponse$outboundSchema = objectType({ - shortcut: Shortcut$outboundSchema.optional(), - error: ShortcutError$outboundSchema.optional() - }); - var UpdateShortcutResponse$; - (function(UpdateShortcutResponse$2) { - UpdateShortcutResponse$2.inboundSchema = UpdateShortcutResponse$inboundSchema; - UpdateShortcutResponse$2.outboundSchema = UpdateShortcutResponse$outboundSchema; - })(UpdateShortcutResponse$ || (UpdateShortcutResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/uploadchatfilesrequest.js - var FileT$inboundSchema = objectType({ - fileName: stringType(), - content: unionType([ - instanceOfType(ReadableStream), - instanceOfType(Blob), - instanceOfType(ArrayBuffer), - instanceOfType(Uint8Array) - ]) - }); - var FileT$outboundSchema = objectType({ - fileName: stringType(), - content: unionType([ - instanceOfType(ReadableStream), - instanceOfType(Blob), - instanceOfType(ArrayBuffer), - instanceOfType(Uint8Array) - ]) - }); - var FileT$; - (function(FileT$2) { - FileT$2.inboundSchema = FileT$inboundSchema; - FileT$2.outboundSchema = FileT$outboundSchema; - })(FileT$ || (FileT$ = {})); - var UploadChatFilesRequest$inboundSchema = objectType({ - files: arrayType(lazyType(() => FileT$inboundSchema)) - }); - var UploadChatFilesRequest$outboundSchema = objectType({ - files: arrayType(lazyType(() => FileT$outboundSchema)) - }); - var UploadChatFilesRequest$; - (function(UploadChatFilesRequest$2) { - UploadChatFilesRequest$2.inboundSchema = UploadChatFilesRequest$inboundSchema; - UploadChatFilesRequest$2.outboundSchema = UploadChatFilesRequest$outboundSchema; - })(UploadChatFilesRequest$ || (UploadChatFilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/uploadchatfilesresponse.js - var UploadChatFilesResponse$inboundSchema = objectType({ - files: arrayType(ChatFile$inboundSchema).optional() - }); - var UploadChatFilesResponse$outboundSchema = objectType({ - files: arrayType(ChatFile$outboundSchema).optional() - }); - var UploadChatFilesResponse$; - (function(UploadChatFilesResponse$2) { - UploadChatFilesResponse$2.inboundSchema = UploadChatFilesResponse$inboundSchema; - UploadChatFilesResponse$2.outboundSchema = UploadChatFilesResponse$outboundSchema; - })(UploadChatFilesResponse$ || (UploadChatFilesResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/uploadshortcutsrequest.js - var UploadShortcutsRequest$inboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - shortcuts: arrayType(IndexingShortcut$inboundSchema) - }); - var UploadShortcutsRequest$outboundSchema = objectType({ - uploadId: stringType(), - isFirstPage: booleanType().optional(), - isLastPage: booleanType().optional(), - forceRestartUpload: booleanType().optional(), - shortcuts: arrayType(IndexingShortcut$outboundSchema) - }); - var UploadShortcutsRequest$; - (function(UploadShortcutsRequest$2) { - UploadShortcutsRequest$2.inboundSchema = UploadShortcutsRequest$inboundSchema; - UploadShortcutsRequest$2.outboundSchema = UploadShortcutsRequest$outboundSchema; - })(UploadShortcutsRequest$ || (UploadShortcutsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/verificationfeed.js - var VerificationFeed$inboundSchema = objectType({ - documents: arrayType(Verification$inboundSchema).optional() - }); - var VerificationFeed$outboundSchema = objectType({ - documents: arrayType(Verification$outboundSchema).optional() - }); - var VerificationFeed$; - (function(VerificationFeed$2) { - VerificationFeed$2.inboundSchema = VerificationFeed$inboundSchema; - VerificationFeed$2.outboundSchema = VerificationFeed$outboundSchema; - })(VerificationFeed$ || (VerificationFeed$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/components/verifyrequest.js - var VerifyRequestAction = { - Verify: "VERIFY", - Deprecate: "DEPRECATE", - Unverify: "UNVERIFY" - }; - var VerifyRequestAction$inboundSchema = nativeEnumType(VerifyRequestAction); - var VerifyRequestAction$outboundSchema = VerifyRequestAction$inboundSchema; - var VerifyRequestAction$; - (function(VerifyRequestAction$2) { - VerifyRequestAction$2.inboundSchema = VerifyRequestAction$inboundSchema; - VerifyRequestAction$2.outboundSchema = VerifyRequestAction$outboundSchema; - })(VerifyRequestAction$ || (VerifyRequestAction$ = {})); - var VerifyRequest$inboundSchema = objectType({ - documentId: stringType(), - action: VerifyRequestAction$inboundSchema.optional() - }); - var VerifyRequest$outboundSchema = objectType({ - documentId: stringType(), - action: VerifyRequestAction$outboundSchema.optional() - }); - var VerifyRequest$; - (function(VerifyRequest$2) { - VerifyRequest$2.inboundSchema = VerifyRequest$inboundSchema; - VerifyRequest$2.outboundSchema = VerifyRequest$outboundSchema; - })(VerifyRequest$ || (VerifyRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/chat.js - var ChatRequest$inboundSchema2 = objectType({ - timezoneOffset: numberType().int().optional(), - ChatRequest: ChatRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "ChatRequest": "chatRequest" - }); - }); - var ChatRequest$outboundSchema2 = objectType({ - timezoneOffset: numberType().int().optional(), - chatRequest: ChatRequest$outboundSchema - }).transform((v) => { - return remap(v, { - chatRequest: "ChatRequest" - }); - }); - var ChatRequest$2; - (function(ChatRequest$3) { - ChatRequest$3.inboundSchema = ChatRequest$inboundSchema2; - ChatRequest$3.outboundSchema = ChatRequest$outboundSchema2; - })(ChatRequest$2 || (ChatRequest$2 = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/chatstream.js - var ChatStreamRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - ChatRequest: ChatRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "ChatRequest": "chatRequest" - }); - }); - var ChatStreamRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - chatRequest: ChatRequest$outboundSchema - }).transform((v) => { - return remap(v, { - chatRequest: "ChatRequest" - }); - }); - var ChatStreamRequest$; - (function(ChatStreamRequest$2) { - ChatStreamRequest$2.inboundSchema = ChatStreamRequest$inboundSchema; - ChatStreamRequest$2.outboundSchema = ChatStreamRequest$outboundSchema; - })(ChatStreamRequest$ || (ChatStreamRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/createcollection.js - var ResponseBody2$inboundSchema = objectType({ - collection: Collection$inboundSchema.optional(), - error: CollectionError$inboundSchema - }); - var ResponseBody2$outboundSchema = objectType({ - collection: Collection$outboundSchema.optional(), - error: CollectionError$outboundSchema - }); - var ResponseBody2$; - (function(ResponseBody2$2) { - ResponseBody2$2.inboundSchema = ResponseBody2$inboundSchema; - ResponseBody2$2.outboundSchema = ResponseBody2$outboundSchema; - })(ResponseBody2$ || (ResponseBody2$ = {})); - var ResponseBody1$inboundSchema = objectType({ - collection: Collection$inboundSchema, - error: CollectionError$inboundSchema.optional() - }); - var ResponseBody1$outboundSchema = objectType({ - collection: Collection$outboundSchema, - error: CollectionError$outboundSchema.optional() - }); - var ResponseBody1$; - (function(ResponseBody1$2) { - ResponseBody1$2.inboundSchema = ResponseBody1$inboundSchema; - ResponseBody1$2.outboundSchema = ResponseBody1$outboundSchema; - })(ResponseBody1$ || (ResponseBody1$ = {})); - var CreatecollectionResponse$inboundSchema = unionType([ - lazyType(() => ResponseBody1$inboundSchema), - lazyType(() => ResponseBody2$inboundSchema) - ]); - var CreatecollectionResponse$outboundSchema = unionType([ - lazyType(() => ResponseBody1$outboundSchema), - lazyType(() => ResponseBody2$outboundSchema) - ]); - var CreatecollectionResponse$; - (function(CreatecollectionResponse$2) { - CreatecollectionResponse$2.inboundSchema = CreatecollectionResponse$inboundSchema; - CreatecollectionResponse$2.outboundSchema = CreatecollectionResponse$outboundSchema; - })(CreatecollectionResponse$ || (CreatecollectionResponse$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/deleteallchats.js - var DeleteallchatsRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional() - }); - var DeleteallchatsRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional() - }); - var DeleteallchatsRequest$; - (function(DeleteallchatsRequest$2) { - DeleteallchatsRequest$2.inboundSchema = DeleteallchatsRequest$inboundSchema; - DeleteallchatsRequest$2.outboundSchema = DeleteallchatsRequest$outboundSchema; - })(DeleteallchatsRequest$ || (DeleteallchatsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/deletechatfiles.js - var DeletechatfilesRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - DeleteChatFilesRequest: DeleteChatFilesRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "DeleteChatFilesRequest": "deleteChatFilesRequest" - }); - }); - var DeletechatfilesRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - deleteChatFilesRequest: DeleteChatFilesRequest$outboundSchema - }).transform((v) => { - return remap(v, { - deleteChatFilesRequest: "DeleteChatFilesRequest" - }); - }); - var DeletechatfilesRequest$; - (function(DeletechatfilesRequest$2) { - DeletechatfilesRequest$2.inboundSchema = DeletechatfilesRequest$inboundSchema; - DeletechatfilesRequest$2.outboundSchema = DeletechatfilesRequest$outboundSchema; - })(DeletechatfilesRequest$ || (DeletechatfilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/deletechats.js - var DeletechatsRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - DeleteChatsRequest: DeleteChatsRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "DeleteChatsRequest": "deleteChatsRequest" - }); - }); - var DeletechatsRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - deleteChatsRequest: DeleteChatsRequest$outboundSchema - }).transform((v) => { - return remap(v, { - deleteChatsRequest: "DeleteChatsRequest" - }); - }); - var DeletechatsRequest$; - (function(DeletechatsRequest$2) { - DeletechatsRequest$2.inboundSchema = DeletechatsRequest$inboundSchema; - DeletechatsRequest$2.outboundSchema = DeletechatsRequest$outboundSchema; - })(DeletechatsRequest$ || (DeletechatsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/downloadpolicycsv.js - var DownloadpolicycsvRequest$inboundSchema = objectType({ - id: stringType() - }); - var DownloadpolicycsvRequest$outboundSchema = objectType({ - id: stringType() - }); - var DownloadpolicycsvRequest$; - (function(DownloadpolicycsvRequest$2) { - DownloadpolicycsvRequest$2.inboundSchema = DownloadpolicycsvRequest$inboundSchema; - DownloadpolicycsvRequest$2.outboundSchema = DownloadpolicycsvRequest$outboundSchema; - })(DownloadpolicycsvRequest$ || (DownloadpolicycsvRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/downloadreportcsv.js - var DownloadreportcsvRequest$inboundSchema = objectType({ - id: stringType() - }); - var DownloadreportcsvRequest$outboundSchema = objectType({ - id: stringType() - }); - var DownloadreportcsvRequest$; - (function(DownloadreportcsvRequest$2) { - DownloadreportcsvRequest$2.inboundSchema = DownloadreportcsvRequest$inboundSchema; - DownloadreportcsvRequest$2.outboundSchema = DownloadreportcsvRequest$outboundSchema; - })(DownloadreportcsvRequest$ || (DownloadreportcsvRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/feedback.js - var FeedbackRequest$inboundSchema = objectType({ - feedbackQueryParameter: stringType().optional(), - Feedback1: Feedback$inboundSchema.optional() - }).transform((v) => { - return remap(v, { - "Feedback1": "feedback1" - }); - }); - var FeedbackRequest$outboundSchema = objectType({ - feedbackQueryParameter: stringType().optional(), - feedback1: Feedback$outboundSchema.optional() - }).transform((v) => { - return remap(v, { - feedback1: "Feedback1" - }); - }); - var FeedbackRequest$; - (function(FeedbackRequest$2) { - FeedbackRequest$2.inboundSchema = FeedbackRequest$inboundSchema; - FeedbackRequest$2.outboundSchema = FeedbackRequest$outboundSchema; - })(FeedbackRequest$ || (FeedbackRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getagent.js - var GetAgentRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - agent_id: stringType() - }).transform((v) => { - return remap(v, { - "agent_id": "agentId" - }); - }); - var GetAgentRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - agentId: stringType() - }).transform((v) => { - return remap(v, { - agentId: "agent_id" - }); - }); - var GetAgentRequest$; - (function(GetAgentRequest$2) { - GetAgentRequest$2.inboundSchema = GetAgentRequest$inboundSchema; - GetAgentRequest$2.outboundSchema = GetAgentRequest$outboundSchema; - })(GetAgentRequest$ || (GetAgentRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getagentschemas.js - var GetAgentSchemasRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - agent_id: stringType() - }).transform((v) => { - return remap(v, { - "agent_id": "agentId" - }); - }); - var GetAgentSchemasRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - agentId: stringType() - }).transform((v) => { - return remap(v, { - agentId: "agent_id" - }); - }); - var GetAgentSchemasRequest$; - (function(GetAgentSchemasRequest$2) { - GetAgentSchemasRequest$2.inboundSchema = GetAgentSchemasRequest$inboundSchema; - GetAgentSchemasRequest$2.outboundSchema = GetAgentSchemasRequest$outboundSchema; - })(GetAgentSchemasRequest$ || (GetAgentSchemasRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getchat.js - var GetchatRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - GetChatRequest: GetChatRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "GetChatRequest": "getChatRequest" - }); - }); - var GetchatRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - getChatRequest: GetChatRequest$outboundSchema - }).transform((v) => { - return remap(v, { - getChatRequest: "GetChatRequest" - }); - }); - var GetchatRequest$; - (function(GetchatRequest$2) { - GetchatRequest$2.inboundSchema = GetchatRequest$inboundSchema; - GetchatRequest$2.outboundSchema = GetchatRequest$outboundSchema; - })(GetchatRequest$ || (GetchatRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getchatapplication.js - var GetchatapplicationRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - GetChatApplicationRequest: GetChatApplicationRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "GetChatApplicationRequest": "getChatApplicationRequest" - }); - }); - var GetchatapplicationRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - getChatApplicationRequest: GetChatApplicationRequest$outboundSchema - }).transform((v) => { - return remap(v, { - getChatApplicationRequest: "GetChatApplicationRequest" - }); - }); - var GetchatapplicationRequest$; - (function(GetchatapplicationRequest$2) { - GetchatapplicationRequest$2.inboundSchema = GetchatapplicationRequest$inboundSchema; - GetchatapplicationRequest$2.outboundSchema = GetchatapplicationRequest$outboundSchema; - })(GetchatapplicationRequest$ || (GetchatapplicationRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getchatfiles.js - var GetchatfilesRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - GetChatFilesRequest: GetChatFilesRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "GetChatFilesRequest": "getChatFilesRequest" - }); - }); - var GetchatfilesRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - getChatFilesRequest: GetChatFilesRequest$outboundSchema - }).transform((v) => { - return remap(v, { - getChatFilesRequest: "GetChatFilesRequest" - }); - }); - var GetchatfilesRequest$; - (function(GetchatfilesRequest$2) { - GetchatfilesRequest$2.inboundSchema = GetchatfilesRequest$inboundSchema; - GetchatfilesRequest$2.outboundSchema = GetchatfilesRequest$outboundSchema; - })(GetchatfilesRequest$ || (GetchatfilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getdocvisibility.js - var GetdocvisibilityRequest$inboundSchema = objectType({ - docIds: arrayType(stringType()).optional() - }); - var GetdocvisibilityRequest$outboundSchema = objectType({ - docIds: arrayType(stringType()).optional() - }); - var GetdocvisibilityRequest$; - (function(GetdocvisibilityRequest$2) { - GetdocvisibilityRequest$2.inboundSchema = GetdocvisibilityRequest$inboundSchema; - GetdocvisibilityRequest$2.outboundSchema = GetdocvisibilityRequest$outboundSchema; - })(GetdocvisibilityRequest$ || (GetdocvisibilityRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getpolicy.js - var GetpolicyRequest$inboundSchema = objectType({ - id: stringType(), - version: numberType().int().optional() - }); - var GetpolicyRequest$outboundSchema = objectType({ - id: stringType(), - version: numberType().int().optional() - }); - var GetpolicyRequest$; - (function(GetpolicyRequest$2) { - GetpolicyRequest$2.inboundSchema = GetpolicyRequest$inboundSchema; - GetpolicyRequest$2.outboundSchema = GetpolicyRequest$outboundSchema; - })(GetpolicyRequest$ || (GetpolicyRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getreportstatus.js - var GetreportstatusRequest$inboundSchema = objectType({ - id: stringType() - }); - var GetreportstatusRequest$outboundSchema = objectType({ - id: stringType() - }); - var GetreportstatusRequest$; - (function(GetreportstatusRequest$2) { - GetreportstatusRequest$2.inboundSchema = GetreportstatusRequest$inboundSchema; - GetreportstatusRequest$2.outboundSchema = GetreportstatusRequest$outboundSchema; - })(GetreportstatusRequest$ || (GetreportstatusRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/getrestapiv1toolslist.js - var GetRestApiV1ToolsListRequest$inboundSchema = objectType({ - toolNames: arrayType(stringType()).optional() - }); - var GetRestApiV1ToolsListRequest$outboundSchema = objectType({ - toolNames: arrayType(stringType()).optional() - }); - var GetRestApiV1ToolsListRequest$; - (function(GetRestApiV1ToolsListRequest$2) { - GetRestApiV1ToolsListRequest$2.inboundSchema = GetRestApiV1ToolsListRequest$inboundSchema; - GetRestApiV1ToolsListRequest$2.outboundSchema = GetRestApiV1ToolsListRequest$outboundSchema; - })(GetRestApiV1ToolsListRequest$ || (GetRestApiV1ToolsListRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/listchats.js - var ListchatsRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional() - }); - var ListchatsRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional() - }); - var ListchatsRequest$; - (function(ListchatsRequest$2) { - ListchatsRequest$2.inboundSchema = ListchatsRequest$inboundSchema; - ListchatsRequest$2.outboundSchema = ListchatsRequest$outboundSchema; - })(ListchatsRequest$ || (ListchatsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/listpins.js - var ListpinsRequest$inboundSchema = objectType({}); - var ListpinsRequest$outboundSchema = objectType({}); - var ListpinsRequest$; - (function(ListpinsRequest$2) { - ListpinsRequest$2.inboundSchema = ListpinsRequest$inboundSchema; - ListpinsRequest$2.outboundSchema = ListpinsRequest$outboundSchema; - })(ListpinsRequest$ || (ListpinsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/listpolicies.js - var ListpoliciesRequest$inboundSchema = objectType({ - autoHide: booleanType().optional(), - frequency: stringType().optional() - }); - var ListpoliciesRequest$outboundSchema = objectType({ - autoHide: booleanType().optional(), - frequency: stringType().optional() - }); - var ListpoliciesRequest$; - (function(ListpoliciesRequest$2) { - ListpoliciesRequest$2.inboundSchema = ListpoliciesRequest$inboundSchema; - ListpoliciesRequest$2.outboundSchema = ListpoliciesRequest$outboundSchema; - })(ListpoliciesRequest$ || (ListpoliciesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/listverifications.js - var ListverificationsRequest$inboundSchema = objectType({ - count: numberType().int().optional() - }); - var ListverificationsRequest$outboundSchema = objectType({ - count: numberType().int().optional() - }); - var ListverificationsRequest$; - (function(ListverificationsRequest$2) { - ListverificationsRequest$2.inboundSchema = ListverificationsRequest$inboundSchema; - ListverificationsRequest$2.outboundSchema = ListverificationsRequest$outboundSchema; - })(ListverificationsRequest$ || (ListverificationsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/postapiindexv1debugdatasourcedocument.js - var PostApiIndexV1DebugDatasourceDocumentRequest$inboundSchema = objectType({ - datasource: stringType(), - DebugDocumentRequest: DebugDocumentRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "DebugDocumentRequest": "debugDocumentRequest" - }); - }); - var PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema = objectType({ - datasource: stringType(), - debugDocumentRequest: DebugDocumentRequest$outboundSchema - }).transform((v) => { - return remap(v, { - debugDocumentRequest: "DebugDocumentRequest" - }); - }); - var PostApiIndexV1DebugDatasourceDocumentRequest$; - (function(PostApiIndexV1DebugDatasourceDocumentRequest$2) { - PostApiIndexV1DebugDatasourceDocumentRequest$2.inboundSchema = PostApiIndexV1DebugDatasourceDocumentRequest$inboundSchema; - PostApiIndexV1DebugDatasourceDocumentRequest$2.outboundSchema = PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema; - })(PostApiIndexV1DebugDatasourceDocumentRequest$ || (PostApiIndexV1DebugDatasourceDocumentRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/postapiindexv1debugdatasourcedocuments.js - var PostApiIndexV1DebugDatasourceDocumentsRequest$inboundSchema = objectType({ - datasource: stringType(), - DebugDocumentsRequest: DebugDocumentsRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "DebugDocumentsRequest": "debugDocumentsRequest" - }); - }); - var PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema = objectType({ - datasource: stringType(), - debugDocumentsRequest: DebugDocumentsRequest$outboundSchema - }).transform((v) => { - return remap(v, { - debugDocumentsRequest: "DebugDocumentsRequest" - }); - }); - var PostApiIndexV1DebugDatasourceDocumentsRequest$; - (function(PostApiIndexV1DebugDatasourceDocumentsRequest$2) { - PostApiIndexV1DebugDatasourceDocumentsRequest$2.inboundSchema = PostApiIndexV1DebugDatasourceDocumentsRequest$inboundSchema; - PostApiIndexV1DebugDatasourceDocumentsRequest$2.outboundSchema = PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema; - })(PostApiIndexV1DebugDatasourceDocumentsRequest$ || (PostApiIndexV1DebugDatasourceDocumentsRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/postapiindexv1debugdatasourcestatus.js - var PostApiIndexV1DebugDatasourceStatusRequest$inboundSchema = objectType({ - datasource: stringType() - }); - var PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema = objectType({ - datasource: stringType() - }); - var PostApiIndexV1DebugDatasourceStatusRequest$; - (function(PostApiIndexV1DebugDatasourceStatusRequest$2) { - PostApiIndexV1DebugDatasourceStatusRequest$2.inboundSchema = PostApiIndexV1DebugDatasourceStatusRequest$inboundSchema; - PostApiIndexV1DebugDatasourceStatusRequest$2.outboundSchema = PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema; - })(PostApiIndexV1DebugDatasourceStatusRequest$ || (PostApiIndexV1DebugDatasourceStatusRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/postapiindexv1debugdatasourceuser.js - var PostApiIndexV1DebugDatasourceUserRequest$inboundSchema = objectType({ - datasource: stringType(), - DebugUserRequest: DebugUserRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "DebugUserRequest": "debugUserRequest" - }); - }); - var PostApiIndexV1DebugDatasourceUserRequest$outboundSchema = objectType({ - datasource: stringType(), - debugUserRequest: DebugUserRequest$outboundSchema - }).transform((v) => { - return remap(v, { - debugUserRequest: "DebugUserRequest" - }); - }); - var PostApiIndexV1DebugDatasourceUserRequest$; - (function(PostApiIndexV1DebugDatasourceUserRequest$2) { - PostApiIndexV1DebugDatasourceUserRequest$2.inboundSchema = PostApiIndexV1DebugDatasourceUserRequest$inboundSchema; - PostApiIndexV1DebugDatasourceUserRequest$2.outboundSchema = PostApiIndexV1DebugDatasourceUserRequest$outboundSchema; - })(PostApiIndexV1DebugDatasourceUserRequest$ || (PostApiIndexV1DebugDatasourceUserRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/updatepolicy.js - var UpdatepolicyRequest$inboundSchema = objectType({ - id: stringType(), - UpdateDlpReportRequest: UpdateDlpReportRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "UpdateDlpReportRequest": "updateDlpReportRequest" - }); - }); - var UpdatepolicyRequest$outboundSchema = objectType({ - id: stringType(), - updateDlpReportRequest: UpdateDlpReportRequest$outboundSchema - }).transform((v) => { - return remap(v, { - updateDlpReportRequest: "UpdateDlpReportRequest" - }); - }); - var UpdatepolicyRequest$; - (function(UpdatepolicyRequest$2) { - UpdatepolicyRequest$2.inboundSchema = UpdatepolicyRequest$inboundSchema; - UpdatepolicyRequest$2.outboundSchema = UpdatepolicyRequest$outboundSchema; - })(UpdatepolicyRequest$ || (UpdatepolicyRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/operations/uploadchatfiles.js - var UploadchatfilesRequest$inboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - UploadChatFilesRequest: UploadChatFilesRequest$inboundSchema - }).transform((v) => { - return remap(v, { - "UploadChatFilesRequest": "uploadChatFilesRequest" - }); - }); - var UploadchatfilesRequest$outboundSchema = objectType({ - timezoneOffset: numberType().int().optional(), - uploadChatFilesRequest: UploadChatFilesRequest$outboundSchema - }).transform((v) => { - return remap(v, { - uploadChatFilesRequest: "UploadChatFilesRequest" - }); - }); - var UploadchatfilesRequest$; - (function(UploadchatfilesRequest$2) { - UploadchatfilesRequest$2.inboundSchema = UploadchatfilesRequest$inboundSchema; - UploadchatfilesRequest$2.outboundSchema = UploadchatfilesRequest$outboundSchema; - })(UploadchatfilesRequest$ || (UploadchatfilesRequest$ = {})); - - // node_modules/@gleanwork/api-client/dist/esm/types/async.js - var __classPrivateFieldSet2 = function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet2 = function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _APIPromise_promise; - var _APIPromise_unwrapped; - var _a; - var APIPromise = class { - constructor(p) { - _APIPromise_promise.set(this, void 0); - _APIPromise_unwrapped.set(this, void 0); - this[_a] = "APIPromise"; - __classPrivateFieldSet2(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f"); - __classPrivateFieldSet2(this, _APIPromise_unwrapped, p instanceof Promise ? __classPrivateFieldGet2(this, _APIPromise_promise, "f").then(([value]) => value) : Promise.resolve(p[0]), "f"); - } - then(onfulfilled, onrejected) { - return __classPrivateFieldGet2(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected); - } - catch(onrejected) { - return __classPrivateFieldGet2(this, _APIPromise_unwrapped, "f").catch(onrejected); - } - finally(onfinally) { - return __classPrivateFieldGet2(this, _APIPromise_unwrapped, "f").finally(onfinally); - } - $inspect() { - return __classPrivateFieldGet2(this, _APIPromise_promise, "f"); - } - }; - _APIPromise_promise = /* @__PURE__ */ new WeakMap(), _APIPromise_unwrapped = /* @__PURE__ */ new WeakMap(), _a = Symbol.toStringTag; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientActivityFeedback.js - function clientActivityFeedback(client, feedback1, feedbackQueryParameter, options) { - return new APIPromise($do(client, feedback1, feedbackQueryParameter, options)); - } - async function $do(client, feedback1, feedbackQueryParameter, options) { - const input = { - feedback1, - feedbackQueryParameter - }; - const parsed = safeParse(input, (value) => FeedbackRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.Feedback1, { explode: true }); - const path = pathToFunc("/rest/api/v1/feedback")(); - const query = encodeFormQuery({ - "feedback": payload.feedbackQueryParameter - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "feedback", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientActivityReport.js - function clientActivityReport(client, request, options) { - return new APIPromise($do2(client, request, options)); - } - async function $do2(client, request, options) { - const parsed = safeParse(request, (value) => Activity$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/activity")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "activity", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/activity.js - var Activity = class extends ClientSDK { - /** - * Report document activity - * - * @remarks - * Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality. - */ - async report(request, options) { - return unwrapAsync(clientActivityReport(this, request, options)); - } - /** - * Report client activity - * - * @remarks - * Report events that happen to results within a Glean client UI, such as search result views and clicks. This signal improves search quality. - */ - async feedback(feedback1, feedbackQueryParameter, options) { - return unwrapAsync(clientActivityFeedback(this, feedback1, feedbackQueryParameter, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAgentsList.js - function clientAgentsList(client, request, options) { - return new APIPromise($do3(client, request, options)); - } - async function $do3(client, request, options) { - const parsed = safeParse(request, (value) => SearchAgentsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/agents/search")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "searchAgents", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "403", "404", "422", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, SearchAgentsResponse$inboundSchema), fail([400, 403, 404, 422, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAgentsRetrieve.js - function clientAgentsRetrieve(client, agentId, timezoneOffset, options) { - return new APIPromise($do4(client, agentId, timezoneOffset, options)); - } - async function $do4(client, agentId, timezoneOffset, options) { - const input = { - agentId, - timezoneOffset - }; - const parsed = safeParse(input, (value) => GetAgentRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: encodeSimple("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/agents/{agent_id}")(pathParams); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getAgent", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "403", "404", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Agent$inboundSchema), fail([400, 403, 404, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAgentsRetrieveSchemas.js - function clientAgentsRetrieveSchemas(client, agentId, timezoneOffset, options) { - return new APIPromise($do5(client, agentId, timezoneOffset, options)); - } - async function $do5(client, agentId, timezoneOffset, options) { - const input = { - agentId, - timezoneOffset - }; - const parsed = safeParse(input, (value) => GetAgentSchemasRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: encodeSimple("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/agents/{agent_id}/schemas")(pathParams); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getAgentSchemas", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "403", "404", "422", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, AgentSchemas$inboundSchema), fail([400, 403, 404, 422, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAgentsRun.js - function clientAgentsRun(client, request, options) { - return new APIPromise($do6(client, request, options)); - } - async function $do6(client, request, options) { - const parsed = safeParse(request, (value) => AgentRunCreate$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/agents/runs/wait")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createAndWaitRun", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "403", "404", "409", "422", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, AgentRunWaitResponse$inboundSchema), fail([400, 403, 404, 409, 422, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAgentsRunStream.js - function clientAgentsRunStream(client, request, options) { - return new APIPromise($do7(client, request, options)); - } - async function $do7(client, request, options) { - const parsed = safeParse(request, (value) => AgentRunCreate$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/agents/runs/stream")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createAndStreamRun", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "403", "404", "409", "422", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(text(200, stringType(), { ctype: "text/event-stream" }), fail([400, 403, 404, 409, 422, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/agents.js - var Agents = class extends ClientSDK { - /** - * Retrieve an agent - * - * @remarks - * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder. - */ - async retrieve(agentId, timezoneOffset, options) { - return unwrapAsync(clientAgentsRetrieve(this, agentId, timezoneOffset, options)); - } - /** - * List an agent's schemas - * - * @remarks - * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure. - */ - async retrieveSchemas(agentId, timezoneOffset, options) { - return unwrapAsync(clientAgentsRetrieveSchemas(this, agentId, timezoneOffset, options)); - } - /** - * Search agents - * - * @remarks - * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name. - */ - async list(request, options) { - return unwrapAsync(clientAgentsList(this, request, options)); - } - /** - * Create an agent run and stream the response - * - * @remarks - * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). - */ - async runStream(request, options) { - return unwrapAsync(clientAgentsRunStream(this, request, options)); - } - /** - * Create an agent run and wait for the response - * - * @remarks - * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. - */ - async run(request, options) { - return unwrapAsync(clientAgentsRun(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnnouncementsCreate.js - function clientAnnouncementsCreate(client, request, options) { - return new APIPromise($do8(client, request, options)); - } - async function $do8(client, request, options) { - const parsed = safeParse(request, (value) => CreateAnnouncementRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/createannouncement")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createannouncement", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Announcement$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnnouncementsDelete.js - function clientAnnouncementsDelete(client, request, options) { - return new APIPromise($do9(client, request, options)); - } - async function $do9(client, request, options) { - const parsed = safeParse(request, (value) => DeleteAnnouncementRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/deleteannouncement")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deleteannouncement", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnnouncementsUpdate.js - function clientAnnouncementsUpdate(client, request, options) { - return new APIPromise($do10(client, request, options)); - } - async function $do10(client, request, options) { - const parsed = safeParse(request, (value) => UpdateAnnouncementRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/updateannouncement")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "updateannouncement", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Announcement$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/announcements.js - var Announcements = class extends ClientSDK { - /** - * Create Announcement - * - * @remarks - * Create a textual announcement visible to some set of users based on department and location. - */ - async create(request, options) { - return unwrapAsync(clientAnnouncementsCreate(this, request, options)); - } - /** - * Delete Announcement - * - * @remarks - * Delete an existing user-generated announcement. - */ - async delete(request, options) { - return unwrapAsync(clientAnnouncementsDelete(this, request, options)); - } - /** - * Update Announcement - * - * @remarks - * Update a textual announcement visible to some set of users based on department and location. - */ - async update(request, options) { - return unwrapAsync(clientAnnouncementsUpdate(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnswersCreate.js - function clientAnswersCreate(client, request, options) { - return new APIPromise($do11(client, request, options)); - } - async function $do11(client, request, options) { - const parsed = safeParse(request, (value) => CreateAnswerRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/createanswer")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createanswer", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Answer$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnswersDelete.js - function clientAnswersDelete(client, request, options) { - return new APIPromise($do12(client, request, options)); - } - async function $do12(client, request, options) { - const parsed = safeParse(request, (value) => DeleteAnswerRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/deleteanswer")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deleteanswer", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnswersList.js - function clientAnswersList(client, request, options) { - return new APIPromise($do13(client, request, options)); - } - async function $do13(client, request, options) { - const parsed = safeParse(request, (value) => ListAnswersRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/listanswers")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listanswers", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListAnswersResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnswersRetrieve.js - function clientAnswersRetrieve(client, request, options) { - return new APIPromise($do14(client, request, options)); - } - async function $do14(client, request, options) { - const parsed = safeParse(request, (value) => GetAnswerRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getanswer")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getanswer", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetAnswerResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAnswersUpdate.js - function clientAnswersUpdate(client, request, options) { - return new APIPromise($do15(client, request, options)); - } - async function $do15(client, request, options) { - const parsed = safeParse(request, (value) => EditAnswerRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/editanswer")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "editanswer", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Answer$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/answers.js - var Answers = class extends ClientSDK { - /** - * Create Answer - * - * @remarks - * Create a user-generated Answer that contains a question and answer. - */ - async create(request, options) { - return unwrapAsync(clientAnswersCreate(this, request, options)); - } - /** - * Delete Answer - * - * @remarks - * Delete an existing user-generated Answer. - */ - async delete(request, options) { - return unwrapAsync(clientAnswersDelete(this, request, options)); - } - /** - * Update Answer - * - * @remarks - * Update an existing user-generated Answer. - */ - async update(request, options) { - return unwrapAsync(clientAnswersUpdate(this, request, options)); - } - /** - * Read Answer - * - * @remarks - * Read the details of a particular Answer given its ID. - */ - async retrieve(request, options) { - return unwrapAsync(clientAnswersRetrieve(this, request, options)); - } - /** - * List Answers - * - * @remarks - * List Answers created by the current user. - */ - async list(request, options) { - return unwrapAsync(clientAnswersList(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatCreate.js - function clientChatCreate(client, chatRequest, timezoneOffset, options) { - return new APIPromise($do16(client, chatRequest, timezoneOffset, options)); - } - async function $do16(client, chatRequest, timezoneOffset, options) { - const input = { - chatRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => ChatRequest$outboundSchema2.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ChatRequest, { explode: true }); - const path = pathToFunc("/rest/api/v1/chat")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "408", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ChatResponse$inboundSchema), fail([400, 401, 408, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatCreateStream.js - function clientChatCreateStream(client, chatRequest, timezoneOffset, options) { - return new APIPromise($do17(client, chatRequest, timezoneOffset, options)); - } - async function $do17(client, chatRequest, timezoneOffset, options) { - const input = { - chatRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => ChatStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ChatRequest, { explode: true }); - const path = pathToFunc("/rest/api/v1/chat#stream")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/plain" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chatStream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "408", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(text(200, stringType()), fail([400, 401, 408, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatDelete.js - function clientChatDelete(client, deleteChatsRequest, timezoneOffset, options) { - return new APIPromise($do18(client, deleteChatsRequest, timezoneOffset, options)); - } - async function $do18(client, deleteChatsRequest, timezoneOffset, options) { - const input = { - deleteChatsRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => DeletechatsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DeleteChatsRequest, { - explode: true - }); - const path = pathToFunc("/rest/api/v1/deletechats")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deletechats", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatDeleteAll.js - function clientChatDeleteAll(client, timezoneOffset, options) { - return new APIPromise($do19(client, timezoneOffset, options)); - } - async function $do19(client, timezoneOffset, options) { - const input = { - timezoneOffset - }; - const parsed = safeParse(input, (value) => DeleteallchatsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/deleteallchats")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deleteallchats", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 403, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatDeleteFiles.js - function clientChatDeleteFiles(client, deleteChatFilesRequest, timezoneOffset, options) { - return new APIPromise($do20(client, deleteChatFilesRequest, timezoneOffset, options)); - } - async function $do20(client, deleteChatFilesRequest, timezoneOffset, options) { - const input = { - deleteChatFilesRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => DeletechatfilesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DeleteChatFilesRequest, { - explode: true - }); - const path = pathToFunc("/rest/api/v1/deletechatfiles")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deletechatfiles", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatList.js - function clientChatList(client, timezoneOffset, options) { - return new APIPromise($do21(client, timezoneOffset, options)); - } - async function $do21(client, timezoneOffset, options) { - const input = { - timezoneOffset - }; - const parsed = safeParse(input, (value) => ListchatsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/listchats")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listchats", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListChatsResponse$inboundSchema), fail([401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatRetrieve.js - function clientChatRetrieve(client, getChatRequest, timezoneOffset, options) { - return new APIPromise($do22(client, getChatRequest, timezoneOffset, options)); - } - async function $do22(client, getChatRequest, timezoneOffset, options) { - const input = { - getChatRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => GetchatRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.GetChatRequest, { explode: true }); - const path = pathToFunc("/rest/api/v1/getchat")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getchat", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetChatResponse$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatRetrieveApplication.js - function clientChatRetrieveApplication(client, getChatApplicationRequest, timezoneOffset, options) { - return new APIPromise($do23(client, getChatApplicationRequest, timezoneOffset, options)); - } - async function $do23(client, getChatApplicationRequest, timezoneOffset, options) { - const input = { - getChatApplicationRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => GetchatapplicationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.GetChatApplicationRequest, { - explode: true - }); - const path = pathToFunc("/rest/api/v1/getchatapplication")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getchatapplication", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetChatApplicationResponse$inboundSchema), fail([400, 401, 403, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatRetrieveFiles.js - function clientChatRetrieveFiles(client, getChatFilesRequest, timezoneOffset, options) { - return new APIPromise($do24(client, getChatFilesRequest, timezoneOffset, options)); - } - async function $do24(client, getChatFilesRequest, timezoneOffset, options) { - const input = { - getChatFilesRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => GetchatfilesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.GetChatFilesRequest, { - explode: true - }); - const path = pathToFunc("/rest/api/v1/getchatfiles")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getchatfiles", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetChatFilesResponse$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/types/blobs.js - var blobLikeSchema = custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true - }); - function isBlobLike(val) { - if (val instanceof Blob) { - return true; - } - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - return "stream" in val && typeof val.stream === "function"; - } - - // node_modules/@gleanwork/api-client/dist/esm/types/streams.js - function isReadableStream(val) { - if (typeof val !== "object" || val === null) { - return false; - } - const stream = val; - return typeof stream.getReader === "function" && typeof stream.cancel === "function" && typeof stream.tee === "function"; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientChatUploadFiles.js - function clientChatUploadFiles(client, uploadChatFilesRequest, timezoneOffset, options) { - return new APIPromise($do25(client, uploadChatFilesRequest, timezoneOffset, options)); - } - async function $do25(client, uploadChatFilesRequest, timezoneOffset, options) { - const input = { - uploadChatFilesRequest, - timezoneOffset - }; - const parsed = safeParse(input, (value) => UploadchatfilesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - for (const fileItem of payload.UploadChatFilesRequest.files) { - if (isBlobLike(fileItem)) { - appendForm(body, "files[]", fileItem); - } else if (isReadableStream(fileItem.content)) { - const buffer = await readableStreamToArrayBuffer(fileItem.content); - const contentType = getContentTypeFromFileName(fileItem.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "files[]", blob, fileItem.fileName); - } else { - const contentType = getContentTypeFromFileName(fileItem.fileName) || "application/octet-stream"; - appendForm(body, "files[]", new Blob([fileItem.content], { type: contentType }), fileItem.fileName); - } - } - const path = pathToFunc("/rest/api/v1/uploadchatfiles")(); - const query = encodeFormQuery({ - "timezoneOffset": payload.timezoneOffset - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "uploadchatfiles", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, UploadChatFilesResponse$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/chat.js - var Chat = class extends ClientSDK { - /** - * Chat - * - * @remarks - * Have a conversation with Glean AI. - */ - async create(chatRequest, timezoneOffset, options) { - return unwrapAsync(clientChatCreate(this, chatRequest, timezoneOffset, options)); - } - /** - * Deletes all saved Chats owned by a user - * - * @remarks - * Deletes all saved Chats a user has had and all their contained conversational content. - */ - async deleteAll(timezoneOffset, options) { - return unwrapAsync(clientChatDeleteAll(this, timezoneOffset, options)); - } - /** - * Deletes saved Chats - * - * @remarks - * Deletes saved Chats and all their contained conversational content. - */ - async delete(deleteChatsRequest, timezoneOffset, options) { - return unwrapAsync(clientChatDelete(this, deleteChatsRequest, timezoneOffset, options)); - } - /** - * Retrieves a Chat - * - * @remarks - * Retrieves the chat history between Glean Assistant and the user for a given Chat. - */ - async retrieve(getChatRequest, timezoneOffset, options) { - return unwrapAsync(clientChatRetrieve(this, getChatRequest, timezoneOffset, options)); - } - /** - * Retrieves all saved Chats - * - * @remarks - * Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content. - */ - async list(timezoneOffset, options) { - return unwrapAsync(clientChatList(this, timezoneOffset, options)); - } - /** - * Gets the metadata for a custom Chat application - * - * @remarks - * Gets the Chat application details for the specified application ID. - */ - async retrieveApplication(getChatApplicationRequest, timezoneOffset, options) { - return unwrapAsync(clientChatRetrieveApplication(this, getChatApplicationRequest, timezoneOffset, options)); - } - /** - * Upload files for Chat. - * - * @remarks - * Upload files for Chat. - */ - async uploadFiles(uploadChatFilesRequest, timezoneOffset, options) { - return unwrapAsync(clientChatUploadFiles(this, uploadChatFilesRequest, timezoneOffset, options)); - } - /** - * Get files uploaded by a user for Chat. - * - * @remarks - * Get files uploaded by a user for Chat. - */ - async retrieveFiles(getChatFilesRequest, timezoneOffset, options) { - return unwrapAsync(clientChatRetrieveFiles(this, getChatFilesRequest, timezoneOffset, options)); - } - /** - * Delete files uploaded by a user for chat. - * - * @remarks - * Delete files uploaded by a user for Chat. - */ - async deleteFiles(deleteChatFilesRequest, timezoneOffset, options) { - return unwrapAsync(clientChatDeleteFiles(this, deleteChatFilesRequest, timezoneOffset, options)); - } - /** - * Chat - * - * @remarks - * Have a conversation with Glean AI. - */ - async createStream(chatRequest, timezoneOffset, options) { - return unwrapAsync(clientChatCreateStream(this, chatRequest, timezoneOffset, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientAuthenticationCreateToken.js - function clientAuthenticationCreateToken(client, options) { - return new APIPromise($do26(client, options)); - } - async function $do26(client, options) { - const path = pathToFunc("/rest/api/v1/createauthtoken")(); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createauthtoken", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, CreateAuthTokenResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/clientauthentication.js - var ClientAuthentication = class extends ClientSDK { - /** - * Create authentication token - * - * @remarks - * Creates an authentication token for the authenticated user. These are - * specifically intended to be used with the [Web SDK](https://developers.glean.com/web). - * - * Note: The tokens generated from this endpoint are **not** valid tokens - * for use with the Client API (e.g. `/rest/api/v1/*`). - */ - async createToken(options) { - return unwrapAsync(clientAuthenticationCreateToken(this, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientDocumentsRetrieve.js - function clientDocumentsRetrieve(client, request, options) { - return new APIPromise($do27(client, request, options)); - } - async function $do27(client, request, options) { - const parsed = safeParse(request, (value) => GetDocumentsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = payload === void 0 ? null : encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getdocuments")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getdocuments", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocumentsResponse$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientDocumentsRetrieveByFacets.js - function clientDocumentsRetrieveByFacets(client, request, options) { - return new APIPromise($do28(client, request, options)); - } - async function $do28(client, request, options) { - const parsed = safeParse(request, (value) => GetDocumentsByFacetsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = payload === void 0 ? null : encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getdocumentsbyfacets")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getdocumentsbyfacets", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "404", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocumentsByFacetsResponse$inboundSchema), fail([400, 401, 404, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientDocumentsRetrievePermissions.js - function clientDocumentsRetrievePermissions(client, request, options) { - return new APIPromise($do29(client, request, options)); - } - async function $do29(client, request, options) { - const parsed = safeParse(request, (value) => GetDocPermissionsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getdocpermissions")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getdocpermissions", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocPermissionsResponse$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientDocumentsSummarize.js - function clientDocumentsSummarize(client, request, options) { - return new APIPromise($do30(client, request, options)); - } - async function $do30(client, request, options) { - const parsed = safeParse(request, (value) => SummarizeRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/summarize")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "summarize", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, SummarizeResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/clientdocuments.js - var ClientDocuments = class extends ClientSDK { - /** - * Read document permissions - * - * @remarks - * Read the emails of all users who have access to the given document. - */ - async retrievePermissions(request, options) { - return unwrapAsync(clientDocumentsRetrievePermissions(this, request, options)); - } - /** - * Read documents - * - * @remarks - * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request. - */ - async retrieve(request, options) { - return unwrapAsync(clientDocumentsRetrieve(this, request, options)); - } - /** - * Read documents by facets - * - * @remarks - * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) macthing the given facet conditions. - */ - async retrieveByFacets(request, options) { - return unwrapAsync(clientDocumentsRetrieveByFacets(this, request, options)); - } - /** - * Summarize documents - * - * @remarks - * Generate an AI summary of the requested documents. - */ - async summarize(request, options) { - return unwrapAsync(clientDocumentsSummarize(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientShortcutsCreate.js - function clientShortcutsCreate(client, request, options) { - return new APIPromise($do31(client, request, options)); - } - async function $do31(client, request, options) { - const parsed = safeParse(request, (value) => CreateShortcutRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/createshortcut")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createshortcut", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, CreateShortcutResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientShortcutsDelete.js - function clientShortcutsDelete(client, request, options) { - return new APIPromise($do32(client, request, options)); - } - async function $do32(client, request, options) { - const parsed = safeParse(request, (value) => DeleteShortcutRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/deleteshortcut")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deleteshortcut", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientShortcutsList.js - function clientShortcutsList(client, request, options) { - return new APIPromise($do33(client, request, options)); - } - async function $do33(client, request, options) { - const parsed = safeParse(request, (value) => ListShortcutsPaginatedRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/listshortcuts")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listshortcuts", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListShortcutsPaginatedResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientShortcutsRetrieve.js - function clientShortcutsRetrieve(client, request, options) { - return new APIPromise($do34(client, request, options)); - } - async function $do34(client, request, options) { - const parsed = safeParse(request, (value) => GetShortcutRequestUnion$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getshortcut")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getshortcut", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetShortcutResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientShortcutsUpdate.js - function clientShortcutsUpdate(client, request, options) { - return new APIPromise($do35(client, request, options)); - } - async function $do35(client, request, options) { - const parsed = safeParse(request, (value) => UpdateShortcutRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/updateshortcut")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "updateshortcut", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, UpdateShortcutResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/clientshortcuts.js - var ClientShortcuts = class extends ClientSDK { - /** - * Create shortcut - * - * @remarks - * Create a user-generated shortcut that contains an alias and destination URL. - */ - async create(request, options) { - return unwrapAsync(clientShortcutsCreate(this, request, options)); - } - /** - * Delete shortcut - * - * @remarks - * Delete an existing user-generated shortcut. - */ - async delete(request, options) { - return unwrapAsync(clientShortcutsDelete(this, request, options)); - } - /** - * Read shortcut - * - * @remarks - * Read a particular shortcut's details given its ID. - */ - async retrieve(request, options) { - return unwrapAsync(clientShortcutsRetrieve(this, request, options)); - } - /** - * List shortcuts - * - * @remarks - * List shortcuts editable/owned by the currently authenticated user. - */ - async list(request, options) { - return unwrapAsync(clientShortcutsList(this, request, options)); - } - /** - * Update shortcut - * - * @remarks - * Updates the shortcut with the given ID. - */ - async update(request, options) { - return unwrapAsync(clientShortcutsUpdate(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsAddItems.js - function clientCollectionsAddItems(client, request, options) { - return new APIPromise($do36(client, request, options)); - } - async function $do36(client, request, options) { - const parsed = safeParse(request, (value) => AddCollectionItemsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/addcollectionitems")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "addcollectionitems", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, AddCollectionItemsResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/collectionerror.js - var CollectionError = class extends GleanBaseError { - constructor(err, httpMeta) { - const message = "message" in err && typeof err.message === "string" ? err.message : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - this.errorCode = err.errorCode; - this.name = "CollectionError"; - } - }; - var CollectionError$inboundSchema2 = objectType({ - errorCode: CollectionErrorErrorCode$inboundSchema, - request$: instanceOfType(Request), - response$: instanceOfType(Response), - body$: stringType() - }).transform((v) => { - return new CollectionError(v, { - request: v.request$, - response: v.response$, - body: v.body$ - }); - }); - var CollectionError$outboundSchema2 = instanceOfType(CollectionError).transform((v) => v.data$).pipe(objectType({ - errorCode: CollectionErrorErrorCode$outboundSchema - })); - var CollectionError$2; - (function(CollectionError$3) { - CollectionError$3.inboundSchema = CollectionError$inboundSchema2; - CollectionError$3.outboundSchema = CollectionError$outboundSchema2; - })(CollectionError$2 || (CollectionError$2 = {})); - - // node_modules/@gleanwork/api-client/dist/esm/models/errors/gleandataerror.js - var GleanDataError = class extends GleanBaseError { - constructor(err, httpMeta) { - const message = "message" in err && typeof err.message === "string" ? err.message : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - if (err.badGmailToken != null) - this.badGmailToken = err.badGmailToken; - if (err.badOutlookToken != null) - this.badOutlookToken = err.badOutlookToken; - if (err.invalidOperators != null) { - this.invalidOperators = err.invalidOperators; - } - if (err.errorMessages != null) - this.errorMessages = err.errorMessages; - this.name = "GleanDataError"; - } - }; - var GleanDataError$inboundSchema2 = objectType({ - badGmailToken: booleanType().optional(), - badOutlookToken: booleanType().optional(), - invalidOperators: arrayType(InvalidOperatorValueError$inboundSchema).optional(), - errorMessages: arrayType(ErrorMessage$inboundSchema).optional(), - request$: instanceOfType(Request), - response$: instanceOfType(Response), - body$: stringType() - }).transform((v) => { - return new GleanDataError(v, { - request: v.request$, - response: v.response$, - body: v.body$ - }); - }); - var GleanDataError$outboundSchema2 = instanceOfType(GleanDataError).transform((v) => v.data$).pipe(objectType({ - badGmailToken: booleanType().optional(), - badOutlookToken: booleanType().optional(), - invalidOperators: arrayType(InvalidOperatorValueError$outboundSchema).optional(), - errorMessages: arrayType(ErrorMessage$outboundSchema).optional() - })); - var GleanDataError$2; - (function(GleanDataError$3) { - GleanDataError$3.inboundSchema = GleanDataError$inboundSchema2; - GleanDataError$3.outboundSchema = GleanDataError$outboundSchema2; - })(GleanDataError$2 || (GleanDataError$2 = {})); - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsCreate.js - function clientCollectionsCreate(client, request, options) { - return new APIPromise($do37(client, request, options)); - } - async function $do37(client, request, options) { - const parsed = safeParse(request, (value) => CreateCollectionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/createcollection")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createcollection", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await match(json(200, CreatecollectionResponse$inboundSchema), jsonErr(422, CollectionError$inboundSchema2), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsDelete.js - function clientCollectionsDelete(client, request, options) { - return new APIPromise($do38(client, request, options)); - } - async function $do38(client, request, options) { - const parsed = safeParse(request, (value) => DeleteCollectionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/deletecollection")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deletecollection", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await match(nil(200, voidType()), jsonErr(422, CollectionError$inboundSchema2), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsDeleteItem.js - function clientCollectionsDeleteItem(client, request, options) { - return new APIPromise($do39(client, request, options)); - } - async function $do39(client, request, options) { - const parsed = safeParse(request, (value) => DeleteCollectionItemRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/deletecollectionitem")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "deletecollectionitem", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, DeleteCollectionItemResponse$inboundSchema), fail([400, 401, 422, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsList.js - function clientCollectionsList(client, request, options) { - return new APIPromise($do40(client, request, options)); - } - async function $do40(client, request, options) { - const parsed = safeParse(request, (value) => ListCollectionsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/listcollections")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listcollections", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListCollectionsResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsRetrieve.js - function clientCollectionsRetrieve(client, request, options) { - return new APIPromise($do41(client, request, options)); - } - async function $do41(client, request, options) { - const parsed = safeParse(request, (value) => GetCollectionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getcollection")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getcollection", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetCollectionResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsUpdate.js - function clientCollectionsUpdate(client, request, options) { - return new APIPromise($do42(client, request, options)); - } - async function $do42(client, request, options) { - const parsed = safeParse(request, (value) => EditCollectionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/editcollection")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "editcollection", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await match(json(200, EditCollectionResponse$inboundSchema), jsonErr(422, CollectionError$inboundSchema2), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientCollectionsUpdateItem.js - function clientCollectionsUpdateItem(client, request, options) { - return new APIPromise($do43(client, request, options)); - } - async function $do43(client, request, options) { - const parsed = safeParse(request, (value) => EditCollectionItemRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/editcollectionitem")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "editcollectionitem", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, EditCollectionItemResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/collections.js - var Collections = class extends ClientSDK { - /** - * Add Collection item - * - * @remarks - * Add items to a Collection. - */ - async addItems(request, options) { - return unwrapAsync(clientCollectionsAddItems(this, request, options)); - } - /** - * Create Collection - * - * @remarks - * Create a publicly visible (empty) Collection of documents. - */ - async create(request, options) { - return unwrapAsync(clientCollectionsCreate(this, request, options)); - } - /** - * Delete Collection - * - * @remarks - * Delete a Collection given the Collection's ID. - */ - async delete(request, options) { - return unwrapAsync(clientCollectionsDelete(this, request, options)); - } - /** - * Delete Collection item - * - * @remarks - * Delete a single item from a Collection. - */ - async deleteItem(request, options) { - return unwrapAsync(clientCollectionsDeleteItem(this, request, options)); - } - /** - * Update Collection - * - * @remarks - * Update the properties of an existing Collection. - */ - async update(request, options) { - return unwrapAsync(clientCollectionsUpdate(this, request, options)); - } - /** - * Update Collection item - * - * @remarks - * Update the URL, Glean Document ID, description of an item within a Collection given its ID. - */ - async updateItem(request, options) { - return unwrapAsync(clientCollectionsUpdateItem(this, request, options)); - } - /** - * Read Collection - * - * @remarks - * Read the details of a Collection given its ID. Does not fetch items in this Collection. - */ - async retrieve(request, options) { - return unwrapAsync(clientCollectionsRetrieve(this, request, options)); - } - /** - * List Collections - * - * @remarks - * List all existing Collections. - */ - async list(request, options) { - return unwrapAsync(clientCollectionsList(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientEntitiesList.js - function clientEntitiesList(client, request, options) { - return new APIPromise($do44(client, request, options)); - } - async function $do44(client, request, options) { - const parsed = safeParse(request, (value) => ListEntitiesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/listentities")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listentities", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListEntitiesResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientEntitiesReadPeople.js - function clientEntitiesReadPeople(client, request, options) { - return new APIPromise($do45(client, request, options)); - } - async function $do45(client, request, options) { - const parsed = safeParse(request, (value) => PeopleRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/people")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "people", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, PeopleResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/entities.js - var Entities = class extends ClientSDK { - /** - * List entities - * - * @remarks - * List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities. - */ - async list(request, options) { - return unwrapAsync(clientEntitiesList(this, request, options)); - } - /** - * Read people - * - * @remarks - * Read people details for the given IDs. - */ - async readPeople(request, options) { - return unwrapAsync(clientEntitiesReadPeople(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataPoliciesCreate.js - function clientGovernanceDataPoliciesCreate(client, request, options) { - return new APIPromise($do46(client, request, options)); - } - async function $do46(client, request, options) { - const parsed = safeParse(request, (value) => CreateDlpReportRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/governance/data/policies")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createpolicy", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, CreateDlpReportResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataPoliciesDownload.js - function clientGovernanceDataPoliciesDownload(client, id, options) { - return new APIPromise($do47(client, id, options)); - } - async function $do47(client, id, options) { - const input = { - id - }; - const parsed = safeParse(input, (value) => DownloadpolicycsvRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - id: encodeSimple("id", payload.id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/governance/data/policies/{id}/download")(pathParams); - const headers = new Headers(compactMap({ - Accept: "text/csv; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "downloadpolicycsv", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(text(200, stringType(), { ctype: "text/csv; charset=UTF-8" }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataPoliciesList.js - function clientGovernanceDataPoliciesList(client, autoHide, frequency, options) { - return new APIPromise($do48(client, autoHide, frequency, options)); - } - async function $do48(client, autoHide, frequency, options) { - const input = { - autoHide, - frequency - }; - const parsed = safeParse(input, (value) => ListpoliciesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/governance/data/policies")(); - const query = encodeFormQuery({ - "autoHide": payload.autoHide, - "frequency": payload.frequency - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listpolicies", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListDlpReportsResponse$inboundSchema), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataPoliciesRetrieve.js - function clientGovernanceDataPoliciesRetrieve(client, id, version, options) { - return new APIPromise($do49(client, id, version, options)); - } - async function $do49(client, id, version, options) { - const input = { - id, - version - }; - const parsed = safeParse(input, (value) => GetpolicyRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - id: encodeSimple("id", payload.id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/governance/data/policies/{id}")(pathParams); - const query = encodeFormQuery({ - "version": payload.version - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getpolicy", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDlpReportResponse$inboundSchema), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataPoliciesUpdate.js - function clientGovernanceDataPoliciesUpdate(client, updateDlpReportRequest, id, options) { - return new APIPromise($do50(client, updateDlpReportRequest, id, options)); - } - async function $do50(client, updateDlpReportRequest, id, options) { - const input = { - updateDlpReportRequest, - id - }; - const parsed = safeParse(input, (value) => UpdatepolicyRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.UpdateDlpReportRequest, { - explode: true - }); - const pathParams = { - id: encodeSimple("id", payload.id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/governance/data/policies/{id}")(pathParams); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "updatepolicy", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, UpdateDlpReportResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/policies.js - var Policies = class extends ClientSDK { - /** - * Gets specified policy - * - * @remarks - * Fetches the specified policy version, or the latest if no version is provided. - */ - async retrieve(id, version, options) { - return unwrapAsync(clientGovernanceDataPoliciesRetrieve(this, id, version, options)); - } - /** - * Updates an existing policy - * - * @remarks - * Updates an existing policy. - */ - async update(updateDlpReportRequest, id, options) { - return unwrapAsync(clientGovernanceDataPoliciesUpdate(this, updateDlpReportRequest, id, options)); - } - /** - * Lists policies - * - * @remarks - * Lists policies with filtering. - */ - async list(autoHide, frequency, options) { - return unwrapAsync(clientGovernanceDataPoliciesList(this, autoHide, frequency, options)); - } - /** - * Creates new policy - * - * @remarks - * Creates a new policy with specified specifications and returns its id. - */ - async create(request, options) { - return unwrapAsync(clientGovernanceDataPoliciesCreate(this, request, options)); - } - /** - * Downloads violations CSV for policy - * - * @remarks - * Downloads CSV violations report for a specific policy id. This does not support continuous policies. - */ - async download(id, options) { - return unwrapAsync(clientGovernanceDataPoliciesDownload(this, id, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataReportsCreate.js - function clientGovernanceDataReportsCreate(client, request, options) { - return new APIPromise($do51(client, request, options)); - } - async function $do51(client, request, options) { - const parsed = safeParse(request, (value) => UpdateDlpConfigRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/governance/data/reports")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "createreport", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, UpdateDlpConfigResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataReportsDownload.js - function clientGovernanceDataReportsDownload(client, id, options) { - return new APIPromise($do52(client, id, options)); - } - async function $do52(client, id, options) { - const input = { - id - }; - const parsed = safeParse(input, (value) => DownloadreportcsvRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - id: encodeSimple("id", payload.id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/governance/data/reports/{id}/download")(pathParams); - const headers = new Headers(compactMap({ - Accept: "text/csv; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "downloadreportcsv", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(text(200, stringType(), { ctype: "text/csv; charset=UTF-8" }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDataReportsStatus.js - function clientGovernanceDataReportsStatus(client, id, options) { - return new APIPromise($do53(client, id, options)); - } - async function $do53(client, id, options) { - const input = { - id - }; - const parsed = safeParse(input, (value) => GetreportstatusRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - id: encodeSimple("id", payload.id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/rest/api/v1/governance/data/reports/{id}/status")(pathParams); - const headers = new Headers(compactMap({ - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getreportstatus", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ReportStatusResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/reports.js - var Reports = class extends ClientSDK { - /** - * Creates new one-time report - * - * @remarks - * Creates a new one-time report and executes its batch job. - */ - async create(request, options) { - return unwrapAsync(clientGovernanceDataReportsCreate(this, request, options)); - } - /** - * Downloads violations CSV for report - * - * @remarks - * Downloads CSV violations report for a specific report id. - */ - async download(id, options) { - return unwrapAsync(clientGovernanceDataReportsDownload(this, id, options)); - } - /** - * Fetches report run status - * - * @remarks - * Fetches the status of the run corresponding to the report-id. - */ - async status(id, options) { - return unwrapAsync(clientGovernanceDataReportsStatus(this, id, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/data.js - var Data = class extends ClientSDK { - get policies() { - return this._policies ?? (this._policies = new Policies(this._options)); - } - get reports() { - return this._reports ?? (this._reports = new Reports(this._options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.js - function clientGovernanceDocumentsVisibilityoverridesCreate(client, request, options) { - return new APIPromise($do54(client, request, options)); - } - async function $do54(client, request, options) { - const parsed = safeParse(request, (value) => UpdateDocumentVisibilityOverridesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/governance/documents/visibilityoverrides")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "setdocvisibility", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, UpdateDocumentVisibilityOverridesResponse$inboundSchema, { ctype: "application/json; charset=UTF-8" }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesList.js - function clientGovernanceDocumentsVisibilityoverridesList(client, docIds, options) { - return new APIPromise($do55(client, docIds, options)); - } - async function $do55(client, docIds, options) { - const input = { - docIds - }; - const parsed = safeParse(input, (value) => GetdocvisibilityRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/governance/documents/visibilityoverrides")(); - const query = encodeFormQuery({ - "docIds": payload.docIds - }); - const headers = new Headers(compactMap({ - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getdocvisibility", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["403", "4XX", "500", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocumentVisibilityOverridesResponse$inboundSchema, { ctype: "application/json; charset=UTF-8" }), fail([403, "4XX"]), fail([500, "5XX"]))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/visibilityoverrides.js - var Visibilityoverrides = class extends ClientSDK { - /** - * Fetches documents visibility - * - * @remarks - * Fetches the visibility override status of the documents passed. - */ - async list(docIds, options) { - return unwrapAsync(clientGovernanceDocumentsVisibilityoverridesList(this, docIds, options)); - } - /** - * Hide or unhide docs - * - * @remarks - * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents. - */ - async create(request, options) { - return unwrapAsync(clientGovernanceDocumentsVisibilityoverridesCreate(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/governancedocuments.js - var GovernanceDocuments = class extends ClientSDK { - get visibilityoverrides() { - return this._visibilityoverrides ?? (this._visibilityoverrides = new Visibilityoverrides(this._options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/governance.js - var Governance = class extends ClientSDK { - get data() { - return this._data ?? (this._data = new Data(this._options)); - } - get documents() { - return this._documents ?? (this._documents = new GovernanceDocuments(this._options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientInsightsRetrieve.js - function clientInsightsRetrieve(client, request, options) { - return new APIPromise($do56(client, request, options)); - } - async function $do56(client, request, options) { - const parsed = safeParse(request, (value) => InsightsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/insights")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "insights", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, InsightsResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/insights.js - var Insights = class extends ClientSDK { - /** - * Get insights - * - * @remarks - * Gets the aggregate usage insights data displayed in the Insights Dashboards. - */ - async retrieve(request, options) { - return unwrapAsync(clientInsightsRetrieve(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientMessagesRetrieve.js - function clientMessagesRetrieve(client, request, options) { - return new APIPromise($do57(client, request, options)); - } - async function $do57(client, request, options) { - const parsed = safeParse(request, (value) => MessagesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/messages")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "messages", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, MessagesResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/messages.js - var Messages = class extends ClientSDK { - /** - * Read messages - * - * @remarks - * Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams). - */ - async retrieve(request, options) { - return unwrapAsync(clientMessagesRetrieve(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientPinsCreate.js - function clientPinsCreate(client, request, options) { - return new APIPromise($do58(client, request, options)); - } - async function $do58(client, request, options) { - const parsed = safeParse(request, (value) => PinRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/pin")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "pin", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, PinDocument$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientPinsList.js - function clientPinsList(client, _request, options) { - return new APIPromise($do59(client, _request, options)); - } - async function $do59(client, _request, options) { - const path = pathToFunc("/rest/api/v1/listpins")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listpins", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ListPinsResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientPinsRemove.js - function clientPinsRemove(client, request, options) { - return new APIPromise($do60(client, request, options)); - } - async function $do60(client, request, options) { - const parsed = safeParse(request, (value) => Unpin$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/unpin")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "unpin", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientPinsRetrieve.js - function clientPinsRetrieve(client, request, options) { - return new APIPromise($do61(client, request, options)); - } - async function $do61(client, request, options) { - const parsed = safeParse(request, (value) => GetPinRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/getpin")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "getpin", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetPinResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientPinsUpdate.js - function clientPinsUpdate(client, request, options) { - return new APIPromise($do62(client, request, options)); - } - async function $do62(client, request, options) { - const parsed = safeParse(request, (value) => EditPinRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/editpin")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "editpin", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, PinDocument$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/pins.js - var Pins = class extends ClientSDK { - /** - * Update pin - * - * @remarks - * Update an existing user-generated pin. - */ - async update(request, options) { - return unwrapAsync(clientPinsUpdate(this, request, options)); - } - /** - * Read pin - * - * @remarks - * Read pin details given its ID. - */ - async retrieve(request, options) { - return unwrapAsync(clientPinsRetrieve(this, request, options)); - } - /** - * List pins - * - * @remarks - * Lists all pins. - */ - async list(request, options) { - return unwrapAsync(clientPinsList(this, request, options)); - } - /** - * Create pin - * - * @remarks - * Pin a document as a result for a given search query.Pin results that are known to be a good match. - */ - async create(request, options) { - return unwrapAsync(clientPinsCreate(this, request, options)); - } - /** - * Delete pin - * - * @remarks - * Unpin a previously pinned result. - */ - async remove(request, options) { - return unwrapAsync(clientPinsRemove(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientSearchAutocomplete.js - function clientSearchAutocomplete(client, request, options) { - return new APIPromise($do63(client, request, options)); - } - async function $do63(client, request, options) { - const parsed = safeParse(request, (value) => AutocompleteRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/autocomplete")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "autocomplete", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, AutocompleteResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientSearchQuery.js - function clientSearchQuery(client, request, options) { - return new APIPromise($do64(client, request, options)); - } - async function $do64(client, request, options) { - const parsed = safeParse(request, (value) => SearchRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/search")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "search", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "408", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await match(json(200, SearchResponse$inboundSchema), jsonErr([403, 422], GleanDataError$inboundSchema2), fail([400, 401, 408, 429, "4XX"]), fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientSearchQueryAsAdmin.js - function clientSearchQueryAsAdmin(client, request, options) { - return new APIPromise($do65(client, request, options)); - } - async function $do65(client, request, options) { - const parsed = safeParse(request, (value) => SearchRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/adminsearch")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "adminsearch", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "422", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await match(json(200, SearchResponse$inboundSchema), jsonErr([403, 422], GleanDataError$inboundSchema2), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientSearchRecommendations.js - function clientSearchRecommendations(client, request, options) { - return new APIPromise($do66(client, request, options)); - } - async function $do66(client, request, options) { - const parsed = safeParse(request, (value) => RecommendationsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/recommendations")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "recommendations", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ResultsResponse$inboundSchema.optional()), nil([202, 204], ResultsResponse$inboundSchema.optional()), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientSearchRetrieveFeed.js - function clientSearchRetrieveFeed(client, request, options) { - return new APIPromise($do67(client, request, options)); - } - async function $do67(client, request, options) { - const parsed = safeParse(request, (value) => FeedRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/feed")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "feed", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "408", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, FeedResponse$inboundSchema), fail([400, 401, 408, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/search.js - var Search = class extends ClientSDK { - /** - * Search the index (admin) - * - * @remarks - * Retrieves results for search query without respect for permissions. This is available only to privileged users. - */ - async queryAsAdmin(request, options) { - return unwrapAsync(clientSearchQueryAsAdmin(this, request, options)); - } - /** - * Autocomplete - * - * @remarks - * Retrieve query suggestions, operators and documents for the given partially typed query. - */ - async autocomplete(request, options) { - return unwrapAsync(clientSearchAutocomplete(this, request, options)); - } - /** - * Feed of documents and events - * - * @remarks - * The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more. - */ - async retrieveFeed(request, options) { - return unwrapAsync(clientSearchRetrieveFeed(this, request, options)); - } - /** - * Recommend documents - * - * @remarks - * Retrieve recommended documents for the given URL or Glean Document ID. - */ - async recommendations(request, options) { - return unwrapAsync(clientSearchRecommendations(this, request, options)); - } - /** - * Search - * - * @remarks - * Retrieve results from the index for the given query and filters. - */ - async query(request, options) { - return unwrapAsync(clientSearchQuery(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientToolsList.js - function clientToolsList(client, toolNames, options) { - return new APIPromise($do68(client, toolNames, options)); - } - async function $do68(client, toolNames, options) { - const input = { - toolNames - }; - const parsed = safeParse(input, (value) => GetRestApiV1ToolsListRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/tools/list")(); - const query = encodeFormQuery({ - "toolNames": payload.toolNames - }, { explode: false }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "get_/rest/api/v1/tools/list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "404", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ToolsListResponse$inboundSchema), fail([400, 401, 404, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientToolsRun.js - function clientToolsRun(client, request, options) { - return new APIPromise($do69(client, request, options)); - } - async function $do69(client, request, options) { - const parsed = safeParse(request, (value) => ToolsCallRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/tools/call")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/rest/api/v1/tools/call", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "404", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, ToolsCallResponse$inboundSchema), fail([400, 401, 404, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/tools.js - var Tools = class extends ClientSDK { - /** - * List available tools - * - * @remarks - * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned. - */ - async list(toolNames, options) { - return unwrapAsync(clientToolsList(this, toolNames, options)); - } - /** - * Execute the specified tool - * - * @remarks - * Execute the specified tool with provided parameters - */ - async run(request, options) { - return unwrapAsync(clientToolsRun(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientVerificationAddReminder.js - function clientVerificationAddReminder(client, request, options) { - return new APIPromise($do70(client, request, options)); - } - async function $do70(client, request, options) { - const parsed = safeParse(request, (value) => ReminderRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/addverificationreminder")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "addverificationreminder", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Verification$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientVerificationList.js - function clientVerificationList(client, count, options) { - return new APIPromise($do71(client, count, options)); - } - async function $do71(client, count, options) { - const input = { - count - }; - const parsed = safeParse(input, (value) => ListverificationsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = pathToFunc("/rest/api/v1/listverifications")(); - const query = encodeFormQuery({ - "count": payload.count - }); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "listverifications", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, VerificationFeed$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/clientVerificationVerify.js - function clientVerificationVerify(client, request, options) { - return new APIPromise($do72(client, request, options)); - } - async function $do72(client, request, options) { - const parsed = safeParse(request, (value) => VerifyRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/rest/api/v1/verify")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "verify", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, Verification$inboundSchema), fail([400, 401, 403, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/verification.js - var Verification = class extends ClientSDK { - /** - * Create verification - * - * @remarks - * Creates a verification reminder for the document. Users can create verification reminders from different product surfaces. - */ - async addReminder(request, options) { - return unwrapAsync(clientVerificationAddReminder(this, request, options)); - } - /** - * List verifications - * - * @remarks - * Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications. - */ - async list(count, options) { - return unwrapAsync(clientVerificationList(this, count, options)); - } - /** - * Update verification - * - * @remarks - * Verify documents to keep the knowledge up to date within customer corpus. - */ - async verify(request, options) { - return unwrapAsync(clientVerificationVerify(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/client.js - var Client = class extends ClientSDK { - get activity() { - return this._activity ?? (this._activity = new Activity(this._options)); - } - get announcements() { - return this._announcements ?? (this._announcements = new Announcements(this._options)); - } - get answers() { - return this._answers ?? (this._answers = new Answers(this._options)); - } - get authentication() { - return this._authentication ?? (this._authentication = new ClientAuthentication(this._options)); - } - get chat() { - return this._chat ?? (this._chat = new Chat(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new Agents(this._options)); - } - get collections() { - return this._collections ?? (this._collections = new Collections(this._options)); - } - get documents() { - return this._documents ?? (this._documents = new ClientDocuments(this._options)); - } - get insights() { - return this._insights ?? (this._insights = new Insights(this._options)); - } - get messages() { - return this._messages ?? (this._messages = new Messages(this._options)); - } - get pins() { - return this._pins ?? (this._pins = new Pins(this._options)); - } - get search() { - return this._search ?? (this._search = new Search(this._options)); - } - get entities() { - return this._entities ?? (this._entities = new Entities(this._options)); - } - get shortcuts() { - return this._shortcuts ?? (this._shortcuts = new ClientShortcuts(this._options)); - } - get verification() { - return this._verification ?? (this._verification = new Verification(this._options)); - } - get tools() { - return this._tools ?? (this._tools = new Tools(this._options)); - } - get governance() { - return this._governance ?? (this._governance = new Governance(this._options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDatasourceStatus.js - function indexingDatasourceStatus(client, datasource, options) { - return new APIPromise($do73(client, datasource, options)); - } - async function $do73(client, datasource, options) { - const input = { - datasource - }; - const parsed = safeParse(input, (value) => PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - datasource: encodeSimple("datasource", payload.datasource, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/api/index/v1/debug/{datasource}/status")(pathParams); - const headers = new Headers(compactMap({ - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/debug/{datasource}/status", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, DebugDatasourceStatusResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/datasource.js - var Datasource2 = class extends ClientSDK { - /** - * Beta: Get datasource status - * - * @remarks - * Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - async status(datasource, options) { - return unwrapAsync(indexingDatasourceStatus(this, datasource, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDatasourcesAdd.js - function indexingDatasourcesAdd(client, request, options) { - return new APIPromise($do74(client, request, options)); - } - async function $do74(client, request, options) { - const parsed = safeParse(request, (value) => CustomDatasourceConfig$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/adddatasource")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/adddatasource", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDatasourcesRetrieveConfig.js - function indexingDatasourcesRetrieveConfig(client, request, options) { - return new APIPromise($do75(client, request, options)); - } - async function $do75(client, request, options) { - const parsed = safeParse(request, (value) => GetDatasourceConfigRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/getdatasourceconfig")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/getdatasourceconfig", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, CustomDatasourceConfig$inboundSchema), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/datasources.js - var Datasources = class extends ClientSDK { - /** - * Add or update datasource - * - * @remarks - * Add or update a custom datasource and its schema. - */ - async add(request, options) { - return unwrapAsync(indexingDatasourcesAdd(this, request, options)); - } - /** - * Get datasource config - * - * @remarks - * Fetches the datasource config for the specified custom datasource. - */ - async retrieveConfig(request, options) { - return unwrapAsync(indexingDatasourcesRetrieveConfig(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingAuthenticationRotateToken.js - function indexingAuthenticationRotateToken(client, options) { - return new APIPromise($do76(client, options)); - } - async function $do76(client, options) { - const path = pathToFunc("/api/index/v1/rotatetoken")(); - const headers = new Headers(compactMap({ - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/rotatetoken", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, RotateTokenResponse$inboundSchema), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/indexingauthentication.js - var IndexingAuthentication = class extends ClientSDK { - /** - * Rotate token - * - * @remarks - * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. - */ - async rotateToken(options) { - return unwrapAsync(indexingAuthenticationRotateToken(this, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsAddOrUpdate.js - function indexingDocumentsAddOrUpdate(client, request, options) { - return new APIPromise($do77(client, request, options)); - } - async function $do77(client, request, options) { - const parsed = safeParse(request, (value) => IndexDocumentRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexdocument")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexdocument", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsBulkIndex.js - function indexingDocumentsBulkIndex(client, request, options) { - return new APIPromise($do78(client, request, options)); - } - async function $do78(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexDocumentsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexdocuments")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexdocuments", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsCheckAccess.js - function indexingDocumentsCheckAccess(client, request, options) { - return new APIPromise($do79(client, request, options)); - } - async function $do79(client, request, options) { - const parsed = safeParse(request, (value) => CheckDocumentAccessRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/checkdocumentaccess")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/checkdocumentaccess", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, CheckDocumentAccessResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsCount.js - function indexingDocumentsCount(client, request, options) { - return new APIPromise($do80(client, request, options)); - } - async function $do80(client, request, options) { - const parsed = safeParse(request, (value) => GetDocumentCountRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/getdocumentcount")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/getdocumentcount", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocumentCountResponse$inboundSchema), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsDebug.js - function indexingDocumentsDebug(client, debugDocumentRequest, datasource, options) { - return new APIPromise($do81(client, debugDocumentRequest, datasource, options)); - } - async function $do81(client, debugDocumentRequest, datasource, options) { - const input = { - debugDocumentRequest, - datasource - }; - const parsed = safeParse(input, (value) => PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DebugDocumentRequest, { - explode: true - }); - const pathParams = { - datasource: encodeSimple("datasource", payload.datasource, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/api/index/v1/debug/{datasource}/document")(pathParams); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/debug/{datasource}/document", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, DebugDocumentResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsDebugMany.js - function indexingDocumentsDebugMany(client, debugDocumentsRequest, datasource, options) { - return new APIPromise($do82(client, debugDocumentsRequest, datasource, options)); - } - async function $do82(client, debugDocumentsRequest, datasource, options) { - const input = { - debugDocumentsRequest, - datasource - }; - const parsed = safeParse(input, (value) => PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DebugDocumentsRequest, { - explode: true - }); - const pathParams = { - datasource: encodeSimple("datasource", payload.datasource, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/api/index/v1/debug/{datasource}/documents")(pathParams); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/debug/{datasource}/documents", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, DebugDocumentsResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsDelete.js - function indexingDocumentsDelete(client, request, options) { - return new APIPromise($do83(client, request, options)); - } - async function $do83(client, request, options) { - const parsed = safeParse(request, (value) => DeleteDocumentRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deletedocument")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deletedocument", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsIndex.js - function indexingDocumentsIndex(client, request, options) { - return new APIPromise($do84(client, request, options)); - } - async function $do84(client, request, options) { - const parsed = safeParse(request, (value) => IndexDocumentsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexdocuments")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexdocuments", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsProcessAll.js - function indexingDocumentsProcessAll(client, request, options) { - return new APIPromise($do85(client, request, options)); - } - async function $do85(client, request, options) { - const parsed = safeParse(request, (value) => ProcessAllDocumentsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = payload === void 0 ? null : encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/processalldocuments")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/processalldocuments", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingDocumentsStatus.js - function indexingDocumentsStatus(client, request, options) { - return new APIPromise($do86(client, request, options)); - } - async function $do86(client, request, options) { - const parsed = safeParse(request, (value) => GetDocumentStatusRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/getdocumentstatus")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/getdocumentstatus", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetDocumentStatusResponse$inboundSchema), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/indexingdocuments.js - var IndexingDocuments = class extends ClientSDK { - /** - * Index document - * - * @remarks - * Adds a document to the index or updates an existing document. - */ - async addOrUpdate(request, options) { - return unwrapAsync(indexingDocumentsAddOrUpdate(this, request, options)); - } - /** - * Index documents - * - * @remarks - * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. - */ - async index(request, options) { - return unwrapAsync(indexingDocumentsIndex(this, request, options)); - } - /** - * Bulk index documents - * - * @remarks - * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndex(request, options) { - return unwrapAsync(indexingDocumentsBulkIndex(this, request, options)); - } - /** - * Schedules the processing of uploaded documents - * - * @remarks - * Schedules the immediate processing of documents uploaded through the indexing API. By default the uploaded documents will be processed asynchronously but this API can be used to schedule processing of all documents on demand. - * - * If a `datasource` parameter is specified, processing is limited to that custom datasource. Without it, processing applies to all documents across all custom datasources. - * #### Rate Limits - * This endpoint is rate-limited to one usage every 3 hours. Exceeding this limit results in a 429 response code. Here's how the rate limit works: - * 1. Calling `/processalldocuments` for datasource `foo` prevents another call for `foo` for 3 hours. - * 2. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for `bar`. - * 3. Calling `/processalldocuments` for all datasources prevents any datasource calls for 3 hours. - * 4. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for all datasources. - * - * For more frequent document processing, contact Glean support. - */ - async processAll(request, options) { - return unwrapAsync(indexingDocumentsProcessAll(this, request, options)); - } - /** - * Delete document - * - * @remarks - * Deletes the specified document from the index. Succeeds if document is not present. - */ - async delete(request, options) { - return unwrapAsync(indexingDocumentsDelete(this, request, options)); - } - /** - * Beta: Get document information - * - * @remarks - * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - async debug(debugDocumentRequest, datasource, options) { - return unwrapAsync(indexingDocumentsDebug(this, debugDocumentRequest, datasource, options)); - } - /** - * Beta: Get information of a batch of documents - * - * @remarks - * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - async debugMany(debugDocumentsRequest, datasource, options) { - return unwrapAsync(indexingDocumentsDebugMany(this, debugDocumentsRequest, datasource, options)); - } - /** - * Check document access - * - * @remarks - * Check if a given user has access to access a document in a custom datasource - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - async checkAccess(request, options) { - return unwrapAsync(indexingDocumentsCheckAccess(this, request, options)); - } - /** - * Get document upload and indexing status - * - * @remarks - * Intended for debugging/validation. Fetches the current upload and indexing status of documents. - * - * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - async status(request, options) { - return unwrapAsync(indexingDocumentsStatus(this, request, options)); - } - /** - * Get document count - * - * @remarks - * Fetches document count for the specified custom datasource. - * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - async count(request, options) { - return unwrapAsync(indexingDocumentsCount(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingShortcutsBulkIndex.js - function indexingShortcutsBulkIndex(client, request, options) { - return new APIPromise($do87(client, request, options)); - } - async function $do87(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexShortcutsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexshortcuts")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexshortcuts", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingShortcutsUpload.js - function indexingShortcutsUpload(client, request, options) { - return new APIPromise($do88(client, request, options)); - } - async function $do88(client, request, options) { - const parsed = safeParse(request, (value) => UploadShortcutsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/uploadshortcuts")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/uploadshortcuts", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/indexingshortcuts.js - var IndexingShortcuts = class extends ClientSDK { - /** - * Bulk index external shortcuts - * - * @remarks - * Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the `/uploadshortcuts` endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to [this](https://help.glean.com/en/articles/5628838-how-go-links-work) page. - */ - async bulkIndex(request, options) { - return unwrapAsync(indexingShortcutsBulkIndex(this, request, options)); - } - /** - * Upload shortcuts - * - * @remarks - * Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded. - */ - async upload(request, options) { - return unwrapAsync(indexingShortcutsUpload(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleBulkIndex.js - function indexingPeopleBulkIndex(client, request, options) { - return new APIPromise($do89(client, request, options)); - } - async function $do89(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexEmployeesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexemployees")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexemployees", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleBulkIndexTeams.js - function indexingPeopleBulkIndexTeams(client, request, options) { - return new APIPromise($do90(client, request, options)); - } - async function $do90(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexTeamsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexteams")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexteams", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleCount.js - function indexingPeopleCount(client, request, options) { - return new APIPromise($do91(client, request, options)); - } - async function $do91(client, request, options) { - const parsed = safeParse(request, (value) => GetUserCountRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/getusercount")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/getusercount", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, GetUserCountResponse$inboundSchema), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleDebug.js - function indexingPeopleDebug(client, debugUserRequest, datasource, options) { - return new APIPromise($do92(client, debugUserRequest, datasource, options)); - } - async function $do92(client, debugUserRequest, datasource, options) { - const input = { - debugUserRequest, - datasource - }; - const parsed = safeParse(input, (value) => PostApiIndexV1DebugDatasourceUserRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DebugUserRequest, { explode: true }); - const pathParams = { - datasource: encodeSimple("datasource", payload.datasource, { - explode: false, - charEncoding: "percent" - }) - }; - const path = pathToFunc("/api/index/v1/debug/{datasource}/user")(pathParams); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json; charset=UTF-8" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/debug/{datasource}/user", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(json(200, DebugUserResponse$inboundSchema, { - ctype: "application/json; charset=UTF-8" - }), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleDelete.js - function indexingPeopleDelete(client, request, options) { - return new APIPromise($do93(client, request, options)); - } - async function $do93(client, request, options) { - const parsed = safeParse(request, (value) => DeleteEmployeeRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deleteemployee")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deleteemployee", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleDeleteTeam.js - function indexingPeopleDeleteTeam(client, request, options) { - return new APIPromise($do94(client, request, options)); - } - async function $do94(client, request, options) { - const parsed = safeParse(request, (value) => DeleteTeamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deleteteam")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deleteteam", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleIndex.js - function indexingPeopleIndex(client, request, options) { - return new APIPromise($do95(client, request, options)); - } - async function $do95(client, request, options) { - const parsed = safeParse(request, (value) => IndexEmployeeRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexemployee")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexemployee", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleIndexTeam.js - function indexingPeopleIndexTeam(client, request, options) { - return new APIPromise($do96(client, request, options)); - } - async function $do96(client, request, options) { - const parsed = safeParse(request, (value) => IndexTeamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexteam")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexteam", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPeopleProcessAllEmployeesAndTeams.js - function indexingPeopleProcessAllEmployeesAndTeams(client, options) { - return new APIPromise($do97(client, options)); - } - async function $do97(client, options) { - const path = pathToFunc("/api/index/v1/processallemployeesandteams")(); - const headers = new Headers(compactMap({ - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/processallemployeesandteams", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/people.js - var People = class extends ClientSDK { - /** - * Beta: Get user information - * - * @remarks - * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - async debug(debugUserRequest, datasource, options) { - return unwrapAsync(indexingPeopleDebug(this, debugUserRequest, datasource, options)); - } - /** - * Get user count - * - * @remarks - * Fetches user count for the specified custom datasource. - * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - async count(request, options) { - return unwrapAsync(indexingPeopleCount(this, request, options)); - } - /** - * Index employee - * - * @remarks - * Adds an employee or updates information about an employee - */ - async index(request, options) { - return unwrapAsync(indexingPeopleIndex(this, request, options)); - } - /** - * Bulk index employees - * - * @remarks - * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndex(request, options) { - return unwrapAsync(indexingPeopleBulkIndex(this, request, options)); - } - /** - * Schedules the processing of uploaded employees and teams - * - * @remarks - * Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand. - */ - async processAllEmployeesAndTeams(options) { - return unwrapAsync(indexingPeopleProcessAllEmployeesAndTeams(this, options)); - } - /** - * Delete employee - * - * @remarks - * Delete an employee. Silently succeeds if employee is not present. - */ - async delete(request, options) { - return unwrapAsync(indexingPeopleDelete(this, request, options)); - } - /** - * Index team - * - * @remarks - * Adds a team or updates information about a team - */ - async indexTeam(request, options) { - return unwrapAsync(indexingPeopleIndexTeam(this, request, options)); - } - /** - * Delete team - * - * @remarks - * Delete a team based on provided id. - */ - async deleteTeam(request, options) { - return unwrapAsync(indexingPeopleDeleteTeam(this, request, options)); - } - /** - * Bulk index teams - * - * @remarks - * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndexTeams(request, options) { - return unwrapAsync(indexingPeopleBulkIndexTeams(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsAuthorizeBetaUsers.js - function indexingPermissionsAuthorizeBetaUsers(client, request, options) { - return new APIPromise($do98(client, request, options)); - } - async function $do98(client, request, options) { - const parsed = safeParse(request, (value) => GreenlistUsersRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/betausers")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/betausers", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsBulkIndexGroups.js - function indexingPermissionsBulkIndexGroups(client, request, options) { - return new APIPromise($do99(client, request, options)); - } - async function $do99(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexGroupsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexgroups")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexgroups", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsBulkIndexMemberships.js - function indexingPermissionsBulkIndexMemberships(client, request, options) { - return new APIPromise($do100(client, request, options)); - } - async function $do100(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexMembershipsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexmemberships")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexmemberships", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsBulkIndexUsers.js - function indexingPermissionsBulkIndexUsers(client, request, options) { - return new APIPromise($do101(client, request, options)); - } - async function $do101(client, request, options) { - const parsed = safeParse(request, (value) => BulkIndexUsersRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/bulkindexusers")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/bulkindexusers", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsDeleteGroup.js - function indexingPermissionsDeleteGroup(client, request, options) { - return new APIPromise($do102(client, request, options)); - } - async function $do102(client, request, options) { - const parsed = safeParse(request, (value) => DeleteGroupRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deletegroup")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deletegroup", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsDeleteMembership.js - function indexingPermissionsDeleteMembership(client, request, options) { - return new APIPromise($do103(client, request, options)); - } - async function $do103(client, request, options) { - const parsed = safeParse(request, (value) => DeleteMembershipRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deletemembership")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deletemembership", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsDeleteUser.js - function indexingPermissionsDeleteUser(client, request, options) { - return new APIPromise($do104(client, request, options)); - } - async function $do104(client, request, options) { - const parsed = safeParse(request, (value) => DeleteUserRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/deleteuser")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/deleteuser", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsIndexGroup.js - function indexingPermissionsIndexGroup(client, request, options) { - return new APIPromise($do105(client, request, options)); - } - async function $do105(client, request, options) { - const parsed = safeParse(request, (value) => IndexGroupRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexgroup")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexgroup", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsIndexMembership.js - function indexingPermissionsIndexMembership(client, request, options) { - return new APIPromise($do106(client, request, options)); - } - async function $do106(client, request, options) { - const parsed = safeParse(request, (value) => IndexMembershipRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexmembership")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexmembership", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsIndexUser.js - function indexingPermissionsIndexUser(client, request, options) { - return new APIPromise($do107(client, request, options)); - } - async function $do107(client, request, options) { - const parsed = safeParse(request, (value) => IndexUserRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/indexuser")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/indexuser", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsProcessMemberships.js - function indexingPermissionsProcessMemberships(client, request, options) { - return new APIPromise($do108(client, request, options)); - } - async function $do108(client, request, options) { - const parsed = safeParse(request, (value) => ProcessAllMembershipsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = payload === void 0 ? null : encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/processallmemberships")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/processallmemberships", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/funcs/indexingPermissionsUpdatePermissions.js - function indexingPermissionsUpdatePermissions(client, request, options) { - return new APIPromise($do109(client, request, options)); - } - async function $do109(client, request, options) { - const parsed = safeParse(request, (value) => UpdatePermissionsRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - const path = pathToFunc("/api/index/v1/updatepermissions")(); - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "*/*" - })); - const secConfig = await extractSecurity(client._options.apiToken); - const securityInput = secConfig == null ? {} : { apiToken: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "post_/api/index/v1/updatepermissions", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiToken, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["400", "401", "409", "429", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await match(nil(200, voidType()), fail([400, 401, 409, 429, "4XX"]), fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - - // node_modules/@gleanwork/api-client/dist/esm/sdk/permissions.js - var Permissions = class extends ClientSDK { - /** - * Update document permissions - * - * @remarks - * Updates the permissions for a given document without modifying document content. - */ - async updatePermissions(request, options) { - return unwrapAsync(indexingPermissionsUpdatePermissions(this, request, options)); - } - /** - * Index user - * - * @remarks - * Adds a datasource user or updates an existing user. - */ - async indexUser(request, options) { - return unwrapAsync(indexingPermissionsIndexUser(this, request, options)); - } - /** - * Bulk index users - * - * @remarks - * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndexUsers(request, options) { - return unwrapAsync(indexingPermissionsBulkIndexUsers(this, request, options)); - } - /** - * Index group - * - * @remarks - * Add or update a group in the datasource. - */ - async indexGroup(request, options) { - return unwrapAsync(indexingPermissionsIndexGroup(this, request, options)); - } - /** - * Bulk index groups - * - * @remarks - * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndexGroups(request, options) { - return unwrapAsync(indexingPermissionsBulkIndexGroups(this, request, options)); - } - /** - * Index membership - * - * @remarks - * Add the memberships of a group in the datasource. - */ - async indexMembership(request, options) { - return unwrapAsync(indexingPermissionsIndexMembership(this, request, options)); - } - /** - * Bulk index memberships for a group - * - * @remarks - * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - async bulkIndexMemberships(request, options) { - return unwrapAsync(indexingPermissionsBulkIndexMemberships(this, request, options)); - } - /** - * Schedules the processing of group memberships - * - * @remarks - * Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand. - */ - async processMemberships(request, options) { - return unwrapAsync(indexingPermissionsProcessMemberships(this, request, options)); - } - /** - * Delete user - * - * @remarks - * Delete the user from the datasource. Silently succeeds if user is not present. - */ - async deleteUser(request, options) { - return unwrapAsync(indexingPermissionsDeleteUser(this, request, options)); - } - /** - * Delete group - * - * @remarks - * Delete group from the datasource. Silently succeeds if group is not present. - */ - async deleteGroup(request, options) { - return unwrapAsync(indexingPermissionsDeleteGroup(this, request, options)); - } - /** - * Delete membership - * - * @remarks - * Delete membership to a group in the specified datasource. Silently succeeds if membership is not present. - */ - async deleteMembership(request, options) { - return unwrapAsync(indexingPermissionsDeleteMembership(this, request, options)); - } - /** - * Beta users - * - * @remarks - * Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled. - */ - async authorizeBetaUsers(request, options) { - return unwrapAsync(indexingPermissionsAuthorizeBetaUsers(this, request, options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/indexing.js - var Indexing = class extends ClientSDK { - get documents() { - return this._documents ?? (this._documents = new IndexingDocuments(this._options)); - } - get permissions() { - return this._permissions ?? (this._permissions = new Permissions(this._options)); - } - get datasource() { - return this._datasource ?? (this._datasource = new Datasource2(this._options)); - } - get people() { - return this._people ?? (this._people = new People(this._options)); - } - get datasources() { - return this._datasources ?? (this._datasources = new Datasources(this._options)); - } - get authentication() { - return this._authentication ?? (this._authentication = new IndexingAuthentication(this._options)); - } - get shortcuts() { - return this._shortcuts ?? (this._shortcuts = new IndexingShortcuts(this._options)); - } - }; - - // node_modules/@gleanwork/api-client/dist/esm/sdk/sdk.js - var Glean = class extends ClientSDK { - get client() { - return this._client ?? (this._client = new Client(this._options)); - } - get indexing() { - return this._indexing ?? (this._indexing = new Indexing(this._options)); - } - }; - - // - globalThis.__deps__ = globalThis.__deps__ || {}; - globalThis.__deps__._gleanwork_api_client = esm_exports; -})(); diff --git a/examples/docusaurus/public/glean-try-it-now/tsworker.js b/examples/docusaurus/public/glean-try-it-now/tsworker.js deleted file mode 100644 index f4911c357..000000000 --- a/examples/docusaurus/public/glean-try-it-now/tsworker.js +++ /dev/null @@ -1,118 +0,0 @@ -// Web Worker for safely executing bundled code This runs in its own isolated -// context to prevent interference with the main thread, and to prevent console -// logs from the main thread from mixing with the logs from the worker. -// Browser-compatible string formatter (replacement for Node.js util.format) -function format(template, ...args) { - let index = 0; - return template.replace(/%([sdifcoO])/g, (match, specifier) => { - if (index >= args.length) - return match; - const arg = args[index++]; - switch (specifier) { - case "s": // string - return String(arg); - case "d": // number - case "i": // integer - return String(Number(arg)); - case "f": // float - return String(Number(arg)); - case "o": // object (simple) - case "O": // object (detailed) - try { - return JSON.stringify(arg); - } - catch { - return String(arg); - } - case "c": // CSS (not supported, just return empty) - return ""; - default: - return match; - } - }); -} -// Helper to enforce strict typing -function sendMessage(message) { - self.postMessage(message); -} -function createConsolePatch(console, level) { - const originalConsoleMethod = console[level]; - // console itself is defined using `any`, so we need to disable the lint - // eslint-disable-next-line @typescript-eslint/no-explicit-any - console[level] = (message, ...optionalParams) => { - const hasSubstitutions = typeof message === "string" && /%[sdifcoO]/.test(message); - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment - originalConsoleMethod.apply(console, [message, ...optionalParams]); - if (hasSubstitutions) { - sendMessage({ - type: "log", - level, - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument - message: format(message, ...optionalParams), - }); - return; - } - sendMessage({ - type: "log", - level, - message, - }); - for (const optionalParam of optionalParams) { - sendMessage({ - type: "log", - level, - message: optionalParam, - }); - } - }; -} -// Listen for messages from the main thread -self.onmessage = function (event) { - if (event.data.type === "execute") { - // Patch console - createConsolePatch(console, "log"); - createConsolePatch(console, "info"); - createConsolePatch(console, "warn"); - createConsolePatch(console, "error"); - createConsolePatch(console, "debug"); - // Listen for unhandled rejections, which includes the API returning an - // error status code - globalThis.addEventListener("unhandledrejection", (event) => { - sendMessage({ - type: "uncaught-reject", - error: event.reason instanceof Error - ? { - message: event.reason.message, - stack: event.reason.stack, - name: event.reason.name, - } - : { message: String(event.reason) }, - }); - }); - // Execute the wrapped code using an indirect eval call for safety. See - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_direct_eval! - try { - // First execute the dependency bundle to populate globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.dependencyBundle}`); - // Then execute the user code which can access dependencies via globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.bundle}`); - } - catch (error) { - // Send back the error - sendMessage({ - type: "uncaught-exception", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - } - } -}; -export {}; -//# sourceMappingURL=worker.js.map \ No newline at end of file diff --git a/examples/docusaurus/public/glean-try-it-now/types.d.ts b/examples/docusaurus/public/glean-try-it-now/types.d.ts deleted file mode 100644 index cc0f26d41..000000000 --- a/examples/docusaurus/public/glean-try-it-now/types.d.ts +++ /dev/null @@ -1,33387 +0,0 @@ -import * as z from 'zod'; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Activity$ { - /** @deprecated use `Activity$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Activity$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Activity$Outbound` instead. */ - type Outbound = Activity$Outbound; -} - -/** @internal */ -declare const Activity$inboundSchema: z.ZodType; - -/** @internal */ -declare type Activity$Outbound = { - events: Array; -}; - -/** @internal */ -declare const Activity$outboundSchema: z.ZodType; - -declare class Activity extends ClientSDK { - /** - * Report document activity - * - * @remarks - * Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality. - */ - report(request: components.Activity, options?: RequestOptions): Promise; - /** - * Report client activity - * - * @remarks - * Report events that happen to results within a Glean client UI, such as search result views and clicks. This signal improves search quality. - */ - feedback(feedback1?: components.Feedback | undefined, feedbackQueryParameter?: string | undefined, options?: RequestOptions): Promise; -} - -declare type Activity_2 = { - events: Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ActivityEnum$ { - /** @deprecated use `ActivityEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly All: "ALL"; - readonly Search: "SEARCH"; - }>; - /** @deprecated use `ActivityEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly All: "ALL"; - readonly Search: "SEARCH"; - }>; -} - -/** @internal */ -declare const ActivityEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ActivityEnum$outboundSchema: z.ZodNativeEnum; - -/** - * Activity e.g. search, home page visit or all. - */ -declare const ActivityEnum: { - readonly All: "ALL"; - readonly Search: "SEARCH"; -}; - -/** - * Activity e.g. search, home page visit or all. - */ -declare type ActivityEnum = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ActivityEvent$ { - /** @deprecated use `ActivityEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ActivityEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ActivityEvent$Outbound` instead. */ - type Outbound = ActivityEvent$Outbound; -} - -/** @internal */ -declare const ActivityEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ActivityEvent$Outbound = { - id?: string | undefined; - action: string; - params?: ActivityEventParams$Outbound | undefined; - timestamp: string; - url: string; -}; - -/** @internal */ -declare const ActivityEvent$outboundSchema: z.ZodType; - -declare type ActivityEvent = { - /** - * Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - */ - id?: string | undefined; - /** - * The type of activity this represents. - */ - action: ActivityEventAction; - params?: ActivityEventParams | undefined; - /** - * The ISO 8601 timestamp when the activity began. - */ - timestamp: Date; - /** - * The URL of the activity. - */ - url: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ActivityEventAction$ { - /** @deprecated use `ActivityEventAction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly View: "VIEW"; - readonly Edit: "EDIT"; - readonly Search: "SEARCH"; - readonly Comment: "COMMENT"; - readonly Crawl: "CRAWL"; - readonly HistoricalSearch: "HISTORICAL_SEARCH"; - readonly HistoricalView: "HISTORICAL_VIEW"; - }>; - /** @deprecated use `ActivityEventAction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly View: "VIEW"; - readonly Edit: "EDIT"; - readonly Search: "SEARCH"; - readonly Comment: "COMMENT"; - readonly Crawl: "CRAWL"; - readonly HistoricalSearch: "HISTORICAL_SEARCH"; - readonly HistoricalView: "HISTORICAL_VIEW"; - }>; -} - -/** @internal */ -declare const ActivityEventAction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ActivityEventAction$outboundSchema: z.ZodNativeEnum; - -/** - * The type of activity this represents. - */ -declare const ActivityEventAction: { - readonly View: "VIEW"; - readonly Edit: "EDIT"; - readonly Search: "SEARCH"; - readonly Comment: "COMMENT"; - readonly Crawl: "CRAWL"; - readonly HistoricalSearch: "HISTORICAL_SEARCH"; - readonly HistoricalView: "HISTORICAL_VIEW"; -}; - -/** - * The type of activity this represents. - */ -declare type ActivityEventAction = ClosedEnum; - -declare function activityEventFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ActivityEventParams$ { - /** @deprecated use `ActivityEventParams$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ActivityEventParams$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ActivityEventParams$Outbound` instead. */ - type Outbound = ActivityEventParams$Outbound; -} - -/** @internal */ -declare const ActivityEventParams$inboundSchema: z.ZodType; - -/** @internal */ -declare type ActivityEventParams$Outbound = { - bodyContent?: string | undefined; - datasourceInstance?: string | undefined; - datasource?: string | undefined; - instanceOnlyName?: string | undefined; - duration?: number | undefined; - query?: string | undefined; - referrer?: string | undefined; - title?: string | undefined; - truncated?: boolean | undefined; -}; - -/** @internal */ -declare const ActivityEventParams$outboundSchema: z.ZodType; - -declare type ActivityEventParams = { - /** - * The HTML content of the page body. - */ - bodyContent?: string | undefined; - /** - * The full datasource instance name inferred from the URL of the event - */ - datasourceInstance?: string | undefined; - /** - * The datasource without the instance inferred from the URL of the event - */ - datasource?: string | undefined; - /** - * The instance only name of the datasource instance, e.g. 1 for jira_1, inferred from the URL of the event - */ - instanceOnlyName?: string | undefined; - /** - * Length in seconds of the activity. For VIEWS, this represents the amount the page was visible in the foreground. - */ - duration?: number | undefined; - /** - * The user's search query associated with a SEARCH. - */ - query?: string | undefined; - /** - * The referring URL of the VIEW or SEARCH. - */ - referrer?: string | undefined; - /** - * The page title associated with the URL of the event - */ - title?: string | undefined; - /** - * Indicates that the parameters are incomplete and more parameters may be sent with the same action+timestamp+URL in the future. This is used for sending the duration when a `VIEW` is finished. - */ - truncated?: boolean | undefined; -}; - -declare function activityEventParamsFromJSON(jsonString: string): Result; - -declare function activityEventParamsToJSON(activityEventParams: ActivityEventParams): string; - -declare function activityEventToJSON(activityEvent: ActivityEvent): string; - -declare function activityFromJSON(jsonString: string): Result; - -declare function activityToJSON(activity: Activity_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AddCollectionItemsError$ { - /** @deprecated use `AddCollectionItemsError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsError$Outbound` instead. */ - type Outbound = AddCollectionItemsError$Outbound; -} - -/** @internal */ -declare const AddCollectionItemsError$inboundSchema: z.ZodType; - -/** @internal */ -declare type AddCollectionItemsError$Outbound = { - errorType?: string | undefined; -}; - -/** @internal */ -declare const AddCollectionItemsError$outboundSchema: z.ZodType; - -declare type AddCollectionItemsError = { - errorType?: AddCollectionItemsErrorErrorType | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AddCollectionItemsErrorErrorType$ { - /** @deprecated use `AddCollectionItemsErrorErrorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ExistingItem: "EXISTING_ITEM"; - }>; - /** @deprecated use `AddCollectionItemsErrorErrorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ExistingItem: "EXISTING_ITEM"; - }>; -} - -/** @internal */ -declare const AddCollectionItemsErrorErrorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AddCollectionItemsErrorErrorType$outboundSchema: z.ZodNativeEnum; - -declare const AddCollectionItemsErrorErrorType: { - readonly ExistingItem: "EXISTING_ITEM"; -}; - -declare type AddCollectionItemsErrorErrorType = ClosedEnum; - -declare function addCollectionItemsErrorFromJSON(jsonString: string): Result; - -declare function addCollectionItemsErrorToJSON(addCollectionItemsError: AddCollectionItemsError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AddCollectionItemsRequest$ { - /** @deprecated use `AddCollectionItemsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsRequest$Outbound` instead. */ - type Outbound = AddCollectionItemsRequest$Outbound; -} - -/** @internal */ -declare const AddCollectionItemsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AddCollectionItemsRequest$Outbound = { - collectionId: number; - addedCollectionItemDescriptors?: Array | undefined; -}; - -/** @internal */ -declare const AddCollectionItemsRequest$outboundSchema: z.ZodType; - -declare type AddCollectionItemsRequest = { - /** - * The ID of the Collection to add items to. - */ - collectionId: number; - /** - * The CollectionItemDescriptors of the items being added. - */ - addedCollectionItemDescriptors?: Array | undefined; -}; - -declare function addCollectionItemsRequestFromJSON(jsonString: string): Result; - -declare function addCollectionItemsRequestToJSON(addCollectionItemsRequest: AddCollectionItemsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AddCollectionItemsResponse$ { - /** @deprecated use `AddCollectionItemsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AddCollectionItemsResponse$Outbound` instead. */ - type Outbound = AddCollectionItemsResponse$Outbound; -} - -/** @internal */ -declare const AddCollectionItemsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type AddCollectionItemsResponse$Outbound = { - collection?: Collection$Outbound | undefined; - error?: AddCollectionItemsError$Outbound | undefined; -}; - -/** @internal */ -declare const AddCollectionItemsResponse$outboundSchema: z.ZodType; - -declare type AddCollectionItemsResponse = { - collection?: Collection | undefined; - error?: AddCollectionItemsError | undefined; -}; - -declare function addCollectionItemsResponseFromJSON(jsonString: string): Result; - -declare function addCollectionItemsResponseToJSON(addCollectionItemsResponse: AddCollectionItemsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AdditionalFieldDefinition$ { - /** @deprecated use `AdditionalFieldDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AdditionalFieldDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AdditionalFieldDefinition$Outbound` instead. */ - type Outbound = AdditionalFieldDefinition$Outbound; -} - -/** @internal */ -declare const AdditionalFieldDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type AdditionalFieldDefinition$Outbound = { - key?: string | undefined; - value?: Array | undefined; -}; - -/** @internal */ -declare const AdditionalFieldDefinition$outboundSchema: z.ZodType; - -/** - * Additional information about the employee or team. - */ -declare type AdditionalFieldDefinition = { - /** - * Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores. - */ - key?: string | undefined; - /** - * List of type string or HypertextField. - * - * @remarks - * - * HypertextField is defined as - * ``` - * { - * anchor: string, // Anchor text for the hypertext field. - * hyperlink: string, // URL for the hypertext field. - * } - * ``` - * Example: ```{"anchor":"Glean","hyperlink":"https://glean.com"}``` - * - * When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs. - * - * **Note**: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored. - * Example: ```"languages": [{"lang":"English","lang":"Spanish",...}]```. In this case, the key "lang" will be ignored and can even be passed in as an empty string. - */ - value?: Array | undefined; -}; - -declare function additionalFieldDefinitionFromJSON(jsonString: string): Result; - -declare function additionalFieldDefinitionToJSON(additionalFieldDefinition: AdditionalFieldDefinition): string; - -declare type AfterErrorContext = HookContext & {}; - -declare interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable_2<{ - response: Response | null; - error: unknown; - }>; -} - -declare type AfterSuccessContext = HookContext & {}; - -declare interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable_2; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Agent$ { - /** @deprecated use `Agent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Agent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Agent$Outbound` instead. */ - type Outbound = Agent$Outbound; -} - -/** @internal */ -declare const Agent$inboundSchema: z.ZodType; - -/** @internal */ -declare type Agent$Outbound = { - agent_id: string; - name: string; - description?: string | undefined; - metadata?: AgentMetadata$Outbound | undefined; - capabilities: AgentCapabilities$Outbound; -}; - -/** @internal */ -declare const Agent$outboundSchema: z.ZodType; - -declare type Agent = { - /** - * The ID of the agent. - */ - agentId: string; - /** - * The name of the agent - */ - name: string; - /** - * The description of the agent. - */ - description?: string | undefined; - /** - * The agent metadata. Currently not implemented. - */ - metadata?: AgentMetadata | undefined; - /** - * Describes features that the agent supports. example: { - * - * @remarks - * "ap.io.messages": true, - * "ap.io.streaming": true - * } - */ - capabilities: AgentCapabilities; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCapabilities$ { - /** @deprecated use `AgentCapabilities$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCapabilities$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCapabilities$Outbound` instead. */ - type Outbound = AgentCapabilities$Outbound; -} - -/** @internal */ -declare const AgentCapabilities$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCapabilities$Outbound = { - "ap.io.messages"?: boolean | undefined; - "ap.io.streaming"?: boolean | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const AgentCapabilities$outboundSchema: z.ZodType; - -/** - * Describes features that the agent supports. example: { - * - * @remarks - * "ap.io.messages": true, - * "ap.io.streaming": true - * } - */ -declare type AgentCapabilities = { - /** - * Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent. - */ - apIoMessages?: boolean | undefined; - /** - * Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming. - */ - apIoStreaming?: boolean | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function agentCapabilitiesFromJSON(jsonString: string): Result; - -declare function agentCapabilitiesToJSON(agentCapabilities: AgentCapabilities): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConfig$ { - /** @deprecated use `AgentConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentConfig$Outbound` instead. */ - type Outbound = AgentConfig$Outbound; -} - -/** @internal */ -declare const AgentConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentConfig$Outbound = { - agent?: string | undefined; - toolSets?: ToolSets$Outbound | undefined; - mode?: string | undefined; -}; - -/** @internal */ -declare const AgentConfig$outboundSchema: z.ZodType; - -/** - * Describes the agent that executes the request. - */ -declare type AgentConfig = { - /** - * Name of the agent. - */ - agent?: AgentEnum | undefined; - /** - * The types of tools that the agent is allowed to use. Only works with FAST and ADVANCED `agent` values - */ - toolSets?: ToolSets | undefined; - /** - * Top level modes to run GleanChat in. - */ - mode?: Mode | undefined; -}; - -declare function agentConfigFromJSON(jsonString: string): Result; - -declare function agentConfigToJSON(agentConfig: AgentConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentEnum$ { - /** @deprecated use `AgentEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly Gpt: "GPT"; - readonly Universal: "UNIVERSAL"; - readonly Fast: "FAST"; - readonly Advanced: "ADVANCED"; - }>; - /** @deprecated use `AgentEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly Gpt: "GPT"; - readonly Universal: "UNIVERSAL"; - readonly Fast: "FAST"; - readonly Advanced: "ADVANCED"; - }>; -} - -/** @internal */ -declare const AgentEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentEnum$outboundSchema: z.ZodNativeEnum; - -/** - * Name of the agent. - */ -declare const AgentEnum: { - readonly Default: "DEFAULT"; - readonly Gpt: "GPT"; - readonly Universal: "UNIVERSAL"; - readonly Fast: "FAST"; - readonly Advanced: "ADVANCED"; -}; - -/** - * Name of the agent. - */ -declare type AgentEnum = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentExecutionStatus$ { - /** @deprecated use `AgentExecutionStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Error: "error"; - readonly Success: "success"; - }>; - /** @deprecated use `AgentExecutionStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Error: "error"; - readonly Success: "success"; - }>; -} - -/** @internal */ -declare const AgentExecutionStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentExecutionStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The status of the run. One of 'error', 'success'. - */ -declare const AgentExecutionStatus: { - readonly Error: "error"; - readonly Success: "success"; -}; - -/** - * The status of the run. One of 'error', 'success'. - */ -declare type AgentExecutionStatus = ClosedEnum; - -declare function agentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentMetadata$ { - /** @deprecated use `AgentMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentMetadata$Outbound` instead. */ - type Outbound = AgentMetadata$Outbound; -} - -/** @internal */ -declare const AgentMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentMetadata$Outbound = {}; - -/** @internal */ -declare const AgentMetadata$outboundSchema: z.ZodType; - -/** - * The agent metadata. Currently not implemented. - */ -declare type AgentMetadata = {}; - -declare function agentMetadataFromJSON(jsonString: string): Result; - -declare function agentMetadataToJSON(agentMetadata: AgentMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentRun$ { - /** @deprecated use `AgentRun$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentRun$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentRun$Outbound` instead. */ - type Outbound = AgentRun$Outbound; -} - -/** @internal */ -declare const AgentRun$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentRun$Outbound = { - agent_id: string; - input?: { - [k: string]: any; - } | undefined; - messages?: Array | undefined; - metadata?: { - [k: string]: any; - } | undefined; - status?: string | undefined; -}; - -/** @internal */ -declare const AgentRun$outboundSchema: z.ZodType; - -/** - * Payload for creating a run. - */ -declare type AgentRun = { - /** - * The ID of the agent to run. - */ - agentId: string; - /** - * The input to the agent. - */ - input?: { - [k: string]: any; - } | undefined; - /** - * The messages to pass an input to the agent. - */ - messages?: Array | undefined; - /** - * The metadata to pass to the agent. - */ - metadata?: { - [k: string]: any; - } | undefined; - /** - * The status of the run. One of 'error', 'success'. - */ - status?: AgentExecutionStatus | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentRunCreate$ { - /** @deprecated use `AgentRunCreate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentRunCreate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentRunCreate$Outbound` instead. */ - type Outbound = AgentRunCreate$Outbound; -} - -/** @internal */ -declare const AgentRunCreate$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentRunCreate$Outbound = { - agent_id: string; - input?: { - [k: string]: any; - } | undefined; - messages?: Array | undefined; - metadata?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const AgentRunCreate$outboundSchema: z.ZodType; - -/** - * Payload for creating a run. - */ -declare type AgentRunCreate = { - /** - * The ID of the agent to run. - */ - agentId: string; - /** - * The input to the agent. - */ - input?: { - [k: string]: any; - } | undefined; - /** - * The messages to pass an input to the agent. - */ - messages?: Array | undefined; - /** - * The metadata to pass to the agent. - */ - metadata?: { - [k: string]: any; - } | undefined; -}; - -declare function agentRunCreateFromJSON(jsonString: string): Result; - -declare function agentRunCreateToJSON(agentRunCreate: AgentRunCreate): string; - -declare function agentRunFromJSON(jsonString: string): Result; - -declare function agentRunToJSON(agentRun: AgentRun): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentRunWaitResponse$ { - /** @deprecated use `AgentRunWaitResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentRunWaitResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentRunWaitResponse$Outbound` instead. */ - type Outbound = AgentRunWaitResponse$Outbound; -} - -/** @internal */ -declare const AgentRunWaitResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentRunWaitResponse$Outbound = { - run?: AgentRun$Outbound | undefined; - messages?: Array | undefined; -}; - -/** @internal */ -declare const AgentRunWaitResponse$outboundSchema: z.ZodType; - -declare type AgentRunWaitResponse = { - run?: AgentRun | undefined; - /** - * The messages returned by the run. - */ - messages?: Array | undefined; -}; - -declare function agentRunWaitResponseFromJSON(jsonString: string): Result; - -declare function agentRunWaitResponseToJSON(agentRunWaitResponse: AgentRunWaitResponse): string; - -declare class Agents extends ClientSDK { - /** - * Retrieve an agent - * - * @remarks - * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder. - */ - retrieve(agentId: string, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * List an agent's schemas - * - * @remarks - * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure. - */ - retrieveSchemas(agentId: string, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Search agents - * - * @remarks - * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name. - */ - list(request: components.SearchAgentsRequest, options?: RequestOptions): Promise; - /** - * Create an agent run and stream the response - * - * @remarks - * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). - */ - runStream(request: components.AgentRunCreate, options?: RequestOptions): Promise; - /** - * Create an agent run and wait for the response - * - * @remarks - * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. - */ - run(request: components.AgentRunCreate, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentSchemas$ { - /** @deprecated use `AgentSchemas$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentSchemas$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentSchemas$Outbound` instead. */ - type Outbound = AgentSchemas$Outbound; -} - -/** @internal */ -declare const AgentSchemas$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentSchemas$Outbound = { - agent_id: string; - input_schema: InputSchema$Outbound; - output_schema: OutputSchema$Outbound; -}; - -/** @internal */ -declare const AgentSchemas$outboundSchema: z.ZodType; - -/** - * Defines the structure and properties of an agent. - */ -declare type AgentSchemas = { - /** - * The ID of the agent. - */ - agentId: string; - /** - * The schema for the agent input. In JSON Schema format. - */ - inputSchema: InputSchema; - /** - * The schema for the agent output. In JSON Schema format. - */ - outputSchema: OutputSchema; -}; - -declare function agentSchemasFromJSON(jsonString: string): Result; - -declare function agentSchemasToJSON(agentSchemas: AgentSchemas): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsInsightsV2Request$ { - /** @deprecated use `AgentsInsightsV2Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsInsightsV2Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsInsightsV2Request$Outbound` instead. */ - type Outbound = AgentsInsightsV2Request$Outbound; -} - -/** @internal */ -declare const AgentsInsightsV2Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsInsightsV2Request$Outbound = { - agentIds?: Array | undefined; - departments?: Array | undefined; - dayRange?: Period$Outbound | undefined; -}; - -/** @internal */ -declare const AgentsInsightsV2Request$outboundSchema: z.ZodType; - -declare type AgentsInsightsV2Request = { - /** - * IDs of the Agents for which Insights should be returned. An empty array signifies all. - */ - agentIds?: Array | undefined; - /** - * Departments for which Insights are requested. - */ - departments?: Array | undefined; - dayRange?: Period | undefined; -}; - -declare function agentsInsightsV2RequestFromJSON(jsonString: string): Result; - -declare function agentsInsightsV2RequestToJSON(agentsInsightsV2Request: AgentsInsightsV2Request): string; - -declare function agentToJSON(agent: Agent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AiAppActionCounts$ { - /** @deprecated use `AiAppActionCounts$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AiAppActionCounts$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AiAppActionCounts$Outbound` instead. */ - type Outbound = AiAppActionCounts$Outbound; -} - -/** @internal */ -declare const AiAppActionCounts$inboundSchema: z.ZodType; - -/** @internal */ -declare type AiAppActionCounts$Outbound = { - totalSlackbotResponses?: number | undefined; - totalSlackbotResponsesShared?: number | undefined; - totalSlackbotResponsesNotHelpful?: number | undefined; - totalChatMessages?: number | undefined; - totalUpvotes?: number | undefined; - totalDownvotes?: number | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const AiAppActionCounts$outboundSchema: z.ZodType; - -/** - * Map from action to frequency. - */ -declare type AiAppActionCounts = { - /** - * Total number of Slackbot responses, both proactive and reactive. - */ - totalSlackbotResponses?: number | undefined; - /** - * Total number of Slackbot responses shared publicly (upvoted). - */ - totalSlackbotResponsesShared?: number | undefined; - /** - * Total number of Slackbot responses rejected as not helpful (downvoted). - */ - totalSlackbotResponsesNotHelpful?: number | undefined; - /** - * Total number of Chat messages sent in requested period. - */ - totalChatMessages?: number | undefined; - /** - * Total number of Chat messages which received upvotes by the user. - */ - totalUpvotes?: number | undefined; - /** - * Total number of Chat messages which received downvotes by the user. - */ - totalDownvotes?: number | undefined; - additionalProperties?: { - [k: string]: number; - }; -}; - -declare function aiAppActionCountsFromJSON(jsonString: string): Result; - -declare function aiAppActionCountsToJSON(aiAppActionCounts: AiAppActionCounts): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AiAppsInsightsResponse$ { - /** @deprecated use `AiAppsInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AiAppsInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AiAppsInsightsResponse$Outbound` instead. */ - type Outbound = AiAppsInsightsResponse$Outbound; -} - -/** @internal */ -declare const AiAppsInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type AiAppsInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - aiAppInsights?: Array | undefined; - totalActiveUsers?: number | undefined; - actionCounts?: AiAppActionCounts$Outbound | undefined; - departments?: Array | undefined; -}; - -/** @internal */ -declare const AiAppsInsightsResponse$outboundSchema: z.ZodType; - -declare type AiAppsInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - aiAppInsights?: Array | undefined; - /** - * Total number of active users on the Ai App in the requested period. - */ - totalActiveUsers?: number | undefined; - /** - * Map from action to frequency. - */ - actionCounts?: AiAppActionCounts | undefined; - /** - * list of departments applicable for users tab. - */ - departments?: Array | undefined; -}; - -declare function aiAppsInsightsResponseFromJSON(jsonString: string): Result; - -declare function aiAppsInsightsResponseToJSON(aiAppsInsightsResponse: AiAppsInsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AiInsightsResponse$ { - /** @deprecated use `AiInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AiInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AiInsightsResponse$Outbound` instead. */ - type Outbound = AiInsightsResponse$Outbound; -} - -/** @internal */ -declare const AiInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type AiInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - assistantInsights?: Array | undefined; - totalActiveAssistantUsers?: number | undefined; - totalChatMessages?: number | undefined; - totalAiSummarizations?: number | undefined; - totalAiAnswers?: number | undefined; - totalUpvotes?: number | undefined; - totalDownvotes?: number | undefined; - totalGleanbotResponses?: number | undefined; - totalGleanbotResponsesShared?: number | undefined; - totalGleanbotResponsesNotHelpful?: number | undefined; - departments?: Array | undefined; -}; - -/** @internal */ -declare const AiInsightsResponse$outboundSchema: z.ZodType; - -declare type AiInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - assistantInsights?: Array | undefined; - /** - * Total number of Active Assistant users (chat, summary, AIA) in requested period. - */ - totalActiveAssistantUsers?: number | undefined; - /** - * Total number of Chat messages sent in requested period. - */ - totalChatMessages?: number | undefined; - /** - * Total number of AI Document Summarizations invoked in the requested period. - */ - totalAiSummarizations?: number | undefined; - /** - * Total number of AI Answers generated in the requested period. - */ - totalAiAnswers?: number | undefined; - /** - * Total number of Chat messages which received upvotes by the user. - */ - totalUpvotes?: number | undefined; - /** - * Total number of Chat messages which received downvotes by the user. - */ - totalDownvotes?: number | undefined; - /** - * Total number of Gleanbot responses, both proactive and reactive. - */ - totalGleanbotResponses?: number | undefined; - /** - * Total number of Gleanbot responses shared publicly (upvoted). - */ - totalGleanbotResponsesShared?: number | undefined; - /** - * Total number of Glean responses rejected as not helpful (downvoted). - */ - totalGleanbotResponsesNotHelpful?: number | undefined; - /** - * list of departments applicable for users tab. - */ - departments?: Array | undefined; -}; - -declare function aiInsightsResponseFromJSON(jsonString: string): Result; - -declare function aiInsightsResponseToJSON(aiInsightsResponse: AiInsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AllowlistOptions$ { - /** @deprecated use `AllowlistOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AllowlistOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AllowlistOptions$Outbound` instead. */ - type Outbound = AllowlistOptions$Outbound; -} - -/** @internal */ -declare const AllowlistOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type AllowlistOptions$Outbound = { - terms?: Array | undefined; -}; - -/** @internal */ -declare const AllowlistOptions$outboundSchema: z.ZodType; - -/** - * Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - */ -declare type AllowlistOptions = { - /** - * list of words and phrases to consider as whitelisted content - */ - terms?: Array | undefined; -}; - -declare function allowlistOptionsFromJSON(jsonString: string): Result; - -declare function allowlistOptionsToJSON(allowlistOptions: AllowlistOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Announcement$ { - /** @deprecated use `Announcement$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Announcement$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Announcement$Outbound` instead. */ - type Outbound = Announcement$Outbound; -} - -/** @internal */ -declare const Announcement$inboundSchema: z.ZodType; - -/** @internal */ -declare type Announcement$Outbound = { - startTime?: string | undefined; - endTime?: string | undefined; - title?: string | undefined; - body?: StructuredText$Outbound | undefined; - emoji?: string | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - banner?: Thumbnail$Outbound | undefined; - audienceFilters?: Array | undefined; - sourceDocumentId?: string | undefined; - hideAttribution?: boolean | undefined; - channel?: string | undefined; - postType?: string | undefined; - isPrioritized?: boolean | undefined; - viewUrl?: string | undefined; - draftId?: number | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id?: number | undefined; - author?: Person$Outbound | undefined; - createTimestamp?: number | undefined; - lastUpdateTimestamp?: number | undefined; - updatedBy?: Person$Outbound | undefined; - viewerInfo?: AnnouncementViewerInfo$Outbound | undefined; - sourceDocument?: Document$Outbound | undefined; - isPublished?: boolean | undefined; -}; - -/** @internal */ -declare const Announcement$outboundSchema: z.ZodType; - -declare type Announcement = { - /** - * The date and time at which the announcement becomes active. - */ - startTime?: Date | undefined; - /** - * The date and time at which the announcement expires. - */ - endTime?: Date | undefined; - /** - * The headline of the announcement. - */ - title?: string | undefined; - body?: StructuredText | undefined; - /** - * An emoji used to indicate the nature of the announcement. - */ - emoji?: string | undefined; - thumbnail?: Thumbnail | undefined; - banner?: Thumbnail | undefined; - /** - * Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - */ - sourceDocumentId?: string | undefined; - /** - * Whether or not to hide an author attribution. - */ - hideAttribution?: boolean | undefined; - /** - * This determines whether this is a Social Feed post or a regular announcement. - */ - channel?: AnnouncementChannel | undefined; - /** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ - postType?: AnnouncementPostType | undefined; - /** - * Used by the Social Feed to pin posts to the front of the feed. - */ - isPrioritized?: boolean | undefined; - /** - * URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - */ - viewUrl?: string | undefined; - /** - * The opaque id of the associated draft. - */ - draftId?: number | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The opaque id of the announcement. - */ - id?: number | undefined; - author?: Person | undefined; - /** - * Server Unix timestamp of the creation time (in seconds since epoch UTC). - */ - createTimestamp?: number | undefined; - /** - * Server Unix timestamp of the last update time (in seconds since epoch UTC). - */ - lastUpdateTimestamp?: number | undefined; - updatedBy?: Person | undefined; - viewerInfo?: AnnouncementViewerInfo | undefined; - sourceDocument?: Document_2 | undefined; - /** - * Whether or not the announcement is published. - */ - isPublished?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnnouncementChannel$ { - /** @deprecated use `AnnouncementChannel$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; - /** @deprecated use `AnnouncementChannel$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; -} - -/** @internal */ -declare const AnnouncementChannel$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AnnouncementChannel$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare const AnnouncementChannel: { - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; -}; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare type AnnouncementChannel = ClosedEnum; - -declare function announcementFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnnouncementPostType$ { - /** @deprecated use `AnnouncementPostType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; - /** @deprecated use `AnnouncementPostType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; -} - -/** @internal */ -declare const AnnouncementPostType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AnnouncementPostType$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare const AnnouncementPostType: { - readonly Text: "TEXT"; - readonly Link: "LINK"; -}; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare type AnnouncementPostType = ClosedEnum; - -declare class Announcements extends ClientSDK { - /** - * Create Announcement - * - * @remarks - * Create a textual announcement visible to some set of users based on department and location. - */ - create(request: components.CreateAnnouncementRequest, options?: RequestOptions): Promise; - /** - * Delete Announcement - * - * @remarks - * Delete an existing user-generated announcement. - */ - delete(request: components.DeleteAnnouncementRequest, options?: RequestOptions): Promise; - /** - * Update Announcement - * - * @remarks - * Update a textual announcement visible to some set of users based on department and location. - */ - update(request: components.UpdateAnnouncementRequest, options?: RequestOptions): Promise; -} - -declare function announcementToJSON(announcement: Announcement): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnnouncementViewerInfo$ { - /** @deprecated use `AnnouncementViewerInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnnouncementViewerInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnnouncementViewerInfo$Outbound` instead. */ - type Outbound = AnnouncementViewerInfo$Outbound; -} - -/** @internal */ -declare const AnnouncementViewerInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnnouncementViewerInfo$Outbound = { - isDismissed?: boolean | undefined; - isRead?: boolean | undefined; -}; - -/** @internal */ -declare const AnnouncementViewerInfo$outboundSchema: z.ZodType; - -declare type AnnouncementViewerInfo = { - /** - * Whether the viewer has dismissed the announcement. - */ - isDismissed?: boolean | undefined; - /** - * Whether the viewer has read the announcement. - */ - isRead?: boolean | undefined; -}; - -declare function announcementViewerInfoFromJSON(jsonString: string): Result; - -declare function announcementViewerInfoToJSON(announcementViewerInfo: AnnouncementViewerInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnonymousEvent$ { - /** @deprecated use `AnonymousEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnonymousEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnonymousEvent$Outbound` instead. */ - type Outbound = AnonymousEvent$Outbound; -} - -/** @internal */ -declare const AnonymousEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnonymousEvent$Outbound = { - time?: TimeInterval$Outbound | undefined; - eventType?: string | undefined; -}; - -/** @internal */ -declare const AnonymousEvent$outboundSchema: z.ZodType; - -/** - * A generic, light-weight calendar event. - */ -declare type AnonymousEvent = { - time?: TimeInterval | undefined; - /** - * The nature of the event, for example "out of office". - */ - eventType?: AnonymousEventEventType | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnonymousEventEventType$ { - /** @deprecated use `AnonymousEventEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; - }>; - /** @deprecated use `AnonymousEventEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; - }>; -} - -/** @internal */ -declare const AnonymousEventEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AnonymousEventEventType$outboundSchema: z.ZodNativeEnum; - -/** - * The nature of the event, for example "out of office". - */ -declare const AnonymousEventEventType: { - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; -}; - -/** - * The nature of the event, for example "out of office". - */ -declare type AnonymousEventEventType = ClosedEnum; - -declare function anonymousEventFromJSON(jsonString: string): Result; - -declare function anonymousEventToJSON(anonymousEvent: AnonymousEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Answer$ { - /** @deprecated use `Answer$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Answer$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Answer$Outbound` instead. */ - type Outbound = Answer$Outbound; -} - -/** @internal */ -declare const Answer$inboundSchema: z.ZodType; - -/** @internal */ -declare type Answer$Outbound = { - id: number; - docId?: string | undefined; - question?: string | undefined; - questionVariations?: Array | undefined; - bodyText?: string | undefined; - boardId?: number | undefined; - audienceFilters?: Array | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion$Outbound | undefined; - sourceType?: string | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - combinedAnswerText?: StructuredText$Outbound | undefined; - likes?: AnswerLikes$Outbound | undefined; - author?: Person$Outbound | undefined; - createTime?: string | undefined; - updateTime?: string | undefined; - updatedBy?: Person$Outbound | undefined; - verification?: Verification$Outbound | undefined; - board?: AnswerBoard$Outbound | undefined; - collections?: Array | undefined; - documentCategory?: string | undefined; - sourceDocument?: Document$Outbound | undefined; -}; - -/** @internal */ -declare const Answer$outboundSchema: z.ZodType; - -declare type Answer = { - /** - * The opaque ID of the Answer. - */ - id: number; - /** - * Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - */ - docId?: string | undefined; - question?: string | undefined; - /** - * Additional ways of phrasing this question. - */ - questionVariations?: Array | undefined; - /** - * The plain text answer to the question. - */ - bodyText?: string | undefined; - /** - * The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - boardId?: number | undefined; - /** - * Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * A list of user roles for the answer added by the owner. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles for the answer removed by the owner. - */ - removedRoles?: Array | undefined; - /** - * A list of roles for this answer explicitly granted by an owner, editor, or admin. - */ - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion | undefined; - sourceType?: AnswerSourceType | undefined; - permissions?: ObjectPermissions | undefined; - combinedAnswerText?: StructuredText | undefined; - likes?: AnswerLikes | undefined; - author?: Person | undefined; - /** - * The time the answer was created in ISO format (ISO 8601). - */ - createTime?: Date | undefined; - /** - * The time the answer was last updated in ISO format (ISO 8601). - */ - updateTime?: Date | undefined; - updatedBy?: Person | undefined; - verification?: Verification | undefined; - board?: AnswerBoard | undefined; - /** - * The collections to which the answer belongs. - */ - collections?: Array | undefined; - /** - * The document's document_category(.proto). - */ - documentCategory?: string | undefined; - sourceDocument?: Document_2 | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerBoard$ { - /** @deprecated use `AnswerBoard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnswerBoard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnswerBoard$Outbound` instead. */ - type Outbound = AnswerBoard$Outbound; -} - -/** @internal */ -declare const AnswerBoard$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnswerBoard$Outbound = { - name: string; - description: string; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - audienceFilters?: Array | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id: number; - createTime?: string | undefined; - updateTime?: string | undefined; - creator?: Person$Outbound | undefined; - updatedBy?: Person$Outbound | undefined; - itemCount?: number | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const AnswerBoard$outboundSchema: z.ZodType; - -declare type AnswerBoard = { - /** - * The unique name of the Collection. - */ - name: string; - /** - * A brief summary of the Collection's contents. - */ - description: string; - /** - * A list of added user roles for the Collection. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Collection. - */ - removedRoles?: Array | undefined; - /** - * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The unique ID of the Answer Board. - */ - id: number; - createTime?: Date | undefined; - updateTime?: Date | undefined; - creator?: Person | undefined; - updatedBy?: Person | undefined; - /** - * The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - */ - itemCount?: number | undefined; - /** - * A list of user roles for the Answer Board. - */ - roles?: Array | undefined; -}; - -declare function answerBoardFromJSON(jsonString: string): Result; - -declare function answerBoardToJSON(answerBoard: AnswerBoard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerCreationData$ { - /** @deprecated use `AnswerCreationData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnswerCreationData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnswerCreationData$Outbound` instead. */ - type Outbound = AnswerCreationData$Outbound; -} - -/** @internal */ -declare const AnswerCreationData$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnswerCreationData$Outbound = { - question?: string | undefined; - questionVariations?: Array | undefined; - bodyText?: string | undefined; - boardId?: number | undefined; - audienceFilters?: Array | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion$Outbound | undefined; - sourceType?: string | undefined; - addedCollections?: Array | undefined; - combinedAnswerText?: StructuredTextMutableProperties$Outbound | undefined; -}; - -/** @internal */ -declare const AnswerCreationData$outboundSchema: z.ZodType; - -declare type AnswerCreationData = { - question?: string | undefined; - /** - * Additional ways of phrasing this question. - */ - questionVariations?: Array | undefined; - /** - * The plain text answer to the question. - */ - bodyText?: string | undefined; - /** - * The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - boardId?: number | undefined; - /** - * Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * A list of user roles for the answer added by the owner. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles for the answer removed by the owner. - */ - removedRoles?: Array | undefined; - /** - * A list of roles for this answer explicitly granted by an owner, editor, or admin. - */ - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion | undefined; - sourceType?: AnswerCreationDataSourceType | undefined; - /** - * IDs of Collections to which a document is added. - */ - addedCollections?: Array | undefined; - combinedAnswerText?: StructuredTextMutableProperties | undefined; -}; - -declare function answerCreationDataFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerCreationDataSourceType$ { - /** @deprecated use `AnswerCreationDataSourceType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; - /** @deprecated use `AnswerCreationDataSourceType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; -} - -/** @internal */ -declare const AnswerCreationDataSourceType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AnswerCreationDataSourceType$outboundSchema: z.ZodNativeEnum; - -declare const AnswerCreationDataSourceType: { - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; -}; - -declare type AnswerCreationDataSourceType = ClosedEnum; - -declare function answerCreationDataToJSON(answerCreationData: AnswerCreationData): string; - -declare function answerFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerLike$ { - /** @deprecated use `AnswerLike$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnswerLike$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnswerLike$Outbound` instead. */ - type Outbound = AnswerLike$Outbound; -} - -/** @internal */ -declare const AnswerLike$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnswerLike$Outbound = { - user?: Person$Outbound | undefined; - createTime?: string | undefined; -}; - -/** @internal */ -declare const AnswerLike$outboundSchema: z.ZodType; - -declare type AnswerLike = { - user?: Person | undefined; - /** - * The time the user liked the answer in ISO format (ISO 8601). - */ - createTime?: Date | undefined; -}; - -declare function answerLikeFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerLikes$ { - /** @deprecated use `AnswerLikes$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnswerLikes$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnswerLikes$Outbound` instead. */ - type Outbound = AnswerLikes$Outbound; -} - -/** @internal */ -declare const AnswerLikes$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnswerLikes$Outbound = { - likedBy: Array; - likedByUser: boolean; - numLikes: number; -}; - -/** @internal */ -declare const AnswerLikes$outboundSchema: z.ZodType; - -declare type AnswerLikes = { - likedBy: Array; - /** - * Whether the user in context liked the answer. - */ - likedByUser: boolean; - /** - * The total number of likes for the answer. - */ - numLikes: number; -}; - -declare function answerLikesFromJSON(jsonString: string): Result; - -declare function answerLikesToJSON(answerLikes: AnswerLikes): string; - -declare function answerLikeToJSON(answerLike: AnswerLike): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerResult$ { - /** @deprecated use `AnswerResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AnswerResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AnswerResult$Outbound` instead. */ - type Outbound = AnswerResult$Outbound; -} - -/** @internal */ -declare const AnswerResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type AnswerResult$Outbound = { - answer: Answer$Outbound; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const AnswerResult$outboundSchema: z.ZodType; - -declare type AnswerResult = { - answer: Answer; - /** - * An opaque token that represents this particular Answer. To be used for `/feedback` reporting. - */ - trackingToken?: string | undefined; -}; - -declare function answerResultFromJSON(jsonString: string): Result; - -declare function answerResultToJSON(answerResult: AnswerResult): string; - -declare class Answers extends ClientSDK { - /** - * Create Answer - * - * @remarks - * Create a user-generated Answer that contains a question and answer. - */ - create(request: components.CreateAnswerRequest, options?: RequestOptions): Promise; - /** - * Delete Answer - * - * @remarks - * Delete an existing user-generated Answer. - */ - delete(request: components.DeleteAnswerRequest, options?: RequestOptions): Promise; - /** - * Update Answer - * - * @remarks - * Update an existing user-generated Answer. - */ - update(request: components.EditAnswerRequest, options?: RequestOptions): Promise; - /** - * Read Answer - * - * @remarks - * Read the details of a particular Answer given its ID. - */ - retrieve(request: components.GetAnswerRequest, options?: RequestOptions): Promise; - /** - * List Answers - * - * @remarks - * List Answers created by the current user. - */ - list(request: components.ListAnswersRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AnswerSourceType$ { - /** @deprecated use `AnswerSourceType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; - /** @deprecated use `AnswerSourceType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; -} - -/** @internal */ -declare const AnswerSourceType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AnswerSourceType$outboundSchema: z.ZodNativeEnum; - -declare const AnswerSourceType: { - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; -}; - -declare type AnswerSourceType = ClosedEnum; - -declare function answerToJSON(answer: Answer): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AppResult$ { - /** @deprecated use `AppResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AppResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AppResult$Outbound` instead. */ - type Outbound = AppResult$Outbound; -} - -/** @internal */ -declare const AppResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type AppResult$Outbound = { - datasource: string; - docType?: string | undefined; - mimeType?: string | undefined; - iconUrl?: string | undefined; -}; - -/** @internal */ -declare const AppResult$outboundSchema: z.ZodType; - -declare type AppResult = { - /** - * The app or other repository type this represents - */ - datasource: string; - /** - * The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - */ - docType?: string | undefined; - /** - * Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive) - */ - mimeType?: string | undefined; - /** - * If there is available icon URL. - */ - iconUrl?: string | undefined; -}; - -declare function appResultFromJSON(jsonString: string): Result; - -declare function appResultToJSON(appResult: AppResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantActivityType$ { - /** @deprecated use `AssistantActivityType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly GleanChat: "GLEAN_CHAT"; - readonly AiSummary: "AI_SUMMARY"; - readonly AiAnswer: "AI_ANSWER"; - readonly GleanbotResponse: "GLEANBOT_RESPONSE"; - }>; - /** @deprecated use `AssistantActivityType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly GleanChat: "GLEAN_CHAT"; - readonly AiSummary: "AI_SUMMARY"; - readonly AiAnswer: "AI_ANSWER"; - readonly GleanbotResponse: "GLEANBOT_RESPONSE"; - }>; -} - -/** @internal */ -declare const AssistantActivityType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AssistantActivityType$outboundSchema: z.ZodNativeEnum; - -declare const AssistantActivityType: { - readonly GleanChat: "GLEAN_CHAT"; - readonly AiSummary: "AI_SUMMARY"; - readonly AiAnswer: "AI_ANSWER"; - readonly GleanbotResponse: "GLEANBOT_RESPONSE"; -}; - -declare type AssistantActivityType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AuthConfig$ { - /** @deprecated use `AuthConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AuthConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AuthConfig$Outbound` instead. */ - type Outbound = AuthConfig$Outbound; -} - -/** @internal */ -declare const AuthConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type AuthConfig$Outbound = { - isOnPrem?: boolean | undefined; - usesCentralAuth?: boolean | undefined; - type?: string | undefined; - grantType?: string | undefined; - status?: string | undefined; - client_url?: string | undefined; - scopes?: Array | undefined; - audiences?: Array | undefined; - authorization_url?: string | undefined; - lastAuthorizedAt?: string | undefined; -}; - -/** @internal */ -declare const AuthConfig$outboundSchema: z.ZodType; - -/** - * Config for tool's authentication method. - */ -declare type AuthConfig = { - /** - * Whether or not this tool is hosted on-premise. - */ - isOnPrem?: boolean | undefined; - /** - * Whether or not this uses central auth. - */ - usesCentralAuth?: boolean | undefined; - /** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ - type?: AuthConfigType | undefined; - /** - * The type of grant type being used. - */ - grantType?: GrantType | undefined; - /** - * Auth status of the tool. - */ - status?: AuthConfigStatus | undefined; - /** - * The URL where users will be directed to start the OAuth flow. - */ - clientUrl?: string | undefined; - /** - * A list of strings denoting the different scopes or access levels required by the tool. - */ - scopes?: Array | undefined; - /** - * A list of strings denoting the different audience which can access the tool. - */ - audiences?: Array | undefined; - /** - * The OAuth provider's endpoint, where access tokens are requested. - */ - authorizationUrl?: string | undefined; - /** - * The time the tool was last authorized in ISO format (ISO 8601). - */ - lastAuthorizedAt?: Date | undefined; -}; - -declare function authConfigFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AuthConfigStatus$ { - /** @deprecated use `AuthConfigStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AwaitingAuth: "AWAITING_AUTH"; - readonly Authorized: "AUTHORIZED"; - readonly AuthDisabled: "AUTH_DISABLED"; - }>; - /** @deprecated use `AuthConfigStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AwaitingAuth: "AWAITING_AUTH"; - readonly Authorized: "AUTHORIZED"; - readonly AuthDisabled: "AUTH_DISABLED"; - }>; -} - -/** @internal */ -declare const AuthConfigStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AuthConfigStatus$outboundSchema: z.ZodNativeEnum; - -/** - * Auth status of the tool. - */ -declare const AuthConfigStatus: { - readonly AwaitingAuth: "AWAITING_AUTH"; - readonly Authorized: "AUTHORIZED"; - readonly AuthDisabled: "AUTH_DISABLED"; -}; - -/** - * Auth status of the tool. - */ -declare type AuthConfigStatus = ClosedEnum; - -declare function authConfigToJSON(authConfig: AuthConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AuthConfigType$ { - /** @deprecated use `AuthConfigType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; - }>; - /** @deprecated use `AuthConfigType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; - }>; -} - -/** @internal */ -declare const AuthConfigType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AuthConfigType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ -declare const AuthConfigType: { - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; -}; - -/** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ -declare type AuthConfigType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Author$ { - /** @deprecated use `Author$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly User: "USER"; - readonly GleanAi: "GLEAN_AI"; - }>; - /** @deprecated use `Author$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly User: "USER"; - readonly GleanAi: "GLEAN_AI"; - }>; -} - -/** @internal */ -declare const Author$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Author$outboundSchema: z.ZodNativeEnum; - -declare const Author: { - readonly User: "USER"; - readonly GleanAi: "GLEAN_AI"; -}; - -declare type Author = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AuthToken$ { - /** @deprecated use `AuthToken$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AuthToken$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AuthToken$Outbound` instead. */ - type Outbound = AuthToken$Outbound; -} - -/** @internal */ -declare const AuthToken$inboundSchema: z.ZodType; - -/** @internal */ -declare type AuthToken$Outbound = { - accessToken: string; - datasource: string; - scope?: string | undefined; - tokenType?: string | undefined; - authUser?: string | undefined; - expiration?: number | undefined; -}; - -/** @internal */ -declare const AuthToken$outboundSchema: z.ZodType; - -declare type AuthToken = { - accessToken: string; - datasource: string; - scope?: string | undefined; - tokenType?: string | undefined; - /** - * Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin. - */ - authUser?: string | undefined; - /** - * Unix timestamp when this token expires (in seconds since epoch UTC). - */ - expiration?: number | undefined; -}; - -declare function authTokenFromJSON(jsonString: string): Result; - -declare function authTokenToJSON(authToken: AuthToken): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AuthType$ { - /** @deprecated use `AuthType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; - }>; - /** @deprecated use `AuthType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; - }>; -} - -/** @internal */ -declare const AuthType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AuthType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ -declare const AuthType: { - readonly None: "NONE"; - readonly OauthUser: "OAUTH_USER"; - readonly OauthAdmin: "OAUTH_ADMIN"; - readonly ApiKey: "API_KEY"; - readonly BasicAuth: "BASIC_AUTH"; - readonly Dwd: "DWD"; -}; - -/** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ -declare type AuthType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteRequest$ { - /** @deprecated use `AutocompleteRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AutocompleteRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AutocompleteRequest$Outbound` instead. */ - type Outbound = AutocompleteRequest$Outbound; -} - -/** @internal */ -declare const AutocompleteRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AutocompleteRequest$Outbound = { - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - query?: string | undefined; - datasourcesFilter?: Array | undefined; - datasource?: string | undefined; - resultTypes?: Array | undefined; - resultSize?: number | undefined; - authTokens?: Array | undefined; -}; - -/** @internal */ -declare const AutocompleteRequest$outboundSchema: z.ZodType; - -declare type AutocompleteRequest = { - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - /** - * Partially typed query. - */ - query?: string | undefined; - /** - * Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing. - */ - datasourcesFilter?: Array | undefined; - /** - * Filter to only return results relevant to the given datasource. - */ - datasource?: string | undefined; - /** - * Filter to only return results of the given type(s). All types may be returned if omitted. - */ - resultTypes?: Array | undefined; - /** - * Maximum number of results to be returned. If no value is provided, the backend will cap at 200. - * - * @remarks - */ - resultSize?: number | undefined; - /** - * Auth tokens which may be used for federated results. - */ - authTokens?: Array | undefined; -}; - -declare function autocompleteRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteRequestResultType$ { - /** @deprecated use `AutocompleteRequestResultType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; - }>; - /** @deprecated use `AutocompleteRequestResultType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; - }>; -} - -/** @internal */ -declare const AutocompleteRequestResultType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AutocompleteRequestResultType$outboundSchema: z.ZodNativeEnum; - -declare const AutocompleteRequestResultType: { - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; -}; - -declare type AutocompleteRequestResultType = ClosedEnum; - -declare function autocompleteRequestToJSON(autocompleteRequest: AutocompleteRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteResponse$ { - /** @deprecated use `AutocompleteResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResponse$Outbound` instead. */ - type Outbound = AutocompleteResponse$Outbound; -} - -/** @internal */ -declare const AutocompleteResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type AutocompleteResponse$Outbound = { - experimentIds?: Array | undefined; - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - results?: Array | undefined; - groups?: Array | undefined; - errorInfo?: GleanDataError$Outbound | undefined; - backendTimeMillis?: number | undefined; -}; - -/** @internal */ -declare const AutocompleteResponse$outboundSchema: z.ZodType; - -declare type AutocompleteResponse = { - /** - * List of experiment ids for the corresponding request. - */ - experimentIds?: Array | undefined; - /** - * An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - results?: Array | undefined; - /** - * Subsections of the results list from which distinct sections should be created. - */ - groups?: Array | undefined; - gleanDataError?: GleanDataError | undefined; - /** - * Time in milliseconds the backend took to respond to the request. - */ - backendTimeMillis?: number | undefined; -}; - -declare function autocompleteResponseFromJSON(jsonString: string): Result; - -declare function autocompleteResponseToJSON(autocompleteResponse: AutocompleteResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteResult$ { - /** @deprecated use `AutocompleteResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResult$Outbound` instead. */ - type Outbound = AutocompleteResult$Outbound; -} - -/** @internal */ -declare const AutocompleteResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type AutocompleteResult$Outbound = { - result: string; - keywords?: Array | undefined; - resultType?: string | undefined; - score?: number | undefined; - operatorMetadata?: OperatorMetadata$Outbound | undefined; - quicklink?: Quicklink$Outbound | undefined; - document?: Document$Outbound | undefined; - url?: string | undefined; - structuredResult?: StructuredResult$Outbound | undefined; - trackingToken?: string | undefined; - ranges?: Array | undefined; -}; - -/** @internal */ -declare const AutocompleteResult$outboundSchema: z.ZodType; - -declare type AutocompleteResult = { - result: string; - /** - * A list of all possible keywords for given result. - */ - keywords?: Array | undefined; - resultType?: AutocompleteResultResultType | undefined; - /** - * Higher indicates a more confident match. - */ - score?: number | undefined; - operatorMetadata?: OperatorMetadata | undefined; - /** - * An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - */ - quicklink?: Quicklink | undefined; - document?: Document_2 | undefined; - url?: string | undefined; - /** - * A single object that can support any object in the work graph. Only a single object will be populated. - */ - structuredResult?: StructuredResult | undefined; - /** - * A token to be passed in /feedback events associated with this autocomplete result. - */ - trackingToken?: string | undefined; - /** - * Subsections of the result string to which some special formatting should be applied (eg. bold) - */ - ranges?: Array | undefined; -}; - -declare function autocompleteResultFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteResultGroup$ { - /** @deprecated use `AutocompleteResultGroup$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResultGroup$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AutocompleteResultGroup$Outbound` instead. */ - type Outbound = AutocompleteResultGroup$Outbound; -} - -/** @internal */ -declare const AutocompleteResultGroup$inboundSchema: z.ZodType; - -/** @internal */ -declare type AutocompleteResultGroup$Outbound = { - startIndex?: number | undefined; - endIndex?: number | undefined; - title?: string | undefined; -}; - -/** @internal */ -declare const AutocompleteResultGroup$outboundSchema: z.ZodType; - -/** - * A subsection of the results list from which distinct sections should be created. - */ -declare type AutocompleteResultGroup = { - /** - * The inclusive start index of the range. - */ - startIndex?: number | undefined; - /** - * The exclusive end index of the range. - */ - endIndex?: number | undefined; - /** - * The title of the result group to be displayed. Empty means no title. - */ - title?: string | undefined; -}; - -declare function autocompleteResultGroupFromJSON(jsonString: string): Result; - -declare function autocompleteResultGroupToJSON(autocompleteResultGroup: AutocompleteResultGroup): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AutocompleteResultResultType$ { - /** @deprecated use `AutocompleteResultResultType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; - }>; - /** @deprecated use `AutocompleteResultResultType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; - }>; -} - -/** @internal */ -declare const AutocompleteResultResultType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AutocompleteResultResultType$outboundSchema: z.ZodNativeEnum; - -declare const AutocompleteResultResultType: { - readonly AdditionalDocument: "ADDITIONAL_DOCUMENT"; - readonly App: "APP"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Datasource: "DATASOURCE"; - readonly Document: "DOCUMENT"; - readonly Entity: "ENTITY"; - readonly Golink: "GOLINK"; - readonly History: "HISTORY"; - readonly NewChat: "NEW_CHAT"; - readonly Operator: "OPERATOR"; - readonly OperatorValue: "OPERATOR_VALUE"; - readonly Quicklink: "QUICKLINK"; - readonly Suggestion: "SUGGESTION"; -}; - -declare type AutocompleteResultResultType = ClosedEnum; - -declare function autocompleteResultToJSON(autocompleteResult: AutocompleteResult): string; - -declare type Awaitable = T | Promise; - -declare type Awaitable_2 = T | Promise; - -declare type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Badge$ { - /** @deprecated use `Badge$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Badge$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Badge$Outbound` instead. */ - type Outbound = Badge$Outbound; -} - -/** @internal */ -declare const Badge$inboundSchema: z.ZodType; - -/** @internal */ -declare type Badge$Outbound = { - key?: string | undefined; - displayName?: string | undefined; - iconConfig?: IconConfig$Outbound | undefined; - pinned?: boolean | undefined; -}; - -/** @internal */ -declare const Badge$outboundSchema: z.ZodType; - -/** - * Displays a user's accomplishment or milestone - */ -declare type Badge = { - /** - * An auto generated unique identifier. - */ - key?: string | undefined; - /** - * The badge name displayed to users - */ - displayName?: string | undefined; - /** - * Defines how to render an icon - */ - iconConfig?: IconConfig | undefined; - /** - * The badge should be shown on the PersonAttribution - */ - pinned?: boolean | undefined; -}; - -declare function badgeFromJSON(jsonString: string): Result; - -declare function badgeToJSON(badge: Badge): string; - -declare type BeforeCreateRequestContext = HookContext & {}; - -declare interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput; -} - -declare type BeforeRequestContext = HookContext & {}; - -declare type BeforeRequestHook = (req: Request) => Awaitable; - -declare interface BeforeRequestHook_2 { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable_2; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexDocumentsRequest$ { - /** @deprecated use `BulkIndexDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexDocumentsRequest$Outbound` instead. */ - type Outbound = BulkIndexDocumentsRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexDocumentsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - datasource: string; - documents: Array; - disableStaleDocumentDeletionCheck?: boolean | undefined; -}; - -/** @internal */ -declare const BulkIndexDocumentsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /bulkindexdocuments API call - */ -declare type BulkIndexDocumentsRequest = { - /** - * Unique id that must be used for this bulk upload instance - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * Datasource of the documents - */ - datasource: string; - /** - * Batch of documents for the datasource - */ - documents: Array; - /** - * True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when `isLastPage = true` - */ - disableStaleDocumentDeletionCheck?: boolean | undefined; -}; - -declare function bulkIndexDocumentsRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexDocumentsRequestToJSON(bulkIndexDocumentsRequest: BulkIndexDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexEmployeesRequest$ { - /** @deprecated use `BulkIndexEmployeesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexEmployeesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexEmployeesRequest$Outbound` instead. */ - type Outbound = BulkIndexEmployeesRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexEmployeesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexEmployeesRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - employees: Array; - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -/** @internal */ -declare const BulkIndexEmployeesRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /bulkindexemployees API call - */ -declare type BulkIndexEmployeesRequest = { - /** - * Unique id that must be used for this bulk upload instance - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * Batch of employee information - */ - employees: Array; - /** - * True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when `isLastPage = true` - */ - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -declare function bulkIndexEmployeesRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexEmployeesRequestToJSON(bulkIndexEmployeesRequest: BulkIndexEmployeesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexGroupsRequest$ { - /** @deprecated use `BulkIndexGroupsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexGroupsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexGroupsRequest$Outbound` instead. */ - type Outbound = BulkIndexGroupsRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexGroupsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexGroupsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - datasource: string; - groups: Array; - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -/** @internal */ -declare const BulkIndexGroupsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body for the /bulkindexgroups API call - */ -declare type BulkIndexGroupsRequest = { - /** - * Unique id that must be used for this instance of datasource groups upload - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * datasource of the groups - */ - datasource: string; - /** - * batch of groups for the datasource - */ - groups: Array; - /** - * True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - */ - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -declare function bulkIndexGroupsRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexGroupsRequestToJSON(bulkIndexGroupsRequest: BulkIndexGroupsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexMembershipsRequest$ { - /** @deprecated use `BulkIndexMembershipsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexMembershipsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexMembershipsRequest$Outbound` instead. */ - type Outbound = BulkIndexMembershipsRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexMembershipsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexMembershipsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - datasource: string; - group?: string | undefined; - memberships: Array; -}; - -/** @internal */ -declare const BulkIndexMembershipsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body for the /bulkindexmemberships API call - */ -declare type BulkIndexMembershipsRequest = { - /** - * Unique id that must be used for this instance of datasource group memberships upload - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * datasource of the memberships - */ - datasource: string; - /** - * group who's memberships are specified - */ - group?: string | undefined; - /** - * batch of memberships for the group - */ - memberships: Array; -}; - -declare function bulkIndexMembershipsRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexMembershipsRequestToJSON(bulkIndexMembershipsRequest: BulkIndexMembershipsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexShortcutsRequest$ { - /** @deprecated use `BulkIndexShortcutsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexShortcutsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexShortcutsRequest$Outbound` instead. */ - type Outbound = BulkIndexShortcutsRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexShortcutsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexShortcutsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - shortcuts: Array; -}; - -/** @internal */ -declare const BulkIndexShortcutsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /bulkindexshortcuts API call - */ -declare type BulkIndexShortcutsRequest = { - /** - * Unique id that must be used for this bulk upload instance - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * Batch of shortcuts information - */ - shortcuts: Array; -}; - -declare function bulkIndexShortcutsRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexShortcutsRequestToJSON(bulkIndexShortcutsRequest: BulkIndexShortcutsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexTeamsRequest$ { - /** @deprecated use `BulkIndexTeamsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexTeamsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexTeamsRequest$Outbound` instead. */ - type Outbound = BulkIndexTeamsRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexTeamsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexTeamsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - teams: Array; -}; - -/** @internal */ -declare const BulkIndexTeamsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /bulkindexteams API call - */ -declare type BulkIndexTeamsRequest = { - /** - * Unique id that must be used for this bulk upload instance - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * Batch of team information - */ - teams: Array; -}; - -declare function bulkIndexTeamsRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexTeamsRequestToJSON(bulkIndexTeamsRequest: BulkIndexTeamsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkIndexUsersRequest$ { - /** @deprecated use `BulkIndexUsersRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkIndexUsersRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkIndexUsersRequest$Outbound` instead. */ - type Outbound = BulkIndexUsersRequest$Outbound; -} - -/** @internal */ -declare const BulkIndexUsersRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkIndexUsersRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - datasource: string; - users: Array; - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -/** @internal */ -declare const BulkIndexUsersRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body for the /bulkindexusers API call - */ -declare type BulkIndexUsersRequest = { - /** - * Unique id that must be used for this instance of datasource users upload - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * datasource of the users - */ - datasource: string; - /** - * batch of users for the datasource - */ - users: Array; - /** - * True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - */ - disableStaleDataDeletionCheck?: boolean | undefined; -}; - -declare function bulkIndexUsersRequestFromJSON(jsonString: string): Result; - -declare function bulkIndexUsersRequestToJSON(bulkIndexUsersRequest: BulkIndexUsersRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkUploadHistoryEvent$ { - /** @deprecated use `BulkUploadHistoryEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BulkUploadHistoryEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BulkUploadHistoryEvent$Outbound` instead. */ - type Outbound = BulkUploadHistoryEvent$Outbound; -} - -/** @internal */ -declare const BulkUploadHistoryEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type BulkUploadHistoryEvent$Outbound = { - uploadId?: string | undefined; - startTime?: string | undefined; - endTime?: string | undefined; - status?: string | undefined; - processingState?: string | undefined; -}; - -/** @internal */ -declare const BulkUploadHistoryEvent$outboundSchema: z.ZodType; - -/** - * Information about a successful bulk upload - */ -declare type BulkUploadHistoryEvent = { - /** - * The unique ID of the upload - */ - uploadId?: string | undefined; - /** - * The start time of the upload in ISO 8601 format - */ - startTime?: string | undefined; - /** - * The end time of the upload in ISO 8601 format, 'NA' if the upload is still active - */ - endTime?: string | undefined; - /** - * The status of the upload, an enum of ACTIVE, SUCCESSFUL - */ - status?: BulkUploadHistoryEventStatus | undefined; - /** - * The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED - */ - processingState?: ProcessingState | undefined; -}; - -declare function bulkUploadHistoryEventFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BulkUploadHistoryEventStatus$ { - /** @deprecated use `BulkUploadHistoryEventStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Active: "ACTIVE"; - readonly Successful: "SUCCESSFUL"; - }>; - /** @deprecated use `BulkUploadHistoryEventStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Active: "ACTIVE"; - readonly Successful: "SUCCESSFUL"; - }>; -} - -/** @internal */ -declare const BulkUploadHistoryEventStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BulkUploadHistoryEventStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The status of the upload, an enum of ACTIVE, SUCCESSFUL - */ -declare const BulkUploadHistoryEventStatus: { - readonly Active: "ACTIVE"; - readonly Successful: "SUCCESSFUL"; -}; - -/** - * The status of the upload, an enum of ACTIVE, SUCCESSFUL - */ -declare type BulkUploadHistoryEventStatus = ClosedEnum; - -declare function bulkUploadHistoryEventToJSON(bulkUploadHistoryEvent: BulkUploadHistoryEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CalendarAttendee$ { - /** @deprecated use `CalendarAttendee$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CalendarAttendee$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CalendarAttendee$Outbound` instead. */ - type Outbound = CalendarAttendee$Outbound; -} - -/** @internal */ -declare const CalendarAttendee$inboundSchema: z.ZodType; - -/** @internal */ -declare type CalendarAttendee$Outbound = { - isOrganizer?: boolean | undefined; - isInGroup?: boolean | undefined; - person: Person$Outbound; - groupAttendees?: Array | undefined; - responseStatus?: string | undefined; -}; - -/** @internal */ -declare const CalendarAttendee$outboundSchema: z.ZodType; - -declare type CalendarAttendee = { - /** - * Whether or not this attendee is an organizer. - */ - isOrganizer?: boolean | undefined; - /** - * Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility. - */ - isInGroup?: boolean | undefined; - person: Person; - /** - * If this attendee is a group, represents the list of individual attendees in the group. - */ - groupAttendees?: Array | undefined; - responseStatus?: ResponseStatus | undefined; -}; - -declare function calendarAttendeeFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CalendarAttendees$ { - /** @deprecated use `CalendarAttendees$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CalendarAttendees$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CalendarAttendees$Outbound` instead. */ - type Outbound = CalendarAttendees$Outbound; -} - -/** @internal */ -declare const CalendarAttendees$inboundSchema: z.ZodType; - -/** @internal */ -declare type CalendarAttendees$Outbound = { - people?: Array | undefined; - isLimit?: boolean | undefined; - total?: number | undefined; - numAccepted?: number | undefined; - numDeclined?: number | undefined; - numNoResponse?: number | undefined; - numTentative?: number | undefined; -}; - -/** @internal */ -declare const CalendarAttendees$outboundSchema: z.ZodType; - -declare type CalendarAttendees = { - /** - * Full details of some of the attendees of this event - */ - people?: Array | undefined; - /** - * Whether the total count of the people returned is at the retrieval limit. - */ - isLimit?: boolean | undefined; - /** - * Total number of attendees in this event. - */ - total?: number | undefined; - /** - * Total number of attendees who have accepted this event. - */ - numAccepted?: number | undefined; - /** - * Total number of attendees who have declined this event. - */ - numDeclined?: number | undefined; - /** - * Total number of attendees who have not responded to this event. - */ - numNoResponse?: number | undefined; - /** - * Total number of attendees who have responded tentatively (i.e. responded maybe) to this event. - */ - numTentative?: number | undefined; -}; - -declare function calendarAttendeesFromJSON(jsonString: string): Result; - -declare function calendarAttendeesToJSON(calendarAttendees: CalendarAttendees): string; - -declare function calendarAttendeeToJSON(calendarAttendee: CalendarAttendee): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CalendarEvent$ { - /** @deprecated use `CalendarEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CalendarEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CalendarEvent$Outbound` instead. */ - type Outbound = CalendarEvent$Outbound; -} - -/** @internal */ -declare const CalendarEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type CalendarEvent$Outbound = { - time?: TimeInterval$Outbound | undefined; - eventType?: string | undefined; - id: string; - url: string; - attendees?: CalendarAttendees$Outbound | undefined; - location?: string | undefined; - conferenceData?: ConferenceData$Outbound | undefined; - description?: string | undefined; - datasource?: string | undefined; - hasTranscript?: boolean | undefined; - transcriptUrl?: string | undefined; - classifications?: Array | undefined; - generatedAttachments?: Array | undefined; -}; - -/** @internal */ -declare const CalendarEvent$outboundSchema: z.ZodType; - -/** - * A generic, light-weight calendar event. - */ -declare type CalendarEvent = { - time?: TimeInterval | undefined; - /** - * The nature of the event, for example "out of office". - */ - eventType?: CalendarEventEventType | undefined; - /** - * The calendar event id - */ - id: string; - /** - * A permalink for this calendar event - */ - url: string; - attendees?: CalendarAttendees | undefined; - /** - * The location that this event is taking place at. - */ - location?: string | undefined; - conferenceData?: ConferenceData | undefined; - /** - * The HTML description of the event. - */ - description?: string | undefined; - /** - * The app or other repository type from which the event was extracted - */ - datasource?: string | undefined; - /** - * The event has a transcript associated with it enabling features like summarization - */ - hasTranscript?: boolean | undefined; - /** - * A link to the transcript of the event - */ - transcriptUrl?: string | undefined; - classifications?: Array | undefined; - generatedAttachments?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CalendarEventEventType$ { - /** @deprecated use `CalendarEventEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; - }>; - /** @deprecated use `CalendarEventEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; - }>; -} - -/** @internal */ -declare const CalendarEventEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CalendarEventEventType$outboundSchema: z.ZodNativeEnum; - -/** - * The nature of the event, for example "out of office". - */ -declare const CalendarEventEventType: { - readonly Default: "DEFAULT"; - readonly OutOfOffice: "OUT_OF_OFFICE"; -}; - -/** - * The nature of the event, for example "out of office". - */ -declare type CalendarEventEventType = ClosedEnum; - -declare function calendarEventFromJSON(jsonString: string): Result; - -declare function calendarEventToJSON(calendarEvent: CalendarEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CanonicalizingRegexType$ { - /** @deprecated use `CanonicalizingRegexType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CanonicalizingRegexType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CanonicalizingRegexType$Outbound` instead. */ - type Outbound = CanonicalizingRegexType$Outbound; -} - -/** @internal */ -declare const CanonicalizingRegexType$inboundSchema: z.ZodType; - -/** @internal */ -declare type CanonicalizingRegexType$Outbound = { - matchRegex?: string | undefined; - rewriteRegex?: string | undefined; -}; - -/** @internal */ -declare const CanonicalizingRegexType$outboundSchema: z.ZodType; - -/** - * Regular expression to apply to an arbitrary string to transform it into a canonical string. - */ -declare type CanonicalizingRegexType = { - /** - * Regular expression to match to an arbitrary string. - */ - matchRegex?: string | undefined; - /** - * Regular expression to transform into a canonical string. - */ - rewriteRegex?: string | undefined; -}; - -declare function canonicalizingRegexTypeFromJSON(jsonString: string): Result; - -declare function canonicalizingRegexTypeToJSON(canonicalizingRegexType: CanonicalizingRegexType): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CategoryToResultSize$ { - /** @deprecated use `CategoryToResultSize$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CategoryToResultSize$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CategoryToResultSize$Outbound` instead. */ - type Outbound = CategoryToResultSize$Outbound; -} - -/** @internal */ -declare const CategoryToResultSize$inboundSchema: z.ZodType; - -/** @internal */ -declare type CategoryToResultSize$Outbound = { - resultSize?: number | undefined; -}; - -/** @internal */ -declare const CategoryToResultSize$outboundSchema: z.ZodType; - -declare type CategoryToResultSize = { - resultSize?: number | undefined; -}; - -declare function categoryToResultSizeFromJSON(jsonString: string): Result; - -declare function categoryToResultSizeToJSON(categoryToResultSize: CategoryToResultSize): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChannelInviteInfo$ { - /** @deprecated use `ChannelInviteInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChannelInviteInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChannelInviteInfo$Outbound` instead. */ - type Outbound = ChannelInviteInfo$Outbound; -} - -/** @internal */ -declare const ChannelInviteInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChannelInviteInfo$Outbound = { - channel?: string | undefined; - isAutoInvite?: boolean | undefined; - inviter?: Person$Outbound | undefined; - inviteTime?: string | undefined; - reminderTime?: string | undefined; -}; - -/** @internal */ -declare const ChannelInviteInfo$outboundSchema: z.ZodType; - -/** - * Information regarding the invite status of a person for a particular channel. - */ -declare type ChannelInviteInfo = { - channel?: CommunicationChannel | undefined; - /** - * Bit that tracks if this invite was automatically sent or user-sent - */ - isAutoInvite?: boolean | undefined; - inviter?: Person | undefined; - /** - * The time this person was invited in ISO format (ISO 8601). - */ - inviteTime?: Date | undefined; - /** - * The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - */ - reminderTime?: Date | undefined; -}; - -declare function channelInviteInfoFromJSON(jsonString: string): Result; - -declare function channelInviteInfoToJSON(channelInviteInfo: ChannelInviteInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Chat$ { - /** @deprecated use `Chat$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Chat$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Chat$Outbound` instead. */ - type Outbound = Chat$Outbound; -} - -/** @internal */ -declare const Chat$inboundSchema: z.ZodType; - -/** @internal */ -declare type Chat$Outbound = { - id?: string | undefined; - createTime?: number | undefined; - createdBy?: Person$Outbound | undefined; - updateTime?: number | undefined; - name?: string | undefined; - applicationId?: string | undefined; - applicationName?: string | undefined; - icon?: IconConfig$Outbound | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - messages?: Array | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const Chat$outboundSchema: z.ZodType; - -/** - * A historical representation of a series of chat messages a user had with Glean Assistant. - */ -declare type Chat = { - /** - * The opaque id of the Chat. - */ - id?: string | undefined; - /** - * Server Unix timestamp of the creation time (in seconds since epoch UTC). - */ - createTime?: number | undefined; - createdBy?: Person | undefined; - /** - * Server Unix timestamp of the update time (in seconds since epoch UTC). - */ - updateTime?: number | undefined; - /** - * The name of the Chat. - */ - name?: string | undefined; - /** - * The ID of the AI App that this Chat is associated to. - */ - applicationId?: string | undefined; - /** - * The display name of the AI App that this Chat is associated to. - */ - applicationName?: string | undefined; - /** - * Defines how to render an icon - */ - icon?: IconConfig | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The chat messages within a Chat. - */ - messages?: Array | undefined; - /** - * A list of roles for this Chat. - */ - roles?: Array | undefined; -}; - -declare class Chat_2 extends ClientSDK { - /** - * Chat - * - * @remarks - * Have a conversation with Glean AI. - */ - create(chatRequest: components.ChatRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Deletes all saved Chats owned by a user - * - * @remarks - * Deletes all saved Chats a user has had and all their contained conversational content. - */ - deleteAll(timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Deletes saved Chats - * - * @remarks - * Deletes saved Chats and all their contained conversational content. - */ - delete(deleteChatsRequest: components.DeleteChatsRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Retrieves a Chat - * - * @remarks - * Retrieves the chat history between Glean Assistant and the user for a given Chat. - */ - retrieve(getChatRequest: components.GetChatRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Retrieves all saved Chats - * - * @remarks - * Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content. - */ - list(timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Gets the metadata for a custom Chat application - * - * @remarks - * Gets the Chat application details for the specified application ID. - */ - retrieveApplication(getChatApplicationRequest: components.GetChatApplicationRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Upload files for Chat. - * - * @remarks - * Upload files for Chat. - */ - uploadFiles(uploadChatFilesRequest: components.UploadChatFilesRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Get files uploaded by a user for Chat. - * - * @remarks - * Get files uploaded by a user for Chat. - */ - retrieveFiles(getChatFilesRequest: components.GetChatFilesRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Delete files uploaded by a user for chat. - * - * @remarks - * Delete files uploaded by a user for Chat. - */ - deleteFiles(deleteChatFilesRequest: components.DeleteChatFilesRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; - /** - * Chat - * - * @remarks - * Have a conversation with Glean AI. - */ - createStream(chatRequest: components.ChatRequest, timezoneOffset?: number | undefined, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatFile$ { - /** @deprecated use `ChatFile$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatFile$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatFile$Outbound` instead. */ - type Outbound = ChatFile$Outbound; -} - -/** @internal */ -declare const ChatFile$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatFile$Outbound = { - id?: string | undefined; - url?: string | undefined; - name?: string | undefined; - metadata?: ChatFileMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const ChatFile$outboundSchema: z.ZodType; - -/** - * Structure for file uploaded by a user for Chat. - */ -declare type ChatFile = { - /** - * Unique identifier of the file. - */ - id?: string | undefined; - /** - * Url of the file. - */ - url?: string | undefined; - /** - * Name of the uploaded file. - */ - name?: string | undefined; - /** - * Metadata of a file uploaded by a user for Chat. - */ - metadata?: ChatFileMetadata | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatFileFailureReason$ { - /** @deprecated use `ChatFileFailureReason$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ParseFailed: "PARSE_FAILED"; - readonly AvScanFailed: "AV_SCAN_FAILED"; - readonly FileTooSmall: "FILE_TOO_SMALL"; - readonly FileTooLarge: "FILE_TOO_LARGE"; - readonly FileExtensionUnsupported: "FILE_EXTENSION_UNSUPPORTED"; - readonly FileMetadataValidationFail: "FILE_METADATA_VALIDATION_FAIL"; - readonly FileProcessingTimedOut: "FILE_PROCESSING_TIMED_OUT"; - }>; - /** @deprecated use `ChatFileFailureReason$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ParseFailed: "PARSE_FAILED"; - readonly AvScanFailed: "AV_SCAN_FAILED"; - readonly FileTooSmall: "FILE_TOO_SMALL"; - readonly FileTooLarge: "FILE_TOO_LARGE"; - readonly FileExtensionUnsupported: "FILE_EXTENSION_UNSUPPORTED"; - readonly FileMetadataValidationFail: "FILE_METADATA_VALIDATION_FAIL"; - readonly FileProcessingTimedOut: "FILE_PROCESSING_TIMED_OUT"; - }>; -} - -/** @internal */ -declare const ChatFileFailureReason$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ChatFileFailureReason$outboundSchema: z.ZodNativeEnum; - -/** - * Reason for failed status. - */ -declare const ChatFileFailureReason: { - readonly ParseFailed: "PARSE_FAILED"; - readonly AvScanFailed: "AV_SCAN_FAILED"; - readonly FileTooSmall: "FILE_TOO_SMALL"; - readonly FileTooLarge: "FILE_TOO_LARGE"; - readonly FileExtensionUnsupported: "FILE_EXTENSION_UNSUPPORTED"; - readonly FileMetadataValidationFail: "FILE_METADATA_VALIDATION_FAIL"; - readonly FileProcessingTimedOut: "FILE_PROCESSING_TIMED_OUT"; -}; - -/** - * Reason for failed status. - */ -declare type ChatFileFailureReason = ClosedEnum; - -declare function chatFileFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatFileMetadata$ { - /** @deprecated use `ChatFileMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatFileMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatFileMetadata$Outbound` instead. */ - type Outbound = ChatFileMetadata$Outbound; -} - -/** @internal */ -declare const ChatFileMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatFileMetadata$Outbound = { - status?: string | undefined; - uploadTime?: number | undefined; - processedSize?: number | undefined; - failureReason?: string | undefined; - mimeType?: string | undefined; -}; - -/** @internal */ -declare const ChatFileMetadata$outboundSchema: z.ZodType; - -/** - * Metadata of a file uploaded by a user for Chat. - */ -declare type ChatFileMetadata = { - /** - * Current status of the file. - */ - status?: ChatFileStatus | undefined; - /** - * Upload time, in epoch seconds. - */ - uploadTime?: number | undefined; - /** - * Size of the processed file in bytes. - */ - processedSize?: number | undefined; - /** - * Reason for failed status. - */ - failureReason?: ChatFileFailureReason | undefined; - /** - * MIME type of the file. - */ - mimeType?: string | undefined; -}; - -declare function chatFileMetadataFromJSON(jsonString: string): Result; - -declare function chatFileMetadataToJSON(chatFileMetadata: ChatFileMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatFileStatus$ { - /** @deprecated use `ChatFileStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Processing: "PROCESSING"; - readonly Processed: "PROCESSED"; - readonly Failed: "FAILED"; - readonly Deleted: "DELETED"; - }>; - /** @deprecated use `ChatFileStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Processing: "PROCESSING"; - readonly Processed: "PROCESSED"; - readonly Failed: "FAILED"; - readonly Deleted: "DELETED"; - }>; -} - -/** @internal */ -declare const ChatFileStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ChatFileStatus$outboundSchema: z.ZodNativeEnum; - -/** - * Current status of the file. - */ -declare const ChatFileStatus: { - readonly Processing: "PROCESSING"; - readonly Processed: "PROCESSED"; - readonly Failed: "FAILED"; - readonly Deleted: "DELETED"; -}; - -/** - * Current status of the file. - */ -declare type ChatFileStatus = ClosedEnum; - -declare function chatFileToJSON(chatFile: ChatFile): string; - -declare function chatFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatMessage$ { - /** @deprecated use `ChatMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatMessage$Outbound` instead. */ - type Outbound = ChatMessage$Outbound; -} - -/** @internal */ -declare const ChatMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatMessage$Outbound = { - agentConfig?: AgentConfig$Outbound | undefined; - author: string; - citations?: Array | undefined; - uploadedFileIds?: Array | undefined; - fragments?: Array | undefined; - ts?: string | undefined; - messageId?: string | undefined; - messageTrackingToken?: string | undefined; - messageType: string; - hasMoreFragments?: boolean | undefined; -}; - -/** @internal */ -declare const ChatMessage$outboundSchema: z.ZodType; - -/** - * A message that is rendered as one coherent unit with one given sender. - */ -declare type ChatMessage = { - /** - * Describes the agent that executes the request. - */ - agentConfig?: AgentConfig | undefined; - author?: Author | undefined; - /** - * A list of Citations that were used to generate the response. - */ - citations?: Array | undefined; - /** - * IDs of files uploaded in the message that are referenced to generate the answer. - */ - uploadedFileIds?: Array | undefined; - /** - * A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - */ - fragments?: Array | undefined; - /** - * Response timestamp of the message. - */ - ts?: string | undefined; - /** - * A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - */ - messageId?: string | undefined; - /** - * Opaque tracking token generated server-side. - */ - messageTrackingToken?: string | undefined; - /** - * Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - */ - messageType?: MessageType | undefined; - /** - * Signals there are additional response fragments incoming. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - hasMoreFragments?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatMessageCitation$ { - /** @deprecated use `ChatMessageCitation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatMessageCitation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatMessageCitation$Outbound` instead. */ - type Outbound = ChatMessageCitation$Outbound; -} - -/** @internal */ -declare const ChatMessageCitation$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatMessageCitation$Outbound = { - trackingToken?: string | undefined; - sourceDocument?: Document$Outbound | undefined; - sourceFile?: ChatFile$Outbound | undefined; - sourcePerson?: Person$Outbound | undefined; - referenceRanges?: Array | undefined; -}; - -/** @internal */ -declare const ChatMessageCitation$outboundSchema: z.ZodType; - -/** - * Information about the source for a ChatMessage. - */ -declare type ChatMessageCitation = { - /** - * An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - sourceDocument?: Document_2 | undefined; - /** - * Structure for file uploaded by a user for Chat. - */ - sourceFile?: ChatFile | undefined; - sourcePerson?: Person | undefined; - /** - * Each reference range and its corresponding snippets - */ - referenceRanges?: Array | undefined; -}; - -declare function chatMessageCitationFromJSON(jsonString: string): Result; - -declare function chatMessageCitationToJSON(chatMessageCitation: ChatMessageCitation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatMessageFragment$ { - /** @deprecated use `ChatMessageFragment$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatMessageFragment$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatMessageFragment$Outbound` instead. */ - type Outbound = ChatMessageFragment$Outbound; -} - -/** @internal */ -declare const ChatMessageFragment$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatMessageFragment$Outbound = { - structuredResults?: Array | undefined; - trackingToken?: string | undefined; - text?: string | undefined; - querySuggestion?: QuerySuggestion$Outbound | undefined; - file?: ChatFile$Outbound | undefined; - action?: ToolInfo$Outbound | undefined; - citation?: ChatMessageCitation$Outbound | undefined; -}; - -/** @internal */ -declare const ChatMessageFragment$outboundSchema: z.ZodType; - -/** - * Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation or file. - */ -declare type ChatMessageFragment = { - /** - * An array of entities in the work graph retrieved via a data request. - */ - structuredResults?: Array | undefined; - /** - * An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - text?: string | undefined; - querySuggestion?: QuerySuggestion | undefined; - /** - * Structure for file uploaded by a user for Chat. - */ - file?: ChatFile | undefined; - action?: ToolInfo | undefined; - /** - * Information about the source for a ChatMessage. - */ - citation?: ChatMessageCitation | undefined; -}; - -declare function chatMessageFragmentFromJSON(jsonString: string): Result; - -declare function chatMessageFragmentToJSON(chatMessageFragment: ChatMessageFragment): string; - -declare function chatMessageFromJSON(jsonString: string): Result; - -declare function chatMessageToJSON(chatMessage: ChatMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatMetadata$ { - /** @deprecated use `ChatMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatMetadata$Outbound` instead. */ - type Outbound = ChatMetadata$Outbound; -} - -/** @internal */ -declare const ChatMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatMetadata$Outbound = { - id?: string | undefined; - createTime?: number | undefined; - createdBy?: Person$Outbound | undefined; - updateTime?: number | undefined; - name?: string | undefined; - applicationId?: string | undefined; - applicationName?: string | undefined; - icon?: IconConfig$Outbound | undefined; -}; - -/** @internal */ -declare const ChatMetadata$outboundSchema: z.ZodType; - -/** - * Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - */ -declare type ChatMetadata = { - /** - * The opaque id of the Chat. - */ - id?: string | undefined; - /** - * Server Unix timestamp of the creation time (in seconds since epoch UTC). - */ - createTime?: number | undefined; - createdBy?: Person | undefined; - /** - * Server Unix timestamp of the update time (in seconds since epoch UTC). - */ - updateTime?: number | undefined; - /** - * The name of the Chat. - */ - name?: string | undefined; - /** - * The ID of the AI App that this Chat is associated to. - */ - applicationId?: string | undefined; - /** - * The display name of the AI App that this Chat is associated to. - */ - applicationName?: string | undefined; - /** - * Defines how to render an icon - */ - icon?: IconConfig | undefined; -}; - -declare function chatMetadataFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatMetadataResult$ { - /** @deprecated use `ChatMetadataResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatMetadataResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatMetadataResult$Outbound` instead. */ - type Outbound = ChatMetadataResult$Outbound; -} - -/** @internal */ -declare const ChatMetadataResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatMetadataResult$Outbound = { - chat?: ChatMetadata$Outbound | undefined; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const ChatMetadataResult$outboundSchema: z.ZodType; - -declare type ChatMetadataResult = { - /** - * Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - */ - chat?: ChatMetadata | undefined; - /** - * An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - */ - trackingToken?: string | undefined; -}; - -declare function chatMetadataResultFromJSON(jsonString: string): Result; - -declare function chatMetadataResultToJSON(chatMetadataResult: ChatMetadataResult): string; - -declare function chatMetadataToJSON(chatMetadata: ChatMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatRequest$ { - /** @deprecated use `ChatRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatRequest$Outbound` instead. */ - type Outbound = ChatRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatRequest$_2 { - /** @deprecated use `ChatRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatRequest$Outbound` instead. */ - type Outbound = ChatRequest$Outbound_2; -} - -/** @internal */ -declare const ChatRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const ChatRequest$inboundSchema_2: z.ZodType; - -/** @internal */ -declare type ChatRequest$Outbound = { - saveChat?: boolean | undefined; - chatId?: string | undefined; - messages: Array; - agentConfig?: AgentConfig$Outbound | undefined; - inclusions?: ChatRestrictionFilters$Outbound | undefined; - exclusions?: ChatRestrictionFilters$Outbound | undefined; - timeoutMillis?: number | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - applicationId?: string | undefined; - agentId?: string | undefined; - stream?: boolean | undefined; -}; - -/** @internal */ -declare type ChatRequest$Outbound_2 = { - timezoneOffset?: number | undefined; - ChatRequest: components.ChatRequest$Outbound; -}; - -/** @internal */ -declare const ChatRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const ChatRequest$outboundSchema_2: z.ZodType; - -declare type ChatRequest = { - /** - * Save the current interaction as a Chat for the user to access and potentially continue later. - */ - saveChat?: boolean | undefined; - /** - * The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true. - */ - chatId?: string | undefined; - /** - * A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - */ - messages: Array; - /** - * Describes the agent that executes the request. - */ - agentConfig?: AgentConfig | undefined; - inclusions?: ChatRestrictionFilters | undefined; - exclusions?: ChatRestrictionFilters | undefined; - /** - * Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - */ - timeoutMillis?: number | undefined; - sessionInfo?: SessionInfo | undefined; - /** - * The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used. - */ - applicationId?: string | undefined; - /** - * The ID of the Agent that should process this chat request. Only Agents with trigger set to 'User chat message' are invokable through this API. If not specified, the default chat experience will be used. - */ - agentId?: string | undefined; - /** - * If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be. - */ - stream?: boolean | undefined; -}; - -declare type ChatRequest_2 = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * Includes chat history for Glean AI to respond to. - */ - chatRequest: components.ChatRequest; -}; - -declare function chatRequestFromJSON(jsonString: string): Result; - -declare function chatRequestFromJSON_2(jsonString: string): Result; - -declare function chatRequestToJSON(chatRequest: ChatRequest): string; - -declare function chatRequestToJSON_2(chatRequest: ChatRequest_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatResponse$ { - /** @deprecated use `ChatResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatResponse$Outbound` instead. */ - type Outbound = ChatResponse$Outbound; -} - -/** @internal */ -declare const ChatResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatResponse$Outbound = { - messages?: Array | undefined; - chatId?: string | undefined; - followUpPrompts?: Array | undefined; - backendTimeMillis?: number | undefined; - chatSessionTrackingToken?: string | undefined; -}; - -/** @internal */ -declare const ChatResponse$outboundSchema: z.ZodType; - -/** - * A single response from the /chat backend. - */ -declare type ChatResponse = { - messages?: Array | undefined; - /** - * The id of the associated Chat the messages belong to, if one exists. - */ - chatId?: string | undefined; - /** - * Follow-up prompts for the user to potentially use - */ - followUpPrompts?: Array | undefined; - /** - * Time in milliseconds the backend took to respond to the request. - */ - backendTimeMillis?: number | undefined; - /** - * A token that is used to track the session. - */ - chatSessionTrackingToken?: string | undefined; -}; - -declare function chatResponseFromJSON(jsonString: string): Result; - -declare function chatResponseToJSON(chatResponse: ChatResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatRestrictionFilters$ { - /** @deprecated use `ChatRestrictionFilters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatRestrictionFilters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatRestrictionFilters$Outbound` instead. */ - type Outbound = ChatRestrictionFilters$Outbound; -} - -/** @internal */ -declare const ChatRestrictionFilters$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatRestrictionFilters$Outbound = { - containerSpecs?: Array | undefined; - documentSpecs?: Array | undefined; - datasourceInstances?: Array | undefined; -}; - -/** @internal */ -declare const ChatRestrictionFilters$outboundSchema: z.ZodType; - -declare type ChatRestrictionFilters = { - /** - * Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - */ - containerSpecs?: Array | undefined; - documentSpecs?: Array | undefined; - datasourceInstances?: Array | undefined; -}; - -declare function chatRestrictionFiltersFromJSON(jsonString: string): Result; - -declare function chatRestrictionFiltersToJSON(chatRestrictionFilters: ChatRestrictionFilters): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatResult$ { - /** @deprecated use `ChatResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatResult$Outbound` instead. */ - type Outbound = ChatResult$Outbound; -} - -/** @internal */ -declare const ChatResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatResult$Outbound = { - chat?: Chat$Outbound | undefined; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const ChatResult$outboundSchema: z.ZodType; - -declare type ChatResult = { - /** - * A historical representation of a series of chat messages a user had with Glean Assistant. - */ - chat?: Chat | undefined; - /** - * An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - */ - trackingToken?: string | undefined; -}; - -declare function chatResultFromJSON(jsonString: string): Result; - -declare function chatResultToJSON(chatResult: ChatResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatStreamRequest$ { - /** @deprecated use `ChatStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatStreamRequest$Outbound` instead. */ - type Outbound = ChatStreamRequest$Outbound; -} - -/** @internal */ -declare const ChatStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatStreamRequest$Outbound = { - timezoneOffset?: number | undefined; - ChatRequest: components.ChatRequest$Outbound; -}; - -/** @internal */ -declare const ChatStreamRequest$outboundSchema: z.ZodType; - -declare type ChatStreamRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * Includes chat history for Glean AI to respond to. - */ - chatRequest: components.ChatRequest; -}; - -declare function chatStreamRequestFromJSON(jsonString: string): Result; - -declare function chatStreamRequestToJSON(chatStreamRequest: ChatStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatSuggestion$ { - /** @deprecated use `ChatSuggestion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatSuggestion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatSuggestion$Outbound` instead. */ - type Outbound = ChatSuggestion$Outbound; -} - -/** @internal */ -declare const ChatSuggestion$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatSuggestion$Outbound = { - query?: string | undefined; - feature?: string | undefined; -}; - -/** @internal */ -declare const ChatSuggestion$outboundSchema: z.ZodType; - -declare type ChatSuggestion = { - /** - * The actionable chat query to run when the user selects this suggestion. - */ - query?: string | undefined; - /** - * Targeted Glean Chat feature for the suggestion. - */ - feature?: string | undefined; -}; - -declare function chatSuggestionFromJSON(jsonString: string): Result; - -declare function chatSuggestionToJSON(chatSuggestion: ChatSuggestion): string; - -declare function chatToJSON(chat: Chat): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatZeroStateSuggestionOptions$ { - /** @deprecated use `ChatZeroStateSuggestionOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatZeroStateSuggestionOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatZeroStateSuggestionOptions$Outbound` instead. */ - type Outbound = ChatZeroStateSuggestionOptions$Outbound; -} - -/** @internal */ -declare const ChatZeroStateSuggestionOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatZeroStateSuggestionOptions$Outbound = { - applicationId?: string | undefined; -}; - -/** @internal */ -declare const ChatZeroStateSuggestionOptions$outboundSchema: z.ZodType; - -declare type ChatZeroStateSuggestionOptions = { - /** - * The Chat Application ID this feed request should be scoped to. Empty means there is no Chat Application ID.. - */ - applicationId?: string | undefined; -}; - -declare function chatZeroStateSuggestionOptionsFromJSON(jsonString: string): Result; - -declare function chatZeroStateSuggestionOptionsToJSON(chatZeroStateSuggestionOptions: ChatZeroStateSuggestionOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CheckDocumentAccessRequest$ { - /** @deprecated use `CheckDocumentAccessRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CheckDocumentAccessRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CheckDocumentAccessRequest$Outbound` instead. */ - type Outbound = CheckDocumentAccessRequest$Outbound; -} - -/** @internal */ -declare const CheckDocumentAccessRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CheckDocumentAccessRequest$Outbound = { - datasource: string; - objectType: string; - docId: string; - userEmail: string; -}; - -/** @internal */ -declare const CheckDocumentAccessRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /checkdocumentaccess API call - */ -declare type CheckDocumentAccessRequest = { - /** - * Datasource of document to check access for. - */ - datasource: string; - /** - * Object type of document to check access for. - */ - objectType: string; - /** - * Glean Document ID to check access for. - */ - docId: string; - /** - * Email of user to check access for. - */ - userEmail: string; -}; - -declare function checkDocumentAccessRequestFromJSON(jsonString: string): Result; - -declare function checkDocumentAccessRequestToJSON(checkDocumentAccessRequest: CheckDocumentAccessRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CheckDocumentAccessResponse$ { - /** @deprecated use `CheckDocumentAccessResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CheckDocumentAccessResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CheckDocumentAccessResponse$Outbound` instead. */ - type Outbound = CheckDocumentAccessResponse$Outbound; -} - -/** @internal */ -declare const CheckDocumentAccessResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type CheckDocumentAccessResponse$Outbound = { - hasAccess?: boolean | undefined; -}; - -/** @internal */ -declare const CheckDocumentAccessResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /checkdocumentaccess API call - */ -declare type CheckDocumentAccessResponse = { - /** - * If true, user has access to document for search - */ - hasAccess?: boolean | undefined; -}; - -declare function checkDocumentAccessResponseFromJSON(jsonString: string): Result; - -declare function checkDocumentAccessResponseToJSON(checkDocumentAccessResponse: CheckDocumentAccessResponse): string; - -declare class Client extends ClientSDK { - private _activity?; - get activity(): Activity; - private _announcements?; - get announcements(): Announcements; - private _answers?; - get answers(): Answers; - private _authentication?; - get authentication(): ClientAuthentication; - private _chat?; - get chat(): Chat_2; - private _agents?; - get agents(): Agents; - private _collections?; - get collections(): Collections; - private _documents?; - get documents(): ClientDocuments; - private _insights?; - get insights(): Insights; - private _messages?; - get messages(): Messages; - private _pins?; - get pins(): Pins; - private _search?; - get search(): Search; - private _entities?; - get entities(): Entities; - private _shortcuts?; - get shortcuts(): ClientShortcuts; - private _verification?; - get verification(): Verification_2; - private _tools?; - get tools(): Tools; - private _governance?; - get governance(): Governance; -} - -declare class ClientAuthentication extends ClientSDK { - /** - * Create authentication token - * - * @remarks - * Creates an authentication token for the authenticated user. These are - * specifically intended to be used with the [Web SDK](https://developers.glean.com/web). - * - * Note: The tokens generated from this endpoint are **not** valid tokens - * for use with the Client API (e.g. `/rest/api/v1/*`). - */ - createToken(options?: RequestOptions): Promise; -} - -declare class ClientDocuments extends ClientSDK { - /** - * Read document permissions - * - * @remarks - * Read the emails of all users who have access to the given document. - */ - retrievePermissions(request: components.GetDocPermissionsRequest, options?: RequestOptions): Promise; - /** - * Read documents - * - * @remarks - * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request. - */ - retrieve(request?: components.GetDocumentsRequest | undefined, options?: RequestOptions): Promise; - /** - * Read documents by facets - * - * @remarks - * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) macthing the given facet conditions. - */ - retrieveByFacets(request?: components.GetDocumentsByFacetsRequest | undefined, options?: RequestOptions): Promise; - /** - * Summarize documents - * - * @remarks - * Generate an AI summary of the requested documents. - */ - summarize(request: components.SummarizeRequest, options?: RequestOptions): Promise; -} - -declare class ClientSDK { - #private; - readonly _baseURL: URL | null; - readonly _options: SDKOptions & { - hooks?: SDKHooks; - }; - constructor(options?: SDKOptions); - _createRequest(context: HookContext, conf: RequestConfig, options?: RequestOptions): Result; - _do(request: Request, options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }): Promise>; -} - -declare class ClientShortcuts extends ClientSDK { - /** - * Create shortcut - * - * @remarks - * Create a user-generated shortcut that contains an alias and destination URL. - */ - create(request: components.CreateShortcutRequest, options?: RequestOptions): Promise; - /** - * Delete shortcut - * - * @remarks - * Delete an existing user-generated shortcut. - */ - delete(request: components.DeleteShortcutRequest, options?: RequestOptions): Promise; - /** - * Read shortcut - * - * @remarks - * Read a particular shortcut's details given its ID. - */ - retrieve(request: components.GetShortcutRequestUnion, options?: RequestOptions): Promise; - /** - * List shortcuts - * - * @remarks - * List shortcuts editable/owned by the currently authenticated user. - */ - list(request: components.ListShortcutsPaginatedRequest, options?: RequestOptions): Promise; - /** - * Update shortcut - * - * @remarks - * Updates the shortcut with the given ID. - */ - update(request: components.UpdateShortcutRequest, options?: RequestOptions): Promise; -} - -declare type ClosedEnum = T[keyof T]; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClusterGroup$ { - /** @deprecated use `ClusterGroup$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClusterGroup$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClusterGroup$Outbound` instead. */ - type Outbound = ClusterGroup$Outbound; -} - -/** @internal */ -declare const ClusterGroup$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClusterGroup$Outbound = { - clusteredResults?: Array | undefined; - clusterType?: string | undefined; - visibleCountHint: number; -}; - -/** @internal */ -declare const ClusterGroup$outboundSchema: z.ZodType; - -declare type ClusterGroup = { - /** - * A list of results that should be displayed as associated with this result. - */ - clusteredResults?: Array | undefined; - /** - * The reason for inclusion of clusteredResults. - */ - clusterType?: ClusterTypeEnum | undefined; - /** - * The default number of results to display before truncating and showing a "see more" link - */ - visibleCountHint: number; -}; - -declare function clusterGroupFromJSON(jsonString: string): Result; - -declare function clusterGroupToJSON(clusterGroup: ClusterGroup): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClusterTypeEnum$ { - /** @deprecated use `ClusterTypeEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Similar: "SIMILAR"; - readonly Freshness: "FRESHNESS"; - readonly Title: "TITLE"; - readonly Content: "CONTENT"; - readonly None: "NONE"; - readonly ThreadReply: "THREAD_REPLY"; - readonly ThreadRoot: "THREAD_ROOT"; - readonly Prefix: "PREFIX"; - readonly Suffix: "SUFFIX"; - readonly AuthorPrefix: "AUTHOR_PREFIX"; - readonly AuthorSuffix: "AUTHOR_SUFFIX"; - }>; - /** @deprecated use `ClusterTypeEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Similar: "SIMILAR"; - readonly Freshness: "FRESHNESS"; - readonly Title: "TITLE"; - readonly Content: "CONTENT"; - readonly None: "NONE"; - readonly ThreadReply: "THREAD_REPLY"; - readonly ThreadRoot: "THREAD_ROOT"; - readonly Prefix: "PREFIX"; - readonly Suffix: "SUFFIX"; - readonly AuthorPrefix: "AUTHOR_PREFIX"; - readonly AuthorSuffix: "AUTHOR_SUFFIX"; - }>; -} - -/** @internal */ -declare const ClusterTypeEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClusterTypeEnum$outboundSchema: z.ZodNativeEnum; - -/** - * The reason for inclusion of clusteredResults. - */ -declare const ClusterTypeEnum: { - readonly Similar: "SIMILAR"; - readonly Freshness: "FRESHNESS"; - readonly Title: "TITLE"; - readonly Content: "CONTENT"; - readonly None: "NONE"; - readonly ThreadReply: "THREAD_REPLY"; - readonly ThreadRoot: "THREAD_ROOT"; - readonly Prefix: "PREFIX"; - readonly Suffix: "SUFFIX"; - readonly AuthorPrefix: "AUTHOR_PREFIX"; - readonly AuthorSuffix: "AUTHOR_SUFFIX"; -}; - -/** - * The reason for inclusion of clusteredResults. - */ -declare type ClusterTypeEnum = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Code$ { - /** @deprecated use `Code$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Code$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Code$Outbound` instead. */ - type Outbound = Code$Outbound; -} - -/** @internal */ -declare const Code$inboundSchema: z.ZodType; - -/** @internal */ -declare type Code$Outbound = { - repoName?: string | undefined; - fileName?: string | undefined; - fileUrl?: string | undefined; - lines?: Array | undefined; - isLastMatch?: boolean | undefined; -}; - -/** @internal */ -declare const Code$outboundSchema: z.ZodType; - -declare type Code = { - repoName?: string | undefined; - fileName?: string | undefined; - fileUrl?: string | undefined; - lines?: Array | undefined; - /** - * Last file match for a repo - */ - isLastMatch?: boolean | undefined; -}; - -declare function codeFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeLine$ { - /** @deprecated use `CodeLine$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CodeLine$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CodeLine$Outbound` instead. */ - type Outbound = CodeLine$Outbound; -} - -/** @internal */ -declare const CodeLine$inboundSchema: z.ZodType; - -/** @internal */ -declare type CodeLine$Outbound = { - lineNumber?: number | undefined; - content?: string | undefined; - ranges?: Array | undefined; -}; - -/** @internal */ -declare const CodeLine$outboundSchema: z.ZodType; - -declare type CodeLine = { - lineNumber?: number | undefined; - content?: string | undefined; - /** - * Index ranges depicting matched sections of the line - */ - ranges?: Array | undefined; -}; - -declare function codeLineFromJSON(jsonString: string): Result; - -declare function codeLineToJSON(codeLine: CodeLine): string; - -declare function codeToJSON(code: Code): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Collection$ { - /** @deprecated use `Collection$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Collection$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Collection$Outbound` instead. */ - type Outbound = Collection$Outbound; -} - -/** @internal */ -declare const Collection$inboundSchema: z.ZodType; - -/** @internal */ -declare type Collection$Outbound = { - name: string; - description: string; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - audienceFilters?: Array | undefined; - icon?: string | undefined; - adminLocked?: boolean | undefined; - parentId?: number | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - allowedDatasource?: string | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id: number; - createTime?: string | undefined; - updateTime?: string | undefined; - creator?: Person$Outbound | undefined; - updatedBy?: Person$Outbound | undefined; - itemCount?: number | undefined; - childCount?: number | undefined; - items?: Array | undefined; - pinMetadata?: CollectionPinnedMetadata$Outbound | undefined; - shortcuts?: Array | undefined; - children?: Array | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const Collection$outboundSchema: z.ZodType; - -declare type Collection = { - /** - * The unique name of the Collection. - */ - name: string; - /** - * A brief summary of the Collection's contents. - */ - description: string; - /** - * A list of added user roles for the Collection. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Collection. - */ - removedRoles?: Array | undefined; - /** - * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The emoji icon of this Collection. - */ - icon?: string | undefined; - /** - * Indicates whether edits are allowed for everyone or only admins. - */ - adminLocked?: boolean | undefined; - /** - * The parent of this Collection, or 0 if it's a top-level Collection. - */ - parentId?: number | undefined; - thumbnail?: Thumbnail | undefined; - /** - * The datasource type this Collection can hold. - */ - allowedDatasource?: string | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The unique ID of the Collection. - */ - id: number; - createTime?: Date | undefined; - updateTime?: Date | undefined; - creator?: Person | undefined; - updatedBy?: Person | undefined; - /** - * The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - */ - itemCount?: number | undefined; - /** - * The number of children Collections. Separated from the actual children so we can grab the count without children. - */ - childCount?: number | undefined; - /** - * The items in this Collection. - */ - items?: Array | undefined; - pinMetadata?: CollectionPinnedMetadata | undefined; - /** - * The names of the shortcuts (Go Links) that point to this Collection. - */ - shortcuts?: Array | undefined; - /** - * The children Collections of this Collection. - */ - children?: Array | undefined; - /** - * A list of user roles for the Collection. - */ - roles?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionError$ { - /** @deprecated use `CollectionError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionError$Outbound` instead. */ - type Outbound = CollectionError$Outbound; -} - -/** @internal */ -declare const CollectionError$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionError$Outbound = { - errorCode: string; -}; - -/** @internal */ -declare const CollectionError$outboundSchema: z.ZodType; - -declare type CollectionError = { - errorCode: CollectionErrorErrorCode; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionErrorErrorCode$ { - /** @deprecated use `CollectionErrorErrorCode$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; - }>; - /** @deprecated use `CollectionErrorErrorCode$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; - }>; -} - -/** @internal */ -declare const CollectionErrorErrorCode$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CollectionErrorErrorCode$outboundSchema: z.ZodNativeEnum; - -declare const CollectionErrorErrorCode: { - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; -}; - -declare type CollectionErrorErrorCode = ClosedEnum; - -declare function collectionErrorFromJSON(jsonString: string): Result; - -declare function collectionErrorToJSON(collectionError: CollectionError): string; - -declare function collectionFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionItem$ { - /** @deprecated use `CollectionItem$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionItem$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionItem$Outbound` instead. */ - type Outbound = CollectionItem$Outbound; -} - -/** @internal */ -declare const CollectionItem$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionItem$Outbound = { - name?: string | undefined; - description?: string | undefined; - icon?: string | undefined; - collectionId: number; - documentId?: string | undefined; - url?: string | undefined; - itemId?: string | undefined; - createdBy?: Person$Outbound | undefined; - createdAt?: string | undefined; - document?: Document$Outbound | undefined; - shortcut?: Shortcut$Outbound | undefined; - collection?: Collection$Outbound | undefined; - itemType: string; -}; - -/** @internal */ -declare const CollectionItem$outboundSchema: z.ZodType; - -declare type CollectionItem = { - /** - * The optional name of the Collection item. - */ - name?: string | undefined; - /** - * A helpful description of why this CollectionItem is in the Collection that it's in. - */ - description?: string | undefined; - /** - * The emoji icon for this CollectionItem. Only used for Text type items. - */ - icon?: string | undefined; - /** - * The Collection ID of the Collection that this CollectionItem belongs in. - */ - collectionId: number; - /** - * If this CollectionItem is indexed, the Glean Document ID of that document. - */ - documentId?: string | undefined; - /** - * The URL of this CollectionItem. - */ - url?: string | undefined; - /** - * Unique identifier for the item within the Collection it belongs to. - */ - itemId?: string | undefined; - createdBy?: Person | undefined; - /** - * Unix timestamp for when the item was first added (in seconds since epoch UTC). - */ - createdAt?: Date | undefined; - document?: Document_2 | undefined; - shortcut?: Shortcut | undefined; - collection?: Collection | undefined; - itemType: CollectionItemItemType; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionItemDescriptor$ { - /** @deprecated use `CollectionItemDescriptor$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionItemDescriptor$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionItemDescriptor$Outbound` instead. */ - type Outbound = CollectionItemDescriptor$Outbound; -} - -/** @internal */ -declare const CollectionItemDescriptor$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionItemDescriptor$Outbound = { - name?: string | undefined; - description?: string | undefined; - icon?: string | undefined; - url?: string | undefined; - documentId?: string | undefined; - newNextItemId?: string | undefined; - itemType?: string | undefined; -}; - -/** @internal */ -declare const CollectionItemDescriptor$outboundSchema: z.ZodType; - -declare type CollectionItemDescriptor = { - /** - * The optional name of the Collection item. - */ - name?: string | undefined; - /** - * A helpful description of why this CollectionItem is in the Collection that it's in. - */ - description?: string | undefined; - /** - * The emoji icon for this CollectionItem. Only used for Text type items. - */ - icon?: string | undefined; - /** - * The URL of the item being added. - */ - url?: string | undefined; - /** - * The Glean Document ID of the item being added if it's an indexed document. - */ - documentId?: string | undefined; - /** - * The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection - */ - newNextItemId?: string | undefined; - itemType?: CollectionItemDescriptorItemType | undefined; -}; - -declare function collectionItemDescriptorFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionItemDescriptorItemType$ { - /** @deprecated use `CollectionItemDescriptorItemType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; - }>; - /** @deprecated use `CollectionItemDescriptorItemType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; - }>; -} - -/** @internal */ -declare const CollectionItemDescriptorItemType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CollectionItemDescriptorItemType$outboundSchema: z.ZodNativeEnum; - -declare const CollectionItemDescriptorItemType: { - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; -}; - -declare type CollectionItemDescriptorItemType = ClosedEnum; - -declare function collectionItemDescriptorToJSON(collectionItemDescriptor: CollectionItemDescriptor): string; - -declare function collectionItemFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionItemItemType$ { - /** @deprecated use `CollectionItemItemType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; - readonly Collection: "COLLECTION"; - }>; - /** @deprecated use `CollectionItemItemType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; - readonly Collection: "COLLECTION"; - }>; -} - -/** @internal */ -declare const CollectionItemItemType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CollectionItemItemType$outboundSchema: z.ZodNativeEnum; - -declare const CollectionItemItemType: { - readonly Document: "DOCUMENT"; - readonly Text: "TEXT"; - readonly Url: "URL"; - readonly Collection: "COLLECTION"; -}; - -declare type CollectionItemItemType = ClosedEnum; - -declare function collectionItemToJSON(collectionItem: CollectionItem): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionPinMetadata$ { - /** @deprecated use `CollectionPinMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionPinMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionPinMetadata$Outbound` instead. */ - type Outbound = CollectionPinMetadata$Outbound; -} - -/** @internal */ -declare const CollectionPinMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionPinMetadata$Outbound = { - id: number; - target: CollectionPinTarget$Outbound; -}; - -/** @internal */ -declare const CollectionPinMetadata$outboundSchema: z.ZodType; - -declare type CollectionPinMetadata = { - /** - * The ID of the Collection. - */ - id: number; - target: CollectionPinTarget; -}; - -declare function collectionPinMetadataFromJSON(jsonString: string): Result; - -declare function collectionPinMetadataToJSON(collectionPinMetadata: CollectionPinMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionPinnableCategories$ { - /** @deprecated use `CollectionPinnableCategories$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly DepartmentResource: "DEPARTMENT_RESOURCE"; - readonly TeamResource: "TEAM_RESOURCE"; - }>; - /** @deprecated use `CollectionPinnableCategories$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly DepartmentResource: "DEPARTMENT_RESOURCE"; - readonly TeamResource: "TEAM_RESOURCE"; - }>; -} - -/** @internal */ -declare const CollectionPinnableCategories$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CollectionPinnableCategories$outboundSchema: z.ZodNativeEnum; - -/** - * Categories a Collection can be pinned to. - */ -declare const CollectionPinnableCategories: { - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly DepartmentResource: "DEPARTMENT_RESOURCE"; - readonly TeamResource: "TEAM_RESOURCE"; -}; - -/** - * Categories a Collection can be pinned to. - */ -declare type CollectionPinnableCategories = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionPinnableTargets$ { - /** @deprecated use `CollectionPinnableTargets$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ResourceCard: "RESOURCE_CARD"; - readonly TeamProfilePage: "TEAM_PROFILE_PAGE"; - }>; - /** @deprecated use `CollectionPinnableTargets$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ResourceCard: "RESOURCE_CARD"; - readonly TeamProfilePage: "TEAM_PROFILE_PAGE"; - }>; -} - -/** @internal */ -declare const CollectionPinnableTargets$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CollectionPinnableTargets$outboundSchema: z.ZodNativeEnum; - -/** - * What targets can a Collection be pinned to. - */ -declare const CollectionPinnableTargets: { - readonly ResourceCard: "RESOURCE_CARD"; - readonly TeamProfilePage: "TEAM_PROFILE_PAGE"; -}; - -/** - * What targets can a Collection be pinned to. - */ -declare type CollectionPinnableTargets = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionPinnedMetadata$ { - /** @deprecated use `CollectionPinnedMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionPinnedMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionPinnedMetadata$Outbound` instead. */ - type Outbound = CollectionPinnedMetadata$Outbound; -} - -/** @internal */ -declare const CollectionPinnedMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionPinnedMetadata$Outbound = { - existingPins?: Array | undefined; - eligiblePins?: Array | undefined; -}; - -/** @internal */ -declare const CollectionPinnedMetadata$outboundSchema: z.ZodType; - -declare type CollectionPinnedMetadata = { - /** - * List of targets this Collection is pinned to. - */ - existingPins?: Array | undefined; - /** - * List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - */ - eligiblePins?: Array | undefined; -}; - -declare function collectionPinnedMetadataFromJSON(jsonString: string): Result; - -declare function collectionPinnedMetadataToJSON(collectionPinnedMetadata: CollectionPinnedMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CollectionPinTarget$ { - /** @deprecated use `CollectionPinTarget$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CollectionPinTarget$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CollectionPinTarget$Outbound` instead. */ - type Outbound = CollectionPinTarget$Outbound; -} - -/** @internal */ -declare const CollectionPinTarget$inboundSchema: z.ZodType; - -/** @internal */ -declare type CollectionPinTarget$Outbound = { - category: string; - value?: string | undefined; - target?: string | undefined; -}; - -/** @internal */ -declare const CollectionPinTarget$outboundSchema: z.ZodType; - -declare type CollectionPinTarget = { - /** - * Categories a Collection can be pinned to. - */ - category: CollectionPinnableCategories; - /** - * Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on. - */ - value?: string | undefined; - /** - * What targets can a Collection be pinned to. - */ - target?: CollectionPinnableTargets | undefined; -}; - -declare function collectionPinTargetFromJSON(jsonString: string): Result; - -declare function collectionPinTargetToJSON(collectionPinTarget: CollectionPinTarget): string; - -declare class Collections extends ClientSDK { - /** - * Add Collection item - * - * @remarks - * Add items to a Collection. - */ - addItems(request: components.AddCollectionItemsRequest, options?: RequestOptions): Promise; - /** - * Create Collection - * - * @remarks - * Create a publicly visible (empty) Collection of documents. - */ - create(request: components.CreateCollectionRequest, options?: RequestOptions): Promise; - /** - * Delete Collection - * - * @remarks - * Delete a Collection given the Collection's ID. - */ - delete(request: components.DeleteCollectionRequest, options?: RequestOptions): Promise; - /** - * Delete Collection item - * - * @remarks - * Delete a single item from a Collection. - */ - deleteItem(request: components.DeleteCollectionItemRequest, options?: RequestOptions): Promise; - /** - * Update Collection - * - * @remarks - * Update the properties of an existing Collection. - */ - update(request: components.EditCollectionRequest, options?: RequestOptions): Promise; - /** - * Update Collection item - * - * @remarks - * Update the URL, Glean Document ID, description of an item within a Collection given its ID. - */ - updateItem(request: components.EditCollectionItemRequest, options?: RequestOptions): Promise; - /** - * Read Collection - * - * @remarks - * Read the details of a Collection given its ID. Does not fetch items in this Collection. - */ - retrieve(request: components.GetCollectionRequest, options?: RequestOptions): Promise; - /** - * List Collections - * - * @remarks - * List all existing Collections. - */ - list(request: components.ListCollectionsRequest, options?: RequestOptions): Promise; -} - -declare function collectionToJSON(collection: Collection): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CommentDefinition$ { - /** @deprecated use `CommentDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CommentDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CommentDefinition$Outbound` instead. */ - type Outbound = CommentDefinition$Outbound; -} - -/** @internal */ -declare const CommentDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type CommentDefinition$Outbound = { - id: string; - author?: UserReferenceDefinition$Outbound | undefined; - content?: ContentDefinition$Outbound | undefined; - createdAt?: number | undefined; - updatedAt?: number | undefined; - updatedBy?: UserReferenceDefinition$Outbound | undefined; -}; - -/** @internal */ -declare const CommentDefinition$outboundSchema: z.ZodType; - -/** - * Describes a comment on a document - */ -declare type CommentDefinition = { - /** - * The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length. - */ - id: string; - /** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ - author?: UserReferenceDefinition | undefined; - /** - * Describes text content or base64 encoded binary content - */ - content?: ContentDefinition | undefined; - /** - * The creation time, in epoch seconds. - */ - createdAt?: number | undefined; - /** - * The last updated time, in epoch seconds. - */ - updatedAt?: number | undefined; - /** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ - updatedBy?: UserReferenceDefinition | undefined; -}; - -declare function commentDefinitionFromJSON(jsonString: string): Result; - -declare function commentDefinitionToJSON(commentDefinition: CommentDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CommunicationChannel$ { - /** @deprecated use `CommunicationChannel$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CommunicationChannelEmail: "COMMUNICATION_CHANNEL_EMAIL"; - readonly CommunicationChannelSlack: "COMMUNICATION_CHANNEL_SLACK"; - }>; - /** @deprecated use `CommunicationChannel$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CommunicationChannelEmail: "COMMUNICATION_CHANNEL_EMAIL"; - readonly CommunicationChannelSlack: "COMMUNICATION_CHANNEL_SLACK"; - }>; -} - -/** @internal */ -declare const CommunicationChannel$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CommunicationChannel$outboundSchema: z.ZodNativeEnum; - -declare const CommunicationChannel: { - readonly CommunicationChannelEmail: "COMMUNICATION_CHANNEL_EMAIL"; - readonly CommunicationChannelSlack: "COMMUNICATION_CHANNEL_SLACK"; -}; - -declare type CommunicationChannel = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Company$ { - /** @deprecated use `Company$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Company$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Company$Outbound` instead. */ - type Outbound = Company$Outbound; -} - -/** @internal */ -declare const Company$inboundSchema: z.ZodType; - -/** @internal */ -declare type Company$Outbound = { - name: string; - profileUrl?: string | undefined; - websiteUrls?: Array | undefined; - logoUrl?: string | undefined; - location?: string | undefined; - phone?: string | undefined; - fax?: string | undefined; - industry?: string | undefined; - annualRevenue?: number | undefined; - numberOfEmployees?: number | undefined; - stockSymbol?: string | undefined; - foundedDate?: string | undefined; - about?: string | undefined; -}; - -/** @internal */ -declare const Company$outboundSchema: z.ZodType; - -declare type Company = { - /** - * User-friendly display name. - */ - name: string; - /** - * Link to internal company company profile. - */ - profileUrl?: string | undefined; - /** - * Link to company's associated websites. - */ - websiteUrls?: Array | undefined; - /** - * The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - */ - logoUrl?: string | undefined; - /** - * User facing string representing the company's location. - */ - location?: string | undefined; - /** - * Phone number as a number string. - */ - phone?: string | undefined; - /** - * Fax number as a number string. - */ - fax?: string | undefined; - /** - * User facing string representing the company's industry. - */ - industry?: string | undefined; - /** - * Average company's annual revenue for reference. - */ - annualRevenue?: number | undefined; - /** - * Average company's number of employees for reference. - */ - numberOfEmployees?: number | undefined; - /** - * Company's stock symbol if company is public. - */ - stockSymbol?: string | undefined; - /** - * The date when the company was founded. - */ - foundedDate?: RFCDate | undefined; - /** - * User facing description of company. - */ - about?: string | undefined; -}; - -declare function companyFromJSON(jsonString: string): Result; - -declare function companyToJSON(company: Company): string; - -declare namespace components { - export { - activityToJSON, - activityFromJSON, - Activity_2 as Activity, - Activity$inboundSchema, - Activity$Outbound, - Activity$outboundSchema, - Activity$, - activityEventToJSON, - activityEventFromJSON, - ActivityEventAction, - ActivityEvent, - ActivityEventAction$inboundSchema, - ActivityEventAction$outboundSchema, - ActivityEventAction$, - ActivityEvent$inboundSchema, - ActivityEvent$Outbound, - ActivityEvent$outboundSchema, - ActivityEvent$, - activityEventParamsToJSON, - activityEventParamsFromJSON, - ActivityEventParams, - ActivityEventParams$inboundSchema, - ActivityEventParams$Outbound, - ActivityEventParams$outboundSchema, - ActivityEventParams$, - addCollectionItemsErrorToJSON, - addCollectionItemsErrorFromJSON, - AddCollectionItemsErrorErrorType, - AddCollectionItemsError, - AddCollectionItemsErrorErrorType$inboundSchema, - AddCollectionItemsErrorErrorType$outboundSchema, - AddCollectionItemsErrorErrorType$, - AddCollectionItemsError$inboundSchema, - AddCollectionItemsError$Outbound, - AddCollectionItemsError$outboundSchema, - AddCollectionItemsError$, - addCollectionItemsRequestToJSON, - addCollectionItemsRequestFromJSON, - AddCollectionItemsRequest, - AddCollectionItemsRequest$inboundSchema, - AddCollectionItemsRequest$Outbound, - AddCollectionItemsRequest$outboundSchema, - AddCollectionItemsRequest$, - addCollectionItemsResponseToJSON, - addCollectionItemsResponseFromJSON, - AddCollectionItemsResponse, - AddCollectionItemsResponse$inboundSchema, - AddCollectionItemsResponse$Outbound, - AddCollectionItemsResponse$outboundSchema, - AddCollectionItemsResponse$, - valueToJSON, - valueFromJSON, - additionalFieldDefinitionToJSON, - additionalFieldDefinitionFromJSON, - Value, - AdditionalFieldDefinition, - Value$inboundSchema, - Value$Outbound, - Value$outboundSchema, - Value$, - AdditionalFieldDefinition$inboundSchema, - AdditionalFieldDefinition$Outbound, - AdditionalFieldDefinition$outboundSchema, - AdditionalFieldDefinition$, - agentMetadataToJSON, - agentMetadataFromJSON, - agentCapabilitiesToJSON, - agentCapabilitiesFromJSON, - agentToJSON, - agentFromJSON, - AgentMetadata, - AgentCapabilities, - Agent, - AgentMetadata$inboundSchema, - AgentMetadata$Outbound, - AgentMetadata$outboundSchema, - AgentMetadata$, - AgentCapabilities$inboundSchema, - AgentCapabilities$Outbound, - AgentCapabilities$outboundSchema, - AgentCapabilities$, - Agent$inboundSchema, - Agent$Outbound, - Agent$outboundSchema, - Agent$, - agentConfigToJSON, - agentConfigFromJSON, - AgentEnum, - Mode, - AgentConfig, - AgentEnum$inboundSchema, - AgentEnum$outboundSchema, - AgentEnum$, - Mode$inboundSchema, - Mode$outboundSchema, - Mode$, - AgentConfig$inboundSchema, - AgentConfig$Outbound, - AgentConfig$outboundSchema, - AgentConfig$, - AgentExecutionStatus, - AgentExecutionStatus$inboundSchema, - AgentExecutionStatus$outboundSchema, - AgentExecutionStatus$, - agentRunToJSON, - agentRunFromJSON, - AgentRun, - AgentRun$inboundSchema, - AgentRun$Outbound, - AgentRun$outboundSchema, - AgentRun$, - agentRunCreateToJSON, - agentRunCreateFromJSON, - AgentRunCreate, - AgentRunCreate$inboundSchema, - AgentRunCreate$Outbound, - AgentRunCreate$outboundSchema, - AgentRunCreate$, - agentRunWaitResponseToJSON, - agentRunWaitResponseFromJSON, - AgentRunWaitResponse, - AgentRunWaitResponse$inboundSchema, - AgentRunWaitResponse$Outbound, - AgentRunWaitResponse$outboundSchema, - AgentRunWaitResponse$, - inputSchemaToJSON, - inputSchemaFromJSON, - outputSchemaToJSON, - outputSchemaFromJSON, - agentSchemasToJSON, - agentSchemasFromJSON, - InputSchema, - OutputSchema, - AgentSchemas, - InputSchema$inboundSchema, - InputSchema$Outbound, - InputSchema$outboundSchema, - InputSchema$, - OutputSchema$inboundSchema, - OutputSchema$Outbound, - OutputSchema$outboundSchema, - OutputSchema$, - AgentSchemas$inboundSchema, - AgentSchemas$Outbound, - AgentSchemas$outboundSchema, - AgentSchemas$, - agentsInsightsV2RequestToJSON, - agentsInsightsV2RequestFromJSON, - AgentsInsightsV2Request, - AgentsInsightsV2Request$inboundSchema, - AgentsInsightsV2Request$Outbound, - AgentsInsightsV2Request$outboundSchema, - AgentsInsightsV2Request$, - aiAppActionCountsToJSON, - aiAppActionCountsFromJSON, - AiAppActionCounts, - AiAppActionCounts$inboundSchema, - AiAppActionCounts$Outbound, - AiAppActionCounts$outboundSchema, - AiAppActionCounts$, - aiAppsInsightsResponseToJSON, - aiAppsInsightsResponseFromJSON, - AiAppsInsightsResponse, - AiAppsInsightsResponse$inboundSchema, - AiAppsInsightsResponse$Outbound, - AiAppsInsightsResponse$outboundSchema, - AiAppsInsightsResponse$, - aiInsightsResponseToJSON, - aiInsightsResponseFromJSON, - AiInsightsResponse, - AiInsightsResponse$inboundSchema, - AiInsightsResponse$Outbound, - AiInsightsResponse$outboundSchema, - AiInsightsResponse$, - allowlistOptionsToJSON, - allowlistOptionsFromJSON, - AllowlistOptions, - AllowlistOptions$inboundSchema, - AllowlistOptions$Outbound, - AllowlistOptions$outboundSchema, - AllowlistOptions$, - announcementViewerInfoToJSON, - announcementViewerInfoFromJSON, - announcementToJSON, - announcementFromJSON, - AnnouncementChannel, - AnnouncementPostType, - AnnouncementViewerInfo, - Announcement, - AnnouncementChannel$inboundSchema, - AnnouncementChannel$outboundSchema, - AnnouncementChannel$, - AnnouncementPostType$inboundSchema, - AnnouncementPostType$outboundSchema, - AnnouncementPostType$, - AnnouncementViewerInfo$inboundSchema, - AnnouncementViewerInfo$Outbound, - AnnouncementViewerInfo$outboundSchema, - AnnouncementViewerInfo$, - Announcement$inboundSchema, - Announcement$Outbound, - Announcement$outboundSchema, - Announcement$, - anonymousEventToJSON, - anonymousEventFromJSON, - AnonymousEventEventType, - AnonymousEvent, - AnonymousEventEventType$inboundSchema, - AnonymousEventEventType$outboundSchema, - AnonymousEventEventType$, - AnonymousEvent$inboundSchema, - AnonymousEvent$Outbound, - AnonymousEvent$outboundSchema, - AnonymousEvent$, - answerToJSON, - answerFromJSON, - AnswerSourceType, - Answer, - AnswerSourceType$inboundSchema, - AnswerSourceType$outboundSchema, - AnswerSourceType$, - Answer$inboundSchema, - Answer$Outbound, - Answer$outboundSchema, - Answer$, - answerBoardToJSON, - answerBoardFromJSON, - AnswerBoard, - AnswerBoard$inboundSchema, - AnswerBoard$Outbound, - AnswerBoard$outboundSchema, - AnswerBoard$, - answerCreationDataToJSON, - answerCreationDataFromJSON, - AnswerCreationDataSourceType, - AnswerCreationData, - AnswerCreationDataSourceType$inboundSchema, - AnswerCreationDataSourceType$outboundSchema, - AnswerCreationDataSourceType$, - AnswerCreationData$inboundSchema, - AnswerCreationData$Outbound, - AnswerCreationData$outboundSchema, - AnswerCreationData$, - answerLikeToJSON, - answerLikeFromJSON, - AnswerLike, - AnswerLike$inboundSchema, - AnswerLike$Outbound, - AnswerLike$outboundSchema, - AnswerLike$, - answerLikesToJSON, - answerLikesFromJSON, - AnswerLikes, - AnswerLikes$inboundSchema, - AnswerLikes$Outbound, - AnswerLikes$outboundSchema, - AnswerLikes$, - answerResultToJSON, - answerResultFromJSON, - AnswerResult, - AnswerResult$inboundSchema, - AnswerResult$Outbound, - AnswerResult$outboundSchema, - AnswerResult$, - appResultToJSON, - appResultFromJSON, - AppResult, - AppResult$inboundSchema, - AppResult$Outbound, - AppResult$outboundSchema, - AppResult$, - authConfigToJSON, - authConfigFromJSON, - AuthConfigType, - GrantType, - AuthConfigStatus, - AuthConfig, - AuthConfigType$inboundSchema, - AuthConfigType$outboundSchema, - AuthConfigType$, - GrantType$inboundSchema, - GrantType$outboundSchema, - GrantType$, - AuthConfigStatus$inboundSchema, - AuthConfigStatus$outboundSchema, - AuthConfigStatus$, - AuthConfig$inboundSchema, - AuthConfig$Outbound, - AuthConfig$outboundSchema, - AuthConfig$, - authTokenToJSON, - authTokenFromJSON, - AuthToken, - AuthToken$inboundSchema, - AuthToken$Outbound, - AuthToken$outboundSchema, - AuthToken$, - autocompleteRequestToJSON, - autocompleteRequestFromJSON, - AutocompleteRequestResultType, - AutocompleteRequest, - AutocompleteRequestResultType$inboundSchema, - AutocompleteRequestResultType$outboundSchema, - AutocompleteRequestResultType$, - AutocompleteRequest$inboundSchema, - AutocompleteRequest$Outbound, - AutocompleteRequest$outboundSchema, - AutocompleteRequest$, - autocompleteResponseToJSON, - autocompleteResponseFromJSON, - AutocompleteResponse, - AutocompleteResponse$inboundSchema, - AutocompleteResponse$Outbound, - AutocompleteResponse$outboundSchema, - AutocompleteResponse$, - autocompleteResultToJSON, - autocompleteResultFromJSON, - AutocompleteResultResultType, - AutocompleteResult, - AutocompleteResultResultType$inboundSchema, - AutocompleteResultResultType$outboundSchema, - AutocompleteResultResultType$, - AutocompleteResult$inboundSchema, - AutocompleteResult$Outbound, - AutocompleteResult$outboundSchema, - AutocompleteResult$, - autocompleteResultGroupToJSON, - autocompleteResultGroupFromJSON, - AutocompleteResultGroup, - AutocompleteResultGroup$inboundSchema, - AutocompleteResultGroup$Outbound, - AutocompleteResultGroup$outboundSchema, - AutocompleteResultGroup$, - badgeToJSON, - badgeFromJSON, - Badge, - Badge$inboundSchema, - Badge$Outbound, - Badge$outboundSchema, - Badge$, - bulkIndexDocumentsRequestToJSON, - bulkIndexDocumentsRequestFromJSON, - BulkIndexDocumentsRequest, - BulkIndexDocumentsRequest$inboundSchema, - BulkIndexDocumentsRequest$Outbound, - BulkIndexDocumentsRequest$outboundSchema, - BulkIndexDocumentsRequest$, - bulkIndexEmployeesRequestToJSON, - bulkIndexEmployeesRequestFromJSON, - BulkIndexEmployeesRequest, - BulkIndexEmployeesRequest$inboundSchema, - BulkIndexEmployeesRequest$Outbound, - BulkIndexEmployeesRequest$outboundSchema, - BulkIndexEmployeesRequest$, - bulkIndexGroupsRequestToJSON, - bulkIndexGroupsRequestFromJSON, - BulkIndexGroupsRequest, - BulkIndexGroupsRequest$inboundSchema, - BulkIndexGroupsRequest$Outbound, - BulkIndexGroupsRequest$outboundSchema, - BulkIndexGroupsRequest$, - bulkIndexMembershipsRequestToJSON, - bulkIndexMembershipsRequestFromJSON, - BulkIndexMembershipsRequest, - BulkIndexMembershipsRequest$inboundSchema, - BulkIndexMembershipsRequest$Outbound, - BulkIndexMembershipsRequest$outboundSchema, - BulkIndexMembershipsRequest$, - bulkIndexShortcutsRequestToJSON, - bulkIndexShortcutsRequestFromJSON, - BulkIndexShortcutsRequest, - BulkIndexShortcutsRequest$inboundSchema, - BulkIndexShortcutsRequest$Outbound, - BulkIndexShortcutsRequest$outboundSchema, - BulkIndexShortcutsRequest$, - bulkIndexTeamsRequestToJSON, - bulkIndexTeamsRequestFromJSON, - BulkIndexTeamsRequest, - BulkIndexTeamsRequest$inboundSchema, - BulkIndexTeamsRequest$Outbound, - BulkIndexTeamsRequest$outboundSchema, - BulkIndexTeamsRequest$, - bulkIndexUsersRequestToJSON, - bulkIndexUsersRequestFromJSON, - BulkIndexUsersRequest, - BulkIndexUsersRequest$inboundSchema, - BulkIndexUsersRequest$Outbound, - BulkIndexUsersRequest$outboundSchema, - BulkIndexUsersRequest$, - bulkUploadHistoryEventToJSON, - bulkUploadHistoryEventFromJSON, - BulkUploadHistoryEventStatus, - ProcessingState, - BulkUploadHistoryEvent, - BulkUploadHistoryEventStatus$inboundSchema, - BulkUploadHistoryEventStatus$outboundSchema, - BulkUploadHistoryEventStatus$, - ProcessingState$inboundSchema, - ProcessingState$outboundSchema, - ProcessingState$, - BulkUploadHistoryEvent$inboundSchema, - BulkUploadHistoryEvent$Outbound, - BulkUploadHistoryEvent$outboundSchema, - BulkUploadHistoryEvent$, - calendarAttendeeToJSON, - calendarAttendeeFromJSON, - ResponseStatus, - CalendarAttendee, - ResponseStatus$inboundSchema, - ResponseStatus$outboundSchema, - ResponseStatus$, - CalendarAttendee$inboundSchema, - CalendarAttendee$Outbound, - CalendarAttendee$outboundSchema, - CalendarAttendee$, - calendarAttendeesToJSON, - calendarAttendeesFromJSON, - CalendarAttendees, - CalendarAttendees$inboundSchema, - CalendarAttendees$Outbound, - CalendarAttendees$outboundSchema, - CalendarAttendees$, - calendarEventToJSON, - calendarEventFromJSON, - CalendarEventEventType, - CalendarEvent, - CalendarEventEventType$inboundSchema, - CalendarEventEventType$outboundSchema, - CalendarEventEventType$, - CalendarEvent$inboundSchema, - CalendarEvent$Outbound, - CalendarEvent$outboundSchema, - CalendarEvent$, - canonicalizingRegexTypeToJSON, - canonicalizingRegexTypeFromJSON, - CanonicalizingRegexType, - CanonicalizingRegexType$inboundSchema, - CanonicalizingRegexType$Outbound, - CanonicalizingRegexType$outboundSchema, - CanonicalizingRegexType$, - channelInviteInfoToJSON, - channelInviteInfoFromJSON, - ChannelInviteInfo, - ChannelInviteInfo$inboundSchema, - ChannelInviteInfo$Outbound, - ChannelInviteInfo$outboundSchema, - ChannelInviteInfo$, - chatToJSON, - chatFromJSON, - Chat, - Chat$inboundSchema, - Chat$Outbound, - Chat$outboundSchema, - Chat$, - chatFileToJSON, - chatFileFromJSON, - ChatFile, - ChatFile$inboundSchema, - ChatFile$Outbound, - ChatFile$outboundSchema, - ChatFile$, - ChatFileFailureReason, - ChatFileFailureReason$inboundSchema, - ChatFileFailureReason$outboundSchema, - ChatFileFailureReason$, - chatFileMetadataToJSON, - chatFileMetadataFromJSON, - ChatFileMetadata, - ChatFileMetadata$inboundSchema, - ChatFileMetadata$Outbound, - ChatFileMetadata$outboundSchema, - ChatFileMetadata$, - ChatFileStatus, - ChatFileStatus$inboundSchema, - ChatFileStatus$outboundSchema, - ChatFileStatus$, - chatMessageToJSON, - chatMessageFromJSON, - Author, - MessageType, - ChatMessage, - Author$inboundSchema, - Author$outboundSchema, - Author$, - MessageType$inboundSchema, - MessageType$outboundSchema, - MessageType$, - ChatMessage$inboundSchema, - ChatMessage$Outbound, - ChatMessage$outboundSchema, - ChatMessage$, - chatMessageCitationToJSON, - chatMessageCitationFromJSON, - ChatMessageCitation, - ChatMessageCitation$inboundSchema, - ChatMessageCitation$Outbound, - ChatMessageCitation$outboundSchema, - ChatMessageCitation$, - chatMessageFragmentToJSON, - chatMessageFragmentFromJSON, - ChatMessageFragment, - ChatMessageFragment$inboundSchema, - ChatMessageFragment$Outbound, - ChatMessageFragment$outboundSchema, - ChatMessageFragment$, - chatMetadataToJSON, - chatMetadataFromJSON, - ChatMetadata, - ChatMetadata$inboundSchema, - ChatMetadata$Outbound, - ChatMetadata$outboundSchema, - ChatMetadata$, - chatMetadataResultToJSON, - chatMetadataResultFromJSON, - ChatMetadataResult, - ChatMetadataResult$inboundSchema, - ChatMetadataResult$Outbound, - ChatMetadataResult$outboundSchema, - ChatMetadataResult$, - chatRequestToJSON, - chatRequestFromJSON, - ChatRequest, - ChatRequest$inboundSchema, - ChatRequest$Outbound, - ChatRequest$outboundSchema, - ChatRequest$, - chatResponseToJSON, - chatResponseFromJSON, - ChatResponse, - ChatResponse$inboundSchema, - ChatResponse$Outbound, - ChatResponse$outboundSchema, - ChatResponse$, - chatRestrictionFiltersToJSON, - chatRestrictionFiltersFromJSON, - ChatRestrictionFilters, - ChatRestrictionFilters$inboundSchema, - ChatRestrictionFilters$Outbound, - ChatRestrictionFilters$outboundSchema, - ChatRestrictionFilters$, - chatResultToJSON, - chatResultFromJSON, - ChatResult, - ChatResult$inboundSchema, - ChatResult$Outbound, - ChatResult$outboundSchema, - ChatResult$, - chatSuggestionToJSON, - chatSuggestionFromJSON, - ChatSuggestion, - ChatSuggestion$inboundSchema, - ChatSuggestion$Outbound, - ChatSuggestion$outboundSchema, - ChatSuggestion$, - chatZeroStateSuggestionOptionsToJSON, - chatZeroStateSuggestionOptionsFromJSON, - ChatZeroStateSuggestionOptions, - ChatZeroStateSuggestionOptions$inboundSchema, - ChatZeroStateSuggestionOptions$Outbound, - ChatZeroStateSuggestionOptions$outboundSchema, - ChatZeroStateSuggestionOptions$, - checkDocumentAccessRequestToJSON, - checkDocumentAccessRequestFromJSON, - CheckDocumentAccessRequest, - CheckDocumentAccessRequest$inboundSchema, - CheckDocumentAccessRequest$Outbound, - CheckDocumentAccessRequest$outboundSchema, - CheckDocumentAccessRequest$, - checkDocumentAccessResponseToJSON, - checkDocumentAccessResponseFromJSON, - CheckDocumentAccessResponse, - CheckDocumentAccessResponse$inboundSchema, - CheckDocumentAccessResponse$Outbound, - CheckDocumentAccessResponse$outboundSchema, - CheckDocumentAccessResponse$, - clusterGroupToJSON, - clusterGroupFromJSON, - ClusterGroup, - ClusterGroup$inboundSchema, - ClusterGroup$Outbound, - ClusterGroup$outboundSchema, - ClusterGroup$, - ClusterTypeEnum, - ClusterTypeEnum$inboundSchema, - ClusterTypeEnum$outboundSchema, - ClusterTypeEnum$, - codeToJSON, - codeFromJSON, - Code, - Code$inboundSchema, - Code$Outbound, - Code$outboundSchema, - Code$, - codeLineToJSON, - codeLineFromJSON, - CodeLine, - CodeLine$inboundSchema, - CodeLine$Outbound, - CodeLine$outboundSchema, - CodeLine$, - collectionToJSON, - collectionFromJSON, - Collection, - Collection$inboundSchema, - Collection$Outbound, - Collection$outboundSchema, - Collection$, - collectionErrorToJSON, - collectionErrorFromJSON, - CollectionErrorErrorCode, - CollectionError, - CollectionErrorErrorCode$inboundSchema, - CollectionErrorErrorCode$outboundSchema, - CollectionErrorErrorCode$, - CollectionError$inboundSchema, - CollectionError$Outbound, - CollectionError$outboundSchema, - CollectionError$, - collectionItemToJSON, - collectionItemFromJSON, - CollectionItemItemType, - CollectionItem, - CollectionItemItemType$inboundSchema, - CollectionItemItemType$outboundSchema, - CollectionItemItemType$, - CollectionItem$inboundSchema, - CollectionItem$Outbound, - CollectionItem$outboundSchema, - CollectionItem$, - collectionItemDescriptorToJSON, - collectionItemDescriptorFromJSON, - CollectionItemDescriptorItemType, - CollectionItemDescriptor, - CollectionItemDescriptorItemType$inboundSchema, - CollectionItemDescriptorItemType$outboundSchema, - CollectionItemDescriptorItemType$, - CollectionItemDescriptor$inboundSchema, - CollectionItemDescriptor$Outbound, - CollectionItemDescriptor$outboundSchema, - CollectionItemDescriptor$, - collectionPinMetadataToJSON, - collectionPinMetadataFromJSON, - CollectionPinMetadata, - CollectionPinMetadata$inboundSchema, - CollectionPinMetadata$Outbound, - CollectionPinMetadata$outboundSchema, - CollectionPinMetadata$, - CollectionPinnableCategories, - CollectionPinnableCategories$inboundSchema, - CollectionPinnableCategories$outboundSchema, - CollectionPinnableCategories$, - CollectionPinnableTargets, - CollectionPinnableTargets$inboundSchema, - CollectionPinnableTargets$outboundSchema, - CollectionPinnableTargets$, - collectionPinnedMetadataToJSON, - collectionPinnedMetadataFromJSON, - CollectionPinnedMetadata, - CollectionPinnedMetadata$inboundSchema, - CollectionPinnedMetadata$Outbound, - CollectionPinnedMetadata$outboundSchema, - CollectionPinnedMetadata$, - collectionPinTargetToJSON, - collectionPinTargetFromJSON, - CollectionPinTarget, - CollectionPinTarget$inboundSchema, - CollectionPinTarget$Outbound, - CollectionPinTarget$outboundSchema, - CollectionPinTarget$, - commentDefinitionToJSON, - commentDefinitionFromJSON, - CommentDefinition, - CommentDefinition$inboundSchema, - CommentDefinition$Outbound, - CommentDefinition$outboundSchema, - CommentDefinition$, - CommunicationChannel, - CommunicationChannel$inboundSchema, - CommunicationChannel$outboundSchema, - CommunicationChannel$, - companyToJSON, - companyFromJSON, - Company, - Company$inboundSchema, - Company$Outbound, - Company$outboundSchema, - Company$, - conferenceDataToJSON, - conferenceDataFromJSON, - Provider, - ConferenceDataSource, - ConferenceData, - Provider$inboundSchema, - Provider$outboundSchema, - Provider$, - ConferenceDataSource$inboundSchema, - ConferenceDataSource$outboundSchema, - ConferenceDataSource$, - ConferenceData$inboundSchema, - ConferenceData$Outbound, - ConferenceData$outboundSchema, - ConferenceData$, - ConnectorType, - ConnectorType$inboundSchema, - ConnectorType$outboundSchema, - ConnectorType$, - contentDefinitionToJSON, - contentDefinitionFromJSON, - ContentDefinition, - ContentDefinition$inboundSchema, - ContentDefinition$Outbound, - ContentDefinition$outboundSchema, - ContentDefinition$, - contentInsightsResponseToJSON, - contentInsightsResponseFromJSON, - ContentInsightsResponse, - ContentInsightsResponse$inboundSchema, - ContentInsightsResponse$Outbound, - ContentInsightsResponse$outboundSchema, - ContentInsightsResponse$, - ContentType, - ContentType$inboundSchema, - ContentType$outboundSchema, - ContentType$, - countInfoToJSON, - countInfoFromJSON, - CountInfo, - CountInfo$inboundSchema, - CountInfo$Outbound, - CountInfo$outboundSchema, - CountInfo$, - createAnnouncementRequestToJSON, - createAnnouncementRequestFromJSON, - CreateAnnouncementRequestChannel, - CreateAnnouncementRequestPostType, - CreateAnnouncementRequest, - CreateAnnouncementRequestChannel$inboundSchema, - CreateAnnouncementRequestChannel$outboundSchema, - CreateAnnouncementRequestChannel$, - CreateAnnouncementRequestPostType$inboundSchema, - CreateAnnouncementRequestPostType$outboundSchema, - CreateAnnouncementRequestPostType$, - CreateAnnouncementRequest$inboundSchema, - CreateAnnouncementRequest$Outbound, - CreateAnnouncementRequest$outboundSchema, - CreateAnnouncementRequest$, - createAnswerRequestToJSON, - createAnswerRequestFromJSON, - CreateAnswerRequest, - CreateAnswerRequest$inboundSchema, - CreateAnswerRequest$Outbound, - CreateAnswerRequest$outboundSchema, - CreateAnswerRequest$, - createAuthTokenResponseToJSON, - createAuthTokenResponseFromJSON, - CreateAuthTokenResponse, - CreateAuthTokenResponse$inboundSchema, - CreateAuthTokenResponse$Outbound, - CreateAuthTokenResponse$outboundSchema, - CreateAuthTokenResponse$, - createCollectionRequestToJSON, - createCollectionRequestFromJSON, - CreateCollectionRequest, - CreateCollectionRequest$inboundSchema, - CreateCollectionRequest$Outbound, - CreateCollectionRequest$outboundSchema, - CreateCollectionRequest$, - createDlpReportRequestToJSON, - createDlpReportRequestFromJSON, - CreateDlpReportRequest, - CreateDlpReportRequest$inboundSchema, - CreateDlpReportRequest$Outbound, - CreateDlpReportRequest$outboundSchema, - CreateDlpReportRequest$, - createDlpReportResponseToJSON, - createDlpReportResponseFromJSON, - CreateDlpReportResponse, - CreateDlpReportResponse$inboundSchema, - CreateDlpReportResponse$Outbound, - CreateDlpReportResponse$outboundSchema, - CreateDlpReportResponse$, - createShortcutRequestToJSON, - createShortcutRequestFromJSON, - CreateShortcutRequest, - CreateShortcutRequest$inboundSchema, - CreateShortcutRequest$Outbound, - CreateShortcutRequest$outboundSchema, - CreateShortcutRequest$, - createShortcutResponseToJSON, - createShortcutResponseFromJSON, - CreateShortcutResponse, - CreateShortcutResponse$inboundSchema, - CreateShortcutResponse$Outbound, - CreateShortcutResponse$outboundSchema, - CreateShortcutResponse$, - customDatasourceConfigToJSON, - customDatasourceConfigFromJSON, - DatasourceCategory, - HideBuiltInFacet, - CustomDatasourceConfigConnectorType, - CustomDatasourceConfig, - DatasourceCategory$inboundSchema, - DatasourceCategory$outboundSchema, - DatasourceCategory$, - HideBuiltInFacet$inboundSchema, - HideBuiltInFacet$outboundSchema, - HideBuiltInFacet$, - CustomDatasourceConfigConnectorType$inboundSchema, - CustomDatasourceConfigConnectorType$outboundSchema, - CustomDatasourceConfigConnectorType$, - CustomDatasourceConfig$inboundSchema, - CustomDatasourceConfig$Outbound, - CustomDatasourceConfig$outboundSchema, - CustomDatasourceConfig$, - customDataValueToJSON, - customDataValueFromJSON, - CustomDataValue, - CustomDataValue$inboundSchema, - CustomDataValue$Outbound, - CustomDataValue$outboundSchema, - CustomDataValue$, - customEntityToJSON, - customEntityFromJSON, - CustomEntity, - CustomEntity$inboundSchema, - CustomEntity$Outbound, - CustomEntity$outboundSchema, - CustomEntity$, - customEntityMetadataToJSON, - customEntityMetadataFromJSON, - CustomEntityMetadata, - CustomEntityMetadata$inboundSchema, - CustomEntityMetadata$Outbound, - CustomEntityMetadata$outboundSchema, - CustomEntityMetadata$, - customerToJSON, - customerFromJSON, - Customer, - Customer$inboundSchema, - Customer$Outbound, - Customer$outboundSchema, - Customer$, - customerMetadataToJSON, - customerMetadataFromJSON, - CustomerMetadata, - CustomerMetadata$inboundSchema, - CustomerMetadata$Outbound, - CustomerMetadata$outboundSchema, - CustomerMetadata$, - customFieldDataToJSON, - customFieldDataFromJSON, - CustomFieldData, - CustomFieldData$inboundSchema, - CustomFieldData$Outbound, - CustomFieldData$outboundSchema, - CustomFieldData$, - customFieldValueToJSON, - customFieldValueFromJSON, - CustomFieldValue, - CustomFieldValue$inboundSchema, - CustomFieldValue$Outbound, - CustomFieldValue$outboundSchema, - CustomFieldValue$, - customFieldValueHyperlinkToJSON, - customFieldValueHyperlinkFromJSON, - CustomFieldValueHyperlink, - CustomFieldValueHyperlink$inboundSchema, - CustomFieldValueHyperlink$Outbound, - CustomFieldValueHyperlink$outboundSchema, - CustomFieldValueHyperlink$, - customFieldValuePersonToJSON, - customFieldValuePersonFromJSON, - CustomFieldValuePerson, - CustomFieldValuePerson$inboundSchema, - CustomFieldValuePerson$Outbound, - CustomFieldValuePerson$outboundSchema, - CustomFieldValuePerson$, - customFieldValueStrToJSON, - customFieldValueStrFromJSON, - CustomFieldValueStr, - CustomFieldValueStr$inboundSchema, - CustomFieldValueStr$Outbound, - CustomFieldValueStr$outboundSchema, - CustomFieldValueStr$, - customPropertyToJSON, - customPropertyFromJSON, - CustomProperty, - CustomProperty$inboundSchema, - CustomProperty$Outbound, - CustomProperty$outboundSchema, - CustomProperty$, - datasourceBulkMembershipDefinitionToJSON, - datasourceBulkMembershipDefinitionFromJSON, - DatasourceBulkMembershipDefinition, - DatasourceBulkMembershipDefinition$inboundSchema, - DatasourceBulkMembershipDefinition$Outbound, - DatasourceBulkMembershipDefinition$outboundSchema, - DatasourceBulkMembershipDefinition$, - datasourceGroupDefinitionToJSON, - datasourceGroupDefinitionFromJSON, - DatasourceGroupDefinition, - DatasourceGroupDefinition$inboundSchema, - DatasourceGroupDefinition$Outbound, - DatasourceGroupDefinition$outboundSchema, - DatasourceGroupDefinition$, - datasourceMembershipDefinitionToJSON, - datasourceMembershipDefinitionFromJSON, - DatasourceMembershipDefinition, - DatasourceMembershipDefinition$inboundSchema, - DatasourceMembershipDefinition$Outbound, - DatasourceMembershipDefinition$outboundSchema, - DatasourceMembershipDefinition$, - datasourceObjectTypeDocumentCountEntryToJSON, - datasourceObjectTypeDocumentCountEntryFromJSON, - DatasourceObjectTypeDocumentCountEntry, - DatasourceObjectTypeDocumentCountEntry$inboundSchema, - DatasourceObjectTypeDocumentCountEntry$Outbound, - DatasourceObjectTypeDocumentCountEntry$outboundSchema, - DatasourceObjectTypeDocumentCountEntry$, - datasourceProfileToJSON, - datasourceProfileFromJSON, - DatasourceProfile, - DatasourceProfile$inboundSchema, - DatasourceProfile$Outbound, - DatasourceProfile$outboundSchema, - DatasourceProfile$, - datasourceUserDefinitionToJSON, - datasourceUserDefinitionFromJSON, - DatasourceUserDefinition, - DatasourceUserDefinition$inboundSchema, - DatasourceUserDefinition$Outbound, - DatasourceUserDefinition$outboundSchema, - DatasourceUserDefinition$, - debugDatasourceStatusIdentityResponseComponentCountsToJSON, - debugDatasourceStatusIdentityResponseComponentCountsFromJSON, - debugDatasourceStatusIdentityResponseComponentToJSON, - debugDatasourceStatusIdentityResponseComponentFromJSON, - DebugDatasourceStatusIdentityResponseComponentCounts, - DebugDatasourceStatusIdentityResponseComponent, - DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema, - DebugDatasourceStatusIdentityResponseComponentCounts$Outbound, - DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema, - DebugDatasourceStatusIdentityResponseComponentCounts$, - DebugDatasourceStatusIdentityResponseComponent$inboundSchema, - DebugDatasourceStatusIdentityResponseComponent$Outbound, - DebugDatasourceStatusIdentityResponseComponent$outboundSchema, - DebugDatasourceStatusIdentityResponseComponent$, - debugDatasourceStatusResponseCountsToJSON, - debugDatasourceStatusResponseCountsFromJSON, - documentsToJSON, - documentsFromJSON, - identityToJSON, - identityFromJSON, - debugDatasourceStatusResponseToJSON, - debugDatasourceStatusResponseFromJSON, - DebugDatasourceStatusResponseCounts, - Documents, - Identity, - DatasourceVisibility, - DebugDatasourceStatusResponse, - DebugDatasourceStatusResponseCounts$inboundSchema, - DebugDatasourceStatusResponseCounts$Outbound, - DebugDatasourceStatusResponseCounts$outboundSchema, - DebugDatasourceStatusResponseCounts$, - Documents$inboundSchema, - Documents$Outbound, - Documents$outboundSchema, - Documents$, - Identity$inboundSchema, - Identity$Outbound, - Identity$outboundSchema, - Identity$, - DatasourceVisibility$inboundSchema, - DatasourceVisibility$outboundSchema, - DatasourceVisibility$, - DebugDatasourceStatusResponse$inboundSchema, - DebugDatasourceStatusResponse$Outbound, - DebugDatasourceStatusResponse$outboundSchema, - DebugDatasourceStatusResponse$, - debugDocumentRequestToJSON, - debugDocumentRequestFromJSON, - DebugDocumentRequest, - DebugDocumentRequest$inboundSchema, - DebugDocumentRequest$Outbound, - DebugDocumentRequest$outboundSchema, - DebugDocumentRequest$, - debugDocumentResponseToJSON, - debugDocumentResponseFromJSON, - DebugDocumentResponse, - DebugDocumentResponse$inboundSchema, - DebugDocumentResponse$Outbound, - DebugDocumentResponse$outboundSchema, - DebugDocumentResponse$, - debugDocumentsRequestToJSON, - debugDocumentsRequestFromJSON, - DebugDocumentsRequest, - DebugDocumentsRequest$inboundSchema, - DebugDocumentsRequest$Outbound, - DebugDocumentsRequest$outboundSchema, - DebugDocumentsRequest$, - debugDocumentsResponseToJSON, - debugDocumentsResponseFromJSON, - DebugDocumentsResponse, - DebugDocumentsResponse$inboundSchema, - DebugDocumentsResponse$Outbound, - DebugDocumentsResponse$outboundSchema, - DebugDocumentsResponse$, - debugDocumentsResponseItemToJSON, - debugDocumentsResponseItemFromJSON, - DebugDocumentsResponseItem, - DebugDocumentsResponseItem$inboundSchema, - DebugDocumentsResponseItem$Outbound, - DebugDocumentsResponseItem$outboundSchema, - DebugDocumentsResponseItem$, - debugUserRequestToJSON, - debugUserRequestFromJSON, - DebugUserRequest, - DebugUserRequest$inboundSchema, - DebugUserRequest$Outbound, - DebugUserRequest$outboundSchema, - DebugUserRequest$, - debugUserResponseToJSON, - debugUserResponseFromJSON, - DebugUserResponse, - DebugUserResponse$inboundSchema, - DebugUserResponse$Outbound, - DebugUserResponse$outboundSchema, - DebugUserResponse$, - deleteAnnouncementRequestToJSON, - deleteAnnouncementRequestFromJSON, - DeleteAnnouncementRequest, - DeleteAnnouncementRequest$inboundSchema, - DeleteAnnouncementRequest$Outbound, - DeleteAnnouncementRequest$outboundSchema, - DeleteAnnouncementRequest$, - deleteAnswerRequestToJSON, - deleteAnswerRequestFromJSON, - DeleteAnswerRequest, - DeleteAnswerRequest$inboundSchema, - DeleteAnswerRequest$Outbound, - DeleteAnswerRequest$outboundSchema, - DeleteAnswerRequest$, - deleteChatFilesRequestToJSON, - deleteChatFilesRequestFromJSON, - DeleteChatFilesRequest, - DeleteChatFilesRequest$inboundSchema, - DeleteChatFilesRequest$Outbound, - DeleteChatFilesRequest$outboundSchema, - DeleteChatFilesRequest$, - deleteChatsRequestToJSON, - deleteChatsRequestFromJSON, - DeleteChatsRequest, - DeleteChatsRequest$inboundSchema, - DeleteChatsRequest$Outbound, - DeleteChatsRequest$outboundSchema, - DeleteChatsRequest$, - deleteCollectionItemRequestToJSON, - deleteCollectionItemRequestFromJSON, - DeleteCollectionItemRequest, - DeleteCollectionItemRequest$inboundSchema, - DeleteCollectionItemRequest$Outbound, - DeleteCollectionItemRequest$outboundSchema, - DeleteCollectionItemRequest$, - deleteCollectionItemResponseToJSON, - deleteCollectionItemResponseFromJSON, - DeleteCollectionItemResponse, - DeleteCollectionItemResponse$inboundSchema, - DeleteCollectionItemResponse$Outbound, - DeleteCollectionItemResponse$outboundSchema, - DeleteCollectionItemResponse$, - deleteCollectionRequestToJSON, - deleteCollectionRequestFromJSON, - DeleteCollectionRequest, - DeleteCollectionRequest$inboundSchema, - DeleteCollectionRequest$Outbound, - DeleteCollectionRequest$outboundSchema, - DeleteCollectionRequest$, - deleteDocumentRequestToJSON, - deleteDocumentRequestFromJSON, - DeleteDocumentRequest, - DeleteDocumentRequest$inboundSchema, - DeleteDocumentRequest$Outbound, - DeleteDocumentRequest$outboundSchema, - DeleteDocumentRequest$, - deleteEmployeeRequestToJSON, - deleteEmployeeRequestFromJSON, - DeleteEmployeeRequest, - DeleteEmployeeRequest$inboundSchema, - DeleteEmployeeRequest$Outbound, - DeleteEmployeeRequest$outboundSchema, - DeleteEmployeeRequest$, - deleteGroupRequestToJSON, - deleteGroupRequestFromJSON, - DeleteGroupRequest, - DeleteGroupRequest$inboundSchema, - DeleteGroupRequest$Outbound, - DeleteGroupRequest$outboundSchema, - DeleteGroupRequest$, - deleteMembershipRequestToJSON, - deleteMembershipRequestFromJSON, - DeleteMembershipRequest, - DeleteMembershipRequest$inboundSchema, - DeleteMembershipRequest$Outbound, - DeleteMembershipRequest$outboundSchema, - DeleteMembershipRequest$, - deleteShortcutRequestToJSON, - deleteShortcutRequestFromJSON, - DeleteShortcutRequest, - DeleteShortcutRequest$inboundSchema, - DeleteShortcutRequest$Outbound, - DeleteShortcutRequest$outboundSchema, - DeleteShortcutRequest$, - deleteTeamRequestToJSON, - deleteTeamRequestFromJSON, - DeleteTeamRequest, - DeleteTeamRequest$inboundSchema, - DeleteTeamRequest$Outbound, - DeleteTeamRequest$outboundSchema, - DeleteTeamRequest$, - deleteUserRequestToJSON, - deleteUserRequestFromJSON, - DeleteUserRequest, - DeleteUserRequest$inboundSchema, - DeleteUserRequest$Outbound, - DeleteUserRequest$outboundSchema, - DeleteUserRequest$, - digestToJSON, - digestFromJSON, - Digest, - Digest$inboundSchema, - Digest$Outbound, - Digest$outboundSchema, - Digest$, - digestSectionToJSON, - digestSectionFromJSON, - DigestSection, - DigestSection$inboundSchema, - DigestSection$Outbound, - DigestSection$outboundSchema, - DigestSection$, - digestUpdateToJSON, - digestUpdateFromJSON, - DigestUpdate, - DigestUpdate$inboundSchema, - DigestUpdate$Outbound, - DigestUpdate$outboundSchema, - DigestUpdate$, - disambiguationToJSON, - disambiguationFromJSON, - Disambiguation, - Disambiguation$inboundSchema, - Disambiguation$Outbound, - Disambiguation$outboundSchema, - Disambiguation$, - displayableListItemUIConfigToJSON, - displayableListItemUIConfigFromJSON, - DisplayableListItemUIConfig, - DisplayableListItemUIConfig$inboundSchema, - DisplayableListItemUIConfig$Outbound, - DisplayableListItemUIConfig$outboundSchema, - DisplayableListItemUIConfig$, - dlpConfigToJSON, - dlpConfigFromJSON, - DlpConfig, - DlpConfig$inboundSchema, - DlpConfig$Outbound, - DlpConfig$outboundSchema, - DlpConfig$, - DlpFrequency, - DlpFrequency$inboundSchema, - DlpFrequency$outboundSchema, - DlpFrequency$, - dlpPersonToJSON, - dlpPersonFromJSON, - DlpPerson, - DlpPerson$inboundSchema, - DlpPerson$Outbound, - DlpPerson$outboundSchema, - DlpPerson$, - dlpPersonMetadataToJSON, - dlpPersonMetadataFromJSON, - DlpPersonMetadata, - DlpPersonMetadata$inboundSchema, - DlpPersonMetadata$Outbound, - DlpPersonMetadata$outboundSchema, - DlpPersonMetadata$, - dlpReportToJSON, - dlpReportFromJSON, - LastScanStatus, - DlpReport, - LastScanStatus$inboundSchema, - LastScanStatus$outboundSchema, - LastScanStatus$, - DlpReport$inboundSchema, - DlpReport$Outbound, - DlpReport$outboundSchema, - DlpReport$, - DlpReportStatus, - DlpReportStatus$inboundSchema, - DlpReportStatus$outboundSchema, - DlpReportStatus$, - DlpSimpleResult, - DlpSimpleResult$inboundSchema, - DlpSimpleResult$outboundSchema, - DlpSimpleResult$, - documentToJSON, - documentFromJSON, - Document_2 as Document, - Document$inboundSchema, - Document$Outbound, - Document$outboundSchema, - Document$, - documentContentToJSON, - documentContentFromJSON, - DocumentContent, - DocumentContent$inboundSchema, - DocumentContent$Outbound, - DocumentContent$outboundSchema, - DocumentContent$, - documentDefinitionToJSON, - documentDefinitionFromJSON, - DocumentDefinition, - DocumentDefinition$inboundSchema, - DocumentDefinition$Outbound, - DocumentDefinition$outboundSchema, - DocumentDefinition$, - documentInsightToJSON, - documentInsightFromJSON, - DocumentInsight, - DocumentInsight$inboundSchema, - DocumentInsight$Outbound, - DocumentInsight$outboundSchema, - DocumentInsight$, - documentInteractionsToJSON, - documentInteractionsFromJSON, - DocumentInteractions, - DocumentInteractions$inboundSchema, - DocumentInteractions$Outbound, - DocumentInteractions$outboundSchema, - DocumentInteractions$, - documentInteractionsDefinitionToJSON, - documentInteractionsDefinitionFromJSON, - DocumentInteractionsDefinition, - DocumentInteractionsDefinition$inboundSchema, - DocumentInteractionsDefinition$Outbound, - DocumentInteractionsDefinition$outboundSchema, - DocumentInteractionsDefinition$, - documentMetadataToJSON, - documentMetadataFromJSON, - DocumentMetadata, - DocumentMetadata$inboundSchema, - DocumentMetadata$Outbound, - DocumentMetadata$outboundSchema, - DocumentMetadata$, - documentOrErrorToJSON, - documentOrErrorFromJSON, - documentOrErrorUnionToJSON, - documentOrErrorUnionFromJSON, - DocumentOrError, - DocumentOrErrorUnion, - DocumentOrError$inboundSchema, - DocumentOrError$Outbound, - DocumentOrError$outboundSchema, - DocumentOrError$, - DocumentOrErrorUnion$inboundSchema, - DocumentOrErrorUnion$Outbound, - DocumentOrErrorUnion$outboundSchema, - DocumentOrErrorUnion$, - documentPermissionsDefinitionToJSON, - documentPermissionsDefinitionFromJSON, - DocumentPermissionsDefinition, - DocumentPermissionsDefinition$inboundSchema, - DocumentPermissionsDefinition$Outbound, - DocumentPermissionsDefinition$outboundSchema, - DocumentPermissionsDefinition$, - documentSectionToJSON, - documentSectionFromJSON, - DocumentSection, - DocumentSection$inboundSchema, - DocumentSection$Outbound, - DocumentSection$outboundSchema, - DocumentSection$, - documentSpec4ToJSON, - documentSpec4FromJSON, - documentSpec3ToJSON, - documentSpec3FromJSON, - documentSpec2ToJSON, - documentSpec2FromJSON, - documentSpec1ToJSON, - documentSpec1FromJSON, - documentSpecUnionToJSON, - documentSpecUnionFromJSON, - DocumentSpecUgcType2, - DocumentSpec4, - DocumentSpecUgcType1, - DocumentSpec3, - DocumentSpec2, - DocumentSpec1, - DocumentSpecUnion, - DocumentSpecUgcType2$inboundSchema, - DocumentSpecUgcType2$outboundSchema, - DocumentSpecUgcType2$, - DocumentSpec4$inboundSchema, - DocumentSpec4$Outbound, - DocumentSpec4$outboundSchema, - DocumentSpec4$, - DocumentSpecUgcType1$inboundSchema, - DocumentSpecUgcType1$outboundSchema, - DocumentSpecUgcType1$, - DocumentSpec3$inboundSchema, - DocumentSpec3$Outbound, - DocumentSpec3$outboundSchema, - DocumentSpec3$, - DocumentSpec2$inboundSchema, - DocumentSpec2$Outbound, - DocumentSpec2$outboundSchema, - DocumentSpec2$, - DocumentSpec1$inboundSchema, - DocumentSpec1$Outbound, - DocumentSpec1$outboundSchema, - DocumentSpec1$, - DocumentSpecUnion$inboundSchema, - DocumentSpecUnion$Outbound, - DocumentSpecUnion$outboundSchema, - DocumentSpecUnion$, - documentStatusResponseToJSON, - documentStatusResponseFromJSON, - DocumentStatusResponse, - DocumentStatusResponse$inboundSchema, - DocumentStatusResponse$Outbound, - DocumentStatusResponse$outboundSchema, - DocumentStatusResponse$, - DocumentVisibility, - DocumentVisibility$inboundSchema, - DocumentVisibility$outboundSchema, - DocumentVisibility$, - documentVisibilityOverrideToJSON, - documentVisibilityOverrideFromJSON, - DocumentVisibilityOverrideOverride, - DocumentVisibilityOverride, - DocumentVisibilityOverrideOverride$inboundSchema, - DocumentVisibilityOverrideOverride$outboundSchema, - DocumentVisibilityOverrideOverride$, - DocumentVisibilityOverride$inboundSchema, - DocumentVisibilityOverride$Outbound, - DocumentVisibilityOverride$outboundSchema, - DocumentVisibilityOverride$, - documentVisibilityUpdateResultToJSON, - documentVisibilityUpdateResultFromJSON, - DocumentVisibilityUpdateResultOverride, - DocumentVisibilityUpdateResult, - DocumentVisibilityUpdateResultOverride$inboundSchema, - DocumentVisibilityUpdateResultOverride$outboundSchema, - DocumentVisibilityUpdateResultOverride$, - DocumentVisibilityUpdateResult$inboundSchema, - DocumentVisibilityUpdateResult$Outbound, - DocumentVisibilityUpdateResult$outboundSchema, - DocumentVisibilityUpdateResult$, - editAnswerRequestToJSON, - editAnswerRequestFromJSON, - EditAnswerRequestSourceType, - EditAnswerRequest, - EditAnswerRequestSourceType$inboundSchema, - EditAnswerRequestSourceType$outboundSchema, - EditAnswerRequestSourceType$, - EditAnswerRequest$inboundSchema, - EditAnswerRequest$Outbound, - EditAnswerRequest$outboundSchema, - EditAnswerRequest$, - editCollectionItemRequestToJSON, - editCollectionItemRequestFromJSON, - EditCollectionItemRequest, - EditCollectionItemRequest$inboundSchema, - EditCollectionItemRequest$Outbound, - EditCollectionItemRequest$outboundSchema, - EditCollectionItemRequest$, - editCollectionItemResponseToJSON, - editCollectionItemResponseFromJSON, - EditCollectionItemResponse, - EditCollectionItemResponse$inboundSchema, - EditCollectionItemResponse$Outbound, - EditCollectionItemResponse$outboundSchema, - EditCollectionItemResponse$, - editCollectionRequestToJSON, - editCollectionRequestFromJSON, - EditCollectionRequest, - EditCollectionRequest$inboundSchema, - EditCollectionRequest$Outbound, - EditCollectionRequest$outboundSchema, - EditCollectionRequest$, - editCollectionResponseToJSON, - editCollectionResponseFromJSON, - EditCollectionResponseErrorCode, - EditCollectionResponse, - EditCollectionResponseErrorCode$inboundSchema, - EditCollectionResponseErrorCode$outboundSchema, - EditCollectionResponseErrorCode$, - EditCollectionResponse$inboundSchema, - EditCollectionResponse$Outbound, - EditCollectionResponse$outboundSchema, - EditCollectionResponse$, - editPinRequestToJSON, - editPinRequestFromJSON, - EditPinRequest, - EditPinRequest$inboundSchema, - EditPinRequest$Outbound, - EditPinRequest$outboundSchema, - EditPinRequest$, - employeeInfoDefinitionToJSON, - employeeInfoDefinitionFromJSON, - EmployeeInfoDefinition, - EmployeeInfoDefinition$inboundSchema, - EmployeeInfoDefinition$Outbound, - EmployeeInfoDefinition$outboundSchema, - EmployeeInfoDefinition$, - employeeTeamInfoToJSON, - employeeTeamInfoFromJSON, - EmployeeTeamInfo, - EmployeeTeamInfo$inboundSchema, - EmployeeTeamInfo$Outbound, - EmployeeTeamInfo$outboundSchema, - EmployeeTeamInfo$, - EntitiesSortOrder, - EntitiesSortOrder$inboundSchema, - EntitiesSortOrder$outboundSchema, - EntitiesSortOrder$, - entityRelationshipToJSON, - entityRelationshipFromJSON, - EntityRelationship, - EntityRelationship$inboundSchema, - EntityRelationship$Outbound, - EntityRelationship$outboundSchema, - EntityRelationship$, - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, - EntityType$, - errorMessageToJSON, - errorMessageFromJSON, - ErrorMessage, - ErrorMessage$inboundSchema, - ErrorMessage$Outbound, - ErrorMessage$outboundSchema, - ErrorMessage$, - eventClassificationToJSON, - eventClassificationFromJSON, - EventClassification, - EventClassification$inboundSchema, - EventClassification$Outbound, - EventClassification$outboundSchema, - EventClassification$, - EventClassificationName, - EventClassificationName$inboundSchema, - EventClassificationName$outboundSchema, - EventClassificationName$, - EventStrategyName, - EventStrategyName$inboundSchema, - EventStrategyName$outboundSchema, - EventStrategyName$, - externalSharingOptionsToJSON, - externalSharingOptionsFromJSON, - ExternalSharingOptions, - ExternalSharingOptions$inboundSchema, - ExternalSharingOptions$Outbound, - ExternalSharingOptions$outboundSchema, - ExternalSharingOptions$, - externalShortcutToJSON, - externalShortcutFromJSON, - ExternalShortcut, - ExternalShortcut$inboundSchema, - ExternalShortcut$Outbound, - ExternalShortcut$outboundSchema, - ExternalShortcut$, - extractedQnAToJSON, - extractedQnAFromJSON, - ExtractedQnA, - ExtractedQnA$inboundSchema, - ExtractedQnA$Outbound, - ExtractedQnA$outboundSchema, - ExtractedQnA$, - facetBucketToJSON, - facetBucketFromJSON, - FacetBucket, - FacetBucket$inboundSchema, - FacetBucket$Outbound, - FacetBucket$outboundSchema, - FacetBucket$, - facetBucketFilterToJSON, - facetBucketFilterFromJSON, - FacetBucketFilter, - FacetBucketFilter$inboundSchema, - FacetBucketFilter$Outbound, - FacetBucketFilter$outboundSchema, - FacetBucketFilter$, - facetFilterToJSON, - facetFilterFromJSON, - FacetFilter, - FacetFilter$inboundSchema, - FacetFilter$Outbound, - FacetFilter$outboundSchema, - FacetFilter$, - facetFilterSetToJSON, - facetFilterSetFromJSON, - FacetFilterSet, - FacetFilterSet$inboundSchema, - FacetFilterSet$Outbound, - FacetFilterSet$outboundSchema, - FacetFilterSet$, - facetFilterValueToJSON, - facetFilterValueFromJSON, - RelationType, - FacetFilterValue, - RelationType$inboundSchema, - RelationType$outboundSchema, - RelationType$, - FacetFilterValue$inboundSchema, - FacetFilterValue$Outbound, - FacetFilterValue$outboundSchema, - FacetFilterValue$, - facetResultToJSON, - facetResultFromJSON, - FacetResult, - FacetResult$inboundSchema, - FacetResult$Outbound, - FacetResult$outboundSchema, - FacetResult$, - facetValueToJSON, - facetValueFromJSON, - FacetValue, - FacetValue$inboundSchema, - FacetValue$Outbound, - FacetValue$outboundSchema, - FacetValue$, - favoriteInfoToJSON, - favoriteInfoFromJSON, - FavoriteInfo, - FavoriteInfo$inboundSchema, - FavoriteInfo$Outbound, - FavoriteInfo$outboundSchema, - FavoriteInfo$, - feedbackToJSON, - feedbackFromJSON, - FeedbackCategory, - Event_2 as Event, - FeedbackChannel, - Feedback, - FeedbackCategory$inboundSchema, - FeedbackCategory$outboundSchema, - FeedbackCategory$, - Event$inboundSchema, - Event$outboundSchema, - Event$, - FeedbackChannel$inboundSchema, - FeedbackChannel$outboundSchema, - FeedbackChannel$, - Feedback$inboundSchema, - Feedback$Outbound, - Feedback$outboundSchema, - Feedback$, - resultDocumentToJSON, - resultDocumentFromJSON, - feedbackChatExchangeToJSON, - feedbackChatExchangeFromJSON, - ResultDocument, - FeedbackChatExchange, - ResultDocument$inboundSchema, - ResultDocument$Outbound, - ResultDocument$outboundSchema, - ResultDocument$, - FeedbackChatExchange$inboundSchema, - FeedbackChatExchange$Outbound, - FeedbackChatExchange$outboundSchema, - FeedbackChatExchange$, - uiConfigToJSON, - uiConfigFromJSON, - feedEntryToJSON, - feedEntryFromJSON, - Format, - UiConfig, - JustificationType, - FeedEntry, - Format$inboundSchema, - Format$outboundSchema, - Format$, - UiConfig$inboundSchema, - UiConfig$Outbound, - UiConfig$outboundSchema, - UiConfig$, - JustificationType$inboundSchema, - JustificationType$outboundSchema, - JustificationType$, - FeedEntry$inboundSchema, - FeedEntry$Outbound, - FeedEntry$outboundSchema, - FeedEntry$, - feedRequestToJSON, - feedRequestFromJSON, - FeedRequestCategory, - FeedRequest, - FeedRequestCategory$inboundSchema, - FeedRequestCategory$outboundSchema, - FeedRequestCategory$, - FeedRequest$inboundSchema, - FeedRequest$Outbound, - FeedRequest$outboundSchema, - FeedRequest$, - categoryToResultSizeToJSON, - categoryToResultSizeFromJSON, - feedRequestOptionsToJSON, - feedRequestOptionsFromJSON, - CategoryToResultSize, - FeedRequestOptions, - CategoryToResultSize$inboundSchema, - CategoryToResultSize$Outbound, - CategoryToResultSize$outboundSchema, - CategoryToResultSize$, - FeedRequestOptions$inboundSchema, - FeedRequestOptions$Outbound, - FeedRequestOptions$outboundSchema, - FeedRequestOptions$, - feedResponseToJSON, - feedResponseFromJSON, - FeedResponse, - FeedResponse$inboundSchema, - FeedResponse$Outbound, - FeedResponse$outboundSchema, - FeedResponse$, - feedResultToJSON, - feedResultFromJSON, - FeedResultCategory, - FeedResult, - FeedResultCategory$inboundSchema, - FeedResultCategory$outboundSchema, - FeedResultCategory$, - FeedResult$inboundSchema, - FeedResult$Outbound, - FeedResult$outboundSchema, - FeedResult$, - followupActionToJSON, - followupActionFromJSON, - FollowupAction, - FollowupAction$inboundSchema, - FollowupAction$Outbound, - FollowupAction$outboundSchema, - FollowupAction$, - generatedAttachmentToJSON, - generatedAttachmentFromJSON, - GeneratedAttachment, - GeneratedAttachment$inboundSchema, - GeneratedAttachment$Outbound, - GeneratedAttachment$outboundSchema, - GeneratedAttachment$, - generatedAttachmentContentToJSON, - generatedAttachmentContentFromJSON, - GeneratedAttachmentContent, - GeneratedAttachmentContent$inboundSchema, - GeneratedAttachmentContent$Outbound, - GeneratedAttachmentContent$outboundSchema, - GeneratedAttachmentContent$, - generatedQnaToJSON, - generatedQnaFromJSON, - GeneratedQnaStatus, - GeneratedQna, - GeneratedQnaStatus$inboundSchema, - GeneratedQnaStatus$outboundSchema, - GeneratedQnaStatus$, - GeneratedQna$inboundSchema, - GeneratedQna$Outbound, - GeneratedQna$outboundSchema, - GeneratedQna$, - getAnswerErrorToJSON, - getAnswerErrorFromJSON, - GetAnswerErrorErrorType, - GetAnswerError, - GetAnswerErrorErrorType$inboundSchema, - GetAnswerErrorErrorType$outboundSchema, - GetAnswerErrorErrorType$, - GetAnswerError$inboundSchema, - GetAnswerError$Outbound, - GetAnswerError$outboundSchema, - GetAnswerError$, - getAnswerRequestToJSON, - getAnswerRequestFromJSON, - GetAnswerRequest, - GetAnswerRequest$inboundSchema, - GetAnswerRequest$Outbound, - GetAnswerRequest$outboundSchema, - GetAnswerRequest$, - getAnswerResponseToJSON, - getAnswerResponseFromJSON, - GetAnswerResponse, - GetAnswerResponse$inboundSchema, - GetAnswerResponse$Outbound, - GetAnswerResponse$outboundSchema, - GetAnswerResponse$, - getChatApplicationRequestToJSON, - getChatApplicationRequestFromJSON, - GetChatApplicationRequest, - GetChatApplicationRequest$inboundSchema, - GetChatApplicationRequest$Outbound, - GetChatApplicationRequest$outboundSchema, - GetChatApplicationRequest$, - getChatApplicationResponseToJSON, - getChatApplicationResponseFromJSON, - GetChatApplicationResponse, - GetChatApplicationResponse$inboundSchema, - GetChatApplicationResponse$Outbound, - GetChatApplicationResponse$outboundSchema, - GetChatApplicationResponse$, - getChatFilesRequestToJSON, - getChatFilesRequestFromJSON, - GetChatFilesRequest, - GetChatFilesRequest$inboundSchema, - GetChatFilesRequest$Outbound, - GetChatFilesRequest$outboundSchema, - GetChatFilesRequest$, - getChatFilesResponseToJSON, - getChatFilesResponseFromJSON, - GetChatFilesResponse, - GetChatFilesResponse$inboundSchema, - GetChatFilesResponse$Outbound, - GetChatFilesResponse$outboundSchema, - GetChatFilesResponse$, - getChatRequestToJSON, - getChatRequestFromJSON, - GetChatRequest, - GetChatRequest$inboundSchema, - GetChatRequest$Outbound, - GetChatRequest$outboundSchema, - GetChatRequest$, - getChatResponseToJSON, - getChatResponseFromJSON, - GetChatResponse, - GetChatResponse$inboundSchema, - GetChatResponse$Outbound, - GetChatResponse$outboundSchema, - GetChatResponse$, - getCollectionRequestToJSON, - getCollectionRequestFromJSON, - GetCollectionRequest, - GetCollectionRequest$inboundSchema, - GetCollectionRequest$Outbound, - GetCollectionRequest$outboundSchema, - GetCollectionRequest$, - getCollectionResponseToJSON, - getCollectionResponseFromJSON, - GetCollectionResponse, - GetCollectionResponse$inboundSchema, - GetCollectionResponse$Outbound, - GetCollectionResponse$outboundSchema, - GetCollectionResponse$, - getDatasourceConfigRequestToJSON, - getDatasourceConfigRequestFromJSON, - GetDatasourceConfigRequest, - GetDatasourceConfigRequest$inboundSchema, - GetDatasourceConfigRequest$Outbound, - GetDatasourceConfigRequest$outboundSchema, - GetDatasourceConfigRequest$, - getDlpReportResponseToJSON, - getDlpReportResponseFromJSON, - GetDlpReportResponse, - GetDlpReportResponse$inboundSchema, - GetDlpReportResponse$Outbound, - GetDlpReportResponse$outboundSchema, - GetDlpReportResponse$, - getDocPermissionsRequestToJSON, - getDocPermissionsRequestFromJSON, - GetDocPermissionsRequest, - GetDocPermissionsRequest$inboundSchema, - GetDocPermissionsRequest$Outbound, - GetDocPermissionsRequest$outboundSchema, - GetDocPermissionsRequest$, - getDocPermissionsResponseToJSON, - getDocPermissionsResponseFromJSON, - GetDocPermissionsResponse, - GetDocPermissionsResponse$inboundSchema, - GetDocPermissionsResponse$Outbound, - GetDocPermissionsResponse$outboundSchema, - GetDocPermissionsResponse$, - getDocumentCountRequestToJSON, - getDocumentCountRequestFromJSON, - GetDocumentCountRequest, - GetDocumentCountRequest$inboundSchema, - GetDocumentCountRequest$Outbound, - GetDocumentCountRequest$outboundSchema, - GetDocumentCountRequest$, - getDocumentCountResponseToJSON, - getDocumentCountResponseFromJSON, - GetDocumentCountResponse, - GetDocumentCountResponse$inboundSchema, - GetDocumentCountResponse$Outbound, - GetDocumentCountResponse$outboundSchema, - GetDocumentCountResponse$, - getDocumentsByFacetsRequestToJSON, - getDocumentsByFacetsRequestFromJSON, - GetDocumentsByFacetsRequest, - GetDocumentsByFacetsRequest$inboundSchema, - GetDocumentsByFacetsRequest$Outbound, - GetDocumentsByFacetsRequest$outboundSchema, - GetDocumentsByFacetsRequest$, - getDocumentsByFacetsResponseToJSON, - getDocumentsByFacetsResponseFromJSON, - GetDocumentsByFacetsResponse, - GetDocumentsByFacetsResponse$inboundSchema, - GetDocumentsByFacetsResponse$Outbound, - GetDocumentsByFacetsResponse$outboundSchema, - GetDocumentsByFacetsResponse$, - getDocumentsRequestToJSON, - getDocumentsRequestFromJSON, - GetDocumentsRequestIncludeField, - GetDocumentsRequest, - GetDocumentsRequestIncludeField$inboundSchema, - GetDocumentsRequestIncludeField$outboundSchema, - GetDocumentsRequestIncludeField$, - GetDocumentsRequest$inboundSchema, - GetDocumentsRequest$Outbound, - GetDocumentsRequest$outboundSchema, - GetDocumentsRequest$, - getDocumentsResponseToJSON, - getDocumentsResponseFromJSON, - GetDocumentsResponse, - GetDocumentsResponse$inboundSchema, - GetDocumentsResponse$Outbound, - GetDocumentsResponse$outboundSchema, - GetDocumentsResponse$, - getDocumentStatusRequestToJSON, - getDocumentStatusRequestFromJSON, - GetDocumentStatusRequest, - GetDocumentStatusRequest$inboundSchema, - GetDocumentStatusRequest$Outbound, - GetDocumentStatusRequest$outboundSchema, - GetDocumentStatusRequest$, - getDocumentStatusResponseToJSON, - getDocumentStatusResponseFromJSON, - GetDocumentStatusResponse, - GetDocumentStatusResponse$inboundSchema, - GetDocumentStatusResponse$Outbound, - GetDocumentStatusResponse$outboundSchema, - GetDocumentStatusResponse$, - getDocumentVisibilityOverridesResponseToJSON, - getDocumentVisibilityOverridesResponseFromJSON, - GetDocumentVisibilityOverridesResponse, - GetDocumentVisibilityOverridesResponse$inboundSchema, - GetDocumentVisibilityOverridesResponse$Outbound, - GetDocumentVisibilityOverridesResponse$outboundSchema, - GetDocumentVisibilityOverridesResponse$, - getPinRequestToJSON, - getPinRequestFromJSON, - GetPinRequest, - GetPinRequest$inboundSchema, - GetPinRequest$Outbound, - GetPinRequest$outboundSchema, - GetPinRequest$, - getPinResponseToJSON, - getPinResponseFromJSON, - GetPinResponse, - GetPinResponse$inboundSchema, - GetPinResponse$Outbound, - GetPinResponse$outboundSchema, - GetPinResponse$, - getShortcutRequestToJSON, - getShortcutRequestFromJSON, - getShortcutRequestUnionToJSON, - getShortcutRequestUnionFromJSON, - GetShortcutRequest, - GetShortcutRequestUnion, - GetShortcutRequest$inboundSchema, - GetShortcutRequest$Outbound, - GetShortcutRequest$outboundSchema, - GetShortcutRequest$, - GetShortcutRequestUnion$inboundSchema, - GetShortcutRequestUnion$Outbound, - GetShortcutRequestUnion$outboundSchema, - GetShortcutRequestUnion$, - getShortcutResponseToJSON, - getShortcutResponseFromJSON, - GetShortcutResponse, - GetShortcutResponse$inboundSchema, - GetShortcutResponse$Outbound, - GetShortcutResponse$outboundSchema, - GetShortcutResponse$, - getUserCountRequestToJSON, - getUserCountRequestFromJSON, - GetUserCountRequest, - GetUserCountRequest$inboundSchema, - GetUserCountRequest$Outbound, - GetUserCountRequest$outboundSchema, - GetUserCountRequest$, - getUserCountResponseToJSON, - getUserCountResponseFromJSON, - GetUserCountResponse, - GetUserCountResponse$inboundSchema, - GetUserCountResponse$Outbound, - GetUserCountResponse$outboundSchema, - GetUserCountResponse$, - gleanAssistInsightsResponseToJSON, - gleanAssistInsightsResponseFromJSON, - GleanAssistInsightsResponse, - GleanAssistInsightsResponse$inboundSchema, - GleanAssistInsightsResponse$Outbound, - GleanAssistInsightsResponse$outboundSchema, - GleanAssistInsightsResponse$, - gleanDataErrorToJSON, - gleanDataErrorFromJSON, - GleanDataError, - GleanDataError$inboundSchema, - GleanDataError$Outbound, - GleanDataError$outboundSchema, - GleanDataError$, - grantPermissionToJSON, - grantPermissionFromJSON, - GrantPermission, - GrantPermission$inboundSchema, - GrantPermission$Outbound, - GrantPermission$outboundSchema, - GrantPermission$, - greenlistUsersRequestToJSON, - greenlistUsersRequestFromJSON, - GreenlistUsersRequest, - GreenlistUsersRequest$inboundSchema, - GreenlistUsersRequest$Outbound, - GreenlistUsersRequest$outboundSchema, - GreenlistUsersRequest$, - groupToJSON, - groupFromJSON, - Group, - Group$inboundSchema, - Group$Outbound, - Group$outboundSchema, - Group$, - GroupType, - GroupType$inboundSchema, - GroupType$outboundSchema, - GroupType$, - hotwordToJSON, - hotwordFromJSON, - Hotword, - Hotword$inboundSchema, - Hotword$Outbound, - Hotword$outboundSchema, - Hotword$, - hotwordProximityToJSON, - hotwordProximityFromJSON, - HotwordProximity, - HotwordProximity$inboundSchema, - HotwordProximity$Outbound, - HotwordProximity$outboundSchema, - HotwordProximity$, - iconConfigToJSON, - iconConfigFromJSON, - IconType, - IconConfig, - IconType$inboundSchema, - IconType$outboundSchema, - IconType$, - IconConfig$inboundSchema, - IconConfig$Outbound, - IconConfig$outboundSchema, - IconConfig$, - indexDocumentRequestToJSON, - indexDocumentRequestFromJSON, - IndexDocumentRequest, - IndexDocumentRequest$inboundSchema, - IndexDocumentRequest$Outbound, - IndexDocumentRequest$outboundSchema, - IndexDocumentRequest$, - indexDocumentsRequestToJSON, - indexDocumentsRequestFromJSON, - IndexDocumentsRequest, - IndexDocumentsRequest$inboundSchema, - IndexDocumentsRequest$Outbound, - IndexDocumentsRequest$outboundSchema, - IndexDocumentsRequest$, - indexEmployeeRequestToJSON, - indexEmployeeRequestFromJSON, - IndexEmployeeRequest, - IndexEmployeeRequest$inboundSchema, - IndexEmployeeRequest$Outbound, - IndexEmployeeRequest$outboundSchema, - IndexEmployeeRequest$, - indexGroupRequestToJSON, - indexGroupRequestFromJSON, - IndexGroupRequest, - IndexGroupRequest$inboundSchema, - IndexGroupRequest$Outbound, - IndexGroupRequest$outboundSchema, - IndexGroupRequest$, - indexingShortcutToJSON, - indexingShortcutFromJSON, - IndexingShortcut, - IndexingShortcut$inboundSchema, - IndexingShortcut$Outbound, - IndexingShortcut$outboundSchema, - IndexingShortcut$, - indexMembershipRequestToJSON, - indexMembershipRequestFromJSON, - IndexMembershipRequest, - IndexMembershipRequest$inboundSchema, - IndexMembershipRequest$Outbound, - IndexMembershipRequest$outboundSchema, - IndexMembershipRequest$, - indexStatusToJSON, - indexStatusFromJSON, - IndexStatus, - IndexStatus$inboundSchema, - IndexStatus$Outbound, - IndexStatus$outboundSchema, - IndexStatus$, - indexTeamRequestToJSON, - indexTeamRequestFromJSON, - IndexTeamRequest, - IndexTeamRequest$inboundSchema, - IndexTeamRequest$Outbound, - IndexTeamRequest$outboundSchema, - IndexTeamRequest$, - indexUserRequestToJSON, - indexUserRequestFromJSON, - IndexUserRequest, - IndexUserRequest$inboundSchema, - IndexUserRequest$Outbound, - IndexUserRequest$outboundSchema, - IndexUserRequest$, - inputOptionsToJSON, - inputOptionsFromJSON, - DatasourcesType, - TimePeriodType, - InputOptions, - DatasourcesType$inboundSchema, - DatasourcesType$outboundSchema, - DatasourcesType$, - TimePeriodType$inboundSchema, - TimePeriodType$outboundSchema, - TimePeriodType$, - InputOptions$inboundSchema, - InputOptions$Outbound, - InputOptions$outboundSchema, - InputOptions$, - insightsAgentsRequestOptionsToJSON, - insightsAgentsRequestOptionsFromJSON, - InsightsAgentsRequestOptions, - InsightsAgentsRequestOptions$inboundSchema, - InsightsAgentsRequestOptions$Outbound, - InsightsAgentsRequestOptions$outboundSchema, - InsightsAgentsRequestOptions$, - insightsAiAppRequestOptionsToJSON, - insightsAiAppRequestOptionsFromJSON, - InsightsAiAppRequestOptions, - InsightsAiAppRequestOptions$inboundSchema, - InsightsAiAppRequestOptions$Outbound, - InsightsAiAppRequestOptions$outboundSchema, - InsightsAiAppRequestOptions$, - insightsAssistantRequestToJSON, - insightsAssistantRequestFromJSON, - InsightsAssistantRequest, - InsightsAssistantRequest$inboundSchema, - InsightsAssistantRequest$Outbound, - InsightsAssistantRequest$outboundSchema, - InsightsAssistantRequest$, - insightsOverviewRequestToJSON, - insightsOverviewRequestFromJSON, - InsightsOverviewRequest, - InsightsOverviewRequest$inboundSchema, - InsightsOverviewRequest$Outbound, - InsightsOverviewRequest$outboundSchema, - InsightsOverviewRequest$, - insightsRequestToJSON, - insightsRequestFromJSON, - InsightsRequestCategory, - AssistantActivityType, - InsightsRequest, - InsightsRequestCategory$inboundSchema, - InsightsRequestCategory$outboundSchema, - InsightsRequestCategory$, - AssistantActivityType$inboundSchema, - AssistantActivityType$outboundSchema, - AssistantActivityType$, - InsightsRequest$inboundSchema, - InsightsRequest$Outbound, - InsightsRequest$outboundSchema, - InsightsRequest$, - insightsResponseToJSON, - insightsResponseFromJSON, - InsightsResponse, - InsightsResponse$inboundSchema, - InsightsResponse$Outbound, - InsightsResponse$outboundSchema, - InsightsResponse$, - invalidOperatorValueErrorToJSON, - invalidOperatorValueErrorFromJSON, - InvalidOperatorValueError, - InvalidOperatorValueError$inboundSchema, - InvalidOperatorValueError$Outbound, - InvalidOperatorValueError$outboundSchema, - InvalidOperatorValueError$, - inviteInfoToJSON, - inviteInfoFromJSON, - InviteInfo, - InviteInfo$inboundSchema, - InviteInfo$Outbound, - InviteInfo$outboundSchema, - InviteInfo$, - labeledCountInfoToJSON, - labeledCountInfoFromJSON, - LabeledCountInfo, - LabeledCountInfo$inboundSchema, - LabeledCountInfo$Outbound, - LabeledCountInfo$outboundSchema, - LabeledCountInfo$, - listAnswersRequestToJSON, - listAnswersRequestFromJSON, - ListAnswersRequest, - ListAnswersRequest$inboundSchema, - ListAnswersRequest$Outbound, - ListAnswersRequest$outboundSchema, - ListAnswersRequest$, - listAnswersResponseToJSON, - listAnswersResponseFromJSON, - ListAnswersResponse, - ListAnswersResponse$inboundSchema, - ListAnswersResponse$Outbound, - ListAnswersResponse$outboundSchema, - ListAnswersResponse$, - listChatsResponseToJSON, - listChatsResponseFromJSON, - ListChatsResponse, - ListChatsResponse$inboundSchema, - ListChatsResponse$Outbound, - ListChatsResponse$outboundSchema, - ListChatsResponse$, - listCollectionsRequestToJSON, - listCollectionsRequestFromJSON, - ListCollectionsRequest, - ListCollectionsRequest$inboundSchema, - ListCollectionsRequest$Outbound, - ListCollectionsRequest$outboundSchema, - ListCollectionsRequest$, - listCollectionsResponseToJSON, - listCollectionsResponseFromJSON, - ListCollectionsResponse, - ListCollectionsResponse$inboundSchema, - ListCollectionsResponse$Outbound, - ListCollectionsResponse$outboundSchema, - ListCollectionsResponse$, - listDlpReportsResponseToJSON, - listDlpReportsResponseFromJSON, - ListDlpReportsResponse, - ListDlpReportsResponse$inboundSchema, - ListDlpReportsResponse$Outbound, - ListDlpReportsResponse$outboundSchema, - ListDlpReportsResponse$, - listEntitiesRequestToJSON, - listEntitiesRequestFromJSON, - ListEntitiesRequestEntityType, - ListEntitiesRequestIncludeField, - RequestType, - ListEntitiesRequest, - ListEntitiesRequestEntityType$inboundSchema, - ListEntitiesRequestEntityType$outboundSchema, - ListEntitiesRequestEntityType$, - ListEntitiesRequestIncludeField$inboundSchema, - ListEntitiesRequestIncludeField$outboundSchema, - ListEntitiesRequestIncludeField$, - RequestType$inboundSchema, - RequestType$outboundSchema, - RequestType$, - ListEntitiesRequest$inboundSchema, - ListEntitiesRequest$Outbound, - ListEntitiesRequest$outboundSchema, - ListEntitiesRequest$, - listEntitiesResponseToJSON, - listEntitiesResponseFromJSON, - ListEntitiesResponse, - ListEntitiesResponse$inboundSchema, - ListEntitiesResponse$Outbound, - ListEntitiesResponse$outboundSchema, - ListEntitiesResponse$, - listPinsResponseToJSON, - listPinsResponseFromJSON, - ListPinsResponse, - ListPinsResponse$inboundSchema, - ListPinsResponse$Outbound, - ListPinsResponse$outboundSchema, - ListPinsResponse$, - listShortcutsPaginatedRequestToJSON, - listShortcutsPaginatedRequestFromJSON, - ListShortcutsPaginatedRequestIncludeField, - ListShortcutsPaginatedRequest, - ListShortcutsPaginatedRequestIncludeField$inboundSchema, - ListShortcutsPaginatedRequestIncludeField$outboundSchema, - ListShortcutsPaginatedRequestIncludeField$, - ListShortcutsPaginatedRequest$inboundSchema, - ListShortcutsPaginatedRequest$Outbound, - ListShortcutsPaginatedRequest$outboundSchema, - ListShortcutsPaginatedRequest$, - listShortcutsPaginatedResponseToJSON, - listShortcutsPaginatedResponseFromJSON, - ListShortcutsPaginatedResponse, - ListShortcutsPaginatedResponse$inboundSchema, - ListShortcutsPaginatedResponse$Outbound, - ListShortcutsPaginatedResponse$outboundSchema, - ListShortcutsPaginatedResponse$, - manualFeedbackInfoToJSON, - manualFeedbackInfoFromJSON, - ManualFeedbackInfoSource, - Issue, - ManualFeedbackInfoVote, - ManualFeedbackInfo, - ManualFeedbackInfoSource$inboundSchema, - ManualFeedbackInfoSource$outboundSchema, - ManualFeedbackInfoSource$, - Issue$inboundSchema, - Issue$outboundSchema, - Issue$, - ManualFeedbackInfoVote$inboundSchema, - ManualFeedbackInfoVote$outboundSchema, - ManualFeedbackInfoVote$, - ManualFeedbackInfo$inboundSchema, - ManualFeedbackInfo$Outbound, - ManualFeedbackInfo$outboundSchema, - ManualFeedbackInfo$, - manualFeedbackSideBySideInfoToJSON, - manualFeedbackSideBySideInfoFromJSON, - ManualFeedbackSideBySideInfoSource, - ManualFeedbackSideBySideInfoVote, - ManualFeedbackSideBySideInfo, - ManualFeedbackSideBySideInfoSource$inboundSchema, - ManualFeedbackSideBySideInfoSource$outboundSchema, - ManualFeedbackSideBySideInfoSource$, - ManualFeedbackSideBySideInfoVote$inboundSchema, - ManualFeedbackSideBySideInfoVote$outboundSchema, - ManualFeedbackSideBySideInfoVote$, - ManualFeedbackSideBySideInfo$inboundSchema, - ManualFeedbackSideBySideInfo$Outbound, - ManualFeedbackSideBySideInfo$outboundSchema, - ManualFeedbackSideBySideInfo$, - meetingToJSON, - meetingFromJSON, - Meeting, - Meeting$inboundSchema, - Meeting$Outbound, - Meeting$outboundSchema, - Meeting$, - messageTextBlockToJSON, - messageTextBlockFromJSON, - messageToJSON, - messageFromJSON, - MessageTextBlock, - Message, - MessageTextBlock$inboundSchema, - MessageTextBlock$Outbound, - MessageTextBlock$outboundSchema, - MessageTextBlock$, - Message$inboundSchema, - Message$Outbound, - Message$outboundSchema, - Message$, - messagesRequestToJSON, - messagesRequestFromJSON, - IdType, - Direction, - Datasource, - MessagesRequest, - IdType$inboundSchema, - IdType$outboundSchema, - IdType$, - Direction$inboundSchema, - Direction$outboundSchema, - Direction$, - Datasource$inboundSchema, - Datasource$outboundSchema, - Datasource$, - MessagesRequest$inboundSchema, - MessagesRequest$Outbound, - MessagesRequest$outboundSchema, - MessagesRequest$, - messagesResponseToJSON, - messagesResponseFromJSON, - MessagesResponse, - MessagesResponse$inboundSchema, - MessagesResponse$Outbound, - MessagesResponse$outboundSchema, - MessagesResponse$, - objectDefinitionToJSON, - objectDefinitionFromJSON, - DocCategory, - ObjectDefinition, - DocCategory$inboundSchema, - DocCategory$outboundSchema, - DocCategory$, - ObjectDefinition$inboundSchema, - ObjectDefinition$Outbound, - ObjectDefinition$outboundSchema, - ObjectDefinition$, - objectPermissionsToJSON, - objectPermissionsFromJSON, - ObjectPermissions, - ObjectPermissions$inboundSchema, - ObjectPermissions$Outbound, - ObjectPermissions$outboundSchema, - ObjectPermissions$, - operatorMetadataToJSON, - operatorMetadataFromJSON, - OperatorType, - OperatorMetadata, - OperatorType$inboundSchema, - OperatorType$outboundSchema, - OperatorType$, - OperatorMetadata$inboundSchema, - OperatorMetadata$Outbound, - OperatorMetadata$outboundSchema, - OperatorMetadata$, - operatorScopeToJSON, - operatorScopeFromJSON, - OperatorScope, - OperatorScope$inboundSchema, - OperatorScope$Outbound, - OperatorScope$outboundSchema, - OperatorScope$, - peopleRequestToJSON, - peopleRequestFromJSON, - PeopleRequestIncludeField, - IncludeType, - PeopleRequest, - PeopleRequestIncludeField$inboundSchema, - PeopleRequestIncludeField$outboundSchema, - PeopleRequestIncludeField$, - IncludeType$inboundSchema, - IncludeType$outboundSchema, - IncludeType$, - PeopleRequest$inboundSchema, - PeopleRequest$Outbound, - PeopleRequest$outboundSchema, - PeopleRequest$, - peopleResponseToJSON, - peopleResponseFromJSON, - PeopleResponse, - PeopleResponse$inboundSchema, - PeopleResponse$Outbound, - PeopleResponse$outboundSchema, - PeopleResponse$, - periodToJSON, - periodFromJSON, - Period, - Period$inboundSchema, - Period$Outbound, - Period$outboundSchema, - Period$, - permissionsToJSON, - permissionsFromJSON, - Permissions_2 as Permissions, - Permissions$inboundSchema, - Permissions$Outbound, - Permissions$outboundSchema, - Permissions$, - permissionsGroupIntersectionDefinitionToJSON, - permissionsGroupIntersectionDefinitionFromJSON, - PermissionsGroupIntersectionDefinition, - PermissionsGroupIntersectionDefinition$inboundSchema, - PermissionsGroupIntersectionDefinition$Outbound, - PermissionsGroupIntersectionDefinition$outboundSchema, - PermissionsGroupIntersectionDefinition$, - personToJSON, - personFromJSON, - Person, - Person$inboundSchema, - Person$Outbound, - Person$outboundSchema, - Person$, - personDistanceToJSON, - personDistanceFromJSON, - PersonDistance, - PersonDistance$inboundSchema, - PersonDistance$Outbound, - PersonDistance$outboundSchema, - PersonDistance$, - personMetadataToJSON, - personMetadataFromJSON, - PersonMetadataType, - PersonMetadata, - PersonMetadataType$inboundSchema, - PersonMetadataType$outboundSchema, - PersonMetadataType$, - PersonMetadata$inboundSchema, - PersonMetadata$Outbound, - PersonMetadata$outboundSchema, - PersonMetadata$, - personObjectToJSON, - personObjectFromJSON, - PersonObject, - PersonObject$inboundSchema, - PersonObject$Outbound, - PersonObject$outboundSchema, - PersonObject$, - personTeamToJSON, - personTeamFromJSON, - PersonTeamRelationship, - PersonTeam, - PersonTeamRelationship$inboundSchema, - PersonTeamRelationship$outboundSchema, - PersonTeamRelationship$, - PersonTeam$inboundSchema, - PersonTeam$Outbound, - PersonTeam$outboundSchema, - PersonTeam$, - personToTeamRelationshipToJSON, - personToTeamRelationshipFromJSON, - PersonToTeamRelationshipRelationship, - PersonToTeamRelationship, - PersonToTeamRelationshipRelationship$inboundSchema, - PersonToTeamRelationshipRelationship$outboundSchema, - PersonToTeamRelationshipRelationship$, - PersonToTeamRelationship$inboundSchema, - PersonToTeamRelationship$Outbound, - PersonToTeamRelationship$outboundSchema, - PersonToTeamRelationship$, - pinDocumentToJSON, - pinDocumentFromJSON, - PinDocument, - PinDocument$inboundSchema, - PinDocument$Outbound, - PinDocument$outboundSchema, - PinDocument$, - pinRequestToJSON, - pinRequestFromJSON, - PinRequest, - PinRequest$inboundSchema, - PinRequest$Outbound, - PinRequest$outboundSchema, - PinRequest$, - possibleValueToJSON, - possibleValueFromJSON, - PossibleValue, - PossibleValue$inboundSchema, - PossibleValue$Outbound, - PossibleValue$outboundSchema, - PossibleValue$, - processAllDocumentsRequestToJSON, - processAllDocumentsRequestFromJSON, - ProcessAllDocumentsRequest, - ProcessAllDocumentsRequest$inboundSchema, - ProcessAllDocumentsRequest$Outbound, - ProcessAllDocumentsRequest$outboundSchema, - ProcessAllDocumentsRequest$, - processAllMembershipsRequestToJSON, - processAllMembershipsRequestFromJSON, - ProcessAllMembershipsRequest, - ProcessAllMembershipsRequest$inboundSchema, - ProcessAllMembershipsRequest$Outbound, - ProcessAllMembershipsRequest$outboundSchema, - ProcessAllMembershipsRequest$, - processingHistoryEventToJSON, - processingHistoryEventFromJSON, - ProcessingHistoryEvent, - ProcessingHistoryEvent$inboundSchema, - ProcessingHistoryEvent$Outbound, - ProcessingHistoryEvent$outboundSchema, - ProcessingHistoryEvent$, - promptTemplateToJSON, - promptTemplateFromJSON, - PromptTemplate, - PromptTemplate$inboundSchema, - PromptTemplate$Outbound, - PromptTemplate$outboundSchema, - PromptTemplate$, - promptTemplateResultToJSON, - promptTemplateResultFromJSON, - PromptTemplateResult, - PromptTemplateResult$inboundSchema, - PromptTemplateResult$Outbound, - PromptTemplateResult$outboundSchema, - PromptTemplateResult$, - propertyDefinitionToJSON, - propertyDefinitionFromJSON, - PropertyType, - UiOptions, - PropertyDefinition_2 as PropertyDefinition, - PropertyType$inboundSchema, - PropertyType$outboundSchema, - PropertyType$, - UiOptions$inboundSchema, - UiOptions$outboundSchema, - UiOptions$, - PropertyDefinition$inboundSchema, - PropertyDefinition$Outbound, - PropertyDefinition$outboundSchema, - PropertyDefinition$, - propertyGroupToJSON, - propertyGroupFromJSON, - PropertyGroup, - PropertyGroup$inboundSchema, - PropertyGroup$Outbound, - PropertyGroup$outboundSchema, - PropertyGroup$, - queryInsightToJSON, - queryInsightFromJSON, - QueryInsight, - QueryInsight$inboundSchema, - QueryInsight$Outbound, - QueryInsight$outboundSchema, - QueryInsight$, - queryInsightsResponseToJSON, - queryInsightsResponseFromJSON, - QueryInsightsResponse, - QueryInsightsResponse$inboundSchema, - QueryInsightsResponse$Outbound, - QueryInsightsResponse$outboundSchema, - QueryInsightsResponse$, - querySuggestionToJSON, - querySuggestionFromJSON, - QuerySuggestion, - QuerySuggestion$inboundSchema, - QuerySuggestion$Outbound, - QuerySuggestion$outboundSchema, - QuerySuggestion$, - querySuggestionListToJSON, - querySuggestionListFromJSON, - QuerySuggestionList, - QuerySuggestionList$inboundSchema, - QuerySuggestionList$Outbound, - QuerySuggestionList$outboundSchema, - QuerySuggestionList$, - quicklinkToJSON, - quicklinkFromJSON, - Scope, - Quicklink, - Scope$inboundSchema, - Scope$outboundSchema, - Scope$, - Quicklink$inboundSchema, - Quicklink$Outbound, - Quicklink$outboundSchema, - Quicklink$, - reactionToJSON, - reactionFromJSON, - Reaction, - Reaction$inboundSchema, - Reaction$Outbound, - Reaction$outboundSchema, - Reaction$, - readPermissionToJSON, - readPermissionFromJSON, - ReadPermission, - ReadPermission$inboundSchema, - ReadPermission$Outbound, - ReadPermission$outboundSchema, - ReadPermission$, - recommendationsRequestToJSON, - recommendationsRequestFromJSON, - RecommendationsRequest, - RecommendationsRequest$inboundSchema, - RecommendationsRequest$Outbound, - RecommendationsRequest$outboundSchema, - RecommendationsRequest$, - recommendationsRequestOptionsToJSON, - recommendationsRequestOptionsFromJSON, - RecommendationsRequestOptions, - RecommendationsRequestOptions$inboundSchema, - RecommendationsRequestOptions$Outbound, - RecommendationsRequestOptions$outboundSchema, - RecommendationsRequestOptions$, - referenceRangeToJSON, - referenceRangeFromJSON, - ReferenceRange, - ReferenceRange$inboundSchema, - ReferenceRange$Outbound, - ReferenceRange$outboundSchema, - ReferenceRange$, - relatedDocumentsToJSON, - relatedDocumentsFromJSON, - Relation, - RelatedDocuments, - Relation$inboundSchema, - Relation$outboundSchema, - Relation$, - RelatedDocuments$inboundSchema, - RelatedDocuments$Outbound, - RelatedDocuments$outboundSchema, - RelatedDocuments$, - relatedObjectMetadataToJSON, - relatedObjectMetadataFromJSON, - relatedObjectToJSON, - relatedObjectFromJSON, - RelatedObjectMetadata, - RelatedObject, - RelatedObjectMetadata$inboundSchema, - RelatedObjectMetadata$Outbound, - RelatedObjectMetadata$outboundSchema, - RelatedObjectMetadata$, - RelatedObject$inboundSchema, - RelatedObject$Outbound, - RelatedObject$outboundSchema, - RelatedObject$, - relatedObjectEdgeToJSON, - relatedObjectEdgeFromJSON, - RelatedObjectEdge, - RelatedObjectEdge$inboundSchema, - RelatedObjectEdge$Outbound, - RelatedObjectEdge$outboundSchema, - RelatedObjectEdge$, - relatedQuestionToJSON, - relatedQuestionFromJSON, - RelatedQuestion, - RelatedQuestion$inboundSchema, - RelatedQuestion$Outbound, - RelatedQuestion$outboundSchema, - RelatedQuestion$, - reminderToJSON, - reminderFromJSON, - Reminder, - Reminder$inboundSchema, - Reminder$Outbound, - Reminder$outboundSchema, - Reminder$, - reminderRequestToJSON, - reminderRequestFromJSON, - ReminderRequest, - ReminderRequest$inboundSchema, - ReminderRequest$Outbound, - ReminderRequest$outboundSchema, - ReminderRequest$, - reportStatusResponseToJSON, - reportStatusResponseFromJSON, - ReportStatusResponseStatus, - ReportStatusResponse, - ReportStatusResponseStatus$inboundSchema, - ReportStatusResponseStatus$outboundSchema, - ReportStatusResponseStatus$, - ReportStatusResponse$inboundSchema, - ReportStatusResponse$Outbound, - ReportStatusResponse$outboundSchema, - ReportStatusResponse$, - restrictionFiltersToJSON, - restrictionFiltersFromJSON, - RestrictionFilters, - RestrictionFilters$inboundSchema, - RestrictionFilters$Outbound, - RestrictionFilters$outboundSchema, - RestrictionFilters$, - resultsDescriptionToJSON, - resultsDescriptionFromJSON, - ResultsDescription, - ResultsDescription$inboundSchema, - ResultsDescription$Outbound, - ResultsDescription$outboundSchema, - ResultsDescription$, - resultsResponseToJSON, - resultsResponseFromJSON, - ResultsResponse, - ResultsResponse$inboundSchema, - ResultsResponse$Outbound, - ResultsResponse$outboundSchema, - ResultsResponse$, - resultTabToJSON, - resultTabFromJSON, - ResultTab, - ResultTab$inboundSchema, - ResultTab$Outbound, - ResultTab$outboundSchema, - ResultTab$, - rotateTokenResponseToJSON, - rotateTokenResponseFromJSON, - RotateTokenResponse, - RotateTokenResponse$inboundSchema, - RotateTokenResponse$Outbound, - RotateTokenResponse$outboundSchema, - RotateTokenResponse$, - ScopeType, - ScopeType$inboundSchema, - ScopeType$outboundSchema, - ScopeType$, - searchAgentsRequestToJSON, - searchAgentsRequestFromJSON, - SearchAgentsRequest, - SearchAgentsRequest$inboundSchema, - SearchAgentsRequest$Outbound, - SearchAgentsRequest$outboundSchema, - SearchAgentsRequest$, - searchAgentsResponseToJSON, - searchAgentsResponseFromJSON, - SearchAgentsResponse, - SearchAgentsResponse$inboundSchema, - SearchAgentsResponse$Outbound, - SearchAgentsResponse$outboundSchema, - SearchAgentsResponse$, - searchProviderInfoToJSON, - searchProviderInfoFromJSON, - SearchProviderInfo, - SearchProviderInfo$inboundSchema, - SearchProviderInfo$Outbound, - SearchProviderInfo$outboundSchema, - SearchProviderInfo$, - searchRequestToJSON, - searchRequestFromJSON, - SearchRequest, - SearchRequest$inboundSchema, - SearchRequest$Outbound, - SearchRequest$outboundSchema, - SearchRequest$, - searchRequestInputDetailsToJSON, - searchRequestInputDetailsFromJSON, - SearchRequestInputDetails, - SearchRequestInputDetails$inboundSchema, - SearchRequestInputDetails$Outbound, - SearchRequestInputDetails$outboundSchema, - SearchRequestInputDetails$, - searchRequestOptionsToJSON, - searchRequestOptionsFromJSON, - ResponseHint, - SearchRequestOptions, - ResponseHint$inboundSchema, - ResponseHint$outboundSchema, - ResponseHint$, - SearchRequestOptions$inboundSchema, - SearchRequestOptions$Outbound, - SearchRequestOptions$outboundSchema, - SearchRequestOptions$, - searchResponseToJSON, - searchResponseFromJSON, - SearchResponse, - SearchResponse$inboundSchema, - SearchResponse$Outbound, - SearchResponse$outboundSchema, - SearchResponse$, - searchResponseMetadataToJSON, - searchResponseMetadataFromJSON, - SearchResponseMetadata, - SearchResponseMetadata$inboundSchema, - SearchResponseMetadata$Outbound, - SearchResponseMetadata$outboundSchema, - SearchResponseMetadata$, - searchResultToJSON, - searchResultFromJSON, - SearchResult, - SearchResult$inboundSchema, - SearchResult$Outbound, - SearchResult$outboundSchema, - SearchResult$, - SearchResultProminenceEnum, - SearchResultProminenceEnum$inboundSchema, - SearchResultProminenceEnum$outboundSchema, - SearchResultProminenceEnum$, - searchResultSnippetToJSON, - searchResultSnippetFromJSON, - SearchResultSnippet, - SearchResultSnippet$inboundSchema, - SearchResultSnippet$Outbound, - SearchResultSnippet$outboundSchema, - SearchResultSnippet$, - searchWarningToJSON, - searchWarningFromJSON, - WarningType, - SearchWarning, - WarningType$inboundSchema, - WarningType$outboundSchema, - WarningType$, - SearchWarning$inboundSchema, - SearchWarning$Outbound, - SearchWarning$outboundSchema, - SearchWarning$, - SectionType, - SectionType$inboundSchema, - SectionType$outboundSchema, - SectionType$, - securityToJSON, - securityFromJSON, - Security, - Security$inboundSchema, - Security$Outbound, - Security$outboundSchema, - Security$, - seenFeedbackInfoToJSON, - seenFeedbackInfoFromJSON, - SeenFeedbackInfo, - SeenFeedbackInfo$inboundSchema, - SeenFeedbackInfo$Outbound, - SeenFeedbackInfo$outboundSchema, - SeenFeedbackInfo$, - sensitiveContentOptionsToJSON, - sensitiveContentOptionsFromJSON, - SensitiveContentOptions, - SensitiveContentOptions$inboundSchema, - SensitiveContentOptions$Outbound, - SensitiveContentOptions$outboundSchema, - SensitiveContentOptions$, - sensitiveExpressionToJSON, - sensitiveExpressionFromJSON, - SensitiveExpression, - SensitiveExpression$inboundSchema, - SensitiveExpression$Outbound, - SensitiveExpression$outboundSchema, - SensitiveExpression$, - sensitiveInfoTypeToJSON, - sensitiveInfoTypeFromJSON, - LikelihoodThreshold, - SensitiveInfoType, - LikelihoodThreshold$inboundSchema, - LikelihoodThreshold$outboundSchema, - LikelihoodThreshold$, - SensitiveInfoType$inboundSchema, - SensitiveInfoType$Outbound, - SensitiveInfoType$outboundSchema, - SensitiveInfoType$, - sessionInfoToJSON, - sessionInfoFromJSON, - SessionInfo, - SessionInfo$inboundSchema, - SessionInfo$Outbound, - SessionInfo$outboundSchema, - SessionInfo$, - shareToJSON, - shareFromJSON, - Share, - Share$inboundSchema, - Share$Outbound, - Share$outboundSchema, - Share$, - sharingOptionsToJSON, - sharingOptionsFromJSON, - SharingOptions, - SharingOptions$inboundSchema, - SharingOptions$Outbound, - SharingOptions$outboundSchema, - SharingOptions$, - shortcutToJSON, - shortcutFromJSON, - Shortcut, - Shortcut$inboundSchema, - Shortcut$Outbound, - Shortcut$outboundSchema, - Shortcut$, - shortcutErrorToJSON, - shortcutErrorFromJSON, - ShortcutErrorErrorType, - ShortcutError, - ShortcutErrorErrorType$inboundSchema, - ShortcutErrorErrorType$outboundSchema, - ShortcutErrorErrorType$, - ShortcutError$inboundSchema, - ShortcutError$Outbound, - ShortcutError$outboundSchema, - ShortcutError$, - shortcutInsightToJSON, - shortcutInsightFromJSON, - ShortcutInsight, - ShortcutInsight$inboundSchema, - ShortcutInsight$Outbound, - ShortcutInsight$outboundSchema, - ShortcutInsight$, - shortcutInsightsResponseToJSON, - shortcutInsightsResponseFromJSON, - ShortcutInsightsResponse, - ShortcutInsightsResponse$inboundSchema, - ShortcutInsightsResponse$Outbound, - ShortcutInsightsResponse$outboundSchema, - ShortcutInsightsResponse$, - shortcutMutablePropertiesToJSON, - shortcutMutablePropertiesFromJSON, - ShortcutMutableProperties, - ShortcutMutableProperties$inboundSchema, - ShortcutMutableProperties$Outbound, - ShortcutMutableProperties$outboundSchema, - ShortcutMutableProperties$, - shortcutsPaginationMetadataToJSON, - shortcutsPaginationMetadataFromJSON, - ShortcutsPaginationMetadata, - ShortcutsPaginationMetadata$inboundSchema, - ShortcutsPaginationMetadata$Outbound, - ShortcutsPaginationMetadata$outboundSchema, - ShortcutsPaginationMetadata$, - responseMetadataToJSON, - responseMetadataFromJSON, - sideBySideImplementationToJSON, - sideBySideImplementationFromJSON, - ResponseMetadata, - SideBySideImplementation, - ResponseMetadata$inboundSchema, - ResponseMetadata$Outbound, - ResponseMetadata$outboundSchema, - ResponseMetadata$, - SideBySideImplementation$inboundSchema, - SideBySideImplementation$Outbound, - SideBySideImplementation$outboundSchema, - SideBySideImplementation$, - socialNetworkToJSON, - socialNetworkFromJSON, - SocialNetwork, - SocialNetwork$inboundSchema, - SocialNetwork$Outbound, - SocialNetwork$outboundSchema, - SocialNetwork$, - socialNetworkDefinitionToJSON, - socialNetworkDefinitionFromJSON, - SocialNetworkDefinition, - SocialNetworkDefinition$inboundSchema, - SocialNetworkDefinition$Outbound, - SocialNetworkDefinition$outboundSchema, - SocialNetworkDefinition$, - sortOptionsToJSON, - sortOptionsFromJSON, - OrderBy, - SortOptions, - OrderBy$inboundSchema, - OrderBy$outboundSchema, - OrderBy$, - SortOptions$inboundSchema, - SortOptions$Outbound, - SortOptions$outboundSchema, - SortOptions$, - structuredLinkToJSON, - structuredLinkFromJSON, - StructuredLink, - StructuredLink$inboundSchema, - StructuredLink$Outbound, - StructuredLink$outboundSchema, - StructuredLink$, - structuredLocationToJSON, - structuredLocationFromJSON, - StructuredLocation, - StructuredLocation$inboundSchema, - StructuredLocation$Outbound, - StructuredLocation$outboundSchema, - StructuredLocation$, - structuredResultToJSON, - structuredResultFromJSON, - Prominence, - StructuredResultSource, - StructuredResult, - Prominence$inboundSchema, - Prominence$outboundSchema, - Prominence$, - StructuredResultSource$inboundSchema, - StructuredResultSource$outboundSchema, - StructuredResultSource$, - StructuredResult$inboundSchema, - StructuredResult$Outbound, - StructuredResult$outboundSchema, - StructuredResult$, - structuredTextToJSON, - structuredTextFromJSON, - StructuredText, - StructuredText$inboundSchema, - StructuredText$Outbound, - StructuredText$outboundSchema, - StructuredText$, - structuredTextItemToJSON, - structuredTextItemFromJSON, - StructuredTextItem, - StructuredTextItem$inboundSchema, - StructuredTextItem$Outbound, - StructuredTextItem$outboundSchema, - StructuredTextItem$, - structuredTextMutablePropertiesToJSON, - structuredTextMutablePropertiesFromJSON, - StructuredTextMutableProperties, - StructuredTextMutableProperties$inboundSchema, - StructuredTextMutableProperties$Outbound, - StructuredTextMutableProperties$outboundSchema, - StructuredTextMutableProperties$, - summarizeRequestToJSON, - summarizeRequestFromJSON, - SummarizeRequest, - SummarizeRequest$inboundSchema, - SummarizeRequest$Outbound, - SummarizeRequest$outboundSchema, - SummarizeRequest$, - errorToJSON, - errorFromJSON, - summarizeResponseToJSON, - summarizeResponseFromJSON, - ErrorT, - SummarizeResponse, - ErrorT$inboundSchema, - ErrorT$Outbound, - ErrorT$outboundSchema, - ErrorT$, - SummarizeResponse$inboundSchema, - SummarizeResponse$Outbound, - SummarizeResponse$outboundSchema, - SummarizeResponse$, - summaryToJSON, - summaryFromJSON, - Summary, - Summary$inboundSchema, - Summary$Outbound, - Summary$outboundSchema, - Summary$, - teamToJSON, - teamFromJSON, - TeamStatus, - Team, - TeamStatus$inboundSchema, - TeamStatus$outboundSchema, - TeamStatus$, - Team$inboundSchema, - Team$Outbound, - Team$outboundSchema, - Team$, - teamEmailToJSON, - teamEmailFromJSON, - TeamEmail, - TeamEmail$inboundSchema, - TeamEmail$Outbound, - TeamEmail$outboundSchema, - TeamEmail$, - teamInfoDefinitionToJSON, - teamInfoDefinitionFromJSON, - TeamInfoDefinition, - TeamInfoDefinition$inboundSchema, - TeamInfoDefinition$Outbound, - TeamInfoDefinition$outboundSchema, - TeamInfoDefinition$, - teamMemberToJSON, - teamMemberFromJSON, - TeamMember, - TeamMember$inboundSchema, - TeamMember$Outbound, - TeamMember$outboundSchema, - TeamMember$, - textRangeToJSON, - textRangeFromJSON, - TextRangeType, - TextRange, - TextRangeType$inboundSchema, - TextRangeType$outboundSchema, - TextRangeType$, - TextRange$inboundSchema, - TextRange$Outbound, - TextRange$outboundSchema, - TextRange$, - thumbnailToJSON, - thumbnailFromJSON, - Thumbnail, - Thumbnail$inboundSchema, - Thumbnail$Outbound, - Thumbnail$outboundSchema, - Thumbnail$, - timeIntervalToJSON, - timeIntervalFromJSON, - TimeInterval, - TimeInterval$inboundSchema, - TimeInterval$Outbound, - TimeInterval$outboundSchema, - TimeInterval$, - timePointToJSON, - timePointFromJSON, - TimePoint, - TimePoint$inboundSchema, - TimePoint$Outbound, - TimePoint$outboundSchema, - TimePoint$, - timeRangeToJSON, - timeRangeFromJSON, - TimeRange, - TimeRange$inboundSchema, - TimeRange$Outbound, - TimeRange$outboundSchema, - TimeRange$, - toolToJSON, - toolFromJSON, - ToolType, - Tool, - ToolType$inboundSchema, - ToolType$outboundSchema, - ToolType$, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, - Tool$, - toolInfoToJSON, - toolInfoFromJSON, - ToolInfo, - ToolInfo$inboundSchema, - ToolInfo$Outbound, - ToolInfo$outboundSchema, - ToolInfo$, - toolMetadataToJSON, - toolMetadataFromJSON, - ToolMetadataType, - KnowledgeType, - WriteActionType, - AuthType, - ToolMetadata, - ToolMetadataType$inboundSchema, - ToolMetadataType$outboundSchema, - ToolMetadataType$, - KnowledgeType$inboundSchema, - KnowledgeType$outboundSchema, - KnowledgeType$, - WriteActionType$inboundSchema, - WriteActionType$outboundSchema, - WriteActionType$, - AuthType$inboundSchema, - AuthType$outboundSchema, - AuthType$, - ToolMetadata$inboundSchema, - ToolMetadata$Outbound, - ToolMetadata$outboundSchema, - ToolMetadata$, - toolParameterToJSON, - toolParameterFromJSON, - ToolParameterType, - ToolParameter, - ToolParameterType$inboundSchema, - ToolParameterType$outboundSchema, - ToolParameterType$, - ToolParameter$inboundSchema, - ToolParameter$Outbound, - ToolParameter$outboundSchema, - ToolParameter$, - toolsCallParameterToJSON, - toolsCallParameterFromJSON, - ToolsCallParameter, - ToolsCallParameter$inboundSchema, - ToolsCallParameter$Outbound, - ToolsCallParameter$outboundSchema, - ToolsCallParameter$, - toolsCallRequestToJSON, - toolsCallRequestFromJSON, - ToolsCallRequest, - ToolsCallRequest$inboundSchema, - ToolsCallRequest$Outbound, - ToolsCallRequest$outboundSchema, - ToolsCallRequest$, - toolsCallResponseToJSON, - toolsCallResponseFromJSON, - ToolsCallResponse, - ToolsCallResponse$inboundSchema, - ToolsCallResponse$Outbound, - ToolsCallResponse$outboundSchema, - ToolsCallResponse$, - toolSetsToJSON, - toolSetsFromJSON, - ToolSets, - ToolSets$inboundSchema, - ToolSets$Outbound, - ToolSets$outboundSchema, - ToolSets$, - toolsListResponseToJSON, - toolsListResponseFromJSON, - ToolsListResponse, - ToolsListResponse$inboundSchema, - ToolsListResponse$Outbound, - ToolsListResponse$outboundSchema, - ToolsListResponse$, - UgcType, - UgcType$inboundSchema, - UgcType$outboundSchema, - UgcType$, - unpinToJSON, - unpinFromJSON, - Unpin, - Unpin$inboundSchema, - Unpin$Outbound, - Unpin$outboundSchema, - Unpin$, - updateAnnouncementRequestToJSON, - updateAnnouncementRequestFromJSON, - UpdateAnnouncementRequestChannel, - UpdateAnnouncementRequestPostType, - UpdateAnnouncementRequest, - UpdateAnnouncementRequestChannel$inboundSchema, - UpdateAnnouncementRequestChannel$outboundSchema, - UpdateAnnouncementRequestChannel$, - UpdateAnnouncementRequestPostType$inboundSchema, - UpdateAnnouncementRequestPostType$outboundSchema, - UpdateAnnouncementRequestPostType$, - UpdateAnnouncementRequest$inboundSchema, - UpdateAnnouncementRequest$Outbound, - UpdateAnnouncementRequest$outboundSchema, - UpdateAnnouncementRequest$, - updateDlpConfigRequestToJSON, - updateDlpConfigRequestFromJSON, - UpdateDlpConfigRequest, - UpdateDlpConfigRequest$inboundSchema, - UpdateDlpConfigRequest$Outbound, - UpdateDlpConfigRequest$outboundSchema, - UpdateDlpConfigRequest$, - updateDlpConfigResponseToJSON, - updateDlpConfigResponseFromJSON, - UpdateDlpConfigResponse, - UpdateDlpConfigResponse$inboundSchema, - UpdateDlpConfigResponse$Outbound, - UpdateDlpConfigResponse$outboundSchema, - UpdateDlpConfigResponse$, - updateDlpReportRequestToJSON, - updateDlpReportRequestFromJSON, - UpdateDlpReportRequest, - UpdateDlpReportRequest$inboundSchema, - UpdateDlpReportRequest$Outbound, - UpdateDlpReportRequest$outboundSchema, - UpdateDlpReportRequest$, - updateDlpReportResponseToJSON, - updateDlpReportResponseFromJSON, - UpdateDlpReportResponse, - UpdateDlpReportResponse$inboundSchema, - UpdateDlpReportResponse$Outbound, - UpdateDlpReportResponse$outboundSchema, - UpdateDlpReportResponse$, - updateDocumentVisibilityOverridesRequestToJSON, - updateDocumentVisibilityOverridesRequestFromJSON, - UpdateDocumentVisibilityOverridesRequest, - UpdateDocumentVisibilityOverridesRequest$inboundSchema, - UpdateDocumentVisibilityOverridesRequest$Outbound, - UpdateDocumentVisibilityOverridesRequest$outboundSchema, - UpdateDocumentVisibilityOverridesRequest$, - updateDocumentVisibilityOverridesResponseToJSON, - updateDocumentVisibilityOverridesResponseFromJSON, - UpdateDocumentVisibilityOverridesResponse, - UpdateDocumentVisibilityOverridesResponse$inboundSchema, - UpdateDocumentVisibilityOverridesResponse$Outbound, - UpdateDocumentVisibilityOverridesResponse$outboundSchema, - UpdateDocumentVisibilityOverridesResponse$, - updatePermissionsRequestToJSON, - updatePermissionsRequestFromJSON, - UpdatePermissionsRequest, - UpdatePermissionsRequest$inboundSchema, - UpdatePermissionsRequest$Outbound, - UpdatePermissionsRequest$outboundSchema, - UpdatePermissionsRequest$, - updateShortcutRequestToJSON, - updateShortcutRequestFromJSON, - UpdateShortcutRequest, - UpdateShortcutRequest$inboundSchema, - UpdateShortcutRequest$Outbound, - UpdateShortcutRequest$outboundSchema, - UpdateShortcutRequest$, - updateShortcutResponseToJSON, - updateShortcutResponseFromJSON, - UpdateShortcutResponse, - UpdateShortcutResponse$inboundSchema, - UpdateShortcutResponse$Outbound, - UpdateShortcutResponse$outboundSchema, - UpdateShortcutResponse$, - UpdateType, - UpdateType$inboundSchema, - UpdateType$outboundSchema, - UpdateType$, - fileToJSON, - fileFromJSON, - uploadChatFilesRequestToJSON, - uploadChatFilesRequestFromJSON, - FileT, - UploadChatFilesRequest, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, - FileT$, - UploadChatFilesRequest$inboundSchema, - UploadChatFilesRequest$Outbound, - UploadChatFilesRequest$outboundSchema, - UploadChatFilesRequest$, - uploadChatFilesResponseToJSON, - uploadChatFilesResponseFromJSON, - UploadChatFilesResponse, - UploadChatFilesResponse$inboundSchema, - UploadChatFilesResponse$Outbound, - UploadChatFilesResponse$outboundSchema, - UploadChatFilesResponse$, - uploadShortcutsRequestToJSON, - uploadShortcutsRequestFromJSON, - UploadShortcutsRequest, - UploadShortcutsRequest$inboundSchema, - UploadShortcutsRequest$Outbound, - UploadShortcutsRequest$outboundSchema, - UploadShortcutsRequest$, - UploadStatusEnum, - UploadStatusEnum$inboundSchema, - UploadStatusEnum$outboundSchema, - UploadStatusEnum$, - userToJSON, - userFromJSON, - User, - User$inboundSchema, - User$Outbound, - User$outboundSchema, - User$, - userActivityToJSON, - userActivityFromJSON, - UserActivityAction, - UserActivity, - UserActivityAction$inboundSchema, - UserActivityAction$outboundSchema, - UserActivityAction$, - UserActivity$inboundSchema, - UserActivity$Outbound, - UserActivity$outboundSchema, - UserActivity$, - userActivityInsightToJSON, - userActivityInsightFromJSON, - ActivityEnum, - UserActivityInsight, - ActivityEnum$inboundSchema, - ActivityEnum$outboundSchema, - ActivityEnum$, - UserActivityInsight$inboundSchema, - UserActivityInsight$Outbound, - UserActivityInsight$outboundSchema, - UserActivityInsight$, - userGeneratedContentIdToJSON, - userGeneratedContentIdFromJSON, - UserGeneratedContentId, - UserGeneratedContentId$inboundSchema, - UserGeneratedContentId$Outbound, - UserGeneratedContentId$outboundSchema, - UserGeneratedContentId$, - userInsightsResponseToJSON, - userInsightsResponseFromJSON, - UserInsightsResponse, - UserInsightsResponse$inboundSchema, - UserInsightsResponse$Outbound, - UserInsightsResponse$outboundSchema, - UserInsightsResponse$, - userReferenceDefinitionToJSON, - userReferenceDefinitionFromJSON, - UserReferenceDefinition, - UserReferenceDefinition$inboundSchema, - UserReferenceDefinition$Outbound, - UserReferenceDefinition$outboundSchema, - UserReferenceDefinition$, - UserRole, - UserRole$inboundSchema, - UserRole$outboundSchema, - UserRole$, - userRoleSpecificationToJSON, - userRoleSpecificationFromJSON, - UserRoleSpecification, - UserRoleSpecification$inboundSchema, - UserRoleSpecification$Outbound, - UserRoleSpecification$outboundSchema, - UserRoleSpecification$, - userStatusResponseToJSON, - userStatusResponseFromJSON, - UserStatusResponse, - UserStatusResponse$inboundSchema, - UserStatusResponse$Outbound, - UserStatusResponse$outboundSchema, - UserStatusResponse$, - userViewInfoToJSON, - userViewInfoFromJSON, - UserViewInfo, - UserViewInfo$inboundSchema, - UserViewInfo$Outbound, - UserViewInfo$outboundSchema, - UserViewInfo$, - verificationToJSON, - verificationFromJSON, - State, - Verification, - State$inboundSchema, - State$outboundSchema, - State$, - Verification$inboundSchema, - Verification$Outbound, - Verification$outboundSchema, - Verification$, - verificationFeedToJSON, - verificationFeedFromJSON, - VerificationFeed, - VerificationFeed$inboundSchema, - VerificationFeed$Outbound, - VerificationFeed$outboundSchema, - VerificationFeed$, - verificationMetadataToJSON, - verificationMetadataFromJSON, - VerificationMetadata, - VerificationMetadata$inboundSchema, - VerificationMetadata$Outbound, - VerificationMetadata$outboundSchema, - VerificationMetadata$, - verifyRequestToJSON, - verifyRequestFromJSON, - VerifyRequestAction, - VerifyRequest, - VerifyRequestAction$inboundSchema, - VerifyRequestAction$outboundSchema, - VerifyRequestAction$, - VerifyRequest$inboundSchema, - VerifyRequest$Outbound, - VerifyRequest$outboundSchema, - VerifyRequest$, - viewerInfoToJSON, - viewerInfoFromJSON, - Role, - ViewerInfo, - Role$inboundSchema, - Role$outboundSchema, - Role$, - ViewerInfo$inboundSchema, - ViewerInfo$Outbound, - ViewerInfo$outboundSchema, - ViewerInfo$, - workflowToJSON, - workflowFromJSON, - Workflow, - Workflow$inboundSchema, - Workflow$Outbound, - Workflow$outboundSchema, - Workflow$, - workflowFeedbackInfoToJSON, - workflowFeedbackInfoFromJSON, - WorkflowFeedbackInfoSource, - WorkflowFeedbackInfo, - WorkflowFeedbackInfoSource$inboundSchema, - WorkflowFeedbackInfoSource$outboundSchema, - WorkflowFeedbackInfoSource$, - WorkflowFeedbackInfo$inboundSchema, - WorkflowFeedbackInfo$Outbound, - WorkflowFeedbackInfo$outboundSchema, - WorkflowFeedbackInfo$, - workflowResultToJSON, - workflowResultFromJSON, - WorkflowResult, - WorkflowResult$inboundSchema, - WorkflowResult$Outbound, - WorkflowResult$outboundSchema, - WorkflowResult$, - writeActionParameterToJSON, - writeActionParameterFromJSON, - WriteActionParameterType, - WriteActionParameter, - WriteActionParameterType$inboundSchema, - WriteActionParameterType$outboundSchema, - WriteActionParameterType$, - WriteActionParameter$inboundSchema, - WriteActionParameter$Outbound, - WriteActionParameter$outboundSchema, - WriteActionParameter$, - writePermissionToJSON, - writePermissionFromJSON, - WritePermission, - WritePermission$inboundSchema, - WritePermission$Outbound, - WritePermission$outboundSchema, - WritePermission$ - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConferenceData$ { - /** @deprecated use `ConferenceData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConferenceData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConferenceData$Outbound` instead. */ - type Outbound = ConferenceData$Outbound; -} - -/** @internal */ -declare const ConferenceData$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConferenceData$Outbound = { - provider: string; - uri: string; - source?: string | undefined; -}; - -/** @internal */ -declare const ConferenceData$outboundSchema: z.ZodType; - -declare type ConferenceData = { - provider: Provider; - /** - * A permalink for the conference. - */ - uri: string; - source?: ConferenceDataSource | undefined; -}; - -declare function conferenceDataFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConferenceDataSource$ { - /** @deprecated use `ConferenceDataSource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NativeConference: "NATIVE_CONFERENCE"; - readonly Location: "LOCATION"; - readonly Description: "DESCRIPTION"; - }>; - /** @deprecated use `ConferenceDataSource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NativeConference: "NATIVE_CONFERENCE"; - readonly Location: "LOCATION"; - readonly Description: "DESCRIPTION"; - }>; -} - -/** @internal */ -declare const ConferenceDataSource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConferenceDataSource$outboundSchema: z.ZodNativeEnum; - -declare const ConferenceDataSource: { - readonly NativeConference: "NATIVE_CONFERENCE"; - readonly Location: "LOCATION"; - readonly Description: "DESCRIPTION"; -}; - -declare type ConferenceDataSource = ClosedEnum; - -declare function conferenceDataToJSON(conferenceData: ConferenceData): string; - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -declare class ConnectionError extends HTTPClientError { - readonly name = "ConnectionError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConnectorType$ { - /** @deprecated use `ConnectorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; - }>; - /** @deprecated use `ConnectorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; - }>; -} - -/** @internal */ -declare const ConnectorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConnectorType$outboundSchema: z.ZodNativeEnum; - -/** - * The source from which document content was pulled, e.g. an API crawl or browser history - */ -declare const ConnectorType: { - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; -}; - -/** - * The source from which document content was pulled, e.g. an API crawl or browser history - */ -declare type ConnectorType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentDefinition$ { - /** @deprecated use `ContentDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ContentDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ContentDefinition$Outbound` instead. */ - type Outbound = ContentDefinition$Outbound; -} - -/** @internal */ -declare const ContentDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type ContentDefinition$Outbound = { - mimeType: string; - textContent?: string | undefined; - binaryContent?: string | undefined; -}; - -/** @internal */ -declare const ContentDefinition$outboundSchema: z.ZodType; - -/** - * Describes text content or base64 encoded binary content - */ -declare type ContentDefinition = { - mimeType: string; - /** - * text content. Only one of textContent or binary content can be specified - */ - textContent?: string | undefined; - /** - * base64 encoded binary content. Only one of textContent or binary content can be specified - */ - binaryContent?: string | undefined; -}; - -declare function contentDefinitionFromJSON(jsonString: string): Result; - -declare function contentDefinitionToJSON(contentDefinition: ContentDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentInsightsResponse$ { - /** @deprecated use `ContentInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ContentInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ContentInsightsResponse$Outbound` instead. */ - type Outbound = ContentInsightsResponse$Outbound; -} - -/** @internal */ -declare const ContentInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ContentInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - documentInsights?: Array | undefined; - departments?: Array | undefined; - minDepartmentSizeThreshold?: number | undefined; - minVisitorThreshold?: number | undefined; -}; - -/** @internal */ -declare const ContentInsightsResponse$outboundSchema: z.ZodType; - -declare type ContentInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - /** - * Insights for documents. - */ - documentInsights?: Array | undefined; - /** - * list of departments applicable for contents tab. - */ - departments?: Array | undefined; - /** - * Min threshold in size of departments while populating results, otherwise 0. - */ - minDepartmentSizeThreshold?: number | undefined; - /** - * Minimum number of visitors to a document required to be included in insights. - */ - minVisitorThreshold?: number | undefined; -}; - -declare function contentInsightsResponseFromJSON(jsonString: string): Result; - -declare function contentInsightsResponseToJSON(contentInsightsResponse: ContentInsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentType$ { - /** @deprecated use `ContentType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; - /** @deprecated use `ContentType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; -} - -/** @internal */ -declare const ContentType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ContentType$outboundSchema: z.ZodNativeEnum; - -declare const ContentType: { - readonly Text: "text"; -}; - -declare type ContentType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CountInfo$ { - /** @deprecated use `CountInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CountInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CountInfo$Outbound` instead. */ - type Outbound = CountInfo$Outbound; -} - -/** @internal */ -declare const CountInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type CountInfo$Outbound = { - count: number; - period?: Period$Outbound | undefined; - org?: string | undefined; -}; - -/** @internal */ -declare const CountInfo$outboundSchema: z.ZodType; - -declare type CountInfo = { - /** - * The counter value - */ - count: number; - period?: Period | undefined; - /** - * The unit of organization over which we did the count aggregation, e.g. org (department) or company - */ - org?: string | undefined; -}; - -declare function countInfoFromJSON(jsonString: string): Result; - -declare function countInfoToJSON(countInfo: CountInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateAnnouncementRequest$ { - /** @deprecated use `CreateAnnouncementRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateAnnouncementRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateAnnouncementRequest$Outbound` instead. */ - type Outbound = CreateAnnouncementRequest$Outbound; -} - -/** @internal */ -declare const CreateAnnouncementRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateAnnouncementRequest$Outbound = { - startTime: string; - endTime: string; - title: string; - body?: StructuredText$Outbound | undefined; - emoji?: string | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - banner?: Thumbnail$Outbound | undefined; - audienceFilters?: Array | undefined; - sourceDocumentId?: string | undefined; - hideAttribution?: boolean | undefined; - channel?: string | undefined; - postType?: string | undefined; - isPrioritized?: boolean | undefined; - viewUrl?: string | undefined; -}; - -/** @internal */ -declare const CreateAnnouncementRequest$outboundSchema: z.ZodType; - -declare type CreateAnnouncementRequest = { - /** - * The date and time at which the announcement becomes active. - */ - startTime: Date; - /** - * The date and time at which the announcement expires. - */ - endTime: Date; - /** - * The headline of the announcement. - */ - title: string; - body?: StructuredText | undefined; - /** - * An emoji used to indicate the nature of the announcement. - */ - emoji?: string | undefined; - thumbnail?: Thumbnail | undefined; - banner?: Thumbnail | undefined; - /** - * Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - */ - sourceDocumentId?: string | undefined; - /** - * Whether or not to hide an author attribution. - */ - hideAttribution?: boolean | undefined; - /** - * This determines whether this is a Social Feed post or a regular announcement. - */ - channel?: CreateAnnouncementRequestChannel | undefined; - /** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ - postType?: CreateAnnouncementRequestPostType | undefined; - /** - * Used by the Social Feed to pin posts to the front of the feed. - */ - isPrioritized?: boolean | undefined; - /** - * URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - */ - viewUrl?: string | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateAnnouncementRequestChannel$ { - /** @deprecated use `CreateAnnouncementRequestChannel$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; - /** @deprecated use `CreateAnnouncementRequestChannel$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; -} - -/** @internal */ -declare const CreateAnnouncementRequestChannel$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CreateAnnouncementRequestChannel$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare const CreateAnnouncementRequestChannel: { - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; -}; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare type CreateAnnouncementRequestChannel = ClosedEnum; - -declare function createAnnouncementRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateAnnouncementRequestPostType$ { - /** @deprecated use `CreateAnnouncementRequestPostType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; - /** @deprecated use `CreateAnnouncementRequestPostType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; -} - -/** @internal */ -declare const CreateAnnouncementRequestPostType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CreateAnnouncementRequestPostType$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare const CreateAnnouncementRequestPostType: { - readonly Text: "TEXT"; - readonly Link: "LINK"; -}; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare type CreateAnnouncementRequestPostType = ClosedEnum; - -declare function createAnnouncementRequestToJSON(createAnnouncementRequest: CreateAnnouncementRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateAnswerRequest$ { - /** @deprecated use `CreateAnswerRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateAnswerRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateAnswerRequest$Outbound` instead. */ - type Outbound = CreateAnswerRequest$Outbound; -} - -/** @internal */ -declare const CreateAnswerRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateAnswerRequest$Outbound = { - data: AnswerCreationData$Outbound; -}; - -/** @internal */ -declare const CreateAnswerRequest$outboundSchema: z.ZodType; - -declare type CreateAnswerRequest = { - data: AnswerCreationData; -}; - -declare function createAnswerRequestFromJSON(jsonString: string): Result; - -declare function createAnswerRequestToJSON(createAnswerRequest: CreateAnswerRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateAuthTokenResponse$ { - /** @deprecated use `CreateAuthTokenResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateAuthTokenResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateAuthTokenResponse$Outbound` instead. */ - type Outbound = CreateAuthTokenResponse$Outbound; -} - -/** @internal */ -declare const CreateAuthTokenResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateAuthTokenResponse$Outbound = { - token: string; - expirationTime: number; -}; - -/** @internal */ -declare const CreateAuthTokenResponse$outboundSchema: z.ZodType; - -declare type CreateAuthTokenResponse = { - /** - * An authentication token that can be passed to any endpoint via Bearer Authentication - */ - token: string; - /** - * Unix timestamp for when this token expires (in seconds since epoch UTC). - */ - expirationTime: number; -}; - -declare function createAuthTokenResponseFromJSON(jsonString: string): Result; - -declare function createAuthTokenResponseToJSON(createAuthTokenResponse: CreateAuthTokenResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateCollectionRequest$ { - /** @deprecated use `CreateCollectionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateCollectionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateCollectionRequest$Outbound` instead. */ - type Outbound = CreateCollectionRequest$Outbound; -} - -/** @internal */ -declare const CreateCollectionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateCollectionRequest$Outbound = { - name: string; - description?: string | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - audienceFilters?: Array | undefined; - icon?: string | undefined; - adminLocked?: boolean | undefined; - parentId?: number | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - allowedDatasource?: string | undefined; - newNextItemId?: string | undefined; -}; - -/** @internal */ -declare const CreateCollectionRequest$outboundSchema: z.ZodType; - -declare type CreateCollectionRequest = { - /** - * The unique name of the Collection. - */ - name: string; - /** - * A brief summary of the Collection's contents. - */ - description?: string | undefined; - /** - * A list of added user roles for the Collection. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Collection. - */ - removedRoles?: Array | undefined; - /** - * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The emoji icon of this Collection. - */ - icon?: string | undefined; - /** - * Indicates whether edits are allowed for everyone or only admins. - */ - adminLocked?: boolean | undefined; - /** - * The parent of this Collection, or 0 if it's a top-level Collection. - */ - parentId?: number | undefined; - thumbnail?: Thumbnail | undefined; - /** - * The datasource type this Collection can hold. - */ - allowedDatasource?: string | undefined; - /** - * The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified. - */ - newNextItemId?: string | undefined; -}; - -declare function createCollectionRequestFromJSON(jsonString: string): Result; - -declare function createCollectionRequestToJSON(createCollectionRequest: CreateCollectionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreatecollectionResponse$ { - /** @deprecated use `CreatecollectionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreatecollectionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreatecollectionResponse$Outbound` instead. */ - type Outbound = CreatecollectionResponse$Outbound; -} - -/** @internal */ -declare const CreatecollectionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreatecollectionResponse$Outbound = ResponseBody1$Outbound | ResponseBody2$Outbound; - -/** @internal */ -declare const CreatecollectionResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type CreatecollectionResponse = ResponseBody1 | ResponseBody2; - -declare function createcollectionResponseFromJSON(jsonString: string): Result; - -declare function createcollectionResponseToJSON(createcollectionResponse: CreatecollectionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateDlpReportRequest$ { - /** @deprecated use `CreateDlpReportRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateDlpReportRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateDlpReportRequest$Outbound` instead. */ - type Outbound = CreateDlpReportRequest$Outbound; -} - -/** @internal */ -declare const CreateDlpReportRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateDlpReportRequest$Outbound = { - name?: string | undefined; - config?: DlpConfig$Outbound | undefined; - frequency?: string | undefined; - autoHideDocs?: boolean | undefined; -}; - -/** @internal */ -declare const CreateDlpReportRequest$outboundSchema: z.ZodType; - -declare type CreateDlpReportRequest = { - /** - * Name of the policy being created. - */ - name?: string | undefined; - /** - * Detailed configuration of what documents and sensitive content will be scanned. - */ - config?: DlpConfig | undefined; - /** - * Interval between scans. DAILY is deprecated. - */ - frequency?: DlpFrequency | undefined; - /** - * Controls whether the policy should hide documents with violations. - */ - autoHideDocs?: boolean | undefined; -}; - -declare function createDlpReportRequestFromJSON(jsonString: string): Result; - -declare function createDlpReportRequestToJSON(createDlpReportRequest: CreateDlpReportRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateDlpReportResponse$ { - /** @deprecated use `CreateDlpReportResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateDlpReportResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateDlpReportResponse$Outbound` instead. */ - type Outbound = CreateDlpReportResponse$Outbound; -} - -/** @internal */ -declare const CreateDlpReportResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateDlpReportResponse$Outbound = { - report?: DlpReport$Outbound | undefined; -}; - -/** @internal */ -declare const CreateDlpReportResponse$outboundSchema: z.ZodType; - -declare type CreateDlpReportResponse = { - /** - * Full policy information that will be used for scans. - */ - report?: DlpReport | undefined; -}; - -declare function createDlpReportResponseFromJSON(jsonString: string): Result; - -declare function createDlpReportResponseToJSON(createDlpReportResponse: CreateDlpReportResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateShortcutRequest$ { - /** @deprecated use `CreateShortcutRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateShortcutRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateShortcutRequest$Outbound` instead. */ - type Outbound = CreateShortcutRequest$Outbound; -} - -/** @internal */ -declare const CreateShortcutRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateShortcutRequest$Outbound = { - data: ShortcutMutableProperties$Outbound; -}; - -/** @internal */ -declare const CreateShortcutRequest$outboundSchema: z.ZodType; - -declare type CreateShortcutRequest = { - data: ShortcutMutableProperties; -}; - -declare function createShortcutRequestFromJSON(jsonString: string): Result; - -declare function createShortcutRequestToJSON(createShortcutRequest: CreateShortcutRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CreateShortcutResponse$ { - /** @deprecated use `CreateShortcutResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CreateShortcutResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CreateShortcutResponse$Outbound` instead. */ - type Outbound = CreateShortcutResponse$Outbound; -} - -/** @internal */ -declare const CreateShortcutResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type CreateShortcutResponse$Outbound = { - shortcut?: Shortcut$Outbound | undefined; - error?: ShortcutError$Outbound | undefined; -}; - -/** @internal */ -declare const CreateShortcutResponse$outboundSchema: z.ZodType; - -declare type CreateShortcutResponse = { - shortcut?: Shortcut | undefined; - error?: ShortcutError | undefined; -}; - -declare function createShortcutResponseFromJSON(jsonString: string): Result; - -declare function createShortcutResponseToJSON(createShortcutResponse: CreateShortcutResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomDatasourceConfig$ { - /** @deprecated use `CustomDatasourceConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomDatasourceConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomDatasourceConfig$Outbound` instead. */ - type Outbound = CustomDatasourceConfig$Outbound; -} - -/** @internal */ -declare const CustomDatasourceConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomDatasourceConfig$Outbound = { - name: string; - displayName?: string | undefined; - datasourceCategory: string; - urlRegex?: string | undefined; - iconUrl?: string | undefined; - objectDefinitions?: Array | undefined; - suggestionText?: string | undefined; - homeUrl?: string | undefined; - crawlerSeedUrls?: Array | undefined; - iconDarkUrl?: string | undefined; - hideBuiltInFacets?: Array | undefined; - canonicalizingURLRegex?: Array | undefined; - canonicalizingTitleRegex?: Array | undefined; - redlistTitleRegex?: string | undefined; - connectorType?: string | undefined; - quicklinks?: Array | undefined; - renderConfigPreset?: string | undefined; - aliases?: Array | undefined; - isOnPrem?: boolean | undefined; - trustUrlRegexForViewActivity: boolean; - includeUtmSource?: boolean | undefined; - stripFragmentInCanonicalUrl: boolean; - identityDatasourceName?: string | undefined; - productAccessGroup?: string | undefined; - isUserReferencedByEmail?: boolean | undefined; - isEntityDatasource: boolean; - isTestDatasource: boolean; -}; - -/** @internal */ -declare const CustomDatasourceConfig$outboundSchema: z.ZodType; - -/** - * Structure describing config properties of a custom datasource - */ -declare type CustomDatasourceConfig = { - /** - * Unique identifier of datasource instance to which this config applies. - */ - name: string; - /** - * The user-friendly instance label to display. If omitted, falls back to the title-cased `name`. - */ - displayName?: string | undefined; - /** - * The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - */ - datasourceCategory?: DatasourceCategory | undefined; - /** - * Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.** - */ - urlRegex?: string | undefined; - /** - * The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - */ - iconUrl?: string | undefined; - /** - * The list of top-level `objectType`s for the datasource. - */ - objectDefinitions?: Array | undefined; - /** - * Example text for what to search for in this datasource - */ - suggestionText?: string | undefined; - /** - * The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page. - */ - homeUrl?: string | undefined; - /** - * This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling. - */ - crawlerSeedUrls?: Array | undefined; - /** - * The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - */ - iconDarkUrl?: string | undefined; - /** - * List of built-in facet types that should be hidden for the datasource. - */ - hideBuiltInFacets?: Array | undefined; - /** - * A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - */ - canonicalizingURLRegex?: Array | undefined; - /** - * A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results - */ - canonicalizingTitleRegex?: Array | undefined; - /** - * A regex that identifies titles that should not be indexed - */ - redlistTitleRegex?: string | undefined; - connectorType?: CustomDatasourceConfigConnectorType | undefined; - /** - * List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira - */ - quicklinks?: Array | undefined; - /** - * The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details - */ - renderConfigPreset?: string | undefined; - /** - * Aliases that can be used as `app` operator-values. - */ - aliases?: Array | undefined; - /** - * Whether or not this datasource is hosted on-premise. - */ - isOnPrem?: boolean | undefined; - /** - * True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load. - */ - trustUrlRegexForViewActivity?: boolean | undefined; - /** - * If true, a utm_source query param will be added to outbound links to this datasource within Glean. - */ - includeUtmSource?: boolean | undefined; - /** - * If true, the fragment part of the URL will be stripped when converting to a canonical url. - */ - stripFragmentInCanonicalUrl?: boolean | undefined; - /** - * If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already. - */ - identityDatasourceName?: string | undefined; - /** - * If the datasource uses a specific product access group, then the name of that group. - */ - productAccessGroup?: string | undefined; - /** - * whether email is used to reference users in document ACLs and in group memberships. - */ - isUserReferencedByEmail?: boolean | undefined; - /** - * True if this datasource is used to push custom entities. - */ - isEntityDatasource?: boolean | undefined; - /** - * True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings. - */ - isTestDatasource?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomDatasourceConfigConnectorType$ { - /** @deprecated use `CustomDatasourceConfigConnectorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; - }>; - /** @deprecated use `CustomDatasourceConfigConnectorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; - }>; -} - -/** @internal */ -declare const CustomDatasourceConfigConnectorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CustomDatasourceConfigConnectorType$outboundSchema: z.ZodNativeEnum; - -/** - * The source from which document content was pulled, e.g. an API crawl or browser history - */ -declare const CustomDatasourceConfigConnectorType: { - readonly ApiCrawl: "API_CRAWL"; - readonly BrowserCrawl: "BROWSER_CRAWL"; - readonly BrowserHistory: "BROWSER_HISTORY"; - readonly Builtin: "BUILTIN"; - readonly FederatedSearch: "FEDERATED_SEARCH"; - readonly PushApi: "PUSH_API"; - readonly WebCrawl: "WEB_CRAWL"; - readonly NativeHistory: "NATIVE_HISTORY"; -}; - -/** - * The source from which document content was pulled, e.g. an API crawl or browser history - */ -declare type CustomDatasourceConfigConnectorType = ClosedEnum; - -declare function customDatasourceConfigFromJSON(jsonString: string): Result; - -declare function customDatasourceConfigToJSON(customDatasourceConfig: CustomDatasourceConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomDataValue$ { - /** @deprecated use `CustomDataValue$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomDataValue$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomDataValue$Outbound` instead. */ - type Outbound = CustomDataValue$Outbound; -} - -/** @internal */ -declare const CustomDataValue$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomDataValue$Outbound = { - displayLabel?: string | undefined; - stringValue?: string | undefined; - stringListValue?: Array | undefined; - numberValue?: number | undefined; - booleanValue?: boolean | undefined; -}; - -/** @internal */ -declare const CustomDataValue$outboundSchema: z.ZodType; - -declare type CustomDataValue = { - displayLabel?: string | undefined; - stringValue?: string | undefined; - /** - * list of strings for multi-value properties - */ - stringListValue?: Array | undefined; - numberValue?: number | undefined; - booleanValue?: boolean | undefined; -}; - -declare function customDataValueFromJSON(jsonString: string): Result; - -declare function customDataValueToJSON(customDataValue: CustomDataValue): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomEntity$ { - /** @deprecated use `CustomEntity$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomEntity$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomEntity$Outbound` instead. */ - type Outbound = CustomEntity$Outbound; -} - -/** @internal */ -declare const CustomEntity$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomEntity$Outbound = { - permissions?: ObjectPermissions$Outbound | undefined; - id?: string | undefined; - title?: string | undefined; - datasource?: string | undefined; - objectType?: string | undefined; - metadata?: CustomEntityMetadata$Outbound | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const CustomEntity$outboundSchema: z.ZodType; - -declare type CustomEntity = { - permissions?: ObjectPermissions | undefined; - /** - * Unique identifier. - */ - id?: string | undefined; - /** - * Title or name of the custom entity. - */ - title?: string | undefined; - /** - * The datasource the custom entity is from. - */ - datasource?: string | undefined; - /** - * The type of the entity. Interpretation is specific to each datasource - */ - objectType?: string | undefined; - metadata?: CustomEntityMetadata | undefined; - /** - * A list of user roles for the custom entity explicitly granted by the owner. - */ - roles?: Array | undefined; -}; - -declare function customEntityFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomEntityMetadata$ { - /** @deprecated use `CustomEntityMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomEntityMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomEntityMetadata$Outbound` instead. */ - type Outbound = CustomEntityMetadata$Outbound; -} - -/** @internal */ -declare const CustomEntityMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomEntityMetadata$Outbound = { - customData?: { - [k: string]: CustomDataValue$Outbound; - } | undefined; -}; - -/** @internal */ -declare const CustomEntityMetadata$outboundSchema: z.ZodType; - -declare type CustomEntityMetadata = { - /** - * Custom fields specific to individual datasources - */ - customData?: { - [k: string]: CustomDataValue; - } | undefined; -}; - -declare function customEntityMetadataFromJSON(jsonString: string): Result; - -declare function customEntityMetadataToJSON(customEntityMetadata: CustomEntityMetadata): string; - -declare function customEntityToJSON(customEntity: CustomEntity): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Customer$ { - /** @deprecated use `Customer$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Customer$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Customer$Outbound` instead. */ - type Outbound = Customer$Outbound; -} - -/** @internal */ -declare const Customer$inboundSchema: z.ZodType; - -/** @internal */ -declare type Customer$Outbound = { - id: string; - domains?: Array | undefined; - company: Company$Outbound; - documentCounts?: { - [k: string]: number; - } | undefined; - poc?: Array | undefined; - metadata?: CustomerMetadata$Outbound | undefined; - mergedCustomers?: Array | undefined; - startDate?: string | undefined; - contractAnnualRevenue?: number | undefined; - notes?: string | undefined; -}; - -/** @internal */ -declare const Customer$outboundSchema: z.ZodType; - -declare type Customer = { - /** - * Unique identifier. - */ - id: string; - /** - * Link to company's associated website domains. - */ - domains?: Array | undefined; - company: Company; - /** - * A map of {string, int} pairs representing counts of each document type associated with this customer. - */ - documentCounts?: { - [k: string]: number; - } | undefined; - /** - * A list of POC for company. - */ - poc?: Array | undefined; - metadata?: CustomerMetadata | undefined; - /** - * A list of Customers. - */ - mergedCustomers?: Array | undefined; - /** - * The date when the interaction with customer started. - */ - startDate?: RFCDate | undefined; - /** - * Average contract annual revenue with that customer. - */ - contractAnnualRevenue?: number | undefined; - /** - * User facing (potentially generated) notes about company. - */ - notes?: string | undefined; -}; - -declare function customerFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomerMetadata$ { - /** @deprecated use `CustomerMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomerMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomerMetadata$Outbound` instead. */ - type Outbound = CustomerMetadata$Outbound; -} - -/** @internal */ -declare const CustomerMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomerMetadata$Outbound = { - datasourceId?: string | undefined; - customData?: { - [k: string]: CustomDataValue$Outbound; - } | undefined; -}; - -/** @internal */ -declare const CustomerMetadata$outboundSchema: z.ZodType; - -declare type CustomerMetadata = { - /** - * The user visible id of the salesforce customer account. - */ - datasourceId?: string | undefined; - /** - * Custom fields specific to individual datasources - */ - customData?: { - [k: string]: CustomDataValue; - } | undefined; -}; - -declare function customerMetadataFromJSON(jsonString: string): Result; - -declare function customerMetadataToJSON(customerMetadata: CustomerMetadata): string; - -declare function customerToJSON(customer: Customer): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomFieldData$ { - /** @deprecated use `CustomFieldData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomFieldData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomFieldData$Outbound` instead. */ - type Outbound = CustomFieldData$Outbound; -} - -/** @internal */ -declare const CustomFieldData$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomFieldData$Outbound = { - label: string; - values: Array; - displayable: boolean; -}; - -/** @internal */ -declare const CustomFieldData$outboundSchema: z.ZodType; - -declare type CustomFieldData = { - /** - * A user-facing label for this field. - */ - label: string; - values: Array; - /** - * Determines whether the client should display this custom field - */ - displayable?: boolean | undefined; -}; - -declare function customFieldDataFromJSON(jsonString: string): Result; - -declare function customFieldDataToJSON(customFieldData: CustomFieldData): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomFieldValue$ { - /** @deprecated use `CustomFieldValue$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValue$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValue$Outbound` instead. */ - type Outbound = CustomFieldValue$Outbound; -} - -/** @internal */ -declare const CustomFieldValue$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomFieldValue$Outbound = CustomFieldValueStr$Outbound | CustomFieldValueHyperlink$Outbound | CustomFieldValuePerson$Outbound; - -/** @internal */ -declare const CustomFieldValue$outboundSchema: z.ZodType; - -declare type CustomFieldValue = CustomFieldValueStr | CustomFieldValueHyperlink | CustomFieldValuePerson; - -declare function customFieldValueFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomFieldValueHyperlink$ { - /** @deprecated use `CustomFieldValueHyperlink$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValueHyperlink$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValueHyperlink$Outbound` instead. */ - type Outbound = CustomFieldValueHyperlink$Outbound; -} - -/** @internal */ -declare const CustomFieldValueHyperlink$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomFieldValueHyperlink$Outbound = { - urlAnchor?: string | undefined; - urlLink?: string | undefined; -}; - -/** @internal */ -declare const CustomFieldValueHyperlink$outboundSchema: z.ZodType; - -declare type CustomFieldValueHyperlink = { - /** - * Anchor text for hyperlink. - */ - urlAnchor?: string | undefined; - /** - * Link for this URL. - */ - urlLink?: string | undefined; -}; - -declare function customFieldValueHyperlinkFromJSON(jsonString: string): Result; - -declare function customFieldValueHyperlinkToJSON(customFieldValueHyperlink: CustomFieldValueHyperlink): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomFieldValuePerson$ { - /** @deprecated use `CustomFieldValuePerson$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValuePerson$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValuePerson$Outbound` instead. */ - type Outbound = CustomFieldValuePerson$Outbound; -} - -/** @internal */ -declare const CustomFieldValuePerson$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomFieldValuePerson$Outbound = { - person?: Person$Outbound | undefined; -}; - -/** @internal */ -declare const CustomFieldValuePerson$outboundSchema: z.ZodType; - -declare type CustomFieldValuePerson = { - person?: Person | undefined; -}; - -declare function customFieldValuePersonFromJSON(jsonString: string): Result; - -declare function customFieldValuePersonToJSON(customFieldValuePerson: CustomFieldValuePerson): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomFieldValueStr$ { - /** @deprecated use `CustomFieldValueStr$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValueStr$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomFieldValueStr$Outbound` instead. */ - type Outbound = CustomFieldValueStr$Outbound; -} - -/** @internal */ -declare const CustomFieldValueStr$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomFieldValueStr$Outbound = { - strText?: string | undefined; -}; - -/** @internal */ -declare const CustomFieldValueStr$outboundSchema: z.ZodType; - -declare type CustomFieldValueStr = { - /** - * Text field for string value. - */ - strText?: string | undefined; -}; - -declare function customFieldValueStrFromJSON(jsonString: string): Result; - -declare function customFieldValueStrToJSON(customFieldValueStr: CustomFieldValueStr): string; - -declare function customFieldValueToJSON(customFieldValue: CustomFieldValue): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CustomProperty$ { - /** @deprecated use `CustomProperty$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CustomProperty$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CustomProperty$Outbound` instead. */ - type Outbound = CustomProperty$Outbound; -} - -/** @internal */ -declare const CustomProperty$inboundSchema: z.ZodType; - -/** @internal */ -declare type CustomProperty$Outbound = { - name?: string | undefined; - value?: any | undefined; -}; - -/** @internal */ -declare const CustomProperty$outboundSchema: z.ZodType; - -/** - * Describes the custom properties of the object. - */ -declare type CustomProperty = { - name?: string | undefined; - /** - * Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this. - */ - value?: any | undefined; -}; - -declare function customPropertyFromJSON(jsonString: string): Result; - -declare function customPropertyToJSON(customProperty: CustomProperty): string; - -declare class Data extends ClientSDK { - private _policies?; - get policies(): Policies; - private _reports?; - get reports(): Reports; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Datasource$ { - /** @deprecated use `Datasource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Slack: "SLACK"; - readonly Microsoftteams: "MICROSOFTTEAMS"; - readonly Facebookworkplace: "FACEBOOKWORKPLACE"; - }>; - /** @deprecated use `Datasource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Slack: "SLACK"; - readonly Microsoftteams: "MICROSOFTTEAMS"; - readonly Facebookworkplace: "FACEBOOKWORKPLACE"; - }>; -} - -/** @internal */ -declare const Datasource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Datasource$outboundSchema: z.ZodNativeEnum; - -/** - * The type of the data source. Missing field defaults to SLACK. - */ -declare const Datasource: { - readonly Slack: "SLACK"; - readonly Microsoftteams: "MICROSOFTTEAMS"; - readonly Facebookworkplace: "FACEBOOKWORKPLACE"; -}; - -/** - * The type of the data source. Missing field defaults to SLACK. - */ -declare type Datasource = ClosedEnum; - -declare class Datasource_2 extends ClientSDK { - /** - * Beta: Get datasource status - * - * @remarks - * Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - status(datasource: string, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceBulkMembershipDefinition$ { - /** @deprecated use `DatasourceBulkMembershipDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceBulkMembershipDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceBulkMembershipDefinition$Outbound` instead. */ - type Outbound = DatasourceBulkMembershipDefinition$Outbound; -} - -/** @internal */ -declare const DatasourceBulkMembershipDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceBulkMembershipDefinition$Outbound = { - memberUserId?: string | undefined; - memberGroupName?: string | undefined; -}; - -/** @internal */ -declare const DatasourceBulkMembershipDefinition$outboundSchema: z.ZodType; - -/** - * describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified. - */ -declare type DatasourceBulkMembershipDefinition = { - /** - * If the member is a user, then the email or datasource id for the user - */ - memberUserId?: string | undefined; - /** - * If the member is a group, then the name of the member group - */ - memberGroupName?: string | undefined; -}; - -declare function datasourceBulkMembershipDefinitionFromJSON(jsonString: string): Result; - -declare function datasourceBulkMembershipDefinitionToJSON(datasourceBulkMembershipDefinition: DatasourceBulkMembershipDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceCategory$ { - /** @deprecated use `DatasourceCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; - }>; - /** @deprecated use `DatasourceCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; - }>; -} - -/** @internal */ -declare const DatasourceCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DatasourceCategory$outboundSchema: z.ZodNativeEnum; - -/** - * The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - */ -declare const DatasourceCategory: { - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; -}; - -/** - * The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - */ -declare type DatasourceCategory = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceGroupDefinition$ { - /** @deprecated use `DatasourceGroupDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceGroupDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceGroupDefinition$Outbound` instead. */ - type Outbound = DatasourceGroupDefinition$Outbound; -} - -/** @internal */ -declare const DatasourceGroupDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceGroupDefinition$Outbound = { - name: string; -}; - -/** @internal */ -declare const DatasourceGroupDefinition$outboundSchema: z.ZodType; - -/** - * describes a group in the datasource - */ -declare type DatasourceGroupDefinition = { - /** - * name of the group. Should be unique among all groups for the datasource, and cannot have spaces. - */ - name: string; -}; - -declare function datasourceGroupDefinitionFromJSON(jsonString: string): Result; - -declare function datasourceGroupDefinitionToJSON(datasourceGroupDefinition: DatasourceGroupDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceMembershipDefinition$ { - /** @deprecated use `DatasourceMembershipDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceMembershipDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceMembershipDefinition$Outbound` instead. */ - type Outbound = DatasourceMembershipDefinition$Outbound; -} - -/** @internal */ -declare const DatasourceMembershipDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceMembershipDefinition$Outbound = { - groupName: string; - memberUserId?: string | undefined; - memberGroupName?: string | undefined; -}; - -/** @internal */ -declare const DatasourceMembershipDefinition$outboundSchema: z.ZodType; - -/** - * describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - */ -declare type DatasourceMembershipDefinition = { - /** - * The group for which the membership is specified - */ - groupName: string; - /** - * If the member is a user, then the email or datasource id for the user - */ - memberUserId?: string | undefined; - /** - * If the member is a group, then the name of the member group - */ - memberGroupName?: string | undefined; -}; - -declare function datasourceMembershipDefinitionFromJSON(jsonString: string): Result; - -declare function datasourceMembershipDefinitionToJSON(datasourceMembershipDefinition: DatasourceMembershipDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceObjectTypeDocumentCountEntry$ { - /** @deprecated use `DatasourceObjectTypeDocumentCountEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceObjectTypeDocumentCountEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceObjectTypeDocumentCountEntry$Outbound` instead. */ - type Outbound = DatasourceObjectTypeDocumentCountEntry$Outbound; -} - -/** @internal */ -declare const DatasourceObjectTypeDocumentCountEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceObjectTypeDocumentCountEntry$Outbound = { - objectType?: string | undefined; - count?: number | undefined; -}; - -/** @internal */ -declare const DatasourceObjectTypeDocumentCountEntry$outboundSchema: z.ZodType; - -declare type DatasourceObjectTypeDocumentCountEntry = { - /** - * The object type of the document - */ - objectType?: string | undefined; - /** - * The number of documents of the corresponding objectType - */ - count?: number | undefined; -}; - -declare function datasourceObjectTypeDocumentCountEntryFromJSON(jsonString: string): Result; - -declare function datasourceObjectTypeDocumentCountEntryToJSON(datasourceObjectTypeDocumentCountEntry: DatasourceObjectTypeDocumentCountEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceProfile$ { - /** @deprecated use `DatasourceProfile$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceProfile$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceProfile$Outbound` instead. */ - type Outbound = DatasourceProfile$Outbound; -} - -/** @internal */ -declare const DatasourceProfile$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceProfile$Outbound = { - datasource: string; - handle: string; - url?: string | undefined; - nativeAppUrl?: string | undefined; - isUserGenerated?: boolean | undefined; -}; - -/** @internal */ -declare const DatasourceProfile$outboundSchema: z.ZodType; - -declare type DatasourceProfile = { - /** - * The datasource the profile is of. - */ - datasource: string; - /** - * The display name of the entity in the given datasource. - */ - handle: string; - /** - * URL to view the entity's profile. - */ - url?: string | undefined; - /** - * A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - */ - nativeAppUrl?: string | undefined; - /** - * For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source) - */ - isUserGenerated?: boolean | undefined; -}; - -declare function datasourceProfileFromJSON(jsonString: string): Result; - -declare function datasourceProfileToJSON(datasourceProfile: DatasourceProfile): string; - -declare class Datasources extends ClientSDK { - /** - * Add or update datasource - * - * @remarks - * Add or update a custom datasource and its schema. - */ - add(request: components.CustomDatasourceConfig, options?: RequestOptions): Promise; - /** - * Get datasource config - * - * @remarks - * Fetches the datasource config for the specified custom datasource. - */ - retrieveConfig(request: components.GetDatasourceConfigRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourcesType$ { - /** @deprecated use `DatasourcesType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly All: "ALL"; - readonly Custom: "CUSTOM"; - }>; - /** @deprecated use `DatasourcesType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly All: "ALL"; - readonly Custom: "CUSTOM"; - }>; -} - -/** @internal */ -declare const DatasourcesType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DatasourcesType$outboundSchema: z.ZodNativeEnum; - -/** - * The types of datasource for which to run the report/policy. - */ -declare const DatasourcesType: { - readonly All: "ALL"; - readonly Custom: "CUSTOM"; -}; - -/** - * The types of datasource for which to run the report/policy. - */ -declare type DatasourcesType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceUserDefinition$ { - /** @deprecated use `DatasourceUserDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DatasourceUserDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DatasourceUserDefinition$Outbound` instead. */ - type Outbound = DatasourceUserDefinition$Outbound; -} - -/** @internal */ -declare const DatasourceUserDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DatasourceUserDefinition$Outbound = { - email: string; - userId?: string | undefined; - name: string; - isActive?: boolean | undefined; -}; - -/** @internal */ -declare const DatasourceUserDefinition$outboundSchema: z.ZodType; - -/** - * describes a user in the datasource - */ -declare type DatasourceUserDefinition = { - email: string; - /** - * To be supplied if the user id in the datasource is not the email - */ - userId?: string | undefined; - name: string; - /** - * set to false if the user is a former employee or a bot - */ - isActive?: boolean | undefined; -}; - -declare function datasourceUserDefinitionFromJSON(jsonString: string): Result; - -declare function datasourceUserDefinitionToJSON(datasourceUserDefinition: DatasourceUserDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DatasourceVisibility$ { - /** @deprecated use `DatasourceVisibility$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly EnabledForAll: "ENABLED_FOR_ALL"; - readonly EnabledForTestGroup: "ENABLED_FOR_TEST_GROUP"; - readonly NotEnabled: "NOT_ENABLED"; - }>; - /** @deprecated use `DatasourceVisibility$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly EnabledForAll: "ENABLED_FOR_ALL"; - readonly EnabledForTestGroup: "ENABLED_FOR_TEST_GROUP"; - readonly NotEnabled: "NOT_ENABLED"; - }>; -} - -/** @internal */ -declare const DatasourceVisibility$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DatasourceVisibility$outboundSchema: z.ZodNativeEnum; - -/** - * The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE - */ -declare const DatasourceVisibility: { - readonly EnabledForAll: "ENABLED_FOR_ALL"; - readonly EnabledForTestGroup: "ENABLED_FOR_TEST_GROUP"; - readonly NotEnabled: "NOT_ENABLED"; -}; - -/** - * The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE - */ -declare type DatasourceVisibility = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDatasourceStatusIdentityResponseComponent$ { - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponent$Outbound` instead. */ - type Outbound = DebugDatasourceStatusIdentityResponseComponent$Outbound; -} - -/** @internal */ -declare const DebugDatasourceStatusIdentityResponseComponent$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDatasourceStatusIdentityResponseComponent$Outbound = { - bulkUploadHistory?: Array | undefined; - counts?: DebugDatasourceStatusIdentityResponseComponentCounts$Outbound | undefined; -}; - -/** @internal */ -declare const DebugDatasourceStatusIdentityResponseComponent$outboundSchema: z.ZodType; - -declare type DebugDatasourceStatusIdentityResponseComponent = { - /** - * Information about active and recent successful uploads for the datasource - */ - bulkUploadHistory?: Array | undefined; - counts?: DebugDatasourceStatusIdentityResponseComponentCounts | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDatasourceStatusIdentityResponseComponentCounts$ { - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusIdentityResponseComponentCounts$Outbound` instead. */ - type Outbound = DebugDatasourceStatusIdentityResponseComponentCounts$Outbound; -} - -/** @internal */ -declare const DebugDatasourceStatusIdentityResponseComponentCounts$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDatasourceStatusIdentityResponseComponentCounts$Outbound = { - uploaded?: number | undefined; -}; - -/** @internal */ -declare const DebugDatasourceStatusIdentityResponseComponentCounts$outboundSchema: z.ZodType; - -declare type DebugDatasourceStatusIdentityResponseComponentCounts = { - /** - * The number of users/groups/memberships uploaded - */ - uploaded?: number | undefined; -}; - -declare function debugDatasourceStatusIdentityResponseComponentCountsFromJSON(jsonString: string): Result; - -declare function debugDatasourceStatusIdentityResponseComponentCountsToJSON(debugDatasourceStatusIdentityResponseComponentCounts: DebugDatasourceStatusIdentityResponseComponentCounts): string; - -declare function debugDatasourceStatusIdentityResponseComponentFromJSON(jsonString: string): Result; - -declare function debugDatasourceStatusIdentityResponseComponentToJSON(debugDatasourceStatusIdentityResponseComponent: DebugDatasourceStatusIdentityResponseComponent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDatasourceStatusResponse$ { - /** @deprecated use `DebugDatasourceStatusResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusResponse$Outbound` instead. */ - type Outbound = DebugDatasourceStatusResponse$Outbound; -} - -/** @internal */ -declare const DebugDatasourceStatusResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDatasourceStatusResponse$Outbound = { - documents?: Documents$Outbound | undefined; - identity?: Identity$Outbound | undefined; - datasourceVisibility?: string | undefined; -}; - -/** @internal */ -declare const DebugDatasourceStatusResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /debug/{datasource}/status API call - */ -declare type DebugDatasourceStatusResponse = { - documents?: Documents | undefined; - identity?: Identity | undefined; - /** - * The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE - */ - datasourceVisibility?: DatasourceVisibility | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDatasourceStatusResponseCounts$ { - /** @deprecated use `DebugDatasourceStatusResponseCounts$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusResponseCounts$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDatasourceStatusResponseCounts$Outbound` instead. */ - type Outbound = DebugDatasourceStatusResponseCounts$Outbound; -} - -/** @internal */ -declare const DebugDatasourceStatusResponseCounts$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDatasourceStatusResponseCounts$Outbound = { - uploaded?: Array | undefined; - indexed?: Array | undefined; -}; - -/** @internal */ -declare const DebugDatasourceStatusResponseCounts$outboundSchema: z.ZodType; - -declare type DebugDatasourceStatusResponseCounts = { - /** - * A list of object types and corresponding upload counts - */ - uploaded?: Array | undefined; - /** - * The number of documents indexed, grouped by objectType - */ - indexed?: Array | undefined; -}; - -declare function debugDatasourceStatusResponseCountsFromJSON(jsonString: string): Result; - -declare function debugDatasourceStatusResponseCountsToJSON(debugDatasourceStatusResponseCounts: DebugDatasourceStatusResponseCounts): string; - -declare function debugDatasourceStatusResponseFromJSON(jsonString: string): Result; - -declare function debugDatasourceStatusResponseToJSON(debugDatasourceStatusResponse: DebugDatasourceStatusResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDocumentRequest$ { - /** @deprecated use `DebugDocumentRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentRequest$Outbound` instead. */ - type Outbound = DebugDocumentRequest$Outbound; -} - -/** @internal */ -declare const DebugDocumentRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDocumentRequest$Outbound = { - objectType: string; - docId: string; -}; - -/** @internal */ -declare const DebugDocumentRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /debug/{datasource}/document API call. - */ -declare type DebugDocumentRequest = { - /** - * Object type of the document to get the status for. - */ - objectType: string; - /** - * Glean Document ID within the datasource to get the status for. - */ - docId: string; -}; - -declare function debugDocumentRequestFromJSON(jsonString: string): Result; - -declare function debugDocumentRequestToJSON(debugDocumentRequest: DebugDocumentRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDocumentResponse$ { - /** @deprecated use `DebugDocumentResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentResponse$Outbound` instead. */ - type Outbound = DebugDocumentResponse$Outbound; -} - -/** @internal */ -declare const DebugDocumentResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDocumentResponse$Outbound = { - status?: DocumentStatusResponse$Outbound | undefined; - uploadedPermissions?: DocumentPermissionsDefinition$Outbound | undefined; -}; - -/** @internal */ -declare const DebugDocumentResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /debug/{datasource}/document API call - */ -declare type DebugDocumentResponse = { - /** - * Describes the document status response body - */ - status?: DocumentStatusResponse | undefined; - /** - * describes the access control details of the document - */ - uploadedPermissions?: DocumentPermissionsDefinition | undefined; -}; - -declare function debugDocumentResponseFromJSON(jsonString: string): Result; - -declare function debugDocumentResponseToJSON(debugDocumentResponse: DebugDocumentResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDocumentsRequest$ { - /** @deprecated use `DebugDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsRequest$Outbound` instead. */ - type Outbound = DebugDocumentsRequest$Outbound; -} - -/** @internal */ -declare const DebugDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDocumentsRequest$Outbound = { - debugDocuments: Array; -}; - -/** @internal */ -declare const DebugDocumentsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /debug/{datasource}/documents API call. - */ -declare type DebugDocumentsRequest = { - /** - * Documents to fetch debug information for - */ - debugDocuments: Array; -}; - -declare function debugDocumentsRequestFromJSON(jsonString: string): Result; - -declare function debugDocumentsRequestToJSON(debugDocumentsRequest: DebugDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDocumentsResponse$ { - /** @deprecated use `DebugDocumentsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsResponse$Outbound` instead. */ - type Outbound = DebugDocumentsResponse$Outbound; -} - -/** @internal */ -declare const DebugDocumentsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDocumentsResponse$Outbound = { - documentStatuses?: Array | undefined; -}; - -/** @internal */ -declare const DebugDocumentsResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of a single document in the /debug/{datasource}/documents API call - */ -declare type DebugDocumentsResponse = { - /** - * List of document ids/urls and their debug information - */ - documentStatuses?: Array | undefined; -}; - -declare function debugDocumentsResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugDocumentsResponseItem$ { - /** @deprecated use `DebugDocumentsResponseItem$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsResponseItem$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugDocumentsResponseItem$Outbound` instead. */ - type Outbound = DebugDocumentsResponseItem$Outbound; -} - -/** @internal */ -declare const DebugDocumentsResponseItem$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugDocumentsResponseItem$Outbound = { - docId?: string | undefined; - objectType?: string | undefined; - debugInfo?: DebugDocumentResponse$Outbound | undefined; -}; - -/** @internal */ -declare const DebugDocumentsResponseItem$outboundSchema: z.ZodType; - -/** - * Describes the response body of a single document in the /debug/{datasource}/documents API call - */ -declare type DebugDocumentsResponseItem = { - /** - * Id of the document - */ - docId?: string | undefined; - /** - * objectType of the document - */ - objectType?: string | undefined; - /** - * Describes the response body of the /debug/{datasource}/document API call - */ - debugInfo?: DebugDocumentResponse | undefined; -}; - -declare function debugDocumentsResponseItemFromJSON(jsonString: string): Result; - -declare function debugDocumentsResponseItemToJSON(debugDocumentsResponseItem: DebugDocumentsResponseItem): string; - -declare function debugDocumentsResponseToJSON(debugDocumentsResponse: DebugDocumentsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugUserRequest$ { - /** @deprecated use `DebugUserRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugUserRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugUserRequest$Outbound` instead. */ - type Outbound = DebugUserRequest$Outbound; -} - -/** @internal */ -declare const DebugUserRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugUserRequest$Outbound = { - email: string; -}; - -/** @internal */ -declare const DebugUserRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /debug/{datasource}/user API call - */ -declare type DebugUserRequest = { - /** - * Email ID of the user to get the status for - */ - email: string; -}; - -declare function debugUserRequestFromJSON(jsonString: string): Result; - -declare function debugUserRequestToJSON(debugUserRequest: DebugUserRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DebugUserResponse$ { - /** @deprecated use `DebugUserResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DebugUserResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DebugUserResponse$Outbound` instead. */ - type Outbound = DebugUserResponse$Outbound; -} - -/** @internal */ -declare const DebugUserResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DebugUserResponse$Outbound = { - status?: UserStatusResponse$Outbound | undefined; - uploadedGroups?: Array | undefined; -}; - -/** @internal */ -declare const DebugUserResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /debug/{datasource}/user API call - */ -declare type DebugUserResponse = { - /** - * Describes the user status response body - */ - status?: UserStatusResponse | undefined; - /** - * List of groups the user is a member of, as uploaded via permissions API. - */ - uploadedGroups?: Array | undefined; -}; - -declare function debugUserResponseFromJSON(jsonString: string): Result; - -declare function debugUserResponseToJSON(debugUserResponse: DebugUserResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteallchatsRequest$ { - /** @deprecated use `DeleteallchatsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteallchatsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteallchatsRequest$Outbound` instead. */ - type Outbound = DeleteallchatsRequest$Outbound; -} - -/** @internal */ -declare const DeleteallchatsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteallchatsRequest$Outbound = { - timezoneOffset?: number | undefined; -}; - -/** @internal */ -declare const DeleteallchatsRequest$outboundSchema: z.ZodType; - -declare type DeleteallchatsRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; -}; - -declare function deleteallchatsRequestFromJSON(jsonString: string): Result; - -declare function deleteallchatsRequestToJSON(deleteallchatsRequest: DeleteallchatsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteAnnouncementRequest$ { - /** @deprecated use `DeleteAnnouncementRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteAnnouncementRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteAnnouncementRequest$Outbound` instead. */ - type Outbound = DeleteAnnouncementRequest$Outbound; -} - -/** @internal */ -declare const DeleteAnnouncementRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteAnnouncementRequest$Outbound = { - id: number; -}; - -/** @internal */ -declare const DeleteAnnouncementRequest$outboundSchema: z.ZodType; - -declare type DeleteAnnouncementRequest = { - /** - * The opaque id of the announcement to be deleted. - */ - id: number; -}; - -declare function deleteAnnouncementRequestFromJSON(jsonString: string): Result; - -declare function deleteAnnouncementRequestToJSON(deleteAnnouncementRequest: DeleteAnnouncementRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteAnswerRequest$ { - /** @deprecated use `DeleteAnswerRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteAnswerRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteAnswerRequest$Outbound` instead. */ - type Outbound = DeleteAnswerRequest$Outbound; -} - -/** @internal */ -declare const DeleteAnswerRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteAnswerRequest$Outbound = { - id: number; - docId?: string | undefined; -}; - -/** @internal */ -declare const DeleteAnswerRequest$outboundSchema: z.ZodType; - -declare type DeleteAnswerRequest = { - /** - * The opaque ID of the Answer. - */ - id: number; - /** - * Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - */ - docId?: string | undefined; -}; - -declare function deleteAnswerRequestFromJSON(jsonString: string): Result; - -declare function deleteAnswerRequestToJSON(deleteAnswerRequest: DeleteAnswerRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteChatFilesRequest$ { - /** @deprecated use `DeleteChatFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteChatFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteChatFilesRequest$Outbound` instead. */ - type Outbound = DeleteChatFilesRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeletechatfilesRequest$ { - /** @deprecated use `DeletechatfilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeletechatfilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeletechatfilesRequest$Outbound` instead. */ - type Outbound = DeletechatfilesRequest$Outbound; -} - -/** @internal */ -declare const DeleteChatFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const DeletechatfilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteChatFilesRequest$Outbound = { - fileIds: Array; -}; - -/** @internal */ -declare type DeletechatfilesRequest$Outbound = { - timezoneOffset?: number | undefined; - DeleteChatFilesRequest: components.DeleteChatFilesRequest$Outbound; -}; - -/** @internal */ -declare const DeleteChatFilesRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const DeletechatfilesRequest$outboundSchema: z.ZodType; - -declare type DeleteChatFilesRequest = { - /** - * IDs of files to delete. - */ - fileIds: Array; -}; - -declare type DeletechatfilesRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - deleteChatFilesRequest: components.DeleteChatFilesRequest; -}; - -declare function deleteChatFilesRequestFromJSON(jsonString: string): Result; - -declare function deletechatfilesRequestFromJSON(jsonString: string): Result; - -declare function deleteChatFilesRequestToJSON(deleteChatFilesRequest: DeleteChatFilesRequest): string; - -declare function deletechatfilesRequestToJSON(deletechatfilesRequest: DeletechatfilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteChatsRequest$ { - /** @deprecated use `DeleteChatsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteChatsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteChatsRequest$Outbound` instead. */ - type Outbound = DeleteChatsRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeletechatsRequest$ { - /** @deprecated use `DeletechatsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeletechatsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeletechatsRequest$Outbound` instead. */ - type Outbound = DeletechatsRequest$Outbound; -} - -/** @internal */ -declare const DeleteChatsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const DeletechatsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteChatsRequest$Outbound = { - ids: Array; -}; - -/** @internal */ -declare type DeletechatsRequest$Outbound = { - timezoneOffset?: number | undefined; - DeleteChatsRequest: components.DeleteChatsRequest$Outbound; -}; - -/** @internal */ -declare const DeleteChatsRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const DeletechatsRequest$outboundSchema: z.ZodType; - -declare type DeleteChatsRequest = { - /** - * A non-empty list of ids of the Chats to be deleted. - */ - ids: Array; -}; - -declare type DeletechatsRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - deleteChatsRequest: components.DeleteChatsRequest; -}; - -declare function deleteChatsRequestFromJSON(jsonString: string): Result; - -declare function deletechatsRequestFromJSON(jsonString: string): Result; - -declare function deleteChatsRequestToJSON(deleteChatsRequest: DeleteChatsRequest): string; - -declare function deletechatsRequestToJSON(deletechatsRequest: DeletechatsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteCollectionItemRequest$ { - /** @deprecated use `DeleteCollectionItemRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionItemRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionItemRequest$Outbound` instead. */ - type Outbound = DeleteCollectionItemRequest$Outbound; -} - -/** @internal */ -declare const DeleteCollectionItemRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteCollectionItemRequest$Outbound = { - collectionId: number; - itemId: string; - documentId?: string | undefined; -}; - -/** @internal */ -declare const DeleteCollectionItemRequest$outboundSchema: z.ZodType; - -declare type DeleteCollectionItemRequest = { - /** - * The ID of the Collection to remove an item in. - */ - collectionId: number; - /** - * The item ID of the CollectionItem to remove from this Collection. - */ - itemId: string; - /** - * The (optional) Glean Document ID of the CollectionItem to remove from this Collection if this is an indexed document. - */ - documentId?: string | undefined; -}; - -declare function deleteCollectionItemRequestFromJSON(jsonString: string): Result; - -declare function deleteCollectionItemRequestToJSON(deleteCollectionItemRequest: DeleteCollectionItemRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteCollectionItemResponse$ { - /** @deprecated use `DeleteCollectionItemResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionItemResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionItemResponse$Outbound` instead. */ - type Outbound = DeleteCollectionItemResponse$Outbound; -} - -/** @internal */ -declare const DeleteCollectionItemResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteCollectionItemResponse$Outbound = { - collection?: Collection$Outbound | undefined; -}; - -/** @internal */ -declare const DeleteCollectionItemResponse$outboundSchema: z.ZodType; - -declare type DeleteCollectionItemResponse = { - collection?: Collection | undefined; -}; - -declare function deleteCollectionItemResponseFromJSON(jsonString: string): Result; - -declare function deleteCollectionItemResponseToJSON(deleteCollectionItemResponse: DeleteCollectionItemResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteCollectionRequest$ { - /** @deprecated use `DeleteCollectionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteCollectionRequest$Outbound` instead. */ - type Outbound = DeleteCollectionRequest$Outbound; -} - -/** @internal */ -declare const DeleteCollectionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteCollectionRequest$Outbound = { - ids: Array; - allowedDatasource?: string | undefined; -}; - -/** @internal */ -declare const DeleteCollectionRequest$outboundSchema: z.ZodType; - -declare type DeleteCollectionRequest = { - /** - * The IDs of the Collections to delete. - */ - ids: Array; - /** - * The datasource allowed in the Collection to be deleted. - */ - allowedDatasource?: string | undefined; -}; - -declare function deleteCollectionRequestFromJSON(jsonString: string): Result; - -declare function deleteCollectionRequestToJSON(deleteCollectionRequest: DeleteCollectionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteDocumentRequest$ { - /** @deprecated use `DeleteDocumentRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteDocumentRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteDocumentRequest$Outbound` instead. */ - type Outbound = DeleteDocumentRequest$Outbound; -} - -/** @internal */ -declare const DeleteDocumentRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteDocumentRequest$Outbound = { - version?: number | undefined; - datasource: string; - objectType: string; - id: string; -}; - -/** @internal */ -declare const DeleteDocumentRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deletedocument API call - */ -declare type DeleteDocumentRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * datasource of the document - */ - datasource: string; - /** - * object type of the document - */ - objectType: string; - /** - * The id of the document - */ - id: string; -}; - -declare function deleteDocumentRequestFromJSON(jsonString: string): Result; - -declare function deleteDocumentRequestToJSON(deleteDocumentRequest: DeleteDocumentRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteEmployeeRequest$ { - /** @deprecated use `DeleteEmployeeRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteEmployeeRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteEmployeeRequest$Outbound` instead. */ - type Outbound = DeleteEmployeeRequest$Outbound; -} - -/** @internal */ -declare const DeleteEmployeeRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteEmployeeRequest$Outbound = { - version?: number | undefined; - employeeEmail: string; -}; - -/** @internal */ -declare const DeleteEmployeeRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deleteemployee API call - */ -declare type DeleteEmployeeRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The deleted employee's email - */ - employeeEmail: string; -}; - -declare function deleteEmployeeRequestFromJSON(jsonString: string): Result; - -declare function deleteEmployeeRequestToJSON(deleteEmployeeRequest: DeleteEmployeeRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteGroupRequest$ { - /** @deprecated use `DeleteGroupRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteGroupRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteGroupRequest$Outbound` instead. */ - type Outbound = DeleteGroupRequest$Outbound; -} - -/** @internal */ -declare const DeleteGroupRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteGroupRequest$Outbound = { - version?: number | undefined; - datasource: string; - groupName: string; -}; - -/** @internal */ -declare const DeleteGroupRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deletegroup API call - */ -declare type DeleteGroupRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the group is removed - */ - datasource: string; - /** - * the name of the group to be deleted - */ - groupName: string; -}; - -declare function deleteGroupRequestFromJSON(jsonString: string): Result; - -declare function deleteGroupRequestToJSON(deleteGroupRequest: DeleteGroupRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteMembershipRequest$ { - /** @deprecated use `DeleteMembershipRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteMembershipRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteMembershipRequest$Outbound` instead. */ - type Outbound = DeleteMembershipRequest$Outbound; -} - -/** @internal */ -declare const DeleteMembershipRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteMembershipRequest$Outbound = { - version?: number | undefined; - datasource: string; - membership: DatasourceMembershipDefinition$Outbound; -}; - -/** @internal */ -declare const DeleteMembershipRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deletemembership API call - */ -declare type DeleteMembershipRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the membership is removed - */ - datasource: string; - /** - * describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - */ - membership: DatasourceMembershipDefinition; -}; - -declare function deleteMembershipRequestFromJSON(jsonString: string): Result; - -declare function deleteMembershipRequestToJSON(deleteMembershipRequest: DeleteMembershipRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteShortcutRequest$ { - /** @deprecated use `DeleteShortcutRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteShortcutRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteShortcutRequest$Outbound` instead. */ - type Outbound = DeleteShortcutRequest$Outbound; -} - -/** @internal */ -declare const DeleteShortcutRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteShortcutRequest$Outbound = { - id: number; -}; - -/** @internal */ -declare const DeleteShortcutRequest$outboundSchema: z.ZodType; - -declare type DeleteShortcutRequest = { - /** - * The opaque id of the user generated content. - */ - id: number; -}; - -declare function deleteShortcutRequestFromJSON(jsonString: string): Result; - -declare function deleteShortcutRequestToJSON(deleteShortcutRequest: DeleteShortcutRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteTeamRequest$ { - /** @deprecated use `DeleteTeamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteTeamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteTeamRequest$Outbound` instead. */ - type Outbound = DeleteTeamRequest$Outbound; -} - -/** @internal */ -declare const DeleteTeamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteTeamRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare const DeleteTeamRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deleteteam API call - */ -declare type DeleteTeamRequest = { - /** - * The deleted team's id - */ - id: string; -}; - -declare function deleteTeamRequestFromJSON(jsonString: string): Result; - -declare function deleteTeamRequestToJSON(deleteTeamRequest: DeleteTeamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteUserRequest$ { - /** @deprecated use `DeleteUserRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteUserRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteUserRequest$Outbound` instead. */ - type Outbound = DeleteUserRequest$Outbound; -} - -/** @internal */ -declare const DeleteUserRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteUserRequest$Outbound = { - version?: number | undefined; - datasource: string; - email: string; -}; - -/** @internal */ -declare const DeleteUserRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /deleteuser API call - */ -declare type DeleteUserRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the user is removed - */ - datasource: string; - /** - * The email of the user to be deleted - */ - email: string; -}; - -declare function deleteUserRequestFromJSON(jsonString: string): Result; - -declare function deleteUserRequestToJSON(deleteUserRequest: DeleteUserRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Digest$ { - /** @deprecated use `Digest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Digest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Digest$Outbound` instead. */ - type Outbound = Digest$Outbound; -} - -/** @internal */ -declare const Digest$inboundSchema: z.ZodType; - -/** @internal */ -declare type Digest$Outbound = { - podcastFileId?: string | undefined; - podcastDuration?: number | undefined; - digestDate?: string | undefined; - sections?: Array | undefined; -}; - -/** @internal */ -declare const Digest$outboundSchema: z.ZodType; - -declare type Digest = { - /** - * Identifier for the podcast file generated from this digest content. - */ - podcastFileId?: string | undefined; - /** - * Duration of the podcast file in seconds. - */ - podcastDuration?: number | undefined; - /** - * The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available. - */ - digestDate?: string | undefined; - /** - * Array of digest sections from which the podcast was created. - */ - sections?: Array | undefined; -}; - -declare function digestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DigestSection$ { - /** @deprecated use `DigestSection$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DigestSection$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DigestSection$Outbound` instead. */ - type Outbound = DigestSection$Outbound; -} - -/** @internal */ -declare const DigestSection$inboundSchema: z.ZodType; - -/** @internal */ -declare type DigestSection$Outbound = { - id: string; - type: string; - displayName?: string | undefined; - channelName?: string | undefined; - channelType?: string | undefined; - instanceId?: string | undefined; - url?: string | undefined; - updates: Array; -}; - -/** @internal */ -declare const DigestSection$outboundSchema: z.ZodType; - -declare type DigestSection = { - /** - * Unique identifier for the digest section. - */ - id: string; - /** - * Type of the section. This defines how the section should be interpreted and rendered in the digest. - */ - type: SectionType; - /** - * Human-readable name for the digest section. - */ - displayName?: string | undefined; - /** - * Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. - */ - channelName?: string | undefined; - /** - * Channel visibility/type for CHANNEL sections. For Slack this is typically one of - * - * @remarks - * PublicChannel, PrivateChannel. Omit if not applicable or unknown. - */ - channelType?: string | undefined; - /** - * Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. - */ - instanceId?: string | undefined; - /** - * Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. - */ - url?: string | undefined; - /** - * List of updates within this digest section. - */ - updates: Array; -}; - -declare function digestSectionFromJSON(jsonString: string): Result; - -declare function digestSectionToJSON(digestSection: DigestSection): string; - -declare function digestToJSON(digest: Digest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DigestUpdate$ { - /** @deprecated use `DigestUpdate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DigestUpdate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DigestUpdate$Outbound` instead. */ - type Outbound = DigestUpdate$Outbound; -} - -/** @internal */ -declare const DigestUpdate$inboundSchema: z.ZodType; - -/** @internal */ -declare type DigestUpdate$Outbound = { - url?: string | undefined; - title?: string | undefined; - datasource?: string | undefined; - summary?: string | undefined; - type?: string | undefined; -}; - -/** @internal */ -declare const DigestUpdate$outboundSchema: z.ZodType; - -declare type DigestUpdate = { - /** - * URL link to the content or document. - */ - url?: string | undefined; - /** - * Title or headline of the update. - */ - title?: string | undefined; - /** - * Name or identifier of the data source (e.g., slack, confluence, etc.). - */ - datasource?: string | undefined; - /** - * Brief summary or description of the update content. - */ - summary?: string | undefined; - /** - * Optional type classification for the update. - */ - type?: UpdateType | undefined; -}; - -declare function digestUpdateFromJSON(jsonString: string): Result; - -declare function digestUpdateToJSON(digestUpdate: DigestUpdate): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Direction$ { - /** @deprecated use `Direction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Older: "OLDER"; - readonly Newer: "NEWER"; - }>; - /** @deprecated use `Direction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Older: "OLDER"; - readonly Newer: "NEWER"; - }>; -} - -/** @internal */ -declare const Direction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Direction$outboundSchema: z.ZodNativeEnum; - -/** - * The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. - */ -declare const Direction: { - readonly Older: "OLDER"; - readonly Newer: "NEWER"; -}; - -/** - * The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. - */ -declare type Direction = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Disambiguation$ { - /** @deprecated use `Disambiguation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Disambiguation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Disambiguation$Outbound` instead. */ - type Outbound = Disambiguation$Outbound; -} - -/** @internal */ -declare const Disambiguation$inboundSchema: z.ZodType; - -/** @internal */ -declare type Disambiguation$Outbound = { - name?: string | undefined; - id?: string | undefined; - type?: string | undefined; -}; - -/** @internal */ -declare const Disambiguation$outboundSchema: z.ZodType; - -/** - * A disambiguation between multiple entities with the same name - */ -declare type Disambiguation = { - /** - * Name of the ambiguous entity - */ - name?: string | undefined; - /** - * The unique id of the entity in the knowledge graph - */ - id?: string | undefined; - /** - * The type of entity. - */ - type?: EntityType | undefined; -}; - -declare function disambiguationFromJSON(jsonString: string): Result; - -declare function disambiguationToJSON(disambiguation: Disambiguation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DisplayableListItemUIConfig$ { - /** @deprecated use `DisplayableListItemUIConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DisplayableListItemUIConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DisplayableListItemUIConfig$Outbound` instead. */ - type Outbound = DisplayableListItemUIConfig$Outbound; -} - -/** @internal */ -declare const DisplayableListItemUIConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type DisplayableListItemUIConfig$Outbound = { - showNewIndicator?: boolean | undefined; -}; - -/** @internal */ -declare const DisplayableListItemUIConfig$outboundSchema: z.ZodType; - -/** - * UI configurations for each item of the list - */ -declare type DisplayableListItemUIConfig = { - /** - * show a "New" pill next to the item - */ - showNewIndicator?: boolean | undefined; -}; - -declare function displayableListItemUIConfigFromJSON(jsonString: string): Result; - -declare function displayableListItemUIConfigToJSON(displayableListItemUIConfig: DisplayableListItemUIConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpConfig$ { - /** @deprecated use `DlpConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DlpConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DlpConfig$Outbound` instead. */ - type Outbound = DlpConfig$Outbound; -} - -/** @internal */ -declare const DlpConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type DlpConfig$Outbound = { - version?: number | undefined; - sensitiveInfoTypes?: Array | undefined; - inputOptions?: InputOptions$Outbound | undefined; - externalSharingOptions?: ExternalSharingOptions$Outbound | undefined; - broadSharingOptions?: SharingOptions$Outbound | undefined; - sensitiveContentOptions?: SensitiveContentOptions$Outbound | undefined; - reportName?: string | undefined; - frequency?: string | undefined; - createdBy?: DlpPerson$Outbound | undefined; - createdAt?: string | undefined; - redactQuote?: boolean | undefined; - autoHideDocs?: boolean | undefined; - allowlistOptions?: AllowlistOptions$Outbound | undefined; -}; - -/** @internal */ -declare const DlpConfig$outboundSchema: z.ZodType; - -/** - * Detailed configuration of what documents and sensitive content will be scanned. - */ -declare type DlpConfig = { - /** - * Synonymous with report/policy id. - */ - version?: number | undefined; - /** - * DEPRECATED - use `sensitiveContentOptions` instead. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - sensitiveInfoTypes?: Array | undefined; - /** - * Controls which data-sources and what time-range to include in scans. - */ - inputOptions?: InputOptions | undefined; - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - externalSharingOptions?: ExternalSharingOptions | undefined; - /** - * Controls how "shared" a document must be to get picked for scans. - */ - broadSharingOptions?: SharingOptions | undefined; - /** - * Options for defining sensitive content within scanned documents. - */ - sensitiveContentOptions?: SensitiveContentOptions | undefined; - reportName?: string | undefined; - /** - * Interval between scans. - */ - frequency?: string | undefined; - /** - * Details about the person who created this report/policy. - */ - createdBy?: DlpPerson | undefined; - /** - * Timestamp at which this configuration was created. - */ - createdAt?: string | undefined; - /** - * redact quote in findings of the report - */ - redactQuote?: boolean | undefined; - /** - * auto hide documents with findings in the report - */ - autoHideDocs?: boolean | undefined; - /** - * Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - */ - allowlistOptions?: AllowlistOptions | undefined; -}; - -declare function dlpConfigFromJSON(jsonString: string): Result; - -declare function dlpConfigToJSON(dlpConfig: DlpConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpFrequency$ { - /** @deprecated use `DlpFrequency$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Once: "ONCE"; - readonly Daily: "DAILY"; - readonly Weekly: "WEEKLY"; - readonly Continuous: "CONTINUOUS"; - readonly None: "NONE"; - }>; - /** @deprecated use `DlpFrequency$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Once: "ONCE"; - readonly Daily: "DAILY"; - readonly Weekly: "WEEKLY"; - readonly Continuous: "CONTINUOUS"; - readonly None: "NONE"; - }>; -} - -/** @internal */ -declare const DlpFrequency$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DlpFrequency$outboundSchema: z.ZodNativeEnum; - -/** - * Interval between scans. DAILY is deprecated. - */ -declare const DlpFrequency: { - readonly Once: "ONCE"; - readonly Daily: "DAILY"; - readonly Weekly: "WEEKLY"; - readonly Continuous: "CONTINUOUS"; - readonly None: "NONE"; -}; - -/** - * Interval between scans. DAILY is deprecated. - */ -declare type DlpFrequency = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpPerson$ { - /** @deprecated use `DlpPerson$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DlpPerson$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DlpPerson$Outbound` instead. */ - type Outbound = DlpPerson$Outbound; -} - -/** @internal */ -declare const DlpPerson$inboundSchema: z.ZodType; - -/** @internal */ -declare type DlpPerson$Outbound = { - name: string; - obfuscatedId: string; - metadata?: DlpPersonMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const DlpPerson$outboundSchema: z.ZodType; - -/** - * Details about the person who created this report/policy. - */ -declare type DlpPerson = { - /** - * The display name. - */ - name: string; - /** - * An opaque identifier that can be used to request metadata for a Person. - */ - obfuscatedId: string; - metadata?: DlpPersonMetadata | undefined; -}; - -declare function dlpPersonFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpPersonMetadata$ { - /** @deprecated use `DlpPersonMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DlpPersonMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DlpPersonMetadata$Outbound` instead. */ - type Outbound = DlpPersonMetadata$Outbound; -} - -/** @internal */ -declare const DlpPersonMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type DlpPersonMetadata$Outbound = { - firstName?: string | undefined; - email?: string | undefined; -}; - -/** @internal */ -declare const DlpPersonMetadata$outboundSchema: z.ZodType; - -declare type DlpPersonMetadata = { - /** - * The first name of the person - */ - firstName?: string | undefined; - /** - * The user's primary email address - */ - email?: string | undefined; -}; - -declare function dlpPersonMetadataFromJSON(jsonString: string): Result; - -declare function dlpPersonMetadataToJSON(dlpPersonMetadata: DlpPersonMetadata): string; - -declare function dlpPersonToJSON(dlpPerson: DlpPerson): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpReport$ { - /** @deprecated use `DlpReport$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DlpReport$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DlpReport$Outbound` instead. */ - type Outbound = DlpReport$Outbound; -} - -/** @internal */ -declare const DlpReport$inboundSchema: z.ZodType; - -/** @internal */ -declare type DlpReport$Outbound = { - id?: string | undefined; - name?: string | undefined; - config?: DlpConfig$Outbound | undefined; - frequency?: string | undefined; - status?: string | undefined; - createdBy?: DlpPerson$Outbound | undefined; - createdAt?: string | undefined; - lastUpdatedAt?: string | undefined; - autoHideDocs?: boolean | undefined; - lastScanStatus?: string | undefined; - lastScanStartTime?: string | undefined; - updatedBy?: DlpPerson$Outbound | undefined; -}; - -/** @internal */ -declare const DlpReport$outboundSchema: z.ZodType; - -/** - * Full policy information that will be used for scans. - */ -declare type DlpReport = { - id?: string | undefined; - name?: string | undefined; - /** - * Detailed configuration of what documents and sensitive content will be scanned. - */ - config?: DlpConfig | undefined; - /** - * Interval between scans. DAILY is deprecated. - */ - frequency?: DlpFrequency | undefined; - /** - * The status of the policy/report. Only ACTIVE status will be picked for scans. - */ - status?: DlpReportStatus | undefined; - /** - * Details about the person who created this report/policy. - */ - createdBy?: DlpPerson | undefined; - /** - * Timestamp at which the policy was created. - */ - createdAt?: string | undefined; - /** - * Timestamp at which the policy was last updated. - */ - lastUpdatedAt?: string | undefined; - /** - * Auto hide documents with findings in the policy. - */ - autoHideDocs?: boolean | undefined; - lastScanStatus?: LastScanStatus | undefined; - /** - * The timestamp at which the report's last run/scan began. - */ - lastScanStartTime?: string | undefined; - /** - * Details about the person who created this report/policy. - */ - updatedBy?: DlpPerson | undefined; -}; - -declare function dlpReportFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpReportStatus$ { - /** @deprecated use `DlpReportStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Active: "ACTIVE"; - readonly Inactive: "INACTIVE"; - readonly Cancelled: "CANCELLED"; - readonly None: "NONE"; - }>; - /** @deprecated use `DlpReportStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Active: "ACTIVE"; - readonly Inactive: "INACTIVE"; - readonly Cancelled: "CANCELLED"; - readonly None: "NONE"; - }>; -} - -/** @internal */ -declare const DlpReportStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DlpReportStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The status of the policy/report. Only ACTIVE status will be picked for scans. - */ -declare const DlpReportStatus: { - readonly Active: "ACTIVE"; - readonly Inactive: "INACTIVE"; - readonly Cancelled: "CANCELLED"; - readonly None: "NONE"; -}; - -/** - * The status of the policy/report. Only ACTIVE status will be picked for scans. - */ -declare type DlpReportStatus = ClosedEnum; - -declare function dlpReportToJSON(dlpReport: DlpReport): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DlpSimpleResult$ { - /** @deprecated use `DlpSimpleResult$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - }>; - /** @deprecated use `DlpSimpleResult$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - }>; -} - -/** @internal */ -declare const DlpSimpleResult$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DlpSimpleResult$outboundSchema: z.ZodNativeEnum; - -declare const DlpSimpleResult: { - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; -}; - -declare type DlpSimpleResult = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocCategory$ { - /** @deprecated use `DocCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; - }>; - /** @deprecated use `DocCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; - }>; -} - -/** @internal */ -declare const DocCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocCategory$outboundSchema: z.ZodNativeEnum; - -/** - * The document category of this object type. - */ -declare const DocCategory: { - readonly Uncategorized: "UNCATEGORIZED"; - readonly Tickets: "TICKETS"; - readonly Crm: "CRM"; - readonly PublishedContent: "PUBLISHED_CONTENT"; - readonly CollaborativeContent: "COLLABORATIVE_CONTENT"; - readonly QuestionAnswer: "QUESTION_ANSWER"; - readonly Messaging: "MESSAGING"; - readonly CodeRepository: "CODE_REPOSITORY"; - readonly ChangeManagement: "CHANGE_MANAGEMENT"; - readonly People: "PEOPLE"; - readonly Email: "EMAIL"; - readonly Sso: "SSO"; - readonly Ats: "ATS"; - readonly KnowledgeHub: "KNOWLEDGE_HUB"; - readonly ExternalShortcut: "EXTERNAL_SHORTCUT"; - readonly Entity: "ENTITY"; - readonly Calendar: "CALENDAR"; - readonly Agents: "AGENTS"; -}; - -/** - * The document category of this object type. - */ -declare type DocCategory = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Document$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Document$Outbound` instead. */ - type Outbound = Document$Outbound; -} - -/** @internal */ -declare const Document$inboundSchema: z.ZodType; - -/** @internal */ -declare type Document$Outbound = { - id?: string | undefined; - datasource?: string | undefined; - connectorType?: string | undefined; - docType?: string | undefined; - content?: DocumentContent$Outbound | undefined; - containerDocument?: Document$Outbound | undefined; - parentDocument?: Document$Outbound | undefined; - title?: string | undefined; - url?: string | undefined; - metadata?: DocumentMetadata$Outbound | undefined; - sections?: Array | undefined; -}; - -/** @internal */ -declare const Document$outboundSchema: z.ZodType; - -declare type Document_2 = { - /** - * The Glean Document ID. - */ - id?: string | undefined; - /** - * The app or other repository type from which the document was extracted - */ - datasource?: string | undefined; - /** - * The source from which document content was pulled, e.g. an API crawl or browser history - */ - connectorType?: ConnectorType | undefined; - /** - * The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - */ - docType?: string | undefined; - content?: DocumentContent | undefined; - containerDocument?: Document_2 | undefined; - parentDocument?: Document_2 | undefined; - /** - * The title of the document. - */ - title?: string | undefined; - /** - * A permalink for the document. - */ - url?: string | undefined; - metadata?: DocumentMetadata | undefined; - /** - * A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - */ - sections?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentContent$ { - /** @deprecated use `DocumentContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentContent$Outbound` instead. */ - type Outbound = DocumentContent$Outbound; -} - -/** @internal */ -declare const DocumentContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentContent$Outbound = { - fullTextList?: Array | undefined; -}; - -/** @internal */ -declare const DocumentContent$outboundSchema: z.ZodType; - -declare type DocumentContent = { - /** - * The plaintext content of the document. - */ - fullTextList?: Array | undefined; -}; - -declare function documentContentFromJSON(jsonString: string): Result; - -declare function documentContentToJSON(documentContent: DocumentContent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentDefinition$ { - /** @deprecated use `DocumentDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentDefinition$Outbound` instead. */ - type Outbound = DocumentDefinition$Outbound; -} - -/** @internal */ -declare const DocumentDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentDefinition$Outbound = { - title?: string | undefined; - filename?: string | undefined; - container?: string | undefined; - containerDatasourceId?: string | undefined; - containerObjectType?: string | undefined; - datasource: string; - objectType?: string | undefined; - viewURL?: string | undefined; - id?: string | undefined; - summary?: ContentDefinition$Outbound | undefined; - body?: ContentDefinition$Outbound | undefined; - author?: UserReferenceDefinition$Outbound | undefined; - owner?: UserReferenceDefinition$Outbound | undefined; - permissions?: DocumentPermissionsDefinition$Outbound | undefined; - createdAt?: number | undefined; - updatedAt?: number | undefined; - updatedBy?: UserReferenceDefinition$Outbound | undefined; - tags?: Array | undefined; - interactions?: DocumentInteractionsDefinition$Outbound | undefined; - status?: string | undefined; - additionalUrls?: Array | undefined; - comments?: Array | undefined; - customProperties?: Array | undefined; -}; - -/** @internal */ -declare const DocumentDefinition$outboundSchema: z.ZodType; - -/** - * Indexable document structure - */ -declare type DocumentDefinition = { - /** - * Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. - */ - title?: string | undefined; - /** - * Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file. - */ - filename?: string | undefined; - /** - * The container name for the content (Folder for example for file content). - */ - container?: string | undefined; - /** - * This represents the datasource sepcific id of the container. - */ - containerDatasourceId?: string | undefined; - /** - * This represents the object type of the container. It cannot have spaces or _ - */ - containerObjectType?: string | undefined; - datasource: string; - /** - * The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - */ - objectType?: string | undefined; - /** - * The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**' - * - * @remarks - */ - viewURL?: string | undefined; - /** - * The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - */ - id?: string | undefined; - /** - * Describes text content or base64 encoded binary content - */ - summary?: ContentDefinition | undefined; - /** - * Describes text content or base64 encoded binary content - */ - body?: ContentDefinition | undefined; - /** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ - author?: UserReferenceDefinition | undefined; - /** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ - owner?: UserReferenceDefinition | undefined; - /** - * describes the access control details of the document - */ - permissions?: DocumentPermissionsDefinition | undefined; - /** - * The creation time, in epoch seconds. - */ - createdAt?: number | undefined; - /** - * The last update time, in epoch seconds. - */ - updatedAt?: number | undefined; - /** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ - updatedBy?: UserReferenceDefinition | undefined; - /** - * Labels associated with the document. - */ - tags?: Array | undefined; - /** - * describes the interactions on the document - */ - interactions?: DocumentInteractionsDefinition | undefined; - status?: string | undefined; - /** - * Additional variations of the URL that this document points to. - */ - additionalUrls?: Array | undefined; - /** - * Comments associated with the document. - */ - comments?: Array | undefined; - /** - * Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - */ - customProperties?: Array | undefined; -}; - -declare function documentDefinitionFromJSON(jsonString: string): Result; - -declare function documentDefinitionToJSON(documentDefinition: DocumentDefinition): string; - -declare function documentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentInsight$ { - /** @deprecated use `DocumentInsight$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentInsight$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentInsight$Outbound` instead. */ - type Outbound = DocumentInsight$Outbound; -} - -/** @internal */ -declare const DocumentInsight$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentInsight$Outbound = { - document: Document$Outbound; - viewCount?: CountInfo$Outbound | undefined; - visitorCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const DocumentInsight$outboundSchema: z.ZodType; - -declare type DocumentInsight = { - document: Document_2; - viewCount?: CountInfo | undefined; - visitorCount?: CountInfo | undefined; -}; - -declare function documentInsightFromJSON(jsonString: string): Result; - -declare function documentInsightToJSON(documentInsight: DocumentInsight): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentInteractions$ { - /** @deprecated use `DocumentInteractions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentInteractions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentInteractions$Outbound` instead. */ - type Outbound = DocumentInteractions$Outbound; -} - -/** @internal */ -declare const DocumentInteractions$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentInteractions$Outbound = { - numComments?: number | undefined; - numReactions?: number | undefined; - reactions?: Array | undefined; - reacts?: Array | undefined; - shares?: Array | undefined; - visitorCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const DocumentInteractions$outboundSchema: z.ZodType; - -declare type DocumentInteractions = { - /** - * The count of comments (thread replies in the case of slack). - */ - numComments?: number | undefined; - /** - * The count of reactions on the document. - */ - numReactions?: number | undefined; - /** - * To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - reactions?: Array | undefined; - reacts?: Array | undefined; - /** - * Describes instances of someone posting a link to this document in one of our indexed datasources. - */ - shares?: Array | undefined; - visitorCount?: CountInfo | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentInteractionsDefinition$ { - /** @deprecated use `DocumentInteractionsDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentInteractionsDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentInteractionsDefinition$Outbound` instead. */ - type Outbound = DocumentInteractionsDefinition$Outbound; -} - -/** @internal */ -declare const DocumentInteractionsDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentInteractionsDefinition$Outbound = { - numViews?: number | undefined; - numLikes?: number | undefined; - numComments?: number | undefined; -}; - -/** @internal */ -declare const DocumentInteractionsDefinition$outboundSchema: z.ZodType; - -/** - * describes the interactions on the document - */ -declare type DocumentInteractionsDefinition = { - numViews?: number | undefined; - numLikes?: number | undefined; - numComments?: number | undefined; -}; - -declare function documentInteractionsDefinitionFromJSON(jsonString: string): Result; - -declare function documentInteractionsDefinitionToJSON(documentInteractionsDefinition: DocumentInteractionsDefinition): string; - -declare function documentInteractionsFromJSON(jsonString: string): Result; - -declare function documentInteractionsToJSON(documentInteractions: DocumentInteractions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentMetadata$ { - /** @deprecated use `DocumentMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentMetadata$Outbound` instead. */ - type Outbound = DocumentMetadata$Outbound; -} - -/** @internal */ -declare const DocumentMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentMetadata$Outbound = { - datasource?: string | undefined; - datasourceInstance?: string | undefined; - objectType?: string | undefined; - container?: string | undefined; - containerId?: string | undefined; - superContainerId?: string | undefined; - parentId?: string | undefined; - mimeType?: string | undefined; - documentId?: string | undefined; - loggingId?: string | undefined; - documentIdHash?: string | undefined; - createTime?: string | undefined; - updateTime?: string | undefined; - author?: Person$Outbound | undefined; - owner?: Person$Outbound | undefined; - mentionedPeople?: Array | undefined; - visibility?: string | undefined; - components?: Array | undefined; - status?: string | undefined; - statusCategory?: string | undefined; - pins?: Array | undefined; - priority?: string | undefined; - assignedTo?: Person$Outbound | undefined; - updatedBy?: Person$Outbound | undefined; - labels?: Array | undefined; - collections?: Array | undefined; - datasourceId?: string | undefined; - interactions?: DocumentInteractions$Outbound | undefined; - verification?: Verification$Outbound | undefined; - viewerInfo?: ViewerInfo$Outbound | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - visitCount?: CountInfo$Outbound | undefined; - shortcuts?: Array | undefined; - path?: string | undefined; - customData?: { - [k: string]: CustomDataValue$Outbound; - } | undefined; - documentCategory?: string | undefined; - contactPerson?: Person$Outbound | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - indexStatus?: IndexStatus$Outbound | undefined; - ancestors?: Array | undefined; -}; - -/** @internal */ -declare const DocumentMetadata$outboundSchema: z.ZodType; - -declare type DocumentMetadata = { - datasource?: string | undefined; - /** - * The datasource instance from which the document was extracted. - */ - datasourceInstance?: string | undefined; - /** - * The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - */ - objectType?: string | undefined; - /** - * The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - */ - container?: string | undefined; - /** - * The Glean Document ID of the container. Uniquely identifies the container. - */ - containerId?: string | undefined; - /** - * The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - */ - superContainerId?: string | undefined; - /** - * The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - */ - parentId?: string | undefined; - mimeType?: string | undefined; - /** - * The index-wide unique identifier. - */ - documentId?: string | undefined; - /** - * A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - */ - loggingId?: string | undefined; - /** - * Hash of the Glean Document ID. - */ - documentIdHash?: string | undefined; - createTime?: Date | undefined; - updateTime?: Date | undefined; - author?: Person | undefined; - owner?: Person | undefined; - /** - * A list of people mentioned in the document. - */ - mentionedPeople?: Array | undefined; - /** - * The level of visibility of the document as understood by our system. - */ - visibility?: DocumentVisibility | undefined; - /** - * A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).) - */ - components?: Array | undefined; - /** - * The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix). - */ - status?: string | undefined; - /** - * The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource. - */ - statusCategory?: string | undefined; - /** - * A list of stars associated with this result. "Pin" is an older name. - */ - pins?: Array | undefined; - /** - * The document priority. Interpretation is datasource specific. - */ - priority?: string | undefined; - assignedTo?: Person | undefined; - updatedBy?: Person | undefined; - /** - * A list of tags for the document. Interpretation is datasource specific. - */ - labels?: Array | undefined; - /** - * A list of collections that the document belongs to. - */ - collections?: Array | undefined; - /** - * The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number). - */ - datasourceId?: string | undefined; - interactions?: DocumentInteractions | undefined; - verification?: Verification | undefined; - viewerInfo?: ViewerInfo | undefined; - permissions?: ObjectPermissions | undefined; - visitCount?: CountInfo | undefined; - /** - * A list of shortcuts of which destination URL is for the document. - */ - shortcuts?: Array | undefined; - /** - * For file datasources like onedrive/github etc this has the path to the file - */ - path?: string | undefined; - /** - * Custom fields specific to individual datasources - */ - customData?: { - [k: string]: CustomDataValue; - } | undefined; - /** - * The document's document_category(.proto). - */ - documentCategory?: string | undefined; - contactPerson?: Person | undefined; - thumbnail?: Thumbnail | undefined; - indexStatus?: IndexStatus | undefined; - /** - * A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list. - */ - ancestors?: Array | undefined; -}; - -declare function documentMetadataFromJSON(jsonString: string): Result; - -declare function documentMetadataToJSON(documentMetadata: DocumentMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentOrError$ { - /** @deprecated use `DocumentOrError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentOrError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentOrError$Outbound` instead. */ - type Outbound = DocumentOrError$Outbound; -} - -/** @internal */ -declare const DocumentOrError$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentOrError$Outbound = { - error?: string | undefined; -}; - -/** @internal */ -declare const DocumentOrError$outboundSchema: z.ZodType; - -declare type DocumentOrError = { - /** - * The text for error, reason. - */ - error?: string | undefined; -}; - -declare function documentOrErrorFromJSON(jsonString: string): Result; - -declare function documentOrErrorToJSON(documentOrError: DocumentOrError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentOrErrorUnion$ { - /** @deprecated use `DocumentOrErrorUnion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentOrErrorUnion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentOrErrorUnion$Outbound` instead. */ - type Outbound = DocumentOrErrorUnion$Outbound; -} - -/** @internal */ -declare const DocumentOrErrorUnion$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentOrErrorUnion$Outbound = Document$Outbound | DocumentOrError$Outbound; - -/** @internal */ -declare const DocumentOrErrorUnion$outboundSchema: z.ZodType; - -declare type DocumentOrErrorUnion = Document_2 | DocumentOrError; - -declare function documentOrErrorUnionFromJSON(jsonString: string): Result; - -declare function documentOrErrorUnionToJSON(documentOrErrorUnion: DocumentOrErrorUnion): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentPermissionsDefinition$ { - /** @deprecated use `DocumentPermissionsDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentPermissionsDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentPermissionsDefinition$Outbound` instead. */ - type Outbound = DocumentPermissionsDefinition$Outbound; -} - -/** @internal */ -declare const DocumentPermissionsDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentPermissionsDefinition$Outbound = { - allowedUsers?: Array | undefined; - allowedGroups?: Array | undefined; - allowedGroupIntersections?: Array | undefined; - allowAnonymousAccess?: boolean | undefined; - allowAllDatasourceUsersAccess?: boolean | undefined; -}; - -/** @internal */ -declare const DocumentPermissionsDefinition$outboundSchema: z.ZodType; - -/** - * describes the access control details of the document - */ -declare type DocumentPermissionsDefinition = { - /** - * List of users who can view the document - */ - allowedUsers?: Array | undefined; - /** - * List of groups that can view the document - */ - allowedGroups?: Array | undefined; - /** - * List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - */ - allowedGroupIntersections?: Array | undefined; - /** - * If true, then any Glean user can view the document - */ - allowAnonymousAccess?: boolean | undefined; - /** - * If true, then any user who has an account in the datasource can view the document. - */ - allowAllDatasourceUsersAccess?: boolean | undefined; -}; - -declare function documentPermissionsDefinitionFromJSON(jsonString: string): Result; - -declare function documentPermissionsDefinitionToJSON(documentPermissionsDefinition: DocumentPermissionsDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Documents$ { - /** @deprecated use `Documents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Documents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Documents$Outbound` instead. */ - type Outbound = Documents$Outbound; -} - -/** @internal */ -declare const Documents$inboundSchema: z.ZodType; - -/** @internal */ -declare type Documents$Outbound = { - bulkUploadHistory?: Array | undefined; - counts?: DebugDatasourceStatusResponseCounts$Outbound | undefined; - processingHistory?: Array | undefined; -}; - -/** @internal */ -declare const Documents$outboundSchema: z.ZodType; - -declare type Documents = { - /** - * Information about active and recent successful uploads for the datasource - */ - bulkUploadHistory?: Array | undefined; - counts?: DebugDatasourceStatusResponseCounts | undefined; - /** - * Information about processing history for the datasource - */ - processingHistory?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSection$ { - /** @deprecated use `DocumentSection$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSection$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSection$Outbound` instead. */ - type Outbound = DocumentSection$Outbound; -} - -/** @internal */ -declare const DocumentSection$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSection$Outbound = { - title?: string | undefined; - url?: string | undefined; -}; - -/** @internal */ -declare const DocumentSection$outboundSchema: z.ZodType; - -declare type DocumentSection = { - /** - * The title of the document section (e.g. the section header). - */ - title?: string | undefined; - /** - * The permalink of the document section. - */ - url?: string | undefined; -}; - -declare function documentSectionFromJSON(jsonString: string): Result; - -declare function documentSectionToJSON(documentSection: DocumentSection): string; - -declare function documentsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpec1$ { - /** @deprecated use `DocumentSpec1$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec1$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec1$Outbound` instead. */ - type Outbound = DocumentSpec1$Outbound; -} - -/** @internal */ -declare const DocumentSpec1$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSpec1$Outbound = { - url: string; -}; - -/** @internal */ -declare const DocumentSpec1$outboundSchema: z.ZodType; - -declare type DocumentSpec1 = { - /** - * The URL of the document. - */ - url: string; -}; - -declare function documentSpec1FromJSON(jsonString: string): Result; - -declare function documentSpec1ToJSON(documentSpec1: DocumentSpec1): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpec2$ { - /** @deprecated use `DocumentSpec2$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec2$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec2$Outbound` instead. */ - type Outbound = DocumentSpec2$Outbound; -} - -/** @internal */ -declare const DocumentSpec2$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSpec2$Outbound = { - id: string; -}; - -/** @internal */ -declare const DocumentSpec2$outboundSchema: z.ZodType; - -declare type DocumentSpec2 = { - /** - * The ID of the document. - */ - id: string; -}; - -declare function documentSpec2FromJSON(jsonString: string): Result; - -declare function documentSpec2ToJSON(documentSpec2: DocumentSpec2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpec3$ { - /** @deprecated use `DocumentSpec3$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec3$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec3$Outbound` instead. */ - type Outbound = DocumentSpec3$Outbound; -} - -/** @internal */ -declare const DocumentSpec3$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSpec3$Outbound = { - ugcType: string; - contentId: number; - docType?: string | undefined; -}; - -/** @internal */ -declare const DocumentSpec3$outboundSchema: z.ZodType; - -declare type DocumentSpec3 = { - /** - * The type of the user generated content (UGC datasource). - */ - ugcType: DocumentSpecUgcType1; - /** - * The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS. - */ - contentId: number; - /** - * The specific type of the user generated content type. - */ - docType?: string | undefined; -}; - -declare function documentSpec3FromJSON(jsonString: string): Result; - -declare function documentSpec3ToJSON(documentSpec3: DocumentSpec3): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpec4$ { - /** @deprecated use `DocumentSpec4$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec4$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSpec4$Outbound` instead. */ - type Outbound = DocumentSpec4$Outbound; -} - -/** @internal */ -declare const DocumentSpec4$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSpec4$Outbound = { - ugcType: string; - ugcId: string; - docType?: string | undefined; -}; - -/** @internal */ -declare const DocumentSpec4$outboundSchema: z.ZodType; - -declare type DocumentSpec4 = { - /** - * The type of the user generated content (UGC datasource). - */ - ugcType: DocumentSpecUgcType2; - /** - * The string id for user generated content. Used for CHATS. - */ - ugcId: string; - /** - * The specific type of the user generated content type. - */ - docType?: string | undefined; -}; - -declare function documentSpec4FromJSON(jsonString: string): Result; - -declare function documentSpec4ToJSON(documentSpec4: DocumentSpec4): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpecUgcType1$ { - /** @deprecated use `DocumentSpecUgcType1$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; - }>; - /** @deprecated use `DocumentSpecUgcType1$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; - }>; -} - -/** @internal */ -declare const DocumentSpecUgcType1$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentSpecUgcType1$outboundSchema: z.ZodNativeEnum; - -/** - * The type of the user generated content (UGC datasource). - */ -declare const DocumentSpecUgcType1: { - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; -}; - -/** - * The type of the user generated content (UGC datasource). - */ -declare type DocumentSpecUgcType1 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpecUgcType2$ { - /** @deprecated use `DocumentSpecUgcType2$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; - }>; - /** @deprecated use `DocumentSpecUgcType2$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; - }>; -} - -/** @internal */ -declare const DocumentSpecUgcType2$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentSpecUgcType2$outboundSchema: z.ZodNativeEnum; - -/** - * The type of the user generated content (UGC datasource). - */ -declare const DocumentSpecUgcType2: { - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Shortcuts: "SHORTCUTS"; - readonly Chats: "CHATS"; -}; - -/** - * The type of the user generated content (UGC datasource). - */ -declare type DocumentSpecUgcType2 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentSpecUnion$ { - /** @deprecated use `DocumentSpecUnion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentSpecUnion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentSpecUnion$Outbound` instead. */ - type Outbound = DocumentSpecUnion$Outbound; -} - -/** @internal */ -declare const DocumentSpecUnion$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentSpecUnion$Outbound = DocumentSpec3$Outbound | DocumentSpec4$Outbound | DocumentSpec1$Outbound | DocumentSpec2$Outbound; - -/** @internal */ -declare const DocumentSpecUnion$outboundSchema: z.ZodType; - -declare type DocumentSpecUnion = DocumentSpec3 | DocumentSpec4 | DocumentSpec1 | DocumentSpec2; - -declare function documentSpecUnionFromJSON(jsonString: string): Result; - -declare function documentSpecUnionToJSON(documentSpecUnion: DocumentSpecUnion): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentStatusResponse$ { - /** @deprecated use `DocumentStatusResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentStatusResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentStatusResponse$Outbound` instead. */ - type Outbound = DocumentStatusResponse$Outbound; -} - -/** @internal */ -declare const DocumentStatusResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentStatusResponse$Outbound = { - uploadStatus?: string | undefined; - lastUploadedAt?: string | undefined; - indexingStatus?: string | undefined; - lastIndexedAt?: string | undefined; - permissionIdentityStatus?: string | undefined; -}; - -/** @internal */ -declare const DocumentStatusResponse$outboundSchema: z.ZodType; - -/** - * Describes the document status response body - */ -declare type DocumentStatusResponse = { - /** - * Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - */ - uploadStatus?: string | undefined; - /** - * Time of last successful upload for the document, in ISO 8601 format - */ - lastUploadedAt?: string | undefined; - /** - * Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - */ - indexingStatus?: string | undefined; - /** - * Time of last successful indexing for the document, in ISO 8601 format - */ - lastIndexedAt?: string | undefined; - /** - * Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`. - */ - permissionIdentityStatus?: string | undefined; -}; - -declare function documentStatusResponseFromJSON(jsonString: string): Result; - -declare function documentStatusResponseToJSON(documentStatusResponse: DocumentStatusResponse): string; - -declare function documentsToJSON(documents: Documents): string; - -declare function documentToJSON(document: Document_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentVisibility$ { - /** @deprecated use `DocumentVisibility$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Private: "PRIVATE"; - readonly SpecificPeopleAndGroups: "SPECIFIC_PEOPLE_AND_GROUPS"; - readonly DomainLink: "DOMAIN_LINK"; - readonly DomainVisible: "DOMAIN_VISIBLE"; - readonly PublicLink: "PUBLIC_LINK"; - readonly PublicVisible: "PUBLIC_VISIBLE"; - }>; - /** @deprecated use `DocumentVisibility$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Private: "PRIVATE"; - readonly SpecificPeopleAndGroups: "SPECIFIC_PEOPLE_AND_GROUPS"; - readonly DomainLink: "DOMAIN_LINK"; - readonly DomainVisible: "DOMAIN_VISIBLE"; - readonly PublicLink: "PUBLIC_LINK"; - readonly PublicVisible: "PUBLIC_VISIBLE"; - }>; -} - -/** @internal */ -declare const DocumentVisibility$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentVisibility$outboundSchema: z.ZodNativeEnum; - -/** - * The level of visibility of the document as understood by our system. - */ -declare const DocumentVisibility: { - readonly Private: "PRIVATE"; - readonly SpecificPeopleAndGroups: "SPECIFIC_PEOPLE_AND_GROUPS"; - readonly DomainLink: "DOMAIN_LINK"; - readonly DomainVisible: "DOMAIN_VISIBLE"; - readonly PublicLink: "PUBLIC_LINK"; - readonly PublicVisible: "PUBLIC_VISIBLE"; -}; - -/** - * The level of visibility of the document as understood by our system. - */ -declare type DocumentVisibility = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentVisibilityOverride$ { - /** @deprecated use `DocumentVisibilityOverride$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentVisibilityOverride$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentVisibilityOverride$Outbound` instead. */ - type Outbound = DocumentVisibilityOverride$Outbound; -} - -/** @internal */ -declare const DocumentVisibilityOverride$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentVisibilityOverride$Outbound = { - docId?: string | undefined; - override?: string | undefined; -}; - -/** @internal */ -declare const DocumentVisibilityOverride$outboundSchema: z.ZodType; - -declare type DocumentVisibilityOverride = { - docId?: string | undefined; - /** - * The visibility-override state of the document. - */ - override?: DocumentVisibilityOverrideOverride | undefined; -}; - -declare function documentVisibilityOverrideFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentVisibilityOverrideOverride$ { - /** @deprecated use `DocumentVisibilityOverrideOverride$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; - }>; - /** @deprecated use `DocumentVisibilityOverrideOverride$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; - }>; -} - -/** @internal */ -declare const DocumentVisibilityOverrideOverride$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentVisibilityOverrideOverride$outboundSchema: z.ZodNativeEnum; - -/** - * The visibility-override state of the document. - */ -declare const DocumentVisibilityOverrideOverride: { - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; -}; - -/** - * The visibility-override state of the document. - */ -declare type DocumentVisibilityOverrideOverride = ClosedEnum; - -declare function documentVisibilityOverrideToJSON(documentVisibilityOverride: DocumentVisibilityOverride): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentVisibilityUpdateResult$ { - /** @deprecated use `DocumentVisibilityUpdateResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentVisibilityUpdateResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentVisibilityUpdateResult$Outbound` instead. */ - type Outbound = DocumentVisibilityUpdateResult$Outbound; -} - -/** @internal */ -declare const DocumentVisibilityUpdateResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentVisibilityUpdateResult$Outbound = { - docId?: string | undefined; - override?: string | undefined; - success?: boolean | undefined; -}; - -/** @internal */ -declare const DocumentVisibilityUpdateResult$outboundSchema: z.ZodType; - -declare type DocumentVisibilityUpdateResult = { - docId?: string | undefined; - /** - * The visibility-override state of the document. - */ - override?: DocumentVisibilityUpdateResultOverride | undefined; - /** - * Whether this document was successfully set to its desired visibility state. - */ - success?: boolean | undefined; -}; - -declare function documentVisibilityUpdateResultFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentVisibilityUpdateResultOverride$ { - /** @deprecated use `DocumentVisibilityUpdateResultOverride$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; - }>; - /** @deprecated use `DocumentVisibilityUpdateResultOverride$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; - }>; -} - -/** @internal */ -declare const DocumentVisibilityUpdateResultOverride$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentVisibilityUpdateResultOverride$outboundSchema: z.ZodNativeEnum; - -/** - * The visibility-override state of the document. - */ -declare const DocumentVisibilityUpdateResultOverride: { - readonly None: "NONE"; - readonly HideFromAll: "HIDE_FROM_ALL"; - readonly HideFromGroups: "HIDE_FROM_GROUPS"; - readonly HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER"; -}; - -/** - * The visibility-override state of the document. - */ -declare type DocumentVisibilityUpdateResultOverride = ClosedEnum; - -declare function documentVisibilityUpdateResultToJSON(documentVisibilityUpdateResult: DocumentVisibilityUpdateResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DownloadpolicycsvRequest$ { - /** @deprecated use `DownloadpolicycsvRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DownloadpolicycsvRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DownloadpolicycsvRequest$Outbound` instead. */ - type Outbound = DownloadpolicycsvRequest$Outbound; -} - -/** @internal */ -declare const DownloadpolicycsvRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DownloadpolicycsvRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare const DownloadpolicycsvRequest$outboundSchema: z.ZodType; - -declare type DownloadpolicycsvRequest = { - /** - * The id of the policy to download violations for. - */ - id: string; -}; - -declare function downloadpolicycsvRequestFromJSON(jsonString: string): Result; - -declare function downloadpolicycsvRequestToJSON(downloadpolicycsvRequest: DownloadpolicycsvRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DownloadreportcsvRequest$ { - /** @deprecated use `DownloadreportcsvRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DownloadreportcsvRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DownloadreportcsvRequest$Outbound` instead. */ - type Outbound = DownloadreportcsvRequest$Outbound; -} - -/** @internal */ -declare const DownloadreportcsvRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DownloadreportcsvRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare const DownloadreportcsvRequest$outboundSchema: z.ZodType; - -declare type DownloadreportcsvRequest = { - /** - * The id of the report to download violations for. - */ - id: string; -}; - -declare function downloadreportcsvRequestFromJSON(jsonString: string): Result; - -declare function downloadreportcsvRequestToJSON(downloadreportcsvRequest: DownloadreportcsvRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditAnswerRequest$ { - /** @deprecated use `EditAnswerRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditAnswerRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditAnswerRequest$Outbound` instead. */ - type Outbound = EditAnswerRequest$Outbound; -} - -/** @internal */ -declare const EditAnswerRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditAnswerRequest$Outbound = { - id: number; - docId?: string | undefined; - question?: string | undefined; - questionVariations?: Array | undefined; - bodyText?: string | undefined; - boardId?: number | undefined; - audienceFilters?: Array | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion$Outbound | undefined; - sourceType?: string | undefined; - addedCollections?: Array | undefined; - removedCollections?: Array | undefined; - combinedAnswerText?: StructuredTextMutableProperties$Outbound | undefined; -}; - -/** @internal */ -declare const EditAnswerRequest$outboundSchema: z.ZodType; - -declare type EditAnswerRequest = { - /** - * The opaque ID of the Answer. - */ - id: number; - /** - * Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - */ - docId?: string | undefined; - question?: string | undefined; - /** - * Additional ways of phrasing this question. - */ - questionVariations?: Array | undefined; - /** - * The plain text answer to the question. - */ - bodyText?: string | undefined; - /** - * The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - boardId?: number | undefined; - /** - * Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * A list of user roles for the answer added by the owner. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles for the answer removed by the owner. - */ - removedRoles?: Array | undefined; - /** - * A list of roles for this answer explicitly granted by an owner, editor, or admin. - */ - roles?: Array | undefined; - sourceDocumentSpec?: DocumentSpecUnion | undefined; - sourceType?: EditAnswerRequestSourceType | undefined; - /** - * IDs of Collections to which a document is added. - */ - addedCollections?: Array | undefined; - /** - * IDs of Collections from which a document is removed. - */ - removedCollections?: Array | undefined; - combinedAnswerText?: StructuredTextMutableProperties | undefined; -}; - -declare function editAnswerRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditAnswerRequestSourceType$ { - /** @deprecated use `EditAnswerRequestSourceType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; - /** @deprecated use `EditAnswerRequestSourceType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; - }>; -} - -/** @internal */ -declare const EditAnswerRequestSourceType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EditAnswerRequestSourceType$outboundSchema: z.ZodNativeEnum; - -declare const EditAnswerRequestSourceType: { - readonly Document: "DOCUMENT"; - readonly Assistant: "ASSISTANT"; -}; - -declare type EditAnswerRequestSourceType = ClosedEnum; - -declare function editAnswerRequestToJSON(editAnswerRequest: EditAnswerRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditCollectionItemRequest$ { - /** @deprecated use `EditCollectionItemRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditCollectionItemRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditCollectionItemRequest$Outbound` instead. */ - type Outbound = EditCollectionItemRequest$Outbound; -} - -/** @internal */ -declare const EditCollectionItemRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditCollectionItemRequest$Outbound = { - name?: string | undefined; - description?: string | undefined; - icon?: string | undefined; - collectionId: number; - itemId: string; -}; - -/** @internal */ -declare const EditCollectionItemRequest$outboundSchema: z.ZodType; - -declare type EditCollectionItemRequest = { - /** - * The optional name of the Collection item. - */ - name?: string | undefined; - /** - * A helpful description of why this CollectionItem is in the Collection that it's in. - */ - description?: string | undefined; - /** - * The emoji icon for this CollectionItem. Only used for Text type items. - */ - icon?: string | undefined; - /** - * The ID of the Collection to edit CollectionItems in. - */ - collectionId: number; - /** - * The ID of the CollectionItem to edit. - */ - itemId: string; -}; - -declare function editCollectionItemRequestFromJSON(jsonString: string): Result; - -declare function editCollectionItemRequestToJSON(editCollectionItemRequest: EditCollectionItemRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditCollectionItemResponse$ { - /** @deprecated use `EditCollectionItemResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditCollectionItemResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditCollectionItemResponse$Outbound` instead. */ - type Outbound = EditCollectionItemResponse$Outbound; -} - -/** @internal */ -declare const EditCollectionItemResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditCollectionItemResponse$Outbound = { - collection?: Collection$Outbound | undefined; -}; - -/** @internal */ -declare const EditCollectionItemResponse$outboundSchema: z.ZodType; - -declare type EditCollectionItemResponse = { - collection?: Collection | undefined; -}; - -declare function editCollectionItemResponseFromJSON(jsonString: string): Result; - -declare function editCollectionItemResponseToJSON(editCollectionItemResponse: EditCollectionItemResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditCollectionRequest$ { - /** @deprecated use `EditCollectionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditCollectionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditCollectionRequest$Outbound` instead. */ - type Outbound = EditCollectionRequest$Outbound; -} - -/** @internal */ -declare const EditCollectionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditCollectionRequest$Outbound = { - name: string; - description?: string | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - audienceFilters?: Array | undefined; - icon?: string | undefined; - adminLocked?: boolean | undefined; - parentId?: number | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - allowedDatasource?: string | undefined; - id: number; -}; - -/** @internal */ -declare const EditCollectionRequest$outboundSchema: z.ZodType; - -declare type EditCollectionRequest = { - /** - * The unique name of the Collection. - */ - name: string; - /** - * A brief summary of the Collection's contents. - */ - description?: string | undefined; - /** - * A list of added user roles for the Collection. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Collection. - */ - removedRoles?: Array | undefined; - /** - * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The emoji icon of this Collection. - */ - icon?: string | undefined; - /** - * Indicates whether edits are allowed for everyone or only admins. - */ - adminLocked?: boolean | undefined; - /** - * The parent of this Collection, or 0 if it's a top-level Collection. - */ - parentId?: number | undefined; - thumbnail?: Thumbnail | undefined; - /** - * The datasource type this Collection can hold. - */ - allowedDatasource?: string | undefined; - /** - * The ID of the Collection to modify. - */ - id: number; -}; - -declare function editCollectionRequestFromJSON(jsonString: string): Result; - -declare function editCollectionRequestToJSON(editCollectionRequest: EditCollectionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditCollectionResponse$ { - /** @deprecated use `EditCollectionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditCollectionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditCollectionResponse$Outbound` instead. */ - type Outbound = EditCollectionResponse$Outbound; -} - -/** @internal */ -declare const EditCollectionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditCollectionResponse$Outbound = { - name: string; - description: string; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - audienceFilters?: Array | undefined; - icon?: string | undefined; - adminLocked?: boolean | undefined; - parentId?: number | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - allowedDatasource?: string | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id: number; - createTime?: string | undefined; - updateTime?: string | undefined; - creator?: Person$Outbound | undefined; - updatedBy?: Person$Outbound | undefined; - itemCount?: number | undefined; - childCount?: number | undefined; - items?: Array | undefined; - pinMetadata?: CollectionPinnedMetadata$Outbound | undefined; - shortcuts?: Array | undefined; - children?: Array | undefined; - roles?: Array | undefined; - errorCode: string; - collection?: Collection$Outbound | undefined; - error?: CollectionError$Outbound | undefined; -}; - -/** @internal */ -declare const EditCollectionResponse$outboundSchema: z.ZodType; - -declare type EditCollectionResponse = { - /** - * The unique name of the Collection. - */ - name: string; - /** - * A brief summary of the Collection's contents. - */ - description: string; - /** - * A list of added user roles for the Collection. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Collection. - */ - removedRoles?: Array | undefined; - /** - * Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The emoji icon of this Collection. - */ - icon?: string | undefined; - /** - * Indicates whether edits are allowed for everyone or only admins. - */ - adminLocked?: boolean | undefined; - /** - * The parent of this Collection, or 0 if it's a top-level Collection. - */ - parentId?: number | undefined; - thumbnail?: Thumbnail | undefined; - /** - * The datasource type this Collection can hold. - */ - allowedDatasource?: string | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The unique ID of the Collection. - */ - id: number; - createTime?: Date | undefined; - updateTime?: Date | undefined; - creator?: Person | undefined; - updatedBy?: Person | undefined; - /** - * The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - */ - itemCount?: number | undefined; - /** - * The number of children Collections. Separated from the actual children so we can grab the count without children. - */ - childCount?: number | undefined; - /** - * The items in this Collection. - */ - items?: Array | undefined; - pinMetadata?: CollectionPinnedMetadata | undefined; - /** - * The names of the shortcuts (Go Links) that point to this Collection. - */ - shortcuts?: Array | undefined; - /** - * The children Collections of this Collection. - */ - children?: Array | undefined; - /** - * A list of user roles for the Collection. - */ - roles?: Array | undefined; - errorCode: EditCollectionResponseErrorCode; - collection?: Collection | undefined; - error?: CollectionError | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditCollectionResponseErrorCode$ { - /** @deprecated use `EditCollectionResponseErrorCode$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; - }>; - /** @deprecated use `EditCollectionResponseErrorCode$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; - }>; -} - -/** @internal */ -declare const EditCollectionResponseErrorCode$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EditCollectionResponseErrorCode$outboundSchema: z.ZodNativeEnum; - -declare const EditCollectionResponseErrorCode: { - readonly NameExists: "NAME_EXISTS"; - readonly NotFound: "NOT_FOUND"; - readonly CollectionPinned: "COLLECTION_PINNED"; - readonly ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT"; - readonly HeightViolation: "HEIGHT_VIOLATION"; - readonly WidthViolation: "WIDTH_VIOLATION"; - readonly NoPermissions: "NO_PERMISSIONS"; -}; - -declare type EditCollectionResponseErrorCode = ClosedEnum; - -declare function editCollectionResponseFromJSON(jsonString: string): Result; - -declare function editCollectionResponseToJSON(editCollectionResponse: EditCollectionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EditPinRequest$ { - /** @deprecated use `EditPinRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EditPinRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EditPinRequest$Outbound` instead. */ - type Outbound = EditPinRequest$Outbound; -} - -/** @internal */ -declare const EditPinRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EditPinRequest$Outbound = { - queries?: Array | undefined; - audienceFilters?: Array | undefined; - id?: string | undefined; -}; - -/** @internal */ -declare const EditPinRequest$outboundSchema: z.ZodType; - -declare type EditPinRequest = { - /** - * The query strings for which the pinned result will show. - */ - queries?: Array | undefined; - /** - * Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The opaque id of the pin to be edited. - */ - id?: string | undefined; -}; - -declare function editPinRequestFromJSON(jsonString: string): Result; - -declare function editPinRequestToJSON(editPinRequest: EditPinRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmployeeInfoDefinition$ { - /** @deprecated use `EmployeeInfoDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmployeeInfoDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmployeeInfoDefinition$Outbound` instead. */ - type Outbound = EmployeeInfoDefinition$Outbound; -} - -/** @internal */ -declare const EmployeeInfoDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmployeeInfoDefinition$Outbound = { - email: string; - firstName?: string | undefined; - lastName?: string | undefined; - preferredName?: string | undefined; - id?: string | undefined; - phoneNumber?: string | undefined; - location?: string | undefined; - structuredLocation?: StructuredLocation$Outbound | undefined; - title?: string | undefined; - photoUrl?: string | undefined; - businessUnit?: string | undefined; - department: string; - datasourceProfiles?: Array | undefined; - teams?: Array | undefined; - startDate?: string | undefined; - endDate?: string | undefined; - bio?: string | undefined; - pronoun?: string | undefined; - alsoKnownAs?: Array | undefined; - profileUrl?: string | undefined; - socialNetworks?: Array | undefined; - managerEmail?: string | undefined; - managerId?: string | undefined; - type: string; - relationships?: Array | undefined; - status: string; - additionalFields?: Array | undefined; -}; - -/** @internal */ -declare const EmployeeInfoDefinition$outboundSchema: z.ZodType; - -/** - * Describes employee info - */ -declare type EmployeeInfoDefinition = { - /** - * The employee's email - */ - email: string; - /** - * The first name of the employee. **Note**: The value cannot be empty - * - * @remarks - */ - firstName?: string | undefined; - /** - * The last name of the employee. **Note**: The value cannot be empty - * - * @remarks - */ - lastName?: string | undefined; - /** - * The preferred name or nickname of the employee - */ - preferredName?: string | undefined; - /** - * **[Advanced]** A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`. - * - * @remarks - */ - id?: string | undefined; - /** - * The employee's phone number. - */ - phoneNumber?: string | undefined; - /** - * The employee's location (city/office name etc). - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - location?: string | undefined; - /** - * Detailed location with information about country, state, city etc. - */ - structuredLocation?: StructuredLocation | undefined; - /** - * The employee's role title. - */ - title?: string | undefined; - /** - * The employee's profile pic - */ - photoUrl?: string | undefined; - /** - * Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - */ - businessUnit?: string | undefined; - /** - * An organizational unit where everyone has a similar task, e.g. `Engineering`. - */ - department: string; - /** - * The datasource profiles of the employee, e.g. `Slack`,`Github`. - */ - datasourceProfiles?: Array | undefined; - /** - * Info about the employee's team(s) - */ - teams?: Array | undefined; - /** - * The date when the employee started - */ - startDate?: RFCDate | undefined; - /** - * If a former employee, the last date of employment. - */ - endDate?: RFCDate | undefined; - /** - * Short biography or mission statement of the employee. - */ - bio?: string | undefined; - /** - * She/her, He/his or other pronoun. - */ - pronoun?: string | undefined; - /** - * Other names associated with the employee. - */ - alsoKnownAs?: Array | undefined; - /** - * Link to internal company person profile. - */ - profileUrl?: string | undefined; - /** - * List of social network profiles. - */ - socialNetworks?: Array | undefined; - /** - * The email of the employee's manager - */ - managerEmail?: string | undefined; - /** - * **[Advanced]** A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`. - * - * @remarks - */ - managerId?: string | undefined; - /** - * The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE` - */ - type?: string | undefined; - /** - * List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile. - */ - relationships?: Array | undefined; - /** - * The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` - */ - status?: string | undefined; - /** - * List of additional fields with more information about the employee. - */ - additionalFields?: Array | undefined; -}; - -declare function employeeInfoDefinitionFromJSON(jsonString: string): Result; - -declare function employeeInfoDefinitionToJSON(employeeInfoDefinition: EmployeeInfoDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmployeeTeamInfo$ { - /** @deprecated use `EmployeeTeamInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmployeeTeamInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmployeeTeamInfo$Outbound` instead. */ - type Outbound = EmployeeTeamInfo$Outbound; -} - -/** @internal */ -declare const EmployeeTeamInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmployeeTeamInfo$Outbound = { - id?: string | undefined; - name?: string | undefined; - url?: string | undefined; -}; - -/** @internal */ -declare const EmployeeTeamInfo$outboundSchema: z.ZodType; - -/** - * Information about which team an employee belongs to - */ -declare type EmployeeTeamInfo = { - /** - * unique identifier for this team - */ - id?: string | undefined; - /** - * Team name - */ - name?: string | undefined; - /** - * Link to internal company team page - */ - url?: string | undefined; -}; - -declare function employeeTeamInfoFromJSON(jsonString: string): Result; - -declare function employeeTeamInfoToJSON(employeeTeamInfo: EmployeeTeamInfo): string; - -declare class Entities extends ClientSDK { - /** - * List entities - * - * @remarks - * List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities. - */ - list(request: components.ListEntitiesRequest, options?: RequestOptions): Promise; - /** - * Read people - * - * @remarks - * Read people details for the given IDs. - */ - readPeople(request: components.PeopleRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntitiesSortOrder$ { - /** @deprecated use `EntitiesSortOrder$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly EntityName: "ENTITY_NAME"; - readonly FirstName: "FIRST_NAME"; - readonly LastName: "LAST_NAME"; - readonly OrgSizeCount: "ORG_SIZE_COUNT"; - readonly StartDate: "START_DATE"; - readonly TeamSize: "TEAM_SIZE"; - readonly Relevance: "RELEVANCE"; - }>; - /** @deprecated use `EntitiesSortOrder$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly EntityName: "ENTITY_NAME"; - readonly FirstName: "FIRST_NAME"; - readonly LastName: "LAST_NAME"; - readonly OrgSizeCount: "ORG_SIZE_COUNT"; - readonly StartDate: "START_DATE"; - readonly TeamSize: "TEAM_SIZE"; - readonly Relevance: "RELEVANCE"; - }>; -} - -/** @internal */ -declare const EntitiesSortOrder$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EntitiesSortOrder$outboundSchema: z.ZodNativeEnum; - -/** - * Different ways of sorting entities - */ -declare const EntitiesSortOrder: { - readonly EntityName: "ENTITY_NAME"; - readonly FirstName: "FIRST_NAME"; - readonly LastName: "LAST_NAME"; - readonly OrgSizeCount: "ORG_SIZE_COUNT"; - readonly StartDate: "START_DATE"; - readonly TeamSize: "TEAM_SIZE"; - readonly Relevance: "RELEVANCE"; -}; - -/** - * Different ways of sorting entities - */ -declare type EntitiesSortOrder = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntityRelationship$ { - /** @deprecated use `EntityRelationship$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EntityRelationship$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EntityRelationship$Outbound` instead. */ - type Outbound = EntityRelationship$Outbound; -} - -/** @internal */ -declare const EntityRelationship$inboundSchema: z.ZodType; - -/** @internal */ -declare type EntityRelationship$Outbound = { - name: string; - email: string; -}; - -/** @internal */ -declare const EntityRelationship$outboundSchema: z.ZodType; - -/** - * Describes a relationship edge between a source and destination entity - */ -declare type EntityRelationship = { - /** - * The title or type of relationship. Currently an enum of `CHIEF_OF_STAFF`, `EXECUTIVE_ASSISTANT` - */ - name: string; - /** - * Email of the person with whom the relationship exists. Per the example above, either `B` or `C`'s email depending on the relationship. - */ - email: string; -}; - -declare function entityRelationshipFromJSON(jsonString: string): Result; - -declare function entityRelationshipToJSON(entityRelationship: EntityRelationship): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntityType$ { - /** @deprecated use `EntityType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Person: "PERSON"; - readonly Project: "PROJECT"; - readonly Customer: "CUSTOMER"; - }>; - /** @deprecated use `EntityType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Person: "PERSON"; - readonly Project: "PROJECT"; - readonly Customer: "CUSTOMER"; - }>; -} - -/** @internal */ -declare const EntityType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EntityType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of entity. - */ -declare const EntityType: { - readonly Person: "PERSON"; - readonly Project: "PROJECT"; - readonly Customer: "CUSTOMER"; -}; - -/** - * The type of entity. - */ -declare type EntityType = ClosedEnum; - -declare function errorFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ErrorMessage$ { - /** @deprecated use `ErrorMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ErrorMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ErrorMessage$Outbound` instead. */ - type Outbound = ErrorMessage$Outbound; -} - -/** @internal */ -declare const ErrorMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type ErrorMessage$Outbound = { - source?: string | undefined; - errorMessage?: string | undefined; -}; - -/** @internal */ -declare const ErrorMessage$outboundSchema: z.ZodType; - -declare type ErrorMessage = { - /** - * The datasource this message relates to. - */ - source?: string | undefined; - errorMessage?: string | undefined; -}; - -declare function errorMessageFromJSON(jsonString: string): Result; - -declare function errorMessageToJSON(errorMessage: ErrorMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ErrorT$ { - /** @deprecated use `ErrorT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ErrorT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ErrorT$Outbound` instead. */ - type Outbound = ErrorT$Outbound; -} - -/** @internal */ -declare const ErrorT$inboundSchema: z.ZodType; - -/** @internal */ -declare type ErrorT$Outbound = { - message?: string | undefined; -}; - -/** @internal */ -declare const ErrorT$outboundSchema: z.ZodType; - -declare type ErrorT = { - message?: string | undefined; -}; - -declare function errorToJSON(errorT: ErrorT): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Event$ { - /** @deprecated use `Event$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Click: "CLICK"; - readonly ContainerClick: "CONTAINER_CLICK"; - readonly CopyLink: "COPY_LINK"; - readonly Create: "CREATE"; - readonly Dismiss: "DISMISS"; - readonly Downvote: "DOWNVOTE"; - readonly Email: "EMAIL"; - readonly Execute: "EXECUTE"; - readonly Filter: "FILTER"; - readonly FirstToken: "FIRST_TOKEN"; - readonly FocusIn: "FOCUS_IN"; - readonly LastToken: "LAST_TOKEN"; - readonly ManualFeedback: "MANUAL_FEEDBACK"; - readonly ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE"; - readonly MarkAsRead: "MARK_AS_READ"; - readonly Message: "MESSAGE"; - readonly MiddleClick: "MIDDLE_CLICK"; - readonly PageBlur: "PAGE_BLUR"; - readonly PageFocus: "PAGE_FOCUS"; - readonly PageLeave: "PAGE_LEAVE"; - readonly Preview: "PREVIEW"; - readonly RelatedClick: "RELATED_CLICK"; - readonly RightClick: "RIGHT_CLICK"; - readonly SectionClick: "SECTION_CLICK"; - readonly Seen: "SEEN"; - readonly Share: "SHARE"; - readonly ShowMore: "SHOW_MORE"; - readonly Upvote: "UPVOTE"; - readonly View: "VIEW"; - readonly Visible: "VISIBLE"; - }>; - /** @deprecated use `Event$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Click: "CLICK"; - readonly ContainerClick: "CONTAINER_CLICK"; - readonly CopyLink: "COPY_LINK"; - readonly Create: "CREATE"; - readonly Dismiss: "DISMISS"; - readonly Downvote: "DOWNVOTE"; - readonly Email: "EMAIL"; - readonly Execute: "EXECUTE"; - readonly Filter: "FILTER"; - readonly FirstToken: "FIRST_TOKEN"; - readonly FocusIn: "FOCUS_IN"; - readonly LastToken: "LAST_TOKEN"; - readonly ManualFeedback: "MANUAL_FEEDBACK"; - readonly ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE"; - readonly MarkAsRead: "MARK_AS_READ"; - readonly Message: "MESSAGE"; - readonly MiddleClick: "MIDDLE_CLICK"; - readonly PageBlur: "PAGE_BLUR"; - readonly PageFocus: "PAGE_FOCUS"; - readonly PageLeave: "PAGE_LEAVE"; - readonly Preview: "PREVIEW"; - readonly RelatedClick: "RELATED_CLICK"; - readonly RightClick: "RIGHT_CLICK"; - readonly SectionClick: "SECTION_CLICK"; - readonly Seen: "SEEN"; - readonly Share: "SHARE"; - readonly ShowMore: "SHOW_MORE"; - readonly Upvote: "UPVOTE"; - readonly View: "VIEW"; - readonly Visible: "VISIBLE"; - }>; -} - -/** @internal */ -declare const Event$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Event$outboundSchema: z.ZodNativeEnum; - -/** - * The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. - */ -declare const Event_2: { - readonly Click: "CLICK"; - readonly ContainerClick: "CONTAINER_CLICK"; - readonly CopyLink: "COPY_LINK"; - readonly Create: "CREATE"; - readonly Dismiss: "DISMISS"; - readonly Downvote: "DOWNVOTE"; - readonly Email: "EMAIL"; - readonly Execute: "EXECUTE"; - readonly Filter: "FILTER"; - readonly FirstToken: "FIRST_TOKEN"; - readonly FocusIn: "FOCUS_IN"; - readonly LastToken: "LAST_TOKEN"; - readonly ManualFeedback: "MANUAL_FEEDBACK"; - readonly ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE"; - readonly MarkAsRead: "MARK_AS_READ"; - readonly Message: "MESSAGE"; - readonly MiddleClick: "MIDDLE_CLICK"; - readonly PageBlur: "PAGE_BLUR"; - readonly PageFocus: "PAGE_FOCUS"; - readonly PageLeave: "PAGE_LEAVE"; - readonly Preview: "PREVIEW"; - readonly RelatedClick: "RELATED_CLICK"; - readonly RightClick: "RIGHT_CLICK"; - readonly SectionClick: "SECTION_CLICK"; - readonly Seen: "SEEN"; - readonly Share: "SHARE"; - readonly ShowMore: "SHOW_MORE"; - readonly Upvote: "UPVOTE"; - readonly View: "VIEW"; - readonly Visible: "VISIBLE"; -}; - -/** - * The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. - */ -declare type Event_2 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventClassification$ { - /** @deprecated use `EventClassification$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EventClassification$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EventClassification$Outbound` instead. */ - type Outbound = EventClassification$Outbound; -} - -/** @internal */ -declare const EventClassification$inboundSchema: z.ZodType; - -/** @internal */ -declare type EventClassification$Outbound = { - name?: string | undefined; - strategies?: Array | undefined; -}; - -/** @internal */ -declare const EventClassification$outboundSchema: z.ZodType; - -/** - * A generated classification of a given event. - */ -declare type EventClassification = { - /** - * The name for a generated classification of an event. - */ - name?: EventClassificationName | undefined; - strategies?: Array | undefined; -}; - -declare function eventClassificationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventClassificationName$ { - /** @deprecated use `EventClassificationName$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ExternalEvent: "External Event"; - }>; - /** @deprecated use `EventClassificationName$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ExternalEvent: "External Event"; - }>; -} - -/** @internal */ -declare const EventClassificationName$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EventClassificationName$outboundSchema: z.ZodNativeEnum; - -/** - * The name for a generated classification of an event. - */ -declare const EventClassificationName: { - readonly ExternalEvent: "External Event"; -}; - -/** - * The name for a generated classification of an event. - */ -declare type EventClassificationName = ClosedEnum; - -declare function eventClassificationToJSON(eventClassification: EventClassification): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventStrategyName$ { - /** @deprecated use `EventStrategyName$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CustomerCard: "customerCard"; - readonly News: "news"; - readonly Call: "call"; - readonly Email: "email"; - readonly MeetingNotes: "meetingNotes"; - readonly LinkedIn: "linkedIn"; - readonly RelevantDocuments: "relevantDocuments"; - readonly ChatFollowUps: "chatFollowUps"; - readonly Conversations: "conversations"; - }>; - /** @deprecated use `EventStrategyName$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CustomerCard: "customerCard"; - readonly News: "news"; - readonly Call: "call"; - readonly Email: "email"; - readonly MeetingNotes: "meetingNotes"; - readonly LinkedIn: "linkedIn"; - readonly RelevantDocuments: "relevantDocuments"; - readonly ChatFollowUps: "chatFollowUps"; - readonly Conversations: "conversations"; - }>; -} - -/** @internal */ -declare const EventStrategyName$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EventStrategyName$outboundSchema: z.ZodNativeEnum; - -/** - * The name of method used to surface relevant data for a given calendar event. - */ -declare const EventStrategyName: { - readonly CustomerCard: "customerCard"; - readonly News: "news"; - readonly Call: "call"; - readonly Email: "email"; - readonly MeetingNotes: "meetingNotes"; - readonly LinkedIn: "linkedIn"; - readonly RelevantDocuments: "relevantDocuments"; - readonly ChatFollowUps: "chatFollowUps"; - readonly Conversations: "conversations"; -}; - -/** - * The name of method used to surface relevant data for a given calendar event. - */ -declare type EventStrategyName = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ExternalSharingOptions$ { - /** @deprecated use `ExternalSharingOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ExternalSharingOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ExternalSharingOptions$Outbound` instead. */ - type Outbound = ExternalSharingOptions$Outbound; -} - -/** @internal */ -declare const ExternalSharingOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type ExternalSharingOptions$Outbound = { - enabled?: boolean | undefined; - threshold?: number | undefined; - thresholdEnabled?: boolean | undefined; - anyoneWithLinkEnabled?: boolean | undefined; - anyoneInternalEnabled?: boolean | undefined; - anonymousAccessEnabled?: boolean | undefined; - userAccessEnabled?: boolean | undefined; - userIds?: Array | undefined; - domainAccessEnabled?: boolean | undefined; -}; - -/** @internal */ -declare const ExternalSharingOptions$outboundSchema: z.ZodType; - -/** - * Controls how "shared" a document must be to get picked for scans. - * - * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. - */ -declare type ExternalSharingOptions = { - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - enabled?: boolean | undefined; - /** - * The minimum number of users the document is shared with. - */ - threshold?: number | undefined; - /** - * Documents will be filtered based on how many people have access to it. - */ - thresholdEnabled?: boolean | undefined; - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - anyoneWithLinkEnabled?: boolean | undefined; - /** - * Only users within the organization can access the document. - */ - anyoneInternalEnabled?: boolean | undefined; - /** - * Anyone on the internet can access the document. - */ - anonymousAccessEnabled?: boolean | undefined; - /** - * Enable user access check - */ - userAccessEnabled?: boolean | undefined; - /** - * Any one of the specified users can access the document. - */ - userIds?: Array | undefined; - domainAccessEnabled?: boolean | undefined; -}; - -declare function externalSharingOptionsFromJSON(jsonString: string): Result; - -declare function externalSharingOptionsToJSON(externalSharingOptions: ExternalSharingOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ExternalShortcut$ { - /** @deprecated use `ExternalShortcut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ExternalShortcut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ExternalShortcut$Outbound` instead. */ - type Outbound = ExternalShortcut$Outbound; -} - -/** @internal */ -declare const ExternalShortcut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ExternalShortcut$Outbound = { - inputAlias: string; - description?: string | undefined; - destinationUrl: string; - createdBy: string; - createTime?: number | undefined; - updatedBy?: string | undefined; - updateTime?: number | undefined; - title?: string | undefined; - intermediateUrl: string; - decayedVisitScore?: number | undefined; - editUrl?: string | undefined; -}; - -/** @internal */ -declare const ExternalShortcut$outboundSchema: z.ZodType; - -declare type ExternalShortcut = { - /** - * link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias. - */ - inputAlias: string; - /** - * A short, plain text blurb to help people understand the intent of the shortcut. - */ - description?: string | undefined; - /** - * destination URL for the shortcut. - */ - destinationUrl: string; - /** - * Email of the user who created this shortcut. - */ - createdBy: string; - /** - * The time the shortcut was created in epoch seconds. - */ - createTime?: number | undefined; - /** - * Email of the user who last updated this shortcut. - */ - updatedBy?: string | undefined; - /** - * The time the shortcut was updated in epoch seconds. - */ - updateTime?: number | undefined; - /** - * Title of the golink - */ - title?: string | undefined; - /** - * The URL from which the user is then redirected to the destination URL. - */ - intermediateUrl: string; - /** - * decayed visits score for ranking - */ - decayedVisitScore?: number | undefined; - /** - * The URL using which the user can access the edit page of the shortcut. - */ - editUrl?: string | undefined; -}; - -declare function externalShortcutFromJSON(jsonString: string): Result; - -declare function externalShortcutToJSON(externalShortcut: ExternalShortcut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ExtractedQnA$ { - /** @deprecated use `ExtractedQnA$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ExtractedQnA$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ExtractedQnA$Outbound` instead. */ - type Outbound = ExtractedQnA$Outbound; -} - -/** @internal */ -declare const ExtractedQnA$inboundSchema: z.ZodType; - -/** @internal */ -declare type ExtractedQnA$Outbound = { - heading?: string | undefined; - question?: string | undefined; - questionResult?: SearchResult$Outbound | undefined; -}; - -/** @internal */ -declare const ExtractedQnA$outboundSchema: z.ZodType; - -declare type ExtractedQnA = { - /** - * Heading text that was matched to produce this result. - */ - heading?: string | undefined; - /** - * Question text that was matched to produce this result. - */ - question?: string | undefined; - questionResult?: SearchResult | undefined; -}; - -declare function extractedQnAFromJSON(jsonString: string): Result; - -declare function extractedQnAToJSON(extractedQnA: ExtractedQnA): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetBucket$ { - /** @deprecated use `FacetBucket$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetBucket$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetBucket$Outbound` instead. */ - type Outbound = FacetBucket$Outbound; -} - -/** @internal */ -declare const FacetBucket$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetBucket$Outbound = { - count?: number | undefined; - datasource?: string | undefined; - percentage?: number | undefined; - value?: FacetValue$Outbound | undefined; -}; - -/** @internal */ -declare const FacetBucket$outboundSchema: z.ZodType; - -declare type FacetBucket = { - /** - * Estimated number of results in this facet. - */ - count?: number | undefined; - /** - * The datasource the value belongs to. This will be used by the all tab to show types across all datasources. - */ - datasource?: string | undefined; - /** - * Estimated percentage of results in this facet. - */ - percentage?: number | undefined; - value?: FacetValue | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetBucketFilter$ { - /** @deprecated use `FacetBucketFilter$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetBucketFilter$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetBucketFilter$Outbound` instead. */ - type Outbound = FacetBucketFilter$Outbound; -} - -/** @internal */ -declare const FacetBucketFilter$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetBucketFilter$Outbound = { - facet?: string | undefined; - prefix?: string | undefined; -}; - -/** @internal */ -declare const FacetBucketFilter$outboundSchema: z.ZodType; - -declare type FacetBucketFilter = { - /** - * The facet whose buckets should be filtered. - */ - facet?: string | undefined; - /** - * The per-term prefix that facet buckets should be filtered on. - */ - prefix?: string | undefined; -}; - -declare function facetBucketFilterFromJSON(jsonString: string): Result; - -declare function facetBucketFilterToJSON(facetBucketFilter: FacetBucketFilter): string; - -declare function facetBucketFromJSON(jsonString: string): Result; - -declare function facetBucketToJSON(facetBucket: FacetBucket): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetFilter$ { - /** @deprecated use `FacetFilter$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetFilter$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetFilter$Outbound` instead. */ - type Outbound = FacetFilter$Outbound; -} - -/** @internal */ -declare const FacetFilter$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetFilter$Outbound = { - fieldName?: string | undefined; - values?: Array | undefined; - groupName?: string | undefined; -}; - -/** @internal */ -declare const FacetFilter$outboundSchema: z.ZodType; - -declare type FacetFilter = { - fieldName?: string | undefined; - /** - * Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - */ - values?: Array | undefined; - /** - * Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - */ - groupName?: string | undefined; -}; - -declare function facetFilterFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetFilterSet$ { - /** @deprecated use `FacetFilterSet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetFilterSet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetFilterSet$Outbound` instead. */ - type Outbound = FacetFilterSet$Outbound; -} - -/** @internal */ -declare const FacetFilterSet$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetFilterSet$Outbound = { - filters?: Array | undefined; -}; - -/** @internal */ -declare const FacetFilterSet$outboundSchema: z.ZodType; - -/** - * Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - */ -declare type FacetFilterSet = { - filters?: Array | undefined; -}; - -declare function facetFilterSetFromJSON(jsonString: string): Result; - -declare function facetFilterSetToJSON(facetFilterSet: FacetFilterSet): string; - -declare function facetFilterToJSON(facetFilter: FacetFilter): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetFilterValue$ { - /** @deprecated use `FacetFilterValue$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetFilterValue$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetFilterValue$Outbound` instead. */ - type Outbound = FacetFilterValue$Outbound; -} - -/** @internal */ -declare const FacetFilterValue$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetFilterValue$Outbound = { - value?: string | undefined; - relationType?: string | undefined; - isNegated?: boolean | undefined; -}; - -/** @internal */ -declare const FacetFilterValue$outboundSchema: z.ZodType; - -declare type FacetFilterValue = { - value?: string | undefined; - relationType?: RelationType | undefined; - /** - * DEPRECATED - please use relationType instead - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - isNegated?: boolean | undefined; -}; - -declare function facetFilterValueFromJSON(jsonString: string): Result; - -declare function facetFilterValueToJSON(facetFilterValue: FacetFilterValue): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetResult$ { - /** @deprecated use `FacetResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetResult$Outbound` instead. */ - type Outbound = FacetResult$Outbound; -} - -/** @internal */ -declare const FacetResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetResult$Outbound = { - sourceName?: string | undefined; - operatorName?: string | undefined; - buckets?: Array | undefined; - hasMoreBuckets?: boolean | undefined; - groupName?: string | undefined; -}; - -/** @internal */ -declare const FacetResult$outboundSchema: z.ZodType; - -declare type FacetResult = { - /** - * The source of this facet (e.g. container_name, type, last_updated_at). - */ - sourceName?: string | undefined; - /** - * How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - */ - operatorName?: string | undefined; - /** - * A list of unique buckets that exist within this result set. - */ - buckets?: Array | undefined; - /** - * Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - */ - hasMoreBuckets?: boolean | undefined; - /** - * For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - */ - groupName?: string | undefined; -}; - -declare function facetResultFromJSON(jsonString: string): Result; - -declare function facetResultToJSON(facetResult: FacetResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FacetValue$ { - /** @deprecated use `FacetValue$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FacetValue$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FacetValue$Outbound` instead. */ - type Outbound = FacetValue$Outbound; -} - -/** @internal */ -declare const FacetValue$inboundSchema: z.ZodType; - -/** @internal */ -declare type FacetValue$Outbound = { - stringValue?: string | undefined; - integerValue?: number | undefined; - displayLabel?: string | undefined; - iconConfig?: IconConfig$Outbound | undefined; -}; - -/** @internal */ -declare const FacetValue$outboundSchema: z.ZodType; - -declare type FacetValue = { - /** - * The value that should be set in the FacetFilter when applying this filter to a search request. - */ - stringValue?: string | undefined; - integerValue?: number | undefined; - /** - * An optional user-friendly label to display in place of the facet value. - */ - displayLabel?: string | undefined; - /** - * Defines how to render an icon - */ - iconConfig?: IconConfig | undefined; -}; - -declare function facetValueFromJSON(jsonString: string): Result; - -declare function facetValueToJSON(facetValue: FacetValue): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FavoriteInfo$ { - /** @deprecated use `FavoriteInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FavoriteInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FavoriteInfo$Outbound` instead. */ - type Outbound = FavoriteInfo$Outbound; -} - -/** @internal */ -declare const FavoriteInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type FavoriteInfo$Outbound = { - ugcType?: string | undefined; - id?: string | undefined; - count?: number | undefined; - favoritedByUser?: boolean | undefined; -}; - -/** @internal */ -declare const FavoriteInfo$outboundSchema: z.ZodType; - -declare type FavoriteInfo = { - ugcType?: UgcType | undefined; - /** - * Opaque id of the UGC. - */ - id?: string | undefined; - /** - * Number of users this object has been favorited by. - */ - count?: number | undefined; - /** - * If the requesting user has favorited this object. - */ - favoritedByUser?: boolean | undefined; -}; - -declare function favoriteInfoFromJSON(jsonString: string): Result; - -declare function favoriteInfoToJSON(favoriteInfo: FavoriteInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Feedback$ { - /** @deprecated use `Feedback$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Feedback$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Feedback$Outbound` instead. */ - type Outbound = Feedback$Outbound; -} - -/** @internal */ -declare const Feedback$inboundSchema: z.ZodType; - -/** @internal */ -declare type Feedback$Outbound = { - id?: string | undefined; - category?: string | undefined; - trackingTokens: Array; - event: string; - position?: number | undefined; - payload?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - timestamp?: string | undefined; - user?: User$Outbound | undefined; - pathname?: string | undefined; - channels?: Array | undefined; - url?: string | undefined; - uiTree?: Array | undefined; - uiElement?: string | undefined; - manualFeedbackInfo?: ManualFeedbackInfo$Outbound | undefined; - manualFeedbackSideBySideInfo?: ManualFeedbackSideBySideInfo$Outbound | undefined; - seenFeedbackInfo?: SeenFeedbackInfo$Outbound | undefined; - userViewInfo?: UserViewInfo$Outbound | undefined; - workflowFeedbackInfo?: WorkflowFeedbackInfo$Outbound | undefined; - applicationId?: string | undefined; - agentId?: string | undefined; -}; - -/** @internal */ -declare const Feedback$outboundSchema: z.ZodType; - -declare type Feedback = { - /** - * Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - */ - id?: string | undefined; - /** - * The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. - */ - category?: FeedbackCategory | undefined; - /** - * A list of server-generated trackingTokens to which this event applies. - */ - trackingTokens: Array; - /** - * The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. - */ - event: Event_2; - /** - * Position of the element in the case that the client controls order (such as feed and autocomplete). - */ - position?: number | undefined; - /** - * For type MANUAL_FEEDBACK, contains string of user feedback. For autocomplete, partial query string. For feed, string of user feedback in addition to manual feedback signals extracted from all suggested content. - */ - payload?: string | undefined; - sessionInfo?: SessionInfo | undefined; - /** - * The ISO 8601 timestamp when the event occured. - */ - timestamp?: Date | undefined; - user?: User | undefined; - /** - * The path the client was at when the feedback event triggered. - */ - pathname?: string | undefined; - /** - * Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean. - */ - channels?: Array | undefined; - /** - * The URL the client was at when the feedback event triggered. - */ - url?: string | undefined; - /** - * The UI element tree associated with the event, if any. - */ - uiTree?: Array | undefined; - /** - * The UI element associated with the event, if any. - */ - uiElement?: string | undefined; - manualFeedbackInfo?: ManualFeedbackInfo | undefined; - manualFeedbackSideBySideInfo?: ManualFeedbackSideBySideInfo | undefined; - seenFeedbackInfo?: SeenFeedbackInfo | undefined; - userViewInfo?: UserViewInfo | undefined; - workflowFeedbackInfo?: WorkflowFeedbackInfo | undefined; - /** - * The application ID of the client that sent the feedback event. - */ - applicationId?: string | undefined; - /** - * The agent ID of the client that sent the feedback event. - */ - agentId?: string | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedbackCategory$ { - /** @deprecated use `FeedbackCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Announcement: "ANNOUNCEMENT"; - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Collections: "COLLECTIONS"; - readonly Feed: "FEED"; - readonly Search: "SEARCH"; - readonly Chat: "CHAT"; - readonly Ntp: "NTP"; - readonly Workflows: "WORKFLOWS"; - readonly Summary: "SUMMARY"; - readonly General: "GENERAL"; - readonly Prompts: "PROMPTS"; - }>; - /** @deprecated use `FeedbackCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Announcement: "ANNOUNCEMENT"; - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Collections: "COLLECTIONS"; - readonly Feed: "FEED"; - readonly Search: "SEARCH"; - readonly Chat: "CHAT"; - readonly Ntp: "NTP"; - readonly Workflows: "WORKFLOWS"; - readonly Summary: "SUMMARY"; - readonly General: "GENERAL"; - readonly Prompts: "PROMPTS"; - }>; -} - -/** @internal */ -declare const FeedbackCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FeedbackCategory$outboundSchema: z.ZodNativeEnum; - -/** - * The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. - */ -declare const FeedbackCategory: { - readonly Announcement: "ANNOUNCEMENT"; - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Collections: "COLLECTIONS"; - readonly Feed: "FEED"; - readonly Search: "SEARCH"; - readonly Chat: "CHAT"; - readonly Ntp: "NTP"; - readonly Workflows: "WORKFLOWS"; - readonly Summary: "SUMMARY"; - readonly General: "GENERAL"; - readonly Prompts: "PROMPTS"; -}; - -/** - * The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. - */ -declare type FeedbackCategory = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedbackChannel$ { - /** @deprecated use `FeedbackChannel$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Company: "COMPANY"; - readonly Glean: "GLEAN"; - }>; - /** @deprecated use `FeedbackChannel$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Company: "COMPANY"; - readonly Glean: "GLEAN"; - }>; -} - -/** @internal */ -declare const FeedbackChannel$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FeedbackChannel$outboundSchema: z.ZodNativeEnum; - -declare const FeedbackChannel: { - readonly Company: "COMPANY"; - readonly Glean: "GLEAN"; -}; - -declare type FeedbackChannel = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedbackChatExchange$ { - /** @deprecated use `FeedbackChatExchange$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedbackChatExchange$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedbackChatExchange$Outbound` instead. */ - type Outbound = FeedbackChatExchange$Outbound; -} - -/** @internal */ -declare const FeedbackChatExchange$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedbackChatExchange$Outbound = { - timestamp?: number | undefined; - agent?: string | undefined; - userQuery?: string | undefined; - searchQuery?: string | undefined; - resultDocuments?: Array | undefined; - response?: string | undefined; -}; - -/** @internal */ -declare const FeedbackChatExchange$outboundSchema: z.ZodType; - -declare type FeedbackChatExchange = { - /** - * Unix timestamp in millis for the chat request. - */ - timestamp?: number | undefined; - /** - * Either DEFAULT (company knowledge) or GPT (world knowledge). - */ - agent?: string | undefined; - /** - * Initial query entered by the user. - */ - userQuery?: string | undefined; - /** - * Search query performed by the agent. - */ - searchQuery?: string | undefined; - /** - * List of documents read by the agent. - */ - resultDocuments?: Array | undefined; - response?: string | undefined; -}; - -declare function feedbackChatExchangeFromJSON(jsonString: string): Result; - -declare function feedbackChatExchangeToJSON(feedbackChatExchange: FeedbackChatExchange): string; - -declare function feedbackFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedbackRequest$ { - /** @deprecated use `FeedbackRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedbackRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedbackRequest$Outbound` instead. */ - type Outbound = FeedbackRequest$Outbound; -} - -/** @internal */ -declare const FeedbackRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedbackRequest$Outbound = { - feedbackQueryParameter?: string | undefined; - Feedback1?: components.Feedback$Outbound | undefined; -}; - -/** @internal */ -declare const FeedbackRequest$outboundSchema: z.ZodType; - -declare type FeedbackRequest = { - /** - * A URL encoded versions of Feedback. This is useful for requests. - */ - feedbackQueryParameter?: string | undefined; - feedback1?: components.Feedback | undefined; -}; - -declare function feedbackRequestFromJSON(jsonString: string): Result; - -declare function feedbackRequestToJSON(feedbackRequest: FeedbackRequest): string; - -declare function feedbackToJSON(feedback: Feedback): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedEntry$ { - /** @deprecated use `FeedEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedEntry$Outbound` instead. */ - type Outbound = FeedEntry$Outbound; -} - -/** @internal */ -declare const FeedEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedEntry$Outbound = { - entryId?: string | undefined; - title: string; - thumbnail?: Thumbnail$Outbound | undefined; - createdBy?: Person$Outbound | undefined; - uiConfig?: UiConfig$Outbound | undefined; - justificationType?: string | undefined; - justification?: string | undefined; - trackingToken?: string | undefined; - viewUrl?: string | undefined; - document?: Document$Outbound | undefined; - event?: CalendarEvent$Outbound | undefined; - announcement?: Announcement$Outbound | undefined; - digest?: Digest$Outbound | undefined; - collection?: Collection$Outbound | undefined; - collectionItem?: CollectionItem$Outbound | undefined; - person?: Person$Outbound | undefined; - app?: AppResult$Outbound | undefined; - chatSuggestion?: ChatSuggestion$Outbound | undefined; - promptTemplate?: PromptTemplateResult$Outbound | undefined; - workflow?: WorkflowResult$Outbound | undefined; - activities?: Array | undefined; - documentVisitorCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const FeedEntry$outboundSchema: z.ZodType; - -declare type FeedEntry = { - /** - * optional ID associated with a single feed entry (displayable_list_id) - */ - entryId?: string | undefined; - /** - * Title for the result. Can be document title, event title and so on. - */ - title: string; - thumbnail?: Thumbnail | undefined; - createdBy?: Person | undefined; - uiConfig?: UiConfig | undefined; - /** - * Type of the justification. - */ - justificationType?: JustificationType | undefined; - /** - * Server side generated justification string if server provides one. - */ - justification?: string | undefined; - /** - * An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - /** - * View URL for the entry if based on links that are not documents in Glean. - */ - viewUrl?: string | undefined; - document?: Document_2 | undefined; - event?: CalendarEvent | undefined; - announcement?: Announcement | undefined; - digest?: Digest | undefined; - collection?: Collection | undefined; - collectionItem?: CollectionItem | undefined; - person?: Person | undefined; - app?: AppResult | undefined; - chatSuggestion?: ChatSuggestion | undefined; - promptTemplate?: PromptTemplateResult | undefined; - workflow?: WorkflowResult | undefined; - /** - * List of activity where each activity has user, action, timestamp. - */ - activities?: Array | undefined; - documentVisitorCount?: CountInfo | undefined; -}; - -declare function feedEntryFromJSON(jsonString: string): Result; - -declare function feedEntryToJSON(feedEntry: FeedEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedRequest$ { - /** @deprecated use `FeedRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedRequest$Outbound` instead. */ - type Outbound = FeedRequest$Outbound; -} - -/** @internal */ -declare const FeedRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedRequest$Outbound = { - categories?: Array | undefined; - requestOptions?: FeedRequestOptions$Outbound | undefined; - timeoutMillis?: number | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; -}; - -/** @internal */ -declare const FeedRequest$outboundSchema: z.ZodType; - -declare type FeedRequest = { - /** - * Categories of content requested. An allowlist gives flexibility to request content separately or together. - */ - categories?: Array | undefined; - requestOptions?: FeedRequestOptions | undefined; - /** - * Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - */ - timeoutMillis?: number | undefined; - sessionInfo?: SessionInfo | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedRequestCategory$ { - /** @deprecated use `FeedRequestCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly WorkflowCollections: "WORKFLOW_COLLECTIONS"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; - /** @deprecated use `FeedRequestCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly WorkflowCollections: "WORKFLOW_COLLECTIONS"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; -} - -/** @internal */ -declare const FeedRequestCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FeedRequestCategory$outboundSchema: z.ZodNativeEnum; - -declare const FeedRequestCategory: { - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly WorkflowCollections: "WORKFLOW_COLLECTIONS"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; -}; - -declare type FeedRequestCategory = ClosedEnum; - -declare function feedRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedRequestOptions$ { - /** @deprecated use `FeedRequestOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedRequestOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedRequestOptions$Outbound` instead. */ - type Outbound = FeedRequestOptions$Outbound; -} - -/** @internal */ -declare const FeedRequestOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedRequestOptions$Outbound = { - resultSize: number; - timezoneOffset?: number | undefined; - categoryToResultSize?: { - [k: string]: CategoryToResultSize$Outbound; - } | undefined; - datasourceFilter?: Array | undefined; - chatZeroStateSuggestionOptions?: ChatZeroStateSuggestionOptions$Outbound | undefined; -}; - -/** @internal */ -declare const FeedRequestOptions$outboundSchema: z.ZodType; - -declare type FeedRequestOptions = { - /** - * Number of results asked in response. If a result is a collection, counts as one. - */ - resultSize: number; - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * Mapping from category to number of results asked for the category. - */ - categoryToResultSize?: { - [k: string]: CategoryToResultSize; - } | undefined; - /** - * Datasources for which content should be included. Empty is for all. - */ - datasourceFilter?: Array | undefined; - chatZeroStateSuggestionOptions?: ChatZeroStateSuggestionOptions | undefined; -}; - -declare function feedRequestOptionsFromJSON(jsonString: string): Result; - -declare function feedRequestOptionsToJSON(feedRequestOptions: FeedRequestOptions): string; - -declare function feedRequestToJSON(feedRequest: FeedRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedResponse$ { - /** @deprecated use `FeedResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedResponse$Outbound` instead. */ - type Outbound = FeedResponse$Outbound; -} - -/** @internal */ -declare const FeedResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedResponse$Outbound = { - experimentIds?: Array | undefined; - trackingToken?: string | undefined; - serverTimestamp: number; - results?: Array | undefined; - facetResults?: { - [k: string]: Array; - } | undefined; - mentionsTimeWindowInHours?: number | undefined; -}; - -/** @internal */ -declare const FeedResponse$outboundSchema: z.ZodType; - -declare type FeedResponse = { - /** - * List of experiment ids for the corresponding request. - */ - experimentIds?: Array | undefined; - /** - * An opaque token that represents this particular feed response. - */ - trackingToken?: string | undefined; - /** - * Server unix timestamp (in seconds since epoch UTC). - */ - serverTimestamp: number; - results?: Array | undefined; - /** - * Map from category to the list of facets that can be used to filter the entry's content. - */ - facetResults?: { - [k: string]: Array; - } | undefined; - /** - * The time window (in hours) used for generating user mentions. - */ - mentionsTimeWindowInHours?: number | undefined; -}; - -declare function feedResponseFromJSON(jsonString: string): Result; - -declare function feedResponseToJSON(feedResponse: FeedResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedResult$ { - /** @deprecated use `FeedResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FeedResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FeedResult$Outbound` instead. */ - type Outbound = FeedResult$Outbound; -} - -/** @internal */ -declare const FeedResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type FeedResult$Outbound = { - category: string; - primaryEntry: FeedEntry$Outbound; - secondaryEntries?: Array | undefined; - rank?: number | undefined; -}; - -/** @internal */ -declare const FeedResult$outboundSchema: z.ZodType; - -declare type FeedResult = { - /** - * Category of the result, one of the requested categories in incoming request. - */ - category: FeedResultCategory; - primaryEntry: FeedEntry; - /** - * Secondary entries for the result e.g. suggested docs for the calendar, carousel. - */ - secondaryEntries?: Array | undefined; - /** - * Rank of the result. Rank is suggested by server. Client side rank may differ. - */ - rank?: number | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FeedResultCategory$ { - /** @deprecated use `FeedResultCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly UseCase: "USE_CASE"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; - /** @deprecated use `FeedResultCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly UseCase: "USE_CASE"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; -} - -/** @internal */ -declare const FeedResultCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FeedResultCategory$outboundSchema: z.ZodNativeEnum; - -/** - * Category of the result, one of the requested categories in incoming request. - */ -declare const FeedResultCategory: { - readonly DocumentSuggestion: "DOCUMENT_SUGGESTION"; - readonly DocumentSuggestionScenario: "DOCUMENT_SUGGESTION_SCENARIO"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly UseCase: "USE_CASE"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly Event: "EVENT"; - readonly Announcement: "ANNOUNCEMENT"; - readonly Mention: "MENTION"; - readonly DatasourceAffinity: "DATASOURCE_AFFINITY"; - readonly Recent: "RECENT"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly Experimental: "EXPERIMENTAL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ExternalTasks: "EXTERNAL_TASKS"; - readonly DisplayableList: "DISPLAYABLE_LIST"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStateWorkflowCreatedByMe: "ZERO_STATE_WORKFLOW_CREATED_BY_ME"; - readonly ZeroStateWorkflowFavorites: "ZERO_STATE_WORKFLOW_FAVORITES"; - readonly ZeroStateWorkflowPopular: "ZERO_STATE_WORKFLOW_POPULAR"; - readonly ZeroStateWorkflowSuggestion: "ZERO_STATE_WORKFLOW_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; -}; - -/** - * Category of the result, one of the requested categories in incoming request. - */ -declare type FeedResultCategory = ClosedEnum; - -declare function feedResultFromJSON(jsonString: string): Result; - -declare function feedResultToJSON(feedResult: FeedResult): string; - -export declare type Fetcher = (input: RequestInfo | URL, init?: RequestInit) => Promise; - -declare function fileFromJSON(jsonString: string): Result; - -export declare namespace files { - export { - readableStreamToArrayBuffer, - getContentTypeFromFileName - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileT$ { - /** @deprecated use `FileT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileT$Outbound` instead. */ - type Outbound = FileT$Outbound; -} - -/** @internal */ -declare const FileT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileT$Outbound = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -declare const FileT$outboundSchema: z.ZodType; - -declare type FileT = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -declare function fileToJSON(fileT: FileT): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FollowupAction$ { - /** @deprecated use `FollowupAction$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FollowupAction$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FollowupAction$Outbound` instead. */ - type Outbound = FollowupAction$Outbound; -} - -/** @internal */ -declare const FollowupAction$inboundSchema: z.ZodType; - -/** @internal */ -declare type FollowupAction$Outbound = { - actionRunId?: string | undefined; - actionInstanceId?: string | undefined; - actionId?: string | undefined; - parameters?: { - [k: string]: string; - } | undefined; - recommendationText?: string | undefined; - actionLabel?: string | undefined; - userConfirmationRequired?: boolean | undefined; -}; - -/** @internal */ -declare const FollowupAction$outboundSchema: z.ZodType; - -/** - * A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately. - */ -declare type FollowupAction = { - /** - * Unique identifier for this actionRun recommendation event. - */ - actionRunId?: string | undefined; - /** - * The ID of the action instance that will be invoked. - */ - actionInstanceId?: string | undefined; - /** - * The ID of the associated action. - */ - actionId?: string | undefined; - /** - * Map of assistant predicted parameters and their corresponding values. - */ - parameters?: { - [k: string]: string; - } | undefined; - /** - * Text to be displayed to the user when recommending the action instance. - */ - recommendationText?: string | undefined; - /** - * The label to be used when displaying a button to execute this action instance. - */ - actionLabel?: string | undefined; - /** - * Whether user confirmation is needed before executing this action instance. - */ - userConfirmationRequired?: boolean | undefined; -}; - -declare function followupActionFromJSON(jsonString: string): Result; - -declare function followupActionToJSON(followupAction: FollowupAction): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Format$ { - /** @deprecated use `Format$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "LIST"; - }>; - /** @deprecated use `Format$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "LIST"; - }>; -} - -/** @internal */ -declare const Format$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Format$outboundSchema: z.ZodNativeEnum; - -/** - * defines how to render this particular displayable list card - */ -declare const Format: { - readonly List: "LIST"; -}; - -/** - * defines how to render this particular displayable list card - */ -declare type Format = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GeneratedAttachment$ { - /** @deprecated use `GeneratedAttachment$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GeneratedAttachment$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GeneratedAttachment$Outbound` instead. */ - type Outbound = GeneratedAttachment$Outbound; -} - -/** @internal */ -declare const GeneratedAttachment$inboundSchema: z.ZodType; - -/** @internal */ -declare type GeneratedAttachment$Outbound = { - strategyName?: string | undefined; - documents?: Array | undefined; - person?: Person$Outbound | undefined; - customer?: Customer$Outbound | undefined; - externalLinks?: Array | undefined; - content?: Array | undefined; -}; - -/** @internal */ -declare const GeneratedAttachment$outboundSchema: z.ZodType; - -/** - * These are attachments that aren't natively present on the event, and have been smartly suggested. - */ -declare type GeneratedAttachment = { - /** - * The name of method used to surface relevant data for a given calendar event. - */ - strategyName?: EventStrategyName | undefined; - documents?: Array | undefined; - person?: Person | undefined; - customer?: Customer | undefined; - /** - * A list of links to external sources outside of Glean. - */ - externalLinks?: Array | undefined; - content?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GeneratedAttachmentContent$ { - /** @deprecated use `GeneratedAttachmentContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GeneratedAttachmentContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GeneratedAttachmentContent$Outbound` instead. */ - type Outbound = GeneratedAttachmentContent$Outbound; -} - -/** @internal */ -declare const GeneratedAttachmentContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type GeneratedAttachmentContent$Outbound = { - displayHeader?: string | undefined; - text?: string | undefined; -}; - -/** @internal */ -declare const GeneratedAttachmentContent$outboundSchema: z.ZodType; - -/** - * Content that has been generated or extrapolated from the documents present in the document field. - */ -declare type GeneratedAttachmentContent = { - /** - * The header describing the generated content. - */ - displayHeader?: string | undefined; - /** - * The content that has been generated. - */ - text?: string | undefined; -}; - -declare function generatedAttachmentContentFromJSON(jsonString: string): Result; - -declare function generatedAttachmentContentToJSON(generatedAttachmentContent: GeneratedAttachmentContent): string; - -declare function generatedAttachmentFromJSON(jsonString: string): Result; - -declare function generatedAttachmentToJSON(generatedAttachment: GeneratedAttachment): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GeneratedQna$ { - /** @deprecated use `GeneratedQna$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GeneratedQna$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GeneratedQna$Outbound` instead. */ - type Outbound = GeneratedQna$Outbound; -} - -/** @internal */ -declare const GeneratedQna$inboundSchema: z.ZodType; - -/** @internal */ -declare type GeneratedQna$Outbound = { - question?: string | undefined; - answer?: string | undefined; - followUpPrompts?: Array | undefined; - followupActions?: Array | undefined; - ranges?: Array | undefined; - status?: string | undefined; - cursor?: string | undefined; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const GeneratedQna$outboundSchema: z.ZodType; - -declare type GeneratedQna = { - /** - * Search query rephrased into a question. - */ - question?: string | undefined; - /** - * Answer generated for the given query or the generated question. - */ - answer?: string | undefined; - /** - * List of all follow-up prompts generated for the given query or the generated question. - */ - followUpPrompts?: Array | undefined; - /** - * List of follow-up actions generated for the given query or the generated question. - */ - followupActions?: Array | undefined; - /** - * Answer subsections to mark with special formatting (citations, bolding etc) - */ - ranges?: Array | undefined; - /** - * Status of backend generating the answer - */ - status?: GeneratedQnaStatus | undefined; - /** - * An opaque cursor representing the search request - */ - cursor?: string | undefined; - /** - * An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; -}; - -declare function generatedQnaFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GeneratedQnaStatus$ { - /** @deprecated use `GeneratedQnaStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Computing: "COMPUTING"; - readonly Disabled: "DISABLED"; - readonly Failed: "FAILED"; - readonly NoAnswer: "NO_ANSWER"; - readonly Skipped: "SKIPPED"; - readonly Streaming: "STREAMING"; - readonly Succeeded: "SUCCEEDED"; - readonly Timeout: "TIMEOUT"; - }>; - /** @deprecated use `GeneratedQnaStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Computing: "COMPUTING"; - readonly Disabled: "DISABLED"; - readonly Failed: "FAILED"; - readonly NoAnswer: "NO_ANSWER"; - readonly Skipped: "SKIPPED"; - readonly Streaming: "STREAMING"; - readonly Succeeded: "SUCCEEDED"; - readonly Timeout: "TIMEOUT"; - }>; -} - -/** @internal */ -declare const GeneratedQnaStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GeneratedQnaStatus$outboundSchema: z.ZodNativeEnum; - -/** - * Status of backend generating the answer - */ -declare const GeneratedQnaStatus: { - readonly Computing: "COMPUTING"; - readonly Disabled: "DISABLED"; - readonly Failed: "FAILED"; - readonly NoAnswer: "NO_ANSWER"; - readonly Skipped: "SKIPPED"; - readonly Streaming: "STREAMING"; - readonly Succeeded: "SUCCEEDED"; - readonly Timeout: "TIMEOUT"; -}; - -/** - * Status of backend generating the answer - */ -declare type GeneratedQnaStatus = ClosedEnum; - -declare function generatedQnaToJSON(generatedQna: GeneratedQna): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAgentRequest$ { - /** @deprecated use `GetAgentRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetAgentRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetAgentRequest$Outbound` instead. */ - type Outbound = GetAgentRequest$Outbound; -} - -/** @internal */ -declare const GetAgentRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetAgentRequest$Outbound = { - timezoneOffset?: number | undefined; - agent_id: string; -}; - -/** @internal */ -declare const GetAgentRequest$outboundSchema: z.ZodType; - -declare type GetAgentRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * The ID of the agent. - */ - agentId: string; -}; - -declare function getAgentRequestFromJSON(jsonString: string): Result; - -declare function getAgentRequestToJSON(getAgentRequest: GetAgentRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAgentSchemasRequest$ { - /** @deprecated use `GetAgentSchemasRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetAgentSchemasRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetAgentSchemasRequest$Outbound` instead. */ - type Outbound = GetAgentSchemasRequest$Outbound; -} - -/** @internal */ -declare const GetAgentSchemasRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetAgentSchemasRequest$Outbound = { - timezoneOffset?: number | undefined; - agent_id: string; -}; - -/** @internal */ -declare const GetAgentSchemasRequest$outboundSchema: z.ZodType; - -declare type GetAgentSchemasRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * The ID of the agent. - */ - agentId: string; -}; - -declare function getAgentSchemasRequestFromJSON(jsonString: string): Result; - -declare function getAgentSchemasRequestToJSON(getAgentSchemasRequest: GetAgentSchemasRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAnswerError$ { - /** @deprecated use `GetAnswerError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetAnswerError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetAnswerError$Outbound` instead. */ - type Outbound = GetAnswerError$Outbound; -} - -/** @internal */ -declare const GetAnswerError$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetAnswerError$Outbound = { - errorType?: string | undefined; - answerAuthor?: Person$Outbound | undefined; -}; - -/** @internal */ -declare const GetAnswerError$outboundSchema: z.ZodType; - -declare type GetAnswerError = { - errorType?: GetAnswerErrorErrorType | undefined; - answerAuthor?: Person | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAnswerErrorErrorType$ { - /** @deprecated use `GetAnswerErrorErrorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; - }>; - /** @deprecated use `GetAnswerErrorErrorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; - }>; -} - -/** @internal */ -declare const GetAnswerErrorErrorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GetAnswerErrorErrorType$outboundSchema: z.ZodNativeEnum; - -declare const GetAnswerErrorErrorType: { - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; -}; - -declare type GetAnswerErrorErrorType = ClosedEnum; - -declare function getAnswerErrorFromJSON(jsonString: string): Result; - -declare function getAnswerErrorToJSON(getAnswerError: GetAnswerError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAnswerRequest$ { - /** @deprecated use `GetAnswerRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetAnswerRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetAnswerRequest$Outbound` instead. */ - type Outbound = GetAnswerRequest$Outbound; -} - -/** @internal */ -declare const GetAnswerRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetAnswerRequest$Outbound = { - id?: number | undefined; - docId?: string | undefined; -}; - -/** @internal */ -declare const GetAnswerRequest$outboundSchema: z.ZodType; - -declare type GetAnswerRequest = { - /** - * The opaque ID of the Answer. - */ - id?: number | undefined; - /** - * Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - */ - docId?: string | undefined; -}; - -declare function getAnswerRequestFromJSON(jsonString: string): Result; - -declare function getAnswerRequestToJSON(getAnswerRequest: GetAnswerRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetAnswerResponse$ { - /** @deprecated use `GetAnswerResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetAnswerResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetAnswerResponse$Outbound` instead. */ - type Outbound = GetAnswerResponse$Outbound; -} - -/** @internal */ -declare const GetAnswerResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetAnswerResponse$Outbound = { - answerResult?: AnswerResult$Outbound | undefined; - error?: GetAnswerError$Outbound | undefined; -}; - -/** @internal */ -declare const GetAnswerResponse$outboundSchema: z.ZodType; - -declare type GetAnswerResponse = { - answerResult?: AnswerResult | undefined; - error?: GetAnswerError | undefined; -}; - -declare function getAnswerResponseFromJSON(jsonString: string): Result; - -declare function getAnswerResponseToJSON(getAnswerResponse: GetAnswerResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatApplicationRequest$ { - /** @deprecated use `GetChatApplicationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatApplicationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatApplicationRequest$Outbound` instead. */ - type Outbound = GetChatApplicationRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetchatapplicationRequest$ { - /** @deprecated use `GetchatapplicationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetchatapplicationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetchatapplicationRequest$Outbound` instead. */ - type Outbound = GetchatapplicationRequest$Outbound; -} - -/** @internal */ -declare const GetChatApplicationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatapplicationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatApplicationRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare type GetchatapplicationRequest$Outbound = { - timezoneOffset?: number | undefined; - GetChatApplicationRequest: components.GetChatApplicationRequest$Outbound; -}; - -/** @internal */ -declare const GetChatApplicationRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatapplicationRequest$outboundSchema: z.ZodType; - -declare type GetChatApplicationRequest = { - /** - * The id of the Chat application to be retrieved. - */ - id: string; -}; - -declare type GetchatapplicationRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - getChatApplicationRequest: components.GetChatApplicationRequest; -}; - -declare function getChatApplicationRequestFromJSON(jsonString: string): Result; - -declare function getchatapplicationRequestFromJSON(jsonString: string): Result; - -declare function getChatApplicationRequestToJSON(getChatApplicationRequest: GetChatApplicationRequest): string; - -declare function getchatapplicationRequestToJSON(getchatapplicationRequest: GetchatapplicationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatApplicationResponse$ { - /** @deprecated use `GetChatApplicationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatApplicationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatApplicationResponse$Outbound` instead. */ - type Outbound = GetChatApplicationResponse$Outbound; -} - -/** @internal */ -declare const GetChatApplicationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatApplicationResponse$Outbound = { - application?: any | undefined; -}; - -/** @internal */ -declare const GetChatApplicationResponse$outboundSchema: z.ZodType; - -declare type GetChatApplicationResponse = { - application?: any | undefined; -}; - -declare function getChatApplicationResponseFromJSON(jsonString: string): Result; - -declare function getChatApplicationResponseToJSON(getChatApplicationResponse: GetChatApplicationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatFilesRequest$ { - /** @deprecated use `GetChatFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatFilesRequest$Outbound` instead. */ - type Outbound = GetChatFilesRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetchatfilesRequest$ { - /** @deprecated use `GetchatfilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetchatfilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetchatfilesRequest$Outbound` instead. */ - type Outbound = GetchatfilesRequest$Outbound; -} - -/** @internal */ -declare const GetChatFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatfilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatFilesRequest$Outbound = { - fileIds: Array; - chatId?: string | undefined; -}; - -/** @internal */ -declare type GetchatfilesRequest$Outbound = { - timezoneOffset?: number | undefined; - GetChatFilesRequest: components.GetChatFilesRequest$Outbound; -}; - -/** @internal */ -declare const GetChatFilesRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatfilesRequest$outboundSchema: z.ZodType; - -declare type GetChatFilesRequest = { - /** - * IDs of files to fetch. - */ - fileIds: Array; - /** - * The ID of the chat that contains the chat file. - */ - chatId?: string | undefined; -}; - -declare type GetchatfilesRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - getChatFilesRequest: components.GetChatFilesRequest; -}; - -declare function getChatFilesRequestFromJSON(jsonString: string): Result; - -declare function getchatfilesRequestFromJSON(jsonString: string): Result; - -declare function getChatFilesRequestToJSON(getChatFilesRequest: GetChatFilesRequest): string; - -declare function getchatfilesRequestToJSON(getchatfilesRequest: GetchatfilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatFilesResponse$ { - /** @deprecated use `GetChatFilesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatFilesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatFilesResponse$Outbound` instead. */ - type Outbound = GetChatFilesResponse$Outbound; -} - -/** @internal */ -declare const GetChatFilesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatFilesResponse$Outbound = { - files?: { - [k: string]: ChatFile$Outbound; - } | undefined; -}; - -/** @internal */ -declare const GetChatFilesResponse$outboundSchema: z.ZodType; - -declare type GetChatFilesResponse = { - /** - * A map of file IDs to ChatFile structs. - */ - files?: { - [k: string]: ChatFile; - } | undefined; -}; - -declare function getChatFilesResponseFromJSON(jsonString: string): Result; - -declare function getChatFilesResponseToJSON(getChatFilesResponse: GetChatFilesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatRequest$ { - /** @deprecated use `GetChatRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatRequest$Outbound` instead. */ - type Outbound = GetChatRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetchatRequest$ { - /** @deprecated use `GetchatRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetchatRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetchatRequest$Outbound` instead. */ - type Outbound = GetchatRequest$Outbound; -} - -/** @internal */ -declare const GetChatRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare type GetchatRequest$Outbound = { - timezoneOffset?: number | undefined; - GetChatRequest: components.GetChatRequest$Outbound; -}; - -/** @internal */ -declare const GetChatRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const GetchatRequest$outboundSchema: z.ZodType; - -declare type GetChatRequest = { - /** - * The id of the Chat to be retrieved. - */ - id: string; -}; - -declare type GetchatRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - getChatRequest: components.GetChatRequest; -}; - -declare function getChatRequestFromJSON(jsonString: string): Result; - -declare function getchatRequestFromJSON(jsonString: string): Result; - -declare function getChatRequestToJSON(getChatRequest: GetChatRequest): string; - -declare function getchatRequestToJSON(getchatRequest: GetchatRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetChatResponse$ { - /** @deprecated use `GetChatResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetChatResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetChatResponse$Outbound` instead. */ - type Outbound = GetChatResponse$Outbound; -} - -/** @internal */ -declare const GetChatResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetChatResponse$Outbound = { - chatResult?: ChatResult$Outbound | undefined; -}; - -/** @internal */ -declare const GetChatResponse$outboundSchema: z.ZodType; - -declare type GetChatResponse = { - chatResult?: ChatResult | undefined; -}; - -declare function getChatResponseFromJSON(jsonString: string): Result; - -declare function getChatResponseToJSON(getChatResponse: GetChatResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetCollectionRequest$ { - /** @deprecated use `GetCollectionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetCollectionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetCollectionRequest$Outbound` instead. */ - type Outbound = GetCollectionRequest$Outbound; -} - -/** @internal */ -declare const GetCollectionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetCollectionRequest$Outbound = { - id: number; - withItems?: boolean | undefined; - withHierarchy?: boolean | undefined; - allowedDatasource?: string | undefined; -}; - -/** @internal */ -declare const GetCollectionRequest$outboundSchema: z.ZodType; - -declare type GetCollectionRequest = { - /** - * The ID of the Collection to be retrieved. - */ - id: number; - /** - * Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive. - */ - withItems?: boolean | undefined; - /** - * Whether or not to include the top level Collection in this Collection's hierarchy. - */ - withHierarchy?: boolean | undefined; - /** - * The datasource allowed in the Collection returned. - */ - allowedDatasource?: string | undefined; -}; - -declare function getCollectionRequestFromJSON(jsonString: string): Result; - -declare function getCollectionRequestToJSON(getCollectionRequest: GetCollectionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetCollectionResponse$ { - /** @deprecated use `GetCollectionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetCollectionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetCollectionResponse$Outbound` instead. */ - type Outbound = GetCollectionResponse$Outbound; -} - -/** @internal */ -declare const GetCollectionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetCollectionResponse$Outbound = { - collection?: Collection$Outbound | undefined; - rootCollection?: Collection$Outbound | undefined; - trackingToken?: string | undefined; - error?: CollectionError$Outbound | undefined; -}; - -/** @internal */ -declare const GetCollectionResponse$outboundSchema: z.ZodType; - -declare type GetCollectionResponse = { - collection?: Collection | undefined; - rootCollection?: Collection | undefined; - /** - * An opaque token that represents this particular Collection. To be used for `/feedback` reporting. - */ - trackingToken?: string | undefined; - error?: CollectionError | undefined; -}; - -declare function getCollectionResponseFromJSON(jsonString: string): Result; - -declare function getCollectionResponseToJSON(getCollectionResponse: GetCollectionResponse): string; - -/** - * Determines the MIME content type based on a file's extension. - * Returns null if the extension is not recognized. - */ -declare function getContentTypeFromFileName(fileName: string): string | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDatasourceConfigRequest$ { - /** @deprecated use `GetDatasourceConfigRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDatasourceConfigRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDatasourceConfigRequest$Outbound` instead. */ - type Outbound = GetDatasourceConfigRequest$Outbound; -} - -/** @internal */ -declare const GetDatasourceConfigRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDatasourceConfigRequest$Outbound = { - datasource: string; -}; - -/** @internal */ -declare const GetDatasourceConfigRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /getdatasourceconfig API call - */ -declare type GetDatasourceConfigRequest = { - /** - * Datasource name for which config is needed. - */ - datasource: string; -}; - -declare function getDatasourceConfigRequestFromJSON(jsonString: string): Result; - -declare function getDatasourceConfigRequestToJSON(getDatasourceConfigRequest: GetDatasourceConfigRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDlpReportResponse$ { - /** @deprecated use `GetDlpReportResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDlpReportResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDlpReportResponse$Outbound` instead. */ - type Outbound = GetDlpReportResponse$Outbound; -} - -/** @internal */ -declare const GetDlpReportResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDlpReportResponse$Outbound = { - report?: DlpReport$Outbound | undefined; -}; - -/** @internal */ -declare const GetDlpReportResponse$outboundSchema: z.ZodType; - -declare type GetDlpReportResponse = { - /** - * Full policy information that will be used for scans. - */ - report?: DlpReport | undefined; -}; - -declare function getDlpReportResponseFromJSON(jsonString: string): Result; - -declare function getDlpReportResponseToJSON(getDlpReportResponse: GetDlpReportResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocPermissionsRequest$ { - /** @deprecated use `GetDocPermissionsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocPermissionsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocPermissionsRequest$Outbound` instead. */ - type Outbound = GetDocPermissionsRequest$Outbound; -} - -/** @internal */ -declare const GetDocPermissionsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocPermissionsRequest$Outbound = { - documentId?: string | undefined; -}; - -/** @internal */ -declare const GetDocPermissionsRequest$outboundSchema: z.ZodType; - -declare type GetDocPermissionsRequest = { - /** - * The Glean Document ID to retrieve permissions for. - */ - documentId?: string | undefined; -}; - -declare function getDocPermissionsRequestFromJSON(jsonString: string): Result; - -declare function getDocPermissionsRequestToJSON(getDocPermissionsRequest: GetDocPermissionsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocPermissionsResponse$ { - /** @deprecated use `GetDocPermissionsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocPermissionsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocPermissionsResponse$Outbound` instead. */ - type Outbound = GetDocPermissionsResponse$Outbound; -} - -/** @internal */ -declare const GetDocPermissionsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocPermissionsResponse$Outbound = { - allowedUserEmails?: Array | undefined; -}; - -/** @internal */ -declare const GetDocPermissionsResponse$outboundSchema: z.ZodType; - -declare type GetDocPermissionsResponse = { - /** - * A list of emails of users who have access to the document. If the document is visible to all Glean users, a list with only a single value of 'VISIBLE_TO_ALL'. - */ - allowedUserEmails?: Array | undefined; -}; - -declare function getDocPermissionsResponseFromJSON(jsonString: string): Result; - -declare function getDocPermissionsResponseToJSON(getDocPermissionsResponse: GetDocPermissionsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentCountRequest$ { - /** @deprecated use `GetDocumentCountRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentCountRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentCountRequest$Outbound` instead. */ - type Outbound = GetDocumentCountRequest$Outbound; -} - -/** @internal */ -declare const GetDocumentCountRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentCountRequest$Outbound = { - datasource: string; -}; - -/** @internal */ -declare const GetDocumentCountRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /getdocumentcount API call - */ -declare type GetDocumentCountRequest = { - /** - * Datasource name for which document count is needed. - */ - datasource: string; -}; - -declare function getDocumentCountRequestFromJSON(jsonString: string): Result; - -declare function getDocumentCountRequestToJSON(getDocumentCountRequest: GetDocumentCountRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentCountResponse$ { - /** @deprecated use `GetDocumentCountResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentCountResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentCountResponse$Outbound` instead. */ - type Outbound = GetDocumentCountResponse$Outbound; -} - -/** @internal */ -declare const GetDocumentCountResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentCountResponse$Outbound = { - documentCount?: number | undefined; -}; - -/** @internal */ -declare const GetDocumentCountResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /getdocumentcount API call - */ -declare type GetDocumentCountResponse = { - /** - * Number of documents corresponding to the specified custom datasource. - */ - documentCount?: number | undefined; -}; - -declare function getDocumentCountResponseFromJSON(jsonString: string): Result; - -declare function getDocumentCountResponseToJSON(getDocumentCountResponse: GetDocumentCountResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentsByFacetsRequest$ { - /** @deprecated use `GetDocumentsByFacetsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsByFacetsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsByFacetsRequest$Outbound` instead. */ - type Outbound = GetDocumentsByFacetsRequest$Outbound; -} - -/** @internal */ -declare const GetDocumentsByFacetsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentsByFacetsRequest$Outbound = { - datasourcesFilter?: Array | undefined; - filterSets: Array; - cursor?: string | undefined; -}; - -/** @internal */ -declare const GetDocumentsByFacetsRequest$outboundSchema: z.ZodType; - -declare type GetDocumentsByFacetsRequest = { - /** - * Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - */ - datasourcesFilter?: Array | undefined; - /** - * A list of facet filter sets that will be OR'ed together. An AND is assumed between different filters in each set. - */ - filterSets: Array; - /** - * Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - */ - cursor?: string | undefined; -}; - -declare function getDocumentsByFacetsRequestFromJSON(jsonString: string): Result; - -declare function getDocumentsByFacetsRequestToJSON(getDocumentsByFacetsRequest: GetDocumentsByFacetsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentsByFacetsResponse$ { - /** @deprecated use `GetDocumentsByFacetsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsByFacetsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsByFacetsResponse$Outbound` instead. */ - type Outbound = GetDocumentsByFacetsResponse$Outbound; -} - -/** @internal */ -declare const GetDocumentsByFacetsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentsByFacetsResponse$Outbound = { - documents?: Array | undefined; - hasMoreResults?: boolean | undefined; - cursor?: string | undefined; -}; - -/** @internal */ -declare const GetDocumentsByFacetsResponse$outboundSchema: z.ZodType; - -declare type GetDocumentsByFacetsResponse = { - /** - * The document details, ordered by score. - */ - documents?: Array | undefined; - /** - * Whether more results are available. Use cursor to retrieve them. - */ - hasMoreResults?: boolean | undefined; - /** - * Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - */ - cursor?: string | undefined; -}; - -declare function getDocumentsByFacetsResponseFromJSON(jsonString: string): Result; - -declare function getDocumentsByFacetsResponseToJSON(getDocumentsByFacetsResponse: GetDocumentsByFacetsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentsRequest$ { - /** @deprecated use `GetDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsRequest$Outbound` instead. */ - type Outbound = GetDocumentsRequest$Outbound; -} - -/** @internal */ -declare const GetDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentsRequest$Outbound = { - documentSpecs: Array; - includeFields?: Array | undefined; -}; - -/** @internal */ -declare const GetDocumentsRequest$outboundSchema: z.ZodType; - -declare type GetDocumentsRequest = { - /** - * The specification for the documents to be retrieved. - */ - documentSpecs: Array; - /** - * List of Document fields to return (that aren't returned by default) - */ - includeFields?: Array | undefined; -}; - -declare function getDocumentsRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentsRequestIncludeField$ { - /** @deprecated use `GetDocumentsRequestIncludeField$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly LastViewedAt: "LAST_VIEWED_AT"; - readonly VisitorsCount: "VISITORS_COUNT"; - readonly RecentShares: "RECENT_SHARES"; - readonly DocumentContent: "DOCUMENT_CONTENT"; - }>; - /** @deprecated use `GetDocumentsRequestIncludeField$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly LastViewedAt: "LAST_VIEWED_AT"; - readonly VisitorsCount: "VISITORS_COUNT"; - readonly RecentShares: "RECENT_SHARES"; - readonly DocumentContent: "DOCUMENT_CONTENT"; - }>; -} - -/** @internal */ -declare const GetDocumentsRequestIncludeField$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GetDocumentsRequestIncludeField$outboundSchema: z.ZodNativeEnum; - -declare const GetDocumentsRequestIncludeField: { - readonly LastViewedAt: "LAST_VIEWED_AT"; - readonly VisitorsCount: "VISITORS_COUNT"; - readonly RecentShares: "RECENT_SHARES"; - readonly DocumentContent: "DOCUMENT_CONTENT"; -}; - -declare type GetDocumentsRequestIncludeField = ClosedEnum; - -declare function getDocumentsRequestToJSON(getDocumentsRequest: GetDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentsResponse$ { - /** @deprecated use `GetDocumentsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentsResponse$Outbound` instead. */ - type Outbound = GetDocumentsResponse$Outbound; -} - -/** @internal */ -declare const GetDocumentsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentsResponse$Outbound = { - documents?: { - [k: string]: DocumentOrErrorUnion$Outbound; - } | undefined; -}; - -/** @internal */ -declare const GetDocumentsResponse$outboundSchema: z.ZodType; - -declare type GetDocumentsResponse = { - /** - * The document details or the error if document is not found. - */ - documents?: { - [k: string]: DocumentOrErrorUnion; - } | undefined; -}; - -declare function getDocumentsResponseFromJSON(jsonString: string): Result; - -declare function getDocumentsResponseToJSON(getDocumentsResponse: GetDocumentsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentStatusRequest$ { - /** @deprecated use `GetDocumentStatusRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentStatusRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentStatusRequest$Outbound` instead. */ - type Outbound = GetDocumentStatusRequest$Outbound; -} - -/** @internal */ -declare const GetDocumentStatusRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentStatusRequest$Outbound = { - datasource: string; - objectType: string; - docId: string; -}; - -/** @internal */ -declare const GetDocumentStatusRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body for /getdocumentstatus API call - */ -declare type GetDocumentStatusRequest = { - /** - * Datasource to get fetch document status for - */ - datasource: string; - /** - * Object type of the document to get the status for - */ - objectType: string; - /** - * Glean Document ID within the datasource to get the status for. - */ - docId: string; -}; - -declare function getDocumentStatusRequestFromJSON(jsonString: string): Result; - -declare function getDocumentStatusRequestToJSON(getDocumentStatusRequest: GetDocumentStatusRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentStatusResponse$ { - /** @deprecated use `GetDocumentStatusResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentStatusResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentStatusResponse$Outbound` instead. */ - type Outbound = GetDocumentStatusResponse$Outbound; -} - -/** @internal */ -declare const GetDocumentStatusResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentStatusResponse$Outbound = { - uploadStatus?: string | undefined; - lastUploadedAt?: number | undefined; - indexingStatus?: string | undefined; - lastIndexedAt?: number | undefined; -}; - -/** @internal */ -declare const GetDocumentStatusResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /getdocumentstatus API call - */ -declare type GetDocumentStatusResponse = { - /** - * Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - */ - uploadStatus?: string | undefined; - /** - * Time of last successful upload, in epoch seconds - */ - lastUploadedAt?: number | undefined; - /** - * Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - */ - indexingStatus?: string | undefined; - /** - * Time of last successful indexing, in epoch seconds - */ - lastIndexedAt?: number | undefined; -}; - -declare function getDocumentStatusResponseFromJSON(jsonString: string): Result; - -declare function getDocumentStatusResponseToJSON(getDocumentStatusResponse: GetDocumentStatusResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetDocumentVisibilityOverridesResponse$ { - /** @deprecated use `GetDocumentVisibilityOverridesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetDocumentVisibilityOverridesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetDocumentVisibilityOverridesResponse$Outbound` instead. */ - type Outbound = GetDocumentVisibilityOverridesResponse$Outbound; -} - -/** @internal */ -declare const GetDocumentVisibilityOverridesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetDocumentVisibilityOverridesResponse$Outbound = { - visibilityOverrides?: Array | undefined; -}; - -/** @internal */ -declare const GetDocumentVisibilityOverridesResponse$outboundSchema: z.ZodType; - -declare type GetDocumentVisibilityOverridesResponse = { - visibilityOverrides?: Array | undefined; -}; - -declare function getDocumentVisibilityOverridesResponseFromJSON(jsonString: string): Result; - -declare function getDocumentVisibilityOverridesResponseToJSON(getDocumentVisibilityOverridesResponse: GetDocumentVisibilityOverridesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetdocvisibilityRequest$ { - /** @deprecated use `GetdocvisibilityRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetdocvisibilityRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetdocvisibilityRequest$Outbound` instead. */ - type Outbound = GetdocvisibilityRequest$Outbound; -} - -/** @internal */ -declare const GetdocvisibilityRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetdocvisibilityRequest$Outbound = { - docIds?: Array | undefined; -}; - -/** @internal */ -declare const GetdocvisibilityRequest$outboundSchema: z.ZodType; - -declare type GetdocvisibilityRequest = { - /** - * List of doc-ids which will have their hide status fetched. - */ - docIds?: Array | undefined; -}; - -declare function getdocvisibilityRequestFromJSON(jsonString: string): Result; - -declare function getdocvisibilityRequestToJSON(getdocvisibilityRequest: GetdocvisibilityRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetPinRequest$ { - /** @deprecated use `GetPinRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetPinRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetPinRequest$Outbound` instead. */ - type Outbound = GetPinRequest$Outbound; -} - -/** @internal */ -declare const GetPinRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetPinRequest$Outbound = { - id?: string | undefined; -}; - -/** @internal */ -declare const GetPinRequest$outboundSchema: z.ZodType; - -declare type GetPinRequest = { - /** - * The opaque id of the pin to be fetched. - */ - id?: string | undefined; -}; - -declare function getPinRequestFromJSON(jsonString: string): Result; - -declare function getPinRequestToJSON(getPinRequest: GetPinRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetPinResponse$ { - /** @deprecated use `GetPinResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetPinResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetPinResponse$Outbound` instead. */ - type Outbound = GetPinResponse$Outbound; -} - -/** @internal */ -declare const GetPinResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetPinResponse$Outbound = { - pin?: PinDocument$Outbound | undefined; -}; - -/** @internal */ -declare const GetPinResponse$outboundSchema: z.ZodType; - -declare type GetPinResponse = { - pin?: PinDocument | undefined; -}; - -declare function getPinResponseFromJSON(jsonString: string): Result; - -declare function getPinResponseToJSON(getPinResponse: GetPinResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetpolicyRequest$ { - /** @deprecated use `GetpolicyRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetpolicyRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetpolicyRequest$Outbound` instead. */ - type Outbound = GetpolicyRequest$Outbound; -} - -/** @internal */ -declare const GetpolicyRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetpolicyRequest$Outbound = { - id: string; - version?: number | undefined; -}; - -/** @internal */ -declare const GetpolicyRequest$outboundSchema: z.ZodType; - -declare type GetpolicyRequest = { - /** - * The id of the policy to fetch. - */ - id: string; - /** - * The version of the policy to fetch. Each time a policy is updated, the older version is still stored. If this is left empty, the latest policy is fetched. - */ - version?: number | undefined; -}; - -declare function getpolicyRequestFromJSON(jsonString: string): Result; - -declare function getpolicyRequestToJSON(getpolicyRequest: GetpolicyRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetreportstatusRequest$ { - /** @deprecated use `GetreportstatusRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetreportstatusRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetreportstatusRequest$Outbound` instead. */ - type Outbound = GetreportstatusRequest$Outbound; -} - -/** @internal */ -declare const GetreportstatusRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetreportstatusRequest$Outbound = { - id: string; -}; - -/** @internal */ -declare const GetreportstatusRequest$outboundSchema: z.ZodType; - -declare type GetreportstatusRequest = { - /** - * The id of the report to get run status for. - */ - id: string; -}; - -declare function getreportstatusRequestFromJSON(jsonString: string): Result; - -declare function getreportstatusRequestToJSON(getreportstatusRequest: GetreportstatusRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetRestApiV1ToolsListRequest$ { - /** @deprecated use `GetRestApiV1ToolsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetRestApiV1ToolsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetRestApiV1ToolsListRequest$Outbound` instead. */ - type Outbound = GetRestApiV1ToolsListRequest$Outbound; -} - -/** @internal */ -declare const GetRestApiV1ToolsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetRestApiV1ToolsListRequest$Outbound = { - toolNames?: Array | undefined; -}; - -/** @internal */ -declare const GetRestApiV1ToolsListRequest$outboundSchema: z.ZodType; - -declare type GetRestApiV1ToolsListRequest = { - /** - * Optional array of tool names to filter by - */ - toolNames?: Array | undefined; -}; - -declare function getRestApiV1ToolsListRequestFromJSON(jsonString: string): Result; - -declare function getRestApiV1ToolsListRequestToJSON(getRestApiV1ToolsListRequest: GetRestApiV1ToolsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetShortcutRequest$ { - /** @deprecated use `GetShortcutRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetShortcutRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetShortcutRequest$Outbound` instead. */ - type Outbound = GetShortcutRequest$Outbound; -} - -/** @internal */ -declare const GetShortcutRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetShortcutRequest$Outbound = { - alias: string; -}; - -/** @internal */ -declare const GetShortcutRequest$outboundSchema: z.ZodType; - -declare type GetShortcutRequest = { - /** - * The alias for the shortcut, including any arguments for variable shortcuts. - */ - alias: string; -}; - -declare function getShortcutRequestFromJSON(jsonString: string): Result; - -declare function getShortcutRequestToJSON(getShortcutRequest: GetShortcutRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetShortcutRequestUnion$ { - /** @deprecated use `GetShortcutRequestUnion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetShortcutRequestUnion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetShortcutRequestUnion$Outbound` instead. */ - type Outbound = GetShortcutRequestUnion$Outbound; -} - -/** @internal */ -declare const GetShortcutRequestUnion$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetShortcutRequestUnion$Outbound = GetShortcutRequest$Outbound | UserGeneratedContentId$Outbound; - -/** @internal */ -declare const GetShortcutRequestUnion$outboundSchema: z.ZodType; - -declare type GetShortcutRequestUnion = GetShortcutRequest | UserGeneratedContentId; - -declare function getShortcutRequestUnionFromJSON(jsonString: string): Result; - -declare function getShortcutRequestUnionToJSON(getShortcutRequestUnion: GetShortcutRequestUnion): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetShortcutResponse$ { - /** @deprecated use `GetShortcutResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetShortcutResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetShortcutResponse$Outbound` instead. */ - type Outbound = GetShortcutResponse$Outbound; -} - -/** @internal */ -declare const GetShortcutResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetShortcutResponse$Outbound = { - shortcut?: Shortcut$Outbound | undefined; - error?: ShortcutError$Outbound | undefined; -}; - -/** @internal */ -declare const GetShortcutResponse$outboundSchema: z.ZodType; - -declare type GetShortcutResponse = { - shortcut?: Shortcut | undefined; - error?: ShortcutError | undefined; -}; - -declare function getShortcutResponseFromJSON(jsonString: string): Result; - -declare function getShortcutResponseToJSON(getShortcutResponse: GetShortcutResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetUserCountRequest$ { - /** @deprecated use `GetUserCountRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetUserCountRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetUserCountRequest$Outbound` instead. */ - type Outbound = GetUserCountRequest$Outbound; -} - -/** @internal */ -declare const GetUserCountRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetUserCountRequest$Outbound = { - datasource: string; -}; - -/** @internal */ -declare const GetUserCountRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /getusercount API call - */ -declare type GetUserCountRequest = { - /** - * Datasource name for which user count is needed. - */ - datasource: string; -}; - -declare function getUserCountRequestFromJSON(jsonString: string): Result; - -declare function getUserCountRequestToJSON(getUserCountRequest: GetUserCountRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GetUserCountResponse$ { - /** @deprecated use `GetUserCountResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GetUserCountResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GetUserCountResponse$Outbound` instead. */ - type Outbound = GetUserCountResponse$Outbound; -} - -/** @internal */ -declare const GetUserCountResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GetUserCountResponse$Outbound = { - userCount?: number | undefined; -}; - -/** @internal */ -declare const GetUserCountResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /getusercount API call - */ -declare type GetUserCountResponse = { - /** - * Number of users corresponding to the specified custom datasource. - */ - userCount?: number | undefined; -}; - -declare function getUserCountResponseFromJSON(jsonString: string): Result; - -declare function getUserCountResponseToJSON(getUserCountResponse: GetUserCountResponse): string; - -export declare class Glean extends ClientSDK { - private _client?; - get client(): Client; - private _indexing?; - get indexing(): Indexing; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GleanAssistInsightsResponse$ { - /** @deprecated use `GleanAssistInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GleanAssistInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GleanAssistInsightsResponse$Outbound` instead. */ - type Outbound = GleanAssistInsightsResponse$Outbound; -} - -/** @internal */ -declare const GleanAssistInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type GleanAssistInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - activityInsights?: Array | undefined; - totalActiveUsers?: number | undefined; - datasourceInstances?: Array | undefined; - departments?: Array | undefined; -}; - -/** @internal */ -declare const GleanAssistInsightsResponse$outboundSchema: z.ZodType; - -declare type GleanAssistInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - /** - * Insights for all active users with respect to set of actions. - */ - activityInsights?: Array | undefined; - /** - * Total number of active users in the requested period. - */ - totalActiveUsers?: number | undefined; - /** - * List of datasource instances for which glean assist is enabled. - */ - datasourceInstances?: Array | undefined; - /** - * List of departments applicable for users tab. - */ - departments?: Array | undefined; -}; - -declare function gleanAssistInsightsResponseFromJSON(jsonString: string): Result; - -declare function gleanAssistInsightsResponseToJSON(gleanAssistInsightsResponse: GleanAssistInsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GleanDataError$ { - /** @deprecated use `GleanDataError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GleanDataError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GleanDataError$Outbound` instead. */ - type Outbound = GleanDataError$Outbound; -} - -/** @internal */ -declare const GleanDataError$inboundSchema: z.ZodType; - -/** @internal */ -declare type GleanDataError$Outbound = { - badGmailToken?: boolean | undefined; - badOutlookToken?: boolean | undefined; - invalidOperators?: Array | undefined; - errorMessages?: Array | undefined; -}; - -/** @internal */ -declare const GleanDataError$outboundSchema: z.ZodType; - -declare type GleanDataError = { - /** - * Indicates the gmail results could not be fetched due to bad token. - */ - badGmailToken?: boolean | undefined; - /** - * Indicates the outlook results could not be fetched due to bad token. - */ - badOutlookToken?: boolean | undefined; - /** - * Indicates results could not be fetched due to invalid operators in the query. - */ - invalidOperators?: Array | undefined; - errorMessages?: Array | undefined; -}; - -declare function gleanDataErrorFromJSON(jsonString: string): Result; - -declare function gleanDataErrorToJSON(gleanDataError: GleanDataError): string; - -declare class Governance extends ClientSDK { - private _data?; - get data(): Data; - private _documents?; - get documents(): GovernanceDocuments; -} - -declare class GovernanceDocuments extends ClientSDK { - private _visibilityoverrides?; - get visibilityoverrides(): Visibilityoverrides; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GrantPermission$ { - /** @deprecated use `GrantPermission$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GrantPermission$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GrantPermission$Outbound` instead. */ - type Outbound = GrantPermission$Outbound; -} - -/** @internal */ -declare const GrantPermission$inboundSchema: z.ZodType; - -/** @internal */ -declare type GrantPermission$Outbound = { - scopeType?: string | undefined; -}; - -/** @internal */ -declare const GrantPermission$outboundSchema: z.ZodType; - -/** - * Describes the grant permission level that a user has for a specific feature - */ -declare type GrantPermission = { - /** - * Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - */ - scopeType?: ScopeType | undefined; -}; - -declare function grantPermissionFromJSON(jsonString: string): Result; - -declare function grantPermissionToJSON(grantPermission: GrantPermission): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GrantType$ { - /** @deprecated use `GrantType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AuthCode: "AUTH_CODE"; - readonly ClientCredentials: "CLIENT_CREDENTIALS"; - }>; - /** @deprecated use `GrantType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AuthCode: "AUTH_CODE"; - readonly ClientCredentials: "CLIENT_CREDENTIALS"; - }>; -} - -/** @internal */ -declare const GrantType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GrantType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of grant type being used. - */ -declare const GrantType: { - readonly AuthCode: "AUTH_CODE"; - readonly ClientCredentials: "CLIENT_CREDENTIALS"; -}; - -/** - * The type of grant type being used. - */ -declare type GrantType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GreenlistUsersRequest$ { - /** @deprecated use `GreenlistUsersRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GreenlistUsersRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GreenlistUsersRequest$Outbound` instead. */ - type Outbound = GreenlistUsersRequest$Outbound; -} - -/** @internal */ -declare const GreenlistUsersRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type GreenlistUsersRequest$Outbound = { - datasource: string; - emails: Array; -}; - -/** @internal */ -declare const GreenlistUsersRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /betausers API call - */ -declare type GreenlistUsersRequest = { - /** - * Datasource which needs to be made visible to users specified in the `emails` field. - */ - datasource: string; - /** - * The emails of the beta users - */ - emails: Array; -}; - -declare function greenlistUsersRequestFromJSON(jsonString: string): Result; - -declare function greenlistUsersRequestToJSON(greenlistUsersRequest: GreenlistUsersRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Group$ { - /** @deprecated use `Group$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Group$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Group$Outbound` instead. */ - type Outbound = Group$Outbound; -} - -/** @internal */ -declare const Group$inboundSchema: z.ZodType; - -/** @internal */ -declare type Group$Outbound = { - type: string; - id: string; - name?: string | undefined; - datasourceInstance?: string | undefined; - provisioningId?: string | undefined; -}; - -/** @internal */ -declare const Group$outboundSchema: z.ZodType; - -declare type Group = { - /** - * The type of user group - */ - type: GroupType; - /** - * A unique identifier for the group. May be the same as name. - */ - id: string; - /** - * Name of the group. - */ - name?: string | undefined; - /** - * Datasource instance if the group belongs to one e.g. external groups. - */ - datasourceInstance?: string | undefined; - /** - * identifier for greenlist provisioning, aka sciokey - */ - provisioningId?: string | undefined; -}; - -declare function groupFromJSON(jsonString: string): Result; - -declare function groupToJSON(group: Group): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GroupType$ { - /** @deprecated use `GroupType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Department: "DEPARTMENT"; - readonly All: "ALL"; - readonly Team: "TEAM"; - readonly JobTitle: "JOB_TITLE"; - readonly RoleType: "ROLE_TYPE"; - readonly Location: "LOCATION"; - readonly Region: "REGION"; - readonly ExternalGroup: "EXTERNAL_GROUP"; - }>; - /** @deprecated use `GroupType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Department: "DEPARTMENT"; - readonly All: "ALL"; - readonly Team: "TEAM"; - readonly JobTitle: "JOB_TITLE"; - readonly RoleType: "ROLE_TYPE"; - readonly Location: "LOCATION"; - readonly Region: "REGION"; - readonly ExternalGroup: "EXTERNAL_GROUP"; - }>; -} - -/** @internal */ -declare const GroupType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GroupType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of user group - */ -declare const GroupType: { - readonly Department: "DEPARTMENT"; - readonly All: "ALL"; - readonly Team: "TEAM"; - readonly JobTitle: "JOB_TITLE"; - readonly RoleType: "ROLE_TYPE"; - readonly Location: "LOCATION"; - readonly Region: "REGION"; - readonly ExternalGroup: "EXTERNAL_GROUP"; -}; - -/** - * The type of user group - */ -declare type GroupType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace HideBuiltInFacet$ { - /** @deprecated use `HideBuiltInFacet$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Type: "TYPE"; - readonly Tag: "TAG"; - readonly Author: "AUTHOR"; - readonly Owner: "OWNER"; - }>; - /** @deprecated use `HideBuiltInFacet$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Type: "TYPE"; - readonly Tag: "TAG"; - readonly Author: "AUTHOR"; - readonly Owner: "OWNER"; - }>; -} - -/** @internal */ -declare const HideBuiltInFacet$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const HideBuiltInFacet$outboundSchema: z.ZodNativeEnum; - -declare const HideBuiltInFacet: { - readonly Type: "TYPE"; - readonly Tag: "TAG"; - readonly Author: "AUTHOR"; - readonly Owner: "OWNER"; -}; - -declare type HideBuiltInFacet = ClosedEnum; - -declare type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes: string[] | null; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; - options: SDKOptions; -}; - -declare interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Hotword$ { - /** @deprecated use `Hotword$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Hotword$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Hotword$Outbound` instead. */ - type Outbound = Hotword$Outbound; -} - -/** @internal */ -declare const Hotword$inboundSchema: z.ZodType; - -/** @internal */ -declare type Hotword$Outbound = { - regex?: string | undefined; - proximity?: HotwordProximity$Outbound | undefined; -}; - -/** @internal */ -declare const Hotword$outboundSchema: z.ZodType; - -declare type Hotword = { - regex?: string | undefined; - proximity?: HotwordProximity | undefined; -}; - -declare function hotwordFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace HotwordProximity$ { - /** @deprecated use `HotwordProximity$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `HotwordProximity$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `HotwordProximity$Outbound` instead. */ - type Outbound = HotwordProximity$Outbound; -} - -/** @internal */ -declare const HotwordProximity$inboundSchema: z.ZodType; - -/** @internal */ -declare type HotwordProximity$Outbound = { - windowBefore?: number | undefined; - windowAfter?: number | undefined; -}; - -/** @internal */ -declare const HotwordProximity$outboundSchema: z.ZodType; - -declare type HotwordProximity = { - windowBefore?: number | undefined; - windowAfter?: number | undefined; -}; - -declare function hotwordProximityFromJSON(jsonString: string): Result; - -declare function hotwordProximityToJSON(hotwordProximity: HotwordProximity): string; - -declare function hotwordToJSON(hotword: Hotword): string; - -export declare class HTTPClient { - private options; - private fetcher; - private requestHooks; - private requestErrorHooks; - private responseHooks; - constructor(options?: HTTPClientOptions); - request(request: Request): Promise; - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - clone(): HTTPClient; -} - -/** - * Base class for all HTTP errors. - */ -declare class HTTPClientError extends Error { - /** The underlying cause of the error. */ - readonly cause: unknown; - name: string; - constructor(message: string, opts?: { - cause?: unknown; - }); -} - -export declare interface HTTPClientOptions { - fetcher?: Fetcher; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IconConfig$ { - /** @deprecated use `IconConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IconConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IconConfig$Outbound` instead. */ - type Outbound = IconConfig$Outbound; -} - -/** @internal */ -declare const IconConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type IconConfig$Outbound = { - generatedBackgroundColorKey?: string | undefined; - backgroundColor?: string | undefined; - color?: string | undefined; - key?: string | undefined; - iconType?: string | undefined; - masked?: boolean | undefined; - name?: string | undefined; - url?: string | undefined; -}; - -/** @internal */ -declare const IconConfig$outboundSchema: z.ZodType; - -/** - * Defines how to render an icon - */ -declare type IconConfig = { - generatedBackgroundColorKey?: string | undefined; - backgroundColor?: string | undefined; - color?: string | undefined; - key?: string | undefined; - iconType?: IconType | undefined; - /** - * Whether the icon should be masked based on current theme. - */ - masked?: boolean | undefined; - /** - * The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - */ - name?: string | undefined; - /** - * The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - */ - url?: string | undefined; -}; - -declare function iconConfigFromJSON(jsonString: string): Result; - -declare function iconConfigToJSON(iconConfig: IconConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IconType$ { - /** @deprecated use `IconType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Collection: "COLLECTION"; - readonly Custom: "CUSTOM"; - readonly Datasource: "DATASOURCE"; - readonly DatasourceInstance: "DATASOURCE_INSTANCE"; - readonly Favicon: "FAVICON"; - readonly FileType: "FILE_TYPE"; - readonly GeneratedBackground: "GENERATED_BACKGROUND"; - readonly Glyph: "GLYPH"; - readonly MimeType: "MIME_TYPE"; - readonly NoIcon: "NO_ICON"; - readonly Person: "PERSON"; - readonly Reactions: "REACTIONS"; - readonly Url: "URL"; - }>; - /** @deprecated use `IconType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Collection: "COLLECTION"; - readonly Custom: "CUSTOM"; - readonly Datasource: "DATASOURCE"; - readonly DatasourceInstance: "DATASOURCE_INSTANCE"; - readonly Favicon: "FAVICON"; - readonly FileType: "FILE_TYPE"; - readonly GeneratedBackground: "GENERATED_BACKGROUND"; - readonly Glyph: "GLYPH"; - readonly MimeType: "MIME_TYPE"; - readonly NoIcon: "NO_ICON"; - readonly Person: "PERSON"; - readonly Reactions: "REACTIONS"; - readonly Url: "URL"; - }>; -} - -/** @internal */ -declare const IconType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const IconType$outboundSchema: z.ZodNativeEnum; - -declare const IconType: { - readonly Collection: "COLLECTION"; - readonly Custom: "CUSTOM"; - readonly Datasource: "DATASOURCE"; - readonly DatasourceInstance: "DATASOURCE_INSTANCE"; - readonly Favicon: "FAVICON"; - readonly FileType: "FILE_TYPE"; - readonly GeneratedBackground: "GENERATED_BACKGROUND"; - readonly Glyph: "GLYPH"; - readonly MimeType: "MIME_TYPE"; - readonly NoIcon: "NO_ICON"; - readonly Person: "PERSON"; - readonly Reactions: "REACTIONS"; - readonly Url: "URL"; -}; - -declare type IconType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Identity$ { - /** @deprecated use `Identity$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Identity$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Identity$Outbound` instead. */ - type Outbound = Identity$Outbound; -} - -/** @internal */ -declare const Identity$inboundSchema: z.ZodType; - -/** @internal */ -declare type Identity$Outbound = { - processingHistory?: Array | undefined; - users?: DebugDatasourceStatusIdentityResponseComponent$Outbound | undefined; - groups?: DebugDatasourceStatusIdentityResponseComponent$Outbound | undefined; - memberships?: DebugDatasourceStatusIdentityResponseComponent$Outbound | undefined; -}; - -/** @internal */ -declare const Identity$outboundSchema: z.ZodType; - -declare type Identity = { - /** - * Information about processing history for the datasource - */ - processingHistory?: Array | undefined; - users?: DebugDatasourceStatusIdentityResponseComponent | undefined; - groups?: DebugDatasourceStatusIdentityResponseComponent | undefined; - memberships?: DebugDatasourceStatusIdentityResponseComponent | undefined; -}; - -declare function identityFromJSON(jsonString: string): Result; - -declare function identityToJSON(identity: Identity): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IdType$ { - /** @deprecated use `IdType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ChannelName: "CHANNEL_NAME"; - readonly ThreadId: "THREAD_ID"; - readonly ConversationId: "CONVERSATION_ID"; - }>; - /** @deprecated use `IdType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ChannelName: "CHANNEL_NAME"; - readonly ThreadId: "THREAD_ID"; - readonly ConversationId: "CONVERSATION_ID"; - }>; -} - -/** @internal */ -declare const IdType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const IdType$outboundSchema: z.ZodNativeEnum; - -/** - * Type of the id in the incoming request. - */ -declare const IdType: { - readonly ChannelName: "CHANNEL_NAME"; - readonly ThreadId: "THREAD_ID"; - readonly ConversationId: "CONVERSATION_ID"; -}; - -/** - * Type of the id in the incoming request. - */ -declare type IdType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IncludeType$ { - /** @deprecated use `IncludeType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; - readonly InvalidEntities: "INVALID_ENTITIES"; - }>; - /** @deprecated use `IncludeType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; - readonly InvalidEntities: "INVALID_ENTITIES"; - }>; -} - -/** @internal */ -declare const IncludeType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const IncludeType$outboundSchema: z.ZodNativeEnum; - -declare const IncludeType: { - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; - readonly InvalidEntities: "INVALID_ENTITIES"; -}; - -declare type IncludeType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexDocumentRequest$ { - /** @deprecated use `IndexDocumentRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexDocumentRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexDocumentRequest$Outbound` instead. */ - type Outbound = IndexDocumentRequest$Outbound; -} - -/** @internal */ -declare const IndexDocumentRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexDocumentRequest$Outbound = { - version?: number | undefined; - document: DocumentDefinition$Outbound; -}; - -/** @internal */ -declare const IndexDocumentRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /indexdocument API call - */ -declare type IndexDocumentRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * Indexable document structure - */ - document: DocumentDefinition; -}; - -declare function indexDocumentRequestFromJSON(jsonString: string): Result; - -declare function indexDocumentRequestToJSON(indexDocumentRequest: IndexDocumentRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexDocumentsRequest$ { - /** @deprecated use `IndexDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexDocumentsRequest$Outbound` instead. */ - type Outbound = IndexDocumentsRequest$Outbound; -} - -/** @internal */ -declare const IndexDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexDocumentsRequest$Outbound = { - uploadId?: string | undefined; - datasource: string; - documents: Array; -}; - -/** @internal */ -declare const IndexDocumentsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /indexdocuments API call - */ -declare type IndexDocumentsRequest = { - /** - * Optional id parameter to identify and track a batch of documents. - */ - uploadId?: string | undefined; - /** - * Datasource of the documents - */ - datasource: string; - /** - * Batch of documents being added/updated - */ - documents: Array; -}; - -declare function indexDocumentsRequestFromJSON(jsonString: string): Result; - -declare function indexDocumentsRequestToJSON(indexDocumentsRequest: IndexDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexEmployeeRequest$ { - /** @deprecated use `IndexEmployeeRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexEmployeeRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexEmployeeRequest$Outbound` instead. */ - type Outbound = IndexEmployeeRequest$Outbound; -} - -/** @internal */ -declare const IndexEmployeeRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexEmployeeRequest$Outbound = { - employee: EmployeeInfoDefinition$Outbound; - version?: number | undefined; -}; - -/** @internal */ -declare const IndexEmployeeRequest$outboundSchema: z.ZodType; - -/** - * Info about an employee and optional version for that info - */ -declare type IndexEmployeeRequest = { - /** - * Describes employee info - */ - employee: EmployeeInfoDefinition; - /** - * Version number for the employee object. If absent or 0 then no version checks are done - */ - version?: number | undefined; -}; - -declare function indexEmployeeRequestFromJSON(jsonString: string): Result; - -declare function indexEmployeeRequestToJSON(indexEmployeeRequest: IndexEmployeeRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexGroupRequest$ { - /** @deprecated use `IndexGroupRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexGroupRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexGroupRequest$Outbound` instead. */ - type Outbound = IndexGroupRequest$Outbound; -} - -/** @internal */ -declare const IndexGroupRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexGroupRequest$Outbound = { - version?: number | undefined; - datasource: string; - group: DatasourceGroupDefinition$Outbound; -}; - -/** @internal */ -declare const IndexGroupRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /indexgroup API call - */ -declare type IndexGroupRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the group is added - */ - datasource: string; - /** - * describes a group in the datasource - */ - group: DatasourceGroupDefinition; -}; - -declare function indexGroupRequestFromJSON(jsonString: string): Result; - -declare function indexGroupRequestToJSON(indexGroupRequest: IndexGroupRequest): string; - -declare class Indexing extends ClientSDK { - private _documents?; - get documents(): IndexingDocuments; - private _permissions?; - get permissions(): Permissions_3; - private _datasource?; - get datasource(): Datasource_2; - private _people?; - get people(): People; - private _datasources?; - get datasources(): Datasources; - private _authentication?; - get authentication(): IndexingAuthentication; - private _shortcuts?; - get shortcuts(): IndexingShortcuts; -} - -declare class IndexingAuthentication extends ClientSDK { - /** - * Rotate token - * - * @remarks - * Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. - */ - rotateToken(options?: RequestOptions): Promise; -} - -declare class IndexingDocuments extends ClientSDK { - /** - * Index document - * - * @remarks - * Adds a document to the index or updates an existing document. - */ - addOrUpdate(request: components.IndexDocumentRequest, options?: RequestOptions): Promise; - /** - * Index documents - * - * @remarks - * Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. - */ - index(request: components.IndexDocumentsRequest, options?: RequestOptions): Promise; - /** - * Bulk index documents - * - * @remarks - * Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndex(request: components.BulkIndexDocumentsRequest, options?: RequestOptions): Promise; - /** - * Schedules the processing of uploaded documents - * - * @remarks - * Schedules the immediate processing of documents uploaded through the indexing API. By default the uploaded documents will be processed asynchronously but this API can be used to schedule processing of all documents on demand. - * - * If a `datasource` parameter is specified, processing is limited to that custom datasource. Without it, processing applies to all documents across all custom datasources. - * #### Rate Limits - * This endpoint is rate-limited to one usage every 3 hours. Exceeding this limit results in a 429 response code. Here's how the rate limit works: - * 1. Calling `/processalldocuments` for datasource `foo` prevents another call for `foo` for 3 hours. - * 2. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for `bar`. - * 3. Calling `/processalldocuments` for all datasources prevents any datasource calls for 3 hours. - * 4. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for all datasources. - * - * For more frequent document processing, contact Glean support. - */ - processAll(request?: components.ProcessAllDocumentsRequest | undefined, options?: RequestOptions): Promise; - /** - * Delete document - * - * @remarks - * Deletes the specified document from the index. Succeeds if document is not present. - */ - delete(request: components.DeleteDocumentRequest, options?: RequestOptions): Promise; - /** - * Beta: Get document information - * - * @remarks - * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - debug(debugDocumentRequest: components.DebugDocumentRequest, datasource: string, options?: RequestOptions): Promise; - /** - * Beta: Get information of a batch of documents - * - * @remarks - * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - debugMany(debugDocumentsRequest: components.DebugDocumentsRequest, datasource: string, options?: RequestOptions): Promise; - /** - * Check document access - * - * @remarks - * Check if a given user has access to access a document in a custom datasource - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - checkAccess(request: components.CheckDocumentAccessRequest, options?: RequestOptions): Promise; - /** - * Get document upload and indexing status - * - * @remarks - * Intended for debugging/validation. Fetches the current upload and indexing status of documents. - * - * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - status(request: components.GetDocumentStatusRequest, options?: RequestOptions): Promise; - /** - * Get document count - * - * @remarks - * Fetches document count for the specified custom datasource. - * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - count(request: components.GetDocumentCountRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexingShortcut$ { - /** @deprecated use `IndexingShortcut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexingShortcut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexingShortcut$Outbound` instead. */ - type Outbound = IndexingShortcut$Outbound; -} - -/** @internal */ -declare const IndexingShortcut$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexingShortcut$Outbound = { - inputAlias: string; - description?: string | undefined; - destinationUrl: string; - createdBy: string; - createTime?: number | undefined; - updatedBy?: string | undefined; - updateTime?: number | undefined; - unlisted?: boolean | undefined; - urlTemplate?: string | undefined; -}; - -/** @internal */ -declare const IndexingShortcut$outboundSchema: z.ZodType; - -declare type IndexingShortcut = { - /** - * link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias. - */ - inputAlias: string; - /** - * A short, plain text blurb to help people understand the intent of the shortcut. - */ - description?: string | undefined; - /** - * destination URL for the shortcut. - */ - destinationUrl: string; - /** - * Email of the user who created this shortcut. - */ - createdBy: string; - /** - * The time the shortcut was created in epoch seconds. - */ - createTime?: number | undefined; - /** - * Email of the user who last updated this shortcut. - */ - updatedBy?: string | undefined; - /** - * The time the shortcut was updated in epoch seconds. - */ - updateTime?: number | undefined; - /** - * Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author and admins only. - */ - unlisted?: boolean | undefined; - /** - * For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - */ - urlTemplate?: string | undefined; -}; - -declare function indexingShortcutFromJSON(jsonString: string): Result; - -declare class IndexingShortcuts extends ClientSDK { - /** - * Bulk index external shortcuts - * - * @remarks - * Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the `/uploadshortcuts` endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to [this](https://help.glean.com/en/articles/5628838-how-go-links-work) page. - */ - bulkIndex(request: components.BulkIndexShortcutsRequest, options?: RequestOptions): Promise; - /** - * Upload shortcuts - * - * @remarks - * Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded. - */ - upload(request: components.UploadShortcutsRequest, options?: RequestOptions): Promise; -} - -declare function indexingShortcutToJSON(indexingShortcut: IndexingShortcut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexMembershipRequest$ { - /** @deprecated use `IndexMembershipRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexMembershipRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexMembershipRequest$Outbound` instead. */ - type Outbound = IndexMembershipRequest$Outbound; -} - -/** @internal */ -declare const IndexMembershipRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexMembershipRequest$Outbound = { - version?: number | undefined; - datasource: string; - membership: DatasourceMembershipDefinition$Outbound; -}; - -/** @internal */ -declare const IndexMembershipRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /indexmembership API call - */ -declare type IndexMembershipRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the membership is added - */ - datasource: string; - /** - * describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - */ - membership: DatasourceMembershipDefinition; -}; - -declare function indexMembershipRequestFromJSON(jsonString: string): Result; - -declare function indexMembershipRequestToJSON(indexMembershipRequest: IndexMembershipRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexStatus$ { - /** @deprecated use `IndexStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexStatus$Outbound` instead. */ - type Outbound = IndexStatus$Outbound; -} - -/** @internal */ -declare const IndexStatus$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexStatus$Outbound = { - lastCrawledTime?: string | undefined; - lastIndexedTime?: string | undefined; -}; - -/** @internal */ -declare const IndexStatus$outboundSchema: z.ZodType; - -declare type IndexStatus = { - /** - * When the document was last crawled - */ - lastCrawledTime?: Date | undefined; - /** - * When the document was last indexed - */ - lastIndexedTime?: Date | undefined; -}; - -declare function indexStatusFromJSON(jsonString: string): Result; - -declare function indexStatusToJSON(indexStatus: IndexStatus): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexTeamRequest$ { - /** @deprecated use `IndexTeamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexTeamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexTeamRequest$Outbound` instead. */ - type Outbound = IndexTeamRequest$Outbound; -} - -/** @internal */ -declare const IndexTeamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexTeamRequest$Outbound = { - team: TeamInfoDefinition$Outbound; - version?: number | undefined; -}; - -/** @internal */ -declare const IndexTeamRequest$outboundSchema: z.ZodType; - -/** - * Info about a team and optional version for that info - */ -declare type IndexTeamRequest = { - /** - * Information about an employee's team - */ - team: TeamInfoDefinition; - /** - * Version number for the team object. If absent or 0 then no version checks are done - */ - version?: number | undefined; -}; - -declare function indexTeamRequestFromJSON(jsonString: string): Result; - -declare function indexTeamRequestToJSON(indexTeamRequest: IndexTeamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace IndexUserRequest$ { - /** @deprecated use `IndexUserRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `IndexUserRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `IndexUserRequest$Outbound` instead. */ - type Outbound = IndexUserRequest$Outbound; -} - -/** @internal */ -declare const IndexUserRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type IndexUserRequest$Outbound = { - version?: number | undefined; - datasource: string; - user: DatasourceUserDefinition$Outbound; -}; - -/** @internal */ -declare const IndexUserRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /indexuser API call - */ -declare type IndexUserRequest = { - /** - * Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - */ - version?: number | undefined; - /** - * The datasource for which the user is added - */ - datasource: string; - /** - * describes a user in the datasource - */ - user: DatasourceUserDefinition; -}; - -declare function indexUserRequestFromJSON(jsonString: string): Result; - -declare function indexUserRequestToJSON(indexUserRequest: IndexUserRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InputOptions$ { - /** @deprecated use `InputOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InputOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InputOptions$Outbound` instead. */ - type Outbound = InputOptions$Outbound; -} - -/** @internal */ -declare const InputOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type InputOptions$Outbound = { - urlGreenlist?: Array | undefined; - datasourcesType?: string | undefined; - datasources?: Array | undefined; - datasourceInstances?: Array | undefined; - timePeriodType?: string | undefined; - customTimeRange?: TimeRange$Outbound | undefined; -}; - -/** @internal */ -declare const InputOptions$outboundSchema: z.ZodType; - -/** - * Controls which data-sources and what time-range to include in scans. - */ -declare type InputOptions = { - /** - * list of url regex matching documents excluded from report - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - urlGreenlist?: Array | undefined; - /** - * The types of datasource for which to run the report/policy. - */ - datasourcesType?: DatasourcesType | undefined; - /** - * List of datasources to consider for report. DEPRECATED - use datasourceInstances instead. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - datasources?: Array | undefined; - /** - * List of datasource instances to consider for report/policy. - */ - datasourceInstances?: Array | undefined; - /** - * Type of time period for which to run the report/policy. PAST_DAY is deprecated. - */ - timePeriodType?: TimePeriodType | undefined; - customTimeRange?: TimeRange | undefined; -}; - -declare function inputOptionsFromJSON(jsonString: string): Result; - -declare function inputOptionsToJSON(inputOptions: InputOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InputSchema$ { - /** @deprecated use `InputSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InputSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InputSchema$Outbound` instead. */ - type Outbound = InputSchema$Outbound; -} - -/** @internal */ -declare const InputSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type InputSchema$Outbound = {}; - -/** @internal */ -declare const InputSchema$outboundSchema: z.ZodType; - -/** - * The schema for the agent input. In JSON Schema format. - */ -declare type InputSchema = {}; - -declare function inputSchemaFromJSON(jsonString: string): Result; - -declare function inputSchemaToJSON(inputSchema: InputSchema): string; - -declare class Insights extends ClientSDK { - /** - * Get insights - * - * @remarks - * Gets the aggregate usage insights data displayed in the Insights Dashboards. - */ - retrieve(request: components.InsightsRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsAgentsRequestOptions$ { - /** @deprecated use `InsightsAgentsRequestOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsAgentsRequestOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsAgentsRequestOptions$Outbound` instead. */ - type Outbound = InsightsAgentsRequestOptions$Outbound; -} - -/** @internal */ -declare const InsightsAgentsRequestOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsAgentsRequestOptions$Outbound = { - agentIds?: Array | undefined; -}; - -/** @internal */ -declare const InsightsAgentsRequestOptions$outboundSchema: z.ZodType; - -declare type InsightsAgentsRequestOptions = { - /** - * IDs of the Agents for which Insights should be returned. An empty array signifies all. - */ - agentIds?: Array | undefined; -}; - -declare function insightsAgentsRequestOptionsFromJSON(jsonString: string): Result; - -declare function insightsAgentsRequestOptionsToJSON(insightsAgentsRequestOptions: InsightsAgentsRequestOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsAiAppRequestOptions$ { - /** @deprecated use `InsightsAiAppRequestOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsAiAppRequestOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsAiAppRequestOptions$Outbound` instead. */ - type Outbound = InsightsAiAppRequestOptions$Outbound; -} - -/** @internal */ -declare const InsightsAiAppRequestOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsAiAppRequestOptions$Outbound = { - aiAppIds?: Array | undefined; -}; - -/** @internal */ -declare const InsightsAiAppRequestOptions$outboundSchema: z.ZodType; - -declare type InsightsAiAppRequestOptions = { - /** - * IDs of the AI Apps for which Insights should be returned. An empty array signifies all. - */ - aiAppIds?: Array | undefined; -}; - -declare function insightsAiAppRequestOptionsFromJSON(jsonString: string): Result; - -declare function insightsAiAppRequestOptionsToJSON(insightsAiAppRequestOptions: InsightsAiAppRequestOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsAssistantRequest$ { - /** @deprecated use `InsightsAssistantRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsAssistantRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsAssistantRequest$Outbound` instead. */ - type Outbound = InsightsAssistantRequest$Outbound; -} - -/** @internal */ -declare const InsightsAssistantRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsAssistantRequest$Outbound = { - departments?: Array | undefined; - dayRange?: Period$Outbound | undefined; -}; - -/** @internal */ -declare const InsightsAssistantRequest$outboundSchema: z.ZodType; - -declare type InsightsAssistantRequest = { - /** - * Departments for which Insights are requested. - */ - departments?: Array | undefined; - dayRange?: Period | undefined; -}; - -declare function insightsAssistantRequestFromJSON(jsonString: string): Result; - -declare function insightsAssistantRequestToJSON(insightsAssistantRequest: InsightsAssistantRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsOverviewRequest$ { - /** @deprecated use `InsightsOverviewRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsOverviewRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsOverviewRequest$Outbound` instead. */ - type Outbound = InsightsOverviewRequest$Outbound; -} - -/** @internal */ -declare const InsightsOverviewRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsOverviewRequest$Outbound = { - departments?: Array | undefined; - dayRange?: Period$Outbound | undefined; -}; - -/** @internal */ -declare const InsightsOverviewRequest$outboundSchema: z.ZodType; - -declare type InsightsOverviewRequest = { - /** - * Departments for which Insights are requested. - */ - departments?: Array | undefined; - dayRange?: Period | undefined; -}; - -declare function insightsOverviewRequestFromJSON(jsonString: string): Result; - -declare function insightsOverviewRequestToJSON(insightsOverviewRequest: InsightsOverviewRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsRequest$ { - /** @deprecated use `InsightsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsRequest$Outbound` instead. */ - type Outbound = InsightsRequest$Outbound; -} - -/** @internal */ -declare const InsightsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsRequest$Outbound = { - overviewRequest?: InsightsOverviewRequest$Outbound | undefined; - assistantRequest?: InsightsAssistantRequest$Outbound | undefined; - agentsRequest?: AgentsInsightsV2Request$Outbound | undefined; - disablePerUserInsights?: boolean | undefined; - categories?: Array | undefined; - departments?: Array | undefined; - dayRange?: Period$Outbound | undefined; - aiAppRequestOptions?: InsightsAiAppRequestOptions$Outbound | undefined; - agentsRequestOptions?: InsightsAgentsRequestOptions$Outbound | undefined; - assistantActivityTypes?: Array | undefined; -}; - -/** @internal */ -declare const InsightsRequest$outboundSchema: z.ZodType; - -declare type InsightsRequest = { - overviewRequest?: InsightsOverviewRequest | undefined; - assistantRequest?: InsightsAssistantRequest | undefined; - agentsRequest?: AgentsInsightsV2Request | undefined; - /** - * If true, suppresses the generation of per-user Insights in the response. Default is false. - */ - disablePerUserInsights?: boolean | undefined; - /** - * Categories of data requested. Request can include single or multiple types. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - categories?: Array | undefined; - /** - * Departments that the data is requested for. If this is empty, corresponds to whole company. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - departments?: Array | undefined; - dayRange?: Period | undefined; - aiAppRequestOptions?: InsightsAiAppRequestOptions | undefined; - agentsRequestOptions?: InsightsAgentsRequestOptions | undefined; - /** - * Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - assistantActivityTypes?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsRequestCategory$ { - /** @deprecated use `InsightsRequestCategory$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Agents: "AGENTS"; - readonly AgentUsers: "AGENT_USERS"; - readonly TopAgents: "TOP_AGENTS"; - readonly AgentsUsageByDepartment: "AGENTS_USAGE_BY_DEPARTMENT"; - readonly Ai: "AI"; - readonly AiApps: "AI_APPS"; - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Content: "CONTENT"; - readonly GleanAssist: "GLEAN_ASSIST"; - readonly Queries: "QUERIES"; - readonly Shortcuts: "SHORTCUTS"; - readonly Users: "USERS"; - }>; - /** @deprecated use `InsightsRequestCategory$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Agents: "AGENTS"; - readonly AgentUsers: "AGENT_USERS"; - readonly TopAgents: "TOP_AGENTS"; - readonly AgentsUsageByDepartment: "AGENTS_USAGE_BY_DEPARTMENT"; - readonly Ai: "AI"; - readonly AiApps: "AI_APPS"; - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Content: "CONTENT"; - readonly GleanAssist: "GLEAN_ASSIST"; - readonly Queries: "QUERIES"; - readonly Shortcuts: "SHORTCUTS"; - readonly Users: "USERS"; - }>; -} - -/** @internal */ -declare const InsightsRequestCategory$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const InsightsRequestCategory$outboundSchema: z.ZodNativeEnum; - -declare const InsightsRequestCategory: { - readonly Agents: "AGENTS"; - readonly AgentUsers: "AGENT_USERS"; - readonly TopAgents: "TOP_AGENTS"; - readonly AgentsUsageByDepartment: "AGENTS_USAGE_BY_DEPARTMENT"; - readonly Ai: "AI"; - readonly AiApps: "AI_APPS"; - readonly Announcements: "ANNOUNCEMENTS"; - readonly Answers: "ANSWERS"; - readonly Collections: "COLLECTIONS"; - readonly Content: "CONTENT"; - readonly GleanAssist: "GLEAN_ASSIST"; - readonly Queries: "QUERIES"; - readonly Shortcuts: "SHORTCUTS"; - readonly Users: "USERS"; -}; - -declare type InsightsRequestCategory = ClosedEnum; - -declare function insightsRequestFromJSON(jsonString: string): Result; - -declare function insightsRequestToJSON(insightsRequest: InsightsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InsightsResponse$ { - /** @deprecated use `InsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InsightsResponse$Outbound` instead. */ - type Outbound = InsightsResponse$Outbound; -} - -/** @internal */ -declare const InsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type InsightsResponse$Outbound = { - timeseries?: Array | undefined; - users?: UserInsightsResponse$Outbound | undefined; - content?: ContentInsightsResponse$Outbound | undefined; - queries?: QueryInsightsResponse$Outbound | undefined; - collections?: ContentInsightsResponse$Outbound | undefined; - collectionsV2?: ContentInsightsResponse$Outbound | undefined; - shortcuts?: ShortcutInsightsResponse$Outbound | undefined; - announcements?: ContentInsightsResponse$Outbound | undefined; - answers?: ContentInsightsResponse$Outbound | undefined; - ai?: AiInsightsResponse$Outbound | undefined; - aiApps?: AiAppsInsightsResponse$Outbound | undefined; - gleanAssist?: GleanAssistInsightsResponse$Outbound | undefined; - departments?: Array | undefined; -}; - -/** @internal */ -declare const InsightsResponse$outboundSchema: z.ZodType; - -declare type InsightsResponse = { - /** - * List of timeseries to make charts (if applicable). - */ - timeseries?: Array | undefined; - users?: UserInsightsResponse | undefined; - content?: ContentInsightsResponse | undefined; - queries?: QueryInsightsResponse | undefined; - collections?: ContentInsightsResponse | undefined; - collectionsV2?: ContentInsightsResponse | undefined; - shortcuts?: ShortcutInsightsResponse | undefined; - announcements?: ContentInsightsResponse | undefined; - answers?: ContentInsightsResponse | undefined; - ai?: AiInsightsResponse | undefined; - aiApps?: AiAppsInsightsResponse | undefined; - gleanAssist?: GleanAssistInsightsResponse | undefined; - /** - * list of all departments. - */ - departments?: Array | undefined; -}; - -declare function insightsResponseFromJSON(jsonString: string): Result; - -declare function insightsResponseToJSON(insightsResponse: InsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InvalidOperatorValueError$ { - /** @deprecated use `InvalidOperatorValueError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InvalidOperatorValueError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InvalidOperatorValueError$Outbound` instead. */ - type Outbound = InvalidOperatorValueError$Outbound; -} - -/** @internal */ -declare const InvalidOperatorValueError$inboundSchema: z.ZodType; - -/** @internal */ -declare type InvalidOperatorValueError$Outbound = { - key?: string | undefined; - value?: string | undefined; -}; - -/** @internal */ -declare const InvalidOperatorValueError$outboundSchema: z.ZodType; - -declare type InvalidOperatorValueError = { - /** - * The operator key that has an invalid value. - */ - key?: string | undefined; - /** - * The invalid operator value. - */ - value?: string | undefined; -}; - -declare function invalidOperatorValueErrorFromJSON(jsonString: string): Result; - -declare function invalidOperatorValueErrorToJSON(invalidOperatorValueError: InvalidOperatorValueError): string; - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -declare class InvalidRequestError extends HTTPClientError { - name: string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InviteInfo$ { - /** @deprecated use `InviteInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InviteInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InviteInfo$Outbound` instead. */ - type Outbound = InviteInfo$Outbound; -} - -/** @internal */ -declare const InviteInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type InviteInfo$Outbound = { - signUpTime?: string | undefined; - invites?: Array | undefined; - inviter?: Person$Outbound | undefined; - inviteTime?: string | undefined; - reminderTime?: string | undefined; -}; - -/** @internal */ -declare const InviteInfo$outboundSchema: z.ZodType; - -/** - * Information regarding the invite status of a person. - */ -declare type InviteInfo = { - /** - * The time this person signed up in ISO format (ISO 8601). - */ - signUpTime?: Date | undefined; - /** - * Latest invites received by the user for each channel - */ - invites?: Array | undefined; - inviter?: Person | undefined; - /** - * The time this person was invited in ISO format (ISO 8601). - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - inviteTime?: Date | undefined; - /** - * The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - reminderTime?: Date | undefined; -}; - -declare function inviteInfoFromJSON(jsonString: string): Result; - -declare function inviteInfoToJSON(inviteInfo: InviteInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Issue$ { - /** @deprecated use `Issue$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly InaccurateResponse: "INACCURATE_RESPONSE"; - readonly IncompleteOrNoAnswer: "INCOMPLETE_OR_NO_ANSWER"; - readonly IncorrectCitation: "INCORRECT_CITATION"; - readonly MissingCitation: "MISSING_CITATION"; - readonly Other: "OTHER"; - readonly OutdatedResponse: "OUTDATED_RESPONSE"; - readonly ResultMissing: "RESULT_MISSING"; - readonly ResultShouldNotAppear: "RESULT_SHOULD_NOT_APPEAR"; - readonly ResultsHelpful: "RESULTS_HELPFUL"; - readonly ResultsPoorOrder: "RESULTS_POOR_ORDER"; - readonly TooMuchOneKind: "TOO_MUCH_ONE_KIND"; - }>; - /** @deprecated use `Issue$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly InaccurateResponse: "INACCURATE_RESPONSE"; - readonly IncompleteOrNoAnswer: "INCOMPLETE_OR_NO_ANSWER"; - readonly IncorrectCitation: "INCORRECT_CITATION"; - readonly MissingCitation: "MISSING_CITATION"; - readonly Other: "OTHER"; - readonly OutdatedResponse: "OUTDATED_RESPONSE"; - readonly ResultMissing: "RESULT_MISSING"; - readonly ResultShouldNotAppear: "RESULT_SHOULD_NOT_APPEAR"; - readonly ResultsHelpful: "RESULTS_HELPFUL"; - readonly ResultsPoorOrder: "RESULTS_POOR_ORDER"; - readonly TooMuchOneKind: "TOO_MUCH_ONE_KIND"; - }>; -} - -/** @internal */ -declare const Issue$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Issue$outboundSchema: z.ZodNativeEnum; - -declare const Issue: { - readonly InaccurateResponse: "INACCURATE_RESPONSE"; - readonly IncompleteOrNoAnswer: "INCOMPLETE_OR_NO_ANSWER"; - readonly IncorrectCitation: "INCORRECT_CITATION"; - readonly MissingCitation: "MISSING_CITATION"; - readonly Other: "OTHER"; - readonly OutdatedResponse: "OUTDATED_RESPONSE"; - readonly ResultMissing: "RESULT_MISSING"; - readonly ResultShouldNotAppear: "RESULT_SHOULD_NOT_APPEAR"; - readonly ResultsHelpful: "RESULTS_HELPFUL"; - readonly ResultsPoorOrder: "RESULTS_POOR_ORDER"; - readonly TooMuchOneKind: "TOO_MUCH_ONE_KIND"; -}; - -declare type Issue = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JustificationType$ { - /** @deprecated use `JustificationType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FrequentlyAccessed: "FREQUENTLY_ACCESSED"; - readonly RecentlyAccessed: "RECENTLY_ACCESSED"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly SuggestedDocument: "SUGGESTED_DOCUMENT"; - readonly EmptyStateSuggestion: "EMPTY_STATE_SUGGESTION"; - readonly FrecencyScored: "FRECENCY_SCORED"; - readonly ServerGenerated: "SERVER_GENERATED"; - readonly UseCase: "USE_CASE"; - readonly UpdateSinceLastView: "UPDATE_SINCE_LAST_VIEW"; - readonly RecentlyStarted: "RECENTLY_STARTED"; - readonly Event: "EVENT"; - readonly UserMention: "USER_MENTION"; - readonly Announcement: "ANNOUNCEMENT"; - readonly ExternalAnnouncement: "EXTERNAL_ANNOUNCEMENT"; - readonly PopularityBasedTrending: "POPULARITY_BASED_TRENDING"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly EventDocumentFromContent: "EVENT_DOCUMENT_FROM_CONTENT"; - readonly EventDocumentFromSearch: "EVENT_DOCUMENT_FROM_SEARCH"; - readonly VisitAffinityScored: "VISIT_AFFINITY_SCORED"; - readonly SuggestedApp: "SUGGESTED_APP"; - readonly SuggestedPerson: "SUGGESTED_PERSON"; - readonly ActivityHighlight: "ACTIVITY_HIGHLIGHT"; - readonly SavedSearch: "SAVED_SEARCH"; - readonly SuggestedChannel: "SUGGESTED_CHANNEL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStatePromptTemplateSuggestion: "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION"; - readonly ZeroStateStaticWorkflowSuggestion: "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION"; - readonly ZeroStateAgentSuggestion: "ZERO_STATE_AGENT_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; - /** @deprecated use `JustificationType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FrequentlyAccessed: "FREQUENTLY_ACCESSED"; - readonly RecentlyAccessed: "RECENTLY_ACCESSED"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly SuggestedDocument: "SUGGESTED_DOCUMENT"; - readonly EmptyStateSuggestion: "EMPTY_STATE_SUGGESTION"; - readonly FrecencyScored: "FRECENCY_SCORED"; - readonly ServerGenerated: "SERVER_GENERATED"; - readonly UseCase: "USE_CASE"; - readonly UpdateSinceLastView: "UPDATE_SINCE_LAST_VIEW"; - readonly RecentlyStarted: "RECENTLY_STARTED"; - readonly Event: "EVENT"; - readonly UserMention: "USER_MENTION"; - readonly Announcement: "ANNOUNCEMENT"; - readonly ExternalAnnouncement: "EXTERNAL_ANNOUNCEMENT"; - readonly PopularityBasedTrending: "POPULARITY_BASED_TRENDING"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly EventDocumentFromContent: "EVENT_DOCUMENT_FROM_CONTENT"; - readonly EventDocumentFromSearch: "EVENT_DOCUMENT_FROM_SEARCH"; - readonly VisitAffinityScored: "VISIT_AFFINITY_SCORED"; - readonly SuggestedApp: "SUGGESTED_APP"; - readonly SuggestedPerson: "SUGGESTED_PERSON"; - readonly ActivityHighlight: "ACTIVITY_HIGHLIGHT"; - readonly SavedSearch: "SAVED_SEARCH"; - readonly SuggestedChannel: "SUGGESTED_CHANNEL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStatePromptTemplateSuggestion: "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION"; - readonly ZeroStateStaticWorkflowSuggestion: "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION"; - readonly ZeroStateAgentSuggestion: "ZERO_STATE_AGENT_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; - }>; -} - -/** @internal */ -declare const JustificationType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JustificationType$outboundSchema: z.ZodNativeEnum; - -/** - * Type of the justification. - */ -declare const JustificationType: { - readonly FrequentlyAccessed: "FREQUENTLY_ACCESSED"; - readonly RecentlyAccessed: "RECENTLY_ACCESSED"; - readonly TrendingDocument: "TRENDING_DOCUMENT"; - readonly VerificationReminder: "VERIFICATION_REMINDER"; - readonly SuggestedDocument: "SUGGESTED_DOCUMENT"; - readonly EmptyStateSuggestion: "EMPTY_STATE_SUGGESTION"; - readonly FrecencyScored: "FRECENCY_SCORED"; - readonly ServerGenerated: "SERVER_GENERATED"; - readonly UseCase: "USE_CASE"; - readonly UpdateSinceLastView: "UPDATE_SINCE_LAST_VIEW"; - readonly RecentlyStarted: "RECENTLY_STARTED"; - readonly Event: "EVENT"; - readonly UserMention: "USER_MENTION"; - readonly Announcement: "ANNOUNCEMENT"; - readonly ExternalAnnouncement: "EXTERNAL_ANNOUNCEMENT"; - readonly PopularityBasedTrending: "POPULARITY_BASED_TRENDING"; - readonly CompanyResource: "COMPANY_RESOURCE"; - readonly EventDocumentFromContent: "EVENT_DOCUMENT_FROM_CONTENT"; - readonly EventDocumentFromSearch: "EVENT_DOCUMENT_FROM_SEARCH"; - readonly VisitAffinityScored: "VISIT_AFFINITY_SCORED"; - readonly SuggestedApp: "SUGGESTED_APP"; - readonly SuggestedPerson: "SUGGESTED_PERSON"; - readonly ActivityHighlight: "ACTIVITY_HIGHLIGHT"; - readonly SavedSearch: "SAVED_SEARCH"; - readonly SuggestedChannel: "SUGGESTED_CHANNEL"; - readonly PeopleCelebrations: "PEOPLE_CELEBRATIONS"; - readonly SocialLink: "SOCIAL_LINK"; - readonly ZeroStateChatSuggestion: "ZERO_STATE_CHAT_SUGGESTION"; - readonly ZeroStateChatToolSuggestion: "ZERO_STATE_CHAT_TOOL_SUGGESTION"; - readonly ZeroStatePromptTemplateSuggestion: "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION"; - readonly ZeroStateStaticWorkflowSuggestion: "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION"; - readonly ZeroStateAgentSuggestion: "ZERO_STATE_AGENT_SUGGESTION"; - readonly PersonalizedChatSuggestion: "PERSONALIZED_CHAT_SUGGESTION"; - readonly DailyDigest: "DAILY_DIGEST"; -}; - -/** - * Type of the justification. - */ -declare type JustificationType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace KnowledgeType$ { - /** @deprecated use `KnowledgeType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NeutralKnowledge: "NEUTRAL_KNOWLEDGE"; - readonly CompanyKnowledge: "COMPANY_KNOWLEDGE"; - readonly WorldKnowledge: "WORLD_KNOWLEDGE"; - }>; - /** @deprecated use `KnowledgeType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NeutralKnowledge: "NEUTRAL_KNOWLEDGE"; - readonly CompanyKnowledge: "COMPANY_KNOWLEDGE"; - readonly WorldKnowledge: "WORLD_KNOWLEDGE"; - }>; -} - -/** @internal */ -declare const KnowledgeType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const KnowledgeType$outboundSchema: z.ZodNativeEnum; - -/** - * Indicates the kind of knowledge a tool would access or modify. - */ -declare const KnowledgeType: { - readonly NeutralKnowledge: "NEUTRAL_KNOWLEDGE"; - readonly CompanyKnowledge: "COMPANY_KNOWLEDGE"; - readonly WorldKnowledge: "WORLD_KNOWLEDGE"; -}; - -/** - * Indicates the kind of knowledge a tool would access or modify. - */ -declare type KnowledgeType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LabeledCountInfo$ { - /** @deprecated use `LabeledCountInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LabeledCountInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LabeledCountInfo$Outbound` instead. */ - type Outbound = LabeledCountInfo$Outbound; -} - -/** @internal */ -declare const LabeledCountInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type LabeledCountInfo$Outbound = { - label: string; - countInfo?: Array | undefined; -}; - -/** @internal */ -declare const LabeledCountInfo$outboundSchema: z.ZodType; - -declare type LabeledCountInfo = { - /** - * Label for the included count information. - */ - label: string; - /** - * List of data points for counts for a given date period. - */ - countInfo?: Array | undefined; -}; - -declare function labeledCountInfoFromJSON(jsonString: string): Result; - -declare function labeledCountInfoToJSON(labeledCountInfo: LabeledCountInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LastScanStatus$ { - /** @deprecated use `LastScanStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; - }>; - /** @deprecated use `LastScanStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; - }>; -} - -/** @internal */ -declare const LastScanStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const LastScanStatus$outboundSchema: z.ZodNativeEnum; - -declare const LastScanStatus: { - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; -}; - -declare type LastScanStatus = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LikelihoodThreshold$ { - /** @deprecated use `LikelihoodThreshold$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Likely: "LIKELY"; - readonly VeryLikely: "VERY_LIKELY"; - }>; - /** @deprecated use `LikelihoodThreshold$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Likely: "LIKELY"; - readonly VeryLikely: "VERY_LIKELY"; - }>; -} - -/** @internal */ -declare const LikelihoodThreshold$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const LikelihoodThreshold$outboundSchema: z.ZodNativeEnum; - -/** - * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. - */ -declare const LikelihoodThreshold: { - readonly Likely: "LIKELY"; - readonly VeryLikely: "VERY_LIKELY"; -}; - -/** - * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. - */ -declare type LikelihoodThreshold = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListAnswersRequest$ { - /** @deprecated use `ListAnswersRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListAnswersRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListAnswersRequest$Outbound` instead. */ - type Outbound = ListAnswersRequest$Outbound; -} - -/** @internal */ -declare const ListAnswersRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListAnswersRequest$Outbound = { - boardId?: number | undefined; -}; - -/** @internal */ -declare const ListAnswersRequest$outboundSchema: z.ZodType; - -declare type ListAnswersRequest = { - /** - * The Answer Board Id to list answers on. - */ - boardId?: number | undefined; -}; - -declare function listAnswersRequestFromJSON(jsonString: string): Result; - -declare function listAnswersRequestToJSON(listAnswersRequest: ListAnswersRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListAnswersResponse$ { - /** @deprecated use `ListAnswersResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListAnswersResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListAnswersResponse$Outbound` instead. */ - type Outbound = ListAnswersResponse$Outbound; -} - -/** @internal */ -declare const ListAnswersResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListAnswersResponse$Outbound = { - answerResults: Array; -}; - -/** @internal */ -declare const ListAnswersResponse$outboundSchema: z.ZodType; - -declare type ListAnswersResponse = { - /** - * List of answers with tracking tokens. - */ - answerResults: Array; -}; - -declare function listAnswersResponseFromJSON(jsonString: string): Result; - -declare function listAnswersResponseToJSON(listAnswersResponse: ListAnswersResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListchatsRequest$ { - /** @deprecated use `ListchatsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListchatsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListchatsRequest$Outbound` instead. */ - type Outbound = ListchatsRequest$Outbound; -} - -/** @internal */ -declare const ListchatsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListchatsRequest$Outbound = { - timezoneOffset?: number | undefined; -}; - -/** @internal */ -declare const ListchatsRequest$outboundSchema: z.ZodType; - -declare type ListchatsRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; -}; - -declare function listchatsRequestFromJSON(jsonString: string): Result; - -declare function listchatsRequestToJSON(listchatsRequest: ListchatsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListChatsResponse$ { - /** @deprecated use `ListChatsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListChatsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListChatsResponse$Outbound` instead. */ - type Outbound = ListChatsResponse$Outbound; -} - -/** @internal */ -declare const ListChatsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListChatsResponse$Outbound = { - chatResults?: Array | undefined; -}; - -/** @internal */ -declare const ListChatsResponse$outboundSchema: z.ZodType; - -declare type ListChatsResponse = { - chatResults?: Array | undefined; -}; - -declare function listChatsResponseFromJSON(jsonString: string): Result; - -declare function listChatsResponseToJSON(listChatsResponse: ListChatsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListCollectionsRequest$ { - /** @deprecated use `ListCollectionsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListCollectionsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListCollectionsRequest$Outbound` instead. */ - type Outbound = ListCollectionsRequest$Outbound; -} - -/** @internal */ -declare const ListCollectionsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListCollectionsRequest$Outbound = { - includeAudience?: boolean | undefined; - includeRoles?: boolean | undefined; - allowedDatasource?: string | undefined; -}; - -/** @internal */ -declare const ListCollectionsRequest$outboundSchema: z.ZodType; - -declare type ListCollectionsRequest = { - /** - * Whether to include the audience filters with the listed Collections. - */ - includeAudience?: boolean | undefined; - /** - * Whether to include the editor roles with the listed Collections. - */ - includeRoles?: boolean | undefined; - /** - * The datasource type this Collection can hold. - * - * @remarks - * ANSWERS - for Collections representing answer boards - */ - allowedDatasource?: string | undefined; -}; - -declare function listCollectionsRequestFromJSON(jsonString: string): Result; - -declare function listCollectionsRequestToJSON(listCollectionsRequest: ListCollectionsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListCollectionsResponse$ { - /** @deprecated use `ListCollectionsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListCollectionsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListCollectionsResponse$Outbound` instead. */ - type Outbound = ListCollectionsResponse$Outbound; -} - -/** @internal */ -declare const ListCollectionsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListCollectionsResponse$Outbound = { - collections: Array; -}; - -/** @internal */ -declare const ListCollectionsResponse$outboundSchema: z.ZodType; - -declare type ListCollectionsResponse = { - /** - * List of all Collections, no Collection items are fetched. - */ - collections: Array; -}; - -declare function listCollectionsResponseFromJSON(jsonString: string): Result; - -declare function listCollectionsResponseToJSON(listCollectionsResponse: ListCollectionsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListDlpReportsResponse$ { - /** @deprecated use `ListDlpReportsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListDlpReportsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListDlpReportsResponse$Outbound` instead. */ - type Outbound = ListDlpReportsResponse$Outbound; -} - -/** @internal */ -declare const ListDlpReportsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListDlpReportsResponse$Outbound = { - reports?: Array | undefined; -}; - -/** @internal */ -declare const ListDlpReportsResponse$outboundSchema: z.ZodType; - -declare type ListDlpReportsResponse = { - reports?: Array | undefined; -}; - -declare function listDlpReportsResponseFromJSON(jsonString: string): Result; - -declare function listDlpReportsResponseToJSON(listDlpReportsResponse: ListDlpReportsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListEntitiesRequest$ { - /** @deprecated use `ListEntitiesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListEntitiesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListEntitiesRequest$Outbound` instead. */ - type Outbound = ListEntitiesRequest$Outbound; -} - -/** @internal */ -declare const ListEntitiesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListEntitiesRequest$Outbound = { - filter?: Array | undefined; - sort?: Array | undefined; - entityType: string; - datasource?: string | undefined; - query?: string | undefined; - includeFields?: Array | undefined; - pageSize?: number | undefined; - cursor?: string | undefined; - source?: string | undefined; - requestType: string; -}; - -/** @internal */ -declare const ListEntitiesRequest$outboundSchema: z.ZodType; - -declare type ListEntitiesRequest = { - filter?: Array | undefined; - /** - * Use EntitiesSortOrder enum for SortOptions.sortBy - */ - sort?: Array | undefined; - entityType?: ListEntitiesRequestEntityType | undefined; - /** - * The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES - */ - datasource?: string | undefined; - /** - * A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities. - */ - query?: string | undefined; - /** - * List of entity fields to return (that aren't returned by default) - */ - includeFields?: Array | undefined; - /** - * Hint to the server about how many results to send back. Server may return less. - */ - pageSize?: number | undefined; - /** - * Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - */ - cursor?: string | undefined; - /** - * A string denoting the search surface from which the endpoint is called. - */ - source?: string | undefined; - /** - * The type of request being made. - */ - requestType?: RequestType | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListEntitiesRequestEntityType$ { - /** @deprecated use `ListEntitiesRequestEntityType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly CustomEntities: "CUSTOM_ENTITIES"; - }>; - /** @deprecated use `ListEntitiesRequestEntityType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly CustomEntities: "CUSTOM_ENTITIES"; - }>; -} - -/** @internal */ -declare const ListEntitiesRequestEntityType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ListEntitiesRequestEntityType$outboundSchema: z.ZodNativeEnum; - -declare const ListEntitiesRequestEntityType: { - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly CustomEntities: "CUSTOM_ENTITIES"; -}; - -declare type ListEntitiesRequestEntityType = ClosedEnum; - -declare function listEntitiesRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListEntitiesRequestIncludeField$ { - /** @deprecated use `ListEntitiesRequestIncludeField$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly Facets: "FACETS"; - readonly InviteInfo: "INVITE_INFO"; - readonly LastExtensionUse: "LAST_EXTENSION_USE"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly UnprocessedTeams: "UNPROCESSED_TEAMS"; - }>; - /** @deprecated use `ListEntitiesRequestIncludeField$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly Facets: "FACETS"; - readonly InviteInfo: "INVITE_INFO"; - readonly LastExtensionUse: "LAST_EXTENSION_USE"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly UnprocessedTeams: "UNPROCESSED_TEAMS"; - }>; -} - -/** @internal */ -declare const ListEntitiesRequestIncludeField$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ListEntitiesRequestIncludeField$outboundSchema: z.ZodNativeEnum; - -declare const ListEntitiesRequestIncludeField: { - readonly People: "PEOPLE"; - readonly Teams: "TEAMS"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly Facets: "FACETS"; - readonly InviteInfo: "INVITE_INFO"; - readonly LastExtensionUse: "LAST_EXTENSION_USE"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly UnprocessedTeams: "UNPROCESSED_TEAMS"; -}; - -declare type ListEntitiesRequestIncludeField = ClosedEnum; - -declare function listEntitiesRequestToJSON(listEntitiesRequest: ListEntitiesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListEntitiesResponse$ { - /** @deprecated use `ListEntitiesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListEntitiesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListEntitiesResponse$Outbound` instead. */ - type Outbound = ListEntitiesResponse$Outbound; -} - -/** @internal */ -declare const ListEntitiesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListEntitiesResponse$Outbound = { - results?: Array | undefined; - teamResults?: Array | undefined; - customEntityResults?: Array | undefined; - facetResults?: Array | undefined; - cursor?: string | undefined; - totalCount?: number | undefined; - hasMoreResults?: boolean | undefined; - sortOptions?: Array | undefined; - customFacetNames?: Array | undefined; -}; - -/** @internal */ -declare const ListEntitiesResponse$outboundSchema: z.ZodType; - -declare type ListEntitiesResponse = { - results?: Array | undefined; - teamResults?: Array | undefined; - customEntityResults?: Array | undefined; - facetResults?: Array | undefined; - /** - * Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - */ - cursor?: string | undefined; - /** - * The total number of entities available - */ - totalCount?: number | undefined; - /** - * Whether or not more entities can be fetched. - */ - hasMoreResults?: boolean | undefined; - /** - * Sort options from EntitiesSortOrder supported for this response. Default is empty list. - */ - sortOptions?: Array | undefined; - /** - * list of Person attributes that are custom setup by deployment - */ - customFacetNames?: Array | undefined; -}; - -declare function listEntitiesResponseFromJSON(jsonString: string): Result; - -declare function listEntitiesResponseToJSON(listEntitiesResponse: ListEntitiesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListpinsRequest$ { - /** @deprecated use `ListpinsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListpinsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListpinsRequest$Outbound` instead. */ - type Outbound = ListpinsRequest$Outbound; -} - -/** @internal */ -declare const ListpinsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListpinsRequest$Outbound = {}; - -/** @internal */ -declare const ListpinsRequest$outboundSchema: z.ZodType; - -/** - * List pins request - */ -declare type ListpinsRequest = {}; - -declare function listpinsRequestFromJSON(jsonString: string): Result; - -declare function listpinsRequestToJSON(listpinsRequest: ListpinsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListPinsResponse$ { - /** @deprecated use `ListPinsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListPinsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListPinsResponse$Outbound` instead. */ - type Outbound = ListPinsResponse$Outbound; -} - -/** @internal */ -declare const ListPinsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListPinsResponse$Outbound = { - pins: Array; -}; - -/** @internal */ -declare const ListPinsResponse$outboundSchema: z.ZodType; - -declare type ListPinsResponse = { - /** - * List of pinned documents. - */ - pins: Array; -}; - -declare function listPinsResponseFromJSON(jsonString: string): Result; - -declare function listPinsResponseToJSON(listPinsResponse: ListPinsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListpoliciesRequest$ { - /** @deprecated use `ListpoliciesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListpoliciesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListpoliciesRequest$Outbound` instead. */ - type Outbound = ListpoliciesRequest$Outbound; -} - -/** @internal */ -declare const ListpoliciesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListpoliciesRequest$Outbound = { - autoHide?: boolean | undefined; - frequency?: string | undefined; -}; - -/** @internal */ -declare const ListpoliciesRequest$outboundSchema: z.ZodType; - -declare type ListpoliciesRequest = { - /** - * Filter to return reports with a given value of auto-hide. - */ - autoHide?: boolean | undefined; - /** - * Filter to return reports with a given frequency. - */ - frequency?: string | undefined; -}; - -declare function listpoliciesRequestFromJSON(jsonString: string): Result; - -declare function listpoliciesRequestToJSON(listpoliciesRequest: ListpoliciesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListShortcutsPaginatedRequest$ { - /** @deprecated use `ListShortcutsPaginatedRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListShortcutsPaginatedRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListShortcutsPaginatedRequest$Outbound` instead. */ - type Outbound = ListShortcutsPaginatedRequest$Outbound; -} - -/** @internal */ -declare const ListShortcutsPaginatedRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListShortcutsPaginatedRequest$Outbound = { - includeFields?: Array | undefined; - pageSize: number; - cursor?: string | undefined; - filters?: Array | undefined; - sort?: SortOptions$Outbound | undefined; - query?: string | undefined; -}; - -/** @internal */ -declare const ListShortcutsPaginatedRequest$outboundSchema: z.ZodType; - -declare type ListShortcutsPaginatedRequest = { - /** - * Array of fields/data to be included in response that are not included by default - */ - includeFields?: Array | undefined; - pageSize: number; - /** - * A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination) - */ - cursor?: string | undefined; - /** - * A list of filters for the query. An AND is assumed between different filters. We support filters on Go Link name, author, department and type. - */ - filters?: Array | undefined; - sort?: SortOptions | undefined; - /** - * Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts. - */ - query?: string | undefined; -}; - -declare function listShortcutsPaginatedRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListShortcutsPaginatedRequestIncludeField$ { - /** @deprecated use `ListShortcutsPaginatedRequestIncludeField$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Facets: "FACETS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; - }>; - /** @deprecated use `ListShortcutsPaginatedRequestIncludeField$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Facets: "FACETS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; - }>; -} - -/** @internal */ -declare const ListShortcutsPaginatedRequestIncludeField$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ListShortcutsPaginatedRequestIncludeField$outboundSchema: z.ZodNativeEnum; - -declare const ListShortcutsPaginatedRequestIncludeField: { - readonly Facets: "FACETS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; -}; - -declare type ListShortcutsPaginatedRequestIncludeField = ClosedEnum; - -declare function listShortcutsPaginatedRequestToJSON(listShortcutsPaginatedRequest: ListShortcutsPaginatedRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListShortcutsPaginatedResponse$ { - /** @deprecated use `ListShortcutsPaginatedResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListShortcutsPaginatedResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListShortcutsPaginatedResponse$Outbound` instead. */ - type Outbound = ListShortcutsPaginatedResponse$Outbound; -} - -/** @internal */ -declare const ListShortcutsPaginatedResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListShortcutsPaginatedResponse$Outbound = { - shortcuts: Array; - facetResults?: Array | undefined; - meta: ShortcutsPaginationMetadata$Outbound; -}; - -/** @internal */ -declare const ListShortcutsPaginatedResponse$outboundSchema: z.ZodType; - -declare type ListShortcutsPaginatedResponse = { - /** - * List of all shortcuts accessible to the user - */ - shortcuts: Array; - facetResults?: Array | undefined; - meta: ShortcutsPaginationMetadata; -}; - -declare function listShortcutsPaginatedResponseFromJSON(jsonString: string): Result; - -declare function listShortcutsPaginatedResponseToJSON(listShortcutsPaginatedResponse: ListShortcutsPaginatedResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListverificationsRequest$ { - /** @deprecated use `ListverificationsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListverificationsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListverificationsRequest$Outbound` instead. */ - type Outbound = ListverificationsRequest$Outbound; -} - -/** @internal */ -declare const ListverificationsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListverificationsRequest$Outbound = { - count?: number | undefined; -}; - -/** @internal */ -declare const ListverificationsRequest$outboundSchema: z.ZodType; - -declare type ListverificationsRequest = { - /** - * Maximum number of documents to return - */ - count?: number | undefined; -}; - -declare function listverificationsRequestFromJSON(jsonString: string): Result; - -declare function listverificationsRequestToJSON(listverificationsRequest: ListverificationsRequest): string; - -declare interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackInfo$ { - /** @deprecated use `ManualFeedbackInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ManualFeedbackInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ManualFeedbackInfo$Outbound` instead. */ - type Outbound = ManualFeedbackInfo$Outbound; -} - -/** @internal */ -declare const ManualFeedbackInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ManualFeedbackInfo$Outbound = { - email?: string | undefined; - source?: string | undefined; - issue?: string | undefined; - issues?: Array | undefined; - imageUrls?: Array | undefined; - query?: string | undefined; - obscuredQuery?: string | undefined; - activeTab?: string | undefined; - comments?: string | undefined; - searchResults?: Array | undefined; - previousMessages?: Array | undefined; - chatTranscript?: Array | undefined; - numQueriesFromFirstRun?: number | undefined; - vote?: string | undefined; - rating?: number | undefined; - ratingKey?: string | undefined; - ratingScale?: number | undefined; -}; - -/** @internal */ -declare const ManualFeedbackInfo$outboundSchema: z.ZodType; - -declare type ManualFeedbackInfo = { - /** - * The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - email?: string | undefined; - /** - * The source associated with the Feedback.event.MANUAL_FEEDBACK event. - */ - source?: ManualFeedbackInfoSource | undefined; - /** - * The issue the user indicated in the feedback. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - issue?: string | undefined; - /** - * The issue(s) the user indicated in the feedback. - */ - issues?: Array | undefined; - /** - * URLs of images uploaded by user when providing feedback - */ - imageUrls?: Array | undefined; - /** - * The query associated with the Feedback.event.MANUAL_FEEDBACK event. - */ - query?: string | undefined; - /** - * The query associated with the Feedback.event.MANUAL_FEEDBACK event, but obscured such that the vowels are replaced with special characters. For search feedback events only. - */ - obscuredQuery?: string | undefined; - /** - * Which tabs the user had chosen at the time of the Feedback.event.MANUAL_FEEDBACK event. For search feedback events only. - */ - activeTab?: string | undefined; - /** - * The comments users can optionally add to the Feedback.event.MANUAL_FEEDBACK events. - */ - comments?: string | undefined; - /** - * The array of search result Glean Document IDs, ordered by top to bottom result. - */ - searchResults?: Array | undefined; - /** - * The array of previous messages in a chat session, ordered by oldest to newest. - */ - previousMessages?: Array | undefined; - /** - * Array of previous request/response exchanges, ordered by oldest to newest. - */ - chatTranscript?: Array | undefined; - /** - * How many times this query has been run in the past. - */ - numQueriesFromFirstRun?: number | undefined; - /** - * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - */ - vote?: ManualFeedbackInfoVote | undefined; - /** - * A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. - */ - rating?: number | undefined; - /** - * A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied". - */ - ratingKey?: string | undefined; - /** - * The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2. - */ - ratingScale?: number | undefined; -}; - -declare function manualFeedbackInfoFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackInfoSource$ { - /** @deprecated use `ManualFeedbackInfoSource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Calendar: "CALENDAR"; - readonly Chat: "CHAT"; - readonly ChatGeneral: "CHAT_GENERAL"; - readonly ConceptCard: "CONCEPT_CARD"; - readonly DesktopApp: "DESKTOP_APP"; - readonly DisambiguationCard: "DISAMBIGUATION_CARD"; - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly Feed: "FEED"; - readonly GeneratedQAndA: "GENERATED_Q_AND_A"; - readonly InlineMenu: "INLINE_MENU"; - readonly NativeResult: "NATIVE_RESULT"; - readonly QAndA: "Q_AND_A"; - readonly RelatedQuestions: "RELATED_QUESTIONS"; - readonly ReportIssue: "REPORT_ISSUE"; - readonly Sciobot: "SCIOBOT"; - readonly Search: "SEARCH"; - readonly Sidebar: "SIDEBAR"; - readonly Summary: "SUMMARY"; - readonly Tasks: "TASKS"; - }>; - /** @deprecated use `ManualFeedbackInfoSource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Calendar: "CALENDAR"; - readonly Chat: "CHAT"; - readonly ChatGeneral: "CHAT_GENERAL"; - readonly ConceptCard: "CONCEPT_CARD"; - readonly DesktopApp: "DESKTOP_APP"; - readonly DisambiguationCard: "DISAMBIGUATION_CARD"; - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly Feed: "FEED"; - readonly GeneratedQAndA: "GENERATED_Q_AND_A"; - readonly InlineMenu: "INLINE_MENU"; - readonly NativeResult: "NATIVE_RESULT"; - readonly QAndA: "Q_AND_A"; - readonly RelatedQuestions: "RELATED_QUESTIONS"; - readonly ReportIssue: "REPORT_ISSUE"; - readonly Sciobot: "SCIOBOT"; - readonly Search: "SEARCH"; - readonly Sidebar: "SIDEBAR"; - readonly Summary: "SUMMARY"; - readonly Tasks: "TASKS"; - }>; -} - -/** @internal */ -declare const ManualFeedbackInfoSource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ManualFeedbackInfoSource$outboundSchema: z.ZodNativeEnum; - -/** - * The source associated with the Feedback.event.MANUAL_FEEDBACK event. - */ -declare const ManualFeedbackInfoSource: { - readonly Autocomplete: "AUTOCOMPLETE"; - readonly Calendar: "CALENDAR"; - readonly Chat: "CHAT"; - readonly ChatGeneral: "CHAT_GENERAL"; - readonly ConceptCard: "CONCEPT_CARD"; - readonly DesktopApp: "DESKTOP_APP"; - readonly DisambiguationCard: "DISAMBIGUATION_CARD"; - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly Feed: "FEED"; - readonly GeneratedQAndA: "GENERATED_Q_AND_A"; - readonly InlineMenu: "INLINE_MENU"; - readonly NativeResult: "NATIVE_RESULT"; - readonly QAndA: "Q_AND_A"; - readonly RelatedQuestions: "RELATED_QUESTIONS"; - readonly ReportIssue: "REPORT_ISSUE"; - readonly Sciobot: "SCIOBOT"; - readonly Search: "SEARCH"; - readonly Sidebar: "SIDEBAR"; - readonly Summary: "SUMMARY"; - readonly Tasks: "TASKS"; -}; - -/** - * The source associated with the Feedback.event.MANUAL_FEEDBACK event. - */ -declare type ManualFeedbackInfoSource = ClosedEnum; - -declare function manualFeedbackInfoToJSON(manualFeedbackInfo: ManualFeedbackInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackInfoVote$ { - /** @deprecated use `ManualFeedbackInfoVote$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; - }>; - /** @deprecated use `ManualFeedbackInfoVote$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; - }>; -} - -/** @internal */ -declare const ManualFeedbackInfoVote$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ManualFeedbackInfoVote$outboundSchema: z.ZodNativeEnum; - -/** - * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - */ -declare const ManualFeedbackInfoVote: { - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; -}; - -/** - * The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - */ -declare type ManualFeedbackInfoVote = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackSideBySideInfo$ { - /** @deprecated use `ManualFeedbackSideBySideInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ManualFeedbackSideBySideInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ManualFeedbackSideBySideInfo$Outbound` instead. */ - type Outbound = ManualFeedbackSideBySideInfo$Outbound; -} - -/** @internal */ -declare const ManualFeedbackSideBySideInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ManualFeedbackSideBySideInfo$Outbound = { - email?: string | undefined; - source?: string | undefined; - query?: string | undefined; - implementations?: Array | undefined; - evaluationSessionId?: string | undefined; - implementationId?: string | undefined; - vote?: string | undefined; - comments?: string | undefined; -}; - -/** @internal */ -declare const ManualFeedbackSideBySideInfo$outboundSchema: z.ZodType; - -declare type ManualFeedbackSideBySideInfo = { - /** - * The email address of the user who submitted the side-by-side feedback. - */ - email?: string | undefined; - /** - * The source associated with the side-by-side feedback event. - */ - source?: ManualFeedbackSideBySideInfoSource | undefined; - /** - * The query or prompt that was evaluated across multiple implementations. - */ - query?: string | undefined; - /** - * Array of implementations that were compared side-by-side. - */ - implementations?: Array | undefined; - /** - * Unique identifier for this evaluation session to group related feedback events. - */ - evaluationSessionId?: string | undefined; - /** - * The ID of the implementation this specific feedback event is for. - */ - implementationId?: string | undefined; - /** - * The vote for this specific implementation. - */ - vote?: ManualFeedbackSideBySideInfoVote | undefined; - /** - * Specific feedback comments for this implementation. - */ - comments?: string | undefined; -}; - -declare function manualFeedbackSideBySideInfoFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackSideBySideInfoSource$ { - /** @deprecated use `ManualFeedbackSideBySideInfoSource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly LiveEval: "LIVE_EVAL"; - readonly Chat: "CHAT"; - readonly Search: "SEARCH"; - }>; - /** @deprecated use `ManualFeedbackSideBySideInfoSource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly LiveEval: "LIVE_EVAL"; - readonly Chat: "CHAT"; - readonly Search: "SEARCH"; - }>; -} - -/** @internal */ -declare const ManualFeedbackSideBySideInfoSource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ManualFeedbackSideBySideInfoSource$outboundSchema: z.ZodNativeEnum; - -/** - * The source associated with the side-by-side feedback event. - */ -declare const ManualFeedbackSideBySideInfoSource: { - readonly LiveEval: "LIVE_EVAL"; - readonly Chat: "CHAT"; - readonly Search: "SEARCH"; -}; - -/** - * The source associated with the side-by-side feedback event. - */ -declare type ManualFeedbackSideBySideInfoSource = ClosedEnum; - -declare function manualFeedbackSideBySideInfoToJSON(manualFeedbackSideBySideInfo: ManualFeedbackSideBySideInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ManualFeedbackSideBySideInfoVote$ { - /** @deprecated use `ManualFeedbackSideBySideInfoVote$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; - readonly Neutral: "NEUTRAL"; - }>; - /** @deprecated use `ManualFeedbackSideBySideInfoVote$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; - readonly Neutral: "NEUTRAL"; - }>; -} - -/** @internal */ -declare const ManualFeedbackSideBySideInfoVote$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ManualFeedbackSideBySideInfoVote$outboundSchema: z.ZodNativeEnum; - -/** - * The vote for this specific implementation. - */ -declare const ManualFeedbackSideBySideInfoVote: { - readonly Upvote: "UPVOTE"; - readonly Downvote: "DOWNVOTE"; - readonly Neutral: "NEUTRAL"; -}; - -/** - * The vote for this specific implementation. - */ -declare type ManualFeedbackSideBySideInfoVote = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Meeting$ { - /** @deprecated use `Meeting$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Meeting$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Meeting$Outbound` instead. */ - type Outbound = Meeting$Outbound; -} - -/** @internal */ -declare const Meeting$inboundSchema: z.ZodType; - -/** @internal */ -declare type Meeting$Outbound = { - id?: string | undefined; - title?: string | undefined; - description?: string | undefined; - url?: string | undefined; - startTime?: string | undefined; - endTime?: string | undefined; - attendees?: CalendarAttendees$Outbound | undefined; -}; - -/** @internal */ -declare const Meeting$outboundSchema: z.ZodType; - -declare type Meeting = { - id?: string | undefined; - title?: string | undefined; - description?: string | undefined; - url?: string | undefined; - startTime?: Date | undefined; - endTime?: Date | undefined; - attendees?: CalendarAttendees | undefined; -}; - -declare function meetingFromJSON(jsonString: string): Result; - -declare function meetingToJSON(meeting: Meeting): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Message$ { - /** @deprecated use `Message$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Message$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Message$Outbound` instead. */ - type Outbound = Message$Outbound; -} - -/** @internal */ -declare const Message$inboundSchema: z.ZodType; - -/** @internal */ -declare type Message$Outbound = { - role?: string | undefined; - content?: Array | undefined; -}; - -/** @internal */ -declare const Message$outboundSchema: z.ZodType; - -declare type Message = { - /** - * The role of the message. - */ - role?: string | undefined; - /** - * The content of the message. - */ - content?: Array | undefined; -}; - -declare function messageFromJSON(jsonString: string): Result; - -declare class Messages extends ClientSDK { - /** - * Read messages - * - * @remarks - * Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams). - */ - retrieve(request: components.MessagesRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessagesRequest$ { - /** @deprecated use `MessagesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessagesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessagesRequest$Outbound` instead. */ - type Outbound = MessagesRequest$Outbound; -} - -/** @internal */ -declare const MessagesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessagesRequest$Outbound = { - idType: string; - id: string; - workspaceId?: string | undefined; - direction?: string | undefined; - timestampMillis?: number | undefined; - includeRootMessage?: boolean | undefined; - datasource?: string | undefined; - datasourceInstanceDisplayName?: string | undefined; -}; - -/** @internal */ -declare const MessagesRequest$outboundSchema: z.ZodType; - -declare type MessagesRequest = { - /** - * Type of the id in the incoming request. - */ - idType: IdType; - /** - * ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID. - */ - id: string; - /** - * Id for the for the workspace in case of multiple workspaces. - */ - workspaceId?: string | undefined; - /** - * The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. - */ - direction?: Direction | undefined; - /** - * Timestamp in millis of the reference message. Only applicable when using a message_id. - */ - timestampMillis?: number | undefined; - /** - * Whether to include root message in response. - */ - includeRootMessage?: boolean | undefined; - /** - * The type of the data source. Missing field defaults to SLACK. - */ - datasource?: Datasource | undefined; - /** - * The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances. - */ - datasourceInstanceDisplayName?: string | undefined; -}; - -declare function messagesRequestFromJSON(jsonString: string): Result; - -declare function messagesRequestToJSON(messagesRequest: MessagesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessagesResponse$ { - /** @deprecated use `MessagesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessagesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessagesResponse$Outbound` instead. */ - type Outbound = MessagesResponse$Outbound; -} - -/** @internal */ -declare const MessagesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessagesResponse$Outbound = { - hasMore: boolean; - searchResponse?: SearchResponse$Outbound | undefined; - rootMessage?: SearchResult$Outbound | undefined; -}; - -/** @internal */ -declare const MessagesResponse$outboundSchema: z.ZodType; - -declare type MessagesResponse = { - /** - * Whether there are more results for client to continue requesting. - */ - hasMore: boolean; - searchResponse?: SearchResponse | undefined; - rootMessage?: SearchResult | undefined; -}; - -declare function messagesResponseFromJSON(jsonString: string): Result; - -declare function messagesResponseToJSON(messagesResponse: MessagesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageTextBlock$ { - /** @deprecated use `MessageTextBlock$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageTextBlock$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageTextBlock$Outbound` instead. */ - type Outbound = MessageTextBlock$Outbound; -} - -/** @internal */ -declare const MessageTextBlock$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageTextBlock$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -declare const MessageTextBlock$outboundSchema: z.ZodType; - -declare type MessageTextBlock = { - text: string; - type: ContentType; -}; - -declare function messageTextBlockFromJSON(jsonString: string): Result; - -declare function messageTextBlockToJSON(messageTextBlock: MessageTextBlock): string; - -declare function messageToJSON(message: Message): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageType$ { - /** @deprecated use `MessageType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Update: "UPDATE"; - readonly Content: "CONTENT"; - readonly Context: "CONTEXT"; - readonly Debug: "DEBUG"; - readonly DebugExternal: "DEBUG_EXTERNAL"; - readonly Error: "ERROR"; - readonly Heading: "HEADING"; - readonly Warning: "WARNING"; - readonly ServerTool: "SERVER_TOOL"; - }>; - /** @deprecated use `MessageType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Update: "UPDATE"; - readonly Content: "CONTENT"; - readonly Context: "CONTEXT"; - readonly Debug: "DEBUG"; - readonly DebugExternal: "DEBUG_EXTERNAL"; - readonly Error: "ERROR"; - readonly Heading: "HEADING"; - readonly Warning: "WARNING"; - readonly ServerTool: "SERVER_TOOL"; - }>; -} - -/** @internal */ -declare const MessageType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageType$outboundSchema: z.ZodNativeEnum; - -/** - * Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - */ -declare const MessageType: { - readonly Update: "UPDATE"; - readonly Content: "CONTENT"; - readonly Context: "CONTEXT"; - readonly Debug: "DEBUG"; - readonly DebugExternal: "DEBUG_EXTERNAL"; - readonly Error: "ERROR"; - readonly Heading: "HEADING"; - readonly Warning: "WARNING"; - readonly ServerTool: "SERVER_TOOL"; -}; - -/** - * Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - */ -declare type MessageType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Mode$ { - /** @deprecated use `Mode$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly Quick: "QUICK"; - }>; - /** @deprecated use `Mode$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Default: "DEFAULT"; - readonly Quick: "QUICK"; - }>; -} - -/** @internal */ -declare const Mode$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Mode$outboundSchema: z.ZodNativeEnum; - -/** - * Top level modes to run GleanChat in. - */ -declare const Mode: { - readonly Default: "DEFAULT"; - readonly Quick: "QUICK"; -}; - -/** - * Top level modes to run GleanChat in. - */ -declare type Mode = ClosedEnum; - -declare type OAuth2PasswordFlow = { - username: string; - password: string; - clientID?: string | undefined; - clientSecret?: string | undefined; - tokenURL: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ObjectDefinition$ { - /** @deprecated use `ObjectDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ObjectDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ObjectDefinition$Outbound` instead. */ - type Outbound = ObjectDefinition$Outbound; -} - -/** @internal */ -declare const ObjectDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type ObjectDefinition$Outbound = { - name?: string | undefined; - displayLabel?: string | undefined; - docCategory?: string | undefined; - propertyDefinitions?: Array | undefined; - propertyGroups?: Array | undefined; - summarizable?: boolean | undefined; -}; - -/** @internal */ -declare const ObjectDefinition$outboundSchema: z.ZodType; - -/** - * The definition for an `DocumentMetadata.objectType` within a datasource. - */ -declare type ObjectDefinition = { - /** - * Unique identifier for this `DocumentMetadata.objectType`. If omitted, this definition is used as a default for all unmatched `DocumentMetadata.objectType`s in this datasource. - */ - name?: string | undefined; - /** - * The user-friendly name of the object for display. - */ - displayLabel?: string | undefined; - /** - * The document category of this object type. - */ - docCategory?: DocCategory | undefined; - propertyDefinitions?: Array | undefined; - /** - * A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI. - */ - propertyGroups?: Array | undefined; - /** - * Whether or not the object is summarizable - */ - summarizable?: boolean | undefined; -}; - -declare function objectDefinitionFromJSON(jsonString: string): Result; - -declare function objectDefinitionToJSON(objectDefinition: ObjectDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ObjectPermissions$ { - /** @deprecated use `ObjectPermissions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ObjectPermissions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ObjectPermissions$Outbound` instead. */ - type Outbound = ObjectPermissions$Outbound; -} - -/** @internal */ -declare const ObjectPermissions$inboundSchema: z.ZodType; - -/** @internal */ -declare type ObjectPermissions$Outbound = { - write?: WritePermission$Outbound | undefined; -}; - -/** @internal */ -declare const ObjectPermissions$outboundSchema: z.ZodType; - -declare type ObjectPermissions = { - /** - * Describes the write permissions levels that a user has for a specific feature - */ - write?: WritePermission | undefined; -}; - -declare function objectPermissionsFromJSON(jsonString: string): Result; - -declare function objectPermissionsToJSON(objectPermissions: ObjectPermissions): string; - -declare namespace operations { - export { - chatRequestToJSON_2 as chatRequestToJSON, - chatRequestFromJSON_2 as chatRequestFromJSON, - ChatRequest_2 as ChatRequest, - ChatRequest$inboundSchema_2 as ChatRequest$inboundSchema, - ChatRequest$Outbound_2 as ChatRequest$Outbound, - ChatRequest$outboundSchema_2 as ChatRequest$outboundSchema, - ChatRequest$_2 as ChatRequest$, - chatStreamRequestToJSON, - chatStreamRequestFromJSON, - ChatStreamRequest, - ChatStreamRequest$inboundSchema, - ChatStreamRequest$Outbound, - ChatStreamRequest$outboundSchema, - ChatStreamRequest$, - responseBody2ToJSON, - responseBody2FromJSON, - responseBody1ToJSON, - responseBody1FromJSON, - createcollectionResponseToJSON, - createcollectionResponseFromJSON, - ResponseBody2, - ResponseBody1, - CreatecollectionResponse, - ResponseBody2$inboundSchema, - ResponseBody2$Outbound, - ResponseBody2$outboundSchema, - ResponseBody2$, - ResponseBody1$inboundSchema, - ResponseBody1$Outbound, - ResponseBody1$outboundSchema, - ResponseBody1$, - CreatecollectionResponse$inboundSchema, - CreatecollectionResponse$Outbound, - CreatecollectionResponse$outboundSchema, - CreatecollectionResponse$, - deleteallchatsRequestToJSON, - deleteallchatsRequestFromJSON, - DeleteallchatsRequest, - DeleteallchatsRequest$inboundSchema, - DeleteallchatsRequest$Outbound, - DeleteallchatsRequest$outboundSchema, - DeleteallchatsRequest$, - deletechatfilesRequestToJSON, - deletechatfilesRequestFromJSON, - DeletechatfilesRequest, - DeletechatfilesRequest$inboundSchema, - DeletechatfilesRequest$Outbound, - DeletechatfilesRequest$outboundSchema, - DeletechatfilesRequest$, - deletechatsRequestToJSON, - deletechatsRequestFromJSON, - DeletechatsRequest, - DeletechatsRequest$inboundSchema, - DeletechatsRequest$Outbound, - DeletechatsRequest$outboundSchema, - DeletechatsRequest$, - downloadpolicycsvRequestToJSON, - downloadpolicycsvRequestFromJSON, - DownloadpolicycsvRequest, - DownloadpolicycsvRequest$inboundSchema, - DownloadpolicycsvRequest$Outbound, - DownloadpolicycsvRequest$outboundSchema, - DownloadpolicycsvRequest$, - downloadreportcsvRequestToJSON, - downloadreportcsvRequestFromJSON, - DownloadreportcsvRequest, - DownloadreportcsvRequest$inboundSchema, - DownloadreportcsvRequest$Outbound, - DownloadreportcsvRequest$outboundSchema, - DownloadreportcsvRequest$, - feedbackRequestToJSON, - feedbackRequestFromJSON, - FeedbackRequest, - FeedbackRequest$inboundSchema, - FeedbackRequest$Outbound, - FeedbackRequest$outboundSchema, - FeedbackRequest$, - getAgentRequestToJSON, - getAgentRequestFromJSON, - GetAgentRequest, - GetAgentRequest$inboundSchema, - GetAgentRequest$Outbound, - GetAgentRequest$outboundSchema, - GetAgentRequest$, - getAgentSchemasRequestToJSON, - getAgentSchemasRequestFromJSON, - GetAgentSchemasRequest, - GetAgentSchemasRequest$inboundSchema, - GetAgentSchemasRequest$Outbound, - GetAgentSchemasRequest$outboundSchema, - GetAgentSchemasRequest$, - getchatRequestToJSON, - getchatRequestFromJSON, - GetchatRequest, - GetchatRequest$inboundSchema, - GetchatRequest$Outbound, - GetchatRequest$outboundSchema, - GetchatRequest$, - getchatapplicationRequestToJSON, - getchatapplicationRequestFromJSON, - GetchatapplicationRequest, - GetchatapplicationRequest$inboundSchema, - GetchatapplicationRequest$Outbound, - GetchatapplicationRequest$outboundSchema, - GetchatapplicationRequest$, - getchatfilesRequestToJSON, - getchatfilesRequestFromJSON, - GetchatfilesRequest, - GetchatfilesRequest$inboundSchema, - GetchatfilesRequest$Outbound, - GetchatfilesRequest$outboundSchema, - GetchatfilesRequest$, - getdocvisibilityRequestToJSON, - getdocvisibilityRequestFromJSON, - GetdocvisibilityRequest, - GetdocvisibilityRequest$inboundSchema, - GetdocvisibilityRequest$Outbound, - GetdocvisibilityRequest$outboundSchema, - GetdocvisibilityRequest$, - getpolicyRequestToJSON, - getpolicyRequestFromJSON, - GetpolicyRequest, - GetpolicyRequest$inboundSchema, - GetpolicyRequest$Outbound, - GetpolicyRequest$outboundSchema, - GetpolicyRequest$, - getreportstatusRequestToJSON, - getreportstatusRequestFromJSON, - GetreportstatusRequest, - GetreportstatusRequest$inboundSchema, - GetreportstatusRequest$Outbound, - GetreportstatusRequest$outboundSchema, - GetreportstatusRequest$, - getRestApiV1ToolsListRequestToJSON, - getRestApiV1ToolsListRequestFromJSON, - GetRestApiV1ToolsListRequest, - GetRestApiV1ToolsListRequest$inboundSchema, - GetRestApiV1ToolsListRequest$Outbound, - GetRestApiV1ToolsListRequest$outboundSchema, - GetRestApiV1ToolsListRequest$, - listchatsRequestToJSON, - listchatsRequestFromJSON, - ListchatsRequest, - ListchatsRequest$inboundSchema, - ListchatsRequest$Outbound, - ListchatsRequest$outboundSchema, - ListchatsRequest$, - listpinsRequestToJSON, - listpinsRequestFromJSON, - ListpinsRequest, - ListpinsRequest$inboundSchema, - ListpinsRequest$Outbound, - ListpinsRequest$outboundSchema, - ListpinsRequest$, - listpoliciesRequestToJSON, - listpoliciesRequestFromJSON, - ListpoliciesRequest, - ListpoliciesRequest$inboundSchema, - ListpoliciesRequest$Outbound, - ListpoliciesRequest$outboundSchema, - ListpoliciesRequest$, - listverificationsRequestToJSON, - listverificationsRequestFromJSON, - ListverificationsRequest, - ListverificationsRequest$inboundSchema, - ListverificationsRequest$Outbound, - ListverificationsRequest$outboundSchema, - ListverificationsRequest$, - postApiIndexV1DebugDatasourceDocumentRequestToJSON, - postApiIndexV1DebugDatasourceDocumentRequestFromJSON, - PostApiIndexV1DebugDatasourceDocumentRequest, - PostApiIndexV1DebugDatasourceDocumentRequest$inboundSchema, - PostApiIndexV1DebugDatasourceDocumentRequest$Outbound, - PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema, - PostApiIndexV1DebugDatasourceDocumentRequest$, - postApiIndexV1DebugDatasourceDocumentsRequestToJSON, - postApiIndexV1DebugDatasourceDocumentsRequestFromJSON, - PostApiIndexV1DebugDatasourceDocumentsRequest, - PostApiIndexV1DebugDatasourceDocumentsRequest$inboundSchema, - PostApiIndexV1DebugDatasourceDocumentsRequest$Outbound, - PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema, - PostApiIndexV1DebugDatasourceDocumentsRequest$, - postApiIndexV1DebugDatasourceStatusRequestToJSON, - postApiIndexV1DebugDatasourceStatusRequestFromJSON, - PostApiIndexV1DebugDatasourceStatusRequest, - PostApiIndexV1DebugDatasourceStatusRequest$inboundSchema, - PostApiIndexV1DebugDatasourceStatusRequest$Outbound, - PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema, - PostApiIndexV1DebugDatasourceStatusRequest$, - postApiIndexV1DebugDatasourceUserRequestToJSON, - postApiIndexV1DebugDatasourceUserRequestFromJSON, - PostApiIndexV1DebugDatasourceUserRequest, - PostApiIndexV1DebugDatasourceUserRequest$inboundSchema, - PostApiIndexV1DebugDatasourceUserRequest$Outbound, - PostApiIndexV1DebugDatasourceUserRequest$outboundSchema, - PostApiIndexV1DebugDatasourceUserRequest$, - updatepolicyRequestToJSON, - updatepolicyRequestFromJSON, - UpdatepolicyRequest, - UpdatepolicyRequest$inboundSchema, - UpdatepolicyRequest$Outbound, - UpdatepolicyRequest$outboundSchema, - UpdatepolicyRequest$, - uploadchatfilesRequestToJSON, - uploadchatfilesRequestFromJSON, - UploadchatfilesRequest, - UploadchatfilesRequest$inboundSchema, - UploadchatfilesRequest$Outbound, - UploadchatfilesRequest$outboundSchema, - UploadchatfilesRequest$ - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OperatorMetadata$ { - /** @deprecated use `OperatorMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OperatorMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OperatorMetadata$Outbound` instead. */ - type Outbound = OperatorMetadata$Outbound; -} - -/** @internal */ -declare const OperatorMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type OperatorMetadata$Outbound = { - name: string; - isCustom?: boolean | undefined; - operatorType?: string | undefined; - helpText?: string | undefined; - scopes?: Array | undefined; - value?: string | undefined; - displayValue?: string | undefined; -}; - -/** @internal */ -declare const OperatorMetadata$outboundSchema: z.ZodType; - -declare type OperatorMetadata = { - name: string; - /** - * Whether this operator is supported by default or something that was created within a workplace app (e.g. custom jira field). - */ - isCustom?: boolean | undefined; - operatorType?: OperatorType | undefined; - helpText?: string | undefined; - scopes?: Array | undefined; - /** - * Raw/canonical value of the operator. Only applies when result is an operator value. - */ - value?: string | undefined; - /** - * Human readable value of the operator that can be shown to the user. Only applies when result is an operator value. - */ - displayValue?: string | undefined; -}; - -declare function operatorMetadataFromJSON(jsonString: string): Result; - -declare function operatorMetadataToJSON(operatorMetadata: OperatorMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OperatorScope$ { - /** @deprecated use `OperatorScope$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OperatorScope$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OperatorScope$Outbound` instead. */ - type Outbound = OperatorScope$Outbound; -} - -/** @internal */ -declare const OperatorScope$inboundSchema: z.ZodType; - -/** @internal */ -declare type OperatorScope$Outbound = { - datasource?: string | undefined; - docType?: string | undefined; -}; - -/** @internal */ -declare const OperatorScope$outboundSchema: z.ZodType; - -declare type OperatorScope = { - datasource?: string | undefined; - docType?: string | undefined; -}; - -declare function operatorScopeFromJSON(jsonString: string): Result; - -declare function operatorScopeToJSON(operatorScope: OperatorScope): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OperatorType$ { - /** @deprecated use `OperatorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Double: "DOUBLE"; - readonly Date: "DATE"; - readonly User: "USER"; - }>; - /** @deprecated use `OperatorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Double: "DOUBLE"; - readonly Date: "DATE"; - readonly User: "USER"; - }>; -} - -/** @internal */ -declare const OperatorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const OperatorType$outboundSchema: z.ZodNativeEnum; - -declare const OperatorType: { - readonly Text: "TEXT"; - readonly Double: "DOUBLE"; - readonly Date: "DATE"; - readonly User: "USER"; -}; - -declare type OperatorType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OrderBy$ { - /** @deprecated use `OrderBy$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Asc: "ASC"; - readonly Desc: "DESC"; - }>; - /** @deprecated use `OrderBy$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Asc: "ASC"; - readonly Desc: "DESC"; - }>; -} - -/** @internal */ -declare const OrderBy$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const OrderBy$outboundSchema: z.ZodNativeEnum; - -declare const OrderBy: { - readonly Asc: "ASC"; - readonly Desc: "DESC"; -}; - -declare type OrderBy = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OutputSchema$ { - /** @deprecated use `OutputSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OutputSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OutputSchema$Outbound` instead. */ - type Outbound = OutputSchema$Outbound; -} - -/** @internal */ -declare const OutputSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type OutputSchema$Outbound = {}; - -/** @internal */ -declare const OutputSchema$outboundSchema: z.ZodType; - -/** - * The schema for the agent output. In JSON Schema format. - */ -declare type OutputSchema = {}; - -declare function outputSchemaFromJSON(jsonString: string): Result; - -declare function outputSchemaToJSON(outputSchema: OutputSchema): string; - -declare class People extends ClientSDK { - /** - * Beta: Get user information - * - * @remarks - * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. - * - * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - */ - debug(debugUserRequest: components.DebugUserRequest, datasource: string, options?: RequestOptions): Promise; - /** - * Get user count - * - * @remarks - * Fetches user count for the specified custom datasource. - * - * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - * - * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. - */ - count(request: components.GetUserCountRequest, options?: RequestOptions): Promise; - /** - * Index employee - * - * @remarks - * Adds an employee or updates information about an employee - */ - index(request: components.IndexEmployeeRequest, options?: RequestOptions): Promise; - /** - * Bulk index employees - * - * @remarks - * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndex(request: components.BulkIndexEmployeesRequest, options?: RequestOptions): Promise; - /** - * Schedules the processing of uploaded employees and teams - * - * @remarks - * Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand. - */ - processAllEmployeesAndTeams(options?: RequestOptions): Promise; - /** - * Delete employee - * - * @remarks - * Delete an employee. Silently succeeds if employee is not present. - */ - delete(request: components.DeleteEmployeeRequest, options?: RequestOptions): Promise; - /** - * Index team - * - * @remarks - * Adds a team or updates information about a team - */ - indexTeam(request: components.IndexTeamRequest, options?: RequestOptions): Promise; - /** - * Delete team - * - * @remarks - * Delete a team based on provided id. - */ - deleteTeam(request: components.DeleteTeamRequest, options?: RequestOptions): Promise; - /** - * Bulk index teams - * - * @remarks - * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndexTeams(request: components.BulkIndexTeamsRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PeopleRequest$ { - /** @deprecated use `PeopleRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PeopleRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PeopleRequest$Outbound` instead. */ - type Outbound = PeopleRequest$Outbound; -} - -/** @internal */ -declare const PeopleRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PeopleRequest$Outbound = { - timezoneOffset?: number | undefined; - obfuscatedIds?: Array | undefined; - emailIds?: Array | undefined; - includeFields?: Array | undefined; - includeTypes?: Array | undefined; - source?: string | undefined; -}; - -/** @internal */ -declare const PeopleRequest$outboundSchema: z.ZodType; - -declare type PeopleRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * The Person IDs to retrieve. If no IDs are requested, the current user's details are returned. - */ - obfuscatedIds?: Array | undefined; - /** - * The email IDs to retrieve. The result is the deduplicated union of emailIds and obfuscatedIds. - */ - emailIds?: Array | undefined; - /** - * List of PersonMetadata fields to return (that aren't returned by default) - */ - includeFields?: Array | undefined; - /** - * The types of people entities to include in the response in addition to those returned by default. - */ - includeTypes?: Array | undefined; - /** - * A string denoting the search surface from which the endpoint is called. - */ - source?: string | undefined; -}; - -declare function peopleRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PeopleRequestIncludeField$ { - /** @deprecated use `PeopleRequestIncludeField$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Badges: "BADGES"; - readonly BusyEvents: "BUSY_EVENTS"; - readonly DocumentActivity: "DOCUMENT_ACTIVITY"; - readonly InviteInfo: "INVITE_INFO"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly PeopleProfileSettings: "PEOPLE_PROFILE_SETTINGS"; - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; - }>; - /** @deprecated use `PeopleRequestIncludeField$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Badges: "BADGES"; - readonly BusyEvents: "BUSY_EVENTS"; - readonly DocumentActivity: "DOCUMENT_ACTIVITY"; - readonly InviteInfo: "INVITE_INFO"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly PeopleProfileSettings: "PEOPLE_PROFILE_SETTINGS"; - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; - }>; -} - -/** @internal */ -declare const PeopleRequestIncludeField$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const PeopleRequestIncludeField$outboundSchema: z.ZodNativeEnum; - -declare const PeopleRequestIncludeField: { - readonly Badges: "BADGES"; - readonly BusyEvents: "BUSY_EVENTS"; - readonly DocumentActivity: "DOCUMENT_ACTIVITY"; - readonly InviteInfo: "INVITE_INFO"; - readonly PeopleDistance: "PEOPLE_DISTANCE"; - readonly Permissions: "PERMISSIONS"; - readonly PeopleDetails: "PEOPLE_DETAILS"; - readonly ManagementDetails: "MANAGEMENT_DETAILS"; - readonly PeopleProfileSettings: "PEOPLE_PROFILE_SETTINGS"; - readonly PeopleWithoutManager: "PEOPLE_WITHOUT_MANAGER"; -}; - -declare type PeopleRequestIncludeField = ClosedEnum; - -declare function peopleRequestToJSON(peopleRequest: PeopleRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PeopleResponse$ { - /** @deprecated use `PeopleResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PeopleResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PeopleResponse$Outbound` instead. */ - type Outbound = PeopleResponse$Outbound; -} - -/** @internal */ -declare const PeopleResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type PeopleResponse$Outbound = { - results?: Array | undefined; - relatedDocuments?: Array | undefined; - errors?: Array | undefined; -}; - -/** @internal */ -declare const PeopleResponse$outboundSchema: z.ZodType; - -declare type PeopleResponse = { - /** - * A Person for each ID in the request, each with PersonMetadata populated. - */ - results?: Array | undefined; - /** - * A list of documents related to this people response. This is only included if DOCUMENT_ACTIVITY is requested and only 1 person is included in the request. - */ - relatedDocuments?: Array | undefined; - /** - * A list of IDs that could not be found. - */ - errors?: Array | undefined; -}; - -declare function peopleResponseFromJSON(jsonString: string): Result; - -declare function peopleResponseToJSON(peopleResponse: PeopleResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Period$ { - /** @deprecated use `Period$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Period$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Period$Outbound` instead. */ - type Outbound = Period$Outbound; -} - -/** @internal */ -declare const Period$inboundSchema: z.ZodType; - -/** @internal */ -declare type Period$Outbound = { - minDaysFromNow?: number | undefined; - maxDaysFromNow?: number | undefined; - start?: TimePoint$Outbound | undefined; - end?: TimePoint$Outbound | undefined; -}; - -/** @internal */ -declare const Period$outboundSchema: z.ZodType; - -declare type Period = { - /** - * DEPRECATED - The number of days from now in the past to define upper boundary of time period. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - minDaysFromNow?: number | undefined; - /** - * DEPRECATED - The number of days from now in the past to define lower boundary of time period. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - maxDaysFromNow?: number | undefined; - start?: TimePoint | undefined; - end?: TimePoint | undefined; -}; - -declare function periodFromJSON(jsonString: string): Result; - -declare function periodToJSON(period: Period): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Permissions$ { - /** @deprecated use `Permissions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Permissions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Permissions$Outbound` instead. */ - type Outbound = Permissions$Outbound; -} - -/** @internal */ -declare const Permissions$inboundSchema: z.ZodType; - -/** @internal */ -declare type Permissions$Outbound = { - canAdminSearch?: boolean | undefined; - canAdminClientApiGlobalTokens?: boolean | undefined; - canDlp?: boolean | undefined; - read?: { - [k: string]: Array; - } | undefined; - write?: { - [k: string]: Array; - } | undefined; - grant?: { - [k: string]: Array; - } | undefined; - role?: string | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const Permissions$outboundSchema: z.ZodType; - -/** - * Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. - * - * @remarks - * When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes. - */ -declare type Permissions_2 = { - /** - * TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - */ - canAdminSearch?: boolean | undefined; - /** - * TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - */ - canAdminClientApiGlobalTokens?: boolean | undefined; - /** - * TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - */ - canDlp?: boolean | undefined; - /** - * Describes the read permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - */ - read?: { - [k: string]: Array; - } | undefined; - /** - * Describes the write permissions levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - */ - write?: { - [k: string]: Array; - } | undefined; - /** - * Describes the grant permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - */ - grant?: { - [k: string]: Array; - } | undefined; - /** - * The roleId of the canonical role a user has. The displayName is equal to the roleId. - */ - role?: string | undefined; - /** - * The roleIds of the roles a user has. - */ - roles?: Array | undefined; -}; - -declare class Permissions_3 extends ClientSDK { - /** - * Update document permissions - * - * @remarks - * Updates the permissions for a given document without modifying document content. - */ - updatePermissions(request: components.UpdatePermissionsRequest, options?: RequestOptions): Promise; - /** - * Index user - * - * @remarks - * Adds a datasource user or updates an existing user. - */ - indexUser(request: components.IndexUserRequest, options?: RequestOptions): Promise; - /** - * Bulk index users - * - * @remarks - * Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndexUsers(request: components.BulkIndexUsersRequest, options?: RequestOptions): Promise; - /** - * Index group - * - * @remarks - * Add or update a group in the datasource. - */ - indexGroup(request: components.IndexGroupRequest, options?: RequestOptions): Promise; - /** - * Bulk index groups - * - * @remarks - * Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndexGroups(request: components.BulkIndexGroupsRequest, options?: RequestOptions): Promise; - /** - * Index membership - * - * @remarks - * Add the memberships of a group in the datasource. - */ - indexMembership(request: components.IndexMembershipRequest, options?: RequestOptions): Promise; - /** - * Bulk index memberships for a group - * - * @remarks - * Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - */ - bulkIndexMemberships(request: components.BulkIndexMembershipsRequest, options?: RequestOptions): Promise; - /** - * Schedules the processing of group memberships - * - * @remarks - * Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand. - */ - processMemberships(request?: components.ProcessAllMembershipsRequest | undefined, options?: RequestOptions): Promise; - /** - * Delete user - * - * @remarks - * Delete the user from the datasource. Silently succeeds if user is not present. - */ - deleteUser(request: components.DeleteUserRequest, options?: RequestOptions): Promise; - /** - * Delete group - * - * @remarks - * Delete group from the datasource. Silently succeeds if group is not present. - */ - deleteGroup(request: components.DeleteGroupRequest, options?: RequestOptions): Promise; - /** - * Delete membership - * - * @remarks - * Delete membership to a group in the specified datasource. Silently succeeds if membership is not present. - */ - deleteMembership(request: components.DeleteMembershipRequest, options?: RequestOptions): Promise; - /** - * Beta users - * - * @remarks - * Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled. - */ - authorizeBetaUsers(request: components.GreenlistUsersRequest, options?: RequestOptions): Promise; -} - -declare function permissionsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PermissionsGroupIntersectionDefinition$ { - /** @deprecated use `PermissionsGroupIntersectionDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PermissionsGroupIntersectionDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PermissionsGroupIntersectionDefinition$Outbound` instead. */ - type Outbound = PermissionsGroupIntersectionDefinition$Outbound; -} - -/** @internal */ -declare const PermissionsGroupIntersectionDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type PermissionsGroupIntersectionDefinition$Outbound = { - requiredGroups?: Array | undefined; -}; - -/** @internal */ -declare const PermissionsGroupIntersectionDefinition$outboundSchema: z.ZodType; - -/** - * describes a list of groups that are all required in a permissions constraint - */ -declare type PermissionsGroupIntersectionDefinition = { - requiredGroups?: Array | undefined; -}; - -declare function permissionsGroupIntersectionDefinitionFromJSON(jsonString: string): Result; - -declare function permissionsGroupIntersectionDefinitionToJSON(permissionsGroupIntersectionDefinition: PermissionsGroupIntersectionDefinition): string; - -declare function permissionsToJSON(permissions: Permissions_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Person$ { - /** @deprecated use `Person$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Person$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Person$Outbound` instead. */ - type Outbound = Person$Outbound; -} - -/** @internal */ -declare const Person$inboundSchema: z.ZodType; - -/** @internal */ -declare type Person$Outbound = { - name: string; - obfuscatedId: string; - relatedDocuments?: Array | undefined; - metadata?: PersonMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const Person$outboundSchema: z.ZodType; - -declare type Person = { - /** - * The display name. - */ - name: string; - /** - * An opaque identifier that can be used to request metadata for a Person. - */ - obfuscatedId: string; - /** - * A list of documents related to this person. - */ - relatedDocuments?: Array | undefined; - metadata?: PersonMetadata | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonDistance$ { - /** @deprecated use `PersonDistance$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PersonDistance$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PersonDistance$Outbound` instead. */ - type Outbound = PersonDistance$Outbound; -} - -/** @internal */ -declare const PersonDistance$inboundSchema: z.ZodType; - -/** @internal */ -declare type PersonDistance$Outbound = { - name: string; - obfuscatedId: string; - distance: number; -}; - -/** @internal */ -declare const PersonDistance$outboundSchema: z.ZodType; - -declare type PersonDistance = { - /** - * The display name. - */ - name: string; - /** - * An opaque identifier that can be used to request metadata for a Person. - */ - obfuscatedId: string; - /** - * Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - */ - distance: number; -}; - -declare function personDistanceFromJSON(jsonString: string): Result; - -declare function personDistanceToJSON(personDistance: PersonDistance): string; - -declare function personFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonMetadata$ { - /** @deprecated use `PersonMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PersonMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PersonMetadata$Outbound` instead. */ - type Outbound = PersonMetadata$Outbound; -} - -/** @internal */ -declare const PersonMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type PersonMetadata$Outbound = { - type?: string | undefined; - firstName?: string | undefined; - lastName?: string | undefined; - title?: string | undefined; - businessUnit?: string | undefined; - department?: string | undefined; - teams?: Array | undefined; - departmentCount?: number | undefined; - email?: string | undefined; - aliasEmails?: Array | undefined; - location?: string | undefined; - structuredLocation?: StructuredLocation$Outbound | undefined; - externalProfileLink?: string | undefined; - manager?: Person$Outbound | undefined; - managementChain?: Array | undefined; - phone?: string | undefined; - timezone?: string | undefined; - timezoneOffset?: number | undefined; - photoUrl?: string | undefined; - uneditedPhotoUrl?: string | undefined; - bannerUrl?: string | undefined; - reports?: Array | undefined; - startDate?: string | undefined; - endDate?: string | undefined; - bio?: string | undefined; - pronoun?: string | undefined; - orgSizeCount?: number | undefined; - directReportsCount?: number | undefined; - preferredName?: string | undefined; - socialNetwork?: Array | undefined; - datasourceProfile?: Array | undefined; - querySuggestions?: QuerySuggestionList$Outbound | undefined; - peopleDistance?: Array | undefined; - inviteInfo?: InviteInfo$Outbound | undefined; - isSignedUp?: boolean | undefined; - lastExtensionUse?: string | undefined; - permissions?: Permissions$Outbound | undefined; - customFields?: Array | undefined; - loggingId?: string | undefined; - startDatePercentile?: number | undefined; - busyEvents?: Array | undefined; - profileBoolSettings?: { - [k: string]: boolean; - } | undefined; - badges?: Array | undefined; - isOrgRoot?: boolean | undefined; -}; - -/** @internal */ -declare const PersonMetadata$outboundSchema: z.ZodType; - -declare type PersonMetadata = { - type?: PersonMetadataType | undefined; - /** - * The first name of the person - */ - firstName?: string | undefined; - /** - * The last name of the person - */ - lastName?: string | undefined; - /** - * Job title. - */ - title?: string | undefined; - /** - * Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - */ - businessUnit?: string | undefined; - /** - * An organizational unit where everyone has a similar task, e.g. `Engineering`. - */ - department?: string | undefined; - /** - * Info about the employee's team(s). - */ - teams?: Array | undefined; - /** - * The number of people in this person's department. - */ - departmentCount?: number | undefined; - /** - * The user's primary email address - */ - email?: string | undefined; - /** - * Additional email addresses of this user beyond the primary, if any. - */ - aliasEmails?: Array | undefined; - /** - * User facing string representing the person's location. - */ - location?: string | undefined; - /** - * Detailed location with information about country, state, city etc. - */ - structuredLocation?: StructuredLocation | undefined; - /** - * Link to a customer's internal profile page. This is set to '#' when no link is desired. - */ - externalProfileLink?: string | undefined; - manager?: Person | undefined; - /** - * The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - */ - managementChain?: Array | undefined; - /** - * Phone number as a number string. - */ - phone?: string | undefined; - /** - * The timezone of the person. E.g. "Pacific Daylight Time". - */ - timezone?: string | undefined; - /** - * The offset of the person's timezone in seconds from UTC. - */ - timezoneOffset?: number | undefined; - /** - * The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - */ - photoUrl?: string | undefined; - /** - * The original photo URL of the person's avatar before any edits they made are applied - */ - uneditedPhotoUrl?: string | undefined; - /** - * The URL of the person's banner photo. - */ - bannerUrl?: string | undefined; - reports?: Array | undefined; - /** - * The date when the employee started. - */ - startDate?: RFCDate | undefined; - /** - * If a former employee, the last date of employment. - */ - endDate?: RFCDate | undefined; - /** - * Short biography or mission statement of the employee. - */ - bio?: string | undefined; - /** - * She/her, He/his or other pronoun. - */ - pronoun?: string | undefined; - /** - * The total recursive size of the people reporting to this person, or 1 - */ - orgSizeCount?: number | undefined; - /** - * The total number of people who directly report to this person, or 0 - */ - directReportsCount?: number | undefined; - /** - * The preferred name of the person, or a nickname. - */ - preferredName?: string | undefined; - /** - * List of social network profiles. - */ - socialNetwork?: Array | undefined; - /** - * List of profiles this user has in different datasources / tools that they use. - */ - datasourceProfile?: Array | undefined; - querySuggestions?: QuerySuggestionList | undefined; - /** - * List of people and distances to those people from this person. Optionally with metadata. - */ - peopleDistance?: Array | undefined; - /** - * Information regarding the invite status of a person. - */ - inviteInfo?: InviteInfo | undefined; - /** - * Whether the user has signed into Glean at least once. - */ - isSignedUp?: boolean | undefined; - /** - * The last time the user has used the Glean extension in ISO 8601 format. - */ - lastExtensionUse?: Date | undefined; - /** - * Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. - * - * @remarks - * When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes. - */ - permissions?: Permissions_2 | undefined; - /** - * User customizable fields for additional people information. - */ - customFields?: Array | undefined; - /** - * The logging id of the person used in scrubbed logs, tracking GA metrics. - */ - loggingId?: string | undefined; - /** - * Percentage of the company that started strictly after this person. Between [0,100). - */ - startDatePercentile?: number | undefined; - /** - * Intervals of busy time for this person, along with the type of event they're busy with. - */ - busyEvents?: Array | undefined; - /** - * flag settings to indicate user profile settings for certain items - */ - profileBoolSettings?: { - [k: string]: boolean; - } | undefined; - /** - * The badges that a user has earned over their lifetime. - */ - badges?: Array | undefined; - /** - * Whether this person is a "root" node in their organization's hierarchy. - */ - isOrgRoot?: boolean | undefined; -}; - -declare function personMetadataFromJSON(jsonString: string): Result; - -declare function personMetadataToJSON(personMetadata: PersonMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonMetadataType$ { - /** @deprecated use `PersonMetadataType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FullTime: "FULL_TIME"; - readonly Contractor: "CONTRACTOR"; - readonly NonEmployee: "NON_EMPLOYEE"; - readonly FormerEmployee: "FORMER_EMPLOYEE"; - }>; - /** @deprecated use `PersonMetadataType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FullTime: "FULL_TIME"; - readonly Contractor: "CONTRACTOR"; - readonly NonEmployee: "NON_EMPLOYEE"; - readonly FormerEmployee: "FORMER_EMPLOYEE"; - }>; -} - -/** @internal */ -declare const PersonMetadataType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const PersonMetadataType$outboundSchema: z.ZodNativeEnum; - -declare const PersonMetadataType: { - readonly FullTime: "FULL_TIME"; - readonly Contractor: "CONTRACTOR"; - readonly NonEmployee: "NON_EMPLOYEE"; - readonly FormerEmployee: "FORMER_EMPLOYEE"; -}; - -declare type PersonMetadataType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonObject$ { - /** @deprecated use `PersonObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PersonObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PersonObject$Outbound` instead. */ - type Outbound = PersonObject$Outbound; -} - -/** @internal */ -declare const PersonObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type PersonObject$Outbound = { - name: string; - obfuscatedId: string; -}; - -/** @internal */ -declare const PersonObject$outboundSchema: z.ZodType; - -declare type PersonObject = { - /** - * The display name. - */ - name: string; - /** - * An opaque identifier that can be used to request metadata for a Person. - */ - obfuscatedId: string; -}; - -declare function personObjectFromJSON(jsonString: string): Result; - -declare function personObjectToJSON(personObject: PersonObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonTeam$ { - /** @deprecated use `PersonTeam$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PersonTeam$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PersonTeam$Outbound` instead. */ - type Outbound = PersonTeam$Outbound; -} - -/** @internal */ -declare const PersonTeam$inboundSchema: z.ZodType; - -/** @internal */ -declare type PersonTeam$Outbound = { - id?: string | undefined; - name?: string | undefined; - externalLink?: string | undefined; - relationship: string; - joinDate?: string | undefined; -}; - -/** @internal */ -declare const PersonTeam$outboundSchema: z.ZodType; - -/** - * Use `id` if you index teams via Glean, and use `name` and `externalLink` if you want to use your own team pages - */ -declare type PersonTeam = { - /** - * Unique identifier - */ - id?: string | undefined; - /** - * Team name - */ - name?: string | undefined; - /** - * Link to a team page on the internet or your company's intranet - */ - externalLink?: string | undefined; - /** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ - relationship?: PersonTeamRelationship | undefined; - /** - * The team member's start date - */ - joinDate?: Date | undefined; -}; - -declare function personTeamFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonTeamRelationship$ { - /** @deprecated use `PersonTeamRelationship$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; - }>; - /** @deprecated use `PersonTeamRelationship$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; - }>; -} - -/** @internal */ -declare const PersonTeamRelationship$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const PersonTeamRelationship$outboundSchema: z.ZodNativeEnum; - -/** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ -declare const PersonTeamRelationship: { - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; -}; - -/** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ -declare type PersonTeamRelationship = ClosedEnum; - -declare function personTeamToJSON(personTeam: PersonTeam): string; - -declare function personToJSON(person: Person): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonToTeamRelationship$ { - /** @deprecated use `PersonToTeamRelationship$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PersonToTeamRelationship$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PersonToTeamRelationship$Outbound` instead. */ - type Outbound = PersonToTeamRelationship$Outbound; -} - -/** @internal */ -declare const PersonToTeamRelationship$inboundSchema: z.ZodType; - -/** @internal */ -declare type PersonToTeamRelationship$Outbound = { - person: Person$Outbound; - relationship: string; - customRelationshipStr?: string | undefined; - joinDate?: string | undefined; -}; - -/** @internal */ -declare const PersonToTeamRelationship$outboundSchema: z.ZodType; - -/** - * Metadata about the relationship of a person to a team. - */ -declare type PersonToTeamRelationship = { - person: Person; - /** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ - relationship?: PersonToTeamRelationshipRelationship | undefined; - /** - * Displayed name for the relationship if relationship is set to `OTHER`. - */ - customRelationshipStr?: string | undefined; - /** - * The team member's start date - */ - joinDate?: Date | undefined; -}; - -declare function personToTeamRelationshipFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PersonToTeamRelationshipRelationship$ { - /** @deprecated use `PersonToTeamRelationshipRelationship$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; - }>; - /** @deprecated use `PersonToTeamRelationshipRelationship$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; - }>; -} - -/** @internal */ -declare const PersonToTeamRelationshipRelationship$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const PersonToTeamRelationshipRelationship$outboundSchema: z.ZodNativeEnum; - -/** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ -declare const PersonToTeamRelationshipRelationship: { - readonly Member: "MEMBER"; - readonly Manager: "MANAGER"; - readonly Lead: "LEAD"; - readonly PointOfContact: "POINT_OF_CONTACT"; - readonly Other: "OTHER"; -}; - -/** - * The team member's relationship to the team. This defaults to MEMBER if not set. - */ -declare type PersonToTeamRelationshipRelationship = ClosedEnum; - -declare function personToTeamRelationshipToJSON(personToTeamRelationship: PersonToTeamRelationship): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PinDocument$ { - /** @deprecated use `PinDocument$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PinDocument$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PinDocument$Outbound` instead. */ - type Outbound = PinDocument$Outbound; -} - -/** @internal */ -declare const PinDocument$inboundSchema: z.ZodType; - -/** @internal */ -declare type PinDocument$Outbound = { - queries?: Array | undefined; - audienceFilters?: Array | undefined; - id?: string | undefined; - documentId: string; - attribution?: Person$Outbound | undefined; - updatedBy?: Person$Outbound | undefined; - createTime?: string | undefined; - updateTime?: string | undefined; -}; - -/** @internal */ -declare const PinDocument$outboundSchema: z.ZodType; - -declare type PinDocument = { - /** - * The query strings for which the pinned result will show. - */ - queries?: Array | undefined; - /** - * Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The opaque id of the pin. - */ - id?: string | undefined; - /** - * The document which should be a pinned result. - */ - documentId: string; - attribution?: Person | undefined; - updatedBy?: Person | undefined; - createTime?: Date | undefined; - updateTime?: Date | undefined; -}; - -declare function pinDocumentFromJSON(jsonString: string): Result; - -declare function pinDocumentToJSON(pinDocument: PinDocument): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PinRequest$ { - /** @deprecated use `PinRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PinRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PinRequest$Outbound` instead. */ - type Outbound = PinRequest$Outbound; -} - -/** @internal */ -declare const PinRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PinRequest$Outbound = { - queries?: Array | undefined; - audienceFilters?: Array | undefined; - documentId?: string | undefined; -}; - -/** @internal */ -declare const PinRequest$outboundSchema: z.ZodType; - -declare type PinRequest = { - /** - * The query strings for which the pinned result will show. - */ - queries?: Array | undefined; - /** - * Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The document to be pinned. - */ - documentId?: string | undefined; -}; - -declare function pinRequestFromJSON(jsonString: string): Result; - -declare function pinRequestToJSON(pinRequest: PinRequest): string; - -declare class Pins extends ClientSDK { - /** - * Update pin - * - * @remarks - * Update an existing user-generated pin. - */ - update(request: components.EditPinRequest, options?: RequestOptions): Promise; - /** - * Read pin - * - * @remarks - * Read pin details given its ID. - */ - retrieve(request: components.GetPinRequest, options?: RequestOptions): Promise; - /** - * List pins - * - * @remarks - * Lists all pins. - */ - list(request: operations.ListpinsRequest, options?: RequestOptions): Promise; - /** - * Create pin - * - * @remarks - * Pin a document as a result for a given search query.Pin results that are known to be a good match. - */ - create(request: components.PinRequest, options?: RequestOptions): Promise; - /** - * Delete pin - * - * @remarks - * Unpin a previously pinned result. - */ - remove(request: components.Unpin, options?: RequestOptions): Promise; -} - -declare class Policies extends ClientSDK { - /** - * Gets specified policy - * - * @remarks - * Fetches the specified policy version, or the latest if no version is provided. - */ - retrieve(id: string, version?: number | undefined, options?: RequestOptions): Promise; - /** - * Updates an existing policy - * - * @remarks - * Updates an existing policy. - */ - update(updateDlpReportRequest: components.UpdateDlpReportRequest, id: string, options?: RequestOptions): Promise; - /** - * Lists policies - * - * @remarks - * Lists policies with filtering. - */ - list(autoHide?: boolean | undefined, frequency?: string | undefined, options?: RequestOptions): Promise; - /** - * Creates new policy - * - * @remarks - * Creates a new policy with specified specifications and returns its id. - */ - create(request: components.CreateDlpReportRequest, options?: RequestOptions): Promise; - /** - * Downloads violations CSV for policy - * - * @remarks - * Downloads CSV violations report for a specific policy id. This does not support continuous policies. - */ - download(id: string, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PossibleValue$ { - /** @deprecated use `PossibleValue$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PossibleValue$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PossibleValue$Outbound` instead. */ - type Outbound = PossibleValue$Outbound; -} - -/** @internal */ -declare const PossibleValue$inboundSchema: z.ZodType; - -/** @internal */ -declare type PossibleValue$Outbound = { - value?: string | undefined; - label?: string | undefined; -}; - -/** @internal */ -declare const PossibleValue$outboundSchema: z.ZodType; - -/** - * Possible value of a specific parameter - */ -declare type PossibleValue = { - /** - * Possible value - */ - value?: string | undefined; - /** - * User-friendly label associated with the value - */ - label?: string | undefined; -}; - -declare function possibleValueFromJSON(jsonString: string): Result; - -declare function possibleValueToJSON(possibleValue: PossibleValue): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PostApiIndexV1DebugDatasourceDocumentRequest$ { - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentRequest$Outbound` instead. */ - type Outbound = PostApiIndexV1DebugDatasourceDocumentRequest$Outbound; -} - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceDocumentRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PostApiIndexV1DebugDatasourceDocumentRequest$Outbound = { - datasource: string; - DebugDocumentRequest: components.DebugDocumentRequest$Outbound; -}; - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceDocumentRequest$outboundSchema: z.ZodType; - -declare type PostApiIndexV1DebugDatasourceDocumentRequest = { - /** - * The datasource to which the document belongs - */ - datasource: string; - debugDocumentRequest: components.DebugDocumentRequest; -}; - -declare function postApiIndexV1DebugDatasourceDocumentRequestFromJSON(jsonString: string): Result; - -declare function postApiIndexV1DebugDatasourceDocumentRequestToJSON(postApiIndexV1DebugDatasourceDocumentRequest: PostApiIndexV1DebugDatasourceDocumentRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PostApiIndexV1DebugDatasourceDocumentsRequest$ { - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceDocumentsRequest$Outbound` instead. */ - type Outbound = PostApiIndexV1DebugDatasourceDocumentsRequest$Outbound; -} - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PostApiIndexV1DebugDatasourceDocumentsRequest$Outbound = { - datasource: string; - DebugDocumentsRequest: components.DebugDocumentsRequest$Outbound; -}; - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceDocumentsRequest$outboundSchema: z.ZodType; - -declare type PostApiIndexV1DebugDatasourceDocumentsRequest = { - /** - * The datasource to which the document belongs - */ - datasource: string; - debugDocumentsRequest: components.DebugDocumentsRequest; -}; - -declare function postApiIndexV1DebugDatasourceDocumentsRequestFromJSON(jsonString: string): Result; - -declare function postApiIndexV1DebugDatasourceDocumentsRequestToJSON(postApiIndexV1DebugDatasourceDocumentsRequest: PostApiIndexV1DebugDatasourceDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PostApiIndexV1DebugDatasourceStatusRequest$ { - /** @deprecated use `PostApiIndexV1DebugDatasourceStatusRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceStatusRequest$Outbound` instead. */ - type Outbound = PostApiIndexV1DebugDatasourceStatusRequest$Outbound; -} - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceStatusRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PostApiIndexV1DebugDatasourceStatusRequest$Outbound = { - datasource: string; -}; - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceStatusRequest$outboundSchema: z.ZodType; - -declare type PostApiIndexV1DebugDatasourceStatusRequest = { - /** - * The datasource to get debug status for. - */ - datasource: string; -}; - -declare function postApiIndexV1DebugDatasourceStatusRequestFromJSON(jsonString: string): Result; - -declare function postApiIndexV1DebugDatasourceStatusRequestToJSON(postApiIndexV1DebugDatasourceStatusRequest: PostApiIndexV1DebugDatasourceStatusRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PostApiIndexV1DebugDatasourceUserRequest$ { - /** @deprecated use `PostApiIndexV1DebugDatasourceUserRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceUserRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PostApiIndexV1DebugDatasourceUserRequest$Outbound` instead. */ - type Outbound = PostApiIndexV1DebugDatasourceUserRequest$Outbound; -} - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceUserRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type PostApiIndexV1DebugDatasourceUserRequest$Outbound = { - datasource: string; - DebugUserRequest: components.DebugUserRequest$Outbound; -}; - -/** @internal */ -declare const PostApiIndexV1DebugDatasourceUserRequest$outboundSchema: z.ZodType; - -declare type PostApiIndexV1DebugDatasourceUserRequest = { - /** - * The datasource to which the user belongs - */ - datasource: string; - debugUserRequest: components.DebugUserRequest; -}; - -declare function postApiIndexV1DebugDatasourceUserRequestFromJSON(jsonString: string): Result; - -declare function postApiIndexV1DebugDatasourceUserRequestToJSON(postApiIndexV1DebugDatasourceUserRequest: PostApiIndexV1DebugDatasourceUserRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessAllDocumentsRequest$ { - /** @deprecated use `ProcessAllDocumentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessAllDocumentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessAllDocumentsRequest$Outbound` instead. */ - type Outbound = ProcessAllDocumentsRequest$Outbound; -} - -/** @internal */ -declare const ProcessAllDocumentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessAllDocumentsRequest$Outbound = { - datasource?: string | undefined; -}; - -/** @internal */ -declare const ProcessAllDocumentsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /processalldocuments API call - */ -declare type ProcessAllDocumentsRequest = { - /** - * If provided, process documents only for this custom datasource. Otherwise all uploaded documents are processed. - */ - datasource?: string | undefined; -}; - -declare function processAllDocumentsRequestFromJSON(jsonString: string): Result; - -declare function processAllDocumentsRequestToJSON(processAllDocumentsRequest: ProcessAllDocumentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessAllMembershipsRequest$ { - /** @deprecated use `ProcessAllMembershipsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessAllMembershipsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessAllMembershipsRequest$Outbound` instead. */ - type Outbound = ProcessAllMembershipsRequest$Outbound; -} - -/** @internal */ -declare const ProcessAllMembershipsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessAllMembershipsRequest$Outbound = { - datasource?: string | undefined; -}; - -/** @internal */ -declare const ProcessAllMembershipsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /processallmemberships API call - */ -declare type ProcessAllMembershipsRequest = { - /** - * If provided, process group memberships only for this custom datasource. Otherwise all uploaded memberships are processed. - */ - datasource?: string | undefined; -}; - -declare function processAllMembershipsRequestFromJSON(jsonString: string): Result; - -declare function processAllMembershipsRequestToJSON(processAllMembershipsRequest: ProcessAllMembershipsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessingHistoryEvent$ { - /** @deprecated use `ProcessingHistoryEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessingHistoryEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessingHistoryEvent$Outbound` instead. */ - type Outbound = ProcessingHistoryEvent$Outbound; -} - -/** @internal */ -declare const ProcessingHistoryEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessingHistoryEvent$Outbound = { - startTime?: string | undefined; - endTime?: string | undefined; -}; - -/** @internal */ -declare const ProcessingHistoryEvent$outboundSchema: z.ZodType; - -/** - * Processing history event for a datasource - */ -declare type ProcessingHistoryEvent = { - /** - * The start time of the processing in ISO 8601 format - */ - startTime?: string | undefined; - /** - * The end time of the processing in ISO 8601 format, 'NA' if still in progress - */ - endTime?: string | undefined; -}; - -declare function processingHistoryEventFromJSON(jsonString: string): Result; - -declare function processingHistoryEventToJSON(processingHistoryEvent: ProcessingHistoryEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessingState$ { - /** @deprecated use `ProcessingState$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Unavailable: "UNAVAILABLE"; - readonly UploadStarted: "UPLOAD STARTED"; - readonly UploadInProgress: "UPLOAD IN PROGRESS"; - readonly UploadCompleted: "UPLOAD COMPLETED"; - readonly DeletionPaused: "DELETION PAUSED"; - readonly IndexingCompleted: "INDEXING COMPLETED"; - }>; - /** @deprecated use `ProcessingState$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Unavailable: "UNAVAILABLE"; - readonly UploadStarted: "UPLOAD STARTED"; - readonly UploadInProgress: "UPLOAD IN PROGRESS"; - readonly UploadCompleted: "UPLOAD COMPLETED"; - readonly DeletionPaused: "DELETION PAUSED"; - readonly IndexingCompleted: "INDEXING COMPLETED"; - }>; -} - -/** @internal */ -declare const ProcessingState$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ProcessingState$outboundSchema: z.ZodNativeEnum; - -/** - * The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED - */ -declare const ProcessingState: { - readonly Unavailable: "UNAVAILABLE"; - readonly UploadStarted: "UPLOAD STARTED"; - readonly UploadInProgress: "UPLOAD IN PROGRESS"; - readonly UploadCompleted: "UPLOAD COMPLETED"; - readonly DeletionPaused: "DELETION PAUSED"; - readonly IndexingCompleted: "INDEXING COMPLETED"; -}; - -/** - * The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED - */ -declare type ProcessingState = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Prominence$ { - /** @deprecated use `Prominence$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; - }>; - /** @deprecated use `Prominence$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; - }>; -} - -/** @internal */ -declare const Prominence$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Prominence$outboundSchema: z.ZodNativeEnum; - -/** - * The level of visual distinction that should be given to a result. - */ -declare const Prominence: { - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; -}; - -/** - * The level of visual distinction that should be given to a result. - */ -declare type Prominence = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PromptTemplate$ { - /** @deprecated use `PromptTemplate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PromptTemplate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PromptTemplate$Outbound` instead. */ - type Outbound = PromptTemplate$Outbound; -} - -/** @internal */ -declare const PromptTemplate$inboundSchema: z.ZodType; - -/** @internal */ -declare type PromptTemplate$Outbound = { - name?: string | undefined; - template: string; - applicationId?: string | undefined; - inclusions?: ChatRestrictionFilters$Outbound | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id?: string | undefined; - author?: Person$Outbound | undefined; - createTimestamp?: number | undefined; - lastUpdateTimestamp?: number | undefined; - lastUpdatedBy?: Person$Outbound | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const PromptTemplate$outboundSchema: z.ZodType; - -declare type PromptTemplate = { - /** - * The user-given identifier for this prompt template. - */ - name?: string | undefined; - /** - * The actual template string. - */ - template: string; - /** - * The Application Id the prompt template should be created under. Empty for default assistant. - */ - applicationId?: string | undefined; - inclusions?: ChatRestrictionFilters | undefined; - /** - * A list of added user roles for the Workflow. - */ - addedRoles?: Array | undefined; - /** - * A list of removed user roles for the Workflow. - */ - removedRoles?: Array | undefined; - permissions?: ObjectPermissions | undefined; - /** - * Opaque id for this prompt template - */ - id?: string | undefined; - author?: Person | undefined; - /** - * Server Unix timestamp of the creation time. - */ - createTimestamp?: number | undefined; - /** - * Server Unix timestamp of the last update time. - */ - lastUpdateTimestamp?: number | undefined; - lastUpdatedBy?: Person | undefined; - /** - * A list of roles for this prompt template explicitly granted. - */ - roles?: Array | undefined; -}; - -declare function promptTemplateFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PromptTemplateResult$ { - /** @deprecated use `PromptTemplateResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PromptTemplateResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PromptTemplateResult$Outbound` instead. */ - type Outbound = PromptTemplateResult$Outbound; -} - -/** @internal */ -declare const PromptTemplateResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type PromptTemplateResult$Outbound = { - promptTemplate?: PromptTemplate$Outbound | undefined; - trackingToken?: string | undefined; - favoriteInfo?: FavoriteInfo$Outbound | undefined; - runCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const PromptTemplateResult$outboundSchema: z.ZodType; - -declare type PromptTemplateResult = { - promptTemplate?: PromptTemplate | undefined; - /** - * An opaque token that represents this prompt template - */ - trackingToken?: string | undefined; - favoriteInfo?: FavoriteInfo | undefined; - runCount?: CountInfo | undefined; -}; - -declare function promptTemplateResultFromJSON(jsonString: string): Result; - -declare function promptTemplateResultToJSON(promptTemplateResult: PromptTemplateResult): string; - -declare function promptTemplateToJSON(promptTemplate: PromptTemplate): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PropertyDefinition$ { - /** @deprecated use `PropertyDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PropertyDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PropertyDefinition$Outbound` instead. */ - type Outbound = PropertyDefinition$Outbound; -} - -/** @internal */ -declare const PropertyDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type PropertyDefinition$Outbound = { - name?: string | undefined; - displayLabel?: string | undefined; - displayLabelPlural?: string | undefined; - propertyType?: string | undefined; - uiOptions?: string | undefined; - hideUiFacet?: boolean | undefined; - uiFacetOrder?: number | undefined; - skipIndexing?: boolean | undefined; - group?: string | undefined; -}; - -/** @internal */ -declare const PropertyDefinition$outboundSchema: z.ZodType; - -declare type PropertyDefinition_2 = { - /** - * The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. - */ - name?: string | undefined; - /** - * The user friendly label for the property. - */ - displayLabel?: string | undefined; - /** - * The user friendly label for the property that will be used if a plural context. - */ - displayLabelPlural?: string | undefined; - /** - * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. - */ - propertyType?: PropertyType | undefined; - uiOptions?: UiOptions | undefined; - /** - * If true then the property will not show up as a facet in the UI. - */ - hideUiFacet?: boolean | undefined; - /** - * Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. - */ - uiFacetOrder?: number | undefined; - /** - * If true then the property will not be indexed for retrieval and ranking. - */ - skipIndexing?: boolean | undefined; - /** - * The unique identifier of the `PropertyGroup` to which this property belongs. - */ - group?: string | undefined; -}; - -declare function propertyDefinitionFromJSON(jsonString: string): Result; - -declare function propertyDefinitionToJSON(propertyDefinition: PropertyDefinition_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PropertyGroup$ { - /** @deprecated use `PropertyGroup$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PropertyGroup$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PropertyGroup$Outbound` instead. */ - type Outbound = PropertyGroup$Outbound; -} - -/** @internal */ -declare const PropertyGroup$inboundSchema: z.ZodType; - -/** @internal */ -declare type PropertyGroup$Outbound = { - name?: string | undefined; - displayLabel?: string | undefined; -}; - -/** @internal */ -declare const PropertyGroup$outboundSchema: z.ZodType; - -/** - * A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI. - */ -declare type PropertyGroup = { - /** - * The unique identifier of the group. - */ - name?: string | undefined; - /** - * The user-friendly group label to display. - */ - displayLabel?: string | undefined; -}; - -declare function propertyGroupFromJSON(jsonString: string): Result; - -declare function propertyGroupToJSON(propertyGroup: PropertyGroup): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PropertyType$ { - /** @deprecated use `PropertyType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Date: "DATE"; - readonly Int: "INT"; - readonly Userid: "USERID"; - readonly Picklist: "PICKLIST"; - readonly Textlist: "TEXTLIST"; - readonly Multipicklist: "MULTIPICKLIST"; - }>; - /** @deprecated use `PropertyType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Date: "DATE"; - readonly Int: "INT"; - readonly Userid: "USERID"; - readonly Picklist: "PICKLIST"; - readonly Textlist: "TEXTLIST"; - readonly Multipicklist: "MULTIPICKLIST"; - }>; -} - -/** @internal */ -declare const PropertyType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const PropertyType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. - */ -declare const PropertyType: { - readonly Text: "TEXT"; - readonly Date: "DATE"; - readonly Int: "INT"; - readonly Userid: "USERID"; - readonly Picklist: "PICKLIST"; - readonly Textlist: "TEXTLIST"; - readonly Multipicklist: "MULTIPICKLIST"; -}; - -/** - * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. - */ -declare type PropertyType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Provider$ { - /** @deprecated use `Provider$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Zoom: "ZOOM"; - readonly Hangouts: "HANGOUTS"; - }>; - /** @deprecated use `Provider$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Zoom: "ZOOM"; - readonly Hangouts: "HANGOUTS"; - }>; -} - -/** @internal */ -declare const Provider$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Provider$outboundSchema: z.ZodNativeEnum; - -declare const Provider: { - readonly Zoom: "ZOOM"; - readonly Hangouts: "HANGOUTS"; -}; - -declare type Provider = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace QueryInsight$ { - /** @deprecated use `QueryInsight$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `QueryInsight$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `QueryInsight$Outbound` instead. */ - type Outbound = QueryInsight$Outbound; -} - -/** @internal */ -declare const QueryInsight$inboundSchema: z.ZodType; - -/** @internal */ -declare type QueryInsight$Outbound = { - query: string; - searchCount?: CountInfo$Outbound | undefined; - searchorCount?: CountInfo$Outbound | undefined; - searchWithClickCount?: CountInfo$Outbound | undefined; - clickCount?: CountInfo$Outbound | undefined; - similarQueries?: Array | undefined; -}; - -/** @internal */ -declare const QueryInsight$outboundSchema: z.ZodType; - -declare type QueryInsight = { - /** - * The query string the information is about. - */ - query: string; - searchCount?: CountInfo | undefined; - searchorCount?: CountInfo | undefined; - searchWithClickCount?: CountInfo | undefined; - clickCount?: CountInfo | undefined; - /** - * list of similar queries to current one. - */ - similarQueries?: Array | undefined; -}; - -declare function queryInsightFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace QueryInsightsResponse$ { - /** @deprecated use `QueryInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `QueryInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `QueryInsightsResponse$Outbound` instead. */ - type Outbound = QueryInsightsResponse$Outbound; -} - -/** @internal */ -declare const QueryInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type QueryInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - queryInsights?: Array | undefined; - lowPerformingQueryInsights?: Array | undefined; - departments?: Array | undefined; - minVisitorThreshold?: number | undefined; -}; - -/** @internal */ -declare const QueryInsightsResponse$outboundSchema: z.ZodType; - -declare type QueryInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - /** - * Insights for queries. - */ - queryInsights?: Array | undefined; - /** - * Insights for low performing queries without good results. - */ - lowPerformingQueryInsights?: Array | undefined; - /** - * list of departments applicable for queries tab. - */ - departments?: Array | undefined; - /** - * Min threshold in number of visitors while populating results, otherwise 0. - */ - minVisitorThreshold?: number | undefined; -}; - -declare function queryInsightsResponseFromJSON(jsonString: string): Result; - -declare function queryInsightsResponseToJSON(queryInsightsResponse: QueryInsightsResponse): string; - -declare function queryInsightToJSON(queryInsight: QueryInsight): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace QuerySuggestion$ { - /** @deprecated use `QuerySuggestion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `QuerySuggestion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `QuerySuggestion$Outbound` instead. */ - type Outbound = QuerySuggestion$Outbound; -} - -/** @internal */ -declare const QuerySuggestion$inboundSchema: z.ZodType; - -/** @internal */ -declare type QuerySuggestion$Outbound = { - missingTerm?: string | undefined; - query: string; - searchProviderInfo?: SearchProviderInfo$Outbound | undefined; - label?: string | undefined; - datasource?: string | undefined; - requestOptions?: SearchRequestOptions$Outbound | undefined; - ranges?: Array | undefined; - inputDetails?: SearchRequestInputDetails$Outbound | undefined; -}; - -/** @internal */ -declare const QuerySuggestion$outboundSchema: z.ZodType; - -declare type QuerySuggestion = { - /** - * A query term missing from the original query on which this suggestion is based. - */ - missingTerm?: string | undefined; - /** - * The query being suggested (e.g. enforcing the missing term from the original query). - */ - query: string; - searchProviderInfo?: SearchProviderInfo | undefined; - /** - * A user-facing description to display for the suggestion. - */ - label?: string | undefined; - /** - * The datasource associated with the suggestion. - */ - datasource?: string | undefined; - requestOptions?: SearchRequestOptions | undefined; - /** - * The bolded ranges within the query of the QuerySuggestion. - */ - ranges?: Array | undefined; - inputDetails?: SearchRequestInputDetails | undefined; -}; - -declare function querySuggestionFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace QuerySuggestionList$ { - /** @deprecated use `QuerySuggestionList$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `QuerySuggestionList$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `QuerySuggestionList$Outbound` instead. */ - type Outbound = QuerySuggestionList$Outbound; -} - -/** @internal */ -declare const QuerySuggestionList$inboundSchema: z.ZodType; - -/** @internal */ -declare type QuerySuggestionList$Outbound = { - suggestions?: Array | undefined; - person?: Person$Outbound | undefined; -}; - -/** @internal */ -declare const QuerySuggestionList$outboundSchema: z.ZodType; - -declare type QuerySuggestionList = { - suggestions?: Array | undefined; - person?: Person | undefined; -}; - -declare function querySuggestionListFromJSON(jsonString: string): Result; - -declare function querySuggestionListToJSON(querySuggestionList: QuerySuggestionList): string; - -declare function querySuggestionToJSON(querySuggestion: QuerySuggestion): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Quicklink$ { - /** @deprecated use `Quicklink$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Quicklink$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Quicklink$Outbound` instead. */ - type Outbound = Quicklink$Outbound; -} - -/** @internal */ -declare const Quicklink$inboundSchema: z.ZodType; - -/** @internal */ -declare type Quicklink$Outbound = { - name?: string | undefined; - shortName?: string | undefined; - url?: string | undefined; - iconConfig?: IconConfig$Outbound | undefined; - id?: string | undefined; - scopes?: Array | undefined; -}; - -/** @internal */ -declare const Quicklink$outboundSchema: z.ZodType; - -/** - * An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - */ -declare type Quicklink = { - /** - * Full action name. Used in autocomplete. - */ - name?: string | undefined; - /** - * Shortened name. Used in app cards. - */ - shortName?: string | undefined; - /** - * The URL of the action. - */ - url?: string | undefined; - /** - * Defines how to render an icon - */ - iconConfig?: IconConfig | undefined; - /** - * Unique identifier of this quicklink - */ - id?: string | undefined; - /** - * The scopes for which this quicklink is applicable - */ - scopes?: Array | undefined; -}; - -declare function quicklinkFromJSON(jsonString: string): Result; - -declare function quicklinkToJSON(quicklink: Quicklink): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Reaction$ { - /** @deprecated use `Reaction$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Reaction$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Reaction$Outbound` instead. */ - type Outbound = Reaction$Outbound; -} - -/** @internal */ -declare const Reaction$inboundSchema: z.ZodType; - -/** @internal */ -declare type Reaction$Outbound = { - type?: string | undefined; - count?: number | undefined; - reactors?: Array | undefined; - reactedByViewer?: boolean | undefined; -}; - -/** @internal */ -declare const Reaction$outboundSchema: z.ZodType; - -declare type Reaction = { - type?: string | undefined; - /** - * The count of the reaction type on the document. - */ - count?: number | undefined; - reactors?: Array | undefined; - /** - * Whether the user in context reacted with this type to the document. - */ - reactedByViewer?: boolean | undefined; -}; - -declare function reactionFromJSON(jsonString: string): Result; - -declare function reactionToJSON(reaction: Reaction): string; - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -declare function readableStreamToArrayBuffer(readable: ReadableStream): Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReadPermission$ { - /** @deprecated use `ReadPermission$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReadPermission$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReadPermission$Outbound` instead. */ - type Outbound = ReadPermission$Outbound; -} - -/** @internal */ -declare const ReadPermission$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReadPermission$Outbound = { - scopeType?: string | undefined; -}; - -/** @internal */ -declare const ReadPermission$outboundSchema: z.ZodType; - -/** - * Describes the read permission level that a user has for a specific feature - */ -declare type ReadPermission = { - /** - * Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - */ - scopeType?: ScopeType | undefined; -}; - -declare function readPermissionFromJSON(jsonString: string): Result; - -declare function readPermissionToJSON(readPermission: ReadPermission): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RecommendationsRequest$ { - /** @deprecated use `RecommendationsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RecommendationsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RecommendationsRequest$Outbound` instead. */ - type Outbound = RecommendationsRequest$Outbound; -} - -/** @internal */ -declare const RecommendationsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type RecommendationsRequest$Outbound = { - timestamp?: string | undefined; - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - sourceDocument?: Document$Outbound | undefined; - pageSize?: number | undefined; - maxSnippetSize?: number | undefined; - recommendationDocumentSpec?: DocumentSpecUnion$Outbound | undefined; - requestOptions?: RecommendationsRequestOptions$Outbound | undefined; -}; - -/** @internal */ -declare const RecommendationsRequest$outboundSchema: z.ZodType; - -declare type RecommendationsRequest = { - /** - * The ISO 8601 timestamp associated with the client request. - */ - timestamp?: Date | undefined; - /** - * A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - */ - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - sourceDocument?: Document_2 | undefined; - /** - * Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - */ - pageSize?: number | undefined; - /** - * Hint to the server about how many characters long a snippet may be. Server may return less or more. - */ - maxSnippetSize?: number | undefined; - recommendationDocumentSpec?: DocumentSpecUnion | undefined; - requestOptions?: RecommendationsRequestOptions | undefined; -}; - -declare function recommendationsRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RecommendationsRequestOptions$ { - /** @deprecated use `RecommendationsRequestOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RecommendationsRequestOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RecommendationsRequestOptions$Outbound` instead. */ - type Outbound = RecommendationsRequestOptions$Outbound; -} - -/** @internal */ -declare const RecommendationsRequestOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type RecommendationsRequestOptions$Outbound = { - datasourceFilter?: string | undefined; - datasourcesFilter?: Array | undefined; - facetFilterSets?: Array | undefined; - context?: Document$Outbound | undefined; - resultProminence?: Array | undefined; -}; - -/** @internal */ -declare const RecommendationsRequestOptions$outboundSchema: z.ZodType; - -declare type RecommendationsRequestOptions = { - /** - * Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - */ - datasourceFilter?: string | undefined; - /** - * Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). All results are returned if missing. - */ - datasourcesFilter?: Array | undefined; - /** - * A list of facet filter sets that will be OR'ed together. - */ - facetFilterSets?: Array | undefined; - context?: Document_2 | undefined; - /** - * The types of prominence wanted in results returned. Default is any type. - */ - resultProminence?: Array | undefined; -}; - -declare function recommendationsRequestOptionsFromJSON(jsonString: string): Result; - -declare function recommendationsRequestOptionsToJSON(recommendationsRequestOptions: RecommendationsRequestOptions): string; - -declare function recommendationsRequestToJSON(recommendationsRequest: RecommendationsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceRange$ { - /** @deprecated use `ReferenceRange$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReferenceRange$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReferenceRange$Outbound` instead. */ - type Outbound = ReferenceRange$Outbound; -} - -/** @internal */ -declare const ReferenceRange$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReferenceRange$Outbound = { - textRange?: TextRange$Outbound | undefined; - snippets?: Array | undefined; -}; - -/** @internal */ -declare const ReferenceRange$outboundSchema: z.ZodType; - -/** - * Each text range from the response can correspond to an array of snippets from the citation source. - */ -declare type ReferenceRange = { - /** - * A subsection of a given string to which some special formatting should be applied. - */ - textRange?: TextRange | undefined; - snippets?: Array | undefined; -}; - -declare function referenceRangeFromJSON(jsonString: string): Result; - -declare function referenceRangeToJSON(referenceRange: ReferenceRange): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelatedDocuments$ { - /** @deprecated use `RelatedDocuments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RelatedDocuments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RelatedDocuments$Outbound` instead. */ - type Outbound = RelatedDocuments$Outbound; -} - -/** @internal */ -declare const RelatedDocuments$inboundSchema: z.ZodType; - -/** @internal */ -declare type RelatedDocuments$Outbound = { - relation?: string | undefined; - associatedEntityId?: string | undefined; - querySuggestion?: QuerySuggestion$Outbound | undefined; - documents?: Array | undefined; - results?: Array | undefined; -}; - -/** @internal */ -declare const RelatedDocuments$outboundSchema: z.ZodType; - -declare type RelatedDocuments = { - /** - * How this document relates to the including entity. - */ - relation?: Relation | undefined; - /** - * Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - */ - associatedEntityId?: string | undefined; - querySuggestion?: QuerySuggestion | undefined; - /** - * A truncated list of documents with this relation. TO BE DEPRECATED. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - documents?: Array | undefined; - /** - * A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - */ - results?: Array | undefined; -}; - -declare function relatedDocumentsFromJSON(jsonString: string): Result; - -declare function relatedDocumentsToJSON(relatedDocuments: RelatedDocuments): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelatedObject$ { - /** @deprecated use `RelatedObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RelatedObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RelatedObject$Outbound` instead. */ - type Outbound = RelatedObject$Outbound; -} - -/** @internal */ -declare const RelatedObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type RelatedObject$Outbound = { - id: string; - metadata?: RelatedObjectMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const RelatedObject$outboundSchema: z.ZodType; - -declare type RelatedObject = { - /** - * The ID of the related object - */ - id: string; - /** - * Some metadata of the object which can be displayed, while not having the actual object. - */ - metadata?: RelatedObjectMetadata | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelatedObjectEdge$ { - /** @deprecated use `RelatedObjectEdge$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RelatedObjectEdge$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RelatedObjectEdge$Outbound` instead. */ - type Outbound = RelatedObjectEdge$Outbound; -} - -/** @internal */ -declare const RelatedObjectEdge$inboundSchema: z.ZodType; - -/** @internal */ -declare type RelatedObjectEdge$Outbound = { - objects?: Array | undefined; -}; - -/** @internal */ -declare const RelatedObjectEdge$outboundSchema: z.ZodType; - -declare type RelatedObjectEdge = { - objects?: Array | undefined; -}; - -declare function relatedObjectEdgeFromJSON(jsonString: string): Result; - -declare function relatedObjectEdgeToJSON(relatedObjectEdge: RelatedObjectEdge): string; - -declare function relatedObjectFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelatedObjectMetadata$ { - /** @deprecated use `RelatedObjectMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RelatedObjectMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RelatedObjectMetadata$Outbound` instead. */ - type Outbound = RelatedObjectMetadata$Outbound; -} - -/** @internal */ -declare const RelatedObjectMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type RelatedObjectMetadata$Outbound = { - name?: string | undefined; -}; - -/** @internal */ -declare const RelatedObjectMetadata$outboundSchema: z.ZodType; - -/** - * Some metadata of the object which can be displayed, while not having the actual object. - */ -declare type RelatedObjectMetadata = { - /** - * Placeholder name of the object, not the relationship. - */ - name?: string | undefined; -}; - -declare function relatedObjectMetadataFromJSON(jsonString: string): Result; - -declare function relatedObjectMetadataToJSON(relatedObjectMetadata: RelatedObjectMetadata): string; - -declare function relatedObjectToJSON(relatedObject: RelatedObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelatedQuestion$ { - /** @deprecated use `RelatedQuestion$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RelatedQuestion$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RelatedQuestion$Outbound` instead. */ - type Outbound = RelatedQuestion$Outbound; -} - -/** @internal */ -declare const RelatedQuestion$inboundSchema: z.ZodType; - -/** @internal */ -declare type RelatedQuestion$Outbound = { - question?: string | undefined; - answer?: string | undefined; - ranges?: Array | undefined; -}; - -/** @internal */ -declare const RelatedQuestion$outboundSchema: z.ZodType; - -declare type RelatedQuestion = { - /** - * The text of the related question - */ - question?: string | undefined; - /** - * The answer for the related question - */ - answer?: string | undefined; - /** - * Subsections of the answer string to which some special formatting should be applied (eg. bold) - */ - ranges?: Array | undefined; -}; - -declare function relatedQuestionFromJSON(jsonString: string): Result; - -declare function relatedQuestionToJSON(relatedQuestion: RelatedQuestion): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Relation$ { - /** @deprecated use `Relation$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Attachment: "ATTACHMENT"; - readonly Canonical: "CANONICAL"; - readonly Case: "CASE"; - readonly ContactLower: "contact"; - readonly ContactUpper: "CONTACT"; - readonly ConversationMessages: "CONVERSATION_MESSAGES"; - readonly Expert: "EXPERT"; - readonly From: "FROM"; - readonly Highlight: "HIGHLIGHT"; - readonly OpportunityLower: "opportunity"; - readonly OpportunityUpper: "OPPORTUNITY"; - readonly Recent: "RECENT"; - readonly Source: "SOURCE"; - readonly Ticket: "TICKET"; - readonly Transcript: "TRANSCRIPT"; - readonly With: "WITH"; - }>; - /** @deprecated use `Relation$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Attachment: "ATTACHMENT"; - readonly Canonical: "CANONICAL"; - readonly Case: "CASE"; - readonly ContactLower: "contact"; - readonly ContactUpper: "CONTACT"; - readonly ConversationMessages: "CONVERSATION_MESSAGES"; - readonly Expert: "EXPERT"; - readonly From: "FROM"; - readonly Highlight: "HIGHLIGHT"; - readonly OpportunityLower: "opportunity"; - readonly OpportunityUpper: "OPPORTUNITY"; - readonly Recent: "RECENT"; - readonly Source: "SOURCE"; - readonly Ticket: "TICKET"; - readonly Transcript: "TRANSCRIPT"; - readonly With: "WITH"; - }>; -} - -/** @internal */ -declare const Relation$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Relation$outboundSchema: z.ZodNativeEnum; - -/** - * How this document relates to the including entity. - */ -declare const Relation: { - readonly Attachment: "ATTACHMENT"; - readonly Canonical: "CANONICAL"; - readonly Case: "CASE"; - readonly ContactLower: "contact"; - readonly ContactUpper: "CONTACT"; - readonly ConversationMessages: "CONVERSATION_MESSAGES"; - readonly Expert: "EXPERT"; - readonly From: "FROM"; - readonly Highlight: "HIGHLIGHT"; - readonly OpportunityLower: "opportunity"; - readonly OpportunityUpper: "OPPORTUNITY"; - readonly Recent: "RECENT"; - readonly Source: "SOURCE"; - readonly Ticket: "TICKET"; - readonly Transcript: "TRANSCRIPT"; - readonly With: "WITH"; -}; - -/** - * How this document relates to the including entity. - */ -declare type Relation = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RelationType$ { - /** @deprecated use `RelationType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Equals: "EQUALS"; - readonly IdEquals: "ID_EQUALS"; - readonly Lt: "LT"; - readonly Gt: "GT"; - readonly NotEquals: "NOT_EQUALS"; - }>; - /** @deprecated use `RelationType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Equals: "EQUALS"; - readonly IdEquals: "ID_EQUALS"; - readonly Lt: "LT"; - readonly Gt: "GT"; - readonly NotEquals: "NOT_EQUALS"; - }>; -} - -/** @internal */ -declare const RelationType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const RelationType$outboundSchema: z.ZodNativeEnum; - -declare const RelationType: { - readonly Equals: "EQUALS"; - readonly IdEquals: "ID_EQUALS"; - readonly Lt: "LT"; - readonly Gt: "GT"; - readonly NotEquals: "NOT_EQUALS"; -}; - -declare type RelationType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Reminder$ { - /** @deprecated use `Reminder$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Reminder$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Reminder$Outbound` instead. */ - type Outbound = Reminder$Outbound; -} - -/** @internal */ -declare const Reminder$inboundSchema: z.ZodType; - -/** @internal */ -declare type Reminder$Outbound = { - assignee: Person$Outbound; - requestor?: Person$Outbound | undefined; - remindAt: number; - createdAt?: number | undefined; - reason?: string | undefined; -}; - -/** @internal */ -declare const Reminder$outboundSchema: z.ZodType; - -declare type Reminder = { - assignee: Person; - requestor?: Person | undefined; - /** - * Unix timestamp for when the reminder should trigger (in seconds since epoch UTC). - */ - remindAt: number; - /** - * Unix timestamp for when the reminder was first created (in seconds since epoch UTC). - */ - createdAt?: number | undefined; - /** - * An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - */ - reason?: string | undefined; -}; - -declare function reminderFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReminderRequest$ { - /** @deprecated use `ReminderRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReminderRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReminderRequest$Outbound` instead. */ - type Outbound = ReminderRequest$Outbound; -} - -/** @internal */ -declare const ReminderRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReminderRequest$Outbound = { - documentId: string; - assignee?: string | undefined; - remindInDays?: number | undefined; - reason?: string | undefined; -}; - -/** @internal */ -declare const ReminderRequest$outboundSchema: z.ZodType; - -declare type ReminderRequest = { - /** - * The document which the verification is for new reminders and/or update. - */ - documentId: string; - /** - * The obfuscated id of the person this verification is assigned to. - */ - assignee?: string | undefined; - /** - * Reminder for the next verifications in terms of days. For deletion, this will be omitted. - */ - remindInDays?: number | undefined; - /** - * An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - */ - reason?: string | undefined; -}; - -declare function reminderRequestFromJSON(jsonString: string): Result; - -declare function reminderRequestToJSON(reminderRequest: ReminderRequest): string; - -declare function reminderToJSON(reminder: Reminder): string; - -declare class Reports extends ClientSDK { - /** - * Creates new one-time report - * - * @remarks - * Creates a new one-time report and executes its batch job. - */ - create(request: components.UpdateDlpConfigRequest, options?: RequestOptions): Promise; - /** - * Downloads violations CSV for report - * - * @remarks - * Downloads CSV violations report for a specific report id. - */ - download(id: string, options?: RequestOptions): Promise; - /** - * Fetches report run status - * - * @remarks - * Fetches the status of the run corresponding to the report-id. - */ - status(id: string, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReportStatusResponse$ { - /** @deprecated use `ReportStatusResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReportStatusResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReportStatusResponse$Outbound` instead. */ - type Outbound = ReportStatusResponse$Outbound; -} - -/** @internal */ -declare const ReportStatusResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReportStatusResponse$Outbound = { - status?: string | undefined; - startTime?: string | undefined; -}; - -/** @internal */ -declare const ReportStatusResponse$outboundSchema: z.ZodType; - -declare type ReportStatusResponse = { - status?: ReportStatusResponseStatus | undefined; - /** - * The timestamp at which the report's run/scan began. - */ - startTime?: string | undefined; -}; - -declare function reportStatusResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReportStatusResponseStatus$ { - /** @deprecated use `ReportStatusResponseStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; - }>; - /** @deprecated use `ReportStatusResponseStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; - }>; -} - -/** @internal */ -declare const ReportStatusResponseStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ReportStatusResponseStatus$outboundSchema: z.ZodNativeEnum; - -declare const ReportStatusResponseStatus: { - readonly Pending: "PENDING"; - readonly Success: "SUCCESS"; - readonly Failure: "FAILURE"; - readonly Cancelled: "CANCELLED"; - readonly Cancelling: "CANCELLING"; - readonly Active: "ACTIVE"; -}; - -declare type ReportStatusResponseStatus = ClosedEnum; - -declare function reportStatusResponseToJSON(reportStatusResponse: ReportStatusResponse): string; - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -declare class RequestAbortedError extends HTTPClientError { - readonly name = "RequestAbortedError"; -} - -declare type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - userAgent?: string | undefined; - timeoutMs?: number; -}; - -declare type RequestErrorHook = (err: unknown, req: Request) => Awaitable; - -declare type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -declare type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * @deprecated `fetchOptions` has been flattened into `RequestOptions`. - * - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -} & Omit; - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -declare class RequestTimeoutError extends HTTPClientError { - readonly name = "RequestTimeoutError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RequestType$ { - /** @deprecated use `RequestType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Standard: "STANDARD"; - readonly FullDirectory: "FULL_DIRECTORY"; - }>; - /** @deprecated use `RequestType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Standard: "STANDARD"; - readonly FullDirectory: "FULL_DIRECTORY"; - }>; -} - -/** @internal */ -declare const RequestType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const RequestType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of request being made. - */ -declare const RequestType: { - readonly Standard: "STANDARD"; - readonly FullDirectory: "FULL_DIRECTORY"; -}; - -/** - * The type of request being made. - */ -declare type RequestType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseBody1$ { - /** @deprecated use `ResponseBody1$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseBody1$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseBody1$Outbound` instead. */ - type Outbound = ResponseBody1$Outbound; -} - -/** @internal */ -declare const ResponseBody1$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseBody1$Outbound = { - collection: components.Collection$Outbound; - error?: components.CollectionError$Outbound | undefined; -}; - -/** @internal */ -declare const ResponseBody1$outboundSchema: z.ZodType; - -declare type ResponseBody1 = { - collection: components.Collection; - error?: components.CollectionError | undefined; -}; - -declare function responseBody1FromJSON(jsonString: string): Result; - -declare function responseBody1ToJSON(responseBody1: ResponseBody1): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseBody2$ { - /** @deprecated use `ResponseBody2$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseBody2$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseBody2$Outbound` instead. */ - type Outbound = ResponseBody2$Outbound; -} - -/** @internal */ -declare const ResponseBody2$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseBody2$Outbound = { - collection?: components.Collection$Outbound | undefined; - error: components.CollectionError$Outbound; -}; - -/** @internal */ -declare const ResponseBody2$outboundSchema: z.ZodType; - -declare type ResponseBody2 = { - collection?: components.Collection | undefined; - error: components.CollectionError; -}; - -declare function responseBody2FromJSON(jsonString: string): Result; - -declare function responseBody2ToJSON(responseBody2: ResponseBody2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseHint$ { - /** @deprecated use `ResponseHint$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AllResultCounts: "ALL_RESULT_COUNTS"; - readonly FacetResults: "FACET_RESULTS"; - readonly QueryMetadata: "QUERY_METADATA"; - readonly Results: "RESULTS"; - readonly SpellcheckMetadata: "SPELLCHECK_METADATA"; - }>; - /** @deprecated use `ResponseHint$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AllResultCounts: "ALL_RESULT_COUNTS"; - readonly FacetResults: "FACET_RESULTS"; - readonly QueryMetadata: "QUERY_METADATA"; - readonly Results: "RESULTS"; - readonly SpellcheckMetadata: "SPELLCHECK_METADATA"; - }>; -} - -/** @internal */ -declare const ResponseHint$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseHint$outboundSchema: z.ZodNativeEnum; - -/** - * Hints for the response content. - */ -declare const ResponseHint: { - readonly AllResultCounts: "ALL_RESULT_COUNTS"; - readonly FacetResults: "FACET_RESULTS"; - readonly QueryMetadata: "QUERY_METADATA"; - readonly Results: "RESULTS"; - readonly SpellcheckMetadata: "SPELLCHECK_METADATA"; -}; - -/** - * Hints for the response content. - */ -declare type ResponseHint = ClosedEnum; - -declare type ResponseHook = (res: Response, req: Request) => Awaitable; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseMetadata$ { - /** @deprecated use `ResponseMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseMetadata$Outbound` instead. */ - type Outbound = ResponseMetadata$Outbound; -} - -/** @internal */ -declare const ResponseMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseMetadata$Outbound = { - latencyMs?: number | undefined; - tokenCount?: number | undefined; - modelUsed?: string | undefined; -}; - -/** @internal */ -declare const ResponseMetadata$outboundSchema: z.ZodType; - -/** - * Metadata about the response (e.g., latency, token count). - */ -declare type ResponseMetadata = { - /** - * Time taken to generate the response in milliseconds. - */ - latencyMs?: number | undefined; - /** - * Number of tokens in the response. - */ - tokenCount?: number | undefined; - /** - * The specific model version used. - */ - modelUsed?: string | undefined; -}; - -declare function responseMetadataFromJSON(jsonString: string): Result; - -declare function responseMetadataToJSON(responseMetadata: ResponseMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStatus$ { - /** @deprecated use `ResponseStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Accepted: "ACCEPTED"; - readonly Declined: "DECLINED"; - readonly NoResponse: "NO_RESPONSE"; - readonly Tentative: "TENTATIVE"; - }>; - /** @deprecated use `ResponseStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Accepted: "ACCEPTED"; - readonly Declined: "DECLINED"; - readonly NoResponse: "NO_RESPONSE"; - readonly Tentative: "TENTATIVE"; - }>; -} - -/** @internal */ -declare const ResponseStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseStatus$outboundSchema: z.ZodNativeEnum; - -declare const ResponseStatus: { - readonly Accepted: "ACCEPTED"; - readonly Declined: "DECLINED"; - readonly NoResponse: "NO_RESPONSE"; - readonly Tentative: "TENTATIVE"; -}; - -declare type ResponseStatus = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RestrictionFilters$ { - /** @deprecated use `RestrictionFilters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RestrictionFilters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RestrictionFilters$Outbound` instead. */ - type Outbound = RestrictionFilters$Outbound; -} - -/** @internal */ -declare const RestrictionFilters$inboundSchema: z.ZodType; - -/** @internal */ -declare type RestrictionFilters$Outbound = { - containerSpecs?: Array | undefined; -}; - -/** @internal */ -declare const RestrictionFilters$outboundSchema: z.ZodType; - -declare type RestrictionFilters = { - /** - * Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - */ - containerSpecs?: Array | undefined; -}; - -declare function restrictionFiltersFromJSON(jsonString: string): Result; - -declare function restrictionFiltersToJSON(restrictionFilters: RestrictionFilters): string; - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -declare type Result = { - ok: true; - value: T; - error?: never; -} | { - ok: false; - value?: never; - error: E; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResultDocument$ { - /** @deprecated use `ResultDocument$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResultDocument$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResultDocument$Outbound` instead. */ - type Outbound = ResultDocument$Outbound; -} - -/** @internal */ -declare const ResultDocument$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResultDocument$Outbound = { - title?: string | undefined; - url?: string | undefined; -}; - -/** @internal */ -declare const ResultDocument$outboundSchema: z.ZodType; - -declare type ResultDocument = { - title?: string | undefined; - url?: string | undefined; -}; - -declare function resultDocumentFromJSON(jsonString: string): Result; - -declare function resultDocumentToJSON(resultDocument: ResultDocument): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResultsDescription$ { - /** @deprecated use `ResultsDescription$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResultsDescription$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResultsDescription$Outbound` instead. */ - type Outbound = ResultsDescription$Outbound; -} - -/** @internal */ -declare const ResultsDescription$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResultsDescription$Outbound = { - text?: string | undefined; - iconConfig?: IconConfig$Outbound | undefined; -}; - -/** @internal */ -declare const ResultsDescription$outboundSchema: z.ZodType; - -declare type ResultsDescription = { - /** - * Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab. - */ - text?: string | undefined; - /** - * Defines how to render an icon - */ - iconConfig?: IconConfig | undefined; -}; - -declare function resultsDescriptionFromJSON(jsonString: string): Result; - -declare function resultsDescriptionToJSON(resultsDescription: ResultsDescription): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResultsResponse$ { - /** @deprecated use `ResultsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResultsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResultsResponse$Outbound` instead. */ - type Outbound = ResultsResponse$Outbound; -} - -/** @internal */ -declare const ResultsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResultsResponse$Outbound = { - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - results?: Array | undefined; - structuredResults?: Array | undefined; - generatedQnaResult?: GeneratedQna$Outbound | undefined; - errorInfo?: GleanDataError$Outbound | undefined; - requestID?: string | undefined; - backendTimeMillis?: number | undefined; -}; - -/** @internal */ -declare const ResultsResponse$outboundSchema: z.ZodType; - -declare type ResultsResponse = { - /** - * A token that should be passed for additional requests related to this request (such as more results requests). - */ - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - results?: Array | undefined; - structuredResults?: Array | undefined; - generatedQnaResult?: GeneratedQna | undefined; - gleanDataError?: GleanDataError | undefined; - /** - * A platform-generated request ID to correlate backend logs. - */ - requestID?: string | undefined; - /** - * Time in milliseconds the backend took to respond to the request. - */ - backendTimeMillis?: number | undefined; -}; - -declare function resultsResponseFromJSON(jsonString: string): Result; - -declare function resultsResponseToJSON(resultsResponse: ResultsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResultTab$ { - /** @deprecated use `ResultTab$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResultTab$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResultTab$Outbound` instead. */ - type Outbound = ResultTab$Outbound; -} - -/** @internal */ -declare const ResultTab$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResultTab$Outbound = { - id?: string | undefined; - count?: number | undefined; - datasource?: string | undefined; - datasourceInstance?: string | undefined; -}; - -/** @internal */ -declare const ResultTab$outboundSchema: z.ZodType; - -declare type ResultTab = { - /** - * The unique ID of the tab. Can be passed in a search request to get results for that tab. - */ - id?: string | undefined; - /** - * The number of results in this tab for the current query. - */ - count?: number | undefined; - /** - * The datasource associated with the tab, if any. - */ - datasource?: string | undefined; - /** - * The datasource instance associated with the tab, if any. - */ - datasourceInstance?: string | undefined; -}; - -declare function resultTabFromJSON(jsonString: string): Result; - -declare function resultTabToJSON(resultTab: ResultTab): string; - -declare type RetryConfig = { - strategy: "none"; -} | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; -}; - -declare class RFCDate { - private serialized; - /** - * Creates a new RFCDate instance using today's date. - */ - static today(): RFCDate; - /** - * Creates a new RFCDate instance using the provided input. - * If a string is used then in must be in the format YYYY-MM-DD. - * - * @param date A Date object or a date string in YYYY-MM-DD format - * @example - * new RFCDate("2022-01-01") - * @example - * new RFCDate(new Date()) - */ - constructor(date: Date | string); - toJSON(): string; - toString(): string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; - }>; - /** @deprecated use `Role$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; - }>; -} - -/** @internal */ -declare const Role$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Role$outboundSchema: z.ZodNativeEnum; - -/** - * DEPRECATED - use permissions instead. Viewer's role on the specific document. - * - * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. - */ -declare const Role: { - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; -}; - -/** - * DEPRECATED - use permissions instead. Viewer's role on the specific document. - * - * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. - */ -declare type Role = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RotateTokenResponse$ { - /** @deprecated use `RotateTokenResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RotateTokenResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RotateTokenResponse$Outbound` instead. */ - type Outbound = RotateTokenResponse$Outbound; -} - -/** @internal */ -declare const RotateTokenResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type RotateTokenResponse$Outbound = { - rawSecret?: string | undefined; - createdAt?: number | undefined; - rotationPeriodMinutes?: number | undefined; -}; - -/** @internal */ -declare const RotateTokenResponse$outboundSchema: z.ZodType; - -/** - * Describes the response body of the /rotatetoken API call - */ -declare type RotateTokenResponse = { - /** - * New raw secret - */ - rawSecret?: string | undefined; - /** - * Unix timestamp in seconds when the new secret value is assigned to the token. The token needs to be rotated before `rotationPeriodMinutes` past the createdAt timestamp otherwise it would be rendered unusable. - */ - createdAt?: number | undefined; - /** - * Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified `rotationPeriodMinutes` after each `/rotatetoken` call, otherwise the tokens would expire. Note that the token would still expire at `expiresAt` timestamp provided during token creation even if the token is being regularly rotated. `rotationPeriodMinutes` property is inherited from the parent token being rotated - */ - rotationPeriodMinutes?: number | undefined; -}; - -declare function rotateTokenResponseFromJSON(jsonString: string): Result; - -declare function rotateTokenResponseToJSON(rotateTokenResponse: RotateTokenResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Scope$ { - /** @deprecated use `Scope$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AppCard: "APP_CARD"; - readonly AutocompleteExactMatch: "AUTOCOMPLETE_EXACT_MATCH"; - readonly AutocompleteFuzzyMatch: "AUTOCOMPLETE_FUZZY_MATCH"; - readonly AutocompleteZeroQuery: "AUTOCOMPLETE_ZERO_QUERY"; - readonly NewTabPage: "NEW_TAB_PAGE"; - }>; - /** @deprecated use `Scope$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AppCard: "APP_CARD"; - readonly AutocompleteExactMatch: "AUTOCOMPLETE_EXACT_MATCH"; - readonly AutocompleteFuzzyMatch: "AUTOCOMPLETE_FUZZY_MATCH"; - readonly AutocompleteZeroQuery: "AUTOCOMPLETE_ZERO_QUERY"; - readonly NewTabPage: "NEW_TAB_PAGE"; - }>; -} - -/** @internal */ -declare const Scope$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Scope$outboundSchema: z.ZodNativeEnum; - -declare const Scope: { - readonly AppCard: "APP_CARD"; - readonly AutocompleteExactMatch: "AUTOCOMPLETE_EXACT_MATCH"; - readonly AutocompleteFuzzyMatch: "AUTOCOMPLETE_FUZZY_MATCH"; - readonly AutocompleteZeroQuery: "AUTOCOMPLETE_ZERO_QUERY"; - readonly NewTabPage: "NEW_TAB_PAGE"; -}; - -declare type Scope = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ScopeType$ { - /** @deprecated use `ScopeType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Global: "GLOBAL"; - readonly Own: "OWN"; - }>; - /** @deprecated use `ScopeType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Global: "GLOBAL"; - readonly Own: "OWN"; - }>; -} - -/** @internal */ -declare const ScopeType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ScopeType$outboundSchema: z.ZodNativeEnum; - -/** - * Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - */ -declare const ScopeType: { - readonly Global: "GLOBAL"; - readonly Own: "OWN"; -}; - -/** - * Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - */ -declare type ScopeType = ClosedEnum; - -export declare const SDK_METADATA: { - readonly language: "typescript"; - readonly openapiDocVersion: "0.9.0"; - readonly sdkVersion: "0.11.2"; - readonly genVersion: "2.720.1"; - readonly userAgent: "speakeasy-sdk/typescript 0.11.2 2.720.1 0.9.0 @gleanwork/api-client"; -}; - -declare class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[]; - beforeCreateRequestHooks: BeforeCreateRequestHook[]; - beforeRequestHooks: BeforeRequestHook_2[]; - afterSuccessHooks: AfterSuccessHook[]; - afterErrorHooks: AfterErrorHook[]; - constructor(); - registerSDKInitHook(hook: SDKInitHook): void; - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - registerAfterSuccessHook(hook: AfterSuccessHook): void; - registerAfterErrorHook(hook: AfterErrorHook): void; - sdkInit(opts: SDKInitOptions): SDKInitOptions; - beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput; - beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise; - afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise; - afterError(hookCtx: AfterErrorContext, response: Response | null, error: unknown): Promise<{ - response: Response | null; - error: unknown; - }>; -} - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -declare interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -declare type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export declare type SDKOptions = { - apiToken?: string | (() => Promise) | undefined; - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - serverIdx?: number | undefined; - /** - * Sets the instance variable for url substitution - */ - instance?: string | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default user agent used by the SDK - */ - userAgent?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -declare class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - readonly rawValue: unknown; - /** - * The raw message that failed validation. - */ - readonly rawMessage: unknown; - static [Symbol.hasInstance](instance: unknown): instance is SDKValidationError; - constructor(message: string, cause: unknown, rawValue: unknown); - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty(): string; -} - -declare class Search extends ClientSDK { - /** - * Search the index (admin) - * - * @remarks - * Retrieves results for search query without respect for permissions. This is available only to privileged users. - */ - queryAsAdmin(request: components.SearchRequest, options?: RequestOptions): Promise; - /** - * Autocomplete - * - * @remarks - * Retrieve query suggestions, operators and documents for the given partially typed query. - */ - autocomplete(request: components.AutocompleteRequest, options?: RequestOptions): Promise; - /** - * Feed of documents and events - * - * @remarks - * The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more. - */ - retrieveFeed(request: components.FeedRequest, options?: RequestOptions): Promise; - /** - * Recommend documents - * - * @remarks - * Retrieve recommended documents for the given URL or Glean Document ID. - */ - recommendations(request: components.RecommendationsRequest, options?: RequestOptions): Promise; - /** - * Search - * - * @remarks - * Retrieve results from the index for the given query and filters. - */ - query(request: components.SearchRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchAgentsRequest$ { - /** @deprecated use `SearchAgentsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchAgentsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchAgentsRequest$Outbound` instead. */ - type Outbound = SearchAgentsRequest$Outbound; -} - -/** @internal */ -declare const SearchAgentsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchAgentsRequest$Outbound = { - name?: string | undefined; -}; - -/** @internal */ -declare const SearchAgentsRequest$outboundSchema: z.ZodType; - -declare type SearchAgentsRequest = { - /** - * Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter. - */ - name?: string | undefined; -}; - -declare function searchAgentsRequestFromJSON(jsonString: string): Result; - -declare function searchAgentsRequestToJSON(searchAgentsRequest: SearchAgentsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchAgentsResponse$ { - /** @deprecated use `SearchAgentsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchAgentsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchAgentsResponse$Outbound` instead. */ - type Outbound = SearchAgentsResponse$Outbound; -} - -/** @internal */ -declare const SearchAgentsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchAgentsResponse$Outbound = { - agents?: Array | undefined; -}; - -/** @internal */ -declare const SearchAgentsResponse$outboundSchema: z.ZodType; - -declare type SearchAgentsResponse = { - agents?: Array | undefined; -}; - -declare function searchAgentsResponseFromJSON(jsonString: string): Result; - -declare function searchAgentsResponseToJSON(searchAgentsResponse: SearchAgentsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchProviderInfo$ { - /** @deprecated use `SearchProviderInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchProviderInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchProviderInfo$Outbound` instead. */ - type Outbound = SearchProviderInfo$Outbound; -} - -/** @internal */ -declare const SearchProviderInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchProviderInfo$Outbound = { - name?: string | undefined; - logoUrl?: string | undefined; - searchLinkUrlTemplate?: string | undefined; -}; - -/** @internal */ -declare const SearchProviderInfo$outboundSchema: z.ZodType; - -declare type SearchProviderInfo = { - /** - * Name of the search provider. - */ - name?: string | undefined; - /** - * URL to the provider's logo. - */ - logoUrl?: string | undefined; - /** - * URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion. - */ - searchLinkUrlTemplate?: string | undefined; -}; - -declare function searchProviderInfoFromJSON(jsonString: string): Result; - -declare function searchProviderInfoToJSON(searchProviderInfo: SearchProviderInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchRequest$ { - /** @deprecated use `SearchRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchRequest$Outbound` instead. */ - type Outbound = SearchRequest$Outbound; -} - -/** @internal */ -declare const SearchRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchRequest$Outbound = { - timestamp?: string | undefined; - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - sourceDocument?: Document$Outbound | undefined; - pageSize?: number | undefined; - maxSnippetSize?: number | undefined; - query: string; - cursor?: string | undefined; - resultTabIds?: Array | undefined; - inputDetails?: SearchRequestInputDetails$Outbound | undefined; - requestOptions?: SearchRequestOptions$Outbound | undefined; - timeoutMillis?: number | undefined; - disableSpellcheck?: boolean | undefined; -}; - -/** @internal */ -declare const SearchRequest$outboundSchema: z.ZodType; - -declare type SearchRequest = { - /** - * The ISO 8601 timestamp associated with the client request. - */ - timestamp?: Date | undefined; - /** - * A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - */ - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - sourceDocument?: Document_2 | undefined; - /** - * Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - */ - pageSize?: number | undefined; - /** - * Hint to the server about how many characters long a snippet may be. Server may return less or more. - */ - maxSnippetSize?: number | undefined; - /** - * The search terms. - */ - query: string; - /** - * Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - */ - cursor?: string | undefined; - /** - * The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict. - */ - resultTabIds?: Array | undefined; - inputDetails?: SearchRequestInputDetails | undefined; - requestOptions?: SearchRequestOptions | undefined; - /** - * Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - */ - timeoutMillis?: number | undefined; - /** - * Whether or not to disable spellcheck. - */ - disableSpellcheck?: boolean | undefined; -}; - -declare function searchRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchRequestInputDetails$ { - /** @deprecated use `SearchRequestInputDetails$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchRequestInputDetails$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchRequestInputDetails$Outbound` instead. */ - type Outbound = SearchRequestInputDetails$Outbound; -} - -/** @internal */ -declare const SearchRequestInputDetails$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchRequestInputDetails$Outbound = { - hasCopyPaste?: boolean | undefined; -}; - -/** @internal */ -declare const SearchRequestInputDetails$outboundSchema: z.ZodType; - -declare type SearchRequestInputDetails = { - /** - * Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - */ - hasCopyPaste?: boolean | undefined; -}; - -declare function searchRequestInputDetailsFromJSON(jsonString: string): Result; - -declare function searchRequestInputDetailsToJSON(searchRequestInputDetails: SearchRequestInputDetails): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchRequestOptions$ { - /** @deprecated use `SearchRequestOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchRequestOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchRequestOptions$Outbound` instead. */ - type Outbound = SearchRequestOptions$Outbound; -} - -/** @internal */ -declare const SearchRequestOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchRequestOptions$Outbound = { - datasourceFilter?: string | undefined; - datasourcesFilter?: Array | undefined; - queryOverridesFacetFilters?: boolean | undefined; - facetFilters?: Array | undefined; - facetFilterSets?: Array | undefined; - facetBucketFilter?: FacetBucketFilter$Outbound | undefined; - facetBucketSize: number; - defaultFacets?: Array | undefined; - authTokens?: Array | undefined; - fetchAllDatasourceCounts?: boolean | undefined; - responseHints?: Array | undefined; - timezoneOffset?: number | undefined; - disableSpellcheck?: boolean | undefined; - disableQueryAutocorrect?: boolean | undefined; - returnLlmContentOverSnippets?: boolean | undefined; - inclusions?: RestrictionFilters$Outbound | undefined; - exclusions?: RestrictionFilters$Outbound | undefined; -}; - -/** @internal */ -declare const SearchRequestOptions$outboundSchema: z.ZodType; - -declare type SearchRequestOptions = { - /** - * Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - */ - datasourceFilter?: string | undefined; - /** - * Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - */ - datasourcesFilter?: Array | undefined; - /** - * If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - */ - queryOverridesFacetFilters?: boolean | undefined; - /** - * A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - */ - facetFilters?: Array | undefined; - /** - * A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - */ - facetFilterSets?: Array | undefined; - facetBucketFilter?: FacetBucketFilter | undefined; - /** - * The maximum number of FacetBuckets to return in each FacetResult. - */ - facetBucketSize: number; - /** - * Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - */ - defaultFacets?: Array | undefined; - /** - * Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - */ - authTokens?: Array | undefined; - /** - * Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - */ - fetchAllDatasourceCounts?: boolean | undefined; - /** - * Array of hints containing which fields should be populated in the response. - */ - responseHints?: Array | undefined; - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - /** - * Whether or not to disable spellcheck. - */ - disableSpellcheck?: boolean | undefined; - /** - * Disables automatic adjustment of the input query for spelling corrections or other reasons. - */ - disableQueryAutocorrect?: boolean | undefined; - /** - * Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - */ - returnLlmContentOverSnippets?: boolean | undefined; - inclusions?: RestrictionFilters | undefined; - exclusions?: RestrictionFilters | undefined; -}; - -declare function searchRequestOptionsFromJSON(jsonString: string): Result; - -declare function searchRequestOptionsToJSON(searchRequestOptions: SearchRequestOptions): string; - -declare function searchRequestToJSON(searchRequest: SearchRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchResponse$ { - /** @deprecated use `SearchResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchResponse$Outbound` instead. */ - type Outbound = SearchResponse$Outbound; -} - -/** @internal */ -declare const SearchResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchResponse$Outbound = { - trackingToken?: string | undefined; - sessionInfo?: SessionInfo$Outbound | undefined; - results?: Array | undefined; - structuredResults?: Array | undefined; - generatedQnaResult?: GeneratedQna$Outbound | undefined; - errorInfo?: GleanDataError$Outbound | undefined; - requestID?: string | undefined; - backendTimeMillis?: number | undefined; - experimentIds?: Array | undefined; - metadata?: SearchResponseMetadata$Outbound | undefined; - facetResults?: Array | undefined; - resultTabs?: Array | undefined; - resultTabIds?: Array | undefined; - resultsDescription?: ResultsDescription$Outbound | undefined; - rewrittenFacetFilters?: Array | undefined; - cursor?: string | undefined; - hasMoreResults?: boolean | undefined; -}; - -/** @internal */ -declare const SearchResponse$outboundSchema: z.ZodType; - -declare type SearchResponse = { - /** - * A token that should be passed for additional requests related to this request (such as more results requests). - */ - trackingToken?: string | undefined; - sessionInfo?: SessionInfo | undefined; - results?: Array | undefined; - structuredResults?: Array | undefined; - generatedQnaResult?: GeneratedQna | undefined; - gleanDataError?: GleanDataError | undefined; - /** - * A platform-generated request ID to correlate backend logs. - */ - requestID?: string | undefined; - /** - * Time in milliseconds the backend took to respond to the request. - */ - backendTimeMillis?: number | undefined; - /** - * List of experiment ids for the corresponding request. - */ - experimentIds?: Array | undefined; - metadata?: SearchResponseMetadata | undefined; - facetResults?: Array | undefined; - /** - * All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - */ - resultTabs?: Array | undefined; - /** - * The unique IDs of the result tabs to which this response belongs. - */ - resultTabIds?: Array | undefined; - resultsDescription?: ResultsDescription | undefined; - /** - * The actual applied facet filters based on the operators and facetFilters in the query. Useful for mapping typed operators to visual facets. - */ - rewrittenFacetFilters?: Array | undefined; - /** - * Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - */ - cursor?: string | undefined; - /** - * Whether more results are available. Use cursor to retrieve them. - */ - hasMoreResults?: boolean | undefined; -}; - -declare function searchResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchResponseMetadata$ { - /** @deprecated use `SearchResponseMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchResponseMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchResponseMetadata$Outbound` instead. */ - type Outbound = SearchResponseMetadata$Outbound; -} - -/** @internal */ -declare const SearchResponseMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchResponseMetadata$Outbound = { - rewrittenQuery?: string | undefined; - searchedQuery?: string | undefined; - searchedQueryWithoutNegation?: string | undefined; - searchedQueryRanges?: Array | undefined; - originalQuery?: string | undefined; - querySuggestion?: QuerySuggestion$Outbound | undefined; - additionalQuerySuggestions?: QuerySuggestionList$Outbound | undefined; - negatedTerms?: Array | undefined; - modifiedQueryWasUsed?: boolean | undefined; - originalQueryHadNoResults?: boolean | undefined; - searchWarning?: SearchWarning$Outbound | undefined; - triggeredExpertDetection?: boolean | undefined; - isNoQuotesSuggestion?: boolean | undefined; -}; - -/** @internal */ -declare const SearchResponseMetadata$outboundSchema: z.ZodType; - -declare type SearchResponseMetadata = { - /** - * A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators. - */ - rewrittenQuery?: string | undefined; - /** - * The actual query used to perform search and return results. - */ - searchedQuery?: string | undefined; - /** - * The query used to perform search and return results, with negated terms and facets removed. - */ - searchedQueryWithoutNegation?: string | undefined; - /** - * The bolded ranges within the searched query. - */ - searchedQueryRanges?: Array | undefined; - /** - * The query text sent by the client in the request. - */ - originalQuery?: string | undefined; - querySuggestion?: QuerySuggestion | undefined; - additionalQuerySuggestions?: QuerySuggestionList | undefined; - /** - * A list of terms that were negated when processing the query. - */ - negatedTerms?: Array | undefined; - /** - * A different query was performed than the one requested. - */ - modifiedQueryWasUsed?: boolean | undefined; - /** - * No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based. - */ - originalQueryHadNoResults?: boolean | undefined; - searchWarning?: SearchWarning | undefined; - /** - * Whether the query triggered expert detection results in the People tab. - */ - triggeredExpertDetection?: boolean | undefined; - /** - * Whether the query was modified to remove quotes - */ - isNoQuotesSuggestion?: boolean | undefined; -}; - -declare function searchResponseMetadataFromJSON(jsonString: string): Result; - -declare function searchResponseMetadataToJSON(searchResponseMetadata: SearchResponseMetadata): string; - -declare function searchResponseToJSON(searchResponse: SearchResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchResult$ { - /** @deprecated use `SearchResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchResult$Outbound` instead. */ - type Outbound = SearchResult$Outbound; -} - -/** @internal */ -declare const SearchResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchResult$Outbound = { - structuredResults?: Array | undefined; - trackingToken?: string | undefined; - document?: Document$Outbound | undefined; - title?: string | undefined; - url: string; - nativeAppUrl?: string | undefined; - snippets?: Array | undefined; - fullText?: string | undefined; - fullTextList?: Array | undefined; - relatedResults?: Array | undefined; - clusteredResults?: Array | undefined; - allClusteredResults?: Array | undefined; - attachmentCount?: number | undefined; - attachments?: Array | undefined; - backlinkResults?: Array | undefined; - clusterType?: string | undefined; - mustIncludeSuggestions?: QuerySuggestionList$Outbound | undefined; - querySuggestion?: QuerySuggestion$Outbound | undefined; - prominence?: string | undefined; - attachmentContext?: string | undefined; - pins?: Array | undefined; -}; - -/** @internal */ -declare const SearchResult$outboundSchema: z.ZodType; - -declare type SearchResult = { - /** - * An array of entities in the work graph retrieved via a data request. - */ - structuredResults?: Array | undefined; - /** - * An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - document?: Document_2 | undefined; - title?: string | undefined; - url: string; - /** - * A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - */ - nativeAppUrl?: string | undefined; - /** - * Text content from the result document which contains search query terms, if available. - */ - snippets?: Array | undefined; - /** - * The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - */ - fullText?: string | undefined; - /** - * The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - */ - fullTextList?: Array | undefined; - /** - * A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP. - */ - relatedResults?: Array | undefined; - /** - * A list of results that should be displayed as associated with this result. - */ - clusteredResults?: Array | undefined; - /** - * A list of results that should be displayed as associated with this result. - */ - allClusteredResults?: Array | undefined; - /** - * The total number of attachments. - */ - attachmentCount?: number | undefined; - /** - * A (potentially partial) list of results representing documents attached to the main result document. - */ - attachments?: Array | undefined; - /** - * A list of results that should be displayed as backlinks of this result in reverse chronological order. - */ - backlinkResults?: Array | undefined; - /** - * The reason for inclusion of clusteredResults. - */ - clusterType?: ClusterTypeEnum | undefined; - mustIncludeSuggestions?: QuerySuggestionList | undefined; - querySuggestion?: QuerySuggestion | undefined; - /** - * The level of visual distinction that should be given to a result. - * - * @remarks - */ - prominence?: SearchResultProminenceEnum | undefined; - /** - * Additional context for the relationship between the result and the document it's attached to. - */ - attachmentContext?: string | undefined; - /** - * A list of pins associated with this search result. - */ - pins?: Array | undefined; -}; - -declare function searchResultFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchResultProminenceEnum$ { - /** @deprecated use `SearchResultProminenceEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; - }>; - /** @deprecated use `SearchResultProminenceEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; - }>; -} - -/** @internal */ -declare const SearchResultProminenceEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const SearchResultProminenceEnum$outboundSchema: z.ZodNativeEnum; - -/** - * The level of visual distinction that should be given to a result. - * - * @remarks - */ -declare const SearchResultProminenceEnum: { - readonly Hero: "HERO"; - readonly Promoted: "PROMOTED"; - readonly Standard: "STANDARD"; -}; - -/** - * The level of visual distinction that should be given to a result. - * - * @remarks - */ -declare type SearchResultProminenceEnum = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchResultSnippet$ { - /** @deprecated use `SearchResultSnippet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchResultSnippet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchResultSnippet$Outbound` instead. */ - type Outbound = SearchResultSnippet$Outbound; -} - -/** @internal */ -declare const SearchResultSnippet$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchResultSnippet$Outbound = { - mimeType?: string | undefined; - text?: string | undefined; - snippetTextOrdering?: number | undefined; - ranges?: Array | undefined; - url?: string | undefined; - snippet: string; -}; - -/** @internal */ -declare const SearchResultSnippet$outboundSchema: z.ZodType; - -declare type SearchResultSnippet = { - /** - * The mime type of the snippets, currently either text/plain or text/html. - */ - mimeType?: string | undefined; - /** - * A matching snippet from the document with no highlights. - */ - text?: string | undefined; - /** - * Used for sorting based off the snippet's location within all_snippetable_text - */ - snippetTextOrdering?: number | undefined; - /** - * The bolded ranges within text. - */ - ranges?: Array | undefined; - /** - * A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. - */ - url?: string | undefined; - /** - * A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - snippet: string; -}; - -declare function searchResultSnippetFromJSON(jsonString: string): Result; - -declare function searchResultSnippetToJSON(searchResultSnippet: SearchResultSnippet): string; - -declare function searchResultToJSON(searchResult: SearchResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SearchWarning$ { - /** @deprecated use `SearchWarning$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SearchWarning$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SearchWarning$Outbound` instead. */ - type Outbound = SearchWarning$Outbound; -} - -/** @internal */ -declare const SearchWarning$inboundSchema: z.ZodType; - -/** @internal */ -declare type SearchWarning$Outbound = { - warningType: string; - lastUsedTerm?: string | undefined; - quotesIgnoredQuery?: string | undefined; - ignoredTerms?: Array | undefined; -}; - -/** @internal */ -declare const SearchWarning$outboundSchema: z.ZodType; - -declare type SearchWarning = { - /** - * The type of the warning. - */ - warningType: WarningType; - /** - * The last term we considered in the user's long query. - */ - lastUsedTerm?: string | undefined; - /** - * The query after ignoring/removing quotes. - */ - quotesIgnoredQuery?: string | undefined; - /** - * A list of query terms that were ignored when generating search results, if any. For example, terms containing invalid filters such as "updated:invalid_date" will be ignored. - */ - ignoredTerms?: Array | undefined; -}; - -declare function searchWarningFromJSON(jsonString: string): Result; - -declare function searchWarningToJSON(searchWarning: SearchWarning): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SectionType$ { - /** @deprecated use `SectionType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Channel: "CHANNEL"; - readonly Mentions: "MENTIONS"; - readonly Topic: "TOPIC"; - }>; - /** @deprecated use `SectionType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Channel: "CHANNEL"; - readonly Mentions: "MENTIONS"; - readonly Topic: "TOPIC"; - }>; -} - -/** @internal */ -declare const SectionType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const SectionType$outboundSchema: z.ZodNativeEnum; - -/** - * Type of the section. This defines how the section should be interpreted and rendered in the digest. - */ -declare const SectionType: { - readonly Channel: "CHANNEL"; - readonly Mentions: "MENTIONS"; - readonly Topic: "TOPIC"; -}; - -/** - * Type of the section. This defines how the section should be interpreted and rendered in the digest. - */ -declare type SectionType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Security$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Security$Outbound` instead. */ - type Outbound = Security$Outbound; -} - -/** @internal */ -declare const Security$inboundSchema: z.ZodType; - -/** @internal */ -declare type Security$Outbound = { - APIToken?: string | undefined; -}; - -/** @internal */ -declare const Security$outboundSchema: z.ZodType; - -declare type Security = { - apiToken?: string | undefined; -}; - -declare function securityFromJSON(jsonString: string): Result; - -declare type SecurityState = { - basic: { - username?: string | undefined; - password?: string | undefined; - }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ - type: "password"; - } & OAuth2PasswordFlow) | { - type: "none"; - }; -}; - -declare function securityToJSON(security: Security): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SeenFeedbackInfo$ { - /** @deprecated use `SeenFeedbackInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SeenFeedbackInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SeenFeedbackInfo$Outbound` instead. */ - type Outbound = SeenFeedbackInfo$Outbound; -} - -/** @internal */ -declare const SeenFeedbackInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type SeenFeedbackInfo$Outbound = { - isExplicit?: boolean | undefined; -}; - -/** @internal */ -declare const SeenFeedbackInfo$outboundSchema: z.ZodType; - -declare type SeenFeedbackInfo = { - /** - * The confidence of the user seeing the object is high because they explicitly interacted with it e.g. answer impression in SERP with additional user interaction. - */ - isExplicit?: boolean | undefined; -}; - -declare function seenFeedbackInfoFromJSON(jsonString: string): Result; - -declare function seenFeedbackInfoToJSON(seenFeedbackInfo: SeenFeedbackInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SensitiveContentOptions$ { - /** @deprecated use `SensitiveContentOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SensitiveContentOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SensitiveContentOptions$Outbound` instead. */ - type Outbound = SensitiveContentOptions$Outbound; -} - -/** @internal */ -declare const SensitiveContentOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type SensitiveContentOptions$Outbound = { - sensitiveInfoTypes?: Array | undefined; - sensitiveTerms?: Array | undefined; - sensitiveRegexes?: Array | undefined; -}; - -/** @internal */ -declare const SensitiveContentOptions$outboundSchema: z.ZodType; - -/** - * Options for defining sensitive content within scanned documents. - */ -declare type SensitiveContentOptions = { - /** - * Predefined categories of terms to consider as sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available types. - */ - sensitiveInfoTypes?: Array | undefined; - /** - * list of words and phrases to consider as sensitive content - */ - sensitiveTerms?: Array | undefined; - /** - * list of regular expressions to consider as sensitive content - */ - sensitiveRegexes?: Array | undefined; -}; - -declare function sensitiveContentOptionsFromJSON(jsonString: string): Result; - -declare function sensitiveContentOptionsToJSON(sensitiveContentOptions: SensitiveContentOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SensitiveExpression$ { - /** @deprecated use `SensitiveExpression$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SensitiveExpression$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SensitiveExpression$Outbound` instead. */ - type Outbound = SensitiveExpression$Outbound; -} - -/** @internal */ -declare const SensitiveExpression$inboundSchema: z.ZodType; - -/** @internal */ -declare type SensitiveExpression$Outbound = { - expression?: string | undefined; - hotwords?: Array | undefined; -}; - -/** @internal */ -declare const SensitiveExpression$outboundSchema: z.ZodType; - -declare type SensitiveExpression = { - /** - * Sensitive word, phrase, or regular expression. - */ - expression?: string | undefined; - /** - * Zero to three proximate regular expressions necessary to consider an expression as sensitive content. - */ - hotwords?: Array | undefined; -}; - -declare function sensitiveExpressionFromJSON(jsonString: string): Result; - -declare function sensitiveExpressionToJSON(sensitiveExpression: SensitiveExpression): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SensitiveInfoType$ { - /** @deprecated use `SensitiveInfoType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SensitiveInfoType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SensitiveInfoType$Outbound` instead. */ - type Outbound = SensitiveInfoType$Outbound; -} - -/** @internal */ -declare const SensitiveInfoType$inboundSchema: z.ZodType; - -/** @internal */ -declare type SensitiveInfoType$Outbound = { - likelihoodThreshold?: string | undefined; - infoType?: string | undefined; -}; - -/** @internal */ -declare const SensitiveInfoType$outboundSchema: z.ZodType; - -declare type SensitiveInfoType = { - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - likelihoodThreshold?: LikelihoodThreshold | undefined; - /** - * Text representation of an info-type to scan for. - */ - infoType?: string | undefined; -}; - -declare function sensitiveInfoTypeFromJSON(jsonString: string): Result; - -declare function sensitiveInfoTypeToJSON(sensitiveInfoType: SensitiveInfoType): string; - -/** - * Contains the list of servers available to the SDK - */ -export declare const ServerList: readonly ["https://{instance}-be.glean.com"]; - -export declare function serverURLFromOptions(options: SDKOptions): URL | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SessionInfo$ { - /** @deprecated use `SessionInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SessionInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SessionInfo$Outbound` instead. */ - type Outbound = SessionInfo$Outbound; -} - -/** @internal */ -declare const SessionInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type SessionInfo$Outbound = { - sessionTrackingToken?: string | undefined; - tabId?: string | undefined; - lastSeen?: string | undefined; - lastQuery?: string | undefined; -}; - -/** @internal */ -declare const SessionInfo$outboundSchema: z.ZodType; - -declare type SessionInfo = { - /** - * A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - */ - sessionTrackingToken?: string | undefined; - /** - * A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - */ - tabId?: string | undefined; - /** - * The last time the server saw this token. - */ - lastSeen?: Date | undefined; - /** - * The last query seen by the server. - */ - lastQuery?: string | undefined; -}; - -declare function sessionInfoFromJSON(jsonString: string): Result; - -declare function sessionInfoToJSON(sessionInfo: SessionInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Share$ { - /** @deprecated use `Share$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Share$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Share$Outbound` instead. */ - type Outbound = Share$Outbound; -} - -/** @internal */ -declare const Share$inboundSchema: z.ZodType; - -/** @internal */ -declare type Share$Outbound = { - numDaysAgo: number; - sharer?: Person$Outbound | undefined; - sharingDocument?: Document$Outbound | undefined; -}; - -/** @internal */ -declare const Share$outboundSchema: z.ZodType; - -/** - * Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip - */ -declare type Share = { - /** - * The number of days that has passed since the share happened - */ - numDaysAgo: number; - sharer?: Person | undefined; - sharingDocument?: Document_2 | undefined; -}; - -declare function shareFromJSON(jsonString: string): Result; - -declare function shareToJSON(share: Share): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingOptions$ { - /** @deprecated use `SharingOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingOptions$Outbound` instead. */ - type Outbound = SharingOptions$Outbound; -} - -/** @internal */ -declare const SharingOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingOptions$Outbound = { - enabled?: boolean | undefined; - threshold?: number | undefined; - thresholdEnabled?: boolean | undefined; - anyoneWithLinkEnabled?: boolean | undefined; - anyoneInternalEnabled?: boolean | undefined; - anonymousAccessEnabled?: boolean | undefined; - userAccessEnabled?: boolean | undefined; - userIds?: Array | undefined; -}; - -/** @internal */ -declare const SharingOptions$outboundSchema: z.ZodType; - -/** - * Controls how "shared" a document must be to get picked for scans. - */ -declare type SharingOptions = { - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - enabled?: boolean | undefined; - /** - * The minimum number of users the document is shared with. - */ - threshold?: number | undefined; - /** - * Documents will be filtered based on how many people have access to it. - */ - thresholdEnabled?: boolean | undefined; - /** - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - anyoneWithLinkEnabled?: boolean | undefined; - /** - * Only users within the organization can access the document. - */ - anyoneInternalEnabled?: boolean | undefined; - /** - * Anyone on the internet can access the document. - */ - anonymousAccessEnabled?: boolean | undefined; - /** - * Enable user access check - */ - userAccessEnabled?: boolean | undefined; - /** - * Any one of the specified users can access the document. - */ - userIds?: Array | undefined; -}; - -declare function sharingOptionsFromJSON(jsonString: string): Result; - -declare function sharingOptionsToJSON(sharingOptions: SharingOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Shortcut$ { - /** @deprecated use `Shortcut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Shortcut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Shortcut$Outbound` instead. */ - type Outbound = Shortcut$Outbound; -} - -/** @internal */ -declare const Shortcut$inboundSchema: z.ZodType; - -/** @internal */ -declare type Shortcut$Outbound = { - id?: number | undefined; - inputAlias: string; - destinationUrl?: string | undefined; - destinationDocumentId?: string | undefined; - description?: string | undefined; - unlisted?: boolean | undefined; - urlTemplate?: string | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - createdBy?: Person$Outbound | undefined; - createTime?: string | undefined; - updatedBy?: Person$Outbound | undefined; - updateTime?: string | undefined; - destinationDocument?: Document$Outbound | undefined; - intermediateUrl?: string | undefined; - viewPrefix?: string | undefined; - isExternal?: boolean | undefined; - editUrl?: string | undefined; - alias?: string | undefined; - title?: string | undefined; - roles?: Array | undefined; -}; - -/** @internal */ -declare const Shortcut$outboundSchema: z.ZodType; - -declare type Shortcut = { - /** - * The opaque id of the user generated content. - */ - id?: number | undefined; - /** - * Link text following go/ prefix as entered by the user. - */ - inputAlias: string; - /** - * Destination URL for the shortcut. - */ - destinationUrl?: string | undefined; - /** - * Glean Document ID for the URL, if known. - */ - destinationDocumentId?: string | undefined; - /** - * A short, plain text blurb to help people understand the intent of the shortcut. - */ - description?: string | undefined; - /** - * Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - */ - unlisted?: boolean | undefined; - /** - * For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - */ - urlTemplate?: string | undefined; - /** - * A list of user roles added for the Shortcut. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles removed for the Shortcut. - */ - removedRoles?: Array | undefined; - permissions?: ObjectPermissions | undefined; - createdBy?: Person | undefined; - /** - * The time the shortcut was created in ISO format (ISO 8601). - */ - createTime?: Date | undefined; - updatedBy?: Person | undefined; - /** - * The time the shortcut was updated in ISO format (ISO 8601). - */ - updateTime?: Date | undefined; - destinationDocument?: Document_2 | undefined; - /** - * The URL from which the user is then redirected to the destination URL. Full replacement for https://go/. - */ - intermediateUrl?: string | undefined; - /** - * The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - */ - viewPrefix?: string | undefined; - /** - * Indicates whether a shortcut is native or external. - */ - isExternal?: boolean | undefined; - /** - * The URL using which the user can access the edit page of the shortcut. - */ - editUrl?: string | undefined; - /** - * canonical link text following go/ prefix where hyphen/underscore is removed. - */ - alias?: string | undefined; - /** - * Title for the Go Link - */ - title?: string | undefined; - /** - * A list of user roles for the Go Link. - */ - roles?: Array | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutError$ { - /** @deprecated use `ShortcutError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShortcutError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ShortcutError$Outbound` instead. */ - type Outbound = ShortcutError$Outbound; -} - -/** @internal */ -declare const ShortcutError$inboundSchema: z.ZodType; - -/** @internal */ -declare type ShortcutError$Outbound = { - errorType?: string | undefined; -}; - -/** @internal */ -declare const ShortcutError$outboundSchema: z.ZodType; - -declare type ShortcutError = { - errorType?: ShortcutErrorErrorType | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutErrorErrorType$ { - /** @deprecated use `ShortcutErrorErrorType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; - readonly ExistingShortcut: "EXISTING_SHORTCUT"; - readonly InvalidChars: "INVALID_CHARS"; - }>; - /** @deprecated use `ShortcutErrorErrorType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; - readonly ExistingShortcut: "EXISTING_SHORTCUT"; - readonly InvalidChars: "INVALID_CHARS"; - }>; -} - -/** @internal */ -declare const ShortcutErrorErrorType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ShortcutErrorErrorType$outboundSchema: z.ZodNativeEnum; - -declare const ShortcutErrorErrorType: { - readonly NoPermission: "NO_PERMISSION"; - readonly InvalidId: "INVALID_ID"; - readonly ExistingShortcut: "EXISTING_SHORTCUT"; - readonly InvalidChars: "INVALID_CHARS"; -}; - -declare type ShortcutErrorErrorType = ClosedEnum; - -declare function shortcutErrorFromJSON(jsonString: string): Result; - -declare function shortcutErrorToJSON(shortcutError: ShortcutError): string; - -declare function shortcutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutInsight$ { - /** @deprecated use `ShortcutInsight$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShortcutInsight$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ShortcutInsight$Outbound` instead. */ - type Outbound = ShortcutInsight$Outbound; -} - -/** @internal */ -declare const ShortcutInsight$inboundSchema: z.ZodType; - -/** @internal */ -declare type ShortcutInsight$Outbound = { - shortcut: Shortcut$Outbound; - visitCount?: CountInfo$Outbound | undefined; - visitorCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const ShortcutInsight$outboundSchema: z.ZodType; - -declare type ShortcutInsight = { - shortcut: Shortcut; - visitCount?: CountInfo | undefined; - visitorCount?: CountInfo | undefined; -}; - -declare function shortcutInsightFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutInsightsResponse$ { - /** @deprecated use `ShortcutInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShortcutInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ShortcutInsightsResponse$Outbound` instead. */ - type Outbound = ShortcutInsightsResponse$Outbound; -} - -/** @internal */ -declare const ShortcutInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ShortcutInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - shortcutInsights?: Array | undefined; - departments?: Array | undefined; - minVisitorThreshold?: number | undefined; -}; - -/** @internal */ -declare const ShortcutInsightsResponse$outboundSchema: z.ZodType; - -declare type ShortcutInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - /** - * Insights for shortcuts. - */ - shortcutInsights?: Array | undefined; - /** - * list of departments applicable for shortcuts tab. - */ - departments?: Array | undefined; - /** - * Min threshold in number of visitors while populating results, otherwise 0. - */ - minVisitorThreshold?: number | undefined; -}; - -declare function shortcutInsightsResponseFromJSON(jsonString: string): Result; - -declare function shortcutInsightsResponseToJSON(shortcutInsightsResponse: ShortcutInsightsResponse): string; - -declare function shortcutInsightToJSON(shortcutInsight: ShortcutInsight): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutMutableProperties$ { - /** @deprecated use `ShortcutMutableProperties$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShortcutMutableProperties$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ShortcutMutableProperties$Outbound` instead. */ - type Outbound = ShortcutMutableProperties$Outbound; -} - -/** @internal */ -declare const ShortcutMutableProperties$inboundSchema: z.ZodType; - -/** @internal */ -declare type ShortcutMutableProperties$Outbound = { - inputAlias?: string | undefined; - destinationUrl?: string | undefined; - destinationDocumentId?: string | undefined; - description?: string | undefined; - unlisted?: boolean | undefined; - urlTemplate?: string | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; -}; - -/** @internal */ -declare const ShortcutMutableProperties$outboundSchema: z.ZodType; - -declare type ShortcutMutableProperties = { - /** - * Link text following go/ prefix as entered by the user. - */ - inputAlias?: string | undefined; - /** - * Destination URL for the shortcut. - */ - destinationUrl?: string | undefined; - /** - * Glean Document ID for the URL, if known. - */ - destinationDocumentId?: string | undefined; - /** - * A short, plain text blurb to help people understand the intent of the shortcut. - */ - description?: string | undefined; - /** - * Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - */ - unlisted?: boolean | undefined; - /** - * For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - */ - urlTemplate?: string | undefined; - /** - * A list of user roles added for the Shortcut. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles removed for the Shortcut. - */ - removedRoles?: Array | undefined; -}; - -declare function shortcutMutablePropertiesFromJSON(jsonString: string): Result; - -declare function shortcutMutablePropertiesToJSON(shortcutMutableProperties: ShortcutMutableProperties): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShortcutsPaginationMetadata$ { - /** @deprecated use `ShortcutsPaginationMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShortcutsPaginationMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ShortcutsPaginationMetadata$Outbound` instead. */ - type Outbound = ShortcutsPaginationMetadata$Outbound; -} - -/** @internal */ -declare const ShortcutsPaginationMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type ShortcutsPaginationMetadata$Outbound = { - cursor?: string | undefined; - hasNextPage?: boolean | undefined; - totalItemCount?: number | undefined; -}; - -/** @internal */ -declare const ShortcutsPaginationMetadata$outboundSchema: z.ZodType; - -declare type ShortcutsPaginationMetadata = { - /** - * Cursor indicates the start of the next page of results - */ - cursor?: string | undefined; - hasNextPage?: boolean | undefined; - totalItemCount?: number | undefined; -}; - -declare function shortcutsPaginationMetadataFromJSON(jsonString: string): Result; - -declare function shortcutsPaginationMetadataToJSON(shortcutsPaginationMetadata: ShortcutsPaginationMetadata): string; - -declare function shortcutToJSON(shortcut: Shortcut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SideBySideImplementation$ { - /** @deprecated use `SideBySideImplementation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SideBySideImplementation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SideBySideImplementation$Outbound` instead. */ - type Outbound = SideBySideImplementation$Outbound; -} - -/** @internal */ -declare const SideBySideImplementation$inboundSchema: z.ZodType; - -/** @internal */ -declare type SideBySideImplementation$Outbound = { - implementationId?: string | undefined; - implementationName?: string | undefined; - searchParams?: { - [k: string]: string; - } | undefined; - response?: string | undefined; - responseMetadata?: ResponseMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const SideBySideImplementation$outboundSchema: z.ZodType; - -declare type SideBySideImplementation = { - /** - * Unique identifier for this implementation variant. - */ - implementationId?: string | undefined; - /** - * Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). - */ - implementationName?: string | undefined; - /** - * The search/chat parameters used for this implementation. - */ - searchParams?: { - [k: string]: string; - } | undefined; - /** - * The full response generated by this implementation. - */ - response?: string | undefined; - /** - * Metadata about the response (e.g., latency, token count). - */ - responseMetadata?: ResponseMetadata | undefined; -}; - -declare function sideBySideImplementationFromJSON(jsonString: string): Result; - -declare function sideBySideImplementationToJSON(sideBySideImplementation: SideBySideImplementation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SocialNetwork$ { - /** @deprecated use `SocialNetwork$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SocialNetwork$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SocialNetwork$Outbound` instead. */ - type Outbound = SocialNetwork$Outbound; -} - -/** @internal */ -declare const SocialNetwork$inboundSchema: z.ZodType; - -/** @internal */ -declare type SocialNetwork$Outbound = { - name: string; - profileName?: string | undefined; - profileUrl: string; -}; - -/** @internal */ -declare const SocialNetwork$outboundSchema: z.ZodType; - -declare type SocialNetwork = { - /** - * Possible values are "twitter", "linkedin". - */ - name: string; - /** - * Human-readable profile name. - */ - profileName?: string | undefined; - /** - * Link to profile. - */ - profileUrl: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SocialNetworkDefinition$ { - /** @deprecated use `SocialNetworkDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SocialNetworkDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SocialNetworkDefinition$Outbound` instead. */ - type Outbound = SocialNetworkDefinition$Outbound; -} - -/** @internal */ -declare const SocialNetworkDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type SocialNetworkDefinition$Outbound = { - name?: string | undefined; - profileName?: string | undefined; - profileUrl?: string | undefined; -}; - -/** @internal */ -declare const SocialNetworkDefinition$outboundSchema: z.ZodType; - -/** - * Employee's social network profile - */ -declare type SocialNetworkDefinition = { - /** - * Possible values are "twitter", "linkedin". - */ - name?: string | undefined; - /** - * Human-readable profile name. - */ - profileName?: string | undefined; - /** - * Link to profile. - */ - profileUrl?: string | undefined; -}; - -declare function socialNetworkDefinitionFromJSON(jsonString: string): Result; - -declare function socialNetworkDefinitionToJSON(socialNetworkDefinition: SocialNetworkDefinition): string; - -declare function socialNetworkFromJSON(jsonString: string): Result; - -declare function socialNetworkToJSON(socialNetwork: SocialNetwork): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SortOptions$ { - /** @deprecated use `SortOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SortOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SortOptions$Outbound` instead. */ - type Outbound = SortOptions$Outbound; -} - -/** @internal */ -declare const SortOptions$inboundSchema: z.ZodType; - -/** @internal */ -declare type SortOptions$Outbound = { - orderBy?: string | undefined; - sortBy?: string | undefined; -}; - -/** @internal */ -declare const SortOptions$outboundSchema: z.ZodType; - -declare type SortOptions = { - orderBy?: OrderBy | undefined; - sortBy?: string | undefined; -}; - -declare function sortOptionsFromJSON(jsonString: string): Result; - -declare function sortOptionsToJSON(sortOptions: SortOptions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace State$ { - /** @deprecated use `State$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Unverified: "UNVERIFIED"; - readonly Verified: "VERIFIED"; - readonly Deprecated: "DEPRECATED"; - }>; - /** @deprecated use `State$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Unverified: "UNVERIFIED"; - readonly Verified: "VERIFIED"; - readonly Deprecated: "DEPRECATED"; - }>; -} - -/** @internal */ -declare const State$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const State$outboundSchema: z.ZodNativeEnum; - -/** - * The verification state for the document. - */ -declare const State: { - readonly Unverified: "UNVERIFIED"; - readonly Verified: "VERIFIED"; - readonly Deprecated: "DEPRECATED"; -}; - -/** - * The verification state for the document. - */ -declare type State = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredLink$ { - /** @deprecated use `StructuredLink$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredLink$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredLink$Outbound` instead. */ - type Outbound = StructuredLink$Outbound; -} - -/** @internal */ -declare const StructuredLink$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredLink$Outbound = { - name?: string | undefined; - url?: string | undefined; - iconConfig?: IconConfig$Outbound | undefined; -}; - -/** @internal */ -declare const StructuredLink$outboundSchema: z.ZodType; - -/** - * The display configuration for a link. - */ -declare type StructuredLink = { - /** - * The display name for the link - */ - name?: string | undefined; - /** - * The URL for the link. - */ - url?: string | undefined; - /** - * Defines how to render an icon - */ - iconConfig?: IconConfig | undefined; -}; - -declare function structuredLinkFromJSON(jsonString: string): Result; - -declare function structuredLinkToJSON(structuredLink: StructuredLink): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredLocation$ { - /** @deprecated use `StructuredLocation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredLocation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredLocation$Outbound` instead. */ - type Outbound = StructuredLocation$Outbound; -} - -/** @internal */ -declare const StructuredLocation$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredLocation$Outbound = { - deskLocation?: string | undefined; - timezone?: string | undefined; - address?: string | undefined; - city?: string | undefined; - state?: string | undefined; - region?: string | undefined; - zipCode?: string | undefined; - country?: string | undefined; - countryCode?: string | undefined; -}; - -/** @internal */ -declare const StructuredLocation$outboundSchema: z.ZodType; - -/** - * Detailed location with information about country, state, city etc. - */ -declare type StructuredLocation = { - /** - * Desk number. - */ - deskLocation?: string | undefined; - /** - * Location's timezone, e.g. UTC, PST. - */ - timezone?: string | undefined; - /** - * Office address or name. - */ - address?: string | undefined; - /** - * Name of the city. - */ - city?: string | undefined; - /** - * State code. - */ - state?: string | undefined; - /** - * Region information, e.g. NORAM, APAC. - */ - region?: string | undefined; - /** - * ZIP Code for the address. - */ - zipCode?: string | undefined; - /** - * Country name. - */ - country?: string | undefined; - /** - * Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - */ - countryCode?: string | undefined; -}; - -declare function structuredLocationFromJSON(jsonString: string): Result; - -declare function structuredLocationToJSON(structuredLocation: StructuredLocation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredResult$ { - /** @deprecated use `StructuredResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredResult$Outbound` instead. */ - type Outbound = StructuredResult$Outbound; -} - -/** @internal */ -declare const StructuredResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredResult$Outbound = { - document?: Document$Outbound | undefined; - person?: Person$Outbound | undefined; - customer?: Customer$Outbound | undefined; - team?: Team$Outbound | undefined; - customEntity?: CustomEntity$Outbound | undefined; - answer?: Answer$Outbound | undefined; - generatedQna?: GeneratedQna$Outbound | undefined; - extractedQnA?: ExtractedQnA$Outbound | undefined; - meeting?: Meeting$Outbound | undefined; - app?: AppResult$Outbound | undefined; - collection?: Collection$Outbound | undefined; - answerBoard?: AnswerBoard$Outbound | undefined; - code?: Code$Outbound | undefined; - shortcut?: Shortcut$Outbound | undefined; - querySuggestions?: QuerySuggestionList$Outbound | undefined; - relatedDocuments?: Array | undefined; - relatedQuestion?: RelatedQuestion$Outbound | undefined; - disambiguation?: Disambiguation$Outbound | undefined; - snippets?: Array | undefined; - trackingToken?: string | undefined; - prominence?: string | undefined; - source?: string | undefined; -}; - -/** @internal */ -declare const StructuredResult$outboundSchema: z.ZodType; - -/** - * A single object that can support any object in the work graph. Only a single object will be populated. - */ -declare type StructuredResult = { - document?: Document_2 | undefined; - person?: Person | undefined; - customer?: Customer | undefined; - team?: Team | undefined; - customEntity?: CustomEntity | undefined; - answer?: Answer | undefined; - generatedQna?: GeneratedQna | undefined; - extractedQnA?: ExtractedQnA | undefined; - meeting?: Meeting | undefined; - app?: AppResult | undefined; - collection?: Collection | undefined; - answerBoard?: AnswerBoard | undefined; - code?: Code | undefined; - shortcut?: Shortcut | undefined; - querySuggestions?: QuerySuggestionList | undefined; - /** - * A list of documents related to this structured result. - */ - relatedDocuments?: Array | undefined; - relatedQuestion?: RelatedQuestion | undefined; - /** - * A disambiguation between multiple entities with the same name - */ - disambiguation?: Disambiguation | undefined; - /** - * Any snippets associated to the populated object. - */ - snippets?: Array | undefined; - /** - * An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; - /** - * The level of visual distinction that should be given to a result. - */ - prominence?: Prominence | undefined; - /** - * Source context for this result. Possible values depend on the result type. - */ - source?: StructuredResultSource | undefined; -}; - -declare function structuredResultFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredResultSource$ { - /** @deprecated use `StructuredResultSource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly EntityNlq: "ENTITY_NLQ"; - }>; - /** @deprecated use `StructuredResultSource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly EntityNlq: "ENTITY_NLQ"; - }>; -} - -/** @internal */ -declare const StructuredResultSource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const StructuredResultSource$outboundSchema: z.ZodNativeEnum; - -/** - * Source context for this result. Possible values depend on the result type. - */ -declare const StructuredResultSource: { - readonly ExpertDetection: "EXPERT_DETECTION"; - readonly EntityNlq: "ENTITY_NLQ"; -}; - -/** - * Source context for this result. Possible values depend on the result type. - */ -declare type StructuredResultSource = ClosedEnum; - -declare function structuredResultToJSON(structuredResult: StructuredResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredText$ { - /** @deprecated use `StructuredText$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredText$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredText$Outbound` instead. */ - type Outbound = StructuredText$Outbound; -} - -/** @internal */ -declare const StructuredText$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredText$Outbound = { - text: string; - structuredList?: Array | undefined; -}; - -/** @internal */ -declare const StructuredText$outboundSchema: z.ZodType; - -declare type StructuredText = { - text: string; - /** - * An array of objects each of which contains either a string or a link which optionally corresponds to a document. - */ - structuredList?: Array | undefined; -}; - -declare function structuredTextFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredTextItem$ { - /** @deprecated use `StructuredTextItem$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredTextItem$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredTextItem$Outbound` instead. */ - type Outbound = StructuredTextItem$Outbound; -} - -/** @internal */ -declare const StructuredTextItem$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredTextItem$Outbound = { - link?: string | undefined; - document?: Document$Outbound | undefined; - text?: string | undefined; - structuredResult?: StructuredResult$Outbound | undefined; -}; - -/** @internal */ -declare const StructuredTextItem$outboundSchema: z.ZodType; - -declare type StructuredTextItem = { - link?: string | undefined; - document?: Document_2 | undefined; - text?: string | undefined; - /** - * A single object that can support any object in the work graph. Only a single object will be populated. - */ - structuredResult?: StructuredResult | undefined; -}; - -declare function structuredTextItemFromJSON(jsonString: string): Result; - -declare function structuredTextItemToJSON(structuredTextItem: StructuredTextItem): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace StructuredTextMutableProperties$ { - /** @deprecated use `StructuredTextMutableProperties$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `StructuredTextMutableProperties$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `StructuredTextMutableProperties$Outbound` instead. */ - type Outbound = StructuredTextMutableProperties$Outbound; -} - -/** @internal */ -declare const StructuredTextMutableProperties$inboundSchema: z.ZodType; - -/** @internal */ -declare type StructuredTextMutableProperties$Outbound = { - text: string; -}; - -/** @internal */ -declare const StructuredTextMutableProperties$outboundSchema: z.ZodType; - -declare type StructuredTextMutableProperties = { - text: string; -}; - -declare function structuredTextMutablePropertiesFromJSON(jsonString: string): Result; - -declare function structuredTextMutablePropertiesToJSON(structuredTextMutableProperties: StructuredTextMutableProperties): string; - -declare function structuredTextToJSON(structuredText: StructuredText): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SummarizeRequest$ { - /** @deprecated use `SummarizeRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SummarizeRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SummarizeRequest$Outbound` instead. */ - type Outbound = SummarizeRequest$Outbound; -} - -/** @internal */ -declare const SummarizeRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type SummarizeRequest$Outbound = { - timestamp?: string | undefined; - query?: string | undefined; - preferredSummaryLength?: number | undefined; - documentSpecs: Array; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const SummarizeRequest$outboundSchema: z.ZodType; - -/** - * Summary of the document - */ -declare type SummarizeRequest = { - /** - * The ISO 8601 timestamp associated with the client request. - */ - timestamp?: Date | undefined; - /** - * Optional query that the summary should be about - */ - query?: string | undefined; - /** - * Optional length of summary output. If not given, defaults to 500 chars. - */ - preferredSummaryLength?: number | undefined; - /** - * Specifications of documents to summarize - */ - documentSpecs: Array; - /** - * An opaque token that represents this particular result. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; -}; - -declare function summarizeRequestFromJSON(jsonString: string): Result; - -declare function summarizeRequestToJSON(summarizeRequest: SummarizeRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SummarizeResponse$ { - /** @deprecated use `SummarizeResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SummarizeResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SummarizeResponse$Outbound` instead. */ - type Outbound = SummarizeResponse$Outbound; -} - -/** @internal */ -declare const SummarizeResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type SummarizeResponse$Outbound = { - error?: ErrorT$Outbound | undefined; - summary?: Summary$Outbound | undefined; - trackingToken?: string | undefined; -}; - -/** @internal */ -declare const SummarizeResponse$outboundSchema: z.ZodType; - -declare type SummarizeResponse = { - error?: ErrorT | undefined; - summary?: Summary | undefined; - /** - * An opaque token that represents this summary in this particular query. To be used for /feedback reporting. - */ - trackingToken?: string | undefined; -}; - -declare function summarizeResponseFromJSON(jsonString: string): Result; - -declare function summarizeResponseToJSON(summarizeResponse: SummarizeResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Summary$ { - /** @deprecated use `Summary$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Summary$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Summary$Outbound` instead. */ - type Outbound = Summary$Outbound; -} - -/** @internal */ -declare const Summary$inboundSchema: z.ZodType; - -/** @internal */ -declare type Summary$Outbound = { - text?: string | undefined; - followUpPrompts?: Array | undefined; -}; - -/** @internal */ -declare const Summary$outboundSchema: z.ZodType; - -declare type Summary = { - text?: string | undefined; - /** - * Follow-up prompts based on the summarized doc - */ - followUpPrompts?: Array | undefined; -}; - -declare function summaryFromJSON(jsonString: string): Result; - -declare function summaryToJSON(summary: Summary): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Team$ { - /** @deprecated use `Team$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Team$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Team$Outbound` instead. */ - type Outbound = Team$Outbound; -} - -/** @internal */ -declare const Team$inboundSchema: z.ZodType; - -/** @internal */ -declare type Team$Outbound = { - relatedObjects?: { - [k: string]: RelatedObjectEdge$Outbound; - } | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id: string; - name: string; - description?: string | undefined; - businessUnit?: string | undefined; - department?: string | undefined; - photoUrl?: string | undefined; - bannerUrl?: string | undefined; - externalLink?: string | undefined; - members?: Array | undefined; - memberCount?: number | undefined; - emails?: Array | undefined; - customFields?: Array | undefined; - datasourceProfiles?: Array | undefined; - datasource?: string | undefined; - createdFrom?: string | undefined; - lastUpdatedAt?: string | undefined; - status: string; - canBeDeleted: boolean; - loggingId?: string | undefined; -}; - -/** @internal */ -declare const Team$outboundSchema: z.ZodType; - -declare type Team = { - /** - * A list of objects related to a source object. - */ - relatedObjects?: { - [k: string]: RelatedObjectEdge; - } | undefined; - permissions?: ObjectPermissions | undefined; - /** - * Unique identifier - */ - id: string; - /** - * Team name - */ - name: string; - /** - * A description of the team - */ - description?: string | undefined; - /** - * Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - */ - businessUnit?: string | undefined; - /** - * An organizational unit where everyone has a similar task, e.g. `Engineering`. - */ - department?: string | undefined; - /** - * A link to the team's photo. - */ - photoUrl?: string | undefined; - /** - * A link to the team's banner photo. - */ - bannerUrl?: string | undefined; - /** - * Link to a team page on the internet or your company's intranet - */ - externalLink?: string | undefined; - /** - * The members on this team - */ - members?: Array | undefined; - /** - * Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team) - */ - memberCount?: number | undefined; - /** - * The emails for this team - */ - emails?: Array | undefined; - /** - * Customizable fields for additional team information. - */ - customFields?: Array | undefined; - /** - * The datasource profiles of the team - */ - datasourceProfiles?: Array | undefined; - /** - * the data source of the team, e.g. GDRIVE - */ - datasource?: string | undefined; - /** - * For teams created from docs, the doc title. Otherwise empty. - */ - createdFrom?: string | undefined; - /** - * when this team was last updated. - */ - lastUpdatedAt?: Date | undefined; - /** - * whether this team is fully processed or there are still unprocessed operations that'll affect it - */ - status?: TeamStatus | undefined; - /** - * can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot - */ - canBeDeleted?: boolean | undefined; - /** - * The logging id of the team used in scrubbed logs, client analytics, and metrics. - */ - loggingId?: string | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TeamEmail$ { - /** @deprecated use `TeamEmail$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TeamEmail$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TeamEmail$Outbound` instead. */ - type Outbound = TeamEmail$Outbound; -} - -/** @internal */ -declare const TeamEmail$inboundSchema: z.ZodType; - -/** @internal */ -declare type TeamEmail$Outbound = { - email: string; - type: string; -}; - -/** @internal */ -declare const TeamEmail$outboundSchema: z.ZodType; - -/** - * Information about a team's email - */ -declare type TeamEmail = { - /** - * An email address - */ - email: string; - /** - * An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER` - */ - type?: string | undefined; -}; - -declare function teamEmailFromJSON(jsonString: string): Result; - -declare function teamEmailToJSON(teamEmail: TeamEmail): string; - -declare function teamFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TeamInfoDefinition$ { - /** @deprecated use `TeamInfoDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TeamInfoDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TeamInfoDefinition$Outbound` instead. */ - type Outbound = TeamInfoDefinition$Outbound; -} - -/** @internal */ -declare const TeamInfoDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type TeamInfoDefinition$Outbound = { - id: string; - name: string; - description?: string | undefined; - businessUnit?: string | undefined; - department?: string | undefined; - photoUrl?: string | undefined; - externalLink?: string | undefined; - emails?: Array | undefined; - datasourceProfiles?: Array | undefined; - members: Array; - additionalFields?: Array | undefined; -}; - -/** @internal */ -declare const TeamInfoDefinition$outboundSchema: z.ZodType; - -/** - * Information about an employee's team - */ -declare type TeamInfoDefinition = { - /** - * The unique ID of the team - */ - id: string; - /** - * Human-readable team name - */ - name: string; - /** - * The description of this team - */ - description?: string | undefined; - /** - * Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - */ - businessUnit?: string | undefined; - /** - * An organizational unit where everyone has a similar task, e.g. `Engineering`. - */ - department?: string | undefined; - /** - * A link to the team's photo - */ - photoUrl?: string | undefined; - /** - * A link to an external team page. If set, team results will link to it. - * - * @remarks - */ - externalLink?: string | undefined; - /** - * The emails of the team - */ - emails?: Array | undefined; - /** - * The datasource profiles of the team, e.g. `Slack`,`Github`. - */ - datasourceProfiles?: Array | undefined; - /** - * The members of the team - */ - members: Array; - /** - * List of additional fields with more information about the team. - */ - additionalFields?: Array | undefined; -}; - -declare function teamInfoDefinitionFromJSON(jsonString: string): Result; - -declare function teamInfoDefinitionToJSON(teamInfoDefinition: TeamInfoDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TeamMember$ { - /** @deprecated use `TeamMember$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TeamMember$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TeamMember$Outbound` instead. */ - type Outbound = TeamMember$Outbound; -} - -/** @internal */ -declare const TeamMember$inboundSchema: z.ZodType; - -/** @internal */ -declare type TeamMember$Outbound = { - email: string; - relationship: string; - join_date?: string | undefined; -}; - -/** @internal */ -declare const TeamMember$outboundSchema: z.ZodType; - -/** - * Information about a team's member - */ -declare type TeamMember = { - /** - * The member's email - */ - email: string; - /** - * The member's relationship to the team, an enum of `MEMBER`, `MANAGER`, `LEAD`, `POINT_OF_CONTACT`, `OTHER` - */ - relationship?: string | undefined; - /** - * The member's start date - */ - joinDate?: RFCDate | undefined; -}; - -declare function teamMemberFromJSON(jsonString: string): Result; - -declare function teamMemberToJSON(teamMember: TeamMember): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TeamStatus$ { - /** @deprecated use `TeamStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Processed: "PROCESSED"; - readonly QueuedForCreation: "QUEUED_FOR_CREATION"; - readonly QueuedForDeletion: "QUEUED_FOR_DELETION"; - }>; - /** @deprecated use `TeamStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Processed: "PROCESSED"; - readonly QueuedForCreation: "QUEUED_FOR_CREATION"; - readonly QueuedForDeletion: "QUEUED_FOR_DELETION"; - }>; -} - -/** @internal */ -declare const TeamStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TeamStatus$outboundSchema: z.ZodNativeEnum; - -/** - * whether this team is fully processed or there are still unprocessed operations that'll affect it - */ -declare const TeamStatus: { - readonly Processed: "PROCESSED"; - readonly QueuedForCreation: "QUEUED_FOR_CREATION"; - readonly QueuedForDeletion: "QUEUED_FOR_DELETION"; -}; - -/** - * whether this team is fully processed or there are still unprocessed operations that'll affect it - */ -declare type TeamStatus = ClosedEnum; - -declare function teamToJSON(team: Team): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextRange$ { - /** @deprecated use `TextRange$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TextRange$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TextRange$Outbound` instead. */ - type Outbound = TextRange$Outbound; -} - -/** @internal */ -declare const TextRange$inboundSchema: z.ZodType; - -/** @internal */ -declare type TextRange$Outbound = { - startIndex: number; - endIndex?: number | undefined; - type?: string | undefined; - url?: string | undefined; - document?: Document$Outbound | undefined; -}; - -/** @internal */ -declare const TextRange$outboundSchema: z.ZodType; - -/** - * A subsection of a given string to which some special formatting should be applied. - */ -declare type TextRange = { - /** - * The inclusive start index of the range. - */ - startIndex: number; - /** - * The exclusive end index of the range. - */ - endIndex?: number | undefined; - type?: TextRangeType | undefined; - /** - * The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - */ - url?: string | undefined; - document?: Document_2 | undefined; -}; - -declare function textRangeFromJSON(jsonString: string): Result; - -declare function textRangeToJSON(textRange: TextRange): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextRangeType$ { - /** @deprecated use `TextRangeType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Bold: "BOLD"; - readonly Citation: "CITATION"; - readonly Highlight: "HIGHLIGHT"; - readonly Link: "LINK"; - }>; - /** @deprecated use `TextRangeType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Bold: "BOLD"; - readonly Citation: "CITATION"; - readonly Highlight: "HIGHLIGHT"; - readonly Link: "LINK"; - }>; -} - -/** @internal */ -declare const TextRangeType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TextRangeType$outboundSchema: z.ZodNativeEnum; - -declare const TextRangeType: { - readonly Bold: "BOLD"; - readonly Citation: "CITATION"; - readonly Highlight: "HIGHLIGHT"; - readonly Link: "LINK"; -}; - -declare type TextRangeType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Thumbnail$ { - /** @deprecated use `Thumbnail$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Thumbnail$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Thumbnail$Outbound` instead. */ - type Outbound = Thumbnail$Outbound; -} - -/** @internal */ -declare const Thumbnail$inboundSchema: z.ZodType; - -/** @internal */ -declare type Thumbnail$Outbound = { - photoId?: string | undefined; - url?: string | undefined; -}; - -/** @internal */ -declare const Thumbnail$outboundSchema: z.ZodType; - -declare type Thumbnail = { - /** - * Photo id if the thumbnail is from splash. - */ - photoId?: string | undefined; - /** - * Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - */ - url?: string | undefined; -}; - -declare function thumbnailFromJSON(jsonString: string): Result; - -declare function thumbnailToJSON(thumbnail: Thumbnail): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimeInterval$ { - /** @deprecated use `TimeInterval$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TimeInterval$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TimeInterval$Outbound` instead. */ - type Outbound = TimeInterval$Outbound; -} - -/** @internal */ -declare const TimeInterval$inboundSchema: z.ZodType; - -/** @internal */ -declare type TimeInterval$Outbound = { - start: string; - end: string; -}; - -/** @internal */ -declare const TimeInterval$outboundSchema: z.ZodType; - -declare type TimeInterval = { - /** - * The RFC3339 timestamp formatted start time of this event. - */ - start: string; - /** - * The RFC3339 timestamp formatted end time of this event. - */ - end: string; -}; - -declare function timeIntervalFromJSON(jsonString: string): Result; - -declare function timeIntervalToJSON(timeInterval: TimeInterval): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimePeriodType$ { - /** @deprecated use `TimePeriodType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AllTime: "ALL_TIME"; - readonly PastYear: "PAST_YEAR"; - readonly PastDay: "PAST_DAY"; - readonly Custom: "CUSTOM"; - readonly LastNDays: "LAST_N_DAYS"; - }>; - /** @deprecated use `TimePeriodType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AllTime: "ALL_TIME"; - readonly PastYear: "PAST_YEAR"; - readonly PastDay: "PAST_DAY"; - readonly Custom: "CUSTOM"; - readonly LastNDays: "LAST_N_DAYS"; - }>; -} - -/** @internal */ -declare const TimePeriodType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TimePeriodType$outboundSchema: z.ZodNativeEnum; - -/** - * Type of time period for which to run the report/policy. PAST_DAY is deprecated. - */ -declare const TimePeriodType: { - readonly AllTime: "ALL_TIME"; - readonly PastYear: "PAST_YEAR"; - readonly PastDay: "PAST_DAY"; - readonly Custom: "CUSTOM"; - readonly LastNDays: "LAST_N_DAYS"; -}; - -/** - * Type of time period for which to run the report/policy. PAST_DAY is deprecated. - */ -declare type TimePeriodType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimePoint$ { - /** @deprecated use `TimePoint$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TimePoint$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TimePoint$Outbound` instead. */ - type Outbound = TimePoint$Outbound; -} - -/** @internal */ -declare const TimePoint$inboundSchema: z.ZodType; - -/** @internal */ -declare type TimePoint$Outbound = { - epochSeconds?: number | undefined; - daysFromNow?: number | undefined; -}; - -/** @internal */ -declare const TimePoint$outboundSchema: z.ZodType; - -declare type TimePoint = { - /** - * Epoch seconds. Has precedence over daysFromNow. - */ - epochSeconds?: number | undefined; - /** - * The number of days from now. Specification relative to current time. Can be negative. - */ - daysFromNow?: number | undefined; -}; - -declare function timePointFromJSON(jsonString: string): Result; - -declare function timePointToJSON(timePoint: TimePoint): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimeRange$ { - /** @deprecated use `TimeRange$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TimeRange$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TimeRange$Outbound` instead. */ - type Outbound = TimeRange$Outbound; -} - -/** @internal */ -declare const TimeRange$inboundSchema: z.ZodType; - -/** @internal */ -declare type TimeRange$Outbound = { - startTime?: string | undefined; - endTime?: string | undefined; - lastNDaysValue?: number | undefined; -}; - -/** @internal */ -declare const TimeRange$outboundSchema: z.ZodType; - -declare type TimeRange = { - /** - * start time of the time range, applicable for the CUSTOM type. - */ - startTime?: Date | undefined; - /** - * end time of the time range, applicable for the CUSTOM type. - */ - endTime?: Date | undefined; - /** - * The number of days to look back from the current time, applicable for the LAST_N_DAYS type. - */ - lastNDaysValue?: number | undefined; -}; - -declare function timeRangeFromJSON(jsonString: string): Result; - -declare function timeRangeToJSON(timeRange: TimeRange): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tool$Outbound` instead. */ - type Outbound = Tool$Outbound; -} - -/** @internal */ -declare const Tool$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tool$Outbound = { - type?: string | undefined; - name?: string | undefined; - displayName?: string | undefined; - description?: string | undefined; - parameters?: { - [k: string]: ToolParameter$Outbound; - } | undefined; -}; - -/** @internal */ -declare const Tool$outboundSchema: z.ZodType; - -declare type Tool = { - /** - * Type of tool (READ, WRITE) - */ - type?: ToolType | undefined; - /** - * Unique identifier for the tool - */ - name?: string | undefined; - /** - * Human-readable name - */ - displayName?: string | undefined; - /** - * LLM friendly description of the tool - */ - description?: string | undefined; - /** - * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - */ - parameters?: { - [k: string]: ToolParameter; - } | undefined; -}; - -declare function toolFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolInfo$ { - /** @deprecated use `ToolInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolInfo$Outbound` instead. */ - type Outbound = ToolInfo$Outbound; -} - -/** @internal */ -declare const ToolInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolInfo$Outbound = { - metadata?: ToolMetadata$Outbound | undefined; - parameters?: { - [k: string]: WriteActionParameter$Outbound; - } | undefined; -}; - -/** @internal */ -declare const ToolInfo$outboundSchema: z.ZodType; - -declare type ToolInfo = { - /** - * The manifest for a tool that can be used to augment Glean Assistant. - */ - metadata?: ToolMetadata | undefined; - /** - * Parameters supported by the tool. - */ - parameters?: { - [k: string]: WriteActionParameter; - } | undefined; -}; - -declare function toolInfoFromJSON(jsonString: string): Result; - -declare function toolInfoToJSON(toolInfo: ToolInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMetadata$ { - /** @deprecated use `ToolMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMetadata$Outbound` instead. */ - type Outbound = ToolMetadata$Outbound; -} - -/** @internal */ -declare const ToolMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMetadata$Outbound = { - type: string; - name: string; - displayName: string; - toolId?: string | undefined; - displayDescription: string; - logoUrl?: string | undefined; - objectName?: string | undefined; - knowledgeType?: string | undefined; - createdBy?: PersonObject$Outbound | undefined; - lastUpdatedBy?: PersonObject$Outbound | undefined; - createdAt?: string | undefined; - lastUpdatedAt?: string | undefined; - writeActionType?: string | undefined; - authType?: string | undefined; - auth?: AuthConfig$Outbound | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - usageInstructions?: string | undefined; - isSetupFinished?: boolean | undefined; -}; - -/** @internal */ -declare const ToolMetadata$outboundSchema: z.ZodType; - -/** - * The manifest for a tool that can be used to augment Glean Assistant. - */ -declare type ToolMetadata = { - /** - * The type of tool. - */ - type: ToolMetadataType; - /** - * Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool. - */ - name: string; - /** - * Human understandable name of the tool. Max 50 characters. - */ - displayName: string; - /** - * An opaque id which is unique identifier for the tool. - */ - toolId?: string | undefined; - /** - * Description of the tool meant for a human. - */ - displayDescription: string; - /** - * URL used to fetch the logo. - */ - logoUrl?: string | undefined; - /** - * Name of the generated object. This will be used to indicate to the end user what the generated object contains. - */ - objectName?: string | undefined; - /** - * Indicates the kind of knowledge a tool would access or modify. - */ - knowledgeType?: KnowledgeType | undefined; - createdBy?: PersonObject | undefined; - lastUpdatedBy?: PersonObject | undefined; - /** - * The time the tool was created in ISO format (ISO 8601) - */ - createdAt?: Date | undefined; - /** - * The time the tool was last updated in ISO format (ISO 8601) - */ - lastUpdatedAt?: Date | undefined; - /** - * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. - */ - writeActionType?: WriteActionType | undefined; - /** - * The type of authentication being used. - * - * @remarks - * Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - * 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - * 'OAUTH_USER' uses individual user tokens for external API calls. - * 'DWD' refers to domain wide delegation. - */ - authType?: AuthType | undefined; - /** - * Config for tool's authentication method. - */ - auth?: AuthConfig | undefined; - permissions?: ObjectPermissions | undefined; - /** - * Usage instructions for the LLM to use this action. - */ - usageInstructions?: string | undefined; - /** - * Whether this action has been fully configured and validated. - */ - isSetupFinished?: boolean | undefined; -}; - -declare function toolMetadataFromJSON(jsonString: string): Result; - -declare function toolMetadataToJSON(toolMetadata: ToolMetadata): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMetadataType$ { - /** @deprecated use `ToolMetadataType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Retrieval: "RETRIEVAL"; - readonly Action: "ACTION"; - }>; - /** @deprecated use `ToolMetadataType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Retrieval: "RETRIEVAL"; - readonly Action: "ACTION"; - }>; -} - -/** @internal */ -declare const ToolMetadataType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolMetadataType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of tool. - */ -declare const ToolMetadataType: { - readonly Retrieval: "RETRIEVAL"; - readonly Action: "ACTION"; -}; - -/** - * The type of tool. - */ -declare type ToolMetadataType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolParameter$ { - /** @deprecated use `ToolParameter$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolParameter$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolParameter$Outbound` instead. */ - type Outbound = ToolParameter$Outbound; -} - -/** @internal */ -declare const ToolParameter$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolParameter$Outbound = { - type?: string | undefined; - name?: string | undefined; - description?: string | undefined; - isRequired?: boolean | undefined; - possibleValues?: Array | undefined; - items?: ToolParameter$Outbound | undefined; - properties?: { - [k: string]: ToolParameter$Outbound; - } | undefined; -}; - -/** @internal */ -declare const ToolParameter$outboundSchema: z.ZodType; - -declare type ToolParameter = { - /** - * Parameter type (string, number, boolean, object, array) - */ - type?: ToolParameterType | undefined; - /** - * The name of the parameter - */ - name?: string | undefined; - /** - * The description of the parameter - */ - description?: string | undefined; - /** - * Whether the parameter is required - */ - isRequired?: boolean | undefined; - /** - * The possible values for the parameter. Can contain only primitive values or arrays of primitive values. - */ - possibleValues?: Array | undefined; - items?: ToolParameter | undefined; - /** - * When type is 'object', this describes the structure of the object. - */ - properties?: { - [k: string]: ToolParameter; - } | undefined; -}; - -declare function toolParameterFromJSON(jsonString: string): Result; - -declare function toolParameterToJSON(toolParameter: ToolParameter): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolParameterType$ { - /** @deprecated use `ToolParameterType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly String: "string"; - readonly Number: "number"; - readonly Boolean: "boolean"; - readonly Object: "object"; - readonly Array: "array"; - }>; - /** @deprecated use `ToolParameterType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly String: "string"; - readonly Number: "number"; - readonly Boolean: "boolean"; - readonly Object: "object"; - readonly Array: "array"; - }>; -} - -/** @internal */ -declare const ToolParameterType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolParameterType$outboundSchema: z.ZodNativeEnum; - -/** - * Parameter type (string, number, boolean, object, array) - */ -declare const ToolParameterType: { - readonly String: "string"; - readonly Number: "number"; - readonly Boolean: "boolean"; - readonly Object: "object"; - readonly Array: "array"; -}; - -/** - * Parameter type (string, number, boolean, object, array) - */ -declare type ToolParameterType = ClosedEnum; - -declare class Tools extends ClientSDK { - /** - * List available tools - * - * @remarks - * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned. - */ - list(toolNames?: Array | undefined, options?: RequestOptions): Promise; - /** - * Execute the specified tool - * - * @remarks - * Execute the specified tool with provided parameters - */ - run(request: components.ToolsCallRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolsCallParameter$ { - /** @deprecated use `ToolsCallParameter$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolsCallParameter$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolsCallParameter$Outbound` instead. */ - type Outbound = ToolsCallParameter$Outbound; -} - -/** @internal */ -declare const ToolsCallParameter$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolsCallParameter$Outbound = { - name: string; - value: string; - items?: Array | undefined; - properties?: { - [k: string]: ToolsCallParameter$Outbound; - } | undefined; -}; - -/** @internal */ -declare const ToolsCallParameter$outboundSchema: z.ZodType; - -declare type ToolsCallParameter = { - /** - * The name of the parameter - */ - name: string; - /** - * The value of the parameter (for primitive types) - */ - value: string; - /** - * The value of the parameter (for array types) - */ - items?: Array | undefined; - /** - * The value of the parameter (for object types) - */ - properties?: { - [k: string]: ToolsCallParameter; - } | undefined; -}; - -declare function toolsCallParameterFromJSON(jsonString: string): Result; - -declare function toolsCallParameterToJSON(toolsCallParameter: ToolsCallParameter): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolsCallRequest$ { - /** @deprecated use `ToolsCallRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolsCallRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolsCallRequest$Outbound` instead. */ - type Outbound = ToolsCallRequest$Outbound; -} - -/** @internal */ -declare const ToolsCallRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolsCallRequest$Outbound = { - name: string; - parameters: { - [k: string]: ToolsCallParameter$Outbound; - }; -}; - -/** @internal */ -declare const ToolsCallRequest$outboundSchema: z.ZodType; - -declare type ToolsCallRequest = { - /** - * Required name of the tool to execute - */ - name: string; - /** - * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - */ - parameters: { - [k: string]: ToolsCallParameter; - }; -}; - -declare function toolsCallRequestFromJSON(jsonString: string): Result; - -declare function toolsCallRequestToJSON(toolsCallRequest: ToolsCallRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolsCallResponse$ { - /** @deprecated use `ToolsCallResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolsCallResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolsCallResponse$Outbound` instead. */ - type Outbound = ToolsCallResponse$Outbound; -} - -/** @internal */ -declare const ToolsCallResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolsCallResponse$Outbound = { - rawResponse?: { - [k: string]: any; - } | undefined; - error?: string | undefined; -}; - -/** @internal */ -declare const ToolsCallResponse$outboundSchema: z.ZodType; - -declare type ToolsCallResponse = { - /** - * The raw response from the tool - */ - rawResponse?: { - [k: string]: any; - } | undefined; - /** - * The error message if applicable - */ - error?: string | undefined; -}; - -declare function toolsCallResponseFromJSON(jsonString: string): Result; - -declare function toolsCallResponseToJSON(toolsCallResponse: ToolsCallResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolSets$ { - /** @deprecated use `ToolSets$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolSets$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolSets$Outbound` instead. */ - type Outbound = ToolSets$Outbound; -} - -/** @internal */ -declare const ToolSets$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolSets$Outbound = { - enableWebSearch?: boolean | undefined; - enableCompanyTools?: boolean | undefined; -}; - -/** @internal */ -declare const ToolSets$outboundSchema: z.ZodType; - -/** - * The types of tools that the agent is allowed to use. Only works with FAST and ADVANCED `agent` values - */ -declare type ToolSets = { - /** - * Whether the agent is allowed to use web search (default: true). - */ - enableWebSearch?: boolean | undefined; - /** - * Whether the agent is allowed to search internal company resources (default: true). - */ - enableCompanyTools?: boolean | undefined; -}; - -declare function toolSetsFromJSON(jsonString: string): Result; - -declare function toolSetsToJSON(toolSets: ToolSets): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolsListResponse$ { - /** @deprecated use `ToolsListResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolsListResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolsListResponse$Outbound` instead. */ - type Outbound = ToolsListResponse$Outbound; -} - -/** @internal */ -declare const ToolsListResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolsListResponse$Outbound = { - tools?: Array | undefined; -}; - -/** @internal */ -declare const ToolsListResponse$outboundSchema: z.ZodType; - -declare type ToolsListResponse = { - tools?: Array | undefined; -}; - -declare function toolsListResponseFromJSON(jsonString: string): Result; - -declare function toolsListResponseToJSON(toolsListResponse: ToolsListResponse): string; - -declare function toolToJSON(tool: Tool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolType$ { - /** @deprecated use `ToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Read: "READ"; - readonly Write: "WRITE"; - }>; - /** @deprecated use `ToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Read: "READ"; - readonly Write: "WRITE"; - }>; -} - -/** @internal */ -declare const ToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolType$outboundSchema: z.ZodNativeEnum; - -/** - * Type of tool (READ, WRITE) - */ -declare const ToolType: { - readonly Read: "READ"; - readonly Write: "WRITE"; -}; - -/** - * Type of tool (READ, WRITE) - */ -declare type ToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UgcType$ { - /** @deprecated use `UgcType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AnnouncementsType: "ANNOUNCEMENTS_TYPE"; - readonly AnswersType: "ANSWERS_TYPE"; - readonly CollectionsType: "COLLECTIONS_TYPE"; - readonly ShortcutsType: "SHORTCUTS_TYPE"; - readonly WorkflowsType: "WORKFLOWS_TYPE"; - readonly PromptTemplatesType: "PROMPT_TEMPLATES_TYPE"; - }>; - /** @deprecated use `UgcType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AnnouncementsType: "ANNOUNCEMENTS_TYPE"; - readonly AnswersType: "ANSWERS_TYPE"; - readonly CollectionsType: "COLLECTIONS_TYPE"; - readonly ShortcutsType: "SHORTCUTS_TYPE"; - readonly WorkflowsType: "WORKFLOWS_TYPE"; - readonly PromptTemplatesType: "PROMPT_TEMPLATES_TYPE"; - }>; -} - -/** @internal */ -declare const UgcType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UgcType$outboundSchema: z.ZodNativeEnum; - -declare const UgcType: { - readonly AnnouncementsType: "ANNOUNCEMENTS_TYPE"; - readonly AnswersType: "ANSWERS_TYPE"; - readonly CollectionsType: "COLLECTIONS_TYPE"; - readonly ShortcutsType: "SHORTCUTS_TYPE"; - readonly WorkflowsType: "WORKFLOWS_TYPE"; - readonly PromptTemplatesType: "PROMPT_TEMPLATES_TYPE"; -}; - -declare type UgcType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UiConfig$ { - /** @deprecated use `UiConfig$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UiConfig$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UiConfig$Outbound` instead. */ - type Outbound = UiConfig$Outbound; -} - -/** @internal */ -declare const UiConfig$inboundSchema: z.ZodType; - -/** @internal */ -declare type UiConfig$Outbound = { - format?: string | undefined; - additionalFlags?: DisplayableListItemUIConfig$Outbound | undefined; -}; - -/** @internal */ -declare const UiConfig$outboundSchema: z.ZodType; - -declare type UiConfig = { - /** - * defines how to render this particular displayable list card - */ - format?: Format | undefined; - /** - * UI configurations for each item of the list - */ - additionalFlags?: DisplayableListItemUIConfig | undefined; -}; - -declare function uiConfigFromJSON(jsonString: string): Result; - -declare function uiConfigToJSON(uiConfig: UiConfig): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UiOptions$ { - /** @deprecated use `UiOptions$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly SearchResult: "SEARCH_RESULT"; - readonly DocHovercard: "DOC_HOVERCARD"; - }>; - /** @deprecated use `UiOptions$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly None: "NONE"; - readonly SearchResult: "SEARCH_RESULT"; - readonly DocHovercard: "DOC_HOVERCARD"; - }>; -} - -/** @internal */ -declare const UiOptions$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UiOptions$outboundSchema: z.ZodNativeEnum; - -declare const UiOptions: { - readonly None: "NONE"; - readonly SearchResult: "SEARCH_RESULT"; - readonly DocHovercard: "DOC_HOVERCARD"; -}; - -declare type UiOptions = ClosedEnum; - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -declare class UnexpectedClientError extends HTTPClientError { - name: string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Unpin$ { - /** @deprecated use `Unpin$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Unpin$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Unpin$Outbound` instead. */ - type Outbound = Unpin$Outbound; -} - -/** @internal */ -declare const Unpin$inboundSchema: z.ZodType; - -/** @internal */ -declare type Unpin$Outbound = { - id?: string | undefined; -}; - -/** @internal */ -declare const Unpin$outboundSchema: z.ZodType; - -declare type Unpin = { - /** - * The opaque id of the pin to be unpinned. - */ - id?: string | undefined; -}; - -declare function unpinFromJSON(jsonString: string): Result; - -declare function unpinToJSON(unpin: Unpin): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateAnnouncementRequest$ { - /** @deprecated use `UpdateAnnouncementRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateAnnouncementRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateAnnouncementRequest$Outbound` instead. */ - type Outbound = UpdateAnnouncementRequest$Outbound; -} - -/** @internal */ -declare const UpdateAnnouncementRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateAnnouncementRequest$Outbound = { - startTime: string; - endTime: string; - title: string; - body?: StructuredText$Outbound | undefined; - emoji?: string | undefined; - thumbnail?: Thumbnail$Outbound | undefined; - banner?: Thumbnail$Outbound | undefined; - audienceFilters?: Array | undefined; - sourceDocumentId?: string | undefined; - hideAttribution?: boolean | undefined; - channel?: string | undefined; - postType?: string | undefined; - isPrioritized?: boolean | undefined; - viewUrl?: string | undefined; - id: number; -}; - -/** @internal */ -declare const UpdateAnnouncementRequest$outboundSchema: z.ZodType; - -declare type UpdateAnnouncementRequest = { - /** - * The date and time at which the announcement becomes active. - */ - startTime: Date; - /** - * The date and time at which the announcement expires. - */ - endTime: Date; - /** - * The headline of the announcement. - */ - title: string; - body?: StructuredText | undefined; - /** - * An emoji used to indicate the nature of the announcement. - */ - emoji?: string | undefined; - thumbnail?: Thumbnail | undefined; - banner?: Thumbnail | undefined; - /** - * Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. - */ - audienceFilters?: Array | undefined; - /** - * The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - */ - sourceDocumentId?: string | undefined; - /** - * Whether or not to hide an author attribution. - */ - hideAttribution?: boolean | undefined; - /** - * This determines whether this is a Social Feed post or a regular announcement. - */ - channel?: UpdateAnnouncementRequestChannel | undefined; - /** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ - postType?: UpdateAnnouncementRequestPostType | undefined; - /** - * Used by the Social Feed to pin posts to the front of the feed. - */ - isPrioritized?: boolean | undefined; - /** - * URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - */ - viewUrl?: string | undefined; - /** - * The opaque id of the announcement. - */ - id: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateAnnouncementRequestChannel$ { - /** @deprecated use `UpdateAnnouncementRequestChannel$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; - /** @deprecated use `UpdateAnnouncementRequestChannel$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; - }>; -} - -/** @internal */ -declare const UpdateAnnouncementRequestChannel$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UpdateAnnouncementRequestChannel$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare const UpdateAnnouncementRequestChannel: { - readonly Main: "MAIN"; - readonly SocialFeed: "SOCIAL_FEED"; -}; - -/** - * This determines whether this is a Social Feed post or a regular announcement. - */ -declare type UpdateAnnouncementRequestChannel = ClosedEnum; - -declare function updateAnnouncementRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateAnnouncementRequestPostType$ { - /** @deprecated use `UpdateAnnouncementRequestPostType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; - /** @deprecated use `UpdateAnnouncementRequestPostType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "TEXT"; - readonly Link: "LINK"; - }>; -} - -/** @internal */ -declare const UpdateAnnouncementRequestPostType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UpdateAnnouncementRequestPostType$outboundSchema: z.ZodNativeEnum; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare const UpdateAnnouncementRequestPostType: { - readonly Text: "TEXT"; - readonly Link: "LINK"; -}; - -/** - * This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - */ -declare type UpdateAnnouncementRequestPostType = ClosedEnum; - -declare function updateAnnouncementRequestToJSON(updateAnnouncementRequest: UpdateAnnouncementRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDlpConfigRequest$ { - /** @deprecated use `UpdateDlpConfigRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpConfigRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpConfigRequest$Outbound` instead. */ - type Outbound = UpdateDlpConfigRequest$Outbound; -} - -/** @internal */ -declare const UpdateDlpConfigRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDlpConfigRequest$Outbound = { - config?: DlpConfig$Outbound | undefined; - frequency?: string | undefined; -}; - -/** @internal */ -declare const UpdateDlpConfigRequest$outboundSchema: z.ZodType; - -declare type UpdateDlpConfigRequest = { - /** - * Detailed configuration of what documents and sensitive content will be scanned. - */ - config?: DlpConfig | undefined; - /** - * Only "ONCE" is supported for reports. - */ - frequency?: string | undefined; -}; - -declare function updateDlpConfigRequestFromJSON(jsonString: string): Result; - -declare function updateDlpConfigRequestToJSON(updateDlpConfigRequest: UpdateDlpConfigRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDlpConfigResponse$ { - /** @deprecated use `UpdateDlpConfigResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpConfigResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpConfigResponse$Outbound` instead. */ - type Outbound = UpdateDlpConfigResponse$Outbound; -} - -/** @internal */ -declare const UpdateDlpConfigResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDlpConfigResponse$Outbound = { - result?: string | undefined; - reportId?: string | undefined; -}; - -/** @internal */ -declare const UpdateDlpConfigResponse$outboundSchema: z.ZodType; - -declare type UpdateDlpConfigResponse = { - result?: DlpSimpleResult | undefined; - /** - * The id of the report that was just created and run. - */ - reportId?: string | undefined; -}; - -declare function updateDlpConfigResponseFromJSON(jsonString: string): Result; - -declare function updateDlpConfigResponseToJSON(updateDlpConfigResponse: UpdateDlpConfigResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDlpReportRequest$ { - /** @deprecated use `UpdateDlpReportRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpReportRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpReportRequest$Outbound` instead. */ - type Outbound = UpdateDlpReportRequest$Outbound; -} - -/** @internal */ -declare const UpdateDlpReportRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDlpReportRequest$Outbound = { - config?: DlpConfig$Outbound | undefined; - frequency?: string | undefined; - status?: string | undefined; - autoHideDocs?: boolean | undefined; - reportName?: string | undefined; -}; - -/** @internal */ -declare const UpdateDlpReportRequest$outboundSchema: z.ZodType; - -declare type UpdateDlpReportRequest = { - /** - * Detailed configuration of what documents and sensitive content will be scanned. - */ - config?: DlpConfig | undefined; - /** - * Interval between scans. DAILY is deprecated. - */ - frequency?: DlpFrequency | undefined; - /** - * The status of the policy/report. Only ACTIVE status will be picked for scans. - */ - status?: DlpReportStatus | undefined; - /** - * The new autoHideDoc boolean the policy will be updated to if provided. - */ - autoHideDocs?: boolean | undefined; - /** - * The new name of the policy if provided. - */ - reportName?: string | undefined; -}; - -declare function updateDlpReportRequestFromJSON(jsonString: string): Result; - -declare function updateDlpReportRequestToJSON(updateDlpReportRequest: UpdateDlpReportRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDlpReportResponse$ { - /** @deprecated use `UpdateDlpReportResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpReportResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDlpReportResponse$Outbound` instead. */ - type Outbound = UpdateDlpReportResponse$Outbound; -} - -/** @internal */ -declare const UpdateDlpReportResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDlpReportResponse$Outbound = { - result?: string | undefined; -}; - -/** @internal */ -declare const UpdateDlpReportResponse$outboundSchema: z.ZodType; - -declare type UpdateDlpReportResponse = { - result?: DlpSimpleResult | undefined; -}; - -declare function updateDlpReportResponseFromJSON(jsonString: string): Result; - -declare function updateDlpReportResponseToJSON(updateDlpReportResponse: UpdateDlpReportResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDocumentVisibilityOverridesRequest$ { - /** @deprecated use `UpdateDocumentVisibilityOverridesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDocumentVisibilityOverridesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDocumentVisibilityOverridesRequest$Outbound` instead. */ - type Outbound = UpdateDocumentVisibilityOverridesRequest$Outbound; -} - -/** @internal */ -declare const UpdateDocumentVisibilityOverridesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDocumentVisibilityOverridesRequest$Outbound = { - visibilityOverrides?: Array | undefined; -}; - -/** @internal */ -declare const UpdateDocumentVisibilityOverridesRequest$outboundSchema: z.ZodType; - -declare type UpdateDocumentVisibilityOverridesRequest = { - visibilityOverrides?: Array | undefined; -}; - -declare function updateDocumentVisibilityOverridesRequestFromJSON(jsonString: string): Result; - -declare function updateDocumentVisibilityOverridesRequestToJSON(updateDocumentVisibilityOverridesRequest: UpdateDocumentVisibilityOverridesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateDocumentVisibilityOverridesResponse$ { - /** @deprecated use `UpdateDocumentVisibilityOverridesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateDocumentVisibilityOverridesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateDocumentVisibilityOverridesResponse$Outbound` instead. */ - type Outbound = UpdateDocumentVisibilityOverridesResponse$Outbound; -} - -/** @internal */ -declare const UpdateDocumentVisibilityOverridesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateDocumentVisibilityOverridesResponse$Outbound = { - results?: Array | undefined; -}; - -/** @internal */ -declare const UpdateDocumentVisibilityOverridesResponse$outboundSchema: z.ZodType; - -declare type UpdateDocumentVisibilityOverridesResponse = { - /** - * The documents and whether their visibility was successfully updated. - */ - results?: Array | undefined; -}; - -declare function updateDocumentVisibilityOverridesResponseFromJSON(jsonString: string): Result; - -declare function updateDocumentVisibilityOverridesResponseToJSON(updateDocumentVisibilityOverridesResponse: UpdateDocumentVisibilityOverridesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdatePermissionsRequest$ { - /** @deprecated use `UpdatePermissionsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdatePermissionsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdatePermissionsRequest$Outbound` instead. */ - type Outbound = UpdatePermissionsRequest$Outbound; -} - -/** @internal */ -declare const UpdatePermissionsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdatePermissionsRequest$Outbound = { - datasource: string; - objectType?: string | undefined; - id?: string | undefined; - viewURL?: string | undefined; - permissions: DocumentPermissionsDefinition$Outbound; -}; - -/** @internal */ -declare const UpdatePermissionsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /updatepermissions API call - */ -declare type UpdatePermissionsRequest = { - datasource: string; - /** - * The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - */ - objectType?: string | undefined; - /** - * The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - */ - id?: string | undefined; - /** - * The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**' - * - * @remarks - */ - viewURL?: string | undefined; - /** - * describes the access control details of the document - */ - permissions: DocumentPermissionsDefinition; -}; - -declare function updatePermissionsRequestFromJSON(jsonString: string): Result; - -declare function updatePermissionsRequestToJSON(updatePermissionsRequest: UpdatePermissionsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdatepolicyRequest$ { - /** @deprecated use `UpdatepolicyRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdatepolicyRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdatepolicyRequest$Outbound` instead. */ - type Outbound = UpdatepolicyRequest$Outbound; -} - -/** @internal */ -declare const UpdatepolicyRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdatepolicyRequest$Outbound = { - id: string; - UpdateDlpReportRequest: components.UpdateDlpReportRequest$Outbound; -}; - -/** @internal */ -declare const UpdatepolicyRequest$outboundSchema: z.ZodType; - -declare type UpdatepolicyRequest = { - /** - * The id of the policy to fetch. - */ - id: string; - updateDlpReportRequest: components.UpdateDlpReportRequest; -}; - -declare function updatepolicyRequestFromJSON(jsonString: string): Result; - -declare function updatepolicyRequestToJSON(updatepolicyRequest: UpdatepolicyRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateShortcutRequest$ { - /** @deprecated use `UpdateShortcutRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateShortcutRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateShortcutRequest$Outbound` instead. */ - type Outbound = UpdateShortcutRequest$Outbound; -} - -/** @internal */ -declare const UpdateShortcutRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateShortcutRequest$Outbound = { - id: number; - inputAlias?: string | undefined; - destinationUrl?: string | undefined; - destinationDocumentId?: string | undefined; - description?: string | undefined; - unlisted?: boolean | undefined; - urlTemplate?: string | undefined; - addedRoles?: Array | undefined; - removedRoles?: Array | undefined; -}; - -/** @internal */ -declare const UpdateShortcutRequest$outboundSchema: z.ZodType; - -declare type UpdateShortcutRequest = { - /** - * The opaque id of the user generated content. - */ - id: number; - /** - * Link text following go/ prefix as entered by the user. - */ - inputAlias?: string | undefined; - /** - * Destination URL for the shortcut. - */ - destinationUrl?: string | undefined; - /** - * Glean Document ID for the URL, if known. - */ - destinationDocumentId?: string | undefined; - /** - * A short, plain text blurb to help people understand the intent of the shortcut. - */ - description?: string | undefined; - /** - * Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - */ - unlisted?: boolean | undefined; - /** - * For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - */ - urlTemplate?: string | undefined; - /** - * A list of user roles added for the Shortcut. - */ - addedRoles?: Array | undefined; - /** - * A list of user roles removed for the Shortcut. - */ - removedRoles?: Array | undefined; -}; - -declare function updateShortcutRequestFromJSON(jsonString: string): Result; - -declare function updateShortcutRequestToJSON(updateShortcutRequest: UpdateShortcutRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateShortcutResponse$ { - /** @deprecated use `UpdateShortcutResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateShortcutResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateShortcutResponse$Outbound` instead. */ - type Outbound = UpdateShortcutResponse$Outbound; -} - -/** @internal */ -declare const UpdateShortcutResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateShortcutResponse$Outbound = { - shortcut?: Shortcut$Outbound | undefined; - error?: ShortcutError$Outbound | undefined; -}; - -/** @internal */ -declare const UpdateShortcutResponse$outboundSchema: z.ZodType; - -declare type UpdateShortcutResponse = { - shortcut?: Shortcut | undefined; - error?: ShortcutError | undefined; -}; - -declare function updateShortcutResponseFromJSON(jsonString: string): Result; - -declare function updateShortcutResponseToJSON(updateShortcutResponse: UpdateShortcutResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateType$ { - /** @deprecated use `UpdateType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Actionable: "ACTIONABLE"; - readonly Informative: "INFORMATIVE"; - }>; - /** @deprecated use `UpdateType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Actionable: "ACTIONABLE"; - readonly Informative: "INFORMATIVE"; - }>; -} - -/** @internal */ -declare const UpdateType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UpdateType$outboundSchema: z.ZodNativeEnum; - -/** - * Optional type classification for the update. - */ -declare const UpdateType: { - readonly Actionable: "ACTIONABLE"; - readonly Informative: "INFORMATIVE"; -}; - -/** - * Optional type classification for the update. - */ -declare type UpdateType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadChatFilesRequest$ { - /** @deprecated use `UploadChatFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadChatFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadChatFilesRequest$Outbound` instead. */ - type Outbound = UploadChatFilesRequest$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadchatfilesRequest$ { - /** @deprecated use `UploadchatfilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadchatfilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadchatfilesRequest$Outbound` instead. */ - type Outbound = UploadchatfilesRequest$Outbound; -} - -/** @internal */ -declare const UploadChatFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare const UploadchatfilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadChatFilesRequest$Outbound = { - files: Array; -}; - -/** @internal */ -declare type UploadchatfilesRequest$Outbound = { - timezoneOffset?: number | undefined; - UploadChatFilesRequest: components.UploadChatFilesRequest$Outbound; -}; - -/** @internal */ -declare const UploadChatFilesRequest$outboundSchema: z.ZodType; - -/** @internal */ -declare const UploadchatfilesRequest$outboundSchema: z.ZodType; - -declare type UploadChatFilesRequest = { - /** - * Raw files to be uploaded for chat in binary format. - */ - files: Array; -}; - -declare type UploadchatfilesRequest = { - /** - * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - */ - timezoneOffset?: number | undefined; - uploadChatFilesRequest: components.UploadChatFilesRequest; -}; - -declare function uploadChatFilesRequestFromJSON(jsonString: string): Result; - -declare function uploadchatfilesRequestFromJSON(jsonString: string): Result; - -declare function uploadChatFilesRequestToJSON(uploadChatFilesRequest: UploadChatFilesRequest): string; - -declare function uploadchatfilesRequestToJSON(uploadchatfilesRequest: UploadchatfilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadChatFilesResponse$ { - /** @deprecated use `UploadChatFilesResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadChatFilesResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadChatFilesResponse$Outbound` instead. */ - type Outbound = UploadChatFilesResponse$Outbound; -} - -/** @internal */ -declare const UploadChatFilesResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadChatFilesResponse$Outbound = { - files?: Array | undefined; -}; - -/** @internal */ -declare const UploadChatFilesResponse$outboundSchema: z.ZodType; - -declare type UploadChatFilesResponse = { - /** - * Files uploaded for chat. - */ - files?: Array | undefined; -}; - -declare function uploadChatFilesResponseFromJSON(jsonString: string): Result; - -declare function uploadChatFilesResponseToJSON(uploadChatFilesResponse: UploadChatFilesResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadShortcutsRequest$ { - /** @deprecated use `UploadShortcutsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadShortcutsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadShortcutsRequest$Outbound` instead. */ - type Outbound = UploadShortcutsRequest$Outbound; -} - -/** @internal */ -declare const UploadShortcutsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadShortcutsRequest$Outbound = { - uploadId: string; - isFirstPage?: boolean | undefined; - isLastPage?: boolean | undefined; - forceRestartUpload?: boolean | undefined; - shortcuts: Array; -}; - -/** @internal */ -declare const UploadShortcutsRequest$outboundSchema: z.ZodType; - -/** - * Describes the request body of the /uploadshortcuts API call - */ -declare type UploadShortcutsRequest = { - /** - * Unique id that must be used for this bulk upload instance - */ - uploadId: string; - /** - * true if this is the first page of the upload. Defaults to false - */ - isFirstPage?: boolean | undefined; - /** - * true if this is the last page of the upload. Defaults to false - */ - isLastPage?: boolean | undefined; - /** - * Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - */ - forceRestartUpload?: boolean | undefined; - /** - * Batch of shortcuts information - */ - shortcuts: Array; -}; - -declare function uploadShortcutsRequestFromJSON(jsonString: string): Result; - -declare function uploadShortcutsRequestToJSON(uploadShortcutsRequest: UploadShortcutsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadStatusEnum$ { - /** @deprecated use `UploadStatusEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Uploaded: "UPLOADED"; - readonly NotUploaded: "NOT_UPLOADED"; - readonly StatusUnknown: "STATUS_UNKNOWN"; - }>; - /** @deprecated use `UploadStatusEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Uploaded: "UPLOADED"; - readonly NotUploaded: "NOT_UPLOADED"; - readonly StatusUnknown: "STATUS_UNKNOWN"; - }>; -} - -/** @internal */ -declare const UploadStatusEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UploadStatusEnum$outboundSchema: z.ZodNativeEnum; - -/** - * Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - */ -declare const UploadStatusEnum: { - readonly Uploaded: "UPLOADED"; - readonly NotUploaded: "NOT_UPLOADED"; - readonly StatusUnknown: "STATUS_UNKNOWN"; -}; - -/** - * Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - */ -declare type UploadStatusEnum = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace User$ { - /** @deprecated use `User$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `User$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `User$Outbound` instead. */ - type Outbound = User$Outbound; -} - -/** @internal */ -declare const User$inboundSchema: z.ZodType; - -/** @internal */ -declare type User$Outbound = { - userID?: string | undefined; - origID?: string | undefined; -}; - -/** @internal */ -declare const User$outboundSchema: z.ZodType; - -declare type User = { - /** - * An opaque user ID for the claimed authority (i.e., the actas param, or the origid if actas is not specified). - */ - userID?: string | undefined; - /** - * An opaque user ID for the authenticated user (ignores actas). - */ - origID?: string | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserActivity$ { - /** @deprecated use `UserActivity$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserActivity$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserActivity$Outbound` instead. */ - type Outbound = UserActivity$Outbound; -} - -/** @internal */ -declare const UserActivity$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserActivity$Outbound = { - actor?: Person$Outbound | undefined; - timestamp?: number | undefined; - action?: string | undefined; - aggregateVisitCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const UserActivity$outboundSchema: z.ZodType; - -declare type UserActivity = { - actor?: Person | undefined; - /** - * Unix timestamp of the activity (in seconds since epoch UTC). - */ - timestamp?: number | undefined; - /** - * The action for the activity - */ - action?: UserActivityAction | undefined; - aggregateVisitCount?: CountInfo | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserActivityAction$ { - /** @deprecated use `UserActivityAction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Add: "ADD"; - readonly AddReminder: "ADD_REMINDER"; - readonly Click: "CLICK"; - readonly Comment: "COMMENT"; - readonly Delete: "DELETE"; - readonly Dismiss: "DISMISS"; - readonly Edit: "EDIT"; - readonly Mention: "MENTION"; - readonly Move: "MOVE"; - readonly Other: "OTHER"; - readonly Restore: "RESTORE"; - readonly Unknown: "UNKNOWN"; - readonly Verify: "VERIFY"; - readonly View: "VIEW"; - }>; - /** @deprecated use `UserActivityAction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Add: "ADD"; - readonly AddReminder: "ADD_REMINDER"; - readonly Click: "CLICK"; - readonly Comment: "COMMENT"; - readonly Delete: "DELETE"; - readonly Dismiss: "DISMISS"; - readonly Edit: "EDIT"; - readonly Mention: "MENTION"; - readonly Move: "MOVE"; - readonly Other: "OTHER"; - readonly Restore: "RESTORE"; - readonly Unknown: "UNKNOWN"; - readonly Verify: "VERIFY"; - readonly View: "VIEW"; - }>; -} - -/** @internal */ -declare const UserActivityAction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UserActivityAction$outboundSchema: z.ZodNativeEnum; - -/** - * The action for the activity - */ -declare const UserActivityAction: { - readonly Add: "ADD"; - readonly AddReminder: "ADD_REMINDER"; - readonly Click: "CLICK"; - readonly Comment: "COMMENT"; - readonly Delete: "DELETE"; - readonly Dismiss: "DISMISS"; - readonly Edit: "EDIT"; - readonly Mention: "MENTION"; - readonly Move: "MOVE"; - readonly Other: "OTHER"; - readonly Restore: "RESTORE"; - readonly Unknown: "UNKNOWN"; - readonly Verify: "VERIFY"; - readonly View: "VIEW"; -}; - -/** - * The action for the activity - */ -declare type UserActivityAction = ClosedEnum; - -declare function userActivityFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserActivityInsight$ { - /** @deprecated use `UserActivityInsight$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserActivityInsight$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserActivityInsight$Outbound` instead. */ - type Outbound = UserActivityInsight$Outbound; -} - -/** @internal */ -declare const UserActivityInsight$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserActivityInsight$Outbound = { - user: Person$Outbound; - activity: string; - lastActivityTimestamp?: number | undefined; - activityCount?: CountInfo$Outbound | undefined; - activeDayCount?: CountInfo$Outbound | undefined; -}; - -/** @internal */ -declare const UserActivityInsight$outboundSchema: z.ZodType; - -declare type UserActivityInsight = { - user: Person; - /** - * Activity e.g. search, home page visit or all. - */ - activity: ActivityEnum; - /** - * Unix timestamp of the last activity (in seconds since epoch UTC). - */ - lastActivityTimestamp?: number | undefined; - activityCount?: CountInfo | undefined; - activeDayCount?: CountInfo | undefined; -}; - -declare function userActivityInsightFromJSON(jsonString: string): Result; - -declare function userActivityInsightToJSON(userActivityInsight: UserActivityInsight): string; - -declare function userActivityToJSON(userActivity: UserActivity): string; - -declare function userFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserGeneratedContentId$ { - /** @deprecated use `UserGeneratedContentId$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserGeneratedContentId$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserGeneratedContentId$Outbound` instead. */ - type Outbound = UserGeneratedContentId$Outbound; -} - -/** @internal */ -declare const UserGeneratedContentId$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserGeneratedContentId$Outbound = { - id?: number | undefined; -}; - -/** @internal */ -declare const UserGeneratedContentId$outboundSchema: z.ZodType; - -declare type UserGeneratedContentId = { - /** - * The opaque id of the user generated content. - */ - id?: number | undefined; -}; - -declare function userGeneratedContentIdFromJSON(jsonString: string): Result; - -declare function userGeneratedContentIdToJSON(userGeneratedContentId: UserGeneratedContentId): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserInsightsResponse$ { - /** @deprecated use `UserInsightsResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserInsightsResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserInsightsResponse$Outbound` instead. */ - type Outbound = UserInsightsResponse$Outbound; -} - -/** @internal */ -declare const UserInsightsResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserInsightsResponse$Outbound = { - lastLogTimestamp?: number | undefined; - activityInsights?: Array | undefined; - inactiveInsights?: Array | undefined; - totalTeammates?: number | undefined; - totalActiveUsers?: number | undefined; - departments?: Array | undefined; -}; - -/** @internal */ -declare const UserInsightsResponse$outboundSchema: z.ZodType; - -declare type UserInsightsResponse = { - /** - * Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - */ - lastLogTimestamp?: number | undefined; - /** - * Insights for all active users with respect to set of actions. - */ - activityInsights?: Array | undefined; - /** - * Insights for all in inactive users with respect to set of actions and time period. Activity count will be set to 0. - */ - inactiveInsights?: Array | undefined; - /** - * Total number of teammates that have logged in to the product, that are still valid teammates. - */ - totalTeammates?: number | undefined; - /** - * Total number of active users in the requested period. - */ - totalActiveUsers?: number | undefined; - /** - * list of departments applicable for users tab. - */ - departments?: Array | undefined; -}; - -declare function userInsightsResponseFromJSON(jsonString: string): Result; - -declare function userInsightsResponseToJSON(userInsightsResponse: UserInsightsResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserReferenceDefinition$ { - /** @deprecated use `UserReferenceDefinition$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserReferenceDefinition$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserReferenceDefinition$Outbound` instead. */ - type Outbound = UserReferenceDefinition$Outbound; -} - -/** @internal */ -declare const UserReferenceDefinition$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserReferenceDefinition$Outbound = { - email?: string | undefined; - datasourceUserId?: string | undefined; - name?: string | undefined; -}; - -/** @internal */ -declare const UserReferenceDefinition$outboundSchema: z.ZodType; - -/** - * Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - */ -declare type UserReferenceDefinition = { - email?: string | undefined; - /** - * some datasources refer to the user by the datasource user id in the document - */ - datasourceUserId?: string | undefined; - name?: string | undefined; -}; - -declare function userReferenceDefinitionFromJSON(jsonString: string): Result; - -declare function userReferenceDefinitionToJSON(userReferenceDefinition: UserReferenceDefinition): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserRole$ { - /** @deprecated use `UserRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Editor: "EDITOR"; - readonly Verifier: "VERIFIER"; - }>; - /** @deprecated use `UserRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Editor: "EDITOR"; - readonly Verifier: "VERIFIER"; - }>; -} - -/** @internal */ -declare const UserRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UserRole$outboundSchema: z.ZodNativeEnum; - -/** - * A user's role with respect to a specific document. - */ -declare const UserRole: { - readonly Owner: "OWNER"; - readonly Viewer: "VIEWER"; - readonly AnswerModerator: "ANSWER_MODERATOR"; - readonly Editor: "EDITOR"; - readonly Verifier: "VERIFIER"; -}; - -/** - * A user's role with respect to a specific document. - */ -declare type UserRole = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserRoleSpecification$ { - /** @deprecated use `UserRoleSpecification$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserRoleSpecification$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserRoleSpecification$Outbound` instead. */ - type Outbound = UserRoleSpecification$Outbound; -} - -/** @internal */ -declare const UserRoleSpecification$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserRoleSpecification$Outbound = { - sourceDocumentSpec?: DocumentSpecUnion$Outbound | undefined; - person?: Person$Outbound | undefined; - group?: Group$Outbound | undefined; - role: string; -}; - -/** @internal */ -declare const UserRoleSpecification$outboundSchema: z.ZodType; - -declare type UserRoleSpecification = { - sourceDocumentSpec?: DocumentSpecUnion | undefined; - person?: Person | undefined; - group?: Group | undefined; - /** - * A user's role with respect to a specific document. - */ - role: UserRole; -}; - -declare function userRoleSpecificationFromJSON(jsonString: string): Result; - -declare function userRoleSpecificationToJSON(userRoleSpecification: UserRoleSpecification): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserStatusResponse$ { - /** @deprecated use `UserStatusResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserStatusResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserStatusResponse$Outbound` instead. */ - type Outbound = UserStatusResponse$Outbound; -} - -/** @internal */ -declare const UserStatusResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserStatusResponse$Outbound = { - isActiveUser?: boolean | undefined; - uploadStatus?: string | undefined; - lastUploadedAt?: string | undefined; -}; - -/** @internal */ -declare const UserStatusResponse$outboundSchema: z.ZodType; - -/** - * Describes the user status response body - */ -declare type UserStatusResponse = { - /** - * Whether the user is active or not - */ - isActiveUser?: boolean | undefined; - /** - * Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - */ - uploadStatus?: UploadStatusEnum | undefined; - /** - * Time of last successful upload for the user, in ISO 8601 format - */ - lastUploadedAt?: string | undefined; -}; - -declare function userStatusResponseFromJSON(jsonString: string): Result; - -declare function userStatusResponseToJSON(userStatusResponse: UserStatusResponse): string; - -declare function userToJSON(user: User): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserViewInfo$ { - /** @deprecated use `UserViewInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserViewInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserViewInfo$Outbound` instead. */ - type Outbound = UserViewInfo$Outbound; -} - -/** @internal */ -declare const UserViewInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserViewInfo$Outbound = { - docId?: string | undefined; - docTitle?: string | undefined; - docUrl?: string | undefined; -}; - -/** @internal */ -declare const UserViewInfo$outboundSchema: z.ZodType; - -declare type UserViewInfo = { - /** - * Unique Glean Document ID of the associated document. - */ - docId?: string | undefined; - /** - * Title of associated document. - */ - docTitle?: string | undefined; - /** - * URL of associated document. - */ - docUrl?: string | undefined; -}; - -declare function userViewInfoFromJSON(jsonString: string): Result; - -declare function userViewInfoToJSON(userViewInfo: UserViewInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Value$ { - /** @deprecated use `Value$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Value$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Value$Outbound` instead. */ - type Outbound = Value$Outbound; -} - -/** @internal */ -declare const Value$inboundSchema: z.ZodType; - -/** @internal */ -declare type Value$Outbound = {}; - -/** @internal */ -declare const Value$outboundSchema: z.ZodType; - -/** - * Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs. - */ -declare type Value = {}; - -declare function valueFromJSON(jsonString: string): Result; - -declare function valueToJSON(value: Value): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Verification$ { - /** @deprecated use `Verification$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Verification$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Verification$Outbound` instead. */ - type Outbound = Verification$Outbound; -} - -/** @internal */ -declare const Verification$inboundSchema: z.ZodType; - -/** @internal */ -declare type Verification$Outbound = { - state: string; - metadata?: VerificationMetadata$Outbound | undefined; -}; - -/** @internal */ -declare const Verification$outboundSchema: z.ZodType; - -declare type Verification = { - /** - * The verification state for the document. - */ - state: State; - metadata?: VerificationMetadata | undefined; -}; - -declare class Verification_2 extends ClientSDK { - /** - * Create verification - * - * @remarks - * Creates a verification reminder for the document. Users can create verification reminders from different product surfaces. - */ - addReminder(request: components.ReminderRequest, options?: RequestOptions): Promise; - /** - * List verifications - * - * @remarks - * Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications. - */ - list(count?: number | undefined, options?: RequestOptions): Promise; - /** - * Update verification - * - * @remarks - * Verify documents to keep the knowledge up to date within customer corpus. - */ - verify(request: components.VerifyRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace VerificationFeed$ { - /** @deprecated use `VerificationFeed$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `VerificationFeed$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `VerificationFeed$Outbound` instead. */ - type Outbound = VerificationFeed$Outbound; -} - -/** @internal */ -declare const VerificationFeed$inboundSchema: z.ZodType; - -/** @internal */ -declare type VerificationFeed$Outbound = { - documents?: Array | undefined; -}; - -/** @internal */ -declare const VerificationFeed$outboundSchema: z.ZodType; - -declare type VerificationFeed = { - /** - * List of document infos that include verification related information for them. - */ - documents?: Array | undefined; -}; - -declare function verificationFeedFromJSON(jsonString: string): Result; - -declare function verificationFeedToJSON(verificationFeed: VerificationFeed): string; - -declare function verificationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace VerificationMetadata$ { - /** @deprecated use `VerificationMetadata$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `VerificationMetadata$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `VerificationMetadata$Outbound` instead. */ - type Outbound = VerificationMetadata$Outbound; -} - -/** @internal */ -declare const VerificationMetadata$inboundSchema: z.ZodType; - -/** @internal */ -declare type VerificationMetadata$Outbound = { - lastVerifier?: Person$Outbound | undefined; - lastVerificationTs?: number | undefined; - expirationTs?: number | undefined; - document?: Document$Outbound | undefined; - reminders?: Array | undefined; - lastReminder?: Reminder$Outbound | undefined; - visitorCount?: Array | undefined; - candidateVerifiers?: Array | undefined; -}; - -/** @internal */ -declare const VerificationMetadata$outboundSchema: z.ZodType; - -declare type VerificationMetadata = { - lastVerifier?: Person | undefined; - /** - * The unix timestamp of the verification (in seconds since epoch UTC). - */ - lastVerificationTs?: number | undefined; - /** - * The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC). - */ - expirationTs?: number | undefined; - document?: Document_2 | undefined; - /** - * Info about all outstanding verification reminders for the document if exists. - */ - reminders?: Array | undefined; - lastReminder?: Reminder | undefined; - /** - * Number of visitors to the document during included time periods. - */ - visitorCount?: Array | undefined; - /** - * List of potential verifiers for the document e.g. old verifiers and/or users with view/edit permissions. - */ - candidateVerifiers?: Array | undefined; -}; - -declare function verificationMetadataFromJSON(jsonString: string): Result; - -declare function verificationMetadataToJSON(verificationMetadata: VerificationMetadata): string; - -declare function verificationToJSON(verification: Verification): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace VerifyRequest$ { - /** @deprecated use `VerifyRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `VerifyRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `VerifyRequest$Outbound` instead. */ - type Outbound = VerifyRequest$Outbound; -} - -/** @internal */ -declare const VerifyRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type VerifyRequest$Outbound = { - documentId: string; - action?: string | undefined; -}; - -/** @internal */ -declare const VerifyRequest$outboundSchema: z.ZodType; - -declare type VerifyRequest = { - /** - * The document which is verified. - */ - documentId: string; - /** - * The verification action requested. - */ - action?: VerifyRequestAction | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace VerifyRequestAction$ { - /** @deprecated use `VerifyRequestAction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Verify: "VERIFY"; - readonly Deprecate: "DEPRECATE"; - readonly Unverify: "UNVERIFY"; - }>; - /** @deprecated use `VerifyRequestAction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Verify: "VERIFY"; - readonly Deprecate: "DEPRECATE"; - readonly Unverify: "UNVERIFY"; - }>; -} - -/** @internal */ -declare const VerifyRequestAction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const VerifyRequestAction$outboundSchema: z.ZodNativeEnum; - -/** - * The verification action requested. - */ -declare const VerifyRequestAction: { - readonly Verify: "VERIFY"; - readonly Deprecate: "DEPRECATE"; - readonly Unverify: "UNVERIFY"; -}; - -/** - * The verification action requested. - */ -declare type VerifyRequestAction = ClosedEnum; - -declare function verifyRequestFromJSON(jsonString: string): Result; - -declare function verifyRequestToJSON(verifyRequest: VerifyRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ViewerInfo$ { - /** @deprecated use `ViewerInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ViewerInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ViewerInfo$Outbound` instead. */ - type Outbound = ViewerInfo$Outbound; -} - -/** @internal */ -declare const ViewerInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ViewerInfo$Outbound = { - role?: string | undefined; - lastViewedTime?: string | undefined; -}; - -/** @internal */ -declare const ViewerInfo$outboundSchema: z.ZodType; - -declare type ViewerInfo = { - /** - * DEPRECATED - use permissions instead. Viewer's role on the specific document. - * - * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. - */ - role?: Role | undefined; - lastViewedTime?: Date | undefined; -}; - -declare function viewerInfoFromJSON(jsonString: string): Result; - -declare function viewerInfoToJSON(viewerInfo: ViewerInfo): string; - -declare class Visibilityoverrides extends ClientSDK { - /** - * Fetches documents visibility - * - * @remarks - * Fetches the visibility override status of the documents passed. - */ - list(docIds?: Array | undefined, options?: RequestOptions): Promise; - /** - * Hide or unhide docs - * - * @remarks - * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents. - */ - create(request: components.UpdateDocumentVisibilityOverridesRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WarningType$ { - /** @deprecated use `WarningType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly LongQuery: "LONG_QUERY"; - readonly QuotedPunctuation: "QUOTED_PUNCTUATION"; - readonly PunctuationOnly: "PUNCTUATION_ONLY"; - readonly CopypastedQuotes: "COPYPASTED_QUOTES"; - readonly InvalidOperator: "INVALID_OPERATOR"; - readonly MaybeInvalidFacetQuery: "MAYBE_INVALID_FACET_QUERY"; - readonly TooManyDatasourceGroups: "TOO_MANY_DATASOURCE_GROUPS"; - }>; - /** @deprecated use `WarningType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly LongQuery: "LONG_QUERY"; - readonly QuotedPunctuation: "QUOTED_PUNCTUATION"; - readonly PunctuationOnly: "PUNCTUATION_ONLY"; - readonly CopypastedQuotes: "COPYPASTED_QUOTES"; - readonly InvalidOperator: "INVALID_OPERATOR"; - readonly MaybeInvalidFacetQuery: "MAYBE_INVALID_FACET_QUERY"; - readonly TooManyDatasourceGroups: "TOO_MANY_DATASOURCE_GROUPS"; - }>; -} - -/** @internal */ -declare const WarningType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WarningType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of the warning. - */ -declare const WarningType: { - readonly LongQuery: "LONG_QUERY"; - readonly QuotedPunctuation: "QUOTED_PUNCTUATION"; - readonly PunctuationOnly: "PUNCTUATION_ONLY"; - readonly CopypastedQuotes: "COPYPASTED_QUOTES"; - readonly InvalidOperator: "INVALID_OPERATOR"; - readonly MaybeInvalidFacetQuery: "MAYBE_INVALID_FACET_QUERY"; - readonly TooManyDatasourceGroups: "TOO_MANY_DATASOURCE_GROUPS"; -}; - -/** - * The type of the warning. - */ -declare type WarningType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Workflow$ { - /** @deprecated use `Workflow$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Workflow$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Workflow$Outbound` instead. */ - type Outbound = Workflow$Outbound; -} - -/** @internal */ -declare const Workflow$inboundSchema: z.ZodType; - -/** @internal */ -declare type Workflow$Outbound = { - name?: string | undefined; - author?: Person$Outbound | undefined; - createTimestamp?: number | undefined; - lastUpdateTimestamp?: number | undefined; - lastUpdatedBy?: Person$Outbound | undefined; - permissions?: ObjectPermissions$Outbound | undefined; - id?: string | undefined; -}; - -/** @internal */ -declare const Workflow$outboundSchema: z.ZodType; - -declare type Workflow = { - /** - * The name of the workflow. - */ - name?: string | undefined; - author?: Person | undefined; - /** - * Server Unix timestamp of the creation time. - */ - createTimestamp?: number | undefined; - /** - * Server Unix timestamp of the last update time. - */ - lastUpdateTimestamp?: number | undefined; - lastUpdatedBy?: Person | undefined; - permissions?: ObjectPermissions | undefined; - /** - * The ID of the workflow. - */ - id?: string | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WorkflowFeedbackInfo$ { - /** @deprecated use `WorkflowFeedbackInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WorkflowFeedbackInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WorkflowFeedbackInfo$Outbound` instead. */ - type Outbound = WorkflowFeedbackInfo$Outbound; -} - -/** @internal */ -declare const WorkflowFeedbackInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type WorkflowFeedbackInfo$Outbound = { - source?: string | undefined; -}; - -/** @internal */ -declare const WorkflowFeedbackInfo$outboundSchema: z.ZodType; - -declare type WorkflowFeedbackInfo = { - /** - * Where the feedback of the workflow originated from - */ - source?: WorkflowFeedbackInfoSource | undefined; -}; - -declare function workflowFeedbackInfoFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WorkflowFeedbackInfoSource$ { - /** @deprecated use `WorkflowFeedbackInfoSource$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ZeroState: "ZERO_STATE"; - readonly Library: "LIBRARY"; - readonly Homepage: "HOMEPAGE"; - }>; - /** @deprecated use `WorkflowFeedbackInfoSource$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ZeroState: "ZERO_STATE"; - readonly Library: "LIBRARY"; - readonly Homepage: "HOMEPAGE"; - }>; -} - -/** @internal */ -declare const WorkflowFeedbackInfoSource$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WorkflowFeedbackInfoSource$outboundSchema: z.ZodNativeEnum; - -/** - * Where the feedback of the workflow originated from - */ -declare const WorkflowFeedbackInfoSource: { - readonly ZeroState: "ZERO_STATE"; - readonly Library: "LIBRARY"; - readonly Homepage: "HOMEPAGE"; -}; - -/** - * Where the feedback of the workflow originated from - */ -declare type WorkflowFeedbackInfoSource = ClosedEnum; - -declare function workflowFeedbackInfoToJSON(workflowFeedbackInfo: WorkflowFeedbackInfo): string; - -declare function workflowFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WorkflowResult$ { - /** @deprecated use `WorkflowResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WorkflowResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WorkflowResult$Outbound` instead. */ - type Outbound = WorkflowResult$Outbound; -} - -/** @internal */ -declare const WorkflowResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type WorkflowResult$Outbound = { - workflow: Workflow$Outbound; -}; - -/** @internal */ -declare const WorkflowResult$outboundSchema: z.ZodType; - -declare type WorkflowResult = { - workflow: Workflow; -}; - -declare function workflowResultFromJSON(jsonString: string): Result; - -declare function workflowResultToJSON(workflowResult: WorkflowResult): string; - -declare function workflowToJSON(workflow: Workflow): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WriteActionParameter$ { - /** @deprecated use `WriteActionParameter$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WriteActionParameter$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WriteActionParameter$Outbound` instead. */ - type Outbound = WriteActionParameter$Outbound; -} - -/** @internal */ -declare const WriteActionParameter$inboundSchema: z.ZodType; - -/** @internal */ -declare type WriteActionParameter$Outbound = { - type?: string | undefined; - displayName?: string | undefined; - value?: string | undefined; - isRequired?: boolean | undefined; - description?: string | undefined; - possibleValues?: Array | undefined; -}; - -/** @internal */ -declare const WriteActionParameter$outboundSchema: z.ZodType; - -declare type WriteActionParameter = { - /** - * The type of the value (e.g., integer, string, boolean, etc.) - */ - type?: WriteActionParameterType | undefined; - /** - * Human readable display name for the key. - */ - displayName?: string | undefined; - /** - * The value of the field. - */ - value?: string | undefined; - /** - * Is the parameter a required field. - */ - isRequired?: boolean | undefined; - /** - * Description of the parameter. - */ - description?: string | undefined; - /** - * Possible values that the parameter can take. - */ - possibleValues?: Array | undefined; -}; - -declare function writeActionParameterFromJSON(jsonString: string): Result; - -declare function writeActionParameterToJSON(writeActionParameter: WriteActionParameter): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WriteActionParameterType$ { - /** @deprecated use `WriteActionParameterType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Unknown: "UNKNOWN"; - readonly Integer: "INTEGER"; - readonly String: "STRING"; - readonly Boolean: "BOOLEAN"; - }>; - /** @deprecated use `WriteActionParameterType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Unknown: "UNKNOWN"; - readonly Integer: "INTEGER"; - readonly String: "STRING"; - readonly Boolean: "BOOLEAN"; - }>; -} - -/** @internal */ -declare const WriteActionParameterType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WriteActionParameterType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of the value (e.g., integer, string, boolean, etc.) - */ -declare const WriteActionParameterType: { - readonly Unknown: "UNKNOWN"; - readonly Integer: "INTEGER"; - readonly String: "STRING"; - readonly Boolean: "BOOLEAN"; -}; - -/** - * The type of the value (e.g., integer, string, boolean, etc.) - */ -declare type WriteActionParameterType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WriteActionType$ { - /** @deprecated use `WriteActionType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Redirect: "REDIRECT"; - readonly Execution: "EXECUTION"; - }>; - /** @deprecated use `WriteActionType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Redirect: "REDIRECT"; - readonly Execution: "EXECUTION"; - }>; -} - -/** @internal */ -declare const WriteActionType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WriteActionType$outboundSchema: z.ZodNativeEnum; - -/** - * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. - */ -declare const WriteActionType: { - readonly Redirect: "REDIRECT"; - readonly Execution: "EXECUTION"; -}; - -/** - * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. - */ -declare type WriteActionType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WritePermission$ { - /** @deprecated use `WritePermission$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WritePermission$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WritePermission$Outbound` instead. */ - type Outbound = WritePermission$Outbound; -} - -/** @internal */ -declare const WritePermission$inboundSchema: z.ZodType; - -/** @internal */ -declare type WritePermission$Outbound = { - scopeType?: string | undefined; - create?: boolean | undefined; - update?: boolean | undefined; - delete?: boolean | undefined; -}; - -/** @internal */ -declare const WritePermission$outboundSchema: z.ZodType; - -/** - * Describes the write permissions levels that a user has for a specific feature - */ -declare type WritePermission = { - /** - * Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - */ - scopeType?: ScopeType | undefined; - /** - * True if user has create permission for this feature and scope - */ - create?: boolean | undefined; - /** - * True if user has update permission for this feature and scope - */ - update?: boolean | undefined; - /** - * True if user has delete permission for this feature and scope - */ - delete?: boolean | undefined; -}; - -declare function writePermissionFromJSON(jsonString: string): Result; - -declare function writePermissionToJSON(writePermission: WritePermission): string; - -export { } diff --git a/examples/docusaurus/public/mistral-try-it-now/deps.js b/examples/docusaurus/public/mistral-try-it-now/deps.js deleted file mode 100644 index 151a02dbc..000000000 --- a/examples/docusaurus/public/mistral-try-it-now/deps.js +++ /dev/null @@ -1,41456 +0,0 @@ -(() => { - var __create = Object.create; - var __defProp = Object.defineProperty; - var __getOwnPropDesc = Object.getOwnPropertyDescriptor; - var __getOwnPropNames = Object.getOwnPropertyNames; - var __getProtoOf = Object.getPrototypeOf; - var __hasOwnProp = Object.prototype.hasOwnProperty; - var __commonJS = (cb, mod) => function __require() { - return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports; - }; - var __copyProps = (to, from, except, desc) => { - if (from && typeof from === "object" || typeof from === "function") { - for (let key of __getOwnPropNames(from)) - if (!__hasOwnProp.call(to, key) && key !== except) - __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); - } - return to; - }; - var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps( - // If the importer is in node compatibility mode or this is not an ESM - // file that has been converted to a CommonJS file using a Babel- - // compatible transform (i.e. "__esModule" has not been set), then set - // "default" to the CommonJS "module.exports" for node compatibility. - isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, - mod - )); - - // node_modules/@mistralai/mistralai/lib/url.js - var require_url = __commonJS({ - "node_modules/@mistralai/mistralai/lib/url.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.pathToFunc = pathToFunc; - var hasOwn = Object.prototype.hasOwnProperty; - function pathToFunc(pathPattern, options) { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - return function buildURLPath(params = {}) { - return pathPattern.replace(paramRE, function(_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error(`Parameter '${placeholder}' must be a string or number`); - } - return options?.charEncoding === "percent" ? encodeURIComponent(`${value}`) : `${value}`; - }); - }; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/config.js - var require_config = __commonJS({ - "node_modules/@mistralai/mistralai/lib/config.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDK_METADATA = exports.ServerList = exports.ServerEu = void 0; - exports.serverURLFromOptions = serverURLFromOptions; - var url_js_1 = require_url(); - exports.ServerEu = "eu"; - exports.ServerList = { - [exports.ServerEu]: "https://api.mistral.ai" - }; - function serverURLFromOptions(options) { - let serverURL = options.serverURL; - const params = {}; - if (!serverURL) { - const server = options.server ?? exports.ServerEu; - serverURL = exports.ServerList[server] || ""; - } - const u = (0, url_js_1.pathToFunc)(serverURL)(params); - return new URL(u); - } - exports.SDK_METADATA = { - language: "typescript", - openapiDocVersion: "1.0.0", - sdkVersion: "1.10.0", - genVersion: "2.687.13", - userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai" - }; - } - }); - - // node_modules/@mistralai/mistralai/lib/files.js - var require_files = __commonJS({ - "node_modules/@mistralai/mistralai/lib/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.readableStreamToArrayBuffer = readableStreamToArrayBuffer; - exports.getContentTypeFromFileName = getContentTypeFromFileName; - async function readableStreamToArrayBuffer(readable) { - const reader = readable.getReader(); - const chunks = []; - let totalLength = 0; - let done = false; - while (!done) { - const { value, done: doneReading } = await reader.read(); - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - return concatenatedChunks.buffer; - } - function getContentTypeFromFileName(fileName) { - if (!fileName) - return null; - const ext = fileName.toLowerCase().split(".").pop(); - if (!ext) - return null; - const mimeTypes = { - json: "application/json", - xml: "application/xml", - html: "text/html", - htm: "text/html", - txt: "text/plain", - csv: "text/csv", - pdf: "application/pdf", - png: "image/png", - jpg: "image/jpeg", - jpeg: "image/jpeg", - gif: "image/gif", - svg: "image/svg+xml", - js: "application/javascript", - css: "text/css", - zip: "application/zip", - tar: "application/x-tar", - gz: "application/gzip", - mp4: "video/mp4", - mp3: "audio/mpeg", - wav: "audio/wav", - webp: "image/webp", - ico: "image/x-icon", - woff: "font/woff", - woff2: "font/woff2", - ttf: "font/ttf", - otf: "font/otf" - }; - return mimeTypes[ext] || null; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/http.js - var require_http = __commonJS({ - "node_modules/@mistralai/mistralai/lib/http.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = void 0; - exports.matchContentType = matchContentType; - exports.matchStatusCode = matchStatusCode; - exports.matchResponse = matchResponse; - exports.isConnectionError = isConnectionError; - exports.isTimeoutError = isTimeoutError; - exports.isAbortError = isAbortError; - var DEFAULT_FETCHER = (input, init) => { - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } - }; - var HTTPClient = class _HTTPClient { - constructor(options = {}) { - this.options = options; - this.requestHooks = []; - this.requestErrorHooks = []; - this.responseHooks = []; - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - async request(request) { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - try { - const res = await this.fetcher(req); - for (const hook of this.responseHooks) { - await hook(res, req); - } - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - throw err; - } - } - addHook(...args) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - removeHook(...args) { - let target; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - return this; - } - clone() { - const child = new _HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - return child; - } - }; - exports.HTTPClient = HTTPClient; - var mediaParamSeparator = /\s*;\s*/g; - function matchContentType(response, pattern) { - if (pattern === "*") { - return true; - } - let contentType = response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - if (wantType.split("/").length !== 2) { - return false; - } - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - if (wantType !== "*/*" && gotType !== wantType && `${type}/*` !== wantType && `*/${subtype}` !== wantType) { - return false; - } - if (gotParams.length < wantParams.length) { - return false; - } - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - return true; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function matchStatusCode(response, codes) { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - return expectedCodes.some((ec) => { - const code = `${ec}`; - if (code === "default") { - return true; - } - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - function matchResponse(response, code, contentTypePattern) { - return matchStatusCode(response, code) && matchContentType(response, contentTypePattern); - } - function isConnectionError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isBrowserErr = err instanceof TypeError && err.message.toLowerCase().startsWith("failed to fetch"); - const isNodeErr = err instanceof TypeError && err.message.toLowerCase().startsWith("fetch failed"); - const isBunErr = "name" in err && err.name === "ConnectionError"; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnreset"; - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; - } - function isTimeoutError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - function isAbortError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/custom_user_agent.js - var require_custom_user_agent = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/custom_user_agent.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CustomUserAgentHook = void 0; - var config_1 = require_config(); - var CustomUserAgentHook = class { - beforeRequest(_, request) { - const version = config_1.SDK_METADATA.sdkVersion; - const ua = `mistral-client-typescript/${version}`; - request.headers.set("user-agent", ua); - if (!request.headers.get("user-agent")) { - request.headers.set("x-mistral-user-agent", ua); - } - return request; - } - }; - exports.CustomUserAgentHook = CustomUserAgentHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/deprecation_warning.js - var require_deprecation_warning = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/deprecation_warning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeprecationWarningHook = void 0; - var HEADER_MODEL_DEPRECATION_TIMESTAMP = "x-model-deprecation-timestamp"; - var DeprecationWarningHook = class { - afterSuccess(_, response) { - if (response.headers.has(HEADER_MODEL_DEPRECATION_TIMESTAMP)) { - response.clone().json().then((body) => { - const model = body.model; - console.warn(`WARNING: The model ${model} is deprecated and will be removed on ${response.headers.get(HEADER_MODEL_DEPRECATION_TIMESTAMP)}. Please refer to https://docs.mistral.ai/getting-started/models/#api-versioning for more information.`); - }); - } - return response; - } - }; - exports.DeprecationWarningHook = DeprecationWarningHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/registration.js - var require_registration = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/registration.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.initHooks = initHooks; - var custom_user_agent_1 = require_custom_user_agent(); - var deprecation_warning_1 = require_deprecation_warning(); - function initHooks(hooks) { - const customUserAgentHook = new custom_user_agent_1.CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook); - const deprecationWarningHook = new deprecation_warning_1.DeprecationWarningHook(); - hooks.registerAfterSuccessHook(deprecationWarningHook); - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/hooks.js - var require_hooks = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/hooks.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKHooks = void 0; - var registration_js_1 = require_registration(); - var SDKHooks = class { - constructor() { - this.sdkInitHooks = []; - this.beforeCreateRequestHooks = []; - this.beforeRequestHooks = []; - this.afterSuccessHooks = []; - this.afterErrorHooks = []; - const presetHooks = []; - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - (0, registration_js_1.initHooks)(this); - } - registerSDKInitHook(hook) { - this.sdkInitHooks.push(hook); - } - registerBeforeCreateRequestHook(hook) { - this.beforeCreateRequestHooks.push(hook); - } - registerBeforeRequestHook(hook) { - this.beforeRequestHooks.push(hook); - } - registerAfterSuccessHook(hook) { - this.afterSuccessHooks.push(hook); - } - registerAfterErrorHook(hook) { - this.afterErrorHooks.push(hook); - } - sdkInit(opts) { - return this.sdkInitHooks.reduce((opts2, hook) => hook.sdkInit(opts2), opts); - } - beforeCreateRequest(hookCtx, input) { - let inp = input; - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - return inp; - } - async beforeRequest(hookCtx, request) { - let req = request; - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - return req; - } - async afterSuccess(hookCtx, response) { - let res = response; - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - return res; - } - async afterError(hookCtx, response, error) { - let res = response; - let err = error; - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - return { response: res, error: err }; - } - }; - exports.SDKHooks = SDKHooks; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js - var require_httpclienterrors = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConnectionError = exports.RequestTimeoutError = exports.RequestAbortedError = exports.InvalidRequestError = exports.UnexpectedClientError = exports.HTTPClientError = void 0; - var HTTPClientError = class extends Error { - constructor(message, opts) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - super(msg, opts); - this.name = "HTTPClientError"; - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } - }; - exports.HTTPClientError = HTTPClientError; - var UnexpectedClientError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "UnexpectedClientError"; - } - }; - exports.UnexpectedClientError = UnexpectedClientError; - var InvalidRequestError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "InvalidRequestError"; - } - }; - exports.InvalidRequestError = InvalidRequestError; - var RequestAbortedError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestAbortedError"; - } - }; - exports.RequestAbortedError = RequestAbortedError; - var RequestTimeoutError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestTimeoutError"; - } - }; - exports.RequestTimeoutError = RequestTimeoutError; - var ConnectionError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "ConnectionError"; - } - }; - exports.ConnectionError = ConnectionError; - } - }); - - // node_modules/@mistralai/mistralai/types/fp.js - var require_fp = __commonJS({ - "node_modules/@mistralai/mistralai/types/fp.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OK = OK; - exports.ERR = ERR; - exports.unwrap = unwrap; - exports.unwrapAsync = unwrapAsync; - function OK(value) { - return { ok: true, value }; - } - function ERR(error) { - return { ok: false, error }; - } - function unwrap(r) { - if (!r.ok) { - throw r.error; - } - return r.value; - } - async function unwrapAsync(pr) { - const r = await pr; - if (!r.ok) { - throw r.error; - } - return r.value; - } - } - }); - - // node_modules/zod/v3/helpers/util.cjs - var require_util = __commonJS({ - "node_modules/zod/v3/helpers/util.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getParsedType = exports.ZodParsedType = exports.objectUtil = exports.util = void 0; - var util; - (function(util2) { - util2.assertEqual = (_) => { - }; - function assertIs(_arg) { - } - util2.assertIs = assertIs; - function assertNever(_x) { - throw new Error(); - } - util2.assertNever = assertNever; - util2.arrayToEnum = (items) => { - const obj = {}; - for (const item of items) { - obj[item] = item; - } - return obj; - }; - util2.getValidEnumValues = (obj) => { - const validKeys = util2.objectKeys(obj).filter((k) => typeof obj[obj[k]] !== "number"); - const filtered = {}; - for (const k of validKeys) { - filtered[k] = obj[k]; - } - return util2.objectValues(filtered); - }; - util2.objectValues = (obj) => { - return util2.objectKeys(obj).map(function(e) { - return obj[e]; - }); - }; - util2.objectKeys = typeof Object.keys === "function" ? (obj) => Object.keys(obj) : (object) => { - const keys = []; - for (const key in object) { - if (Object.prototype.hasOwnProperty.call(object, key)) { - keys.push(key); - } - } - return keys; - }; - util2.find = (arr, checker) => { - for (const item of arr) { - if (checker(item)) - return item; - } - return void 0; - }; - util2.isInteger = typeof Number.isInteger === "function" ? (val) => Number.isInteger(val) : (val) => typeof val === "number" && Number.isFinite(val) && Math.floor(val) === val; - function joinValues(array, separator = " | ") { - return array.map((val) => typeof val === "string" ? `'${val}'` : val).join(separator); - } - util2.joinValues = joinValues; - util2.jsonStringifyReplacer = (_, value) => { - if (typeof value === "bigint") { - return value.toString(); - } - return value; - }; - })(util || (exports.util = util = {})); - var objectUtil; - (function(objectUtil2) { - objectUtil2.mergeShapes = (first, second) => { - return { - ...first, - ...second - // second overwrites first - }; - }; - })(objectUtil || (exports.objectUtil = objectUtil = {})); - exports.ZodParsedType = util.arrayToEnum([ - "string", - "nan", - "number", - "integer", - "float", - "boolean", - "date", - "bigint", - "symbol", - "function", - "undefined", - "null", - "array", - "object", - "unknown", - "promise", - "void", - "never", - "map", - "set" - ]); - var getParsedType = (data) => { - const t = typeof data; - switch (t) { - case "undefined": - return exports.ZodParsedType.undefined; - case "string": - return exports.ZodParsedType.string; - case "number": - return Number.isNaN(data) ? exports.ZodParsedType.nan : exports.ZodParsedType.number; - case "boolean": - return exports.ZodParsedType.boolean; - case "function": - return exports.ZodParsedType.function; - case "bigint": - return exports.ZodParsedType.bigint; - case "symbol": - return exports.ZodParsedType.symbol; - case "object": - if (Array.isArray(data)) { - return exports.ZodParsedType.array; - } - if (data === null) { - return exports.ZodParsedType.null; - } - if (data.then && typeof data.then === "function" && data.catch && typeof data.catch === "function") { - return exports.ZodParsedType.promise; - } - if (typeof Map !== "undefined" && data instanceof Map) { - return exports.ZodParsedType.map; - } - if (typeof Set !== "undefined" && data instanceof Set) { - return exports.ZodParsedType.set; - } - if (typeof Date !== "undefined" && data instanceof Date) { - return exports.ZodParsedType.date; - } - return exports.ZodParsedType.object; - default: - return exports.ZodParsedType.unknown; - } - }; - exports.getParsedType = getParsedType; - } - }); - - // node_modules/zod/v3/ZodError.cjs - var require_ZodError = __commonJS({ - "node_modules/zod/v3/ZodError.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ZodError = exports.quotelessJson = exports.ZodIssueCode = void 0; - var util_js_1 = require_util(); - exports.ZodIssueCode = util_js_1.util.arrayToEnum([ - "invalid_type", - "invalid_literal", - "custom", - "invalid_union", - "invalid_union_discriminator", - "invalid_enum_value", - "unrecognized_keys", - "invalid_arguments", - "invalid_return_type", - "invalid_date", - "invalid_string", - "too_small", - "too_big", - "invalid_intersection_types", - "not_multiple_of", - "not_finite" - ]); - var quotelessJson = (obj) => { - const json = JSON.stringify(obj, null, 2); - return json.replace(/"([^"]+)":/g, "$1:"); - }; - exports.quotelessJson = quotelessJson; - var ZodError = class _ZodError extends Error { - get errors() { - return this.issues; - } - constructor(issues) { - super(); - this.issues = []; - this.addIssue = (sub) => { - this.issues = [...this.issues, sub]; - }; - this.addIssues = (subs = []) => { - this.issues = [...this.issues, ...subs]; - }; - const actualProto = new.target.prototype; - if (Object.setPrototypeOf) { - Object.setPrototypeOf(this, actualProto); - } else { - this.__proto__ = actualProto; - } - this.name = "ZodError"; - this.issues = issues; - } - format(_mapper) { - const mapper = _mapper || function(issue) { - return issue.message; - }; - const fieldErrors = { _errors: [] }; - const processError = (error) => { - for (const issue of error.issues) { - if (issue.code === "invalid_union") { - issue.unionErrors.map(processError); - } else if (issue.code === "invalid_return_type") { - processError(issue.returnTypeError); - } else if (issue.code === "invalid_arguments") { - processError(issue.argumentsError); - } else if (issue.path.length === 0) { - fieldErrors._errors.push(mapper(issue)); - } else { - let curr = fieldErrors; - let i = 0; - while (i < issue.path.length) { - const el = issue.path[i]; - const terminal = i === issue.path.length - 1; - if (!terminal) { - curr[el] = curr[el] || { _errors: [] }; - } else { - curr[el] = curr[el] || { _errors: [] }; - curr[el]._errors.push(mapper(issue)); - } - curr = curr[el]; - i++; - } - } - } - }; - processError(this); - return fieldErrors; - } - static assert(value) { - if (!(value instanceof _ZodError)) { - throw new Error(`Not a ZodError: ${value}`); - } - } - toString() { - return this.message; - } - get message() { - return JSON.stringify(this.issues, util_js_1.util.jsonStringifyReplacer, 2); - } - get isEmpty() { - return this.issues.length === 0; - } - flatten(mapper = (issue) => issue.message) { - const fieldErrors = {}; - const formErrors = []; - for (const sub of this.issues) { - if (sub.path.length > 0) { - const firstEl = sub.path[0]; - fieldErrors[firstEl] = fieldErrors[firstEl] || []; - fieldErrors[firstEl].push(mapper(sub)); - } else { - formErrors.push(mapper(sub)); - } - } - return { formErrors, fieldErrors }; - } - get formErrors() { - return this.flatten(); - } - }; - exports.ZodError = ZodError; - ZodError.create = (issues) => { - const error = new ZodError(issues); - return error; - }; - } - }); - - // node_modules/zod/v3/locales/en.cjs - var require_en = __commonJS({ - "node_modules/zod/v3/locales/en.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - var ZodError_js_1 = require_ZodError(); - var util_js_1 = require_util(); - var errorMap = (issue, _ctx) => { - let message; - switch (issue.code) { - case ZodError_js_1.ZodIssueCode.invalid_type: - if (issue.received === util_js_1.ZodParsedType.undefined) { - message = "Required"; - } else { - message = `Expected ${issue.expected}, received ${issue.received}`; - } - break; - case ZodError_js_1.ZodIssueCode.invalid_literal: - message = `Invalid literal value, expected ${JSON.stringify(issue.expected, util_js_1.util.jsonStringifyReplacer)}`; - break; - case ZodError_js_1.ZodIssueCode.unrecognized_keys: - message = `Unrecognized key(s) in object: ${util_js_1.util.joinValues(issue.keys, ", ")}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union_discriminator: - message = `Invalid discriminator value. Expected ${util_js_1.util.joinValues(issue.options)}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_enum_value: - message = `Invalid enum value. Expected ${util_js_1.util.joinValues(issue.options)}, received '${issue.received}'`; - break; - case ZodError_js_1.ZodIssueCode.invalid_arguments: - message = `Invalid function arguments`; - break; - case ZodError_js_1.ZodIssueCode.invalid_return_type: - message = `Invalid function return type`; - break; - case ZodError_js_1.ZodIssueCode.invalid_date: - message = `Invalid date`; - break; - case ZodError_js_1.ZodIssueCode.invalid_string: - if (typeof issue.validation === "object") { - if ("includes" in issue.validation) { - message = `Invalid input: must include "${issue.validation.includes}"`; - if (typeof issue.validation.position === "number") { - message = `${message} at one or more positions greater than or equal to ${issue.validation.position}`; - } - } else if ("startsWith" in issue.validation) { - message = `Invalid input: must start with "${issue.validation.startsWith}"`; - } else if ("endsWith" in issue.validation) { - message = `Invalid input: must end with "${issue.validation.endsWith}"`; - } else { - util_js_1.util.assertNever(issue.validation); - } - } else if (issue.validation !== "regex") { - message = `Invalid ${issue.validation}`; - } else { - message = "Invalid"; - } - break; - case ZodError_js_1.ZodIssueCode.too_small: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `more than`} ${issue.minimum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `over`} ${issue.minimum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "bigint") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${new Date(Number(issue.minimum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.too_big: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `less than`} ${issue.maximum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `under`} ${issue.maximum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "bigint") - message = `BigInt must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly` : issue.inclusive ? `smaller than or equal to` : `smaller than`} ${new Date(Number(issue.maximum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.custom: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_intersection_types: - message = `Intersection results could not be merged`; - break; - case ZodError_js_1.ZodIssueCode.not_multiple_of: - message = `Number must be a multiple of ${issue.multipleOf}`; - break; - case ZodError_js_1.ZodIssueCode.not_finite: - message = "Number must be finite"; - break; - default: - message = _ctx.defaultError; - util_js_1.util.assertNever(issue); - } - return { message }; - }; - exports.default = errorMap; - } - }); - - // node_modules/zod/v3/errors.cjs - var require_errors = __commonJS({ - "node_modules/zod/v3/errors.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.defaultErrorMap = void 0; - exports.setErrorMap = setErrorMap; - exports.getErrorMap = getErrorMap; - var en_js_1 = __importDefault(require_en()); - exports.defaultErrorMap = en_js_1.default; - var overrideErrorMap = en_js_1.default; - function setErrorMap(map) { - overrideErrorMap = map; - } - function getErrorMap() { - return overrideErrorMap; - } - } - }); - - // node_modules/zod/v3/helpers/parseUtil.cjs - var require_parseUtil = __commonJS({ - "node_modules/zod/v3/helpers/parseUtil.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isAsync = exports.isValid = exports.isDirty = exports.isAborted = exports.OK = exports.DIRTY = exports.INVALID = exports.ParseStatus = exports.EMPTY_PATH = exports.makeIssue = void 0; - exports.addIssueToContext = addIssueToContext; - var errors_js_1 = require_errors(); - var en_js_1 = __importDefault(require_en()); - var makeIssue = (params) => { - const { data, path, errorMaps, issueData } = params; - const fullPath = [...path, ...issueData.path || []]; - const fullIssue = { - ...issueData, - path: fullPath - }; - if (issueData.message !== void 0) { - return { - ...issueData, - path: fullPath, - message: issueData.message - }; - } - let errorMessage = ""; - const maps = errorMaps.filter((m) => !!m).slice().reverse(); - for (const map of maps) { - errorMessage = map(fullIssue, { data, defaultError: errorMessage }).message; - } - return { - ...issueData, - path: fullPath, - message: errorMessage - }; - }; - exports.makeIssue = makeIssue; - exports.EMPTY_PATH = []; - function addIssueToContext(ctx, issueData) { - const overrideMap = (0, errors_js_1.getErrorMap)(); - const issue = (0, exports.makeIssue)({ - issueData, - data: ctx.data, - path: ctx.path, - errorMaps: [ - ctx.common.contextualErrorMap, - // contextual error map is first priority - ctx.schemaErrorMap, - // then schema-bound map if available - overrideMap, - // then global override map - overrideMap === en_js_1.default ? void 0 : en_js_1.default - // then global default map - ].filter((x) => !!x) - }); - ctx.common.issues.push(issue); - } - var ParseStatus = class _ParseStatus { - constructor() { - this.value = "valid"; - } - dirty() { - if (this.value === "valid") - this.value = "dirty"; - } - abort() { - if (this.value !== "aborted") - this.value = "aborted"; - } - static mergeArray(status, results) { - const arrayValue = []; - for (const s of results) { - if (s.status === "aborted") - return exports.INVALID; - if (s.status === "dirty") - status.dirty(); - arrayValue.push(s.value); - } - return { status: status.value, value: arrayValue }; - } - static async mergeObjectAsync(status, pairs) { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value - }); - } - return _ParseStatus.mergeObjectSync(status, syncPairs); - } - static mergeObjectSync(status, pairs) { - const finalObject = {}; - for (const pair of pairs) { - const { key, value } = pair; - if (key.status === "aborted") - return exports.INVALID; - if (value.status === "aborted") - return exports.INVALID; - if (key.status === "dirty") - status.dirty(); - if (value.status === "dirty") - status.dirty(); - if (key.value !== "__proto__" && (typeof value.value !== "undefined" || pair.alwaysSet)) { - finalObject[key.value] = value.value; - } - } - return { status: status.value, value: finalObject }; - } - }; - exports.ParseStatus = ParseStatus; - exports.INVALID = Object.freeze({ - status: "aborted" - }); - var DIRTY = (value) => ({ status: "dirty", value }); - exports.DIRTY = DIRTY; - var OK = (value) => ({ status: "valid", value }); - exports.OK = OK; - var isAborted = (x) => x.status === "aborted"; - exports.isAborted = isAborted; - var isDirty = (x) => x.status === "dirty"; - exports.isDirty = isDirty; - var isValid = (x) => x.status === "valid"; - exports.isValid = isValid; - var isAsync = (x) => typeof Promise !== "undefined" && x instanceof Promise; - exports.isAsync = isAsync; - } - }); - - // node_modules/zod/v3/helpers/typeAliases.cjs - var require_typeAliases = __commonJS({ - "node_modules/zod/v3/helpers/typeAliases.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod/v3/helpers/errorUtil.cjs - var require_errorUtil = __commonJS({ - "node_modules/zod/v3/helpers/errorUtil.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.errorUtil = void 0; - var errorUtil; - (function(errorUtil2) { - errorUtil2.errToObj = (message) => typeof message === "string" ? { message } : message || {}; - errorUtil2.toString = (message) => typeof message === "string" ? message : message?.message; - })(errorUtil || (exports.errorUtil = errorUtil = {})); - } - }); - - // node_modules/zod/v3/types.cjs - var require_types = __commonJS({ - "node_modules/zod/v3/types.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.discriminatedUnion = exports.date = exports.boolean = exports.bigint = exports.array = exports.any = exports.coerce = exports.ZodFirstPartyTypeKind = exports.late = exports.ZodSchema = exports.Schema = exports.ZodReadonly = exports.ZodPipeline = exports.ZodBranded = exports.BRAND = exports.ZodNaN = exports.ZodCatch = exports.ZodDefault = exports.ZodNullable = exports.ZodOptional = exports.ZodTransformer = exports.ZodEffects = exports.ZodPromise = exports.ZodNativeEnum = exports.ZodEnum = exports.ZodLiteral = exports.ZodLazy = exports.ZodFunction = exports.ZodSet = exports.ZodMap = exports.ZodRecord = exports.ZodTuple = exports.ZodIntersection = exports.ZodDiscriminatedUnion = exports.ZodUnion = exports.ZodObject = exports.ZodArray = exports.ZodVoid = exports.ZodNever = exports.ZodUnknown = exports.ZodAny = exports.ZodNull = exports.ZodUndefined = exports.ZodSymbol = exports.ZodDate = exports.ZodBoolean = exports.ZodBigInt = exports.ZodNumber = exports.ZodString = exports.ZodType = void 0; - exports.NEVER = exports.void = exports.unknown = exports.union = exports.undefined = exports.tuple = exports.transformer = exports.symbol = exports.string = exports.strictObject = exports.set = exports.record = exports.promise = exports.preprocess = exports.pipeline = exports.ostring = exports.optional = exports.onumber = exports.oboolean = exports.object = exports.number = exports.nullable = exports.null = exports.never = exports.nativeEnum = exports.nan = exports.map = exports.literal = exports.lazy = exports.intersection = exports.instanceof = exports.function = exports.enum = exports.effect = void 0; - exports.datetimeRegex = datetimeRegex; - exports.custom = custom; - var ZodError_js_1 = require_ZodError(); - var errors_js_1 = require_errors(); - var errorUtil_js_1 = require_errorUtil(); - var parseUtil_js_1 = require_parseUtil(); - var util_js_1 = require_util(); - var ParseInputLazyPath = class { - constructor(parent, value, path, key) { - this._cachedPath = []; - this.parent = parent; - this.data = value; - this._path = path; - this._key = key; - } - get path() { - if (!this._cachedPath.length) { - if (Array.isArray(this._key)) { - this._cachedPath.push(...this._path, ...this._key); - } else { - this._cachedPath.push(...this._path, this._key); - } - } - return this._cachedPath; - } - }; - var handleResult = (ctx, result) => { - if ((0, parseUtil_js_1.isValid)(result)) { - return { success: true, data: result.value }; - } else { - if (!ctx.common.issues.length) { - throw new Error("Validation failed but no issues detected."); - } - return { - success: false, - get error() { - if (this._error) - return this._error; - const error = new ZodError_js_1.ZodError(ctx.common.issues); - this._error = error; - return this._error; - } - }; - } - }; - function processCreateParams(params) { - if (!params) - return {}; - const { errorMap, invalid_type_error, required_error, description } = params; - if (errorMap && (invalid_type_error || required_error)) { - throw new Error(`Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`); - } - if (errorMap) - return { errorMap, description }; - const customMap = (iss, ctx) => { - const { message } = params; - if (iss.code === "invalid_enum_value") { - return { message: message ?? ctx.defaultError }; - } - if (typeof ctx.data === "undefined") { - return { message: message ?? required_error ?? ctx.defaultError }; - } - if (iss.code !== "invalid_type") - return { message: ctx.defaultError }; - return { message: message ?? invalid_type_error ?? ctx.defaultError }; - }; - return { errorMap: customMap, description }; - } - var ZodType = class { - get description() { - return this._def.description; - } - _getType(input) { - return (0, util_js_1.getParsedType)(input.data); - } - _getOrReturnCtx(input, ctx) { - return ctx || { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - }; - } - _processInputParams(input) { - return { - status: new parseUtil_js_1.ParseStatus(), - ctx: { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - } - }; - } - _parseSync(input) { - const result = this._parse(input); - if ((0, parseUtil_js_1.isAsync)(result)) { - throw new Error("Synchronous parse encountered promise."); - } - return result; - } - _parseAsync(input) { - const result = this._parse(input); - return Promise.resolve(result); - } - parse(data, params) { - const result = this.safeParse(data, params); - if (result.success) - return result.data; - throw result.error; - } - safeParse(data, params) { - const ctx = { - common: { - issues: [], - async: params?.async ?? false, - contextualErrorMap: params?.errorMap - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const result = this._parseSync({ data, path: ctx.path, parent: ctx }); - return handleResult(ctx, result); - } - "~validate"(data) { - const ctx = { - common: { - issues: [], - async: !!this["~standard"].async - }, - path: [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - if (!this["~standard"].async) { - try { - const result = this._parseSync({ data, path: [], parent: ctx }); - return (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }; - } catch (err) { - if (err?.message?.toLowerCase()?.includes("encountered")) { - this["~standard"].async = true; - } - ctx.common = { - issues: [], - async: true - }; - } - } - return this._parseAsync({ data, path: [], parent: ctx }).then((result) => (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }); - } - async parseAsync(data, params) { - const result = await this.safeParseAsync(data, params); - if (result.success) - return result.data; - throw result.error; - } - async safeParseAsync(data, params) { - const ctx = { - common: { - issues: [], - contextualErrorMap: params?.errorMap, - async: true - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const maybeAsyncResult = this._parse({ data, path: ctx.path, parent: ctx }); - const result = await ((0, parseUtil_js_1.isAsync)(maybeAsyncResult) ? maybeAsyncResult : Promise.resolve(maybeAsyncResult)); - return handleResult(ctx, result); - } - refine(check, message) { - const getIssueProperties = (val) => { - if (typeof message === "string" || typeof message === "undefined") { - return { message }; - } else if (typeof message === "function") { - return message(val); - } else { - return message; - } - }; - return this._refinement((val, ctx) => { - const result = check(val); - const setError = () => ctx.addIssue({ - code: ZodError_js_1.ZodIssueCode.custom, - ...getIssueProperties(val) - }); - if (typeof Promise !== "undefined" && result instanceof Promise) { - return result.then((data) => { - if (!data) { - setError(); - return false; - } else { - return true; - } - }); - } - if (!result) { - setError(); - return false; - } else { - return true; - } - }); - } - refinement(check, refinementData) { - return this._refinement((val, ctx) => { - if (!check(val)) { - ctx.addIssue(typeof refinementData === "function" ? refinementData(val, ctx) : refinementData); - return false; - } else { - return true; - } - }); - } - _refinement(refinement) { - return new ZodEffects({ - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "refinement", refinement } - }); - } - superRefine(refinement) { - return this._refinement(refinement); - } - constructor(def) { - this.spa = this.safeParseAsync; - this._def = def; - this.parse = this.parse.bind(this); - this.safeParse = this.safeParse.bind(this); - this.parseAsync = this.parseAsync.bind(this); - this.safeParseAsync = this.safeParseAsync.bind(this); - this.spa = this.spa.bind(this); - this.refine = this.refine.bind(this); - this.refinement = this.refinement.bind(this); - this.superRefine = this.superRefine.bind(this); - this.optional = this.optional.bind(this); - this.nullable = this.nullable.bind(this); - this.nullish = this.nullish.bind(this); - this.array = this.array.bind(this); - this.promise = this.promise.bind(this); - this.or = this.or.bind(this); - this.and = this.and.bind(this); - this.transform = this.transform.bind(this); - this.brand = this.brand.bind(this); - this.default = this.default.bind(this); - this.catch = this.catch.bind(this); - this.describe = this.describe.bind(this); - this.pipe = this.pipe.bind(this); - this.readonly = this.readonly.bind(this); - this.isNullable = this.isNullable.bind(this); - this.isOptional = this.isOptional.bind(this); - this["~standard"] = { - version: 1, - vendor: "zod", - validate: (data) => this["~validate"](data) - }; - } - optional() { - return ZodOptional.create(this, this._def); - } - nullable() { - return ZodNullable.create(this, this._def); - } - nullish() { - return this.nullable().optional(); - } - array() { - return ZodArray.create(this); - } - promise() { - return ZodPromise.create(this, this._def); - } - or(option) { - return ZodUnion.create([this, option], this._def); - } - and(incoming) { - return ZodIntersection.create(this, incoming, this._def); - } - transform(transform) { - return new ZodEffects({ - ...processCreateParams(this._def), - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "transform", transform } - }); - } - default(def) { - const defaultValueFunc = typeof def === "function" ? def : () => def; - return new ZodDefault({ - ...processCreateParams(this._def), - innerType: this, - defaultValue: defaultValueFunc, - typeName: ZodFirstPartyTypeKind.ZodDefault - }); - } - brand() { - return new ZodBranded({ - typeName: ZodFirstPartyTypeKind.ZodBranded, - type: this, - ...processCreateParams(this._def) - }); - } - catch(def) { - const catchValueFunc = typeof def === "function" ? def : () => def; - return new ZodCatch({ - ...processCreateParams(this._def), - innerType: this, - catchValue: catchValueFunc, - typeName: ZodFirstPartyTypeKind.ZodCatch - }); - } - describe(description) { - const This = this.constructor; - return new This({ - ...this._def, - description - }); - } - pipe(target) { - return ZodPipeline.create(this, target); - } - readonly() { - return ZodReadonly.create(this); - } - isOptional() { - return this.safeParse(void 0).success; - } - isNullable() { - return this.safeParse(null).success; - } - }; - exports.ZodType = ZodType; - exports.Schema = ZodType; - exports.ZodSchema = ZodType; - var cuidRegex = /^c[^\s-]{8,}$/i; - var cuid2Regex = /^[0-9a-z]+$/; - var ulidRegex = /^[0-9A-HJKMNP-TV-Z]{26}$/i; - var uuidRegex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i; - var nanoidRegex = /^[a-z0-9_-]{21}$/i; - var jwtRegex = /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/; - var durationRegex = /^[-+]?P(?!$)(?:(?:[-+]?\d+Y)|(?:[-+]?\d+[.,]\d+Y$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:(?:[-+]?\d+W)|(?:[-+]?\d+[.,]\d+W$))?(?:(?:[-+]?\d+D)|(?:[-+]?\d+[.,]\d+D$))?(?:T(?=[\d+-])(?:(?:[-+]?\d+H)|(?:[-+]?\d+[.,]\d+H$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:[-+]?\d+(?:[.,]\d+)?S)?)??$/; - var emailRegex = /^(?!\.)(?!.*\.\.)([A-Z0-9_'+\-\.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9\-]*\.)+[A-Z]{2,}$/i; - var _emojiRegex = `^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$`; - var emojiRegex; - var ipv4Regex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/; - var ipv4CidrRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/; - var ipv6Regex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/; - var ipv6CidrRegex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/; - var base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/; - var base64urlRegex = /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/; - var dateRegexSource = `((\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\\d|3[01])|(0[469]|11)-(0[1-9]|[12]\\d|30)|(02)-(0[1-9]|1\\d|2[0-8])))`; - var dateRegex = new RegExp(`^${dateRegexSource}$`); - function timeRegexSource(args) { - let secondsRegexSource = `[0-5]\\d`; - if (args.precision) { - secondsRegexSource = `${secondsRegexSource}\\.\\d{${args.precision}}`; - } else if (args.precision == null) { - secondsRegexSource = `${secondsRegexSource}(\\.\\d+)?`; - } - const secondsQuantifier = args.precision ? "+" : "?"; - return `([01]\\d|2[0-3]):[0-5]\\d(:${secondsRegexSource})${secondsQuantifier}`; - } - function timeRegex(args) { - return new RegExp(`^${timeRegexSource(args)}$`); - } - function datetimeRegex(args) { - let regex = `${dateRegexSource}T${timeRegexSource(args)}`; - const opts = []; - opts.push(args.local ? `Z?` : `Z`); - if (args.offset) - opts.push(`([+-]\\d{2}:?\\d{2})`); - regex = `${regex}(${opts.join("|")})`; - return new RegExp(`^${regex}$`); - } - function isValidIP(ip, version) { - if ((version === "v4" || !version) && ipv4Regex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6Regex.test(ip)) { - return true; - } - return false; - } - function isValidJWT(jwt, alg) { - if (!jwtRegex.test(jwt)) - return false; - try { - const [header] = jwt.split("."); - if (!header) - return false; - const base64 = header.replace(/-/g, "+").replace(/_/g, "/").padEnd(header.length + (4 - header.length % 4) % 4, "="); - const decoded = JSON.parse(atob(base64)); - if (typeof decoded !== "object" || decoded === null) - return false; - if ("typ" in decoded && decoded?.typ !== "JWT") - return false; - if (!decoded.alg) - return false; - if (alg && decoded.alg !== alg) - return false; - return true; - } catch { - return false; - } - } - function isValidCidr(ip, version) { - if ((version === "v4" || !version) && ipv4CidrRegex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6CidrRegex.test(ip)) { - return true; - } - return false; - } - var ZodString = class _ZodString extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = String(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.string) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.string, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.length < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.length > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "length") { - const tooBig = input.data.length > check.value; - const tooSmall = input.data.length < check.value; - if (tooBig || tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - if (tooBig) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } else if (tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } - status.dirty(); - } - } else if (check.kind === "email") { - if (!emailRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "email", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "emoji") { - if (!emojiRegex) { - emojiRegex = new RegExp(_emojiRegex, "u"); - } - if (!emojiRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "emoji", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "uuid") { - if (!uuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "uuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "nanoid") { - if (!nanoidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "nanoid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid") { - if (!cuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid2") { - if (!cuid2Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid2", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ulid") { - if (!ulidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ulid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "url") { - try { - new URL(input.data); - } catch { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "regex") { - check.regex.lastIndex = 0; - const testResult = check.regex.test(input.data); - if (!testResult) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "regex", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "trim") { - input.data = input.data.trim(); - } else if (check.kind === "includes") { - if (!input.data.includes(check.value, check.position)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { includes: check.value, position: check.position }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "toLowerCase") { - input.data = input.data.toLowerCase(); - } else if (check.kind === "toUpperCase") { - input.data = input.data.toUpperCase(); - } else if (check.kind === "startsWith") { - if (!input.data.startsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { startsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "endsWith") { - if (!input.data.endsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { endsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "datetime") { - const regex = datetimeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "datetime", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "date") { - const regex = dateRegex; - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "date", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "time") { - const regex = timeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "time", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "duration") { - if (!durationRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "duration", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ip") { - if (!isValidIP(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ip", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "jwt") { - if (!isValidJWT(input.data, check.alg)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "jwt", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cidr") { - if (!isValidCidr(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cidr", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64") { - if (!base64Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64url") { - if (!base64urlRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _regex(regex, validation, message) { - return this.refinement((data) => regex.test(data), { - validation, - code: ZodError_js_1.ZodIssueCode.invalid_string, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - _addCheck(check) { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - email(message) { - return this._addCheck({ kind: "email", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - url(message) { - return this._addCheck({ kind: "url", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - emoji(message) { - return this._addCheck({ kind: "emoji", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - uuid(message) { - return this._addCheck({ kind: "uuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - nanoid(message) { - return this._addCheck({ kind: "nanoid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid(message) { - return this._addCheck({ kind: "cuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid2(message) { - return this._addCheck({ kind: "cuid2", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - ulid(message) { - return this._addCheck({ kind: "ulid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64(message) { - return this._addCheck({ kind: "base64", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64url(message) { - return this._addCheck({ - kind: "base64url", - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - jwt(options) { - return this._addCheck({ kind: "jwt", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - ip(options) { - return this._addCheck({ kind: "ip", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - cidr(options) { - return this._addCheck({ kind: "cidr", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - datetime(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "datetime", - precision: null, - offset: false, - local: false, - message: options - }); - } - return this._addCheck({ - kind: "datetime", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - offset: options?.offset ?? false, - local: options?.local ?? false, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - date(message) { - return this._addCheck({ kind: "date", message }); - } - time(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "time", - precision: null, - message: options - }); - } - return this._addCheck({ - kind: "time", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - duration(message) { - return this._addCheck({ kind: "duration", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - regex(regex, message) { - return this._addCheck({ - kind: "regex", - regex, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - includes(value, options) { - return this._addCheck({ - kind: "includes", - value, - position: options?.position, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - startsWith(value, message) { - return this._addCheck({ - kind: "startsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - endsWith(value, message) { - return this._addCheck({ - kind: "endsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - min(minLength, message) { - return this._addCheck({ - kind: "min", - value: minLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - max(maxLength, message) { - return this._addCheck({ - kind: "max", - value: maxLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - length(len, message) { - return this._addCheck({ - kind: "length", - value: len, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - /** - * Equivalent to `.min(1)` - */ - nonempty(message) { - return this.min(1, errorUtil_js_1.errorUtil.errToObj(message)); - } - trim() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "trim" }] - }); - } - toLowerCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toLowerCase" }] - }); - } - toUpperCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toUpperCase" }] - }); - } - get isDatetime() { - return !!this._def.checks.find((ch) => ch.kind === "datetime"); - } - get isDate() { - return !!this._def.checks.find((ch) => ch.kind === "date"); - } - get isTime() { - return !!this._def.checks.find((ch) => ch.kind === "time"); - } - get isDuration() { - return !!this._def.checks.find((ch) => ch.kind === "duration"); - } - get isEmail() { - return !!this._def.checks.find((ch) => ch.kind === "email"); - } - get isURL() { - return !!this._def.checks.find((ch) => ch.kind === "url"); - } - get isEmoji() { - return !!this._def.checks.find((ch) => ch.kind === "emoji"); - } - get isUUID() { - return !!this._def.checks.find((ch) => ch.kind === "uuid"); - } - get isNANOID() { - return !!this._def.checks.find((ch) => ch.kind === "nanoid"); - } - get isCUID() { - return !!this._def.checks.find((ch) => ch.kind === "cuid"); - } - get isCUID2() { - return !!this._def.checks.find((ch) => ch.kind === "cuid2"); - } - get isULID() { - return !!this._def.checks.find((ch) => ch.kind === "ulid"); - } - get isIP() { - return !!this._def.checks.find((ch) => ch.kind === "ip"); - } - get isCIDR() { - return !!this._def.checks.find((ch) => ch.kind === "cidr"); - } - get isBase64() { - return !!this._def.checks.find((ch) => ch.kind === "base64"); - } - get isBase64url() { - return !!this._def.checks.find((ch) => ch.kind === "base64url"); - } - get minLength() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxLength() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodString = ZodString; - ZodString.create = (params) => { - return new ZodString({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodString, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - function floatSafeRemainder(val, step) { - const valDecCount = (val.toString().split(".")[1] || "").length; - const stepDecCount = (step.toString().split(".")[1] || "").length; - const decCount = valDecCount > stepDecCount ? valDecCount : stepDecCount; - const valInt = Number.parseInt(val.toFixed(decCount).replace(".", "")); - const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", "")); - return valInt % stepInt / 10 ** decCount; - } - var ZodNumber = class _ZodNumber extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - this.step = this.multipleOf; - } - _parse(input) { - if (this._def.coerce) { - input.data = Number(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.number) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.number, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "int") { - if (!util_js_1.util.isInteger(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: "integer", - received: "float", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (floatSafeRemainder(input.data, check.value) !== 0) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "finite") { - if (!Number.isFinite(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_finite, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodNumber({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodNumber({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - int(message) { - return this._addCheck({ - kind: "int", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - finite(message) { - return this._addCheck({ - kind: "finite", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - safe(message) { - return this._addCheck({ - kind: "min", - inclusive: true, - value: Number.MIN_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - })._addCheck({ - kind: "max", - inclusive: true, - value: Number.MAX_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - get isInt() { - return !!this._def.checks.find((ch) => ch.kind === "int" || ch.kind === "multipleOf" && util_js_1.util.isInteger(ch.value)); - } - get isFinite() { - let max = null; - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "finite" || ch.kind === "int" || ch.kind === "multipleOf") { - return true; - } else if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } else if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return Number.isFinite(min) && Number.isFinite(max); - } - }; - exports.ZodNumber = ZodNumber; - ZodNumber.create = (params) => { - return new ZodNumber({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodNumber, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodBigInt = class _ZodBigInt extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - } - _parse(input) { - if (this._def.coerce) { - try { - input.data = BigInt(input.data); - } catch { - return this._getInvalidInput(input); - } - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.bigint) { - return this._getInvalidInput(input); - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - type: "bigint", - minimum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - type: "bigint", - maximum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (input.data % check.value !== BigInt(0)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _getInvalidInput(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.bigint, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodBigInt({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodBigInt({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodBigInt = ZodBigInt; - ZodBigInt.create = (params) => { - return new ZodBigInt({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodBigInt, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - var ZodBoolean = class extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = Boolean(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.boolean) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.boolean, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodBoolean = ZodBoolean; - ZodBoolean.create = (params) => { - return new ZodBoolean({ - typeName: ZodFirstPartyTypeKind.ZodBoolean, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodDate = class _ZodDate extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = new Date(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.date) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.date, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (Number.isNaN(input.data.getTime())) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_date - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.getTime() < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - message: check.message, - inclusive: true, - exact: false, - minimum: check.value, - type: "date" - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.getTime() > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - message: check.message, - inclusive: true, - exact: false, - maximum: check.value, - type: "date" - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { - status: status.value, - value: new Date(input.data.getTime()) - }; - } - _addCheck(check) { - return new _ZodDate({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - min(minDate, message) { - return this._addCheck({ - kind: "min", - value: minDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - max(maxDate, message) { - return this._addCheck({ - kind: "max", - value: maxDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minDate() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min != null ? new Date(min) : null; - } - get maxDate() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max != null ? new Date(max) : null; - } - }; - exports.ZodDate = ZodDate; - ZodDate.create = (params) => { - return new ZodDate({ - checks: [], - coerce: params?.coerce || false, - typeName: ZodFirstPartyTypeKind.ZodDate, - ...processCreateParams(params) - }); - }; - var ZodSymbol = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.symbol) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.symbol, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodSymbol = ZodSymbol; - ZodSymbol.create = (params) => { - return new ZodSymbol({ - typeName: ZodFirstPartyTypeKind.ZodSymbol, - ...processCreateParams(params) - }); - }; - var ZodUndefined = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.undefined, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUndefined = ZodUndefined; - ZodUndefined.create = (params) => { - return new ZodUndefined({ - typeName: ZodFirstPartyTypeKind.ZodUndefined, - ...processCreateParams(params) - }); - }; - var ZodNull = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.null) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.null, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodNull = ZodNull; - ZodNull.create = (params) => { - return new ZodNull({ - typeName: ZodFirstPartyTypeKind.ZodNull, - ...processCreateParams(params) - }); - }; - var ZodAny = class extends ZodType { - constructor() { - super(...arguments); - this._any = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodAny = ZodAny; - ZodAny.create = (params) => { - return new ZodAny({ - typeName: ZodFirstPartyTypeKind.ZodAny, - ...processCreateParams(params) - }); - }; - var ZodUnknown = class extends ZodType { - constructor() { - super(...arguments); - this._unknown = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUnknown = ZodUnknown; - ZodUnknown.create = (params) => { - return new ZodUnknown({ - typeName: ZodFirstPartyTypeKind.ZodUnknown, - ...processCreateParams(params) - }); - }; - var ZodNever = class extends ZodType { - _parse(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.never, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - }; - exports.ZodNever = ZodNever; - ZodNever.create = (params) => { - return new ZodNever({ - typeName: ZodFirstPartyTypeKind.ZodNever, - ...processCreateParams(params) - }); - }; - var ZodVoid = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.void, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodVoid = ZodVoid; - ZodVoid.create = (params) => { - return new ZodVoid({ - typeName: ZodFirstPartyTypeKind.ZodVoid, - ...processCreateParams(params) - }); - }; - var ZodArray = class _ZodArray extends ZodType { - _parse(input) { - const { ctx, status } = this._processInputParams(input); - const def = this._def; - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (def.exactLength !== null) { - const tooBig = ctx.data.length > def.exactLength.value; - const tooSmall = ctx.data.length < def.exactLength.value; - if (tooBig || tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: tooBig ? ZodError_js_1.ZodIssueCode.too_big : ZodError_js_1.ZodIssueCode.too_small, - minimum: tooSmall ? def.exactLength.value : void 0, - maximum: tooBig ? def.exactLength.value : void 0, - type: "array", - inclusive: true, - exact: true, - message: def.exactLength.message - }); - status.dirty(); - } - } - if (def.minLength !== null) { - if (ctx.data.length < def.minLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.minLength.message - }); - status.dirty(); - } - } - if (def.maxLength !== null) { - if (ctx.data.length > def.maxLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.maxLength.message - }); - status.dirty(); - } - } - if (ctx.common.async) { - return Promise.all([...ctx.data].map((item, i) => { - return def.type._parseAsync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - })).then((result2) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, result2); - }); - } - const result = [...ctx.data].map((item, i) => { - return def.type._parseSync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - }); - return parseUtil_js_1.ParseStatus.mergeArray(status, result); - } - get element() { - return this._def.type; - } - min(minLength, message) { - return new _ZodArray({ - ...this._def, - minLength: { value: minLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxLength, message) { - return new _ZodArray({ - ...this._def, - maxLength: { value: maxLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - length(len, message) { - return new _ZodArray({ - ...this._def, - exactLength: { value: len, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodArray = ZodArray; - ZodArray.create = (schema, params) => { - return new ZodArray({ - type: schema, - minLength: null, - maxLength: null, - exactLength: null, - typeName: ZodFirstPartyTypeKind.ZodArray, - ...processCreateParams(params) - }); - }; - function deepPartialify(schema) { - if (schema instanceof ZodObject) { - const newShape = {}; - for (const key in schema.shape) { - const fieldSchema = schema.shape[key]; - newShape[key] = ZodOptional.create(deepPartialify(fieldSchema)); - } - return new ZodObject({ - ...schema._def, - shape: () => newShape - }); - } else if (schema instanceof ZodArray) { - return new ZodArray({ - ...schema._def, - type: deepPartialify(schema.element) - }); - } else if (schema instanceof ZodOptional) { - return ZodOptional.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodNullable) { - return ZodNullable.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodTuple) { - return ZodTuple.create(schema.items.map((item) => deepPartialify(item))); - } else { - return schema; - } - } - var ZodObject = class _ZodObject extends ZodType { - constructor() { - super(...arguments); - this._cached = null; - this.nonstrict = this.passthrough; - this.augment = this.extend; - } - _getCached() { - if (this._cached !== null) - return this._cached; - const shape = this._def.shape(); - const keys = util_js_1.util.objectKeys(shape); - this._cached = { shape, keys }; - return this._cached; - } - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.object) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const { status, ctx } = this._processInputParams(input); - const { shape, keys: shapeKeys } = this._getCached(); - const extraKeys = []; - if (!(this._def.catchall instanceof ZodNever && this._def.unknownKeys === "strip")) { - for (const key in ctx.data) { - if (!shapeKeys.includes(key)) { - extraKeys.push(key); - } - } - } - const pairs = []; - for (const key of shapeKeys) { - const keyValidator = shape[key]; - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: keyValidator._parse(new ParseInputLazyPath(ctx, value, ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (this._def.catchall instanceof ZodNever) { - const unknownKeys = this._def.unknownKeys; - if (unknownKeys === "passthrough") { - for (const key of extraKeys) { - pairs.push({ - key: { status: "valid", value: key }, - value: { status: "valid", value: ctx.data[key] } - }); - } - } else if (unknownKeys === "strict") { - if (extraKeys.length > 0) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.unrecognized_keys, - keys: extraKeys - }); - status.dirty(); - } - } else if (unknownKeys === "strip") { - } else { - throw new Error(`Internal ZodObject error: invalid unknownKeys value.`); - } - } else { - const catchall = this._def.catchall; - for (const key of extraKeys) { - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: catchall._parse( - new ParseInputLazyPath(ctx, value, ctx.path, key) - //, ctx.child(key), value, getParsedType(value) - ), - alwaysSet: key in ctx.data - }); - } - } - if (ctx.common.async) { - return Promise.resolve().then(async () => { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value, - alwaysSet: pair.alwaysSet - }); - } - return syncPairs; - }).then((syncPairs) => { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, syncPairs); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get shape() { - return this._def.shape(); - } - strict(message) { - errorUtil_js_1.errorUtil.errToObj; - return new _ZodObject({ - ...this._def, - unknownKeys: "strict", - ...message !== void 0 ? { - errorMap: (issue, ctx) => { - const defaultError = this._def.errorMap?.(issue, ctx).message ?? ctx.defaultError; - if (issue.code === "unrecognized_keys") - return { - message: errorUtil_js_1.errorUtil.errToObj(message).message ?? defaultError - }; - return { - message: defaultError - }; - } - } : {} - }); - } - strip() { - return new _ZodObject({ - ...this._def, - unknownKeys: "strip" - }); - } - passthrough() { - return new _ZodObject({ - ...this._def, - unknownKeys: "passthrough" - }); - } - // const AugmentFactory = - // (def: Def) => - // ( - // augmentation: Augmentation - // ): ZodObject< - // extendShape, Augmentation>, - // Def["unknownKeys"], - // Def["catchall"] - // > => { - // return new ZodObject({ - // ...def, - // shape: () => ({ - // ...def.shape(), - // ...augmentation, - // }), - // }) as any; - // }; - extend(augmentation) { - return new _ZodObject({ - ...this._def, - shape: () => ({ - ...this._def.shape(), - ...augmentation - }) - }); - } - /** - * Prior to zod@1.0.12 there was a bug in the - * inferred type of merged objects. Please - * upgrade if you are experiencing issues. - */ - merge(merging) { - const merged = new _ZodObject({ - unknownKeys: merging._def.unknownKeys, - catchall: merging._def.catchall, - shape: () => ({ - ...this._def.shape(), - ...merging._def.shape() - }), - typeName: ZodFirstPartyTypeKind.ZodObject - }); - return merged; - } - // merge< - // Incoming extends AnyZodObject, - // Augmentation extends Incoming["shape"], - // NewOutput extends { - // [k in keyof Augmentation | keyof Output]: k extends keyof Augmentation - // ? Augmentation[k]["_output"] - // : k extends keyof Output - // ? Output[k] - // : never; - // }, - // NewInput extends { - // [k in keyof Augmentation | keyof Input]: k extends keyof Augmentation - // ? Augmentation[k]["_input"] - // : k extends keyof Input - // ? Input[k] - // : never; - // } - // >( - // merging: Incoming - // ): ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"], - // NewOutput, - // NewInput - // > { - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - setKey(key, schema) { - return this.augment({ [key]: schema }); - } - // merge( - // merging: Incoming - // ): //ZodObject = (merging) => { - // ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"] - // > { - // // const mergedShape = objectUtil.mergeShapes( - // // this._def.shape(), - // // merging._def.shape() - // // ); - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - catchall(index) { - return new _ZodObject({ - ...this._def, - catchall: index - }); - } - pick(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(mask)) { - if (mask[key] && this.shape[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - omit(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (!mask[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - /** - * @deprecated - */ - deepPartial() { - return deepPartialify(this); - } - partial(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - const fieldSchema = this.shape[key]; - if (mask && !mask[key]) { - newShape[key] = fieldSchema; - } else { - newShape[key] = fieldSchema.optional(); - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - required(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (mask && !mask[key]) { - newShape[key] = this.shape[key]; - } else { - const fieldSchema = this.shape[key]; - let newField = fieldSchema; - while (newField instanceof ZodOptional) { - newField = newField._def.innerType; - } - newShape[key] = newField; - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - keyof() { - return createZodEnum(util_js_1.util.objectKeys(this.shape)); - } - }; - exports.ZodObject = ZodObject; - ZodObject.create = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.strictCreate = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strict", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.lazycreate = (shape, params) => { - return new ZodObject({ - shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - var ZodUnion = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const options = this._def.options; - function handleResults(results) { - for (const result of results) { - if (result.result.status === "valid") { - return result.result; - } - } - for (const result of results) { - if (result.result.status === "dirty") { - ctx.common.issues.push(...result.ctx.common.issues); - return result.result; - } - } - const unionErrors = results.map((result) => new ZodError_js_1.ZodError(result.ctx.common.issues)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return Promise.all(options.map(async (option) => { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - return { - result: await option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }), - ctx: childCtx - }; - })).then(handleResults); - } else { - let dirty = void 0; - const issues = []; - for (const option of options) { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - const result = option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }); - if (result.status === "valid") { - return result; - } else if (result.status === "dirty" && !dirty) { - dirty = { result, ctx: childCtx }; - } - if (childCtx.common.issues.length) { - issues.push(childCtx.common.issues); - } - } - if (dirty) { - ctx.common.issues.push(...dirty.ctx.common.issues); - return dirty.result; - } - const unionErrors = issues.map((issues2) => new ZodError_js_1.ZodError(issues2)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - } - get options() { - return this._def.options; - } - }; - exports.ZodUnion = ZodUnion; - ZodUnion.create = (types, params) => { - return new ZodUnion({ - options: types, - typeName: ZodFirstPartyTypeKind.ZodUnion, - ...processCreateParams(params) - }); - }; - var getDiscriminator = (type) => { - if (type instanceof ZodLazy) { - return getDiscriminator(type.schema); - } else if (type instanceof ZodEffects) { - return getDiscriminator(type.innerType()); - } else if (type instanceof ZodLiteral) { - return [type.value]; - } else if (type instanceof ZodEnum) { - return type.options; - } else if (type instanceof ZodNativeEnum) { - return util_js_1.util.objectValues(type.enum); - } else if (type instanceof ZodDefault) { - return getDiscriminator(type._def.innerType); - } else if (type instanceof ZodUndefined) { - return [void 0]; - } else if (type instanceof ZodNull) { - return [null]; - } else if (type instanceof ZodOptional) { - return [void 0, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodNullable) { - return [null, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodBranded) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodReadonly) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodCatch) { - return getDiscriminator(type._def.innerType); - } else { - return []; - } - }; - var ZodDiscriminatedUnion = class _ZodDiscriminatedUnion extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const discriminator = this.discriminator; - const discriminatorValue = ctx.data[discriminator]; - const option = this.optionsMap.get(discriminatorValue); - if (!option) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union_discriminator, - options: Array.from(this.optionsMap.keys()), - path: [discriminator] - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } else { - return option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } - } - get discriminator() { - return this._def.discriminator; - } - get options() { - return this._def.options; - } - get optionsMap() { - return this._def.optionsMap; - } - /** - * The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. - * However, it only allows a union of objects, all of which need to share a discriminator property. This property must - * have a different value for each object in the union. - * @param discriminator the name of the discriminator property - * @param types an array of object schemas - * @param params - */ - static create(discriminator, options, params) { - const optionsMap = /* @__PURE__ */ new Map(); - for (const type of options) { - const discriminatorValues = getDiscriminator(type.shape[discriminator]); - if (!discriminatorValues.length) { - throw new Error(`A discriminator value for key \`${discriminator}\` could not be extracted from all schema options`); - } - for (const value of discriminatorValues) { - if (optionsMap.has(value)) { - throw new Error(`Discriminator property ${String(discriminator)} has duplicate value ${String(value)}`); - } - optionsMap.set(value, type); - } - } - return new _ZodDiscriminatedUnion({ - typeName: ZodFirstPartyTypeKind.ZodDiscriminatedUnion, - discriminator, - options, - optionsMap, - ...processCreateParams(params) - }); - } - }; - exports.ZodDiscriminatedUnion = ZodDiscriminatedUnion; - function mergeValues(a, b) { - const aType = (0, util_js_1.getParsedType)(a); - const bType = (0, util_js_1.getParsedType)(b); - if (a === b) { - return { valid: true, data: a }; - } else if (aType === util_js_1.ZodParsedType.object && bType === util_js_1.ZodParsedType.object) { - const bKeys = util_js_1.util.objectKeys(b); - const sharedKeys = util_js_1.util.objectKeys(a).filter((key) => bKeys.indexOf(key) !== -1); - const newObj = { ...a, ...b }; - for (const key of sharedKeys) { - const sharedValue = mergeValues(a[key], b[key]); - if (!sharedValue.valid) { - return { valid: false }; - } - newObj[key] = sharedValue.data; - } - return { valid: true, data: newObj }; - } else if (aType === util_js_1.ZodParsedType.array && bType === util_js_1.ZodParsedType.array) { - if (a.length !== b.length) { - return { valid: false }; - } - const newArray = []; - for (let index = 0; index < a.length; index++) { - const itemA = a[index]; - const itemB = b[index]; - const sharedValue = mergeValues(itemA, itemB); - if (!sharedValue.valid) { - return { valid: false }; - } - newArray.push(sharedValue.data); - } - return { valid: true, data: newArray }; - } else if (aType === util_js_1.ZodParsedType.date && bType === util_js_1.ZodParsedType.date && +a === +b) { - return { valid: true, data: a }; - } else { - return { valid: false }; - } - } - var ZodIntersection = class extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const handleParsed = (parsedLeft, parsedRight) => { - if ((0, parseUtil_js_1.isAborted)(parsedLeft) || (0, parseUtil_js_1.isAborted)(parsedRight)) { - return parseUtil_js_1.INVALID; - } - const merged = mergeValues(parsedLeft.value, parsedRight.value); - if (!merged.valid) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_intersection_types - }); - return parseUtil_js_1.INVALID; - } - if ((0, parseUtil_js_1.isDirty)(parsedLeft) || (0, parseUtil_js_1.isDirty)(parsedRight)) { - status.dirty(); - } - return { status: status.value, value: merged.data }; - }; - if (ctx.common.async) { - return Promise.all([ - this._def.left._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), - this._def.right._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }) - ]).then(([left, right]) => handleParsed(left, right)); - } else { - return handleParsed(this._def.left._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), this._def.right._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - })); - } - } - }; - exports.ZodIntersection = ZodIntersection; - ZodIntersection.create = (left, right, params) => { - return new ZodIntersection({ - left, - right, - typeName: ZodFirstPartyTypeKind.ZodIntersection, - ...processCreateParams(params) - }); - }; - var ZodTuple = class _ZodTuple extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (ctx.data.length < this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - return parseUtil_js_1.INVALID; - } - const rest = this._def.rest; - if (!rest && ctx.data.length > this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - status.dirty(); - } - const items = [...ctx.data].map((item, itemIndex) => { - const schema = this._def.items[itemIndex] || this._def.rest; - if (!schema) - return null; - return schema._parse(new ParseInputLazyPath(ctx, item, ctx.path, itemIndex)); - }).filter((x) => !!x); - if (ctx.common.async) { - return Promise.all(items).then((results) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, results); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeArray(status, items); - } - } - get items() { - return this._def.items; - } - rest(rest) { - return new _ZodTuple({ - ...this._def, - rest - }); - } - }; - exports.ZodTuple = ZodTuple; - ZodTuple.create = (schemas, params) => { - if (!Array.isArray(schemas)) { - throw new Error("You must pass an array of schemas to z.tuple([ ... ])"); - } - return new ZodTuple({ - items: schemas, - typeName: ZodFirstPartyTypeKind.ZodTuple, - rest: null, - ...processCreateParams(params) - }); - }; - var ZodRecord = class _ZodRecord extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const pairs = []; - const keyType = this._def.keyType; - const valueType = this._def.valueType; - for (const key in ctx.data) { - pairs.push({ - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, key)), - value: valueType._parse(new ParseInputLazyPath(ctx, ctx.data[key], ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (ctx.common.async) { - return parseUtil_js_1.ParseStatus.mergeObjectAsync(status, pairs); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get element() { - return this._def.valueType; - } - static create(first, second, third) { - if (second instanceof ZodType) { - return new _ZodRecord({ - keyType: first, - valueType: second, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(third) - }); - } - return new _ZodRecord({ - keyType: ZodString.create(), - valueType: first, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(second) - }); - } - }; - exports.ZodRecord = ZodRecord; - var ZodMap = class extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.map) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.map, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const keyType = this._def.keyType; - const valueType = this._def.valueType; - const pairs = [...ctx.data.entries()].map(([key, value], index) => { - return { - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, [index, "key"])), - value: valueType._parse(new ParseInputLazyPath(ctx, value, ctx.path, [index, "value"])) - }; - }); - if (ctx.common.async) { - const finalMap = /* @__PURE__ */ new Map(); - return Promise.resolve().then(async () => { - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - }); - } else { - const finalMap = /* @__PURE__ */ new Map(); - for (const pair of pairs) { - const key = pair.key; - const value = pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - } - } - }; - exports.ZodMap = ZodMap; - ZodMap.create = (keyType, valueType, params) => { - return new ZodMap({ - valueType, - keyType, - typeName: ZodFirstPartyTypeKind.ZodMap, - ...processCreateParams(params) - }); - }; - var ZodSet = class _ZodSet extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.set) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.set, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const def = this._def; - if (def.minSize !== null) { - if (ctx.data.size < def.minSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.minSize.message - }); - status.dirty(); - } - } - if (def.maxSize !== null) { - if (ctx.data.size > def.maxSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.maxSize.message - }); - status.dirty(); - } - } - const valueType = this._def.valueType; - function finalizeSet(elements2) { - const parsedSet = /* @__PURE__ */ new Set(); - for (const element of elements2) { - if (element.status === "aborted") - return parseUtil_js_1.INVALID; - if (element.status === "dirty") - status.dirty(); - parsedSet.add(element.value); - } - return { status: status.value, value: parsedSet }; - } - const elements = [...ctx.data.values()].map((item, i) => valueType._parse(new ParseInputLazyPath(ctx, item, ctx.path, i))); - if (ctx.common.async) { - return Promise.all(elements).then((elements2) => finalizeSet(elements2)); - } else { - return finalizeSet(elements); - } - } - min(minSize, message) { - return new _ZodSet({ - ...this._def, - minSize: { value: minSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxSize, message) { - return new _ZodSet({ - ...this._def, - maxSize: { value: maxSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - size(size, message) { - return this.min(size, message).max(size, message); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodSet = ZodSet; - ZodSet.create = (valueType, params) => { - return new ZodSet({ - valueType, - minSize: null, - maxSize: null, - typeName: ZodFirstPartyTypeKind.ZodSet, - ...processCreateParams(params) - }); - }; - var ZodFunction = class _ZodFunction extends ZodType { - constructor() { - super(...arguments); - this.validate = this.implement; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.function) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.function, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - function makeArgsIssue(args, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: args, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_arguments, - argumentsError: error - } - }); - } - function makeReturnsIssue(returns, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: returns, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_return_type, - returnTypeError: error - } - }); - } - const params = { errorMap: ctx.common.contextualErrorMap }; - const fn = ctx.data; - if (this._def.returns instanceof ZodPromise) { - const me = this; - return (0, parseUtil_js_1.OK)(async function(...args) { - const error = new ZodError_js_1.ZodError([]); - const parsedArgs = await me._def.args.parseAsync(args, params).catch((e) => { - error.addIssue(makeArgsIssue(args, e)); - throw error; - }); - const result = await Reflect.apply(fn, this, parsedArgs); - const parsedReturns = await me._def.returns._def.type.parseAsync(result, params).catch((e) => { - error.addIssue(makeReturnsIssue(result, e)); - throw error; - }); - return parsedReturns; - }); - } else { - const me = this; - return (0, parseUtil_js_1.OK)(function(...args) { - const parsedArgs = me._def.args.safeParse(args, params); - if (!parsedArgs.success) { - throw new ZodError_js_1.ZodError([makeArgsIssue(args, parsedArgs.error)]); - } - const result = Reflect.apply(fn, this, parsedArgs.data); - const parsedReturns = me._def.returns.safeParse(result, params); - if (!parsedReturns.success) { - throw new ZodError_js_1.ZodError([makeReturnsIssue(result, parsedReturns.error)]); - } - return parsedReturns.data; - }); - } - } - parameters() { - return this._def.args; - } - returnType() { - return this._def.returns; - } - args(...items) { - return new _ZodFunction({ - ...this._def, - args: ZodTuple.create(items).rest(ZodUnknown.create()) - }); - } - returns(returnType) { - return new _ZodFunction({ - ...this._def, - returns: returnType - }); - } - implement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - strictImplement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - static create(args, returns, params) { - return new _ZodFunction({ - args: args ? args : ZodTuple.create([]).rest(ZodUnknown.create()), - returns: returns || ZodUnknown.create(), - typeName: ZodFirstPartyTypeKind.ZodFunction, - ...processCreateParams(params) - }); - } - }; - exports.ZodFunction = ZodFunction; - var ZodLazy = class extends ZodType { - get schema() { - return this._def.getter(); - } - _parse(input) { - const { ctx } = this._processInputParams(input); - const lazySchema = this._def.getter(); - return lazySchema._parse({ data: ctx.data, path: ctx.path, parent: ctx }); - } - }; - exports.ZodLazy = ZodLazy; - ZodLazy.create = (getter, params) => { - return new ZodLazy({ - getter, - typeName: ZodFirstPartyTypeKind.ZodLazy, - ...processCreateParams(params) - }); - }; - var ZodLiteral = class extends ZodType { - _parse(input) { - if (input.data !== this._def.value) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_literal, - expected: this._def.value - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - get value() { - return this._def.value; - } - }; - exports.ZodLiteral = ZodLiteral; - ZodLiteral.create = (value, params) => { - return new ZodLiteral({ - value, - typeName: ZodFirstPartyTypeKind.ZodLiteral, - ...processCreateParams(params) - }); - }; - function createZodEnum(values, params) { - return new ZodEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodEnum, - ...processCreateParams(params) - }); - } - var ZodEnum = class _ZodEnum extends ZodType { - _parse(input) { - if (typeof input.data !== "string") { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(this._def.values); - } - if (!this._cache.has(input.data)) { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get options() { - return this._def.values; - } - get enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Values() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - extract(values, newDef = this._def) { - return _ZodEnum.create(values, { - ...this._def, - ...newDef - }); - } - exclude(values, newDef = this._def) { - return _ZodEnum.create(this.options.filter((opt) => !values.includes(opt)), { - ...this._def, - ...newDef - }); - } - }; - exports.ZodEnum = ZodEnum; - ZodEnum.create = createZodEnum; - var ZodNativeEnum = class extends ZodType { - _parse(input) { - const nativeEnumValues = util_js_1.util.getValidEnumValues(this._def.values); - const ctx = this._getOrReturnCtx(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.string && ctx.parsedType !== util_js_1.ZodParsedType.number) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(util_js_1.util.getValidEnumValues(this._def.values)); - } - if (!this._cache.has(input.data)) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get enum() { - return this._def.values; - } - }; - exports.ZodNativeEnum = ZodNativeEnum; - ZodNativeEnum.create = (values, params) => { - return new ZodNativeEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodNativeEnum, - ...processCreateParams(params) - }); - }; - var ZodPromise = class extends ZodType { - unwrap() { - return this._def.type; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.promise && ctx.common.async === false) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.promise, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const promisified = ctx.parsedType === util_js_1.ZodParsedType.promise ? ctx.data : Promise.resolve(ctx.data); - return (0, parseUtil_js_1.OK)(promisified.then((data) => { - return this._def.type.parseAsync(data, { - path: ctx.path, - errorMap: ctx.common.contextualErrorMap - }); - })); - } - }; - exports.ZodPromise = ZodPromise; - ZodPromise.create = (schema, params) => { - return new ZodPromise({ - type: schema, - typeName: ZodFirstPartyTypeKind.ZodPromise, - ...processCreateParams(params) - }); - }; - var ZodEffects = class extends ZodType { - innerType() { - return this._def.schema; - } - sourceType() { - return this._def.schema._def.typeName === ZodFirstPartyTypeKind.ZodEffects ? this._def.schema.sourceType() : this._def.schema; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const effect = this._def.effect || null; - const checkCtx = { - addIssue: (arg) => { - (0, parseUtil_js_1.addIssueToContext)(ctx, arg); - if (arg.fatal) { - status.abort(); - } else { - status.dirty(); - } - }, - get path() { - return ctx.path; - } - }; - checkCtx.addIssue = checkCtx.addIssue.bind(checkCtx); - if (effect.type === "preprocess") { - const processed = effect.transform(ctx.data, checkCtx); - if (ctx.common.async) { - return Promise.resolve(processed).then(async (processed2) => { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = await this._def.schema._parseAsync({ - data: processed2, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - }); - } else { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = this._def.schema._parseSync({ - data: processed, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - } - } - if (effect.type === "refinement") { - const executeRefinement = (acc) => { - const result = effect.refinement(acc, checkCtx); - if (ctx.common.async) { - return Promise.resolve(result); - } - if (result instanceof Promise) { - throw new Error("Async refinement encountered during synchronous parse operation. Use .parseAsync instead."); - } - return acc; - }; - if (ctx.common.async === false) { - const inner = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - executeRefinement(inner.value); - return { status: status.value, value: inner.value }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((inner) => { - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - return executeRefinement(inner.value).then(() => { - return { status: status.value, value: inner.value }; - }); - }); - } - } - if (effect.type === "transform") { - if (ctx.common.async === false) { - const base = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - const result = effect.transform(base.value, checkCtx); - if (result instanceof Promise) { - throw new Error(`Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead.`); - } - return { status: status.value, value: result }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((base) => { - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - return Promise.resolve(effect.transform(base.value, checkCtx)).then((result) => ({ - status: status.value, - value: result - })); - }); - } - } - util_js_1.util.assertNever(effect); - } - }; - exports.ZodEffects = ZodEffects; - exports.ZodTransformer = ZodEffects; - ZodEffects.create = (schema, effect, params) => { - return new ZodEffects({ - schema, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect, - ...processCreateParams(params) - }); - }; - ZodEffects.createWithPreprocess = (preprocess, schema, params) => { - return new ZodEffects({ - schema, - effect: { type: "preprocess", transform: preprocess }, - typeName: ZodFirstPartyTypeKind.ZodEffects, - ...processCreateParams(params) - }); - }; - var ZodOptional = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.undefined) { - return (0, parseUtil_js_1.OK)(void 0); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodOptional = ZodOptional; - ZodOptional.create = (type, params) => { - return new ZodOptional({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodOptional, - ...processCreateParams(params) - }); - }; - var ZodNullable = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.null) { - return (0, parseUtil_js_1.OK)(null); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodNullable = ZodNullable; - ZodNullable.create = (type, params) => { - return new ZodNullable({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodNullable, - ...processCreateParams(params) - }); - }; - var ZodDefault = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - let data = ctx.data; - if (ctx.parsedType === util_js_1.ZodParsedType.undefined) { - data = this._def.defaultValue(); - } - return this._def.innerType._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - removeDefault() { - return this._def.innerType; - } - }; - exports.ZodDefault = ZodDefault; - ZodDefault.create = (type, params) => { - return new ZodDefault({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodDefault, - defaultValue: typeof params.default === "function" ? params.default : () => params.default, - ...processCreateParams(params) - }); - }; - var ZodCatch = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const newCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - } - }; - const result = this._def.innerType._parse({ - data: newCtx.data, - path: newCtx.path, - parent: { - ...newCtx - } - }); - if ((0, parseUtil_js_1.isAsync)(result)) { - return result.then((result2) => { - return { - status: "valid", - value: result2.status === "valid" ? result2.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - }); - } else { - return { - status: "valid", - value: result.status === "valid" ? result.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - } - } - removeCatch() { - return this._def.innerType; - } - }; - exports.ZodCatch = ZodCatch; - ZodCatch.create = (type, params) => { - return new ZodCatch({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodCatch, - catchValue: typeof params.catch === "function" ? params.catch : () => params.catch, - ...processCreateParams(params) - }); - }; - var ZodNaN = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.nan) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.nan, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - }; - exports.ZodNaN = ZodNaN; - ZodNaN.create = (params) => { - return new ZodNaN({ - typeName: ZodFirstPartyTypeKind.ZodNaN, - ...processCreateParams(params) - }); - }; - exports.BRAND = Symbol("zod_brand"); - var ZodBranded = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const data = ctx.data; - return this._def.type._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - unwrap() { - return this._def.type; - } - }; - exports.ZodBranded = ZodBranded; - var ZodPipeline = class _ZodPipeline extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.common.async) { - const handleAsync = async () => { - const inResult = await this._def.in._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return (0, parseUtil_js_1.DIRTY)(inResult.value); - } else { - return this._def.out._parseAsync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - }; - return handleAsync(); - } else { - const inResult = this._def.in._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return { - status: "dirty", - value: inResult.value - }; - } else { - return this._def.out._parseSync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - } - } - static create(a, b) { - return new _ZodPipeline({ - in: a, - out: b, - typeName: ZodFirstPartyTypeKind.ZodPipeline - }); - } - }; - exports.ZodPipeline = ZodPipeline; - var ZodReadonly = class extends ZodType { - _parse(input) { - const result = this._def.innerType._parse(input); - const freeze = (data) => { - if ((0, parseUtil_js_1.isValid)(data)) { - data.value = Object.freeze(data.value); - } - return data; - }; - return (0, parseUtil_js_1.isAsync)(result) ? result.then((data) => freeze(data)) : freeze(result); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodReadonly = ZodReadonly; - ZodReadonly.create = (type, params) => { - return new ZodReadonly({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodReadonly, - ...processCreateParams(params) - }); - }; - function cleanParams(params, data) { - const p = typeof params === "function" ? params(data) : typeof params === "string" ? { message: params } : params; - const p2 = typeof p === "string" ? { message: p } : p; - return p2; - } - function custom(check, _params = {}, fatal) { - if (check) - return ZodAny.create().superRefine((data, ctx) => { - const r = check(data); - if (r instanceof Promise) { - return r.then((r2) => { - if (!r2) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - }); - } - if (!r) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - return; - }); - return ZodAny.create(); - } - exports.late = { - object: ZodObject.lazycreate - }; - var ZodFirstPartyTypeKind; - (function(ZodFirstPartyTypeKind2) { - ZodFirstPartyTypeKind2["ZodString"] = "ZodString"; - ZodFirstPartyTypeKind2["ZodNumber"] = "ZodNumber"; - ZodFirstPartyTypeKind2["ZodNaN"] = "ZodNaN"; - ZodFirstPartyTypeKind2["ZodBigInt"] = "ZodBigInt"; - ZodFirstPartyTypeKind2["ZodBoolean"] = "ZodBoolean"; - ZodFirstPartyTypeKind2["ZodDate"] = "ZodDate"; - ZodFirstPartyTypeKind2["ZodSymbol"] = "ZodSymbol"; - ZodFirstPartyTypeKind2["ZodUndefined"] = "ZodUndefined"; - ZodFirstPartyTypeKind2["ZodNull"] = "ZodNull"; - ZodFirstPartyTypeKind2["ZodAny"] = "ZodAny"; - ZodFirstPartyTypeKind2["ZodUnknown"] = "ZodUnknown"; - ZodFirstPartyTypeKind2["ZodNever"] = "ZodNever"; - ZodFirstPartyTypeKind2["ZodVoid"] = "ZodVoid"; - ZodFirstPartyTypeKind2["ZodArray"] = "ZodArray"; - ZodFirstPartyTypeKind2["ZodObject"] = "ZodObject"; - ZodFirstPartyTypeKind2["ZodUnion"] = "ZodUnion"; - ZodFirstPartyTypeKind2["ZodDiscriminatedUnion"] = "ZodDiscriminatedUnion"; - ZodFirstPartyTypeKind2["ZodIntersection"] = "ZodIntersection"; - ZodFirstPartyTypeKind2["ZodTuple"] = "ZodTuple"; - ZodFirstPartyTypeKind2["ZodRecord"] = "ZodRecord"; - ZodFirstPartyTypeKind2["ZodMap"] = "ZodMap"; - ZodFirstPartyTypeKind2["ZodSet"] = "ZodSet"; - ZodFirstPartyTypeKind2["ZodFunction"] = "ZodFunction"; - ZodFirstPartyTypeKind2["ZodLazy"] = "ZodLazy"; - ZodFirstPartyTypeKind2["ZodLiteral"] = "ZodLiteral"; - ZodFirstPartyTypeKind2["ZodEnum"] = "ZodEnum"; - ZodFirstPartyTypeKind2["ZodEffects"] = "ZodEffects"; - ZodFirstPartyTypeKind2["ZodNativeEnum"] = "ZodNativeEnum"; - ZodFirstPartyTypeKind2["ZodOptional"] = "ZodOptional"; - ZodFirstPartyTypeKind2["ZodNullable"] = "ZodNullable"; - ZodFirstPartyTypeKind2["ZodDefault"] = "ZodDefault"; - ZodFirstPartyTypeKind2["ZodCatch"] = "ZodCatch"; - ZodFirstPartyTypeKind2["ZodPromise"] = "ZodPromise"; - ZodFirstPartyTypeKind2["ZodBranded"] = "ZodBranded"; - ZodFirstPartyTypeKind2["ZodPipeline"] = "ZodPipeline"; - ZodFirstPartyTypeKind2["ZodReadonly"] = "ZodReadonly"; - })(ZodFirstPartyTypeKind || (exports.ZodFirstPartyTypeKind = ZodFirstPartyTypeKind = {})); - var instanceOfType = (cls, params = { - message: `Input not instance of ${cls.name}` - }) => custom((data) => data instanceof cls, params); - exports.instanceof = instanceOfType; - var stringType = ZodString.create; - exports.string = stringType; - var numberType = ZodNumber.create; - exports.number = numberType; - var nanType = ZodNaN.create; - exports.nan = nanType; - var bigIntType = ZodBigInt.create; - exports.bigint = bigIntType; - var booleanType = ZodBoolean.create; - exports.boolean = booleanType; - var dateType = ZodDate.create; - exports.date = dateType; - var symbolType = ZodSymbol.create; - exports.symbol = symbolType; - var undefinedType = ZodUndefined.create; - exports.undefined = undefinedType; - var nullType = ZodNull.create; - exports.null = nullType; - var anyType = ZodAny.create; - exports.any = anyType; - var unknownType = ZodUnknown.create; - exports.unknown = unknownType; - var neverType = ZodNever.create; - exports.never = neverType; - var voidType = ZodVoid.create; - exports.void = voidType; - var arrayType = ZodArray.create; - exports.array = arrayType; - var objectType = ZodObject.create; - exports.object = objectType; - var strictObjectType = ZodObject.strictCreate; - exports.strictObject = strictObjectType; - var unionType = ZodUnion.create; - exports.union = unionType; - var discriminatedUnionType = ZodDiscriminatedUnion.create; - exports.discriminatedUnion = discriminatedUnionType; - var intersectionType = ZodIntersection.create; - exports.intersection = intersectionType; - var tupleType = ZodTuple.create; - exports.tuple = tupleType; - var recordType = ZodRecord.create; - exports.record = recordType; - var mapType = ZodMap.create; - exports.map = mapType; - var setType = ZodSet.create; - exports.set = setType; - var functionType = ZodFunction.create; - exports.function = functionType; - var lazyType = ZodLazy.create; - exports.lazy = lazyType; - var literalType = ZodLiteral.create; - exports.literal = literalType; - var enumType = ZodEnum.create; - exports.enum = enumType; - var nativeEnumType = ZodNativeEnum.create; - exports.nativeEnum = nativeEnumType; - var promiseType = ZodPromise.create; - exports.promise = promiseType; - var effectsType = ZodEffects.create; - exports.effect = effectsType; - exports.transformer = effectsType; - var optionalType = ZodOptional.create; - exports.optional = optionalType; - var nullableType = ZodNullable.create; - exports.nullable = nullableType; - var preprocessType = ZodEffects.createWithPreprocess; - exports.preprocess = preprocessType; - var pipelineType = ZodPipeline.create; - exports.pipeline = pipelineType; - var ostring = () => stringType().optional(); - exports.ostring = ostring; - var onumber = () => numberType().optional(); - exports.onumber = onumber; - var oboolean = () => booleanType().optional(); - exports.oboolean = oboolean; - exports.coerce = { - string: ((arg) => ZodString.create({ ...arg, coerce: true })), - number: ((arg) => ZodNumber.create({ ...arg, coerce: true })), - boolean: ((arg) => ZodBoolean.create({ - ...arg, - coerce: true - })), - bigint: ((arg) => ZodBigInt.create({ ...arg, coerce: true })), - date: ((arg) => ZodDate.create({ ...arg, coerce: true })) - }; - exports.NEVER = parseUtil_js_1.INVALID; - } - }); - - // node_modules/zod/v3/external.cjs - var require_external = __commonJS({ - "node_modules/zod/v3/external.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_errors(), exports); - __exportStar(require_parseUtil(), exports); - __exportStar(require_typeAliases(), exports); - __exportStar(require_util(), exports); - __exportStar(require_types(), exports); - __exportStar(require_ZodError(), exports); - } - }); - - // node_modules/zod/index.cjs - var require_zod = __commonJS({ - "node_modules/zod/index.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); - } - __setModuleDefault(result, mod); - return result; - }; - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.z = void 0; - var z = __importStar(require_external()); - exports.z = z; - __exportStar(require_external(), exports); - exports.default = z; - } - }); - - // node_modules/@mistralai/mistralai/lib/base64.js - var require_base64 = __commonJS({ - "node_modules/@mistralai/mistralai/lib/base64.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodInbound = exports.zodOutbound = void 0; - exports.bytesToBase64 = bytesToBase64; - exports.bytesFromBase64 = bytesFromBase64; - exports.stringToBytes = stringToBytes; - exports.stringFromBytes = stringFromBytes; - exports.stringToBase64 = stringToBase64; - exports.stringFromBase64 = stringFromBase64; - var z = __importStar(require_zod()); - function bytesToBase64(u8arr) { - return btoa(String.fromCodePoint(...u8arr)); - } - function bytesFromBase64(encoded) { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); - } - function stringToBytes(str) { - return new TextEncoder().encode(str); - } - function stringFromBytes(u8arr) { - return new TextDecoder().decode(u8arr); - } - function stringToBase64(str) { - return bytesToBase64(stringToBytes(str)); - } - function stringFromBase64(b64str) { - return stringFromBytes(bytesFromBase64(b64str)); - } - exports.zodOutbound = z.instanceof(Uint8Array).or(z.string().transform(stringToBytes)); - exports.zodInbound = z.instanceof(Uint8Array).or(z.string().transform(bytesFromBase64)); - } - }); - - // node_modules/@mistralai/mistralai/lib/is-plain-object.js - var require_is_plain_object = __commonJS({ - "node_modules/@mistralai/mistralai/lib/is-plain-object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isPlainObject = isPlainObject; - function isPlainObject(value) { - if (typeof value !== "object" || value === null) { - return false; - } - const prototype = Object.getPrototypeOf(value); - return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/encodings.js - var require_encodings = __commonJS({ - "node_modules/@mistralai/mistralai/lib/encodings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.encodeDeepObjectQuery = exports.encodePipeDelimitedQuery = exports.encodeSpaceDelimitedQuery = exports.encodeFormQuery = exports.encodeJSONQuery = exports.encodeSimple = exports.encodePipeDelimited = exports.encodeSpaceDelimited = exports.encodeForm = exports.EncodingError = void 0; - exports.encodeMatrix = encodeMatrix; - exports.encodeLabel = encodeLabel; - exports.encodeBodyForm = encodeBodyForm; - exports.encodeDeepObject = encodeDeepObject; - exports.encodeDeepObjectObject = encodeDeepObjectObject; - exports.encodeJSON = encodeJSON; - exports.queryJoin = queryJoin; - exports.queryEncoder = queryEncoder; - exports.appendForm = appendForm; - var base64_js_1 = require_base64(); - var is_plain_object_js_1 = require_is_plain_object(); - var EncodingError = class extends Error { - constructor(message) { - super(message); - this.name = "EncodingError"; - } - }; - exports.EncodingError = EncodingError; - function encodeMatrix(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - if (!tmp) { - return; - } - out += `;${tmp}`; - }); - return out; - } - function encodeLabel(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - out += encValue == null ? "" : `.${encValue}`; - }); - return out; - } - function formEncoder(sep) { - return (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - const encodedSep = encodeString(sep); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - }; - } - exports.encodeForm = formEncoder(","); - exports.encodeSpaceDelimited = formEncoder(" "); - exports.encodePipeDelimited = formEncoder("|"); - function encodeBodyForm(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - } - function encodeDeepObject(key, value, options) { - if (value == null) { - return; - } - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Value of parameter '${key}' which uses deepObject encoding must be an object or null`); - } - return encodeDeepObjectObject(key, value, options); - } - function encodeDeepObjectObject(key, value, options) { - if (value == null) { - return; - } - let out = ""; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - const pk = `${key}[${ck}]`; - if ((0, is_plain_object_js_1.isPlainObject)(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - out += objOut == null ? "" : `&${objOut}`; - return; - } - const pairs = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - out += encoded == null ? "" : `&${encoded}`; - }); - return out.slice(1); - } - function encodeJSON(key, value, options) { - if (typeof value === "undefined") { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; - } - var encodeSimple = (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - out += tmp ? `,${tmp}` : ""; - }); - return out.slice(1); - }; - exports.encodeSimple = encodeSimple; - function explode(key, value) { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if ((0, is_plain_object_js_1.isPlainObject)(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } - } - function serializeValue(value) { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - return `${value}`; - } - function jsonReplacer(_, value) { - if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else { - return value; - } - } - function mapDefined(inp, mapper) { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - const m = mapper(v); - if (m == null) { - return acc; - } - acc.push(m); - return acc; - }, []); - return res.length ? res : null; - } - function mapDefinedEntries(inp, mapper) { - const acc = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - const m = mapper([k, v]); - if (m == null) { - continue; - } - acc.push(m); - } - return acc.length ? acc : null; - } - function queryJoin(...args) { - return args.filter(Boolean).join("&"); - } - function queryEncoder(f) { - const bulkEncode = function(values, options) { - const opts = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent" - }; - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - return bulkEncode; - } - exports.encodeJSONQuery = queryEncoder(encodeJSON); - exports.encodeFormQuery = queryEncoder(exports.encodeForm); - exports.encodeSpaceDelimitedQuery = queryEncoder(exports.encodeSpaceDelimited); - exports.encodePipeDelimitedQuery = queryEncoder(exports.encodePipeDelimited); - exports.encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - function appendForm(fd, key, value, fileName) { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/dlv.js - var require_dlv = __commonJS({ - "node_modules/@mistralai/mistralai/lib/dlv.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.dlv = dlv; - function dlv(obj, key, def, p, undef) { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/env.js - var require_env = __commonJS({ - "node_modules/@mistralai/mistralai/lib/env.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.envSchema = void 0; - exports.env = env; - exports.resetEnv = resetEnv; - var dlv_js_1 = require_dlv(); - var z = __importStar(require_zod()); - exports.envSchema = z.object({ - MISTRAL_API_KEY: z.string().optional(), - MISTRAL_DEBUG: z.coerce.boolean().optional() - }); - var envMemo = void 0; - function env() { - if (envMemo) { - return envMemo; - } - envMemo = exports.envSchema.parse((0, dlv_js_1.dlv)(globalThis, "process.env") ?? (0, dlv_js_1.dlv)(globalThis, "Deno.env") ?? {}); - return envMemo; - } - function resetEnv() { - envMemo = void 0; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/retries.js - var require_retries = __commonJS({ - "node_modules/@mistralai/mistralai/lib/retries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TemporaryError = exports.PermanentError = void 0; - exports.retry = retry; - var http_js_1 = require_http(); - var defaultBackoff = { - initialInterval: 500, - maxInterval: 6e4, - exponent: 1.5, - maxElapsedTime: 36e5 - }; - var PermanentError = class _PermanentError extends Error { - constructor(message, options) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - super(msg, options); - this.name = "PermanentError"; - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - Object.setPrototypeOf(this, _PermanentError.prototype); - } - }; - exports.PermanentError = PermanentError; - var TemporaryError = class _TemporaryError extends Error { - constructor(message, response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - Object.setPrototypeOf(this, _TemporaryError.prototype); - } - }; - exports.TemporaryError = TemporaryError; - async function retry(fetchFn, options) { - switch (options.config.strategy) { - case "backoff": - return retryBackoff(wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors - }), options.config.backoff ?? defaultBackoff); - default: - return await fetchFn(); - } - } - function wrapFetcher(fn, options) { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError("Response failed with retryable status code", res); - } - return res; - } catch (err) { - if (err instanceof TemporaryError) { - throw err; - } - if (options.retryConnectionErrors && ((0, http_js_1.isTimeoutError)(err) || (0, http_js_1.isConnectionError)(err))) { - throw err; - } - throw new PermanentError("Permanent error", { cause: err }); - } - }; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function isRetryableResponse(res, statusCodes) { - const actual = `${res.status}`; - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - async function retryBackoff(fn, strategy) { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - const start = Date.now(); - let x = 0; - while (true) { - try { - const res = await fn(); - return res; - } catch (err) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - throw err; - } - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - if (retryInterval <= 0) { - retryInterval = initialInterval * Math.pow(x, exponent) + Math.random() * 1e3; - } - const d = Math.min(retryInterval, maxInterval); - await delay(d); - x++; - } - } - } - function retryIntervalFromResponse(res) { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1e3; - } - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - return 0; - } - async function delay(delay2) { - return new Promise((resolve) => setTimeout(resolve, delay2)); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/sdks.js - var require_sdks = __commonJS({ - "node_modules/@mistralai/mistralai/lib/sdks.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _ClientSDK_httpClient; - var _ClientSDK_hooks; - var _ClientSDK_logger; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClientSDK = void 0; - var hooks_js_1 = require_hooks(); - var httpclienterrors_js_1 = require_httpclienterrors(); - var fp_js_1 = require_fp(); - var base64_js_1 = require_base64(); - var config_js_1 = require_config(); - var encodings_js_1 = require_encodings(); - var env_js_1 = require_env(); - var http_js_1 = require_http(); - var retries_js_1 = require_retries(); - var gt = typeof globalThis === "undefined" ? null : globalThis; - var webWorkerLike = typeof gt === "object" && gt != null && "importScripts" in gt && typeof gt["importScripts"] === "function"; - var isBrowserLike = webWorkerLike || typeof navigator !== "undefined" && "serviceWorker" in navigator || typeof window === "object" && typeof window.document !== "undefined"; - var ClientSDK = class { - constructor(options = {}) { - _ClientSDK_httpClient.set(this, void 0); - _ClientSDK_hooks.set(this, void 0); - _ClientSDK_logger.set(this, void 0); - const opt = options; - if (typeof opt === "object" && opt != null && "hooks" in opt && opt.hooks instanceof hooks_js_1.SDKHooks) { - __classPrivateFieldSet(this, _ClientSDK_hooks, opt.hooks, "f"); - } else { - __classPrivateFieldSet(this, _ClientSDK_hooks, new hooks_js_1.SDKHooks(), "f"); - } - const url = (0, config_js_1.serverURLFromOptions)(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").sdkInit({ - baseURL: url, - client: options.httpClient || new http_js_1.HTTPClient() - }); - this._baseURL = baseURL; - __classPrivateFieldSet(this, _ClientSDK_httpClient, client, "f"); - this._options = { ...options, hooks: __classPrivateFieldGet(this, _ClientSDK_hooks, "f") }; - __classPrivateFieldSet(this, _ClientSDK_logger, this._options.debugLogger, "f"); - if (!__classPrivateFieldGet(this, _ClientSDK_logger, "f") && (0, env_js_1.env)().MISTRAL_DEBUG) { - __classPrivateFieldSet(this, _ClientSDK_logger, console, "f"); - } - } - _createRequest(context, conf, options) { - const { method, path, query, headers: opHeaders, security } = conf; - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - let finalQuery = query || ""; - const secQuery = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = (0, encodings_js_1.encodeForm)(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - const headers = new Headers(opHeaders); - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = (0, base64_js_1.stringToBase64)([username || "", password || ""].join(":")); - headers.set("Authorization", `Basic ${encoded}`); - } - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - const userHeaders = new Headers(options?.headers ?? options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", conf.userAgent ?? config_js_1.SDK_METADATA.userAgent); - } - const fetchOptions = { - ...options?.fetchOptions, - ...options - }; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - fetchOptions.signal = timeoutSignal; - } - if (conf.body instanceof ReadableStream) { - Object.assign(fetchOptions, { duplex: "half" }); - } - let input; - try { - input = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method - } - }); - } catch (err) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Create request hook failed to execute", { - cause: err - })); - } - return (0, fp_js_1.OK)(new Request(input.url, input.options)); - } - async _do(request, options) { - const { context, errorCodes } = options; - return (0, retries_js_1.retry)(async () => { - const req = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeRequest(context, request.clone()); - await logRequest(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log request:", e)); - let response = await __classPrivateFieldGet(this, _ClientSDK_httpClient, "f").request(req); - try { - if ((0, http_js_1.matchStatusCode)(response, errorCodes)) { - const result = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterError(context, response, null); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterSuccess(context, response); - } - } finally { - await logResponse(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), response, req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log response:", e)); - } - return response; - }, { config: options.retryConfig, statusCodes: options.retryCodes }).then((r) => (0, fp_js_1.OK)(r), (err) => { - switch (true) { - case (0, http_js_1.isAbortError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestAbortedError("Request aborted by client", { - cause: err - })); - case (0, http_js_1.isTimeoutError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestTimeoutError("Request timed out", { cause: err })); - case (0, http_js_1.isConnectionError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.ConnectionError("Unable to make request", { cause: err })); - default: - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Unexpected HTTP client error", { - cause: err - })); - } - }); - } - }; - exports.ClientSDK = ClientSDK; - _ClientSDK_httpClient = /* @__PURE__ */ new WeakMap(), _ClientSDK_hooks = /* @__PURE__ */ new WeakMap(), _ClientSDK_logger = /* @__PURE__ */ new WeakMap(); - var jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; - var jsonlLikeContentTypeRE = /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; - async function logRequest(logger, req) { - if (!logger) { - return; - } - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`> Request: ${req.method} ${req.url}`); - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - async function logResponse(logger, res, req) { - if (!logger) { - return; - } - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case ((0, http_js_1.matchContentType)(res, "application/json") || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().json()); - break; - case ((0, http_js_1.matchContentType)(res, "application/jsonl") || jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case (0, http_js_1.matchContentType)(res, "text/*"): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/mistralerror.js - var require_mistralerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/mistralerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralError = void 0; - var MistralError = class extends Error { - constructor(message, httpMeta) { - super(message); - this.statusCode = httpMeta.response.status; - this.body = httpMeta.body; - this.headers = httpMeta.response.headers; - this.contentType = httpMeta.response.headers.get("content-type") || ""; - this.rawResponse = httpMeta.response; - this.name = "MistralError"; - } - }; - exports.MistralError = MistralError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js - var require_sdkvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKValidationError = void 0; - exports.formatZodError = formatZodError; - var z = __importStar(require_zod()); - var SDKValidationError = class extends Error { - // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError` - static [Symbol.hasInstance](instance) { - if (!(instance instanceof Error)) - return false; - if (!("rawValue" in instance)) - return false; - if (!("rawMessage" in instance)) - return false; - if (!("pretty" in instance)) - return false; - if (typeof instance.pretty !== "function") - return false; - return true; - } - constructor(message, cause, rawValue) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.SDKValidationError = SDKValidationError; - function formatZodError(err, level = 0) { - let pre = " ".repeat(level); - pre = level > 0 ? `\u2502${pre}` : pre; - pre += " ".repeat(level); - let message = ""; - const append = (str) => message += ` -${pre}${str}`; - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - if (len) { - append(`\u250C ${headline}:`); - } - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`\u2502 \u2022 [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`\u2502 Want: ${issue.expected}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`\u2502 Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len2 = issue.unionErrors.length; - append(`\u2502 \u2716\uFE0E Attemped to deserialize into one of ${len2} union members:`); - issue.unionErrors.forEach((err2, i) => { - append(`\u2502 \u2716\uFE0E Member ${i + 1} of ${len2}`); - append(`${formatZodError(err2, level + 1)}`); - }); - } - } - } - if (err.issues.length) { - append(`\u2514\u2500*`); - } - return message.slice(1); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js - var require_responsevalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseValidationError = void 0; - var z = __importStar(require_zod()); - var mistralerror_js_1 = require_mistralerror(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var ResponseValidationError = class extends mistralerror_js_1.MistralError { - constructor(message, extra) { - super(message, extra); - this.name = "ResponseValidationError"; - this.cause = extra.cause; - this.rawValue = extra.rawValue; - this.rawMessage = extra.rawMessage; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${(0, sdkvalidationerror_js_1.formatZodError)(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.ResponseValidationError = ResponseValidationError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkerror.js - var require_sdkerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKError = void 0; - var mistralerror_js_1 = require_mistralerror(); - var SDKError = class extends mistralerror_js_1.MistralError { - constructor(message, httpMeta) { - if (message) { - message += `: `; - } - message += `Status ${httpMeta.response.status}`; - const contentType = httpMeta.response.headers.get("content-type") || `""`; - if (contentType !== "application/json") { - message += ` Content-Type ${contentType.includes(" ") ? `"${contentType}"` : contentType}`; - } - const body = httpMeta.body || `""`; - message += body.length > 100 ? "\n" : ". "; - let bodyDisplay = body; - if (body.length > 1e4) { - const truncated = body.substring(0, 1e4); - const remaining = body.length - 1e4; - bodyDisplay = `${truncated}...and ${remaining} more chars`; - } - message += `Body: ${bodyDisplay}`; - message = message.trim(); - super(message, httpMeta); - this.name = "SDKError"; - } - }; - exports.SDKError = SDKError; - } - }); - - // node_modules/@mistralai/mistralai/lib/matchers.js - var require_matchers = __commonJS({ - "node_modules/@mistralai/mistralai/lib/matchers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.jsonErr = jsonErr; - exports.json = json; - exports.jsonl = jsonl; - exports.jsonlErr = jsonlErr; - exports.textErr = textErr; - exports.text = text; - exports.bytesErr = bytesErr; - exports.bytes = bytes; - exports.streamErr = streamErr; - exports.stream = stream; - exports.sseErr = sseErr; - exports.sse = sse; - exports.nilErr = nilErr; - exports.nil = nil; - exports.fail = fail; - exports.match = match; - exports.unpackHeaders = unpackHeaders; - var responsevalidationerror_js_1 = require_responsevalidationerror(); - var sdkerror_js_1 = require_sdkerror(); - var fp_js_1 = require_fp(); - var http_js_1 = require_http(); - var is_plain_object_js_1 = require_is_plain_object(); - var DEFAULT_CONTENT_TYPES = { - jsonl: "application/jsonl", - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*" - }; - function jsonErr(codes, schema, options) { - return { ...options, err: true, enc: "json", codes, schema }; - } - function json(codes, schema, options) { - return { ...options, enc: "json", codes, schema }; - } - function jsonl(codes, schema, options) { - return { ...options, enc: "jsonl", codes, schema }; - } - function jsonlErr(codes, schema, options) { - return { ...options, err: true, enc: "jsonl", codes, schema }; - } - function textErr(codes, schema, options) { - return { ...options, err: true, enc: "text", codes, schema }; - } - function text(codes, schema, options) { - return { ...options, enc: "text", codes, schema }; - } - function bytesErr(codes, schema, options) { - return { ...options, err: true, enc: "bytes", codes, schema }; - } - function bytes(codes, schema, options) { - return { ...options, enc: "bytes", codes, schema }; - } - function streamErr(codes, schema, options) { - return { ...options, err: true, enc: "stream", codes, schema }; - } - function stream(codes, schema, options) { - return { ...options, enc: "stream", codes, schema }; - } - function sseErr(codes, schema, options) { - return { ...options, err: true, enc: "sse", codes, schema }; - } - function sse(codes, schema, options) { - return { ...options, enc: "sse", codes, schema }; - } - function nilErr(codes, schema, options) { - return { ...options, err: true, enc: "nil", codes, schema }; - } - function nil(codes, schema, options) { - return { ...options, enc: "nil", codes, schema }; - } - function fail(codes) { - return { enc: "fail", codes }; - } - function match(...matchers) { - return async function matchFunc(response, request, options) { - let raw; - let matcher; - for (const match2 of matchers) { - const { codes } = match2; - const ctpattern = "ctype" in match2 ? match2.ctype : DEFAULT_CONTENT_TYPES[match2.enc]; - if (ctpattern && (0, http_js_1.matchResponse)(response, codes, ctpattern)) { - matcher = match2; - break; - } else if (!ctpattern && (0, http_js_1.matchStatusCode)(response, codes)) { - matcher = match2; - break; - } - } - if (!matcher) { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("Unexpected Status or Content-Type", { - response, - request, - body: await response.text().catch(() => "") - }) - }, raw]; - } - const encoding = matcher.enc; - let body = ""; - switch (encoding) { - case "json": - body = await response.text(); - raw = JSON.parse(body); - break; - case "jsonl": - raw = response.body; - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - body = await response.text(); - raw = body; - break; - case "sse": - raw = response.body; - break; - case "nil": - body = await response.text(); - raw = void 0; - break; - case "fail": - body = await response.text(); - raw = body; - break; - default: - encoding; - throw new Error(`Unsupported response type: ${encoding}`); - } - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("API error occurred", { request, response, body }) - }, raw]; - } - const resultKey = matcher.key || options?.resultKey; - let data; - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null, - request$: request, - response$: response, - body$: body - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - [resultKey]: raw - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null - }; - } else { - data = raw; - } - if ("err" in matcher) { - const result = safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }), - raw - ]; - } - }; - } - var headerValRE = /, */; - function unpackHeaders(headers) { - const out = {}; - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - return out; - } - function safeParseResponse(rawValue, fn, errorMessage, httpMeta) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new responsevalidationerror_js_1.ResponseValidationError(errorMessage, { - cause: err, - rawValue, - rawMessage: errorMessage, - ...httpMeta - })); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/primitives.js - var require_primitives = __commonJS({ - "node_modules/@mistralai/mistralai/lib/primitives.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.invariant = invariant; - exports.remap = remap; - exports.combineSignals = combineSignals; - exports.abortSignalAny = abortSignalAny; - exports.compactMap = compactMap; - exports.allRequired = allRequired; - var InvariantError = class extends Error { - constructor(message) { - super(message); - this.name = "InvariantError"; - } - }; - function invariant(condition, message) { - if (!condition) { - throw new InvariantError(message); - } - } - function remap(inp, mappings) { - let out = {}; - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - return out; - } - function combineSignals(...signals) { - const filtered = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } - } - function abortSignalAny(signals) { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - if (signals.length === 1) { - return signals[0] || controller.signal; - } - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - function abort() { - controller.abort(this.reason); - clean(); - } - const signalRefs = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - return result; - } - function compactMap(values) { - const out = {}; - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - return out; - } - function allRequired(v) { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - return v; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/schemas.js - var require_schemas = __commonJS({ - "node_modules/@mistralai/mistralai/lib/schemas.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parse = parse; - exports.safeParse = safeParse; - exports.collectExtraKeys = collectExtraKeys; - var zod_1 = require_zod(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var fp_js_1 = require_fp(); - function parse(rawValue, fn, errorMessage) { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof zod_1.ZodError) { - throw new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } - } - function safeParse(rawValue, fn, errorMessage) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue)); - } - } - function collectExtraKeys(obj, extrasKey, optional) { - return obj.transform((val) => { - const extras = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - extras[key] = v; - delete val[key]; - } - if (optional && Object.keys(extras).length === 0) { - return val; - } - return { ...val, [extrasKey]: extras }; - }); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/security.js - var require_security = __commonJS({ - "node_modules/@mistralai/mistralai/lib/security.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SecurityError = exports.SecurityErrorCode = void 0; - exports.resolveSecurity = resolveSecurity; - exports.resolveGlobalSecurity = resolveGlobalSecurity; - exports.extractSecurity = extractSecurity; - var env_js_1 = require_env(); - var SecurityErrorCode; - (function(SecurityErrorCode2) { - SecurityErrorCode2["Incomplete"] = "incomplete"; - SecurityErrorCode2["UnrecognisedSecurityType"] = "unrecognized_security_type"; - })(SecurityErrorCode || (exports.SecurityErrorCode = SecurityErrorCode = {})); - var SecurityError = class _SecurityError extends Error { - constructor(code, message) { - super(message); - this.code = code; - this.name = "SecurityError"; - } - static incomplete() { - return new _SecurityError(SecurityErrorCode.Incomplete, "Security requirements not met in order to perform the operation"); - } - static unrecognizedType(type) { - return new _SecurityError(SecurityErrorCode.UnrecognisedSecurityType, `Unrecognised security type: ${type}`); - } - }; - exports.SecurityError = SecurityError; - function resolveSecurity(...options) { - const state = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" } - }; - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return typeof o.value === "string" && !!o.value; - } else if (o.type === "oauth2:client_credentials") { - if (typeof o.value == "string") { - return !!o.value; - } - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o.value})`); - } - }); - }); - if (option == null) { - return null; - } - option.forEach((spec) => { - if (spec.value == null) { - return; - } - const { type } = spec; - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec; - throw SecurityError.unrecognizedType(type); - } - }); - return state; - } - function applyBasic(state, spec) { - if (spec.value == null) { - return; - } - state.basic = spec.value; - } - function applyBearer(state, spec) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - if (spec.fieldName !== void 0) { - state.headers[spec.fieldName] = value; - } - } - function resolveGlobalSecurity(security) { - return resolveSecurity([ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey ?? (0, env_js_1.env)().MISTRAL_API_KEY - } - ]); - } - async function extractSecurity(sec) { - if (sec == null) { - return; - } - return typeof sec === "function" ? sec() : sec; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js - var require_codeinterpretertool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CodeInterpreterTool$ = exports.CodeInterpreterTool$outboundSchema = exports.CodeInterpreterTool$inboundSchema = exports.CodeInterpreterToolType$ = exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema = exports.CodeInterpreterToolType = void 0; - exports.codeInterpreterToolToJSON = codeInterpreterToolToJSON; - exports.codeInterpreterToolFromJSON = codeInterpreterToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CodeInterpreterToolType = { - CodeInterpreter: "code_interpreter" - }; - exports.CodeInterpreterToolType$inboundSchema = z.nativeEnum(exports.CodeInterpreterToolType); - exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema; - var CodeInterpreterToolType$; - (function(CodeInterpreterToolType$2) { - CodeInterpreterToolType$2.inboundSchema = exports.CodeInterpreterToolType$inboundSchema; - CodeInterpreterToolType$2.outboundSchema = exports.CodeInterpreterToolType$outboundSchema; - })(CodeInterpreterToolType$ || (exports.CodeInterpreterToolType$ = CodeInterpreterToolType$ = {})); - exports.CodeInterpreterTool$inboundSchema = z.object({ - type: exports.CodeInterpreterToolType$inboundSchema.default("code_interpreter") - }); - exports.CodeInterpreterTool$outboundSchema = z.object({ - type: exports.CodeInterpreterToolType$outboundSchema.default("code_interpreter") - }); - var CodeInterpreterTool$; - (function(CodeInterpreterTool$2) { - CodeInterpreterTool$2.inboundSchema = exports.CodeInterpreterTool$inboundSchema; - CodeInterpreterTool$2.outboundSchema = exports.CodeInterpreterTool$outboundSchema; - })(CodeInterpreterTool$ || (exports.CodeInterpreterTool$ = CodeInterpreterTool$ = {})); - function codeInterpreterToolToJSON(codeInterpreterTool) { - return JSON.stringify(exports.CodeInterpreterTool$outboundSchema.parse(codeInterpreterTool)); - } - function codeInterpreterToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CodeInterpreterTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CodeInterpreterTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargsstop.js - var require_completionargsstop = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargsstop.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgsStop$ = exports.CompletionArgsStop$outboundSchema = exports.CompletionArgsStop$inboundSchema = void 0; - exports.completionArgsStopToJSON = completionArgsStopToJSON; - exports.completionArgsStopFromJSON = completionArgsStopFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CompletionArgsStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.CompletionArgsStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var CompletionArgsStop$; - (function(CompletionArgsStop$2) { - CompletionArgsStop$2.inboundSchema = exports.CompletionArgsStop$inboundSchema; - CompletionArgsStop$2.outboundSchema = exports.CompletionArgsStop$outboundSchema; - })(CompletionArgsStop$ || (exports.CompletionArgsStop$ = CompletionArgsStop$ = {})); - function completionArgsStopToJSON(completionArgsStop) { - return JSON.stringify(exports.CompletionArgsStop$outboundSchema.parse(completionArgsStop)); - } - function completionArgsStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgsStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgsStop' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/prediction.js - var require_prediction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/prediction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Prediction$ = exports.Prediction$outboundSchema = exports.Prediction$inboundSchema = void 0; - exports.predictionToJSON = predictionToJSON; - exports.predictionFromJSON = predictionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Prediction$inboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - exports.Prediction$outboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - var Prediction$; - (function(Prediction$2) { - Prediction$2.inboundSchema = exports.Prediction$inboundSchema; - Prediction$2.outboundSchema = exports.Prediction$outboundSchema; - })(Prediction$ || (exports.Prediction$ = Prediction$ = {})); - function predictionToJSON(prediction) { - return JSON.stringify(exports.Prediction$outboundSchema.parse(prediction)); - } - function predictionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Prediction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Prediction' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jsonschema.js - var require_jsonschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jsonschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JsonSchema$ = exports.JsonSchema$outboundSchema = exports.JsonSchema$inboundSchema = void 0; - exports.jsonSchemaToJSON = jsonSchemaToJSON; - exports.jsonSchemaFromJSON = jsonSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JsonSchema$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "schema": "schemaDefinition" - }); - }); - exports.JsonSchema$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - schemaDefinition: "schema" - }); - }); - var JsonSchema$; - (function(JsonSchema$2) { - JsonSchema$2.inboundSchema = exports.JsonSchema$inboundSchema; - JsonSchema$2.outboundSchema = exports.JsonSchema$outboundSchema; - })(JsonSchema$ || (exports.JsonSchema$ = JsonSchema$ = {})); - function jsonSchemaToJSON(jsonSchema) { - return JSON.stringify(exports.JsonSchema$outboundSchema.parse(jsonSchema)); - } - function jsonSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JsonSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JsonSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformats.js - var require_responseformats = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformats.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormats$ = exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema = exports.ResponseFormats = void 0; - var z = __importStar(require_zod()); - exports.ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema" - }; - exports.ResponseFormats$inboundSchema = z.nativeEnum(exports.ResponseFormats); - exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema; - var ResponseFormats$; - (function(ResponseFormats$2) { - ResponseFormats$2.inboundSchema = exports.ResponseFormats$inboundSchema; - ResponseFormats$2.outboundSchema = exports.ResponseFormats$outboundSchema; - })(ResponseFormats$ || (exports.ResponseFormats$ = ResponseFormats$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformat.js - var require_responseformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormat$ = exports.ResponseFormat$outboundSchema = exports.ResponseFormat$inboundSchema = void 0; - exports.responseFormatToJSON = responseFormatToJSON; - exports.responseFormatFromJSON = responseFormatFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var jsonschema_js_1 = require_jsonschema(); - var responseformats_js_1 = require_responseformats(); - exports.ResponseFormat$inboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(jsonschema_js_1.JsonSchema$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "json_schema": "jsonSchema" - }); - }); - exports.ResponseFormat$outboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(jsonschema_js_1.JsonSchema$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jsonSchema: "json_schema" - }); - }); - var ResponseFormat$; - (function(ResponseFormat$2) { - ResponseFormat$2.inboundSchema = exports.ResponseFormat$inboundSchema; - ResponseFormat$2.outboundSchema = exports.ResponseFormat$outboundSchema; - })(ResponseFormat$ || (exports.ResponseFormat$ = ResponseFormat$ = {})); - function responseFormatToJSON(responseFormat) { - return JSON.stringify(exports.ResponseFormat$outboundSchema.parse(responseFormat)); - } - function responseFormatFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseFormat$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseFormat' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js - var require_toolchoiceenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoiceEnum$ = exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema = exports.ToolChoiceEnum = void 0; - var z = __importStar(require_zod()); - exports.ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required" - }; - exports.ToolChoiceEnum$inboundSchema = z.nativeEnum(exports.ToolChoiceEnum); - exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema; - var ToolChoiceEnum$; - (function(ToolChoiceEnum$2) { - ToolChoiceEnum$2.inboundSchema = exports.ToolChoiceEnum$inboundSchema; - ToolChoiceEnum$2.outboundSchema = exports.ToolChoiceEnum$outboundSchema; - })(ToolChoiceEnum$ || (exports.ToolChoiceEnum$ = ToolChoiceEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargs.js - var require_completionargs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgs$ = exports.CompletionArgs$outboundSchema = exports.CompletionArgs$inboundSchema = void 0; - exports.completionArgsToJSON = completionArgsToJSON; - exports.completionArgsFromJSON = completionArgsFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargsstop_js_1 = require_completionargsstop(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - exports.CompletionArgs$inboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$inboundSchema).optional(), - presence_penalty: z.nullable(z.number()).optional(), - frequency_penalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - top_p: z.nullable(z.number()).optional(), - max_tokens: z.nullable(z.number().int()).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$inboundSchema).optional(), - response_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - tool_choice: toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice" - }); - }); - exports.CompletionArgs$outboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$outboundSchema).optional(), - presencePenalty: z.nullable(z.number()).optional(), - frequencyPenalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - topP: z.nullable(z.number()).optional(), - maxTokens: z.nullable(z.number().int()).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$outboundSchema).optional(), - responseFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - toolChoice: toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice" - }); - }); - var CompletionArgs$; - (function(CompletionArgs$2) { - CompletionArgs$2.inboundSchema = exports.CompletionArgs$inboundSchema; - CompletionArgs$2.outboundSchema = exports.CompletionArgs$outboundSchema; - })(CompletionArgs$ || (exports.CompletionArgs$ = CompletionArgs$ = {})); - function completionArgsToJSON(completionArgs) { - return JSON.stringify(exports.CompletionArgs$outboundSchema.parse(completionArgs)); - } - function completionArgsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js - var require_documentlibrarytool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentLibraryTool$ = exports.DocumentLibraryTool$outboundSchema = exports.DocumentLibraryTool$inboundSchema = exports.DocumentLibraryToolType$ = exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema = exports.DocumentLibraryToolType = void 0; - exports.documentLibraryToolToJSON = documentLibraryToolToJSON; - exports.documentLibraryToolFromJSON = documentLibraryToolFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentLibraryToolType = { - DocumentLibrary: "document_library" - }; - exports.DocumentLibraryToolType$inboundSchema = z.nativeEnum(exports.DocumentLibraryToolType); - exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema; - var DocumentLibraryToolType$; - (function(DocumentLibraryToolType$2) { - DocumentLibraryToolType$2.inboundSchema = exports.DocumentLibraryToolType$inboundSchema; - DocumentLibraryToolType$2.outboundSchema = exports.DocumentLibraryToolType$outboundSchema; - })(DocumentLibraryToolType$ || (exports.DocumentLibraryToolType$ = DocumentLibraryToolType$ = {})); - exports.DocumentLibraryTool$inboundSchema = z.object({ - type: exports.DocumentLibraryToolType$inboundSchema.default("document_library"), - library_ids: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_ids": "libraryIds" - }); - }); - exports.DocumentLibraryTool$outboundSchema = z.object({ - type: exports.DocumentLibraryToolType$outboundSchema.default("document_library"), - libraryIds: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryIds: "library_ids" - }); - }); - var DocumentLibraryTool$; - (function(DocumentLibraryTool$2) { - DocumentLibraryTool$2.inboundSchema = exports.DocumentLibraryTool$inboundSchema; - DocumentLibraryTool$2.outboundSchema = exports.DocumentLibraryTool$outboundSchema; - })(DocumentLibraryTool$ || (exports.DocumentLibraryTool$ = DocumentLibraryTool$ = {})); - function documentLibraryToolToJSON(documentLibraryTool) { - return JSON.stringify(exports.DocumentLibraryTool$outboundSchema.parse(documentLibraryTool)); - } - function documentLibraryToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentLibraryTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentLibraryTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/function.js - var require_function = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/function.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionT$ = exports.FunctionT$outboundSchema = exports.FunctionT$inboundSchema = void 0; - exports.functionToJSON = functionToJSON; - exports.functionFromJSON = functionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionT$inboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - exports.FunctionT$outboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - var FunctionT$; - (function(FunctionT$2) { - FunctionT$2.inboundSchema = exports.FunctionT$inboundSchema; - FunctionT$2.outboundSchema = exports.FunctionT$outboundSchema; - })(FunctionT$ || (exports.FunctionT$ = FunctionT$ = {})); - function functionToJSON(functionT) { - return JSON.stringify(exports.FunctionT$outboundSchema.parse(functionT)); - } - function functionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functiontool.js - var require_functiontool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functiontool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionTool$ = exports.FunctionTool$outboundSchema = exports.FunctionTool$inboundSchema = exports.FunctionToolType$ = exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema = exports.FunctionToolType = void 0; - exports.functionToolToJSON = functionToolToJSON; - exports.functionToolFromJSON = functionToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - exports.FunctionToolType = { - Function: "function" - }; - exports.FunctionToolType$inboundSchema = z.nativeEnum(exports.FunctionToolType); - exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema; - var FunctionToolType$; - (function(FunctionToolType$2) { - FunctionToolType$2.inboundSchema = exports.FunctionToolType$inboundSchema; - FunctionToolType$2.outboundSchema = exports.FunctionToolType$outboundSchema; - })(FunctionToolType$ || (exports.FunctionToolType$ = FunctionToolType$ = {})); - exports.FunctionTool$inboundSchema = z.object({ - type: exports.FunctionToolType$inboundSchema.default("function"), - function: function_js_1.FunctionT$inboundSchema - }); - exports.FunctionTool$outboundSchema = z.object({ - type: exports.FunctionToolType$outboundSchema.default("function"), - function: function_js_1.FunctionT$outboundSchema - }); - var FunctionTool$; - (function(FunctionTool$2) { - FunctionTool$2.inboundSchema = exports.FunctionTool$inboundSchema; - FunctionTool$2.outboundSchema = exports.FunctionTool$outboundSchema; - })(FunctionTool$ || (exports.FunctionTool$ = FunctionTool$ = {})); - function functionToolToJSON(functionTool) { - return JSON.stringify(exports.FunctionTool$outboundSchema.parse(functionTool)); - } - function functionToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js - var require_imagegenerationtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageGenerationTool$ = exports.ImageGenerationTool$outboundSchema = exports.ImageGenerationTool$inboundSchema = exports.ImageGenerationToolType$ = exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema = exports.ImageGenerationToolType = void 0; - exports.imageGenerationToolToJSON = imageGenerationToolToJSON; - exports.imageGenerationToolFromJSON = imageGenerationToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageGenerationToolType = { - ImageGeneration: "image_generation" - }; - exports.ImageGenerationToolType$inboundSchema = z.nativeEnum(exports.ImageGenerationToolType); - exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema; - var ImageGenerationToolType$; - (function(ImageGenerationToolType$2) { - ImageGenerationToolType$2.inboundSchema = exports.ImageGenerationToolType$inboundSchema; - ImageGenerationToolType$2.outboundSchema = exports.ImageGenerationToolType$outboundSchema; - })(ImageGenerationToolType$ || (exports.ImageGenerationToolType$ = ImageGenerationToolType$ = {})); - exports.ImageGenerationTool$inboundSchema = z.object({ - type: exports.ImageGenerationToolType$inboundSchema.default("image_generation") - }); - exports.ImageGenerationTool$outboundSchema = z.object({ - type: exports.ImageGenerationToolType$outboundSchema.default("image_generation") - }); - var ImageGenerationTool$; - (function(ImageGenerationTool$2) { - ImageGenerationTool$2.inboundSchema = exports.ImageGenerationTool$inboundSchema; - ImageGenerationTool$2.outboundSchema = exports.ImageGenerationTool$outboundSchema; - })(ImageGenerationTool$ || (exports.ImageGenerationTool$ = ImageGenerationTool$ = {})); - function imageGenerationToolToJSON(imageGenerationTool) { - return JSON.stringify(exports.ImageGenerationTool$outboundSchema.parse(imageGenerationTool)); - } - function imageGenerationToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageGenerationTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageGenerationTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js - var require_websearchpremiumtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchPremiumTool$ = exports.WebSearchPremiumTool$outboundSchema = exports.WebSearchPremiumTool$inboundSchema = exports.WebSearchPremiumToolType$ = exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema = exports.WebSearchPremiumToolType = void 0; - exports.webSearchPremiumToolToJSON = webSearchPremiumToolToJSON; - exports.webSearchPremiumToolFromJSON = webSearchPremiumToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchPremiumToolType = { - WebSearchPremium: "web_search_premium" - }; - exports.WebSearchPremiumToolType$inboundSchema = z.nativeEnum(exports.WebSearchPremiumToolType); - exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - var WebSearchPremiumToolType$; - (function(WebSearchPremiumToolType$2) { - WebSearchPremiumToolType$2.inboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - WebSearchPremiumToolType$2.outboundSchema = exports.WebSearchPremiumToolType$outboundSchema; - })(WebSearchPremiumToolType$ || (exports.WebSearchPremiumToolType$ = WebSearchPremiumToolType$ = {})); - exports.WebSearchPremiumTool$inboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$inboundSchema.default("web_search_premium") - }); - exports.WebSearchPremiumTool$outboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$outboundSchema.default("web_search_premium") - }); - var WebSearchPremiumTool$; - (function(WebSearchPremiumTool$2) { - WebSearchPremiumTool$2.inboundSchema = exports.WebSearchPremiumTool$inboundSchema; - WebSearchPremiumTool$2.outboundSchema = exports.WebSearchPremiumTool$outboundSchema; - })(WebSearchPremiumTool$ || (exports.WebSearchPremiumTool$ = WebSearchPremiumTool$ = {})); - function webSearchPremiumToolToJSON(webSearchPremiumTool) { - return JSON.stringify(exports.WebSearchPremiumTool$outboundSchema.parse(webSearchPremiumTool)); - } - function webSearchPremiumToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchPremiumTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchPremiumTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchtool.js - var require_websearchtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchTool$ = exports.WebSearchTool$outboundSchema = exports.WebSearchTool$inboundSchema = exports.WebSearchToolType$ = exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema = exports.WebSearchToolType = void 0; - exports.webSearchToolToJSON = webSearchToolToJSON; - exports.webSearchToolFromJSON = webSearchToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchToolType = { - WebSearch: "web_search" - }; - exports.WebSearchToolType$inboundSchema = z.nativeEnum(exports.WebSearchToolType); - exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema; - var WebSearchToolType$; - (function(WebSearchToolType$2) { - WebSearchToolType$2.inboundSchema = exports.WebSearchToolType$inboundSchema; - WebSearchToolType$2.outboundSchema = exports.WebSearchToolType$outboundSchema; - })(WebSearchToolType$ || (exports.WebSearchToolType$ = WebSearchToolType$ = {})); - exports.WebSearchTool$inboundSchema = z.object({ - type: exports.WebSearchToolType$inboundSchema.default("web_search") - }); - exports.WebSearchTool$outboundSchema = z.object({ - type: exports.WebSearchToolType$outboundSchema.default("web_search") - }); - var WebSearchTool$; - (function(WebSearchTool$2) { - WebSearchTool$2.inboundSchema = exports.WebSearchTool$inboundSchema; - WebSearchTool$2.outboundSchema = exports.WebSearchTool$outboundSchema; - })(WebSearchTool$ || (exports.WebSearchTool$ = WebSearchTool$ = {})); - function webSearchToolToJSON(webSearchTool) { - return JSON.stringify(exports.WebSearchTool$outboundSchema.parse(webSearchTool)); - } - function webSearchToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agent.js - var require_agent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agent$ = exports.Agent$outboundSchema = exports.Agent$inboundSchema = exports.AgentObject$ = exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema = exports.AgentTools$ = exports.AgentTools$outboundSchema = exports.AgentTools$inboundSchema = exports.AgentObject = void 0; - exports.agentToolsToJSON = agentToolsToJSON; - exports.agentToolsFromJSON = agentToolsFromJSON; - exports.agentToJSON = agentToJSON; - exports.agentFromJSON = agentFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentObject = { - Agent: "agent" - }; - exports.AgentTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentTools$; - (function(AgentTools$2) { - AgentTools$2.inboundSchema = exports.AgentTools$inboundSchema; - AgentTools$2.outboundSchema = exports.AgentTools$outboundSchema; - })(AgentTools$ || (exports.AgentTools$ = AgentTools$ = {})); - function agentToolsToJSON(agentTools) { - return JSON.stringify(exports.AgentTools$outboundSchema.parse(agentTools)); - } - function agentToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentTools' from JSON`); - } - exports.AgentObject$inboundSchema = z.nativeEnum(exports.AgentObject); - exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema; - var AgentObject$; - (function(AgentObject$2) { - AgentObject$2.inboundSchema = exports.AgentObject$inboundSchema; - AgentObject$2.outboundSchema = exports.AgentObject$outboundSchema; - })(AgentObject$ || (exports.AgentObject$ = AgentObject$ = {})); - exports.Agent$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$inboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.Agent$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$outboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var Agent$; - (function(Agent$2) { - Agent$2.inboundSchema = exports.Agent$inboundSchema; - Agent$2.outboundSchema = exports.Agent$outboundSchema; - })(Agent$ || (exports.Agent$ = Agent$ = {})); - function agentToJSON(agent) { - return JSON.stringify(exports.Agent$outboundSchema.parse(agent)); - } - function agentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Agent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Agent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentconversation.js - var require_agentconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentConversation$ = exports.AgentConversation$outboundSchema = exports.AgentConversation$inboundSchema = exports.AgentConversationObject$ = exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema = exports.AgentConversationObject = void 0; - exports.agentConversationToJSON = agentConversationToJSON; - exports.agentConversationFromJSON = agentConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentConversationObject = { - Conversation: "conversation" - }; - exports.AgentConversationObject$inboundSchema = z.nativeEnum(exports.AgentConversationObject); - exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema; - var AgentConversationObject$; - (function(AgentConversationObject$2) { - AgentConversationObject$2.inboundSchema = exports.AgentConversationObject$inboundSchema; - AgentConversationObject$2.outboundSchema = exports.AgentConversationObject$outboundSchema; - })(AgentConversationObject$ || (exports.AgentConversationObject$ = AgentConversationObject$ = {})); - exports.AgentConversation$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "agent_id": "agentId" - }); - }); - exports.AgentConversation$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - agentId: "agent_id" - }); - }); - var AgentConversation$; - (function(AgentConversation$2) { - AgentConversation$2.inboundSchema = exports.AgentConversation$inboundSchema; - AgentConversation$2.outboundSchema = exports.AgentConversation$outboundSchema; - })(AgentConversation$ || (exports.AgentConversation$ = AgentConversation$ = {})); - function agentConversationToJSON(agentConversation) { - return JSON.stringify(exports.AgentConversation$outboundSchema.parse(agentConversation)); - } - function agentConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js - var require_agentcreationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentCreationRequest$ = exports.AgentCreationRequest$outboundSchema = exports.AgentCreationRequest$inboundSchema = exports.AgentCreationRequestTools$ = exports.AgentCreationRequestTools$outboundSchema = exports.AgentCreationRequestTools$inboundSchema = void 0; - exports.agentCreationRequestToolsToJSON = agentCreationRequestToolsToJSON; - exports.agentCreationRequestToolsFromJSON = agentCreationRequestToolsFromJSON; - exports.agentCreationRequestToJSON = agentCreationRequestToJSON; - exports.agentCreationRequestFromJSON = agentCreationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentCreationRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentCreationRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentCreationRequestTools$; - (function(AgentCreationRequestTools$2) { - AgentCreationRequestTools$2.inboundSchema = exports.AgentCreationRequestTools$inboundSchema; - AgentCreationRequestTools$2.outboundSchema = exports.AgentCreationRequestTools$outboundSchema; - })(AgentCreationRequestTools$ || (exports.AgentCreationRequestTools$ = AgentCreationRequestTools$ = {})); - function agentCreationRequestToolsToJSON(agentCreationRequestTools) { - return JSON.stringify(exports.AgentCreationRequestTools$outboundSchema.parse(agentCreationRequestTools)); - } - function agentCreationRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequestTools' from JSON`); - } - exports.AgentCreationRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentCreationRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentCreationRequest$; - (function(AgentCreationRequest$2) { - AgentCreationRequest$2.inboundSchema = exports.AgentCreationRequest$inboundSchema; - AgentCreationRequest$2.outboundSchema = exports.AgentCreationRequest$outboundSchema; - })(AgentCreationRequest$ || (exports.AgentCreationRequest$ = AgentCreationRequest$ = {})); - function agentCreationRequestToJSON(agentCreationRequest) { - return JSON.stringify(exports.AgentCreationRequest$outboundSchema.parse(agentCreationRequest)); - } - function agentCreationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js - var require_agenthandoffdoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffDoneEvent$ = exports.AgentHandoffDoneEvent$outboundSchema = exports.AgentHandoffDoneEvent$inboundSchema = exports.AgentHandoffDoneEventType$ = exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema = exports.AgentHandoffDoneEventType = void 0; - exports.agentHandoffDoneEventToJSON = agentHandoffDoneEventToJSON; - exports.agentHandoffDoneEventFromJSON = agentHandoffDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffDoneEventType = { - AgentHandoffDone: "agent.handoff.done" - }; - exports.AgentHandoffDoneEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffDoneEventType); - exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - var AgentHandoffDoneEventType$; - (function(AgentHandoffDoneEventType$2) { - AgentHandoffDoneEventType$2.inboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - AgentHandoffDoneEventType$2.outboundSchema = exports.AgentHandoffDoneEventType$outboundSchema; - })(AgentHandoffDoneEventType$ || (exports.AgentHandoffDoneEventType$ = AgentHandoffDoneEventType$ = {})); - exports.AgentHandoffDoneEvent$inboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$inboundSchema.default("agent.handoff.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffDoneEvent$outboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$outboundSchema.default("agent.handoff.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffDoneEvent$; - (function(AgentHandoffDoneEvent$2) { - AgentHandoffDoneEvent$2.inboundSchema = exports.AgentHandoffDoneEvent$inboundSchema; - AgentHandoffDoneEvent$2.outboundSchema = exports.AgentHandoffDoneEvent$outboundSchema; - })(AgentHandoffDoneEvent$ || (exports.AgentHandoffDoneEvent$ = AgentHandoffDoneEvent$ = {})); - function agentHandoffDoneEventToJSON(agentHandoffDoneEvent) { - return JSON.stringify(exports.AgentHandoffDoneEvent$outboundSchema.parse(agentHandoffDoneEvent)); - } - function agentHandoffDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js - var require_agenthandoffentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffEntry$ = exports.AgentHandoffEntry$outboundSchema = exports.AgentHandoffEntry$inboundSchema = exports.AgentHandoffEntryType$ = exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema = exports.AgentHandoffEntryObject$ = exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema = exports.AgentHandoffEntryType = exports.AgentHandoffEntryObject = void 0; - exports.agentHandoffEntryToJSON = agentHandoffEntryToJSON; - exports.agentHandoffEntryFromJSON = agentHandoffEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffEntryObject = { - Entry: "entry" - }; - exports.AgentHandoffEntryType = { - AgentHandoff: "agent.handoff" - }; - exports.AgentHandoffEntryObject$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryObject); - exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - var AgentHandoffEntryObject$; - (function(AgentHandoffEntryObject$2) { - AgentHandoffEntryObject$2.inboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - AgentHandoffEntryObject$2.outboundSchema = exports.AgentHandoffEntryObject$outboundSchema; - })(AgentHandoffEntryObject$ || (exports.AgentHandoffEntryObject$ = AgentHandoffEntryObject$ = {})); - exports.AgentHandoffEntryType$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryType); - exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema; - var AgentHandoffEntryType$; - (function(AgentHandoffEntryType$2) { - AgentHandoffEntryType$2.inboundSchema = exports.AgentHandoffEntryType$inboundSchema; - AgentHandoffEntryType$2.outboundSchema = exports.AgentHandoffEntryType$outboundSchema; - })(AgentHandoffEntryType$ || (exports.AgentHandoffEntryType$ = AgentHandoffEntryType$ = {})); - exports.AgentHandoffEntry$inboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$inboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$inboundSchema.default("agent.handoff"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - previous_agent_id: z.string(), - previous_agent_name: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffEntry$outboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$outboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$outboundSchema.default("agent.handoff"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - previousAgentId: z.string(), - previousAgentName: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffEntry$; - (function(AgentHandoffEntry$2) { - AgentHandoffEntry$2.inboundSchema = exports.AgentHandoffEntry$inboundSchema; - AgentHandoffEntry$2.outboundSchema = exports.AgentHandoffEntry$outboundSchema; - })(AgentHandoffEntry$ || (exports.AgentHandoffEntry$ = AgentHandoffEntry$ = {})); - function agentHandoffEntryToJSON(agentHandoffEntry) { - return JSON.stringify(exports.AgentHandoffEntry$outboundSchema.parse(agentHandoffEntry)); - } - function agentHandoffEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js - var require_agenthandoffstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffStartedEvent$ = exports.AgentHandoffStartedEvent$outboundSchema = exports.AgentHandoffStartedEvent$inboundSchema = exports.AgentHandoffStartedEventType$ = exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema = exports.AgentHandoffStartedEventType = void 0; - exports.agentHandoffStartedEventToJSON = agentHandoffStartedEventToJSON; - exports.agentHandoffStartedEventFromJSON = agentHandoffStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffStartedEventType = { - AgentHandoffStarted: "agent.handoff.started" - }; - exports.AgentHandoffStartedEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffStartedEventType); - exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - var AgentHandoffStartedEventType$; - (function(AgentHandoffStartedEventType$2) { - AgentHandoffStartedEventType$2.inboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - AgentHandoffStartedEventType$2.outboundSchema = exports.AgentHandoffStartedEventType$outboundSchema; - })(AgentHandoffStartedEventType$ || (exports.AgentHandoffStartedEventType$ = AgentHandoffStartedEventType$ = {})); - exports.AgentHandoffStartedEvent$inboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$inboundSchema.default("agent.handoff.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - previous_agent_id: z.string(), - previous_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName" - }); - }); - exports.AgentHandoffStartedEvent$outboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$outboundSchema.default("agent.handoff.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - previousAgentId: z.string(), - previousAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name" - }); - }); - var AgentHandoffStartedEvent$; - (function(AgentHandoffStartedEvent$2) { - AgentHandoffStartedEvent$2.inboundSchema = exports.AgentHandoffStartedEvent$inboundSchema; - AgentHandoffStartedEvent$2.outboundSchema = exports.AgentHandoffStartedEvent$outboundSchema; - })(AgentHandoffStartedEvent$ || (exports.AgentHandoffStartedEvent$ = AgentHandoffStartedEvent$ = {})); - function agentHandoffStartedEventToJSON(agentHandoffStartedEvent) { - return JSON.stringify(exports.AgentHandoffStartedEvent$outboundSchema.parse(agentHandoffStartedEvent)); - } - function agentHandoffStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiochunk.js - var require_audiochunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiochunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioChunk$ = exports.AudioChunk$outboundSchema = exports.AudioChunk$inboundSchema = exports.AudioChunkType$ = exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema = exports.AudioChunkType = void 0; - exports.audioChunkToJSON = audioChunkToJSON; - exports.audioChunkFromJSON = audioChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AudioChunkType = { - InputAudio: "input_audio" - }; - exports.AudioChunkType$inboundSchema = z.nativeEnum(exports.AudioChunkType); - exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema; - var AudioChunkType$; - (function(AudioChunkType$2) { - AudioChunkType$2.inboundSchema = exports.AudioChunkType$inboundSchema; - AudioChunkType$2.outboundSchema = exports.AudioChunkType$outboundSchema; - })(AudioChunkType$ || (exports.AudioChunkType$ = AudioChunkType$ = {})); - exports.AudioChunk$inboundSchema = z.object({ - input_audio: z.string(), - type: exports.AudioChunkType$inboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_audio": "inputAudio" - }); - }); - exports.AudioChunk$outboundSchema = z.object({ - inputAudio: z.string(), - type: exports.AudioChunkType$outboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputAudio: "input_audio" - }); - }); - var AudioChunk$; - (function(AudioChunk$2) { - AudioChunk$2.inboundSchema = exports.AudioChunk$inboundSchema; - AudioChunk$2.outboundSchema = exports.AudioChunk$outboundSchema; - })(AudioChunk$ || (exports.AudioChunk$ = AudioChunk$ = {})); - function audioChunkToJSON(audioChunk) { - return JSON.stringify(exports.AudioChunk$outboundSchema.parse(audioChunk)); - } - function audioChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenturlchunk.js - var require_documenturlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenturlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentURLChunk$ = exports.DocumentURLChunk$outboundSchema = exports.DocumentURLChunk$inboundSchema = exports.DocumentURLChunkType$ = exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema = exports.DocumentURLChunkType = void 0; - exports.documentURLChunkToJSON = documentURLChunkToJSON; - exports.documentURLChunkFromJSON = documentURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentURLChunkType = { - DocumentUrl: "document_url" - }; - exports.DocumentURLChunkType$inboundSchema = z.nativeEnum(exports.DocumentURLChunkType); - exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema; - var DocumentURLChunkType$; - (function(DocumentURLChunkType$2) { - DocumentURLChunkType$2.inboundSchema = exports.DocumentURLChunkType$inboundSchema; - DocumentURLChunkType$2.outboundSchema = exports.DocumentURLChunkType$outboundSchema; - })(DocumentURLChunkType$ || (exports.DocumentURLChunkType$ = DocumentURLChunkType$ = {})); - exports.DocumentURLChunk$inboundSchema = z.object({ - document_url: z.string(), - document_name: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$inboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_url": "documentUrl", - "document_name": "documentName" - }); - }); - exports.DocumentURLChunk$outboundSchema = z.object({ - documentUrl: z.string(), - documentName: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$outboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentUrl: "document_url", - documentName: "document_name" - }); - }); - var DocumentURLChunk$; - (function(DocumentURLChunk$2) { - DocumentURLChunk$2.inboundSchema = exports.DocumentURLChunk$inboundSchema; - DocumentURLChunk$2.outboundSchema = exports.DocumentURLChunk$outboundSchema; - })(DocumentURLChunk$ || (exports.DocumentURLChunk$ = DocumentURLChunk$ = {})); - function documentURLChunkToJSON(documentURLChunk) { - return JSON.stringify(exports.DocumentURLChunk$outboundSchema.parse(documentURLChunk)); - } - function documentURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filechunk.js - var require_filechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileChunk$ = exports.FileChunk$outboundSchema = exports.FileChunk$inboundSchema = void 0; - exports.fileChunkToJSON = fileChunkToJSON; - exports.fileChunkFromJSON = fileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FileChunk$inboundSchema = z.object({ - type: z.literal("file").default("file"), - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FileChunk$outboundSchema = z.object({ - type: z.literal("file").default("file"), - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FileChunk$; - (function(FileChunk$2) { - FileChunk$2.inboundSchema = exports.FileChunk$inboundSchema; - FileChunk$2.outboundSchema = exports.FileChunk$outboundSchema; - })(FileChunk$ || (exports.FileChunk$ = FileChunk$ = {})); - function fileChunkToJSON(fileChunk) { - return JSON.stringify(exports.FileChunk$outboundSchema.parse(fileChunk)); - } - function fileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurl.js - var require_imageurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURL$ = exports.ImageURL$outboundSchema = exports.ImageURL$inboundSchema = void 0; - exports.imageURLToJSON = imageURLToJSON; - exports.imageURLFromJSON = imageURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageURL$inboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - exports.ImageURL$outboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - var ImageURL$; - (function(ImageURL$2) { - ImageURL$2.inboundSchema = exports.ImageURL$inboundSchema; - ImageURL$2.outboundSchema = exports.ImageURL$outboundSchema; - })(ImageURL$ || (exports.ImageURL$ = ImageURL$ = {})); - function imageURLToJSON(imageURL) { - return JSON.stringify(exports.ImageURL$outboundSchema.parse(imageURL)); - } - function imageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurlchunk.js - var require_imageurlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURLChunk$ = exports.ImageURLChunk$outboundSchema = exports.ImageURLChunk$inboundSchema = exports.ImageURLChunkType$ = exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema = exports.ImageURLChunkImageURL$ = exports.ImageURLChunkImageURL$outboundSchema = exports.ImageURLChunkImageURL$inboundSchema = exports.ImageURLChunkType = void 0; - exports.imageURLChunkImageURLToJSON = imageURLChunkImageURLToJSON; - exports.imageURLChunkImageURLFromJSON = imageURLChunkImageURLFromJSON; - exports.imageURLChunkToJSON = imageURLChunkToJSON; - exports.imageURLChunkFromJSON = imageURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var imageurl_js_1 = require_imageurl(); - exports.ImageURLChunkType = { - ImageUrl: "image_url" - }; - exports.ImageURLChunkImageURL$inboundSchema = z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]); - exports.ImageURLChunkImageURL$outboundSchema = z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]); - var ImageURLChunkImageURL$; - (function(ImageURLChunkImageURL$2) { - ImageURLChunkImageURL$2.inboundSchema = exports.ImageURLChunkImageURL$inboundSchema; - ImageURLChunkImageURL$2.outboundSchema = exports.ImageURLChunkImageURL$outboundSchema; - })(ImageURLChunkImageURL$ || (exports.ImageURLChunkImageURL$ = ImageURLChunkImageURL$ = {})); - function imageURLChunkImageURLToJSON(imageURLChunkImageURL) { - return JSON.stringify(exports.ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL)); - } - function imageURLChunkImageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunkImageURL' from JSON`); - } - exports.ImageURLChunkType$inboundSchema = z.nativeEnum(exports.ImageURLChunkType); - exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema; - var ImageURLChunkType$; - (function(ImageURLChunkType$2) { - ImageURLChunkType$2.inboundSchema = exports.ImageURLChunkType$inboundSchema; - ImageURLChunkType$2.outboundSchema = exports.ImageURLChunkType$outboundSchema; - })(ImageURLChunkType$ || (exports.ImageURLChunkType$ = ImageURLChunkType$ = {})); - exports.ImageURLChunk$inboundSchema = z.object({ - image_url: z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]), - type: exports.ImageURLChunkType$inboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "image_url": "imageUrl" - }); - }); - exports.ImageURLChunk$outboundSchema = z.object({ - imageUrl: z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]), - type: exports.ImageURLChunkType$outboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - imageUrl: "image_url" - }); - }); - var ImageURLChunk$; - (function(ImageURLChunk$2) { - ImageURLChunk$2.inboundSchema = exports.ImageURLChunk$inboundSchema; - ImageURLChunk$2.outboundSchema = exports.ImageURLChunk$outboundSchema; - })(ImageURLChunk$ || (exports.ImageURLChunk$ = ImageURLChunk$ = {})); - function imageURLChunkToJSON(imageURLChunk) { - return JSON.stringify(exports.ImageURLChunk$outboundSchema.parse(imageURLChunk)); - } - function imageURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/referencechunk.js - var require_referencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/referencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ReferenceChunk$ = exports.ReferenceChunk$outboundSchema = exports.ReferenceChunk$inboundSchema = exports.ReferenceChunkType$ = exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema = exports.ReferenceChunkType = void 0; - exports.referenceChunkToJSON = referenceChunkToJSON; - exports.referenceChunkFromJSON = referenceChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ReferenceChunkType = { - Reference: "reference" - }; - exports.ReferenceChunkType$inboundSchema = z.nativeEnum(exports.ReferenceChunkType); - exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema; - var ReferenceChunkType$; - (function(ReferenceChunkType$2) { - ReferenceChunkType$2.inboundSchema = exports.ReferenceChunkType$inboundSchema; - ReferenceChunkType$2.outboundSchema = exports.ReferenceChunkType$outboundSchema; - })(ReferenceChunkType$ || (exports.ReferenceChunkType$ = ReferenceChunkType$ = {})); - exports.ReferenceChunk$inboundSchema = z.object({ - reference_ids: z.array(z.number().int()), - type: exports.ReferenceChunkType$inboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "reference_ids": "referenceIds" - }); - }); - exports.ReferenceChunk$outboundSchema = z.object({ - referenceIds: z.array(z.number().int()), - type: exports.ReferenceChunkType$outboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - referenceIds: "reference_ids" - }); - }); - var ReferenceChunk$; - (function(ReferenceChunk$2) { - ReferenceChunk$2.inboundSchema = exports.ReferenceChunk$inboundSchema; - ReferenceChunk$2.outboundSchema = exports.ReferenceChunk$outboundSchema; - })(ReferenceChunk$ || (exports.ReferenceChunk$ = ReferenceChunk$ = {})); - function referenceChunkToJSON(referenceChunk) { - return JSON.stringify(exports.ReferenceChunk$outboundSchema.parse(referenceChunk)); - } - function referenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/textchunk.js - var require_textchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/textchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TextChunk$ = exports.TextChunk$outboundSchema = exports.TextChunk$inboundSchema = exports.TextChunkType$ = exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema = exports.TextChunkType = void 0; - exports.textChunkToJSON = textChunkToJSON; - exports.textChunkFromJSON = textChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.TextChunkType = { - Text: "text" - }; - exports.TextChunkType$inboundSchema = z.nativeEnum(exports.TextChunkType); - exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema; - var TextChunkType$; - (function(TextChunkType$2) { - TextChunkType$2.inboundSchema = exports.TextChunkType$inboundSchema; - TextChunkType$2.outboundSchema = exports.TextChunkType$outboundSchema; - })(TextChunkType$ || (exports.TextChunkType$ = TextChunkType$ = {})); - exports.TextChunk$inboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$inboundSchema.default("text") - }); - exports.TextChunk$outboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$outboundSchema.default("text") - }); - var TextChunk$; - (function(TextChunk$2) { - TextChunk$2.inboundSchema = exports.TextChunk$inboundSchema; - TextChunk$2.outboundSchema = exports.TextChunk$outboundSchema; - })(TextChunk$ || (exports.TextChunk$ = TextChunk$ = {})); - function textChunkToJSON(textChunk) { - return JSON.stringify(exports.TextChunk$outboundSchema.parse(textChunk)); - } - function textChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TextChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TextChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/thinkchunk.js - var require_thinkchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/thinkchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ThinkChunk$ = exports.ThinkChunk$outboundSchema = exports.ThinkChunk$inboundSchema = exports.ThinkChunkType$ = exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema = exports.Thinking$ = exports.Thinking$outboundSchema = exports.Thinking$inboundSchema = exports.ThinkChunkType = void 0; - exports.thinkingToJSON = thinkingToJSON; - exports.thinkingFromJSON = thinkingFromJSON; - exports.thinkChunkToJSON = thinkChunkToJSON; - exports.thinkChunkFromJSON = thinkChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - exports.ThinkChunkType = { - Thinking: "thinking" - }; - exports.Thinking$inboundSchema = z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema]); - exports.Thinking$outboundSchema = z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema]); - var Thinking$; - (function(Thinking$2) { - Thinking$2.inboundSchema = exports.Thinking$inboundSchema; - Thinking$2.outboundSchema = exports.Thinking$outboundSchema; - })(Thinking$ || (exports.Thinking$ = Thinking$ = {})); - function thinkingToJSON(thinking) { - return JSON.stringify(exports.Thinking$outboundSchema.parse(thinking)); - } - function thinkingFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Thinking$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Thinking' from JSON`); - } - exports.ThinkChunkType$inboundSchema = z.nativeEnum(exports.ThinkChunkType); - exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema; - var ThinkChunkType$; - (function(ThinkChunkType$2) { - ThinkChunkType$2.inboundSchema = exports.ThinkChunkType$inboundSchema; - ThinkChunkType$2.outboundSchema = exports.ThinkChunkType$outboundSchema; - })(ThinkChunkType$ || (exports.ThinkChunkType$ = ThinkChunkType$ = {})); - exports.ThinkChunk$inboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$inboundSchema.default("thinking") - }); - exports.ThinkChunk$outboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$outboundSchema.default("thinking") - }); - var ThinkChunk$; - (function(ThinkChunk$2) { - ThinkChunk$2.inboundSchema = exports.ThinkChunk$inboundSchema; - ThinkChunk$2.outboundSchema = exports.ThinkChunk$outboundSchema; - })(ThinkChunk$ || (exports.ThinkChunk$ = ThinkChunk$ = {})); - function thinkChunkToJSON(thinkChunk) { - return JSON.stringify(exports.ThinkChunk$outboundSchema.parse(thinkChunk)); - } - function thinkChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ThinkChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ThinkChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/contentchunk.js - var require_contentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/contentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ContentChunk$ = exports.ContentChunk$outboundSchema = exports.ContentChunk$inboundSchema = void 0; - exports.contentChunkToJSON = contentChunkToJSON; - exports.contentChunkFromJSON = contentChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var audiochunk_js_1 = require_audiochunk(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.ContentChunk$inboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$inboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$inboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$inboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$inboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$inboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ContentChunk$outboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$outboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$outboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$outboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$outboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$outboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - var ContentChunk$; - (function(ContentChunk$2) { - ContentChunk$2.inboundSchema = exports.ContentChunk$inboundSchema; - ContentChunk$2.outboundSchema = exports.ContentChunk$outboundSchema; - })(ContentChunk$ || (exports.ContentChunk$ = ContentChunk$ = {})); - function contentChunkToJSON(contentChunk) { - return JSON.stringify(exports.ContentChunk$outboundSchema.parse(contentChunk)); - } - function contentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ContentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ContentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncall.js - var require_functioncall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCall$ = exports.FunctionCall$outboundSchema = exports.FunctionCall$inboundSchema = exports.Arguments$ = exports.Arguments$outboundSchema = exports.Arguments$inboundSchema = void 0; - exports.argumentsToJSON = argumentsToJSON; - exports.argumentsFromJSON = argumentsFromJSON; - exports.functionCallToJSON = functionCallToJSON; - exports.functionCallFromJSON = functionCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Arguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.Arguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var Arguments$; - (function(Arguments$2) { - Arguments$2.inboundSchema = exports.Arguments$inboundSchema; - Arguments$2.outboundSchema = exports.Arguments$outboundSchema; - })(Arguments$ || (exports.Arguments$ = Arguments$ = {})); - function argumentsToJSON(value) { - return JSON.stringify(exports.Arguments$outboundSchema.parse(value)); - } - function argumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Arguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Arguments' from JSON`); - } - exports.FunctionCall$inboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - exports.FunctionCall$outboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - var FunctionCall$; - (function(FunctionCall$2) { - FunctionCall$2.inboundSchema = exports.FunctionCall$inboundSchema; - FunctionCall$2.outboundSchema = exports.FunctionCall$outboundSchema; - })(FunctionCall$ || (exports.FunctionCall$ = FunctionCall$ = {})); - function functionCallToJSON(functionCall) { - return JSON.stringify(exports.FunctionCall$outboundSchema.parse(functionCall)); - } - function functionCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/enums.js - var require_enums = __commonJS({ - "node_modules/@mistralai/mistralai/types/enums.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.catchUnrecognizedEnum = catchUnrecognizedEnum; - function catchUnrecognizedEnum(value) { - return value; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tooltypes.js - var require_tooltypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tooltypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolTypes$ = exports.ToolTypes$outboundSchema = exports.ToolTypes$inboundSchema = exports.ToolTypes = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ToolTypes = { - Function: "function" - }; - exports.ToolTypes$inboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ToolTypes$outboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().and(z.custom()) - ]); - var ToolTypes$; - (function(ToolTypes$2) { - ToolTypes$2.inboundSchema = exports.ToolTypes$inboundSchema; - ToolTypes$2.outboundSchema = exports.ToolTypes$outboundSchema; - })(ToolTypes$ || (exports.ToolTypes$ = ToolTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolcall.js - var require_toolcall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolcall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolCall$ = exports.ToolCall$outboundSchema = exports.ToolCall$inboundSchema = void 0; - exports.toolCallToJSON = toolCallToJSON; - exports.toolCallFromJSON = toolCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functioncall_js_1 = require_functioncall(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolCall$inboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functioncall_js_1.FunctionCall$inboundSchema, - index: z.number().int().default(0) - }); - exports.ToolCall$outboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functioncall_js_1.FunctionCall$outboundSchema, - index: z.number().int().default(0) - }); - var ToolCall$; - (function(ToolCall$2) { - ToolCall$2.inboundSchema = exports.ToolCall$inboundSchema; - ToolCall$2.outboundSchema = exports.ToolCall$outboundSchema; - })(ToolCall$ || (exports.ToolCall$ = ToolCall$ = {})); - function toolCallToJSON(toolCall) { - return JSON.stringify(exports.ToolCall$outboundSchema.parse(toolCall)); - } - function toolCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/assistantmessage.js - var require_assistantmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/assistantmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AssistantMessage$ = exports.AssistantMessage$outboundSchema = exports.AssistantMessage$inboundSchema = exports.AssistantMessageRole$ = exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema = exports.AssistantMessageContent$ = exports.AssistantMessageContent$outboundSchema = exports.AssistantMessageContent$inboundSchema = exports.AssistantMessageRole = void 0; - exports.assistantMessageContentToJSON = assistantMessageContentToJSON; - exports.assistantMessageContentFromJSON = assistantMessageContentFromJSON; - exports.assistantMessageToJSON = assistantMessageToJSON; - exports.assistantMessageFromJSON = assistantMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.AssistantMessageRole = { - Assistant: "assistant" - }; - exports.AssistantMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.AssistantMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var AssistantMessageContent$; - (function(AssistantMessageContent$2) { - AssistantMessageContent$2.inboundSchema = exports.AssistantMessageContent$inboundSchema; - AssistantMessageContent$2.outboundSchema = exports.AssistantMessageContent$outboundSchema; - })(AssistantMessageContent$ || (exports.AssistantMessageContent$ = AssistantMessageContent$ = {})); - function assistantMessageContentToJSON(assistantMessageContent) { - return JSON.stringify(exports.AssistantMessageContent$outboundSchema.parse(assistantMessageContent)); - } - function assistantMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessageContent' from JSON`); - } - exports.AssistantMessageRole$inboundSchema = z.nativeEnum(exports.AssistantMessageRole); - exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema; - var AssistantMessageRole$; - (function(AssistantMessageRole$2) { - AssistantMessageRole$2.inboundSchema = exports.AssistantMessageRole$inboundSchema; - AssistantMessageRole$2.outboundSchema = exports.AssistantMessageRole$outboundSchema; - })(AssistantMessageRole$ || (exports.AssistantMessageRole$ = AssistantMessageRole$ = {})); - exports.AssistantMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$inboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.AssistantMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$outboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var AssistantMessage$; - (function(AssistantMessage$2) { - AssistantMessage$2.inboundSchema = exports.AssistantMessage$inboundSchema; - AssistantMessage$2.outboundSchema = exports.AssistantMessage$outboundSchema; - })(AssistantMessage$ || (exports.AssistantMessage$ = AssistantMessage$ = {})); - function assistantMessageToJSON(assistantMessage) { - return JSON.stringify(exports.AssistantMessage$outboundSchema.parse(assistantMessage)); - } - function assistantMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js - var require_mistralpromptmode = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralPromptMode$ = exports.MistralPromptMode$outboundSchema = exports.MistralPromptMode$inboundSchema = exports.MistralPromptMode = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.MistralPromptMode = { - Reasoning: "reasoning" - }; - exports.MistralPromptMode$inboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.MistralPromptMode$outboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().and(z.custom()) - ]); - var MistralPromptMode$; - (function(MistralPromptMode$2) { - MistralPromptMode$2.inboundSchema = exports.MistralPromptMode$inboundSchema; - MistralPromptMode$2.outboundSchema = exports.MistralPromptMode$outboundSchema; - })(MistralPromptMode$ || (exports.MistralPromptMode$ = MistralPromptMode$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js - var require_systemmessagecontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessageContentChunks$ = exports.SystemMessageContentChunks$outboundSchema = exports.SystemMessageContentChunks$inboundSchema = void 0; - exports.systemMessageContentChunksToJSON = systemMessageContentChunksToJSON; - exports.systemMessageContentChunksFromJSON = systemMessageContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.SystemMessageContentChunks$inboundSchema = z.union([ - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.SystemMessageContentChunks$outboundSchema = z.union([ - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - var SystemMessageContentChunks$; - (function(SystemMessageContentChunks$2) { - SystemMessageContentChunks$2.inboundSchema = exports.SystemMessageContentChunks$inboundSchema; - SystemMessageContentChunks$2.outboundSchema = exports.SystemMessageContentChunks$outboundSchema; - })(SystemMessageContentChunks$ || (exports.SystemMessageContentChunks$ = SystemMessageContentChunks$ = {})); - function systemMessageContentChunksToJSON(systemMessageContentChunks) { - return JSON.stringify(exports.SystemMessageContentChunks$outboundSchema.parse(systemMessageContentChunks)); - } - function systemMessageContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessage.js - var require_systemmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessage$ = exports.SystemMessage$outboundSchema = exports.SystemMessage$inboundSchema = exports.Role$ = exports.Role$outboundSchema = exports.Role$inboundSchema = exports.SystemMessageContent$ = exports.SystemMessageContent$outboundSchema = exports.SystemMessageContent$inboundSchema = exports.Role = void 0; - exports.systemMessageContentToJSON = systemMessageContentToJSON; - exports.systemMessageContentFromJSON = systemMessageContentFromJSON; - exports.systemMessageToJSON = systemMessageToJSON; - exports.systemMessageFromJSON = systemMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var systemmessagecontentchunks_js_1 = require_systemmessagecontentchunks(); - exports.Role = { - System: "system" - }; - exports.SystemMessageContent$inboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema)]); - exports.SystemMessageContent$outboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema)]); - var SystemMessageContent$; - (function(SystemMessageContent$2) { - SystemMessageContent$2.inboundSchema = exports.SystemMessageContent$inboundSchema; - SystemMessageContent$2.outboundSchema = exports.SystemMessageContent$outboundSchema; - })(SystemMessageContent$ || (exports.SystemMessageContent$ = SystemMessageContent$ = {})); - function systemMessageContentToJSON(systemMessageContent) { - return JSON.stringify(exports.SystemMessageContent$outboundSchema.parse(systemMessageContent)); - } - function systemMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContent' from JSON`); - } - exports.Role$inboundSchema = z.nativeEnum(exports.Role); - exports.Role$outboundSchema = exports.Role$inboundSchema; - var Role$; - (function(Role$2) { - Role$2.inboundSchema = exports.Role$inboundSchema; - Role$2.outboundSchema = exports.Role$outboundSchema; - })(Role$ || (exports.Role$ = Role$ = {})); - exports.SystemMessage$inboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema) - ]), - role: exports.Role$inboundSchema.default("system") - }); - exports.SystemMessage$outboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema) - ]), - role: exports.Role$outboundSchema.default("system") - }); - var SystemMessage$; - (function(SystemMessage$2) { - SystemMessage$2.inboundSchema = exports.SystemMessage$inboundSchema; - SystemMessage$2.outboundSchema = exports.SystemMessage$outboundSchema; - })(SystemMessage$ || (exports.SystemMessage$ = SystemMessage$ = {})); - function systemMessageToJSON(systemMessage) { - return JSON.stringify(exports.SystemMessage$outboundSchema.parse(systemMessage)); - } - function systemMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tool.js - var require_tool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Tool$ = exports.Tool$outboundSchema = exports.Tool$inboundSchema = void 0; - exports.toolToJSON = toolToJSON; - exports.toolFromJSON = toolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - var tooltypes_js_1 = require_tooltypes(); - exports.Tool$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: function_js_1.FunctionT$inboundSchema - }); - exports.Tool$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: function_js_1.FunctionT$outboundSchema - }); - var Tool$; - (function(Tool$2) { - Tool$2.inboundSchema = exports.Tool$inboundSchema; - Tool$2.outboundSchema = exports.Tool$outboundSchema; - })(Tool$ || (exports.Tool$ = Tool$ = {})); - function toolToJSON(tool) { - return JSON.stringify(exports.Tool$outboundSchema.parse(tool)); - } - function toolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionname.js - var require_functionname = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionname.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionName$ = exports.FunctionName$outboundSchema = exports.FunctionName$inboundSchema = void 0; - exports.functionNameToJSON = functionNameToJSON; - exports.functionNameFromJSON = functionNameFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionName$inboundSchema = z.object({ - name: z.string() - }); - exports.FunctionName$outboundSchema = z.object({ - name: z.string() - }); - var FunctionName$; - (function(FunctionName$2) { - FunctionName$2.inboundSchema = exports.FunctionName$inboundSchema; - FunctionName$2.outboundSchema = exports.FunctionName$outboundSchema; - })(FunctionName$ || (exports.FunctionName$ = FunctionName$ = {})); - function functionNameToJSON(functionName) { - return JSON.stringify(exports.FunctionName$outboundSchema.parse(functionName)); - } - function functionNameFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionName$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionName' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoice.js - var require_toolchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoice$ = exports.ToolChoice$outboundSchema = exports.ToolChoice$inboundSchema = void 0; - exports.toolChoiceToJSON = toolChoiceToJSON; - exports.toolChoiceFromJSON = toolChoiceFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functionname_js_1 = require_functionname(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolChoice$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functionname_js_1.FunctionName$inboundSchema - }); - exports.ToolChoice$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functionname_js_1.FunctionName$outboundSchema - }); - var ToolChoice$; - (function(ToolChoice$2) { - ToolChoice$2.inboundSchema = exports.ToolChoice$inboundSchema; - ToolChoice$2.outboundSchema = exports.ToolChoice$outboundSchema; - })(ToolChoice$ || (exports.ToolChoice$ = ToolChoice$ = {})); - function toolChoiceToJSON(toolChoice) { - return JSON.stringify(exports.ToolChoice$outboundSchema.parse(toolChoice)); - } - function toolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolmessage.js - var require_toolmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolMessage$ = exports.ToolMessage$outboundSchema = exports.ToolMessage$inboundSchema = exports.ToolMessageRole$ = exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema = exports.ToolMessageContent$ = exports.ToolMessageContent$outboundSchema = exports.ToolMessageContent$inboundSchema = exports.ToolMessageRole = void 0; - exports.toolMessageContentToJSON = toolMessageContentToJSON; - exports.toolMessageContentFromJSON = toolMessageContentFromJSON; - exports.toolMessageToJSON = toolMessageToJSON; - exports.toolMessageFromJSON = toolMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.ToolMessageRole = { - Tool: "tool" - }; - exports.ToolMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.ToolMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var ToolMessageContent$; - (function(ToolMessageContent$2) { - ToolMessageContent$2.inboundSchema = exports.ToolMessageContent$inboundSchema; - ToolMessageContent$2.outboundSchema = exports.ToolMessageContent$outboundSchema; - })(ToolMessageContent$ || (exports.ToolMessageContent$ = ToolMessageContent$ = {})); - function toolMessageContentToJSON(toolMessageContent) { - return JSON.stringify(exports.ToolMessageContent$outboundSchema.parse(toolMessageContent)); - } - function toolMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessageContent' from JSON`); - } - exports.ToolMessageRole$inboundSchema = z.nativeEnum(exports.ToolMessageRole); - exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema; - var ToolMessageRole$; - (function(ToolMessageRole$2) { - ToolMessageRole$2.inboundSchema = exports.ToolMessageRole$inboundSchema; - ToolMessageRole$2.outboundSchema = exports.ToolMessageRole$outboundSchema; - })(ToolMessageRole$ || (exports.ToolMessageRole$ = ToolMessageRole$ = {})); - exports.ToolMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$inboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_call_id": "toolCallId" - }); - }); - exports.ToolMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$outboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCallId: "tool_call_id" - }); - }); - var ToolMessage$; - (function(ToolMessage$2) { - ToolMessage$2.inboundSchema = exports.ToolMessage$inboundSchema; - ToolMessage$2.outboundSchema = exports.ToolMessage$outboundSchema; - })(ToolMessage$ || (exports.ToolMessage$ = ToolMessage$ = {})); - function toolMessageToJSON(toolMessage) { - return JSON.stringify(exports.ToolMessage$outboundSchema.parse(toolMessage)); - } - function toolMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usermessage.js - var require_usermessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usermessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UserMessage$ = exports.UserMessage$outboundSchema = exports.UserMessage$inboundSchema = exports.UserMessageRole$ = exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema = exports.UserMessageContent$ = exports.UserMessageContent$outboundSchema = exports.UserMessageContent$inboundSchema = exports.UserMessageRole = void 0; - exports.userMessageContentToJSON = userMessageContentToJSON; - exports.userMessageContentFromJSON = userMessageContentFromJSON; - exports.userMessageToJSON = userMessageToJSON; - exports.userMessageFromJSON = userMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.UserMessageRole = { - User: "user" - }; - exports.UserMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.UserMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var UserMessageContent$; - (function(UserMessageContent$2) { - UserMessageContent$2.inboundSchema = exports.UserMessageContent$inboundSchema; - UserMessageContent$2.outboundSchema = exports.UserMessageContent$outboundSchema; - })(UserMessageContent$ || (exports.UserMessageContent$ = UserMessageContent$ = {})); - function userMessageContentToJSON(userMessageContent) { - return JSON.stringify(exports.UserMessageContent$outboundSchema.parse(userMessageContent)); - } - function userMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessageContent' from JSON`); - } - exports.UserMessageRole$inboundSchema = z.nativeEnum(exports.UserMessageRole); - exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema; - var UserMessageRole$; - (function(UserMessageRole$2) { - UserMessageRole$2.inboundSchema = exports.UserMessageRole$inboundSchema; - UserMessageRole$2.outboundSchema = exports.UserMessageRole$outboundSchema; - })(UserMessageRole$ || (exports.UserMessageRole$ = UserMessageRole$ = {})); - exports.UserMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - role: exports.UserMessageRole$inboundSchema.default("user") - }); - exports.UserMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - role: exports.UserMessageRole$outboundSchema.default("user") - }); - var UserMessage$; - (function(UserMessage$2) { - UserMessage$2.inboundSchema = exports.UserMessage$inboundSchema; - UserMessage$2.outboundSchema = exports.UserMessage$outboundSchema; - })(UserMessage$ || (exports.UserMessage$ = UserMessage$ = {})); - function userMessageToJSON(userMessage) { - return JSON.stringify(exports.UserMessage$outboundSchema.parse(userMessage)); - } - function userMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js - var require_agentscompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionRequest$ = exports.AgentsCompletionRequest$outboundSchema = exports.AgentsCompletionRequest$inboundSchema = exports.AgentsCompletionRequestToolChoice$ = exports.AgentsCompletionRequestToolChoice$outboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema = exports.AgentsCompletionRequestMessages$ = exports.AgentsCompletionRequestMessages$outboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema = exports.AgentsCompletionRequestStop$ = exports.AgentsCompletionRequestStop$outboundSchema = exports.AgentsCompletionRequestStop$inboundSchema = void 0; - exports.agentsCompletionRequestStopToJSON = agentsCompletionRequestStopToJSON; - exports.agentsCompletionRequestStopFromJSON = agentsCompletionRequestStopFromJSON; - exports.agentsCompletionRequestMessagesToJSON = agentsCompletionRequestMessagesToJSON; - exports.agentsCompletionRequestMessagesFromJSON = agentsCompletionRequestMessagesFromJSON; - exports.agentsCompletionRequestToolChoiceToJSON = agentsCompletionRequestToolChoiceToJSON; - exports.agentsCompletionRequestToolChoiceFromJSON = agentsCompletionRequestToolChoiceFromJSON; - exports.agentsCompletionRequestToJSON = agentsCompletionRequestToJSON; - exports.agentsCompletionRequestFromJSON = agentsCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionRequestStop$; - (function(AgentsCompletionRequestStop$2) { - AgentsCompletionRequestStop$2.inboundSchema = exports.AgentsCompletionRequestStop$inboundSchema; - AgentsCompletionRequestStop$2.outboundSchema = exports.AgentsCompletionRequestStop$outboundSchema; - })(AgentsCompletionRequestStop$ || (exports.AgentsCompletionRequestStop$ = AgentsCompletionRequestStop$ = {})); - function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop) { - return JSON.stringify(exports.AgentsCompletionRequestStop$outboundSchema.parse(agentsCompletionRequestStop)); - } - function agentsCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestStop' from JSON`); - } - exports.AgentsCompletionRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionRequestMessages$; - (function(AgentsCompletionRequestMessages$2) { - AgentsCompletionRequestMessages$2.inboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema; - AgentsCompletionRequestMessages$2.outboundSchema = exports.AgentsCompletionRequestMessages$outboundSchema; - })(AgentsCompletionRequestMessages$ || (exports.AgentsCompletionRequestMessages$ = AgentsCompletionRequestMessages$ = {})); - function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages) { - return JSON.stringify(exports.AgentsCompletionRequestMessages$outboundSchema.parse(agentsCompletionRequestMessages)); - } - function agentsCompletionRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestMessages' from JSON`); - } - exports.AgentsCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionRequestToolChoice$; - (function(AgentsCompletionRequestToolChoice$2) { - AgentsCompletionRequestToolChoice$2.inboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema; - AgentsCompletionRequestToolChoice$2.outboundSchema = exports.AgentsCompletionRequestToolChoice$outboundSchema; - })(AgentsCompletionRequestToolChoice$ || (exports.AgentsCompletionRequestToolChoice$ = AgentsCompletionRequestToolChoice$ = {})); - function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionRequestToolChoice$outboundSchema.parse(agentsCompletionRequestToolChoice)); - } - function agentsCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestToolChoice' from JSON`); - } - exports.AgentsCompletionRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionRequest$; - (function(AgentsCompletionRequest$2) { - AgentsCompletionRequest$2.inboundSchema = exports.AgentsCompletionRequest$inboundSchema; - AgentsCompletionRequest$2.outboundSchema = exports.AgentsCompletionRequest$outboundSchema; - })(AgentsCompletionRequest$ || (exports.AgentsCompletionRequest$ = AgentsCompletionRequest$ = {})); - function agentsCompletionRequestToJSON(agentsCompletionRequest) { - return JSON.stringify(exports.AgentsCompletionRequest$outboundSchema.parse(agentsCompletionRequest)); - } - function agentsCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js - var require_agentscompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionStreamRequest$ = exports.AgentsCompletionStreamRequest$outboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$ = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = exports.AgentsCompletionStreamRequestMessages$ = exports.AgentsCompletionStreamRequestMessages$outboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema = exports.AgentsCompletionStreamRequestStop$ = exports.AgentsCompletionStreamRequestStop$outboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema = void 0; - exports.agentsCompletionStreamRequestStopToJSON = agentsCompletionStreamRequestStopToJSON; - exports.agentsCompletionStreamRequestStopFromJSON = agentsCompletionStreamRequestStopFromJSON; - exports.agentsCompletionStreamRequestMessagesToJSON = agentsCompletionStreamRequestMessagesToJSON; - exports.agentsCompletionStreamRequestMessagesFromJSON = agentsCompletionStreamRequestMessagesFromJSON; - exports.agentsCompletionStreamRequestToolChoiceToJSON = agentsCompletionStreamRequestToolChoiceToJSON; - exports.agentsCompletionStreamRequestToolChoiceFromJSON = agentsCompletionStreamRequestToolChoiceFromJSON; - exports.agentsCompletionStreamRequestToJSON = agentsCompletionStreamRequestToJSON; - exports.agentsCompletionStreamRequestFromJSON = agentsCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionStreamRequestStop$; - (function(AgentsCompletionStreamRequestStop$2) { - AgentsCompletionStreamRequestStop$2.inboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema; - AgentsCompletionStreamRequestStop$2.outboundSchema = exports.AgentsCompletionStreamRequestStop$outboundSchema; - })(AgentsCompletionStreamRequestStop$ || (exports.AgentsCompletionStreamRequestStop$ = AgentsCompletionStreamRequestStop$ = {})); - function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop) { - return JSON.stringify(exports.AgentsCompletionStreamRequestStop$outboundSchema.parse(agentsCompletionStreamRequestStop)); - } - function agentsCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestStop' from JSON`); - } - exports.AgentsCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionStreamRequestMessages$; - (function(AgentsCompletionStreamRequestMessages$2) { - AgentsCompletionStreamRequestMessages$2.inboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema; - AgentsCompletionStreamRequestMessages$2.outboundSchema = exports.AgentsCompletionStreamRequestMessages$outboundSchema; - })(AgentsCompletionStreamRequestMessages$ || (exports.AgentsCompletionStreamRequestMessages$ = AgentsCompletionStreamRequestMessages$ = {})); - function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages) { - return JSON.stringify(exports.AgentsCompletionStreamRequestMessages$outboundSchema.parse(agentsCompletionStreamRequestMessages)); - } - function agentsCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestMessages' from JSON`); - } - exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionStreamRequestToolChoice$; - (function(AgentsCompletionStreamRequestToolChoice$2) { - AgentsCompletionStreamRequestToolChoice$2.inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema; - AgentsCompletionStreamRequestToolChoice$2.outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema; - })(AgentsCompletionStreamRequestToolChoice$ || (exports.AgentsCompletionStreamRequestToolChoice$ = AgentsCompletionStreamRequestToolChoice$ = {})); - function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionStreamRequestToolChoice$outboundSchema.parse(agentsCompletionStreamRequestToolChoice)); - } - function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestToolChoice' from JSON`); - } - exports.AgentsCompletionStreamRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionStreamRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionStreamRequest$; - (function(AgentsCompletionStreamRequest$2) { - AgentsCompletionStreamRequest$2.inboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema; - AgentsCompletionStreamRequest$2.outboundSchema = exports.AgentsCompletionStreamRequest$outboundSchema; - })(AgentsCompletionStreamRequest$ || (exports.AgentsCompletionStreamRequest$ = AgentsCompletionStreamRequest$ = {})); - function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest) { - return JSON.stringify(exports.AgentsCompletionStreamRequest$outboundSchema.parse(agentsCompletionStreamRequest)); - } - function agentsCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js - var require_agentupdaterequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentUpdateRequest$ = exports.AgentUpdateRequest$outboundSchema = exports.AgentUpdateRequest$inboundSchema = exports.AgentUpdateRequestTools$ = exports.AgentUpdateRequestTools$outboundSchema = exports.AgentUpdateRequestTools$inboundSchema = void 0; - exports.agentUpdateRequestToolsToJSON = agentUpdateRequestToolsToJSON; - exports.agentUpdateRequestToolsFromJSON = agentUpdateRequestToolsFromJSON; - exports.agentUpdateRequestToJSON = agentUpdateRequestToJSON; - exports.agentUpdateRequestFromJSON = agentUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentUpdateRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentUpdateRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentUpdateRequestTools$; - (function(AgentUpdateRequestTools$2) { - AgentUpdateRequestTools$2.inboundSchema = exports.AgentUpdateRequestTools$inboundSchema; - AgentUpdateRequestTools$2.outboundSchema = exports.AgentUpdateRequestTools$outboundSchema; - })(AgentUpdateRequestTools$ || (exports.AgentUpdateRequestTools$ = AgentUpdateRequestTools$ = {})); - function agentUpdateRequestToolsToJSON(agentUpdateRequestTools) { - return JSON.stringify(exports.AgentUpdateRequestTools$outboundSchema.parse(agentUpdateRequestTools)); - } - function agentUpdateRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequestTools' from JSON`); - } - exports.AgentUpdateRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentUpdateRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentUpdateRequest$; - (function(AgentUpdateRequest$2) { - AgentUpdateRequest$2.inboundSchema = exports.AgentUpdateRequest$inboundSchema; - AgentUpdateRequest$2.outboundSchema = exports.AgentUpdateRequest$outboundSchema; - })(AgentUpdateRequest$ || (exports.AgentUpdateRequest$ = AgentUpdateRequest$ = {})); - function agentUpdateRequestToJSON(agentUpdateRequest) { - return JSON.stringify(exports.AgentUpdateRequest$outboundSchema.parse(agentUpdateRequest)); - } - function agentUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/apiendpoint.js - var require_apiendpoint = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/apiendpoint.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ApiEndpoint$ = exports.ApiEndpoint$outboundSchema = exports.ApiEndpoint$inboundSchema = exports.ApiEndpoint = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ApiEndpoint = { - RootV1ChatCompletions: "/v1/chat/completions", - RootV1Embeddings: "/v1/embeddings", - RootV1FimCompletions: "/v1/fim/completions", - RootV1Moderations: "/v1/moderations", - RootV1ChatModerations: "/v1/chat/moderations", - RootV1Ocr: "/v1/ocr", - RootV1Classifications: "/v1/classifications", - RootV1ChatClassifications: "/v1/chat/classifications", - RootV1Conversations: "/v1/conversations", - RootV1AudioTranscriptions: "/v1/audio/transcriptions" - }; - exports.ApiEndpoint$inboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ApiEndpoint$outboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().and(z.custom()) - ]); - var ApiEndpoint$; - (function(ApiEndpoint$2) { - ApiEndpoint$2.inboundSchema = exports.ApiEndpoint$inboundSchema; - ApiEndpoint$2.outboundSchema = exports.ApiEndpoint$outboundSchema; - })(ApiEndpoint$ || (exports.ApiEndpoint$ = ApiEndpoint$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js - var require_archiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ArchiveFTModelOut$ = exports.ArchiveFTModelOut$outboundSchema = exports.ArchiveFTModelOut$inboundSchema = exports.ArchiveFTModelOutObject$ = exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema = exports.ArchiveFTModelOutObject = void 0; - exports.archiveFTModelOutToJSON = archiveFTModelOutToJSON; - exports.archiveFTModelOutFromJSON = archiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ArchiveFTModelOutObject = { - Model: "model" - }; - exports.ArchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.ArchiveFTModelOutObject); - exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - var ArchiveFTModelOutObject$; - (function(ArchiveFTModelOutObject$2) { - ArchiveFTModelOutObject$2.inboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - ArchiveFTModelOutObject$2.outboundSchema = exports.ArchiveFTModelOutObject$outboundSchema; - })(ArchiveFTModelOutObject$ || (exports.ArchiveFTModelOutObject$ = ArchiveFTModelOutObject$ = {})); - exports.ArchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(true) - }); - exports.ArchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(true) - }); - var ArchiveFTModelOut$; - (function(ArchiveFTModelOut$2) { - ArchiveFTModelOut$2.inboundSchema = exports.ArchiveFTModelOut$inboundSchema; - ArchiveFTModelOut$2.outboundSchema = exports.ArchiveFTModelOut$outboundSchema; - })(ArchiveFTModelOut$ || (exports.ArchiveFTModelOut$ = ArchiveFTModelOut$ = {})); - function archiveFTModelOutToJSON(archiveFTModelOut) { - return JSON.stringify(exports.ArchiveFTModelOut$outboundSchema.parse(archiveFTModelOut)); - } - function archiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ArchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ArchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/blobs.js - var require_blobs = __commonJS({ - "node_modules/@mistralai/mistralai/types/blobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.blobLikeSchema = void 0; - exports.isBlobLike = isBlobLike; - var z = __importStar(require_zod()); - exports.blobLikeSchema = z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true - }); - function isBlobLike(val) { - if (val instanceof Blob) { - return true; - } - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - return "stream" in val && typeof val.stream === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/file.js - var require_file = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/file.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileT$ = exports.FileT$outboundSchema = exports.FileT$inboundSchema = void 0; - exports.fileToJSON = fileToJSON; - exports.fileFromJSON = fileFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileT$inboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - exports.FileT$outboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - var FileT$; - (function(FileT$2) { - FileT$2.inboundSchema = exports.FileT$inboundSchema; - FileT$2.outboundSchema = exports.FileT$outboundSchema; - })(FileT$ || (exports.FileT$ = FileT$ = {})); - function fileToJSON(fileT) { - return JSON.stringify(exports.FileT$outboundSchema.parse(fileT)); - } - function fileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/timestampgranularity.js - var require_timestampgranularity = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/timestampgranularity.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TimestampGranularity$ = exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema = exports.TimestampGranularity = void 0; - var z = __importStar(require_zod()); - exports.TimestampGranularity = { - Segment: "segment" - }; - exports.TimestampGranularity$inboundSchema = z.nativeEnum(exports.TimestampGranularity); - exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema; - var TimestampGranularity$; - (function(TimestampGranularity$2) { - TimestampGranularity$2.inboundSchema = exports.TimestampGranularity$inboundSchema; - TimestampGranularity$2.outboundSchema = exports.TimestampGranularity$outboundSchema; - })(TimestampGranularity$ || (exports.TimestampGranularity$ = TimestampGranularity$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js - var require_audiotranscriptionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequest$ = exports.AudioTranscriptionRequest$outboundSchema = exports.AudioTranscriptionRequest$inboundSchema = void 0; - exports.audioTranscriptionRequestToJSON = audioTranscriptionRequestToJSON; - exports.audioTranscriptionRequestFromJSON = audioTranscriptionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequest$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequest$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequest$; - (function(AudioTranscriptionRequest$2) { - AudioTranscriptionRequest$2.inboundSchema = exports.AudioTranscriptionRequest$inboundSchema; - AudioTranscriptionRequest$2.outboundSchema = exports.AudioTranscriptionRequest$outboundSchema; - })(AudioTranscriptionRequest$ || (exports.AudioTranscriptionRequest$ = AudioTranscriptionRequest$ = {})); - function audioTranscriptionRequestToJSON(audioTranscriptionRequest) { - return JSON.stringify(exports.AudioTranscriptionRequest$outboundSchema.parse(audioTranscriptionRequest)); - } - function audioTranscriptionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js - var require_audiotranscriptionrequeststream = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequestStream$ = exports.AudioTranscriptionRequestStream$outboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema = void 0; - exports.audioTranscriptionRequestStreamToJSON = audioTranscriptionRequestStreamToJSON; - exports.audioTranscriptionRequestStreamFromJSON = audioTranscriptionRequestStreamFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequestStream$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequestStream$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequestStream$; - (function(AudioTranscriptionRequestStream$2) { - AudioTranscriptionRequestStream$2.inboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema; - AudioTranscriptionRequestStream$2.outboundSchema = exports.AudioTranscriptionRequestStream$outboundSchema; - })(AudioTranscriptionRequestStream$ || (exports.AudioTranscriptionRequestStream$ = AudioTranscriptionRequestStream$ = {})); - function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream) { - return JSON.stringify(exports.AudioTranscriptionRequestStream$outboundSchema.parse(audioTranscriptionRequestStream)); - } - function audioTranscriptionRequestStreamFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequestStream$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequestStream' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelcapabilities.js - var require_modelcapabilities = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelcapabilities.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelCapabilities$ = exports.ModelCapabilities$outboundSchema = exports.ModelCapabilities$inboundSchema = void 0; - exports.modelCapabilitiesToJSON = modelCapabilitiesToJSON; - exports.modelCapabilitiesFromJSON = modelCapabilitiesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModelCapabilities$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(true), - fine_tuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.ModelCapabilities$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(true), - fineTuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var ModelCapabilities$; - (function(ModelCapabilities$2) { - ModelCapabilities$2.inboundSchema = exports.ModelCapabilities$inboundSchema; - ModelCapabilities$2.outboundSchema = exports.ModelCapabilities$outboundSchema; - })(ModelCapabilities$ || (exports.ModelCapabilities$ = ModelCapabilities$ = {})); - function modelCapabilitiesToJSON(modelCapabilities) { - return JSON.stringify(exports.ModelCapabilities$outboundSchema.parse(modelCapabilities)); - } - function modelCapabilitiesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelCapabilities$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelCapabilities' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/basemodelcard.js - var require_basemodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/basemodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BaseModelCard$ = exports.BaseModelCard$outboundSchema = exports.BaseModelCard$inboundSchema = exports.BaseModelCardType$ = exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema = exports.BaseModelCardType = void 0; - exports.baseModelCardToJSON = baseModelCardToJSON; - exports.baseModelCardFromJSON = baseModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.BaseModelCardType = { - Base: "base" - }; - exports.BaseModelCardType$inboundSchema = z.nativeEnum(exports.BaseModelCardType); - exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema; - var BaseModelCardType$; - (function(BaseModelCardType$2) { - BaseModelCardType$2.inboundSchema = exports.BaseModelCardType$inboundSchema; - BaseModelCardType$2.outboundSchema = exports.BaseModelCardType$outboundSchema; - })(BaseModelCardType$ || (exports.BaseModelCardType$ = BaseModelCardType$ = {})); - exports.BaseModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.BaseModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var BaseModelCard$; - (function(BaseModelCard$2) { - BaseModelCard$2.inboundSchema = exports.BaseModelCard$inboundSchema; - BaseModelCard$2.outboundSchema = exports.BaseModelCard$outboundSchema; - })(BaseModelCard$ || (exports.BaseModelCard$ = BaseModelCard$ = {})); - function baseModelCardToJSON(baseModelCard) { - return JSON.stringify(exports.BaseModelCard$outboundSchema.parse(baseModelCard)); - } - function baseModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BaseModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BaseModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batcherror.js - var require_batcherror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batcherror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchError$ = exports.BatchError$outboundSchema = exports.BatchError$inboundSchema = void 0; - exports.batchErrorToJSON = batchErrorToJSON; - exports.batchErrorFromJSON = batchErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.BatchError$inboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - exports.BatchError$outboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - var BatchError$; - (function(BatchError$2) { - BatchError$2.inboundSchema = exports.BatchError$inboundSchema; - BatchError$2.outboundSchema = exports.BatchError$outboundSchema; - })(BatchError$ || (exports.BatchError$ = BatchError$ = {})); - function batchErrorToJSON(batchError) { - return JSON.stringify(exports.BatchError$outboundSchema.parse(batchError)); - } - function batchErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobin.js - var require_batchjobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobIn$ = exports.BatchJobIn$outboundSchema = exports.BatchJobIn$inboundSchema = void 0; - exports.batchJobInToJSON = batchJobInToJSON; - exports.batchJobInFromJSON = batchJobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var apiendpoint_js_1 = require_apiendpoint(); - exports.BatchJobIn$inboundSchema = z.object({ - input_files: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$inboundSchema, - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeout_hours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "timeout_hours": "timeoutHours" - }); - }); - exports.BatchJobIn$outboundSchema = z.object({ - inputFiles: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$outboundSchema, - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeoutHours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - timeoutHours: "timeout_hours" - }); - }); - var BatchJobIn$; - (function(BatchJobIn$2) { - BatchJobIn$2.inboundSchema = exports.BatchJobIn$inboundSchema; - BatchJobIn$2.outboundSchema = exports.BatchJobIn$outboundSchema; - })(BatchJobIn$ || (exports.BatchJobIn$ = BatchJobIn$ = {})); - function batchJobInToJSON(batchJobIn) { - return JSON.stringify(exports.BatchJobIn$outboundSchema.parse(batchJobIn)); - } - function batchJobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobstatus.js - var require_batchjobstatus = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobstatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobStatus$ = exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema = exports.BatchJobStatus = void 0; - var z = __importStar(require_zod()); - exports.BatchJobStatus = { - Queued: "QUEUED", - Running: "RUNNING", - Success: "SUCCESS", - Failed: "FAILED", - TimeoutExceeded: "TIMEOUT_EXCEEDED", - CancellationRequested: "CANCELLATION_REQUESTED", - Cancelled: "CANCELLED" - }; - exports.BatchJobStatus$inboundSchema = z.nativeEnum(exports.BatchJobStatus); - exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema; - var BatchJobStatus$; - (function(BatchJobStatus$2) { - BatchJobStatus$2.inboundSchema = exports.BatchJobStatus$inboundSchema; - BatchJobStatus$2.outboundSchema = exports.BatchJobStatus$outboundSchema; - })(BatchJobStatus$ || (exports.BatchJobStatus$ = BatchJobStatus$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobout.js - var require_batchjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobOut$ = exports.BatchJobOut$outboundSchema = exports.BatchJobOut$inboundSchema = exports.BatchJobOutObject$ = exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema = exports.BatchJobOutObject = void 0; - exports.batchJobOutToJSON = batchJobOutToJSON; - exports.batchJobOutFromJSON = batchJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var batcherror_js_1 = require_batcherror(); - var batchjobstatus_js_1 = require_batchjobstatus(); - exports.BatchJobOutObject = { - Batch: "batch" - }; - exports.BatchJobOutObject$inboundSchema = z.nativeEnum(exports.BatchJobOutObject); - exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema; - var BatchJobOutObject$; - (function(BatchJobOutObject$2) { - BatchJobOutObject$2.inboundSchema = exports.BatchJobOutObject$inboundSchema; - BatchJobOutObject$2.outboundSchema = exports.BatchJobOutObject$outboundSchema; - })(BatchJobOutObject$ || (exports.BatchJobOutObject$ = BatchJobOutObject$ = {})); - exports.BatchJobOut$inboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$inboundSchema.default("batch"), - input_files: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - output_file: z.nullable(z.string()).optional(), - error_file: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$inboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$inboundSchema, - created_at: z.number().int(), - total_requests: z.number().int(), - completed_requests: z.number().int(), - succeeded_requests: z.number().int(), - failed_requests: z.number().int(), - started_at: z.nullable(z.number().int()).optional(), - completed_at: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "output_file": "outputFile", - "error_file": "errorFile", - "created_at": "createdAt", - "total_requests": "totalRequests", - "completed_requests": "completedRequests", - "succeeded_requests": "succeededRequests", - "failed_requests": "failedRequests", - "started_at": "startedAt", - "completed_at": "completedAt" - }); - }); - exports.BatchJobOut$outboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$outboundSchema.default("batch"), - inputFiles: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - outputFile: z.nullable(z.string()).optional(), - errorFile: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$outboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$outboundSchema, - createdAt: z.number().int(), - totalRequests: z.number().int(), - completedRequests: z.number().int(), - succeededRequests: z.number().int(), - failedRequests: z.number().int(), - startedAt: z.nullable(z.number().int()).optional(), - completedAt: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - outputFile: "output_file", - errorFile: "error_file", - createdAt: "created_at", - totalRequests: "total_requests", - completedRequests: "completed_requests", - succeededRequests: "succeeded_requests", - failedRequests: "failed_requests", - startedAt: "started_at", - completedAt: "completed_at" - }); - }); - var BatchJobOut$; - (function(BatchJobOut$2) { - BatchJobOut$2.inboundSchema = exports.BatchJobOut$inboundSchema; - BatchJobOut$2.outboundSchema = exports.BatchJobOut$outboundSchema; - })(BatchJobOut$ || (exports.BatchJobOut$ = BatchJobOut$ = {})); - function batchJobOutToJSON(batchJobOut) { - return JSON.stringify(exports.BatchJobOut$outboundSchema.parse(batchJobOut)); - } - function batchJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobsout.js - var require_batchjobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobsOut$ = exports.BatchJobsOut$outboundSchema = exports.BatchJobsOut$inboundSchema = exports.BatchJobsOutObject$ = exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema = exports.BatchJobsOutObject = void 0; - exports.batchJobsOutToJSON = batchJobsOutToJSON; - exports.batchJobsOutFromJSON = batchJobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var batchjobout_js_1 = require_batchjobout(); - exports.BatchJobsOutObject = { - List: "list" - }; - exports.BatchJobsOutObject$inboundSchema = z.nativeEnum(exports.BatchJobsOutObject); - exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema; - var BatchJobsOutObject$; - (function(BatchJobsOutObject$2) { - BatchJobsOutObject$2.inboundSchema = exports.BatchJobsOutObject$inboundSchema; - BatchJobsOutObject$2.outboundSchema = exports.BatchJobsOutObject$outboundSchema; - })(BatchJobsOutObject$ || (exports.BatchJobsOutObject$ = BatchJobsOutObject$ = {})); - exports.BatchJobsOut$inboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$inboundSchema).optional(), - object: exports.BatchJobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.BatchJobsOut$outboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$outboundSchema).optional(), - object: exports.BatchJobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var BatchJobsOut$; - (function(BatchJobsOut$2) { - BatchJobsOut$2.inboundSchema = exports.BatchJobsOut$inboundSchema; - BatchJobsOut$2.outboundSchema = exports.BatchJobsOut$outboundSchema; - })(BatchJobsOut$ || (exports.BatchJobsOut$ = BatchJobsOut$ = {})); - function batchJobsOutToJSON(batchJobsOut) { - return JSON.stringify(exports.BatchJobsOut$outboundSchema.parse(batchJobsOut)); - } - function batchJobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/builtinconnectors.js - var require_builtinconnectors = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/builtinconnectors.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BuiltInConnectors$ = exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema = exports.BuiltInConnectors = void 0; - var z = __importStar(require_zod()); - exports.BuiltInConnectors = { - WebSearch: "web_search", - WebSearchPremium: "web_search_premium", - CodeInterpreter: "code_interpreter", - ImageGeneration: "image_generation", - DocumentLibrary: "document_library" - }; - exports.BuiltInConnectors$inboundSchema = z.nativeEnum(exports.BuiltInConnectors); - exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema; - var BuiltInConnectors$; - (function(BuiltInConnectors$2) { - BuiltInConnectors$2.inboundSchema = exports.BuiltInConnectors$inboundSchema; - BuiltInConnectors$2.outboundSchema = exports.BuiltInConnectors$outboundSchema; - })(BuiltInConnectors$ || (exports.BuiltInConnectors$ = BuiltInConnectors$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/instructrequest.js - var require_instructrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/instructrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InstructRequest$ = exports.InstructRequest$outboundSchema = exports.InstructRequest$inboundSchema = exports.InstructRequestMessages$ = exports.InstructRequestMessages$outboundSchema = exports.InstructRequestMessages$inboundSchema = void 0; - exports.instructRequestMessagesToJSON = instructRequestMessagesToJSON; - exports.instructRequestMessagesFromJSON = instructRequestMessagesFromJSON; - exports.instructRequestToJSON = instructRequestToJSON; - exports.instructRequestFromJSON = instructRequestFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestMessages$; - (function(InstructRequestMessages$2) { - InstructRequestMessages$2.inboundSchema = exports.InstructRequestMessages$inboundSchema; - InstructRequestMessages$2.outboundSchema = exports.InstructRequestMessages$outboundSchema; - })(InstructRequestMessages$ || (exports.InstructRequestMessages$ = InstructRequestMessages$ = {})); - function instructRequestMessagesToJSON(instructRequestMessages) { - return JSON.stringify(exports.InstructRequestMessages$outboundSchema.parse(instructRequestMessages)); - } - function instructRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestMessages' from JSON`); - } - exports.InstructRequest$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequest$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequest$; - (function(InstructRequest$2) { - InstructRequest$2.inboundSchema = exports.InstructRequest$inboundSchema; - InstructRequest$2.outboundSchema = exports.InstructRequest$outboundSchema; - })(InstructRequest$ || (exports.InstructRequest$ = InstructRequest$ = {})); - function instructRequestToJSON(instructRequest) { - return JSON.stringify(exports.InstructRequest$outboundSchema.parse(instructRequest)); - } - function instructRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputs.js - var require_inputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Inputs$ = exports.Inputs$outboundSchema = exports.Inputs$inboundSchema = exports.InstructRequestInputs$ = exports.InstructRequestInputs$outboundSchema = exports.InstructRequestInputs$inboundSchema = exports.InstructRequestInputsMessages$ = exports.InstructRequestInputsMessages$outboundSchema = exports.InstructRequestInputsMessages$inboundSchema = void 0; - exports.instructRequestInputsMessagesToJSON = instructRequestInputsMessagesToJSON; - exports.instructRequestInputsMessagesFromJSON = instructRequestInputsMessagesFromJSON; - exports.instructRequestInputsToJSON = instructRequestInputsToJSON; - exports.instructRequestInputsFromJSON = instructRequestInputsFromJSON; - exports.inputsToJSON = inputsToJSON; - exports.inputsFromJSON = inputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var instructrequest_js_1 = require_instructrequest(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestInputsMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestInputsMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestInputsMessages$; - (function(InstructRequestInputsMessages$2) { - InstructRequestInputsMessages$2.inboundSchema = exports.InstructRequestInputsMessages$inboundSchema; - InstructRequestInputsMessages$2.outboundSchema = exports.InstructRequestInputsMessages$outboundSchema; - })(InstructRequestInputsMessages$ || (exports.InstructRequestInputsMessages$ = InstructRequestInputsMessages$ = {})); - function instructRequestInputsMessagesToJSON(instructRequestInputsMessages) { - return JSON.stringify(exports.InstructRequestInputsMessages$outboundSchema.parse(instructRequestInputsMessages)); - } - function instructRequestInputsMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputsMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputsMessages' from JSON`); - } - exports.InstructRequestInputs$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequestInputs$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequestInputs$; - (function(InstructRequestInputs$2) { - InstructRequestInputs$2.inboundSchema = exports.InstructRequestInputs$inboundSchema; - InstructRequestInputs$2.outboundSchema = exports.InstructRequestInputs$outboundSchema; - })(InstructRequestInputs$ || (exports.InstructRequestInputs$ = InstructRequestInputs$ = {})); - function instructRequestInputsToJSON(instructRequestInputs) { - return JSON.stringify(exports.InstructRequestInputs$outboundSchema.parse(instructRequestInputs)); - } - function instructRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputs' from JSON`); - } - exports.Inputs$inboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$inboundSchema), - z.array(instructrequest_js_1.InstructRequest$inboundSchema) - ]); - exports.Inputs$outboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$outboundSchema), - z.array(instructrequest_js_1.InstructRequest$outboundSchema) - ]); - var Inputs$; - (function(Inputs$2) { - Inputs$2.inboundSchema = exports.Inputs$inboundSchema; - Inputs$2.outboundSchema = exports.Inputs$outboundSchema; - })(Inputs$ || (exports.Inputs$ = Inputs$ = {})); - function inputsToJSON(inputs) { - return JSON.stringify(exports.Inputs$outboundSchema.parse(inputs)); - } - function inputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Inputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Inputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js - var require_chatclassificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatClassificationRequest$ = exports.ChatClassificationRequest$outboundSchema = exports.ChatClassificationRequest$inboundSchema = void 0; - exports.chatClassificationRequestToJSON = chatClassificationRequestToJSON; - exports.chatClassificationRequestFromJSON = chatClassificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var inputs_js_1 = require_inputs(); - exports.ChatClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: inputs_js_1.Inputs$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: inputs_js_1.Inputs$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatClassificationRequest$; - (function(ChatClassificationRequest$2) { - ChatClassificationRequest$2.inboundSchema = exports.ChatClassificationRequest$inboundSchema; - ChatClassificationRequest$2.outboundSchema = exports.ChatClassificationRequest$outboundSchema; - })(ChatClassificationRequest$ || (exports.ChatClassificationRequest$ = ChatClassificationRequest$ = {})); - function chatClassificationRequestToJSON(chatClassificationRequest) { - return JSON.stringify(exports.ChatClassificationRequest$outboundSchema.parse(chatClassificationRequest)); - } - function chatClassificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js - var require_chatcompletionchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionChoice$ = exports.ChatCompletionChoice$outboundSchema = exports.ChatCompletionChoice$inboundSchema = exports.FinishReason$ = exports.FinishReason$outboundSchema = exports.FinishReason$inboundSchema = exports.FinishReason = void 0; - exports.chatCompletionChoiceToJSON = chatCompletionChoiceToJSON; - exports.chatCompletionChoiceFromJSON = chatCompletionChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var assistantmessage_js_1 = require_assistantmessage(); - exports.FinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.FinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().and(z.custom()) - ]); - var FinishReason$; - (function(FinishReason$2) { - FinishReason$2.inboundSchema = exports.FinishReason$inboundSchema; - FinishReason$2.outboundSchema = exports.FinishReason$outboundSchema; - })(FinishReason$ || (exports.FinishReason$ = FinishReason$ = {})); - exports.ChatCompletionChoice$inboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$inboundSchema, - finish_reason: exports.FinishReason$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.ChatCompletionChoice$outboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$outboundSchema, - finishReason: exports.FinishReason$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var ChatCompletionChoice$; - (function(ChatCompletionChoice$2) { - ChatCompletionChoice$2.inboundSchema = exports.ChatCompletionChoice$inboundSchema; - ChatCompletionChoice$2.outboundSchema = exports.ChatCompletionChoice$outboundSchema; - })(ChatCompletionChoice$ || (exports.ChatCompletionChoice$ = ChatCompletionChoice$ = {})); - function chatCompletionChoiceToJSON(chatCompletionChoice) { - return JSON.stringify(exports.ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice)); - } - function chatCompletionChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js - var require_chatcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionRequest$ = exports.ChatCompletionRequest$outboundSchema = exports.ChatCompletionRequest$inboundSchema = exports.ChatCompletionRequestToolChoice$ = exports.ChatCompletionRequestToolChoice$outboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema = exports.Messages$ = exports.Messages$outboundSchema = exports.Messages$inboundSchema = exports.Stop$ = exports.Stop$outboundSchema = exports.Stop$inboundSchema = void 0; - exports.stopToJSON = stopToJSON; - exports.stopFromJSON = stopFromJSON; - exports.messagesToJSON = messagesToJSON; - exports.messagesFromJSON = messagesFromJSON; - exports.chatCompletionRequestToolChoiceToJSON = chatCompletionRequestToolChoiceToJSON; - exports.chatCompletionRequestToolChoiceFromJSON = chatCompletionRequestToolChoiceFromJSON; - exports.chatCompletionRequestToJSON = chatCompletionRequestToJSON; - exports.chatCompletionRequestFromJSON = chatCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Stop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.Stop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var Stop$; - (function(Stop$2) { - Stop$2.inboundSchema = exports.Stop$inboundSchema; - Stop$2.outboundSchema = exports.Stop$outboundSchema; - })(Stop$ || (exports.Stop$ = Stop$ = {})); - function stopToJSON(stop) { - return JSON.stringify(exports.Stop$outboundSchema.parse(stop)); - } - function stopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Stop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Stop' from JSON`); - } - exports.Messages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Messages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Messages$; - (function(Messages$2) { - Messages$2.inboundSchema = exports.Messages$inboundSchema; - Messages$2.outboundSchema = exports.Messages$outboundSchema; - })(Messages$ || (exports.Messages$ = Messages$ = {})); - function messagesToJSON(messages) { - return JSON.stringify(exports.Messages$outboundSchema.parse(messages)); - } - function messagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Messages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Messages' from JSON`); - } - exports.ChatCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionRequestToolChoice$; - (function(ChatCompletionRequestToolChoice$2) { - ChatCompletionRequestToolChoice$2.inboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema; - ChatCompletionRequestToolChoice$2.outboundSchema = exports.ChatCompletionRequestToolChoice$outboundSchema; - })(ChatCompletionRequestToolChoice$ || (exports.ChatCompletionRequestToolChoice$ = ChatCompletionRequestToolChoice$ = {})); - function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionRequestToolChoice$outboundSchema.parse(chatCompletionRequestToolChoice)); - } - function chatCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`); - } - exports.ChatCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionRequest$; - (function(ChatCompletionRequest$2) { - ChatCompletionRequest$2.inboundSchema = exports.ChatCompletionRequest$inboundSchema; - ChatCompletionRequest$2.outboundSchema = exports.ChatCompletionRequest$outboundSchema; - })(ChatCompletionRequest$ || (exports.ChatCompletionRequest$ = ChatCompletionRequest$ = {})); - function chatCompletionRequestToJSON(chatCompletionRequest) { - return JSON.stringify(exports.ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest)); - } - function chatCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usageinfo.js - var require_usageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UsageInfo$ = exports.UsageInfo$outboundSchema = exports.UsageInfo$inboundSchema = void 0; - exports.usageInfoToJSON = usageInfoToJSON; - exports.usageInfoFromJSON = usageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.UsageInfo$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - prompt_audio_seconds: z.nullable(z.number().int()).optional() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "prompt_audio_seconds": "promptAudioSeconds" - }); - }); - exports.UsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - promptAudioSeconds: z.nullable(z.number().int()).optional(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - promptAudioSeconds: "prompt_audio_seconds", - additionalProperties: null - }) - }; - }); - var UsageInfo$; - (function(UsageInfo$2) { - UsageInfo$2.inboundSchema = exports.UsageInfo$inboundSchema; - UsageInfo$2.outboundSchema = exports.UsageInfo$outboundSchema; - })(UsageInfo$ || (exports.UsageInfo$ = UsageInfo$ = {})); - function usageInfoToJSON(usageInfo) { - return JSON.stringify(exports.UsageInfo$outboundSchema.parse(usageInfo)); - } - function usageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js - var require_chatcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionResponse$ = exports.ChatCompletionResponse$outboundSchema = exports.ChatCompletionResponse$inboundSchema = void 0; - exports.chatCompletionResponseToJSON = chatCompletionResponseToJSON; - exports.chatCompletionResponseFromJSON = chatCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.ChatCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.ChatCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var ChatCompletionResponse$; - (function(ChatCompletionResponse$2) { - ChatCompletionResponse$2.inboundSchema = exports.ChatCompletionResponse$inboundSchema; - ChatCompletionResponse$2.outboundSchema = exports.ChatCompletionResponse$outboundSchema; - })(ChatCompletionResponse$ || (exports.ChatCompletionResponse$ = ChatCompletionResponse$ = {})); - function chatCompletionResponseToJSON(chatCompletionResponse) { - return JSON.stringify(exports.ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse)); - } - function chatCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js - var require_chatcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionStreamRequest$ = exports.ChatCompletionStreamRequest$outboundSchema = exports.ChatCompletionStreamRequest$inboundSchema = exports.ChatCompletionStreamRequestToolChoice$ = exports.ChatCompletionStreamRequestToolChoice$outboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema = exports.ChatCompletionStreamRequestMessages$ = exports.ChatCompletionStreamRequestMessages$outboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema = exports.ChatCompletionStreamRequestStop$ = exports.ChatCompletionStreamRequestStop$outboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema = void 0; - exports.chatCompletionStreamRequestStopToJSON = chatCompletionStreamRequestStopToJSON; - exports.chatCompletionStreamRequestStopFromJSON = chatCompletionStreamRequestStopFromJSON; - exports.chatCompletionStreamRequestMessagesToJSON = chatCompletionStreamRequestMessagesToJSON; - exports.chatCompletionStreamRequestMessagesFromJSON = chatCompletionStreamRequestMessagesFromJSON; - exports.chatCompletionStreamRequestToolChoiceToJSON = chatCompletionStreamRequestToolChoiceToJSON; - exports.chatCompletionStreamRequestToolChoiceFromJSON = chatCompletionStreamRequestToolChoiceFromJSON; - exports.chatCompletionStreamRequestToJSON = chatCompletionStreamRequestToJSON; - exports.chatCompletionStreamRequestFromJSON = chatCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.ChatCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ChatCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ChatCompletionStreamRequestStop$; - (function(ChatCompletionStreamRequestStop$2) { - ChatCompletionStreamRequestStop$2.inboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema; - ChatCompletionStreamRequestStop$2.outboundSchema = exports.ChatCompletionStreamRequestStop$outboundSchema; - })(ChatCompletionStreamRequestStop$ || (exports.ChatCompletionStreamRequestStop$ = ChatCompletionStreamRequestStop$ = {})); - function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop) { - return JSON.stringify(exports.ChatCompletionStreamRequestStop$outboundSchema.parse(chatCompletionStreamRequestStop)); - } - function chatCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestStop' from JSON`); - } - exports.ChatCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.ChatCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var ChatCompletionStreamRequestMessages$; - (function(ChatCompletionStreamRequestMessages$2) { - ChatCompletionStreamRequestMessages$2.inboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema; - ChatCompletionStreamRequestMessages$2.outboundSchema = exports.ChatCompletionStreamRequestMessages$outboundSchema; - })(ChatCompletionStreamRequestMessages$ || (exports.ChatCompletionStreamRequestMessages$ = ChatCompletionStreamRequestMessages$ = {})); - function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages) { - return JSON.stringify(exports.ChatCompletionStreamRequestMessages$outboundSchema.parse(chatCompletionStreamRequestMessages)); - } - function chatCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestMessages' from JSON`); - } - exports.ChatCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionStreamRequestToolChoice$; - (function(ChatCompletionStreamRequestToolChoice$2) { - ChatCompletionStreamRequestToolChoice$2.inboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema; - ChatCompletionStreamRequestToolChoice$2.outboundSchema = exports.ChatCompletionStreamRequestToolChoice$outboundSchema; - })(ChatCompletionStreamRequestToolChoice$ || (exports.ChatCompletionStreamRequestToolChoice$ = ChatCompletionStreamRequestToolChoice$ = {})); - function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionStreamRequestToolChoice$outboundSchema.parse(chatCompletionStreamRequestToolChoice)); - } - function chatCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`); - } - exports.ChatCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionStreamRequest$; - (function(ChatCompletionStreamRequest$2) { - ChatCompletionStreamRequest$2.inboundSchema = exports.ChatCompletionStreamRequest$inboundSchema; - ChatCompletionStreamRequest$2.outboundSchema = exports.ChatCompletionStreamRequest$outboundSchema; - })(ChatCompletionStreamRequest$ || (exports.ChatCompletionStreamRequest$ = ChatCompletionStreamRequest$ = {})); - function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest) { - return JSON.stringify(exports.ChatCompletionStreamRequest$outboundSchema.parse(chatCompletionStreamRequest)); - } - function chatCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js - var require_chatmoderationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatModerationRequest$ = exports.ChatModerationRequest$outboundSchema = exports.ChatModerationRequest$inboundSchema = exports.ChatModerationRequestInputs$ = exports.ChatModerationRequestInputs$outboundSchema = exports.ChatModerationRequestInputs$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = exports.Two$ = exports.Two$outboundSchema = exports.Two$inboundSchema = void 0; - exports.twoToJSON = twoToJSON; - exports.twoFromJSON = twoFromJSON; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.chatModerationRequestInputsToJSON = chatModerationRequestInputsToJSON; - exports.chatModerationRequestInputsFromJSON = chatModerationRequestInputsFromJSON; - exports.chatModerationRequestToJSON = chatModerationRequestToJSON; - exports.chatModerationRequestFromJSON = chatModerationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Two$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Two$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Two$; - (function(Two$2) { - Two$2.inboundSchema = exports.Two$inboundSchema; - Two$2.outboundSchema = exports.Two$outboundSchema; - })(Two$ || (exports.Two$ = Two$ = {})); - function twoToJSON(two) { - return JSON.stringify(exports.Two$outboundSchema.parse(two)); - } - function twoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Two$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Two' from JSON`); - } - exports.One$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.One$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.ChatModerationRequestInputs$inboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - exports.ChatModerationRequestInputs$outboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - var ChatModerationRequestInputs$; - (function(ChatModerationRequestInputs$2) { - ChatModerationRequestInputs$2.inboundSchema = exports.ChatModerationRequestInputs$inboundSchema; - ChatModerationRequestInputs$2.outboundSchema = exports.ChatModerationRequestInputs$outboundSchema; - })(ChatModerationRequestInputs$ || (exports.ChatModerationRequestInputs$ = ChatModerationRequestInputs$ = {})); - function chatModerationRequestInputsToJSON(chatModerationRequestInputs) { - return JSON.stringify(exports.ChatModerationRequestInputs$outboundSchema.parse(chatModerationRequestInputs)); - } - function chatModerationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequestInputs' from JSON`); - } - exports.ChatModerationRequest$inboundSchema = z.object({ - input: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatModerationRequest$outboundSchema = z.object({ - inputs: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatModerationRequest$; - (function(ChatModerationRequest$2) { - ChatModerationRequest$2.inboundSchema = exports.ChatModerationRequest$inboundSchema; - ChatModerationRequest$2.outboundSchema = exports.ChatModerationRequest$outboundSchema; - })(ChatModerationRequest$ || (exports.ChatModerationRequest$ = ChatModerationRequest$ = {})); - function chatModerationRequestToJSON(chatModerationRequest) { - return JSON.stringify(exports.ChatModerationRequest$outboundSchema.parse(chatModerationRequest)); - } - function chatModerationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/metricout.js - var require_metricout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/metricout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MetricOut$ = exports.MetricOut$outboundSchema = exports.MetricOut$inboundSchema = void 0; - exports.metricOutToJSON = metricOutToJSON; - exports.metricOutFromJSON = metricOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.MetricOut$inboundSchema = z.object({ - train_loss: z.nullable(z.number()).optional(), - valid_loss: z.nullable(z.number()).optional(), - valid_mean_token_accuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "train_loss": "trainLoss", - "valid_loss": "validLoss", - "valid_mean_token_accuracy": "validMeanTokenAccuracy" - }); - }); - exports.MetricOut$outboundSchema = z.object({ - trainLoss: z.nullable(z.number()).optional(), - validLoss: z.nullable(z.number()).optional(), - validMeanTokenAccuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainLoss: "train_loss", - validLoss: "valid_loss", - validMeanTokenAccuracy: "valid_mean_token_accuracy" - }); - }); - var MetricOut$; - (function(MetricOut$2) { - MetricOut$2.inboundSchema = exports.MetricOut$inboundSchema; - MetricOut$2.outboundSchema = exports.MetricOut$outboundSchema; - })(MetricOut$ || (exports.MetricOut$ = MetricOut$ = {})); - function metricOutToJSON(metricOut) { - return JSON.stringify(exports.MetricOut$outboundSchema.parse(metricOut)); - } - function metricOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MetricOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MetricOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/checkpointout.js - var require_checkpointout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/checkpointout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CheckpointOut$ = exports.CheckpointOut$outboundSchema = exports.CheckpointOut$inboundSchema = void 0; - exports.checkpointOutToJSON = checkpointOutToJSON; - exports.checkpointOutFromJSON = checkpointOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var metricout_js_1 = require_metricout(); - exports.CheckpointOut$inboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$inboundSchema, - step_number: z.number().int(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "step_number": "stepNumber", - "created_at": "createdAt" - }); - }); - exports.CheckpointOut$outboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$outboundSchema, - stepNumber: z.number().int(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - stepNumber: "step_number", - createdAt: "created_at" - }); - }); - var CheckpointOut$; - (function(CheckpointOut$2) { - CheckpointOut$2.inboundSchema = exports.CheckpointOut$inboundSchema; - CheckpointOut$2.outboundSchema = exports.CheckpointOut$outboundSchema; - })(CheckpointOut$ || (exports.CheckpointOut$ = CheckpointOut$ = {})); - function checkpointOutToJSON(checkpointOut) { - return JSON.stringify(exports.CheckpointOut$outboundSchema.parse(checkpointOut)); - } - function checkpointOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CheckpointOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CheckpointOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationrequest.js - var require_classificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationRequest$ = exports.ClassificationRequest$outboundSchema = exports.ClassificationRequest$inboundSchema = exports.ClassificationRequestInputs$ = exports.ClassificationRequestInputs$outboundSchema = exports.ClassificationRequestInputs$inboundSchema = void 0; - exports.classificationRequestInputsToJSON = classificationRequestInputsToJSON; - exports.classificationRequestInputsFromJSON = classificationRequestInputsFromJSON; - exports.classificationRequestToJSON = classificationRequestToJSON; - exports.classificationRequestFromJSON = classificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassificationRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ClassificationRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ClassificationRequestInputs$; - (function(ClassificationRequestInputs$2) { - ClassificationRequestInputs$2.inboundSchema = exports.ClassificationRequestInputs$inboundSchema; - ClassificationRequestInputs$2.outboundSchema = exports.ClassificationRequestInputs$outboundSchema; - })(ClassificationRequestInputs$ || (exports.ClassificationRequestInputs$ = ClassificationRequestInputs$ = {})); - function classificationRequestInputsToJSON(classificationRequestInputs) { - return JSON.stringify(exports.ClassificationRequestInputs$outboundSchema.parse(classificationRequestInputs)); - } - function classificationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequestInputs' from JSON`); - } - exports.ClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ClassificationRequest$; - (function(ClassificationRequest$2) { - ClassificationRequest$2.inboundSchema = exports.ClassificationRequest$inboundSchema; - ClassificationRequest$2.outboundSchema = exports.ClassificationRequest$outboundSchema; - })(ClassificationRequest$ || (exports.ClassificationRequest$ = ClassificationRequest$ = {})); - function classificationRequestToJSON(classificationRequest) { - return JSON.stringify(exports.ClassificationRequest$outboundSchema.parse(classificationRequest)); - } - function classificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js - var require_classificationtargetresult = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationTargetResult$ = exports.ClassificationTargetResult$outboundSchema = exports.ClassificationTargetResult$inboundSchema = void 0; - exports.classificationTargetResultToJSON = classificationTargetResultToJSON; - exports.classificationTargetResultFromJSON = classificationTargetResultFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ClassificationTargetResult$inboundSchema = z.object({ - scores: z.record(z.number()) - }); - exports.ClassificationTargetResult$outboundSchema = z.object({ - scores: z.record(z.number()) - }); - var ClassificationTargetResult$; - (function(ClassificationTargetResult$2) { - ClassificationTargetResult$2.inboundSchema = exports.ClassificationTargetResult$inboundSchema; - ClassificationTargetResult$2.outboundSchema = exports.ClassificationTargetResult$outboundSchema; - })(ClassificationTargetResult$ || (exports.ClassificationTargetResult$ = ClassificationTargetResult$ = {})); - function classificationTargetResultToJSON(classificationTargetResult) { - return JSON.stringify(exports.ClassificationTargetResult$outboundSchema.parse(classificationTargetResult)); - } - function classificationTargetResultFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationTargetResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationTargetResult' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationresponse.js - var require_classificationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationResponse$ = exports.ClassificationResponse$outboundSchema = exports.ClassificationResponse$inboundSchema = void 0; - exports.classificationResponseToJSON = classificationResponseToJSON; - exports.classificationResponseFromJSON = classificationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classificationtargetresult_js_1 = require_classificationtargetresult(); - exports.ClassificationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$inboundSchema)) - }); - exports.ClassificationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$outboundSchema)) - }); - var ClassificationResponse$; - (function(ClassificationResponse$2) { - ClassificationResponse$2.inboundSchema = exports.ClassificationResponse$inboundSchema; - ClassificationResponse$2.outboundSchema = exports.ClassificationResponse$outboundSchema; - })(ClassificationResponse$ || (exports.ClassificationResponse$ = ClassificationResponse$ = {})); - function classificationResponseToJSON(classificationResponse) { - return JSON.stringify(exports.ClassificationResponse$outboundSchema.parse(classificationResponse)); - } - function classificationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js - var require_ftclassifierlossfunction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTClassifierLossFunction$ = exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema = exports.FTClassifierLossFunction = void 0; - var z = __importStar(require_zod()); - exports.FTClassifierLossFunction = { - SingleClass: "single_class", - MultiClass: "multi_class" - }; - exports.FTClassifierLossFunction$inboundSchema = z.nativeEnum(exports.FTClassifierLossFunction); - exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema; - var FTClassifierLossFunction$; - (function(FTClassifierLossFunction$2) { - FTClassifierLossFunction$2.inboundSchema = exports.FTClassifierLossFunction$inboundSchema; - FTClassifierLossFunction$2.outboundSchema = exports.FTClassifierLossFunction$outboundSchema; - })(FTClassifierLossFunction$ || (exports.FTClassifierLossFunction$ = FTClassifierLossFunction$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetout.js - var require_classifiertargetout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetOut$ = exports.ClassifierTargetOut$outboundSchema = exports.ClassifierTargetOut$inboundSchema = void 0; - exports.classifierTargetOutToJSON = classifierTargetOutToJSON; - exports.classifierTargetOutFromJSON = classifierTargetOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetOut$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - loss_function: ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetOut$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - lossFunction: ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetOut$; - (function(ClassifierTargetOut$2) { - ClassifierTargetOut$2.inboundSchema = exports.ClassifierTargetOut$inboundSchema; - ClassifierTargetOut$2.outboundSchema = exports.ClassifierTargetOut$outboundSchema; - })(ClassifierTargetOut$ || (exports.ClassifierTargetOut$ = ClassifierTargetOut$ = {})); - function classifierTargetOutToJSON(classifierTargetOut) { - return JSON.stringify(exports.ClassifierTargetOut$outboundSchema.parse(classifierTargetOut)); - } - function classifierTargetOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js - var require_classifiertrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParameters$ = exports.ClassifierTrainingParameters$outboundSchema = exports.ClassifierTrainingParameters$inboundSchema = void 0; - exports.classifierTrainingParametersToJSON = classifierTrainingParametersToJSON; - exports.classifierTrainingParametersFromJSON = classifierTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParameters$; - (function(ClassifierTrainingParameters$2) { - ClassifierTrainingParameters$2.inboundSchema = exports.ClassifierTrainingParameters$inboundSchema; - ClassifierTrainingParameters$2.outboundSchema = exports.ClassifierTrainingParameters$outboundSchema; - })(ClassifierTrainingParameters$ || (exports.ClassifierTrainingParameters$ = ClassifierTrainingParameters$ = {})); - function classifierTrainingParametersToJSON(classifierTrainingParameters) { - return JSON.stringify(exports.ClassifierTrainingParameters$outboundSchema.parse(classifierTrainingParameters)); - } - function classifierTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/eventout.js - var require_eventout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/eventout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventOut$ = exports.EventOut$outboundSchema = exports.EventOut$inboundSchema = void 0; - exports.eventOutToJSON = eventOutToJSON; - exports.eventOutFromJSON = eventOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.EventOut$inboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.EventOut$outboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var EventOut$; - (function(EventOut$2) { - EventOut$2.inboundSchema = exports.EventOut$inboundSchema; - EventOut$2.outboundSchema = exports.EventOut$outboundSchema; - })(EventOut$ || (exports.EventOut$ = EventOut$ = {})); - function eventOutToJSON(eventOut) { - return JSON.stringify(exports.EventOut$outboundSchema.parse(eventOut)); - } - function eventOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EventOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EventOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobmetadataout.js - var require_jobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobMetadataOut$ = exports.JobMetadataOut$outboundSchema = exports.JobMetadataOut$inboundSchema = void 0; - exports.jobMetadataOutToJSON = jobMetadataOutToJSON; - exports.jobMetadataOutFromJSON = jobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime" - }); - }); - exports.JobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time" - }); - }); - var JobMetadataOut$; - (function(JobMetadataOut$2) { - JobMetadataOut$2.inboundSchema = exports.JobMetadataOut$inboundSchema; - JobMetadataOut$2.outboundSchema = exports.JobMetadataOut$outboundSchema; - })(JobMetadataOut$ || (exports.JobMetadataOut$ = JobMetadataOut$ = {})); - function jobMetadataOutToJSON(jobMetadataOut) { - return JSON.stringify(exports.JobMetadataOut$outboundSchema.parse(jobMetadataOut)); - } - function jobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js - var require_wandbintegrationout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegrationOut$ = exports.WandbIntegrationOut$outboundSchema = exports.WandbIntegrationOut$inboundSchema = exports.WandbIntegrationOutType$ = exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema = exports.WandbIntegrationOutType = void 0; - exports.wandbIntegrationOutToJSON = wandbIntegrationOutToJSON; - exports.wandbIntegrationOutFromJSON = wandbIntegrationOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationOutType = { - Wandb: "wandb" - }; - exports.WandbIntegrationOutType$inboundSchema = z.nativeEnum(exports.WandbIntegrationOutType); - exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema; - var WandbIntegrationOutType$; - (function(WandbIntegrationOutType$2) { - WandbIntegrationOutType$2.inboundSchema = exports.WandbIntegrationOutType$inboundSchema; - WandbIntegrationOutType$2.outboundSchema = exports.WandbIntegrationOutType$outboundSchema; - })(WandbIntegrationOutType$ || (exports.WandbIntegrationOutType$ = WandbIntegrationOutType$ = {})); - exports.WandbIntegrationOut$inboundSchema = z.object({ - type: exports.WandbIntegrationOutType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - run_name: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "run_name": "runName" - }); - }); - exports.WandbIntegrationOut$outboundSchema = z.object({ - type: exports.WandbIntegrationOutType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - runName: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - runName: "run_name" - }); - }); - var WandbIntegrationOut$; - (function(WandbIntegrationOut$2) { - WandbIntegrationOut$2.inboundSchema = exports.WandbIntegrationOut$inboundSchema; - WandbIntegrationOut$2.outboundSchema = exports.WandbIntegrationOut$outboundSchema; - })(WandbIntegrationOut$ || (exports.WandbIntegrationOut$ = WandbIntegrationOut$ = {})); - function wandbIntegrationOutToJSON(wandbIntegrationOut) { - return JSON.stringify(exports.WandbIntegrationOut$outboundSchema.parse(wandbIntegrationOut)); - } - function wandbIntegrationOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegrationOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegrationOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js - var require_classifierdetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierDetailedJobOut$ = exports.ClassifierDetailedJobOut$outboundSchema = exports.ClassifierDetailedJobOut$inboundSchema = exports.ClassifierDetailedJobOutJobType$ = exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema = exports.ClassifierDetailedJobOutIntegrations$ = exports.ClassifierDetailedJobOutIntegrations$outboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema = exports.ClassifierDetailedJobOutObject$ = exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema = exports.ClassifierDetailedJobOutStatus$ = exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema = exports.ClassifierDetailedJobOutJobType = exports.ClassifierDetailedJobOutObject = exports.ClassifierDetailedJobOutStatus = void 0; - exports.classifierDetailedJobOutIntegrationsToJSON = classifierDetailedJobOutIntegrationsToJSON; - exports.classifierDetailedJobOutIntegrationsFromJSON = classifierDetailedJobOutIntegrationsFromJSON; - exports.classifierDetailedJobOutToJSON = classifierDetailedJobOutToJSON; - exports.classifierDetailedJobOutFromJSON = classifierDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var eventout_js_1 = require_eventout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierDetailedJobOutObject = { - Job: "job" - }; - exports.ClassifierDetailedJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutStatus); - exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - var ClassifierDetailedJobOutStatus$; - (function(ClassifierDetailedJobOutStatus$2) { - ClassifierDetailedJobOutStatus$2.inboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - ClassifierDetailedJobOutStatus$2.outboundSchema = exports.ClassifierDetailedJobOutStatus$outboundSchema; - })(ClassifierDetailedJobOutStatus$ || (exports.ClassifierDetailedJobOutStatus$ = ClassifierDetailedJobOutStatus$ = {})); - exports.ClassifierDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutObject); - exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - var ClassifierDetailedJobOutObject$; - (function(ClassifierDetailedJobOutObject$2) { - ClassifierDetailedJobOutObject$2.inboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - ClassifierDetailedJobOutObject$2.outboundSchema = exports.ClassifierDetailedJobOutObject$outboundSchema; - })(ClassifierDetailedJobOutObject$ || (exports.ClassifierDetailedJobOutObject$ = ClassifierDetailedJobOutObject$ = {})); - exports.ClassifierDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierDetailedJobOutIntegrations$; - (function(ClassifierDetailedJobOutIntegrations$2) { - ClassifierDetailedJobOutIntegrations$2.inboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema; - ClassifierDetailedJobOutIntegrations$2.outboundSchema = exports.ClassifierDetailedJobOutIntegrations$outboundSchema; - })(ClassifierDetailedJobOutIntegrations$ || (exports.ClassifierDetailedJobOutIntegrations$ = ClassifierDetailedJobOutIntegrations$ = {})); - function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations) { - return JSON.stringify(exports.ClassifierDetailedJobOutIntegrations$outboundSchema.parse(classifierDetailedJobOutIntegrations)); - } - function classifierDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOutIntegrations' from JSON`); - } - exports.ClassifierDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutJobType); - exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - var ClassifierDetailedJobOutJobType$; - (function(ClassifierDetailedJobOutJobType$2) { - ClassifierDetailedJobOutJobType$2.inboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - ClassifierDetailedJobOutJobType$2.outboundSchema = exports.ClassifierDetailedJobOutJobType$outboundSchema; - })(ClassifierDetailedJobOutJobType$ || (exports.ClassifierDetailedJobOutJobType$ = ClassifierDetailedJobOutJobType$ = {})); - exports.ClassifierDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierDetailedJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema, - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.ClassifierDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierDetailedJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema, - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var ClassifierDetailedJobOut$; - (function(ClassifierDetailedJobOut$2) { - ClassifierDetailedJobOut$2.inboundSchema = exports.ClassifierDetailedJobOut$inboundSchema; - ClassifierDetailedJobOut$2.outboundSchema = exports.ClassifierDetailedJobOut$outboundSchema; - })(ClassifierDetailedJobOut$ || (exports.ClassifierDetailedJobOut$ = ClassifierDetailedJobOut$ = {})); - function classifierDetailedJobOutToJSON(classifierDetailedJobOut) { - return JSON.stringify(exports.ClassifierDetailedJobOut$outboundSchema.parse(classifierDetailedJobOut)); - } - function classifierDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js - var require_ftmodelcapabilitiesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCapabilitiesOut$ = exports.FTModelCapabilitiesOut$outboundSchema = exports.FTModelCapabilitiesOut$inboundSchema = void 0; - exports.ftModelCapabilitiesOutToJSON = ftModelCapabilitiesOutToJSON; - exports.ftModelCapabilitiesOutFromJSON = ftModelCapabilitiesOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FTModelCapabilitiesOut$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(false), - fine_tuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.FTModelCapabilitiesOut$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(false), - fineTuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var FTModelCapabilitiesOut$; - (function(FTModelCapabilitiesOut$2) { - FTModelCapabilitiesOut$2.inboundSchema = exports.FTModelCapabilitiesOut$inboundSchema; - FTModelCapabilitiesOut$2.outboundSchema = exports.FTModelCapabilitiesOut$outboundSchema; - })(FTModelCapabilitiesOut$ || (exports.FTModelCapabilitiesOut$ = FTModelCapabilitiesOut$ = {})); - function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut) { - return JSON.stringify(exports.FTModelCapabilitiesOut$outboundSchema.parse(ftModelCapabilitiesOut)); - } - function ftModelCapabilitiesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCapabilitiesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCapabilitiesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js - var require_classifierftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierFTModelOut$ = exports.ClassifierFTModelOut$outboundSchema = exports.ClassifierFTModelOut$inboundSchema = exports.ClassifierFTModelOutModelType$ = exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema = exports.ClassifierFTModelOutObject$ = exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema = exports.ClassifierFTModelOutModelType = exports.ClassifierFTModelOutObject = void 0; - exports.classifierFTModelOutToJSON = classifierFTModelOutToJSON; - exports.classifierFTModelOutFromJSON = classifierFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.ClassifierFTModelOutObject = { - Model: "model" - }; - exports.ClassifierFTModelOutModelType = { - Classifier: "classifier" - }; - exports.ClassifierFTModelOutObject$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutObject); - exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - var ClassifierFTModelOutObject$; - (function(ClassifierFTModelOutObject$2) { - ClassifierFTModelOutObject$2.inboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - ClassifierFTModelOutObject$2.outboundSchema = exports.ClassifierFTModelOutObject$outboundSchema; - })(ClassifierFTModelOutObject$ || (exports.ClassifierFTModelOutObject$ = ClassifierFTModelOutObject$ = {})); - exports.ClassifierFTModelOutModelType$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutModelType); - exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - var ClassifierFTModelOutModelType$; - (function(ClassifierFTModelOutModelType$2) { - ClassifierFTModelOutModelType$2.inboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - ClassifierFTModelOutModelType$2.outboundSchema = exports.ClassifierFTModelOutModelType$outboundSchema; - })(ClassifierFTModelOutModelType$ || (exports.ClassifierFTModelOutModelType$ = ClassifierFTModelOutModelType$ = {})); - exports.ClassifierFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema), - model_type: exports.ClassifierFTModelOutModelType$inboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "classifier_targets": "classifierTargets", - "model_type": "modelType" - }); - }); - exports.ClassifierFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema), - modelType: exports.ClassifierFTModelOutModelType$outboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - classifierTargets: "classifier_targets", - modelType: "model_type" - }); - }); - var ClassifierFTModelOut$; - (function(ClassifierFTModelOut$2) { - ClassifierFTModelOut$2.inboundSchema = exports.ClassifierFTModelOut$inboundSchema; - ClassifierFTModelOut$2.outboundSchema = exports.ClassifierFTModelOut$outboundSchema; - })(ClassifierFTModelOut$ || (exports.ClassifierFTModelOut$ = ClassifierFTModelOut$ = {})); - function classifierFTModelOutToJSON(classifierFTModelOut) { - return JSON.stringify(exports.ClassifierFTModelOut$outboundSchema.parse(classifierFTModelOut)); - } - function classifierFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierjobout.js - var require_classifierjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierJobOut$ = exports.ClassifierJobOut$outboundSchema = exports.ClassifierJobOut$inboundSchema = exports.ClassifierJobOutJobType$ = exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema = exports.ClassifierJobOutIntegrations$ = exports.ClassifierJobOutIntegrations$outboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema = exports.ClassifierJobOutObject$ = exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema = exports.ClassifierJobOutStatus$ = exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema = exports.ClassifierJobOutJobType = exports.ClassifierJobOutObject = exports.ClassifierJobOutStatus = void 0; - exports.classifierJobOutIntegrationsToJSON = classifierJobOutIntegrationsToJSON; - exports.classifierJobOutIntegrationsFromJSON = classifierJobOutIntegrationsFromJSON; - exports.classifierJobOutToJSON = classifierJobOutToJSON; - exports.classifierJobOutFromJSON = classifierJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierJobOutObject = { - Job: "job" - }; - exports.ClassifierJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierJobOutStatus); - exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - var ClassifierJobOutStatus$; - (function(ClassifierJobOutStatus$2) { - ClassifierJobOutStatus$2.inboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - ClassifierJobOutStatus$2.outboundSchema = exports.ClassifierJobOutStatus$outboundSchema; - })(ClassifierJobOutStatus$ || (exports.ClassifierJobOutStatus$ = ClassifierJobOutStatus$ = {})); - exports.ClassifierJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierJobOutObject); - exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema; - var ClassifierJobOutObject$; - (function(ClassifierJobOutObject$2) { - ClassifierJobOutObject$2.inboundSchema = exports.ClassifierJobOutObject$inboundSchema; - ClassifierJobOutObject$2.outboundSchema = exports.ClassifierJobOutObject$outboundSchema; - })(ClassifierJobOutObject$ || (exports.ClassifierJobOutObject$ = ClassifierJobOutObject$ = {})); - exports.ClassifierJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierJobOutIntegrations$; - (function(ClassifierJobOutIntegrations$2) { - ClassifierJobOutIntegrations$2.inboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema; - ClassifierJobOutIntegrations$2.outboundSchema = exports.ClassifierJobOutIntegrations$outboundSchema; - })(ClassifierJobOutIntegrations$ || (exports.ClassifierJobOutIntegrations$ = ClassifierJobOutIntegrations$ = {})); - function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations) { - return JSON.stringify(exports.ClassifierJobOutIntegrations$outboundSchema.parse(classifierJobOutIntegrations)); - } - function classifierJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOutIntegrations' from JSON`); - } - exports.ClassifierJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierJobOutJobType); - exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - var ClassifierJobOutJobType$; - (function(ClassifierJobOutJobType$2) { - ClassifierJobOutJobType$2.inboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - ClassifierJobOutJobType$2.outboundSchema = exports.ClassifierJobOutJobType$outboundSchema; - })(ClassifierJobOutJobType$ || (exports.ClassifierJobOutJobType$ = ClassifierJobOutJobType$ = {})); - exports.ClassifierJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.ClassifierJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var ClassifierJobOut$; - (function(ClassifierJobOut$2) { - ClassifierJobOut$2.inboundSchema = exports.ClassifierJobOut$inboundSchema; - ClassifierJobOut$2.outboundSchema = exports.ClassifierJobOut$outboundSchema; - })(ClassifierJobOut$ || (exports.ClassifierJobOut$ = ClassifierJobOut$ = {})); - function classifierJobOutToJSON(classifierJobOut) { - return JSON.stringify(exports.ClassifierJobOut$outboundSchema.parse(classifierJobOut)); - } - function classifierJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetin.js - var require_classifiertargetin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetIn$ = exports.ClassifierTargetIn$outboundSchema = exports.ClassifierTargetIn$inboundSchema = void 0; - exports.classifierTargetInToJSON = classifierTargetInToJSON; - exports.classifierTargetInFromJSON = classifierTargetInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetIn$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - loss_function: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetIn$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - lossFunction: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetIn$; - (function(ClassifierTargetIn$2) { - ClassifierTargetIn$2.inboundSchema = exports.ClassifierTargetIn$inboundSchema; - ClassifierTargetIn$2.outboundSchema = exports.ClassifierTargetIn$outboundSchema; - })(ClassifierTargetIn$ || (exports.ClassifierTargetIn$ = ClassifierTargetIn$ = {})); - function classifierTargetInToJSON(classifierTargetIn) { - return JSON.stringify(exports.ClassifierTargetIn$outboundSchema.parse(classifierTargetIn)); - } - function classifierTargetInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js - var require_classifiertrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParametersIn$ = exports.ClassifierTrainingParametersIn$outboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema = void 0; - exports.classifierTrainingParametersInToJSON = classifierTrainingParametersInToJSON; - exports.classifierTrainingParametersInFromJSON = classifierTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParametersIn$; - (function(ClassifierTrainingParametersIn$2) { - ClassifierTrainingParametersIn$2.inboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema; - ClassifierTrainingParametersIn$2.outboundSchema = exports.ClassifierTrainingParametersIn$outboundSchema; - })(ClassifierTrainingParametersIn$ || (exports.ClassifierTrainingParametersIn$ = ClassifierTrainingParametersIn$ = {})); - function classifierTrainingParametersInToJSON(classifierTrainingParametersIn) { - return JSON.stringify(exports.ClassifierTrainingParametersIn$outboundSchema.parse(classifierTrainingParametersIn)); - } - function classifierTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deltamessage.js - var require_deltamessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deltamessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeltaMessage$ = exports.DeltaMessage$outboundSchema = exports.DeltaMessage$inboundSchema = exports.Content$ = exports.Content$outboundSchema = exports.Content$inboundSchema = void 0; - exports.contentToJSON = contentToJSON; - exports.contentFromJSON = contentFromJSON; - exports.deltaMessageToJSON = deltaMessageToJSON; - exports.deltaMessageFromJSON = deltaMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.Content$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.Content$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var Content$; - (function(Content$2) { - Content$2.inboundSchema = exports.Content$inboundSchema; - Content$2.outboundSchema = exports.Content$outboundSchema; - })(Content$ || (exports.Content$ = Content$ = {})); - function contentToJSON(content) { - return JSON.stringify(exports.Content$outboundSchema.parse(content)); - } - function contentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Content$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Content' from JSON`); - } - exports.DeltaMessage$inboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.DeltaMessage$outboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var DeltaMessage$; - (function(DeltaMessage$2) { - DeltaMessage$2.inboundSchema = exports.DeltaMessage$inboundSchema; - DeltaMessage$2.outboundSchema = exports.DeltaMessage$outboundSchema; - })(DeltaMessage$ || (exports.DeltaMessage$ = DeltaMessage$ = {})); - function deltaMessageToJSON(deltaMessage) { - return JSON.stringify(exports.DeltaMessage$outboundSchema.parse(deltaMessage)); - } - function deltaMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeltaMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeltaMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js - var require_completionresponsestreamchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionResponseStreamChoice$ = exports.CompletionResponseStreamChoice$outboundSchema = exports.CompletionResponseStreamChoice$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$ = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason = void 0; - exports.completionResponseStreamChoiceToJSON = completionResponseStreamChoiceToJSON; - exports.completionResponseStreamChoiceFromJSON = completionResponseStreamChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var deltamessage_js_1 = require_deltamessage(); - exports.CompletionResponseStreamChoiceFinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().and(z.custom()) - ]); - var CompletionResponseStreamChoiceFinishReason$; - (function(CompletionResponseStreamChoiceFinishReason$2) { - CompletionResponseStreamChoiceFinishReason$2.inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema; - CompletionResponseStreamChoiceFinishReason$2.outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema; - })(CompletionResponseStreamChoiceFinishReason$ || (exports.CompletionResponseStreamChoiceFinishReason$ = CompletionResponseStreamChoiceFinishReason$ = {})); - exports.CompletionResponseStreamChoice$inboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$inboundSchema, - finish_reason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.CompletionResponseStreamChoice$outboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$outboundSchema, - finishReason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var CompletionResponseStreamChoice$; - (function(CompletionResponseStreamChoice$2) { - CompletionResponseStreamChoice$2.inboundSchema = exports.CompletionResponseStreamChoice$inboundSchema; - CompletionResponseStreamChoice$2.outboundSchema = exports.CompletionResponseStreamChoice$outboundSchema; - })(CompletionResponseStreamChoice$ || (exports.CompletionResponseStreamChoice$ = CompletionResponseStreamChoice$ = {})); - function completionResponseStreamChoiceToJSON(completionResponseStreamChoice) { - return JSON.stringify(exports.CompletionResponseStreamChoice$outboundSchema.parse(completionResponseStreamChoice)); - } - function completionResponseStreamChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionResponseStreamChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionchunk.js - var require_completionchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionChunk$ = exports.CompletionChunk$outboundSchema = exports.CompletionChunk$inboundSchema = void 0; - exports.completionChunkToJSON = completionChunkToJSON; - exports.completionChunkFromJSON = completionChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionresponsestreamchoice_js_1 = require_completionresponsestreamchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.CompletionChunk$inboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$inboundSchema) - }); - exports.CompletionChunk$outboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$outboundSchema) - }); - var CompletionChunk$; - (function(CompletionChunk$2) { - CompletionChunk$2.inboundSchema = exports.CompletionChunk$inboundSchema; - CompletionChunk$2.outboundSchema = exports.CompletionChunk$outboundSchema; - })(CompletionChunk$ || (exports.CompletionChunk$ = CompletionChunk$ = {})); - function completionChunkToJSON(completionChunk) { - return JSON.stringify(exports.CompletionChunk$outboundSchema.parse(completionChunk)); - } - function completionChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js - var require_completiontrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParameters$ = exports.CompletionTrainingParameters$outboundSchema = exports.CompletionTrainingParameters$inboundSchema = void 0; - exports.completionTrainingParametersToJSON = completionTrainingParametersToJSON; - exports.completionTrainingParametersFromJSON = completionTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParameters$; - (function(CompletionTrainingParameters$2) { - CompletionTrainingParameters$2.inboundSchema = exports.CompletionTrainingParameters$inboundSchema; - CompletionTrainingParameters$2.outboundSchema = exports.CompletionTrainingParameters$outboundSchema; - })(CompletionTrainingParameters$ || (exports.CompletionTrainingParameters$ = CompletionTrainingParameters$ = {})); - function completionTrainingParametersToJSON(completionTrainingParameters) { - return JSON.stringify(exports.CompletionTrainingParameters$outboundSchema.parse(completionTrainingParameters)); - } - function completionTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js - var require_githubrepositoryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryOut$ = exports.GithubRepositoryOut$outboundSchema = exports.GithubRepositoryOut$inboundSchema = exports.GithubRepositoryOutType$ = exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema = exports.GithubRepositoryOutType = void 0; - exports.githubRepositoryOutToJSON = githubRepositoryOutToJSON; - exports.githubRepositoryOutFromJSON = githubRepositoryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryOutType = { - Github: "github" - }; - exports.GithubRepositoryOutType$inboundSchema = z.nativeEnum(exports.GithubRepositoryOutType); - exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema; - var GithubRepositoryOutType$; - (function(GithubRepositoryOutType$2) { - GithubRepositoryOutType$2.inboundSchema = exports.GithubRepositoryOutType$inboundSchema; - GithubRepositoryOutType$2.outboundSchema = exports.GithubRepositoryOutType$outboundSchema; - })(GithubRepositoryOutType$ || (exports.GithubRepositoryOutType$ = GithubRepositoryOutType$ = {})); - exports.GithubRepositoryOut$inboundSchema = z.object({ - type: exports.GithubRepositoryOutType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commit_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "commit_id": "commitId" - }); - }); - exports.GithubRepositoryOut$outboundSchema = z.object({ - type: exports.GithubRepositoryOutType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commitId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - commitId: "commit_id" - }); - }); - var GithubRepositoryOut$; - (function(GithubRepositoryOut$2) { - GithubRepositoryOut$2.inboundSchema = exports.GithubRepositoryOut$inboundSchema; - GithubRepositoryOut$2.outboundSchema = exports.GithubRepositoryOut$outboundSchema; - })(GithubRepositoryOut$ || (exports.GithubRepositoryOut$ = GithubRepositoryOut$ = {})); - function githubRepositoryOutToJSON(githubRepositoryOut) { - return JSON.stringify(exports.GithubRepositoryOut$outboundSchema.parse(githubRepositoryOut)); - } - function githubRepositoryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js - var require_completiondetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionDetailedJobOut$ = exports.CompletionDetailedJobOut$outboundSchema = exports.CompletionDetailedJobOut$inboundSchema = exports.CompletionDetailedJobOutRepositories$ = exports.CompletionDetailedJobOutRepositories$outboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema = exports.CompletionDetailedJobOutJobType$ = exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema = exports.CompletionDetailedJobOutIntegrations$ = exports.CompletionDetailedJobOutIntegrations$outboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema = exports.CompletionDetailedJobOutObject$ = exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema = exports.CompletionDetailedJobOutStatus$ = exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema = exports.CompletionDetailedJobOutJobType = exports.CompletionDetailedJobOutObject = exports.CompletionDetailedJobOutStatus = void 0; - exports.completionDetailedJobOutIntegrationsToJSON = completionDetailedJobOutIntegrationsToJSON; - exports.completionDetailedJobOutIntegrationsFromJSON = completionDetailedJobOutIntegrationsFromJSON; - exports.completionDetailedJobOutRepositoriesToJSON = completionDetailedJobOutRepositoriesToJSON; - exports.completionDetailedJobOutRepositoriesFromJSON = completionDetailedJobOutRepositoriesFromJSON; - exports.completionDetailedJobOutToJSON = completionDetailedJobOutToJSON; - exports.completionDetailedJobOutFromJSON = completionDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var eventout_js_1 = require_eventout(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.CompletionDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionDetailedJobOutObject = { - Job: "job" - }; - exports.CompletionDetailedJobOutJobType = { - Completion: "completion" - }; - exports.CompletionDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutStatus); - exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - var CompletionDetailedJobOutStatus$; - (function(CompletionDetailedJobOutStatus$2) { - CompletionDetailedJobOutStatus$2.inboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - CompletionDetailedJobOutStatus$2.outboundSchema = exports.CompletionDetailedJobOutStatus$outboundSchema; - })(CompletionDetailedJobOutStatus$ || (exports.CompletionDetailedJobOutStatus$ = CompletionDetailedJobOutStatus$ = {})); - exports.CompletionDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutObject); - exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - var CompletionDetailedJobOutObject$; - (function(CompletionDetailedJobOutObject$2) { - CompletionDetailedJobOutObject$2.inboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - CompletionDetailedJobOutObject$2.outboundSchema = exports.CompletionDetailedJobOutObject$outboundSchema; - })(CompletionDetailedJobOutObject$ || (exports.CompletionDetailedJobOutObject$ = CompletionDetailedJobOutObject$ = {})); - exports.CompletionDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.CompletionDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var CompletionDetailedJobOutIntegrations$; - (function(CompletionDetailedJobOutIntegrations$2) { - CompletionDetailedJobOutIntegrations$2.inboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema; - CompletionDetailedJobOutIntegrations$2.outboundSchema = exports.CompletionDetailedJobOutIntegrations$outboundSchema; - })(CompletionDetailedJobOutIntegrations$ || (exports.CompletionDetailedJobOutIntegrations$ = CompletionDetailedJobOutIntegrations$ = {})); - function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations) { - return JSON.stringify(exports.CompletionDetailedJobOutIntegrations$outboundSchema.parse(completionDetailedJobOutIntegrations)); - } - function completionDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutIntegrations' from JSON`); - } - exports.CompletionDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutJobType); - exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - var CompletionDetailedJobOutJobType$; - (function(CompletionDetailedJobOutJobType$2) { - CompletionDetailedJobOutJobType$2.inboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - CompletionDetailedJobOutJobType$2.outboundSchema = exports.CompletionDetailedJobOutJobType$outboundSchema; - })(CompletionDetailedJobOutJobType$ || (exports.CompletionDetailedJobOutJobType$ = CompletionDetailedJobOutJobType$ = {})); - exports.CompletionDetailedJobOutRepositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.CompletionDetailedJobOutRepositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var CompletionDetailedJobOutRepositories$; - (function(CompletionDetailedJobOutRepositories$2) { - CompletionDetailedJobOutRepositories$2.inboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema; - CompletionDetailedJobOutRepositories$2.outboundSchema = exports.CompletionDetailedJobOutRepositories$outboundSchema; - })(CompletionDetailedJobOutRepositories$ || (exports.CompletionDetailedJobOutRepositories$ = CompletionDetailedJobOutRepositories$ = {})); - function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories) { - return JSON.stringify(exports.CompletionDetailedJobOutRepositories$outboundSchema.parse(completionDetailedJobOutRepositories)); - } - function completionDetailedJobOutRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutRepositories' from JSON`); - } - exports.CompletionDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.CompletionDetailedJobOutJobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.CompletionDetailedJobOutJobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionDetailedJobOut$; - (function(CompletionDetailedJobOut$2) { - CompletionDetailedJobOut$2.inboundSchema = exports.CompletionDetailedJobOut$inboundSchema; - CompletionDetailedJobOut$2.outboundSchema = exports.CompletionDetailedJobOut$outboundSchema; - })(CompletionDetailedJobOut$ || (exports.CompletionDetailedJobOut$ = CompletionDetailedJobOut$ = {})); - function completionDetailedJobOutToJSON(completionDetailedJobOut) { - return JSON.stringify(exports.CompletionDetailedJobOut$outboundSchema.parse(completionDetailedJobOut)); - } - function completionDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionevent.js - var require_completionevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionEvent$ = exports.CompletionEvent$outboundSchema = exports.CompletionEvent$inboundSchema = void 0; - exports.completionEventToJSON = completionEventToJSON; - exports.completionEventFromJSON = completionEventFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionchunk_js_1 = require_completionchunk(); - exports.CompletionEvent$inboundSchema = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(completionchunk_js_1.CompletionChunk$inboundSchema) - }); - exports.CompletionEvent$outboundSchema = z.object({ - data: completionchunk_js_1.CompletionChunk$outboundSchema - }); - var CompletionEvent$; - (function(CompletionEvent$2) { - CompletionEvent$2.inboundSchema = exports.CompletionEvent$inboundSchema; - CompletionEvent$2.outboundSchema = exports.CompletionEvent$outboundSchema; - })(CompletionEvent$ || (exports.CompletionEvent$ = CompletionEvent$ = {})); - function completionEventToJSON(completionEvent) { - return JSON.stringify(exports.CompletionEvent$outboundSchema.parse(completionEvent)); - } - function completionEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionftmodelout.js - var require_completionftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionFTModelOut$ = exports.CompletionFTModelOut$outboundSchema = exports.CompletionFTModelOut$inboundSchema = exports.ModelType$ = exports.ModelType$outboundSchema = exports.ModelType$inboundSchema = exports.CompletionFTModelOutObject$ = exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema = exports.ModelType = exports.CompletionFTModelOutObject = void 0; - exports.completionFTModelOutToJSON = completionFTModelOutToJSON; - exports.completionFTModelOutFromJSON = completionFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.CompletionFTModelOutObject = { - Model: "model" - }; - exports.ModelType = { - Completion: "completion" - }; - exports.CompletionFTModelOutObject$inboundSchema = z.nativeEnum(exports.CompletionFTModelOutObject); - exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - var CompletionFTModelOutObject$; - (function(CompletionFTModelOutObject$2) { - CompletionFTModelOutObject$2.inboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - CompletionFTModelOutObject$2.outboundSchema = exports.CompletionFTModelOutObject$outboundSchema; - })(CompletionFTModelOutObject$ || (exports.CompletionFTModelOutObject$ = CompletionFTModelOutObject$ = {})); - exports.ModelType$inboundSchema = z.nativeEnum(exports.ModelType); - exports.ModelType$outboundSchema = exports.ModelType$inboundSchema; - var ModelType$; - (function(ModelType$2) { - ModelType$2.inboundSchema = exports.ModelType$inboundSchema; - ModelType$2.outboundSchema = exports.ModelType$outboundSchema; - })(ModelType$ || (exports.ModelType$ = ModelType$ = {})); - exports.CompletionFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - model_type: exports.ModelType$inboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "model_type": "modelType" - }); - }); - exports.CompletionFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - modelType: exports.ModelType$outboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - modelType: "model_type" - }); - }); - var CompletionFTModelOut$; - (function(CompletionFTModelOut$2) { - CompletionFTModelOut$2.inboundSchema = exports.CompletionFTModelOut$inboundSchema; - CompletionFTModelOut$2.outboundSchema = exports.CompletionFTModelOut$outboundSchema; - })(CompletionFTModelOut$ || (exports.CompletionFTModelOut$ = CompletionFTModelOut$ = {})); - function completionFTModelOutToJSON(completionFTModelOut) { - return JSON.stringify(exports.CompletionFTModelOut$outboundSchema.parse(completionFTModelOut)); - } - function completionFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionjobout.js - var require_completionjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionJobOut$ = exports.CompletionJobOut$outboundSchema = exports.CompletionJobOut$inboundSchema = exports.Repositories$ = exports.Repositories$outboundSchema = exports.Repositories$inboundSchema = exports.JobType$ = exports.JobType$outboundSchema = exports.JobType$inboundSchema = exports.Integrations$ = exports.Integrations$outboundSchema = exports.Integrations$inboundSchema = exports.CompletionJobOutObject$ = exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.JobType = exports.CompletionJobOutObject = exports.Status = void 0; - exports.integrationsToJSON = integrationsToJSON; - exports.integrationsFromJSON = integrationsFromJSON; - exports.repositoriesToJSON = repositoriesToJSON; - exports.repositoriesFromJSON = repositoriesFromJSON; - exports.completionJobOutToJSON = completionJobOutToJSON; - exports.completionJobOutFromJSON = completionJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionJobOutObject = { - Job: "job" - }; - exports.JobType = { - Completion: "completion" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.CompletionJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionJobOutObject); - exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema; - var CompletionJobOutObject$; - (function(CompletionJobOutObject$2) { - CompletionJobOutObject$2.inboundSchema = exports.CompletionJobOutObject$inboundSchema; - CompletionJobOutObject$2.outboundSchema = exports.CompletionJobOutObject$outboundSchema; - })(CompletionJobOutObject$ || (exports.CompletionJobOutObject$ = CompletionJobOutObject$ = {})); - exports.Integrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.Integrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var Integrations$; - (function(Integrations$2) { - Integrations$2.inboundSchema = exports.Integrations$inboundSchema; - Integrations$2.outboundSchema = exports.Integrations$outboundSchema; - })(Integrations$ || (exports.Integrations$ = Integrations$ = {})); - function integrationsToJSON(integrations) { - return JSON.stringify(exports.Integrations$outboundSchema.parse(integrations)); - } - function integrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Integrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Integrations' from JSON`); - } - exports.JobType$inboundSchema = z.nativeEnum(exports.JobType); - exports.JobType$outboundSchema = exports.JobType$inboundSchema; - var JobType$; - (function(JobType$2) { - JobType$2.inboundSchema = exports.JobType$inboundSchema; - JobType$2.outboundSchema = exports.JobType$outboundSchema; - })(JobType$ || (exports.JobType$ = JobType$ = {})); - exports.Repositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.Repositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var Repositories$; - (function(Repositories$2) { - Repositories$2.inboundSchema = exports.Repositories$inboundSchema; - Repositories$2.outboundSchema = exports.Repositories$outboundSchema; - })(Repositories$ || (exports.Repositories$ = Repositories$ = {})); - function repositoriesToJSON(repositories) { - return JSON.stringify(exports.Repositories$outboundSchema.parse(repositories)); - } - function repositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Repositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Repositories' from JSON`); - } - exports.CompletionJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.Status$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.JobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.Status$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.JobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionJobOut$; - (function(CompletionJobOut$2) { - CompletionJobOut$2.inboundSchema = exports.CompletionJobOut$inboundSchema; - CompletionJobOut$2.outboundSchema = exports.CompletionJobOut$outboundSchema; - })(CompletionJobOut$ || (exports.CompletionJobOut$ = CompletionJobOut$ = {})); - function completionJobOutToJSON(completionJobOut) { - return JSON.stringify(exports.CompletionJobOut$outboundSchema.parse(completionJobOut)); - } - function completionJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js - var require_completiontrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParametersIn$ = exports.CompletionTrainingParametersIn$outboundSchema = exports.CompletionTrainingParametersIn$inboundSchema = void 0; - exports.completionTrainingParametersInToJSON = completionTrainingParametersInToJSON; - exports.completionTrainingParametersInFromJSON = completionTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParametersIn$; - (function(CompletionTrainingParametersIn$2) { - CompletionTrainingParametersIn$2.inboundSchema = exports.CompletionTrainingParametersIn$inboundSchema; - CompletionTrainingParametersIn$2.outboundSchema = exports.CompletionTrainingParametersIn$outboundSchema; - })(CompletionTrainingParametersIn$ || (exports.CompletionTrainingParametersIn$ = CompletionTrainingParametersIn$ = {})); - function completionTrainingParametersInToJSON(completionTrainingParametersIn) { - return JSON.stringify(exports.CompletionTrainingParametersIn$outboundSchema.parse(completionTrainingParametersIn)); - } - function completionTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js - var require_functioncallentryarguments = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntryArguments$ = exports.FunctionCallEntryArguments$outboundSchema = exports.FunctionCallEntryArguments$inboundSchema = void 0; - exports.functionCallEntryArgumentsToJSON = functionCallEntryArgumentsToJSON; - exports.functionCallEntryArgumentsFromJSON = functionCallEntryArgumentsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEntryArguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.FunctionCallEntryArguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var FunctionCallEntryArguments$; - (function(FunctionCallEntryArguments$2) { - FunctionCallEntryArguments$2.inboundSchema = exports.FunctionCallEntryArguments$inboundSchema; - FunctionCallEntryArguments$2.outboundSchema = exports.FunctionCallEntryArguments$outboundSchema; - })(FunctionCallEntryArguments$ || (exports.FunctionCallEntryArguments$ = FunctionCallEntryArguments$ = {})); - function functionCallEntryArgumentsToJSON(functionCallEntryArguments) { - return JSON.stringify(exports.FunctionCallEntryArguments$outboundSchema.parse(functionCallEntryArguments)); - } - function functionCallEntryArgumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntryArguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntryArguments' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentry.js - var require_functioncallentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntry$ = exports.FunctionCallEntry$outboundSchema = exports.FunctionCallEntry$inboundSchema = exports.FunctionCallEntryType$ = exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema = exports.FunctionCallEntryObject$ = exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema = exports.FunctionCallEntryType = exports.FunctionCallEntryObject = void 0; - exports.functionCallEntryToJSON = functionCallEntryToJSON; - exports.functionCallEntryFromJSON = functionCallEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var functioncallentryarguments_js_1 = require_functioncallentryarguments(); - exports.FunctionCallEntryObject = { - Entry: "entry" - }; - exports.FunctionCallEntryType = { - FunctionCall: "function.call" - }; - exports.FunctionCallEntryObject$inboundSchema = z.nativeEnum(exports.FunctionCallEntryObject); - exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema; - var FunctionCallEntryObject$; - (function(FunctionCallEntryObject$2) { - FunctionCallEntryObject$2.inboundSchema = exports.FunctionCallEntryObject$inboundSchema; - FunctionCallEntryObject$2.outboundSchema = exports.FunctionCallEntryObject$outboundSchema; - })(FunctionCallEntryObject$ || (exports.FunctionCallEntryObject$ = FunctionCallEntryObject$ = {})); - exports.FunctionCallEntryType$inboundSchema = z.nativeEnum(exports.FunctionCallEntryType); - exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema; - var FunctionCallEntryType$; - (function(FunctionCallEntryType$2) { - FunctionCallEntryType$2.inboundSchema = exports.FunctionCallEntryType$inboundSchema; - FunctionCallEntryType$2.outboundSchema = exports.FunctionCallEntryType$outboundSchema; - })(FunctionCallEntryType$ || (exports.FunctionCallEntryType$ = FunctionCallEntryType$ = {})); - exports.FunctionCallEntry$inboundSchema = z.object({ - object: exports.FunctionCallEntryObject$inboundSchema.default("entry"), - type: exports.FunctionCallEntryType$inboundSchema.default("function.call"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEntry$outboundSchema = z.object({ - object: exports.FunctionCallEntryObject$outboundSchema.default("entry"), - type: exports.FunctionCallEntryType$outboundSchema.default("function.call"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEntry$; - (function(FunctionCallEntry$2) { - FunctionCallEntry$2.inboundSchema = exports.FunctionCallEntry$inboundSchema; - FunctionCallEntry$2.outboundSchema = exports.FunctionCallEntry$outboundSchema; - })(FunctionCallEntry$ || (exports.FunctionCallEntry$ = FunctionCallEntry$ = {})); - function functionCallEntryToJSON(functionCallEntry) { - return JSON.stringify(exports.FunctionCallEntry$outboundSchema.parse(functionCallEntry)); - } - function functionCallEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionresultentry.js - var require_functionresultentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionresultentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionResultEntry$ = exports.FunctionResultEntry$outboundSchema = exports.FunctionResultEntry$inboundSchema = exports.FunctionResultEntryType$ = exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema = exports.FunctionResultEntryObject$ = exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema = exports.FunctionResultEntryType = exports.FunctionResultEntryObject = void 0; - exports.functionResultEntryToJSON = functionResultEntryToJSON; - exports.functionResultEntryFromJSON = functionResultEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionResultEntryObject = { - Entry: "entry" - }; - exports.FunctionResultEntryType = { - FunctionResult: "function.result" - }; - exports.FunctionResultEntryObject$inboundSchema = z.nativeEnum(exports.FunctionResultEntryObject); - exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema; - var FunctionResultEntryObject$; - (function(FunctionResultEntryObject$2) { - FunctionResultEntryObject$2.inboundSchema = exports.FunctionResultEntryObject$inboundSchema; - FunctionResultEntryObject$2.outboundSchema = exports.FunctionResultEntryObject$outboundSchema; - })(FunctionResultEntryObject$ || (exports.FunctionResultEntryObject$ = FunctionResultEntryObject$ = {})); - exports.FunctionResultEntryType$inboundSchema = z.nativeEnum(exports.FunctionResultEntryType); - exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema; - var FunctionResultEntryType$; - (function(FunctionResultEntryType$2) { - FunctionResultEntryType$2.inboundSchema = exports.FunctionResultEntryType$inboundSchema; - FunctionResultEntryType$2.outboundSchema = exports.FunctionResultEntryType$outboundSchema; - })(FunctionResultEntryType$ || (exports.FunctionResultEntryType$ = FunctionResultEntryType$ = {})); - exports.FunctionResultEntry$inboundSchema = z.object({ - object: exports.FunctionResultEntryObject$inboundSchema.default("entry"), - type: exports.FunctionResultEntryType$inboundSchema.default("function.result"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionResultEntry$outboundSchema = z.object({ - object: exports.FunctionResultEntryObject$outboundSchema.default("entry"), - type: exports.FunctionResultEntryType$outboundSchema.default("function.result"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionResultEntry$; - (function(FunctionResultEntry$2) { - FunctionResultEntry$2.inboundSchema = exports.FunctionResultEntry$inboundSchema; - FunctionResultEntry$2.outboundSchema = exports.FunctionResultEntry$outboundSchema; - })(FunctionResultEntry$ || (exports.FunctionResultEntry$ = FunctionResultEntry$ = {})); - function functionResultEntryToJSON(functionResultEntry) { - return JSON.stringify(exports.FunctionResultEntry$outboundSchema.parse(functionResultEntry)); - } - function functionResultEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionResultEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionResultEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolfilechunk.js - var require_toolfilechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolfilechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolFileChunk$ = exports.ToolFileChunk$outboundSchema = exports.ToolFileChunk$inboundSchema = exports.ToolFileChunkType$ = exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema = exports.ToolFileChunkType = void 0; - exports.toolFileChunkToJSON = toolFileChunkToJSON; - exports.toolFileChunkFromJSON = toolFileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolFileChunkType = { - ToolFile: "tool_file" - }; - exports.ToolFileChunkType$inboundSchema = z.nativeEnum(exports.ToolFileChunkType); - exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema; - var ToolFileChunkType$; - (function(ToolFileChunkType$2) { - ToolFileChunkType$2.inboundSchema = exports.ToolFileChunkType$inboundSchema; - ToolFileChunkType$2.outboundSchema = exports.ToolFileChunkType$outboundSchema; - })(ToolFileChunkType$ || (exports.ToolFileChunkType$ = ToolFileChunkType$ = {})); - exports.ToolFileChunk$inboundSchema = z.object({ - type: exports.ToolFileChunkType$inboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - file_id: z.string(), - file_name: z.nullable(z.string()).optional(), - file_type: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId", - "file_name": "fileName", - "file_type": "fileType" - }); - }); - exports.ToolFileChunk$outboundSchema = z.object({ - type: exports.ToolFileChunkType$outboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - fileId: z.string(), - fileName: z.nullable(z.string()).optional(), - fileType: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id", - fileName: "file_name", - fileType: "file_type" - }); - }); - var ToolFileChunk$; - (function(ToolFileChunk$2) { - ToolFileChunk$2.inboundSchema = exports.ToolFileChunk$inboundSchema; - ToolFileChunk$2.outboundSchema = exports.ToolFileChunk$outboundSchema; - })(ToolFileChunk$ || (exports.ToolFileChunk$ = ToolFileChunk$ = {})); - function toolFileChunkToJSON(toolFileChunk) { - return JSON.stringify(exports.ToolFileChunk$outboundSchema.parse(toolFileChunk)); - } - function toolFileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolFileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolFileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js - var require_messageinputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputContentChunks$ = exports.MessageInputContentChunks$outboundSchema = exports.MessageInputContentChunks$inboundSchema = void 0; - exports.messageInputContentChunksToJSON = messageInputContentChunksToJSON; - exports.messageInputContentChunksFromJSON = messageInputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - exports.MessageInputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageInputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageInputContentChunks$; - (function(MessageInputContentChunks$2) { - MessageInputContentChunks$2.inboundSchema = exports.MessageInputContentChunks$inboundSchema; - MessageInputContentChunks$2.outboundSchema = exports.MessageInputContentChunks$outboundSchema; - })(MessageInputContentChunks$ || (exports.MessageInputContentChunks$ = MessageInputContentChunks$ = {})); - function messageInputContentChunksToJSON(messageInputContentChunks) { - return JSON.stringify(exports.MessageInputContentChunks$outboundSchema.parse(messageInputContentChunks)); - } - function messageInputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputentry.js - var require_messageinputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputEntry$ = exports.MessageInputEntry$outboundSchema = exports.MessageInputEntry$inboundSchema = exports.MessageInputEntryContent$ = exports.MessageInputEntryContent$outboundSchema = exports.MessageInputEntryContent$inboundSchema = exports.MessageInputEntryRole$ = exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema = exports.MessageInputEntryType$ = exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema = exports.ObjectT$ = exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema = exports.MessageInputEntryRole = exports.MessageInputEntryType = exports.ObjectT = void 0; - exports.messageInputEntryContentToJSON = messageInputEntryContentToJSON; - exports.messageInputEntryContentFromJSON = messageInputEntryContentFromJSON; - exports.messageInputEntryToJSON = messageInputEntryToJSON; - exports.messageInputEntryFromJSON = messageInputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageinputcontentchunks_js_1 = require_messageinputcontentchunks(); - exports.ObjectT = { - Entry: "entry" - }; - exports.MessageInputEntryType = { - MessageInput: "message.input" - }; - exports.MessageInputEntryRole = { - Assistant: "assistant", - User: "user" - }; - exports.ObjectT$inboundSchema = z.nativeEnum(exports.ObjectT); - exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema; - var ObjectT$; - (function(ObjectT$2) { - ObjectT$2.inboundSchema = exports.ObjectT$inboundSchema; - ObjectT$2.outboundSchema = exports.ObjectT$outboundSchema; - })(ObjectT$ || (exports.ObjectT$ = ObjectT$ = {})); - exports.MessageInputEntryType$inboundSchema = z.nativeEnum(exports.MessageInputEntryType); - exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema; - var MessageInputEntryType$; - (function(MessageInputEntryType$2) { - MessageInputEntryType$2.inboundSchema = exports.MessageInputEntryType$inboundSchema; - MessageInputEntryType$2.outboundSchema = exports.MessageInputEntryType$outboundSchema; - })(MessageInputEntryType$ || (exports.MessageInputEntryType$ = MessageInputEntryType$ = {})); - exports.MessageInputEntryRole$inboundSchema = z.nativeEnum(exports.MessageInputEntryRole); - exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema; - var MessageInputEntryRole$; - (function(MessageInputEntryRole$2) { - MessageInputEntryRole$2.inboundSchema = exports.MessageInputEntryRole$inboundSchema; - MessageInputEntryRole$2.outboundSchema = exports.MessageInputEntryRole$outboundSchema; - })(MessageInputEntryRole$ || (exports.MessageInputEntryRole$ = MessageInputEntryRole$ = {})); - exports.MessageInputEntryContent$inboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema)]); - exports.MessageInputEntryContent$outboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema)]); - var MessageInputEntryContent$; - (function(MessageInputEntryContent$2) { - MessageInputEntryContent$2.inboundSchema = exports.MessageInputEntryContent$inboundSchema; - MessageInputEntryContent$2.outboundSchema = exports.MessageInputEntryContent$outboundSchema; - })(MessageInputEntryContent$ || (exports.MessageInputEntryContent$ = MessageInputEntryContent$ = {})); - function messageInputEntryContentToJSON(messageInputEntryContent) { - return JSON.stringify(exports.MessageInputEntryContent$outboundSchema.parse(messageInputEntryContent)); - } - function messageInputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntryContent' from JSON`); - } - exports.MessageInputEntry$inboundSchema = z.object({ - object: exports.ObjectT$inboundSchema.default("entry"), - type: exports.MessageInputEntryType$inboundSchema.default("message.input"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$inboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.MessageInputEntry$outboundSchema = z.object({ - object: exports.ObjectT$outboundSchema.default("entry"), - type: exports.MessageInputEntryType$outboundSchema.default("message.input"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$outboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var MessageInputEntry$; - (function(MessageInputEntry$2) { - MessageInputEntry$2.inboundSchema = exports.MessageInputEntry$inboundSchema; - MessageInputEntry$2.outboundSchema = exports.MessageInputEntry$outboundSchema; - })(MessageInputEntry$ || (exports.MessageInputEntry$ = MessageInputEntry$ = {})); - function messageInputEntryToJSON(messageInputEntry) { - return JSON.stringify(exports.MessageInputEntry$outboundSchema.parse(messageInputEntry)); - } - function messageInputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js - var require_toolreferencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolReferenceChunk$ = exports.ToolReferenceChunk$outboundSchema = exports.ToolReferenceChunk$inboundSchema = exports.ToolReferenceChunkType$ = exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema = exports.ToolReferenceChunkType = void 0; - exports.toolReferenceChunkToJSON = toolReferenceChunkToJSON; - exports.toolReferenceChunkFromJSON = toolReferenceChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolReferenceChunkType = { - ToolReference: "tool_reference" - }; - exports.ToolReferenceChunkType$inboundSchema = z.nativeEnum(exports.ToolReferenceChunkType); - exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema; - var ToolReferenceChunkType$; - (function(ToolReferenceChunkType$2) { - ToolReferenceChunkType$2.inboundSchema = exports.ToolReferenceChunkType$inboundSchema; - ToolReferenceChunkType$2.outboundSchema = exports.ToolReferenceChunkType$outboundSchema; - })(ToolReferenceChunkType$ || (exports.ToolReferenceChunkType$ = ToolReferenceChunkType$ = {})); - exports.ToolReferenceChunk$inboundSchema = z.object({ - type: exports.ToolReferenceChunkType$inboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.ToolReferenceChunk$outboundSchema = z.object({ - type: exports.ToolReferenceChunkType$outboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var ToolReferenceChunk$; - (function(ToolReferenceChunk$2) { - ToolReferenceChunk$2.inboundSchema = exports.ToolReferenceChunk$inboundSchema; - ToolReferenceChunk$2.outboundSchema = exports.ToolReferenceChunk$outboundSchema; - })(ToolReferenceChunk$ || (exports.ToolReferenceChunk$ = ToolReferenceChunk$ = {})); - function toolReferenceChunkToJSON(toolReferenceChunk) { - return JSON.stringify(exports.ToolReferenceChunk$outboundSchema.parse(toolReferenceChunk)); - } - function toolReferenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js - var require_messageoutputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputContentChunks$ = exports.MessageOutputContentChunks$outboundSchema = exports.MessageOutputContentChunks$inboundSchema = void 0; - exports.messageOutputContentChunksToJSON = messageOutputContentChunksToJSON; - exports.messageOutputContentChunksFromJSON = messageOutputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.MessageOutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageOutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageOutputContentChunks$; - (function(MessageOutputContentChunks$2) { - MessageOutputContentChunks$2.inboundSchema = exports.MessageOutputContentChunks$inboundSchema; - MessageOutputContentChunks$2.outboundSchema = exports.MessageOutputContentChunks$outboundSchema; - })(MessageOutputContentChunks$ || (exports.MessageOutputContentChunks$ = MessageOutputContentChunks$ = {})); - function messageOutputContentChunksToJSON(messageOutputContentChunks) { - return JSON.stringify(exports.MessageOutputContentChunks$outboundSchema.parse(messageOutputContentChunks)); - } - function messageOutputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputentry.js - var require_messageoutputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEntry$ = exports.MessageOutputEntry$outboundSchema = exports.MessageOutputEntry$inboundSchema = exports.MessageOutputEntryContent$ = exports.MessageOutputEntryContent$outboundSchema = exports.MessageOutputEntryContent$inboundSchema = exports.MessageOutputEntryRole$ = exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema = exports.MessageOutputEntryType$ = exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema = exports.MessageOutputEntryObject$ = exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema = exports.MessageOutputEntryRole = exports.MessageOutputEntryType = exports.MessageOutputEntryObject = void 0; - exports.messageOutputEntryContentToJSON = messageOutputEntryContentToJSON; - exports.messageOutputEntryContentFromJSON = messageOutputEntryContentFromJSON; - exports.messageOutputEntryToJSON = messageOutputEntryToJSON; - exports.messageOutputEntryFromJSON = messageOutputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageoutputcontentchunks_js_1 = require_messageoutputcontentchunks(); - exports.MessageOutputEntryObject = { - Entry: "entry" - }; - exports.MessageOutputEntryType = { - MessageOutput: "message.output" - }; - exports.MessageOutputEntryRole = { - Assistant: "assistant" - }; - exports.MessageOutputEntryObject$inboundSchema = z.nativeEnum(exports.MessageOutputEntryObject); - exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema; - var MessageOutputEntryObject$; - (function(MessageOutputEntryObject$2) { - MessageOutputEntryObject$2.inboundSchema = exports.MessageOutputEntryObject$inboundSchema; - MessageOutputEntryObject$2.outboundSchema = exports.MessageOutputEntryObject$outboundSchema; - })(MessageOutputEntryObject$ || (exports.MessageOutputEntryObject$ = MessageOutputEntryObject$ = {})); - exports.MessageOutputEntryType$inboundSchema = z.nativeEnum(exports.MessageOutputEntryType); - exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema; - var MessageOutputEntryType$; - (function(MessageOutputEntryType$2) { - MessageOutputEntryType$2.inboundSchema = exports.MessageOutputEntryType$inboundSchema; - MessageOutputEntryType$2.outboundSchema = exports.MessageOutputEntryType$outboundSchema; - })(MessageOutputEntryType$ || (exports.MessageOutputEntryType$ = MessageOutputEntryType$ = {})); - exports.MessageOutputEntryRole$inboundSchema = z.nativeEnum(exports.MessageOutputEntryRole); - exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema; - var MessageOutputEntryRole$; - (function(MessageOutputEntryRole$2) { - MessageOutputEntryRole$2.inboundSchema = exports.MessageOutputEntryRole$inboundSchema; - MessageOutputEntryRole$2.outboundSchema = exports.MessageOutputEntryRole$outboundSchema; - })(MessageOutputEntryRole$ || (exports.MessageOutputEntryRole$ = MessageOutputEntryRole$ = {})); - exports.MessageOutputEntryContent$inboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema)]); - exports.MessageOutputEntryContent$outboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema)]); - var MessageOutputEntryContent$; - (function(MessageOutputEntryContent$2) { - MessageOutputEntryContent$2.inboundSchema = exports.MessageOutputEntryContent$inboundSchema; - MessageOutputEntryContent$2.outboundSchema = exports.MessageOutputEntryContent$outboundSchema; - })(MessageOutputEntryContent$ || (exports.MessageOutputEntryContent$ = MessageOutputEntryContent$ = {})); - function messageOutputEntryContentToJSON(messageOutputEntryContent) { - return JSON.stringify(exports.MessageOutputEntryContent$outboundSchema.parse(messageOutputEntryContent)); - } - function messageOutputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntryContent' from JSON`); - } - exports.MessageOutputEntry$inboundSchema = z.object({ - object: exports.MessageOutputEntryObject$inboundSchema.default("entry"), - type: exports.MessageOutputEntryType$inboundSchema.default("message.output"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$inboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEntry$outboundSchema = z.object({ - object: exports.MessageOutputEntryObject$outboundSchema.default("entry"), - type: exports.MessageOutputEntryType$outboundSchema.default("message.output"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$outboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - agentId: "agent_id" - }); - }); - var MessageOutputEntry$; - (function(MessageOutputEntry$2) { - MessageOutputEntry$2.inboundSchema = exports.MessageOutputEntry$inboundSchema; - MessageOutputEntry$2.outboundSchema = exports.MessageOutputEntry$outboundSchema; - })(MessageOutputEntry$ || (exports.MessageOutputEntry$ = MessageOutputEntry$ = {})); - function messageOutputEntryToJSON(messageOutputEntry) { - return JSON.stringify(exports.MessageOutputEntry$outboundSchema.parse(messageOutputEntry)); - } - function messageOutputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js - var require_toolexecutionentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionEntry$ = exports.ToolExecutionEntry$outboundSchema = exports.ToolExecutionEntry$inboundSchema = exports.ToolExecutionEntryType$ = exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema = exports.ToolExecutionEntryObject$ = exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema = exports.ToolExecutionEntryType = exports.ToolExecutionEntryObject = void 0; - exports.toolExecutionEntryToJSON = toolExecutionEntryToJSON; - exports.toolExecutionEntryFromJSON = toolExecutionEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionEntryObject = { - Entry: "entry" - }; - exports.ToolExecutionEntryType = { - ToolExecution: "tool.execution" - }; - exports.ToolExecutionEntryObject$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryObject); - exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - var ToolExecutionEntryObject$; - (function(ToolExecutionEntryObject$2) { - ToolExecutionEntryObject$2.inboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - ToolExecutionEntryObject$2.outboundSchema = exports.ToolExecutionEntryObject$outboundSchema; - })(ToolExecutionEntryObject$ || (exports.ToolExecutionEntryObject$ = ToolExecutionEntryObject$ = {})); - exports.ToolExecutionEntryType$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryType); - exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema; - var ToolExecutionEntryType$; - (function(ToolExecutionEntryType$2) { - ToolExecutionEntryType$2.inboundSchema = exports.ToolExecutionEntryType$inboundSchema; - ToolExecutionEntryType$2.outboundSchema = exports.ToolExecutionEntryType$outboundSchema; - })(ToolExecutionEntryType$ || (exports.ToolExecutionEntryType$ = ToolExecutionEntryType$ = {})); - exports.ToolExecutionEntry$inboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$inboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$inboundSchema.default("tool.execution"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.ToolExecutionEntry$outboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$outboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$outboundSchema.default("tool.execution"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var ToolExecutionEntry$; - (function(ToolExecutionEntry$2) { - ToolExecutionEntry$2.inboundSchema = exports.ToolExecutionEntry$inboundSchema; - ToolExecutionEntry$2.outboundSchema = exports.ToolExecutionEntry$outboundSchema; - })(ToolExecutionEntry$ || (exports.ToolExecutionEntry$ = ToolExecutionEntry$ = {})); - function toolExecutionEntryToJSON(toolExecutionEntry) { - return JSON.stringify(exports.ToolExecutionEntry$outboundSchema.parse(toolExecutionEntry)); - } - function toolExecutionEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputentries.js - var require_inputentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InputEntries$ = exports.InputEntries$outboundSchema = exports.InputEntries$inboundSchema = void 0; - exports.inputEntriesToJSON = inputEntriesToJSON; - exports.inputEntriesFromJSON = inputEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.InputEntries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.InputEntries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var InputEntries$; - (function(InputEntries$2) { - InputEntries$2.inboundSchema = exports.InputEntries$inboundSchema; - InputEntries$2.outboundSchema = exports.InputEntries$outboundSchema; - })(InputEntries$ || (exports.InputEntries$ = InputEntries$ = {})); - function inputEntriesToJSON(inputEntries) { - return JSON.stringify(exports.InputEntries$outboundSchema.parse(inputEntries)); - } - function inputEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InputEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InputEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationinputs.js - var require_conversationinputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationinputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationInputs$ = exports.ConversationInputs$outboundSchema = exports.ConversationInputs$inboundSchema = void 0; - exports.conversationInputsToJSON = conversationInputsToJSON; - exports.conversationInputsFromJSON = conversationInputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var inputentries_js_1 = require_inputentries(); - exports.ConversationInputs$inboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$inboundSchema)]); - exports.ConversationInputs$outboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$outboundSchema)]); - var ConversationInputs$; - (function(ConversationInputs$2) { - ConversationInputs$2.inboundSchema = exports.ConversationInputs$inboundSchema; - ConversationInputs$2.outboundSchema = exports.ConversationInputs$outboundSchema; - })(ConversationInputs$ || (exports.ConversationInputs$ = ConversationInputs$ = {})); - function conversationInputsToJSON(conversationInputs) { - return JSON.stringify(exports.ConversationInputs$outboundSchema.parse(conversationInputs)); - } - function conversationInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationInputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js - var require_conversationappendrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendRequest$ = exports.ConversationAppendRequest$outboundSchema = exports.ConversationAppendRequest$inboundSchema = exports.ConversationAppendRequestHandoffExecution$ = exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema = exports.ConversationAppendRequestHandoffExecution = void 0; - exports.conversationAppendRequestToJSON = conversationAppendRequestToJSON; - exports.conversationAppendRequestFromJSON = conversationAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendRequestHandoffExecution); - exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - var ConversationAppendRequestHandoffExecution$; - (function(ConversationAppendRequestHandoffExecution$2) { - ConversationAppendRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - ConversationAppendRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendRequestHandoffExecution$outboundSchema; - })(ConversationAppendRequestHandoffExecution$ || (exports.ConversationAppendRequestHandoffExecution$ = ConversationAppendRequestHandoffExecution$ = {})); - exports.ConversationAppendRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendRequest$; - (function(ConversationAppendRequest$2) { - ConversationAppendRequest$2.inboundSchema = exports.ConversationAppendRequest$inboundSchema; - ConversationAppendRequest$2.outboundSchema = exports.ConversationAppendRequest$outboundSchema; - })(ConversationAppendRequest$ || (exports.ConversationAppendRequest$ = ConversationAppendRequest$ = {})); - function conversationAppendRequestToJSON(conversationAppendRequest) { - return JSON.stringify(exports.ConversationAppendRequest$outboundSchema.parse(conversationAppendRequest)); - } - function conversationAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js - var require_conversationappendstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendStreamRequest$ = exports.ConversationAppendStreamRequest$outboundSchema = exports.ConversationAppendStreamRequest$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$ = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution = void 0; - exports.conversationAppendStreamRequestToJSON = conversationAppendStreamRequestToJSON; - exports.conversationAppendStreamRequestFromJSON = conversationAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendStreamRequestHandoffExecution); - exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - var ConversationAppendStreamRequestHandoffExecution$; - (function(ConversationAppendStreamRequestHandoffExecution$2) { - ConversationAppendStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - ConversationAppendStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema; - })(ConversationAppendStreamRequestHandoffExecution$ || (exports.ConversationAppendStreamRequestHandoffExecution$ = ConversationAppendStreamRequestHandoffExecution$ = {})); - exports.ConversationAppendStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendStreamRequest$; - (function(ConversationAppendStreamRequest$2) { - ConversationAppendStreamRequest$2.inboundSchema = exports.ConversationAppendStreamRequest$inboundSchema; - ConversationAppendStreamRequest$2.outboundSchema = exports.ConversationAppendStreamRequest$outboundSchema; - })(ConversationAppendStreamRequest$ || (exports.ConversationAppendStreamRequest$ = ConversationAppendStreamRequest$ = {})); - function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest) { - return JSON.stringify(exports.ConversationAppendStreamRequest$outboundSchema.parse(conversationAppendStreamRequest)); - } - function conversationAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallevent.js - var require_functioncallevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEvent$ = exports.FunctionCallEvent$outboundSchema = exports.FunctionCallEvent$inboundSchema = exports.FunctionCallEventType$ = exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema = exports.FunctionCallEventType = void 0; - exports.functionCallEventToJSON = functionCallEventToJSON; - exports.functionCallEventFromJSON = functionCallEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEventType = { - FunctionCallDelta: "function.call.delta" - }; - exports.FunctionCallEventType$inboundSchema = z.nativeEnum(exports.FunctionCallEventType); - exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema; - var FunctionCallEventType$; - (function(FunctionCallEventType$2) { - FunctionCallEventType$2.inboundSchema = exports.FunctionCallEventType$inboundSchema; - FunctionCallEventType$2.outboundSchema = exports.FunctionCallEventType$outboundSchema; - })(FunctionCallEventType$ || (exports.FunctionCallEventType$ = FunctionCallEventType$ = {})); - exports.FunctionCallEvent$inboundSchema = z.object({ - type: exports.FunctionCallEventType$inboundSchema.default("function.call.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: z.string(), - tool_call_id: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEvent$outboundSchema = z.object({ - type: exports.FunctionCallEventType$outboundSchema.default("function.call.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: z.string(), - toolCallId: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEvent$; - (function(FunctionCallEvent$2) { - FunctionCallEvent$2.inboundSchema = exports.FunctionCallEvent$inboundSchema; - FunctionCallEvent$2.outboundSchema = exports.FunctionCallEvent$outboundSchema; - })(FunctionCallEvent$ || (exports.FunctionCallEvent$ = FunctionCallEvent$ = {})); - function functionCallEventToJSON(functionCallEvent) { - return JSON.stringify(exports.FunctionCallEvent$outboundSchema.parse(functionCallEvent)); - } - function functionCallEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js - var require_outputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OutputContentChunks$ = exports.OutputContentChunks$outboundSchema = exports.OutputContentChunks$inboundSchema = void 0; - exports.outputContentChunksToJSON = outputContentChunksToJSON; - exports.outputContentChunksFromJSON = outputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.OutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.OutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var OutputContentChunks$; - (function(OutputContentChunks$2) { - OutputContentChunks$2.inboundSchema = exports.OutputContentChunks$inboundSchema; - OutputContentChunks$2.outboundSchema = exports.OutputContentChunks$outboundSchema; - })(OutputContentChunks$ || (exports.OutputContentChunks$ = OutputContentChunks$ = {})); - function outputContentChunksToJSON(outputContentChunks) { - return JSON.stringify(exports.OutputContentChunks$outboundSchema.parse(outputContentChunks)); - } - function outputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputevent.js - var require_messageoutputevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEvent$ = exports.MessageOutputEvent$outboundSchema = exports.MessageOutputEvent$inboundSchema = exports.MessageOutputEventContent$ = exports.MessageOutputEventContent$outboundSchema = exports.MessageOutputEventContent$inboundSchema = exports.MessageOutputEventRole$ = exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema = exports.MessageOutputEventType$ = exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema = exports.MessageOutputEventRole = exports.MessageOutputEventType = void 0; - exports.messageOutputEventContentToJSON = messageOutputEventContentToJSON; - exports.messageOutputEventContentFromJSON = messageOutputEventContentFromJSON; - exports.messageOutputEventToJSON = messageOutputEventToJSON; - exports.messageOutputEventFromJSON = messageOutputEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var outputcontentchunks_js_1 = require_outputcontentchunks(); - exports.MessageOutputEventType = { - MessageOutputDelta: "message.output.delta" - }; - exports.MessageOutputEventRole = { - Assistant: "assistant" - }; - exports.MessageOutputEventType$inboundSchema = z.nativeEnum(exports.MessageOutputEventType); - exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema; - var MessageOutputEventType$; - (function(MessageOutputEventType$2) { - MessageOutputEventType$2.inboundSchema = exports.MessageOutputEventType$inboundSchema; - MessageOutputEventType$2.outboundSchema = exports.MessageOutputEventType$outboundSchema; - })(MessageOutputEventType$ || (exports.MessageOutputEventType$ = MessageOutputEventType$ = {})); - exports.MessageOutputEventRole$inboundSchema = z.nativeEnum(exports.MessageOutputEventRole); - exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema; - var MessageOutputEventRole$; - (function(MessageOutputEventRole$2) { - MessageOutputEventRole$2.inboundSchema = exports.MessageOutputEventRole$inboundSchema; - MessageOutputEventRole$2.outboundSchema = exports.MessageOutputEventRole$outboundSchema; - })(MessageOutputEventRole$ || (exports.MessageOutputEventRole$ = MessageOutputEventRole$ = {})); - exports.MessageOutputEventContent$inboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]); - exports.MessageOutputEventContent$outboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]); - var MessageOutputEventContent$; - (function(MessageOutputEventContent$2) { - MessageOutputEventContent$2.inboundSchema = exports.MessageOutputEventContent$inboundSchema; - MessageOutputEventContent$2.outboundSchema = exports.MessageOutputEventContent$outboundSchema; - })(MessageOutputEventContent$ || (exports.MessageOutputEventContent$ = MessageOutputEventContent$ = {})); - function messageOutputEventContentToJSON(messageOutputEventContent) { - return JSON.stringify(exports.MessageOutputEventContent$outboundSchema.parse(messageOutputEventContent)); - } - function messageOutputEventContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEventContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEventContent' from JSON`); - } - exports.MessageOutputEvent$inboundSchema = z.object({ - type: exports.MessageOutputEventType$inboundSchema.default("message.output.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - content_index: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$inboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "content_index": "contentIndex", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEvent$outboundSchema = z.object({ - type: exports.MessageOutputEventType$outboundSchema.default("message.output.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - contentIndex: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$outboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - contentIndex: "content_index", - agentId: "agent_id" - }); - }); - var MessageOutputEvent$; - (function(MessageOutputEvent$2) { - MessageOutputEvent$2.inboundSchema = exports.MessageOutputEvent$inboundSchema; - MessageOutputEvent$2.outboundSchema = exports.MessageOutputEvent$outboundSchema; - })(MessageOutputEvent$ || (exports.MessageOutputEvent$ = MessageOutputEvent$ = {})); - function messageOutputEventToJSON(messageOutputEvent) { - return JSON.stringify(exports.MessageOutputEvent$outboundSchema.parse(messageOutputEvent)); - } - function messageOutputEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js - var require_conversationusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationUsageInfo$ = exports.ConversationUsageInfo$outboundSchema = exports.ConversationUsageInfo$inboundSchema = void 0; - exports.conversationUsageInfoToJSON = conversationUsageInfoToJSON; - exports.conversationUsageInfoFromJSON = conversationUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ConversationUsageInfo$inboundSchema = z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - connector_tokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "connector_tokens": "connectorTokens" - }); - }); - exports.ConversationUsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - connectorTokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - connectorTokens: "connector_tokens" - }); - }); - var ConversationUsageInfo$; - (function(ConversationUsageInfo$2) { - ConversationUsageInfo$2.inboundSchema = exports.ConversationUsageInfo$inboundSchema; - ConversationUsageInfo$2.outboundSchema = exports.ConversationUsageInfo$outboundSchema; - })(ConversationUsageInfo$ || (exports.ConversationUsageInfo$ = ConversationUsageInfo$ = {})); - function conversationUsageInfoToJSON(conversationUsageInfo) { - return JSON.stringify(exports.ConversationUsageInfo$outboundSchema.parse(conversationUsageInfo)); - } - function conversationUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsedoneevent.js - var require_responsedoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsedoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseDoneEvent$ = exports.ResponseDoneEvent$outboundSchema = exports.ResponseDoneEvent$inboundSchema = exports.ResponseDoneEventType$ = exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema = exports.ResponseDoneEventType = void 0; - exports.responseDoneEventToJSON = responseDoneEventToJSON; - exports.responseDoneEventFromJSON = responseDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - exports.ResponseDoneEventType = { - ConversationResponseDone: "conversation.response.done" - }; - exports.ResponseDoneEventType$inboundSchema = z.nativeEnum(exports.ResponseDoneEventType); - exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema; - var ResponseDoneEventType$; - (function(ResponseDoneEventType$2) { - ResponseDoneEventType$2.inboundSchema = exports.ResponseDoneEventType$inboundSchema; - ResponseDoneEventType$2.outboundSchema = exports.ResponseDoneEventType$outboundSchema; - })(ResponseDoneEventType$ || (exports.ResponseDoneEventType$ = ResponseDoneEventType$ = {})); - exports.ResponseDoneEvent$inboundSchema = z.object({ - type: exports.ResponseDoneEventType$inboundSchema.default("conversation.response.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseDoneEvent$outboundSchema = z.object({ - type: exports.ResponseDoneEventType$outboundSchema.default("conversation.response.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseDoneEvent$; - (function(ResponseDoneEvent$2) { - ResponseDoneEvent$2.inboundSchema = exports.ResponseDoneEvent$inboundSchema; - ResponseDoneEvent$2.outboundSchema = exports.ResponseDoneEvent$outboundSchema; - })(ResponseDoneEvent$ || (exports.ResponseDoneEvent$ = ResponseDoneEvent$ = {})); - function responseDoneEventToJSON(responseDoneEvent) { - return JSON.stringify(exports.ResponseDoneEvent$outboundSchema.parse(responseDoneEvent)); - } - function responseDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseerrorevent.js - var require_responseerrorevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseerrorevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseErrorEvent$ = exports.ResponseErrorEvent$outboundSchema = exports.ResponseErrorEvent$inboundSchema = exports.ResponseErrorEventType$ = exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema = exports.ResponseErrorEventType = void 0; - exports.responseErrorEventToJSON = responseErrorEventToJSON; - exports.responseErrorEventFromJSON = responseErrorEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseErrorEventType = { - ConversationResponseError: "conversation.response.error" - }; - exports.ResponseErrorEventType$inboundSchema = z.nativeEnum(exports.ResponseErrorEventType); - exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema; - var ResponseErrorEventType$; - (function(ResponseErrorEventType$2) { - ResponseErrorEventType$2.inboundSchema = exports.ResponseErrorEventType$inboundSchema; - ResponseErrorEventType$2.outboundSchema = exports.ResponseErrorEventType$outboundSchema; - })(ResponseErrorEventType$ || (exports.ResponseErrorEventType$ = ResponseErrorEventType$ = {})); - exports.ResponseErrorEvent$inboundSchema = z.object({ - type: exports.ResponseErrorEventType$inboundSchema.default("conversation.response.error"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseErrorEvent$outboundSchema = z.object({ - type: exports.ResponseErrorEventType$outboundSchema.default("conversation.response.error"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseErrorEvent$; - (function(ResponseErrorEvent$2) { - ResponseErrorEvent$2.inboundSchema = exports.ResponseErrorEvent$inboundSchema; - ResponseErrorEvent$2.outboundSchema = exports.ResponseErrorEvent$outboundSchema; - })(ResponseErrorEvent$ || (exports.ResponseErrorEvent$ = ResponseErrorEvent$ = {})); - function responseErrorEventToJSON(responseErrorEvent) { - return JSON.stringify(exports.ResponseErrorEvent$outboundSchema.parse(responseErrorEvent)); - } - function responseErrorEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseErrorEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseErrorEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsestartedevent.js - var require_responsestartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsestartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseStartedEvent$ = exports.ResponseStartedEvent$outboundSchema = exports.ResponseStartedEvent$inboundSchema = exports.ResponseStartedEventType$ = exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema = exports.ResponseStartedEventType = void 0; - exports.responseStartedEventToJSON = responseStartedEventToJSON; - exports.responseStartedEventFromJSON = responseStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseStartedEventType = { - ConversationResponseStarted: "conversation.response.started" - }; - exports.ResponseStartedEventType$inboundSchema = z.nativeEnum(exports.ResponseStartedEventType); - exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema; - var ResponseStartedEventType$; - (function(ResponseStartedEventType$2) { - ResponseStartedEventType$2.inboundSchema = exports.ResponseStartedEventType$inboundSchema; - ResponseStartedEventType$2.outboundSchema = exports.ResponseStartedEventType$outboundSchema; - })(ResponseStartedEventType$ || (exports.ResponseStartedEventType$ = ResponseStartedEventType$ = {})); - exports.ResponseStartedEvent$inboundSchema = z.object({ - type: exports.ResponseStartedEventType$inboundSchema.default("conversation.response.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "conversation_id": "conversationId" - }); - }); - exports.ResponseStartedEvent$outboundSchema = z.object({ - type: exports.ResponseStartedEventType$outboundSchema.default("conversation.response.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - conversationId: "conversation_id" - }); - }); - var ResponseStartedEvent$; - (function(ResponseStartedEvent$2) { - ResponseStartedEvent$2.inboundSchema = exports.ResponseStartedEvent$inboundSchema; - ResponseStartedEvent$2.outboundSchema = exports.ResponseStartedEvent$outboundSchema; - })(ResponseStartedEvent$ || (exports.ResponseStartedEvent$ = ResponseStartedEvent$ = {})); - function responseStartedEventToJSON(responseStartedEvent) { - return JSON.stringify(exports.ResponseStartedEvent$outboundSchema.parse(responseStartedEvent)); - } - function responseStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ssetypes.js - var require_ssetypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ssetypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SSETypes$ = exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema = exports.SSETypes = void 0; - var z = __importStar(require_zod()); - exports.SSETypes = { - ConversationResponseStarted: "conversation.response.started", - ConversationResponseDone: "conversation.response.done", - ConversationResponseError: "conversation.response.error", - MessageOutputDelta: "message.output.delta", - ToolExecutionStarted: "tool.execution.started", - ToolExecutionDelta: "tool.execution.delta", - ToolExecutionDone: "tool.execution.done", - AgentHandoffStarted: "agent.handoff.started", - AgentHandoffDone: "agent.handoff.done", - FunctionCallDelta: "function.call.delta" - }; - exports.SSETypes$inboundSchema = z.nativeEnum(exports.SSETypes); - exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema; - var SSETypes$; - (function(SSETypes$2) { - SSETypes$2.inboundSchema = exports.SSETypes$inboundSchema; - SSETypes$2.outboundSchema = exports.SSETypes$outboundSchema; - })(SSETypes$ || (exports.SSETypes$ = SSETypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js - var require_toolexecutiondeltaevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDeltaEvent$ = exports.ToolExecutionDeltaEvent$outboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema = exports.ToolExecutionDeltaEventType$ = exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema = exports.ToolExecutionDeltaEventType = void 0; - exports.toolExecutionDeltaEventToJSON = toolExecutionDeltaEventToJSON; - exports.toolExecutionDeltaEventFromJSON = toolExecutionDeltaEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDeltaEventType = { - ToolExecutionDelta: "tool.execution.delta" - }; - exports.ToolExecutionDeltaEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDeltaEventType); - exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - var ToolExecutionDeltaEventType$; - (function(ToolExecutionDeltaEventType$2) { - ToolExecutionDeltaEventType$2.inboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - ToolExecutionDeltaEventType$2.outboundSchema = exports.ToolExecutionDeltaEventType$outboundSchema; - })(ToolExecutionDeltaEventType$ || (exports.ToolExecutionDeltaEventType$ = ToolExecutionDeltaEventType$ = {})); - exports.ToolExecutionDeltaEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$inboundSchema.default("tool.execution.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDeltaEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$outboundSchema.default("tool.execution.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDeltaEvent$; - (function(ToolExecutionDeltaEvent$2) { - ToolExecutionDeltaEvent$2.inboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema; - ToolExecutionDeltaEvent$2.outboundSchema = exports.ToolExecutionDeltaEvent$outboundSchema; - })(ToolExecutionDeltaEvent$ || (exports.ToolExecutionDeltaEvent$ = ToolExecutionDeltaEvent$ = {})); - function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent) { - return JSON.stringify(exports.ToolExecutionDeltaEvent$outboundSchema.parse(toolExecutionDeltaEvent)); - } - function toolExecutionDeltaEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDeltaEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDeltaEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js - var require_toolexecutiondoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDoneEvent$ = exports.ToolExecutionDoneEvent$outboundSchema = exports.ToolExecutionDoneEvent$inboundSchema = exports.ToolExecutionDoneEventType$ = exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema = exports.ToolExecutionDoneEventType = void 0; - exports.toolExecutionDoneEventToJSON = toolExecutionDoneEventToJSON; - exports.toolExecutionDoneEventFromJSON = toolExecutionDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDoneEventType = { - ToolExecutionDone: "tool.execution.done" - }; - exports.ToolExecutionDoneEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDoneEventType); - exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - var ToolExecutionDoneEventType$; - (function(ToolExecutionDoneEventType$2) { - ToolExecutionDoneEventType$2.inboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - ToolExecutionDoneEventType$2.outboundSchema = exports.ToolExecutionDoneEventType$outboundSchema; - })(ToolExecutionDoneEventType$ || (exports.ToolExecutionDoneEventType$ = ToolExecutionDoneEventType$ = {})); - exports.ToolExecutionDoneEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$inboundSchema.default("tool.execution.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDoneEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$outboundSchema.default("tool.execution.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDoneEvent$; - (function(ToolExecutionDoneEvent$2) { - ToolExecutionDoneEvent$2.inboundSchema = exports.ToolExecutionDoneEvent$inboundSchema; - ToolExecutionDoneEvent$2.outboundSchema = exports.ToolExecutionDoneEvent$outboundSchema; - })(ToolExecutionDoneEvent$ || (exports.ToolExecutionDoneEvent$ = ToolExecutionDoneEvent$ = {})); - function toolExecutionDoneEventToJSON(toolExecutionDoneEvent) { - return JSON.stringify(exports.ToolExecutionDoneEvent$outboundSchema.parse(toolExecutionDoneEvent)); - } - function toolExecutionDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js - var require_toolexecutionstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionStartedEvent$ = exports.ToolExecutionStartedEvent$outboundSchema = exports.ToolExecutionStartedEvent$inboundSchema = exports.ToolExecutionStartedEventType$ = exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema = exports.ToolExecutionStartedEventType = void 0; - exports.toolExecutionStartedEventToJSON = toolExecutionStartedEventToJSON; - exports.toolExecutionStartedEventFromJSON = toolExecutionStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionStartedEventType = { - ToolExecutionStarted: "tool.execution.started" - }; - exports.ToolExecutionStartedEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionStartedEventType); - exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - var ToolExecutionStartedEventType$; - (function(ToolExecutionStartedEventType$2) { - ToolExecutionStartedEventType$2.inboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - ToolExecutionStartedEventType$2.outboundSchema = exports.ToolExecutionStartedEventType$outboundSchema; - })(ToolExecutionStartedEventType$ || (exports.ToolExecutionStartedEventType$ = ToolExecutionStartedEventType$ = {})); - exports.ToolExecutionStartedEvent$inboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$inboundSchema.default("tool.execution.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionStartedEvent$outboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$outboundSchema.default("tool.execution.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionStartedEvent$; - (function(ToolExecutionStartedEvent$2) { - ToolExecutionStartedEvent$2.inboundSchema = exports.ToolExecutionStartedEvent$inboundSchema; - ToolExecutionStartedEvent$2.outboundSchema = exports.ToolExecutionStartedEvent$outboundSchema; - })(ToolExecutionStartedEvent$ || (exports.ToolExecutionStartedEvent$ = ToolExecutionStartedEvent$ = {})); - function toolExecutionStartedEventToJSON(toolExecutionStartedEvent) { - return JSON.stringify(exports.ToolExecutionStartedEvent$outboundSchema.parse(toolExecutionStartedEvent)); - } - function toolExecutionStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationevents.js - var require_conversationevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationEvents$ = exports.ConversationEvents$outboundSchema = exports.ConversationEvents$inboundSchema = exports.ConversationEventsData$ = exports.ConversationEventsData$outboundSchema = exports.ConversationEventsData$inboundSchema = void 0; - exports.conversationEventsDataToJSON = conversationEventsDataToJSON; - exports.conversationEventsDataFromJSON = conversationEventsDataFromJSON; - exports.conversationEventsToJSON = conversationEventsToJSON; - exports.conversationEventsFromJSON = conversationEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffdoneevent_js_1 = require_agenthandoffdoneevent(); - var agenthandoffstartedevent_js_1 = require_agenthandoffstartedevent(); - var functioncallevent_js_1 = require_functioncallevent(); - var messageoutputevent_js_1 = require_messageoutputevent(); - var responsedoneevent_js_1 = require_responsedoneevent(); - var responseerrorevent_js_1 = require_responseerrorevent(); - var responsestartedevent_js_1 = require_responsestartedevent(); - var ssetypes_js_1 = require_ssetypes(); - var toolexecutiondeltaevent_js_1 = require_toolexecutiondeltaevent(); - var toolexecutiondoneevent_js_1 = require_toolexecutiondoneevent(); - var toolexecutionstartedevent_js_1 = require_toolexecutionstartedevent(); - exports.ConversationEventsData$inboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - exports.ConversationEventsData$outboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - var ConversationEventsData$; - (function(ConversationEventsData$2) { - ConversationEventsData$2.inboundSchema = exports.ConversationEventsData$inboundSchema; - ConversationEventsData$2.outboundSchema = exports.ConversationEventsData$outboundSchema; - })(ConversationEventsData$ || (exports.ConversationEventsData$ = ConversationEventsData$ = {})); - function conversationEventsDataToJSON(conversationEventsData) { - return JSON.stringify(exports.ConversationEventsData$outboundSchema.parse(conversationEventsData)); - } - function conversationEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEventsData' from JSON`); - } - exports.ConversationEvents$inboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ type: v.type }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ type: v.type }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ type: v.type }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.ConversationEvents$outboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$outboundSchema, - data: z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]) - }); - var ConversationEvents$; - (function(ConversationEvents$2) { - ConversationEvents$2.inboundSchema = exports.ConversationEvents$inboundSchema; - ConversationEvents$2.outboundSchema = exports.ConversationEvents$outboundSchema; - })(ConversationEvents$ || (exports.ConversationEvents$ = ConversationEvents$ = {})); - function conversationEventsToJSON(conversationEvents) { - return JSON.stringify(exports.ConversationEvents$outboundSchema.parse(conversationEvents)); - } - function conversationEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationhistory.js - var require_conversationhistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationhistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationHistory$ = exports.ConversationHistory$outboundSchema = exports.ConversationHistory$inboundSchema = exports.Entries$ = exports.Entries$outboundSchema = exports.Entries$inboundSchema = exports.ConversationHistoryObject$ = exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema = exports.ConversationHistoryObject = void 0; - exports.entriesToJSON = entriesToJSON; - exports.entriesFromJSON = entriesFromJSON; - exports.conversationHistoryToJSON = conversationHistoryToJSON; - exports.conversationHistoryFromJSON = conversationHistoryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationHistoryObject = { - ConversationHistory: "conversation.history" - }; - exports.ConversationHistoryObject$inboundSchema = z.nativeEnum(exports.ConversationHistoryObject); - exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema; - var ConversationHistoryObject$; - (function(ConversationHistoryObject$2) { - ConversationHistoryObject$2.inboundSchema = exports.ConversationHistoryObject$inboundSchema; - ConversationHistoryObject$2.outboundSchema = exports.ConversationHistoryObject$outboundSchema; - })(ConversationHistoryObject$ || (exports.ConversationHistoryObject$ = ConversationHistoryObject$ = {})); - exports.Entries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Entries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Entries$; - (function(Entries$2) { - Entries$2.inboundSchema = exports.Entries$inboundSchema; - Entries$2.outboundSchema = exports.Entries$outboundSchema; - })(Entries$ || (exports.Entries$ = Entries$ = {})); - function entriesToJSON(entries) { - return JSON.stringify(exports.Entries$outboundSchema.parse(entries)); - } - function entriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Entries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Entries' from JSON`); - } - exports.ConversationHistory$inboundSchema = z.object({ - object: exports.ConversationHistoryObject$inboundSchema.default("conversation.history"), - conversation_id: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationHistory$outboundSchema = z.object({ - object: exports.ConversationHistoryObject$outboundSchema.default("conversation.history"), - conversationId: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationHistory$; - (function(ConversationHistory$2) { - ConversationHistory$2.inboundSchema = exports.ConversationHistory$inboundSchema; - ConversationHistory$2.outboundSchema = exports.ConversationHistory$outboundSchema; - })(ConversationHistory$ || (exports.ConversationHistory$ = ConversationHistory$ = {})); - function conversationHistoryToJSON(conversationHistory) { - return JSON.stringify(exports.ConversationHistory$outboundSchema.parse(conversationHistory)); - } - function conversationHistoryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationHistory$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationHistory' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageentries.js - var require_messageentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageEntries$ = exports.MessageEntries$outboundSchema = exports.MessageEntries$inboundSchema = void 0; - exports.messageEntriesToJSON = messageEntriesToJSON; - exports.messageEntriesFromJSON = messageEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - exports.MessageEntries$inboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.MessageEntries$outboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var MessageEntries$; - (function(MessageEntries$2) { - MessageEntries$2.inboundSchema = exports.MessageEntries$inboundSchema; - MessageEntries$2.outboundSchema = exports.MessageEntries$outboundSchema; - })(MessageEntries$ || (exports.MessageEntries$ = MessageEntries$ = {})); - function messageEntriesToJSON(messageEntries) { - return JSON.stringify(exports.MessageEntries$outboundSchema.parse(messageEntries)); - } - function messageEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationmessages.js - var require_conversationmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationMessages$ = exports.ConversationMessages$outboundSchema = exports.ConversationMessages$inboundSchema = exports.ConversationMessagesObject$ = exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema = exports.ConversationMessagesObject = void 0; - exports.conversationMessagesToJSON = conversationMessagesToJSON; - exports.conversationMessagesFromJSON = conversationMessagesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageentries_js_1 = require_messageentries(); - exports.ConversationMessagesObject = { - ConversationMessages: "conversation.messages" - }; - exports.ConversationMessagesObject$inboundSchema = z.nativeEnum(exports.ConversationMessagesObject); - exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema; - var ConversationMessagesObject$; - (function(ConversationMessagesObject$2) { - ConversationMessagesObject$2.inboundSchema = exports.ConversationMessagesObject$inboundSchema; - ConversationMessagesObject$2.outboundSchema = exports.ConversationMessagesObject$outboundSchema; - })(ConversationMessagesObject$ || (exports.ConversationMessagesObject$ = ConversationMessagesObject$ = {})); - exports.ConversationMessages$inboundSchema = z.object({ - object: exports.ConversationMessagesObject$inboundSchema.default("conversation.messages"), - conversation_id: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationMessages$outboundSchema = z.object({ - object: exports.ConversationMessagesObject$outboundSchema.default("conversation.messages"), - conversationId: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationMessages$; - (function(ConversationMessages$2) { - ConversationMessages$2.inboundSchema = exports.ConversationMessages$inboundSchema; - ConversationMessages$2.outboundSchema = exports.ConversationMessages$outboundSchema; - })(ConversationMessages$ || (exports.ConversationMessages$ = ConversationMessages$ = {})); - function conversationMessagesToJSON(conversationMessages) { - return JSON.stringify(exports.ConversationMessages$outboundSchema.parse(conversationMessages)); - } - function conversationMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationMessages' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrequest.js - var require_conversationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRequest$ = exports.ConversationRequest$outboundSchema = exports.ConversationRequest$inboundSchema = exports.Tools$ = exports.Tools$outboundSchema = exports.Tools$inboundSchema = exports.HandoffExecution$ = exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema = exports.HandoffExecution = void 0; - exports.toolsToJSON = toolsToJSON; - exports.toolsFromJSON = toolsFromJSON; - exports.conversationRequestToJSON = conversationRequestToJSON; - exports.conversationRequestFromJSON = conversationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.HandoffExecution = { - Client: "client", - Server: "server" - }; - exports.HandoffExecution$inboundSchema = z.nativeEnum(exports.HandoffExecution); - exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema; - var HandoffExecution$; - (function(HandoffExecution$2) { - HandoffExecution$2.inboundSchema = exports.HandoffExecution$inboundSchema; - HandoffExecution$2.outboundSchema = exports.HandoffExecution$outboundSchema; - })(HandoffExecution$ || (exports.HandoffExecution$ = HandoffExecution$ = {})); - exports.Tools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Tools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var Tools$; - (function(Tools$2) { - Tools$2.inboundSchema = exports.Tools$inboundSchema; - Tools$2.outboundSchema = exports.Tools$outboundSchema; - })(Tools$ || (exports.Tools$ = Tools$ = {})); - function toolsToJSON(tools) { - return JSON.stringify(exports.Tools$outboundSchema.parse(tools)); - } - function toolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tools' from JSON`); - } - exports.ConversationRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.HandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.HandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationRequest$; - (function(ConversationRequest$2) { - ConversationRequest$2.inboundSchema = exports.ConversationRequest$inboundSchema; - ConversationRequest$2.outboundSchema = exports.ConversationRequest$outboundSchema; - })(ConversationRequest$ || (exports.ConversationRequest$ = ConversationRequest$ = {})); - function conversationRequestToJSON(conversationRequest) { - return JSON.stringify(exports.ConversationRequest$outboundSchema.parse(conversationRequest)); - } - function conversationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationresponse.js - var require_conversationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationResponse$ = exports.ConversationResponse$outboundSchema = exports.ConversationResponse$inboundSchema = exports.Outputs$ = exports.Outputs$outboundSchema = exports.Outputs$inboundSchema = exports.ConversationResponseObject$ = exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema = exports.ConversationResponseObject = void 0; - exports.outputsToJSON = outputsToJSON; - exports.outputsFromJSON = outputsFromJSON; - exports.conversationResponseToJSON = conversationResponseToJSON; - exports.conversationResponseFromJSON = conversationResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - var functioncallentry_js_1 = require_functioncallentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationResponseObject = { - ConversationResponse: "conversation.response" - }; - exports.ConversationResponseObject$inboundSchema = z.nativeEnum(exports.ConversationResponseObject); - exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema; - var ConversationResponseObject$; - (function(ConversationResponseObject$2) { - ConversationResponseObject$2.inboundSchema = exports.ConversationResponseObject$inboundSchema; - ConversationResponseObject$2.outboundSchema = exports.ConversationResponseObject$outboundSchema; - })(ConversationResponseObject$ || (exports.ConversationResponseObject$ = ConversationResponseObject$ = {})); - exports.Outputs$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Outputs$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Outputs$; - (function(Outputs$2) { - Outputs$2.inboundSchema = exports.Outputs$inboundSchema; - Outputs$2.outboundSchema = exports.Outputs$outboundSchema; - })(Outputs$ || (exports.Outputs$ = Outputs$ = {})); - function outputsToJSON(outputs) { - return JSON.stringify(exports.Outputs$outboundSchema.parse(outputs)); - } - function outputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Outputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Outputs' from JSON`); - } - exports.ConversationResponse$inboundSchema = z.object({ - object: exports.ConversationResponseObject$inboundSchema.default("conversation.response"), - conversation_id: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationResponse$outboundSchema = z.object({ - object: exports.ConversationResponseObject$outboundSchema.default("conversation.response"), - conversationId: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationResponse$; - (function(ConversationResponse$2) { - ConversationResponse$2.inboundSchema = exports.ConversationResponse$inboundSchema; - ConversationResponse$2.outboundSchema = exports.ConversationResponse$outboundSchema; - })(ConversationResponse$ || (exports.ConversationResponse$ = ConversationResponse$ = {})); - function conversationResponseToJSON(conversationResponse) { - return JSON.stringify(exports.ConversationResponse$outboundSchema.parse(conversationResponse)); - } - function conversationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js - var require_conversationrestartrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartRequest$ = exports.ConversationRestartRequest$outboundSchema = exports.ConversationRestartRequest$inboundSchema = exports.ConversationRestartRequestHandoffExecution$ = exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema = exports.ConversationRestartRequestHandoffExecution = void 0; - exports.conversationRestartRequestToJSON = conversationRestartRequestToJSON; - exports.conversationRestartRequestFromJSON = conversationRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartRequestHandoffExecution); - exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - var ConversationRestartRequestHandoffExecution$; - (function(ConversationRestartRequestHandoffExecution$2) { - ConversationRestartRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - ConversationRestartRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartRequestHandoffExecution$outboundSchema; - })(ConversationRestartRequestHandoffExecution$ || (exports.ConversationRestartRequestHandoffExecution$ = ConversationRestartRequestHandoffExecution$ = {})); - exports.ConversationRestartRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartRequest$; - (function(ConversationRestartRequest$2) { - ConversationRestartRequest$2.inboundSchema = exports.ConversationRestartRequest$inboundSchema; - ConversationRestartRequest$2.outboundSchema = exports.ConversationRestartRequest$outboundSchema; - })(ConversationRestartRequest$ || (exports.ConversationRestartRequest$ = ConversationRestartRequest$ = {})); - function conversationRestartRequestToJSON(conversationRestartRequest) { - return JSON.stringify(exports.ConversationRestartRequest$outboundSchema.parse(conversationRestartRequest)); - } - function conversationRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js - var require_conversationrestartstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartStreamRequest$ = exports.ConversationRestartStreamRequest$outboundSchema = exports.ConversationRestartStreamRequest$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$ = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution = void 0; - exports.conversationRestartStreamRequestToJSON = conversationRestartStreamRequestToJSON; - exports.conversationRestartStreamRequestFromJSON = conversationRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartStreamRequestHandoffExecution); - exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - var ConversationRestartStreamRequestHandoffExecution$; - (function(ConversationRestartStreamRequestHandoffExecution$2) { - ConversationRestartStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - ConversationRestartStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema; - })(ConversationRestartStreamRequestHandoffExecution$ || (exports.ConversationRestartStreamRequestHandoffExecution$ = ConversationRestartStreamRequestHandoffExecution$ = {})); - exports.ConversationRestartStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartStreamRequest$; - (function(ConversationRestartStreamRequest$2) { - ConversationRestartStreamRequest$2.inboundSchema = exports.ConversationRestartStreamRequest$inboundSchema; - ConversationRestartStreamRequest$2.outboundSchema = exports.ConversationRestartStreamRequest$outboundSchema; - })(ConversationRestartStreamRequest$ || (exports.ConversationRestartStreamRequest$ = ConversationRestartStreamRequest$ = {})); - function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest) { - return JSON.stringify(exports.ConversationRestartStreamRequest$outboundSchema.parse(conversationRestartStreamRequest)); - } - function conversationRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js - var require_conversationstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationStreamRequest$ = exports.ConversationStreamRequest$outboundSchema = exports.ConversationStreamRequest$inboundSchema = exports.ConversationStreamRequestTools$ = exports.ConversationStreamRequestTools$outboundSchema = exports.ConversationStreamRequestTools$inboundSchema = exports.ConversationStreamRequestHandoffExecution$ = exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema = exports.ConversationStreamRequestHandoffExecution = void 0; - exports.conversationStreamRequestToolsToJSON = conversationStreamRequestToolsToJSON; - exports.conversationStreamRequestToolsFromJSON = conversationStreamRequestToolsFromJSON; - exports.conversationStreamRequestToJSON = conversationStreamRequestToJSON; - exports.conversationStreamRequestFromJSON = conversationStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ConversationStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationStreamRequestHandoffExecution); - exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - var ConversationStreamRequestHandoffExecution$; - (function(ConversationStreamRequestHandoffExecution$2) { - ConversationStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - ConversationStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationStreamRequestHandoffExecution$outboundSchema; - })(ConversationStreamRequestHandoffExecution$ || (exports.ConversationStreamRequestHandoffExecution$ = ConversationStreamRequestHandoffExecution$ = {})); - exports.ConversationStreamRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ConversationStreamRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ConversationStreamRequestTools$; - (function(ConversationStreamRequestTools$2) { - ConversationStreamRequestTools$2.inboundSchema = exports.ConversationStreamRequestTools$inboundSchema; - ConversationStreamRequestTools$2.outboundSchema = exports.ConversationStreamRequestTools$outboundSchema; - })(ConversationStreamRequestTools$ || (exports.ConversationStreamRequestTools$ = ConversationStreamRequestTools$ = {})); - function conversationStreamRequestToolsToJSON(conversationStreamRequestTools) { - return JSON.stringify(exports.ConversationStreamRequestTools$outboundSchema.parse(conversationStreamRequestTools)); - } - function conversationStreamRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequestTools' from JSON`); - } - exports.ConversationStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.ConversationStreamRequestHandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.ConversationStreamRequestHandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationStreamRequest$; - (function(ConversationStreamRequest$2) { - ConversationStreamRequest$2.inboundSchema = exports.ConversationStreamRequest$inboundSchema; - ConversationStreamRequest$2.outboundSchema = exports.ConversationStreamRequest$outboundSchema; - })(ConversationStreamRequest$ || (exports.ConversationStreamRequest$ = ConversationStreamRequest$ = {})); - function conversationStreamRequestToJSON(conversationStreamRequest) { - return JSON.stringify(exports.ConversationStreamRequest$outboundSchema.parse(conversationStreamRequest)); - } - function conversationStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletefileout.js - var require_deletefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteFileOut$ = exports.DeleteFileOut$outboundSchema = exports.DeleteFileOut$inboundSchema = void 0; - exports.deleteFileOutToJSON = deleteFileOutToJSON; - exports.deleteFileOutFromJSON = deleteFileOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - exports.DeleteFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - var DeleteFileOut$; - (function(DeleteFileOut$2) { - DeleteFileOut$2.inboundSchema = exports.DeleteFileOut$inboundSchema; - DeleteFileOut$2.outboundSchema = exports.DeleteFileOut$outboundSchema; - })(DeleteFileOut$ || (exports.DeleteFileOut$ = DeleteFileOut$ = {})); - function deleteFileOutToJSON(deleteFileOut) { - return JSON.stringify(exports.DeleteFileOut$outboundSchema.parse(deleteFileOut)); - } - function deleteFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletemodelout.js - var require_deletemodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletemodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelOut$ = exports.DeleteModelOut$outboundSchema = exports.DeleteModelOut$inboundSchema = void 0; - exports.deleteModelOutToJSON = deleteModelOutToJSON; - exports.deleteModelOutFromJSON = deleteModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteModelOut$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - exports.DeleteModelOut$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - var DeleteModelOut$; - (function(DeleteModelOut$2) { - DeleteModelOut$2.inboundSchema = exports.DeleteModelOut$inboundSchema; - DeleteModelOut$2.outboundSchema = exports.DeleteModelOut$outboundSchema; - })(DeleteModelOut$ || (exports.DeleteModelOut$ = DeleteModelOut$ = {})); - function deleteModelOutToJSON(deleteModelOut) { - return JSON.stringify(exports.DeleteModelOut$outboundSchema.parse(deleteModelOut)); - } - function deleteModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentout.js - var require_documentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentOut$ = exports.DocumentOut$outboundSchema = exports.DocumentOut$inboundSchema = void 0; - exports.documentOutToJSON = documentOutToJSON; - exports.documentOutFromJSON = documentOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentOut$inboundSchema = z.object({ - id: z.string(), - library_id: z.string(), - hash: z.string(), - mime_type: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - last_processed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - number_of_pages: z.nullable(z.number().int()).optional(), - processing_status: z.string(), - uploaded_by_id: z.string(), - uploaded_by_type: z.string(), - tokens_processing_main_content: z.nullable(z.number().int()).optional(), - tokens_processing_summary: z.nullable(z.number().int()).optional(), - tokens_processing_total: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "mime_type": "mimeType", - "created_at": "createdAt", - "last_processed_at": "lastProcessedAt", - "number_of_pages": "numberOfPages", - "processing_status": "processingStatus", - "uploaded_by_id": "uploadedById", - "uploaded_by_type": "uploadedByType", - "tokens_processing_main_content": "tokensProcessingMainContent", - "tokens_processing_summary": "tokensProcessingSummary", - "tokens_processing_total": "tokensProcessingTotal" - }); - }); - exports.DocumentOut$outboundSchema = z.object({ - id: z.string(), - libraryId: z.string(), - hash: z.string(), - mimeType: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - createdAt: z.date().transform((v) => v.toISOString()), - lastProcessedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - numberOfPages: z.nullable(z.number().int()).optional(), - processingStatus: z.string(), - uploadedById: z.string(), - uploadedByType: z.string(), - tokensProcessingMainContent: z.nullable(z.number().int()).optional(), - tokensProcessingSummary: z.nullable(z.number().int()).optional(), - tokensProcessingTotal: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - mimeType: "mime_type", - createdAt: "created_at", - lastProcessedAt: "last_processed_at", - numberOfPages: "number_of_pages", - processingStatus: "processing_status", - uploadedById: "uploaded_by_id", - uploadedByType: "uploaded_by_type", - tokensProcessingMainContent: "tokens_processing_main_content", - tokensProcessingSummary: "tokens_processing_summary", - tokensProcessingTotal: "tokens_processing_total" - }); - }); - var DocumentOut$; - (function(DocumentOut$2) { - DocumentOut$2.inboundSchema = exports.DocumentOut$inboundSchema; - DocumentOut$2.outboundSchema = exports.DocumentOut$outboundSchema; - })(DocumentOut$ || (exports.DocumentOut$ = DocumentOut$ = {})); - function documentOutToJSON(documentOut) { - return JSON.stringify(exports.DocumentOut$outboundSchema.parse(documentOut)); - } - function documentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenttextcontent.js - var require_documenttextcontent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenttextcontent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentTextContent$ = exports.DocumentTextContent$outboundSchema = exports.DocumentTextContent$inboundSchema = void 0; - exports.documentTextContentToJSON = documentTextContentToJSON; - exports.documentTextContentFromJSON = documentTextContentFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentTextContent$inboundSchema = z.object({ - text: z.string() - }); - exports.DocumentTextContent$outboundSchema = z.object({ - text: z.string() - }); - var DocumentTextContent$; - (function(DocumentTextContent$2) { - DocumentTextContent$2.inboundSchema = exports.DocumentTextContent$inboundSchema; - DocumentTextContent$2.outboundSchema = exports.DocumentTextContent$outboundSchema; - })(DocumentTextContent$ || (exports.DocumentTextContent$ = DocumentTextContent$ = {})); - function documentTextContentToJSON(documentTextContent) { - return JSON.stringify(exports.DocumentTextContent$outboundSchema.parse(documentTextContent)); - } - function documentTextContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentTextContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentTextContent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentupdatein.js - var require_documentupdatein = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentupdatein.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentUpdateIn$ = exports.DocumentUpdateIn$outboundSchema = exports.DocumentUpdateIn$inboundSchema = void 0; - exports.documentUpdateInToJSON = documentUpdateInToJSON; - exports.documentUpdateInFromJSON = documentUpdateInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentUpdateIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - exports.DocumentUpdateIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - var DocumentUpdateIn$; - (function(DocumentUpdateIn$2) { - DocumentUpdateIn$2.inboundSchema = exports.DocumentUpdateIn$inboundSchema; - DocumentUpdateIn$2.outboundSchema = exports.DocumentUpdateIn$outboundSchema; - })(DocumentUpdateIn$ || (exports.DocumentUpdateIn$ = DocumentUpdateIn$ = {})); - function documentUpdateInToJSON(documentUpdateIn) { - return JSON.stringify(exports.DocumentUpdateIn$outboundSchema.parse(documentUpdateIn)); - } - function documentUpdateInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentUpdateIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentUpdateIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingdtype.js - var require_embeddingdtype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingdtype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingDtype$ = exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema = exports.EmbeddingDtype = void 0; - var z = __importStar(require_zod()); - exports.EmbeddingDtype = { - Float: "float", - Int8: "int8", - Uint8: "uint8", - Binary: "binary", - Ubinary: "ubinary" - }; - exports.EmbeddingDtype$inboundSchema = z.nativeEnum(exports.EmbeddingDtype); - exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema; - var EmbeddingDtype$; - (function(EmbeddingDtype$2) { - EmbeddingDtype$2.inboundSchema = exports.EmbeddingDtype$inboundSchema; - EmbeddingDtype$2.outboundSchema = exports.EmbeddingDtype$outboundSchema; - })(EmbeddingDtype$ || (exports.EmbeddingDtype$ = EmbeddingDtype$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/encodingformat.js - var require_encodingformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/encodingformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EncodingFormat$ = exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema = exports.EncodingFormat = void 0; - var z = __importStar(require_zod()); - exports.EncodingFormat = { - Float: "float", - Base64: "base64" - }; - exports.EncodingFormat$inboundSchema = z.nativeEnum(exports.EncodingFormat); - exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema; - var EncodingFormat$; - (function(EncodingFormat$2) { - EncodingFormat$2.inboundSchema = exports.EncodingFormat$inboundSchema; - EncodingFormat$2.outboundSchema = exports.EncodingFormat$outboundSchema; - })(EncodingFormat$ || (exports.EncodingFormat$ = EncodingFormat$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingrequest.js - var require_embeddingrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingRequest$ = exports.EmbeddingRequest$outboundSchema = exports.EmbeddingRequest$inboundSchema = exports.EmbeddingRequestInputs$ = exports.EmbeddingRequestInputs$outboundSchema = exports.EmbeddingRequestInputs$inboundSchema = void 0; - exports.embeddingRequestInputsToJSON = embeddingRequestInputsToJSON; - exports.embeddingRequestInputsFromJSON = embeddingRequestInputsFromJSON; - exports.embeddingRequestToJSON = embeddingRequestToJSON; - exports.embeddingRequestFromJSON = embeddingRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var embeddingdtype_js_1 = require_embeddingdtype(); - var encodingformat_js_1 = require_encodingformat(); - exports.EmbeddingRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.EmbeddingRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var EmbeddingRequestInputs$; - (function(EmbeddingRequestInputs$2) { - EmbeddingRequestInputs$2.inboundSchema = exports.EmbeddingRequestInputs$inboundSchema; - EmbeddingRequestInputs$2.outboundSchema = exports.EmbeddingRequestInputs$outboundSchema; - })(EmbeddingRequestInputs$ || (exports.EmbeddingRequestInputs$ = EmbeddingRequestInputs$ = {})); - function embeddingRequestInputsToJSON(embeddingRequestInputs) { - return JSON.stringify(exports.EmbeddingRequestInputs$outboundSchema.parse(embeddingRequestInputs)); - } - function embeddingRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequestInputs' from JSON`); - } - exports.EmbeddingRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]), - output_dimension: z.nullable(z.number().int()).optional(), - output_dtype: embeddingdtype_js_1.EmbeddingDtype$inboundSchema.optional(), - encoding_format: encodingformat_js_1.EncodingFormat$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs", - "output_dimension": "outputDimension", - "output_dtype": "outputDtype", - "encoding_format": "encodingFormat" - }); - }); - exports.EmbeddingRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]), - outputDimension: z.nullable(z.number().int()).optional(), - outputDtype: embeddingdtype_js_1.EmbeddingDtype$outboundSchema.optional(), - encodingFormat: encodingformat_js_1.EncodingFormat$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input", - outputDimension: "output_dimension", - outputDtype: "output_dtype", - encodingFormat: "encoding_format" - }); - }); - var EmbeddingRequest$; - (function(EmbeddingRequest$2) { - EmbeddingRequest$2.inboundSchema = exports.EmbeddingRequest$inboundSchema; - EmbeddingRequest$2.outboundSchema = exports.EmbeddingRequest$outboundSchema; - })(EmbeddingRequest$ || (exports.EmbeddingRequest$ = EmbeddingRequest$ = {})); - function embeddingRequestToJSON(embeddingRequest) { - return JSON.stringify(exports.EmbeddingRequest$outboundSchema.parse(embeddingRequest)); - } - function embeddingRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js - var require_embeddingresponsedata = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponseData$ = exports.EmbeddingResponseData$outboundSchema = exports.EmbeddingResponseData$inboundSchema = void 0; - exports.embeddingResponseDataToJSON = embeddingResponseDataToJSON; - exports.embeddingResponseDataFromJSON = embeddingResponseDataFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.EmbeddingResponseData$inboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - exports.EmbeddingResponseData$outboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - var EmbeddingResponseData$; - (function(EmbeddingResponseData$2) { - EmbeddingResponseData$2.inboundSchema = exports.EmbeddingResponseData$inboundSchema; - EmbeddingResponseData$2.outboundSchema = exports.EmbeddingResponseData$outboundSchema; - })(EmbeddingResponseData$ || (exports.EmbeddingResponseData$ = EmbeddingResponseData$ = {})); - function embeddingResponseDataToJSON(embeddingResponseData) { - return JSON.stringify(exports.EmbeddingResponseData$outboundSchema.parse(embeddingResponseData)); - } - function embeddingResponseDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponseData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponseData' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponse.js - var require_embeddingresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponse$ = exports.EmbeddingResponse$outboundSchema = exports.EmbeddingResponse$inboundSchema = void 0; - exports.embeddingResponseToJSON = embeddingResponseToJSON; - exports.embeddingResponseFromJSON = embeddingResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var embeddingresponsedata_js_1 = require_embeddingresponsedata(); - var usageinfo_js_1 = require_usageinfo(); - exports.EmbeddingResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$inboundSchema) - }); - exports.EmbeddingResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$outboundSchema) - }); - var EmbeddingResponse$; - (function(EmbeddingResponse$2) { - EmbeddingResponse$2.inboundSchema = exports.EmbeddingResponse$inboundSchema; - EmbeddingResponse$2.outboundSchema = exports.EmbeddingResponse$outboundSchema; - })(EmbeddingResponse$ || (exports.EmbeddingResponse$ = EmbeddingResponse$ = {})); - function embeddingResponseToJSON(embeddingResponse) { - return JSON.stringify(exports.EmbeddingResponse$outboundSchema.parse(embeddingResponse)); - } - function embeddingResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/entitytype.js - var require_entitytype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/entitytype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EntityType$ = exports.EntityType$outboundSchema = exports.EntityType$inboundSchema = exports.EntityType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.EntityType = { - User: "User", - Workspace: "Workspace", - Org: "Org" - }; - exports.EntityType$inboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.EntityType$outboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().and(z.custom()) - ]); - var EntityType$; - (function(EntityType$2) { - EntityType$2.inboundSchema = exports.EntityType$inboundSchema; - EntityType$2.outboundSchema = exports.EntityType$outboundSchema; - })(EntityType$ || (exports.EntityType$ = EntityType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/filepurpose.js - var require_filepurpose = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filepurpose.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilePurpose$ = exports.FilePurpose$outboundSchema = exports.FilePurpose$inboundSchema = exports.FilePurpose = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.FilePurpose = { - FineTune: "fine-tune", - Batch: "batch", - Ocr: "ocr" - }; - exports.FilePurpose$inboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FilePurpose$outboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().and(z.custom()) - ]); - var FilePurpose$; - (function(FilePurpose$2) { - FilePurpose$2.inboundSchema = exports.FilePurpose$inboundSchema; - FilePurpose$2.outboundSchema = exports.FilePurpose$outboundSchema; - })(FilePurpose$ || (exports.FilePurpose$ = FilePurpose$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sampletype.js - var require_sampletype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sampletype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SampleType$ = exports.SampleType$outboundSchema = exports.SampleType$inboundSchema = exports.SampleType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.SampleType = { - Pretrain: "pretrain", - Instruct: "instruct", - BatchRequest: "batch_request", - BatchResult: "batch_result", - BatchError: "batch_error" - }; - exports.SampleType$inboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.SampleType$outboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().and(z.custom()) - ]); - var SampleType$; - (function(SampleType$2) { - SampleType$2.inboundSchema = exports.SampleType$inboundSchema; - SampleType$2.outboundSchema = exports.SampleType$outboundSchema; - })(SampleType$ || (exports.SampleType$ = SampleType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/source.js - var require_source = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/source.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Source$ = exports.Source$outboundSchema = exports.Source$inboundSchema = exports.Source = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.Source = { - Upload: "upload", - Repository: "repository", - Mistral: "mistral" - }; - exports.Source$inboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.Source$outboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().and(z.custom()) - ]); - var Source$; - (function(Source$2) { - Source$2.inboundSchema = exports.Source$inboundSchema; - Source$2.outboundSchema = exports.Source$outboundSchema; - })(Source$ || (exports.Source$ = Source$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/fileschema.js - var require_fileschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fileschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSchema$ = exports.FileSchema$outboundSchema = exports.FileSchema$inboundSchema = void 0; - exports.fileSchemaToJSON = fileSchemaToJSON; - exports.fileSchemaFromJSON = fileSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.FileSchema$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.FileSchema$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var FileSchema$; - (function(FileSchema$2) { - FileSchema$2.inboundSchema = exports.FileSchema$inboundSchema; - FileSchema$2.outboundSchema = exports.FileSchema$outboundSchema; - })(FileSchema$ || (exports.FileSchema$ = FileSchema$ = {})); - function fileSchemaToJSON(fileSchema) { - return JSON.stringify(exports.FileSchema$outboundSchema.parse(fileSchema)); - } - function fileSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filesignedurl.js - var require_filesignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filesignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSignedURL$ = exports.FileSignedURL$outboundSchema = exports.FileSignedURL$inboundSchema = void 0; - exports.fileSignedURLToJSON = fileSignedURLToJSON; - exports.fileSignedURLFromJSON = fileSignedURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileSignedURL$inboundSchema = z.object({ - url: z.string() - }); - exports.FileSignedURL$outboundSchema = z.object({ - url: z.string() - }); - var FileSignedURL$; - (function(FileSignedURL$2) { - FileSignedURL$2.inboundSchema = exports.FileSignedURL$inboundSchema; - FileSignedURL$2.outboundSchema = exports.FileSignedURL$outboundSchema; - })(FileSignedURL$ || (exports.FileSignedURL$ = FileSignedURL$ = {})); - function fileSignedURLToJSON(fileSignedURL) { - return JSON.stringify(exports.FileSignedURL$outboundSchema.parse(fileSignedURL)); - } - function fileSignedURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSignedURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSignedURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js - var require_fimcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionRequest$ = exports.FIMCompletionRequest$outboundSchema = exports.FIMCompletionRequest$inboundSchema = exports.FIMCompletionRequestStop$ = exports.FIMCompletionRequestStop$outboundSchema = exports.FIMCompletionRequestStop$inboundSchema = void 0; - exports.fimCompletionRequestStopToJSON = fimCompletionRequestStopToJSON; - exports.fimCompletionRequestStopFromJSON = fimCompletionRequestStopFromJSON; - exports.fimCompletionRequestToJSON = fimCompletionRequestToJSON; - exports.fimCompletionRequestFromJSON = fimCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionRequestStop$; - (function(FIMCompletionRequestStop$2) { - FIMCompletionRequestStop$2.inboundSchema = exports.FIMCompletionRequestStop$inboundSchema; - FIMCompletionRequestStop$2.outboundSchema = exports.FIMCompletionRequestStop$outboundSchema; - })(FIMCompletionRequestStop$ || (exports.FIMCompletionRequestStop$ = FIMCompletionRequestStop$ = {})); - function fimCompletionRequestStopToJSON(fimCompletionRequestStop) { - return JSON.stringify(exports.FIMCompletionRequestStop$outboundSchema.parse(fimCompletionRequestStop)); - } - function fimCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequestStop' from JSON`); - } - exports.FIMCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionRequest$; - (function(FIMCompletionRequest$2) { - FIMCompletionRequest$2.inboundSchema = exports.FIMCompletionRequest$inboundSchema; - FIMCompletionRequest$2.outboundSchema = exports.FIMCompletionRequest$outboundSchema; - })(FIMCompletionRequest$ || (exports.FIMCompletionRequest$ = FIMCompletionRequest$ = {})); - function fimCompletionRequestToJSON(fimCompletionRequest) { - return JSON.stringify(exports.FIMCompletionRequest$outboundSchema.parse(fimCompletionRequest)); - } - function fimCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js - var require_fimcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionResponse$ = exports.FIMCompletionResponse$outboundSchema = exports.FIMCompletionResponse$inboundSchema = void 0; - exports.fimCompletionResponseToJSON = fimCompletionResponseToJSON; - exports.fimCompletionResponseFromJSON = fimCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.FIMCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.FIMCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var FIMCompletionResponse$; - (function(FIMCompletionResponse$2) { - FIMCompletionResponse$2.inboundSchema = exports.FIMCompletionResponse$inboundSchema; - FIMCompletionResponse$2.outboundSchema = exports.FIMCompletionResponse$outboundSchema; - })(FIMCompletionResponse$ || (exports.FIMCompletionResponse$ = FIMCompletionResponse$ = {})); - function fimCompletionResponseToJSON(fimCompletionResponse) { - return JSON.stringify(exports.FIMCompletionResponse$outboundSchema.parse(fimCompletionResponse)); - } - function fimCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js - var require_fimcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionStreamRequest$ = exports.FIMCompletionStreamRequest$outboundSchema = exports.FIMCompletionStreamRequest$inboundSchema = exports.FIMCompletionStreamRequestStop$ = exports.FIMCompletionStreamRequestStop$outboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema = void 0; - exports.fimCompletionStreamRequestStopToJSON = fimCompletionStreamRequestStopToJSON; - exports.fimCompletionStreamRequestStopFromJSON = fimCompletionStreamRequestStopFromJSON; - exports.fimCompletionStreamRequestToJSON = fimCompletionStreamRequestToJSON; - exports.fimCompletionStreamRequestFromJSON = fimCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionStreamRequestStop$; - (function(FIMCompletionStreamRequestStop$2) { - FIMCompletionStreamRequestStop$2.inboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema; - FIMCompletionStreamRequestStop$2.outboundSchema = exports.FIMCompletionStreamRequestStop$outboundSchema; - })(FIMCompletionStreamRequestStop$ || (exports.FIMCompletionStreamRequestStop$ = FIMCompletionStreamRequestStop$ = {})); - function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop) { - return JSON.stringify(exports.FIMCompletionStreamRequestStop$outboundSchema.parse(fimCompletionStreamRequestStop)); - } - function fimCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequestStop' from JSON`); - } - exports.FIMCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionStreamRequest$; - (function(FIMCompletionStreamRequest$2) { - FIMCompletionStreamRequest$2.inboundSchema = exports.FIMCompletionStreamRequest$inboundSchema; - FIMCompletionStreamRequest$2.outboundSchema = exports.FIMCompletionStreamRequest$outboundSchema; - })(FIMCompletionStreamRequest$ || (exports.FIMCompletionStreamRequest$ = FIMCompletionStreamRequest$ = {})); - function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest) { - return JSON.stringify(exports.FIMCompletionStreamRequest$outboundSchema.parse(fimCompletionStreamRequest)); - } - function fimCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js - var require_finetuneablemodeltype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuneableModelType$ = exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema = exports.FineTuneableModelType = void 0; - var z = __importStar(require_zod()); - exports.FineTuneableModelType = { - Completion: "completion", - Classifier: "classifier" - }; - exports.FineTuneableModelType$inboundSchema = z.nativeEnum(exports.FineTuneableModelType); - exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema; - var FineTuneableModelType$; - (function(FineTuneableModelType$2) { - FineTuneableModelType$2.inboundSchema = exports.FineTuneableModelType$inboundSchema; - FineTuneableModelType$2.outboundSchema = exports.FineTuneableModelType$outboundSchema; - })(FineTuneableModelType$ || (exports.FineTuneableModelType$ = FineTuneableModelType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcard.js - var require_ftmodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCard$ = exports.FTModelCard$outboundSchema = exports.FTModelCard$inboundSchema = exports.FTModelCardType$ = exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema = exports.FTModelCardType = void 0; - exports.ftModelCardToJSON = ftModelCardToJSON; - exports.ftModelCardFromJSON = ftModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.FTModelCardType = { - FineTuned: "fine-tuned" - }; - exports.FTModelCardType$inboundSchema = z.nativeEnum(exports.FTModelCardType); - exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema; - var FTModelCardType$; - (function(FTModelCardType$2) { - FTModelCardType$2.inboundSchema = exports.FTModelCardType$inboundSchema; - FTModelCardType$2.outboundSchema = exports.FTModelCardType$outboundSchema; - })(FTModelCardType$ || (exports.FTModelCardType$ = FTModelCardType$ = {})); - exports.FTModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.FTModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var FTModelCard$; - (function(FTModelCard$2) { - FTModelCard$2.inboundSchema = exports.FTModelCard$inboundSchema; - FTModelCard$2.outboundSchema = exports.FTModelCard$outboundSchema; - })(FTModelCard$ || (exports.FTModelCard$ = FTModelCard$ = {})); - function ftModelCardToJSON(ftModelCard) { - return JSON.stringify(exports.FTModelCard$outboundSchema.parse(ftModelCard)); - } - function ftModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js - var require_githubrepositoryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryIn$ = exports.GithubRepositoryIn$outboundSchema = exports.GithubRepositoryIn$inboundSchema = exports.GithubRepositoryInType$ = exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema = exports.GithubRepositoryInType = void 0; - exports.githubRepositoryInToJSON = githubRepositoryInToJSON; - exports.githubRepositoryInFromJSON = githubRepositoryInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryInType = { - Github: "github" - }; - exports.GithubRepositoryInType$inboundSchema = z.nativeEnum(exports.GithubRepositoryInType); - exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema; - var GithubRepositoryInType$; - (function(GithubRepositoryInType$2) { - GithubRepositoryInType$2.inboundSchema = exports.GithubRepositoryInType$inboundSchema; - GithubRepositoryInType$2.outboundSchema = exports.GithubRepositoryInType$outboundSchema; - })(GithubRepositoryInType$ || (exports.GithubRepositoryInType$ = GithubRepositoryInType$ = {})); - exports.GithubRepositoryIn$inboundSchema = z.object({ - type: exports.GithubRepositoryInType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - exports.GithubRepositoryIn$outboundSchema = z.object({ - type: exports.GithubRepositoryInType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - var GithubRepositoryIn$; - (function(GithubRepositoryIn$2) { - GithubRepositoryIn$2.inboundSchema = exports.GithubRepositoryIn$inboundSchema; - GithubRepositoryIn$2.outboundSchema = exports.GithubRepositoryIn$outboundSchema; - })(GithubRepositoryIn$ || (exports.GithubRepositoryIn$ = GithubRepositoryIn$ = {})); - function githubRepositoryInToJSON(githubRepositoryIn) { - return JSON.stringify(exports.GithubRepositoryIn$outboundSchema.parse(githubRepositoryIn)); - } - function githubRepositoryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/trainingfile.js - var require_trainingfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/trainingfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TrainingFile$ = exports.TrainingFile$outboundSchema = exports.TrainingFile$inboundSchema = void 0; - exports.trainingFileToJSON = trainingFileToJSON; - exports.trainingFileFromJSON = trainingFileFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TrainingFile$inboundSchema = z.object({ - file_id: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.TrainingFile$outboundSchema = z.object({ - fileId: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var TrainingFile$; - (function(TrainingFile$2) { - TrainingFile$2.inboundSchema = exports.TrainingFile$inboundSchema; - TrainingFile$2.outboundSchema = exports.TrainingFile$outboundSchema; - })(TrainingFile$ || (exports.TrainingFile$ = TrainingFile$ = {})); - function trainingFileToJSON(trainingFile) { - return JSON.stringify(exports.TrainingFile$outboundSchema.parse(trainingFile)); - } - function trainingFileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TrainingFile$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TrainingFile' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegration.js - var require_wandbintegration = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegration.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegration$ = exports.WandbIntegration$outboundSchema = exports.WandbIntegration$inboundSchema = exports.WandbIntegrationType$ = exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema = exports.WandbIntegrationType = void 0; - exports.wandbIntegrationToJSON = wandbIntegrationToJSON; - exports.wandbIntegrationFromJSON = wandbIntegrationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationType = { - Wandb: "wandb" - }; - exports.WandbIntegrationType$inboundSchema = z.nativeEnum(exports.WandbIntegrationType); - exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema; - var WandbIntegrationType$; - (function(WandbIntegrationType$2) { - WandbIntegrationType$2.inboundSchema = exports.WandbIntegrationType$inboundSchema; - WandbIntegrationType$2.outboundSchema = exports.WandbIntegrationType$outboundSchema; - })(WandbIntegrationType$ || (exports.WandbIntegrationType$ = WandbIntegrationType$ = {})); - exports.WandbIntegration$inboundSchema = z.object({ - type: exports.WandbIntegrationType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - api_key: z.string(), - run_name: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "api_key": "apiKey", - "run_name": "runName" - }); - }); - exports.WandbIntegration$outboundSchema = z.object({ - type: exports.WandbIntegrationType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - apiKey: z.string(), - runName: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "api_key", - runName: "run_name" - }); - }); - var WandbIntegration$; - (function(WandbIntegration$2) { - WandbIntegration$2.inboundSchema = exports.WandbIntegration$inboundSchema; - WandbIntegration$2.outboundSchema = exports.WandbIntegration$outboundSchema; - })(WandbIntegration$ || (exports.WandbIntegration$ = WandbIntegration$ = {})); - function wandbIntegrationToJSON(wandbIntegration) { - return JSON.stringify(exports.WandbIntegration$outboundSchema.parse(wandbIntegration)); - } - function wandbIntegrationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegration$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegration' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobin.js - var require_jobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobIn$ = exports.JobIn$outboundSchema = exports.JobIn$inboundSchema = exports.JobInRepositories$ = exports.JobInRepositories$outboundSchema = exports.JobInRepositories$inboundSchema = exports.Hyperparameters$ = exports.Hyperparameters$outboundSchema = exports.Hyperparameters$inboundSchema = exports.JobInIntegrations$ = exports.JobInIntegrations$outboundSchema = exports.JobInIntegrations$inboundSchema = void 0; - exports.jobInIntegrationsToJSON = jobInIntegrationsToJSON; - exports.jobInIntegrationsFromJSON = jobInIntegrationsFromJSON; - exports.hyperparametersToJSON = hyperparametersToJSON; - exports.hyperparametersFromJSON = hyperparametersFromJSON; - exports.jobInRepositoriesToJSON = jobInRepositoriesToJSON; - exports.jobInRepositoriesFromJSON = jobInRepositoriesFromJSON; - exports.jobInToJSON = jobInToJSON; - exports.jobInFromJSON = jobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetin_js_1 = require_classifiertargetin(); - var classifiertrainingparametersin_js_1 = require_classifiertrainingparametersin(); - var completiontrainingparametersin_js_1 = require_completiontrainingparametersin(); - var finetuneablemodeltype_js_1 = require_finetuneablemodeltype(); - var githubrepositoryin_js_1 = require_githubrepositoryin(); - var trainingfile_js_1 = require_trainingfile(); - var wandbintegration_js_1 = require_wandbintegration(); - exports.JobInIntegrations$inboundSchema = wandbintegration_js_1.WandbIntegration$inboundSchema; - exports.JobInIntegrations$outboundSchema = wandbintegration_js_1.WandbIntegration$outboundSchema; - var JobInIntegrations$; - (function(JobInIntegrations$2) { - JobInIntegrations$2.inboundSchema = exports.JobInIntegrations$inboundSchema; - JobInIntegrations$2.outboundSchema = exports.JobInIntegrations$outboundSchema; - })(JobInIntegrations$ || (exports.JobInIntegrations$ = JobInIntegrations$ = {})); - function jobInIntegrationsToJSON(jobInIntegrations) { - return JSON.stringify(exports.JobInIntegrations$outboundSchema.parse(jobInIntegrations)); - } - function jobInIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInIntegrations' from JSON`); - } - exports.Hyperparameters$inboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]); - exports.Hyperparameters$outboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]); - var Hyperparameters$; - (function(Hyperparameters$2) { - Hyperparameters$2.inboundSchema = exports.Hyperparameters$inboundSchema; - Hyperparameters$2.outboundSchema = exports.Hyperparameters$outboundSchema; - })(Hyperparameters$ || (exports.Hyperparameters$ = Hyperparameters$ = {})); - function hyperparametersToJSON(hyperparameters) { - return JSON.stringify(exports.Hyperparameters$outboundSchema.parse(hyperparameters)); - } - function hyperparametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Hyperparameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Hyperparameters' from JSON`); - } - exports.JobInRepositories$inboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema; - exports.JobInRepositories$outboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema; - var JobInRepositories$; - (function(JobInRepositories$2) { - JobInRepositories$2.inboundSchema = exports.JobInRepositories$inboundSchema; - JobInRepositories$2.outboundSchema = exports.JobInRepositories$outboundSchema; - })(JobInRepositories$ || (exports.JobInRepositories$ = JobInRepositories$ = {})); - function jobInRepositoriesToJSON(jobInRepositories) { - return JSON.stringify(exports.JobInRepositories$outboundSchema.parse(jobInRepositories)); - } - function jobInRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInRepositories' from JSON`); - } - exports.JobIn$inboundSchema = z.object({ - model: z.string(), - training_files: z.array(trainingfile_js_1.TrainingFile$inboundSchema).optional(), - validation_files: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$inboundSchema)).optional(), - auto_start: z.boolean().optional(), - invalid_sample_skip_percentage: z.number().default(0), - job_type: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$inboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema)).optional(), - classifier_targets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "auto_start": "autoStart", - "invalid_sample_skip_percentage": "invalidSampleSkipPercentage", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.JobIn$outboundSchema = z.object({ - model: z.string(), - trainingFiles: z.array(trainingfile_js_1.TrainingFile$outboundSchema).optional(), - validationFiles: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$outboundSchema)).optional(), - autoStart: z.boolean().optional(), - invalidSampleSkipPercentage: z.number().default(0), - jobType: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$outboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema)).optional(), - classifierTargets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingFiles: "training_files", - validationFiles: "validation_files", - autoStart: "auto_start", - invalidSampleSkipPercentage: "invalid_sample_skip_percentage", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var JobIn$; - (function(JobIn$2) { - JobIn$2.inboundSchema = exports.JobIn$inboundSchema; - JobIn$2.outboundSchema = exports.JobIn$outboundSchema; - })(JobIn$ || (exports.JobIn$ = JobIn$ = {})); - function jobInToJSON(jobIn) { - return JSON.stringify(exports.JobIn$outboundSchema.parse(jobIn)); - } - function jobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobsout.js - var require_jobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsOut$ = exports.JobsOut$outboundSchema = exports.JobsOut$inboundSchema = exports.JobsOutObject$ = exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema = exports.JobsOutData$ = exports.JobsOutData$outboundSchema = exports.JobsOutData$inboundSchema = exports.JobsOutObject = void 0; - exports.jobsOutDataToJSON = jobsOutDataToJSON; - exports.jobsOutDataFromJSON = jobsOutDataFromJSON; - exports.jobsOutToJSON = jobsOutToJSON; - exports.jobsOutFromJSON = jobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classifierjobout_js_1 = require_classifierjobout(); - var completionjobout_js_1 = require_completionjobout(); - exports.JobsOutObject = { - List: "list" - }; - exports.JobsOutData$inboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsOutData$outboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsOutData$; - (function(JobsOutData$2) { - JobsOutData$2.inboundSchema = exports.JobsOutData$inboundSchema; - JobsOutData$2.outboundSchema = exports.JobsOutData$outboundSchema; - })(JobsOutData$ || (exports.JobsOutData$ = JobsOutData$ = {})); - function jobsOutDataToJSON(jobsOutData) { - return JSON.stringify(exports.JobsOutData$outboundSchema.parse(jobsOutData)); - } - function jobsOutDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOutData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOutData' from JSON`); - } - exports.JobsOutObject$inboundSchema = z.nativeEnum(exports.JobsOutObject); - exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema; - var JobsOutObject$; - (function(JobsOutObject$2) { - JobsOutObject$2.inboundSchema = exports.JobsOutObject$inboundSchema; - JobsOutObject$2.outboundSchema = exports.JobsOutObject$outboundSchema; - })(JobsOutObject$ || (exports.JobsOutObject$ = JobsOutObject$ = {})); - exports.JobsOut$inboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ])).optional(), - object: exports.JobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.JobsOut$outboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ])).optional(), - object: exports.JobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var JobsOut$; - (function(JobsOut$2) { - JobsOut$2.inboundSchema = exports.JobsOut$inboundSchema; - JobsOut$2.outboundSchema = exports.JobsOut$outboundSchema; - })(JobsOut$ || (exports.JobsOut$ = JobsOut$ = {})); - function jobsOutToJSON(jobsOut) { - return JSON.stringify(exports.JobsOut$outboundSchema.parse(jobsOut)); - } - function jobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js - var require_legacyjobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LegacyJobMetadataOut$ = exports.LegacyJobMetadataOut$outboundSchema = exports.LegacyJobMetadataOut$inboundSchema = exports.LegacyJobMetadataOutObject$ = exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema = exports.LegacyJobMetadataOutObject = void 0; - exports.legacyJobMetadataOutToJSON = legacyJobMetadataOutToJSON; - exports.legacyJobMetadataOutFromJSON = legacyJobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LegacyJobMetadataOutObject = { - JobMetadata: "job.metadata" - }; - exports.LegacyJobMetadataOutObject$inboundSchema = z.nativeEnum(exports.LegacyJobMetadataOutObject); - exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - var LegacyJobMetadataOutObject$; - (function(LegacyJobMetadataOutObject$2) { - LegacyJobMetadataOutObject$2.inboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - LegacyJobMetadataOutObject$2.outboundSchema = exports.LegacyJobMetadataOutObject$outboundSchema; - })(LegacyJobMetadataOutObject$ || (exports.LegacyJobMetadataOutObject$ = LegacyJobMetadataOutObject$ = {})); - exports.LegacyJobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - training_steps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$inboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime", - "training_steps": "trainingSteps" - }); - }); - exports.LegacyJobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - trainingSteps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$outboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time", - trainingSteps: "training_steps" - }); - }); - var LegacyJobMetadataOut$; - (function(LegacyJobMetadataOut$2) { - LegacyJobMetadataOut$2.inboundSchema = exports.LegacyJobMetadataOut$inboundSchema; - LegacyJobMetadataOut$2.outboundSchema = exports.LegacyJobMetadataOut$outboundSchema; - })(LegacyJobMetadataOut$ || (exports.LegacyJobMetadataOut$ = LegacyJobMetadataOut$ = {})); - function legacyJobMetadataOutToJSON(legacyJobMetadataOut) { - return JSON.stringify(exports.LegacyJobMetadataOut$outboundSchema.parse(legacyJobMetadataOut)); - } - function legacyJobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LegacyJobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LegacyJobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryin.js - var require_libraryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryIn$ = exports.LibraryIn$outboundSchema = exports.LibraryIn$inboundSchema = void 0; - exports.libraryInToJSON = libraryInToJSON; - exports.libraryInFromJSON = libraryInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryIn$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunk_size: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "chunk_size": "chunkSize" - }); - }); - exports.LibraryIn$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunkSize: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - chunkSize: "chunk_size" - }); - }); - var LibraryIn$; - (function(LibraryIn$2) { - LibraryIn$2.inboundSchema = exports.LibraryIn$inboundSchema; - LibraryIn$2.outboundSchema = exports.LibraryIn$outboundSchema; - })(LibraryIn$ || (exports.LibraryIn$ = LibraryIn$ = {})); - function libraryInToJSON(libraryIn) { - return JSON.stringify(exports.LibraryIn$outboundSchema.parse(libraryIn)); - } - function libraryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryinupdate.js - var require_libraryinupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryinupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryInUpdate$ = exports.LibraryInUpdate$outboundSchema = exports.LibraryInUpdate$inboundSchema = void 0; - exports.libraryInUpdateToJSON = libraryInUpdateToJSON; - exports.libraryInUpdateFromJSON = libraryInUpdateFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.LibraryInUpdate$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.LibraryInUpdate$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var LibraryInUpdate$; - (function(LibraryInUpdate$2) { - LibraryInUpdate$2.inboundSchema = exports.LibraryInUpdate$inboundSchema; - LibraryInUpdate$2.outboundSchema = exports.LibraryInUpdate$outboundSchema; - })(LibraryInUpdate$ || (exports.LibraryInUpdate$ = LibraryInUpdate$ = {})); - function libraryInUpdateToJSON(libraryInUpdate) { - return JSON.stringify(exports.LibraryInUpdate$outboundSchema.parse(libraryInUpdate)); - } - function libraryInUpdateFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryInUpdate$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryInUpdate' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryout.js - var require_libraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryOut$ = exports.LibraryOut$outboundSchema = exports.LibraryOut$inboundSchema = void 0; - exports.libraryOutToJSON = libraryOutToJSON; - exports.libraryOutFromJSON = libraryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryOut$inboundSchema = z.object({ - id: z.string(), - name: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - owner_id: z.string(), - owner_type: z.string(), - total_size: z.number().int(), - nb_documents: z.number().int(), - chunk_size: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generated_name: z.nullable(z.string()).optional(), - generated_description: z.nullable(z.string()).optional(), - explicit_user_members_count: z.nullable(z.number().int()).optional(), - explicit_workspace_members_count: z.nullable(z.number().int()).optional(), - org_sharing_role: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "owner_id": "ownerId", - "owner_type": "ownerType", - "total_size": "totalSize", - "nb_documents": "nbDocuments", - "chunk_size": "chunkSize", - "generated_name": "generatedName", - "generated_description": "generatedDescription", - "explicit_user_members_count": "explicitUserMembersCount", - "explicit_workspace_members_count": "explicitWorkspaceMembersCount", - "org_sharing_role": "orgSharingRole" - }); - }); - exports.LibraryOut$outboundSchema = z.object({ - id: z.string(), - name: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - ownerId: z.string(), - ownerType: z.string(), - totalSize: z.number().int(), - nbDocuments: z.number().int(), - chunkSize: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generatedName: z.nullable(z.string()).optional(), - generatedDescription: z.nullable(z.string()).optional(), - explicitUserMembersCount: z.nullable(z.number().int()).optional(), - explicitWorkspaceMembersCount: z.nullable(z.number().int()).optional(), - orgSharingRole: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - ownerId: "owner_id", - ownerType: "owner_type", - totalSize: "total_size", - nbDocuments: "nb_documents", - chunkSize: "chunk_size", - generatedName: "generated_name", - generatedDescription: "generated_description", - explicitUserMembersCount: "explicit_user_members_count", - explicitWorkspaceMembersCount: "explicit_workspace_members_count", - orgSharingRole: "org_sharing_role" - }); - }); - var LibraryOut$; - (function(LibraryOut$2) { - LibraryOut$2.inboundSchema = exports.LibraryOut$inboundSchema; - LibraryOut$2.outboundSchema = exports.LibraryOut$outboundSchema; - })(LibraryOut$ || (exports.LibraryOut$ = LibraryOut$ = {})); - function libraryOutToJSON(libraryOut) { - return JSON.stringify(exports.LibraryOut$outboundSchema.parse(libraryOut)); - } - function libraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/paginationinfo.js - var require_paginationinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/paginationinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.PaginationInfo$ = exports.PaginationInfo$outboundSchema = exports.PaginationInfo$inboundSchema = void 0; - exports.paginationInfoToJSON = paginationInfoToJSON; - exports.paginationInfoFromJSON = paginationInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.PaginationInfo$inboundSchema = z.object({ - total_items: z.number().int(), - total_pages: z.number().int(), - current_page: z.number().int(), - page_size: z.number().int(), - has_more: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "total_items": "totalItems", - "total_pages": "totalPages", - "current_page": "currentPage", - "page_size": "pageSize", - "has_more": "hasMore" - }); - }); - exports.PaginationInfo$outboundSchema = z.object({ - totalItems: z.number().int(), - totalPages: z.number().int(), - currentPage: z.number().int(), - pageSize: z.number().int(), - hasMore: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - totalItems: "total_items", - totalPages: "total_pages", - currentPage: "current_page", - pageSize: "page_size", - hasMore: "has_more" - }); - }); - var PaginationInfo$; - (function(PaginationInfo$2) { - PaginationInfo$2.inboundSchema = exports.PaginationInfo$inboundSchema; - PaginationInfo$2.outboundSchema = exports.PaginationInfo$outboundSchema; - })(PaginationInfo$ || (exports.PaginationInfo$ = PaginationInfo$ = {})); - function paginationInfoToJSON(paginationInfo) { - return JSON.stringify(exports.PaginationInfo$outboundSchema.parse(paginationInfo)); - } - function paginationInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PaginationInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PaginationInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listdocumentout.js - var require_listdocumentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listdocumentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListDocumentOut$ = exports.ListDocumentOut$outboundSchema = exports.ListDocumentOut$inboundSchema = void 0; - exports.listDocumentOutToJSON = listDocumentOutToJSON; - exports.listDocumentOutFromJSON = listDocumentOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documentout_js_1 = require_documentout(); - var paginationinfo_js_1 = require_paginationinfo(); - exports.ListDocumentOut$inboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$inboundSchema, - data: z.array(documentout_js_1.DocumentOut$inboundSchema) - }); - exports.ListDocumentOut$outboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$outboundSchema, - data: z.array(documentout_js_1.DocumentOut$outboundSchema) - }); - var ListDocumentOut$; - (function(ListDocumentOut$2) { - ListDocumentOut$2.inboundSchema = exports.ListDocumentOut$inboundSchema; - ListDocumentOut$2.outboundSchema = exports.ListDocumentOut$outboundSchema; - })(ListDocumentOut$ || (exports.ListDocumentOut$ = ListDocumentOut$ = {})); - function listDocumentOutToJSON(listDocumentOut) { - return JSON.stringify(exports.ListDocumentOut$outboundSchema.parse(listDocumentOut)); - } - function listDocumentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListDocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListDocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listfilesout.js - var require_listfilesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listfilesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListFilesOut$ = exports.ListFilesOut$outboundSchema = exports.ListFilesOut$inboundSchema = void 0; - exports.listFilesOutToJSON = listFilesOutToJSON; - exports.listFilesOutFromJSON = listFilesOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var fileschema_js_1 = require_fileschema(); - exports.ListFilesOut$inboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$inboundSchema), - object: z.string(), - total: z.number().int() - }); - exports.ListFilesOut$outboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$outboundSchema), - object: z.string(), - total: z.number().int() - }); - var ListFilesOut$; - (function(ListFilesOut$2) { - ListFilesOut$2.inboundSchema = exports.ListFilesOut$inboundSchema; - ListFilesOut$2.outboundSchema = exports.ListFilesOut$outboundSchema; - })(ListFilesOut$ || (exports.ListFilesOut$ = ListFilesOut$ = {})); - function listFilesOutToJSON(listFilesOut) { - return JSON.stringify(exports.ListFilesOut$outboundSchema.parse(listFilesOut)); - } - function listFilesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListFilesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListFilesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listlibraryout.js - var require_listlibraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listlibraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListLibraryOut$ = exports.ListLibraryOut$outboundSchema = exports.ListLibraryOut$inboundSchema = void 0; - exports.listLibraryOutToJSON = listLibraryOutToJSON; - exports.listLibraryOutFromJSON = listLibraryOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var libraryout_js_1 = require_libraryout(); - exports.ListLibraryOut$inboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$inboundSchema) - }); - exports.ListLibraryOut$outboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$outboundSchema) - }); - var ListLibraryOut$; - (function(ListLibraryOut$2) { - ListLibraryOut$2.inboundSchema = exports.ListLibraryOut$inboundSchema; - ListLibraryOut$2.outboundSchema = exports.ListLibraryOut$outboundSchema; - })(ListLibraryOut$ || (exports.ListLibraryOut$ = ListLibraryOut$ = {})); - function listLibraryOutToJSON(listLibraryOut) { - return JSON.stringify(exports.ListLibraryOut$outboundSchema.parse(listLibraryOut)); - } - function listLibraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListLibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListLibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingout.js - var require_sharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingOut$ = exports.SharingOut$outboundSchema = exports.SharingOut$inboundSchema = void 0; - exports.sharingOutToJSON = sharingOutToJSON; - exports.sharingOutFromJSON = sharingOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.SharingOut$inboundSchema = z.object({ - library_id: z.string(), - user_id: z.nullable(z.string()).optional(), - org_id: z.string(), - role: z.string(), - share_with_type: z.string(), - share_with_uuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "user_id": "userId", - "org_id": "orgId", - "share_with_type": "shareWithType", - "share_with_uuid": "shareWithUuid" - }); - }); - exports.SharingOut$outboundSchema = z.object({ - libraryId: z.string(), - userId: z.nullable(z.string()).optional(), - orgId: z.string(), - role: z.string(), - shareWithType: z.string(), - shareWithUuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - userId: "user_id", - orgId: "org_id", - shareWithType: "share_with_type", - shareWithUuid: "share_with_uuid" - }); - }); - var SharingOut$; - (function(SharingOut$2) { - SharingOut$2.inboundSchema = exports.SharingOut$inboundSchema; - SharingOut$2.outboundSchema = exports.SharingOut$outboundSchema; - })(SharingOut$ || (exports.SharingOut$ = SharingOut$ = {})); - function sharingOutToJSON(sharingOut) { - return JSON.stringify(exports.SharingOut$outboundSchema.parse(sharingOut)); - } - function sharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listsharingout.js - var require_listsharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listsharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListSharingOut$ = exports.ListSharingOut$outboundSchema = exports.ListSharingOut$inboundSchema = void 0; - exports.listSharingOutToJSON = listSharingOutToJSON; - exports.listSharingOutFromJSON = listSharingOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var sharingout_js_1 = require_sharingout(); - exports.ListSharingOut$inboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$inboundSchema) - }); - exports.ListSharingOut$outboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$outboundSchema) - }); - var ListSharingOut$; - (function(ListSharingOut$2) { - ListSharingOut$2.inboundSchema = exports.ListSharingOut$inboundSchema; - ListSharingOut$2.outboundSchema = exports.ListSharingOut$outboundSchema; - })(ListSharingOut$ || (exports.ListSharingOut$ = ListSharingOut$ = {})); - function listSharingOutToJSON(listSharingOut) { - return JSON.stringify(exports.ListSharingOut$outboundSchema.parse(listSharingOut)); - } - function listSharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListSharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListSharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelconversation.js - var require_modelconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelConversation$ = exports.ModelConversation$outboundSchema = exports.ModelConversation$inboundSchema = exports.ModelConversationObject$ = exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema = exports.ModelConversationTools$ = exports.ModelConversationTools$outboundSchema = exports.ModelConversationTools$inboundSchema = exports.ModelConversationObject = void 0; - exports.modelConversationToolsToJSON = modelConversationToolsToJSON; - exports.modelConversationToolsFromJSON = modelConversationToolsFromJSON; - exports.modelConversationToJSON = modelConversationToJSON; - exports.modelConversationFromJSON = modelConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ModelConversationObject = { - Conversation: "conversation" - }; - exports.ModelConversationTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ModelConversationTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ModelConversationTools$; - (function(ModelConversationTools$2) { - ModelConversationTools$2.inboundSchema = exports.ModelConversationTools$inboundSchema; - ModelConversationTools$2.outboundSchema = exports.ModelConversationTools$outboundSchema; - })(ModelConversationTools$ || (exports.ModelConversationTools$ = ModelConversationTools$ = {})); - function modelConversationToolsToJSON(modelConversationTools) { - return JSON.stringify(exports.ModelConversationTools$outboundSchema.parse(modelConversationTools)); - } - function modelConversationToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversationTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversationTools' from JSON`); - } - exports.ModelConversationObject$inboundSchema = z.nativeEnum(exports.ModelConversationObject); - exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema; - var ModelConversationObject$; - (function(ModelConversationObject$2) { - ModelConversationObject$2.inboundSchema = exports.ModelConversationObject$inboundSchema; - ModelConversationObject$2.outboundSchema = exports.ModelConversationObject$outboundSchema; - })(ModelConversationObject$ || (exports.ModelConversationObject$ = ModelConversationObject$ = {})); - exports.ModelConversation$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.ModelConversation$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var ModelConversation$; - (function(ModelConversation$2) { - ModelConversation$2.inboundSchema = exports.ModelConversation$inboundSchema; - ModelConversation$2.outboundSchema = exports.ModelConversation$outboundSchema; - })(ModelConversation$ || (exports.ModelConversation$ = ModelConversation$ = {})); - function modelConversationToJSON(modelConversation) { - return JSON.stringify(exports.ModelConversation$outboundSchema.parse(modelConversation)); - } - function modelConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modellist.js - var require_modellist = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modellist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelList$ = exports.ModelList$outboundSchema = exports.ModelList$inboundSchema = exports.Data$ = exports.Data$outboundSchema = exports.Data$inboundSchema = void 0; - exports.dataToJSON = dataToJSON; - exports.dataFromJSON = dataFromJSON; - exports.modelListToJSON = modelListToJSON; - exports.modelListFromJSON = modelListFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var basemodelcard_js_1 = require_basemodelcard(); - var ftmodelcard_js_1 = require_ftmodelcard(); - exports.Data$inboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Data$outboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var Data$; - (function(Data$2) { - Data$2.inboundSchema = exports.Data$inboundSchema; - Data$2.outboundSchema = exports.Data$outboundSchema; - })(Data$ || (exports.Data$ = Data$ = {})); - function dataToJSON(data) { - return JSON.stringify(exports.Data$outboundSchema.parse(data)); - } - function dataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Data$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Data' from JSON`); - } - exports.ModelList$inboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - exports.ModelList$outboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - var ModelList$; - (function(ModelList$2) { - ModelList$2.inboundSchema = exports.ModelList$inboundSchema; - ModelList$2.outboundSchema = exports.ModelList$outboundSchema; - })(ModelList$ || (exports.ModelList$ = ModelList$ = {})); - function modelListToJSON(modelList) { - return JSON.stringify(exports.ModelList$outboundSchema.parse(modelList)); - } - function modelListFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelList$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelList' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationobject.js - var require_moderationobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationObject$ = exports.ModerationObject$outboundSchema = exports.ModerationObject$inboundSchema = void 0; - exports.moderationObjectToJSON = moderationObjectToJSON; - exports.moderationObjectFromJSON = moderationObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModerationObject$inboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - category_scores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "category_scores": "categoryScores" - }); - }); - exports.ModerationObject$outboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - categoryScores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - categoryScores: "category_scores" - }); - }); - var ModerationObject$; - (function(ModerationObject$2) { - ModerationObject$2.inboundSchema = exports.ModerationObject$inboundSchema; - ModerationObject$2.outboundSchema = exports.ModerationObject$outboundSchema; - })(ModerationObject$ || (exports.ModerationObject$ = ModerationObject$ = {})); - function moderationObjectToJSON(moderationObject) { - return JSON.stringify(exports.ModerationObject$outboundSchema.parse(moderationObject)); - } - function moderationObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationresponse.js - var require_moderationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationResponse$ = exports.ModerationResponse$outboundSchema = exports.ModerationResponse$inboundSchema = void 0; - exports.moderationResponseToJSON = moderationResponseToJSON; - exports.moderationResponseFromJSON = moderationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var moderationobject_js_1 = require_moderationobject(); - exports.ModerationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$inboundSchema) - }); - exports.ModerationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$outboundSchema) - }); - var ModerationResponse$; - (function(ModerationResponse$2) { - ModerationResponse$2.inboundSchema = exports.ModerationResponse$inboundSchema; - ModerationResponse$2.outboundSchema = exports.ModerationResponse$outboundSchema; - })(ModerationResponse$ || (exports.ModerationResponse$ = ModerationResponse$ = {})); - function moderationResponseToJSON(moderationResponse) { - return JSON.stringify(exports.ModerationResponse$outboundSchema.parse(moderationResponse)); - } - function moderationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrimageobject.js - var require_ocrimageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrimageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRImageObject$ = exports.OCRImageObject$outboundSchema = exports.OCRImageObject$inboundSchema = void 0; - exports.ocrImageObjectToJSON = ocrImageObjectToJSON; - exports.ocrImageObjectFromJSON = ocrImageObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRImageObject$inboundSchema = z.object({ - id: z.string(), - top_left_x: z.nullable(z.number().int()), - top_left_y: z.nullable(z.number().int()), - bottom_right_x: z.nullable(z.number().int()), - bottom_right_y: z.nullable(z.number().int()), - image_base64: z.nullable(z.string()).optional(), - image_annotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_left_x": "topLeftX", - "top_left_y": "topLeftY", - "bottom_right_x": "bottomRightX", - "bottom_right_y": "bottomRightY", - "image_base64": "imageBase64", - "image_annotation": "imageAnnotation" - }); - }); - exports.OCRImageObject$outboundSchema = z.object({ - id: z.string(), - topLeftX: z.nullable(z.number().int()), - topLeftY: z.nullable(z.number().int()), - bottomRightX: z.nullable(z.number().int()), - bottomRightY: z.nullable(z.number().int()), - imageBase64: z.nullable(z.string()).optional(), - imageAnnotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topLeftX: "top_left_x", - topLeftY: "top_left_y", - bottomRightX: "bottom_right_x", - bottomRightY: "bottom_right_y", - imageBase64: "image_base64", - imageAnnotation: "image_annotation" - }); - }); - var OCRImageObject$; - (function(OCRImageObject$2) { - OCRImageObject$2.inboundSchema = exports.OCRImageObject$inboundSchema; - OCRImageObject$2.outboundSchema = exports.OCRImageObject$outboundSchema; - })(OCRImageObject$ || (exports.OCRImageObject$ = OCRImageObject$ = {})); - function ocrImageObjectToJSON(ocrImageObject) { - return JSON.stringify(exports.OCRImageObject$outboundSchema.parse(ocrImageObject)); - } - function ocrImageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRImageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRImageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js - var require_ocrpagedimensions = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageDimensions$ = exports.OCRPageDimensions$outboundSchema = exports.OCRPageDimensions$inboundSchema = void 0; - exports.ocrPageDimensionsToJSON = ocrPageDimensionsToJSON; - exports.ocrPageDimensionsFromJSON = ocrPageDimensionsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.OCRPageDimensions$inboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - exports.OCRPageDimensions$outboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - var OCRPageDimensions$; - (function(OCRPageDimensions$2) { - OCRPageDimensions$2.inboundSchema = exports.OCRPageDimensions$inboundSchema; - OCRPageDimensions$2.outboundSchema = exports.OCRPageDimensions$outboundSchema; - })(OCRPageDimensions$ || (exports.OCRPageDimensions$ = OCRPageDimensions$ = {})); - function ocrPageDimensionsToJSON(ocrPageDimensions) { - return JSON.stringify(exports.OCRPageDimensions$outboundSchema.parse(ocrPageDimensions)); - } - function ocrPageDimensionsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageDimensions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageDimensions' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpageobject.js - var require_ocrpageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageObject$ = exports.OCRPageObject$outboundSchema = exports.OCRPageObject$inboundSchema = void 0; - exports.ocrPageObjectToJSON = ocrPageObjectToJSON; - exports.ocrPageObjectFromJSON = ocrPageObjectFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var ocrimageobject_js_1 = require_ocrimageobject(); - var ocrpagedimensions_js_1 = require_ocrpagedimensions(); - exports.OCRPageObject$inboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$inboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$inboundSchema) - }); - exports.OCRPageObject$outboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$outboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$outboundSchema) - }); - var OCRPageObject$; - (function(OCRPageObject$2) { - OCRPageObject$2.inboundSchema = exports.OCRPageObject$inboundSchema; - OCRPageObject$2.outboundSchema = exports.OCRPageObject$outboundSchema; - })(OCRPageObject$ || (exports.OCRPageObject$ = OCRPageObject$ = {})); - function ocrPageObjectToJSON(ocrPageObject) { - return JSON.stringify(exports.OCRPageObject$outboundSchema.parse(ocrPageObject)); - } - function ocrPageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrrequest.js - var require_ocrrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRRequest$ = exports.OCRRequest$outboundSchema = exports.OCRRequest$inboundSchema = exports.Document$ = exports.Document$outboundSchema = exports.Document$inboundSchema = void 0; - exports.documentToJSON = documentToJSON; - exports.documentFromJSON = documentFromJSON; - exports.ocrRequestToJSON = ocrRequestToJSON; - exports.ocrRequestFromJSON = ocrRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var responseformat_js_1 = require_responseformat(); - exports.Document$inboundSchema = z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]); - exports.Document$outboundSchema = z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]); - var Document$; - (function(Document$2) { - Document$2.inboundSchema = exports.Document$inboundSchema; - Document$2.outboundSchema = exports.Document$outboundSchema; - })(Document$ || (exports.Document$ = Document$ = {})); - function documentToJSON(document) { - return JSON.stringify(exports.Document$outboundSchema.parse(document)); - } - function documentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Document$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Document' from JSON`); - } - exports.OCRRequest$inboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - include_image_base64: z.nullable(z.boolean()).optional(), - image_limit: z.nullable(z.number().int()).optional(), - image_min_size: z.nullable(z.number().int()).optional(), - bbox_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - document_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "include_image_base64": "includeImageBase64", - "image_limit": "imageLimit", - "image_min_size": "imageMinSize", - "bbox_annotation_format": "bboxAnnotationFormat", - "document_annotation_format": "documentAnnotationFormat" - }); - }); - exports.OCRRequest$outboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - includeImageBase64: z.nullable(z.boolean()).optional(), - imageLimit: z.nullable(z.number().int()).optional(), - imageMinSize: z.nullable(z.number().int()).optional(), - bboxAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - documentAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - includeImageBase64: "include_image_base64", - imageLimit: "image_limit", - imageMinSize: "image_min_size", - bboxAnnotationFormat: "bbox_annotation_format", - documentAnnotationFormat: "document_annotation_format" - }); - }); - var OCRRequest$; - (function(OCRRequest$2) { - OCRRequest$2.inboundSchema = exports.OCRRequest$inboundSchema; - OCRRequest$2.outboundSchema = exports.OCRRequest$outboundSchema; - })(OCRRequest$ || (exports.OCRRequest$ = OCRRequest$ = {})); - function ocrRequestToJSON(ocrRequest) { - return JSON.stringify(exports.OCRRequest$outboundSchema.parse(ocrRequest)); - } - function ocrRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js - var require_ocrusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRUsageInfo$ = exports.OCRUsageInfo$outboundSchema = exports.OCRUsageInfo$inboundSchema = void 0; - exports.ocrUsageInfoToJSON = ocrUsageInfoToJSON; - exports.ocrUsageInfoFromJSON = ocrUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRUsageInfo$inboundSchema = z.object({ - pages_processed: z.number().int(), - doc_size_bytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "pages_processed": "pagesProcessed", - "doc_size_bytes": "docSizeBytes" - }); - }); - exports.OCRUsageInfo$outboundSchema = z.object({ - pagesProcessed: z.number().int(), - docSizeBytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pagesProcessed: "pages_processed", - docSizeBytes: "doc_size_bytes" - }); - }); - var OCRUsageInfo$; - (function(OCRUsageInfo$2) { - OCRUsageInfo$2.inboundSchema = exports.OCRUsageInfo$inboundSchema; - OCRUsageInfo$2.outboundSchema = exports.OCRUsageInfo$outboundSchema; - })(OCRUsageInfo$ || (exports.OCRUsageInfo$ = OCRUsageInfo$ = {})); - function ocrUsageInfoToJSON(ocrUsageInfo) { - return JSON.stringify(exports.OCRUsageInfo$outboundSchema.parse(ocrUsageInfo)); - } - function ocrUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrresponse.js - var require_ocrresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRResponse$ = exports.OCRResponse$outboundSchema = exports.OCRResponse$inboundSchema = void 0; - exports.ocrResponseToJSON = ocrResponseToJSON; - exports.ocrResponseFromJSON = ocrResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ocrpageobject_js_1 = require_ocrpageobject(); - var ocrusageinfo_js_1 = require_ocrusageinfo(); - exports.OCRResponse$inboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$inboundSchema), - model: z.string(), - document_annotation: z.nullable(z.string()).optional(), - usage_info: ocrusageinfo_js_1.OCRUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_annotation": "documentAnnotation", - "usage_info": "usageInfo" - }); - }); - exports.OCRResponse$outboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$outboundSchema), - model: z.string(), - documentAnnotation: z.nullable(z.string()).optional(), - usageInfo: ocrusageinfo_js_1.OCRUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentAnnotation: "document_annotation", - usageInfo: "usage_info" - }); - }); - var OCRResponse$; - (function(OCRResponse$2) { - OCRResponse$2.inboundSchema = exports.OCRResponse$inboundSchema; - OCRResponse$2.outboundSchema = exports.OCRResponse$outboundSchema; - })(OCRResponse$ || (exports.OCRResponse$ = OCRResponse$ = {})); - function ocrResponseToJSON(ocrResponse) { - return JSON.stringify(exports.OCRResponse$outboundSchema.parse(ocrResponse)); - } - function ocrResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/processingstatusout.js - var require_processingstatusout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/processingstatusout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ProcessingStatusOut$ = exports.ProcessingStatusOut$outboundSchema = exports.ProcessingStatusOut$inboundSchema = void 0; - exports.processingStatusOutToJSON = processingStatusOutToJSON; - exports.processingStatusOutFromJSON = processingStatusOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ProcessingStatusOut$inboundSchema = z.object({ - document_id: z.string(), - processing_status: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_id": "documentId", - "processing_status": "processingStatus" - }); - }); - exports.ProcessingStatusOut$outboundSchema = z.object({ - documentId: z.string(), - processingStatus: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentId: "document_id", - processingStatus: "processing_status" - }); - }); - var ProcessingStatusOut$; - (function(ProcessingStatusOut$2) { - ProcessingStatusOut$2.inboundSchema = exports.ProcessingStatusOut$inboundSchema; - ProcessingStatusOut$2.outboundSchema = exports.ProcessingStatusOut$outboundSchema; - })(ProcessingStatusOut$ || (exports.ProcessingStatusOut$ = ProcessingStatusOut$ = {})); - function processingStatusOutToJSON(processingStatusOut) { - return JSON.stringify(exports.ProcessingStatusOut$outboundSchema.parse(processingStatusOut)); - } - function processingStatusOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ProcessingStatusOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ProcessingStatusOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/retrievefileout.js - var require_retrievefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/retrievefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveFileOut$ = exports.RetrieveFileOut$outboundSchema = exports.RetrieveFileOut$inboundSchema = void 0; - exports.retrieveFileOutToJSON = retrieveFileOutToJSON; - exports.retrieveFileOutFromJSON = retrieveFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.RetrieveFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.RetrieveFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var RetrieveFileOut$; - (function(RetrieveFileOut$2) { - RetrieveFileOut$2.inboundSchema = exports.RetrieveFileOut$inboundSchema; - RetrieveFileOut$2.outboundSchema = exports.RetrieveFileOut$outboundSchema; - })(RetrieveFileOut$ || (exports.RetrieveFileOut$ = RetrieveFileOut$ = {})); - function retrieveFileOutToJSON(retrieveFileOut) { - return JSON.stringify(exports.RetrieveFileOut$outboundSchema.parse(retrieveFileOut)); - } - function retrieveFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/security.js - var require_security2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/security.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Security$ = exports.Security$outboundSchema = exports.Security$inboundSchema = void 0; - exports.securityToJSON = securityToJSON; - exports.securityFromJSON = securityFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Security$inboundSchema = z.object({ - ApiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "ApiKey": "apiKey" - }); - }); - exports.Security$outboundSchema = z.object({ - apiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "ApiKey" - }); - }); - var Security$; - (function(Security$2) { - Security$2.inboundSchema = exports.Security$inboundSchema; - Security$2.outboundSchema = exports.Security$outboundSchema; - })(Security$ || (exports.Security$ = Security$ = {})); - function securityToJSON(security) { - return JSON.stringify(exports.Security$outboundSchema.parse(security)); - } - function securityFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Security$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Security' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/shareenum.js - var require_shareenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/shareenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ShareEnum$ = exports.ShareEnum$outboundSchema = exports.ShareEnum$inboundSchema = exports.ShareEnum = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ShareEnum = { - Viewer: "Viewer", - Editor: "Editor" - }; - exports.ShareEnum$inboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ShareEnum$outboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().and(z.custom()) - ]); - var ShareEnum$; - (function(ShareEnum$2) { - ShareEnum$2.inboundSchema = exports.ShareEnum$inboundSchema; - ShareEnum$2.outboundSchema = exports.ShareEnum$outboundSchema; - })(ShareEnum$ || (exports.ShareEnum$ = ShareEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingdelete.js - var require_sharingdelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingdelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingDelete$ = exports.SharingDelete$outboundSchema = exports.SharingDelete$inboundSchema = void 0; - exports.sharingDeleteToJSON = sharingDeleteToJSON; - exports.sharingDeleteFromJSON = sharingDeleteFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - exports.SharingDelete$inboundSchema = z.object({ - org_id: z.string(), - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingDelete$outboundSchema = z.object({ - orgId: z.string(), - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingDelete$; - (function(SharingDelete$2) { - SharingDelete$2.inboundSchema = exports.SharingDelete$inboundSchema; - SharingDelete$2.outboundSchema = exports.SharingDelete$outboundSchema; - })(SharingDelete$ || (exports.SharingDelete$ = SharingDelete$ = {})); - function sharingDeleteToJSON(sharingDelete) { - return JSON.stringify(exports.SharingDelete$outboundSchema.parse(sharingDelete)); - } - function sharingDeleteFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingDelete$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingDelete' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingin.js - var require_sharingin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingIn$ = exports.SharingIn$outboundSchema = exports.SharingIn$inboundSchema = void 0; - exports.sharingInToJSON = sharingInToJSON; - exports.sharingInFromJSON = sharingInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - var shareenum_js_1 = require_shareenum(); - exports.SharingIn$inboundSchema = z.object({ - org_id: z.string(), - level: shareenum_js_1.ShareEnum$inboundSchema, - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingIn$outboundSchema = z.object({ - orgId: z.string(), - level: shareenum_js_1.ShareEnum$outboundSchema, - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingIn$; - (function(SharingIn$2) { - SharingIn$2.inboundSchema = exports.SharingIn$inboundSchema; - SharingIn$2.outboundSchema = exports.SharingIn$outboundSchema; - })(SharingIn$ || (exports.SharingIn$ = SharingIn$ = {})); - function sharingInToJSON(sharingIn) { - return JSON.stringify(exports.SharingIn$outboundSchema.parse(sharingIn)); - } - function sharingInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js - var require_transcriptionsegmentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionSegmentChunk$ = exports.TranscriptionSegmentChunk$outboundSchema = exports.TranscriptionSegmentChunk$inboundSchema = exports.Type$ = exports.Type$outboundSchema = exports.Type$inboundSchema = exports.Type = void 0; - exports.transcriptionSegmentChunkToJSON = transcriptionSegmentChunkToJSON; - exports.transcriptionSegmentChunkFromJSON = transcriptionSegmentChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Type = { - TranscriptionSegment: "transcription_segment" - }; - exports.Type$inboundSchema = z.nativeEnum(exports.Type); - exports.Type$outboundSchema = exports.Type$inboundSchema; - var Type$; - (function(Type$2) { - Type$2.inboundSchema = exports.Type$inboundSchema; - Type$2.outboundSchema = exports.Type$outboundSchema; - })(Type$ || (exports.Type$ = Type$ = {})); - exports.TranscriptionSegmentChunk$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$inboundSchema.default("transcription_segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionSegmentChunk$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$outboundSchema.default("transcription_segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionSegmentChunk$; - (function(TranscriptionSegmentChunk$2) { - TranscriptionSegmentChunk$2.inboundSchema = exports.TranscriptionSegmentChunk$inboundSchema; - TranscriptionSegmentChunk$2.outboundSchema = exports.TranscriptionSegmentChunk$outboundSchema; - })(TranscriptionSegmentChunk$ || (exports.TranscriptionSegmentChunk$ = TranscriptionSegmentChunk$ = {})); - function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk) { - return JSON.stringify(exports.TranscriptionSegmentChunk$outboundSchema.parse(transcriptionSegmentChunk)); - } - function transcriptionSegmentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionSegmentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionSegmentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js - var require_transcriptionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionResponse$ = exports.TranscriptionResponse$outboundSchema = exports.TranscriptionResponse$inboundSchema = void 0; - exports.transcriptionResponseToJSON = transcriptionResponseToJSON; - exports.transcriptionResponseFromJSON = transcriptionResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionResponse$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionResponse$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionResponse$; - (function(TranscriptionResponse$2) { - TranscriptionResponse$2.inboundSchema = exports.TranscriptionResponse$inboundSchema; - TranscriptionResponse$2.outboundSchema = exports.TranscriptionResponse$outboundSchema; - })(TranscriptionResponse$ || (exports.TranscriptionResponse$ = TranscriptionResponse$ = {})); - function transcriptionResponseToJSON(transcriptionResponse) { - return JSON.stringify(exports.TranscriptionResponse$outboundSchema.parse(transcriptionResponse)); - } - function transcriptionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js - var require_transcriptionstreamdone = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamDone$ = exports.TranscriptionStreamDone$outboundSchema = exports.TranscriptionStreamDone$inboundSchema = exports.TranscriptionStreamDoneType$ = exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema = exports.TranscriptionStreamDoneType = void 0; - exports.transcriptionStreamDoneToJSON = transcriptionStreamDoneToJSON; - exports.transcriptionStreamDoneFromJSON = transcriptionStreamDoneFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionStreamDoneType = { - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamDoneType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamDoneType); - exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - var TranscriptionStreamDoneType$; - (function(TranscriptionStreamDoneType$2) { - TranscriptionStreamDoneType$2.inboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - TranscriptionStreamDoneType$2.outboundSchema = exports.TranscriptionStreamDoneType$outboundSchema; - })(TranscriptionStreamDoneType$ || (exports.TranscriptionStreamDoneType$ = TranscriptionStreamDoneType$ = {})); - exports.TranscriptionStreamDone$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - type: exports.TranscriptionStreamDoneType$inboundSchema.default("transcription.done"), - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamDone$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - type: exports.TranscriptionStreamDoneType$outboundSchema.default("transcription.done"), - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamDone$; - (function(TranscriptionStreamDone$2) { - TranscriptionStreamDone$2.inboundSchema = exports.TranscriptionStreamDone$inboundSchema; - TranscriptionStreamDone$2.outboundSchema = exports.TranscriptionStreamDone$outboundSchema; - })(TranscriptionStreamDone$ || (exports.TranscriptionStreamDone$ = TranscriptionStreamDone$ = {})); - function transcriptionStreamDoneToJSON(transcriptionStreamDone) { - return JSON.stringify(exports.TranscriptionStreamDone$outboundSchema.parse(transcriptionStreamDone)); - } - function transcriptionStreamDoneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamDone$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamDone' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js - var require_transcriptionstreameventtypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEventTypes$ = exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema = exports.TranscriptionStreamEventTypes = void 0; - var z = __importStar(require_zod()); - exports.TranscriptionStreamEventTypes = { - TranscriptionLanguage: "transcription.language", - TranscriptionSegment: "transcription.segment", - TranscriptionTextDelta: "transcription.text.delta", - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamEventTypes$inboundSchema = z.nativeEnum(exports.TranscriptionStreamEventTypes); - exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - var TranscriptionStreamEventTypes$; - (function(TranscriptionStreamEventTypes$2) { - TranscriptionStreamEventTypes$2.inboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - TranscriptionStreamEventTypes$2.outboundSchema = exports.TranscriptionStreamEventTypes$outboundSchema; - })(TranscriptionStreamEventTypes$ || (exports.TranscriptionStreamEventTypes$ = TranscriptionStreamEventTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js - var require_transcriptionstreamlanguage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamLanguage$ = exports.TranscriptionStreamLanguage$outboundSchema = exports.TranscriptionStreamLanguage$inboundSchema = exports.TranscriptionStreamLanguageType$ = exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema = exports.TranscriptionStreamLanguageType = void 0; - exports.transcriptionStreamLanguageToJSON = transcriptionStreamLanguageToJSON; - exports.transcriptionStreamLanguageFromJSON = transcriptionStreamLanguageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamLanguageType = { - TranscriptionLanguage: "transcription.language" - }; - exports.TranscriptionStreamLanguageType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamLanguageType); - exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - var TranscriptionStreamLanguageType$; - (function(TranscriptionStreamLanguageType$2) { - TranscriptionStreamLanguageType$2.inboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - TranscriptionStreamLanguageType$2.outboundSchema = exports.TranscriptionStreamLanguageType$outboundSchema; - })(TranscriptionStreamLanguageType$ || (exports.TranscriptionStreamLanguageType$ = TranscriptionStreamLanguageType$ = {})); - exports.TranscriptionStreamLanguage$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - type: exports.TranscriptionStreamLanguageType$inboundSchema.default("transcription.language"), - audio_language: z.string() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "audio_language": "audioLanguage" - }); - }); - exports.TranscriptionStreamLanguage$outboundSchema = z.object({ - type: exports.TranscriptionStreamLanguageType$outboundSchema.default("transcription.language"), - audioLanguage: z.string(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - audioLanguage: "audio_language", - additionalProperties: null - }) - }; - }); - var TranscriptionStreamLanguage$; - (function(TranscriptionStreamLanguage$2) { - TranscriptionStreamLanguage$2.inboundSchema = exports.TranscriptionStreamLanguage$inboundSchema; - TranscriptionStreamLanguage$2.outboundSchema = exports.TranscriptionStreamLanguage$outboundSchema; - })(TranscriptionStreamLanguage$ || (exports.TranscriptionStreamLanguage$ = TranscriptionStreamLanguage$ = {})); - function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage) { - return JSON.stringify(exports.TranscriptionStreamLanguage$outboundSchema.parse(transcriptionStreamLanguage)); - } - function transcriptionStreamLanguageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamLanguage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamLanguage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js - var require_transcriptionstreamsegmentdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamSegmentDelta$ = exports.TranscriptionStreamSegmentDelta$outboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema = exports.TranscriptionStreamSegmentDeltaType$ = exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema = exports.TranscriptionStreamSegmentDeltaType = void 0; - exports.transcriptionStreamSegmentDeltaToJSON = transcriptionStreamSegmentDeltaToJSON; - exports.transcriptionStreamSegmentDeltaFromJSON = transcriptionStreamSegmentDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamSegmentDeltaType = { - TranscriptionSegment: "transcription.segment" - }; - exports.TranscriptionStreamSegmentDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamSegmentDeltaType); - exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - var TranscriptionStreamSegmentDeltaType$; - (function(TranscriptionStreamSegmentDeltaType$2) { - TranscriptionStreamSegmentDeltaType$2.inboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - TranscriptionStreamSegmentDeltaType$2.outboundSchema = exports.TranscriptionStreamSegmentDeltaType$outboundSchema; - })(TranscriptionStreamSegmentDeltaType$ || (exports.TranscriptionStreamSegmentDeltaType$ = TranscriptionStreamSegmentDeltaType$ = {})); - exports.TranscriptionStreamSegmentDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$inboundSchema.default("transcription.segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamSegmentDelta$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$outboundSchema.default("transcription.segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamSegmentDelta$; - (function(TranscriptionStreamSegmentDelta$2) { - TranscriptionStreamSegmentDelta$2.inboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema; - TranscriptionStreamSegmentDelta$2.outboundSchema = exports.TranscriptionStreamSegmentDelta$outboundSchema; - })(TranscriptionStreamSegmentDelta$ || (exports.TranscriptionStreamSegmentDelta$ = TranscriptionStreamSegmentDelta$ = {})); - function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta) { - return JSON.stringify(exports.TranscriptionStreamSegmentDelta$outboundSchema.parse(transcriptionStreamSegmentDelta)); - } - function transcriptionStreamSegmentDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamSegmentDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamSegmentDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js - var require_transcriptionstreamtextdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamTextDelta$ = exports.TranscriptionStreamTextDelta$outboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema = exports.TranscriptionStreamTextDeltaType$ = exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema = exports.TranscriptionStreamTextDeltaType = void 0; - exports.transcriptionStreamTextDeltaToJSON = transcriptionStreamTextDeltaToJSON; - exports.transcriptionStreamTextDeltaFromJSON = transcriptionStreamTextDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamTextDeltaType = { - TranscriptionTextDelta: "transcription.text.delta" - }; - exports.TranscriptionStreamTextDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamTextDeltaType); - exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - var TranscriptionStreamTextDeltaType$; - (function(TranscriptionStreamTextDeltaType$2) { - TranscriptionStreamTextDeltaType$2.inboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - TranscriptionStreamTextDeltaType$2.outboundSchema = exports.TranscriptionStreamTextDeltaType$outboundSchema; - })(TranscriptionStreamTextDeltaType$ || (exports.TranscriptionStreamTextDeltaType$ = TranscriptionStreamTextDeltaType$ = {})); - exports.TranscriptionStreamTextDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$inboundSchema.default("transcription.text.delta") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamTextDelta$outboundSchema = z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$outboundSchema.default("transcription.text.delta"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamTextDelta$; - (function(TranscriptionStreamTextDelta$2) { - TranscriptionStreamTextDelta$2.inboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema; - TranscriptionStreamTextDelta$2.outboundSchema = exports.TranscriptionStreamTextDelta$outboundSchema; - })(TranscriptionStreamTextDelta$ || (exports.TranscriptionStreamTextDelta$ = TranscriptionStreamTextDelta$ = {})); - function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta) { - return JSON.stringify(exports.TranscriptionStreamTextDelta$outboundSchema.parse(transcriptionStreamTextDelta)); - } - function transcriptionStreamTextDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamTextDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamTextDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js - var require_transcriptionstreamevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEvents$ = exports.TranscriptionStreamEvents$outboundSchema = exports.TranscriptionStreamEvents$inboundSchema = exports.TranscriptionStreamEventsData$ = exports.TranscriptionStreamEventsData$outboundSchema = exports.TranscriptionStreamEventsData$inboundSchema = void 0; - exports.transcriptionStreamEventsDataToJSON = transcriptionStreamEventsDataToJSON; - exports.transcriptionStreamEventsDataFromJSON = transcriptionStreamEventsDataFromJSON; - exports.transcriptionStreamEventsToJSON = transcriptionStreamEventsToJSON; - exports.transcriptionStreamEventsFromJSON = transcriptionStreamEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var transcriptionstreamdone_js_1 = require_transcriptionstreamdone(); - var transcriptionstreameventtypes_js_1 = require_transcriptionstreameventtypes(); - var transcriptionstreamlanguage_js_1 = require_transcriptionstreamlanguage(); - var transcriptionstreamsegmentdelta_js_1 = require_transcriptionstreamsegmentdelta(); - var transcriptionstreamtextdelta_js_1 = require_transcriptionstreamtextdelta(); - exports.TranscriptionStreamEventsData$inboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - exports.TranscriptionStreamEventsData$outboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - var TranscriptionStreamEventsData$; - (function(TranscriptionStreamEventsData$2) { - TranscriptionStreamEventsData$2.inboundSchema = exports.TranscriptionStreamEventsData$inboundSchema; - TranscriptionStreamEventsData$2.outboundSchema = exports.TranscriptionStreamEventsData$outboundSchema; - })(TranscriptionStreamEventsData$ || (exports.TranscriptionStreamEventsData$ = TranscriptionStreamEventsData$ = {})); - function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData) { - return JSON.stringify(exports.TranscriptionStreamEventsData$outboundSchema.parse(transcriptionStreamEventsData)); - } - function transcriptionStreamEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEventsData' from JSON`); - } - exports.TranscriptionStreamEvents$inboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ type: v.type }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.TranscriptionStreamEvents$outboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$outboundSchema, - data: z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]) - }); - var TranscriptionStreamEvents$; - (function(TranscriptionStreamEvents$2) { - TranscriptionStreamEvents$2.inboundSchema = exports.TranscriptionStreamEvents$inboundSchema; - TranscriptionStreamEvents$2.outboundSchema = exports.TranscriptionStreamEvents$outboundSchema; - })(TranscriptionStreamEvents$ || (exports.TranscriptionStreamEvents$ = TranscriptionStreamEvents$ = {})); - function transcriptionStreamEventsToJSON(transcriptionStreamEvents) { - return JSON.stringify(exports.TranscriptionStreamEvents$outboundSchema.parse(transcriptionStreamEvents)); - } - function transcriptionStreamEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js - var require_unarchiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UnarchiveFTModelOut$ = exports.UnarchiveFTModelOut$outboundSchema = exports.UnarchiveFTModelOut$inboundSchema = exports.UnarchiveFTModelOutObject$ = exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema = exports.UnarchiveFTModelOutObject = void 0; - exports.unarchiveFTModelOutToJSON = unarchiveFTModelOutToJSON; - exports.unarchiveFTModelOutFromJSON = unarchiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UnarchiveFTModelOutObject = { - Model: "model" - }; - exports.UnarchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.UnarchiveFTModelOutObject); - exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - var UnarchiveFTModelOutObject$; - (function(UnarchiveFTModelOutObject$2) { - UnarchiveFTModelOutObject$2.inboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - UnarchiveFTModelOutObject$2.outboundSchema = exports.UnarchiveFTModelOutObject$outboundSchema; - })(UnarchiveFTModelOutObject$ || (exports.UnarchiveFTModelOutObject$ = UnarchiveFTModelOutObject$ = {})); - exports.UnarchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(false) - }); - exports.UnarchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(false) - }); - var UnarchiveFTModelOut$; - (function(UnarchiveFTModelOut$2) { - UnarchiveFTModelOut$2.inboundSchema = exports.UnarchiveFTModelOut$inboundSchema; - UnarchiveFTModelOut$2.outboundSchema = exports.UnarchiveFTModelOut$outboundSchema; - })(UnarchiveFTModelOut$ || (exports.UnarchiveFTModelOut$ = UnarchiveFTModelOut$ = {})); - function unarchiveFTModelOutToJSON(unarchiveFTModelOut) { - return JSON.stringify(exports.UnarchiveFTModelOut$outboundSchema.parse(unarchiveFTModelOut)); - } - function unarchiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UnarchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UnarchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/updateftmodelin.js - var require_updateftmodelin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/updateftmodelin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UpdateFTModelIn$ = exports.UpdateFTModelIn$outboundSchema = exports.UpdateFTModelIn$inboundSchema = void 0; - exports.updateFTModelInToJSON = updateFTModelInToJSON; - exports.updateFTModelInFromJSON = updateFTModelInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UpdateFTModelIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.UpdateFTModelIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var UpdateFTModelIn$; - (function(UpdateFTModelIn$2) { - UpdateFTModelIn$2.inboundSchema = exports.UpdateFTModelIn$inboundSchema; - UpdateFTModelIn$2.outboundSchema = exports.UpdateFTModelIn$outboundSchema; - })(UpdateFTModelIn$ || (exports.UpdateFTModelIn$ = UpdateFTModelIn$ = {})); - function updateFTModelInToJSON(updateFTModelIn) { - return JSON.stringify(exports.UpdateFTModelIn$outboundSchema.parse(updateFTModelIn)); - } - function updateFTModelInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UpdateFTModelIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UpdateFTModelIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/uploadfileout.js - var require_uploadfileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/uploadfileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UploadFileOut$ = exports.UploadFileOut$outboundSchema = exports.UploadFileOut$inboundSchema = void 0; - exports.uploadFileOutToJSON = uploadFileOutToJSON; - exports.uploadFileOutFromJSON = uploadFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.UploadFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.UploadFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var UploadFileOut$; - (function(UploadFileOut$2) { - UploadFileOut$2.inboundSchema = exports.UploadFileOut$inboundSchema; - UploadFileOut$2.outboundSchema = exports.UploadFileOut$outboundSchema; - })(UploadFileOut$ || (exports.UploadFileOut$ = UploadFileOut$ = {})); - function uploadFileOutToJSON(uploadFileOut) { - return JSON.stringify(exports.UploadFileOut$outboundSchema.parse(uploadFileOut)); - } - function uploadFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UploadFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UploadFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/validationerror.js - var require_validationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/validationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ValidationError$ = exports.ValidationError$outboundSchema = exports.ValidationError$inboundSchema = exports.Loc$ = exports.Loc$outboundSchema = exports.Loc$inboundSchema = void 0; - exports.locToJSON = locToJSON; - exports.locFromJSON = locFromJSON; - exports.validationErrorToJSON = validationErrorToJSON; - exports.validationErrorFromJSON = validationErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Loc$inboundSchema = z.union([z.string(), z.number().int()]); - exports.Loc$outboundSchema = z.union([z.string(), z.number().int()]); - var Loc$; - (function(Loc$2) { - Loc$2.inboundSchema = exports.Loc$inboundSchema; - Loc$2.outboundSchema = exports.Loc$outboundSchema; - })(Loc$ || (exports.Loc$ = Loc$ = {})); - function locToJSON(loc) { - return JSON.stringify(exports.Loc$outboundSchema.parse(loc)); - } - function locFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Loc$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Loc' from JSON`); - } - exports.ValidationError$inboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - exports.ValidationError$outboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - var ValidationError$; - (function(ValidationError$2) { - ValidationError$2.inboundSchema = exports.ValidationError$inboundSchema; - ValidationError$2.outboundSchema = exports.ValidationError$outboundSchema; - })(ValidationError$ || (exports.ValidationError$ = ValidationError$ = {})); - function validationErrorToJSON(validationError) { - return JSON.stringify(exports.ValidationError$outboundSchema.parse(validationError)); - } - function validationErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ValidationError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ValidationError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/index.js - var require_components = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agent(), exports); - __exportStar(require_agentconversation(), exports); - __exportStar(require_agentcreationrequest(), exports); - __exportStar(require_agenthandoffdoneevent(), exports); - __exportStar(require_agenthandoffentry(), exports); - __exportStar(require_agenthandoffstartedevent(), exports); - __exportStar(require_agentscompletionrequest(), exports); - __exportStar(require_agentscompletionstreamrequest(), exports); - __exportStar(require_agentupdaterequest(), exports); - __exportStar(require_apiendpoint(), exports); - __exportStar(require_archiveftmodelout(), exports); - __exportStar(require_assistantmessage(), exports); - __exportStar(require_audiochunk(), exports); - __exportStar(require_audiotranscriptionrequest(), exports); - __exportStar(require_audiotranscriptionrequeststream(), exports); - __exportStar(require_basemodelcard(), exports); - __exportStar(require_batcherror(), exports); - __exportStar(require_batchjobin(), exports); - __exportStar(require_batchjobout(), exports); - __exportStar(require_batchjobsout(), exports); - __exportStar(require_batchjobstatus(), exports); - __exportStar(require_builtinconnectors(), exports); - __exportStar(require_chatclassificationrequest(), exports); - __exportStar(require_chatcompletionchoice(), exports); - __exportStar(require_chatcompletionrequest(), exports); - __exportStar(require_chatcompletionresponse(), exports); - __exportStar(require_chatcompletionstreamrequest(), exports); - __exportStar(require_chatmoderationrequest(), exports); - __exportStar(require_checkpointout(), exports); - __exportStar(require_classificationrequest(), exports); - __exportStar(require_classificationresponse(), exports); - __exportStar(require_classificationtargetresult(), exports); - __exportStar(require_classifierdetailedjobout(), exports); - __exportStar(require_classifierftmodelout(), exports); - __exportStar(require_classifierjobout(), exports); - __exportStar(require_classifiertargetin(), exports); - __exportStar(require_classifiertargetout(), exports); - __exportStar(require_classifiertrainingparameters(), exports); - __exportStar(require_classifiertrainingparametersin(), exports); - __exportStar(require_codeinterpretertool(), exports); - __exportStar(require_completionargs(), exports); - __exportStar(require_completionargsstop(), exports); - __exportStar(require_completionchunk(), exports); - __exportStar(require_completiondetailedjobout(), exports); - __exportStar(require_completionevent(), exports); - __exportStar(require_completionftmodelout(), exports); - __exportStar(require_completionjobout(), exports); - __exportStar(require_completionresponsestreamchoice(), exports); - __exportStar(require_completiontrainingparameters(), exports); - __exportStar(require_completiontrainingparametersin(), exports); - __exportStar(require_contentchunk(), exports); - __exportStar(require_conversationappendrequest(), exports); - __exportStar(require_conversationappendstreamrequest(), exports); - __exportStar(require_conversationevents(), exports); - __exportStar(require_conversationhistory(), exports); - __exportStar(require_conversationinputs(), exports); - __exportStar(require_conversationmessages(), exports); - __exportStar(require_conversationrequest(), exports); - __exportStar(require_conversationresponse(), exports); - __exportStar(require_conversationrestartrequest(), exports); - __exportStar(require_conversationrestartstreamrequest(), exports); - __exportStar(require_conversationstreamrequest(), exports); - __exportStar(require_conversationusageinfo(), exports); - __exportStar(require_deletefileout(), exports); - __exportStar(require_deletemodelout(), exports); - __exportStar(require_deltamessage(), exports); - __exportStar(require_documentlibrarytool(), exports); - __exportStar(require_documentout(), exports); - __exportStar(require_documenttextcontent(), exports); - __exportStar(require_documentupdatein(), exports); - __exportStar(require_documenturlchunk(), exports); - __exportStar(require_embeddingdtype(), exports); - __exportStar(require_embeddingrequest(), exports); - __exportStar(require_embeddingresponse(), exports); - __exportStar(require_embeddingresponsedata(), exports); - __exportStar(require_encodingformat(), exports); - __exportStar(require_entitytype(), exports); - __exportStar(require_eventout(), exports); - __exportStar(require_file(), exports); - __exportStar(require_filechunk(), exports); - __exportStar(require_filepurpose(), exports); - __exportStar(require_fileschema(), exports); - __exportStar(require_filesignedurl(), exports); - __exportStar(require_fimcompletionrequest(), exports); - __exportStar(require_fimcompletionresponse(), exports); - __exportStar(require_fimcompletionstreamrequest(), exports); - __exportStar(require_finetuneablemodeltype(), exports); - __exportStar(require_ftclassifierlossfunction(), exports); - __exportStar(require_ftmodelcapabilitiesout(), exports); - __exportStar(require_ftmodelcard(), exports); - __exportStar(require_function(), exports); - __exportStar(require_functioncall(), exports); - __exportStar(require_functioncallentry(), exports); - __exportStar(require_functioncallentryarguments(), exports); - __exportStar(require_functioncallevent(), exports); - __exportStar(require_functionname(), exports); - __exportStar(require_functionresultentry(), exports); - __exportStar(require_functiontool(), exports); - __exportStar(require_githubrepositoryin(), exports); - __exportStar(require_githubrepositoryout(), exports); - __exportStar(require_imagegenerationtool(), exports); - __exportStar(require_imageurl(), exports); - __exportStar(require_imageurlchunk(), exports); - __exportStar(require_inputentries(), exports); - __exportStar(require_inputs(), exports); - __exportStar(require_instructrequest(), exports); - __exportStar(require_jobin(), exports); - __exportStar(require_jobmetadataout(), exports); - __exportStar(require_jobsout(), exports); - __exportStar(require_jsonschema(), exports); - __exportStar(require_legacyjobmetadataout(), exports); - __exportStar(require_libraryin(), exports); - __exportStar(require_libraryinupdate(), exports); - __exportStar(require_libraryout(), exports); - __exportStar(require_listdocumentout(), exports); - __exportStar(require_listfilesout(), exports); - __exportStar(require_listlibraryout(), exports); - __exportStar(require_listsharingout(), exports); - __exportStar(require_messageentries(), exports); - __exportStar(require_messageinputcontentchunks(), exports); - __exportStar(require_messageinputentry(), exports); - __exportStar(require_messageoutputcontentchunks(), exports); - __exportStar(require_messageoutputentry(), exports); - __exportStar(require_messageoutputevent(), exports); - __exportStar(require_metricout(), exports); - __exportStar(require_mistralpromptmode(), exports); - __exportStar(require_modelcapabilities(), exports); - __exportStar(require_modelconversation(), exports); - __exportStar(require_modellist(), exports); - __exportStar(require_moderationobject(), exports); - __exportStar(require_moderationresponse(), exports); - __exportStar(require_ocrimageobject(), exports); - __exportStar(require_ocrpagedimensions(), exports); - __exportStar(require_ocrpageobject(), exports); - __exportStar(require_ocrrequest(), exports); - __exportStar(require_ocrresponse(), exports); - __exportStar(require_ocrusageinfo(), exports); - __exportStar(require_outputcontentchunks(), exports); - __exportStar(require_paginationinfo(), exports); - __exportStar(require_prediction(), exports); - __exportStar(require_processingstatusout(), exports); - __exportStar(require_referencechunk(), exports); - __exportStar(require_responsedoneevent(), exports); - __exportStar(require_responseerrorevent(), exports); - __exportStar(require_responseformat(), exports); - __exportStar(require_responseformats(), exports); - __exportStar(require_responsestartedevent(), exports); - __exportStar(require_retrievefileout(), exports); - __exportStar(require_sampletype(), exports); - __exportStar(require_security2(), exports); - __exportStar(require_shareenum(), exports); - __exportStar(require_sharingdelete(), exports); - __exportStar(require_sharingin(), exports); - __exportStar(require_sharingout(), exports); - __exportStar(require_source(), exports); - __exportStar(require_ssetypes(), exports); - __exportStar(require_systemmessage(), exports); - __exportStar(require_systemmessagecontentchunks(), exports); - __exportStar(require_textchunk(), exports); - __exportStar(require_thinkchunk(), exports); - __exportStar(require_timestampgranularity(), exports); - __exportStar(require_tool(), exports); - __exportStar(require_toolcall(), exports); - __exportStar(require_toolchoice(), exports); - __exportStar(require_toolchoiceenum(), exports); - __exportStar(require_toolexecutiondeltaevent(), exports); - __exportStar(require_toolexecutiondoneevent(), exports); - __exportStar(require_toolexecutionentry(), exports); - __exportStar(require_toolexecutionstartedevent(), exports); - __exportStar(require_toolfilechunk(), exports); - __exportStar(require_toolmessage(), exports); - __exportStar(require_toolreferencechunk(), exports); - __exportStar(require_tooltypes(), exports); - __exportStar(require_trainingfile(), exports); - __exportStar(require_transcriptionresponse(), exports); - __exportStar(require_transcriptionsegmentchunk(), exports); - __exportStar(require_transcriptionstreamdone(), exports); - __exportStar(require_transcriptionstreamevents(), exports); - __exportStar(require_transcriptionstreameventtypes(), exports); - __exportStar(require_transcriptionstreamlanguage(), exports); - __exportStar(require_transcriptionstreamsegmentdelta(), exports); - __exportStar(require_transcriptionstreamtextdelta(), exports); - __exportStar(require_unarchiveftmodelout(), exports); - __exportStar(require_updateftmodelin(), exports); - __exportStar(require_uploadfileout(), exports); - __exportStar(require_usageinfo(), exports); - __exportStar(require_usermessage(), exports); - __exportStar(require_validationerror(), exports); - __exportStar(require_wandbintegration(), exports); - __exportStar(require_wandbintegrationout(), exports); - __exportStar(require_websearchpremiumtool(), exports); - __exportStar(require_websearchtool(), exports); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js - var require_httpvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPValidationError$ = exports.HTTPValidationError$outboundSchema = exports.HTTPValidationError$inboundSchema = exports.HTTPValidationError = void 0; - var z = __importStar(require_zod()); - var components = __importStar(require_components()); - var mistralerror_js_1 = require_mistralerror(); - var HTTPValidationError = class extends mistralerror_js_1.MistralError { - constructor(err, httpMeta) { - const message = "message" in err && typeof err.message === "string" ? err.message : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - if (err.detail != null) - this.detail = err.detail; - this.name = "HTTPValidationError"; - } - }; - exports.HTTPValidationError = HTTPValidationError; - exports.HTTPValidationError$inboundSchema = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), - request$: z.instanceof(Request), - response$: z.instanceof(Response), - body$: z.string() - }).transform((v) => { - return new HTTPValidationError(v, { - request: v.request$, - response: v.response$, - body: v.body$ - }); - }); - exports.HTTPValidationError$outboundSchema = z.instanceof(HTTPValidationError).transform((v) => v.data$).pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional() - })); - var HTTPValidationError$; - (function(HTTPValidationError$2) { - HTTPValidationError$2.inboundSchema = exports.HTTPValidationError$inboundSchema; - HTTPValidationError$2.outboundSchema = exports.HTTPValidationError$outboundSchema; - })(HTTPValidationError$ || (exports.HTTPValidationError$ = HTTPValidationError$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/index.js - var require_errors2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_httpclienterrors(), exports); - __exportStar(require_httpvalidationerror(), exports); - __exportStar(require_responsevalidationerror(), exports); - __exportStar(require_sdkerror(), exports); - __exportStar(require_sdkvalidationerror(), exports); - } - }); - - // node_modules/@mistralai/mistralai/types/async.js - var require_async = __commonJS({ - "node_modules/@mistralai/mistralai/types/async.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _APIPromise_promise; - var _APIPromise_unwrapped; - var _a; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.APIPromise = void 0; - var APIPromise = class { - constructor(p) { - _APIPromise_promise.set(this, void 0); - _APIPromise_unwrapped.set(this, void 0); - this[_a] = "APIPromise"; - __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f"); - __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value) : Promise.resolve(p[0]), "f"); - } - then(onfulfilled, onrejected) { - return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected); - } - catch(onrejected) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected); - } - finally(onfinally) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally); - } - $inspect() { - return __classPrivateFieldGet(this, _APIPromise_promise, "f"); - } - }; - exports.APIPromise = APIPromise; - _APIPromise_promise = /* @__PURE__ */ new WeakMap(), _APIPromise_unwrapped = /* @__PURE__ */ new WeakMap(), _a = Symbol.toStringTag; - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsComplete.js - var require_agentsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsComplete = agentsComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_completion_v1_agents_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/event-streams.js - var require_event_streams = __commonJS({ - "node_modules/@mistralai/mistralai/lib/event-streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventStream = void 0; - var EventStream = class extends ReadableStream { - constructor(responseBody, parse) { - const upstream = responseBody.getReader(); - let buffer = new Uint8Array(); - super({ - async pull(downstream) { - try { - while (true) { - const match = findBoundary(buffer); - if (!match) { - const chunk = await upstream.read(); - if (chunk.done) - return downstream.close(); - buffer = concatBuffer(buffer, chunk.value); - continue; - } - const message = buffer.slice(0, match.index); - buffer = buffer.slice(match.index + match.length); - const item = parseMessage(message, parse); - if (item?.value) - return downstream.enqueue(item.value); - if (item?.done) { - await upstream.cancel("done"); - return downstream.close(); - } - } - } catch (e) { - downstream.error(e); - await upstream.cancel(e); - } - }, - cancel: (reason) => upstream.cancel(reason) - }); - } - // Polyfill for older browsers - [Symbol.asyncIterator]() { - const fn = ReadableStream.prototype[Symbol.asyncIterator]; - if (typeof fn === "function") - return fn.call(this); - const reader = this.getReader(); - return { - next: async () => { - const r = await reader.read(); - if (r.done) { - reader.releaseLock(); - return { done: true, value: void 0 }; - } - return { done: false, value: r.value }; - }, - throw: async (e) => { - await reader.cancel(e); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - return: async () => { - await reader.cancel("done"); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - [Symbol.asyncIterator]() { - return this; - } - }; - } - }; - exports.EventStream = EventStream; - function concatBuffer(a, b) { - const c = new Uint8Array(a.length + b.length); - c.set(a, 0); - c.set(b, a.length); - return c; - } - function findBoundary(buf) { - const len = buf.length; - for (let i = 0; i < len; i++) { - if (i <= len - 4 && buf[i] === 13 && buf[i + 1] === 10 && buf[i + 2] === 13 && buf[i + 3] === 10) { - return { index: i, length: 4 }; - } - if (i <= len - 2 && buf[i] === 13 && buf[i + 1] === 13) { - return { index: i, length: 2 }; - } - if (i <= len - 2 && buf[i] === 10 && buf[i + 1] === 10) { - return { index: i, length: 2 }; - } - } - return null; - } - function parseMessage(chunk, parse) { - const text = new TextDecoder().decode(chunk); - const lines = text.split(/\r\n|\r|\n/); - const dataLines = []; - const ret = {}; - let ignore = true; - for (const line of lines) { - if (!line || line.startsWith(":")) - continue; - ignore = false; - const i = line.indexOf(":"); - const field = line.slice(0, i); - const value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1); - if (field === "data") - dataLines.push(value); - else if (field === "event") - ret.event = value; - else if (field === "id") - ret.id = value; - else if (field === "retry") { - const n = Number(value); - if (!isNaN(n)) - ret.retry = n; - } - } - if (ignore) - return; - if (dataLines.length) - ret.data = dataLines.join("\n"); - return parse(ret); - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsStream.js - var require_agentsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsStream = agentsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_agents", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/agents.js - var require_agents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/agents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agents = void 0; - var agentsComplete_js_1 = require_agentsComplete(); - var agentsStream_js_1 = require_agentsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Agents = class extends sdks_js_1.ClientSDK { - /** - * Agents Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsComplete_js_1.agentsComplete)(this, request, options)); - } - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsStream_js_1.agentsStream)(this, request, options)); - } - }; - exports.Agents = Agents; - } - }); - - // node_modules/@mistralai/mistralai/types/streams.js - var require_streams = __commonJS({ - "node_modules/@mistralai/mistralai/types/streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isReadableStream = isReadableStream; - function isReadableStream(val) { - if (typeof val !== "object" || val === null) { - return false; - } - const stream = val; - return typeof stream.getReader === "function" && typeof stream.cancel === "function" && typeof stream.tee === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js - var require_audioTranscriptionsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsComplete = audioTranscriptionsComplete; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.TranscriptionResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js - var require_audioTranscriptionsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsStream = audioTranscriptionsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequestStream$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.TranscriptionStreamEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/transcriptions.js - var require_transcriptions = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/transcriptions.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Transcriptions = void 0; - var audioTranscriptionsComplete_js_1 = require_audioTranscriptionsComplete(); - var audioTranscriptionsStream_js_1 = require_audioTranscriptionsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Transcriptions = class extends sdks_js_1.ClientSDK { - /** - * Create Transcription - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsComplete_js_1.audioTranscriptionsComplete)(this, request, options)); - } - /** - * Create streaming transcription (SSE) - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsStream_js_1.audioTranscriptionsStream)(this, request, options)); - } - }; - exports.Transcriptions = Transcriptions; - } - }); - - // node_modules/@mistralai/mistralai/sdk/audio.js - var require_audio = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/audio.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Audio = void 0; - var sdks_js_1 = require_sdks(); - var transcriptions_js_1 = require_transcriptions(); - var Audio = class extends sdks_js_1.ClientSDK { - get transcriptions() { - return this._transcriptions ?? (this._transcriptions = new transcriptions_js_1.Transcriptions(this._options)); - } - }; - exports.Audio = Audio; - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js - var require_agentsapiv1agentsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsGetRequest$ = exports.AgentsApiV1AgentsGetRequest$outboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsGetRequestToJSON = agentsApiV1AgentsGetRequestToJSON; - exports.agentsApiV1AgentsGetRequestFromJSON = agentsApiV1AgentsGetRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsGetRequest$inboundSchema = z.object({ - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsGetRequest$outboundSchema = z.object({ - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsGetRequest$; - (function(AgentsApiV1AgentsGetRequest$2) { - AgentsApiV1AgentsGetRequest$2.inboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema; - AgentsApiV1AgentsGetRequest$2.outboundSchema = exports.AgentsApiV1AgentsGetRequest$outboundSchema; - })(AgentsApiV1AgentsGetRequest$ || (exports.AgentsApiV1AgentsGetRequest$ = AgentsApiV1AgentsGetRequest$ = {})); - function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsGetRequest$outboundSchema.parse(agentsApiV1AgentsGetRequest)); - } - function agentsApiV1AgentsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsGetRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js - var require_agentsapiv1agentslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsListRequest$ = exports.AgentsApiV1AgentsListRequest$outboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsListRequestToJSON = agentsApiV1AgentsListRequestToJSON; - exports.agentsApiV1AgentsListRequestFromJSON = agentsApiV1AgentsListRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1AgentsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1AgentsListRequest$; - (function(AgentsApiV1AgentsListRequest$2) { - AgentsApiV1AgentsListRequest$2.inboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema; - AgentsApiV1AgentsListRequest$2.outboundSchema = exports.AgentsApiV1AgentsListRequest$outboundSchema; - })(AgentsApiV1AgentsListRequest$ || (exports.AgentsApiV1AgentsListRequest$ = AgentsApiV1AgentsListRequest$ = {})); - function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsListRequest$outboundSchema.parse(agentsApiV1AgentsListRequest)); - } - function agentsApiV1AgentsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsListRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js - var require_agentsapiv1agentsupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateRequest$ = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateRequestToJSON = agentsApiV1AgentsUpdateRequestToJSON; - exports.agentsApiV1AgentsUpdateRequestFromJSON = agentsApiV1AgentsUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = z.object({ - agent_id: z.string(), - AgentUpdateRequest: components.AgentUpdateRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId", - "AgentUpdateRequest": "agentUpdateRequest" - }); - }); - exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = z.object({ - agentId: z.string(), - agentUpdateRequest: components.AgentUpdateRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id", - agentUpdateRequest: "AgentUpdateRequest" - }); - }); - var AgentsApiV1AgentsUpdateRequest$; - (function(AgentsApiV1AgentsUpdateRequest$2) { - AgentsApiV1AgentsUpdateRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema; - AgentsApiV1AgentsUpdateRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateRequest$ || (exports.AgentsApiV1AgentsUpdateRequest$ = AgentsApiV1AgentsUpdateRequest$ = {})); - function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(agentsApiV1AgentsUpdateRequest)); - } - function agentsApiV1AgentsUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js - var require_agentsapiv1agentsupdateversion = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateVersionRequest$ = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateVersionRequestToJSON = agentsApiV1AgentsUpdateVersionRequestToJSON; - exports.agentsApiV1AgentsUpdateVersionRequestFromJSON = agentsApiV1AgentsUpdateVersionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = z.object({ - agent_id: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = z.object({ - agentId: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsUpdateVersionRequest$; - (function(AgentsApiV1AgentsUpdateVersionRequest$2) { - AgentsApiV1AgentsUpdateVersionRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema; - AgentsApiV1AgentsUpdateVersionRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateVersionRequest$ || (exports.AgentsApiV1AgentsUpdateVersionRequest$ = AgentsApiV1AgentsUpdateVersionRequest$ = {})); - function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(agentsApiV1AgentsUpdateVersionRequest)); - } - function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateVersionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js - var require_agentsapiv1conversationsappend = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendRequest$ = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendRequestToJSON = agentsApiV1ConversationsAppendRequestToJSON; - exports.agentsApiV1ConversationsAppendRequestFromJSON = agentsApiV1ConversationsAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendRequest: components.ConversationAppendRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendRequest": "conversationAppendRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendRequest: components.ConversationAppendRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendRequest: "ConversationAppendRequest" - }); - }); - var AgentsApiV1ConversationsAppendRequest$; - (function(AgentsApiV1ConversationsAppendRequest$2) { - AgentsApiV1ConversationsAppendRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema; - AgentsApiV1ConversationsAppendRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendRequest$ || (exports.AgentsApiV1ConversationsAppendRequest$ = AgentsApiV1ConversationsAppendRequest$ = {})); - function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(agentsApiV1ConversationsAppendRequest)); - } - function agentsApiV1ConversationsAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js - var require_agentsapiv1conversationsappendstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendStreamRequest$ = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendStreamRequestToJSON = agentsApiV1ConversationsAppendStreamRequestToJSON; - exports.agentsApiV1ConversationsAppendStreamRequestFromJSON = agentsApiV1ConversationsAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendStreamRequest": "conversationAppendStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendStreamRequest: components.ConversationAppendStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendStreamRequest: "ConversationAppendStreamRequest" - }); - }); - var AgentsApiV1ConversationsAppendStreamRequest$; - (function(AgentsApiV1ConversationsAppendStreamRequest$2) { - AgentsApiV1ConversationsAppendStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema; - AgentsApiV1ConversationsAppendStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendStreamRequest$ || (exports.AgentsApiV1ConversationsAppendStreamRequest$ = AgentsApiV1ConversationsAppendStreamRequest$ = {})); - function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(agentsApiV1ConversationsAppendStreamRequest)); - } - function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js - var require_agentsapiv1conversationsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = exports.AgentsApiV1ConversationsGetRequest$ = exports.AgentsApiV1ConversationsGetRequest$outboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsGetRequestToJSON = agentsApiV1ConversationsGetRequestToJSON; - exports.agentsApiV1ConversationsGetRequestFromJSON = agentsApiV1ConversationsGetRequestFromJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsGetRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsGetRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsGetRequest$; - (function(AgentsApiV1ConversationsGetRequest$2) { - AgentsApiV1ConversationsGetRequest$2.inboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema; - AgentsApiV1ConversationsGetRequest$2.outboundSchema = exports.AgentsApiV1ConversationsGetRequest$outboundSchema; - })(AgentsApiV1ConversationsGetRequest$ || (exports.AgentsApiV1ConversationsGetRequest$ = AgentsApiV1ConversationsGetRequest$ = {})); - function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(agentsApiV1ConversationsGetRequest)); - } - function agentsApiV1ConversationsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetRequest' from JSON`); - } - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var AgentsApiV1ConversationsGetResponseV1ConversationsGet$; - (function(AgentsApiV1ConversationsGetResponseV1ConversationsGet$2) { - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.inboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema; - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema; - })(AgentsApiV1ConversationsGetResponseV1ConversationsGet$ || (exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = {})); - function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema.parse(agentsApiV1ConversationsGetResponseV1ConversationsGet)); - } - function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetResponseV1ConversationsGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js - var require_agentsapiv1conversationshistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsHistoryRequest$ = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsHistoryRequestToJSON = agentsApiV1ConversationsHistoryRequestToJSON; - exports.agentsApiV1ConversationsHistoryRequestFromJSON = agentsApiV1ConversationsHistoryRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsHistoryRequest$; - (function(AgentsApiV1ConversationsHistoryRequest$2) { - AgentsApiV1ConversationsHistoryRequest$2.inboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema; - AgentsApiV1ConversationsHistoryRequest$2.outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema; - })(AgentsApiV1ConversationsHistoryRequest$ || (exports.AgentsApiV1ConversationsHistoryRequest$ = AgentsApiV1ConversationsHistoryRequest$ = {})); - function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(agentsApiV1ConversationsHistoryRequest)); - } - function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsHistoryRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js - var require_agentsapiv1conversationslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseBody$ = exports.ResponseBody$outboundSchema = exports.ResponseBody$inboundSchema = exports.AgentsApiV1ConversationsListRequest$ = exports.AgentsApiV1ConversationsListRequest$outboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsListRequestToJSON = agentsApiV1ConversationsListRequestToJSON; - exports.agentsApiV1ConversationsListRequestFromJSON = agentsApiV1ConversationsListRequestFromJSON; - exports.responseBodyToJSON = responseBodyToJSON; - exports.responseBodyFromJSON = responseBodyFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1ConversationsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1ConversationsListRequest$; - (function(AgentsApiV1ConversationsListRequest$2) { - AgentsApiV1ConversationsListRequest$2.inboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema; - AgentsApiV1ConversationsListRequest$2.outboundSchema = exports.AgentsApiV1ConversationsListRequest$outboundSchema; - })(AgentsApiV1ConversationsListRequest$ || (exports.AgentsApiV1ConversationsListRequest$ = AgentsApiV1ConversationsListRequest$ = {})); - function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsListRequest$outboundSchema.parse(agentsApiV1ConversationsListRequest)); - } - function agentsApiV1ConversationsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsListRequest' from JSON`); - } - exports.ResponseBody$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.ResponseBody$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var ResponseBody$; - (function(ResponseBody$2) { - ResponseBody$2.inboundSchema = exports.ResponseBody$inboundSchema; - ResponseBody$2.outboundSchema = exports.ResponseBody$outboundSchema; - })(ResponseBody$ || (exports.ResponseBody$ = ResponseBody$ = {})); - function responseBodyToJSON(responseBody) { - return JSON.stringify(exports.ResponseBody$outboundSchema.parse(responseBody)); - } - function responseBodyFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseBody' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js - var require_agentsapiv1conversationsmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsMessagesRequest$ = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsMessagesRequestToJSON = agentsApiV1ConversationsMessagesRequestToJSON; - exports.agentsApiV1ConversationsMessagesRequestFromJSON = agentsApiV1ConversationsMessagesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsMessagesRequest$; - (function(AgentsApiV1ConversationsMessagesRequest$2) { - AgentsApiV1ConversationsMessagesRequest$2.inboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema; - AgentsApiV1ConversationsMessagesRequest$2.outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema; - })(AgentsApiV1ConversationsMessagesRequest$ || (exports.AgentsApiV1ConversationsMessagesRequest$ = AgentsApiV1ConversationsMessagesRequest$ = {})); - function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(agentsApiV1ConversationsMessagesRequest)); - } - function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsMessagesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js - var require_agentsapiv1conversationsrestart = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartRequest$ = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartRequestToJSON = agentsApiV1ConversationsRestartRequestToJSON; - exports.agentsApiV1ConversationsRestartRequestFromJSON = agentsApiV1ConversationsRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartRequest: components.ConversationRestartRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartRequest": "conversationRestartRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartRequest: components.ConversationRestartRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartRequest: "ConversationRestartRequest" - }); - }); - var AgentsApiV1ConversationsRestartRequest$; - (function(AgentsApiV1ConversationsRestartRequest$2) { - AgentsApiV1ConversationsRestartRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema; - AgentsApiV1ConversationsRestartRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartRequest$ || (exports.AgentsApiV1ConversationsRestartRequest$ = AgentsApiV1ConversationsRestartRequest$ = {})); - function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(agentsApiV1ConversationsRestartRequest)); - } - function agentsApiV1ConversationsRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js - var require_agentsapiv1conversationsrestartstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartStreamRequest$ = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartStreamRequestToJSON = agentsApiV1ConversationsRestartStreamRequestToJSON; - exports.agentsApiV1ConversationsRestartStreamRequestFromJSON = agentsApiV1ConversationsRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartStreamRequest": "conversationRestartStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartStreamRequest: components.ConversationRestartStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartStreamRequest: "ConversationRestartStreamRequest" - }); - }); - var AgentsApiV1ConversationsRestartStreamRequest$; - (function(AgentsApiV1ConversationsRestartStreamRequest$2) { - AgentsApiV1ConversationsRestartStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema; - AgentsApiV1ConversationsRestartStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartStreamRequest$ || (exports.AgentsApiV1ConversationsRestartStreamRequest$ = AgentsApiV1ConversationsRestartStreamRequest$ = {})); - function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(agentsApiV1ConversationsRestartStreamRequest)); - } - function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js - var require_deletemodelv1modelsmodeliddelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$ = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = void 0; - exports.deleteModelV1ModelsModelIdDeleteRequestToJSON = deleteModelV1ModelsModelIdDeleteRequestToJSON; - exports.deleteModelV1ModelsModelIdDeleteRequestFromJSON = deleteModelV1ModelsModelIdDeleteRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var DeleteModelV1ModelsModelIdDeleteRequest$; - (function(DeleteModelV1ModelsModelIdDeleteRequest$2) { - DeleteModelV1ModelsModelIdDeleteRequest$2.inboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema; - DeleteModelV1ModelsModelIdDeleteRequest$2.outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema; - })(DeleteModelV1ModelsModelIdDeleteRequest$ || (exports.DeleteModelV1ModelsModelIdDeleteRequest$ = DeleteModelV1ModelsModelIdDeleteRequest$ = {})); - function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest) { - return JSON.stringify(exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(deleteModelV1ModelsModelIdDeleteRequest)); - } - function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelV1ModelsModelIdDeleteRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js - var require_filesapiroutesdeletefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDeleteFileRequest$ = exports.FilesApiRoutesDeleteFileRequest$outboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDeleteFileRequestToJSON = filesApiRoutesDeleteFileRequestToJSON; - exports.filesApiRoutesDeleteFileRequestFromJSON = filesApiRoutesDeleteFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDeleteFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDeleteFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDeleteFileRequest$; - (function(FilesApiRoutesDeleteFileRequest$2) { - FilesApiRoutesDeleteFileRequest$2.inboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema; - FilesApiRoutesDeleteFileRequest$2.outboundSchema = exports.FilesApiRoutesDeleteFileRequest$outboundSchema; - })(FilesApiRoutesDeleteFileRequest$ || (exports.FilesApiRoutesDeleteFileRequest$ = FilesApiRoutesDeleteFileRequest$ = {})); - function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(filesApiRoutesDeleteFileRequest)); - } - function filesApiRoutesDeleteFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDeleteFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDeleteFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js - var require_filesapiroutesdownloadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDownloadFileRequest$ = exports.FilesApiRoutesDownloadFileRequest$outboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDownloadFileRequestToJSON = filesApiRoutesDownloadFileRequestToJSON; - exports.filesApiRoutesDownloadFileRequestFromJSON = filesApiRoutesDownloadFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDownloadFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDownloadFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDownloadFileRequest$; - (function(FilesApiRoutesDownloadFileRequest$2) { - FilesApiRoutesDownloadFileRequest$2.inboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema; - FilesApiRoutesDownloadFileRequest$2.outboundSchema = exports.FilesApiRoutesDownloadFileRequest$outboundSchema; - })(FilesApiRoutesDownloadFileRequest$ || (exports.FilesApiRoutesDownloadFileRequest$ = FilesApiRoutesDownloadFileRequest$ = {})); - function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(filesApiRoutesDownloadFileRequest)); - } - function filesApiRoutesDownloadFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDownloadFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDownloadFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js - var require_filesapiroutesgetsignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesGetSignedUrlRequest$ = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = void 0; - exports.filesApiRoutesGetSignedUrlRequestToJSON = filesApiRoutesGetSignedUrlRequestToJSON; - exports.filesApiRoutesGetSignedUrlRequestFromJSON = filesApiRoutesGetSignedUrlRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = z.object({ - file_id: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = z.object({ - fileId: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesGetSignedUrlRequest$; - (function(FilesApiRoutesGetSignedUrlRequest$2) { - FilesApiRoutesGetSignedUrlRequest$2.inboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema; - FilesApiRoutesGetSignedUrlRequest$2.outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema; - })(FilesApiRoutesGetSignedUrlRequest$ || (exports.FilesApiRoutesGetSignedUrlRequest$ = FilesApiRoutesGetSignedUrlRequest$ = {})); - function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest) { - return JSON.stringify(exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(filesApiRoutesGetSignedUrlRequest)); - } - function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesGetSignedUrlRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js - var require_filesapirouteslistfiles = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesListFilesRequest$ = exports.FilesApiRoutesListFilesRequest$outboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema = void 0; - exports.filesApiRoutesListFilesRequestToJSON = filesApiRoutesListFilesRequestToJSON; - exports.filesApiRoutesListFilesRequestFromJSON = filesApiRoutesListFilesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.FilesApiRoutesListFilesRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - sample_type: z.nullable(z.array(components.SampleType$inboundSchema)).optional(), - source: z.nullable(z.array(components.Source$inboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "sample_type": "sampleType" - }); - }); - exports.FilesApiRoutesListFilesRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - sampleType: z.nullable(z.array(components.SampleType$outboundSchema)).optional(), - source: z.nullable(z.array(components.Source$outboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - sampleType: "sample_type" - }); - }); - var FilesApiRoutesListFilesRequest$; - (function(FilesApiRoutesListFilesRequest$2) { - FilesApiRoutesListFilesRequest$2.inboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema; - FilesApiRoutesListFilesRequest$2.outboundSchema = exports.FilesApiRoutesListFilesRequest$outboundSchema; - })(FilesApiRoutesListFilesRequest$ || (exports.FilesApiRoutesListFilesRequest$ = FilesApiRoutesListFilesRequest$ = {})); - function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest) { - return JSON.stringify(exports.FilesApiRoutesListFilesRequest$outboundSchema.parse(filesApiRoutesListFilesRequest)); - } - function filesApiRoutesListFilesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesListFilesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesListFilesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js - var require_filesapiroutesretrievefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesRetrieveFileRequest$ = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = void 0; - exports.filesApiRoutesRetrieveFileRequestToJSON = filesApiRoutesRetrieveFileRequestToJSON; - exports.filesApiRoutesRetrieveFileRequestFromJSON = filesApiRoutesRetrieveFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesRetrieveFileRequest$; - (function(FilesApiRoutesRetrieveFileRequest$2) { - FilesApiRoutesRetrieveFileRequest$2.inboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema; - FilesApiRoutesRetrieveFileRequest$2.outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema; - })(FilesApiRoutesRetrieveFileRequest$ || (exports.FilesApiRoutesRetrieveFileRequest$ = FilesApiRoutesRetrieveFileRequest$ = {})); - function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest) { - return JSON.stringify(exports.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(filesApiRoutesRetrieveFileRequest)); - } - function filesApiRoutesRetrieveFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesRetrieveFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesRetrieveFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js - var require_filesapiroutesuploadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = void 0; - exports.filesApiRoutesUploadFileMultiPartBodyParamsToJSON = filesApiRoutesUploadFileMultiPartBodyParamsToJSON; - exports.filesApiRoutesUploadFileMultiPartBodyParamsFromJSON = filesApiRoutesUploadFileMultiPartBodyParamsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = z.object({ - purpose: components.FilePurpose$inboundSchema.optional(), - file: components.FileT$inboundSchema - }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = z.object({ - purpose: components.FilePurpose$outboundSchema.optional(), - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var FilesApiRoutesUploadFileMultiPartBodyParams$; - (function(FilesApiRoutesUploadFileMultiPartBodyParams$2) { - FilesApiRoutesUploadFileMultiPartBodyParams$2.inboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema; - FilesApiRoutesUploadFileMultiPartBodyParams$2.outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema; - })(FilesApiRoutesUploadFileMultiPartBodyParams$ || (exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = FilesApiRoutesUploadFileMultiPartBodyParams$ = {})); - function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams) { - return JSON.stringify(exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(filesApiRoutesUploadFileMultiPartBodyParams)); - } - function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesUploadFileMultiPartBodyParams' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js - var require_jobsapiroutesbatchcancelbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$ = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchCancelBatchJobRequestToJSON = jobsApiRoutesBatchCancelBatchJobRequestToJSON; - exports.jobsApiRoutesBatchCancelBatchJobRequestFromJSON = jobsApiRoutesBatchCancelBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchCancelBatchJobRequest$; - (function(JobsApiRoutesBatchCancelBatchJobRequest$2) { - JobsApiRoutesBatchCancelBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema; - JobsApiRoutesBatchCancelBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchCancelBatchJobRequest$ || (exports.JobsApiRoutesBatchCancelBatchJobRequest$ = JobsApiRoutesBatchCancelBatchJobRequest$ = {})); - function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchCancelBatchJobRequest)); - } - function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchCancelBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js - var require_jobsapiroutesbatchgetbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobRequest$ = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobRequestToJSON = jobsApiRoutesBatchGetBatchJobRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobRequestFromJSON = jobsApiRoutesBatchGetBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchGetBatchJobRequest$; - (function(JobsApiRoutesBatchGetBatchJobRequest$2) { - JobsApiRoutesBatchGetBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobRequest$ || (exports.JobsApiRoutesBatchGetBatchJobRequest$ = JobsApiRoutesBatchGetBatchJobRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobRequest)); - } - function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js - var require_jobsapiroutesbatchgetbatchjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$ = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobsRequestToJSON = jobsApiRoutesBatchGetBatchJobsRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobsRequestFromJSON = jobsApiRoutesBatchGetBatchJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "agent_id": "agentId", - "created_after": "createdAfter", - "created_by_me": "createdByMe" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - agentId: "agent_id", - createdAfter: "created_after", - createdByMe: "created_by_me" - }); - }); - var JobsApiRoutesBatchGetBatchJobsRequest$; - (function(JobsApiRoutesBatchGetBatchJobsRequest$2) { - JobsApiRoutesBatchGetBatchJobsRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobsRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobsRequest$ || (exports.JobsApiRoutesBatchGetBatchJobsRequest$ = JobsApiRoutesBatchGetBatchJobsRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobsRequest)); - } - function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningArchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningArchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningArchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js - var require_jobsapiroutesfinetuningcancelfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningCancelFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobRequest$2) { - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningCancelFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js - var require_jobsapiroutesfinetuningcreatefinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = void 0; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.One$inboundSchema = z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.One$outboundSchema = z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = z.union([ - components.LegacyJobMetadataOut$inboundSchema, - z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]) - ]); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = z.union([ - components.LegacyJobMetadataOut$outboundSchema, - z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]) - ]); - var JobsApiRoutesFineTuningCreateFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCreateFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCreateFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCreateFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCreateFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js - var require_jobsapiroutesfinetuninggetfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = JobsApiRoutesFineTuningGetFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningGetFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningGetFineTuningJobResponse$2) { - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = JobsApiRoutesFineTuningGetFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js - var require_jobsapiroutesfinetuninggetfinetuningjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.Status = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_before: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(exports.Status$inboundSchema).optional(), - wandb_project: z.nullable(z.string()).optional(), - wandb_name: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "created_after": "createdAfter", - "created_before": "createdBefore", - "created_by_me": "createdByMe", - "wandb_project": "wandbProject", - "wandb_name": "wandbName" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdBefore: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(exports.Status$outboundSchema).optional(), - wandbProject: z.nullable(z.string()).optional(), - wandbName: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - createdAfter: "created_after", - createdBefore: "created_before", - createdByMe: "created_by_me", - wandbProject: "wandb_project", - wandbName: "wandb_name" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobsRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobsRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobsRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobsRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js - var require_jobsapiroutesfinetuningstartfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningStartFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningStartFineTuningJobRequest$2) { - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = JobsApiRoutesFineTuningStartFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningStartFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningStartFineTuningJobResponse$2) { - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = JobsApiRoutesFineTuningStartFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningunarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js - var require_jobsapiroutesfinetuningupdatefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string(), - UpdateFTModelIn: components.UpdateFTModelIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId", - "UpdateFTModelIn": "updateFTModelIn" - }); - }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string(), - updateFTModelIn: components.UpdateFTModelIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id", - updateFTModelIn: "UpdateFTModelIn" - }); - }); - var JobsApiRoutesFineTuningUpdateFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = z.union([ - components.ClassifierFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("classifier") }).transform((v) => ({ - modelType: v.model_type - }))), - components.CompletionFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("completion") }).transform((v) => ({ - modelType: v.model_type - }))) - ]); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = z.union([ - components.ClassifierFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("classifier") }).transform((v) => ({ - model_type: v.modelType - }))), - components.CompletionFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("completion") }).transform((v) => ({ - model_type: v.modelType - }))) - ]); - var JobsApiRoutesFineTuningUpdateFineTunedModelResponse$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelResponse)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js - var require_librariesdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDeleteV1Request$ = exports.LibrariesDeleteV1Request$outboundSchema = exports.LibrariesDeleteV1Request$inboundSchema = void 0; - exports.librariesDeleteV1RequestToJSON = librariesDeleteV1RequestToJSON; - exports.librariesDeleteV1RequestFromJSON = librariesDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDeleteV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesDeleteV1Request$; - (function(LibrariesDeleteV1Request$2) { - LibrariesDeleteV1Request$2.inboundSchema = exports.LibrariesDeleteV1Request$inboundSchema; - LibrariesDeleteV1Request$2.outboundSchema = exports.LibrariesDeleteV1Request$outboundSchema; - })(LibrariesDeleteV1Request$ || (exports.LibrariesDeleteV1Request$ = LibrariesDeleteV1Request$ = {})); - function librariesDeleteV1RequestToJSON(librariesDeleteV1Request) { - return JSON.stringify(exports.LibrariesDeleteV1Request$outboundSchema.parse(librariesDeleteV1Request)); - } - function librariesDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js - var require_librariesdocumentsdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsDeleteV1Request$ = exports.LibrariesDocumentsDeleteV1Request$outboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema = void 0; - exports.librariesDocumentsDeleteV1RequestToJSON = librariesDocumentsDeleteV1RequestToJSON; - exports.librariesDocumentsDeleteV1RequestFromJSON = librariesDocumentsDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsDeleteV1Request$; - (function(LibrariesDocumentsDeleteV1Request$2) { - LibrariesDocumentsDeleteV1Request$2.inboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema; - LibrariesDocumentsDeleteV1Request$2.outboundSchema = exports.LibrariesDocumentsDeleteV1Request$outboundSchema; - })(LibrariesDocumentsDeleteV1Request$ || (exports.LibrariesDocumentsDeleteV1Request$ = LibrariesDocumentsDeleteV1Request$ = {})); - function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request) { - return JSON.stringify(exports.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(librariesDocumentsDeleteV1Request)); - } - function librariesDocumentsDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js - var require_librariesdocumentsgetextractedtextsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetExtractedTextSignedUrlV1Request$; - (function(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2) { - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ || (exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = {})); - function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetExtractedTextSignedUrlV1Request)); - } - function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetExtractedTextSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js - var require_librariesdocumentsgetsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetSignedUrlV1Request$ = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetSignedUrlV1RequestToJSON = librariesDocumentsGetSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetSignedUrlV1RequestFromJSON = librariesDocumentsGetSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetSignedUrlV1Request$; - (function(LibrariesDocumentsGetSignedUrlV1Request$2) { - LibrariesDocumentsGetSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetSignedUrlV1Request$ || (exports.LibrariesDocumentsGetSignedUrlV1Request$ = LibrariesDocumentsGetSignedUrlV1Request$ = {})); - function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetSignedUrlV1Request)); - } - function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js - var require_librariesdocumentsgetstatusv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetStatusV1Request$ = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetStatusV1RequestToJSON = librariesDocumentsGetStatusV1RequestToJSON; - exports.librariesDocumentsGetStatusV1RequestFromJSON = librariesDocumentsGetStatusV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetStatusV1Request$; - (function(LibrariesDocumentsGetStatusV1Request$2) { - LibrariesDocumentsGetStatusV1Request$2.inboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema; - LibrariesDocumentsGetStatusV1Request$2.outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema; - })(LibrariesDocumentsGetStatusV1Request$ || (exports.LibrariesDocumentsGetStatusV1Request$ = LibrariesDocumentsGetStatusV1Request$ = {})); - function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(librariesDocumentsGetStatusV1Request)); - } - function librariesDocumentsGetStatusV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetStatusV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetStatusV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js - var require_librariesdocumentsgettextcontentv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetTextContentV1Request$ = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetTextContentV1RequestToJSON = librariesDocumentsGetTextContentV1RequestToJSON; - exports.librariesDocumentsGetTextContentV1RequestFromJSON = librariesDocumentsGetTextContentV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetTextContentV1Request$; - (function(LibrariesDocumentsGetTextContentV1Request$2) { - LibrariesDocumentsGetTextContentV1Request$2.inboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema; - LibrariesDocumentsGetTextContentV1Request$2.outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema; - })(LibrariesDocumentsGetTextContentV1Request$ || (exports.LibrariesDocumentsGetTextContentV1Request$ = LibrariesDocumentsGetTextContentV1Request$ = {})); - function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(librariesDocumentsGetTextContentV1Request)); - } - function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetTextContentV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js - var require_librariesdocumentsgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetV1Request$ = exports.LibrariesDocumentsGetV1Request$outboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetV1RequestToJSON = librariesDocumentsGetV1RequestToJSON; - exports.librariesDocumentsGetV1RequestFromJSON = librariesDocumentsGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetV1Request$; - (function(LibrariesDocumentsGetV1Request$2) { - LibrariesDocumentsGetV1Request$2.inboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema; - LibrariesDocumentsGetV1Request$2.outboundSchema = exports.LibrariesDocumentsGetV1Request$outboundSchema; - })(LibrariesDocumentsGetV1Request$ || (exports.LibrariesDocumentsGetV1Request$ = LibrariesDocumentsGetV1Request$ = {})); - function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetV1Request$outboundSchema.parse(librariesDocumentsGetV1Request)); - } - function librariesDocumentsGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js - var require_librariesdocumentslistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsListV1Request$ = exports.LibrariesDocumentsListV1Request$outboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema = void 0; - exports.librariesDocumentsListV1RequestToJSON = librariesDocumentsListV1RequestToJSON; - exports.librariesDocumentsListV1RequestFromJSON = librariesDocumentsListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsListV1Request$inboundSchema = z.object({ - library_id: z.string(), - search: z.nullable(z.string()).optional(), - page_size: z.number().int().default(100), - page: z.number().int().default(0), - sort_by: z.string().default("created_at"), - sort_order: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "page_size": "pageSize", - "sort_by": "sortBy", - "sort_order": "sortOrder" - }); - }); - exports.LibrariesDocumentsListV1Request$outboundSchema = z.object({ - libraryId: z.string(), - search: z.nullable(z.string()).optional(), - pageSize: z.number().int().default(100), - page: z.number().int().default(0), - sortBy: z.string().default("created_at"), - sortOrder: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - pageSize: "page_size", - sortBy: "sort_by", - sortOrder: "sort_order" - }); - }); - var LibrariesDocumentsListV1Request$; - (function(LibrariesDocumentsListV1Request$2) { - LibrariesDocumentsListV1Request$2.inboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema; - LibrariesDocumentsListV1Request$2.outboundSchema = exports.LibrariesDocumentsListV1Request$outboundSchema; - })(LibrariesDocumentsListV1Request$ || (exports.LibrariesDocumentsListV1Request$ = LibrariesDocumentsListV1Request$ = {})); - function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request) { - return JSON.stringify(exports.LibrariesDocumentsListV1Request$outboundSchema.parse(librariesDocumentsListV1Request)); - } - function librariesDocumentsListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js - var require_librariesdocumentsreprocessv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsReprocessV1Request$ = exports.LibrariesDocumentsReprocessV1Request$outboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema = void 0; - exports.librariesDocumentsReprocessV1RequestToJSON = librariesDocumentsReprocessV1RequestToJSON; - exports.librariesDocumentsReprocessV1RequestFromJSON = librariesDocumentsReprocessV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsReprocessV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsReprocessV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsReprocessV1Request$; - (function(LibrariesDocumentsReprocessV1Request$2) { - LibrariesDocumentsReprocessV1Request$2.inboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema; - LibrariesDocumentsReprocessV1Request$2.outboundSchema = exports.LibrariesDocumentsReprocessV1Request$outboundSchema; - })(LibrariesDocumentsReprocessV1Request$ || (exports.LibrariesDocumentsReprocessV1Request$ = LibrariesDocumentsReprocessV1Request$ = {})); - function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request) { - return JSON.stringify(exports.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(librariesDocumentsReprocessV1Request)); - } - function librariesDocumentsReprocessV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsReprocessV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsReprocessV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js - var require_librariesdocumentsupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUpdateV1Request$ = exports.LibrariesDocumentsUpdateV1Request$outboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema = void 0; - exports.librariesDocumentsUpdateV1RequestToJSON = librariesDocumentsUpdateV1RequestToJSON; - exports.librariesDocumentsUpdateV1RequestFromJSON = librariesDocumentsUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string(), - DocumentUpdateIn: components.DocumentUpdateIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId", - "DocumentUpdateIn": "documentUpdateIn" - }); - }); - exports.LibrariesDocumentsUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string(), - documentUpdateIn: components.DocumentUpdateIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id", - documentUpdateIn: "DocumentUpdateIn" - }); - }); - var LibrariesDocumentsUpdateV1Request$; - (function(LibrariesDocumentsUpdateV1Request$2) { - LibrariesDocumentsUpdateV1Request$2.inboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema; - LibrariesDocumentsUpdateV1Request$2.outboundSchema = exports.LibrariesDocumentsUpdateV1Request$outboundSchema; - })(LibrariesDocumentsUpdateV1Request$ || (exports.LibrariesDocumentsUpdateV1Request$ = LibrariesDocumentsUpdateV1Request$ = {})); - function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(librariesDocumentsUpdateV1Request)); - } - function librariesDocumentsUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js - var require_librariesdocumentsuploadv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUploadV1Request$ = exports.LibrariesDocumentsUploadV1Request$outboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$ = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = void 0; - exports.librariesDocumentsUploadV1DocumentUploadToJSON = librariesDocumentsUploadV1DocumentUploadToJSON; - exports.librariesDocumentsUploadV1DocumentUploadFromJSON = librariesDocumentsUploadV1DocumentUploadFromJSON; - exports.librariesDocumentsUploadV1RequestToJSON = librariesDocumentsUploadV1RequestToJSON; - exports.librariesDocumentsUploadV1RequestFromJSON = librariesDocumentsUploadV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = z.object({ - file: components.FileT$inboundSchema - }); - exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = z.object({ - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var LibrariesDocumentsUploadV1DocumentUpload$; - (function(LibrariesDocumentsUploadV1DocumentUpload$2) { - LibrariesDocumentsUploadV1DocumentUpload$2.inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema; - LibrariesDocumentsUploadV1DocumentUpload$2.outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema; - })(LibrariesDocumentsUploadV1DocumentUpload$ || (exports.LibrariesDocumentsUploadV1DocumentUpload$ = LibrariesDocumentsUploadV1DocumentUpload$ = {})); - function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema.parse(librariesDocumentsUploadV1DocumentUpload)); - } - function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1DocumentUpload' from JSON`); - } - exports.LibrariesDocumentsUploadV1Request$inboundSchema = z.object({ - library_id: z.string(), - RequestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "RequestBody": "requestBody" - }); - }); - exports.LibrariesDocumentsUploadV1Request$outboundSchema = z.object({ - libraryId: z.string(), - requestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - requestBody: "RequestBody" - }); - }); - var LibrariesDocumentsUploadV1Request$; - (function(LibrariesDocumentsUploadV1Request$2) { - LibrariesDocumentsUploadV1Request$2.inboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema; - LibrariesDocumentsUploadV1Request$2.outboundSchema = exports.LibrariesDocumentsUploadV1Request$outboundSchema; - })(LibrariesDocumentsUploadV1Request$ || (exports.LibrariesDocumentsUploadV1Request$ = LibrariesDocumentsUploadV1Request$ = {})); - function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1Request$outboundSchema.parse(librariesDocumentsUploadV1Request)); - } - function librariesDocumentsUploadV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js - var require_librariesgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesGetV1Request$ = exports.LibrariesGetV1Request$outboundSchema = exports.LibrariesGetV1Request$inboundSchema = void 0; - exports.librariesGetV1RequestToJSON = librariesGetV1RequestToJSON; - exports.librariesGetV1RequestFromJSON = librariesGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesGetV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesGetV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesGetV1Request$; - (function(LibrariesGetV1Request$2) { - LibrariesGetV1Request$2.inboundSchema = exports.LibrariesGetV1Request$inboundSchema; - LibrariesGetV1Request$2.outboundSchema = exports.LibrariesGetV1Request$outboundSchema; - })(LibrariesGetV1Request$ || (exports.LibrariesGetV1Request$ = LibrariesGetV1Request$ = {})); - function librariesGetV1RequestToJSON(librariesGetV1Request) { - return JSON.stringify(exports.LibrariesGetV1Request$outboundSchema.parse(librariesGetV1Request)); - } - function librariesGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js - var require_librariessharecreatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareCreateV1Request$ = exports.LibrariesShareCreateV1Request$outboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema = void 0; - exports.librariesShareCreateV1RequestToJSON = librariesShareCreateV1RequestToJSON; - exports.librariesShareCreateV1RequestFromJSON = librariesShareCreateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareCreateV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingIn: components.SharingIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingIn": "sharingIn" - }); - }); - exports.LibrariesShareCreateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingIn: components.SharingIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingIn: "SharingIn" - }); - }); - var LibrariesShareCreateV1Request$; - (function(LibrariesShareCreateV1Request$2) { - LibrariesShareCreateV1Request$2.inboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema; - LibrariesShareCreateV1Request$2.outboundSchema = exports.LibrariesShareCreateV1Request$outboundSchema; - })(LibrariesShareCreateV1Request$ || (exports.LibrariesShareCreateV1Request$ = LibrariesShareCreateV1Request$ = {})); - function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request) { - return JSON.stringify(exports.LibrariesShareCreateV1Request$outboundSchema.parse(librariesShareCreateV1Request)); - } - function librariesShareCreateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareCreateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareCreateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js - var require_librariessharedeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareDeleteV1Request$ = exports.LibrariesShareDeleteV1Request$outboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema = void 0; - exports.librariesShareDeleteV1RequestToJSON = librariesShareDeleteV1RequestToJSON; - exports.librariesShareDeleteV1RequestFromJSON = librariesShareDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingDelete: components.SharingDelete$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingDelete": "sharingDelete" - }); - }); - exports.LibrariesShareDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingDelete: components.SharingDelete$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingDelete: "SharingDelete" - }); - }); - var LibrariesShareDeleteV1Request$; - (function(LibrariesShareDeleteV1Request$2) { - LibrariesShareDeleteV1Request$2.inboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema; - LibrariesShareDeleteV1Request$2.outboundSchema = exports.LibrariesShareDeleteV1Request$outboundSchema; - })(LibrariesShareDeleteV1Request$ || (exports.LibrariesShareDeleteV1Request$ = LibrariesShareDeleteV1Request$ = {})); - function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request) { - return JSON.stringify(exports.LibrariesShareDeleteV1Request$outboundSchema.parse(librariesShareDeleteV1Request)); - } - function librariesShareDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js - var require_librariessharelistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareListV1Request$ = exports.LibrariesShareListV1Request$outboundSchema = exports.LibrariesShareListV1Request$inboundSchema = void 0; - exports.librariesShareListV1RequestToJSON = librariesShareListV1RequestToJSON; - exports.librariesShareListV1RequestFromJSON = librariesShareListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesShareListV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesShareListV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesShareListV1Request$; - (function(LibrariesShareListV1Request$2) { - LibrariesShareListV1Request$2.inboundSchema = exports.LibrariesShareListV1Request$inboundSchema; - LibrariesShareListV1Request$2.outboundSchema = exports.LibrariesShareListV1Request$outboundSchema; - })(LibrariesShareListV1Request$ || (exports.LibrariesShareListV1Request$ = LibrariesShareListV1Request$ = {})); - function librariesShareListV1RequestToJSON(librariesShareListV1Request) { - return JSON.stringify(exports.LibrariesShareListV1Request$outboundSchema.parse(librariesShareListV1Request)); - } - function librariesShareListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js - var require_librariesupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesUpdateV1Request$ = exports.LibrariesUpdateV1Request$outboundSchema = exports.LibrariesUpdateV1Request$inboundSchema = void 0; - exports.librariesUpdateV1RequestToJSON = librariesUpdateV1RequestToJSON; - exports.librariesUpdateV1RequestFromJSON = librariesUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - LibraryInUpdate: components.LibraryInUpdate$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "LibraryInUpdate": "libraryInUpdate" - }); - }); - exports.LibrariesUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - libraryInUpdate: components.LibraryInUpdate$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - libraryInUpdate: "LibraryInUpdate" - }); - }); - var LibrariesUpdateV1Request$; - (function(LibrariesUpdateV1Request$2) { - LibrariesUpdateV1Request$2.inboundSchema = exports.LibrariesUpdateV1Request$inboundSchema; - LibrariesUpdateV1Request$2.outboundSchema = exports.LibrariesUpdateV1Request$outboundSchema; - })(LibrariesUpdateV1Request$ || (exports.LibrariesUpdateV1Request$ = LibrariesUpdateV1Request$ = {})); - function librariesUpdateV1RequestToJSON(librariesUpdateV1Request) { - return JSON.stringify(exports.LibrariesUpdateV1Request$outboundSchema.parse(librariesUpdateV1Request)); - } - function librariesUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js - var require_retrievemodelv1modelsmodelidget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$ = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = void 0; - exports.retrieveModelV1ModelsModelIdGetRequestToJSON = retrieveModelV1ModelsModelIdGetRequestToJSON; - exports.retrieveModelV1ModelsModelIdGetRequestFromJSON = retrieveModelV1ModelsModelIdGetRequestFromJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var RetrieveModelV1ModelsModelIdGetRequest$; - (function(RetrieveModelV1ModelsModelIdGetRequest$2) { - RetrieveModelV1ModelsModelIdGetRequest$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema; - RetrieveModelV1ModelsModelIdGetRequest$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetRequest$ || (exports.RetrieveModelV1ModelsModelIdGetRequest$ = RetrieveModelV1ModelsModelIdGetRequest$ = {})); - function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(retrieveModelV1ModelsModelIdGetRequest)); - } - function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetRequest' from JSON`); - } - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = z.union([ - components.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = z.union([ - components.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$; - (function(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2) { - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema; - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ || (exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = {})); - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema.parse(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet)); - } - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/index.js - var require_operations = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agentsapiv1agentsget(), exports); - __exportStar(require_agentsapiv1agentslist(), exports); - __exportStar(require_agentsapiv1agentsupdate(), exports); - __exportStar(require_agentsapiv1agentsupdateversion(), exports); - __exportStar(require_agentsapiv1conversationsappend(), exports); - __exportStar(require_agentsapiv1conversationsappendstream(), exports); - __exportStar(require_agentsapiv1conversationsget(), exports); - __exportStar(require_agentsapiv1conversationshistory(), exports); - __exportStar(require_agentsapiv1conversationslist(), exports); - __exportStar(require_agentsapiv1conversationsmessages(), exports); - __exportStar(require_agentsapiv1conversationsrestart(), exports); - __exportStar(require_agentsapiv1conversationsrestartstream(), exports); - __exportStar(require_deletemodelv1modelsmodeliddelete(), exports); - __exportStar(require_filesapiroutesdeletefile(), exports); - __exportStar(require_filesapiroutesdownloadfile(), exports); - __exportStar(require_filesapiroutesgetsignedurl(), exports); - __exportStar(require_filesapirouteslistfiles(), exports); - __exportStar(require_filesapiroutesretrievefile(), exports); - __exportStar(require_filesapiroutesuploadfile(), exports); - __exportStar(require_jobsapiroutesbatchcancelbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningcancelfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningcreatefinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningstartfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningunarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningupdatefinetunedmodel(), exports); - __exportStar(require_librariesdeletev1(), exports); - __exportStar(require_librariesdocumentsdeletev1(), exports); - __exportStar(require_librariesdocumentsgetextractedtextsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetstatusv1(), exports); - __exportStar(require_librariesdocumentsgettextcontentv1(), exports); - __exportStar(require_librariesdocumentsgetv1(), exports); - __exportStar(require_librariesdocumentslistv1(), exports); - __exportStar(require_librariesdocumentsreprocessv1(), exports); - __exportStar(require_librariesdocumentsupdatev1(), exports); - __exportStar(require_librariesdocumentsuploadv1(), exports); - __exportStar(require_librariesgetv1(), exports); - __exportStar(require_librariessharecreatev1(), exports); - __exportStar(require_librariessharedeletev1(), exports); - __exportStar(require_librariessharelistv1(), exports); - __exportStar(require_librariesupdatev1(), exports); - __exportStar(require_retrievemodelv1modelsmodelidget(), exports); - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js - var require_batchJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCancel = batchJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_cancel_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js - var require_batchJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCreate = batchJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function batchJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.BatchJobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_create_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsGet.js - var require_batchJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsGet = batchJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsList.js - var require_batchJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsList = batchJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "agent_id": payload?.agent_id, - "created_after": payload?.created_after, - "created_by_me": payload?.created_by_me, - "metadata": payload?.metadata, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistraljobs.js - var require_mistraljobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistraljobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralJobs = void 0; - var batchJobsCancel_js_1 = require_batchJobsCancel(); - var batchJobsCreate_js_1 = require_batchJobsCreate(); - var batchJobsGet_js_1 = require_batchJobsGet(); - var batchJobsList_js_1 = require_batchJobsList(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralJobs = class extends sdks_js_1.ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsList_js_1.batchJobsList)(this, request, options)); - } - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCreate_js_1.batchJobsCreate)(this, request, options)); - } - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsGet_js_1.batchJobsGet)(this, request, options)); - } - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCancel_js_1.batchJobsCancel)(this, request, options)); - } - }; - exports.MistralJobs = MistralJobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/batch.js - var require_batch = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/batch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Batch = void 0; - var sdks_js_1 = require_sdks(); - var mistraljobs_js_1 = require_mistraljobs(); - var Batch = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new mistraljobs_js_1.MistralJobs(this._options)); - } - }; - exports.Batch = Batch; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js - var require_betaConversationsAppend = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppend = betaConversationsAppend; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppend(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js - var require_betaConversationsAppendStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppendStream = betaConversationsAppendStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppendStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js - var require_betaConversationsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGet = betaConversationsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js - var require_betaConversationsGetHistory = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetHistory = betaConversationsGetHistory; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetHistory(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/history")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_history", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationHistory$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js - var require_betaConversationsGetMessages = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetMessages = betaConversationsGetMessages; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetMessages(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/messages")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_messages", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationMessages$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsList.js - var require_betaConversationsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsList = betaConversationsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(operations.ResponseBody$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js - var require_betaConversationsRestart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestart = betaConversationsRestart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js - var require_betaConversationsRestartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestartStream = betaConversationsRestartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js - var require_betaConversationsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStart = betaConversationsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js - var require_betaConversationsStartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStartStream = betaConversationsStartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/conversations.js - var require_conversations = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/conversations.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Conversations = void 0; - var betaConversationsAppend_js_1 = require_betaConversationsAppend(); - var betaConversationsAppendStream_js_1 = require_betaConversationsAppendStream(); - var betaConversationsGet_js_1 = require_betaConversationsGet(); - var betaConversationsGetHistory_js_1 = require_betaConversationsGetHistory(); - var betaConversationsGetMessages_js_1 = require_betaConversationsGetMessages(); - var betaConversationsList_js_1 = require_betaConversationsList(); - var betaConversationsRestart_js_1 = require_betaConversationsRestart(); - var betaConversationsRestartStream_js_1 = require_betaConversationsRestartStream(); - var betaConversationsStart_js_1 = require_betaConversationsStart(); - var betaConversationsStartStream_js_1 = require_betaConversationsStartStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Conversations = class extends sdks_js_1.ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStart_js_1.betaConversationsStart)(this, request, options)); - } - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsList_js_1.betaConversationsList)(this, request, options)); - } - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGet_js_1.betaConversationsGet)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async append(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppend_js_1.betaConversationsAppend)(this, request, options)); - } - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - async getHistory(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetHistory_js_1.betaConversationsGetHistory)(this, request, options)); - } - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - async getMessages(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetMessages_js_1.betaConversationsGetMessages)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restart(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestart_js_1.betaConversationsRestart)(this, request, options)); - } - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async startStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStartStream_js_1.betaConversationsStartStream)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async appendStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppendStream_js_1.betaConversationsAppendStream)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restartStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestartStream_js_1.betaConversationsRestartStream)(this, request, options)); - } - }; - exports.Conversations = Conversations; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js - var require_betaLibrariesCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesCreate = betaLibrariesCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaLibrariesCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.LibraryIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(201, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js - var require_betaLibrariesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDelete = betaLibrariesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js - var require_betaLibrariesGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesGet = betaLibrariesGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js - var require_betaLibrariesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesList = betaLibrariesList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function betaLibrariesList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListLibraryOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js - var require_betaLibrariesUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesUpdate = betaLibrariesUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.LibraryInUpdate, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js - var require_betaLibrariesAccessesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesDelete = betaLibrariesAccessesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingDelete, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js - var require_betaLibrariesAccessesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesList = betaLibrariesAccessesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListSharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js - var require_betaLibrariesAccessesUpdateOrCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesUpdateOrCreate = betaLibrariesAccessesUpdateOrCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesUpdateOrCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareCreateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingIn, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/accesses.js - var require_accesses = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/accesses.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Accesses = void 0; - var betaLibrariesAccessesDelete_js_1 = require_betaLibrariesAccessesDelete(); - var betaLibrariesAccessesList_js_1 = require_betaLibrariesAccessesList(); - var betaLibrariesAccessesUpdateOrCreate_js_1 = require_betaLibrariesAccessesUpdateOrCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Accesses = class extends sdks_js_1.ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesList_js_1.betaLibrariesAccessesList)(this, request, options)); - } - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - async updateOrCreate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesUpdateOrCreate_js_1.betaLibrariesAccessesUpdateOrCreate)(this, request, options)); - } - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesDelete_js_1.betaLibrariesAccessesDelete)(this, request, options)); - } - }; - exports.Accesses = Accesses; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js - var require_betaLibrariesDocumentsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsDelete = betaLibrariesDocumentsDelete; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js - var require_betaLibrariesDocumentsExtractedTextSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsExtractedTextSignedUrl = betaLibrariesDocumentsExtractedTextSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsExtractedTextSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_extracted_text_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js - var require_betaLibrariesDocumentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGet = betaLibrariesDocumentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js - var require_betaLibrariesDocumentsGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGetSignedUrl = betaLibrariesDocumentsGetSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js - var require_betaLibrariesDocumentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsList = betaLibrariesDocumentsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload.page, - "page_size": payload.page_size, - "search": payload.search, - "sort_by": payload.sort_by, - "sort_order": payload.sort_order - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListDocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js - var require_betaLibrariesDocumentsReprocess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsReprocess = betaLibrariesDocumentsReprocess; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsReprocess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/reprocess")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_reprocess_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js - var require_betaLibrariesDocumentsStatus = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsStatus = betaLibrariesDocumentsStatus; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsStatus(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/status")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_status_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ProcessingStatusOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js - var require_betaLibrariesDocumentsTextContent = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsTextContent = betaLibrariesDocumentsTextContent; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsTextContent(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/text_content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_text_content_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentTextContent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js - var require_betaLibrariesDocumentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpdate = betaLibrariesDocumentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.DocumentUpdateIn, { explode: true }); - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js - var require_betaLibrariesDocumentsUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpload = betaLibrariesDocumentsUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function betaLibrariesDocumentsUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUploadV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.RequestBody.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.RequestBody.file); - } else if ((0, streams_js_1.isReadableStream)(payload.RequestBody.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.RequestBody.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.RequestBody.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.RequestBody.file.content], { type: contentType }), payload.RequestBody.file.fileName); - } - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_upload_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json([200, 201], components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/documents.js - var require_documents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/documents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Documents = void 0; - var betaLibrariesDocumentsDelete_js_1 = require_betaLibrariesDocumentsDelete(); - var betaLibrariesDocumentsExtractedTextSignedUrl_js_1 = require_betaLibrariesDocumentsExtractedTextSignedUrl(); - var betaLibrariesDocumentsGet_js_1 = require_betaLibrariesDocumentsGet(); - var betaLibrariesDocumentsGetSignedUrl_js_1 = require_betaLibrariesDocumentsGetSignedUrl(); - var betaLibrariesDocumentsList_js_1 = require_betaLibrariesDocumentsList(); - var betaLibrariesDocumentsReprocess_js_1 = require_betaLibrariesDocumentsReprocess(); - var betaLibrariesDocumentsStatus_js_1 = require_betaLibrariesDocumentsStatus(); - var betaLibrariesDocumentsTextContent_js_1 = require_betaLibrariesDocumentsTextContent(); - var betaLibrariesDocumentsUpdate_js_1 = require_betaLibrariesDocumentsUpdate(); - var betaLibrariesDocumentsUpload_js_1 = require_betaLibrariesDocumentsUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Documents = class extends sdks_js_1.ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsList_js_1.betaLibrariesDocumentsList)(this, request, options)); - } - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpload_js_1.betaLibrariesDocumentsUpload)(this, request, options)); - } - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGet_js_1.betaLibrariesDocumentsGet)(this, request, options)); - } - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpdate_js_1.betaLibrariesDocumentsUpdate)(this, request, options)); - } - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsDelete_js_1.betaLibrariesDocumentsDelete)(this, request, options)); - } - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - async textContent(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsTextContent_js_1.betaLibrariesDocumentsTextContent)(this, request, options)); - } - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - async status(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsStatus_js_1.betaLibrariesDocumentsStatus)(this, request, options)); - } - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGetSignedUrl_js_1.betaLibrariesDocumentsGetSignedUrl)(this, request, options)); - } - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - async extractedTextSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsExtractedTextSignedUrl_js_1.betaLibrariesDocumentsExtractedTextSignedUrl)(this, request, options)); - } - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - async reprocess(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsReprocess_js_1.betaLibrariesDocumentsReprocess)(this, request, options)); - } - }; - exports.Documents = Documents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/libraries.js - var require_libraries = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/libraries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Libraries = void 0; - var betaLibrariesCreate_js_1 = require_betaLibrariesCreate(); - var betaLibrariesDelete_js_1 = require_betaLibrariesDelete(); - var betaLibrariesGet_js_1 = require_betaLibrariesGet(); - var betaLibrariesList_js_1 = require_betaLibrariesList(); - var betaLibrariesUpdate_js_1 = require_betaLibrariesUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var accesses_js_1 = require_accesses(); - var documents_js_1 = require_documents(); - var Libraries = class extends sdks_js_1.ClientSDK { - get documents() { - return this._documents ?? (this._documents = new documents_js_1.Documents(this._options)); - } - get accesses() { - return this._accesses ?? (this._accesses = new accesses_js_1.Accesses(this._options)); - } - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesList_js_1.betaLibrariesList)(this, options)); - } - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesCreate_js_1.betaLibrariesCreate)(this, request, options)); - } - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesGet_js_1.betaLibrariesGet)(this, request, options)); - } - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDelete_js_1.betaLibrariesDelete)(this, request, options)); - } - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesUpdate_js_1.betaLibrariesUpdate)(this, request, options)); - } - }; - exports.Libraries = Libraries; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js - var require_betaAgentsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsCreate = betaAgentsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaAgentsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentCreationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_create", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js - var require_betaAgentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsGet = betaAgentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsList.js - var require_betaAgentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsList = betaAgentsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(components.Agent$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js - var require_betaAgentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdate = betaAgentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.AgentUpdateRequest, { - explode: true - }); - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js - var require_betaAgentsUpdateVersion = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdateVersion = betaAgentsUpdateVersion; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdateVersion(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}/version")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "version": payload.version - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update_version", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistralagents.js - var require_mistralagents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistralagents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralAgents = void 0; - var betaAgentsCreate_js_1 = require_betaAgentsCreate(); - var betaAgentsGet_js_1 = require_betaAgentsGet(); - var betaAgentsList_js_1 = require_betaAgentsList(); - var betaAgentsUpdate_js_1 = require_betaAgentsUpdate(); - var betaAgentsUpdateVersion_js_1 = require_betaAgentsUpdateVersion(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralAgents = class extends sdks_js_1.ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsCreate_js_1.betaAgentsCreate)(this, request, options)); - } - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsList_js_1.betaAgentsList)(this, request, options)); - } - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsGet_js_1.betaAgentsGet)(this, request, options)); - } - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdate_js_1.betaAgentsUpdate)(this, request, options)); - } - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - async updateVersion(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdateVersion_js_1.betaAgentsUpdateVersion)(this, request, options)); - } - }; - exports.MistralAgents = MistralAgents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/beta.js - var require_beta = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/beta.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Beta = void 0; - var sdks_js_1 = require_sdks(); - var conversations_js_1 = require_conversations(); - var libraries_js_1 = require_libraries(); - var mistralagents_js_1 = require_mistralagents(); - var Beta = class extends sdks_js_1.ClientSDK { - get conversations() { - return this._conversations ?? (this._conversations = new conversations_js_1.Conversations(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new mistralagents_js_1.MistralAgents(this._options)); - } - get libraries() { - return this._libraries ?? (this._libraries = new libraries_js_1.Libraries(this._options)); - } - }; - exports.Beta = Beta; - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatComplete.js - var require_chatComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatComplete = chatComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatStream.js - var require_chatStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatStream = chatStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Options.js - var require_Options = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Options.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getDefaultOptions = exports.defaultOptions = exports.jsonDescription = exports.ignoreOverride = void 0; - exports.ignoreOverride = Symbol("Let zodToJsonSchema decide on which parser to use"); - var jsonDescription = (jsonSchema, def) => { - if (def.description) { - try { - return { - ...jsonSchema, - ...JSON.parse(def.description) - }; - } catch { - } - } - return jsonSchema; - }; - exports.jsonDescription = jsonDescription; - exports.defaultOptions = { - name: void 0, - $refStrategy: "root", - basePath: ["#"], - effectStrategy: "input", - pipeStrategy: "all", - dateStrategy: "format:date-time", - mapStrategy: "entries", - removeAdditionalStrategy: "passthrough", - allowedAdditionalProperties: true, - rejectedAdditionalProperties: false, - definitionPath: "definitions", - target: "jsonSchema7", - strictUnions: false, - definitions: {}, - errorMessages: false, - markdownDescription: false, - patternStrategy: "escape", - applyRegexFlags: false, - emailStrategy: "format:email", - base64Strategy: "contentEncoding:base64", - nameStrategy: "ref", - openAiAnyTypeName: "OpenAiAnyType" - }; - var getDefaultOptions = (options) => typeof options === "string" ? { - ...exports.defaultOptions, - name: options - } : { - ...exports.defaultOptions, - ...options - }; - exports.getDefaultOptions = getDefaultOptions; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Refs.js - var require_Refs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Refs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRefs = void 0; - var Options_js_1 = require_Options(); - var getRefs = (options) => { - const _options = (0, Options_js_1.getDefaultOptions)(options); - const currentPath = _options.name !== void 0 ? [..._options.basePath, _options.definitionPath, _options.name] : _options.basePath; - return { - ..._options, - flags: { hasReferencedOpenAiAnyType: false }, - currentPath, - propertyPath: void 0, - seen: new Map(Object.entries(_options.definitions).map(([name, def]) => [ - def._def, - { - def: def._def, - path: [..._options.basePath, _options.definitionPath, name], - // Resolution of references will be forced even though seen, so it's ok that the schema is undefined here for now. - jsonSchema: void 0 - } - ])) - }; - }; - exports.getRefs = getRefs; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/errorMessages.js - var require_errorMessages = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/errorMessages.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.setResponseValueAndErrors = exports.addErrorMessage = void 0; - function addErrorMessage(res, key, errorMessage, refs) { - if (!refs?.errorMessages) - return; - if (errorMessage) { - res.errorMessage = { - ...res.errorMessage, - [key]: errorMessage - }; - } - } - exports.addErrorMessage = addErrorMessage; - function setResponseValueAndErrors(res, key, value, errorMessage, refs) { - res[key] = value; - addErrorMessage(res, key, errorMessage, refs); - } - exports.setResponseValueAndErrors = setResponseValueAndErrors; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js - var require_getRelativePath = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRelativePath = void 0; - var getRelativePath = (pathA, pathB) => { - let i = 0; - for (; i < pathA.length && i < pathB.length; i++) { - if (pathA[i] !== pathB[i]) - break; - } - return [(pathA.length - i).toString(), ...pathB.slice(i)].join("/"); - }; - exports.getRelativePath = getRelativePath; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/any.js - var require_any = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/any.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseAnyDef = void 0; - var getRelativePath_js_1 = require_getRelativePath(); - function parseAnyDef(refs) { - if (refs.target !== "openAi") { - return {}; - } - const anyDefinitionPath = [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ]; - refs.flags.hasReferencedOpenAiAnyType = true; - return { - $ref: refs.$refStrategy === "relative" ? (0, getRelativePath_js_1.getRelativePath)(anyDefinitionPath, refs.currentPath) : anyDefinitionPath.join("/") - }; - } - exports.parseAnyDef = parseAnyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/array.js - var require_array = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/array.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseArrayDef = void 0; - var zod_1 = require_zod(); - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseArrayDef(def, refs) { - const res = { - type: "array" - }; - if (def.type?._def && def.type?._def?.typeName !== zod_1.ZodFirstPartyTypeKind.ZodAny) { - res.items = (0, parseDef_js_1.parseDef)(def.type._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - } - if (def.minLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.minLength.value, def.minLength.message, refs); - } - if (def.maxLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.maxLength.value, def.maxLength.message, refs); - } - if (def.exactLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.exactLength.value, def.exactLength.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.exactLength.value, def.exactLength.message, refs); - } - return res; - } - exports.parseArrayDef = parseArrayDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js - var require_bigint = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBigintDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseBigintDef(def, refs) { - const res = { - type: "integer", - format: "int64" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseBigintDef = parseBigintDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js - var require_boolean = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBooleanDef = void 0; - function parseBooleanDef() { - return { - type: "boolean" - }; - } - exports.parseBooleanDef = parseBooleanDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js - var require_branded = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBrandedDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseBrandedDef(_def, refs) { - return (0, parseDef_js_1.parseDef)(_def.type._def, refs); - } - exports.parseBrandedDef = parseBrandedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js - var require_catch = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseCatchDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseCatchDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseCatchDef = parseCatchDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/date.js - var require_date = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/date.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDateDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseDateDef(def, refs, overrideDateStrategy) { - const strategy = overrideDateStrategy ?? refs.dateStrategy; - if (Array.isArray(strategy)) { - return { - anyOf: strategy.map((item, i) => parseDateDef(def, refs, item)) - }; - } - switch (strategy) { - case "string": - case "format:date-time": - return { - type: "string", - format: "date-time" - }; - case "format:date": - return { - type: "string", - format: "date" - }; - case "integer": - return integerDateParser(def, refs); - } - } - exports.parseDateDef = parseDateDef; - var integerDateParser = (def, refs) => { - const res = { - type: "integer", - format: "unix-time" - }; - if (refs.target === "openApi3") { - return res; - } - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "minimum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "maximum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - } - } - return res; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/default.js - var require_default = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/default.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDefaultDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseDefaultDef(_def, refs) { - return { - ...(0, parseDef_js_1.parseDef)(_def.innerType._def, refs), - default: _def.defaultValue() - }; - } - exports.parseDefaultDef = parseDefaultDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js - var require_effects = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEffectsDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - function parseEffectsDef(_def, refs) { - return refs.effectStrategy === "input" ? (0, parseDef_js_1.parseDef)(_def.schema._def, refs) : (0, any_js_1.parseAnyDef)(refs); - } - exports.parseEffectsDef = parseEffectsDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js - var require_enum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEnumDef = void 0; - function parseEnumDef(def) { - return { - type: "string", - enum: Array.from(def.values) - }; - } - exports.parseEnumDef = parseEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js - var require_intersection = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseIntersectionDef = void 0; - var parseDef_js_1 = require_parseDef(); - var isJsonSchema7AllOfType = (type) => { - if ("type" in type && type.type === "string") - return false; - return "allOf" in type; - }; - function parseIntersectionDef(def, refs) { - const allOf = [ - (0, parseDef_js_1.parseDef)(def.left._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }), - (0, parseDef_js_1.parseDef)(def.right._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "1"] - }) - ].filter((x) => !!x); - let unevaluatedProperties = refs.target === "jsonSchema2019-09" ? { unevaluatedProperties: false } : void 0; - const mergedAllOf = []; - allOf.forEach((schema) => { - if (isJsonSchema7AllOfType(schema)) { - mergedAllOf.push(...schema.allOf); - if (schema.unevaluatedProperties === void 0) { - unevaluatedProperties = void 0; - } - } else { - let nestedSchema = schema; - if ("additionalProperties" in schema && schema.additionalProperties === false) { - const { additionalProperties, ...rest } = schema; - nestedSchema = rest; - } else { - unevaluatedProperties = void 0; - } - mergedAllOf.push(nestedSchema); - } - }); - return mergedAllOf.length ? { - allOf: mergedAllOf, - ...unevaluatedProperties - } : void 0; - } - exports.parseIntersectionDef = parseIntersectionDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js - var require_literal = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseLiteralDef = void 0; - function parseLiteralDef(def, refs) { - const parsedType = typeof def.value; - if (parsedType !== "bigint" && parsedType !== "number" && parsedType !== "boolean" && parsedType !== "string") { - return { - type: Array.isArray(def.value) ? "array" : "object" - }; - } - if (refs.target === "openApi3") { - return { - type: parsedType === "bigint" ? "integer" : parsedType, - enum: [def.value] - }; - } - return { - type: parsedType === "bigint" ? "integer" : parsedType, - const: def.value - }; - } - exports.parseLiteralDef = parseLiteralDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/string.js - var require_string = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/string.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseStringDef = exports.zodPatterns = void 0; - var errorMessages_js_1 = require_errorMessages(); - var emojiRegex = void 0; - exports.zodPatterns = { - /** - * `c` was changed to `[cC]` to replicate /i flag - */ - cuid: /^[cC][^\s-]{8,}$/, - cuid2: /^[0-9a-z]+$/, - ulid: /^[0-9A-HJKMNP-TV-Z]{26}$/, - /** - * `a-z` was added to replicate /i flag - */ - email: /^(?!\.)(?!.*\.\.)([a-zA-Z0-9_'+\-\.]*)[a-zA-Z0-9_+-]@([a-zA-Z0-9][a-zA-Z0-9\-]*\.)+[a-zA-Z]{2,}$/, - /** - * Constructed a valid Unicode RegExp - * - * Lazily instantiate since this type of regex isn't supported - * in all envs (e.g. React Native). - * - * See: - * https://github.com/colinhacks/zod/issues/2433 - * Fix in Zod: - * https://github.com/colinhacks/zod/commit/9340fd51e48576a75adc919bff65dbc4a5d4c99b - */ - emoji: () => { - if (emojiRegex === void 0) { - emojiRegex = RegExp("^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$", "u"); - } - return emojiRegex; - }, - /** - * Unused - */ - uuid: /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/, - /** - * Unused - */ - ipv4: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/, - ipv4Cidr: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/, - /** - * Unused - */ - ipv6: /^(([a-f0-9]{1,4}:){7}|::([a-f0-9]{1,4}:){0,6}|([a-f0-9]{1,4}:){1}:([a-f0-9]{1,4}:){0,5}|([a-f0-9]{1,4}:){2}:([a-f0-9]{1,4}:){0,4}|([a-f0-9]{1,4}:){3}:([a-f0-9]{1,4}:){0,3}|([a-f0-9]{1,4}:){4}:([a-f0-9]{1,4}:){0,2}|([a-f0-9]{1,4}:){5}:([a-f0-9]{1,4}:){0,1})([a-f0-9]{1,4}|(((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2}))\.){3}((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2})))$/, - ipv6Cidr: /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/, - base64: /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/, - base64url: /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/, - nanoid: /^[a-zA-Z0-9_-]{21}$/, - jwt: /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/ - }; - function parseStringDef(def, refs) { - const res = { - type: "string" - }; - if (def.checks) { - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "email": - switch (refs.emailStrategy) { - case "format:email": - addFormat(res, "email", check.message, refs); - break; - case "format:idn-email": - addFormat(res, "idn-email", check.message, refs); - break; - case "pattern:zod": - addPattern(res, exports.zodPatterns.email, check.message, refs); - break; - } - break; - case "url": - addFormat(res, "uri", check.message, refs); - break; - case "uuid": - addFormat(res, "uuid", check.message, refs); - break; - case "regex": - addPattern(res, check.regex, check.message, refs); - break; - case "cuid": - addPattern(res, exports.zodPatterns.cuid, check.message, refs); - break; - case "cuid2": - addPattern(res, exports.zodPatterns.cuid2, check.message, refs); - break; - case "startsWith": - addPattern(res, RegExp(`^${escapeLiteralCheckValue(check.value, refs)}`), check.message, refs); - break; - case "endsWith": - addPattern(res, RegExp(`${escapeLiteralCheckValue(check.value, refs)}$`), check.message, refs); - break; - case "datetime": - addFormat(res, "date-time", check.message, refs); - break; - case "date": - addFormat(res, "date", check.message, refs); - break; - case "time": - addFormat(res, "time", check.message, refs); - break; - case "duration": - addFormat(res, "duration", check.message, refs); - break; - case "length": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "includes": { - addPattern(res, RegExp(escapeLiteralCheckValue(check.value, refs)), check.message, refs); - break; - } - case "ip": { - if (check.version !== "v6") { - addFormat(res, "ipv4", check.message, refs); - } - if (check.version !== "v4") { - addFormat(res, "ipv6", check.message, refs); - } - break; - } - case "base64url": - addPattern(res, exports.zodPatterns.base64url, check.message, refs); - break; - case "jwt": - addPattern(res, exports.zodPatterns.jwt, check.message, refs); - break; - case "cidr": { - if (check.version !== "v6") { - addPattern(res, exports.zodPatterns.ipv4Cidr, check.message, refs); - } - if (check.version !== "v4") { - addPattern(res, exports.zodPatterns.ipv6Cidr, check.message, refs); - } - break; - } - case "emoji": - addPattern(res, exports.zodPatterns.emoji(), check.message, refs); - break; - case "ulid": { - addPattern(res, exports.zodPatterns.ulid, check.message, refs); - break; - } - case "base64": { - switch (refs.base64Strategy) { - case "format:binary": { - addFormat(res, "binary", check.message, refs); - break; - } - case "contentEncoding:base64": { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "contentEncoding", "base64", check.message, refs); - break; - } - case "pattern:zod": { - addPattern(res, exports.zodPatterns.base64, check.message, refs); - break; - } - } - break; - } - case "nanoid": { - addPattern(res, exports.zodPatterns.nanoid, check.message, refs); - } - case "toLowerCase": - case "toUpperCase": - case "trim": - break; - default: - /* @__PURE__ */ ((_) => { - })(check); - } - } - } - return res; - } - exports.parseStringDef = parseStringDef; - function escapeLiteralCheckValue(literal, refs) { - return refs.patternStrategy === "escape" ? escapeNonAlphaNumeric(literal) : literal; - } - var ALPHA_NUMERIC = new Set("ABCDEFGHIJKLMNOPQRSTUVXYZabcdefghijklmnopqrstuvxyz0123456789"); - function escapeNonAlphaNumeric(source) { - let result = ""; - for (let i = 0; i < source.length; i++) { - if (!ALPHA_NUMERIC.has(source[i])) { - result += "\\"; - } - result += source[i]; - } - return result; - } - function addFormat(schema, value, message, refs) { - if (schema.format || schema.anyOf?.some((x) => x.format)) { - if (!schema.anyOf) { - schema.anyOf = []; - } - if (schema.format) { - schema.anyOf.push({ - format: schema.format, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { format: schema.errorMessage.format } - } - }); - delete schema.format; - if (schema.errorMessage) { - delete schema.errorMessage.format; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.anyOf.push({ - format: value, - ...message && refs.errorMessages && { errorMessage: { format: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "format", value, message, refs); - } - } - function addPattern(schema, regex, message, refs) { - if (schema.pattern || schema.allOf?.some((x) => x.pattern)) { - if (!schema.allOf) { - schema.allOf = []; - } - if (schema.pattern) { - schema.allOf.push({ - pattern: schema.pattern, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { pattern: schema.errorMessage.pattern } - } - }); - delete schema.pattern; - if (schema.errorMessage) { - delete schema.errorMessage.pattern; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.allOf.push({ - pattern: stringifyRegExpWithFlags(regex, refs), - ...message && refs.errorMessages && { errorMessage: { pattern: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "pattern", stringifyRegExpWithFlags(regex, refs), message, refs); - } - } - function stringifyRegExpWithFlags(regex, refs) { - if (!refs.applyRegexFlags || !regex.flags) { - return regex.source; - } - const flags = { - i: regex.flags.includes("i"), - m: regex.flags.includes("m"), - s: regex.flags.includes("s") - // `.` matches newlines - }; - const source = flags.i ? regex.source.toLowerCase() : regex.source; - let pattern = ""; - let isEscaped = false; - let inCharGroup = false; - let inCharRange = false; - for (let i = 0; i < source.length; i++) { - if (isEscaped) { - pattern += source[i]; - isEscaped = false; - continue; - } - if (flags.i) { - if (inCharGroup) { - if (source[i].match(/[a-z]/)) { - if (inCharRange) { - pattern += source[i]; - pattern += `${source[i - 2]}-${source[i]}`.toUpperCase(); - inCharRange = false; - } else if (source[i + 1] === "-" && source[i + 2]?.match(/[a-z]/)) { - pattern += source[i]; - inCharRange = true; - } else { - pattern += `${source[i]}${source[i].toUpperCase()}`; - } - continue; - } - } else if (source[i].match(/[a-z]/)) { - pattern += `[${source[i]}${source[i].toUpperCase()}]`; - continue; - } - } - if (flags.m) { - if (source[i] === "^") { - pattern += `(^|(?<=[\r -]))`; - continue; - } else if (source[i] === "$") { - pattern += `($|(?=[\r -]))`; - continue; - } - } - if (flags.s && source[i] === ".") { - pattern += inCharGroup ? `${source[i]}\r -` : `[${source[i]}\r -]`; - continue; - } - pattern += source[i]; - if (source[i] === "\\") { - isEscaped = true; - } else if (inCharGroup && source[i] === "]") { - inCharGroup = false; - } else if (!inCharGroup && source[i] === "[") { - inCharGroup = true; - } - } - try { - new RegExp(pattern); - } catch { - console.warn(`Could not convert regex pattern at ${refs.currentPath.join("/")} to a flag-independent form! Falling back to the flag-ignorant source`); - return regex.source; - } - return pattern; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/record.js - var require_record = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/record.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseRecordDef = void 0; - var zod_1 = require_zod(); - var parseDef_js_1 = require_parseDef(); - var string_js_1 = require_string(); - var branded_js_1 = require_branded(); - var any_js_1 = require_any(); - function parseRecordDef(def, refs) { - if (refs.target === "openAi") { - console.warn("Warning: OpenAI may not support records in schemas! Try an array of key-value pairs instead."); - } - if (refs.target === "openApi3" && def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - type: "object", - required: def.keyType._def.values, - properties: def.keyType._def.values.reduce((acc, key) => ({ - ...acc, - [key]: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", key] - }) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}), - additionalProperties: refs.rejectedAdditionalProperties - }; - } - const schema = { - type: "object", - additionalProperties: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }) ?? refs.allowedAdditionalProperties - }; - if (refs.target === "openApi3") { - return schema; - } - if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.checks?.length) { - const { type, ...keyType } = (0, string_js_1.parseStringDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - ...schema, - propertyNames: { - enum: def.keyType._def.values - } - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodBranded && def.keyType._def.type._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.type._def.checks?.length) { - const { type, ...keyType } = (0, branded_js_1.parseBrandedDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } - return schema; - } - exports.parseRecordDef = parseRecordDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/map.js - var require_map = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/map.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseMapDef = void 0; - var parseDef_js_1 = require_parseDef(); - var record_js_1 = require_record(); - var any_js_1 = require_any(); - function parseMapDef(def, refs) { - if (refs.mapStrategy === "record") { - return (0, record_js_1.parseRecordDef)(def, refs); - } - const keys = (0, parseDef_js_1.parseDef)(def.keyType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "0"] - }) || (0, any_js_1.parseAnyDef)(refs); - const values = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "1"] - }) || (0, any_js_1.parseAnyDef)(refs); - return { - type: "array", - maxItems: 125, - items: { - type: "array", - items: [keys, values], - minItems: 2, - maxItems: 2 - } - }; - } - exports.parseMapDef = parseMapDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js - var require_nativeEnum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNativeEnumDef = void 0; - function parseNativeEnumDef(def) { - const object = def.values; - const actualKeys = Object.keys(def.values).filter((key) => { - return typeof object[object[key]] !== "number"; - }); - const actualValues = actualKeys.map((key) => object[key]); - const parsedTypes = Array.from(new Set(actualValues.map((values) => typeof values))); - return { - type: parsedTypes.length === 1 ? parsedTypes[0] === "string" ? "string" : "number" : ["string", "number"], - enum: actualValues - }; - } - exports.parseNativeEnumDef = parseNativeEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/never.js - var require_never = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/never.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNeverDef = void 0; - var any_js_1 = require_any(); - function parseNeverDef(refs) { - return refs.target === "openAi" ? void 0 : { - not: (0, any_js_1.parseAnyDef)({ - ...refs, - currentPath: [...refs.currentPath, "not"] - }) - }; - } - exports.parseNeverDef = parseNeverDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/null.js - var require_null = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/null.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullDef = void 0; - function parseNullDef(refs) { - return refs.target === "openApi3" ? { - enum: ["null"], - nullable: true - } : { - type: "null" - }; - } - exports.parseNullDef = parseNullDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/union.js - var require_union = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/union.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnionDef = exports.primitiveMappings = void 0; - var parseDef_js_1 = require_parseDef(); - exports.primitiveMappings = { - ZodString: "string", - ZodNumber: "number", - ZodBigInt: "integer", - ZodBoolean: "boolean", - ZodNull: "null" - }; - function parseUnionDef(def, refs) { - if (refs.target === "openApi3") - return asAnyOf(def, refs); - const options = def.options instanceof Map ? Array.from(def.options.values()) : def.options; - if (options.every((x) => x._def.typeName in exports.primitiveMappings && (!x._def.checks || !x._def.checks.length))) { - const types = options.reduce((types2, x) => { - const type = exports.primitiveMappings[x._def.typeName]; - return type && !types2.includes(type) ? [...types2, type] : types2; - }, []); - return { - type: types.length > 1 ? types : types[0] - }; - } else if (options.every((x) => x._def.typeName === "ZodLiteral" && !x.description)) { - const types = options.reduce((acc, x) => { - const type = typeof x._def.value; - switch (type) { - case "string": - case "number": - case "boolean": - return [...acc, type]; - case "bigint": - return [...acc, "integer"]; - case "object": - if (x._def.value === null) - return [...acc, "null"]; - case "symbol": - case "undefined": - case "function": - default: - return acc; - } - }, []); - if (types.length === options.length) { - const uniqueTypes = types.filter((x, i, a) => a.indexOf(x) === i); - return { - type: uniqueTypes.length > 1 ? uniqueTypes : uniqueTypes[0], - enum: options.reduce((acc, x) => { - return acc.includes(x._def.value) ? acc : [...acc, x._def.value]; - }, []) - }; - } - } else if (options.every((x) => x._def.typeName === "ZodEnum")) { - return { - type: "string", - enum: options.reduce((acc, x) => [ - ...acc, - ...x._def.values.filter((x2) => !acc.includes(x2)) - ], []) - }; - } - return asAnyOf(def, refs); - } - exports.parseUnionDef = parseUnionDef; - var asAnyOf = (def, refs) => { - const anyOf = (def.options instanceof Map ? Array.from(def.options.values()) : def.options).map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", `${i}`] - })).filter((x) => !!x && (!refs.strictUnions || typeof x === "object" && Object.keys(x).length > 0)); - return anyOf.length ? { anyOf } : void 0; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js - var require_nullable = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullableDef = void 0; - var parseDef_js_1 = require_parseDef(); - var union_js_1 = require_union(); - function parseNullableDef(def, refs) { - if (["ZodString", "ZodNumber", "ZodBigInt", "ZodBoolean", "ZodNull"].includes(def.innerType._def.typeName) && (!def.innerType._def.checks || !def.innerType._def.checks.length)) { - if (refs.target === "openApi3") { - return { - type: union_js_1.primitiveMappings[def.innerType._def.typeName], - nullable: true - }; - } - return { - type: [ - union_js_1.primitiveMappings[def.innerType._def.typeName], - "null" - ] - }; - } - if (refs.target === "openApi3") { - const base2 = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath] - }); - if (base2 && "$ref" in base2) - return { allOf: [base2], nullable: true }; - return base2 && { ...base2, nullable: true }; - } - const base = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "0"] - }); - return base && { anyOf: [base, { type: "null" }] }; - } - exports.parseNullableDef = parseNullableDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/number.js - var require_number = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/number.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNumberDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseNumberDef(def, refs) { - const res = { - type: "number" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "int": - res.type = "integer"; - (0, errorMessages_js_1.addErrorMessage)(res, "type", check.message, refs); - break; - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseNumberDef = parseNumberDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/object.js - var require_object = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseObjectDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseObjectDef(def, refs) { - const forceOptionalIntoNullable = refs.target === "openAi"; - const result = { - type: "object", - properties: {} - }; - const required = []; - const shape = def.shape(); - for (const propName in shape) { - let propDef = shape[propName]; - if (propDef === void 0 || propDef._def === void 0) { - continue; - } - let propOptional = safeIsOptional(propDef); - if (propOptional && forceOptionalIntoNullable) { - if (propDef._def.typeName === "ZodOptional") { - propDef = propDef._def.innerType; - } - if (!propDef.isNullable()) { - propDef = propDef.nullable(); - } - propOptional = false; - } - const parsedDef = (0, parseDef_js_1.parseDef)(propDef._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", propName], - propertyPath: [...refs.currentPath, "properties", propName] - }); - if (parsedDef === void 0) { - continue; - } - result.properties[propName] = parsedDef; - if (!propOptional) { - required.push(propName); - } - } - if (required.length) { - result.required = required; - } - const additionalProperties = decideAdditionalProperties(def, refs); - if (additionalProperties !== void 0) { - result.additionalProperties = additionalProperties; - } - return result; - } - exports.parseObjectDef = parseObjectDef; - function decideAdditionalProperties(def, refs) { - if (def.catchall._def.typeName !== "ZodNever") { - return (0, parseDef_js_1.parseDef)(def.catchall._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }); - } - switch (def.unknownKeys) { - case "passthrough": - return refs.allowedAdditionalProperties; - case "strict": - return refs.rejectedAdditionalProperties; - case "strip": - return refs.removeAdditionalStrategy === "strict" ? refs.allowedAdditionalProperties : refs.rejectedAdditionalProperties; - } - } - function safeIsOptional(schema) { - try { - return schema.isOptional(); - } catch { - return true; - } - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js - var require_optional = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseOptionalDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - var parseOptionalDef = (def, refs) => { - if (refs.currentPath.toString() === refs.propertyPath?.toString()) { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - } - const innerSchema = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "1"] - }); - return innerSchema ? { - anyOf: [ - { - not: (0, any_js_1.parseAnyDef)(refs) - }, - innerSchema - ] - } : (0, any_js_1.parseAnyDef)(refs); - }; - exports.parseOptionalDef = parseOptionalDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js - var require_pipeline = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePipelineDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parsePipelineDef = (def, refs) => { - if (refs.pipeStrategy === "input") { - return (0, parseDef_js_1.parseDef)(def.in._def, refs); - } else if (refs.pipeStrategy === "output") { - return (0, parseDef_js_1.parseDef)(def.out._def, refs); - } - const a = (0, parseDef_js_1.parseDef)(def.in._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }); - const b = (0, parseDef_js_1.parseDef)(def.out._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", a ? "1" : "0"] - }); - return { - allOf: [a, b].filter((x) => x !== void 0) - }; - }; - exports.parsePipelineDef = parsePipelineDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js - var require_promise = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePromiseDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parsePromiseDef(def, refs) { - return (0, parseDef_js_1.parseDef)(def.type._def, refs); - } - exports.parsePromiseDef = parsePromiseDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/set.js - var require_set = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/set.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseSetDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseSetDef(def, refs) { - const items = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - const schema = { - type: "array", - uniqueItems: true, - items - }; - if (def.minSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "minItems", def.minSize.value, def.minSize.message, refs); - } - if (def.maxSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "maxItems", def.maxSize.value, def.maxSize.message, refs); - } - return schema; - } - exports.parseSetDef = parseSetDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js - var require_tuple = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseTupleDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseTupleDef(def, refs) { - if (def.rest) { - return { - type: "array", - minItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []), - additionalItems: (0, parseDef_js_1.parseDef)(def.rest._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalItems"] - }) - }; - } else { - return { - type: "array", - minItems: def.items.length, - maxItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []) - }; - } - } - exports.parseTupleDef = parseTupleDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js - var require_undefined = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUndefinedDef = void 0; - var any_js_1 = require_any(); - function parseUndefinedDef(refs) { - return { - not: (0, any_js_1.parseAnyDef)(refs) - }; - } - exports.parseUndefinedDef = parseUndefinedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js - var require_unknown = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnknownDef = void 0; - var any_js_1 = require_any(); - function parseUnknownDef(refs) { - return (0, any_js_1.parseAnyDef)(refs); - } - exports.parseUnknownDef = parseUnknownDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js - var require_readonly = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseReadonlyDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseReadonlyDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseReadonlyDef = parseReadonlyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/selectParser.js - var require_selectParser = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/selectParser.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.selectParser = void 0; - var zod_1 = require_zod(); - var any_js_1 = require_any(); - var array_js_1 = require_array(); - var bigint_js_1 = require_bigint(); - var boolean_js_1 = require_boolean(); - var branded_js_1 = require_branded(); - var catch_js_1 = require_catch(); - var date_js_1 = require_date(); - var default_js_1 = require_default(); - var effects_js_1 = require_effects(); - var enum_js_1 = require_enum(); - var intersection_js_1 = require_intersection(); - var literal_js_1 = require_literal(); - var map_js_1 = require_map(); - var nativeEnum_js_1 = require_nativeEnum(); - var never_js_1 = require_never(); - var null_js_1 = require_null(); - var nullable_js_1 = require_nullable(); - var number_js_1 = require_number(); - var object_js_1 = require_object(); - var optional_js_1 = require_optional(); - var pipeline_js_1 = require_pipeline(); - var promise_js_1 = require_promise(); - var record_js_1 = require_record(); - var set_js_1 = require_set(); - var string_js_1 = require_string(); - var tuple_js_1 = require_tuple(); - var undefined_js_1 = require_undefined(); - var union_js_1 = require_union(); - var unknown_js_1 = require_unknown(); - var readonly_js_1 = require_readonly(); - var selectParser = (def, typeName, refs) => { - switch (typeName) { - case zod_1.ZodFirstPartyTypeKind.ZodString: - return (0, string_js_1.parseStringDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNumber: - return (0, number_js_1.parseNumberDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodObject: - return (0, object_js_1.parseObjectDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBigInt: - return (0, bigint_js_1.parseBigintDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBoolean: - return (0, boolean_js_1.parseBooleanDef)(); - case zod_1.ZodFirstPartyTypeKind.ZodDate: - return (0, date_js_1.parseDateDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUndefined: - return (0, undefined_js_1.parseUndefinedDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodNull: - return (0, null_js_1.parseNullDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodArray: - return (0, array_js_1.parseArrayDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnion: - case zod_1.ZodFirstPartyTypeKind.ZodDiscriminatedUnion: - return (0, union_js_1.parseUnionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodIntersection: - return (0, intersection_js_1.parseIntersectionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodTuple: - return (0, tuple_js_1.parseTupleDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodRecord: - return (0, record_js_1.parseRecordDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLiteral: - return (0, literal_js_1.parseLiteralDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodEnum: - return (0, enum_js_1.parseEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNativeEnum: - return (0, nativeEnum_js_1.parseNativeEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNullable: - return (0, nullable_js_1.parseNullableDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodOptional: - return (0, optional_js_1.parseOptionalDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodMap: - return (0, map_js_1.parseMapDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodSet: - return (0, set_js_1.parseSetDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLazy: - return () => def.getter()._def; - case zod_1.ZodFirstPartyTypeKind.ZodPromise: - return (0, promise_js_1.parsePromiseDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNaN: - case zod_1.ZodFirstPartyTypeKind.ZodNever: - return (0, never_js_1.parseNeverDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodEffects: - return (0, effects_js_1.parseEffectsDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodAny: - return (0, any_js_1.parseAnyDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnknown: - return (0, unknown_js_1.parseUnknownDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodDefault: - return (0, default_js_1.parseDefaultDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBranded: - return (0, branded_js_1.parseBrandedDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodReadonly: - return (0, readonly_js_1.parseReadonlyDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodCatch: - return (0, catch_js_1.parseCatchDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodPipeline: - return (0, pipeline_js_1.parsePipelineDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodFunction: - case zod_1.ZodFirstPartyTypeKind.ZodVoid: - case zod_1.ZodFirstPartyTypeKind.ZodSymbol: - return void 0; - default: - return /* @__PURE__ */ ((_) => void 0)(typeName); - } - }; - exports.selectParser = selectParser; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseDef.js - var require_parseDef = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseDef.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDef = void 0; - var Options_js_1 = require_Options(); - var selectParser_js_1 = require_selectParser(); - var getRelativePath_js_1 = require_getRelativePath(); - var any_js_1 = require_any(); - function parseDef(def, refs, forceResolution = false) { - const seenItem = refs.seen.get(def); - if (refs.override) { - const overrideResult = refs.override?.(def, refs, seenItem, forceResolution); - if (overrideResult !== Options_js_1.ignoreOverride) { - return overrideResult; - } - } - if (seenItem && !forceResolution) { - const seenSchema = get$ref(seenItem, refs); - if (seenSchema !== void 0) { - return seenSchema; - } - } - const newItem = { def, path: refs.currentPath, jsonSchema: void 0 }; - refs.seen.set(def, newItem); - const jsonSchemaOrGetter = (0, selectParser_js_1.selectParser)(def, def.typeName, refs); - const jsonSchema = typeof jsonSchemaOrGetter === "function" ? parseDef(jsonSchemaOrGetter(), refs) : jsonSchemaOrGetter; - if (jsonSchema) { - addMeta(def, refs, jsonSchema); - } - if (refs.postProcess) { - const postProcessResult = refs.postProcess(jsonSchema, def, refs); - newItem.jsonSchema = jsonSchema; - return postProcessResult; - } - newItem.jsonSchema = jsonSchema; - return jsonSchema; - } - exports.parseDef = parseDef; - var get$ref = (item, refs) => { - switch (refs.$refStrategy) { - case "root": - return { $ref: item.path.join("/") }; - case "relative": - return { $ref: (0, getRelativePath_js_1.getRelativePath)(refs.currentPath, item.path) }; - case "none": - case "seen": { - if (item.path.length < refs.currentPath.length && item.path.every((value, index) => refs.currentPath[index] === value)) { - console.warn(`Recursive reference detected at ${refs.currentPath.join("/")}! Defaulting to any`); - return (0, any_js_1.parseAnyDef)(refs); - } - return refs.$refStrategy === "seen" ? (0, any_js_1.parseAnyDef)(refs) : void 0; - } - } - }; - var addMeta = (def, refs, jsonSchema) => { - if (def.description) { - jsonSchema.description = def.description; - if (refs.markdownDescription) { - jsonSchema.markdownDescription = def.description; - } - } - return jsonSchema; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseTypes.js - var require_parseTypes = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseTypes.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js - var require_zodToJsonSchema = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodToJsonSchema = void 0; - var parseDef_js_1 = require_parseDef(); - var Refs_js_1 = require_Refs(); - var any_js_1 = require_any(); - var zodToJsonSchema = (schema, options) => { - const refs = (0, Refs_js_1.getRefs)(options); - let definitions = typeof options === "object" && options.definitions ? Object.entries(options.definitions).reduce((acc, [name2, schema2]) => ({ - ...acc, - [name2]: (0, parseDef_js_1.parseDef)(schema2._def, { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name2] - }, true) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}) : void 0; - const name = typeof options === "string" ? options : options?.nameStrategy === "title" ? void 0 : options?.name; - const main = (0, parseDef_js_1.parseDef)(schema._def, name === void 0 ? refs : { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name] - }, false) ?? (0, any_js_1.parseAnyDef)(refs); - const title = typeof options === "object" && options.name !== void 0 && options.nameStrategy === "title" ? options.name : void 0; - if (title !== void 0) { - main.title = title; - } - if (refs.flags.hasReferencedOpenAiAnyType) { - if (!definitions) { - definitions = {}; - } - if (!definitions[refs.openAiAnyTypeName]) { - definitions[refs.openAiAnyTypeName] = { - // Skipping "object" as no properties can be defined and additionalProperties must be "false" - type: ["string", "number", "integer", "boolean", "array", "null"], - items: { - $ref: refs.$refStrategy === "relative" ? "1" : [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ].join("/") - } - }; - } - } - const combined = name === void 0 ? definitions ? { - ...main, - [refs.definitionPath]: definitions - } : main : { - $ref: [ - ...refs.$refStrategy === "relative" ? [] : refs.basePath, - refs.definitionPath, - name - ].join("/"), - [refs.definitionPath]: { - ...definitions, - [name]: main - } - }; - if (refs.target === "jsonSchema7") { - combined.$schema = "http://json-schema.org/draft-07/schema#"; - } else if (refs.target === "jsonSchema2019-09" || refs.target === "openAi") { - combined.$schema = "https://json-schema.org/draft/2019-09/schema#"; - } - if (refs.target === "openAi" && ("anyOf" in combined || "oneOf" in combined || "allOf" in combined || "type" in combined && Array.isArray(combined.type))) { - console.warn("Warning: OpenAI may not support schemas with unions as roots! Try wrapping it in an object property."); - } - return combined; - }; - exports.zodToJsonSchema = zodToJsonSchema; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/index.js - var require_cjs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_Options(), exports); - __exportStar(require_Refs(), exports); - __exportStar(require_errorMessages(), exports); - __exportStar(require_getRelativePath(), exports); - __exportStar(require_parseDef(), exports); - __exportStar(require_parseTypes(), exports); - __exportStar(require_any(), exports); - __exportStar(require_array(), exports); - __exportStar(require_bigint(), exports); - __exportStar(require_boolean(), exports); - __exportStar(require_branded(), exports); - __exportStar(require_catch(), exports); - __exportStar(require_date(), exports); - __exportStar(require_default(), exports); - __exportStar(require_effects(), exports); - __exportStar(require_enum(), exports); - __exportStar(require_intersection(), exports); - __exportStar(require_literal(), exports); - __exportStar(require_map(), exports); - __exportStar(require_nativeEnum(), exports); - __exportStar(require_never(), exports); - __exportStar(require_null(), exports); - __exportStar(require_nullable(), exports); - __exportStar(require_number(), exports); - __exportStar(require_object(), exports); - __exportStar(require_optional(), exports); - __exportStar(require_pipeline(), exports); - __exportStar(require_promise(), exports); - __exportStar(require_readonly(), exports); - __exportStar(require_record(), exports); - __exportStar(require_set(), exports); - __exportStar(require_string(), exports); - __exportStar(require_tuple(), exports); - __exportStar(require_undefined(), exports); - __exportStar(require_union(), exports); - __exportStar(require_unknown(), exports); - __exportStar(require_selectParser(), exports); - __exportStar(require_zodToJsonSchema(), exports); - var zodToJsonSchema_js_1 = require_zodToJsonSchema(); - exports.default = zodToJsonSchema_js_1.zodToJsonSchema; - } - }); - - // node_modules/@mistralai/mistralai/extra/structChat.js - var require_structChat = __commonJS({ - "node_modules/@mistralai/mistralai/extra/structChat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.transformToChatCompletionRequest = transformToChatCompletionRequest; - exports.convertToParsedChatCompletionResponse = convertToParsedChatCompletionResponse; - exports.responseFormatFromZodObject = responseFormatFromZodObject; - var zod_to_json_schema_1 = require_cjs(); - function transformToChatCompletionRequest(parsedRequest) { - const { responseFormat, ...rest } = parsedRequest; - const transformedResponseFormat = responseFormatFromZodObject(responseFormat); - return { - ...rest, - responseFormat: transformedResponseFormat - }; - } - function convertToParsedChatCompletionResponse(response, responseFormat) { - if (response.choices === void 0 || response.choices.length === 0) { - return { - ...response, - choices: response.choices === void 0 ? void 0 : [] - }; - } - const parsedChoices = []; - for (const _choice of response.choices) { - if (_choice.message === null || typeof _choice.message === "undefined") { - parsedChoices.push({ ..._choice, message: void 0 }); - } else { - if (_choice.message.content !== null && typeof _choice.message.content !== "undefined" && !Array.isArray(_choice.message.content)) { - parsedChoices.push({ - ..._choice, - message: { - ..._choice.message, - parsed: responseFormat.safeParse(JSON.parse(_choice.message.content)).data - } - }); - } - } - } - return { - ...response, - choices: parsedChoices - }; - } - function responseFormatFromZodObject(responseFormat) { - const responseJsonSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(responseFormat); - const placeholderName = "placeholderName"; - return { - type: "json_schema", - jsonSchema: { - name: placeholderName, - schemaDefinition: responseJsonSchema, - strict: true - } - }; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/chat.js - var require_chat = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/chat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Chat = void 0; - var chatComplete_js_1 = require_chatComplete(); - var chatStream_js_1 = require_chatStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var structChat_js_1 = require_structChat(); - var Chat = class extends sdks_js_1.ClientSDK { - // #region sdk-class-body - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - async parse(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - const response = await (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, ccr_request, options)); - const parsed_response = (0, structChat_js_1.convertToParsedChatCompletionResponse)(response, request.responseFormat); - return parsed_response; - } - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - async parseStream(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, ccr_request, options)); - } - // #endregion sdk-class-body - /** - * Chat Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, request, options)); - } - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, request, options)); - } - }; - exports.Chat = Chat; - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassify.js - var require_classifiersClassify = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassify.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassify = classifiersClassify; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassify(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "classifications_v1_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js - var require_classifiersClassifyChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassifyChat = classifiersClassifyChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassifyChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_classifications_v1_chat_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerate.js - var require_classifiersModerate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerate = classifiersModerate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "moderations_v1_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js - var require_classifiersModerateChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerateChat = classifiersModerateChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerateChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatModerationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_moderations_v1_chat_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/classifiers.js - var require_classifiers = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/classifiers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Classifiers = void 0; - var classifiersClassify_js_1 = require_classifiersClassify(); - var classifiersClassifyChat_js_1 = require_classifiersClassifyChat(); - var classifiersModerate_js_1 = require_classifiersModerate(); - var classifiersModerateChat_js_1 = require_classifiersModerateChat(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Classifiers = class extends sdks_js_1.ClientSDK { - /** - * Moderations - */ - async moderate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerate_js_1.classifiersModerate)(this, request, options)); - } - /** - * Chat Moderations - */ - async moderateChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerateChat_js_1.classifiersModerateChat)(this, request, options)); - } - /** - * Classifications - */ - async classify(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassify_js_1.classifiersClassify)(this, request, options)); - } - /** - * Chat Classifications - */ - async classifyChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassifyChat_js_1.classifiersClassifyChat)(this, request, options)); - } - }; - exports.Classifiers = Classifiers; - } - }); - - // node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js - var require_embeddingsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.embeddingsCreate = embeddingsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function embeddingsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.EmbeddingRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/embeddings")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "embeddings_v1_embeddings_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.EmbeddingResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/embeddings.js - var require_embeddings = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/embeddings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Embeddings = void 0; - var embeddingsCreate_js_1 = require_embeddingsCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Embeddings = class extends sdks_js_1.ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, embeddingsCreate_js_1.embeddingsCreate)(this, request, options)); - } - }; - exports.Embeddings = Embeddings; - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDelete.js - var require_filesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDelete = filesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_delete_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.DeleteFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDownload.js - var require_filesDownload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDownload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDownload = filesDownload; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDownload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/octet-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_download_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.stream(200, z.instanceof(ReadableStream)), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js - var require_filesGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesGetSignedUrl = filesGetSignedUrl; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/url")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "expiry": payload.expiry - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_get_signed_url", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.FileSignedURL$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesList.js - var require_filesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesList = filesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesListFilesRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size, - "purpose": payload?.purpose, - "sample_type": payload?.sample_type, - "search": payload?.search, - "source": payload?.source - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_list_files", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListFilesOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesRetrieve.js - var require_filesRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesRetrieve = filesRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_retrieve_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.RetrieveFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesUpload.js - var require_filesUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesUpload = filesUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function filesUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - if (payload.purpose !== void 0) { - (0, encodings_js_1.appendForm)(body, "purpose", payload.purpose); - } - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_upload_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UploadFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/files.js - var require_files2 = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Files = void 0; - var filesDelete_js_1 = require_filesDelete(); - var filesDownload_js_1 = require_filesDownload(); - var filesGetSignedUrl_js_1 = require_filesGetSignedUrl(); - var filesList_js_1 = require_filesList(); - var filesRetrieve_js_1 = require_filesRetrieve(); - var filesUpload_js_1 = require_filesUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Files = class extends sdks_js_1.ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesUpload_js_1.filesUpload)(this, request, options)); - } - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesList_js_1.filesList)(this, request, options)); - } - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesRetrieve_js_1.filesRetrieve)(this, request, options)); - } - /** - * Delete File - * - * @remarks - * Delete a file. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDelete_js_1.filesDelete)(this, request, options)); - } - /** - * Download File - * - * @remarks - * Download a file - */ - async download(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDownload_js_1.filesDownload)(this, request, options)); - } - /** - * Get Signed Url - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesGetSignedUrl_js_1.filesGetSignedUrl)(this, request, options)); - } - }; - exports.Files = Files; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimComplete.js - var require_fimComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimComplete = fimComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "fim_completion_v1_fim_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.FIMCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimStream.js - var require_fimStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimStream = fimStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_fim", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/fim.js - var require_fim = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/fim.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Fim = void 0; - var fimComplete_js_1 = require_fimComplete(); - var fimStream_js_1 = require_fimStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Fim = class extends sdks_js_1.ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimComplete_js_1.fimComplete)(this, request, options)); - } - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimStream_js_1.fimStream)(this, request, options)); - } - }; - exports.Fim = Fim; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js - var require_fineTuningJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCancel = fineTuningJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js - var require_fineTuningJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCreate = fineTuningJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.JobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_create_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js - var require_fineTuningJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsGet = fineTuningJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js - var require_fineTuningJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsList = fineTuningJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "created_after": payload?.created_after, - "created_before": payload?.created_before, - "created_by_me": payload?.created_by_me, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status, - "suffix": payload?.suffix, - "wandb_name": payload?.wandb_name, - "wandb_project": payload?.wandb_project - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.JobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js - var require_fineTuningJobsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsStart = fineTuningJobsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/start")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_start_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/jobs.js - var require_jobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/jobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Jobs = void 0; - var fineTuningJobsCancel_js_1 = require_fineTuningJobsCancel(); - var fineTuningJobsCreate_js_1 = require_fineTuningJobsCreate(); - var fineTuningJobsGet_js_1 = require_fineTuningJobsGet(); - var fineTuningJobsList_js_1 = require_fineTuningJobsList(); - var fineTuningJobsStart_js_1 = require_fineTuningJobsStart(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Jobs = class extends sdks_js_1.ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsList_js_1.fineTuningJobsList)(this, request, options)); - } - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCreate_js_1.fineTuningJobsCreate)(this, request, options)); - } - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsGet_js_1.fineTuningJobsGet)(this, request, options)); - } - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCancel_js_1.fineTuningJobsCancel)(this, request, options)); - } - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsStart_js_1.fineTuningJobsStart)(this, request, options)); - } - }; - exports.Jobs = Jobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/finetuning.js - var require_finetuning = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/finetuning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuning = void 0; - var sdks_js_1 = require_sdks(); - var jobs_js_1 = require_jobs(); - var FineTuning = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new jobs_js_1.Jobs(this._options)); - } - }; - exports.FineTuning = FineTuning; - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsArchive.js - var require_modelsArchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsArchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsArchive = modelsArchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsArchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_archive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ArchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsDelete.js - var require_modelsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsDelete = modelsDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "delete_model_v1_models__model_id__delete", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DeleteModelOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsList.js - var require_modelsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsList = modelsList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function modelsList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/models")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "list_models_v1_models_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModelList$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js - var require_modelsRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsRetrieve = modelsRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "retrieve_model_v1_models__model_id__get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js - var require_modelsUnarchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUnarchive = modelsUnarchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUnarchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UnarchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUpdate.js - var require_modelsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUpdate = modelsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.UpdateFTModelIn, { explode: true }); - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_update_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/models.js - var require_models = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/models.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Models = void 0; - var modelsArchive_js_1 = require_modelsArchive(); - var modelsDelete_js_1 = require_modelsDelete(); - var modelsList_js_1 = require_modelsList(); - var modelsRetrieve_js_1 = require_modelsRetrieve(); - var modelsUnarchive_js_1 = require_modelsUnarchive(); - var modelsUpdate_js_1 = require_modelsUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Models = class extends sdks_js_1.ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, modelsList_js_1.modelsList)(this, options)); - } - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsRetrieve_js_1.modelsRetrieve)(this, request, options)); - } - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsDelete_js_1.modelsDelete)(this, request, options)); - } - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUpdate_js_1.modelsUpdate)(this, request, options)); - } - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - async archive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsArchive_js_1.modelsArchive)(this, request, options)); - } - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - async unarchive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUnarchive_js_1.modelsUnarchive)(this, request, options)); - } - }; - exports.Models = Models; - } - }); - - // node_modules/@mistralai/mistralai/funcs/ocrProcess.js - var require_ocrProcess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/ocrProcess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ocrProcess = ocrProcess; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function ocrProcess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.OCRRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/ocr")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "ocr_v1_ocr_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.OCRResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/ocr.js - var require_ocr = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/ocr.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Ocr = void 0; - var ocrProcess_js_1 = require_ocrProcess(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Ocr = class extends sdks_js_1.ClientSDK { - /** - * OCR - */ - async process(request, options) { - return (0, fp_js_1.unwrapAsync)((0, ocrProcess_js_1.ocrProcess)(this, request, options)); - } - }; - exports.Ocr = Ocr; - } - }); - - // node_modules/@mistralai/mistralai/sdk/sdk.js - var require_sdk = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/sdk.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Mistral = void 0; - var sdks_js_1 = require_sdks(); - var agents_js_1 = require_agents(); - var audio_js_1 = require_audio(); - var batch_js_1 = require_batch(); - var beta_js_1 = require_beta(); - var chat_js_1 = require_chat(); - var classifiers_js_1 = require_classifiers(); - var embeddings_js_1 = require_embeddings(); - var files_js_1 = require_files2(); - var fim_js_1 = require_fim(); - var finetuning_js_1 = require_finetuning(); - var models_js_1 = require_models(); - var ocr_js_1 = require_ocr(); - var Mistral = class extends sdks_js_1.ClientSDK { - get models() { - return this._models ?? (this._models = new models_js_1.Models(this._options)); - } - get beta() { - return this._beta ?? (this._beta = new beta_js_1.Beta(this._options)); - } - get files() { - return this._files ?? (this._files = new files_js_1.Files(this._options)); - } - get fineTuning() { - return this._fineTuning ?? (this._fineTuning = new finetuning_js_1.FineTuning(this._options)); - } - get batch() { - return this._batch ?? (this._batch = new batch_js_1.Batch(this._options)); - } - get chat() { - return this._chat ?? (this._chat = new chat_js_1.Chat(this._options)); - } - get fim() { - return this._fim ?? (this._fim = new fim_js_1.Fim(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new agents_js_1.Agents(this._options)); - } - get embeddings() { - return this._embeddings ?? (this._embeddings = new embeddings_js_1.Embeddings(this._options)); - } - get classifiers() { - return this._classifiers ?? (this._classifiers = new classifiers_js_1.Classifiers(this._options)); - } - get ocr() { - return this._ocr ?? (this._ocr = new ocr_js_1.Ocr(this._options)); - } - get audio() { - return this._audio ?? (this._audio = new audio_js_1.Audio(this._options)); - } - }; - exports.Mistral = Mistral; - } - }); - - // node_modules/@mistralai/mistralai/index.js - var require_mistralai = __commonJS({ - "node_modules/@mistralai/mistralai/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = exports.files = void 0; - __exportStar(require_config(), exports); - exports.files = __importStar(require_files()); - var http_js_1 = require_http(); - Object.defineProperty(exports, "HTTPClient", { enumerable: true, get: function() { - return http_js_1.HTTPClient; - } }); - __exportStar(require_sdk(), exports); - } - }); - - // - var _mistralai_mistralai = __toESM(require_mistralai()); - globalThis.__deps__ = globalThis.__deps__ || {}; - globalThis.__deps__._mistralai_mistralai = _mistralai_mistralai; -})(); diff --git a/examples/docusaurus/public/mistral-try-it-now/mistralai-1.9.11-py3-none-any.whl b/examples/docusaurus/public/mistral-try-it-now/mistralai-1.9.11-py3-none-any.whl deleted file mode 100644 index e908a939c..000000000 --- a/examples/docusaurus/public/mistral-try-it-now/mistralai-1.9.11-py3-none-any.whl +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:cdab4994d504eb3738272d659bd73f364571d416f1e8f01365d4d15acef4a2e9 -size 442747 diff --git a/examples/docusaurus/public/mistral-try-it-now/pyworker.js b/examples/docusaurus/public/mistral-try-it-now/pyworker.js deleted file mode 100644 index 14c67c496..000000000 --- a/examples/docusaurus/public/mistral-try-it-now/pyworker.js +++ /dev/null @@ -1,80 +0,0 @@ -// Web Worker for safely executing bundled code This runs in its own isolated -// context to prevent interference with the main thread, since the Python -// runtime blocks the main thread even when idling. -// eslint-disable-next-line @typescript-eslint/ban-ts-comment -// @ts-expect-error -// eslint-disable-next-line fast-import/no-unresolved-imports -import { loadPyodide as loadPyodideUntyped } from "https://cdn.jsdelivr.net/pyodide/v0.29.0/full/pyodide.mjs"; -const loadPyodide = loadPyodideUntyped; -// Helper to enforce strict typing -function sendMessage(message) { - self.postMessage(message); -} -// Listen for messages from the main thread -self.onmessage = async function (event) { - if (event.data.type === "execute") { - // Listen for unhandled rejections, which includes the API returning an - // error status code - globalThis.addEventListener("unhandledrejection", (event) => { - sendMessage({ - type: "uncaught-reject", - error: event.reason instanceof Error - ? { - message: event.reason.message, - stack: event.reason.stack, - name: event.reason.name, - } - : { message: String(event.reason) }, - }); - }); - // Initialize the runtime - let pyodide; - try { - // Load the SDK via micropip - pyodide = await loadPyodide(); - await pyodide.loadPackage("micropip"); - const micropip = pyodide.pyimport("micropip"); - const url = globalThis.location.origin + event.data.dependencyUrl; - await micropip.install(url); - sendMessage({ type: "initialization:finished" }); - } - catch (error) { - // Send back the error - sendMessage({ - type: "initialization:error", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - return; - } - try { - // Set stdio - pyodide.setStdout({ - batched: (msg) => sendMessage({ type: "log", message: msg, level: "info" }), - }); - pyodide.setStderr({ - batched: (msg) => sendMessage({ type: "log", message: msg, level: "error" }), - }); - pyodide.runPython(event.data.code); - } - catch (error) { - // Send back the error - sendMessage({ - type: "uncaught-exception", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - } - } -}; -//# sourceMappingURL=worker.js.map \ No newline at end of file diff --git a/examples/docusaurus/public/mistral-try-it-now/tsworker.js b/examples/docusaurus/public/mistral-try-it-now/tsworker.js deleted file mode 100644 index f4911c357..000000000 --- a/examples/docusaurus/public/mistral-try-it-now/tsworker.js +++ /dev/null @@ -1,118 +0,0 @@ -// Web Worker for safely executing bundled code This runs in its own isolated -// context to prevent interference with the main thread, and to prevent console -// logs from the main thread from mixing with the logs from the worker. -// Browser-compatible string formatter (replacement for Node.js util.format) -function format(template, ...args) { - let index = 0; - return template.replace(/%([sdifcoO])/g, (match, specifier) => { - if (index >= args.length) - return match; - const arg = args[index++]; - switch (specifier) { - case "s": // string - return String(arg); - case "d": // number - case "i": // integer - return String(Number(arg)); - case "f": // float - return String(Number(arg)); - case "o": // object (simple) - case "O": // object (detailed) - try { - return JSON.stringify(arg); - } - catch { - return String(arg); - } - case "c": // CSS (not supported, just return empty) - return ""; - default: - return match; - } - }); -} -// Helper to enforce strict typing -function sendMessage(message) { - self.postMessage(message); -} -function createConsolePatch(console, level) { - const originalConsoleMethod = console[level]; - // console itself is defined using `any`, so we need to disable the lint - // eslint-disable-next-line @typescript-eslint/no-explicit-any - console[level] = (message, ...optionalParams) => { - const hasSubstitutions = typeof message === "string" && /%[sdifcoO]/.test(message); - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment - originalConsoleMethod.apply(console, [message, ...optionalParams]); - if (hasSubstitutions) { - sendMessage({ - type: "log", - level, - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument - message: format(message, ...optionalParams), - }); - return; - } - sendMessage({ - type: "log", - level, - message, - }); - for (const optionalParam of optionalParams) { - sendMessage({ - type: "log", - level, - message: optionalParam, - }); - } - }; -} -// Listen for messages from the main thread -self.onmessage = function (event) { - if (event.data.type === "execute") { - // Patch console - createConsolePatch(console, "log"); - createConsolePatch(console, "info"); - createConsolePatch(console, "warn"); - createConsolePatch(console, "error"); - createConsolePatch(console, "debug"); - // Listen for unhandled rejections, which includes the API returning an - // error status code - globalThis.addEventListener("unhandledrejection", (event) => { - sendMessage({ - type: "uncaught-reject", - error: event.reason instanceof Error - ? { - message: event.reason.message, - stack: event.reason.stack, - name: event.reason.name, - } - : { message: String(event.reason) }, - }); - }); - // Execute the wrapped code using an indirect eval call for safety. See - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_direct_eval! - try { - // First execute the dependency bundle to populate globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.dependencyBundle}`); - // Then execute the user code which can access dependencies via globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.bundle}`); - } - catch (error) { - // Send back the error - sendMessage({ - type: "uncaught-exception", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - } - } -}; -export {}; -//# sourceMappingURL=worker.js.map \ No newline at end of file diff --git a/examples/docusaurus/public/mistral-try-it-now/types.d.ts b/examples/docusaurus/public/mistral-try-it-now/types.d.ts deleted file mode 100644 index bac18f929..000000000 --- a/examples/docusaurus/public/mistral-try-it-now/types.d.ts +++ /dev/null @@ -1,18932 +0,0 @@ -import * as z from 'zod'; -import { z as z_2 } from 'zod'; - -declare const __brand: unique symbol; - -declare class Accesses extends ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - list(request: operations.LibrariesShareListV1Request, options?: RequestOptions): Promise; - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - updateOrCreate(request: operations.LibrariesShareCreateV1Request, options?: RequestOptions): Promise; - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - delete(request: operations.LibrariesShareDeleteV1Request, options?: RequestOptions): Promise; -} - -declare type AfterErrorContext = HookContext & {}; - -declare interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable_2<{ - response: Response | null; - error: unknown; - }>; -} - -declare type AfterSuccessContext = HookContext & {}; - -declare interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable_2; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Agent$ { - /** @deprecated use `Agent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Agent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Agent$Outbound` instead. */ - type Outbound = Agent$Outbound; -} - -/** @internal */ -declare const Agent$inboundSchema: z.ZodType; - -/** @internal */ -declare type Agent$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object: string; - id: string; - version: number; - created_at: string; - updated_at: string; -}; - -/** @internal */ -declare const Agent$outboundSchema: z.ZodType; - -declare type Agent = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object?: AgentObject | undefined; - id: string; - version: number; - createdAt: Date; - updatedAt: Date; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversation$ { - /** @deprecated use `AgentConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$Outbound` instead. */ - type Outbound = AgentConversation$Outbound; -} - -/** @internal */ -declare const AgentConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentConversation$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - agent_id: string; -}; - -/** @internal */ -declare const AgentConversation$outboundSchema: z.ZodType; - -declare type AgentConversation = { - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: AgentConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - agentId: string; -}; - -declare function agentConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversationObject$ { - /** @deprecated use `AgentConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `AgentConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const AgentConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type AgentConversationObject = ClosedEnum; - -declare function agentConversationToJSON(agentConversation: AgentConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequest$ { - /** @deprecated use `AgentCreationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$Outbound` instead. */ - type Outbound = AgentCreationRequest$Outbound; -} - -/** @internal */ -declare const AgentCreationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentCreationRequest$outboundSchema: z.ZodType; - -declare type AgentCreationRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentCreationRequestFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToJSON(agentCreationRequest: AgentCreationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequestTools$ { - /** @deprecated use `AgentCreationRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$Outbound` instead. */ - type Outbound = AgentCreationRequestTools$Outbound; -} - -/** @internal */ -declare const AgentCreationRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentCreationRequestTools$outboundSchema: z.ZodType; - -declare type AgentCreationRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentCreationRequestToolsFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToolsToJSON(agentCreationRequestTools: AgentCreationRequestTools): string; - -declare function agentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEvent$ { - /** @deprecated use `AgentHandoffDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$Outbound` instead. */ - type Outbound = AgentHandoffDoneEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffDoneEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffDoneEvent = { - type?: AgentHandoffDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffDoneEventFromJSON(jsonString: string): Result; - -declare function agentHandoffDoneEventToJSON(agentHandoffDoneEvent: AgentHandoffDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEventType$ { - /** @deprecated use `AgentHandoffDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; - /** @deprecated use `AgentHandoffDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; -} - -/** @internal */ -declare const AgentHandoffDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffDoneEventType: { - readonly AgentHandoffDone: "agent.handoff.done"; -}; - -declare type AgentHandoffDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntry$ { - /** @deprecated use `AgentHandoffEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$Outbound` instead. */ - type Outbound = AgentHandoffEntry$Outbound; -} - -/** @internal */ -declare const AgentHandoffEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - previous_agent_id: string; - previous_agent_name: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffEntry$outboundSchema: z.ZodType; - -declare type AgentHandoffEntry = { - object?: AgentHandoffEntryObject | undefined; - type?: AgentHandoffEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - previousAgentId: string; - previousAgentName: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryObject$ { - /** @deprecated use `AgentHandoffEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `AgentHandoffEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryObject: { - readonly Entry: "entry"; -}; - -declare type AgentHandoffEntryObject = ClosedEnum; - -declare function agentHandoffEntryToJSON(agentHandoffEntry: AgentHandoffEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryType$ { - /** @deprecated use `AgentHandoffEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; - /** @deprecated use `AgentHandoffEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryType: { - readonly AgentHandoff: "agent.handoff"; -}; - -declare type AgentHandoffEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEvent$ { - /** @deprecated use `AgentHandoffStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$Outbound` instead. */ - type Outbound = AgentHandoffStartedEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - previous_agent_id: string; - previous_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffStartedEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffStartedEvent = { - type?: AgentHandoffStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - previousAgentId: string; - previousAgentName: string; -}; - -declare function agentHandoffStartedEventFromJSON(jsonString: string): Result; - -declare function agentHandoffStartedEventToJSON(agentHandoffStartedEvent: AgentHandoffStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEventType$ { - /** @deprecated use `AgentHandoffStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; - /** @deprecated use `AgentHandoffStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; -} - -/** @internal */ -declare const AgentHandoffStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffStartedEventType: { - readonly AgentHandoffStarted: "agent.handoff.started"; -}; - -declare type AgentHandoffStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentObject$ { - /** @deprecated use `AgentObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; - /** @deprecated use `AgentObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; -} - -/** @internal */ -declare const AgentObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentObject: { - readonly Agent: "agent"; -}; - -declare type AgentObject = ClosedEnum; - -declare class Agents extends ClientSDK { - /** - * Agents Completion - */ - complete(request: components.AgentsCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.AgentsCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsGetRequest$ { - /** @deprecated use `AgentsApiV1AgentsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsGetRequest$Outbound = { - agent_id: string; -}; - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsGetRequest = { - agentId: string; -}; - -declare function agentsApiV1AgentsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest: AgentsApiV1AgentsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsListRequest$ { - /** @deprecated use `AgentsApiV1AgentsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1AgentsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest: AgentsApiV1AgentsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateRequest$Outbound = { - agent_id: string; - AgentUpdateRequest: components.AgentUpdateRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateRequest = { - agentId: string; - agentUpdateRequest: components.AgentUpdateRequest; -}; - -declare function agentsApiV1AgentsUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest: AgentsApiV1AgentsUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateVersionRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateVersionRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateVersionRequest$Outbound = { - agent_id: string; - version: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateVersionRequest = { - agentId: string; - version: number; -}; - -declare function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest: AgentsApiV1AgentsUpdateVersionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendRequest$Outbound = { - conversation_id: string; - ConversationAppendRequest: components.ConversationAppendRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendRequest: components.ConversationAppendRequest; -}; - -declare function agentsApiV1ConversationsAppendRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest: AgentsApiV1ConversationsAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendStreamRequest$Outbound = { - conversation_id: string; - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendStreamRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendStreamRequest: components.ConversationAppendStreamRequest; -}; - -declare function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest: AgentsApiV1ConversationsAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetRequest$ { - /** @deprecated use `AgentsApiV1ConversationsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsGetRequest = { - /** - * ID of the conversation from which we are fetching metadata. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest: AgentsApiV1ConversationsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetResponseV1ConversationsGet$ { - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet = components.ModelConversation | components.AgentConversation; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet: AgentsApiV1ConversationsGetResponseV1ConversationsGet): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsHistoryRequest$ { - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsHistoryRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsHistoryRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsHistoryRequest = { - /** - * ID of the conversation from which we are fetching entries. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest: AgentsApiV1ConversationsHistoryRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsListRequest$ { - /** @deprecated use `AgentsApiV1ConversationsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1ConversationsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest: AgentsApiV1ConversationsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsMessagesRequest$ { - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsMessagesRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsMessagesRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsMessagesRequest = { - /** - * ID of the conversation from which we are fetching messages. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest: AgentsApiV1ConversationsMessagesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartRequest$Outbound = { - conversation_id: string; - ConversationRestartRequest: components.ConversationRestartRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartRequest: components.ConversationRestartRequest; -}; - -declare function agentsApiV1ConversationsRestartRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest: AgentsApiV1ConversationsRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartStreamRequest$Outbound = { - conversation_id: string; - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartStreamRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartStreamRequest: components.ConversationRestartStreamRequest; -}; - -declare function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest: AgentsApiV1ConversationsRestartStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequest$ { - /** @deprecated use `AgentsCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$Outbound` instead. */ - type Outbound = AgentsCompletionRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestMessages$ { - /** @deprecated use `AgentsCompletionRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages: AgentsCompletionRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestStop$ { - /** @deprecated use `AgentsCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionRequestStop = string | Array; - -declare function agentsCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop: AgentsCompletionRequestStop): string; - -declare function agentsCompletionRequestToJSON(agentsCompletionRequest: AgentsCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestToolChoice$ { - /** @deprecated use `AgentsCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice: AgentsCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequest$ { - /** @deprecated use `AgentsCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestMessages$ { - /** @deprecated use `AgentsCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages: AgentsCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestStop$ { - /** @deprecated use `AgentsCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionStreamRequestStop = string | Array; - -declare function agentsCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop: AgentsCompletionStreamRequestStop): string; - -declare function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest: AgentsCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestToolChoice$ { - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice: AgentsCompletionStreamRequestToolChoice): string; - -declare function agentToJSON(agent: Agent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentTools$ { - /** @deprecated use `AgentTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentTools$Outbound` instead. */ - type Outbound = AgentTools$Outbound; -} - -/** @internal */ -declare const AgentTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentTools$outboundSchema: z.ZodType; - -declare type AgentTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentToolsFromJSON(jsonString: string): Result; - -declare function agentToolsToJSON(agentTools: AgentTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequest$ { - /** @deprecated use `AgentUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$Outbound` instead. */ - type Outbound = AgentUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentUpdateRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToJSON(agentUpdateRequest: AgentUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequestTools$ { - /** @deprecated use `AgentUpdateRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$Outbound` instead. */ - type Outbound = AgentUpdateRequestTools$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentUpdateRequestTools$outboundSchema: z.ZodType; - -declare type AgentUpdateRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentUpdateRequestToolsFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToolsToJSON(agentUpdateRequestTools: AgentUpdateRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ApiEndpoint$ { - /** @deprecated use `ApiEndpoint$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ApiEndpoint$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ApiEndpoint$inboundSchema: z.ZodType; - -/** @internal */ -declare const ApiEndpoint$outboundSchema: z.ZodType; - -declare const ApiEndpoint: { - readonly RootV1ChatCompletions: "/v1/chat/completions"; - readonly RootV1Embeddings: "/v1/embeddings"; - readonly RootV1FimCompletions: "/v1/fim/completions"; - readonly RootV1Moderations: "/v1/moderations"; - readonly RootV1ChatModerations: "/v1/chat/moderations"; - readonly RootV1Ocr: "/v1/ocr"; - readonly RootV1Classifications: "/v1/classifications"; - readonly RootV1ChatClassifications: "/v1/chat/classifications"; - readonly RootV1Conversations: "/v1/conversations"; - readonly RootV1AudioTranscriptions: "/v1/audio/transcriptions"; -}; - -declare type ApiEndpoint = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOut$ { - /** @deprecated use `ArchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$Outbound` instead. */ - type Outbound = ArchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const ArchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ArchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const ArchiveFTModelOut$outboundSchema: z.ZodType; - -declare type ArchiveFTModelOut = { - id: string; - object?: ArchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function archiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOutObject$ { - /** @deprecated use `ArchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ArchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ArchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ArchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ArchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ArchiveFTModelOutObject = ClosedEnum; - -declare function archiveFTModelOutToJSON(archiveFTModelOut: ArchiveFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Arguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Arguments$Outbound` instead. */ - type Outbound = Arguments$Outbound; -} - -/** @internal */ -declare const Arguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type Arguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const Arguments$outboundSchema: z.ZodType; - -declare type Arguments = { - [k: string]: any; -} | string; - -declare function argumentsFromJSON(jsonString: string): Result; - -declare function argumentsToJSON(value: Arguments): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - type Outbound = AssistantMessage$Outbound; -} - -/** @internal */ -declare const AssistantMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -declare const AssistantMessage$outboundSchema: z.ZodType; - -declare type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - type Outbound = AssistantMessageContent$Outbound; -} - -/** @internal */ -declare const AssistantMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessageContent$Outbound = string | Array; - -/** @internal */ -declare const AssistantMessageContent$outboundSchema: z.ZodType; - -declare type AssistantMessageContent = string | Array; - -declare function assistantMessageContentFromJSON(jsonString: string): Result; - -declare function assistantMessageContentToJSON(assistantMessageContent: AssistantMessageContent): string; - -declare function assistantMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const AssistantMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AssistantMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const AssistantMessageRole: { - readonly Assistant: "assistant"; -}; - -declare type AssistantMessageRole = ClosedEnum; - -declare function assistantMessageToJSON(assistantMessage: AssistantMessage): string; - -declare class Audio_2 extends ClientSDK { - private _transcriptions?; - get transcriptions(): Transcriptions; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunk$ { - /** @deprecated use `AudioChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$Outbound` instead. */ - type Outbound = AudioChunk$Outbound; -} - -/** @internal */ -declare const AudioChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioChunk$Outbound = { - input_audio: string; - type: string; -}; - -/** @internal */ -declare const AudioChunk$outboundSchema: z.ZodType; - -declare type AudioChunk = { - inputAudio: string; - type?: AudioChunkType | undefined; -}; - -declare function audioChunkFromJSON(jsonString: string): Result; - -declare function audioChunkToJSON(audioChunk: AudioChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunkType$ { - /** @deprecated use `AudioChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; - /** @deprecated use `AudioChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; -} - -/** @internal */ -declare const AudioChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AudioChunkType$outboundSchema: z.ZodNativeEnum; - -declare const AudioChunkType: { - readonly InputAudio: "input_audio"; -}; - -declare type AudioChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequest$ { - /** @deprecated use `AudioTranscriptionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$Outbound` instead. */ - type Outbound = AudioTranscriptionRequest$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequest$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: false; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequest$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequest = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: false | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequestStream$ { - /** @deprecated use `AudioTranscriptionRequestStream$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$Outbound` instead. */ - type Outbound = AudioTranscriptionRequestStream$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequestStream$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequestStream$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: true; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequestStream$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequestStream = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: true | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestStreamFromJSON(jsonString: string): Result; - -declare function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream: AudioTranscriptionRequestStream): string; - -declare function audioTranscriptionRequestToJSON(audioTranscriptionRequest: AudioTranscriptionRequest): string; - -declare type Awaitable = T | Promise; - -declare type Awaitable_2 = T | Promise; - -declare type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCard$ { - /** @deprecated use `BaseModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$Outbound` instead. */ - type Outbound = BaseModelCard$Outbound; -} - -/** @internal */ -declare const BaseModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type BaseModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "base"; -}; - -/** @internal */ -declare const BaseModelCard$outboundSchema: z.ZodType; - -declare type BaseModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "base" | undefined; -}; - -declare function baseModelCardFromJSON(jsonString: string): Result; - -declare function baseModelCardToJSON(baseModelCard: BaseModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCardType$ { - /** @deprecated use `BaseModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; - /** @deprecated use `BaseModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; -} - -/** @internal */ -declare const BaseModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BaseModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const BaseModelCardType: { - readonly Base: "base"; -}; - -declare type BaseModelCardType = ClosedEnum; - -declare class Batch extends ClientSDK { - private _jobs?; - get jobs(): MistralJobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchError$ { - /** @deprecated use `BatchError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchError$Outbound` instead. */ - type Outbound = BatchError$Outbound; -} - -/** @internal */ -declare const BatchError$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchError$Outbound = { - message: string; - count: number; -}; - -/** @internal */ -declare const BatchError$outboundSchema: z.ZodType; - -declare type BatchError = { - message: string; - count?: number | undefined; -}; - -declare function batchErrorFromJSON(jsonString: string): Result; - -declare function batchErrorToJSON(batchError: BatchError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobIn$ { - /** @deprecated use `BatchJobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$Outbound` instead. */ - type Outbound = BatchJobIn$Outbound; -} - -/** @internal */ -declare const BatchJobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobIn$Outbound = { - input_files: Array; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeout_hours: number; -}; - -/** @internal */ -declare const BatchJobIn$outboundSchema: z.ZodType; - -declare type BatchJobIn = { - inputFiles: Array; - endpoint: ApiEndpoint; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeoutHours?: number | undefined; -}; - -declare function batchJobInFromJSON(jsonString: string): Result; - -declare function batchJobInToJSON(batchJobIn: BatchJobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOut$ { - /** @deprecated use `BatchJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$Outbound` instead. */ - type Outbound = BatchJobOut$Outbound; -} - -/** @internal */ -declare const BatchJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobOut$Outbound = { - id: string; - object: string; - input_files: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - output_file?: string | null | undefined; - error_file?: string | null | undefined; - errors: Array; - status: string; - created_at: number; - total_requests: number; - completed_requests: number; - succeeded_requests: number; - failed_requests: number; - started_at?: number | null | undefined; - completed_at?: number | null | undefined; -}; - -/** @internal */ -declare const BatchJobOut$outboundSchema: z.ZodType; - -declare type BatchJobOut = { - id: string; - object?: BatchJobOutObject | undefined; - inputFiles: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agentId?: string | null | undefined; - outputFile?: string | null | undefined; - errorFile?: string | null | undefined; - errors: Array; - status: BatchJobStatus; - createdAt: number; - totalRequests: number; - completedRequests: number; - succeededRequests: number; - failedRequests: number; - startedAt?: number | null | undefined; - completedAt?: number | null | undefined; -}; - -declare function batchJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOutObject$ { - /** @deprecated use `BatchJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; - /** @deprecated use `BatchJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; -} - -/** @internal */ -declare const BatchJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobOutObject: { - readonly Batch: "batch"; -}; - -declare type BatchJobOutObject = ClosedEnum; - -declare function batchJobOutToJSON(batchJobOut: BatchJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOut$ { - /** @deprecated use `BatchJobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$Outbound` instead. */ - type Outbound = BatchJobsOut$Outbound; -} - -/** @internal */ -declare const BatchJobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobsOut$Outbound = { - data?: Array | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const BatchJobsOut$outboundSchema: z.ZodType; - -declare type BatchJobsOut = { - data?: Array | undefined; - object?: BatchJobsOutObject | undefined; - total: number; -}; - -declare function batchJobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOutObject$ { - /** @deprecated use `BatchJobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `BatchJobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const BatchJobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobsOutObject: { - readonly List: "list"; -}; - -declare type BatchJobsOutObject = ClosedEnum; - -declare function batchJobsOutToJSON(batchJobsOut: BatchJobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobStatus$ { - /** @deprecated use `BatchJobStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; - /** @deprecated use `BatchJobStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; -} - -/** @internal */ -declare const BatchJobStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobStatus$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobStatus: { - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; -}; - -declare type BatchJobStatus = ClosedEnum; - -declare type BeforeCreateRequestContext = HookContext & {}; - -declare interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput; -} - -declare type BeforeRequestContext = HookContext & {}; - -declare type BeforeRequestHook = (req: Request) => Awaitable; - -declare interface BeforeRequestHook_2 { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable_2; -} - -declare class Beta extends ClientSDK { - private _conversations?; - get conversations(): Conversations; - private _agents?; - get agents(): MistralAgents; - private _libraries?; - get libraries(): Libraries; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BuiltInConnectors$ { - /** @deprecated use `BuiltInConnectors$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `BuiltInConnectors$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const BuiltInConnectors$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BuiltInConnectors$outboundSchema: z.ZodNativeEnum; - -declare const BuiltInConnectors: { - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; -}; - -declare type BuiltInConnectors = ClosedEnum; - -declare class Chat extends ClientSDK { - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - parse(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - parseStream(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Chat Completion - */ - complete(request: components.ChatCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.ChatCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatClassificationRequest$ { - /** @deprecated use `ChatClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$Outbound` instead. */ - type Outbound = ChatClassificationRequest$Outbound; -} - -/** @internal */ -declare const ChatClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatClassificationRequest$Outbound = { - model: string; - input: Inputs$Outbound; -}; - -/** @internal */ -declare const ChatClassificationRequest$outboundSchema: z.ZodType; - -declare type ChatClassificationRequest = { - model: string; - /** - * Chat to classify - */ - inputs: Inputs; -}; - -declare function chatClassificationRequestFromJSON(jsonString: string): Result; - -declare function chatClassificationRequestToJSON(chatClassificationRequest: ChatClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - type Outbound = ChatCompletionChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -declare const ChatCompletionChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: FinishReason; -}; - -declare function chatCompletionChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionChoiceToJSON(chatCompletionChoice: ChatCompletionChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - type Outbound = ChatCompletionRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionRequestFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToJSON(chatCompletionRequest: ChatCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - type Outbound = ChatCompletionResponse$Outbound; -} - -/** @internal */ -declare const ChatCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const ChatCompletionResponse$outboundSchema: z.ZodType; - -declare type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function chatCompletionResponseFromJSON(jsonString: string): Result; - -declare function chatCompletionResponseToJSON(chatCompletionResponse: ChatCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestMessages$ { - /** @deprecated use `ChatCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function chatCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages: ChatCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestStop$ { - /** @deprecated use `ChatCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const ChatCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type ChatCompletionStreamRequestStop = string | Array; - -declare function chatCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop: ChatCompletionStreamRequestStop): string; - -declare function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest: ChatCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequest$ { - /** @deprecated use `ChatModerationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$Outbound` instead. */ - type Outbound = ChatModerationRequest$Outbound; -} - -/** @internal */ -declare const ChatModerationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequest$Outbound = { - input: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })> | Array>; - model: string; -}; - -/** @internal */ -declare const ChatModerationRequest$outboundSchema: z.ZodType; - -declare type ChatModerationRequest = { - /** - * Chat to classify - */ - inputs: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })> | Array>; - model: string; -}; - -declare function chatModerationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequestInputs$ { - /** @deprecated use `ChatModerationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$Outbound` instead. */ - type Outbound = ChatModerationRequestInputs$Outbound; -} - -/** @internal */ -declare const ChatModerationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequestInputs$Outbound = Array<(SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -})> | Array>; - -/** @internal */ -declare const ChatModerationRequestInputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type ChatModerationRequestInputs = Array<(SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -})> | Array>; - -declare function chatModerationRequestInputsFromJSON(jsonString: string): Result; - -declare function chatModerationRequestInputsToJSON(chatModerationRequestInputs: ChatModerationRequestInputs): string; - -declare function chatModerationRequestToJSON(chatModerationRequest: ChatModerationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CheckpointOut$ { - /** @deprecated use `CheckpointOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$Outbound` instead. */ - type Outbound = CheckpointOut$Outbound; -} - -/** @internal */ -declare const CheckpointOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CheckpointOut$Outbound = { - metrics: MetricOut$Outbound; - step_number: number; - created_at: number; -}; - -/** @internal */ -declare const CheckpointOut$outboundSchema: z.ZodType; - -declare type CheckpointOut = { - /** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ - metrics: MetricOut; - /** - * The step number that the checkpoint was created at. - */ - stepNumber: number; - /** - * The UNIX timestamp (in seconds) for when the checkpoint was created. - */ - createdAt: number; -}; - -declare function checkpointOutFromJSON(jsonString: string): Result; - -declare function checkpointOutToJSON(checkpointOut: CheckpointOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequest$ { - /** @deprecated use `ClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$Outbound` instead. */ - type Outbound = ClassificationRequest$Outbound; -} - -/** @internal */ -declare const ClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequest$Outbound = { - model: string; - input: string | Array; -}; - -/** @internal */ -declare const ClassificationRequest$outboundSchema: z.ZodType; - -declare type ClassificationRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to classify. - */ - inputs: string | Array; -}; - -declare function classificationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequestInputs$ { - /** @deprecated use `ClassificationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$Outbound` instead. */ - type Outbound = ClassificationRequestInputs$Outbound; -} - -/** @internal */ -declare const ClassificationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const ClassificationRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to classify. - */ -declare type ClassificationRequestInputs = string | Array; - -declare function classificationRequestInputsFromJSON(jsonString: string): Result; - -declare function classificationRequestInputsToJSON(classificationRequestInputs: ClassificationRequestInputs): string; - -declare function classificationRequestToJSON(classificationRequest: ClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationResponse$ { - /** @deprecated use `ClassificationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$Outbound` instead. */ - type Outbound = ClassificationResponse$Outbound; -} - -/** @internal */ -declare const ClassificationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationResponse$Outbound = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult$Outbound; - }>; -}; - -/** @internal */ -declare const ClassificationResponse$outboundSchema: z.ZodType; - -declare type ClassificationResponse = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult; - }>; -}; - -declare function classificationResponseFromJSON(jsonString: string): Result; - -declare function classificationResponseToJSON(classificationResponse: ClassificationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationTargetResult$ { - /** @deprecated use `ClassificationTargetResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$Outbound` instead. */ - type Outbound = ClassificationTargetResult$Outbound; -} - -/** @internal */ -declare const ClassificationTargetResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationTargetResult$Outbound = { - scores: { - [k: string]: number; - }; -}; - -/** @internal */ -declare const ClassificationTargetResult$outboundSchema: z.ZodType; - -declare type ClassificationTargetResult = { - scores: { - [k: string]: number; - }; -}; - -declare function classificationTargetResultFromJSON(jsonString: string): Result; - -declare function classificationTargetResultToJSON(classificationTargetResult: ClassificationTargetResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOut$ { - /** @deprecated use `ClassifierDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; - events?: Array | undefined; - checkpoints?: Array | undefined; - classifier_targets: Array; -}; - -/** @internal */ -declare const ClassifierDetailedJobOut$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: ClassifierDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: ClassifierDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: ClassifierDetailedJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; - classifierTargets: Array; -}; - -declare function classifierDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutIntegrations$ { - /** @deprecated use `ClassifierDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function classifierDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations: ClassifierDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutJobType$ { - /** @deprecated use `ClassifierDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutJobType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutObject$ { - /** @deprecated use `ClassifierDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type ClassifierDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutStatus$ { - /** @deprecated use `ClassifierDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type ClassifierDetailedJobOutStatus = ClosedEnum; - -declare function classifierDetailedJobOutToJSON(classifierDetailedJobOut: ClassifierDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOut$ { - /** @deprecated use `ClassifierFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$Outbound` instead. */ - type Outbound = ClassifierFTModelOut$Outbound; -} - -/** @internal */ -declare const ClassifierFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - classifier_targets: Array; - model_type: string; -}; - -/** @internal */ -declare const ClassifierFTModelOut$outboundSchema: z.ZodType; - -declare type ClassifierFTModelOut = { - id: string; - object?: ClassifierFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - classifierTargets: Array; - modelType?: ClassifierFTModelOutModelType | undefined; -}; - -declare function classifierFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutModelType$ { - /** @deprecated use `ClassifierFTModelOutModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierFTModelOutModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutModelType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutModelType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierFTModelOutModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutObject$ { - /** @deprecated use `ClassifierFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ClassifierFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ClassifierFTModelOutObject = ClosedEnum; - -declare function classifierFTModelOutToJSON(classifierFTModelOut: ClassifierFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOut$ { - /** @deprecated use `ClassifierJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$Outbound` instead. */ - type Outbound = ClassifierJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; -}; - -/** @internal */ -declare const ClassifierJobOut$outboundSchema: z.ZodType; - -declare type ClassifierJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: ClassifierJobOutStatus; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: ClassifierJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: ClassifierJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; -}; - -declare function classifierJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutIntegrations$ { - /** @deprecated use `ClassifierJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierJobOutIntegrations = WandbIntegrationOut; - -declare function classifierJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations: ClassifierJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutJobType$ { - /** @deprecated use `ClassifierJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutJobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const ClassifierJobOutJobType: { - readonly Classifier: "classifier"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type ClassifierJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutObject$ { - /** @deprecated use `ClassifierJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const ClassifierJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type ClassifierJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutStatus$ { - /** @deprecated use `ClassifierJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const ClassifierJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type ClassifierJobOutStatus = ClosedEnum; - -declare function classifierJobOutToJSON(classifierJobOut: ClassifierJobOut): string; - -declare class Classifiers extends ClientSDK { - /** - * Moderations - */ - moderate(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Moderations - */ - moderateChat(request: components.ChatModerationRequest, options?: RequestOptions): Promise; - /** - * Classifications - */ - classify(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Classifications - */ - classifyChat(request: components.ChatClassificationRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetIn$ { - /** @deprecated use `ClassifierTargetIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$Outbound` instead. */ - type Outbound = ClassifierTargetIn$Outbound; -} - -/** @internal */ -declare const ClassifierTargetIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetIn$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function?: string | null | undefined; -}; - -/** @internal */ -declare const ClassifierTargetIn$outboundSchema: z.ZodType; - -declare type ClassifierTargetIn = { - name: string; - labels: Array; - weight?: number | undefined; - lossFunction?: FTClassifierLossFunction | null | undefined; -}; - -declare function classifierTargetInFromJSON(jsonString: string): Result; - -declare function classifierTargetInToJSON(classifierTargetIn: ClassifierTargetIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetOut$ { - /** @deprecated use `ClassifierTargetOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$Outbound` instead. */ - type Outbound = ClassifierTargetOut$Outbound; -} - -/** @internal */ -declare const ClassifierTargetOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetOut$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function: string; -}; - -/** @internal */ -declare const ClassifierTargetOut$outboundSchema: z.ZodType; - -declare type ClassifierTargetOut = { - name: string; - labels: Array; - weight: number; - lossFunction: FTClassifierLossFunction; -}; - -declare function classifierTargetOutFromJSON(jsonString: string): Result; - -declare function classifierTargetOutToJSON(classifierTargetOut: ClassifierTargetOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParameters$ { - /** @deprecated use `ClassifierTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$Outbound` instead. */ - type Outbound = ClassifierTrainingParameters$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParameters$outboundSchema: z.ZodType; - -declare type ClassifierTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParametersIn$ { - /** @deprecated use `ClassifierTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$Outbound` instead. */ - type Outbound = ClassifierTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a classifier fine-tune job. - */ -declare type ClassifierTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersInFromJSON(jsonString: string): Result; - -declare function classifierTrainingParametersInToJSON(classifierTrainingParametersIn: ClassifierTrainingParametersIn): string; - -declare function classifierTrainingParametersToJSON(classifierTrainingParameters: ClassifierTrainingParameters): string; - -declare class ClientSDK { - #private; - readonly _baseURL: URL | null; - readonly _options: SDKOptions & { - hooks?: SDKHooks; - }; - constructor(options?: SDKOptions); - _createRequest(context: HookContext, conf: RequestConfig, options?: RequestOptions): Result; - _do(request: Request, options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }): Promise>; -} - -declare type ClosedEnum = T[keyof T]; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterTool$ { - /** @deprecated use `CodeInterpreterTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$Outbound` instead. */ - type Outbound = CodeInterpreterTool$Outbound; -} - -/** @internal */ -declare const CodeInterpreterTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type CodeInterpreterTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const CodeInterpreterTool$outboundSchema: z.ZodType; - -declare type CodeInterpreterTool = { - type?: CodeInterpreterToolType | undefined; -}; - -declare function codeInterpreterToolFromJSON(jsonString: string): Result; - -declare function codeInterpreterToolToJSON(codeInterpreterTool: CodeInterpreterTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterToolType$ { - /** @deprecated use `CodeInterpreterToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; - /** @deprecated use `CodeInterpreterToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; -} - -/** @internal */ -declare const CodeInterpreterToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CodeInterpreterToolType$outboundSchema: z.ZodNativeEnum; - -declare const CodeInterpreterToolType: { - readonly CodeInterpreter: "code_interpreter"; -}; - -declare type CodeInterpreterToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgs$ { - /** @deprecated use `CompletionArgs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$Outbound` instead. */ - type Outbound = CompletionArgs$Outbound; -} - -/** @internal */ -declare const CompletionArgs$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgs$Outbound = { - stop?: CompletionArgsStop$Outbound | null | undefined; - presence_penalty?: number | null | undefined; - frequency_penalty?: number | null | undefined; - temperature?: number | null | undefined; - top_p?: number | null | undefined; - max_tokens?: number | null | undefined; - random_seed?: number | null | undefined; - prediction?: Prediction$Outbound | null | undefined; - response_format?: ResponseFormat$Outbound | null | undefined; - tool_choice?: string | undefined; -}; - -/** @internal */ -declare const CompletionArgs$outboundSchema: z.ZodType; - -/** - * White-listed arguments from the completion API - */ -declare type CompletionArgs = { - stop?: CompletionArgsStop | null | undefined; - presencePenalty?: number | null | undefined; - frequencyPenalty?: number | null | undefined; - temperature?: number | null | undefined; - topP?: number | null | undefined; - maxTokens?: number | null | undefined; - randomSeed?: number | null | undefined; - prediction?: Prediction | null | undefined; - responseFormat?: ResponseFormat | null | undefined; - toolChoice?: ToolChoiceEnum | undefined; -}; - -declare function completionArgsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgsStop$ { - /** @deprecated use `CompletionArgsStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$Outbound` instead. */ - type Outbound = CompletionArgsStop$Outbound; -} - -/** @internal */ -declare const CompletionArgsStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgsStop$Outbound = string | Array; - -/** @internal */ -declare const CompletionArgsStop$outboundSchema: z.ZodType; - -declare type CompletionArgsStop = string | Array; - -declare function completionArgsStopFromJSON(jsonString: string): Result; - -declare function completionArgsStopToJSON(completionArgsStop: CompletionArgsStop): string; - -declare function completionArgsToJSON(completionArgs: CompletionArgs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - type Outbound = CompletionChunk$Outbound; -} - -/** @internal */ -declare const CompletionChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -declare const CompletionChunk$outboundSchema: z.ZodType; - -declare type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -declare function completionChunkFromJSON(jsonString: string): Result; - -declare function completionChunkToJSON(completionChunk: CompletionChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOut$ { - /** @deprecated use `CompletionDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$Outbound` instead. */ - type Outbound = CompletionDetailedJobOut$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -/** @internal */ -declare const CompletionDetailedJobOut$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: CompletionDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: CompletionDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: CompletionDetailedJobOutJobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -declare function completionDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutIntegrations$ { - /** @deprecated use `CompletionDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function completionDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations: CompletionDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutJobType$ { - /** @deprecated use `CompletionDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `CompletionDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutJobType: { - readonly Completion: "completion"; -}; - -declare type CompletionDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutObject$ { - /** @deprecated use `CompletionDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type CompletionDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutRepositories$ { - /** @deprecated use `CompletionDetailedJobOutRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutRepositories$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutRepositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutRepositories = GithubRepositoryOut; - -declare function completionDetailedJobOutRepositoriesFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories: CompletionDetailedJobOutRepositories): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutStatus$ { - /** @deprecated use `CompletionDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `CompletionDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type CompletionDetailedJobOutStatus = ClosedEnum; - -declare function completionDetailedJobOutToJSON(completionDetailedJobOut: CompletionDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - type Outbound = CompletionEvent$Outbound; -} - -/** @internal */ -declare const CompletionEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -declare const CompletionEvent$outboundSchema: z.ZodType; - -declare type CompletionEvent = { - data: CompletionChunk; -}; - -declare function completionEventFromJSON(jsonString: string): Result; - -declare function completionEventToJSON(completionEvent: CompletionEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOut$ { - /** @deprecated use `CompletionFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$Outbound` instead. */ - type Outbound = CompletionFTModelOut$Outbound; -} - -/** @internal */ -declare const CompletionFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - model_type: string; -}; - -/** @internal */ -declare const CompletionFTModelOut$outboundSchema: z.ZodType; - -declare type CompletionFTModelOut = { - id: string; - object?: CompletionFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - modelType?: ModelType | undefined; -}; - -declare function completionFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOutObject$ { - /** @deprecated use `CompletionFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `CompletionFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const CompletionFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionFTModelOutObject: { - readonly Model: "model"; -}; - -declare type CompletionFTModelOutObject = ClosedEnum; - -declare function completionFTModelOutToJSON(completionFTModelOut: CompletionFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOut$ { - /** @deprecated use `CompletionJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$Outbound` instead. */ - type Outbound = CompletionJobOut$Outbound; -} - -/** @internal */ -declare const CompletionJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; -}; - -/** @internal */ -declare const CompletionJobOut$outboundSchema: z.ZodType; - -declare type CompletionJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: Status; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: CompletionJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: JobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; -}; - -declare function completionJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOutObject$ { - /** @deprecated use `CompletionJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const CompletionJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type CompletionJobOutObject = ClosedEnum; - -declare function completionJobOutToJSON(completionJobOut: CompletionJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - type Outbound = CompletionResponseStreamChoice$Outbound; -} - -/** @internal */ -declare const CompletionResponseStreamChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -declare const CompletionResponseStreamChoice$outboundSchema: z.ZodType; - -declare type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: CompletionResponseStreamChoiceFinishReason | null; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoiceFinishReason$ { - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$outboundSchema: z.ZodType; - -declare const CompletionResponseStreamChoiceFinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type CompletionResponseStreamChoiceFinishReason = OpenEnum; - -declare function completionResponseStreamChoiceFromJSON(jsonString: string): Result; - -declare function completionResponseStreamChoiceToJSON(completionResponseStreamChoice: CompletionResponseStreamChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParameters$ { - /** @deprecated use `CompletionTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$Outbound` instead. */ - type Outbound = CompletionTrainingParameters$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParameters$outboundSchema: z.ZodType; - -declare type CompletionTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParametersIn$ { - /** @deprecated use `CompletionTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$Outbound` instead. */ - type Outbound = CompletionTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a fine-tune job. - */ -declare type CompletionTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersInFromJSON(jsonString: string): Result; - -declare function completionTrainingParametersInToJSON(completionTrainingParametersIn: CompletionTrainingParametersIn): string; - -declare function completionTrainingParametersToJSON(completionTrainingParameters: CompletionTrainingParameters): string; - -declare namespace components { - export { - agentToolsToJSON, - agentToolsFromJSON, - agentToJSON, - agentFromJSON, - AgentTools, - AgentObject, - Agent, - AgentTools$inboundSchema, - AgentTools$Outbound, - AgentTools$outboundSchema, - AgentTools$, - AgentObject$inboundSchema, - AgentObject$outboundSchema, - AgentObject$, - Agent$inboundSchema, - Agent$Outbound, - Agent$outboundSchema, - Agent$, - agentConversationToJSON, - agentConversationFromJSON, - AgentConversationObject, - AgentConversation, - AgentConversationObject$inboundSchema, - AgentConversationObject$outboundSchema, - AgentConversationObject$, - AgentConversation$inboundSchema, - AgentConversation$Outbound, - AgentConversation$outboundSchema, - AgentConversation$, - agentCreationRequestToolsToJSON, - agentCreationRequestToolsFromJSON, - agentCreationRequestToJSON, - agentCreationRequestFromJSON, - AgentCreationRequestTools, - AgentCreationRequest, - AgentCreationRequestTools$inboundSchema, - AgentCreationRequestTools$Outbound, - AgentCreationRequestTools$outboundSchema, - AgentCreationRequestTools$, - AgentCreationRequest$inboundSchema, - AgentCreationRequest$Outbound, - AgentCreationRequest$outboundSchema, - AgentCreationRequest$, - agentHandoffDoneEventToJSON, - agentHandoffDoneEventFromJSON, - AgentHandoffDoneEventType, - AgentHandoffDoneEvent, - AgentHandoffDoneEventType$inboundSchema, - AgentHandoffDoneEventType$outboundSchema, - AgentHandoffDoneEventType$, - AgentHandoffDoneEvent$inboundSchema, - AgentHandoffDoneEvent$Outbound, - AgentHandoffDoneEvent$outboundSchema, - AgentHandoffDoneEvent$, - agentHandoffEntryToJSON, - agentHandoffEntryFromJSON, - AgentHandoffEntryObject, - AgentHandoffEntryType, - AgentHandoffEntry, - AgentHandoffEntryObject$inboundSchema, - AgentHandoffEntryObject$outboundSchema, - AgentHandoffEntryObject$, - AgentHandoffEntryType$inboundSchema, - AgentHandoffEntryType$outboundSchema, - AgentHandoffEntryType$, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, - AgentHandoffEntry$, - agentHandoffStartedEventToJSON, - agentHandoffStartedEventFromJSON, - AgentHandoffStartedEventType, - AgentHandoffStartedEvent, - AgentHandoffStartedEventType$inboundSchema, - AgentHandoffStartedEventType$outboundSchema, - AgentHandoffStartedEventType$, - AgentHandoffStartedEvent$inboundSchema, - AgentHandoffStartedEvent$Outbound, - AgentHandoffStartedEvent$outboundSchema, - AgentHandoffStartedEvent$, - agentsCompletionRequestStopToJSON, - agentsCompletionRequestStopFromJSON, - agentsCompletionRequestMessagesToJSON, - agentsCompletionRequestMessagesFromJSON, - agentsCompletionRequestToolChoiceToJSON, - agentsCompletionRequestToolChoiceFromJSON, - agentsCompletionRequestToJSON, - agentsCompletionRequestFromJSON, - AgentsCompletionRequestStop, - AgentsCompletionRequestMessages, - AgentsCompletionRequestToolChoice, - AgentsCompletionRequest, - AgentsCompletionRequestStop$inboundSchema, - AgentsCompletionRequestStop$Outbound, - AgentsCompletionRequestStop$outboundSchema, - AgentsCompletionRequestStop$, - AgentsCompletionRequestMessages$inboundSchema, - AgentsCompletionRequestMessages$Outbound, - AgentsCompletionRequestMessages$outboundSchema, - AgentsCompletionRequestMessages$, - AgentsCompletionRequestToolChoice$inboundSchema, - AgentsCompletionRequestToolChoice$Outbound, - AgentsCompletionRequestToolChoice$outboundSchema, - AgentsCompletionRequestToolChoice$, - AgentsCompletionRequest$inboundSchema, - AgentsCompletionRequest$Outbound, - AgentsCompletionRequest$outboundSchema, - AgentsCompletionRequest$, - agentsCompletionStreamRequestStopToJSON, - agentsCompletionStreamRequestStopFromJSON, - agentsCompletionStreamRequestMessagesToJSON, - agentsCompletionStreamRequestMessagesFromJSON, - agentsCompletionStreamRequestToolChoiceToJSON, - agentsCompletionStreamRequestToolChoiceFromJSON, - agentsCompletionStreamRequestToJSON, - agentsCompletionStreamRequestFromJSON, - AgentsCompletionStreamRequestStop, - AgentsCompletionStreamRequestMessages, - AgentsCompletionStreamRequestToolChoice, - AgentsCompletionStreamRequest, - AgentsCompletionStreamRequestStop$inboundSchema, - AgentsCompletionStreamRequestStop$Outbound, - AgentsCompletionStreamRequestStop$outboundSchema, - AgentsCompletionStreamRequestStop$, - AgentsCompletionStreamRequestMessages$inboundSchema, - AgentsCompletionStreamRequestMessages$Outbound, - AgentsCompletionStreamRequestMessages$outboundSchema, - AgentsCompletionStreamRequestMessages$, - AgentsCompletionStreamRequestToolChoice$inboundSchema, - AgentsCompletionStreamRequestToolChoice$Outbound, - AgentsCompletionStreamRequestToolChoice$outboundSchema, - AgentsCompletionStreamRequestToolChoice$, - AgentsCompletionStreamRequest$inboundSchema, - AgentsCompletionStreamRequest$Outbound, - AgentsCompletionStreamRequest$outboundSchema, - AgentsCompletionStreamRequest$, - agentUpdateRequestToolsToJSON, - agentUpdateRequestToolsFromJSON, - agentUpdateRequestToJSON, - agentUpdateRequestFromJSON, - AgentUpdateRequestTools, - AgentUpdateRequest, - AgentUpdateRequestTools$inboundSchema, - AgentUpdateRequestTools$Outbound, - AgentUpdateRequestTools$outboundSchema, - AgentUpdateRequestTools$, - AgentUpdateRequest$inboundSchema, - AgentUpdateRequest$Outbound, - AgentUpdateRequest$outboundSchema, - AgentUpdateRequest$, - ApiEndpoint, - ApiEndpoint$inboundSchema, - ApiEndpoint$outboundSchema, - ApiEndpoint$, - archiveFTModelOutToJSON, - archiveFTModelOutFromJSON, - ArchiveFTModelOutObject, - ArchiveFTModelOut, - ArchiveFTModelOutObject$inboundSchema, - ArchiveFTModelOutObject$outboundSchema, - ArchiveFTModelOutObject$, - ArchiveFTModelOut$inboundSchema, - ArchiveFTModelOut$Outbound, - ArchiveFTModelOut$outboundSchema, - ArchiveFTModelOut$, - assistantMessageContentToJSON, - assistantMessageContentFromJSON, - assistantMessageToJSON, - assistantMessageFromJSON, - AssistantMessageContent, - AssistantMessageRole, - AssistantMessage, - AssistantMessageContent$inboundSchema, - AssistantMessageContent$Outbound, - AssistantMessageContent$outboundSchema, - AssistantMessageContent$, - AssistantMessageRole$inboundSchema, - AssistantMessageRole$outboundSchema, - AssistantMessageRole$, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, - AssistantMessage$, - audioChunkToJSON, - audioChunkFromJSON, - AudioChunkType, - AudioChunk, - AudioChunkType$inboundSchema, - AudioChunkType$outboundSchema, - AudioChunkType$, - AudioChunk$inboundSchema, - AudioChunk$Outbound, - AudioChunk$outboundSchema, - AudioChunk$, - audioTranscriptionRequestToJSON, - audioTranscriptionRequestFromJSON, - AudioTranscriptionRequest, - AudioTranscriptionRequest$inboundSchema, - AudioTranscriptionRequest$Outbound, - AudioTranscriptionRequest$outboundSchema, - AudioTranscriptionRequest$, - audioTranscriptionRequestStreamToJSON, - audioTranscriptionRequestStreamFromJSON, - AudioTranscriptionRequestStream, - AudioTranscriptionRequestStream$inboundSchema, - AudioTranscriptionRequestStream$Outbound, - AudioTranscriptionRequestStream$outboundSchema, - AudioTranscriptionRequestStream$, - baseModelCardToJSON, - baseModelCardFromJSON, - BaseModelCardType, - BaseModelCard, - BaseModelCardType$inboundSchema, - BaseModelCardType$outboundSchema, - BaseModelCardType$, - BaseModelCard$inboundSchema, - BaseModelCard$Outbound, - BaseModelCard$outboundSchema, - BaseModelCard$, - batchErrorToJSON, - batchErrorFromJSON, - BatchError, - BatchError$inboundSchema, - BatchError$Outbound, - BatchError$outboundSchema, - BatchError$, - batchJobInToJSON, - batchJobInFromJSON, - BatchJobIn, - BatchJobIn$inboundSchema, - BatchJobIn$Outbound, - BatchJobIn$outboundSchema, - BatchJobIn$, - batchJobOutToJSON, - batchJobOutFromJSON, - BatchJobOutObject, - BatchJobOut, - BatchJobOutObject$inboundSchema, - BatchJobOutObject$outboundSchema, - BatchJobOutObject$, - BatchJobOut$inboundSchema, - BatchJobOut$Outbound, - BatchJobOut$outboundSchema, - BatchJobOut$, - batchJobsOutToJSON, - batchJobsOutFromJSON, - BatchJobsOutObject, - BatchJobsOut, - BatchJobsOutObject$inboundSchema, - BatchJobsOutObject$outboundSchema, - BatchJobsOutObject$, - BatchJobsOut$inboundSchema, - BatchJobsOut$Outbound, - BatchJobsOut$outboundSchema, - BatchJobsOut$, - BatchJobStatus, - BatchJobStatus$inboundSchema, - BatchJobStatus$outboundSchema, - BatchJobStatus$, - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, - BuiltInConnectors$, - chatClassificationRequestToJSON, - chatClassificationRequestFromJSON, - ChatClassificationRequest, - ChatClassificationRequest$inboundSchema, - ChatClassificationRequest$Outbound, - ChatClassificationRequest$outboundSchema, - ChatClassificationRequest$, - chatCompletionChoiceToJSON, - chatCompletionChoiceFromJSON, - FinishReason, - ChatCompletionChoice, - FinishReason$inboundSchema, - FinishReason$outboundSchema, - FinishReason$, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, - ChatCompletionChoice$, - stopToJSON, - stopFromJSON, - messagesToJSON, - messagesFromJSON, - chatCompletionRequestToolChoiceToJSON, - chatCompletionRequestToolChoiceFromJSON, - chatCompletionRequestToJSON, - chatCompletionRequestFromJSON, - Stop, - Messages, - ChatCompletionRequestToolChoice, - ChatCompletionRequest, - Stop$inboundSchema, - Stop$Outbound, - Stop$outboundSchema, - Stop$, - Messages$inboundSchema, - Messages$Outbound, - Messages$outboundSchema, - Messages$, - ChatCompletionRequestToolChoice$inboundSchema, - ChatCompletionRequestToolChoice$Outbound, - ChatCompletionRequestToolChoice$outboundSchema, - ChatCompletionRequestToolChoice$, - ChatCompletionRequest$inboundSchema, - ChatCompletionRequest$Outbound, - ChatCompletionRequest$outboundSchema, - ChatCompletionRequest$, - chatCompletionResponseToJSON, - chatCompletionResponseFromJSON, - ChatCompletionResponse, - ChatCompletionResponse$inboundSchema, - ChatCompletionResponse$Outbound, - ChatCompletionResponse$outboundSchema, - ChatCompletionResponse$, - chatCompletionStreamRequestStopToJSON, - chatCompletionStreamRequestStopFromJSON, - chatCompletionStreamRequestMessagesToJSON, - chatCompletionStreamRequestMessagesFromJSON, - chatCompletionStreamRequestToolChoiceToJSON, - chatCompletionStreamRequestToolChoiceFromJSON, - chatCompletionStreamRequestToJSON, - chatCompletionStreamRequestFromJSON, - ChatCompletionStreamRequestStop, - ChatCompletionStreamRequestMessages, - ChatCompletionStreamRequestToolChoice, - ChatCompletionStreamRequest, - ChatCompletionStreamRequestStop$inboundSchema, - ChatCompletionStreamRequestStop$Outbound, - ChatCompletionStreamRequestStop$outboundSchema, - ChatCompletionStreamRequestStop$, - ChatCompletionStreamRequestMessages$inboundSchema, - ChatCompletionStreamRequestMessages$Outbound, - ChatCompletionStreamRequestMessages$outboundSchema, - ChatCompletionStreamRequestMessages$, - ChatCompletionStreamRequestToolChoice$inboundSchema, - ChatCompletionStreamRequestToolChoice$Outbound, - ChatCompletionStreamRequestToolChoice$outboundSchema, - ChatCompletionStreamRequestToolChoice$, - ChatCompletionStreamRequest$inboundSchema, - ChatCompletionStreamRequest$Outbound, - ChatCompletionStreamRequest$outboundSchema, - ChatCompletionStreamRequest$, - twoToJSON, - twoFromJSON, - oneToJSON, - oneFromJSON, - chatModerationRequestInputsToJSON, - chatModerationRequestInputsFromJSON, - chatModerationRequestToJSON, - chatModerationRequestFromJSON, - Two, - One, - ChatModerationRequestInputs, - ChatModerationRequest, - Two$inboundSchema, - Two$Outbound, - Two$outboundSchema, - Two$, - One$inboundSchema, - One$Outbound, - One$outboundSchema, - One$, - ChatModerationRequestInputs$inboundSchema, - ChatModerationRequestInputs$Outbound, - ChatModerationRequestInputs$outboundSchema, - ChatModerationRequestInputs$, - ChatModerationRequest$inboundSchema, - ChatModerationRequest$Outbound, - ChatModerationRequest$outboundSchema, - ChatModerationRequest$, - checkpointOutToJSON, - checkpointOutFromJSON, - CheckpointOut, - CheckpointOut$inboundSchema, - CheckpointOut$Outbound, - CheckpointOut$outboundSchema, - CheckpointOut$, - classificationRequestInputsToJSON, - classificationRequestInputsFromJSON, - classificationRequestToJSON, - classificationRequestFromJSON, - ClassificationRequestInputs, - ClassificationRequest, - ClassificationRequestInputs$inboundSchema, - ClassificationRequestInputs$Outbound, - ClassificationRequestInputs$outboundSchema, - ClassificationRequestInputs$, - ClassificationRequest$inboundSchema, - ClassificationRequest$Outbound, - ClassificationRequest$outboundSchema, - ClassificationRequest$, - classificationResponseToJSON, - classificationResponseFromJSON, - ClassificationResponse, - ClassificationResponse$inboundSchema, - ClassificationResponse$Outbound, - ClassificationResponse$outboundSchema, - ClassificationResponse$, - classificationTargetResultToJSON, - classificationTargetResultFromJSON, - ClassificationTargetResult, - ClassificationTargetResult$inboundSchema, - ClassificationTargetResult$Outbound, - ClassificationTargetResult$outboundSchema, - ClassificationTargetResult$, - classifierDetailedJobOutIntegrationsToJSON, - classifierDetailedJobOutIntegrationsFromJSON, - classifierDetailedJobOutToJSON, - classifierDetailedJobOutFromJSON, - ClassifierDetailedJobOutStatus, - ClassifierDetailedJobOutObject, - ClassifierDetailedJobOutIntegrations, - ClassifierDetailedJobOutJobType, - ClassifierDetailedJobOut, - ClassifierDetailedJobOutStatus$inboundSchema, - ClassifierDetailedJobOutStatus$outboundSchema, - ClassifierDetailedJobOutStatus$, - ClassifierDetailedJobOutObject$inboundSchema, - ClassifierDetailedJobOutObject$outboundSchema, - ClassifierDetailedJobOutObject$, - ClassifierDetailedJobOutIntegrations$inboundSchema, - ClassifierDetailedJobOutIntegrations$Outbound, - ClassifierDetailedJobOutIntegrations$outboundSchema, - ClassifierDetailedJobOutIntegrations$, - ClassifierDetailedJobOutJobType$inboundSchema, - ClassifierDetailedJobOutJobType$outboundSchema, - ClassifierDetailedJobOutJobType$, - ClassifierDetailedJobOut$inboundSchema, - ClassifierDetailedJobOut$Outbound, - ClassifierDetailedJobOut$outboundSchema, - ClassifierDetailedJobOut$, - classifierFTModelOutToJSON, - classifierFTModelOutFromJSON, - ClassifierFTModelOutObject, - ClassifierFTModelOutModelType, - ClassifierFTModelOut, - ClassifierFTModelOutObject$inboundSchema, - ClassifierFTModelOutObject$outboundSchema, - ClassifierFTModelOutObject$, - ClassifierFTModelOutModelType$inboundSchema, - ClassifierFTModelOutModelType$outboundSchema, - ClassifierFTModelOutModelType$, - ClassifierFTModelOut$inboundSchema, - ClassifierFTModelOut$Outbound, - ClassifierFTModelOut$outboundSchema, - ClassifierFTModelOut$, - classifierJobOutIntegrationsToJSON, - classifierJobOutIntegrationsFromJSON, - classifierJobOutToJSON, - classifierJobOutFromJSON, - ClassifierJobOutStatus, - ClassifierJobOutObject, - ClassifierJobOutIntegrations, - ClassifierJobOutJobType, - ClassifierJobOut, - ClassifierJobOutStatus$inboundSchema, - ClassifierJobOutStatus$outboundSchema, - ClassifierJobOutStatus$, - ClassifierJobOutObject$inboundSchema, - ClassifierJobOutObject$outboundSchema, - ClassifierJobOutObject$, - ClassifierJobOutIntegrations$inboundSchema, - ClassifierJobOutIntegrations$Outbound, - ClassifierJobOutIntegrations$outboundSchema, - ClassifierJobOutIntegrations$, - ClassifierJobOutJobType$inboundSchema, - ClassifierJobOutJobType$outboundSchema, - ClassifierJobOutJobType$, - ClassifierJobOut$inboundSchema, - ClassifierJobOut$Outbound, - ClassifierJobOut$outboundSchema, - ClassifierJobOut$, - classifierTargetInToJSON, - classifierTargetInFromJSON, - ClassifierTargetIn, - ClassifierTargetIn$inboundSchema, - ClassifierTargetIn$Outbound, - ClassifierTargetIn$outboundSchema, - ClassifierTargetIn$, - classifierTargetOutToJSON, - classifierTargetOutFromJSON, - ClassifierTargetOut, - ClassifierTargetOut$inboundSchema, - ClassifierTargetOut$Outbound, - ClassifierTargetOut$outboundSchema, - ClassifierTargetOut$, - classifierTrainingParametersToJSON, - classifierTrainingParametersFromJSON, - ClassifierTrainingParameters, - ClassifierTrainingParameters$inboundSchema, - ClassifierTrainingParameters$Outbound, - ClassifierTrainingParameters$outboundSchema, - ClassifierTrainingParameters$, - classifierTrainingParametersInToJSON, - classifierTrainingParametersInFromJSON, - ClassifierTrainingParametersIn, - ClassifierTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$Outbound, - ClassifierTrainingParametersIn$outboundSchema, - ClassifierTrainingParametersIn$, - codeInterpreterToolToJSON, - codeInterpreterToolFromJSON, - CodeInterpreterToolType, - CodeInterpreterTool, - CodeInterpreterToolType$inboundSchema, - CodeInterpreterToolType$outboundSchema, - CodeInterpreterToolType$, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, - CodeInterpreterTool$, - completionArgsToJSON, - completionArgsFromJSON, - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, - CompletionArgs$, - completionArgsStopToJSON, - completionArgsStopFromJSON, - CompletionArgsStop, - CompletionArgsStop$inboundSchema, - CompletionArgsStop$Outbound, - CompletionArgsStop$outboundSchema, - CompletionArgsStop$, - completionChunkToJSON, - completionChunkFromJSON, - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, - CompletionChunk$, - completionDetailedJobOutIntegrationsToJSON, - completionDetailedJobOutIntegrationsFromJSON, - completionDetailedJobOutRepositoriesToJSON, - completionDetailedJobOutRepositoriesFromJSON, - completionDetailedJobOutToJSON, - completionDetailedJobOutFromJSON, - CompletionDetailedJobOutStatus, - CompletionDetailedJobOutObject, - CompletionDetailedJobOutIntegrations, - CompletionDetailedJobOutJobType, - CompletionDetailedJobOutRepositories, - CompletionDetailedJobOut, - CompletionDetailedJobOutStatus$inboundSchema, - CompletionDetailedJobOutStatus$outboundSchema, - CompletionDetailedJobOutStatus$, - CompletionDetailedJobOutObject$inboundSchema, - CompletionDetailedJobOutObject$outboundSchema, - CompletionDetailedJobOutObject$, - CompletionDetailedJobOutIntegrations$inboundSchema, - CompletionDetailedJobOutIntegrations$Outbound, - CompletionDetailedJobOutIntegrations$outboundSchema, - CompletionDetailedJobOutIntegrations$, - CompletionDetailedJobOutJobType$inboundSchema, - CompletionDetailedJobOutJobType$outboundSchema, - CompletionDetailedJobOutJobType$, - CompletionDetailedJobOutRepositories$inboundSchema, - CompletionDetailedJobOutRepositories$Outbound, - CompletionDetailedJobOutRepositories$outboundSchema, - CompletionDetailedJobOutRepositories$, - CompletionDetailedJobOut$inboundSchema, - CompletionDetailedJobOut$Outbound, - CompletionDetailedJobOut$outboundSchema, - CompletionDetailedJobOut$, - completionEventToJSON, - completionEventFromJSON, - CompletionEvent, - CompletionEvent$inboundSchema, - CompletionEvent$Outbound, - CompletionEvent$outboundSchema, - CompletionEvent$, - completionFTModelOutToJSON, - completionFTModelOutFromJSON, - CompletionFTModelOutObject, - ModelType, - CompletionFTModelOut, - CompletionFTModelOutObject$inboundSchema, - CompletionFTModelOutObject$outboundSchema, - CompletionFTModelOutObject$, - ModelType$inboundSchema, - ModelType$outboundSchema, - ModelType$, - CompletionFTModelOut$inboundSchema, - CompletionFTModelOut$Outbound, - CompletionFTModelOut$outboundSchema, - CompletionFTModelOut$, - integrationsToJSON, - integrationsFromJSON, - repositoriesToJSON, - repositoriesFromJSON, - completionJobOutToJSON, - completionJobOutFromJSON, - Status, - CompletionJobOutObject, - Integrations, - JobType, - Repositories, - CompletionJobOut, - Status$inboundSchema, - Status$outboundSchema, - Status$, - CompletionJobOutObject$inboundSchema, - CompletionJobOutObject$outboundSchema, - CompletionJobOutObject$, - Integrations$inboundSchema, - Integrations$Outbound, - Integrations$outboundSchema, - Integrations$, - JobType$inboundSchema, - JobType$outboundSchema, - JobType$, - Repositories$inboundSchema, - Repositories$Outbound, - Repositories$outboundSchema, - Repositories$, - CompletionJobOut$inboundSchema, - CompletionJobOut$Outbound, - CompletionJobOut$outboundSchema, - CompletionJobOut$, - completionResponseStreamChoiceToJSON, - completionResponseStreamChoiceFromJSON, - CompletionResponseStreamChoiceFinishReason, - CompletionResponseStreamChoice, - CompletionResponseStreamChoiceFinishReason$inboundSchema, - CompletionResponseStreamChoiceFinishReason$outboundSchema, - CompletionResponseStreamChoiceFinishReason$, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, - CompletionResponseStreamChoice$, - completionTrainingParametersToJSON, - completionTrainingParametersFromJSON, - CompletionTrainingParameters, - CompletionTrainingParameters$inboundSchema, - CompletionTrainingParameters$Outbound, - CompletionTrainingParameters$outboundSchema, - CompletionTrainingParameters$, - completionTrainingParametersInToJSON, - completionTrainingParametersInFromJSON, - CompletionTrainingParametersIn, - CompletionTrainingParametersIn$inboundSchema, - CompletionTrainingParametersIn$Outbound, - CompletionTrainingParametersIn$outboundSchema, - CompletionTrainingParametersIn$, - contentChunkToJSON, - contentChunkFromJSON, - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, - ContentChunk$, - conversationAppendRequestToJSON, - conversationAppendRequestFromJSON, - ConversationAppendRequestHandoffExecution, - ConversationAppendRequest, - ConversationAppendRequestHandoffExecution$inboundSchema, - ConversationAppendRequestHandoffExecution$outboundSchema, - ConversationAppendRequestHandoffExecution$, - ConversationAppendRequest$inboundSchema, - ConversationAppendRequest$Outbound, - ConversationAppendRequest$outboundSchema, - ConversationAppendRequest$, - conversationAppendStreamRequestToJSON, - conversationAppendStreamRequestFromJSON, - ConversationAppendStreamRequestHandoffExecution, - ConversationAppendStreamRequest, - ConversationAppendStreamRequestHandoffExecution$inboundSchema, - ConversationAppendStreamRequestHandoffExecution$outboundSchema, - ConversationAppendStreamRequestHandoffExecution$, - ConversationAppendStreamRequest$inboundSchema, - ConversationAppendStreamRequest$Outbound, - ConversationAppendStreamRequest$outboundSchema, - ConversationAppendStreamRequest$, - conversationEventsDataToJSON, - conversationEventsDataFromJSON, - conversationEventsToJSON, - conversationEventsFromJSON, - ConversationEventsData, - ConversationEvents, - ConversationEventsData$inboundSchema, - ConversationEventsData$Outbound, - ConversationEventsData$outboundSchema, - ConversationEventsData$, - ConversationEvents$inboundSchema, - ConversationEvents$Outbound, - ConversationEvents$outboundSchema, - ConversationEvents$, - entriesToJSON, - entriesFromJSON, - conversationHistoryToJSON, - conversationHistoryFromJSON, - ConversationHistoryObject, - Entries, - ConversationHistory, - ConversationHistoryObject$inboundSchema, - ConversationHistoryObject$outboundSchema, - ConversationHistoryObject$, - Entries$inboundSchema, - Entries$Outbound, - Entries$outboundSchema, - Entries$, - ConversationHistory$inboundSchema, - ConversationHistory$Outbound, - ConversationHistory$outboundSchema, - ConversationHistory$, - conversationInputsToJSON, - conversationInputsFromJSON, - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, - ConversationInputs$, - conversationMessagesToJSON, - conversationMessagesFromJSON, - ConversationMessagesObject, - ConversationMessages, - ConversationMessagesObject$inboundSchema, - ConversationMessagesObject$outboundSchema, - ConversationMessagesObject$, - ConversationMessages$inboundSchema, - ConversationMessages$Outbound, - ConversationMessages$outboundSchema, - ConversationMessages$, - toolsToJSON, - toolsFromJSON, - conversationRequestToJSON, - conversationRequestFromJSON, - HandoffExecution, - Tools, - ConversationRequest, - HandoffExecution$inboundSchema, - HandoffExecution$outboundSchema, - HandoffExecution$, - Tools$inboundSchema, - Tools$Outbound, - Tools$outboundSchema, - Tools$, - ConversationRequest$inboundSchema, - ConversationRequest$Outbound, - ConversationRequest$outboundSchema, - ConversationRequest$, - outputsToJSON, - outputsFromJSON, - conversationResponseToJSON, - conversationResponseFromJSON, - ConversationResponseObject, - Outputs, - ConversationResponse, - ConversationResponseObject$inboundSchema, - ConversationResponseObject$outboundSchema, - ConversationResponseObject$, - Outputs$inboundSchema, - Outputs$Outbound, - Outputs$outboundSchema, - Outputs$, - ConversationResponse$inboundSchema, - ConversationResponse$Outbound, - ConversationResponse$outboundSchema, - ConversationResponse$, - conversationRestartRequestToJSON, - conversationRestartRequestFromJSON, - ConversationRestartRequestHandoffExecution, - ConversationRestartRequest, - ConversationRestartRequestHandoffExecution$inboundSchema, - ConversationRestartRequestHandoffExecution$outboundSchema, - ConversationRestartRequestHandoffExecution$, - ConversationRestartRequest$inboundSchema, - ConversationRestartRequest$Outbound, - ConversationRestartRequest$outboundSchema, - ConversationRestartRequest$, - conversationRestartStreamRequestToJSON, - conversationRestartStreamRequestFromJSON, - ConversationRestartStreamRequestHandoffExecution, - ConversationRestartStreamRequest, - ConversationRestartStreamRequestHandoffExecution$inboundSchema, - ConversationRestartStreamRequestHandoffExecution$outboundSchema, - ConversationRestartStreamRequestHandoffExecution$, - ConversationRestartStreamRequest$inboundSchema, - ConversationRestartStreamRequest$Outbound, - ConversationRestartStreamRequest$outboundSchema, - ConversationRestartStreamRequest$, - conversationStreamRequestToolsToJSON, - conversationStreamRequestToolsFromJSON, - conversationStreamRequestToJSON, - conversationStreamRequestFromJSON, - ConversationStreamRequestHandoffExecution, - ConversationStreamRequestTools, - ConversationStreamRequest, - ConversationStreamRequestHandoffExecution$inboundSchema, - ConversationStreamRequestHandoffExecution$outboundSchema, - ConversationStreamRequestHandoffExecution$, - ConversationStreamRequestTools$inboundSchema, - ConversationStreamRequestTools$Outbound, - ConversationStreamRequestTools$outboundSchema, - ConversationStreamRequestTools$, - ConversationStreamRequest$inboundSchema, - ConversationStreamRequest$Outbound, - ConversationStreamRequest$outboundSchema, - ConversationStreamRequest$, - conversationUsageInfoToJSON, - conversationUsageInfoFromJSON, - ConversationUsageInfo, - ConversationUsageInfo$inboundSchema, - ConversationUsageInfo$Outbound, - ConversationUsageInfo$outboundSchema, - ConversationUsageInfo$, - deleteFileOutToJSON, - deleteFileOutFromJSON, - DeleteFileOut, - DeleteFileOut$inboundSchema, - DeleteFileOut$Outbound, - DeleteFileOut$outboundSchema, - DeleteFileOut$, - deleteModelOutToJSON, - deleteModelOutFromJSON, - DeleteModelOut, - DeleteModelOut$inboundSchema, - DeleteModelOut$Outbound, - DeleteModelOut$outboundSchema, - DeleteModelOut$, - contentToJSON, - contentFromJSON, - deltaMessageToJSON, - deltaMessageFromJSON, - Content, - DeltaMessage, - Content$inboundSchema, - Content$Outbound, - Content$outboundSchema, - Content$, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, - DeltaMessage$, - documentLibraryToolToJSON, - documentLibraryToolFromJSON, - DocumentLibraryToolType, - DocumentLibraryTool, - DocumentLibraryToolType$inboundSchema, - DocumentLibraryToolType$outboundSchema, - DocumentLibraryToolType$, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, - DocumentLibraryTool$, - documentOutToJSON, - documentOutFromJSON, - DocumentOut, - DocumentOut$inboundSchema, - DocumentOut$Outbound, - DocumentOut$outboundSchema, - DocumentOut$, - documentTextContentToJSON, - documentTextContentFromJSON, - DocumentTextContent, - DocumentTextContent$inboundSchema, - DocumentTextContent$Outbound, - DocumentTextContent$outboundSchema, - DocumentTextContent$, - documentUpdateInToJSON, - documentUpdateInFromJSON, - DocumentUpdateIn, - DocumentUpdateIn$inboundSchema, - DocumentUpdateIn$Outbound, - DocumentUpdateIn$outboundSchema, - DocumentUpdateIn$, - documentURLChunkToJSON, - documentURLChunkFromJSON, - DocumentURLChunkType, - DocumentURLChunk, - DocumentURLChunkType$inboundSchema, - DocumentURLChunkType$outboundSchema, - DocumentURLChunkType$, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, - DocumentURLChunk$, - EmbeddingDtype, - EmbeddingDtype$inboundSchema, - EmbeddingDtype$outboundSchema, - EmbeddingDtype$, - embeddingRequestInputsToJSON, - embeddingRequestInputsFromJSON, - embeddingRequestToJSON, - embeddingRequestFromJSON, - EmbeddingRequestInputs, - EmbeddingRequest, - EmbeddingRequestInputs$inboundSchema, - EmbeddingRequestInputs$Outbound, - EmbeddingRequestInputs$outboundSchema, - EmbeddingRequestInputs$, - EmbeddingRequest$inboundSchema, - EmbeddingRequest$Outbound, - EmbeddingRequest$outboundSchema, - EmbeddingRequest$, - embeddingResponseToJSON, - embeddingResponseFromJSON, - EmbeddingResponse, - EmbeddingResponse$inboundSchema, - EmbeddingResponse$Outbound, - EmbeddingResponse$outboundSchema, - EmbeddingResponse$, - embeddingResponseDataToJSON, - embeddingResponseDataFromJSON, - EmbeddingResponseData, - EmbeddingResponseData$inboundSchema, - EmbeddingResponseData$Outbound, - EmbeddingResponseData$outboundSchema, - EmbeddingResponseData$, - EncodingFormat, - EncodingFormat$inboundSchema, - EncodingFormat$outboundSchema, - EncodingFormat$, - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, - EntityType$, - eventOutToJSON, - eventOutFromJSON, - EventOut, - EventOut$inboundSchema, - EventOut$Outbound, - EventOut$outboundSchema, - EventOut$, - fileToJSON, - fileFromJSON, - FileT, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, - FileT$, - fileChunkToJSON, - fileChunkFromJSON, - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, - FileChunk$, - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, - FilePurpose$, - fileSchemaToJSON, - fileSchemaFromJSON, - FileSchema, - FileSchema$inboundSchema, - FileSchema$Outbound, - FileSchema$outboundSchema, - FileSchema$, - fileSignedURLToJSON, - fileSignedURLFromJSON, - FileSignedURL, - FileSignedURL$inboundSchema, - FileSignedURL$Outbound, - FileSignedURL$outboundSchema, - FileSignedURL$, - fimCompletionRequestStopToJSON, - fimCompletionRequestStopFromJSON, - fimCompletionRequestToJSON, - fimCompletionRequestFromJSON, - FIMCompletionRequestStop, - FIMCompletionRequest, - FIMCompletionRequestStop$inboundSchema, - FIMCompletionRequestStop$Outbound, - FIMCompletionRequestStop$outboundSchema, - FIMCompletionRequestStop$, - FIMCompletionRequest$inboundSchema, - FIMCompletionRequest$Outbound, - FIMCompletionRequest$outboundSchema, - FIMCompletionRequest$, - fimCompletionResponseToJSON, - fimCompletionResponseFromJSON, - FIMCompletionResponse, - FIMCompletionResponse$inboundSchema, - FIMCompletionResponse$Outbound, - FIMCompletionResponse$outboundSchema, - FIMCompletionResponse$, - fimCompletionStreamRequestStopToJSON, - fimCompletionStreamRequestStopFromJSON, - fimCompletionStreamRequestToJSON, - fimCompletionStreamRequestFromJSON, - FIMCompletionStreamRequestStop, - FIMCompletionStreamRequest, - FIMCompletionStreamRequestStop$inboundSchema, - FIMCompletionStreamRequestStop$Outbound, - FIMCompletionStreamRequestStop$outboundSchema, - FIMCompletionStreamRequestStop$, - FIMCompletionStreamRequest$inboundSchema, - FIMCompletionStreamRequest$Outbound, - FIMCompletionStreamRequest$outboundSchema, - FIMCompletionStreamRequest$, - FineTuneableModelType, - FineTuneableModelType$inboundSchema, - FineTuneableModelType$outboundSchema, - FineTuneableModelType$, - FTClassifierLossFunction, - FTClassifierLossFunction$inboundSchema, - FTClassifierLossFunction$outboundSchema, - FTClassifierLossFunction$, - ftModelCapabilitiesOutToJSON, - ftModelCapabilitiesOutFromJSON, - FTModelCapabilitiesOut, - FTModelCapabilitiesOut$inboundSchema, - FTModelCapabilitiesOut$Outbound, - FTModelCapabilitiesOut$outboundSchema, - FTModelCapabilitiesOut$, - ftModelCardToJSON, - ftModelCardFromJSON, - FTModelCardType, - FTModelCard, - FTModelCardType$inboundSchema, - FTModelCardType$outboundSchema, - FTModelCardType$, - FTModelCard$inboundSchema, - FTModelCard$Outbound, - FTModelCard$outboundSchema, - FTModelCard$, - functionToJSON, - functionFromJSON, - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, - FunctionT$, - argumentsToJSON, - argumentsFromJSON, - functionCallToJSON, - functionCallFromJSON, - Arguments, - FunctionCall, - Arguments$inboundSchema, - Arguments$Outbound, - Arguments$outboundSchema, - Arguments$, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, - FunctionCall$, - functionCallEntryToJSON, - functionCallEntryFromJSON, - FunctionCallEntryObject, - FunctionCallEntryType, - FunctionCallEntry, - FunctionCallEntryObject$inboundSchema, - FunctionCallEntryObject$outboundSchema, - FunctionCallEntryObject$, - FunctionCallEntryType$inboundSchema, - FunctionCallEntryType$outboundSchema, - FunctionCallEntryType$, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, - FunctionCallEntry$, - functionCallEntryArgumentsToJSON, - functionCallEntryArgumentsFromJSON, - FunctionCallEntryArguments, - FunctionCallEntryArguments$inboundSchema, - FunctionCallEntryArguments$Outbound, - FunctionCallEntryArguments$outboundSchema, - FunctionCallEntryArguments$, - functionCallEventToJSON, - functionCallEventFromJSON, - FunctionCallEventType, - FunctionCallEvent, - FunctionCallEventType$inboundSchema, - FunctionCallEventType$outboundSchema, - FunctionCallEventType$, - FunctionCallEvent$inboundSchema, - FunctionCallEvent$Outbound, - FunctionCallEvent$outboundSchema, - FunctionCallEvent$, - functionNameToJSON, - functionNameFromJSON, - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, - FunctionName$, - functionResultEntryToJSON, - functionResultEntryFromJSON, - FunctionResultEntryObject, - FunctionResultEntryType, - FunctionResultEntry, - FunctionResultEntryObject$inboundSchema, - FunctionResultEntryObject$outboundSchema, - FunctionResultEntryObject$, - FunctionResultEntryType$inboundSchema, - FunctionResultEntryType$outboundSchema, - FunctionResultEntryType$, - FunctionResultEntry$inboundSchema, - FunctionResultEntry$Outbound, - FunctionResultEntry$outboundSchema, - FunctionResultEntry$, - functionToolToJSON, - functionToolFromJSON, - FunctionToolType, - FunctionTool, - FunctionToolType$inboundSchema, - FunctionToolType$outboundSchema, - FunctionToolType$, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, - FunctionTool$, - githubRepositoryInToJSON, - githubRepositoryInFromJSON, - GithubRepositoryInType, - GithubRepositoryIn, - GithubRepositoryInType$inboundSchema, - GithubRepositoryInType$outboundSchema, - GithubRepositoryInType$, - GithubRepositoryIn$inboundSchema, - GithubRepositoryIn$Outbound, - GithubRepositoryIn$outboundSchema, - GithubRepositoryIn$, - githubRepositoryOutToJSON, - githubRepositoryOutFromJSON, - GithubRepositoryOutType, - GithubRepositoryOut, - GithubRepositoryOutType$inboundSchema, - GithubRepositoryOutType$outboundSchema, - GithubRepositoryOutType$, - GithubRepositoryOut$inboundSchema, - GithubRepositoryOut$Outbound, - GithubRepositoryOut$outboundSchema, - GithubRepositoryOut$, - imageGenerationToolToJSON, - imageGenerationToolFromJSON, - ImageGenerationToolType, - ImageGenerationTool, - ImageGenerationToolType$inboundSchema, - ImageGenerationToolType$outboundSchema, - ImageGenerationToolType$, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, - ImageGenerationTool$, - imageURLToJSON, - imageURLFromJSON, - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, - ImageURL$, - imageURLChunkImageURLToJSON, - imageURLChunkImageURLFromJSON, - imageURLChunkToJSON, - imageURLChunkFromJSON, - ImageURLChunkImageURL, - ImageURLChunkType, - ImageURLChunk, - ImageURLChunkImageURL$inboundSchema, - ImageURLChunkImageURL$Outbound, - ImageURLChunkImageURL$outboundSchema, - ImageURLChunkImageURL$, - ImageURLChunkType$inboundSchema, - ImageURLChunkType$outboundSchema, - ImageURLChunkType$, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, - ImageURLChunk$, - inputEntriesToJSON, - inputEntriesFromJSON, - InputEntries, - InputEntries$inboundSchema, - InputEntries$Outbound, - InputEntries$outboundSchema, - InputEntries$, - instructRequestInputsMessagesToJSON, - instructRequestInputsMessagesFromJSON, - instructRequestInputsToJSON, - instructRequestInputsFromJSON, - inputsToJSON, - inputsFromJSON, - InstructRequestInputsMessages, - InstructRequestInputs, - Inputs, - InstructRequestInputsMessages$inboundSchema, - InstructRequestInputsMessages$Outbound, - InstructRequestInputsMessages$outboundSchema, - InstructRequestInputsMessages$, - InstructRequestInputs$inboundSchema, - InstructRequestInputs$Outbound, - InstructRequestInputs$outboundSchema, - InstructRequestInputs$, - Inputs$inboundSchema, - Inputs$Outbound, - Inputs$outboundSchema, - Inputs$, - instructRequestMessagesToJSON, - instructRequestMessagesFromJSON, - instructRequestToJSON, - instructRequestFromJSON, - InstructRequestMessages, - InstructRequest, - InstructRequestMessages$inboundSchema, - InstructRequestMessages$Outbound, - InstructRequestMessages$outboundSchema, - InstructRequestMessages$, - InstructRequest$inboundSchema, - InstructRequest$Outbound, - InstructRequest$outboundSchema, - InstructRequest$, - jobInIntegrationsToJSON, - jobInIntegrationsFromJSON, - hyperparametersToJSON, - hyperparametersFromJSON, - jobInRepositoriesToJSON, - jobInRepositoriesFromJSON, - jobInToJSON, - jobInFromJSON, - JobInIntegrations, - Hyperparameters, - JobInRepositories, - JobIn, - JobInIntegrations$inboundSchema, - JobInIntegrations$Outbound, - JobInIntegrations$outboundSchema, - JobInIntegrations$, - Hyperparameters$inboundSchema, - Hyperparameters$Outbound, - Hyperparameters$outboundSchema, - Hyperparameters$, - JobInRepositories$inboundSchema, - JobInRepositories$Outbound, - JobInRepositories$outboundSchema, - JobInRepositories$, - JobIn$inboundSchema, - JobIn$Outbound, - JobIn$outboundSchema, - JobIn$, - jobMetadataOutToJSON, - jobMetadataOutFromJSON, - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, - JobMetadataOut$, - jobsOutDataToJSON, - jobsOutDataFromJSON, - jobsOutToJSON, - jobsOutFromJSON, - JobsOutData, - JobsOutObject, - JobsOut, - JobsOutData$inboundSchema, - JobsOutData$Outbound, - JobsOutData$outboundSchema, - JobsOutData$, - JobsOutObject$inboundSchema, - JobsOutObject$outboundSchema, - JobsOutObject$, - JobsOut$inboundSchema, - JobsOut$Outbound, - JobsOut$outboundSchema, - JobsOut$, - jsonSchemaToJSON, - jsonSchemaFromJSON, - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, - JsonSchema$, - legacyJobMetadataOutToJSON, - legacyJobMetadataOutFromJSON, - LegacyJobMetadataOutObject, - LegacyJobMetadataOut, - LegacyJobMetadataOutObject$inboundSchema, - LegacyJobMetadataOutObject$outboundSchema, - LegacyJobMetadataOutObject$, - LegacyJobMetadataOut$inboundSchema, - LegacyJobMetadataOut$Outbound, - LegacyJobMetadataOut$outboundSchema, - LegacyJobMetadataOut$, - libraryInToJSON, - libraryInFromJSON, - LibraryIn, - LibraryIn$inboundSchema, - LibraryIn$Outbound, - LibraryIn$outboundSchema, - LibraryIn$, - libraryInUpdateToJSON, - libraryInUpdateFromJSON, - LibraryInUpdate, - LibraryInUpdate$inboundSchema, - LibraryInUpdate$Outbound, - LibraryInUpdate$outboundSchema, - LibraryInUpdate$, - libraryOutToJSON, - libraryOutFromJSON, - LibraryOut, - LibraryOut$inboundSchema, - LibraryOut$Outbound, - LibraryOut$outboundSchema, - LibraryOut$, - listDocumentOutToJSON, - listDocumentOutFromJSON, - ListDocumentOut, - ListDocumentOut$inboundSchema, - ListDocumentOut$Outbound, - ListDocumentOut$outboundSchema, - ListDocumentOut$, - listFilesOutToJSON, - listFilesOutFromJSON, - ListFilesOut, - ListFilesOut$inboundSchema, - ListFilesOut$Outbound, - ListFilesOut$outboundSchema, - ListFilesOut$, - listLibraryOutToJSON, - listLibraryOutFromJSON, - ListLibraryOut, - ListLibraryOut$inboundSchema, - ListLibraryOut$Outbound, - ListLibraryOut$outboundSchema, - ListLibraryOut$, - listSharingOutToJSON, - listSharingOutFromJSON, - ListSharingOut, - ListSharingOut$inboundSchema, - ListSharingOut$Outbound, - ListSharingOut$outboundSchema, - ListSharingOut$, - messageEntriesToJSON, - messageEntriesFromJSON, - MessageEntries, - MessageEntries$inboundSchema, - MessageEntries$Outbound, - MessageEntries$outboundSchema, - MessageEntries$, - messageInputContentChunksToJSON, - messageInputContentChunksFromJSON, - MessageInputContentChunks, - MessageInputContentChunks$inboundSchema, - MessageInputContentChunks$Outbound, - MessageInputContentChunks$outboundSchema, - MessageInputContentChunks$, - messageInputEntryContentToJSON, - messageInputEntryContentFromJSON, - messageInputEntryToJSON, - messageInputEntryFromJSON, - ObjectT, - MessageInputEntryType, - MessageInputEntryRole, - MessageInputEntryContent, - MessageInputEntry, - ObjectT$inboundSchema, - ObjectT$outboundSchema, - ObjectT$, - MessageInputEntryType$inboundSchema, - MessageInputEntryType$outboundSchema, - MessageInputEntryType$, - MessageInputEntryRole$inboundSchema, - MessageInputEntryRole$outboundSchema, - MessageInputEntryRole$, - MessageInputEntryContent$inboundSchema, - MessageInputEntryContent$Outbound, - MessageInputEntryContent$outboundSchema, - MessageInputEntryContent$, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, - MessageInputEntry$, - messageOutputContentChunksToJSON, - messageOutputContentChunksFromJSON, - MessageOutputContentChunks, - MessageOutputContentChunks$inboundSchema, - MessageOutputContentChunks$Outbound, - MessageOutputContentChunks$outboundSchema, - MessageOutputContentChunks$, - messageOutputEntryContentToJSON, - messageOutputEntryContentFromJSON, - messageOutputEntryToJSON, - messageOutputEntryFromJSON, - MessageOutputEntryObject, - MessageOutputEntryType, - MessageOutputEntryRole, - MessageOutputEntryContent, - MessageOutputEntry, - MessageOutputEntryObject$inboundSchema, - MessageOutputEntryObject$outboundSchema, - MessageOutputEntryObject$, - MessageOutputEntryType$inboundSchema, - MessageOutputEntryType$outboundSchema, - MessageOutputEntryType$, - MessageOutputEntryRole$inboundSchema, - MessageOutputEntryRole$outboundSchema, - MessageOutputEntryRole$, - MessageOutputEntryContent$inboundSchema, - MessageOutputEntryContent$Outbound, - MessageOutputEntryContent$outboundSchema, - MessageOutputEntryContent$, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, - MessageOutputEntry$, - messageOutputEventContentToJSON, - messageOutputEventContentFromJSON, - messageOutputEventToJSON, - messageOutputEventFromJSON, - MessageOutputEventType, - MessageOutputEventRole, - MessageOutputEventContent, - MessageOutputEvent, - MessageOutputEventType$inboundSchema, - MessageOutputEventType$outboundSchema, - MessageOutputEventType$, - MessageOutputEventRole$inboundSchema, - MessageOutputEventRole$outboundSchema, - MessageOutputEventRole$, - MessageOutputEventContent$inboundSchema, - MessageOutputEventContent$Outbound, - MessageOutputEventContent$outboundSchema, - MessageOutputEventContent$, - MessageOutputEvent$inboundSchema, - MessageOutputEvent$Outbound, - MessageOutputEvent$outboundSchema, - MessageOutputEvent$, - metricOutToJSON, - metricOutFromJSON, - MetricOut, - MetricOut$inboundSchema, - MetricOut$Outbound, - MetricOut$outboundSchema, - MetricOut$, - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, - MistralPromptMode$, - modelCapabilitiesToJSON, - modelCapabilitiesFromJSON, - ModelCapabilities, - ModelCapabilities$inboundSchema, - ModelCapabilities$Outbound, - ModelCapabilities$outboundSchema, - ModelCapabilities$, - modelConversationToolsToJSON, - modelConversationToolsFromJSON, - modelConversationToJSON, - modelConversationFromJSON, - ModelConversationTools, - ModelConversationObject, - ModelConversation, - ModelConversationTools$inboundSchema, - ModelConversationTools$Outbound, - ModelConversationTools$outboundSchema, - ModelConversationTools$, - ModelConversationObject$inboundSchema, - ModelConversationObject$outboundSchema, - ModelConversationObject$, - ModelConversation$inboundSchema, - ModelConversation$Outbound, - ModelConversation$outboundSchema, - ModelConversation$, - dataToJSON, - dataFromJSON, - modelListToJSON, - modelListFromJSON, - Data, - ModelList, - Data$inboundSchema, - Data$Outbound, - Data$outboundSchema, - Data$, - ModelList$inboundSchema, - ModelList$Outbound, - ModelList$outboundSchema, - ModelList$, - moderationObjectToJSON, - moderationObjectFromJSON, - ModerationObject, - ModerationObject$inboundSchema, - ModerationObject$Outbound, - ModerationObject$outboundSchema, - ModerationObject$, - moderationResponseToJSON, - moderationResponseFromJSON, - ModerationResponse, - ModerationResponse$inboundSchema, - ModerationResponse$Outbound, - ModerationResponse$outboundSchema, - ModerationResponse$, - ocrImageObjectToJSON, - ocrImageObjectFromJSON, - OCRImageObject, - OCRImageObject$inboundSchema, - OCRImageObject$Outbound, - OCRImageObject$outboundSchema, - OCRImageObject$, - ocrPageDimensionsToJSON, - ocrPageDimensionsFromJSON, - OCRPageDimensions, - OCRPageDimensions$inboundSchema, - OCRPageDimensions$Outbound, - OCRPageDimensions$outboundSchema, - OCRPageDimensions$, - ocrPageObjectToJSON, - ocrPageObjectFromJSON, - OCRPageObject, - OCRPageObject$inboundSchema, - OCRPageObject$Outbound, - OCRPageObject$outboundSchema, - OCRPageObject$, - documentToJSON, - documentFromJSON, - ocrRequestToJSON, - ocrRequestFromJSON, - Document_2 as Document, - OCRRequest, - Document$inboundSchema, - Document$Outbound, - Document$outboundSchema, - Document$, - OCRRequest$inboundSchema, - OCRRequest$Outbound, - OCRRequest$outboundSchema, - OCRRequest$, - ocrResponseToJSON, - ocrResponseFromJSON, - OCRResponse, - OCRResponse$inboundSchema, - OCRResponse$Outbound, - OCRResponse$outboundSchema, - OCRResponse$, - ocrUsageInfoToJSON, - ocrUsageInfoFromJSON, - OCRUsageInfo, - OCRUsageInfo$inboundSchema, - OCRUsageInfo$Outbound, - OCRUsageInfo$outboundSchema, - OCRUsageInfo$, - outputContentChunksToJSON, - outputContentChunksFromJSON, - OutputContentChunks, - OutputContentChunks$inboundSchema, - OutputContentChunks$Outbound, - OutputContentChunks$outboundSchema, - OutputContentChunks$, - paginationInfoToJSON, - paginationInfoFromJSON, - PaginationInfo, - PaginationInfo$inboundSchema, - PaginationInfo$Outbound, - PaginationInfo$outboundSchema, - PaginationInfo$, - predictionToJSON, - predictionFromJSON, - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, - Prediction$, - processingStatusOutToJSON, - processingStatusOutFromJSON, - ProcessingStatusOut, - ProcessingStatusOut$inboundSchema, - ProcessingStatusOut$Outbound, - ProcessingStatusOut$outboundSchema, - ProcessingStatusOut$, - referenceChunkToJSON, - referenceChunkFromJSON, - ReferenceChunkType, - ReferenceChunk, - ReferenceChunkType$inboundSchema, - ReferenceChunkType$outboundSchema, - ReferenceChunkType$, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, - ReferenceChunk$, - responseDoneEventToJSON, - responseDoneEventFromJSON, - ResponseDoneEventType, - ResponseDoneEvent, - ResponseDoneEventType$inboundSchema, - ResponseDoneEventType$outboundSchema, - ResponseDoneEventType$, - ResponseDoneEvent$inboundSchema, - ResponseDoneEvent$Outbound, - ResponseDoneEvent$outboundSchema, - ResponseDoneEvent$, - responseErrorEventToJSON, - responseErrorEventFromJSON, - ResponseErrorEventType, - ResponseErrorEvent, - ResponseErrorEventType$inboundSchema, - ResponseErrorEventType$outboundSchema, - ResponseErrorEventType$, - ResponseErrorEvent$inboundSchema, - ResponseErrorEvent$Outbound, - ResponseErrorEvent$outboundSchema, - ResponseErrorEvent$, - responseFormatToJSON, - responseFormatFromJSON, - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, - ResponseFormat$, - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, - ResponseFormats$, - responseStartedEventToJSON, - responseStartedEventFromJSON, - ResponseStartedEventType, - ResponseStartedEvent, - ResponseStartedEventType$inboundSchema, - ResponseStartedEventType$outboundSchema, - ResponseStartedEventType$, - ResponseStartedEvent$inboundSchema, - ResponseStartedEvent$Outbound, - ResponseStartedEvent$outboundSchema, - ResponseStartedEvent$, - retrieveFileOutToJSON, - retrieveFileOutFromJSON, - RetrieveFileOut, - RetrieveFileOut$inboundSchema, - RetrieveFileOut$Outbound, - RetrieveFileOut$outboundSchema, - RetrieveFileOut$, - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, - SampleType$, - securityToJSON, - securityFromJSON, - Security, - Security$inboundSchema, - Security$Outbound, - Security$outboundSchema, - Security$, - ShareEnum, - ShareEnum$inboundSchema, - ShareEnum$outboundSchema, - ShareEnum$, - sharingDeleteToJSON, - sharingDeleteFromJSON, - SharingDelete, - SharingDelete$inboundSchema, - SharingDelete$Outbound, - SharingDelete$outboundSchema, - SharingDelete$, - sharingInToJSON, - sharingInFromJSON, - SharingIn, - SharingIn$inboundSchema, - SharingIn$Outbound, - SharingIn$outboundSchema, - SharingIn$, - sharingOutToJSON, - sharingOutFromJSON, - SharingOut, - SharingOut$inboundSchema, - SharingOut$Outbound, - SharingOut$outboundSchema, - SharingOut$, - Source, - Source$inboundSchema, - Source$outboundSchema, - Source$, - SSETypes, - SSETypes$inboundSchema, - SSETypes$outboundSchema, - SSETypes$, - systemMessageContentToJSON, - systemMessageContentFromJSON, - systemMessageToJSON, - systemMessageFromJSON, - SystemMessageContent, - Role, - SystemMessage, - SystemMessageContent$inboundSchema, - SystemMessageContent$Outbound, - SystemMessageContent$outboundSchema, - SystemMessageContent$, - Role$inboundSchema, - Role$outboundSchema, - Role$, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, - SystemMessage$, - systemMessageContentChunksToJSON, - systemMessageContentChunksFromJSON, - SystemMessageContentChunks, - SystemMessageContentChunks$inboundSchema, - SystemMessageContentChunks$Outbound, - SystemMessageContentChunks$outboundSchema, - SystemMessageContentChunks$, - textChunkToJSON, - textChunkFromJSON, - TextChunkType, - TextChunk, - TextChunkType$inboundSchema, - TextChunkType$outboundSchema, - TextChunkType$, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, - TextChunk$, - thinkingToJSON, - thinkingFromJSON, - thinkChunkToJSON, - thinkChunkFromJSON, - Thinking, - ThinkChunkType, - ThinkChunk, - Thinking$inboundSchema, - Thinking$Outbound, - Thinking$outboundSchema, - Thinking$, - ThinkChunkType$inboundSchema, - ThinkChunkType$outboundSchema, - ThinkChunkType$, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, - ThinkChunk$, - TimestampGranularity, - TimestampGranularity$inboundSchema, - TimestampGranularity$outboundSchema, - TimestampGranularity$, - toolToJSON, - toolFromJSON, - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, - Tool$, - toolCallToJSON, - toolCallFromJSON, - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, - ToolCall$, - toolChoiceToJSON, - toolChoiceFromJSON, - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, - ToolChoice$, - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, - ToolChoiceEnum$, - toolExecutionDeltaEventToJSON, - toolExecutionDeltaEventFromJSON, - ToolExecutionDeltaEventType, - ToolExecutionDeltaEvent, - ToolExecutionDeltaEventType$inboundSchema, - ToolExecutionDeltaEventType$outboundSchema, - ToolExecutionDeltaEventType$, - ToolExecutionDeltaEvent$inboundSchema, - ToolExecutionDeltaEvent$Outbound, - ToolExecutionDeltaEvent$outboundSchema, - ToolExecutionDeltaEvent$, - toolExecutionDoneEventToJSON, - toolExecutionDoneEventFromJSON, - ToolExecutionDoneEventType, - ToolExecutionDoneEvent, - ToolExecutionDoneEventType$inboundSchema, - ToolExecutionDoneEventType$outboundSchema, - ToolExecutionDoneEventType$, - ToolExecutionDoneEvent$inboundSchema, - ToolExecutionDoneEvent$Outbound, - ToolExecutionDoneEvent$outboundSchema, - ToolExecutionDoneEvent$, - toolExecutionEntryToJSON, - toolExecutionEntryFromJSON, - ToolExecutionEntryObject, - ToolExecutionEntryType, - ToolExecutionEntry, - ToolExecutionEntryObject$inboundSchema, - ToolExecutionEntryObject$outboundSchema, - ToolExecutionEntryObject$, - ToolExecutionEntryType$inboundSchema, - ToolExecutionEntryType$outboundSchema, - ToolExecutionEntryType$, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, - ToolExecutionEntry$, - toolExecutionStartedEventToJSON, - toolExecutionStartedEventFromJSON, - ToolExecutionStartedEventType, - ToolExecutionStartedEvent, - ToolExecutionStartedEventType$inboundSchema, - ToolExecutionStartedEventType$outboundSchema, - ToolExecutionStartedEventType$, - ToolExecutionStartedEvent$inboundSchema, - ToolExecutionStartedEvent$Outbound, - ToolExecutionStartedEvent$outboundSchema, - ToolExecutionStartedEvent$, - toolFileChunkToJSON, - toolFileChunkFromJSON, - ToolFileChunkType, - ToolFileChunk, - ToolFileChunkType$inboundSchema, - ToolFileChunkType$outboundSchema, - ToolFileChunkType$, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, - ToolFileChunk$, - toolMessageContentToJSON, - toolMessageContentFromJSON, - toolMessageToJSON, - toolMessageFromJSON, - ToolMessageContent, - ToolMessageRole, - ToolMessage, - ToolMessageContent$inboundSchema, - ToolMessageContent$Outbound, - ToolMessageContent$outboundSchema, - ToolMessageContent$, - ToolMessageRole$inboundSchema, - ToolMessageRole$outboundSchema, - ToolMessageRole$, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, - ToolMessage$, - toolReferenceChunkToJSON, - toolReferenceChunkFromJSON, - ToolReferenceChunkType, - ToolReferenceChunk, - ToolReferenceChunkType$inboundSchema, - ToolReferenceChunkType$outboundSchema, - ToolReferenceChunkType$, - ToolReferenceChunk$inboundSchema, - ToolReferenceChunk$Outbound, - ToolReferenceChunk$outboundSchema, - ToolReferenceChunk$, - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, - ToolTypes$, - trainingFileToJSON, - trainingFileFromJSON, - TrainingFile, - TrainingFile$inboundSchema, - TrainingFile$Outbound, - TrainingFile$outboundSchema, - TrainingFile$, - transcriptionResponseToJSON, - transcriptionResponseFromJSON, - TranscriptionResponse, - TranscriptionResponse$inboundSchema, - TranscriptionResponse$Outbound, - TranscriptionResponse$outboundSchema, - TranscriptionResponse$, - transcriptionSegmentChunkToJSON, - transcriptionSegmentChunkFromJSON, - Type, - TranscriptionSegmentChunk, - Type$inboundSchema, - Type$outboundSchema, - Type$, - TranscriptionSegmentChunk$inboundSchema, - TranscriptionSegmentChunk$Outbound, - TranscriptionSegmentChunk$outboundSchema, - TranscriptionSegmentChunk$, - transcriptionStreamDoneToJSON, - transcriptionStreamDoneFromJSON, - TranscriptionStreamDoneType, - TranscriptionStreamDone, - TranscriptionStreamDoneType$inboundSchema, - TranscriptionStreamDoneType$outboundSchema, - TranscriptionStreamDoneType$, - TranscriptionStreamDone$inboundSchema, - TranscriptionStreamDone$Outbound, - TranscriptionStreamDone$outboundSchema, - TranscriptionStreamDone$, - transcriptionStreamEventsDataToJSON, - transcriptionStreamEventsDataFromJSON, - transcriptionStreamEventsToJSON, - transcriptionStreamEventsFromJSON, - TranscriptionStreamEventsData, - TranscriptionStreamEvents, - TranscriptionStreamEventsData$inboundSchema, - TranscriptionStreamEventsData$Outbound, - TranscriptionStreamEventsData$outboundSchema, - TranscriptionStreamEventsData$, - TranscriptionStreamEvents$inboundSchema, - TranscriptionStreamEvents$Outbound, - TranscriptionStreamEvents$outboundSchema, - TranscriptionStreamEvents$, - TranscriptionStreamEventTypes, - TranscriptionStreamEventTypes$inboundSchema, - TranscriptionStreamEventTypes$outboundSchema, - TranscriptionStreamEventTypes$, - transcriptionStreamLanguageToJSON, - transcriptionStreamLanguageFromJSON, - TranscriptionStreamLanguageType, - TranscriptionStreamLanguage, - TranscriptionStreamLanguageType$inboundSchema, - TranscriptionStreamLanguageType$outboundSchema, - TranscriptionStreamLanguageType$, - TranscriptionStreamLanguage$inboundSchema, - TranscriptionStreamLanguage$Outbound, - TranscriptionStreamLanguage$outboundSchema, - TranscriptionStreamLanguage$, - transcriptionStreamSegmentDeltaToJSON, - transcriptionStreamSegmentDeltaFromJSON, - TranscriptionStreamSegmentDeltaType, - TranscriptionStreamSegmentDelta, - TranscriptionStreamSegmentDeltaType$inboundSchema, - TranscriptionStreamSegmentDeltaType$outboundSchema, - TranscriptionStreamSegmentDeltaType$, - TranscriptionStreamSegmentDelta$inboundSchema, - TranscriptionStreamSegmentDelta$Outbound, - TranscriptionStreamSegmentDelta$outboundSchema, - TranscriptionStreamSegmentDelta$, - transcriptionStreamTextDeltaToJSON, - transcriptionStreamTextDeltaFromJSON, - TranscriptionStreamTextDeltaType, - TranscriptionStreamTextDelta, - TranscriptionStreamTextDeltaType$inboundSchema, - TranscriptionStreamTextDeltaType$outboundSchema, - TranscriptionStreamTextDeltaType$, - TranscriptionStreamTextDelta$inboundSchema, - TranscriptionStreamTextDelta$Outbound, - TranscriptionStreamTextDelta$outboundSchema, - TranscriptionStreamTextDelta$, - unarchiveFTModelOutToJSON, - unarchiveFTModelOutFromJSON, - UnarchiveFTModelOutObject, - UnarchiveFTModelOut, - UnarchiveFTModelOutObject$inboundSchema, - UnarchiveFTModelOutObject$outboundSchema, - UnarchiveFTModelOutObject$, - UnarchiveFTModelOut$inboundSchema, - UnarchiveFTModelOut$Outbound, - UnarchiveFTModelOut$outboundSchema, - UnarchiveFTModelOut$, - updateFTModelInToJSON, - updateFTModelInFromJSON, - UpdateFTModelIn, - UpdateFTModelIn$inboundSchema, - UpdateFTModelIn$Outbound, - UpdateFTModelIn$outboundSchema, - UpdateFTModelIn$, - uploadFileOutToJSON, - uploadFileOutFromJSON, - UploadFileOut, - UploadFileOut$inboundSchema, - UploadFileOut$Outbound, - UploadFileOut$outboundSchema, - UploadFileOut$, - usageInfoToJSON, - usageInfoFromJSON, - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, - UsageInfo$, - userMessageContentToJSON, - userMessageContentFromJSON, - userMessageToJSON, - userMessageFromJSON, - UserMessageContent, - UserMessageRole, - UserMessage, - UserMessageContent$inboundSchema, - UserMessageContent$Outbound, - UserMessageContent$outboundSchema, - UserMessageContent$, - UserMessageRole$inboundSchema, - UserMessageRole$outboundSchema, - UserMessageRole$, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, - UserMessage$, - locToJSON, - locFromJSON, - validationErrorToJSON, - validationErrorFromJSON, - Loc, - ValidationError, - Loc$inboundSchema, - Loc$Outbound, - Loc$outboundSchema, - Loc$, - ValidationError$inboundSchema, - ValidationError$Outbound, - ValidationError$outboundSchema, - ValidationError$, - wandbIntegrationToJSON, - wandbIntegrationFromJSON, - WandbIntegrationType, - WandbIntegration, - WandbIntegrationType$inboundSchema, - WandbIntegrationType$outboundSchema, - WandbIntegrationType$, - WandbIntegration$inboundSchema, - WandbIntegration$Outbound, - WandbIntegration$outboundSchema, - WandbIntegration$, - wandbIntegrationOutToJSON, - wandbIntegrationOutFromJSON, - WandbIntegrationOutType, - WandbIntegrationOut, - WandbIntegrationOutType$inboundSchema, - WandbIntegrationOutType$outboundSchema, - WandbIntegrationOutType$, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, - WandbIntegrationOut$, - webSearchPremiumToolToJSON, - webSearchPremiumToolFromJSON, - WebSearchPremiumToolType, - WebSearchPremiumTool, - WebSearchPremiumToolType$inboundSchema, - WebSearchPremiumToolType$outboundSchema, - WebSearchPremiumToolType$, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, - WebSearchPremiumTool$, - webSearchToolToJSON, - webSearchToolFromJSON, - WebSearchToolType, - WebSearchTool, - WebSearchToolType$inboundSchema, - WebSearchToolType$outboundSchema, - WebSearchToolType$, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, - WebSearchTool$ - } -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -declare class ConnectionError extends HTTPClientError { - readonly name = "ConnectionError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Content$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Content$Outbound` instead. */ - type Outbound = Content$Outbound; -} - -/** @internal */ -declare const Content$inboundSchema: z.ZodType; - -/** @internal */ -declare type Content$Outbound = string | Array; - -/** @internal */ -declare const Content$outboundSchema: z.ZodType; - -declare type Content = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$Outbound` instead. */ - type Outbound = ContentChunk$Outbound; -} - -/** @internal */ -declare const ContentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ContentChunk$Outbound = (ImageURLChunk$Outbound & { - type: "image_url"; -}) | (DocumentURLChunk$Outbound & { - type: "document_url"; -}) | (TextChunk$Outbound & { - type: "text"; -}) | (ReferenceChunk$Outbound & { - type: "reference"; -}) | (FileChunk$Outbound & { - type: "file"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}) | (AudioChunk$Outbound & { - type: "input_audio"; -}); - -/** @internal */ -declare const ContentChunk$outboundSchema: z.ZodType; - -declare type ContentChunk = (ImageURLChunk & { - type: "image_url"; -}) | (DocumentURLChunk & { - type: "document_url"; -}) | (TextChunk & { - type: "text"; -}) | (ReferenceChunk & { - type: "reference"; -}) | (FileChunk & { - type: "file"; -}) | (ThinkChunk & { - type: "thinking"; -}) | (AudioChunk & { - type: "input_audio"; -}); - -declare function contentChunkFromJSON(jsonString: string): Result; - -declare function contentChunkToJSON(contentChunk: ContentChunk): string; - -declare function contentFromJSON(jsonString: string): Result; - -declare function contentToJSON(content: Content): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequest$ { - /** @deprecated use `ConversationAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$Outbound` instead. */ - type Outbound = ConversationAppendRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendRequestToJSON(conversationAppendRequest: ConversationAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequest$ { - /** @deprecated use `ConversationAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$Outbound` instead. */ - type Outbound = ConversationAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest: ConversationAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEvents$ { - /** @deprecated use `ConversationEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$Outbound` instead. */ - type Outbound = ConversationEvents$Outbound; -} - -/** @internal */ -declare const ConversationEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEvents$Outbound = { - event: string; - data: (FunctionCallEvent$Outbound & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; - }) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; - }); -}; - -/** @internal */ -declare const ConversationEvents$outboundSchema: z.ZodType; - -declare type ConversationEvents = { - /** - * Server side events sent when streaming a conversation response. - */ - event: SSETypes; - data: (FunctionCallEvent & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent & { - type: "conversation.response.error"; - }) | (MessageOutputEvent & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent & { - type: "conversation.response.started"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEventsData$ { - /** @deprecated use `ConversationEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$Outbound` instead. */ - type Outbound = ConversationEventsData$Outbound; -} - -/** @internal */ -declare const ConversationEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEventsData$Outbound = (FunctionCallEvent$Outbound & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; -}) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; -}); - -/** @internal */ -declare const ConversationEventsData$outboundSchema: z.ZodType; - -declare type ConversationEventsData = (FunctionCallEvent & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent & { - type: "conversation.response.error"; -}) | (MessageOutputEvent & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent & { - type: "conversation.response.started"; -}); - -declare function conversationEventsDataFromJSON(jsonString: string): Result; - -declare function conversationEventsDataToJSON(conversationEventsData: ConversationEventsData): string; - -declare function conversationEventsFromJSON(jsonString: string): Result; - -declare function conversationEventsToJSON(conversationEvents: ConversationEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistory$ { - /** @deprecated use `ConversationHistory$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$Outbound` instead. */ - type Outbound = ConversationHistory$Outbound; -} - -/** @internal */ -declare const ConversationHistory$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationHistory$Outbound = { - object: string; - conversation_id: string; - entries: Array; -}; - -/** @internal */ -declare const ConversationHistory$outboundSchema: z.ZodType; - -/** - * Retrieve all entries in a conversation. - */ -declare type ConversationHistory = { - object?: ConversationHistoryObject | undefined; - conversationId: string; - entries: Array; -}; - -declare function conversationHistoryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistoryObject$ { - /** @deprecated use `ConversationHistoryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; - /** @deprecated use `ConversationHistoryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; -} - -/** @internal */ -declare const ConversationHistoryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationHistoryObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationHistoryObject: { - readonly ConversationHistory: "conversation.history"; -}; - -declare type ConversationHistoryObject = ClosedEnum; - -declare function conversationHistoryToJSON(conversationHistory: ConversationHistory): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationInputs$ { - /** @deprecated use `ConversationInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$Outbound` instead. */ - type Outbound = ConversationInputs$Outbound; -} - -/** @internal */ -declare const ConversationInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationInputs$Outbound = string | Array; - -/** @internal */ -declare const ConversationInputs$outboundSchema: z.ZodType; - -declare type ConversationInputs = string | Array; - -declare function conversationInputsFromJSON(jsonString: string): Result; - -declare function conversationInputsToJSON(conversationInputs: ConversationInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessages$ { - /** @deprecated use `ConversationMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$Outbound` instead. */ - type Outbound = ConversationMessages$Outbound; -} - -/** @internal */ -declare const ConversationMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationMessages$Outbound = { - object: string; - conversation_id: string; - messages: Array; -}; - -/** @internal */ -declare const ConversationMessages$outboundSchema: z.ZodType; - -/** - * Similar to the conversation history but only keep the messages - */ -declare type ConversationMessages = { - object?: ConversationMessagesObject | undefined; - conversationId: string; - messages: Array; -}; - -declare function conversationMessagesFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessagesObject$ { - /** @deprecated use `ConversationMessagesObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; - /** @deprecated use `ConversationMessagesObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; -} - -/** @internal */ -declare const ConversationMessagesObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationMessagesObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationMessagesObject: { - readonly ConversationMessages: "conversation.messages"; -}; - -declare type ConversationMessagesObject = ClosedEnum; - -declare function conversationMessagesToJSON(conversationMessages: ConversationMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRequest$ { - /** @deprecated use `ConversationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$Outbound` instead. */ - type Outbound = ConversationRequest$Outbound; -} - -/** @internal */ -declare const ConversationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationRequest$outboundSchema: z.ZodType; - -declare type ConversationRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: HandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationRequestFromJSON(jsonString: string): Result; - -declare function conversationRequestToJSON(conversationRequest: ConversationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponse$ { - /** @deprecated use `ConversationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$Outbound` instead. */ - type Outbound = ConversationResponse$Outbound; -} - -/** @internal */ -declare const ConversationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationResponse$Outbound = { - object: string; - conversation_id: string; - outputs: Array; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ConversationResponse$outboundSchema: z.ZodType; - -/** - * The response after appending new entries to the conversation. - */ -declare type ConversationResponse = { - object?: ConversationResponseObject | undefined; - conversationId: string; - outputs: Array; - usage: ConversationUsageInfo; -}; - -declare function conversationResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponseObject$ { - /** @deprecated use `ConversationResponseObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; - /** @deprecated use `ConversationResponseObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; -} - -/** @internal */ -declare const ConversationResponseObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationResponseObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationResponseObject: { - readonly ConversationResponse: "conversation.response"; -}; - -declare type ConversationResponseObject = ClosedEnum; - -declare function conversationResponseToJSON(conversationResponse: ConversationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequest$ { - /** @deprecated use `ConversationRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$Outbound` instead. */ - type Outbound = ConversationRestartRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartRequestToJSON(conversationRestartRequest: ConversationRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequest$ { - /** @deprecated use `ConversationRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$Outbound` instead. */ - type Outbound = ConversationRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartStreamRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest: ConversationRestartStreamRequest): string; - -declare class Conversations extends ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - start(request: components.ConversationRequest, options?: RequestOptions): Promise; - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1ConversationsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - get(request: operations.AgentsApiV1ConversationsGetRequest, options?: RequestOptions): Promise; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - append(request: operations.AgentsApiV1ConversationsAppendRequest, options?: RequestOptions): Promise; - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - getHistory(request: operations.AgentsApiV1ConversationsHistoryRequest, options?: RequestOptions): Promise; - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - getMessages(request: operations.AgentsApiV1ConversationsMessagesRequest, options?: RequestOptions): Promise; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restart(request: operations.AgentsApiV1ConversationsRestartRequest, options?: RequestOptions): Promise; - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - startStream(request: components.ConversationStreamRequest, options?: RequestOptions): Promise>; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - appendStream(request: operations.AgentsApiV1ConversationsAppendStreamRequest, options?: RequestOptions): Promise>; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restartStream(request: operations.AgentsApiV1ConversationsRestartStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequest$ { - /** @deprecated use `ConversationStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$Outbound` instead. */ - type Outbound = ConversationStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: ConversationStreamRequestHandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationStreamRequestToJSON(conversationStreamRequest: ConversationStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestTools$ { - /** @deprecated use `ConversationStreamRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$Outbound` instead. */ - type Outbound = ConversationStreamRequestTools$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ConversationStreamRequestTools$outboundSchema: z.ZodType; - -declare type ConversationStreamRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function conversationStreamRequestToolsFromJSON(jsonString: string): Result; - -declare function conversationStreamRequestToolsToJSON(conversationStreamRequestTools: ConversationStreamRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationUsageInfo$ { - /** @deprecated use `ConversationUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$Outbound` instead. */ - type Outbound = ConversationUsageInfo$Outbound; -} - -/** @internal */ -declare const ConversationUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationUsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - connector_tokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -/** @internal */ -declare const ConversationUsageInfo$outboundSchema: z.ZodType; - -declare type ConversationUsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - connectorTokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -declare function conversationUsageInfoFromJSON(jsonString: string): Result; - -declare function conversationUsageInfoToJSON(conversationUsageInfo: ConversationUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Data$ { - /** @deprecated use `Data$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Data$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Data$Outbound` instead. */ - type Outbound = Data$Outbound; -} - -/** @internal */ -declare const Data$inboundSchema: z.ZodType; - -/** @internal */ -declare type Data$Outbound = (FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const Data$outboundSchema: z.ZodType; - -declare type Data = (FTModelCard & { - type: "fine-tuned"; -}) | (BaseModelCard & { - type: "base"; -}); - -declare function dataFromJSON(jsonString: string): Result; - -declare function dataToJSON(data: Data): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteFileOut$ { - /** @deprecated use `DeleteFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$Outbound` instead. */ - type Outbound = DeleteFileOut$Outbound; -} - -/** @internal */ -declare const DeleteFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteFileOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteFileOut$outboundSchema: z.ZodType; - -declare type DeleteFileOut = { - /** - * The ID of the deleted file. - */ - id: string; - /** - * The object type that was deleted - */ - object: string; - /** - * The deletion status. - */ - deleted: boolean; -}; - -declare function deleteFileOutFromJSON(jsonString: string): Result; - -declare function deleteFileOutToJSON(deleteFileOut: DeleteFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelOut$ { - /** @deprecated use `DeleteModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$Outbound` instead. */ - type Outbound = DeleteModelOut$Outbound; -} - -/** @internal */ -declare const DeleteModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteModelOut$outboundSchema: z.ZodType; - -declare type DeleteModelOut = { - /** - * The ID of the deleted model. - */ - id: string; - /** - * The object type that was deleted - */ - object?: string | undefined; - /** - * The deletion status - */ - deleted?: boolean | undefined; -}; - -declare function deleteModelOutFromJSON(jsonString: string): Result; - -declare function deleteModelOutToJSON(deleteModelOut: DeleteModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelV1ModelsModelIdDeleteRequest$ { - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$Outbound` instead. */ - type Outbound = DeleteModelV1ModelsModelIdDeleteRequest$Outbound; -} - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelV1ModelsModelIdDeleteRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema: z.ZodType; - -declare type DeleteModelV1ModelsModelIdDeleteRequest = { - /** - * The ID of the model to delete. - */ - modelId: string; -}; - -declare function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString: string): Result; - -declare function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest: DeleteModelV1ModelsModelIdDeleteRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - type Outbound = DeltaMessage$Outbound; -} - -/** @internal */ -declare const DeltaMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -declare const DeltaMessage$outboundSchema: z.ZodType; - -declare type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -declare function deltaMessageFromJSON(jsonString: string): Result; - -declare function deltaMessageToJSON(deltaMessage: DeltaMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Document$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Document$Outbound` instead. */ - type Outbound = Document$Outbound; -} - -/** @internal */ -declare const Document$inboundSchema: z.ZodType; - -/** @internal */ -declare type Document$Outbound = FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - -/** @internal */ -declare const Document$outboundSchema: z.ZodType; - -/** - * Document to run OCR on - */ -declare type Document_2 = FileChunk | DocumentURLChunk | ImageURLChunk; - -declare function documentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryTool$ { - /** @deprecated use `DocumentLibraryTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$Outbound` instead. */ - type Outbound = DocumentLibraryTool$Outbound; -} - -/** @internal */ -declare const DocumentLibraryTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentLibraryTool$Outbound = { - type: string; - library_ids: Array; -}; - -/** @internal */ -declare const DocumentLibraryTool$outboundSchema: z.ZodType; - -declare type DocumentLibraryTool = { - type?: DocumentLibraryToolType | undefined; - /** - * Ids of the library in which to search. - */ - libraryIds: Array; -}; - -declare function documentLibraryToolFromJSON(jsonString: string): Result; - -declare function documentLibraryToolToJSON(documentLibraryTool: DocumentLibraryTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryToolType$ { - /** @deprecated use `DocumentLibraryToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `DocumentLibraryToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const DocumentLibraryToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentLibraryToolType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentLibraryToolType: { - readonly DocumentLibrary: "document_library"; -}; - -declare type DocumentLibraryToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentOut$ { - /** @deprecated use `DocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$Outbound` instead. */ - type Outbound = DocumentOut$Outbound; -} - -/** @internal */ -declare const DocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentOut$Outbound = { - id: string; - library_id: string; - hash: string; - mime_type: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - created_at: string; - last_processed_at?: string | null | undefined; - number_of_pages?: number | null | undefined; - processing_status: string; - uploaded_by_id: string; - uploaded_by_type: string; - tokens_processing_main_content?: number | null | undefined; - tokens_processing_summary?: number | null | undefined; - tokens_processing_total: number; -}; - -/** @internal */ -declare const DocumentOut$outboundSchema: z.ZodType; - -declare type DocumentOut = { - id: string; - libraryId: string; - hash: string; - mimeType: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - createdAt: Date; - lastProcessedAt?: Date | null | undefined; - numberOfPages?: number | null | undefined; - processingStatus: string; - uploadedById: string; - uploadedByType: string; - tokensProcessingMainContent?: number | null | undefined; - tokensProcessingSummary?: number | null | undefined; - tokensProcessingTotal: number; -}; - -declare function documentOutFromJSON(jsonString: string): Result; - -declare function documentOutToJSON(documentOut: DocumentOut): string; - -declare class Documents extends ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - list(request: operations.LibrariesDocumentsListV1Request, options?: RequestOptions): Promise; - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - upload(request: operations.LibrariesDocumentsUploadV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - get(request: operations.LibrariesDocumentsGetV1Request, options?: RequestOptions): Promise; - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - update(request: operations.LibrariesDocumentsUpdateV1Request, options?: RequestOptions): Promise; - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - delete(request: operations.LibrariesDocumentsDeleteV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - textContent(request: operations.LibrariesDocumentsGetTextContentV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - status(request: operations.LibrariesDocumentsGetStatusV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - getSignedUrl(request: operations.LibrariesDocumentsGetSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - extractedTextSignedUrl(request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - reprocess(request: operations.LibrariesDocumentsReprocessV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentTextContent$ { - /** @deprecated use `DocumentTextContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$Outbound` instead. */ - type Outbound = DocumentTextContent$Outbound; -} - -/** @internal */ -declare const DocumentTextContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentTextContent$Outbound = { - text: string; -}; - -/** @internal */ -declare const DocumentTextContent$outboundSchema: z.ZodType; - -declare type DocumentTextContent = { - text: string; -}; - -declare function documentTextContentFromJSON(jsonString: string): Result; - -declare function documentTextContentToJSON(documentTextContent: DocumentTextContent): string; - -declare function documentToJSON(document: Document_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentUpdateIn$ { - /** @deprecated use `DocumentUpdateIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$Outbound` instead. */ - type Outbound = DocumentUpdateIn$Outbound; -} - -/** @internal */ -declare const DocumentUpdateIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentUpdateIn$Outbound = { - name?: string | null | undefined; -}; - -/** @internal */ -declare const DocumentUpdateIn$outboundSchema: z.ZodType; - -declare type DocumentUpdateIn = { - name?: string | null | undefined; -}; - -declare function documentUpdateInFromJSON(jsonString: string): Result; - -declare function documentUpdateInToJSON(documentUpdateIn: DocumentUpdateIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunk$ { - /** @deprecated use `DocumentURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$Outbound` instead. */ - type Outbound = DocumentURLChunk$Outbound; -} - -/** @internal */ -declare const DocumentURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentURLChunk$Outbound = { - document_url: string; - document_name?: string | null | undefined; - type: string; -}; - -/** @internal */ -declare const DocumentURLChunk$outboundSchema: z.ZodType; - -declare type DocumentURLChunk = { - documentUrl: string; - /** - * The filename of the document - */ - documentName?: string | null | undefined; - type?: DocumentURLChunkType | undefined; -}; - -declare function documentURLChunkFromJSON(jsonString: string): Result; - -declare function documentURLChunkToJSON(documentURLChunk: DocumentURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunkType$ { - /** @deprecated use `DocumentURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; - /** @deprecated use `DocumentURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; -} - -/** @internal */ -declare const DocumentURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentURLChunkType: { - readonly DocumentUrl: "document_url"; -}; - -declare type DocumentURLChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingDtype$ { - /** @deprecated use `EmbeddingDtype$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; - /** @deprecated use `EmbeddingDtype$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; -} - -/** @internal */ -declare const EmbeddingDtype$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EmbeddingDtype$outboundSchema: z.ZodNativeEnum; - -declare const EmbeddingDtype: { - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; -}; - -declare type EmbeddingDtype = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequest$ { - /** @deprecated use `EmbeddingRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$Outbound` instead. */ - type Outbound = EmbeddingRequest$Outbound; -} - -/** @internal */ -declare const EmbeddingRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequest$Outbound = { - model: string; - input: string | Array; - output_dimension?: number | null | undefined; - output_dtype?: string | undefined; - encoding_format?: string | undefined; -}; - -/** @internal */ -declare const EmbeddingRequest$outboundSchema: z.ZodType; - -declare type EmbeddingRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to embed. - */ - inputs: string | Array; - /** - * The dimension of the output embeddings. - */ - outputDimension?: number | null | undefined; - outputDtype?: EmbeddingDtype | undefined; - encodingFormat?: EncodingFormat | undefined; -}; - -declare function embeddingRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequestInputs$ { - /** @deprecated use `EmbeddingRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$Outbound` instead. */ - type Outbound = EmbeddingRequestInputs$Outbound; -} - -/** @internal */ -declare const EmbeddingRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const EmbeddingRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to embed. - */ -declare type EmbeddingRequestInputs = string | Array; - -declare function embeddingRequestInputsFromJSON(jsonString: string): Result; - -declare function embeddingRequestInputsToJSON(embeddingRequestInputs: EmbeddingRequestInputs): string; - -declare function embeddingRequestToJSON(embeddingRequest: EmbeddingRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponse$ { - /** @deprecated use `EmbeddingResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$Outbound` instead. */ - type Outbound = EmbeddingResponse$Outbound; -} - -/** @internal */ -declare const EmbeddingResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const EmbeddingResponse$outboundSchema: z.ZodType; - -declare type EmbeddingResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - data: Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponseData$ { - /** @deprecated use `EmbeddingResponseData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$Outbound` instead. */ - type Outbound = EmbeddingResponseData$Outbound; -} - -/** @internal */ -declare const EmbeddingResponseData$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponseData$Outbound = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -/** @internal */ -declare const EmbeddingResponseData$outboundSchema: z.ZodType; - -declare type EmbeddingResponseData = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -declare function embeddingResponseDataFromJSON(jsonString: string): Result; - -declare function embeddingResponseDataToJSON(embeddingResponseData: EmbeddingResponseData): string; - -declare function embeddingResponseFromJSON(jsonString: string): Result; - -declare function embeddingResponseToJSON(embeddingResponse: EmbeddingResponse): string; - -declare class Embeddings extends ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - create(request: components.EmbeddingRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EncodingFormat$ { - /** @deprecated use `EncodingFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; - /** @deprecated use `EncodingFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; -} - -/** @internal */ -declare const EncodingFormat$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EncodingFormat$outboundSchema: z.ZodNativeEnum; - -declare const EncodingFormat: { - readonly Float: "float"; - readonly Base64: "base64"; -}; - -declare type EncodingFormat = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntityType$ { - /** @deprecated use `EntityType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EntityType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const EntityType$inboundSchema: z.ZodType; - -/** @internal */ -declare const EntityType$outboundSchema: z.ZodType; - -/** - * The type of entity, used to share a library. - */ -declare const EntityType: { - readonly User: "User"; - readonly Workspace: "Workspace"; - readonly Org: "Org"; -}; - -/** - * The type of entity, used to share a library. - */ -declare type EntityType = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Entries$ { - /** @deprecated use `Entries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Entries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Entries$Outbound` instead. */ - type Outbound = Entries$Outbound; -} - -/** @internal */ -declare const Entries$inboundSchema: z.ZodType; - -/** @internal */ -declare type Entries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Entries$outboundSchema: z.ZodType; - -declare type Entries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function entriesFromJSON(jsonString: string): Result; - -declare function entriesToJSON(entries: Entries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventOut$ { - /** @deprecated use `EventOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EventOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EventOut$Outbound` instead. */ - type Outbound = EventOut$Outbound; -} - -/** @internal */ -declare const EventOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type EventOut$Outbound = { - name: string; - data?: { - [k: string]: any; - } | null | undefined; - created_at: number; -}; - -/** @internal */ -declare const EventOut$outboundSchema: z.ZodType; - -declare type EventOut = { - /** - * The name of the event. - */ - name: string; - data?: { - [k: string]: any; - } | null | undefined; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; -}; - -declare function eventOutFromJSON(jsonString: string): Result; - -declare function eventOutToJSON(eventOut: EventOut): string; - -declare class EventStream> extends ReadableStream { - constructor(responseBody: ReadableStream, parse: (x: ServerEvent) => IteratorResult); - [Symbol.asyncIterator](): AsyncIterableIterator; -} - -export declare type Fetcher = (input: RequestInfo | URL, init?: RequestInit) => Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileChunk$ { - /** @deprecated use `FileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileChunk$Outbound` instead. */ - type Outbound = FileChunk$Outbound; -} - -/** @internal */ -declare const FileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileChunk$Outbound = { - type: "file"; - file_id: string; -}; - -/** @internal */ -declare const FileChunk$outboundSchema: z.ZodType; - -declare type FileChunk = { - type?: "file" | undefined; - fileId: string; -}; - -declare function fileChunkFromJSON(jsonString: string): Result; - -declare function fileChunkToJSON(fileChunk: FileChunk): string; - -declare function fileFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilePurpose$ { - /** @deprecated use `FilePurpose$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilePurpose$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FilePurpose$inboundSchema: z.ZodType; - -/** @internal */ -declare const FilePurpose$outboundSchema: z.ZodType; - -declare const FilePurpose: { - readonly FineTune: "fine-tune"; - readonly Batch: "batch"; - readonly Ocr: "ocr"; -}; - -declare type FilePurpose = OpenEnum; - -declare class Files extends ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - upload(request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, options?: RequestOptions): Promise; - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - list(request?: operations.FilesApiRoutesListFilesRequest | undefined, options?: RequestOptions): Promise; - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - retrieve(request: operations.FilesApiRoutesRetrieveFileRequest, options?: RequestOptions): Promise; - /** - * Delete File - * - * @remarks - * Delete a file. - */ - delete(request: operations.FilesApiRoutesDeleteFileRequest, options?: RequestOptions): Promise; - /** - * Download File - * - * @remarks - * Download a file - */ - download(request: operations.FilesApiRoutesDownloadFileRequest, options?: RequestOptions): Promise>; - /** - * Get Signed Url - */ - getSignedUrl(request: operations.FilesApiRoutesGetSignedUrlRequest, options?: RequestOptions): Promise; -} - -export declare namespace files { - export { - readableStreamToArrayBuffer, - getContentTypeFromFileName - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDeleteFileRequest$ { - /** @deprecated use `FilesApiRoutesDeleteFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDeleteFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDeleteFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDeleteFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDeleteFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest: FilesApiRoutesDeleteFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDownloadFileRequest$ { - /** @deprecated use `FilesApiRoutesDownloadFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDownloadFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDownloadFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDownloadFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDownloadFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest: FilesApiRoutesDownloadFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesGetSignedUrlRequest$ { - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesGetSignedUrlRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesGetSignedUrlRequest$Outbound = { - file_id: string; - expiry: number; -}; - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesGetSignedUrlRequest = { - fileId: string; - /** - * Number of hours before the url becomes invalid. Defaults to 24h - */ - expiry?: number | undefined; -}; - -declare function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest: FilesApiRoutesGetSignedUrlRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesListFilesRequest$ { - /** @deprecated use `FilesApiRoutesListFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesListFilesRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesListFilesRequest$Outbound = { - page: number; - page_size: number; - sample_type?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: string | null | undefined; -}; - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesListFilesRequest = { - page?: number | undefined; - pageSize?: number | undefined; - sampleType?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: components.FilePurpose | null | undefined; -}; - -declare function filesApiRoutesListFilesRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest: FilesApiRoutesListFilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesRetrieveFileRequest$ { - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesRetrieveFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesRetrieveFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesRetrieveFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesRetrieveFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest: FilesApiRoutesRetrieveFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesUploadFileMultiPartBodyParams$ { - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$Outbound` instead. */ - type Outbound = FilesApiRoutesUploadFileMultiPartBodyParams$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesUploadFileMultiPartBodyParams$Outbound = { - purpose?: string | undefined; - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema: z.ZodType; - -declare type FilesApiRoutesUploadFileMultiPartBodyParams = { - purpose?: components.FilePurpose | undefined; - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString: string): Result; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams: FilesApiRoutesUploadFileMultiPartBodyParams): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSchema$ { - /** @deprecated use `FileSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSchema$Outbound` instead. */ - type Outbound = FileSchema$Outbound; -} - -/** @internal */ -declare const FileSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSchema$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const FileSchema$outboundSchema: z.ZodType; - -declare type FileSchema = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function fileSchemaFromJSON(jsonString: string): Result; - -declare function fileSchemaToJSON(fileSchema: FileSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSignedURL$ { - /** @deprecated use `FileSignedURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$Outbound` instead. */ - type Outbound = FileSignedURL$Outbound; -} - -/** @internal */ -declare const FileSignedURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSignedURL$Outbound = { - url: string; -}; - -/** @internal */ -declare const FileSignedURL$outboundSchema: z.ZodType; - -declare type FileSignedURL = { - url: string; -}; - -declare function fileSignedURLFromJSON(jsonString: string): Result; - -declare function fileSignedURLToJSON(fileSignedURL: FileSignedURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileT$ { - /** @deprecated use `FileT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileT$Outbound` instead. */ - type Outbound = FileT$Outbound; -} - -/** @internal */ -declare const FileT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileT$Outbound = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -declare const FileT$outboundSchema: z.ZodType; - -declare type FileT = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -declare function fileToJSON(fileT: FileT): string; - -declare class Fim extends ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - complete(request: components.FIMCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.FIMCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequest$ { - /** @deprecated use `FIMCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$Outbound` instead. */ - type Outbound = FIMCompletionRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequestStop$ { - /** @deprecated use `FIMCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionRequestStop = string | Array; - -declare function fimCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionRequestStopToJSON(fimCompletionRequestStop: FIMCompletionRequestStop): string; - -declare function fimCompletionRequestToJSON(fimCompletionRequest: FIMCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionResponse$ { - /** @deprecated use `FIMCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$Outbound` instead. */ - type Outbound = FIMCompletionResponse$Outbound; -} - -/** @internal */ -declare const FIMCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const FIMCompletionResponse$outboundSchema: z.ZodType; - -declare type FIMCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function fimCompletionResponseFromJSON(jsonString: string): Result; - -declare function fimCompletionResponseToJSON(fimCompletionResponse: FIMCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequest$ { - /** @deprecated use `FIMCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionStreamRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequestStop$ { - /** @deprecated use `FIMCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionStreamRequestStop = string | Array; - -declare function fimCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop: FIMCompletionStreamRequestStop): string; - -declare function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest: FIMCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FineTuneableModelType$ { - /** @deprecated use `FineTuneableModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; - /** @deprecated use `FineTuneableModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const FineTuneableModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FineTuneableModelType$outboundSchema: z.ZodNativeEnum; - -declare const FineTuneableModelType: { - readonly Completion: "completion"; - readonly Classifier: "classifier"; -}; - -declare type FineTuneableModelType = ClosedEnum; - -declare class FineTuning extends ClientSDK { - private _jobs?; - get jobs(): Jobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const FinishReason$outboundSchema: z.ZodType; - -declare const FinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly ModelLength: "model_length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type FinishReason = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTClassifierLossFunction$ { - /** @deprecated use `FTClassifierLossFunction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; - /** @deprecated use `FTClassifierLossFunction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; -} - -/** @internal */ -declare const FTClassifierLossFunction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTClassifierLossFunction$outboundSchema: z.ZodNativeEnum; - -declare const FTClassifierLossFunction: { - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; -}; - -declare type FTClassifierLossFunction = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCapabilitiesOut$ { - /** @deprecated use `FTModelCapabilitiesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$Outbound` instead. */ - type Outbound = FTModelCapabilitiesOut$Outbound; -} - -/** @internal */ -declare const FTModelCapabilitiesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCapabilitiesOut$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - classification: boolean; -}; - -/** @internal */ -declare const FTModelCapabilitiesOut$outboundSchema: z.ZodType; - -declare type FTModelCapabilitiesOut = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function ftModelCapabilitiesOutFromJSON(jsonString: string): Result; - -declare function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut: FTModelCapabilitiesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCard$ { - /** @deprecated use `FTModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$Outbound` instead. */ - type Outbound = FTModelCard$Outbound; -} - -/** @internal */ -declare const FTModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "fine-tuned"; - job: string; - root: string; - archived: boolean; -}; - -/** @internal */ -declare const FTModelCard$outboundSchema: z.ZodType; - -/** - * Extra fields for fine-tuned models. - */ -declare type FTModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "fine-tuned" | undefined; - job: string; - root: string; - archived?: boolean | undefined; -}; - -declare function ftModelCardFromJSON(jsonString: string): Result; - -declare function ftModelCardToJSON(ftModelCard: FTModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCardType$ { - /** @deprecated use `FTModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; - /** @deprecated use `FTModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; -} - -/** @internal */ -declare const FTModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const FTModelCardType: { - readonly FineTuned: "fine-tuned"; -}; - -declare type FTModelCardType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$Outbound` instead. */ - type Outbound = FunctionCall$Outbound; -} - -/** @internal */ -declare const FunctionCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCall$Outbound = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** @internal */ -declare const FunctionCall$outboundSchema: z.ZodType; - -declare type FunctionCall = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntry$ { - /** @deprecated use `FunctionCallEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$Outbound` instead. */ - type Outbound = FunctionCallEntry$Outbound; -} - -/** @internal */ -declare const FunctionCallEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - name: string; - arguments: FunctionCallEntryArguments$Outbound; -}; - -/** @internal */ -declare const FunctionCallEntry$outboundSchema: z.ZodType; - -declare type FunctionCallEntry = { - object?: FunctionCallEntryObject | undefined; - type?: FunctionCallEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - name: string; - arguments: FunctionCallEntryArguments; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryArguments$ { - /** @deprecated use `FunctionCallEntryArguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$Outbound` instead. */ - type Outbound = FunctionCallEntryArguments$Outbound; -} - -/** @internal */ -declare const FunctionCallEntryArguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntryArguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const FunctionCallEntryArguments$outboundSchema: z.ZodType; - -declare type FunctionCallEntryArguments = { - [k: string]: any; -} | string; - -declare function functionCallEntryArgumentsFromJSON(jsonString: string): Result; - -declare function functionCallEntryArgumentsToJSON(functionCallEntryArguments: FunctionCallEntryArguments): string; - -declare function functionCallEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryObject$ { - /** @deprecated use `FunctionCallEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionCallEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionCallEntryObject = ClosedEnum; - -declare function functionCallEntryToJSON(functionCallEntry: FunctionCallEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryType$ { - /** @deprecated use `FunctionCallEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; - /** @deprecated use `FunctionCallEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryType: { - readonly FunctionCall: "function.call"; -}; - -declare type FunctionCallEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEvent$ { - /** @deprecated use `FunctionCallEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$Outbound` instead. */ - type Outbound = FunctionCallEvent$Outbound; -} - -/** @internal */ -declare const FunctionCallEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - tool_call_id: string; - arguments: string; -}; - -/** @internal */ -declare const FunctionCallEvent$outboundSchema: z.ZodType; - -declare type FunctionCallEvent = { - type?: FunctionCallEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: string; - toolCallId: string; - arguments: string; -}; - -declare function functionCallEventFromJSON(jsonString: string): Result; - -declare function functionCallEventToJSON(functionCallEvent: FunctionCallEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEventType$ { - /** @deprecated use `FunctionCallEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `FunctionCallEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const FunctionCallEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEventType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEventType: { - readonly FunctionCallDelta: "function.call.delta"; -}; - -declare type FunctionCallEventType = ClosedEnum; - -declare function functionCallFromJSON(jsonString: string): Result; - -declare function functionCallToJSON(functionCall: FunctionCall): string; - -declare function functionFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionName$Outbound` instead. */ - type Outbound = FunctionName$Outbound; -} - -/** @internal */ -declare const FunctionName$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -declare const FunctionName$outboundSchema: z.ZodType; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -declare type FunctionName = { - name: string; -}; - -declare function functionNameFromJSON(jsonString: string): Result; - -declare function functionNameToJSON(functionName: FunctionName): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntry$ { - /** @deprecated use `FunctionResultEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$Outbound` instead. */ - type Outbound = FunctionResultEntry$Outbound; -} - -/** @internal */ -declare const FunctionResultEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionResultEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - result: string; -}; - -/** @internal */ -declare const FunctionResultEntry$outboundSchema: z.ZodType; - -declare type FunctionResultEntry = { - object?: FunctionResultEntryObject | undefined; - type?: FunctionResultEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - result: string; -}; - -declare function functionResultEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryObject$ { - /** @deprecated use `FunctionResultEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionResultEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionResultEntryObject = ClosedEnum; - -declare function functionResultEntryToJSON(functionResultEntry: FunctionResultEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryType$ { - /** @deprecated use `FunctionResultEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; - /** @deprecated use `FunctionResultEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryType: { - readonly FunctionResult: "function.result"; -}; - -declare type FunctionResultEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionT$Outbound` instead. */ - type Outbound = FunctionT$Outbound; -} - -/** @internal */ -declare const FunctionT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -/** @internal */ -declare const FunctionT$outboundSchema: z.ZodType; - -declare type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -declare function functionToJSON(functionT: FunctionT): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionTool$ { - /** @deprecated use `FunctionTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$Outbound` instead. */ - type Outbound = FunctionTool$Outbound; -} - -/** @internal */ -declare const FunctionTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionTool$Outbound = { - type: string; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const FunctionTool$outboundSchema: z.ZodType; - -declare type FunctionTool = { - type?: FunctionToolType | undefined; - function: FunctionT; -}; - -declare function functionToolFromJSON(jsonString: string): Result; - -declare function functionToolToJSON(functionTool: FunctionTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionToolType$ { - /** @deprecated use `FunctionToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; - /** @deprecated use `FunctionToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; -} - -/** @internal */ -declare const FunctionToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionToolType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionToolType: { - readonly Function: "function"; -}; - -declare type FunctionToolType = ClosedEnum; - -/** - * Determines the MIME content type based on a file's extension. - * Returns null if the extension is not recognized. - */ -declare function getContentTypeFromFileName(fileName: string): string | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryIn$ { - /** @deprecated use `GithubRepositoryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$Outbound` instead. */ - type Outbound = GithubRepositoryIn$Outbound; -} - -/** @internal */ -declare const GithubRepositoryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryIn$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - token: string; -}; - -/** @internal */ -declare const GithubRepositoryIn$outboundSchema: z.ZodType; - -declare type GithubRepositoryIn = { - type?: GithubRepositoryInType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - token: string; -}; - -declare function githubRepositoryInFromJSON(jsonString: string): Result; - -declare function githubRepositoryInToJSON(githubRepositoryIn: GithubRepositoryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryInType$ { - /** @deprecated use `GithubRepositoryInType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryInType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryInType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryInType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryInType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryInType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOut$ { - /** @deprecated use `GithubRepositoryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$Outbound` instead. */ - type Outbound = GithubRepositoryOut$Outbound; -} - -/** @internal */ -declare const GithubRepositoryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryOut$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - commit_id: string; -}; - -/** @internal */ -declare const GithubRepositoryOut$outboundSchema: z.ZodType; - -declare type GithubRepositoryOut = { - type?: GithubRepositoryOutType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - commitId: string; -}; - -declare function githubRepositoryOutFromJSON(jsonString: string): Result; - -declare function githubRepositoryOutToJSON(githubRepositoryOut: GithubRepositoryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOutType$ { - /** @deprecated use `GithubRepositoryOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryOutType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryOutType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryOutType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace HandoffExecution$ { - /** @deprecated use `HandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `HandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const HandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const HandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const HandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type HandoffExecution = ClosedEnum; - -declare type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes: string[] | null; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; - options: SDKOptions; -}; - -declare interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export declare class HTTPClient { - private options; - private fetcher; - private requestHooks; - private requestErrorHooks; - private responseHooks; - constructor(options?: HTTPClientOptions); - request(request: Request): Promise; - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - clone(): HTTPClient; -} - -/** - * Base class for all HTTP errors. - */ -declare class HTTPClientError extends Error { - /** The underlying cause of the error. */ - readonly cause: unknown; - name: string; - constructor(message: string, opts?: { - cause?: unknown; - }); -} - -export declare interface HTTPClientOptions { - fetcher?: Fetcher; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Hyperparameters$ { - /** @deprecated use `Hyperparameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$Outbound` instead. */ - type Outbound = Hyperparameters$Outbound; -} - -/** @internal */ -declare const Hyperparameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type Hyperparameters$Outbound = CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - -/** @internal */ -declare const Hyperparameters$outboundSchema: z.ZodType; - -declare type Hyperparameters = CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - -declare function hyperparametersFromJSON(jsonString: string): Result; - -declare function hyperparametersToJSON(hyperparameters: Hyperparameters): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationTool$ { - /** @deprecated use `ImageGenerationTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$Outbound` instead. */ - type Outbound = ImageGenerationTool$Outbound; -} - -/** @internal */ -declare const ImageGenerationTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageGenerationTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const ImageGenerationTool$outboundSchema: z.ZodType; - -declare type ImageGenerationTool = { - type?: ImageGenerationToolType | undefined; -}; - -declare function imageGenerationToolFromJSON(jsonString: string): Result; - -declare function imageGenerationToolToJSON(imageGenerationTool: ImageGenerationTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationToolType$ { - /** @deprecated use `ImageGenerationToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; - /** @deprecated use `ImageGenerationToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; -} - -/** @internal */ -declare const ImageGenerationToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageGenerationToolType$outboundSchema: z.ZodNativeEnum; - -declare const ImageGenerationToolType: { - readonly ImageGeneration: "image_generation"; -}; - -declare type ImageGenerationToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURL$Outbound` instead. */ - type Outbound = ImageURL$Outbound; -} - -/** @internal */ -declare const ImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -declare const ImageURL$outboundSchema: z.ZodType; - -declare type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - type Outbound = ImageURLChunk$Outbound; -} - -/** @internal */ -declare const ImageURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -declare const ImageURLChunk$outboundSchema: z.ZodType; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -declare type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -declare function imageURLChunkFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - type Outbound = ImageURLChunkImageURL$Outbound; -} - -/** @internal */ -declare const ImageURLChunkImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -declare const ImageURLChunkImageURL$outboundSchema: z.ZodType; - -declare type ImageURLChunkImageURL = ImageURL | string; - -declare function imageURLChunkImageURLFromJSON(jsonString: string): Result; - -declare function imageURLChunkImageURLToJSON(imageURLChunkImageURL: ImageURLChunkImageURL): string; - -declare function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; -} - -/** @internal */ -declare const ImageURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ImageURLChunkType: { - readonly ImageUrl: "image_url"; -}; - -declare type ImageURLChunkType = ClosedEnum; - -declare function imageURLFromJSON(jsonString: string): Result; - -declare function imageURLToJSON(imageURL: ImageURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InputEntries$ { - /** @deprecated use `InputEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InputEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InputEntries$Outbound` instead. */ - type Outbound = InputEntries$Outbound; -} - -/** @internal */ -declare const InputEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type InputEntries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const InputEntries$outboundSchema: z.ZodType; - -declare type InputEntries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function inputEntriesFromJSON(jsonString: string): Result; - -declare function inputEntriesToJSON(inputEntries: InputEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Inputs$ { - /** @deprecated use `Inputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Inputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Inputs$Outbound` instead. */ - type Outbound = Inputs$Outbound; -} - -/** @internal */ -declare const Inputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Inputs$Outbound = InstructRequestInputs$Outbound | Array; - -/** @internal */ -declare const Inputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type Inputs = InstructRequestInputs | Array; - -declare function inputsFromJSON(jsonString: string): Result; - -declare function inputsToJSON(inputs: Inputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequest$ { - /** @deprecated use `InstructRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$Outbound` instead. */ - type Outbound = InstructRequest$Outbound; -} - -/** @internal */ -declare const InstructRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequest$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequest$outboundSchema: z.ZodType; - -declare type InstructRequest = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputs$ { - /** @deprecated use `InstructRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$Outbound` instead. */ - type Outbound = InstructRequestInputs$Outbound; -} - -/** @internal */ -declare const InstructRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputs$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequestInputs$outboundSchema: z.ZodType; - -declare type InstructRequestInputs = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestInputsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputsMessages$ { - /** @deprecated use `InstructRequestInputsMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$Outbound` instead. */ - type Outbound = InstructRequestInputsMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestInputsMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputsMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestInputsMessages$outboundSchema: z.ZodType; - -declare type InstructRequestInputsMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestInputsMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestInputsMessagesToJSON(instructRequestInputsMessages: InstructRequestInputsMessages): string; - -declare function instructRequestInputsToJSON(instructRequestInputs: InstructRequestInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestMessages$ { - /** @deprecated use `InstructRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$Outbound` instead. */ - type Outbound = InstructRequestMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestMessages$outboundSchema: z.ZodType; - -declare type InstructRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestMessagesToJSON(instructRequestMessages: InstructRequestMessages): string; - -declare function instructRequestToJSON(instructRequest: InstructRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Integrations$ { - /** @deprecated use `Integrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Integrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Integrations$Outbound` instead. */ - type Outbound = Integrations$Outbound; -} - -/** @internal */ -declare const Integrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type Integrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const Integrations$outboundSchema: z.ZodType; - -declare type Integrations = WandbIntegrationOut; - -declare function integrationsFromJSON(jsonString: string): Result; - -declare function integrationsToJSON(integrations: Integrations): string; - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -declare class InvalidRequestError extends HTTPClientError { - name: string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobIn$ { - /** @deprecated use `JobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobIn$Outbound` instead. */ - type Outbound = JobIn$Outbound; -} - -/** @internal */ -declare const JobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobIn$Outbound = { - model: string; - training_files?: Array | undefined; - validation_files?: Array | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - auto_start?: boolean | undefined; - invalid_sample_skip_percentage: number; - job_type?: string | null | undefined; - hyperparameters: CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - repositories?: Array | null | undefined; - classifier_targets?: Array | null | undefined; -}; - -/** @internal */ -declare const JobIn$outboundSchema: z.ZodType; - -declare type JobIn = { - /** - * The name of the model to fine-tune. - */ - model: string; - trainingFiles?: Array | undefined; - /** - * A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - */ - validationFiles?: Array | null | undefined; - /** - * A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - */ - suffix?: string | null | undefined; - /** - * A list of integrations to enable for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * This field will be required in a future release. - */ - autoStart?: boolean | undefined; - invalidSampleSkipPercentage?: number | undefined; - jobType?: FineTuneableModelType | null | undefined; - hyperparameters: CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - repositories?: Array | null | undefined; - classifierTargets?: Array | null | undefined; -}; - -declare function jobInFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInIntegrations$ { - /** @deprecated use `JobInIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$Outbound` instead. */ - type Outbound = JobInIntegrations$Outbound; -} - -/** @internal */ -declare const JobInIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInIntegrations$Outbound = WandbIntegration$Outbound; - -/** @internal */ -declare const JobInIntegrations$outboundSchema: z.ZodType; - -declare type JobInIntegrations = WandbIntegration; - -declare function jobInIntegrationsFromJSON(jsonString: string): Result; - -declare function jobInIntegrationsToJSON(jobInIntegrations: JobInIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInRepositories$ { - /** @deprecated use `JobInRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$Outbound` instead. */ - type Outbound = JobInRepositories$Outbound; -} - -/** @internal */ -declare const JobInRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInRepositories$Outbound = GithubRepositoryIn$Outbound; - -/** @internal */ -declare const JobInRepositories$outboundSchema: z.ZodType; - -declare type JobInRepositories = GithubRepositoryIn; - -declare function jobInRepositoriesFromJSON(jsonString: string): Result; - -declare function jobInRepositoriesToJSON(jobInRepositories: JobInRepositories): string; - -declare function jobInToJSON(jobIn: JobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobMetadataOut$ { - /** @deprecated use `JobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$Outbound` instead. */ - type Outbound = JobMetadataOut$Outbound; -} - -/** @internal */ -declare const JobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; -}; - -/** @internal */ -declare const JobMetadataOut$outboundSchema: z.ZodType; - -declare type JobMetadataOut = { - expectedDurationSeconds?: number | null | undefined; - cost?: number | null | undefined; - costCurrency?: string | null | undefined; - trainTokensPerStep?: number | null | undefined; - trainTokens?: number | null | undefined; - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; -}; - -declare function jobMetadataOutFromJSON(jsonString: string): Result; - -declare function jobMetadataOutToJSON(jobMetadataOut: JobMetadataOut): string; - -declare class Jobs extends ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - create(request: components.JobIn, options?: RequestOptions): Promise; - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - get(request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - cancel(request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - start(request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchCancelBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchCancelBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchCancelBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchCancelBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest: JobsApiRoutesBatchCancelBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest: JobsApiRoutesBatchGetBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobsRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - created_after?: string | null | undefined; - created_by_me: boolean; - status?: Array | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobsRequest = { - page?: number | undefined; - pageSize?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - createdAfter?: Date | null | undefined; - createdByMe?: boolean | undefined; - status?: Array | null | undefined; -}; - -declare function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest: JobsApiRoutesBatchGetBatchJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest = { - /** - * The ID of the model to archive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest: JobsApiRoutesFineTuningArchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest = { - /** - * The ID of the job to cancel. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest: JobsApiRoutesFineTuningCancelFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse: JobsApiRoutesFineTuningCancelFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCreateFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound = components.LegacyJobMetadataOut$Outbound | (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse = components.LegacyJobMetadataOut | (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse: JobsApiRoutesFineTuningCreateFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest = { - /** - * The ID of the job to analyse. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest: JobsApiRoutesFineTuningGetFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse: JobsApiRoutesFineTuningGetFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobsRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - created_after?: string | null | undefined; - created_before?: string | null | undefined; - created_by_me: boolean; - status?: string | null | undefined; - wandb_project?: string | null | undefined; - wandb_name?: string | null | undefined; - suffix?: string | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest = { - /** - * The page number of the results to be returned. - */ - page?: number | undefined; - /** - * The number of items to return per page. - */ - pageSize?: number | undefined; - /** - * The model name used for fine-tuning to filter on. When set, the other results are not displayed. - */ - model?: string | null | undefined; - /** - * The date/time to filter on. When set, the results for previous creation times are not displayed. - */ - createdAfter?: Date | null | undefined; - createdBefore?: Date | null | undefined; - /** - * When set, only return results for jobs created by the API caller. Other results are not displayed. - */ - createdByMe?: boolean | undefined; - /** - * The current job state to filter on. When set, the other results are not displayed. - */ - status?: Status_2 | null | undefined; - /** - * The Weights and Biases project to filter on. When set, the other results are not displayed. - */ - wandbProject?: string | null | undefined; - /** - * The Weight and Biases run name to filter on. When set, the other results are not displayed. - */ - wandbName?: string | null | undefined; - /** - * The model suffix to filter on. When set, the other results are not displayed. - */ - suffix?: string | null | undefined; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest: JobsApiRoutesFineTuningGetFineTuningJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest: JobsApiRoutesFineTuningStartFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse: JobsApiRoutesFineTuningStartFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest = { - /** - * The ID of the model to unarchive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest: JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound = { - model_id: string; - UpdateFTModelIn: components.UpdateFTModelIn$Outbound; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest = { - /** - * The ID of the model to update. - */ - modelId: string; - updateFTModelIn: components.UpdateFTModelIn; -}; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest: JobsApiRoutesFineTuningUpdateFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound = (components.ClassifierFTModelOut$Outbound & { - model_type: "classifier"; -}) | (components.CompletionFTModelOut$Outbound & { - model_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse = (components.ClassifierFTModelOut & { - modelType: "classifier"; -}) | (components.CompletionFTModelOut & { - modelType: "completion"; -}); - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse: JobsApiRoutesFineTuningUpdateFineTunedModelResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOut$ { - /** @deprecated use `JobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOut$Outbound` instead. */ - type Outbound = JobsOut$Outbound; -} - -/** @internal */ -declare const JobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOut$Outbound = { - data?: Array<(ClassifierJobOut$Outbound & { - job_type: "classifier"; - }) | (CompletionJobOut$Outbound & { - job_type: "completion"; - })> | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const JobsOut$outboundSchema: z.ZodType; - -declare type JobsOut = { - data?: Array<(ClassifierJobOut & { - jobType: "classifier"; - }) | (CompletionJobOut & { - jobType: "completion"; - })> | undefined; - object?: JobsOutObject | undefined; - total: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutData$ { - /** @deprecated use `JobsOutData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$Outbound` instead. */ - type Outbound = JobsOutData$Outbound; -} - -/** @internal */ -declare const JobsOutData$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOutData$Outbound = (ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsOutData$outboundSchema: z.ZodType; - -declare type JobsOutData = (ClassifierJobOut & { - jobType: "classifier"; -}) | (CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsOutDataFromJSON(jsonString: string): Result; - -declare function jobsOutDataToJSON(jobsOutData: JobsOutData): string; - -declare function jobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutObject$ { - /** @deprecated use `JobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `JobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const JobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const JobsOutObject: { - readonly List: "list"; -}; - -declare type JobsOutObject = ClosedEnum; - -declare function jobsOutToJSON(jobsOut: JobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobType$ { - /** @deprecated use `JobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `JobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const JobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const JobType: { - readonly Completion: "completion"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type JobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$Outbound` instead. */ - type Outbound = JsonSchema$Outbound; -} - -/** @internal */ -declare const JsonSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -/** @internal */ -declare const JsonSchema$outboundSchema: z.ZodType; - -declare type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -declare function jsonSchemaFromJSON(jsonString: string): Result; - -declare function jsonSchemaToJSON(jsonSchema: JsonSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOut$ { - /** @deprecated use `LegacyJobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$Outbound` instead. */ - type Outbound = LegacyJobMetadataOut$Outbound; -} - -/** @internal */ -declare const LegacyJobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LegacyJobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; - deprecated: boolean; - details: string; - epochs?: number | null | undefined; - training_steps?: number | null | undefined; - object: string; -}; - -/** @internal */ -declare const LegacyJobMetadataOut$outboundSchema: z.ZodType; - -declare type LegacyJobMetadataOut = { - /** - * The approximated time (in seconds) for the fine-tuning process to complete. - */ - expectedDurationSeconds?: number | null | undefined; - /** - * The cost of the fine-tuning job. - */ - cost?: number | null | undefined; - /** - * The currency used for the fine-tuning job cost. - */ - costCurrency?: string | null | undefined; - /** - * The number of tokens consumed by one training step. - */ - trainTokensPerStep?: number | null | undefined; - /** - * The total number of tokens used during the fine-tuning process. - */ - trainTokens?: number | null | undefined; - /** - * The total number of tokens in the training dataset. - */ - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; - deprecated?: boolean | undefined; - details: string; - /** - * The number of complete passes through the entire training dataset. - */ - epochs?: number | null | undefined; - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - object?: LegacyJobMetadataOutObject | undefined; -}; - -declare function legacyJobMetadataOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOutObject$ { - /** @deprecated use `LegacyJobMetadataOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; - /** @deprecated use `LegacyJobMetadataOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; -} - -/** @internal */ -declare const LegacyJobMetadataOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const LegacyJobMetadataOutObject$outboundSchema: z.ZodNativeEnum; - -declare const LegacyJobMetadataOutObject: { - readonly JobMetadata: "job.metadata"; -}; - -declare type LegacyJobMetadataOutObject = ClosedEnum; - -declare function legacyJobMetadataOutToJSON(legacyJobMetadataOut: LegacyJobMetadataOut): string; - -declare class Libraries extends ClientSDK { - private _documents?; - get documents(): Documents; - private _accesses?; - get accesses(): Accesses; - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - list(options?: RequestOptions): Promise; - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - create(request: components.LibraryIn, options?: RequestOptions): Promise; - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - get(request: operations.LibrariesGetV1Request, options?: RequestOptions): Promise; - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - delete(request: operations.LibrariesDeleteV1Request, options?: RequestOptions): Promise; - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - update(request: operations.LibrariesUpdateV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDeleteV1Request$ { - /** @deprecated use `LibrariesDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDeleteV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDeleteV1Request = { - libraryId: string; -}; - -declare function librariesDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDeleteV1RequestToJSON(librariesDeleteV1Request: LibrariesDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsDeleteV1Request$ { - /** @deprecated use `LibrariesDocumentsDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsDeleteV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsDeleteV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request: LibrariesDocumentsDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request: LibrariesDocumentsGetExtractedTextSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request: LibrariesDocumentsGetSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetStatusV1Request$ { - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetStatusV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetStatusV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetStatusV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetStatusV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request: LibrariesDocumentsGetStatusV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetTextContentV1Request$ { - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetTextContentV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetTextContentV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetTextContentV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request: LibrariesDocumentsGetTextContentV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetV1Request$ { - /** @deprecated use `LibrariesDocumentsGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request: LibrariesDocumentsGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsListV1Request$ { - /** @deprecated use `LibrariesDocumentsListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsListV1Request$Outbound = { - library_id: string; - search?: string | null | undefined; - page_size: number; - page: number; - sort_by: string; - sort_order: string; -}; - -/** @internal */ -declare const LibrariesDocumentsListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsListV1Request = { - libraryId: string; - search?: string | null | undefined; - pageSize?: number | undefined; - page?: number | undefined; - sortBy?: string | undefined; - sortOrder?: string | undefined; -}; - -declare function librariesDocumentsListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request: LibrariesDocumentsListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsReprocessV1Request$ { - /** @deprecated use `LibrariesDocumentsReprocessV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsReprocessV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsReprocessV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsReprocessV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsReprocessV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request: LibrariesDocumentsReprocessV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUpdateV1Request$ { - /** @deprecated use `LibrariesDocumentsUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUpdateV1Request$Outbound = { - library_id: string; - document_id: string; - DocumentUpdateIn: components.DocumentUpdateIn$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUpdateV1Request = { - libraryId: string; - documentId: string; - documentUpdateIn: components.DocumentUpdateIn; -}; - -declare function librariesDocumentsUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request: LibrariesDocumentsUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1DocumentUpload$ { - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1DocumentUpload$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1DocumentUpload$Outbound = { - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1DocumentUpload = { - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload: LibrariesDocumentsUploadV1DocumentUpload): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1Request$ { - /** @deprecated use `LibrariesDocumentsUploadV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1Request$Outbound = { - library_id: string; - RequestBody: LibrariesDocumentsUploadV1DocumentUpload$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1Request = { - libraryId: string; - requestBody: LibrariesDocumentsUploadV1DocumentUpload; -}; - -declare function librariesDocumentsUploadV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request: LibrariesDocumentsUploadV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesGetV1Request$ { - /** @deprecated use `LibrariesGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$Outbound` instead. */ - type Outbound = LibrariesGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesGetV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesGetV1Request = { - libraryId: string; -}; - -declare function librariesGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesGetV1RequestToJSON(librariesGetV1Request: LibrariesGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareCreateV1Request$ { - /** @deprecated use `LibrariesShareCreateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$Outbound` instead. */ - type Outbound = LibrariesShareCreateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareCreateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareCreateV1Request$Outbound = { - library_id: string; - SharingIn: components.SharingIn$Outbound; -}; - -/** @internal */ -declare const LibrariesShareCreateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareCreateV1Request = { - libraryId: string; - sharingIn: components.SharingIn; -}; - -declare function librariesShareCreateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request: LibrariesShareCreateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareDeleteV1Request$ { - /** @deprecated use `LibrariesShareDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesShareDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareDeleteV1Request$Outbound = { - library_id: string; - SharingDelete: components.SharingDelete$Outbound; -}; - -/** @internal */ -declare const LibrariesShareDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareDeleteV1Request = { - libraryId: string; - sharingDelete: components.SharingDelete; -}; - -declare function librariesShareDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request: LibrariesShareDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareListV1Request$ { - /** @deprecated use `LibrariesShareListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$Outbound` instead. */ - type Outbound = LibrariesShareListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareListV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesShareListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareListV1Request = { - libraryId: string; -}; - -declare function librariesShareListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareListV1RequestToJSON(librariesShareListV1Request: LibrariesShareListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesUpdateV1Request$ { - /** @deprecated use `LibrariesUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesUpdateV1Request$Outbound = { - library_id: string; - LibraryInUpdate: components.LibraryInUpdate$Outbound; -}; - -/** @internal */ -declare const LibrariesUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesUpdateV1Request = { - libraryId: string; - libraryInUpdate: components.LibraryInUpdate; -}; - -declare function librariesUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesUpdateV1RequestToJSON(librariesUpdateV1Request: LibrariesUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryIn$ { - /** @deprecated use `LibraryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$Outbound` instead. */ - type Outbound = LibraryIn$Outbound; -} - -/** @internal */ -declare const LibraryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryIn$Outbound = { - name: string; - description?: string | null | undefined; - chunk_size?: number | null | undefined; -}; - -/** @internal */ -declare const LibraryIn$outboundSchema: z.ZodType; - -declare type LibraryIn = { - name: string; - description?: string | null | undefined; - chunkSize?: number | null | undefined; -}; - -declare function libraryInFromJSON(jsonString: string): Result; - -declare function libraryInToJSON(libraryIn: LibraryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryInUpdate$ { - /** @deprecated use `LibraryInUpdate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$Outbound` instead. */ - type Outbound = LibraryInUpdate$Outbound; -} - -/** @internal */ -declare const LibraryInUpdate$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryInUpdate$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryInUpdate$outboundSchema: z.ZodType; - -declare type LibraryInUpdate = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function libraryInUpdateFromJSON(jsonString: string): Result; - -declare function libraryInUpdateToJSON(libraryInUpdate: LibraryInUpdate): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryOut$ { - /** @deprecated use `LibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$Outbound` instead. */ - type Outbound = LibraryOut$Outbound; -} - -/** @internal */ -declare const LibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryOut$Outbound = { - id: string; - name: string; - created_at: string; - updated_at: string; - owner_id: string; - owner_type: string; - total_size: number; - nb_documents: number; - chunk_size: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generated_name?: string | null | undefined; - generated_description?: string | null | undefined; - explicit_user_members_count?: number | null | undefined; - explicit_workspace_members_count?: number | null | undefined; - org_sharing_role?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryOut$outboundSchema: z.ZodType; - -declare type LibraryOut = { - id: string; - name: string; - createdAt: Date; - updatedAt: Date; - ownerId: string; - ownerType: string; - totalSize: number; - nbDocuments: number; - chunkSize: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generatedName?: string | null | undefined; - generatedDescription?: string | null | undefined; - explicitUserMembersCount?: number | null | undefined; - explicitWorkspaceMembersCount?: number | null | undefined; - orgSharingRole?: string | null | undefined; -}; - -declare function libraryOutFromJSON(jsonString: string): Result; - -declare function libraryOutToJSON(libraryOut: LibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListDocumentOut$ { - /** @deprecated use `ListDocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$Outbound` instead. */ - type Outbound = ListDocumentOut$Outbound; -} - -/** @internal */ -declare const ListDocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListDocumentOut$Outbound = { - pagination: PaginationInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const ListDocumentOut$outboundSchema: z.ZodType; - -declare type ListDocumentOut = { - pagination: PaginationInfo; - data: Array; -}; - -declare function listDocumentOutFromJSON(jsonString: string): Result; - -declare function listDocumentOutToJSON(listDocumentOut: ListDocumentOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListFilesOut$ { - /** @deprecated use `ListFilesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$Outbound` instead. */ - type Outbound = ListFilesOut$Outbound; -} - -/** @internal */ -declare const ListFilesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListFilesOut$Outbound = { - data: Array; - object: string; - total: number; -}; - -/** @internal */ -declare const ListFilesOut$outboundSchema: z.ZodType; - -declare type ListFilesOut = { - data: Array; - object: string; - total: number; -}; - -declare function listFilesOutFromJSON(jsonString: string): Result; - -declare function listFilesOutToJSON(listFilesOut: ListFilesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListLibraryOut$ { - /** @deprecated use `ListLibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$Outbound` instead. */ - type Outbound = ListLibraryOut$Outbound; -} - -/** @internal */ -declare const ListLibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListLibraryOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListLibraryOut$outboundSchema: z.ZodType; - -declare type ListLibraryOut = { - data: Array; -}; - -declare function listLibraryOutFromJSON(jsonString: string): Result; - -declare function listLibraryOutToJSON(listLibraryOut: ListLibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListSharingOut$ { - /** @deprecated use `ListSharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$Outbound` instead. */ - type Outbound = ListSharingOut$Outbound; -} - -/** @internal */ -declare const ListSharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListSharingOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListSharingOut$outboundSchema: z.ZodType; - -declare type ListSharingOut = { - data: Array; -}; - -declare function listSharingOutFromJSON(jsonString: string): Result; - -declare function listSharingOutToJSON(listSharingOut: ListSharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Loc$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Loc$Outbound` instead. */ - type Outbound = Loc$Outbound; -} - -/** @internal */ -declare const Loc$inboundSchema: z.ZodType; - -/** @internal */ -declare type Loc$Outbound = string | number; - -/** @internal */ -declare const Loc$outboundSchema: z.ZodType; - -declare type Loc = string | number; - -declare function locFromJSON(jsonString: string): Result; - -declare function locToJSON(loc: Loc): string; - -declare interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageEntries$ { - /** @deprecated use `MessageEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$Outbound` instead. */ - type Outbound = MessageEntries$Outbound; -} - -/** @internal */ -declare const MessageEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageEntries$Outbound = MessageInputEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const MessageEntries$outboundSchema: z.ZodType; - -declare type MessageEntries = MessageInputEntry | MessageOutputEntry; - -declare function messageEntriesFromJSON(jsonString: string): Result; - -declare function messageEntriesToJSON(messageEntries: MessageEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputContentChunks$ { - /** @deprecated use `MessageInputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$Outbound` instead. */ - type Outbound = MessageInputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageInputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputContentChunks$Outbound = ToolFileChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageInputContentChunks$outboundSchema: z.ZodType; - -declare type MessageInputContentChunks = ToolFileChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageInputContentChunksFromJSON(jsonString: string): Result; - -declare function messageInputContentChunksToJSON(messageInputContentChunks: MessageInputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntry$ { - /** @deprecated use `MessageInputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$Outbound` instead. */ - type Outbound = MessageInputEntry$Outbound; -} - -/** @internal */ -declare const MessageInputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - role: string; - content: string | Array; - prefix: boolean; -}; - -/** @internal */ -declare const MessageInputEntry$outboundSchema: z.ZodType; - -/** - * Representation of an input message inside the conversation. - */ -declare type MessageInputEntry = { - object?: ObjectT | undefined; - type?: MessageInputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - role: MessageInputEntryRole; - content: string | Array; - prefix?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryContent$ { - /** @deprecated use `MessageInputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$Outbound` instead. */ - type Outbound = MessageInputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageInputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageInputEntryContent$outboundSchema: z.ZodType; - -declare type MessageInputEntryContent = string | Array; - -declare function messageInputEntryContentFromJSON(jsonString: string): Result; - -declare function messageInputEntryContentToJSON(messageInputEntryContent: MessageInputEntryContent): string; - -declare function messageInputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryRole$ { - /** @deprecated use `MessageInputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; - /** @deprecated use `MessageInputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; -} - -/** @internal */ -declare const MessageInputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryRole: { - readonly Assistant: "assistant"; - readonly User: "user"; -}; - -declare type MessageInputEntryRole = ClosedEnum; - -declare function messageInputEntryToJSON(messageInputEntry: MessageInputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryType$ { - /** @deprecated use `MessageInputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; - /** @deprecated use `MessageInputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; -} - -/** @internal */ -declare const MessageInputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryType: { - readonly MessageInput: "message.input"; -}; - -declare type MessageInputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputContentChunks$ { - /** @deprecated use `MessageOutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$Outbound` instead. */ - type Outbound = MessageOutputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageOutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageOutputContentChunks$outboundSchema: z.ZodType; - -declare type MessageOutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageOutputContentChunksFromJSON(jsonString: string): Result; - -declare function messageOutputContentChunksToJSON(messageOutputContentChunks: MessageOutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntry$ { - /** @deprecated use `MessageOutputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$Outbound` instead. */ - type Outbound = MessageOutputEntry$Outbound; -} - -/** @internal */ -declare const MessageOutputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; - role: string; - content: string | Array; -}; - -/** @internal */ -declare const MessageOutputEntry$outboundSchema: z.ZodType; - -declare type MessageOutputEntry = { - object?: MessageOutputEntryObject | undefined; - type?: MessageOutputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; - role?: MessageOutputEntryRole | undefined; - content: string | Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryContent$ { - /** @deprecated use `MessageOutputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$Outbound` instead. */ - type Outbound = MessageOutputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageOutputEntryContent$outboundSchema: z.ZodType; - -declare type MessageOutputEntryContent = string | Array; - -declare function messageOutputEntryContentFromJSON(jsonString: string): Result; - -declare function messageOutputEntryContentToJSON(messageOutputEntryContent: MessageOutputEntryContent): string; - -declare function messageOutputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryObject$ { - /** @deprecated use `MessageOutputEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `MessageOutputEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryObject: { - readonly Entry: "entry"; -}; - -declare type MessageOutputEntryObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryRole$ { - /** @deprecated use `MessageOutputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEntryRole = ClosedEnum; - -declare function messageOutputEntryToJSON(messageOutputEntry: MessageOutputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryType$ { - /** @deprecated use `MessageOutputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; - /** @deprecated use `MessageOutputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryType: { - readonly MessageOutput: "message.output"; -}; - -declare type MessageOutputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEvent$ { - /** @deprecated use `MessageOutputEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$Outbound` instead. */ - type Outbound = MessageOutputEvent$Outbound; -} - -/** @internal */ -declare const MessageOutputEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - content_index: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - role: string; - content: string | OutputContentChunks$Outbound; -}; - -/** @internal */ -declare const MessageOutputEvent$outboundSchema: z.ZodType; - -declare type MessageOutputEvent = { - type?: MessageOutputEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - contentIndex?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - role?: MessageOutputEventRole | undefined; - content: string | OutputContentChunks; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventContent$ { - /** @deprecated use `MessageOutputEventContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$Outbound` instead. */ - type Outbound = MessageOutputEventContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEventContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEventContent$Outbound = string | OutputContentChunks$Outbound; - -/** @internal */ -declare const MessageOutputEventContent$outboundSchema: z.ZodType; - -declare type MessageOutputEventContent = string | OutputContentChunks; - -declare function messageOutputEventContentFromJSON(jsonString: string): Result; - -declare function messageOutputEventContentToJSON(messageOutputEventContent: MessageOutputEventContent): string; - -declare function messageOutputEventFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventRole$ { - /** @deprecated use `MessageOutputEventRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEventRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEventRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEventRole = ClosedEnum; - -declare function messageOutputEventToJSON(messageOutputEvent: MessageOutputEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventType$ { - /** @deprecated use `MessageOutputEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; - /** @deprecated use `MessageOutputEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; -} - -/** @internal */ -declare const MessageOutputEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventType: { - readonly MessageOutputDelta: "message.output.delta"; -}; - -declare type MessageOutputEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Messages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Messages$Outbound` instead. */ - type Outbound = Messages$Outbound; -} - -/** @internal */ -declare const Messages$inboundSchema: z.ZodType; - -/** @internal */ -declare type Messages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Messages$outboundSchema: z.ZodType; - -declare type Messages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function messagesFromJSON(jsonString: string): Result; - -declare function messagesToJSON(messages: Messages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MetricOut$ { - /** @deprecated use `MetricOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MetricOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MetricOut$Outbound` instead. */ - type Outbound = MetricOut$Outbound; -} - -/** @internal */ -declare const MetricOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type MetricOut$Outbound = { - train_loss?: number | null | undefined; - valid_loss?: number | null | undefined; - valid_mean_token_accuracy?: number | null | undefined; -}; - -/** @internal */ -declare const MetricOut$outboundSchema: z.ZodType; - -/** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ -declare type MetricOut = { - trainLoss?: number | null | undefined; - validLoss?: number | null | undefined; - validMeanTokenAccuracy?: number | null | undefined; -}; - -declare function metricOutFromJSON(jsonString: string): Result; - -declare function metricOutToJSON(metricOut: MetricOut): string; - -export declare class Mistral extends ClientSDK { - private _models?; - get models(): Models; - private _beta?; - get beta(): Beta; - private _files?; - get files(): Files; - private _fineTuning?; - get fineTuning(): FineTuning; - private _batch?; - get batch(): Batch; - private _chat?; - get chat(): Chat; - private _fim?; - get fim(): Fim; - private _agents?; - get agents(): Agents; - private _embeddings?; - get embeddings(): Embeddings; - private _classifiers?; - get classifiers(): Classifiers; - private _ocr?; - get ocr(): Ocr; - private _audio?; - get audio(): Audio_2; -} - -declare class MistralAgents extends ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - create(request: components.AgentCreationRequest, options?: RequestOptions): Promise; - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1AgentsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - get(request: operations.AgentsApiV1AgentsGetRequest, options?: RequestOptions): Promise; - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - update(request: operations.AgentsApiV1AgentsUpdateRequest, options?: RequestOptions): Promise; - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - updateVersion(request: operations.AgentsApiV1AgentsUpdateVersionRequest, options?: RequestOptions): Promise; -} - -declare class MistralJobs extends ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - create(request: components.BatchJobIn, options?: RequestOptions): Promise; - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - get(request: operations.JobsApiRoutesBatchGetBatchJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - cancel(request: operations.JobsApiRoutesBatchCancelBatchJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MistralPromptMode$ { - /** @deprecated use `MistralPromptMode$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MistralPromptMode$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const MistralPromptMode$inboundSchema: z.ZodType; - -/** @internal */ -declare const MistralPromptMode$outboundSchema: z.ZodType; - -declare const MistralPromptMode: { - readonly Reasoning: "reasoning"; -}; - -declare type MistralPromptMode = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelCapabilities$ { - /** @deprecated use `ModelCapabilities$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$Outbound` instead. */ - type Outbound = ModelCapabilities$Outbound; -} - -/** @internal */ -declare const ModelCapabilities$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelCapabilities$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - vision: boolean; - classification: boolean; -}; - -/** @internal */ -declare const ModelCapabilities$outboundSchema: z.ZodType; - -declare type ModelCapabilities = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - vision?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function modelCapabilitiesFromJSON(jsonString: string): Result; - -declare function modelCapabilitiesToJSON(modelCapabilities: ModelCapabilities): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversation$ { - /** @deprecated use `ModelConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$Outbound` instead. */ - type Outbound = ModelConversation$Outbound; -} - -/** @internal */ -declare const ModelConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversation$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - model: string; -}; - -/** @internal */ -declare const ModelConversation$outboundSchema: z.ZodType; - -declare type ModelConversation = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: ModelConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - model: string; -}; - -declare function modelConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationObject$ { - /** @deprecated use `ModelConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `ModelConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const ModelConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const ModelConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type ModelConversationObject = ClosedEnum; - -declare function modelConversationToJSON(modelConversation: ModelConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationTools$ { - /** @deprecated use `ModelConversationTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$Outbound` instead. */ - type Outbound = ModelConversationTools$Outbound; -} - -/** @internal */ -declare const ModelConversationTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversationTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ModelConversationTools$outboundSchema: z.ZodType; - -declare type ModelConversationTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function modelConversationToolsFromJSON(jsonString: string): Result; - -declare function modelConversationToolsToJSON(modelConversationTools: ModelConversationTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelList$ { - /** @deprecated use `ModelList$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelList$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelList$Outbound` instead. */ - type Outbound = ModelList$Outbound; -} - -/** @internal */ -declare const ModelList$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelList$Outbound = { - object: string; - data?: Array<(FTModelCard$Outbound & { - type: "fine-tuned"; - }) | (BaseModelCard$Outbound & { - type: "base"; - })> | undefined; -}; - -/** @internal */ -declare const ModelList$outboundSchema: z.ZodType; - -declare type ModelList = { - object?: string | undefined; - data?: Array<(FTModelCard & { - type: "fine-tuned"; - }) | (BaseModelCard & { - type: "base"; - })> | undefined; -}; - -declare function modelListFromJSON(jsonString: string): Result; - -declare function modelListToJSON(modelList: ModelList): string; - -declare class Models extends ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - list(options?: RequestOptions): Promise; - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - retrieve(request: operations.RetrieveModelV1ModelsModelIdGetRequest, options?: RequestOptions): Promise; - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - delete(request: operations.DeleteModelV1ModelsModelIdDeleteRequest, options?: RequestOptions): Promise; - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - update(request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - archive(request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - unarchive(request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelType$ { - /** @deprecated use `ModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `ModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const ModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelType$outboundSchema: z.ZodNativeEnum; - -declare const ModelType: { - readonly Completion: "completion"; -}; - -declare type ModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationObject$ { - /** @deprecated use `ModerationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$Outbound` instead. */ - type Outbound = ModerationObject$Outbound; -} - -/** @internal */ -declare const ModerationObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationObject$Outbound = { - categories?: { - [k: string]: boolean; - } | undefined; - category_scores?: { - [k: string]: number; - } | undefined; -}; - -/** @internal */ -declare const ModerationObject$outboundSchema: z.ZodType; - -declare type ModerationObject = { - /** - * Moderation result thresholds - */ - categories?: { - [k: string]: boolean; - } | undefined; - /** - * Moderation result - */ - categoryScores?: { - [k: string]: number; - } | undefined; -}; - -declare function moderationObjectFromJSON(jsonString: string): Result; - -declare function moderationObjectToJSON(moderationObject: ModerationObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationResponse$ { - /** @deprecated use `ModerationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$Outbound` instead. */ - type Outbound = ModerationResponse$Outbound; -} - -/** @internal */ -declare const ModerationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationResponse$Outbound = { - id: string; - model: string; - results: Array; -}; - -/** @internal */ -declare const ModerationResponse$outboundSchema: z.ZodType; - -declare type ModerationResponse = { - id: string; - model: string; - results: Array; -}; - -declare function moderationResponseFromJSON(jsonString: string): Result; - -declare function moderationResponseToJSON(moderationResponse: ModerationResponse): string; - -declare type OAuth2PasswordFlow = { - username: string; - password: string; - clientID?: string | undefined; - clientSecret?: string | undefined; - tokenURL: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ObjectT$ { - /** @deprecated use `ObjectT$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ObjectT$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ObjectT$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ObjectT$outboundSchema: z.ZodNativeEnum; - -declare const ObjectT: { - readonly Entry: "entry"; -}; - -declare type ObjectT = ClosedEnum; - -declare class Ocr extends ClientSDK { - /** - * OCR - */ - process(request: components.OCRRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRImageObject$ { - /** @deprecated use `OCRImageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$Outbound` instead. */ - type Outbound = OCRImageObject$Outbound; -} - -/** @internal */ -declare const OCRImageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRImageObject$Outbound = { - id: string; - top_left_x: number | null; - top_left_y: number | null; - bottom_right_x: number | null; - bottom_right_y: number | null; - image_base64?: string | null | undefined; - image_annotation?: string | null | undefined; -}; - -/** @internal */ -declare const OCRImageObject$outboundSchema: z.ZodType; - -declare type OCRImageObject = { - /** - * Image ID for extracted image in a page - */ - id: string; - /** - * X coordinate of top-left corner of the extracted image - */ - topLeftX: number | null; - /** - * Y coordinate of top-left corner of the extracted image - */ - topLeftY: number | null; - /** - * X coordinate of bottom-right corner of the extracted image - */ - bottomRightX: number | null; - /** - * Y coordinate of bottom-right corner of the extracted image - */ - bottomRightY: number | null; - /** - * Base64 string of the extracted image - */ - imageBase64?: string | null | undefined; - /** - * Annotation of the extracted image in json str - */ - imageAnnotation?: string | null | undefined; -}; - -declare function ocrImageObjectFromJSON(jsonString: string): Result; - -declare function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageDimensions$ { - /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$Outbound` instead. */ - type Outbound = OCRPageDimensions$Outbound; -} - -/** @internal */ -declare const OCRPageDimensions$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageDimensions$Outbound = { - dpi: number; - height: number; - width: number; -}; - -/** @internal */ -declare const OCRPageDimensions$outboundSchema: z.ZodType; - -declare type OCRPageDimensions = { - /** - * Dots per inch of the page-image - */ - dpi: number; - /** - * Height of the image in pixels - */ - height: number; - /** - * Width of the image in pixels - */ - width: number; -}; - -declare function ocrPageDimensionsFromJSON(jsonString: string): Result; - -declare function ocrPageDimensionsToJSON(ocrPageDimensions: OCRPageDimensions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageObject$ { - /** @deprecated use `OCRPageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$Outbound` instead. */ - type Outbound = OCRPageObject$Outbound; -} - -/** @internal */ -declare const OCRPageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageObject$Outbound = { - index: number; - markdown: string; - images: Array; - dimensions: OCRPageDimensions$Outbound | null; -}; - -/** @internal */ -declare const OCRPageObject$outboundSchema: z.ZodType; - -declare type OCRPageObject = { - /** - * The page index in a pdf document starting from 0 - */ - index: number; - /** - * The markdown string response of the page - */ - markdown: string; - /** - * List of all extracted images in the page - */ - images: Array; - /** - * The dimensions of the PDF Page's screenshot image - */ - dimensions: OCRPageDimensions | null; -}; - -declare function ocrPageObjectFromJSON(jsonString: string): Result; - -declare function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRRequest$ { - /** @deprecated use `OCRRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$Outbound` instead. */ - type Outbound = OCRRequest$Outbound; -} - -/** @internal */ -declare const OCRRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRRequest$Outbound = { - model: string | null; - id?: string | undefined; - document: FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - pages?: Array | null | undefined; - include_image_base64?: boolean | null | undefined; - image_limit?: number | null | undefined; - image_min_size?: number | null | undefined; - bbox_annotation_format?: ResponseFormat$Outbound | null | undefined; - document_annotation_format?: ResponseFormat$Outbound | null | undefined; -}; - -/** @internal */ -declare const OCRRequest$outboundSchema: z.ZodType; - -declare type OCRRequest = { - model: string | null; - id?: string | undefined; - /** - * Document to run OCR on - */ - document: FileChunk | DocumentURLChunk | ImageURLChunk; - /** - * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - */ - pages?: Array | null | undefined; - /** - * Include image URLs in response - */ - includeImageBase64?: boolean | null | undefined; - /** - * Max images to extract - */ - imageLimit?: number | null | undefined; - /** - * Minimum height and width of image to extract - */ - imageMinSize?: number | null | undefined; - /** - * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - */ - bboxAnnotationFormat?: ResponseFormat | null | undefined; - /** - * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - */ - documentAnnotationFormat?: ResponseFormat | null | undefined; -}; - -declare function ocrRequestFromJSON(jsonString: string): Result; - -declare function ocrRequestToJSON(ocrRequest: OCRRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRResponse$ { - /** @deprecated use `OCRResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$Outbound` instead. */ - type Outbound = OCRResponse$Outbound; -} - -/** @internal */ -declare const OCRResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRResponse$Outbound = { - pages: Array; - model: string; - document_annotation?: string | null | undefined; - usage_info: OCRUsageInfo$Outbound; -}; - -/** @internal */ -declare const OCRResponse$outboundSchema: z.ZodType; - -declare type OCRResponse = { - /** - * List of OCR info for pages. - */ - pages: Array; - /** - * The model used to generate the OCR. - */ - model: string; - /** - * Formatted response in the request_format if provided in json str - */ - documentAnnotation?: string | null | undefined; - usageInfo: OCRUsageInfo; -}; - -declare function ocrResponseFromJSON(jsonString: string): Result; - -declare function ocrResponseToJSON(ocrResponse: OCRResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRUsageInfo$ { - /** @deprecated use `OCRUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$Outbound` instead. */ - type Outbound = OCRUsageInfo$Outbound; -} - -/** @internal */ -declare const OCRUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRUsageInfo$Outbound = { - pages_processed: number; - doc_size_bytes?: number | null | undefined; -}; - -/** @internal */ -declare const OCRUsageInfo$outboundSchema: z.ZodType; - -declare type OCRUsageInfo = { - /** - * Number of pages processed - */ - pagesProcessed: number; - /** - * Document size in bytes - */ - docSizeBytes?: number | null | undefined; -}; - -declare function ocrUsageInfoFromJSON(jsonString: string): Result; - -declare function ocrUsageInfoToJSON(ocrUsageInfo: OCRUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$ { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$_2 { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound_2; -} - -/** @internal */ -declare const One$inboundSchema: z.ZodType; - -/** @internal */ -declare const One$inboundSchema_2: z.ZodType; - -/** @internal */ -declare type One$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare type One$Outbound_2 = (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const One$outboundSchema: z.ZodType; - -/** @internal */ -declare const One$outboundSchema_2: z.ZodType; - -declare type One = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare type One_2 = (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function oneFromJSON(jsonString: string): Result; - -declare function oneFromJSON_2(jsonString: string): Result; - -declare function oneToJSON(one: One): string; - -declare function oneToJSON_2(one: One_2): string; - -declare type OpenEnum = Prettify | Unrecognized; - -declare namespace operations { - export { - agentsApiV1AgentsGetRequestToJSON, - agentsApiV1AgentsGetRequestFromJSON, - AgentsApiV1AgentsGetRequest, - AgentsApiV1AgentsGetRequest$inboundSchema, - AgentsApiV1AgentsGetRequest$Outbound, - AgentsApiV1AgentsGetRequest$outboundSchema, - AgentsApiV1AgentsGetRequest$, - agentsApiV1AgentsListRequestToJSON, - agentsApiV1AgentsListRequestFromJSON, - AgentsApiV1AgentsListRequest, - AgentsApiV1AgentsListRequest$inboundSchema, - AgentsApiV1AgentsListRequest$Outbound, - AgentsApiV1AgentsListRequest$outboundSchema, - AgentsApiV1AgentsListRequest$, - agentsApiV1AgentsUpdateRequestToJSON, - agentsApiV1AgentsUpdateRequestFromJSON, - AgentsApiV1AgentsUpdateRequest, - AgentsApiV1AgentsUpdateRequest$inboundSchema, - AgentsApiV1AgentsUpdateRequest$Outbound, - AgentsApiV1AgentsUpdateRequest$outboundSchema, - AgentsApiV1AgentsUpdateRequest$, - agentsApiV1AgentsUpdateVersionRequestToJSON, - agentsApiV1AgentsUpdateVersionRequestFromJSON, - AgentsApiV1AgentsUpdateVersionRequest, - AgentsApiV1AgentsUpdateVersionRequest$inboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$Outbound, - AgentsApiV1AgentsUpdateVersionRequest$outboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$, - agentsApiV1ConversationsAppendRequestToJSON, - agentsApiV1ConversationsAppendRequestFromJSON, - AgentsApiV1ConversationsAppendRequest, - AgentsApiV1ConversationsAppendRequest$inboundSchema, - AgentsApiV1ConversationsAppendRequest$Outbound, - AgentsApiV1ConversationsAppendRequest$outboundSchema, - AgentsApiV1ConversationsAppendRequest$, - agentsApiV1ConversationsAppendStreamRequestToJSON, - agentsApiV1ConversationsAppendStreamRequestFromJSON, - AgentsApiV1ConversationsAppendStreamRequest, - AgentsApiV1ConversationsAppendStreamRequest$inboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$Outbound, - AgentsApiV1ConversationsAppendStreamRequest$outboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$, - agentsApiV1ConversationsGetRequestToJSON, - agentsApiV1ConversationsGetRequestFromJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON, - AgentsApiV1ConversationsGetRequest, - AgentsApiV1ConversationsGetResponseV1ConversationsGet, - AgentsApiV1ConversationsGetRequest$inboundSchema, - AgentsApiV1ConversationsGetRequest$Outbound, - AgentsApiV1ConversationsGetRequest$outboundSchema, - AgentsApiV1ConversationsGetRequest$, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$, - agentsApiV1ConversationsHistoryRequestToJSON, - agentsApiV1ConversationsHistoryRequestFromJSON, - AgentsApiV1ConversationsHistoryRequest, - AgentsApiV1ConversationsHistoryRequest$inboundSchema, - AgentsApiV1ConversationsHistoryRequest$Outbound, - AgentsApiV1ConversationsHistoryRequest$outboundSchema, - AgentsApiV1ConversationsHistoryRequest$, - agentsApiV1ConversationsListRequestToJSON, - agentsApiV1ConversationsListRequestFromJSON, - responseBodyToJSON, - responseBodyFromJSON, - AgentsApiV1ConversationsListRequest, - ResponseBody, - AgentsApiV1ConversationsListRequest$inboundSchema, - AgentsApiV1ConversationsListRequest$Outbound, - AgentsApiV1ConversationsListRequest$outboundSchema, - AgentsApiV1ConversationsListRequest$, - ResponseBody$inboundSchema, - ResponseBody$Outbound, - ResponseBody$outboundSchema, - ResponseBody$, - agentsApiV1ConversationsMessagesRequestToJSON, - agentsApiV1ConversationsMessagesRequestFromJSON, - AgentsApiV1ConversationsMessagesRequest, - AgentsApiV1ConversationsMessagesRequest$inboundSchema, - AgentsApiV1ConversationsMessagesRequest$Outbound, - AgentsApiV1ConversationsMessagesRequest$outboundSchema, - AgentsApiV1ConversationsMessagesRequest$, - agentsApiV1ConversationsRestartRequestToJSON, - agentsApiV1ConversationsRestartRequestFromJSON, - AgentsApiV1ConversationsRestartRequest, - AgentsApiV1ConversationsRestartRequest$inboundSchema, - AgentsApiV1ConversationsRestartRequest$Outbound, - AgentsApiV1ConversationsRestartRequest$outboundSchema, - AgentsApiV1ConversationsRestartRequest$, - agentsApiV1ConversationsRestartStreamRequestToJSON, - agentsApiV1ConversationsRestartStreamRequestFromJSON, - AgentsApiV1ConversationsRestartStreamRequest, - AgentsApiV1ConversationsRestartStreamRequest$inboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$Outbound, - AgentsApiV1ConversationsRestartStreamRequest$outboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$, - deleteModelV1ModelsModelIdDeleteRequestToJSON, - deleteModelV1ModelsModelIdDeleteRequestFromJSON, - DeleteModelV1ModelsModelIdDeleteRequest, - DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$Outbound, - DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$, - filesApiRoutesDeleteFileRequestToJSON, - filesApiRoutesDeleteFileRequestFromJSON, - FilesApiRoutesDeleteFileRequest, - FilesApiRoutesDeleteFileRequest$inboundSchema, - FilesApiRoutesDeleteFileRequest$Outbound, - FilesApiRoutesDeleteFileRequest$outboundSchema, - FilesApiRoutesDeleteFileRequest$, - filesApiRoutesDownloadFileRequestToJSON, - filesApiRoutesDownloadFileRequestFromJSON, - FilesApiRoutesDownloadFileRequest, - FilesApiRoutesDownloadFileRequest$inboundSchema, - FilesApiRoutesDownloadFileRequest$Outbound, - FilesApiRoutesDownloadFileRequest$outboundSchema, - FilesApiRoutesDownloadFileRequest$, - filesApiRoutesGetSignedUrlRequestToJSON, - filesApiRoutesGetSignedUrlRequestFromJSON, - FilesApiRoutesGetSignedUrlRequest, - FilesApiRoutesGetSignedUrlRequest$inboundSchema, - FilesApiRoutesGetSignedUrlRequest$Outbound, - FilesApiRoutesGetSignedUrlRequest$outboundSchema, - FilesApiRoutesGetSignedUrlRequest$, - filesApiRoutesListFilesRequestToJSON, - filesApiRoutesListFilesRequestFromJSON, - FilesApiRoutesListFilesRequest, - FilesApiRoutesListFilesRequest$inboundSchema, - FilesApiRoutesListFilesRequest$Outbound, - FilesApiRoutesListFilesRequest$outboundSchema, - FilesApiRoutesListFilesRequest$, - filesApiRoutesRetrieveFileRequestToJSON, - filesApiRoutesRetrieveFileRequestFromJSON, - FilesApiRoutesRetrieveFileRequest, - FilesApiRoutesRetrieveFileRequest$inboundSchema, - FilesApiRoutesRetrieveFileRequest$Outbound, - FilesApiRoutesRetrieveFileRequest$outboundSchema, - FilesApiRoutesRetrieveFileRequest$, - filesApiRoutesUploadFileMultiPartBodyParamsToJSON, - filesApiRoutesUploadFileMultiPartBodyParamsFromJSON, - FilesApiRoutesUploadFileMultiPartBodyParams, - FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$Outbound, - FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$, - jobsApiRoutesBatchCancelBatchJobRequestToJSON, - jobsApiRoutesBatchCancelBatchJobRequestFromJSON, - JobsApiRoutesBatchCancelBatchJobRequest, - JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$Outbound, - JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobRequestToJSON, - jobsApiRoutesBatchGetBatchJobRequestFromJSON, - JobsApiRoutesBatchGetBatchJobRequest, - JobsApiRoutesBatchGetBatchJobRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$Outbound, - JobsApiRoutesBatchGetBatchJobRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobsRequestToJSON, - jobsApiRoutesBatchGetBatchJobsRequestFromJSON, - JobsApiRoutesBatchGetBatchJobsRequest, - JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$Outbound, - JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningCancelFineTuningJobRequest, - JobsApiRoutesFineTuningCancelFineTuningJobResponse, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$, - oneToJSON_2 as oneToJSON, - oneFromJSON_2 as oneFromJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON, - One_2 as One, - JobsApiRoutesFineTuningCreateFineTuningJobResponse, - One$inboundSchema_2 as One$inboundSchema, - One$Outbound_2 as One$Outbound, - One$outboundSchema_2 as One$outboundSchema, - One$_2 as One$, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningGetFineTuningJobRequest, - JobsApiRoutesFineTuningGetFineTuningJobResponse, - JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$, - JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON, - Status_2 as Status, - JobsApiRoutesFineTuningGetFineTuningJobsRequest, - Status$inboundSchema_2 as Status$inboundSchema, - Status$outboundSchema_2 as Status$outboundSchema, - Status$_2 as Status$, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$, - jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningStartFineTuningJobRequest, - JobsApiRoutesFineTuningStartFineTuningJobResponse, - JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$, - JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$, - librariesDeleteV1RequestToJSON, - librariesDeleteV1RequestFromJSON, - LibrariesDeleteV1Request, - LibrariesDeleteV1Request$inboundSchema, - LibrariesDeleteV1Request$Outbound, - LibrariesDeleteV1Request$outboundSchema, - LibrariesDeleteV1Request$, - librariesDocumentsDeleteV1RequestToJSON, - librariesDocumentsDeleteV1RequestFromJSON, - LibrariesDocumentsDeleteV1Request, - LibrariesDocumentsDeleteV1Request$inboundSchema, - LibrariesDocumentsDeleteV1Request$Outbound, - LibrariesDocumentsDeleteV1Request$outboundSchema, - LibrariesDocumentsDeleteV1Request$, - librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON, - librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$, - librariesDocumentsGetSignedUrlV1RequestToJSON, - librariesDocumentsGetSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetSignedUrlV1Request, - LibrariesDocumentsGetSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$Outbound, - LibrariesDocumentsGetSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$, - librariesDocumentsGetStatusV1RequestToJSON, - librariesDocumentsGetStatusV1RequestFromJSON, - LibrariesDocumentsGetStatusV1Request, - LibrariesDocumentsGetStatusV1Request$inboundSchema, - LibrariesDocumentsGetStatusV1Request$Outbound, - LibrariesDocumentsGetStatusV1Request$outboundSchema, - LibrariesDocumentsGetStatusV1Request$, - librariesDocumentsGetTextContentV1RequestToJSON, - librariesDocumentsGetTextContentV1RequestFromJSON, - LibrariesDocumentsGetTextContentV1Request, - LibrariesDocumentsGetTextContentV1Request$inboundSchema, - LibrariesDocumentsGetTextContentV1Request$Outbound, - LibrariesDocumentsGetTextContentV1Request$outboundSchema, - LibrariesDocumentsGetTextContentV1Request$, - librariesDocumentsGetV1RequestToJSON, - librariesDocumentsGetV1RequestFromJSON, - LibrariesDocumentsGetV1Request, - LibrariesDocumentsGetV1Request$inboundSchema, - LibrariesDocumentsGetV1Request$Outbound, - LibrariesDocumentsGetV1Request$outboundSchema, - LibrariesDocumentsGetV1Request$, - librariesDocumentsListV1RequestToJSON, - librariesDocumentsListV1RequestFromJSON, - LibrariesDocumentsListV1Request, - LibrariesDocumentsListV1Request$inboundSchema, - LibrariesDocumentsListV1Request$Outbound, - LibrariesDocumentsListV1Request$outboundSchema, - LibrariesDocumentsListV1Request$, - librariesDocumentsReprocessV1RequestToJSON, - librariesDocumentsReprocessV1RequestFromJSON, - LibrariesDocumentsReprocessV1Request, - LibrariesDocumentsReprocessV1Request$inboundSchema, - LibrariesDocumentsReprocessV1Request$Outbound, - LibrariesDocumentsReprocessV1Request$outboundSchema, - LibrariesDocumentsReprocessV1Request$, - librariesDocumentsUpdateV1RequestToJSON, - librariesDocumentsUpdateV1RequestFromJSON, - LibrariesDocumentsUpdateV1Request, - LibrariesDocumentsUpdateV1Request$inboundSchema, - LibrariesDocumentsUpdateV1Request$Outbound, - LibrariesDocumentsUpdateV1Request$outboundSchema, - LibrariesDocumentsUpdateV1Request$, - librariesDocumentsUploadV1DocumentUploadToJSON, - librariesDocumentsUploadV1DocumentUploadFromJSON, - librariesDocumentsUploadV1RequestToJSON, - librariesDocumentsUploadV1RequestFromJSON, - LibrariesDocumentsUploadV1DocumentUpload, - LibrariesDocumentsUploadV1Request, - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$Outbound, - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$, - LibrariesDocumentsUploadV1Request$inboundSchema, - LibrariesDocumentsUploadV1Request$Outbound, - LibrariesDocumentsUploadV1Request$outboundSchema, - LibrariesDocumentsUploadV1Request$, - librariesGetV1RequestToJSON, - librariesGetV1RequestFromJSON, - LibrariesGetV1Request, - LibrariesGetV1Request$inboundSchema, - LibrariesGetV1Request$Outbound, - LibrariesGetV1Request$outboundSchema, - LibrariesGetV1Request$, - librariesShareCreateV1RequestToJSON, - librariesShareCreateV1RequestFromJSON, - LibrariesShareCreateV1Request, - LibrariesShareCreateV1Request$inboundSchema, - LibrariesShareCreateV1Request$Outbound, - LibrariesShareCreateV1Request$outboundSchema, - LibrariesShareCreateV1Request$, - librariesShareDeleteV1RequestToJSON, - librariesShareDeleteV1RequestFromJSON, - LibrariesShareDeleteV1Request, - LibrariesShareDeleteV1Request$inboundSchema, - LibrariesShareDeleteV1Request$Outbound, - LibrariesShareDeleteV1Request$outboundSchema, - LibrariesShareDeleteV1Request$, - librariesShareListV1RequestToJSON, - librariesShareListV1RequestFromJSON, - LibrariesShareListV1Request, - LibrariesShareListV1Request$inboundSchema, - LibrariesShareListV1Request$Outbound, - LibrariesShareListV1Request$outboundSchema, - LibrariesShareListV1Request$, - librariesUpdateV1RequestToJSON, - librariesUpdateV1RequestFromJSON, - LibrariesUpdateV1Request, - LibrariesUpdateV1Request$inboundSchema, - LibrariesUpdateV1Request$Outbound, - LibrariesUpdateV1Request$outboundSchema, - LibrariesUpdateV1Request$, - retrieveModelV1ModelsModelIdGetRequestToJSON, - retrieveModelV1ModelsModelIdGetRequestFromJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON, - RetrieveModelV1ModelsModelIdGetRequest, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - RetrieveModelV1ModelsModelIdGetRequest$inboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$Outbound, - RetrieveModelV1ModelsModelIdGetRequest$outboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OutputContentChunks$ { - /** @deprecated use `OutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$Outbound` instead. */ - type Outbound = OutputContentChunks$Outbound; -} - -/** @internal */ -declare const OutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type OutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const OutputContentChunks$outboundSchema: z.ZodType; - -declare type OutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function outputContentChunksFromJSON(jsonString: string): Result; - -declare function outputContentChunksToJSON(outputContentChunks: OutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Outputs$ { - /** @deprecated use `Outputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Outputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Outputs$Outbound` instead. */ - type Outbound = Outputs$Outbound; -} - -/** @internal */ -declare const Outputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Outputs$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Outputs$outboundSchema: z.ZodType; - -declare type Outputs = AgentHandoffEntry | FunctionCallEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function outputsFromJSON(jsonString: string): Result; - -declare function outputsToJSON(outputs: Outputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PaginationInfo$ { - /** @deprecated use `PaginationInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$Outbound` instead. */ - type Outbound = PaginationInfo$Outbound; -} - -/** @internal */ -declare const PaginationInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type PaginationInfo$Outbound = { - total_items: number; - total_pages: number; - current_page: number; - page_size: number; - has_more: boolean; -}; - -/** @internal */ -declare const PaginationInfo$outboundSchema: z.ZodType; - -declare type PaginationInfo = { - totalItems: number; - totalPages: number; - currentPage: number; - pageSize: number; - hasMore: boolean; -}; - -declare function paginationInfoFromJSON(jsonString: string): Result; - -declare function paginationInfoToJSON(paginationInfo: PaginationInfo): string; - -declare type ParsedAssistantMessage = components.AssistantMessage & { - parsed?: z_2.infer | undefined; -}; - -declare type ParsedChatCompletionChoice = Omit & { - message?: ParsedAssistantMessage | undefined; -}; - -declare type ParsedChatCompletionRequest = Omit & { - responseFormat: T; -}; - -declare type ParsedChatCompletionResponse = Omit & { - choices?: Array> | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Prediction$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Prediction$Outbound` instead. */ - type Outbound = Prediction$Outbound; -} - -/** @internal */ -declare const Prediction$inboundSchema: z.ZodType; - -/** @internal */ -declare type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -declare const Prediction$outboundSchema: z.ZodType; - -declare type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -declare function predictionFromJSON(jsonString: string): Result; - -declare function predictionToJSON(prediction: Prediction): string; - -declare type Prettify = { - [K in keyof T]: T[K]; -} & {}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessingStatusOut$ { - /** @deprecated use `ProcessingStatusOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$Outbound` instead. */ - type Outbound = ProcessingStatusOut$Outbound; -} - -/** @internal */ -declare const ProcessingStatusOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessingStatusOut$Outbound = { - document_id: string; - processing_status: string; -}; - -/** @internal */ -declare const ProcessingStatusOut$outboundSchema: z.ZodType; - -declare type ProcessingStatusOut = { - documentId: string; - processingStatus: string; -}; - -declare function processingStatusOutFromJSON(jsonString: string): Result; - -declare function processingStatusOutToJSON(processingStatusOut: ProcessingStatusOut): string; - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -declare function readableStreamToArrayBuffer(readable: ReadableStream): Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - type Outbound = ReferenceChunk$Outbound; -} - -/** @internal */ -declare const ReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -declare const ReferenceChunk$outboundSchema: z.ZodType; - -declare type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -declare function referenceChunkFromJSON(jsonString: string): Result; - -declare function referenceChunkToJSON(referenceChunk: ReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; -} - -/** @internal */ -declare const ReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ReferenceChunkType: { - readonly Reference: "reference"; -}; - -declare type ReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Repositories$ { - /** @deprecated use `Repositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Repositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Repositories$Outbound` instead. */ - type Outbound = Repositories$Outbound; -} - -/** @internal */ -declare const Repositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type Repositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const Repositories$outboundSchema: z.ZodType; - -declare type Repositories = GithubRepositoryOut; - -declare function repositoriesFromJSON(jsonString: string): Result; - -declare function repositoriesToJSON(repositories: Repositories): string; - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -declare class RequestAbortedError extends HTTPClientError { - readonly name = "RequestAbortedError"; -} - -declare type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - userAgent?: string | undefined; - timeoutMs?: number; -}; - -declare type RequestErrorHook = (err: unknown, req: Request) => Awaitable; - -declare type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -declare type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * @deprecated `fetchOptions` has been flattened into `RequestOptions`. - * - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -} & Omit; - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -declare class RequestTimeoutError extends HTTPClientError { - readonly name = "RequestTimeoutError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseBody$ { - /** @deprecated use `ResponseBody$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$Outbound` instead. */ - type Outbound = ResponseBody$Outbound; -} - -/** @internal */ -declare const ResponseBody$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseBody$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const ResponseBody$outboundSchema: z.ZodType; - -declare type ResponseBody = components.ModelConversation | components.AgentConversation; - -declare function responseBodyFromJSON(jsonString: string): Result; - -declare function responseBodyToJSON(responseBody: ResponseBody): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEvent$ { - /** @deprecated use `ResponseDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$Outbound` instead. */ - type Outbound = ResponseDoneEvent$Outbound; -} - -/** @internal */ -declare const ResponseDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ResponseDoneEvent$outboundSchema: z.ZodType; - -declare type ResponseDoneEvent = { - type?: ResponseDoneEventType | undefined; - createdAt?: Date | undefined; - usage: ConversationUsageInfo; -}; - -declare function responseDoneEventFromJSON(jsonString: string): Result; - -declare function responseDoneEventToJSON(responseDoneEvent: ResponseDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEventType$ { - /** @deprecated use `ResponseDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; - /** @deprecated use `ResponseDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; -} - -/** @internal */ -declare const ResponseDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseDoneEventType: { - readonly ConversationResponseDone: "conversation.response.done"; -}; - -declare type ResponseDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEvent$ { - /** @deprecated use `ResponseErrorEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$Outbound` instead. */ - type Outbound = ResponseErrorEvent$Outbound; -} - -/** @internal */ -declare const ResponseErrorEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseErrorEvent$Outbound = { - type: string; - created_at?: string | undefined; - message: string; - code: number; -}; - -/** @internal */ -declare const ResponseErrorEvent$outboundSchema: z.ZodType; - -declare type ResponseErrorEvent = { - type?: ResponseErrorEventType | undefined; - createdAt?: Date | undefined; - message: string; - code: number; -}; - -declare function responseErrorEventFromJSON(jsonString: string): Result; - -declare function responseErrorEventToJSON(responseErrorEvent: ResponseErrorEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEventType$ { - /** @deprecated use `ResponseErrorEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; - /** @deprecated use `ResponseErrorEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; -} - -/** @internal */ -declare const ResponseErrorEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseErrorEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseErrorEventType: { - readonly ConversationResponseError: "conversation.response.error"; -}; - -declare type ResponseErrorEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - type Outbound = ResponseFormat$Outbound; -} - -/** @internal */ -declare const ResponseFormat$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -declare const ResponseFormat$outboundSchema: z.ZodType; - -declare type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -declare function responseFormatFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; -} - -/** @internal */ -declare const ResponseFormats$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseFormats$outboundSchema: z.ZodNativeEnum; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare const ResponseFormats: { - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; -}; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare type ResponseFormats = ClosedEnum; - -declare function responseFormatToJSON(responseFormat: ResponseFormat): string; - -declare type ResponseHook = (res: Response, req: Request) => Awaitable; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEvent$ { - /** @deprecated use `ResponseStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$Outbound` instead. */ - type Outbound = ResponseStartedEvent$Outbound; -} - -/** @internal */ -declare const ResponseStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - conversation_id: string; -}; - -/** @internal */ -declare const ResponseStartedEvent$outboundSchema: z.ZodType; - -declare type ResponseStartedEvent = { - type?: ResponseStartedEventType | undefined; - createdAt?: Date | undefined; - conversationId: string; -}; - -declare function responseStartedEventFromJSON(jsonString: string): Result; - -declare function responseStartedEventToJSON(responseStartedEvent: ResponseStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEventType$ { - /** @deprecated use `ResponseStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; - /** @deprecated use `ResponseStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; -} - -/** @internal */ -declare const ResponseStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseStartedEventType: { - readonly ConversationResponseStarted: "conversation.response.started"; -}; - -declare type ResponseStartedEventType = ClosedEnum; - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -declare type Result = { - ok: true; - value: T; - error?: never; -} | { - ok: false; - value?: never; - error: E; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveFileOut$ { - /** @deprecated use `RetrieveFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$Outbound` instead. */ - type Outbound = RetrieveFileOut$Outbound; -} - -/** @internal */ -declare const RetrieveFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; - deleted: boolean; -}; - -/** @internal */ -declare const RetrieveFileOut$outboundSchema: z.ZodType; - -declare type RetrieveFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; - deleted: boolean; -}; - -declare function retrieveFileOutFromJSON(jsonString: string): Result; - -declare function retrieveFileOutToJSON(retrieveFileOut: RetrieveFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetRequest$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetRequest$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$outboundSchema: z.ZodType; - -declare type RetrieveModelV1ModelsModelIdGetRequest = { - /** - * The ID of the model to retrieve. - */ - modelId: string; -}; - -declare function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest: RetrieveModelV1ModelsModelIdGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound = (components.FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (components.BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet = (components.FTModelCard & { - type: "fine-tuned"; -}) | (components.BaseModelCard & { - type: "base"; -}); - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet: RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet): string; - -declare type RetryConfig = { - strategy: "none"; -} | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; - /** @deprecated use `Role$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; -} - -/** @internal */ -declare const Role$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Role$outboundSchema: z.ZodNativeEnum; - -declare const Role: { - readonly System: "system"; -}; - -declare type Role = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SampleType$ { - /** @deprecated use `SampleType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SampleType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const SampleType$inboundSchema: z.ZodType; - -/** @internal */ -declare const SampleType$outboundSchema: z.ZodType; - -declare const SampleType: { - readonly Pretrain: "pretrain"; - readonly Instruct: "instruct"; - readonly BatchRequest: "batch_request"; - readonly BatchResult: "batch_result"; - readonly BatchError: "batch_error"; -}; - -declare type SampleType = OpenEnum; - -export declare const SDK_METADATA: { - readonly language: "typescript"; - readonly openapiDocVersion: "1.0.0"; - readonly sdkVersion: "1.10.0"; - readonly genVersion: "2.687.13"; - readonly userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai"; -}; - -declare class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[]; - beforeCreateRequestHooks: BeforeCreateRequestHook[]; - beforeRequestHooks: BeforeRequestHook_2[]; - afterSuccessHooks: AfterSuccessHook[]; - afterErrorHooks: AfterErrorHook[]; - constructor(); - registerSDKInitHook(hook: SDKInitHook): void; - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - registerAfterSuccessHook(hook: AfterSuccessHook): void; - registerAfterErrorHook(hook: AfterErrorHook): void; - sdkInit(opts: SDKInitOptions): SDKInitOptions; - beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput; - beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise; - afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise; - afterError(hookCtx: AfterErrorContext, response: Response | null, error: unknown): Promise<{ - response: Response | null; - error: unknown; - }>; -} - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -declare interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -declare type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export declare type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default user agent used by the SDK - */ - userAgent?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -declare class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - readonly rawValue: unknown; - /** - * The raw message that failed validation. - */ - readonly rawMessage: unknown; - static [Symbol.hasInstance](instance: unknown): instance is SDKValidationError; - constructor(message: string, cause: unknown, rawValue: unknown); - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty(): string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Security$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Security$Outbound` instead. */ - type Outbound = Security$Outbound; -} - -/** @internal */ -declare const Security$inboundSchema: z.ZodType; - -/** @internal */ -declare type Security$Outbound = { - ApiKey?: string | undefined; -}; - -/** @internal */ -declare const Security$outboundSchema: z.ZodType; - -declare type Security = { - apiKey?: string | undefined; -}; - -declare function securityFromJSON(jsonString: string): Result; - -declare type SecurityState = { - basic: { - username?: string | undefined; - password?: string | undefined; - }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ - type: "password"; - } & OAuth2PasswordFlow) | { - type: "none"; - }; -}; - -declare function securityToJSON(security: Security): string; - -/** - * EU Production server - */ -export declare const ServerEu = "eu"; - -declare type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - id?: string | undefined; - retry?: number | undefined; -}; - -/** - * Contains the list of servers available to the SDK - */ -export declare const ServerList: { - readonly eu: "https://api.mistral.ai"; -}; - -export declare function serverURLFromOptions(options: SDKOptions): URL | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShareEnum$ { - /** @deprecated use `ShareEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShareEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ShareEnum$inboundSchema: z.ZodType; - -/** @internal */ -declare const ShareEnum$outboundSchema: z.ZodType; - -declare const ShareEnum: { - readonly Viewer: "Viewer"; - readonly Editor: "Editor"; -}; - -declare type ShareEnum = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingDelete$ { - /** @deprecated use `SharingDelete$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$Outbound` instead. */ - type Outbound = SharingDelete$Outbound; -} - -/** @internal */ -declare const SharingDelete$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingDelete$Outbound = { - org_id: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingDelete$outboundSchema: z.ZodType; - -declare type SharingDelete = { - orgId: string; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingDeleteFromJSON(jsonString: string): Result; - -declare function sharingDeleteToJSON(sharingDelete: SharingDelete): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingIn$ { - /** @deprecated use `SharingIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingIn$Outbound` instead. */ - type Outbound = SharingIn$Outbound; -} - -/** @internal */ -declare const SharingIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingIn$Outbound = { - org_id: string; - level: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingIn$outboundSchema: z.ZodType; - -declare type SharingIn = { - orgId: string; - level: ShareEnum; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingInFromJSON(jsonString: string): Result; - -declare function sharingInToJSON(sharingIn: SharingIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingOut$ { - /** @deprecated use `SharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingOut$Outbound` instead. */ - type Outbound = SharingOut$Outbound; -} - -/** @internal */ -declare const SharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingOut$Outbound = { - library_id: string; - user_id?: string | null | undefined; - org_id: string; - role: string; - share_with_type: string; - share_with_uuid: string; -}; - -/** @internal */ -declare const SharingOut$outboundSchema: z.ZodType; - -declare type SharingOut = { - libraryId: string; - userId?: string | null | undefined; - orgId: string; - role: string; - shareWithType: string; - shareWithUuid: string; -}; - -declare function sharingOutFromJSON(jsonString: string): Result; - -declare function sharingOutToJSON(sharingOut: SharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Source$ { - /** @deprecated use `Source$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Source$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const Source$inboundSchema: z.ZodType; - -/** @internal */ -declare const Source$outboundSchema: z.ZodType; - -declare const Source: { - readonly Upload: "upload"; - readonly Repository: "repository"; - readonly Mistral: "mistral"; -}; - -declare type Source = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SSETypes$ { - /** @deprecated use `SSETypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `SSETypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const SSETypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const SSETypes$outboundSchema: z.ZodNativeEnum; - -/** - * Server side events sent when streaming a conversation response. - */ -declare const SSETypes: { - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; -}; - -/** - * Server side events sent when streaming a conversation response. - */ -declare type SSETypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$ { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$_2 { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const Status$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$inboundSchema_2: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema_2: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const Status: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type Status = ClosedEnum; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare const Status_2: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare type Status_2 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Stop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Stop$Outbound` instead. */ - type Outbound = Stop$Outbound; -} - -/** @internal */ -declare const Stop$inboundSchema: z.ZodType; - -/** @internal */ -declare type Stop$Outbound = string | Array; - -/** @internal */ -declare const Stop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type Stop = string | Array; - -declare function stopFromJSON(jsonString: string): Result; - -declare function stopToJSON(stop: Stop): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$Outbound` instead. */ - type Outbound = SystemMessage$Outbound; -} - -/** @internal */ -declare const SystemMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -declare const SystemMessage$outboundSchema: z.ZodType; - -declare type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - type Outbound = SystemMessageContent$Outbound; -} - -/** @internal */ -declare const SystemMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContent$Outbound = string | Array; - -/** @internal */ -declare const SystemMessageContent$outboundSchema: z.ZodType; - -declare type SystemMessageContent = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContentChunks$ { - /** @deprecated use `SystemMessageContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$Outbound` instead. */ - type Outbound = SystemMessageContentChunks$Outbound; -} - -/** @internal */ -declare const SystemMessageContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContentChunks$Outbound = (TextChunk$Outbound & { - type: "text"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}); - -/** @internal */ -declare const SystemMessageContentChunks$outboundSchema: z.ZodType; - -declare type SystemMessageContentChunks = (TextChunk & { - type: "text"; -}) | (ThinkChunk & { - type: "thinking"; -}); - -declare function systemMessageContentChunksFromJSON(jsonString: string): Result; - -declare function systemMessageContentChunksToJSON(systemMessageContentChunks: SystemMessageContentChunks): string; - -declare function systemMessageContentFromJSON(jsonString: string): Result; - -declare function systemMessageContentToJSON(systemMessageContent: SystemMessageContent): string; - -declare function systemMessageFromJSON(jsonString: string): Result; - -declare function systemMessageToJSON(systemMessage: SystemMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TextChunk$Outbound` instead. */ - type Outbound = TextChunk$Outbound; -} - -/** @internal */ -declare const TextChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -declare const TextChunk$outboundSchema: z.ZodType; - -declare type TextChunk = { - text: string; - type?: TextChunkType | undefined; -}; - -declare function textChunkFromJSON(jsonString: string): Result; - -declare function textChunkToJSON(textChunk: TextChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunkType$ { - /** @deprecated use `TextChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; - /** @deprecated use `TextChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; -} - -/** @internal */ -declare const TextChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TextChunkType$outboundSchema: z.ZodNativeEnum; - -declare const TextChunkType: { - readonly Text: "text"; -}; - -declare type TextChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunk$ { - /** @deprecated use `ThinkChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$Outbound` instead. */ - type Outbound = ThinkChunk$Outbound; -} - -/** @internal */ -declare const ThinkChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ThinkChunk$Outbound = { - thinking: Array; - closed?: boolean | undefined; - type: string; -}; - -/** @internal */ -declare const ThinkChunk$outboundSchema: z.ZodType; - -declare type ThinkChunk = { - thinking: Array; - /** - * Whether the thinking chunk is closed or not. Currently only used for prefixing. - */ - closed?: boolean | undefined; - type?: ThinkChunkType | undefined; -}; - -declare function thinkChunkFromJSON(jsonString: string): Result; - -declare function thinkChunkToJSON(thinkChunk: ThinkChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunkType$ { - /** @deprecated use `ThinkChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; - /** @deprecated use `ThinkChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; -} - -/** @internal */ -declare const ThinkChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ThinkChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ThinkChunkType: { - readonly Thinking: "thinking"; -}; - -declare type ThinkChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Thinking$ { - /** @deprecated use `Thinking$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Thinking$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Thinking$Outbound` instead. */ - type Outbound = Thinking$Outbound; -} - -/** @internal */ -declare const Thinking$inboundSchema: z.ZodType; - -/** @internal */ -declare type Thinking$Outbound = ReferenceChunk$Outbound | TextChunk$Outbound; - -/** @internal */ -declare const Thinking$outboundSchema: z.ZodType; - -declare type Thinking = ReferenceChunk | TextChunk; - -declare function thinkingFromJSON(jsonString: string): Result; - -declare function thinkingToJSON(thinking: Thinking): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimestampGranularity$ { - /** @deprecated use `TimestampGranularity$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; - /** @deprecated use `TimestampGranularity$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; -} - -/** @internal */ -declare const TimestampGranularity$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TimestampGranularity$outboundSchema: z.ZodNativeEnum; - -declare const TimestampGranularity: { - readonly Segment: "segment"; -}; - -declare type TimestampGranularity = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tool$Outbound` instead. */ - type Outbound = Tool$Outbound; -} - -/** @internal */ -declare const Tool$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const Tool$outboundSchema: z.ZodType; - -declare type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolCall$Outbound` instead. */ - type Outbound = ToolCall$Outbound; -} - -/** @internal */ -declare const ToolCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -declare const ToolCall$outboundSchema: z.ZodType; - -declare type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -declare function toolCallFromJSON(jsonString: string): Result; - -declare function toolCallToJSON(toolCall: ToolCall): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$Outbound` instead. */ - type Outbound = ToolChoice$Outbound; -} - -/** @internal */ -declare const ToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -declare const ToolChoice$outboundSchema: z.ZodType; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -declare type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; -} - -/** @internal */ -declare const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum; - -declare const ToolChoiceEnum: { - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; -}; - -declare type ToolChoiceEnum = ClosedEnum; - -declare function toolChoiceFromJSON(jsonString: string): Result; - -declare function toolChoiceToJSON(toolChoice: ToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEvent$ { - /** @deprecated use `ToolExecutionDeltaEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$Outbound` instead. */ - type Outbound = ToolExecutionDeltaEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDeltaEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDeltaEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionDeltaEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDeltaEvent = { - type?: ToolExecutionDeltaEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionDeltaEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent: ToolExecutionDeltaEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEventType$ { - /** @deprecated use `ToolExecutionDeltaEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; - /** @deprecated use `ToolExecutionDeltaEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; -} - -/** @internal */ -declare const ToolExecutionDeltaEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDeltaEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDeltaEventType: { - readonly ToolExecutionDelta: "tool.execution.delta"; -}; - -declare type ToolExecutionDeltaEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEvent$ { - /** @deprecated use `ToolExecutionDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$Outbound` instead. */ - type Outbound = ToolExecutionDoneEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionDoneEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDoneEvent = { - type?: ToolExecutionDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionDoneEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDoneEventToJSON(toolExecutionDoneEvent: ToolExecutionDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEventType$ { - /** @deprecated use `ToolExecutionDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; - /** @deprecated use `ToolExecutionDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; -} - -/** @internal */ -declare const ToolExecutionDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDoneEventType: { - readonly ToolExecutionDone: "tool.execution.done"; -}; - -declare type ToolExecutionDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntry$ { - /** @deprecated use `ToolExecutionEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$Outbound` instead. */ - type Outbound = ToolExecutionEntry$Outbound; -} - -/** @internal */ -declare const ToolExecutionEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - name: string; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionEntry$outboundSchema: z.ZodType; - -declare type ToolExecutionEntry = { - object?: ToolExecutionEntryObject | undefined; - type?: ToolExecutionEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - name: BuiltInConnectors; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryObject$ { - /** @deprecated use `ToolExecutionEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ToolExecutionEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryObject: { - readonly Entry: "entry"; -}; - -declare type ToolExecutionEntryObject = ClosedEnum; - -declare function toolExecutionEntryToJSON(toolExecutionEntry: ToolExecutionEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryType$ { - /** @deprecated use `ToolExecutionEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; - /** @deprecated use `ToolExecutionEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryType: { - readonly ToolExecution: "tool.execution"; -}; - -declare type ToolExecutionEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEvent$ { - /** @deprecated use `ToolExecutionStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$Outbound` instead. */ - type Outbound = ToolExecutionStartedEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionStartedEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionStartedEvent = { - type?: ToolExecutionStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionStartedEventFromJSON(jsonString: string): Result; - -declare function toolExecutionStartedEventToJSON(toolExecutionStartedEvent: ToolExecutionStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEventType$ { - /** @deprecated use `ToolExecutionStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; - /** @deprecated use `ToolExecutionStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; -} - -/** @internal */ -declare const ToolExecutionStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionStartedEventType: { - readonly ToolExecutionStarted: "tool.execution.started"; -}; - -declare type ToolExecutionStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunk$ { - /** @deprecated use `ToolFileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$Outbound` instead. */ - type Outbound = ToolFileChunk$Outbound; -} - -/** @internal */ -declare const ToolFileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolFileChunk$Outbound = { - type: string; - tool: string; - file_id: string; - file_name?: string | null | undefined; - file_type?: string | null | undefined; -}; - -/** @internal */ -declare const ToolFileChunk$outboundSchema: z.ZodType; - -declare type ToolFileChunk = { - type?: ToolFileChunkType | undefined; - tool: BuiltInConnectors; - fileId: string; - fileName?: string | null | undefined; - fileType?: string | null | undefined; -}; - -declare function toolFileChunkFromJSON(jsonString: string): Result; - -declare function toolFileChunkToJSON(toolFileChunk: ToolFileChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunkType$ { - /** @deprecated use `ToolFileChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; - /** @deprecated use `ToolFileChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; -} - -/** @internal */ -declare const ToolFileChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolFileChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolFileChunkType: { - readonly ToolFile: "tool_file"; -}; - -declare type ToolFileChunkType = ClosedEnum; - -declare function toolFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$Outbound` instead. */ - type Outbound = ToolMessage$Outbound; -} - -/** @internal */ -declare const ToolMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -declare const ToolMessage$outboundSchema: z.ZodType; - -declare type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - type Outbound = ToolMessageContent$Outbound; -} - -/** @internal */ -declare const ToolMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -declare const ToolMessageContent$outboundSchema: z.ZodType; - -declare type ToolMessageContent = string | Array; - -declare function toolMessageContentFromJSON(jsonString: string): Result; - -declare function toolMessageContentToJSON(toolMessageContent: ToolMessageContent): string; - -declare function toolMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; -} - -/** @internal */ -declare const ToolMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const ToolMessageRole: { - readonly Tool: "tool"; -}; - -declare type ToolMessageRole = ClosedEnum; - -declare function toolMessageToJSON(toolMessage: ToolMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunk$ { - /** @deprecated use `ToolReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$Outbound` instead. */ - type Outbound = ToolReferenceChunk$Outbound; -} - -/** @internal */ -declare const ToolReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolReferenceChunk$Outbound = { - type: string; - tool: string; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const ToolReferenceChunk$outboundSchema: z.ZodType; - -declare type ToolReferenceChunk = { - type?: ToolReferenceChunkType | undefined; - tool: BuiltInConnectors; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function toolReferenceChunkFromJSON(jsonString: string): Result; - -declare function toolReferenceChunkToJSON(toolReferenceChunk: ToolReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunkType$ { - /** @deprecated use `ToolReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; - /** @deprecated use `ToolReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; -} - -/** @internal */ -declare const ToolReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolReferenceChunkType: { - readonly ToolReference: "tool_reference"; -}; - -declare type ToolReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tools$ { - /** @deprecated use `Tools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tools$Outbound` instead. */ - type Outbound = Tools$Outbound; -} - -/** @internal */ -declare const Tools$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const Tools$outboundSchema: z.ZodType; - -declare type Tools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function toolsFromJSON(jsonString: string): Result; - -declare function toolsToJSON(tools: Tools): string; - -declare function toolToJSON(tool: Tool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ToolTypes$inboundSchema: z.ZodType; - -/** @internal */ -declare const ToolTypes$outboundSchema: z.ZodType; - -declare const ToolTypes: { - readonly Function: "function"; -}; - -declare type ToolTypes = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TrainingFile$ { - /** @deprecated use `TrainingFile$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$Outbound` instead. */ - type Outbound = TrainingFile$Outbound; -} - -/** @internal */ -declare const TrainingFile$inboundSchema: z.ZodType; - -/** @internal */ -declare type TrainingFile$Outbound = { - file_id: string; - weight: number; -}; - -/** @internal */ -declare const TrainingFile$outboundSchema: z.ZodType; - -declare type TrainingFile = { - fileId: string; - weight?: number | undefined; -}; - -declare function trainingFileFromJSON(jsonString: string): Result; - -declare function trainingFileToJSON(trainingFile: TrainingFile): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionResponse$ { - /** @deprecated use `TranscriptionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$Outbound` instead. */ - type Outbound = TranscriptionResponse$Outbound; -} - -/** @internal */ -declare const TranscriptionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionResponse$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionResponse$outboundSchema: z.ZodType; - -declare type TranscriptionResponse = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionResponseFromJSON(jsonString: string): Result; - -declare function transcriptionResponseToJSON(transcriptionResponse: TranscriptionResponse): string; - -declare class Transcriptions extends ClientSDK { - /** - * Create Transcription - */ - complete(request: components.AudioTranscriptionRequest, options?: RequestOptions): Promise; - /** - * Create streaming transcription (SSE) - */ - stream(request: components.AudioTranscriptionRequestStream, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionSegmentChunk$ { - /** @deprecated use `TranscriptionSegmentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$Outbound` instead. */ - type Outbound = TranscriptionSegmentChunk$Outbound; -} - -/** @internal */ -declare const TranscriptionSegmentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionSegmentChunk$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionSegmentChunk$outboundSchema: z.ZodType; - -declare type TranscriptionSegmentChunk = { - text: string; - start: number; - end: number; - type?: Type | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionSegmentChunkFromJSON(jsonString: string): Result; - -declare function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk: TranscriptionSegmentChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDone$ { - /** @deprecated use `TranscriptionStreamDone$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$Outbound` instead. */ - type Outbound = TranscriptionStreamDone$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamDone$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamDone$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - type: string; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamDone$outboundSchema: z.ZodType; - -declare type TranscriptionStreamDone = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - type?: TranscriptionStreamDoneType | undefined; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamDoneFromJSON(jsonString: string): Result; - -declare function transcriptionStreamDoneToJSON(transcriptionStreamDone: TranscriptionStreamDone): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDoneType$ { - /** @deprecated use `TranscriptionStreamDoneType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamDoneType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamDoneType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamDoneType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamDoneType: { - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamDoneType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEvents$ { - /** @deprecated use `TranscriptionStreamEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$Outbound` instead. */ - type Outbound = TranscriptionStreamEvents$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEvents$Outbound = { - event: string; - data: (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; - }); -}; - -/** @internal */ -declare const TranscriptionStreamEvents$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEvents = { - event: TranscriptionStreamEventTypes; - data: (TranscriptionStreamDone & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventsData$ { - /** @deprecated use `TranscriptionStreamEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$Outbound` instead. */ - type Outbound = TranscriptionStreamEventsData$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEventsData$Outbound = (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; -}); - -/** @internal */ -declare const TranscriptionStreamEventsData$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEventsData = (TranscriptionStreamDone & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; -}); - -declare function transcriptionStreamEventsDataFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData: TranscriptionStreamEventsData): string; - -declare function transcriptionStreamEventsFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsToJSON(transcriptionStreamEvents: TranscriptionStreamEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventTypes$ { - /** @deprecated use `TranscriptionStreamEventTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamEventTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamEventTypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamEventTypes$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamEventTypes: { - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamEventTypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguage$ { - /** @deprecated use `TranscriptionStreamLanguage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$Outbound` instead. */ - type Outbound = TranscriptionStreamLanguage$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamLanguage$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamLanguage$Outbound = { - type: string; - audio_language: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamLanguage$outboundSchema: z.ZodType; - -declare type TranscriptionStreamLanguage = { - type?: TranscriptionStreamLanguageType | undefined; - audioLanguage: string; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamLanguageFromJSON(jsonString: string): Result; - -declare function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage: TranscriptionStreamLanguage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguageType$ { - /** @deprecated use `TranscriptionStreamLanguageType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; - /** @deprecated use `TranscriptionStreamLanguageType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamLanguageType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamLanguageType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamLanguageType: { - readonly TranscriptionLanguage: "transcription.language"; -}; - -declare type TranscriptionStreamLanguageType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDelta$ { - /** @deprecated use `TranscriptionStreamSegmentDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamSegmentDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamSegmentDelta$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamSegmentDelta = { - text: string; - start: number; - end: number; - type?: TranscriptionStreamSegmentDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamSegmentDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta: TranscriptionStreamSegmentDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDeltaType$ { - /** @deprecated use `TranscriptionStreamSegmentDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; - /** @deprecated use `TranscriptionStreamSegmentDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamSegmentDeltaType: { - readonly TranscriptionSegment: "transcription.segment"; -}; - -declare type TranscriptionStreamSegmentDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDelta$ { - /** @deprecated use `TranscriptionStreamTextDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamTextDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamTextDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamTextDelta$Outbound = { - text: string; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamTextDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamTextDelta = { - text: string; - type?: TranscriptionStreamTextDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamTextDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta: TranscriptionStreamTextDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDeltaType$ { - /** @deprecated use `TranscriptionStreamTextDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; - /** @deprecated use `TranscriptionStreamTextDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamTextDeltaType: { - readonly TranscriptionTextDelta: "transcription.text.delta"; -}; - -declare type TranscriptionStreamTextDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Two$ { - /** @deprecated use `Two$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Two$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Two$Outbound` instead. */ - type Outbound = Two$Outbound; -} - -/** @internal */ -declare const Two$inboundSchema: z.ZodType; - -/** @internal */ -declare type Two$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Two$outboundSchema: z.ZodType; - -declare type Two = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function twoFromJSON(jsonString: string): Result; - -declare function twoToJSON(two: Two): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; - /** @deprecated use `Type$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; -} - -/** @internal */ -declare const Type$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Type$outboundSchema: z.ZodNativeEnum; - -declare const Type: { - readonly TranscriptionSegment: "transcription_segment"; -}; - -declare type Type = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOut$ { - /** @deprecated use `UnarchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$Outbound` instead. */ - type Outbound = UnarchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const UnarchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UnarchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const UnarchiveFTModelOut$outboundSchema: z.ZodType; - -declare type UnarchiveFTModelOut = { - id: string; - object?: UnarchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function unarchiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOutObject$ { - /** @deprecated use `UnarchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `UnarchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const UnarchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UnarchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const UnarchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type UnarchiveFTModelOutObject = ClosedEnum; - -declare function unarchiveFTModelOutToJSON(unarchiveFTModelOut: UnarchiveFTModelOut): string; - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -declare class UnexpectedClientError extends HTTPClientError { - name: string; -} - -declare type Unrecognized = T & { - [__brand]: "unrecognized"; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateFTModelIn$ { - /** @deprecated use `UpdateFTModelIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$Outbound` instead. */ - type Outbound = UpdateFTModelIn$Outbound; -} - -/** @internal */ -declare const UpdateFTModelIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateFTModelIn$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const UpdateFTModelIn$outboundSchema: z.ZodType; - -declare type UpdateFTModelIn = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function updateFTModelInFromJSON(jsonString: string): Result; - -declare function updateFTModelInToJSON(updateFTModelIn: UpdateFTModelIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadFileOut$ { - /** @deprecated use `UploadFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$Outbound` instead. */ - type Outbound = UploadFileOut$Outbound; -} - -/** @internal */ -declare const UploadFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const UploadFileOut$outboundSchema: z.ZodType; - -declare type UploadFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function uploadFileOutFromJSON(jsonString: string): Result; - -declare function uploadFileOutToJSON(uploadFileOut: UploadFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$Outbound` instead. */ - type Outbound = UsageInfo$Outbound; -} - -/** @internal */ -declare const UsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - prompt_audio_seconds?: number | null | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const UsageInfo$outboundSchema: z.ZodType; - -declare type UsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - promptAudioSeconds?: number | null | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function usageInfoFromJSON(jsonString: string): Result; - -declare function usageInfoToJSON(usageInfo: UsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessage$Outbound` instead. */ - type Outbound = UserMessage$Outbound; -} - -/** @internal */ -declare const UserMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -declare const UserMessage$outboundSchema: z.ZodType; - -declare type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - type Outbound = UserMessageContent$Outbound; -} - -/** @internal */ -declare const UserMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessageContent$Outbound = string | Array; - -/** @internal */ -declare const UserMessageContent$outboundSchema: z.ZodType; - -declare type UserMessageContent = string | Array; - -declare function userMessageContentFromJSON(jsonString: string): Result; - -declare function userMessageContentToJSON(userMessageContent: UserMessageContent): string; - -declare function userMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; -} - -/** @internal */ -declare const UserMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UserMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const UserMessageRole: { - readonly User: "user"; -}; - -declare type UserMessageRole = ClosedEnum; - -declare function userMessageToJSON(userMessage: UserMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ValidationError$Outbound` instead. */ - type Outbound = ValidationError$Outbound; -} - -/** @internal */ -declare const ValidationError$inboundSchema: z.ZodType; - -/** @internal */ -declare type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -declare const ValidationError$outboundSchema: z.ZodType; - -declare type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -declare function validationErrorFromJSON(jsonString: string): Result; - -declare function validationErrorToJSON(validationError: ValidationError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegration$ { - /** @deprecated use `WandbIntegration$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$Outbound` instead. */ - type Outbound = WandbIntegration$Outbound; -} - -/** @internal */ -declare const WandbIntegration$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegration$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - api_key: string; - run_name?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegration$outboundSchema: z.ZodType; - -declare type WandbIntegration = { - type?: WandbIntegrationType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - /** - * The WandB API key to use for authentication. - */ - apiKey: string; - runName?: string | null | undefined; -}; - -declare function wandbIntegrationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOut$ { - /** @deprecated use `WandbIntegrationOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$Outbound` instead. */ - type Outbound = WandbIntegrationOut$Outbound; -} - -/** @internal */ -declare const WandbIntegrationOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegrationOut$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - run_name?: string | null | undefined; - url?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegrationOut$outboundSchema: z.ZodType; - -declare type WandbIntegrationOut = { - type?: WandbIntegrationOutType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - runName?: string | null | undefined; - url?: string | null | undefined; -}; - -declare function wandbIntegrationOutFromJSON(jsonString: string): Result; - -declare function wandbIntegrationOutToJSON(wandbIntegrationOut: WandbIntegrationOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOutType$ { - /** @deprecated use `WandbIntegrationOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationOutType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationOutType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationOutType = ClosedEnum; - -declare function wandbIntegrationToJSON(wandbIntegration: WandbIntegration): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationType$ { - /** @deprecated use `WandbIntegrationType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumTool$ { - /** @deprecated use `WebSearchPremiumTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$Outbound` instead. */ - type Outbound = WebSearchPremiumTool$Outbound; -} - -/** @internal */ -declare const WebSearchPremiumTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchPremiumTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchPremiumTool$outboundSchema: z.ZodType; - -declare type WebSearchPremiumTool = { - type?: WebSearchPremiumToolType | undefined; -}; - -declare function webSearchPremiumToolFromJSON(jsonString: string): Result; - -declare function webSearchPremiumToolToJSON(webSearchPremiumTool: WebSearchPremiumTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumToolType$ { - /** @deprecated use `WebSearchPremiumToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; - /** @deprecated use `WebSearchPremiumToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; -} - -/** @internal */ -declare const WebSearchPremiumToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchPremiumToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchPremiumToolType: { - readonly WebSearchPremium: "web_search_premium"; -}; - -declare type WebSearchPremiumToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchTool$ { - /** @deprecated use `WebSearchTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$Outbound` instead. */ - type Outbound = WebSearchTool$Outbound; -} - -/** @internal */ -declare const WebSearchTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchTool$outboundSchema: z.ZodType; - -declare type WebSearchTool = { - type?: WebSearchToolType | undefined; -}; - -declare function webSearchToolFromJSON(jsonString: string): Result; - -declare function webSearchToolToJSON(webSearchTool: WebSearchTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchToolType$ { - /** @deprecated use `WebSearchToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; - /** @deprecated use `WebSearchToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; -} - -/** @internal */ -declare const WebSearchToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchToolType: { - readonly WebSearch: "web_search"; -}; - -declare type WebSearchToolType = ClosedEnum; - -export { } diff --git a/examples/docusaurus/sidebars.ts b/examples/docusaurus/sidebars.ts deleted file mode 100644 index 574ed394c..000000000 --- a/examples/docusaurus/sidebars.ts +++ /dev/null @@ -1,33 +0,0 @@ -import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; - -// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) - -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ -const sidebars: SidebarsConfig = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{ type: "autogenerated", dirName: "." }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ -}; - -export default sidebars; diff --git a/examples/docusaurus/speakeasy.glean.config.mjs b/examples/docusaurus/speakeasy.glean.config.mjs deleted file mode 100644 index 42666f86c..000000000 --- a/examples/docusaurus/speakeasy.glean.config.mjs +++ /dev/null @@ -1,24 +0,0 @@ -export default { - spec: "../specs/glean.yaml", - output: { - pageOutDir: "./docs/glean/api", - embedOutDir: "./src/components/glean-embeds", - framework: "docusaurus", - }, - display: { - maxNestingLevel: 2, - }, - codeSamples: [ - { - language: "typescript", - sdkTarballPath: "../sdks/glean-typescript.tar.gz", - tryItNow: { - outDir: "./public/glean-try-it-now", - urlPrefix: "/glean-try-it-now", - }, - }, - { - language: "curl", - }, - ], -}; diff --git a/examples/docusaurus/speakeasy.mistral.config.mjs b/examples/docusaurus/speakeasy.mistral.config.mjs deleted file mode 100644 index 1c127685f..000000000 --- a/examples/docusaurus/speakeasy.mistral.config.mjs +++ /dev/null @@ -1,32 +0,0 @@ -export default { - spec: "../specs/mistral.yaml", - output: { - pageOutDir: "./docs/mistral/api", - framework: "docusaurus", - }, - display: { - showDebugPlaceholders: true, - }, - codeSamples: [ - { - language: "typescript", - sdkTarballPath: "../sdks/mistral-typescript.tar.gz", - tryItNow: { - outDir: "./public/mistral-try-it-now", - urlPrefix: "/mistral-try-it-now", - }, - }, - { - language: "python", - sdkTarballPath: "../sdks/mistral-python.tar.gz", - tryItNow: { - outDir: "./public/mistral-try-it-now", - urlPrefix: "/mistral-try-it-now", - }, - }, - { - language: "curl", - tryItNow: true, - }, - ], -}; diff --git a/examples/docusaurus/speakeasy.pokeapi.config.mjs b/examples/docusaurus/speakeasy.pokeapi.config.mjs deleted file mode 100644 index 2e770ea71..000000000 --- a/examples/docusaurus/speakeasy.pokeapi.config.mjs +++ /dev/null @@ -1,7 +0,0 @@ -export default { - spec: "../specs/pokeapi.yml", - output: { - pageOutDir: "./docs/pokeapi/api", - framework: "docusaurus", - }, -}; diff --git a/examples/docusaurus/src/components/HomepageFeatures/index.tsx b/examples/docusaurus/src/components/HomepageFeatures/index.tsx deleted file mode 100644 index b64f2495d..000000000 --- a/examples/docusaurus/src/components/HomepageFeatures/index.tsx +++ /dev/null @@ -1,37 +0,0 @@ -import type { ReactNode } from "react"; -import clsx from "clsx"; -import Heading from "@theme/Heading"; -import styles from "./styles.module.css"; - -type FeatureItem = { - title: string; - Svg: React.ComponentType>; - description: ReactNode; -}; - -const FeatureList: FeatureItem[] = []; - -function Feature({ title, Svg, description }: FeatureItem) { - return ( -
    -
    - {title} -

    {description}

    -
    -
    - ); -} - -export default function HomepageFeatures(): ReactNode { - return ( -
    -
    -
    - {FeatureList.map((props, idx) => ( - - ))} -
    -
    -
    - ); -} diff --git a/examples/docusaurus/src/components/HomepageFeatures/styles.module.css b/examples/docusaurus/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index 2132b3d12..000000000 --- a/examples/docusaurus/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,6 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} diff --git a/examples/docusaurus/src/components/glean-embeds/contents/action.mdx b/examples/docusaurus/src/components/glean-embeds/contents/action.mdx deleted file mode 100644 index 8f77eb479..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/action.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparameters from "../loaders/parameters.tsx"; - - - -ToolInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### action \{#embed-action+action\} - - - - - - - - - -#### ToolInfo \{#embed-action+action+toolinfo\} - - - - - -ToolMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-action+action+toolinfo+metadata\} - - - - - -The manifest for a tool that can be used to augment Glean Assistant. - - - - - - - - - - - - - - - - - - - -WriteActionParameter","children":[{"label":"WriteActionParameter","linkedLabel":"WriteActionParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parameters \{#embed-action+action+toolinfo+parameters\} - - - - - -Parameters supported by the tool. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/actioncounts.mdx b/examples/docusaurus/src/components/glean-embeds/contents/actioncounts.mdx deleted file mode 100644 index 83da80b5f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/actioncounts.mdx +++ /dev/null @@ -1,242 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -AiAppActionCounts","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### actionCounts \{#embed-actioncounts+actioncounts\} - - - - - -Map from action to frequency. - - - - - - - - - -#### AiAppActionCounts \{#embed-actioncounts+actioncounts+aiappactioncounts\} - - - - - -Map from action to frequency. - - - - - - - - - -##### AdditionalProperties \{#embed-actioncounts+actioncounts+aiappactioncounts+additionalproperties\} - - - - - - - - - -##### totalChatMessages \{#embed-actioncounts+actioncounts+aiappactioncounts+totalchatmessages\} - - - - - -Total number of Chat messages sent in requested period. - - - - - - - - - -##### totalDownvotes \{#embed-actioncounts+actioncounts+aiappactioncounts+totaldownvotes\} - - - - - -Total number of Chat messages which received downvotes by the user. - - - - - - - - - -##### totalSlackbotResponses \{#embed-actioncounts+actioncounts+aiappactioncounts+totalslackbotresponses\} - - - - - -Total number of Slackbot responses, both proactive and reactive. - - - - - - - - - -##### totalSlackbotResponsesNotHelpful \{#embed-actioncounts+actioncounts+aiappactioncounts+totalslackbotresponsesnothelpful\} - - - - - -Total number of Slackbot responses rejected as not helpful (downvoted). - - - - - - - - - -##### totalSlackbotResponsesShared \{#embed-actioncounts+actioncounts+aiappactioncounts+totalslackbotresponsesshared\} - - - - - -Total number of Slackbot responses shared publicly (upvoted). - - - - - - - - - -##### totalUpvotes \{#embed-actioncounts+actioncounts+aiappactioncounts+totalupvotes\} - - - - - -Total number of Chat messages which received upvotes by the user. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/activedaycount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/activedaycount.mdx deleted file mode 100644 index 694590ae0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/activedaycount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### activeDayCount \{#embed-activedaycount+activedaycount\} - - - - - - - - - -#### CountInfo \{#embed-activedaycount+activedaycount+countinfo\} - - - - - - - - - -##### count \{#embed-activedaycount+activedaycount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-activedaycount+activedaycount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-activedaycount+activedaycount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/activities.mdx b/examples/docusaurus/src/components/glean-embeds/contents/activities.mdx deleted file mode 100644 index 3c761170e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/activities.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactor from "../loaders/actor.tsx"; -import Embedaggregatevisitcount from "../loaders/aggregatevisitcount.tsx"; - - - -UserActivity","children":[{"label":"UserActivity","linkedLabel":"UserActivity","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### activities \{#embed-activities+activities\} - - - - - -List of activity where each activity has user, action, timestamp. - - - - - - - - - -#### UserActivity \{#embed-activities+activities+useractivity\} - - - - - - - - - -##### action \{#embed-activities+activities+useractivity+action\} - - - - - -The action for the activity - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### actor \{#embed-activities+activities+useractivity+actor\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### aggregateVisitCount \{#embed-activities+activities+useractivity+aggregatevisitcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### timestamp \{#embed-activities+activities+useractivity+timestamp\} - - - - - -Unix timestamp of the activity (in seconds since epoch UTC). - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/activitycount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/activitycount.mdx deleted file mode 100644 index ee56b84f8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/activitycount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### activityCount \{#embed-activitycount+activitycount\} - - - - - - - - - -#### CountInfo \{#embed-activitycount+activitycount+countinfo\} - - - - - - - - - -##### count \{#embed-activitycount+activitycount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-activitycount+activitycount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-activitycount+activitycount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/activityinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/activityinsights.mdx deleted file mode 100644 index 5e2d90875..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/activityinsights.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivedaycount from "../loaders/activedaycount.tsx"; -import Embedactivitycount from "../loaders/activitycount.tsx"; -import Embeduser from "../loaders/user.tsx"; - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### activityInsights \{#embed-activityinsights+activityinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - -#### UserActivityInsight \{#embed-activityinsights+activityinsights+useractivityinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activeDayCount \{#embed-activityinsights+activityinsights+useractivityinsight+activedaycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### activity \{#embed-activityinsights+activityinsights+useractivityinsight+activity\} - - - - - -Activity e.g. search, home page visit or all. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityCount \{#embed-activityinsights+activityinsights+useractivityinsight+activitycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastActivityTimestamp \{#embed-activityinsights+activityinsights+useractivityinsight+lastactivitytimestamp\} - - - - - -Unix timestamp of the last activity (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### user \{#embed-activityinsights+activityinsights+useractivityinsight+user\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/actor.mdx b/examples/docusaurus/src/components/glean-embeds/contents/actor.mdx deleted file mode 100644 index 746c916b7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/actor.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### actor \{#embed-actor+actor\} - - - - - - - - - -#### Person \{#embed-actor+actor+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-actor+actor+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-actor+actor+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-actor+actor+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-actor+actor+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/addedroles.mdx b/examples/docusaurus/src/components/glean-embeds/contents/addedroles.mdx deleted file mode 100644 index 3b351cd74..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/addedroles.mdx +++ /dev/null @@ -1,180 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedgroup from "../loaders/group.tsx"; -import Embedperson from "../loaders/person.tsx"; - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### addedRoles \{#embed-addedroles+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#embed-addedroles+addedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#embed-addedroles+addedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-addedroles+addedroles+userrolespecification+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#embed-addedroles+addedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#embed-addedroles+addedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/additionalfields.mdx b/examples/docusaurus/src/components/glean-embeds/contents/additionalfields.mdx deleted file mode 100644 index e910c78b1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/additionalfields.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalue from "../loaders/value.tsx"; - - - -AdditionalFieldDefinition","children":[{"label":"AdditionalFieldDefinition","linkedLabel":"AdditionalFieldDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### additionalFields \{#embed-additionalfields+additionalfields\} - - - - - -List of additional fields with more information about the employee. - - - - - - - - - -#### AdditionalFieldDefinition \{#embed-additionalfields+additionalfields+additionalfielddefinition\} - - - - - -Additional information about the employee or team. - - - - - - - - - -##### key \{#embed-additionalfields+additionalfields+additionalfielddefinition+key\} - - - - - -Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores. - - - - - -value","children":[{"label":"value","linkedLabel":"value","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### value \{#embed-additionalfields+additionalfields+additionalfielddefinition+value\} - - - - - -List of type string or HypertextField. - -HypertextField is defined as -``` -\{ - anchor: string, // Anchor text for the hypertext field. - hyperlink: string, // URL for the hypertext field. -\} -``` -Example: ```\{"anchor":"Glean","hyperlink":"https://glean.com"\}``` - -When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs. - -**Note**: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored. -Example: ```"languages": [\{"lang":"English","lang":"Spanish",...\}]```. In this case, the key "lang" will be ignored and can even be passed in as an empty string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/additionalquerysuggestions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/additionalquerysuggestions.mdx deleted file mode 100644 index 2572d9663..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/additionalquerysuggestions.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperson from "../loaders/person.tsx"; -import Embedsuggestions from "../loaders/suggestions.tsx"; - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### additionalQuerySuggestions \{#embed-additionalquerysuggestions+additionalquerysuggestions\} - - - - - - - - - -#### QuerySuggestionList \{#embed-additionalquerysuggestions+additionalquerysuggestions+querysuggestionlist\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-additionalquerysuggestions+additionalquerysuggestions+querysuggestionlist+person\} - - - - - - - - - - - - - - - - - - - -QuerySuggestion","children":[{"label":"QuerySuggestion","linkedLabel":"QuerySuggestion","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### suggestions \{#embed-additionalquerysuggestions+additionalquerysuggestions+querysuggestionlist+suggestions\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/agentconfig.mdx b/examples/docusaurus/src/components/glean-embeds/contents/agentconfig.mdx deleted file mode 100644 index 978da27ea..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/agentconfig.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -AgentConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### agentConfig \{#embed-agentconfig+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -#### AgentConfig \{#embed-agentconfig+agentconfig+agentconfig\} - - - - - -Describes the agent that executes the request. - - - - - - - - - -##### agent \{#embed-agentconfig+agentconfig+agentconfig+agent\} - - - - - -Name of the agent. - - - - - - - - - -##### mode \{#embed-agentconfig+agentconfig+agentconfig+mode\} - - - - - -Top level modes to run GleanChat in. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/aggregatevisitcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/aggregatevisitcount.mdx deleted file mode 100644 index c0e48f168..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/aggregatevisitcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### aggregateVisitCount \{#embed-aggregatevisitcount+aggregatevisitcount\} - - - - - - - - - -#### CountInfo \{#embed-aggregatevisitcount+aggregatevisitcount+countinfo\} - - - - - - - - - -##### count \{#embed-aggregatevisitcount+aggregatevisitcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-aggregatevisitcount+aggregatevisitcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-aggregatevisitcount+aggregatevisitcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/aiappinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/aiappinsights.mdx deleted file mode 100644 index 4a104a759..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/aiappinsights.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivedaycount from "../loaders/activedaycount.tsx"; -import Embedactivitycount from "../loaders/activitycount.tsx"; -import Embeduser from "../loaders/user.tsx"; - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### aiAppInsights \{#embed-aiappinsights+aiappinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - -#### UserActivityInsight \{#embed-aiappinsights+aiappinsights+useractivityinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activeDayCount \{#embed-aiappinsights+aiappinsights+useractivityinsight+activedaycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### activity \{#embed-aiappinsights+aiappinsights+useractivityinsight+activity\} - - - - - -Activity e.g. search, home page visit or all. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityCount \{#embed-aiappinsights+aiappinsights+useractivityinsight+activitycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastActivityTimestamp \{#embed-aiappinsights+aiappinsights+useractivityinsight+lastactivitytimestamp\} - - - - - -Unix timestamp of the last activity (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### user \{#embed-aiappinsights+aiappinsights+useractivityinsight+user\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/allclusteredresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/allclusteredresults.mdx deleted file mode 100644 index c8f254812..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/allclusteredresults.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedclusteredresults from "../loaders/clusteredresults.tsx"; - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### allClusteredResults \{#embed-allclusteredresults+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - -#### ClusterGroup \{#embed-allclusteredresults+allclusteredresults+clustergroup\} - - - - - - - - - -##### clusterType \{#embed-allclusteredresults+allclusteredresults+clustergroup+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#embed-allclusteredresults+allclusteredresults+clustergroup+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### visibleCountHint \{#embed-allclusteredresults+allclusteredresults+clustergroup+visiblecounthint\} - - - - - -The default number of results to display before truncating and showing a "see more" link - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/allowedgroupintersections.mdx b/examples/docusaurus/src/components/glean-embeds/contents/allowedgroupintersections.mdx deleted file mode 100644 index 936f1f2ba..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/allowedgroupintersections.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -PermissionsGroupIntersectionDefinition","children":[{"label":"PermissionsGroupIntersectionDefinition","linkedLabel":"PermissionsGroupIntersectionDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### allowedGroupIntersections \{#embed-allowedgroupintersections+allowedgroupintersections\} - - - - - -List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - - - - - - - - - -#### PermissionsGroupIntersectionDefinition \{#embed-allowedgroupintersections+allowedgroupintersections+permissionsgroupintersectiondefinition\} - - - - - -describes a list of groups that are all required in a permissions constraint - - - - - - - - - -##### requiredGroups \{#embed-allowedgroupintersections+allowedgroupintersections+permissionsgroupintersectiondefinition+requiredgroups\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/allowedusers.mdx b/examples/docusaurus/src/components/glean-embeds/contents/allowedusers.mdx deleted file mode 100644 index c0f4bc899..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/allowedusers.mdx +++ /dev/null @@ -1,136 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -UserReferenceDefinition","children":[{"label":"UserReferenceDefinition","linkedLabel":"UserReferenceDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### allowedUsers \{#embed-allowedusers+allowedusers\} - - - - - -List of users who can view the document - - - - - - - - - -#### UserReferenceDefinition \{#embed-allowedusers+allowedusers+userreferencedefinition\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - -##### datasourceUserId \{#embed-allowedusers+allowedusers+userreferencedefinition+datasourceuserid\} - - - - - -some datasources refer to the user by the datasource user id in the document - - - - - - - - - -##### email \{#embed-allowedusers+allowedusers+userreferencedefinition+email\} - - - - - - - - - -##### name \{#embed-allowedusers+allowedusers+userreferencedefinition+name\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/allowlistoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/allowlistoptions.mdx deleted file mode 100644 index 711ad9809..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/allowlistoptions.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -AllowlistOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### allowlistOptions \{#embed-allowlistoptions+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - -#### AllowlistOptions \{#embed-allowlistoptions+allowlistoptions+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - -##### terms \{#embed-allowlistoptions+allowlistoptions+allowlistoptions+terms\} - - - - - -list of words and phrases to consider as whitelisted content - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/announcement.mdx b/examples/docusaurus/src/components/glean-embeds/contents/announcement.mdx deleted file mode 100644 index 8f454f364..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/announcement.mdx +++ /dev/null @@ -1,757 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedauthor from "../loaders/author.tsx"; -import Embedbanner from "../loaders/banner.tsx"; -import Embedbody from "../loaders/body.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedsourcedocument from "../loaders/sourcedocument.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; -import Embedviewerinfo from "../loaders/viewerinfo.tsx"; - - - -Announcement","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### announcement \{#embed-announcement+announcement\} - - - - - - - - - -#### Announcement \{#embed-announcement+announcement+announcement\} - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-announcement+announcement+announcement+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#embed-announcement+announcement+announcement+author\} - - - - - - - - - - - - - - - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### banner \{#embed-announcement+announcement+announcement+banner\} - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### body \{#embed-announcement+announcement+announcement+body\} - - - - - - - - - - - - - - - - - - - - - - - -##### channel \{#embed-announcement+announcement+announcement+channel\} - - - - - -This determines whether this is a Social Feed post or a regular announcement. - - - - - - - - - -##### createTimestamp \{#embed-announcement+announcement+announcement+createtimestamp\} - - - - - -Server Unix timestamp of the creation time (in seconds since epoch UTC). - - - - - - - - - -##### draftId \{#embed-announcement+announcement+announcement+draftid\} - - - - - -The opaque id of the associated draft. - - - - - - - - - -##### emoji \{#embed-announcement+announcement+announcement+emoji\} - - - - - -An emoji used to indicate the nature of the announcement. - - - - - - - - - -##### endTime \{#embed-announcement+announcement+announcement+endtime\} - - - - - -The date and time at which the announcement expires. - - - - - - - - - -##### hideAttribution \{#embed-announcement+announcement+announcement+hideattribution\} - - - - - -Whether or not to hide an author attribution. - - - - - - - - - -##### id \{#embed-announcement+announcement+announcement+id\} - - - - - -The opaque id of the announcement. - - - - - - - - - -##### isPrioritized \{#embed-announcement+announcement+announcement+isprioritized\} - - - - - -Used by the Social Feed to pin posts to the front of the feed. - - - - - - - - - -##### isPublished \{#embed-announcement+announcement+announcement+ispublished\} - - - - - -Whether or not the announcement is published. - - - - - - - - - -##### lastUpdateTimestamp \{#embed-announcement+announcement+announcement+lastupdatetimestamp\} - - - - - -Server Unix timestamp of the last update time (in seconds since epoch UTC). - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-announcement+announcement+announcement+permissions\} - - - - - - - - - - - - - - - - - - - - - - - -##### postType \{#embed-announcement+announcement+announcement+posttype\} - - - - - -This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceDocument \{#embed-announcement+announcement+announcement+sourcedocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### sourceDocumentId \{#embed-announcement+announcement+announcement+sourcedocumentid\} - - - - - -The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - - - - - - - - - -##### startTime \{#embed-announcement+announcement+announcement+starttime\} - - - - - -The date and time at which the announcement becomes active. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-announcement+announcement+announcement+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-announcement+announcement+announcement+title\} - - - - - -The headline of the announcement. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-announcement+announcement+announcement+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### viewUrl \{#embed-announcement+announcement+announcement+viewurl\} - - - - - -URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - - - - - -viewerInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### viewerInfo \{#embed-announcement+announcement+announcement+viewerinfo\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/answer.mdx b/examples/docusaurus/src/components/glean-embeds/contents/answer.mdx deleted file mode 100644 index dfe731614..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/answer.mdx +++ /dev/null @@ -1,852 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../loaders/addedroles.tsx"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedauthor from "../loaders/author.tsx"; -import Embedboard from "../loaders/board.tsx"; -import Embedcollections from "../loaders/collections.tsx"; -import Embedcombinedanswertext from "../loaders/combinedanswertext.tsx"; -import Embedlikes from "../loaders/likes.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedsourcedocument from "../loaders/sourcedocument.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; -import Embedverification from "../loaders/verification.tsx"; - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answer \{#embed-answer+answer\} - - - - - - - - - -#### Answer \{#embed-answer+answer+answer\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-answer+answer+answer+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-answer+answer+answer+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#embed-answer+answer+answer+author\} - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### board \{#embed-answer+answer+answer+board\} - - - - - - - - - - - - - - - - - - - - - - - -##### boardId \{#embed-answer+answer+answer+boardid\} - - - - - -The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - - - - - - - - - -##### bodyText \{#embed-answer+answer+answer+bodytext\} - - - - - -The plain text answer to the question. - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collections \{#embed-answer+answer+answer+collections\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### combinedAnswerText \{#embed-answer+answer+answer+combinedanswertext\} - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-answer+answer+answer+createtime\} - - - - - -The time the answer was created in ISO format (ISO 8601). - - - - - - - - - -##### docId \{#embed-answer+answer+answer+docid\} - - - - - -Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - - - - - -_Example:_ - -``` -ANSWERS_answer_3 -``` - - - - - - - - - -##### documentCategory \{#embed-answer+answer+answer+documentcategory\} - - - - - -The document's document_category(.proto). - - - - - - - - - -##### id \{#embed-answer+answer+answer+id\} - - - - - -The opaque ID of the Answer. - - - - - -_Example:_ - -``` -3 -``` - - - - - -AnswerLikes","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### likes \{#embed-answer+answer+answer+likes\} - - - - - - - - - - - - - - - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-answer+answer+answer+permissions\} - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#embed-answer+answer+answer+question\} - - - - - -_Example:_ - -``` -Why is the sky blue? -``` - - - - - - - - - -##### questionVariations \{#embed-answer+answer+answer+questionvariations\} - - - - - -Additional ways of phrasing this question. - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-answer+answer+answer+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-answer+answer+answer+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceDocument \{#embed-answer+answer+answer+sourcedocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### sourceDocumentSpec \{#embed-answer+answer+answer+sourcedocumentspec\} - - - - - - - - - -##### sourceType \{#embed-answer+answer+answer+sourcetype\} - - - - - - - - - -##### updateTime \{#embed-answer+answer+answer+updatetime\} - - - - - -The time the answer was last updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-answer+answer+answer+updatedby\} - - - - - - - - - - - - - - - - - - - -Verification","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### verification \{#embed-answer+answer+answer+verification\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/answerauthor.mdx b/examples/docusaurus/src/components/glean-embeds/contents/answerauthor.mdx deleted file mode 100644 index de2fb7146..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/answerauthor.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answerAuthor \{#embed-answerauthor+answerauthor\} - - - - - - - - - -#### Person \{#embed-answerauthor+answerauthor+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-answerauthor+answerauthor+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-answerauthor+answerauthor+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-answerauthor+answerauthor+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-answerauthor+answerauthor+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/answerboard.mdx b/examples/docusaurus/src/components/glean-embeds/contents/answerboard.mdx deleted file mode 100644 index 70376479f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/answerboard.mdx +++ /dev/null @@ -1,459 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedcreator from "../loaders/creator.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### answerBoard \{#embed-answerboard+answerboard\} - - - - - - - - - -#### AnswerBoard \{#embed-answerboard+answerboard+answerboard\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-answerboard+answerboard+answerboard+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-answerboard+answerboard+answerboard+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-answerboard+answerboard+answerboard+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#embed-answerboard+answerboard+answerboard+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-answerboard+answerboard+answerboard+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### id \{#embed-answerboard+answerboard+answerboard+id\} - - - - - -The unique ID of the Answer Board. - - - - - - - - - -##### itemCount \{#embed-answerboard+answerboard+answerboard+itemcount\} - - - - - -The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - - - - - - - - - -##### name \{#embed-answerboard+answerboard+answerboard+name\} - - - - - -The unique name of the Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-answerboard+answerboard+answerboard+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-answerboard+answerboard+answerboard+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-answerboard+answerboard+answerboard+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-answerboard+answerboard+answerboard+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-answerboard+answerboard+answerboard+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/app.mdx b/examples/docusaurus/src/components/glean-embeds/contents/app.mdx deleted file mode 100644 index 073b87d0c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/app.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### app \{#embed-app+app\} - - - - - - - - - -#### AppResult \{#embed-app+app+appresult\} - - - - - - - - - -##### datasource \{#embed-app+app+appresult+datasource\} - - - - - -The app or other repository type this represents - - - - - - - - - -##### docType \{#embed-app+app+appresult+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### iconUrl \{#embed-app+app+appresult+iconurl\} - - - - - -If there is available icon URL. - - - - - - - - - -##### mimeType \{#embed-app+app+appresult+mimetype\} - - - - - -Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive) - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/assignee.mdx b/examples/docusaurus/src/components/glean-embeds/contents/assignee.mdx deleted file mode 100644 index 79e76950a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/assignee.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### assignee \{#embed-assignee+assignee\} - - - - - - - - - -#### Person \{#embed-assignee+assignee+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-assignee+assignee+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-assignee+assignee+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-assignee+assignee+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-assignee+assignee+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/assistantinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/assistantinsights.mdx deleted file mode 100644 index 93ad9b000..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/assistantinsights.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivedaycount from "../loaders/activedaycount.tsx"; -import Embedactivitycount from "../loaders/activitycount.tsx"; -import Embeduser from "../loaders/user.tsx"; - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### assistantInsights \{#embed-assistantinsights+assistantinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - -#### UserActivityInsight \{#embed-assistantinsights+assistantinsights+useractivityinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activeDayCount \{#embed-assistantinsights+assistantinsights+useractivityinsight+activedaycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### activity \{#embed-assistantinsights+assistantinsights+useractivityinsight+activity\} - - - - - -Activity e.g. search, home page visit or all. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityCount \{#embed-assistantinsights+assistantinsights+useractivityinsight+activitycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastActivityTimestamp \{#embed-assistantinsights+assistantinsights+useractivityinsight+lastactivitytimestamp\} - - - - - -Unix timestamp of the last activity (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### user \{#embed-assistantinsights+assistantinsights+useractivityinsight+user\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/attachments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/attachments.mdx deleted file mode 100644 index b05fe22ff..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/attachments.mdx +++ /dev/null @@ -1,687 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedbacklinkresults from "../loaders/backlinkresults.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedmustincludesuggestions from "../loaders/mustincludesuggestions.tsx"; -import Embedpins from "../loaders/pins.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../loaders/relatedresults.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedstructuredresults from "../loaders/structuredresults.tsx"; - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attachments \{#embed-attachments+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#embed-attachments+attachments+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#embed-attachments+attachments+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - -##### attachmentContext \{#embed-attachments+attachments+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#embed-attachments+attachments+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#embed-attachments+attachments+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#embed-attachments+attachments+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#embed-attachments+attachments+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-attachments+attachments+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#embed-attachments+attachments+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#embed-attachments+attachments+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#embed-attachments+attachments+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#embed-attachments+attachments+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#embed-attachments+attachments+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-attachments+attachments+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-attachments+attachments+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#embed-attachments+attachments+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-attachments+attachments+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-attachments+attachments+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-attachments+attachments+searchresult+title\} - - - - - - - - - -##### trackingToken \{#embed-attachments+attachments+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#embed-attachments+attachments+searchresult+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/attendees.mdx b/examples/docusaurus/src/components/glean-embeds/contents/attendees.mdx deleted file mode 100644 index 866894819..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/attendees.mdx +++ /dev/null @@ -1,252 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedpeople from "../loaders/people.tsx"; - - - -CalendarAttendees","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attendees \{#embed-attendees+attendees\} - - - - - - - - - -#### CalendarAttendees \{#embed-attendees+attendees+calendarattendees\} - - - - - - - - - -##### isLimit \{#embed-attendees+attendees+calendarattendees+islimit\} - - - - - -Whether the total count of the people returned is at the retrieval limit. - - - - - - - - - -##### numAccepted \{#embed-attendees+attendees+calendarattendees+numaccepted\} - - - - - -Total number of attendees who have accepted this event. - - - - - - - - - -##### numDeclined \{#embed-attendees+attendees+calendarattendees+numdeclined\} - - - - - -Total number of attendees who have declined this event. - - - - - - - - - -##### numNoResponse \{#embed-attendees+attendees+calendarattendees+numnoresponse\} - - - - - -Total number of attendees who have not responded to this event. - - - - - - - - - -##### numTentative \{#embed-attendees+attendees+calendarattendees+numtentative\} - - - - - -Total number of attendees who have responded tentatively (i.e. responded maybe) to this event. - - - - - -CalendarAttendee","children":[{"label":"CalendarAttendee","linkedLabel":"CalendarAttendee","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### people \{#embed-attendees+attendees+calendarattendees+people\} - - - - - -Full details of some of the attendees of this event - - - - - - - - - - - - - - - - - - - - - - - -##### total \{#embed-attendees+attendees+calendarattendees+total\} - - - - - -Total number of attendees in this event. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/attribution.mdx b/examples/docusaurus/src/components/glean-embeds/contents/attribution.mdx deleted file mode 100644 index c1e0d2492..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/attribution.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attribution \{#embed-attribution+attribution\} - - - - - - - - - -#### Person \{#embed-attribution+attribution+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-attribution+attribution+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-attribution+attribution+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-attribution+attribution+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-attribution+attribution+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/audiencefilters.mdx b/examples/docusaurus/src/components/glean-embeds/contents/audiencefilters.mdx deleted file mode 100644 index 3f2ad019e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/audiencefilters.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../loaders/values.tsx"; - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### audienceFilters \{#embed-audiencefilters+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#embed-audiencefilters+audiencefilters+facetfilter\} - - - - - - - - - -##### fieldName \{#embed-audiencefilters+audiencefilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#embed-audiencefilters+audiencefilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#embed-audiencefilters+audiencefilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/author.mdx b/examples/docusaurus/src/components/glean-embeds/contents/author.mdx deleted file mode 100644 index 766c78b1d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/author.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### author \{#embed-author+author\} - - - - - - - - - -#### Person \{#embed-author+author+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-author+author+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-author+author+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-author+author+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-author+author+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/authtokens.mdx b/examples/docusaurus/src/components/glean-embeds/contents/authtokens.mdx deleted file mode 100644 index f5f32e805..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/authtokens.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -AuthToken","children":[{"label":"AuthToken","linkedLabel":"AuthToken","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### authTokens \{#embed-authtokens+authtokens\} - - - - - -Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - - - - - - - - - -#### AuthToken \{#embed-authtokens+authtokens+authtoken\} - - - - - - - - - -##### accessToken \{#embed-authtokens+authtokens+authtoken+accesstoken\} - - - - - - - - - -##### authUser \{#embed-authtokens+authtokens+authtoken+authuser\} - - - - - -Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin. - - - - - - - - - -##### datasource \{#embed-authtokens+authtokens+authtoken+datasource\} - - - - - - - - - -##### expiration \{#embed-authtokens+authtokens+authtoken+expiration\} - - - - - -Unix timestamp when this token expires (in seconds since epoch UTC). - - - - - - - - - -##### scope \{#embed-authtokens+authtokens+authtoken+scope\} - - - - - - - - - -##### tokenType \{#embed-authtokens+authtokens+authtoken+tokentype\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/backlinkresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/backlinkresults.mdx deleted file mode 100644 index 38675c89f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/backlinkresults.mdx +++ /dev/null @@ -1,672 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; -import Embedmustincludesuggestions from "../loaders/mustincludesuggestions.tsx"; -import Embedpins from "../loaders/pins.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../loaders/relatedresults.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedstructuredresults from "../loaders/structuredresults.tsx"; - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### backlinkResults \{#embed-backlinkresults+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#embed-backlinkresults+backlinkresults+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#embed-backlinkresults+backlinkresults+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - -##### attachmentContext \{#embed-backlinkresults+backlinkresults+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#embed-backlinkresults+backlinkresults+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#embed-backlinkresults+backlinkresults+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - -##### clusterType \{#embed-backlinkresults+backlinkresults+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#embed-backlinkresults+backlinkresults+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-backlinkresults+backlinkresults+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#embed-backlinkresults+backlinkresults+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#embed-backlinkresults+backlinkresults+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#embed-backlinkresults+backlinkresults+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#embed-backlinkresults+backlinkresults+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#embed-backlinkresults+backlinkresults+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-backlinkresults+backlinkresults+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-backlinkresults+backlinkresults+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#embed-backlinkresults+backlinkresults+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-backlinkresults+backlinkresults+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-backlinkresults+backlinkresults+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-backlinkresults+backlinkresults+searchresult+title\} - - - - - - - - - -##### trackingToken \{#embed-backlinkresults+backlinkresults+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#embed-backlinkresults+backlinkresults+searchresult+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/banner.mdx b/examples/docusaurus/src/components/glean-embeds/contents/banner.mdx deleted file mode 100644 index aecb304cb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/banner.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/board.mdx b/examples/docusaurus/src/components/glean-embeds/contents/board.mdx deleted file mode 100644 index 26eec2b17..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/board.mdx +++ /dev/null @@ -1,470 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../loaders/addedroles.tsx"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedcreator from "../loaders/creator.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### board \{#embed-board+board\} - - - - - - - - - -#### AnswerBoard \{#embed-board+board+answerboard\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-board+board+answerboard+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-board+board+answerboard+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-board+board+answerboard+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#embed-board+board+answerboard+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-board+board+answerboard+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### id \{#embed-board+board+answerboard+id\} - - - - - -The unique ID of the Answer Board. - - - - - - - - - -##### itemCount \{#embed-board+board+answerboard+itemcount\} - - - - - -The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - - - - - - - - - -##### name \{#embed-board+board+answerboard+name\} - - - - - -The unique name of the Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-board+board+answerboard+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-board+board+answerboard+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-board+board+answerboard+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-board+board+answerboard+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-board+board+answerboard+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/body.mdx b/examples/docusaurus/src/components/glean-embeds/contents/body.mdx deleted file mode 100644 index a0c1e5662..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/body.mdx +++ /dev/null @@ -1,136 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedstructuredlist from "../loaders/structuredlist.tsx"; - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### body \{#embed-body+body\} - - - - - - - - - -#### StructuredText \{#embed-body+body+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#embed-body+body+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#embed-body+body+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/broadsharingoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/broadsharingoptions.mdx deleted file mode 100644 index 486e832ca..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/broadsharingoptions.mdx +++ /dev/null @@ -1,261 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### broadSharingOptions \{#embed-broadsharingoptions+broadsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - -#### SharingOptions \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - -##### anonymousAccessEnabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+anonymousaccessenabled\} - - - - - -Anyone on the internet can access the document. - - - - - - - - - -##### anyoneInternalEnabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+anyoneinternalenabled\} - - - - - -Only users within the organization can access the document. - - - - - - - - - -##### anyoneWithLinkEnabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+anyonewithlinkenabled\} - - - - - - - - - -##### enabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+enabled\} - - - - - - - - - -##### threshold \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+threshold\} - - - - - -The minimum number of users the document is shared with. - - - - - - - - - -##### thresholdEnabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+thresholdenabled\} - - - - - -Documents will be filtered based on how many people have access to it. - - - - - - - - - -##### userAccessEnabled \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+useraccessenabled\} - - - - - -Enable user access check - - - - - - - - - -##### userIds \{#embed-broadsharingoptions+broadsharingoptions+sharingoptions+userids\} - - - - - -Any one of the specified users can access the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/buckets.mdx b/examples/docusaurus/src/components/glean-embeds/contents/buckets.mdx deleted file mode 100644 index a89842886..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/buckets.mdx +++ /dev/null @@ -1,208 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalue from "../loaders/value.tsx"; - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### buckets \{#embed-buckets+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - -#### FacetBucket \{#embed-buckets+buckets+facetbucket\} - - - - - - - - - -##### count \{#embed-buckets+buckets+facetbucket+count\} - - - - - -Estimated number of results in this facet. - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - -##### datasource \{#embed-buckets+buckets+facetbucket+datasource\} - - - - - -The datasource the value belongs to. This will be used by the all tab to show types across all datasources. - - - - - -_Example:_ - -``` -jira -``` - - - - - - - - - -##### percentage \{#embed-buckets+buckets+facetbucket+percentage\} - - - - - -Estimated percentage of results in this facet. - - - - - -_Example:_ - -``` -5 -``` - - - - - -FacetValue","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### value \{#embed-buckets+buckets+facetbucket+value\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/candidateverifiers.mdx b/examples/docusaurus/src/components/glean-embeds/contents/candidateverifiers.mdx deleted file mode 100644 index 00fe76da6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/candidateverifiers.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### candidateVerifiers \{#embed-candidateverifiers+candidateverifiers\} - - - - - -A list of POC for company. - - - - - - - - - -#### Person \{#embed-candidateverifiers+candidateverifiers+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-candidateverifiers+candidateverifiers+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-candidateverifiers+candidateverifiers+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-candidateverifiers+candidateverifiers+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-candidateverifiers+candidateverifiers+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/capabilities.mdx b/examples/docusaurus/src/components/glean-embeds/contents/capabilities.mdx deleted file mode 100644 index 2b5879323..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/capabilities.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Agent Capabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### capabilities \{#embed-capabilities+capabilities\} - - - - - -Describes features that the agent supports. example: \{ - "ap.io.messages": true, - "ap.io.streaming": true -\} - - - - - - - - - -#### Agent Capabilities \{#embed-capabilities+capabilities+agent capabilities\} - - - - - -Describes features that the agent supports. example: \{ - "ap.io.messages": true, - "ap.io.streaming": true -\} - - - - - - - - - -##### AdditionalProperties \{#embed-capabilities+capabilities+agent capabilities+additionalproperties\} - - - - - - - - - -##### ap.io.messages \{#embed-capabilities+capabilities+agent capabilities+ap.io.messages\} - - - - - -Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent. - - - - - - - - - -##### ap.io.streaming \{#embed-capabilities+capabilities+agent capabilities+ap.io.streaming\} - - - - - -Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/categorytoresultsize.mdx b/examples/docusaurus/src/components/glean-embeds/contents/categorytoresultsize.mdx deleted file mode 100644 index 7f16e12c5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/categorytoresultsize.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -categoryToResultSize","children":[{"label":"categoryToResultSize","linkedLabel":"categoryToResultSize","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### categoryToResultSize \{#embed-categorytoresultsize+categorytoresultsize\} - - - - - -Mapping from category to number of results asked for the category. - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/chat.mdx b/examples/docusaurus/src/components/glean-embeds/contents/chat.mdx deleted file mode 100644 index 503eb6ef7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/chat.mdx +++ /dev/null @@ -1,413 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embedicon from "../loaders/icon.tsx"; -import Embedmessages from "../loaders/messages.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedroles from "../loaders/roles.tsx"; - - - -Chat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chat \{#embed-chat+chat\} - - - - - -A historical representation of a series of chat messages a user had with Glean Assistant. - - - - - - - - - -#### Chat \{#embed-chat+chat+chat\} - - - - - -A historical representation of a series of chat messages a user had with Glean Assistant. - - - - - - - - - -##### applicationId \{#embed-chat+chat+chat+applicationid\} - - - - - -The ID of the AI App that this Chat is associated to. - - - - - - - - - -##### applicationName \{#embed-chat+chat+chat+applicationname\} - - - - - -The display name of the AI App that this Chat is associated to. - - - - - - - - - -##### createTime \{#embed-chat+chat+chat+createtime\} - - - - - -Server Unix timestamp of the creation time (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-chat+chat+chat+createdby\} - - - - - - - - - - - - - - - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### icon \{#embed-chat+chat+chat+icon\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#embed-chat+chat+chat+id\} - - - - - -The opaque id of the Chat. - - - - - -ChatMessage","children":[{"label":"ChatMessage","linkedLabel":"ChatMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### messages \{#embed-chat+chat+chat+messages\} - - - - - -A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-chat+chat+chat+name\} - - - - - -The name of the Chat. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-chat+chat+chat+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-chat+chat+chat+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-chat+chat+chat+updatetime\} - - - - - -Server Unix timestamp of the update time (in seconds since epoch UTC). - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/chatsuggestion.mdx b/examples/docusaurus/src/components/glean-embeds/contents/chatsuggestion.mdx deleted file mode 100644 index bc5616b75..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/chatsuggestion.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ChatSuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chatSuggestion \{#embed-chatsuggestion+chatsuggestion\} - - - - - - - - - -#### ChatSuggestion \{#embed-chatsuggestion+chatsuggestion+chatsuggestion\} - - - - - - - - - -##### feature \{#embed-chatsuggestion+chatsuggestion+chatsuggestion+feature\} - - - - - -Targeted Glean Chat feature for the suggestion. - - - - - - - - - -##### query \{#embed-chatsuggestion+chatsuggestion+chatsuggestion+query\} - - - - - -The actionable chat query to run when the user selects this suggestion. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/chattranscript.mdx b/examples/docusaurus/src/components/glean-embeds/contents/chattranscript.mdx deleted file mode 100644 index 555f92bd5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/chattranscript.mdx +++ /dev/null @@ -1,231 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedresultdocuments from "../loaders/resultdocuments.tsx"; - - - -FeedbackChatExchange","children":[{"label":"FeedbackChatExchange","linkedLabel":"FeedbackChatExchange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chatTranscript \{#embed-chattranscript+chattranscript\} - - - - - -Array of previous request/response exchanges, ordered by oldest to newest. - - - - - - - - - -#### FeedbackChatExchange \{#embed-chattranscript+chattranscript+feedbackchatexchange\} - - - - - - - - - -##### agent \{#embed-chattranscript+chattranscript+feedbackchatexchange+agent\} - - - - - -Either DEFAULT (company knowledge) or GPT (world knowledge). - - - - - - - - - -##### response \{#embed-chattranscript+chattranscript+feedbackchatexchange+response\} - - - - - -resultDocument","children":[{"label":"resultDocument","linkedLabel":"resultDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### resultDocuments \{#embed-chattranscript+chattranscript+feedbackchatexchange+resultdocuments\} - - - - - -List of documents read by the agent. - - - - - - - - - - - - - - - - - - - - - - - -##### searchQuery \{#embed-chattranscript+chattranscript+feedbackchatexchange+searchquery\} - - - - - -Search query performed by the agent. - - - - - - - - - -##### timestamp \{#embed-chattranscript+chattranscript+feedbackchatexchange+timestamp\} - - - - - -Unix timestamp in millis for the chat request. - - - - - - - - - -##### userQuery \{#embed-chattranscript+chattranscript+feedbackchatexchange+userquery\} - - - - - -Initial query entered by the user. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/chatzerostatesuggestionoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/chatzerostatesuggestionoptions.mdx deleted file mode 100644 index c74a91351..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/chatzerostatesuggestionoptions.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ChatZeroStateSuggestionOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chatZeroStateSuggestionOptions \{#embed-chatzerostatesuggestionoptions+chatzerostatesuggestionoptions\} - - - - - - - - - -#### ChatZeroStateSuggestionOptions \{#embed-chatzerostatesuggestionoptions+chatzerostatesuggestionoptions+chatzerostatesuggestionoptions\} - - - - - - - - - -##### applicationId \{#embed-chatzerostatesuggestionoptions+chatzerostatesuggestionoptions+chatzerostatesuggestionoptions+applicationid\} - - - - - -The Chat Application ID this feed request should be scoped to. Empty means there is no Chat Application ID.. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/children.mdx b/examples/docusaurus/src/components/glean-embeds/contents/children.mdx deleted file mode 100644 index 7742d7551..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/children.mdx +++ /dev/null @@ -1,723 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedcreator from "../loaders/creator.tsx"; -import Embeditems from "../loaders/items.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedpinmetadata from "../loaders/pinmetadata.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### children \{#embed-children+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#embed-children+children+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-children+children+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - -##### adminLocked \{#embed-children+children+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#embed-children+children+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-children+children+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#embed-children+children+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - - - - - -##### createTime \{#embed-children+children+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#embed-children+children+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-children+children+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#embed-children+children+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#embed-children+children+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#embed-children+children+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#embed-children+children+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-children+children+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#embed-children+children+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-children+children+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#embed-children+children+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-children+children+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-children+children+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#embed-children+children+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-children+children+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-children+children+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-children+children+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/citation.mdx b/examples/docusaurus/src/components/glean-embeds/contents/citation.mdx deleted file mode 100644 index 665295232..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/citation.mdx +++ /dev/null @@ -1,260 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedreferenceranges from "../loaders/referenceranges.tsx"; -import Embedsourcedocument from "../loaders/sourcedocument.tsx"; -import Embedsourcefile from "../loaders/sourcefile.tsx"; -import Embedsourceperson from "../loaders/sourceperson.tsx"; - - - -ChatMessageCitation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### citation \{#embed-citation+citation\} - - - - - -Information about the source for a ChatMessage. - - - - - - - - - -#### ChatMessageCitation \{#embed-citation+citation+chatmessagecitation\} - - - - - -Information about the source for a ChatMessage. - - - - - -ReferenceRange","children":[{"label":"ReferenceRange","linkedLabel":"ReferenceRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### referenceRanges \{#embed-citation+citation+chatmessagecitation+referenceranges\} - - - - - -Each reference range and its corresponding snippets - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceDocument \{#embed-citation+citation+chatmessagecitation+sourcedocument\} - - - - - - - - - - - - - - - - - - - -ChatFile","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceFile \{#embed-citation+citation+chatmessagecitation+sourcefile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourcePerson \{#embed-citation+citation+chatmessagecitation+sourceperson\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#embed-citation+citation+chatmessagecitation+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/citations.mdx b/examples/docusaurus/src/components/glean-embeds/contents/citations.mdx deleted file mode 100644 index b054a0549..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/citations.mdx +++ /dev/null @@ -1,260 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedreferenceranges from "../loaders/referenceranges.tsx"; -import Embedsourcedocument from "../loaders/sourcedocument.tsx"; -import Embedsourcefile from "../loaders/sourcefile.tsx"; -import Embedsourceperson from "../loaders/sourceperson.tsx"; - - - -ChatMessageCitation","children":[{"label":"ChatMessageCitation","linkedLabel":"ChatMessageCitation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### citations \{#embed-citations+citations\} - - - - - -A list of Citations that were used to generate the response. - - - - - - - - - -#### ChatMessageCitation \{#embed-citations+citations+chatmessagecitation\} - - - - - -Information about the source for a ChatMessage. - - - - - -ReferenceRange","children":[{"label":"ReferenceRange","linkedLabel":"ReferenceRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### referenceRanges \{#embed-citations+citations+chatmessagecitation+referenceranges\} - - - - - -Each reference range and its corresponding snippets - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceDocument \{#embed-citations+citations+chatmessagecitation+sourcedocument\} - - - - - - - - - - - - - - - - - - - -ChatFile","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourceFile \{#embed-citations+citations+chatmessagecitation+sourcefile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sourcePerson \{#embed-citations+citations+chatmessagecitation+sourceperson\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#embed-citations+citations+chatmessagecitation+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/classifications.mdx b/examples/docusaurus/src/components/glean-embeds/contents/classifications.mdx deleted file mode 100644 index a317717e3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/classifications.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -EventClassification","children":[{"label":"EventClassification","linkedLabel":"EventClassification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### classifications \{#embed-classifications+classifications\} - - - - - - - - - -#### EventClassification \{#embed-classifications+classifications+eventclassification\} - - - - - -A generated classification of a given event. - - - - - - - - - -##### name \{#embed-classifications+classifications+eventclassification+name\} - - - - - -The name for a generated classification of an event. - - - - - - - - - -##### strategies \{#embed-classifications+classifications+eventclassification+strategies\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/clickcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/clickcount.mdx deleted file mode 100644 index ab42dbdd1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/clickcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### clickCount \{#embed-clickcount+clickcount\} - - - - - - - - - -#### CountInfo \{#embed-clickcount+clickcount+countinfo\} - - - - - - - - - -##### count \{#embed-clickcount+clickcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-clickcount+clickcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-clickcount+clickcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/clusteredresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/clusteredresults.mdx deleted file mode 100644 index ca9ebbc2d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/clusteredresults.mdx +++ /dev/null @@ -1,698 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedattachments from "../loaders/attachments.tsx"; -import Embedbacklinkresults from "../loaders/backlinkresults.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedmustincludesuggestions from "../loaders/mustincludesuggestions.tsx"; -import Embedpins from "../loaders/pins.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../loaders/relatedresults.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedstructuredresults from "../loaders/structuredresults.tsx"; - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### clusteredResults \{#embed-clusteredresults+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#embed-clusteredresults+clusteredresults+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#embed-clusteredresults+clusteredresults+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - -##### attachmentContext \{#embed-clusteredresults+clusteredresults+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#embed-clusteredresults+clusteredresults+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#embed-clusteredresults+clusteredresults+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#embed-clusteredresults+clusteredresults+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#embed-clusteredresults+clusteredresults+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-clusteredresults+clusteredresults+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#embed-clusteredresults+clusteredresults+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#embed-clusteredresults+clusteredresults+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#embed-clusteredresults+clusteredresults+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#embed-clusteredresults+clusteredresults+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#embed-clusteredresults+clusteredresults+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-clusteredresults+clusteredresults+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-clusteredresults+clusteredresults+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#embed-clusteredresults+clusteredresults+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-clusteredresults+clusteredresults+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-clusteredresults+clusteredresults+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-clusteredresults+clusteredresults+searchresult+title\} - - - - - - - - - -##### trackingToken \{#embed-clusteredresults+clusteredresults+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#embed-clusteredresults+clusteredresults+searchresult+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/code.mdx b/examples/docusaurus/src/components/glean-embeds/contents/code.mdx deleted file mode 100644 index 96bd5363d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/code.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedlines from "../loaders/lines.tsx"; - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### code \{#embed-code+code\} - - - - - - - - - -#### Code \{#embed-code+code+code\} - - - - - - - - - -##### fileName \{#embed-code+code+code+filename\} - - - - - - - - - -##### fileUrl \{#embed-code+code+code+fileurl\} - - - - - - - - - -##### isLastMatch \{#embed-code+code+code+islastmatch\} - - - - - -Last file match for a repo - - - - - -CodeLine","children":[{"label":"CodeLine","linkedLabel":"CodeLine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### lines \{#embed-code+code+code+lines\} - - - - - - - - - - - - - - - - - - - - - - - -##### repoName \{#embed-code+code+code+reponame\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/collection.mdx b/examples/docusaurus/src/components/glean-embeds/contents/collection.mdx deleted file mode 100644 index 564312218..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/collection.mdx +++ /dev/null @@ -1,757 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedchildren from "../loaders/children.tsx"; -import Embedcreator from "../loaders/creator.tsx"; -import Embeditems from "../loaders/items.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedpinmetadata from "../loaders/pinmetadata.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collection \{#embed-collection+collection\} - - - - - - - - - -#### Collection \{#embed-collection+collection+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-collection+collection+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - -##### adminLocked \{#embed-collection+collection+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#embed-collection+collection+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-collection+collection+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#embed-collection+collection+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#embed-collection+collection+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-collection+collection+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#embed-collection+collection+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-collection+collection+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#embed-collection+collection+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#embed-collection+collection+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#embed-collection+collection+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#embed-collection+collection+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-collection+collection+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#embed-collection+collection+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-collection+collection+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#embed-collection+collection+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-collection+collection+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-collection+collection+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#embed-collection+collection+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-collection+collection+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-collection+collection+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-collection+collection+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/collectionitem.mdx b/examples/docusaurus/src/components/glean-embeds/contents/collectionitem.mdx deleted file mode 100644 index e139dce57..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/collectionitem.mdx +++ /dev/null @@ -1,417 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcollection from "../loaders/collection.tsx"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedshortcut from "../loaders/shortcut.tsx"; - - - -CollectionItem","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collectionItem \{#embed-collectionitem+collectionitem\} - - - - - - - - - -#### CollectionItem \{#embed-collectionitem+collectionitem+collectionitem\} - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-collectionitem+collectionitem+collectionitem+collection\} - - - - - - - - - - - - - - - - - - - - - - - -##### collectionId \{#embed-collectionitem+collectionitem+collectionitem+collectionid\} - - - - - -The Collection ID of the Collection that this CollectionItem belongs in. - - - - - - - - - -##### createdAt \{#embed-collectionitem+collectionitem+collectionitem+createdat\} - - - - - -Unix timestamp for when the item was first added (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-collectionitem+collectionitem+collectionitem+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-collectionitem+collectionitem+collectionitem+description\} - - - - - -A helpful description of why this CollectionItem is in the Collection that it's in. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-collectionitem+collectionitem+collectionitem+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### documentId \{#embed-collectionitem+collectionitem+collectionitem+documentid\} - - - - - -If this CollectionItem is indexed, the Glean Document ID of that document. - - - - - - - - - -##### icon \{#embed-collectionitem+collectionitem+collectionitem+icon\} - - - - - -The emoji icon for this CollectionItem. Only used for Text type items. - - - - - - - - - -##### itemId \{#embed-collectionitem+collectionitem+collectionitem+itemid\} - - - - - -Unique identifier for the item within the Collection it belongs to. - - - - - - - - - -##### itemType \{#embed-collectionitem+collectionitem+collectionitem+itemtype\} - - - - - - - - - -##### name \{#embed-collectionitem+collectionitem+collectionitem+name\} - - - - - -The optional name of the Collection item. - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#embed-collectionitem+collectionitem+collectionitem+shortcut\} - - - - - - - - - - - - - - - - - - - - - - - -##### url \{#embed-collectionitem+collectionitem+collectionitem+url\} - - - - - -The URL of this CollectionItem. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/collections.mdx b/examples/docusaurus/src/components/glean-embeds/contents/collections.mdx deleted file mode 100644 index 263a1c8bb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/collections.mdx +++ /dev/null @@ -1,774 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaddedroles from "../loaders/addedroles.tsx"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedchildren from "../loaders/children.tsx"; -import Embedcreator from "../loaders/creator.tsx"; -import Embeditems from "../loaders/items.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedpinmetadata from "../loaders/pinmetadata.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### collections \{#embed-collections+collections\} - - - - - -The collections to which the answer belongs. - - - - - - - - - -#### Collection \{#embed-collections+collections+collection\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-collections+collections+collection+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### adminLocked \{#embed-collections+collections+collection+adminlocked\} - - - - - -Indicates whether edits are allowed for everyone or only admins. - - - - - - - - - -##### allowedDatasource \{#embed-collections+collections+collection+alloweddatasource\} - - - - - -The datasource type this Collection can hold. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-collections+collections+collection+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### childCount \{#embed-collections+collections+collection+childcount\} - - - - - -The number of children Collections. Separated from the actual children so we can grab the count without children. - - - - - -Collection","children":[{"label":"Collection","linkedLabel":"Collection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### children \{#embed-collections+collections+collection+children\} - - - - - -The collections to which the answer belongs. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-collections+collections+collection+createtime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### creator \{#embed-collections+collections+collection+creator\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-collections+collections+collection+description\} - - - - - -A brief summary of the Collection's contents. - - - - - - - - - -##### icon \{#embed-collections+collections+collection+icon\} - - - - - -The emoji icon of this Collection. - - - - - - - - - -##### id \{#embed-collections+collections+collection+id\} - - - - - -The unique ID of the Collection. - - - - - - - - - -##### itemCount \{#embed-collections+collections+collection+itemcount\} - - - - - -The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - - - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#embed-collections+collections+collection+items\} - - - - - -The items in this Collection. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-collections+collections+collection+name\} - - - - - -The unique name of the Collection. - - - - - - - - - -##### parentId \{#embed-collections+collections+collection+parentid\} - - - - - -The parent of this Collection, or 0 if it's a top-level Collection. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-collections+collections+collection+permissions\} - - - - - - - - - - - - - - - - - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pinMetadata \{#embed-collections+collections+collection+pinmetadata\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-collections+collections+collection+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-collections+collections+collection+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### shortcuts \{#embed-collections+collections+collection+shortcuts\} - - - - - -The names of the shortcuts (Go Links) that point to this Collection. - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-collections+collections+collection+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### updateTime \{#embed-collections+collections+collection+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-collections+collections+collection+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/combinedanswertext.mdx b/examples/docusaurus/src/components/glean-embeds/contents/combinedanswertext.mdx deleted file mode 100644 index f47ecd1a2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/combinedanswertext.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -StructuredText","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### combinedAnswerText \{#embed-combinedanswertext+combinedanswertext\} - - - - - - - - - -#### StructuredText \{#embed-combinedanswertext+combinedanswertext+structuredtext\} - - - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredList \{#embed-combinedanswertext+combinedanswertext+structuredtext+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - - - - - -##### text \{#embed-combinedanswertext+combinedanswertext+structuredtext+text\} - - - - - -_Example:_ - -``` -From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/comments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/comments.mdx deleted file mode 100644 index 01873babb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/comments.mdx +++ /dev/null @@ -1,270 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedauthor from "../loaders/author.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -CommentDefinition","children":[{"label":"CommentDefinition","linkedLabel":"CommentDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### comments \{#embed-comments+comments\} - - - - - -Comments associated with the document. - - - - - - - - - -#### CommentDefinition \{#embed-comments+comments+commentdefinition\} - - - - - -Describes a comment on a document - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### author \{#embed-comments+comments+commentdefinition+author\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-comments+comments+commentdefinition+content\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#embed-comments+comments+commentdefinition+createdat\} - - - - - -The creation time, in epoch seconds. - - - - - - - - - -##### id \{#embed-comments+comments+commentdefinition+id\} - - - - - -The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length. - - - - - - - - - -##### updatedAt \{#embed-comments+comments+commentdefinition+updatedat\} - - - - - -The last updated time, in epoch seconds. - - - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-comments+comments+commentdefinition+updatedby\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/company.mdx b/examples/docusaurus/src/components/glean-embeds/contents/company.mdx deleted file mode 100644 index e59162815..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/company.mdx +++ /dev/null @@ -1,416 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Company","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### company \{#embed-company+company\} - - - - - - - - - -#### Company \{#embed-company+company+company\} - - - - - - - - - -##### about \{#embed-company+company+company+about\} - - - - - -User facing description of company. - - - - - -_Example:_ - -``` -Financial, software, data, and media company headquartered in Midtown Manhattan, New York City -``` - - - - - - - - - -##### annualRevenue \{#embed-company+company+company+annualrevenue\} - - - - - -Average company's annual revenue for reference. - - - - - - - - - -##### fax \{#embed-company+company+company+fax\} - - - - - -Fax number as a number string. - - - - - - - - - -##### foundedDate \{#embed-company+company+company+foundeddate\} - - - - - -The date when the company was founded. - - - - - - - - - -##### industry \{#embed-company+company+company+industry\} - - - - - -User facing string representing the company's industry. - - - - - -_Example:_ - -``` -Finances -``` - - - - - - - - - -##### location \{#embed-company+company+company+location\} - - - - - -User facing string representing the company's location. - - - - - -_Example:_ - -``` -New York City -``` - - - - - - - - - -##### logoUrl \{#embed-company+company+company+logourl\} - - - - - -The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - - - - - - - - - -##### name \{#embed-company+company+company+name\} - - - - - -User-friendly display name. - - - - - - - - - -##### numberOfEmployees \{#embed-company+company+company+numberofemployees\} - - - - - -Average company's number of employees for reference. - - - - - - - - - -##### phone \{#embed-company+company+company+phone\} - - - - - -Phone number as a number string. - - - - - - - - - -##### profileUrl \{#embed-company+company+company+profileurl\} - - - - - -Link to internal company company profile. - - - - - - - - - -##### stockSymbol \{#embed-company+company+company+stocksymbol\} - - - - - -Company's stock symbol if company is public. - - - - - - - - - -##### websiteUrls \{#embed-company+company+company+websiteurls\} - - - - - -Link to company's associated websites. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/conferencedata.mdx b/examples/docusaurus/src/components/glean-embeds/contents/conferencedata.mdx deleted file mode 100644 index 6a4954f9b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/conferencedata.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ConferenceData","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### conferenceData \{#embed-conferencedata+conferencedata\} - - - - - - - - - -#### ConferenceData \{#embed-conferencedata+conferencedata+conferencedata\} - - - - - - - - - -##### provider \{#embed-conferencedata+conferencedata+conferencedata+provider\} - - - - - - - - - -##### source \{#embed-conferencedata+conferencedata+conferencedata+source\} - - - - - - - - - -##### uri \{#embed-conferencedata+conferencedata+conferencedata+uri\} - - - - - -A permalink for the conference. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/config.mdx b/examples/docusaurus/src/components/glean-embeds/contents/config.mdx deleted file mode 100644 index 694e66295..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/config.mdx +++ /dev/null @@ -1,523 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedallowlistoptions from "../loaders/allowlistoptions.tsx"; -import Embedbroadsharingoptions from "../loaders/broadsharingoptions.tsx"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embedexternalsharingoptions from "../loaders/externalsharingoptions.tsx"; -import Embedinputoptions from "../loaders/inputoptions.tsx"; -import Embedsensitivecontentoptions from "../loaders/sensitivecontentoptions.tsx"; -import Embedsensitiveinfotypes from "../loaders/sensitiveinfotypes.tsx"; - - - -DlpConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### config \{#embed-config+config\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - - - - - -#### DlpConfig \{#embed-config+config+dlpconfig\} - - - - - -Detailed configuration of what documents and sensitive content will be scanned. - - - - - -AllowlistOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowlistOptions \{#embed-config+config+dlpconfig+allowlistoptions\} - - - - - -Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - - - - - - - - - - - - - - - - - - - - - - - -##### autoHideDocs \{#embed-config+config+dlpconfig+autohidedocs\} - - - - - -auto hide documents with findings in the report - - - - - -SharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### broadSharingOptions \{#embed-config+config+dlpconfig+broadsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#embed-config+config+dlpconfig+createdat\} - - - - - -Timestamp at which this configuration was created. - - - - - -DlpPerson","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-config+config+dlpconfig+createdby\} - - - - - -Details about the person who created this report/policy. - - - - - - - - - - - - - - - - - - - -ExternalSharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### externalSharingOptions \{#embed-config+config+dlpconfig+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - - - - - - - - - - - - - - - -##### frequency \{#embed-config+config+dlpconfig+frequency\} - - - - - -Interval between scans. - - - - - -InputOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputOptions \{#embed-config+config+dlpconfig+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - - - - - - - - - - - - - - - - - - - -##### redactQuote \{#embed-config+config+dlpconfig+redactquote\} - - - - - -redact quote in findings of the report - - - - - - - - - -##### reportName \{#embed-config+config+dlpconfig+reportname\} - - - - - -SensitiveContentOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveContentOptions \{#embed-config+config+dlpconfig+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - - - - - - - - - - - - - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveInfoTypes \{#embed-config+config+dlpconfig+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - - - - - - - - - - - - - - - -##### version \{#embed-config+config+dlpconfig+version\} - - - - - -Synonymous with report/policy id. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/containerdocument.mdx b/examples/docusaurus/src/components/glean-embeds/contents/containerdocument.mdx deleted file mode 100644 index 81ee4742f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/containerdocument.mdx +++ /dev/null @@ -1,358 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### containerDocument \{#embed-containerdocument+containerdocument\} - - - - - - - - - -#### Document \{#embed-containerdocument+containerdocument+document\} - - - - - - - - - -##### connectorType \{#embed-containerdocument+containerdocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-containerdocument+containerdocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-containerdocument+containerdocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-containerdocument+containerdocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-containerdocument+containerdocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-containerdocument+containerdocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-containerdocument+containerdocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-containerdocument+containerdocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-containerdocument+containerdocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-containerdocument+containerdocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/content.mdx b/examples/docusaurus/src/components/glean-embeds/contents/content.mdx deleted file mode 100644 index 5789f8849..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/content.mdx +++ /dev/null @@ -1,104 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -MessageTextBlock","children":[{"label":"MessageTextBlock","linkedLabel":"MessageTextBlock","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### content \{#embed-content+content\} - - - - - -The content of the message. - - - - - - - - - -#### MessageTextBlock \{#embed-content+content+messagetextblock\} - - - - - - - - - -##### text \{#embed-content+content+messagetextblock+text\} - - - - - - - - - -##### type \{#embed-content+content+messagetextblock+type\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/context.mdx b/examples/docusaurus/src/components/glean-embeds/contents/context.mdx deleted file mode 100644 index 054e1296f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/context.mdx +++ /dev/null @@ -1,396 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../loaders/containerdocument.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### context \{#embed-context+context\} - - - - - - - - - -#### Document \{#embed-context+context+document\} - - - - - - - - - -##### connectorType \{#embed-context+context+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-context+context+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-context+context+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-context+context+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-context+context+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-context+context+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-context+context+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-context+context+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-context+context+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-context+context+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-context+context+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/countinfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/countinfo.mdx deleted file mode 100644 index b3ba1e9f7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/countinfo.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[{"label":"CountInfo","linkedLabel":"CountInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### countInfo \{#embed-countinfo+countinfo\} - - - - - -Number of visitors to the document during included time periods. - - - - - - - - - -#### CountInfo \{#embed-countinfo+countinfo+countinfo\} - - - - - - - - - -##### count \{#embed-countinfo+countinfo+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-countinfo+countinfo+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-countinfo+countinfo+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/createdby.mdx b/examples/docusaurus/src/components/glean-embeds/contents/createdby.mdx deleted file mode 100644 index 1cae16d04..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/createdby.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### createdBy \{#embed-createdby+createdby\} - - - - - - - - - -#### Person \{#embed-createdby+createdby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-createdby+createdby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-createdby+createdby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-createdby+createdby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-createdby+createdby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/creator.mdx b/examples/docusaurus/src/components/glean-embeds/contents/creator.mdx deleted file mode 100644 index e373ff72a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/creator.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### creator \{#embed-creator+creator\} - - - - - - - - - -#### Person \{#embed-creator+creator+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-creator+creator+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-creator+creator+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-creator+creator+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-creator+creator+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/customentity.mdx b/examples/docusaurus/src/components/glean-embeds/contents/customentity.mdx deleted file mode 100644 index c025d684d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/customentity.mdx +++ /dev/null @@ -1,270 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedroles from "../loaders/roles.tsx"; - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customEntity \{#embed-customentity+customentity\} - - - - - - - - - -#### CustomEntity \{#embed-customentity+customentity+customentity\} - - - - - - - - - -##### datasource \{#embed-customentity+customentity+customentity+datasource\} - - - - - -The datasource the custom entity is from. - - - - - - - - - -##### id \{#embed-customentity+customentity+customentity+id\} - - - - - -Unique identifier. - - - - - -CustomEntityMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-customentity+customentity+customentity+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### objectType \{#embed-customentity+customentity+customentity+objecttype\} - - - - - -The type of the entity. Interpretation is specific to each datasource - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-customentity+customentity+customentity+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-customentity+customentity+customentity+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-customentity+customentity+customentity+title\} - - - - - -Title or name of the custom entity. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/customer.mdx b/examples/docusaurus/src/components/glean-embeds/contents/customer.mdx deleted file mode 100644 index 804e27e35..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/customer.mdx +++ /dev/null @@ -1,375 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcompany from "../loaders/company.tsx"; -import Embedmergedcustomers from "../loaders/mergedcustomers.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedpoc from "../loaders/poc.tsx"; - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customer \{#embed-customer+customer\} - - - - - - - - - -#### Customer \{#embed-customer+customer+customer\} - - - - - -Company","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### company \{#embed-customer+customer+customer+company\} - - - - - - - - - - - - - - - - - - - - - - - -##### contractAnnualRevenue \{#embed-customer+customer+customer+contractannualrevenue\} - - - - - -Average contract annual revenue with that customer. - - - - - - - - - -##### documentCounts \{#embed-customer+customer+customer+documentcounts\} - - - - - -A map of \{string, int\} pairs representing counts of each document type associated with this customer. - - - - - - - - - -##### domains \{#embed-customer+customer+customer+domains\} - - - - - -Link to company's associated website domains. - - - - - - - - - -##### id \{#embed-customer+customer+customer+id\} - - - - - -Unique identifier. - - - - - -Customer","children":[{"label":"Customer","linkedLabel":"Customer","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mergedCustomers \{#embed-customer+customer+customer+mergedcustomers\} - - - - - -A list of Customers. - - - - - - - - - - - - - - - - - - - -CustomerMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-customer+customer+customer+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### notes \{#embed-customer+customer+customer+notes\} - - - - - -User facing (potentially generated) notes about company. - - - - - -_Example:_ - -``` -CIO is interested in trying out the product. -``` - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### poc \{#embed-customer+customer+customer+poc\} - - - - - -A list of POC for company. - - - - - - - - - - - - - - - - - - - - - - - -##### startDate \{#embed-customer+customer+customer+startdate\} - - - - - -The date when the interaction with customer started. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/customfields.mdx b/examples/docusaurus/src/components/glean-embeds/contents/customfields.mdx deleted file mode 100644 index f4a6ee6f3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/customfields.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../loaders/values.tsx"; - - - -CustomFieldData","children":[{"label":"CustomFieldData","linkedLabel":"CustomFieldData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customFields \{#embed-customfields+customfields\} - - - - - -Customizable fields for additional team information. - - - - - - - - - -#### CustomFieldData \{#embed-customfields+customfields+customfielddata\} - - - - - - - - - -##### displayable \{#embed-customfields+customfields+customfielddata+displayable\} - - - - - -Determines whether the client should display this custom field - - - - - -_Default Value:_ `true` - - - - - - - - - -##### label \{#embed-customfields+customfields+customfielddata+label\} - - - - - -A user-facing label for this field. - - - - - -CustomFieldValueStr","children":[],"breakoutSubTypes":{}},{"label":"CustomFieldValueHyperlink","linkedLabel":"CustomFieldValueHyperlink","children":[],"breakoutSubTypes":{}},{"label":"CustomFieldValuePerson","linkedLabel":"CustomFieldValuePerson","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#embed-customfields+customfields+customfielddata+values\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/customproperties.mdx b/examples/docusaurus/src/components/glean-embeds/contents/customproperties.mdx deleted file mode 100644 index 5c984dd27..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/customproperties.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -CustomProperty","children":[{"label":"CustomProperty","linkedLabel":"CustomProperty","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customProperties \{#embed-customproperties+customproperties\} - - - - - -Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - - - - - - - - - -#### CustomProperty \{#embed-customproperties+customproperties+customproperty\} - - - - - -Describes the custom properties of the object. - - - - - - - - - -##### name \{#embed-customproperties+customproperties+customproperty+name\} - - - - - - - - - -##### value \{#embed-customproperties+customproperties+customproperty+value\} - - - - - -Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/customtimerange.mdx b/examples/docusaurus/src/components/glean-embeds/contents/customtimerange.mdx deleted file mode 100644 index ae5a2aafb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/customtimerange.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -TimeRange","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### customTimeRange \{#embed-customtimerange+customtimerange\} - - - - - - - - - -#### TimeRange \{#embed-customtimerange+customtimerange+timerange\} - - - - - - - - - -##### endTime \{#embed-customtimerange+customtimerange+timerange+endtime\} - - - - - -end time of the time range, applicable for the CUSTOM type. - - - - - - - - - -##### lastNDaysValue \{#embed-customtimerange+customtimerange+timerange+lastndaysvalue\} - - - - - -The number of days to look back from the current time, applicable for the LAST_N_DAYS type. - - - - - - - - - -##### startTime \{#embed-customtimerange+customtimerange+timerange+starttime\} - - - - - -start time of the time range, applicable for the CUSTOM type. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/datasourceprofiles.mdx b/examples/docusaurus/src/components/glean-embeds/contents/datasourceprofiles.mdx deleted file mode 100644 index 55d3d2e57..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/datasourceprofiles.mdx +++ /dev/null @@ -1,202 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### datasourceProfiles \{#embed-datasourceprofiles+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - -#### DatasourceProfile \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile\} - - - - - - - - - -##### datasource \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile+datasource\} - - - - - -The datasource the profile is of. - - - - - -_Example:_ - -``` -github -``` - - - - - - - - - -##### handle \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile+handle\} - - - - - -The display name of the entity in the given datasource. - - - - - - - - - -##### isUserGenerated \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile+isusergenerated\} - - - - - -For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source) - - - - - - - - - -##### nativeAppUrl \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - - - - - - - - - -##### url \{#embed-datasourceprofiles+datasourceprofiles+datasourceprofile+url\} - - - - - -URL to view the entity's profile. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/debuginfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/debuginfo.mdx deleted file mode 100644 index d032bd3ad..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/debuginfo.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedstatus from "../loaders/status.tsx"; -import Embeduploadedpermissions from "../loaders/uploadedpermissions.tsx"; - - - -DebugDocumentResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### debugInfo \{#embed-debuginfo+debuginfo\} - - - - - -Describes the response body of the /debug/\{datasource\}/document API call - - - - - - - - - -#### DebugDocumentResponse \{#embed-debuginfo+debuginfo+debugdocumentresponse\} - - - - - -Describes the response body of the /debug/\{datasource\}/document API call - - - - - -DocumentStatusResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### status \{#embed-debuginfo+debuginfo+debugdocumentresponse+status\} - - - - - -Describes the document status response body - - - - - - - - - - - - - - - - - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### uploadedPermissions \{#embed-debuginfo+debuginfo+debugdocumentresponse+uploadedpermissions\} - - - - - -describes the access control details of the document - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/destinationdocument.mdx b/examples/docusaurus/src/components/glean-embeds/contents/destinationdocument.mdx deleted file mode 100644 index 932e5ab43..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/destinationdocument.mdx +++ /dev/null @@ -1,396 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../loaders/containerdocument.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### destinationDocument \{#embed-destinationdocument+destinationdocument\} - - - - - - - - - -#### Document \{#embed-destinationdocument+destinationdocument+document\} - - - - - - - - - -##### connectorType \{#embed-destinationdocument+destinationdocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-destinationdocument+destinationdocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-destinationdocument+destinationdocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-destinationdocument+destinationdocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-destinationdocument+destinationdocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-destinationdocument+destinationdocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-destinationdocument+destinationdocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-destinationdocument+destinationdocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-destinationdocument+destinationdocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-destinationdocument+destinationdocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-destinationdocument+destinationdocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/digest.mdx b/examples/docusaurus/src/components/glean-embeds/contents/digest.mdx deleted file mode 100644 index 6ecacb5d6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/digest.mdx +++ /dev/null @@ -1,188 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedsections from "../loaders/sections.tsx"; - - - -Digest","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### digest \{#embed-digest+digest\} - - - - - - - - - -#### Digest \{#embed-digest+digest+digest\} - - - - - - - - - -##### digestDate \{#embed-digest+digest+digest+digestdate\} - - - - - -The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available. - - - - - -_Example:_ - -``` -2025-09-03 -``` - - - - - - - - - -##### podcastDuration \{#embed-digest+digest+digest+podcastduration\} - - - - - -Duration of the podcast file in seconds. - - - - - - - - - -##### podcastFileId \{#embed-digest+digest+digest+podcastfileid\} - - - - - -Identifier for the podcast file generated from this digest content. - - - - - -DigestSection","children":[{"label":"DigestSection","linkedLabel":"DigestSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-digest+digest+digest+sections\} - - - - - -Array of digest sections from which the podcast was created. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/disambiguation.mdx b/examples/docusaurus/src/components/glean-embeds/contents/disambiguation.mdx deleted file mode 100644 index 6df451a82..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/disambiguation.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### disambiguation \{#embed-disambiguation+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - -#### Disambiguation \{#embed-disambiguation+disambiguation+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - -##### id \{#embed-disambiguation+disambiguation+disambiguation+id\} - - - - - -The unique id of the entity in the knowledge graph - - - - - - - - - -##### name \{#embed-disambiguation+disambiguation+disambiguation+name\} - - - - - -Name of the ambiguous entity - - - - - - - - - -##### type \{#embed-disambiguation+disambiguation+disambiguation+type\} - - - - - -The type of entity. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/document.mdx b/examples/docusaurus/src/components/glean-embeds/contents/document.mdx deleted file mode 100644 index bab7108d0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/document.mdx +++ /dev/null @@ -1,396 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../loaders/containerdocument.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document \{#embed-document+document\} - - - - - - - - - -#### Document \{#embed-document+document+document\} - - - - - - - - - -##### connectorType \{#embed-document+document+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-document+document+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-document+document+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-document+document+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-document+document+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-document+document+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-document+document+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-document+document+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-document+document+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-document+document+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-document+document+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/documentinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/documentinsights.mdx deleted file mode 100644 index 7100526b5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/documentinsights.mdx +++ /dev/null @@ -1,174 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; -import Embedviewcount from "../loaders/viewcount.tsx"; -import Embedvisitorcount from "../loaders/visitorcount.tsx"; - - - -DocumentInsight","children":[{"label":"DocumentInsight","linkedLabel":"DocumentInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documentInsights \{#embed-documentinsights+documentinsights\} - - - - - -Insights for documents. - - - - - - - - - -#### DocumentInsight \{#embed-documentinsights+documentinsights+documentinsight\} - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-documentinsights+documentinsights+documentinsight+document\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### viewCount \{#embed-documentinsights+documentinsights+documentinsight+viewcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### visitorCount \{#embed-documentinsights+documentinsights+documentinsight+visitorcount\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/documents.mdx b/examples/docusaurus/src/components/glean-embeds/contents/documents.mdx deleted file mode 100644 index 4961e8ef8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/documents.mdx +++ /dev/null @@ -1,402 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../loaders/containerdocument.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documents \{#embed-documents+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - -#### Document \{#embed-documents+documents+document\} - - - - - - - - - -##### connectorType \{#embed-documents+documents+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-documents+documents+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-documents+documents+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-documents+documents+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-documents+documents+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-documents+documents+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-documents+documents+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-documents+documents+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-documents+documents+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-documents+documents+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-documents+documents+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/documentvisitorcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/documentvisitorcount.mdx deleted file mode 100644 index 800c0e7c8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/documentvisitorcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### documentVisitorCount \{#embed-documentvisitorcount+documentvisitorcount\} - - - - - - - - - -#### CountInfo \{#embed-documentvisitorcount+documentvisitorcount+countinfo\} - - - - - - - - - -##### count \{#embed-documentvisitorcount+documentvisitorcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-documentvisitorcount+documentvisitorcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-documentvisitorcount+documentvisitorcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/eligiblepins.mdx b/examples/docusaurus/src/components/glean-embeds/contents/eligiblepins.mdx deleted file mode 100644 index bc8168ffb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/eligiblepins.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedtarget from "../loaders/target.tsx"; - - - -CollectionPinMetadata","children":[{"label":"CollectionPinMetadata","linkedLabel":"CollectionPinMetadata","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### eligiblePins \{#embed-eligiblepins+eligiblepins\} - - - - - -List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - - - - - - - - - -#### CollectionPinMetadata \{#embed-eligiblepins+eligiblepins+collectionpinmetadata\} - - - - - - - - - -##### id \{#embed-eligiblepins+eligiblepins+collectionpinmetadata+id\} - - - - - -The ID of the Collection. - - - - - -CollectionPinTarget","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### target \{#embed-eligiblepins+eligiblepins+collectionpinmetadata+target\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/emails.mdx b/examples/docusaurus/src/components/glean-embeds/contents/emails.mdx deleted file mode 100644 index 56a0a66ca..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/emails.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -TeamEmail","children":[{"label":"TeamEmail","linkedLabel":"TeamEmail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### emails \{#embed-emails+emails\} - - - - - -The emails for this team - - - - - - - - - -#### TeamEmail \{#embed-emails+emails+teamemail\} - - - - - -Information about a team's email - - - - - - - - - -##### email \{#embed-emails+emails+teamemail+email\} - - - - - -An email address - - - - - - - - - -##### type \{#embed-emails+emails+teamemail+type\} - - - - - -An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER` - - - - - -_Default Value:_ `"OTHER"` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/end.mdx b/examples/docusaurus/src/components/glean-embeds/contents/end.mdx deleted file mode 100644 index 1e3465058..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/end.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### end \{#embed-end+end\} - - - - - - - - - -#### TimePoint \{#embed-end+end+timepoint\} - - - - - - - - - -##### daysFromNow \{#embed-end+end+timepoint+daysfromnow\} - - - - - -The number of days from now. Specification relative to current time. Can be negative. - - - - - - - - - -##### epochSeconds \{#embed-end+end+timepoint+epochseconds\} - - - - - -Epoch seconds. Has precedence over daysFromNow. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/event.mdx b/examples/docusaurus/src/components/glean-embeds/contents/event.mdx deleted file mode 100644 index 1d0aea9c0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/event.mdx +++ /dev/null @@ -1,457 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedattendees from "../loaders/attendees.tsx"; -import Embedclassifications from "../loaders/classifications.tsx"; -import Embedconferencedata from "../loaders/conferencedata.tsx"; -import Embedgeneratedattachments from "../loaders/generatedattachments.tsx"; -import Embedtime from "../loaders/time.tsx"; - - - -CalendarEvent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### event \{#embed-event+event\} - - - - - -A generic, light-weight calendar event. - - - - - - - - - -#### CalendarEvent \{#embed-event+event+calendarevent\} - - - - - -A generic, light-weight calendar event. - - - - - -CalendarAttendees","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attendees \{#embed-event+event+calendarevent+attendees\} - - - - - - - - - - - - - - - - - - - -EventClassification","children":[{"label":"EventClassification","linkedLabel":"EventClassification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifications \{#embed-event+event+calendarevent+classifications\} - - - - - - - - - - - - - - - - - - - -ConferenceData","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### conferenceData \{#embed-event+event+calendarevent+conferencedata\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-event+event+calendarevent+datasource\} - - - - - -The app or other repository type from which the event was extracted - - - - - - - - - -##### description \{#embed-event+event+calendarevent+description\} - - - - - -The HTML description of the event. - - - - - - - - - -##### eventType \{#embed-event+event+calendarevent+eventtype\} - - - - - -The nature of the event, for example "out of office". - - - - - -GeneratedAttachment","children":[{"label":"GeneratedAttachment","linkedLabel":"GeneratedAttachment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedAttachments \{#embed-event+event+calendarevent+generatedattachments\} - - - - - - - - - - - - - - - - - - - - - - - -##### hasTranscript \{#embed-event+event+calendarevent+hastranscript\} - - - - - -The event has a transcript associated with it enabling features like summarization - - - - - - - - - -##### id \{#embed-event+event+calendarevent+id\} - - - - - -The calendar event id - - - - - - - - - -##### location \{#embed-event+event+calendarevent+location\} - - - - - -The location that this event is taking place at. - - - - - -TimeInterval","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### time \{#embed-event+event+calendarevent+time\} - - - - - - - - - - - - - - - - - - - - - - - -##### transcriptUrl \{#embed-event+event+calendarevent+transcripturl\} - - - - - -A link to the transcript of the event - - - - - - - - - -##### url \{#embed-event+event+calendarevent+url\} - - - - - -A permalink for this calendar event - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/exclusions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/exclusions.mdx deleted file mode 100644 index 8b43ad5a3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/exclusions.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### exclusions \{#embed-exclusions+exclusions\} - - - - - - - - - -#### RestrictionFilters \{#embed-exclusions+exclusions+restrictionfilters\} - - - - - - - - - -##### containerSpecs \{#embed-exclusions+exclusions+restrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/existingpins.mdx b/examples/docusaurus/src/components/glean-embeds/contents/existingpins.mdx deleted file mode 100644 index 12efb649d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/existingpins.mdx +++ /dev/null @@ -1,141 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -CollectionPinTarget","children":[{"label":"CollectionPinTarget","linkedLabel":"CollectionPinTarget","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### existingPins \{#embed-existingpins+existingpins\} - - - - - -List of targets this Collection is pinned to. - - - - - - - - - -#### CollectionPinTarget \{#embed-existingpins+existingpins+collectionpintarget\} - - - - - - - - - -##### category \{#embed-existingpins+existingpins+collectionpintarget+category\} - - - - - -Categories a Collection can be pinned to. - - - - - - - - - -##### target \{#embed-existingpins+existingpins+collectionpintarget+target\} - - - - - -What targets can a Collection be pinned to. - - - - - - - - - -##### value \{#embed-existingpins+existingpins+collectionpintarget+value\} - - - - - -Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/externallinks.mdx b/examples/docusaurus/src/components/glean-embeds/contents/externallinks.mdx deleted file mode 100644 index 0586b129b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/externallinks.mdx +++ /dev/null @@ -1,165 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embediconconfig from "../loaders/iconconfig.tsx"; - - - -StructuredLink","children":[{"label":"StructuredLink","linkedLabel":"StructuredLink","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### externalLinks \{#embed-externallinks+externallinks\} - - - - - -A list of links to external sources outside of Glean. - - - - - - - - - -#### StructuredLink \{#embed-externallinks+externallinks+structuredlink\} - - - - - -The display configuration for a link. - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#embed-externallinks+externallinks+structuredlink+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-externallinks+externallinks+structuredlink+name\} - - - - - -The display name for the link - - - - - - - - - -##### url \{#embed-externallinks+externallinks+structuredlink+url\} - - - - - -The URL for the link. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/externalsharingoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/externalsharingoptions.mdx deleted file mode 100644 index a1d3ec399..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/externalsharingoptions.mdx +++ /dev/null @@ -1,280 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ExternalSharingOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### externalSharingOptions \{#embed-externalsharingoptions+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - -#### ExternalSharingOptions \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions\} - - - - - -Controls how "shared" a document must be to get picked for scans. - - - - - - - - - -##### anonymousAccessEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+anonymousaccessenabled\} - - - - - -Anyone on the internet can access the document. - - - - - - - - - -##### anyoneInternalEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+anyoneinternalenabled\} - - - - - -Only users within the organization can access the document. - - - - - - - - - -##### anyoneWithLinkEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+anyonewithlinkenabled\} - - - - - - - - - -##### domainAccessEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+domainaccessenabled\} - - - - - - - - - -##### enabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+enabled\} - - - - - - - - - -##### threshold \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+threshold\} - - - - - -The minimum number of users the document is shared with. - - - - - - - - - -##### thresholdEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+thresholdenabled\} - - - - - -Documents will be filtered based on how many people have access to it. - - - - - - - - - -##### userAccessEnabled \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+useraccessenabled\} - - - - - -Enable user access check - - - - - - - - - -##### userIds \{#embed-externalsharingoptions+externalsharingoptions+externalsharingoptions+userids\} - - - - - -Any one of the specified users can access the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/extractedqna.mdx b/examples/docusaurus/src/components/glean-embeds/contents/extractedqna.mdx deleted file mode 100644 index 5cb2009e7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/extractedqna.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedquestionresult from "../loaders/questionresult.tsx"; - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### extractedQnA \{#embed-extractedqna+extractedqna\} - - - - - - - - - -#### ExtractedQnA \{#embed-extractedqna+extractedqna+extractedqna\} - - - - - - - - - -##### heading \{#embed-extractedqna+extractedqna+extractedqna+heading\} - - - - - -Heading text that was matched to produce this result. - - - - - - - - - -##### question \{#embed-extractedqna+extractedqna+extractedqna+question\} - - - - - -Question text that was matched to produce this result. - - - - - -SearchResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### questionResult \{#embed-extractedqna+extractedqna+extractedqna+questionresult\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/facetbucketfilter.mdx b/examples/docusaurus/src/components/glean-embeds/contents/facetbucketfilter.mdx deleted file mode 100644 index 6ab5a7a23..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/facetbucketfilter.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -FacetBucketFilter","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetBucketFilter \{#embed-facetbucketfilter+facetbucketfilter\} - - - - - - - - - -#### FacetBucketFilter \{#embed-facetbucketfilter+facetbucketfilter+facetbucketfilter\} - - - - - - - - - -##### facet \{#embed-facetbucketfilter+facetbucketfilter+facetbucketfilter+facet\} - - - - - -The facet whose buckets should be filtered. - - - - - - - - - -##### prefix \{#embed-facetbucketfilter+facetbucketfilter+facetbucketfilter+prefix\} - - - - - -The per-term prefix that facet buckets should be filtered on. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/facetfilters.mdx b/examples/docusaurus/src/components/glean-embeds/contents/facetfilters.mdx deleted file mode 100644 index 8448d6292..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/facetfilters.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../loaders/values.tsx"; - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetFilters \{#embed-facetfilters+facetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#embed-facetfilters+facetfilters+facetfilter\} - - - - - - - - - -##### fieldName \{#embed-facetfilters+facetfilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#embed-facetfilters+facetfilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#embed-facetfilters+facetfilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/facetfiltersets.mdx b/examples/docusaurus/src/components/glean-embeds/contents/facetfiltersets.mdx deleted file mode 100644 index dde04d2a4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/facetfiltersets.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedfilters from "../loaders/filters.tsx"; - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetFilterSets \{#embed-facetfiltersets+facetfiltersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - -#### FacetFilterSet \{#embed-facetfiltersets+facetfiltersets+facetfilterset\} - - - - - -Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### filters \{#embed-facetfiltersets+facetfiltersets+facetfilterset+filters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/facetresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/facetresults.mdx deleted file mode 100644 index 4e460ab45..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/facetresults.mdx +++ /dev/null @@ -1,243 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedbuckets from "../loaders/buckets.tsx"; - - - -FacetResult","children":[{"label":"FacetResult","linkedLabel":"FacetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### facetResults \{#embed-facetresults+facetresults\} - - - - - - - - - -#### FacetResult \{#embed-facetresults+facetresults+facetresult\} - - - - - -FacetBucket","children":[{"label":"FacetBucket","linkedLabel":"FacetBucket","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### buckets \{#embed-facetresults+facetresults+facetresult+buckets\} - - - - - -A list of unique buckets that exist within this result set. - - - - - - - - - - - - - - - - - - - - - - - -##### groupName \{#embed-facetresults+facetresults+facetresult+groupname\} - - - - - -For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - - - - - -_Example:_ - -``` -Service Cloud -``` - - - - - - - - - -##### hasMoreBuckets \{#embed-facetresults+facetresults+facetresult+hasmorebuckets\} - - - - - -Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### operatorName \{#embed-facetresults+facetresults+facetresult+operatorname\} - - - - - -How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - - - - - -_Example:_ - -``` -SelectMultiple -``` - - - - - - - - - -##### sourceName \{#embed-facetresults+facetresults+facetresult+sourcename\} - - - - - -The source of this facet (e.g. container_name, type, last_updated_at). - - - - - -_Example:_ - -``` -container_name -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/favoriteinfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/favoriteinfo.mdx deleted file mode 100644 index c302f58a1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/favoriteinfo.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -FavoriteInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### favoriteInfo \{#embed-favoriteinfo+favoriteinfo\} - - - - - - - - - -#### FavoriteInfo \{#embed-favoriteinfo+favoriteinfo+favoriteinfo\} - - - - - - - - - -##### count \{#embed-favoriteinfo+favoriteinfo+favoriteinfo+count\} - - - - - -Number of users this object has been favorited by. - - - - - - - - - -##### favoritedByUser \{#embed-favoriteinfo+favoriteinfo+favoriteinfo+favoritedbyuser\} - - - - - -If the requesting user has favorited this object. - - - - - - - - - -##### id \{#embed-favoriteinfo+favoriteinfo+favoriteinfo+id\} - - - - - -Opaque id of the UGC. - - - - - - - - - -##### ugcType \{#embed-favoriteinfo+favoriteinfo+favoriteinfo+ugctype\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/file.mdx b/examples/docusaurus/src/components/glean-embeds/contents/file.mdx deleted file mode 100644 index 7165287d6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/file.mdx +++ /dev/null @@ -1,221 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -ChatFile","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file \{#embed-file+file\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -#### ChatFile \{#embed-file+file+chatfile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -##### id \{#embed-file+file+chatfile+id\} - - - - - -Unique identifier of the file. - - - - - -_Example:_ - -``` -FILE_1234 -``` - - - - - -ChatFileMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-file+file+chatfile+metadata\} - - - - - -Metadata of a file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-file+file+chatfile+name\} - - - - - -Name of the uploaded file. - - - - - -_Example:_ - -``` -sample.pdf -``` - - - - - - - - - -##### url \{#embed-file+file+chatfile+url\} - - - - - -Url of the file. - - - - - -_Example:_ - -``` -www.google.com -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/filters.mdx b/examples/docusaurus/src/components/glean-embeds/contents/filters.mdx deleted file mode 100644 index 4667642a5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/filters.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../loaders/values.tsx"; - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### filters \{#embed-filters+filters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#embed-filters+filters+facetfilter\} - - - - - - - - - -##### fieldName \{#embed-filters+filters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#embed-filters+filters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#embed-filters+filters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/followupactions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/followupactions.mdx deleted file mode 100644 index 88481ffec..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/followupactions.mdx +++ /dev/null @@ -1,223 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### followupActions \{#embed-followupactions+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - -#### FollowupAction \{#embed-followupactions+followupactions+followupaction\} - - - - - -A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately. - - - - - - - - - -##### actionId \{#embed-followupactions+followupactions+followupaction+actionid\} - - - - - -The ID of the associated action. - - - - - - - - - -##### actionInstanceId \{#embed-followupactions+followupactions+followupaction+actioninstanceid\} - - - - - -The ID of the action instance that will be invoked. - - - - - - - - - -##### actionLabel \{#embed-followupactions+followupactions+followupaction+actionlabel\} - - - - - -The label to be used when displaying a button to execute this action instance. - - - - - - - - - -##### actionRunId \{#embed-followupactions+followupactions+followupaction+actionrunid\} - - - - - -Unique identifier for this actionRun recommendation event. - - - - - - - - - -##### recommendationText \{#embed-followupactions+followupactions+followupaction+recommendationtext\} - - - - - -Text to be displayed to the user when recommending the action instance. - - - - - - - - - -##### userConfirmationRequired \{#embed-followupactions+followupactions+followupaction+userconfirmationrequired\} - - - - - -Whether user confirmation is needed before executing this action instance. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/fragments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/fragments.mdx deleted file mode 100644 index d9acaa87d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/fragments.mdx +++ /dev/null @@ -1,315 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedaction from "../loaders/action.tsx"; -import Embedcitation from "../loaders/citation.tsx"; -import Embedfile from "../loaders/file.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedstructuredresults from "../loaders/structuredresults.tsx"; - - - -ChatMessageFragment","children":[{"label":"ChatMessageFragment","linkedLabel":"ChatMessageFragment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### fragments \{#embed-fragments+fragments\} - - - - - -A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - - - - - - - - - -#### ChatMessageFragment \{#embed-fragments+fragments+chatmessagefragment\} - - - - - -Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation or file. - - - - - -ToolInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### action \{#embed-fragments+fragments+chatmessagefragment+action\} - - - - - - - - - - - - - - - - - - - -ChatMessageCitation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### citation \{#embed-fragments+fragments+chatmessagefragment+citation\} - - - - - -Information about the source for a ChatMessage. - - - - - - - - - - - - - - - - - - - -ChatFile","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### file \{#embed-fragments+fragments+chatmessagefragment+file\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-fragments+fragments+chatmessagefragment+querysuggestion\} - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-fragments+fragments+chatmessagefragment+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#embed-fragments+fragments+chatmessagefragment+text\} - - - - - - - - - -##### trackingToken \{#embed-fragments+fragments+chatmessagefragment+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/generatedattachments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/generatedattachments.mdx deleted file mode 100644 index 56a5169b6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/generatedattachments.mdx +++ /dev/null @@ -1,280 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontent from "../loaders/content.tsx"; -import Embedcustomer from "../loaders/customer.tsx"; -import Embeddocuments from "../loaders/documents.tsx"; -import Embedexternallinks from "../loaders/externallinks.tsx"; -import Embedperson from "../loaders/person.tsx"; - - - -GeneratedAttachment","children":[{"label":"GeneratedAttachment","linkedLabel":"GeneratedAttachment","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedAttachments \{#embed-generatedattachments+generatedattachments\} - - - - - - - - - -#### GeneratedAttachment \{#embed-generatedattachments+generatedattachments+generatedattachment\} - - - - - -These are attachments that aren't natively present on the event, and have been smartly suggested. - - - - - -GeneratedAttachmentContent","children":[{"label":"GeneratedAttachmentContent","linkedLabel":"GeneratedAttachmentContent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-generatedattachments+generatedattachments+generatedattachment+content\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#embed-generatedattachments+generatedattachments+generatedattachment+customer\} - - - - - - - - - - - - - - - - - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documents \{#embed-generatedattachments+generatedattachments+generatedattachment+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - - - - - - - - - - - -StructuredLink","children":[{"label":"StructuredLink","linkedLabel":"StructuredLink","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### externalLinks \{#embed-generatedattachments+generatedattachments+generatedattachment+externallinks\} - - - - - -A list of links to external sources outside of Glean. - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-generatedattachments+generatedattachments+generatedattachment+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### strategyName \{#embed-generatedattachments+generatedattachments+generatedattachment+strategyname\} - - - - - -The name of method used to surface relevant data for a given calendar event. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/generatedqna.mdx b/examples/docusaurus/src/components/glean-embeds/contents/generatedqna.mdx deleted file mode 100644 index 53e4e0de0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/generatedqna.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedfollowupactions from "../loaders/followupactions.tsx"; -import Embedranges from "../loaders/ranges.tsx"; - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedQna \{#embed-generatedqna+generatedqna\} - - - - - - - - - -#### GeneratedQna \{#embed-generatedqna+generatedqna+generatedqna\} - - - - - - - - - -##### answer \{#embed-generatedqna+generatedqna+generatedqna+answer\} - - - - - -Answer generated for the given query or the generated question. - - - - - - - - - -##### cursor \{#embed-generatedqna+generatedqna+generatedqna+cursor\} - - - - - -An opaque cursor representing the search request - - - - - - - - - -##### followUpPrompts \{#embed-generatedqna+generatedqna+generatedqna+followupprompts\} - - - - - -List of all follow-up prompts generated for the given query or the generated question. - - - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### followupActions \{#embed-generatedqna+generatedqna+generatedqna+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#embed-generatedqna+generatedqna+generatedqna+question\} - - - - - -Search query rephrased into a question. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-generatedqna+generatedqna+generatedqna+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#embed-generatedqna+generatedqna+generatedqna+status\} - - - - - -Status of backend generating the answer - - - - - - - - - -##### trackingToken \{#embed-generatedqna+generatedqna+generatedqna+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/generatedqnaresult.mdx b/examples/docusaurus/src/components/glean-embeds/contents/generatedqnaresult.mdx deleted file mode 100644 index ca27a082b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/generatedqnaresult.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedfollowupactions from "../loaders/followupactions.tsx"; -import Embedranges from "../loaders/ranges.tsx"; - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generatedQnaResult \{#embed-generatedqnaresult+generatedqnaresult\} - - - - - - - - - -#### GeneratedQna \{#embed-generatedqnaresult+generatedqnaresult+generatedqna\} - - - - - - - - - -##### answer \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+answer\} - - - - - -Answer generated for the given query or the generated question. - - - - - - - - - -##### cursor \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+cursor\} - - - - - -An opaque cursor representing the search request - - - - - - - - - -##### followUpPrompts \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+followupprompts\} - - - - - -List of all follow-up prompts generated for the given query or the generated question. - - - - - -FollowupAction","children":[{"label":"FollowupAction","linkedLabel":"FollowupAction","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### followupActions \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+followupactions\} - - - - - -List of follow-up actions generated for the given query or the generated question. - - - - - - - - - - - - - - - - - - - - - - - -##### question \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+question\} - - - - - -Search query rephrased into a question. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+status\} - - - - - -Status of backend generating the answer - - - - - - - - - -##### trackingToken \{#embed-generatedqnaresult+generatedqnaresult+generatedqna+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/gleandataerror.mdx b/examples/docusaurus/src/components/glean-embeds/contents/gleandataerror.mdx deleted file mode 100644 index f594a371b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/gleandataerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -GleanDataError","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### GleanDataError \{#embed-gleandataerror+gleandataerror\} - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/group.mdx b/examples/docusaurus/src/components/glean-embeds/contents/group.mdx deleted file mode 100644 index 6d5fdc1c5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/group.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### group \{#embed-group+group\} - - - - - - - - - -#### Group \{#embed-group+group+group\} - - - - - - - - - -##### datasourceInstance \{#embed-group+group+group+datasourceinstance\} - - - - - -Datasource instance if the group belongs to one e.g. external groups. - - - - - - - - - -##### id \{#embed-group+group+group+id\} - - - - - -A unique identifier for the group. May be the same as name. - - - - - - - - - -##### name \{#embed-group+group+group+name\} - - - - - -Name of the group. - - - - - - - - - -##### type \{#embed-group+group+group+type\} - - - - - -The type of user group - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/groupattendees.mdx b/examples/docusaurus/src/components/glean-embeds/contents/groupattendees.mdx deleted file mode 100644 index 74039a9de..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/groupattendees.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -CalendarAttendee","children":[{"label":"CalendarAttendee","linkedLabel":"CalendarAttendee","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### groupAttendees \{#embed-groupattendees+groupattendees\} - - - - - -Full details of some of the attendees of this event - - - - - - - - - -#### CalendarAttendee \{#embed-groupattendees+groupattendees+calendarattendee\} - - - - - - - - - -##### isInGroup \{#embed-groupattendees+groupattendees+calendarattendee+isingroup\} - - - - - -Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility. - - - - - - - - - -##### isOrganizer \{#embed-groupattendees+groupattendees+calendarattendee+isorganizer\} - - - - - -Whether or not this attendee is an organizer. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-groupattendees+groupattendees+calendarattendee+person\} - - - - - - - - - - - - - -##### responseStatus \{#embed-groupattendees+groupattendees+calendarattendee+responsestatus\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/hotwords.mdx b/examples/docusaurus/src/components/glean-embeds/contents/hotwords.mdx deleted file mode 100644 index 65411a95b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/hotwords.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedproximity from "../loaders/proximity.tsx"; - - - -Hotword","children":[{"label":"Hotword","linkedLabel":"Hotword","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hotwords \{#embed-hotwords+hotwords\} - - - - - -Zero to three proximate regular expressions necessary to consider an expression as sensitive content. - - - - - - - - - -#### Hotword \{#embed-hotwords+hotwords+hotword\} - - - - - -HotwordProximity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### proximity \{#embed-hotwords+hotwords+hotword+proximity\} - - - - - - - - - - - - - - - - - - - - - - - -##### regex \{#embed-hotwords+hotwords+hotword+regex\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/icon.mdx b/examples/docusaurus/src/components/glean-embeds/contents/icon.mdx deleted file mode 100644 index bc60ec442..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/icon.mdx +++ /dev/null @@ -1,243 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### icon \{#embed-icon+icon\} - - - - - -Defines how to render an icon - - - - - - - - - -#### IconConfig \{#embed-icon+icon+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - -##### backgroundColor \{#embed-icon+icon+iconconfig+backgroundcolor\} - - - - - - - - - -##### color \{#embed-icon+icon+iconconfig+color\} - - - - - - - - - -##### generatedBackgroundColorKey \{#embed-icon+icon+iconconfig+generatedbackgroundcolorkey\} - - - - - - - - - -##### iconType \{#embed-icon+icon+iconconfig+icontype\} - - - - - - - - - -##### key \{#embed-icon+icon+iconconfig+key\} - - - - - - - - - -##### masked \{#embed-icon+icon+iconconfig+masked\} - - - - - -Whether the icon should be masked based on current theme. - - - - - - - - - -##### name \{#embed-icon+icon+iconconfig+name\} - - - - - -The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - - - - - - - - - -##### url \{#embed-icon+icon+iconconfig+url\} - - - - - -The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/iconconfig.mdx b/examples/docusaurus/src/components/glean-embeds/contents/iconconfig.mdx deleted file mode 100644 index 7ecdba1cc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/iconconfig.mdx +++ /dev/null @@ -1,243 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### iconConfig \{#embed-iconconfig+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - -#### IconConfig \{#embed-iconconfig+iconconfig+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - -##### backgroundColor \{#embed-iconconfig+iconconfig+iconconfig+backgroundcolor\} - - - - - - - - - -##### color \{#embed-iconconfig+iconconfig+iconconfig+color\} - - - - - - - - - -##### generatedBackgroundColorKey \{#embed-iconconfig+iconconfig+iconconfig+generatedbackgroundcolorkey\} - - - - - - - - - -##### iconType \{#embed-iconconfig+iconconfig+iconconfig+icontype\} - - - - - - - - - -##### key \{#embed-iconconfig+iconconfig+iconconfig+key\} - - - - - - - - - -##### masked \{#embed-iconconfig+iconconfig+iconconfig+masked\} - - - - - -Whether the icon should be masked based on current theme. - - - - - - - - - -##### name \{#embed-iconconfig+iconconfig+iconconfig+name\} - - - - - -The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - - - - - - - - - -##### url \{#embed-iconconfig+iconconfig+iconconfig+url\} - - - - - -The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/implementations.mdx b/examples/docusaurus/src/components/glean-embeds/contents/implementations.mdx deleted file mode 100644 index fdcbf77ff..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/implementations.mdx +++ /dev/null @@ -1,212 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedresponsemetadata from "../loaders/responsemetadata.tsx"; - - - -SideBySideImplementation","children":[{"label":"SideBySideImplementation","linkedLabel":"SideBySideImplementation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### implementations \{#embed-implementations+implementations\} - - - - - -Array of implementations that were compared side-by-side. - - - - - - - - - -#### SideBySideImplementation \{#embed-implementations+implementations+sidebysideimplementation\} - - - - - - - - - -##### implementationId \{#embed-implementations+implementations+sidebysideimplementation+implementationid\} - - - - - -Unique identifier for this implementation variant. - - - - - - - - - -##### implementationName \{#embed-implementations+implementations+sidebysideimplementation+implementationname\} - - - - - -Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). - - - - - - - - - -##### response \{#embed-implementations+implementations+sidebysideimplementation+response\} - - - - - -The full response generated by this implementation. - - - - - -responseMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### responseMetadata \{#embed-implementations+implementations+sidebysideimplementation+responsemetadata\} - - - - - -Metadata about the response (e.g., latency, token count). - - - - - - - - - - - - - - - - - - - - - - - -##### searchParams \{#embed-implementations+implementations+sidebysideimplementation+searchparams\} - - - - - -The search/chat parameters used for this implementation. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/inactiveinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/inactiveinsights.mdx deleted file mode 100644 index 52e7024d5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/inactiveinsights.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivedaycount from "../loaders/activedaycount.tsx"; -import Embedactivitycount from "../loaders/activitycount.tsx"; -import Embeduser from "../loaders/user.tsx"; - - - -UserActivityInsight","children":[{"label":"UserActivityInsight","linkedLabel":"UserActivityInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inactiveInsights \{#embed-inactiveinsights+inactiveinsights\} - - - - - -Insights for all active users with respect to set of actions. - - - - - - - - - -#### UserActivityInsight \{#embed-inactiveinsights+inactiveinsights+useractivityinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activeDayCount \{#embed-inactiveinsights+inactiveinsights+useractivityinsight+activedaycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### activity \{#embed-inactiveinsights+inactiveinsights+useractivityinsight+activity\} - - - - - -Activity e.g. search, home page visit or all. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activityCount \{#embed-inactiveinsights+inactiveinsights+useractivityinsight+activitycount\} - - - - - - - - - - - - - - - - - - - - - - - -##### lastActivityTimestamp \{#embed-inactiveinsights+inactiveinsights+useractivityinsight+lastactivitytimestamp\} - - - - - -Unix timestamp of the last activity (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### user \{#embed-inactiveinsights+inactiveinsights+useractivityinsight+user\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/inclusions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/inclusions.mdx deleted file mode 100644 index 935716e21..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/inclusions.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inclusions \{#embed-inclusions+inclusions\} - - - - - - - - - -#### RestrictionFilters \{#embed-inclusions+inclusions+restrictionfilters\} - - - - - - - - - -##### containerSpecs \{#embed-inclusions+inclusions+restrictionfilters+containerspecs\} - - - - - -Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/inputdetails.mdx b/examples/docusaurus/src/components/glean-embeds/contents/inputdetails.mdx deleted file mode 100644 index 7b650d99d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/inputdetails.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SearchRequestInputDetails","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputDetails \{#embed-inputdetails+inputdetails\} - - - - - - - - - -#### SearchRequestInputDetails \{#embed-inputdetails+inputdetails+searchrequestinputdetails\} - - - - - - - - - -##### hasCopyPaste \{#embed-inputdetails+inputdetails+searchrequestinputdetails+hascopypaste\} - - - - - -Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/inputoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/inputoptions.mdx deleted file mode 100644 index fcf8a0a75..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/inputoptions.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcustomtimerange from "../loaders/customtimerange.tsx"; - - - -InputOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputOptions \{#embed-inputoptions+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - - - - - -#### InputOptions \{#embed-inputoptions+inputoptions+inputoptions\} - - - - - -Controls which data-sources and what time-range to include in scans. - - - - - -TimeRange","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customTimeRange \{#embed-inputoptions+inputoptions+inputoptions+customtimerange\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceInstances \{#embed-inputoptions+inputoptions+inputoptions+datasourceinstances\} - - - - - -List of datasource instances to consider for report/policy. - - - - - - - - - -##### datasources \{#embed-inputoptions+inputoptions+inputoptions+datasources\} - - - - - -List of datasources to consider for report. DEPRECATED - use datasourceInstances instead. - - - - - - - - - -##### datasourcesType \{#embed-inputoptions+inputoptions+inputoptions+datasourcestype\} - - - - - -The types of datasource for which to run the report/policy. - - - - - - - - - -##### timePeriodType \{#embed-inputoptions+inputoptions+inputoptions+timeperiodtype\} - - - - - -Type of time period for which to run the report/policy. PAST_DAY is deprecated. - - - - - - - - - -##### urlGreenlist \{#embed-inputoptions+inputoptions+inputoptions+urlgreenlist\} - - - - - -list of url regex matching documents excluded from report - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/interactions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/interactions.mdx deleted file mode 100644 index 80ed3941a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/interactions.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -DocumentInteractionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### interactions \{#embed-interactions+interactions\} - - - - - -describes the interactions on the document - - - - - - - - - -#### DocumentInteractionsDefinition \{#embed-interactions+interactions+documentinteractionsdefinition\} - - - - - -describes the interactions on the document - - - - - - - - - -##### numComments \{#embed-interactions+interactions+documentinteractionsdefinition+numcomments\} - - - - - - - - - -##### numLikes \{#embed-interactions+interactions+documentinteractionsdefinition+numlikes\} - - - - - - - - - -##### numViews \{#embed-interactions+interactions+documentinteractionsdefinition+numviews\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/items.mdx b/examples/docusaurus/src/components/glean-embeds/contents/items.mdx deleted file mode 100644 index a3e196ae1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/items.mdx +++ /dev/null @@ -1,412 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedshortcut from "../loaders/shortcut.tsx"; - - - -CollectionItem","children":[{"label":"CollectionItem","linkedLabel":"CollectionItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items \{#embed-items+items\} - - - - - -The items in this Collection. - - - - - - - - - -#### CollectionItem \{#embed-items+items+collectionitem\} - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-items+items+collectionitem+collection\} - - - - - - - - - - - - - -##### collectionId \{#embed-items+items+collectionitem+collectionid\} - - - - - -The Collection ID of the Collection that this CollectionItem belongs in. - - - - - - - - - -##### createdAt \{#embed-items+items+collectionitem+createdat\} - - - - - -Unix timestamp for when the item was first added (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-items+items+collectionitem+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-items+items+collectionitem+description\} - - - - - -A helpful description of why this CollectionItem is in the Collection that it's in. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-items+items+collectionitem+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### documentId \{#embed-items+items+collectionitem+documentid\} - - - - - -If this CollectionItem is indexed, the Glean Document ID of that document. - - - - - - - - - -##### icon \{#embed-items+items+collectionitem+icon\} - - - - - -The emoji icon for this CollectionItem. Only used for Text type items. - - - - - - - - - -##### itemId \{#embed-items+items+collectionitem+itemid\} - - - - - -Unique identifier for the item within the Collection it belongs to. - - - - - - - - - -##### itemType \{#embed-items+items+collectionitem+itemtype\} - - - - - - - - - -##### name \{#embed-items+items+collectionitem+name\} - - - - - -The optional name of the Collection item. - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#embed-items+items+collectionitem+shortcut\} - - - - - - - - - - - - - - - - - - - - - - - -##### url \{#embed-items+items+collectionitem+url\} - - - - - -The URL of this CollectionItem. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/lastreminder.mdx b/examples/docusaurus/src/components/glean-embeds/contents/lastreminder.mdx deleted file mode 100644 index 19269138c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/lastreminder.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedassignee from "../loaders/assignee.tsx"; -import Embedrequestor from "../loaders/requestor.tsx"; - - - -Reminder","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### lastReminder \{#embed-lastreminder+lastreminder\} - - - - - - - - - -#### Reminder \{#embed-lastreminder+lastreminder+reminder\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### assignee \{#embed-lastreminder+lastreminder+reminder+assignee\} - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#embed-lastreminder+lastreminder+reminder+createdat\} - - - - - -Unix timestamp for when the reminder was first created (in seconds since epoch UTC). - - - - - - - - - -##### reason \{#embed-lastreminder+lastreminder+reminder+reason\} - - - - - -An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - - - - - - - - - -##### remindAt \{#embed-lastreminder+lastreminder+reminder+remindat\} - - - - - -Unix timestamp for when the reminder should trigger (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### requestor \{#embed-lastreminder+lastreminder+reminder+requestor\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/lastverifier.mdx b/examples/docusaurus/src/components/glean-embeds/contents/lastverifier.mdx deleted file mode 100644 index 6fc97eaa0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/lastverifier.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### lastVerifier \{#embed-lastverifier+lastverifier\} - - - - - - - - - -#### Person \{#embed-lastverifier+lastverifier+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-lastverifier+lastverifier+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-lastverifier+lastverifier+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-lastverifier+lastverifier+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-lastverifier+lastverifier+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/likedby.mdx b/examples/docusaurus/src/components/glean-embeds/contents/likedby.mdx deleted file mode 100644 index 509a2fa58..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/likedby.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeduser from "../loaders/user.tsx"; - - - -AnswerLike","children":[{"label":"AnswerLike","linkedLabel":"AnswerLike","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likedBy \{#embed-likedby+likedby\} - - - - - - - - - -#### AnswerLike \{#embed-likedby+likedby+answerlike\} - - - - - - - - - -##### createTime \{#embed-likedby+likedby+answerlike+createtime\} - - - - - -The time the user liked the answer in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### user \{#embed-likedby+likedby+answerlike+user\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/likes.mdx b/examples/docusaurus/src/components/glean-embeds/contents/likes.mdx deleted file mode 100644 index 6549bfe77..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/likes.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedlikedby from "../loaders/likedby.tsx"; - - - -AnswerLikes","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes \{#embed-likes+likes\} - - - - - - - - - -#### AnswerLikes \{#embed-likes+likes+answerlikes\} - - - - - -AnswerLike","children":[{"label":"AnswerLike","linkedLabel":"AnswerLike","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### likedBy \{#embed-likes+likes+answerlikes+likedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### likedByUser \{#embed-likes+likes+answerlikes+likedbyuser\} - - - - - -Whether the user in context liked the answer. - - - - - - - - - -##### numLikes \{#embed-likes+likes+answerlikes+numlikes\} - - - - - -The total number of likes for the answer. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/lines.mdx b/examples/docusaurus/src/components/glean-embeds/contents/lines.mdx deleted file mode 100644 index 1ca7f7a29..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/lines.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedranges from "../loaders/ranges.tsx"; - - - -CodeLine","children":[{"label":"CodeLine","linkedLabel":"CodeLine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### lines \{#embed-lines+lines\} - - - - - - - - - -#### CodeLine \{#embed-lines+lines+codeline\} - - - - - - - - - -##### content \{#embed-lines+lines+codeline+content\} - - - - - - - - - -##### lineNumber \{#embed-lines+lines+codeline+linenumber\} - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-lines+lines+codeline+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/lowperformingqueryinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/lowperformingqueryinsights.mdx deleted file mode 100644 index 37d4a67ab..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/lowperformingqueryinsights.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedclickcount from "../loaders/clickcount.tsx"; -import Embedsearchcount from "../loaders/searchcount.tsx"; -import Embedsearchwithclickcount from "../loaders/searchwithclickcount.tsx"; -import Embedsearchorcount from "../loaders/searchorcount.tsx"; -import Embedsimilarqueries from "../loaders/similarqueries.tsx"; - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### lowPerformingQueryInsights \{#embed-lowperformingqueryinsights+lowperformingqueryinsights\} - - - - - -Insights for queries. - - - - - - - - - -#### QueryInsight \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clickCount \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+clickcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### query \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+query\} - - - - - -The query string the information is about. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchCount \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+searchcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchWithClickCount \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+searchwithclickcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchorCount \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+searchorcount\} - - - - - - - - - - - - - - - - - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### similarQueries \{#embed-lowperformingqueryinsights+lowperformingqueryinsights+queryinsight+similarqueries\} - - - - - -Insights for queries. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/meeting.mdx b/examples/docusaurus/src/components/glean-embeds/contents/meeting.mdx deleted file mode 100644 index 0ea038490..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/meeting.mdx +++ /dev/null @@ -1,209 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedattendees from "../loaders/attendees.tsx"; - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### meeting \{#embed-meeting+meeting\} - - - - - - - - - -#### Meeting \{#embed-meeting+meeting+meeting\} - - - - - -CalendarAttendees","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attendees \{#embed-meeting+meeting+meeting+attendees\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-meeting+meeting+meeting+description\} - - - - - - - - - -##### endTime \{#embed-meeting+meeting+meeting+endtime\} - - - - - - - - - -##### id \{#embed-meeting+meeting+meeting+id\} - - - - - - - - - -##### startTime \{#embed-meeting+meeting+meeting+starttime\} - - - - - - - - - -##### title \{#embed-meeting+meeting+meeting+title\} - - - - - - - - - -##### url \{#embed-meeting+meeting+meeting+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/members.mdx b/examples/docusaurus/src/components/glean-embeds/contents/members.mdx deleted file mode 100644 index 968598498..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/members.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -PersonToTeamRelationship","children":[{"label":"PersonToTeamRelationship","linkedLabel":"PersonToTeamRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### members \{#embed-members+members\} - - - - - -The members on this team - - - - - - - - - -#### PersonToTeamRelationship \{#embed-members+members+persontoteamrelationship\} - - - - - -Metadata about the relationship of a person to a team. - - - - - - - - - -##### customRelationshipStr \{#embed-members+members+persontoteamrelationship+customrelationshipstr\} - - - - - -Displayed name for the relationship if relationship is set to `OTHER`. - - - - - - - - - -##### joinDate \{#embed-members+members+persontoteamrelationship+joindate\} - - - - - -The team member's start date - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-members+members+persontoteamrelationship+person\} - - - - - - - - - - - - - -##### relationship \{#embed-members+members+persontoteamrelationship+relationship\} - - - - - -The team member's relationship to the team. This defaults to MEMBER if not set. - - - - - -_Default Value:_ `"MEMBER"` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/mergedcustomers.mdx b/examples/docusaurus/src/components/glean-embeds/contents/mergedcustomers.mdx deleted file mode 100644 index e3d2277cc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/mergedcustomers.mdx +++ /dev/null @@ -1,337 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcompany from "../loaders/company.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedpoc from "../loaders/poc.tsx"; - - - -Customer","children":[{"label":"Customer","linkedLabel":"Customer","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### mergedCustomers \{#embed-mergedcustomers+mergedcustomers\} - - - - - -A list of Customers. - - - - - - - - - -#### Customer \{#embed-mergedcustomers+mergedcustomers+customer\} - - - - - -Company","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### company \{#embed-mergedcustomers+mergedcustomers+customer+company\} - - - - - - - - - - - - - - - - - - - - - - - -##### contractAnnualRevenue \{#embed-mergedcustomers+mergedcustomers+customer+contractannualrevenue\} - - - - - -Average contract annual revenue with that customer. - - - - - - - - - -##### documentCounts \{#embed-mergedcustomers+mergedcustomers+customer+documentcounts\} - - - - - -A map of \{string, int\} pairs representing counts of each document type associated with this customer. - - - - - - - - - -##### domains \{#embed-mergedcustomers+mergedcustomers+customer+domains\} - - - - - -Link to company's associated website domains. - - - - - - - - - -##### id \{#embed-mergedcustomers+mergedcustomers+customer+id\} - - - - - -Unique identifier. - - - - - -CustomerMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-mergedcustomers+mergedcustomers+customer+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### notes \{#embed-mergedcustomers+mergedcustomers+customer+notes\} - - - - - -User facing (potentially generated) notes about company. - - - - - -_Example:_ - -``` -CIO is interested in trying out the product. -``` - - - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### poc \{#embed-mergedcustomers+mergedcustomers+customer+poc\} - - - - - -A list of POC for company. - - - - - - - - - - - - - - - - - - - - - - - -##### startDate \{#embed-mergedcustomers+mergedcustomers+customer+startdate\} - - - - - -The date when the interaction with customer started. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/messages.mdx b/examples/docusaurus/src/components/glean-embeds/contents/messages.mdx deleted file mode 100644 index 92df9d928..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/messages.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontent from "../loaders/content.tsx"; - - - -Message","children":[{"label":"Message","linkedLabel":"Message","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages \{#embed-messages+messages\} - - - - - -The messages to pass an input to the agent. - - - - - - - - - -#### Message \{#embed-messages+messages+message\} - - - - - -MessageTextBlock","children":[{"label":"MessageTextBlock","linkedLabel":"MessageTextBlock","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-messages+messages+message+content\} - - - - - -The content of the message. - - - - - - - - - - - - - - - - - - - - - - - -##### role \{#embed-messages+messages+message+role\} - - - - - -The role of the message. - - - - - -_Example:_ - -``` -USER -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/metadata.mdx b/examples/docusaurus/src/components/glean-embeds/contents/metadata.mdx deleted file mode 100644 index ec4698873..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/metadata.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Metadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### metadata \{#embed-metadata+metadata\} - - - - - -The agent metadata. Currently not implemented. - - - - - - - - - -#### Metadata \{#embed-metadata+metadata+metadata\} - - - - - -The agent metadata. Currently not implemented. - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/mustincludesuggestions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/mustincludesuggestions.mdx deleted file mode 100644 index 6899c9d2a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/mustincludesuggestions.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedsuggestions from "../loaders/suggestions.tsx"; - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### mustIncludeSuggestions \{#embed-mustincludesuggestions+mustincludesuggestions\} - - - - - - - - - -#### QuerySuggestionList \{#embed-mustincludesuggestions+mustincludesuggestions+querysuggestionlist\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-mustincludesuggestions+mustincludesuggestions+querysuggestionlist+person\} - - - - - - - - - -QuerySuggestion","children":[{"label":"QuerySuggestion","linkedLabel":"QuerySuggestion","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### suggestions \{#embed-mustincludesuggestions+mustincludesuggestions+querysuggestionlist+suggestions\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/objects.mdx b/examples/docusaurus/src/components/glean-embeds/contents/objects.mdx deleted file mode 100644 index d1a7d3b54..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/objects.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -RelatedObject","children":[{"label":"RelatedObject","linkedLabel":"RelatedObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### objects \{#embed-objects+objects\} - - - - - - - - - -#### RelatedObject \{#embed-objects+objects+relatedobject\} - - - - - - - - - -##### id \{#embed-objects+objects+relatedobject+id\} - - - - - -The ID of the related object - - - - - -metadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-objects+objects+relatedobject+metadata\} - - - - - -Some metadata of the object which can be displayed, while not having the actual object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/operatormetadata.mdx b/examples/docusaurus/src/components/glean-embeds/contents/operatormetadata.mdx deleted file mode 100644 index fd79e6acf..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/operatormetadata.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedscopes from "../loaders/scopes.tsx"; - - - -OperatorMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### operatorMetadata \{#embed-operatormetadata+operatormetadata\} - - - - - - - - - -#### OperatorMetadata \{#embed-operatormetadata+operatormetadata+operatormetadata\} - - - - - - - - - -##### displayValue \{#embed-operatormetadata+operatormetadata+operatormetadata+displayvalue\} - - - - - -Human readable value of the operator that can be shown to the user. Only applies when result is an operator value. - - - - - - - - - -##### helpText \{#embed-operatormetadata+operatormetadata+operatormetadata+helptext\} - - - - - - - - - -##### isCustom \{#embed-operatormetadata+operatormetadata+operatormetadata+iscustom\} - - - - - -Whether this operator is supported by default or something that was created within a workplace app (e.g. custom jira field). - - - - - - - - - -##### name \{#embed-operatormetadata+operatormetadata+operatormetadata+name\} - - - - - - - - - -##### operatorType \{#embed-operatormetadata+operatormetadata+operatormetadata+operatortype\} - - - - - -OperatorScope","children":[{"label":"OperatorScope","linkedLabel":"OperatorScope","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### scopes \{#embed-operatormetadata+operatormetadata+operatormetadata+scopes\} - - - - - - - - - - - - - - - - - - - - - - - -##### value \{#embed-operatormetadata+operatormetadata+operatormetadata+value\} - - - - - -Raw/canonical value of the operator. Only applies when result is an operator value. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/owner.mdx b/examples/docusaurus/src/components/glean-embeds/contents/owner.mdx deleted file mode 100644 index 069f9b3b2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/owner.mdx +++ /dev/null @@ -1,136 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -UserReferenceDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### owner \{#embed-owner+owner\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - -#### UserReferenceDefinition \{#embed-owner+owner+userreferencedefinition\} - - - - - -Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - - - - - - - - - -##### datasourceUserId \{#embed-owner+owner+userreferencedefinition+datasourceuserid\} - - - - - -some datasources refer to the user by the datasource user id in the document - - - - - - - - - -##### email \{#embed-owner+owner+userreferencedefinition+email\} - - - - - - - - - -##### name \{#embed-owner+owner+userreferencedefinition+name\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/parameters.mdx b/examples/docusaurus/src/components/glean-embeds/contents/parameters.mdx deleted file mode 100644 index 439f4974e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/parameters.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedpossiblevalues from "../loaders/possiblevalues.tsx"; - - - -WriteActionParameter","children":[{"label":"WriteActionParameter","linkedLabel":"WriteActionParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### parameters \{#embed-parameters+parameters\} - - - - - -Parameters supported by the tool. - - - - - - - - - -#### WriteActionParameter \{#embed-parameters+parameters+writeactionparameter\} - - - - - - - - - -##### description \{#embed-parameters+parameters+writeactionparameter+description\} - - - - - -Description of the parameter. - - - - - - - - - -##### displayName \{#embed-parameters+parameters+writeactionparameter+displayname\} - - - - - -Human readable display name for the key. - - - - - - - - - -##### isRequired \{#embed-parameters+parameters+writeactionparameter+isrequired\} - - - - - -Is the parameter a required field. - - - - - -PossibleValue","children":[{"label":"PossibleValue","linkedLabel":"PossibleValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### possibleValues \{#embed-parameters+parameters+writeactionparameter+possiblevalues\} - - - - - -Possible values that the parameter can take. - - - - - - - - - - - - - - - - - - - - - - - -##### type \{#embed-parameters+parameters+writeactionparameter+type\} - - - - - -The type of the value (e.g., integer, string, boolean, etc.) - - - - - - - - - -##### value \{#embed-parameters+parameters+writeactionparameter+value\} - - - - - -The value of the field. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/params.mdx b/examples/docusaurus/src/components/glean-embeds/contents/params.mdx deleted file mode 100644 index b08d2866f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/params.mdx +++ /dev/null @@ -1,285 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ActivityEventParams","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### params \{#embed-params+params\} - - - - - - - - - -#### ActivityEventParams \{#embed-params+params+activityeventparams\} - - - - - - - - - -##### bodyContent \{#embed-params+params+activityeventparams+bodycontent\} - - - - - -The HTML content of the page body. - - - - - - - - - -##### datasource \{#embed-params+params+activityeventparams+datasource\} - - - - - -The datasource without the instance inferred from the URL of the event - - - - - - - - - -##### datasourceInstance \{#embed-params+params+activityeventparams+datasourceinstance\} - - - - - -The full datasource instance name inferred from the URL of the event - - - - - - - - - -##### duration \{#embed-params+params+activityeventparams+duration\} - - - - - -Length in seconds of the activity. For VIEWS, this represents the amount the page was visible in the foreground. - - - - - - - - - -##### instanceOnlyName \{#embed-params+params+activityeventparams+instanceonlyname\} - - - - - -The instance only name of the datasource instance, e.g. 1 for jira_1, inferred from the URL of the event - - - - - - - - - -##### query \{#embed-params+params+activityeventparams+query\} - - - - - -The user's search query associated with a SEARCH. - - - - - - - - - -##### referrer \{#embed-params+params+activityeventparams+referrer\} - - - - - -The referring URL of the VIEW or SEARCH. - - - - - - - - - -##### title \{#embed-params+params+activityeventparams+title\} - - - - - -The page title associated with the URL of the event - - - - - - - - - -##### truncated \{#embed-params+params+activityeventparams+truncated\} - - - - - -Indicates that the parameters are incomplete and more parameters may be sent with the same action+timestamp+URL in the future. This is used for sending the duration when a `VIEW` is finished. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/parentdocument.mdx b/examples/docusaurus/src/components/glean-embeds/contents/parentdocument.mdx deleted file mode 100644 index 0023e9242..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/parentdocument.mdx +++ /dev/null @@ -1,343 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### parentDocument \{#embed-parentdocument+parentdocument\} - - - - - - - - - -#### Document \{#embed-parentdocument+parentdocument+document\} - - - - - - - - - -##### connectorType \{#embed-parentdocument+parentdocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-parentdocument+parentdocument+document+containerdocument\} - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-parentdocument+parentdocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-parentdocument+parentdocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-parentdocument+parentdocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-parentdocument+parentdocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-parentdocument+parentdocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-parentdocument+parentdocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-parentdocument+parentdocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-parentdocument+parentdocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/people.mdx b/examples/docusaurus/src/components/glean-embeds/contents/people.mdx deleted file mode 100644 index 7ed005b74..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/people.mdx +++ /dev/null @@ -1,204 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedgroupattendees from "../loaders/groupattendees.tsx"; - - - -CalendarAttendee","children":[{"label":"CalendarAttendee","linkedLabel":"CalendarAttendee","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### people \{#embed-people+people\} - - - - - -Full details of some of the attendees of this event - - - - - - - - - -#### CalendarAttendee \{#embed-people+people+calendarattendee\} - - - - - -CalendarAttendee","children":[{"label":"CalendarAttendee","linkedLabel":"CalendarAttendee","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### groupAttendees \{#embed-people+people+calendarattendee+groupattendees\} - - - - - -Full details of some of the attendees of this event - - - - - - - - - - - - - - - - - - - - - - - -##### isInGroup \{#embed-people+people+calendarattendee+isingroup\} - - - - - -Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility. - - - - - - - - - -##### isOrganizer \{#embed-people+people+calendarattendee+isorganizer\} - - - - - -Whether or not this attendee is an organizer. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-people+people+calendarattendee+person\} - - - - - - - - - - - - - -##### responseStatus \{#embed-people+people+calendarattendee+responsestatus\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/period.mdx b/examples/docusaurus/src/components/glean-embeds/contents/period.mdx deleted file mode 100644 index 8be5bc334..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/period.mdx +++ /dev/null @@ -1,180 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedend from "../loaders/end.tsx"; -import Embedstart from "../loaders/start.tsx"; - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### period \{#embed-period+period\} - - - - - - - - - -#### Period \{#embed-period+period+period\} - - - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### end \{#embed-period+period+period+end\} - - - - - - - - - - - - - - - - - - - - - - - -##### maxDaysFromNow \{#embed-period+period+period+maxdaysfromnow\} - - - - - -DEPRECATED - The number of days from now in the past to define lower boundary of time period. - - - - - - - - - -##### minDaysFromNow \{#embed-period+period+period+mindaysfromnow\} - - - - - -DEPRECATED - The number of days from now in the past to define upper boundary of time period. - - - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### start \{#embed-period+period+period+start\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/permissions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/permissions.mdx deleted file mode 100644 index 383368996..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/permissions.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedwrite from "../loaders/write.tsx"; - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### permissions \{#embed-permissions+permissions\} - - - - - - - - - -#### ObjectPermissions \{#embed-permissions+permissions+objectpermissions\} - - - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### write \{#embed-permissions+permissions+objectpermissions+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/person.mdx b/examples/docusaurus/src/components/glean-embeds/contents/person.mdx deleted file mode 100644 index 299301911..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/person.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### person \{#embed-person+person\} - - - - - - - - - -#### Person \{#embed-person+person+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-person+person+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-person+person+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-person+person+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-person+person+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/pinmetadata.mdx b/examples/docusaurus/src/components/glean-embeds/contents/pinmetadata.mdx deleted file mode 100644 index 87d87bd53..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/pinmetadata.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedeligiblepins from "../loaders/eligiblepins.tsx"; -import Embedexistingpins from "../loaders/existingpins.tsx"; - - - -CollectionPinnedMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pinMetadata \{#embed-pinmetadata+pinmetadata\} - - - - - - - - - -#### CollectionPinnedMetadata \{#embed-pinmetadata+pinmetadata+collectionpinnedmetadata\} - - - - - -CollectionPinMetadata","children":[{"label":"CollectionPinMetadata","linkedLabel":"CollectionPinMetadata","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### eligiblePins \{#embed-pinmetadata+pinmetadata+collectionpinnedmetadata+eligiblepins\} - - - - - -List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - - - - - - - - - - - - - - - - - - - -CollectionPinTarget","children":[{"label":"CollectionPinTarget","linkedLabel":"CollectionPinTarget","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### existingPins \{#embed-pinmetadata+pinmetadata+collectionpinnedmetadata+existingpins\} - - - - - -List of targets this Collection is pinned to. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/pins.mdx b/examples/docusaurus/src/components/glean-embeds/contents/pins.mdx deleted file mode 100644 index ebc026fd3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/pins.mdx +++ /dev/null @@ -1,293 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedattribution from "../loaders/attribution.tsx"; -import Embedaudiencefilters from "../loaders/audiencefilters.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pins \{#embed-pins+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - -#### PinDocument \{#embed-pins+pins+pindocument\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attribution \{#embed-pins+pins+pindocument+attribution\} - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### audienceFilters \{#embed-pins+pins+pindocument+audiencefilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### createTime \{#embed-pins+pins+pindocument+createtime\} - - - - - - - - - -##### documentId \{#embed-pins+pins+pindocument+documentid\} - - - - - -The document which should be a pinned result. - - - - - - - - - -##### id \{#embed-pins+pins+pindocument+id\} - - - - - -The opaque id of the pin. - - - - - - - - - -##### queries \{#embed-pins+pins+pindocument+queries\} - - - - - -The query strings for which the pinned result will show. - - - - - - - - - -##### updateTime \{#embed-pins+pins+pindocument+updatetime\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-pins+pins+pindocument+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/poc.mdx b/examples/docusaurus/src/components/glean-embeds/contents/poc.mdx deleted file mode 100644 index 39b94591b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/poc.mdx +++ /dev/null @@ -1,181 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Person","children":[{"label":"Person","linkedLabel":"Person","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### poc \{#embed-poc+poc\} - - - - - -A list of POC for company. - - - - - - - - - -#### Person \{#embed-poc+poc+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-poc+poc+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-poc+poc+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-poc+poc+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-poc+poc+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/possiblevalues.mdx b/examples/docusaurus/src/components/glean-embeds/contents/possiblevalues.mdx deleted file mode 100644 index f93608567..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/possiblevalues.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -PossibleValue","children":[{"label":"PossibleValue","linkedLabel":"PossibleValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### possibleValues \{#embed-possiblevalues+possiblevalues\} - - - - - -Possible values that the parameter can take. - - - - - - - - - -#### PossibleValue \{#embed-possiblevalues+possiblevalues+possiblevalue\} - - - - - -Possible value of a specific parameter - - - - - - - - - -##### label \{#embed-possiblevalues+possiblevalues+possiblevalue+label\} - - - - - -User-friendly label associated with the value - - - - - - - - - -##### value \{#embed-possiblevalues+possiblevalues+possiblevalue+value\} - - - - - -Possible value - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/primaryentry.mdx b/examples/docusaurus/src/components/glean-embeds/contents/primaryentry.mdx deleted file mode 100644 index ff75e861a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/primaryentry.mdx +++ /dev/null @@ -1,788 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivities from "../loaders/activities.tsx"; -import Embedannouncement from "../loaders/announcement.tsx"; -import Embedapp from "../loaders/app.tsx"; -import Embedchatsuggestion from "../loaders/chatsuggestion.tsx"; -import Embedcollection from "../loaders/collection.tsx"; -import Embedcollectionitem from "../loaders/collectionitem.tsx"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embeddigest from "../loaders/digest.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embeddocumentvisitorcount from "../loaders/documentvisitorcount.tsx"; -import Embedevent from "../loaders/event.tsx"; -import Embedperson from "../loaders/person.tsx"; -import Embedprompttemplate from "../loaders/prompttemplate.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embeduiconfig from "../loaders/uiconfig.tsx"; -import Embedworkflow from "../loaders/workflow.tsx"; - - - -FeedEntry","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### primaryEntry \{#embed-primaryentry+primaryentry\} - - - - - - - - - -#### FeedEntry \{#embed-primaryentry+primaryentry+feedentry\} - - - - - -UserActivity","children":[{"label":"UserActivity","linkedLabel":"UserActivity","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activities \{#embed-primaryentry+primaryentry+feedentry+activities\} - - - - - -List of activity where each activity has user, action, timestamp. - - - - - - - - - - - - - - - - - - - -Announcement","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### announcement \{#embed-primaryentry+primaryentry+feedentry+announcement\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#embed-primaryentry+primaryentry+feedentry+app\} - - - - - - - - - - - - - - - - - - - -ChatSuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chatSuggestion \{#embed-primaryentry+primaryentry+feedentry+chatsuggestion\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-primaryentry+primaryentry+feedentry+collection\} - - - - - - - - - - - - - - - - - - - -CollectionItem","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collectionItem \{#embed-primaryentry+primaryentry+feedentry+collectionitem\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-primaryentry+primaryentry+feedentry+createdby\} - - - - - - - - - - - - - - - - - - - -Digest","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### digest \{#embed-primaryentry+primaryentry+feedentry+digest\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-primaryentry+primaryentry+feedentry+document\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentVisitorCount \{#embed-primaryentry+primaryentry+feedentry+documentvisitorcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### entryId \{#embed-primaryentry+primaryentry+feedentry+entryid\} - - - - - -optional ID associated with a single feed entry (displayable_list_id) - - - - - -CalendarEvent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### event \{#embed-primaryentry+primaryentry+feedentry+event\} - - - - - -A generic, light-weight calendar event. - - - - - - - - - - - - - - - - - - - - - - - -##### justification \{#embed-primaryentry+primaryentry+feedentry+justification\} - - - - - -Server side generated justification string if server provides one. - - - - - - - - - -##### justificationType \{#embed-primaryentry+primaryentry+feedentry+justificationtype\} - - - - - -Type of the justification. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-primaryentry+primaryentry+feedentry+person\} - - - - - - - - - - - - - - - - - - - -PromptTemplateResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### promptTemplate \{#embed-primaryentry+primaryentry+feedentry+prompttemplate\} - - - - - - - - - - - - - - - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-primaryentry+primaryentry+feedentry+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-primaryentry+primaryentry+feedentry+title\} - - - - - -Title for the result. Can be document title, event title and so on. - - - - - - - - - -##### trackingToken \{#embed-primaryentry+primaryentry+feedentry+trackingtoken\} - - - - - -An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - - - - - -uiConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### uiConfig \{#embed-primaryentry+primaryentry+feedentry+uiconfig\} - - - - - - - - - - - - - - - - - - - - - - - -##### viewUrl \{#embed-primaryentry+primaryentry+feedentry+viewurl\} - - - - - -View URL for the entry if based on links that are not documents in Glean. - - - - - -WorkflowResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### workflow \{#embed-primaryentry+primaryentry+feedentry+workflow\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/prompttemplate.mdx b/examples/docusaurus/src/components/glean-embeds/contents/prompttemplate.mdx deleted file mode 100644 index 071f1d7e0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/prompttemplate.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedfavoriteinfo from "../loaders/favoriteinfo.tsx"; -import Embedruncount from "../loaders/runcount.tsx"; - - - -PromptTemplateResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### promptTemplate \{#embed-prompttemplate+prompttemplate\} - - - - - - - - - -#### PromptTemplateResult \{#embed-prompttemplate+prompttemplate+prompttemplateresult\} - - - - - -FavoriteInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### favoriteInfo \{#embed-prompttemplate+prompttemplate+prompttemplateresult+favoriteinfo\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### runCount \{#embed-prompttemplate+prompttemplate+prompttemplateresult+runcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#embed-prompttemplate+prompttemplate+prompttemplateresult+trackingtoken\} - - - - - -An opaque token that represents this prompt template - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/properties.mdx b/examples/docusaurus/src/components/glean-embeds/contents/properties.mdx deleted file mode 100644 index ce6c0ee5f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/properties.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeditems from "../loaders/items.tsx"; - - - -ToolsCallParameter","children":[{"label":"ToolsCallParameter","linkedLabel":"ToolsCallParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### properties \{#embed-properties+properties\} - - - - - -The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - - - - - - - - - -#### ToolsCallParameter \{#embed-properties+properties+toolscallparameter\} - - - - - -ToolsCallParameter","children":[{"label":"ToolsCallParameter","linkedLabel":"ToolsCallParameter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### items \{#embed-properties+properties+toolscallparameter+items\} - - - - - -The value of the parameter (for array types) - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-properties+properties+toolscallparameter+name\} - - - - - -The name of the parameter - - - - - - - - - -##### value \{#embed-properties+properties+toolscallparameter+value\} - - - - - -The value of the parameter (for primitive types) - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/propertydefinitions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/propertydefinitions.mdx deleted file mode 100644 index 8ba0cb85b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/propertydefinitions.mdx +++ /dev/null @@ -1,279 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -PropertyDefinition","children":[{"label":"PropertyDefinition","linkedLabel":"PropertyDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### propertyDefinitions \{#embed-propertydefinitions+propertydefinitions\} - - - - - - - - - -#### PropertyDefinition \{#embed-propertydefinitions+propertydefinitions+propertydefinition\} - - - - - - - - - -##### displayLabel \{#embed-propertydefinitions+propertydefinitions+propertydefinition+displaylabel\} - - - - - -The user friendly label for the property. - - - - - - - - - -##### displayLabelPlural \{#embed-propertydefinitions+propertydefinitions+propertydefinition+displaylabelplural\} - - - - - -The user friendly label for the property that will be used if a plural context. - - - - - - - - - -##### group \{#embed-propertydefinitions+propertydefinitions+propertydefinition+group\} - - - - - -The unique identifier of the `PropertyGroup` to which this property belongs. - - - - - - - - - -##### hideUiFacet \{#embed-propertydefinitions+propertydefinitions+propertydefinition+hideuifacet\} - - - - - -If true then the property will not show up as a facet in the UI. - - - - - - - - - -##### name \{#embed-propertydefinitions+propertydefinitions+propertydefinition+name\} - - - - - -The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. - - - - - - - - - -##### propertyType \{#embed-propertydefinitions+propertydefinitions+propertydefinition+propertytype\} - - - - - -The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. - - - - - - - - - -##### skipIndexing \{#embed-propertydefinitions+propertydefinitions+propertydefinition+skipindexing\} - - - - - -If true then the property will not be indexed for retrieval and ranking. - - - - - - - - - -##### uiFacetOrder \{#embed-propertydefinitions+propertydefinitions+propertydefinition+uifacetorder\} - - - - - -Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. - - - - - - - - - -##### uiOptions \{#embed-propertydefinitions+propertydefinitions+propertydefinition+uioptions\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/propertygroups.mdx b/examples/docusaurus/src/components/glean-embeds/contents/propertygroups.mdx deleted file mode 100644 index a4b0616d4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/propertygroups.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -PropertyGroup","children":[{"label":"PropertyGroup","linkedLabel":"PropertyGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### propertyGroups \{#embed-propertygroups+propertygroups\} - - - - - -A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI. - - - - - - - - - -#### PropertyGroup \{#embed-propertygroups+propertygroups+propertygroup\} - - - - - -A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI. - - - - - - - - - -##### displayLabel \{#embed-propertygroups+propertygroups+propertygroup+displaylabel\} - - - - - -The user-friendly group label to display. - - - - - - - - - -##### name \{#embed-propertygroups+propertygroups+propertygroup+name\} - - - - - -The unique identifier of the group. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/proximity.mdx b/examples/docusaurus/src/components/glean-embeds/contents/proximity.mdx deleted file mode 100644 index 6a9366366..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/proximity.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -HotwordProximity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### proximity \{#embed-proximity+proximity\} - - - - - - - - - -#### HotwordProximity \{#embed-proximity+proximity+hotwordproximity\} - - - - - - - - - -##### windowAfter \{#embed-proximity+proximity+hotwordproximity+windowafter\} - - - - - - - - - -##### windowBefore \{#embed-proximity+proximity+hotwordproximity+windowbefore\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/queryinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/queryinsights.mdx deleted file mode 100644 index 27a0d7725..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/queryinsights.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedclickcount from "../loaders/clickcount.tsx"; -import Embedsearchcount from "../loaders/searchcount.tsx"; -import Embedsearchwithclickcount from "../loaders/searchwithclickcount.tsx"; -import Embedsearchorcount from "../loaders/searchorcount.tsx"; -import Embedsimilarqueries from "../loaders/similarqueries.tsx"; - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### queryInsights \{#embed-queryinsights+queryinsights\} - - - - - -Insights for queries. - - - - - - - - - -#### QueryInsight \{#embed-queryinsights+queryinsights+queryinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clickCount \{#embed-queryinsights+queryinsights+queryinsight+clickcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### query \{#embed-queryinsights+queryinsights+queryinsight+query\} - - - - - -The query string the information is about. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchCount \{#embed-queryinsights+queryinsights+queryinsight+searchcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchWithClickCount \{#embed-queryinsights+queryinsights+queryinsight+searchwithclickcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchorCount \{#embed-queryinsights+queryinsights+queryinsight+searchorcount\} - - - - - - - - - - - - - - - - - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### similarQueries \{#embed-queryinsights+queryinsights+queryinsight+similarqueries\} - - - - - -Insights for queries. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/querysuggestion.mdx b/examples/docusaurus/src/components/glean-embeds/contents/querysuggestion.mdx deleted file mode 100644 index 8eb76de5d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/querysuggestion.mdx +++ /dev/null @@ -1,316 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedinputdetails from "../loaders/inputdetails.tsx"; -import Embedranges from "../loaders/ranges.tsx"; -import Embedrequestoptions from "../loaders/requestoptions.tsx"; -import Embedsearchproviderinfo from "../loaders/searchproviderinfo.tsx"; - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### querySuggestion \{#embed-querysuggestion+querysuggestion\} - - - - - - - - - -#### QuerySuggestion \{#embed-querysuggestion+querysuggestion+querysuggestion\} - - - - - - - - - -##### datasource \{#embed-querysuggestion+querysuggestion+querysuggestion+datasource\} - - - - - -The datasource associated with the suggestion. - - - - - -SearchRequestInputDetails","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputDetails \{#embed-querysuggestion+querysuggestion+querysuggestion+inputdetails\} - - - - - - - - - - - - - - - - - - - - - - - -##### label \{#embed-querysuggestion+querysuggestion+querysuggestion+label\} - - - - - -A user-facing description to display for the suggestion. - - - - - - - - - -##### missingTerm \{#embed-querysuggestion+querysuggestion+querysuggestion+missingterm\} - - - - - -A query term missing from the original query on which this suggestion is based. - - - - - - - - - -##### query \{#embed-querysuggestion+querysuggestion+querysuggestion+query\} - - - - - -The query being suggested (e.g. enforcing the missing term from the original query). - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-querysuggestion+querysuggestion+querysuggestion+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - -SearchRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### requestOptions \{#embed-querysuggestion+querysuggestion+querysuggestion+requestoptions\} - - - - - - - - - - - - - - - - - - - -SearchProviderInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchProviderInfo \{#embed-querysuggestion+querysuggestion+querysuggestion+searchproviderinfo\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/querysuggestions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/querysuggestions.mdx deleted file mode 100644 index 61af4e11a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/querysuggestions.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedsuggestions from "../loaders/suggestions.tsx"; - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### querySuggestions \{#embed-querysuggestions+querysuggestions\} - - - - - - - - - -#### QuerySuggestionList \{#embed-querysuggestions+querysuggestions+querysuggestionlist\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-querysuggestions+querysuggestions+querysuggestionlist+person\} - - - - - - - - - -QuerySuggestion","children":[{"label":"QuerySuggestion","linkedLabel":"QuerySuggestion","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### suggestions \{#embed-querysuggestions+querysuggestions+querysuggestionlist+suggestions\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/questionresult.mdx b/examples/docusaurus/src/components/glean-embeds/contents/questionresult.mdx deleted file mode 100644 index 669cccdae..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/questionresult.mdx +++ /dev/null @@ -1,680 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; -import Embedmustincludesuggestions from "../loaders/mustincludesuggestions.tsx"; -import Embedpins from "../loaders/pins.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../loaders/relatedresults.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; - - - -SearchResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### questionResult \{#embed-questionresult+questionresult\} - - - - - - - - - -#### SearchResult \{#embed-questionresult+questionresult+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#embed-questionresult+questionresult+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - -##### attachmentContext \{#embed-questionresult+questionresult+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#embed-questionresult+questionresult+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#embed-questionresult+questionresult+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#embed-questionresult+questionresult+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - -##### clusterType \{#embed-questionresult+questionresult+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#embed-questionresult+questionresult+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-questionresult+questionresult+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#embed-questionresult+questionresult+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#embed-questionresult+questionresult+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#embed-questionresult+questionresult+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#embed-questionresult+questionresult+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#embed-questionresult+questionresult+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-questionresult+questionresult+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-questionresult+questionresult+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#embed-questionresult+questionresult+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-questionresult+questionresult+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-questionresult+questionresult+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - -##### title \{#embed-questionresult+questionresult+searchresult+title\} - - - - - - - - - -##### trackingToken \{#embed-questionresult+questionresult+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#embed-questionresult+questionresult+searchresult+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/quicklink.mdx b/examples/docusaurus/src/components/glean-embeds/contents/quicklink.mdx deleted file mode 100644 index ab0dc863f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/quicklink.mdx +++ /dev/null @@ -1,240 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embediconconfig from "../loaders/iconconfig.tsx"; - - - -Quicklink","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### quicklink \{#embed-quicklink+quicklink\} - - - - - -An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - - - - - - - - - -#### Quicklink \{#embed-quicklink+quicklink+quicklink\} - - - - - -An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#embed-quicklink+quicklink+quicklink+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### id \{#embed-quicklink+quicklink+quicklink+id\} - - - - - -Unique identifier of this quicklink - - - - - - - - - -##### name \{#embed-quicklink+quicklink+quicklink+name\} - - - - - -Full action name. Used in autocomplete. - - - - - - - - - -##### scopes \{#embed-quicklink+quicklink+quicklink+scopes\} - - - - - -The scopes for which this quicklink is applicable - - - - - - - - - -##### shortName \{#embed-quicklink+quicklink+quicklink+shortname\} - - - - - -Shortened name. Used in app cards. - - - - - - - - - -##### url \{#embed-quicklink+quicklink+quicklink+url\} - - - - - -The URL of the action. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/ranges.mdx b/examples/docusaurus/src/components/glean-embeds/contents/ranges.mdx deleted file mode 100644 index 72e47e968..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/ranges.mdx +++ /dev/null @@ -1,203 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### ranges \{#embed-ranges+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - -#### TextRange \{#embed-ranges+ranges+textrange\} - - - - - -A subsection of a given string to which some special formatting should be applied. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-ranges+ranges+textrange+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### endIndex \{#embed-ranges+ranges+textrange+endindex\} - - - - - -The exclusive end index of the range. - - - - - - - - - -##### startIndex \{#embed-ranges+ranges+textrange+startindex\} - - - - - -The inclusive start index of the range. - - - - - - - - - -##### type \{#embed-ranges+ranges+textrange+type\} - - - - - - - - - -##### url \{#embed-ranges+ranges+textrange+url\} - - - - - -The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/referenceranges.mdx b/examples/docusaurus/src/components/glean-embeds/contents/referenceranges.mdx deleted file mode 100644 index 383ab04d6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/referenceranges.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedtextrange from "../loaders/textrange.tsx"; - - - -ReferenceRange","children":[{"label":"ReferenceRange","linkedLabel":"ReferenceRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### referenceRanges \{#embed-referenceranges+referenceranges\} - - - - - -Each reference range and its corresponding snippets - - - - - - - - - -#### ReferenceRange \{#embed-referenceranges+referenceranges+referencerange\} - - - - - -Each text range from the response can correspond to an array of snippets from the citation source. - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-referenceranges+referenceranges+referencerange+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -TextRange","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### textRange \{#embed-referenceranges+referenceranges+referencerange+textrange\} - - - - - -A subsection of a given string to which some special formatting should be applied. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/relateddocuments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/relateddocuments.mdx deleted file mode 100644 index 1fb65e123..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/relateddocuments.mdx +++ /dev/null @@ -1,236 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocuments from "../loaders/documents.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedresults from "../loaders/results.tsx"; - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relatedDocuments \{#embed-relateddocuments+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - -#### RelatedDocuments \{#embed-relateddocuments+relateddocuments+relateddocuments\} - - - - - - - - - -##### associatedEntityId \{#embed-relateddocuments+relateddocuments+relateddocuments+associatedentityid\} - - - - - -Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - - - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documents \{#embed-relateddocuments+relateddocuments+relateddocuments+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - - - - - - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-relateddocuments+relateddocuments+relateddocuments+querysuggestion\} - - - - - - - - - - - - - - - - - - - - - - - -##### relation \{#embed-relateddocuments+relateddocuments+relateddocuments+relation\} - - - - - -How this document relates to the including entity. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### results \{#embed-relateddocuments+relateddocuments+relateddocuments+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/relatedobjects.mdx b/examples/docusaurus/src/components/glean-embeds/contents/relatedobjects.mdx deleted file mode 100644 index 89edc7be2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/relatedobjects.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedobjects from "../loaders/objects.tsx"; - - - -RelatedObjectEdge","children":[{"label":"RelatedObjectEdge","linkedLabel":"RelatedObjectEdge","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relatedObjects \{#embed-relatedobjects+relatedobjects\} - - - - - -A list of objects related to a source object. - - - - - - - - - -#### RelatedObjectEdge \{#embed-relatedobjects+relatedobjects+relatedobjectedge\} - - - - - -RelatedObject","children":[{"label":"RelatedObject","linkedLabel":"RelatedObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### objects \{#embed-relatedobjects+relatedobjects+relatedobjectedge+objects\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/relatedquestion.mdx b/examples/docusaurus/src/components/glean-embeds/contents/relatedquestion.mdx deleted file mode 100644 index 678127ff7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/relatedquestion.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedranges from "../loaders/ranges.tsx"; - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relatedQuestion \{#embed-relatedquestion+relatedquestion\} - - - - - - - - - -#### RelatedQuestion \{#embed-relatedquestion+relatedquestion+relatedquestion\} - - - - - - - - - -##### answer \{#embed-relatedquestion+relatedquestion+relatedquestion+answer\} - - - - - -The answer for the related question - - - - - - - - - -##### question \{#embed-relatedquestion+relatedquestion+relatedquestion+question\} - - - - - -The text of the related question - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-relatedquestion+relatedquestion+relatedquestion+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/relatedresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/relatedresults.mdx deleted file mode 100644 index 10a84799c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/relatedresults.mdx +++ /dev/null @@ -1,225 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocuments from "../loaders/documents.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relatedResults \{#embed-relatedresults+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - -#### RelatedDocuments \{#embed-relatedresults+relatedresults+relateddocuments\} - - - - - - - - - -##### associatedEntityId \{#embed-relatedresults+relatedresults+relateddocuments+associatedentityid\} - - - - - -Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - - - - - -Document","children":[{"label":"Document","linkedLabel":"Document","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documents \{#embed-relatedresults+relatedresults+relateddocuments+documents\} - - - - - -A truncated list of documents with this relation. TO BE DEPRECATED. - - - - - - - - - - - - - - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-relatedresults+relatedresults+relateddocuments+querysuggestion\} - - - - - - - - - - - - - - - - - - - - - - - -##### relation \{#embed-relatedresults+relatedresults+relateddocuments+relation\} - - - - - -How this document relates to the including entity. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### results \{#embed-relatedresults+relatedresults+relateddocuments+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/relationships.mdx b/examples/docusaurus/src/components/glean-embeds/contents/relationships.mdx deleted file mode 100644 index bd955dbf0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/relationships.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -EntityRelationship","children":[{"label":"EntityRelationship","linkedLabel":"EntityRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### relationships \{#embed-relationships+relationships\} - - - - - -List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile. - - - - - - - - - -#### EntityRelationship \{#embed-relationships+relationships+entityrelationship\} - - - - - -Describes a relationship edge between a source and destination entity - - - - - - - - - -##### email \{#embed-relationships+relationships+entityrelationship+email\} - - - - - -Email of the person with whom the relationship exists. Per the example above, either `B` or `C`'s email depending on the relationship. - - - - - - - - - -##### name \{#embed-relationships+relationships+entityrelationship+name\} - - - - - -The title or type of relationship. Currently an enum of `CHIEF_OF_STAFF`, `EXECUTIVE_ASSISTANT` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/reminders.mdx b/examples/docusaurus/src/components/glean-embeds/contents/reminders.mdx deleted file mode 100644 index ad7c849cf..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/reminders.mdx +++ /dev/null @@ -1,211 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedassignee from "../loaders/assignee.tsx"; -import Embedrequestor from "../loaders/requestor.tsx"; - - - -Reminder","children":[{"label":"Reminder","linkedLabel":"Reminder","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### reminders \{#embed-reminders+reminders\} - - - - - -Info about all outstanding verification reminders for the document if exists. - - - - - - - - - -#### Reminder \{#embed-reminders+reminders+reminder\} - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### assignee \{#embed-reminders+reminders+reminder+assignee\} - - - - - - - - - - - - - - - - - - - - - - - -##### createdAt \{#embed-reminders+reminders+reminder+createdat\} - - - - - -Unix timestamp for when the reminder was first created (in seconds since epoch UTC). - - - - - - - - - -##### reason \{#embed-reminders+reminders+reminder+reason\} - - - - - -An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - - - - - - - - - -##### remindAt \{#embed-reminders+reminders+reminder+remindat\} - - - - - -Unix timestamp for when the reminder should trigger (in seconds since epoch UTC). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### requestor \{#embed-reminders+reminders+reminder+requestor\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/removedroles.mdx b/examples/docusaurus/src/components/glean-embeds/contents/removedroles.mdx deleted file mode 100644 index 681c9bf3f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/removedroles.mdx +++ /dev/null @@ -1,169 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedgroup from "../loaders/group.tsx"; - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### removedRoles \{#embed-removedroles+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#embed-removedroles+removedroles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#embed-removedroles+removedroles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-removedroles+removedroles+userrolespecification+person\} - - - - - - - - - - - - - -##### role \{#embed-removedroles+removedroles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#embed-removedroles+removedroles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/requestoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/requestoptions.mdx deleted file mode 100644 index 026a0964c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/requestoptions.mdx +++ /dev/null @@ -1,571 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedauthtokens from "../loaders/authtokens.tsx"; -import Embedexclusions from "../loaders/exclusions.tsx"; -import Embedfacetbucketfilter from "../loaders/facetbucketfilter.tsx"; -import Embedfacetfiltersets from "../loaders/facetfiltersets.tsx"; -import Embedfacetfilters from "../loaders/facetfilters.tsx"; -import Embedinclusions from "../loaders/inclusions.tsx"; - - - -SearchRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestOptions \{#embed-requestoptions+requestoptions\} - - - - - - - - - -#### SearchRequestOptions \{#embed-requestoptions+requestoptions+searchrequestoptions\} - - - - - -AuthToken","children":[{"label":"AuthToken","linkedLabel":"AuthToken","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### authTokens \{#embed-requestoptions+requestoptions+searchrequestoptions+authtokens\} - - - - - -Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - - - - - - - - - - - - - - - - - - - - - - - -##### datasourceFilter \{#embed-requestoptions+requestoptions+searchrequestoptions+datasourcefilter\} - - - - - -Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### datasourcesFilter \{#embed-requestoptions+requestoptions+searchrequestoptions+datasourcesfilter\} - - - - - -Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - - - - - - - - - -##### defaultFacets \{#embed-requestoptions+requestoptions+searchrequestoptions+defaultfacets\} - - - - - -Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - - - - - - - - - -##### disableQueryAutocorrect \{#embed-requestoptions+requestoptions+searchrequestoptions+disablequeryautocorrect\} - - - - - -Disables automatic adjustment of the input query for spelling corrections or other reasons. - - - - - - - - - -##### disableSpellcheck \{#embed-requestoptions+requestoptions+searchrequestoptions+disablespellcheck\} - - - - - -Whether or not to disable spellcheck. - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### exclusions \{#embed-requestoptions+requestoptions+searchrequestoptions+exclusions\} - - - - - - - - - - - - - - - - - - - -FacetBucketFilter","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetBucketFilter \{#embed-requestoptions+requestoptions+searchrequestoptions+facetbucketfilter\} - - - - - - - - - - - - - - - - - - - - - - - -##### facetBucketSize \{#embed-requestoptions+requestoptions+searchrequestoptions+facetbucketsize\} - - - - - -The maximum number of FacetBuckets to return in each FacetResult. - - - - - -FacetFilterSet","children":[{"label":"FacetFilterSet","linkedLabel":"FacetFilterSet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilterSets \{#embed-requestoptions+requestoptions+searchrequestoptions+facetfiltersets\} - - - - - -A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - - - - - - - - - - - - - - - - - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### facetFilters \{#embed-requestoptions+requestoptions+searchrequestoptions+facetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - - - - - - - - - - - - - - - -##### fetchAllDatasourceCounts \{#embed-requestoptions+requestoptions+searchrequestoptions+fetchalldatasourcecounts\} - - - - - -Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - - - - - -RestrictionFilters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inclusions \{#embed-requestoptions+requestoptions+searchrequestoptions+inclusions\} - - - - - - - - - - - - - - - - - - - - - - - -##### queryOverridesFacetFilters \{#embed-requestoptions+requestoptions+searchrequestoptions+queryoverridesfacetfilters\} - - - - - -If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - - - - - - - - - -##### responseHints \{#embed-requestoptions+requestoptions+searchrequestoptions+responsehints\} - - - - - -Array of hints containing which fields should be populated in the response. - - - - - - - - - -##### returnLlmContentOverSnippets \{#embed-requestoptions+requestoptions+searchrequestoptions+returnllmcontentoversnippets\} - - - - - -Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - - - - - - - - - -##### timezoneOffset \{#embed-requestoptions+requestoptions+searchrequestoptions+timezoneoffset\} - - - - - -The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/requestor.mdx b/examples/docusaurus/src/components/glean-embeds/contents/requestor.mdx deleted file mode 100644 index ea60b6c09..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/requestor.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### requestor \{#embed-requestor+requestor\} - - - - - - - - - -#### Person \{#embed-requestor+requestor+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-requestor+requestor+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-requestor+requestor+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-requestor+requestor+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-requestor+requestor+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/responsemetadata.mdx b/examples/docusaurus/src/components/glean-embeds/contents/responsemetadata.mdx deleted file mode 100644 index d584c681d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/responsemetadata.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -responseMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### responseMetadata \{#embed-responsemetadata+responsemetadata\} - - - - - -Metadata about the response (e.g., latency, token count). - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/resultdocuments.mdx b/examples/docusaurus/src/components/glean-embeds/contents/resultdocuments.mdx deleted file mode 100644 index b986b6578..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/resultdocuments.mdx +++ /dev/null @@ -1,104 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -resultDocument","children":[{"label":"resultDocument","linkedLabel":"resultDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultDocuments \{#embed-resultdocuments+resultdocuments\} - - - - - -List of documents read by the agent. - - - - - - - - - -#### resultDocument \{#embed-resultdocuments+resultdocuments+resultdocument\} - - - - - - - - - -##### title \{#embed-resultdocuments+resultdocuments+resultdocument+title\} - - - - - - - - - -##### url \{#embed-resultdocuments+resultdocuments+resultdocument+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/results.mdx b/examples/docusaurus/src/components/glean-embeds/contents/results.mdx deleted file mode 100644 index 2d510a141..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/results.mdx +++ /dev/null @@ -1,757 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedallclusteredresults from "../loaders/allclusteredresults.tsx"; -import Embedattachments from "../loaders/attachments.tsx"; -import Embedbacklinkresults from "../loaders/backlinkresults.tsx"; -import Embedclusteredresults from "../loaders/clusteredresults.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedmustincludesuggestions from "../loaders/mustincludesuggestions.tsx"; -import Embedpins from "../loaders/pins.tsx"; -import Embedquerysuggestion from "../loaders/querysuggestion.tsx"; -import Embedrelatedresults from "../loaders/relatedresults.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedstructuredresults from "../loaders/structuredresults.tsx"; - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results \{#embed-results+results\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - -#### SearchResult \{#embed-results+results+searchresult\} - - - - - -ClusterGroup","children":[{"label":"ClusterGroup","linkedLabel":"ClusterGroup","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allClusteredResults \{#embed-results+results+searchresult+allclusteredresults\} - - - - - -A list of results that should be displayed as associated with this result. - - - - - - - - - - - - - - - - - - - - - - - -##### attachmentContext \{#embed-results+results+searchresult+attachmentcontext\} - - - - - -Additional context for the relationship between the result and the document it's attached to. - - - - - - - - - -##### attachmentCount \{#embed-results+results+searchresult+attachmentcount\} - - - - - -The total number of attachments. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### attachments \{#embed-results+results+searchresult+attachments\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### backlinkResults \{#embed-results+results+searchresult+backlinkresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - - - - - -##### clusterType \{#embed-results+results+searchresult+clustertype\} - - - - - -The reason for inclusion of clusteredResults. - - - - - -SearchResult","children":[{"label":"SearchResult","linkedLabel":"SearchResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clusteredResults \{#embed-results+results+searchresult+clusteredresults\} - - - - - -A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-results+results+searchresult+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### fullText \{#embed-results+results+searchresult+fulltext\} - - - - - -The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - - - - - -##### fullTextList \{#embed-results+results+searchresult+fulltextlist\} - - - - - -The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### mustIncludeSuggestions \{#embed-results+results+searchresult+mustincludesuggestions\} - - - - - - - - - - - - - - - - - - - - - - - -##### nativeAppUrl \{#embed-results+results+searchresult+nativeappurl\} - - - - - -A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - - - - - -PinDocument","children":[{"label":"PinDocument","linkedLabel":"PinDocument","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pins \{#embed-results+results+searchresult+pins\} - - - - - -A list of pins associated with this search result. - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-results+results+searchresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - - -QuerySuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestion \{#embed-results+results+searchresult+querysuggestion\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedResults \{#embed-results+results+searchresult+relatedresults\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-results+results+searchresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResults \{#embed-results+results+searchresult+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-results+results+searchresult+title\} - - - - - - - - - -##### trackingToken \{#embed-results+results+searchresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - -##### url \{#embed-results+results+searchresult+url\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/resultsdescription.mdx b/examples/docusaurus/src/components/glean-embeds/contents/resultsdescription.mdx deleted file mode 100644 index 0208c210d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/resultsdescription.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embediconconfig from "../loaders/iconconfig.tsx"; - - - -ResultsDescription","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultsDescription \{#embed-resultsdescription+resultsdescription\} - - - - - - - - - -#### ResultsDescription \{#embed-resultsdescription+resultsdescription+resultsdescription\} - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#embed-resultsdescription+resultsdescription+resultsdescription+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#embed-resultsdescription+resultsdescription+resultsdescription+text\} - - - - - -Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/resulttabs.mdx b/examples/docusaurus/src/components/glean-embeds/contents/resulttabs.mdx deleted file mode 100644 index 50ea20f4d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/resulttabs.mdx +++ /dev/null @@ -1,166 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ResultTab","children":[{"label":"ResultTab","linkedLabel":"ResultTab","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### resultTabs \{#embed-resulttabs+resulttabs\} - - - - - -All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - - - - - - - - - -#### ResultTab \{#embed-resulttabs+resulttabs+resulttab\} - - - - - - - - - -##### count \{#embed-resulttabs+resulttabs+resulttab+count\} - - - - - -The number of results in this tab for the current query. - - - - - - - - - -##### datasource \{#embed-resulttabs+resulttabs+resulttab+datasource\} - - - - - -The datasource associated with the tab, if any. - - - - - - - - - -##### datasourceInstance \{#embed-resulttabs+resulttabs+resulttab+datasourceinstance\} - - - - - -The datasource instance associated with the tab, if any. - - - - - - - - - -##### id \{#embed-resulttabs+resulttabs+resulttab+id\} - - - - - -The unique ID of the tab. Can be passed in a search request to get results for that tab. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/rewrittenfacetfilters.mdx b/examples/docusaurus/src/components/glean-embeds/contents/rewrittenfacetfilters.mdx deleted file mode 100644 index 4a7cf075c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/rewrittenfacetfilters.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedvalues from "../loaders/values.tsx"; - - - -FacetFilter","children":[{"label":"FacetFilter","linkedLabel":"FacetFilter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### rewrittenFacetFilters \{#embed-rewrittenfacetfilters+rewrittenfacetfilters\} - - - - - -A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - - - - - - - - - -#### FacetFilter \{#embed-rewrittenfacetfilters+rewrittenfacetfilters+facetfilter\} - - - - - - - - - -##### fieldName \{#embed-rewrittenfacetfilters+rewrittenfacetfilters+facetfilter+fieldname\} - - - - - -_Example:_ - -``` -owner -``` - - - - - - - - - -##### groupName \{#embed-rewrittenfacetfilters+rewrittenfacetfilters+facetfilter+groupname\} - - - - - -Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### values \{#embed-rewrittenfacetfilters+rewrittenfacetfilters+facetfilter+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/roles.mdx b/examples/docusaurus/src/components/glean-embeds/contents/roles.mdx deleted file mode 100644 index a15087c35..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/roles.mdx +++ /dev/null @@ -1,169 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedgroup from "../loaders/group.tsx"; - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### roles \{#embed-roles+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - -#### UserRoleSpecification \{#embed-roles+roles+userrolespecification\} - - - - - -Group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### group \{#embed-roles+roles+userrolespecification+group\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-roles+roles+userrolespecification+person\} - - - - - - - - - - - - - -##### role \{#embed-roles+roles+userrolespecification+role\} - - - - - -A user's role with respect to a specific document. - - - - - - - - - -##### sourceDocumentSpec \{#embed-roles+roles+userrolespecification+sourcedocumentspec\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/runcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/runcount.mdx deleted file mode 100644 index ffbbb1173..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/runcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### runCount \{#embed-runcount+runcount\} - - - - - - - - - -#### CountInfo \{#embed-runcount+runcount+countinfo\} - - - - - - - - - -##### count \{#embed-runcount+runcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-runcount+runcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-runcount+runcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/scopes.mdx b/examples/docusaurus/src/components/glean-embeds/contents/scopes.mdx deleted file mode 100644 index 69a0d7d0a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/scopes.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -OperatorScope","children":[{"label":"OperatorScope","linkedLabel":"OperatorScope","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### scopes \{#embed-scopes+scopes\} - - - - - - - - - -#### OperatorScope \{#embed-scopes+scopes+operatorscope\} - - - - - - - - - -##### datasource \{#embed-scopes+scopes+operatorscope+datasource\} - - - - - - - - - -##### docType \{#embed-scopes+scopes+operatorscope+doctype\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchcount.mdx deleted file mode 100644 index 76e8d0b89..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchCount \{#embed-searchcount+searchcount\} - - - - - - - - - -#### CountInfo \{#embed-searchcount+searchcount+countinfo\} - - - - - - - - - -##### count \{#embed-searchcount+searchcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-searchcount+searchcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-searchcount+searchcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchedqueryranges.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchedqueryranges.mdx deleted file mode 100644 index db3ce9436..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchedqueryranges.mdx +++ /dev/null @@ -1,203 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchedQueryRanges \{#embed-searchedqueryranges+searchedqueryranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - -#### TextRange \{#embed-searchedqueryranges+searchedqueryranges+textrange\} - - - - - -A subsection of a given string to which some special formatting should be applied. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-searchedqueryranges+searchedqueryranges+textrange+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### endIndex \{#embed-searchedqueryranges+searchedqueryranges+textrange+endindex\} - - - - - -The exclusive end index of the range. - - - - - - - - - -##### startIndex \{#embed-searchedqueryranges+searchedqueryranges+textrange+startindex\} - - - - - -The inclusive start index of the range. - - - - - - - - - -##### type \{#embed-searchedqueryranges+searchedqueryranges+textrange+type\} - - - - - - - - - -##### url \{#embed-searchedqueryranges+searchedqueryranges+textrange+url\} - - - - - -The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchorcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchorcount.mdx deleted file mode 100644 index c7a43558e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchorcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchorCount \{#embed-searchorcount+searchorcount\} - - - - - - - - - -#### CountInfo \{#embed-searchorcount+searchorcount+countinfo\} - - - - - - - - - -##### count \{#embed-searchorcount+searchorcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-searchorcount+searchorcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-searchorcount+searchorcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchproviderinfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchproviderinfo.mdx deleted file mode 100644 index d1d74d268..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchproviderinfo.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SearchProviderInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchProviderInfo \{#embed-searchproviderinfo+searchproviderinfo\} - - - - - - - - - -#### SearchProviderInfo \{#embed-searchproviderinfo+searchproviderinfo+searchproviderinfo\} - - - - - - - - - -##### logoUrl \{#embed-searchproviderinfo+searchproviderinfo+searchproviderinfo+logourl\} - - - - - -URL to the provider's logo. - - - - - - - - - -##### name \{#embed-searchproviderinfo+searchproviderinfo+searchproviderinfo+name\} - - - - - -Name of the search provider. - - - - - - - - - -##### searchLinkUrlTemplate \{#embed-searchproviderinfo+searchproviderinfo+searchproviderinfo+searchlinkurltemplate\} - - - - - -URL template that can be used to perform the suggested search by replacing the \{query\} placeholder with the query suggestion. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchwarning.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchwarning.mdx deleted file mode 100644 index 673f34dc9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchwarning.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SearchWarning","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchWarning \{#embed-searchwarning+searchwarning\} - - - - - - - - - -#### SearchWarning \{#embed-searchwarning+searchwarning+searchwarning\} - - - - - - - - - -##### ignoredTerms \{#embed-searchwarning+searchwarning+searchwarning+ignoredterms\} - - - - - -A list of query terms that were ignored when generating search results, if any. For example, terms containing invalid filters such as "updated:invalid_date" will be ignored. - - - - - - - - - -##### lastUsedTerm \{#embed-searchwarning+searchwarning+searchwarning+lastusedterm\} - - - - - -The last term we considered in the user's long query. - - - - - - - - - -##### quotesIgnoredQuery \{#embed-searchwarning+searchwarning+searchwarning+quotesignoredquery\} - - - - - -The query after ignoring/removing quotes. - - - - - - - - - -##### warningType \{#embed-searchwarning+searchwarning+searchwarning+warningtype\} - - - - - -The type of the warning. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/searchwithclickcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/searchwithclickcount.mdx deleted file mode 100644 index 73fe4aeeb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/searchwithclickcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### searchWithClickCount \{#embed-searchwithclickcount+searchwithclickcount\} - - - - - - - - - -#### CountInfo \{#embed-searchwithclickcount+searchwithclickcount+countinfo\} - - - - - - - - - -##### count \{#embed-searchwithclickcount+searchwithclickcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-searchwithclickcount+searchwithclickcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-searchwithclickcount+searchwithclickcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/secondaryentries.mdx b/examples/docusaurus/src/components/glean-embeds/contents/secondaryentries.mdx deleted file mode 100644 index 23824c485..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/secondaryentries.mdx +++ /dev/null @@ -1,794 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedactivities from "../loaders/activities.tsx"; -import Embedannouncement from "../loaders/announcement.tsx"; -import Embedapp from "../loaders/app.tsx"; -import Embedchatsuggestion from "../loaders/chatsuggestion.tsx"; -import Embedcollection from "../loaders/collection.tsx"; -import Embedcollectionitem from "../loaders/collectionitem.tsx"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embeddigest from "../loaders/digest.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embeddocumentvisitorcount from "../loaders/documentvisitorcount.tsx"; -import Embedevent from "../loaders/event.tsx"; -import Embedperson from "../loaders/person.tsx"; -import Embedprompttemplate from "../loaders/prompttemplate.tsx"; -import Embedthumbnail from "../loaders/thumbnail.tsx"; -import Embeduiconfig from "../loaders/uiconfig.tsx"; -import Embedworkflow from "../loaders/workflow.tsx"; - - - -FeedEntry","children":[{"label":"FeedEntry","linkedLabel":"FeedEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### secondaryEntries \{#embed-secondaryentries+secondaryentries\} - - - - - -Secondary entries for the result e.g. suggested docs for the calendar, carousel. - - - - - - - - - -#### FeedEntry \{#embed-secondaryentries+secondaryentries+feedentry\} - - - - - -UserActivity","children":[{"label":"UserActivity","linkedLabel":"UserActivity","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### activities \{#embed-secondaryentries+secondaryentries+feedentry+activities\} - - - - - -List of activity where each activity has user, action, timestamp. - - - - - - - - - - - - - - - - - - - -Announcement","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### announcement \{#embed-secondaryentries+secondaryentries+feedentry+announcement\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#embed-secondaryentries+secondaryentries+feedentry+app\} - - - - - - - - - - - - - - - - - - - -ChatSuggestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### chatSuggestion \{#embed-secondaryentries+secondaryentries+feedentry+chatsuggestion\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-secondaryentries+secondaryentries+feedentry+collection\} - - - - - - - - - - - - - - - - - - - -CollectionItem","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collectionItem \{#embed-secondaryentries+secondaryentries+feedentry+collectionitem\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-secondaryentries+secondaryentries+feedentry+createdby\} - - - - - - - - - - - - - - - - - - - -Digest","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### digest \{#embed-secondaryentries+secondaryentries+feedentry+digest\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-secondaryentries+secondaryentries+feedentry+document\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### documentVisitorCount \{#embed-secondaryentries+secondaryentries+feedentry+documentvisitorcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### entryId \{#embed-secondaryentries+secondaryentries+feedentry+entryid\} - - - - - -optional ID associated with a single feed entry (displayable_list_id) - - - - - -CalendarEvent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### event \{#embed-secondaryentries+secondaryentries+feedentry+event\} - - - - - -A generic, light-weight calendar event. - - - - - - - - - - - - - - - - - - - - - - - -##### justification \{#embed-secondaryentries+secondaryentries+feedentry+justification\} - - - - - -Server side generated justification string if server provides one. - - - - - - - - - -##### justificationType \{#embed-secondaryentries+secondaryentries+feedentry+justificationtype\} - - - - - -Type of the justification. - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-secondaryentries+secondaryentries+feedentry+person\} - - - - - - - - - - - - - - - - - - - -PromptTemplateResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### promptTemplate \{#embed-secondaryentries+secondaryentries+feedentry+prompttemplate\} - - - - - - - - - - - - - - - - - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thumbnail \{#embed-secondaryentries+secondaryentries+feedentry+thumbnail\} - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-secondaryentries+secondaryentries+feedentry+title\} - - - - - -Title for the result. Can be document title, event title and so on. - - - - - - - - - -##### trackingToken \{#embed-secondaryentries+secondaryentries+feedentry+trackingtoken\} - - - - - -An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - - - - - -uiConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### uiConfig \{#embed-secondaryentries+secondaryentries+feedentry+uiconfig\} - - - - - - - - - - - - - - - - - - - - - - - -##### viewUrl \{#embed-secondaryentries+secondaryentries+feedentry+viewurl\} - - - - - -View URL for the entry if based on links that are not documents in Glean. - - - - - -WorkflowResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### workflow \{#embed-secondaryentries+secondaryentries+feedentry+workflow\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sections.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sections.mdx deleted file mode 100644 index 55614e0bb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sections.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sections \{#embed-sections+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - -#### DocumentSection \{#embed-sections+sections+documentsection\} - - - - - - - - - -##### title \{#embed-sections+sections+documentsection+title\} - - - - - -The title of the document section (e.g. the section header). - - - - - - - - - -##### url \{#embed-sections+sections+documentsection+url\} - - - - - -The permalink of the document section. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sensitivecontentoptions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sensitivecontentoptions.mdx deleted file mode 100644 index 740644948..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sensitivecontentoptions.mdx +++ /dev/null @@ -1,207 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedsensitiveinfotypes from "../loaders/sensitiveinfotypes.tsx"; -import Embedsensitiveregexes from "../loaders/sensitiveregexes.tsx"; -import Embedsensitiveterms from "../loaders/sensitiveterms.tsx"; - - - -SensitiveContentOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sensitiveContentOptions \{#embed-sensitivecontentoptions+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - - - - - -#### SensitiveContentOptions \{#embed-sensitivecontentoptions+sensitivecontentoptions+sensitivecontentoptions\} - - - - - -Options for defining sensitive content within scanned documents. - - - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveInfoTypes \{#embed-sensitivecontentoptions+sensitivecontentoptions+sensitivecontentoptions+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - - - - - - - - - - - -SensitiveExpression","children":[{"label":"SensitiveExpression","linkedLabel":"SensitiveExpression","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveRegexes \{#embed-sensitivecontentoptions+sensitivecontentoptions+sensitivecontentoptions+sensitiveregexes\} - - - - - -list of words and phrases to consider as sensitive content - - - - - - - - - - - - - - - - - - - -SensitiveExpression","children":[{"label":"SensitiveExpression","linkedLabel":"SensitiveExpression","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sensitiveTerms \{#embed-sensitivecontentoptions+sensitivecontentoptions+sensitivecontentoptions+sensitiveterms\} - - - - - -list of words and phrases to consider as sensitive content - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveinfotypes.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sensitiveinfotypes.mdx deleted file mode 100644 index 4c662b1ad..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveinfotypes.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SensitiveInfoType","children":[{"label":"SensitiveInfoType","linkedLabel":"SensitiveInfoType","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sensitiveInfoTypes \{#embed-sensitiveinfotypes+sensitiveinfotypes\} - - - - - -DEPRECATED - use `sensitiveContentOptions` instead. - - - - - - - - - -#### SensitiveInfoType \{#embed-sensitiveinfotypes+sensitiveinfotypes+sensitiveinfotype\} - - - - - - - - - -##### infoType \{#embed-sensitiveinfotypes+sensitiveinfotypes+sensitiveinfotype+infotype\} - - - - - -Text representation of an info-type to scan for. - - - - - - - - - -##### likelihoodThreshold \{#embed-sensitiveinfotypes+sensitiveinfotypes+sensitiveinfotype+likelihoodthreshold\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveregexes.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sensitiveregexes.mdx deleted file mode 100644 index 4d1e5d4b6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveregexes.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedhotwords from "../loaders/hotwords.tsx"; - - - -SensitiveExpression","children":[{"label":"SensitiveExpression","linkedLabel":"SensitiveExpression","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sensitiveRegexes \{#embed-sensitiveregexes+sensitiveregexes\} - - - - - -list of words and phrases to consider as sensitive content - - - - - - - - - -#### SensitiveExpression \{#embed-sensitiveregexes+sensitiveregexes+sensitiveexpression\} - - - - - - - - - -##### expression \{#embed-sensitiveregexes+sensitiveregexes+sensitiveexpression+expression\} - - - - - -Sensitive word, phrase, or regular expression. - - - - - -Hotword","children":[{"label":"Hotword","linkedLabel":"Hotword","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hotwords \{#embed-sensitiveregexes+sensitiveregexes+sensitiveexpression+hotwords\} - - - - - -Zero to three proximate regular expressions necessary to consider an expression as sensitive content. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveterms.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sensitiveterms.mdx deleted file mode 100644 index dd6a898c9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sensitiveterms.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedhotwords from "../loaders/hotwords.tsx"; - - - -SensitiveExpression","children":[{"label":"SensitiveExpression","linkedLabel":"SensitiveExpression","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sensitiveTerms \{#embed-sensitiveterms+sensitiveterms\} - - - - - -list of words and phrases to consider as sensitive content - - - - - - - - - -#### SensitiveExpression \{#embed-sensitiveterms+sensitiveterms+sensitiveexpression\} - - - - - - - - - -##### expression \{#embed-sensitiveterms+sensitiveterms+sensitiveexpression+expression\} - - - - - -Sensitive word, phrase, or regular expression. - - - - - -Hotword","children":[{"label":"Hotword","linkedLabel":"Hotword","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hotwords \{#embed-sensitiveterms+sensitiveterms+sensitiveexpression+hotwords\} - - - - - -Zero to three proximate regular expressions necessary to consider an expression as sensitive content. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sessioninfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sessioninfo.mdx deleted file mode 100644 index 66e27a47f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sessioninfo.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SessionInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sessionInfo \{#embed-sessioninfo+sessioninfo\} - - - - - - - - - -#### SessionInfo \{#embed-sessioninfo+sessioninfo+sessioninfo\} - - - - - - - - - -##### lastQuery \{#embed-sessioninfo+sessioninfo+sessioninfo+lastquery\} - - - - - -The last query seen by the server. - - - - - - - - - -##### lastSeen \{#embed-sessioninfo+sessioninfo+sessioninfo+lastseen\} - - - - - -The last time the server saw this token. - - - - - - - - - -##### sessionTrackingToken \{#embed-sessioninfo+sessioninfo+sessioninfo+sessiontrackingtoken\} - - - - - -A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - - - - - - - - - -##### tabId \{#embed-sessioninfo+sessioninfo+sessioninfo+tabid\} - - - - - -A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/shortcut.mdx b/examples/docusaurus/src/components/glean-embeds/contents/shortcut.mdx deleted file mode 100644 index 1a03e2aea..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/shortcut.mdx +++ /dev/null @@ -1,690 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcreatedby from "../loaders/createdby.tsx"; -import Embeddestinationdocument from "../loaders/destinationdocument.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedremovedroles from "../loaders/removedroles.tsx"; -import Embedroles from "../loaders/roles.tsx"; -import Embedupdatedby from "../loaders/updatedby.tsx"; - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcut \{#embed-shortcut+shortcut\} - - - - - - - - - -#### Shortcut \{#embed-shortcut+shortcut+shortcut\} - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### addedRoles \{#embed-shortcut+shortcut+shortcut+addedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - -##### alias \{#embed-shortcut+shortcut+shortcut+alias\} - - - - - -canonical link text following go/ prefix where hyphen/underscore is removed. - - - - - - - - - -##### createTime \{#embed-shortcut+shortcut+shortcut+createtime\} - - - - - -The time the shortcut was created in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### createdBy \{#embed-shortcut+shortcut+shortcut+createdby\} - - - - - - - - - - - - - - - - - - - - - - - -##### description \{#embed-shortcut+shortcut+shortcut+description\} - - - - - -A short, plain text blurb to help people understand the intent of the shortcut. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### destinationDocument \{#embed-shortcut+shortcut+shortcut+destinationdocument\} - - - - - - - - - - - - - - - - - - - - - - - -##### destinationDocumentId \{#embed-shortcut+shortcut+shortcut+destinationdocumentid\} - - - - - -Glean Document ID for the URL, if known. - - - - - - - - - -##### destinationUrl \{#embed-shortcut+shortcut+shortcut+destinationurl\} - - - - - -Destination URL for the shortcut. - - - - - - - - - -##### editUrl \{#embed-shortcut+shortcut+shortcut+editurl\} - - - - - -The URL using which the user can access the edit page of the shortcut. - - - - - - - - - -##### id \{#embed-shortcut+shortcut+shortcut+id\} - - - - - -The opaque id of the user generated content. - - - - - - - - - -##### inputAlias \{#embed-shortcut+shortcut+shortcut+inputalias\} - - - - - -Link text following go/ prefix as entered by the user. - - - - - - - - - -##### intermediateUrl \{#embed-shortcut+shortcut+shortcut+intermediateurl\} - - - - - -The URL from which the user is then redirected to the destination URL. Full replacement for https://go/\{inputAlias\}. - - - - - - - - - -##### isExternal \{#embed-shortcut+shortcut+shortcut+isexternal\} - - - - - -Indicates whether a shortcut is native or external. - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-shortcut+shortcut+shortcut+permissions\} - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### removedRoles \{#embed-shortcut+shortcut+shortcut+removedroles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - -UserRoleSpecification","children":[{"label":"UserRoleSpecification","linkedLabel":"UserRoleSpecification","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### roles \{#embed-shortcut+shortcut+shortcut+roles\} - - - - - -A list of user roles for the custom entity explicitly granted by the owner. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-shortcut+shortcut+shortcut+title\} - - - - - -Title for the Go Link - - - - - - - - - -##### unlisted \{#embed-shortcut+shortcut+shortcut+unlisted\} - - - - - -Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - - - - - - - - - -##### updateTime \{#embed-shortcut+shortcut+shortcut+updatetime\} - - - - - -The time the shortcut was updated in ISO format (ISO 8601). - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### updatedBy \{#embed-shortcut+shortcut+shortcut+updatedby\} - - - - - - - - - - - - - - - - - - - - - - - -##### urlTemplate \{#embed-shortcut+shortcut+shortcut+urltemplate\} - - - - - -For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - - - - - - - - - -##### viewPrefix \{#embed-shortcut+shortcut+shortcut+viewprefix\} - - - - - -The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/shortcutinsights.mdx b/examples/docusaurus/src/components/glean-embeds/contents/shortcutinsights.mdx deleted file mode 100644 index 3420cf07d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/shortcutinsights.mdx +++ /dev/null @@ -1,174 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedshortcut from "../loaders/shortcut.tsx"; -import Embedvisitcount from "../loaders/visitcount.tsx"; -import Embedvisitorcount from "../loaders/visitorcount.tsx"; - - - -ShortcutInsight","children":[{"label":"ShortcutInsight","linkedLabel":"ShortcutInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shortcutInsights \{#embed-shortcutinsights+shortcutinsights\} - - - - - -Insights for shortcuts. - - - - - - - - - -#### ShortcutInsight \{#embed-shortcutinsights+shortcutinsights+shortcutinsight\} - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#embed-shortcutinsights+shortcutinsights+shortcutinsight+shortcut\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### visitCount \{#embed-shortcutinsights+shortcutinsights+shortcutinsight+visitcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### visitorCount \{#embed-shortcutinsights+shortcutinsights+shortcutinsight+visitorcount\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/similarqueries.mdx b/examples/docusaurus/src/components/glean-embeds/contents/similarqueries.mdx deleted file mode 100644 index ae5fca85a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/similarqueries.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedclickcount from "../loaders/clickcount.tsx"; -import Embedsearchcount from "../loaders/searchcount.tsx"; -import Embedsearchwithclickcount from "../loaders/searchwithclickcount.tsx"; -import Embedsearchorcount from "../loaders/searchorcount.tsx"; - - - -QueryInsight","children":[{"label":"QueryInsight","linkedLabel":"QueryInsight","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### similarQueries \{#embed-similarqueries+similarqueries\} - - - - - -Insights for queries. - - - - - - - - - -#### QueryInsight \{#embed-similarqueries+similarqueries+queryinsight\} - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### clickCount \{#embed-similarqueries+similarqueries+queryinsight+clickcount\} - - - - - - - - - - - - - - - - - - - - - - - -##### query \{#embed-similarqueries+similarqueries+queryinsight+query\} - - - - - -The query string the information is about. - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchCount \{#embed-similarqueries+similarqueries+queryinsight+searchcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchWithClickCount \{#embed-similarqueries+similarqueries+queryinsight+searchwithclickcount\} - - - - - - - - - - - - - - - - - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchorCount \{#embed-similarqueries+similarqueries+queryinsight+searchorcount\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/snippets.mdx b/examples/docusaurus/src/components/glean-embeds/contents/snippets.mdx deleted file mode 100644 index 7a2d192c8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/snippets.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedranges from "../loaders/ranges.tsx"; - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### snippets \{#embed-snippets+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - -#### SearchResultSnippet \{#embed-snippets+snippets+searchresultsnippet\} - - - - - - - - - -##### mimeType \{#embed-snippets+snippets+searchresultsnippet+mimetype\} - - - - - -The mime type of the snippets, currently either text/plain or text/html. - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-snippets+snippets+searchresultsnippet+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - - - - - -##### snippet \{#embed-snippets+snippets+searchresultsnippet+snippet\} - - - - - -A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. - - - - - - - - - -##### snippetTextOrdering \{#embed-snippets+snippets+searchresultsnippet+snippettextordering\} - - - - - -Used for sorting based off the snippet's location within all_snippetable_text - - - - - - - - - -##### text \{#embed-snippets+snippets+searchresultsnippet+text\} - - - - - -A matching snippet from the document with no highlights. - - - - - - - - - -##### url \{#embed-snippets+snippets+searchresultsnippet+url\} - - - - - -A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/socialnetworks.mdx b/examples/docusaurus/src/components/glean-embeds/contents/socialnetworks.mdx deleted file mode 100644 index 46f6406da..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/socialnetworks.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -SocialNetworkDefinition","children":[{"label":"SocialNetworkDefinition","linkedLabel":"SocialNetworkDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### socialNetworks \{#embed-socialnetworks+socialnetworks\} - - - - - -List of social network profiles. - - - - - - - - - -#### SocialNetworkDefinition \{#embed-socialnetworks+socialnetworks+socialnetworkdefinition\} - - - - - -Employee's social network profile - - - - - - - - - -##### name \{#embed-socialnetworks+socialnetworks+socialnetworkdefinition+name\} - - - - - -Possible values are "twitter", "linkedin". - - - - - - - - - -##### profileName \{#embed-socialnetworks+socialnetworks+socialnetworkdefinition+profilename\} - - - - - -Human-readable profile name. - - - - - - - - - -##### profileUrl \{#embed-socialnetworks+socialnetworks+socialnetworkdefinition+profileurl\} - - - - - -Link to profile. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sourcedocument.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sourcedocument.mdx deleted file mode 100644 index 42756d791..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sourcedocument.mdx +++ /dev/null @@ -1,396 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcontainerdocument from "../loaders/containerdocument.tsx"; -import Embedcontent from "../loaders/content.tsx"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedparentdocument from "../loaders/parentdocument.tsx"; -import Embedsections from "../loaders/sections.tsx"; - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceDocument \{#embed-sourcedocument+sourcedocument\} - - - - - - - - - -#### Document \{#embed-sourcedocument+sourcedocument+document\} - - - - - - - - - -##### connectorType \{#embed-sourcedocument+sourcedocument+document+connectortype\} - - - - - -The source from which document content was pulled, e.g. an API crawl or browser history - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### containerDocument \{#embed-sourcedocument+sourcedocument+document+containerdocument\} - - - - - - - - - - - - - - - - - - - -DocumentContent","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content \{#embed-sourcedocument+sourcedocument+document+content\} - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-sourcedocument+sourcedocument+document+datasource\} - - - - - -The app or other repository type from which the document was extracted - - - - - - - - - -##### docType \{#embed-sourcedocument+sourcedocument+document+doctype\} - - - - - -The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - - - - - - - - - -##### id \{#embed-sourcedocument+sourcedocument+document+id\} - - - - - -The Glean Document ID. - - - - - -DocumentMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-sourcedocument+sourcedocument+document+metadata\} - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### parentDocument \{#embed-sourcedocument+sourcedocument+document+parentdocument\} - - - - - - - - - - - - - - - - - - - -DocumentSection","children":[{"label":"DocumentSection","linkedLabel":"DocumentSection","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### sections \{#embed-sourcedocument+sourcedocument+document+sections\} - - - - - -A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - - - - - - - - - - - - - - - - - - - - - - - -##### title \{#embed-sourcedocument+sourcedocument+document+title\} - - - - - -The title of the document. - - - - - - - - - -##### url \{#embed-sourcedocument+sourcedocument+document+url\} - - - - - -A permalink for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sourcefile.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sourcefile.mdx deleted file mode 100644 index 3d2af87dd..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sourcefile.mdx +++ /dev/null @@ -1,221 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -ChatFile","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourceFile \{#embed-sourcefile+sourcefile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -#### ChatFile \{#embed-sourcefile+sourcefile+chatfile\} - - - - - -Structure for file uploaded by a user for Chat. - - - - - - - - - -##### id \{#embed-sourcefile+sourcefile+chatfile+id\} - - - - - -Unique identifier of the file. - - - - - -_Example:_ - -``` -FILE_1234 -``` - - - - - -ChatFileMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-sourcefile+sourcefile+chatfile+metadata\} - - - - - -Metadata of a file uploaded by a user for Chat. - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-sourcefile+sourcefile+chatfile+name\} - - - - - -Name of the uploaded file. - - - - - -_Example:_ - -``` -sample.pdf -``` - - - - - - - - - -##### url \{#embed-sourcefile+sourcefile+chatfile+url\} - - - - - -Url of the file. - - - - - -_Example:_ - -``` -www.google.com -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/sourceperson.mdx b/examples/docusaurus/src/components/glean-embeds/contents/sourceperson.mdx deleted file mode 100644 index 98b456108..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/sourceperson.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sourcePerson \{#embed-sourceperson+sourceperson\} - - - - - - - - - -#### Person \{#embed-sourceperson+sourceperson+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-sourceperson+sourceperson+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-sourceperson+sourceperson+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-sourceperson+sourceperson+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-sourceperson+sourceperson+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/start.mdx b/examples/docusaurus/src/components/glean-embeds/contents/start.mdx deleted file mode 100644 index dd5eea1f7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/start.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -TimePoint","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### start \{#embed-start+start\} - - - - - - - - - -#### TimePoint \{#embed-start+start+timepoint\} - - - - - - - - - -##### daysFromNow \{#embed-start+start+timepoint+daysfromnow\} - - - - - -The number of days from now. Specification relative to current time. Can be negative. - - - - - - - - - -##### epochSeconds \{#embed-start+start+timepoint+epochseconds\} - - - - - -Epoch seconds. Has precedence over daysFromNow. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/status.mdx b/examples/docusaurus/src/components/glean-embeds/contents/status.mdx deleted file mode 100644 index a306d1eb1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/status.mdx +++ /dev/null @@ -1,249 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -DocumentStatusResponse","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### status \{#embed-status+status\} - - - - - -Describes the document status response body - - - - - - - - - -#### DocumentStatusResponse \{#embed-status+status+documentstatusresponse\} - - - - - -Describes the document status response body - - - - - - - - - -##### indexingStatus \{#embed-status+status+documentstatusresponse+indexingstatus\} - - - - - -Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - - - - - -_Example:_ - -``` -INDEXED -``` - - - - - - - - - -##### lastIndexedAt \{#embed-status+status+documentstatusresponse+lastindexedat\} - - - - - -Time of last successful indexing for the document, in ISO 8601 format - - - - - -_Example:_ - -``` -2021-08-06T17:58:01.000Z -``` - - - - - - - - - -##### lastUploadedAt \{#embed-status+status+documentstatusresponse+lastuploadedat\} - - - - - -Time of last successful upload for the document, in ISO 8601 format - - - - - -_Example:_ - -``` -2021-08-06T17:58:01.000Z -``` - - - - - - - - - -##### permissionIdentityStatus \{#embed-status+status+documentstatusresponse+permissionidentitystatus\} - - - - - -Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`. - - - - - -_Example:_ - -``` -UPLOADED -``` - - - - - - - - - -##### uploadStatus \{#embed-status+status+documentstatusresponse+uploadstatus\} - - - - - -Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - - - - - -_Example:_ - -``` -UPLOADED -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/structuredlist.mdx b/examples/docusaurus/src/components/glean-embeds/contents/structuredlist.mdx deleted file mode 100644 index 69e3127bb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/structuredlist.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; -import Embedstructuredresult from "../loaders/structuredresult.tsx"; - - - -StructuredTextItem","children":[{"label":"StructuredTextItem","linkedLabel":"StructuredTextItem","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredList \{#embed-structuredlist+structuredlist\} - - - - - -An array of objects each of which contains either a string or a link which optionally corresponds to a document. - - - - - - - - - -#### StructuredTextItem \{#embed-structuredlist+structuredlist+structuredtextitem\} - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-structuredlist+structuredlist+structuredtextitem+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### link \{#embed-structuredlist+structuredlist+structuredtextitem+link\} - - - - - -_Example:_ - -``` -https://en.wikipedia.org/wiki/Diffuse_sky_radiation -``` - - - - - -StructuredResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### structuredResult \{#embed-structuredlist+structuredlist+structuredtextitem+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - - - - - - - - - - - - - - - - - - - -##### text \{#embed-structuredlist+structuredlist+structuredtextitem+text\} - - - - - -_Example:_ - -``` -Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue. -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/structuredlocation.mdx b/examples/docusaurus/src/components/glean-embeds/contents/structuredlocation.mdx deleted file mode 100644 index 92c5f311f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/structuredlocation.mdx +++ /dev/null @@ -1,298 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -StructuredLocation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredLocation \{#embed-structuredlocation+structuredlocation\} - - - - - -Detailed location with information about country, state, city etc. - - - - - - - - - -#### StructuredLocation \{#embed-structuredlocation+structuredlocation+structuredlocation\} - - - - - -Detailed location with information about country, state, city etc. - - - - - - - - - -##### address \{#embed-structuredlocation+structuredlocation+structuredlocation+address\} - - - - - -Office address or name. - - - - - - - - - -##### city \{#embed-structuredlocation+structuredlocation+structuredlocation+city\} - - - - - -Name of the city. - - - - - - - - - -##### country \{#embed-structuredlocation+structuredlocation+structuredlocation+country\} - - - - - -Country name. - - - - - - - - - -##### countryCode \{#embed-structuredlocation+structuredlocation+structuredlocation+countrycode\} - - - - - -Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - - - - - - - - - -##### deskLocation \{#embed-structuredlocation+structuredlocation+structuredlocation+desklocation\} - - - - - -Desk number. - - - - - - - - - -##### region \{#embed-structuredlocation+structuredlocation+structuredlocation+region\} - - - - - -Region information, e.g. NORAM, APAC. - - - - - - - - - -##### state \{#embed-structuredlocation+structuredlocation+structuredlocation+state\} - - - - - -State code. - - - - - - - - - -##### timezone \{#embed-structuredlocation+structuredlocation+structuredlocation+timezone\} - - - - - -Location's timezone, e.g. UTC, PST. - - - - - - - - - -##### zipCode \{#embed-structuredlocation+structuredlocation+structuredlocation+zipcode\} - - - - - -ZIP Code for the address. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/structuredresult.mdx b/examples/docusaurus/src/components/glean-embeds/contents/structuredresult.mdx deleted file mode 100644 index b747334fd..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/structuredresult.mdx +++ /dev/null @@ -1,842 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedanswer from "../loaders/answer.tsx"; -import Embedanswerboard from "../loaders/answerboard.tsx"; -import Embedapp from "../loaders/app.tsx"; -import Embedcode from "../loaders/code.tsx"; -import Embedcollection from "../loaders/collection.tsx"; -import Embedcustomentity from "../loaders/customentity.tsx"; -import Embedcustomer from "../loaders/customer.tsx"; -import Embeddisambiguation from "../loaders/disambiguation.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedextractedqna from "../loaders/extractedqna.tsx"; -import Embedgeneratedqna from "../loaders/generatedqna.tsx"; -import Embedmeeting from "../loaders/meeting.tsx"; -import Embedperson from "../loaders/person.tsx"; -import Embedquerysuggestions from "../loaders/querysuggestions.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; -import Embedrelatedquestion from "../loaders/relatedquestion.tsx"; -import Embedshortcut from "../loaders/shortcut.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedteam from "../loaders/team.tsx"; - - - -StructuredResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredResult \{#embed-structuredresult+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - - - - - -#### StructuredResult \{#embed-structuredresult+structuredresult+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#embed-structuredresult+structuredresult+structuredresult+answer\} - - - - - - - - - - - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerBoard \{#embed-structuredresult+structuredresult+structuredresult+answerboard\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#embed-structuredresult+structuredresult+structuredresult+app\} - - - - - - - - - - - - - - - - - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### code \{#embed-structuredresult+structuredresult+structuredresult+code\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-structuredresult+structuredresult+structuredresult+collection\} - - - - - - - - - - - - - - - - - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customEntity \{#embed-structuredresult+structuredresult+structuredresult+customentity\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#embed-structuredresult+structuredresult+structuredresult+customer\} - - - - - - - - - - - - - - - - - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### disambiguation \{#embed-structuredresult+structuredresult+structuredresult+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-structuredresult+structuredresult+structuredresult+document\} - - - - - - - - - - - - - - - - - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### extractedQnA \{#embed-structuredresult+structuredresult+structuredresult+extractedqna\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQna \{#embed-structuredresult+structuredresult+structuredresult+generatedqna\} - - - - - - - - - - - - - - - - - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### meeting \{#embed-structuredresult+structuredresult+structuredresult+meeting\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-structuredresult+structuredresult+structuredresult+person\} - - - - - - - - - - - - - - - - - - - - - - - -##### prominence \{#embed-structuredresult+structuredresult+structuredresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestions \{#embed-structuredresult+structuredresult+structuredresult+querysuggestions\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-structuredresult+structuredresult+structuredresult+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedQuestion \{#embed-structuredresult+structuredresult+structuredresult+relatedquestion\} - - - - - - - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#embed-structuredresult+structuredresult+structuredresult+shortcut\} - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-structuredresult+structuredresult+structuredresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - - - - - -##### source \{#embed-structuredresult+structuredresult+structuredresult+source\} - - - - - -Source context for this result. Possible values depend on the result type. - - - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### team \{#embed-structuredresult+structuredresult+structuredresult+team\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#embed-structuredresult+structuredresult+structuredresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/structuredresults.mdx b/examples/docusaurus/src/components/glean-embeds/contents/structuredresults.mdx deleted file mode 100644 index 22da0da3a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/structuredresults.mdx +++ /dev/null @@ -1,805 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedanswerboard from "../loaders/answerboard.tsx"; -import Embedapp from "../loaders/app.tsx"; -import Embedcode from "../loaders/code.tsx"; -import Embedcollection from "../loaders/collection.tsx"; -import Embedcustomentity from "../loaders/customentity.tsx"; -import Embedcustomer from "../loaders/customer.tsx"; -import Embeddisambiguation from "../loaders/disambiguation.tsx"; -import Embeddocument from "../loaders/document.tsx"; -import Embedextractedqna from "../loaders/extractedqna.tsx"; -import Embedgeneratedqna from "../loaders/generatedqna.tsx"; -import Embedmeeting from "../loaders/meeting.tsx"; -import Embedquerysuggestions from "../loaders/querysuggestions.tsx"; -import Embedrelatedquestion from "../loaders/relatedquestion.tsx"; -import Embedshortcut from "../loaders/shortcut.tsx"; -import Embedsnippets from "../loaders/snippets.tsx"; -import Embedteam from "../loaders/team.tsx"; - - - -StructuredResult","children":[{"label":"StructuredResult","linkedLabel":"StructuredResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### structuredResults \{#embed-structuredresults+structuredresults\} - - - - - -An array of entities in the work graph retrieved via a data request. - - - - - - - - - -#### StructuredResult \{#embed-structuredresults+structuredresults+structuredresult\} - - - - - -A single object that can support any object in the work graph. Only a single object will be populated. - - - - - -Answer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answer \{#embed-structuredresults+structuredresults+structuredresult+answer\} - - - - - - - - - -AnswerBoard","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### answerBoard \{#embed-structuredresults+structuredresults+structuredresult+answerboard\} - - - - - - - - - - - - - - - - - - - -AppResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### app \{#embed-structuredresults+structuredresults+structuredresult+app\} - - - - - - - - - - - - - - - - - - - -Code","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### code \{#embed-structuredresults+structuredresults+structuredresult+code\} - - - - - - - - - - - - - - - - - - - -Collection","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### collection \{#embed-structuredresults+structuredresults+structuredresult+collection\} - - - - - - - - - - - - - - - - - - - -CustomEntity","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customEntity \{#embed-structuredresults+structuredresults+structuredresult+customentity\} - - - - - - - - - - - - - - - - - - - -Customer","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customer \{#embed-structuredresults+structuredresults+structuredresult+customer\} - - - - - - - - - - - - - - - - - - - -Disambiguation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### disambiguation \{#embed-structuredresults+structuredresults+structuredresult+disambiguation\} - - - - - -A disambiguation between multiple entities with the same name - - - - - - - - - - - - - - - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-structuredresults+structuredresults+structuredresult+document\} - - - - - - - - - - - - - - - - - - - -ExtractedQnA","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### extractedQnA \{#embed-structuredresults+structuredresults+structuredresult+extractedqna\} - - - - - - - - - - - - - - - - - - - -GeneratedQna","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generatedQna \{#embed-structuredresults+structuredresults+structuredresult+generatedqna\} - - - - - - - - - - - - - - - - - - - -Meeting","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### meeting \{#embed-structuredresults+structuredresults+structuredresult+meeting\} - - - - - - - - - - - - - - - - - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### person \{#embed-structuredresults+structuredresults+structuredresult+person\} - - - - - - - - - - - - - -##### prominence \{#embed-structuredresults+structuredresults+structuredresult+prominence\} - - - - - -The level of visual distinction that should be given to a result. - - - - - -QuerySuggestionList","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### querySuggestions \{#embed-structuredresults+structuredresults+structuredresult+querysuggestions\} - - - - - - - - - - - - - - - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-structuredresults+structuredresults+structuredresult+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - -RelatedQuestion","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedQuestion \{#embed-structuredresults+structuredresults+structuredresult+relatedquestion\} - - - - - - - - - - - - - - - - - - - -Shortcut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### shortcut \{#embed-structuredresults+structuredresults+structuredresult+shortcut\} - - - - - - - - - - - - - - - - - - - -SearchResultSnippet","children":[{"label":"SearchResultSnippet","linkedLabel":"SearchResultSnippet","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### snippets \{#embed-structuredresults+structuredresults+structuredresult+snippets\} - - - - - -Any snippets associated to the populated object. - - - - - - - - - - - - - - - - - - - - - - - -##### source \{#embed-structuredresults+structuredresults+structuredresult+source\} - - - - - -Source context for this result. Possible values depend on the result type. - - - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### team \{#embed-structuredresults+structuredresults+structuredresult+team\} - - - - - - - - - - - - - - - - - - - - - - - -##### trackingToken \{#embed-structuredresults+structuredresults+structuredresult+trackingtoken\} - - - - - -An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/suggestions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/suggestions.mdx deleted file mode 100644 index 65f7e5e0f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/suggestions.mdx +++ /dev/null @@ -1,316 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedinputdetails from "../loaders/inputdetails.tsx"; -import Embedranges from "../loaders/ranges.tsx"; -import Embedrequestoptions from "../loaders/requestoptions.tsx"; -import Embedsearchproviderinfo from "../loaders/searchproviderinfo.tsx"; - - - -QuerySuggestion","children":[{"label":"QuerySuggestion","linkedLabel":"QuerySuggestion","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### suggestions \{#embed-suggestions+suggestions\} - - - - - - - - - -#### QuerySuggestion \{#embed-suggestions+suggestions+querysuggestion\} - - - - - - - - - -##### datasource \{#embed-suggestions+suggestions+querysuggestion+datasource\} - - - - - -The datasource associated with the suggestion. - - - - - -SearchRequestInputDetails","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### inputDetails \{#embed-suggestions+suggestions+querysuggestion+inputdetails\} - - - - - - - - - - - - - - - - - - - - - - - -##### label \{#embed-suggestions+suggestions+querysuggestion+label\} - - - - - -A user-facing description to display for the suggestion. - - - - - - - - - -##### missingTerm \{#embed-suggestions+suggestions+querysuggestion+missingterm\} - - - - - -A query term missing from the original query on which this suggestion is based. - - - - - - - - - -##### query \{#embed-suggestions+suggestions+querysuggestion+query\} - - - - - -The query being suggested (e.g. enforcing the missing term from the original query). - - - - - -TextRange","children":[{"label":"TextRange","linkedLabel":"TextRange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### ranges \{#embed-suggestions+suggestions+querysuggestion+ranges\} - - - - - -The bolded ranges within the query of the QuerySuggestion. - - - - - - - - - - - - - - - - - - - -SearchRequestOptions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### requestOptions \{#embed-suggestions+suggestions+querysuggestion+requestoptions\} - - - - - - - - - - - - - - - - - - - -SearchProviderInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### searchProviderInfo \{#embed-suggestions+suggestions+querysuggestion+searchproviderinfo\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/summary.mdx b/examples/docusaurus/src/components/glean-embeds/contents/summary.mdx deleted file mode 100644 index ba8bb82f3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/summary.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -ContentDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### summary \{#embed-summary+summary\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - -#### ContentDefinition \{#embed-summary+summary+contentdefinition\} - - - - - -Describes text content or base64 encoded binary content - - - - - - - - - -##### binaryContent \{#embed-summary+summary+contentdefinition+binarycontent\} - - - - - -base64 encoded binary content. Only one of textContent or binary content can be specified - - - - - - - - - -##### mimeType \{#embed-summary+summary+contentdefinition+mimetype\} - - - - - - - - - -##### textContent \{#embed-summary+summary+contentdefinition+textcontent\} - - - - - -text content. Only one of textContent or binary content can be specified - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/target.mdx b/examples/docusaurus/src/components/glean-embeds/contents/target.mdx deleted file mode 100644 index 1458bbbf5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/target.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -CollectionPinTarget","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### target \{#embed-target+target\} - - - - - - - - - -#### CollectionPinTarget \{#embed-target+target+collectionpintarget\} - - - - - - - - - -##### category \{#embed-target+target+collectionpintarget+category\} - - - - - -Categories a Collection can be pinned to. - - - - - - - - - -##### value \{#embed-target+target+collectionpintarget+value\} - - - - - -Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/team.mdx b/examples/docusaurus/src/components/glean-embeds/contents/team.mdx deleted file mode 100644 index d8db595bc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/team.mdx +++ /dev/null @@ -1,696 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedcustomfields from "../loaders/customfields.tsx"; -import Embeddatasourceprofiles from "../loaders/datasourceprofiles.tsx"; -import Embedemails from "../loaders/emails.tsx"; -import Embedmembers from "../loaders/members.tsx"; -import Embedpermissions from "../loaders/permissions.tsx"; -import Embedrelatedobjects from "../loaders/relatedobjects.tsx"; - - - -Team","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### team \{#embed-team+team\} - - - - - - - - - -#### Team \{#embed-team+team+team\} - - - - - - - - - -##### bannerUrl \{#embed-team+team+team+bannerurl\} - - - - - -A link to the team's banner photo. - - - - - - - - - -##### businessUnit \{#embed-team+team+team+businessunit\} - - - - - -Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - - - - - - - - - -##### canBeDeleted \{#embed-team+team+team+canbedeleted\} - - - - - -can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot - - - - - -_Default Value:_ `true` - - - - - - - - - -##### createdFrom \{#embed-team+team+team+createdfrom\} - - - - - -For teams created from docs, the doc title. Otherwise empty. - - - - - -CustomFieldData","children":[{"label":"CustomFieldData","linkedLabel":"CustomFieldData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### customFields \{#embed-team+team+team+customfields\} - - - - - -Customizable fields for additional team information. - - - - - - - - - - - - - - - - - - - - - - - -##### datasource \{#embed-team+team+team+datasource\} - - - - - -the data source of the team, e.g. GDRIVE - - - - - -DatasourceProfile","children":[{"label":"DatasourceProfile","linkedLabel":"DatasourceProfile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### datasourceProfiles \{#embed-team+team+team+datasourceprofiles\} - - - - - -The datasource profiles of the team - - - - - - - - - - - - - - - - - - - - - - - -##### department \{#embed-team+team+team+department\} - - - - - -An organizational unit where everyone has a similar task, e.g. `Engineering`. - - - - - - - - - -##### description \{#embed-team+team+team+description\} - - - - - -A description of the team - - - - - -TeamEmail","children":[{"label":"TeamEmail","linkedLabel":"TeamEmail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### emails \{#embed-team+team+team+emails\} - - - - - -The emails for this team - - - - - - - - - - - - - - - - - - - - - - - -##### externalLink \{#embed-team+team+team+externallink\} - - - - - -Link to a team page on the internet or your company's intranet - - - - - - - - - -##### id \{#embed-team+team+team+id\} - - - - - -Unique identifier - - - - - - - - - -##### lastUpdatedAt \{#embed-team+team+team+lastupdatedat\} - - - - - -when this team was last updated. - - - - - - - - - -##### loggingId \{#embed-team+team+team+loggingid\} - - - - - -The logging id of the team used in scrubbed logs, client analytics, and metrics. - - - - - - - - - -##### memberCount \{#embed-team+team+team+membercount\} - - - - - -Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team) - - - - - -PersonToTeamRelationship","children":[{"label":"PersonToTeamRelationship","linkedLabel":"PersonToTeamRelationship","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### members \{#embed-team+team+team+members\} - - - - - -The members on this team - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-team+team+team+name\} - - - - - -Team name - - - - - -ObjectPermissions","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### permissions \{#embed-team+team+team+permissions\} - - - - - - - - - - - - - - - - - - - - - - - -##### photoUrl \{#embed-team+team+team+photourl\} - - - - - -A link to the team's photo. - - - - - -RelatedObjectEdge","children":[{"label":"RelatedObjectEdge","linkedLabel":"RelatedObjectEdge","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedObjects \{#embed-team+team+team+relatedobjects\} - - - - - -A list of objects related to a source object. - - - - - - - - - - - - - - - - - - - - - - - -##### status \{#embed-team+team+team+status\} - - - - - -whether this team is fully processed or there are still unprocessed operations that'll affect it - - - - - -_Default Value:_ `"PROCESSED"` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/teams.mdx b/examples/docusaurus/src/components/glean-embeds/contents/teams.mdx deleted file mode 100644 index c6f3fe7b5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/teams.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -EmployeeTeamInfo","children":[{"label":"EmployeeTeamInfo","linkedLabel":"EmployeeTeamInfo","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### teams \{#embed-teams+teams\} - - - - - -Info about the employee's team(s) - - - - - - - - - -#### EmployeeTeamInfo \{#embed-teams+teams+employeeteaminfo\} - - - - - -Information about which team an employee belongs to - - - - - - - - - -##### id \{#embed-teams+teams+employeeteaminfo+id\} - - - - - -unique identifier for this team - - - - - - - - - -##### name \{#embed-teams+teams+employeeteaminfo+name\} - - - - - -Team name - - - - - - - - - -##### url \{#embed-teams+teams+employeeteaminfo+url\} - - - - - -Link to internal company team page - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/textrange.mdx b/examples/docusaurus/src/components/glean-embeds/contents/textrange.mdx deleted file mode 100644 index 136ba1e21..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/textrange.mdx +++ /dev/null @@ -1,203 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embeddocument from "../loaders/document.tsx"; - - - -TextRange","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### textRange \{#embed-textrange+textrange\} - - - - - -A subsection of a given string to which some special formatting should be applied. - - - - - - - - - -#### TextRange \{#embed-textrange+textrange+textrange\} - - - - - -A subsection of a given string to which some special formatting should be applied. - - - - - -Document","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### document \{#embed-textrange+textrange+textrange+document\} - - - - - - - - - - - - - - - - - - - - - - - -##### endIndex \{#embed-textrange+textrange+textrange+endindex\} - - - - - -The exclusive end index of the range. - - - - - - - - - -##### startIndex \{#embed-textrange+textrange+textrange+startindex\} - - - - - -The inclusive start index of the range. - - - - - - - - - -##### type \{#embed-textrange+textrange+textrange+type\} - - - - - - - - - -##### url \{#embed-textrange+textrange+textrange+url\} - - - - - -The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/thumbnail.mdx b/examples/docusaurus/src/components/glean-embeds/contents/thumbnail.mdx deleted file mode 100644 index d708d9f76..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/thumbnail.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -Thumbnail","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### thumbnail \{#embed-thumbnail+thumbnail\} - - - - - - - - - -#### Thumbnail \{#embed-thumbnail+thumbnail+thumbnail\} - - - - - - - - - -##### photoId \{#embed-thumbnail+thumbnail+thumbnail+photoid\} - - - - - -Photo id if the thumbnail is from splash. - - - - - - - - - -##### url \{#embed-thumbnail+thumbnail+thumbnail+url\} - - - - - -Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/time.mdx b/examples/docusaurus/src/components/glean-embeds/contents/time.mdx deleted file mode 100644 index b45fe3379..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/time.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -TimeInterval","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### time \{#embed-time+time\} - - - - - - - - - -#### TimeInterval \{#embed-time+time+timeinterval\} - - - - - - - - - -##### end \{#embed-time+time+timeinterval+end\} - - - - - -The RFC3339 timestamp formatted end time of this event. - - - - - - - - - -##### start \{#embed-time+time+timeinterval+start\} - - - - - -The RFC3339 timestamp formatted start time of this event. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/uiconfig.mdx b/examples/docusaurus/src/components/glean-embeds/contents/uiconfig.mdx deleted file mode 100644 index d5e05b4f0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/uiconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -uiConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### uiConfig \{#embed-uiconfig+uiconfig\} - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/updatedby.mdx b/examples/docusaurus/src/components/glean-embeds/contents/updatedby.mdx deleted file mode 100644 index c7235d9a4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/updatedby.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### updatedBy \{#embed-updatedby+updatedby\} - - - - - - - - - -#### Person \{#embed-updatedby+updatedby+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-updatedby+updatedby+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-updatedby+updatedby+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-updatedby+updatedby+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-updatedby+updatedby+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/uploadedpermissions.mdx b/examples/docusaurus/src/components/glean-embeds/contents/uploadedpermissions.mdx deleted file mode 100644 index 11a5aafea..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/uploadedpermissions.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedallowedgroupintersections from "../loaders/allowedgroupintersections.tsx"; -import Embedallowedusers from "../loaders/allowedusers.tsx"; - - - -DocumentPermissionsDefinition","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### uploadedPermissions \{#embed-uploadedpermissions+uploadedpermissions\} - - - - - -describes the access control details of the document - - - - - - - - - -#### DocumentPermissionsDefinition \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition\} - - - - - -describes the access control details of the document - - - - - - - - - -##### allowAllDatasourceUsersAccess \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition+allowalldatasourceusersaccess\} - - - - - -If true, then any user who has an account in the datasource can view the document. - - - - - - - - - -##### allowAnonymousAccess \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition+allowanonymousaccess\} - - - - - -If true, then any Glean user can view the document - - - - - -PermissionsGroupIntersectionDefinition","children":[{"label":"PermissionsGroupIntersectionDefinition","linkedLabel":"PermissionsGroupIntersectionDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedGroupIntersections \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition+allowedgroupintersections\} - - - - - -List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - - - - - - - - - - - - - - - - - - - - - - - -##### allowedGroups \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition+allowedgroups\} - - - - - -List of groups that can view the document - - - - - -UserReferenceDefinition","children":[{"label":"UserReferenceDefinition","linkedLabel":"UserReferenceDefinition","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### allowedUsers \{#embed-uploadedpermissions+uploadedpermissions+documentpermissionsdefinition+allowedusers\} - - - - - -List of users who can view the document - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/user.mdx b/examples/docusaurus/src/components/glean-embeds/contents/user.mdx deleted file mode 100644 index 4628f23e4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/user.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; -import Embedrelateddocuments from "../loaders/relateddocuments.tsx"; - - - -Person","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### user \{#embed-user+user\} - - - - - - - - - -#### Person \{#embed-user+user+person\} - - - - - -PersonMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-user+user+person+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### name \{#embed-user+user+person+name\} - - - - - -The display name. - - - - - - - - - -##### obfuscatedId \{#embed-user+user+person+obfuscatedid\} - - - - - -An opaque identifier that can be used to request metadata for a Person. - - - - - -RelatedDocuments","children":[{"label":"RelatedDocuments","linkedLabel":"RelatedDocuments","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### relatedDocuments \{#embed-user+user+person+relateddocuments\} - - - - - -A list of documents related to this person. - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/value.mdx b/examples/docusaurus/src/components/glean-embeds/contents/value.mdx deleted file mode 100644 index cee86ef58..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/value.mdx +++ /dev/null @@ -1,202 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embediconconfig from "../loaders/iconconfig.tsx"; - - - -FacetValue","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### value \{#embed-value+value\} - - - - - - - - - -#### FacetValue \{#embed-value+value+facetvalue\} - - - - - - - - - -##### displayLabel \{#embed-value+value+facetvalue+displaylabel\} - - - - - -An optional user-friendly label to display in place of the facet value. - - - - - -_Example:_ - -``` -engineering -``` - - - - - -IconConfig","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### iconConfig \{#embed-value+value+facetvalue+iconconfig\} - - - - - -Defines how to render an icon - - - - - - - - - - - - - - - - - - - - - - - -##### integerValue \{#embed-value+value+facetvalue+integervalue\} - - - - - -_Example:_ - -``` -5 -``` - - - - - - - - - -##### stringValue \{#embed-value+value+facetvalue+stringvalue\} - - - - - -The value that should be set in the FacetFilter when applying this filter to a search request. - - - - - -_Example:_ - -``` -engineering -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/values.mdx b/examples/docusaurus/src/components/glean-embeds/contents/values.mdx deleted file mode 100644 index b10b0e022..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/values.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -FacetFilterValue","children":[{"label":"FacetFilterValue","linkedLabel":"FacetFilterValue","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### values \{#embed-values+values\} - - - - - -Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - - - - - - - - - -#### FacetFilterValue \{#embed-values+values+facetfiltervalue\} - - - - - - - - - -##### isNegated \{#embed-values+values+facetfiltervalue+isnegated\} - - - - - -DEPRECATED - please use relationType instead - - - - - - - - - -##### relationType \{#embed-values+values+facetfiltervalue+relationtype\} - - - - - -_Example:_ - -``` -EQUALS -``` - - - - - - - - - -##### value \{#embed-values+values+facetfiltervalue+value\} - - - - - -_Example:_ - -``` -Spreadsheet -``` - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/verification.mdx b/examples/docusaurus/src/components/glean-embeds/contents/verification.mdx deleted file mode 100644 index 278018fab..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/verification.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedmetadata from "../loaders/metadata.tsx"; - - - -Verification","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### verification \{#embed-verification+verification\} - - - - - - - - - -#### Verification \{#embed-verification+verification+verification\} - - - - - -VerificationMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata \{#embed-verification+verification+verification+metadata\} - - - - - - - - - - - - - - - - - - - - - - - -##### state \{#embed-verification+verification+verification+state\} - - - - - -The verification state for the document. - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/viewcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/viewcount.mdx deleted file mode 100644 index 9dafe6f4d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/viewcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### viewCount \{#embed-viewcount+viewcount\} - - - - - - - - - -#### CountInfo \{#embed-viewcount+viewcount+countinfo\} - - - - - - - - - -##### count \{#embed-viewcount+viewcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-viewcount+viewcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-viewcount+viewcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/viewerinfo.mdx b/examples/docusaurus/src/components/glean-embeds/contents/viewerinfo.mdx deleted file mode 100644 index f2adfb85b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/viewerinfo.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -viewerInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### viewerInfo \{#embed-viewerinfo+viewerinfo\} - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/visitcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/visitcount.mdx deleted file mode 100644 index 0dad3fef4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/visitcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### visitCount \{#embed-visitcount+visitcount\} - - - - - - - - - -#### CountInfo \{#embed-visitcount+visitcount+countinfo\} - - - - - - - - - -##### count \{#embed-visitcount+visitcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-visitcount+visitcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-visitcount+visitcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/visitorcount.mdx b/examples/docusaurus/src/components/glean-embeds/contents/visitorcount.mdx deleted file mode 100644 index 849927513..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/visitorcount.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - Embed, - EmbedTrigger, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; -import Embedperiod from "../loaders/period.tsx"; - - - -CountInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### visitorCount \{#embed-visitorcount+visitorcount\} - - - - - - - - - -#### CountInfo \{#embed-visitorcount+visitorcount+countinfo\} - - - - - - - - - -##### count \{#embed-visitorcount+visitorcount+countinfo+count\} - - - - - -The counter value - - - - - - - - - -##### org \{#embed-visitorcount+visitorcount+countinfo+org\} - - - - - -The unit of organization over which we did the count aggregation, e.g. org (department) or company - - - - - -Period","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### period \{#embed-visitorcount+visitorcount+countinfo+period\} - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/workflow.mdx b/examples/docusaurus/src/components/glean-embeds/contents/workflow.mdx deleted file mode 100644 index 6f3522abf..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/workflow.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -WorkflowResult","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### workflow \{#embed-workflow+workflow\} - - - - - - - - - -#### WorkflowResult \{#embed-workflow+workflow+workflowresult\} - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/contents/write.mdx b/examples/docusaurus/src/components/glean-embeds/contents/write.mdx deleted file mode 100644 index b627cd439..000000000 --- a/examples/docusaurus/src/components/glean-embeds/contents/write.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -hide_table_of_contents: true ---- -import { - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection -} from "@speakeasy-api/docs-md-react"; - - - -WritePermission","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### write \{#embed-write+write\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - -#### WritePermission \{#embed-write+write+writepermission\} - - - - - -Describes the write permissions levels that a user has for a specific feature - - - - - - - - - -##### create \{#embed-write+write+writepermission+create\} - - - - - -True if user has create permission for this feature and scope - - - - - - - - - -##### delete \{#embed-write+write+writepermission+delete\} - - - - - -True if user has delete permission for this feature and scope - - - - - - - - - -##### scopeType \{#embed-write+write+writepermission+scopetype\} - - - - - -Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - - - - - - - - - -##### update \{#embed-write+write+writepermission+update\} - - - - - -True if user has update permission for this feature and scope - - - - - - - - - - - - - - \ No newline at end of file diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/action.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/action.tsx deleted file mode 100644 index 8ee4b0915..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/action.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/action.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/actioncounts.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/actioncounts.tsx deleted file mode 100644 index 77d893e7a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/actioncounts.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/actioncounts.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/activedaycount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/activedaycount.tsx deleted file mode 100644 index 4b62eadb7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/activedaycount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/activedaycount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/activities.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/activities.tsx deleted file mode 100644 index 0ef890582..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/activities.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/activities.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/activitycount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/activitycount.tsx deleted file mode 100644 index 7ff9b6f4a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/activitycount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/activitycount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/activityinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/activityinsights.tsx deleted file mode 100644 index 3b3afa90e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/activityinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/activityinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/actor.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/actor.tsx deleted file mode 100644 index deba5b9c4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/actor.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/actor.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/addedroles.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/addedroles.tsx deleted file mode 100644 index 65c703eb7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/addedroles.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/addedroles.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/additionalfields.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/additionalfields.tsx deleted file mode 100644 index 33d0df14f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/additionalfields.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/additionalfields.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/additionalquerysuggestions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/additionalquerysuggestions.tsx deleted file mode 100644 index b09fc2623..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/additionalquerysuggestions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/additionalquerysuggestions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/agentconfig.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/agentconfig.tsx deleted file mode 100644 index 0d33e81d0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/agentconfig.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/agentconfig.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/aggregatevisitcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/aggregatevisitcount.tsx deleted file mode 100644 index 2ab45723c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/aggregatevisitcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/aggregatevisitcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/aiappinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/aiappinsights.tsx deleted file mode 100644 index 96b7fb9e1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/aiappinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/aiappinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/allclusteredresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/allclusteredresults.tsx deleted file mode 100644 index a8836a3bc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/allclusteredresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/allclusteredresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/allowedgroupintersections.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/allowedgroupintersections.tsx deleted file mode 100644 index 757884e45..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/allowedgroupintersections.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/allowedgroupintersections.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/allowedusers.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/allowedusers.tsx deleted file mode 100644 index b34e44916..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/allowedusers.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/allowedusers.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/allowlistoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/allowlistoptions.tsx deleted file mode 100644 index 4ba525720..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/allowlistoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/allowlistoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/announcement.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/announcement.tsx deleted file mode 100644 index b79644e15..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/announcement.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/announcement.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/answer.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/answer.tsx deleted file mode 100644 index d9731b737..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/answer.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/answer.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/answerauthor.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/answerauthor.tsx deleted file mode 100644 index 41074f536..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/answerauthor.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/answerauthor.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/answerboard.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/answerboard.tsx deleted file mode 100644 index e80e3cf49..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/answerboard.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/answerboard.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/app.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/app.tsx deleted file mode 100644 index d9b0b5a5f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/app.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/app.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/assignee.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/assignee.tsx deleted file mode 100644 index 0350ba84e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/assignee.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/assignee.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/assistantinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/assistantinsights.tsx deleted file mode 100644 index 6eacf666f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/assistantinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/assistantinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/attachments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/attachments.tsx deleted file mode 100644 index 46b22c5de..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/attachments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/attachments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/attendees.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/attendees.tsx deleted file mode 100644 index c32de3ed9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/attendees.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/attendees.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/attribution.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/attribution.tsx deleted file mode 100644 index ae1e90527..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/attribution.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/attribution.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/audiencefilters.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/audiencefilters.tsx deleted file mode 100644 index 7045c9fbb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/audiencefilters.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/audiencefilters.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/author.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/author.tsx deleted file mode 100644 index d74d5c6a5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/author.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/author.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/authtokens.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/authtokens.tsx deleted file mode 100644 index 153e905d5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/authtokens.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/authtokens.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/backlinkresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/backlinkresults.tsx deleted file mode 100644 index 469747234..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/backlinkresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/backlinkresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/banner.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/banner.tsx deleted file mode 100644 index 4c85fd7b2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/banner.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/banner.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/board.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/board.tsx deleted file mode 100644 index 4fc1bb276..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/board.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/board.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/body.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/body.tsx deleted file mode 100644 index ac8cd7a1f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/body.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/body.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/broadsharingoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/broadsharingoptions.tsx deleted file mode 100644 index ba548edf7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/broadsharingoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/broadsharingoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/buckets.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/buckets.tsx deleted file mode 100644 index 24f774f74..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/buckets.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/buckets.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/candidateverifiers.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/candidateverifiers.tsx deleted file mode 100644 index d65365de9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/candidateverifiers.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/candidateverifiers.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/capabilities.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/capabilities.tsx deleted file mode 100644 index 73faacf8e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/capabilities.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/capabilities.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/categorytoresultsize.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/categorytoresultsize.tsx deleted file mode 100644 index d13fa5b5d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/categorytoresultsize.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/categorytoresultsize.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/chat.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/chat.tsx deleted file mode 100644 index ffa217189..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/chat.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/chat.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/chatsuggestion.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/chatsuggestion.tsx deleted file mode 100644 index b4f417468..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/chatsuggestion.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/chatsuggestion.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/chattranscript.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/chattranscript.tsx deleted file mode 100644 index 68ff07781..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/chattranscript.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/chattranscript.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/chatzerostatesuggestionoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/chatzerostatesuggestionoptions.tsx deleted file mode 100644 index 9da38c9e3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/chatzerostatesuggestionoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/chatzerostatesuggestionoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/children.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/children.tsx deleted file mode 100644 index 09d7471e1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/children.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/children.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/citation.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/citation.tsx deleted file mode 100644 index 42183c2f9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/citation.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/citation.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/citations.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/citations.tsx deleted file mode 100644 index 8e1f37b7e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/citations.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/citations.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/classifications.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/classifications.tsx deleted file mode 100644 index dc14a65e5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/classifications.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/classifications.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/clickcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/clickcount.tsx deleted file mode 100644 index fd8640093..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/clickcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/clickcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/clusteredresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/clusteredresults.tsx deleted file mode 100644 index d673f3194..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/clusteredresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/clusteredresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/code.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/code.tsx deleted file mode 100644 index f0fc8a2dd..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/code.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/code.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/collection.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/collection.tsx deleted file mode 100644 index 7cc3d6dad..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/collection.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/collection.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/collectionitem.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/collectionitem.tsx deleted file mode 100644 index 05fdf8bd1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/collectionitem.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/collectionitem.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/collections.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/collections.tsx deleted file mode 100644 index 5906481ea..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/collections.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/collections.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/combinedanswertext.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/combinedanswertext.tsx deleted file mode 100644 index 3fd4444c3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/combinedanswertext.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/combinedanswertext.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/comments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/comments.tsx deleted file mode 100644 index 02187345b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/comments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/comments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/company.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/company.tsx deleted file mode 100644 index 33e4d3d4f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/company.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/company.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/conferencedata.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/conferencedata.tsx deleted file mode 100644 index 340cc9d64..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/conferencedata.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/conferencedata.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/config.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/config.tsx deleted file mode 100644 index bdf45101e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/config.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/config.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/containerdocument.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/containerdocument.tsx deleted file mode 100644 index bb30e7bbe..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/containerdocument.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/containerdocument.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/content.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/content.tsx deleted file mode 100644 index de0f70819..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/content.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/content.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/context.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/context.tsx deleted file mode 100644 index c9d08dc4e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/context.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/context.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/countinfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/countinfo.tsx deleted file mode 100644 index 9d3b610b1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/countinfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/countinfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/createdby.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/createdby.tsx deleted file mode 100644 index 6432d5d71..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/createdby.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/createdby.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/creator.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/creator.tsx deleted file mode 100644 index 76a19d6d7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/creator.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/creator.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/customentity.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/customentity.tsx deleted file mode 100644 index efeaf31da..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/customentity.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/customentity.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/customer.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/customer.tsx deleted file mode 100644 index 0f2124153..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/customer.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/customer.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/customfields.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/customfields.tsx deleted file mode 100644 index 9f7adecd2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/customfields.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/customfields.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/customproperties.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/customproperties.tsx deleted file mode 100644 index de598d38b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/customproperties.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/customproperties.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/customtimerange.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/customtimerange.tsx deleted file mode 100644 index 745f2304c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/customtimerange.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/customtimerange.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/datasourceprofiles.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/datasourceprofiles.tsx deleted file mode 100644 index b8891c756..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/datasourceprofiles.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/datasourceprofiles.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/debuginfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/debuginfo.tsx deleted file mode 100644 index 9243e9348..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/debuginfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/debuginfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/destinationdocument.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/destinationdocument.tsx deleted file mode 100644 index 9b1004bc2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/destinationdocument.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/destinationdocument.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/digest.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/digest.tsx deleted file mode 100644 index 00bf32f55..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/digest.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/digest.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/disambiguation.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/disambiguation.tsx deleted file mode 100644 index 4dc05c330..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/disambiguation.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/disambiguation.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/document.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/document.tsx deleted file mode 100644 index 4f522fe63..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/document.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/document.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/documentinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/documentinsights.tsx deleted file mode 100644 index ca6305bf5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/documentinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/documentinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/documents.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/documents.tsx deleted file mode 100644 index f1fdd9e4f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/documents.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/documents.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/documentvisitorcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/documentvisitorcount.tsx deleted file mode 100644 index 5a1bcc531..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/documentvisitorcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/documentvisitorcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/eligiblepins.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/eligiblepins.tsx deleted file mode 100644 index 7d2a69e20..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/eligiblepins.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/eligiblepins.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/emails.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/emails.tsx deleted file mode 100644 index 5c29369be..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/emails.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/emails.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/end.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/end.tsx deleted file mode 100644 index 76ebd6c0d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/end.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/end.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/event.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/event.tsx deleted file mode 100644 index e59efd92d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/event.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/event.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/exclusions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/exclusions.tsx deleted file mode 100644 index 8e9145723..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/exclusions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/exclusions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/existingpins.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/existingpins.tsx deleted file mode 100644 index 9715b59c8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/existingpins.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/existingpins.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/externallinks.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/externallinks.tsx deleted file mode 100644 index 0e478c02f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/externallinks.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/externallinks.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/externalsharingoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/externalsharingoptions.tsx deleted file mode 100644 index 50da58513..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/externalsharingoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/externalsharingoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/extractedqna.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/extractedqna.tsx deleted file mode 100644 index 130f36494..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/extractedqna.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/extractedqna.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/facetbucketfilter.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/facetbucketfilter.tsx deleted file mode 100644 index d1f6419ee..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/facetbucketfilter.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/facetbucketfilter.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/facetfilters.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/facetfilters.tsx deleted file mode 100644 index 3b133206e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/facetfilters.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/facetfilters.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/facetfiltersets.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/facetfiltersets.tsx deleted file mode 100644 index 9eefa088e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/facetfiltersets.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/facetfiltersets.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/facetresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/facetresults.tsx deleted file mode 100644 index c8ddc28d6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/facetresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/facetresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/favoriteinfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/favoriteinfo.tsx deleted file mode 100644 index be04aa703..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/favoriteinfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/favoriteinfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/file.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/file.tsx deleted file mode 100644 index 631eff719..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/file.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/file.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/filters.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/filters.tsx deleted file mode 100644 index f576694a9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/filters.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/filters.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/followupactions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/followupactions.tsx deleted file mode 100644 index 41e8842e7..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/followupactions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/followupactions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/fragments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/fragments.tsx deleted file mode 100644 index d8c14375c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/fragments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/fragments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/generatedattachments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/generatedattachments.tsx deleted file mode 100644 index a688294c9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/generatedattachments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/generatedattachments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/generatedqna.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/generatedqna.tsx deleted file mode 100644 index 3207b4bb5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/generatedqna.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/generatedqna.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/generatedqnaresult.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/generatedqnaresult.tsx deleted file mode 100644 index d743b9e47..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/generatedqnaresult.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/generatedqnaresult.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/gleandataerror.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/gleandataerror.tsx deleted file mode 100644 index d52c0aeac..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/gleandataerror.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/gleandataerror.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/group.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/group.tsx deleted file mode 100644 index ce463247d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/group.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/group.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/groupattendees.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/groupattendees.tsx deleted file mode 100644 index aba26301a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/groupattendees.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/groupattendees.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/hotwords.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/hotwords.tsx deleted file mode 100644 index ab5c21ceb..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/hotwords.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/hotwords.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/icon.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/icon.tsx deleted file mode 100644 index 82d46ce44..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/icon.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/icon.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/iconconfig.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/iconconfig.tsx deleted file mode 100644 index 2b05b0a54..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/iconconfig.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/iconconfig.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/implementations.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/implementations.tsx deleted file mode 100644 index e6aa2fa55..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/implementations.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/implementations.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/inactiveinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/inactiveinsights.tsx deleted file mode 100644 index 616658f96..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/inactiveinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/inactiveinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/inclusions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/inclusions.tsx deleted file mode 100644 index d59318cb0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/inclusions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/inclusions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/inputdetails.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/inputdetails.tsx deleted file mode 100644 index e563c8104..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/inputdetails.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/inputdetails.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/inputoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/inputoptions.tsx deleted file mode 100644 index f8eb62448..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/inputoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/inputoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/interactions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/interactions.tsx deleted file mode 100644 index 7e74f043e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/interactions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/interactions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/items.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/items.tsx deleted file mode 100644 index b3a4b763a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/items.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/items.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/lastreminder.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/lastreminder.tsx deleted file mode 100644 index a15b7f7a9..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/lastreminder.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/lastreminder.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/lastverifier.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/lastverifier.tsx deleted file mode 100644 index 6355e336b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/lastverifier.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/lastverifier.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/likedby.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/likedby.tsx deleted file mode 100644 index 39872996d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/likedby.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/likedby.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/likes.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/likes.tsx deleted file mode 100644 index d25958626..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/likes.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/likes.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/lines.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/lines.tsx deleted file mode 100644 index 145fe2176..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/lines.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/lines.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/lowperformingqueryinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/lowperformingqueryinsights.tsx deleted file mode 100644 index c4d9053a8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/lowperformingqueryinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/lowperformingqueryinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/meeting.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/meeting.tsx deleted file mode 100644 index e91372755..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/meeting.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/meeting.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/members.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/members.tsx deleted file mode 100644 index d69a3c579..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/members.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/members.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/mergedcustomers.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/mergedcustomers.tsx deleted file mode 100644 index 50eb2eef5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/mergedcustomers.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/mergedcustomers.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/messages.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/messages.tsx deleted file mode 100644 index 370d25333..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/messages.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/messages.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/metadata.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/metadata.tsx deleted file mode 100644 index abf939960..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/metadata.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/metadata.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/mustincludesuggestions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/mustincludesuggestions.tsx deleted file mode 100644 index f14278c10..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/mustincludesuggestions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/mustincludesuggestions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/objects.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/objects.tsx deleted file mode 100644 index 49f08dc45..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/objects.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/objects.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/operatormetadata.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/operatormetadata.tsx deleted file mode 100644 index 99462482e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/operatormetadata.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/operatormetadata.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/owner.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/owner.tsx deleted file mode 100644 index 24a317c9f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/owner.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/owner.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/parameters.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/parameters.tsx deleted file mode 100644 index c4178490b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/parameters.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/parameters.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/params.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/params.tsx deleted file mode 100644 index 2052e01d5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/params.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/params.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/parentdocument.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/parentdocument.tsx deleted file mode 100644 index 23c6287e1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/parentdocument.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/parentdocument.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/people.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/people.tsx deleted file mode 100644 index 2568cb85f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/people.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/people.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/period.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/period.tsx deleted file mode 100644 index 9f3c85c37..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/period.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/period.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/permissions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/permissions.tsx deleted file mode 100644 index 0bb800d87..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/permissions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/permissions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/person.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/person.tsx deleted file mode 100644 index e58a86e00..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/person.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/person.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/pinmetadata.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/pinmetadata.tsx deleted file mode 100644 index 9cf8a977b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/pinmetadata.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/pinmetadata.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/pins.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/pins.tsx deleted file mode 100644 index 6a66e234c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/pins.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/pins.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/poc.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/poc.tsx deleted file mode 100644 index 20358164a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/poc.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/poc.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/possiblevalues.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/possiblevalues.tsx deleted file mode 100644 index 7701eaea5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/possiblevalues.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/possiblevalues.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/primaryentry.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/primaryentry.tsx deleted file mode 100644 index 656a7d461..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/primaryentry.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/primaryentry.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/prompttemplate.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/prompttemplate.tsx deleted file mode 100644 index 816475edd..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/prompttemplate.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/prompttemplate.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/properties.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/properties.tsx deleted file mode 100644 index 6a84d51f4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/properties.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/properties.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/propertydefinitions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/propertydefinitions.tsx deleted file mode 100644 index 176234daf..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/propertydefinitions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/propertydefinitions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/propertygroups.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/propertygroups.tsx deleted file mode 100644 index 5198c471a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/propertygroups.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/propertygroups.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/proximity.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/proximity.tsx deleted file mode 100644 index f7fb49c6e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/proximity.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/proximity.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/queryinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/queryinsights.tsx deleted file mode 100644 index 5a9f40323..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/queryinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/queryinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestion.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestion.tsx deleted file mode 100644 index 3d6317e53..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestion.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/querysuggestion.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestions.tsx deleted file mode 100644 index 349369d62..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/querysuggestions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/querysuggestions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/questionresult.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/questionresult.tsx deleted file mode 100644 index a5629d5bc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/questionresult.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/questionresult.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/quicklink.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/quicklink.tsx deleted file mode 100644 index 368d6eaef..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/quicklink.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/quicklink.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/ranges.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/ranges.tsx deleted file mode 100644 index e0ac045f2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/ranges.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/ranges.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/referenceranges.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/referenceranges.tsx deleted file mode 100644 index 6fd05725d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/referenceranges.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/referenceranges.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/relateddocuments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/relateddocuments.tsx deleted file mode 100644 index 158d9a8c5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/relateddocuments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/relateddocuments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/relatedobjects.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/relatedobjects.tsx deleted file mode 100644 index 8b0bb15d1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/relatedobjects.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/relatedobjects.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/relatedquestion.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/relatedquestion.tsx deleted file mode 100644 index 88790e395..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/relatedquestion.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/relatedquestion.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/relatedresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/relatedresults.tsx deleted file mode 100644 index 6b5b22de8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/relatedresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/relatedresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/relationships.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/relationships.tsx deleted file mode 100644 index 64ec3e127..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/relationships.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/relationships.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/reminders.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/reminders.tsx deleted file mode 100644 index 39b264632..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/reminders.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/reminders.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/removedroles.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/removedroles.tsx deleted file mode 100644 index a1aff4f52..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/removedroles.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/removedroles.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/requestoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/requestoptions.tsx deleted file mode 100644 index e8703f297..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/requestoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/requestoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/requestor.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/requestor.tsx deleted file mode 100644 index c167014d4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/requestor.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/requestor.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/responsemetadata.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/responsemetadata.tsx deleted file mode 100644 index f6753a75b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/responsemetadata.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/responsemetadata.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/resultdocuments.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/resultdocuments.tsx deleted file mode 100644 index f7035b6cc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/resultdocuments.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/resultdocuments.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/results.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/results.tsx deleted file mode 100644 index 178c584b5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/results.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/results.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/resultsdescription.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/resultsdescription.tsx deleted file mode 100644 index 0a8b08a3f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/resultsdescription.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/resultsdescription.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/resulttabs.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/resulttabs.tsx deleted file mode 100644 index 28810d589..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/resulttabs.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/resulttabs.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/rewrittenfacetfilters.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/rewrittenfacetfilters.tsx deleted file mode 100644 index 3bd3be6da..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/rewrittenfacetfilters.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/rewrittenfacetfilters.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/roles.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/roles.tsx deleted file mode 100644 index b8940bb9c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/roles.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/roles.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/runcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/runcount.tsx deleted file mode 100644 index ff759a4ca..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/runcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/runcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/scopes.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/scopes.tsx deleted file mode 100644 index d853dd420..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/scopes.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/scopes.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchcount.tsx deleted file mode 100644 index b463ff04a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchedqueryranges.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchedqueryranges.tsx deleted file mode 100644 index 64ce99d4f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchedqueryranges.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchedqueryranges.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchorcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchorcount.tsx deleted file mode 100644 index 2f88b02b8..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchorcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchorcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchproviderinfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchproviderinfo.tsx deleted file mode 100644 index 01080d0e4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchproviderinfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchproviderinfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchwarning.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchwarning.tsx deleted file mode 100644 index d75306cd6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchwarning.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchwarning.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/searchwithclickcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/searchwithclickcount.tsx deleted file mode 100644 index 0a22160d4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/searchwithclickcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/searchwithclickcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/secondaryentries.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/secondaryentries.tsx deleted file mode 100644 index 90e4d41b1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/secondaryentries.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/secondaryentries.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sections.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sections.tsx deleted file mode 100644 index 9cfe4f6c1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sections.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sections.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sensitivecontentoptions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sensitivecontentoptions.tsx deleted file mode 100644 index 1bb01a745..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sensitivecontentoptions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sensitivecontentoptions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveinfotypes.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveinfotypes.tsx deleted file mode 100644 index 6547c89a0..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveinfotypes.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sensitiveinfotypes.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveregexes.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveregexes.tsx deleted file mode 100644 index 87c071830..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveregexes.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sensitiveregexes.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveterms.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveterms.tsx deleted file mode 100644 index 2f7e372ef..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sensitiveterms.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sensitiveterms.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sessioninfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sessioninfo.tsx deleted file mode 100644 index ce53a5e93..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sessioninfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sessioninfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/shortcut.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/shortcut.tsx deleted file mode 100644 index 7f95b38f4..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/shortcut.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/shortcut.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/shortcutinsights.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/shortcutinsights.tsx deleted file mode 100644 index cf39fd5b2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/shortcutinsights.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/shortcutinsights.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/similarqueries.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/similarqueries.tsx deleted file mode 100644 index 2e15a60ec..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/similarqueries.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/similarqueries.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/snippets.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/snippets.tsx deleted file mode 100644 index 515f7300a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/snippets.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/snippets.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/socialnetworks.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/socialnetworks.tsx deleted file mode 100644 index 494fe47b1..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/socialnetworks.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/socialnetworks.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sourcedocument.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sourcedocument.tsx deleted file mode 100644 index 193044346..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sourcedocument.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sourcedocument.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sourcefile.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sourcefile.tsx deleted file mode 100644 index aca5cd620..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sourcefile.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sourcefile.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/sourceperson.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/sourceperson.tsx deleted file mode 100644 index a68ec15de..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/sourceperson.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/sourceperson.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/start.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/start.tsx deleted file mode 100644 index f5c86b7fc..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/start.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/start.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/status.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/status.tsx deleted file mode 100644 index b53c9568d..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/status.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/status.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/structuredlist.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/structuredlist.tsx deleted file mode 100644 index 28b187337..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/structuredlist.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/structuredlist.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/structuredlocation.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/structuredlocation.tsx deleted file mode 100644 index 76af54b67..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/structuredlocation.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/structuredlocation.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/structuredresult.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/structuredresult.tsx deleted file mode 100644 index afa11de77..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/structuredresult.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/structuredresult.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/structuredresults.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/structuredresults.tsx deleted file mode 100644 index 02423b6f3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/structuredresults.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/structuredresults.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/suggestions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/suggestions.tsx deleted file mode 100644 index c3a6ae4e5..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/suggestions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/suggestions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/summary.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/summary.tsx deleted file mode 100644 index dae9a694a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/summary.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/summary.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/target.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/target.tsx deleted file mode 100644 index 86ba26048..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/target.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/target.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/team.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/team.tsx deleted file mode 100644 index 878266a49..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/team.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/team.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/teams.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/teams.tsx deleted file mode 100644 index 53d22bc2f..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/teams.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/teams.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/textrange.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/textrange.tsx deleted file mode 100644 index e9ed74e99..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/textrange.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/textrange.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/thumbnail.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/thumbnail.tsx deleted file mode 100644 index 061cc7a4e..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/thumbnail.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/thumbnail.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/time.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/time.tsx deleted file mode 100644 index 8780cd382..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/time.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/time.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/uiconfig.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/uiconfig.tsx deleted file mode 100644 index dcc9a7d11..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/uiconfig.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/uiconfig.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/updatedby.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/updatedby.tsx deleted file mode 100644 index ea90fb6d6..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/updatedby.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/updatedby.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/uploadedpermissions.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/uploadedpermissions.tsx deleted file mode 100644 index e637e836b..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/uploadedpermissions.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/uploadedpermissions.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/user.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/user.tsx deleted file mode 100644 index 6a0dfb5be..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/user.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/user.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/value.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/value.tsx deleted file mode 100644 index d21ba8395..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/value.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/value.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/values.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/values.tsx deleted file mode 100644 index f145df9c3..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/values.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/values.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/verification.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/verification.tsx deleted file mode 100644 index 90c8be8ce..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/verification.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/verification.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/viewcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/viewcount.tsx deleted file mode 100644 index 4b15d0bd2..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/viewcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/viewcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/viewerinfo.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/viewerinfo.tsx deleted file mode 100644 index 7443dff1a..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/viewerinfo.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/viewerinfo.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/visitcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/visitcount.tsx deleted file mode 100644 index 389a08c9c..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/visitcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/visitcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/visitorcount.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/visitorcount.tsx deleted file mode 100644 index 379387c49..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/visitorcount.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/visitorcount.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/workflow.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/workflow.tsx deleted file mode 100644 index a7a3ded11..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/workflow.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/workflow.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/components/glean-embeds/loaders/write.tsx b/examples/docusaurus/src/components/glean-embeds/loaders/write.tsx deleted file mode 100644 index fcec2e195..000000000 --- a/examples/docusaurus/src/components/glean-embeds/loaders/write.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import { lazy, Suspense } from "react"; - -// This import needs to have a literal value so bundlers can statically -// analyze this component. This is why we don't use a generic component that -// takes in a 'src' property, or anything like that. -const Contents = lazy(() => import("../contents/write.mdx")); - -export default function() { - return ( - Loading...}> - - - ); -} diff --git a/examples/docusaurus/src/css/custom.css b/examples/docusaurus/src/css/custom.css deleted file mode 100644 index 2bc6a4cfd..000000000 --- a/examples/docusaurus/src/css/custom.css +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} diff --git a/examples/docusaurus/src/pages/index.module.css b/examples/docusaurus/src/pages/index.module.css deleted file mode 100644 index 33ead3fe3..000000000 --- a/examples/docusaurus/src/pages/index.module.css +++ /dev/null @@ -1,24 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 996px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; - gap: 8px; -} diff --git a/examples/docusaurus/src/pages/index.tsx b/examples/docusaurus/src/pages/index.tsx deleted file mode 100644 index 2f7420c39..000000000 --- a/examples/docusaurus/src/pages/index.tsx +++ /dev/null @@ -1,55 +0,0 @@ -import type { ReactNode } from "react"; -import clsx from "clsx"; -import Link from "@docusaurus/Link"; -import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; -import Layout from "@theme/Layout"; -import HomepageFeatures from "@site/src/components/HomepageFeatures"; -import Heading from "@theme/Heading"; - -import styles from "./index.module.css"; - -function HomepageHeader() { - const { siteConfig } = useDocusaurusContext(); - return ( -
    -
    - - {siteConfig.title} - -

    {siteConfig.tagline}

    -
    - - PokeAPI - - - Glean - - - Mistral - -
    -
    -
    - ); -} - -export default function Home(): ReactNode { - const { siteConfig } = useDocusaurusContext(); - return ( - - -
    - -
    -     - ); -} diff --git a/examples/docusaurus/src/pages/markdown-page.md b/examples/docusaurus/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b66..000000000 --- a/examples/docusaurus/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/examples/docusaurus/tsconfig.json b/examples/docusaurus/tsconfig.json deleted file mode 100644 index 920d7a652..000000000 --- a/examples/docusaurus/tsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - // This file is not used in compilation. It is here just for a nice editor experience. - "extends": "@docusaurus/tsconfig", - "compilerOptions": { - "baseUrl": "." - }, - "exclude": [".docusaurus", "build"] -} diff --git a/examples/nextra/next-env.d.ts b/examples/nextra/next-env.d.ts deleted file mode 100644 index 830fb594c..000000000 --- a/examples/nextra/next-env.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -/// -/// -/// - -// NOTE: This file should not be edited -// see https://nextjs.org/docs/app/api-reference/config/typescript for more information. diff --git a/examples/nextra/next.config.ts b/examples/nextra/next.config.ts deleted file mode 100644 index 334bd6712..000000000 --- a/examples/nextra/next.config.ts +++ /dev/null @@ -1,23 +0,0 @@ -import nextra from "nextra"; -import lit from "@lit-labs/nextjs"; - -// Set up Nextra with its configuration -const withNextra = nextra({ - // ... Add Nextra-specific options here -}); - -const withLit = lit({ - webpackModuleRulesTest: /.*\.(js|jsx|ts|tsx|mdx)$/, -}); - -// Export the final Next.js config with Nextra and Lit SSR included -export default withNextra( - withLit({ - // Transpile @speakeasy-api packages so they work during SSR - transpilePackages: [ - "@speakeasy-api/docs-md-components", - "@speakeasy-api/docs-md-react", - ], - output: "export", - }) -); diff --git a/examples/nextra/package.json b/examples/nextra/package.json deleted file mode 100644 index 6803c9d5d..000000000 --- a/examples/nextra/package.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "name": "merged-nextra", - "version": "1.0.0", - "main": "index.js", - "scripts": { - "dev": "rm -rf .next && next -p 3002", - "build-api-docs": "docs-md -c speakeasy.mistral.config.mjs && docs-md -c speakeasy.pokeapi.config.mjs", - "prebuild": "cd ../../ && make build-packages", - "clean": "rm -rf .next node_modules/.cache out", - "build": "next build", - "postbuild": "pagefind --site .next/server/app --output-path out/_pagefind", - "start": "http-server out -p 3002" - }, - "author": "", - "license": "ISC", - "description": "", - "dependencies": { - "@lit-labs/nextjs": "^0.2.4", - "@radix-ui/colors": "^3.0.0", - "@speakeasy-api/docs-md": "*", - "@speakeasy-api/docs-md-react": "*", - "jotai": "^2.12.5", - "motion": "^12.16.0", - "next": "^15.5.3", - "nextra": "^4.2.17", - "nextra-theme-docs": "^4.2.17", - "radix-ui": "^1.3.4", - "react": "^19.1.0", - "react-dom": "^19.1.0", - "react-use-measure": "^2.1.7", - "@lit-labs/ssr-react": "^0.3.0", - "@webcomponents/template-shadowroot": "^0.2.1", - "imports-loader": "^4.0.1" - }, - "devDependencies": { - "@types/node": "22.15.3", - "@types/react": "^19.1.2", - "http-server": "^14.1.1", - "pagefind": "^1.3.0" - } -} \ No newline at end of file diff --git a/examples/nextra/public/mistral-try-it-now/deps.js b/examples/nextra/public/mistral-try-it-now/deps.js deleted file mode 100644 index 151a02dbc..000000000 --- a/examples/nextra/public/mistral-try-it-now/deps.js +++ /dev/null @@ -1,41456 +0,0 @@ -(() => { - var __create = Object.create; - var __defProp = Object.defineProperty; - var __getOwnPropDesc = Object.getOwnPropertyDescriptor; - var __getOwnPropNames = Object.getOwnPropertyNames; - var __getProtoOf = Object.getPrototypeOf; - var __hasOwnProp = Object.prototype.hasOwnProperty; - var __commonJS = (cb, mod) => function __require() { - return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports; - }; - var __copyProps = (to, from, except, desc) => { - if (from && typeof from === "object" || typeof from === "function") { - for (let key of __getOwnPropNames(from)) - if (!__hasOwnProp.call(to, key) && key !== except) - __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); - } - return to; - }; - var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps( - // If the importer is in node compatibility mode or this is not an ESM - // file that has been converted to a CommonJS file using a Babel- - // compatible transform (i.e. "__esModule" has not been set), then set - // "default" to the CommonJS "module.exports" for node compatibility. - isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, - mod - )); - - // node_modules/@mistralai/mistralai/lib/url.js - var require_url = __commonJS({ - "node_modules/@mistralai/mistralai/lib/url.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.pathToFunc = pathToFunc; - var hasOwn = Object.prototype.hasOwnProperty; - function pathToFunc(pathPattern, options) { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - return function buildURLPath(params = {}) { - return pathPattern.replace(paramRE, function(_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error(`Parameter '${placeholder}' must be a string or number`); - } - return options?.charEncoding === "percent" ? encodeURIComponent(`${value}`) : `${value}`; - }); - }; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/config.js - var require_config = __commonJS({ - "node_modules/@mistralai/mistralai/lib/config.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDK_METADATA = exports.ServerList = exports.ServerEu = void 0; - exports.serverURLFromOptions = serverURLFromOptions; - var url_js_1 = require_url(); - exports.ServerEu = "eu"; - exports.ServerList = { - [exports.ServerEu]: "https://api.mistral.ai" - }; - function serverURLFromOptions(options) { - let serverURL = options.serverURL; - const params = {}; - if (!serverURL) { - const server = options.server ?? exports.ServerEu; - serverURL = exports.ServerList[server] || ""; - } - const u = (0, url_js_1.pathToFunc)(serverURL)(params); - return new URL(u); - } - exports.SDK_METADATA = { - language: "typescript", - openapiDocVersion: "1.0.0", - sdkVersion: "1.10.0", - genVersion: "2.687.13", - userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai" - }; - } - }); - - // node_modules/@mistralai/mistralai/lib/files.js - var require_files = __commonJS({ - "node_modules/@mistralai/mistralai/lib/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.readableStreamToArrayBuffer = readableStreamToArrayBuffer; - exports.getContentTypeFromFileName = getContentTypeFromFileName; - async function readableStreamToArrayBuffer(readable) { - const reader = readable.getReader(); - const chunks = []; - let totalLength = 0; - let done = false; - while (!done) { - const { value, done: doneReading } = await reader.read(); - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - return concatenatedChunks.buffer; - } - function getContentTypeFromFileName(fileName) { - if (!fileName) - return null; - const ext = fileName.toLowerCase().split(".").pop(); - if (!ext) - return null; - const mimeTypes = { - json: "application/json", - xml: "application/xml", - html: "text/html", - htm: "text/html", - txt: "text/plain", - csv: "text/csv", - pdf: "application/pdf", - png: "image/png", - jpg: "image/jpeg", - jpeg: "image/jpeg", - gif: "image/gif", - svg: "image/svg+xml", - js: "application/javascript", - css: "text/css", - zip: "application/zip", - tar: "application/x-tar", - gz: "application/gzip", - mp4: "video/mp4", - mp3: "audio/mpeg", - wav: "audio/wav", - webp: "image/webp", - ico: "image/x-icon", - woff: "font/woff", - woff2: "font/woff2", - ttf: "font/ttf", - otf: "font/otf" - }; - return mimeTypes[ext] || null; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/http.js - var require_http = __commonJS({ - "node_modules/@mistralai/mistralai/lib/http.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = void 0; - exports.matchContentType = matchContentType; - exports.matchStatusCode = matchStatusCode; - exports.matchResponse = matchResponse; - exports.isConnectionError = isConnectionError; - exports.isTimeoutError = isTimeoutError; - exports.isAbortError = isAbortError; - var DEFAULT_FETCHER = (input, init) => { - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } - }; - var HTTPClient = class _HTTPClient { - constructor(options = {}) { - this.options = options; - this.requestHooks = []; - this.requestErrorHooks = []; - this.responseHooks = []; - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - async request(request) { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - try { - const res = await this.fetcher(req); - for (const hook of this.responseHooks) { - await hook(res, req); - } - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - throw err; - } - } - addHook(...args) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - removeHook(...args) { - let target; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - return this; - } - clone() { - const child = new _HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - return child; - } - }; - exports.HTTPClient = HTTPClient; - var mediaParamSeparator = /\s*;\s*/g; - function matchContentType(response, pattern) { - if (pattern === "*") { - return true; - } - let contentType = response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - if (wantType.split("/").length !== 2) { - return false; - } - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - if (wantType !== "*/*" && gotType !== wantType && `${type}/*` !== wantType && `*/${subtype}` !== wantType) { - return false; - } - if (gotParams.length < wantParams.length) { - return false; - } - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - return true; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function matchStatusCode(response, codes) { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - return expectedCodes.some((ec) => { - const code = `${ec}`; - if (code === "default") { - return true; - } - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - function matchResponse(response, code, contentTypePattern) { - return matchStatusCode(response, code) && matchContentType(response, contentTypePattern); - } - function isConnectionError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isBrowserErr = err instanceof TypeError && err.message.toLowerCase().startsWith("failed to fetch"); - const isNodeErr = err instanceof TypeError && err.message.toLowerCase().startsWith("fetch failed"); - const isBunErr = "name" in err && err.name === "ConnectionError"; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnreset"; - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; - } - function isTimeoutError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - function isAbortError(err) { - if (typeof err !== "object" || err == null) { - return false; - } - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - const isGenericErr = "code" in err && typeof err.code === "string" && err.code.toLowerCase() === "econnaborted"; - return isNative || isLegacyNative || isGenericErr; - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/custom_user_agent.js - var require_custom_user_agent = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/custom_user_agent.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CustomUserAgentHook = void 0; - var config_1 = require_config(); - var CustomUserAgentHook = class { - beforeRequest(_, request) { - const version = config_1.SDK_METADATA.sdkVersion; - const ua = `mistral-client-typescript/${version}`; - request.headers.set("user-agent", ua); - if (!request.headers.get("user-agent")) { - request.headers.set("x-mistral-user-agent", ua); - } - return request; - } - }; - exports.CustomUserAgentHook = CustomUserAgentHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/deprecation_warning.js - var require_deprecation_warning = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/deprecation_warning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeprecationWarningHook = void 0; - var HEADER_MODEL_DEPRECATION_TIMESTAMP = "x-model-deprecation-timestamp"; - var DeprecationWarningHook = class { - afterSuccess(_, response) { - if (response.headers.has(HEADER_MODEL_DEPRECATION_TIMESTAMP)) { - response.clone().json().then((body) => { - const model = body.model; - console.warn(`WARNING: The model ${model} is deprecated and will be removed on ${response.headers.get(HEADER_MODEL_DEPRECATION_TIMESTAMP)}. Please refer to https://docs.mistral.ai/getting-started/models/#api-versioning for more information.`); - }); - } - return response; - } - }; - exports.DeprecationWarningHook = DeprecationWarningHook; - } - }); - - // node_modules/@mistralai/mistralai/hooks/registration.js - var require_registration = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/registration.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.initHooks = initHooks; - var custom_user_agent_1 = require_custom_user_agent(); - var deprecation_warning_1 = require_deprecation_warning(); - function initHooks(hooks) { - const customUserAgentHook = new custom_user_agent_1.CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook); - const deprecationWarningHook = new deprecation_warning_1.DeprecationWarningHook(); - hooks.registerAfterSuccessHook(deprecationWarningHook); - } - } - }); - - // node_modules/@mistralai/mistralai/hooks/hooks.js - var require_hooks = __commonJS({ - "node_modules/@mistralai/mistralai/hooks/hooks.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKHooks = void 0; - var registration_js_1 = require_registration(); - var SDKHooks = class { - constructor() { - this.sdkInitHooks = []; - this.beforeCreateRequestHooks = []; - this.beforeRequestHooks = []; - this.afterSuccessHooks = []; - this.afterErrorHooks = []; - const presetHooks = []; - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - (0, registration_js_1.initHooks)(this); - } - registerSDKInitHook(hook) { - this.sdkInitHooks.push(hook); - } - registerBeforeCreateRequestHook(hook) { - this.beforeCreateRequestHooks.push(hook); - } - registerBeforeRequestHook(hook) { - this.beforeRequestHooks.push(hook); - } - registerAfterSuccessHook(hook) { - this.afterSuccessHooks.push(hook); - } - registerAfterErrorHook(hook) { - this.afterErrorHooks.push(hook); - } - sdkInit(opts) { - return this.sdkInitHooks.reduce((opts2, hook) => hook.sdkInit(opts2), opts); - } - beforeCreateRequest(hookCtx, input) { - let inp = input; - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - return inp; - } - async beforeRequest(hookCtx, request) { - let req = request; - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - return req; - } - async afterSuccess(hookCtx, response) { - let res = response; - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - return res; - } - async afterError(hookCtx, response, error) { - let res = response; - let err = error; - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - return { response: res, error: err }; - } - }; - exports.SDKHooks = SDKHooks; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js - var require_httpclienterrors = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpclienterrors.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConnectionError = exports.RequestTimeoutError = exports.RequestAbortedError = exports.InvalidRequestError = exports.UnexpectedClientError = exports.HTTPClientError = void 0; - var HTTPClientError = class extends Error { - constructor(message, opts) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - super(msg, opts); - this.name = "HTTPClientError"; - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } - }; - exports.HTTPClientError = HTTPClientError; - var UnexpectedClientError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "UnexpectedClientError"; - } - }; - exports.UnexpectedClientError = UnexpectedClientError; - var InvalidRequestError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "InvalidRequestError"; - } - }; - exports.InvalidRequestError = InvalidRequestError; - var RequestAbortedError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestAbortedError"; - } - }; - exports.RequestAbortedError = RequestAbortedError; - var RequestTimeoutError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "RequestTimeoutError"; - } - }; - exports.RequestTimeoutError = RequestTimeoutError; - var ConnectionError = class extends HTTPClientError { - constructor() { - super(...arguments); - this.name = "ConnectionError"; - } - }; - exports.ConnectionError = ConnectionError; - } - }); - - // node_modules/@mistralai/mistralai/types/fp.js - var require_fp = __commonJS({ - "node_modules/@mistralai/mistralai/types/fp.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OK = OK; - exports.ERR = ERR; - exports.unwrap = unwrap; - exports.unwrapAsync = unwrapAsync; - function OK(value) { - return { ok: true, value }; - } - function ERR(error) { - return { ok: false, error }; - } - function unwrap(r) { - if (!r.ok) { - throw r.error; - } - return r.value; - } - async function unwrapAsync(pr) { - const r = await pr; - if (!r.ok) { - throw r.error; - } - return r.value; - } - } - }); - - // node_modules/zod/v3/helpers/util.cjs - var require_util = __commonJS({ - "node_modules/zod/v3/helpers/util.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getParsedType = exports.ZodParsedType = exports.objectUtil = exports.util = void 0; - var util; - (function(util2) { - util2.assertEqual = (_) => { - }; - function assertIs(_arg) { - } - util2.assertIs = assertIs; - function assertNever(_x) { - throw new Error(); - } - util2.assertNever = assertNever; - util2.arrayToEnum = (items) => { - const obj = {}; - for (const item of items) { - obj[item] = item; - } - return obj; - }; - util2.getValidEnumValues = (obj) => { - const validKeys = util2.objectKeys(obj).filter((k) => typeof obj[obj[k]] !== "number"); - const filtered = {}; - for (const k of validKeys) { - filtered[k] = obj[k]; - } - return util2.objectValues(filtered); - }; - util2.objectValues = (obj) => { - return util2.objectKeys(obj).map(function(e) { - return obj[e]; - }); - }; - util2.objectKeys = typeof Object.keys === "function" ? (obj) => Object.keys(obj) : (object) => { - const keys = []; - for (const key in object) { - if (Object.prototype.hasOwnProperty.call(object, key)) { - keys.push(key); - } - } - return keys; - }; - util2.find = (arr, checker) => { - for (const item of arr) { - if (checker(item)) - return item; - } - return void 0; - }; - util2.isInteger = typeof Number.isInteger === "function" ? (val) => Number.isInteger(val) : (val) => typeof val === "number" && Number.isFinite(val) && Math.floor(val) === val; - function joinValues(array, separator = " | ") { - return array.map((val) => typeof val === "string" ? `'${val}'` : val).join(separator); - } - util2.joinValues = joinValues; - util2.jsonStringifyReplacer = (_, value) => { - if (typeof value === "bigint") { - return value.toString(); - } - return value; - }; - })(util || (exports.util = util = {})); - var objectUtil; - (function(objectUtil2) { - objectUtil2.mergeShapes = (first, second) => { - return { - ...first, - ...second - // second overwrites first - }; - }; - })(objectUtil || (exports.objectUtil = objectUtil = {})); - exports.ZodParsedType = util.arrayToEnum([ - "string", - "nan", - "number", - "integer", - "float", - "boolean", - "date", - "bigint", - "symbol", - "function", - "undefined", - "null", - "array", - "object", - "unknown", - "promise", - "void", - "never", - "map", - "set" - ]); - var getParsedType = (data) => { - const t = typeof data; - switch (t) { - case "undefined": - return exports.ZodParsedType.undefined; - case "string": - return exports.ZodParsedType.string; - case "number": - return Number.isNaN(data) ? exports.ZodParsedType.nan : exports.ZodParsedType.number; - case "boolean": - return exports.ZodParsedType.boolean; - case "function": - return exports.ZodParsedType.function; - case "bigint": - return exports.ZodParsedType.bigint; - case "symbol": - return exports.ZodParsedType.symbol; - case "object": - if (Array.isArray(data)) { - return exports.ZodParsedType.array; - } - if (data === null) { - return exports.ZodParsedType.null; - } - if (data.then && typeof data.then === "function" && data.catch && typeof data.catch === "function") { - return exports.ZodParsedType.promise; - } - if (typeof Map !== "undefined" && data instanceof Map) { - return exports.ZodParsedType.map; - } - if (typeof Set !== "undefined" && data instanceof Set) { - return exports.ZodParsedType.set; - } - if (typeof Date !== "undefined" && data instanceof Date) { - return exports.ZodParsedType.date; - } - return exports.ZodParsedType.object; - default: - return exports.ZodParsedType.unknown; - } - }; - exports.getParsedType = getParsedType; - } - }); - - // node_modules/zod/v3/ZodError.cjs - var require_ZodError = __commonJS({ - "node_modules/zod/v3/ZodError.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ZodError = exports.quotelessJson = exports.ZodIssueCode = void 0; - var util_js_1 = require_util(); - exports.ZodIssueCode = util_js_1.util.arrayToEnum([ - "invalid_type", - "invalid_literal", - "custom", - "invalid_union", - "invalid_union_discriminator", - "invalid_enum_value", - "unrecognized_keys", - "invalid_arguments", - "invalid_return_type", - "invalid_date", - "invalid_string", - "too_small", - "too_big", - "invalid_intersection_types", - "not_multiple_of", - "not_finite" - ]); - var quotelessJson = (obj) => { - const json = JSON.stringify(obj, null, 2); - return json.replace(/"([^"]+)":/g, "$1:"); - }; - exports.quotelessJson = quotelessJson; - var ZodError = class _ZodError extends Error { - get errors() { - return this.issues; - } - constructor(issues) { - super(); - this.issues = []; - this.addIssue = (sub) => { - this.issues = [...this.issues, sub]; - }; - this.addIssues = (subs = []) => { - this.issues = [...this.issues, ...subs]; - }; - const actualProto = new.target.prototype; - if (Object.setPrototypeOf) { - Object.setPrototypeOf(this, actualProto); - } else { - this.__proto__ = actualProto; - } - this.name = "ZodError"; - this.issues = issues; - } - format(_mapper) { - const mapper = _mapper || function(issue) { - return issue.message; - }; - const fieldErrors = { _errors: [] }; - const processError = (error) => { - for (const issue of error.issues) { - if (issue.code === "invalid_union") { - issue.unionErrors.map(processError); - } else if (issue.code === "invalid_return_type") { - processError(issue.returnTypeError); - } else if (issue.code === "invalid_arguments") { - processError(issue.argumentsError); - } else if (issue.path.length === 0) { - fieldErrors._errors.push(mapper(issue)); - } else { - let curr = fieldErrors; - let i = 0; - while (i < issue.path.length) { - const el = issue.path[i]; - const terminal = i === issue.path.length - 1; - if (!terminal) { - curr[el] = curr[el] || { _errors: [] }; - } else { - curr[el] = curr[el] || { _errors: [] }; - curr[el]._errors.push(mapper(issue)); - } - curr = curr[el]; - i++; - } - } - } - }; - processError(this); - return fieldErrors; - } - static assert(value) { - if (!(value instanceof _ZodError)) { - throw new Error(`Not a ZodError: ${value}`); - } - } - toString() { - return this.message; - } - get message() { - return JSON.stringify(this.issues, util_js_1.util.jsonStringifyReplacer, 2); - } - get isEmpty() { - return this.issues.length === 0; - } - flatten(mapper = (issue) => issue.message) { - const fieldErrors = {}; - const formErrors = []; - for (const sub of this.issues) { - if (sub.path.length > 0) { - const firstEl = sub.path[0]; - fieldErrors[firstEl] = fieldErrors[firstEl] || []; - fieldErrors[firstEl].push(mapper(sub)); - } else { - formErrors.push(mapper(sub)); - } - } - return { formErrors, fieldErrors }; - } - get formErrors() { - return this.flatten(); - } - }; - exports.ZodError = ZodError; - ZodError.create = (issues) => { - const error = new ZodError(issues); - return error; - }; - } - }); - - // node_modules/zod/v3/locales/en.cjs - var require_en = __commonJS({ - "node_modules/zod/v3/locales/en.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - var ZodError_js_1 = require_ZodError(); - var util_js_1 = require_util(); - var errorMap = (issue, _ctx) => { - let message; - switch (issue.code) { - case ZodError_js_1.ZodIssueCode.invalid_type: - if (issue.received === util_js_1.ZodParsedType.undefined) { - message = "Required"; - } else { - message = `Expected ${issue.expected}, received ${issue.received}`; - } - break; - case ZodError_js_1.ZodIssueCode.invalid_literal: - message = `Invalid literal value, expected ${JSON.stringify(issue.expected, util_js_1.util.jsonStringifyReplacer)}`; - break; - case ZodError_js_1.ZodIssueCode.unrecognized_keys: - message = `Unrecognized key(s) in object: ${util_js_1.util.joinValues(issue.keys, ", ")}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_union_discriminator: - message = `Invalid discriminator value. Expected ${util_js_1.util.joinValues(issue.options)}`; - break; - case ZodError_js_1.ZodIssueCode.invalid_enum_value: - message = `Invalid enum value. Expected ${util_js_1.util.joinValues(issue.options)}, received '${issue.received}'`; - break; - case ZodError_js_1.ZodIssueCode.invalid_arguments: - message = `Invalid function arguments`; - break; - case ZodError_js_1.ZodIssueCode.invalid_return_type: - message = `Invalid function return type`; - break; - case ZodError_js_1.ZodIssueCode.invalid_date: - message = `Invalid date`; - break; - case ZodError_js_1.ZodIssueCode.invalid_string: - if (typeof issue.validation === "object") { - if ("includes" in issue.validation) { - message = `Invalid input: must include "${issue.validation.includes}"`; - if (typeof issue.validation.position === "number") { - message = `${message} at one or more positions greater than or equal to ${issue.validation.position}`; - } - } else if ("startsWith" in issue.validation) { - message = `Invalid input: must start with "${issue.validation.startsWith}"`; - } else if ("endsWith" in issue.validation) { - message = `Invalid input: must end with "${issue.validation.endsWith}"`; - } else { - util_js_1.util.assertNever(issue.validation); - } - } else if (issue.validation !== "regex") { - message = `Invalid ${issue.validation}`; - } else { - message = "Invalid"; - } - break; - case ZodError_js_1.ZodIssueCode.too_small: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `more than`} ${issue.minimum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? "exactly" : issue.inclusive ? `at least` : `over`} ${issue.minimum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "bigint") - message = `Number must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${issue.minimum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly equal to ` : issue.inclusive ? `greater than or equal to ` : `greater than `}${new Date(Number(issue.minimum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.too_big: - if (issue.type === "array") - message = `Array must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `less than`} ${issue.maximum} element(s)`; - else if (issue.type === "string") - message = `String must contain ${issue.exact ? `exactly` : issue.inclusive ? `at most` : `under`} ${issue.maximum} character(s)`; - else if (issue.type === "number") - message = `Number must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "bigint") - message = `BigInt must be ${issue.exact ? `exactly` : issue.inclusive ? `less than or equal to` : `less than`} ${issue.maximum}`; - else if (issue.type === "date") - message = `Date must be ${issue.exact ? `exactly` : issue.inclusive ? `smaller than or equal to` : `smaller than`} ${new Date(Number(issue.maximum))}`; - else - message = "Invalid input"; - break; - case ZodError_js_1.ZodIssueCode.custom: - message = `Invalid input`; - break; - case ZodError_js_1.ZodIssueCode.invalid_intersection_types: - message = `Intersection results could not be merged`; - break; - case ZodError_js_1.ZodIssueCode.not_multiple_of: - message = `Number must be a multiple of ${issue.multipleOf}`; - break; - case ZodError_js_1.ZodIssueCode.not_finite: - message = "Number must be finite"; - break; - default: - message = _ctx.defaultError; - util_js_1.util.assertNever(issue); - } - return { message }; - }; - exports.default = errorMap; - } - }); - - // node_modules/zod/v3/errors.cjs - var require_errors = __commonJS({ - "node_modules/zod/v3/errors.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.defaultErrorMap = void 0; - exports.setErrorMap = setErrorMap; - exports.getErrorMap = getErrorMap; - var en_js_1 = __importDefault(require_en()); - exports.defaultErrorMap = en_js_1.default; - var overrideErrorMap = en_js_1.default; - function setErrorMap(map) { - overrideErrorMap = map; - } - function getErrorMap() { - return overrideErrorMap; - } - } - }); - - // node_modules/zod/v3/helpers/parseUtil.cjs - var require_parseUtil = __commonJS({ - "node_modules/zod/v3/helpers/parseUtil.cjs"(exports) { - "use strict"; - var __importDefault = exports && exports.__importDefault || function(mod) { - return mod && mod.__esModule ? mod : { "default": mod }; - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isAsync = exports.isValid = exports.isDirty = exports.isAborted = exports.OK = exports.DIRTY = exports.INVALID = exports.ParseStatus = exports.EMPTY_PATH = exports.makeIssue = void 0; - exports.addIssueToContext = addIssueToContext; - var errors_js_1 = require_errors(); - var en_js_1 = __importDefault(require_en()); - var makeIssue = (params) => { - const { data, path, errorMaps, issueData } = params; - const fullPath = [...path, ...issueData.path || []]; - const fullIssue = { - ...issueData, - path: fullPath - }; - if (issueData.message !== void 0) { - return { - ...issueData, - path: fullPath, - message: issueData.message - }; - } - let errorMessage = ""; - const maps = errorMaps.filter((m) => !!m).slice().reverse(); - for (const map of maps) { - errorMessage = map(fullIssue, { data, defaultError: errorMessage }).message; - } - return { - ...issueData, - path: fullPath, - message: errorMessage - }; - }; - exports.makeIssue = makeIssue; - exports.EMPTY_PATH = []; - function addIssueToContext(ctx, issueData) { - const overrideMap = (0, errors_js_1.getErrorMap)(); - const issue = (0, exports.makeIssue)({ - issueData, - data: ctx.data, - path: ctx.path, - errorMaps: [ - ctx.common.contextualErrorMap, - // contextual error map is first priority - ctx.schemaErrorMap, - // then schema-bound map if available - overrideMap, - // then global override map - overrideMap === en_js_1.default ? void 0 : en_js_1.default - // then global default map - ].filter((x) => !!x) - }); - ctx.common.issues.push(issue); - } - var ParseStatus = class _ParseStatus { - constructor() { - this.value = "valid"; - } - dirty() { - if (this.value === "valid") - this.value = "dirty"; - } - abort() { - if (this.value !== "aborted") - this.value = "aborted"; - } - static mergeArray(status, results) { - const arrayValue = []; - for (const s of results) { - if (s.status === "aborted") - return exports.INVALID; - if (s.status === "dirty") - status.dirty(); - arrayValue.push(s.value); - } - return { status: status.value, value: arrayValue }; - } - static async mergeObjectAsync(status, pairs) { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value - }); - } - return _ParseStatus.mergeObjectSync(status, syncPairs); - } - static mergeObjectSync(status, pairs) { - const finalObject = {}; - for (const pair of pairs) { - const { key, value } = pair; - if (key.status === "aborted") - return exports.INVALID; - if (value.status === "aborted") - return exports.INVALID; - if (key.status === "dirty") - status.dirty(); - if (value.status === "dirty") - status.dirty(); - if (key.value !== "__proto__" && (typeof value.value !== "undefined" || pair.alwaysSet)) { - finalObject[key.value] = value.value; - } - } - return { status: status.value, value: finalObject }; - } - }; - exports.ParseStatus = ParseStatus; - exports.INVALID = Object.freeze({ - status: "aborted" - }); - var DIRTY = (value) => ({ status: "dirty", value }); - exports.DIRTY = DIRTY; - var OK = (value) => ({ status: "valid", value }); - exports.OK = OK; - var isAborted = (x) => x.status === "aborted"; - exports.isAborted = isAborted; - var isDirty = (x) => x.status === "dirty"; - exports.isDirty = isDirty; - var isValid = (x) => x.status === "valid"; - exports.isValid = isValid; - var isAsync = (x) => typeof Promise !== "undefined" && x instanceof Promise; - exports.isAsync = isAsync; - } - }); - - // node_modules/zod/v3/helpers/typeAliases.cjs - var require_typeAliases = __commonJS({ - "node_modules/zod/v3/helpers/typeAliases.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod/v3/helpers/errorUtil.cjs - var require_errorUtil = __commonJS({ - "node_modules/zod/v3/helpers/errorUtil.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.errorUtil = void 0; - var errorUtil; - (function(errorUtil2) { - errorUtil2.errToObj = (message) => typeof message === "string" ? { message } : message || {}; - errorUtil2.toString = (message) => typeof message === "string" ? message : message?.message; - })(errorUtil || (exports.errorUtil = errorUtil = {})); - } - }); - - // node_modules/zod/v3/types.cjs - var require_types = __commonJS({ - "node_modules/zod/v3/types.cjs"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.discriminatedUnion = exports.date = exports.boolean = exports.bigint = exports.array = exports.any = exports.coerce = exports.ZodFirstPartyTypeKind = exports.late = exports.ZodSchema = exports.Schema = exports.ZodReadonly = exports.ZodPipeline = exports.ZodBranded = exports.BRAND = exports.ZodNaN = exports.ZodCatch = exports.ZodDefault = exports.ZodNullable = exports.ZodOptional = exports.ZodTransformer = exports.ZodEffects = exports.ZodPromise = exports.ZodNativeEnum = exports.ZodEnum = exports.ZodLiteral = exports.ZodLazy = exports.ZodFunction = exports.ZodSet = exports.ZodMap = exports.ZodRecord = exports.ZodTuple = exports.ZodIntersection = exports.ZodDiscriminatedUnion = exports.ZodUnion = exports.ZodObject = exports.ZodArray = exports.ZodVoid = exports.ZodNever = exports.ZodUnknown = exports.ZodAny = exports.ZodNull = exports.ZodUndefined = exports.ZodSymbol = exports.ZodDate = exports.ZodBoolean = exports.ZodBigInt = exports.ZodNumber = exports.ZodString = exports.ZodType = void 0; - exports.NEVER = exports.void = exports.unknown = exports.union = exports.undefined = exports.tuple = exports.transformer = exports.symbol = exports.string = exports.strictObject = exports.set = exports.record = exports.promise = exports.preprocess = exports.pipeline = exports.ostring = exports.optional = exports.onumber = exports.oboolean = exports.object = exports.number = exports.nullable = exports.null = exports.never = exports.nativeEnum = exports.nan = exports.map = exports.literal = exports.lazy = exports.intersection = exports.instanceof = exports.function = exports.enum = exports.effect = void 0; - exports.datetimeRegex = datetimeRegex; - exports.custom = custom; - var ZodError_js_1 = require_ZodError(); - var errors_js_1 = require_errors(); - var errorUtil_js_1 = require_errorUtil(); - var parseUtil_js_1 = require_parseUtil(); - var util_js_1 = require_util(); - var ParseInputLazyPath = class { - constructor(parent, value, path, key) { - this._cachedPath = []; - this.parent = parent; - this.data = value; - this._path = path; - this._key = key; - } - get path() { - if (!this._cachedPath.length) { - if (Array.isArray(this._key)) { - this._cachedPath.push(...this._path, ...this._key); - } else { - this._cachedPath.push(...this._path, this._key); - } - } - return this._cachedPath; - } - }; - var handleResult = (ctx, result) => { - if ((0, parseUtil_js_1.isValid)(result)) { - return { success: true, data: result.value }; - } else { - if (!ctx.common.issues.length) { - throw new Error("Validation failed but no issues detected."); - } - return { - success: false, - get error() { - if (this._error) - return this._error; - const error = new ZodError_js_1.ZodError(ctx.common.issues); - this._error = error; - return this._error; - } - }; - } - }; - function processCreateParams(params) { - if (!params) - return {}; - const { errorMap, invalid_type_error, required_error, description } = params; - if (errorMap && (invalid_type_error || required_error)) { - throw new Error(`Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`); - } - if (errorMap) - return { errorMap, description }; - const customMap = (iss, ctx) => { - const { message } = params; - if (iss.code === "invalid_enum_value") { - return { message: message ?? ctx.defaultError }; - } - if (typeof ctx.data === "undefined") { - return { message: message ?? required_error ?? ctx.defaultError }; - } - if (iss.code !== "invalid_type") - return { message: ctx.defaultError }; - return { message: message ?? invalid_type_error ?? ctx.defaultError }; - }; - return { errorMap: customMap, description }; - } - var ZodType = class { - get description() { - return this._def.description; - } - _getType(input) { - return (0, util_js_1.getParsedType)(input.data); - } - _getOrReturnCtx(input, ctx) { - return ctx || { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - }; - } - _processInputParams(input) { - return { - status: new parseUtil_js_1.ParseStatus(), - ctx: { - common: input.parent.common, - data: input.data, - parsedType: (0, util_js_1.getParsedType)(input.data), - schemaErrorMap: this._def.errorMap, - path: input.path, - parent: input.parent - } - }; - } - _parseSync(input) { - const result = this._parse(input); - if ((0, parseUtil_js_1.isAsync)(result)) { - throw new Error("Synchronous parse encountered promise."); - } - return result; - } - _parseAsync(input) { - const result = this._parse(input); - return Promise.resolve(result); - } - parse(data, params) { - const result = this.safeParse(data, params); - if (result.success) - return result.data; - throw result.error; - } - safeParse(data, params) { - const ctx = { - common: { - issues: [], - async: params?.async ?? false, - contextualErrorMap: params?.errorMap - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const result = this._parseSync({ data, path: ctx.path, parent: ctx }); - return handleResult(ctx, result); - } - "~validate"(data) { - const ctx = { - common: { - issues: [], - async: !!this["~standard"].async - }, - path: [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - if (!this["~standard"].async) { - try { - const result = this._parseSync({ data, path: [], parent: ctx }); - return (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }; - } catch (err) { - if (err?.message?.toLowerCase()?.includes("encountered")) { - this["~standard"].async = true; - } - ctx.common = { - issues: [], - async: true - }; - } - } - return this._parseAsync({ data, path: [], parent: ctx }).then((result) => (0, parseUtil_js_1.isValid)(result) ? { - value: result.value - } : { - issues: ctx.common.issues - }); - } - async parseAsync(data, params) { - const result = await this.safeParseAsync(data, params); - if (result.success) - return result.data; - throw result.error; - } - async safeParseAsync(data, params) { - const ctx = { - common: { - issues: [], - contextualErrorMap: params?.errorMap, - async: true - }, - path: params?.path || [], - schemaErrorMap: this._def.errorMap, - parent: null, - data, - parsedType: (0, util_js_1.getParsedType)(data) - }; - const maybeAsyncResult = this._parse({ data, path: ctx.path, parent: ctx }); - const result = await ((0, parseUtil_js_1.isAsync)(maybeAsyncResult) ? maybeAsyncResult : Promise.resolve(maybeAsyncResult)); - return handleResult(ctx, result); - } - refine(check, message) { - const getIssueProperties = (val) => { - if (typeof message === "string" || typeof message === "undefined") { - return { message }; - } else if (typeof message === "function") { - return message(val); - } else { - return message; - } - }; - return this._refinement((val, ctx) => { - const result = check(val); - const setError = () => ctx.addIssue({ - code: ZodError_js_1.ZodIssueCode.custom, - ...getIssueProperties(val) - }); - if (typeof Promise !== "undefined" && result instanceof Promise) { - return result.then((data) => { - if (!data) { - setError(); - return false; - } else { - return true; - } - }); - } - if (!result) { - setError(); - return false; - } else { - return true; - } - }); - } - refinement(check, refinementData) { - return this._refinement((val, ctx) => { - if (!check(val)) { - ctx.addIssue(typeof refinementData === "function" ? refinementData(val, ctx) : refinementData); - return false; - } else { - return true; - } - }); - } - _refinement(refinement) { - return new ZodEffects({ - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "refinement", refinement } - }); - } - superRefine(refinement) { - return this._refinement(refinement); - } - constructor(def) { - this.spa = this.safeParseAsync; - this._def = def; - this.parse = this.parse.bind(this); - this.safeParse = this.safeParse.bind(this); - this.parseAsync = this.parseAsync.bind(this); - this.safeParseAsync = this.safeParseAsync.bind(this); - this.spa = this.spa.bind(this); - this.refine = this.refine.bind(this); - this.refinement = this.refinement.bind(this); - this.superRefine = this.superRefine.bind(this); - this.optional = this.optional.bind(this); - this.nullable = this.nullable.bind(this); - this.nullish = this.nullish.bind(this); - this.array = this.array.bind(this); - this.promise = this.promise.bind(this); - this.or = this.or.bind(this); - this.and = this.and.bind(this); - this.transform = this.transform.bind(this); - this.brand = this.brand.bind(this); - this.default = this.default.bind(this); - this.catch = this.catch.bind(this); - this.describe = this.describe.bind(this); - this.pipe = this.pipe.bind(this); - this.readonly = this.readonly.bind(this); - this.isNullable = this.isNullable.bind(this); - this.isOptional = this.isOptional.bind(this); - this["~standard"] = { - version: 1, - vendor: "zod", - validate: (data) => this["~validate"](data) - }; - } - optional() { - return ZodOptional.create(this, this._def); - } - nullable() { - return ZodNullable.create(this, this._def); - } - nullish() { - return this.nullable().optional(); - } - array() { - return ZodArray.create(this); - } - promise() { - return ZodPromise.create(this, this._def); - } - or(option) { - return ZodUnion.create([this, option], this._def); - } - and(incoming) { - return ZodIntersection.create(this, incoming, this._def); - } - transform(transform) { - return new ZodEffects({ - ...processCreateParams(this._def), - schema: this, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect: { type: "transform", transform } - }); - } - default(def) { - const defaultValueFunc = typeof def === "function" ? def : () => def; - return new ZodDefault({ - ...processCreateParams(this._def), - innerType: this, - defaultValue: defaultValueFunc, - typeName: ZodFirstPartyTypeKind.ZodDefault - }); - } - brand() { - return new ZodBranded({ - typeName: ZodFirstPartyTypeKind.ZodBranded, - type: this, - ...processCreateParams(this._def) - }); - } - catch(def) { - const catchValueFunc = typeof def === "function" ? def : () => def; - return new ZodCatch({ - ...processCreateParams(this._def), - innerType: this, - catchValue: catchValueFunc, - typeName: ZodFirstPartyTypeKind.ZodCatch - }); - } - describe(description) { - const This = this.constructor; - return new This({ - ...this._def, - description - }); - } - pipe(target) { - return ZodPipeline.create(this, target); - } - readonly() { - return ZodReadonly.create(this); - } - isOptional() { - return this.safeParse(void 0).success; - } - isNullable() { - return this.safeParse(null).success; - } - }; - exports.ZodType = ZodType; - exports.Schema = ZodType; - exports.ZodSchema = ZodType; - var cuidRegex = /^c[^\s-]{8,}$/i; - var cuid2Regex = /^[0-9a-z]+$/; - var ulidRegex = /^[0-9A-HJKMNP-TV-Z]{26}$/i; - var uuidRegex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i; - var nanoidRegex = /^[a-z0-9_-]{21}$/i; - var jwtRegex = /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/; - var durationRegex = /^[-+]?P(?!$)(?:(?:[-+]?\d+Y)|(?:[-+]?\d+[.,]\d+Y$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:(?:[-+]?\d+W)|(?:[-+]?\d+[.,]\d+W$))?(?:(?:[-+]?\d+D)|(?:[-+]?\d+[.,]\d+D$))?(?:T(?=[\d+-])(?:(?:[-+]?\d+H)|(?:[-+]?\d+[.,]\d+H$))?(?:(?:[-+]?\d+M)|(?:[-+]?\d+[.,]\d+M$))?(?:[-+]?\d+(?:[.,]\d+)?S)?)??$/; - var emailRegex = /^(?!\.)(?!.*\.\.)([A-Z0-9_'+\-\.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9\-]*\.)+[A-Z]{2,}$/i; - var _emojiRegex = `^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$`; - var emojiRegex; - var ipv4Regex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/; - var ipv4CidrRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/; - var ipv6Regex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/; - var ipv6CidrRegex = /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/; - var base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/; - var base64urlRegex = /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/; - var dateRegexSource = `((\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\\d|3[01])|(0[469]|11)-(0[1-9]|[12]\\d|30)|(02)-(0[1-9]|1\\d|2[0-8])))`; - var dateRegex = new RegExp(`^${dateRegexSource}$`); - function timeRegexSource(args) { - let secondsRegexSource = `[0-5]\\d`; - if (args.precision) { - secondsRegexSource = `${secondsRegexSource}\\.\\d{${args.precision}}`; - } else if (args.precision == null) { - secondsRegexSource = `${secondsRegexSource}(\\.\\d+)?`; - } - const secondsQuantifier = args.precision ? "+" : "?"; - return `([01]\\d|2[0-3]):[0-5]\\d(:${secondsRegexSource})${secondsQuantifier}`; - } - function timeRegex(args) { - return new RegExp(`^${timeRegexSource(args)}$`); - } - function datetimeRegex(args) { - let regex = `${dateRegexSource}T${timeRegexSource(args)}`; - const opts = []; - opts.push(args.local ? `Z?` : `Z`); - if (args.offset) - opts.push(`([+-]\\d{2}:?\\d{2})`); - regex = `${regex}(${opts.join("|")})`; - return new RegExp(`^${regex}$`); - } - function isValidIP(ip, version) { - if ((version === "v4" || !version) && ipv4Regex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6Regex.test(ip)) { - return true; - } - return false; - } - function isValidJWT(jwt, alg) { - if (!jwtRegex.test(jwt)) - return false; - try { - const [header] = jwt.split("."); - if (!header) - return false; - const base64 = header.replace(/-/g, "+").replace(/_/g, "/").padEnd(header.length + (4 - header.length % 4) % 4, "="); - const decoded = JSON.parse(atob(base64)); - if (typeof decoded !== "object" || decoded === null) - return false; - if ("typ" in decoded && decoded?.typ !== "JWT") - return false; - if (!decoded.alg) - return false; - if (alg && decoded.alg !== alg) - return false; - return true; - } catch { - return false; - } - } - function isValidCidr(ip, version) { - if ((version === "v4" || !version) && ipv4CidrRegex.test(ip)) { - return true; - } - if ((version === "v6" || !version) && ipv6CidrRegex.test(ip)) { - return true; - } - return false; - } - var ZodString = class _ZodString extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = String(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.string) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.string, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.length < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.length > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "length") { - const tooBig = input.data.length > check.value; - const tooSmall = input.data.length < check.value; - if (tooBig || tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - if (tooBig) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } else if (tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "string", - inclusive: true, - exact: true, - message: check.message - }); - } - status.dirty(); - } - } else if (check.kind === "email") { - if (!emailRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "email", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "emoji") { - if (!emojiRegex) { - emojiRegex = new RegExp(_emojiRegex, "u"); - } - if (!emojiRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "emoji", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "uuid") { - if (!uuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "uuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "nanoid") { - if (!nanoidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "nanoid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid") { - if (!cuidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cuid2") { - if (!cuid2Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cuid2", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ulid") { - if (!ulidRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ulid", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "url") { - try { - new URL(input.data); - } catch { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "regex") { - check.regex.lastIndex = 0; - const testResult = check.regex.test(input.data); - if (!testResult) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "regex", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "trim") { - input.data = input.data.trim(); - } else if (check.kind === "includes") { - if (!input.data.includes(check.value, check.position)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { includes: check.value, position: check.position }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "toLowerCase") { - input.data = input.data.toLowerCase(); - } else if (check.kind === "toUpperCase") { - input.data = input.data.toUpperCase(); - } else if (check.kind === "startsWith") { - if (!input.data.startsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { startsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "endsWith") { - if (!input.data.endsWith(check.value)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: { endsWith: check.value }, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "datetime") { - const regex = datetimeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "datetime", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "date") { - const regex = dateRegex; - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "date", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "time") { - const regex = timeRegex(check); - if (!regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_string, - validation: "time", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "duration") { - if (!durationRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "duration", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "ip") { - if (!isValidIP(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "ip", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "jwt") { - if (!isValidJWT(input.data, check.alg)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "jwt", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "cidr") { - if (!isValidCidr(input.data, check.version)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "cidr", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64") { - if (!base64Regex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "base64url") { - if (!base64urlRegex.test(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - validation: "base64url", - code: ZodError_js_1.ZodIssueCode.invalid_string, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _regex(regex, validation, message) { - return this.refinement((data) => regex.test(data), { - validation, - code: ZodError_js_1.ZodIssueCode.invalid_string, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - _addCheck(check) { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - email(message) { - return this._addCheck({ kind: "email", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - url(message) { - return this._addCheck({ kind: "url", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - emoji(message) { - return this._addCheck({ kind: "emoji", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - uuid(message) { - return this._addCheck({ kind: "uuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - nanoid(message) { - return this._addCheck({ kind: "nanoid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid(message) { - return this._addCheck({ kind: "cuid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - cuid2(message) { - return this._addCheck({ kind: "cuid2", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - ulid(message) { - return this._addCheck({ kind: "ulid", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64(message) { - return this._addCheck({ kind: "base64", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - base64url(message) { - return this._addCheck({ - kind: "base64url", - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - jwt(options) { - return this._addCheck({ kind: "jwt", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - ip(options) { - return this._addCheck({ kind: "ip", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - cidr(options) { - return this._addCheck({ kind: "cidr", ...errorUtil_js_1.errorUtil.errToObj(options) }); - } - datetime(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "datetime", - precision: null, - offset: false, - local: false, - message: options - }); - } - return this._addCheck({ - kind: "datetime", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - offset: options?.offset ?? false, - local: options?.local ?? false, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - date(message) { - return this._addCheck({ kind: "date", message }); - } - time(options) { - if (typeof options === "string") { - return this._addCheck({ - kind: "time", - precision: null, - message: options - }); - } - return this._addCheck({ - kind: "time", - precision: typeof options?.precision === "undefined" ? null : options?.precision, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - duration(message) { - return this._addCheck({ kind: "duration", ...errorUtil_js_1.errorUtil.errToObj(message) }); - } - regex(regex, message) { - return this._addCheck({ - kind: "regex", - regex, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - includes(value, options) { - return this._addCheck({ - kind: "includes", - value, - position: options?.position, - ...errorUtil_js_1.errorUtil.errToObj(options?.message) - }); - } - startsWith(value, message) { - return this._addCheck({ - kind: "startsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - endsWith(value, message) { - return this._addCheck({ - kind: "endsWith", - value, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - min(minLength, message) { - return this._addCheck({ - kind: "min", - value: minLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - max(maxLength, message) { - return this._addCheck({ - kind: "max", - value: maxLength, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - length(len, message) { - return this._addCheck({ - kind: "length", - value: len, - ...errorUtil_js_1.errorUtil.errToObj(message) - }); - } - /** - * Equivalent to `.min(1)` - */ - nonempty(message) { - return this.min(1, errorUtil_js_1.errorUtil.errToObj(message)); - } - trim() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "trim" }] - }); - } - toLowerCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toLowerCase" }] - }); - } - toUpperCase() { - return new _ZodString({ - ...this._def, - checks: [...this._def.checks, { kind: "toUpperCase" }] - }); - } - get isDatetime() { - return !!this._def.checks.find((ch) => ch.kind === "datetime"); - } - get isDate() { - return !!this._def.checks.find((ch) => ch.kind === "date"); - } - get isTime() { - return !!this._def.checks.find((ch) => ch.kind === "time"); - } - get isDuration() { - return !!this._def.checks.find((ch) => ch.kind === "duration"); - } - get isEmail() { - return !!this._def.checks.find((ch) => ch.kind === "email"); - } - get isURL() { - return !!this._def.checks.find((ch) => ch.kind === "url"); - } - get isEmoji() { - return !!this._def.checks.find((ch) => ch.kind === "emoji"); - } - get isUUID() { - return !!this._def.checks.find((ch) => ch.kind === "uuid"); - } - get isNANOID() { - return !!this._def.checks.find((ch) => ch.kind === "nanoid"); - } - get isCUID() { - return !!this._def.checks.find((ch) => ch.kind === "cuid"); - } - get isCUID2() { - return !!this._def.checks.find((ch) => ch.kind === "cuid2"); - } - get isULID() { - return !!this._def.checks.find((ch) => ch.kind === "ulid"); - } - get isIP() { - return !!this._def.checks.find((ch) => ch.kind === "ip"); - } - get isCIDR() { - return !!this._def.checks.find((ch) => ch.kind === "cidr"); - } - get isBase64() { - return !!this._def.checks.find((ch) => ch.kind === "base64"); - } - get isBase64url() { - return !!this._def.checks.find((ch) => ch.kind === "base64url"); - } - get minLength() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxLength() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodString = ZodString; - ZodString.create = (params) => { - return new ZodString({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodString, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - function floatSafeRemainder(val, step) { - const valDecCount = (val.toString().split(".")[1] || "").length; - const stepDecCount = (step.toString().split(".")[1] || "").length; - const decCount = valDecCount > stepDecCount ? valDecCount : stepDecCount; - const valInt = Number.parseInt(val.toFixed(decCount).replace(".", "")); - const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", "")); - return valInt % stepInt / 10 ** decCount; - } - var ZodNumber = class _ZodNumber extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - this.step = this.multipleOf; - } - _parse(input) { - if (this._def.coerce) { - input.data = Number(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.number) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.number, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "int") { - if (!util_js_1.util.isInteger(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: "integer", - received: "float", - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: check.value, - type: "number", - inclusive: check.inclusive, - exact: false, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (floatSafeRemainder(input.data, check.value) !== 0) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "finite") { - if (!Number.isFinite(input.data)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_finite, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodNumber({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodNumber({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - int(message) { - return this._addCheck({ - kind: "int", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: 0, - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - finite(message) { - return this._addCheck({ - kind: "finite", - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - safe(message) { - return this._addCheck({ - kind: "min", - inclusive: true, - value: Number.MIN_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - })._addCheck({ - kind: "max", - inclusive: true, - value: Number.MAX_SAFE_INTEGER, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - get isInt() { - return !!this._def.checks.find((ch) => ch.kind === "int" || ch.kind === "multipleOf" && util_js_1.util.isInteger(ch.value)); - } - get isFinite() { - let max = null; - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "finite" || ch.kind === "int" || ch.kind === "multipleOf") { - return true; - } else if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } else if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return Number.isFinite(min) && Number.isFinite(max); - } - }; - exports.ZodNumber = ZodNumber; - ZodNumber.create = (params) => { - return new ZodNumber({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodNumber, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodBigInt = class _ZodBigInt extends ZodType { - constructor() { - super(...arguments); - this.min = this.gte; - this.max = this.lte; - } - _parse(input) { - if (this._def.coerce) { - try { - input.data = BigInt(input.data); - } catch { - return this._getInvalidInput(input); - } - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.bigint) { - return this._getInvalidInput(input); - } - let ctx = void 0; - const status = new parseUtil_js_1.ParseStatus(); - for (const check of this._def.checks) { - if (check.kind === "min") { - const tooSmall = check.inclusive ? input.data < check.value : input.data <= check.value; - if (tooSmall) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - type: "bigint", - minimum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "max") { - const tooBig = check.inclusive ? input.data > check.value : input.data >= check.value; - if (tooBig) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - type: "bigint", - maximum: check.value, - inclusive: check.inclusive, - message: check.message - }); - status.dirty(); - } - } else if (check.kind === "multipleOf") { - if (input.data % check.value !== BigInt(0)) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.not_multiple_of, - multipleOf: check.value, - message: check.message - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { status: status.value, value: input.data }; - } - _getInvalidInput(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.bigint, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - gte(value, message) { - return this.setLimit("min", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - gt(value, message) { - return this.setLimit("min", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - lte(value, message) { - return this.setLimit("max", value, true, errorUtil_js_1.errorUtil.toString(message)); - } - lt(value, message) { - return this.setLimit("max", value, false, errorUtil_js_1.errorUtil.toString(message)); - } - setLimit(kind, value, inclusive, message) { - return new _ZodBigInt({ - ...this._def, - checks: [ - ...this._def.checks, - { - kind, - value, - inclusive, - message: errorUtil_js_1.errorUtil.toString(message) - } - ] - }); - } - _addCheck(check) { - return new _ZodBigInt({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - positive(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - negative(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: false, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonpositive(message) { - return this._addCheck({ - kind: "max", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - nonnegative(message) { - return this._addCheck({ - kind: "min", - value: BigInt(0), - inclusive: true, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - multipleOf(value, message) { - return this._addCheck({ - kind: "multipleOf", - value, - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minValue() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min; - } - get maxValue() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max; - } - }; - exports.ZodBigInt = ZodBigInt; - ZodBigInt.create = (params) => { - return new ZodBigInt({ - checks: [], - typeName: ZodFirstPartyTypeKind.ZodBigInt, - coerce: params?.coerce ?? false, - ...processCreateParams(params) - }); - }; - var ZodBoolean = class extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = Boolean(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.boolean) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.boolean, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodBoolean = ZodBoolean; - ZodBoolean.create = (params) => { - return new ZodBoolean({ - typeName: ZodFirstPartyTypeKind.ZodBoolean, - coerce: params?.coerce || false, - ...processCreateParams(params) - }); - }; - var ZodDate = class _ZodDate extends ZodType { - _parse(input) { - if (this._def.coerce) { - input.data = new Date(input.data); - } - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.date) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.date, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (Number.isNaN(input.data.getTime())) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_date - }); - return parseUtil_js_1.INVALID; - } - const status = new parseUtil_js_1.ParseStatus(); - let ctx = void 0; - for (const check of this._def.checks) { - if (check.kind === "min") { - if (input.data.getTime() < check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - message: check.message, - inclusive: true, - exact: false, - minimum: check.value, - type: "date" - }); - status.dirty(); - } - } else if (check.kind === "max") { - if (input.data.getTime() > check.value) { - ctx = this._getOrReturnCtx(input, ctx); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - message: check.message, - inclusive: true, - exact: false, - maximum: check.value, - type: "date" - }); - status.dirty(); - } - } else { - util_js_1.util.assertNever(check); - } - } - return { - status: status.value, - value: new Date(input.data.getTime()) - }; - } - _addCheck(check) { - return new _ZodDate({ - ...this._def, - checks: [...this._def.checks, check] - }); - } - min(minDate, message) { - return this._addCheck({ - kind: "min", - value: minDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - max(maxDate, message) { - return this._addCheck({ - kind: "max", - value: maxDate.getTime(), - message: errorUtil_js_1.errorUtil.toString(message) - }); - } - get minDate() { - let min = null; - for (const ch of this._def.checks) { - if (ch.kind === "min") { - if (min === null || ch.value > min) - min = ch.value; - } - } - return min != null ? new Date(min) : null; - } - get maxDate() { - let max = null; - for (const ch of this._def.checks) { - if (ch.kind === "max") { - if (max === null || ch.value < max) - max = ch.value; - } - } - return max != null ? new Date(max) : null; - } - }; - exports.ZodDate = ZodDate; - ZodDate.create = (params) => { - return new ZodDate({ - checks: [], - coerce: params?.coerce || false, - typeName: ZodFirstPartyTypeKind.ZodDate, - ...processCreateParams(params) - }); - }; - var ZodSymbol = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.symbol) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.symbol, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodSymbol = ZodSymbol; - ZodSymbol.create = (params) => { - return new ZodSymbol({ - typeName: ZodFirstPartyTypeKind.ZodSymbol, - ...processCreateParams(params) - }); - }; - var ZodUndefined = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.undefined, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUndefined = ZodUndefined; - ZodUndefined.create = (params) => { - return new ZodUndefined({ - typeName: ZodFirstPartyTypeKind.ZodUndefined, - ...processCreateParams(params) - }); - }; - var ZodNull = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.null) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.null, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodNull = ZodNull; - ZodNull.create = (params) => { - return new ZodNull({ - typeName: ZodFirstPartyTypeKind.ZodNull, - ...processCreateParams(params) - }); - }; - var ZodAny = class extends ZodType { - constructor() { - super(...arguments); - this._any = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodAny = ZodAny; - ZodAny.create = (params) => { - return new ZodAny({ - typeName: ZodFirstPartyTypeKind.ZodAny, - ...processCreateParams(params) - }); - }; - var ZodUnknown = class extends ZodType { - constructor() { - super(...arguments); - this._unknown = true; - } - _parse(input) { - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodUnknown = ZodUnknown; - ZodUnknown.create = (params) => { - return new ZodUnknown({ - typeName: ZodFirstPartyTypeKind.ZodUnknown, - ...processCreateParams(params) - }); - }; - var ZodNever = class extends ZodType { - _parse(input) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.never, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - }; - exports.ZodNever = ZodNever; - ZodNever.create = (params) => { - return new ZodNever({ - typeName: ZodFirstPartyTypeKind.ZodNever, - ...processCreateParams(params) - }); - }; - var ZodVoid = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.undefined) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.void, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - }; - exports.ZodVoid = ZodVoid; - ZodVoid.create = (params) => { - return new ZodVoid({ - typeName: ZodFirstPartyTypeKind.ZodVoid, - ...processCreateParams(params) - }); - }; - var ZodArray = class _ZodArray extends ZodType { - _parse(input) { - const { ctx, status } = this._processInputParams(input); - const def = this._def; - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (def.exactLength !== null) { - const tooBig = ctx.data.length > def.exactLength.value; - const tooSmall = ctx.data.length < def.exactLength.value; - if (tooBig || tooSmall) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: tooBig ? ZodError_js_1.ZodIssueCode.too_big : ZodError_js_1.ZodIssueCode.too_small, - minimum: tooSmall ? def.exactLength.value : void 0, - maximum: tooBig ? def.exactLength.value : void 0, - type: "array", - inclusive: true, - exact: true, - message: def.exactLength.message - }); - status.dirty(); - } - } - if (def.minLength !== null) { - if (ctx.data.length < def.minLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.minLength.message - }); - status.dirty(); - } - } - if (def.maxLength !== null) { - if (ctx.data.length > def.maxLength.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxLength.value, - type: "array", - inclusive: true, - exact: false, - message: def.maxLength.message - }); - status.dirty(); - } - } - if (ctx.common.async) { - return Promise.all([...ctx.data].map((item, i) => { - return def.type._parseAsync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - })).then((result2) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, result2); - }); - } - const result = [...ctx.data].map((item, i) => { - return def.type._parseSync(new ParseInputLazyPath(ctx, item, ctx.path, i)); - }); - return parseUtil_js_1.ParseStatus.mergeArray(status, result); - } - get element() { - return this._def.type; - } - min(minLength, message) { - return new _ZodArray({ - ...this._def, - minLength: { value: minLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxLength, message) { - return new _ZodArray({ - ...this._def, - maxLength: { value: maxLength, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - length(len, message) { - return new _ZodArray({ - ...this._def, - exactLength: { value: len, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodArray = ZodArray; - ZodArray.create = (schema, params) => { - return new ZodArray({ - type: schema, - minLength: null, - maxLength: null, - exactLength: null, - typeName: ZodFirstPartyTypeKind.ZodArray, - ...processCreateParams(params) - }); - }; - function deepPartialify(schema) { - if (schema instanceof ZodObject) { - const newShape = {}; - for (const key in schema.shape) { - const fieldSchema = schema.shape[key]; - newShape[key] = ZodOptional.create(deepPartialify(fieldSchema)); - } - return new ZodObject({ - ...schema._def, - shape: () => newShape - }); - } else if (schema instanceof ZodArray) { - return new ZodArray({ - ...schema._def, - type: deepPartialify(schema.element) - }); - } else if (schema instanceof ZodOptional) { - return ZodOptional.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodNullable) { - return ZodNullable.create(deepPartialify(schema.unwrap())); - } else if (schema instanceof ZodTuple) { - return ZodTuple.create(schema.items.map((item) => deepPartialify(item))); - } else { - return schema; - } - } - var ZodObject = class _ZodObject extends ZodType { - constructor() { - super(...arguments); - this._cached = null; - this.nonstrict = this.passthrough; - this.augment = this.extend; - } - _getCached() { - if (this._cached !== null) - return this._cached; - const shape = this._def.shape(); - const keys = util_js_1.util.objectKeys(shape); - this._cached = { shape, keys }; - return this._cached; - } - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.object) { - const ctx2 = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx2, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx2.parsedType - }); - return parseUtil_js_1.INVALID; - } - const { status, ctx } = this._processInputParams(input); - const { shape, keys: shapeKeys } = this._getCached(); - const extraKeys = []; - if (!(this._def.catchall instanceof ZodNever && this._def.unknownKeys === "strip")) { - for (const key in ctx.data) { - if (!shapeKeys.includes(key)) { - extraKeys.push(key); - } - } - } - const pairs = []; - for (const key of shapeKeys) { - const keyValidator = shape[key]; - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: keyValidator._parse(new ParseInputLazyPath(ctx, value, ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (this._def.catchall instanceof ZodNever) { - const unknownKeys = this._def.unknownKeys; - if (unknownKeys === "passthrough") { - for (const key of extraKeys) { - pairs.push({ - key: { status: "valid", value: key }, - value: { status: "valid", value: ctx.data[key] } - }); - } - } else if (unknownKeys === "strict") { - if (extraKeys.length > 0) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.unrecognized_keys, - keys: extraKeys - }); - status.dirty(); - } - } else if (unknownKeys === "strip") { - } else { - throw new Error(`Internal ZodObject error: invalid unknownKeys value.`); - } - } else { - const catchall = this._def.catchall; - for (const key of extraKeys) { - const value = ctx.data[key]; - pairs.push({ - key: { status: "valid", value: key }, - value: catchall._parse( - new ParseInputLazyPath(ctx, value, ctx.path, key) - //, ctx.child(key), value, getParsedType(value) - ), - alwaysSet: key in ctx.data - }); - } - } - if (ctx.common.async) { - return Promise.resolve().then(async () => { - const syncPairs = []; - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - syncPairs.push({ - key, - value, - alwaysSet: pair.alwaysSet - }); - } - return syncPairs; - }).then((syncPairs) => { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, syncPairs); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get shape() { - return this._def.shape(); - } - strict(message) { - errorUtil_js_1.errorUtil.errToObj; - return new _ZodObject({ - ...this._def, - unknownKeys: "strict", - ...message !== void 0 ? { - errorMap: (issue, ctx) => { - const defaultError = this._def.errorMap?.(issue, ctx).message ?? ctx.defaultError; - if (issue.code === "unrecognized_keys") - return { - message: errorUtil_js_1.errorUtil.errToObj(message).message ?? defaultError - }; - return { - message: defaultError - }; - } - } : {} - }); - } - strip() { - return new _ZodObject({ - ...this._def, - unknownKeys: "strip" - }); - } - passthrough() { - return new _ZodObject({ - ...this._def, - unknownKeys: "passthrough" - }); - } - // const AugmentFactory = - // (def: Def) => - // ( - // augmentation: Augmentation - // ): ZodObject< - // extendShape, Augmentation>, - // Def["unknownKeys"], - // Def["catchall"] - // > => { - // return new ZodObject({ - // ...def, - // shape: () => ({ - // ...def.shape(), - // ...augmentation, - // }), - // }) as any; - // }; - extend(augmentation) { - return new _ZodObject({ - ...this._def, - shape: () => ({ - ...this._def.shape(), - ...augmentation - }) - }); - } - /** - * Prior to zod@1.0.12 there was a bug in the - * inferred type of merged objects. Please - * upgrade if you are experiencing issues. - */ - merge(merging) { - const merged = new _ZodObject({ - unknownKeys: merging._def.unknownKeys, - catchall: merging._def.catchall, - shape: () => ({ - ...this._def.shape(), - ...merging._def.shape() - }), - typeName: ZodFirstPartyTypeKind.ZodObject - }); - return merged; - } - // merge< - // Incoming extends AnyZodObject, - // Augmentation extends Incoming["shape"], - // NewOutput extends { - // [k in keyof Augmentation | keyof Output]: k extends keyof Augmentation - // ? Augmentation[k]["_output"] - // : k extends keyof Output - // ? Output[k] - // : never; - // }, - // NewInput extends { - // [k in keyof Augmentation | keyof Input]: k extends keyof Augmentation - // ? Augmentation[k]["_input"] - // : k extends keyof Input - // ? Input[k] - // : never; - // } - // >( - // merging: Incoming - // ): ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"], - // NewOutput, - // NewInput - // > { - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - setKey(key, schema) { - return this.augment({ [key]: schema }); - } - // merge( - // merging: Incoming - // ): //ZodObject = (merging) => { - // ZodObject< - // extendShape>, - // Incoming["_def"]["unknownKeys"], - // Incoming["_def"]["catchall"] - // > { - // // const mergedShape = objectUtil.mergeShapes( - // // this._def.shape(), - // // merging._def.shape() - // // ); - // const merged: any = new ZodObject({ - // unknownKeys: merging._def.unknownKeys, - // catchall: merging._def.catchall, - // shape: () => - // objectUtil.mergeShapes(this._def.shape(), merging._def.shape()), - // typeName: ZodFirstPartyTypeKind.ZodObject, - // }) as any; - // return merged; - // } - catchall(index) { - return new _ZodObject({ - ...this._def, - catchall: index - }); - } - pick(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(mask)) { - if (mask[key] && this.shape[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - omit(mask) { - const shape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (!mask[key]) { - shape[key] = this.shape[key]; - } - } - return new _ZodObject({ - ...this._def, - shape: () => shape - }); - } - /** - * @deprecated - */ - deepPartial() { - return deepPartialify(this); - } - partial(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - const fieldSchema = this.shape[key]; - if (mask && !mask[key]) { - newShape[key] = fieldSchema; - } else { - newShape[key] = fieldSchema.optional(); - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - required(mask) { - const newShape = {}; - for (const key of util_js_1.util.objectKeys(this.shape)) { - if (mask && !mask[key]) { - newShape[key] = this.shape[key]; - } else { - const fieldSchema = this.shape[key]; - let newField = fieldSchema; - while (newField instanceof ZodOptional) { - newField = newField._def.innerType; - } - newShape[key] = newField; - } - } - return new _ZodObject({ - ...this._def, - shape: () => newShape - }); - } - keyof() { - return createZodEnum(util_js_1.util.objectKeys(this.shape)); - } - }; - exports.ZodObject = ZodObject; - ZodObject.create = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.strictCreate = (shape, params) => { - return new ZodObject({ - shape: () => shape, - unknownKeys: "strict", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - ZodObject.lazycreate = (shape, params) => { - return new ZodObject({ - shape, - unknownKeys: "strip", - catchall: ZodNever.create(), - typeName: ZodFirstPartyTypeKind.ZodObject, - ...processCreateParams(params) - }); - }; - var ZodUnion = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const options = this._def.options; - function handleResults(results) { - for (const result of results) { - if (result.result.status === "valid") { - return result.result; - } - } - for (const result of results) { - if (result.result.status === "dirty") { - ctx.common.issues.push(...result.ctx.common.issues); - return result.result; - } - } - const unionErrors = results.map((result) => new ZodError_js_1.ZodError(result.ctx.common.issues)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return Promise.all(options.map(async (option) => { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - return { - result: await option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }), - ctx: childCtx - }; - })).then(handleResults); - } else { - let dirty = void 0; - const issues = []; - for (const option of options) { - const childCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - }, - parent: null - }; - const result = option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: childCtx - }); - if (result.status === "valid") { - return result; - } else if (result.status === "dirty" && !dirty) { - dirty = { result, ctx: childCtx }; - } - if (childCtx.common.issues.length) { - issues.push(childCtx.common.issues); - } - } - if (dirty) { - ctx.common.issues.push(...dirty.ctx.common.issues); - return dirty.result; - } - const unionErrors = issues.map((issues2) => new ZodError_js_1.ZodError(issues2)); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union, - unionErrors - }); - return parseUtil_js_1.INVALID; - } - } - get options() { - return this._def.options; - } - }; - exports.ZodUnion = ZodUnion; - ZodUnion.create = (types, params) => { - return new ZodUnion({ - options: types, - typeName: ZodFirstPartyTypeKind.ZodUnion, - ...processCreateParams(params) - }); - }; - var getDiscriminator = (type) => { - if (type instanceof ZodLazy) { - return getDiscriminator(type.schema); - } else if (type instanceof ZodEffects) { - return getDiscriminator(type.innerType()); - } else if (type instanceof ZodLiteral) { - return [type.value]; - } else if (type instanceof ZodEnum) { - return type.options; - } else if (type instanceof ZodNativeEnum) { - return util_js_1.util.objectValues(type.enum); - } else if (type instanceof ZodDefault) { - return getDiscriminator(type._def.innerType); - } else if (type instanceof ZodUndefined) { - return [void 0]; - } else if (type instanceof ZodNull) { - return [null]; - } else if (type instanceof ZodOptional) { - return [void 0, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodNullable) { - return [null, ...getDiscriminator(type.unwrap())]; - } else if (type instanceof ZodBranded) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodReadonly) { - return getDiscriminator(type.unwrap()); - } else if (type instanceof ZodCatch) { - return getDiscriminator(type._def.innerType); - } else { - return []; - } - }; - var ZodDiscriminatedUnion = class _ZodDiscriminatedUnion extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const discriminator = this.discriminator; - const discriminatorValue = ctx.data[discriminator]; - const option = this.optionsMap.get(discriminatorValue); - if (!option) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_union_discriminator, - options: Array.from(this.optionsMap.keys()), - path: [discriminator] - }); - return parseUtil_js_1.INVALID; - } - if (ctx.common.async) { - return option._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } else { - return option._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - } - } - get discriminator() { - return this._def.discriminator; - } - get options() { - return this._def.options; - } - get optionsMap() { - return this._def.optionsMap; - } - /** - * The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. - * However, it only allows a union of objects, all of which need to share a discriminator property. This property must - * have a different value for each object in the union. - * @param discriminator the name of the discriminator property - * @param types an array of object schemas - * @param params - */ - static create(discriminator, options, params) { - const optionsMap = /* @__PURE__ */ new Map(); - for (const type of options) { - const discriminatorValues = getDiscriminator(type.shape[discriminator]); - if (!discriminatorValues.length) { - throw new Error(`A discriminator value for key \`${discriminator}\` could not be extracted from all schema options`); - } - for (const value of discriminatorValues) { - if (optionsMap.has(value)) { - throw new Error(`Discriminator property ${String(discriminator)} has duplicate value ${String(value)}`); - } - optionsMap.set(value, type); - } - } - return new _ZodDiscriminatedUnion({ - typeName: ZodFirstPartyTypeKind.ZodDiscriminatedUnion, - discriminator, - options, - optionsMap, - ...processCreateParams(params) - }); - } - }; - exports.ZodDiscriminatedUnion = ZodDiscriminatedUnion; - function mergeValues(a, b) { - const aType = (0, util_js_1.getParsedType)(a); - const bType = (0, util_js_1.getParsedType)(b); - if (a === b) { - return { valid: true, data: a }; - } else if (aType === util_js_1.ZodParsedType.object && bType === util_js_1.ZodParsedType.object) { - const bKeys = util_js_1.util.objectKeys(b); - const sharedKeys = util_js_1.util.objectKeys(a).filter((key) => bKeys.indexOf(key) !== -1); - const newObj = { ...a, ...b }; - for (const key of sharedKeys) { - const sharedValue = mergeValues(a[key], b[key]); - if (!sharedValue.valid) { - return { valid: false }; - } - newObj[key] = sharedValue.data; - } - return { valid: true, data: newObj }; - } else if (aType === util_js_1.ZodParsedType.array && bType === util_js_1.ZodParsedType.array) { - if (a.length !== b.length) { - return { valid: false }; - } - const newArray = []; - for (let index = 0; index < a.length; index++) { - const itemA = a[index]; - const itemB = b[index]; - const sharedValue = mergeValues(itemA, itemB); - if (!sharedValue.valid) { - return { valid: false }; - } - newArray.push(sharedValue.data); - } - return { valid: true, data: newArray }; - } else if (aType === util_js_1.ZodParsedType.date && bType === util_js_1.ZodParsedType.date && +a === +b) { - return { valid: true, data: a }; - } else { - return { valid: false }; - } - } - var ZodIntersection = class extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const handleParsed = (parsedLeft, parsedRight) => { - if ((0, parseUtil_js_1.isAborted)(parsedLeft) || (0, parseUtil_js_1.isAborted)(parsedRight)) { - return parseUtil_js_1.INVALID; - } - const merged = mergeValues(parsedLeft.value, parsedRight.value); - if (!merged.valid) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_intersection_types - }); - return parseUtil_js_1.INVALID; - } - if ((0, parseUtil_js_1.isDirty)(parsedLeft) || (0, parseUtil_js_1.isDirty)(parsedRight)) { - status.dirty(); - } - return { status: status.value, value: merged.data }; - }; - if (ctx.common.async) { - return Promise.all([ - this._def.left._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), - this._def.right._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }) - ]).then(([left, right]) => handleParsed(left, right)); - } else { - return handleParsed(this._def.left._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }), this._def.right._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - })); - } - } - }; - exports.ZodIntersection = ZodIntersection; - ZodIntersection.create = (left, right, params) => { - return new ZodIntersection({ - left, - right, - typeName: ZodFirstPartyTypeKind.ZodIntersection, - ...processCreateParams(params) - }); - }; - var ZodTuple = class _ZodTuple extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.array) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.array, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - if (ctx.data.length < this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - return parseUtil_js_1.INVALID; - } - const rest = this._def.rest; - if (!rest && ctx.data.length > this._def.items.length) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: this._def.items.length, - inclusive: true, - exact: false, - type: "array" - }); - status.dirty(); - } - const items = [...ctx.data].map((item, itemIndex) => { - const schema = this._def.items[itemIndex] || this._def.rest; - if (!schema) - return null; - return schema._parse(new ParseInputLazyPath(ctx, item, ctx.path, itemIndex)); - }).filter((x) => !!x); - if (ctx.common.async) { - return Promise.all(items).then((results) => { - return parseUtil_js_1.ParseStatus.mergeArray(status, results); - }); - } else { - return parseUtil_js_1.ParseStatus.mergeArray(status, items); - } - } - get items() { - return this._def.items; - } - rest(rest) { - return new _ZodTuple({ - ...this._def, - rest - }); - } - }; - exports.ZodTuple = ZodTuple; - ZodTuple.create = (schemas, params) => { - if (!Array.isArray(schemas)) { - throw new Error("You must pass an array of schemas to z.tuple([ ... ])"); - } - return new ZodTuple({ - items: schemas, - typeName: ZodFirstPartyTypeKind.ZodTuple, - rest: null, - ...processCreateParams(params) - }); - }; - var ZodRecord = class _ZodRecord extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.object) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.object, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const pairs = []; - const keyType = this._def.keyType; - const valueType = this._def.valueType; - for (const key in ctx.data) { - pairs.push({ - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, key)), - value: valueType._parse(new ParseInputLazyPath(ctx, ctx.data[key], ctx.path, key)), - alwaysSet: key in ctx.data - }); - } - if (ctx.common.async) { - return parseUtil_js_1.ParseStatus.mergeObjectAsync(status, pairs); - } else { - return parseUtil_js_1.ParseStatus.mergeObjectSync(status, pairs); - } - } - get element() { - return this._def.valueType; - } - static create(first, second, third) { - if (second instanceof ZodType) { - return new _ZodRecord({ - keyType: first, - valueType: second, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(third) - }); - } - return new _ZodRecord({ - keyType: ZodString.create(), - valueType: first, - typeName: ZodFirstPartyTypeKind.ZodRecord, - ...processCreateParams(second) - }); - } - }; - exports.ZodRecord = ZodRecord; - var ZodMap = class extends ZodType { - get keySchema() { - return this._def.keyType; - } - get valueSchema() { - return this._def.valueType; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.map) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.map, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const keyType = this._def.keyType; - const valueType = this._def.valueType; - const pairs = [...ctx.data.entries()].map(([key, value], index) => { - return { - key: keyType._parse(new ParseInputLazyPath(ctx, key, ctx.path, [index, "key"])), - value: valueType._parse(new ParseInputLazyPath(ctx, value, ctx.path, [index, "value"])) - }; - }); - if (ctx.common.async) { - const finalMap = /* @__PURE__ */ new Map(); - return Promise.resolve().then(async () => { - for (const pair of pairs) { - const key = await pair.key; - const value = await pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - }); - } else { - const finalMap = /* @__PURE__ */ new Map(); - for (const pair of pairs) { - const key = pair.key; - const value = pair.value; - if (key.status === "aborted" || value.status === "aborted") { - return parseUtil_js_1.INVALID; - } - if (key.status === "dirty" || value.status === "dirty") { - status.dirty(); - } - finalMap.set(key.value, value.value); - } - return { status: status.value, value: finalMap }; - } - } - }; - exports.ZodMap = ZodMap; - ZodMap.create = (keyType, valueType, params) => { - return new ZodMap({ - valueType, - keyType, - typeName: ZodFirstPartyTypeKind.ZodMap, - ...processCreateParams(params) - }); - }; - var ZodSet = class _ZodSet extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.set) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.set, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const def = this._def; - if (def.minSize !== null) { - if (ctx.data.size < def.minSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_small, - minimum: def.minSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.minSize.message - }); - status.dirty(); - } - } - if (def.maxSize !== null) { - if (ctx.data.size > def.maxSize.value) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.too_big, - maximum: def.maxSize.value, - type: "set", - inclusive: true, - exact: false, - message: def.maxSize.message - }); - status.dirty(); - } - } - const valueType = this._def.valueType; - function finalizeSet(elements2) { - const parsedSet = /* @__PURE__ */ new Set(); - for (const element of elements2) { - if (element.status === "aborted") - return parseUtil_js_1.INVALID; - if (element.status === "dirty") - status.dirty(); - parsedSet.add(element.value); - } - return { status: status.value, value: parsedSet }; - } - const elements = [...ctx.data.values()].map((item, i) => valueType._parse(new ParseInputLazyPath(ctx, item, ctx.path, i))); - if (ctx.common.async) { - return Promise.all(elements).then((elements2) => finalizeSet(elements2)); - } else { - return finalizeSet(elements); - } - } - min(minSize, message) { - return new _ZodSet({ - ...this._def, - minSize: { value: minSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - max(maxSize, message) { - return new _ZodSet({ - ...this._def, - maxSize: { value: maxSize, message: errorUtil_js_1.errorUtil.toString(message) } - }); - } - size(size, message) { - return this.min(size, message).max(size, message); - } - nonempty(message) { - return this.min(1, message); - } - }; - exports.ZodSet = ZodSet; - ZodSet.create = (valueType, params) => { - return new ZodSet({ - valueType, - minSize: null, - maxSize: null, - typeName: ZodFirstPartyTypeKind.ZodSet, - ...processCreateParams(params) - }); - }; - var ZodFunction = class _ZodFunction extends ZodType { - constructor() { - super(...arguments); - this.validate = this.implement; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.function) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.function, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - function makeArgsIssue(args, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: args, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_arguments, - argumentsError: error - } - }); - } - function makeReturnsIssue(returns, error) { - return (0, parseUtil_js_1.makeIssue)({ - data: returns, - path: ctx.path, - errorMaps: [ctx.common.contextualErrorMap, ctx.schemaErrorMap, (0, errors_js_1.getErrorMap)(), errors_js_1.defaultErrorMap].filter((x) => !!x), - issueData: { - code: ZodError_js_1.ZodIssueCode.invalid_return_type, - returnTypeError: error - } - }); - } - const params = { errorMap: ctx.common.contextualErrorMap }; - const fn = ctx.data; - if (this._def.returns instanceof ZodPromise) { - const me = this; - return (0, parseUtil_js_1.OK)(async function(...args) { - const error = new ZodError_js_1.ZodError([]); - const parsedArgs = await me._def.args.parseAsync(args, params).catch((e) => { - error.addIssue(makeArgsIssue(args, e)); - throw error; - }); - const result = await Reflect.apply(fn, this, parsedArgs); - const parsedReturns = await me._def.returns._def.type.parseAsync(result, params).catch((e) => { - error.addIssue(makeReturnsIssue(result, e)); - throw error; - }); - return parsedReturns; - }); - } else { - const me = this; - return (0, parseUtil_js_1.OK)(function(...args) { - const parsedArgs = me._def.args.safeParse(args, params); - if (!parsedArgs.success) { - throw new ZodError_js_1.ZodError([makeArgsIssue(args, parsedArgs.error)]); - } - const result = Reflect.apply(fn, this, parsedArgs.data); - const parsedReturns = me._def.returns.safeParse(result, params); - if (!parsedReturns.success) { - throw new ZodError_js_1.ZodError([makeReturnsIssue(result, parsedReturns.error)]); - } - return parsedReturns.data; - }); - } - } - parameters() { - return this._def.args; - } - returnType() { - return this._def.returns; - } - args(...items) { - return new _ZodFunction({ - ...this._def, - args: ZodTuple.create(items).rest(ZodUnknown.create()) - }); - } - returns(returnType) { - return new _ZodFunction({ - ...this._def, - returns: returnType - }); - } - implement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - strictImplement(func) { - const validatedFunc = this.parse(func); - return validatedFunc; - } - static create(args, returns, params) { - return new _ZodFunction({ - args: args ? args : ZodTuple.create([]).rest(ZodUnknown.create()), - returns: returns || ZodUnknown.create(), - typeName: ZodFirstPartyTypeKind.ZodFunction, - ...processCreateParams(params) - }); - } - }; - exports.ZodFunction = ZodFunction; - var ZodLazy = class extends ZodType { - get schema() { - return this._def.getter(); - } - _parse(input) { - const { ctx } = this._processInputParams(input); - const lazySchema = this._def.getter(); - return lazySchema._parse({ data: ctx.data, path: ctx.path, parent: ctx }); - } - }; - exports.ZodLazy = ZodLazy; - ZodLazy.create = (getter, params) => { - return new ZodLazy({ - getter, - typeName: ZodFirstPartyTypeKind.ZodLazy, - ...processCreateParams(params) - }); - }; - var ZodLiteral = class extends ZodType { - _parse(input) { - if (input.data !== this._def.value) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_literal, - expected: this._def.value - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - get value() { - return this._def.value; - } - }; - exports.ZodLiteral = ZodLiteral; - ZodLiteral.create = (value, params) => { - return new ZodLiteral({ - value, - typeName: ZodFirstPartyTypeKind.ZodLiteral, - ...processCreateParams(params) - }); - }; - function createZodEnum(values, params) { - return new ZodEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodEnum, - ...processCreateParams(params) - }); - } - var ZodEnum = class _ZodEnum extends ZodType { - _parse(input) { - if (typeof input.data !== "string") { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(this._def.values); - } - if (!this._cache.has(input.data)) { - const ctx = this._getOrReturnCtx(input); - const expectedValues = this._def.values; - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get options() { - return this._def.values; - } - get enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Values() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - get Enum() { - const enumValues = {}; - for (const val of this._def.values) { - enumValues[val] = val; - } - return enumValues; - } - extract(values, newDef = this._def) { - return _ZodEnum.create(values, { - ...this._def, - ...newDef - }); - } - exclude(values, newDef = this._def) { - return _ZodEnum.create(this.options.filter((opt) => !values.includes(opt)), { - ...this._def, - ...newDef - }); - } - }; - exports.ZodEnum = ZodEnum; - ZodEnum.create = createZodEnum; - var ZodNativeEnum = class extends ZodType { - _parse(input) { - const nativeEnumValues = util_js_1.util.getValidEnumValues(this._def.values); - const ctx = this._getOrReturnCtx(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.string && ctx.parsedType !== util_js_1.ZodParsedType.number) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - expected: util_js_1.util.joinValues(expectedValues), - received: ctx.parsedType, - code: ZodError_js_1.ZodIssueCode.invalid_type - }); - return parseUtil_js_1.INVALID; - } - if (!this._cache) { - this._cache = new Set(util_js_1.util.getValidEnumValues(this._def.values)); - } - if (!this._cache.has(input.data)) { - const expectedValues = util_js_1.util.objectValues(nativeEnumValues); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - received: ctx.data, - code: ZodError_js_1.ZodIssueCode.invalid_enum_value, - options: expectedValues - }); - return parseUtil_js_1.INVALID; - } - return (0, parseUtil_js_1.OK)(input.data); - } - get enum() { - return this._def.values; - } - }; - exports.ZodNativeEnum = ZodNativeEnum; - ZodNativeEnum.create = (values, params) => { - return new ZodNativeEnum({ - values, - typeName: ZodFirstPartyTypeKind.ZodNativeEnum, - ...processCreateParams(params) - }); - }; - var ZodPromise = class extends ZodType { - unwrap() { - return this._def.type; - } - _parse(input) { - const { ctx } = this._processInputParams(input); - if (ctx.parsedType !== util_js_1.ZodParsedType.promise && ctx.common.async === false) { - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.promise, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - const promisified = ctx.parsedType === util_js_1.ZodParsedType.promise ? ctx.data : Promise.resolve(ctx.data); - return (0, parseUtil_js_1.OK)(promisified.then((data) => { - return this._def.type.parseAsync(data, { - path: ctx.path, - errorMap: ctx.common.contextualErrorMap - }); - })); - } - }; - exports.ZodPromise = ZodPromise; - ZodPromise.create = (schema, params) => { - return new ZodPromise({ - type: schema, - typeName: ZodFirstPartyTypeKind.ZodPromise, - ...processCreateParams(params) - }); - }; - var ZodEffects = class extends ZodType { - innerType() { - return this._def.schema; - } - sourceType() { - return this._def.schema._def.typeName === ZodFirstPartyTypeKind.ZodEffects ? this._def.schema.sourceType() : this._def.schema; - } - _parse(input) { - const { status, ctx } = this._processInputParams(input); - const effect = this._def.effect || null; - const checkCtx = { - addIssue: (arg) => { - (0, parseUtil_js_1.addIssueToContext)(ctx, arg); - if (arg.fatal) { - status.abort(); - } else { - status.dirty(); - } - }, - get path() { - return ctx.path; - } - }; - checkCtx.addIssue = checkCtx.addIssue.bind(checkCtx); - if (effect.type === "preprocess") { - const processed = effect.transform(ctx.data, checkCtx); - if (ctx.common.async) { - return Promise.resolve(processed).then(async (processed2) => { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = await this._def.schema._parseAsync({ - data: processed2, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - }); - } else { - if (status.value === "aborted") - return parseUtil_js_1.INVALID; - const result = this._def.schema._parseSync({ - data: processed, - path: ctx.path, - parent: ctx - }); - if (result.status === "aborted") - return parseUtil_js_1.INVALID; - if (result.status === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - if (status.value === "dirty") - return (0, parseUtil_js_1.DIRTY)(result.value); - return result; - } - } - if (effect.type === "refinement") { - const executeRefinement = (acc) => { - const result = effect.refinement(acc, checkCtx); - if (ctx.common.async) { - return Promise.resolve(result); - } - if (result instanceof Promise) { - throw new Error("Async refinement encountered during synchronous parse operation. Use .parseAsync instead."); - } - return acc; - }; - if (ctx.common.async === false) { - const inner = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - executeRefinement(inner.value); - return { status: status.value, value: inner.value }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((inner) => { - if (inner.status === "aborted") - return parseUtil_js_1.INVALID; - if (inner.status === "dirty") - status.dirty(); - return executeRefinement(inner.value).then(() => { - return { status: status.value, value: inner.value }; - }); - }); - } - } - if (effect.type === "transform") { - if (ctx.common.async === false) { - const base = this._def.schema._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - const result = effect.transform(base.value, checkCtx); - if (result instanceof Promise) { - throw new Error(`Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead.`); - } - return { status: status.value, value: result }; - } else { - return this._def.schema._parseAsync({ data: ctx.data, path: ctx.path, parent: ctx }).then((base) => { - if (!(0, parseUtil_js_1.isValid)(base)) - return parseUtil_js_1.INVALID; - return Promise.resolve(effect.transform(base.value, checkCtx)).then((result) => ({ - status: status.value, - value: result - })); - }); - } - } - util_js_1.util.assertNever(effect); - } - }; - exports.ZodEffects = ZodEffects; - exports.ZodTransformer = ZodEffects; - ZodEffects.create = (schema, effect, params) => { - return new ZodEffects({ - schema, - typeName: ZodFirstPartyTypeKind.ZodEffects, - effect, - ...processCreateParams(params) - }); - }; - ZodEffects.createWithPreprocess = (preprocess, schema, params) => { - return new ZodEffects({ - schema, - effect: { type: "preprocess", transform: preprocess }, - typeName: ZodFirstPartyTypeKind.ZodEffects, - ...processCreateParams(params) - }); - }; - var ZodOptional = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.undefined) { - return (0, parseUtil_js_1.OK)(void 0); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodOptional = ZodOptional; - ZodOptional.create = (type, params) => { - return new ZodOptional({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodOptional, - ...processCreateParams(params) - }); - }; - var ZodNullable = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType === util_js_1.ZodParsedType.null) { - return (0, parseUtil_js_1.OK)(null); - } - return this._def.innerType._parse(input); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodNullable = ZodNullable; - ZodNullable.create = (type, params) => { - return new ZodNullable({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodNullable, - ...processCreateParams(params) - }); - }; - var ZodDefault = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - let data = ctx.data; - if (ctx.parsedType === util_js_1.ZodParsedType.undefined) { - data = this._def.defaultValue(); - } - return this._def.innerType._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - removeDefault() { - return this._def.innerType; - } - }; - exports.ZodDefault = ZodDefault; - ZodDefault.create = (type, params) => { - return new ZodDefault({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodDefault, - defaultValue: typeof params.default === "function" ? params.default : () => params.default, - ...processCreateParams(params) - }); - }; - var ZodCatch = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const newCtx = { - ...ctx, - common: { - ...ctx.common, - issues: [] - } - }; - const result = this._def.innerType._parse({ - data: newCtx.data, - path: newCtx.path, - parent: { - ...newCtx - } - }); - if ((0, parseUtil_js_1.isAsync)(result)) { - return result.then((result2) => { - return { - status: "valid", - value: result2.status === "valid" ? result2.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - }); - } else { - return { - status: "valid", - value: result.status === "valid" ? result.value : this._def.catchValue({ - get error() { - return new ZodError_js_1.ZodError(newCtx.common.issues); - }, - input: newCtx.data - }) - }; - } - } - removeCatch() { - return this._def.innerType; - } - }; - exports.ZodCatch = ZodCatch; - ZodCatch.create = (type, params) => { - return new ZodCatch({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodCatch, - catchValue: typeof params.catch === "function" ? params.catch : () => params.catch, - ...processCreateParams(params) - }); - }; - var ZodNaN = class extends ZodType { - _parse(input) { - const parsedType = this._getType(input); - if (parsedType !== util_js_1.ZodParsedType.nan) { - const ctx = this._getOrReturnCtx(input); - (0, parseUtil_js_1.addIssueToContext)(ctx, { - code: ZodError_js_1.ZodIssueCode.invalid_type, - expected: util_js_1.ZodParsedType.nan, - received: ctx.parsedType - }); - return parseUtil_js_1.INVALID; - } - return { status: "valid", value: input.data }; - } - }; - exports.ZodNaN = ZodNaN; - ZodNaN.create = (params) => { - return new ZodNaN({ - typeName: ZodFirstPartyTypeKind.ZodNaN, - ...processCreateParams(params) - }); - }; - exports.BRAND = Symbol("zod_brand"); - var ZodBranded = class extends ZodType { - _parse(input) { - const { ctx } = this._processInputParams(input); - const data = ctx.data; - return this._def.type._parse({ - data, - path: ctx.path, - parent: ctx - }); - } - unwrap() { - return this._def.type; - } - }; - exports.ZodBranded = ZodBranded; - var ZodPipeline = class _ZodPipeline extends ZodType { - _parse(input) { - const { status, ctx } = this._processInputParams(input); - if (ctx.common.async) { - const handleAsync = async () => { - const inResult = await this._def.in._parseAsync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return (0, parseUtil_js_1.DIRTY)(inResult.value); - } else { - return this._def.out._parseAsync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - }; - return handleAsync(); - } else { - const inResult = this._def.in._parseSync({ - data: ctx.data, - path: ctx.path, - parent: ctx - }); - if (inResult.status === "aborted") - return parseUtil_js_1.INVALID; - if (inResult.status === "dirty") { - status.dirty(); - return { - status: "dirty", - value: inResult.value - }; - } else { - return this._def.out._parseSync({ - data: inResult.value, - path: ctx.path, - parent: ctx - }); - } - } - } - static create(a, b) { - return new _ZodPipeline({ - in: a, - out: b, - typeName: ZodFirstPartyTypeKind.ZodPipeline - }); - } - }; - exports.ZodPipeline = ZodPipeline; - var ZodReadonly = class extends ZodType { - _parse(input) { - const result = this._def.innerType._parse(input); - const freeze = (data) => { - if ((0, parseUtil_js_1.isValid)(data)) { - data.value = Object.freeze(data.value); - } - return data; - }; - return (0, parseUtil_js_1.isAsync)(result) ? result.then((data) => freeze(data)) : freeze(result); - } - unwrap() { - return this._def.innerType; - } - }; - exports.ZodReadonly = ZodReadonly; - ZodReadonly.create = (type, params) => { - return new ZodReadonly({ - innerType: type, - typeName: ZodFirstPartyTypeKind.ZodReadonly, - ...processCreateParams(params) - }); - }; - function cleanParams(params, data) { - const p = typeof params === "function" ? params(data) : typeof params === "string" ? { message: params } : params; - const p2 = typeof p === "string" ? { message: p } : p; - return p2; - } - function custom(check, _params = {}, fatal) { - if (check) - return ZodAny.create().superRefine((data, ctx) => { - const r = check(data); - if (r instanceof Promise) { - return r.then((r2) => { - if (!r2) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - }); - } - if (!r) { - const params = cleanParams(_params, data); - const _fatal = params.fatal ?? fatal ?? true; - ctx.addIssue({ code: "custom", ...params, fatal: _fatal }); - } - return; - }); - return ZodAny.create(); - } - exports.late = { - object: ZodObject.lazycreate - }; - var ZodFirstPartyTypeKind; - (function(ZodFirstPartyTypeKind2) { - ZodFirstPartyTypeKind2["ZodString"] = "ZodString"; - ZodFirstPartyTypeKind2["ZodNumber"] = "ZodNumber"; - ZodFirstPartyTypeKind2["ZodNaN"] = "ZodNaN"; - ZodFirstPartyTypeKind2["ZodBigInt"] = "ZodBigInt"; - ZodFirstPartyTypeKind2["ZodBoolean"] = "ZodBoolean"; - ZodFirstPartyTypeKind2["ZodDate"] = "ZodDate"; - ZodFirstPartyTypeKind2["ZodSymbol"] = "ZodSymbol"; - ZodFirstPartyTypeKind2["ZodUndefined"] = "ZodUndefined"; - ZodFirstPartyTypeKind2["ZodNull"] = "ZodNull"; - ZodFirstPartyTypeKind2["ZodAny"] = "ZodAny"; - ZodFirstPartyTypeKind2["ZodUnknown"] = "ZodUnknown"; - ZodFirstPartyTypeKind2["ZodNever"] = "ZodNever"; - ZodFirstPartyTypeKind2["ZodVoid"] = "ZodVoid"; - ZodFirstPartyTypeKind2["ZodArray"] = "ZodArray"; - ZodFirstPartyTypeKind2["ZodObject"] = "ZodObject"; - ZodFirstPartyTypeKind2["ZodUnion"] = "ZodUnion"; - ZodFirstPartyTypeKind2["ZodDiscriminatedUnion"] = "ZodDiscriminatedUnion"; - ZodFirstPartyTypeKind2["ZodIntersection"] = "ZodIntersection"; - ZodFirstPartyTypeKind2["ZodTuple"] = "ZodTuple"; - ZodFirstPartyTypeKind2["ZodRecord"] = "ZodRecord"; - ZodFirstPartyTypeKind2["ZodMap"] = "ZodMap"; - ZodFirstPartyTypeKind2["ZodSet"] = "ZodSet"; - ZodFirstPartyTypeKind2["ZodFunction"] = "ZodFunction"; - ZodFirstPartyTypeKind2["ZodLazy"] = "ZodLazy"; - ZodFirstPartyTypeKind2["ZodLiteral"] = "ZodLiteral"; - ZodFirstPartyTypeKind2["ZodEnum"] = "ZodEnum"; - ZodFirstPartyTypeKind2["ZodEffects"] = "ZodEffects"; - ZodFirstPartyTypeKind2["ZodNativeEnum"] = "ZodNativeEnum"; - ZodFirstPartyTypeKind2["ZodOptional"] = "ZodOptional"; - ZodFirstPartyTypeKind2["ZodNullable"] = "ZodNullable"; - ZodFirstPartyTypeKind2["ZodDefault"] = "ZodDefault"; - ZodFirstPartyTypeKind2["ZodCatch"] = "ZodCatch"; - ZodFirstPartyTypeKind2["ZodPromise"] = "ZodPromise"; - ZodFirstPartyTypeKind2["ZodBranded"] = "ZodBranded"; - ZodFirstPartyTypeKind2["ZodPipeline"] = "ZodPipeline"; - ZodFirstPartyTypeKind2["ZodReadonly"] = "ZodReadonly"; - })(ZodFirstPartyTypeKind || (exports.ZodFirstPartyTypeKind = ZodFirstPartyTypeKind = {})); - var instanceOfType = (cls, params = { - message: `Input not instance of ${cls.name}` - }) => custom((data) => data instanceof cls, params); - exports.instanceof = instanceOfType; - var stringType = ZodString.create; - exports.string = stringType; - var numberType = ZodNumber.create; - exports.number = numberType; - var nanType = ZodNaN.create; - exports.nan = nanType; - var bigIntType = ZodBigInt.create; - exports.bigint = bigIntType; - var booleanType = ZodBoolean.create; - exports.boolean = booleanType; - var dateType = ZodDate.create; - exports.date = dateType; - var symbolType = ZodSymbol.create; - exports.symbol = symbolType; - var undefinedType = ZodUndefined.create; - exports.undefined = undefinedType; - var nullType = ZodNull.create; - exports.null = nullType; - var anyType = ZodAny.create; - exports.any = anyType; - var unknownType = ZodUnknown.create; - exports.unknown = unknownType; - var neverType = ZodNever.create; - exports.never = neverType; - var voidType = ZodVoid.create; - exports.void = voidType; - var arrayType = ZodArray.create; - exports.array = arrayType; - var objectType = ZodObject.create; - exports.object = objectType; - var strictObjectType = ZodObject.strictCreate; - exports.strictObject = strictObjectType; - var unionType = ZodUnion.create; - exports.union = unionType; - var discriminatedUnionType = ZodDiscriminatedUnion.create; - exports.discriminatedUnion = discriminatedUnionType; - var intersectionType = ZodIntersection.create; - exports.intersection = intersectionType; - var tupleType = ZodTuple.create; - exports.tuple = tupleType; - var recordType = ZodRecord.create; - exports.record = recordType; - var mapType = ZodMap.create; - exports.map = mapType; - var setType = ZodSet.create; - exports.set = setType; - var functionType = ZodFunction.create; - exports.function = functionType; - var lazyType = ZodLazy.create; - exports.lazy = lazyType; - var literalType = ZodLiteral.create; - exports.literal = literalType; - var enumType = ZodEnum.create; - exports.enum = enumType; - var nativeEnumType = ZodNativeEnum.create; - exports.nativeEnum = nativeEnumType; - var promiseType = ZodPromise.create; - exports.promise = promiseType; - var effectsType = ZodEffects.create; - exports.effect = effectsType; - exports.transformer = effectsType; - var optionalType = ZodOptional.create; - exports.optional = optionalType; - var nullableType = ZodNullable.create; - exports.nullable = nullableType; - var preprocessType = ZodEffects.createWithPreprocess; - exports.preprocess = preprocessType; - var pipelineType = ZodPipeline.create; - exports.pipeline = pipelineType; - var ostring = () => stringType().optional(); - exports.ostring = ostring; - var onumber = () => numberType().optional(); - exports.onumber = onumber; - var oboolean = () => booleanType().optional(); - exports.oboolean = oboolean; - exports.coerce = { - string: ((arg) => ZodString.create({ ...arg, coerce: true })), - number: ((arg) => ZodNumber.create({ ...arg, coerce: true })), - boolean: ((arg) => ZodBoolean.create({ - ...arg, - coerce: true - })), - bigint: ((arg) => ZodBigInt.create({ ...arg, coerce: true })), - date: ((arg) => ZodDate.create({ ...arg, coerce: true })) - }; - exports.NEVER = parseUtil_js_1.INVALID; - } - }); - - // node_modules/zod/v3/external.cjs - var require_external = __commonJS({ - "node_modules/zod/v3/external.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_errors(), exports); - __exportStar(require_parseUtil(), exports); - __exportStar(require_typeAliases(), exports); - __exportStar(require_util(), exports); - __exportStar(require_types(), exports); - __exportStar(require_ZodError(), exports); - } - }); - - // node_modules/zod/index.cjs - var require_zod = __commonJS({ - "node_modules/zod/index.cjs"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); - } - __setModuleDefault(result, mod); - return result; - }; - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.z = void 0; - var z = __importStar(require_external()); - exports.z = z; - __exportStar(require_external(), exports); - exports.default = z; - } - }); - - // node_modules/@mistralai/mistralai/lib/base64.js - var require_base64 = __commonJS({ - "node_modules/@mistralai/mistralai/lib/base64.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodInbound = exports.zodOutbound = void 0; - exports.bytesToBase64 = bytesToBase64; - exports.bytesFromBase64 = bytesFromBase64; - exports.stringToBytes = stringToBytes; - exports.stringFromBytes = stringFromBytes; - exports.stringToBase64 = stringToBase64; - exports.stringFromBase64 = stringFromBase64; - var z = __importStar(require_zod()); - function bytesToBase64(u8arr) { - return btoa(String.fromCodePoint(...u8arr)); - } - function bytesFromBase64(encoded) { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); - } - function stringToBytes(str) { - return new TextEncoder().encode(str); - } - function stringFromBytes(u8arr) { - return new TextDecoder().decode(u8arr); - } - function stringToBase64(str) { - return bytesToBase64(stringToBytes(str)); - } - function stringFromBase64(b64str) { - return stringFromBytes(bytesFromBase64(b64str)); - } - exports.zodOutbound = z.instanceof(Uint8Array).or(z.string().transform(stringToBytes)); - exports.zodInbound = z.instanceof(Uint8Array).or(z.string().transform(bytesFromBase64)); - } - }); - - // node_modules/@mistralai/mistralai/lib/is-plain-object.js - var require_is_plain_object = __commonJS({ - "node_modules/@mistralai/mistralai/lib/is-plain-object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isPlainObject = isPlainObject; - function isPlainObject(value) { - if (typeof value !== "object" || value === null) { - return false; - } - const prototype = Object.getPrototypeOf(value); - return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/encodings.js - var require_encodings = __commonJS({ - "node_modules/@mistralai/mistralai/lib/encodings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.encodeDeepObjectQuery = exports.encodePipeDelimitedQuery = exports.encodeSpaceDelimitedQuery = exports.encodeFormQuery = exports.encodeJSONQuery = exports.encodeSimple = exports.encodePipeDelimited = exports.encodeSpaceDelimited = exports.encodeForm = exports.EncodingError = void 0; - exports.encodeMatrix = encodeMatrix; - exports.encodeLabel = encodeLabel; - exports.encodeBodyForm = encodeBodyForm; - exports.encodeDeepObject = encodeDeepObject; - exports.encodeDeepObjectObject = encodeDeepObjectObject; - exports.encodeJSON = encodeJSON; - exports.queryJoin = queryJoin; - exports.queryEncoder = queryEncoder; - exports.appendForm = appendForm; - var base64_js_1 = require_base64(); - var is_plain_object_js_1 = require_is_plain_object(); - var EncodingError = class extends Error { - constructor(message) { - super(message); - this.name = "EncodingError"; - } - }; - exports.EncodingError = EncodingError; - function encodeMatrix(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - if (!tmp) { - return; - } - out += `;${tmp}`; - }); - return out; - } - function encodeLabel(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - out += encValue == null ? "" : `.${encValue}`; - }); - return out; - } - function formEncoder(sep) { - return (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - const encodedSep = encodeString(sep); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = null; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - if (encValue == null) { - return; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - }; - } - exports.encodeForm = formEncoder(","); - exports.encodeSpaceDelimited = formEncoder(" "); - exports.encodePipeDelimited = formEncoder("|"); - function encodeBodyForm(key, value, options) { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - tmp = `${encodeString(pk)}=${encValue}`; - if (!tmp || tmp === "=") { - return; - } - out += `&${tmp}`; - }); - return out.slice(1); - } - function encodeDeepObject(key, value, options) { - if (value == null) { - return; - } - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Value of parameter '${key}' which uses deepObject encoding must be an object or null`); - } - return encodeDeepObjectObject(key, value, options); - } - function encodeDeepObjectObject(key, value, options) { - if (value == null) { - return; - } - let out = ""; - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - if (!(0, is_plain_object_js_1.isPlainObject)(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - const pk = `${key}[${ck}]`; - if ((0, is_plain_object_js_1.isPlainObject)(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - out += objOut == null ? "" : `&${objOut}`; - return; - } - const pairs = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - out += encoded == null ? "" : `&${encoded}`; - }); - return out.slice(1); - } - function encodeJSON(key, value, options) { - if (typeof value === "undefined") { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; - } - var encodeSimple = (key, value, options) => { - let out = ""; - const pairs = options?.explode ? explode(key, value) : [[key, value]]; - if (pairs.every(([_, v]) => v == null)) { - return; - } - const encodeString = (v) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v) => encodeString(serializeValue(v)); - pairs.forEach(([pk, pv]) => { - let tmp = ""; - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if ((0, is_plain_object_js_1.isPlainObject)(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && (0, is_plain_object_js_1.isPlainObject)(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - out += tmp ? `,${tmp}` : ""; - }); - return out.slice(1); - }; - exports.encodeSimple = encodeSimple; - function explode(key, value) { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if ((0, is_plain_object_js_1.isPlainObject)(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } - } - function serializeValue(value) { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - return `${value}`; - } - function jsonReplacer(_, value) { - if (value instanceof Uint8Array) { - return (0, base64_js_1.bytesToBase64)(value); - } else { - return value; - } - } - function mapDefined(inp, mapper) { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - const m = mapper(v); - if (m == null) { - return acc; - } - acc.push(m); - return acc; - }, []); - return res.length ? res : null; - } - function mapDefinedEntries(inp, mapper) { - const acc = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - const m = mapper([k, v]); - if (m == null) { - continue; - } - acc.push(m); - } - return acc.length ? acc : null; - } - function queryJoin(...args) { - return args.filter(Boolean).join("&"); - } - function queryEncoder(f) { - const bulkEncode = function(values, options) { - const opts = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent" - }; - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - return bulkEncode; - } - exports.encodeJSONQuery = queryEncoder(encodeJSON); - exports.encodeFormQuery = queryEncoder(exports.encodeForm); - exports.encodeSpaceDelimitedQuery = queryEncoder(exports.encodeSpaceDelimited); - exports.encodePipeDelimitedQuery = queryEncoder(exports.encodePipeDelimited); - exports.encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - function appendForm(fd, key, value, fileName) { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/dlv.js - var require_dlv = __commonJS({ - "node_modules/@mistralai/mistralai/lib/dlv.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.dlv = dlv; - function dlv(obj, key, def, p, undef) { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/env.js - var require_env = __commonJS({ - "node_modules/@mistralai/mistralai/lib/env.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.envSchema = void 0; - exports.env = env; - exports.resetEnv = resetEnv; - var dlv_js_1 = require_dlv(); - var z = __importStar(require_zod()); - exports.envSchema = z.object({ - MISTRAL_API_KEY: z.string().optional(), - MISTRAL_DEBUG: z.coerce.boolean().optional() - }); - var envMemo = void 0; - function env() { - if (envMemo) { - return envMemo; - } - envMemo = exports.envSchema.parse((0, dlv_js_1.dlv)(globalThis, "process.env") ?? (0, dlv_js_1.dlv)(globalThis, "Deno.env") ?? {}); - return envMemo; - } - function resetEnv() { - envMemo = void 0; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/retries.js - var require_retries = __commonJS({ - "node_modules/@mistralai/mistralai/lib/retries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TemporaryError = exports.PermanentError = void 0; - exports.retry = retry; - var http_js_1 = require_http(); - var defaultBackoff = { - initialInterval: 500, - maxInterval: 6e4, - exponent: 1.5, - maxElapsedTime: 36e5 - }; - var PermanentError = class _PermanentError extends Error { - constructor(message, options) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - super(msg, options); - this.name = "PermanentError"; - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - Object.setPrototypeOf(this, _PermanentError.prototype); - } - }; - exports.PermanentError = PermanentError; - var TemporaryError = class _TemporaryError extends Error { - constructor(message, response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - Object.setPrototypeOf(this, _TemporaryError.prototype); - } - }; - exports.TemporaryError = TemporaryError; - async function retry(fetchFn, options) { - switch (options.config.strategy) { - case "backoff": - return retryBackoff(wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors - }), options.config.backoff ?? defaultBackoff); - default: - return await fetchFn(); - } - } - function wrapFetcher(fn, options) { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError("Response failed with retryable status code", res); - } - return res; - } catch (err) { - if (err instanceof TemporaryError) { - throw err; - } - if (options.retryConnectionErrors && ((0, http_js_1.isTimeoutError)(err) || (0, http_js_1.isConnectionError)(err))) { - throw err; - } - throw new PermanentError("Permanent error", { cause: err }); - } - }; - } - var codeRangeRE = new RegExp("^[0-9]xx$", "i"); - function isRetryableResponse(res, statusCodes) { - const actual = `${res.status}`; - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - return actualFamily === expectFamily; - }); - } - async function retryBackoff(fn, strategy) { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - const start = Date.now(); - let x = 0; - while (true) { - try { - const res = await fn(); - return res; - } catch (err) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - throw err; - } - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - if (retryInterval <= 0) { - retryInterval = initialInterval * Math.pow(x, exponent) + Math.random() * 1e3; - } - const d = Math.min(retryInterval, maxInterval); - await delay(d); - x++; - } - } - } - function retryIntervalFromResponse(res) { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1e3; - } - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - return 0; - } - async function delay(delay2) { - return new Promise((resolve) => setTimeout(resolve, delay2)); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/sdks.js - var require_sdks = __commonJS({ - "node_modules/@mistralai/mistralai/lib/sdks.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _ClientSDK_httpClient; - var _ClientSDK_hooks; - var _ClientSDK_logger; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClientSDK = void 0; - var hooks_js_1 = require_hooks(); - var httpclienterrors_js_1 = require_httpclienterrors(); - var fp_js_1 = require_fp(); - var base64_js_1 = require_base64(); - var config_js_1 = require_config(); - var encodings_js_1 = require_encodings(); - var env_js_1 = require_env(); - var http_js_1 = require_http(); - var retries_js_1 = require_retries(); - var gt = typeof globalThis === "undefined" ? null : globalThis; - var webWorkerLike = typeof gt === "object" && gt != null && "importScripts" in gt && typeof gt["importScripts"] === "function"; - var isBrowserLike = webWorkerLike || typeof navigator !== "undefined" && "serviceWorker" in navigator || typeof window === "object" && typeof window.document !== "undefined"; - var ClientSDK = class { - constructor(options = {}) { - _ClientSDK_httpClient.set(this, void 0); - _ClientSDK_hooks.set(this, void 0); - _ClientSDK_logger.set(this, void 0); - const opt = options; - if (typeof opt === "object" && opt != null && "hooks" in opt && opt.hooks instanceof hooks_js_1.SDKHooks) { - __classPrivateFieldSet(this, _ClientSDK_hooks, opt.hooks, "f"); - } else { - __classPrivateFieldSet(this, _ClientSDK_hooks, new hooks_js_1.SDKHooks(), "f"); - } - const url = (0, config_js_1.serverURLFromOptions)(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").sdkInit({ - baseURL: url, - client: options.httpClient || new http_js_1.HTTPClient() - }); - this._baseURL = baseURL; - __classPrivateFieldSet(this, _ClientSDK_httpClient, client, "f"); - this._options = { ...options, hooks: __classPrivateFieldGet(this, _ClientSDK_hooks, "f") }; - __classPrivateFieldSet(this, _ClientSDK_logger, this._options.debugLogger, "f"); - if (!__classPrivateFieldGet(this, _ClientSDK_logger, "f") && (0, env_js_1.env)().MISTRAL_DEBUG) { - __classPrivateFieldSet(this, _ClientSDK_logger, console, "f"); - } - } - _createRequest(context, conf, options) { - const { method, path, query, headers: opHeaders, security } = conf; - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - let finalQuery = query || ""; - const secQuery = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = (0, encodings_js_1.encodeForm)(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - const headers = new Headers(opHeaders); - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = (0, base64_js_1.stringToBase64)([username || "", password || ""].join(":")); - headers.set("Authorization", `Basic ${encoded}`); - } - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - const userHeaders = new Headers(options?.headers ?? options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", conf.userAgent ?? config_js_1.SDK_METADATA.userAgent); - } - const fetchOptions = { - ...options?.fetchOptions, - ...options - }; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - fetchOptions.signal = timeoutSignal; - } - if (conf.body instanceof ReadableStream) { - Object.assign(fetchOptions, { duplex: "half" }); - } - let input; - try { - input = __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method - } - }); - } catch (err) { - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Create request hook failed to execute", { - cause: err - })); - } - return (0, fp_js_1.OK)(new Request(input.url, input.options)); - } - async _do(request, options) { - const { context, errorCodes } = options; - return (0, retries_js_1.retry)(async () => { - const req = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").beforeRequest(context, request.clone()); - await logRequest(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log request:", e)); - let response = await __classPrivateFieldGet(this, _ClientSDK_httpClient, "f").request(req); - try { - if ((0, http_js_1.matchStatusCode)(response, errorCodes)) { - const result = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterError(context, response, null); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await __classPrivateFieldGet(this, _ClientSDK_hooks, "f").afterSuccess(context, response); - } - } finally { - await logResponse(__classPrivateFieldGet(this, _ClientSDK_logger, "f"), response, req).catch((e) => __classPrivateFieldGet(this, _ClientSDK_logger, "f")?.log("Failed to log response:", e)); - } - return response; - }, { config: options.retryConfig, statusCodes: options.retryCodes }).then((r) => (0, fp_js_1.OK)(r), (err) => { - switch (true) { - case (0, http_js_1.isAbortError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestAbortedError("Request aborted by client", { - cause: err - })); - case (0, http_js_1.isTimeoutError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.RequestTimeoutError("Request timed out", { cause: err })); - case (0, http_js_1.isConnectionError)(err): - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.ConnectionError("Unable to make request", { cause: err })); - default: - return (0, fp_js_1.ERR)(new httpclienterrors_js_1.UnexpectedClientError("Unexpected HTTP client error", { - cause: err - })); - } - }); - } - }; - exports.ClientSDK = ClientSDK; - _ClientSDK_httpClient = /* @__PURE__ */ new WeakMap(), _ClientSDK_hooks = /* @__PURE__ */ new WeakMap(), _ClientSDK_logger = /* @__PURE__ */ new WeakMap(); - var jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; - var jsonlLikeContentTypeRE = /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; - async function logRequest(logger, req) { - if (!logger) { - return; - } - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`> Request: ${req.method} ${req.url}`); - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - async function logResponse(logger, res, req) { - if (!logger) { - return; - } - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - logger.group("Body:"); - switch (true) { - case ((0, http_js_1.matchContentType)(res, "application/json") || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().json()); - break; - case ((0, http_js_1.matchContentType)(res, "application/jsonl") || jsonlLikeContentTypeRE.test(ct)): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case (0, http_js_1.matchContentType)(res, "text/*"): - logger.log(await res.clone().text()); - break; - case (0, http_js_1.matchContentType)(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - logger.groupEnd(); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/mistralerror.js - var require_mistralerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/mistralerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralError = void 0; - var MistralError = class extends Error { - constructor(message, httpMeta) { - super(message); - this.statusCode = httpMeta.response.status; - this.body = httpMeta.body; - this.headers = httpMeta.response.headers; - this.contentType = httpMeta.response.headers.get("content-type") || ""; - this.rawResponse = httpMeta.response; - this.name = "MistralError"; - } - }; - exports.MistralError = MistralError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js - var require_sdkvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKValidationError = void 0; - exports.formatZodError = formatZodError; - var z = __importStar(require_zod()); - var SDKValidationError = class extends Error { - // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError` - static [Symbol.hasInstance](instance) { - if (!(instance instanceof Error)) - return false; - if (!("rawValue" in instance)) - return false; - if (!("rawMessage" in instance)) - return false; - if (!("pretty" in instance)) - return false; - if (typeof instance.pretty !== "function") - return false; - return true; - } - constructor(message, cause, rawValue) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.SDKValidationError = SDKValidationError; - function formatZodError(err, level = 0) { - let pre = " ".repeat(level); - pre = level > 0 ? `\u2502${pre}` : pre; - pre += " ".repeat(level); - let message = ""; - const append = (str) => message += ` -${pre}${str}`; - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - if (len) { - append(`\u250C ${headline}:`); - } - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`\u2502 \u2022 [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`\u2502 Want: ${issue.expected}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`\u2502 Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - append(`\u2502 Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`\u2502 Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len2 = issue.unionErrors.length; - append(`\u2502 \u2716\uFE0E Attemped to deserialize into one of ${len2} union members:`); - issue.unionErrors.forEach((err2, i) => { - append(`\u2502 \u2716\uFE0E Member ${i + 1} of ${len2}`); - append(`${formatZodError(err2, level + 1)}`); - }); - } - } - } - if (err.issues.length) { - append(`\u2514\u2500*`); - } - return message.slice(1); - } - } - }); - - // node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js - var require_responsevalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/responsevalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseValidationError = void 0; - var z = __importStar(require_zod()); - var mistralerror_js_1 = require_mistralerror(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var ResponseValidationError = class extends mistralerror_js_1.MistralError { - constructor(message, extra) { - super(message, extra); - this.name = "ResponseValidationError"; - this.cause = extra.cause; - this.rawValue = extra.rawValue; - this.rawMessage = extra.rawMessage; - } - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty() { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage} -${(0, sdkvalidationerror_js_1.formatZodError)(this.cause)}`; - } else { - return this.toString(); - } - } - }; - exports.ResponseValidationError = ResponseValidationError; - } - }); - - // node_modules/@mistralai/mistralai/models/errors/sdkerror.js - var require_sdkerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/sdkerror.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SDKError = void 0; - var mistralerror_js_1 = require_mistralerror(); - var SDKError = class extends mistralerror_js_1.MistralError { - constructor(message, httpMeta) { - if (message) { - message += `: `; - } - message += `Status ${httpMeta.response.status}`; - const contentType = httpMeta.response.headers.get("content-type") || `""`; - if (contentType !== "application/json") { - message += ` Content-Type ${contentType.includes(" ") ? `"${contentType}"` : contentType}`; - } - const body = httpMeta.body || `""`; - message += body.length > 100 ? "\n" : ". "; - let bodyDisplay = body; - if (body.length > 1e4) { - const truncated = body.substring(0, 1e4); - const remaining = body.length - 1e4; - bodyDisplay = `${truncated}...and ${remaining} more chars`; - } - message += `Body: ${bodyDisplay}`; - message = message.trim(); - super(message, httpMeta); - this.name = "SDKError"; - } - }; - exports.SDKError = SDKError; - } - }); - - // node_modules/@mistralai/mistralai/lib/matchers.js - var require_matchers = __commonJS({ - "node_modules/@mistralai/mistralai/lib/matchers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.jsonErr = jsonErr; - exports.json = json; - exports.jsonl = jsonl; - exports.jsonlErr = jsonlErr; - exports.textErr = textErr; - exports.text = text; - exports.bytesErr = bytesErr; - exports.bytes = bytes; - exports.streamErr = streamErr; - exports.stream = stream; - exports.sseErr = sseErr; - exports.sse = sse; - exports.nilErr = nilErr; - exports.nil = nil; - exports.fail = fail; - exports.match = match; - exports.unpackHeaders = unpackHeaders; - var responsevalidationerror_js_1 = require_responsevalidationerror(); - var sdkerror_js_1 = require_sdkerror(); - var fp_js_1 = require_fp(); - var http_js_1 = require_http(); - var is_plain_object_js_1 = require_is_plain_object(); - var DEFAULT_CONTENT_TYPES = { - jsonl: "application/jsonl", - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*" - }; - function jsonErr(codes, schema, options) { - return { ...options, err: true, enc: "json", codes, schema }; - } - function json(codes, schema, options) { - return { ...options, enc: "json", codes, schema }; - } - function jsonl(codes, schema, options) { - return { ...options, enc: "jsonl", codes, schema }; - } - function jsonlErr(codes, schema, options) { - return { ...options, err: true, enc: "jsonl", codes, schema }; - } - function textErr(codes, schema, options) { - return { ...options, err: true, enc: "text", codes, schema }; - } - function text(codes, schema, options) { - return { ...options, enc: "text", codes, schema }; - } - function bytesErr(codes, schema, options) { - return { ...options, err: true, enc: "bytes", codes, schema }; - } - function bytes(codes, schema, options) { - return { ...options, enc: "bytes", codes, schema }; - } - function streamErr(codes, schema, options) { - return { ...options, err: true, enc: "stream", codes, schema }; - } - function stream(codes, schema, options) { - return { ...options, enc: "stream", codes, schema }; - } - function sseErr(codes, schema, options) { - return { ...options, err: true, enc: "sse", codes, schema }; - } - function sse(codes, schema, options) { - return { ...options, enc: "sse", codes, schema }; - } - function nilErr(codes, schema, options) { - return { ...options, err: true, enc: "nil", codes, schema }; - } - function nil(codes, schema, options) { - return { ...options, enc: "nil", codes, schema }; - } - function fail(codes) { - return { enc: "fail", codes }; - } - function match(...matchers) { - return async function matchFunc(response, request, options) { - let raw; - let matcher; - for (const match2 of matchers) { - const { codes } = match2; - const ctpattern = "ctype" in match2 ? match2.ctype : DEFAULT_CONTENT_TYPES[match2.enc]; - if (ctpattern && (0, http_js_1.matchResponse)(response, codes, ctpattern)) { - matcher = match2; - break; - } else if (!ctpattern && (0, http_js_1.matchStatusCode)(response, codes)) { - matcher = match2; - break; - } - } - if (!matcher) { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("Unexpected Status or Content-Type", { - response, - request, - body: await response.text().catch(() => "") - }) - }, raw]; - } - const encoding = matcher.enc; - let body = ""; - switch (encoding) { - case "json": - body = await response.text(); - raw = JSON.parse(body); - break; - case "jsonl": - raw = response.body; - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - body = await response.text(); - raw = body; - break; - case "sse": - raw = response.body; - break; - case "nil": - body = await response.text(); - raw = void 0; - break; - case "fail": - body = await response.text(); - raw = body; - break; - default: - encoding; - throw new Error(`Unsupported response type: ${encoding}`); - } - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new sdkerror_js_1.SDKError("API error occurred", { request, response, body }) - }, raw]; - } - const resultKey = matcher.key || options?.resultKey; - let data; - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null, - request$: request, - response$: response, - body$: body - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - [resultKey]: raw - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null, - ...(0, is_plain_object_js_1.isPlainObject)(raw) ? raw : null - }; - } else { - data = raw; - } - if ("err" in matcher) { - const result = safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParseResponse(data, (v) => matcher.schema.parse(v), "Response validation failed", { request, response, body }), - raw - ]; - } - }; - } - var headerValRE = /, */; - function unpackHeaders(headers) { - const out = {}; - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - return out; - } - function safeParseResponse(rawValue, fn, errorMessage, httpMeta) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new responsevalidationerror_js_1.ResponseValidationError(errorMessage, { - cause: err, - rawValue, - rawMessage: errorMessage, - ...httpMeta - })); - } - } - } - }); - - // node_modules/@mistralai/mistralai/lib/primitives.js - var require_primitives = __commonJS({ - "node_modules/@mistralai/mistralai/lib/primitives.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.invariant = invariant; - exports.remap = remap; - exports.combineSignals = combineSignals; - exports.abortSignalAny = abortSignalAny; - exports.compactMap = compactMap; - exports.allRequired = allRequired; - var InvariantError = class extends Error { - constructor(message) { - super(message); - this.name = "InvariantError"; - } - }; - function invariant(condition, message) { - if (!condition) { - throw new InvariantError(message); - } - } - function remap(inp, mappings) { - let out = {}; - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - return out; - } - function combineSignals(...signals) { - const filtered = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } - } - function abortSignalAny(signals) { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - if (signals.length === 1) { - return signals[0] || controller.signal; - } - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - function abort() { - controller.abort(this.reason); - clean(); - } - const signalRefs = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - return result; - } - function compactMap(values) { - const out = {}; - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - return out; - } - function allRequired(v) { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - return v; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/schemas.js - var require_schemas = __commonJS({ - "node_modules/@mistralai/mistralai/lib/schemas.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parse = parse; - exports.safeParse = safeParse; - exports.collectExtraKeys = collectExtraKeys; - var zod_1 = require_zod(); - var sdkvalidationerror_js_1 = require_sdkvalidationerror(); - var fp_js_1 = require_fp(); - function parse(rawValue, fn, errorMessage) { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof zod_1.ZodError) { - throw new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } - } - function safeParse(rawValue, fn, errorMessage) { - try { - return (0, fp_js_1.OK)(fn(rawValue)); - } catch (err) { - return (0, fp_js_1.ERR)(new sdkvalidationerror_js_1.SDKValidationError(errorMessage, err, rawValue)); - } - } - function collectExtraKeys(obj, extrasKey, optional) { - return obj.transform((val) => { - const extras = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - extras[key] = v; - delete val[key]; - } - if (optional && Object.keys(extras).length === 0) { - return val; - } - return { ...val, [extrasKey]: extras }; - }); - } - } - }); - - // node_modules/@mistralai/mistralai/lib/security.js - var require_security = __commonJS({ - "node_modules/@mistralai/mistralai/lib/security.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SecurityError = exports.SecurityErrorCode = void 0; - exports.resolveSecurity = resolveSecurity; - exports.resolveGlobalSecurity = resolveGlobalSecurity; - exports.extractSecurity = extractSecurity; - var env_js_1 = require_env(); - var SecurityErrorCode; - (function(SecurityErrorCode2) { - SecurityErrorCode2["Incomplete"] = "incomplete"; - SecurityErrorCode2["UnrecognisedSecurityType"] = "unrecognized_security_type"; - })(SecurityErrorCode || (exports.SecurityErrorCode = SecurityErrorCode = {})); - var SecurityError = class _SecurityError extends Error { - constructor(code, message) { - super(message); - this.code = code; - this.name = "SecurityError"; - } - static incomplete() { - return new _SecurityError(SecurityErrorCode.Incomplete, "Security requirements not met in order to perform the operation"); - } - static unrecognizedType(type) { - return new _SecurityError(SecurityErrorCode.UnrecognisedSecurityType, `Unrecognised security type: ${type}`); - } - }; - exports.SecurityError = SecurityError; - function resolveSecurity(...options) { - const state = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" } - }; - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return typeof o.value === "string" && !!o.value; - } else if (o.type === "oauth2:client_credentials") { - if (typeof o.value == "string") { - return !!o.value; - } - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o.value})`); - } - }); - }); - if (option == null) { - return null; - } - option.forEach((spec) => { - if (spec.value == null) { - return; - } - const { type } = spec; - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec; - throw SecurityError.unrecognizedType(type); - } - }); - return state; - } - function applyBasic(state, spec) { - if (spec.value == null) { - return; - } - state.basic = spec.value; - } - function applyBearer(state, spec) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - if (spec.fieldName !== void 0) { - state.headers[spec.fieldName] = value; - } - } - function resolveGlobalSecurity(security) { - return resolveSecurity([ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey ?? (0, env_js_1.env)().MISTRAL_API_KEY - } - ]); - } - async function extractSecurity(sec) { - if (sec == null) { - return; - } - return typeof sec === "function" ? sec() : sec; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js - var require_codeinterpretertool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/codeinterpretertool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CodeInterpreterTool$ = exports.CodeInterpreterTool$outboundSchema = exports.CodeInterpreterTool$inboundSchema = exports.CodeInterpreterToolType$ = exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema = exports.CodeInterpreterToolType = void 0; - exports.codeInterpreterToolToJSON = codeInterpreterToolToJSON; - exports.codeInterpreterToolFromJSON = codeInterpreterToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CodeInterpreterToolType = { - CodeInterpreter: "code_interpreter" - }; - exports.CodeInterpreterToolType$inboundSchema = z.nativeEnum(exports.CodeInterpreterToolType); - exports.CodeInterpreterToolType$outboundSchema = exports.CodeInterpreterToolType$inboundSchema; - var CodeInterpreterToolType$; - (function(CodeInterpreterToolType$2) { - CodeInterpreterToolType$2.inboundSchema = exports.CodeInterpreterToolType$inboundSchema; - CodeInterpreterToolType$2.outboundSchema = exports.CodeInterpreterToolType$outboundSchema; - })(CodeInterpreterToolType$ || (exports.CodeInterpreterToolType$ = CodeInterpreterToolType$ = {})); - exports.CodeInterpreterTool$inboundSchema = z.object({ - type: exports.CodeInterpreterToolType$inboundSchema.default("code_interpreter") - }); - exports.CodeInterpreterTool$outboundSchema = z.object({ - type: exports.CodeInterpreterToolType$outboundSchema.default("code_interpreter") - }); - var CodeInterpreterTool$; - (function(CodeInterpreterTool$2) { - CodeInterpreterTool$2.inboundSchema = exports.CodeInterpreterTool$inboundSchema; - CodeInterpreterTool$2.outboundSchema = exports.CodeInterpreterTool$outboundSchema; - })(CodeInterpreterTool$ || (exports.CodeInterpreterTool$ = CodeInterpreterTool$ = {})); - function codeInterpreterToolToJSON(codeInterpreterTool) { - return JSON.stringify(exports.CodeInterpreterTool$outboundSchema.parse(codeInterpreterTool)); - } - function codeInterpreterToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CodeInterpreterTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CodeInterpreterTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargsstop.js - var require_completionargsstop = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargsstop.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgsStop$ = exports.CompletionArgsStop$outboundSchema = exports.CompletionArgsStop$inboundSchema = void 0; - exports.completionArgsStopToJSON = completionArgsStopToJSON; - exports.completionArgsStopFromJSON = completionArgsStopFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.CompletionArgsStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.CompletionArgsStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var CompletionArgsStop$; - (function(CompletionArgsStop$2) { - CompletionArgsStop$2.inboundSchema = exports.CompletionArgsStop$inboundSchema; - CompletionArgsStop$2.outboundSchema = exports.CompletionArgsStop$outboundSchema; - })(CompletionArgsStop$ || (exports.CompletionArgsStop$ = CompletionArgsStop$ = {})); - function completionArgsStopToJSON(completionArgsStop) { - return JSON.stringify(exports.CompletionArgsStop$outboundSchema.parse(completionArgsStop)); - } - function completionArgsStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgsStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgsStop' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/prediction.js - var require_prediction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/prediction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Prediction$ = exports.Prediction$outboundSchema = exports.Prediction$inboundSchema = void 0; - exports.predictionToJSON = predictionToJSON; - exports.predictionFromJSON = predictionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Prediction$inboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - exports.Prediction$outboundSchema = z.object({ - type: z.literal("content").default("content"), - content: z.string().default("") - }); - var Prediction$; - (function(Prediction$2) { - Prediction$2.inboundSchema = exports.Prediction$inboundSchema; - Prediction$2.outboundSchema = exports.Prediction$outboundSchema; - })(Prediction$ || (exports.Prediction$ = Prediction$ = {})); - function predictionToJSON(prediction) { - return JSON.stringify(exports.Prediction$outboundSchema.parse(prediction)); - } - function predictionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Prediction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Prediction' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jsonschema.js - var require_jsonschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jsonschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JsonSchema$ = exports.JsonSchema$outboundSchema = exports.JsonSchema$inboundSchema = void 0; - exports.jsonSchemaToJSON = jsonSchemaToJSON; - exports.jsonSchemaFromJSON = jsonSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JsonSchema$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "schema": "schemaDefinition" - }); - }); - exports.JsonSchema$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - schemaDefinition: "schema" - }); - }); - var JsonSchema$; - (function(JsonSchema$2) { - JsonSchema$2.inboundSchema = exports.JsonSchema$inboundSchema; - JsonSchema$2.outboundSchema = exports.JsonSchema$outboundSchema; - })(JsonSchema$ || (exports.JsonSchema$ = JsonSchema$ = {})); - function jsonSchemaToJSON(jsonSchema) { - return JSON.stringify(exports.JsonSchema$outboundSchema.parse(jsonSchema)); - } - function jsonSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JsonSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JsonSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformats.js - var require_responseformats = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformats.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormats$ = exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema = exports.ResponseFormats = void 0; - var z = __importStar(require_zod()); - exports.ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema" - }; - exports.ResponseFormats$inboundSchema = z.nativeEnum(exports.ResponseFormats); - exports.ResponseFormats$outboundSchema = exports.ResponseFormats$inboundSchema; - var ResponseFormats$; - (function(ResponseFormats$2) { - ResponseFormats$2.inboundSchema = exports.ResponseFormats$inboundSchema; - ResponseFormats$2.outboundSchema = exports.ResponseFormats$outboundSchema; - })(ResponseFormats$ || (exports.ResponseFormats$ = ResponseFormats$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseformat.js - var require_responseformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseFormat$ = exports.ResponseFormat$outboundSchema = exports.ResponseFormat$inboundSchema = void 0; - exports.responseFormatToJSON = responseFormatToJSON; - exports.responseFormatFromJSON = responseFormatFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var jsonschema_js_1 = require_jsonschema(); - var responseformats_js_1 = require_responseformats(); - exports.ResponseFormat$inboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(jsonschema_js_1.JsonSchema$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "json_schema": "jsonSchema" - }); - }); - exports.ResponseFormat$outboundSchema = z.object({ - type: responseformats_js_1.ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(jsonschema_js_1.JsonSchema$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jsonSchema: "json_schema" - }); - }); - var ResponseFormat$; - (function(ResponseFormat$2) { - ResponseFormat$2.inboundSchema = exports.ResponseFormat$inboundSchema; - ResponseFormat$2.outboundSchema = exports.ResponseFormat$outboundSchema; - })(ResponseFormat$ || (exports.ResponseFormat$ = ResponseFormat$ = {})); - function responseFormatToJSON(responseFormat) { - return JSON.stringify(exports.ResponseFormat$outboundSchema.parse(responseFormat)); - } - function responseFormatFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseFormat$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseFormat' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js - var require_toolchoiceenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoiceenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoiceEnum$ = exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema = exports.ToolChoiceEnum = void 0; - var z = __importStar(require_zod()); - exports.ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required" - }; - exports.ToolChoiceEnum$inboundSchema = z.nativeEnum(exports.ToolChoiceEnum); - exports.ToolChoiceEnum$outboundSchema = exports.ToolChoiceEnum$inboundSchema; - var ToolChoiceEnum$; - (function(ToolChoiceEnum$2) { - ToolChoiceEnum$2.inboundSchema = exports.ToolChoiceEnum$inboundSchema; - ToolChoiceEnum$2.outboundSchema = exports.ToolChoiceEnum$outboundSchema; - })(ToolChoiceEnum$ || (exports.ToolChoiceEnum$ = ToolChoiceEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionargs.js - var require_completionargs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionargs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionArgs$ = exports.CompletionArgs$outboundSchema = exports.CompletionArgs$inboundSchema = void 0; - exports.completionArgsToJSON = completionArgsToJSON; - exports.completionArgsFromJSON = completionArgsFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargsstop_js_1 = require_completionargsstop(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - exports.CompletionArgs$inboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$inboundSchema).optional(), - presence_penalty: z.nullable(z.number()).optional(), - frequency_penalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - top_p: z.nullable(z.number()).optional(), - max_tokens: z.nullable(z.number().int()).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$inboundSchema).optional(), - response_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - tool_choice: toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice" - }); - }); - exports.CompletionArgs$outboundSchema = z.object({ - stop: z.nullable(completionargsstop_js_1.CompletionArgsStop$outboundSchema).optional(), - presencePenalty: z.nullable(z.number()).optional(), - frequencyPenalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - topP: z.nullable(z.number()).optional(), - maxTokens: z.nullable(z.number().int()).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(prediction_js_1.Prediction$outboundSchema).optional(), - responseFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - toolChoice: toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice" - }); - }); - var CompletionArgs$; - (function(CompletionArgs$2) { - CompletionArgs$2.inboundSchema = exports.CompletionArgs$inboundSchema; - CompletionArgs$2.outboundSchema = exports.CompletionArgs$outboundSchema; - })(CompletionArgs$ || (exports.CompletionArgs$ = CompletionArgs$ = {})); - function completionArgsToJSON(completionArgs) { - return JSON.stringify(exports.CompletionArgs$outboundSchema.parse(completionArgs)); - } - function completionArgsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionArgs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionArgs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js - var require_documentlibrarytool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentlibrarytool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentLibraryTool$ = exports.DocumentLibraryTool$outboundSchema = exports.DocumentLibraryTool$inboundSchema = exports.DocumentLibraryToolType$ = exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema = exports.DocumentLibraryToolType = void 0; - exports.documentLibraryToolToJSON = documentLibraryToolToJSON; - exports.documentLibraryToolFromJSON = documentLibraryToolFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentLibraryToolType = { - DocumentLibrary: "document_library" - }; - exports.DocumentLibraryToolType$inboundSchema = z.nativeEnum(exports.DocumentLibraryToolType); - exports.DocumentLibraryToolType$outboundSchema = exports.DocumentLibraryToolType$inboundSchema; - var DocumentLibraryToolType$; - (function(DocumentLibraryToolType$2) { - DocumentLibraryToolType$2.inboundSchema = exports.DocumentLibraryToolType$inboundSchema; - DocumentLibraryToolType$2.outboundSchema = exports.DocumentLibraryToolType$outboundSchema; - })(DocumentLibraryToolType$ || (exports.DocumentLibraryToolType$ = DocumentLibraryToolType$ = {})); - exports.DocumentLibraryTool$inboundSchema = z.object({ - type: exports.DocumentLibraryToolType$inboundSchema.default("document_library"), - library_ids: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_ids": "libraryIds" - }); - }); - exports.DocumentLibraryTool$outboundSchema = z.object({ - type: exports.DocumentLibraryToolType$outboundSchema.default("document_library"), - libraryIds: z.array(z.string()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryIds: "library_ids" - }); - }); - var DocumentLibraryTool$; - (function(DocumentLibraryTool$2) { - DocumentLibraryTool$2.inboundSchema = exports.DocumentLibraryTool$inboundSchema; - DocumentLibraryTool$2.outboundSchema = exports.DocumentLibraryTool$outboundSchema; - })(DocumentLibraryTool$ || (exports.DocumentLibraryTool$ = DocumentLibraryTool$ = {})); - function documentLibraryToolToJSON(documentLibraryTool) { - return JSON.stringify(exports.DocumentLibraryTool$outboundSchema.parse(documentLibraryTool)); - } - function documentLibraryToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentLibraryTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentLibraryTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/function.js - var require_function = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/function.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionT$ = exports.FunctionT$outboundSchema = exports.FunctionT$inboundSchema = void 0; - exports.functionToJSON = functionToJSON; - exports.functionFromJSON = functionFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionT$inboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - exports.FunctionT$outboundSchema = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()) - }); - var FunctionT$; - (function(FunctionT$2) { - FunctionT$2.inboundSchema = exports.FunctionT$inboundSchema; - FunctionT$2.outboundSchema = exports.FunctionT$outboundSchema; - })(FunctionT$ || (exports.FunctionT$ = FunctionT$ = {})); - function functionToJSON(functionT) { - return JSON.stringify(exports.FunctionT$outboundSchema.parse(functionT)); - } - function functionFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functiontool.js - var require_functiontool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functiontool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionTool$ = exports.FunctionTool$outboundSchema = exports.FunctionTool$inboundSchema = exports.FunctionToolType$ = exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema = exports.FunctionToolType = void 0; - exports.functionToolToJSON = functionToolToJSON; - exports.functionToolFromJSON = functionToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - exports.FunctionToolType = { - Function: "function" - }; - exports.FunctionToolType$inboundSchema = z.nativeEnum(exports.FunctionToolType); - exports.FunctionToolType$outboundSchema = exports.FunctionToolType$inboundSchema; - var FunctionToolType$; - (function(FunctionToolType$2) { - FunctionToolType$2.inboundSchema = exports.FunctionToolType$inboundSchema; - FunctionToolType$2.outboundSchema = exports.FunctionToolType$outboundSchema; - })(FunctionToolType$ || (exports.FunctionToolType$ = FunctionToolType$ = {})); - exports.FunctionTool$inboundSchema = z.object({ - type: exports.FunctionToolType$inboundSchema.default("function"), - function: function_js_1.FunctionT$inboundSchema - }); - exports.FunctionTool$outboundSchema = z.object({ - type: exports.FunctionToolType$outboundSchema.default("function"), - function: function_js_1.FunctionT$outboundSchema - }); - var FunctionTool$; - (function(FunctionTool$2) { - FunctionTool$2.inboundSchema = exports.FunctionTool$inboundSchema; - FunctionTool$2.outboundSchema = exports.FunctionTool$outboundSchema; - })(FunctionTool$ || (exports.FunctionTool$ = FunctionTool$ = {})); - function functionToolToJSON(functionTool) { - return JSON.stringify(exports.FunctionTool$outboundSchema.parse(functionTool)); - } - function functionToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js - var require_imagegenerationtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imagegenerationtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageGenerationTool$ = exports.ImageGenerationTool$outboundSchema = exports.ImageGenerationTool$inboundSchema = exports.ImageGenerationToolType$ = exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema = exports.ImageGenerationToolType = void 0; - exports.imageGenerationToolToJSON = imageGenerationToolToJSON; - exports.imageGenerationToolFromJSON = imageGenerationToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageGenerationToolType = { - ImageGeneration: "image_generation" - }; - exports.ImageGenerationToolType$inboundSchema = z.nativeEnum(exports.ImageGenerationToolType); - exports.ImageGenerationToolType$outboundSchema = exports.ImageGenerationToolType$inboundSchema; - var ImageGenerationToolType$; - (function(ImageGenerationToolType$2) { - ImageGenerationToolType$2.inboundSchema = exports.ImageGenerationToolType$inboundSchema; - ImageGenerationToolType$2.outboundSchema = exports.ImageGenerationToolType$outboundSchema; - })(ImageGenerationToolType$ || (exports.ImageGenerationToolType$ = ImageGenerationToolType$ = {})); - exports.ImageGenerationTool$inboundSchema = z.object({ - type: exports.ImageGenerationToolType$inboundSchema.default("image_generation") - }); - exports.ImageGenerationTool$outboundSchema = z.object({ - type: exports.ImageGenerationToolType$outboundSchema.default("image_generation") - }); - var ImageGenerationTool$; - (function(ImageGenerationTool$2) { - ImageGenerationTool$2.inboundSchema = exports.ImageGenerationTool$inboundSchema; - ImageGenerationTool$2.outboundSchema = exports.ImageGenerationTool$outboundSchema; - })(ImageGenerationTool$ || (exports.ImageGenerationTool$ = ImageGenerationTool$ = {})); - function imageGenerationToolToJSON(imageGenerationTool) { - return JSON.stringify(exports.ImageGenerationTool$outboundSchema.parse(imageGenerationTool)); - } - function imageGenerationToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageGenerationTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageGenerationTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js - var require_websearchpremiumtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchpremiumtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchPremiumTool$ = exports.WebSearchPremiumTool$outboundSchema = exports.WebSearchPremiumTool$inboundSchema = exports.WebSearchPremiumToolType$ = exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema = exports.WebSearchPremiumToolType = void 0; - exports.webSearchPremiumToolToJSON = webSearchPremiumToolToJSON; - exports.webSearchPremiumToolFromJSON = webSearchPremiumToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchPremiumToolType = { - WebSearchPremium: "web_search_premium" - }; - exports.WebSearchPremiumToolType$inboundSchema = z.nativeEnum(exports.WebSearchPremiumToolType); - exports.WebSearchPremiumToolType$outboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - var WebSearchPremiumToolType$; - (function(WebSearchPremiumToolType$2) { - WebSearchPremiumToolType$2.inboundSchema = exports.WebSearchPremiumToolType$inboundSchema; - WebSearchPremiumToolType$2.outboundSchema = exports.WebSearchPremiumToolType$outboundSchema; - })(WebSearchPremiumToolType$ || (exports.WebSearchPremiumToolType$ = WebSearchPremiumToolType$ = {})); - exports.WebSearchPremiumTool$inboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$inboundSchema.default("web_search_premium") - }); - exports.WebSearchPremiumTool$outboundSchema = z.object({ - type: exports.WebSearchPremiumToolType$outboundSchema.default("web_search_premium") - }); - var WebSearchPremiumTool$; - (function(WebSearchPremiumTool$2) { - WebSearchPremiumTool$2.inboundSchema = exports.WebSearchPremiumTool$inboundSchema; - WebSearchPremiumTool$2.outboundSchema = exports.WebSearchPremiumTool$outboundSchema; - })(WebSearchPremiumTool$ || (exports.WebSearchPremiumTool$ = WebSearchPremiumTool$ = {})); - function webSearchPremiumToolToJSON(webSearchPremiumTool) { - return JSON.stringify(exports.WebSearchPremiumTool$outboundSchema.parse(webSearchPremiumTool)); - } - function webSearchPremiumToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchPremiumTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchPremiumTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/websearchtool.js - var require_websearchtool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/websearchtool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WebSearchTool$ = exports.WebSearchTool$outboundSchema = exports.WebSearchTool$inboundSchema = exports.WebSearchToolType$ = exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema = exports.WebSearchToolType = void 0; - exports.webSearchToolToJSON = webSearchToolToJSON; - exports.webSearchToolFromJSON = webSearchToolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.WebSearchToolType = { - WebSearch: "web_search" - }; - exports.WebSearchToolType$inboundSchema = z.nativeEnum(exports.WebSearchToolType); - exports.WebSearchToolType$outboundSchema = exports.WebSearchToolType$inboundSchema; - var WebSearchToolType$; - (function(WebSearchToolType$2) { - WebSearchToolType$2.inboundSchema = exports.WebSearchToolType$inboundSchema; - WebSearchToolType$2.outboundSchema = exports.WebSearchToolType$outboundSchema; - })(WebSearchToolType$ || (exports.WebSearchToolType$ = WebSearchToolType$ = {})); - exports.WebSearchTool$inboundSchema = z.object({ - type: exports.WebSearchToolType$inboundSchema.default("web_search") - }); - exports.WebSearchTool$outboundSchema = z.object({ - type: exports.WebSearchToolType$outboundSchema.default("web_search") - }); - var WebSearchTool$; - (function(WebSearchTool$2) { - WebSearchTool$2.inboundSchema = exports.WebSearchTool$inboundSchema; - WebSearchTool$2.outboundSchema = exports.WebSearchTool$outboundSchema; - })(WebSearchTool$ || (exports.WebSearchTool$ = WebSearchTool$ = {})); - function webSearchToolToJSON(webSearchTool) { - return JSON.stringify(exports.WebSearchTool$outboundSchema.parse(webSearchTool)); - } - function webSearchToolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WebSearchTool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WebSearchTool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agent.js - var require_agent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agent$ = exports.Agent$outboundSchema = exports.Agent$inboundSchema = exports.AgentObject$ = exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema = exports.AgentTools$ = exports.AgentTools$outboundSchema = exports.AgentTools$inboundSchema = exports.AgentObject = void 0; - exports.agentToolsToJSON = agentToolsToJSON; - exports.agentToolsFromJSON = agentToolsFromJSON; - exports.agentToJSON = agentToJSON; - exports.agentFromJSON = agentFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentObject = { - Agent: "agent" - }; - exports.AgentTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentTools$; - (function(AgentTools$2) { - AgentTools$2.inboundSchema = exports.AgentTools$inboundSchema; - AgentTools$2.outboundSchema = exports.AgentTools$outboundSchema; - })(AgentTools$ || (exports.AgentTools$ = AgentTools$ = {})); - function agentToolsToJSON(agentTools) { - return JSON.stringify(exports.AgentTools$outboundSchema.parse(agentTools)); - } - function agentToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentTools' from JSON`); - } - exports.AgentObject$inboundSchema = z.nativeEnum(exports.AgentObject); - exports.AgentObject$outboundSchema = exports.AgentObject$inboundSchema; - var AgentObject$; - (function(AgentObject$2) { - AgentObject$2.inboundSchema = exports.AgentObject$inboundSchema; - AgentObject$2.outboundSchema = exports.AgentObject$outboundSchema; - })(AgentObject$ || (exports.AgentObject$ = AgentObject$ = {})); - exports.Agent$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$inboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.Agent$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: exports.AgentObject$outboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var Agent$; - (function(Agent$2) { - Agent$2.inboundSchema = exports.Agent$inboundSchema; - Agent$2.outboundSchema = exports.Agent$outboundSchema; - })(Agent$ || (exports.Agent$ = Agent$ = {})); - function agentToJSON(agent) { - return JSON.stringify(exports.Agent$outboundSchema.parse(agent)); - } - function agentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Agent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Agent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentconversation.js - var require_agentconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentConversation$ = exports.AgentConversation$outboundSchema = exports.AgentConversation$inboundSchema = exports.AgentConversationObject$ = exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema = exports.AgentConversationObject = void 0; - exports.agentConversationToJSON = agentConversationToJSON; - exports.agentConversationFromJSON = agentConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentConversationObject = { - Conversation: "conversation" - }; - exports.AgentConversationObject$inboundSchema = z.nativeEnum(exports.AgentConversationObject); - exports.AgentConversationObject$outboundSchema = exports.AgentConversationObject$inboundSchema; - var AgentConversationObject$; - (function(AgentConversationObject$2) { - AgentConversationObject$2.inboundSchema = exports.AgentConversationObject$inboundSchema; - AgentConversationObject$2.outboundSchema = exports.AgentConversationObject$outboundSchema; - })(AgentConversationObject$ || (exports.AgentConversationObject$ = AgentConversationObject$ = {})); - exports.AgentConversation$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "agent_id": "agentId" - }); - }); - exports.AgentConversation$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.AgentConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - agentId: "agent_id" - }); - }); - var AgentConversation$; - (function(AgentConversation$2) { - AgentConversation$2.inboundSchema = exports.AgentConversation$inboundSchema; - AgentConversation$2.outboundSchema = exports.AgentConversation$outboundSchema; - })(AgentConversation$ || (exports.AgentConversation$ = AgentConversation$ = {})); - function agentConversationToJSON(agentConversation) { - return JSON.stringify(exports.AgentConversation$outboundSchema.parse(agentConversation)); - } - function agentConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js - var require_agentcreationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentcreationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentCreationRequest$ = exports.AgentCreationRequest$outboundSchema = exports.AgentCreationRequest$inboundSchema = exports.AgentCreationRequestTools$ = exports.AgentCreationRequestTools$outboundSchema = exports.AgentCreationRequestTools$inboundSchema = void 0; - exports.agentCreationRequestToolsToJSON = agentCreationRequestToolsToJSON; - exports.agentCreationRequestToolsFromJSON = agentCreationRequestToolsFromJSON; - exports.agentCreationRequestToJSON = agentCreationRequestToJSON; - exports.agentCreationRequestFromJSON = agentCreationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentCreationRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentCreationRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentCreationRequestTools$; - (function(AgentCreationRequestTools$2) { - AgentCreationRequestTools$2.inboundSchema = exports.AgentCreationRequestTools$inboundSchema; - AgentCreationRequestTools$2.outboundSchema = exports.AgentCreationRequestTools$outboundSchema; - })(AgentCreationRequestTools$ || (exports.AgentCreationRequestTools$ = AgentCreationRequestTools$ = {})); - function agentCreationRequestToolsToJSON(agentCreationRequestTools) { - return JSON.stringify(exports.AgentCreationRequestTools$outboundSchema.parse(agentCreationRequestTools)); - } - function agentCreationRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequestTools' from JSON`); - } - exports.AgentCreationRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentCreationRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentCreationRequest$; - (function(AgentCreationRequest$2) { - AgentCreationRequest$2.inboundSchema = exports.AgentCreationRequest$inboundSchema; - AgentCreationRequest$2.outboundSchema = exports.AgentCreationRequest$outboundSchema; - })(AgentCreationRequest$ || (exports.AgentCreationRequest$ = AgentCreationRequest$ = {})); - function agentCreationRequestToJSON(agentCreationRequest) { - return JSON.stringify(exports.AgentCreationRequest$outboundSchema.parse(agentCreationRequest)); - } - function agentCreationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentCreationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentCreationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js - var require_agenthandoffdoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffdoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffDoneEvent$ = exports.AgentHandoffDoneEvent$outboundSchema = exports.AgentHandoffDoneEvent$inboundSchema = exports.AgentHandoffDoneEventType$ = exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema = exports.AgentHandoffDoneEventType = void 0; - exports.agentHandoffDoneEventToJSON = agentHandoffDoneEventToJSON; - exports.agentHandoffDoneEventFromJSON = agentHandoffDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffDoneEventType = { - AgentHandoffDone: "agent.handoff.done" - }; - exports.AgentHandoffDoneEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffDoneEventType); - exports.AgentHandoffDoneEventType$outboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - var AgentHandoffDoneEventType$; - (function(AgentHandoffDoneEventType$2) { - AgentHandoffDoneEventType$2.inboundSchema = exports.AgentHandoffDoneEventType$inboundSchema; - AgentHandoffDoneEventType$2.outboundSchema = exports.AgentHandoffDoneEventType$outboundSchema; - })(AgentHandoffDoneEventType$ || (exports.AgentHandoffDoneEventType$ = AgentHandoffDoneEventType$ = {})); - exports.AgentHandoffDoneEvent$inboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$inboundSchema.default("agent.handoff.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffDoneEvent$outboundSchema = z.object({ - type: exports.AgentHandoffDoneEventType$outboundSchema.default("agent.handoff.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffDoneEvent$; - (function(AgentHandoffDoneEvent$2) { - AgentHandoffDoneEvent$2.inboundSchema = exports.AgentHandoffDoneEvent$inboundSchema; - AgentHandoffDoneEvent$2.outboundSchema = exports.AgentHandoffDoneEvent$outboundSchema; - })(AgentHandoffDoneEvent$ || (exports.AgentHandoffDoneEvent$ = AgentHandoffDoneEvent$ = {})); - function agentHandoffDoneEventToJSON(agentHandoffDoneEvent) { - return JSON.stringify(exports.AgentHandoffDoneEvent$outboundSchema.parse(agentHandoffDoneEvent)); - } - function agentHandoffDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js - var require_agenthandoffentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffEntry$ = exports.AgentHandoffEntry$outboundSchema = exports.AgentHandoffEntry$inboundSchema = exports.AgentHandoffEntryType$ = exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema = exports.AgentHandoffEntryObject$ = exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema = exports.AgentHandoffEntryType = exports.AgentHandoffEntryObject = void 0; - exports.agentHandoffEntryToJSON = agentHandoffEntryToJSON; - exports.agentHandoffEntryFromJSON = agentHandoffEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffEntryObject = { - Entry: "entry" - }; - exports.AgentHandoffEntryType = { - AgentHandoff: "agent.handoff" - }; - exports.AgentHandoffEntryObject$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryObject); - exports.AgentHandoffEntryObject$outboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - var AgentHandoffEntryObject$; - (function(AgentHandoffEntryObject$2) { - AgentHandoffEntryObject$2.inboundSchema = exports.AgentHandoffEntryObject$inboundSchema; - AgentHandoffEntryObject$2.outboundSchema = exports.AgentHandoffEntryObject$outboundSchema; - })(AgentHandoffEntryObject$ || (exports.AgentHandoffEntryObject$ = AgentHandoffEntryObject$ = {})); - exports.AgentHandoffEntryType$inboundSchema = z.nativeEnum(exports.AgentHandoffEntryType); - exports.AgentHandoffEntryType$outboundSchema = exports.AgentHandoffEntryType$inboundSchema; - var AgentHandoffEntryType$; - (function(AgentHandoffEntryType$2) { - AgentHandoffEntryType$2.inboundSchema = exports.AgentHandoffEntryType$inboundSchema; - AgentHandoffEntryType$2.outboundSchema = exports.AgentHandoffEntryType$outboundSchema; - })(AgentHandoffEntryType$ || (exports.AgentHandoffEntryType$ = AgentHandoffEntryType$ = {})); - exports.AgentHandoffEntry$inboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$inboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$inboundSchema.default("agent.handoff"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - previous_agent_id: z.string(), - previous_agent_name: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName" - }); - }); - exports.AgentHandoffEntry$outboundSchema = z.object({ - object: exports.AgentHandoffEntryObject$outboundSchema.default("entry"), - type: exports.AgentHandoffEntryType$outboundSchema.default("agent.handoff"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - previousAgentId: z.string(), - previousAgentName: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name" - }); - }); - var AgentHandoffEntry$; - (function(AgentHandoffEntry$2) { - AgentHandoffEntry$2.inboundSchema = exports.AgentHandoffEntry$inboundSchema; - AgentHandoffEntry$2.outboundSchema = exports.AgentHandoffEntry$outboundSchema; - })(AgentHandoffEntry$ || (exports.AgentHandoffEntry$ = AgentHandoffEntry$ = {})); - function agentHandoffEntryToJSON(agentHandoffEntry) { - return JSON.stringify(exports.AgentHandoffEntry$outboundSchema.parse(agentHandoffEntry)); - } - function agentHandoffEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js - var require_agenthandoffstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agenthandoffstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentHandoffStartedEvent$ = exports.AgentHandoffStartedEvent$outboundSchema = exports.AgentHandoffStartedEvent$inboundSchema = exports.AgentHandoffStartedEventType$ = exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema = exports.AgentHandoffStartedEventType = void 0; - exports.agentHandoffStartedEventToJSON = agentHandoffStartedEventToJSON; - exports.agentHandoffStartedEventFromJSON = agentHandoffStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentHandoffStartedEventType = { - AgentHandoffStarted: "agent.handoff.started" - }; - exports.AgentHandoffStartedEventType$inboundSchema = z.nativeEnum(exports.AgentHandoffStartedEventType); - exports.AgentHandoffStartedEventType$outboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - var AgentHandoffStartedEventType$; - (function(AgentHandoffStartedEventType$2) { - AgentHandoffStartedEventType$2.inboundSchema = exports.AgentHandoffStartedEventType$inboundSchema; - AgentHandoffStartedEventType$2.outboundSchema = exports.AgentHandoffStartedEventType$outboundSchema; - })(AgentHandoffStartedEventType$ || (exports.AgentHandoffStartedEventType$ = AgentHandoffStartedEventType$ = {})); - exports.AgentHandoffStartedEvent$inboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$inboundSchema.default("agent.handoff.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - previous_agent_id: z.string(), - previous_agent_name: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName" - }); - }); - exports.AgentHandoffStartedEvent$outboundSchema = z.object({ - type: exports.AgentHandoffStartedEventType$outboundSchema.default("agent.handoff.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - previousAgentId: z.string(), - previousAgentName: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name" - }); - }); - var AgentHandoffStartedEvent$; - (function(AgentHandoffStartedEvent$2) { - AgentHandoffStartedEvent$2.inboundSchema = exports.AgentHandoffStartedEvent$inboundSchema; - AgentHandoffStartedEvent$2.outboundSchema = exports.AgentHandoffStartedEvent$outboundSchema; - })(AgentHandoffStartedEvent$ || (exports.AgentHandoffStartedEvent$ = AgentHandoffStartedEvent$ = {})); - function agentHandoffStartedEventToJSON(agentHandoffStartedEvent) { - return JSON.stringify(exports.AgentHandoffStartedEvent$outboundSchema.parse(agentHandoffStartedEvent)); - } - function agentHandoffStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentHandoffStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentHandoffStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiochunk.js - var require_audiochunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiochunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioChunk$ = exports.AudioChunk$outboundSchema = exports.AudioChunk$inboundSchema = exports.AudioChunkType$ = exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema = exports.AudioChunkType = void 0; - exports.audioChunkToJSON = audioChunkToJSON; - exports.audioChunkFromJSON = audioChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AudioChunkType = { - InputAudio: "input_audio" - }; - exports.AudioChunkType$inboundSchema = z.nativeEnum(exports.AudioChunkType); - exports.AudioChunkType$outboundSchema = exports.AudioChunkType$inboundSchema; - var AudioChunkType$; - (function(AudioChunkType$2) { - AudioChunkType$2.inboundSchema = exports.AudioChunkType$inboundSchema; - AudioChunkType$2.outboundSchema = exports.AudioChunkType$outboundSchema; - })(AudioChunkType$ || (exports.AudioChunkType$ = AudioChunkType$ = {})); - exports.AudioChunk$inboundSchema = z.object({ - input_audio: z.string(), - type: exports.AudioChunkType$inboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_audio": "inputAudio" - }); - }); - exports.AudioChunk$outboundSchema = z.object({ - inputAudio: z.string(), - type: exports.AudioChunkType$outboundSchema.default("input_audio") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputAudio: "input_audio" - }); - }); - var AudioChunk$; - (function(AudioChunk$2) { - AudioChunk$2.inboundSchema = exports.AudioChunk$inboundSchema; - AudioChunk$2.outboundSchema = exports.AudioChunk$outboundSchema; - })(AudioChunk$ || (exports.AudioChunk$ = AudioChunk$ = {})); - function audioChunkToJSON(audioChunk) { - return JSON.stringify(exports.AudioChunk$outboundSchema.parse(audioChunk)); - } - function audioChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenturlchunk.js - var require_documenturlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenturlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentURLChunk$ = exports.DocumentURLChunk$outboundSchema = exports.DocumentURLChunk$inboundSchema = exports.DocumentURLChunkType$ = exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema = exports.DocumentURLChunkType = void 0; - exports.documentURLChunkToJSON = documentURLChunkToJSON; - exports.documentURLChunkFromJSON = documentURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentURLChunkType = { - DocumentUrl: "document_url" - }; - exports.DocumentURLChunkType$inboundSchema = z.nativeEnum(exports.DocumentURLChunkType); - exports.DocumentURLChunkType$outboundSchema = exports.DocumentURLChunkType$inboundSchema; - var DocumentURLChunkType$; - (function(DocumentURLChunkType$2) { - DocumentURLChunkType$2.inboundSchema = exports.DocumentURLChunkType$inboundSchema; - DocumentURLChunkType$2.outboundSchema = exports.DocumentURLChunkType$outboundSchema; - })(DocumentURLChunkType$ || (exports.DocumentURLChunkType$ = DocumentURLChunkType$ = {})); - exports.DocumentURLChunk$inboundSchema = z.object({ - document_url: z.string(), - document_name: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$inboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_url": "documentUrl", - "document_name": "documentName" - }); - }); - exports.DocumentURLChunk$outboundSchema = z.object({ - documentUrl: z.string(), - documentName: z.nullable(z.string()).optional(), - type: exports.DocumentURLChunkType$outboundSchema.default("document_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentUrl: "document_url", - documentName: "document_name" - }); - }); - var DocumentURLChunk$; - (function(DocumentURLChunk$2) { - DocumentURLChunk$2.inboundSchema = exports.DocumentURLChunk$inboundSchema; - DocumentURLChunk$2.outboundSchema = exports.DocumentURLChunk$outboundSchema; - })(DocumentURLChunk$ || (exports.DocumentURLChunk$ = DocumentURLChunk$ = {})); - function documentURLChunkToJSON(documentURLChunk) { - return JSON.stringify(exports.DocumentURLChunk$outboundSchema.parse(documentURLChunk)); - } - function documentURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filechunk.js - var require_filechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileChunk$ = exports.FileChunk$outboundSchema = exports.FileChunk$inboundSchema = void 0; - exports.fileChunkToJSON = fileChunkToJSON; - exports.fileChunkFromJSON = fileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FileChunk$inboundSchema = z.object({ - type: z.literal("file").default("file"), - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FileChunk$outboundSchema = z.object({ - type: z.literal("file").default("file"), - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FileChunk$; - (function(FileChunk$2) { - FileChunk$2.inboundSchema = exports.FileChunk$inboundSchema; - FileChunk$2.outboundSchema = exports.FileChunk$outboundSchema; - })(FileChunk$ || (exports.FileChunk$ = FileChunk$ = {})); - function fileChunkToJSON(fileChunk) { - return JSON.stringify(exports.FileChunk$outboundSchema.parse(fileChunk)); - } - function fileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurl.js - var require_imageurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURL$ = exports.ImageURL$outboundSchema = exports.ImageURL$inboundSchema = void 0; - exports.imageURLToJSON = imageURLToJSON; - exports.imageURLFromJSON = imageURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ImageURL$inboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - exports.ImageURL$outboundSchema = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional() - }); - var ImageURL$; - (function(ImageURL$2) { - ImageURL$2.inboundSchema = exports.ImageURL$inboundSchema; - ImageURL$2.outboundSchema = exports.ImageURL$outboundSchema; - })(ImageURL$ || (exports.ImageURL$ = ImageURL$ = {})); - function imageURLToJSON(imageURL) { - return JSON.stringify(exports.ImageURL$outboundSchema.parse(imageURL)); - } - function imageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/imageurlchunk.js - var require_imageurlchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/imageurlchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ImageURLChunk$ = exports.ImageURLChunk$outboundSchema = exports.ImageURLChunk$inboundSchema = exports.ImageURLChunkType$ = exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema = exports.ImageURLChunkImageURL$ = exports.ImageURLChunkImageURL$outboundSchema = exports.ImageURLChunkImageURL$inboundSchema = exports.ImageURLChunkType = void 0; - exports.imageURLChunkImageURLToJSON = imageURLChunkImageURLToJSON; - exports.imageURLChunkImageURLFromJSON = imageURLChunkImageURLFromJSON; - exports.imageURLChunkToJSON = imageURLChunkToJSON; - exports.imageURLChunkFromJSON = imageURLChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var imageurl_js_1 = require_imageurl(); - exports.ImageURLChunkType = { - ImageUrl: "image_url" - }; - exports.ImageURLChunkImageURL$inboundSchema = z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]); - exports.ImageURLChunkImageURL$outboundSchema = z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]); - var ImageURLChunkImageURL$; - (function(ImageURLChunkImageURL$2) { - ImageURLChunkImageURL$2.inboundSchema = exports.ImageURLChunkImageURL$inboundSchema; - ImageURLChunkImageURL$2.outboundSchema = exports.ImageURLChunkImageURL$outboundSchema; - })(ImageURLChunkImageURL$ || (exports.ImageURLChunkImageURL$ = ImageURLChunkImageURL$ = {})); - function imageURLChunkImageURLToJSON(imageURLChunkImageURL) { - return JSON.stringify(exports.ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL)); - } - function imageURLChunkImageURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunkImageURL' from JSON`); - } - exports.ImageURLChunkType$inboundSchema = z.nativeEnum(exports.ImageURLChunkType); - exports.ImageURLChunkType$outboundSchema = exports.ImageURLChunkType$inboundSchema; - var ImageURLChunkType$; - (function(ImageURLChunkType$2) { - ImageURLChunkType$2.inboundSchema = exports.ImageURLChunkType$inboundSchema; - ImageURLChunkType$2.outboundSchema = exports.ImageURLChunkType$outboundSchema; - })(ImageURLChunkType$ || (exports.ImageURLChunkType$ = ImageURLChunkType$ = {})); - exports.ImageURLChunk$inboundSchema = z.object({ - image_url: z.union([imageurl_js_1.ImageURL$inboundSchema, z.string()]), - type: exports.ImageURLChunkType$inboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "image_url": "imageUrl" - }); - }); - exports.ImageURLChunk$outboundSchema = z.object({ - imageUrl: z.union([imageurl_js_1.ImageURL$outboundSchema, z.string()]), - type: exports.ImageURLChunkType$outboundSchema.default("image_url") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - imageUrl: "image_url" - }); - }); - var ImageURLChunk$; - (function(ImageURLChunk$2) { - ImageURLChunk$2.inboundSchema = exports.ImageURLChunk$inboundSchema; - ImageURLChunk$2.outboundSchema = exports.ImageURLChunk$outboundSchema; - })(ImageURLChunk$ || (exports.ImageURLChunk$ = ImageURLChunk$ = {})); - function imageURLChunkToJSON(imageURLChunk) { - return JSON.stringify(exports.ImageURLChunk$outboundSchema.parse(imageURLChunk)); - } - function imageURLChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ImageURLChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ImageURLChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/referencechunk.js - var require_referencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/referencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ReferenceChunk$ = exports.ReferenceChunk$outboundSchema = exports.ReferenceChunk$inboundSchema = exports.ReferenceChunkType$ = exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema = exports.ReferenceChunkType = void 0; - exports.referenceChunkToJSON = referenceChunkToJSON; - exports.referenceChunkFromJSON = referenceChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ReferenceChunkType = { - Reference: "reference" - }; - exports.ReferenceChunkType$inboundSchema = z.nativeEnum(exports.ReferenceChunkType); - exports.ReferenceChunkType$outboundSchema = exports.ReferenceChunkType$inboundSchema; - var ReferenceChunkType$; - (function(ReferenceChunkType$2) { - ReferenceChunkType$2.inboundSchema = exports.ReferenceChunkType$inboundSchema; - ReferenceChunkType$2.outboundSchema = exports.ReferenceChunkType$outboundSchema; - })(ReferenceChunkType$ || (exports.ReferenceChunkType$ = ReferenceChunkType$ = {})); - exports.ReferenceChunk$inboundSchema = z.object({ - reference_ids: z.array(z.number().int()), - type: exports.ReferenceChunkType$inboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "reference_ids": "referenceIds" - }); - }); - exports.ReferenceChunk$outboundSchema = z.object({ - referenceIds: z.array(z.number().int()), - type: exports.ReferenceChunkType$outboundSchema.default("reference") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - referenceIds: "reference_ids" - }); - }); - var ReferenceChunk$; - (function(ReferenceChunk$2) { - ReferenceChunk$2.inboundSchema = exports.ReferenceChunk$inboundSchema; - ReferenceChunk$2.outboundSchema = exports.ReferenceChunk$outboundSchema; - })(ReferenceChunk$ || (exports.ReferenceChunk$ = ReferenceChunk$ = {})); - function referenceChunkToJSON(referenceChunk) { - return JSON.stringify(exports.ReferenceChunk$outboundSchema.parse(referenceChunk)); - } - function referenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/textchunk.js - var require_textchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/textchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TextChunk$ = exports.TextChunk$outboundSchema = exports.TextChunk$inboundSchema = exports.TextChunkType$ = exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema = exports.TextChunkType = void 0; - exports.textChunkToJSON = textChunkToJSON; - exports.textChunkFromJSON = textChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.TextChunkType = { - Text: "text" - }; - exports.TextChunkType$inboundSchema = z.nativeEnum(exports.TextChunkType); - exports.TextChunkType$outboundSchema = exports.TextChunkType$inboundSchema; - var TextChunkType$; - (function(TextChunkType$2) { - TextChunkType$2.inboundSchema = exports.TextChunkType$inboundSchema; - TextChunkType$2.outboundSchema = exports.TextChunkType$outboundSchema; - })(TextChunkType$ || (exports.TextChunkType$ = TextChunkType$ = {})); - exports.TextChunk$inboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$inboundSchema.default("text") - }); - exports.TextChunk$outboundSchema = z.object({ - text: z.string(), - type: exports.TextChunkType$outboundSchema.default("text") - }); - var TextChunk$; - (function(TextChunk$2) { - TextChunk$2.inboundSchema = exports.TextChunk$inboundSchema; - TextChunk$2.outboundSchema = exports.TextChunk$outboundSchema; - })(TextChunk$ || (exports.TextChunk$ = TextChunk$ = {})); - function textChunkToJSON(textChunk) { - return JSON.stringify(exports.TextChunk$outboundSchema.parse(textChunk)); - } - function textChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TextChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TextChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/thinkchunk.js - var require_thinkchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/thinkchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ThinkChunk$ = exports.ThinkChunk$outboundSchema = exports.ThinkChunk$inboundSchema = exports.ThinkChunkType$ = exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema = exports.Thinking$ = exports.Thinking$outboundSchema = exports.Thinking$inboundSchema = exports.ThinkChunkType = void 0; - exports.thinkingToJSON = thinkingToJSON; - exports.thinkingFromJSON = thinkingFromJSON; - exports.thinkChunkToJSON = thinkChunkToJSON; - exports.thinkChunkFromJSON = thinkChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - exports.ThinkChunkType = { - Thinking: "thinking" - }; - exports.Thinking$inboundSchema = z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema]); - exports.Thinking$outboundSchema = z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema]); - var Thinking$; - (function(Thinking$2) { - Thinking$2.inboundSchema = exports.Thinking$inboundSchema; - Thinking$2.outboundSchema = exports.Thinking$outboundSchema; - })(Thinking$ || (exports.Thinking$ = Thinking$ = {})); - function thinkingToJSON(thinking) { - return JSON.stringify(exports.Thinking$outboundSchema.parse(thinking)); - } - function thinkingFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Thinking$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Thinking' from JSON`); - } - exports.ThinkChunkType$inboundSchema = z.nativeEnum(exports.ThinkChunkType); - exports.ThinkChunkType$outboundSchema = exports.ThinkChunkType$inboundSchema; - var ThinkChunkType$; - (function(ThinkChunkType$2) { - ThinkChunkType$2.inboundSchema = exports.ThinkChunkType$inboundSchema; - ThinkChunkType$2.outboundSchema = exports.ThinkChunkType$outboundSchema; - })(ThinkChunkType$ || (exports.ThinkChunkType$ = ThinkChunkType$ = {})); - exports.ThinkChunk$inboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$inboundSchema, textchunk_js_1.TextChunk$inboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$inboundSchema.default("thinking") - }); - exports.ThinkChunk$outboundSchema = z.object({ - thinking: z.array(z.union([referencechunk_js_1.ReferenceChunk$outboundSchema, textchunk_js_1.TextChunk$outboundSchema])), - closed: z.boolean().optional(), - type: exports.ThinkChunkType$outboundSchema.default("thinking") - }); - var ThinkChunk$; - (function(ThinkChunk$2) { - ThinkChunk$2.inboundSchema = exports.ThinkChunk$inboundSchema; - ThinkChunk$2.outboundSchema = exports.ThinkChunk$outboundSchema; - })(ThinkChunk$ || (exports.ThinkChunk$ = ThinkChunk$ = {})); - function thinkChunkToJSON(thinkChunk) { - return JSON.stringify(exports.ThinkChunk$outboundSchema.parse(thinkChunk)); - } - function thinkChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ThinkChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ThinkChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/contentchunk.js - var require_contentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/contentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ContentChunk$ = exports.ContentChunk$outboundSchema = exports.ContentChunk$inboundSchema = void 0; - exports.contentChunkToJSON = contentChunkToJSON; - exports.contentChunkFromJSON = contentChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var audiochunk_js_1 = require_audiochunk(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var referencechunk_js_1 = require_referencechunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.ContentChunk$inboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$inboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$inboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$inboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$inboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$inboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ContentChunk$outboundSchema = z.union([ - imageurlchunk_js_1.ImageURLChunk$outboundSchema.and(z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type - }))), - documenturlchunk_js_1.DocumentURLChunk$outboundSchema.and(z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type - }))), - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - referencechunk_js_1.ReferenceChunk$outboundSchema.and(z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type - }))), - filechunk_js_1.FileChunk$outboundSchema.and(z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))), - audiochunk_js_1.AudioChunk$outboundSchema.and(z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type - }))) - ]); - var ContentChunk$; - (function(ContentChunk$2) { - ContentChunk$2.inboundSchema = exports.ContentChunk$inboundSchema; - ContentChunk$2.outboundSchema = exports.ContentChunk$outboundSchema; - })(ContentChunk$ || (exports.ContentChunk$ = ContentChunk$ = {})); - function contentChunkToJSON(contentChunk) { - return JSON.stringify(exports.ContentChunk$outboundSchema.parse(contentChunk)); - } - function contentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ContentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ContentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncall.js - var require_functioncall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCall$ = exports.FunctionCall$outboundSchema = exports.FunctionCall$inboundSchema = exports.Arguments$ = exports.Arguments$outboundSchema = exports.Arguments$inboundSchema = void 0; - exports.argumentsToJSON = argumentsToJSON; - exports.argumentsFromJSON = argumentsFromJSON; - exports.functionCallToJSON = functionCallToJSON; - exports.functionCallFromJSON = functionCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Arguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.Arguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var Arguments$; - (function(Arguments$2) { - Arguments$2.inboundSchema = exports.Arguments$inboundSchema; - Arguments$2.outboundSchema = exports.Arguments$outboundSchema; - })(Arguments$ || (exports.Arguments$ = Arguments$ = {})); - function argumentsToJSON(value) { - return JSON.stringify(exports.Arguments$outboundSchema.parse(value)); - } - function argumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Arguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Arguments' from JSON`); - } - exports.FunctionCall$inboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - exports.FunctionCall$outboundSchema = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]) - }); - var FunctionCall$; - (function(FunctionCall$2) { - FunctionCall$2.inboundSchema = exports.FunctionCall$inboundSchema; - FunctionCall$2.outboundSchema = exports.FunctionCall$outboundSchema; - })(FunctionCall$ || (exports.FunctionCall$ = FunctionCall$ = {})); - function functionCallToJSON(functionCall) { - return JSON.stringify(exports.FunctionCall$outboundSchema.parse(functionCall)); - } - function functionCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/enums.js - var require_enums = __commonJS({ - "node_modules/@mistralai/mistralai/types/enums.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.catchUnrecognizedEnum = catchUnrecognizedEnum; - function catchUnrecognizedEnum(value) { - return value; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tooltypes.js - var require_tooltypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tooltypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolTypes$ = exports.ToolTypes$outboundSchema = exports.ToolTypes$inboundSchema = exports.ToolTypes = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ToolTypes = { - Function: "function" - }; - exports.ToolTypes$inboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ToolTypes$outboundSchema = z.union([ - z.nativeEnum(exports.ToolTypes), - z.string().and(z.custom()) - ]); - var ToolTypes$; - (function(ToolTypes$2) { - ToolTypes$2.inboundSchema = exports.ToolTypes$inboundSchema; - ToolTypes$2.outboundSchema = exports.ToolTypes$outboundSchema; - })(ToolTypes$ || (exports.ToolTypes$ = ToolTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolcall.js - var require_toolcall = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolcall.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolCall$ = exports.ToolCall$outboundSchema = exports.ToolCall$inboundSchema = void 0; - exports.toolCallToJSON = toolCallToJSON; - exports.toolCallFromJSON = toolCallFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functioncall_js_1 = require_functioncall(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolCall$inboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functioncall_js_1.FunctionCall$inboundSchema, - index: z.number().int().default(0) - }); - exports.ToolCall$outboundSchema = z.object({ - id: z.string().default("null"), - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functioncall_js_1.FunctionCall$outboundSchema, - index: z.number().int().default(0) - }); - var ToolCall$; - (function(ToolCall$2) { - ToolCall$2.inboundSchema = exports.ToolCall$inboundSchema; - ToolCall$2.outboundSchema = exports.ToolCall$outboundSchema; - })(ToolCall$ || (exports.ToolCall$ = ToolCall$ = {})); - function toolCallToJSON(toolCall) { - return JSON.stringify(exports.ToolCall$outboundSchema.parse(toolCall)); - } - function toolCallFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolCall$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolCall' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/assistantmessage.js - var require_assistantmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/assistantmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AssistantMessage$ = exports.AssistantMessage$outboundSchema = exports.AssistantMessage$inboundSchema = exports.AssistantMessageRole$ = exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema = exports.AssistantMessageContent$ = exports.AssistantMessageContent$outboundSchema = exports.AssistantMessageContent$inboundSchema = exports.AssistantMessageRole = void 0; - exports.assistantMessageContentToJSON = assistantMessageContentToJSON; - exports.assistantMessageContentFromJSON = assistantMessageContentFromJSON; - exports.assistantMessageToJSON = assistantMessageToJSON; - exports.assistantMessageFromJSON = assistantMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.AssistantMessageRole = { - Assistant: "assistant" - }; - exports.AssistantMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.AssistantMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var AssistantMessageContent$; - (function(AssistantMessageContent$2) { - AssistantMessageContent$2.inboundSchema = exports.AssistantMessageContent$inboundSchema; - AssistantMessageContent$2.outboundSchema = exports.AssistantMessageContent$outboundSchema; - })(AssistantMessageContent$ || (exports.AssistantMessageContent$ = AssistantMessageContent$ = {})); - function assistantMessageContentToJSON(assistantMessageContent) { - return JSON.stringify(exports.AssistantMessageContent$outboundSchema.parse(assistantMessageContent)); - } - function assistantMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessageContent' from JSON`); - } - exports.AssistantMessageRole$inboundSchema = z.nativeEnum(exports.AssistantMessageRole); - exports.AssistantMessageRole$outboundSchema = exports.AssistantMessageRole$inboundSchema; - var AssistantMessageRole$; - (function(AssistantMessageRole$2) { - AssistantMessageRole$2.inboundSchema = exports.AssistantMessageRole$inboundSchema; - AssistantMessageRole$2.outboundSchema = exports.AssistantMessageRole$outboundSchema; - })(AssistantMessageRole$ || (exports.AssistantMessageRole$ = AssistantMessageRole$ = {})); - exports.AssistantMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$inboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.AssistantMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: exports.AssistantMessageRole$outboundSchema.default("assistant") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var AssistantMessage$; - (function(AssistantMessage$2) { - AssistantMessage$2.inboundSchema = exports.AssistantMessage$inboundSchema; - AssistantMessage$2.outboundSchema = exports.AssistantMessage$outboundSchema; - })(AssistantMessage$ || (exports.AssistantMessage$ = AssistantMessage$ = {})); - function assistantMessageToJSON(assistantMessage) { - return JSON.stringify(exports.AssistantMessage$outboundSchema.parse(assistantMessage)); - } - function assistantMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AssistantMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AssistantMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js - var require_mistralpromptmode = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/mistralpromptmode.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralPromptMode$ = exports.MistralPromptMode$outboundSchema = exports.MistralPromptMode$inboundSchema = exports.MistralPromptMode = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.MistralPromptMode = { - Reasoning: "reasoning" - }; - exports.MistralPromptMode$inboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.MistralPromptMode$outboundSchema = z.union([ - z.nativeEnum(exports.MistralPromptMode), - z.string().and(z.custom()) - ]); - var MistralPromptMode$; - (function(MistralPromptMode$2) { - MistralPromptMode$2.inboundSchema = exports.MistralPromptMode$inboundSchema; - MistralPromptMode$2.outboundSchema = exports.MistralPromptMode$outboundSchema; - })(MistralPromptMode$ || (exports.MistralPromptMode$ = MistralPromptMode$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js - var require_systemmessagecontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessagecontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessageContentChunks$ = exports.SystemMessageContentChunks$outboundSchema = exports.SystemMessageContentChunks$inboundSchema = void 0; - exports.systemMessageContentChunksToJSON = systemMessageContentChunksToJSON; - exports.systemMessageContentChunksFromJSON = systemMessageContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - exports.SystemMessageContentChunks$inboundSchema = z.union([ - textchunk_js_1.TextChunk$inboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$inboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.SystemMessageContentChunks$outboundSchema = z.union([ - textchunk_js_1.TextChunk$outboundSchema.and(z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type }))), - thinkchunk_js_1.ThinkChunk$outboundSchema.and(z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type - }))) - ]); - var SystemMessageContentChunks$; - (function(SystemMessageContentChunks$2) { - SystemMessageContentChunks$2.inboundSchema = exports.SystemMessageContentChunks$inboundSchema; - SystemMessageContentChunks$2.outboundSchema = exports.SystemMessageContentChunks$outboundSchema; - })(SystemMessageContentChunks$ || (exports.SystemMessageContentChunks$ = SystemMessageContentChunks$ = {})); - function systemMessageContentChunksToJSON(systemMessageContentChunks) { - return JSON.stringify(exports.SystemMessageContentChunks$outboundSchema.parse(systemMessageContentChunks)); - } - function systemMessageContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/systemmessage.js - var require_systemmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/systemmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SystemMessage$ = exports.SystemMessage$outboundSchema = exports.SystemMessage$inboundSchema = exports.Role$ = exports.Role$outboundSchema = exports.Role$inboundSchema = exports.SystemMessageContent$ = exports.SystemMessageContent$outboundSchema = exports.SystemMessageContent$inboundSchema = exports.Role = void 0; - exports.systemMessageContentToJSON = systemMessageContentToJSON; - exports.systemMessageContentFromJSON = systemMessageContentFromJSON; - exports.systemMessageToJSON = systemMessageToJSON; - exports.systemMessageFromJSON = systemMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var systemmessagecontentchunks_js_1 = require_systemmessagecontentchunks(); - exports.Role = { - System: "system" - }; - exports.SystemMessageContent$inboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema)]); - exports.SystemMessageContent$outboundSchema = z.union([z.string(), z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema)]); - var SystemMessageContent$; - (function(SystemMessageContent$2) { - SystemMessageContent$2.inboundSchema = exports.SystemMessageContent$inboundSchema; - SystemMessageContent$2.outboundSchema = exports.SystemMessageContent$outboundSchema; - })(SystemMessageContent$ || (exports.SystemMessageContent$ = SystemMessageContent$ = {})); - function systemMessageContentToJSON(systemMessageContent) { - return JSON.stringify(exports.SystemMessageContent$outboundSchema.parse(systemMessageContent)); - } - function systemMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessageContent' from JSON`); - } - exports.Role$inboundSchema = z.nativeEnum(exports.Role); - exports.Role$outboundSchema = exports.Role$inboundSchema; - var Role$; - (function(Role$2) { - Role$2.inboundSchema = exports.Role$inboundSchema; - Role$2.outboundSchema = exports.Role$outboundSchema; - })(Role$ || (exports.Role$ = Role$ = {})); - exports.SystemMessage$inboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$inboundSchema) - ]), - role: exports.Role$inboundSchema.default("system") - }); - exports.SystemMessage$outboundSchema = z.object({ - content: z.union([ - z.string(), - z.array(systemmessagecontentchunks_js_1.SystemMessageContentChunks$outboundSchema) - ]), - role: exports.Role$outboundSchema.default("system") - }); - var SystemMessage$; - (function(SystemMessage$2) { - SystemMessage$2.inboundSchema = exports.SystemMessage$inboundSchema; - SystemMessage$2.outboundSchema = exports.SystemMessage$outboundSchema; - })(SystemMessage$ || (exports.SystemMessage$ = SystemMessage$ = {})); - function systemMessageToJSON(systemMessage) { - return JSON.stringify(exports.SystemMessage$outboundSchema.parse(systemMessage)); - } - function systemMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SystemMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SystemMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/tool.js - var require_tool = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/tool.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Tool$ = exports.Tool$outboundSchema = exports.Tool$inboundSchema = void 0; - exports.toolToJSON = toolToJSON; - exports.toolFromJSON = toolFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var function_js_1 = require_function(); - var tooltypes_js_1 = require_tooltypes(); - exports.Tool$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: function_js_1.FunctionT$inboundSchema - }); - exports.Tool$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: function_js_1.FunctionT$outboundSchema - }); - var Tool$; - (function(Tool$2) { - Tool$2.inboundSchema = exports.Tool$inboundSchema; - Tool$2.outboundSchema = exports.Tool$outboundSchema; - })(Tool$ || (exports.Tool$ = Tool$ = {})); - function toolToJSON(tool) { - return JSON.stringify(exports.Tool$outboundSchema.parse(tool)); - } - function toolFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tool$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tool' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionname.js - var require_functionname = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionname.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionName$ = exports.FunctionName$outboundSchema = exports.FunctionName$inboundSchema = void 0; - exports.functionNameToJSON = functionNameToJSON; - exports.functionNameFromJSON = functionNameFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionName$inboundSchema = z.object({ - name: z.string() - }); - exports.FunctionName$outboundSchema = z.object({ - name: z.string() - }); - var FunctionName$; - (function(FunctionName$2) { - FunctionName$2.inboundSchema = exports.FunctionName$inboundSchema; - FunctionName$2.outboundSchema = exports.FunctionName$outboundSchema; - })(FunctionName$ || (exports.FunctionName$ = FunctionName$ = {})); - function functionNameToJSON(functionName) { - return JSON.stringify(exports.FunctionName$outboundSchema.parse(functionName)); - } - function functionNameFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionName$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionName' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolchoice.js - var require_toolchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolChoice$ = exports.ToolChoice$outboundSchema = exports.ToolChoice$inboundSchema = void 0; - exports.toolChoiceToJSON = toolChoiceToJSON; - exports.toolChoiceFromJSON = toolChoiceFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var functionname_js_1 = require_functionname(); - var tooltypes_js_1 = require_tooltypes(); - exports.ToolChoice$inboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$inboundSchema.optional(), - function: functionname_js_1.FunctionName$inboundSchema - }); - exports.ToolChoice$outboundSchema = z.object({ - type: tooltypes_js_1.ToolTypes$outboundSchema.optional(), - function: functionname_js_1.FunctionName$outboundSchema - }); - var ToolChoice$; - (function(ToolChoice$2) { - ToolChoice$2.inboundSchema = exports.ToolChoice$inboundSchema; - ToolChoice$2.outboundSchema = exports.ToolChoice$outboundSchema; - })(ToolChoice$ || (exports.ToolChoice$ = ToolChoice$ = {})); - function toolChoiceToJSON(toolChoice) { - return JSON.stringify(exports.ToolChoice$outboundSchema.parse(toolChoice)); - } - function toolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolmessage.js - var require_toolmessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolmessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolMessage$ = exports.ToolMessage$outboundSchema = exports.ToolMessage$inboundSchema = exports.ToolMessageRole$ = exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema = exports.ToolMessageContent$ = exports.ToolMessageContent$outboundSchema = exports.ToolMessageContent$inboundSchema = exports.ToolMessageRole = void 0; - exports.toolMessageContentToJSON = toolMessageContentToJSON; - exports.toolMessageContentFromJSON = toolMessageContentFromJSON; - exports.toolMessageToJSON = toolMessageToJSON; - exports.toolMessageFromJSON = toolMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.ToolMessageRole = { - Tool: "tool" - }; - exports.ToolMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.ToolMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var ToolMessageContent$; - (function(ToolMessageContent$2) { - ToolMessageContent$2.inboundSchema = exports.ToolMessageContent$inboundSchema; - ToolMessageContent$2.outboundSchema = exports.ToolMessageContent$outboundSchema; - })(ToolMessageContent$ || (exports.ToolMessageContent$ = ToolMessageContent$ = {})); - function toolMessageContentToJSON(toolMessageContent) { - return JSON.stringify(exports.ToolMessageContent$outboundSchema.parse(toolMessageContent)); - } - function toolMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessageContent' from JSON`); - } - exports.ToolMessageRole$inboundSchema = z.nativeEnum(exports.ToolMessageRole); - exports.ToolMessageRole$outboundSchema = exports.ToolMessageRole$inboundSchema; - var ToolMessageRole$; - (function(ToolMessageRole$2) { - ToolMessageRole$2.inboundSchema = exports.ToolMessageRole$inboundSchema; - ToolMessageRole$2.outboundSchema = exports.ToolMessageRole$outboundSchema; - })(ToolMessageRole$ || (exports.ToolMessageRole$ = ToolMessageRole$ = {})); - exports.ToolMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$inboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_call_id": "toolCallId" - }); - }); - exports.ToolMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: exports.ToolMessageRole$outboundSchema.default("tool") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCallId: "tool_call_id" - }); - }); - var ToolMessage$; - (function(ToolMessage$2) { - ToolMessage$2.inboundSchema = exports.ToolMessage$inboundSchema; - ToolMessage$2.outboundSchema = exports.ToolMessage$outboundSchema; - })(ToolMessage$ || (exports.ToolMessage$ = ToolMessage$ = {})); - function toolMessageToJSON(toolMessage) { - return JSON.stringify(exports.ToolMessage$outboundSchema.parse(toolMessage)); - } - function toolMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usermessage.js - var require_usermessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usermessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UserMessage$ = exports.UserMessage$outboundSchema = exports.UserMessage$inboundSchema = exports.UserMessageRole$ = exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema = exports.UserMessageContent$ = exports.UserMessageContent$outboundSchema = exports.UserMessageContent$inboundSchema = exports.UserMessageRole = void 0; - exports.userMessageContentToJSON = userMessageContentToJSON; - exports.userMessageContentFromJSON = userMessageContentFromJSON; - exports.userMessageToJSON = userMessageToJSON; - exports.userMessageFromJSON = userMessageFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - exports.UserMessageRole = { - User: "user" - }; - exports.UserMessageContent$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.UserMessageContent$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var UserMessageContent$; - (function(UserMessageContent$2) { - UserMessageContent$2.inboundSchema = exports.UserMessageContent$inboundSchema; - UserMessageContent$2.outboundSchema = exports.UserMessageContent$outboundSchema; - })(UserMessageContent$ || (exports.UserMessageContent$ = UserMessageContent$ = {})); - function userMessageContentToJSON(userMessageContent) { - return JSON.stringify(exports.UserMessageContent$outboundSchema.parse(userMessageContent)); - } - function userMessageContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessageContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessageContent' from JSON`); - } - exports.UserMessageRole$inboundSchema = z.nativeEnum(exports.UserMessageRole); - exports.UserMessageRole$outboundSchema = exports.UserMessageRole$inboundSchema; - var UserMessageRole$; - (function(UserMessageRole$2) { - UserMessageRole$2.inboundSchema = exports.UserMessageRole$inboundSchema; - UserMessageRole$2.outboundSchema = exports.UserMessageRole$outboundSchema; - })(UserMessageRole$ || (exports.UserMessageRole$ = UserMessageRole$ = {})); - exports.UserMessage$inboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])), - role: exports.UserMessageRole$inboundSchema.default("user") - }); - exports.UserMessage$outboundSchema = z.object({ - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])), - role: exports.UserMessageRole$outboundSchema.default("user") - }); - var UserMessage$; - (function(UserMessage$2) { - UserMessage$2.inboundSchema = exports.UserMessage$inboundSchema; - UserMessage$2.outboundSchema = exports.UserMessage$outboundSchema; - })(UserMessage$ || (exports.UserMessage$ = UserMessage$ = {})); - function userMessageToJSON(userMessage) { - return JSON.stringify(exports.UserMessage$outboundSchema.parse(userMessage)); - } - function userMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UserMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UserMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js - var require_agentscompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionRequest$ = exports.AgentsCompletionRequest$outboundSchema = exports.AgentsCompletionRequest$inboundSchema = exports.AgentsCompletionRequestToolChoice$ = exports.AgentsCompletionRequestToolChoice$outboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema = exports.AgentsCompletionRequestMessages$ = exports.AgentsCompletionRequestMessages$outboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema = exports.AgentsCompletionRequestStop$ = exports.AgentsCompletionRequestStop$outboundSchema = exports.AgentsCompletionRequestStop$inboundSchema = void 0; - exports.agentsCompletionRequestStopToJSON = agentsCompletionRequestStopToJSON; - exports.agentsCompletionRequestStopFromJSON = agentsCompletionRequestStopFromJSON; - exports.agentsCompletionRequestMessagesToJSON = agentsCompletionRequestMessagesToJSON; - exports.agentsCompletionRequestMessagesFromJSON = agentsCompletionRequestMessagesFromJSON; - exports.agentsCompletionRequestToolChoiceToJSON = agentsCompletionRequestToolChoiceToJSON; - exports.agentsCompletionRequestToolChoiceFromJSON = agentsCompletionRequestToolChoiceFromJSON; - exports.agentsCompletionRequestToJSON = agentsCompletionRequestToJSON; - exports.agentsCompletionRequestFromJSON = agentsCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionRequestStop$; - (function(AgentsCompletionRequestStop$2) { - AgentsCompletionRequestStop$2.inboundSchema = exports.AgentsCompletionRequestStop$inboundSchema; - AgentsCompletionRequestStop$2.outboundSchema = exports.AgentsCompletionRequestStop$outboundSchema; - })(AgentsCompletionRequestStop$ || (exports.AgentsCompletionRequestStop$ = AgentsCompletionRequestStop$ = {})); - function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop) { - return JSON.stringify(exports.AgentsCompletionRequestStop$outboundSchema.parse(agentsCompletionRequestStop)); - } - function agentsCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestStop' from JSON`); - } - exports.AgentsCompletionRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionRequestMessages$; - (function(AgentsCompletionRequestMessages$2) { - AgentsCompletionRequestMessages$2.inboundSchema = exports.AgentsCompletionRequestMessages$inboundSchema; - AgentsCompletionRequestMessages$2.outboundSchema = exports.AgentsCompletionRequestMessages$outboundSchema; - })(AgentsCompletionRequestMessages$ || (exports.AgentsCompletionRequestMessages$ = AgentsCompletionRequestMessages$ = {})); - function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages) { - return JSON.stringify(exports.AgentsCompletionRequestMessages$outboundSchema.parse(agentsCompletionRequestMessages)); - } - function agentsCompletionRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestMessages' from JSON`); - } - exports.AgentsCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionRequestToolChoice$; - (function(AgentsCompletionRequestToolChoice$2) { - AgentsCompletionRequestToolChoice$2.inboundSchema = exports.AgentsCompletionRequestToolChoice$inboundSchema; - AgentsCompletionRequestToolChoice$2.outboundSchema = exports.AgentsCompletionRequestToolChoice$outboundSchema; - })(AgentsCompletionRequestToolChoice$ || (exports.AgentsCompletionRequestToolChoice$ = AgentsCompletionRequestToolChoice$ = {})); - function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionRequestToolChoice$outboundSchema.parse(agentsCompletionRequestToolChoice)); - } - function agentsCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequestToolChoice' from JSON`); - } - exports.AgentsCompletionRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionRequest$; - (function(AgentsCompletionRequest$2) { - AgentsCompletionRequest$2.inboundSchema = exports.AgentsCompletionRequest$inboundSchema; - AgentsCompletionRequest$2.outboundSchema = exports.AgentsCompletionRequest$outboundSchema; - })(AgentsCompletionRequest$ || (exports.AgentsCompletionRequest$ = AgentsCompletionRequest$ = {})); - function agentsCompletionRequestToJSON(agentsCompletionRequest) { - return JSON.stringify(exports.AgentsCompletionRequest$outboundSchema.parse(agentsCompletionRequest)); - } - function agentsCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js - var require_agentscompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentscompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsCompletionStreamRequest$ = exports.AgentsCompletionStreamRequest$outboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$ = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = exports.AgentsCompletionStreamRequestMessages$ = exports.AgentsCompletionStreamRequestMessages$outboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema = exports.AgentsCompletionStreamRequestStop$ = exports.AgentsCompletionStreamRequestStop$outboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema = void 0; - exports.agentsCompletionStreamRequestStopToJSON = agentsCompletionStreamRequestStopToJSON; - exports.agentsCompletionStreamRequestStopFromJSON = agentsCompletionStreamRequestStopFromJSON; - exports.agentsCompletionStreamRequestMessagesToJSON = agentsCompletionStreamRequestMessagesToJSON; - exports.agentsCompletionStreamRequestMessagesFromJSON = agentsCompletionStreamRequestMessagesFromJSON; - exports.agentsCompletionStreamRequestToolChoiceToJSON = agentsCompletionStreamRequestToolChoiceToJSON; - exports.agentsCompletionStreamRequestToolChoiceFromJSON = agentsCompletionStreamRequestToolChoiceFromJSON; - exports.agentsCompletionStreamRequestToJSON = agentsCompletionStreamRequestToJSON; - exports.agentsCompletionStreamRequestFromJSON = agentsCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.AgentsCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.AgentsCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var AgentsCompletionStreamRequestStop$; - (function(AgentsCompletionStreamRequestStop$2) { - AgentsCompletionStreamRequestStop$2.inboundSchema = exports.AgentsCompletionStreamRequestStop$inboundSchema; - AgentsCompletionStreamRequestStop$2.outboundSchema = exports.AgentsCompletionStreamRequestStop$outboundSchema; - })(AgentsCompletionStreamRequestStop$ || (exports.AgentsCompletionStreamRequestStop$ = AgentsCompletionStreamRequestStop$ = {})); - function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop) { - return JSON.stringify(exports.AgentsCompletionStreamRequestStop$outboundSchema.parse(agentsCompletionStreamRequestStop)); - } - function agentsCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestStop' from JSON`); - } - exports.AgentsCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.AgentsCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var AgentsCompletionStreamRequestMessages$; - (function(AgentsCompletionStreamRequestMessages$2) { - AgentsCompletionStreamRequestMessages$2.inboundSchema = exports.AgentsCompletionStreamRequestMessages$inboundSchema; - AgentsCompletionStreamRequestMessages$2.outboundSchema = exports.AgentsCompletionStreamRequestMessages$outboundSchema; - })(AgentsCompletionStreamRequestMessages$ || (exports.AgentsCompletionStreamRequestMessages$ = AgentsCompletionStreamRequestMessages$ = {})); - function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages) { - return JSON.stringify(exports.AgentsCompletionStreamRequestMessages$outboundSchema.parse(agentsCompletionStreamRequestMessages)); - } - function agentsCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestMessages' from JSON`); - } - exports.AgentsCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.AgentsCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var AgentsCompletionStreamRequestToolChoice$; - (function(AgentsCompletionStreamRequestToolChoice$2) { - AgentsCompletionStreamRequestToolChoice$2.inboundSchema = exports.AgentsCompletionStreamRequestToolChoice$inboundSchema; - AgentsCompletionStreamRequestToolChoice$2.outboundSchema = exports.AgentsCompletionStreamRequestToolChoice$outboundSchema; - })(AgentsCompletionStreamRequestToolChoice$ || (exports.AgentsCompletionStreamRequestToolChoice$ = AgentsCompletionStreamRequestToolChoice$ = {})); - function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.AgentsCompletionStreamRequestToolChoice$outboundSchema.parse(agentsCompletionStreamRequestToolChoice)); - } - function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequestToolChoice' from JSON`); - } - exports.AgentsCompletionStreamRequest$inboundSchema = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId" - }); - }); - exports.AgentsCompletionStreamRequest$outboundSchema = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id" - }); - }); - var AgentsCompletionStreamRequest$; - (function(AgentsCompletionStreamRequest$2) { - AgentsCompletionStreamRequest$2.inboundSchema = exports.AgentsCompletionStreamRequest$inboundSchema; - AgentsCompletionStreamRequest$2.outboundSchema = exports.AgentsCompletionStreamRequest$outboundSchema; - })(AgentsCompletionStreamRequest$ || (exports.AgentsCompletionStreamRequest$ = AgentsCompletionStreamRequest$ = {})); - function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest) { - return JSON.stringify(exports.AgentsCompletionStreamRequest$outboundSchema.parse(agentsCompletionStreamRequest)); - } - function agentsCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js - var require_agentupdaterequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/agentupdaterequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentUpdateRequest$ = exports.AgentUpdateRequest$outboundSchema = exports.AgentUpdateRequest$inboundSchema = exports.AgentUpdateRequestTools$ = exports.AgentUpdateRequestTools$outboundSchema = exports.AgentUpdateRequestTools$inboundSchema = void 0; - exports.agentUpdateRequestToolsToJSON = agentUpdateRequestToolsToJSON; - exports.agentUpdateRequestToolsFromJSON = agentUpdateRequestToolsFromJSON; - exports.agentUpdateRequestToJSON = agentUpdateRequestToJSON; - exports.agentUpdateRequestFromJSON = agentUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.AgentUpdateRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.AgentUpdateRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var AgentUpdateRequestTools$; - (function(AgentUpdateRequestTools$2) { - AgentUpdateRequestTools$2.inboundSchema = exports.AgentUpdateRequestTools$inboundSchema; - AgentUpdateRequestTools$2.outboundSchema = exports.AgentUpdateRequestTools$outboundSchema; - })(AgentUpdateRequestTools$ || (exports.AgentUpdateRequestTools$ = AgentUpdateRequestTools$ = {})); - function agentUpdateRequestToolsToJSON(agentUpdateRequestTools) { - return JSON.stringify(exports.AgentUpdateRequestTools$outboundSchema.parse(agentUpdateRequestTools)); - } - function agentUpdateRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequestTools' from JSON`); - } - exports.AgentUpdateRequest$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs" - }); - }); - exports.AgentUpdateRequest$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args" - }); - }); - var AgentUpdateRequest$; - (function(AgentUpdateRequest$2) { - AgentUpdateRequest$2.inboundSchema = exports.AgentUpdateRequest$inboundSchema; - AgentUpdateRequest$2.outboundSchema = exports.AgentUpdateRequest$outboundSchema; - })(AgentUpdateRequest$ || (exports.AgentUpdateRequest$ = AgentUpdateRequest$ = {})); - function agentUpdateRequestToJSON(agentUpdateRequest) { - return JSON.stringify(exports.AgentUpdateRequest$outboundSchema.parse(agentUpdateRequest)); - } - function agentUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/apiendpoint.js - var require_apiendpoint = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/apiendpoint.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ApiEndpoint$ = exports.ApiEndpoint$outboundSchema = exports.ApiEndpoint$inboundSchema = exports.ApiEndpoint = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ApiEndpoint = { - RootV1ChatCompletions: "/v1/chat/completions", - RootV1Embeddings: "/v1/embeddings", - RootV1FimCompletions: "/v1/fim/completions", - RootV1Moderations: "/v1/moderations", - RootV1ChatModerations: "/v1/chat/moderations", - RootV1Ocr: "/v1/ocr", - RootV1Classifications: "/v1/classifications", - RootV1ChatClassifications: "/v1/chat/classifications", - RootV1Conversations: "/v1/conversations", - RootV1AudioTranscriptions: "/v1/audio/transcriptions" - }; - exports.ApiEndpoint$inboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ApiEndpoint$outboundSchema = z.union([ - z.nativeEnum(exports.ApiEndpoint), - z.string().and(z.custom()) - ]); - var ApiEndpoint$; - (function(ApiEndpoint$2) { - ApiEndpoint$2.inboundSchema = exports.ApiEndpoint$inboundSchema; - ApiEndpoint$2.outboundSchema = exports.ApiEndpoint$outboundSchema; - })(ApiEndpoint$ || (exports.ApiEndpoint$ = ApiEndpoint$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js - var require_archiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/archiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ArchiveFTModelOut$ = exports.ArchiveFTModelOut$outboundSchema = exports.ArchiveFTModelOut$inboundSchema = exports.ArchiveFTModelOutObject$ = exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema = exports.ArchiveFTModelOutObject = void 0; - exports.archiveFTModelOutToJSON = archiveFTModelOutToJSON; - exports.archiveFTModelOutFromJSON = archiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ArchiveFTModelOutObject = { - Model: "model" - }; - exports.ArchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.ArchiveFTModelOutObject); - exports.ArchiveFTModelOutObject$outboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - var ArchiveFTModelOutObject$; - (function(ArchiveFTModelOutObject$2) { - ArchiveFTModelOutObject$2.inboundSchema = exports.ArchiveFTModelOutObject$inboundSchema; - ArchiveFTModelOutObject$2.outboundSchema = exports.ArchiveFTModelOutObject$outboundSchema; - })(ArchiveFTModelOutObject$ || (exports.ArchiveFTModelOutObject$ = ArchiveFTModelOutObject$ = {})); - exports.ArchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(true) - }); - exports.ArchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ArchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(true) - }); - var ArchiveFTModelOut$; - (function(ArchiveFTModelOut$2) { - ArchiveFTModelOut$2.inboundSchema = exports.ArchiveFTModelOut$inboundSchema; - ArchiveFTModelOut$2.outboundSchema = exports.ArchiveFTModelOut$outboundSchema; - })(ArchiveFTModelOut$ || (exports.ArchiveFTModelOut$ = ArchiveFTModelOut$ = {})); - function archiveFTModelOutToJSON(archiveFTModelOut) { - return JSON.stringify(exports.ArchiveFTModelOut$outboundSchema.parse(archiveFTModelOut)); - } - function archiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ArchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ArchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/types/blobs.js - var require_blobs = __commonJS({ - "node_modules/@mistralai/mistralai/types/blobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.blobLikeSchema = void 0; - exports.isBlobLike = isBlobLike; - var z = __importStar(require_zod()); - exports.blobLikeSchema = z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true - }); - function isBlobLike(val) { - if (val instanceof Blob) { - return true; - } - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - return "stream" in val && typeof val.stream === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/file.js - var require_file = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/file.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileT$ = exports.FileT$outboundSchema = exports.FileT$inboundSchema = void 0; - exports.fileToJSON = fileToJSON; - exports.fileFromJSON = fileFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileT$inboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - exports.FileT$outboundSchema = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array) - ]) - }); - var FileT$; - (function(FileT$2) { - FileT$2.inboundSchema = exports.FileT$inboundSchema; - FileT$2.outboundSchema = exports.FileT$outboundSchema; - })(FileT$ || (exports.FileT$ = FileT$ = {})); - function fileToJSON(fileT) { - return JSON.stringify(exports.FileT$outboundSchema.parse(fileT)); - } - function fileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileT$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileT' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/timestampgranularity.js - var require_timestampgranularity = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/timestampgranularity.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TimestampGranularity$ = exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema = exports.TimestampGranularity = void 0; - var z = __importStar(require_zod()); - exports.TimestampGranularity = { - Segment: "segment" - }; - exports.TimestampGranularity$inboundSchema = z.nativeEnum(exports.TimestampGranularity); - exports.TimestampGranularity$outboundSchema = exports.TimestampGranularity$inboundSchema; - var TimestampGranularity$; - (function(TimestampGranularity$2) { - TimestampGranularity$2.inboundSchema = exports.TimestampGranularity$inboundSchema; - TimestampGranularity$2.outboundSchema = exports.TimestampGranularity$outboundSchema; - })(TimestampGranularity$ || (exports.TimestampGranularity$ = TimestampGranularity$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js - var require_audiotranscriptionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequest$ = exports.AudioTranscriptionRequest$outboundSchema = exports.AudioTranscriptionRequest$inboundSchema = void 0; - exports.audioTranscriptionRequestToJSON = audioTranscriptionRequestToJSON; - exports.audioTranscriptionRequestFromJSON = audioTranscriptionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequest$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequest$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequest$; - (function(AudioTranscriptionRequest$2) { - AudioTranscriptionRequest$2.inboundSchema = exports.AudioTranscriptionRequest$inboundSchema; - AudioTranscriptionRequest$2.outboundSchema = exports.AudioTranscriptionRequest$outboundSchema; - })(AudioTranscriptionRequest$ || (exports.AudioTranscriptionRequest$ = AudioTranscriptionRequest$ = {})); - function audioTranscriptionRequestToJSON(audioTranscriptionRequest) { - return JSON.stringify(exports.AudioTranscriptionRequest$outboundSchema.parse(audioTranscriptionRequest)); - } - function audioTranscriptionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js - var require_audiotranscriptionrequeststream = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/audiotranscriptionrequeststream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AudioTranscriptionRequestStream$ = exports.AudioTranscriptionRequestStream$outboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema = void 0; - exports.audioTranscriptionRequestStreamToJSON = audioTranscriptionRequestStreamToJSON; - exports.audioTranscriptionRequestStreamFromJSON = audioTranscriptionRequestStreamFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var file_js_1 = require_file(); - var timestampgranularity_js_1 = require_timestampgranularity(); - exports.AudioTranscriptionRequestStream$inboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestamp_granularities: z.array(timestampgranularity_js_1.TimestampGranularity$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities" - }); - }); - exports.AudioTranscriptionRequestStream$outboundSchema = z.object({ - model: z.string(), - file: file_js_1.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestampGranularities: z.array(timestampgranularity_js_1.TimestampGranularity$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities" - }); - }); - var AudioTranscriptionRequestStream$; - (function(AudioTranscriptionRequestStream$2) { - AudioTranscriptionRequestStream$2.inboundSchema = exports.AudioTranscriptionRequestStream$inboundSchema; - AudioTranscriptionRequestStream$2.outboundSchema = exports.AudioTranscriptionRequestStream$outboundSchema; - })(AudioTranscriptionRequestStream$ || (exports.AudioTranscriptionRequestStream$ = AudioTranscriptionRequestStream$ = {})); - function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream) { - return JSON.stringify(exports.AudioTranscriptionRequestStream$outboundSchema.parse(audioTranscriptionRequestStream)); - } - function audioTranscriptionRequestStreamFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AudioTranscriptionRequestStream$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AudioTranscriptionRequestStream' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelcapabilities.js - var require_modelcapabilities = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelcapabilities.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelCapabilities$ = exports.ModelCapabilities$outboundSchema = exports.ModelCapabilities$inboundSchema = void 0; - exports.modelCapabilitiesToJSON = modelCapabilitiesToJSON; - exports.modelCapabilitiesFromJSON = modelCapabilitiesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModelCapabilities$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(true), - fine_tuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.ModelCapabilities$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(true), - fineTuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var ModelCapabilities$; - (function(ModelCapabilities$2) { - ModelCapabilities$2.inboundSchema = exports.ModelCapabilities$inboundSchema; - ModelCapabilities$2.outboundSchema = exports.ModelCapabilities$outboundSchema; - })(ModelCapabilities$ || (exports.ModelCapabilities$ = ModelCapabilities$ = {})); - function modelCapabilitiesToJSON(modelCapabilities) { - return JSON.stringify(exports.ModelCapabilities$outboundSchema.parse(modelCapabilities)); - } - function modelCapabilitiesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelCapabilities$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelCapabilities' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/basemodelcard.js - var require_basemodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/basemodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BaseModelCard$ = exports.BaseModelCard$outboundSchema = exports.BaseModelCard$inboundSchema = exports.BaseModelCardType$ = exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema = exports.BaseModelCardType = void 0; - exports.baseModelCardToJSON = baseModelCardToJSON; - exports.baseModelCardFromJSON = baseModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.BaseModelCardType = { - Base: "base" - }; - exports.BaseModelCardType$inboundSchema = z.nativeEnum(exports.BaseModelCardType); - exports.BaseModelCardType$outboundSchema = exports.BaseModelCardType$inboundSchema; - var BaseModelCardType$; - (function(BaseModelCardType$2) { - BaseModelCardType$2.inboundSchema = exports.BaseModelCardType$inboundSchema; - BaseModelCardType$2.outboundSchema = exports.BaseModelCardType$outboundSchema; - })(BaseModelCardType$ || (exports.BaseModelCardType$ = BaseModelCardType$ = {})); - exports.BaseModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.BaseModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var BaseModelCard$; - (function(BaseModelCard$2) { - BaseModelCard$2.inboundSchema = exports.BaseModelCard$inboundSchema; - BaseModelCard$2.outboundSchema = exports.BaseModelCard$outboundSchema; - })(BaseModelCard$ || (exports.BaseModelCard$ = BaseModelCard$ = {})); - function baseModelCardToJSON(baseModelCard) { - return JSON.stringify(exports.BaseModelCard$outboundSchema.parse(baseModelCard)); - } - function baseModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BaseModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BaseModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batcherror.js - var require_batcherror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batcherror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchError$ = exports.BatchError$outboundSchema = exports.BatchError$inboundSchema = void 0; - exports.batchErrorToJSON = batchErrorToJSON; - exports.batchErrorFromJSON = batchErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.BatchError$inboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - exports.BatchError$outboundSchema = z.object({ - message: z.string(), - count: z.number().int().default(1) - }); - var BatchError$; - (function(BatchError$2) { - BatchError$2.inboundSchema = exports.BatchError$inboundSchema; - BatchError$2.outboundSchema = exports.BatchError$outboundSchema; - })(BatchError$ || (exports.BatchError$ = BatchError$ = {})); - function batchErrorToJSON(batchError) { - return JSON.stringify(exports.BatchError$outboundSchema.parse(batchError)); - } - function batchErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobin.js - var require_batchjobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobIn$ = exports.BatchJobIn$outboundSchema = exports.BatchJobIn$inboundSchema = void 0; - exports.batchJobInToJSON = batchJobInToJSON; - exports.batchJobInFromJSON = batchJobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var apiendpoint_js_1 = require_apiendpoint(); - exports.BatchJobIn$inboundSchema = z.object({ - input_files: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$inboundSchema, - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeout_hours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "timeout_hours": "timeoutHours" - }); - }); - exports.BatchJobIn$outboundSchema = z.object({ - inputFiles: z.array(z.string()), - endpoint: apiendpoint_js_1.ApiEndpoint$outboundSchema, - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeoutHours: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - timeoutHours: "timeout_hours" - }); - }); - var BatchJobIn$; - (function(BatchJobIn$2) { - BatchJobIn$2.inboundSchema = exports.BatchJobIn$inboundSchema; - BatchJobIn$2.outboundSchema = exports.BatchJobIn$outboundSchema; - })(BatchJobIn$ || (exports.BatchJobIn$ = BatchJobIn$ = {})); - function batchJobInToJSON(batchJobIn) { - return JSON.stringify(exports.BatchJobIn$outboundSchema.parse(batchJobIn)); - } - function batchJobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobstatus.js - var require_batchjobstatus = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobstatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobStatus$ = exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema = exports.BatchJobStatus = void 0; - var z = __importStar(require_zod()); - exports.BatchJobStatus = { - Queued: "QUEUED", - Running: "RUNNING", - Success: "SUCCESS", - Failed: "FAILED", - TimeoutExceeded: "TIMEOUT_EXCEEDED", - CancellationRequested: "CANCELLATION_REQUESTED", - Cancelled: "CANCELLED" - }; - exports.BatchJobStatus$inboundSchema = z.nativeEnum(exports.BatchJobStatus); - exports.BatchJobStatus$outboundSchema = exports.BatchJobStatus$inboundSchema; - var BatchJobStatus$; - (function(BatchJobStatus$2) { - BatchJobStatus$2.inboundSchema = exports.BatchJobStatus$inboundSchema; - BatchJobStatus$2.outboundSchema = exports.BatchJobStatus$outboundSchema; - })(BatchJobStatus$ || (exports.BatchJobStatus$ = BatchJobStatus$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobout.js - var require_batchjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobOut$ = exports.BatchJobOut$outboundSchema = exports.BatchJobOut$inboundSchema = exports.BatchJobOutObject$ = exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema = exports.BatchJobOutObject = void 0; - exports.batchJobOutToJSON = batchJobOutToJSON; - exports.batchJobOutFromJSON = batchJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var batcherror_js_1 = require_batcherror(); - var batchjobstatus_js_1 = require_batchjobstatus(); - exports.BatchJobOutObject = { - Batch: "batch" - }; - exports.BatchJobOutObject$inboundSchema = z.nativeEnum(exports.BatchJobOutObject); - exports.BatchJobOutObject$outboundSchema = exports.BatchJobOutObject$inboundSchema; - var BatchJobOutObject$; - (function(BatchJobOutObject$2) { - BatchJobOutObject$2.inboundSchema = exports.BatchJobOutObject$inboundSchema; - BatchJobOutObject$2.outboundSchema = exports.BatchJobOutObject$outboundSchema; - })(BatchJobOutObject$ || (exports.BatchJobOutObject$ = BatchJobOutObject$ = {})); - exports.BatchJobOut$inboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$inboundSchema.default("batch"), - input_files: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - output_file: z.nullable(z.string()).optional(), - error_file: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$inboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$inboundSchema, - created_at: z.number().int(), - total_requests: z.number().int(), - completed_requests: z.number().int(), - succeeded_requests: z.number().int(), - failed_requests: z.number().int(), - started_at: z.nullable(z.number().int()).optional(), - completed_at: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "output_file": "outputFile", - "error_file": "errorFile", - "created_at": "createdAt", - "total_requests": "totalRequests", - "completed_requests": "completedRequests", - "succeeded_requests": "succeededRequests", - "failed_requests": "failedRequests", - "started_at": "startedAt", - "completed_at": "completedAt" - }); - }); - exports.BatchJobOut$outboundSchema = z.object({ - id: z.string(), - object: exports.BatchJobOutObject$outboundSchema.default("batch"), - inputFiles: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - outputFile: z.nullable(z.string()).optional(), - errorFile: z.nullable(z.string()).optional(), - errors: z.array(batcherror_js_1.BatchError$outboundSchema), - status: batchjobstatus_js_1.BatchJobStatus$outboundSchema, - createdAt: z.number().int(), - totalRequests: z.number().int(), - completedRequests: z.number().int(), - succeededRequests: z.number().int(), - failedRequests: z.number().int(), - startedAt: z.nullable(z.number().int()).optional(), - completedAt: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputFiles: "input_files", - agentId: "agent_id", - outputFile: "output_file", - errorFile: "error_file", - createdAt: "created_at", - totalRequests: "total_requests", - completedRequests: "completed_requests", - succeededRequests: "succeeded_requests", - failedRequests: "failed_requests", - startedAt: "started_at", - completedAt: "completed_at" - }); - }); - var BatchJobOut$; - (function(BatchJobOut$2) { - BatchJobOut$2.inboundSchema = exports.BatchJobOut$inboundSchema; - BatchJobOut$2.outboundSchema = exports.BatchJobOut$outboundSchema; - })(BatchJobOut$ || (exports.BatchJobOut$ = BatchJobOut$ = {})); - function batchJobOutToJSON(batchJobOut) { - return JSON.stringify(exports.BatchJobOut$outboundSchema.parse(batchJobOut)); - } - function batchJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/batchjobsout.js - var require_batchjobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/batchjobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BatchJobsOut$ = exports.BatchJobsOut$outboundSchema = exports.BatchJobsOut$inboundSchema = exports.BatchJobsOutObject$ = exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema = exports.BatchJobsOutObject = void 0; - exports.batchJobsOutToJSON = batchJobsOutToJSON; - exports.batchJobsOutFromJSON = batchJobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var batchjobout_js_1 = require_batchjobout(); - exports.BatchJobsOutObject = { - List: "list" - }; - exports.BatchJobsOutObject$inboundSchema = z.nativeEnum(exports.BatchJobsOutObject); - exports.BatchJobsOutObject$outboundSchema = exports.BatchJobsOutObject$inboundSchema; - var BatchJobsOutObject$; - (function(BatchJobsOutObject$2) { - BatchJobsOutObject$2.inboundSchema = exports.BatchJobsOutObject$inboundSchema; - BatchJobsOutObject$2.outboundSchema = exports.BatchJobsOutObject$outboundSchema; - })(BatchJobsOutObject$ || (exports.BatchJobsOutObject$ = BatchJobsOutObject$ = {})); - exports.BatchJobsOut$inboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$inboundSchema).optional(), - object: exports.BatchJobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.BatchJobsOut$outboundSchema = z.object({ - data: z.array(batchjobout_js_1.BatchJobOut$outboundSchema).optional(), - object: exports.BatchJobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var BatchJobsOut$; - (function(BatchJobsOut$2) { - BatchJobsOut$2.inboundSchema = exports.BatchJobsOut$inboundSchema; - BatchJobsOut$2.outboundSchema = exports.BatchJobsOut$outboundSchema; - })(BatchJobsOut$ || (exports.BatchJobsOut$ = BatchJobsOut$ = {})); - function batchJobsOutToJSON(batchJobsOut) { - return JSON.stringify(exports.BatchJobsOut$outboundSchema.parse(batchJobsOut)); - } - function batchJobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.BatchJobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'BatchJobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/builtinconnectors.js - var require_builtinconnectors = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/builtinconnectors.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.BuiltInConnectors$ = exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema = exports.BuiltInConnectors = void 0; - var z = __importStar(require_zod()); - exports.BuiltInConnectors = { - WebSearch: "web_search", - WebSearchPremium: "web_search_premium", - CodeInterpreter: "code_interpreter", - ImageGeneration: "image_generation", - DocumentLibrary: "document_library" - }; - exports.BuiltInConnectors$inboundSchema = z.nativeEnum(exports.BuiltInConnectors); - exports.BuiltInConnectors$outboundSchema = exports.BuiltInConnectors$inboundSchema; - var BuiltInConnectors$; - (function(BuiltInConnectors$2) { - BuiltInConnectors$2.inboundSchema = exports.BuiltInConnectors$inboundSchema; - BuiltInConnectors$2.outboundSchema = exports.BuiltInConnectors$outboundSchema; - })(BuiltInConnectors$ || (exports.BuiltInConnectors$ = BuiltInConnectors$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/instructrequest.js - var require_instructrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/instructrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InstructRequest$ = exports.InstructRequest$outboundSchema = exports.InstructRequest$inboundSchema = exports.InstructRequestMessages$ = exports.InstructRequestMessages$outboundSchema = exports.InstructRequestMessages$inboundSchema = void 0; - exports.instructRequestMessagesToJSON = instructRequestMessagesToJSON; - exports.instructRequestMessagesFromJSON = instructRequestMessagesFromJSON; - exports.instructRequestToJSON = instructRequestToJSON; - exports.instructRequestFromJSON = instructRequestFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestMessages$; - (function(InstructRequestMessages$2) { - InstructRequestMessages$2.inboundSchema = exports.InstructRequestMessages$inboundSchema; - InstructRequestMessages$2.outboundSchema = exports.InstructRequestMessages$outboundSchema; - })(InstructRequestMessages$ || (exports.InstructRequestMessages$ = InstructRequestMessages$ = {})); - function instructRequestMessagesToJSON(instructRequestMessages) { - return JSON.stringify(exports.InstructRequestMessages$outboundSchema.parse(instructRequestMessages)); - } - function instructRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestMessages' from JSON`); - } - exports.InstructRequest$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequest$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequest$; - (function(InstructRequest$2) { - InstructRequest$2.inboundSchema = exports.InstructRequest$inboundSchema; - InstructRequest$2.outboundSchema = exports.InstructRequest$outboundSchema; - })(InstructRequest$ || (exports.InstructRequest$ = InstructRequest$ = {})); - function instructRequestToJSON(instructRequest) { - return JSON.stringify(exports.InstructRequest$outboundSchema.parse(instructRequest)); - } - function instructRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputs.js - var require_inputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Inputs$ = exports.Inputs$outboundSchema = exports.Inputs$inboundSchema = exports.InstructRequestInputs$ = exports.InstructRequestInputs$outboundSchema = exports.InstructRequestInputs$inboundSchema = exports.InstructRequestInputsMessages$ = exports.InstructRequestInputsMessages$outboundSchema = exports.InstructRequestInputsMessages$inboundSchema = void 0; - exports.instructRequestInputsMessagesToJSON = instructRequestInputsMessagesToJSON; - exports.instructRequestInputsMessagesFromJSON = instructRequestInputsMessagesFromJSON; - exports.instructRequestInputsToJSON = instructRequestInputsToJSON; - exports.instructRequestInputsFromJSON = instructRequestInputsFromJSON; - exports.inputsToJSON = inputsToJSON; - exports.inputsFromJSON = inputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var instructrequest_js_1 = require_instructrequest(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.InstructRequestInputsMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.InstructRequestInputsMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var InstructRequestInputsMessages$; - (function(InstructRequestInputsMessages$2) { - InstructRequestInputsMessages$2.inboundSchema = exports.InstructRequestInputsMessages$inboundSchema; - InstructRequestInputsMessages$2.outboundSchema = exports.InstructRequestInputsMessages$outboundSchema; - })(InstructRequestInputsMessages$ || (exports.InstructRequestInputsMessages$ = InstructRequestInputsMessages$ = {})); - function instructRequestInputsMessagesToJSON(instructRequestInputsMessages) { - return JSON.stringify(exports.InstructRequestInputsMessages$outboundSchema.parse(instructRequestInputsMessages)); - } - function instructRequestInputsMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputsMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputsMessages' from JSON`); - } - exports.InstructRequestInputs$inboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - exports.InstructRequestInputs$outboundSchema = z.object({ - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])) - }); - var InstructRequestInputs$; - (function(InstructRequestInputs$2) { - InstructRequestInputs$2.inboundSchema = exports.InstructRequestInputs$inboundSchema; - InstructRequestInputs$2.outboundSchema = exports.InstructRequestInputs$outboundSchema; - })(InstructRequestInputs$ || (exports.InstructRequestInputs$ = InstructRequestInputs$ = {})); - function instructRequestInputsToJSON(instructRequestInputs) { - return JSON.stringify(exports.InstructRequestInputs$outboundSchema.parse(instructRequestInputs)); - } - function instructRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InstructRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InstructRequestInputs' from JSON`); - } - exports.Inputs$inboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$inboundSchema), - z.array(instructrequest_js_1.InstructRequest$inboundSchema) - ]); - exports.Inputs$outboundSchema = z.union([ - z.lazy(() => exports.InstructRequestInputs$outboundSchema), - z.array(instructrequest_js_1.InstructRequest$outboundSchema) - ]); - var Inputs$; - (function(Inputs$2) { - Inputs$2.inboundSchema = exports.Inputs$inboundSchema; - Inputs$2.outboundSchema = exports.Inputs$outboundSchema; - })(Inputs$ || (exports.Inputs$ = Inputs$ = {})); - function inputsToJSON(inputs) { - return JSON.stringify(exports.Inputs$outboundSchema.parse(inputs)); - } - function inputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Inputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Inputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js - var require_chatclassificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatclassificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatClassificationRequest$ = exports.ChatClassificationRequest$outboundSchema = exports.ChatClassificationRequest$inboundSchema = void 0; - exports.chatClassificationRequestToJSON = chatClassificationRequestToJSON; - exports.chatClassificationRequestFromJSON = chatClassificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var inputs_js_1 = require_inputs(); - exports.ChatClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: inputs_js_1.Inputs$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: inputs_js_1.Inputs$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatClassificationRequest$; - (function(ChatClassificationRequest$2) { - ChatClassificationRequest$2.inboundSchema = exports.ChatClassificationRequest$inboundSchema; - ChatClassificationRequest$2.outboundSchema = exports.ChatClassificationRequest$outboundSchema; - })(ChatClassificationRequest$ || (exports.ChatClassificationRequest$ = ChatClassificationRequest$ = {})); - function chatClassificationRequestToJSON(chatClassificationRequest) { - return JSON.stringify(exports.ChatClassificationRequest$outboundSchema.parse(chatClassificationRequest)); - } - function chatClassificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js - var require_chatcompletionchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionChoice$ = exports.ChatCompletionChoice$outboundSchema = exports.ChatCompletionChoice$inboundSchema = exports.FinishReason$ = exports.FinishReason$outboundSchema = exports.FinishReason$inboundSchema = exports.FinishReason = void 0; - exports.chatCompletionChoiceToJSON = chatCompletionChoiceToJSON; - exports.chatCompletionChoiceFromJSON = chatCompletionChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var assistantmessage_js_1 = require_assistantmessage(); - exports.FinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.FinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.FinishReason), - z.string().and(z.custom()) - ]); - var FinishReason$; - (function(FinishReason$2) { - FinishReason$2.inboundSchema = exports.FinishReason$inboundSchema; - FinishReason$2.outboundSchema = exports.FinishReason$outboundSchema; - })(FinishReason$ || (exports.FinishReason$ = FinishReason$ = {})); - exports.ChatCompletionChoice$inboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$inboundSchema, - finish_reason: exports.FinishReason$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.ChatCompletionChoice$outboundSchema = z.object({ - index: z.number().int(), - message: assistantmessage_js_1.AssistantMessage$outboundSchema, - finishReason: exports.FinishReason$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var ChatCompletionChoice$; - (function(ChatCompletionChoice$2) { - ChatCompletionChoice$2.inboundSchema = exports.ChatCompletionChoice$inboundSchema; - ChatCompletionChoice$2.outboundSchema = exports.ChatCompletionChoice$outboundSchema; - })(ChatCompletionChoice$ || (exports.ChatCompletionChoice$ = ChatCompletionChoice$ = {})); - function chatCompletionChoiceToJSON(chatCompletionChoice) { - return JSON.stringify(exports.ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice)); - } - function chatCompletionChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js - var require_chatcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionRequest$ = exports.ChatCompletionRequest$outboundSchema = exports.ChatCompletionRequest$inboundSchema = exports.ChatCompletionRequestToolChoice$ = exports.ChatCompletionRequestToolChoice$outboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema = exports.Messages$ = exports.Messages$outboundSchema = exports.Messages$inboundSchema = exports.Stop$ = exports.Stop$outboundSchema = exports.Stop$inboundSchema = void 0; - exports.stopToJSON = stopToJSON; - exports.stopFromJSON = stopFromJSON; - exports.messagesToJSON = messagesToJSON; - exports.messagesFromJSON = messagesFromJSON; - exports.chatCompletionRequestToolChoiceToJSON = chatCompletionRequestToolChoiceToJSON; - exports.chatCompletionRequestToolChoiceFromJSON = chatCompletionRequestToolChoiceFromJSON; - exports.chatCompletionRequestToJSON = chatCompletionRequestToJSON; - exports.chatCompletionRequestFromJSON = chatCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Stop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.Stop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var Stop$; - (function(Stop$2) { - Stop$2.inboundSchema = exports.Stop$inboundSchema; - Stop$2.outboundSchema = exports.Stop$outboundSchema; - })(Stop$ || (exports.Stop$ = Stop$ = {})); - function stopToJSON(stop) { - return JSON.stringify(exports.Stop$outboundSchema.parse(stop)); - } - function stopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Stop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Stop' from JSON`); - } - exports.Messages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Messages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Messages$; - (function(Messages$2) { - Messages$2.inboundSchema = exports.Messages$inboundSchema; - Messages$2.outboundSchema = exports.Messages$outboundSchema; - })(Messages$ || (exports.Messages$ = Messages$ = {})); - function messagesToJSON(messages) { - return JSON.stringify(exports.Messages$outboundSchema.parse(messages)); - } - function messagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Messages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Messages' from JSON`); - } - exports.ChatCompletionRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionRequestToolChoice$; - (function(ChatCompletionRequestToolChoice$2) { - ChatCompletionRequestToolChoice$2.inboundSchema = exports.ChatCompletionRequestToolChoice$inboundSchema; - ChatCompletionRequestToolChoice$2.outboundSchema = exports.ChatCompletionRequestToolChoice$outboundSchema; - })(ChatCompletionRequestToolChoice$ || (exports.ChatCompletionRequestToolChoice$ = ChatCompletionRequestToolChoice$ = {})); - function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionRequestToolChoice$outboundSchema.parse(chatCompletionRequestToolChoice)); - } - function chatCompletionRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`); - } - exports.ChatCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionRequest$; - (function(ChatCompletionRequest$2) { - ChatCompletionRequest$2.inboundSchema = exports.ChatCompletionRequest$inboundSchema; - ChatCompletionRequest$2.outboundSchema = exports.ChatCompletionRequest$outboundSchema; - })(ChatCompletionRequest$ || (exports.ChatCompletionRequest$ = ChatCompletionRequest$ = {})); - function chatCompletionRequestToJSON(chatCompletionRequest) { - return JSON.stringify(exports.ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest)); - } - function chatCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/usageinfo.js - var require_usageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/usageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UsageInfo$ = exports.UsageInfo$outboundSchema = exports.UsageInfo$inboundSchema = void 0; - exports.usageInfoToJSON = usageInfoToJSON; - exports.usageInfoFromJSON = usageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.UsageInfo$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - prompt_audio_seconds: z.nullable(z.number().int()).optional() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "prompt_audio_seconds": "promptAudioSeconds" - }); - }); - exports.UsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - promptAudioSeconds: z.nullable(z.number().int()).optional(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - promptAudioSeconds: "prompt_audio_seconds", - additionalProperties: null - }) - }; - }); - var UsageInfo$; - (function(UsageInfo$2) { - UsageInfo$2.inboundSchema = exports.UsageInfo$inboundSchema; - UsageInfo$2.outboundSchema = exports.UsageInfo$outboundSchema; - })(UsageInfo$ || (exports.UsageInfo$ = UsageInfo$ = {})); - function usageInfoToJSON(usageInfo) { - return JSON.stringify(exports.UsageInfo$outboundSchema.parse(usageInfo)); - } - function usageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js - var require_chatcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionResponse$ = exports.ChatCompletionResponse$outboundSchema = exports.ChatCompletionResponse$inboundSchema = void 0; - exports.chatCompletionResponseToJSON = chatCompletionResponseToJSON; - exports.chatCompletionResponseFromJSON = chatCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.ChatCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.ChatCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var ChatCompletionResponse$; - (function(ChatCompletionResponse$2) { - ChatCompletionResponse$2.inboundSchema = exports.ChatCompletionResponse$inboundSchema; - ChatCompletionResponse$2.outboundSchema = exports.ChatCompletionResponse$outboundSchema; - })(ChatCompletionResponse$ || (exports.ChatCompletionResponse$ = ChatCompletionResponse$ = {})); - function chatCompletionResponseToJSON(chatCompletionResponse) { - return JSON.stringify(exports.ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse)); - } - function chatCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js - var require_chatcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatCompletionStreamRequest$ = exports.ChatCompletionStreamRequest$outboundSchema = exports.ChatCompletionStreamRequest$inboundSchema = exports.ChatCompletionStreamRequestToolChoice$ = exports.ChatCompletionStreamRequestToolChoice$outboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema = exports.ChatCompletionStreamRequestMessages$ = exports.ChatCompletionStreamRequestMessages$outboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema = exports.ChatCompletionStreamRequestStop$ = exports.ChatCompletionStreamRequestStop$outboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema = void 0; - exports.chatCompletionStreamRequestStopToJSON = chatCompletionStreamRequestStopToJSON; - exports.chatCompletionStreamRequestStopFromJSON = chatCompletionStreamRequestStopFromJSON; - exports.chatCompletionStreamRequestMessagesToJSON = chatCompletionStreamRequestMessagesToJSON; - exports.chatCompletionStreamRequestMessagesFromJSON = chatCompletionStreamRequestMessagesFromJSON; - exports.chatCompletionStreamRequestToolChoiceToJSON = chatCompletionStreamRequestToolChoiceToJSON; - exports.chatCompletionStreamRequestToolChoiceFromJSON = chatCompletionStreamRequestToolChoiceFromJSON; - exports.chatCompletionStreamRequestToJSON = chatCompletionStreamRequestToJSON; - exports.chatCompletionStreamRequestFromJSON = chatCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var mistralpromptmode_js_1 = require_mistralpromptmode(); - var prediction_js_1 = require_prediction(); - var responseformat_js_1 = require_responseformat(); - var systemmessage_js_1 = require_systemmessage(); - var tool_js_1 = require_tool(); - var toolchoice_js_1 = require_toolchoice(); - var toolchoiceenum_js_1 = require_toolchoiceenum(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.ChatCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ChatCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ChatCompletionStreamRequestStop$; - (function(ChatCompletionStreamRequestStop$2) { - ChatCompletionStreamRequestStop$2.inboundSchema = exports.ChatCompletionStreamRequestStop$inboundSchema; - ChatCompletionStreamRequestStop$2.outboundSchema = exports.ChatCompletionStreamRequestStop$outboundSchema; - })(ChatCompletionStreamRequestStop$ || (exports.ChatCompletionStreamRequestStop$ = ChatCompletionStreamRequestStop$ = {})); - function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop) { - return JSON.stringify(exports.ChatCompletionStreamRequestStop$outboundSchema.parse(chatCompletionStreamRequestStop)); - } - function chatCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestStop' from JSON`); - } - exports.ChatCompletionStreamRequestMessages$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.ChatCompletionStreamRequestMessages$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var ChatCompletionStreamRequestMessages$; - (function(ChatCompletionStreamRequestMessages$2) { - ChatCompletionStreamRequestMessages$2.inboundSchema = exports.ChatCompletionStreamRequestMessages$inboundSchema; - ChatCompletionStreamRequestMessages$2.outboundSchema = exports.ChatCompletionStreamRequestMessages$outboundSchema; - })(ChatCompletionStreamRequestMessages$ || (exports.ChatCompletionStreamRequestMessages$ = ChatCompletionStreamRequestMessages$ = {})); - function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages) { - return JSON.stringify(exports.ChatCompletionStreamRequestMessages$outboundSchema.parse(chatCompletionStreamRequestMessages)); - } - function chatCompletionStreamRequestMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestMessages' from JSON`); - } - exports.ChatCompletionStreamRequestToolChoice$inboundSchema = z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]); - exports.ChatCompletionStreamRequestToolChoice$outboundSchema = z.union([toolchoice_js_1.ToolChoice$outboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema]); - var ChatCompletionStreamRequestToolChoice$; - (function(ChatCompletionStreamRequestToolChoice$2) { - ChatCompletionStreamRequestToolChoice$2.inboundSchema = exports.ChatCompletionStreamRequestToolChoice$inboundSchema; - ChatCompletionStreamRequestToolChoice$2.outboundSchema = exports.ChatCompletionStreamRequestToolChoice$outboundSchema; - })(ChatCompletionStreamRequestToolChoice$ || (exports.ChatCompletionStreamRequestToolChoice$ = ChatCompletionStreamRequestToolChoice$ = {})); - function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice) { - return JSON.stringify(exports.ChatCompletionStreamRequestToolChoice$outboundSchema.parse(chatCompletionStreamRequestToolChoice)); - } - function chatCompletionStreamRequestToolChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`); - } - exports.ChatCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - response_format: responseformat_js_1.ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$inboundSchema)).optional(), - tool_choice: z.union([toolchoice_js_1.ToolChoice$inboundSchema, toolchoiceenum_js_1.ToolChoiceEnum$inboundSchema]).optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt" - }); - }); - exports.ChatCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - responseFormat: responseformat_js_1.ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(tool_js_1.Tool$outboundSchema)).optional(), - toolChoice: z.union([ - toolchoice_js_1.ToolChoice$outboundSchema, - toolchoiceenum_js_1.ToolChoiceEnum$outboundSchema - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: prediction_js_1.Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(mistralpromptmode_js_1.MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt" - }); - }); - var ChatCompletionStreamRequest$; - (function(ChatCompletionStreamRequest$2) { - ChatCompletionStreamRequest$2.inboundSchema = exports.ChatCompletionStreamRequest$inboundSchema; - ChatCompletionStreamRequest$2.outboundSchema = exports.ChatCompletionStreamRequest$outboundSchema; - })(ChatCompletionStreamRequest$ || (exports.ChatCompletionStreamRequest$ = ChatCompletionStreamRequest$ = {})); - function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest) { - return JSON.stringify(exports.ChatCompletionStreamRequest$outboundSchema.parse(chatCompletionStreamRequest)); - } - function chatCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js - var require_chatmoderationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/chatmoderationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ChatModerationRequest$ = exports.ChatModerationRequest$outboundSchema = exports.ChatModerationRequest$inboundSchema = exports.ChatModerationRequestInputs$ = exports.ChatModerationRequestInputs$outboundSchema = exports.ChatModerationRequestInputs$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = exports.Two$ = exports.Two$outboundSchema = exports.Two$inboundSchema = void 0; - exports.twoToJSON = twoToJSON; - exports.twoFromJSON = twoFromJSON; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.chatModerationRequestInputsToJSON = chatModerationRequestInputsToJSON; - exports.chatModerationRequestInputsFromJSON = chatModerationRequestInputsFromJSON; - exports.chatModerationRequestToJSON = chatModerationRequestToJSON; - exports.chatModerationRequestFromJSON = chatModerationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var assistantmessage_js_1 = require_assistantmessage(); - var systemmessage_js_1 = require_systemmessage(); - var toolmessage_js_1 = require_toolmessage(); - var usermessage_js_1 = require_usermessage(); - exports.Two$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.Two$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var Two$; - (function(Two$2) { - Two$2.inboundSchema = exports.Two$inboundSchema; - Two$2.outboundSchema = exports.Two$outboundSchema; - })(Two$ || (exports.Two$ = Two$ = {})); - function twoToJSON(two) { - return JSON.stringify(exports.Two$outboundSchema.parse(two)); - } - function twoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Two$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Two' from JSON`); - } - exports.One$inboundSchema = z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - exports.One$outboundSchema = z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.ChatModerationRequestInputs$inboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - exports.ChatModerationRequestInputs$outboundSchema = z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]); - var ChatModerationRequestInputs$; - (function(ChatModerationRequestInputs$2) { - ChatModerationRequestInputs$2.inboundSchema = exports.ChatModerationRequestInputs$inboundSchema; - ChatModerationRequestInputs$2.outboundSchema = exports.ChatModerationRequestInputs$outboundSchema; - })(ChatModerationRequestInputs$ || (exports.ChatModerationRequestInputs$ = ChatModerationRequestInputs$ = {})); - function chatModerationRequestInputsToJSON(chatModerationRequestInputs) { - return JSON.stringify(exports.ChatModerationRequestInputs$outboundSchema.parse(chatModerationRequestInputs)); - } - function chatModerationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequestInputs' from JSON`); - } - exports.ChatModerationRequest$inboundSchema = z.object({ - input: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$inboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$inboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$inboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$inboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ChatModerationRequest$outboundSchema = z.object({ - inputs: z.union([ - z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ])), - z.array(z.array(z.union([ - systemmessage_js_1.SystemMessage$outboundSchema.and(z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role - }))), - toolmessage_js_1.ToolMessage$outboundSchema.and(z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role - }))), - usermessage_js_1.UserMessage$outboundSchema.and(z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role - }))), - assistantmessage_js_1.AssistantMessage$outboundSchema.and(z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role - }))) - ]))) - ]), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ChatModerationRequest$; - (function(ChatModerationRequest$2) { - ChatModerationRequest$2.inboundSchema = exports.ChatModerationRequest$inboundSchema; - ChatModerationRequest$2.outboundSchema = exports.ChatModerationRequest$outboundSchema; - })(ChatModerationRequest$ || (exports.ChatModerationRequest$ = ChatModerationRequest$ = {})); - function chatModerationRequestToJSON(chatModerationRequest) { - return JSON.stringify(exports.ChatModerationRequest$outboundSchema.parse(chatModerationRequest)); - } - function chatModerationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ChatModerationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ChatModerationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/metricout.js - var require_metricout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/metricout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MetricOut$ = exports.MetricOut$outboundSchema = exports.MetricOut$inboundSchema = void 0; - exports.metricOutToJSON = metricOutToJSON; - exports.metricOutFromJSON = metricOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.MetricOut$inboundSchema = z.object({ - train_loss: z.nullable(z.number()).optional(), - valid_loss: z.nullable(z.number()).optional(), - valid_mean_token_accuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "train_loss": "trainLoss", - "valid_loss": "validLoss", - "valid_mean_token_accuracy": "validMeanTokenAccuracy" - }); - }); - exports.MetricOut$outboundSchema = z.object({ - trainLoss: z.nullable(z.number()).optional(), - validLoss: z.nullable(z.number()).optional(), - validMeanTokenAccuracy: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainLoss: "train_loss", - validLoss: "valid_loss", - validMeanTokenAccuracy: "valid_mean_token_accuracy" - }); - }); - var MetricOut$; - (function(MetricOut$2) { - MetricOut$2.inboundSchema = exports.MetricOut$inboundSchema; - MetricOut$2.outboundSchema = exports.MetricOut$outboundSchema; - })(MetricOut$ || (exports.MetricOut$ = MetricOut$ = {})); - function metricOutToJSON(metricOut) { - return JSON.stringify(exports.MetricOut$outboundSchema.parse(metricOut)); - } - function metricOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MetricOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MetricOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/checkpointout.js - var require_checkpointout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/checkpointout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CheckpointOut$ = exports.CheckpointOut$outboundSchema = exports.CheckpointOut$inboundSchema = void 0; - exports.checkpointOutToJSON = checkpointOutToJSON; - exports.checkpointOutFromJSON = checkpointOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var metricout_js_1 = require_metricout(); - exports.CheckpointOut$inboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$inboundSchema, - step_number: z.number().int(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "step_number": "stepNumber", - "created_at": "createdAt" - }); - }); - exports.CheckpointOut$outboundSchema = z.object({ - metrics: metricout_js_1.MetricOut$outboundSchema, - stepNumber: z.number().int(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - stepNumber: "step_number", - createdAt: "created_at" - }); - }); - var CheckpointOut$; - (function(CheckpointOut$2) { - CheckpointOut$2.inboundSchema = exports.CheckpointOut$inboundSchema; - CheckpointOut$2.outboundSchema = exports.CheckpointOut$outboundSchema; - })(CheckpointOut$ || (exports.CheckpointOut$ = CheckpointOut$ = {})); - function checkpointOutToJSON(checkpointOut) { - return JSON.stringify(exports.CheckpointOut$outboundSchema.parse(checkpointOut)); - } - function checkpointOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CheckpointOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CheckpointOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationrequest.js - var require_classificationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationRequest$ = exports.ClassificationRequest$outboundSchema = exports.ClassificationRequest$inboundSchema = exports.ClassificationRequestInputs$ = exports.ClassificationRequestInputs$outboundSchema = exports.ClassificationRequestInputs$inboundSchema = void 0; - exports.classificationRequestInputsToJSON = classificationRequestInputsToJSON; - exports.classificationRequestInputsFromJSON = classificationRequestInputsFromJSON; - exports.classificationRequestToJSON = classificationRequestToJSON; - exports.classificationRequestFromJSON = classificationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassificationRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.ClassificationRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var ClassificationRequestInputs$; - (function(ClassificationRequestInputs$2) { - ClassificationRequestInputs$2.inboundSchema = exports.ClassificationRequestInputs$inboundSchema; - ClassificationRequestInputs$2.outboundSchema = exports.ClassificationRequestInputs$outboundSchema; - })(ClassificationRequestInputs$ || (exports.ClassificationRequestInputs$ = ClassificationRequestInputs$ = {})); - function classificationRequestInputsToJSON(classificationRequestInputs) { - return JSON.stringify(exports.ClassificationRequestInputs$outboundSchema.parse(classificationRequestInputs)); - } - function classificationRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequestInputs' from JSON`); - } - exports.ClassificationRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs" - }); - }); - exports.ClassificationRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input" - }); - }); - var ClassificationRequest$; - (function(ClassificationRequest$2) { - ClassificationRequest$2.inboundSchema = exports.ClassificationRequest$inboundSchema; - ClassificationRequest$2.outboundSchema = exports.ClassificationRequest$outboundSchema; - })(ClassificationRequest$ || (exports.ClassificationRequest$ = ClassificationRequest$ = {})); - function classificationRequestToJSON(classificationRequest) { - return JSON.stringify(exports.ClassificationRequest$outboundSchema.parse(classificationRequest)); - } - function classificationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js - var require_classificationtargetresult = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationtargetresult.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationTargetResult$ = exports.ClassificationTargetResult$outboundSchema = exports.ClassificationTargetResult$inboundSchema = void 0; - exports.classificationTargetResultToJSON = classificationTargetResultToJSON; - exports.classificationTargetResultFromJSON = classificationTargetResultFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.ClassificationTargetResult$inboundSchema = z.object({ - scores: z.record(z.number()) - }); - exports.ClassificationTargetResult$outboundSchema = z.object({ - scores: z.record(z.number()) - }); - var ClassificationTargetResult$; - (function(ClassificationTargetResult$2) { - ClassificationTargetResult$2.inboundSchema = exports.ClassificationTargetResult$inboundSchema; - ClassificationTargetResult$2.outboundSchema = exports.ClassificationTargetResult$outboundSchema; - })(ClassificationTargetResult$ || (exports.ClassificationTargetResult$ = ClassificationTargetResult$ = {})); - function classificationTargetResultToJSON(classificationTargetResult) { - return JSON.stringify(exports.ClassificationTargetResult$outboundSchema.parse(classificationTargetResult)); - } - function classificationTargetResultFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationTargetResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationTargetResult' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classificationresponse.js - var require_classificationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classificationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassificationResponse$ = exports.ClassificationResponse$outboundSchema = exports.ClassificationResponse$inboundSchema = void 0; - exports.classificationResponseToJSON = classificationResponseToJSON; - exports.classificationResponseFromJSON = classificationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classificationtargetresult_js_1 = require_classificationtargetresult(); - exports.ClassificationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$inboundSchema)) - }); - exports.ClassificationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(classificationtargetresult_js_1.ClassificationTargetResult$outboundSchema)) - }); - var ClassificationResponse$; - (function(ClassificationResponse$2) { - ClassificationResponse$2.inboundSchema = exports.ClassificationResponse$inboundSchema; - ClassificationResponse$2.outboundSchema = exports.ClassificationResponse$outboundSchema; - })(ClassificationResponse$ || (exports.ClassificationResponse$ = ClassificationResponse$ = {})); - function classificationResponseToJSON(classificationResponse) { - return JSON.stringify(exports.ClassificationResponse$outboundSchema.parse(classificationResponse)); - } - function classificationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassificationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassificationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js - var require_ftclassifierlossfunction = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftclassifierlossfunction.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTClassifierLossFunction$ = exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema = exports.FTClassifierLossFunction = void 0; - var z = __importStar(require_zod()); - exports.FTClassifierLossFunction = { - SingleClass: "single_class", - MultiClass: "multi_class" - }; - exports.FTClassifierLossFunction$inboundSchema = z.nativeEnum(exports.FTClassifierLossFunction); - exports.FTClassifierLossFunction$outboundSchema = exports.FTClassifierLossFunction$inboundSchema; - var FTClassifierLossFunction$; - (function(FTClassifierLossFunction$2) { - FTClassifierLossFunction$2.inboundSchema = exports.FTClassifierLossFunction$inboundSchema; - FTClassifierLossFunction$2.outboundSchema = exports.FTClassifierLossFunction$outboundSchema; - })(FTClassifierLossFunction$ || (exports.FTClassifierLossFunction$ = FTClassifierLossFunction$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetout.js - var require_classifiertargetout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetOut$ = exports.ClassifierTargetOut$outboundSchema = exports.ClassifierTargetOut$inboundSchema = void 0; - exports.classifierTargetOutToJSON = classifierTargetOutToJSON; - exports.classifierTargetOutFromJSON = classifierTargetOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetOut$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - loss_function: ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetOut$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - lossFunction: ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetOut$; - (function(ClassifierTargetOut$2) { - ClassifierTargetOut$2.inboundSchema = exports.ClassifierTargetOut$inboundSchema; - ClassifierTargetOut$2.outboundSchema = exports.ClassifierTargetOut$outboundSchema; - })(ClassifierTargetOut$ || (exports.ClassifierTargetOut$ = ClassifierTargetOut$ = {})); - function classifierTargetOutToJSON(classifierTargetOut) { - return JSON.stringify(exports.ClassifierTargetOut$outboundSchema.parse(classifierTargetOut)); - } - function classifierTargetOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js - var require_classifiertrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParameters$ = exports.ClassifierTrainingParameters$outboundSchema = exports.ClassifierTrainingParameters$inboundSchema = void 0; - exports.classifierTrainingParametersToJSON = classifierTrainingParametersToJSON; - exports.classifierTrainingParametersFromJSON = classifierTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParameters$; - (function(ClassifierTrainingParameters$2) { - ClassifierTrainingParameters$2.inboundSchema = exports.ClassifierTrainingParameters$inboundSchema; - ClassifierTrainingParameters$2.outboundSchema = exports.ClassifierTrainingParameters$outboundSchema; - })(ClassifierTrainingParameters$ || (exports.ClassifierTrainingParameters$ = ClassifierTrainingParameters$ = {})); - function classifierTrainingParametersToJSON(classifierTrainingParameters) { - return JSON.stringify(exports.ClassifierTrainingParameters$outboundSchema.parse(classifierTrainingParameters)); - } - function classifierTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/eventout.js - var require_eventout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/eventout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventOut$ = exports.EventOut$outboundSchema = exports.EventOut$inboundSchema = void 0; - exports.eventOutToJSON = eventOutToJSON; - exports.eventOutFromJSON = eventOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.EventOut$inboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - created_at: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.EventOut$outboundSchema = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - createdAt: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var EventOut$; - (function(EventOut$2) { - EventOut$2.inboundSchema = exports.EventOut$inboundSchema; - EventOut$2.outboundSchema = exports.EventOut$outboundSchema; - })(EventOut$ || (exports.EventOut$ = EventOut$ = {})); - function eventOutToJSON(eventOut) { - return JSON.stringify(exports.EventOut$outboundSchema.parse(eventOut)); - } - function eventOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EventOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EventOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobmetadataout.js - var require_jobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobMetadataOut$ = exports.JobMetadataOut$outboundSchema = exports.JobMetadataOut$inboundSchema = void 0; - exports.jobMetadataOutToJSON = jobMetadataOutToJSON; - exports.jobMetadataOutFromJSON = jobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime" - }); - }); - exports.JobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time" - }); - }); - var JobMetadataOut$; - (function(JobMetadataOut$2) { - JobMetadataOut$2.inboundSchema = exports.JobMetadataOut$inboundSchema; - JobMetadataOut$2.outboundSchema = exports.JobMetadataOut$outboundSchema; - })(JobMetadataOut$ || (exports.JobMetadataOut$ = JobMetadataOut$ = {})); - function jobMetadataOutToJSON(jobMetadataOut) { - return JSON.stringify(exports.JobMetadataOut$outboundSchema.parse(jobMetadataOut)); - } - function jobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js - var require_wandbintegrationout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegrationout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegrationOut$ = exports.WandbIntegrationOut$outboundSchema = exports.WandbIntegrationOut$inboundSchema = exports.WandbIntegrationOutType$ = exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema = exports.WandbIntegrationOutType = void 0; - exports.wandbIntegrationOutToJSON = wandbIntegrationOutToJSON; - exports.wandbIntegrationOutFromJSON = wandbIntegrationOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationOutType = { - Wandb: "wandb" - }; - exports.WandbIntegrationOutType$inboundSchema = z.nativeEnum(exports.WandbIntegrationOutType); - exports.WandbIntegrationOutType$outboundSchema = exports.WandbIntegrationOutType$inboundSchema; - var WandbIntegrationOutType$; - (function(WandbIntegrationOutType$2) { - WandbIntegrationOutType$2.inboundSchema = exports.WandbIntegrationOutType$inboundSchema; - WandbIntegrationOutType$2.outboundSchema = exports.WandbIntegrationOutType$outboundSchema; - })(WandbIntegrationOutType$ || (exports.WandbIntegrationOutType$ = WandbIntegrationOutType$ = {})); - exports.WandbIntegrationOut$inboundSchema = z.object({ - type: exports.WandbIntegrationOutType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - run_name: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "run_name": "runName" - }); - }); - exports.WandbIntegrationOut$outboundSchema = z.object({ - type: exports.WandbIntegrationOutType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - runName: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - runName: "run_name" - }); - }); - var WandbIntegrationOut$; - (function(WandbIntegrationOut$2) { - WandbIntegrationOut$2.inboundSchema = exports.WandbIntegrationOut$inboundSchema; - WandbIntegrationOut$2.outboundSchema = exports.WandbIntegrationOut$outboundSchema; - })(WandbIntegrationOut$ || (exports.WandbIntegrationOut$ = WandbIntegrationOut$ = {})); - function wandbIntegrationOutToJSON(wandbIntegrationOut) { - return JSON.stringify(exports.WandbIntegrationOut$outboundSchema.parse(wandbIntegrationOut)); - } - function wandbIntegrationOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegrationOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegrationOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js - var require_classifierdetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierdetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierDetailedJobOut$ = exports.ClassifierDetailedJobOut$outboundSchema = exports.ClassifierDetailedJobOut$inboundSchema = exports.ClassifierDetailedJobOutJobType$ = exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema = exports.ClassifierDetailedJobOutIntegrations$ = exports.ClassifierDetailedJobOutIntegrations$outboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema = exports.ClassifierDetailedJobOutObject$ = exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema = exports.ClassifierDetailedJobOutStatus$ = exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema = exports.ClassifierDetailedJobOutJobType = exports.ClassifierDetailedJobOutObject = exports.ClassifierDetailedJobOutStatus = void 0; - exports.classifierDetailedJobOutIntegrationsToJSON = classifierDetailedJobOutIntegrationsToJSON; - exports.classifierDetailedJobOutIntegrationsFromJSON = classifierDetailedJobOutIntegrationsFromJSON; - exports.classifierDetailedJobOutToJSON = classifierDetailedJobOutToJSON; - exports.classifierDetailedJobOutFromJSON = classifierDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var eventout_js_1 = require_eventout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierDetailedJobOutObject = { - Job: "job" - }; - exports.ClassifierDetailedJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutStatus); - exports.ClassifierDetailedJobOutStatus$outboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - var ClassifierDetailedJobOutStatus$; - (function(ClassifierDetailedJobOutStatus$2) { - ClassifierDetailedJobOutStatus$2.inboundSchema = exports.ClassifierDetailedJobOutStatus$inboundSchema; - ClassifierDetailedJobOutStatus$2.outboundSchema = exports.ClassifierDetailedJobOutStatus$outboundSchema; - })(ClassifierDetailedJobOutStatus$ || (exports.ClassifierDetailedJobOutStatus$ = ClassifierDetailedJobOutStatus$ = {})); - exports.ClassifierDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutObject); - exports.ClassifierDetailedJobOutObject$outboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - var ClassifierDetailedJobOutObject$; - (function(ClassifierDetailedJobOutObject$2) { - ClassifierDetailedJobOutObject$2.inboundSchema = exports.ClassifierDetailedJobOutObject$inboundSchema; - ClassifierDetailedJobOutObject$2.outboundSchema = exports.ClassifierDetailedJobOutObject$outboundSchema; - })(ClassifierDetailedJobOutObject$ || (exports.ClassifierDetailedJobOutObject$ = ClassifierDetailedJobOutObject$ = {})); - exports.ClassifierDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierDetailedJobOutIntegrations$; - (function(ClassifierDetailedJobOutIntegrations$2) { - ClassifierDetailedJobOutIntegrations$2.inboundSchema = exports.ClassifierDetailedJobOutIntegrations$inboundSchema; - ClassifierDetailedJobOutIntegrations$2.outboundSchema = exports.ClassifierDetailedJobOutIntegrations$outboundSchema; - })(ClassifierDetailedJobOutIntegrations$ || (exports.ClassifierDetailedJobOutIntegrations$ = ClassifierDetailedJobOutIntegrations$ = {})); - function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations) { - return JSON.stringify(exports.ClassifierDetailedJobOutIntegrations$outboundSchema.parse(classifierDetailedJobOutIntegrations)); - } - function classifierDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOutIntegrations' from JSON`); - } - exports.ClassifierDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierDetailedJobOutJobType); - exports.ClassifierDetailedJobOutJobType$outboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - var ClassifierDetailedJobOutJobType$; - (function(ClassifierDetailedJobOutJobType$2) { - ClassifierDetailedJobOutJobType$2.inboundSchema = exports.ClassifierDetailedJobOutJobType$inboundSchema; - ClassifierDetailedJobOutJobType$2.outboundSchema = exports.ClassifierDetailedJobOutJobType$outboundSchema; - })(ClassifierDetailedJobOutJobType$ || (exports.ClassifierDetailedJobOutJobType$ = ClassifierDetailedJobOutJobType$ = {})); - exports.ClassifierDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierDetailedJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema, - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.ClassifierDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierDetailedJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema, - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var ClassifierDetailedJobOut$; - (function(ClassifierDetailedJobOut$2) { - ClassifierDetailedJobOut$2.inboundSchema = exports.ClassifierDetailedJobOut$inboundSchema; - ClassifierDetailedJobOut$2.outboundSchema = exports.ClassifierDetailedJobOut$outboundSchema; - })(ClassifierDetailedJobOut$ || (exports.ClassifierDetailedJobOut$ = ClassifierDetailedJobOut$ = {})); - function classifierDetailedJobOutToJSON(classifierDetailedJobOut) { - return JSON.stringify(exports.ClassifierDetailedJobOut$outboundSchema.parse(classifierDetailedJobOut)); - } - function classifierDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js - var require_ftmodelcapabilitiesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcapabilitiesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCapabilitiesOut$ = exports.FTModelCapabilitiesOut$outboundSchema = exports.FTModelCapabilitiesOut$inboundSchema = void 0; - exports.ftModelCapabilitiesOutToJSON = ftModelCapabilitiesOutToJSON; - exports.ftModelCapabilitiesOutFromJSON = ftModelCapabilitiesOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FTModelCapabilitiesOut$inboundSchema = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(false), - fine_tuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning" - }); - }); - exports.FTModelCapabilitiesOut$outboundSchema = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(false), - fineTuning: z.boolean().default(false), - classification: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning" - }); - }); - var FTModelCapabilitiesOut$; - (function(FTModelCapabilitiesOut$2) { - FTModelCapabilitiesOut$2.inboundSchema = exports.FTModelCapabilitiesOut$inboundSchema; - FTModelCapabilitiesOut$2.outboundSchema = exports.FTModelCapabilitiesOut$outboundSchema; - })(FTModelCapabilitiesOut$ || (exports.FTModelCapabilitiesOut$ = FTModelCapabilitiesOut$ = {})); - function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut) { - return JSON.stringify(exports.FTModelCapabilitiesOut$outboundSchema.parse(ftModelCapabilitiesOut)); - } - function ftModelCapabilitiesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCapabilitiesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCapabilitiesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js - var require_classifierftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierFTModelOut$ = exports.ClassifierFTModelOut$outboundSchema = exports.ClassifierFTModelOut$inboundSchema = exports.ClassifierFTModelOutModelType$ = exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema = exports.ClassifierFTModelOutObject$ = exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema = exports.ClassifierFTModelOutModelType = exports.ClassifierFTModelOutObject = void 0; - exports.classifierFTModelOutToJSON = classifierFTModelOutToJSON; - exports.classifierFTModelOutFromJSON = classifierFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetout_js_1 = require_classifiertargetout(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.ClassifierFTModelOutObject = { - Model: "model" - }; - exports.ClassifierFTModelOutModelType = { - Classifier: "classifier" - }; - exports.ClassifierFTModelOutObject$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutObject); - exports.ClassifierFTModelOutObject$outboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - var ClassifierFTModelOutObject$; - (function(ClassifierFTModelOutObject$2) { - ClassifierFTModelOutObject$2.inboundSchema = exports.ClassifierFTModelOutObject$inboundSchema; - ClassifierFTModelOutObject$2.outboundSchema = exports.ClassifierFTModelOutObject$outboundSchema; - })(ClassifierFTModelOutObject$ || (exports.ClassifierFTModelOutObject$ = ClassifierFTModelOutObject$ = {})); - exports.ClassifierFTModelOutModelType$inboundSchema = z.nativeEnum(exports.ClassifierFTModelOutModelType); - exports.ClassifierFTModelOutModelType$outboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - var ClassifierFTModelOutModelType$; - (function(ClassifierFTModelOutModelType$2) { - ClassifierFTModelOutModelType$2.inboundSchema = exports.ClassifierFTModelOutModelType$inboundSchema; - ClassifierFTModelOutModelType$2.outboundSchema = exports.ClassifierFTModelOutModelType$outboundSchema; - })(ClassifierFTModelOutModelType$ || (exports.ClassifierFTModelOutModelType$ = ClassifierFTModelOutModelType$ = {})); - exports.ClassifierFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifier_targets: z.array(classifiertargetout_js_1.ClassifierTargetOut$inboundSchema), - model_type: exports.ClassifierFTModelOutModelType$inboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "classifier_targets": "classifierTargets", - "model_type": "modelType" - }); - }); - exports.ClassifierFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.ClassifierFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifierTargets: z.array(classifiertargetout_js_1.ClassifierTargetOut$outboundSchema), - modelType: exports.ClassifierFTModelOutModelType$outboundSchema.default("classifier") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - classifierTargets: "classifier_targets", - modelType: "model_type" - }); - }); - var ClassifierFTModelOut$; - (function(ClassifierFTModelOut$2) { - ClassifierFTModelOut$2.inboundSchema = exports.ClassifierFTModelOut$inboundSchema; - ClassifierFTModelOut$2.outboundSchema = exports.ClassifierFTModelOut$outboundSchema; - })(ClassifierFTModelOut$ || (exports.ClassifierFTModelOut$ = ClassifierFTModelOut$ = {})); - function classifierFTModelOutToJSON(classifierFTModelOut) { - return JSON.stringify(exports.ClassifierFTModelOut$outboundSchema.parse(classifierFTModelOut)); - } - function classifierFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifierjobout.js - var require_classifierjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifierjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierJobOut$ = exports.ClassifierJobOut$outboundSchema = exports.ClassifierJobOut$inboundSchema = exports.ClassifierJobOutJobType$ = exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema = exports.ClassifierJobOutIntegrations$ = exports.ClassifierJobOutIntegrations$outboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema = exports.ClassifierJobOutObject$ = exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema = exports.ClassifierJobOutStatus$ = exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema = exports.ClassifierJobOutJobType = exports.ClassifierJobOutObject = exports.ClassifierJobOutStatus = void 0; - exports.classifierJobOutIntegrationsToJSON = classifierJobOutIntegrationsToJSON; - exports.classifierJobOutIntegrationsFromJSON = classifierJobOutIntegrationsFromJSON; - exports.classifierJobOutToJSON = classifierJobOutToJSON; - exports.classifierJobOutFromJSON = classifierJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertrainingparameters_js_1 = require_classifiertrainingparameters(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.ClassifierJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.ClassifierJobOutObject = { - Job: "job" - }; - exports.ClassifierJobOutJobType = { - Classifier: "classifier" - }; - exports.ClassifierJobOutStatus$inboundSchema = z.nativeEnum(exports.ClassifierJobOutStatus); - exports.ClassifierJobOutStatus$outboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - var ClassifierJobOutStatus$; - (function(ClassifierJobOutStatus$2) { - ClassifierJobOutStatus$2.inboundSchema = exports.ClassifierJobOutStatus$inboundSchema; - ClassifierJobOutStatus$2.outboundSchema = exports.ClassifierJobOutStatus$outboundSchema; - })(ClassifierJobOutStatus$ || (exports.ClassifierJobOutStatus$ = ClassifierJobOutStatus$ = {})); - exports.ClassifierJobOutObject$inboundSchema = z.nativeEnum(exports.ClassifierJobOutObject); - exports.ClassifierJobOutObject$outboundSchema = exports.ClassifierJobOutObject$inboundSchema; - var ClassifierJobOutObject$; - (function(ClassifierJobOutObject$2) { - ClassifierJobOutObject$2.inboundSchema = exports.ClassifierJobOutObject$inboundSchema; - ClassifierJobOutObject$2.outboundSchema = exports.ClassifierJobOutObject$outboundSchema; - })(ClassifierJobOutObject$ || (exports.ClassifierJobOutObject$ = ClassifierJobOutObject$ = {})); - exports.ClassifierJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.ClassifierJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var ClassifierJobOutIntegrations$; - (function(ClassifierJobOutIntegrations$2) { - ClassifierJobOutIntegrations$2.inboundSchema = exports.ClassifierJobOutIntegrations$inboundSchema; - ClassifierJobOutIntegrations$2.outboundSchema = exports.ClassifierJobOutIntegrations$outboundSchema; - })(ClassifierJobOutIntegrations$ || (exports.ClassifierJobOutIntegrations$ = ClassifierJobOutIntegrations$ = {})); - function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations) { - return JSON.stringify(exports.ClassifierJobOutIntegrations$outboundSchema.parse(classifierJobOutIntegrations)); - } - function classifierJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOutIntegrations' from JSON`); - } - exports.ClassifierJobOutJobType$inboundSchema = z.nativeEnum(exports.ClassifierJobOutJobType); - exports.ClassifierJobOutJobType$outboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - var ClassifierJobOutJobType$; - (function(ClassifierJobOutJobType$2) { - ClassifierJobOutJobType$2.inboundSchema = exports.ClassifierJobOutJobType$inboundSchema; - ClassifierJobOutJobType$2.outboundSchema = exports.ClassifierJobOutJobType$outboundSchema; - })(ClassifierJobOutJobType$ || (exports.ClassifierJobOutJobType$ = ClassifierJobOutJobType$ = {})); - exports.ClassifierJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.ClassifierJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.ClassifierJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.ClassifierJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.ClassifierJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.ClassifierJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: classifiertrainingparameters_js_1.ClassifierTrainingParameters$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var ClassifierJobOut$; - (function(ClassifierJobOut$2) { - ClassifierJobOut$2.inboundSchema = exports.ClassifierJobOut$inboundSchema; - ClassifierJobOut$2.outboundSchema = exports.ClassifierJobOut$outboundSchema; - })(ClassifierJobOut$ || (exports.ClassifierJobOut$ = ClassifierJobOut$ = {})); - function classifierJobOutToJSON(classifierJobOut) { - return JSON.stringify(exports.ClassifierJobOut$outboundSchema.parse(classifierJobOut)); - } - function classifierJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertargetin.js - var require_classifiertargetin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertargetin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTargetIn$ = exports.ClassifierTargetIn$outboundSchema = exports.ClassifierTargetIn$inboundSchema = void 0; - exports.classifierTargetInToJSON = classifierTargetInToJSON; - exports.classifierTargetInFromJSON = classifierTargetInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftclassifierlossfunction_js_1 = require_ftclassifierlossfunction(); - exports.ClassifierTargetIn$inboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - loss_function: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "loss_function": "lossFunction" - }); - }); - exports.ClassifierTargetIn$outboundSchema = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - lossFunction: z.nullable(ftclassifierlossfunction_js_1.FTClassifierLossFunction$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - lossFunction: "loss_function" - }); - }); - var ClassifierTargetIn$; - (function(ClassifierTargetIn$2) { - ClassifierTargetIn$2.inboundSchema = exports.ClassifierTargetIn$inboundSchema; - ClassifierTargetIn$2.outboundSchema = exports.ClassifierTargetIn$outboundSchema; - })(ClassifierTargetIn$ || (exports.ClassifierTargetIn$ = ClassifierTargetIn$ = {})); - function classifierTargetInToJSON(classifierTargetIn) { - return JSON.stringify(exports.ClassifierTargetIn$outboundSchema.parse(classifierTargetIn)); - } - function classifierTargetInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTargetIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTargetIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js - var require_classifiertrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/classifiertrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ClassifierTrainingParametersIn$ = exports.ClassifierTrainingParametersIn$outboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema = void 0; - exports.classifierTrainingParametersInToJSON = classifierTrainingParametersInToJSON; - exports.classifierTrainingParametersInFromJSON = classifierTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ClassifierTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen" - }); - }); - exports.ClassifierTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len" - }); - }); - var ClassifierTrainingParametersIn$; - (function(ClassifierTrainingParametersIn$2) { - ClassifierTrainingParametersIn$2.inboundSchema = exports.ClassifierTrainingParametersIn$inboundSchema; - ClassifierTrainingParametersIn$2.outboundSchema = exports.ClassifierTrainingParametersIn$outboundSchema; - })(ClassifierTrainingParametersIn$ || (exports.ClassifierTrainingParametersIn$ = ClassifierTrainingParametersIn$ = {})); - function classifierTrainingParametersInToJSON(classifierTrainingParametersIn) { - return JSON.stringify(exports.ClassifierTrainingParametersIn$outboundSchema.parse(classifierTrainingParametersIn)); - } - function classifierTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ClassifierTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ClassifierTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deltamessage.js - var require_deltamessage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deltamessage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeltaMessage$ = exports.DeltaMessage$outboundSchema = exports.DeltaMessage$inboundSchema = exports.Content$ = exports.Content$outboundSchema = exports.Content$inboundSchema = void 0; - exports.contentToJSON = contentToJSON; - exports.contentFromJSON = contentFromJSON; - exports.deltaMessageToJSON = deltaMessageToJSON; - exports.deltaMessageFromJSON = deltaMessageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var contentchunk_js_1 = require_contentchunk(); - var toolcall_js_1 = require_toolcall(); - exports.Content$inboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)]); - exports.Content$outboundSchema = z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)]); - var Content$; - (function(Content$2) { - Content$2.inboundSchema = exports.Content$inboundSchema; - Content$2.outboundSchema = exports.Content$outboundSchema; - })(Content$ || (exports.Content$ = Content$ = {})); - function contentToJSON(content) { - return JSON.stringify(exports.Content$outboundSchema.parse(content)); - } - function contentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Content$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Content' from JSON`); - } - exports.DeltaMessage$inboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$inboundSchema)])).optional(), - tool_calls: z.nullable(z.array(toolcall_js_1.ToolCall$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "tool_calls": "toolCalls" - }); - }); - exports.DeltaMessage$outboundSchema = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable(z.union([z.string(), z.array(contentchunk_js_1.ContentChunk$outboundSchema)])).optional(), - toolCalls: z.nullable(z.array(toolcall_js_1.ToolCall$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - toolCalls: "tool_calls" - }); - }); - var DeltaMessage$; - (function(DeltaMessage$2) { - DeltaMessage$2.inboundSchema = exports.DeltaMessage$inboundSchema; - DeltaMessage$2.outboundSchema = exports.DeltaMessage$outboundSchema; - })(DeltaMessage$ || (exports.DeltaMessage$ = DeltaMessage$ = {})); - function deltaMessageToJSON(deltaMessage) { - return JSON.stringify(exports.DeltaMessage$outboundSchema.parse(deltaMessage)); - } - function deltaMessageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeltaMessage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeltaMessage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js - var require_completionresponsestreamchoice = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionresponsestreamchoice.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionResponseStreamChoice$ = exports.CompletionResponseStreamChoice$outboundSchema = exports.CompletionResponseStreamChoice$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$ = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = exports.CompletionResponseStreamChoiceFinishReason = void 0; - exports.completionResponseStreamChoiceToJSON = completionResponseStreamChoiceToJSON; - exports.completionResponseStreamChoiceFromJSON = completionResponseStreamChoiceFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var enums_js_1 = require_enums(); - var deltamessage_js_1 = require_deltamessage(); - exports.CompletionResponseStreamChoiceFinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls" - }; - exports.CompletionResponseStreamChoiceFinishReason$inboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.CompletionResponseStreamChoiceFinishReason$outboundSchema = z.union([ - z.nativeEnum(exports.CompletionResponseStreamChoiceFinishReason), - z.string().and(z.custom()) - ]); - var CompletionResponseStreamChoiceFinishReason$; - (function(CompletionResponseStreamChoiceFinishReason$2) { - CompletionResponseStreamChoiceFinishReason$2.inboundSchema = exports.CompletionResponseStreamChoiceFinishReason$inboundSchema; - CompletionResponseStreamChoiceFinishReason$2.outboundSchema = exports.CompletionResponseStreamChoiceFinishReason$outboundSchema; - })(CompletionResponseStreamChoiceFinishReason$ || (exports.CompletionResponseStreamChoiceFinishReason$ = CompletionResponseStreamChoiceFinishReason$ = {})); - exports.CompletionResponseStreamChoice$inboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$inboundSchema, - finish_reason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "finish_reason": "finishReason" - }); - }); - exports.CompletionResponseStreamChoice$outboundSchema = z.object({ - index: z.number().int(), - delta: deltamessage_js_1.DeltaMessage$outboundSchema, - finishReason: z.nullable(exports.CompletionResponseStreamChoiceFinishReason$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - finishReason: "finish_reason" - }); - }); - var CompletionResponseStreamChoice$; - (function(CompletionResponseStreamChoice$2) { - CompletionResponseStreamChoice$2.inboundSchema = exports.CompletionResponseStreamChoice$inboundSchema; - CompletionResponseStreamChoice$2.outboundSchema = exports.CompletionResponseStreamChoice$outboundSchema; - })(CompletionResponseStreamChoice$ || (exports.CompletionResponseStreamChoice$ = CompletionResponseStreamChoice$ = {})); - function completionResponseStreamChoiceToJSON(completionResponseStreamChoice) { - return JSON.stringify(exports.CompletionResponseStreamChoice$outboundSchema.parse(completionResponseStreamChoice)); - } - function completionResponseStreamChoiceFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionResponseStreamChoice' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionchunk.js - var require_completionchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionChunk$ = exports.CompletionChunk$outboundSchema = exports.CompletionChunk$inboundSchema = void 0; - exports.completionChunkToJSON = completionChunkToJSON; - exports.completionChunkFromJSON = completionChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionresponsestreamchoice_js_1 = require_completionresponsestreamchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.CompletionChunk$inboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$inboundSchema) - }); - exports.CompletionChunk$outboundSchema = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema.optional(), - choices: z.array(completionresponsestreamchoice_js_1.CompletionResponseStreamChoice$outboundSchema) - }); - var CompletionChunk$; - (function(CompletionChunk$2) { - CompletionChunk$2.inboundSchema = exports.CompletionChunk$inboundSchema; - CompletionChunk$2.outboundSchema = exports.CompletionChunk$outboundSchema; - })(CompletionChunk$ || (exports.CompletionChunk$ = CompletionChunk$ = {})); - function completionChunkToJSON(completionChunk) { - return JSON.stringify(exports.CompletionChunk$outboundSchema.parse(completionChunk)); - } - function completionChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js - var require_completiontrainingparameters = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparameters.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParameters$ = exports.CompletionTrainingParameters$outboundSchema = exports.CompletionTrainingParameters$inboundSchema = void 0; - exports.completionTrainingParametersToJSON = completionTrainingParametersToJSON; - exports.completionTrainingParametersFromJSON = completionTrainingParametersFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParameters$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParameters$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParameters$; - (function(CompletionTrainingParameters$2) { - CompletionTrainingParameters$2.inboundSchema = exports.CompletionTrainingParameters$inboundSchema; - CompletionTrainingParameters$2.outboundSchema = exports.CompletionTrainingParameters$outboundSchema; - })(CompletionTrainingParameters$ || (exports.CompletionTrainingParameters$ = CompletionTrainingParameters$ = {})); - function completionTrainingParametersToJSON(completionTrainingParameters) { - return JSON.stringify(exports.CompletionTrainingParameters$outboundSchema.parse(completionTrainingParameters)); - } - function completionTrainingParametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParameters' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js - var require_githubrepositoryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryOut$ = exports.GithubRepositoryOut$outboundSchema = exports.GithubRepositoryOut$inboundSchema = exports.GithubRepositoryOutType$ = exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema = exports.GithubRepositoryOutType = void 0; - exports.githubRepositoryOutToJSON = githubRepositoryOutToJSON; - exports.githubRepositoryOutFromJSON = githubRepositoryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryOutType = { - Github: "github" - }; - exports.GithubRepositoryOutType$inboundSchema = z.nativeEnum(exports.GithubRepositoryOutType); - exports.GithubRepositoryOutType$outboundSchema = exports.GithubRepositoryOutType$inboundSchema; - var GithubRepositoryOutType$; - (function(GithubRepositoryOutType$2) { - GithubRepositoryOutType$2.inboundSchema = exports.GithubRepositoryOutType$inboundSchema; - GithubRepositoryOutType$2.outboundSchema = exports.GithubRepositoryOutType$outboundSchema; - })(GithubRepositoryOutType$ || (exports.GithubRepositoryOutType$ = GithubRepositoryOutType$ = {})); - exports.GithubRepositoryOut$inboundSchema = z.object({ - type: exports.GithubRepositoryOutType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commit_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "commit_id": "commitId" - }); - }); - exports.GithubRepositoryOut$outboundSchema = z.object({ - type: exports.GithubRepositoryOutType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commitId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - commitId: "commit_id" - }); - }); - var GithubRepositoryOut$; - (function(GithubRepositoryOut$2) { - GithubRepositoryOut$2.inboundSchema = exports.GithubRepositoryOut$inboundSchema; - GithubRepositoryOut$2.outboundSchema = exports.GithubRepositoryOut$outboundSchema; - })(GithubRepositoryOut$ || (exports.GithubRepositoryOut$ = GithubRepositoryOut$ = {})); - function githubRepositoryOutToJSON(githubRepositoryOut) { - return JSON.stringify(exports.GithubRepositoryOut$outboundSchema.parse(githubRepositoryOut)); - } - function githubRepositoryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js - var require_completiondetailedjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiondetailedjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionDetailedJobOut$ = exports.CompletionDetailedJobOut$outboundSchema = exports.CompletionDetailedJobOut$inboundSchema = exports.CompletionDetailedJobOutRepositories$ = exports.CompletionDetailedJobOutRepositories$outboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema = exports.CompletionDetailedJobOutJobType$ = exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema = exports.CompletionDetailedJobOutIntegrations$ = exports.CompletionDetailedJobOutIntegrations$outboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema = exports.CompletionDetailedJobOutObject$ = exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema = exports.CompletionDetailedJobOutStatus$ = exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema = exports.CompletionDetailedJobOutJobType = exports.CompletionDetailedJobOutObject = exports.CompletionDetailedJobOutStatus = void 0; - exports.completionDetailedJobOutIntegrationsToJSON = completionDetailedJobOutIntegrationsToJSON; - exports.completionDetailedJobOutIntegrationsFromJSON = completionDetailedJobOutIntegrationsFromJSON; - exports.completionDetailedJobOutRepositoriesToJSON = completionDetailedJobOutRepositoriesToJSON; - exports.completionDetailedJobOutRepositoriesFromJSON = completionDetailedJobOutRepositoriesFromJSON; - exports.completionDetailedJobOutToJSON = completionDetailedJobOutToJSON; - exports.completionDetailedJobOutFromJSON = completionDetailedJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var checkpointout_js_1 = require_checkpointout(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var eventout_js_1 = require_eventout(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.CompletionDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionDetailedJobOutObject = { - Job: "job" - }; - exports.CompletionDetailedJobOutJobType = { - Completion: "completion" - }; - exports.CompletionDetailedJobOutStatus$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutStatus); - exports.CompletionDetailedJobOutStatus$outboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - var CompletionDetailedJobOutStatus$; - (function(CompletionDetailedJobOutStatus$2) { - CompletionDetailedJobOutStatus$2.inboundSchema = exports.CompletionDetailedJobOutStatus$inboundSchema; - CompletionDetailedJobOutStatus$2.outboundSchema = exports.CompletionDetailedJobOutStatus$outboundSchema; - })(CompletionDetailedJobOutStatus$ || (exports.CompletionDetailedJobOutStatus$ = CompletionDetailedJobOutStatus$ = {})); - exports.CompletionDetailedJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutObject); - exports.CompletionDetailedJobOutObject$outboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - var CompletionDetailedJobOutObject$; - (function(CompletionDetailedJobOutObject$2) { - CompletionDetailedJobOutObject$2.inboundSchema = exports.CompletionDetailedJobOutObject$inboundSchema; - CompletionDetailedJobOutObject$2.outboundSchema = exports.CompletionDetailedJobOutObject$outboundSchema; - })(CompletionDetailedJobOutObject$ || (exports.CompletionDetailedJobOutObject$ = CompletionDetailedJobOutObject$ = {})); - exports.CompletionDetailedJobOutIntegrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.CompletionDetailedJobOutIntegrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var CompletionDetailedJobOutIntegrations$; - (function(CompletionDetailedJobOutIntegrations$2) { - CompletionDetailedJobOutIntegrations$2.inboundSchema = exports.CompletionDetailedJobOutIntegrations$inboundSchema; - CompletionDetailedJobOutIntegrations$2.outboundSchema = exports.CompletionDetailedJobOutIntegrations$outboundSchema; - })(CompletionDetailedJobOutIntegrations$ || (exports.CompletionDetailedJobOutIntegrations$ = CompletionDetailedJobOutIntegrations$ = {})); - function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations) { - return JSON.stringify(exports.CompletionDetailedJobOutIntegrations$outboundSchema.parse(completionDetailedJobOutIntegrations)); - } - function completionDetailedJobOutIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutIntegrations' from JSON`); - } - exports.CompletionDetailedJobOutJobType$inboundSchema = z.nativeEnum(exports.CompletionDetailedJobOutJobType); - exports.CompletionDetailedJobOutJobType$outboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - var CompletionDetailedJobOutJobType$; - (function(CompletionDetailedJobOutJobType$2) { - CompletionDetailedJobOutJobType$2.inboundSchema = exports.CompletionDetailedJobOutJobType$inboundSchema; - CompletionDetailedJobOutJobType$2.outboundSchema = exports.CompletionDetailedJobOutJobType$outboundSchema; - })(CompletionDetailedJobOutJobType$ || (exports.CompletionDetailedJobOutJobType$ = CompletionDetailedJobOutJobType$ = {})); - exports.CompletionDetailedJobOutRepositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.CompletionDetailedJobOutRepositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var CompletionDetailedJobOutRepositories$; - (function(CompletionDetailedJobOutRepositories$2) { - CompletionDetailedJobOutRepositories$2.inboundSchema = exports.CompletionDetailedJobOutRepositories$inboundSchema; - CompletionDetailedJobOutRepositories$2.outboundSchema = exports.CompletionDetailedJobOutRepositories$outboundSchema; - })(CompletionDetailedJobOutRepositories$ || (exports.CompletionDetailedJobOutRepositories$ = CompletionDetailedJobOutRepositories$ = {})); - function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories) { - return JSON.stringify(exports.CompletionDetailedJobOutRepositories$outboundSchema.parse(completionDetailedJobOutRepositories)); - } - function completionDetailedJobOutRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOutRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOutRepositories' from JSON`); - } - exports.CompletionDetailedJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.CompletionDetailedJobOutJobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$inboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionDetailedJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.CompletionDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.CompletionDetailedJobOutJobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional(), - events: z.array(eventout_js_1.EventOut$outboundSchema).optional(), - checkpoints: z.array(checkpointout_js_1.CheckpointOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionDetailedJobOut$; - (function(CompletionDetailedJobOut$2) { - CompletionDetailedJobOut$2.inboundSchema = exports.CompletionDetailedJobOut$inboundSchema; - CompletionDetailedJobOut$2.outboundSchema = exports.CompletionDetailedJobOut$outboundSchema; - })(CompletionDetailedJobOut$ || (exports.CompletionDetailedJobOut$ = CompletionDetailedJobOut$ = {})); - function completionDetailedJobOutToJSON(completionDetailedJobOut) { - return JSON.stringify(exports.CompletionDetailedJobOut$outboundSchema.parse(completionDetailedJobOut)); - } - function completionDetailedJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionDetailedJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionDetailedJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionevent.js - var require_completionevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionEvent$ = exports.CompletionEvent$outboundSchema = exports.CompletionEvent$inboundSchema = void 0; - exports.completionEventToJSON = completionEventToJSON; - exports.completionEventFromJSON = completionEventFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var completionchunk_js_1 = require_completionchunk(); - exports.CompletionEvent$inboundSchema = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(completionchunk_js_1.CompletionChunk$inboundSchema) - }); - exports.CompletionEvent$outboundSchema = z.object({ - data: completionchunk_js_1.CompletionChunk$outboundSchema - }); - var CompletionEvent$; - (function(CompletionEvent$2) { - CompletionEvent$2.inboundSchema = exports.CompletionEvent$inboundSchema; - CompletionEvent$2.outboundSchema = exports.CompletionEvent$outboundSchema; - })(CompletionEvent$ || (exports.CompletionEvent$ = CompletionEvent$ = {})); - function completionEventToJSON(completionEvent) { - return JSON.stringify(exports.CompletionEvent$outboundSchema.parse(completionEvent)); - } - function completionEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionftmodelout.js - var require_completionftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionFTModelOut$ = exports.CompletionFTModelOut$outboundSchema = exports.CompletionFTModelOut$inboundSchema = exports.ModelType$ = exports.ModelType$outboundSchema = exports.ModelType$inboundSchema = exports.CompletionFTModelOutObject$ = exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema = exports.ModelType = exports.CompletionFTModelOutObject = void 0; - exports.completionFTModelOutToJSON = completionFTModelOutToJSON; - exports.completionFTModelOutFromJSON = completionFTModelOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ftmodelcapabilitiesout_js_1 = require_ftmodelcapabilitiesout(); - exports.CompletionFTModelOutObject = { - Model: "model" - }; - exports.ModelType = { - Completion: "completion" - }; - exports.CompletionFTModelOutObject$inboundSchema = z.nativeEnum(exports.CompletionFTModelOutObject); - exports.CompletionFTModelOutObject$outboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - var CompletionFTModelOutObject$; - (function(CompletionFTModelOutObject$2) { - CompletionFTModelOutObject$2.inboundSchema = exports.CompletionFTModelOutObject$inboundSchema; - CompletionFTModelOutObject$2.outboundSchema = exports.CompletionFTModelOutObject$outboundSchema; - })(CompletionFTModelOutObject$ || (exports.CompletionFTModelOutObject$ = CompletionFTModelOutObject$ = {})); - exports.ModelType$inboundSchema = z.nativeEnum(exports.ModelType); - exports.ModelType$outboundSchema = exports.ModelType$inboundSchema; - var ModelType$; - (function(ModelType$2) { - ModelType$2.inboundSchema = exports.ModelType$inboundSchema; - ModelType$2.outboundSchema = exports.ModelType$outboundSchema; - })(ModelType$ || (exports.ModelType$ = ModelType$ = {})); - exports.CompletionFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - model_type: exports.ModelType$inboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "model_type": "modelType" - }); - }); - exports.CompletionFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.CompletionFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: ftmodelcapabilitiesout_js_1.FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - modelType: exports.ModelType$outboundSchema.default("completion") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - modelType: "model_type" - }); - }); - var CompletionFTModelOut$; - (function(CompletionFTModelOut$2) { - CompletionFTModelOut$2.inboundSchema = exports.CompletionFTModelOut$inboundSchema; - CompletionFTModelOut$2.outboundSchema = exports.CompletionFTModelOut$outboundSchema; - })(CompletionFTModelOut$ || (exports.CompletionFTModelOut$ = CompletionFTModelOut$ = {})); - function completionFTModelOutToJSON(completionFTModelOut) { - return JSON.stringify(exports.CompletionFTModelOut$outboundSchema.parse(completionFTModelOut)); - } - function completionFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completionjobout.js - var require_completionjobout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completionjobout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionJobOut$ = exports.CompletionJobOut$outboundSchema = exports.CompletionJobOut$inboundSchema = exports.Repositories$ = exports.Repositories$outboundSchema = exports.Repositories$inboundSchema = exports.JobType$ = exports.JobType$outboundSchema = exports.JobType$inboundSchema = exports.Integrations$ = exports.Integrations$outboundSchema = exports.Integrations$inboundSchema = exports.CompletionJobOutObject$ = exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.JobType = exports.CompletionJobOutObject = exports.Status = void 0; - exports.integrationsToJSON = integrationsToJSON; - exports.integrationsFromJSON = integrationsFromJSON; - exports.repositoriesToJSON = repositoriesToJSON; - exports.repositoriesFromJSON = repositoriesFromJSON; - exports.completionJobOutToJSON = completionJobOutToJSON; - exports.completionJobOutFromJSON = completionJobOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completiontrainingparameters_js_1 = require_completiontrainingparameters(); - var githubrepositoryout_js_1 = require_githubrepositoryout(); - var jobmetadataout_js_1 = require_jobmetadataout(); - var wandbintegrationout_js_1 = require_wandbintegrationout(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.CompletionJobOutObject = { - Job: "job" - }; - exports.JobType = { - Completion: "completion" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.CompletionJobOutObject$inboundSchema = z.nativeEnum(exports.CompletionJobOutObject); - exports.CompletionJobOutObject$outboundSchema = exports.CompletionJobOutObject$inboundSchema; - var CompletionJobOutObject$; - (function(CompletionJobOutObject$2) { - CompletionJobOutObject$2.inboundSchema = exports.CompletionJobOutObject$inboundSchema; - CompletionJobOutObject$2.outboundSchema = exports.CompletionJobOutObject$outboundSchema; - })(CompletionJobOutObject$ || (exports.CompletionJobOutObject$ = CompletionJobOutObject$ = {})); - exports.Integrations$inboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema; - exports.Integrations$outboundSchema = wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema; - var Integrations$; - (function(Integrations$2) { - Integrations$2.inboundSchema = exports.Integrations$inboundSchema; - Integrations$2.outboundSchema = exports.Integrations$outboundSchema; - })(Integrations$ || (exports.Integrations$ = Integrations$ = {})); - function integrationsToJSON(integrations) { - return JSON.stringify(exports.Integrations$outboundSchema.parse(integrations)); - } - function integrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Integrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Integrations' from JSON`); - } - exports.JobType$inboundSchema = z.nativeEnum(exports.JobType); - exports.JobType$outboundSchema = exports.JobType$inboundSchema; - var JobType$; - (function(JobType$2) { - JobType$2.inboundSchema = exports.JobType$inboundSchema; - JobType$2.outboundSchema = exports.JobType$outboundSchema; - })(JobType$ || (exports.JobType$ = JobType$ = {})); - exports.Repositories$inboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema; - exports.Repositories$outboundSchema = githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema; - var Repositories$; - (function(Repositories$2) { - Repositories$2.inboundSchema = exports.Repositories$inboundSchema; - Repositories$2.outboundSchema = exports.Repositories$outboundSchema; - })(Repositories$ || (exports.Repositories$ = Repositories$ = {})); - function repositoriesToJSON(repositories) { - return JSON.stringify(exports.Repositories$outboundSchema.parse(repositories)); - } - function repositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Repositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Repositories' from JSON`); - } - exports.CompletionJobOut$inboundSchema = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: exports.Status$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$inboundSchema)).optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$inboundSchema).optional(), - job_type: exports.JobType$inboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$inboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType" - }); - }); - exports.CompletionJobOut$outboundSchema = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: exports.Status$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: exports.CompletionJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegrationout_js_1.WandbIntegrationOut$outboundSchema)).optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(jobmetadataout_js_1.JobMetadataOut$outboundSchema).optional(), - jobType: exports.JobType$outboundSchema.default("completion"), - hyperparameters: completiontrainingparameters_js_1.CompletionTrainingParameters$outboundSchema, - repositories: z.array(githubrepositoryout_js_1.GithubRepositoryOut$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type" - }); - }); - var CompletionJobOut$; - (function(CompletionJobOut$2) { - CompletionJobOut$2.inboundSchema = exports.CompletionJobOut$inboundSchema; - CompletionJobOut$2.outboundSchema = exports.CompletionJobOut$outboundSchema; - })(CompletionJobOut$ || (exports.CompletionJobOut$ = CompletionJobOut$ = {})); - function completionJobOutToJSON(completionJobOut) { - return JSON.stringify(exports.CompletionJobOut$outboundSchema.parse(completionJobOut)); - } - function completionJobOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionJobOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionJobOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js - var require_completiontrainingparametersin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/completiontrainingparametersin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.CompletionTrainingParametersIn$ = exports.CompletionTrainingParametersIn$outboundSchema = exports.CompletionTrainingParametersIn$inboundSchema = void 0; - exports.completionTrainingParametersInToJSON = completionTrainingParametersInToJSON; - exports.completionTrainingParametersInFromJSON = completionTrainingParametersInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.CompletionTrainingParametersIn$inboundSchema = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(1e-4), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio" - }); - }); - exports.CompletionTrainingParametersIn$outboundSchema = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(1e-4), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio" - }); - }); - var CompletionTrainingParametersIn$; - (function(CompletionTrainingParametersIn$2) { - CompletionTrainingParametersIn$2.inboundSchema = exports.CompletionTrainingParametersIn$inboundSchema; - CompletionTrainingParametersIn$2.outboundSchema = exports.CompletionTrainingParametersIn$outboundSchema; - })(CompletionTrainingParametersIn$ || (exports.CompletionTrainingParametersIn$ = CompletionTrainingParametersIn$ = {})); - function completionTrainingParametersInToJSON(completionTrainingParametersIn) { - return JSON.stringify(exports.CompletionTrainingParametersIn$outboundSchema.parse(completionTrainingParametersIn)); - } - function completionTrainingParametersInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.CompletionTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CompletionTrainingParametersIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js - var require_functioncallentryarguments = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentryarguments.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntryArguments$ = exports.FunctionCallEntryArguments$outboundSchema = exports.FunctionCallEntryArguments$inboundSchema = void 0; - exports.functionCallEntryArgumentsToJSON = functionCallEntryArgumentsToJSON; - exports.functionCallEntryArgumentsFromJSON = functionCallEntryArgumentsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEntryArguments$inboundSchema = z.union([z.record(z.any()), z.string()]); - exports.FunctionCallEntryArguments$outboundSchema = z.union([z.record(z.any()), z.string()]); - var FunctionCallEntryArguments$; - (function(FunctionCallEntryArguments$2) { - FunctionCallEntryArguments$2.inboundSchema = exports.FunctionCallEntryArguments$inboundSchema; - FunctionCallEntryArguments$2.outboundSchema = exports.FunctionCallEntryArguments$outboundSchema; - })(FunctionCallEntryArguments$ || (exports.FunctionCallEntryArguments$ = FunctionCallEntryArguments$ = {})); - function functionCallEntryArgumentsToJSON(functionCallEntryArguments) { - return JSON.stringify(exports.FunctionCallEntryArguments$outboundSchema.parse(functionCallEntryArguments)); - } - function functionCallEntryArgumentsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntryArguments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntryArguments' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallentry.js - var require_functioncallentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEntry$ = exports.FunctionCallEntry$outboundSchema = exports.FunctionCallEntry$inboundSchema = exports.FunctionCallEntryType$ = exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema = exports.FunctionCallEntryObject$ = exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema = exports.FunctionCallEntryType = exports.FunctionCallEntryObject = void 0; - exports.functionCallEntryToJSON = functionCallEntryToJSON; - exports.functionCallEntryFromJSON = functionCallEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var functioncallentryarguments_js_1 = require_functioncallentryarguments(); - exports.FunctionCallEntryObject = { - Entry: "entry" - }; - exports.FunctionCallEntryType = { - FunctionCall: "function.call" - }; - exports.FunctionCallEntryObject$inboundSchema = z.nativeEnum(exports.FunctionCallEntryObject); - exports.FunctionCallEntryObject$outboundSchema = exports.FunctionCallEntryObject$inboundSchema; - var FunctionCallEntryObject$; - (function(FunctionCallEntryObject$2) { - FunctionCallEntryObject$2.inboundSchema = exports.FunctionCallEntryObject$inboundSchema; - FunctionCallEntryObject$2.outboundSchema = exports.FunctionCallEntryObject$outboundSchema; - })(FunctionCallEntryObject$ || (exports.FunctionCallEntryObject$ = FunctionCallEntryObject$ = {})); - exports.FunctionCallEntryType$inboundSchema = z.nativeEnum(exports.FunctionCallEntryType); - exports.FunctionCallEntryType$outboundSchema = exports.FunctionCallEntryType$inboundSchema; - var FunctionCallEntryType$; - (function(FunctionCallEntryType$2) { - FunctionCallEntryType$2.inboundSchema = exports.FunctionCallEntryType$inboundSchema; - FunctionCallEntryType$2.outboundSchema = exports.FunctionCallEntryType$outboundSchema; - })(FunctionCallEntryType$ || (exports.FunctionCallEntryType$ = FunctionCallEntryType$ = {})); - exports.FunctionCallEntry$inboundSchema = z.object({ - object: exports.FunctionCallEntryObject$inboundSchema.default("entry"), - type: exports.FunctionCallEntryType$inboundSchema.default("function.call"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEntry$outboundSchema = z.object({ - object: exports.FunctionCallEntryObject$outboundSchema.default("entry"), - type: exports.FunctionCallEntryType$outboundSchema.default("function.call"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - name: z.string(), - arguments: functioncallentryarguments_js_1.FunctionCallEntryArguments$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEntry$; - (function(FunctionCallEntry$2) { - FunctionCallEntry$2.inboundSchema = exports.FunctionCallEntry$inboundSchema; - FunctionCallEntry$2.outboundSchema = exports.FunctionCallEntry$outboundSchema; - })(FunctionCallEntry$ || (exports.FunctionCallEntry$ = FunctionCallEntry$ = {})); - function functionCallEntryToJSON(functionCallEntry) { - return JSON.stringify(exports.FunctionCallEntry$outboundSchema.parse(functionCallEntry)); - } - function functionCallEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functionresultentry.js - var require_functionresultentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functionresultentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionResultEntry$ = exports.FunctionResultEntry$outboundSchema = exports.FunctionResultEntry$inboundSchema = exports.FunctionResultEntryType$ = exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema = exports.FunctionResultEntryObject$ = exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema = exports.FunctionResultEntryType = exports.FunctionResultEntryObject = void 0; - exports.functionResultEntryToJSON = functionResultEntryToJSON; - exports.functionResultEntryFromJSON = functionResultEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionResultEntryObject = { - Entry: "entry" - }; - exports.FunctionResultEntryType = { - FunctionResult: "function.result" - }; - exports.FunctionResultEntryObject$inboundSchema = z.nativeEnum(exports.FunctionResultEntryObject); - exports.FunctionResultEntryObject$outboundSchema = exports.FunctionResultEntryObject$inboundSchema; - var FunctionResultEntryObject$; - (function(FunctionResultEntryObject$2) { - FunctionResultEntryObject$2.inboundSchema = exports.FunctionResultEntryObject$inboundSchema; - FunctionResultEntryObject$2.outboundSchema = exports.FunctionResultEntryObject$outboundSchema; - })(FunctionResultEntryObject$ || (exports.FunctionResultEntryObject$ = FunctionResultEntryObject$ = {})); - exports.FunctionResultEntryType$inboundSchema = z.nativeEnum(exports.FunctionResultEntryType); - exports.FunctionResultEntryType$outboundSchema = exports.FunctionResultEntryType$inboundSchema; - var FunctionResultEntryType$; - (function(FunctionResultEntryType$2) { - FunctionResultEntryType$2.inboundSchema = exports.FunctionResultEntryType$inboundSchema; - FunctionResultEntryType$2.outboundSchema = exports.FunctionResultEntryType$outboundSchema; - })(FunctionResultEntryType$ || (exports.FunctionResultEntryType$ = FunctionResultEntryType$ = {})); - exports.FunctionResultEntry$inboundSchema = z.object({ - object: exports.FunctionResultEntryObject$inboundSchema.default("entry"), - type: exports.FunctionResultEntryType$inboundSchema.default("function.result"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionResultEntry$outboundSchema = z.object({ - object: exports.FunctionResultEntryObject$outboundSchema.default("entry"), - type: exports.FunctionResultEntryType$outboundSchema.default("function.result"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - result: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id" - }); - }); - var FunctionResultEntry$; - (function(FunctionResultEntry$2) { - FunctionResultEntry$2.inboundSchema = exports.FunctionResultEntry$inboundSchema; - FunctionResultEntry$2.outboundSchema = exports.FunctionResultEntry$outboundSchema; - })(FunctionResultEntry$ || (exports.FunctionResultEntry$ = FunctionResultEntry$ = {})); - function functionResultEntryToJSON(functionResultEntry) { - return JSON.stringify(exports.FunctionResultEntry$outboundSchema.parse(functionResultEntry)); - } - function functionResultEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionResultEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionResultEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolfilechunk.js - var require_toolfilechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolfilechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolFileChunk$ = exports.ToolFileChunk$outboundSchema = exports.ToolFileChunk$inboundSchema = exports.ToolFileChunkType$ = exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema = exports.ToolFileChunkType = void 0; - exports.toolFileChunkToJSON = toolFileChunkToJSON; - exports.toolFileChunkFromJSON = toolFileChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolFileChunkType = { - ToolFile: "tool_file" - }; - exports.ToolFileChunkType$inboundSchema = z.nativeEnum(exports.ToolFileChunkType); - exports.ToolFileChunkType$outboundSchema = exports.ToolFileChunkType$inboundSchema; - var ToolFileChunkType$; - (function(ToolFileChunkType$2) { - ToolFileChunkType$2.inboundSchema = exports.ToolFileChunkType$inboundSchema; - ToolFileChunkType$2.outboundSchema = exports.ToolFileChunkType$outboundSchema; - })(ToolFileChunkType$ || (exports.ToolFileChunkType$ = ToolFileChunkType$ = {})); - exports.ToolFileChunk$inboundSchema = z.object({ - type: exports.ToolFileChunkType$inboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - file_id: z.string(), - file_name: z.nullable(z.string()).optional(), - file_type: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId", - "file_name": "fileName", - "file_type": "fileType" - }); - }); - exports.ToolFileChunk$outboundSchema = z.object({ - type: exports.ToolFileChunkType$outboundSchema.default("tool_file"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - fileId: z.string(), - fileName: z.nullable(z.string()).optional(), - fileType: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id", - fileName: "file_name", - fileType: "file_type" - }); - }); - var ToolFileChunk$; - (function(ToolFileChunk$2) { - ToolFileChunk$2.inboundSchema = exports.ToolFileChunk$inboundSchema; - ToolFileChunk$2.outboundSchema = exports.ToolFileChunk$outboundSchema; - })(ToolFileChunk$ || (exports.ToolFileChunk$ = ToolFileChunk$ = {})); - function toolFileChunkToJSON(toolFileChunk) { - return JSON.stringify(exports.ToolFileChunk$outboundSchema.parse(toolFileChunk)); - } - function toolFileChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolFileChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolFileChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js - var require_messageinputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputContentChunks$ = exports.MessageInputContentChunks$outboundSchema = exports.MessageInputContentChunks$inboundSchema = void 0; - exports.messageInputContentChunksToJSON = messageInputContentChunksToJSON; - exports.messageInputContentChunksFromJSON = messageInputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - exports.MessageInputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageInputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageInputContentChunks$; - (function(MessageInputContentChunks$2) { - MessageInputContentChunks$2.inboundSchema = exports.MessageInputContentChunks$inboundSchema; - MessageInputContentChunks$2.outboundSchema = exports.MessageInputContentChunks$outboundSchema; - })(MessageInputContentChunks$ || (exports.MessageInputContentChunks$ = MessageInputContentChunks$ = {})); - function messageInputContentChunksToJSON(messageInputContentChunks) { - return JSON.stringify(exports.MessageInputContentChunks$outboundSchema.parse(messageInputContentChunks)); - } - function messageInputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageinputentry.js - var require_messageinputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageinputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageInputEntry$ = exports.MessageInputEntry$outboundSchema = exports.MessageInputEntry$inboundSchema = exports.MessageInputEntryContent$ = exports.MessageInputEntryContent$outboundSchema = exports.MessageInputEntryContent$inboundSchema = exports.MessageInputEntryRole$ = exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema = exports.MessageInputEntryType$ = exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema = exports.ObjectT$ = exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema = exports.MessageInputEntryRole = exports.MessageInputEntryType = exports.ObjectT = void 0; - exports.messageInputEntryContentToJSON = messageInputEntryContentToJSON; - exports.messageInputEntryContentFromJSON = messageInputEntryContentFromJSON; - exports.messageInputEntryToJSON = messageInputEntryToJSON; - exports.messageInputEntryFromJSON = messageInputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageinputcontentchunks_js_1 = require_messageinputcontentchunks(); - exports.ObjectT = { - Entry: "entry" - }; - exports.MessageInputEntryType = { - MessageInput: "message.input" - }; - exports.MessageInputEntryRole = { - Assistant: "assistant", - User: "user" - }; - exports.ObjectT$inboundSchema = z.nativeEnum(exports.ObjectT); - exports.ObjectT$outboundSchema = exports.ObjectT$inboundSchema; - var ObjectT$; - (function(ObjectT$2) { - ObjectT$2.inboundSchema = exports.ObjectT$inboundSchema; - ObjectT$2.outboundSchema = exports.ObjectT$outboundSchema; - })(ObjectT$ || (exports.ObjectT$ = ObjectT$ = {})); - exports.MessageInputEntryType$inboundSchema = z.nativeEnum(exports.MessageInputEntryType); - exports.MessageInputEntryType$outboundSchema = exports.MessageInputEntryType$inboundSchema; - var MessageInputEntryType$; - (function(MessageInputEntryType$2) { - MessageInputEntryType$2.inboundSchema = exports.MessageInputEntryType$inboundSchema; - MessageInputEntryType$2.outboundSchema = exports.MessageInputEntryType$outboundSchema; - })(MessageInputEntryType$ || (exports.MessageInputEntryType$ = MessageInputEntryType$ = {})); - exports.MessageInputEntryRole$inboundSchema = z.nativeEnum(exports.MessageInputEntryRole); - exports.MessageInputEntryRole$outboundSchema = exports.MessageInputEntryRole$inboundSchema; - var MessageInputEntryRole$; - (function(MessageInputEntryRole$2) { - MessageInputEntryRole$2.inboundSchema = exports.MessageInputEntryRole$inboundSchema; - MessageInputEntryRole$2.outboundSchema = exports.MessageInputEntryRole$outboundSchema; - })(MessageInputEntryRole$ || (exports.MessageInputEntryRole$ = MessageInputEntryRole$ = {})); - exports.MessageInputEntryContent$inboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema)]); - exports.MessageInputEntryContent$outboundSchema = z.union([z.string(), z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema)]); - var MessageInputEntryContent$; - (function(MessageInputEntryContent$2) { - MessageInputEntryContent$2.inboundSchema = exports.MessageInputEntryContent$inboundSchema; - MessageInputEntryContent$2.outboundSchema = exports.MessageInputEntryContent$outboundSchema; - })(MessageInputEntryContent$ || (exports.MessageInputEntryContent$ = MessageInputEntryContent$ = {})); - function messageInputEntryContentToJSON(messageInputEntryContent) { - return JSON.stringify(exports.MessageInputEntryContent$outboundSchema.parse(messageInputEntryContent)); - } - function messageInputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntryContent' from JSON`); - } - exports.MessageInputEntry$inboundSchema = z.object({ - object: exports.ObjectT$inboundSchema.default("entry"), - type: exports.MessageInputEntryType$inboundSchema.default("message.input"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$inboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$inboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.MessageInputEntry$outboundSchema = z.object({ - object: exports.ObjectT$outboundSchema.default("entry"), - type: exports.MessageInputEntryType$outboundSchema.default("message.input"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - role: exports.MessageInputEntryRole$outboundSchema, - content: z.union([ - z.string(), - z.array(messageinputcontentchunks_js_1.MessageInputContentChunks$outboundSchema) - ]), - prefix: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var MessageInputEntry$; - (function(MessageInputEntry$2) { - MessageInputEntry$2.inboundSchema = exports.MessageInputEntry$inboundSchema; - MessageInputEntry$2.outboundSchema = exports.MessageInputEntry$outboundSchema; - })(MessageInputEntry$ || (exports.MessageInputEntry$ = MessageInputEntry$ = {})); - function messageInputEntryToJSON(messageInputEntry) { - return JSON.stringify(exports.MessageInputEntry$outboundSchema.parse(messageInputEntry)); - } - function messageInputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageInputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageInputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js - var require_toolreferencechunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolreferencechunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolReferenceChunk$ = exports.ToolReferenceChunk$outboundSchema = exports.ToolReferenceChunk$inboundSchema = exports.ToolReferenceChunkType$ = exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema = exports.ToolReferenceChunkType = void 0; - exports.toolReferenceChunkToJSON = toolReferenceChunkToJSON; - exports.toolReferenceChunkFromJSON = toolReferenceChunkFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolReferenceChunkType = { - ToolReference: "tool_reference" - }; - exports.ToolReferenceChunkType$inboundSchema = z.nativeEnum(exports.ToolReferenceChunkType); - exports.ToolReferenceChunkType$outboundSchema = exports.ToolReferenceChunkType$inboundSchema; - var ToolReferenceChunkType$; - (function(ToolReferenceChunkType$2) { - ToolReferenceChunkType$2.inboundSchema = exports.ToolReferenceChunkType$inboundSchema; - ToolReferenceChunkType$2.outboundSchema = exports.ToolReferenceChunkType$outboundSchema; - })(ToolReferenceChunkType$ || (exports.ToolReferenceChunkType$ = ToolReferenceChunkType$ = {})); - exports.ToolReferenceChunk$inboundSchema = z.object({ - type: exports.ToolReferenceChunkType$inboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.ToolReferenceChunk$outboundSchema = z.object({ - type: exports.ToolReferenceChunkType$outboundSchema.default("tool_reference"), - tool: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var ToolReferenceChunk$; - (function(ToolReferenceChunk$2) { - ToolReferenceChunk$2.inboundSchema = exports.ToolReferenceChunk$inboundSchema; - ToolReferenceChunk$2.outboundSchema = exports.ToolReferenceChunk$outboundSchema; - })(ToolReferenceChunk$ || (exports.ToolReferenceChunk$ = ToolReferenceChunk$ = {})); - function toolReferenceChunkToJSON(toolReferenceChunk) { - return JSON.stringify(exports.ToolReferenceChunk$outboundSchema.parse(toolReferenceChunk)); - } - function toolReferenceChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolReferenceChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolReferenceChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js - var require_messageoutputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputContentChunks$ = exports.MessageOutputContentChunks$outboundSchema = exports.MessageOutputContentChunks$inboundSchema = void 0; - exports.messageOutputContentChunksToJSON = messageOutputContentChunksToJSON; - exports.messageOutputContentChunksFromJSON = messageOutputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.MessageOutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.MessageOutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var MessageOutputContentChunks$; - (function(MessageOutputContentChunks$2) { - MessageOutputContentChunks$2.inboundSchema = exports.MessageOutputContentChunks$inboundSchema; - MessageOutputContentChunks$2.outboundSchema = exports.MessageOutputContentChunks$outboundSchema; - })(MessageOutputContentChunks$ || (exports.MessageOutputContentChunks$ = MessageOutputContentChunks$ = {})); - function messageOutputContentChunksToJSON(messageOutputContentChunks) { - return JSON.stringify(exports.MessageOutputContentChunks$outboundSchema.parse(messageOutputContentChunks)); - } - function messageOutputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputentry.js - var require_messageoutputentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEntry$ = exports.MessageOutputEntry$outboundSchema = exports.MessageOutputEntry$inboundSchema = exports.MessageOutputEntryContent$ = exports.MessageOutputEntryContent$outboundSchema = exports.MessageOutputEntryContent$inboundSchema = exports.MessageOutputEntryRole$ = exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema = exports.MessageOutputEntryType$ = exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema = exports.MessageOutputEntryObject$ = exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema = exports.MessageOutputEntryRole = exports.MessageOutputEntryType = exports.MessageOutputEntryObject = void 0; - exports.messageOutputEntryContentToJSON = messageOutputEntryContentToJSON; - exports.messageOutputEntryContentFromJSON = messageOutputEntryContentFromJSON; - exports.messageOutputEntryToJSON = messageOutputEntryToJSON; - exports.messageOutputEntryFromJSON = messageOutputEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageoutputcontentchunks_js_1 = require_messageoutputcontentchunks(); - exports.MessageOutputEntryObject = { - Entry: "entry" - }; - exports.MessageOutputEntryType = { - MessageOutput: "message.output" - }; - exports.MessageOutputEntryRole = { - Assistant: "assistant" - }; - exports.MessageOutputEntryObject$inboundSchema = z.nativeEnum(exports.MessageOutputEntryObject); - exports.MessageOutputEntryObject$outboundSchema = exports.MessageOutputEntryObject$inboundSchema; - var MessageOutputEntryObject$; - (function(MessageOutputEntryObject$2) { - MessageOutputEntryObject$2.inboundSchema = exports.MessageOutputEntryObject$inboundSchema; - MessageOutputEntryObject$2.outboundSchema = exports.MessageOutputEntryObject$outboundSchema; - })(MessageOutputEntryObject$ || (exports.MessageOutputEntryObject$ = MessageOutputEntryObject$ = {})); - exports.MessageOutputEntryType$inboundSchema = z.nativeEnum(exports.MessageOutputEntryType); - exports.MessageOutputEntryType$outboundSchema = exports.MessageOutputEntryType$inboundSchema; - var MessageOutputEntryType$; - (function(MessageOutputEntryType$2) { - MessageOutputEntryType$2.inboundSchema = exports.MessageOutputEntryType$inboundSchema; - MessageOutputEntryType$2.outboundSchema = exports.MessageOutputEntryType$outboundSchema; - })(MessageOutputEntryType$ || (exports.MessageOutputEntryType$ = MessageOutputEntryType$ = {})); - exports.MessageOutputEntryRole$inboundSchema = z.nativeEnum(exports.MessageOutputEntryRole); - exports.MessageOutputEntryRole$outboundSchema = exports.MessageOutputEntryRole$inboundSchema; - var MessageOutputEntryRole$; - (function(MessageOutputEntryRole$2) { - MessageOutputEntryRole$2.inboundSchema = exports.MessageOutputEntryRole$inboundSchema; - MessageOutputEntryRole$2.outboundSchema = exports.MessageOutputEntryRole$outboundSchema; - })(MessageOutputEntryRole$ || (exports.MessageOutputEntryRole$ = MessageOutputEntryRole$ = {})); - exports.MessageOutputEntryContent$inboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema)]); - exports.MessageOutputEntryContent$outboundSchema = z.union([z.string(), z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema)]); - var MessageOutputEntryContent$; - (function(MessageOutputEntryContent$2) { - MessageOutputEntryContent$2.inboundSchema = exports.MessageOutputEntryContent$inboundSchema; - MessageOutputEntryContent$2.outboundSchema = exports.MessageOutputEntryContent$outboundSchema; - })(MessageOutputEntryContent$ || (exports.MessageOutputEntryContent$ = MessageOutputEntryContent$ = {})); - function messageOutputEntryContentToJSON(messageOutputEntryContent) { - return JSON.stringify(exports.MessageOutputEntryContent$outboundSchema.parse(messageOutputEntryContent)); - } - function messageOutputEntryContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntryContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntryContent' from JSON`); - } - exports.MessageOutputEntry$inboundSchema = z.object({ - object: exports.MessageOutputEntryObject$inboundSchema.default("entry"), - type: exports.MessageOutputEntryType$inboundSchema.default("message.output"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$inboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$inboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEntry$outboundSchema = z.object({ - object: exports.MessageOutputEntryObject$outboundSchema.default("entry"), - type: exports.MessageOutputEntryType$outboundSchema.default("message.output"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: exports.MessageOutputEntryRole$outboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(messageoutputcontentchunks_js_1.MessageOutputContentChunks$outboundSchema) - ]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at", - agentId: "agent_id" - }); - }); - var MessageOutputEntry$; - (function(MessageOutputEntry$2) { - MessageOutputEntry$2.inboundSchema = exports.MessageOutputEntry$inboundSchema; - MessageOutputEntry$2.outboundSchema = exports.MessageOutputEntry$outboundSchema; - })(MessageOutputEntry$ || (exports.MessageOutputEntry$ = MessageOutputEntry$ = {})); - function messageOutputEntryToJSON(messageOutputEntry) { - return JSON.stringify(exports.MessageOutputEntry$outboundSchema.parse(messageOutputEntry)); - } - function messageOutputEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js - var require_toolexecutionentry = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionentry.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionEntry$ = exports.ToolExecutionEntry$outboundSchema = exports.ToolExecutionEntry$inboundSchema = exports.ToolExecutionEntryType$ = exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema = exports.ToolExecutionEntryObject$ = exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema = exports.ToolExecutionEntryType = exports.ToolExecutionEntryObject = void 0; - exports.toolExecutionEntryToJSON = toolExecutionEntryToJSON; - exports.toolExecutionEntryFromJSON = toolExecutionEntryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionEntryObject = { - Entry: "entry" - }; - exports.ToolExecutionEntryType = { - ToolExecution: "tool.execution" - }; - exports.ToolExecutionEntryObject$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryObject); - exports.ToolExecutionEntryObject$outboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - var ToolExecutionEntryObject$; - (function(ToolExecutionEntryObject$2) { - ToolExecutionEntryObject$2.inboundSchema = exports.ToolExecutionEntryObject$inboundSchema; - ToolExecutionEntryObject$2.outboundSchema = exports.ToolExecutionEntryObject$outboundSchema; - })(ToolExecutionEntryObject$ || (exports.ToolExecutionEntryObject$ = ToolExecutionEntryObject$ = {})); - exports.ToolExecutionEntryType$inboundSchema = z.nativeEnum(exports.ToolExecutionEntryType); - exports.ToolExecutionEntryType$outboundSchema = exports.ToolExecutionEntryType$inboundSchema; - var ToolExecutionEntryType$; - (function(ToolExecutionEntryType$2) { - ToolExecutionEntryType$2.inboundSchema = exports.ToolExecutionEntryType$inboundSchema; - ToolExecutionEntryType$2.outboundSchema = exports.ToolExecutionEntryType$outboundSchema; - })(ToolExecutionEntryType$ || (exports.ToolExecutionEntryType$ = ToolExecutionEntryType$ = {})); - exports.ToolExecutionEntry$inboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$inboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$inboundSchema.default("tool.execution"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - completed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "completed_at": "completedAt" - }); - }); - exports.ToolExecutionEntry$outboundSchema = z.object({ - object: exports.ToolExecutionEntryObject$outboundSchema.default("entry"), - type: exports.ToolExecutionEntryType$outboundSchema.default("tool.execution"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - id: z.string().optional(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - completedAt: "completed_at" - }); - }); - var ToolExecutionEntry$; - (function(ToolExecutionEntry$2) { - ToolExecutionEntry$2.inboundSchema = exports.ToolExecutionEntry$inboundSchema; - ToolExecutionEntry$2.outboundSchema = exports.ToolExecutionEntry$outboundSchema; - })(ToolExecutionEntry$ || (exports.ToolExecutionEntry$ = ToolExecutionEntry$ = {})); - function toolExecutionEntryToJSON(toolExecutionEntry) { - return JSON.stringify(exports.ToolExecutionEntry$outboundSchema.parse(toolExecutionEntry)); - } - function toolExecutionEntryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionEntry$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionEntry' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/inputentries.js - var require_inputentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/inputentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.InputEntries$ = exports.InputEntries$outboundSchema = exports.InputEntries$inboundSchema = void 0; - exports.inputEntriesToJSON = inputEntriesToJSON; - exports.inputEntriesFromJSON = inputEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.InputEntries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.InputEntries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var InputEntries$; - (function(InputEntries$2) { - InputEntries$2.inboundSchema = exports.InputEntries$inboundSchema; - InputEntries$2.outboundSchema = exports.InputEntries$outboundSchema; - })(InputEntries$ || (exports.InputEntries$ = InputEntries$ = {})); - function inputEntriesToJSON(inputEntries) { - return JSON.stringify(exports.InputEntries$outboundSchema.parse(inputEntries)); - } - function inputEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.InputEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'InputEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationinputs.js - var require_conversationinputs = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationinputs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationInputs$ = exports.ConversationInputs$outboundSchema = exports.ConversationInputs$inboundSchema = void 0; - exports.conversationInputsToJSON = conversationInputsToJSON; - exports.conversationInputsFromJSON = conversationInputsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var inputentries_js_1 = require_inputentries(); - exports.ConversationInputs$inboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$inboundSchema)]); - exports.ConversationInputs$outboundSchema = z.union([z.string(), z.array(inputentries_js_1.InputEntries$outboundSchema)]); - var ConversationInputs$; - (function(ConversationInputs$2) { - ConversationInputs$2.inboundSchema = exports.ConversationInputs$inboundSchema; - ConversationInputs$2.outboundSchema = exports.ConversationInputs$outboundSchema; - })(ConversationInputs$ || (exports.ConversationInputs$ = ConversationInputs$ = {})); - function conversationInputsToJSON(conversationInputs) { - return JSON.stringify(exports.ConversationInputs$outboundSchema.parse(conversationInputs)); - } - function conversationInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationInputs' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js - var require_conversationappendrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendRequest$ = exports.ConversationAppendRequest$outboundSchema = exports.ConversationAppendRequest$inboundSchema = exports.ConversationAppendRequestHandoffExecution$ = exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema = exports.ConversationAppendRequestHandoffExecution = void 0; - exports.conversationAppendRequestToJSON = conversationAppendRequestToJSON; - exports.conversationAppendRequestFromJSON = conversationAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendRequestHandoffExecution); - exports.ConversationAppendRequestHandoffExecution$outboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - var ConversationAppendRequestHandoffExecution$; - (function(ConversationAppendRequestHandoffExecution$2) { - ConversationAppendRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendRequestHandoffExecution$inboundSchema; - ConversationAppendRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendRequestHandoffExecution$outboundSchema; - })(ConversationAppendRequestHandoffExecution$ || (exports.ConversationAppendRequestHandoffExecution$ = ConversationAppendRequestHandoffExecution$ = {})); - exports.ConversationAppendRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendRequest$; - (function(ConversationAppendRequest$2) { - ConversationAppendRequest$2.inboundSchema = exports.ConversationAppendRequest$inboundSchema; - ConversationAppendRequest$2.outboundSchema = exports.ConversationAppendRequest$outboundSchema; - })(ConversationAppendRequest$ || (exports.ConversationAppendRequest$ = ConversationAppendRequest$ = {})); - function conversationAppendRequestToJSON(conversationAppendRequest) { - return JSON.stringify(exports.ConversationAppendRequest$outboundSchema.parse(conversationAppendRequest)); - } - function conversationAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js - var require_conversationappendstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationappendstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationAppendStreamRequest$ = exports.ConversationAppendStreamRequest$outboundSchema = exports.ConversationAppendStreamRequest$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$ = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution = void 0; - exports.conversationAppendStreamRequestToJSON = conversationAppendStreamRequestToJSON; - exports.conversationAppendStreamRequestFromJSON = conversationAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationAppendStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationAppendStreamRequestHandoffExecution); - exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - var ConversationAppendStreamRequestHandoffExecution$; - (function(ConversationAppendStreamRequestHandoffExecution$2) { - ConversationAppendStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema; - ConversationAppendStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema; - })(ConversationAppendStreamRequestHandoffExecution$ || (exports.ConversationAppendStreamRequestHandoffExecution$ = ConversationAppendStreamRequestHandoffExecution$ = {})); - exports.ConversationAppendStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationAppendStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs" - }); - }); - exports.ConversationAppendStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationAppendStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args" - }); - }); - var ConversationAppendStreamRequest$; - (function(ConversationAppendStreamRequest$2) { - ConversationAppendStreamRequest$2.inboundSchema = exports.ConversationAppendStreamRequest$inboundSchema; - ConversationAppendStreamRequest$2.outboundSchema = exports.ConversationAppendStreamRequest$outboundSchema; - })(ConversationAppendStreamRequest$ || (exports.ConversationAppendStreamRequest$ = ConversationAppendStreamRequest$ = {})); - function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest) { - return JSON.stringify(exports.ConversationAppendStreamRequest$outboundSchema.parse(conversationAppendStreamRequest)); - } - function conversationAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/functioncallevent.js - var require_functioncallevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/functioncallevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FunctionCallEvent$ = exports.FunctionCallEvent$outboundSchema = exports.FunctionCallEvent$inboundSchema = exports.FunctionCallEventType$ = exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema = exports.FunctionCallEventType = void 0; - exports.functionCallEventToJSON = functionCallEventToJSON; - exports.functionCallEventFromJSON = functionCallEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FunctionCallEventType = { - FunctionCallDelta: "function.call.delta" - }; - exports.FunctionCallEventType$inboundSchema = z.nativeEnum(exports.FunctionCallEventType); - exports.FunctionCallEventType$outboundSchema = exports.FunctionCallEventType$inboundSchema; - var FunctionCallEventType$; - (function(FunctionCallEventType$2) { - FunctionCallEventType$2.inboundSchema = exports.FunctionCallEventType$inboundSchema; - FunctionCallEventType$2.outboundSchema = exports.FunctionCallEventType$outboundSchema; - })(FunctionCallEventType$ || (exports.FunctionCallEventType$ = FunctionCallEventType$ = {})); - exports.FunctionCallEvent$inboundSchema = z.object({ - type: exports.FunctionCallEventType$inboundSchema.default("function.call.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: z.string(), - tool_call_id: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "tool_call_id": "toolCallId" - }); - }); - exports.FunctionCallEvent$outboundSchema = z.object({ - type: exports.FunctionCallEventType$outboundSchema.default("function.call.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: z.string(), - toolCallId: z.string(), - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - toolCallId: "tool_call_id" - }); - }); - var FunctionCallEvent$; - (function(FunctionCallEvent$2) { - FunctionCallEvent$2.inboundSchema = exports.FunctionCallEvent$inboundSchema; - FunctionCallEvent$2.outboundSchema = exports.FunctionCallEvent$outboundSchema; - })(FunctionCallEvent$ || (exports.FunctionCallEvent$ = FunctionCallEvent$ = {})); - function functionCallEventToJSON(functionCallEvent) { - return JSON.stringify(exports.FunctionCallEvent$outboundSchema.parse(functionCallEvent)); - } - function functionCallEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FunctionCallEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FunctionCallEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js - var require_outputcontentchunks = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/outputcontentchunks.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OutputContentChunks$ = exports.OutputContentChunks$outboundSchema = exports.OutputContentChunks$inboundSchema = void 0; - exports.outputContentChunksToJSON = outputContentChunksToJSON; - exports.outputContentChunksFromJSON = outputContentChunksFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var textchunk_js_1 = require_textchunk(); - var thinkchunk_js_1 = require_thinkchunk(); - var toolfilechunk_js_1 = require_toolfilechunk(); - var toolreferencechunk_js_1 = require_toolreferencechunk(); - exports.OutputContentChunks$inboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$inboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$inboundSchema, - textchunk_js_1.TextChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - thinkchunk_js_1.ThinkChunk$inboundSchema - ]); - exports.OutputContentChunks$outboundSchema = z.union([ - toolfilechunk_js_1.ToolFileChunk$outboundSchema, - toolreferencechunk_js_1.ToolReferenceChunk$outboundSchema, - textchunk_js_1.TextChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - thinkchunk_js_1.ThinkChunk$outboundSchema - ]); - var OutputContentChunks$; - (function(OutputContentChunks$2) { - OutputContentChunks$2.inboundSchema = exports.OutputContentChunks$inboundSchema; - OutputContentChunks$2.outboundSchema = exports.OutputContentChunks$outboundSchema; - })(OutputContentChunks$ || (exports.OutputContentChunks$ = OutputContentChunks$ = {})); - function outputContentChunksToJSON(outputContentChunks) { - return JSON.stringify(exports.OutputContentChunks$outboundSchema.parse(outputContentChunks)); - } - function outputContentChunksFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OutputContentChunks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OutputContentChunks' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageoutputevent.js - var require_messageoutputevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageoutputevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageOutputEvent$ = exports.MessageOutputEvent$outboundSchema = exports.MessageOutputEvent$inboundSchema = exports.MessageOutputEventContent$ = exports.MessageOutputEventContent$outboundSchema = exports.MessageOutputEventContent$inboundSchema = exports.MessageOutputEventRole$ = exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema = exports.MessageOutputEventType$ = exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema = exports.MessageOutputEventRole = exports.MessageOutputEventType = void 0; - exports.messageOutputEventContentToJSON = messageOutputEventContentToJSON; - exports.messageOutputEventContentFromJSON = messageOutputEventContentFromJSON; - exports.messageOutputEventToJSON = messageOutputEventToJSON; - exports.messageOutputEventFromJSON = messageOutputEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var outputcontentchunks_js_1 = require_outputcontentchunks(); - exports.MessageOutputEventType = { - MessageOutputDelta: "message.output.delta" - }; - exports.MessageOutputEventRole = { - Assistant: "assistant" - }; - exports.MessageOutputEventType$inboundSchema = z.nativeEnum(exports.MessageOutputEventType); - exports.MessageOutputEventType$outboundSchema = exports.MessageOutputEventType$inboundSchema; - var MessageOutputEventType$; - (function(MessageOutputEventType$2) { - MessageOutputEventType$2.inboundSchema = exports.MessageOutputEventType$inboundSchema; - MessageOutputEventType$2.outboundSchema = exports.MessageOutputEventType$outboundSchema; - })(MessageOutputEventType$ || (exports.MessageOutputEventType$ = MessageOutputEventType$ = {})); - exports.MessageOutputEventRole$inboundSchema = z.nativeEnum(exports.MessageOutputEventRole); - exports.MessageOutputEventRole$outboundSchema = exports.MessageOutputEventRole$inboundSchema; - var MessageOutputEventRole$; - (function(MessageOutputEventRole$2) { - MessageOutputEventRole$2.inboundSchema = exports.MessageOutputEventRole$inboundSchema; - MessageOutputEventRole$2.outboundSchema = exports.MessageOutputEventRole$outboundSchema; - })(MessageOutputEventRole$ || (exports.MessageOutputEventRole$ = MessageOutputEventRole$ = {})); - exports.MessageOutputEventContent$inboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]); - exports.MessageOutputEventContent$outboundSchema = z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]); - var MessageOutputEventContent$; - (function(MessageOutputEventContent$2) { - MessageOutputEventContent$2.inboundSchema = exports.MessageOutputEventContent$inboundSchema; - MessageOutputEventContent$2.outboundSchema = exports.MessageOutputEventContent$outboundSchema; - })(MessageOutputEventContent$ || (exports.MessageOutputEventContent$ = MessageOutputEventContent$ = {})); - function messageOutputEventContentToJSON(messageOutputEventContent) { - return JSON.stringify(exports.MessageOutputEventContent$outboundSchema.parse(messageOutputEventContent)); - } - function messageOutputEventContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEventContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEventContent' from JSON`); - } - exports.MessageOutputEvent$inboundSchema = z.object({ - type: exports.MessageOutputEventType$inboundSchema.default("message.output.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - content_index: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$inboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$inboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "content_index": "contentIndex", - "agent_id": "agentId" - }); - }); - exports.MessageOutputEvent$outboundSchema = z.object({ - type: exports.MessageOutputEventType$outboundSchema.default("message.output.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - contentIndex: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - role: exports.MessageOutputEventRole$outboundSchema.default("assistant"), - content: z.union([z.string(), outputcontentchunks_js_1.OutputContentChunks$outboundSchema]) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index", - contentIndex: "content_index", - agentId: "agent_id" - }); - }); - var MessageOutputEvent$; - (function(MessageOutputEvent$2) { - MessageOutputEvent$2.inboundSchema = exports.MessageOutputEvent$inboundSchema; - MessageOutputEvent$2.outboundSchema = exports.MessageOutputEvent$outboundSchema; - })(MessageOutputEvent$ || (exports.MessageOutputEvent$ = MessageOutputEvent$ = {})); - function messageOutputEventToJSON(messageOutputEvent) { - return JSON.stringify(exports.MessageOutputEvent$outboundSchema.parse(messageOutputEvent)); - } - function messageOutputEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageOutputEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageOutputEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js - var require_conversationusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationUsageInfo$ = exports.ConversationUsageInfo$outboundSchema = exports.ConversationUsageInfo$inboundSchema = void 0; - exports.conversationUsageInfoToJSON = conversationUsageInfoToJSON; - exports.conversationUsageInfoFromJSON = conversationUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ConversationUsageInfo$inboundSchema = z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - connector_tokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "connector_tokens": "connectorTokens" - }); - }); - exports.ConversationUsageInfo$outboundSchema = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - connectorTokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - connectorTokens: "connector_tokens" - }); - }); - var ConversationUsageInfo$; - (function(ConversationUsageInfo$2) { - ConversationUsageInfo$2.inboundSchema = exports.ConversationUsageInfo$inboundSchema; - ConversationUsageInfo$2.outboundSchema = exports.ConversationUsageInfo$outboundSchema; - })(ConversationUsageInfo$ || (exports.ConversationUsageInfo$ = ConversationUsageInfo$ = {})); - function conversationUsageInfoToJSON(conversationUsageInfo) { - return JSON.stringify(exports.ConversationUsageInfo$outboundSchema.parse(conversationUsageInfo)); - } - function conversationUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsedoneevent.js - var require_responsedoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsedoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseDoneEvent$ = exports.ResponseDoneEvent$outboundSchema = exports.ResponseDoneEvent$inboundSchema = exports.ResponseDoneEventType$ = exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema = exports.ResponseDoneEventType = void 0; - exports.responseDoneEventToJSON = responseDoneEventToJSON; - exports.responseDoneEventFromJSON = responseDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - exports.ResponseDoneEventType = { - ConversationResponseDone: "conversation.response.done" - }; - exports.ResponseDoneEventType$inboundSchema = z.nativeEnum(exports.ResponseDoneEventType); - exports.ResponseDoneEventType$outboundSchema = exports.ResponseDoneEventType$inboundSchema; - var ResponseDoneEventType$; - (function(ResponseDoneEventType$2) { - ResponseDoneEventType$2.inboundSchema = exports.ResponseDoneEventType$inboundSchema; - ResponseDoneEventType$2.outboundSchema = exports.ResponseDoneEventType$outboundSchema; - })(ResponseDoneEventType$ || (exports.ResponseDoneEventType$ = ResponseDoneEventType$ = {})); - exports.ResponseDoneEvent$inboundSchema = z.object({ - type: exports.ResponseDoneEventType$inboundSchema.default("conversation.response.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseDoneEvent$outboundSchema = z.object({ - type: exports.ResponseDoneEventType$outboundSchema.default("conversation.response.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseDoneEvent$; - (function(ResponseDoneEvent$2) { - ResponseDoneEvent$2.inboundSchema = exports.ResponseDoneEvent$inboundSchema; - ResponseDoneEvent$2.outboundSchema = exports.ResponseDoneEvent$outboundSchema; - })(ResponseDoneEvent$ || (exports.ResponseDoneEvent$ = ResponseDoneEvent$ = {})); - function responseDoneEventToJSON(responseDoneEvent) { - return JSON.stringify(exports.ResponseDoneEvent$outboundSchema.parse(responseDoneEvent)); - } - function responseDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responseerrorevent.js - var require_responseerrorevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responseerrorevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseErrorEvent$ = exports.ResponseErrorEvent$outboundSchema = exports.ResponseErrorEvent$inboundSchema = exports.ResponseErrorEventType$ = exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema = exports.ResponseErrorEventType = void 0; - exports.responseErrorEventToJSON = responseErrorEventToJSON; - exports.responseErrorEventFromJSON = responseErrorEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseErrorEventType = { - ConversationResponseError: "conversation.response.error" - }; - exports.ResponseErrorEventType$inboundSchema = z.nativeEnum(exports.ResponseErrorEventType); - exports.ResponseErrorEventType$outboundSchema = exports.ResponseErrorEventType$inboundSchema; - var ResponseErrorEventType$; - (function(ResponseErrorEventType$2) { - ResponseErrorEventType$2.inboundSchema = exports.ResponseErrorEventType$inboundSchema; - ResponseErrorEventType$2.outboundSchema = exports.ResponseErrorEventType$outboundSchema; - })(ResponseErrorEventType$ || (exports.ResponseErrorEventType$ = ResponseErrorEventType$ = {})); - exports.ResponseErrorEvent$inboundSchema = z.object({ - type: exports.ResponseErrorEventType$inboundSchema.default("conversation.response.error"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt" - }); - }); - exports.ResponseErrorEvent$outboundSchema = z.object({ - type: exports.ResponseErrorEventType$outboundSchema.default("conversation.response.error"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - message: z.string(), - code: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at" - }); - }); - var ResponseErrorEvent$; - (function(ResponseErrorEvent$2) { - ResponseErrorEvent$2.inboundSchema = exports.ResponseErrorEvent$inboundSchema; - ResponseErrorEvent$2.outboundSchema = exports.ResponseErrorEvent$outboundSchema; - })(ResponseErrorEvent$ || (exports.ResponseErrorEvent$ = ResponseErrorEvent$ = {})); - function responseErrorEventToJSON(responseErrorEvent) { - return JSON.stringify(exports.ResponseErrorEvent$outboundSchema.parse(responseErrorEvent)); - } - function responseErrorEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseErrorEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseErrorEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/responsestartedevent.js - var require_responsestartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/responsestartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseStartedEvent$ = exports.ResponseStartedEvent$outboundSchema = exports.ResponseStartedEvent$inboundSchema = exports.ResponseStartedEventType$ = exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema = exports.ResponseStartedEventType = void 0; - exports.responseStartedEventToJSON = responseStartedEventToJSON; - exports.responseStartedEventFromJSON = responseStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ResponseStartedEventType = { - ConversationResponseStarted: "conversation.response.started" - }; - exports.ResponseStartedEventType$inboundSchema = z.nativeEnum(exports.ResponseStartedEventType); - exports.ResponseStartedEventType$outboundSchema = exports.ResponseStartedEventType$inboundSchema; - var ResponseStartedEventType$; - (function(ResponseStartedEventType$2) { - ResponseStartedEventType$2.inboundSchema = exports.ResponseStartedEventType$inboundSchema; - ResponseStartedEventType$2.outboundSchema = exports.ResponseStartedEventType$outboundSchema; - })(ResponseStartedEventType$ || (exports.ResponseStartedEventType$ = ResponseStartedEventType$ = {})); - exports.ResponseStartedEvent$inboundSchema = z.object({ - type: exports.ResponseStartedEventType$inboundSchema.default("conversation.response.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "conversation_id": "conversationId" - }); - }); - exports.ResponseStartedEvent$outboundSchema = z.object({ - type: exports.ResponseStartedEventType$outboundSchema.default("conversation.response.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - conversationId: "conversation_id" - }); - }); - var ResponseStartedEvent$; - (function(ResponseStartedEvent$2) { - ResponseStartedEvent$2.inboundSchema = exports.ResponseStartedEvent$inboundSchema; - ResponseStartedEvent$2.outboundSchema = exports.ResponseStartedEvent$outboundSchema; - })(ResponseStartedEvent$ || (exports.ResponseStartedEvent$ = ResponseStartedEvent$ = {})); - function responseStartedEventToJSON(responseStartedEvent) { - return JSON.stringify(exports.ResponseStartedEvent$outboundSchema.parse(responseStartedEvent)); - } - function responseStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ssetypes.js - var require_ssetypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ssetypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SSETypes$ = exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema = exports.SSETypes = void 0; - var z = __importStar(require_zod()); - exports.SSETypes = { - ConversationResponseStarted: "conversation.response.started", - ConversationResponseDone: "conversation.response.done", - ConversationResponseError: "conversation.response.error", - MessageOutputDelta: "message.output.delta", - ToolExecutionStarted: "tool.execution.started", - ToolExecutionDelta: "tool.execution.delta", - ToolExecutionDone: "tool.execution.done", - AgentHandoffStarted: "agent.handoff.started", - AgentHandoffDone: "agent.handoff.done", - FunctionCallDelta: "function.call.delta" - }; - exports.SSETypes$inboundSchema = z.nativeEnum(exports.SSETypes); - exports.SSETypes$outboundSchema = exports.SSETypes$inboundSchema; - var SSETypes$; - (function(SSETypes$2) { - SSETypes$2.inboundSchema = exports.SSETypes$inboundSchema; - SSETypes$2.outboundSchema = exports.SSETypes$outboundSchema; - })(SSETypes$ || (exports.SSETypes$ = SSETypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js - var require_toolexecutiondeltaevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondeltaevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDeltaEvent$ = exports.ToolExecutionDeltaEvent$outboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema = exports.ToolExecutionDeltaEventType$ = exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema = exports.ToolExecutionDeltaEventType = void 0; - exports.toolExecutionDeltaEventToJSON = toolExecutionDeltaEventToJSON; - exports.toolExecutionDeltaEventFromJSON = toolExecutionDeltaEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDeltaEventType = { - ToolExecutionDelta: "tool.execution.delta" - }; - exports.ToolExecutionDeltaEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDeltaEventType); - exports.ToolExecutionDeltaEventType$outboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - var ToolExecutionDeltaEventType$; - (function(ToolExecutionDeltaEventType$2) { - ToolExecutionDeltaEventType$2.inboundSchema = exports.ToolExecutionDeltaEventType$inboundSchema; - ToolExecutionDeltaEventType$2.outboundSchema = exports.ToolExecutionDeltaEventType$outboundSchema; - })(ToolExecutionDeltaEventType$ || (exports.ToolExecutionDeltaEventType$ = ToolExecutionDeltaEventType$ = {})); - exports.ToolExecutionDeltaEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$inboundSchema.default("tool.execution.delta"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDeltaEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDeltaEventType$outboundSchema.default("tool.execution.delta"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDeltaEvent$; - (function(ToolExecutionDeltaEvent$2) { - ToolExecutionDeltaEvent$2.inboundSchema = exports.ToolExecutionDeltaEvent$inboundSchema; - ToolExecutionDeltaEvent$2.outboundSchema = exports.ToolExecutionDeltaEvent$outboundSchema; - })(ToolExecutionDeltaEvent$ || (exports.ToolExecutionDeltaEvent$ = ToolExecutionDeltaEvent$ = {})); - function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent) { - return JSON.stringify(exports.ToolExecutionDeltaEvent$outboundSchema.parse(toolExecutionDeltaEvent)); - } - function toolExecutionDeltaEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDeltaEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDeltaEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js - var require_toolexecutiondoneevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutiondoneevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionDoneEvent$ = exports.ToolExecutionDoneEvent$outboundSchema = exports.ToolExecutionDoneEvent$inboundSchema = exports.ToolExecutionDoneEventType$ = exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema = exports.ToolExecutionDoneEventType = void 0; - exports.toolExecutionDoneEventToJSON = toolExecutionDoneEventToJSON; - exports.toolExecutionDoneEventFromJSON = toolExecutionDoneEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionDoneEventType = { - ToolExecutionDone: "tool.execution.done" - }; - exports.ToolExecutionDoneEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionDoneEventType); - exports.ToolExecutionDoneEventType$outboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - var ToolExecutionDoneEventType$; - (function(ToolExecutionDoneEventType$2) { - ToolExecutionDoneEventType$2.inboundSchema = exports.ToolExecutionDoneEventType$inboundSchema; - ToolExecutionDoneEventType$2.outboundSchema = exports.ToolExecutionDoneEventType$outboundSchema; - })(ToolExecutionDoneEventType$ || (exports.ToolExecutionDoneEventType$ = ToolExecutionDoneEventType$ = {})); - exports.ToolExecutionDoneEvent$inboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$inboundSchema.default("tool.execution.done"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionDoneEvent$outboundSchema = z.object({ - type: exports.ToolExecutionDoneEventType$outboundSchema.default("tool.execution.done"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - info: z.record(z.any()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionDoneEvent$; - (function(ToolExecutionDoneEvent$2) { - ToolExecutionDoneEvent$2.inboundSchema = exports.ToolExecutionDoneEvent$inboundSchema; - ToolExecutionDoneEvent$2.outboundSchema = exports.ToolExecutionDoneEvent$outboundSchema; - })(ToolExecutionDoneEvent$ || (exports.ToolExecutionDoneEvent$ = ToolExecutionDoneEvent$ = {})); - function toolExecutionDoneEventToJSON(toolExecutionDoneEvent) { - return JSON.stringify(exports.ToolExecutionDoneEvent$outboundSchema.parse(toolExecutionDoneEvent)); - } - function toolExecutionDoneEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionDoneEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionDoneEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js - var require_toolexecutionstartedevent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/toolexecutionstartedevent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ToolExecutionStartedEvent$ = exports.ToolExecutionStartedEvent$outboundSchema = exports.ToolExecutionStartedEvent$inboundSchema = exports.ToolExecutionStartedEventType$ = exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema = exports.ToolExecutionStartedEventType = void 0; - exports.toolExecutionStartedEventToJSON = toolExecutionStartedEventToJSON; - exports.toolExecutionStartedEventFromJSON = toolExecutionStartedEventFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var builtinconnectors_js_1 = require_builtinconnectors(); - exports.ToolExecutionStartedEventType = { - ToolExecutionStarted: "tool.execution.started" - }; - exports.ToolExecutionStartedEventType$inboundSchema = z.nativeEnum(exports.ToolExecutionStartedEventType); - exports.ToolExecutionStartedEventType$outboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - var ToolExecutionStartedEventType$; - (function(ToolExecutionStartedEventType$2) { - ToolExecutionStartedEventType$2.inboundSchema = exports.ToolExecutionStartedEventType$inboundSchema; - ToolExecutionStartedEventType$2.outboundSchema = exports.ToolExecutionStartedEventType$outboundSchema; - })(ToolExecutionStartedEventType$ || (exports.ToolExecutionStartedEventType$ = ToolExecutionStartedEventType$ = {})); - exports.ToolExecutionStartedEvent$inboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$inboundSchema.default("tool.execution.started"), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)).optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$inboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "output_index": "outputIndex" - }); - }); - exports.ToolExecutionStartedEvent$outboundSchema = z.object({ - type: exports.ToolExecutionStartedEventType$outboundSchema.default("tool.execution.started"), - createdAt: z.date().transform((v) => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: builtinconnectors_js_1.BuiltInConnectors$outboundSchema, - arguments: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - outputIndex: "output_index" - }); - }); - var ToolExecutionStartedEvent$; - (function(ToolExecutionStartedEvent$2) { - ToolExecutionStartedEvent$2.inboundSchema = exports.ToolExecutionStartedEvent$inboundSchema; - ToolExecutionStartedEvent$2.outboundSchema = exports.ToolExecutionStartedEvent$outboundSchema; - })(ToolExecutionStartedEvent$ || (exports.ToolExecutionStartedEvent$ = ToolExecutionStartedEvent$ = {})); - function toolExecutionStartedEventToJSON(toolExecutionStartedEvent) { - return JSON.stringify(exports.ToolExecutionStartedEvent$outboundSchema.parse(toolExecutionStartedEvent)); - } - function toolExecutionStartedEventFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ToolExecutionStartedEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ToolExecutionStartedEvent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationevents.js - var require_conversationevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationEvents$ = exports.ConversationEvents$outboundSchema = exports.ConversationEvents$inboundSchema = exports.ConversationEventsData$ = exports.ConversationEventsData$outboundSchema = exports.ConversationEventsData$inboundSchema = void 0; - exports.conversationEventsDataToJSON = conversationEventsDataToJSON; - exports.conversationEventsDataFromJSON = conversationEventsDataFromJSON; - exports.conversationEventsToJSON = conversationEventsToJSON; - exports.conversationEventsFromJSON = conversationEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var agenthandoffdoneevent_js_1 = require_agenthandoffdoneevent(); - var agenthandoffstartedevent_js_1 = require_agenthandoffstartedevent(); - var functioncallevent_js_1 = require_functioncallevent(); - var messageoutputevent_js_1 = require_messageoutputevent(); - var responsedoneevent_js_1 = require_responsedoneevent(); - var responseerrorevent_js_1 = require_responseerrorevent(); - var responsestartedevent_js_1 = require_responsestartedevent(); - var ssetypes_js_1 = require_ssetypes(); - var toolexecutiondeltaevent_js_1 = require_toolexecutiondeltaevent(); - var toolexecutiondoneevent_js_1 = require_toolexecutiondoneevent(); - var toolexecutionstartedevent_js_1 = require_toolexecutionstartedevent(); - exports.ConversationEventsData$inboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - exports.ConversationEventsData$outboundSchema = z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type - }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]); - var ConversationEventsData$; - (function(ConversationEventsData$2) { - ConversationEventsData$2.inboundSchema = exports.ConversationEventsData$inboundSchema; - ConversationEventsData$2.outboundSchema = exports.ConversationEventsData$outboundSchema; - })(ConversationEventsData$ || (exports.ConversationEventsData$ = ConversationEventsData$ = {})); - function conversationEventsDataToJSON(conversationEventsData) { - return JSON.stringify(exports.ConversationEventsData$outboundSchema.parse(conversationEventsData)); - } - function conversationEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEventsData' from JSON`); - } - exports.ConversationEvents$inboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - functioncallevent_js_1.FunctionCallEvent$inboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$inboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ type: v.type }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ type: v.type }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$inboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ type: v.type }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$inboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$inboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.ConversationEvents$outboundSchema = z.object({ - event: ssetypes_js_1.SSETypes$outboundSchema, - data: z.union([ - functioncallevent_js_1.FunctionCallEvent$outboundSchema.and(z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type - }))), - agenthandoffdoneevent_js_1.AgentHandoffDoneEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type - }))), - agenthandoffstartedevent_js_1.AgentHandoffStartedEvent$outboundSchema.and(z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondeltaevent_js_1.ToolExecutionDeltaEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutionstartedevent_js_1.ToolExecutionStartedEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ type: v.type }))), - responseerrorevent_js_1.ResponseErrorEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.error") }).transform((v) => ({ type: v.type }))), - messageoutputevent_js_1.MessageOutputEvent$outboundSchema.and(z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type - }))), - toolexecutiondoneevent_js_1.ToolExecutionDoneEvent$outboundSchema.and(z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type - }))), - responsedoneevent_js_1.ResponseDoneEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.done") }).transform((v) => ({ type: v.type }))), - responsestartedevent_js_1.ResponseStartedEvent$outboundSchema.and(z.object({ type: z.literal("conversation.response.started") }).transform((v) => ({ type: v.type }))) - ]) - }); - var ConversationEvents$; - (function(ConversationEvents$2) { - ConversationEvents$2.inboundSchema = exports.ConversationEvents$inboundSchema; - ConversationEvents$2.outboundSchema = exports.ConversationEvents$outboundSchema; - })(ConversationEvents$ || (exports.ConversationEvents$ = ConversationEvents$ = {})); - function conversationEventsToJSON(conversationEvents) { - return JSON.stringify(exports.ConversationEvents$outboundSchema.parse(conversationEvents)); - } - function conversationEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationhistory.js - var require_conversationhistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationhistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationHistory$ = exports.ConversationHistory$outboundSchema = exports.ConversationHistory$inboundSchema = exports.Entries$ = exports.Entries$outboundSchema = exports.Entries$inboundSchema = exports.ConversationHistoryObject$ = exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema = exports.ConversationHistoryObject = void 0; - exports.entriesToJSON = entriesToJSON; - exports.entriesFromJSON = entriesFromJSON; - exports.conversationHistoryToJSON = conversationHistoryToJSON; - exports.conversationHistoryFromJSON = conversationHistoryFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var functioncallentry_js_1 = require_functioncallentry(); - var functionresultentry_js_1 = require_functionresultentry(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationHistoryObject = { - ConversationHistory: "conversation.history" - }; - exports.ConversationHistoryObject$inboundSchema = z.nativeEnum(exports.ConversationHistoryObject); - exports.ConversationHistoryObject$outboundSchema = exports.ConversationHistoryObject$inboundSchema; - var ConversationHistoryObject$; - (function(ConversationHistoryObject$2) { - ConversationHistoryObject$2.inboundSchema = exports.ConversationHistoryObject$inboundSchema; - ConversationHistoryObject$2.outboundSchema = exports.ConversationHistoryObject$outboundSchema; - })(ConversationHistoryObject$ || (exports.ConversationHistoryObject$ = ConversationHistoryObject$ = {})); - exports.Entries$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Entries$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Entries$; - (function(Entries$2) { - Entries$2.inboundSchema = exports.Entries$inboundSchema; - Entries$2.outboundSchema = exports.Entries$outboundSchema; - })(Entries$ || (exports.Entries$ = Entries$ = {})); - function entriesToJSON(entries) { - return JSON.stringify(exports.Entries$outboundSchema.parse(entries)); - } - function entriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Entries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Entries' from JSON`); - } - exports.ConversationHistory$inboundSchema = z.object({ - object: exports.ConversationHistoryObject$inboundSchema.default("conversation.history"), - conversation_id: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - messageinputentry_js_1.MessageInputEntry$inboundSchema, - functionresultentry_js_1.FunctionResultEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationHistory$outboundSchema = z.object({ - object: exports.ConversationHistoryObject$outboundSchema.default("conversation.history"), - conversationId: z.string(), - entries: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - messageinputentry_js_1.MessageInputEntry$outboundSchema, - functionresultentry_js_1.FunctionResultEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationHistory$; - (function(ConversationHistory$2) { - ConversationHistory$2.inboundSchema = exports.ConversationHistory$inboundSchema; - ConversationHistory$2.outboundSchema = exports.ConversationHistory$outboundSchema; - })(ConversationHistory$ || (exports.ConversationHistory$ = ConversationHistory$ = {})); - function conversationHistoryToJSON(conversationHistory) { - return JSON.stringify(exports.ConversationHistory$outboundSchema.parse(conversationHistory)); - } - function conversationHistoryFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationHistory$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationHistory' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/messageentries.js - var require_messageentries = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/messageentries.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MessageEntries$ = exports.MessageEntries$outboundSchema = exports.MessageEntries$inboundSchema = void 0; - exports.messageEntriesToJSON = messageEntriesToJSON; - exports.messageEntriesFromJSON = messageEntriesFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var messageinputentry_js_1 = require_messageinputentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - exports.MessageEntries$inboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.MessageEntries$outboundSchema = z.union([ - messageinputentry_js_1.MessageInputEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var MessageEntries$; - (function(MessageEntries$2) { - MessageEntries$2.inboundSchema = exports.MessageEntries$inboundSchema; - MessageEntries$2.outboundSchema = exports.MessageEntries$outboundSchema; - })(MessageEntries$ || (exports.MessageEntries$ = MessageEntries$ = {})); - function messageEntriesToJSON(messageEntries) { - return JSON.stringify(exports.MessageEntries$outboundSchema.parse(messageEntries)); - } - function messageEntriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.MessageEntries$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'MessageEntries' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationmessages.js - var require_conversationmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationMessages$ = exports.ConversationMessages$outboundSchema = exports.ConversationMessages$inboundSchema = exports.ConversationMessagesObject$ = exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema = exports.ConversationMessagesObject = void 0; - exports.conversationMessagesToJSON = conversationMessagesToJSON; - exports.conversationMessagesFromJSON = conversationMessagesFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var messageentries_js_1 = require_messageentries(); - exports.ConversationMessagesObject = { - ConversationMessages: "conversation.messages" - }; - exports.ConversationMessagesObject$inboundSchema = z.nativeEnum(exports.ConversationMessagesObject); - exports.ConversationMessagesObject$outboundSchema = exports.ConversationMessagesObject$inboundSchema; - var ConversationMessagesObject$; - (function(ConversationMessagesObject$2) { - ConversationMessagesObject$2.inboundSchema = exports.ConversationMessagesObject$inboundSchema; - ConversationMessagesObject$2.outboundSchema = exports.ConversationMessagesObject$outboundSchema; - })(ConversationMessagesObject$ || (exports.ConversationMessagesObject$ = ConversationMessagesObject$ = {})); - exports.ConversationMessages$inboundSchema = z.object({ - object: exports.ConversationMessagesObject$inboundSchema.default("conversation.messages"), - conversation_id: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationMessages$outboundSchema = z.object({ - object: exports.ConversationMessagesObject$outboundSchema.default("conversation.messages"), - conversationId: z.string(), - messages: z.array(messageentries_js_1.MessageEntries$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationMessages$; - (function(ConversationMessages$2) { - ConversationMessages$2.inboundSchema = exports.ConversationMessages$inboundSchema; - ConversationMessages$2.outboundSchema = exports.ConversationMessages$outboundSchema; - })(ConversationMessages$ || (exports.ConversationMessages$ = ConversationMessages$ = {})); - function conversationMessagesToJSON(conversationMessages) { - return JSON.stringify(exports.ConversationMessages$outboundSchema.parse(conversationMessages)); - } - function conversationMessagesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationMessages$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationMessages' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrequest.js - var require_conversationrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRequest$ = exports.ConversationRequest$outboundSchema = exports.ConversationRequest$inboundSchema = exports.Tools$ = exports.Tools$outboundSchema = exports.Tools$inboundSchema = exports.HandoffExecution$ = exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema = exports.HandoffExecution = void 0; - exports.toolsToJSON = toolsToJSON; - exports.toolsFromJSON = toolsFromJSON; - exports.conversationRequestToJSON = conversationRequestToJSON; - exports.conversationRequestFromJSON = conversationRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.HandoffExecution = { - Client: "client", - Server: "server" - }; - exports.HandoffExecution$inboundSchema = z.nativeEnum(exports.HandoffExecution); - exports.HandoffExecution$outboundSchema = exports.HandoffExecution$inboundSchema; - var HandoffExecution$; - (function(HandoffExecution$2) { - HandoffExecution$2.inboundSchema = exports.HandoffExecution$inboundSchema; - HandoffExecution$2.outboundSchema = exports.HandoffExecution$outboundSchema; - })(HandoffExecution$ || (exports.HandoffExecution$ = HandoffExecution$ = {})); - exports.Tools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Tools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var Tools$; - (function(Tools$2) { - Tools$2.inboundSchema = exports.Tools$inboundSchema; - Tools$2.outboundSchema = exports.Tools$outboundSchema; - })(Tools$ || (exports.Tools$ = Tools$ = {})); - function toolsToJSON(tools) { - return JSON.stringify(exports.Tools$outboundSchema.parse(tools)); - } - function toolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Tools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Tools' from JSON`); - } - exports.ConversationRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.HandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.HandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationRequest$; - (function(ConversationRequest$2) { - ConversationRequest$2.inboundSchema = exports.ConversationRequest$inboundSchema; - ConversationRequest$2.outboundSchema = exports.ConversationRequest$outboundSchema; - })(ConversationRequest$ || (exports.ConversationRequest$ = ConversationRequest$ = {})); - function conversationRequestToJSON(conversationRequest) { - return JSON.stringify(exports.ConversationRequest$outboundSchema.parse(conversationRequest)); - } - function conversationRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationresponse.js - var require_conversationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationResponse$ = exports.ConversationResponse$outboundSchema = exports.ConversationResponse$inboundSchema = exports.Outputs$ = exports.Outputs$outboundSchema = exports.Outputs$inboundSchema = exports.ConversationResponseObject$ = exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema = exports.ConversationResponseObject = void 0; - exports.outputsToJSON = outputsToJSON; - exports.outputsFromJSON = outputsFromJSON; - exports.conversationResponseToJSON = conversationResponseToJSON; - exports.conversationResponseFromJSON = conversationResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var agenthandoffentry_js_1 = require_agenthandoffentry(); - var conversationusageinfo_js_1 = require_conversationusageinfo(); - var functioncallentry_js_1 = require_functioncallentry(); - var messageoutputentry_js_1 = require_messageoutputentry(); - var toolexecutionentry_js_1 = require_toolexecutionentry(); - exports.ConversationResponseObject = { - ConversationResponse: "conversation.response" - }; - exports.ConversationResponseObject$inboundSchema = z.nativeEnum(exports.ConversationResponseObject); - exports.ConversationResponseObject$outboundSchema = exports.ConversationResponseObject$inboundSchema; - var ConversationResponseObject$; - (function(ConversationResponseObject$2) { - ConversationResponseObject$2.inboundSchema = exports.ConversationResponseObject$inboundSchema; - ConversationResponseObject$2.outboundSchema = exports.ConversationResponseObject$outboundSchema; - })(ConversationResponseObject$ || (exports.ConversationResponseObject$ = ConversationResponseObject$ = {})); - exports.Outputs$inboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ]); - exports.Outputs$outboundSchema = z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ]); - var Outputs$; - (function(Outputs$2) { - Outputs$2.inboundSchema = exports.Outputs$inboundSchema; - Outputs$2.outboundSchema = exports.Outputs$outboundSchema; - })(Outputs$ || (exports.Outputs$ = Outputs$ = {})); - function outputsToJSON(outputs) { - return JSON.stringify(exports.Outputs$outboundSchema.parse(outputs)); - } - function outputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Outputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Outputs' from JSON`); - } - exports.ConversationResponse$inboundSchema = z.object({ - object: exports.ConversationResponseObject$inboundSchema.default("conversation.response"), - conversation_id: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$inboundSchema, - functioncallentry_js_1.FunctionCallEntry$inboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$inboundSchema, - messageoutputentry_js_1.MessageOutputEntry$inboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.ConversationResponse$outboundSchema = z.object({ - object: exports.ConversationResponseObject$outboundSchema.default("conversation.response"), - conversationId: z.string(), - outputs: z.array(z.union([ - agenthandoffentry_js_1.AgentHandoffEntry$outboundSchema, - functioncallentry_js_1.FunctionCallEntry$outboundSchema, - toolexecutionentry_js_1.ToolExecutionEntry$outboundSchema, - messageoutputentry_js_1.MessageOutputEntry$outboundSchema - ])), - usage: conversationusageinfo_js_1.ConversationUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var ConversationResponse$; - (function(ConversationResponse$2) { - ConversationResponse$2.inboundSchema = exports.ConversationResponse$inboundSchema; - ConversationResponse$2.outboundSchema = exports.ConversationResponse$outboundSchema; - })(ConversationResponse$ || (exports.ConversationResponse$ = ConversationResponse$ = {})); - function conversationResponseToJSON(conversationResponse) { - return JSON.stringify(exports.ConversationResponse$outboundSchema.parse(conversationResponse)); - } - function conversationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js - var require_conversationrestartrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartRequest$ = exports.ConversationRestartRequest$outboundSchema = exports.ConversationRestartRequest$inboundSchema = exports.ConversationRestartRequestHandoffExecution$ = exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema = exports.ConversationRestartRequestHandoffExecution = void 0; - exports.conversationRestartRequestToJSON = conversationRestartRequestToJSON; - exports.conversationRestartRequestFromJSON = conversationRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartRequestHandoffExecution); - exports.ConversationRestartRequestHandoffExecution$outboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - var ConversationRestartRequestHandoffExecution$; - (function(ConversationRestartRequestHandoffExecution$2) { - ConversationRestartRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartRequestHandoffExecution$inboundSchema; - ConversationRestartRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartRequestHandoffExecution$outboundSchema; - })(ConversationRestartRequestHandoffExecution$ || (exports.ConversationRestartRequestHandoffExecution$ = ConversationRestartRequestHandoffExecution$ = {})); - exports.ConversationRestartRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartRequest$; - (function(ConversationRestartRequest$2) { - ConversationRestartRequest$2.inboundSchema = exports.ConversationRestartRequest$inboundSchema; - ConversationRestartRequest$2.outboundSchema = exports.ConversationRestartRequest$outboundSchema; - })(ConversationRestartRequest$ || (exports.ConversationRestartRequest$ = ConversationRestartRequest$ = {})); - function conversationRestartRequestToJSON(conversationRestartRequest) { - return JSON.stringify(exports.ConversationRestartRequest$outboundSchema.parse(conversationRestartRequest)); - } - function conversationRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js - var require_conversationrestartstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationrestartstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationRestartStreamRequest$ = exports.ConversationRestartStreamRequest$outboundSchema = exports.ConversationRestartStreamRequest$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$ = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution = void 0; - exports.conversationRestartStreamRequestToJSON = conversationRestartStreamRequestToJSON; - exports.conversationRestartStreamRequestFromJSON = conversationRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - exports.ConversationRestartStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationRestartStreamRequestHandoffExecution); - exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - var ConversationRestartStreamRequestHandoffExecution$; - (function(ConversationRestartStreamRequestHandoffExecution$2) { - ConversationRestartStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema; - ConversationRestartStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema; - })(ConversationRestartStreamRequestHandoffExecution$ || (exports.ConversationRestartStreamRequestHandoffExecution$ = ConversationRestartStreamRequestHandoffExecution$ = {})); - exports.ConversationRestartStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: exports.ConversationRestartStreamRequestHandoffExecution$inboundSchema.default("server"), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId" - }); - }); - exports.ConversationRestartStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: exports.ConversationRestartStreamRequestHandoffExecution$outboundSchema.default("server"), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id" - }); - }); - var ConversationRestartStreamRequest$; - (function(ConversationRestartStreamRequest$2) { - ConversationRestartStreamRequest$2.inboundSchema = exports.ConversationRestartStreamRequest$inboundSchema; - ConversationRestartStreamRequest$2.outboundSchema = exports.ConversationRestartStreamRequest$outboundSchema; - })(ConversationRestartStreamRequest$ || (exports.ConversationRestartStreamRequest$ = ConversationRestartStreamRequest$ = {})); - function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest) { - return JSON.stringify(exports.ConversationRestartStreamRequest$outboundSchema.parse(conversationRestartStreamRequest)); - } - function conversationRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js - var require_conversationstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/conversationstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ConversationStreamRequest$ = exports.ConversationStreamRequest$outboundSchema = exports.ConversationStreamRequest$inboundSchema = exports.ConversationStreamRequestTools$ = exports.ConversationStreamRequestTools$outboundSchema = exports.ConversationStreamRequestTools$inboundSchema = exports.ConversationStreamRequestHandoffExecution$ = exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema = exports.ConversationStreamRequestHandoffExecution = void 0; - exports.conversationStreamRequestToolsToJSON = conversationStreamRequestToolsToJSON; - exports.conversationStreamRequestToolsFromJSON = conversationStreamRequestToolsFromJSON; - exports.conversationStreamRequestToJSON = conversationStreamRequestToJSON; - exports.conversationStreamRequestFromJSON = conversationStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var conversationinputs_js_1 = require_conversationinputs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ConversationStreamRequestHandoffExecution = { - Client: "client", - Server: "server" - }; - exports.ConversationStreamRequestHandoffExecution$inboundSchema = z.nativeEnum(exports.ConversationStreamRequestHandoffExecution); - exports.ConversationStreamRequestHandoffExecution$outboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - var ConversationStreamRequestHandoffExecution$; - (function(ConversationStreamRequestHandoffExecution$2) { - ConversationStreamRequestHandoffExecution$2.inboundSchema = exports.ConversationStreamRequestHandoffExecution$inboundSchema; - ConversationStreamRequestHandoffExecution$2.outboundSchema = exports.ConversationStreamRequestHandoffExecution$outboundSchema; - })(ConversationStreamRequestHandoffExecution$ || (exports.ConversationStreamRequestHandoffExecution$ = ConversationStreamRequestHandoffExecution$ = {})); - exports.ConversationStreamRequestTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ConversationStreamRequestTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ConversationStreamRequestTools$; - (function(ConversationStreamRequestTools$2) { - ConversationStreamRequestTools$2.inboundSchema = exports.ConversationStreamRequestTools$inboundSchema; - ConversationStreamRequestTools$2.outboundSchema = exports.ConversationStreamRequestTools$outboundSchema; - })(ConversationStreamRequestTools$ || (exports.ConversationStreamRequestTools$ = ConversationStreamRequestTools$ = {})); - function conversationStreamRequestToolsToJSON(conversationStreamRequestTools) { - return JSON.stringify(exports.ConversationStreamRequestTools$outboundSchema.parse(conversationStreamRequestTools)); - } - function conversationStreamRequestToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequestTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequestTools' from JSON`); - } - exports.ConversationStreamRequest$inboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(exports.ConversationStreamRequestHandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completion_args: z.nullable(completionargs_js_1.CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId" - }); - }); - exports.ConversationStreamRequest$outboundSchema = z.object({ - inputs: conversationinputs_js_1.ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(exports.ConversationStreamRequestHandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable(z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ type: v.type }))) - ]))).optional(), - completionArgs: z.nullable(completionargs_js_1.CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id" - }); - }); - var ConversationStreamRequest$; - (function(ConversationStreamRequest$2) { - ConversationStreamRequest$2.inboundSchema = exports.ConversationStreamRequest$inboundSchema; - ConversationStreamRequest$2.outboundSchema = exports.ConversationStreamRequest$outboundSchema; - })(ConversationStreamRequest$ || (exports.ConversationStreamRequest$ = ConversationStreamRequest$ = {})); - function conversationStreamRequestToJSON(conversationStreamRequest) { - return JSON.stringify(exports.ConversationStreamRequest$outboundSchema.parse(conversationStreamRequest)); - } - function conversationStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ConversationStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ConversationStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletefileout.js - var require_deletefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteFileOut$ = exports.DeleteFileOut$outboundSchema = exports.DeleteFileOut$inboundSchema = void 0; - exports.deleteFileOutToJSON = deleteFileOutToJSON; - exports.deleteFileOutFromJSON = deleteFileOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - exports.DeleteFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean() - }); - var DeleteFileOut$; - (function(DeleteFileOut$2) { - DeleteFileOut$2.inboundSchema = exports.DeleteFileOut$inboundSchema; - DeleteFileOut$2.outboundSchema = exports.DeleteFileOut$outboundSchema; - })(DeleteFileOut$ || (exports.DeleteFileOut$ = DeleteFileOut$ = {})); - function deleteFileOutToJSON(deleteFileOut) { - return JSON.stringify(exports.DeleteFileOut$outboundSchema.parse(deleteFileOut)); - } - function deleteFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/deletemodelout.js - var require_deletemodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/deletemodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelOut$ = exports.DeleteModelOut$outboundSchema = exports.DeleteModelOut$inboundSchema = void 0; - exports.deleteModelOutToJSON = deleteModelOutToJSON; - exports.deleteModelOutFromJSON = deleteModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DeleteModelOut$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - exports.DeleteModelOut$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true) - }); - var DeleteModelOut$; - (function(DeleteModelOut$2) { - DeleteModelOut$2.inboundSchema = exports.DeleteModelOut$inboundSchema; - DeleteModelOut$2.outboundSchema = exports.DeleteModelOut$outboundSchema; - })(DeleteModelOut$ || (exports.DeleteModelOut$ = DeleteModelOut$ = {})); - function deleteModelOutToJSON(deleteModelOut) { - return JSON.stringify(exports.DeleteModelOut$outboundSchema.parse(deleteModelOut)); - } - function deleteModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentout.js - var require_documentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentOut$ = exports.DocumentOut$outboundSchema = exports.DocumentOut$inboundSchema = void 0; - exports.documentOutToJSON = documentOutToJSON; - exports.documentOutFromJSON = documentOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DocumentOut$inboundSchema = z.object({ - id: z.string(), - library_id: z.string(), - hash: z.string(), - mime_type: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - last_processed_at: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - number_of_pages: z.nullable(z.number().int()).optional(), - processing_status: z.string(), - uploaded_by_id: z.string(), - uploaded_by_type: z.string(), - tokens_processing_main_content: z.nullable(z.number().int()).optional(), - tokens_processing_summary: z.nullable(z.number().int()).optional(), - tokens_processing_total: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "mime_type": "mimeType", - "created_at": "createdAt", - "last_processed_at": "lastProcessedAt", - "number_of_pages": "numberOfPages", - "processing_status": "processingStatus", - "uploaded_by_id": "uploadedById", - "uploaded_by_type": "uploadedByType", - "tokens_processing_main_content": "tokensProcessingMainContent", - "tokens_processing_summary": "tokensProcessingSummary", - "tokens_processing_total": "tokensProcessingTotal" - }); - }); - exports.DocumentOut$outboundSchema = z.object({ - id: z.string(), - libraryId: z.string(), - hash: z.string(), - mimeType: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - createdAt: z.date().transform((v) => v.toISOString()), - lastProcessedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - numberOfPages: z.nullable(z.number().int()).optional(), - processingStatus: z.string(), - uploadedById: z.string(), - uploadedByType: z.string(), - tokensProcessingMainContent: z.nullable(z.number().int()).optional(), - tokensProcessingSummary: z.nullable(z.number().int()).optional(), - tokensProcessingTotal: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - mimeType: "mime_type", - createdAt: "created_at", - lastProcessedAt: "last_processed_at", - numberOfPages: "number_of_pages", - processingStatus: "processing_status", - uploadedById: "uploaded_by_id", - uploadedByType: "uploaded_by_type", - tokensProcessingMainContent: "tokens_processing_main_content", - tokensProcessingSummary: "tokens_processing_summary", - tokensProcessingTotal: "tokens_processing_total" - }); - }); - var DocumentOut$; - (function(DocumentOut$2) { - DocumentOut$2.inboundSchema = exports.DocumentOut$inboundSchema; - DocumentOut$2.outboundSchema = exports.DocumentOut$outboundSchema; - })(DocumentOut$ || (exports.DocumentOut$ = DocumentOut$ = {})); - function documentOutToJSON(documentOut) { - return JSON.stringify(exports.DocumentOut$outboundSchema.parse(documentOut)); - } - function documentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documenttextcontent.js - var require_documenttextcontent = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documenttextcontent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentTextContent$ = exports.DocumentTextContent$outboundSchema = exports.DocumentTextContent$inboundSchema = void 0; - exports.documentTextContentToJSON = documentTextContentToJSON; - exports.documentTextContentFromJSON = documentTextContentFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentTextContent$inboundSchema = z.object({ - text: z.string() - }); - exports.DocumentTextContent$outboundSchema = z.object({ - text: z.string() - }); - var DocumentTextContent$; - (function(DocumentTextContent$2) { - DocumentTextContent$2.inboundSchema = exports.DocumentTextContent$inboundSchema; - DocumentTextContent$2.outboundSchema = exports.DocumentTextContent$outboundSchema; - })(DocumentTextContent$ || (exports.DocumentTextContent$ = DocumentTextContent$ = {})); - function documentTextContentToJSON(documentTextContent) { - return JSON.stringify(exports.DocumentTextContent$outboundSchema.parse(documentTextContent)); - } - function documentTextContentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentTextContent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentTextContent' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/documentupdatein.js - var require_documentupdatein = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/documentupdatein.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DocumentUpdateIn$ = exports.DocumentUpdateIn$outboundSchema = exports.DocumentUpdateIn$inboundSchema = void 0; - exports.documentUpdateInToJSON = documentUpdateInToJSON; - exports.documentUpdateInFromJSON = documentUpdateInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.DocumentUpdateIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - exports.DocumentUpdateIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional() - }); - var DocumentUpdateIn$; - (function(DocumentUpdateIn$2) { - DocumentUpdateIn$2.inboundSchema = exports.DocumentUpdateIn$inboundSchema; - DocumentUpdateIn$2.outboundSchema = exports.DocumentUpdateIn$outboundSchema; - })(DocumentUpdateIn$ || (exports.DocumentUpdateIn$ = DocumentUpdateIn$ = {})); - function documentUpdateInToJSON(documentUpdateIn) { - return JSON.stringify(exports.DocumentUpdateIn$outboundSchema.parse(documentUpdateIn)); - } - function documentUpdateInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DocumentUpdateIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentUpdateIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingdtype.js - var require_embeddingdtype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingdtype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingDtype$ = exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema = exports.EmbeddingDtype = void 0; - var z = __importStar(require_zod()); - exports.EmbeddingDtype = { - Float: "float", - Int8: "int8", - Uint8: "uint8", - Binary: "binary", - Ubinary: "ubinary" - }; - exports.EmbeddingDtype$inboundSchema = z.nativeEnum(exports.EmbeddingDtype); - exports.EmbeddingDtype$outboundSchema = exports.EmbeddingDtype$inboundSchema; - var EmbeddingDtype$; - (function(EmbeddingDtype$2) { - EmbeddingDtype$2.inboundSchema = exports.EmbeddingDtype$inboundSchema; - EmbeddingDtype$2.outboundSchema = exports.EmbeddingDtype$outboundSchema; - })(EmbeddingDtype$ || (exports.EmbeddingDtype$ = EmbeddingDtype$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/encodingformat.js - var require_encodingformat = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/encodingformat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EncodingFormat$ = exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema = exports.EncodingFormat = void 0; - var z = __importStar(require_zod()); - exports.EncodingFormat = { - Float: "float", - Base64: "base64" - }; - exports.EncodingFormat$inboundSchema = z.nativeEnum(exports.EncodingFormat); - exports.EncodingFormat$outboundSchema = exports.EncodingFormat$inboundSchema; - var EncodingFormat$; - (function(EncodingFormat$2) { - EncodingFormat$2.inboundSchema = exports.EncodingFormat$inboundSchema; - EncodingFormat$2.outboundSchema = exports.EncodingFormat$outboundSchema; - })(EncodingFormat$ || (exports.EncodingFormat$ = EncodingFormat$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingrequest.js - var require_embeddingrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingRequest$ = exports.EmbeddingRequest$outboundSchema = exports.EmbeddingRequest$inboundSchema = exports.EmbeddingRequestInputs$ = exports.EmbeddingRequestInputs$outboundSchema = exports.EmbeddingRequestInputs$inboundSchema = void 0; - exports.embeddingRequestInputsToJSON = embeddingRequestInputsToJSON; - exports.embeddingRequestInputsFromJSON = embeddingRequestInputsFromJSON; - exports.embeddingRequestToJSON = embeddingRequestToJSON; - exports.embeddingRequestFromJSON = embeddingRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var embeddingdtype_js_1 = require_embeddingdtype(); - var encodingformat_js_1 = require_encodingformat(); - exports.EmbeddingRequestInputs$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.EmbeddingRequestInputs$outboundSchema = z.union([z.string(), z.array(z.string())]); - var EmbeddingRequestInputs$; - (function(EmbeddingRequestInputs$2) { - EmbeddingRequestInputs$2.inboundSchema = exports.EmbeddingRequestInputs$inboundSchema; - EmbeddingRequestInputs$2.outboundSchema = exports.EmbeddingRequestInputs$outboundSchema; - })(EmbeddingRequestInputs$ || (exports.EmbeddingRequestInputs$ = EmbeddingRequestInputs$ = {})); - function embeddingRequestInputsToJSON(embeddingRequestInputs) { - return JSON.stringify(exports.EmbeddingRequestInputs$outboundSchema.parse(embeddingRequestInputs)); - } - function embeddingRequestInputsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequestInputs$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequestInputs' from JSON`); - } - exports.EmbeddingRequest$inboundSchema = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]), - output_dimension: z.nullable(z.number().int()).optional(), - output_dtype: embeddingdtype_js_1.EmbeddingDtype$inboundSchema.optional(), - encoding_format: encodingformat_js_1.EncodingFormat$inboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "input": "inputs", - "output_dimension": "outputDimension", - "output_dtype": "outputDtype", - "encoding_format": "encodingFormat" - }); - }); - exports.EmbeddingRequest$outboundSchema = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]), - outputDimension: z.nullable(z.number().int()).optional(), - outputDtype: embeddingdtype_js_1.EmbeddingDtype$outboundSchema.optional(), - encodingFormat: encodingformat_js_1.EncodingFormat$outboundSchema.optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - inputs: "input", - outputDimension: "output_dimension", - outputDtype: "output_dtype", - encodingFormat: "encoding_format" - }); - }); - var EmbeddingRequest$; - (function(EmbeddingRequest$2) { - EmbeddingRequest$2.inboundSchema = exports.EmbeddingRequest$inboundSchema; - EmbeddingRequest$2.outboundSchema = exports.EmbeddingRequest$outboundSchema; - })(EmbeddingRequest$ || (exports.EmbeddingRequest$ = EmbeddingRequest$ = {})); - function embeddingRequestToJSON(embeddingRequest) { - return JSON.stringify(exports.EmbeddingRequest$outboundSchema.parse(embeddingRequest)); - } - function embeddingRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js - var require_embeddingresponsedata = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponsedata.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponseData$ = exports.EmbeddingResponseData$outboundSchema = exports.EmbeddingResponseData$inboundSchema = void 0; - exports.embeddingResponseDataToJSON = embeddingResponseDataToJSON; - exports.embeddingResponseDataFromJSON = embeddingResponseDataFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.EmbeddingResponseData$inboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - exports.EmbeddingResponseData$outboundSchema = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional() - }); - var EmbeddingResponseData$; - (function(EmbeddingResponseData$2) { - EmbeddingResponseData$2.inboundSchema = exports.EmbeddingResponseData$inboundSchema; - EmbeddingResponseData$2.outboundSchema = exports.EmbeddingResponseData$outboundSchema; - })(EmbeddingResponseData$ || (exports.EmbeddingResponseData$ = EmbeddingResponseData$ = {})); - function embeddingResponseDataToJSON(embeddingResponseData) { - return JSON.stringify(exports.EmbeddingResponseData$outboundSchema.parse(embeddingResponseData)); - } - function embeddingResponseDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponseData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponseData' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/embeddingresponse.js - var require_embeddingresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/embeddingresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EmbeddingResponse$ = exports.EmbeddingResponse$outboundSchema = exports.EmbeddingResponse$inboundSchema = void 0; - exports.embeddingResponseToJSON = embeddingResponseToJSON; - exports.embeddingResponseFromJSON = embeddingResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var embeddingresponsedata_js_1 = require_embeddingresponsedata(); - var usageinfo_js_1 = require_usageinfo(); - exports.EmbeddingResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$inboundSchema) - }); - exports.EmbeddingResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - data: z.array(embeddingresponsedata_js_1.EmbeddingResponseData$outboundSchema) - }); - var EmbeddingResponse$; - (function(EmbeddingResponse$2) { - EmbeddingResponse$2.inboundSchema = exports.EmbeddingResponse$inboundSchema; - EmbeddingResponse$2.outboundSchema = exports.EmbeddingResponse$outboundSchema; - })(EmbeddingResponse$ || (exports.EmbeddingResponse$ = EmbeddingResponse$ = {})); - function embeddingResponseToJSON(embeddingResponse) { - return JSON.stringify(exports.EmbeddingResponse$outboundSchema.parse(embeddingResponse)); - } - function embeddingResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.EmbeddingResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'EmbeddingResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/entitytype.js - var require_entitytype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/entitytype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EntityType$ = exports.EntityType$outboundSchema = exports.EntityType$inboundSchema = exports.EntityType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.EntityType = { - User: "User", - Workspace: "Workspace", - Org: "Org" - }; - exports.EntityType$inboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.EntityType$outboundSchema = z.union([ - z.nativeEnum(exports.EntityType), - z.string().and(z.custom()) - ]); - var EntityType$; - (function(EntityType$2) { - EntityType$2.inboundSchema = exports.EntityType$inboundSchema; - EntityType$2.outboundSchema = exports.EntityType$outboundSchema; - })(EntityType$ || (exports.EntityType$ = EntityType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/filepurpose.js - var require_filepurpose = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filepurpose.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilePurpose$ = exports.FilePurpose$outboundSchema = exports.FilePurpose$inboundSchema = exports.FilePurpose = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.FilePurpose = { - FineTune: "fine-tune", - Batch: "batch", - Ocr: "ocr" - }; - exports.FilePurpose$inboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.FilePurpose$outboundSchema = z.union([ - z.nativeEnum(exports.FilePurpose), - z.string().and(z.custom()) - ]); - var FilePurpose$; - (function(FilePurpose$2) { - FilePurpose$2.inboundSchema = exports.FilePurpose$inboundSchema; - FilePurpose$2.outboundSchema = exports.FilePurpose$outboundSchema; - })(FilePurpose$ || (exports.FilePurpose$ = FilePurpose$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sampletype.js - var require_sampletype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sampletype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SampleType$ = exports.SampleType$outboundSchema = exports.SampleType$inboundSchema = exports.SampleType = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.SampleType = { - Pretrain: "pretrain", - Instruct: "instruct", - BatchRequest: "batch_request", - BatchResult: "batch_result", - BatchError: "batch_error" - }; - exports.SampleType$inboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.SampleType$outboundSchema = z.union([ - z.nativeEnum(exports.SampleType), - z.string().and(z.custom()) - ]); - var SampleType$; - (function(SampleType$2) { - SampleType$2.inboundSchema = exports.SampleType$inboundSchema; - SampleType$2.outboundSchema = exports.SampleType$outboundSchema; - })(SampleType$ || (exports.SampleType$ = SampleType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/source.js - var require_source = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/source.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Source$ = exports.Source$outboundSchema = exports.Source$inboundSchema = exports.Source = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.Source = { - Upload: "upload", - Repository: "repository", - Mistral: "mistral" - }; - exports.Source$inboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.Source$outboundSchema = z.union([ - z.nativeEnum(exports.Source), - z.string().and(z.custom()) - ]); - var Source$; - (function(Source$2) { - Source$2.inboundSchema = exports.Source$inboundSchema; - Source$2.outboundSchema = exports.Source$outboundSchema; - })(Source$ || (exports.Source$ = Source$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/fileschema.js - var require_fileschema = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fileschema.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSchema$ = exports.FileSchema$outboundSchema = exports.FileSchema$inboundSchema = void 0; - exports.fileSchemaToJSON = fileSchemaToJSON; - exports.fileSchemaFromJSON = fileSchemaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.FileSchema$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.FileSchema$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var FileSchema$; - (function(FileSchema$2) { - FileSchema$2.inboundSchema = exports.FileSchema$inboundSchema; - FileSchema$2.outboundSchema = exports.FileSchema$outboundSchema; - })(FileSchema$ || (exports.FileSchema$ = FileSchema$ = {})); - function fileSchemaToJSON(fileSchema) { - return JSON.stringify(exports.FileSchema$outboundSchema.parse(fileSchema)); - } - function fileSchemaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSchema$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSchema' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/filesignedurl.js - var require_filesignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/filesignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FileSignedURL$ = exports.FileSignedURL$outboundSchema = exports.FileSignedURL$inboundSchema = void 0; - exports.fileSignedURLToJSON = fileSignedURLToJSON; - exports.fileSignedURLFromJSON = fileSignedURLFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.FileSignedURL$inboundSchema = z.object({ - url: z.string() - }); - exports.FileSignedURL$outboundSchema = z.object({ - url: z.string() - }); - var FileSignedURL$; - (function(FileSignedURL$2) { - FileSignedURL$2.inboundSchema = exports.FileSignedURL$inboundSchema; - FileSignedURL$2.outboundSchema = exports.FileSignedURL$outboundSchema; - })(FileSignedURL$ || (exports.FileSignedURL$ = FileSignedURL$ = {})); - function fileSignedURLToJSON(fileSignedURL) { - return JSON.stringify(exports.FileSignedURL$outboundSchema.parse(fileSignedURL)); - } - function fileSignedURLFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FileSignedURL$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FileSignedURL' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js - var require_fimcompletionrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionRequest$ = exports.FIMCompletionRequest$outboundSchema = exports.FIMCompletionRequest$inboundSchema = exports.FIMCompletionRequestStop$ = exports.FIMCompletionRequestStop$outboundSchema = exports.FIMCompletionRequestStop$inboundSchema = void 0; - exports.fimCompletionRequestStopToJSON = fimCompletionRequestStopToJSON; - exports.fimCompletionRequestStopFromJSON = fimCompletionRequestStopFromJSON; - exports.fimCompletionRequestToJSON = fimCompletionRequestToJSON; - exports.fimCompletionRequestFromJSON = fimCompletionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionRequestStop$; - (function(FIMCompletionRequestStop$2) { - FIMCompletionRequestStop$2.inboundSchema = exports.FIMCompletionRequestStop$inboundSchema; - FIMCompletionRequestStop$2.outboundSchema = exports.FIMCompletionRequestStop$outboundSchema; - })(FIMCompletionRequestStop$ || (exports.FIMCompletionRequestStop$ = FIMCompletionRequestStop$ = {})); - function fimCompletionRequestStopToJSON(fimCompletionRequestStop) { - return JSON.stringify(exports.FIMCompletionRequestStop$outboundSchema.parse(fimCompletionRequestStop)); - } - function fimCompletionRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequestStop' from JSON`); - } - exports.FIMCompletionRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionRequest$; - (function(FIMCompletionRequest$2) { - FIMCompletionRequest$2.inboundSchema = exports.FIMCompletionRequest$inboundSchema; - FIMCompletionRequest$2.outboundSchema = exports.FIMCompletionRequest$outboundSchema; - })(FIMCompletionRequest$ || (exports.FIMCompletionRequest$ = FIMCompletionRequest$ = {})); - function fimCompletionRequestToJSON(fimCompletionRequest) { - return JSON.stringify(exports.FIMCompletionRequest$outboundSchema.parse(fimCompletionRequest)); - } - function fimCompletionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js - var require_fimcompletionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionResponse$ = exports.FIMCompletionResponse$outboundSchema = exports.FIMCompletionResponse$inboundSchema = void 0; - exports.fimCompletionResponseToJSON = fimCompletionResponseToJSON; - exports.fimCompletionResponseFromJSON = fimCompletionResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var chatcompletionchoice_js_1 = require_chatcompletionchoice(); - var usageinfo_js_1 = require_usageinfo(); - exports.FIMCompletionResponse$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$inboundSchema) - }); - exports.FIMCompletionResponse$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(chatcompletionchoice_js_1.ChatCompletionChoice$outboundSchema) - }); - var FIMCompletionResponse$; - (function(FIMCompletionResponse$2) { - FIMCompletionResponse$2.inboundSchema = exports.FIMCompletionResponse$inboundSchema; - FIMCompletionResponse$2.outboundSchema = exports.FIMCompletionResponse$outboundSchema; - })(FIMCompletionResponse$ || (exports.FIMCompletionResponse$ = FIMCompletionResponse$ = {})); - function fimCompletionResponseToJSON(fimCompletionResponse) { - return JSON.stringify(exports.FIMCompletionResponse$outboundSchema.parse(fimCompletionResponse)); - } - function fimCompletionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js - var require_fimcompletionstreamrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/fimcompletionstreamrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FIMCompletionStreamRequest$ = exports.FIMCompletionStreamRequest$outboundSchema = exports.FIMCompletionStreamRequest$inboundSchema = exports.FIMCompletionStreamRequestStop$ = exports.FIMCompletionStreamRequestStop$outboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema = void 0; - exports.fimCompletionStreamRequestStopToJSON = fimCompletionStreamRequestStopToJSON; - exports.fimCompletionStreamRequestStopFromJSON = fimCompletionStreamRequestStopFromJSON; - exports.fimCompletionStreamRequestToJSON = fimCompletionStreamRequestToJSON; - exports.fimCompletionStreamRequestFromJSON = fimCompletionStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FIMCompletionStreamRequestStop$inboundSchema = z.union([z.string(), z.array(z.string())]); - exports.FIMCompletionStreamRequestStop$outboundSchema = z.union([z.string(), z.array(z.string())]); - var FIMCompletionStreamRequestStop$; - (function(FIMCompletionStreamRequestStop$2) { - FIMCompletionStreamRequestStop$2.inboundSchema = exports.FIMCompletionStreamRequestStop$inboundSchema; - FIMCompletionStreamRequestStop$2.outboundSchema = exports.FIMCompletionStreamRequestStop$outboundSchema; - })(FIMCompletionStreamRequestStop$ || (exports.FIMCompletionStreamRequestStop$ = FIMCompletionStreamRequestStop$ = {})); - function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop) { - return JSON.stringify(exports.FIMCompletionStreamRequestStop$outboundSchema.parse(fimCompletionStreamRequestStop)); - } - function fimCompletionStreamRequestStopFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequestStop' from JSON`); - } - exports.FIMCompletionStreamRequest$inboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens" - }); - }); - exports.FIMCompletionStreamRequest$outboundSchema = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens" - }); - }); - var FIMCompletionStreamRequest$; - (function(FIMCompletionStreamRequest$2) { - FIMCompletionStreamRequest$2.inboundSchema = exports.FIMCompletionStreamRequest$inboundSchema; - FIMCompletionStreamRequest$2.outboundSchema = exports.FIMCompletionStreamRequest$outboundSchema; - })(FIMCompletionStreamRequest$ || (exports.FIMCompletionStreamRequest$ = FIMCompletionStreamRequest$ = {})); - function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest) { - return JSON.stringify(exports.FIMCompletionStreamRequest$outboundSchema.parse(fimCompletionStreamRequest)); - } - function fimCompletionStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FIMCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FIMCompletionStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js - var require_finetuneablemodeltype = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/finetuneablemodeltype.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuneableModelType$ = exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema = exports.FineTuneableModelType = void 0; - var z = __importStar(require_zod()); - exports.FineTuneableModelType = { - Completion: "completion", - Classifier: "classifier" - }; - exports.FineTuneableModelType$inboundSchema = z.nativeEnum(exports.FineTuneableModelType); - exports.FineTuneableModelType$outboundSchema = exports.FineTuneableModelType$inboundSchema; - var FineTuneableModelType$; - (function(FineTuneableModelType$2) { - FineTuneableModelType$2.inboundSchema = exports.FineTuneableModelType$inboundSchema; - FineTuneableModelType$2.outboundSchema = exports.FineTuneableModelType$outboundSchema; - })(FineTuneableModelType$ || (exports.FineTuneableModelType$ = FineTuneableModelType$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/ftmodelcard.js - var require_ftmodelcard = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ftmodelcard.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FTModelCard$ = exports.FTModelCard$outboundSchema = exports.FTModelCard$inboundSchema = exports.FTModelCardType$ = exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema = exports.FTModelCardType = void 0; - exports.ftModelCardToJSON = ftModelCardToJSON; - exports.ftModelCardFromJSON = ftModelCardFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var modelcapabilities_js_1 = require_modelcapabilities(); - exports.FTModelCardType = { - FineTuned: "fine-tuned" - }; - exports.FTModelCardType$inboundSchema = z.nativeEnum(exports.FTModelCardType); - exports.FTModelCardType$outboundSchema = exports.FTModelCardType$inboundSchema; - var FTModelCardType$; - (function(FTModelCardType$2) { - FTModelCardType$2.inboundSchema = exports.FTModelCardType$inboundSchema; - FTModelCardType$2.outboundSchema = exports.FTModelCardType$outboundSchema; - })(FTModelCardType$ || (exports.FTModelCardType$ = FTModelCardType$ = {})); - exports.FTModelCard$inboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature" - }); - }); - exports.FTModelCard$outboundSchema = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: modelcapabilities_js_1.ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature" - }); - }); - var FTModelCard$; - (function(FTModelCard$2) { - FTModelCard$2.inboundSchema = exports.FTModelCard$inboundSchema; - FTModelCard$2.outboundSchema = exports.FTModelCard$outboundSchema; - })(FTModelCard$ || (exports.FTModelCard$ = FTModelCard$ = {})); - function ftModelCardToJSON(ftModelCard) { - return JSON.stringify(exports.FTModelCard$outboundSchema.parse(ftModelCard)); - } - function ftModelCardFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FTModelCard$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FTModelCard' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js - var require_githubrepositoryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/githubrepositoryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.GithubRepositoryIn$ = exports.GithubRepositoryIn$outboundSchema = exports.GithubRepositoryIn$inboundSchema = exports.GithubRepositoryInType$ = exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema = exports.GithubRepositoryInType = void 0; - exports.githubRepositoryInToJSON = githubRepositoryInToJSON; - exports.githubRepositoryInFromJSON = githubRepositoryInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.GithubRepositoryInType = { - Github: "github" - }; - exports.GithubRepositoryInType$inboundSchema = z.nativeEnum(exports.GithubRepositoryInType); - exports.GithubRepositoryInType$outboundSchema = exports.GithubRepositoryInType$inboundSchema; - var GithubRepositoryInType$; - (function(GithubRepositoryInType$2) { - GithubRepositoryInType$2.inboundSchema = exports.GithubRepositoryInType$inboundSchema; - GithubRepositoryInType$2.outboundSchema = exports.GithubRepositoryInType$outboundSchema; - })(GithubRepositoryInType$ || (exports.GithubRepositoryInType$ = GithubRepositoryInType$ = {})); - exports.GithubRepositoryIn$inboundSchema = z.object({ - type: exports.GithubRepositoryInType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - exports.GithubRepositoryIn$outboundSchema = z.object({ - type: exports.GithubRepositoryInType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string() - }); - var GithubRepositoryIn$; - (function(GithubRepositoryIn$2) { - GithubRepositoryIn$2.inboundSchema = exports.GithubRepositoryIn$inboundSchema; - GithubRepositoryIn$2.outboundSchema = exports.GithubRepositoryIn$outboundSchema; - })(GithubRepositoryIn$ || (exports.GithubRepositoryIn$ = GithubRepositoryIn$ = {})); - function githubRepositoryInToJSON(githubRepositoryIn) { - return JSON.stringify(exports.GithubRepositoryIn$outboundSchema.parse(githubRepositoryIn)); - } - function githubRepositoryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.GithubRepositoryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GithubRepositoryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/trainingfile.js - var require_trainingfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/trainingfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TrainingFile$ = exports.TrainingFile$outboundSchema = exports.TrainingFile$inboundSchema = void 0; - exports.trainingFileToJSON = trainingFileToJSON; - exports.trainingFileFromJSON = trainingFileFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TrainingFile$inboundSchema = z.object({ - file_id: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.TrainingFile$outboundSchema = z.object({ - fileId: z.string(), - weight: z.number().default(1) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var TrainingFile$; - (function(TrainingFile$2) { - TrainingFile$2.inboundSchema = exports.TrainingFile$inboundSchema; - TrainingFile$2.outboundSchema = exports.TrainingFile$outboundSchema; - })(TrainingFile$ || (exports.TrainingFile$ = TrainingFile$ = {})); - function trainingFileToJSON(trainingFile) { - return JSON.stringify(exports.TrainingFile$outboundSchema.parse(trainingFile)); - } - function trainingFileFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TrainingFile$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TrainingFile' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/wandbintegration.js - var require_wandbintegration = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/wandbintegration.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.WandbIntegration$ = exports.WandbIntegration$outboundSchema = exports.WandbIntegration$inboundSchema = exports.WandbIntegrationType$ = exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema = exports.WandbIntegrationType = void 0; - exports.wandbIntegrationToJSON = wandbIntegrationToJSON; - exports.wandbIntegrationFromJSON = wandbIntegrationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.WandbIntegrationType = { - Wandb: "wandb" - }; - exports.WandbIntegrationType$inboundSchema = z.nativeEnum(exports.WandbIntegrationType); - exports.WandbIntegrationType$outboundSchema = exports.WandbIntegrationType$inboundSchema; - var WandbIntegrationType$; - (function(WandbIntegrationType$2) { - WandbIntegrationType$2.inboundSchema = exports.WandbIntegrationType$inboundSchema; - WandbIntegrationType$2.outboundSchema = exports.WandbIntegrationType$outboundSchema; - })(WandbIntegrationType$ || (exports.WandbIntegrationType$ = WandbIntegrationType$ = {})); - exports.WandbIntegration$inboundSchema = z.object({ - type: exports.WandbIntegrationType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - api_key: z.string(), - run_name: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "api_key": "apiKey", - "run_name": "runName" - }); - }); - exports.WandbIntegration$outboundSchema = z.object({ - type: exports.WandbIntegrationType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - apiKey: z.string(), - runName: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "api_key", - runName: "run_name" - }); - }); - var WandbIntegration$; - (function(WandbIntegration$2) { - WandbIntegration$2.inboundSchema = exports.WandbIntegration$inboundSchema; - WandbIntegration$2.outboundSchema = exports.WandbIntegration$outboundSchema; - })(WandbIntegration$ || (exports.WandbIntegration$ = WandbIntegration$ = {})); - function wandbIntegrationToJSON(wandbIntegration) { - return JSON.stringify(exports.WandbIntegration$outboundSchema.parse(wandbIntegration)); - } - function wandbIntegrationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.WandbIntegration$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'WandbIntegration' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobin.js - var require_jobin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobIn$ = exports.JobIn$outboundSchema = exports.JobIn$inboundSchema = exports.JobInRepositories$ = exports.JobInRepositories$outboundSchema = exports.JobInRepositories$inboundSchema = exports.Hyperparameters$ = exports.Hyperparameters$outboundSchema = exports.Hyperparameters$inboundSchema = exports.JobInIntegrations$ = exports.JobInIntegrations$outboundSchema = exports.JobInIntegrations$inboundSchema = void 0; - exports.jobInIntegrationsToJSON = jobInIntegrationsToJSON; - exports.jobInIntegrationsFromJSON = jobInIntegrationsFromJSON; - exports.hyperparametersToJSON = hyperparametersToJSON; - exports.hyperparametersFromJSON = hyperparametersFromJSON; - exports.jobInRepositoriesToJSON = jobInRepositoriesToJSON; - exports.jobInRepositoriesFromJSON = jobInRepositoriesFromJSON; - exports.jobInToJSON = jobInToJSON; - exports.jobInFromJSON = jobInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var classifiertargetin_js_1 = require_classifiertargetin(); - var classifiertrainingparametersin_js_1 = require_classifiertrainingparametersin(); - var completiontrainingparametersin_js_1 = require_completiontrainingparametersin(); - var finetuneablemodeltype_js_1 = require_finetuneablemodeltype(); - var githubrepositoryin_js_1 = require_githubrepositoryin(); - var trainingfile_js_1 = require_trainingfile(); - var wandbintegration_js_1 = require_wandbintegration(); - exports.JobInIntegrations$inboundSchema = wandbintegration_js_1.WandbIntegration$inboundSchema; - exports.JobInIntegrations$outboundSchema = wandbintegration_js_1.WandbIntegration$outboundSchema; - var JobInIntegrations$; - (function(JobInIntegrations$2) { - JobInIntegrations$2.inboundSchema = exports.JobInIntegrations$inboundSchema; - JobInIntegrations$2.outboundSchema = exports.JobInIntegrations$outboundSchema; - })(JobInIntegrations$ || (exports.JobInIntegrations$ = JobInIntegrations$ = {})); - function jobInIntegrationsToJSON(jobInIntegrations) { - return JSON.stringify(exports.JobInIntegrations$outboundSchema.parse(jobInIntegrations)); - } - function jobInIntegrationsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInIntegrations$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInIntegrations' from JSON`); - } - exports.Hyperparameters$inboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]); - exports.Hyperparameters$outboundSchema = z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]); - var Hyperparameters$; - (function(Hyperparameters$2) { - Hyperparameters$2.inboundSchema = exports.Hyperparameters$inboundSchema; - Hyperparameters$2.outboundSchema = exports.Hyperparameters$outboundSchema; - })(Hyperparameters$ || (exports.Hyperparameters$ = Hyperparameters$ = {})); - function hyperparametersToJSON(hyperparameters) { - return JSON.stringify(exports.Hyperparameters$outboundSchema.parse(hyperparameters)); - } - function hyperparametersFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Hyperparameters$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Hyperparameters' from JSON`); - } - exports.JobInRepositories$inboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema; - exports.JobInRepositories$outboundSchema = githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema; - var JobInRepositories$; - (function(JobInRepositories$2) { - JobInRepositories$2.inboundSchema = exports.JobInRepositories$inboundSchema; - JobInRepositories$2.outboundSchema = exports.JobInRepositories$outboundSchema; - })(JobInRepositories$ || (exports.JobInRepositories$ = JobInRepositories$ = {})); - function jobInRepositoriesToJSON(jobInRepositories) { - return JSON.stringify(exports.JobInRepositories$outboundSchema.parse(jobInRepositories)); - } - function jobInRepositoriesFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobInRepositories$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobInRepositories' from JSON`); - } - exports.JobIn$inboundSchema = z.object({ - model: z.string(), - training_files: z.array(trainingfile_js_1.TrainingFile$inboundSchema).optional(), - validation_files: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$inboundSchema)).optional(), - auto_start: z.boolean().optional(), - invalid_sample_skip_percentage: z.number().default(0), - job_type: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$inboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$inboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$inboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$inboundSchema)).optional(), - classifier_targets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "auto_start": "autoStart", - "invalid_sample_skip_percentage": "invalidSampleSkipPercentage", - "job_type": "jobType", - "classifier_targets": "classifierTargets" - }); - }); - exports.JobIn$outboundSchema = z.object({ - model: z.string(), - trainingFiles: z.array(trainingfile_js_1.TrainingFile$outboundSchema).optional(), - validationFiles: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(wandbintegration_js_1.WandbIntegration$outboundSchema)).optional(), - autoStart: z.boolean().optional(), - invalidSampleSkipPercentage: z.number().default(0), - jobType: z.nullable(finetuneablemodeltype_js_1.FineTuneableModelType$outboundSchema).optional(), - hyperparameters: z.union([ - completiontrainingparametersin_js_1.CompletionTrainingParametersIn$outboundSchema, - classifiertrainingparametersin_js_1.ClassifierTrainingParametersIn$outboundSchema - ]), - repositories: z.nullable(z.array(githubrepositoryin_js_1.GithubRepositoryIn$outboundSchema)).optional(), - classifierTargets: z.nullable(z.array(classifiertargetin_js_1.ClassifierTargetIn$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - trainingFiles: "training_files", - validationFiles: "validation_files", - autoStart: "auto_start", - invalidSampleSkipPercentage: "invalid_sample_skip_percentage", - jobType: "job_type", - classifierTargets: "classifier_targets" - }); - }); - var JobIn$; - (function(JobIn$2) { - JobIn$2.inboundSchema = exports.JobIn$inboundSchema; - JobIn$2.outboundSchema = exports.JobIn$outboundSchema; - })(JobIn$ || (exports.JobIn$ = JobIn$ = {})); - function jobInToJSON(jobIn) { - return JSON.stringify(exports.JobIn$outboundSchema.parse(jobIn)); - } - function jobInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/jobsout.js - var require_jobsout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/jobsout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsOut$ = exports.JobsOut$outboundSchema = exports.JobsOut$inboundSchema = exports.JobsOutObject$ = exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema = exports.JobsOutData$ = exports.JobsOutData$outboundSchema = exports.JobsOutData$inboundSchema = exports.JobsOutObject = void 0; - exports.jobsOutDataToJSON = jobsOutDataToJSON; - exports.jobsOutDataFromJSON = jobsOutDataFromJSON; - exports.jobsOutToJSON = jobsOutToJSON; - exports.jobsOutFromJSON = jobsOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var classifierjobout_js_1 = require_classifierjobout(); - var completionjobout_js_1 = require_completionjobout(); - exports.JobsOutObject = { - List: "list" - }; - exports.JobsOutData$inboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsOutData$outboundSchema = z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsOutData$; - (function(JobsOutData$2) { - JobsOutData$2.inboundSchema = exports.JobsOutData$inboundSchema; - JobsOutData$2.outboundSchema = exports.JobsOutData$outboundSchema; - })(JobsOutData$ || (exports.JobsOutData$ = JobsOutData$ = {})); - function jobsOutDataToJSON(jobsOutData) { - return JSON.stringify(exports.JobsOutData$outboundSchema.parse(jobsOutData)); - } - function jobsOutDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOutData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOutData' from JSON`); - } - exports.JobsOutObject$inboundSchema = z.nativeEnum(exports.JobsOutObject); - exports.JobsOutObject$outboundSchema = exports.JobsOutObject$inboundSchema; - var JobsOutObject$; - (function(JobsOutObject$2) { - JobsOutObject$2.inboundSchema = exports.JobsOutObject$inboundSchema; - JobsOutObject$2.outboundSchema = exports.JobsOutObject$outboundSchema; - })(JobsOutObject$ || (exports.JobsOutObject$ = JobsOutObject$ = {})); - exports.JobsOut$inboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - completionjobout_js_1.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ])).optional(), - object: exports.JobsOutObject$inboundSchema.default("list"), - total: z.number().int() - }); - exports.JobsOut$outboundSchema = z.object({ - data: z.array(z.union([ - classifierjobout_js_1.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - completionjobout_js_1.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ])).optional(), - object: exports.JobsOutObject$outboundSchema.default("list"), - total: z.number().int() - }); - var JobsOut$; - (function(JobsOut$2) { - JobsOut$2.inboundSchema = exports.JobsOut$inboundSchema; - JobsOut$2.outboundSchema = exports.JobsOut$outboundSchema; - })(JobsOut$ || (exports.JobsOut$ = JobsOut$ = {})); - function jobsOutToJSON(jobsOut) { - return JSON.stringify(exports.JobsOut$outboundSchema.parse(jobsOut)); - } - function jobsOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js - var require_legacyjobmetadataout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/legacyjobmetadataout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LegacyJobMetadataOut$ = exports.LegacyJobMetadataOut$outboundSchema = exports.LegacyJobMetadataOut$inboundSchema = exports.LegacyJobMetadataOutObject$ = exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema = exports.LegacyJobMetadataOutObject = void 0; - exports.legacyJobMetadataOutToJSON = legacyJobMetadataOutToJSON; - exports.legacyJobMetadataOutFromJSON = legacyJobMetadataOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LegacyJobMetadataOutObject = { - JobMetadata: "job.metadata" - }; - exports.LegacyJobMetadataOutObject$inboundSchema = z.nativeEnum(exports.LegacyJobMetadataOutObject); - exports.LegacyJobMetadataOutObject$outboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - var LegacyJobMetadataOutObject$; - (function(LegacyJobMetadataOutObject$2) { - LegacyJobMetadataOutObject$2.inboundSchema = exports.LegacyJobMetadataOutObject$inboundSchema; - LegacyJobMetadataOutObject$2.outboundSchema = exports.LegacyJobMetadataOutObject$outboundSchema; - })(LegacyJobMetadataOutObject$ || (exports.LegacyJobMetadataOutObject$ = LegacyJobMetadataOutObject$ = {})); - exports.LegacyJobMetadataOut$inboundSchema = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - training_steps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$inboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime", - "training_steps": "trainingSteps" - }); - }); - exports.LegacyJobMetadataOut$outboundSchema = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - trainingSteps: z.nullable(z.number().int()).optional(), - object: exports.LegacyJobMetadataOutObject$outboundSchema.default("job.metadata") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time", - trainingSteps: "training_steps" - }); - }); - var LegacyJobMetadataOut$; - (function(LegacyJobMetadataOut$2) { - LegacyJobMetadataOut$2.inboundSchema = exports.LegacyJobMetadataOut$inboundSchema; - LegacyJobMetadataOut$2.outboundSchema = exports.LegacyJobMetadataOut$outboundSchema; - })(LegacyJobMetadataOut$ || (exports.LegacyJobMetadataOut$ = LegacyJobMetadataOut$ = {})); - function legacyJobMetadataOutToJSON(legacyJobMetadataOut) { - return JSON.stringify(exports.LegacyJobMetadataOut$outboundSchema.parse(legacyJobMetadataOut)); - } - function legacyJobMetadataOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LegacyJobMetadataOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LegacyJobMetadataOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryin.js - var require_libraryin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryIn$ = exports.LibraryIn$outboundSchema = exports.LibraryIn$inboundSchema = void 0; - exports.libraryInToJSON = libraryInToJSON; - exports.libraryInFromJSON = libraryInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryIn$inboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunk_size: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "chunk_size": "chunkSize" - }); - }); - exports.LibraryIn$outboundSchema = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunkSize: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - chunkSize: "chunk_size" - }); - }); - var LibraryIn$; - (function(LibraryIn$2) { - LibraryIn$2.inboundSchema = exports.LibraryIn$inboundSchema; - LibraryIn$2.outboundSchema = exports.LibraryIn$outboundSchema; - })(LibraryIn$ || (exports.LibraryIn$ = LibraryIn$ = {})); - function libraryInToJSON(libraryIn) { - return JSON.stringify(exports.LibraryIn$outboundSchema.parse(libraryIn)); - } - function libraryInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryinupdate.js - var require_libraryinupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryinupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryInUpdate$ = exports.LibraryInUpdate$outboundSchema = exports.LibraryInUpdate$inboundSchema = void 0; - exports.libraryInUpdateToJSON = libraryInUpdateToJSON; - exports.libraryInUpdateFromJSON = libraryInUpdateFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.LibraryInUpdate$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.LibraryInUpdate$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var LibraryInUpdate$; - (function(LibraryInUpdate$2) { - LibraryInUpdate$2.inboundSchema = exports.LibraryInUpdate$inboundSchema; - LibraryInUpdate$2.outboundSchema = exports.LibraryInUpdate$outboundSchema; - })(LibraryInUpdate$ || (exports.LibraryInUpdate$ = LibraryInUpdate$ = {})); - function libraryInUpdateToJSON(libraryInUpdate) { - return JSON.stringify(exports.LibraryInUpdate$outboundSchema.parse(libraryInUpdate)); - } - function libraryInUpdateFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryInUpdate$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryInUpdate' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/libraryout.js - var require_libraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/libraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibraryOut$ = exports.LibraryOut$outboundSchema = exports.LibraryOut$inboundSchema = void 0; - exports.libraryOutToJSON = libraryOutToJSON; - exports.libraryOutFromJSON = libraryOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibraryOut$inboundSchema = z.object({ - id: z.string(), - name: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - owner_id: z.string(), - owner_type: z.string(), - total_size: z.number().int(), - nb_documents: z.number().int(), - chunk_size: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generated_name: z.nullable(z.string()).optional(), - generated_description: z.nullable(z.string()).optional(), - explicit_user_members_count: z.nullable(z.number().int()).optional(), - explicit_workspace_members_count: z.nullable(z.number().int()).optional(), - org_sharing_role: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "owner_id": "ownerId", - "owner_type": "ownerType", - "total_size": "totalSize", - "nb_documents": "nbDocuments", - "chunk_size": "chunkSize", - "generated_name": "generatedName", - "generated_description": "generatedDescription", - "explicit_user_members_count": "explicitUserMembersCount", - "explicit_workspace_members_count": "explicitWorkspaceMembersCount", - "org_sharing_role": "orgSharingRole" - }); - }); - exports.LibraryOut$outboundSchema = z.object({ - id: z.string(), - name: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - ownerId: z.string(), - ownerType: z.string(), - totalSize: z.number().int(), - nbDocuments: z.number().int(), - chunkSize: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generatedName: z.nullable(z.string()).optional(), - generatedDescription: z.nullable(z.string()).optional(), - explicitUserMembersCount: z.nullable(z.number().int()).optional(), - explicitWorkspaceMembersCount: z.nullable(z.number().int()).optional(), - orgSharingRole: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - createdAt: "created_at", - updatedAt: "updated_at", - ownerId: "owner_id", - ownerType: "owner_type", - totalSize: "total_size", - nbDocuments: "nb_documents", - chunkSize: "chunk_size", - generatedName: "generated_name", - generatedDescription: "generated_description", - explicitUserMembersCount: "explicit_user_members_count", - explicitWorkspaceMembersCount: "explicit_workspace_members_count", - orgSharingRole: "org_sharing_role" - }); - }); - var LibraryOut$; - (function(LibraryOut$2) { - LibraryOut$2.inboundSchema = exports.LibraryOut$inboundSchema; - LibraryOut$2.outboundSchema = exports.LibraryOut$outboundSchema; - })(LibraryOut$ || (exports.LibraryOut$ = LibraryOut$ = {})); - function libraryOutToJSON(libraryOut) { - return JSON.stringify(exports.LibraryOut$outboundSchema.parse(libraryOut)); - } - function libraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/paginationinfo.js - var require_paginationinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/paginationinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.PaginationInfo$ = exports.PaginationInfo$outboundSchema = exports.PaginationInfo$inboundSchema = void 0; - exports.paginationInfoToJSON = paginationInfoToJSON; - exports.paginationInfoFromJSON = paginationInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.PaginationInfo$inboundSchema = z.object({ - total_items: z.number().int(), - total_pages: z.number().int(), - current_page: z.number().int(), - page_size: z.number().int(), - has_more: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "total_items": "totalItems", - "total_pages": "totalPages", - "current_page": "currentPage", - "page_size": "pageSize", - "has_more": "hasMore" - }); - }); - exports.PaginationInfo$outboundSchema = z.object({ - totalItems: z.number().int(), - totalPages: z.number().int(), - currentPage: z.number().int(), - pageSize: z.number().int(), - hasMore: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - totalItems: "total_items", - totalPages: "total_pages", - currentPage: "current_page", - pageSize: "page_size", - hasMore: "has_more" - }); - }); - var PaginationInfo$; - (function(PaginationInfo$2) { - PaginationInfo$2.inboundSchema = exports.PaginationInfo$inboundSchema; - PaginationInfo$2.outboundSchema = exports.PaginationInfo$outboundSchema; - })(PaginationInfo$ || (exports.PaginationInfo$ = PaginationInfo$ = {})); - function paginationInfoToJSON(paginationInfo) { - return JSON.stringify(exports.PaginationInfo$outboundSchema.parse(paginationInfo)); - } - function paginationInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PaginationInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PaginationInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listdocumentout.js - var require_listdocumentout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listdocumentout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListDocumentOut$ = exports.ListDocumentOut$outboundSchema = exports.ListDocumentOut$inboundSchema = void 0; - exports.listDocumentOutToJSON = listDocumentOutToJSON; - exports.listDocumentOutFromJSON = listDocumentOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var documentout_js_1 = require_documentout(); - var paginationinfo_js_1 = require_paginationinfo(); - exports.ListDocumentOut$inboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$inboundSchema, - data: z.array(documentout_js_1.DocumentOut$inboundSchema) - }); - exports.ListDocumentOut$outboundSchema = z.object({ - pagination: paginationinfo_js_1.PaginationInfo$outboundSchema, - data: z.array(documentout_js_1.DocumentOut$outboundSchema) - }); - var ListDocumentOut$; - (function(ListDocumentOut$2) { - ListDocumentOut$2.inboundSchema = exports.ListDocumentOut$inboundSchema; - ListDocumentOut$2.outboundSchema = exports.ListDocumentOut$outboundSchema; - })(ListDocumentOut$ || (exports.ListDocumentOut$ = ListDocumentOut$ = {})); - function listDocumentOutToJSON(listDocumentOut) { - return JSON.stringify(exports.ListDocumentOut$outboundSchema.parse(listDocumentOut)); - } - function listDocumentOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListDocumentOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListDocumentOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listfilesout.js - var require_listfilesout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listfilesout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListFilesOut$ = exports.ListFilesOut$outboundSchema = exports.ListFilesOut$inboundSchema = void 0; - exports.listFilesOutToJSON = listFilesOutToJSON; - exports.listFilesOutFromJSON = listFilesOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var fileschema_js_1 = require_fileschema(); - exports.ListFilesOut$inboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$inboundSchema), - object: z.string(), - total: z.number().int() - }); - exports.ListFilesOut$outboundSchema = z.object({ - data: z.array(fileschema_js_1.FileSchema$outboundSchema), - object: z.string(), - total: z.number().int() - }); - var ListFilesOut$; - (function(ListFilesOut$2) { - ListFilesOut$2.inboundSchema = exports.ListFilesOut$inboundSchema; - ListFilesOut$2.outboundSchema = exports.ListFilesOut$outboundSchema; - })(ListFilesOut$ || (exports.ListFilesOut$ = ListFilesOut$ = {})); - function listFilesOutToJSON(listFilesOut) { - return JSON.stringify(exports.ListFilesOut$outboundSchema.parse(listFilesOut)); - } - function listFilesOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListFilesOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListFilesOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listlibraryout.js - var require_listlibraryout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listlibraryout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListLibraryOut$ = exports.ListLibraryOut$outboundSchema = exports.ListLibraryOut$inboundSchema = void 0; - exports.listLibraryOutToJSON = listLibraryOutToJSON; - exports.listLibraryOutFromJSON = listLibraryOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var libraryout_js_1 = require_libraryout(); - exports.ListLibraryOut$inboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$inboundSchema) - }); - exports.ListLibraryOut$outboundSchema = z.object({ - data: z.array(libraryout_js_1.LibraryOut$outboundSchema) - }); - var ListLibraryOut$; - (function(ListLibraryOut$2) { - ListLibraryOut$2.inboundSchema = exports.ListLibraryOut$inboundSchema; - ListLibraryOut$2.outboundSchema = exports.ListLibraryOut$outboundSchema; - })(ListLibraryOut$ || (exports.ListLibraryOut$ = ListLibraryOut$ = {})); - function listLibraryOutToJSON(listLibraryOut) { - return JSON.stringify(exports.ListLibraryOut$outboundSchema.parse(listLibraryOut)); - } - function listLibraryOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListLibraryOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListLibraryOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingout.js - var require_sharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingOut$ = exports.SharingOut$outboundSchema = exports.SharingOut$inboundSchema = void 0; - exports.sharingOutToJSON = sharingOutToJSON; - exports.sharingOutFromJSON = sharingOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.SharingOut$inboundSchema = z.object({ - library_id: z.string(), - user_id: z.nullable(z.string()).optional(), - org_id: z.string(), - role: z.string(), - share_with_type: z.string(), - share_with_uuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "user_id": "userId", - "org_id": "orgId", - "share_with_type": "shareWithType", - "share_with_uuid": "shareWithUuid" - }); - }); - exports.SharingOut$outboundSchema = z.object({ - libraryId: z.string(), - userId: z.nullable(z.string()).optional(), - orgId: z.string(), - role: z.string(), - shareWithType: z.string(), - shareWithUuid: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - userId: "user_id", - orgId: "org_id", - shareWithType: "share_with_type", - shareWithUuid: "share_with_uuid" - }); - }); - var SharingOut$; - (function(SharingOut$2) { - SharingOut$2.inboundSchema = exports.SharingOut$inboundSchema; - SharingOut$2.outboundSchema = exports.SharingOut$outboundSchema; - })(SharingOut$ || (exports.SharingOut$ = SharingOut$ = {})); - function sharingOutToJSON(sharingOut) { - return JSON.stringify(exports.SharingOut$outboundSchema.parse(sharingOut)); - } - function sharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/listsharingout.js - var require_listsharingout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/listsharingout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ListSharingOut$ = exports.ListSharingOut$outboundSchema = exports.ListSharingOut$inboundSchema = void 0; - exports.listSharingOutToJSON = listSharingOutToJSON; - exports.listSharingOutFromJSON = listSharingOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var sharingout_js_1 = require_sharingout(); - exports.ListSharingOut$inboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$inboundSchema) - }); - exports.ListSharingOut$outboundSchema = z.object({ - data: z.array(sharingout_js_1.SharingOut$outboundSchema) - }); - var ListSharingOut$; - (function(ListSharingOut$2) { - ListSharingOut$2.inboundSchema = exports.ListSharingOut$inboundSchema; - ListSharingOut$2.outboundSchema = exports.ListSharingOut$outboundSchema; - })(ListSharingOut$ || (exports.ListSharingOut$ = ListSharingOut$ = {})); - function listSharingOutToJSON(listSharingOut) { - return JSON.stringify(exports.ListSharingOut$outboundSchema.parse(listSharingOut)); - } - function listSharingOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ListSharingOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ListSharingOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modelconversation.js - var require_modelconversation = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modelconversation.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelConversation$ = exports.ModelConversation$outboundSchema = exports.ModelConversation$inboundSchema = exports.ModelConversationObject$ = exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema = exports.ModelConversationTools$ = exports.ModelConversationTools$outboundSchema = exports.ModelConversationTools$inboundSchema = exports.ModelConversationObject = void 0; - exports.modelConversationToolsToJSON = modelConversationToolsToJSON; - exports.modelConversationToolsFromJSON = modelConversationToolsFromJSON; - exports.modelConversationToJSON = modelConversationToJSON; - exports.modelConversationFromJSON = modelConversationFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var codeinterpretertool_js_1 = require_codeinterpretertool(); - var completionargs_js_1 = require_completionargs(); - var documentlibrarytool_js_1 = require_documentlibrarytool(); - var functiontool_js_1 = require_functiontool(); - var imagegenerationtool_js_1 = require_imagegenerationtool(); - var websearchpremiumtool_js_1 = require_websearchpremiumtool(); - var websearchtool_js_1 = require_websearchtool(); - exports.ModelConversationObject = { - Conversation: "conversation" - }; - exports.ModelConversationTools$inboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.ModelConversationTools$outboundSchema = z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ]); - var ModelConversationTools$; - (function(ModelConversationTools$2) { - ModelConversationTools$2.inboundSchema = exports.ModelConversationTools$inboundSchema; - ModelConversationTools$2.outboundSchema = exports.ModelConversationTools$outboundSchema; - })(ModelConversationTools$ || (exports.ModelConversationTools$ = ModelConversationTools$ = {})); - function modelConversationToolsToJSON(modelConversationTools) { - return JSON.stringify(exports.ModelConversationTools$outboundSchema.parse(modelConversationTools)); - } - function modelConversationToolsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversationTools$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversationTools' from JSON`); - } - exports.ModelConversationObject$inboundSchema = z.nativeEnum(exports.ModelConversationObject); - exports.ModelConversationObject$outboundSchema = exports.ModelConversationObject$inboundSchema; - var ModelConversationObject$; - (function(ModelConversationObject$2) { - ModelConversationObject$2.inboundSchema = exports.ModelConversationObject$inboundSchema; - ModelConversationObject$2.outboundSchema = exports.ModelConversationObject$outboundSchema; - })(ModelConversationObject$ || (exports.ModelConversationObject$ = ModelConversationObject$ = {})); - exports.ModelConversation$inboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$inboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$inboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$inboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$inboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$inboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$inboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completion_args: completionargs_js_1.CompletionArgs$inboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform((v) => new Date(v)), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt" - }); - }); - exports.ModelConversation$outboundSchema = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array(z.union([ - documentlibrarytool_js_1.DocumentLibraryTool$outboundSchema.and(z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type - }))), - functiontool_js_1.FunctionTool$outboundSchema.and(z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type - }))), - codeinterpretertool_js_1.CodeInterpreterTool$outboundSchema.and(z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type - }))), - imagegenerationtool_js_1.ImageGenerationTool$outboundSchema.and(z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type - }))), - websearchtool_js_1.WebSearchTool$outboundSchema.and(z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type - }))), - websearchpremiumtool_js_1.WebSearchPremiumTool$outboundSchema.and(z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type - }))) - ])).optional(), - completionArgs: completionargs_js_1.CompletionArgs$outboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: exports.ModelConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform((v) => v.toISOString()), - updatedAt: z.date().transform((v) => v.toISOString()), - model: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at" - }); - }); - var ModelConversation$; - (function(ModelConversation$2) { - ModelConversation$2.inboundSchema = exports.ModelConversation$inboundSchema; - ModelConversation$2.outboundSchema = exports.ModelConversation$outboundSchema; - })(ModelConversation$ || (exports.ModelConversation$ = ModelConversation$ = {})); - function modelConversationToJSON(modelConversation) { - return JSON.stringify(exports.ModelConversation$outboundSchema.parse(modelConversation)); - } - function modelConversationFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelConversation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelConversation' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/modellist.js - var require_modellist = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/modellist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModelList$ = exports.ModelList$outboundSchema = exports.ModelList$inboundSchema = exports.Data$ = exports.Data$outboundSchema = exports.Data$inboundSchema = void 0; - exports.dataToJSON = dataToJSON; - exports.dataFromJSON = dataFromJSON; - exports.modelListToJSON = modelListToJSON; - exports.modelListFromJSON = modelListFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var basemodelcard_js_1 = require_basemodelcard(); - var ftmodelcard_js_1 = require_ftmodelcard(); - exports.Data$inboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.Data$outboundSchema = z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var Data$; - (function(Data$2) { - Data$2.inboundSchema = exports.Data$inboundSchema; - Data$2.outboundSchema = exports.Data$outboundSchema; - })(Data$ || (exports.Data$ = Data$ = {})); - function dataToJSON(data) { - return JSON.stringify(exports.Data$outboundSchema.parse(data)); - } - function dataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Data$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Data' from JSON`); - } - exports.ModelList$inboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - exports.ModelList$outboundSchema = z.object({ - object: z.string().default("list"), - data: z.array(z.union([ - ftmodelcard_js_1.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - basemodelcard_js_1.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ])).optional() - }); - var ModelList$; - (function(ModelList$2) { - ModelList$2.inboundSchema = exports.ModelList$inboundSchema; - ModelList$2.outboundSchema = exports.ModelList$outboundSchema; - })(ModelList$ || (exports.ModelList$ = ModelList$ = {})); - function modelListToJSON(modelList) { - return JSON.stringify(exports.ModelList$outboundSchema.parse(modelList)); - } - function modelListFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModelList$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModelList' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationobject.js - var require_moderationobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationObject$ = exports.ModerationObject$outboundSchema = exports.ModerationObject$inboundSchema = void 0; - exports.moderationObjectToJSON = moderationObjectToJSON; - exports.moderationObjectFromJSON = moderationObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ModerationObject$inboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - category_scores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "category_scores": "categoryScores" - }); - }); - exports.ModerationObject$outboundSchema = z.object({ - categories: z.record(z.boolean()).optional(), - categoryScores: z.record(z.number()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - categoryScores: "category_scores" - }); - }); - var ModerationObject$; - (function(ModerationObject$2) { - ModerationObject$2.inboundSchema = exports.ModerationObject$inboundSchema; - ModerationObject$2.outboundSchema = exports.ModerationObject$outboundSchema; - })(ModerationObject$ || (exports.ModerationObject$ = ModerationObject$ = {})); - function moderationObjectToJSON(moderationObject) { - return JSON.stringify(exports.ModerationObject$outboundSchema.parse(moderationObject)); - } - function moderationObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/moderationresponse.js - var require_moderationresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/moderationresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ModerationResponse$ = exports.ModerationResponse$outboundSchema = exports.ModerationResponse$inboundSchema = void 0; - exports.moderationResponseToJSON = moderationResponseToJSON; - exports.moderationResponseFromJSON = moderationResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var moderationobject_js_1 = require_moderationobject(); - exports.ModerationResponse$inboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$inboundSchema) - }); - exports.ModerationResponse$outboundSchema = z.object({ - id: z.string(), - model: z.string(), - results: z.array(moderationobject_js_1.ModerationObject$outboundSchema) - }); - var ModerationResponse$; - (function(ModerationResponse$2) { - ModerationResponse$2.inboundSchema = exports.ModerationResponse$inboundSchema; - ModerationResponse$2.outboundSchema = exports.ModerationResponse$outboundSchema; - })(ModerationResponse$ || (exports.ModerationResponse$ = ModerationResponse$ = {})); - function moderationResponseToJSON(moderationResponse) { - return JSON.stringify(exports.ModerationResponse$outboundSchema.parse(moderationResponse)); - } - function moderationResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ModerationResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ModerationResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrimageobject.js - var require_ocrimageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrimageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRImageObject$ = exports.OCRImageObject$outboundSchema = exports.OCRImageObject$inboundSchema = void 0; - exports.ocrImageObjectToJSON = ocrImageObjectToJSON; - exports.ocrImageObjectFromJSON = ocrImageObjectFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRImageObject$inboundSchema = z.object({ - id: z.string(), - top_left_x: z.nullable(z.number().int()), - top_left_y: z.nullable(z.number().int()), - bottom_right_x: z.nullable(z.number().int()), - bottom_right_y: z.nullable(z.number().int()), - image_base64: z.nullable(z.string()).optional(), - image_annotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "top_left_x": "topLeftX", - "top_left_y": "topLeftY", - "bottom_right_x": "bottomRightX", - "bottom_right_y": "bottomRightY", - "image_base64": "imageBase64", - "image_annotation": "imageAnnotation" - }); - }); - exports.OCRImageObject$outboundSchema = z.object({ - id: z.string(), - topLeftX: z.nullable(z.number().int()), - topLeftY: z.nullable(z.number().int()), - bottomRightX: z.nullable(z.number().int()), - bottomRightY: z.nullable(z.number().int()), - imageBase64: z.nullable(z.string()).optional(), - imageAnnotation: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - topLeftX: "top_left_x", - topLeftY: "top_left_y", - bottomRightX: "bottom_right_x", - bottomRightY: "bottom_right_y", - imageBase64: "image_base64", - imageAnnotation: "image_annotation" - }); - }); - var OCRImageObject$; - (function(OCRImageObject$2) { - OCRImageObject$2.inboundSchema = exports.OCRImageObject$inboundSchema; - OCRImageObject$2.outboundSchema = exports.OCRImageObject$outboundSchema; - })(OCRImageObject$ || (exports.OCRImageObject$ = OCRImageObject$ = {})); - function ocrImageObjectToJSON(ocrImageObject) { - return JSON.stringify(exports.OCRImageObject$outboundSchema.parse(ocrImageObject)); - } - function ocrImageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRImageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRImageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js - var require_ocrpagedimensions = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpagedimensions.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageDimensions$ = exports.OCRPageDimensions$outboundSchema = exports.OCRPageDimensions$inboundSchema = void 0; - exports.ocrPageDimensionsToJSON = ocrPageDimensionsToJSON; - exports.ocrPageDimensionsFromJSON = ocrPageDimensionsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.OCRPageDimensions$inboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - exports.OCRPageDimensions$outboundSchema = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int() - }); - var OCRPageDimensions$; - (function(OCRPageDimensions$2) { - OCRPageDimensions$2.inboundSchema = exports.OCRPageDimensions$inboundSchema; - OCRPageDimensions$2.outboundSchema = exports.OCRPageDimensions$outboundSchema; - })(OCRPageDimensions$ || (exports.OCRPageDimensions$ = OCRPageDimensions$ = {})); - function ocrPageDimensionsToJSON(ocrPageDimensions) { - return JSON.stringify(exports.OCRPageDimensions$outboundSchema.parse(ocrPageDimensions)); - } - function ocrPageDimensionsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageDimensions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageDimensions' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrpageobject.js - var require_ocrpageobject = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrpageobject.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRPageObject$ = exports.OCRPageObject$outboundSchema = exports.OCRPageObject$inboundSchema = void 0; - exports.ocrPageObjectToJSON = ocrPageObjectToJSON; - exports.ocrPageObjectFromJSON = ocrPageObjectFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var ocrimageobject_js_1 = require_ocrimageobject(); - var ocrpagedimensions_js_1 = require_ocrpagedimensions(); - exports.OCRPageObject$inboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$inboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$inboundSchema) - }); - exports.OCRPageObject$outboundSchema = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(ocrimageobject_js_1.OCRImageObject$outboundSchema), - dimensions: z.nullable(ocrpagedimensions_js_1.OCRPageDimensions$outboundSchema) - }); - var OCRPageObject$; - (function(OCRPageObject$2) { - OCRPageObject$2.inboundSchema = exports.OCRPageObject$inboundSchema; - OCRPageObject$2.outboundSchema = exports.OCRPageObject$outboundSchema; - })(OCRPageObject$ || (exports.OCRPageObject$ = OCRPageObject$ = {})); - function ocrPageObjectToJSON(ocrPageObject) { - return JSON.stringify(exports.OCRPageObject$outboundSchema.parse(ocrPageObject)); - } - function ocrPageObjectFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRPageObject$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRPageObject' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrrequest.js - var require_ocrrequest = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrrequest.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRRequest$ = exports.OCRRequest$outboundSchema = exports.OCRRequest$inboundSchema = exports.Document$ = exports.Document$outboundSchema = exports.Document$inboundSchema = void 0; - exports.documentToJSON = documentToJSON; - exports.documentFromJSON = documentFromJSON; - exports.ocrRequestToJSON = ocrRequestToJSON; - exports.ocrRequestFromJSON = ocrRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var documenturlchunk_js_1 = require_documenturlchunk(); - var filechunk_js_1 = require_filechunk(); - var imageurlchunk_js_1 = require_imageurlchunk(); - var responseformat_js_1 = require_responseformat(); - exports.Document$inboundSchema = z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]); - exports.Document$outboundSchema = z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]); - var Document$; - (function(Document$2) { - Document$2.inboundSchema = exports.Document$inboundSchema; - Document$2.outboundSchema = exports.Document$outboundSchema; - })(Document$ || (exports.Document$ = Document$ = {})); - function documentToJSON(document) { - return JSON.stringify(exports.Document$outboundSchema.parse(document)); - } - function documentFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Document$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Document' from JSON`); - } - exports.OCRRequest$inboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$inboundSchema, - documenturlchunk_js_1.DocumentURLChunk$inboundSchema, - imageurlchunk_js_1.ImageURLChunk$inboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - include_image_base64: z.nullable(z.boolean()).optional(), - image_limit: z.nullable(z.number().int()).optional(), - image_min_size: z.nullable(z.number().int()).optional(), - bbox_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional(), - document_annotation_format: z.nullable(responseformat_js_1.ResponseFormat$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "include_image_base64": "includeImageBase64", - "image_limit": "imageLimit", - "image_min_size": "imageMinSize", - "bbox_annotation_format": "bboxAnnotationFormat", - "document_annotation_format": "documentAnnotationFormat" - }); - }); - exports.OCRRequest$outboundSchema = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - filechunk_js_1.FileChunk$outboundSchema, - documenturlchunk_js_1.DocumentURLChunk$outboundSchema, - imageurlchunk_js_1.ImageURLChunk$outboundSchema - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - includeImageBase64: z.nullable(z.boolean()).optional(), - imageLimit: z.nullable(z.number().int()).optional(), - imageMinSize: z.nullable(z.number().int()).optional(), - bboxAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional(), - documentAnnotationFormat: z.nullable(responseformat_js_1.ResponseFormat$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - includeImageBase64: "include_image_base64", - imageLimit: "image_limit", - imageMinSize: "image_min_size", - bboxAnnotationFormat: "bbox_annotation_format", - documentAnnotationFormat: "document_annotation_format" - }); - }); - var OCRRequest$; - (function(OCRRequest$2) { - OCRRequest$2.inboundSchema = exports.OCRRequest$inboundSchema; - OCRRequest$2.outboundSchema = exports.OCRRequest$outboundSchema; - })(OCRRequest$ || (exports.OCRRequest$ = OCRRequest$ = {})); - function ocrRequestToJSON(ocrRequest) { - return JSON.stringify(exports.OCRRequest$outboundSchema.parse(ocrRequest)); - } - function ocrRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js - var require_ocrusageinfo = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrusageinfo.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRUsageInfo$ = exports.OCRUsageInfo$outboundSchema = exports.OCRUsageInfo$inboundSchema = void 0; - exports.ocrUsageInfoToJSON = ocrUsageInfoToJSON; - exports.ocrUsageInfoFromJSON = ocrUsageInfoFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.OCRUsageInfo$inboundSchema = z.object({ - pages_processed: z.number().int(), - doc_size_bytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "pages_processed": "pagesProcessed", - "doc_size_bytes": "docSizeBytes" - }); - }); - exports.OCRUsageInfo$outboundSchema = z.object({ - pagesProcessed: z.number().int(), - docSizeBytes: z.nullable(z.number().int()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pagesProcessed: "pages_processed", - docSizeBytes: "doc_size_bytes" - }); - }); - var OCRUsageInfo$; - (function(OCRUsageInfo$2) { - OCRUsageInfo$2.inboundSchema = exports.OCRUsageInfo$inboundSchema; - OCRUsageInfo$2.outboundSchema = exports.OCRUsageInfo$outboundSchema; - })(OCRUsageInfo$ || (exports.OCRUsageInfo$ = OCRUsageInfo$ = {})); - function ocrUsageInfoToJSON(ocrUsageInfo) { - return JSON.stringify(exports.OCRUsageInfo$outboundSchema.parse(ocrUsageInfo)); - } - function ocrUsageInfoFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRUsageInfo$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRUsageInfo' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/ocrresponse.js - var require_ocrresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/ocrresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.OCRResponse$ = exports.OCRResponse$outboundSchema = exports.OCRResponse$inboundSchema = void 0; - exports.ocrResponseToJSON = ocrResponseToJSON; - exports.ocrResponseFromJSON = ocrResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var ocrpageobject_js_1 = require_ocrpageobject(); - var ocrusageinfo_js_1 = require_ocrusageinfo(); - exports.OCRResponse$inboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$inboundSchema), - model: z.string(), - document_annotation: z.nullable(z.string()).optional(), - usage_info: ocrusageinfo_js_1.OCRUsageInfo$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_annotation": "documentAnnotation", - "usage_info": "usageInfo" - }); - }); - exports.OCRResponse$outboundSchema = z.object({ - pages: z.array(ocrpageobject_js_1.OCRPageObject$outboundSchema), - model: z.string(), - documentAnnotation: z.nullable(z.string()).optional(), - usageInfo: ocrusageinfo_js_1.OCRUsageInfo$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentAnnotation: "document_annotation", - usageInfo: "usage_info" - }); - }); - var OCRResponse$; - (function(OCRResponse$2) { - OCRResponse$2.inboundSchema = exports.OCRResponse$inboundSchema; - OCRResponse$2.outboundSchema = exports.OCRResponse$outboundSchema; - })(OCRResponse$ || (exports.OCRResponse$ = OCRResponse$ = {})); - function ocrResponseToJSON(ocrResponse) { - return JSON.stringify(exports.OCRResponse$outboundSchema.parse(ocrResponse)); - } - function ocrResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.OCRResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'OCRResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/processingstatusout.js - var require_processingstatusout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/processingstatusout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ProcessingStatusOut$ = exports.ProcessingStatusOut$outboundSchema = exports.ProcessingStatusOut$inboundSchema = void 0; - exports.processingStatusOutToJSON = processingStatusOutToJSON; - exports.processingStatusOutFromJSON = processingStatusOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.ProcessingStatusOut$inboundSchema = z.object({ - document_id: z.string(), - processing_status: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "document_id": "documentId", - "processing_status": "processingStatus" - }); - }); - exports.ProcessingStatusOut$outboundSchema = z.object({ - documentId: z.string(), - processingStatus: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - documentId: "document_id", - processingStatus: "processing_status" - }); - }); - var ProcessingStatusOut$; - (function(ProcessingStatusOut$2) { - ProcessingStatusOut$2.inboundSchema = exports.ProcessingStatusOut$inboundSchema; - ProcessingStatusOut$2.outboundSchema = exports.ProcessingStatusOut$outboundSchema; - })(ProcessingStatusOut$ || (exports.ProcessingStatusOut$ = ProcessingStatusOut$ = {})); - function processingStatusOutToJSON(processingStatusOut) { - return JSON.stringify(exports.ProcessingStatusOut$outboundSchema.parse(processingStatusOut)); - } - function processingStatusOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ProcessingStatusOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ProcessingStatusOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/retrievefileout.js - var require_retrievefileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/retrievefileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveFileOut$ = exports.RetrieveFileOut$outboundSchema = exports.RetrieveFileOut$inboundSchema = void 0; - exports.retrieveFileOutToJSON = retrieveFileOutToJSON; - exports.retrieveFileOutFromJSON = retrieveFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.RetrieveFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.RetrieveFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var RetrieveFileOut$; - (function(RetrieveFileOut$2) { - RetrieveFileOut$2.inboundSchema = exports.RetrieveFileOut$inboundSchema; - RetrieveFileOut$2.outboundSchema = exports.RetrieveFileOut$outboundSchema; - })(RetrieveFileOut$ || (exports.RetrieveFileOut$ = RetrieveFileOut$ = {})); - function retrieveFileOutToJSON(retrieveFileOut) { - return JSON.stringify(exports.RetrieveFileOut$outboundSchema.parse(retrieveFileOut)); - } - function retrieveFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/security.js - var require_security2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/security.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Security$ = exports.Security$outboundSchema = exports.Security$inboundSchema = void 0; - exports.securityToJSON = securityToJSON; - exports.securityFromJSON = securityFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Security$inboundSchema = z.object({ - ApiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "ApiKey": "apiKey" - }); - }); - exports.Security$outboundSchema = z.object({ - apiKey: z.string().optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - apiKey: "ApiKey" - }); - }); - var Security$; - (function(Security$2) { - Security$2.inboundSchema = exports.Security$inboundSchema; - Security$2.outboundSchema = exports.Security$outboundSchema; - })(Security$ || (exports.Security$ = Security$ = {})); - function securityToJSON(security) { - return JSON.stringify(exports.Security$outboundSchema.parse(security)); - } - function securityFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Security$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Security' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/shareenum.js - var require_shareenum = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/shareenum.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ShareEnum$ = exports.ShareEnum$outboundSchema = exports.ShareEnum$inboundSchema = exports.ShareEnum = void 0; - var z = __importStar(require_zod()); - var enums_js_1 = require_enums(); - exports.ShareEnum = { - Viewer: "Viewer", - Editor: "Editor" - }; - exports.ShareEnum$inboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().transform(enums_js_1.catchUnrecognizedEnum) - ]); - exports.ShareEnum$outboundSchema = z.union([ - z.nativeEnum(exports.ShareEnum), - z.string().and(z.custom()) - ]); - var ShareEnum$; - (function(ShareEnum$2) { - ShareEnum$2.inboundSchema = exports.ShareEnum$inboundSchema; - ShareEnum$2.outboundSchema = exports.ShareEnum$outboundSchema; - })(ShareEnum$ || (exports.ShareEnum$ = ShareEnum$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingdelete.js - var require_sharingdelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingdelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingDelete$ = exports.SharingDelete$outboundSchema = exports.SharingDelete$inboundSchema = void 0; - exports.sharingDeleteToJSON = sharingDeleteToJSON; - exports.sharingDeleteFromJSON = sharingDeleteFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - exports.SharingDelete$inboundSchema = z.object({ - org_id: z.string(), - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingDelete$outboundSchema = z.object({ - orgId: z.string(), - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingDelete$; - (function(SharingDelete$2) { - SharingDelete$2.inboundSchema = exports.SharingDelete$inboundSchema; - SharingDelete$2.outboundSchema = exports.SharingDelete$outboundSchema; - })(SharingDelete$ || (exports.SharingDelete$ = SharingDelete$ = {})); - function sharingDeleteToJSON(sharingDelete) { - return JSON.stringify(exports.SharingDelete$outboundSchema.parse(sharingDelete)); - } - function sharingDeleteFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingDelete$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingDelete' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/sharingin.js - var require_sharingin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/sharingin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.SharingIn$ = exports.SharingIn$outboundSchema = exports.SharingIn$inboundSchema = void 0; - exports.sharingInToJSON = sharingInToJSON; - exports.sharingInFromJSON = sharingInFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var entitytype_js_1 = require_entitytype(); - var shareenum_js_1 = require_shareenum(); - exports.SharingIn$inboundSchema = z.object({ - org_id: z.string(), - level: shareenum_js_1.ShareEnum$inboundSchema, - share_with_uuid: z.string(), - share_with_type: entitytype_js_1.EntityType$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType" - }); - }); - exports.SharingIn$outboundSchema = z.object({ - orgId: z.string(), - level: shareenum_js_1.ShareEnum$outboundSchema, - shareWithUuid: z.string(), - shareWithType: entitytype_js_1.EntityType$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type" - }); - }); - var SharingIn$; - (function(SharingIn$2) { - SharingIn$2.inboundSchema = exports.SharingIn$inboundSchema; - SharingIn$2.outboundSchema = exports.SharingIn$outboundSchema; - })(SharingIn$ || (exports.SharingIn$ = SharingIn$ = {})); - function sharingInToJSON(sharingIn) { - return JSON.stringify(exports.SharingIn$outboundSchema.parse(sharingIn)); - } - function sharingInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SharingIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SharingIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js - var require_transcriptionsegmentchunk = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionsegmentchunk.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionSegmentChunk$ = exports.TranscriptionSegmentChunk$outboundSchema = exports.TranscriptionSegmentChunk$inboundSchema = exports.Type$ = exports.Type$outboundSchema = exports.Type$inboundSchema = exports.Type = void 0; - exports.transcriptionSegmentChunkToJSON = transcriptionSegmentChunkToJSON; - exports.transcriptionSegmentChunkFromJSON = transcriptionSegmentChunkFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Type = { - TranscriptionSegment: "transcription_segment" - }; - exports.Type$inboundSchema = z.nativeEnum(exports.Type); - exports.Type$outboundSchema = exports.Type$inboundSchema; - var Type$; - (function(Type$2) { - Type$2.inboundSchema = exports.Type$inboundSchema; - Type$2.outboundSchema = exports.Type$outboundSchema; - })(Type$ || (exports.Type$ = Type$ = {})); - exports.TranscriptionSegmentChunk$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$inboundSchema.default("transcription_segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionSegmentChunk$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.Type$outboundSchema.default("transcription_segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionSegmentChunk$; - (function(TranscriptionSegmentChunk$2) { - TranscriptionSegmentChunk$2.inboundSchema = exports.TranscriptionSegmentChunk$inboundSchema; - TranscriptionSegmentChunk$2.outboundSchema = exports.TranscriptionSegmentChunk$outboundSchema; - })(TranscriptionSegmentChunk$ || (exports.TranscriptionSegmentChunk$ = TranscriptionSegmentChunk$ = {})); - function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk) { - return JSON.stringify(exports.TranscriptionSegmentChunk$outboundSchema.parse(transcriptionSegmentChunk)); - } - function transcriptionSegmentChunkFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionSegmentChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionSegmentChunk' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js - var require_transcriptionresponse = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionresponse.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionResponse$ = exports.TranscriptionResponse$outboundSchema = exports.TranscriptionResponse$inboundSchema = void 0; - exports.transcriptionResponseToJSON = transcriptionResponseToJSON; - exports.transcriptionResponseFromJSON = transcriptionResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionResponse$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionResponse$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionResponse$; - (function(TranscriptionResponse$2) { - TranscriptionResponse$2.inboundSchema = exports.TranscriptionResponse$inboundSchema; - TranscriptionResponse$2.outboundSchema = exports.TranscriptionResponse$outboundSchema; - })(TranscriptionResponse$ || (exports.TranscriptionResponse$ = TranscriptionResponse$ = {})); - function transcriptionResponseToJSON(transcriptionResponse) { - return JSON.stringify(exports.TranscriptionResponse$outboundSchema.parse(transcriptionResponse)); - } - function transcriptionResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js - var require_transcriptionstreamdone = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamdone.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamDone$ = exports.TranscriptionStreamDone$outboundSchema = exports.TranscriptionStreamDone$inboundSchema = exports.TranscriptionStreamDoneType$ = exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema = exports.TranscriptionStreamDoneType = void 0; - exports.transcriptionStreamDoneToJSON = transcriptionStreamDoneToJSON; - exports.transcriptionStreamDoneFromJSON = transcriptionStreamDoneFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var transcriptionsegmentchunk_js_1 = require_transcriptionsegmentchunk(); - var usageinfo_js_1 = require_usageinfo(); - exports.TranscriptionStreamDoneType = { - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamDoneType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamDoneType); - exports.TranscriptionStreamDoneType$outboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - var TranscriptionStreamDoneType$; - (function(TranscriptionStreamDoneType$2) { - TranscriptionStreamDoneType$2.inboundSchema = exports.TranscriptionStreamDoneType$inboundSchema; - TranscriptionStreamDoneType$2.outboundSchema = exports.TranscriptionStreamDoneType$outboundSchema; - })(TranscriptionStreamDoneType$ || (exports.TranscriptionStreamDoneType$ = TranscriptionStreamDoneType$ = {})); - exports.TranscriptionStreamDone$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$inboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$inboundSchema, - type: exports.TranscriptionStreamDoneType$inboundSchema.default("transcription.done"), - language: z.nullable(z.string()) - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamDone$outboundSchema = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(transcriptionsegmentchunk_js_1.TranscriptionSegmentChunk$outboundSchema).optional(), - usage: usageinfo_js_1.UsageInfo$outboundSchema, - type: exports.TranscriptionStreamDoneType$outboundSchema.default("transcription.done"), - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamDone$; - (function(TranscriptionStreamDone$2) { - TranscriptionStreamDone$2.inboundSchema = exports.TranscriptionStreamDone$inboundSchema; - TranscriptionStreamDone$2.outboundSchema = exports.TranscriptionStreamDone$outboundSchema; - })(TranscriptionStreamDone$ || (exports.TranscriptionStreamDone$ = TranscriptionStreamDone$ = {})); - function transcriptionStreamDoneToJSON(transcriptionStreamDone) { - return JSON.stringify(exports.TranscriptionStreamDone$outboundSchema.parse(transcriptionStreamDone)); - } - function transcriptionStreamDoneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamDone$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamDone' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js - var require_transcriptionstreameventtypes = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreameventtypes.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEventTypes$ = exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema = exports.TranscriptionStreamEventTypes = void 0; - var z = __importStar(require_zod()); - exports.TranscriptionStreamEventTypes = { - TranscriptionLanguage: "transcription.language", - TranscriptionSegment: "transcription.segment", - TranscriptionTextDelta: "transcription.text.delta", - TranscriptionDone: "transcription.done" - }; - exports.TranscriptionStreamEventTypes$inboundSchema = z.nativeEnum(exports.TranscriptionStreamEventTypes); - exports.TranscriptionStreamEventTypes$outboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - var TranscriptionStreamEventTypes$; - (function(TranscriptionStreamEventTypes$2) { - TranscriptionStreamEventTypes$2.inboundSchema = exports.TranscriptionStreamEventTypes$inboundSchema; - TranscriptionStreamEventTypes$2.outboundSchema = exports.TranscriptionStreamEventTypes$outboundSchema; - })(TranscriptionStreamEventTypes$ || (exports.TranscriptionStreamEventTypes$ = TranscriptionStreamEventTypes$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js - var require_transcriptionstreamlanguage = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamlanguage.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamLanguage$ = exports.TranscriptionStreamLanguage$outboundSchema = exports.TranscriptionStreamLanguage$inboundSchema = exports.TranscriptionStreamLanguageType$ = exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema = exports.TranscriptionStreamLanguageType = void 0; - exports.transcriptionStreamLanguageToJSON = transcriptionStreamLanguageToJSON; - exports.transcriptionStreamLanguageFromJSON = transcriptionStreamLanguageFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamLanguageType = { - TranscriptionLanguage: "transcription.language" - }; - exports.TranscriptionStreamLanguageType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamLanguageType); - exports.TranscriptionStreamLanguageType$outboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - var TranscriptionStreamLanguageType$; - (function(TranscriptionStreamLanguageType$2) { - TranscriptionStreamLanguageType$2.inboundSchema = exports.TranscriptionStreamLanguageType$inboundSchema; - TranscriptionStreamLanguageType$2.outboundSchema = exports.TranscriptionStreamLanguageType$outboundSchema; - })(TranscriptionStreamLanguageType$ || (exports.TranscriptionStreamLanguageType$ = TranscriptionStreamLanguageType$ = {})); - exports.TranscriptionStreamLanguage$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - type: exports.TranscriptionStreamLanguageType$inboundSchema.default("transcription.language"), - audio_language: z.string() - }).catchall(z.any()), "additionalProperties", true).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "audio_language": "audioLanguage" - }); - }); - exports.TranscriptionStreamLanguage$outboundSchema = z.object({ - type: exports.TranscriptionStreamLanguageType$outboundSchema.default("transcription.language"), - audioLanguage: z.string(), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - audioLanguage: "audio_language", - additionalProperties: null - }) - }; - }); - var TranscriptionStreamLanguage$; - (function(TranscriptionStreamLanguage$2) { - TranscriptionStreamLanguage$2.inboundSchema = exports.TranscriptionStreamLanguage$inboundSchema; - TranscriptionStreamLanguage$2.outboundSchema = exports.TranscriptionStreamLanguage$outboundSchema; - })(TranscriptionStreamLanguage$ || (exports.TranscriptionStreamLanguage$ = TranscriptionStreamLanguage$ = {})); - function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage) { - return JSON.stringify(exports.TranscriptionStreamLanguage$outboundSchema.parse(transcriptionStreamLanguage)); - } - function transcriptionStreamLanguageFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamLanguage$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamLanguage' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js - var require_transcriptionstreamsegmentdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamsegmentdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamSegmentDelta$ = exports.TranscriptionStreamSegmentDelta$outboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema = exports.TranscriptionStreamSegmentDeltaType$ = exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema = exports.TranscriptionStreamSegmentDeltaType = void 0; - exports.transcriptionStreamSegmentDeltaToJSON = transcriptionStreamSegmentDeltaToJSON; - exports.transcriptionStreamSegmentDeltaFromJSON = transcriptionStreamSegmentDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamSegmentDeltaType = { - TranscriptionSegment: "transcription.segment" - }; - exports.TranscriptionStreamSegmentDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamSegmentDeltaType); - exports.TranscriptionStreamSegmentDeltaType$outboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - var TranscriptionStreamSegmentDeltaType$; - (function(TranscriptionStreamSegmentDeltaType$2) { - TranscriptionStreamSegmentDeltaType$2.inboundSchema = exports.TranscriptionStreamSegmentDeltaType$inboundSchema; - TranscriptionStreamSegmentDeltaType$2.outboundSchema = exports.TranscriptionStreamSegmentDeltaType$outboundSchema; - })(TranscriptionStreamSegmentDeltaType$ || (exports.TranscriptionStreamSegmentDeltaType$ = TranscriptionStreamSegmentDeltaType$ = {})); - exports.TranscriptionStreamSegmentDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$inboundSchema.default("transcription.segment") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamSegmentDelta$outboundSchema = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: exports.TranscriptionStreamSegmentDeltaType$outboundSchema.default("transcription.segment"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamSegmentDelta$; - (function(TranscriptionStreamSegmentDelta$2) { - TranscriptionStreamSegmentDelta$2.inboundSchema = exports.TranscriptionStreamSegmentDelta$inboundSchema; - TranscriptionStreamSegmentDelta$2.outboundSchema = exports.TranscriptionStreamSegmentDelta$outboundSchema; - })(TranscriptionStreamSegmentDelta$ || (exports.TranscriptionStreamSegmentDelta$ = TranscriptionStreamSegmentDelta$ = {})); - function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta) { - return JSON.stringify(exports.TranscriptionStreamSegmentDelta$outboundSchema.parse(transcriptionStreamSegmentDelta)); - } - function transcriptionStreamSegmentDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamSegmentDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamSegmentDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js - var require_transcriptionstreamtextdelta = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamtextdelta.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamTextDelta$ = exports.TranscriptionStreamTextDelta$outboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema = exports.TranscriptionStreamTextDeltaType$ = exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema = exports.TranscriptionStreamTextDeltaType = void 0; - exports.transcriptionStreamTextDeltaToJSON = transcriptionStreamTextDeltaToJSON; - exports.transcriptionStreamTextDeltaFromJSON = transcriptionStreamTextDeltaFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.TranscriptionStreamTextDeltaType = { - TranscriptionTextDelta: "transcription.text.delta" - }; - exports.TranscriptionStreamTextDeltaType$inboundSchema = z.nativeEnum(exports.TranscriptionStreamTextDeltaType); - exports.TranscriptionStreamTextDeltaType$outboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - var TranscriptionStreamTextDeltaType$; - (function(TranscriptionStreamTextDeltaType$2) { - TranscriptionStreamTextDeltaType$2.inboundSchema = exports.TranscriptionStreamTextDeltaType$inboundSchema; - TranscriptionStreamTextDeltaType$2.outboundSchema = exports.TranscriptionStreamTextDeltaType$outboundSchema; - })(TranscriptionStreamTextDeltaType$ || (exports.TranscriptionStreamTextDeltaType$ = TranscriptionStreamTextDeltaType$ = {})); - exports.TranscriptionStreamTextDelta$inboundSchema = (0, schemas_js_1.collectExtraKeys)(z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$inboundSchema.default("transcription.text.delta") - }).catchall(z.any()), "additionalProperties", true); - exports.TranscriptionStreamTextDelta$outboundSchema = z.object({ - text: z.string(), - type: exports.TranscriptionStreamTextDeltaType$outboundSchema.default("transcription.text.delta"), - additionalProperties: z.record(z.any()) - }).transform((v) => { - return { - ...v.additionalProperties, - ...(0, primitives_js_1.remap)(v, { - additionalProperties: null - }) - }; - }); - var TranscriptionStreamTextDelta$; - (function(TranscriptionStreamTextDelta$2) { - TranscriptionStreamTextDelta$2.inboundSchema = exports.TranscriptionStreamTextDelta$inboundSchema; - TranscriptionStreamTextDelta$2.outboundSchema = exports.TranscriptionStreamTextDelta$outboundSchema; - })(TranscriptionStreamTextDelta$ || (exports.TranscriptionStreamTextDelta$ = TranscriptionStreamTextDelta$ = {})); - function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta) { - return JSON.stringify(exports.TranscriptionStreamTextDelta$outboundSchema.parse(transcriptionStreamTextDelta)); - } - function transcriptionStreamTextDeltaFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamTextDelta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamTextDelta' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js - var require_transcriptionstreamevents = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/transcriptionstreamevents.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.TranscriptionStreamEvents$ = exports.TranscriptionStreamEvents$outboundSchema = exports.TranscriptionStreamEvents$inboundSchema = exports.TranscriptionStreamEventsData$ = exports.TranscriptionStreamEventsData$outboundSchema = exports.TranscriptionStreamEventsData$inboundSchema = void 0; - exports.transcriptionStreamEventsDataToJSON = transcriptionStreamEventsDataToJSON; - exports.transcriptionStreamEventsDataFromJSON = transcriptionStreamEventsDataFromJSON; - exports.transcriptionStreamEventsToJSON = transcriptionStreamEventsToJSON; - exports.transcriptionStreamEventsFromJSON = transcriptionStreamEventsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var transcriptionstreamdone_js_1 = require_transcriptionstreamdone(); - var transcriptionstreameventtypes_js_1 = require_transcriptionstreameventtypes(); - var transcriptionstreamlanguage_js_1 = require_transcriptionstreamlanguage(); - var transcriptionstreamsegmentdelta_js_1 = require_transcriptionstreamsegmentdelta(); - var transcriptionstreamtextdelta_js_1 = require_transcriptionstreamtextdelta(); - exports.TranscriptionStreamEventsData$inboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - exports.TranscriptionStreamEventsData$outboundSchema = z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]); - var TranscriptionStreamEventsData$; - (function(TranscriptionStreamEventsData$2) { - TranscriptionStreamEventsData$2.inboundSchema = exports.TranscriptionStreamEventsData$inboundSchema; - TranscriptionStreamEventsData$2.outboundSchema = exports.TranscriptionStreamEventsData$outboundSchema; - })(TranscriptionStreamEventsData$ || (exports.TranscriptionStreamEventsData$ = TranscriptionStreamEventsData$ = {})); - function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData) { - return JSON.stringify(exports.TranscriptionStreamEventsData$outboundSchema.parse(transcriptionStreamEventsData)); - } - function transcriptionStreamEventsDataFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEventsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEventsData' from JSON`); - } - exports.TranscriptionStreamEvents$inboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}` - }); - return z.NEVER; - } - }).pipe(z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$inboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$inboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ type: v.type }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$inboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$inboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ])) - }); - exports.TranscriptionStreamEvents$outboundSchema = z.object({ - event: transcriptionstreameventtypes_js_1.TranscriptionStreamEventTypes$outboundSchema, - data: z.union([ - transcriptionstreamdone_js_1.TranscriptionStreamDone$outboundSchema.and(z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamsegmentdelta_js_1.TranscriptionStreamSegmentDelta$outboundSchema.and(z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type - }))), - transcriptionstreamlanguage_js_1.TranscriptionStreamLanguage$outboundSchema.and(z.object({ type: z.literal("transcription.language") }).transform((v) => ({ type: v.type }))), - transcriptionstreamtextdelta_js_1.TranscriptionStreamTextDelta$outboundSchema.and(z.object({ type: z.literal("transcription.text.delta") }).transform((v) => ({ type: v.type }))) - ]) - }); - var TranscriptionStreamEvents$; - (function(TranscriptionStreamEvents$2) { - TranscriptionStreamEvents$2.inboundSchema = exports.TranscriptionStreamEvents$inboundSchema; - TranscriptionStreamEvents$2.outboundSchema = exports.TranscriptionStreamEvents$outboundSchema; - })(TranscriptionStreamEvents$ || (exports.TranscriptionStreamEvents$ = TranscriptionStreamEvents$ = {})); - function transcriptionStreamEventsToJSON(transcriptionStreamEvents) { - return JSON.stringify(exports.TranscriptionStreamEvents$outboundSchema.parse(transcriptionStreamEvents)); - } - function transcriptionStreamEventsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TranscriptionStreamEvents$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TranscriptionStreamEvents' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js - var require_unarchiveftmodelout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/unarchiveftmodelout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UnarchiveFTModelOut$ = exports.UnarchiveFTModelOut$outboundSchema = exports.UnarchiveFTModelOut$inboundSchema = exports.UnarchiveFTModelOutObject$ = exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema = exports.UnarchiveFTModelOutObject = void 0; - exports.unarchiveFTModelOutToJSON = unarchiveFTModelOutToJSON; - exports.unarchiveFTModelOutFromJSON = unarchiveFTModelOutFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UnarchiveFTModelOutObject = { - Model: "model" - }; - exports.UnarchiveFTModelOutObject$inboundSchema = z.nativeEnum(exports.UnarchiveFTModelOutObject); - exports.UnarchiveFTModelOutObject$outboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - var UnarchiveFTModelOutObject$; - (function(UnarchiveFTModelOutObject$2) { - UnarchiveFTModelOutObject$2.inboundSchema = exports.UnarchiveFTModelOutObject$inboundSchema; - UnarchiveFTModelOutObject$2.outboundSchema = exports.UnarchiveFTModelOutObject$outboundSchema; - })(UnarchiveFTModelOutObject$ || (exports.UnarchiveFTModelOutObject$ = UnarchiveFTModelOutObject$ = {})); - exports.UnarchiveFTModelOut$inboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(false) - }); - exports.UnarchiveFTModelOut$outboundSchema = z.object({ - id: z.string(), - object: exports.UnarchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(false) - }); - var UnarchiveFTModelOut$; - (function(UnarchiveFTModelOut$2) { - UnarchiveFTModelOut$2.inboundSchema = exports.UnarchiveFTModelOut$inboundSchema; - UnarchiveFTModelOut$2.outboundSchema = exports.UnarchiveFTModelOut$outboundSchema; - })(UnarchiveFTModelOut$ || (exports.UnarchiveFTModelOut$ = UnarchiveFTModelOut$ = {})); - function unarchiveFTModelOutToJSON(unarchiveFTModelOut) { - return JSON.stringify(exports.UnarchiveFTModelOut$outboundSchema.parse(unarchiveFTModelOut)); - } - function unarchiveFTModelOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UnarchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UnarchiveFTModelOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/updateftmodelin.js - var require_updateftmodelin = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/updateftmodelin.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UpdateFTModelIn$ = exports.UpdateFTModelIn$outboundSchema = exports.UpdateFTModelIn$inboundSchema = void 0; - exports.updateFTModelInToJSON = updateFTModelInToJSON; - exports.updateFTModelInFromJSON = updateFTModelInFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.UpdateFTModelIn$inboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - exports.UpdateFTModelIn$outboundSchema = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional() - }); - var UpdateFTModelIn$; - (function(UpdateFTModelIn$2) { - UpdateFTModelIn$2.inboundSchema = exports.UpdateFTModelIn$inboundSchema; - UpdateFTModelIn$2.outboundSchema = exports.UpdateFTModelIn$outboundSchema; - })(UpdateFTModelIn$ || (exports.UpdateFTModelIn$ = UpdateFTModelIn$ = {})); - function updateFTModelInToJSON(updateFTModelIn) { - return JSON.stringify(exports.UpdateFTModelIn$outboundSchema.parse(updateFTModelIn)); - } - function updateFTModelInFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UpdateFTModelIn$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UpdateFTModelIn' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/uploadfileout.js - var require_uploadfileout = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/uploadfileout.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.UploadFileOut$ = exports.UploadFileOut$outboundSchema = exports.UploadFileOut$inboundSchema = void 0; - exports.uploadFileOutToJSON = uploadFileOutToJSON; - exports.uploadFileOutFromJSON = uploadFileOutFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var filepurpose_js_1 = require_filepurpose(); - var sampletype_js_1 = require_sampletype(); - var source_js_1 = require_source(); - exports.UploadFileOut$inboundSchema = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$inboundSchema, - sample_type: sampletype_js_1.SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$inboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines" - }); - }); - exports.UploadFileOut$outboundSchema = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: filepurpose_js_1.FilePurpose$outboundSchema, - sampleType: sampletype_js_1.SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: source_js_1.Source$outboundSchema, - signature: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines" - }); - }); - var UploadFileOut$; - (function(UploadFileOut$2) { - UploadFileOut$2.inboundSchema = exports.UploadFileOut$inboundSchema; - UploadFileOut$2.outboundSchema = exports.UploadFileOut$outboundSchema; - })(UploadFileOut$ || (exports.UploadFileOut$ = UploadFileOut$ = {})); - function uploadFileOutToJSON(uploadFileOut) { - return JSON.stringify(exports.UploadFileOut$outboundSchema.parse(uploadFileOut)); - } - function uploadFileOutFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.UploadFileOut$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'UploadFileOut' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/validationerror.js - var require_validationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/validationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ValidationError$ = exports.ValidationError$outboundSchema = exports.ValidationError$inboundSchema = exports.Loc$ = exports.Loc$outboundSchema = exports.Loc$inboundSchema = void 0; - exports.locToJSON = locToJSON; - exports.locFromJSON = locFromJSON; - exports.validationErrorToJSON = validationErrorToJSON; - exports.validationErrorFromJSON = validationErrorFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - exports.Loc$inboundSchema = z.union([z.string(), z.number().int()]); - exports.Loc$outboundSchema = z.union([z.string(), z.number().int()]); - var Loc$; - (function(Loc$2) { - Loc$2.inboundSchema = exports.Loc$inboundSchema; - Loc$2.outboundSchema = exports.Loc$outboundSchema; - })(Loc$ || (exports.Loc$ = Loc$ = {})); - function locToJSON(loc) { - return JSON.stringify(exports.Loc$outboundSchema.parse(loc)); - } - function locFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Loc$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Loc' from JSON`); - } - exports.ValidationError$inboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - exports.ValidationError$outboundSchema = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string() - }); - var ValidationError$; - (function(ValidationError$2) { - ValidationError$2.inboundSchema = exports.ValidationError$inboundSchema; - ValidationError$2.outboundSchema = exports.ValidationError$outboundSchema; - })(ValidationError$ || (exports.ValidationError$ = ValidationError$ = {})); - function validationErrorToJSON(validationError) { - return JSON.stringify(exports.ValidationError$outboundSchema.parse(validationError)); - } - function validationErrorFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ValidationError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ValidationError' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/components/index.js - var require_components = __commonJS({ - "node_modules/@mistralai/mistralai/models/components/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agent(), exports); - __exportStar(require_agentconversation(), exports); - __exportStar(require_agentcreationrequest(), exports); - __exportStar(require_agenthandoffdoneevent(), exports); - __exportStar(require_agenthandoffentry(), exports); - __exportStar(require_agenthandoffstartedevent(), exports); - __exportStar(require_agentscompletionrequest(), exports); - __exportStar(require_agentscompletionstreamrequest(), exports); - __exportStar(require_agentupdaterequest(), exports); - __exportStar(require_apiendpoint(), exports); - __exportStar(require_archiveftmodelout(), exports); - __exportStar(require_assistantmessage(), exports); - __exportStar(require_audiochunk(), exports); - __exportStar(require_audiotranscriptionrequest(), exports); - __exportStar(require_audiotranscriptionrequeststream(), exports); - __exportStar(require_basemodelcard(), exports); - __exportStar(require_batcherror(), exports); - __exportStar(require_batchjobin(), exports); - __exportStar(require_batchjobout(), exports); - __exportStar(require_batchjobsout(), exports); - __exportStar(require_batchjobstatus(), exports); - __exportStar(require_builtinconnectors(), exports); - __exportStar(require_chatclassificationrequest(), exports); - __exportStar(require_chatcompletionchoice(), exports); - __exportStar(require_chatcompletionrequest(), exports); - __exportStar(require_chatcompletionresponse(), exports); - __exportStar(require_chatcompletionstreamrequest(), exports); - __exportStar(require_chatmoderationrequest(), exports); - __exportStar(require_checkpointout(), exports); - __exportStar(require_classificationrequest(), exports); - __exportStar(require_classificationresponse(), exports); - __exportStar(require_classificationtargetresult(), exports); - __exportStar(require_classifierdetailedjobout(), exports); - __exportStar(require_classifierftmodelout(), exports); - __exportStar(require_classifierjobout(), exports); - __exportStar(require_classifiertargetin(), exports); - __exportStar(require_classifiertargetout(), exports); - __exportStar(require_classifiertrainingparameters(), exports); - __exportStar(require_classifiertrainingparametersin(), exports); - __exportStar(require_codeinterpretertool(), exports); - __exportStar(require_completionargs(), exports); - __exportStar(require_completionargsstop(), exports); - __exportStar(require_completionchunk(), exports); - __exportStar(require_completiondetailedjobout(), exports); - __exportStar(require_completionevent(), exports); - __exportStar(require_completionftmodelout(), exports); - __exportStar(require_completionjobout(), exports); - __exportStar(require_completionresponsestreamchoice(), exports); - __exportStar(require_completiontrainingparameters(), exports); - __exportStar(require_completiontrainingparametersin(), exports); - __exportStar(require_contentchunk(), exports); - __exportStar(require_conversationappendrequest(), exports); - __exportStar(require_conversationappendstreamrequest(), exports); - __exportStar(require_conversationevents(), exports); - __exportStar(require_conversationhistory(), exports); - __exportStar(require_conversationinputs(), exports); - __exportStar(require_conversationmessages(), exports); - __exportStar(require_conversationrequest(), exports); - __exportStar(require_conversationresponse(), exports); - __exportStar(require_conversationrestartrequest(), exports); - __exportStar(require_conversationrestartstreamrequest(), exports); - __exportStar(require_conversationstreamrequest(), exports); - __exportStar(require_conversationusageinfo(), exports); - __exportStar(require_deletefileout(), exports); - __exportStar(require_deletemodelout(), exports); - __exportStar(require_deltamessage(), exports); - __exportStar(require_documentlibrarytool(), exports); - __exportStar(require_documentout(), exports); - __exportStar(require_documenttextcontent(), exports); - __exportStar(require_documentupdatein(), exports); - __exportStar(require_documenturlchunk(), exports); - __exportStar(require_embeddingdtype(), exports); - __exportStar(require_embeddingrequest(), exports); - __exportStar(require_embeddingresponse(), exports); - __exportStar(require_embeddingresponsedata(), exports); - __exportStar(require_encodingformat(), exports); - __exportStar(require_entitytype(), exports); - __exportStar(require_eventout(), exports); - __exportStar(require_file(), exports); - __exportStar(require_filechunk(), exports); - __exportStar(require_filepurpose(), exports); - __exportStar(require_fileschema(), exports); - __exportStar(require_filesignedurl(), exports); - __exportStar(require_fimcompletionrequest(), exports); - __exportStar(require_fimcompletionresponse(), exports); - __exportStar(require_fimcompletionstreamrequest(), exports); - __exportStar(require_finetuneablemodeltype(), exports); - __exportStar(require_ftclassifierlossfunction(), exports); - __exportStar(require_ftmodelcapabilitiesout(), exports); - __exportStar(require_ftmodelcard(), exports); - __exportStar(require_function(), exports); - __exportStar(require_functioncall(), exports); - __exportStar(require_functioncallentry(), exports); - __exportStar(require_functioncallentryarguments(), exports); - __exportStar(require_functioncallevent(), exports); - __exportStar(require_functionname(), exports); - __exportStar(require_functionresultentry(), exports); - __exportStar(require_functiontool(), exports); - __exportStar(require_githubrepositoryin(), exports); - __exportStar(require_githubrepositoryout(), exports); - __exportStar(require_imagegenerationtool(), exports); - __exportStar(require_imageurl(), exports); - __exportStar(require_imageurlchunk(), exports); - __exportStar(require_inputentries(), exports); - __exportStar(require_inputs(), exports); - __exportStar(require_instructrequest(), exports); - __exportStar(require_jobin(), exports); - __exportStar(require_jobmetadataout(), exports); - __exportStar(require_jobsout(), exports); - __exportStar(require_jsonschema(), exports); - __exportStar(require_legacyjobmetadataout(), exports); - __exportStar(require_libraryin(), exports); - __exportStar(require_libraryinupdate(), exports); - __exportStar(require_libraryout(), exports); - __exportStar(require_listdocumentout(), exports); - __exportStar(require_listfilesout(), exports); - __exportStar(require_listlibraryout(), exports); - __exportStar(require_listsharingout(), exports); - __exportStar(require_messageentries(), exports); - __exportStar(require_messageinputcontentchunks(), exports); - __exportStar(require_messageinputentry(), exports); - __exportStar(require_messageoutputcontentchunks(), exports); - __exportStar(require_messageoutputentry(), exports); - __exportStar(require_messageoutputevent(), exports); - __exportStar(require_metricout(), exports); - __exportStar(require_mistralpromptmode(), exports); - __exportStar(require_modelcapabilities(), exports); - __exportStar(require_modelconversation(), exports); - __exportStar(require_modellist(), exports); - __exportStar(require_moderationobject(), exports); - __exportStar(require_moderationresponse(), exports); - __exportStar(require_ocrimageobject(), exports); - __exportStar(require_ocrpagedimensions(), exports); - __exportStar(require_ocrpageobject(), exports); - __exportStar(require_ocrrequest(), exports); - __exportStar(require_ocrresponse(), exports); - __exportStar(require_ocrusageinfo(), exports); - __exportStar(require_outputcontentchunks(), exports); - __exportStar(require_paginationinfo(), exports); - __exportStar(require_prediction(), exports); - __exportStar(require_processingstatusout(), exports); - __exportStar(require_referencechunk(), exports); - __exportStar(require_responsedoneevent(), exports); - __exportStar(require_responseerrorevent(), exports); - __exportStar(require_responseformat(), exports); - __exportStar(require_responseformats(), exports); - __exportStar(require_responsestartedevent(), exports); - __exportStar(require_retrievefileout(), exports); - __exportStar(require_sampletype(), exports); - __exportStar(require_security2(), exports); - __exportStar(require_shareenum(), exports); - __exportStar(require_sharingdelete(), exports); - __exportStar(require_sharingin(), exports); - __exportStar(require_sharingout(), exports); - __exportStar(require_source(), exports); - __exportStar(require_ssetypes(), exports); - __exportStar(require_systemmessage(), exports); - __exportStar(require_systemmessagecontentchunks(), exports); - __exportStar(require_textchunk(), exports); - __exportStar(require_thinkchunk(), exports); - __exportStar(require_timestampgranularity(), exports); - __exportStar(require_tool(), exports); - __exportStar(require_toolcall(), exports); - __exportStar(require_toolchoice(), exports); - __exportStar(require_toolchoiceenum(), exports); - __exportStar(require_toolexecutiondeltaevent(), exports); - __exportStar(require_toolexecutiondoneevent(), exports); - __exportStar(require_toolexecutionentry(), exports); - __exportStar(require_toolexecutionstartedevent(), exports); - __exportStar(require_toolfilechunk(), exports); - __exportStar(require_toolmessage(), exports); - __exportStar(require_toolreferencechunk(), exports); - __exportStar(require_tooltypes(), exports); - __exportStar(require_trainingfile(), exports); - __exportStar(require_transcriptionresponse(), exports); - __exportStar(require_transcriptionsegmentchunk(), exports); - __exportStar(require_transcriptionstreamdone(), exports); - __exportStar(require_transcriptionstreamevents(), exports); - __exportStar(require_transcriptionstreameventtypes(), exports); - __exportStar(require_transcriptionstreamlanguage(), exports); - __exportStar(require_transcriptionstreamsegmentdelta(), exports); - __exportStar(require_transcriptionstreamtextdelta(), exports); - __exportStar(require_unarchiveftmodelout(), exports); - __exportStar(require_updateftmodelin(), exports); - __exportStar(require_uploadfileout(), exports); - __exportStar(require_usageinfo(), exports); - __exportStar(require_usermessage(), exports); - __exportStar(require_validationerror(), exports); - __exportStar(require_wandbintegration(), exports); - __exportStar(require_wandbintegrationout(), exports); - __exportStar(require_websearchpremiumtool(), exports); - __exportStar(require_websearchtool(), exports); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js - var require_httpvalidationerror = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/httpvalidationerror.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPValidationError$ = exports.HTTPValidationError$outboundSchema = exports.HTTPValidationError$inboundSchema = exports.HTTPValidationError = void 0; - var z = __importStar(require_zod()); - var components = __importStar(require_components()); - var mistralerror_js_1 = require_mistralerror(); - var HTTPValidationError = class extends mistralerror_js_1.MistralError { - constructor(err, httpMeta) { - const message = "message" in err && typeof err.message === "string" ? err.message : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - if (err.detail != null) - this.detail = err.detail; - this.name = "HTTPValidationError"; - } - }; - exports.HTTPValidationError = HTTPValidationError; - exports.HTTPValidationError$inboundSchema = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), - request$: z.instanceof(Request), - response$: z.instanceof(Response), - body$: z.string() - }).transform((v) => { - return new HTTPValidationError(v, { - request: v.request$, - response: v.response$, - body: v.body$ - }); - }); - exports.HTTPValidationError$outboundSchema = z.instanceof(HTTPValidationError).transform((v) => v.data$).pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional() - })); - var HTTPValidationError$; - (function(HTTPValidationError$2) { - HTTPValidationError$2.inboundSchema = exports.HTTPValidationError$inboundSchema; - HTTPValidationError$2.outboundSchema = exports.HTTPValidationError$outboundSchema; - })(HTTPValidationError$ || (exports.HTTPValidationError$ = HTTPValidationError$ = {})); - } - }); - - // node_modules/@mistralai/mistralai/models/errors/index.js - var require_errors2 = __commonJS({ - "node_modules/@mistralai/mistralai/models/errors/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_httpclienterrors(), exports); - __exportStar(require_httpvalidationerror(), exports); - __exportStar(require_responsevalidationerror(), exports); - __exportStar(require_sdkerror(), exports); - __exportStar(require_sdkvalidationerror(), exports); - } - }); - - // node_modules/@mistralai/mistralai/types/async.js - var require_async = __commonJS({ - "node_modules/@mistralai/mistralai/types/async.js"(exports) { - "use strict"; - var __classPrivateFieldSet = exports && exports.__classPrivateFieldSet || function(receiver, state, value, kind, f) { - if (kind === "m") throw new TypeError("Private method is not writable"); - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it"); - return kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value), value; - }; - var __classPrivateFieldGet = exports && exports.__classPrivateFieldGet || function(receiver, state, kind, f) { - if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter"); - if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it"); - return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver); - }; - var _APIPromise_promise; - var _APIPromise_unwrapped; - var _a; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.APIPromise = void 0; - var APIPromise = class { - constructor(p) { - _APIPromise_promise.set(this, void 0); - _APIPromise_unwrapped.set(this, void 0); - this[_a] = "APIPromise"; - __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f"); - __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value) : Promise.resolve(p[0]), "f"); - } - then(onfulfilled, onrejected) { - return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected); - } - catch(onrejected) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected); - } - finally(onfinally) { - return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally); - } - $inspect() { - return __classPrivateFieldGet(this, _APIPromise_promise, "f"); - } - }; - exports.APIPromise = APIPromise; - _APIPromise_promise = /* @__PURE__ */ new WeakMap(), _APIPromise_unwrapped = /* @__PURE__ */ new WeakMap(), _a = Symbol.toStringTag; - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsComplete.js - var require_agentsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsComplete = agentsComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_completion_v1_agents_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/lib/event-streams.js - var require_event_streams = __commonJS({ - "node_modules/@mistralai/mistralai/lib/event-streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.EventStream = void 0; - var EventStream = class extends ReadableStream { - constructor(responseBody, parse) { - const upstream = responseBody.getReader(); - let buffer = new Uint8Array(); - super({ - async pull(downstream) { - try { - while (true) { - const match = findBoundary(buffer); - if (!match) { - const chunk = await upstream.read(); - if (chunk.done) - return downstream.close(); - buffer = concatBuffer(buffer, chunk.value); - continue; - } - const message = buffer.slice(0, match.index); - buffer = buffer.slice(match.index + match.length); - const item = parseMessage(message, parse); - if (item?.value) - return downstream.enqueue(item.value); - if (item?.done) { - await upstream.cancel("done"); - return downstream.close(); - } - } - } catch (e) { - downstream.error(e); - await upstream.cancel(e); - } - }, - cancel: (reason) => upstream.cancel(reason) - }); - } - // Polyfill for older browsers - [Symbol.asyncIterator]() { - const fn = ReadableStream.prototype[Symbol.asyncIterator]; - if (typeof fn === "function") - return fn.call(this); - const reader = this.getReader(); - return { - next: async () => { - const r = await reader.read(); - if (r.done) { - reader.releaseLock(); - return { done: true, value: void 0 }; - } - return { done: false, value: r.value }; - }, - throw: async (e) => { - await reader.cancel(e); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - return: async () => { - await reader.cancel("done"); - reader.releaseLock(); - return { done: true, value: void 0 }; - }, - [Symbol.asyncIterator]() { - return this; - } - }; - } - }; - exports.EventStream = EventStream; - function concatBuffer(a, b) { - const c = new Uint8Array(a.length + b.length); - c.set(a, 0); - c.set(b, a.length); - return c; - } - function findBoundary(buf) { - const len = buf.length; - for (let i = 0; i < len; i++) { - if (i <= len - 4 && buf[i] === 13 && buf[i + 1] === 10 && buf[i + 2] === 13 && buf[i + 3] === 10) { - return { index: i, length: 4 }; - } - if (i <= len - 2 && buf[i] === 13 && buf[i + 1] === 13) { - return { index: i, length: 2 }; - } - if (i <= len - 2 && buf[i] === 10 && buf[i + 1] === 10) { - return { index: i, length: 2 }; - } - } - return null; - } - function parseMessage(chunk, parse) { - const text = new TextDecoder().decode(chunk); - const lines = text.split(/\r\n|\r|\n/); - const dataLines = []; - const ret = {}; - let ignore = true; - for (const line of lines) { - if (!line || line.startsWith(":")) - continue; - ignore = false; - const i = line.indexOf(":"); - const field = line.slice(0, i); - const value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1); - if (field === "data") - dataLines.push(value); - else if (field === "event") - ret.event = value; - else if (field === "id") - ret.id = value; - else if (field === "retry") { - const n = Number(value); - if (!isNaN(n)) - ret.retry = n; - } - } - if (ignore) - return; - if (dataLines.length) - ret.data = dataLines.join("\n"); - return parse(ret); - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/agentsStream.js - var require_agentsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/agentsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.agentsStream = agentsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function agentsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentsCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_agents", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/agents.js - var require_agents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/agents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Agents = void 0; - var agentsComplete_js_1 = require_agentsComplete(); - var agentsStream_js_1 = require_agentsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Agents = class extends sdks_js_1.ClientSDK { - /** - * Agents Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsComplete_js_1.agentsComplete)(this, request, options)); - } - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, agentsStream_js_1.agentsStream)(this, request, options)); - } - }; - exports.Agents = Agents; - } - }); - - // node_modules/@mistralai/mistralai/types/streams.js - var require_streams = __commonJS({ - "node_modules/@mistralai/mistralai/types/streams.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.isReadableStream = isReadableStream; - function isReadableStream(val) { - if (typeof val !== "object" || val === null) { - return false; - } - const stream = val; - return typeof stream.getReader === "function" && typeof stream.cancel === "function" && typeof stream.tee === "function"; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js - var require_audioTranscriptionsComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsComplete = audioTranscriptionsComplete; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.TranscriptionResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js - var require_audioTranscriptionsStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/audioTranscriptionsStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.audioTranscriptionsStream = audioTranscriptionsStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function audioTranscriptionsStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AudioTranscriptionRequestStream$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - (0, encodings_js_1.appendForm)(body, "model", payload.model); - if (payload.file !== void 0) { - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - } - if (payload.file_id !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_id", payload.file_id); - } - if (payload.file_url !== void 0) { - (0, encodings_js_1.appendForm)(body, "file_url", payload.file_url); - } - if (payload.language !== void 0) { - (0, encodings_js_1.appendForm)(body, "language", payload.language); - } - if (payload.stream !== void 0) { - (0, encodings_js_1.appendForm)(body, "stream", payload.stream); - } - if (payload.temperature !== void 0) { - (0, encodings_js_1.appendForm)(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== void 0) { - (0, encodings_js_1.appendForm)(body, "timestamp_granularities", payload.timestamp_granularities); - } - const path = (0, url_js_1.pathToFunc)("/v1/audio/transcriptions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.TranscriptionStreamEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/transcriptions.js - var require_transcriptions = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/transcriptions.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Transcriptions = void 0; - var audioTranscriptionsComplete_js_1 = require_audioTranscriptionsComplete(); - var audioTranscriptionsStream_js_1 = require_audioTranscriptionsStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Transcriptions = class extends sdks_js_1.ClientSDK { - /** - * Create Transcription - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsComplete_js_1.audioTranscriptionsComplete)(this, request, options)); - } - /** - * Create streaming transcription (SSE) - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, audioTranscriptionsStream_js_1.audioTranscriptionsStream)(this, request, options)); - } - }; - exports.Transcriptions = Transcriptions; - } - }); - - // node_modules/@mistralai/mistralai/sdk/audio.js - var require_audio = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/audio.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Audio = void 0; - var sdks_js_1 = require_sdks(); - var transcriptions_js_1 = require_transcriptions(); - var Audio = class extends sdks_js_1.ClientSDK { - get transcriptions() { - return this._transcriptions ?? (this._transcriptions = new transcriptions_js_1.Transcriptions(this._options)); - } - }; - exports.Audio = Audio; - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js - var require_agentsapiv1agentsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsGetRequest$ = exports.AgentsApiV1AgentsGetRequest$outboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsGetRequestToJSON = agentsApiV1AgentsGetRequestToJSON; - exports.agentsApiV1AgentsGetRequestFromJSON = agentsApiV1AgentsGetRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsGetRequest$inboundSchema = z.object({ - agent_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsGetRequest$outboundSchema = z.object({ - agentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsGetRequest$; - (function(AgentsApiV1AgentsGetRequest$2) { - AgentsApiV1AgentsGetRequest$2.inboundSchema = exports.AgentsApiV1AgentsGetRequest$inboundSchema; - AgentsApiV1AgentsGetRequest$2.outboundSchema = exports.AgentsApiV1AgentsGetRequest$outboundSchema; - })(AgentsApiV1AgentsGetRequest$ || (exports.AgentsApiV1AgentsGetRequest$ = AgentsApiV1AgentsGetRequest$ = {})); - function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsGetRequest$outboundSchema.parse(agentsApiV1AgentsGetRequest)); - } - function agentsApiV1AgentsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsGetRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js - var require_agentsapiv1agentslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsListRequest$ = exports.AgentsApiV1AgentsListRequest$outboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsListRequestToJSON = agentsApiV1AgentsListRequestToJSON; - exports.agentsApiV1AgentsListRequestFromJSON = agentsApiV1AgentsListRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1AgentsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(20) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1AgentsListRequest$; - (function(AgentsApiV1AgentsListRequest$2) { - AgentsApiV1AgentsListRequest$2.inboundSchema = exports.AgentsApiV1AgentsListRequest$inboundSchema; - AgentsApiV1AgentsListRequest$2.outboundSchema = exports.AgentsApiV1AgentsListRequest$outboundSchema; - })(AgentsApiV1AgentsListRequest$ || (exports.AgentsApiV1AgentsListRequest$ = AgentsApiV1AgentsListRequest$ = {})); - function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsListRequest$outboundSchema.parse(agentsApiV1AgentsListRequest)); - } - function agentsApiV1AgentsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsListRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js - var require_agentsapiv1agentsupdate = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateRequest$ = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateRequestToJSON = agentsApiV1AgentsUpdateRequestToJSON; - exports.agentsApiV1AgentsUpdateRequestFromJSON = agentsApiV1AgentsUpdateRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1AgentsUpdateRequest$inboundSchema = z.object({ - agent_id: z.string(), - AgentUpdateRequest: components.AgentUpdateRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId", - "AgentUpdateRequest": "agentUpdateRequest" - }); - }); - exports.AgentsApiV1AgentsUpdateRequest$outboundSchema = z.object({ - agentId: z.string(), - agentUpdateRequest: components.AgentUpdateRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id", - agentUpdateRequest: "AgentUpdateRequest" - }); - }); - var AgentsApiV1AgentsUpdateRequest$; - (function(AgentsApiV1AgentsUpdateRequest$2) { - AgentsApiV1AgentsUpdateRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateRequest$inboundSchema; - AgentsApiV1AgentsUpdateRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateRequest$ || (exports.AgentsApiV1AgentsUpdateRequest$ = AgentsApiV1AgentsUpdateRequest$ = {})); - function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(agentsApiV1AgentsUpdateRequest)); - } - function agentsApiV1AgentsUpdateRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js - var require_agentsapiv1agentsupdateversion = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1agentsupdateversion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1AgentsUpdateVersionRequest$ = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = void 0; - exports.agentsApiV1AgentsUpdateVersionRequestToJSON = agentsApiV1AgentsUpdateVersionRequestToJSON; - exports.agentsApiV1AgentsUpdateVersionRequestFromJSON = agentsApiV1AgentsUpdateVersionRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema = z.object({ - agent_id: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "agent_id": "agentId" - }); - }); - exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema = z.object({ - agentId: z.string(), - version: z.number().int() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - agentId: "agent_id" - }); - }); - var AgentsApiV1AgentsUpdateVersionRequest$; - (function(AgentsApiV1AgentsUpdateVersionRequest$2) { - AgentsApiV1AgentsUpdateVersionRequest$2.inboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema; - AgentsApiV1AgentsUpdateVersionRequest$2.outboundSchema = exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema; - })(AgentsApiV1AgentsUpdateVersionRequest$ || (exports.AgentsApiV1AgentsUpdateVersionRequest$ = AgentsApiV1AgentsUpdateVersionRequest$ = {})); - function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest) { - return JSON.stringify(exports.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(agentsApiV1AgentsUpdateVersionRequest)); - } - function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1AgentsUpdateVersionRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1AgentsUpdateVersionRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js - var require_agentsapiv1conversationsappend = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendRequest$ = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendRequestToJSON = agentsApiV1ConversationsAppendRequestToJSON; - exports.agentsApiV1ConversationsAppendRequestFromJSON = agentsApiV1ConversationsAppendRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendRequest: components.ConversationAppendRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendRequest": "conversationAppendRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendRequest: components.ConversationAppendRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendRequest: "ConversationAppendRequest" - }); - }); - var AgentsApiV1ConversationsAppendRequest$; - (function(AgentsApiV1ConversationsAppendRequest$2) { - AgentsApiV1ConversationsAppendRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendRequest$inboundSchema; - AgentsApiV1ConversationsAppendRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendRequest$ || (exports.AgentsApiV1ConversationsAppendRequest$ = AgentsApiV1ConversationsAppendRequest$ = {})); - function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(agentsApiV1ConversationsAppendRequest)); - } - function agentsApiV1ConversationsAppendRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js - var require_agentsapiv1conversationsappendstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsappendstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsAppendStreamRequest$ = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsAppendStreamRequestToJSON = agentsApiV1ConversationsAppendStreamRequestToJSON; - exports.agentsApiV1ConversationsAppendStreamRequestFromJSON = agentsApiV1ConversationsAppendStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationAppendStreamRequest": "conversationAppendStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationAppendStreamRequest: components.ConversationAppendStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationAppendStreamRequest: "ConversationAppendStreamRequest" - }); - }); - var AgentsApiV1ConversationsAppendStreamRequest$; - (function(AgentsApiV1ConversationsAppendStreamRequest$2) { - AgentsApiV1ConversationsAppendStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema; - AgentsApiV1ConversationsAppendStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsAppendStreamRequest$ || (exports.AgentsApiV1ConversationsAppendStreamRequest$ = AgentsApiV1ConversationsAppendStreamRequest$ = {})); - function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(agentsApiV1ConversationsAppendStreamRequest)); - } - function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsAppendStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js - var require_agentsapiv1conversationsget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = exports.AgentsApiV1ConversationsGetRequest$ = exports.AgentsApiV1ConversationsGetRequest$outboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsGetRequestToJSON = agentsApiV1ConversationsGetRequestToJSON; - exports.agentsApiV1ConversationsGetRequestFromJSON = agentsApiV1ConversationsGetRequestFromJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON; - exports.agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON = agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsGetRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsGetRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsGetRequest$; - (function(AgentsApiV1ConversationsGetRequest$2) { - AgentsApiV1ConversationsGetRequest$2.inboundSchema = exports.AgentsApiV1ConversationsGetRequest$inboundSchema; - AgentsApiV1ConversationsGetRequest$2.outboundSchema = exports.AgentsApiV1ConversationsGetRequest$outboundSchema; - })(AgentsApiV1ConversationsGetRequest$ || (exports.AgentsApiV1ConversationsGetRequest$ = AgentsApiV1ConversationsGetRequest$ = {})); - function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(agentsApiV1ConversationsGetRequest)); - } - function agentsApiV1ConversationsGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetRequest' from JSON`); - } - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var AgentsApiV1ConversationsGetResponseV1ConversationsGet$; - (function(AgentsApiV1ConversationsGetResponseV1ConversationsGet$2) { - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.inboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema; - AgentsApiV1ConversationsGetResponseV1ConversationsGet$2.outboundSchema = exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema; - })(AgentsApiV1ConversationsGetResponseV1ConversationsGet$ || (exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = AgentsApiV1ConversationsGetResponseV1ConversationsGet$ = {})); - function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet) { - return JSON.stringify(exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema.parse(agentsApiV1ConversationsGetResponseV1ConversationsGet)); - } - function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsGetResponseV1ConversationsGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js - var require_agentsapiv1conversationshistory = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationshistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsHistoryRequest$ = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsHistoryRequestToJSON = agentsApiV1ConversationsHistoryRequestToJSON; - exports.agentsApiV1ConversationsHistoryRequestFromJSON = agentsApiV1ConversationsHistoryRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsHistoryRequest$; - (function(AgentsApiV1ConversationsHistoryRequest$2) { - AgentsApiV1ConversationsHistoryRequest$2.inboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema; - AgentsApiV1ConversationsHistoryRequest$2.outboundSchema = exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema; - })(AgentsApiV1ConversationsHistoryRequest$ || (exports.AgentsApiV1ConversationsHistoryRequest$ = AgentsApiV1ConversationsHistoryRequest$ = {})); - function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(agentsApiV1ConversationsHistoryRequest)); - } - function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsHistoryRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsHistoryRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js - var require_agentsapiv1conversationslist = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationslist.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ResponseBody$ = exports.ResponseBody$outboundSchema = exports.ResponseBody$inboundSchema = exports.AgentsApiV1ConversationsListRequest$ = exports.AgentsApiV1ConversationsListRequest$outboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsListRequestToJSON = agentsApiV1ConversationsListRequestToJSON; - exports.agentsApiV1ConversationsListRequestFromJSON = agentsApiV1ConversationsListRequestFromJSON; - exports.responseBodyToJSON = responseBodyToJSON; - exports.responseBodyFromJSON = responseBodyFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsListRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize" - }); - }); - exports.AgentsApiV1ConversationsListRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size" - }); - }); - var AgentsApiV1ConversationsListRequest$; - (function(AgentsApiV1ConversationsListRequest$2) { - AgentsApiV1ConversationsListRequest$2.inboundSchema = exports.AgentsApiV1ConversationsListRequest$inboundSchema; - AgentsApiV1ConversationsListRequest$2.outboundSchema = exports.AgentsApiV1ConversationsListRequest$outboundSchema; - })(AgentsApiV1ConversationsListRequest$ || (exports.AgentsApiV1ConversationsListRequest$ = AgentsApiV1ConversationsListRequest$ = {})); - function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsListRequest$outboundSchema.parse(agentsApiV1ConversationsListRequest)); - } - function agentsApiV1ConversationsListRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsListRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsListRequest' from JSON`); - } - exports.ResponseBody$inboundSchema = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema - ]); - exports.ResponseBody$outboundSchema = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema - ]); - var ResponseBody$; - (function(ResponseBody$2) { - ResponseBody$2.inboundSchema = exports.ResponseBody$inboundSchema; - ResponseBody$2.outboundSchema = exports.ResponseBody$outboundSchema; - })(ResponseBody$ || (exports.ResponseBody$ = ResponseBody$ = {})); - function responseBodyToJSON(responseBody) { - return JSON.stringify(exports.ResponseBody$outboundSchema.parse(responseBody)); - } - function responseBodyFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.ResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ResponseBody' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js - var require_agentsapiv1conversationsmessages = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsmessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsMessagesRequest$ = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsMessagesRequestToJSON = agentsApiV1ConversationsMessagesRequestToJSON; - exports.agentsApiV1ConversationsMessagesRequestFromJSON = agentsApiV1ConversationsMessagesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema = z.object({ - conversation_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId" - }); - }); - exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema = z.object({ - conversationId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id" - }); - }); - var AgentsApiV1ConversationsMessagesRequest$; - (function(AgentsApiV1ConversationsMessagesRequest$2) { - AgentsApiV1ConversationsMessagesRequest$2.inboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema; - AgentsApiV1ConversationsMessagesRequest$2.outboundSchema = exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema; - })(AgentsApiV1ConversationsMessagesRequest$ || (exports.AgentsApiV1ConversationsMessagesRequest$ = AgentsApiV1ConversationsMessagesRequest$ = {})); - function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(agentsApiV1ConversationsMessagesRequest)); - } - function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsMessagesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsMessagesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js - var require_agentsapiv1conversationsrestart = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartRequest$ = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartRequestToJSON = agentsApiV1ConversationsRestartRequestToJSON; - exports.agentsApiV1ConversationsRestartRequestFromJSON = agentsApiV1ConversationsRestartRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartRequest: components.ConversationRestartRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartRequest": "conversationRestartRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartRequest: components.ConversationRestartRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartRequest: "ConversationRestartRequest" - }); - }); - var AgentsApiV1ConversationsRestartRequest$; - (function(AgentsApiV1ConversationsRestartRequest$2) { - AgentsApiV1ConversationsRestartRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartRequest$inboundSchema; - AgentsApiV1ConversationsRestartRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartRequest$ || (exports.AgentsApiV1ConversationsRestartRequest$ = AgentsApiV1ConversationsRestartRequest$ = {})); - function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(agentsApiV1ConversationsRestartRequest)); - } - function agentsApiV1ConversationsRestartRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js - var require_agentsapiv1conversationsrestartstream = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/agentsapiv1conversationsrestartstream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.AgentsApiV1ConversationsRestartStreamRequest$ = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = void 0; - exports.agentsApiV1ConversationsRestartStreamRequestToJSON = agentsApiV1ConversationsRestartStreamRequestToJSON; - exports.agentsApiV1ConversationsRestartStreamRequestFromJSON = agentsApiV1ConversationsRestartStreamRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema = z.object({ - conversation_id: z.string(), - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "conversation_id": "conversationId", - "ConversationRestartStreamRequest": "conversationRestartStreamRequest" - }); - }); - exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema = z.object({ - conversationId: z.string(), - conversationRestartStreamRequest: components.ConversationRestartStreamRequest$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - conversationId: "conversation_id", - conversationRestartStreamRequest: "ConversationRestartStreamRequest" - }); - }); - var AgentsApiV1ConversationsRestartStreamRequest$; - (function(AgentsApiV1ConversationsRestartStreamRequest$2) { - AgentsApiV1ConversationsRestartStreamRequest$2.inboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema; - AgentsApiV1ConversationsRestartStreamRequest$2.outboundSchema = exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema; - })(AgentsApiV1ConversationsRestartStreamRequest$ || (exports.AgentsApiV1ConversationsRestartStreamRequest$ = AgentsApiV1ConversationsRestartStreamRequest$ = {})); - function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest) { - return JSON.stringify(exports.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(agentsApiV1ConversationsRestartStreamRequest)); - } - function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.AgentsApiV1ConversationsRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AgentsApiV1ConversationsRestartStreamRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js - var require_deletemodelv1modelsmodeliddelete = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/deletemodelv1modelsmodeliddelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$ = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = void 0; - exports.deleteModelV1ModelsModelIdDeleteRequestToJSON = deleteModelV1ModelsModelIdDeleteRequestToJSON; - exports.deleteModelV1ModelsModelIdDeleteRequestFromJSON = deleteModelV1ModelsModelIdDeleteRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var DeleteModelV1ModelsModelIdDeleteRequest$; - (function(DeleteModelV1ModelsModelIdDeleteRequest$2) { - DeleteModelV1ModelsModelIdDeleteRequest$2.inboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema; - DeleteModelV1ModelsModelIdDeleteRequest$2.outboundSchema = exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema; - })(DeleteModelV1ModelsModelIdDeleteRequest$ || (exports.DeleteModelV1ModelsModelIdDeleteRequest$ = DeleteModelV1ModelsModelIdDeleteRequest$ = {})); - function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest) { - return JSON.stringify(exports.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(deleteModelV1ModelsModelIdDeleteRequest)); - } - function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DeleteModelV1ModelsModelIdDeleteRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js - var require_filesapiroutesdeletefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdeletefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDeleteFileRequest$ = exports.FilesApiRoutesDeleteFileRequest$outboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDeleteFileRequestToJSON = filesApiRoutesDeleteFileRequestToJSON; - exports.filesApiRoutesDeleteFileRequestFromJSON = filesApiRoutesDeleteFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDeleteFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDeleteFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDeleteFileRequest$; - (function(FilesApiRoutesDeleteFileRequest$2) { - FilesApiRoutesDeleteFileRequest$2.inboundSchema = exports.FilesApiRoutesDeleteFileRequest$inboundSchema; - FilesApiRoutesDeleteFileRequest$2.outboundSchema = exports.FilesApiRoutesDeleteFileRequest$outboundSchema; - })(FilesApiRoutesDeleteFileRequest$ || (exports.FilesApiRoutesDeleteFileRequest$ = FilesApiRoutesDeleteFileRequest$ = {})); - function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(filesApiRoutesDeleteFileRequest)); - } - function filesApiRoutesDeleteFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDeleteFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDeleteFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js - var require_filesapiroutesdownloadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesdownloadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesDownloadFileRequest$ = exports.FilesApiRoutesDownloadFileRequest$outboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema = void 0; - exports.filesApiRoutesDownloadFileRequestToJSON = filesApiRoutesDownloadFileRequestToJSON; - exports.filesApiRoutesDownloadFileRequestFromJSON = filesApiRoutesDownloadFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesDownloadFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesDownloadFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesDownloadFileRequest$; - (function(FilesApiRoutesDownloadFileRequest$2) { - FilesApiRoutesDownloadFileRequest$2.inboundSchema = exports.FilesApiRoutesDownloadFileRequest$inboundSchema; - FilesApiRoutesDownloadFileRequest$2.outboundSchema = exports.FilesApiRoutesDownloadFileRequest$outboundSchema; - })(FilesApiRoutesDownloadFileRequest$ || (exports.FilesApiRoutesDownloadFileRequest$ = FilesApiRoutesDownloadFileRequest$ = {})); - function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest) { - return JSON.stringify(exports.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(filesApiRoutesDownloadFileRequest)); - } - function filesApiRoutesDownloadFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesDownloadFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesDownloadFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js - var require_filesapiroutesgetsignedurl = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesgetsignedurl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesGetSignedUrlRequest$ = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = void 0; - exports.filesApiRoutesGetSignedUrlRequestToJSON = filesApiRoutesGetSignedUrlRequestToJSON; - exports.filesApiRoutesGetSignedUrlRequestFromJSON = filesApiRoutesGetSignedUrlRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema = z.object({ - file_id: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema = z.object({ - fileId: z.string(), - expiry: z.number().int().default(24) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesGetSignedUrlRequest$; - (function(FilesApiRoutesGetSignedUrlRequest$2) { - FilesApiRoutesGetSignedUrlRequest$2.inboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema; - FilesApiRoutesGetSignedUrlRequest$2.outboundSchema = exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema; - })(FilesApiRoutesGetSignedUrlRequest$ || (exports.FilesApiRoutesGetSignedUrlRequest$ = FilesApiRoutesGetSignedUrlRequest$ = {})); - function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest) { - return JSON.stringify(exports.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(filesApiRoutesGetSignedUrlRequest)); - } - function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesGetSignedUrlRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesGetSignedUrlRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js - var require_filesapirouteslistfiles = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapirouteslistfiles.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesListFilesRequest$ = exports.FilesApiRoutesListFilesRequest$outboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema = void 0; - exports.filesApiRoutesListFilesRequestToJSON = filesApiRoutesListFilesRequestToJSON; - exports.filesApiRoutesListFilesRequestFromJSON = filesApiRoutesListFilesRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.FilesApiRoutesListFilesRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - sample_type: z.nullable(z.array(components.SampleType$inboundSchema)).optional(), - source: z.nullable(z.array(components.Source$inboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$inboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "sample_type": "sampleType" - }); - }); - exports.FilesApiRoutesListFilesRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - sampleType: z.nullable(z.array(components.SampleType$outboundSchema)).optional(), - source: z.nullable(z.array(components.Source$outboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$outboundSchema).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - sampleType: "sample_type" - }); - }); - var FilesApiRoutesListFilesRequest$; - (function(FilesApiRoutesListFilesRequest$2) { - FilesApiRoutesListFilesRequest$2.inboundSchema = exports.FilesApiRoutesListFilesRequest$inboundSchema; - FilesApiRoutesListFilesRequest$2.outboundSchema = exports.FilesApiRoutesListFilesRequest$outboundSchema; - })(FilesApiRoutesListFilesRequest$ || (exports.FilesApiRoutesListFilesRequest$ = FilesApiRoutesListFilesRequest$ = {})); - function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest) { - return JSON.stringify(exports.FilesApiRoutesListFilesRequest$outboundSchema.parse(filesApiRoutesListFilesRequest)); - } - function filesApiRoutesListFilesRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesListFilesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesListFilesRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js - var require_filesapiroutesretrievefile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesretrievefile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesRetrieveFileRequest$ = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = void 0; - exports.filesApiRoutesRetrieveFileRequestToJSON = filesApiRoutesRetrieveFileRequestToJSON; - exports.filesApiRoutesRetrieveFileRequestFromJSON = filesApiRoutesRetrieveFileRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.FilesApiRoutesRetrieveFileRequest$inboundSchema = z.object({ - file_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "file_id": "fileId" - }); - }); - exports.FilesApiRoutesRetrieveFileRequest$outboundSchema = z.object({ - fileId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - fileId: "file_id" - }); - }); - var FilesApiRoutesRetrieveFileRequest$; - (function(FilesApiRoutesRetrieveFileRequest$2) { - FilesApiRoutesRetrieveFileRequest$2.inboundSchema = exports.FilesApiRoutesRetrieveFileRequest$inboundSchema; - FilesApiRoutesRetrieveFileRequest$2.outboundSchema = exports.FilesApiRoutesRetrieveFileRequest$outboundSchema; - })(FilesApiRoutesRetrieveFileRequest$ || (exports.FilesApiRoutesRetrieveFileRequest$ = FilesApiRoutesRetrieveFileRequest$ = {})); - function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest) { - return JSON.stringify(exports.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(filesApiRoutesRetrieveFileRequest)); - } - function filesApiRoutesRetrieveFileRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesRetrieveFileRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesRetrieveFileRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js - var require_filesapiroutesuploadfile = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/filesapiroutesuploadfile.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = void 0; - exports.filesApiRoutesUploadFileMultiPartBodyParamsToJSON = filesApiRoutesUploadFileMultiPartBodyParamsToJSON; - exports.filesApiRoutesUploadFileMultiPartBodyParamsFromJSON = filesApiRoutesUploadFileMultiPartBodyParamsFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema = z.object({ - purpose: components.FilePurpose$inboundSchema.optional(), - file: components.FileT$inboundSchema - }); - exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema = z.object({ - purpose: components.FilePurpose$outboundSchema.optional(), - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var FilesApiRoutesUploadFileMultiPartBodyParams$; - (function(FilesApiRoutesUploadFileMultiPartBodyParams$2) { - FilesApiRoutesUploadFileMultiPartBodyParams$2.inboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema; - FilesApiRoutesUploadFileMultiPartBodyParams$2.outboundSchema = exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema; - })(FilesApiRoutesUploadFileMultiPartBodyParams$ || (exports.FilesApiRoutesUploadFileMultiPartBodyParams$ = FilesApiRoutesUploadFileMultiPartBodyParams$ = {})); - function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams) { - return JSON.stringify(exports.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(filesApiRoutesUploadFileMultiPartBodyParams)); - } - function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'FilesApiRoutesUploadFileMultiPartBodyParams' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js - var require_jobsapiroutesbatchcancelbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchcancelbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$ = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchCancelBatchJobRequestToJSON = jobsApiRoutesBatchCancelBatchJobRequestToJSON; - exports.jobsApiRoutesBatchCancelBatchJobRequestFromJSON = jobsApiRoutesBatchCancelBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchCancelBatchJobRequest$; - (function(JobsApiRoutesBatchCancelBatchJobRequest$2) { - JobsApiRoutesBatchCancelBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema; - JobsApiRoutesBatchCancelBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchCancelBatchJobRequest$ || (exports.JobsApiRoutesBatchCancelBatchJobRequest$ = JobsApiRoutesBatchCancelBatchJobRequest$ = {})); - function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchCancelBatchJobRequest)); - } - function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchCancelBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js - var require_jobsapiroutesbatchgetbatchjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobRequest$ = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobRequestToJSON = jobsApiRoutesBatchGetBatchJobRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobRequestFromJSON = jobsApiRoutesBatchGetBatchJobRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesBatchGetBatchJobRequest$; - (function(JobsApiRoutesBatchGetBatchJobRequest$2) { - JobsApiRoutesBatchGetBatchJobRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobRequest$ || (exports.JobsApiRoutesBatchGetBatchJobRequest$ = JobsApiRoutesBatchGetBatchJobRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobRequest)); - } - function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js - var require_jobsapiroutesbatchgetbatchjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesbatchgetbatchjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$ = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = void 0; - exports.jobsApiRoutesBatchGetBatchJobsRequestToJSON = jobsApiRoutesBatchGetBatchJobsRequestToJSON; - exports.jobsApiRoutesBatchGetBatchJobsRequestFromJSON = jobsApiRoutesBatchGetBatchJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$inboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "agent_id": "agentId", - "created_after": "createdAfter", - "created_by_me": "createdByMe" - }); - }); - exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$outboundSchema)).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - agentId: "agent_id", - createdAfter: "created_after", - createdByMe: "created_by_me" - }); - }); - var JobsApiRoutesBatchGetBatchJobsRequest$; - (function(JobsApiRoutesBatchGetBatchJobsRequest$2) { - JobsApiRoutesBatchGetBatchJobsRequest$2.inboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema; - JobsApiRoutesBatchGetBatchJobsRequest$2.outboundSchema = exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema; - })(JobsApiRoutesBatchGetBatchJobsRequest$ || (exports.JobsApiRoutesBatchGetBatchJobsRequest$ = JobsApiRoutesBatchGetBatchJobsRequest$ = {})); - function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.parse(jobsApiRoutesBatchGetBatchJobsRequest)); - } - function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesBatchGetBatchJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningArchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningArchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningArchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js - var require_jobsapiroutesfinetuningcancelfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningCancelFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobRequest$2) { - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = JobsApiRoutesFineTuningCancelFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningCancelFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCancelFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCancelFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCancelFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = JobsApiRoutesFineTuningCancelFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCancelFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js - var require_jobsapiroutesfinetuningcreatefinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = exports.One$ = exports.One$outboundSchema = exports.One$inboundSchema = void 0; - exports.oneToJSON = oneToJSON; - exports.oneFromJSON = oneFromJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.One$inboundSchema = z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.One$outboundSchema = z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var One$; - (function(One$2) { - One$2.inboundSchema = exports.One$inboundSchema; - One$2.outboundSchema = exports.One$outboundSchema; - })(One$ || (exports.One$ = One$ = {})); - function oneToJSON(one) { - return JSON.stringify(exports.One$outboundSchema.parse(one)); - } - function oneFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`); - } - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema = z.union([ - components.LegacyJobMetadataOut$inboundSchema, - z.union([ - components.ClassifierJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]) - ]); - exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema = z.union([ - components.LegacyJobMetadataOut$outboundSchema, - z.union([ - components.ClassifierJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]) - ]); - var JobsApiRoutesFineTuningCreateFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningCreateFineTuningJobResponse$2) { - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningCreateFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningCreateFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = JobsApiRoutesFineTuningCreateFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningCreateFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningCreateFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js - var require_jobsapiroutesfinetuninggetfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$ = JobsApiRoutesFineTuningGetFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningGetFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningGetFineTuningJobResponse$2) { - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$ = JobsApiRoutesFineTuningGetFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js - var require_jobsapiroutesfinetuninggetfinetuningjobs = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = exports.Status$ = exports.Status$outboundSchema = exports.Status$inboundSchema = exports.Status = void 0; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON; - exports.jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON = jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED" - }; - exports.Status$inboundSchema = z.nativeEnum(exports.Status); - exports.Status$outboundSchema = exports.Status$inboundSchema; - var Status$; - (function(Status$2) { - Status$2.inboundSchema = exports.Status$inboundSchema; - Status$2.outboundSchema = exports.Status$outboundSchema; - })(Status$ || (exports.Status$ = Status$ = {})); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - created_after: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_before: z.nullable(z.string().datetime({ offset: true }).transform((v) => new Date(v))).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(exports.Status$inboundSchema).optional(), - wandb_project: z.nullable(z.string()).optional(), - wandb_name: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "page_size": "pageSize", - "created_after": "createdAfter", - "created_before": "createdBefore", - "created_by_me": "createdByMe", - "wandb_project": "wandbProject", - "wandb_name": "wandbName" - }); - }); - exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - createdAfter: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdBefore: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(exports.Status$outboundSchema).optional(), - wandbProject: z.nullable(z.string()).optional(), - wandbName: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - pageSize: "page_size", - createdAfter: "created_after", - createdBefore: "created_before", - createdByMe: "created_by_me", - wandbProject: "wandb_project", - wandbName: "wandb_name" - }); - }); - var JobsApiRoutesFineTuningGetFineTuningJobsRequest$; - (function(JobsApiRoutesFineTuningGetFineTuningJobsRequest$2) { - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema; - JobsApiRoutesFineTuningGetFineTuningJobsRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema; - })(JobsApiRoutesFineTuningGetFineTuningJobsRequest$ || (exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = JobsApiRoutesFineTuningGetFineTuningJobsRequest$ = {})); - function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.parse(jobsApiRoutesFineTuningGetFineTuningJobsRequest)); - } - function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobsRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js - var require_jobsapiroutesfinetuningstartfinetuningjob = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningstartfinetuningjob.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON = jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON; - exports.jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON = jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema = z.object({ - job_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "job_id": "jobId" - }); - }); - exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema = z.object({ - jobId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - jobId: "job_id" - }); - }); - var JobsApiRoutesFineTuningStartFineTuningJobRequest$; - (function(JobsApiRoutesFineTuningStartFineTuningJobRequest$2) { - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobRequest$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$ = JobsApiRoutesFineTuningStartFineTuningJobRequest$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobRequest)); - } - function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type - }))), - components.CompletionDetailedJobOut$inboundSchema.and(z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type - }))) - ]); - exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType - }))), - components.CompletionDetailedJobOut$outboundSchema.and(z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType - }))) - ]); - var JobsApiRoutesFineTuningStartFineTuningJobResponse$; - (function(JobsApiRoutesFineTuningStartFineTuningJobResponse$2) { - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema; - JobsApiRoutesFineTuningStartFineTuningJobResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema; - })(JobsApiRoutesFineTuningStartFineTuningJobResponse$ || (exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$ = JobsApiRoutesFineTuningStartFineTuningJobResponse$ = {})); - function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema.parse(jobsApiRoutesFineTuningStartFineTuningJobResponse)); - } - function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js - var require_jobsapiroutesfinetuningunarchivefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js - var require_jobsapiroutesfinetuningupdatefinetunedmodel = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = void 0; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON; - exports.jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON = jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema = z.object({ - model_id: z.string(), - UpdateFTModelIn: components.UpdateFTModelIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId", - "UpdateFTModelIn": "updateFTModelIn" - }); - }); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema = z.object({ - modelId: z.string(), - updateFTModelIn: components.UpdateFTModelIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id", - updateFTModelIn: "UpdateFTModelIn" - }); - }); - var JobsApiRoutesFineTuningUpdateFineTunedModelRequest$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelRequest)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelRequest' from JSON`); - } - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema = z.union([ - components.ClassifierFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("classifier") }).transform((v) => ({ - modelType: v.model_type - }))), - components.CompletionFTModelOut$inboundSchema.and(z.object({ model_type: z.literal("completion") }).transform((v) => ({ - modelType: v.model_type - }))) - ]); - exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema = z.union([ - components.ClassifierFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("classifier") }).transform((v) => ({ - model_type: v.modelType - }))), - components.CompletionFTModelOut$outboundSchema.and(z.object({ modelType: z.literal("completion") }).transform((v) => ({ - model_type: v.modelType - }))) - ]); - var JobsApiRoutesFineTuningUpdateFineTunedModelResponse$; - (function(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2) { - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.inboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema; - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$2.outboundSchema = exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema; - })(JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ || (exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ = {})); - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse) { - return JSON.stringify(exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema.parse(jobsApiRoutesFineTuningUpdateFineTunedModelResponse)); - } - function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelResponse' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js - var require_librariesdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDeleteV1Request$ = exports.LibrariesDeleteV1Request$outboundSchema = exports.LibrariesDeleteV1Request$inboundSchema = void 0; - exports.librariesDeleteV1RequestToJSON = librariesDeleteV1RequestToJSON; - exports.librariesDeleteV1RequestFromJSON = librariesDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDeleteV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesDeleteV1Request$; - (function(LibrariesDeleteV1Request$2) { - LibrariesDeleteV1Request$2.inboundSchema = exports.LibrariesDeleteV1Request$inboundSchema; - LibrariesDeleteV1Request$2.outboundSchema = exports.LibrariesDeleteV1Request$outboundSchema; - })(LibrariesDeleteV1Request$ || (exports.LibrariesDeleteV1Request$ = LibrariesDeleteV1Request$ = {})); - function librariesDeleteV1RequestToJSON(librariesDeleteV1Request) { - return JSON.stringify(exports.LibrariesDeleteV1Request$outboundSchema.parse(librariesDeleteV1Request)); - } - function librariesDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js - var require_librariesdocumentsdeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsdeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsDeleteV1Request$ = exports.LibrariesDocumentsDeleteV1Request$outboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema = void 0; - exports.librariesDocumentsDeleteV1RequestToJSON = librariesDocumentsDeleteV1RequestToJSON; - exports.librariesDocumentsDeleteV1RequestFromJSON = librariesDocumentsDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsDeleteV1Request$; - (function(LibrariesDocumentsDeleteV1Request$2) { - LibrariesDocumentsDeleteV1Request$2.inboundSchema = exports.LibrariesDocumentsDeleteV1Request$inboundSchema; - LibrariesDocumentsDeleteV1Request$2.outboundSchema = exports.LibrariesDocumentsDeleteV1Request$outboundSchema; - })(LibrariesDocumentsDeleteV1Request$ || (exports.LibrariesDocumentsDeleteV1Request$ = LibrariesDocumentsDeleteV1Request$ = {})); - function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request) { - return JSON.stringify(exports.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(librariesDocumentsDeleteV1Request)); - } - function librariesDocumentsDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js - var require_librariesdocumentsgetextractedtextsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetextractedtextsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON = librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetExtractedTextSignedUrlV1Request$; - (function(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2) { - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ || (exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ = {})); - function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetExtractedTextSignedUrlV1Request)); - } - function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetExtractedTextSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js - var require_librariesdocumentsgetsignedurlv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetsignedurlv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetSignedUrlV1Request$ = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetSignedUrlV1RequestToJSON = librariesDocumentsGetSignedUrlV1RequestToJSON; - exports.librariesDocumentsGetSignedUrlV1RequestFromJSON = librariesDocumentsGetSignedUrlV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetSignedUrlV1Request$; - (function(LibrariesDocumentsGetSignedUrlV1Request$2) { - LibrariesDocumentsGetSignedUrlV1Request$2.inboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema; - LibrariesDocumentsGetSignedUrlV1Request$2.outboundSchema = exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema; - })(LibrariesDocumentsGetSignedUrlV1Request$ || (exports.LibrariesDocumentsGetSignedUrlV1Request$ = LibrariesDocumentsGetSignedUrlV1Request$ = {})); - function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(librariesDocumentsGetSignedUrlV1Request)); - } - function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetSignedUrlV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetSignedUrlV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js - var require_librariesdocumentsgetstatusv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetstatusv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetStatusV1Request$ = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetStatusV1RequestToJSON = librariesDocumentsGetStatusV1RequestToJSON; - exports.librariesDocumentsGetStatusV1RequestFromJSON = librariesDocumentsGetStatusV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetStatusV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetStatusV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetStatusV1Request$; - (function(LibrariesDocumentsGetStatusV1Request$2) { - LibrariesDocumentsGetStatusV1Request$2.inboundSchema = exports.LibrariesDocumentsGetStatusV1Request$inboundSchema; - LibrariesDocumentsGetStatusV1Request$2.outboundSchema = exports.LibrariesDocumentsGetStatusV1Request$outboundSchema; - })(LibrariesDocumentsGetStatusV1Request$ || (exports.LibrariesDocumentsGetStatusV1Request$ = LibrariesDocumentsGetStatusV1Request$ = {})); - function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(librariesDocumentsGetStatusV1Request)); - } - function librariesDocumentsGetStatusV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetStatusV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetStatusV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js - var require_librariesdocumentsgettextcontentv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgettextcontentv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetTextContentV1Request$ = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetTextContentV1RequestToJSON = librariesDocumentsGetTextContentV1RequestToJSON; - exports.librariesDocumentsGetTextContentV1RequestFromJSON = librariesDocumentsGetTextContentV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetTextContentV1Request$; - (function(LibrariesDocumentsGetTextContentV1Request$2) { - LibrariesDocumentsGetTextContentV1Request$2.inboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema; - LibrariesDocumentsGetTextContentV1Request$2.outboundSchema = exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema; - })(LibrariesDocumentsGetTextContentV1Request$ || (exports.LibrariesDocumentsGetTextContentV1Request$ = LibrariesDocumentsGetTextContentV1Request$ = {})); - function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(librariesDocumentsGetTextContentV1Request)); - } - function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetTextContentV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetTextContentV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js - var require_librariesdocumentsgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsGetV1Request$ = exports.LibrariesDocumentsGetV1Request$outboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema = void 0; - exports.librariesDocumentsGetV1RequestToJSON = librariesDocumentsGetV1RequestToJSON; - exports.librariesDocumentsGetV1RequestFromJSON = librariesDocumentsGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsGetV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsGetV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsGetV1Request$; - (function(LibrariesDocumentsGetV1Request$2) { - LibrariesDocumentsGetV1Request$2.inboundSchema = exports.LibrariesDocumentsGetV1Request$inboundSchema; - LibrariesDocumentsGetV1Request$2.outboundSchema = exports.LibrariesDocumentsGetV1Request$outboundSchema; - })(LibrariesDocumentsGetV1Request$ || (exports.LibrariesDocumentsGetV1Request$ = LibrariesDocumentsGetV1Request$ = {})); - function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request) { - return JSON.stringify(exports.LibrariesDocumentsGetV1Request$outboundSchema.parse(librariesDocumentsGetV1Request)); - } - function librariesDocumentsGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js - var require_librariesdocumentslistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentslistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsListV1Request$ = exports.LibrariesDocumentsListV1Request$outboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema = void 0; - exports.librariesDocumentsListV1RequestToJSON = librariesDocumentsListV1RequestToJSON; - exports.librariesDocumentsListV1RequestFromJSON = librariesDocumentsListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsListV1Request$inboundSchema = z.object({ - library_id: z.string(), - search: z.nullable(z.string()).optional(), - page_size: z.number().int().default(100), - page: z.number().int().default(0), - sort_by: z.string().default("created_at"), - sort_order: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "page_size": "pageSize", - "sort_by": "sortBy", - "sort_order": "sortOrder" - }); - }); - exports.LibrariesDocumentsListV1Request$outboundSchema = z.object({ - libraryId: z.string(), - search: z.nullable(z.string()).optional(), - pageSize: z.number().int().default(100), - page: z.number().int().default(0), - sortBy: z.string().default("created_at"), - sortOrder: z.string().default("desc") - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - pageSize: "page_size", - sortBy: "sort_by", - sortOrder: "sort_order" - }); - }); - var LibrariesDocumentsListV1Request$; - (function(LibrariesDocumentsListV1Request$2) { - LibrariesDocumentsListV1Request$2.inboundSchema = exports.LibrariesDocumentsListV1Request$inboundSchema; - LibrariesDocumentsListV1Request$2.outboundSchema = exports.LibrariesDocumentsListV1Request$outboundSchema; - })(LibrariesDocumentsListV1Request$ || (exports.LibrariesDocumentsListV1Request$ = LibrariesDocumentsListV1Request$ = {})); - function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request) { - return JSON.stringify(exports.LibrariesDocumentsListV1Request$outboundSchema.parse(librariesDocumentsListV1Request)); - } - function librariesDocumentsListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js - var require_librariesdocumentsreprocessv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsreprocessv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsReprocessV1Request$ = exports.LibrariesDocumentsReprocessV1Request$outboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema = void 0; - exports.librariesDocumentsReprocessV1RequestToJSON = librariesDocumentsReprocessV1RequestToJSON; - exports.librariesDocumentsReprocessV1RequestFromJSON = librariesDocumentsReprocessV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesDocumentsReprocessV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId" - }); - }); - exports.LibrariesDocumentsReprocessV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id" - }); - }); - var LibrariesDocumentsReprocessV1Request$; - (function(LibrariesDocumentsReprocessV1Request$2) { - LibrariesDocumentsReprocessV1Request$2.inboundSchema = exports.LibrariesDocumentsReprocessV1Request$inboundSchema; - LibrariesDocumentsReprocessV1Request$2.outboundSchema = exports.LibrariesDocumentsReprocessV1Request$outboundSchema; - })(LibrariesDocumentsReprocessV1Request$ || (exports.LibrariesDocumentsReprocessV1Request$ = LibrariesDocumentsReprocessV1Request$ = {})); - function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request) { - return JSON.stringify(exports.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(librariesDocumentsReprocessV1Request)); - } - function librariesDocumentsReprocessV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsReprocessV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsReprocessV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js - var require_librariesdocumentsupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUpdateV1Request$ = exports.LibrariesDocumentsUpdateV1Request$outboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema = void 0; - exports.librariesDocumentsUpdateV1RequestToJSON = librariesDocumentsUpdateV1RequestToJSON; - exports.librariesDocumentsUpdateV1RequestFromJSON = librariesDocumentsUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - document_id: z.string(), - DocumentUpdateIn: components.DocumentUpdateIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "document_id": "documentId", - "DocumentUpdateIn": "documentUpdateIn" - }); - }); - exports.LibrariesDocumentsUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - documentId: z.string(), - documentUpdateIn: components.DocumentUpdateIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - documentId: "document_id", - documentUpdateIn: "DocumentUpdateIn" - }); - }); - var LibrariesDocumentsUpdateV1Request$; - (function(LibrariesDocumentsUpdateV1Request$2) { - LibrariesDocumentsUpdateV1Request$2.inboundSchema = exports.LibrariesDocumentsUpdateV1Request$inboundSchema; - LibrariesDocumentsUpdateV1Request$2.outboundSchema = exports.LibrariesDocumentsUpdateV1Request$outboundSchema; - })(LibrariesDocumentsUpdateV1Request$ || (exports.LibrariesDocumentsUpdateV1Request$ = LibrariesDocumentsUpdateV1Request$ = {})); - function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(librariesDocumentsUpdateV1Request)); - } - function librariesDocumentsUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js - var require_librariesdocumentsuploadv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesdocumentsuploadv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesDocumentsUploadV1Request$ = exports.LibrariesDocumentsUploadV1Request$outboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$ = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = void 0; - exports.librariesDocumentsUploadV1DocumentUploadToJSON = librariesDocumentsUploadV1DocumentUploadToJSON; - exports.librariesDocumentsUploadV1DocumentUploadFromJSON = librariesDocumentsUploadV1DocumentUploadFromJSON; - exports.librariesDocumentsUploadV1RequestToJSON = librariesDocumentsUploadV1RequestToJSON; - exports.librariesDocumentsUploadV1RequestFromJSON = librariesDocumentsUploadV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var blobs_js_1 = require_blobs(); - var components = __importStar(require_components()); - exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema = z.object({ - file: components.FileT$inboundSchema - }); - exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema = z.object({ - file: components.FileT$outboundSchema.or(blobs_js_1.blobLikeSchema) - }); - var LibrariesDocumentsUploadV1DocumentUpload$; - (function(LibrariesDocumentsUploadV1DocumentUpload$2) { - LibrariesDocumentsUploadV1DocumentUpload$2.inboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema; - LibrariesDocumentsUploadV1DocumentUpload$2.outboundSchema = exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema; - })(LibrariesDocumentsUploadV1DocumentUpload$ || (exports.LibrariesDocumentsUploadV1DocumentUpload$ = LibrariesDocumentsUploadV1DocumentUpload$ = {})); - function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema.parse(librariesDocumentsUploadV1DocumentUpload)); - } - function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1DocumentUpload' from JSON`); - } - exports.LibrariesDocumentsUploadV1Request$inboundSchema = z.object({ - library_id: z.string(), - RequestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$inboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "RequestBody": "requestBody" - }); - }); - exports.LibrariesDocumentsUploadV1Request$outboundSchema = z.object({ - libraryId: z.string(), - requestBody: z.lazy(() => exports.LibrariesDocumentsUploadV1DocumentUpload$outboundSchema) - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - requestBody: "RequestBody" - }); - }); - var LibrariesDocumentsUploadV1Request$; - (function(LibrariesDocumentsUploadV1Request$2) { - LibrariesDocumentsUploadV1Request$2.inboundSchema = exports.LibrariesDocumentsUploadV1Request$inboundSchema; - LibrariesDocumentsUploadV1Request$2.outboundSchema = exports.LibrariesDocumentsUploadV1Request$outboundSchema; - })(LibrariesDocumentsUploadV1Request$ || (exports.LibrariesDocumentsUploadV1Request$ = LibrariesDocumentsUploadV1Request$ = {})); - function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request) { - return JSON.stringify(exports.LibrariesDocumentsUploadV1Request$outboundSchema.parse(librariesDocumentsUploadV1Request)); - } - function librariesDocumentsUploadV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesDocumentsUploadV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesDocumentsUploadV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js - var require_librariesgetv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesgetv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesGetV1Request$ = exports.LibrariesGetV1Request$outboundSchema = exports.LibrariesGetV1Request$inboundSchema = void 0; - exports.librariesGetV1RequestToJSON = librariesGetV1RequestToJSON; - exports.librariesGetV1RequestFromJSON = librariesGetV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesGetV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesGetV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesGetV1Request$; - (function(LibrariesGetV1Request$2) { - LibrariesGetV1Request$2.inboundSchema = exports.LibrariesGetV1Request$inboundSchema; - LibrariesGetV1Request$2.outboundSchema = exports.LibrariesGetV1Request$outboundSchema; - })(LibrariesGetV1Request$ || (exports.LibrariesGetV1Request$ = LibrariesGetV1Request$ = {})); - function librariesGetV1RequestToJSON(librariesGetV1Request) { - return JSON.stringify(exports.LibrariesGetV1Request$outboundSchema.parse(librariesGetV1Request)); - } - function librariesGetV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesGetV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesGetV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js - var require_librariessharecreatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharecreatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareCreateV1Request$ = exports.LibrariesShareCreateV1Request$outboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema = void 0; - exports.librariesShareCreateV1RequestToJSON = librariesShareCreateV1RequestToJSON; - exports.librariesShareCreateV1RequestFromJSON = librariesShareCreateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareCreateV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingIn: components.SharingIn$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingIn": "sharingIn" - }); - }); - exports.LibrariesShareCreateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingIn: components.SharingIn$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingIn: "SharingIn" - }); - }); - var LibrariesShareCreateV1Request$; - (function(LibrariesShareCreateV1Request$2) { - LibrariesShareCreateV1Request$2.inboundSchema = exports.LibrariesShareCreateV1Request$inboundSchema; - LibrariesShareCreateV1Request$2.outboundSchema = exports.LibrariesShareCreateV1Request$outboundSchema; - })(LibrariesShareCreateV1Request$ || (exports.LibrariesShareCreateV1Request$ = LibrariesShareCreateV1Request$ = {})); - function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request) { - return JSON.stringify(exports.LibrariesShareCreateV1Request$outboundSchema.parse(librariesShareCreateV1Request)); - } - function librariesShareCreateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareCreateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareCreateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js - var require_librariessharedeletev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharedeletev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareDeleteV1Request$ = exports.LibrariesShareDeleteV1Request$outboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema = void 0; - exports.librariesShareDeleteV1RequestToJSON = librariesShareDeleteV1RequestToJSON; - exports.librariesShareDeleteV1RequestFromJSON = librariesShareDeleteV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesShareDeleteV1Request$inboundSchema = z.object({ - library_id: z.string(), - SharingDelete: components.SharingDelete$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "SharingDelete": "sharingDelete" - }); - }); - exports.LibrariesShareDeleteV1Request$outboundSchema = z.object({ - libraryId: z.string(), - sharingDelete: components.SharingDelete$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - sharingDelete: "SharingDelete" - }); - }); - var LibrariesShareDeleteV1Request$; - (function(LibrariesShareDeleteV1Request$2) { - LibrariesShareDeleteV1Request$2.inboundSchema = exports.LibrariesShareDeleteV1Request$inboundSchema; - LibrariesShareDeleteV1Request$2.outboundSchema = exports.LibrariesShareDeleteV1Request$outboundSchema; - })(LibrariesShareDeleteV1Request$ || (exports.LibrariesShareDeleteV1Request$ = LibrariesShareDeleteV1Request$ = {})); - function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request) { - return JSON.stringify(exports.LibrariesShareDeleteV1Request$outboundSchema.parse(librariesShareDeleteV1Request)); - } - function librariesShareDeleteV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareDeleteV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareDeleteV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js - var require_librariessharelistv1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariessharelistv1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesShareListV1Request$ = exports.LibrariesShareListV1Request$outboundSchema = exports.LibrariesShareListV1Request$inboundSchema = void 0; - exports.librariesShareListV1RequestToJSON = librariesShareListV1RequestToJSON; - exports.librariesShareListV1RequestFromJSON = librariesShareListV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - exports.LibrariesShareListV1Request$inboundSchema = z.object({ - library_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId" - }); - }); - exports.LibrariesShareListV1Request$outboundSchema = z.object({ - libraryId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id" - }); - }); - var LibrariesShareListV1Request$; - (function(LibrariesShareListV1Request$2) { - LibrariesShareListV1Request$2.inboundSchema = exports.LibrariesShareListV1Request$inboundSchema; - LibrariesShareListV1Request$2.outboundSchema = exports.LibrariesShareListV1Request$outboundSchema; - })(LibrariesShareListV1Request$ || (exports.LibrariesShareListV1Request$ = LibrariesShareListV1Request$ = {})); - function librariesShareListV1RequestToJSON(librariesShareListV1Request) { - return JSON.stringify(exports.LibrariesShareListV1Request$outboundSchema.parse(librariesShareListV1Request)); - } - function librariesShareListV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesShareListV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesShareListV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js - var require_librariesupdatev1 = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/librariesupdatev1.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.LibrariesUpdateV1Request$ = exports.LibrariesUpdateV1Request$outboundSchema = exports.LibrariesUpdateV1Request$inboundSchema = void 0; - exports.librariesUpdateV1RequestToJSON = librariesUpdateV1RequestToJSON; - exports.librariesUpdateV1RequestFromJSON = librariesUpdateV1RequestFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.LibrariesUpdateV1Request$inboundSchema = z.object({ - library_id: z.string(), - LibraryInUpdate: components.LibraryInUpdate$inboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "library_id": "libraryId", - "LibraryInUpdate": "libraryInUpdate" - }); - }); - exports.LibrariesUpdateV1Request$outboundSchema = z.object({ - libraryId: z.string(), - libraryInUpdate: components.LibraryInUpdate$outboundSchema - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - libraryId: "library_id", - libraryInUpdate: "LibraryInUpdate" - }); - }); - var LibrariesUpdateV1Request$; - (function(LibrariesUpdateV1Request$2) { - LibrariesUpdateV1Request$2.inboundSchema = exports.LibrariesUpdateV1Request$inboundSchema; - LibrariesUpdateV1Request$2.outboundSchema = exports.LibrariesUpdateV1Request$outboundSchema; - })(LibrariesUpdateV1Request$ || (exports.LibrariesUpdateV1Request$ = LibrariesUpdateV1Request$ = {})); - function librariesUpdateV1RequestToJSON(librariesUpdateV1Request) { - return JSON.stringify(exports.LibrariesUpdateV1Request$outboundSchema.parse(librariesUpdateV1Request)); - } - function librariesUpdateV1RequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.LibrariesUpdateV1Request$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'LibrariesUpdateV1Request' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js - var require_retrievemodelv1modelsmodelidget = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/retrievemodelv1modelsmodelidget.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$ = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = void 0; - exports.retrieveModelV1ModelsModelIdGetRequestToJSON = retrieveModelV1ModelsModelIdGetRequestToJSON; - exports.retrieveModelV1ModelsModelIdGetRequestFromJSON = retrieveModelV1ModelsModelIdGetRequestFromJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON; - exports.retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON = retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON; - var z = __importStar(require_zod()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var components = __importStar(require_components()); - exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema = z.object({ - model_id: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - "model_id": "modelId" - }); - }); - exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema = z.object({ - modelId: z.string() - }).transform((v) => { - return (0, primitives_js_1.remap)(v, { - modelId: "model_id" - }); - }); - var RetrieveModelV1ModelsModelIdGetRequest$; - (function(RetrieveModelV1ModelsModelIdGetRequest$2) { - RetrieveModelV1ModelsModelIdGetRequest$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema; - RetrieveModelV1ModelsModelIdGetRequest$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetRequest$ || (exports.RetrieveModelV1ModelsModelIdGetRequest$ = RetrieveModelV1ModelsModelIdGetRequest$ = {})); - function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(retrieveModelV1ModelsModelIdGetRequest)); - } - function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetRequest' from JSON`); - } - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema = z.union([ - components.FTModelCard$inboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$inboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema = z.union([ - components.FTModelCard$outboundSchema.and(z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type - }))), - components.BaseModelCard$outboundSchema.and(z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type - }))) - ]); - var RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$; - (function(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2) { - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.inboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema; - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$2.outboundSchema = exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema; - })(RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ || (exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ = {})); - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet) { - return JSON.stringify(exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema.parse(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet)); - } - function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString) { - return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet' from JSON`); - } - } - }); - - // node_modules/@mistralai/mistralai/models/operations/index.js - var require_operations = __commonJS({ - "node_modules/@mistralai/mistralai/models/operations/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_agentsapiv1agentsget(), exports); - __exportStar(require_agentsapiv1agentslist(), exports); - __exportStar(require_agentsapiv1agentsupdate(), exports); - __exportStar(require_agentsapiv1agentsupdateversion(), exports); - __exportStar(require_agentsapiv1conversationsappend(), exports); - __exportStar(require_agentsapiv1conversationsappendstream(), exports); - __exportStar(require_agentsapiv1conversationsget(), exports); - __exportStar(require_agentsapiv1conversationshistory(), exports); - __exportStar(require_agentsapiv1conversationslist(), exports); - __exportStar(require_agentsapiv1conversationsmessages(), exports); - __exportStar(require_agentsapiv1conversationsrestart(), exports); - __exportStar(require_agentsapiv1conversationsrestartstream(), exports); - __exportStar(require_deletemodelv1modelsmodeliddelete(), exports); - __exportStar(require_filesapiroutesdeletefile(), exports); - __exportStar(require_filesapiroutesdownloadfile(), exports); - __exportStar(require_filesapiroutesgetsignedurl(), exports); - __exportStar(require_filesapirouteslistfiles(), exports); - __exportStar(require_filesapiroutesretrievefile(), exports); - __exportStar(require_filesapiroutesuploadfile(), exports); - __exportStar(require_jobsapiroutesbatchcancelbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjob(), exports); - __exportStar(require_jobsapiroutesbatchgetbatchjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningcancelfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningcreatefinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuninggetfinetuningjobs(), exports); - __exportStar(require_jobsapiroutesfinetuningstartfinetuningjob(), exports); - __exportStar(require_jobsapiroutesfinetuningunarchivefinetunedmodel(), exports); - __exportStar(require_jobsapiroutesfinetuningupdatefinetunedmodel(), exports); - __exportStar(require_librariesdeletev1(), exports); - __exportStar(require_librariesdocumentsdeletev1(), exports); - __exportStar(require_librariesdocumentsgetextractedtextsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetsignedurlv1(), exports); - __exportStar(require_librariesdocumentsgetstatusv1(), exports); - __exportStar(require_librariesdocumentsgettextcontentv1(), exports); - __exportStar(require_librariesdocumentsgetv1(), exports); - __exportStar(require_librariesdocumentslistv1(), exports); - __exportStar(require_librariesdocumentsreprocessv1(), exports); - __exportStar(require_librariesdocumentsupdatev1(), exports); - __exportStar(require_librariesdocumentsuploadv1(), exports); - __exportStar(require_librariesgetv1(), exports); - __exportStar(require_librariessharecreatev1(), exports); - __exportStar(require_librariessharedeletev1(), exports); - __exportStar(require_librariessharelistv1(), exports); - __exportStar(require_librariesupdatev1(), exports); - __exportStar(require_retrievemodelv1modelsmodelidget(), exports); - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js - var require_batchJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCancel = batchJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_cancel_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js - var require_batchJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsCreate = batchJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function batchJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.BatchJobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_create_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsGet.js - var require_batchJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsGet = batchJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/batchJobsList.js - var require_batchJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/batchJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.batchJobsList = batchJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function batchJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/batch/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "agent_id": payload?.agent_id, - "created_after": payload?.created_after, - "created_by_me": payload?.created_by_me, - "metadata": payload?.metadata, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.BatchJobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistraljobs.js - var require_mistraljobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistraljobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralJobs = void 0; - var batchJobsCancel_js_1 = require_batchJobsCancel(); - var batchJobsCreate_js_1 = require_batchJobsCreate(); - var batchJobsGet_js_1 = require_batchJobsGet(); - var batchJobsList_js_1 = require_batchJobsList(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralJobs = class extends sdks_js_1.ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsList_js_1.batchJobsList)(this, request, options)); - } - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCreate_js_1.batchJobsCreate)(this, request, options)); - } - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsGet_js_1.batchJobsGet)(this, request, options)); - } - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, batchJobsCancel_js_1.batchJobsCancel)(this, request, options)); - } - }; - exports.MistralJobs = MistralJobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/batch.js - var require_batch = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/batch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Batch = void 0; - var sdks_js_1 = require_sdks(); - var mistraljobs_js_1 = require_mistraljobs(); - var Batch = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new mistraljobs_js_1.MistralJobs(this._options)); - } - }; - exports.Batch = Batch; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js - var require_betaConversationsAppend = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppend.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppend = betaConversationsAppend; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppend(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js - var require_betaConversationsAppendStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsAppendStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsAppendStream = betaConversationsAppendStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsAppendStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationAppendStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js - var require_betaConversationsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGet = betaConversationsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js - var require_betaConversationsGetHistory = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetHistory.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetHistory = betaConversationsGetHistory; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetHistory(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/history")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_history", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationHistory$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js - var require_betaConversationsGetMessages = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsGetMessages.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsGetMessages = betaConversationsGetMessages; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsGetMessages(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/messages")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_messages", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationMessages$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsList.js - var require_betaConversationsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsList = betaConversationsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(operations.ResponseBody$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js - var require_betaConversationsRestart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestart = betaConversationsRestart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js - var require_betaConversationsRestartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsRestartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsRestartStream = betaConversationsRestartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaConversationsRestartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.ConversationRestartStreamRequest, { - explode: true - }); - const pathParams = { - conversation_id: (0, encodings_js_1.encodeSimple)("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/conversations/{conversation_id}/restart#stream")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js - var require_betaConversationsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStart = betaConversationsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ConversationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js - var require_betaConversationsStartStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaConversationsStartStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaConversationsStartStream = betaConversationsStartStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaConversationsStartStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ConversationStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/conversations#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start_stream", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/conversations.js - var require_conversations = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/conversations.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Conversations = void 0; - var betaConversationsAppend_js_1 = require_betaConversationsAppend(); - var betaConversationsAppendStream_js_1 = require_betaConversationsAppendStream(); - var betaConversationsGet_js_1 = require_betaConversationsGet(); - var betaConversationsGetHistory_js_1 = require_betaConversationsGetHistory(); - var betaConversationsGetMessages_js_1 = require_betaConversationsGetMessages(); - var betaConversationsList_js_1 = require_betaConversationsList(); - var betaConversationsRestart_js_1 = require_betaConversationsRestart(); - var betaConversationsRestartStream_js_1 = require_betaConversationsRestartStream(); - var betaConversationsStart_js_1 = require_betaConversationsStart(); - var betaConversationsStartStream_js_1 = require_betaConversationsStartStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Conversations = class extends sdks_js_1.ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStart_js_1.betaConversationsStart)(this, request, options)); - } - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsList_js_1.betaConversationsList)(this, request, options)); - } - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGet_js_1.betaConversationsGet)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async append(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppend_js_1.betaConversationsAppend)(this, request, options)); - } - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - async getHistory(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetHistory_js_1.betaConversationsGetHistory)(this, request, options)); - } - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - async getMessages(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsGetMessages_js_1.betaConversationsGetMessages)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restart(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestart_js_1.betaConversationsRestart)(this, request, options)); - } - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async startStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsStartStream_js_1.betaConversationsStartStream)(this, request, options)); - } - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async appendStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsAppendStream_js_1.betaConversationsAppendStream)(this, request, options)); - } - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restartStream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaConversationsRestartStream_js_1.betaConversationsRestartStream)(this, request, options)); - } - }; - exports.Conversations = Conversations; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js - var require_betaLibrariesCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesCreate = betaLibrariesCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaLibrariesCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.LibraryIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(201, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js - var require_betaLibrariesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDelete = betaLibrariesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js - var require_betaLibrariesGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesGet = betaLibrariesGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js - var require_betaLibrariesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesList = betaLibrariesList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var async_js_1 = require_async(); - function betaLibrariesList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/libraries")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListLibraryOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js - var require_betaLibrariesUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesUpdate = betaLibrariesUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.LibraryInUpdate, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.LibraryOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js - var require_betaLibrariesAccessesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesDelete = betaLibrariesAccessesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingDelete, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js - var require_betaLibrariesAccessesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesList = betaLibrariesAccessesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListSharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js - var require_betaLibrariesAccessesUpdateOrCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesAccessesUpdateOrCreate = betaLibrariesAccessesUpdateOrCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesAccessesUpdateOrCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesShareCreateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.SharingIn, { explode: true }); - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/share")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_create_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.SharingOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/accesses.js - var require_accesses = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/accesses.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Accesses = void 0; - var betaLibrariesAccessesDelete_js_1 = require_betaLibrariesAccessesDelete(); - var betaLibrariesAccessesList_js_1 = require_betaLibrariesAccessesList(); - var betaLibrariesAccessesUpdateOrCreate_js_1 = require_betaLibrariesAccessesUpdateOrCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Accesses = class extends sdks_js_1.ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesList_js_1.betaLibrariesAccessesList)(this, request, options)); - } - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - async updateOrCreate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesUpdateOrCreate_js_1.betaLibrariesAccessesUpdateOrCreate)(this, request, options)); - } - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesAccessesDelete_js_1.betaLibrariesAccessesDelete)(this, request, options)); - } - }; - exports.Accesses = Accesses; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js - var require_betaLibrariesDocumentsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsDelete = betaLibrariesDocumentsDelete; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_delete_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js - var require_betaLibrariesDocumentsExtractedTextSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsExtractedTextSignedUrl = betaLibrariesDocumentsExtractedTextSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsExtractedTextSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_extracted_text_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js - var require_betaLibrariesDocumentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGet = betaLibrariesDocumentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js - var require_betaLibrariesDocumentsGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsGetSignedUrl = betaLibrariesDocumentsGetSignedUrl; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/signed-url")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_signed_url_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.string()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js - var require_betaLibrariesDocumentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsList = betaLibrariesDocumentsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsListV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload.page, - "page_size": payload.page_size, - "search": payload.search, - "sort_by": payload.sort_by, - "sort_order": payload.sort_order - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_list_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ListDocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js - var require_betaLibrariesDocumentsReprocess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsReprocess = betaLibrariesDocumentsReprocess; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsReprocess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsReprocessV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/reprocess")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_reprocess_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.nil(204, z.void()), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js - var require_betaLibrariesDocumentsStatus = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsStatus = betaLibrariesDocumentsStatus; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsStatus(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/status")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_status_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ProcessingStatusOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js - var require_betaLibrariesDocumentsTextContent = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsTextContent = betaLibrariesDocumentsTextContent; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsTextContent(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}/text_content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_text_content_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentTextContent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js - var require_betaLibrariesDocumentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpdate = betaLibrariesDocumentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaLibrariesDocumentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.DocumentUpdateIn, { explode: true }); - const pathParams = { - document_id: (0, encodings_js_1.encodeSimple)("document_id", payload.document_id, { - explode: false, - charEncoding: "percent" - }), - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents/{document_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_update_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js - var require_betaLibrariesDocumentsUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaLibrariesDocumentsUpload = betaLibrariesDocumentsUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function betaLibrariesDocumentsUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.LibrariesDocumentsUploadV1Request$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.RequestBody.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.RequestBody.file); - } else if ((0, streams_js_1.isReadableStream)(payload.RequestBody.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.RequestBody.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.RequestBody.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.RequestBody.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.RequestBody.file.content], { type: contentType }), payload.RequestBody.file.fileName); - } - const pathParams = { - library_id: (0, encodings_js_1.encodeSimple)("library_id", payload.library_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/libraries/{library_id}/documents")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_upload_v1", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json([200, 201], components.DocumentOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/documents.js - var require_documents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/documents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Documents = void 0; - var betaLibrariesDocumentsDelete_js_1 = require_betaLibrariesDocumentsDelete(); - var betaLibrariesDocumentsExtractedTextSignedUrl_js_1 = require_betaLibrariesDocumentsExtractedTextSignedUrl(); - var betaLibrariesDocumentsGet_js_1 = require_betaLibrariesDocumentsGet(); - var betaLibrariesDocumentsGetSignedUrl_js_1 = require_betaLibrariesDocumentsGetSignedUrl(); - var betaLibrariesDocumentsList_js_1 = require_betaLibrariesDocumentsList(); - var betaLibrariesDocumentsReprocess_js_1 = require_betaLibrariesDocumentsReprocess(); - var betaLibrariesDocumentsStatus_js_1 = require_betaLibrariesDocumentsStatus(); - var betaLibrariesDocumentsTextContent_js_1 = require_betaLibrariesDocumentsTextContent(); - var betaLibrariesDocumentsUpdate_js_1 = require_betaLibrariesDocumentsUpdate(); - var betaLibrariesDocumentsUpload_js_1 = require_betaLibrariesDocumentsUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Documents = class extends sdks_js_1.ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsList_js_1.betaLibrariesDocumentsList)(this, request, options)); - } - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpload_js_1.betaLibrariesDocumentsUpload)(this, request, options)); - } - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGet_js_1.betaLibrariesDocumentsGet)(this, request, options)); - } - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsUpdate_js_1.betaLibrariesDocumentsUpdate)(this, request, options)); - } - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsDelete_js_1.betaLibrariesDocumentsDelete)(this, request, options)); - } - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - async textContent(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsTextContent_js_1.betaLibrariesDocumentsTextContent)(this, request, options)); - } - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - async status(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsStatus_js_1.betaLibrariesDocumentsStatus)(this, request, options)); - } - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsGetSignedUrl_js_1.betaLibrariesDocumentsGetSignedUrl)(this, request, options)); - } - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - async extractedTextSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsExtractedTextSignedUrl_js_1.betaLibrariesDocumentsExtractedTextSignedUrl)(this, request, options)); - } - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - async reprocess(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDocumentsReprocess_js_1.betaLibrariesDocumentsReprocess)(this, request, options)); - } - }; - exports.Documents = Documents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/libraries.js - var require_libraries = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/libraries.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Libraries = void 0; - var betaLibrariesCreate_js_1 = require_betaLibrariesCreate(); - var betaLibrariesDelete_js_1 = require_betaLibrariesDelete(); - var betaLibrariesGet_js_1 = require_betaLibrariesGet(); - var betaLibrariesList_js_1 = require_betaLibrariesList(); - var betaLibrariesUpdate_js_1 = require_betaLibrariesUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var accesses_js_1 = require_accesses(); - var documents_js_1 = require_documents(); - var Libraries = class extends sdks_js_1.ClientSDK { - get documents() { - return this._documents ?? (this._documents = new documents_js_1.Documents(this._options)); - } - get accesses() { - return this._accesses ?? (this._accesses = new accesses_js_1.Accesses(this._options)); - } - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesList_js_1.betaLibrariesList)(this, options)); - } - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesCreate_js_1.betaLibrariesCreate)(this, request, options)); - } - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesGet_js_1.betaLibrariesGet)(this, request, options)); - } - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesDelete_js_1.betaLibrariesDelete)(this, request, options)); - } - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaLibrariesUpdate_js_1.betaLibrariesUpdate)(this, request, options)); - } - }; - exports.Libraries = Libraries; - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js - var require_betaAgentsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsCreate = betaAgentsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function betaAgentsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.AgentCreationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_create", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js - var require_betaAgentsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsGet = betaAgentsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsList.js - var require_betaAgentsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsList = betaAgentsList; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsListRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/agents")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_list", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, z.array(components.Agent$inboundSchema)), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js - var require_betaAgentsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdate = betaAgentsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.AgentUpdateRequest, { - explode: true - }); - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js - var require_betaAgentsUpdateVersion = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.betaAgentsUpdateVersion = betaAgentsUpdateVersion; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function betaAgentsUpdateVersion(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - agent_id: (0, encodings_js_1.encodeSimple)("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/agents/{agent_id}/version")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "version": payload.version - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update_version", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.Agent$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/mistralagents.js - var require_mistralagents = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/mistralagents.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.MistralAgents = void 0; - var betaAgentsCreate_js_1 = require_betaAgentsCreate(); - var betaAgentsGet_js_1 = require_betaAgentsGet(); - var betaAgentsList_js_1 = require_betaAgentsList(); - var betaAgentsUpdate_js_1 = require_betaAgentsUpdate(); - var betaAgentsUpdateVersion_js_1 = require_betaAgentsUpdateVersion(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var MistralAgents = class extends sdks_js_1.ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsCreate_js_1.betaAgentsCreate)(this, request, options)); - } - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsList_js_1.betaAgentsList)(this, request, options)); - } - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsGet_js_1.betaAgentsGet)(this, request, options)); - } - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdate_js_1.betaAgentsUpdate)(this, request, options)); - } - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - async updateVersion(request, options) { - return (0, fp_js_1.unwrapAsync)((0, betaAgentsUpdateVersion_js_1.betaAgentsUpdateVersion)(this, request, options)); - } - }; - exports.MistralAgents = MistralAgents; - } - }); - - // node_modules/@mistralai/mistralai/sdk/beta.js - var require_beta = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/beta.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Beta = void 0; - var sdks_js_1 = require_sdks(); - var conversations_js_1 = require_conversations(); - var libraries_js_1 = require_libraries(); - var mistralagents_js_1 = require_mistralagents(); - var Beta = class extends sdks_js_1.ClientSDK { - get conversations() { - return this._conversations ?? (this._conversations = new conversations_js_1.Conversations(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new mistralagents_js_1.MistralAgents(this._options)); - } - get libraries() { - return this._libraries ?? (this._libraries = new libraries_js_1.Libraries(this._options)); - } - }; - exports.Beta = Beta; - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatComplete.js - var require_chatComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatComplete = chatComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ChatCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/chatStream.js - var require_chatStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/chatStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.chatStream = chatStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function chatStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Options.js - var require_Options = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Options.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getDefaultOptions = exports.defaultOptions = exports.jsonDescription = exports.ignoreOverride = void 0; - exports.ignoreOverride = Symbol("Let zodToJsonSchema decide on which parser to use"); - var jsonDescription = (jsonSchema, def) => { - if (def.description) { - try { - return { - ...jsonSchema, - ...JSON.parse(def.description) - }; - } catch { - } - } - return jsonSchema; - }; - exports.jsonDescription = jsonDescription; - exports.defaultOptions = { - name: void 0, - $refStrategy: "root", - basePath: ["#"], - effectStrategy: "input", - pipeStrategy: "all", - dateStrategy: "format:date-time", - mapStrategy: "entries", - removeAdditionalStrategy: "passthrough", - allowedAdditionalProperties: true, - rejectedAdditionalProperties: false, - definitionPath: "definitions", - target: "jsonSchema7", - strictUnions: false, - definitions: {}, - errorMessages: false, - markdownDescription: false, - patternStrategy: "escape", - applyRegexFlags: false, - emailStrategy: "format:email", - base64Strategy: "contentEncoding:base64", - nameStrategy: "ref", - openAiAnyTypeName: "OpenAiAnyType" - }; - var getDefaultOptions = (options) => typeof options === "string" ? { - ...exports.defaultOptions, - name: options - } : { - ...exports.defaultOptions, - ...options - }; - exports.getDefaultOptions = getDefaultOptions; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/Refs.js - var require_Refs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/Refs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRefs = void 0; - var Options_js_1 = require_Options(); - var getRefs = (options) => { - const _options = (0, Options_js_1.getDefaultOptions)(options); - const currentPath = _options.name !== void 0 ? [..._options.basePath, _options.definitionPath, _options.name] : _options.basePath; - return { - ..._options, - flags: { hasReferencedOpenAiAnyType: false }, - currentPath, - propertyPath: void 0, - seen: new Map(Object.entries(_options.definitions).map(([name, def]) => [ - def._def, - { - def: def._def, - path: [..._options.basePath, _options.definitionPath, name], - // Resolution of references will be forced even though seen, so it's ok that the schema is undefined here for now. - jsonSchema: void 0 - } - ])) - }; - }; - exports.getRefs = getRefs; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/errorMessages.js - var require_errorMessages = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/errorMessages.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.setResponseValueAndErrors = exports.addErrorMessage = void 0; - function addErrorMessage(res, key, errorMessage, refs) { - if (!refs?.errorMessages) - return; - if (errorMessage) { - res.errorMessage = { - ...res.errorMessage, - [key]: errorMessage - }; - } - } - exports.addErrorMessage = addErrorMessage; - function setResponseValueAndErrors(res, key, value, errorMessage, refs) { - res[key] = value; - addErrorMessage(res, key, errorMessage, refs); - } - exports.setResponseValueAndErrors = setResponseValueAndErrors; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js - var require_getRelativePath = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/getRelativePath.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.getRelativePath = void 0; - var getRelativePath = (pathA, pathB) => { - let i = 0; - for (; i < pathA.length && i < pathB.length; i++) { - if (pathA[i] !== pathB[i]) - break; - } - return [(pathA.length - i).toString(), ...pathB.slice(i)].join("/"); - }; - exports.getRelativePath = getRelativePath; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/any.js - var require_any = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/any.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseAnyDef = void 0; - var getRelativePath_js_1 = require_getRelativePath(); - function parseAnyDef(refs) { - if (refs.target !== "openAi") { - return {}; - } - const anyDefinitionPath = [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ]; - refs.flags.hasReferencedOpenAiAnyType = true; - return { - $ref: refs.$refStrategy === "relative" ? (0, getRelativePath_js_1.getRelativePath)(anyDefinitionPath, refs.currentPath) : anyDefinitionPath.join("/") - }; - } - exports.parseAnyDef = parseAnyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/array.js - var require_array = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/array.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseArrayDef = void 0; - var zod_1 = require_zod(); - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseArrayDef(def, refs) { - const res = { - type: "array" - }; - if (def.type?._def && def.type?._def?.typeName !== zod_1.ZodFirstPartyTypeKind.ZodAny) { - res.items = (0, parseDef_js_1.parseDef)(def.type._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - } - if (def.minLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.minLength.value, def.minLength.message, refs); - } - if (def.maxLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.maxLength.value, def.maxLength.message, refs); - } - if (def.exactLength) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minItems", def.exactLength.value, def.exactLength.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxItems", def.exactLength.value, def.exactLength.message, refs); - } - return res; - } - exports.parseArrayDef = parseArrayDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js - var require_bigint = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/bigint.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBigintDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseBigintDef(def, refs) { - const res = { - type: "integer", - format: "int64" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseBigintDef = parseBigintDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js - var require_boolean = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/boolean.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBooleanDef = void 0; - function parseBooleanDef() { - return { - type: "boolean" - }; - } - exports.parseBooleanDef = parseBooleanDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js - var require_branded = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/branded.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseBrandedDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseBrandedDef(_def, refs) { - return (0, parseDef_js_1.parseDef)(_def.type._def, refs); - } - exports.parseBrandedDef = parseBrandedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js - var require_catch = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/catch.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseCatchDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseCatchDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseCatchDef = parseCatchDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/date.js - var require_date = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/date.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDateDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseDateDef(def, refs, overrideDateStrategy) { - const strategy = overrideDateStrategy ?? refs.dateStrategy; - if (Array.isArray(strategy)) { - return { - anyOf: strategy.map((item, i) => parseDateDef(def, refs, item)) - }; - } - switch (strategy) { - case "string": - case "format:date-time": - return { - type: "string", - format: "date-time" - }; - case "format:date": - return { - type: "string", - format: "date" - }; - case "integer": - return integerDateParser(def, refs); - } - } - exports.parseDateDef = parseDateDef; - var integerDateParser = (def, refs) => { - const res = { - type: "integer", - format: "unix-time" - }; - if (refs.target === "openApi3") { - return res; - } - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "minimum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)( - res, - "maximum", - check.value, - // This is in milliseconds - check.message, - refs - ); - break; - } - } - return res; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/default.js - var require_default = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/default.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDefaultDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseDefaultDef(_def, refs) { - return { - ...(0, parseDef_js_1.parseDef)(_def.innerType._def, refs), - default: _def.defaultValue() - }; - } - exports.parseDefaultDef = parseDefaultDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js - var require_effects = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/effects.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEffectsDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - function parseEffectsDef(_def, refs) { - return refs.effectStrategy === "input" ? (0, parseDef_js_1.parseDef)(_def.schema._def, refs) : (0, any_js_1.parseAnyDef)(refs); - } - exports.parseEffectsDef = parseEffectsDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js - var require_enum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/enum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseEnumDef = void 0; - function parseEnumDef(def) { - return { - type: "string", - enum: Array.from(def.values) - }; - } - exports.parseEnumDef = parseEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js - var require_intersection = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/intersection.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseIntersectionDef = void 0; - var parseDef_js_1 = require_parseDef(); - var isJsonSchema7AllOfType = (type) => { - if ("type" in type && type.type === "string") - return false; - return "allOf" in type; - }; - function parseIntersectionDef(def, refs) { - const allOf = [ - (0, parseDef_js_1.parseDef)(def.left._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }), - (0, parseDef_js_1.parseDef)(def.right._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "1"] - }) - ].filter((x) => !!x); - let unevaluatedProperties = refs.target === "jsonSchema2019-09" ? { unevaluatedProperties: false } : void 0; - const mergedAllOf = []; - allOf.forEach((schema) => { - if (isJsonSchema7AllOfType(schema)) { - mergedAllOf.push(...schema.allOf); - if (schema.unevaluatedProperties === void 0) { - unevaluatedProperties = void 0; - } - } else { - let nestedSchema = schema; - if ("additionalProperties" in schema && schema.additionalProperties === false) { - const { additionalProperties, ...rest } = schema; - nestedSchema = rest; - } else { - unevaluatedProperties = void 0; - } - mergedAllOf.push(nestedSchema); - } - }); - return mergedAllOf.length ? { - allOf: mergedAllOf, - ...unevaluatedProperties - } : void 0; - } - exports.parseIntersectionDef = parseIntersectionDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js - var require_literal = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/literal.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseLiteralDef = void 0; - function parseLiteralDef(def, refs) { - const parsedType = typeof def.value; - if (parsedType !== "bigint" && parsedType !== "number" && parsedType !== "boolean" && parsedType !== "string") { - return { - type: Array.isArray(def.value) ? "array" : "object" - }; - } - if (refs.target === "openApi3") { - return { - type: parsedType === "bigint" ? "integer" : parsedType, - enum: [def.value] - }; - } - return { - type: parsedType === "bigint" ? "integer" : parsedType, - const: def.value - }; - } - exports.parseLiteralDef = parseLiteralDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/string.js - var require_string = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/string.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseStringDef = exports.zodPatterns = void 0; - var errorMessages_js_1 = require_errorMessages(); - var emojiRegex = void 0; - exports.zodPatterns = { - /** - * `c` was changed to `[cC]` to replicate /i flag - */ - cuid: /^[cC][^\s-]{8,}$/, - cuid2: /^[0-9a-z]+$/, - ulid: /^[0-9A-HJKMNP-TV-Z]{26}$/, - /** - * `a-z` was added to replicate /i flag - */ - email: /^(?!\.)(?!.*\.\.)([a-zA-Z0-9_'+\-\.]*)[a-zA-Z0-9_+-]@([a-zA-Z0-9][a-zA-Z0-9\-]*\.)+[a-zA-Z]{2,}$/, - /** - * Constructed a valid Unicode RegExp - * - * Lazily instantiate since this type of regex isn't supported - * in all envs (e.g. React Native). - * - * See: - * https://github.com/colinhacks/zod/issues/2433 - * Fix in Zod: - * https://github.com/colinhacks/zod/commit/9340fd51e48576a75adc919bff65dbc4a5d4c99b - */ - emoji: () => { - if (emojiRegex === void 0) { - emojiRegex = RegExp("^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$", "u"); - } - return emojiRegex; - }, - /** - * Unused - */ - uuid: /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/, - /** - * Unused - */ - ipv4: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/, - ipv4Cidr: /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\/(3[0-2]|[12]?[0-9])$/, - /** - * Unused - */ - ipv6: /^(([a-f0-9]{1,4}:){7}|::([a-f0-9]{1,4}:){0,6}|([a-f0-9]{1,4}:){1}:([a-f0-9]{1,4}:){0,5}|([a-f0-9]{1,4}:){2}:([a-f0-9]{1,4}:){0,4}|([a-f0-9]{1,4}:){3}:([a-f0-9]{1,4}:){0,3}|([a-f0-9]{1,4}:){4}:([a-f0-9]{1,4}:){0,2}|([a-f0-9]{1,4}:){5}:([a-f0-9]{1,4}:){0,1})([a-f0-9]{1,4}|(((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2}))\.){3}((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2})))$/, - ipv6Cidr: /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$/, - base64: /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/, - base64url: /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/, - nanoid: /^[a-zA-Z0-9_-]{21}$/, - jwt: /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/ - }; - function parseStringDef(def, refs) { - const res = { - type: "string" - }; - if (def.checks) { - for (const check of def.checks) { - switch (check.kind) { - case "min": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - break; - case "max": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "email": - switch (refs.emailStrategy) { - case "format:email": - addFormat(res, "email", check.message, refs); - break; - case "format:idn-email": - addFormat(res, "idn-email", check.message, refs); - break; - case "pattern:zod": - addPattern(res, exports.zodPatterns.email, check.message, refs); - break; - } - break; - case "url": - addFormat(res, "uri", check.message, refs); - break; - case "uuid": - addFormat(res, "uuid", check.message, refs); - break; - case "regex": - addPattern(res, check.regex, check.message, refs); - break; - case "cuid": - addPattern(res, exports.zodPatterns.cuid, check.message, refs); - break; - case "cuid2": - addPattern(res, exports.zodPatterns.cuid2, check.message, refs); - break; - case "startsWith": - addPattern(res, RegExp(`^${escapeLiteralCheckValue(check.value, refs)}`), check.message, refs); - break; - case "endsWith": - addPattern(res, RegExp(`${escapeLiteralCheckValue(check.value, refs)}$`), check.message, refs); - break; - case "datetime": - addFormat(res, "date-time", check.message, refs); - break; - case "date": - addFormat(res, "date", check.message, refs); - break; - case "time": - addFormat(res, "time", check.message, refs); - break; - case "duration": - addFormat(res, "duration", check.message, refs); - break; - case "length": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minLength", typeof res.minLength === "number" ? Math.max(res.minLength, check.value) : check.value, check.message, refs); - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maxLength", typeof res.maxLength === "number" ? Math.min(res.maxLength, check.value) : check.value, check.message, refs); - break; - case "includes": { - addPattern(res, RegExp(escapeLiteralCheckValue(check.value, refs)), check.message, refs); - break; - } - case "ip": { - if (check.version !== "v6") { - addFormat(res, "ipv4", check.message, refs); - } - if (check.version !== "v4") { - addFormat(res, "ipv6", check.message, refs); - } - break; - } - case "base64url": - addPattern(res, exports.zodPatterns.base64url, check.message, refs); - break; - case "jwt": - addPattern(res, exports.zodPatterns.jwt, check.message, refs); - break; - case "cidr": { - if (check.version !== "v6") { - addPattern(res, exports.zodPatterns.ipv4Cidr, check.message, refs); - } - if (check.version !== "v4") { - addPattern(res, exports.zodPatterns.ipv6Cidr, check.message, refs); - } - break; - } - case "emoji": - addPattern(res, exports.zodPatterns.emoji(), check.message, refs); - break; - case "ulid": { - addPattern(res, exports.zodPatterns.ulid, check.message, refs); - break; - } - case "base64": { - switch (refs.base64Strategy) { - case "format:binary": { - addFormat(res, "binary", check.message, refs); - break; - } - case "contentEncoding:base64": { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "contentEncoding", "base64", check.message, refs); - break; - } - case "pattern:zod": { - addPattern(res, exports.zodPatterns.base64, check.message, refs); - break; - } - } - break; - } - case "nanoid": { - addPattern(res, exports.zodPatterns.nanoid, check.message, refs); - } - case "toLowerCase": - case "toUpperCase": - case "trim": - break; - default: - /* @__PURE__ */ ((_) => { - })(check); - } - } - } - return res; - } - exports.parseStringDef = parseStringDef; - function escapeLiteralCheckValue(literal, refs) { - return refs.patternStrategy === "escape" ? escapeNonAlphaNumeric(literal) : literal; - } - var ALPHA_NUMERIC = new Set("ABCDEFGHIJKLMNOPQRSTUVXYZabcdefghijklmnopqrstuvxyz0123456789"); - function escapeNonAlphaNumeric(source) { - let result = ""; - for (let i = 0; i < source.length; i++) { - if (!ALPHA_NUMERIC.has(source[i])) { - result += "\\"; - } - result += source[i]; - } - return result; - } - function addFormat(schema, value, message, refs) { - if (schema.format || schema.anyOf?.some((x) => x.format)) { - if (!schema.anyOf) { - schema.anyOf = []; - } - if (schema.format) { - schema.anyOf.push({ - format: schema.format, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { format: schema.errorMessage.format } - } - }); - delete schema.format; - if (schema.errorMessage) { - delete schema.errorMessage.format; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.anyOf.push({ - format: value, - ...message && refs.errorMessages && { errorMessage: { format: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "format", value, message, refs); - } - } - function addPattern(schema, regex, message, refs) { - if (schema.pattern || schema.allOf?.some((x) => x.pattern)) { - if (!schema.allOf) { - schema.allOf = []; - } - if (schema.pattern) { - schema.allOf.push({ - pattern: schema.pattern, - ...schema.errorMessage && refs.errorMessages && { - errorMessage: { pattern: schema.errorMessage.pattern } - } - }); - delete schema.pattern; - if (schema.errorMessage) { - delete schema.errorMessage.pattern; - if (Object.keys(schema.errorMessage).length === 0) { - delete schema.errorMessage; - } - } - } - schema.allOf.push({ - pattern: stringifyRegExpWithFlags(regex, refs), - ...message && refs.errorMessages && { errorMessage: { pattern: message } } - }); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "pattern", stringifyRegExpWithFlags(regex, refs), message, refs); - } - } - function stringifyRegExpWithFlags(regex, refs) { - if (!refs.applyRegexFlags || !regex.flags) { - return regex.source; - } - const flags = { - i: regex.flags.includes("i"), - m: regex.flags.includes("m"), - s: regex.flags.includes("s") - // `.` matches newlines - }; - const source = flags.i ? regex.source.toLowerCase() : regex.source; - let pattern = ""; - let isEscaped = false; - let inCharGroup = false; - let inCharRange = false; - for (let i = 0; i < source.length; i++) { - if (isEscaped) { - pattern += source[i]; - isEscaped = false; - continue; - } - if (flags.i) { - if (inCharGroup) { - if (source[i].match(/[a-z]/)) { - if (inCharRange) { - pattern += source[i]; - pattern += `${source[i - 2]}-${source[i]}`.toUpperCase(); - inCharRange = false; - } else if (source[i + 1] === "-" && source[i + 2]?.match(/[a-z]/)) { - pattern += source[i]; - inCharRange = true; - } else { - pattern += `${source[i]}${source[i].toUpperCase()}`; - } - continue; - } - } else if (source[i].match(/[a-z]/)) { - pattern += `[${source[i]}${source[i].toUpperCase()}]`; - continue; - } - } - if (flags.m) { - if (source[i] === "^") { - pattern += `(^|(?<=[\r -]))`; - continue; - } else if (source[i] === "$") { - pattern += `($|(?=[\r -]))`; - continue; - } - } - if (flags.s && source[i] === ".") { - pattern += inCharGroup ? `${source[i]}\r -` : `[${source[i]}\r -]`; - continue; - } - pattern += source[i]; - if (source[i] === "\\") { - isEscaped = true; - } else if (inCharGroup && source[i] === "]") { - inCharGroup = false; - } else if (!inCharGroup && source[i] === "[") { - inCharGroup = true; - } - } - try { - new RegExp(pattern); - } catch { - console.warn(`Could not convert regex pattern at ${refs.currentPath.join("/")} to a flag-independent form! Falling back to the flag-ignorant source`); - return regex.source; - } - return pattern; - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/record.js - var require_record = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/record.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseRecordDef = void 0; - var zod_1 = require_zod(); - var parseDef_js_1 = require_parseDef(); - var string_js_1 = require_string(); - var branded_js_1 = require_branded(); - var any_js_1 = require_any(); - function parseRecordDef(def, refs) { - if (refs.target === "openAi") { - console.warn("Warning: OpenAI may not support records in schemas! Try an array of key-value pairs instead."); - } - if (refs.target === "openApi3" && def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - type: "object", - required: def.keyType._def.values, - properties: def.keyType._def.values.reduce((acc, key) => ({ - ...acc, - [key]: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", key] - }) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}), - additionalProperties: refs.rejectedAdditionalProperties - }; - } - const schema = { - type: "object", - additionalProperties: (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }) ?? refs.allowedAdditionalProperties - }; - if (refs.target === "openApi3") { - return schema; - } - if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.checks?.length) { - const { type, ...keyType } = (0, string_js_1.parseStringDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodEnum) { - return { - ...schema, - propertyNames: { - enum: def.keyType._def.values - } - }; - } else if (def.keyType?._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodBranded && def.keyType._def.type._def.typeName === zod_1.ZodFirstPartyTypeKind.ZodString && def.keyType._def.type._def.checks?.length) { - const { type, ...keyType } = (0, branded_js_1.parseBrandedDef)(def.keyType._def, refs); - return { - ...schema, - propertyNames: keyType - }; - } - return schema; - } - exports.parseRecordDef = parseRecordDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/map.js - var require_map = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/map.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseMapDef = void 0; - var parseDef_js_1 = require_parseDef(); - var record_js_1 = require_record(); - var any_js_1 = require_any(); - function parseMapDef(def, refs) { - if (refs.mapStrategy === "record") { - return (0, record_js_1.parseRecordDef)(def, refs); - } - const keys = (0, parseDef_js_1.parseDef)(def.keyType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "0"] - }) || (0, any_js_1.parseAnyDef)(refs); - const values = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items", "items", "1"] - }) || (0, any_js_1.parseAnyDef)(refs); - return { - type: "array", - maxItems: 125, - items: { - type: "array", - items: [keys, values], - minItems: 2, - maxItems: 2 - } - }; - } - exports.parseMapDef = parseMapDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js - var require_nativeEnum = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nativeEnum.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNativeEnumDef = void 0; - function parseNativeEnumDef(def) { - const object = def.values; - const actualKeys = Object.keys(def.values).filter((key) => { - return typeof object[object[key]] !== "number"; - }); - const actualValues = actualKeys.map((key) => object[key]); - const parsedTypes = Array.from(new Set(actualValues.map((values) => typeof values))); - return { - type: parsedTypes.length === 1 ? parsedTypes[0] === "string" ? "string" : "number" : ["string", "number"], - enum: actualValues - }; - } - exports.parseNativeEnumDef = parseNativeEnumDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/never.js - var require_never = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/never.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNeverDef = void 0; - var any_js_1 = require_any(); - function parseNeverDef(refs) { - return refs.target === "openAi" ? void 0 : { - not: (0, any_js_1.parseAnyDef)({ - ...refs, - currentPath: [...refs.currentPath, "not"] - }) - }; - } - exports.parseNeverDef = parseNeverDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/null.js - var require_null = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/null.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullDef = void 0; - function parseNullDef(refs) { - return refs.target === "openApi3" ? { - enum: ["null"], - nullable: true - } : { - type: "null" - }; - } - exports.parseNullDef = parseNullDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/union.js - var require_union = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/union.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnionDef = exports.primitiveMappings = void 0; - var parseDef_js_1 = require_parseDef(); - exports.primitiveMappings = { - ZodString: "string", - ZodNumber: "number", - ZodBigInt: "integer", - ZodBoolean: "boolean", - ZodNull: "null" - }; - function parseUnionDef(def, refs) { - if (refs.target === "openApi3") - return asAnyOf(def, refs); - const options = def.options instanceof Map ? Array.from(def.options.values()) : def.options; - if (options.every((x) => x._def.typeName in exports.primitiveMappings && (!x._def.checks || !x._def.checks.length))) { - const types = options.reduce((types2, x) => { - const type = exports.primitiveMappings[x._def.typeName]; - return type && !types2.includes(type) ? [...types2, type] : types2; - }, []); - return { - type: types.length > 1 ? types : types[0] - }; - } else if (options.every((x) => x._def.typeName === "ZodLiteral" && !x.description)) { - const types = options.reduce((acc, x) => { - const type = typeof x._def.value; - switch (type) { - case "string": - case "number": - case "boolean": - return [...acc, type]; - case "bigint": - return [...acc, "integer"]; - case "object": - if (x._def.value === null) - return [...acc, "null"]; - case "symbol": - case "undefined": - case "function": - default: - return acc; - } - }, []); - if (types.length === options.length) { - const uniqueTypes = types.filter((x, i, a) => a.indexOf(x) === i); - return { - type: uniqueTypes.length > 1 ? uniqueTypes : uniqueTypes[0], - enum: options.reduce((acc, x) => { - return acc.includes(x._def.value) ? acc : [...acc, x._def.value]; - }, []) - }; - } - } else if (options.every((x) => x._def.typeName === "ZodEnum")) { - return { - type: "string", - enum: options.reduce((acc, x) => [ - ...acc, - ...x._def.values.filter((x2) => !acc.includes(x2)) - ], []) - }; - } - return asAnyOf(def, refs); - } - exports.parseUnionDef = parseUnionDef; - var asAnyOf = (def, refs) => { - const anyOf = (def.options instanceof Map ? Array.from(def.options.values()) : def.options).map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", `${i}`] - })).filter((x) => !!x && (!refs.strictUnions || typeof x === "object" && Object.keys(x).length > 0)); - return anyOf.length ? { anyOf } : void 0; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js - var require_nullable = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/nullable.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNullableDef = void 0; - var parseDef_js_1 = require_parseDef(); - var union_js_1 = require_union(); - function parseNullableDef(def, refs) { - if (["ZodString", "ZodNumber", "ZodBigInt", "ZodBoolean", "ZodNull"].includes(def.innerType._def.typeName) && (!def.innerType._def.checks || !def.innerType._def.checks.length)) { - if (refs.target === "openApi3") { - return { - type: union_js_1.primitiveMappings[def.innerType._def.typeName], - nullable: true - }; - } - return { - type: [ - union_js_1.primitiveMappings[def.innerType._def.typeName], - "null" - ] - }; - } - if (refs.target === "openApi3") { - const base2 = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath] - }); - if (base2 && "$ref" in base2) - return { allOf: [base2], nullable: true }; - return base2 && { ...base2, nullable: true }; - } - const base = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "0"] - }); - return base && { anyOf: [base, { type: "null" }] }; - } - exports.parseNullableDef = parseNullableDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/number.js - var require_number = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/number.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseNumberDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - function parseNumberDef(def, refs) { - const res = { - type: "number" - }; - if (!def.checks) - return res; - for (const check of def.checks) { - switch (check.kind) { - case "int": - res.type = "integer"; - (0, errorMessages_js_1.addErrorMessage)(res, "type", check.message, refs); - break; - case "min": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMinimum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMinimum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "minimum", check.value, check.message, refs); - } - break; - case "max": - if (refs.target === "jsonSchema7") { - if (check.inclusive) { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } else { - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "exclusiveMaximum", check.value, check.message, refs); - } - } else { - if (!check.inclusive) { - res.exclusiveMaximum = true; - } - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "maximum", check.value, check.message, refs); - } - break; - case "multipleOf": - (0, errorMessages_js_1.setResponseValueAndErrors)(res, "multipleOf", check.value, check.message, refs); - break; - } - } - return res; - } - exports.parseNumberDef = parseNumberDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/object.js - var require_object = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/object.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseObjectDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseObjectDef(def, refs) { - const forceOptionalIntoNullable = refs.target === "openAi"; - const result = { - type: "object", - properties: {} - }; - const required = []; - const shape = def.shape(); - for (const propName in shape) { - let propDef = shape[propName]; - if (propDef === void 0 || propDef._def === void 0) { - continue; - } - let propOptional = safeIsOptional(propDef); - if (propOptional && forceOptionalIntoNullable) { - if (propDef._def.typeName === "ZodOptional") { - propDef = propDef._def.innerType; - } - if (!propDef.isNullable()) { - propDef = propDef.nullable(); - } - propOptional = false; - } - const parsedDef = (0, parseDef_js_1.parseDef)(propDef._def, { - ...refs, - currentPath: [...refs.currentPath, "properties", propName], - propertyPath: [...refs.currentPath, "properties", propName] - }); - if (parsedDef === void 0) { - continue; - } - result.properties[propName] = parsedDef; - if (!propOptional) { - required.push(propName); - } - } - if (required.length) { - result.required = required; - } - const additionalProperties = decideAdditionalProperties(def, refs); - if (additionalProperties !== void 0) { - result.additionalProperties = additionalProperties; - } - return result; - } - exports.parseObjectDef = parseObjectDef; - function decideAdditionalProperties(def, refs) { - if (def.catchall._def.typeName !== "ZodNever") { - return (0, parseDef_js_1.parseDef)(def.catchall._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalProperties"] - }); - } - switch (def.unknownKeys) { - case "passthrough": - return refs.allowedAdditionalProperties; - case "strict": - return refs.rejectedAdditionalProperties; - case "strip": - return refs.removeAdditionalStrategy === "strict" ? refs.allowedAdditionalProperties : refs.rejectedAdditionalProperties; - } - } - function safeIsOptional(schema) { - try { - return schema.isOptional(); - } catch { - return true; - } - } - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js - var require_optional = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/optional.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseOptionalDef = void 0; - var parseDef_js_1 = require_parseDef(); - var any_js_1 = require_any(); - var parseOptionalDef = (def, refs) => { - if (refs.currentPath.toString() === refs.propertyPath?.toString()) { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - } - const innerSchema = (0, parseDef_js_1.parseDef)(def.innerType._def, { - ...refs, - currentPath: [...refs.currentPath, "anyOf", "1"] - }); - return innerSchema ? { - anyOf: [ - { - not: (0, any_js_1.parseAnyDef)(refs) - }, - innerSchema - ] - } : (0, any_js_1.parseAnyDef)(refs); - }; - exports.parseOptionalDef = parseOptionalDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js - var require_pipeline = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/pipeline.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePipelineDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parsePipelineDef = (def, refs) => { - if (refs.pipeStrategy === "input") { - return (0, parseDef_js_1.parseDef)(def.in._def, refs); - } else if (refs.pipeStrategy === "output") { - return (0, parseDef_js_1.parseDef)(def.out._def, refs); - } - const a = (0, parseDef_js_1.parseDef)(def.in._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", "0"] - }); - const b = (0, parseDef_js_1.parseDef)(def.out._def, { - ...refs, - currentPath: [...refs.currentPath, "allOf", a ? "1" : "0"] - }); - return { - allOf: [a, b].filter((x) => x !== void 0) - }; - }; - exports.parsePipelineDef = parsePipelineDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js - var require_promise = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/promise.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parsePromiseDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parsePromiseDef(def, refs) { - return (0, parseDef_js_1.parseDef)(def.type._def, refs); - } - exports.parsePromiseDef = parsePromiseDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/set.js - var require_set = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/set.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseSetDef = void 0; - var errorMessages_js_1 = require_errorMessages(); - var parseDef_js_1 = require_parseDef(); - function parseSetDef(def, refs) { - const items = (0, parseDef_js_1.parseDef)(def.valueType._def, { - ...refs, - currentPath: [...refs.currentPath, "items"] - }); - const schema = { - type: "array", - uniqueItems: true, - items - }; - if (def.minSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "minItems", def.minSize.value, def.minSize.message, refs); - } - if (def.maxSize) { - (0, errorMessages_js_1.setResponseValueAndErrors)(schema, "maxItems", def.maxSize.value, def.maxSize.message, refs); - } - return schema; - } - exports.parseSetDef = parseSetDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js - var require_tuple = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/tuple.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseTupleDef = void 0; - var parseDef_js_1 = require_parseDef(); - function parseTupleDef(def, refs) { - if (def.rest) { - return { - type: "array", - minItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []), - additionalItems: (0, parseDef_js_1.parseDef)(def.rest._def, { - ...refs, - currentPath: [...refs.currentPath, "additionalItems"] - }) - }; - } else { - return { - type: "array", - minItems: def.items.length, - maxItems: def.items.length, - items: def.items.map((x, i) => (0, parseDef_js_1.parseDef)(x._def, { - ...refs, - currentPath: [...refs.currentPath, "items", `${i}`] - })).reduce((acc, x) => x === void 0 ? acc : [...acc, x], []) - }; - } - } - exports.parseTupleDef = parseTupleDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js - var require_undefined = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/undefined.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUndefinedDef = void 0; - var any_js_1 = require_any(); - function parseUndefinedDef(refs) { - return { - not: (0, any_js_1.parseAnyDef)(refs) - }; - } - exports.parseUndefinedDef = parseUndefinedDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js - var require_unknown = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/unknown.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseUnknownDef = void 0; - var any_js_1 = require_any(); - function parseUnknownDef(refs) { - return (0, any_js_1.parseAnyDef)(refs); - } - exports.parseUnknownDef = parseUnknownDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js - var require_readonly = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parsers/readonly.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseReadonlyDef = void 0; - var parseDef_js_1 = require_parseDef(); - var parseReadonlyDef = (def, refs) => { - return (0, parseDef_js_1.parseDef)(def.innerType._def, refs); - }; - exports.parseReadonlyDef = parseReadonlyDef; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/selectParser.js - var require_selectParser = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/selectParser.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.selectParser = void 0; - var zod_1 = require_zod(); - var any_js_1 = require_any(); - var array_js_1 = require_array(); - var bigint_js_1 = require_bigint(); - var boolean_js_1 = require_boolean(); - var branded_js_1 = require_branded(); - var catch_js_1 = require_catch(); - var date_js_1 = require_date(); - var default_js_1 = require_default(); - var effects_js_1 = require_effects(); - var enum_js_1 = require_enum(); - var intersection_js_1 = require_intersection(); - var literal_js_1 = require_literal(); - var map_js_1 = require_map(); - var nativeEnum_js_1 = require_nativeEnum(); - var never_js_1 = require_never(); - var null_js_1 = require_null(); - var nullable_js_1 = require_nullable(); - var number_js_1 = require_number(); - var object_js_1 = require_object(); - var optional_js_1 = require_optional(); - var pipeline_js_1 = require_pipeline(); - var promise_js_1 = require_promise(); - var record_js_1 = require_record(); - var set_js_1 = require_set(); - var string_js_1 = require_string(); - var tuple_js_1 = require_tuple(); - var undefined_js_1 = require_undefined(); - var union_js_1 = require_union(); - var unknown_js_1 = require_unknown(); - var readonly_js_1 = require_readonly(); - var selectParser = (def, typeName, refs) => { - switch (typeName) { - case zod_1.ZodFirstPartyTypeKind.ZodString: - return (0, string_js_1.parseStringDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNumber: - return (0, number_js_1.parseNumberDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodObject: - return (0, object_js_1.parseObjectDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBigInt: - return (0, bigint_js_1.parseBigintDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBoolean: - return (0, boolean_js_1.parseBooleanDef)(); - case zod_1.ZodFirstPartyTypeKind.ZodDate: - return (0, date_js_1.parseDateDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUndefined: - return (0, undefined_js_1.parseUndefinedDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodNull: - return (0, null_js_1.parseNullDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodArray: - return (0, array_js_1.parseArrayDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnion: - case zod_1.ZodFirstPartyTypeKind.ZodDiscriminatedUnion: - return (0, union_js_1.parseUnionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodIntersection: - return (0, intersection_js_1.parseIntersectionDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodTuple: - return (0, tuple_js_1.parseTupleDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodRecord: - return (0, record_js_1.parseRecordDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLiteral: - return (0, literal_js_1.parseLiteralDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodEnum: - return (0, enum_js_1.parseEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNativeEnum: - return (0, nativeEnum_js_1.parseNativeEnumDef)(def); - case zod_1.ZodFirstPartyTypeKind.ZodNullable: - return (0, nullable_js_1.parseNullableDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodOptional: - return (0, optional_js_1.parseOptionalDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodMap: - return (0, map_js_1.parseMapDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodSet: - return (0, set_js_1.parseSetDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodLazy: - return () => def.getter()._def; - case zod_1.ZodFirstPartyTypeKind.ZodPromise: - return (0, promise_js_1.parsePromiseDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodNaN: - case zod_1.ZodFirstPartyTypeKind.ZodNever: - return (0, never_js_1.parseNeverDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodEffects: - return (0, effects_js_1.parseEffectsDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodAny: - return (0, any_js_1.parseAnyDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodUnknown: - return (0, unknown_js_1.parseUnknownDef)(refs); - case zod_1.ZodFirstPartyTypeKind.ZodDefault: - return (0, default_js_1.parseDefaultDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodBranded: - return (0, branded_js_1.parseBrandedDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodReadonly: - return (0, readonly_js_1.parseReadonlyDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodCatch: - return (0, catch_js_1.parseCatchDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodPipeline: - return (0, pipeline_js_1.parsePipelineDef)(def, refs); - case zod_1.ZodFirstPartyTypeKind.ZodFunction: - case zod_1.ZodFirstPartyTypeKind.ZodVoid: - case zod_1.ZodFirstPartyTypeKind.ZodSymbol: - return void 0; - default: - return /* @__PURE__ */ ((_) => void 0)(typeName); - } - }; - exports.selectParser = selectParser; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseDef.js - var require_parseDef = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseDef.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.parseDef = void 0; - var Options_js_1 = require_Options(); - var selectParser_js_1 = require_selectParser(); - var getRelativePath_js_1 = require_getRelativePath(); - var any_js_1 = require_any(); - function parseDef(def, refs, forceResolution = false) { - const seenItem = refs.seen.get(def); - if (refs.override) { - const overrideResult = refs.override?.(def, refs, seenItem, forceResolution); - if (overrideResult !== Options_js_1.ignoreOverride) { - return overrideResult; - } - } - if (seenItem && !forceResolution) { - const seenSchema = get$ref(seenItem, refs); - if (seenSchema !== void 0) { - return seenSchema; - } - } - const newItem = { def, path: refs.currentPath, jsonSchema: void 0 }; - refs.seen.set(def, newItem); - const jsonSchemaOrGetter = (0, selectParser_js_1.selectParser)(def, def.typeName, refs); - const jsonSchema = typeof jsonSchemaOrGetter === "function" ? parseDef(jsonSchemaOrGetter(), refs) : jsonSchemaOrGetter; - if (jsonSchema) { - addMeta(def, refs, jsonSchema); - } - if (refs.postProcess) { - const postProcessResult = refs.postProcess(jsonSchema, def, refs); - newItem.jsonSchema = jsonSchema; - return postProcessResult; - } - newItem.jsonSchema = jsonSchema; - return jsonSchema; - } - exports.parseDef = parseDef; - var get$ref = (item, refs) => { - switch (refs.$refStrategy) { - case "root": - return { $ref: item.path.join("/") }; - case "relative": - return { $ref: (0, getRelativePath_js_1.getRelativePath)(refs.currentPath, item.path) }; - case "none": - case "seen": { - if (item.path.length < refs.currentPath.length && item.path.every((value, index) => refs.currentPath[index] === value)) { - console.warn(`Recursive reference detected at ${refs.currentPath.join("/")}! Defaulting to any`); - return (0, any_js_1.parseAnyDef)(refs); - } - return refs.$refStrategy === "seen" ? (0, any_js_1.parseAnyDef)(refs) : void 0; - } - } - }; - var addMeta = (def, refs, jsonSchema) => { - if (def.description) { - jsonSchema.description = def.description; - if (refs.markdownDescription) { - jsonSchema.markdownDescription = def.description; - } - } - return jsonSchema; - }; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/parseTypes.js - var require_parseTypes = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/parseTypes.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js - var require_zodToJsonSchema = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/zodToJsonSchema.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.zodToJsonSchema = void 0; - var parseDef_js_1 = require_parseDef(); - var Refs_js_1 = require_Refs(); - var any_js_1 = require_any(); - var zodToJsonSchema = (schema, options) => { - const refs = (0, Refs_js_1.getRefs)(options); - let definitions = typeof options === "object" && options.definitions ? Object.entries(options.definitions).reduce((acc, [name2, schema2]) => ({ - ...acc, - [name2]: (0, parseDef_js_1.parseDef)(schema2._def, { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name2] - }, true) ?? (0, any_js_1.parseAnyDef)(refs) - }), {}) : void 0; - const name = typeof options === "string" ? options : options?.nameStrategy === "title" ? void 0 : options?.name; - const main = (0, parseDef_js_1.parseDef)(schema._def, name === void 0 ? refs : { - ...refs, - currentPath: [...refs.basePath, refs.definitionPath, name] - }, false) ?? (0, any_js_1.parseAnyDef)(refs); - const title = typeof options === "object" && options.name !== void 0 && options.nameStrategy === "title" ? options.name : void 0; - if (title !== void 0) { - main.title = title; - } - if (refs.flags.hasReferencedOpenAiAnyType) { - if (!definitions) { - definitions = {}; - } - if (!definitions[refs.openAiAnyTypeName]) { - definitions[refs.openAiAnyTypeName] = { - // Skipping "object" as no properties can be defined and additionalProperties must be "false" - type: ["string", "number", "integer", "boolean", "array", "null"], - items: { - $ref: refs.$refStrategy === "relative" ? "1" : [ - ...refs.basePath, - refs.definitionPath, - refs.openAiAnyTypeName - ].join("/") - } - }; - } - } - const combined = name === void 0 ? definitions ? { - ...main, - [refs.definitionPath]: definitions - } : main : { - $ref: [ - ...refs.$refStrategy === "relative" ? [] : refs.basePath, - refs.definitionPath, - name - ].join("/"), - [refs.definitionPath]: { - ...definitions, - [name]: main - } - }; - if (refs.target === "jsonSchema7") { - combined.$schema = "http://json-schema.org/draft-07/schema#"; - } else if (refs.target === "jsonSchema2019-09" || refs.target === "openAi") { - combined.$schema = "https://json-schema.org/draft/2019-09/schema#"; - } - if (refs.target === "openAi" && ("anyOf" in combined || "oneOf" in combined || "allOf" in combined || "type" in combined && Array.isArray(combined.type))) { - console.warn("Warning: OpenAI may not support schemas with unions as roots! Try wrapping it in an object property."); - } - return combined; - }; - exports.zodToJsonSchema = zodToJsonSchema; - } - }); - - // node_modules/zod-to-json-schema/dist/cjs/index.js - var require_cjs = __commonJS({ - "node_modules/zod-to-json-schema/dist/cjs/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - Object.defineProperty(exports, "__esModule", { value: true }); - __exportStar(require_Options(), exports); - __exportStar(require_Refs(), exports); - __exportStar(require_errorMessages(), exports); - __exportStar(require_getRelativePath(), exports); - __exportStar(require_parseDef(), exports); - __exportStar(require_parseTypes(), exports); - __exportStar(require_any(), exports); - __exportStar(require_array(), exports); - __exportStar(require_bigint(), exports); - __exportStar(require_boolean(), exports); - __exportStar(require_branded(), exports); - __exportStar(require_catch(), exports); - __exportStar(require_date(), exports); - __exportStar(require_default(), exports); - __exportStar(require_effects(), exports); - __exportStar(require_enum(), exports); - __exportStar(require_intersection(), exports); - __exportStar(require_literal(), exports); - __exportStar(require_map(), exports); - __exportStar(require_nativeEnum(), exports); - __exportStar(require_never(), exports); - __exportStar(require_null(), exports); - __exportStar(require_nullable(), exports); - __exportStar(require_number(), exports); - __exportStar(require_object(), exports); - __exportStar(require_optional(), exports); - __exportStar(require_pipeline(), exports); - __exportStar(require_promise(), exports); - __exportStar(require_readonly(), exports); - __exportStar(require_record(), exports); - __exportStar(require_set(), exports); - __exportStar(require_string(), exports); - __exportStar(require_tuple(), exports); - __exportStar(require_undefined(), exports); - __exportStar(require_union(), exports); - __exportStar(require_unknown(), exports); - __exportStar(require_selectParser(), exports); - __exportStar(require_zodToJsonSchema(), exports); - var zodToJsonSchema_js_1 = require_zodToJsonSchema(); - exports.default = zodToJsonSchema_js_1.zodToJsonSchema; - } - }); - - // node_modules/@mistralai/mistralai/extra/structChat.js - var require_structChat = __commonJS({ - "node_modules/@mistralai/mistralai/extra/structChat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.transformToChatCompletionRequest = transformToChatCompletionRequest; - exports.convertToParsedChatCompletionResponse = convertToParsedChatCompletionResponse; - exports.responseFormatFromZodObject = responseFormatFromZodObject; - var zod_to_json_schema_1 = require_cjs(); - function transformToChatCompletionRequest(parsedRequest) { - const { responseFormat, ...rest } = parsedRequest; - const transformedResponseFormat = responseFormatFromZodObject(responseFormat); - return { - ...rest, - responseFormat: transformedResponseFormat - }; - } - function convertToParsedChatCompletionResponse(response, responseFormat) { - if (response.choices === void 0 || response.choices.length === 0) { - return { - ...response, - choices: response.choices === void 0 ? void 0 : [] - }; - } - const parsedChoices = []; - for (const _choice of response.choices) { - if (_choice.message === null || typeof _choice.message === "undefined") { - parsedChoices.push({ ..._choice, message: void 0 }); - } else { - if (_choice.message.content !== null && typeof _choice.message.content !== "undefined" && !Array.isArray(_choice.message.content)) { - parsedChoices.push({ - ..._choice, - message: { - ..._choice.message, - parsed: responseFormat.safeParse(JSON.parse(_choice.message.content)).data - } - }); - } - } - } - return { - ...response, - choices: parsedChoices - }; - } - function responseFormatFromZodObject(responseFormat) { - const responseJsonSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(responseFormat); - const placeholderName = "placeholderName"; - return { - type: "json_schema", - jsonSchema: { - name: placeholderName, - schemaDefinition: responseJsonSchema, - strict: true - } - }; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/chat.js - var require_chat = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/chat.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Chat = void 0; - var chatComplete_js_1 = require_chatComplete(); - var chatStream_js_1 = require_chatStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var structChat_js_1 = require_structChat(); - var Chat = class extends sdks_js_1.ClientSDK { - // #region sdk-class-body - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - async parse(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - const response = await (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, ccr_request, options)); - const parsed_response = (0, structChat_js_1.convertToParsedChatCompletionResponse)(response, request.responseFormat); - return parsed_response; - } - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - async parseStream(request, options) { - const ccr_request = (0, structChat_js_1.transformToChatCompletionRequest)(request); - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, ccr_request, options)); - } - // #endregion sdk-class-body - /** - * Chat Completion - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatComplete_js_1.chatComplete)(this, request, options)); - } - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, chatStream_js_1.chatStream)(this, request, options)); - } - }; - exports.Chat = Chat; - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassify.js - var require_classifiersClassify = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassify.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassify = classifiersClassify; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassify(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "classifications_v1_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js - var require_classifiersClassifyChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersClassifyChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersClassifyChat = classifiersClassifyChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersClassifyChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/classifications")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_classifications_v1_chat_classifications_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ClassificationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerate.js - var require_classifiersModerate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerate = classifiersModerate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ClassificationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "moderations_v1_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js - var require_classifiersModerateChat = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/classifiersModerateChat.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.classifiersModerateChat = classifiersModerateChat; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function classifiersModerateChat(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.ChatModerationRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/chat/moderations")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_moderations_v1_chat_moderations_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModerationResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/classifiers.js - var require_classifiers = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/classifiers.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Classifiers = void 0; - var classifiersClassify_js_1 = require_classifiersClassify(); - var classifiersClassifyChat_js_1 = require_classifiersClassifyChat(); - var classifiersModerate_js_1 = require_classifiersModerate(); - var classifiersModerateChat_js_1 = require_classifiersModerateChat(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Classifiers = class extends sdks_js_1.ClientSDK { - /** - * Moderations - */ - async moderate(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerate_js_1.classifiersModerate)(this, request, options)); - } - /** - * Chat Moderations - */ - async moderateChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersModerateChat_js_1.classifiersModerateChat)(this, request, options)); - } - /** - * Classifications - */ - async classify(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassify_js_1.classifiersClassify)(this, request, options)); - } - /** - * Chat Classifications - */ - async classifyChat(request, options) { - return (0, fp_js_1.unwrapAsync)((0, classifiersClassifyChat_js_1.classifiersClassifyChat)(this, request, options)); - } - }; - exports.Classifiers = Classifiers; - } - }); - - // node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js - var require_embeddingsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/embeddingsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.embeddingsCreate = embeddingsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function embeddingsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.EmbeddingRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/embeddings")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "embeddings_v1_embeddings_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.EmbeddingResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/embeddings.js - var require_embeddings = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/embeddings.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Embeddings = void 0; - var embeddingsCreate_js_1 = require_embeddingsCreate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Embeddings = class extends sdks_js_1.ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, embeddingsCreate_js_1.embeddingsCreate)(this, request, options)); - } - }; - exports.Embeddings = Embeddings; - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDelete.js - var require_filesDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDelete = filesDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_delete_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.DeleteFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesDownload.js - var require_filesDownload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesDownload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesDownload = filesDownload; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesDownload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/content")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/octet-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_download_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.stream(200, z.instanceof(ReadableStream)), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js - var require_filesGetSignedUrl = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesGetSignedUrl.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesGetSignedUrl = filesGetSignedUrl; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesGetSignedUrl(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}/url")(pathParams); - const query = (0, encodings_js_1.encodeFormQuery)({ - "expiry": payload.expiry - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_get_signed_url", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.FileSignedURL$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesList.js - var require_filesList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesList = filesList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesListFilesRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "page": payload?.page, - "page_size": payload?.page_size, - "purpose": payload?.purpose, - "sample_type": payload?.sample_type, - "search": payload?.search, - "source": payload?.source - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_list_files", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ListFilesOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesRetrieve.js - var require_filesRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesRetrieve = filesRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function filesRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - file_id: (0, encodings_js_1.encodeSimple)("file_id", payload.file_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/files/{file_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_retrieve_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.RetrieveFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/filesUpload.js - var require_filesUpload = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/filesUpload.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.filesUpload = filesUpload; - var encodings_js_1 = require_encodings(); - var files_js_1 = require_files(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - var blobs_js_1 = require_blobs(); - var streams_js_1 = require_streams(); - function filesUpload(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - if ((0, blobs_js_1.isBlobLike)(payload.file)) { - (0, encodings_js_1.appendForm)(body, "file", payload.file); - } else if ((0, streams_js_1.isReadableStream)(payload.file.content)) { - const buffer = await (0, files_js_1.readableStreamToArrayBuffer)(payload.file.content); - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - (0, encodings_js_1.appendForm)(body, "file", blob, payload.file.fileName); - } else { - const contentType = (0, files_js_1.getContentTypeFromFileName)(payload.file.fileName) || "application/octet-stream"; - (0, encodings_js_1.appendForm)(body, "file", new Blob([payload.file.content], { type: contentType }), payload.file.fileName); - } - if (payload.purpose !== void 0) { - (0, encodings_js_1.appendForm)(body, "purpose", payload.purpose); - } - const path = (0, url_js_1.pathToFunc)("/v1/files")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_upload_file", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UploadFileOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/files.js - var require_files2 = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/files.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Files = void 0; - var filesDelete_js_1 = require_filesDelete(); - var filesDownload_js_1 = require_filesDownload(); - var filesGetSignedUrl_js_1 = require_filesGetSignedUrl(); - var filesList_js_1 = require_filesList(); - var filesRetrieve_js_1 = require_filesRetrieve(); - var filesUpload_js_1 = require_filesUpload(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Files = class extends sdks_js_1.ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - async upload(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesUpload_js_1.filesUpload)(this, request, options)); - } - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesList_js_1.filesList)(this, request, options)); - } - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesRetrieve_js_1.filesRetrieve)(this, request, options)); - } - /** - * Delete File - * - * @remarks - * Delete a file. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDelete_js_1.filesDelete)(this, request, options)); - } - /** - * Download File - * - * @remarks - * Download a file - */ - async download(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesDownload_js_1.filesDownload)(this, request, options)); - } - /** - * Get Signed Url - */ - async getSignedUrl(request, options) { - return (0, fp_js_1.unwrapAsync)((0, filesGetSignedUrl_js_1.filesGetSignedUrl)(this, request, options)); - } - }; - exports.Files = Files; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimComplete.js - var require_fimComplete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimComplete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimComplete = fimComplete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimComplete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "fim_completion_v1_fim_completions_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.FIMCompletionResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fimStream.js - var require_fimStream = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fimStream.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fimStream = fimStream; - var z = __importStar(require_zod()); - var encodings_js_1 = require_encodings(); - var event_streams_js_1 = require_event_streams(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function fimStream(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.FIMCompletionStreamRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fim/completions#stream")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "text/event-stream" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_fim", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.sse(200, z.instanceof(ReadableStream).transform((stream) => { - return new event_streams_js_1.EventStream(stream, (rawEvent) => { - if (rawEvent.data === "[DONE]") - return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent) - }; - }); - })), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/fim.js - var require_fim = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/fim.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Fim = void 0; - var fimComplete_js_1 = require_fimComplete(); - var fimStream_js_1 = require_fimStream(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Fim = class extends sdks_js_1.ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - async complete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimComplete_js_1.fimComplete)(this, request, options)); - } - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fimStream_js_1.fimStream)(this, request, options)); - } - }; - exports.Fim = Fim; - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js - var require_fineTuningJobsCancel = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCancel.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCancel = fineTuningJobsCancel; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCancel(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/cancel")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js - var require_fineTuningJobsCreate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsCreate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsCreate = fineTuningJobsCreate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsCreate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.JobIn$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_create_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js - var require_fineTuningJobsGet = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsGet.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsGet = fineTuningJobsGet; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsGet(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js - var require_fineTuningJobsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsList = fineTuningJobsList; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsList(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.optional().parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs")(); - const query = (0, encodings_js_1.encodeFormQuery)({ - "created_after": payload?.created_after, - "created_before": payload?.created_before, - "created_by_me": payload?.created_by_me, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status, - "suffix": payload?.suffix, - "wandb_name": payload?.wandb_name, - "wandb_project": payload?.wandb_project - }); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - query, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.JobsOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js - var require_fineTuningJobsStart = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/fineTuningJobsStart.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.fineTuningJobsStart = fineTuningJobsStart; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function fineTuningJobsStart(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - job_id: (0, encodings_js_1.encodeSimple)("job_id", payload.job_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/jobs/{job_id}/start")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_start_fine_tuning_job", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/jobs.js - var require_jobs = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/jobs.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Jobs = void 0; - var fineTuningJobsCancel_js_1 = require_fineTuningJobsCancel(); - var fineTuningJobsCreate_js_1 = require_fineTuningJobsCreate(); - var fineTuningJobsGet_js_1 = require_fineTuningJobsGet(); - var fineTuningJobsList_js_1 = require_fineTuningJobsList(); - var fineTuningJobsStart_js_1 = require_fineTuningJobsStart(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Jobs = class extends sdks_js_1.ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - async list(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsList_js_1.fineTuningJobsList)(this, request, options)); - } - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - async create(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCreate_js_1.fineTuningJobsCreate)(this, request, options)); - } - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - async get(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsGet_js_1.fineTuningJobsGet)(this, request, options)); - } - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - async cancel(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsCancel_js_1.fineTuningJobsCancel)(this, request, options)); - } - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - async start(request, options) { - return (0, fp_js_1.unwrapAsync)((0, fineTuningJobsStart_js_1.fineTuningJobsStart)(this, request, options)); - } - }; - exports.Jobs = Jobs; - } - }); - - // node_modules/@mistralai/mistralai/sdk/finetuning.js - var require_finetuning = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/finetuning.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.FineTuning = void 0; - var sdks_js_1 = require_sdks(); - var jobs_js_1 = require_jobs(); - var FineTuning = class extends sdks_js_1.ClientSDK { - get jobs() { - return this._jobs ?? (this._jobs = new jobs_js_1.Jobs(this._options)); - } - }; - exports.FineTuning = FineTuning; - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsArchive.js - var require_modelsArchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsArchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsArchive = modelsArchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsArchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_archive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.ArchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsDelete.js - var require_modelsDelete = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsDelete.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsDelete = modelsDelete; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsDelete(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "delete_model_v1_models__model_id__delete", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.DeleteModelOut$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsList.js - var require_modelsList = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsList.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsList = modelsList; - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function modelsList(client, options) { - return new async_js_1.APIPromise($do(client, options)); - } - async function $do(client, options) { - const path = (0, url_js_1.pathToFunc)("/v1/models")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "list_models_v1_models_get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.ModelList$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js - var require_modelsRetrieve = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsRetrieve.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsRetrieve = modelsRetrieve; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var errors = __importStar(require_errors2()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsRetrieve(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "retrieve_model_v1_models__model_id__get", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js - var require_modelsUnarchive = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUnarchive.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUnarchive = modelsUnarchive; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUnarchive(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}/archive")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, components.UnarchiveFTModelOut$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/funcs/modelsUpdate.js - var require_modelsUpdate = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/modelsUpdate.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.modelsUpdate = modelsUpdate; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var operations = __importStar(require_operations()); - var async_js_1 = require_async(); - function modelsUpdate(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload.UpdateFTModelIn, { explode: true }); - const pathParams = { - model_id: (0, encodings_js_1.encodeSimple)("model_id", payload.model_id, { - explode: false, - charEncoding: "percent" - }) - }; - const path = (0, url_js_1.pathToFunc)("/v1/fine_tuning/models/{model_id}")(pathParams); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_update_fine_tuned_model", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const [result] = await M.match(M.json(200, operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/models.js - var require_models = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/models.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Models = void 0; - var modelsArchive_js_1 = require_modelsArchive(); - var modelsDelete_js_1 = require_modelsDelete(); - var modelsList_js_1 = require_modelsList(); - var modelsRetrieve_js_1 = require_modelsRetrieve(); - var modelsUnarchive_js_1 = require_modelsUnarchive(); - var modelsUpdate_js_1 = require_modelsUpdate(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Models = class extends sdks_js_1.ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - async list(options) { - return (0, fp_js_1.unwrapAsync)((0, modelsList_js_1.modelsList)(this, options)); - } - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - async retrieve(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsRetrieve_js_1.modelsRetrieve)(this, request, options)); - } - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - async delete(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsDelete_js_1.modelsDelete)(this, request, options)); - } - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - async update(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUpdate_js_1.modelsUpdate)(this, request, options)); - } - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - async archive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsArchive_js_1.modelsArchive)(this, request, options)); - } - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - async unarchive(request, options) { - return (0, fp_js_1.unwrapAsync)((0, modelsUnarchive_js_1.modelsUnarchive)(this, request, options)); - } - }; - exports.Models = Models; - } - }); - - // node_modules/@mistralai/mistralai/funcs/ocrProcess.js - var require_ocrProcess = __commonJS({ - "node_modules/@mistralai/mistralai/funcs/ocrProcess.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.ocrProcess = ocrProcess; - var encodings_js_1 = require_encodings(); - var M = __importStar(require_matchers()); - var primitives_js_1 = require_primitives(); - var schemas_js_1 = require_schemas(); - var security_js_1 = require_security(); - var url_js_1 = require_url(); - var components = __importStar(require_components()); - var errors = __importStar(require_errors2()); - var async_js_1 = require_async(); - function ocrProcess(client, request, options) { - return new async_js_1.APIPromise($do(client, request, options)); - } - async function $do(client, request, options) { - const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.OCRRequest$outboundSchema.parse(value), "Input validation failed"); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true }); - const path = (0, url_js_1.pathToFunc)("/v1/ocr")(); - const headers = new Headers((0, primitives_js_1.compactMap)({ - "Content-Type": "application/json", - Accept: "application/json" - })); - const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput); - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "ocr_v1_ocr_post", - oAuth2Scopes: [], - resolvedSecurity: requestSecurity, - securitySource: client._options.apiKey, - retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"] - }; - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path, - headers, - body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1 - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - const responseFields = { - HttpMeta: { Response: response, Request: req } - }; - const [result] = await M.match(M.json(200, components.OCRResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - return [result, { status: "complete", request: req, response }]; - } - } - }); - - // node_modules/@mistralai/mistralai/sdk/ocr.js - var require_ocr = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/ocr.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Ocr = void 0; - var ocrProcess_js_1 = require_ocrProcess(); - var sdks_js_1 = require_sdks(); - var fp_js_1 = require_fp(); - var Ocr = class extends sdks_js_1.ClientSDK { - /** - * OCR - */ - async process(request, options) { - return (0, fp_js_1.unwrapAsync)((0, ocrProcess_js_1.ocrProcess)(this, request, options)); - } - }; - exports.Ocr = Ocr; - } - }); - - // node_modules/@mistralai/mistralai/sdk/sdk.js - var require_sdk = __commonJS({ - "node_modules/@mistralai/mistralai/sdk/sdk.js"(exports) { - "use strict"; - Object.defineProperty(exports, "__esModule", { value: true }); - exports.Mistral = void 0; - var sdks_js_1 = require_sdks(); - var agents_js_1 = require_agents(); - var audio_js_1 = require_audio(); - var batch_js_1 = require_batch(); - var beta_js_1 = require_beta(); - var chat_js_1 = require_chat(); - var classifiers_js_1 = require_classifiers(); - var embeddings_js_1 = require_embeddings(); - var files_js_1 = require_files2(); - var fim_js_1 = require_fim(); - var finetuning_js_1 = require_finetuning(); - var models_js_1 = require_models(); - var ocr_js_1 = require_ocr(); - var Mistral = class extends sdks_js_1.ClientSDK { - get models() { - return this._models ?? (this._models = new models_js_1.Models(this._options)); - } - get beta() { - return this._beta ?? (this._beta = new beta_js_1.Beta(this._options)); - } - get files() { - return this._files ?? (this._files = new files_js_1.Files(this._options)); - } - get fineTuning() { - return this._fineTuning ?? (this._fineTuning = new finetuning_js_1.FineTuning(this._options)); - } - get batch() { - return this._batch ?? (this._batch = new batch_js_1.Batch(this._options)); - } - get chat() { - return this._chat ?? (this._chat = new chat_js_1.Chat(this._options)); - } - get fim() { - return this._fim ?? (this._fim = new fim_js_1.Fim(this._options)); - } - get agents() { - return this._agents ?? (this._agents = new agents_js_1.Agents(this._options)); - } - get embeddings() { - return this._embeddings ?? (this._embeddings = new embeddings_js_1.Embeddings(this._options)); - } - get classifiers() { - return this._classifiers ?? (this._classifiers = new classifiers_js_1.Classifiers(this._options)); - } - get ocr() { - return this._ocr ?? (this._ocr = new ocr_js_1.Ocr(this._options)); - } - get audio() { - return this._audio ?? (this._audio = new audio_js_1.Audio(this._options)); - } - }; - exports.Mistral = Mistral; - } - }); - - // node_modules/@mistralai/mistralai/index.js - var require_mistralai = __commonJS({ - "node_modules/@mistralai/mistralai/index.js"(exports) { - "use strict"; - var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - var desc = Object.getOwnPropertyDescriptor(m, k); - if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { - return m[k]; - } }; - } - Object.defineProperty(o, k2, desc); - }) : (function(o, m, k, k2) { - if (k2 === void 0) k2 = k; - o[k2] = m[k]; - })); - var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); - }) : function(o, v) { - o["default"] = v; - }); - var __exportStar = exports && exports.__exportStar || function(m, exports2) { - for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p); - }; - var __importStar = exports && exports.__importStar || /* @__PURE__ */ (function() { - var ownKeys = function(o) { - ownKeys = Object.getOwnPropertyNames || function(o2) { - var ar = []; - for (var k in o2) if (Object.prototype.hasOwnProperty.call(o2, k)) ar[ar.length] = k; - return ar; - }; - return ownKeys(o); - }; - return function(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) { - for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); - } - __setModuleDefault(result, mod); - return result; - }; - })(); - Object.defineProperty(exports, "__esModule", { value: true }); - exports.HTTPClient = exports.files = void 0; - __exportStar(require_config(), exports); - exports.files = __importStar(require_files()); - var http_js_1 = require_http(); - Object.defineProperty(exports, "HTTPClient", { enumerable: true, get: function() { - return http_js_1.HTTPClient; - } }); - __exportStar(require_sdk(), exports); - } - }); - - // - var _mistralai_mistralai = __toESM(require_mistralai()); - globalThis.__deps__ = globalThis.__deps__ || {}; - globalThis.__deps__._mistralai_mistralai = _mistralai_mistralai; -})(); diff --git a/examples/nextra/public/mistral-try-it-now/tsworker.js b/examples/nextra/public/mistral-try-it-now/tsworker.js deleted file mode 100644 index f4911c357..000000000 --- a/examples/nextra/public/mistral-try-it-now/tsworker.js +++ /dev/null @@ -1,118 +0,0 @@ -// Web Worker for safely executing bundled code This runs in its own isolated -// context to prevent interference with the main thread, and to prevent console -// logs from the main thread from mixing with the logs from the worker. -// Browser-compatible string formatter (replacement for Node.js util.format) -function format(template, ...args) { - let index = 0; - return template.replace(/%([sdifcoO])/g, (match, specifier) => { - if (index >= args.length) - return match; - const arg = args[index++]; - switch (specifier) { - case "s": // string - return String(arg); - case "d": // number - case "i": // integer - return String(Number(arg)); - case "f": // float - return String(Number(arg)); - case "o": // object (simple) - case "O": // object (detailed) - try { - return JSON.stringify(arg); - } - catch { - return String(arg); - } - case "c": // CSS (not supported, just return empty) - return ""; - default: - return match; - } - }); -} -// Helper to enforce strict typing -function sendMessage(message) { - self.postMessage(message); -} -function createConsolePatch(console, level) { - const originalConsoleMethod = console[level]; - // console itself is defined using `any`, so we need to disable the lint - // eslint-disable-next-line @typescript-eslint/no-explicit-any - console[level] = (message, ...optionalParams) => { - const hasSubstitutions = typeof message === "string" && /%[sdifcoO]/.test(message); - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment - originalConsoleMethod.apply(console, [message, ...optionalParams]); - if (hasSubstitutions) { - sendMessage({ - type: "log", - level, - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument - message: format(message, ...optionalParams), - }); - return; - } - sendMessage({ - type: "log", - level, - message, - }); - for (const optionalParam of optionalParams) { - sendMessage({ - type: "log", - level, - message: optionalParam, - }); - } - }; -} -// Listen for messages from the main thread -self.onmessage = function (event) { - if (event.data.type === "execute") { - // Patch console - createConsolePatch(console, "log"); - createConsolePatch(console, "info"); - createConsolePatch(console, "warn"); - createConsolePatch(console, "error"); - createConsolePatch(console, "debug"); - // Listen for unhandled rejections, which includes the API returning an - // error status code - globalThis.addEventListener("unhandledrejection", (event) => { - sendMessage({ - type: "uncaught-reject", - error: event.reason instanceof Error - ? { - message: event.reason.message, - stack: event.reason.stack, - name: event.reason.name, - } - : { message: String(event.reason) }, - }); - }); - // Execute the wrapped code using an indirect eval call for safety. See - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_direct_eval! - try { - // First execute the dependency bundle to populate globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.dependencyBundle}`); - // Then execute the user code which can access dependencies via globalThis.__deps__ - eval?.(`"use strict"; - ${event.data.bundle}`); - } - catch (error) { - // Send back the error - sendMessage({ - type: "uncaught-exception", - error: error instanceof Error - ? { - message: error.message, - stack: error.stack, - name: error.name, - } - : { message: String(error) }, - }); - } - } -}; -export {}; -//# sourceMappingURL=worker.js.map \ No newline at end of file diff --git a/examples/nextra/public/mistral-try-it-now/types.d.ts b/examples/nextra/public/mistral-try-it-now/types.d.ts deleted file mode 100644 index bac18f929..000000000 --- a/examples/nextra/public/mistral-try-it-now/types.d.ts +++ /dev/null @@ -1,18932 +0,0 @@ -import * as z from 'zod'; -import { z as z_2 } from 'zod'; - -declare const __brand: unique symbol; - -declare class Accesses extends ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - list(request: operations.LibrariesShareListV1Request, options?: RequestOptions): Promise; - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - updateOrCreate(request: operations.LibrariesShareCreateV1Request, options?: RequestOptions): Promise; - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - delete(request: operations.LibrariesShareDeleteV1Request, options?: RequestOptions): Promise; -} - -declare type AfterErrorContext = HookContext & {}; - -declare interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable_2<{ - response: Response | null; - error: unknown; - }>; -} - -declare type AfterSuccessContext = HookContext & {}; - -declare interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable_2; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Agent$ { - /** @deprecated use `Agent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Agent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Agent$Outbound` instead. */ - type Outbound = Agent$Outbound; -} - -/** @internal */ -declare const Agent$inboundSchema: z.ZodType; - -/** @internal */ -declare type Agent$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object: string; - id: string; - version: number; - created_at: string; - updated_at: string; -}; - -/** @internal */ -declare const Agent$outboundSchema: z.ZodType; - -declare type Agent = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object?: AgentObject | undefined; - id: string; - version: number; - createdAt: Date; - updatedAt: Date; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversation$ { - /** @deprecated use `AgentConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentConversation$Outbound` instead. */ - type Outbound = AgentConversation$Outbound; -} - -/** @internal */ -declare const AgentConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentConversation$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - agent_id: string; -}; - -/** @internal */ -declare const AgentConversation$outboundSchema: z.ZodType; - -declare type AgentConversation = { - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: AgentConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - agentId: string; -}; - -declare function agentConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentConversationObject$ { - /** @deprecated use `AgentConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `AgentConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const AgentConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type AgentConversationObject = ClosedEnum; - -declare function agentConversationToJSON(agentConversation: AgentConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequest$ { - /** @deprecated use `AgentCreationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequest$Outbound` instead. */ - type Outbound = AgentCreationRequest$Outbound; -} - -/** @internal */ -declare const AgentCreationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentCreationRequest$outboundSchema: z.ZodType; - -declare type AgentCreationRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentCreationRequestFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToJSON(agentCreationRequest: AgentCreationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentCreationRequestTools$ { - /** @deprecated use `AgentCreationRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentCreationRequestTools$Outbound` instead. */ - type Outbound = AgentCreationRequestTools$Outbound; -} - -/** @internal */ -declare const AgentCreationRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentCreationRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentCreationRequestTools$outboundSchema: z.ZodType; - -declare type AgentCreationRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentCreationRequestToolsFromJSON(jsonString: string): Result; - -declare function agentCreationRequestToolsToJSON(agentCreationRequestTools: AgentCreationRequestTools): string; - -declare function agentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEvent$ { - /** @deprecated use `AgentHandoffDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffDoneEvent$Outbound` instead. */ - type Outbound = AgentHandoffDoneEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffDoneEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffDoneEvent = { - type?: AgentHandoffDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffDoneEventFromJSON(jsonString: string): Result; - -declare function agentHandoffDoneEventToJSON(agentHandoffDoneEvent: AgentHandoffDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffDoneEventType$ { - /** @deprecated use `AgentHandoffDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; - /** @deprecated use `AgentHandoffDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffDone: "agent.handoff.done"; - }>; -} - -/** @internal */ -declare const AgentHandoffDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffDoneEventType: { - readonly AgentHandoffDone: "agent.handoff.done"; -}; - -declare type AgentHandoffDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntry$ { - /** @deprecated use `AgentHandoffEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffEntry$Outbound` instead. */ - type Outbound = AgentHandoffEntry$Outbound; -} - -/** @internal */ -declare const AgentHandoffEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - previous_agent_id: string; - previous_agent_name: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffEntry$outboundSchema: z.ZodType; - -declare type AgentHandoffEntry = { - object?: AgentHandoffEntryObject | undefined; - type?: AgentHandoffEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - previousAgentId: string; - previousAgentName: string; - nextAgentId: string; - nextAgentName: string; -}; - -declare function agentHandoffEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryObject$ { - /** @deprecated use `AgentHandoffEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `AgentHandoffEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryObject: { - readonly Entry: "entry"; -}; - -declare type AgentHandoffEntryObject = ClosedEnum; - -declare function agentHandoffEntryToJSON(agentHandoffEntry: AgentHandoffEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffEntryType$ { - /** @deprecated use `AgentHandoffEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; - /** @deprecated use `AgentHandoffEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoff: "agent.handoff"; - }>; -} - -/** @internal */ -declare const AgentHandoffEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffEntryType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffEntryType: { - readonly AgentHandoff: "agent.handoff"; -}; - -declare type AgentHandoffEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEvent$ { - /** @deprecated use `AgentHandoffStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentHandoffStartedEvent$Outbound` instead. */ - type Outbound = AgentHandoffStartedEvent$Outbound; -} - -/** @internal */ -declare const AgentHandoffStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentHandoffStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - previous_agent_id: string; - previous_agent_name: string; -}; - -/** @internal */ -declare const AgentHandoffStartedEvent$outboundSchema: z.ZodType; - -declare type AgentHandoffStartedEvent = { - type?: AgentHandoffStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - previousAgentId: string; - previousAgentName: string; -}; - -declare function agentHandoffStartedEventFromJSON(jsonString: string): Result; - -declare function agentHandoffStartedEventToJSON(agentHandoffStartedEvent: AgentHandoffStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentHandoffStartedEventType$ { - /** @deprecated use `AgentHandoffStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; - /** @deprecated use `AgentHandoffStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly AgentHandoffStarted: "agent.handoff.started"; - }>; -} - -/** @internal */ -declare const AgentHandoffStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentHandoffStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const AgentHandoffStartedEventType: { - readonly AgentHandoffStarted: "agent.handoff.started"; -}; - -declare type AgentHandoffStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentObject$ { - /** @deprecated use `AgentObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; - /** @deprecated use `AgentObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Agent: "agent"; - }>; -} - -/** @internal */ -declare const AgentObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AgentObject$outboundSchema: z.ZodNativeEnum; - -declare const AgentObject: { - readonly Agent: "agent"; -}; - -declare type AgentObject = ClosedEnum; - -declare class Agents extends ClientSDK { - /** - * Agents Completion - */ - complete(request: components.AgentsCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.AgentsCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsGetRequest$ { - /** @deprecated use `AgentsApiV1AgentsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsGetRequest$Outbound = { - agent_id: string; -}; - -/** @internal */ -declare const AgentsApiV1AgentsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsGetRequest = { - agentId: string; -}; - -declare function agentsApiV1AgentsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsGetRequestToJSON(agentsApiV1AgentsGetRequest: AgentsApiV1AgentsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsListRequest$ { - /** @deprecated use `AgentsApiV1AgentsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1AgentsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsListRequestToJSON(agentsApiV1AgentsListRequest: AgentsApiV1AgentsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateRequest$Outbound = { - agent_id: string; - AgentUpdateRequest: components.AgentUpdateRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateRequest = { - agentId: string; - agentUpdateRequest: components.AgentUpdateRequest; -}; - -declare function agentsApiV1AgentsUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateRequestToJSON(agentsApiV1AgentsUpdateRequest: AgentsApiV1AgentsUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1AgentsUpdateVersionRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$Outbound` instead. */ - type Outbound = AgentsApiV1AgentsUpdateVersionRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1AgentsUpdateVersionRequest$Outbound = { - agent_id: string; - version: number; -}; - -/** @internal */ -declare const AgentsApiV1AgentsUpdateVersionRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1AgentsUpdateVersionRequest = { - agentId: string; - version: number; -}; - -declare function agentsApiV1AgentsUpdateVersionRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1AgentsUpdateVersionRequestToJSON(agentsApiV1AgentsUpdateVersionRequest: AgentsApiV1AgentsUpdateVersionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendRequest$Outbound = { - conversation_id: string; - ConversationAppendRequest: components.ConversationAppendRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendRequest: components.ConversationAppendRequest; -}; - -declare function agentsApiV1ConversationsAppendRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendRequestToJSON(agentsApiV1ConversationsAppendRequest: AgentsApiV1ConversationsAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsAppendStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsAppendStreamRequest$Outbound = { - conversation_id: string; - ConversationAppendStreamRequest: components.ConversationAppendStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsAppendStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsAppendStreamRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendStreamRequest: components.ConversationAppendStreamRequest; -}; - -declare function agentsApiV1ConversationsAppendStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsAppendStreamRequestToJSON(agentsApiV1ConversationsAppendStreamRequest: AgentsApiV1ConversationsAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetRequest$ { - /** @deprecated use `AgentsApiV1ConversationsGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsGetRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsGetRequest = { - /** - * ID of the conversation from which we are fetching metadata. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsGetRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetRequestToJSON(agentsApiV1ConversationsGetRequest: AgentsApiV1ConversationsGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsGetResponseV1ConversationsGet$ { - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type AgentsApiV1ConversationsGetResponseV1ConversationsGet = components.ModelConversation | components.AgentConversation; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON(agentsApiV1ConversationsGetResponseV1ConversationsGet: AgentsApiV1ConversationsGetResponseV1ConversationsGet): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsHistoryRequest$ { - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsHistoryRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsHistoryRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsHistoryRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsHistoryRequest = { - /** - * ID of the conversation from which we are fetching entries. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsHistoryRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsHistoryRequestToJSON(agentsApiV1ConversationsHistoryRequest: AgentsApiV1ConversationsHistoryRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsListRequest$ { - /** @deprecated use `AgentsApiV1ConversationsListRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsListRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsListRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsListRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -declare function agentsApiV1ConversationsListRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsListRequestToJSON(agentsApiV1ConversationsListRequest: AgentsApiV1ConversationsListRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsMessagesRequest$ { - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsMessagesRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsMessagesRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsMessagesRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsMessagesRequest = { - /** - * ID of the conversation from which we are fetching messages. - */ - conversationId: string; -}; - -declare function agentsApiV1ConversationsMessagesRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsMessagesRequestToJSON(agentsApiV1ConversationsMessagesRequest: AgentsApiV1ConversationsMessagesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartRequest$Outbound = { - conversation_id: string; - ConversationRestartRequest: components.ConversationRestartRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartRequest: components.ConversationRestartRequest; -}; - -declare function agentsApiV1ConversationsRestartRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartRequestToJSON(agentsApiV1ConversationsRestartRequest: AgentsApiV1ConversationsRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsApiV1ConversationsRestartStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$Outbound` instead. */ - type Outbound = AgentsApiV1ConversationsRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsApiV1ConversationsRestartStreamRequest$Outbound = { - conversation_id: string; - ConversationRestartStreamRequest: components.ConversationRestartStreamRequest$Outbound; -}; - -/** @internal */ -declare const AgentsApiV1ConversationsRestartStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsApiV1ConversationsRestartStreamRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartStreamRequest: components.ConversationRestartStreamRequest; -}; - -declare function agentsApiV1ConversationsRestartStreamRequestFromJSON(jsonString: string): Result; - -declare function agentsApiV1ConversationsRestartStreamRequestToJSON(agentsApiV1ConversationsRestartStreamRequest: AgentsApiV1ConversationsRestartStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequest$ { - /** @deprecated use `AgentsCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequest$Outbound` instead. */ - type Outbound = AgentsCompletionRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestMessages$ { - /** @deprecated use `AgentsCompletionRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestMessagesToJSON(agentsCompletionRequestMessages: AgentsCompletionRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestStop$ { - /** @deprecated use `AgentsCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionRequestStop = string | Array; - -declare function agentsCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestStopToJSON(agentsCompletionRequestStop: AgentsCompletionRequestStop): string; - -declare function agentsCompletionRequestToJSON(agentsCompletionRequest: AgentsCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionRequestToolChoice$ { - /** @deprecated use `AgentsCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionRequestToolChoiceToJSON(agentsCompletionRequestToolChoice: AgentsCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequest$ { - /** @deprecated use `AgentsCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequest$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -declare const AgentsCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -declare function agentsCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestMessages$ { - /** @deprecated use `AgentsCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const AgentsCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function agentsCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestMessagesToJSON(agentsCompletionStreamRequestMessages: AgentsCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestStop$ { - /** @deprecated use `AgentsCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const AgentsCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type AgentsCompletionStreamRequestStop = string | Array; - -declare function agentsCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestStopToJSON(agentsCompletionStreamRequestStop: AgentsCompletionStreamRequestStop): string; - -declare function agentsCompletionStreamRequestToJSON(agentsCompletionStreamRequest: AgentsCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentsCompletionStreamRequestToolChoice$ { - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = AgentsCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentsCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const AgentsCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type AgentsCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function agentsCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function agentsCompletionStreamRequestToolChoiceToJSON(agentsCompletionStreamRequestToolChoice: AgentsCompletionStreamRequestToolChoice): string; - -declare function agentToJSON(agent: Agent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentTools$ { - /** @deprecated use `AgentTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentTools$Outbound` instead. */ - type Outbound = AgentTools$Outbound; -} - -/** @internal */ -declare const AgentTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentTools$outboundSchema: z.ZodType; - -declare type AgentTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentToolsFromJSON(jsonString: string): Result; - -declare function agentToolsToJSON(agentTools: AgentTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequest$ { - /** @deprecated use `AgentUpdateRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequest$Outbound` instead. */ - type Outbound = AgentUpdateRequest$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequest$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -declare const AgentUpdateRequest$outboundSchema: z.ZodType; - -declare type AgentUpdateRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -declare function agentUpdateRequestFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToJSON(agentUpdateRequest: AgentUpdateRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AgentUpdateRequestTools$ { - /** @deprecated use `AgentUpdateRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AgentUpdateRequestTools$Outbound` instead. */ - type Outbound = AgentUpdateRequestTools$Outbound; -} - -/** @internal */ -declare const AgentUpdateRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type AgentUpdateRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const AgentUpdateRequestTools$outboundSchema: z.ZodType; - -declare type AgentUpdateRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function agentUpdateRequestToolsFromJSON(jsonString: string): Result; - -declare function agentUpdateRequestToolsToJSON(agentUpdateRequestTools: AgentUpdateRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ApiEndpoint$ { - /** @deprecated use `ApiEndpoint$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ApiEndpoint$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ApiEndpoint$inboundSchema: z.ZodType; - -/** @internal */ -declare const ApiEndpoint$outboundSchema: z.ZodType; - -declare const ApiEndpoint: { - readonly RootV1ChatCompletions: "/v1/chat/completions"; - readonly RootV1Embeddings: "/v1/embeddings"; - readonly RootV1FimCompletions: "/v1/fim/completions"; - readonly RootV1Moderations: "/v1/moderations"; - readonly RootV1ChatModerations: "/v1/chat/moderations"; - readonly RootV1Ocr: "/v1/ocr"; - readonly RootV1Classifications: "/v1/classifications"; - readonly RootV1ChatClassifications: "/v1/chat/classifications"; - readonly RootV1Conversations: "/v1/conversations"; - readonly RootV1AudioTranscriptions: "/v1/audio/transcriptions"; -}; - -declare type ApiEndpoint = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOut$ { - /** @deprecated use `ArchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ArchiveFTModelOut$Outbound` instead. */ - type Outbound = ArchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const ArchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ArchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const ArchiveFTModelOut$outboundSchema: z.ZodType; - -declare type ArchiveFTModelOut = { - id: string; - object?: ArchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function archiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ArchiveFTModelOutObject$ { - /** @deprecated use `ArchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ArchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ArchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ArchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ArchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ArchiveFTModelOutObject = ClosedEnum; - -declare function archiveFTModelOutToJSON(archiveFTModelOut: ArchiveFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Arguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Arguments$Outbound` instead. */ - type Outbound = Arguments$Outbound; -} - -/** @internal */ -declare const Arguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type Arguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const Arguments$outboundSchema: z.ZodType; - -declare type Arguments = { - [k: string]: any; -} | string; - -declare function argumentsFromJSON(jsonString: string): Result; - -declare function argumentsToJSON(value: Arguments): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - type Outbound = AssistantMessage$Outbound; -} - -/** @internal */ -declare const AssistantMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -declare const AssistantMessage$outboundSchema: z.ZodType; - -declare type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - type Outbound = AssistantMessageContent$Outbound; -} - -/** @internal */ -declare const AssistantMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type AssistantMessageContent$Outbound = string | Array; - -/** @internal */ -declare const AssistantMessageContent$outboundSchema: z.ZodType; - -declare type AssistantMessageContent = string | Array; - -declare function assistantMessageContentFromJSON(jsonString: string): Result; - -declare function assistantMessageContentToJSON(assistantMessageContent: AssistantMessageContent): string; - -declare function assistantMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const AssistantMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AssistantMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const AssistantMessageRole: { - readonly Assistant: "assistant"; -}; - -declare type AssistantMessageRole = ClosedEnum; - -declare function assistantMessageToJSON(assistantMessage: AssistantMessage): string; - -declare class Audio_2 extends ClientSDK { - private _transcriptions?; - get transcriptions(): Transcriptions; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunk$ { - /** @deprecated use `AudioChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioChunk$Outbound` instead. */ - type Outbound = AudioChunk$Outbound; -} - -/** @internal */ -declare const AudioChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioChunk$Outbound = { - input_audio: string; - type: string; -}; - -/** @internal */ -declare const AudioChunk$outboundSchema: z.ZodType; - -declare type AudioChunk = { - inputAudio: string; - type?: AudioChunkType | undefined; -}; - -declare function audioChunkFromJSON(jsonString: string): Result; - -declare function audioChunkToJSON(audioChunk: AudioChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioChunkType$ { - /** @deprecated use `AudioChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; - /** @deprecated use `AudioChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly InputAudio: "input_audio"; - }>; -} - -/** @internal */ -declare const AudioChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const AudioChunkType$outboundSchema: z.ZodNativeEnum; - -declare const AudioChunkType: { - readonly InputAudio: "input_audio"; -}; - -declare type AudioChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequest$ { - /** @deprecated use `AudioTranscriptionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequest$Outbound` instead. */ - type Outbound = AudioTranscriptionRequest$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequest$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: false; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequest$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequest = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: false | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace AudioTranscriptionRequestStream$ { - /** @deprecated use `AudioTranscriptionRequestStream$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `AudioTranscriptionRequestStream$Outbound` instead. */ - type Outbound = AudioTranscriptionRequestStream$Outbound; -} - -/** @internal */ -declare const AudioTranscriptionRequestStream$inboundSchema: z.ZodType; - -/** @internal */ -declare type AudioTranscriptionRequestStream$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: true; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -declare const AudioTranscriptionRequestStream$outboundSchema: z.ZodType; - -declare type AudioTranscriptionRequestStream = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: true | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -declare function audioTranscriptionRequestStreamFromJSON(jsonString: string): Result; - -declare function audioTranscriptionRequestStreamToJSON(audioTranscriptionRequestStream: AudioTranscriptionRequestStream): string; - -declare function audioTranscriptionRequestToJSON(audioTranscriptionRequest: AudioTranscriptionRequest): string; - -declare type Awaitable = T | Promise; - -declare type Awaitable_2 = T | Promise; - -declare type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCard$ { - /** @deprecated use `BaseModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BaseModelCard$Outbound` instead. */ - type Outbound = BaseModelCard$Outbound; -} - -/** @internal */ -declare const BaseModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type BaseModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "base"; -}; - -/** @internal */ -declare const BaseModelCard$outboundSchema: z.ZodType; - -declare type BaseModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "base" | undefined; -}; - -declare function baseModelCardFromJSON(jsonString: string): Result; - -declare function baseModelCardToJSON(baseModelCard: BaseModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BaseModelCardType$ { - /** @deprecated use `BaseModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; - /** @deprecated use `BaseModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Base: "base"; - }>; -} - -/** @internal */ -declare const BaseModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BaseModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const BaseModelCardType: { - readonly Base: "base"; -}; - -declare type BaseModelCardType = ClosedEnum; - -declare class Batch extends ClientSDK { - private _jobs?; - get jobs(): MistralJobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchError$ { - /** @deprecated use `BatchError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchError$Outbound` instead. */ - type Outbound = BatchError$Outbound; -} - -/** @internal */ -declare const BatchError$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchError$Outbound = { - message: string; - count: number; -}; - -/** @internal */ -declare const BatchError$outboundSchema: z.ZodType; - -declare type BatchError = { - message: string; - count?: number | undefined; -}; - -declare function batchErrorFromJSON(jsonString: string): Result; - -declare function batchErrorToJSON(batchError: BatchError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobIn$ { - /** @deprecated use `BatchJobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobIn$Outbound` instead. */ - type Outbound = BatchJobIn$Outbound; -} - -/** @internal */ -declare const BatchJobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobIn$Outbound = { - input_files: Array; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeout_hours: number; -}; - -/** @internal */ -declare const BatchJobIn$outboundSchema: z.ZodType; - -declare type BatchJobIn = { - inputFiles: Array; - endpoint: ApiEndpoint; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: string; - } | null | undefined; - timeoutHours?: number | undefined; -}; - -declare function batchJobInFromJSON(jsonString: string): Result; - -declare function batchJobInToJSON(batchJobIn: BatchJobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOut$ { - /** @deprecated use `BatchJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobOut$Outbound` instead. */ - type Outbound = BatchJobOut$Outbound; -} - -/** @internal */ -declare const BatchJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobOut$Outbound = { - id: string; - object: string; - input_files: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - output_file?: string | null | undefined; - error_file?: string | null | undefined; - errors: Array; - status: string; - created_at: number; - total_requests: number; - completed_requests: number; - succeeded_requests: number; - failed_requests: number; - started_at?: number | null | undefined; - completed_at?: number | null | undefined; -}; - -/** @internal */ -declare const BatchJobOut$outboundSchema: z.ZodType; - -declare type BatchJobOut = { - id: string; - object?: BatchJobOutObject | undefined; - inputFiles: Array; - metadata?: { - [k: string]: any; - } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agentId?: string | null | undefined; - outputFile?: string | null | undefined; - errorFile?: string | null | undefined; - errors: Array; - status: BatchJobStatus; - createdAt: number; - totalRequests: number; - completedRequests: number; - succeededRequests: number; - failedRequests: number; - startedAt?: number | null | undefined; - completedAt?: number | null | undefined; -}; - -declare function batchJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobOutObject$ { - /** @deprecated use `BatchJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; - /** @deprecated use `BatchJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Batch: "batch"; - }>; -} - -/** @internal */ -declare const BatchJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobOutObject: { - readonly Batch: "batch"; -}; - -declare type BatchJobOutObject = ClosedEnum; - -declare function batchJobOutToJSON(batchJobOut: BatchJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOut$ { - /** @deprecated use `BatchJobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `BatchJobsOut$Outbound` instead. */ - type Outbound = BatchJobsOut$Outbound; -} - -/** @internal */ -declare const BatchJobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type BatchJobsOut$Outbound = { - data?: Array | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const BatchJobsOut$outboundSchema: z.ZodType; - -declare type BatchJobsOut = { - data?: Array | undefined; - object?: BatchJobsOutObject | undefined; - total: number; -}; - -declare function batchJobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobsOutObject$ { - /** @deprecated use `BatchJobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `BatchJobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const BatchJobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobsOutObject: { - readonly List: "list"; -}; - -declare type BatchJobsOutObject = ClosedEnum; - -declare function batchJobsOutToJSON(batchJobsOut: BatchJobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BatchJobStatus$ { - /** @deprecated use `BatchJobStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; - /** @deprecated use `BatchJobStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; - }>; -} - -/** @internal */ -declare const BatchJobStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BatchJobStatus$outboundSchema: z.ZodNativeEnum; - -declare const BatchJobStatus: { - readonly Queued: "QUEUED"; - readonly Running: "RUNNING"; - readonly Success: "SUCCESS"; - readonly Failed: "FAILED"; - readonly TimeoutExceeded: "TIMEOUT_EXCEEDED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - readonly Cancelled: "CANCELLED"; -}; - -declare type BatchJobStatus = ClosedEnum; - -declare type BeforeCreateRequestContext = HookContext & {}; - -declare interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput; -} - -declare type BeforeRequestContext = HookContext & {}; - -declare type BeforeRequestHook = (req: Request) => Awaitable; - -declare interface BeforeRequestHook_2 { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable_2; -} - -declare class Beta extends ClientSDK { - private _conversations?; - get conversations(): Conversations; - private _agents?; - get agents(): MistralAgents; - private _libraries?; - get libraries(): Libraries; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace BuiltInConnectors$ { - /** @deprecated use `BuiltInConnectors$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `BuiltInConnectors$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const BuiltInConnectors$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const BuiltInConnectors$outboundSchema: z.ZodNativeEnum; - -declare const BuiltInConnectors: { - readonly WebSearch: "web_search"; - readonly WebSearchPremium: "web_search_premium"; - readonly CodeInterpreter: "code_interpreter"; - readonly ImageGeneration: "image_generation"; - readonly DocumentLibrary: "document_library"; -}; - -declare type BuiltInConnectors = ClosedEnum; - -declare class Chat extends ClientSDK { - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - parse(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - parseStream(request: ParsedChatCompletionRequest, options?: RequestOptions): Promise>; - /** - * Chat Completion - */ - complete(request: components.ChatCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.ChatCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatClassificationRequest$ { - /** @deprecated use `ChatClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatClassificationRequest$Outbound` instead. */ - type Outbound = ChatClassificationRequest$Outbound; -} - -/** @internal */ -declare const ChatClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatClassificationRequest$Outbound = { - model: string; - input: Inputs$Outbound; -}; - -/** @internal */ -declare const ChatClassificationRequest$outboundSchema: z.ZodType; - -declare type ChatClassificationRequest = { - model: string; - /** - * Chat to classify - */ - inputs: Inputs; -}; - -declare function chatClassificationRequestFromJSON(jsonString: string): Result; - -declare function chatClassificationRequestToJSON(chatClassificationRequest: ChatClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - type Outbound = ChatCompletionChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -declare const ChatCompletionChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: FinishReason; -}; - -declare function chatCompletionChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionChoiceToJSON(chatCompletionChoice: ChatCompletionChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - type Outbound = ChatCompletionRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionRequestFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToJSON(chatCompletionRequest: ChatCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionRequestToolChoiceToJSON(chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - type Outbound = ChatCompletionResponse$Outbound; -} - -/** @internal */ -declare const ChatCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const ChatCompletionResponse$outboundSchema: z.ZodType; - -declare type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function chatCompletionResponseFromJSON(jsonString: string): Result; - -declare function chatCompletionResponseToJSON(chatCompletionResponse: ChatCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -declare const ChatCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -declare function chatCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestMessages$ { - /** @deprecated use `ChatCompletionStreamRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestMessages$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestMessages$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const ChatCompletionStreamRequestMessages$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function chatCompletionStreamRequestMessagesFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestMessagesToJSON(chatCompletionStreamRequestMessages: ChatCompletionStreamRequestMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestStop$ { - /** @deprecated use `ChatCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const ChatCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type ChatCompletionStreamRequestStop = string | Array; - -declare function chatCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestStopToJSON(chatCompletionStreamRequestStop: ChatCompletionStreamRequestStop): string; - -declare function chatCompletionStreamRequestToJSON(chatCompletionStreamRequest: ChatCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatCompletionStreamRequestToolChoice$Outbound = ToolChoice$Outbound | string; - -/** @internal */ -declare const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType; - -declare type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -declare function chatCompletionStreamRequestToolChoiceFromJSON(jsonString: string): Result; - -declare function chatCompletionStreamRequestToolChoiceToJSON(chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequest$ { - /** @deprecated use `ChatModerationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequest$Outbound` instead. */ - type Outbound = ChatModerationRequest$Outbound; -} - -/** @internal */ -declare const ChatModerationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequest$Outbound = { - input: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })> | Array>; - model: string; -}; - -/** @internal */ -declare const ChatModerationRequest$outboundSchema: z.ZodType; - -declare type ChatModerationRequest = { - /** - * Chat to classify - */ - inputs: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })> | Array>; - model: string; -}; - -declare function chatModerationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ChatModerationRequestInputs$ { - /** @deprecated use `ChatModerationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ChatModerationRequestInputs$Outbound` instead. */ - type Outbound = ChatModerationRequestInputs$Outbound; -} - -/** @internal */ -declare const ChatModerationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ChatModerationRequestInputs$Outbound = Array<(SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -})> | Array>; - -/** @internal */ -declare const ChatModerationRequestInputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type ChatModerationRequestInputs = Array<(SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -})> | Array>; - -declare function chatModerationRequestInputsFromJSON(jsonString: string): Result; - -declare function chatModerationRequestInputsToJSON(chatModerationRequestInputs: ChatModerationRequestInputs): string; - -declare function chatModerationRequestToJSON(chatModerationRequest: ChatModerationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CheckpointOut$ { - /** @deprecated use `CheckpointOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CheckpointOut$Outbound` instead. */ - type Outbound = CheckpointOut$Outbound; -} - -/** @internal */ -declare const CheckpointOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CheckpointOut$Outbound = { - metrics: MetricOut$Outbound; - step_number: number; - created_at: number; -}; - -/** @internal */ -declare const CheckpointOut$outboundSchema: z.ZodType; - -declare type CheckpointOut = { - /** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ - metrics: MetricOut; - /** - * The step number that the checkpoint was created at. - */ - stepNumber: number; - /** - * The UNIX timestamp (in seconds) for when the checkpoint was created. - */ - createdAt: number; -}; - -declare function checkpointOutFromJSON(jsonString: string): Result; - -declare function checkpointOutToJSON(checkpointOut: CheckpointOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequest$ { - /** @deprecated use `ClassificationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequest$Outbound` instead. */ - type Outbound = ClassificationRequest$Outbound; -} - -/** @internal */ -declare const ClassificationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequest$Outbound = { - model: string; - input: string | Array; -}; - -/** @internal */ -declare const ClassificationRequest$outboundSchema: z.ZodType; - -declare type ClassificationRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to classify. - */ - inputs: string | Array; -}; - -declare function classificationRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationRequestInputs$ { - /** @deprecated use `ClassificationRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationRequestInputs$Outbound` instead. */ - type Outbound = ClassificationRequestInputs$Outbound; -} - -/** @internal */ -declare const ClassificationRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const ClassificationRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to classify. - */ -declare type ClassificationRequestInputs = string | Array; - -declare function classificationRequestInputsFromJSON(jsonString: string): Result; - -declare function classificationRequestInputsToJSON(classificationRequestInputs: ClassificationRequestInputs): string; - -declare function classificationRequestToJSON(classificationRequest: ClassificationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationResponse$ { - /** @deprecated use `ClassificationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationResponse$Outbound` instead. */ - type Outbound = ClassificationResponse$Outbound; -} - -/** @internal */ -declare const ClassificationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationResponse$Outbound = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult$Outbound; - }>; -}; - -/** @internal */ -declare const ClassificationResponse$outboundSchema: z.ZodType; - -declare type ClassificationResponse = { - id: string; - model: string; - results: Array<{ - [k: string]: ClassificationTargetResult; - }>; -}; - -declare function classificationResponseFromJSON(jsonString: string): Result; - -declare function classificationResponseToJSON(classificationResponse: ClassificationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassificationTargetResult$ { - /** @deprecated use `ClassificationTargetResult$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassificationTargetResult$Outbound` instead. */ - type Outbound = ClassificationTargetResult$Outbound; -} - -/** @internal */ -declare const ClassificationTargetResult$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassificationTargetResult$Outbound = { - scores: { - [k: string]: number; - }; -}; - -/** @internal */ -declare const ClassificationTargetResult$outboundSchema: z.ZodType; - -declare type ClassificationTargetResult = { - scores: { - [k: string]: number; - }; -}; - -declare function classificationTargetResultFromJSON(jsonString: string): Result; - -declare function classificationTargetResultToJSON(classificationTargetResult: ClassificationTargetResult): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOut$ { - /** @deprecated use `ClassifierDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOut$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; - events?: Array | undefined; - checkpoints?: Array | undefined; - classifier_targets: Array; -}; - -/** @internal */ -declare const ClassifierDetailedJobOut$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: ClassifierDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: ClassifierDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: ClassifierDetailedJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; - classifierTargets: Array; -}; - -declare function classifierDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutIntegrations$ { - /** @deprecated use `ClassifierDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function classifierDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierDetailedJobOutIntegrationsToJSON(classifierDetailedJobOutIntegrations: ClassifierDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutJobType$ { - /** @deprecated use `ClassifierDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutJobType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutObject$ { - /** @deprecated use `ClassifierDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type ClassifierDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierDetailedJobOutStatus$ { - /** @deprecated use `ClassifierDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type ClassifierDetailedJobOutStatus = ClosedEnum; - -declare function classifierDetailedJobOutToJSON(classifierDetailedJobOut: ClassifierDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOut$ { - /** @deprecated use `ClassifierFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierFTModelOut$Outbound` instead. */ - type Outbound = ClassifierFTModelOut$Outbound; -} - -/** @internal */ -declare const ClassifierFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - classifier_targets: Array; - model_type: string; -}; - -/** @internal */ -declare const ClassifierFTModelOut$outboundSchema: z.ZodType; - -declare type ClassifierFTModelOut = { - id: string; - object?: ClassifierFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - classifierTargets: Array; - modelType?: ClassifierFTModelOutModelType | undefined; -}; - -declare function classifierFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutModelType$ { - /** @deprecated use `ClassifierFTModelOutModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierFTModelOutModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutModelType$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutModelType: { - readonly Classifier: "classifier"; -}; - -declare type ClassifierFTModelOutModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierFTModelOutObject$ { - /** @deprecated use `ClassifierFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `ClassifierFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const ClassifierFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const ClassifierFTModelOutObject: { - readonly Model: "model"; -}; - -declare type ClassifierFTModelOutObject = ClosedEnum; - -declare function classifierFTModelOutToJSON(classifierFTModelOut: ClassifierFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOut$ { - /** @deprecated use `ClassifierJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOut$Outbound` instead. */ - type Outbound = ClassifierJobOut$Outbound; -} - -/** @internal */ -declare const ClassifierJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; -}; - -/** @internal */ -declare const ClassifierJobOut$outboundSchema: z.ZodType; - -declare type ClassifierJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: ClassifierJobOutStatus; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: ClassifierJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: ClassifierJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; -}; - -declare function classifierJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutIntegrations$ { - /** @deprecated use `ClassifierJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierJobOutIntegrations$Outbound` instead. */ - type Outbound = ClassifierJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const ClassifierJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const ClassifierJobOutIntegrations$outboundSchema: z.ZodType; - -declare type ClassifierJobOutIntegrations = WandbIntegrationOut; - -declare function classifierJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function classifierJobOutIntegrationsToJSON(classifierJobOutIntegrations: ClassifierJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutJobType$ { - /** @deprecated use `ClassifierJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; - /** @deprecated use `ClassifierJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutJobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const ClassifierJobOutJobType: { - readonly Classifier: "classifier"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type ClassifierJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutObject$ { - /** @deprecated use `ClassifierJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `ClassifierJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const ClassifierJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type ClassifierJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierJobOutStatus$ { - /** @deprecated use `ClassifierJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `ClassifierJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const ClassifierJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ClassifierJobOutStatus$outboundSchema: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const ClassifierJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type ClassifierJobOutStatus = ClosedEnum; - -declare function classifierJobOutToJSON(classifierJobOut: ClassifierJobOut): string; - -declare class Classifiers extends ClientSDK { - /** - * Moderations - */ - moderate(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Moderations - */ - moderateChat(request: components.ChatModerationRequest, options?: RequestOptions): Promise; - /** - * Classifications - */ - classify(request: components.ClassificationRequest, options?: RequestOptions): Promise; - /** - * Chat Classifications - */ - classifyChat(request: components.ChatClassificationRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetIn$ { - /** @deprecated use `ClassifierTargetIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetIn$Outbound` instead. */ - type Outbound = ClassifierTargetIn$Outbound; -} - -/** @internal */ -declare const ClassifierTargetIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetIn$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function?: string | null | undefined; -}; - -/** @internal */ -declare const ClassifierTargetIn$outboundSchema: z.ZodType; - -declare type ClassifierTargetIn = { - name: string; - labels: Array; - weight?: number | undefined; - lossFunction?: FTClassifierLossFunction | null | undefined; -}; - -declare function classifierTargetInFromJSON(jsonString: string): Result; - -declare function classifierTargetInToJSON(classifierTargetIn: ClassifierTargetIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTargetOut$ { - /** @deprecated use `ClassifierTargetOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTargetOut$Outbound` instead. */ - type Outbound = ClassifierTargetOut$Outbound; -} - -/** @internal */ -declare const ClassifierTargetOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTargetOut$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function: string; -}; - -/** @internal */ -declare const ClassifierTargetOut$outboundSchema: z.ZodType; - -declare type ClassifierTargetOut = { - name: string; - labels: Array; - weight: number; - lossFunction: FTClassifierLossFunction; -}; - -declare function classifierTargetOutFromJSON(jsonString: string): Result; - -declare function classifierTargetOutToJSON(classifierTargetOut: ClassifierTargetOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParameters$ { - /** @deprecated use `ClassifierTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParameters$Outbound` instead. */ - type Outbound = ClassifierTrainingParameters$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParameters$outboundSchema: z.ZodType; - -declare type ClassifierTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ClassifierTrainingParametersIn$ { - /** @deprecated use `ClassifierTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ClassifierTrainingParametersIn$Outbound` instead. */ - type Outbound = ClassifierTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const ClassifierTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type ClassifierTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -declare const ClassifierTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a classifier fine-tune job. - */ -declare type ClassifierTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -declare function classifierTrainingParametersInFromJSON(jsonString: string): Result; - -declare function classifierTrainingParametersInToJSON(classifierTrainingParametersIn: ClassifierTrainingParametersIn): string; - -declare function classifierTrainingParametersToJSON(classifierTrainingParameters: ClassifierTrainingParameters): string; - -declare class ClientSDK { - #private; - readonly _baseURL: URL | null; - readonly _options: SDKOptions & { - hooks?: SDKHooks; - }; - constructor(options?: SDKOptions); - _createRequest(context: HookContext, conf: RequestConfig, options?: RequestOptions): Result; - _do(request: Request, options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }): Promise>; -} - -declare type ClosedEnum = T[keyof T]; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterTool$ { - /** @deprecated use `CodeInterpreterTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CodeInterpreterTool$Outbound` instead. */ - type Outbound = CodeInterpreterTool$Outbound; -} - -/** @internal */ -declare const CodeInterpreterTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type CodeInterpreterTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const CodeInterpreterTool$outboundSchema: z.ZodType; - -declare type CodeInterpreterTool = { - type?: CodeInterpreterToolType | undefined; -}; - -declare function codeInterpreterToolFromJSON(jsonString: string): Result; - -declare function codeInterpreterToolToJSON(codeInterpreterTool: CodeInterpreterTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CodeInterpreterToolType$ { - /** @deprecated use `CodeInterpreterToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; - /** @deprecated use `CodeInterpreterToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly CodeInterpreter: "code_interpreter"; - }>; -} - -/** @internal */ -declare const CodeInterpreterToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CodeInterpreterToolType$outboundSchema: z.ZodNativeEnum; - -declare const CodeInterpreterToolType: { - readonly CodeInterpreter: "code_interpreter"; -}; - -declare type CodeInterpreterToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgs$ { - /** @deprecated use `CompletionArgs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgs$Outbound` instead. */ - type Outbound = CompletionArgs$Outbound; -} - -/** @internal */ -declare const CompletionArgs$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgs$Outbound = { - stop?: CompletionArgsStop$Outbound | null | undefined; - presence_penalty?: number | null | undefined; - frequency_penalty?: number | null | undefined; - temperature?: number | null | undefined; - top_p?: number | null | undefined; - max_tokens?: number | null | undefined; - random_seed?: number | null | undefined; - prediction?: Prediction$Outbound | null | undefined; - response_format?: ResponseFormat$Outbound | null | undefined; - tool_choice?: string | undefined; -}; - -/** @internal */ -declare const CompletionArgs$outboundSchema: z.ZodType; - -/** - * White-listed arguments from the completion API - */ -declare type CompletionArgs = { - stop?: CompletionArgsStop | null | undefined; - presencePenalty?: number | null | undefined; - frequencyPenalty?: number | null | undefined; - temperature?: number | null | undefined; - topP?: number | null | undefined; - maxTokens?: number | null | undefined; - randomSeed?: number | null | undefined; - prediction?: Prediction | null | undefined; - responseFormat?: ResponseFormat | null | undefined; - toolChoice?: ToolChoiceEnum | undefined; -}; - -declare function completionArgsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionArgsStop$ { - /** @deprecated use `CompletionArgsStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionArgsStop$Outbound` instead. */ - type Outbound = CompletionArgsStop$Outbound; -} - -/** @internal */ -declare const CompletionArgsStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionArgsStop$Outbound = string | Array; - -/** @internal */ -declare const CompletionArgsStop$outboundSchema: z.ZodType; - -declare type CompletionArgsStop = string | Array; - -declare function completionArgsStopFromJSON(jsonString: string): Result; - -declare function completionArgsStopToJSON(completionArgsStop: CompletionArgsStop): string; - -declare function completionArgsToJSON(completionArgs: CompletionArgs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - type Outbound = CompletionChunk$Outbound; -} - -/** @internal */ -declare const CompletionChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -declare const CompletionChunk$outboundSchema: z.ZodType; - -declare type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -declare function completionChunkFromJSON(jsonString: string): Result; - -declare function completionChunkToJSON(completionChunk: CompletionChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOut$ { - /** @deprecated use `CompletionDetailedJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOut$Outbound` instead. */ - type Outbound = CompletionDetailedJobOut$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -/** @internal */ -declare const CompletionDetailedJobOut$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: CompletionDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: CompletionDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: CompletionDetailedJobOutJobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -declare function completionDetailedJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutIntegrations$ { - /** @deprecated use `CompletionDetailedJobOutIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutIntegrations$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutIntegrations$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutIntegrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutIntegrations$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutIntegrations = WandbIntegrationOut; - -declare function completionDetailedJobOutIntegrationsFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutIntegrationsToJSON(completionDetailedJobOutIntegrations: CompletionDetailedJobOutIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutJobType$ { - /** @deprecated use `CompletionDetailedJobOutJobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `CompletionDetailedJobOutJobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutJobType: { - readonly Completion: "completion"; -}; - -declare type CompletionDetailedJobOutJobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutObject$ { - /** @deprecated use `CompletionDetailedJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionDetailedJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutObject: { - readonly Job: "job"; -}; - -declare type CompletionDetailedJobOutObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutRepositories$ { - /** @deprecated use `CompletionDetailedJobOutRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionDetailedJobOutRepositories$Outbound` instead. */ - type Outbound = CompletionDetailedJobOutRepositories$Outbound; -} - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionDetailedJobOutRepositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const CompletionDetailedJobOutRepositories$outboundSchema: z.ZodType; - -declare type CompletionDetailedJobOutRepositories = GithubRepositoryOut; - -declare function completionDetailedJobOutRepositoriesFromJSON(jsonString: string): Result; - -declare function completionDetailedJobOutRepositoriesToJSON(completionDetailedJobOutRepositories: CompletionDetailedJobOutRepositories): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionDetailedJobOutStatus$ { - /** @deprecated use `CompletionDetailedJobOutStatus$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `CompletionDetailedJobOutStatus$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const CompletionDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum; - -declare const CompletionDetailedJobOutStatus: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -declare type CompletionDetailedJobOutStatus = ClosedEnum; - -declare function completionDetailedJobOutToJSON(completionDetailedJobOut: CompletionDetailedJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - type Outbound = CompletionEvent$Outbound; -} - -/** @internal */ -declare const CompletionEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -declare const CompletionEvent$outboundSchema: z.ZodType; - -declare type CompletionEvent = { - data: CompletionChunk; -}; - -declare function completionEventFromJSON(jsonString: string): Result; - -declare function completionEventToJSON(completionEvent: CompletionEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOut$ { - /** @deprecated use `CompletionFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionFTModelOut$Outbound` instead. */ - type Outbound = CompletionFTModelOut$Outbound; -} - -/** @internal */ -declare const CompletionFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - model_type: string; -}; - -/** @internal */ -declare const CompletionFTModelOut$outboundSchema: z.ZodType; - -declare type CompletionFTModelOut = { - id: string; - object?: CompletionFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - modelType?: ModelType | undefined; -}; - -declare function completionFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionFTModelOutObject$ { - /** @deprecated use `CompletionFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `CompletionFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const CompletionFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const CompletionFTModelOutObject: { - readonly Model: "model"; -}; - -declare type CompletionFTModelOutObject = ClosedEnum; - -declare function completionFTModelOutToJSON(completionFTModelOut: CompletionFTModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOut$ { - /** @deprecated use `CompletionJobOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionJobOut$Outbound` instead. */ - type Outbound = CompletionJobOut$Outbound; -} - -/** @internal */ -declare const CompletionJobOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; -}; - -/** @internal */ -declare const CompletionJobOut$outboundSchema: z.ZodType; - -declare type CompletionJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: Status; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: CompletionJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: JobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; -}; - -declare function completionJobOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionJobOutObject$ { - /** @deprecated use `CompletionJobOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; - /** @deprecated use `CompletionJobOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Job: "job"; - }>; -} - -/** @internal */ -declare const CompletionJobOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const CompletionJobOutObject$outboundSchema: z.ZodNativeEnum; - -/** - * The object type of the fine-tuning job. - */ -declare const CompletionJobOutObject: { - readonly Job: "job"; -}; - -/** - * The object type of the fine-tuning job. - */ -declare type CompletionJobOutObject = ClosedEnum; - -declare function completionJobOutToJSON(completionJobOut: CompletionJobOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - type Outbound = CompletionResponseStreamChoice$Outbound; -} - -/** @internal */ -declare const CompletionResponseStreamChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -declare const CompletionResponseStreamChoice$outboundSchema: z.ZodType; - -declare type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: CompletionResponseStreamChoiceFinishReason | null; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionResponseStreamChoiceFinishReason$ { - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const CompletionResponseStreamChoiceFinishReason$outboundSchema: z.ZodType; - -declare const CompletionResponseStreamChoiceFinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type CompletionResponseStreamChoiceFinishReason = OpenEnum; - -declare function completionResponseStreamChoiceFromJSON(jsonString: string): Result; - -declare function completionResponseStreamChoiceToJSON(completionResponseStreamChoice: CompletionResponseStreamChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParameters$ { - /** @deprecated use `CompletionTrainingParameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParameters$Outbound` instead. */ - type Outbound = CompletionTrainingParameters$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParameters$outboundSchema: z.ZodType; - -declare type CompletionTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace CompletionTrainingParametersIn$ { - /** @deprecated use `CompletionTrainingParametersIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `CompletionTrainingParametersIn$Outbound` instead. */ - type Outbound = CompletionTrainingParametersIn$Outbound; -} - -/** @internal */ -declare const CompletionTrainingParametersIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type CompletionTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -declare const CompletionTrainingParametersIn$outboundSchema: z.ZodType; - -/** - * The fine-tuning hyperparameter settings used in a fine-tune job. - */ -declare type CompletionTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -declare function completionTrainingParametersInFromJSON(jsonString: string): Result; - -declare function completionTrainingParametersInToJSON(completionTrainingParametersIn: CompletionTrainingParametersIn): string; - -declare function completionTrainingParametersToJSON(completionTrainingParameters: CompletionTrainingParameters): string; - -declare namespace components { - export { - agentToolsToJSON, - agentToolsFromJSON, - agentToJSON, - agentFromJSON, - AgentTools, - AgentObject, - Agent, - AgentTools$inboundSchema, - AgentTools$Outbound, - AgentTools$outboundSchema, - AgentTools$, - AgentObject$inboundSchema, - AgentObject$outboundSchema, - AgentObject$, - Agent$inboundSchema, - Agent$Outbound, - Agent$outboundSchema, - Agent$, - agentConversationToJSON, - agentConversationFromJSON, - AgentConversationObject, - AgentConversation, - AgentConversationObject$inboundSchema, - AgentConversationObject$outboundSchema, - AgentConversationObject$, - AgentConversation$inboundSchema, - AgentConversation$Outbound, - AgentConversation$outboundSchema, - AgentConversation$, - agentCreationRequestToolsToJSON, - agentCreationRequestToolsFromJSON, - agentCreationRequestToJSON, - agentCreationRequestFromJSON, - AgentCreationRequestTools, - AgentCreationRequest, - AgentCreationRequestTools$inboundSchema, - AgentCreationRequestTools$Outbound, - AgentCreationRequestTools$outboundSchema, - AgentCreationRequestTools$, - AgentCreationRequest$inboundSchema, - AgentCreationRequest$Outbound, - AgentCreationRequest$outboundSchema, - AgentCreationRequest$, - agentHandoffDoneEventToJSON, - agentHandoffDoneEventFromJSON, - AgentHandoffDoneEventType, - AgentHandoffDoneEvent, - AgentHandoffDoneEventType$inboundSchema, - AgentHandoffDoneEventType$outboundSchema, - AgentHandoffDoneEventType$, - AgentHandoffDoneEvent$inboundSchema, - AgentHandoffDoneEvent$Outbound, - AgentHandoffDoneEvent$outboundSchema, - AgentHandoffDoneEvent$, - agentHandoffEntryToJSON, - agentHandoffEntryFromJSON, - AgentHandoffEntryObject, - AgentHandoffEntryType, - AgentHandoffEntry, - AgentHandoffEntryObject$inboundSchema, - AgentHandoffEntryObject$outboundSchema, - AgentHandoffEntryObject$, - AgentHandoffEntryType$inboundSchema, - AgentHandoffEntryType$outboundSchema, - AgentHandoffEntryType$, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, - AgentHandoffEntry$, - agentHandoffStartedEventToJSON, - agentHandoffStartedEventFromJSON, - AgentHandoffStartedEventType, - AgentHandoffStartedEvent, - AgentHandoffStartedEventType$inboundSchema, - AgentHandoffStartedEventType$outboundSchema, - AgentHandoffStartedEventType$, - AgentHandoffStartedEvent$inboundSchema, - AgentHandoffStartedEvent$Outbound, - AgentHandoffStartedEvent$outboundSchema, - AgentHandoffStartedEvent$, - agentsCompletionRequestStopToJSON, - agentsCompletionRequestStopFromJSON, - agentsCompletionRequestMessagesToJSON, - agentsCompletionRequestMessagesFromJSON, - agentsCompletionRequestToolChoiceToJSON, - agentsCompletionRequestToolChoiceFromJSON, - agentsCompletionRequestToJSON, - agentsCompletionRequestFromJSON, - AgentsCompletionRequestStop, - AgentsCompletionRequestMessages, - AgentsCompletionRequestToolChoice, - AgentsCompletionRequest, - AgentsCompletionRequestStop$inboundSchema, - AgentsCompletionRequestStop$Outbound, - AgentsCompletionRequestStop$outboundSchema, - AgentsCompletionRequestStop$, - AgentsCompletionRequestMessages$inboundSchema, - AgentsCompletionRequestMessages$Outbound, - AgentsCompletionRequestMessages$outboundSchema, - AgentsCompletionRequestMessages$, - AgentsCompletionRequestToolChoice$inboundSchema, - AgentsCompletionRequestToolChoice$Outbound, - AgentsCompletionRequestToolChoice$outboundSchema, - AgentsCompletionRequestToolChoice$, - AgentsCompletionRequest$inboundSchema, - AgentsCompletionRequest$Outbound, - AgentsCompletionRequest$outboundSchema, - AgentsCompletionRequest$, - agentsCompletionStreamRequestStopToJSON, - agentsCompletionStreamRequestStopFromJSON, - agentsCompletionStreamRequestMessagesToJSON, - agentsCompletionStreamRequestMessagesFromJSON, - agentsCompletionStreamRequestToolChoiceToJSON, - agentsCompletionStreamRequestToolChoiceFromJSON, - agentsCompletionStreamRequestToJSON, - agentsCompletionStreamRequestFromJSON, - AgentsCompletionStreamRequestStop, - AgentsCompletionStreamRequestMessages, - AgentsCompletionStreamRequestToolChoice, - AgentsCompletionStreamRequest, - AgentsCompletionStreamRequestStop$inboundSchema, - AgentsCompletionStreamRequestStop$Outbound, - AgentsCompletionStreamRequestStop$outboundSchema, - AgentsCompletionStreamRequestStop$, - AgentsCompletionStreamRequestMessages$inboundSchema, - AgentsCompletionStreamRequestMessages$Outbound, - AgentsCompletionStreamRequestMessages$outboundSchema, - AgentsCompletionStreamRequestMessages$, - AgentsCompletionStreamRequestToolChoice$inboundSchema, - AgentsCompletionStreamRequestToolChoice$Outbound, - AgentsCompletionStreamRequestToolChoice$outboundSchema, - AgentsCompletionStreamRequestToolChoice$, - AgentsCompletionStreamRequest$inboundSchema, - AgentsCompletionStreamRequest$Outbound, - AgentsCompletionStreamRequest$outboundSchema, - AgentsCompletionStreamRequest$, - agentUpdateRequestToolsToJSON, - agentUpdateRequestToolsFromJSON, - agentUpdateRequestToJSON, - agentUpdateRequestFromJSON, - AgentUpdateRequestTools, - AgentUpdateRequest, - AgentUpdateRequestTools$inboundSchema, - AgentUpdateRequestTools$Outbound, - AgentUpdateRequestTools$outboundSchema, - AgentUpdateRequestTools$, - AgentUpdateRequest$inboundSchema, - AgentUpdateRequest$Outbound, - AgentUpdateRequest$outboundSchema, - AgentUpdateRequest$, - ApiEndpoint, - ApiEndpoint$inboundSchema, - ApiEndpoint$outboundSchema, - ApiEndpoint$, - archiveFTModelOutToJSON, - archiveFTModelOutFromJSON, - ArchiveFTModelOutObject, - ArchiveFTModelOut, - ArchiveFTModelOutObject$inboundSchema, - ArchiveFTModelOutObject$outboundSchema, - ArchiveFTModelOutObject$, - ArchiveFTModelOut$inboundSchema, - ArchiveFTModelOut$Outbound, - ArchiveFTModelOut$outboundSchema, - ArchiveFTModelOut$, - assistantMessageContentToJSON, - assistantMessageContentFromJSON, - assistantMessageToJSON, - assistantMessageFromJSON, - AssistantMessageContent, - AssistantMessageRole, - AssistantMessage, - AssistantMessageContent$inboundSchema, - AssistantMessageContent$Outbound, - AssistantMessageContent$outboundSchema, - AssistantMessageContent$, - AssistantMessageRole$inboundSchema, - AssistantMessageRole$outboundSchema, - AssistantMessageRole$, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, - AssistantMessage$, - audioChunkToJSON, - audioChunkFromJSON, - AudioChunkType, - AudioChunk, - AudioChunkType$inboundSchema, - AudioChunkType$outboundSchema, - AudioChunkType$, - AudioChunk$inboundSchema, - AudioChunk$Outbound, - AudioChunk$outboundSchema, - AudioChunk$, - audioTranscriptionRequestToJSON, - audioTranscriptionRequestFromJSON, - AudioTranscriptionRequest, - AudioTranscriptionRequest$inboundSchema, - AudioTranscriptionRequest$Outbound, - AudioTranscriptionRequest$outboundSchema, - AudioTranscriptionRequest$, - audioTranscriptionRequestStreamToJSON, - audioTranscriptionRequestStreamFromJSON, - AudioTranscriptionRequestStream, - AudioTranscriptionRequestStream$inboundSchema, - AudioTranscriptionRequestStream$Outbound, - AudioTranscriptionRequestStream$outboundSchema, - AudioTranscriptionRequestStream$, - baseModelCardToJSON, - baseModelCardFromJSON, - BaseModelCardType, - BaseModelCard, - BaseModelCardType$inboundSchema, - BaseModelCardType$outboundSchema, - BaseModelCardType$, - BaseModelCard$inboundSchema, - BaseModelCard$Outbound, - BaseModelCard$outboundSchema, - BaseModelCard$, - batchErrorToJSON, - batchErrorFromJSON, - BatchError, - BatchError$inboundSchema, - BatchError$Outbound, - BatchError$outboundSchema, - BatchError$, - batchJobInToJSON, - batchJobInFromJSON, - BatchJobIn, - BatchJobIn$inboundSchema, - BatchJobIn$Outbound, - BatchJobIn$outboundSchema, - BatchJobIn$, - batchJobOutToJSON, - batchJobOutFromJSON, - BatchJobOutObject, - BatchJobOut, - BatchJobOutObject$inboundSchema, - BatchJobOutObject$outboundSchema, - BatchJobOutObject$, - BatchJobOut$inboundSchema, - BatchJobOut$Outbound, - BatchJobOut$outboundSchema, - BatchJobOut$, - batchJobsOutToJSON, - batchJobsOutFromJSON, - BatchJobsOutObject, - BatchJobsOut, - BatchJobsOutObject$inboundSchema, - BatchJobsOutObject$outboundSchema, - BatchJobsOutObject$, - BatchJobsOut$inboundSchema, - BatchJobsOut$Outbound, - BatchJobsOut$outboundSchema, - BatchJobsOut$, - BatchJobStatus, - BatchJobStatus$inboundSchema, - BatchJobStatus$outboundSchema, - BatchJobStatus$, - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, - BuiltInConnectors$, - chatClassificationRequestToJSON, - chatClassificationRequestFromJSON, - ChatClassificationRequest, - ChatClassificationRequest$inboundSchema, - ChatClassificationRequest$Outbound, - ChatClassificationRequest$outboundSchema, - ChatClassificationRequest$, - chatCompletionChoiceToJSON, - chatCompletionChoiceFromJSON, - FinishReason, - ChatCompletionChoice, - FinishReason$inboundSchema, - FinishReason$outboundSchema, - FinishReason$, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, - ChatCompletionChoice$, - stopToJSON, - stopFromJSON, - messagesToJSON, - messagesFromJSON, - chatCompletionRequestToolChoiceToJSON, - chatCompletionRequestToolChoiceFromJSON, - chatCompletionRequestToJSON, - chatCompletionRequestFromJSON, - Stop, - Messages, - ChatCompletionRequestToolChoice, - ChatCompletionRequest, - Stop$inboundSchema, - Stop$Outbound, - Stop$outboundSchema, - Stop$, - Messages$inboundSchema, - Messages$Outbound, - Messages$outboundSchema, - Messages$, - ChatCompletionRequestToolChoice$inboundSchema, - ChatCompletionRequestToolChoice$Outbound, - ChatCompletionRequestToolChoice$outboundSchema, - ChatCompletionRequestToolChoice$, - ChatCompletionRequest$inboundSchema, - ChatCompletionRequest$Outbound, - ChatCompletionRequest$outboundSchema, - ChatCompletionRequest$, - chatCompletionResponseToJSON, - chatCompletionResponseFromJSON, - ChatCompletionResponse, - ChatCompletionResponse$inboundSchema, - ChatCompletionResponse$Outbound, - ChatCompletionResponse$outboundSchema, - ChatCompletionResponse$, - chatCompletionStreamRequestStopToJSON, - chatCompletionStreamRequestStopFromJSON, - chatCompletionStreamRequestMessagesToJSON, - chatCompletionStreamRequestMessagesFromJSON, - chatCompletionStreamRequestToolChoiceToJSON, - chatCompletionStreamRequestToolChoiceFromJSON, - chatCompletionStreamRequestToJSON, - chatCompletionStreamRequestFromJSON, - ChatCompletionStreamRequestStop, - ChatCompletionStreamRequestMessages, - ChatCompletionStreamRequestToolChoice, - ChatCompletionStreamRequest, - ChatCompletionStreamRequestStop$inboundSchema, - ChatCompletionStreamRequestStop$Outbound, - ChatCompletionStreamRequestStop$outboundSchema, - ChatCompletionStreamRequestStop$, - ChatCompletionStreamRequestMessages$inboundSchema, - ChatCompletionStreamRequestMessages$Outbound, - ChatCompletionStreamRequestMessages$outboundSchema, - ChatCompletionStreamRequestMessages$, - ChatCompletionStreamRequestToolChoice$inboundSchema, - ChatCompletionStreamRequestToolChoice$Outbound, - ChatCompletionStreamRequestToolChoice$outboundSchema, - ChatCompletionStreamRequestToolChoice$, - ChatCompletionStreamRequest$inboundSchema, - ChatCompletionStreamRequest$Outbound, - ChatCompletionStreamRequest$outboundSchema, - ChatCompletionStreamRequest$, - twoToJSON, - twoFromJSON, - oneToJSON, - oneFromJSON, - chatModerationRequestInputsToJSON, - chatModerationRequestInputsFromJSON, - chatModerationRequestToJSON, - chatModerationRequestFromJSON, - Two, - One, - ChatModerationRequestInputs, - ChatModerationRequest, - Two$inboundSchema, - Two$Outbound, - Two$outboundSchema, - Two$, - One$inboundSchema, - One$Outbound, - One$outboundSchema, - One$, - ChatModerationRequestInputs$inboundSchema, - ChatModerationRequestInputs$Outbound, - ChatModerationRequestInputs$outboundSchema, - ChatModerationRequestInputs$, - ChatModerationRequest$inboundSchema, - ChatModerationRequest$Outbound, - ChatModerationRequest$outboundSchema, - ChatModerationRequest$, - checkpointOutToJSON, - checkpointOutFromJSON, - CheckpointOut, - CheckpointOut$inboundSchema, - CheckpointOut$Outbound, - CheckpointOut$outboundSchema, - CheckpointOut$, - classificationRequestInputsToJSON, - classificationRequestInputsFromJSON, - classificationRequestToJSON, - classificationRequestFromJSON, - ClassificationRequestInputs, - ClassificationRequest, - ClassificationRequestInputs$inboundSchema, - ClassificationRequestInputs$Outbound, - ClassificationRequestInputs$outboundSchema, - ClassificationRequestInputs$, - ClassificationRequest$inboundSchema, - ClassificationRequest$Outbound, - ClassificationRequest$outboundSchema, - ClassificationRequest$, - classificationResponseToJSON, - classificationResponseFromJSON, - ClassificationResponse, - ClassificationResponse$inboundSchema, - ClassificationResponse$Outbound, - ClassificationResponse$outboundSchema, - ClassificationResponse$, - classificationTargetResultToJSON, - classificationTargetResultFromJSON, - ClassificationTargetResult, - ClassificationTargetResult$inboundSchema, - ClassificationTargetResult$Outbound, - ClassificationTargetResult$outboundSchema, - ClassificationTargetResult$, - classifierDetailedJobOutIntegrationsToJSON, - classifierDetailedJobOutIntegrationsFromJSON, - classifierDetailedJobOutToJSON, - classifierDetailedJobOutFromJSON, - ClassifierDetailedJobOutStatus, - ClassifierDetailedJobOutObject, - ClassifierDetailedJobOutIntegrations, - ClassifierDetailedJobOutJobType, - ClassifierDetailedJobOut, - ClassifierDetailedJobOutStatus$inboundSchema, - ClassifierDetailedJobOutStatus$outboundSchema, - ClassifierDetailedJobOutStatus$, - ClassifierDetailedJobOutObject$inboundSchema, - ClassifierDetailedJobOutObject$outboundSchema, - ClassifierDetailedJobOutObject$, - ClassifierDetailedJobOutIntegrations$inboundSchema, - ClassifierDetailedJobOutIntegrations$Outbound, - ClassifierDetailedJobOutIntegrations$outboundSchema, - ClassifierDetailedJobOutIntegrations$, - ClassifierDetailedJobOutJobType$inboundSchema, - ClassifierDetailedJobOutJobType$outboundSchema, - ClassifierDetailedJobOutJobType$, - ClassifierDetailedJobOut$inboundSchema, - ClassifierDetailedJobOut$Outbound, - ClassifierDetailedJobOut$outboundSchema, - ClassifierDetailedJobOut$, - classifierFTModelOutToJSON, - classifierFTModelOutFromJSON, - ClassifierFTModelOutObject, - ClassifierFTModelOutModelType, - ClassifierFTModelOut, - ClassifierFTModelOutObject$inboundSchema, - ClassifierFTModelOutObject$outboundSchema, - ClassifierFTModelOutObject$, - ClassifierFTModelOutModelType$inboundSchema, - ClassifierFTModelOutModelType$outboundSchema, - ClassifierFTModelOutModelType$, - ClassifierFTModelOut$inboundSchema, - ClassifierFTModelOut$Outbound, - ClassifierFTModelOut$outboundSchema, - ClassifierFTModelOut$, - classifierJobOutIntegrationsToJSON, - classifierJobOutIntegrationsFromJSON, - classifierJobOutToJSON, - classifierJobOutFromJSON, - ClassifierJobOutStatus, - ClassifierJobOutObject, - ClassifierJobOutIntegrations, - ClassifierJobOutJobType, - ClassifierJobOut, - ClassifierJobOutStatus$inboundSchema, - ClassifierJobOutStatus$outboundSchema, - ClassifierJobOutStatus$, - ClassifierJobOutObject$inboundSchema, - ClassifierJobOutObject$outboundSchema, - ClassifierJobOutObject$, - ClassifierJobOutIntegrations$inboundSchema, - ClassifierJobOutIntegrations$Outbound, - ClassifierJobOutIntegrations$outboundSchema, - ClassifierJobOutIntegrations$, - ClassifierJobOutJobType$inboundSchema, - ClassifierJobOutJobType$outboundSchema, - ClassifierJobOutJobType$, - ClassifierJobOut$inboundSchema, - ClassifierJobOut$Outbound, - ClassifierJobOut$outboundSchema, - ClassifierJobOut$, - classifierTargetInToJSON, - classifierTargetInFromJSON, - ClassifierTargetIn, - ClassifierTargetIn$inboundSchema, - ClassifierTargetIn$Outbound, - ClassifierTargetIn$outboundSchema, - ClassifierTargetIn$, - classifierTargetOutToJSON, - classifierTargetOutFromJSON, - ClassifierTargetOut, - ClassifierTargetOut$inboundSchema, - ClassifierTargetOut$Outbound, - ClassifierTargetOut$outboundSchema, - ClassifierTargetOut$, - classifierTrainingParametersToJSON, - classifierTrainingParametersFromJSON, - ClassifierTrainingParameters, - ClassifierTrainingParameters$inboundSchema, - ClassifierTrainingParameters$Outbound, - ClassifierTrainingParameters$outboundSchema, - ClassifierTrainingParameters$, - classifierTrainingParametersInToJSON, - classifierTrainingParametersInFromJSON, - ClassifierTrainingParametersIn, - ClassifierTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$Outbound, - ClassifierTrainingParametersIn$outboundSchema, - ClassifierTrainingParametersIn$, - codeInterpreterToolToJSON, - codeInterpreterToolFromJSON, - CodeInterpreterToolType, - CodeInterpreterTool, - CodeInterpreterToolType$inboundSchema, - CodeInterpreterToolType$outboundSchema, - CodeInterpreterToolType$, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, - CodeInterpreterTool$, - completionArgsToJSON, - completionArgsFromJSON, - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, - CompletionArgs$, - completionArgsStopToJSON, - completionArgsStopFromJSON, - CompletionArgsStop, - CompletionArgsStop$inboundSchema, - CompletionArgsStop$Outbound, - CompletionArgsStop$outboundSchema, - CompletionArgsStop$, - completionChunkToJSON, - completionChunkFromJSON, - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, - CompletionChunk$, - completionDetailedJobOutIntegrationsToJSON, - completionDetailedJobOutIntegrationsFromJSON, - completionDetailedJobOutRepositoriesToJSON, - completionDetailedJobOutRepositoriesFromJSON, - completionDetailedJobOutToJSON, - completionDetailedJobOutFromJSON, - CompletionDetailedJobOutStatus, - CompletionDetailedJobOutObject, - CompletionDetailedJobOutIntegrations, - CompletionDetailedJobOutJobType, - CompletionDetailedJobOutRepositories, - CompletionDetailedJobOut, - CompletionDetailedJobOutStatus$inboundSchema, - CompletionDetailedJobOutStatus$outboundSchema, - CompletionDetailedJobOutStatus$, - CompletionDetailedJobOutObject$inboundSchema, - CompletionDetailedJobOutObject$outboundSchema, - CompletionDetailedJobOutObject$, - CompletionDetailedJobOutIntegrations$inboundSchema, - CompletionDetailedJobOutIntegrations$Outbound, - CompletionDetailedJobOutIntegrations$outboundSchema, - CompletionDetailedJobOutIntegrations$, - CompletionDetailedJobOutJobType$inboundSchema, - CompletionDetailedJobOutJobType$outboundSchema, - CompletionDetailedJobOutJobType$, - CompletionDetailedJobOutRepositories$inboundSchema, - CompletionDetailedJobOutRepositories$Outbound, - CompletionDetailedJobOutRepositories$outboundSchema, - CompletionDetailedJobOutRepositories$, - CompletionDetailedJobOut$inboundSchema, - CompletionDetailedJobOut$Outbound, - CompletionDetailedJobOut$outboundSchema, - CompletionDetailedJobOut$, - completionEventToJSON, - completionEventFromJSON, - CompletionEvent, - CompletionEvent$inboundSchema, - CompletionEvent$Outbound, - CompletionEvent$outboundSchema, - CompletionEvent$, - completionFTModelOutToJSON, - completionFTModelOutFromJSON, - CompletionFTModelOutObject, - ModelType, - CompletionFTModelOut, - CompletionFTModelOutObject$inboundSchema, - CompletionFTModelOutObject$outboundSchema, - CompletionFTModelOutObject$, - ModelType$inboundSchema, - ModelType$outboundSchema, - ModelType$, - CompletionFTModelOut$inboundSchema, - CompletionFTModelOut$Outbound, - CompletionFTModelOut$outboundSchema, - CompletionFTModelOut$, - integrationsToJSON, - integrationsFromJSON, - repositoriesToJSON, - repositoriesFromJSON, - completionJobOutToJSON, - completionJobOutFromJSON, - Status, - CompletionJobOutObject, - Integrations, - JobType, - Repositories, - CompletionJobOut, - Status$inboundSchema, - Status$outboundSchema, - Status$, - CompletionJobOutObject$inboundSchema, - CompletionJobOutObject$outboundSchema, - CompletionJobOutObject$, - Integrations$inboundSchema, - Integrations$Outbound, - Integrations$outboundSchema, - Integrations$, - JobType$inboundSchema, - JobType$outboundSchema, - JobType$, - Repositories$inboundSchema, - Repositories$Outbound, - Repositories$outboundSchema, - Repositories$, - CompletionJobOut$inboundSchema, - CompletionJobOut$Outbound, - CompletionJobOut$outboundSchema, - CompletionJobOut$, - completionResponseStreamChoiceToJSON, - completionResponseStreamChoiceFromJSON, - CompletionResponseStreamChoiceFinishReason, - CompletionResponseStreamChoice, - CompletionResponseStreamChoiceFinishReason$inboundSchema, - CompletionResponseStreamChoiceFinishReason$outboundSchema, - CompletionResponseStreamChoiceFinishReason$, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, - CompletionResponseStreamChoice$, - completionTrainingParametersToJSON, - completionTrainingParametersFromJSON, - CompletionTrainingParameters, - CompletionTrainingParameters$inboundSchema, - CompletionTrainingParameters$Outbound, - CompletionTrainingParameters$outboundSchema, - CompletionTrainingParameters$, - completionTrainingParametersInToJSON, - completionTrainingParametersInFromJSON, - CompletionTrainingParametersIn, - CompletionTrainingParametersIn$inboundSchema, - CompletionTrainingParametersIn$Outbound, - CompletionTrainingParametersIn$outboundSchema, - CompletionTrainingParametersIn$, - contentChunkToJSON, - contentChunkFromJSON, - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, - ContentChunk$, - conversationAppendRequestToJSON, - conversationAppendRequestFromJSON, - ConversationAppendRequestHandoffExecution, - ConversationAppendRequest, - ConversationAppendRequestHandoffExecution$inboundSchema, - ConversationAppendRequestHandoffExecution$outboundSchema, - ConversationAppendRequestHandoffExecution$, - ConversationAppendRequest$inboundSchema, - ConversationAppendRequest$Outbound, - ConversationAppendRequest$outboundSchema, - ConversationAppendRequest$, - conversationAppendStreamRequestToJSON, - conversationAppendStreamRequestFromJSON, - ConversationAppendStreamRequestHandoffExecution, - ConversationAppendStreamRequest, - ConversationAppendStreamRequestHandoffExecution$inboundSchema, - ConversationAppendStreamRequestHandoffExecution$outboundSchema, - ConversationAppendStreamRequestHandoffExecution$, - ConversationAppendStreamRequest$inboundSchema, - ConversationAppendStreamRequest$Outbound, - ConversationAppendStreamRequest$outboundSchema, - ConversationAppendStreamRequest$, - conversationEventsDataToJSON, - conversationEventsDataFromJSON, - conversationEventsToJSON, - conversationEventsFromJSON, - ConversationEventsData, - ConversationEvents, - ConversationEventsData$inboundSchema, - ConversationEventsData$Outbound, - ConversationEventsData$outboundSchema, - ConversationEventsData$, - ConversationEvents$inboundSchema, - ConversationEvents$Outbound, - ConversationEvents$outboundSchema, - ConversationEvents$, - entriesToJSON, - entriesFromJSON, - conversationHistoryToJSON, - conversationHistoryFromJSON, - ConversationHistoryObject, - Entries, - ConversationHistory, - ConversationHistoryObject$inboundSchema, - ConversationHistoryObject$outboundSchema, - ConversationHistoryObject$, - Entries$inboundSchema, - Entries$Outbound, - Entries$outboundSchema, - Entries$, - ConversationHistory$inboundSchema, - ConversationHistory$Outbound, - ConversationHistory$outboundSchema, - ConversationHistory$, - conversationInputsToJSON, - conversationInputsFromJSON, - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, - ConversationInputs$, - conversationMessagesToJSON, - conversationMessagesFromJSON, - ConversationMessagesObject, - ConversationMessages, - ConversationMessagesObject$inboundSchema, - ConversationMessagesObject$outboundSchema, - ConversationMessagesObject$, - ConversationMessages$inboundSchema, - ConversationMessages$Outbound, - ConversationMessages$outboundSchema, - ConversationMessages$, - toolsToJSON, - toolsFromJSON, - conversationRequestToJSON, - conversationRequestFromJSON, - HandoffExecution, - Tools, - ConversationRequest, - HandoffExecution$inboundSchema, - HandoffExecution$outboundSchema, - HandoffExecution$, - Tools$inboundSchema, - Tools$Outbound, - Tools$outboundSchema, - Tools$, - ConversationRequest$inboundSchema, - ConversationRequest$Outbound, - ConversationRequest$outboundSchema, - ConversationRequest$, - outputsToJSON, - outputsFromJSON, - conversationResponseToJSON, - conversationResponseFromJSON, - ConversationResponseObject, - Outputs, - ConversationResponse, - ConversationResponseObject$inboundSchema, - ConversationResponseObject$outboundSchema, - ConversationResponseObject$, - Outputs$inboundSchema, - Outputs$Outbound, - Outputs$outboundSchema, - Outputs$, - ConversationResponse$inboundSchema, - ConversationResponse$Outbound, - ConversationResponse$outboundSchema, - ConversationResponse$, - conversationRestartRequestToJSON, - conversationRestartRequestFromJSON, - ConversationRestartRequestHandoffExecution, - ConversationRestartRequest, - ConversationRestartRequestHandoffExecution$inboundSchema, - ConversationRestartRequestHandoffExecution$outboundSchema, - ConversationRestartRequestHandoffExecution$, - ConversationRestartRequest$inboundSchema, - ConversationRestartRequest$Outbound, - ConversationRestartRequest$outboundSchema, - ConversationRestartRequest$, - conversationRestartStreamRequestToJSON, - conversationRestartStreamRequestFromJSON, - ConversationRestartStreamRequestHandoffExecution, - ConversationRestartStreamRequest, - ConversationRestartStreamRequestHandoffExecution$inboundSchema, - ConversationRestartStreamRequestHandoffExecution$outboundSchema, - ConversationRestartStreamRequestHandoffExecution$, - ConversationRestartStreamRequest$inboundSchema, - ConversationRestartStreamRequest$Outbound, - ConversationRestartStreamRequest$outboundSchema, - ConversationRestartStreamRequest$, - conversationStreamRequestToolsToJSON, - conversationStreamRequestToolsFromJSON, - conversationStreamRequestToJSON, - conversationStreamRequestFromJSON, - ConversationStreamRequestHandoffExecution, - ConversationStreamRequestTools, - ConversationStreamRequest, - ConversationStreamRequestHandoffExecution$inboundSchema, - ConversationStreamRequestHandoffExecution$outboundSchema, - ConversationStreamRequestHandoffExecution$, - ConversationStreamRequestTools$inboundSchema, - ConversationStreamRequestTools$Outbound, - ConversationStreamRequestTools$outboundSchema, - ConversationStreamRequestTools$, - ConversationStreamRequest$inboundSchema, - ConversationStreamRequest$Outbound, - ConversationStreamRequest$outboundSchema, - ConversationStreamRequest$, - conversationUsageInfoToJSON, - conversationUsageInfoFromJSON, - ConversationUsageInfo, - ConversationUsageInfo$inboundSchema, - ConversationUsageInfo$Outbound, - ConversationUsageInfo$outboundSchema, - ConversationUsageInfo$, - deleteFileOutToJSON, - deleteFileOutFromJSON, - DeleteFileOut, - DeleteFileOut$inboundSchema, - DeleteFileOut$Outbound, - DeleteFileOut$outboundSchema, - DeleteFileOut$, - deleteModelOutToJSON, - deleteModelOutFromJSON, - DeleteModelOut, - DeleteModelOut$inboundSchema, - DeleteModelOut$Outbound, - DeleteModelOut$outboundSchema, - DeleteModelOut$, - contentToJSON, - contentFromJSON, - deltaMessageToJSON, - deltaMessageFromJSON, - Content, - DeltaMessage, - Content$inboundSchema, - Content$Outbound, - Content$outboundSchema, - Content$, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, - DeltaMessage$, - documentLibraryToolToJSON, - documentLibraryToolFromJSON, - DocumentLibraryToolType, - DocumentLibraryTool, - DocumentLibraryToolType$inboundSchema, - DocumentLibraryToolType$outboundSchema, - DocumentLibraryToolType$, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, - DocumentLibraryTool$, - documentOutToJSON, - documentOutFromJSON, - DocumentOut, - DocumentOut$inboundSchema, - DocumentOut$Outbound, - DocumentOut$outboundSchema, - DocumentOut$, - documentTextContentToJSON, - documentTextContentFromJSON, - DocumentTextContent, - DocumentTextContent$inboundSchema, - DocumentTextContent$Outbound, - DocumentTextContent$outboundSchema, - DocumentTextContent$, - documentUpdateInToJSON, - documentUpdateInFromJSON, - DocumentUpdateIn, - DocumentUpdateIn$inboundSchema, - DocumentUpdateIn$Outbound, - DocumentUpdateIn$outboundSchema, - DocumentUpdateIn$, - documentURLChunkToJSON, - documentURLChunkFromJSON, - DocumentURLChunkType, - DocumentURLChunk, - DocumentURLChunkType$inboundSchema, - DocumentURLChunkType$outboundSchema, - DocumentURLChunkType$, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, - DocumentURLChunk$, - EmbeddingDtype, - EmbeddingDtype$inboundSchema, - EmbeddingDtype$outboundSchema, - EmbeddingDtype$, - embeddingRequestInputsToJSON, - embeddingRequestInputsFromJSON, - embeddingRequestToJSON, - embeddingRequestFromJSON, - EmbeddingRequestInputs, - EmbeddingRequest, - EmbeddingRequestInputs$inboundSchema, - EmbeddingRequestInputs$Outbound, - EmbeddingRequestInputs$outboundSchema, - EmbeddingRequestInputs$, - EmbeddingRequest$inboundSchema, - EmbeddingRequest$Outbound, - EmbeddingRequest$outboundSchema, - EmbeddingRequest$, - embeddingResponseToJSON, - embeddingResponseFromJSON, - EmbeddingResponse, - EmbeddingResponse$inboundSchema, - EmbeddingResponse$Outbound, - EmbeddingResponse$outboundSchema, - EmbeddingResponse$, - embeddingResponseDataToJSON, - embeddingResponseDataFromJSON, - EmbeddingResponseData, - EmbeddingResponseData$inboundSchema, - EmbeddingResponseData$Outbound, - EmbeddingResponseData$outboundSchema, - EmbeddingResponseData$, - EncodingFormat, - EncodingFormat$inboundSchema, - EncodingFormat$outboundSchema, - EncodingFormat$, - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, - EntityType$, - eventOutToJSON, - eventOutFromJSON, - EventOut, - EventOut$inboundSchema, - EventOut$Outbound, - EventOut$outboundSchema, - EventOut$, - fileToJSON, - fileFromJSON, - FileT, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, - FileT$, - fileChunkToJSON, - fileChunkFromJSON, - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, - FileChunk$, - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, - FilePurpose$, - fileSchemaToJSON, - fileSchemaFromJSON, - FileSchema, - FileSchema$inboundSchema, - FileSchema$Outbound, - FileSchema$outboundSchema, - FileSchema$, - fileSignedURLToJSON, - fileSignedURLFromJSON, - FileSignedURL, - FileSignedURL$inboundSchema, - FileSignedURL$Outbound, - FileSignedURL$outboundSchema, - FileSignedURL$, - fimCompletionRequestStopToJSON, - fimCompletionRequestStopFromJSON, - fimCompletionRequestToJSON, - fimCompletionRequestFromJSON, - FIMCompletionRequestStop, - FIMCompletionRequest, - FIMCompletionRequestStop$inboundSchema, - FIMCompletionRequestStop$Outbound, - FIMCompletionRequestStop$outboundSchema, - FIMCompletionRequestStop$, - FIMCompletionRequest$inboundSchema, - FIMCompletionRequest$Outbound, - FIMCompletionRequest$outboundSchema, - FIMCompletionRequest$, - fimCompletionResponseToJSON, - fimCompletionResponseFromJSON, - FIMCompletionResponse, - FIMCompletionResponse$inboundSchema, - FIMCompletionResponse$Outbound, - FIMCompletionResponse$outboundSchema, - FIMCompletionResponse$, - fimCompletionStreamRequestStopToJSON, - fimCompletionStreamRequestStopFromJSON, - fimCompletionStreamRequestToJSON, - fimCompletionStreamRequestFromJSON, - FIMCompletionStreamRequestStop, - FIMCompletionStreamRequest, - FIMCompletionStreamRequestStop$inboundSchema, - FIMCompletionStreamRequestStop$Outbound, - FIMCompletionStreamRequestStop$outboundSchema, - FIMCompletionStreamRequestStop$, - FIMCompletionStreamRequest$inboundSchema, - FIMCompletionStreamRequest$Outbound, - FIMCompletionStreamRequest$outboundSchema, - FIMCompletionStreamRequest$, - FineTuneableModelType, - FineTuneableModelType$inboundSchema, - FineTuneableModelType$outboundSchema, - FineTuneableModelType$, - FTClassifierLossFunction, - FTClassifierLossFunction$inboundSchema, - FTClassifierLossFunction$outboundSchema, - FTClassifierLossFunction$, - ftModelCapabilitiesOutToJSON, - ftModelCapabilitiesOutFromJSON, - FTModelCapabilitiesOut, - FTModelCapabilitiesOut$inboundSchema, - FTModelCapabilitiesOut$Outbound, - FTModelCapabilitiesOut$outboundSchema, - FTModelCapabilitiesOut$, - ftModelCardToJSON, - ftModelCardFromJSON, - FTModelCardType, - FTModelCard, - FTModelCardType$inboundSchema, - FTModelCardType$outboundSchema, - FTModelCardType$, - FTModelCard$inboundSchema, - FTModelCard$Outbound, - FTModelCard$outboundSchema, - FTModelCard$, - functionToJSON, - functionFromJSON, - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, - FunctionT$, - argumentsToJSON, - argumentsFromJSON, - functionCallToJSON, - functionCallFromJSON, - Arguments, - FunctionCall, - Arguments$inboundSchema, - Arguments$Outbound, - Arguments$outboundSchema, - Arguments$, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, - FunctionCall$, - functionCallEntryToJSON, - functionCallEntryFromJSON, - FunctionCallEntryObject, - FunctionCallEntryType, - FunctionCallEntry, - FunctionCallEntryObject$inboundSchema, - FunctionCallEntryObject$outboundSchema, - FunctionCallEntryObject$, - FunctionCallEntryType$inboundSchema, - FunctionCallEntryType$outboundSchema, - FunctionCallEntryType$, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, - FunctionCallEntry$, - functionCallEntryArgumentsToJSON, - functionCallEntryArgumentsFromJSON, - FunctionCallEntryArguments, - FunctionCallEntryArguments$inboundSchema, - FunctionCallEntryArguments$Outbound, - FunctionCallEntryArguments$outboundSchema, - FunctionCallEntryArguments$, - functionCallEventToJSON, - functionCallEventFromJSON, - FunctionCallEventType, - FunctionCallEvent, - FunctionCallEventType$inboundSchema, - FunctionCallEventType$outboundSchema, - FunctionCallEventType$, - FunctionCallEvent$inboundSchema, - FunctionCallEvent$Outbound, - FunctionCallEvent$outboundSchema, - FunctionCallEvent$, - functionNameToJSON, - functionNameFromJSON, - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, - FunctionName$, - functionResultEntryToJSON, - functionResultEntryFromJSON, - FunctionResultEntryObject, - FunctionResultEntryType, - FunctionResultEntry, - FunctionResultEntryObject$inboundSchema, - FunctionResultEntryObject$outboundSchema, - FunctionResultEntryObject$, - FunctionResultEntryType$inboundSchema, - FunctionResultEntryType$outboundSchema, - FunctionResultEntryType$, - FunctionResultEntry$inboundSchema, - FunctionResultEntry$Outbound, - FunctionResultEntry$outboundSchema, - FunctionResultEntry$, - functionToolToJSON, - functionToolFromJSON, - FunctionToolType, - FunctionTool, - FunctionToolType$inboundSchema, - FunctionToolType$outboundSchema, - FunctionToolType$, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, - FunctionTool$, - githubRepositoryInToJSON, - githubRepositoryInFromJSON, - GithubRepositoryInType, - GithubRepositoryIn, - GithubRepositoryInType$inboundSchema, - GithubRepositoryInType$outboundSchema, - GithubRepositoryInType$, - GithubRepositoryIn$inboundSchema, - GithubRepositoryIn$Outbound, - GithubRepositoryIn$outboundSchema, - GithubRepositoryIn$, - githubRepositoryOutToJSON, - githubRepositoryOutFromJSON, - GithubRepositoryOutType, - GithubRepositoryOut, - GithubRepositoryOutType$inboundSchema, - GithubRepositoryOutType$outboundSchema, - GithubRepositoryOutType$, - GithubRepositoryOut$inboundSchema, - GithubRepositoryOut$Outbound, - GithubRepositoryOut$outboundSchema, - GithubRepositoryOut$, - imageGenerationToolToJSON, - imageGenerationToolFromJSON, - ImageGenerationToolType, - ImageGenerationTool, - ImageGenerationToolType$inboundSchema, - ImageGenerationToolType$outboundSchema, - ImageGenerationToolType$, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, - ImageGenerationTool$, - imageURLToJSON, - imageURLFromJSON, - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, - ImageURL$, - imageURLChunkImageURLToJSON, - imageURLChunkImageURLFromJSON, - imageURLChunkToJSON, - imageURLChunkFromJSON, - ImageURLChunkImageURL, - ImageURLChunkType, - ImageURLChunk, - ImageURLChunkImageURL$inboundSchema, - ImageURLChunkImageURL$Outbound, - ImageURLChunkImageURL$outboundSchema, - ImageURLChunkImageURL$, - ImageURLChunkType$inboundSchema, - ImageURLChunkType$outboundSchema, - ImageURLChunkType$, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, - ImageURLChunk$, - inputEntriesToJSON, - inputEntriesFromJSON, - InputEntries, - InputEntries$inboundSchema, - InputEntries$Outbound, - InputEntries$outboundSchema, - InputEntries$, - instructRequestInputsMessagesToJSON, - instructRequestInputsMessagesFromJSON, - instructRequestInputsToJSON, - instructRequestInputsFromJSON, - inputsToJSON, - inputsFromJSON, - InstructRequestInputsMessages, - InstructRequestInputs, - Inputs, - InstructRequestInputsMessages$inboundSchema, - InstructRequestInputsMessages$Outbound, - InstructRequestInputsMessages$outboundSchema, - InstructRequestInputsMessages$, - InstructRequestInputs$inboundSchema, - InstructRequestInputs$Outbound, - InstructRequestInputs$outboundSchema, - InstructRequestInputs$, - Inputs$inboundSchema, - Inputs$Outbound, - Inputs$outboundSchema, - Inputs$, - instructRequestMessagesToJSON, - instructRequestMessagesFromJSON, - instructRequestToJSON, - instructRequestFromJSON, - InstructRequestMessages, - InstructRequest, - InstructRequestMessages$inboundSchema, - InstructRequestMessages$Outbound, - InstructRequestMessages$outboundSchema, - InstructRequestMessages$, - InstructRequest$inboundSchema, - InstructRequest$Outbound, - InstructRequest$outboundSchema, - InstructRequest$, - jobInIntegrationsToJSON, - jobInIntegrationsFromJSON, - hyperparametersToJSON, - hyperparametersFromJSON, - jobInRepositoriesToJSON, - jobInRepositoriesFromJSON, - jobInToJSON, - jobInFromJSON, - JobInIntegrations, - Hyperparameters, - JobInRepositories, - JobIn, - JobInIntegrations$inboundSchema, - JobInIntegrations$Outbound, - JobInIntegrations$outboundSchema, - JobInIntegrations$, - Hyperparameters$inboundSchema, - Hyperparameters$Outbound, - Hyperparameters$outboundSchema, - Hyperparameters$, - JobInRepositories$inboundSchema, - JobInRepositories$Outbound, - JobInRepositories$outboundSchema, - JobInRepositories$, - JobIn$inboundSchema, - JobIn$Outbound, - JobIn$outboundSchema, - JobIn$, - jobMetadataOutToJSON, - jobMetadataOutFromJSON, - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, - JobMetadataOut$, - jobsOutDataToJSON, - jobsOutDataFromJSON, - jobsOutToJSON, - jobsOutFromJSON, - JobsOutData, - JobsOutObject, - JobsOut, - JobsOutData$inboundSchema, - JobsOutData$Outbound, - JobsOutData$outboundSchema, - JobsOutData$, - JobsOutObject$inboundSchema, - JobsOutObject$outboundSchema, - JobsOutObject$, - JobsOut$inboundSchema, - JobsOut$Outbound, - JobsOut$outboundSchema, - JobsOut$, - jsonSchemaToJSON, - jsonSchemaFromJSON, - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, - JsonSchema$, - legacyJobMetadataOutToJSON, - legacyJobMetadataOutFromJSON, - LegacyJobMetadataOutObject, - LegacyJobMetadataOut, - LegacyJobMetadataOutObject$inboundSchema, - LegacyJobMetadataOutObject$outboundSchema, - LegacyJobMetadataOutObject$, - LegacyJobMetadataOut$inboundSchema, - LegacyJobMetadataOut$Outbound, - LegacyJobMetadataOut$outboundSchema, - LegacyJobMetadataOut$, - libraryInToJSON, - libraryInFromJSON, - LibraryIn, - LibraryIn$inboundSchema, - LibraryIn$Outbound, - LibraryIn$outboundSchema, - LibraryIn$, - libraryInUpdateToJSON, - libraryInUpdateFromJSON, - LibraryInUpdate, - LibraryInUpdate$inboundSchema, - LibraryInUpdate$Outbound, - LibraryInUpdate$outboundSchema, - LibraryInUpdate$, - libraryOutToJSON, - libraryOutFromJSON, - LibraryOut, - LibraryOut$inboundSchema, - LibraryOut$Outbound, - LibraryOut$outboundSchema, - LibraryOut$, - listDocumentOutToJSON, - listDocumentOutFromJSON, - ListDocumentOut, - ListDocumentOut$inboundSchema, - ListDocumentOut$Outbound, - ListDocumentOut$outboundSchema, - ListDocumentOut$, - listFilesOutToJSON, - listFilesOutFromJSON, - ListFilesOut, - ListFilesOut$inboundSchema, - ListFilesOut$Outbound, - ListFilesOut$outboundSchema, - ListFilesOut$, - listLibraryOutToJSON, - listLibraryOutFromJSON, - ListLibraryOut, - ListLibraryOut$inboundSchema, - ListLibraryOut$Outbound, - ListLibraryOut$outboundSchema, - ListLibraryOut$, - listSharingOutToJSON, - listSharingOutFromJSON, - ListSharingOut, - ListSharingOut$inboundSchema, - ListSharingOut$Outbound, - ListSharingOut$outboundSchema, - ListSharingOut$, - messageEntriesToJSON, - messageEntriesFromJSON, - MessageEntries, - MessageEntries$inboundSchema, - MessageEntries$Outbound, - MessageEntries$outboundSchema, - MessageEntries$, - messageInputContentChunksToJSON, - messageInputContentChunksFromJSON, - MessageInputContentChunks, - MessageInputContentChunks$inboundSchema, - MessageInputContentChunks$Outbound, - MessageInputContentChunks$outboundSchema, - MessageInputContentChunks$, - messageInputEntryContentToJSON, - messageInputEntryContentFromJSON, - messageInputEntryToJSON, - messageInputEntryFromJSON, - ObjectT, - MessageInputEntryType, - MessageInputEntryRole, - MessageInputEntryContent, - MessageInputEntry, - ObjectT$inboundSchema, - ObjectT$outboundSchema, - ObjectT$, - MessageInputEntryType$inboundSchema, - MessageInputEntryType$outboundSchema, - MessageInputEntryType$, - MessageInputEntryRole$inboundSchema, - MessageInputEntryRole$outboundSchema, - MessageInputEntryRole$, - MessageInputEntryContent$inboundSchema, - MessageInputEntryContent$Outbound, - MessageInputEntryContent$outboundSchema, - MessageInputEntryContent$, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, - MessageInputEntry$, - messageOutputContentChunksToJSON, - messageOutputContentChunksFromJSON, - MessageOutputContentChunks, - MessageOutputContentChunks$inboundSchema, - MessageOutputContentChunks$Outbound, - MessageOutputContentChunks$outboundSchema, - MessageOutputContentChunks$, - messageOutputEntryContentToJSON, - messageOutputEntryContentFromJSON, - messageOutputEntryToJSON, - messageOutputEntryFromJSON, - MessageOutputEntryObject, - MessageOutputEntryType, - MessageOutputEntryRole, - MessageOutputEntryContent, - MessageOutputEntry, - MessageOutputEntryObject$inboundSchema, - MessageOutputEntryObject$outboundSchema, - MessageOutputEntryObject$, - MessageOutputEntryType$inboundSchema, - MessageOutputEntryType$outboundSchema, - MessageOutputEntryType$, - MessageOutputEntryRole$inboundSchema, - MessageOutputEntryRole$outboundSchema, - MessageOutputEntryRole$, - MessageOutputEntryContent$inboundSchema, - MessageOutputEntryContent$Outbound, - MessageOutputEntryContent$outboundSchema, - MessageOutputEntryContent$, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, - MessageOutputEntry$, - messageOutputEventContentToJSON, - messageOutputEventContentFromJSON, - messageOutputEventToJSON, - messageOutputEventFromJSON, - MessageOutputEventType, - MessageOutputEventRole, - MessageOutputEventContent, - MessageOutputEvent, - MessageOutputEventType$inboundSchema, - MessageOutputEventType$outboundSchema, - MessageOutputEventType$, - MessageOutputEventRole$inboundSchema, - MessageOutputEventRole$outboundSchema, - MessageOutputEventRole$, - MessageOutputEventContent$inboundSchema, - MessageOutputEventContent$Outbound, - MessageOutputEventContent$outboundSchema, - MessageOutputEventContent$, - MessageOutputEvent$inboundSchema, - MessageOutputEvent$Outbound, - MessageOutputEvent$outboundSchema, - MessageOutputEvent$, - metricOutToJSON, - metricOutFromJSON, - MetricOut, - MetricOut$inboundSchema, - MetricOut$Outbound, - MetricOut$outboundSchema, - MetricOut$, - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, - MistralPromptMode$, - modelCapabilitiesToJSON, - modelCapabilitiesFromJSON, - ModelCapabilities, - ModelCapabilities$inboundSchema, - ModelCapabilities$Outbound, - ModelCapabilities$outboundSchema, - ModelCapabilities$, - modelConversationToolsToJSON, - modelConversationToolsFromJSON, - modelConversationToJSON, - modelConversationFromJSON, - ModelConversationTools, - ModelConversationObject, - ModelConversation, - ModelConversationTools$inboundSchema, - ModelConversationTools$Outbound, - ModelConversationTools$outboundSchema, - ModelConversationTools$, - ModelConversationObject$inboundSchema, - ModelConversationObject$outboundSchema, - ModelConversationObject$, - ModelConversation$inboundSchema, - ModelConversation$Outbound, - ModelConversation$outboundSchema, - ModelConversation$, - dataToJSON, - dataFromJSON, - modelListToJSON, - modelListFromJSON, - Data, - ModelList, - Data$inboundSchema, - Data$Outbound, - Data$outboundSchema, - Data$, - ModelList$inboundSchema, - ModelList$Outbound, - ModelList$outboundSchema, - ModelList$, - moderationObjectToJSON, - moderationObjectFromJSON, - ModerationObject, - ModerationObject$inboundSchema, - ModerationObject$Outbound, - ModerationObject$outboundSchema, - ModerationObject$, - moderationResponseToJSON, - moderationResponseFromJSON, - ModerationResponse, - ModerationResponse$inboundSchema, - ModerationResponse$Outbound, - ModerationResponse$outboundSchema, - ModerationResponse$, - ocrImageObjectToJSON, - ocrImageObjectFromJSON, - OCRImageObject, - OCRImageObject$inboundSchema, - OCRImageObject$Outbound, - OCRImageObject$outboundSchema, - OCRImageObject$, - ocrPageDimensionsToJSON, - ocrPageDimensionsFromJSON, - OCRPageDimensions, - OCRPageDimensions$inboundSchema, - OCRPageDimensions$Outbound, - OCRPageDimensions$outboundSchema, - OCRPageDimensions$, - ocrPageObjectToJSON, - ocrPageObjectFromJSON, - OCRPageObject, - OCRPageObject$inboundSchema, - OCRPageObject$Outbound, - OCRPageObject$outboundSchema, - OCRPageObject$, - documentToJSON, - documentFromJSON, - ocrRequestToJSON, - ocrRequestFromJSON, - Document_2 as Document, - OCRRequest, - Document$inboundSchema, - Document$Outbound, - Document$outboundSchema, - Document$, - OCRRequest$inboundSchema, - OCRRequest$Outbound, - OCRRequest$outboundSchema, - OCRRequest$, - ocrResponseToJSON, - ocrResponseFromJSON, - OCRResponse, - OCRResponse$inboundSchema, - OCRResponse$Outbound, - OCRResponse$outboundSchema, - OCRResponse$, - ocrUsageInfoToJSON, - ocrUsageInfoFromJSON, - OCRUsageInfo, - OCRUsageInfo$inboundSchema, - OCRUsageInfo$Outbound, - OCRUsageInfo$outboundSchema, - OCRUsageInfo$, - outputContentChunksToJSON, - outputContentChunksFromJSON, - OutputContentChunks, - OutputContentChunks$inboundSchema, - OutputContentChunks$Outbound, - OutputContentChunks$outboundSchema, - OutputContentChunks$, - paginationInfoToJSON, - paginationInfoFromJSON, - PaginationInfo, - PaginationInfo$inboundSchema, - PaginationInfo$Outbound, - PaginationInfo$outboundSchema, - PaginationInfo$, - predictionToJSON, - predictionFromJSON, - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, - Prediction$, - processingStatusOutToJSON, - processingStatusOutFromJSON, - ProcessingStatusOut, - ProcessingStatusOut$inboundSchema, - ProcessingStatusOut$Outbound, - ProcessingStatusOut$outboundSchema, - ProcessingStatusOut$, - referenceChunkToJSON, - referenceChunkFromJSON, - ReferenceChunkType, - ReferenceChunk, - ReferenceChunkType$inboundSchema, - ReferenceChunkType$outboundSchema, - ReferenceChunkType$, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, - ReferenceChunk$, - responseDoneEventToJSON, - responseDoneEventFromJSON, - ResponseDoneEventType, - ResponseDoneEvent, - ResponseDoneEventType$inboundSchema, - ResponseDoneEventType$outboundSchema, - ResponseDoneEventType$, - ResponseDoneEvent$inboundSchema, - ResponseDoneEvent$Outbound, - ResponseDoneEvent$outboundSchema, - ResponseDoneEvent$, - responseErrorEventToJSON, - responseErrorEventFromJSON, - ResponseErrorEventType, - ResponseErrorEvent, - ResponseErrorEventType$inboundSchema, - ResponseErrorEventType$outboundSchema, - ResponseErrorEventType$, - ResponseErrorEvent$inboundSchema, - ResponseErrorEvent$Outbound, - ResponseErrorEvent$outboundSchema, - ResponseErrorEvent$, - responseFormatToJSON, - responseFormatFromJSON, - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, - ResponseFormat$, - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, - ResponseFormats$, - responseStartedEventToJSON, - responseStartedEventFromJSON, - ResponseStartedEventType, - ResponseStartedEvent, - ResponseStartedEventType$inboundSchema, - ResponseStartedEventType$outboundSchema, - ResponseStartedEventType$, - ResponseStartedEvent$inboundSchema, - ResponseStartedEvent$Outbound, - ResponseStartedEvent$outboundSchema, - ResponseStartedEvent$, - retrieveFileOutToJSON, - retrieveFileOutFromJSON, - RetrieveFileOut, - RetrieveFileOut$inboundSchema, - RetrieveFileOut$Outbound, - RetrieveFileOut$outboundSchema, - RetrieveFileOut$, - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, - SampleType$, - securityToJSON, - securityFromJSON, - Security, - Security$inboundSchema, - Security$Outbound, - Security$outboundSchema, - Security$, - ShareEnum, - ShareEnum$inboundSchema, - ShareEnum$outboundSchema, - ShareEnum$, - sharingDeleteToJSON, - sharingDeleteFromJSON, - SharingDelete, - SharingDelete$inboundSchema, - SharingDelete$Outbound, - SharingDelete$outboundSchema, - SharingDelete$, - sharingInToJSON, - sharingInFromJSON, - SharingIn, - SharingIn$inboundSchema, - SharingIn$Outbound, - SharingIn$outboundSchema, - SharingIn$, - sharingOutToJSON, - sharingOutFromJSON, - SharingOut, - SharingOut$inboundSchema, - SharingOut$Outbound, - SharingOut$outboundSchema, - SharingOut$, - Source, - Source$inboundSchema, - Source$outboundSchema, - Source$, - SSETypes, - SSETypes$inboundSchema, - SSETypes$outboundSchema, - SSETypes$, - systemMessageContentToJSON, - systemMessageContentFromJSON, - systemMessageToJSON, - systemMessageFromJSON, - SystemMessageContent, - Role, - SystemMessage, - SystemMessageContent$inboundSchema, - SystemMessageContent$Outbound, - SystemMessageContent$outboundSchema, - SystemMessageContent$, - Role$inboundSchema, - Role$outboundSchema, - Role$, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, - SystemMessage$, - systemMessageContentChunksToJSON, - systemMessageContentChunksFromJSON, - SystemMessageContentChunks, - SystemMessageContentChunks$inboundSchema, - SystemMessageContentChunks$Outbound, - SystemMessageContentChunks$outboundSchema, - SystemMessageContentChunks$, - textChunkToJSON, - textChunkFromJSON, - TextChunkType, - TextChunk, - TextChunkType$inboundSchema, - TextChunkType$outboundSchema, - TextChunkType$, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, - TextChunk$, - thinkingToJSON, - thinkingFromJSON, - thinkChunkToJSON, - thinkChunkFromJSON, - Thinking, - ThinkChunkType, - ThinkChunk, - Thinking$inboundSchema, - Thinking$Outbound, - Thinking$outboundSchema, - Thinking$, - ThinkChunkType$inboundSchema, - ThinkChunkType$outboundSchema, - ThinkChunkType$, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, - ThinkChunk$, - TimestampGranularity, - TimestampGranularity$inboundSchema, - TimestampGranularity$outboundSchema, - TimestampGranularity$, - toolToJSON, - toolFromJSON, - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, - Tool$, - toolCallToJSON, - toolCallFromJSON, - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, - ToolCall$, - toolChoiceToJSON, - toolChoiceFromJSON, - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, - ToolChoice$, - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, - ToolChoiceEnum$, - toolExecutionDeltaEventToJSON, - toolExecutionDeltaEventFromJSON, - ToolExecutionDeltaEventType, - ToolExecutionDeltaEvent, - ToolExecutionDeltaEventType$inboundSchema, - ToolExecutionDeltaEventType$outboundSchema, - ToolExecutionDeltaEventType$, - ToolExecutionDeltaEvent$inboundSchema, - ToolExecutionDeltaEvent$Outbound, - ToolExecutionDeltaEvent$outboundSchema, - ToolExecutionDeltaEvent$, - toolExecutionDoneEventToJSON, - toolExecutionDoneEventFromJSON, - ToolExecutionDoneEventType, - ToolExecutionDoneEvent, - ToolExecutionDoneEventType$inboundSchema, - ToolExecutionDoneEventType$outboundSchema, - ToolExecutionDoneEventType$, - ToolExecutionDoneEvent$inboundSchema, - ToolExecutionDoneEvent$Outbound, - ToolExecutionDoneEvent$outboundSchema, - ToolExecutionDoneEvent$, - toolExecutionEntryToJSON, - toolExecutionEntryFromJSON, - ToolExecutionEntryObject, - ToolExecutionEntryType, - ToolExecutionEntry, - ToolExecutionEntryObject$inboundSchema, - ToolExecutionEntryObject$outboundSchema, - ToolExecutionEntryObject$, - ToolExecutionEntryType$inboundSchema, - ToolExecutionEntryType$outboundSchema, - ToolExecutionEntryType$, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, - ToolExecutionEntry$, - toolExecutionStartedEventToJSON, - toolExecutionStartedEventFromJSON, - ToolExecutionStartedEventType, - ToolExecutionStartedEvent, - ToolExecutionStartedEventType$inboundSchema, - ToolExecutionStartedEventType$outboundSchema, - ToolExecutionStartedEventType$, - ToolExecutionStartedEvent$inboundSchema, - ToolExecutionStartedEvent$Outbound, - ToolExecutionStartedEvent$outboundSchema, - ToolExecutionStartedEvent$, - toolFileChunkToJSON, - toolFileChunkFromJSON, - ToolFileChunkType, - ToolFileChunk, - ToolFileChunkType$inboundSchema, - ToolFileChunkType$outboundSchema, - ToolFileChunkType$, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, - ToolFileChunk$, - toolMessageContentToJSON, - toolMessageContentFromJSON, - toolMessageToJSON, - toolMessageFromJSON, - ToolMessageContent, - ToolMessageRole, - ToolMessage, - ToolMessageContent$inboundSchema, - ToolMessageContent$Outbound, - ToolMessageContent$outboundSchema, - ToolMessageContent$, - ToolMessageRole$inboundSchema, - ToolMessageRole$outboundSchema, - ToolMessageRole$, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, - ToolMessage$, - toolReferenceChunkToJSON, - toolReferenceChunkFromJSON, - ToolReferenceChunkType, - ToolReferenceChunk, - ToolReferenceChunkType$inboundSchema, - ToolReferenceChunkType$outboundSchema, - ToolReferenceChunkType$, - ToolReferenceChunk$inboundSchema, - ToolReferenceChunk$Outbound, - ToolReferenceChunk$outboundSchema, - ToolReferenceChunk$, - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, - ToolTypes$, - trainingFileToJSON, - trainingFileFromJSON, - TrainingFile, - TrainingFile$inboundSchema, - TrainingFile$Outbound, - TrainingFile$outboundSchema, - TrainingFile$, - transcriptionResponseToJSON, - transcriptionResponseFromJSON, - TranscriptionResponse, - TranscriptionResponse$inboundSchema, - TranscriptionResponse$Outbound, - TranscriptionResponse$outboundSchema, - TranscriptionResponse$, - transcriptionSegmentChunkToJSON, - transcriptionSegmentChunkFromJSON, - Type, - TranscriptionSegmentChunk, - Type$inboundSchema, - Type$outboundSchema, - Type$, - TranscriptionSegmentChunk$inboundSchema, - TranscriptionSegmentChunk$Outbound, - TranscriptionSegmentChunk$outboundSchema, - TranscriptionSegmentChunk$, - transcriptionStreamDoneToJSON, - transcriptionStreamDoneFromJSON, - TranscriptionStreamDoneType, - TranscriptionStreamDone, - TranscriptionStreamDoneType$inboundSchema, - TranscriptionStreamDoneType$outboundSchema, - TranscriptionStreamDoneType$, - TranscriptionStreamDone$inboundSchema, - TranscriptionStreamDone$Outbound, - TranscriptionStreamDone$outboundSchema, - TranscriptionStreamDone$, - transcriptionStreamEventsDataToJSON, - transcriptionStreamEventsDataFromJSON, - transcriptionStreamEventsToJSON, - transcriptionStreamEventsFromJSON, - TranscriptionStreamEventsData, - TranscriptionStreamEvents, - TranscriptionStreamEventsData$inboundSchema, - TranscriptionStreamEventsData$Outbound, - TranscriptionStreamEventsData$outboundSchema, - TranscriptionStreamEventsData$, - TranscriptionStreamEvents$inboundSchema, - TranscriptionStreamEvents$Outbound, - TranscriptionStreamEvents$outboundSchema, - TranscriptionStreamEvents$, - TranscriptionStreamEventTypes, - TranscriptionStreamEventTypes$inboundSchema, - TranscriptionStreamEventTypes$outboundSchema, - TranscriptionStreamEventTypes$, - transcriptionStreamLanguageToJSON, - transcriptionStreamLanguageFromJSON, - TranscriptionStreamLanguageType, - TranscriptionStreamLanguage, - TranscriptionStreamLanguageType$inboundSchema, - TranscriptionStreamLanguageType$outboundSchema, - TranscriptionStreamLanguageType$, - TranscriptionStreamLanguage$inboundSchema, - TranscriptionStreamLanguage$Outbound, - TranscriptionStreamLanguage$outboundSchema, - TranscriptionStreamLanguage$, - transcriptionStreamSegmentDeltaToJSON, - transcriptionStreamSegmentDeltaFromJSON, - TranscriptionStreamSegmentDeltaType, - TranscriptionStreamSegmentDelta, - TranscriptionStreamSegmentDeltaType$inboundSchema, - TranscriptionStreamSegmentDeltaType$outboundSchema, - TranscriptionStreamSegmentDeltaType$, - TranscriptionStreamSegmentDelta$inboundSchema, - TranscriptionStreamSegmentDelta$Outbound, - TranscriptionStreamSegmentDelta$outboundSchema, - TranscriptionStreamSegmentDelta$, - transcriptionStreamTextDeltaToJSON, - transcriptionStreamTextDeltaFromJSON, - TranscriptionStreamTextDeltaType, - TranscriptionStreamTextDelta, - TranscriptionStreamTextDeltaType$inboundSchema, - TranscriptionStreamTextDeltaType$outboundSchema, - TranscriptionStreamTextDeltaType$, - TranscriptionStreamTextDelta$inboundSchema, - TranscriptionStreamTextDelta$Outbound, - TranscriptionStreamTextDelta$outboundSchema, - TranscriptionStreamTextDelta$, - unarchiveFTModelOutToJSON, - unarchiveFTModelOutFromJSON, - UnarchiveFTModelOutObject, - UnarchiveFTModelOut, - UnarchiveFTModelOutObject$inboundSchema, - UnarchiveFTModelOutObject$outboundSchema, - UnarchiveFTModelOutObject$, - UnarchiveFTModelOut$inboundSchema, - UnarchiveFTModelOut$Outbound, - UnarchiveFTModelOut$outboundSchema, - UnarchiveFTModelOut$, - updateFTModelInToJSON, - updateFTModelInFromJSON, - UpdateFTModelIn, - UpdateFTModelIn$inboundSchema, - UpdateFTModelIn$Outbound, - UpdateFTModelIn$outboundSchema, - UpdateFTModelIn$, - uploadFileOutToJSON, - uploadFileOutFromJSON, - UploadFileOut, - UploadFileOut$inboundSchema, - UploadFileOut$Outbound, - UploadFileOut$outboundSchema, - UploadFileOut$, - usageInfoToJSON, - usageInfoFromJSON, - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, - UsageInfo$, - userMessageContentToJSON, - userMessageContentFromJSON, - userMessageToJSON, - userMessageFromJSON, - UserMessageContent, - UserMessageRole, - UserMessage, - UserMessageContent$inboundSchema, - UserMessageContent$Outbound, - UserMessageContent$outboundSchema, - UserMessageContent$, - UserMessageRole$inboundSchema, - UserMessageRole$outboundSchema, - UserMessageRole$, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, - UserMessage$, - locToJSON, - locFromJSON, - validationErrorToJSON, - validationErrorFromJSON, - Loc, - ValidationError, - Loc$inboundSchema, - Loc$Outbound, - Loc$outboundSchema, - Loc$, - ValidationError$inboundSchema, - ValidationError$Outbound, - ValidationError$outboundSchema, - ValidationError$, - wandbIntegrationToJSON, - wandbIntegrationFromJSON, - WandbIntegrationType, - WandbIntegration, - WandbIntegrationType$inboundSchema, - WandbIntegrationType$outboundSchema, - WandbIntegrationType$, - WandbIntegration$inboundSchema, - WandbIntegration$Outbound, - WandbIntegration$outboundSchema, - WandbIntegration$, - wandbIntegrationOutToJSON, - wandbIntegrationOutFromJSON, - WandbIntegrationOutType, - WandbIntegrationOut, - WandbIntegrationOutType$inboundSchema, - WandbIntegrationOutType$outboundSchema, - WandbIntegrationOutType$, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, - WandbIntegrationOut$, - webSearchPremiumToolToJSON, - webSearchPremiumToolFromJSON, - WebSearchPremiumToolType, - WebSearchPremiumTool, - WebSearchPremiumToolType$inboundSchema, - WebSearchPremiumToolType$outboundSchema, - WebSearchPremiumToolType$, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, - WebSearchPremiumTool$, - webSearchToolToJSON, - webSearchToolFromJSON, - WebSearchToolType, - WebSearchTool, - WebSearchToolType$inboundSchema, - WebSearchToolType$outboundSchema, - WebSearchToolType$, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, - WebSearchTool$ - } -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -declare class ConnectionError extends HTTPClientError { - readonly name = "ConnectionError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Content$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Content$Outbound` instead. */ - type Outbound = Content$Outbound; -} - -/** @internal */ -declare const Content$inboundSchema: z.ZodType; - -/** @internal */ -declare type Content$Outbound = string | Array; - -/** @internal */ -declare const Content$outboundSchema: z.ZodType; - -declare type Content = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ContentChunk$Outbound` instead. */ - type Outbound = ContentChunk$Outbound; -} - -/** @internal */ -declare const ContentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ContentChunk$Outbound = (ImageURLChunk$Outbound & { - type: "image_url"; -}) | (DocumentURLChunk$Outbound & { - type: "document_url"; -}) | (TextChunk$Outbound & { - type: "text"; -}) | (ReferenceChunk$Outbound & { - type: "reference"; -}) | (FileChunk$Outbound & { - type: "file"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}) | (AudioChunk$Outbound & { - type: "input_audio"; -}); - -/** @internal */ -declare const ContentChunk$outboundSchema: z.ZodType; - -declare type ContentChunk = (ImageURLChunk & { - type: "image_url"; -}) | (DocumentURLChunk & { - type: "document_url"; -}) | (TextChunk & { - type: "text"; -}) | (ReferenceChunk & { - type: "reference"; -}) | (FileChunk & { - type: "file"; -}) | (ThinkChunk & { - type: "thinking"; -}) | (AudioChunk & { - type: "input_audio"; -}); - -declare function contentChunkFromJSON(jsonString: string): Result; - -declare function contentChunkToJSON(contentChunk: ContentChunk): string; - -declare function contentFromJSON(jsonString: string): Result; - -declare function contentToJSON(content: Content): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequest$ { - /** @deprecated use `ConversationAppendRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendRequest$Outbound` instead. */ - type Outbound = ConversationAppendRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendRequestToJSON(conversationAppendRequest: ConversationAppendRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequest$ { - /** @deprecated use `ConversationAppendStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationAppendStreamRequest$Outbound` instead. */ - type Outbound = ConversationAppendStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationAppendStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationAppendStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -declare const ConversationAppendStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationAppendStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -declare function conversationAppendStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationAppendStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationAppendStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationAppendStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationAppendStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationAppendStreamRequestToJSON(conversationAppendStreamRequest: ConversationAppendStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEvents$ { - /** @deprecated use `ConversationEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEvents$Outbound` instead. */ - type Outbound = ConversationEvents$Outbound; -} - -/** @internal */ -declare const ConversationEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEvents$Outbound = { - event: string; - data: (FunctionCallEvent$Outbound & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; - }) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; - }); -}; - -/** @internal */ -declare const ConversationEvents$outboundSchema: z.ZodType; - -declare type ConversationEvents = { - /** - * Server side events sent when streaming a conversation response. - */ - event: SSETypes; - data: (FunctionCallEvent & { - type: "function.call.delta"; - }) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; - }) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; - }) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; - }) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; - }) | (ResponseErrorEvent & { - type: "conversation.response.error"; - }) | (MessageOutputEvent & { - type: "message.output.delta"; - }) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; - }) | (ResponseDoneEvent & { - type: "conversation.response.done"; - }) | (ResponseStartedEvent & { - type: "conversation.response.started"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationEventsData$ { - /** @deprecated use `ConversationEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationEventsData$Outbound` instead. */ - type Outbound = ConversationEventsData$Outbound; -} - -/** @internal */ -declare const ConversationEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationEventsData$Outbound = (FunctionCallEvent$Outbound & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent$Outbound & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent$Outbound & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent$Outbound & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent$Outbound & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent$Outbound & { - type: "conversation.response.error"; -}) | (MessageOutputEvent$Outbound & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent$Outbound & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent$Outbound & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; -}); - -/** @internal */ -declare const ConversationEventsData$outboundSchema: z.ZodType; - -declare type ConversationEventsData = (FunctionCallEvent & { - type: "function.call.delta"; -}) | (AgentHandoffDoneEvent & { - type: "agent.handoff.done"; -}) | (AgentHandoffStartedEvent & { - type: "agent.handoff.started"; -}) | (ToolExecutionDeltaEvent & { - type: "tool.execution.delta"; -}) | (ToolExecutionStartedEvent & { - type: "tool.execution.started"; -}) | (ResponseErrorEvent & { - type: "conversation.response.error"; -}) | (MessageOutputEvent & { - type: "message.output.delta"; -}) | (ToolExecutionDoneEvent & { - type: "tool.execution.done"; -}) | (ResponseDoneEvent & { - type: "conversation.response.done"; -}) | (ResponseStartedEvent & { - type: "conversation.response.started"; -}); - -declare function conversationEventsDataFromJSON(jsonString: string): Result; - -declare function conversationEventsDataToJSON(conversationEventsData: ConversationEventsData): string; - -declare function conversationEventsFromJSON(jsonString: string): Result; - -declare function conversationEventsToJSON(conversationEvents: ConversationEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistory$ { - /** @deprecated use `ConversationHistory$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationHistory$Outbound` instead. */ - type Outbound = ConversationHistory$Outbound; -} - -/** @internal */ -declare const ConversationHistory$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationHistory$Outbound = { - object: string; - conversation_id: string; - entries: Array; -}; - -/** @internal */ -declare const ConversationHistory$outboundSchema: z.ZodType; - -/** - * Retrieve all entries in a conversation. - */ -declare type ConversationHistory = { - object?: ConversationHistoryObject | undefined; - conversationId: string; - entries: Array; -}; - -declare function conversationHistoryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationHistoryObject$ { - /** @deprecated use `ConversationHistoryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; - /** @deprecated use `ConversationHistoryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationHistory: "conversation.history"; - }>; -} - -/** @internal */ -declare const ConversationHistoryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationHistoryObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationHistoryObject: { - readonly ConversationHistory: "conversation.history"; -}; - -declare type ConversationHistoryObject = ClosedEnum; - -declare function conversationHistoryToJSON(conversationHistory: ConversationHistory): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationInputs$ { - /** @deprecated use `ConversationInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationInputs$Outbound` instead. */ - type Outbound = ConversationInputs$Outbound; -} - -/** @internal */ -declare const ConversationInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationInputs$Outbound = string | Array; - -/** @internal */ -declare const ConversationInputs$outboundSchema: z.ZodType; - -declare type ConversationInputs = string | Array; - -declare function conversationInputsFromJSON(jsonString: string): Result; - -declare function conversationInputsToJSON(conversationInputs: ConversationInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessages$ { - /** @deprecated use `ConversationMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationMessages$Outbound` instead. */ - type Outbound = ConversationMessages$Outbound; -} - -/** @internal */ -declare const ConversationMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationMessages$Outbound = { - object: string; - conversation_id: string; - messages: Array; -}; - -/** @internal */ -declare const ConversationMessages$outboundSchema: z.ZodType; - -/** - * Similar to the conversation history but only keep the messages - */ -declare type ConversationMessages = { - object?: ConversationMessagesObject | undefined; - conversationId: string; - messages: Array; -}; - -declare function conversationMessagesFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationMessagesObject$ { - /** @deprecated use `ConversationMessagesObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; - /** @deprecated use `ConversationMessagesObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationMessages: "conversation.messages"; - }>; -} - -/** @internal */ -declare const ConversationMessagesObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationMessagesObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationMessagesObject: { - readonly ConversationMessages: "conversation.messages"; -}; - -declare type ConversationMessagesObject = ClosedEnum; - -declare function conversationMessagesToJSON(conversationMessages: ConversationMessages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRequest$ { - /** @deprecated use `ConversationRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRequest$Outbound` instead. */ - type Outbound = ConversationRequest$Outbound; -} - -/** @internal */ -declare const ConversationRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationRequest$outboundSchema: z.ZodType; - -declare type ConversationRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: HandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationRequestFromJSON(jsonString: string): Result; - -declare function conversationRequestToJSON(conversationRequest: ConversationRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponse$ { - /** @deprecated use `ConversationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationResponse$Outbound` instead. */ - type Outbound = ConversationResponse$Outbound; -} - -/** @internal */ -declare const ConversationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationResponse$Outbound = { - object: string; - conversation_id: string; - outputs: Array; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ConversationResponse$outboundSchema: z.ZodType; - -/** - * The response after appending new entries to the conversation. - */ -declare type ConversationResponse = { - object?: ConversationResponseObject | undefined; - conversationId: string; - outputs: Array; - usage: ConversationUsageInfo; -}; - -declare function conversationResponseFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationResponseObject$ { - /** @deprecated use `ConversationResponseObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; - /** @deprecated use `ConversationResponseObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponse: "conversation.response"; - }>; -} - -/** @internal */ -declare const ConversationResponseObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationResponseObject$outboundSchema: z.ZodNativeEnum; - -declare const ConversationResponseObject: { - readonly ConversationResponse: "conversation.response"; -}; - -declare type ConversationResponseObject = ClosedEnum; - -declare function conversationResponseToJSON(conversationResponse: ConversationResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequest$ { - /** @deprecated use `ConversationRestartRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartRequest$Outbound` instead. */ - type Outbound = ConversationRestartRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartRequestToJSON(conversationRestartRequest: ConversationRestartRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequest$ { - /** @deprecated use `ConversationRestartStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationRestartStreamRequest$Outbound` instead. */ - type Outbound = ConversationRestartStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationRestartStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationRestartStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -declare const ConversationRestartStreamRequest$outboundSchema: z.ZodType; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -declare type ConversationRestartStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartStreamRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -declare function conversationRestartStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationRestartStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationRestartStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationRestartStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationRestartStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationRestartStreamRequestToJSON(conversationRestartStreamRequest: ConversationRestartStreamRequest): string; - -declare class Conversations extends ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - start(request: components.ConversationRequest, options?: RequestOptions): Promise; - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1ConversationsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - get(request: operations.AgentsApiV1ConversationsGetRequest, options?: RequestOptions): Promise; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - append(request: operations.AgentsApiV1ConversationsAppendRequest, options?: RequestOptions): Promise; - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - getHistory(request: operations.AgentsApiV1ConversationsHistoryRequest, options?: RequestOptions): Promise; - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - getMessages(request: operations.AgentsApiV1ConversationsMessagesRequest, options?: RequestOptions): Promise; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restart(request: operations.AgentsApiV1ConversationsRestartRequest, options?: RequestOptions): Promise; - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - startStream(request: components.ConversationStreamRequest, options?: RequestOptions): Promise>; - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - appendStream(request: operations.AgentsApiV1ConversationsAppendStreamRequest, options?: RequestOptions): Promise>; - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - restartStream(request: operations.AgentsApiV1ConversationsRestartStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequest$ { - /** @deprecated use `ConversationStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequest$Outbound` instead. */ - type Outbound = ConversationStreamRequest$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | null | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -declare const ConversationStreamRequest$outboundSchema: z.ZodType; - -declare type ConversationStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: ConversationStreamRequestHandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | null | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -declare function conversationStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationStreamRequestHandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `ConversationStreamRequestHandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ConversationStreamRequestHandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const ConversationStreamRequestHandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type ConversationStreamRequestHandoffExecution = ClosedEnum; - -declare function conversationStreamRequestToJSON(conversationStreamRequest: ConversationStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationStreamRequestTools$ { - /** @deprecated use `ConversationStreamRequestTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationStreamRequestTools$Outbound` instead. */ - type Outbound = ConversationStreamRequestTools$Outbound; -} - -/** @internal */ -declare const ConversationStreamRequestTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationStreamRequestTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ConversationStreamRequestTools$outboundSchema: z.ZodType; - -declare type ConversationStreamRequestTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function conversationStreamRequestToolsFromJSON(jsonString: string): Result; - -declare function conversationStreamRequestToolsToJSON(conversationStreamRequestTools: ConversationStreamRequestTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ConversationUsageInfo$ { - /** @deprecated use `ConversationUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ConversationUsageInfo$Outbound` instead. */ - type Outbound = ConversationUsageInfo$Outbound; -} - -/** @internal */ -declare const ConversationUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type ConversationUsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - connector_tokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -/** @internal */ -declare const ConversationUsageInfo$outboundSchema: z.ZodType; - -declare type ConversationUsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - connectorTokens?: number | null | undefined; - connectors?: { - [k: string]: number; - } | null | undefined; -}; - -declare function conversationUsageInfoFromJSON(jsonString: string): Result; - -declare function conversationUsageInfoToJSON(conversationUsageInfo: ConversationUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Data$ { - /** @deprecated use `Data$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Data$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Data$Outbound` instead. */ - type Outbound = Data$Outbound; -} - -/** @internal */ -declare const Data$inboundSchema: z.ZodType; - -/** @internal */ -declare type Data$Outbound = (FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const Data$outboundSchema: z.ZodType; - -declare type Data = (FTModelCard & { - type: "fine-tuned"; -}) | (BaseModelCard & { - type: "base"; -}); - -declare function dataFromJSON(jsonString: string): Result; - -declare function dataToJSON(data: Data): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteFileOut$ { - /** @deprecated use `DeleteFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteFileOut$Outbound` instead. */ - type Outbound = DeleteFileOut$Outbound; -} - -/** @internal */ -declare const DeleteFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteFileOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteFileOut$outboundSchema: z.ZodType; - -declare type DeleteFileOut = { - /** - * The ID of the deleted file. - */ - id: string; - /** - * The object type that was deleted - */ - object: string; - /** - * The deletion status. - */ - deleted: boolean; -}; - -declare function deleteFileOutFromJSON(jsonString: string): Result; - -declare function deleteFileOutToJSON(deleteFileOut: DeleteFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelOut$ { - /** @deprecated use `DeleteModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelOut$Outbound` instead. */ - type Outbound = DeleteModelOut$Outbound; -} - -/** @internal */ -declare const DeleteModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -declare const DeleteModelOut$outboundSchema: z.ZodType; - -declare type DeleteModelOut = { - /** - * The ID of the deleted model. - */ - id: string; - /** - * The object type that was deleted - */ - object?: string | undefined; - /** - * The deletion status - */ - deleted?: boolean | undefined; -}; - -declare function deleteModelOutFromJSON(jsonString: string): Result; - -declare function deleteModelOutToJSON(deleteModelOut: DeleteModelOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeleteModelV1ModelsModelIdDeleteRequest$ { - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$Outbound` instead. */ - type Outbound = DeleteModelV1ModelsModelIdDeleteRequest$Outbound; -} - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeleteModelV1ModelsModelIdDeleteRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema: z.ZodType; - -declare type DeleteModelV1ModelsModelIdDeleteRequest = { - /** - * The ID of the model to delete. - */ - modelId: string; -}; - -declare function deleteModelV1ModelsModelIdDeleteRequestFromJSON(jsonString: string): Result; - -declare function deleteModelV1ModelsModelIdDeleteRequestToJSON(deleteModelV1ModelsModelIdDeleteRequest: DeleteModelV1ModelsModelIdDeleteRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - type Outbound = DeltaMessage$Outbound; -} - -/** @internal */ -declare const DeltaMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -declare const DeltaMessage$outboundSchema: z.ZodType; - -declare type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -declare function deltaMessageFromJSON(jsonString: string): Result; - -declare function deltaMessageToJSON(deltaMessage: DeltaMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Document$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Document$Outbound` instead. */ - type Outbound = Document$Outbound; -} - -/** @internal */ -declare const Document$inboundSchema: z.ZodType; - -/** @internal */ -declare type Document$Outbound = FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - -/** @internal */ -declare const Document$outboundSchema: z.ZodType; - -/** - * Document to run OCR on - */ -declare type Document_2 = FileChunk | DocumentURLChunk | ImageURLChunk; - -declare function documentFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryTool$ { - /** @deprecated use `DocumentLibraryTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentLibraryTool$Outbound` instead. */ - type Outbound = DocumentLibraryTool$Outbound; -} - -/** @internal */ -declare const DocumentLibraryTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentLibraryTool$Outbound = { - type: string; - library_ids: Array; -}; - -/** @internal */ -declare const DocumentLibraryTool$outboundSchema: z.ZodType; - -declare type DocumentLibraryTool = { - type?: DocumentLibraryToolType | undefined; - /** - * Ids of the library in which to search. - */ - libraryIds: Array; -}; - -declare function documentLibraryToolFromJSON(jsonString: string): Result; - -declare function documentLibraryToolToJSON(documentLibraryTool: DocumentLibraryTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentLibraryToolType$ { - /** @deprecated use `DocumentLibraryToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; - /** @deprecated use `DocumentLibraryToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentLibrary: "document_library"; - }>; -} - -/** @internal */ -declare const DocumentLibraryToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentLibraryToolType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentLibraryToolType: { - readonly DocumentLibrary: "document_library"; -}; - -declare type DocumentLibraryToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentOut$ { - /** @deprecated use `DocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentOut$Outbound` instead. */ - type Outbound = DocumentOut$Outbound; -} - -/** @internal */ -declare const DocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentOut$Outbound = { - id: string; - library_id: string; - hash: string; - mime_type: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - created_at: string; - last_processed_at?: string | null | undefined; - number_of_pages?: number | null | undefined; - processing_status: string; - uploaded_by_id: string; - uploaded_by_type: string; - tokens_processing_main_content?: number | null | undefined; - tokens_processing_summary?: number | null | undefined; - tokens_processing_total: number; -}; - -/** @internal */ -declare const DocumentOut$outboundSchema: z.ZodType; - -declare type DocumentOut = { - id: string; - libraryId: string; - hash: string; - mimeType: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - createdAt: Date; - lastProcessedAt?: Date | null | undefined; - numberOfPages?: number | null | undefined; - processingStatus: string; - uploadedById: string; - uploadedByType: string; - tokensProcessingMainContent?: number | null | undefined; - tokensProcessingSummary?: number | null | undefined; - tokensProcessingTotal: number; -}; - -declare function documentOutFromJSON(jsonString: string): Result; - -declare function documentOutToJSON(documentOut: DocumentOut): string; - -declare class Documents extends ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - list(request: operations.LibrariesDocumentsListV1Request, options?: RequestOptions): Promise; - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - upload(request: operations.LibrariesDocumentsUploadV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - get(request: operations.LibrariesDocumentsGetV1Request, options?: RequestOptions): Promise; - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - update(request: operations.LibrariesDocumentsUpdateV1Request, options?: RequestOptions): Promise; - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - delete(request: operations.LibrariesDocumentsDeleteV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - textContent(request: operations.LibrariesDocumentsGetTextContentV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - status(request: operations.LibrariesDocumentsGetStatusV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - getSignedUrl(request: operations.LibrariesDocumentsGetSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - extractedTextSignedUrl(request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, options?: RequestOptions): Promise; - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - reprocess(request: operations.LibrariesDocumentsReprocessV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentTextContent$ { - /** @deprecated use `DocumentTextContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentTextContent$Outbound` instead. */ - type Outbound = DocumentTextContent$Outbound; -} - -/** @internal */ -declare const DocumentTextContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentTextContent$Outbound = { - text: string; -}; - -/** @internal */ -declare const DocumentTextContent$outboundSchema: z.ZodType; - -declare type DocumentTextContent = { - text: string; -}; - -declare function documentTextContentFromJSON(jsonString: string): Result; - -declare function documentTextContentToJSON(documentTextContent: DocumentTextContent): string; - -declare function documentToJSON(document: Document_2): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentUpdateIn$ { - /** @deprecated use `DocumentUpdateIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentUpdateIn$Outbound` instead. */ - type Outbound = DocumentUpdateIn$Outbound; -} - -/** @internal */ -declare const DocumentUpdateIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentUpdateIn$Outbound = { - name?: string | null | undefined; -}; - -/** @internal */ -declare const DocumentUpdateIn$outboundSchema: z.ZodType; - -declare type DocumentUpdateIn = { - name?: string | null | undefined; -}; - -declare function documentUpdateInFromJSON(jsonString: string): Result; - -declare function documentUpdateInToJSON(documentUpdateIn: DocumentUpdateIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunk$ { - /** @deprecated use `DocumentURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `DocumentURLChunk$Outbound` instead. */ - type Outbound = DocumentURLChunk$Outbound; -} - -/** @internal */ -declare const DocumentURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type DocumentURLChunk$Outbound = { - document_url: string; - document_name?: string | null | undefined; - type: string; -}; - -/** @internal */ -declare const DocumentURLChunk$outboundSchema: z.ZodType; - -declare type DocumentURLChunk = { - documentUrl: string; - /** - * The filename of the document - */ - documentName?: string | null | undefined; - type?: DocumentURLChunkType | undefined; -}; - -declare function documentURLChunkFromJSON(jsonString: string): Result; - -declare function documentURLChunkToJSON(documentURLChunk: DocumentURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace DocumentURLChunkType$ { - /** @deprecated use `DocumentURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; - /** @deprecated use `DocumentURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly DocumentUrl: "document_url"; - }>; -} - -/** @internal */ -declare const DocumentURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const DocumentURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const DocumentURLChunkType: { - readonly DocumentUrl: "document_url"; -}; - -declare type DocumentURLChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingDtype$ { - /** @deprecated use `EmbeddingDtype$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; - /** @deprecated use `EmbeddingDtype$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; - }>; -} - -/** @internal */ -declare const EmbeddingDtype$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EmbeddingDtype$outboundSchema: z.ZodNativeEnum; - -declare const EmbeddingDtype: { - readonly Float: "float"; - readonly Int8: "int8"; - readonly Uint8: "uint8"; - readonly Binary: "binary"; - readonly Ubinary: "ubinary"; -}; - -declare type EmbeddingDtype = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequest$ { - /** @deprecated use `EmbeddingRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequest$Outbound` instead. */ - type Outbound = EmbeddingRequest$Outbound; -} - -/** @internal */ -declare const EmbeddingRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequest$Outbound = { - model: string; - input: string | Array; - output_dimension?: number | null | undefined; - output_dtype?: string | undefined; - encoding_format?: string | undefined; -}; - -/** @internal */ -declare const EmbeddingRequest$outboundSchema: z.ZodType; - -declare type EmbeddingRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to embed. - */ - inputs: string | Array; - /** - * The dimension of the output embeddings. - */ - outputDimension?: number | null | undefined; - outputDtype?: EmbeddingDtype | undefined; - encodingFormat?: EncodingFormat | undefined; -}; - -declare function embeddingRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingRequestInputs$ { - /** @deprecated use `EmbeddingRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingRequestInputs$Outbound` instead. */ - type Outbound = EmbeddingRequestInputs$Outbound; -} - -/** @internal */ -declare const EmbeddingRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingRequestInputs$Outbound = string | Array; - -/** @internal */ -declare const EmbeddingRequestInputs$outboundSchema: z.ZodType; - -/** - * Text to embed. - */ -declare type EmbeddingRequestInputs = string | Array; - -declare function embeddingRequestInputsFromJSON(jsonString: string): Result; - -declare function embeddingRequestInputsToJSON(embeddingRequestInputs: EmbeddingRequestInputs): string; - -declare function embeddingRequestToJSON(embeddingRequest: EmbeddingRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponse$ { - /** @deprecated use `EmbeddingResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponse$Outbound` instead. */ - type Outbound = EmbeddingResponse$Outbound; -} - -/** @internal */ -declare const EmbeddingResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const EmbeddingResponse$outboundSchema: z.ZodType; - -declare type EmbeddingResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - data: Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EmbeddingResponseData$ { - /** @deprecated use `EmbeddingResponseData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EmbeddingResponseData$Outbound` instead. */ - type Outbound = EmbeddingResponseData$Outbound; -} - -/** @internal */ -declare const EmbeddingResponseData$inboundSchema: z.ZodType; - -/** @internal */ -declare type EmbeddingResponseData$Outbound = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -/** @internal */ -declare const EmbeddingResponseData$outboundSchema: z.ZodType; - -declare type EmbeddingResponseData = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -declare function embeddingResponseDataFromJSON(jsonString: string): Result; - -declare function embeddingResponseDataToJSON(embeddingResponseData: EmbeddingResponseData): string; - -declare function embeddingResponseFromJSON(jsonString: string): Result; - -declare function embeddingResponseToJSON(embeddingResponse: EmbeddingResponse): string; - -declare class Embeddings extends ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - create(request: components.EmbeddingRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EncodingFormat$ { - /** @deprecated use `EncodingFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; - /** @deprecated use `EncodingFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Float: "float"; - readonly Base64: "base64"; - }>; -} - -/** @internal */ -declare const EncodingFormat$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const EncodingFormat$outboundSchema: z.ZodNativeEnum; - -declare const EncodingFormat: { - readonly Float: "float"; - readonly Base64: "base64"; -}; - -declare type EncodingFormat = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EntityType$ { - /** @deprecated use `EntityType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EntityType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const EntityType$inboundSchema: z.ZodType; - -/** @internal */ -declare const EntityType$outboundSchema: z.ZodType; - -/** - * The type of entity, used to share a library. - */ -declare const EntityType: { - readonly User: "User"; - readonly Workspace: "Workspace"; - readonly Org: "Org"; -}; - -/** - * The type of entity, used to share a library. - */ -declare type EntityType = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Entries$ { - /** @deprecated use `Entries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Entries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Entries$Outbound` instead. */ - type Outbound = Entries$Outbound; -} - -/** @internal */ -declare const Entries$inboundSchema: z.ZodType; - -/** @internal */ -declare type Entries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Entries$outboundSchema: z.ZodType; - -declare type Entries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function entriesFromJSON(jsonString: string): Result; - -declare function entriesToJSON(entries: Entries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace EventOut$ { - /** @deprecated use `EventOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `EventOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `EventOut$Outbound` instead. */ - type Outbound = EventOut$Outbound; -} - -/** @internal */ -declare const EventOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type EventOut$Outbound = { - name: string; - data?: { - [k: string]: any; - } | null | undefined; - created_at: number; -}; - -/** @internal */ -declare const EventOut$outboundSchema: z.ZodType; - -declare type EventOut = { - /** - * The name of the event. - */ - name: string; - data?: { - [k: string]: any; - } | null | undefined; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; -}; - -declare function eventOutFromJSON(jsonString: string): Result; - -declare function eventOutToJSON(eventOut: EventOut): string; - -declare class EventStream> extends ReadableStream { - constructor(responseBody: ReadableStream, parse: (x: ServerEvent) => IteratorResult); - [Symbol.asyncIterator](): AsyncIterableIterator; -} - -export declare type Fetcher = (input: RequestInfo | URL, init?: RequestInit) => Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileChunk$ { - /** @deprecated use `FileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileChunk$Outbound` instead. */ - type Outbound = FileChunk$Outbound; -} - -/** @internal */ -declare const FileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileChunk$Outbound = { - type: "file"; - file_id: string; -}; - -/** @internal */ -declare const FileChunk$outboundSchema: z.ZodType; - -declare type FileChunk = { - type?: "file" | undefined; - fileId: string; -}; - -declare function fileChunkFromJSON(jsonString: string): Result; - -declare function fileChunkToJSON(fileChunk: FileChunk): string; - -declare function fileFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilePurpose$ { - /** @deprecated use `FilePurpose$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilePurpose$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FilePurpose$inboundSchema: z.ZodType; - -/** @internal */ -declare const FilePurpose$outboundSchema: z.ZodType; - -declare const FilePurpose: { - readonly FineTune: "fine-tune"; - readonly Batch: "batch"; - readonly Ocr: "ocr"; -}; - -declare type FilePurpose = OpenEnum; - -declare class Files extends ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - upload(request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, options?: RequestOptions): Promise; - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - list(request?: operations.FilesApiRoutesListFilesRequest | undefined, options?: RequestOptions): Promise; - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - retrieve(request: operations.FilesApiRoutesRetrieveFileRequest, options?: RequestOptions): Promise; - /** - * Delete File - * - * @remarks - * Delete a file. - */ - delete(request: operations.FilesApiRoutesDeleteFileRequest, options?: RequestOptions): Promise; - /** - * Download File - * - * @remarks - * Download a file - */ - download(request: operations.FilesApiRoutesDownloadFileRequest, options?: RequestOptions): Promise>; - /** - * Get Signed Url - */ - getSignedUrl(request: operations.FilesApiRoutesGetSignedUrlRequest, options?: RequestOptions): Promise; -} - -export declare namespace files { - export { - readableStreamToArrayBuffer, - getContentTypeFromFileName - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDeleteFileRequest$ { - /** @deprecated use `FilesApiRoutesDeleteFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDeleteFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDeleteFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDeleteFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDeleteFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDeleteFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDeleteFileRequestToJSON(filesApiRoutesDeleteFileRequest: FilesApiRoutesDeleteFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesDownloadFileRequest$ { - /** @deprecated use `FilesApiRoutesDownloadFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesDownloadFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesDownloadFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesDownloadFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesDownloadFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesDownloadFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesDownloadFileRequestToJSON(filesApiRoutesDownloadFileRequest: FilesApiRoutesDownloadFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesGetSignedUrlRequest$ { - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesGetSignedUrlRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesGetSignedUrlRequest$Outbound = { - file_id: string; - expiry: number; -}; - -/** @internal */ -declare const FilesApiRoutesGetSignedUrlRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesGetSignedUrlRequest = { - fileId: string; - /** - * Number of hours before the url becomes invalid. Defaults to 24h - */ - expiry?: number | undefined; -}; - -declare function filesApiRoutesGetSignedUrlRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesGetSignedUrlRequestToJSON(filesApiRoutesGetSignedUrlRequest: FilesApiRoutesGetSignedUrlRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesListFilesRequest$ { - /** @deprecated use `FilesApiRoutesListFilesRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesListFilesRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesListFilesRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesListFilesRequest$Outbound = { - page: number; - page_size: number; - sample_type?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: string | null | undefined; -}; - -/** @internal */ -declare const FilesApiRoutesListFilesRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesListFilesRequest = { - page?: number | undefined; - pageSize?: number | undefined; - sampleType?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: components.FilePurpose | null | undefined; -}; - -declare function filesApiRoutesListFilesRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesListFilesRequestToJSON(filesApiRoutesListFilesRequest: FilesApiRoutesListFilesRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesRetrieveFileRequest$ { - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$Outbound` instead. */ - type Outbound = FilesApiRoutesRetrieveFileRequest$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesRetrieveFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -declare const FilesApiRoutesRetrieveFileRequest$outboundSchema: z.ZodType; - -declare type FilesApiRoutesRetrieveFileRequest = { - fileId: string; -}; - -declare function filesApiRoutesRetrieveFileRequestFromJSON(jsonString: string): Result; - -declare function filesApiRoutesRetrieveFileRequestToJSON(filesApiRoutesRetrieveFileRequest: FilesApiRoutesRetrieveFileRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FilesApiRoutesUploadFileMultiPartBodyParams$ { - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$Outbound` instead. */ - type Outbound = FilesApiRoutesUploadFileMultiPartBodyParams$Outbound; -} - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema: z.ZodType; - -/** @internal */ -declare type FilesApiRoutesUploadFileMultiPartBodyParams$Outbound = { - purpose?: string | undefined; - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema: z.ZodType; - -declare type FilesApiRoutesUploadFileMultiPartBodyParams = { - purpose?: components.FilePurpose | undefined; - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON(jsonString: string): Result; - -declare function filesApiRoutesUploadFileMultiPartBodyParamsToJSON(filesApiRoutesUploadFileMultiPartBodyParams: FilesApiRoutesUploadFileMultiPartBodyParams): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSchema$ { - /** @deprecated use `FileSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSchema$Outbound` instead. */ - type Outbound = FileSchema$Outbound; -} - -/** @internal */ -declare const FileSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSchema$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const FileSchema$outboundSchema: z.ZodType; - -declare type FileSchema = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function fileSchemaFromJSON(jsonString: string): Result; - -declare function fileSchemaToJSON(fileSchema: FileSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileSignedURL$ { - /** @deprecated use `FileSignedURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileSignedURL$Outbound` instead. */ - type Outbound = FileSignedURL$Outbound; -} - -/** @internal */ -declare const FileSignedURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileSignedURL$Outbound = { - url: string; -}; - -/** @internal */ -declare const FileSignedURL$outboundSchema: z.ZodType; - -declare type FileSignedURL = { - url: string; -}; - -declare function fileSignedURLFromJSON(jsonString: string): Result; - -declare function fileSignedURLToJSON(fileSignedURL: FileSignedURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FileT$ { - /** @deprecated use `FileT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FileT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FileT$Outbound` instead. */ - type Outbound = FileT$Outbound; -} - -/** @internal */ -declare const FileT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FileT$Outbound = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -declare const FileT$outboundSchema: z.ZodType; - -declare type FileT = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -declare function fileToJSON(fileT: FileT): string; - -declare class Fim extends ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - complete(request: components.FIMCompletionRequest, options?: RequestOptions): Promise; - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream(request: components.FIMCompletionStreamRequest, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequest$ { - /** @deprecated use `FIMCompletionRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequest$Outbound` instead. */ - type Outbound = FIMCompletionRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionRequestStop$ { - /** @deprecated use `FIMCompletionRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionRequestStop = string | Array; - -declare function fimCompletionRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionRequestStopToJSON(fimCompletionRequestStop: FIMCompletionRequestStop): string; - -declare function fimCompletionRequestToJSON(fimCompletionRequest: FIMCompletionRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionResponse$ { - /** @deprecated use `FIMCompletionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionResponse$Outbound` instead. */ - type Outbound = FIMCompletionResponse$Outbound; -} - -/** @internal */ -declare const FIMCompletionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -declare const FIMCompletionResponse$outboundSchema: z.ZodType; - -declare type FIMCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -declare function fimCompletionResponseFromJSON(jsonString: string): Result; - -declare function fimCompletionResponseToJSON(fimCompletionResponse: FIMCompletionResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequest$ { - /** @deprecated use `FIMCompletionStreamRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequest$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequest$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -declare const FIMCompletionStreamRequest$outboundSchema: z.ZodType; - -declare type FIMCompletionStreamRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -declare function fimCompletionStreamRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FIMCompletionStreamRequestStop$ { - /** @deprecated use `FIMCompletionStreamRequestStop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FIMCompletionStreamRequestStop$Outbound` instead. */ - type Outbound = FIMCompletionStreamRequestStop$Outbound; -} - -/** @internal */ -declare const FIMCompletionStreamRequestStop$inboundSchema: z.ZodType; - -/** @internal */ -declare type FIMCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -declare const FIMCompletionStreamRequestStop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type FIMCompletionStreamRequestStop = string | Array; - -declare function fimCompletionStreamRequestStopFromJSON(jsonString: string): Result; - -declare function fimCompletionStreamRequestStopToJSON(fimCompletionStreamRequestStop: FIMCompletionStreamRequestStop): string; - -declare function fimCompletionStreamRequestToJSON(fimCompletionStreamRequest: FIMCompletionStreamRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FineTuneableModelType$ { - /** @deprecated use `FineTuneableModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; - /** @deprecated use `FineTuneableModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - readonly Classifier: "classifier"; - }>; -} - -/** @internal */ -declare const FineTuneableModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FineTuneableModelType$outboundSchema: z.ZodNativeEnum; - -declare const FineTuneableModelType: { - readonly Completion: "completion"; - readonly Classifier: "classifier"; -}; - -declare type FineTuneableModelType = ClosedEnum; - -declare class FineTuning extends ClientSDK { - private _jobs?; - get jobs(): Jobs; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const FinishReason$inboundSchema: z.ZodType; - -/** @internal */ -declare const FinishReason$outboundSchema: z.ZodType; - -declare const FinishReason: { - readonly Stop: "stop"; - readonly Length: "length"; - readonly ModelLength: "model_length"; - readonly Error: "error"; - readonly ToolCalls: "tool_calls"; -}; - -declare type FinishReason = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTClassifierLossFunction$ { - /** @deprecated use `FTClassifierLossFunction$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; - /** @deprecated use `FTClassifierLossFunction$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; - }>; -} - -/** @internal */ -declare const FTClassifierLossFunction$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTClassifierLossFunction$outboundSchema: z.ZodNativeEnum; - -declare const FTClassifierLossFunction: { - readonly SingleClass: "single_class"; - readonly MultiClass: "multi_class"; -}; - -declare type FTClassifierLossFunction = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCapabilitiesOut$ { - /** @deprecated use `FTModelCapabilitiesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCapabilitiesOut$Outbound` instead. */ - type Outbound = FTModelCapabilitiesOut$Outbound; -} - -/** @internal */ -declare const FTModelCapabilitiesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCapabilitiesOut$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - classification: boolean; -}; - -/** @internal */ -declare const FTModelCapabilitiesOut$outboundSchema: z.ZodType; - -declare type FTModelCapabilitiesOut = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function ftModelCapabilitiesOutFromJSON(jsonString: string): Result; - -declare function ftModelCapabilitiesOutToJSON(ftModelCapabilitiesOut: FTModelCapabilitiesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCard$ { - /** @deprecated use `FTModelCard$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FTModelCard$Outbound` instead. */ - type Outbound = FTModelCard$Outbound; -} - -/** @internal */ -declare const FTModelCard$inboundSchema: z.ZodType; - -/** @internal */ -declare type FTModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "fine-tuned"; - job: string; - root: string; - archived: boolean; -}; - -/** @internal */ -declare const FTModelCard$outboundSchema: z.ZodType; - -/** - * Extra fields for fine-tuned models. - */ -declare type FTModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "fine-tuned" | undefined; - job: string; - root: string; - archived?: boolean | undefined; -}; - -declare function ftModelCardFromJSON(jsonString: string): Result; - -declare function ftModelCardToJSON(ftModelCard: FTModelCard): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FTModelCardType$ { - /** @deprecated use `FTModelCardType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; - /** @deprecated use `FTModelCardType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FineTuned: "fine-tuned"; - }>; -} - -/** @internal */ -declare const FTModelCardType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FTModelCardType$outboundSchema: z.ZodNativeEnum; - -declare const FTModelCardType: { - readonly FineTuned: "fine-tuned"; -}; - -declare type FTModelCardType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCall$Outbound` instead. */ - type Outbound = FunctionCall$Outbound; -} - -/** @internal */ -declare const FunctionCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCall$Outbound = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** @internal */ -declare const FunctionCall$outboundSchema: z.ZodType; - -declare type FunctionCall = { - name: string; - arguments: { - [k: string]: any; - } | string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntry$ { - /** @deprecated use `FunctionCallEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntry$Outbound` instead. */ - type Outbound = FunctionCallEntry$Outbound; -} - -/** @internal */ -declare const FunctionCallEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - name: string; - arguments: FunctionCallEntryArguments$Outbound; -}; - -/** @internal */ -declare const FunctionCallEntry$outboundSchema: z.ZodType; - -declare type FunctionCallEntry = { - object?: FunctionCallEntryObject | undefined; - type?: FunctionCallEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - name: string; - arguments: FunctionCallEntryArguments; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryArguments$ { - /** @deprecated use `FunctionCallEntryArguments$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEntryArguments$Outbound` instead. */ - type Outbound = FunctionCallEntryArguments$Outbound; -} - -/** @internal */ -declare const FunctionCallEntryArguments$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEntryArguments$Outbound = { - [k: string]: any; -} | string; - -/** @internal */ -declare const FunctionCallEntryArguments$outboundSchema: z.ZodType; - -declare type FunctionCallEntryArguments = { - [k: string]: any; -} | string; - -declare function functionCallEntryArgumentsFromJSON(jsonString: string): Result; - -declare function functionCallEntryArgumentsToJSON(functionCallEntryArguments: FunctionCallEntryArguments): string; - -declare function functionCallEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryObject$ { - /** @deprecated use `FunctionCallEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionCallEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionCallEntryObject = ClosedEnum; - -declare function functionCallEntryToJSON(functionCallEntry: FunctionCallEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEntryType$ { - /** @deprecated use `FunctionCallEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; - /** @deprecated use `FunctionCallEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCall: "function.call"; - }>; -} - -/** @internal */ -declare const FunctionCallEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEntryType: { - readonly FunctionCall: "function.call"; -}; - -declare type FunctionCallEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEvent$ { - /** @deprecated use `FunctionCallEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionCallEvent$Outbound` instead. */ - type Outbound = FunctionCallEvent$Outbound; -} - -/** @internal */ -declare const FunctionCallEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionCallEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - tool_call_id: string; - arguments: string; -}; - -/** @internal */ -declare const FunctionCallEvent$outboundSchema: z.ZodType; - -declare type FunctionCallEvent = { - type?: FunctionCallEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: string; - toolCallId: string; - arguments: string; -}; - -declare function functionCallEventFromJSON(jsonString: string): Result; - -declare function functionCallEventToJSON(functionCallEvent: FunctionCallEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionCallEventType$ { - /** @deprecated use `FunctionCallEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `FunctionCallEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const FunctionCallEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionCallEventType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionCallEventType: { - readonly FunctionCallDelta: "function.call.delta"; -}; - -declare type FunctionCallEventType = ClosedEnum; - -declare function functionCallFromJSON(jsonString: string): Result; - -declare function functionCallToJSON(functionCall: FunctionCall): string; - -declare function functionFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionName$Outbound` instead. */ - type Outbound = FunctionName$Outbound; -} - -/** @internal */ -declare const FunctionName$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -declare const FunctionName$outboundSchema: z.ZodType; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -declare type FunctionName = { - name: string; -}; - -declare function functionNameFromJSON(jsonString: string): Result; - -declare function functionNameToJSON(functionName: FunctionName): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntry$ { - /** @deprecated use `FunctionResultEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionResultEntry$Outbound` instead. */ - type Outbound = FunctionResultEntry$Outbound; -} - -/** @internal */ -declare const FunctionResultEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionResultEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - result: string; -}; - -/** @internal */ -declare const FunctionResultEntry$outboundSchema: z.ZodType; - -declare type FunctionResultEntry = { - object?: FunctionResultEntryObject | undefined; - type?: FunctionResultEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - result: string; -}; - -declare function functionResultEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryObject$ { - /** @deprecated use `FunctionResultEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `FunctionResultEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryObject: { - readonly Entry: "entry"; -}; - -declare type FunctionResultEntryObject = ClosedEnum; - -declare function functionResultEntryToJSON(functionResultEntry: FunctionResultEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionResultEntryType$ { - /** @deprecated use `FunctionResultEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; - /** @deprecated use `FunctionResultEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly FunctionResult: "function.result"; - }>; -} - -/** @internal */ -declare const FunctionResultEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionResultEntryType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionResultEntryType: { - readonly FunctionResult: "function.result"; -}; - -declare type FunctionResultEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionT$Outbound` instead. */ - type Outbound = FunctionT$Outbound; -} - -/** @internal */ -declare const FunctionT$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -/** @internal */ -declare const FunctionT$outboundSchema: z.ZodType; - -declare type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { - [k: string]: any; - }; -}; - -declare function functionToJSON(functionT: FunctionT): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionTool$ { - /** @deprecated use `FunctionTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `FunctionTool$Outbound` instead. */ - type Outbound = FunctionTool$Outbound; -} - -/** @internal */ -declare const FunctionTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type FunctionTool$Outbound = { - type: string; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const FunctionTool$outboundSchema: z.ZodType; - -declare type FunctionTool = { - type?: FunctionToolType | undefined; - function: FunctionT; -}; - -declare function functionToolFromJSON(jsonString: string): Result; - -declare function functionToolToJSON(functionTool: FunctionTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace FunctionToolType$ { - /** @deprecated use `FunctionToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; - /** @deprecated use `FunctionToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Function: "function"; - }>; -} - -/** @internal */ -declare const FunctionToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const FunctionToolType$outboundSchema: z.ZodNativeEnum; - -declare const FunctionToolType: { - readonly Function: "function"; -}; - -declare type FunctionToolType = ClosedEnum; - -/** - * Determines the MIME content type based on a file's extension. - * Returns null if the extension is not recognized. - */ -declare function getContentTypeFromFileName(fileName: string): string | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryIn$ { - /** @deprecated use `GithubRepositoryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryIn$Outbound` instead. */ - type Outbound = GithubRepositoryIn$Outbound; -} - -/** @internal */ -declare const GithubRepositoryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryIn$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - token: string; -}; - -/** @internal */ -declare const GithubRepositoryIn$outboundSchema: z.ZodType; - -declare type GithubRepositoryIn = { - type?: GithubRepositoryInType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - token: string; -}; - -declare function githubRepositoryInFromJSON(jsonString: string): Result; - -declare function githubRepositoryInToJSON(githubRepositoryIn: GithubRepositoryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryInType$ { - /** @deprecated use `GithubRepositoryInType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryInType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryInType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryInType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryInType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryInType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOut$ { - /** @deprecated use `GithubRepositoryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `GithubRepositoryOut$Outbound` instead. */ - type Outbound = GithubRepositoryOut$Outbound; -} - -/** @internal */ -declare const GithubRepositoryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type GithubRepositoryOut$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - commit_id: string; -}; - -/** @internal */ -declare const GithubRepositoryOut$outboundSchema: z.ZodType; - -declare type GithubRepositoryOut = { - type?: GithubRepositoryOutType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - commitId: string; -}; - -declare function githubRepositoryOutFromJSON(jsonString: string): Result; - -declare function githubRepositoryOutToJSON(githubRepositoryOut: GithubRepositoryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace GithubRepositoryOutType$ { - /** @deprecated use `GithubRepositoryOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; - /** @deprecated use `GithubRepositoryOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Github: "github"; - }>; -} - -/** @internal */ -declare const GithubRepositoryOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const GithubRepositoryOutType$outboundSchema: z.ZodNativeEnum; - -declare const GithubRepositoryOutType: { - readonly Github: "github"; -}; - -declare type GithubRepositoryOutType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace HandoffExecution$ { - /** @deprecated use `HandoffExecution$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; - /** @deprecated use `HandoffExecution$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Client: "client"; - readonly Server: "server"; - }>; -} - -/** @internal */ -declare const HandoffExecution$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const HandoffExecution$outboundSchema: z.ZodNativeEnum; - -declare const HandoffExecution: { - readonly Client: "client"; - readonly Server: "server"; -}; - -declare type HandoffExecution = ClosedEnum; - -declare type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes: string[] | null; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; - options: SDKOptions; -}; - -declare interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export declare class HTTPClient { - private options; - private fetcher; - private requestHooks; - private requestErrorHooks; - private responseHooks; - constructor(options?: HTTPClientOptions); - request(request: Request): Promise; - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - clone(): HTTPClient; -} - -/** - * Base class for all HTTP errors. - */ -declare class HTTPClientError extends Error { - /** The underlying cause of the error. */ - readonly cause: unknown; - name: string; - constructor(message: string, opts?: { - cause?: unknown; - }); -} - -export declare interface HTTPClientOptions { - fetcher?: Fetcher; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Hyperparameters$ { - /** @deprecated use `Hyperparameters$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Hyperparameters$Outbound` instead. */ - type Outbound = Hyperparameters$Outbound; -} - -/** @internal */ -declare const Hyperparameters$inboundSchema: z.ZodType; - -/** @internal */ -declare type Hyperparameters$Outbound = CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - -/** @internal */ -declare const Hyperparameters$outboundSchema: z.ZodType; - -declare type Hyperparameters = CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - -declare function hyperparametersFromJSON(jsonString: string): Result; - -declare function hyperparametersToJSON(hyperparameters: Hyperparameters): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationTool$ { - /** @deprecated use `ImageGenerationTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageGenerationTool$Outbound` instead. */ - type Outbound = ImageGenerationTool$Outbound; -} - -/** @internal */ -declare const ImageGenerationTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageGenerationTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const ImageGenerationTool$outboundSchema: z.ZodType; - -declare type ImageGenerationTool = { - type?: ImageGenerationToolType | undefined; -}; - -declare function imageGenerationToolFromJSON(jsonString: string): Result; - -declare function imageGenerationToolToJSON(imageGenerationTool: ImageGenerationTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageGenerationToolType$ { - /** @deprecated use `ImageGenerationToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; - /** @deprecated use `ImageGenerationToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageGeneration: "image_generation"; - }>; -} - -/** @internal */ -declare const ImageGenerationToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageGenerationToolType$outboundSchema: z.ZodNativeEnum; - -declare const ImageGenerationToolType: { - readonly ImageGeneration: "image_generation"; -}; - -declare type ImageGenerationToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURL$Outbound` instead. */ - type Outbound = ImageURL$Outbound; -} - -/** @internal */ -declare const ImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -declare const ImageURL$outboundSchema: z.ZodType; - -declare type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - type Outbound = ImageURLChunk$Outbound; -} - -/** @internal */ -declare const ImageURLChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -declare const ImageURLChunk$outboundSchema: z.ZodType; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -declare type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -declare function imageURLChunkFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - type Outbound = ImageURLChunkImageURL$Outbound; -} - -/** @internal */ -declare const ImageURLChunkImageURL$inboundSchema: z.ZodType; - -/** @internal */ -declare type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -declare const ImageURLChunkImageURL$outboundSchema: z.ZodType; - -declare type ImageURLChunkImageURL = ImageURL | string; - -declare function imageURLChunkImageURLFromJSON(jsonString: string): Result; - -declare function imageURLChunkImageURLToJSON(imageURLChunkImageURL: ImageURLChunkImageURL): string; - -declare function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ImageUrl: "image_url"; - }>; -} - -/** @internal */ -declare const ImageURLChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ImageURLChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ImageURLChunkType: { - readonly ImageUrl: "image_url"; -}; - -declare type ImageURLChunkType = ClosedEnum; - -declare function imageURLFromJSON(jsonString: string): Result; - -declare function imageURLToJSON(imageURL: ImageURL): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InputEntries$ { - /** @deprecated use `InputEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InputEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InputEntries$Outbound` instead. */ - type Outbound = InputEntries$Outbound; -} - -/** @internal */ -declare const InputEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type InputEntries$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | MessageInputEntry$Outbound | FunctionResultEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const InputEntries$outboundSchema: z.ZodType; - -declare type InputEntries = AgentHandoffEntry | FunctionCallEntry | MessageInputEntry | FunctionResultEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function inputEntriesFromJSON(jsonString: string): Result; - -declare function inputEntriesToJSON(inputEntries: InputEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Inputs$ { - /** @deprecated use `Inputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Inputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Inputs$Outbound` instead. */ - type Outbound = Inputs$Outbound; -} - -/** @internal */ -declare const Inputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Inputs$Outbound = InstructRequestInputs$Outbound | Array; - -/** @internal */ -declare const Inputs$outboundSchema: z.ZodType; - -/** - * Chat to classify - */ -declare type Inputs = InstructRequestInputs | Array; - -declare function inputsFromJSON(jsonString: string): Result; - -declare function inputsToJSON(inputs: Inputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequest$ { - /** @deprecated use `InstructRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequest$Outbound` instead. */ - type Outbound = InstructRequest$Outbound; -} - -/** @internal */ -declare const InstructRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequest$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequest$outboundSchema: z.ZodType; - -declare type InstructRequest = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputs$ { - /** @deprecated use `InstructRequestInputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputs$Outbound` instead. */ - type Outbound = InstructRequestInputs$Outbound; -} - -/** @internal */ -declare const InstructRequestInputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputs$Outbound = { - messages: Array<(SystemMessage$Outbound & { - role: "system"; - }) | (ToolMessage$Outbound & { - role: "tool"; - }) | (UserMessage$Outbound & { - role: "user"; - }) | (AssistantMessage$Outbound & { - role: "assistant"; - })>; -}; - -/** @internal */ -declare const InstructRequestInputs$outboundSchema: z.ZodType; - -declare type InstructRequestInputs = { - messages: Array<(SystemMessage & { - role: "system"; - }) | (ToolMessage & { - role: "tool"; - }) | (UserMessage & { - role: "user"; - }) | (AssistantMessage & { - role: "assistant"; - })>; -}; - -declare function instructRequestInputsFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestInputsMessages$ { - /** @deprecated use `InstructRequestInputsMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestInputsMessages$Outbound` instead. */ - type Outbound = InstructRequestInputsMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestInputsMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestInputsMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestInputsMessages$outboundSchema: z.ZodType; - -declare type InstructRequestInputsMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestInputsMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestInputsMessagesToJSON(instructRequestInputsMessages: InstructRequestInputsMessages): string; - -declare function instructRequestInputsToJSON(instructRequestInputs: InstructRequestInputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace InstructRequestMessages$ { - /** @deprecated use `InstructRequestMessages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `InstructRequestMessages$Outbound` instead. */ - type Outbound = InstructRequestMessages$Outbound; -} - -/** @internal */ -declare const InstructRequestMessages$inboundSchema: z.ZodType; - -/** @internal */ -declare type InstructRequestMessages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const InstructRequestMessages$outboundSchema: z.ZodType; - -declare type InstructRequestMessages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function instructRequestMessagesFromJSON(jsonString: string): Result; - -declare function instructRequestMessagesToJSON(instructRequestMessages: InstructRequestMessages): string; - -declare function instructRequestToJSON(instructRequest: InstructRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Integrations$ { - /** @deprecated use `Integrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Integrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Integrations$Outbound` instead. */ - type Outbound = Integrations$Outbound; -} - -/** @internal */ -declare const Integrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type Integrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -declare const Integrations$outboundSchema: z.ZodType; - -declare type Integrations = WandbIntegrationOut; - -declare function integrationsFromJSON(jsonString: string): Result; - -declare function integrationsToJSON(integrations: Integrations): string; - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -declare class InvalidRequestError extends HTTPClientError { - name: string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobIn$ { - /** @deprecated use `JobIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobIn$Outbound` instead. */ - type Outbound = JobIn$Outbound; -} - -/** @internal */ -declare const JobIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobIn$Outbound = { - model: string; - training_files?: Array | undefined; - validation_files?: Array | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - auto_start?: boolean | undefined; - invalid_sample_skip_percentage: number; - job_type?: string | null | undefined; - hyperparameters: CompletionTrainingParametersIn$Outbound | ClassifierTrainingParametersIn$Outbound; - repositories?: Array | null | undefined; - classifier_targets?: Array | null | undefined; -}; - -/** @internal */ -declare const JobIn$outboundSchema: z.ZodType; - -declare type JobIn = { - /** - * The name of the model to fine-tune. - */ - model: string; - trainingFiles?: Array | undefined; - /** - * A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - */ - validationFiles?: Array | null | undefined; - /** - * A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - */ - suffix?: string | null | undefined; - /** - * A list of integrations to enable for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * This field will be required in a future release. - */ - autoStart?: boolean | undefined; - invalidSampleSkipPercentage?: number | undefined; - jobType?: FineTuneableModelType | null | undefined; - hyperparameters: CompletionTrainingParametersIn | ClassifierTrainingParametersIn; - repositories?: Array | null | undefined; - classifierTargets?: Array | null | undefined; -}; - -declare function jobInFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInIntegrations$ { - /** @deprecated use `JobInIntegrations$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInIntegrations$Outbound` instead. */ - type Outbound = JobInIntegrations$Outbound; -} - -/** @internal */ -declare const JobInIntegrations$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInIntegrations$Outbound = WandbIntegration$Outbound; - -/** @internal */ -declare const JobInIntegrations$outboundSchema: z.ZodType; - -declare type JobInIntegrations = WandbIntegration; - -declare function jobInIntegrationsFromJSON(jsonString: string): Result; - -declare function jobInIntegrationsToJSON(jobInIntegrations: JobInIntegrations): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobInRepositories$ { - /** @deprecated use `JobInRepositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobInRepositories$Outbound` instead. */ - type Outbound = JobInRepositories$Outbound; -} - -/** @internal */ -declare const JobInRepositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobInRepositories$Outbound = GithubRepositoryIn$Outbound; - -/** @internal */ -declare const JobInRepositories$outboundSchema: z.ZodType; - -declare type JobInRepositories = GithubRepositoryIn; - -declare function jobInRepositoriesFromJSON(jsonString: string): Result; - -declare function jobInRepositoriesToJSON(jobInRepositories: JobInRepositories): string; - -declare function jobInToJSON(jobIn: JobIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobMetadataOut$ { - /** @deprecated use `JobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobMetadataOut$Outbound` instead. */ - type Outbound = JobMetadataOut$Outbound; -} - -/** @internal */ -declare const JobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; -}; - -/** @internal */ -declare const JobMetadataOut$outboundSchema: z.ZodType; - -declare type JobMetadataOut = { - expectedDurationSeconds?: number | null | undefined; - cost?: number | null | undefined; - costCurrency?: string | null | undefined; - trainTokensPerStep?: number | null | undefined; - trainTokens?: number | null | undefined; - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; -}; - -declare function jobMetadataOutFromJSON(jsonString: string): Result; - -declare function jobMetadataOutToJSON(jobMetadataOut: JobMetadataOut): string; - -declare class Jobs extends ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - create(request: components.JobIn, options?: RequestOptions): Promise; - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - get(request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - cancel(request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, options?: RequestOptions): Promise; - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - start(request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchCancelBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchCancelBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchCancelBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchCancelBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchCancelBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchCancelBatchJobRequestToJSON(jobsApiRoutesBatchCancelBatchJobRequest: JobsApiRoutesBatchCancelBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesBatchGetBatchJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobRequestToJSON(jobsApiRoutesBatchGetBatchJobRequest: JobsApiRoutesBatchGetBatchJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesBatchGetBatchJobsRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesBatchGetBatchJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesBatchGetBatchJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - created_after?: string | null | undefined; - created_by_me: boolean; - status?: Array | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesBatchGetBatchJobsRequest = { - page?: number | undefined; - pageSize?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { - [k: string]: any; - } | null | undefined; - createdAfter?: Date | null | undefined; - createdByMe?: boolean | undefined; - status?: Array | null | undefined; -}; - -declare function jobsApiRoutesBatchGetBatchJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesBatchGetBatchJobsRequestToJSON(jobsApiRoutesBatchGetBatchJobsRequest: JobsApiRoutesBatchGetBatchJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningArchiveFineTunedModelRequest = { - /** - * The ID of the model to archive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningArchiveFineTunedModelRequest: JobsApiRoutesFineTuningArchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningCancelFineTuningJobRequest = { - /** - * The ID of the job to cancel. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON(jobsApiRoutesFineTuningCancelFineTuningJobRequest: JobsApiRoutesFineTuningCancelFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCancelFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCancelFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCancelFineTuningJobResponse: JobsApiRoutesFineTuningCancelFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningCreateFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound = components.LegacyJobMetadataOut$Outbound | (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningCreateFineTuningJobResponse = components.LegacyJobMetadataOut | (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON(jobsApiRoutesFineTuningCreateFineTuningJobResponse: JobsApiRoutesFineTuningCreateFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobRequest = { - /** - * The ID of the job to analyse. - */ - jobId: string; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobRequest: JobsApiRoutesFineTuningGetFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningGetFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON(jobsApiRoutesFineTuningGetFineTuningJobResponse: JobsApiRoutesFineTuningGetFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningGetFineTuningJobsRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - created_after?: string | null | undefined; - created_before?: string | null | undefined; - created_by_me: boolean; - status?: string | null | undefined; - wandb_project?: string | null | undefined; - wandb_name?: string | null | undefined; - suffix?: string | null | undefined; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningGetFineTuningJobsRequest = { - /** - * The page number of the results to be returned. - */ - page?: number | undefined; - /** - * The number of items to return per page. - */ - pageSize?: number | undefined; - /** - * The model name used for fine-tuning to filter on. When set, the other results are not displayed. - */ - model?: string | null | undefined; - /** - * The date/time to filter on. When set, the results for previous creation times are not displayed. - */ - createdAfter?: Date | null | undefined; - createdBefore?: Date | null | undefined; - /** - * When set, only return results for jobs created by the API caller. Other results are not displayed. - */ - createdByMe?: boolean | undefined; - /** - * The current job state to filter on. When set, the other results are not displayed. - */ - status?: Status_2 | null | undefined; - /** - * The Weights and Biases project to filter on. When set, the other results are not displayed. - */ - wandbProject?: string | null | undefined; - /** - * The Weight and Biases run name to filter on. When set, the other results are not displayed. - */ - wandbName?: string | null | undefined; - /** - * The model suffix to filter on. When set, the other results are not displayed. - */ - suffix?: string | null | undefined; -}; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON(jobsApiRoutesFineTuningGetFineTuningJobsRequest: JobsApiRoutesFineTuningGetFineTuningJobsRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningStartFineTuningJobRequest = { - jobId: string; -}; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON(jobsApiRoutesFineTuningStartFineTuningJobRequest: JobsApiRoutesFineTuningStartFineTuningJobRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningStartFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound = (components.ClassifierDetailedJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionDetailedJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningStartFineTuningJobResponse = (components.ClassifierDetailedJobOut & { - jobType: "classifier"; -}) | (components.CompletionDetailedJobOut & { - jobType: "completion"; -}); - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON(jobsApiRoutesFineTuningStartFineTuningJobResponse: JobsApiRoutesFineTuningStartFineTuningJobResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest = { - /** - * The ID of the model to unarchive. - */ - modelId: string; -}; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest: JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound = { - model_id: string; - UpdateFTModelIn: components.UpdateFTModelIn$Outbound; -}; - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema: z.ZodType; - -declare type JobsApiRoutesFineTuningUpdateFineTunedModelRequest = { - /** - * The ID of the model to update. - */ - modelId: string; - updateFTModelIn: components.UpdateFTModelIn; -}; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelRequest: JobsApiRoutesFineTuningUpdateFineTunedModelRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound` instead. */ - type Outbound = JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound; -} - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound = (components.ClassifierFTModelOut$Outbound & { - model_type: "classifier"; -}) | (components.CompletionFTModelOut$Outbound & { - model_type: "completion"; -}); - -/** @internal */ -declare const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema: z.ZodType; - -/** - * OK - */ -declare type JobsApiRoutesFineTuningUpdateFineTunedModelResponse = (components.ClassifierFTModelOut & { - modelType: "classifier"; -}) | (components.CompletionFTModelOut & { - modelType: "completion"; -}); - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON(jsonString: string): Result; - -declare function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON(jobsApiRoutesFineTuningUpdateFineTunedModelResponse: JobsApiRoutesFineTuningUpdateFineTunedModelResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOut$ { - /** @deprecated use `JobsOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOut$Outbound` instead. */ - type Outbound = JobsOut$Outbound; -} - -/** @internal */ -declare const JobsOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOut$Outbound = { - data?: Array<(ClassifierJobOut$Outbound & { - job_type: "classifier"; - }) | (CompletionJobOut$Outbound & { - job_type: "completion"; - })> | undefined; - object: string; - total: number; -}; - -/** @internal */ -declare const JobsOut$outboundSchema: z.ZodType; - -declare type JobsOut = { - data?: Array<(ClassifierJobOut & { - jobType: "classifier"; - }) | (CompletionJobOut & { - jobType: "completion"; - })> | undefined; - object?: JobsOutObject | undefined; - total: number; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutData$ { - /** @deprecated use `JobsOutData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JobsOutData$Outbound` instead. */ - type Outbound = JobsOutData$Outbound; -} - -/** @internal */ -declare const JobsOutData$inboundSchema: z.ZodType; - -/** @internal */ -declare type JobsOutData$Outbound = (ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const JobsOutData$outboundSchema: z.ZodType; - -declare type JobsOutData = (ClassifierJobOut & { - jobType: "classifier"; -}) | (CompletionJobOut & { - jobType: "completion"; -}); - -declare function jobsOutDataFromJSON(jsonString: string): Result; - -declare function jobsOutDataToJSON(jobsOutData: JobsOutData): string; - -declare function jobsOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobsOutObject$ { - /** @deprecated use `JobsOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; - /** @deprecated use `JobsOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly List: "list"; - }>; -} - -/** @internal */ -declare const JobsOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobsOutObject$outboundSchema: z.ZodNativeEnum; - -declare const JobsOutObject: { - readonly List: "list"; -}; - -declare type JobsOutObject = ClosedEnum; - -declare function jobsOutToJSON(jobsOut: JobsOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JobType$ { - /** @deprecated use `JobType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `JobType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const JobType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const JobType$outboundSchema: z.ZodNativeEnum; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare const JobType: { - readonly Completion: "completion"; -}; - -/** - * The type of job (`FT` for fine-tuning). - */ -declare type JobType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `JsonSchema$Outbound` instead. */ - type Outbound = JsonSchema$Outbound; -} - -/** @internal */ -declare const JsonSchema$inboundSchema: z.ZodType; - -/** @internal */ -declare type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -/** @internal */ -declare const JsonSchema$outboundSchema: z.ZodType; - -declare type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { - [k: string]: any; - }; - strict?: boolean | undefined; -}; - -declare function jsonSchemaFromJSON(jsonString: string): Result; - -declare function jsonSchemaToJSON(jsonSchema: JsonSchema): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOut$ { - /** @deprecated use `LegacyJobMetadataOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LegacyJobMetadataOut$Outbound` instead. */ - type Outbound = LegacyJobMetadataOut$Outbound; -} - -/** @internal */ -declare const LegacyJobMetadataOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LegacyJobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; - deprecated: boolean; - details: string; - epochs?: number | null | undefined; - training_steps?: number | null | undefined; - object: string; -}; - -/** @internal */ -declare const LegacyJobMetadataOut$outboundSchema: z.ZodType; - -declare type LegacyJobMetadataOut = { - /** - * The approximated time (in seconds) for the fine-tuning process to complete. - */ - expectedDurationSeconds?: number | null | undefined; - /** - * The cost of the fine-tuning job. - */ - cost?: number | null | undefined; - /** - * The currency used for the fine-tuning job cost. - */ - costCurrency?: string | null | undefined; - /** - * The number of tokens consumed by one training step. - */ - trainTokensPerStep?: number | null | undefined; - /** - * The total number of tokens used during the fine-tuning process. - */ - trainTokens?: number | null | undefined; - /** - * The total number of tokens in the training dataset. - */ - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; - deprecated?: boolean | undefined; - details: string; - /** - * The number of complete passes through the entire training dataset. - */ - epochs?: number | null | undefined; - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - object?: LegacyJobMetadataOutObject | undefined; -}; - -declare function legacyJobMetadataOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LegacyJobMetadataOutObject$ { - /** @deprecated use `LegacyJobMetadataOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; - /** @deprecated use `LegacyJobMetadataOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly JobMetadata: "job.metadata"; - }>; -} - -/** @internal */ -declare const LegacyJobMetadataOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const LegacyJobMetadataOutObject$outboundSchema: z.ZodNativeEnum; - -declare const LegacyJobMetadataOutObject: { - readonly JobMetadata: "job.metadata"; -}; - -declare type LegacyJobMetadataOutObject = ClosedEnum; - -declare function legacyJobMetadataOutToJSON(legacyJobMetadataOut: LegacyJobMetadataOut): string; - -declare class Libraries extends ClientSDK { - private _documents?; - get documents(): Documents; - private _accesses?; - get accesses(): Accesses; - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - list(options?: RequestOptions): Promise; - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - create(request: components.LibraryIn, options?: RequestOptions): Promise; - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - get(request: operations.LibrariesGetV1Request, options?: RequestOptions): Promise; - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - delete(request: operations.LibrariesDeleteV1Request, options?: RequestOptions): Promise; - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - update(request: operations.LibrariesUpdateV1Request, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDeleteV1Request$ { - /** @deprecated use `LibrariesDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDeleteV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDeleteV1Request = { - libraryId: string; -}; - -declare function librariesDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDeleteV1RequestToJSON(librariesDeleteV1Request: LibrariesDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsDeleteV1Request$ { - /** @deprecated use `LibrariesDocumentsDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsDeleteV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsDeleteV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsDeleteV1RequestToJSON(librariesDocumentsDeleteV1Request: LibrariesDocumentsDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetExtractedTextSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON(librariesDocumentsGetExtractedTextSignedUrlV1Request: LibrariesDocumentsGetExtractedTextSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetSignedUrlV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetSignedUrlV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetSignedUrlV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetSignedUrlV1RequestToJSON(librariesDocumentsGetSignedUrlV1Request: LibrariesDocumentsGetSignedUrlV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetStatusV1Request$ { - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetStatusV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetStatusV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetStatusV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetStatusV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetStatusV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetStatusV1RequestToJSON(librariesDocumentsGetStatusV1Request: LibrariesDocumentsGetStatusV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetTextContentV1Request$ { - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetTextContentV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetTextContentV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetTextContentV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetTextContentV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetTextContentV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetTextContentV1RequestToJSON(librariesDocumentsGetTextContentV1Request: LibrariesDocumentsGetTextContentV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsGetV1Request$ { - /** @deprecated use `LibrariesDocumentsGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsGetV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsGetV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsGetV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsGetV1RequestToJSON(librariesDocumentsGetV1Request: LibrariesDocumentsGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsListV1Request$ { - /** @deprecated use `LibrariesDocumentsListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsListV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsListV1Request$Outbound = { - library_id: string; - search?: string | null | undefined; - page_size: number; - page: number; - sort_by: string; - sort_order: string; -}; - -/** @internal */ -declare const LibrariesDocumentsListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsListV1Request = { - libraryId: string; - search?: string | null | undefined; - pageSize?: number | undefined; - page?: number | undefined; - sortBy?: string | undefined; - sortOrder?: string | undefined; -}; - -declare function librariesDocumentsListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsListV1RequestToJSON(librariesDocumentsListV1Request: LibrariesDocumentsListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsReprocessV1Request$ { - /** @deprecated use `LibrariesDocumentsReprocessV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsReprocessV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsReprocessV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -declare const LibrariesDocumentsReprocessV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsReprocessV1Request = { - libraryId: string; - documentId: string; -}; - -declare function librariesDocumentsReprocessV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsReprocessV1RequestToJSON(librariesDocumentsReprocessV1Request: LibrariesDocumentsReprocessV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUpdateV1Request$ { - /** @deprecated use `LibrariesDocumentsUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUpdateV1Request$Outbound = { - library_id: string; - document_id: string; - DocumentUpdateIn: components.DocumentUpdateIn$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUpdateV1Request = { - libraryId: string; - documentId: string; - documentUpdateIn: components.DocumentUpdateIn; -}; - -declare function librariesDocumentsUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUpdateV1RequestToJSON(librariesDocumentsUpdateV1Request: LibrariesDocumentsUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1DocumentUpload$ { - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1DocumentUpload$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1DocumentUpload$Outbound = { - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1DocumentUpload$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1DocumentUpload = { - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -declare function librariesDocumentsUploadV1DocumentUploadFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1DocumentUploadToJSON(librariesDocumentsUploadV1DocumentUpload: LibrariesDocumentsUploadV1DocumentUpload): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesDocumentsUploadV1Request$ { - /** @deprecated use `LibrariesDocumentsUploadV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesDocumentsUploadV1Request$Outbound` instead. */ - type Outbound = LibrariesDocumentsUploadV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesDocumentsUploadV1Request$Outbound = { - library_id: string; - RequestBody: LibrariesDocumentsUploadV1DocumentUpload$Outbound; -}; - -/** @internal */ -declare const LibrariesDocumentsUploadV1Request$outboundSchema: z.ZodType; - -declare type LibrariesDocumentsUploadV1Request = { - libraryId: string; - requestBody: LibrariesDocumentsUploadV1DocumentUpload; -}; - -declare function librariesDocumentsUploadV1RequestFromJSON(jsonString: string): Result; - -declare function librariesDocumentsUploadV1RequestToJSON(librariesDocumentsUploadV1Request: LibrariesDocumentsUploadV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesGetV1Request$ { - /** @deprecated use `LibrariesGetV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesGetV1Request$Outbound` instead. */ - type Outbound = LibrariesGetV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesGetV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesGetV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesGetV1Request$outboundSchema: z.ZodType; - -declare type LibrariesGetV1Request = { - libraryId: string; -}; - -declare function librariesGetV1RequestFromJSON(jsonString: string): Result; - -declare function librariesGetV1RequestToJSON(librariesGetV1Request: LibrariesGetV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareCreateV1Request$ { - /** @deprecated use `LibrariesShareCreateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareCreateV1Request$Outbound` instead. */ - type Outbound = LibrariesShareCreateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareCreateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareCreateV1Request$Outbound = { - library_id: string; - SharingIn: components.SharingIn$Outbound; -}; - -/** @internal */ -declare const LibrariesShareCreateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareCreateV1Request = { - libraryId: string; - sharingIn: components.SharingIn; -}; - -declare function librariesShareCreateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareCreateV1RequestToJSON(librariesShareCreateV1Request: LibrariesShareCreateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareDeleteV1Request$ { - /** @deprecated use `LibrariesShareDeleteV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareDeleteV1Request$Outbound` instead. */ - type Outbound = LibrariesShareDeleteV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareDeleteV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareDeleteV1Request$Outbound = { - library_id: string; - SharingDelete: components.SharingDelete$Outbound; -}; - -/** @internal */ -declare const LibrariesShareDeleteV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareDeleteV1Request = { - libraryId: string; - sharingDelete: components.SharingDelete; -}; - -declare function librariesShareDeleteV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareDeleteV1RequestToJSON(librariesShareDeleteV1Request: LibrariesShareDeleteV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesShareListV1Request$ { - /** @deprecated use `LibrariesShareListV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesShareListV1Request$Outbound` instead. */ - type Outbound = LibrariesShareListV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesShareListV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesShareListV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -declare const LibrariesShareListV1Request$outboundSchema: z.ZodType; - -declare type LibrariesShareListV1Request = { - libraryId: string; -}; - -declare function librariesShareListV1RequestFromJSON(jsonString: string): Result; - -declare function librariesShareListV1RequestToJSON(librariesShareListV1Request: LibrariesShareListV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibrariesUpdateV1Request$ { - /** @deprecated use `LibrariesUpdateV1Request$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibrariesUpdateV1Request$Outbound` instead. */ - type Outbound = LibrariesUpdateV1Request$Outbound; -} - -/** @internal */ -declare const LibrariesUpdateV1Request$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibrariesUpdateV1Request$Outbound = { - library_id: string; - LibraryInUpdate: components.LibraryInUpdate$Outbound; -}; - -/** @internal */ -declare const LibrariesUpdateV1Request$outboundSchema: z.ZodType; - -declare type LibrariesUpdateV1Request = { - libraryId: string; - libraryInUpdate: components.LibraryInUpdate; -}; - -declare function librariesUpdateV1RequestFromJSON(jsonString: string): Result; - -declare function librariesUpdateV1RequestToJSON(librariesUpdateV1Request: LibrariesUpdateV1Request): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryIn$ { - /** @deprecated use `LibraryIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryIn$Outbound` instead. */ - type Outbound = LibraryIn$Outbound; -} - -/** @internal */ -declare const LibraryIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryIn$Outbound = { - name: string; - description?: string | null | undefined; - chunk_size?: number | null | undefined; -}; - -/** @internal */ -declare const LibraryIn$outboundSchema: z.ZodType; - -declare type LibraryIn = { - name: string; - description?: string | null | undefined; - chunkSize?: number | null | undefined; -}; - -declare function libraryInFromJSON(jsonString: string): Result; - -declare function libraryInToJSON(libraryIn: LibraryIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryInUpdate$ { - /** @deprecated use `LibraryInUpdate$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryInUpdate$Outbound` instead. */ - type Outbound = LibraryInUpdate$Outbound; -} - -/** @internal */ -declare const LibraryInUpdate$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryInUpdate$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryInUpdate$outboundSchema: z.ZodType; - -declare type LibraryInUpdate = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function libraryInUpdateFromJSON(jsonString: string): Result; - -declare function libraryInUpdateToJSON(libraryInUpdate: LibraryInUpdate): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace LibraryOut$ { - /** @deprecated use `LibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `LibraryOut$Outbound` instead. */ - type Outbound = LibraryOut$Outbound; -} - -/** @internal */ -declare const LibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type LibraryOut$Outbound = { - id: string; - name: string; - created_at: string; - updated_at: string; - owner_id: string; - owner_type: string; - total_size: number; - nb_documents: number; - chunk_size: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generated_name?: string | null | undefined; - generated_description?: string | null | undefined; - explicit_user_members_count?: number | null | undefined; - explicit_workspace_members_count?: number | null | undefined; - org_sharing_role?: string | null | undefined; -}; - -/** @internal */ -declare const LibraryOut$outboundSchema: z.ZodType; - -declare type LibraryOut = { - id: string; - name: string; - createdAt: Date; - updatedAt: Date; - ownerId: string; - ownerType: string; - totalSize: number; - nbDocuments: number; - chunkSize: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generatedName?: string | null | undefined; - generatedDescription?: string | null | undefined; - explicitUserMembersCount?: number | null | undefined; - explicitWorkspaceMembersCount?: number | null | undefined; - orgSharingRole?: string | null | undefined; -}; - -declare function libraryOutFromJSON(jsonString: string): Result; - -declare function libraryOutToJSON(libraryOut: LibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListDocumentOut$ { - /** @deprecated use `ListDocumentOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListDocumentOut$Outbound` instead. */ - type Outbound = ListDocumentOut$Outbound; -} - -/** @internal */ -declare const ListDocumentOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListDocumentOut$Outbound = { - pagination: PaginationInfo$Outbound; - data: Array; -}; - -/** @internal */ -declare const ListDocumentOut$outboundSchema: z.ZodType; - -declare type ListDocumentOut = { - pagination: PaginationInfo; - data: Array; -}; - -declare function listDocumentOutFromJSON(jsonString: string): Result; - -declare function listDocumentOutToJSON(listDocumentOut: ListDocumentOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListFilesOut$ { - /** @deprecated use `ListFilesOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListFilesOut$Outbound` instead. */ - type Outbound = ListFilesOut$Outbound; -} - -/** @internal */ -declare const ListFilesOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListFilesOut$Outbound = { - data: Array; - object: string; - total: number; -}; - -/** @internal */ -declare const ListFilesOut$outboundSchema: z.ZodType; - -declare type ListFilesOut = { - data: Array; - object: string; - total: number; -}; - -declare function listFilesOutFromJSON(jsonString: string): Result; - -declare function listFilesOutToJSON(listFilesOut: ListFilesOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListLibraryOut$ { - /** @deprecated use `ListLibraryOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListLibraryOut$Outbound` instead. */ - type Outbound = ListLibraryOut$Outbound; -} - -/** @internal */ -declare const ListLibraryOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListLibraryOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListLibraryOut$outboundSchema: z.ZodType; - -declare type ListLibraryOut = { - data: Array; -}; - -declare function listLibraryOutFromJSON(jsonString: string): Result; - -declare function listLibraryOutToJSON(listLibraryOut: ListLibraryOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ListSharingOut$ { - /** @deprecated use `ListSharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ListSharingOut$Outbound` instead. */ - type Outbound = ListSharingOut$Outbound; -} - -/** @internal */ -declare const ListSharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ListSharingOut$Outbound = { - data: Array; -}; - -/** @internal */ -declare const ListSharingOut$outboundSchema: z.ZodType; - -declare type ListSharingOut = { - data: Array; -}; - -declare function listSharingOutFromJSON(jsonString: string): Result; - -declare function listSharingOutToJSON(listSharingOut: ListSharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Loc$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Loc$Outbound` instead. */ - type Outbound = Loc$Outbound; -} - -/** @internal */ -declare const Loc$inboundSchema: z.ZodType; - -/** @internal */ -declare type Loc$Outbound = string | number; - -/** @internal */ -declare const Loc$outboundSchema: z.ZodType; - -declare type Loc = string | number; - -declare function locFromJSON(jsonString: string): Result; - -declare function locToJSON(loc: Loc): string; - -declare interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageEntries$ { - /** @deprecated use `MessageEntries$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageEntries$Outbound` instead. */ - type Outbound = MessageEntries$Outbound; -} - -/** @internal */ -declare const MessageEntries$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageEntries$Outbound = MessageInputEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const MessageEntries$outboundSchema: z.ZodType; - -declare type MessageEntries = MessageInputEntry | MessageOutputEntry; - -declare function messageEntriesFromJSON(jsonString: string): Result; - -declare function messageEntriesToJSON(messageEntries: MessageEntries): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputContentChunks$ { - /** @deprecated use `MessageInputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputContentChunks$Outbound` instead. */ - type Outbound = MessageInputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageInputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputContentChunks$Outbound = ToolFileChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageInputContentChunks$outboundSchema: z.ZodType; - -declare type MessageInputContentChunks = ToolFileChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageInputContentChunksFromJSON(jsonString: string): Result; - -declare function messageInputContentChunksToJSON(messageInputContentChunks: MessageInputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntry$ { - /** @deprecated use `MessageInputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntry$Outbound` instead. */ - type Outbound = MessageInputEntry$Outbound; -} - -/** @internal */ -declare const MessageInputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - role: string; - content: string | Array; - prefix: boolean; -}; - -/** @internal */ -declare const MessageInputEntry$outboundSchema: z.ZodType; - -/** - * Representation of an input message inside the conversation. - */ -declare type MessageInputEntry = { - object?: ObjectT | undefined; - type?: MessageInputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - role: MessageInputEntryRole; - content: string | Array; - prefix?: boolean | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryContent$ { - /** @deprecated use `MessageInputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageInputEntryContent$Outbound` instead. */ - type Outbound = MessageInputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageInputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageInputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageInputEntryContent$outboundSchema: z.ZodType; - -declare type MessageInputEntryContent = string | Array; - -declare function messageInputEntryContentFromJSON(jsonString: string): Result; - -declare function messageInputEntryContentToJSON(messageInputEntryContent: MessageInputEntryContent): string; - -declare function messageInputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryRole$ { - /** @deprecated use `MessageInputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; - /** @deprecated use `MessageInputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - readonly User: "user"; - }>; -} - -/** @internal */ -declare const MessageInputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryRole: { - readonly Assistant: "assistant"; - readonly User: "user"; -}; - -declare type MessageInputEntryRole = ClosedEnum; - -declare function messageInputEntryToJSON(messageInputEntry: MessageInputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageInputEntryType$ { - /** @deprecated use `MessageInputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; - /** @deprecated use `MessageInputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageInput: "message.input"; - }>; -} - -/** @internal */ -declare const MessageInputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageInputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageInputEntryType: { - readonly MessageInput: "message.input"; -}; - -declare type MessageInputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputContentChunks$ { - /** @deprecated use `MessageOutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputContentChunks$Outbound` instead. */ - type Outbound = MessageOutputContentChunks$Outbound; -} - -/** @internal */ -declare const MessageOutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const MessageOutputContentChunks$outboundSchema: z.ZodType; - -declare type MessageOutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function messageOutputContentChunksFromJSON(jsonString: string): Result; - -declare function messageOutputContentChunksToJSON(messageOutputContentChunks: MessageOutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntry$ { - /** @deprecated use `MessageOutputEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntry$Outbound` instead. */ - type Outbound = MessageOutputEntry$Outbound; -} - -/** @internal */ -declare const MessageOutputEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; - role: string; - content: string | Array; -}; - -/** @internal */ -declare const MessageOutputEntry$outboundSchema: z.ZodType; - -declare type MessageOutputEntry = { - object?: MessageOutputEntryObject | undefined; - type?: MessageOutputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; - role?: MessageOutputEntryRole | undefined; - content: string | Array; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryContent$ { - /** @deprecated use `MessageOutputEntryContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEntryContent$Outbound` instead. */ - type Outbound = MessageOutputEntryContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEntryContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEntryContent$Outbound = string | Array; - -/** @internal */ -declare const MessageOutputEntryContent$outboundSchema: z.ZodType; - -declare type MessageOutputEntryContent = string | Array; - -declare function messageOutputEntryContentFromJSON(jsonString: string): Result; - -declare function messageOutputEntryContentToJSON(messageOutputEntryContent: MessageOutputEntryContent): string; - -declare function messageOutputEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryObject$ { - /** @deprecated use `MessageOutputEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `MessageOutputEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryObject: { - readonly Entry: "entry"; -}; - -declare type MessageOutputEntryObject = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryRole$ { - /** @deprecated use `MessageOutputEntryRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEntryRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEntryRole = ClosedEnum; - -declare function messageOutputEntryToJSON(messageOutputEntry: MessageOutputEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEntryType$ { - /** @deprecated use `MessageOutputEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; - /** @deprecated use `MessageOutputEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutput: "message.output"; - }>; -} - -/** @internal */ -declare const MessageOutputEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEntryType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEntryType: { - readonly MessageOutput: "message.output"; -}; - -declare type MessageOutputEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEvent$ { - /** @deprecated use `MessageOutputEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEvent$Outbound` instead. */ - type Outbound = MessageOutputEvent$Outbound; -} - -/** @internal */ -declare const MessageOutputEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - content_index: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - role: string; - content: string | OutputContentChunks$Outbound; -}; - -/** @internal */ -declare const MessageOutputEvent$outboundSchema: z.ZodType; - -declare type MessageOutputEvent = { - type?: MessageOutputEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - contentIndex?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - role?: MessageOutputEventRole | undefined; - content: string | OutputContentChunks; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventContent$ { - /** @deprecated use `MessageOutputEventContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MessageOutputEventContent$Outbound` instead. */ - type Outbound = MessageOutputEventContent$Outbound; -} - -/** @internal */ -declare const MessageOutputEventContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type MessageOutputEventContent$Outbound = string | OutputContentChunks$Outbound; - -/** @internal */ -declare const MessageOutputEventContent$outboundSchema: z.ZodType; - -declare type MessageOutputEventContent = string | OutputContentChunks; - -declare function messageOutputEventContentFromJSON(jsonString: string): Result; - -declare function messageOutputEventContentToJSON(messageOutputEventContent: MessageOutputEventContent): string; - -declare function messageOutputEventFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventRole$ { - /** @deprecated use `MessageOutputEventRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; - /** @deprecated use `MessageOutputEventRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Assistant: "assistant"; - }>; -} - -/** @internal */ -declare const MessageOutputEventRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventRole$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventRole: { - readonly Assistant: "assistant"; -}; - -declare type MessageOutputEventRole = ClosedEnum; - -declare function messageOutputEventToJSON(messageOutputEvent: MessageOutputEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MessageOutputEventType$ { - /** @deprecated use `MessageOutputEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; - /** @deprecated use `MessageOutputEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly MessageOutputDelta: "message.output.delta"; - }>; -} - -/** @internal */ -declare const MessageOutputEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const MessageOutputEventType$outboundSchema: z.ZodNativeEnum; - -declare const MessageOutputEventType: { - readonly MessageOutputDelta: "message.output.delta"; -}; - -declare type MessageOutputEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Messages$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Messages$Outbound` instead. */ - type Outbound = Messages$Outbound; -} - -/** @internal */ -declare const Messages$inboundSchema: z.ZodType; - -/** @internal */ -declare type Messages$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Messages$outboundSchema: z.ZodType; - -declare type Messages = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function messagesFromJSON(jsonString: string): Result; - -declare function messagesToJSON(messages: Messages): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MetricOut$ { - /** @deprecated use `MetricOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MetricOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `MetricOut$Outbound` instead. */ - type Outbound = MetricOut$Outbound; -} - -/** @internal */ -declare const MetricOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type MetricOut$Outbound = { - train_loss?: number | null | undefined; - valid_loss?: number | null | undefined; - valid_mean_token_accuracy?: number | null | undefined; -}; - -/** @internal */ -declare const MetricOut$outboundSchema: z.ZodType; - -/** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ -declare type MetricOut = { - trainLoss?: number | null | undefined; - validLoss?: number | null | undefined; - validMeanTokenAccuracy?: number | null | undefined; -}; - -declare function metricOutFromJSON(jsonString: string): Result; - -declare function metricOutToJSON(metricOut: MetricOut): string; - -export declare class Mistral extends ClientSDK { - private _models?; - get models(): Models; - private _beta?; - get beta(): Beta; - private _files?; - get files(): Files; - private _fineTuning?; - get fineTuning(): FineTuning; - private _batch?; - get batch(): Batch; - private _chat?; - get chat(): Chat; - private _fim?; - get fim(): Fim; - private _agents?; - get agents(): Agents; - private _embeddings?; - get embeddings(): Embeddings; - private _classifiers?; - get classifiers(): Classifiers; - private _ocr?; - get ocr(): Ocr; - private _audio?; - get audio(): Audio_2; -} - -declare class MistralAgents extends ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - create(request: components.AgentCreationRequest, options?: RequestOptions): Promise; - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - list(request?: operations.AgentsApiV1AgentsListRequest | undefined, options?: RequestOptions): Promise>; - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - get(request: operations.AgentsApiV1AgentsGetRequest, options?: RequestOptions): Promise; - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - update(request: operations.AgentsApiV1AgentsUpdateRequest, options?: RequestOptions): Promise; - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - updateVersion(request: operations.AgentsApiV1AgentsUpdateVersionRequest, options?: RequestOptions): Promise; -} - -declare class MistralJobs extends ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - list(request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, options?: RequestOptions): Promise; - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - create(request: components.BatchJobIn, options?: RequestOptions): Promise; - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - get(request: operations.JobsApiRoutesBatchGetBatchJobRequest, options?: RequestOptions): Promise; - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - cancel(request: operations.JobsApiRoutesBatchCancelBatchJobRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace MistralPromptMode$ { - /** @deprecated use `MistralPromptMode$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `MistralPromptMode$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const MistralPromptMode$inboundSchema: z.ZodType; - -/** @internal */ -declare const MistralPromptMode$outboundSchema: z.ZodType; - -declare const MistralPromptMode: { - readonly Reasoning: "reasoning"; -}; - -declare type MistralPromptMode = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelCapabilities$ { - /** @deprecated use `ModelCapabilities$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelCapabilities$Outbound` instead. */ - type Outbound = ModelCapabilities$Outbound; -} - -/** @internal */ -declare const ModelCapabilities$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelCapabilities$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - vision: boolean; - classification: boolean; -}; - -/** @internal */ -declare const ModelCapabilities$outboundSchema: z.ZodType; - -declare type ModelCapabilities = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - vision?: boolean | undefined; - classification?: boolean | undefined; -}; - -declare function modelCapabilitiesFromJSON(jsonString: string): Result; - -declare function modelCapabilitiesToJSON(modelCapabilities: ModelCapabilities): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversation$ { - /** @deprecated use `ModelConversation$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversation$Outbound` instead. */ - type Outbound = ModelConversation$Outbound; -} - -/** @internal */ -declare const ModelConversation$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversation$Outbound = { - instructions?: string | null | undefined; - tools?: Array<(DocumentLibraryTool$Outbound & { - type: "document_library"; - }) | (FunctionTool$Outbound & { - type: "function"; - }) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; - }) | (ImageGenerationTool$Outbound & { - type: "image_generation"; - }) | (WebSearchTool$Outbound & { - type: "web_search"; - }) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; - })> | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - model: string; -}; - -/** @internal */ -declare const ModelConversation$outboundSchema: z.ZodType; - -declare type ModelConversation = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: Array<(DocumentLibraryTool & { - type: "document_library"; - }) | (FunctionTool & { - type: "function"; - }) | (CodeInterpreterTool & { - type: "code_interpreter"; - }) | (ImageGenerationTool & { - type: "image_generation"; - }) | (WebSearchTool & { - type: "web_search"; - }) | (WebSearchPremiumTool & { - type: "web_search_premium"; - })> | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: ModelConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - model: string; -}; - -declare function modelConversationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationObject$ { - /** @deprecated use `ModelConversationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; - /** @deprecated use `ModelConversationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Conversation: "conversation"; - }>; -} - -/** @internal */ -declare const ModelConversationObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelConversationObject$outboundSchema: z.ZodNativeEnum; - -declare const ModelConversationObject: { - readonly Conversation: "conversation"; -}; - -declare type ModelConversationObject = ClosedEnum; - -declare function modelConversationToJSON(modelConversation: ModelConversation): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelConversationTools$ { - /** @deprecated use `ModelConversationTools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelConversationTools$Outbound` instead. */ - type Outbound = ModelConversationTools$Outbound; -} - -/** @internal */ -declare const ModelConversationTools$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelConversationTools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const ModelConversationTools$outboundSchema: z.ZodType; - -declare type ModelConversationTools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function modelConversationToolsFromJSON(jsonString: string): Result; - -declare function modelConversationToolsToJSON(modelConversationTools: ModelConversationTools): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelList$ { - /** @deprecated use `ModelList$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModelList$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModelList$Outbound` instead. */ - type Outbound = ModelList$Outbound; -} - -/** @internal */ -declare const ModelList$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModelList$Outbound = { - object: string; - data?: Array<(FTModelCard$Outbound & { - type: "fine-tuned"; - }) | (BaseModelCard$Outbound & { - type: "base"; - })> | undefined; -}; - -/** @internal */ -declare const ModelList$outboundSchema: z.ZodType; - -declare type ModelList = { - object?: string | undefined; - data?: Array<(FTModelCard & { - type: "fine-tuned"; - }) | (BaseModelCard & { - type: "base"; - })> | undefined; -}; - -declare function modelListFromJSON(jsonString: string): Result; - -declare function modelListToJSON(modelList: ModelList): string; - -declare class Models extends ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - list(options?: RequestOptions): Promise; - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - retrieve(request: operations.RetrieveModelV1ModelsModelIdGetRequest, options?: RequestOptions): Promise; - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - delete(request: operations.DeleteModelV1ModelsModelIdDeleteRequest, options?: RequestOptions): Promise; - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - update(request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - archive(request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, options?: RequestOptions): Promise; - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - unarchive(request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModelType$ { - /** @deprecated use `ModelType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; - /** @deprecated use `ModelType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Completion: "completion"; - }>; -} - -/** @internal */ -declare const ModelType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ModelType$outboundSchema: z.ZodNativeEnum; - -declare const ModelType: { - readonly Completion: "completion"; -}; - -declare type ModelType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationObject$ { - /** @deprecated use `ModerationObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationObject$Outbound` instead. */ - type Outbound = ModerationObject$Outbound; -} - -/** @internal */ -declare const ModerationObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationObject$Outbound = { - categories?: { - [k: string]: boolean; - } | undefined; - category_scores?: { - [k: string]: number; - } | undefined; -}; - -/** @internal */ -declare const ModerationObject$outboundSchema: z.ZodType; - -declare type ModerationObject = { - /** - * Moderation result thresholds - */ - categories?: { - [k: string]: boolean; - } | undefined; - /** - * Moderation result - */ - categoryScores?: { - [k: string]: number; - } | undefined; -}; - -declare function moderationObjectFromJSON(jsonString: string): Result; - -declare function moderationObjectToJSON(moderationObject: ModerationObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ModerationResponse$ { - /** @deprecated use `ModerationResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ModerationResponse$Outbound` instead. */ - type Outbound = ModerationResponse$Outbound; -} - -/** @internal */ -declare const ModerationResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type ModerationResponse$Outbound = { - id: string; - model: string; - results: Array; -}; - -/** @internal */ -declare const ModerationResponse$outboundSchema: z.ZodType; - -declare type ModerationResponse = { - id: string; - model: string; - results: Array; -}; - -declare function moderationResponseFromJSON(jsonString: string): Result; - -declare function moderationResponseToJSON(moderationResponse: ModerationResponse): string; - -declare type OAuth2PasswordFlow = { - username: string; - password: string; - clientID?: string | undefined; - clientSecret?: string | undefined; - tokenURL: string; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ObjectT$ { - /** @deprecated use `ObjectT$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ObjectT$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ObjectT$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ObjectT$outboundSchema: z.ZodNativeEnum; - -declare const ObjectT: { - readonly Entry: "entry"; -}; - -declare type ObjectT = ClosedEnum; - -declare class Ocr extends ClientSDK { - /** - * OCR - */ - process(request: components.OCRRequest, options?: RequestOptions): Promise; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRImageObject$ { - /** @deprecated use `OCRImageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRImageObject$Outbound` instead. */ - type Outbound = OCRImageObject$Outbound; -} - -/** @internal */ -declare const OCRImageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRImageObject$Outbound = { - id: string; - top_left_x: number | null; - top_left_y: number | null; - bottom_right_x: number | null; - bottom_right_y: number | null; - image_base64?: string | null | undefined; - image_annotation?: string | null | undefined; -}; - -/** @internal */ -declare const OCRImageObject$outboundSchema: z.ZodType; - -declare type OCRImageObject = { - /** - * Image ID for extracted image in a page - */ - id: string; - /** - * X coordinate of top-left corner of the extracted image - */ - topLeftX: number | null; - /** - * Y coordinate of top-left corner of the extracted image - */ - topLeftY: number | null; - /** - * X coordinate of bottom-right corner of the extracted image - */ - bottomRightX: number | null; - /** - * Y coordinate of bottom-right corner of the extracted image - */ - bottomRightY: number | null; - /** - * Base64 string of the extracted image - */ - imageBase64?: string | null | undefined; - /** - * Annotation of the extracted image in json str - */ - imageAnnotation?: string | null | undefined; -}; - -declare function ocrImageObjectFromJSON(jsonString: string): Result; - -declare function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageDimensions$ { - /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageDimensions$Outbound` instead. */ - type Outbound = OCRPageDimensions$Outbound; -} - -/** @internal */ -declare const OCRPageDimensions$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageDimensions$Outbound = { - dpi: number; - height: number; - width: number; -}; - -/** @internal */ -declare const OCRPageDimensions$outboundSchema: z.ZodType; - -declare type OCRPageDimensions = { - /** - * Dots per inch of the page-image - */ - dpi: number; - /** - * Height of the image in pixels - */ - height: number; - /** - * Width of the image in pixels - */ - width: number; -}; - -declare function ocrPageDimensionsFromJSON(jsonString: string): Result; - -declare function ocrPageDimensionsToJSON(ocrPageDimensions: OCRPageDimensions): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRPageObject$ { - /** @deprecated use `OCRPageObject$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRPageObject$Outbound` instead. */ - type Outbound = OCRPageObject$Outbound; -} - -/** @internal */ -declare const OCRPageObject$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRPageObject$Outbound = { - index: number; - markdown: string; - images: Array; - dimensions: OCRPageDimensions$Outbound | null; -}; - -/** @internal */ -declare const OCRPageObject$outboundSchema: z.ZodType; - -declare type OCRPageObject = { - /** - * The page index in a pdf document starting from 0 - */ - index: number; - /** - * The markdown string response of the page - */ - markdown: string; - /** - * List of all extracted images in the page - */ - images: Array; - /** - * The dimensions of the PDF Page's screenshot image - */ - dimensions: OCRPageDimensions | null; -}; - -declare function ocrPageObjectFromJSON(jsonString: string): Result; - -declare function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRRequest$ { - /** @deprecated use `OCRRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRRequest$Outbound` instead. */ - type Outbound = OCRRequest$Outbound; -} - -/** @internal */ -declare const OCRRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRRequest$Outbound = { - model: string | null; - id?: string | undefined; - document: FileChunk$Outbound | DocumentURLChunk$Outbound | ImageURLChunk$Outbound; - pages?: Array | null | undefined; - include_image_base64?: boolean | null | undefined; - image_limit?: number | null | undefined; - image_min_size?: number | null | undefined; - bbox_annotation_format?: ResponseFormat$Outbound | null | undefined; - document_annotation_format?: ResponseFormat$Outbound | null | undefined; -}; - -/** @internal */ -declare const OCRRequest$outboundSchema: z.ZodType; - -declare type OCRRequest = { - model: string | null; - id?: string | undefined; - /** - * Document to run OCR on - */ - document: FileChunk | DocumentURLChunk | ImageURLChunk; - /** - * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - */ - pages?: Array | null | undefined; - /** - * Include image URLs in response - */ - includeImageBase64?: boolean | null | undefined; - /** - * Max images to extract - */ - imageLimit?: number | null | undefined; - /** - * Minimum height and width of image to extract - */ - imageMinSize?: number | null | undefined; - /** - * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - */ - bboxAnnotationFormat?: ResponseFormat | null | undefined; - /** - * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - */ - documentAnnotationFormat?: ResponseFormat | null | undefined; -}; - -declare function ocrRequestFromJSON(jsonString: string): Result; - -declare function ocrRequestToJSON(ocrRequest: OCRRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRResponse$ { - /** @deprecated use `OCRResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRResponse$Outbound` instead. */ - type Outbound = OCRResponse$Outbound; -} - -/** @internal */ -declare const OCRResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRResponse$Outbound = { - pages: Array; - model: string; - document_annotation?: string | null | undefined; - usage_info: OCRUsageInfo$Outbound; -}; - -/** @internal */ -declare const OCRResponse$outboundSchema: z.ZodType; - -declare type OCRResponse = { - /** - * List of OCR info for pages. - */ - pages: Array; - /** - * The model used to generate the OCR. - */ - model: string; - /** - * Formatted response in the request_format if provided in json str - */ - documentAnnotation?: string | null | undefined; - usageInfo: OCRUsageInfo; -}; - -declare function ocrResponseFromJSON(jsonString: string): Result; - -declare function ocrResponseToJSON(ocrResponse: OCRResponse): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OCRUsageInfo$ { - /** @deprecated use `OCRUsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OCRUsageInfo$Outbound` instead. */ - type Outbound = OCRUsageInfo$Outbound; -} - -/** @internal */ -declare const OCRUsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type OCRUsageInfo$Outbound = { - pages_processed: number; - doc_size_bytes?: number | null | undefined; -}; - -/** @internal */ -declare const OCRUsageInfo$outboundSchema: z.ZodType; - -declare type OCRUsageInfo = { - /** - * Number of pages processed - */ - pagesProcessed: number; - /** - * Document size in bytes - */ - docSizeBytes?: number | null | undefined; -}; - -declare function ocrUsageInfoFromJSON(jsonString: string): Result; - -declare function ocrUsageInfoToJSON(ocrUsageInfo: OCRUsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$ { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace One$_2 { - /** @deprecated use `One$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `One$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `One$Outbound` instead. */ - type Outbound = One$Outbound_2; -} - -/** @internal */ -declare const One$inboundSchema: z.ZodType; - -/** @internal */ -declare const One$inboundSchema_2: z.ZodType; - -/** @internal */ -declare type One$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare type One$Outbound_2 = (components.ClassifierJobOut$Outbound & { - job_type: "classifier"; -}) | (components.CompletionJobOut$Outbound & { - job_type: "completion"; -}); - -/** @internal */ -declare const One$outboundSchema: z.ZodType; - -/** @internal */ -declare const One$outboundSchema_2: z.ZodType; - -declare type One = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare type One_2 = (components.ClassifierJobOut & { - jobType: "classifier"; -}) | (components.CompletionJobOut & { - jobType: "completion"; -}); - -declare function oneFromJSON(jsonString: string): Result; - -declare function oneFromJSON_2(jsonString: string): Result; - -declare function oneToJSON(one: One): string; - -declare function oneToJSON_2(one: One_2): string; - -declare type OpenEnum = Prettify | Unrecognized; - -declare namespace operations { - export { - agentsApiV1AgentsGetRequestToJSON, - agentsApiV1AgentsGetRequestFromJSON, - AgentsApiV1AgentsGetRequest, - AgentsApiV1AgentsGetRequest$inboundSchema, - AgentsApiV1AgentsGetRequest$Outbound, - AgentsApiV1AgentsGetRequest$outboundSchema, - AgentsApiV1AgentsGetRequest$, - agentsApiV1AgentsListRequestToJSON, - agentsApiV1AgentsListRequestFromJSON, - AgentsApiV1AgentsListRequest, - AgentsApiV1AgentsListRequest$inboundSchema, - AgentsApiV1AgentsListRequest$Outbound, - AgentsApiV1AgentsListRequest$outboundSchema, - AgentsApiV1AgentsListRequest$, - agentsApiV1AgentsUpdateRequestToJSON, - agentsApiV1AgentsUpdateRequestFromJSON, - AgentsApiV1AgentsUpdateRequest, - AgentsApiV1AgentsUpdateRequest$inboundSchema, - AgentsApiV1AgentsUpdateRequest$Outbound, - AgentsApiV1AgentsUpdateRequest$outboundSchema, - AgentsApiV1AgentsUpdateRequest$, - agentsApiV1AgentsUpdateVersionRequestToJSON, - agentsApiV1AgentsUpdateVersionRequestFromJSON, - AgentsApiV1AgentsUpdateVersionRequest, - AgentsApiV1AgentsUpdateVersionRequest$inboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$Outbound, - AgentsApiV1AgentsUpdateVersionRequest$outboundSchema, - AgentsApiV1AgentsUpdateVersionRequest$, - agentsApiV1ConversationsAppendRequestToJSON, - agentsApiV1ConversationsAppendRequestFromJSON, - AgentsApiV1ConversationsAppendRequest, - AgentsApiV1ConversationsAppendRequest$inboundSchema, - AgentsApiV1ConversationsAppendRequest$Outbound, - AgentsApiV1ConversationsAppendRequest$outboundSchema, - AgentsApiV1ConversationsAppendRequest$, - agentsApiV1ConversationsAppendStreamRequestToJSON, - agentsApiV1ConversationsAppendStreamRequestFromJSON, - AgentsApiV1ConversationsAppendStreamRequest, - AgentsApiV1ConversationsAppendStreamRequest$inboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$Outbound, - AgentsApiV1ConversationsAppendStreamRequest$outboundSchema, - AgentsApiV1ConversationsAppendStreamRequest$, - agentsApiV1ConversationsGetRequestToJSON, - agentsApiV1ConversationsGetRequestFromJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON, - agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON, - AgentsApiV1ConversationsGetRequest, - AgentsApiV1ConversationsGetResponseV1ConversationsGet, - AgentsApiV1ConversationsGetRequest$inboundSchema, - AgentsApiV1ConversationsGetRequest$Outbound, - AgentsApiV1ConversationsGetRequest$outboundSchema, - AgentsApiV1ConversationsGetRequest$, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema, - AgentsApiV1ConversationsGetResponseV1ConversationsGet$, - agentsApiV1ConversationsHistoryRequestToJSON, - agentsApiV1ConversationsHistoryRequestFromJSON, - AgentsApiV1ConversationsHistoryRequest, - AgentsApiV1ConversationsHistoryRequest$inboundSchema, - AgentsApiV1ConversationsHistoryRequest$Outbound, - AgentsApiV1ConversationsHistoryRequest$outboundSchema, - AgentsApiV1ConversationsHistoryRequest$, - agentsApiV1ConversationsListRequestToJSON, - agentsApiV1ConversationsListRequestFromJSON, - responseBodyToJSON, - responseBodyFromJSON, - AgentsApiV1ConversationsListRequest, - ResponseBody, - AgentsApiV1ConversationsListRequest$inboundSchema, - AgentsApiV1ConversationsListRequest$Outbound, - AgentsApiV1ConversationsListRequest$outboundSchema, - AgentsApiV1ConversationsListRequest$, - ResponseBody$inboundSchema, - ResponseBody$Outbound, - ResponseBody$outboundSchema, - ResponseBody$, - agentsApiV1ConversationsMessagesRequestToJSON, - agentsApiV1ConversationsMessagesRequestFromJSON, - AgentsApiV1ConversationsMessagesRequest, - AgentsApiV1ConversationsMessagesRequest$inboundSchema, - AgentsApiV1ConversationsMessagesRequest$Outbound, - AgentsApiV1ConversationsMessagesRequest$outboundSchema, - AgentsApiV1ConversationsMessagesRequest$, - agentsApiV1ConversationsRestartRequestToJSON, - agentsApiV1ConversationsRestartRequestFromJSON, - AgentsApiV1ConversationsRestartRequest, - AgentsApiV1ConversationsRestartRequest$inboundSchema, - AgentsApiV1ConversationsRestartRequest$Outbound, - AgentsApiV1ConversationsRestartRequest$outboundSchema, - AgentsApiV1ConversationsRestartRequest$, - agentsApiV1ConversationsRestartStreamRequestToJSON, - agentsApiV1ConversationsRestartStreamRequestFromJSON, - AgentsApiV1ConversationsRestartStreamRequest, - AgentsApiV1ConversationsRestartStreamRequest$inboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$Outbound, - AgentsApiV1ConversationsRestartStreamRequest$outboundSchema, - AgentsApiV1ConversationsRestartStreamRequest$, - deleteModelV1ModelsModelIdDeleteRequestToJSON, - deleteModelV1ModelsModelIdDeleteRequestFromJSON, - DeleteModelV1ModelsModelIdDeleteRequest, - DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$Outbound, - DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema, - DeleteModelV1ModelsModelIdDeleteRequest$, - filesApiRoutesDeleteFileRequestToJSON, - filesApiRoutesDeleteFileRequestFromJSON, - FilesApiRoutesDeleteFileRequest, - FilesApiRoutesDeleteFileRequest$inboundSchema, - FilesApiRoutesDeleteFileRequest$Outbound, - FilesApiRoutesDeleteFileRequest$outboundSchema, - FilesApiRoutesDeleteFileRequest$, - filesApiRoutesDownloadFileRequestToJSON, - filesApiRoutesDownloadFileRequestFromJSON, - FilesApiRoutesDownloadFileRequest, - FilesApiRoutesDownloadFileRequest$inboundSchema, - FilesApiRoutesDownloadFileRequest$Outbound, - FilesApiRoutesDownloadFileRequest$outboundSchema, - FilesApiRoutesDownloadFileRequest$, - filesApiRoutesGetSignedUrlRequestToJSON, - filesApiRoutesGetSignedUrlRequestFromJSON, - FilesApiRoutesGetSignedUrlRequest, - FilesApiRoutesGetSignedUrlRequest$inboundSchema, - FilesApiRoutesGetSignedUrlRequest$Outbound, - FilesApiRoutesGetSignedUrlRequest$outboundSchema, - FilesApiRoutesGetSignedUrlRequest$, - filesApiRoutesListFilesRequestToJSON, - filesApiRoutesListFilesRequestFromJSON, - FilesApiRoutesListFilesRequest, - FilesApiRoutesListFilesRequest$inboundSchema, - FilesApiRoutesListFilesRequest$Outbound, - FilesApiRoutesListFilesRequest$outboundSchema, - FilesApiRoutesListFilesRequest$, - filesApiRoutesRetrieveFileRequestToJSON, - filesApiRoutesRetrieveFileRequestFromJSON, - FilesApiRoutesRetrieveFileRequest, - FilesApiRoutesRetrieveFileRequest$inboundSchema, - FilesApiRoutesRetrieveFileRequest$Outbound, - FilesApiRoutesRetrieveFileRequest$outboundSchema, - FilesApiRoutesRetrieveFileRequest$, - filesApiRoutesUploadFileMultiPartBodyParamsToJSON, - filesApiRoutesUploadFileMultiPartBodyParamsFromJSON, - FilesApiRoutesUploadFileMultiPartBodyParams, - FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$Outbound, - FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema, - FilesApiRoutesUploadFileMultiPartBodyParams$, - jobsApiRoutesBatchCancelBatchJobRequestToJSON, - jobsApiRoutesBatchCancelBatchJobRequestFromJSON, - JobsApiRoutesBatchCancelBatchJobRequest, - JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$Outbound, - JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema, - JobsApiRoutesBatchCancelBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobRequestToJSON, - jobsApiRoutesBatchGetBatchJobRequestFromJSON, - JobsApiRoutesBatchGetBatchJobRequest, - JobsApiRoutesBatchGetBatchJobRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$Outbound, - JobsApiRoutesBatchGetBatchJobRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobRequest$, - jobsApiRoutesBatchGetBatchJobsRequestToJSON, - jobsApiRoutesBatchGetBatchJobsRequestFromJSON, - JobsApiRoutesBatchGetBatchJobsRequest, - JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$Outbound, - JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema, - JobsApiRoutesBatchGetBatchJobsRequest$, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningCancelFineTuningJobRequest, - JobsApiRoutesFineTuningCancelFineTuningJobResponse, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobRequest$, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCancelFineTuningJobResponse$, - oneToJSON_2 as oneToJSON, - oneFromJSON_2 as oneFromJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON, - One_2 as One, - JobsApiRoutesFineTuningCreateFineTuningJobResponse, - One$inboundSchema_2 as One$inboundSchema, - One$Outbound_2 as One$Outbound, - One$outboundSchema_2 as One$outboundSchema, - One$_2 as One$, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningCreateFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningGetFineTuningJobRequest, - JobsApiRoutesFineTuningGetFineTuningJobResponse, - JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobRequest$, - JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobResponse$, - jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON, - jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON, - Status_2 as Status, - JobsApiRoutesFineTuningGetFineTuningJobsRequest, - Status$inboundSchema_2 as Status$inboundSchema, - Status$outboundSchema_2 as Status$outboundSchema, - Status$_2 as Status$, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema, - JobsApiRoutesFineTuningGetFineTuningJobsRequest$, - jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON, - jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON, - jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON, - JobsApiRoutesFineTuningStartFineTuningJobRequest, - JobsApiRoutesFineTuningStartFineTuningJobResponse, - JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobRequest$, - JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound, - JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema, - JobsApiRoutesFineTuningStartFineTuningJobResponse$, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON, - jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$, - librariesDeleteV1RequestToJSON, - librariesDeleteV1RequestFromJSON, - LibrariesDeleteV1Request, - LibrariesDeleteV1Request$inboundSchema, - LibrariesDeleteV1Request$Outbound, - LibrariesDeleteV1Request$outboundSchema, - LibrariesDeleteV1Request$, - librariesDocumentsDeleteV1RequestToJSON, - librariesDocumentsDeleteV1RequestFromJSON, - LibrariesDocumentsDeleteV1Request, - LibrariesDocumentsDeleteV1Request$inboundSchema, - LibrariesDocumentsDeleteV1Request$Outbound, - LibrariesDocumentsDeleteV1Request$outboundSchema, - LibrariesDocumentsDeleteV1Request$, - librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON, - librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$, - librariesDocumentsGetSignedUrlV1RequestToJSON, - librariesDocumentsGetSignedUrlV1RequestFromJSON, - LibrariesDocumentsGetSignedUrlV1Request, - LibrariesDocumentsGetSignedUrlV1Request$inboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$Outbound, - LibrariesDocumentsGetSignedUrlV1Request$outboundSchema, - LibrariesDocumentsGetSignedUrlV1Request$, - librariesDocumentsGetStatusV1RequestToJSON, - librariesDocumentsGetStatusV1RequestFromJSON, - LibrariesDocumentsGetStatusV1Request, - LibrariesDocumentsGetStatusV1Request$inboundSchema, - LibrariesDocumentsGetStatusV1Request$Outbound, - LibrariesDocumentsGetStatusV1Request$outboundSchema, - LibrariesDocumentsGetStatusV1Request$, - librariesDocumentsGetTextContentV1RequestToJSON, - librariesDocumentsGetTextContentV1RequestFromJSON, - LibrariesDocumentsGetTextContentV1Request, - LibrariesDocumentsGetTextContentV1Request$inboundSchema, - LibrariesDocumentsGetTextContentV1Request$Outbound, - LibrariesDocumentsGetTextContentV1Request$outboundSchema, - LibrariesDocumentsGetTextContentV1Request$, - librariesDocumentsGetV1RequestToJSON, - librariesDocumentsGetV1RequestFromJSON, - LibrariesDocumentsGetV1Request, - LibrariesDocumentsGetV1Request$inboundSchema, - LibrariesDocumentsGetV1Request$Outbound, - LibrariesDocumentsGetV1Request$outboundSchema, - LibrariesDocumentsGetV1Request$, - librariesDocumentsListV1RequestToJSON, - librariesDocumentsListV1RequestFromJSON, - LibrariesDocumentsListV1Request, - LibrariesDocumentsListV1Request$inboundSchema, - LibrariesDocumentsListV1Request$Outbound, - LibrariesDocumentsListV1Request$outboundSchema, - LibrariesDocumentsListV1Request$, - librariesDocumentsReprocessV1RequestToJSON, - librariesDocumentsReprocessV1RequestFromJSON, - LibrariesDocumentsReprocessV1Request, - LibrariesDocumentsReprocessV1Request$inboundSchema, - LibrariesDocumentsReprocessV1Request$Outbound, - LibrariesDocumentsReprocessV1Request$outboundSchema, - LibrariesDocumentsReprocessV1Request$, - librariesDocumentsUpdateV1RequestToJSON, - librariesDocumentsUpdateV1RequestFromJSON, - LibrariesDocumentsUpdateV1Request, - LibrariesDocumentsUpdateV1Request$inboundSchema, - LibrariesDocumentsUpdateV1Request$Outbound, - LibrariesDocumentsUpdateV1Request$outboundSchema, - LibrariesDocumentsUpdateV1Request$, - librariesDocumentsUploadV1DocumentUploadToJSON, - librariesDocumentsUploadV1DocumentUploadFromJSON, - librariesDocumentsUploadV1RequestToJSON, - librariesDocumentsUploadV1RequestFromJSON, - LibrariesDocumentsUploadV1DocumentUpload, - LibrariesDocumentsUploadV1Request, - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$Outbound, - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema, - LibrariesDocumentsUploadV1DocumentUpload$, - LibrariesDocumentsUploadV1Request$inboundSchema, - LibrariesDocumentsUploadV1Request$Outbound, - LibrariesDocumentsUploadV1Request$outboundSchema, - LibrariesDocumentsUploadV1Request$, - librariesGetV1RequestToJSON, - librariesGetV1RequestFromJSON, - LibrariesGetV1Request, - LibrariesGetV1Request$inboundSchema, - LibrariesGetV1Request$Outbound, - LibrariesGetV1Request$outboundSchema, - LibrariesGetV1Request$, - librariesShareCreateV1RequestToJSON, - librariesShareCreateV1RequestFromJSON, - LibrariesShareCreateV1Request, - LibrariesShareCreateV1Request$inboundSchema, - LibrariesShareCreateV1Request$Outbound, - LibrariesShareCreateV1Request$outboundSchema, - LibrariesShareCreateV1Request$, - librariesShareDeleteV1RequestToJSON, - librariesShareDeleteV1RequestFromJSON, - LibrariesShareDeleteV1Request, - LibrariesShareDeleteV1Request$inboundSchema, - LibrariesShareDeleteV1Request$Outbound, - LibrariesShareDeleteV1Request$outboundSchema, - LibrariesShareDeleteV1Request$, - librariesShareListV1RequestToJSON, - librariesShareListV1RequestFromJSON, - LibrariesShareListV1Request, - LibrariesShareListV1Request$inboundSchema, - LibrariesShareListV1Request$Outbound, - LibrariesShareListV1Request$outboundSchema, - LibrariesShareListV1Request$, - librariesUpdateV1RequestToJSON, - librariesUpdateV1RequestFromJSON, - LibrariesUpdateV1Request, - LibrariesUpdateV1Request$inboundSchema, - LibrariesUpdateV1Request$Outbound, - LibrariesUpdateV1Request$outboundSchema, - LibrariesUpdateV1Request$, - retrieveModelV1ModelsModelIdGetRequestToJSON, - retrieveModelV1ModelsModelIdGetRequestFromJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON, - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON, - RetrieveModelV1ModelsModelIdGetRequest, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - RetrieveModelV1ModelsModelIdGetRequest$inboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$Outbound, - RetrieveModelV1ModelsModelIdGetRequest$outboundSchema, - RetrieveModelV1ModelsModelIdGetRequest$, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ - } -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace OutputContentChunks$ { - /** @deprecated use `OutputContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `OutputContentChunks$Outbound` instead. */ - type Outbound = OutputContentChunks$Outbound; -} - -/** @internal */ -declare const OutputContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type OutputContentChunks$Outbound = ToolFileChunk$Outbound | ToolReferenceChunk$Outbound | TextChunk$Outbound | ImageURLChunk$Outbound | DocumentURLChunk$Outbound | ThinkChunk$Outbound; - -/** @internal */ -declare const OutputContentChunks$outboundSchema: z.ZodType; - -declare type OutputContentChunks = ToolFileChunk | ToolReferenceChunk | TextChunk | ImageURLChunk | DocumentURLChunk | ThinkChunk; - -declare function outputContentChunksFromJSON(jsonString: string): Result; - -declare function outputContentChunksToJSON(outputContentChunks: OutputContentChunks): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Outputs$ { - /** @deprecated use `Outputs$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Outputs$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Outputs$Outbound` instead. */ - type Outbound = Outputs$Outbound; -} - -/** @internal */ -declare const Outputs$inboundSchema: z.ZodType; - -/** @internal */ -declare type Outputs$Outbound = AgentHandoffEntry$Outbound | FunctionCallEntry$Outbound | ToolExecutionEntry$Outbound | MessageOutputEntry$Outbound; - -/** @internal */ -declare const Outputs$outboundSchema: z.ZodType; - -declare type Outputs = AgentHandoffEntry | FunctionCallEntry | ToolExecutionEntry | MessageOutputEntry; - -declare function outputsFromJSON(jsonString: string): Result; - -declare function outputsToJSON(outputs: Outputs): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace PaginationInfo$ { - /** @deprecated use `PaginationInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `PaginationInfo$Outbound` instead. */ - type Outbound = PaginationInfo$Outbound; -} - -/** @internal */ -declare const PaginationInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type PaginationInfo$Outbound = { - total_items: number; - total_pages: number; - current_page: number; - page_size: number; - has_more: boolean; -}; - -/** @internal */ -declare const PaginationInfo$outboundSchema: z.ZodType; - -declare type PaginationInfo = { - totalItems: number; - totalPages: number; - currentPage: number; - pageSize: number; - hasMore: boolean; -}; - -declare function paginationInfoFromJSON(jsonString: string): Result; - -declare function paginationInfoToJSON(paginationInfo: PaginationInfo): string; - -declare type ParsedAssistantMessage = components.AssistantMessage & { - parsed?: z_2.infer | undefined; -}; - -declare type ParsedChatCompletionChoice = Omit & { - message?: ParsedAssistantMessage | undefined; -}; - -declare type ParsedChatCompletionRequest = Omit & { - responseFormat: T; -}; - -declare type ParsedChatCompletionResponse = Omit & { - choices?: Array> | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Prediction$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Prediction$Outbound` instead. */ - type Outbound = Prediction$Outbound; -} - -/** @internal */ -declare const Prediction$inboundSchema: z.ZodType; - -/** @internal */ -declare type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -declare const Prediction$outboundSchema: z.ZodType; - -declare type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -declare function predictionFromJSON(jsonString: string): Result; - -declare function predictionToJSON(prediction: Prediction): string; - -declare type Prettify = { - [K in keyof T]: T[K]; -} & {}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ProcessingStatusOut$ { - /** @deprecated use `ProcessingStatusOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ProcessingStatusOut$Outbound` instead. */ - type Outbound = ProcessingStatusOut$Outbound; -} - -/** @internal */ -declare const ProcessingStatusOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type ProcessingStatusOut$Outbound = { - document_id: string; - processing_status: string; -}; - -/** @internal */ -declare const ProcessingStatusOut$outboundSchema: z.ZodType; - -declare type ProcessingStatusOut = { - documentId: string; - processingStatus: string; -}; - -declare function processingStatusOutFromJSON(jsonString: string): Result; - -declare function processingStatusOutToJSON(processingStatusOut: ProcessingStatusOut): string; - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -declare function readableStreamToArrayBuffer(readable: ReadableStream): Promise; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - type Outbound = ReferenceChunk$Outbound; -} - -/** @internal */ -declare const ReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -declare const ReferenceChunk$outboundSchema: z.ZodType; - -declare type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -declare function referenceChunkFromJSON(jsonString: string): Result; - -declare function referenceChunkToJSON(referenceChunk: ReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Reference: "reference"; - }>; -} - -/** @internal */ -declare const ReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ReferenceChunkType: { - readonly Reference: "reference"; -}; - -declare type ReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Repositories$ { - /** @deprecated use `Repositories$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Repositories$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Repositories$Outbound` instead. */ - type Outbound = Repositories$Outbound; -} - -/** @internal */ -declare const Repositories$inboundSchema: z.ZodType; - -/** @internal */ -declare type Repositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -declare const Repositories$outboundSchema: z.ZodType; - -declare type Repositories = GithubRepositoryOut; - -declare function repositoriesFromJSON(jsonString: string): Result; - -declare function repositoriesToJSON(repositories: Repositories): string; - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -declare class RequestAbortedError extends HTTPClientError { - readonly name = "RequestAbortedError"; -} - -declare type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - userAgent?: string | undefined; - timeoutMs?: number; -}; - -declare type RequestErrorHook = (err: unknown, req: Request) => Awaitable; - -declare type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -declare type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * @deprecated `fetchOptions` has been flattened into `RequestOptions`. - * - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -} & Omit; - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -declare class RequestTimeoutError extends HTTPClientError { - readonly name = "RequestTimeoutError"; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseBody$ { - /** @deprecated use `ResponseBody$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseBody$Outbound` instead. */ - type Outbound = ResponseBody$Outbound; -} - -/** @internal */ -declare const ResponseBody$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseBody$Outbound = components.ModelConversation$Outbound | components.AgentConversation$Outbound; - -/** @internal */ -declare const ResponseBody$outboundSchema: z.ZodType; - -declare type ResponseBody = components.ModelConversation | components.AgentConversation; - -declare function responseBodyFromJSON(jsonString: string): Result; - -declare function responseBodyToJSON(responseBody: ResponseBody): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEvent$ { - /** @deprecated use `ResponseDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseDoneEvent$Outbound` instead. */ - type Outbound = ResponseDoneEvent$Outbound; -} - -/** @internal */ -declare const ResponseDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -declare const ResponseDoneEvent$outboundSchema: z.ZodType; - -declare type ResponseDoneEvent = { - type?: ResponseDoneEventType | undefined; - createdAt?: Date | undefined; - usage: ConversationUsageInfo; -}; - -declare function responseDoneEventFromJSON(jsonString: string): Result; - -declare function responseDoneEventToJSON(responseDoneEvent: ResponseDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseDoneEventType$ { - /** @deprecated use `ResponseDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; - /** @deprecated use `ResponseDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseDone: "conversation.response.done"; - }>; -} - -/** @internal */ -declare const ResponseDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseDoneEventType: { - readonly ConversationResponseDone: "conversation.response.done"; -}; - -declare type ResponseDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEvent$ { - /** @deprecated use `ResponseErrorEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseErrorEvent$Outbound` instead. */ - type Outbound = ResponseErrorEvent$Outbound; -} - -/** @internal */ -declare const ResponseErrorEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseErrorEvent$Outbound = { - type: string; - created_at?: string | undefined; - message: string; - code: number; -}; - -/** @internal */ -declare const ResponseErrorEvent$outboundSchema: z.ZodType; - -declare type ResponseErrorEvent = { - type?: ResponseErrorEventType | undefined; - createdAt?: Date | undefined; - message: string; - code: number; -}; - -declare function responseErrorEventFromJSON(jsonString: string): Result; - -declare function responseErrorEventToJSON(responseErrorEvent: ResponseErrorEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseErrorEventType$ { - /** @deprecated use `ResponseErrorEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; - /** @deprecated use `ResponseErrorEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseError: "conversation.response.error"; - }>; -} - -/** @internal */ -declare const ResponseErrorEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseErrorEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseErrorEventType: { - readonly ConversationResponseError: "conversation.response.error"; -}; - -declare type ResponseErrorEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - type Outbound = ResponseFormat$Outbound; -} - -/** @internal */ -declare const ResponseFormat$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -declare const ResponseFormat$outboundSchema: z.ZodType; - -declare type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -declare function responseFormatFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; - }>; -} - -/** @internal */ -declare const ResponseFormats$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseFormats$outboundSchema: z.ZodNativeEnum; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare const ResponseFormats: { - readonly Text: "text"; - readonly JsonObject: "json_object"; - readonly JsonSchema: "json_schema"; -}; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -declare type ResponseFormats = ClosedEnum; - -declare function responseFormatToJSON(responseFormat: ResponseFormat): string; - -declare type ResponseHook = (res: Response, req: Request) => Awaitable; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEvent$ { - /** @deprecated use `ResponseStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ResponseStartedEvent$Outbound` instead. */ - type Outbound = ResponseStartedEvent$Outbound; -} - -/** @internal */ -declare const ResponseStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ResponseStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - conversation_id: string; -}; - -/** @internal */ -declare const ResponseStartedEvent$outboundSchema: z.ZodType; - -declare type ResponseStartedEvent = { - type?: ResponseStartedEventType | undefined; - createdAt?: Date | undefined; - conversationId: string; -}; - -declare function responseStartedEventFromJSON(jsonString: string): Result; - -declare function responseStartedEventToJSON(responseStartedEvent: ResponseStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ResponseStartedEventType$ { - /** @deprecated use `ResponseStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; - /** @deprecated use `ResponseStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - }>; -} - -/** @internal */ -declare const ResponseStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ResponseStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ResponseStartedEventType: { - readonly ConversationResponseStarted: "conversation.response.started"; -}; - -declare type ResponseStartedEventType = ClosedEnum; - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -declare type Result = { - ok: true; - value: T; - error?: never; -} | { - ok: false; - value?: never; - error: E; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveFileOut$ { - /** @deprecated use `RetrieveFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveFileOut$Outbound` instead. */ - type Outbound = RetrieveFileOut$Outbound; -} - -/** @internal */ -declare const RetrieveFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; - deleted: boolean; -}; - -/** @internal */ -declare const RetrieveFileOut$outboundSchema: z.ZodType; - -declare type RetrieveFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; - deleted: boolean; -}; - -declare function retrieveFileOutFromJSON(jsonString: string): Result; - -declare function retrieveFileOutToJSON(retrieveFileOut: RetrieveFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetRequest$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetRequest$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetRequest$outboundSchema: z.ZodType; - -declare type RetrieveModelV1ModelsModelIdGetRequest = { - /** - * The ID of the model to retrieve. - */ - modelId: string; -}; - -declare function retrieveModelV1ModelsModelIdGetRequestFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetRequestToJSON(retrieveModelV1ModelsModelIdGetRequest: RetrieveModelV1ModelsModelIdGetRequest): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound` instead. */ - type Outbound = RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound; -} - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema: z.ZodType; - -/** @internal */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound = (components.FTModelCard$Outbound & { - type: "fine-tuned"; -}) | (components.BaseModelCard$Outbound & { - type: "base"; -}); - -/** @internal */ -declare const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema: z.ZodType; - -/** - * Successful Response - */ -declare type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet = (components.FTModelCard & { - type: "fine-tuned"; -}) | (components.BaseModelCard & { - type: "base"; -}); - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON(jsonString: string): Result; - -declare function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON(retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet: RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet): string; - -declare type RetryConfig = { - strategy: "none"; -} | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; - /** @deprecated use `Role$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly System: "system"; - }>; -} - -/** @internal */ -declare const Role$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Role$outboundSchema: z.ZodNativeEnum; - -declare const Role: { - readonly System: "system"; -}; - -declare type Role = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SampleType$ { - /** @deprecated use `SampleType$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SampleType$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const SampleType$inboundSchema: z.ZodType; - -/** @internal */ -declare const SampleType$outboundSchema: z.ZodType; - -declare const SampleType: { - readonly Pretrain: "pretrain"; - readonly Instruct: "instruct"; - readonly BatchRequest: "batch_request"; - readonly BatchResult: "batch_result"; - readonly BatchError: "batch_error"; -}; - -declare type SampleType = OpenEnum; - -export declare const SDK_METADATA: { - readonly language: "typescript"; - readonly openapiDocVersion: "1.0.0"; - readonly sdkVersion: "1.10.0"; - readonly genVersion: "2.687.13"; - readonly userAgent: "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai"; -}; - -declare class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[]; - beforeCreateRequestHooks: BeforeCreateRequestHook[]; - beforeRequestHooks: BeforeRequestHook_2[]; - afterSuccessHooks: AfterSuccessHook[]; - afterErrorHooks: AfterErrorHook[]; - constructor(); - registerSDKInitHook(hook: SDKInitHook): void; - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - registerBeforeRequestHook(hook: BeforeRequestHook_2): void; - registerAfterSuccessHook(hook: AfterSuccessHook): void; - registerAfterErrorHook(hook: AfterErrorHook): void; - sdkInit(opts: SDKInitOptions): SDKInitOptions; - beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput; - beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise; - afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise; - afterError(hookCtx: AfterErrorContext, response: Response | null, error: unknown): Promise<{ - response: Response | null; - error: unknown; - }>; -} - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -declare interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -declare type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export declare type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default user agent used by the SDK - */ - userAgent?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -declare class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - readonly rawValue: unknown; - /** - * The raw message that failed validation. - */ - readonly rawMessage: unknown; - static [Symbol.hasInstance](instance: unknown): instance is SDKValidationError; - constructor(message: string, cause: unknown, rawValue: unknown); - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - pretty(): string; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Security$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Security$Outbound` instead. */ - type Outbound = Security$Outbound; -} - -/** @internal */ -declare const Security$inboundSchema: z.ZodType; - -/** @internal */ -declare type Security$Outbound = { - ApiKey?: string | undefined; -}; - -/** @internal */ -declare const Security$outboundSchema: z.ZodType; - -declare type Security = { - apiKey?: string | undefined; -}; - -declare function securityFromJSON(jsonString: string): Result; - -declare type SecurityState = { - basic: { - username?: string | undefined; - password?: string | undefined; - }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ - type: "password"; - } & OAuth2PasswordFlow) | { - type: "none"; - }; -}; - -declare function securityToJSON(security: Security): string; - -/** - * EU Production server - */ -export declare const ServerEu = "eu"; - -declare type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - id?: string | undefined; - retry?: number | undefined; -}; - -/** - * Contains the list of servers available to the SDK - */ -export declare const ServerList: { - readonly eu: "https://api.mistral.ai"; -}; - -export declare function serverURLFromOptions(options: SDKOptions): URL | null; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ShareEnum$ { - /** @deprecated use `ShareEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ShareEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ShareEnum$inboundSchema: z.ZodType; - -/** @internal */ -declare const ShareEnum$outboundSchema: z.ZodType; - -declare const ShareEnum: { - readonly Viewer: "Viewer"; - readonly Editor: "Editor"; -}; - -declare type ShareEnum = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingDelete$ { - /** @deprecated use `SharingDelete$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingDelete$Outbound` instead. */ - type Outbound = SharingDelete$Outbound; -} - -/** @internal */ -declare const SharingDelete$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingDelete$Outbound = { - org_id: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingDelete$outboundSchema: z.ZodType; - -declare type SharingDelete = { - orgId: string; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingDeleteFromJSON(jsonString: string): Result; - -declare function sharingDeleteToJSON(sharingDelete: SharingDelete): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingIn$ { - /** @deprecated use `SharingIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingIn$Outbound` instead. */ - type Outbound = SharingIn$Outbound; -} - -/** @internal */ -declare const SharingIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingIn$Outbound = { - org_id: string; - level: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -declare const SharingIn$outboundSchema: z.ZodType; - -declare type SharingIn = { - orgId: string; - level: ShareEnum; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -declare function sharingInFromJSON(jsonString: string): Result; - -declare function sharingInToJSON(sharingIn: SharingIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SharingOut$ { - /** @deprecated use `SharingOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SharingOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SharingOut$Outbound` instead. */ - type Outbound = SharingOut$Outbound; -} - -/** @internal */ -declare const SharingOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type SharingOut$Outbound = { - library_id: string; - user_id?: string | null | undefined; - org_id: string; - role: string; - share_with_type: string; - share_with_uuid: string; -}; - -/** @internal */ -declare const SharingOut$outboundSchema: z.ZodType; - -declare type SharingOut = { - libraryId: string; - userId?: string | null | undefined; - orgId: string; - role: string; - shareWithType: string; - shareWithUuid: string; -}; - -declare function sharingOutFromJSON(jsonString: string): Result; - -declare function sharingOutToJSON(sharingOut: SharingOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Source$ { - /** @deprecated use `Source$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Source$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const Source$inboundSchema: z.ZodType; - -/** @internal */ -declare const Source$outboundSchema: z.ZodType; - -declare const Source: { - readonly Upload: "upload"; - readonly Repository: "repository"; - readonly Mistral: "mistral"; -}; - -declare type Source = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SSETypes$ { - /** @deprecated use `SSETypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; - /** @deprecated use `SSETypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; - }>; -} - -/** @internal */ -declare const SSETypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const SSETypes$outboundSchema: z.ZodNativeEnum; - -/** - * Server side events sent when streaming a conversation response. - */ -declare const SSETypes: { - readonly ConversationResponseStarted: "conversation.response.started"; - readonly ConversationResponseDone: "conversation.response.done"; - readonly ConversationResponseError: "conversation.response.error"; - readonly MessageOutputDelta: "message.output.delta"; - readonly ToolExecutionStarted: "tool.execution.started"; - readonly ToolExecutionDelta: "tool.execution.delta"; - readonly ToolExecutionDone: "tool.execution.done"; - readonly AgentHandoffStarted: "agent.handoff.started"; - readonly AgentHandoffDone: "agent.handoff.done"; - readonly FunctionCallDelta: "function.call.delta"; -}; - -/** - * Server side events sent when streaming a conversation response. - */ -declare type SSETypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$ { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Status$_2 { - /** @deprecated use `Status$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; - /** @deprecated use `Status$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; - }>; -} - -/** @internal */ -declare const Status$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$inboundSchema_2: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Status$outboundSchema_2: z.ZodNativeEnum; - -/** - * The current status of the fine-tuning job. - */ -declare const Status: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current status of the fine-tuning job. - */ -declare type Status = ClosedEnum; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare const Status_2: { - readonly Queued: "QUEUED"; - readonly Started: "STARTED"; - readonly Validating: "VALIDATING"; - readonly Validated: "VALIDATED"; - readonly Running: "RUNNING"; - readonly FailedValidation: "FAILED_VALIDATION"; - readonly Failed: "FAILED"; - readonly Success: "SUCCESS"; - readonly Cancelled: "CANCELLED"; - readonly CancellationRequested: "CANCELLATION_REQUESTED"; -}; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -declare type Status_2 = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Stop$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Stop$Outbound` instead. */ - type Outbound = Stop$Outbound; -} - -/** @internal */ -declare const Stop$inboundSchema: z.ZodType; - -/** @internal */ -declare type Stop$Outbound = string | Array; - -/** @internal */ -declare const Stop$outboundSchema: z.ZodType; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -declare type Stop = string | Array; - -declare function stopFromJSON(jsonString: string): Result; - -declare function stopToJSON(stop: Stop): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessage$Outbound` instead. */ - type Outbound = SystemMessage$Outbound; -} - -/** @internal */ -declare const SystemMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -declare const SystemMessage$outboundSchema: z.ZodType; - -declare type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - type Outbound = SystemMessageContent$Outbound; -} - -/** @internal */ -declare const SystemMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContent$Outbound = string | Array; - -/** @internal */ -declare const SystemMessageContent$outboundSchema: z.ZodType; - -declare type SystemMessageContent = string | Array; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace SystemMessageContentChunks$ { - /** @deprecated use `SystemMessageContentChunks$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `SystemMessageContentChunks$Outbound` instead. */ - type Outbound = SystemMessageContentChunks$Outbound; -} - -/** @internal */ -declare const SystemMessageContentChunks$inboundSchema: z.ZodType; - -/** @internal */ -declare type SystemMessageContentChunks$Outbound = (TextChunk$Outbound & { - type: "text"; -}) | (ThinkChunk$Outbound & { - type: "thinking"; -}); - -/** @internal */ -declare const SystemMessageContentChunks$outboundSchema: z.ZodType; - -declare type SystemMessageContentChunks = (TextChunk & { - type: "text"; -}) | (ThinkChunk & { - type: "thinking"; -}); - -declare function systemMessageContentChunksFromJSON(jsonString: string): Result; - -declare function systemMessageContentChunksToJSON(systemMessageContentChunks: SystemMessageContentChunks): string; - -declare function systemMessageContentFromJSON(jsonString: string): Result; - -declare function systemMessageContentToJSON(systemMessageContent: SystemMessageContent): string; - -declare function systemMessageFromJSON(jsonString: string): Result; - -declare function systemMessageToJSON(systemMessage: SystemMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TextChunk$Outbound` instead. */ - type Outbound = TextChunk$Outbound; -} - -/** @internal */ -declare const TextChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -declare const TextChunk$outboundSchema: z.ZodType; - -declare type TextChunk = { - text: string; - type?: TextChunkType | undefined; -}; - -declare function textChunkFromJSON(jsonString: string): Result; - -declare function textChunkToJSON(textChunk: TextChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TextChunkType$ { - /** @deprecated use `TextChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; - /** @deprecated use `TextChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Text: "text"; - }>; -} - -/** @internal */ -declare const TextChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TextChunkType$outboundSchema: z.ZodNativeEnum; - -declare const TextChunkType: { - readonly Text: "text"; -}; - -declare type TextChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunk$ { - /** @deprecated use `ThinkChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ThinkChunk$Outbound` instead. */ - type Outbound = ThinkChunk$Outbound; -} - -/** @internal */ -declare const ThinkChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ThinkChunk$Outbound = { - thinking: Array; - closed?: boolean | undefined; - type: string; -}; - -/** @internal */ -declare const ThinkChunk$outboundSchema: z.ZodType; - -declare type ThinkChunk = { - thinking: Array; - /** - * Whether the thinking chunk is closed or not. Currently only used for prefixing. - */ - closed?: boolean | undefined; - type?: ThinkChunkType | undefined; -}; - -declare function thinkChunkFromJSON(jsonString: string): Result; - -declare function thinkChunkToJSON(thinkChunk: ThinkChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ThinkChunkType$ { - /** @deprecated use `ThinkChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; - /** @deprecated use `ThinkChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Thinking: "thinking"; - }>; -} - -/** @internal */ -declare const ThinkChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ThinkChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ThinkChunkType: { - readonly Thinking: "thinking"; -}; - -declare type ThinkChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Thinking$ { - /** @deprecated use `Thinking$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Thinking$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Thinking$Outbound` instead. */ - type Outbound = Thinking$Outbound; -} - -/** @internal */ -declare const Thinking$inboundSchema: z.ZodType; - -/** @internal */ -declare type Thinking$Outbound = ReferenceChunk$Outbound | TextChunk$Outbound; - -/** @internal */ -declare const Thinking$outboundSchema: z.ZodType; - -declare type Thinking = ReferenceChunk | TextChunk; - -declare function thinkingFromJSON(jsonString: string): Result; - -declare function thinkingToJSON(thinking: Thinking): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TimestampGranularity$ { - /** @deprecated use `TimestampGranularity$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; - /** @deprecated use `TimestampGranularity$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Segment: "segment"; - }>; -} - -/** @internal */ -declare const TimestampGranularity$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TimestampGranularity$outboundSchema: z.ZodNativeEnum; - -declare const TimestampGranularity: { - readonly Segment: "segment"; -}; - -declare type TimestampGranularity = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tool$Outbound` instead. */ - type Outbound = Tool$Outbound; -} - -/** @internal */ -declare const Tool$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -declare const Tool$outboundSchema: z.ZodType; - -declare type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolCall$Outbound` instead. */ - type Outbound = ToolCall$Outbound; -} - -/** @internal */ -declare const ToolCall$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -declare const ToolCall$outboundSchema: z.ZodType; - -declare type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -declare function toolCallFromJSON(jsonString: string): Result; - -declare function toolCallToJSON(toolCall: ToolCall): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolChoice$Outbound` instead. */ - type Outbound = ToolChoice$Outbound; -} - -/** @internal */ -declare const ToolChoice$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -declare const ToolChoice$outboundSchema: z.ZodType; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -declare type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; - }>; -} - -/** @internal */ -declare const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum; - -declare const ToolChoiceEnum: { - readonly Auto: "auto"; - readonly None: "none"; - readonly Any: "any"; - readonly Required: "required"; -}; - -declare type ToolChoiceEnum = ClosedEnum; - -declare function toolChoiceFromJSON(jsonString: string): Result; - -declare function toolChoiceToJSON(toolChoice: ToolChoice): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEvent$ { - /** @deprecated use `ToolExecutionDeltaEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDeltaEvent$Outbound` instead. */ - type Outbound = ToolExecutionDeltaEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDeltaEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDeltaEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionDeltaEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDeltaEvent = { - type?: ToolExecutionDeltaEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionDeltaEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDeltaEventToJSON(toolExecutionDeltaEvent: ToolExecutionDeltaEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDeltaEventType$ { - /** @deprecated use `ToolExecutionDeltaEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; - /** @deprecated use `ToolExecutionDeltaEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDelta: "tool.execution.delta"; - }>; -} - -/** @internal */ -declare const ToolExecutionDeltaEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDeltaEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDeltaEventType: { - readonly ToolExecutionDelta: "tool.execution.delta"; -}; - -declare type ToolExecutionDeltaEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEvent$ { - /** @deprecated use `ToolExecutionDoneEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionDoneEvent$Outbound` instead. */ - type Outbound = ToolExecutionDoneEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionDoneEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionDoneEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionDoneEvent = { - type?: ToolExecutionDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionDoneEventFromJSON(jsonString: string): Result; - -declare function toolExecutionDoneEventToJSON(toolExecutionDoneEvent: ToolExecutionDoneEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionDoneEventType$ { - /** @deprecated use `ToolExecutionDoneEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; - /** @deprecated use `ToolExecutionDoneEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionDone: "tool.execution.done"; - }>; -} - -/** @internal */ -declare const ToolExecutionDoneEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionDoneEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionDoneEventType: { - readonly ToolExecutionDone: "tool.execution.done"; -}; - -declare type ToolExecutionDoneEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntry$ { - /** @deprecated use `ToolExecutionEntry$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionEntry$Outbound` instead. */ - type Outbound = ToolExecutionEntry$Outbound; -} - -/** @internal */ -declare const ToolExecutionEntry$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - name: string; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -/** @internal */ -declare const ToolExecutionEntry$outboundSchema: z.ZodType; - -declare type ToolExecutionEntry = { - object?: ToolExecutionEntryObject | undefined; - type?: ToolExecutionEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - name: BuiltInConnectors; - arguments: string; - info?: { - [k: string]: any; - } | undefined; -}; - -declare function toolExecutionEntryFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryObject$ { - /** @deprecated use `ToolExecutionEntryObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; - /** @deprecated use `ToolExecutionEntryObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Entry: "entry"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryObject$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryObject: { - readonly Entry: "entry"; -}; - -declare type ToolExecutionEntryObject = ClosedEnum; - -declare function toolExecutionEntryToJSON(toolExecutionEntry: ToolExecutionEntry): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionEntryType$ { - /** @deprecated use `ToolExecutionEntryType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; - /** @deprecated use `ToolExecutionEntryType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecution: "tool.execution"; - }>; -} - -/** @internal */ -declare const ToolExecutionEntryType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionEntryType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionEntryType: { - readonly ToolExecution: "tool.execution"; -}; - -declare type ToolExecutionEntryType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEvent$ { - /** @deprecated use `ToolExecutionStartedEvent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolExecutionStartedEvent$Outbound` instead. */ - type Outbound = ToolExecutionStartedEvent$Outbound; -} - -/** @internal */ -declare const ToolExecutionStartedEvent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolExecutionStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -declare const ToolExecutionStartedEvent$outboundSchema: z.ZodType; - -declare type ToolExecutionStartedEvent = { - type?: ToolExecutionStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -declare function toolExecutionStartedEventFromJSON(jsonString: string): Result; - -declare function toolExecutionStartedEventToJSON(toolExecutionStartedEvent: ToolExecutionStartedEvent): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolExecutionStartedEventType$ { - /** @deprecated use `ToolExecutionStartedEventType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; - /** @deprecated use `ToolExecutionStartedEventType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolExecutionStarted: "tool.execution.started"; - }>; -} - -/** @internal */ -declare const ToolExecutionStartedEventType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolExecutionStartedEventType$outboundSchema: z.ZodNativeEnum; - -declare const ToolExecutionStartedEventType: { - readonly ToolExecutionStarted: "tool.execution.started"; -}; - -declare type ToolExecutionStartedEventType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunk$ { - /** @deprecated use `ToolFileChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolFileChunk$Outbound` instead. */ - type Outbound = ToolFileChunk$Outbound; -} - -/** @internal */ -declare const ToolFileChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolFileChunk$Outbound = { - type: string; - tool: string; - file_id: string; - file_name?: string | null | undefined; - file_type?: string | null | undefined; -}; - -/** @internal */ -declare const ToolFileChunk$outboundSchema: z.ZodType; - -declare type ToolFileChunk = { - type?: ToolFileChunkType | undefined; - tool: BuiltInConnectors; - fileId: string; - fileName?: string | null | undefined; - fileType?: string | null | undefined; -}; - -declare function toolFileChunkFromJSON(jsonString: string): Result; - -declare function toolFileChunkToJSON(toolFileChunk: ToolFileChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolFileChunkType$ { - /** @deprecated use `ToolFileChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; - /** @deprecated use `ToolFileChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolFile: "tool_file"; - }>; -} - -/** @internal */ -declare const ToolFileChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolFileChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolFileChunkType: { - readonly ToolFile: "tool_file"; -}; - -declare type ToolFileChunkType = ClosedEnum; - -declare function toolFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessage$Outbound` instead. */ - type Outbound = ToolMessage$Outbound; -} - -/** @internal */ -declare const ToolMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -declare const ToolMessage$outboundSchema: z.ZodType; - -declare type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - type Outbound = ToolMessageContent$Outbound; -} - -/** @internal */ -declare const ToolMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -declare const ToolMessageContent$outboundSchema: z.ZodType; - -declare type ToolMessageContent = string | Array; - -declare function toolMessageContentFromJSON(jsonString: string): Result; - -declare function toolMessageContentToJSON(toolMessageContent: ToolMessageContent): string; - -declare function toolMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Tool: "tool"; - }>; -} - -/** @internal */ -declare const ToolMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const ToolMessageRole: { - readonly Tool: "tool"; -}; - -declare type ToolMessageRole = ClosedEnum; - -declare function toolMessageToJSON(toolMessage: ToolMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunk$ { - /** @deprecated use `ToolReferenceChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ToolReferenceChunk$Outbound` instead. */ - type Outbound = ToolReferenceChunk$Outbound; -} - -/** @internal */ -declare const ToolReferenceChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type ToolReferenceChunk$Outbound = { - type: string; - tool: string; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const ToolReferenceChunk$outboundSchema: z.ZodType; - -declare type ToolReferenceChunk = { - type?: ToolReferenceChunkType | undefined; - tool: BuiltInConnectors; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function toolReferenceChunkFromJSON(jsonString: string): Result; - -declare function toolReferenceChunkToJSON(toolReferenceChunk: ToolReferenceChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolReferenceChunkType$ { - /** @deprecated use `ToolReferenceChunkType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; - /** @deprecated use `ToolReferenceChunkType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly ToolReference: "tool_reference"; - }>; -} - -/** @internal */ -declare const ToolReferenceChunkType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const ToolReferenceChunkType$outboundSchema: z.ZodNativeEnum; - -declare const ToolReferenceChunkType: { - readonly ToolReference: "tool_reference"; -}; - -declare type ToolReferenceChunkType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Tools$ { - /** @deprecated use `Tools$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Tools$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Tools$Outbound` instead. */ - type Outbound = Tools$Outbound; -} - -/** @internal */ -declare const Tools$inboundSchema: z.ZodType; - -/** @internal */ -declare type Tools$Outbound = (DocumentLibraryTool$Outbound & { - type: "document_library"; -}) | (FunctionTool$Outbound & { - type: "function"; -}) | (CodeInterpreterTool$Outbound & { - type: "code_interpreter"; -}) | (ImageGenerationTool$Outbound & { - type: "image_generation"; -}) | (WebSearchTool$Outbound & { - type: "web_search"; -}) | (WebSearchPremiumTool$Outbound & { - type: "web_search_premium"; -}); - -/** @internal */ -declare const Tools$outboundSchema: z.ZodType; - -declare type Tools = (DocumentLibraryTool & { - type: "document_library"; -}) | (FunctionTool & { - type: "function"; -}) | (CodeInterpreterTool & { - type: "code_interpreter"; -}) | (ImageGenerationTool & { - type: "image_generation"; -}) | (WebSearchTool & { - type: "web_search"; -}) | (WebSearchPremiumTool & { - type: "web_search_premium"; -}); - -declare function toolsFromJSON(jsonString: string): Result; - -declare function toolsToJSON(tools: Tools): string; - -declare function toolToJSON(tool: Tool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodType; -} - -/** @internal */ -declare const ToolTypes$inboundSchema: z.ZodType; - -/** @internal */ -declare const ToolTypes$outboundSchema: z.ZodType; - -declare const ToolTypes: { - readonly Function: "function"; -}; - -declare type ToolTypes = OpenEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TrainingFile$ { - /** @deprecated use `TrainingFile$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TrainingFile$Outbound` instead. */ - type Outbound = TrainingFile$Outbound; -} - -/** @internal */ -declare const TrainingFile$inboundSchema: z.ZodType; - -/** @internal */ -declare type TrainingFile$Outbound = { - file_id: string; - weight: number; -}; - -/** @internal */ -declare const TrainingFile$outboundSchema: z.ZodType; - -declare type TrainingFile = { - fileId: string; - weight?: number | undefined; -}; - -declare function trainingFileFromJSON(jsonString: string): Result; - -declare function trainingFileToJSON(trainingFile: TrainingFile): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionResponse$ { - /** @deprecated use `TranscriptionResponse$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionResponse$Outbound` instead. */ - type Outbound = TranscriptionResponse$Outbound; -} - -/** @internal */ -declare const TranscriptionResponse$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionResponse$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionResponse$outboundSchema: z.ZodType; - -declare type TranscriptionResponse = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionResponseFromJSON(jsonString: string): Result; - -declare function transcriptionResponseToJSON(transcriptionResponse: TranscriptionResponse): string; - -declare class Transcriptions extends ClientSDK { - /** - * Create Transcription - */ - complete(request: components.AudioTranscriptionRequest, options?: RequestOptions): Promise; - /** - * Create streaming transcription (SSE) - */ - stream(request: components.AudioTranscriptionRequestStream, options?: RequestOptions): Promise>; -} - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionSegmentChunk$ { - /** @deprecated use `TranscriptionSegmentChunk$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionSegmentChunk$Outbound` instead. */ - type Outbound = TranscriptionSegmentChunk$Outbound; -} - -/** @internal */ -declare const TranscriptionSegmentChunk$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionSegmentChunk$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionSegmentChunk$outboundSchema: z.ZodType; - -declare type TranscriptionSegmentChunk = { - text: string; - start: number; - end: number; - type?: Type | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionSegmentChunkFromJSON(jsonString: string): Result; - -declare function transcriptionSegmentChunkToJSON(transcriptionSegmentChunk: TranscriptionSegmentChunk): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDone$ { - /** @deprecated use `TranscriptionStreamDone$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamDone$Outbound` instead. */ - type Outbound = TranscriptionStreamDone$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamDone$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamDone$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - type: string; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamDone$outboundSchema: z.ZodType; - -declare type TranscriptionStreamDone = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - type?: TranscriptionStreamDoneType | undefined; - language: string | null; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamDoneFromJSON(jsonString: string): Result; - -declare function transcriptionStreamDoneToJSON(transcriptionStreamDone: TranscriptionStreamDone): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamDoneType$ { - /** @deprecated use `TranscriptionStreamDoneType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamDoneType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamDoneType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamDoneType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamDoneType: { - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamDoneType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEvents$ { - /** @deprecated use `TranscriptionStreamEvents$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEvents$Outbound` instead. */ - type Outbound = TranscriptionStreamEvents$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEvents$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEvents$Outbound = { - event: string; - data: (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; - }); -}; - -/** @internal */ -declare const TranscriptionStreamEvents$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEvents = { - event: TranscriptionStreamEventTypes; - data: (TranscriptionStreamDone & { - type: "transcription.done"; - }) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; - }) | (TranscriptionStreamLanguage & { - type: "transcription.language"; - }) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; - }); -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventsData$ { - /** @deprecated use `TranscriptionStreamEventsData$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamEventsData$Outbound` instead. */ - type Outbound = TranscriptionStreamEventsData$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamEventsData$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamEventsData$Outbound = (TranscriptionStreamDone$Outbound & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; -}); - -/** @internal */ -declare const TranscriptionStreamEventsData$outboundSchema: z.ZodType; - -declare type TranscriptionStreamEventsData = (TranscriptionStreamDone & { - type: "transcription.done"; -}) | (TranscriptionStreamSegmentDelta & { - type: "transcription.segment"; -}) | (TranscriptionStreamLanguage & { - type: "transcription.language"; -}) | (TranscriptionStreamTextDelta & { - type: "transcription.text.delta"; -}); - -declare function transcriptionStreamEventsDataFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsDataToJSON(transcriptionStreamEventsData: TranscriptionStreamEventsData): string; - -declare function transcriptionStreamEventsFromJSON(jsonString: string): Result; - -declare function transcriptionStreamEventsToJSON(transcriptionStreamEvents: TranscriptionStreamEvents): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamEventTypes$ { - /** @deprecated use `TranscriptionStreamEventTypes$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; - /** @deprecated use `TranscriptionStreamEventTypes$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamEventTypes$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamEventTypes$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamEventTypes: { - readonly TranscriptionLanguage: "transcription.language"; - readonly TranscriptionSegment: "transcription.segment"; - readonly TranscriptionTextDelta: "transcription.text.delta"; - readonly TranscriptionDone: "transcription.done"; -}; - -declare type TranscriptionStreamEventTypes = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguage$ { - /** @deprecated use `TranscriptionStreamLanguage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamLanguage$Outbound` instead. */ - type Outbound = TranscriptionStreamLanguage$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamLanguage$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamLanguage$Outbound = { - type: string; - audio_language: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamLanguage$outboundSchema: z.ZodType; - -declare type TranscriptionStreamLanguage = { - type?: TranscriptionStreamLanguageType | undefined; - audioLanguage: string; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamLanguageFromJSON(jsonString: string): Result; - -declare function transcriptionStreamLanguageToJSON(transcriptionStreamLanguage: TranscriptionStreamLanguage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamLanguageType$ { - /** @deprecated use `TranscriptionStreamLanguageType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; - /** @deprecated use `TranscriptionStreamLanguageType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionLanguage: "transcription.language"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamLanguageType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamLanguageType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamLanguageType: { - readonly TranscriptionLanguage: "transcription.language"; -}; - -declare type TranscriptionStreamLanguageType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDelta$ { - /** @deprecated use `TranscriptionStreamSegmentDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamSegmentDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamSegmentDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamSegmentDelta$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamSegmentDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamSegmentDelta = { - text: string; - start: number; - end: number; - type?: TranscriptionStreamSegmentDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamSegmentDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamSegmentDeltaToJSON(transcriptionStreamSegmentDelta: TranscriptionStreamSegmentDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamSegmentDeltaType$ { - /** @deprecated use `TranscriptionStreamSegmentDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; - /** @deprecated use `TranscriptionStreamSegmentDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription.segment"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamSegmentDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamSegmentDeltaType: { - readonly TranscriptionSegment: "transcription.segment"; -}; - -declare type TranscriptionStreamSegmentDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDelta$ { - /** @deprecated use `TranscriptionStreamTextDelta$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `TranscriptionStreamTextDelta$Outbound` instead. */ - type Outbound = TranscriptionStreamTextDelta$Outbound; -} - -/** @internal */ -declare const TranscriptionStreamTextDelta$inboundSchema: z.ZodType; - -/** @internal */ -declare type TranscriptionStreamTextDelta$Outbound = { - text: string; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const TranscriptionStreamTextDelta$outboundSchema: z.ZodType; - -declare type TranscriptionStreamTextDelta = { - text: string; - type?: TranscriptionStreamTextDeltaType | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function transcriptionStreamTextDeltaFromJSON(jsonString: string): Result; - -declare function transcriptionStreamTextDeltaToJSON(transcriptionStreamTextDelta: TranscriptionStreamTextDelta): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace TranscriptionStreamTextDeltaType$ { - /** @deprecated use `TranscriptionStreamTextDeltaType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; - /** @deprecated use `TranscriptionStreamTextDeltaType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionTextDelta: "transcription.text.delta"; - }>; -} - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const TranscriptionStreamTextDeltaType$outboundSchema: z.ZodNativeEnum; - -declare const TranscriptionStreamTextDeltaType: { - readonly TranscriptionTextDelta: "transcription.text.delta"; -}; - -declare type TranscriptionStreamTextDeltaType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Two$ { - /** @deprecated use `Two$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `Two$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `Two$Outbound` instead. */ - type Outbound = Two$Outbound; -} - -/** @internal */ -declare const Two$inboundSchema: z.ZodType; - -/** @internal */ -declare type Two$Outbound = (SystemMessage$Outbound & { - role: "system"; -}) | (ToolMessage$Outbound & { - role: "tool"; -}) | (UserMessage$Outbound & { - role: "user"; -}) | (AssistantMessage$Outbound & { - role: "assistant"; -}); - -/** @internal */ -declare const Two$outboundSchema: z.ZodType; - -declare type Two = (SystemMessage & { - role: "system"; -}) | (ToolMessage & { - role: "tool"; -}) | (UserMessage & { - role: "user"; -}) | (AssistantMessage & { - role: "assistant"; -}); - -declare function twoFromJSON(jsonString: string): Result; - -declare function twoToJSON(two: Two): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; - /** @deprecated use `Type$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly TranscriptionSegment: "transcription_segment"; - }>; -} - -/** @internal */ -declare const Type$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const Type$outboundSchema: z.ZodNativeEnum; - -declare const Type: { - readonly TranscriptionSegment: "transcription_segment"; -}; - -declare type Type = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOut$ { - /** @deprecated use `UnarchiveFTModelOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UnarchiveFTModelOut$Outbound` instead. */ - type Outbound = UnarchiveFTModelOut$Outbound; -} - -/** @internal */ -declare const UnarchiveFTModelOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UnarchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -declare const UnarchiveFTModelOut$outboundSchema: z.ZodType; - -declare type UnarchiveFTModelOut = { - id: string; - object?: UnarchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -declare function unarchiveFTModelOutFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UnarchiveFTModelOutObject$ { - /** @deprecated use `UnarchiveFTModelOutObject$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; - /** @deprecated use `UnarchiveFTModelOutObject$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Model: "model"; - }>; -} - -/** @internal */ -declare const UnarchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UnarchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum; - -declare const UnarchiveFTModelOutObject: { - readonly Model: "model"; -}; - -declare type UnarchiveFTModelOutObject = ClosedEnum; - -declare function unarchiveFTModelOutToJSON(unarchiveFTModelOut: UnarchiveFTModelOut): string; - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -declare class UnexpectedClientError extends HTTPClientError { - name: string; -} - -declare type Unrecognized = T & { - [__brand]: "unrecognized"; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UpdateFTModelIn$ { - /** @deprecated use `UpdateFTModelIn$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UpdateFTModelIn$Outbound` instead. */ - type Outbound = UpdateFTModelIn$Outbound; -} - -/** @internal */ -declare const UpdateFTModelIn$inboundSchema: z.ZodType; - -/** @internal */ -declare type UpdateFTModelIn$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -declare const UpdateFTModelIn$outboundSchema: z.ZodType; - -declare type UpdateFTModelIn = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -declare function updateFTModelInFromJSON(jsonString: string): Result; - -declare function updateFTModelInToJSON(updateFTModelIn: UpdateFTModelIn): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UploadFileOut$ { - /** @deprecated use `UploadFileOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UploadFileOut$Outbound` instead. */ - type Outbound = UploadFileOut$Outbound; -} - -/** @internal */ -declare const UploadFileOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type UploadFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -declare const UploadFileOut$outboundSchema: z.ZodType; - -declare type UploadFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -declare function uploadFileOutFromJSON(jsonString: string): Result; - -declare function uploadFileOutToJSON(uploadFileOut: UploadFileOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UsageInfo$Outbound` instead. */ - type Outbound = UsageInfo$Outbound; -} - -/** @internal */ -declare const UsageInfo$inboundSchema: z.ZodType; - -/** @internal */ -declare type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - prompt_audio_seconds?: number | null | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -declare const UsageInfo$outboundSchema: z.ZodType; - -declare type UsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - promptAudioSeconds?: number | null | undefined; - additionalProperties?: { - [k: string]: any; - }; -}; - -declare function usageInfoFromJSON(jsonString: string): Result; - -declare function usageInfoToJSON(usageInfo: UsageInfo): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessage$Outbound` instead. */ - type Outbound = UserMessage$Outbound; -} - -/** @internal */ -declare const UserMessage$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -declare const UserMessage$outboundSchema: z.ZodType; - -declare type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - type Outbound = UserMessageContent$Outbound; -} - -/** @internal */ -declare const UserMessageContent$inboundSchema: z.ZodType; - -/** @internal */ -declare type UserMessageContent$Outbound = string | Array; - -/** @internal */ -declare const UserMessageContent$outboundSchema: z.ZodType; - -declare type UserMessageContent = string | Array; - -declare function userMessageContentFromJSON(jsonString: string): Result; - -declare function userMessageContentToJSON(userMessageContent: UserMessageContent): string; - -declare function userMessageFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly User: "user"; - }>; -} - -/** @internal */ -declare const UserMessageRole$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const UserMessageRole$outboundSchema: z.ZodNativeEnum; - -declare const UserMessageRole: { - readonly User: "user"; -}; - -declare type UserMessageRole = ClosedEnum; - -declare function userMessageToJSON(userMessage: UserMessage): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `ValidationError$Outbound` instead. */ - type Outbound = ValidationError$Outbound; -} - -/** @internal */ -declare const ValidationError$inboundSchema: z.ZodType; - -/** @internal */ -declare type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -declare const ValidationError$outboundSchema: z.ZodType; - -declare type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -declare function validationErrorFromJSON(jsonString: string): Result; - -declare function validationErrorToJSON(validationError: ValidationError): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegration$ { - /** @deprecated use `WandbIntegration$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegration$Outbound` instead. */ - type Outbound = WandbIntegration$Outbound; -} - -/** @internal */ -declare const WandbIntegration$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegration$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - api_key: string; - run_name?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegration$outboundSchema: z.ZodType; - -declare type WandbIntegration = { - type?: WandbIntegrationType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - /** - * The WandB API key to use for authentication. - */ - apiKey: string; - runName?: string | null | undefined; -}; - -declare function wandbIntegrationFromJSON(jsonString: string): Result; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOut$ { - /** @deprecated use `WandbIntegrationOut$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WandbIntegrationOut$Outbound` instead. */ - type Outbound = WandbIntegrationOut$Outbound; -} - -/** @internal */ -declare const WandbIntegrationOut$inboundSchema: z.ZodType; - -/** @internal */ -declare type WandbIntegrationOut$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - run_name?: string | null | undefined; - url?: string | null | undefined; -}; - -/** @internal */ -declare const WandbIntegrationOut$outboundSchema: z.ZodType; - -declare type WandbIntegrationOut = { - type?: WandbIntegrationOutType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - runName?: string | null | undefined; - url?: string | null | undefined; -}; - -declare function wandbIntegrationOutFromJSON(jsonString: string): Result; - -declare function wandbIntegrationOutToJSON(wandbIntegrationOut: WandbIntegrationOut): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationOutType$ { - /** @deprecated use `WandbIntegrationOutType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationOutType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationOutType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationOutType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationOutType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationOutType = ClosedEnum; - -declare function wandbIntegrationToJSON(wandbIntegration: WandbIntegration): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WandbIntegrationType$ { - /** @deprecated use `WandbIntegrationType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; - /** @deprecated use `WandbIntegrationType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly Wandb: "wandb"; - }>; -} - -/** @internal */ -declare const WandbIntegrationType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WandbIntegrationType$outboundSchema: z.ZodNativeEnum; - -declare const WandbIntegrationType: { - readonly Wandb: "wandb"; -}; - -declare type WandbIntegrationType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumTool$ { - /** @deprecated use `WebSearchPremiumTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchPremiumTool$Outbound` instead. */ - type Outbound = WebSearchPremiumTool$Outbound; -} - -/** @internal */ -declare const WebSearchPremiumTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchPremiumTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchPremiumTool$outboundSchema: z.ZodType; - -declare type WebSearchPremiumTool = { - type?: WebSearchPremiumToolType | undefined; -}; - -declare function webSearchPremiumToolFromJSON(jsonString: string): Result; - -declare function webSearchPremiumToolToJSON(webSearchPremiumTool: WebSearchPremiumTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchPremiumToolType$ { - /** @deprecated use `WebSearchPremiumToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; - /** @deprecated use `WebSearchPremiumToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearchPremium: "web_search_premium"; - }>; -} - -/** @internal */ -declare const WebSearchPremiumToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchPremiumToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchPremiumToolType: { - readonly WebSearchPremium: "web_search_premium"; -}; - -declare type WebSearchPremiumToolType = ClosedEnum; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchTool$ { - /** @deprecated use `WebSearchTool$inboundSchema` instead. */ - const inboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$outboundSchema` instead. */ - const outboundSchema: z.ZodType; - /** @deprecated use `WebSearchTool$Outbound` instead. */ - type Outbound = WebSearchTool$Outbound; -} - -/** @internal */ -declare const WebSearchTool$inboundSchema: z.ZodType; - -/** @internal */ -declare type WebSearchTool$Outbound = { - type: string; -}; - -/** @internal */ -declare const WebSearchTool$outboundSchema: z.ZodType; - -declare type WebSearchTool = { - type?: WebSearchToolType | undefined; -}; - -declare function webSearchToolFromJSON(jsonString: string): Result; - -declare function webSearchToolToJSON(webSearchTool: WebSearchTool): string; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -declare namespace WebSearchToolType$ { - /** @deprecated use `WebSearchToolType$inboundSchema` instead. */ - const inboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; - /** @deprecated use `WebSearchToolType$outboundSchema` instead. */ - const outboundSchema: z.ZodNativeEnum<{ - readonly WebSearch: "web_search"; - }>; -} - -/** @internal */ -declare const WebSearchToolType$inboundSchema: z.ZodNativeEnum; - -/** @internal */ -declare const WebSearchToolType$outboundSchema: z.ZodNativeEnum; - -declare const WebSearchToolType: { - readonly WebSearch: "web_search"; -}; - -declare type WebSearchToolType = ClosedEnum; - -export { } diff --git a/examples/nextra/speakeasy.mistral.config.mjs b/examples/nextra/speakeasy.mistral.config.mjs deleted file mode 100644 index 3e7fd636c..000000000 --- a/examples/nextra/speakeasy.mistral.config.mjs +++ /dev/null @@ -1,25 +0,0 @@ -export default { - spec: "../specs/mistral.yaml", - output: { - pageOutDir: "./src/app/mistral/api", - framework: "nextra", - }, - codeSamples: [ - { - language: "typescript", - sdkFolder: "../sdks/mistral-typescript", - tryItNow: { - outDir: "./public/mistral-try-it-now", - urlPrefix: "/mistral-try-it-now", - }, - }, - { - language: "python", - sdkTarballPath: "../sdks/mistral-python.tar.gz", - }, - { - language: "curl", - tryItNow: true, - }, - ], -}; diff --git a/examples/nextra/speakeasy.pokeapi.config.mjs b/examples/nextra/speakeasy.pokeapi.config.mjs deleted file mode 100644 index dddf2a982..000000000 --- a/examples/nextra/speakeasy.pokeapi.config.mjs +++ /dev/null @@ -1,12 +0,0 @@ -export default { - spec: "../specs/pokeapi.yml", - output: { - pageOutDir: "./src/app/pokeapi/api", - framework: "nextra", - }, - codeSamples: [ - { - language: "curl", - }, - ], -}; diff --git a/examples/nextra/src/app/layout.tsx b/examples/nextra/src/app/layout.tsx deleted file mode 100644 index a9791bc2c..000000000 --- a/examples/nextra/src/app/layout.tsx +++ /dev/null @@ -1,51 +0,0 @@ -import { Footer, Layout, Navbar } from "nextra-theme-docs"; -import { Banner, Head } from "nextra/components"; -import { getPageMap } from "nextra/page-map"; -import "nextra-theme-docs/style.css"; - -export const metadata = { - // Define your metadata here - // For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata -}; - -const navbar = ( - Speakeasy Nextra Demo} - // ... Your additional navbar options - /> -); -const footer =
    MIT {new Date().getFullYear()} © Speakeasy.
    ; - -export default async function RootLayout({ - children, -}: { - children: React.ReactNode; -}) { - return ( - - - {/* Your additional tags should be passed as `children` of `` element */} - - - - {children} - - - - ); -} diff --git a/examples/nextra/src/app/mistral/api/_meta.ts b/examples/nextra/src/app/mistral/api/_meta.ts deleted file mode 100644 index 7a9470c09..000000000 --- a/examples/nextra/src/app/mistral/api/_meta.ts +++ /dev/null @@ -1,4 +0,0 @@ -export default { - index: { title: "About", theme: { collapsed: false } }, - endpoint: { title: "Operations", theme: { collapsed: false } } - } \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/agents/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/agents/page.mdx deleted file mode 100644 index f7383dc63..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/agents/page.mdx +++ /dev/null @@ -1,5597 +0,0 @@ ---- -sidebarTitle: Agents ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Agents Endpoints - - - - - -Agents API. - - - - - - - - - -## POST /v1/agents/completions [#operation-agents_completion_v1_agents_completions_post] - - - - - -Agents Completion - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.agents.complete(messages=[ - { - "content": "Who is the best French painter? Answer in one short sentence.", - "role": "user", - }, - ], agent_id="", stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-agents_completion_v1_agents_completions_post_request-examples] - - - - - -```json -{ - "agent_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do" - } - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_completion_v1_agents_completions_post_request] - - - - - - - - - - - -##### agent_id [#operation-agents_completion_v1_agents_completions_post_request_agent_id] - - - - - -The ID of the agent to use for this completion. - - - - - - - - - -##### frequency_penalty [#operation-agents_completion_v1_agents_completions_post_request_frequency_penalty] - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens [#operation-agents_completion_v1_agents_completions_post_request_max_tokens] - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages [#operation-agents_completion_v1_agents_completions_post_request_messages] - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - - - -#### SystemMessage [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage] - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content] - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role [#operation-agents_completion_v1_agents_completions_post_request_messages_systemmessage_role] - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content] - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-agents_completion_v1_agents_completions_post_request_messages_usermessage_role] - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content] - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_name] - - - - - - - - - -##### role [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_role] - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id [#operation-agents_completion_v1_agents_completions_post_request_messages_toolmessage_tool_call_id] - - - - - - - - - - - - - - - - - -##### n [#operation-agents_completion_v1_agents_completions_post_request_n] - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - - - -##### parallel_tool_calls [#operation-agents_completion_v1_agents_completions_post_request_parallel_tool_calls] - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction [#operation-agents_completion_v1_agents_completions_post_request_prediction] - - - - - - - - - -#### Prediction [#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_completion_v1_agents_completions_post_request_presence_penalty] - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode [#operation-agents_completion_v1_agents_completions_post_request_prompt_mode] - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - - - -##### random_seed [#operation-agents_completion_v1_agents_completions_post_request_random_seed] - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format [#operation-agents_completion_v1_agents_completions_post_request_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_completion_v1_agents_completions_post_request_stop] - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream [#operation-agents_completion_v1_agents_completions_post_request_stream] - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice [#operation-agents_completion_v1_agents_completions_post_request_tool_choice] - - - - - - - - - -#### ToolChoice [#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice] - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function] - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -#### FunctionName [#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function_functionname] - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_function_functionname_name] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_tool_choice_toolchoice_type] - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_completion_v1_agents_completions_post_request_tools] - - - - - - - - - -#### Tool [#operation-agents_completion_v1_agents_completions_post_request_tools_tool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function] - - - - - - - - - -#### Function [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function] - - - - - - - - - -##### description [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_request_tools_tool_type] - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_completion_v1_agents_completions_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_completion_v1_agents_completions_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices] - - - - - - - - - -#### ChatCompletionChoice [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice] - - - - - - - - - -##### finish_reason [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason] - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_index] - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message] - - - - - - - - - -#### AssistantMessage [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_created] - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_model] - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_object] - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage] - - - - - - - - - -#### UsageInfo [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_completion_v1_agents_completions_post_responses_200_application-json_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_completion_v1_agents_completions_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx deleted file mode 100644 index a0c18dada..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/audio/transcriptions/page.mdx +++ /dev/null @@ -1,2043 +0,0 @@ ---- -sidebarTitle: Audio Transcriptions ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Audio Transcriptions Endpoints - - - - - -API for audio transcription. - - - - - - - - - -## POST /v1/audio/transcriptions [#operation-audio_api_v1_transcriptions_post] - - - - - -Create Transcription - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.audio.transcriptions.complete(model="Model X") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-audio_api_v1_transcriptions_post_request-examples] - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-audio_api_v1_transcriptions_post_request] - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file [#operation-audio_api_v1_transcriptions_post_request_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File [#operation-audio_api_v1_transcriptions_post_request_file_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content [#operation-audio_api_v1_transcriptions_post_request_file_file_content] - - - - - - - - - -##### fileName [#operation-audio_api_v1_transcriptions_post_request_file_file_filename] - - - - - - - - - - - - - - - - - -##### file_id [#operation-audio_api_v1_transcriptions_post_request_file_id] - - - - - -ID of a file uploaded to /v1/files - - - - - - - - - -##### file_url [#operation-audio_api_v1_transcriptions_post_request_file_url] - - - - - -Url of a file to be transcribed - - - - - - - - - -##### language [#operation-audio_api_v1_transcriptions_post_request_language] - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - - - -##### model [#operation-audio_api_v1_transcriptions_post_request_model] - - - - - - - - - -##### stream [#operation-audio_api_v1_transcriptions_post_request_stream] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature [#operation-audio_api_v1_transcriptions_post_request_temperature] - - - - - - - - - -##### timestamp_granularities [#operation-audio_api_v1_transcriptions_post_request_timestamp_granularities] - - - - - -Granularities of timestamps to include in the response. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-audio_api_v1_transcriptions_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "language": null, - "model": "ipsum eiusmod", - "text": "consequat do", - "usage": {} -} -``` - - - - - - - - - - - - - -### Responses [#operation-audio_api_v1_transcriptions_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### language [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_language] - - - - - - - - - -##### model [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_model] - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### segments [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments] - - - - - - - - - -#### TranscriptionSegmentChunk [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk] - - - - - - - - - -##### end [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_end] - - - - - - - - - -##### start [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_start] - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_text] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_segments_transcriptionsegmentchunk_type] - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_text] - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage] - - - - - - - - - -#### UsageInfo [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-audio_api_v1_transcriptions_post_responses_200_application-json_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/audio/transcriptions\#stream [#operation-audio_api_v1_transcriptions_post_stream] - - - - - -Create streaming transcription (SSE) - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.audio.transcriptions.stream(model="Camry") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-audio_api_v1_transcriptions_post_stream_request-examples] - - - - - -```json -{ - "model": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-audio_api_v1_transcriptions_post_stream_request] - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file [#operation-audio_api_v1_transcriptions_post_stream_request_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File [#operation-audio_api_v1_transcriptions_post_stream_request_file_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content [#operation-audio_api_v1_transcriptions_post_stream_request_file_file_content] - - - - - - - - - -##### fileName [#operation-audio_api_v1_transcriptions_post_stream_request_file_file_filename] - - - - - - - - - - - - - - - - - -##### file_id [#operation-audio_api_v1_transcriptions_post_stream_request_file_id] - - - - - -ID of a file uploaded to /v1/files - - - - - - - - - -##### file_url [#operation-audio_api_v1_transcriptions_post_stream_request_file_url] - - - - - -Url of a file to be transcribed - - - - - - - - - -##### language [#operation-audio_api_v1_transcriptions_post_stream_request_language] - - - - - -Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - - - - - - - - - -##### model [#operation-audio_api_v1_transcriptions_post_stream_request_model] - - - - - - - - - -##### stream [#operation-audio_api_v1_transcriptions_post_stream_request_stream] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### temperature [#operation-audio_api_v1_transcriptions_post_stream_request_temperature] - - - - - - - - - -##### timestamp_granularities [#operation-audio_api_v1_transcriptions_post_stream_request_timestamp_granularities] - - - - - -Granularities of timestamps to include in the response. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-audio_api_v1_transcriptions_post_stream_responses-examples] - - - - - -200 - - - - - -```json -null -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-audio_api_v1_transcriptions_post_stream_responses] - - - - - -200 - - - - - - - -TranscriptionStreamEvents","children":[{"label":"TranscriptionStreamEvents","linkedLabel":"TranscriptionStreamEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Stream of transcription events - - - - - - - - - -#### TranscriptionStreamEvents [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents] - - - - - -TranscriptionStreamTextDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamLanguage","linkedLabel":"TranscriptionStreamLanguage","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamSegmentDelta","linkedLabel":"TranscriptionStreamSegmentDelta","children":[],"breakoutSubTypes":{}},{"label":"TranscriptionStreamDone","linkedLabel":"TranscriptionStreamDone","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data] - - - - - - - - - -#### TranscriptionStreamTextDelta [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta] - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta_text] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamtextdelta_type] - - - - - -_Default Value:_ `"transcription.text.delta"` - - - - - - - - - - - - - -#### TranscriptionStreamLanguage [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage] - - - - - - - - - -##### audio_language [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage_audio_language] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamlanguage_type] - - - - - -_Default Value:_ `"transcription.language"` - - - - - - - - - - - - - -#### TranscriptionStreamSegmentDelta [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta] - - - - - - - - - -##### end [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_end] - - - - - - - - - -##### start [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_start] - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_text] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamsegmentdelta_type] - - - - - -_Default Value:_ `"transcription.segment"` - - - - - - - - - - - - - -#### TranscriptionStreamDone [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone] - - - - - - - - - -##### language [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_language] - - - - - - - - - -##### model [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_model] - - - - - -TranscriptionSegmentChunk","children":[{"label":"TranscriptionSegmentChunk","linkedLabel":"TranscriptionSegmentChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### segments [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments] - - - - - - - - - -#### TranscriptionSegmentChunk [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk] - - - - - - - - - -##### end [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_end] - - - - - - - - - -##### start [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_start] - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_text] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_segments_transcriptionsegmentchunk_type] - - - - - -_Default Value:_ `"transcription_segment"` - - - - - - - - - - - - - - - - - -##### text [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_text] - - - - - - - - - -##### type [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_type] - - - - - -_Default Value:_ `"transcription.done"` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage] - - - - - - - - - -#### UsageInfo [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_data_transcriptionstreamdone_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - -##### event [#operation-audio_api_v1_transcriptions_post_stream_responses_200_text-event-stream_transcriptionstreamevents_event] - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/batch/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/batch/page.mdx deleted file mode 100644 index 9f5c8fedf..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/batch/page.mdx +++ /dev/null @@ -1,2815 +0,0 @@ ---- -sidebarTitle: Batch ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Batch Endpoints - - - - - -Batch API - - - - - - - - - -## GET /v1/batch/jobs [#operation-jobs_api_routes_batch_get_batch_jobs] - - - - - -_Get Batch Jobs_ - - - - - -Get a list of batch jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.list(page=0, page_size=100, created_by_me=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-jobs_api_routes_batch_get_batch_jobs_responses-examples] - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_batch_get_batch_jobs_responses] - - - - - -200 - - - - - - - -OK - - - - - -BatchJobOut","children":[{"label":"BatchJobOut","linkedLabel":"BatchJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data] - - - - - - - - - -#### BatchJobOut [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout] - - - - - - - - - -##### agent_id [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_agent_id] - - - - - - - - - -##### completed_at [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_completed_at] - - - - - - - - - -##### completed_requests [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_completed_requests] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_created_at] - - - - - - - - - -##### endpoint [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_endpoint] - - - - - - - - - -##### error_file [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_error_file] - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### errors [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors] - - - - - - - - - -#### BatchError [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror] - - - - - - - - - -##### count [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror_count] - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_errors_batcherror_message] - - - - - - - - - - - - - - - - - -##### failed_requests [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_failed_requests] - - - - - - - - - -##### id [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_id] - - - - - - - - - -##### input_files [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_input_files] - - - - - - - - - -##### metadata [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_metadata] - - - - - - - - - -##### model [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_model] - - - - - - - - - -##### object [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_object] - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_output_file] - - - - - - - - - -##### started_at [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_started_at] - - - - - - - - - -##### status [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_status] - - - - - - - - - -##### succeeded_requests [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_succeeded_requests] - - - - - - - - - -##### total_requests [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_data_batchjobout_total_requests] - - - - - - - - - - - - - - - - - -##### object [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_object] - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total [#operation-jobs_api_routes_batch_get_batch_jobs_responses_200_application-json_total] - - - - - - - - - - - - - - - - - - - -## POST /v1/batch/jobs [#operation-jobs_api_routes_batch_create_batch_job] - - - - - -_Create Batch Job_ - - - - - -Create a new batch job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.create(input_files=[ - "fe3343a2-3b8d-404b-ba32-a78dede2614a", - ], endpoint="/v1/moderations", timeout_hours=24) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-jobs_api_routes_batch_create_batch_job_request-examples] - - - - - -```json -{ - "endpoint": "/v1/chat/completions", - "input_files": [ - "ipsum eiusmod" - ] -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-jobs_api_routes_batch_create_batch_job_request] - - - - - - - - - - - -##### agent_id [#operation-jobs_api_routes_batch_create_batch_job_request_agent_id] - - - - - - - - - -##### endpoint [#operation-jobs_api_routes_batch_create_batch_job_request_endpoint] - - - - - - - - - -##### input_files [#operation-jobs_api_routes_batch_create_batch_job_request_input_files] - - - - - - - - - -##### metadata [#operation-jobs_api_routes_batch_create_batch_job_request_metadata] - - - - - - - - - -##### model [#operation-jobs_api_routes_batch_create_batch_job_request_model] - - - - - - - - - -##### timeout_hours [#operation-jobs_api_routes_batch_create_batch_job_request_timeout_hours] - - - - - -_Default Value:_ `24` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_batch_create_batch_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_batch_create_batch_job_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_agent_id] - - - - - - - - - -##### completed_at [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_at] - - - - - - - - - -##### completed_requests [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_completed_requests] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_created_at] - - - - - - - - - -##### endpoint [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_endpoint] - - - - - - - - - -##### error_file [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_error_file] - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors] - - - - - - - - - -#### BatchError [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror] - - - - - - - - - -##### count [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror_count] - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_errors_batcherror_message] - - - - - - - - - - - - - - - - - -##### failed_requests [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_failed_requests] - - - - - - - - - -##### id [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_id] - - - - - - - - - -##### input_files [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_input_files] - - - - - - - - - -##### metadata [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_metadata] - - - - - - - - - -##### model [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_model] - - - - - - - - - -##### object [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_object] - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_output_file] - - - - - - - - - -##### started_at [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_started_at] - - - - - - - - - -##### status [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_status] - - - - - - - - - -##### succeeded_requests [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_succeeded_requests] - - - - - - - - - -##### total_requests [#operation-jobs_api_routes_batch_create_batch_job_responses_200_application-json_total_requests] - - - - - - - - - - - - - -     - - - - - -## GET /v1/batch/jobs/\{job\_id\} [#operation-jobs_api_routes_batch_get_batch_job] - - - - - -_Get Batch Job_ - - - - - -Get a batch job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.get(job_id="4017dc9f-b629-42f4-9700-8c681b9e7f0f") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_batch_get_batch_job_parameters] - - - - - - - - - - - -##### job_id [#operation-jobs_api_routes_batch_get_batch_job_parameters_job_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_batch_get_batch_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_batch_get_batch_job_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_agent_id] - - - - - - - - - -##### completed_at [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_at] - - - - - - - - - -##### completed_requests [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_completed_requests] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_created_at] - - - - - - - - - -##### endpoint [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_endpoint] - - - - - - - - - -##### error_file [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_error_file] - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors] - - - - - - - - - -#### BatchError [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror] - - - - - - - - - -##### count [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror_count] - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_errors_batcherror_message] - - - - - - - - - - - - - - - - - -##### failed_requests [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_failed_requests] - - - - - - - - - -##### id [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_id] - - - - - - - - - -##### input_files [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_input_files] - - - - - - - - - -##### metadata [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_metadata] - - - - - - - - - -##### model [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_model] - - - - - - - - - -##### object [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_object] - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_output_file] - - - - - - - - - -##### started_at [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_started_at] - - - - - - - - - -##### status [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_status] - - - - - - - - - -##### succeeded_requests [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_succeeded_requests] - - - - - - - - - -##### total_requests [#operation-jobs_api_routes_batch_get_batch_job_responses_200_application-json_total_requests] - - - - - - - - - - - - - -     - - - - - -## POST /v1/batch/jobs/\{job\_id\}/cancel [#operation-jobs_api_routes_batch_cancel_batch_job] - - - - - -_Cancel Batch Job_ - - - - - -Request the cancellation of a batch job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.batch.jobs.cancel(job_id="4fb29d1c-535b-4f0a-a1cb-2167f86da569") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_batch_cancel_batch_job_parameters] - - - - - - - - - - - -##### job_id [#operation-jobs_api_routes_batch_cancel_batch_job_parameters_job_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_batch_cancel_batch_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "completed_requests": 87, - "created_at": 14, - "endpoint": "ipsum eiusmod", - "errors": [ - { - "message": "consequat do" - } - ], - "failed_requests": 56, - "id": "reprehenderit ut dolore", - "input_files": [ - "occaecat dolor sit" - ], - "status": "QUEUED", - "succeeded_requests": 91, - "total_requests": 32 -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_batch_cancel_batch_job_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### agent_id [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_agent_id] - - - - - - - - - -##### completed_at [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_at] - - - - - - - - - -##### completed_requests [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_completed_requests] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_created_at] - - - - - - - - - -##### endpoint [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_endpoint] - - - - - - - - - -##### error_file [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_error_file] - - - - - -BatchError","children":[{"label":"BatchError","linkedLabel":"BatchError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### errors [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors] - - - - - - - - - -#### BatchError [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror] - - - - - - - - - -##### count [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror_count] - - - - - -_Default Value:_ `1` - - - - - - - - - -##### message [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_errors_batcherror_message] - - - - - - - - - - - - - - - - - -##### failed_requests [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_failed_requests] - - - - - - - - - -##### id [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_id] - - - - - - - - - -##### input_files [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_input_files] - - - - - - - - - -##### metadata [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_metadata] - - - - - - - - - -##### model [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_model] - - - - - - - - - -##### object [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_object] - - - - - -_Default Value:_ `"batch"` - - - - - - - - - -##### output_file [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_output_file] - - - - - - - - - -##### started_at [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_started_at] - - - - - - - - - -##### status [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_status] - - - - - - - - - -##### succeeded_requests [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_succeeded_requests] - - - - - - - - - -##### total_requests [#operation-jobs_api_routes_batch_cancel_batch_job_responses_200_application-json_total_requests] - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/beta/agents/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/beta/agents/page.mdx deleted file mode 100644 index 7a9c21e1e..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/beta/agents/page.mdx +++ /dev/null @@ -1,10427 +0,0 @@ ---- -sidebarTitle: Beta Agents ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Agents Endpoints - - - - - -(beta) Agents API - - - - - - - - - -## GET /v1/agents [#operation-agents_api_v1_agents_list] - - - - - -_List agent entities._ - - - - - -Retrieve a list of agent entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.list(page=0, page_size=20) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_agents_list_parameters] - - - - - - - - - - - -##### page [#operation-agents_api_v1_agents_list_parameters_page] - - - - - - - - - -##### page_size [#operation-agents_api_v1_agents_list_parameters_page_size] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_agents_list_responses-examples] - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_agents_list_responses] - - - - - -200 - - - - - - - -Agent","children":[{"label":"Agent","linkedLabel":"Agent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### Agent [#operation-agents_api_v1_agents_list_responses_200_application-json_agent] - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_handoffs] - - - - - - - - - -##### id [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_object] - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_updated_at] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_list_responses_200_application-json_agent_version] - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_agents_list_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_agents_list_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_list_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/agents [#operation-agents_api_v1_agents_create] - - - - - -_Create a agent that can be used within a conversation._ - - - - - -Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.create(model="LeBaron", name="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-agents_api_v1_agents_create_request-examples] - - - - - -```json -{ - "model": "ipsum eiusmod", - "name": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_agents_create_request] - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_create_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_create_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_create_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_request_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_create_request_handoffs] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_create_request_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_create_request_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_request_name] - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_create_request_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_create_request_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_create_request_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_create_request_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_create_request_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_create_request_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_create_request_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_create_request_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_request_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_agents_create_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_agents_create_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_create_responses_200_application-json_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_agents_create_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_responses_200_application-json_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_create_responses_200_application-json_handoffs] - - - - - - - - - -##### id [#operation-agents_api_v1_agents_create_responses_200_application-json_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_create_responses_200_application-json_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_create_responses_200_application-json_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_responses_200_application-json_name] - - - - - - - - - -##### object [#operation-agents_api_v1_agents_create_responses_200_application-json_object] - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_create_responses_200_application-json_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_200_application-json_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_agents_create_responses_200_application-json_updated_at] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_create_responses_200_application-json_version] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_agents_create_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_agents_create_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_create_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/agents/\{agent\_id\} [#operation-agents_api_v1_agents_get] - - - - - -_Retrieve an agent entity._ - - - - - -Given an agent retrieve an agent entity with its attributes. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.get(agent_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_agents_get_parameters] - - - - - - - - - - - -##### agent_id [#operation-agents_api_v1_agents_get_parameters_agent_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_agents_get_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_agents_get_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_get_responses_200_application-json_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_agents_get_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_get_responses_200_application-json_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_get_responses_200_application-json_handoffs] - - - - - - - - - -##### id [#operation-agents_api_v1_agents_get_responses_200_application-json_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_get_responses_200_application-json_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_get_responses_200_application-json_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_get_responses_200_application-json_name] - - - - - - - - - -##### object [#operation-agents_api_v1_agents_get_responses_200_application-json_object] - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_get_responses_200_application-json_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_200_application-json_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_agents_get_responses_200_application-json_updated_at] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_get_responses_200_application-json_version] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_agents_get_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_agents_get_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_get_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/agents/\{agent\_id\} [#operation-agents_api_v1_agents_update] - - - - - -_Update an agent entity._ - - - - - -Update an agent attributes and create a new version. - - - - - - - - - -TypeScript - - - - - -\",\n agentUpdateRequest: {},\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.update(agent_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_agents_update_parameters] - - - - - - - - - - - -##### agent_id [#operation-agents_api_v1_agents_update_parameters_agent_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-agents_api_v1_agents_update_request-examples] - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_agents_update_request] - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_update_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_update_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_update_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_request_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_update_request_handoffs] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_update_request_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_update_request_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_request_name] - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_update_request_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_update_request_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_update_request_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_request_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_update_request_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_update_request_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_update_request_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_update_request_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_request_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_agents_update_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_agents_update_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_update_responses_200_application-json_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_agents_update_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_responses_200_application-json_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_update_responses_200_application-json_handoffs] - - - - - - - - - -##### id [#operation-agents_api_v1_agents_update_responses_200_application-json_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_update_responses_200_application-json_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_update_responses_200_application-json_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_responses_200_application-json_name] - - - - - - - - - -##### object [#operation-agents_api_v1_agents_update_responses_200_application-json_object] - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_update_responses_200_application-json_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_200_application-json_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_agents_update_responses_200_application-json_updated_at] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_update_responses_200_application-json_version] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_agents_update_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_agents_update_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/agents/\{agent\_id\}/version [#operation-agents_api_v1_agents_update_version] - - - - - -_Update an agent version._ - - - - - -Switch the version of an agent. - - - - - - - - - -TypeScript - - - - - -\",\n version: 157995,\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.agents.update_version(agent_id="", version=157995) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_agents_update_version_parameters] - - - - - - - - - - - -##### agent_id [#operation-agents_api_v1_agents_update_version_parameters_agent_id] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_update_version_parameters_version] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_agents_update_version_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "name": "reprehenderit ut dolore", - "updated_at": "2025-10-07T20:56:01.974Z", - "version": 87 -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_agents_update_version_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_agents_update_version_responses_200_application-json_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_agents_update_version_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_version_responses_200_application-json_description] - - - - - - - - - -##### handoffs [#operation-agents_api_v1_agents_update_version_responses_200_application-json_handoffs] - - - - - - - - - -##### id [#operation-agents_api_v1_agents_update_version_responses_200_application-json_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_agents_update_version_responses_200_application-json_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_agents_update_version_responses_200_application-json_model] - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_version_responses_200_application-json_name] - - - - - - - - - -##### object [#operation-agents_api_v1_agents_update_version_responses_200_application-json_object] - - - - - -_Default Value:_ `"agent"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_200_application-json_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_agents_update_version_responses_200_application-json_updated_at] - - - - - - - - - -##### version [#operation-agents_api_v1_agents_update_version_responses_200_application-json_version] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_agents_update_version_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_agents_update_version_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/beta/conversations/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/beta/conversations/page.mdx deleted file mode 100644 index c5b324743..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/beta/conversations/page.mdx +++ /dev/null @@ -1,39983 +0,0 @@ ---- -sidebarTitle: Beta Conversations ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Conversations Endpoints - - - - - -(beta) Conversations API - - - - - - - - - -## GET /v1/conversations [#operation-agents_api_v1_conversations_list] - - - - - -_List all created conversations._ - - - - - -Retrieve a list of conversation entities sorted by creation time. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.list(page=0, page_size=100) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_list_parameters] - - - - - - - - - - - -##### page [#operation-agents_api_v1_conversations_list_parameters_page] - - - - - - - - - -##### page_size [#operation-agents_api_v1_conversations_list_parameters_page_size] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_list_responses-examples] - - - - - -200 - - - - - -```json -[ - { - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" - } -] -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_list_responses] - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation] - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_description] - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_model] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_name] - - - - - -Name given to the conversation. - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_object] - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_conversations_list_responses_200_application-json_modelconversation_updated_at] - - - - - - - - - - - - - -#### AgentConversation [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_agent_id] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_description] - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_name] - - - - - -Name given to the conversation. - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_object] - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at [#operation-agents_api_v1_conversations_list_responses_200_application-json_agentconversation_updated_at] - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_list_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_list_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_list_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations [#operation-agents_api_v1_conversations_start] - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.start(inputs="", stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_start_request-examples] - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_start_request] - - - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_request_agent_id] - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_start_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_start_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_request_description] - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_start_request_handoff_execution] - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_start_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions [#operation-agents_api_v1_conversations_start_request_instructions] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_request_model] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_request_name] - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_start_request_store] - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_start_request_stream] - - - - - -_Default Value:_ `false` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_conversations_start_request_tools] - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_conversations_start_request_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_start_request_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_conversations_start_request_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_conversations_start_request_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_conversations_start_request_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_conversations_start_request_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_request_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_start_responses-examples] - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_start_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_conversation_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_responses_200_application-json_object] - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs] - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_200_application-json_outputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_start_responses_200_application-json_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_start_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_start_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\} [#operation-agents_api_v1_conversations_get] - - - - - -_Retrieve a conversation information._ - - - - - -Given a conversation_id retrieve a conversation entity with its attributes. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_get_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_get_parameters_conversation_id] - - - - - -ID of the conversation from which we are fetching metadata. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_get_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "model": "consequat do", - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_get_responses] - - - - - -200 - - - - - - - -ModelConversation","children":[],"breakoutSubTypes":{}},{"label":"AgentConversation","linkedLabel":"AgentConversation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ModelConversation [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation] - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_description] - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_id] - - - - - - - - - -##### instructions [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_instructions] - - - - - -Instruction prompt the model will follow during the conversation. - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_model] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_name] - - - - - -Name given to the conversation. - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_object] - - - - - -_Default Value:_ `"conversation"` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tools [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools] - - - - - -List of tools which are available to the model during the conversation. - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -##### updated_at [#operation-agents_api_v1_conversations_get_responses_200_application-json_modelconversation_updated_at] - - - - - - - - - - - - - -#### AgentConversation [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_agent_id] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_created_at] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_description] - - - - - -Description of the what the conversation is about. - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_name] - - - - - -Name given to the conversation. - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_object] - - - - - -_Default Value:_ `"conversation"` - - - - - - - - - -##### updated_at [#operation-agents_api_v1_conversations_get_responses_200_application-json_agentconversation_updated_at] - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_get_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_get_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_get_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\} [#operation-agents_api_v1_conversations_append] - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - -\",\n conversationAppendRequest: {\n inputs: [],\n },\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.append(conversation_id="", inputs=[], stream=False, store=True, handoff_execution="server") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_append_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_append_parameters_conversation_id] - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_append_request-examples] - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_append_request] - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_append_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_append_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_append_request_handoff_execution] - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_append_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_append_request_store] - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_append_request_stream] - - - - - -_Default Value:_ `false` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_append_responses-examples] - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_append_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_conversation_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_responses_200_application-json_object] - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs] - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_200_application-json_outputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_append_responses_200_application-json_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_append_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_append_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\}/history [#operation-agents_api_v1_conversations_history] - - - - - -_Retrieve all entries in a conversation._ - - - - - -Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get_history(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_history_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_history_parameters_conversation_id] - - - - - -ID of the conversation from which we are fetching entries. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_history_responses-examples] - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "entries": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_history_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_conversation_id] - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### entries [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_200_application-json_entries_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_history_responses_200_application-json_object] - - - - - -_Default Value:_ `"conversation.history"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_history_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_history_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_history_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/conversations/\{conversation\_id\}/messages [#operation-agents_api_v1_conversations_messages] - - - - - -_Retrieve all messages in a conversation._ - - - - - -Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.get_messages(conversation_id="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_messages_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_messages_parameters_conversation_id] - - - - - -ID of the conversation from which we are fetching messages. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_messages_responses-examples] - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "messages": [ - { - "content": "consequat do", - "role": "assistant" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_messages_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_conversation_id] - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_200_application-json_messages_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_messages_responses_200_application-json_object] - - - - - -_Default Value:_ `"conversation.messages"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_messages_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_messages_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart [#operation-agents_api_v1_conversations_restart] - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - -\",\n conversationRestartRequest: {\n inputs: \"\",\n fromEntryId: \"\",\n },\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.restart(conversation_id="", inputs="", from_entry_id="", stream=False, store=True, handoff_execution="server") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_restart_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_restart_parameters_conversation_id] - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_restart_request-examples] - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_restart_request] - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_restart_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_restart_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### from_entry_id [#operation-agents_api_v1_conversations_restart_request_from_entry_id] - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_restart_request_handoff_execution] - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_restart_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_restart_request_store] - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_restart_request_stream] - - - - - -_Default Value:_ `false` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_restart_responses-examples] - - - - - -200 - - - - - -```json -{ - "conversation_id": "ipsum eiusmod", - "outputs": [ - { - "content": "consequat do" - } - ], - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-agents_api_v1_conversations_restart_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_conversation_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_responses_200_application-json_object] - - - - - -_Default Value:_ `"conversation.response"` - - - - - -MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### outputs [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs] - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_200_application-json_outputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_restart_responses_200_application-json_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_restart_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations\#stream [#operation-agents_api_v1_conversations_start_stream] - - - - - -_Create a conversation and append entries to it._ - - - - - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - - - - - - - - - -TypeScript - - - - - -\",\n previousAgentName: \"\",\n nextAgentId: \"\",\n nextAgentName: \"\",\n },\n ],\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.start_stream(inputs=[ - { - "object": "entry", - "type": "function.result", - "tool_call_id": "", - "result": "", - }, - ], stream=True) - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_start_stream_request-examples] - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_start_stream_request] - - - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_stream_request_agent_id] - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_start_stream_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_start_stream_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_stream_request_description] - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_start_stream_request_handoff_execution] - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_start_stream_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### instructions [#operation-agents_api_v1_conversations_start_stream_request_instructions] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_stream_request_model] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_request_name] - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_start_stream_request_store] - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_start_stream_request_stream] - - - - - -_Default Value:_ `true` - - - - - -FunctionTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchTool","linkedLabel":"WebSearchTool","children":[],"breakoutSubTypes":{}},{"label":"WebSearchPremiumTool","linkedLabel":"WebSearchPremiumTool","children":[],"breakoutSubTypes":{}},{"label":"CodeInterpreterTool","linkedLabel":"CodeInterpreterTool","children":[],"breakoutSubTypes":{}},{"label":"ImageGenerationTool","linkedLabel":"ImageGenerationTool","children":[],"breakoutSubTypes":{}},{"label":"DocumentLibraryTool","linkedLabel":"DocumentLibraryTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-agents_api_v1_conversations_start_stream_request_tools] - - - - - - - - - -#### FunctionTool [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function] - - - - - - - - - -#### Function [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_name] - - - - - - - - - -##### parameters [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_parameters] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_functiontool_type] - - - - - -_Default Value:_ `"function"` - - - - - - - - - - - - - -#### WebSearchTool [#operation-agents_api_v1_conversations_start_stream_request_tools_websearchtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_websearchtool_type] - - - - - -_Default Value:_ `"web_search"` - - - - - - - - - - - - - -#### WebSearchPremiumTool [#operation-agents_api_v1_conversations_start_stream_request_tools_websearchpremiumtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_websearchpremiumtool_type] - - - - - -_Default Value:_ `"web_search_premium"` - - - - - - - - - - - - - -#### CodeInterpreterTool [#operation-agents_api_v1_conversations_start_stream_request_tools_codeinterpretertool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_codeinterpretertool_type] - - - - - -_Default Value:_ `"code_interpreter"` - - - - - - - - - - - - - -#### ImageGenerationTool [#operation-agents_api_v1_conversations_start_stream_request_tools_imagegenerationtool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_imagegenerationtool_type] - - - - - -_Default Value:_ `"image_generation"` - - - - - - - - - - - - - -#### DocumentLibraryTool [#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool] - - - - - - - - - -##### library_ids [#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool_library_ids] - - - - - -Ids of the library in which to search. - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_request_tools_documentlibrarytool_type] - - - - - -_Default Value:_ `"document_library"` - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_start_stream_responses-examples] - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-agents_api_v1_conversations_start_stream_responses] - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents] - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data] - - - - - - - - - -#### ResponseStartedEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent] - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type] - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type] - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent] - - - - - - - - - -##### code [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at] - - - - - - - - - -##### message [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type] - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type] - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type] - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type] - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### content_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type] - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type] - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type] - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type] - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event [#operation-agents_api_v1_conversations_start_stream_responses_200_text-event-stream_conversationevents_event] - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_start_stream_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}\#stream [#operation-agents_api_v1_conversations_append_stream] - - - - - -_Append new entries to an existing conversation._ - - - - - -Run completion on the history of the conversation and the user entries. Return the new created entries. - - - - - - - - - -TypeScript - - - - - -\",\n conversationAppendStreamRequest: {\n inputs: \"\",\n },\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.append_stream(conversation_id="", inputs="", stream=True, store=True, handoff_execution="server") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_append_stream_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_append_stream_parameters_conversation_id] - - - - - -ID of the conversation to which we append entries. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_append_stream_request-examples] - - - - - -```json -{ - "inputs": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_append_stream_request] - - - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_append_stream_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_append_stream_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_append_stream_request_handoff_execution] - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_append_stream_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_append_stream_request_store] - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_append_stream_request_stream] - - - - - -_Default Value:_ `true` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_append_stream_responses-examples] - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-agents_api_v1_conversations_append_stream_responses] - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents] - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data] - - - - - - - - - -#### ResponseStartedEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent] - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type] - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type] - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent] - - - - - - - - - -##### code [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at] - - - - - - - - - -##### message [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type] - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type] - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type] - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type] - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### content_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type] - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type] - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type] - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type] - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event [#operation-agents_api_v1_conversations_append_stream_responses_200_text-event-stream_conversationevents_event] - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_append_stream_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/conversations/\{conversation\_id\}/restart\#stream [#operation-agents_api_v1_conversations_restart_stream] - - - - - -_Restart a conversation starting from a given entry._ - - - - - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - - - - - - - - - -TypeScript - - - - - -\",\n conversationRestartStreamRequest: {\n inputs: [\n {\n object: \"entry\",\n type: \"message.input\",\n role: \"assistant\",\n content: \"\",\n prefix: false,\n },\n ],\n fromEntryId: \"\",\n },\n });\n\n for await (const event of result) {\n // Handle the event\n console.log(event);\n }\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.conversations.restart_stream(conversation_id="", inputs=[ - { - "object": "entry", - "type": "message.input", - "role": "assistant", - "content": "", - "prefix": False, - }, - ], from_entry_id="", stream=True, store=True, handoff_execution="server") - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-agents_api_v1_conversations_restart_stream_parameters] - - - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_restart_stream_parameters_conversation_id] - - - - - -ID of the original conversation which is being restarted. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-agents_api_v1_conversations_restart_stream_request-examples] - - - - - -```json -{ - "from_entry_id": "ipsum eiusmod", - "inputs": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-agents_api_v1_conversations_restart_stream_request] - - - - - - - -Request to restart a new conversation from a given entry in the conversation. - - - - - -CompletionArgs","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### completion_args [#operation-agents_api_v1_conversations_restart_stream_request_completion_args] - - - - - -White-listed arguments from the completion API - - - - - - - - - -#### CompletionArgs [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs] - - - - - -White-listed arguments from the completion API - - - - - - - - - -##### frequency_penalty [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_frequency_penalty] - - - - - - - - - -##### max_tokens [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_max_tokens] - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### prediction [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction] - - - - - - - - - -#### Prediction [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction] - - - - - - - - - -##### content [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_presence_penalty] - - - - - - - - - -##### random_seed [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_random_seed] - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### response_format [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format] - - - - - - - - - -#### ResponseFormat [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### stop [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_stop] - - - - - - - - - -##### temperature [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_temperature] - - - - - - - - - -##### tool_choice [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_tool_choice] - - - - - - - - - -##### top_p [#operation-agents_api_v1_conversations_restart_stream_request_completion_args_completionargs_top_p] - - - - - - - - - - - - - - - - - -##### from_entry_id [#operation-agents_api_v1_conversations_restart_stream_request_from_entry_id] - - - - - - - - - -##### handoff_execution [#operation-agents_api_v1_conversations_restart_stream_request_handoff_execution] - - - - - -_Default Value:_ `"server"` - - - - - -MessageInputEntry","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEntry","linkedLabel":"MessageOutputEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionResultEntry","linkedLabel":"FunctionResultEntry","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEntry","linkedLabel":"FunctionCallEntry","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionEntry","linkedLabel":"ToolExecutionEntry","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffEntry","linkedLabel":"AgentHandoffEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### inputs [#operation-agents_api_v1_conversations_restart_stream_request_inputs] - - - - - - - - - -#### MessageInputEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry] - - - - - -Representation of an input message inside the conversation. - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### prefix [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_prefix] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_role] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageinputentry_type] - - - - - -_Default Value:_ `"message.input"` - - - - - - - - - - - - - -#### MessageOutputEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_agent_id] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_completed_at] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_model] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_messageoutputentry_type] - - - - - -_Default Value:_ `"message.output"` - - - - - - - - - - - - - -#### FunctionResultEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_id] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### result [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_result] - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functionresultentry_type] - - - - - -_Default Value:_ `"function.result"` - - - - - - - - - - - - - -#### FunctionCallEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_functioncallentry_type] - - - - - -_Default Value:_ `"function.call"` - - - - - - - - - - - - - -#### ToolExecutionEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_arguments] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_toolexecutionentry_type] - - - - - -_Default Value:_ `"tool.execution"` - - - - - - - - - - - - - -#### AgentHandoffEntry [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry] - - - - - - - - - -##### completed_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_completed_at] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_next_agent_name] - - - - - - - - - -##### object [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_object] - - - - - -_Default Value:_ `"entry"` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_request_inputs_agenthandoffentry_type] - - - - - -_Default Value:_ `"agent.handoff"` - - - - - - - - - - - - - - - - - -##### store [#operation-agents_api_v1_conversations_restart_stream_request_store] - - - - - -Whether to store the results into our servers or not. - - - - - -_Default Value:_ `true` - - - - - - - - - -##### stream [#operation-agents_api_v1_conversations_restart_stream_request_stream] - - - - - -_Default Value:_ `true` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-agents_api_v1_conversations_restart_stream_responses-examples] - - - - - -200 - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-agents_api_v1_conversations_restart_stream_responses] - - - - - -200 - - - - - - - -ConversationEvents","children":[{"label":"ConversationEvents","linkedLabel":"ConversationEvents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### ConversationEvents [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents] - - - - - -ResponseStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseDoneEvent","linkedLabel":"ResponseDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"ResponseErrorEvent","linkedLabel":"ResponseErrorEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionStartedEvent","linkedLabel":"ToolExecutionStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDeltaEvent","linkedLabel":"ToolExecutionDeltaEvent","children":[],"breakoutSubTypes":{}},{"label":"ToolExecutionDoneEvent","linkedLabel":"ToolExecutionDoneEvent","children":[],"breakoutSubTypes":{}},{"label":"MessageOutputEvent","linkedLabel":"MessageOutputEvent","children":[],"breakoutSubTypes":{}},{"label":"FunctionCallEvent","linkedLabel":"FunctionCallEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffStartedEvent","linkedLabel":"AgentHandoffStartedEvent","children":[],"breakoutSubTypes":{}},{"label":"AgentHandoffDoneEvent","linkedLabel":"AgentHandoffDoneEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data] - - - - - - - - - -#### ResponseStartedEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent] - - - - - - - - - -##### conversation_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_conversation_id] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsestartedevent_type] - - - - - -_Default Value:_ `"conversation.response.started"` - - - - - - - - - - - - - -#### ResponseDoneEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_created_at] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_type] - - - - - -_Default Value:_ `"conversation.response.done"` - - - - - -ConversationUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage] - - - - - - - - - -#### ConversationUsageInfo [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo] - - - - - - - - - -##### completion_tokens [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### connector_tokens [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connector_tokens] - - - - - - - - - -##### connectors [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_connectors] - - - - - - - - - -##### prompt_tokens [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responsedoneevent_usage_conversationusageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - -#### ResponseErrorEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent] - - - - - - - - - -##### code [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_code] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_created_at] - - - - - - - - - -##### message [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_message] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_responseerrorevent_type] - - - - - -_Default Value:_ `"conversation.response.error"` - - - - - - - - - - - - - -#### ToolExecutionStartedEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutionstartedevent_type] - - - - - -_Default Value:_ `"tool.execution.started"` - - - - - - - - - - - - - -#### ToolExecutionDeltaEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondeltaevent_type] - - - - - -_Default Value:_ `"tool.execution.delta"` - - - - - - - - - - - - - -#### ToolExecutionDoneEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_id] - - - - - - - - - -##### info [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_info] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_toolexecutiondoneevent_type] - - - - - -_Default Value:_ `"tool.execution.done"` - - - - - - - - - - - - - -#### MessageOutputEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent] - - - - - - - - - -##### agent_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_agent_id] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolFileChunk","linkedLabel":"ToolFileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ToolReferenceChunk","linkedLabel":"ToolReferenceChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content] - - - - - - - - - -#### TextChunk [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk] - - - - - - - - - -##### text [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_text] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### ToolFileChunk [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk] - - - - - - - - - -##### file_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_id] - - - - - - - - - -##### file_name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_name] - - - - - - - - - -##### file_type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_file_type] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolfilechunk_type] - - - - - -_Default Value:_ `"tool_file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ToolReferenceChunk [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk] - - - - - - - - - -##### description [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_description] - - - - - - - - - -##### favicon [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_favicon] - - - - - - - - - -##### title [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_title] - - - - - - - - - -##### tool [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_tool] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_type] - - - - - -_Default Value:_ `"tool_reference"` - - - - - - - - - -##### url [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_toolreferencechunk_url] - - - - - - - - - - - - - - - - - -##### content_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_content_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_id] - - - - - - - - - -##### model [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_model] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### role [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_role] - - - - - -_Default Value:_ `"assistant"` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_messageoutputevent_type] - - - - - -_Default Value:_ `"message.output.delta"` - - - - - - - - - - - - - -#### FunctionCallEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent] - - - - - - - - - -##### arguments [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_arguments] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_id] - - - - - - - - - -##### name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### tool_call_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_tool_call_id] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_functioncallevent_type] - - - - - -_Default Value:_ `"function.call.delta"` - - - - - - - - - - - - - -#### AgentHandoffStartedEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_id] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### previous_agent_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_id] - - - - - - - - - -##### previous_agent_name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_previous_agent_name] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffstartedevent_type] - - - - - -_Default Value:_ `"agent.handoff.started"` - - - - - - - - - - - - - -#### AgentHandoffDoneEvent [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent] - - - - - - - - - -##### created_at [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_created_at] - - - - - - - - - -##### id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_id] - - - - - - - - - -##### next_agent_id [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_id] - - - - - - - - - -##### next_agent_name [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_next_agent_name] - - - - - - - - - -##### output_index [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_output_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_data_agenthandoffdoneevent_type] - - - - - -_Default Value:_ `"agent.handoff.done"` - - - - - - - - - - - - - - - - - -##### event [#operation-agents_api_v1_conversations_restart_stream_responses_200_text-event-stream_conversationevents_event] - - - - - -Server side events sent when streaming a conversation response. - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-agents_api_v1_conversations_restart_stream_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx deleted file mode 100644 index dd654bb33..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/accesses/page.mdx +++ /dev/null @@ -1,2101 +0,0 @@ ---- -sidebarTitle: Beta Libraries Accesses ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Accesses Endpoints - - - - - -(beta) Libraries API - manage access to a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/share [#operation-libraries_share_list_v1] - - - - - -_List all of the access to this library._ - - - - - -Given a library, list all of the Entity that have access and to what level. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.list(library_id="d2169833-d8e2-416e-a372-76518d3d99c2") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_share_list_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_share_list_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_share_list_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "data": [ - { - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" - } - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_share_list_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -SharingOut","children":[{"label":"SharingOut","linkedLabel":"SharingOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-libraries_share_list_v1_responses_200_application-json_data] - - - - - - - - - -#### SharingOut [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout] - - - - - - - - - -##### library_id [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_library_id] - - - - - - - - - -##### org_id [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_org_id] - - - - - - - - - -##### role [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_role] - - - - - - - - - -##### share_with_type [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_share_with_type] - - - - - - - - - -##### share_with_uuid [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_share_with_uuid] - - - - - - - - - -##### user_id [#operation-libraries_share_list_v1_responses_200_application-json_data_sharingout_user_id] - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_share_list_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_share_list_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_share_list_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_share_list_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\}/share [#operation-libraries_share_create_v1] - - - - - -_Create or update an access level._ - - - - - -Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.update_or_create(library_id="36de3a24-5b1c-4c8f-9d84-d5642205a976", org_id="aadd9ae1-f285-4437-884a-091c77efa6fd", level="Viewer", share_with_uuid="0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20", share_with_type="User") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_share_create_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_share_create_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-libraries_share_create_v1_request-examples] - - - - - -```json -{ - "level": "Viewer", - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_share_create_v1_request] - - - - - - - - - - - -##### level [#operation-libraries_share_create_v1_request_level] - - - - - - - - - -##### org_id [#operation-libraries_share_create_v1_request_org_id] - - - - - - - - - -##### share_with_type [#operation-libraries_share_create_v1_request_share_with_type] - - - - - -The type of entity, used to share a library. - - - - - - - - - -##### share_with_uuid [#operation-libraries_share_create_v1_request_share_with_uuid] - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_share_create_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_share_create_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id [#operation-libraries_share_create_v1_responses_200_application-json_library_id] - - - - - - - - - -##### org_id [#operation-libraries_share_create_v1_responses_200_application-json_org_id] - - - - - - - - - -##### role [#operation-libraries_share_create_v1_responses_200_application-json_role] - - - - - - - - - -##### share_with_type [#operation-libraries_share_create_v1_responses_200_application-json_share_with_type] - - - - - - - - - -##### share_with_uuid [#operation-libraries_share_create_v1_responses_200_application-json_share_with_uuid] - - - - - - - - - -##### user_id [#operation-libraries_share_create_v1_responses_200_application-json_user_id] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_share_create_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_share_create_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_share_create_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_share_create_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\}/share [#operation-libraries_share_delete_v1] - - - - - -_Delete an access level._ - - - - - -Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.accesses.delete(library_id="709e3cad-9fb2-4f4e-bf88-143cf1808107", org_id="0814a235-c2d0-4814-875a-4b85f93d3dc7", share_with_uuid="b843cc47-ce8f-4354-8cfc-5fcd7fb2865b", share_with_type="User") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_share_delete_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_share_delete_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-libraries_share_delete_v1_request-examples] - - - - - -```json -{ - "org_id": "ipsum eiusmod", - "share_with_type": "User", - "share_with_uuid": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_share_delete_v1_request] - - - - - - - - - - - -##### org_id [#operation-libraries_share_delete_v1_request_org_id] - - - - - - - - - -##### share_with_type [#operation-libraries_share_delete_v1_request_share_with_type] - - - - - -The type of entity, used to share a library. - - - - - - - - - -##### share_with_uuid [#operation-libraries_share_delete_v1_request_share_with_uuid] - - - - - -The id of the entity (user, workspace or organization) to share with - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_share_delete_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "library_id": "ipsum eiusmod", - "org_id": "consequat do", - "role": "reprehenderit ut dolore", - "share_with_type": "occaecat dolor sit", - "share_with_uuid": "nostrud" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_share_delete_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### library_id [#operation-libraries_share_delete_v1_responses_200_application-json_library_id] - - - - - - - - - -##### org_id [#operation-libraries_share_delete_v1_responses_200_application-json_org_id] - - - - - - - - - -##### role [#operation-libraries_share_delete_v1_responses_200_application-json_role] - - - - - - - - - -##### share_with_type [#operation-libraries_share_delete_v1_responses_200_application-json_share_with_type] - - - - - - - - - -##### share_with_uuid [#operation-libraries_share_delete_v1_responses_200_application-json_share_with_uuid] - - - - - - - - - -##### user_id [#operation-libraries_share_delete_v1_responses_200_application-json_user_id] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_share_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_share_delete_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_share_delete_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx deleted file mode 100644 index 5946e2764..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/documents/page.mdx +++ /dev/null @@ -1,6572 +0,0 @@ ---- -sidebarTitle: Beta Libraries Documents ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Documents Endpoints - - - - - -(beta) Libraries API - manage documents in a library. - - - - - - - - - -## GET /v1/libraries/\{library\_id\}/documents [#operation-libraries_documents_list_v1] - - - - - -_List document in a given library._ - - - - - -Given a library, lists the document that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.list(library_id="5c3ca4cd-62bc-4c71-ad8a-1531ae80d078", page_size=100, page=0, sort_by="created_at", sort_order="desc") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-libraries_documents_list_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "data": [ - { - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" - } - ], - "pagination": { - "current_page": 56, - "has_more": false, - "page_size": 91, - "total_items": 32, - "total_pages": 78 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_list_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -DocumentOut","children":[{"label":"DocumentOut","linkedLabel":"DocumentOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-libraries_documents_list_v1_responses_200_application-json_data] - - - - - - - - - -#### DocumentOut [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout] - - - - - - - - - -##### created_at [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_created_at] - - - - - - - - - -##### extension [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_extension] - - - - - - - - - -##### hash [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_hash] - - - - - - - - - -##### id [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_id] - - - - - - - - - -##### last_processed_at [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_last_processed_at] - - - - - - - - - -##### library_id [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_library_id] - - - - - - - - - -##### mime_type [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_mime_type] - - - - - - - - - -##### name [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_name] - - - - - - - - - -##### number_of_pages [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_number_of_pages] - - - - - - - - - -##### processing_status [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_processing_status] - - - - - - - - - -##### size [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_size] - - - - - - - - - -##### summary [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_summary] - - - - - - - - - -##### tokens_processing_main_content [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_main_content] - - - - - - - - - -##### tokens_processing_summary [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_summary] - - - - - - - - - -##### tokens_processing_total [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_tokens_processing_total] - - - - - - - - - -##### uploaded_by_id [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_uploaded_by_id] - - - - - - - - - -##### uploaded_by_type [#operation-libraries_documents_list_v1_responses_200_application-json_data_documentout_uploaded_by_type] - - - - - - - - - - - - - -PaginationInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pagination [#operation-libraries_documents_list_v1_responses_200_application-json_pagination] - - - - - - - - - -#### PaginationInfo [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo] - - - - - - - - - -##### current_page [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_current_page] - - - - - - - - - -##### has_more [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_has_more] - - - - - - - - - -##### page_size [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_page_size] - - - - - - - - - -##### total_items [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_total_items] - - - - - - - - - -##### total_pages [#operation-libraries_documents_list_v1_responses_200_application-json_pagination_paginationinfo_total_pages] - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_list_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_list_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_list_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries/\{library\_id\}/documents [#operation-libraries_documents_upload_v1] - - - - - -_Upload a new document._ - - - - - -Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.upload(library_id="a02150d9-5ee0-4877-b62c-28b1fcdf3b76", file={ - "file_name": "example.file", - "content": open("example.file", "rb"), - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_upload_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_upload_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-libraries_documents_upload_v1_request-examples] - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_documents_upload_v1_request] - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file [#operation-libraries_documents_upload_v1_request_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File [#operation-libraries_documents_upload_v1_request_file_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content [#operation-libraries_documents_upload_v1_request_file_file_content] - - - - - - - - - -##### fileName [#operation-libraries_documents_upload_v1_request_file_file_filename] - - - - - - - - - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_upload_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_upload_v1_responses] - - - - - -200 - - - - - - - -A document with the same hash was found in this library. Returns the existing document. - - - - - - - - - -##### created_at [#operation-libraries_documents_upload_v1_responses_200_application-json_created_at] - - - - - - - - - -##### extension [#operation-libraries_documents_upload_v1_responses_200_application-json_extension] - - - - - - - - - -##### hash [#operation-libraries_documents_upload_v1_responses_200_application-json_hash] - - - - - - - - - -##### id [#operation-libraries_documents_upload_v1_responses_200_application-json_id] - - - - - - - - - -##### last_processed_at [#operation-libraries_documents_upload_v1_responses_200_application-json_last_processed_at] - - - - - - - - - -##### library_id [#operation-libraries_documents_upload_v1_responses_200_application-json_library_id] - - - - - - - - - -##### mime_type [#operation-libraries_documents_upload_v1_responses_200_application-json_mime_type] - - - - - - - - - -##### name [#operation-libraries_documents_upload_v1_responses_200_application-json_name] - - - - - - - - - -##### number_of_pages [#operation-libraries_documents_upload_v1_responses_200_application-json_number_of_pages] - - - - - - - - - -##### processing_status [#operation-libraries_documents_upload_v1_responses_200_application-json_processing_status] - - - - - - - - - -##### size [#operation-libraries_documents_upload_v1_responses_200_application-json_size] - - - - - - - - - -##### summary [#operation-libraries_documents_upload_v1_responses_200_application-json_summary] - - - - - - - - - -##### tokens_processing_main_content [#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_main_content] - - - - - - - - - -##### tokens_processing_summary [#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_summary] - - - - - - - - - -##### tokens_processing_total [#operation-libraries_documents_upload_v1_responses_200_application-json_tokens_processing_total] - - - - - - - - - -##### uploaded_by_id [#operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_id] - - - - - - - - - -##### uploaded_by_type [#operation-libraries_documents_upload_v1_responses_200_application-json_uploaded_by_type] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_upload_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_upload_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_upload_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\} [#operation-libraries_documents_get_v1] - - - - - -_Retrieve the metadata of a specific document._ - - - - - -Given a library and a document in this library, you can retrieve the metadata of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.get(library_id="03d908c8-90a1-44fd-bf3a-8490fb7c9a03", document_id="90973aec-0508-4375-8b00-91d732414745") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_get_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_get_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_get_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_get_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_get_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at [#operation-libraries_documents_get_v1_responses_200_application-json_created_at] - - - - - - - - - -##### extension [#operation-libraries_documents_get_v1_responses_200_application-json_extension] - - - - - - - - - -##### hash [#operation-libraries_documents_get_v1_responses_200_application-json_hash] - - - - - - - - - -##### id [#operation-libraries_documents_get_v1_responses_200_application-json_id] - - - - - - - - - -##### last_processed_at [#operation-libraries_documents_get_v1_responses_200_application-json_last_processed_at] - - - - - - - - - -##### library_id [#operation-libraries_documents_get_v1_responses_200_application-json_library_id] - - - - - - - - - -##### mime_type [#operation-libraries_documents_get_v1_responses_200_application-json_mime_type] - - - - - - - - - -##### name [#operation-libraries_documents_get_v1_responses_200_application-json_name] - - - - - - - - - -##### number_of_pages [#operation-libraries_documents_get_v1_responses_200_application-json_number_of_pages] - - - - - - - - - -##### processing_status [#operation-libraries_documents_get_v1_responses_200_application-json_processing_status] - - - - - - - - - -##### size [#operation-libraries_documents_get_v1_responses_200_application-json_size] - - - - - - - - - -##### summary [#operation-libraries_documents_get_v1_responses_200_application-json_summary] - - - - - - - - - -##### tokens_processing_main_content [#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_main_content] - - - - - - - - - -##### tokens_processing_summary [#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_summary] - - - - - - - - - -##### tokens_processing_total [#operation-libraries_documents_get_v1_responses_200_application-json_tokens_processing_total] - - - - - - - - - -##### uploaded_by_id [#operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_id] - - - - - - - - - -##### uploaded_by_type [#operation-libraries_documents_get_v1_responses_200_application-json_uploaded_by_type] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_get_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_get_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_get_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\}/documents/\{document\_id\} [#operation-libraries_documents_update_v1] - - - - - -_Update the metadata of a specific document._ - - - - - -Given a library and a document in that library, update the name of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.update(library_id="3ddd8d93-dca5-4a6d-980d-173226c35742", document_id="2a25e44c-b160-40ca-b5c2-b65fb2fcae34") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_update_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_update_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_update_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-libraries_documents_update_v1_request-examples] - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_documents_update_v1_request] - - - - - - - - - - - -##### name [#operation-libraries_documents_update_v1_request_name] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_update_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "created_at": "2025-10-07T20:56:01.974Z", - "extension": "ipsum eiusmod", - "hash": "consequat do", - "id": "reprehenderit ut dolore", - "library_id": "occaecat dolor sit", - "mime_type": "nostrud", - "name": "aute aliqua aute commodo", - "processing_status": "irure", - "size": 87, - "tokens_processing_total": 14, - "uploaded_by_id": "dolor", - "uploaded_by_type": "sunt" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_update_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### created_at [#operation-libraries_documents_update_v1_responses_200_application-json_created_at] - - - - - - - - - -##### extension [#operation-libraries_documents_update_v1_responses_200_application-json_extension] - - - - - - - - - -##### hash [#operation-libraries_documents_update_v1_responses_200_application-json_hash] - - - - - - - - - -##### id [#operation-libraries_documents_update_v1_responses_200_application-json_id] - - - - - - - - - -##### last_processed_at [#operation-libraries_documents_update_v1_responses_200_application-json_last_processed_at] - - - - - - - - - -##### library_id [#operation-libraries_documents_update_v1_responses_200_application-json_library_id] - - - - - - - - - -##### mime_type [#operation-libraries_documents_update_v1_responses_200_application-json_mime_type] - - - - - - - - - -##### name [#operation-libraries_documents_update_v1_responses_200_application-json_name] - - - - - - - - - -##### number_of_pages [#operation-libraries_documents_update_v1_responses_200_application-json_number_of_pages] - - - - - - - - - -##### processing_status [#operation-libraries_documents_update_v1_responses_200_application-json_processing_status] - - - - - - - - - -##### size [#operation-libraries_documents_update_v1_responses_200_application-json_size] - - - - - - - - - -##### summary [#operation-libraries_documents_update_v1_responses_200_application-json_summary] - - - - - - - - - -##### tokens_processing_main_content [#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_main_content] - - - - - - - - - -##### tokens_processing_summary [#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_summary] - - - - - - - - - -##### tokens_processing_total [#operation-libraries_documents_update_v1_responses_200_application-json_tokens_processing_total] - - - - - - - - - -##### uploaded_by_id [#operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_id] - - - - - - - - - -##### uploaded_by_type [#operation-libraries_documents_update_v1_responses_200_application-json_uploaded_by_type] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_update_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_update_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_update_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\}/documents/\{document\_id\} [#operation-libraries_documents_delete_v1] - - - - - -_Delete a document._ - - - - - -Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - mistral.beta.libraries.documents.delete(library_id="005daae9-d42e-407d-82d7-2261c6a1496c", document_id="edc236b0-baff-49a9-884b-4ca36a258da4") - - # Use the SDK ... - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_delete_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_delete_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_delete_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_delete_v1_responses-examples] - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-libraries_documents_delete_v1_responses] - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_delete_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_delete_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/text\_content [#operation-libraries_documents_get_text_content_v1] - - - - - -_Retrieve the text content of a specific document._ - - - - - -Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.text_content(library_id="1d177215-3b6b-45ba-9fa9-baf773223bec", document_id="60214c91-2aba-4692-a4e6-a53365de8caf") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_get_text_content_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_get_text_content_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_get_text_content_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_get_text_content_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "text": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_get_text_content_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### text [#operation-libraries_documents_get_text_content_v1_responses_200_application-json_text] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_get_text_content_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/status [#operation-libraries_documents_get_status_v1] - - - - - -_Retrieve the processing status of a specific document._ - - - - - -Given a library and a document in that library, retrieve the processing status of that document. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.status(library_id="e6906f70-368f-4155-80da-c1718f01bc43", document_id="2c904915-d831-4e9d-a345-8ce405bcef66") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_get_status_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_get_status_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_get_status_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_get_status_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "document_id": "ipsum eiusmod", - "processing_status": "consequat do" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_get_status_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_id [#operation-libraries_documents_get_status_v1_responses_200_application-json_document_id] - - - - - - - - - -##### processing_status [#operation-libraries_documents_get_status_v1_responses_200_application-json_processing_status] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_get_status_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_get_status_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_get_status_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/signed-url [#operation-libraries_documents_get_signed_url_v1] - - - - - -_Retrieve the signed URL of a specific document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.get_signed_url(library_id="23cf6904-a602-4ee8-9f5b-8efc557c336d", document_id="48598486-df71-4994-acbb-1133c72efa8c") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_get_signed_url_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_get_signed_url_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_get_signed_url_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_get_signed_url_v1_responses-examples] - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_get_signed_url_v1_responses] - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_get_signed_url_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\}/documents/\{document\_id\}/extracted-text-signed-url [#operation-libraries_documents_get_extracted_text_signed_url_v1] - - - - - -_Retrieve the signed URL of text extracted from a given document._ - - - - - -Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.documents.extracted_text_signed_url(library_id="a6f15de3-1e82-4f95-af82-851499042ef8", document_id="9749d4f9-24e5-4ca2-99a3-a406863f805d") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_get_extracted_text_signed_url_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses-examples] - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses] - - - - - -200 - - - - - - - - - - - - - -Successful Response - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_get_extracted_text_signed_url_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/libraries/\{library\_id\}/documents/\{document\_id\}/reprocess [#operation-libraries_documents_reprocess_v1] - - - - - -_Reprocess a document._ - - - - - -Given a library and a document in that library, reprocess that document, it will be billed again. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - mistral.beta.libraries.documents.reprocess(library_id="51b29371-de8f-4ba4-932b-a0bafb3a7f64", document_id="3052422c-49ca-45ac-a918-cadb35d61fd8") - - # Use the SDK ... - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_documents_reprocess_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_documents_reprocess_v1_parameters_library_id] - - - - - - - - - -##### document_id [#operation-libraries_documents_reprocess_v1_parameters_document_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_documents_reprocess_v1_responses-examples] - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-libraries_documents_reprocess_v1_responses] - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_documents_reprocess_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_documents_reprocess_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/page.mdx deleted file mode 100644 index e26de7421..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/beta/libraries/page.mdx +++ /dev/null @@ -1,3791 +0,0 @@ ---- -sidebarTitle: Beta Libraries ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Beta Libraries Endpoints - - - - - -(beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - - - - - - - - - -## GET /v1/libraries [#operation-libraries_list_v1] - - - - - -_List all libraries you have access to._ - - - - - -List all libraries that you have created or have been shared with you. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.list() - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-libraries_list_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "data": [ - { - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_list_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -LibraryOut","children":[{"label":"LibraryOut","linkedLabel":"LibraryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-libraries_list_v1_responses_200_application-json_data] - - - - - - - - - -#### LibraryOut [#operation-libraries_list_v1_responses_200_application-json_data_libraryout] - - - - - - - - - -##### chunk_size [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_chunk_size] - - - - - - - - - -##### created_at [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_created_at] - - - - - - - - - -##### description [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_description] - - - - - - - - - -##### emoji [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_emoji] - - - - - - - - - -##### explicit_user_members_count [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_explicit_user_members_count] - - - - - - - - - -##### explicit_workspace_members_count [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_explicit_workspace_members_count] - - - - - - - - - -##### generated_description [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_generated_description] - - - - - - - - - -##### generated_name [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_generated_name] - - - - - - - - - -##### id [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_id] - - - - - - - - - -##### name [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_name] - - - - - - - - - -##### nb_documents [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_nb_documents] - - - - - - - - - -##### org_sharing_role [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_org_sharing_role] - - - - - - - - - -##### owner_id [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_owner_id] - - - - - - - - - -##### owner_type [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_owner_type] - - - - - - - - - -##### total_size [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_total_size] - - - - - - - - - -##### updated_at [#operation-libraries_list_v1_responses_200_application-json_data_libraryout_updated_at] - - - - - - - - - - - - - - - - - - - - - - - - - - - -## POST /v1/libraries [#operation-libraries_create_v1] - - - - - -_Create a new Library._ - - - - - -Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - - - - - - - - - -TypeScript - - - - - -\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.create(name="") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-libraries_create_v1_request-examples] - - - - - -```json -{ - "name": "ipsum eiusmod" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_create_v1_request] - - - - - - - - - - - -##### chunk_size [#operation-libraries_create_v1_request_chunk_size] - - - - - - - - - -##### description [#operation-libraries_create_v1_request_description] - - - - - - - - - -##### name [#operation-libraries_create_v1_request_name] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_create_v1_responses-examples] - - - - - -201 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Server-Side Events [#operation-libraries_create_v1_responses] - - - - - -201 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size [#operation-libraries_create_v1_responses_201_application-json_chunk_size] - - - - - - - - - -##### created_at [#operation-libraries_create_v1_responses_201_application-json_created_at] - - - - - - - - - -##### description [#operation-libraries_create_v1_responses_201_application-json_description] - - - - - - - - - -##### emoji [#operation-libraries_create_v1_responses_201_application-json_emoji] - - - - - - - - - -##### explicit_user_members_count [#operation-libraries_create_v1_responses_201_application-json_explicit_user_members_count] - - - - - - - - - -##### explicit_workspace_members_count [#operation-libraries_create_v1_responses_201_application-json_explicit_workspace_members_count] - - - - - - - - - -##### generated_description [#operation-libraries_create_v1_responses_201_application-json_generated_description] - - - - - - - - - -##### generated_name [#operation-libraries_create_v1_responses_201_application-json_generated_name] - - - - - - - - - -##### id [#operation-libraries_create_v1_responses_201_application-json_id] - - - - - - - - - -##### name [#operation-libraries_create_v1_responses_201_application-json_name] - - - - - - - - - -##### nb_documents [#operation-libraries_create_v1_responses_201_application-json_nb_documents] - - - - - - - - - -##### org_sharing_role [#operation-libraries_create_v1_responses_201_application-json_org_sharing_role] - - - - - - - - - -##### owner_id [#operation-libraries_create_v1_responses_201_application-json_owner_id] - - - - - - - - - -##### owner_type [#operation-libraries_create_v1_responses_201_application-json_owner_type] - - - - - - - - - -##### total_size [#operation-libraries_create_v1_responses_201_application-json_total_size] - - - - - - - - - -##### updated_at [#operation-libraries_create_v1_responses_201_application-json_updated_at] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_create_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_create_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_create_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_create_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_create_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/libraries/\{library\_id\} [#operation-libraries_get_v1] - - - - - -_Detailed information about a specific Library._ - - - - - -Given a library id, details information about that Library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.get(library_id="d0d23a1e-bfe5-45e7-b7bb-22a4ea78d47f") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_get_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_get_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_get_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_get_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size [#operation-libraries_get_v1_responses_200_application-json_chunk_size] - - - - - - - - - -##### created_at [#operation-libraries_get_v1_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-libraries_get_v1_responses_200_application-json_description] - - - - - - - - - -##### emoji [#operation-libraries_get_v1_responses_200_application-json_emoji] - - - - - - - - - -##### explicit_user_members_count [#operation-libraries_get_v1_responses_200_application-json_explicit_user_members_count] - - - - - - - - - -##### explicit_workspace_members_count [#operation-libraries_get_v1_responses_200_application-json_explicit_workspace_members_count] - - - - - - - - - -##### generated_description [#operation-libraries_get_v1_responses_200_application-json_generated_description] - - - - - - - - - -##### generated_name [#operation-libraries_get_v1_responses_200_application-json_generated_name] - - - - - - - - - -##### id [#operation-libraries_get_v1_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-libraries_get_v1_responses_200_application-json_name] - - - - - - - - - -##### nb_documents [#operation-libraries_get_v1_responses_200_application-json_nb_documents] - - - - - - - - - -##### org_sharing_role [#operation-libraries_get_v1_responses_200_application-json_org_sharing_role] - - - - - - - - - -##### owner_id [#operation-libraries_get_v1_responses_200_application-json_owner_id] - - - - - - - - - -##### owner_type [#operation-libraries_get_v1_responses_200_application-json_owner_type] - - - - - - - - - -##### total_size [#operation-libraries_get_v1_responses_200_application-json_total_size] - - - - - - - - - -##### updated_at [#operation-libraries_get_v1_responses_200_application-json_updated_at] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_get_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_get_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_get_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_get_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_get_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PUT /v1/libraries/\{library\_id\} [#operation-libraries_update_v1] - - - - - -_Update a library._ - - - - - -Given a library id, you can update the name and description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.update(library_id="e01880c3-d0b5-4a29-8b1b-abdb8ce917e4") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_update_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_update_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-libraries_update_v1_request-examples] - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-libraries_update_v1_request] - - - - - - - - - - - -##### description [#operation-libraries_update_v1_request_description] - - - - - - - - - -##### name [#operation-libraries_update_v1_request_name] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_update_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_update_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size [#operation-libraries_update_v1_responses_200_application-json_chunk_size] - - - - - - - - - -##### created_at [#operation-libraries_update_v1_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-libraries_update_v1_responses_200_application-json_description] - - - - - - - - - -##### emoji [#operation-libraries_update_v1_responses_200_application-json_emoji] - - - - - - - - - -##### explicit_user_members_count [#operation-libraries_update_v1_responses_200_application-json_explicit_user_members_count] - - - - - - - - - -##### explicit_workspace_members_count [#operation-libraries_update_v1_responses_200_application-json_explicit_workspace_members_count] - - - - - - - - - -##### generated_description [#operation-libraries_update_v1_responses_200_application-json_generated_description] - - - - - - - - - -##### generated_name [#operation-libraries_update_v1_responses_200_application-json_generated_name] - - - - - - - - - -##### id [#operation-libraries_update_v1_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-libraries_update_v1_responses_200_application-json_name] - - - - - - - - - -##### nb_documents [#operation-libraries_update_v1_responses_200_application-json_nb_documents] - - - - - - - - - -##### org_sharing_role [#operation-libraries_update_v1_responses_200_application-json_org_sharing_role] - - - - - - - - - -##### owner_id [#operation-libraries_update_v1_responses_200_application-json_owner_id] - - - - - - - - - -##### owner_type [#operation-libraries_update_v1_responses_200_application-json_owner_type] - - - - - - - - - -##### total_size [#operation-libraries_update_v1_responses_200_application-json_total_size] - - - - - - - - - -##### updated_at [#operation-libraries_update_v1_responses_200_application-json_updated_at] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_update_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_update_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_update_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_update_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_update_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/libraries/\{library\_id\} [#operation-libraries_delete_v1] - - - - - -_Delete a library and all of it's document._ - - - - - -Given a library id, deletes it together with all documents that have been uploaded to that library. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.beta.libraries.delete(library_id="6cad0b6e-fd2e-4d11-a48b-21d30fb7c17a") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-libraries_delete_v1_parameters] - - - - - - - - - - - -##### library_id [#operation-libraries_delete_v1_parameters_library_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-libraries_delete_v1_responses-examples] - - - - - -200 - - - - - -```json -{ - "chunk_size": null, - "created_at": "2025-10-07T20:56:01.974Z", - "id": "ipsum eiusmod", - "name": "consequat do", - "nb_documents": 87, - "owner_id": "reprehenderit ut dolore", - "owner_type": "occaecat dolor sit", - "total_size": 14, - "updated_at": "2025-10-07T20:56:01.974Z" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-libraries_delete_v1_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### chunk_size [#operation-libraries_delete_v1_responses_200_application-json_chunk_size] - - - - - - - - - -##### created_at [#operation-libraries_delete_v1_responses_200_application-json_created_at] - - - - - - - - - -##### description [#operation-libraries_delete_v1_responses_200_application-json_description] - - - - - - - - - -##### emoji [#operation-libraries_delete_v1_responses_200_application-json_emoji] - - - - - - - - - -##### explicit_user_members_count [#operation-libraries_delete_v1_responses_200_application-json_explicit_user_members_count] - - - - - - - - - -##### explicit_workspace_members_count [#operation-libraries_delete_v1_responses_200_application-json_explicit_workspace_members_count] - - - - - - - - - -##### generated_description [#operation-libraries_delete_v1_responses_200_application-json_generated_description] - - - - - - - - - -##### generated_name [#operation-libraries_delete_v1_responses_200_application-json_generated_name] - - - - - - - - - -##### id [#operation-libraries_delete_v1_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-libraries_delete_v1_responses_200_application-json_name] - - - - - - - - - -##### nb_documents [#operation-libraries_delete_v1_responses_200_application-json_nb_documents] - - - - - - - - - -##### org_sharing_role [#operation-libraries_delete_v1_responses_200_application-json_org_sharing_role] - - - - - - - - - -##### owner_id [#operation-libraries_delete_v1_responses_200_application-json_owner_id] - - - - - - - - - -##### owner_type [#operation-libraries_delete_v1_responses_200_application-json_owner_type] - - - - - - - - - -##### total_size [#operation-libraries_delete_v1_responses_200_application-json_total_size] - - - - - - - - - -##### updated_at [#operation-libraries_delete_v1_responses_200_application-json_updated_at] - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-libraries_delete_v1_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-libraries_delete_v1_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-libraries_delete_v1_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-libraries_delete_v1_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/chat/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/chat/page.mdx deleted file mode 100644 index 88db2a426..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/chat/page.mdx +++ /dev/null @@ -1,7104 +0,0 @@ ---- -sidebarTitle: Chat ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Chat Endpoints - - - - - -Chat Completion API. - - - - - - - - - -## POST /v1/chat/completions [#operation-chat_completion_v1_chat_completions_post] - - - - - -Chat Completion - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.chat.complete(model="mistral-small-latest", messages=[ - { - "content": "Who is the best French painter? Answer in one short sentence.", - "role": "user", - }, - ], stream=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-chat_completion_v1_chat_completions_post_request-examples] - - - - - -```json -{ - "messages": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "mistral-small-latest" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-chat_completion_v1_chat_completions_post_request] - - - - - - - - - - - -##### frequency_penalty [#operation-chat_completion_v1_chat_completions_post_request_frequency_penalty] - - - - - -frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### max_tokens [#operation-chat_completion_v1_chat_completions_post_request_max_tokens] - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### messages [#operation-chat_completion_v1_chat_completions_post_request_messages] - - - - - -The prompt(s) to generate completions for, encoded as a list of dict with role and content. - - - - - - - - - -#### SystemMessage [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage] - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_request_messages_systemmessage_role] - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_request_messages_usermessage_role] - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_name] - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_role] - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id [#operation-chat_completion_v1_chat_completions_post_request_messages_toolmessage_tool_call_id] - - - - - - - - - - - - - - - - - -##### model [#operation-chat_completion_v1_chat_completions_post_request_model] - - - - - -ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### n [#operation-chat_completion_v1_chat_completions_post_request_n] - - - - - -Number of completions to return for each request, input tokens are only billed once. - - - - - - - - - -##### parallel_tool_calls [#operation-chat_completion_v1_chat_completions_post_request_parallel_tool_calls] - - - - - -_Default Value:_ `true` - - - - - -Prediction","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### prediction [#operation-chat_completion_v1_chat_completions_post_request_prediction] - - - - - - - - - -#### Prediction [#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction] - - - - - - - - - -##### content [#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction_content] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_prediction_prediction_type] - - - - - -_Default Value:_ `"content"` - - - - - - - - - - - - - - - - - -##### presence_penalty [#operation-chat_completion_v1_chat_completions_post_request_presence_penalty] - - - - - -presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_mode [#operation-chat_completion_v1_chat_completions_post_request_prompt_mode] - - - - - -Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - - - - - - - - - -##### random_seed [#operation-chat_completion_v1_chat_completions_post_request_random_seed] - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### response_format [#operation-chat_completion_v1_chat_completions_post_request_response_format] - - - - - - - - - -#### ResponseFormat [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_response_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### safe_prompt [#operation-chat_completion_v1_chat_completions_post_request_safe_prompt] - - - - - -Whether to inject a safety prompt before all conversations. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### stop [#operation-chat_completion_v1_chat_completions_post_request_stop] - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream [#operation-chat_completion_v1_chat_completions_post_request_stream] - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### temperature [#operation-chat_completion_v1_chat_completions_post_request_temperature] - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - -ToolChoice","children":[],"breakoutSubTypes":{}},{"label":"enum","linkedLabel":"enum","children":[{"label":"\"auto\"","linkedLabel":"\"auto\"","children":[],"breakoutSubTypes":{}},{"label":"\"none\"","linkedLabel":"\"none\"","children":[],"breakoutSubTypes":{}},{"label":"\"any\"","linkedLabel":"\"any\"","children":[],"breakoutSubTypes":{}},{"label":"\"required\"","linkedLabel":"\"required\"","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tool_choice [#operation-chat_completion_v1_chat_completions_post_request_tool_choice] - - - - - - - - - -#### ToolChoice [#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice] - - - - - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - - - - - -FunctionName","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function] - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -#### FunctionName [#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function_functionname] - - - - - -this restriction of `Function` is used to select a specific function to call - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_function_functionname_name] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_tool_choice_toolchoice_type] - - - - - - - - - - - - - -Tool","children":[{"label":"Tool","linkedLabel":"Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### tools [#operation-chat_completion_v1_chat_completions_post_request_tools] - - - - - - - - - -#### Tool [#operation-chat_completion_v1_chat_completions_post_request_tools_tool] - - - - - -Function","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function] - - - - - - - - - -#### Function [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function] - - - - - - - - - -##### description [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_description] - - - - - -_Default Value:_ `""` - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_name] - - - - - - - - - -##### parameters [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_parameters] - - - - - - - - - -##### strict [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_function_function_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_request_tools_tool_type] - - - - - - - - - - - - - - - - - -##### top_p [#operation-chat_completion_v1_chat_completions_post_request_top_p] - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - -_Default Value:_ `1` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-chat_completion_v1_chat_completions_post_responses-examples] - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-chat_completion_v1_chat_completions_post_responses] - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices] - - - - - - - - - -#### ChatCompletionChoice [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice] - - - - - - - - - -##### finish_reason [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason] - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_index] - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message] - - - - - - - - - -#### AssistantMessage [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_created] - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_model] - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_object] - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage] - - - - - - - - - -#### UsageInfo [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_application-json_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent] - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data] - - - - - - - - - -#### CompletionChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk] - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices] - - - - - - - - - -#### CompletionResponseStreamChoice [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice] - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta] - - - - - - - - - -#### DeltaMessage [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_role] - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_finish_reason] - - - - - - - - - -##### index [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_index] - - - - - - - - - - - - - - - - - -##### created [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_created] - - - - - - - - - -##### id [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_id] - - - - - - - - - -##### model [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_model] - - - - - - - - - -##### object [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_object] - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage] - - - - - - - - - -#### UsageInfo [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-chat_completion_v1_chat_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-chat_completion_v1_chat_completions_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/classifiers/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/classifiers/page.mdx deleted file mode 100644 index 89c26a4bf..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/classifiers/page.mdx +++ /dev/null @@ -1,8249 +0,0 @@ ---- -sidebarTitle: Classifiers ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Classifiers Endpoints - - - - - -Classifiers API. - - - - - - - - - -## POST /v1/moderations [#operation-moderations_v1_moderations_post] - - - - - -Moderations - - - - - - - - - -TypeScript - - - - - -\",\n \"\",\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.moderate(model="Durango", inputs=[ - "", - "", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-moderations_v1_moderations_post_request-examples] - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-moderations_v1_moderations_post_request] - - - - - - - - - - - -##### input [#operation-moderations_v1_moderations_post_request_input] - - - - - -Text to classify. - - - - - - - - - -##### model [#operation-moderations_v1_moderations_post_request_model] - - - - - -ID of the model to use. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-moderations_v1_moderations_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-moderations_v1_moderations_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id [#operation-moderations_v1_moderations_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-moderations_v1_moderations_post_responses_200_application-json_model] - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-moderations_v1_moderations_post_responses_200_application-json_results] - - - - - - - - - -#### ModerationObject [#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject] - - - - - - - - - -##### categories [#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject_categories] - - - - - -Moderation result thresholds - - - - - - - - - -##### category_scores [#operation-moderations_v1_moderations_post_responses_200_application-json_results_moderationobject_category_scores] - - - - - -Moderation result - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-moderations_v1_moderations_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-moderations_v1_moderations_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-moderations_v1_moderations_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/chat/moderations [#operation-chat_moderations_v1_chat_moderations_post] - - - - - -Chat Moderations - - - - - - - - - -TypeScript - - - - - -\",\n role: \"tool\",\n },\n ],\n model: \"LeBaron\",\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.moderate_chat(inputs=[ - { - "content": "", - "role": "tool", - }, - ], model="LeBaron") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-chat_moderations_v1_chat_moderations_post_request-examples] - - - - - -```json -{ - "input": [ - { - "content": "ipsum eiusmod" - } - ], - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-chat_moderations_v1_chat_moderations_post_request] - - - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"union","children":[{"label":"array","linkedLabel":"union","children":[{"label":"union","linkedLabel":"union","children":[{"label":"SystemMessage","linkedLabel":"SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input [#operation-chat_moderations_v1_chat_moderations_post_request_input] - - - - - -Chat to classify - - - - - - - - - -#### SystemMessage [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage] - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_moderations_v1_chat_moderations_post_request_input_systemmessage_role] - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_moderations_v1_chat_moderations_post_request_input_usermessage_role] - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_name] - - - - - - - - - -##### role [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_role] - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id [#operation-chat_moderations_v1_chat_moderations_post_request_input_toolmessage_tool_call_id] - - - - - - - - - - - - - - - - - -##### model [#operation-chat_moderations_v1_chat_moderations_post_request_model] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-chat_moderations_v1_chat_moderations_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - {} - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-chat_moderations_v1_chat_moderations_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_model] - - - - - -ModerationObject","children":[{"label":"ModerationObject","linkedLabel":"ModerationObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results] - - - - - - - - - -#### ModerationObject [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject] - - - - - - - - - -##### categories [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject_categories] - - - - - -Moderation result thresholds - - - - - - - - - -##### category_scores [#operation-chat_moderations_v1_chat_moderations_post_responses_200_application-json_results_moderationobject_category_scores] - - - - - -Moderation result - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-chat_moderations_v1_chat_moderations_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/classifications [#operation-classifications_v1_classifications_post] - - - - - -Classifications - - - - - - - - - -TypeScript - - - - - -\",\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.classify(model="Silverado", inputs=[ - "", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-classifications_v1_classifications_post_request-examples] - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-classifications_v1_classifications_post_request] - - - - - - - - - - - -##### input [#operation-classifications_v1_classifications_post_request_input] - - - - - -Text to classify. - - - - - - - - - -##### model [#operation-classifications_v1_classifications_post_request_model] - - - - - -ID of the model to use. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-classifications_v1_classifications_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-classifications_v1_classifications_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id [#operation-classifications_v1_classifications_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-classifications_v1_classifications_post_responses_200_application-json_model] - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-classifications_v1_classifications_post_responses_200_application-json_results] - - - - - - - - - -#### ClassificationTargetResult [#operation-classifications_v1_classifications_post_responses_200_application-json_results_classificationtargetresult] - - - - - - - - - -##### scores [#operation-classifications_v1_classifications_post_responses_200_application-json_results_classificationtargetresult_scores] - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-classifications_v1_classifications_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-classifications_v1_classifications_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-classifications_v1_classifications_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/chat/classifications [#operation-chat_classifications_v1_chat_classifications_post] - - - - - -Chat Classifications - - - - - - - - - -TypeScript - - - - - -\",\n role: \"system\",\n },\n ],\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();\n`} - dependencyUrlPrefix="/mistral-try-it-now" - packageName="@mistralai/mistralai" -/> - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.classifiers.classify_chat(model="Camry", inputs=[ - { - "messages": [ - { - "content": "", - "role": "system", - }, - ], - }, - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-chat_classifications_v1_chat_classifications_post_request-examples] - - - - - -```json -{ - "input": { - "messages": [ - { - "content": "ipsum eiusmod" - } - ] - }, - "model": "consequat do" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-chat_classifications_v1_chat_classifications_post_request] - - - - - - - -InstructRequest","children":[],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"InstructRequest","children":[{"label":"InstructRequest","linkedLabel":"InstructRequest","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### input [#operation-chat_classifications_v1_chat_classifications_post_request_input] - - - - - -Chat to classify - - - - - - - - - -#### InstructRequest [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest] - - - - - -SystemMessage","children":[],"breakoutSubTypes":{}},{"label":"UserMessage","linkedLabel":"UserMessage","children":[],"breakoutSubTypes":{}},{"label":"AssistantMessage","linkedLabel":"AssistantMessage","children":[],"breakoutSubTypes":{}},{"label":"ToolMessage","linkedLabel":"ToolMessage","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### messages [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages] - - - - - - - - - -#### SystemMessage [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage] - - - - - -TextChunk","children":[{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_systemmessage_role] - - - - - -_Default Value:_ `"system"` - - - - - - - - - - - - - -#### UserMessage [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_usermessage_role] - - - - - -_Default Value:_ `"user"` - - - - - - - - - - - - - -#### AssistantMessage [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - -#### ToolMessage [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content] - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### name [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_name] - - - - - - - - - -##### role [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_role] - - - - - -_Default Value:_ `"tool"` - - - - - - - - - -##### tool_call_id [#operation-chat_classifications_v1_chat_classifications_post_request_input_instructrequest_messages_toolmessage_tool_call_id] - - - - - - - - - - - - - - - - - - - - - - - - - -##### model [#operation-chat_classifications_v1_chat_classifications_post_request_model] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-chat_classifications_v1_chat_classifications_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "mod-e5cc70bb28c444948073e77776eb30ef", - "model": "consequat do", - "results": [ - [ - { - "scores": [ - 87 - ] - } - ] - ] -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-chat_classifications_v1_chat_classifications_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### id [#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -mod-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_model] - - - - - -ClassificationTargetResult","children":[{"label":"map","linkedLabel":"ClassificationTargetResult","children":[{"label":"ClassificationTargetResult","linkedLabel":"ClassificationTargetResult","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results] - - - - - - - - - -#### ClassificationTargetResult [#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results_classificationtargetresult] - - - - - - - - - -##### scores [#operation-chat_classifications_v1_chat_classifications_post_responses_200_application-json_results_classificationtargetresult_scores] - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-chat_classifications_v1_chat_classifications_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/embeddings/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/embeddings/page.mdx deleted file mode 100644 index a0fb67754..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/embeddings/page.mdx +++ /dev/null @@ -1,988 +0,0 @@ ---- -sidebarTitle: Embeddings ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Embeddings Endpoints - - - - - -Embeddings API. - - - - - - - - - -## POST /v1/embeddings [#operation-embeddings_v1_embeddings_post] - - - - - -_Embeddings_ - - - - - -Embeddings - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.embeddings.create(model="mistral-embed", inputs=[ - "Embed this sentence.", - "As well as this one.", - ]) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-embeddings_v1_embeddings_post_request-examples] - - - - - -```json -{ - "input": "ipsum eiusmod", - "model": "mistral-embed" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-embeddings_v1_embeddings_post_request] - - - - - - - - - - - -##### input [#operation-embeddings_v1_embeddings_post_request_input] - - - - - -Text to embed. - - - - - - - - - -##### model [#operation-embeddings_v1_embeddings_post_request_model] - - - - - -ID of the model to use. - - - - - -_Example:_ - -``` -mistral-embed -``` - - - - - - - - - -##### output_dimension [#operation-embeddings_v1_embeddings_post_request_output_dimension] - - - - - -The dimension of the output embeddings. - - - - - - - - - -##### output_dtype [#operation-embeddings_v1_embeddings_post_request_output_dtype] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-embeddings_v1_embeddings_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "data": [ - {} - ], - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "mistral-small-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-embeddings_v1_embeddings_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -EmbeddingResponseData","children":[{"label":"EmbeddingResponseData","linkedLabel":"EmbeddingResponseData","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-embeddings_v1_embeddings_post_responses_200_application-json_data] - - - - - - - - - -#### EmbeddingResponseData [#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata] - - - - - - - - - -##### embedding [#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_embedding] - - - - - - - - - -##### index [#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_index] - - - - - -_Example:_ - -``` -0 -``` - - - - - - - - - -##### object [#operation-embeddings_v1_embeddings_post_responses_200_application-json_data_embeddingresponsedata_object] - - - - - -_Example:_ - -``` -embedding -``` - - - - - - - - - - - - - - - - - -##### id [#operation-embeddings_v1_embeddings_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-embeddings_v1_embeddings_post_responses_200_application-json_model] - - - - - -_Example:_ - -``` -mistral-small-latest -``` - - - - - - - - - -##### object [#operation-embeddings_v1_embeddings_post_responses_200_application-json_object] - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage] - - - - - - - - - -#### UsageInfo [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-embeddings_v1_embeddings_post_responses_200_application-json_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-embeddings_v1_embeddings_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-embeddings_v1_embeddings_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/files/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/files/page.mdx deleted file mode 100644 index 7ffc2f834..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/files/page.mdx +++ /dev/null @@ -1,2642 +0,0 @@ ---- -sidebarTitle: Files ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Files Endpoints - - - - - -Files API - - - - - - - - - -## GET /v1/files [#operation-files_api_routes_list_files] - - - - - -_List Files_ - - - - - -Returns a list of files that belong to the user's organization. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.list(page=0, page_size=100) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-files_api_routes_list_files_responses-examples] - - - - - -200 - - - - - -```json -{ - "data": [ - { - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" - } - ], - "object": "occaecat dolor sit", - "total": 56 -} -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_list_files_responses] - - - - - -200 - - - - - - - -OK - - - - - -FileSchema","children":[{"label":"FileSchema","linkedLabel":"FileSchema","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-files_api_routes_list_files_responses_200_application-json_data] - - - - - - - - - -#### FileSchema [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema] - - - - - - - - - -##### bytes [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_bytes] - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### filename [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_filename] - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_id] - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_mimetype] - - - - - - - - - -##### num_lines [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_num_lines] - - - - - - - - - -##### object [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_object] - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_purpose] - - - - - - - - - -##### sample_type [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_sample_type] - - - - - - - - - -##### signature [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_signature] - - - - - - - - - -##### source [#operation-files_api_routes_list_files_responses_200_application-json_data_fileschema_source] - - - - - - - - - - - - - - - - - -##### object [#operation-files_api_routes_list_files_responses_200_application-json_object] - - - - - - - - - -##### total [#operation-files_api_routes_list_files_responses_200_application-json_total] - - - - - - - - - - - - - - - - - - - -## POST /v1/files [#operation-files_api_routes_upload_file] - - - - - -_Upload File_ - - - - - -Upload a file that can be used across various endpoints. - -The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - -Please contact us if you need to increase these storage limits. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.upload(file={ - "file_name": "example.file", - "content": open("example.file", "rb"), - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-files_api_routes_upload_file_request-examples] - - - - - -```json -{ - "file": { - "content": "ipsum eiusmod", - "fileName": "consequat do" - } -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-files_api_routes_upload_file_request] - - - - - - - -File","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### file [#operation-files_api_routes_upload_file_request_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -#### File [#operation-files_api_routes_upload_file_request_file_file] - - - - - -The File object (not file name) to be uploaded. - To upload a file and specify a custom file name you should format your request as such: - ```bash - file=@path/to/your/file.jsonl;filename=custom_name.jsonl - ``` - Otherwise, you can just keep the original file name: - ```bash - file=@path/to/your/file.jsonl - ``` - - - - - - - - - -##### content [#operation-files_api_routes_upload_file_request_file_file_content] - - - - - - - - - -##### fileName [#operation-files_api_routes_upload_file_request_file_file_filename] - - - - - - - - - - - - - - - - - -##### purpose [#operation-files_api_routes_upload_file_request_purpose] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-files_api_routes_upload_file_responses-examples] - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_upload_file_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes [#operation-files_api_routes_upload_file_responses_200_application-json_bytes] - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at [#operation-files_api_routes_upload_file_responses_200_application-json_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### filename [#operation-files_api_routes_upload_file_responses_200_application-json_filename] - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id [#operation-files_api_routes_upload_file_responses_200_application-json_id] - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype [#operation-files_api_routes_upload_file_responses_200_application-json_mimetype] - - - - - - - - - -##### num_lines [#operation-files_api_routes_upload_file_responses_200_application-json_num_lines] - - - - - - - - - -##### object [#operation-files_api_routes_upload_file_responses_200_application-json_object] - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose [#operation-files_api_routes_upload_file_responses_200_application-json_purpose] - - - - - - - - - -##### sample_type [#operation-files_api_routes_upload_file_responses_200_application-json_sample_type] - - - - - - - - - -##### signature [#operation-files_api_routes_upload_file_responses_200_application-json_signature] - - - - - - - - - -##### source [#operation-files_api_routes_upload_file_responses_200_application-json_source] - - - - - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\} [#operation-files_api_routes_retrieve_file] - - - - - -_Retrieve File_ - - - - - -Returns information about a specific file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.retrieve(file_id="f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-files_api_routes_retrieve_file_parameters] - - - - - - - - - - - -##### file_id [#operation-files_api_routes_retrieve_file_parameters_file_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-files_api_routes_retrieve_file_responses-examples] - - - - - -200 - - - - - -```json -{ - "bytes": "13000", - "created_at": "1716963433", - "deleted": false, - "filename": "files_upload.jsonl", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file", - "purpose": "fine-tune", - "sample_type": "pretrain", - "source": "upload" -} -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_retrieve_file_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### bytes [#operation-files_api_routes_retrieve_file_responses_200_application-json_bytes] - - - - - -The size of the file, in bytes. - - - - - -_Example:_ - -``` -13000 -``` - - - - - - - - - -##### created_at [#operation-files_api_routes_retrieve_file_responses_200_application-json_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - - - - - -##### deleted [#operation-files_api_routes_retrieve_file_responses_200_application-json_deleted] - - - - - - - - - -##### filename [#operation-files_api_routes_retrieve_file_responses_200_application-json_filename] - - - - - -The name of the uploaded file. - - - - - -_Example:_ - -``` -files_upload.jsonl -``` - - - - - - - - - -##### id [#operation-files_api_routes_retrieve_file_responses_200_application-json_id] - - - - - -The unique identifier of the file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### mimetype [#operation-files_api_routes_retrieve_file_responses_200_application-json_mimetype] - - - - - - - - - -##### num_lines [#operation-files_api_routes_retrieve_file_responses_200_application-json_num_lines] - - - - - - - - - -##### object [#operation-files_api_routes_retrieve_file_responses_200_application-json_object] - - - - - -The object type, which is always "file". - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - -##### purpose [#operation-files_api_routes_retrieve_file_responses_200_application-json_purpose] - - - - - - - - - -##### sample_type [#operation-files_api_routes_retrieve_file_responses_200_application-json_sample_type] - - - - - - - - - -##### signature [#operation-files_api_routes_retrieve_file_responses_200_application-json_signature] - - - - - - - - - -##### source [#operation-files_api_routes_retrieve_file_responses_200_application-json_source] - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/files/\{file\_id\} [#operation-files_api_routes_delete_file] - - - - - -_Delete File_ - - - - - -Delete a file. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.delete(file_id="3b6d45eb-e30b-416f-8019-f47e2e93d930") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-files_api_routes_delete_file_parameters] - - - - - - - - - - - -##### file_id [#operation-files_api_routes_delete_file_parameters_file_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-files_api_routes_delete_file_responses-examples] - - - - - -200 - - - - - -```json -{ - "deleted": "false", - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", - "object": "file" -} -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_delete_file_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### deleted [#operation-files_api_routes_delete_file_responses_200_application-json_deleted] - - - - - -The deletion status. - - - - - -_Example:_ - -``` -false -``` - - - - - - - - - -##### id [#operation-files_api_routes_delete_file_responses_200_application-json_id] - - - - - -The ID of the deleted file. - - - - - -_Example:_ - -``` -497f6eca-6276-4993-bfeb-53cbbbba6f09 -``` - - - - - - - - - -##### object [#operation-files_api_routes_delete_file_responses_200_application-json_object] - - - - - -The object type that was deleted - - - - - -_Example:_ - -``` -file -``` - - - - - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\}/content [#operation-files_api_routes_download_file] - - - - - -_Download File_ - - - - - -Download a file - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.download(file_id="f8919994-a4a1-46b2-8b5b-06335a4300ce") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-files_api_routes_download_file_parameters] - - - - - - - - - - - -##### file_id [#operation-files_api_routes_download_file_parameters_file_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-files_api_routes_download_file_responses-examples] - - - - - -200 - - - - - -```json -"ipsum eiusmod" -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_download_file_responses] - - - - - -200 - - - - - - - - - - - - - -OK - - - - - - - - - -     - - - - - -## GET /v1/files/\{file\_id\}/url [#operation-files_api_routes_get_signed_url] - - - - - -Get Signed Url - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.files.get_signed_url(file_id="06a020ab-355c-49a6-b19d-304b7c01699f", expiry=24) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-files_api_routes_get_signed_url_parameters] - - - - - - - - - - - -##### file_id [#operation-files_api_routes_get_signed_url_parameters_file_id] - - - - - - - - - -##### expiry [#operation-files_api_routes_get_signed_url_parameters_expiry] - - - - - -Number of hours before the url becomes invalid. Defaults to 24h - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-files_api_routes_get_signed_url_responses-examples] - - - - - -200 - - - - - -```json -{ - "url": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses [#operation-files_api_routes_get_signed_url_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### url [#operation-files_api_routes_get_signed_url_responses_200_application-json_url] - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/fim/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/fim/page.mdx deleted file mode 100644 index 3df9a890a..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/fim/page.mdx +++ /dev/null @@ -1,3640 +0,0 @@ ---- -sidebarTitle: Fim ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Fim Endpoints - - - - - -Fill-in-the-middle API. - - - - - - - - - -## POST /v1/fim/completions [#operation-fim_completion_v1_fim_completions_post] - - - - - -_Fim Completion_ - - - - - -FIM completion. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fim.complete(model="codestral-2405", prompt="def", top_p=1, stream=False, suffix="return a+b") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-fim_completion_v1_fim_completions_post_request-examples] - - - - - -```json -{ - "prompt": "def" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-fim_completion_v1_fim_completions_post_request] - - - - - - - - - - - -##### max_tokens [#operation-fim_completion_v1_fim_completions_post_request_max_tokens] - - - - - -The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - - - - - - - - - -##### min_tokens [#operation-fim_completion_v1_fim_completions_post_request_min_tokens] - - - - - -The minimum number of tokens to generate in the completion. - - - - - - - - - -##### model [#operation-fim_completion_v1_fim_completions_post_request_model] - - - - - -ID of the model to use. Only compatible for now with: - - `codestral-2405` - - `codestral-latest` - - - - - -_Example:_ - -``` -codestral-2405 -``` - - - - - -_Default Value:_ `"codestral-2405"` - - - - - - - - - -##### prompt [#operation-fim_completion_v1_fim_completions_post_request_prompt] - - - - - -The text/code to complete. - - - - - -_Example:_ - -``` -def -``` - - - - - - - - - -##### random_seed [#operation-fim_completion_v1_fim_completions_post_request_random_seed] - - - - - -The seed to use for random sampling. If set, different calls will generate deterministic results. - - - - - - - - - -##### stop [#operation-fim_completion_v1_fim_completions_post_request_stop] - - - - - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - - - - - - - - -##### stream [#operation-fim_completion_v1_fim_completions_post_request_stream] - - - - - -Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### suffix [#operation-fim_completion_v1_fim_completions_post_request_suffix] - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - -_Example:_ - -``` -return a+b -``` - - - - - - - - - -##### temperature [#operation-fim_completion_v1_fim_completions_post_request_temperature] - - - - - -What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - - - - - - - - - -##### top_p [#operation-fim_completion_v1_fim_completions_post_request_top_p] - - - - - -Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - - - - - -_Default Value:_ `1` - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-fim_completion_v1_fim_completions_post_responses-examples] - - - - - -200 (application/json) - - - - - -```json -{ - "choices": [ - { - "finish_reason": "stop", - "index": "0", - "message": {} - } - ], - "created": "1702256327", - "id": "cmpl-e5cc70bb28c444948073e77776eb30ef", - "model": "codestral-latest", - "object": "chat.completion", - "usage": {} -} -``` - - - - - -200 (text/event-stream) - - - - - -```json -null -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-fim_completion_v1_fim_completions_post_responses] - - - - - -200 (application/json) - - - - - - - -Successful Response - - - - - -ChatCompletionChoice","children":[{"label":"ChatCompletionChoice","linkedLabel":"ChatCompletionChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### choices [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices] - - - - - - - - - -#### ChatCompletionChoice [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice] - - - - - - - - - -##### finish_reason [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_finish_reason] - - - - - -_Example:_ - -``` -stop -``` - - - - - - - - - -##### index [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_index] - - - - - -_Example:_ - -``` -0 -``` - - - - - -AssistantMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### message [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message] - - - - - - - - - -#### AssistantMessage [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content] - - - - - - - - - -#### TextChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk] - - - - - - - - - -##### text [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### prefix [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_prefix] - - - - - -Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - - - - - -_Default Value:_ `false` - - - - - - - - - -##### role [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_role] - - - - - -_Default Value:_ `"assistant"` - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_choices_chatcompletionchoice_message_assistantmessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### created [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_created] - - - - - -_Example:_ - -``` -1702256327 -``` - - - - - - - - - -##### id [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_id] - - - - - -_Example:_ - -``` -cmpl-e5cc70bb28c444948073e77776eb30ef -``` - - - - - - - - - -##### model [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_model] - - - - - -_Example:_ - -``` -codestral-latest -``` - - - - - - - - - -##### object [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_object] - - - - - -_Example:_ - -``` -chat.completion -``` - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage] - - - - - - - - - -#### UsageInfo [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_application-json_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - -200 (text/event-stream) - - - - - - - -CompletionEvent","children":[{"label":"CompletionEvent","linkedLabel":"CompletionEvent","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### CompletionEvent [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent] - - - - - -CompletionChunk","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### data [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data] - - - - - - - - - -#### CompletionChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk] - - - - - -CompletionResponseStreamChoice","children":[{"label":"CompletionResponseStreamChoice","linkedLabel":"CompletionResponseStreamChoice","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### choices [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices] - - - - - - - - - -#### CompletionResponseStreamChoice [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice] - - - - - -DeltaMessage","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### delta [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta] - - - - - - - - - -#### DeltaMessage [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage] - - - - - -TextChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ReferenceChunk","linkedLabel":"ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"FileChunk","linkedLabel":"FileChunk","children":[],"breakoutSubTypes":{}},{"label":"ThinkChunk","linkedLabel":"ThinkChunk","children":[],"breakoutSubTypes":{}},{"label":"AudioChunk","linkedLabel":"AudioChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### content [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content] - - - - - - - - - -#### TextChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk] - - - - - - - - - -##### text [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_text] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk] - - - - - - - - - -##### document_name [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ReferenceChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk] - - - - - - - - - -##### reference_ids [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### FileChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk] - - - - - - - - - -##### file_id [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_file_id] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### ThinkChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk] - - - - - - - - - -##### closed [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_closed] - - - - - -Whether the thinking chunk is closed or not. Currently only used for prefixing. - - - - - -_Default Value:_ `true` - - - - - -ReferenceChunk","children":[],"breakoutSubTypes":{}},{"label":"TextChunk","linkedLabel":"TextChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### thinking [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking] - - - - - - - - - -#### ReferenceChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk] - - - - - - - - - -##### reference_ids [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_reference_ids] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_referencechunk_type] - - - - - -_Default Value:_ `"reference"` - - - - - - - - - - - - - -#### TextChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk] - - - - - - - - - -##### text [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_text] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_thinking_textchunk_type] - - - - - -_Default Value:_ `"text"` - - - - - - - - - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_thinkchunk_type] - - - - - -_Default Value:_ `"thinking"` - - - - - - - - - - - - - -#### AudioChunk [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk] - - - - - - - - - -##### input_audio [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_input_audio] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_content_audiochunk_type] - - - - - -_Default Value:_ `"input_audio"` - - - - - - - - - - - - - - - - - -##### role [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_role] - - - - - -ToolCall","children":[{"label":"ToolCall","linkedLabel":"ToolCall","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### tool_calls [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls] - - - - - - - - - -#### ToolCall [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall] - - - - - -FunctionCall","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### function [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function] - - - - - - - - - -#### FunctionCall [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall] - - - - - - - - - -##### arguments [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_arguments] - - - - - - - - - -##### name [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_function_functioncall_name] - - - - - - - - - - - - - - - - - -##### id [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_id] - - - - - -_Default Value:_ `"null"` - - - - - - - - - -##### index [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_index] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_delta_deltamessage_tool_calls_toolcall_type] - - - - - - - - - - - - - - - - - - - - - - - - - -##### finish_reason [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_finish_reason] - - - - - - - - - -##### index [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_choices_completionresponsestreamchoice_index] - - - - - - - - - - - - - - - - - -##### created [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_created] - - - - - - - - - -##### id [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_id] - - - - - - - - - -##### model [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_model] - - - - - - - - - -##### object [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_object] - - - - - -UsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### usage [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage] - - - - - - - - - -#### UsageInfo [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo] - - - - - - - - - -##### completion_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_completion_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### prompt_audio_seconds [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_audio_seconds] - - - - - - - - - -##### prompt_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_prompt_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### total_tokens [#operation-fim_completion_v1_fim_completions_post_responses_200_text-event-stream_completionevent_data_completionchunk_usage_usageinfo_total_tokens] - - - - - -_Default Value:_ `0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-fim_completion_v1_fim_completions_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/fine-tuning/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/fine-tuning/page.mdx deleted file mode 100644 index 1927d07d5..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/fine-tuning/page.mdx +++ /dev/null @@ -1,14285 +0,0 @@ ---- -sidebarTitle: Fine Tuning ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Fine Tuning Endpoints - - - - - -Fine-tuning API - - - - - - - - - -## GET /v1/fine\_tuning/jobs [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs] - - - - - -_Get Fine Tuning Jobs_ - - - - - -Get a list of fine-tuning jobs for your organization and user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.list(page=0, page_size=100, created_by_me=False) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses-examples] - - - - - -200 - - - - - -```json -{ - "total": 87 -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses] - - - - - -200 - - - - - - - -OK - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data] - - - - - - - - - -#### CompletionJobOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_auto_start] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_fine_tuned_model] - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters] - - - - - - - - - -#### CompletionTrainingParameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_hyperparameters_completiontrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_id] - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations] - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_job_type] - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_modified_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_object] - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories] - - - - - - - - - -#### GithubRepositoryOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout] - - - - - - - - - -##### commit_id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_commit_id] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_ref] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_repositories_githubrepositoryout_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_status] - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_suffix] - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_trained_tokens] - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_training_files] - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_completionjobout_validation_files] - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### ClassifierJobOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_auto_start] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_fine_tuned_model] - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters] - - - - - - - - - -#### ClassifierTrainingParameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_hyperparameters_classifiertrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_id] - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations] - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_job_type] - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_modified_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_object] - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_status] - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_suffix] - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_trained_tokens] - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_training_files] - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_data_classifierjobout_validation_files] - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_object] - - - - - -_Default Value:_ `"list"` - - - - - - - - - -##### total [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_jobs_responses_200_application-json_total] - - - - - - - - - - - - - - - - - - - -## POST /v1/fine\_tuning/jobs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job] - - - - - -_Create Fine Tuning Job_ - - - - - -Create a new fine-tuning job, it will be queued for processing. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.create(model="Camaro", hyperparameters={ - "learning_rate": 0.0001, - }, invalid_sample_skip_percentage=0) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters] - - - - - - - - - - - -##### dry_run [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_parameters_dry_run] - - - - - -* If `true` the job is not spawned, instead the query returns a handful of useful metadata - for the user to perform sanity checks (see `LegacyJobMetadataOut` response). -* Otherwise, the job is started and the query returns the job ID along with some of the - input parameters (see `JobOut` response). - - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request-examples] - - - - - -```json -{ - "hyperparameters": {}, - "model": "ministral-3b-latest" -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request] - - - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_auto_start] - - - - - -This field will be required in a future release. - - - - - -ClassifierTargetIn","children":[{"label":"ClassifierTargetIn","linkedLabel":"ClassifierTargetIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### classifier_targets [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets] - - - - - - - - - -#### ClassifierTargetIn [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin] - - - - - - - - - -##### labels [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_labels] - - - - - - - - - -##### loss_function [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_loss_function] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_name] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_classifier_targets_classifiertargetin_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - -CompletionTrainingParametersIn","children":[],"breakoutSubTypes":{}},{"label":"ClassifierTrainingParametersIn","linkedLabel":"ClassifierTrainingParametersIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters] - - - - - - - - - -#### CompletionTrainingParametersIn [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin] - - - - - -The fine-tuning hyperparameter settings used in a fine-tune job. - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_learning_rate] - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_training_steps] - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_warmup_fraction] - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_completiontrainingparametersin_weight_decay] - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - - - - - - - -#### ClassifierTrainingParametersIn [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin] - - - - - -The fine-tuning hyperparameter settings used in a classifier fine-tune job. - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_learning_rate] - - - - - -A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_training_steps] - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_warmup_fraction] - - - - - -(Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_hyperparameters_classifiertrainingparametersin_weight_decay] - - - - - -(Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - - - - - - - - - - - - - -WandbIntegration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations] - - - - - -A list of integrations to enable for your fine-tuning job. - - - - - - - - - -#### WandbIntegration [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration] - - - - - - - - - -##### api_key [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_api_key] - - - - - -The WandB API key to use for authentication. - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_integrations_wandbintegration_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - - - - - - - - - -##### invalid_sample_skip_percentage [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_invalid_sample_skip_percentage] - - - - - -_Default Value:_ `0` - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_job_type] - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_model] - - - - - -The name of the model to fine-tune. - - - - - -GithubRepositoryIn","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories] - - - - - - - - - -#### GithubRepositoryIn [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_ref] - - - - - - - - - -##### token [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_token] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_repositories_githubrepositoryin_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_suffix] - - - - - -A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - - - - - -TrainingFile","children":[{"label":"TrainingFile","linkedLabel":"TrainingFile","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files] - - - - - - - - - -#### TrainingFile [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile] - - - - - - - - - -##### file_id [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile_file_id] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_training_files_trainingfile_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_request_validation_files] - - - - - -A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses] - - - - - -200 - - - - - - - -CompletionJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierJobOut","linkedLabel":"ClassifierJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"LegacyJobMetadataOut","linkedLabel":"LegacyJobMetadataOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionJobOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_auto_start] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_fine_tuned_model] - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters] - - - - - - - - - -#### CompletionTrainingParameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_hyperparameters_completiontrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_id] - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations] - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_job_type] - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_modified_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_object] - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories] - - - - - - - - - -#### GithubRepositoryOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout] - - - - - - - - - -##### commit_id [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_commit_id] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_ref] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_repositories_githubrepositoryout_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_status] - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_suffix] - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_trained_tokens] - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_training_files] - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_completionjobout_validation_files] - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### ClassifierJobOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_auto_start] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was created. - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_fine_tuned_model] - - - - - -The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters] - - - - - - - - - -#### ClassifierTrainingParameters [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_hyperparameters_classifiertrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_id] - - - - - -The ID of the job. - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations] - - - - - -A list of integrations enabled for your fine-tuning job. - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_job_type] - - - - - -The type of job (`FT` for fine-tuning). - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_modified_at] - - - - - -The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_object] - - - - - -The object type of the fine-tuning job. - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_status] - - - - - -The current status of the fine-tuning job. - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_suffix] - - - - - -Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_trained_tokens] - - - - - -Total number of tokens trained. - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_training_files] - - - - - -A list containing the IDs of uploaded files that contain training data. - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_classifierjobout_validation_files] - - - - - -A list containing the IDs of uploaded files that contain validation data. - - - - - - - - - - - - - -#### LegacyJobMetadataOut [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_cost] - - - - - -The cost of the fine-tuning job. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_cost_currency] - - - - - -The currency used for the fine-tuning job cost. - - - - - -_Example:_ - -``` -EUR -``` - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_data_tokens] - - - - - -The total number of tokens in the training dataset. - - - - - -_Example:_ - -``` -305375 -``` - - - - - - - - - -##### deprecated [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_deprecated] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### details [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_details] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_epochs] - - - - - -The number of complete passes through the entire training dataset. - - - - - -_Example:_ - -``` -4.2922 -``` - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_expected_duration_seconds] - - - - - -The approximated time (in seconds) for the fine-tuning process to complete. - - - - - -_Example:_ - -``` -220 -``` - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_object] - - - - - -_Default Value:_ `"job.metadata"` - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_train_tokens] - - - - - -The total number of tokens used during the fine-tuning process. - - - - - -_Example:_ - -``` -1310720 -``` - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_train_tokens_per_step] - - - - - -The number of tokens consumed by one training step. - - - - - -_Example:_ - -``` -131072 -``` - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_create_fine_tuning_job_responses_200_application-json_legacyjobmetadataout_training_steps] - - - - - -The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -     - - - - - -## GET /v1/fine\_tuning/jobs/\{job\_id\} [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job] - - - - - -_Get Fine Tuning Job_ - - - - - -Get a fine-tuned job details by its UUID. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.get(job_id="c167a961-ffca-4bcf-93ac-6169468dd389") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters] - - - - - - - - - - - -##### job_id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_parameters_job_id] - - - - - -The ID of the job to analyse. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses] - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model] - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters] - - - - - - - - - -#### CompletionTrainingParameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type] - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories] - - - - - - - - - -#### GithubRepositoryOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout] - - - - - - - - - -##### commit_id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files] - - - - - - - - - - - - - -#### ClassifierDetailedJobOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets] - - - - - - - - - -#### ClassifierTargetOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout] - - - - - - - - - -##### labels [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels] - - - - - - - - - -##### loss_function [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight] - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model] - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters] - - - - - - - - - -#### ClassifierTrainingParameters [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type] - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_get_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files] - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/cancel [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job] - - - - - -_Cancel Fine Tuning Job_ - - - - - -Request the cancellation of a fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.cancel(job_id="6188a2f6-7513-4e0f-89cc-3f8088523a49") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters] - - - - - - - - - - - -##### job_id [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_parameters_job_id] - - - - - -The ID of the job to cancel. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses] - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model] - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters] - - - - - - - - - -#### CompletionTrainingParameters [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type] - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories] - - - - - - - - - -#### GithubRepositoryOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout] - - - - - - - - - -##### commit_id [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files] - - - - - - - - - - - - - -#### ClassifierDetailedJobOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets] - - - - - - - - - -#### ClassifierTargetOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout] - - - - - - - - - -##### labels [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels] - - - - - - - - - -##### loss_function [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight] - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model] - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters] - - - - - - - - - -#### ClassifierTrainingParameters [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type] - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_cancel_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files] - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/jobs/\{job\_id\}/start [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job] - - - - - -_Start Fine Tuning Job_ - - - - - -Request the start of a validated fine tuning job. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.fine_tuning.jobs.start(job_id="56553e4d-0679-471e-b9ac-59a77d671103") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters] - - - - - - - - - - - -##### job_id [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_parameters_job_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses-examples] - - - - - -200 - - - - - -```json -{ - "auto_start": false, - "created_at": 87, - "hyperparameters": {}, - "id": "ipsum eiusmod", - "model": "ministral-3b-latest", - "modified_at": 14, - "status": "QUEUED", - "training_files": [ - "consequat do" - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses] - - - - - -200 - - - - - - - -CompletionDetailedJobOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierDetailedJobOut","linkedLabel":"ClassifierDetailedJobOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionDetailedJobOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_fine_tuned_model] - - - - - -CompletionTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters] - - - - - - - - - -#### CompletionTrainingParameters [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_epochs] - - - - - - - - - -##### fim_ratio [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_fim_ratio] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_hyperparameters_completiontrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_job_type] - - - - - -_Default Value:_ `"completion"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - -GithubRepositoryOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### repositories [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories] - - - - - - - - - -#### GithubRepositoryOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout] - - - - - - - - - -##### commit_id [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_commit_id] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_name] - - - - - - - - - -##### owner [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_owner] - - - - - - - - - -##### ref [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_ref] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_type] - - - - - -_Default Value:_ `"github"` - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_repositories_githubrepositoryout_weight] - - - - - -_Default Value:_ `1` - - - - - - - - - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_completiondetailedjobout_validation_files] - - - - - - - - - - - - - -#### ClassifierDetailedJobOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout] - - - - - - - - - -##### auto_start [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_auto_start] - - - - - -CheckpointOut","children":[{"label":"CheckpointOut","linkedLabel":"CheckpointOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### checkpoints [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints] - - - - - - - - - -#### CheckpointOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_created_at] - - - - - -The UNIX timestamp (in seconds) for when the checkpoint was created. - - - - - -_Example:_ - -``` -1716963433 -``` - - - - - -MetricOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metrics [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -#### MetricOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout] - - - - - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - - - - - - - - - -##### train_loss [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_train_loss] - - - - - - - - - -##### valid_loss [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_loss] - - - - - - - - - -##### valid_mean_token_accuracy [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_metrics_metricout_valid_mean_token_accuracy] - - - - - - - - - - - - - - - - - -##### step_number [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_checkpoints_checkpointout_step_number] - - - - - -The step number that the checkpoint was created at. - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets] - - - - - - - - - -#### ClassifierTargetOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout] - - - - - - - - - -##### labels [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_labels] - - - - - - - - - -##### loss_function [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_loss_function] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_name] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_classifier_targets_classifiertargetout_weight] - - - - - - - - - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_created_at] - - - - - -EventOut","children":[{"label":"EventOut","linkedLabel":"EventOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### events [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events] - - - - - -Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - - - - - - - - - -#### EventOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout] - - - - - - - - - -##### created_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_created_at] - - - - - -The UNIX timestamp (in seconds) of the event. - - - - - - - - - -##### data [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_data] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_events_eventout_name] - - - - - -The name of the event. - - - - - - - - - - - - - - - - - -##### fine_tuned_model [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_fine_tuned_model] - - - - - -ClassifierTrainingParameters","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### hyperparameters [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters] - - - - - - - - - -#### ClassifierTrainingParameters [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters] - - - - - - - - - -##### epochs [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_epochs] - - - - - - - - - -##### learning_rate [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_learning_rate] - - - - - -_Default Value:_ `0.0001` - - - - - - - - - -##### seq_len [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_seq_len] - - - - - - - - - -##### training_steps [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_training_steps] - - - - - - - - - -##### warmup_fraction [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_warmup_fraction] - - - - - - - - - -##### weight_decay [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_hyperparameters_classifiertrainingparameters_weight_decay] - - - - - - - - - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_id] - - - - - -WandbIntegrationOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### integrations [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations] - - - - - - - - - -#### WandbIntegrationOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_name] - - - - - -A display name to set for the run. If not set, will use the job ID as the name. - - - - - - - - - -##### project [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_project] - - - - - -The name of the project that the new run will be created under. - - - - - - - - - -##### run_name [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_run_name] - - - - - - - - - -##### type [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_type] - - - - - -_Default Value:_ `"wandb"` - - - - - - - - - -##### url [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_integrations_wandbintegrationout_url] - - - - - - - - - - - - - - - - - -##### job_type [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_job_type] - - - - - -_Default Value:_ `"classifier"` - - - - - -JobMetadataOut","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### metadata [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata] - - - - - - - - - -#### JobMetadataOut [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout] - - - - - - - - - -##### cost [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost] - - - - - - - - - -##### cost_currency [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_cost_currency] - - - - - - - - - -##### data_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_data_tokens] - - - - - - - - - -##### estimated_start_time [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_estimated_start_time] - - - - - - - - - -##### expected_duration_seconds [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_expected_duration_seconds] - - - - - - - - - -##### train_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens] - - - - - - - - - -##### train_tokens_per_step [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_metadata_jobmetadataout_train_tokens_per_step] - - - - - - - - - - - - - - - - - -##### model [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_model] - - - - - -The name of the model to fine-tune. - - - - - - - - - -##### modified_at [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_modified_at] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_object] - - - - - -_Default Value:_ `"job"` - - - - - - - - - -##### status [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_status] - - - - - - - - - -##### suffix [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_suffix] - - - - - - - - - -##### trained_tokens [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_trained_tokens] - - - - - - - - - -##### training_files [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_training_files] - - - - - - - - - -##### validation_files [#operation-jobs_api_routes_fine_tuning_start_fine_tuning_job_responses_200_application-json_classifierdetailedjobout_validation_files] - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/models/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/models/page.mdx deleted file mode 100644 index 3154df7e8..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/models/page.mdx +++ /dev/null @@ -1,5629 +0,0 @@ ---- -sidebarTitle: Models ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Models Endpoints - - - - - -Model Management API - - - - - - - - - -## GET /v1/models [#operation-list_models_v1_models_get] - - - - - -_List Models_ - - - - - -List all models available to the user. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.list() - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - - - - - -### Responses Examples [#operation-list_models_v1_models_get_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-list_models_v1_models_get_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### data [#operation-list_models_v1_models_get_responses_200_application-json_data] - - - - - - - - - -#### BaseModelCard [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard] - - - - - - - - - -##### aliases [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_aliases] - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities] - - - - - - - - - -#### ModelCapabilities [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities] - - - - - - - - - -##### classification [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_function_calling] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_capabilities_modelcapabilities_vision] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_created] - - - - - - - - - -##### default_model_temperature [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_default_model_temperature] - - - - - - - - - -##### deprecation [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_deprecation] - - - - - - - - - -##### deprecation_replacement_model [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_deprecation_replacement_model] - - - - - - - - - -##### description [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_description] - - - - - - - - - -##### id [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_id] - - - - - - - - - -##### max_context_length [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_name] - - - - - - - - - -##### object [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_owned_by] - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type [#operation-list_models_v1_models_get_responses_200_application-json_data_basemodelcard_type] - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard] - - - - - -Extra fields for fine-tuned models. - - - - - - - - - -##### aliases [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_aliases] - - - - - - - - - -##### archived [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_archived] - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities] - - - - - - - - - -#### ModelCapabilities [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities] - - - - - - - - - -##### classification [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_function_calling] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_capabilities_modelcapabilities_vision] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_created] - - - - - - - - - -##### default_model_temperature [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_default_model_temperature] - - - - - - - - - -##### deprecation [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_deprecation] - - - - - - - - - -##### deprecation_replacement_model [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_deprecation_replacement_model] - - - - - - - - - -##### description [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_description] - - - - - - - - - -##### id [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_id] - - - - - - - - - -##### job [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_job] - - - - - - - - - -##### max_context_length [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_name] - - - - - - - - - -##### object [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_owned_by] - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_root] - - - - - - - - - -##### type [#operation-list_models_v1_models_get_responses_200_application-json_data_ftmodelcard_type] - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - - - -##### object [#operation-list_models_v1_models_get_responses_200_application-json_object] - - - - - -_Default Value:_ `"list"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-list_models_v1_models_get_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-list_models_v1_models_get_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-list_models_v1_models_get_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-list_models_v1_models_get_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - - - - - - - -## GET /v1/models/\{model\_id\} [#operation-retrieve_model_v1_models_model_id_get] - - - - - -_Retrieve Model_ - - - - - -Retrieve information about a model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.retrieve(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-retrieve_model_v1_models_model_id_get_parameters] - - - - - - - - - - - -##### model_id [#operation-retrieve_model_v1_models_model_id_get_parameters_model_id] - - - - - -The ID of the model to retrieve. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-retrieve_model_v1_models_model_id_get_responses-examples] - - - - - -200 - - - - - -```json -{ - "capabilities": {}, - "id": "ipsum eiusmod" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-retrieve_model_v1_models_model_id_get_responses] - - - - - -200 - - - - - - - -BaseModelCard","children":[],"breakoutSubTypes":{}},{"label":"FTModelCard","linkedLabel":"FTModelCard","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -Successful Response - - - - - - - - - -#### BaseModelCard [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard] - - - - - - - - - -##### aliases [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_aliases] - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities] - - - - - - - - - -#### ModelCapabilities [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities] - - - - - - - - - -##### classification [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_function_calling] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_capabilities_modelcapabilities_vision] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_created] - - - - - - - - - -##### default_model_temperature [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_default_model_temperature] - - - - - - - - - -##### deprecation [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_deprecation] - - - - - - - - - -##### deprecation_replacement_model [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_deprecation_replacement_model] - - - - - - - - - -##### description [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_description] - - - - - - - - - -##### id [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_id] - - - - - - - - - -##### max_context_length [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_name] - - - - - - - - - -##### object [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_owned_by] - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### type [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_basemodelcard_type] - - - - - -_Default Value:_ `"base"` - - - - - - - - - - - - - -#### FTModelCard [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard] - - - - - -Extra fields for fine-tuned models. - - - - - - - - - -##### aliases [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_aliases] - - - - - - - - - -##### archived [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_archived] - - - - - -_Default Value:_ `false` - - - - - -ModelCapabilities","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities] - - - - - - - - - -#### ModelCapabilities [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities] - - - - - - - - - -##### classification [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_function_calling] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### vision [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_capabilities_modelcapabilities_vision] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_created] - - - - - - - - - -##### default_model_temperature [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_default_model_temperature] - - - - - - - - - -##### deprecation [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_deprecation] - - - - - - - - - -##### deprecation_replacement_model [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_deprecation_replacement_model] - - - - - - - - - -##### description [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_description] - - - - - - - - - -##### id [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_id] - - - - - - - - - -##### job [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_job] - - - - - - - - - -##### max_context_length [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### name [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_name] - - - - - - - - - -##### object [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_owned_by] - - - - - -_Default Value:_ `"mistralai"` - - - - - - - - - -##### root [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_root] - - - - - - - - - -##### type [#operation-retrieve_model_v1_models_model_id_get_responses_200_application-json_ftmodelcard_type] - - - - - -_Default Value:_ `"fine-tuned"` - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-retrieve_model_v1_models_model_id_get_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/models/\{model\_id\} [#operation-delete_model_v1_models_model_id_delete] - - - - - -_Delete Model_ - - - - - -Delete a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.delete(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-delete_model_v1_models_model_id_delete_parameters] - - - - - - - - - - - -##### model_id [#operation-delete_model_v1_models_model_id_delete_parameters_model_id] - - - - - -The ID of the model to delete. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-delete_model_v1_models_model_id_delete_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "ft:open-mistral-7b:587a6b29:20240514:7e773925" -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-delete_model_v1_models_model_id_delete_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### deleted [#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_deleted] - - - - - -The deletion status - - - - - -_Example:_ - -``` -true -``` - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id [#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_id] - - - - - -The ID of the deleted model. - - - - - -_Example:_ - -``` -ft:open-mistral-7b:587a6b29:20240514:7e773925 -``` - - - - - - - - - -##### object [#operation-delete_model_v1_models_model_id_delete_responses_200_application-json_object] - - - - - -The object type that was deleted - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-delete_model_v1_models_model_id_delete_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## PATCH /v1/fine\_tuning/models/\{model\_id\} [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model] - - - - - -_Update Fine Tuned Model_ - - - - - -Update a model name or description. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.update(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters] - - - - - - - - - - - -##### model_id [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_parameters_model_id] - - - - - -The ID of the model to update. - - - - - - - - - -
    - -     - - - -
    - - - -### Request Example [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request-examples] - - - - - -```json -{} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request] - - - - - - - - - - - -##### description [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_description] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_request_name] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses-examples] - - - - - -200 - - - - - -```json -{ - "archived": false, - "capabilities": {}, - "created": 87, - "id": "ipsum eiusmod", - "job": "consequat do", - "owned_by": "reprehenderit ut dolore", - "root": "occaecat dolor sit", - "root_version": "nostrud", - "workspace_id": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses] - - - - - -200 - - - - - - - -CompletionFTModelOut","children":[],"breakoutSubTypes":{}},{"label":"ClassifierFTModelOut","linkedLabel":"ClassifierFTModelOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - -OK - - - - - - - - - -#### CompletionFTModelOut [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout] - - - - - - - - - -##### aliases [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_aliases] - - - - - - - - - -##### archived [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_archived] - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities] - - - - - - - - - -#### FTModelCapabilitiesOut [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout] - - - - - - - - - -##### classification [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_capabilities_ftmodelcapabilitiesout_function_calling] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### created [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_created] - - - - - - - - - -##### description [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_description] - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_id] - - - - - - - - - -##### job [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_job] - - - - - - - - - -##### max_context_length [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_model_type] - - - - - -_Default Value:_ `"completion"` - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_name] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_owned_by] - - - - - - - - - -##### root [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_root] - - - - - - - - - -##### root_version [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_root_version] - - - - - - - - - -##### workspace_id [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_completionftmodelout_workspace_id] - - - - - - - - - - - - - -#### ClassifierFTModelOut [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout] - - - - - - - - - -##### aliases [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_aliases] - - - - - - - - - -##### archived [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_archived] - - - - - -FTModelCapabilitiesOut","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### capabilities [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities] - - - - - - - - - -#### FTModelCapabilitiesOut [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout] - - - - - - - - - -##### classification [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_classification] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### completion_chat [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_completion_chat] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### completion_fim [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_completion_fim] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### fine_tuning [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_fine_tuning] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### function_calling [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_capabilities_ftmodelcapabilitiesout_function_calling] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - -ClassifierTargetOut","children":[{"label":"ClassifierTargetOut","linkedLabel":"ClassifierTargetOut","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### classifier_targets [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets] - - - - - - - - - -#### ClassifierTargetOut [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout] - - - - - - - - - -##### labels [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_labels] - - - - - - - - - -##### loss_function [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_loss_function] - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_name] - - - - - - - - - -##### weight [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_classifier_targets_classifiertargetout_weight] - - - - - - - - - - - - - - - - - -##### created [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_created] - - - - - - - - - -##### description [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_description] - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_id] - - - - - - - - - -##### job [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_job] - - - - - - - - - -##### max_context_length [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_max_context_length] - - - - - -_Default Value:_ `32768` - - - - - - - - - -##### model_type [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_model_type] - - - - - -_Default Value:_ `"classifier"` - - - - - - - - - -##### name [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_name] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - -##### owned_by [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_owned_by] - - - - - - - - - -##### root [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_root] - - - - - - - - - -##### root_version [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_root_version] - - - - - - - - - -##### workspace_id [#operation-jobs_api_routes_fine_tuning_update_fine_tuned_model_responses_200_application-json_classifierftmodelout_workspace_id] - - - - - - - - - - - - - - - - - -     - - - - - -## POST /v1/fine\_tuning/models/\{model\_id\}/archive [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model] - - - - - -_Archive Fine Tuned Model_ - - - - - -Archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.archive(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters] - - - - - - - - - - - -##### model_id [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_parameters_model_id] - - - - - -The ID of the model to archive. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_archived] - - - - - -_Default Value:_ `true` - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_id] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_archive_fine_tuned_model_responses_200_application-json_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - -     - - - - - -## DELETE /v1/fine\_tuning/models/\{model\_id\}/archive [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model] - - - - - -_Unarchive Fine Tuned Model_ - - - - - -Un-archive a fine-tuned model. - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.models.unarchive(model_id="ft:open-mistral-7b:587a6b29:20240514:7e773925") - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Parameters [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters] - - - - - - - - - - - -##### model_id [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_parameters_model_id] - - - - - -The ID of the model to unarchive. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": "ipsum eiusmod" -} -``` - - - - - - - - - - - - - -### Responses [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses] - - - - - -200 - - - - - - - -OK - - - - - - - - - -##### archived [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_archived] - - - - - -_Default Value:_ `false` - - - - - - - - - -##### id [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_id] - - - - - - - - - -##### object [#operation-jobs_api_routes_fine_tuning_unarchive_fine_tuned_model_responses_200_application-json_object] - - - - - -_Default Value:_ `"model"` - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/endpoint/ocr/page.mdx b/examples/nextra/src/app/mistral/api/endpoint/ocr/page.mdx deleted file mode 100644 index 5d077671b..000000000 --- a/examples/nextra/src/app/mistral/api/endpoint/ocr/page.mdx +++ /dev/null @@ -1,1981 +0,0 @@ ---- -sidebarTitle: Ocr ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutDescription, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDefaultValue, - ExpandablePropertyDescription, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationRequestBodyExamplesSection, - OperationRequestBodySection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle, - TryItNow -} from "@speakeasy-api/docs-md-react"; - - - - - -# Ocr Endpoints - - - - - -OCR API - - - - - - - - - -## POST /v1/ocr [#operation-ocr_v1_ocr_post] - - - - - -OCR - - - - - - - - - -TypeScript - - - - - - - - - - - -Python - - - - - - - -```python -from mistralai import Mistral -import os - - -with Mistral( - api_key=os.getenv("MISTRAL_API_KEY", ""), -) as mistral: - - res = mistral.ocr.process(model="CX-9", document={ - "image_url": { - "url": "https://measly-scrap.com", - }, - "type": "image_url", - }) - - # Handle response - print(res) - - -``` - - - - - - - -cURL - - - - - - - - - - - - - - - -
    - - - -### Request Example [#operation-ocr_v1_ocr_post_request-examples] - - - - - -```json -{ - "document": { - "file_id": "ipsum eiusmod" - }, - "model": null -} -``` - - - -
    - -     - - - -
    - - - -### Request Body [#operation-ocr_v1_ocr_post_request] - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### bbox_annotation_format [#operation-ocr_v1_ocr_post_request_bbox_annotation_format] - - - - - - - - - -#### ResponseFormat [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_request_bbox_annotation_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - -FileChunk","children":[],"breakoutSubTypes":{}},{"label":"DocumentURLChunk","linkedLabel":"DocumentURLChunk","children":[],"breakoutSubTypes":{}},{"label":"ImageURLChunk","linkedLabel":"ImageURLChunk","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document [#operation-ocr_v1_ocr_post_request_document] - - - - - -Document to run OCR on - - - - - - - - - -#### FileChunk [#operation-ocr_v1_ocr_post_request_document_filechunk] - - - - - - - - - -##### file_id [#operation-ocr_v1_ocr_post_request_document_filechunk_file_id] - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_request_document_filechunk_type] - - - - - -_Default Value:_ `"file"` - - - - - - - - - - - - - -#### DocumentURLChunk [#operation-ocr_v1_ocr_post_request_document_documenturlchunk] - - - - - - - - - -##### document_name [#operation-ocr_v1_ocr_post_request_document_documenturlchunk_document_name] - - - - - -The filename of the document - - - - - - - - - -##### document_url [#operation-ocr_v1_ocr_post_request_document_documenturlchunk_document_url] - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_request_document_documenturlchunk_type] - - - - - -_Default Value:_ `"document_url"` - - - - - - - - - - - - - -#### ImageURLChunk [#operation-ocr_v1_ocr_post_request_document_imageurlchunk] - - - - - -\{"type":"image_url","image_url":\{"url":"data:image/png;base64,iVBORw0 - - - - - -ImageURL","children":[],"breakoutSubTypes":{}},{"label":"string","linkedLabel":"string","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### image_url [#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url] - - - - - - - - - -#### ImageURL [#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl] - - - - - - - - - -##### detail [#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl_detail] - - - - - - - - - -##### url [#operation-ocr_v1_ocr_post_request_document_imageurlchunk_image_url_imageurl_url] - - - - - - - - - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_request_document_imageurlchunk_type] - - - - - -_Default Value:_ `"image_url"` - - - - - - - - - - - - - -ResponseFormat","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### document_annotation_format [#operation-ocr_v1_ocr_post_request_document_annotation_format] - - - - - - - - - -#### ResponseFormat [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat] - - - - - -JsonSchema","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### json_schema [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema] - - - - - - - - - -#### JsonSchema [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema] - - - - - - - - - -##### description [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_description] - - - - - - - - - -##### name [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_name] - - - - - - - - - -##### schema_definition [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_schema_definition] - - - - - - - - - -##### strict [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_json_schema_jsonschema_strict] - - - - - -_Default Value:_ `false` - - - - - - - - - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_request_document_annotation_format_responseformat_type] - - - - - -An object specifying the format that the model must output. Setting to `\{ "type": "json_object" \}` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - - - - - - - - - - - - - - - - - -##### id [#operation-ocr_v1_ocr_post_request_id] - - - - - - - - - -##### image_limit [#operation-ocr_v1_ocr_post_request_image_limit] - - - - - -Max images to extract - - - - - - - - - -##### image_min_size [#operation-ocr_v1_ocr_post_request_image_min_size] - - - - - -Minimum height and width of image to extract - - - - - - - - - -##### include_image_base64 [#operation-ocr_v1_ocr_post_request_include_image_base64] - - - - - -Include image URLs in response - - - - - - - - - -##### model [#operation-ocr_v1_ocr_post_request_model] - - - - - - - - - -##### pages [#operation-ocr_v1_ocr_post_request_pages] - - - - - -Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-ocr_v1_ocr_post_responses-examples] - - - - - -200 - - - - - -```json -{ - "model": "ipsum eiusmod", - "pages": [ - { - "dimensions": null, - "images": [ - { - "bottom_right_x": null, - "bottom_right_y": null, - "id": "consequat do", - "top_left_x": null, - "top_left_y": null - } - ], - "index": 87, - "markdown": "reprehenderit ut dolore" - } - ], - "usage_info": { - "pages_processed": 14 - } -} -``` - - - - - -422 - - - - - -```json -{ - "HttpMeta": { - "Request": null, - "Response": null - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-ocr_v1_ocr_post_responses] - - - - - -200 - - - - - - - -Successful Response - - - - - - - - - -##### document_annotation [#operation-ocr_v1_ocr_post_responses_200_application-json_document_annotation] - - - - - -Formatted response in the request_format if provided in json str - - - - - - - - - -##### model [#operation-ocr_v1_ocr_post_responses_200_application-json_model] - - - - - -The model used to generate the OCR. - - - - - -OCRPageObject","children":[{"label":"OCRPageObject","linkedLabel":"OCRPageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pages [#operation-ocr_v1_ocr_post_responses_200_application-json_pages] - - - - - -List of OCR info for pages. - - - - - - - - - -#### OCRPageObject [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject] - - - - - -OCRPageDimensions","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### dimensions [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions] - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - - - -#### OCRPageDimensions [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions] - - - - - -The dimensions of the PDF Page's screenshot image - - - - - - - - - -##### dpi [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_dpi] - - - - - -Dots per inch of the page-image - - - - - - - - - -##### height [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_height] - - - - - -Height of the image in pixels - - - - - - - - - -##### width [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_dimensions_ocrpagedimensions_width] - - - - - -Width of the image in pixels - - - - - - - - - - - - - -OCRImageObject","children":[{"label":"OCRImageObject","linkedLabel":"OCRImageObject","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### images [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images] - - - - - -List of all extracted images in the page - - - - - - - - - -#### OCRImageObject [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject] - - - - - - - - - -##### bottom_right_x [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_bottom_right_x] - - - - - -X coordinate of bottom-right corner of the extracted image - - - - - - - - - -##### bottom_right_y [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_bottom_right_y] - - - - - -Y coordinate of bottom-right corner of the extracted image - - - - - - - - - -##### id [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_id] - - - - - -Image ID for extracted image in a page - - - - - - - - - -##### image_annotation [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_image_annotation] - - - - - -Annotation of the extracted image in json str - - - - - - - - - -##### image_base64 [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_image_base64] - - - - - -Base64 string of the extracted image - - - - - - - - - -##### top_left_x [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_top_left_x] - - - - - -X coordinate of top-left corner of the extracted image - - - - - - - - - -##### top_left_y [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_images_ocrimageobject_top_left_y] - - - - - -Y coordinate of top-left corner of the extracted image - - - - - - - - - - - - - - - - - -##### index [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_index] - - - - - -The page index in a pdf document starting from 0 - - - - - - - - - -##### markdown [#operation-ocr_v1_ocr_post_responses_200_application-json_pages_ocrpageobject_markdown] - - - - - -The markdown string response of the page - - - - - - - - - - - - - -OCRUsageInfo","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### usage_info [#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info] - - - - - - - - - -#### OCRUsageInfo [#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo] - - - - - - - - - -##### doc_size_bytes [#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo_doc_size_bytes] - - - - - -Document size in bytes - - - - - - - - - -##### pages_processed [#operation-ocr_v1_ocr_post_responses_200_application-json_usage_info_ocrusageinfo_pages_processed] - - - - - -Number of pages processed - - - - - - - - - - - - - - - - - - - -422 - - - - - - - -Validation Error - - - - - -HTTPMetadata","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### HttpMeta [#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta] - - - - - - - - - -#### HTTPMetadata [#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata] - - - - - - - - - -##### Request [#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata_request] - - - - - -Raw HTTP request; suitable for debugging - - - - - - - - - -##### Response [#operation-ocr_v1_ocr_post_responses_422_application-json_httpmeta_httpmetadata_response] - - - - - -Raw HTTP response; suitable for custom response parsing - - - - - - - - - - - - - -ValidationError","children":[{"label":"ValidationError","linkedLabel":"ValidationError","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### detail [#operation-ocr_v1_ocr_post_responses_422_application-json_detail] - - - - - - - - - -#### ValidationError [#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror] - - - - - - - - - -##### loc [#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_loc] - - - - - - - - - -##### msg [#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_msg] - - - - - - - - - -##### type [#operation-ocr_v1_ocr_post_responses_422_application-json_detail_validationerror_type] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/api/page.mdx b/examples/nextra/src/app/mistral/api/page.mdx deleted file mode 100644 index 5f2f87e35..000000000 --- a/examples/nextra/src/app/mistral/api/page.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebarTitle: About ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - Pill -} from "@speakeasy-api/docs-md-react"; - -# About Mistral AI API - -_Version: 1.0.0_ - -Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -Servers - -- https://api.mistral.ai - -## Global Security - -### ApiKey bearer http [#ApiKey] \ No newline at end of file diff --git a/examples/nextra/src/app/mistral/page.mdx b/examples/nextra/src/app/mistral/page.mdx deleted file mode 100644 index fbbddcf3c..000000000 --- a/examples/nextra/src/app/mistral/page.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Home ---- - -# Speakeasy Docs Demo - -Welcome to the Speakeasy Docs Demo! This is a simple demo demonstrating a build of Speakeasy's API docs using Nextra. diff --git a/examples/nextra/src/app/page.mdx b/examples/nextra/src/app/page.mdx deleted file mode 100644 index 49b8f1514..000000000 --- a/examples/nextra/src/app/page.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Home ---- - -# Speakeasy Docs Demo - -Welcome to the Speakeasy Docs Demo! This is a simple demo demonstrating a build of Speakeasy's API docs using Nextra. - -Please visit the: -* [PokeAPI docs](./pokeapi/api) -* [Mistral API docs](./mistral/api) \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/_meta.ts b/examples/nextra/src/app/pokeapi/api/_meta.ts deleted file mode 100644 index 7a9470c09..000000000 --- a/examples/nextra/src/app/pokeapi/api/_meta.ts +++ /dev/null @@ -1,4 +0,0 @@ -export default { - index: { title: "About", theme: { collapsed: false } }, - endpoint: { title: "Operations", theme: { collapsed: false } } - } \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/berries/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/berries/page.mdx deleted file mode 100644 index 5b38a293a..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/berries/page.mdx +++ /dev/null @@ -1,3165 +0,0 @@ ---- -sidebarTitle: Berries ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Berries Endpoints - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -## GET /api/v2/berry/ [#operation-api_v2_berry_list] - - - - - -_List berries_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_berry_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_berry_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_berry_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_berry_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_berry_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_berry_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_berry_list_responses_200_application-json_results] - - - - - - - - - -#### BerrySummary [#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary] - - - - - - - - - -##### name [#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_list_responses_200_application-json_results_berrysummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry/\{id\}/ [#operation-api_v2_berry_retrieve] - - - - - -_Get a berry_ - - - - - -Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokémon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_berry_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "firmness": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "flavors": [ - { - "flavor": {}, - "potency": "10" - } - ], - "growth_time": 14, - "id": 56, - "item": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "max_harvest": 91, - "name": "nostrud", - "natural_gift_power": 32, - "natural_gift_type": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "size": 78, - "smoothness": 5, - "soil_dryness": 69 -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_retrieve_responses] - - - - - -200 - - - - - - - -BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### firmness [#operation-api_v2_berry_retrieve_responses_200_application-json_firmness] - - - - - - - - - -#### BerryFirmnessSummary [#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary] - - - - - - - - - -##### name [#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_retrieve_responses_200_application-json_firmness_berryfirmnesssummary_url] - - - - - - - - - - - - - -flavor","children":[{"label":"flavor","linkedLabel":"flavor","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavors [#operation-api_v2_berry_retrieve_responses_200_application-json_flavors] - - - - - - - - - -#### flavor [#operation-api_v2_berry_retrieve_responses_200_application-json_flavors_flavor] - - - - - - - - - -##### potency [#operation-api_v2_berry_retrieve_responses_200_application-json_flavors_flavor_potency] - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### growth_time [#operation-api_v2_berry_retrieve_responses_200_application-json_growth_time] - - - - - - - - - -##### id [#operation-api_v2_berry_retrieve_responses_200_application-json_id] - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item [#operation-api_v2_berry_retrieve_responses_200_application-json_item] - - - - - - - - - -#### ItemSummary [#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_retrieve_responses_200_application-json_item_itemsummary_url] - - - - - - - - - - - - - - - - - -##### max_harvest [#operation-api_v2_berry_retrieve_responses_200_application-json_max_harvest] - - - - - - - - - -##### name [#operation-api_v2_berry_retrieve_responses_200_application-json_name] - - - - - - - - - -##### natural_gift_power [#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_power] - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### natural_gift_type [#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type] - - - - - - - - - -#### TypeSummary [#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary] - - - - - - - - - -##### name [#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_retrieve_responses_200_application-json_natural_gift_type_typesummary_url] - - - - - - - - - - - - - - - - - -##### size [#operation-api_v2_berry_retrieve_responses_200_application-json_size] - - - - - - - - - -##### smoothness [#operation-api_v2_berry_retrieve_responses_200_application-json_smoothness] - - - - - - - - - -##### soil_dryness [#operation-api_v2_berry_retrieve_responses_200_application-json_soil_dryness] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-firmness/ [#operation-api_v2_berry_firmness_list] - - - - - -_List berry firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-firmness/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_firmness_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_firmness_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_firmness_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_firmness_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_berry_firmness_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_berry_firmness_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_berry_firmness_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_firmness_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_firmness_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_berry_firmness_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_berry_firmness_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_berry_firmness_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFirmnessSummary","children":[{"label":"BerryFirmnessSummary","linkedLabel":"BerryFirmnessSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_berry_firmness_list_responses_200_application-json_results] - - - - - - - - - -#### BerryFirmnessSummary [#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary] - - - - - - - - - -##### name [#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_firmness_list_responses_200_application-json_results_berryfirmnesssummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-firmness/\{id\}/ [#operation-api_v2_berry_firmness_retrieve] - - - - - -_Get berry by firmness_ - - - - - -Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-firmness/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_firmness_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_firmness_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_firmness_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_firmness_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_berry_firmness_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_firmness_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_firmness_retrieve_responses] - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries] - - - - - - - - - -#### BerrySummary [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary] - - - - - - - - - -##### name [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_berries_berrysummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_name] - - - - - -BerryFirmnessName","children":[{"label":"BerryFirmnessName","linkedLabel":"BerryFirmnessName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names] - - - - - - - - - -#### BerryFirmnessName [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_berry_firmness_retrieve_responses_200_application-json_names_berryfirmnessname_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-flavor/ [#operation-api_v2_berry_flavor_list] - - - - - -_List berry flavors_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-flavor/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_flavor_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_flavor_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_flavor_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_flavor_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_berry_flavor_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_berry_flavor_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_berry_flavor_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_flavor_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_flavor_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_berry_flavor_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_berry_flavor_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_berry_flavor_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -BerryFlavorSummary","children":[{"label":"BerryFlavorSummary","linkedLabel":"BerryFlavorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_berry_flavor_list_responses_200_application-json_results] - - - - - - - - - -#### BerryFlavorSummary [#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary] - - - - - - - - - -##### name [#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_flavor_list_responses_200_application-json_results_berryflavorsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/berry-flavor/\{id\}/ [#operation-api_v2_berry_flavor_retrieve] - - - - - -_Get berries by flavor_ - - - - - -Flavors determine whether a Pokémon will benefit or suffer from eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/berry-flavor/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_berry_flavor_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_berry_flavor_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_berry_flavor_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_berry_flavor_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_berry_flavor_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_berry_flavor_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "berry": {}, - "potency": "10" - } - ], - "contest_type": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 14, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_berry_flavor_retrieve_responses] - - - - - -200 - - - - - - - -berry","children":[{"label":"berry","linkedLabel":"berry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries] - - - - - - - - - -#### berry [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries_berry] - - - - - - - - - -##### potency [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_berries_berry_potency] - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type] - - - - - - - - - -#### ContestTypeSummary [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary] - - - - - - - - - -##### name [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_contest_type_contesttypesummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_name] - - - - - -BerryFlavorName","children":[{"label":"BerryFlavorName","linkedLabel":"BerryFlavorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names] - - - - - - - - - -#### BerryFlavorName [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_berry_flavor_retrieve_responses_200_application-json_names_berryflavorname_name] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/contests/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/contests/page.mdx deleted file mode 100644 index 3b0b42d5e..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/contests/page.mdx +++ /dev/null @@ -1,2890 +0,0 @@ ---- -sidebarTitle: Contests ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Contests Endpoints - - - - - - - - - -## GET /api/v2/contest-type/ [#operation-api_v2_contest_type_list] - - - - - -_List contest types_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-type/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_contest_type_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_contest_type_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_contest_type_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_contest_type_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_contest_type_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_contest_type_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_contest_type_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_contest_type_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_contest_type_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_contest_type_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_contest_type_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_contest_type_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestTypeSummary","children":[{"label":"ContestTypeSummary","linkedLabel":"ContestTypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_contest_type_list_responses_200_application-json_results] - - - - - - - - - -#### ContestTypeSummary [#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary] - - - - - - - - - -##### name [#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary_name] - - - - - - - - - -##### url [#operation-api_v2_contest_type_list_responses_200_application-json_results_contesttypesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-type/\{id\}/ [#operation-api_v2_contest_type_retrieve] - - - - - -_Get contest type_ - - - - - -Contest types are categories judges used to weigh a Pokémon's condition in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-type/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_contest_type_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_contest_type_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_contest_type_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_contest_type_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_contest_type_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_contest_type_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "berry_flavor": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "color": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_contest_type_retrieve_responses] - - - - - -200 - - - - - - - -berry_flavor","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berry_flavor [#operation-api_v2_contest_type_retrieve_responses_200_application-json_berry_flavor] - - - - - - - - - - - - - -##### id [#operation-api_v2_contest_type_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_contest_type_retrieve_responses_200_application-json_name] - - - - - -ContestTypeName","children":[{"label":"ContestTypeName","linkedLabel":"ContestTypeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names] - - - - - - - - - -#### ContestTypeName [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename] - - - - - - - - - -##### color [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_color] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_contest_type_retrieve_responses_200_application-json_names_contesttypename_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-effect/ [#operation-api_v2_contest_effect_list] - - - - - -_List contest effects_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-effect/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_contest_effect_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_contest_effect_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_contest_effect_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_contest_effect_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_contest_effect_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_contest_effect_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_contest_effect_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_contest_effect_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_contest_effect_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_contest_effect_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_contest_effect_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_contest_effect_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ContestEffectSummary","children":[{"label":"ContestEffectSummary","linkedLabel":"ContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_contest_effect_list_responses_200_application-json_results] - - - - - - - - - -#### ContestEffectSummary [#operation-api_v2_contest_effect_list_responses_200_application-json_results_contesteffectsummary] - - - - - - - - - -##### url [#operation-api_v2_contest_effect_list_responses_200_application-json_results_contesteffectsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/contest-effect/\{id\}/ [#operation-api_v2_contest_effect_retrieve] - - - - - -_Get contest effect_ - - - - - -Contest effects refer to the effects of moves when used in contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/contest-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_contest_effect_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_contest_effect_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_contest_effect_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_contest_effect_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_contest_effect_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_contest_effect_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "flavor_text_entries": [ - { - "flavor_text": "occaecat dolor sit", - "language": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - } - ], - "id": 14, - "jam": 56 -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_contest_effect_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### appeal [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_appeal] - - - - - -ContestEffectEffectText","children":[{"label":"ContestEffectEffectText","linkedLabel":"ContestEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries] - - - - - - - - - -#### ContestEffectEffectText [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext] - - - - - - - - - -##### effect [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_effect] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_effect_entries_contesteffecteffecttext_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - -ContestEffectFlavorText","children":[{"label":"ContestEffectFlavorText","linkedLabel":"ContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### ContestEffectFlavorText [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext] - - - - - - - - - -##### flavor_text [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_flavor_text] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_contesteffectflavortext_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_id] - - - - - - - - - -##### jam [#operation-api_v2_contest_effect_retrieve_responses_200_application-json_jam] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/super-contest-effect/ [#operation-api_v2_super_contest_effect_list] - - - - - -_List super contest effects_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/super-contest-effect/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_super_contest_effect_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_super_contest_effect_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_super_contest_effect_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_super_contest_effect_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_super_contest_effect_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_super_contest_effect_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_super_contest_effect_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_super_contest_effect_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_super_contest_effect_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_super_contest_effect_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_super_contest_effect_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_super_contest_effect_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -SuperContestEffectSummary","children":[{"label":"SuperContestEffectSummary","linkedLabel":"SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_super_contest_effect_list_responses_200_application-json_results] - - - - - - - - - -#### SuperContestEffectSummary [#operation-api_v2_super_contest_effect_list_responses_200_application-json_results_supercontesteffectsummary] - - - - - - - - - -##### url [#operation-api_v2_super_contest_effect_list_responses_200_application-json_results_supercontesteffectsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/super-contest-effect/\{id\}/ [#operation-api_v2_super_contest_effect_retrieve] - - - - - -_Get super contest effect_ - - - - - -Super contest effects refer to the effects of moves when used in super contests. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/super-contest-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_super_contest_effect_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_super_contest_effect_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_super_contest_effect_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_super_contest_effect_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_super_contest_effect_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_super_contest_effect_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "appeal": 87, - "flavor_text_entries": [ - { - "flavor_text": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 14, - "moves": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_super_contest_effect_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### appeal [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_appeal] - - - - - -SuperContestEffectFlavorText","children":[{"label":"SuperContestEffectFlavorText","linkedLabel":"SuperContestEffectFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### SuperContestEffectFlavorText [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext] - - - - - - - - - -##### flavor_text [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_flavor_text] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_flavor_text_entries_supercontesteffectflavortext_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_id] - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### MoveSummary [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary] - - - - - - - - - -##### name [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_super_contest_effect_retrieve_responses_200_application-json_moves_movesummary_url] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/encounters/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/encounters/page.mdx deleted file mode 100644 index 43592d86e..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/encounters/page.mdx +++ /dev/null @@ -1,3479 +0,0 @@ ---- -sidebarTitle: Encounters ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - FrontMatterDisplayType, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDisplayTypeSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Encounters Endpoints - - - - - - - - - -## GET /api/v2/encounter-method/ [#operation-api_v2_encounter_method_list] - - - - - -_List encounter methods_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-method/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_method_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_method_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_method_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_method_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_encounter_method_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_encounter_method_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_encounter_method_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_method_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_method_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_encounter_method_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_encounter_method_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_encounter_method_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterMethodSummary","children":[{"label":"EncounterMethodSummary","linkedLabel":"EncounterMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_encounter_method_list_responses_200_application-json_results] - - - - - - - - - -#### EncounterMethodSummary [#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_method_list_responses_200_application-json_results_encountermethodsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-method/\{id\}/ [#operation-api_v2_encounter_method_retrieve] - - - - - -_Get encounter method_ - - - - - -Methods by which the player might can encounter Pokémon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-method/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_method_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_method_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_method_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_method_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_encounter_method_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_method_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_method_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_name] - - - - - -EncounterMethodName","children":[{"label":"EncounterMethodName","linkedLabel":"EncounterMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names] - - - - - - - - - -#### EncounterMethodName [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_names_encountermethodname_name] - - - - - - - - - - - - - - - - - -##### order [#operation-api_v2_encounter_method_retrieve_responses_200_application-json_order] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition/ [#operation-api_v2_encounter_condition_list] - - - - - -_List encounter conditions_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_condition_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_condition_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_condition_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_condition_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_encounter_condition_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_encounter_condition_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_encounter_condition_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_condition_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_condition_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_encounter_condition_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_encounter_condition_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_encounter_condition_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionSummary","children":[{"label":"EncounterConditionSummary","linkedLabel":"EncounterConditionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_encounter_condition_list_responses_200_application-json_results] - - - - - - - - - -#### EncounterConditionSummary [#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_list_responses_200_application-json_results_encounterconditionsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition/\{id\}/ [#operation-api_v2_encounter_condition_retrieve] - - - - - -_Get encounter condition_ - - - - - -Conditions which affect what pokemon might appear in the wild, e.g., day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_condition_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_condition_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_condition_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_condition_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_encounter_condition_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_condition_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "values": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_condition_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_name] - - - - - -EncounterConditionName","children":[{"label":"EncounterConditionName","linkedLabel":"EncounterConditionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names] - - - - - - - - - -#### EncounterConditionName [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_names_encounterconditionname_name] - - - - - - - - - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### values [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values] - - - - - - - - - -#### EncounterConditionValueSummary [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_retrieve_responses_200_application-json_values_encounterconditionvaluesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition-value/ [#operation-api_v2_encounter_condition_value_list] - - - - - -_List encounter condition values_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition-value/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_condition_value_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_condition_value_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_condition_value_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_condition_value_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_encounter_condition_value_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_encounter_condition_value_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_encounter_condition_value_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_condition_value_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_condition_value_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EncounterConditionValueSummary","children":[{"label":"EncounterConditionValueSummary","linkedLabel":"EncounterConditionValueSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results] - - - - - - - - - -#### EncounterConditionValueSummary [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_value_list_responses_200_application-json_results_encounterconditionvaluesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/encounter-condition-value/\{id\}/ [#operation-api_v2_encounter_condition_value_retrieve] - - - - - -_Get encounter condition value_ - - - - - -Encounter condition values are the various states that an encounter condition can have, i.e., time of day can be either day or night. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/encounter-condition-value/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_encounter_condition_value_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_encounter_condition_value_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_encounter_condition_value_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_encounter_condition_value_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_encounter_condition_value_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_encounter_condition_value_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "condition": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_encounter_condition_value_retrieve_responses] - - - - - -200 - - - - - - - -EncounterConditionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### condition [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition] - - - - - - - - - -#### EncounterConditionSummary [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_condition_encounterconditionsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_name] - - - - - -EncounterConditionValueName","children":[{"label":"EncounterConditionValueName","linkedLabel":"EncounterConditionValueName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names] - - - - - - - - - -#### EncounterConditionValueName [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_encounter_condition_value_retrieve_responses_200_application-json_names_encounterconditionvaluename_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/\{pokemon\_id\}/encounters [#operation-api_v2_pokemon_encounters_retrieve] - - - - - -_Get pokemon encounter_ - - - - - -Handles Pokemon Encounters as a sub-resource. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/{pokemon_id}/encounters \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_encounters_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_encounters_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_encounters_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_encounters_retrieve_parameters] - - - - - - - - - - - -##### pokemon_id [#operation-api_v2_pokemon_encounters_retrieve_parameters_pokemon_id] - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_encounters_retrieve_responses-examples] - - - - - -200 - - - - - -```json -[ - { - "location_area": { - "name": "cerulean-city-area", - "url": "https://pokeapi.co/api/v2/location-area/281/" - }, - "version_details": [ - { - "encounter_details": [ - { - "chance": "100", - "condition_values": [ - { - "name": "story-progress-beat-red", - "url": "https://pokeapi.co/api/v2/encounter-condition-value/55/" - } - ], - "max_level": "10", - "method": { - "name": "gift", - "url": "https://pokeapi.co/api/v2/encounter-method/18/" - }, - "min_level": "10" - } - ], - "max_chance": "100", - "version": { - "name": "red", - "url": "https://pokeapi.co/api/v2/version/1/" - } - } - ] - } -] -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_encounters_retrieve_responses] - - - - - -200 - - - - - - - -ResponseBody","children":[{"label":"ResponseBody","linkedLabel":"ResponseBody","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} -/> - - - - - - - - - -#### ResponseBody [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody] - - - - - -location_area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### location_area [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_location_area] - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details] - - - - - - - - - -#### version\_detail [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail] - - - - - -encounter_detail","children":[{"label":"encounter_detail","linkedLabel":"encounter_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details] - - - - - - - - - -#### encounter\_detail [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail] - - - - - - - - - -##### chance [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_chance] - - - - - -_Example:_ - -``` -100 -``` - - - - - -condition_value","children":[{"label":"condition_value","linkedLabel":"condition_value","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### condition_values [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values] - - - - - - - - - -#### condition\_value [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value] - - - - - - - - - -##### name [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value_name] - - - - - -_Example:_ - -``` -story-progress-beat-red -``` - - - - - - - - - -##### url [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_condition_values_condition_value_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/encounter-condition-value/55/ -``` - - - - - - - - - - - - - - - - - -##### max_level [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_max_level] - - - - - -_Example:_ - -``` -10 -``` - - - - - -method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### method [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_method] - - - - - - - - - - - - - -##### min_level [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_encounter_details_encounter_detail_min_level] - - - - - -_Example:_ - -``` -10 -``` - - - - - - - - - - - - - - - - - -##### max_chance [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_max_chance] - - - - - -_Example:_ - -``` -100 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_pokemon_encounters_retrieve_responses_200_application-json_responsebody_version_details_version_detail_version] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/evolution/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/evolution/page.mdx deleted file mode 100644 index a1c183771..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/evolution/page.mdx +++ /dev/null @@ -1,1838 +0,0 @@ ---- -sidebarTitle: Evolution ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Evolution Endpoints - - - - - -Evolution is a process in which a Pokémon changes into a different species of Pokémon. - - - - - - - - - -## GET /api/v2/evolution-chain/ [#operation-api_v2_evolution_chain_list] - - - - - -_List evolution chains_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-chain/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_evolution_chain_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_evolution_chain_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_evolution_chain_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_evolution_chain_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_evolution_chain_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_evolution_chain_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_evolution_chain_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_evolution_chain_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_evolution_chain_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_evolution_chain_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_evolution_chain_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_evolution_chain_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionChainSummary","children":[{"label":"EvolutionChainSummary","linkedLabel":"EvolutionChainSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_evolution_chain_list_responses_200_application-json_results] - - - - - - - - - -#### EvolutionChainSummary [#operation-api_v2_evolution_chain_list_responses_200_application-json_results_evolutionchainsummary] - - - - - - - - - -##### url [#operation-api_v2_evolution_chain_list_responses_200_application-json_results_evolutionchainsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-chain/\{id\}/ [#operation-api_v2_evolution_chain_retrieve] - - - - - -_Get evolution chain_ - - - - - -Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-chain/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_evolution_chain_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_evolution_chain_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_evolution_chain_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_evolution_chain_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_evolution_chain_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_evolution_chain_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "baby_trigger_item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "chain": { - "evolution_details": [ - null - ], - "evolves_to": [ - { - "evolution_details": [ - { - "gender": null, - "held_item": null, - "item": null, - "known_move": null, - "known_move_type": null, - "location": null, - "min_affection": null, - "min_beauty": null, - "min_happiness": null, - "min_level": null, - "needs_overworld_rain": null, - "party_species": null, - "party_type": null, - "relative_physical_stats": null, - "time_of_day": "reprehenderit ut dolore", - "trade_species": null, - "trigger": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "turn_upside_down": false - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - } - ], - "is_baby": false, - "species": { - "name": "happiny", - "url": "https://pokeapi.co/api/v2/pokemon-species/440/" - } - }, - "id": 87 -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_evolution_chain_retrieve_responses] - - - - - -200 - - - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_item [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item] - - - - - - - - - -#### ItemSummary [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_baby_trigger_item_itemsummary_url] - - - - - - - - - - - - - -chain","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### chain [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_chain] - - - - - - - - - - - - - -##### id [#operation-api_v2_evolution_chain_retrieve_responses_200_application-json_id] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-trigger/ [#operation-api_v2_evolution_trigger_list] - - - - - -_List evolution triggers_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-trigger/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_evolution_trigger_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_evolution_trigger_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_evolution_trigger_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_evolution_trigger_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_evolution_trigger_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_evolution_trigger_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_evolution_trigger_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_evolution_trigger_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_evolution_trigger_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_evolution_trigger_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_evolution_trigger_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_evolution_trigger_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EvolutionTriggerSummary","children":[{"label":"EvolutionTriggerSummary","linkedLabel":"EvolutionTriggerSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_evolution_trigger_list_responses_200_application-json_results] - - - - - - - - - -#### EvolutionTriggerSummary [#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary] - - - - - - - - - -##### name [#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary_name] - - - - - - - - - -##### url [#operation-api_v2_evolution_trigger_list_responses_200_application-json_results_evolutiontriggersummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/evolution-trigger/\{id\}/ [#operation-api_v2_evolution_trigger_retrieve] - - - - - -_Get evolution trigger_ - - - - - -Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/evolution-trigger/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_evolution_trigger_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_evolution_trigger_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_evolution_trigger_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_evolution_trigger_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_evolution_trigger_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_evolution_trigger_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "ivysaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/2/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_evolution_trigger_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_name] - - - - - -EvolutionTriggerName","children":[{"label":"EvolutionTriggerName","linkedLabel":"EvolutionTriggerName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names] - - - - - - - - - -#### EvolutionTriggerName [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_names_evolutiontriggername_name] - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### pokemon\_specie [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie] - - - - - - - - - -##### name [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_name] - - - - - -_Example:_ - -``` -ivysaur -``` - - - - - - - - - -##### url [#operation-api_v2_evolution_trigger_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/2/ -``` - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/games/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/games/page.mdx deleted file mode 100644 index d4d4a7522..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/games/page.mdx +++ /dev/null @@ -1,4918 +0,0 @@ ---- -sidebarTitle: Games ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Games Endpoints - - - - - -The Pokémon games are all video games in the Pokémon franchise. - - - - - - - - - -## GET /api/v2/generation/ [#operation-api_v2_generation_list] - - - - - -_List genrations_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/generation/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_generation_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_generation_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_generation_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_generation_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_generation_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_generation_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_generation_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_generation_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_generation_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_generation_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_generation_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_generation_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenerationSummary","children":[{"label":"GenerationSummary","linkedLabel":"GenerationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_generation_list_responses_200_application-json_results] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_list_responses_200_application-json_results_generationsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/generation/\{id\}/ [#operation-api_v2_generation_retrieve] - - - - - -_Get genration_ - - - - - -A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/generation/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_generation_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_generation_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_generation_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_generation_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_generation_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_generation_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "abilities": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "main_region": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "moves": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ], - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_species": [ - { - "name": "do do sint mollit", - "url": "occaecat" - } - ], - "types": [ - { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - ], - "version_groups": [ - { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_generation_retrieve_responses] - - - - - -200 - - - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities [#operation-api_v2_generation_retrieve_responses_200_application-json_abilities] - - - - - - - - - -#### AbilitySummary [#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_abilities_abilitysummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_generation_retrieve_responses_200_application-json_id] - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_region [#operation-api_v2_generation_retrieve_responses_200_application-json_main_region] - - - - - - - - - -#### RegionSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_main_region_regionsummary_url] - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_generation_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### MoveSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_moves_movesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_name] - - - - - -GenerationName","children":[{"label":"GenerationName","linkedLabel":"GenerationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_generation_retrieve_responses_200_application-json_names] - - - - - - - - - -#### GenerationName [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_names_generationname_name] - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url] - - - - - - - - - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types [#operation-api_v2_generation_retrieve_responses_200_application-json_types] - - - - - - - - - -#### TypeSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_types_typesummary_url] - - - - - - - - - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups [#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_generation_retrieve_responses_200_application-json_version_groups_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokedex/ [#operation-api_v2_pokedex_list] - - - - - -_List pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokedex/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokedex_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokedex_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokedex_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokedex_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokedex_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokedex_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokedex_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokedex_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokedex_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokedex_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokedex_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokedex_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokedex_list_responses_200_application-json_results] - - - - - - - - - -#### PokedexSummary [#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary] - - - - - - - - - -##### name [#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokedex_list_responses_200_application-json_results_pokedexsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokedex/\{id\}/ [#operation-api_v2_pokedex_retrieve] - - - - - -_Get pokedex_ - - - - - -A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokedex/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokedex_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokedex_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokedex_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokedex_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokedex_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokedex_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pokemon_entries": [ - { - "entry_number": "1", - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - } - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version_groups": [ - { - "name": "the-teal-mask", - "url": "https://pokeapi.co/api/v2/version-group/26/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokedex_retrieve_responses] - - - - - -200 - - - - - - - -PokedexDescription","children":[{"label":"PokedexDescription","linkedLabel":"PokedexDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### PokedexDescription [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription] - - - - - - - - - -##### description [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokedex_retrieve_responses_200_application-json_descriptions_pokedexdescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_pokedex_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_main_series [#operation-api_v2_pokedex_retrieve_responses_200_application-json_is_main_series] - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_name] - - - - - -PokedexName","children":[{"label":"PokedexName","linkedLabel":"PokedexName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names] - - - - - - - - - -#### PokedexName [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_names_pokedexname_name] - - - - - - - - - - - - - -pokemon_entry","children":[{"label":"pokemon_entry","linkedLabel":"pokemon_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_entries [#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries] - - - - - - - - - -#### pokemon\_entry [#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry] - - - - - - - - - -##### entry_number [#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry_entry_number] - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species [#operation-api_v2_pokedex_retrieve_responses_200_application-json_pokemon_entries_pokemon_entry_pokemon_species] - - - - - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region [#operation-api_v2_pokedex_retrieve_responses_200_application-json_region] - - - - - - - - - -#### RegionSummary [#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary] - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokedex_retrieve_responses_200_application-json_region_regionsummary_url] - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups [#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups] - - - - - - - - - -#### version\_group [#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group] - - - - - - - - - -##### name [#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group_name] - - - - - -_Example:_ - -``` -the-teal-mask -``` - - - - - - - - - -##### url [#operation-api_v2_pokedex_retrieve_responses_200_application-json_version_groups_version_group_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/26/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version/ [#operation-api_v2_version_list] - - - - - -_List versions_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_version_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_version_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_version_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_version_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_version_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_version_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_version_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_version_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_version_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_version_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_version_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_version_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_version_list_responses_200_application-json_results] - - - - - - - - - -#### VersionSummary [#operation-api_v2_version_list_responses_200_application-json_results_versionsummary] - - - - - - - - - -##### name [#operation-api_v2_version_list_responses_200_application-json_results_versionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_list_responses_200_application-json_results_versionsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version/\{id\}/ [#operation-api_v2_version_retrieve] - - - - - -_Get version_ - - - - - -Versions of the games, e.g., Red, Blue or Yellow. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_version_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_version_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_version_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_version_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_version_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_version_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_version_retrieve_responses] - - - - - -200 - - - - - - - -Should have a link to Version Group info but the Circular -dependency and compilation order fight eachother and I'm -not sure how to add anything other than a hyperlink - - - - - - - - - -##### id [#operation-api_v2_version_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_version_retrieve_responses_200_application-json_name] - - - - - -VersionName","children":[{"label":"VersionName","linkedLabel":"VersionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_version_retrieve_responses_200_application-json_names] - - - - - - - - - -#### VersionName [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_version_retrieve_responses_200_application-json_names_versionname_name] - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group [#operation-api_v2_version_retrieve_responses_200_application-json_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_retrieve_responses_200_application-json_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version-group/ [#operation-api_v2_version_group_list] - - - - - -_List version groups_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version-group/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_version_group_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_version_group_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_version_group_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_version_group_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_version_group_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_version_group_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_version_group_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_version_group_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_version_group_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_version_group_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_version_group_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_version_group_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -VersionGroupSummary","children":[{"label":"VersionGroupSummary","linkedLabel":"VersionGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_version_group_list_responses_200_application-json_results] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_group_list_responses_200_application-json_results_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/version-group/\{id\}/ [#operation-api_v2_version_group_retrieve] - - - - - -_Get version group_ - - - - - -Version groups categorize highly similar versions of the games. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/version-group/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_version_group_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_version_group_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_version_group_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_version_group_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_version_group_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_version_group_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "generation": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "id": 87, - "move_learn_methods": [ - { - "name": "level-up", - "url": "https://pokeapi.co/api/v2/move-learn-method/1/" - } - ], - "name": "nostrud", - "pokedexes": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/pokedex/2/" - } - ], - "regions": [ - { - "name": "kanto", - "url": "https://pokeapi.co/api/v2/region/1/" - } - ], - "versions": [ - { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_version_group_retrieve_responses] - - - - - -200 - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation [#operation-api_v2_version_group_retrieve_responses_200_application-json_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_group_retrieve_responses_200_application-json_generation_generationsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_version_group_retrieve_responses_200_application-json_id] - - - - - -move_learn_method","children":[{"label":"move_learn_method","linkedLabel":"move_learn_method","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_learn_methods [#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods] - - - - - - - - - -#### move\_learn\_method [#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method] - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method_name] - - - - - -_Example:_ - -``` -level-up -``` - - - - - - - - - -##### url [#operation-api_v2_version_group_retrieve_responses_200_application-json_move_learn_methods_move_learn_method_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move-learn-method/1/ -``` - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_name] - - - - - - - - - -##### order [#operation-api_v2_version_group_retrieve_responses_200_application-json_order] - - - - - -pokedex","children":[{"label":"pokedex","linkedLabel":"pokedex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes [#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes] - - - - - - - - - -#### pokedex [#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex] - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex_name] - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url [#operation-api_v2_version_group_retrieve_responses_200_application-json_pokedexes_pokedex_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokedex/2/ -``` - - - - - - - - - - - - - -region","children":[{"label":"region","linkedLabel":"region","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### regions [#operation-api_v2_version_group_retrieve_responses_200_application-json_regions] - - - - - - - - - -#### region [#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region] - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region_name] - - - - - -_Example:_ - -``` -kanto -``` - - - - - - - - - -##### url [#operation-api_v2_version_group_retrieve_responses_200_application-json_regions_region_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/region/1/ -``` - - - - - - - - - - - - - -VersionSummary","children":[{"label":"VersionSummary","linkedLabel":"VersionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### versions [#operation-api_v2_version_group_retrieve_responses_200_application-json_versions] - - - - - - - - - -#### VersionSummary [#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary] - - - - - - - - - -##### name [#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_version_group_retrieve_responses_200_application-json_versions_versionsummary_url] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/items/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/items/page.mdx deleted file mode 100644 index 69efea21e..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/items/page.mdx +++ /dev/null @@ -1,5983 +0,0 @@ ---- -sidebarTitle: Items ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Items Endpoints - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -## GET /api/v2/item/ [#operation-api_v2_item_list] - - - - - -_List items_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_item_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_item_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_item_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_item_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_item_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_item_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_item_list_responses_200_application-json_results] - - - - - - - - - -#### ItemSummary [#operation-api_v2_item_list_responses_200_application-json_results_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_item_list_responses_200_application-json_results_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_list_responses_200_application-json_results_itemsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item/\{id\}/ [#operation-api_v2_item_retrieve] - - - - - -_Get item_ - - - - - -An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_item_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "attributes": [ - { - "name": "countable", - "url": "https://pokeapi.co/api/v2/item-attribute/1/" - } - ], - "baby_trigger_for": { - "url": "https://pokeapi.co/api/v2/evolution-chain/51/" - }, - "category": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "language": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "text": "occaecat", - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "fling_effect": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "ut sint", - "url": "dolor voluptate eu" - } - } - ], - "held_by_pokemon": [ - { - "pokemon": { - "name": "farfetchd", - "url": "https://pokeapi.co/api/v2/pokemon/83/" - }, - "version-details": [ - { - "rarity": "5", - "version": { - "name": "ruby", - "url": "https://pokeapi.co/api/v2/version/7/" - } - } - ] - } - ], - "id": 56, - "machines": [ - { - "machine": "https://pokeapi.co/api/v2/machine/1/", - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/20/" - } - } - ], - "name": "ullamco", - "names": [ - { - "language": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "name": "in consectetur excepteur sint" - } - ], - "sprites": { - "default": "https://pokeapi.co/media/sprites/items/master-ball.png" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_retrieve_responses] - - - - - -200 - - - - - - - -attribute","children":[{"label":"attribute","linkedLabel":"attribute","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### attributes [#operation-api_v2_item_retrieve_responses_200_application-json_attributes] - - - - - - - - - -#### attribute [#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute_name] - - - - - -_Example:_ - -``` -countable -``` - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_attributes_attribute_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item-attribute/1/ -``` - - - - - - - - - - - - - -baby_trigger_for","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### baby_trigger_for [#operation-api_v2_item_retrieve_responses_200_application-json_baby_trigger_for] - - - - - - - - - -ItemCategorySummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### category [#operation-api_v2_item_retrieve_responses_200_application-json_category] - - - - - - - - - -#### ItemCategorySummary [#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_category_itemcategorysummary_url] - - - - - - - - - - - - - - - - - -##### cost [#operation-api_v2_item_retrieve_responses_200_application-json_cost] - - - - - -ItemEffectText","children":[{"label":"ItemEffectText","linkedLabel":"ItemEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries] - - - - - - - - - -#### ItemEffectText [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext] - - - - - - - - - -##### effect [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_effect] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### short_effect [#operation-api_v2_item_retrieve_responses_200_application-json_effect_entries_itemeffecttext_short_effect] - - - - - - - - - - - - - -ItemFlavorText","children":[{"label":"ItemFlavorText","linkedLabel":"ItemFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### ItemFlavorText [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### text [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_text] - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_flavor_text_entries_itemflavortext_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### fling_effect [#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect] - - - - - - - - - -#### ItemFlingEffectSummary [#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_fling_effect_itemflingeffectsummary_url] - - - - - - - - - - - - - - - - - -##### fling_power [#operation-api_v2_item_retrieve_responses_200_application-json_fling_power] - - - - - -ItemGameIndex","children":[{"label":"ItemGameIndex","linkedLabel":"ItemGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices] - - - - - - - - - -#### ItemGameIndex [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex] - - - - - - - - - -##### game_index [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_game_index] - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_game_indices_itemgameindex_generation_generationsummary_url] - - - - - - - - - - - - - - - - - - - - - -held_by_pokemon","children":[{"label":"held_by_pokemon","linkedLabel":"held_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_by_pokemon [#operation-api_v2_item_retrieve_responses_200_application-json_held_by_pokemon] - - - - - - - - - - - - - -##### id [#operation-api_v2_item_retrieve_responses_200_application-json_id] - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines [#operation-api_v2_item_retrieve_responses_200_application-json_machines] - - - - - - - - - -#### machine [#operation-api_v2_item_retrieve_responses_200_application-json_machines_machine] - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_item_retrieve_responses_200_application-json_machines_machine_version_group] - - - - - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_name] - - - - - -ItemName","children":[{"label":"ItemName","linkedLabel":"ItemName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_item_retrieve_responses_200_application-json_names] - - - - - - - - - -#### ItemName [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_retrieve_responses_200_application-json_names_itemname_name] - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites [#operation-api_v2_item_retrieve_responses_200_application-json_sprites] - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-category/ [#operation-api_v2_item_category_list] - - - - - -_List item categories_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-category/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_category_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_category_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_category_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_category_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_item_category_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_item_category_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_item_category_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_category_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_category_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_item_category_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_item_category_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_item_category_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_item_category_list_responses_200_application-json_results] - - - - - - - - - -#### ItemCategorySummary [#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary] - - - - - - - - - -##### name [#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_category_list_responses_200_application-json_results_itemcategorysummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-category/\{id\}/ [#operation-api_v2_item_category_retrieve] - - - - - -_Get item category_ - - - - - -Item categories determine where items will be placed in the players bag. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-category/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_category_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_category_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_category_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_category_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_item_category_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_category_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "items": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "pocket": { - "name": "irure", - "url": "dolor" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_category_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_item_category_retrieve_responses_200_application-json_id] - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items [#operation-api_v2_item_category_retrieve_responses_200_application-json_items] - - - - - - - - - -#### ItemSummary [#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_category_retrieve_responses_200_application-json_items_itemsummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_category_retrieve_responses_200_application-json_name] - - - - - -ItemCategoryName","children":[{"label":"ItemCategoryName","linkedLabel":"ItemCategoryName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_item_category_retrieve_responses_200_application-json_names] - - - - - - - - - -#### ItemCategoryName [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_category_retrieve_responses_200_application-json_names_itemcategoryname_name] - - - - - - - - - - - - - -ItemPocketSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pocket [#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket] - - - - - - - - - -#### ItemPocketSummary [#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary] - - - - - - - - - -##### name [#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_category_retrieve_responses_200_application-json_pocket_itempocketsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-attribute/ [#operation-api_v2_item_attribute_list] - - - - - -_List item attributes_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-attribute/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_attribute_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_attribute_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_attribute_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_attribute_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_item_attribute_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_item_attribute_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_item_attribute_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_attribute_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_attribute_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_item_attribute_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_item_attribute_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_item_attribute_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemAttributeSummary","children":[{"label":"ItemAttributeSummary","linkedLabel":"ItemAttributeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_item_attribute_list_responses_200_application-json_results] - - - - - - - - - -#### ItemAttributeSummary [#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary] - - - - - - - - - -##### name [#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_attribute_list_responses_200_application-json_results_itemattributesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-attribute/\{id\}/ [#operation-api_v2_item_attribute_retrieve] - - - - - -_Get item attribute_ - - - - - -Item attributes define particular aspects of items, e.g."usable in battle" or "consumable". - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-attribute/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_attribute_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_attribute_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_attribute_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_attribute_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_item_attribute_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_attribute_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "items": [ - { - "name": "master-ball", - "url": "https://pokeapi.co/api/v2/item/1/" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_attribute_retrieve_responses] - - - - - -200 - - - - - - - -ItemAttributeDescription","children":[{"label":"ItemAttributeDescription","linkedLabel":"ItemAttributeDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### ItemAttributeDescription [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription] - - - - - - - - - -##### description [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_descriptions_itemattributedescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_id] - - - - - -item","children":[{"label":"item","linkedLabel":"item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items] - - - - - - - - - -#### item [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item] - - - - - - - - - -##### name [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item_name] - - - - - -_Example:_ - -``` -master-ball -``` - - - - - - - - - -##### url [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_items_item_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/item/1/ -``` - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_name] - - - - - -ItemAttributeName","children":[{"label":"ItemAttributeName","linkedLabel":"ItemAttributeName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names] - - - - - - - - - -#### ItemAttributeName [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_attribute_retrieve_responses_200_application-json_names_itemattributename_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-fling-effect/ [#operation-api_v2_item_fling_effect_list] - - - - - -_List item fling effects_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-fling-effect/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_fling_effect_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_fling_effect_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_fling_effect_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_fling_effect_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_item_fling_effect_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_item_fling_effect_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_item_fling_effect_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_fling_effect_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_fling_effect_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_item_fling_effect_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_item_fling_effect_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_item_fling_effect_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemFlingEffectSummary","children":[{"label":"ItemFlingEffectSummary","linkedLabel":"ItemFlingEffectSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_item_fling_effect_list_responses_200_application-json_results] - - - - - - - - - -#### ItemFlingEffectSummary [#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary] - - - - - - - - - -##### name [#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_fling_effect_list_responses_200_application-json_results_itemflingeffectsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-fling-effect/\{id\}/ [#operation-api_v2_item_fling_effect_retrieve] - - - - - -_Get item fling effect_ - - - - - -The various effects of the move"Fling" when used with different items. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-fling-effect/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_fling_effect_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_fling_effect_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_fling_effect_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_fling_effect_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_item_fling_effect_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_fling_effect_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "id": 87, - "items": [ - { - "name": "occaecat dolor sit", - "url": "nostrud" - } - ], - "name": "aute aliqua aute commodo" -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_fling_effect_retrieve_responses] - - - - - -200 - - - - - - - -ItemFlingEffectEffectText","children":[{"label":"ItemFlingEffectEffectText","linkedLabel":"ItemFlingEffectEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries] - - - - - - - - - -#### ItemFlingEffectEffectText [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext] - - - - - - - - - -##### effect [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_effect] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_effect_entries_itemflingeffecteffecttext_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_id] - - - - - -ItemSummary","children":[{"label":"ItemSummary","linkedLabel":"ItemSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### items [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items] - - - - - - - - - -#### ItemSummary [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_items_itemsummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_fling_effect_retrieve_responses_200_application-json_name] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-pocket/ [#operation-api_v2_item_pocket_list] - - - - - -_List item pockets_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-pocket/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_pocket_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_pocket_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_pocket_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_pocket_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_item_pocket_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_item_pocket_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_item_pocket_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_pocket_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_pocket_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_item_pocket_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_item_pocket_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_item_pocket_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -ItemPocketSummary","children":[{"label":"ItemPocketSummary","linkedLabel":"ItemPocketSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_item_pocket_list_responses_200_application-json_results] - - - - - - - - - -#### ItemPocketSummary [#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary] - - - - - - - - - -##### name [#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_pocket_list_responses_200_application-json_results_itempocketsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/item-pocket/\{id\}/ [#operation-api_v2_item_pocket_retrieve] - - - - - -_Get item pocket_ - - - - - -Pockets within the players bag used for storing items by category. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/item-pocket/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_item_pocket_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_item_pocket_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_item_pocket_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_item_pocket_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_item_pocket_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_item_pocket_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "categories": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_item_pocket_retrieve_responses] - - - - - -200 - - - - - - - -ItemCategorySummary","children":[{"label":"ItemCategorySummary","linkedLabel":"ItemCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### categories [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories] - - - - - - - - - -#### ItemCategorySummary [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary] - - - - - - - - - -##### name [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_categories_itemcategorysummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_name] - - - - - -ItemPocketName","children":[{"label":"ItemPocketName","linkedLabel":"ItemPocketName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names] - - - - - - - - - -#### ItemPocketName [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_item_pocket_retrieve_responses_200_application-json_names_itempocketname_name] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/location/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/location/page.mdx deleted file mode 100644 index 38d887b8f..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/location/page.mdx +++ /dev/null @@ -1,4712 +0,0 @@ ---- -sidebarTitle: Location ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Location Endpoints - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -## GET /api/v2/location/ [#operation-api_v2_location_list] - - - - - -_List locations_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_location_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_location_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_location_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_location_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_location_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_location_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_location_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_location_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_location_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_location_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_location_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_location_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_location_list_responses_200_application-json_results] - - - - - - - - - -#### LocationSummary [#operation-api_v2_location_list_responses_200_application-json_results_locationsummary] - - - - - - - - - -##### name [#operation-api_v2_location_list_responses_200_application-json_results_locationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_list_responses_200_application-json_results_locationsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location/\{id\}/ [#operation-api_v2_location_retrieve] - - - - - -_Get location_ - - - - - -Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_location_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_location_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_location_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_location_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_location_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_location_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "areas": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - } - ], - "id": 14, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "region": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_location_retrieve_responses] - - - - - -200 - - - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### areas [#operation-api_v2_location_retrieve_responses_200_application-json_areas] - - - - - - - - - -#### LocationAreaSummary [#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary] - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_retrieve_responses_200_application-json_areas_locationareasummary_url] - - - - - - - - - - - - - -LocationGameIndex","children":[{"label":"LocationGameIndex","linkedLabel":"LocationGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices] - - - - - - - - - -#### LocationGameIndex [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex] - - - - - - - - - -##### game_index [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_game_index] - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_retrieve_responses_200_application-json_game_indices_locationgameindex_generation_generationsummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_location_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_name] - - - - - -LocationName","children":[{"label":"LocationName","linkedLabel":"LocationName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_location_retrieve_responses_200_application-json_names] - - - - - - - - - -#### LocationName [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_names_locationname_name] - - - - - - - - - - - - - -RegionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### region [#operation-api_v2_location_retrieve_responses_200_application-json_region] - - - - - - - - - -#### RegionSummary [#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary] - - - - - - - - - -##### name [#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_retrieve_responses_200_application-json_region_regionsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location-area/ [#operation-api_v2_location_area_list] - - - - - -_List location areas_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location-area/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_location_area_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_location_area_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_location_area_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_location_area_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_location_area_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_location_area_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_location_area_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_location_area_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_location_area_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_location_area_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_location_area_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LocationAreaSummary","children":[{"label":"LocationAreaSummary","linkedLabel":"LocationAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_location_area_list_responses_200_application-json_results] - - - - - - - - - -#### LocationAreaSummary [#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary] - - - - - - - - - -##### name [#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_area_list_responses_200_application-json_results_locationareasummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/location-area/\{id\}/ [#operation-api_v2_location_area_retrieve] - - - - - -_Get location area_ - - - - - -Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/location-area/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_location_area_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_location_area_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_location_area_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_location_area_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_location_area_retrieve_parameters_id] - - - - - -A unique integer value identifying this location area. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_location_area_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "encounter_method_rates": [ - { - "encounter_method": { - "name": "old-rod", - "url": "https://pokeapi.co/api/v2/encounter-method/2/" - }, - "version_details": [ - { - "rate": "5", - "version": { - "name": "platinum", - "url": "https://pokeapi.co/api/v2/version/14/" - } - } - ] - } - ], - "game_index": 14, - "id": 56, - "location": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "name": "irure", - "names": [ - { - "language": { - "name": "dolor", - "url": "sunt" - }, - "name": "nisi minim commodo irure minim" - } - ], - "pokemon_encounters": [ - { - "pokemon": { - "name": "tentacool", - "url": "https://pokeapi.co/api/v2/pokemon/72/" - }, - "version_details": [ - { - "encounter_details": { - "chance": "60", - "max_level": "30", - "method": { - "name": "surf", - "url": "https://pokeapi.co/api/v2/encounter-method/5/" - }, - "min_level": "20" - }, - "max_chance": "60", - "version": { - "name": "diamond", - "url": "https://pokeapi.co/api/v2/version/12/" - } - } - ] - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_location_area_retrieve_responses] - - - - - -200 - - - - - - - -encounter_method_rate","children":[{"label":"encounter_method_rate","linkedLabel":"encounter_method_rate","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### encounter_method_rates [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates] - - - - - - - - - -#### encounter\_method\_rate [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate] - - - - - -encounter_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_method [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_encounter_method] - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details] - - - - - - - - - -#### version\_detail [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail] - - - - - - - - - -##### rate [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail_rate] - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_location_area_retrieve_responses_200_application-json_encounter_method_rates_encounter_method_rate_version_details_version_detail_version] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### game_index [#operation-api_v2_location_area_retrieve_responses_200_application-json_game_index] - - - - - - - - - -##### id [#operation-api_v2_location_area_retrieve_responses_200_application-json_id] - - - - - -LocationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### location [#operation-api_v2_location_area_retrieve_responses_200_application-json_location] - - - - - - - - - -#### LocationSummary [#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary] - - - - - - - - - -##### name [#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_area_retrieve_responses_200_application-json_location_locationsummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_location_area_retrieve_responses_200_application-json_name] - - - - - -LocationAreaName","children":[{"label":"LocationAreaName","linkedLabel":"LocationAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_location_area_retrieve_responses_200_application-json_names] - - - - - - - - - -#### LocationAreaName [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_location_area_retrieve_responses_200_application-json_names_locationareaname_name] - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters] - - - - - - - - - -#### pokemon\_encounter [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter] - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_pokemon] - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details] - - - - - - - - - -#### version\_detail [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail] - - - - - -encounter_details","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### encounter_details [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_encounter_details] - - - - - - - - - - - - - -##### max_chance [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_max_chance] - - - - - -_Example:_ - -``` -60 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_location_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_version_details_version_detail_version] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pal-park-area/ [#operation-api_v2_pal_park_area_list] - - - - - -_List pal park areas_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pal-park-area/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pal_park_area_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pal_park_area_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pal_park_area_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pal_park_area_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pal_park_area_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pal_park_area_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pal_park_area_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pal_park_area_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pal_park_area_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pal_park_area_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pal_park_area_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pal_park_area_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PalParkAreaSummary","children":[{"label":"PalParkAreaSummary","linkedLabel":"PalParkAreaSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pal_park_area_list_responses_200_application-json_results] - - - - - - - - - -#### PalParkAreaSummary [#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary] - - - - - - - - - -##### name [#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary_name] - - - - - - - - - -##### url [#operation-api_v2_pal_park_area_list_responses_200_application-json_results_palparkareasummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pal-park-area/\{id\}/ [#operation-api_v2_pal_park_area_retrieve] - - - - - -_Get pal park area_ - - - - - -Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pal-park-area/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pal_park_area_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pal_park_area_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pal_park_area_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pal_park_area_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pal_park_area_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pal_park_area_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_encounters": [ - { - "base_score": "50", - "pokemon-species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "30" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pal_park_area_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_name] - - - - - -PalParkAreaName","children":[{"label":"PalParkAreaName","linkedLabel":"PalParkAreaName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names] - - - - - - - - - -#### PalParkAreaName [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_names_palparkareaname_name] - - - - - - - - - - - - - -pokemon_encounter","children":[{"label":"pokemon_encounter","linkedLabel":"pokemon_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_encounters [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters] - - - - - - - - - -#### pokemon\_encounter [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter] - - - - - - - - - -##### base_score [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_base_score] - - - - - -_Example:_ - -``` -50 -``` - - - - - -pokemon-species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon-species [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_pokemon-species] - - - - - - - - - - - - - -##### rate [#operation-api_v2_pal_park_area_retrieve_responses_200_application-json_pokemon_encounters_pokemon_encounter_rate] - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/region/ [#operation-api_v2_region_list] - - - - - -_List regions_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/region/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_region_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_region_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_region_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_region_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_region_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_region_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_region_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_region_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_region_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_region_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_region_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_region_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -RegionSummary","children":[{"label":"RegionSummary","linkedLabel":"RegionSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_region_list_responses_200_application-json_results] - - - - - - - - - -#### RegionSummary [#operation-api_v2_region_list_responses_200_application-json_results_regionsummary] - - - - - - - - - -##### name [#operation-api_v2_region_list_responses_200_application-json_results_regionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_region_list_responses_200_application-json_results_regionsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/region/\{id\}/ [#operation-api_v2_region_retrieve] - - - - - -_Get region_ - - - - - -A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/region/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_region_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_region_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_region_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_region_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_region_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_region_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "locations": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "main_generation": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ], - "pokedexes": [ - { - "name": "sunt", - "url": "nisi minim commodo irure minim" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_region_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_region_retrieve_responses_200_application-json_id] - - - - - -LocationSummary","children":[{"label":"LocationSummary","linkedLabel":"LocationSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### locations [#operation-api_v2_region_retrieve_responses_200_application-json_locations] - - - - - - - - - -#### LocationSummary [#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary] - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_region_retrieve_responses_200_application-json_locations_locationsummary_url] - - - - - - - - - - - - - -main_generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### main_generation [#operation-api_v2_region_retrieve_responses_200_application-json_main_generation] - - - - - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_name] - - - - - -RegionName","children":[{"label":"RegionName","linkedLabel":"RegionName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_region_retrieve_responses_200_application-json_names] - - - - - - - - - -#### RegionName [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_names_regionname_name] - - - - - - - - - - - - - -PokedexSummary","children":[{"label":"PokedexSummary","linkedLabel":"PokedexSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedexes [#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes] - - - - - - - - - -#### PokedexSummary [#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary] - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary_name] - - - - - - - - - -##### url [#operation-api_v2_region_retrieve_responses_200_application-json_pokedexes_pokedexsummary_url] - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups [#operation-api_v2_region_retrieve_responses_200_application-json_version_groups] - - - - - - - - - -#### version\_group [#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group] - - - - - - - - - -##### name [#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group_name] - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url [#operation-api_v2_region_retrieve_responses_200_application-json_version_groups_version_group_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/machines/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/machines/page.mdx deleted file mode 100644 index e1b64c1be..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/machines/page.mdx +++ /dev/null @@ -1,976 +0,0 @@ ---- -sidebarTitle: Machines ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Machines Endpoints - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -## GET /api/v2/machine/ [#operation-api_v2_machine_list] - - - - - -_List machines_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/machine/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_machine_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_machine_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_machine_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_machine_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_machine_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_machine_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_machine_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_machine_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_machine_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_machine_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_machine_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_machine_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MachineSummary","children":[{"label":"MachineSummary","linkedLabel":"MachineSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_machine_list_responses_200_application-json_results] - - - - - - - - - -#### MachineSummary [#operation-api_v2_machine_list_responses_200_application-json_results_machinesummary] - - - - - - - - - -##### url [#operation-api_v2_machine_list_responses_200_application-json_results_machinesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/machine/\{id\}/ [#operation-api_v2_machine_retrieve] - - - - - -_Get machine_ - - - - - -Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/machine/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_machine_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_machine_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_machine_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_machine_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_machine_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_machine_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "item": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "move": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "version_group": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_machine_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_machine_retrieve_responses_200_application-json_id] - - - - - -ItemSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### item [#operation-api_v2_machine_retrieve_responses_200_application-json_item] - - - - - - - - - -#### ItemSummary [#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary] - - - - - - - - - -##### name [#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary_name] - - - - - - - - - -##### url [#operation-api_v2_machine_retrieve_responses_200_application-json_item_itemsummary_url] - - - - - - - - - - - - - -MoveSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move [#operation-api_v2_machine_retrieve_responses_200_application-json_move] - - - - - - - - - -#### MoveSummary [#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary] - - - - - - - - - -##### name [#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_machine_retrieve_responses_200_application-json_move_movesummary_url] - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group [#operation-api_v2_machine_retrieve_responses_200_application-json_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_machine_retrieve_responses_200_application-json_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/moves/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/moves/page.mdx deleted file mode 100644 index 6f54e3251..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/moves/page.mdx +++ /dev/null @@ -1,7808 +0,0 @@ ---- -sidebarTitle: Moves ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Moves Endpoints - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -## GET /api/v2/move/ [#operation-api_v2_move_list] - - - - - -_List moves_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_list_responses_200_application-json_results] - - - - - - - - - -#### MoveSummary [#operation-api_v2_move_list_responses_200_application-json_results_movesummary] - - - - - - - - - -##### name [#operation-api_v2_move_list_responses_200_application-json_results_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_list_responses_200_application-json_results_movesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move/\{id\}/ [#operation-api_v2_move_retrieve] - - - - - -_Get move_ - - - - - -Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "contest_combos": { - "normal": { - "use_after": null, - "use_before": null - }, - "super": { - "use_after": null, - "use_before": null - } - }, - "contest_effect": { - "url": "ipsum eiusmod" - }, - "contest_type": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "damage_class": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "effect_chance": 87, - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "Hits Pokémon under the effects of dig and fly.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "version_group": { - "name": "gold-silver", - "url": "https://pokeapi.co/api/v2/version-group/3/" - } - } - ], - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nostrud anim", - "language": { - "name": "exercitation aliqua sint", - "url": "ut sint" - }, - "version_group": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - } - } - ], - "generation": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "id": 14, - "learned_by_pokemon": [ - { - "name": "clefairy", - "url": "https://pokeapi.co/api/v2/pokemon/35/" - } - ], - "machines": [ - { - "machine": { - "url": "https://pokeapi.co/api/v2/machine/1/" - }, - "version_group": { - "name": "sword-shield", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - } - ], - "meta": { - "ailment": { - "name": "voluptate aliquip", - "url": "et excepteur dolore commodo id" - }, - "category": { - "name": "in consectetur excepteur sint", - "url": "sunt amet" - } - }, - "name": "duis ea", - "names": [ - { - "language": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "name": "magna est commodo officia" - } - ], - "past_values": [ - { - "effect_chance": 56, - "effect_entries": [ - { - "effect": "Inflicts [regular damage]{mechanic:regular-damage}.", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "short_effect": "Inflicts regular damage with no additional effect." - } - ], - "type": { - "name": "ad occaecat elit proident ea", - "url": "cillum culpa aute minim" - }, - "version_group": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "stat_changes": [ - { - "change": "2", - "stat": { - "name": "attack", - "url": "https://pokeapi.co/api/v2/stat/1/" - } - } - ], - "super_contest_effect": { - "url": "nostrud" - }, - "target": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "type": { - "name": "dolor", - "url": "sunt" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### accuracy [#operation-api_v2_move_retrieve_responses_200_application-json_accuracy] - - - - - -contest_combos","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_combos [#operation-api_v2_move_retrieve_responses_200_application-json_contest_combos] - - - - - - - - - -ContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_effect [#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect] - - - - - - - - - -#### ContestEffectSummary [#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect_contesteffectsummary] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_contest_effect_contesteffectsummary_url] - - - - - - - - - - - - - -ContestTypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### contest_type [#operation-api_v2_move_retrieve_responses_200_application-json_contest_type] - - - - - - - - - -#### ContestTypeSummary [#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_contest_type_contesttypesummary_url] - - - - - - - - - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_class [#operation-api_v2_move_retrieve_responses_200_application-json_damage_class] - - - - - - - - - -#### MoveDamageClassSummary [#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_damage_class_movedamageclasssummary_url] - - - - - - - - - - - - - - - - - -##### effect_chance [#operation-api_v2_move_retrieve_responses_200_application-json_effect_chance] - - - - - -effect_change","children":[{"label":"effect_change","linkedLabel":"effect_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes] - - - - - - - - - -#### effect\_change [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change] - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries] - - - - - - - - - -#### effect\_entry [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry] - - - - - - - - - -##### effect [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry_effect] - - - - - -_Example:_ - -``` -Hits Pokémon under the effects of dig and fly. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_effect_entries_effect_entry_language] - - - - - - - - - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_move_retrieve_responses_200_application-json_effect_changes_effect_change_version_group] - - - - - - - - - - - - - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries [#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries] - - - - - - - - - -#### effect\_entry [#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry] - - - - - - - - - -##### effect [#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_effect] - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_language] - - - - - - - - - - - - - -##### short_effect [#operation-api_v2_move_retrieve_responses_200_application-json_effect_entries_effect_entry_short_effect] - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - -MoveFlavorText","children":[{"label":"MoveFlavorText","linkedLabel":"MoveFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### MoveFlavorText [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext] - - - - - - - - - -##### flavor_text [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_flavor_text] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_language_languagesummary_url] - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_flavor_text_entries_moveflavortext_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation [#operation-api_v2_move_retrieve_responses_200_application-json_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_generation_generationsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_move_retrieve_responses_200_application-json_id] - - - - - -learned_by_pokemon","children":[{"label":"learned_by_pokemon","linkedLabel":"learned_by_pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### learned_by_pokemon [#operation-api_v2_move_retrieve_responses_200_application-json_learned_by_pokemon] - - - - - - - - - -machine","children":[{"label":"machine","linkedLabel":"machine","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### machines [#operation-api_v2_move_retrieve_responses_200_application-json_machines] - - - - - - - - - -#### machine [#operation-api_v2_move_retrieve_responses_200_application-json_machines_machine] - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_move_retrieve_responses_200_application-json_machines_machine_version_group] - - - - - - - - - - - - - - - - - -meta","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### meta [#operation-api_v2_move_retrieve_responses_200_application-json_meta] - - - - - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_name] - - - - - -MoveName","children":[{"label":"MoveName","linkedLabel":"MoveName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveName [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_names_movename_name] - - - - - - - - - - - - - -MoveChange","children":[{"label":"MoveChange","linkedLabel":"MoveChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_values [#operation-api_v2_move_retrieve_responses_200_application-json_past_values] - - - - - - - - - -#### MoveChange [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange] - - - - - - - - - -##### accuracy [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_accuracy] - - - - - - - - - -##### effect_chance [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_chance] - - - - - -effect_entry","children":[{"label":"effect_entry","linkedLabel":"effect_entry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries] - - - - - - - - - -#### effect\_entry [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry] - - - - - - - - - -##### effect [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_effect] - - - - - -_Example:_ - -``` -Inflicts [regular damage]{mechanic:regular-damage}. -``` - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_language] - - - - - - - - - - - - - -##### short_effect [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_effect_entries_effect_entry_short_effect] - - - - - -_Example:_ - -``` -Inflicts regular damage with no additional effect. -``` - - - - - - - - - - - - - - - - - -##### power [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_power] - - - - - - - - - -##### pp [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_pp] - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### type [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type] - - - - - - - - - -#### TypeSummary [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_type_typesummary_url] - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_past_values_movechange_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### power [#operation-api_v2_move_retrieve_responses_200_application-json_power] - - - - - - - - - -##### pp [#operation-api_v2_move_retrieve_responses_200_application-json_pp] - - - - - - - - - -##### priority [#operation-api_v2_move_retrieve_responses_200_application-json_priority] - - - - - -stat_change","children":[{"label":"stat_change","linkedLabel":"stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stat_changes [#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes] - - - - - - - - - -#### stat\_change [#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change] - - - - - - - - - -##### change [#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change_change] - - - - - -_Example:_ - -``` -2 -``` - - - - - -stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat [#operation-api_v2_move_retrieve_responses_200_application-json_stat_changes_stat_change_stat] - - - - - - - - - - - - - - - - - -SuperContestEffectSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### super_contest_effect [#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect] - - - - - - - - - -#### SuperContestEffectSummary [#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect_supercontesteffectsummary] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_super_contest_effect_supercontesteffectsummary_url] - - - - - - - - - - - - - -MoveTargetSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### target [#operation-api_v2_move_retrieve_responses_200_application-json_target] - - - - - - - - - -#### MoveTargetSummary [#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_target_movetargetsummary_url] - - - - - - - - - - - - - -TypeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### type [#operation-api_v2_move_retrieve_responses_200_application-json_type] - - - - - - - - - -#### TypeSummary [#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary] - - - - - - - - - -##### name [#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_retrieve_responses_200_application-json_type_typesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-ailment/ [#operation-api_v2_move_ailment_list] - - - - - -_List move meta ailments_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-ailment/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_ailment_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_ailment_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_ailment_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_ailment_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_ailment_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_ailment_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_ailment_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_ailment_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_ailment_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_ailment_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_ailment_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_ailment_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaAilmentSummary","children":[{"label":"MoveMetaAilmentSummary","linkedLabel":"MoveMetaAilmentSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_ailment_list_responses_200_application-json_results] - - - - - - - - - -#### MoveMetaAilmentSummary [#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary] - - - - - - - - - -##### name [#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_ailment_list_responses_200_application-json_results_movemetaailmentsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-ailment/\{id\}/ [#operation-api_v2_move_ailment_retrieve] - - - - - -_Get move meta ailment_ - - - - - -Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-ailment/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_ailment_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_ailment_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_ailment_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_ailment_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_ailment_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_ailment_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "moves": [ - { - "name": "thunder-punch", - "url": "https://pokeapi.co/api/v2/move/9/" - } - ], - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_ailment_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_id] - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### move [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move] - - - - - - - - - -##### name [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move_name] - - - - - -_Example:_ - -``` -thunder-punch -``` - - - - - - - - - -##### url [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_moves_move_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/9/ -``` - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_name] - - - - - -MoveMetaAilmentName","children":[{"label":"MoveMetaAilmentName","linkedLabel":"MoveMetaAilmentName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveMetaAilmentName [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_ailment_retrieve_responses_200_application-json_names_movemetaailmentname_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-battle-style/ [#operation-api_v2_move_battle_style_list] - - - - - -_List move battle styles_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-battle-style/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_battle_style_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_battle_style_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_battle_style_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_battle_style_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_battle_style_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_battle_style_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_battle_style_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_battle_style_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_battle_style_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_battle_style_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_battle_style_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_battle_style_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveBattleStyleSummary","children":[{"label":"MoveBattleStyleSummary","linkedLabel":"MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_battle_style_list_responses_200_application-json_results] - - - - - - - - - -#### MoveBattleStyleSummary [#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary] - - - - - - - - - -##### name [#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_battle_style_list_responses_200_application-json_results_movebattlestylesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-battle-style/\{id\}/ [#operation-api_v2_move_battle_style_retrieve] - - - - - -_Get move battle style_ - - - - - -Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-battle-style/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_battle_style_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_battle_style_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_battle_style_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_battle_style_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_battle_style_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_battle_style_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_battle_style_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_name] - - - - - -MoveBattleStyleName","children":[{"label":"MoveBattleStyleName","linkedLabel":"MoveBattleStyleName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveBattleStyleName [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_battle_style_retrieve_responses_200_application-json_names_movebattlestylename_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-category/ [#operation-api_v2_move_category_list] - - - - - -_List move meta categories_ - - - - - -Very general categories that loosely group move effects. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-category/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_category_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_category_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_category_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_category_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_category_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_category_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_category_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_category_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_category_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_category_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_category_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_category_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveMetaCategorySummary","children":[{"label":"MoveMetaCategorySummary","linkedLabel":"MoveMetaCategorySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_category_list_responses_200_application-json_results] - - - - - - - - - -#### MoveMetaCategorySummary [#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary] - - - - - - - - - -##### name [#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_category_list_responses_200_application-json_results_movemetacategorysummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-category/\{id\}/ [#operation-api_v2_move_category_retrieve] - - - - - -_Get move meta category_ - - - - - -Very general categories that loosely group move effects. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-category/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_category_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_category_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_category_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_category_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_category_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_category_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "sing", - "url": "https://pokeapi.co/api/v2/move/47/" - } - ], - "name": "nostrud" -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_category_retrieve_responses] - - - - - -200 - - - - - - - -MoveMetaCategoryDescription","children":[{"label":"MoveMetaCategoryDescription","linkedLabel":"MoveMetaCategoryDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### MoveMetaCategoryDescription [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription] - - - - - - - - - -##### description [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_category_retrieve_responses_200_application-json_descriptions_movemetacategorydescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_move_category_retrieve_responses_200_application-json_id] - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_move_category_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### move [#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move] - - - - - - - - - -##### name [#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move_name] - - - - - -_Example:_ - -``` -sing -``` - - - - - - - - - -##### url [#operation-api_v2_move_category_retrieve_responses_200_application-json_moves_move_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/move/47/ -``` - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_category_retrieve_responses_200_application-json_name] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-learn-method/ [#operation-api_v2_move_learn_method_list] - - - - - -_List move learn methods_ - - - - - -Methods by which Pokémon can learn moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-learn-method/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_learn_method_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_learn_method_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_learn_method_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_learn_method_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_learn_method_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_learn_method_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_learn_method_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_learn_method_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_learn_method_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_learn_method_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_learn_method_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_learn_method_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveLearnMethodSummary","children":[{"label":"MoveLearnMethodSummary","linkedLabel":"MoveLearnMethodSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_learn_method_list_responses_200_application-json_results] - - - - - - - - - -#### MoveLearnMethodSummary [#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary] - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_learn_method_list_responses_200_application-json_results_movelearnmethodsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-learn-method/\{id\}/ [#operation-api_v2_move_learn_method_retrieve] - - - - - -_Get move learn method_ - - - - - -Methods by which Pokémon can learn moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-learn-method/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_learn_method_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_learn_method_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_learn_method_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_learn_method_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_learn_method_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_learn_method_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ], - "version_groups": [ - { - "name": "red-blue", - "url": "https://pokeapi.co/api/v2/version-group/1/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_learn_method_retrieve_responses] - - - - - -200 - - - - - - - -MoveLearnMethodDescription","children":[{"label":"MoveLearnMethodDescription","linkedLabel":"MoveLearnMethodDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### MoveLearnMethodDescription [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription] - - - - - - - - - -##### description [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_descriptions_movelearnmethoddescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_name] - - - - - -MoveLearnMethodName","children":[{"label":"MoveLearnMethodName","linkedLabel":"MoveLearnMethodName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveLearnMethodName [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_names_movelearnmethodname_name] - - - - - - - - - - - - - -version_group","children":[{"label":"version_group","linkedLabel":"version_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_groups [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups] - - - - - - - - - -#### version\_group [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group] - - - - - - - - - -##### name [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group_name] - - - - - -_Example:_ - -``` -red-blue -``` - - - - - - - - - -##### url [#operation-api_v2_move_learn_method_retrieve_responses_200_application-json_version_groups_version_group_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/version-group/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-target/ [#operation-api_v2_move_target_list] - - - - - -_List move targets_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-target/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_target_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_target_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_target_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_target_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_target_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_target_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_target_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_target_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_target_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_target_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_target_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_target_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveTargetSummary","children":[{"label":"MoveTargetSummary","linkedLabel":"MoveTargetSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_target_list_responses_200_application-json_results] - - - - - - - - - -#### MoveTargetSummary [#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary] - - - - - - - - - -##### name [#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_target_list_responses_200_application-json_results_movetargetsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-target/\{id\}/ [#operation-api_v2_move_target_retrieve] - - - - - -_Get move target_ - - - - - -Targets moves can be directed at during battle. Targets can be Pokémon, environments or even other moves. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-target/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_target_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_target_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_target_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_target_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_target_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_target_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_target_retrieve_responses] - - - - - -200 - - - - - - - -MoveTargetDescription","children":[{"label":"MoveTargetDescription","linkedLabel":"MoveTargetDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### MoveTargetDescription [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription] - - - - - - - - - -##### description [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_target_retrieve_responses_200_application-json_descriptions_movetargetdescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_move_target_retrieve_responses_200_application-json_id] - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_move_target_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### MoveSummary [#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary] - - - - - - - - - -##### name [#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_target_retrieve_responses_200_application-json_moves_movesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_target_retrieve_responses_200_application-json_name] - - - - - -MoveTargetName","children":[{"label":"MoveTargetName","linkedLabel":"MoveTargetName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_target_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveTargetName [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_target_retrieve_responses_200_application-json_names_movetargetname_name] - - - - - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/pokemon/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/pokemon/page.mdx deleted file mode 100644 index 415c48498..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/pokemon/page.mdx +++ /dev/null @@ -1,20423 +0,0 @@ ---- -sidebarTitle: Pokemon ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyDescriptionSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagDescription, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Pokemon Endpoints - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -## GET /api/v2/ability/ [#operation-api_v2_ability_list] - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/ability/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_ability_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_ability_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_ability_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_ability_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_ability_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_ability_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_ability_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_ability_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_ability_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_ability_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_ability_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_ability_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -AbilitySummary","children":[{"label":"AbilitySummary","linkedLabel":"AbilitySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_ability_list_responses_200_application-json_results] - - - - - - - - - -#### AbilitySummary [#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary] - - - - - - - - - -##### name [#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_list_responses_200_application-json_results_abilitysummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/ability/\{id\}/ [#operation-api_v2_ability_retrieve] - - - - - -Abilities provide passive effects for Pokémon in battle or in the overworld. Pokémon have multiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/ability/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_ability_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_ability_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_ability_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_ability_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_ability_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_ability_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "effect_changes": [ - { - "effect_entries": [ - { - "effect": "ipsum eiusmod", - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - } - } - ], - "version_group": { - "name": "occaecat dolor sit", - "url": "nostrud" - } - } - ], - "effect_entries": [ - { - "effect": "aute aliqua aute commodo", - "language": { - "name": "irure", - "url": "dolor" - }, - "short_effect": "sunt" - } - ], - "flavor_text_entries": [ - { - "flavor_text": "nisi minim commodo irure minim", - "language": { - "name": "do do sint mollit", - "url": "occaecat" - }, - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 87, - "name": "ut sint", - "names": [ - { - "language": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "name": "et voluptate" - } - ], - "pokemon": [ - { - "is_hidden": false, - "pokemon": { - "name": "gloom", - "url": "https://pokeapi.co/api/v2/pokemon/44/" - }, - "slot": "3" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_ability_retrieve_responses] - - - - - -200 - - - - - - - -AbilityChange","children":[{"label":"AbilityChange","linkedLabel":"AbilityChange","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_changes [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes] - - - - - - - - - -#### AbilityChange [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange] - - - - - -AbilityChangeEffectText","children":[{"label":"AbilityChangeEffectText","linkedLabel":"AbilityChangeEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### effect_entries [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries] - - - - - - - - - -#### AbilityChangeEffectText [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext] - - - - - - - - - -##### effect [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_effect] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_effect_entries_abilitychangeeffecttext_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_changes_abilitychange_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -AbilityEffectText","children":[{"label":"AbilityEffectText","linkedLabel":"AbilityEffectText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### effect_entries [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries] - - - - - - - - - -#### AbilityEffectText [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext] - - - - - - - - - -##### effect [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_effect] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### short_effect [#operation-api_v2_ability_retrieve_responses_200_application-json_effect_entries_abilityeffecttext_short_effect] - - - - - - - - - - - - - -AbilityFlavorText","children":[{"label":"AbilityFlavorText","linkedLabel":"AbilityFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### AbilityFlavorText [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext] - - - - - - - - - -##### flavor_text [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_flavor_text] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_language_languagesummary_url] - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_flavor_text_entries_abilityflavortext_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation [#operation-api_v2_ability_retrieve_responses_200_application-json_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_generation_generationsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_ability_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_main_series [#operation-api_v2_ability_retrieve_responses_200_application-json_is_main_series] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_name] - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_ability_retrieve_responses_200_application-json_names] - - - - - - - - - -#### AbilityName [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_ability_retrieve_responses_200_application-json_names_abilityname_name] - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon [#operation-api_v2_ability_retrieve_responses_200_application-json_pokemon] - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/characteristic/ [#operation-api_v2_characteristic_list] - - - - - -_List charecterictics_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/characteristic/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_characteristic_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_characteristic_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_characteristic_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_characteristic_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_characteristic_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_characteristic_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_characteristic_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_characteristic_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_characteristic_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_characteristic_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_characteristic_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_characteristic_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_characteristic_list_responses_200_application-json_results] - - - - - - - - - -#### CharacteristicSummary [#operation-api_v2_characteristic_list_responses_200_application-json_results_characteristicsummary] - - - - - - - - - -##### url [#operation-api_v2_characteristic_list_responses_200_application-json_results_characteristicsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/characteristic/\{id\}/ [#operation-api_v2_characteristic_retrieve] - - - - - -_Get characteristic_ - - - - - -Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/characteristic/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_characteristic_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_characteristic_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_characteristic_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_characteristic_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_characteristic_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_characteristic_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "gene_modulo": 87, - "highest_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "id": 14, - "possible_values": [ - 56 - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_characteristic_retrieve_responses] - - - - - -200 - - - - - - - -CharacteristicDescription","children":[{"label":"CharacteristicDescription","linkedLabel":"CharacteristicDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### CharacteristicDescription [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription] - - - - - - - - - -##### description [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_characteristic_retrieve_responses_200_application-json_descriptions_characteristicdescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### gene_modulo [#operation-api_v2_characteristic_retrieve_responses_200_application-json_gene_modulo] - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### highest_stat [#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat] - - - - - - - - - -#### StatSummary [#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary] - - - - - - - - - -##### name [#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary_name] - - - - - - - - - -##### url [#operation-api_v2_characteristic_retrieve_responses_200_application-json_highest_stat_statsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_characteristic_retrieve_responses_200_application-json_id] - - - - - - - - - -##### possible_values [#operation-api_v2_characteristic_retrieve_responses_200_application-json_possible_values] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/egg-group/ [#operation-api_v2_egg_group_list] - - - - - -_List egg groups_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/egg-group/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_egg_group_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_egg_group_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_egg_group_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_egg_group_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_egg_group_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_egg_group_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_egg_group_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_egg_group_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_egg_group_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_egg_group_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_egg_group_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_egg_group_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -EggGroupSummary","children":[{"label":"EggGroupSummary","linkedLabel":"EggGroupSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_egg_group_list_responses_200_application-json_results] - - - - - - - - - -#### EggGroupSummary [#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary] - - - - - - - - - -##### name [#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_egg_group_list_responses_200_application-json_results_egggroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/egg-group/\{id\}/ [#operation-api_v2_egg_group_retrieve] - - - - - -_Get egg group_ - - - - - -Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/egg-group/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_egg_group_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_egg_group_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_egg_group_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_egg_group_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_egg_group_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_egg_group_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - {} - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_egg_group_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_egg_group_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_egg_group_retrieve_responses_200_application-json_name] - - - - - -EggGroupName","children":[{"label":"EggGroupName","linkedLabel":"EggGroupName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names] - - - - - - - - - -#### EggGroupName [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_egg_group_retrieve_responses_200_application-json_names_egggroupname_name] - - - - - - - - - - - - - -pokemon_specie","children":[{"label":"pokemon_specie","linkedLabel":"pokemon_specie","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### pokemon\_specie [#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie] - - - - - - - - - -##### name [#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_name] - - - - - -Pokemon species name. - - - - - -_Example:_ - -``` -bulbasaur -``` - - - - - - - - - -##### url [#operation-api_v2_egg_group_retrieve_responses_200_application-json_pokemon_species_pokemon_specie_url] - - - - - -The URL to get more information about the species - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon-species/1/ -``` - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/gender/ [#operation-api_v2_gender_list] - - - - - -_List genders_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/gender/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_gender_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_gender_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_gender_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_gender_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_gender_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_gender_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_gender_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_gender_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_gender_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_gender_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_gender_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_gender_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GenderSummary","children":[{"label":"GenderSummary","linkedLabel":"GenderSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_gender_list_responses_200_application-json_results] - - - - - - - - - -#### GenderSummary [#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary] - - - - - - - - - -##### name [#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary_name] - - - - - - - - - -##### url [#operation-api_v2_gender_list_responses_200_application-json_results_gendersummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/gender/\{id\}/ [#operation-api_v2_gender_retrieve] - - - - - -_Get gender_ - - - - - -Genders were introduced in Generation II for the purposes of breeding Pokémon but can also result in visual differences or even different evolutionary lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/gender/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_gender_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_gender_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_gender_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_gender_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_gender_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_gender_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "pokemon_species_details": [ - { - "pokemon_species": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon-species/1/" - }, - "rate": "1" - } - ], - "required_for_evolution": [ - { - "name": "wormadam", - "url": "https://pokeapi.co/api/v2/pokemon-species/413/" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_gender_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_gender_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_gender_retrieve_responses_200_application-json_name] - - - - - -pokemon_species_detail","children":[{"label":"pokemon_species_detail","linkedLabel":"pokemon_species_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species_details [#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details] - - - - - - - - - -#### pokemon\_species\_detail [#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail] - - - - - -pokemon_species","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon_species [#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail_pokemon_species] - - - - - - - - - - - - - -##### rate [#operation-api_v2_gender_retrieve_responses_200_application-json_pokemon_species_details_pokemon_species_detail_rate] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -required_for_evolution","children":[{"label":"required_for_evolution","linkedLabel":"required_for_evolution","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### required_for_evolution [#operation-api_v2_gender_retrieve_responses_200_application-json_required_for_evolution] - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/growth-rate/ [#operation-api_v2_growth_rate_list] - - - - - -_List growth rates_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/growth-rate/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_growth_rate_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_growth_rate_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_growth_rate_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_growth_rate_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_growth_rate_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_growth_rate_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_growth_rate_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_growth_rate_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_growth_rate_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_growth_rate_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_growth_rate_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_growth_rate_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -GrowthRateSummary","children":[{"label":"GrowthRateSummary","linkedLabel":"GrowthRateSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_growth_rate_list_responses_200_application-json_results] - - - - - - - - - -#### GrowthRateSummary [#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary] - - - - - - - - - -##### name [#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary_name] - - - - - - - - - -##### url [#operation-api_v2_growth_rate_list_responses_200_application-json_results_growthratesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/growth-rate/\{id\}/ [#operation-api_v2_growth_rate_retrieve] - - - - - -_Get growth rate_ - - - - - -Growth rates are the speed with which Pokémon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/growth-rate/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_growth_rate_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_growth_rate_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_growth_rate_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_growth_rate_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_growth_rate_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_growth_rate_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "formula": "reprehenderit ut dolore", - "id": 87, - "levels": [ - { - "experience": 14, - "level": 56 - } - ], - "name": "occaecat dolor sit", - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_growth_rate_retrieve_responses] - - - - - -200 - - - - - - - -GrowthRateDescription","children":[{"label":"GrowthRateDescription","linkedLabel":"GrowthRateDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### GrowthRateDescription [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription] - - - - - - - - - -##### description [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_descriptions_growthratedescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### formula [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_formula] - - - - - - - - - -##### id [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_id] - - - - - -Experience","children":[{"label":"Experience","linkedLabel":"Experience","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### levels [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels] - - - - - - - - - -#### Experience [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience] - - - - - - - - - -##### experience [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience_experience] - - - - - - - - - -##### level [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_levels_experience_level] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_name] - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_growth_rate_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-damage-class/ [#operation-api_v2_move_damage_class_list] - - - - - -_List move damage classes_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-damage-class/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_damage_class_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_damage_class_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_damage_class_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_damage_class_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_move_damage_class_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_move_damage_class_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_move_damage_class_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_damage_class_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_damage_class_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_move_damage_class_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_move_damage_class_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_move_damage_class_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -MoveDamageClassSummary","children":[{"label":"MoveDamageClassSummary","linkedLabel":"MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_move_damage_class_list_responses_200_application-json_results] - - - - - - - - - -#### MoveDamageClassSummary [#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary] - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_damage_class_list_responses_200_application-json_results_movedamageclasssummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/move-damage-class/\{id\}/ [#operation-api_v2_move_damage_class_retrieve] - - - - - -_Get move damage class_ - - - - - -Damage classes moves can have, e.g. physical, special, or non-damaging. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/move-damage-class/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_move_damage_class_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_move_damage_class_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_move_damage_class_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_move_damage_class_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_move_damage_class_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_move_damage_class_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "descriptions": [ - { - "language": { - "name": "ipsum eiusmod", - "url": "consequat do" - } - } - ], - "id": 87, - "moves": [ - { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - } - ], - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_move_damage_class_retrieve_responses] - - - - - -200 - - - - - - - -MoveDamageClassDescription","children":[{"label":"MoveDamageClassDescription","linkedLabel":"MoveDamageClassDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### descriptions [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions] - - - - - - - - - -#### MoveDamageClassDescription [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription] - - - - - - - - - -##### description [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_descriptions_movedamageclassdescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_id] - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### MoveSummary [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary] - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_moves_movesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_name] - - - - - -MoveDamageClassName","children":[{"label":"MoveDamageClassName","linkedLabel":"MoveDamageClassName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names] - - - - - - - - - -#### MoveDamageClassName [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_move_damage_class_retrieve_responses_200_application-json_names_movedamageclassname_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/nature/ [#operation-api_v2_nature_list] - - - - - -_List natures_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/nature/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_nature_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_nature_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_nature_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_nature_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_nature_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_nature_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_nature_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_nature_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_nature_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_nature_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_nature_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_nature_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -NatureSummary","children":[{"label":"NatureSummary","linkedLabel":"NatureSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_nature_list_responses_200_application-json_results] - - - - - - - - - -#### NatureSummary [#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary] - - - - - - - - - -##### name [#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_list_responses_200_application-json_results_naturesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/nature/\{id\}/ [#operation-api_v2_nature_retrieve] - - - - - -_Get nature_ - - - - - -Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/nature/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_nature_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_nature_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_nature_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_nature_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_nature_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_nature_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "berries": [ - { - "name": "ipsum eiusmod", - "url": "consequat do" - } - ], - "decreased_stat": { - "name": "reprehenderit ut dolore", - "url": "occaecat dolor sit" - }, - "hates_flavor": { - "name": "nostrud", - "url": "aute aliqua aute commodo" - }, - "id": 87, - "increased_stat": { - "name": "irure", - "url": "dolor" - }, - "likes_flavor": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "move_battle_style_preferences": [ - { - "high_hp_preference": 14, - "low_hp_preference": 56, - "move_battle_style": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "name": "fugiat", - "names": [ - { - "language": { - "name": "non nisi proident Lorem", - "url": "nostrud anim" - }, - "name": "exercitation aliqua sint" - } - ], - "pokeathlon_stat_changes": [ - { - "max_change": "1", - "pokeathlon_stat": { - "name": "power", - "url": "https://pokeapi.co/api/v2/pokeathlon-stat/2/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_nature_retrieve_responses] - - - - - -200 - - - - - - - -BerrySummary","children":[{"label":"BerrySummary","linkedLabel":"BerrySummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### berries [#operation-api_v2_nature_retrieve_responses_200_application-json_berries] - - - - - - - - - -#### BerrySummary [#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_berries_berrysummary_url] - - - - - - - - - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### decreased_stat [#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat] - - - - - - - - - -#### StatSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_decreased_stat_statsummary_url] - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### hates_flavor [#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor] - - - - - - - - - -#### BerryFlavorSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_hates_flavor_berryflavorsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_nature_retrieve_responses_200_application-json_id] - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### increased_stat [#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat] - - - - - - - - - -#### StatSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_increased_stat_statsummary_url] - - - - - - - - - - - - - -BerryFlavorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### likes_flavor [#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor] - - - - - - - - - -#### BerryFlavorSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_likes_flavor_berryflavorsummary_url] - - - - - - - - - - - - - -NatureBattleStylePreference","children":[{"label":"NatureBattleStylePreference","linkedLabel":"NatureBattleStylePreference","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_battle_style_preferences [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences] - - - - - - - - - -#### NatureBattleStylePreference [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference] - - - - - - - - - -##### high_hp_preference [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_high_hp_preference] - - - - - - - - - -##### low_hp_preference [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_low_hp_preference] - - - - - -MoveBattleStyleSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_battle_style [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style] - - - - - - - - - -#### MoveBattleStyleSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_move_battle_style_preferences_naturebattlestylepreference_move_battle_style_movebattlestylesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_name] - - - - - -NatureName","children":[{"label":"NatureName","linkedLabel":"NatureName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_nature_retrieve_responses_200_application-json_names] - - - - - - - - - -#### NatureName [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_nature_retrieve_responses_200_application-json_names_naturename_name] - - - - - - - - - - - - - -pokeathlon_stat_change","children":[{"label":"pokeathlon_stat_change","linkedLabel":"pokeathlon_stat_change","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokeathlon_stat_changes [#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes] - - - - - - - - - -#### pokeathlon\_stat\_change [#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change] - - - - - - - - - -##### max_change [#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change_max_change] - - - - - -_Example:_ - -``` -1 -``` - - - - - -pokeathlon_stat","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokeathlon_stat [#operation-api_v2_nature_retrieve_responses_200_application-json_pokeathlon_stat_changes_pokeathlon_stat_change_pokeathlon_stat] - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/ [#operation-api_v2_pokemon_list] - - - - - -_List pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSummary","children":[{"label":"PokemonSummary","linkedLabel":"PokemonSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonSummary [#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_list_responses_200_application-json_results_pokemonsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon/\{id\}/ [#operation-api_v2_pokemon_retrieve] - - - - - -_Get pokemon_ - - - - - -Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon. Each Pokémon belongs to a specific species but may take on a variant which makes it differ from other Pokémon of the same species, such as base stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 1, - "name": "Rambo", - "base_experience": 64, - "height": 7, - "is_legendary": false, - "is_mythical": false, - "order": 1, - "weight": 60 -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_retrieve_responses] - - - - - -200 - - - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### abilities [#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities] - - - - - - - - - -#### ability [#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability] - - - - - - - - - -##### is_hidden [#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability_is_hidden] - - - - - - - - - -##### slot [#operation-api_v2_pokemon_retrieve_responses_200_application-json_abilities_ability_slot] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### base_experience [#operation-api_v2_pokemon_retrieve_responses_200_application-json_base_experience] - - - - - -cries","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### cries [#operation-api_v2_pokemon_retrieve_responses_200_application-json_cries] - - - - - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### forms [#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms] - - - - - - - - - -#### PokemonFormSummary [#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_retrieve_responses_200_application-json_forms_pokemonformsummary_url] - - - - - - - - - - - - - -PokemonGameIndex","children":[{"label":"PokemonGameIndex","linkedLabel":"PokemonGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices] - - - - - - - - - -#### PokemonGameIndex [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex] - - - - - - - - - -##### game_index [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_game_index] - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version] - - - - - - - - - -#### VersionSummary [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_retrieve_responses_200_application-json_game_indices_pokemongameindex_version_versionsummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### height [#operation-api_v2_pokemon_retrieve_responses_200_application-json_height] - - - - - -held_item","children":[{"label":"held_item","linkedLabel":"held_item","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### held_items [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items] - - - - - - - - - -#### held\_item [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item] - - - - - -item","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### item [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_item] - - - - - - - - - -version_detail","children":[{"label":"version_detail","linkedLabel":"version_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_details [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details] - - - - - - - - - -#### version\_detail [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail] - - - - - - - - - -##### rarity [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail_rarity] - - - - - -_Example:_ - -``` -5 -``` - - - - - -version","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_pokemon_retrieve_responses_200_application-json_held_items_held_item_version_details_version_detail_version] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_default [#operation-api_v2_pokemon_retrieve_responses_200_application-json_is_default] - - - - - - - - - -##### location_area_encounters [#operation-api_v2_pokemon_retrieve_responses_200_application-json_location_area_encounters] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/pokemon/1/encounters -``` - - - - - -move","children":[{"label":"move","linkedLabel":"move","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### move [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move] - - - - - -version_group_detail","children":[{"label":"version_group_detail","linkedLabel":"version_group_detail","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group_details [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details] - - - - - - - - - -#### version\_group\_detail [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail] - - - - - - - - - -##### level_learned_at [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_level_learned_at] - - - - - -_Example:_ - -``` -1 -``` - - - - - -move_learn_method","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### move_learn_method [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_move_learn_method] - - - - - - - - - -version_group","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version_group [#operation-api_v2_pokemon_retrieve_responses_200_application-json_moves_move_version_group_details_version_group_detail_version_group] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pokemon_retrieve_responses_200_application-json_name] - - - - - - - - - -##### order [#operation-api_v2_pokemon_retrieve_responses_200_application-json_order] - - - - - -past_ability","children":[{"label":"past_ability","linkedLabel":"past_ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_abilities [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities] - - - - - - - - - -#### past\_ability [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability] - - - - - -ability","children":[{"label":"ability","linkedLabel":"ability","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### abilities [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities] - - - - - - - - - -#### ability [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability] - - - - - - - - - -##### is_hidden [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability_is_hidden] - - - - - - - - - -##### slot [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_abilities_ability_slot] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_abilities_past_ability_generation] - - - - - - - - - - - - - - - - - -past_type","children":[{"label":"past_type","linkedLabel":"past_type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_types [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types] - - - - - - - - - -#### past\_type [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type] - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_generation] - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### types [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types] - - - - - - - - - -#### type [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types_type] - - - - - - - - - -##### slot [#operation-api_v2_pokemon_retrieve_responses_200_application-json_past_types_past_type_types_type_slot] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### species [#operation-api_v2_pokemon_retrieve_responses_200_application-json_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_retrieve_responses_200_application-json_species_pokemonspeciessummary_url] - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites [#operation-api_v2_pokemon_retrieve_responses_200_application-json_sprites] - - - - - - - - - -PokemonStat","children":[{"label":"PokemonStat","linkedLabel":"PokemonStat","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### stats [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats] - - - - - - - - - -#### PokemonStat [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat] - - - - - - - - - -##### base_stat [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_base_stat] - - - - - - - - - -##### effort [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_effort] - - - - - -StatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### stat [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat] - - - - - - - - - -#### StatSummary [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_retrieve_responses_200_application-json_stats_pokemonstat_stat_statsummary_url] - - - - - - - - - - - - - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types [#operation-api_v2_pokemon_retrieve_responses_200_application-json_types] - - - - - - - - - -#### type [#operation-api_v2_pokemon_retrieve_responses_200_application-json_types_type] - - - - - - - - - -##### slot [#operation-api_v2_pokemon_retrieve_responses_200_application-json_types_type_slot] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - - - - - -##### weight [#operation-api_v2_pokemon_retrieve_responses_200_application-json_weight] - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-color/ [#operation-api_v2_pokemon_color_list] - - - - - -_List pokemon colors_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-color/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_color_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_color_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_color_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_color_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_color_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_color_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_color_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_color_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_color_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_color_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_color_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_color_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonColorSummary","children":[{"label":"PokemonColorSummary","linkedLabel":"PokemonColorSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_color_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonColorSummary [#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_color_list_responses_200_application-json_results_pokemoncolorsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-color/\{id\}/ [#operation-api_v2_pokemon_color_retrieve] - - - - - -_Get pokemon color_ - - - - - -Colors used for sorting Pokémon in a Pokédex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-color/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_color_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_color_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_color_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_color_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_color_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_color_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_color_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_name] - - - - - -PokemonColorName","children":[{"label":"PokemonColorName","linkedLabel":"PokemonColorName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names] - - - - - - - - - -#### PokemonColorName [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_names_pokemoncolorname_name] - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_color_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-form/ [#operation-api_v2_pokemon_form_list] - - - - - -_List pokemon forms_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-form/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_form_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_form_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_form_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_form_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_form_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_form_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_form_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_form_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_form_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_form_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_form_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_form_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonFormSummary","children":[{"label":"PokemonFormSummary","linkedLabel":"PokemonFormSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_form_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonFormSummary [#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_form_list_responses_200_application-json_results_pokemonformsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-form/\{id\}/ [#operation-api_v2_pokemon_form_retrieve] - - - - - -_Get pokemon form_ - - - - - -Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-form/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_form_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_form_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_form_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_form_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_form_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_form_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "form_name": "ipsum eiusmod", - "form_names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "id": 87, - "name": "nostrud", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "Plant Cloak" - } - ], - "pokemon": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "sprites": {}, - "types": [ - { - "slot": "1", - "type": { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - } - ], - "version_group": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_form_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### form_name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_name] - - - - - -form_name","children":[{"label":"form_name","linkedLabel":"form_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_names [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names] - - - - - - - - - -#### form\_name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name] - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name_language] - - - - - - - - - - - - - -##### name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_names_form_name_name] - - - - - -_Example:_ - -``` -Plant Cloak -``` - - - - - - - - - - - - - - - - - -##### form_order [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_form_order] - - - - - - - - - -##### id [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_battle_only [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_battle_only] - - - - - - - - - -##### is_default [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_default] - - - - - - - - - -##### is_mega [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_is_mega] - - - - - - - - - -##### name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_name] - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names] - - - - - - - - - -#### name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names_name] - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_names_name_language] - - - - - - - - - - - - - - - - - - - - - -##### order [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_order] - - - - - -PokemonSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon] - - - - - - - - - -#### PokemonSummary [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_pokemon_pokemonsummary_url] - - - - - - - - - - - - - -sprites","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_sprites] - - - - - - - - - -type","children":[{"label":"type","linkedLabel":"type","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### types [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types] - - - - - - - - - -#### type [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types_type] - - - - - - - - - -##### slot [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_types_type_slot] - - - - - -_Example:_ - -``` -1 -``` - - - - - - - - - - - - - -VersionGroupSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### version_group [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group] - - - - - - - - - -#### VersionGroupSummary [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_form_retrieve_responses_200_application-json_version_group_versiongroupsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-habitat/ [#operation-api_v2_pokemon_habitat_list] - - - - - -_List pokemom habitas_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-habitat/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_habitat_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_habitat_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_habitat_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_habitat_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_habitat_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_habitat_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_habitat_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_habitat_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_habitat_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonHabitatSummary","children":[{"label":"PokemonHabitatSummary","linkedLabel":"PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonHabitatSummary [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_habitat_list_responses_200_application-json_results_pokemonhabitatsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-habitat/\{id\}/ [#operation-api_v2_pokemon_habitat_retrieve] - - - - - -_Get pokemom habita_ - - - - - -Habitats are generally different terrain Pokémon can be found in but can also be areas designated for rare or legendary Pokémon. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-habitat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_habitat_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_habitat_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_habitat_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_habitat_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_habitat_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_habitat_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "name": "ipsum eiusmod", - "names": [ - { - "language": { - "name": "consequat do", - "url": "reprehenderit ut dolore" - }, - "name": "occaecat dolor sit" - } - ], - "pokemon_species": [ - { - "name": "nostrud", - "url": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_habitat_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_name] - - - - - -PokemonHabitatName","children":[{"label":"PokemonHabitatName","linkedLabel":"PokemonHabitatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names] - - - - - - - - - -#### PokemonHabitatName [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_names_pokemonhabitatname_name] - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_habitat_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-shape/ [#operation-api_v2_pokemon_shape_list] - - - - - -_List pokemon shapes_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-shape/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_shape_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_shape_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_shape_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_shape_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_shape_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_shape_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_shape_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_shape_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_shape_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_shape_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_shape_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_shape_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonShapeSummary","children":[{"label":"PokemonShapeSummary","linkedLabel":"PokemonShapeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_shape_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonShapeSummary [#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_shape_list_responses_200_application-json_results_pokemonshapesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-shape/\{id\}/ [#operation-api_v2_pokemon_shape_retrieve] - - - - - -_Get pokemon shape_ - - - - - -Shapes used for sorting Pokémon in a Pokédex. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-shape/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_shape_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_shape_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_shape_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_shape_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_shape_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_shape_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "awesome_names": [ - { - "awesome_name": "Pomaceous", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "id": 87, - "name": "occaecat dolor sit", - "names": [ - { - "name": "Ball", - "url": "https://pokeapi.co/api/v2/language/9/" - } - ], - "pokemon_species": [ - { - "name": "irure", - "url": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_shape_retrieve_responses] - - - - - -200 - - - - - - - -awesome_name","children":[{"label":"awesome_name","linkedLabel":"awesome_name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### awesome_names [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names] - - - - - - - - - -#### awesome\_name [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names_awesome_name] - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_awesome_names_awesome_name_language] - - - - - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_name] - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names] - - - - - - - - - -#### name [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_names_name_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/language/9/ -``` - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon_species [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_shape_retrieve_responses_200_application-json_pokemon_species_pokemonspeciessummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-species/ [#operation-api_v2_pokemon_species_list] - - - - - -_List pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-species/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_species_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_species_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_species_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_species_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokemon_species_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokemon_species_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokemon_species_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_species_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_species_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokemon_species_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokemon_species_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokemon_species_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokemonSpeciesSummary","children":[{"label":"PokemonSpeciesSummary","linkedLabel":"PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokemon_species_list_responses_200_application-json_results] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_list_responses_200_application-json_results_pokemonspeciessummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokemon-species/\{id\}/ [#operation-api_v2_pokemon_species_retrieve] - - - - - -_Get pokemon species_ - - - - - -A Pokémon Species forms the basis for at least one Pokémon. Attributes of a Pokémon species are shared across all varieties of Pokémon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokemon-species/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokemon_species_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokemon_species_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokemon_species_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokemon_species_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokemon_species_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokemon_species_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "color": { - "name": "ipsum eiusmod", - "url": "consequat do" - }, - "egg_groups": [ - { - "name": "monster", - "url": "https://pokeapi.co/api/v2/egg-group/1/" - } - ], - "evolution_chain": { - "url": "nostrud" - }, - "evolves_from_species": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "flavor_text_entries": [ - { - "flavor_text": "dolor", - "language": { - "name": "sunt", - "url": "nisi minim commodo irure minim" - }, - "version": { - "name": "do do sint mollit", - "url": "occaecat" - } - } - ], - "form_descriptions": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "genera": [ - { - "genus": "Seed Pokémon", - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - } - } - ], - "generation": { - "name": "dolor voluptate eu", - "url": "quis minim non magna quis" - }, - "growth_rate": { - "name": "et voluptate", - "url": "commodo labore aliqua ad" - }, - "habitat": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "id": 87, - "name": "proident", - "names": [ - { - "language": { - "name": "en", - "url": "https://pokeapi.co/api/v2/language/9/" - }, - "name": "bulbasaur" - } - ], - "pal_park_encounters": [ - { - "area": { - "name": "field", - "url": "https://pokeapi.co/api/v2/pal-park-area/2/" - }, - "base_score": "50", - "rate": "30" - } - ], - "pokedex_numbers": [ - { - "entry_number": 91, - "pokedex": { - "name": "sunt amet", - "url": "duis ea" - } - } - ], - "shape": { - "name": "nisi laborum", - "url": "cupidatat nulla velit" - }, - "varieties": [ - { - "is_default": false, - "pokemon": { - "name": "bulbasaur", - "url": "https://pokeapi.co/api/v2/pokemon/1/" - } - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokemon_species_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### base_happiness [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_base_happiness] - - - - - - - - - -##### capture_rate [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_capture_rate] - - - - - -PokemonColorSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### color [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color] - - - - - - - - - -#### PokemonColorSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_color_pokemoncolorsummary_url] - - - - - - - - - - - - - -egg_group","children":[{"label":"egg_group","linkedLabel":"egg_group","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### egg_groups [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups] - - - - - - - - - -#### egg\_group [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group_name] - - - - - -_Example:_ - -``` -monster -``` - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_egg_groups_egg_group_url] - - - - - -_Example:_ - -``` -https://pokeapi.co/api/v2/egg-group/1/ -``` - - - - - - - - - - - - - -EvolutionChainSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolution_chain [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain] - - - - - - - - - -#### EvolutionChainSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain_evolutionchainsummary] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolution_chain_evolutionchainsummary_url] - - - - - - - - - - - - - -PokemonSpeciesSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### evolves_from_species [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species] - - - - - - - - - -#### PokemonSpeciesSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_evolves_from_species_pokemonspeciessummary_url] - - - - - - - - - - - - - -PokemonSpeciesFlavorText","children":[{"label":"PokemonSpeciesFlavorText","linkedLabel":"PokemonSpeciesFlavorText","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### flavor_text_entries [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries] - - - - - - - - - -#### PokemonSpeciesFlavorText [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext] - - - - - - - - - -##### flavor_text [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_flavor_text] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_language_languagesummary_url] - - - - - - - - - - - - - -VersionSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### version [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version] - - - - - - - - - -#### VersionSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_flavor_text_entries_pokemonspeciesflavortext_version_versionsummary_url] - - - - - - - - - - - - - - - - - - - - - -PokemonSpeciesDescription","children":[{"label":"PokemonSpeciesDescription","linkedLabel":"PokemonSpeciesDescription","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### form_descriptions [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions] - - - - - - - - - -#### PokemonSpeciesDescription [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription] - - - - - - - - - -##### description [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_description] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_form_descriptions_pokemonspeciesdescription_language_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - - - - - -##### forms_switchable [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_forms_switchable] - - - - - - - - - -##### gender_rate [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_gender_rate] - - - - - -genus","children":[{"label":"genus","linkedLabel":"genus","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### genera [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera] - - - - - - - - - -#### genus [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera_genus] - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_genera_genus_language] - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_generation_generationsummary_url] - - - - - - - - - - - - - -GrowthRateSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### growth_rate [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate] - - - - - - - - - -#### GrowthRateSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_growth_rate_growthratesummary_url] - - - - - - - - - - - - - -PokemonHabitatSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### habitat [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat] - - - - - - - - - -#### PokemonHabitatSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_habitat_pokemonhabitatsummary_url] - - - - - - - - - - - - - - - - - -##### has_gender_differences [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_has_gender_differences] - - - - - - - - - -##### hatch_counter [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_hatch_counter] - - - - - - - - - -##### id [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_baby [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_baby] - - - - - - - - - -##### is_legendary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_legendary] - - - - - - - - - -##### is_mythical [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_is_mythical] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_name] - - - - - -name","children":[{"label":"name","linkedLabel":"name","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names] - - - - - - - - - -#### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names_name] - - - - - -language","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_names_name_language] - - - - - - - - - - - - - - - - - - - - - -##### order [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_order] - - - - - -pal_park_encounter","children":[{"label":"pal_park_encounter","linkedLabel":"pal_park_encounter","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pal_park_encounters [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters] - - - - - - - - - -#### pal\_park\_encounter [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter] - - - - - -area","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### area [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_area] - - - - - - - - - - - - - -##### base_score [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_base_score] - - - - - -_Example:_ - -``` -50 -``` - - - - - - - - - -##### rate [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pal_park_encounters_pal_park_encounter_rate] - - - - - -_Example:_ - -``` -30 -``` - - - - - - - - - - - - - -PokemonDexEntry","children":[{"label":"PokemonDexEntry","linkedLabel":"PokemonDexEntry","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokedex_numbers [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers] - - - - - - - - - -#### PokemonDexEntry [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry] - - - - - - - - - -##### entry_number [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_entry_number] - - - - - -PokedexSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokedex [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex] - - - - - - - - - -#### PokedexSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_pokedex_numbers_pokemondexentry_pokedex_pokedexsummary_url] - - - - - - - - - - - - - - - - - - - - - -PokemonShapeSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### shape [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape] - - - - - - - - - -#### PokemonShapeSummary [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary] - - - - - - - - - -##### name [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_shape_pokemonshapesummary_url] - - - - - - - - - - - - - -variety","children":[{"label":"variety","linkedLabel":"variety","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### varieties [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties] - - - - - - - - - -#### variety [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety] - - - - - - - - - -##### is_default [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety_is_default] - - - - - -pokemon","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### pokemon [#operation-api_v2_pokemon_species_retrieve_responses_200_application-json_varieties_variety_pokemon] - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokeathlon-stat/ [#operation-api_v2_pokeathlon_stat_list] - - - - - -_List pokeathlon stats_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokeathlon-stat/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokeathlon_stat_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokeathlon_stat_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokeathlon_stat_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokeathlon_stat_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_pokeathlon_stat_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_pokeathlon_stat_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_pokeathlon_stat_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokeathlon_stat_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokeathlon_stat_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -PokeathlonStatSummary","children":[{"label":"PokeathlonStatSummary","linkedLabel":"PokeathlonStatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results] - - - - - - - - - -#### PokeathlonStatSummary [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary] - - - - - - - - - -##### name [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokeathlon_stat_list_responses_200_application-json_results_pokeathlonstatsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/pokeathlon-stat/\{id\}/ [#operation-api_v2_pokeathlon_stat_retrieve] - - - - - -_Get pokeathlon stat_ - - - - - -Pokeathlon Stats are different attributes of a Pokémon's performance in Pokéathlons. In Pokéathlons, competitions happen on different courses; one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) for greater detail. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/pokeathlon-stat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_pokeathlon_stat_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_pokeathlon_stat_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_pokeathlon_stat_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_pokeathlon_stat_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_pokeathlon_stat_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_pokeathlon_stat_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "affecting_natures": { - "decrease": [ - { - "max_change": "-1", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ], - "increase": [ - { - "max_change": "2", - "nature": { - "name": "hardy", - "url": "https://pokeapi.co/api/v2/nature/1/" - } - } - ] - }, - "id": 56, - "name": "nostrud", - "names": [ - { - "language": { - "name": "aute aliqua aute commodo", - "url": "irure" - }, - "name": "dolor" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_pokeathlon_stat_retrieve_responses] - - - - - -200 - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_affecting_natures] - - - - - - - - - - - - - -##### id [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_id] - - - - - - - - - -##### name [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_name] - - - - - -PokeathlonStatName","children":[{"label":"PokeathlonStatName","linkedLabel":"PokeathlonStatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names] - - - - - - - - - -#### PokeathlonStatName [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_pokeathlon_stat_retrieve_responses_200_application-json_names_pokeathlonstatname_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/stat/ [#operation-api_v2_stat_list] - - - - - -_List stats_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/stat/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_stat_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_stat_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_stat_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_stat_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_stat_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_stat_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_stat_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_stat_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_stat_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_stat_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_stat_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_stat_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -StatSummary","children":[{"label":"StatSummary","linkedLabel":"StatSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_stat_list_responses_200_application-json_results] - - - - - - - - - -#### StatSummary [#operation-api_v2_stat_list_responses_200_application-json_results_statsummary] - - - - - - - - - -##### name [#operation-api_v2_stat_list_responses_200_application-json_results_statsummary_name] - - - - - - - - - -##### url [#operation-api_v2_stat_list_responses_200_application-json_results_statsummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/stat/\{id\}/ [#operation-api_v2_stat_retrieve] - - - - - -_Get stat_ - - - - - -Stats determine certain aspects of battles. Each Pokémon has a value for each stat which grows as they gain levels and can be altered momentarily by effects in battles. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/stat/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_stat_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_stat_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_stat_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_stat_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_stat_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_stat_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "affecting_moves": { - "decrease": [ - { - "change": "5", - "move": { - "name": "growl", - "url": "https://pokeapi.co/api/v2/move/45/" - } - } - ], - "increase": [ - { - "change": "-1", - "move": { - "name": "swords-dance", - "url": "https://pokeapi.co/api/v2/move/14/" - } - } - ] - }, - "affecting_natures": { - "decrease": [ - { - "name": "bold", - "url": "https://pokeapi.co/api/v2/nature/2/" - } - ], - "increase": [ - { - "name": "lonely", - "url": "https://pokeapi.co/api/v2/nature/6/" - } - ] - }, - "characteristics": [ - { - "url": "sunt" - } - ], - "game_index": 56, - "id": 91, - "move_damage_class": { - "name": "nisi minim commodo irure minim", - "url": "do do sint mollit" - }, - "name": "occaecat", - "names": [ - { - "language": { - "name": "fugiat", - "url": "non nisi proident Lorem" - }, - "name": "nostrud anim" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_stat_retrieve_responses] - - - - - -200 - - - - - - - -affecting_moves","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_moves [#operation-api_v2_stat_retrieve_responses_200_application-json_affecting_moves] - - - - - - - - - -affecting_natures","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### affecting_natures [#operation-api_v2_stat_retrieve_responses_200_application-json_affecting_natures] - - - - - - - - - -CharacteristicSummary","children":[{"label":"CharacteristicSummary","linkedLabel":"CharacteristicSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### characteristics [#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics] - - - - - - - - - -#### CharacteristicSummary [#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics_characteristicsummary] - - - - - - - - - -##### url [#operation-api_v2_stat_retrieve_responses_200_application-json_characteristics_characteristicsummary_url] - - - - - - - - - - - - - - - - - -##### game_index [#operation-api_v2_stat_retrieve_responses_200_application-json_game_index] - - - - - - - - - -##### id [#operation-api_v2_stat_retrieve_responses_200_application-json_id] - - - - - - - - - -##### is_battle_only [#operation-api_v2_stat_retrieve_responses_200_application-json_is_battle_only] - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class [#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class] - - - - - - - - - -#### MoveDamageClassSummary [#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary] - - - - - - - - - -##### name [#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_name] - - - - - - - - - -##### url [#operation-api_v2_stat_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_stat_retrieve_responses_200_application-json_name] - - - - - -StatName","children":[{"label":"StatName","linkedLabel":"StatName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_stat_retrieve_responses_200_application-json_names] - - - - - - - - - -#### StatName [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_stat_retrieve_responses_200_application-json_names_statname_name] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/type/ [#operation-api_v2_type_list] - - - - - -_List types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/type/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_type_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_type_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_type_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_type_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_type_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_type_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_type_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_type_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_type_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_type_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_type_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_type_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -TypeSummary","children":[{"label":"TypeSummary","linkedLabel":"TypeSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_type_list_responses_200_application-json_results] - - - - - - - - - -#### TypeSummary [#operation-api_v2_type_list_responses_200_application-json_results_typesummary] - - - - - - - - - -##### name [#operation-api_v2_type_list_responses_200_application-json_results_typesummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_list_responses_200_application-json_results_typesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/type/\{id\}/ [#operation-api_v2_type_retrieve] - - - - - -_Get types_ - - - - - -Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/type/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_type_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_type_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_type_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_type_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_type_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_type_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "game_indices": [ - { - "game_index": 87, - "generation": { - "name": "fugiat", - "url": "non nisi proident Lorem" - } - } - ], - "generation": { - "name": "nostrud anim", - "url": "exercitation aliqua sint" - }, - "id": 14, - "move_damage_class": { - "name": "ut sint", - "url": "dolor voluptate eu" - }, - "moves": [ - { - "name": "quis minim non magna quis", - "url": "et voluptate" - } - ], - "name": "commodo labore aliqua ad", - "names": [ - { - "language": { - "name": "elit culpa est non", - "url": "dolore aliqua eu" - }, - "name": "proident" - } - ], - "past_damage_relations": [ - { - "damage_relations": { - "double_damage_from": [ - { - "name": "water", - "url": "https://pokeapi.co/api/v2/type/11/" - } - ], - "double_damage_to": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_from": [ - { - "name": "poison", - "url": "https://pokeapi.co/api/v2/type/4/" - } - ], - "half_damage_to": [ - { - "name": "bug", - "url": "https://pokeapi.co/api/v2/type/7/" - } - ], - "no_damage_from": [ - { - "name": "electric", - "url": "https://pokeapi.co/api/v2/type/13/" - } - ], - "no_damage_to": [ - { - "name": "flying", - "url": "https://pokeapi.co/api/v2/type/3/" - } - ] - }, - "generation": { - "name": "generation-v", - "url": "https://pokeapi.co/api/v2/generation/5/" - } - } - ], - "pokemon": [ - {} - ], - "sprites": [ - [ - {} - ] - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_type_retrieve_responses] - - - - - -200 - - - - - - - -Serializer for the Type resource - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### damage_relations [#operation-api_v2_type_retrieve_responses_200_application-json_damage_relations] - - - - - - - - - -TypeGameIndex","children":[{"label":"TypeGameIndex","linkedLabel":"TypeGameIndex","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### game_indices [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices] - - - - - - - - - -#### TypeGameIndex [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex] - - - - - - - - - -##### game_index [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_game_index] - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_retrieve_responses_200_application-json_game_indices_typegameindex_generation_generationsummary_url] - - - - - - - - - - - - - - - - - - - - - -GenerationSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### generation [#operation-api_v2_type_retrieve_responses_200_application-json_generation] - - - - - - - - - -#### GenerationSummary [#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary] - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_retrieve_responses_200_application-json_generation_generationsummary_url] - - - - - - - - - - - - - - - - - -##### id [#operation-api_v2_type_retrieve_responses_200_application-json_id] - - - - - -MoveDamageClassSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### move_damage_class [#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class] - - - - - - - - - -#### MoveDamageClassSummary [#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary] - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_retrieve_responses_200_application-json_move_damage_class_movedamageclasssummary_url] - - - - - - - - - - - - - -MoveSummary","children":[{"label":"MoveSummary","linkedLabel":"MoveSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### moves [#operation-api_v2_type_retrieve_responses_200_application-json_moves] - - - - - - - - - -#### MoveSummary [#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary] - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_retrieve_responses_200_application-json_moves_movesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_name] - - - - - -AbilityName","children":[{"label":"AbilityName","linkedLabel":"AbilityName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_type_retrieve_responses_200_application-json_names] - - - - - - - - - -#### AbilityName [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_type_retrieve_responses_200_application-json_names_abilityname_name] - - - - - - - - - - - - - -past_damage_relation","children":[{"label":"past_damage_relation","linkedLabel":"past_damage_relation","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### past_damage_relations [#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations] - - - - - - - - - -#### past\_damage\_relation [#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation] - - - - - -damage_relations","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### damage_relations [#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation_damage_relations] - - - - - - - - - -generation","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### generation [#operation-api_v2_type_retrieve_responses_200_application-json_past_damage_relations_past_damage_relation_generation] - - - - - - - - - - - - - - - - - -pokemon","children":[{"label":"pokemon","linkedLabel":"pokemon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### pokemon [#operation-api_v2_type_retrieve_responses_200_application-json_pokemon] - - - - - - - - - -sprites","children":[{"label":"map","linkedLabel":"sprites","children":[{"label":"sprites","linkedLabel":"sprites","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### sprites [#operation-api_v2_type_retrieve_responses_200_application-json_sprites] - - - - - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/endpoint/utility/page.mdx b/examples/nextra/src/app/pokeapi/api/endpoint/utility/page.mdx deleted file mode 100644 index 0fe2e1efb..000000000 --- a/examples/nextra/src/app/pokeapi/api/endpoint/utility/page.mdx +++ /dev/null @@ -1,961 +0,0 @@ ---- -sidebarTitle: Utility ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - CodeSample, - CodeSampleTab, - CodeSampleTabbedSection, - ExpandableBreakout, - ExpandableBreakoutProperties, - ExpandableBreakoutTitle, - ExpandableProperty, - ExpandablePropertyBreakouts, - ExpandablePropertyDescription, - ExpandablePropertyExamples, - ExpandablePropertyTitle, - ExpandableSection, - Operation, - OperationCodeSamplesSection, - OperationDescriptionSection, - OperationParametersSection, - OperationResponseBodyExamplesSection, - OperationResponseBodySection, - OperationSecuritySection, - OperationSummarySection, - OperationTitleSection, - Pill, - ResponseExamplesTab, - ResponseExamplesTabbedSection, - ResponseTab, - ResponseTabbedSection, - Section, - SectionContent, - SectionTitle, - Tag, - TagTitle -} from "@speakeasy-api/docs-md-react"; - - - - - -# Utility Endpoints - - - - - - - - - -## GET /api/v2/language/ [#operation-api_v2_language_list] - - - - - -_List languages_ - - - - - -Languages for translations of API resource information. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/language/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_language_list_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_language_list_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_language_list_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_language_list_parameters] - - - - - - - - - - - -##### limit [#operation-api_v2_language_list_parameters_limit] - - - - - -Number of results to return per page. - - - - - - - - - -##### offset [#operation-api_v2_language_list_parameters_offset] - - - - - -The initial index from which to return the results. - - - - - - - - - -##### q [#operation-api_v2_language_list_parameters_q] - - - - - -> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) -Case-insensitive query applied on the `name` property. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_language_list_responses-examples] - - - - - -200 - - - - - -```json -{} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_language_list_responses] - - - - - -200 - - - - - - - - - - - -##### count [#operation-api_v2_language_list_responses_200_application-json_count] - - - - - -_Example:_ - -``` -123 -``` - - - - - - - - - -##### next [#operation-api_v2_language_list_responses_200_application-json_next] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=400&limit=100 -``` - - - - - - - - - -##### previous [#operation-api_v2_language_list_responses_200_application-json_previous] - - - - - -_Example:_ - -``` -http://api.example.org/accounts/?offset=200&limit=100 -``` - - - - - -LanguageSummary","children":[{"label":"LanguageSummary","linkedLabel":"LanguageSummary","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### results [#operation-api_v2_language_list_responses_200_application-json_results] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_language_list_responses_200_application-json_results_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_language_list_responses_200_application-json_results_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_language_list_responses_200_application-json_results_languagesummary_url] - - - - - - - - - - - - - - - - - - - - - -     - - - - - -## GET /api/v2/language/\{id\}/ [#operation-api_v2_language_retrieve] - - - - - -_Get language_ - - - - - -Languages for translations of API resource information. - - - - - - - - - -cURL - - - - - - - -```curl -curl https://pokeapi.co/api/v2/language/{id}/ \ - -X GET -``` - - - - - - - - - - - -
    - - - -### Security [#operation-api_v2_language_retrieve_security] - - - - - - - - - - - -##### cookieAuth [#operation-api_v2_language_retrieve_security_cookieauth] - - - - - - - - - -##### basicAuth [#operation-api_v2_language_retrieve_security_basicauth] - - - - - - - - - -
    - -     - - - -
    - - - -### Parameters [#operation-api_v2_language_retrieve_parameters] - - - - - - - - - - - -##### id [#operation-api_v2_language_retrieve_parameters_id] - - - - - -This parameter can be a string or an integer. - - - - - - - - - -
    - -     - - - - - - - -### Responses Examples [#operation-api_v2_language_retrieve_responses-examples] - - - - - -200 - - - - - -```json -{ - "id": 87, - "iso3166": "ipsum eiusmod", - "iso639": "consequat do", - "name": "reprehenderit ut dolore", - "names": [ - { - "language": { - "name": "occaecat dolor sit", - "url": "nostrud" - }, - "name": "aute aliqua aute commodo" - } - ] -} -``` - - - - - - - - - - - - - -### Responses [#operation-api_v2_language_retrieve_responses] - - - - - -200 - - - - - - - - - - - -##### id [#operation-api_v2_language_retrieve_responses_200_application-json_id] - - - - - - - - - -##### iso3166 [#operation-api_v2_language_retrieve_responses_200_application-json_iso3166] - - - - - - - - - -##### iso639 [#operation-api_v2_language_retrieve_responses_200_application-json_iso639] - - - - - - - - - -##### name [#operation-api_v2_language_retrieve_responses_200_application-json_name] - - - - - -LanguageName","children":[{"label":"LanguageName","linkedLabel":"LanguageName","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={true} -> - - - -##### names [#operation-api_v2_language_retrieve_responses_200_application-json_names] - - - - - - - - - -#### LanguageName [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename] - - - - - -LanguageSummary","children":[],"breakoutSubTypes":{}}} - typeAnnotations={[{"title":"required","variant":"warning"}]} - hasExpandableContent={true} - expandByDefault={false} -> - - - -##### language [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language] - - - - - - - - - -#### LanguageSummary [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary] - - - - - - - - - -##### name [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary_name] - - - - - - - - - -##### url [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_language_languagesummary_url] - - - - - - - - - - - - - - - - - -##### name [#operation-api_v2_language_retrieve_responses_200_application-json_names_languagename_name] - - - - - - - - - - - - - - - - - -##### official [#operation-api_v2_language_retrieve_responses_200_application-json_official] - - - - - - - - - - - - - -     \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/api/page.mdx b/examples/nextra/src/app/pokeapi/api/page.mdx deleted file mode 100644 index d93504de1..000000000 --- a/examples/nextra/src/app/pokeapi/api/page.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebarTitle: About ---- - -import "@speakeasy-api/docs-md-react/nextra.css"; - -import { - Pill -} from "@speakeasy-api/docs-md-react"; - -# About PokéAPI - -_Version: 2.7.0_ - -All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API. - -## What is this? - -This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series. - -We've covered everything from Pokémon to Berry Flavors. - -## Where do I start? - -We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started. - -This API will always be publicly available and will never require any extensive setup process to consume. - -Created by [**Paul Hallett**](https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo. - - -Servers - -- https://pokeapi.co - -## Global Security - -### cookieAuth cookie apiKey [#cookieAuth] \ No newline at end of file diff --git a/examples/nextra/src/app/pokeapi/page.mdx b/examples/nextra/src/app/pokeapi/page.mdx deleted file mode 100644 index fbbddcf3c..000000000 --- a/examples/nextra/src/app/pokeapi/page.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Home ---- - -# Speakeasy Docs Demo - -Welcome to the Speakeasy Docs Demo! This is a simple demo demonstrating a build of Speakeasy's API docs using Nextra. diff --git a/examples/nextra/src/components/PropertiesModal.tsx b/examples/nextra/src/components/PropertiesModal.tsx deleted file mode 100644 index f4b3847b2..000000000 --- a/examples/nextra/src/components/PropertiesModal.tsx +++ /dev/null @@ -1,28 +0,0 @@ -import * as Dialog from "@radix-ui/react-dialog"; -import "./styles.css"; - -interface PropertiesModalProps { - children: React.ReactNode; -} - -export const PropertiesModal = ({ children }: PropertiesModalProps) => ( - - - - - - - - Edit profile - - {children} - - - - - - - -); diff --git a/examples/nextra/src/components/styles.css b/examples/nextra/src/components/styles.css deleted file mode 100644 index 0b792706c..000000000 --- a/examples/nextra/src/components/styles.css +++ /dev/null @@ -1,153 +0,0 @@ -@import "@radix-ui/colors/black-alpha.css"; -@import "@radix-ui/colors/green.css"; -@import "@radix-ui/colors/mauve.css"; -@import "@radix-ui/colors/violet.css"; - -.DialogOverlay { - background-color: var(--black-a9); - position: fixed; - inset: 0; - animation: overlayShow 150ms cubic-bezier(0.16, 1, 0.3, 1); -} - -.DialogContent { - background-color: var(--gray-1); - border-radius: 6px; - box-shadow: var(--shadow-6); - position: fixed; - top: 50%; - left: 50%; - transform: translate(-50%, -50%); - width: 90vw; - max-width: 500px; - max-height: 85vh; - padding: 25px; - animation: contentShow 150ms cubic-bezier(0.16, 1, 0.3, 1); -} -.DialogContent:focus { - outline: none; -} - -.DialogTitle { - margin: 0; - font-weight: 500; - color: var(--mauve-12); - font-size: 17px; -} - -.DialogDescription { - margin: 10px 0 20px; - color: var(--mauve-11); - font-size: 15px; - line-height: 1.5; -} - -.Button { - display: inline-flex; - align-items: center; - justify-content: center; - border-radius: 4px; - padding: 0 15px; - font-size: 15px; - line-height: 1; - font-weight: 500; - height: 35px; - user-select: none; -} -.Button:focus:not(:focus-visible) { - outline: 0; -} -.Button:focus-visible { - outline: 2px solid var(--violet-6); - outline-offset: 1px; -} -.Button.violet { - background-color: var(--violet-4); - color: var(--violet-12); - outline-color: var(--violet-6); -} -.Button.violet:hover { - background-color: var(--mauve-3); -} -.Button.green { - background-color: var(--green-4); - color: var(--green-11); - outline-color: var(--green-7); -} -.Button.green:hover { - background-color: var(--green-5); -} - -.IconButton { - all: unset; - font-family: inherit; - border-radius: 100%; - height: 25px; - width: 25px; - display: inline-flex; - align-items: center; - justify-content: center; - color: var(--violet-11); - position: absolute; - top: 10px; - right: 10px; - background-color: var(--gray-3); -} -.IconButton:hover { - background-color: var(--violet-4); -} -.IconButton:focus { - box-shadow: 0 0 0 2px var(--violet-7); -} - -.Fieldset { - display: flex; - gap: 20px; - align-items: center; - margin-bottom: 15px; -} - -.Label { - font-size: 15px; - color: var(--violet-11); - width: 90px; - text-align: right; -} - -.Input { - width: 100%; - flex: 1; - display: inline-flex; - align-items: center; - justify-content: center; - border-radius: 4px; - padding: 0 10px; - font-size: 15px; - line-height: 1; - color: var(--violet-11); - box-shadow: 0 0 0 1px var(--violet-7); - height: 35px; -} -.Input:focus { - box-shadow: 0 0 0 2px var(--violet-8); -} - -@keyframes overlayShow { - from { - opacity: 0; - } - to { - opacity: 1; - } -} - -@keyframes contentShow { - from { - opacity: 0; - transform: translate(-50%, -48%) scale(0.96); - } - to { - opacity: 1; - transform: translate(-50%, -50%) scale(1); - } -} diff --git a/examples/nextra/src/mdx-components.tsx b/examples/nextra/src/mdx-components.tsx deleted file mode 100644 index 62c978f16..000000000 --- a/examples/nextra/src/mdx-components.tsx +++ /dev/null @@ -1,12 +0,0 @@ -import { useMDXComponents as getThemeComponents } from "nextra-theme-docs"; // nextra-theme-blog or your custom theme - -// Get the default MDX components -const themeComponents = getThemeComponents(); - -// Merge components -export function useMDXComponents(components: T) { - return { - ...themeComponents, - ...components, - }; -} diff --git a/examples/nextra/tsconfig.json b/examples/nextra/tsconfig.json deleted file mode 100644 index 664a7cf61..000000000 --- a/examples/nextra/tsconfig.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2020", - "lib": [ - "DOM", - "ES2020" - ], - "module": "ESNext", - "jsx": "preserve", - "noEmit": true, - "strict": true, - "skipLibCheck": true, - "isolatedModules": true, - "resolveJsonModule": true, - "moduleResolution": "bundler", - "useDefineForClassFields": true, - "allowImportingTsExtensions": true, - "allowJs": true, - "incremental": true, - "esModuleInterop": true, - "plugins": [ - { - "name": "next" - } - ], - "paths": { - "@/*": [ - "./src/*" - ] - } - }, - "include": [ - "src/**/*", - ".next/types/**/*.ts" - ], - "exclude": [ - "node_modules" - ] -} diff --git a/examples/sdks/glean-typescript.tar.gz b/examples/sdks/glean-typescript.tar.gz deleted file mode 100644 index 165530f58..000000000 --- a/examples/sdks/glean-typescript.tar.gz +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:5560fbcf5f560cad4bdecb0a573e175166be1da030f2983e294f05aa02a33c4a -size 1784791 diff --git a/examples/sdks/mistral-python.tar.gz b/examples/sdks/mistral-python.tar.gz deleted file mode 100644 index 7de64c874..000000000 --- a/examples/sdks/mistral-python.tar.gz +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fd4ebeadad2ec206794dbe4bd2ae5fed673590a83aed0ef59a3e19d8258dc16f -size 798381 diff --git a/examples/sdks/mistral-typescript.tar.gz b/examples/sdks/mistral-typescript.tar.gz deleted file mode 100644 index 7e77cd587..000000000 --- a/examples/sdks/mistral-typescript.tar.gz +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:9abf0c7f2da7a9e270ebc1ed38cb0ad62e3ccdc8a2d7fab54c209df61875edd2 -size 530095 diff --git a/examples/sdks/mistral-typescript/.devcontainer/README.md b/examples/sdks/mistral-typescript/.devcontainer/README.md deleted file mode 100644 index 9832db9d1..000000000 --- a/examples/sdks/mistral-typescript/.devcontainer/README.md +++ /dev/null @@ -1,35 +0,0 @@ - -
    - -
    -
    - -> **Remember to shutdown a GitHub Codespace when it is not in use!** - -# Dev Containers Quick Start - -The default location for usage snippets is the `samples` directory. - -## Running a Usage Sample - -A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below. - -``` -ts-node root.ts -``` - -## Generating Additional Usage Samples - -The speakeasy CLI allows you to generate more usage snippets. Here's how: - -- To generate a sample for a specific operation by providing an operation ID, use: - -``` -speakeasy generate usage -s registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi -l typescript -i {INPUT_OPERATION_ID} -o ./samples -``` - -- To generate samples for an entire namespace (like a tag or group name), use: - -``` -speakeasy generate usage -s registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi -l typescript -n {INPUT_TAG_NAME} -o ./samples -``` diff --git a/examples/sdks/mistral-typescript/.devcontainer/devcontainer.json b/examples/sdks/mistral-typescript/.devcontainer/devcontainer.json deleted file mode 100644 index 4d560dd5f..000000000 --- a/examples/sdks/mistral-typescript/.devcontainer/devcontainer.json +++ /dev/null @@ -1,45 +0,0 @@ -// For format details, see https://aka.ms/devcontainer.json. For config options, see the -// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node -{ - "name": "TypeScript", - "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye", - // Features to add to the dev container. More info: https://containers.dev/features. - // "features": {}, - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh", - "customizations": { - "vscode": { - "extensions": [ - "ms-vscode.vscode-typescript-tslint-plugin", - "esbenp.prettier-vscode", - "github.vscode-pull-request-github" - ], - "settings": { - "files.eol": "\n", - "editor.formatOnSave": true, - "typescript.tsc.autoDetect": "on", - "typescript.updateImportsOnFileMove.enabled": "always", - "typescript.preferences.importModuleSpecifier": "relative", - "[typescript]": { - "editor.codeActionsOnSave": { - "source.organizeImports": true - } - }, - "[typescriptreact]": { - "editor.codeActionsOnSave": { - "source.organizeImports": true - } - } - } - }, - "codespaces": { - "openFiles": [ - ".devcontainer/README.md" - ] - } - } - // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. - // "remoteUser": "root" -} diff --git a/examples/sdks/mistral-typescript/.devcontainer/setup.sh b/examples/sdks/mistral-typescript/.devcontainer/setup.sh deleted file mode 100644 index 9cb44b212..000000000 --- a/examples/sdks/mistral-typescript/.devcontainer/setup.sh +++ /dev/null @@ -1,30 +0,0 @@ -#!/bin/bash - -# Install the speakeasy CLI -curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh - -# Setup samples directory -rmdir samples || true -mkdir samples - -npm install -npm install -g ts-node -npm link -npm link @mistralai/mistralai -TS_CONFIG_CONTENT=$(cat < samples/tsconfig.json - -# Generate starter usage sample with speakeasy -speakeasy generate usage -s registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi -l typescript -o samples/root.ts \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/.genignore b/examples/sdks/mistral-typescript/.genignore deleted file mode 100644 index d7b4a34d3..000000000 --- a/examples/sdks/mistral-typescript/.genignore +++ /dev/null @@ -1,3 +0,0 @@ -examples/ -src/extra/ -tests/ \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/.gitattributes b/examples/sdks/mistral-typescript/.gitattributes deleted file mode 100644 index 113eead50..000000000 --- a/examples/sdks/mistral-typescript/.gitattributes +++ /dev/null @@ -1,2 +0,0 @@ -# This allows generated code to be indexed correctly -*.ts linguist-generated=false \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/.github/workflows/run_example_scripts.yaml b/examples/sdks/mistral-typescript/.github/workflows/run_example_scripts.yaml deleted file mode 100644 index ae2a5c75e..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/run_example_scripts.yaml +++ /dev/null @@ -1,32 +0,0 @@ -name: Running the examples - -on: - push: - branches: - - main - pull_request: - branches: - - main - -jobs: - lint: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: '22' - - - name: Install dependencies - run: npm install && npm install --prefix examples && npm install tsx - - - name: Build the project - run: npm run build - - - name: Run the example script - run: ./scripts/run_examples.sh - env: - MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_azure_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_azure_sdk.yaml deleted file mode 100644 index 9745da80d..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_azure_sdk.yaml +++ /dev/null @@ -1,28 +0,0 @@ -name: Generate MISTRALAI-AZURE-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - workflow_dispatch: - inputs: - force: - description: Force generation of SDKs - type: boolean - default: false - set_version: - description: optionally set a specific SDK version - type: string -jobs: - generate: - uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 - with: - force: ${{ github.event.inputs.force }} - mode: pr - set_version: ${{ github.event.inputs.set_version }} - speakeasy_version: latest - target: mistralai-azure-sdk - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_gcp_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_gcp_sdk.yaml deleted file mode 100644 index 964755ef3..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_gcp_sdk.yaml +++ /dev/null @@ -1,28 +0,0 @@ -name: Generate MISTRALAI-GCP-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - workflow_dispatch: - inputs: - force: - description: Force generation of SDKs - type: boolean - default: false - set_version: - description: optionally set a specific SDK version - type: string -jobs: - generate: - uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 - with: - force: ${{ github.event.inputs.force }} - mode: pr - set_version: ${{ github.event.inputs.set_version }} - speakeasy_version: latest - target: mistralai-gcp-sdk - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_sdk.yaml deleted file mode 100644 index 419e99a60..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_generation_mistralai_sdk.yaml +++ /dev/null @@ -1,28 +0,0 @@ -name: Generate MISTRALAI-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - workflow_dispatch: - inputs: - force: - description: Force generation of SDKs - type: boolean - default: false - set_version: - description: optionally set a specific SDK version - type: string -jobs: - generate: - uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 - with: - force: ${{ github.event.inputs.force }} - mode: pr - set_version: ${{ github.event.inputs.set_version }} - speakeasy_version: latest - target: mistralai-sdk - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_azure_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_azure_sdk.yaml deleted file mode 100644 index 93fa30206..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_azure_sdk.yaml +++ /dev/null @@ -1,19 +0,0 @@ -name: Publish MISTRALAI-AZURE-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - push: - branches: - - main - paths: - - packages/mistralai-azure/RELEASES.md -jobs: - publish: - uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15 - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - npm_token: ${{ secrets.NPM_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_gcp_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_gcp_sdk.yaml deleted file mode 100644 index 361618b6d..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_gcp_sdk.yaml +++ /dev/null @@ -1,19 +0,0 @@ -name: Publish MISTRALAI-GCP-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - push: - branches: - - main - paths: - - packages/mistralai-gcp/RELEASES.md -jobs: - publish: - uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15 - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - npm_token: ${{ secrets.NPM_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_sdk.yaml b/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_sdk.yaml deleted file mode 100644 index 85dea5c22..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/sdk_publish_mistralai_sdk.yaml +++ /dev/null @@ -1,20 +0,0 @@ -name: Publish MISTRALAI-SDK -permissions: - checks: write - contents: write - pull-requests: write - statuses: write -"on": - push: - branches: - - main - paths: - - RELEASES.md - - '*/RELEASES.md' -jobs: - publish: - uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15 - secrets: - github_access_token: ${{ secrets.GITHUB_TOKEN }} - npm_token: ${{ secrets.NPM_TOKEN }} - speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/examples/sdks/mistral-typescript/.github/workflows/test_custom_code.yaml b/examples/sdks/mistral-typescript/.github/workflows/test_custom_code.yaml deleted file mode 100644 index a11f39ef9..000000000 --- a/examples/sdks/mistral-typescript/.github/workflows/test_custom_code.yaml +++ /dev/null @@ -1,30 +0,0 @@ -name: Testing custom files - -on: - push: - branches: - - main - pull_request: - branches: - - main - -jobs: - lint: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: '22' - - - name: Install dependencies - run: npm install && npm install --prefix examples && npm install --prefix tests - - - name: Build the project - run: npm run build - - - name: Run the unit tests - run: (cd tests && npm test) diff --git a/examples/sdks/mistral-typescript/.gitignore b/examples/sdks/mistral-typescript/.gitignore deleted file mode 100644 index bf4508071..000000000 --- a/examples/sdks/mistral-typescript/.gitignore +++ /dev/null @@ -1,127 +0,0 @@ -/examples/node_modules -.DS_Store -**/.speakeasy/temp/ -**/.speakeasy/logs/ -.DS_Store -.env.*.local -/mcp-server -/bin -/.eslintcache -.vscode/ -/react-query -/.speakeasy/reports -/__tests__ -/core.* -/extra -/funcs -/models -/models/errors -/types -/node_modules -/lib -/sdk -/hooks -/index.* -/cjs -/esm -/dist -/.tsbuildinfo -/.tshy -/.tshy-* -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* -.pnpm-debug.log* -# Diagnostic reports (https://nodejs.org/api/report.html) -report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json -# Runtime data -pids -*.pid -*.seed -*.pid.lock -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov -# Coverage directory used by tools like istanbul -coverage -*.lcov -# nyc test coverage -.nyc_output -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) -.grunt -# Bower dependency directory (https://bower.io/) -bower_components -# node-waf configuration -.lock-wscript -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release -# Dependency directories -node_modules/ -jspm_packages/ -# Snowpack dependency directory (https://snowpack.dev/) -web_modules/ -# TypeScript cache -*.tsbuildinfo -# Optional npm cache directory -.npm -# Optional eslint cache -.eslintcache -# Optional stylelint cache -.stylelintcache -# Microbundle cache -.rpt2_cache/ -.rts2_cache_cjs/ -.rts2_cache_es/ -.rts2_cache_umd/ -# Optional REPL history -.node_repl_history -# Output of 'npm pack' -*.tgz -# Yarn Integrity file -.yarn-integrity -# dotenv environment variable files -.env -.env.development.local -.env.test.local -.env.production.local -.env.local -# parcel-bundler cache (https://parceljs.org/) -.cache -.parcel-cache -# Next.js build output -.next -out -# Nuxt.js build / generate output -.nuxt -dist -# Gatsby files -.cache/ -# Comment in the public line in if your project uses Gatsby and not Next.js -# https://nextjs.org/blog/next-9-1#public-directory-support -# public -# vuepress build output -.vuepress/dist -# vuepress v2.x temp and cache directory -.temp -.cache -# Docusaurus cache and generated files -.docusaurus -# Serverless directories -.serverless/ -# FuseBox cache -.fusebox/ -# DynamoDB Local files -.dynamodb/ -# TernJS port file -.tern-port -# Stores VSCode versions used for testing VSCode extensions -.vscode-test -# yarn v2 -.yarn/cache -.yarn/unplugged -.yarn/build-state.yml -.yarn/install-state.gz -.pnp.* diff --git a/examples/sdks/mistral-typescript/.npmignore b/examples/sdks/mistral-typescript/.npmignore deleted file mode 100644 index cf98a6bf0..000000000 --- a/examples/sdks/mistral-typescript/.npmignore +++ /dev/null @@ -1,15 +0,0 @@ -**/* -!/FUNCTIONS.md -!/RUNTIMES.md -!/REACT_QUERY.md -!/**/*.ts -!/**/*.js -!/**/*.mjs -!/**/*.json -!/**/*.map - -/eslint.config.mjs -/cjs -/.tshy -/.tshy-* -/__tests__ diff --git a/examples/sdks/mistral-typescript/.speakeasy/gen.lock b/examples/sdks/mistral-typescript/.speakeasy/gen.lock deleted file mode 100644 index 9f54b4d54..000000000 --- a/examples/sdks/mistral-typescript/.speakeasy/gen.lock +++ /dev/null @@ -1,1482 +0,0 @@ -lockVersion: 2.0.0 -id: 81b65c50-f2e3-40a3-bd65-346524007b3d -management: - docChecksum: c3693e4872a0785b2ed46c59a8464804 - docVersion: 1.0.0 - speakeasyVersion: 1.606.10 - generationVersion: 2.687.13 - releaseVersion: 1.10.0 - configChecksum: 77a96c5f477c3a6c50078fd36c795d9e - repoURL: https://github.com/mistralai/client-ts.git - installationURL: https://github.com/mistralai/client-ts - published: true -features: - typescript: - additionalDependencies: 0.1.0 - additionalProperties: 0.1.1 - constsAndDefaults: 0.1.12 - core: 3.21.20 - customCodeRegions: 0.1.0 - defaultEnabledRetries: 0.1.0 - devContainers: 2.90.0 - downloadStreams: 0.1.1 - enumUnions: 0.1.0 - envVarSecurityUsage: 0.1.2 - examples: 2.82.3 - globalSecurity: 2.82.13 - globalSecurityCallbacks: 0.1.0 - globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.82.5 - methodArguments: 0.1.2 - nameOverrides: 2.81.2 - nullables: 0.1.1 - openEnums: 0.1.1 - responseFormat: 0.2.3 - retries: 2.83.0 - sdkHooks: 0.3.0 - serverEvents: 0.1.8 - serverEventsSentinels: 0.1.0 - serverIDs: 2.81.2 - unions: 2.85.11 - uploadStreams: 0.1.0 -generatedFiles: - - .devcontainer/README.md - - .devcontainer/devcontainer.json - - .devcontainer/setup.sh - - .gitattributes - - .npmignore - - FUNCTIONS.md - - RUNTIMES.md - - USAGE.md - - docs/lib/utils/retryconfig.md - - docs/models/components/agent.md - - docs/models/components/agentconversation.md - - docs/models/components/agentconversationobject.md - - docs/models/components/agentcreationrequest.md - - docs/models/components/agentcreationrequesttools.md - - docs/models/components/agenthandoffdoneevent.md - - docs/models/components/agenthandoffdoneeventtype.md - - docs/models/components/agenthandoffentry.md - - docs/models/components/agenthandoffentryobject.md - - docs/models/components/agenthandoffentrytype.md - - docs/models/components/agenthandoffstartedevent.md - - docs/models/components/agenthandoffstartedeventtype.md - - docs/models/components/agentobject.md - - docs/models/components/agentscompletionrequest.md - - docs/models/components/agentscompletionrequestmessages.md - - docs/models/components/agentscompletionrequeststop.md - - docs/models/components/agentscompletionrequesttoolchoice.md - - docs/models/components/agentscompletionstreamrequest.md - - docs/models/components/agentscompletionstreamrequestmessages.md - - docs/models/components/agentscompletionstreamrequeststop.md - - docs/models/components/agentscompletionstreamrequesttoolchoice.md - - docs/models/components/agenttools.md - - docs/models/components/agentupdaterequest.md - - docs/models/components/agentupdaterequesttools.md - - docs/models/components/apiendpoint.md - - docs/models/components/archiveftmodelout.md - - docs/models/components/archiveftmodeloutobject.md - - docs/models/components/arguments.md - - docs/models/components/assistantmessage.md - - docs/models/components/assistantmessagecontent.md - - docs/models/components/assistantmessagerole.md - - docs/models/components/audiochunk.md - - docs/models/components/audiochunktype.md - - docs/models/components/audiotranscriptionrequest.md - - docs/models/components/audiotranscriptionrequeststream.md - - docs/models/components/basemodelcard.md - - docs/models/components/basemodelcardtype.md - - docs/models/components/batcherror.md - - docs/models/components/batchjobin.md - - docs/models/components/batchjobout.md - - docs/models/components/batchjoboutobject.md - - docs/models/components/batchjobsout.md - - docs/models/components/batchjobsoutobject.md - - docs/models/components/batchjobstatus.md - - docs/models/components/builtinconnectors.md - - docs/models/components/chatclassificationrequest.md - - docs/models/components/chatcompletionchoice.md - - docs/models/components/chatcompletionrequest.md - - docs/models/components/chatcompletionrequesttoolchoice.md - - docs/models/components/chatcompletionresponse.md - - docs/models/components/chatcompletionstreamrequest.md - - docs/models/components/chatcompletionstreamrequestmessages.md - - docs/models/components/chatcompletionstreamrequeststop.md - - docs/models/components/chatcompletionstreamrequesttoolchoice.md - - docs/models/components/chatmoderationrequest.md - - docs/models/components/chatmoderationrequestinputs.md - - docs/models/components/checkpointout.md - - docs/models/components/classificationrequest.md - - docs/models/components/classificationrequestinputs.md - - docs/models/components/classificationresponse.md - - docs/models/components/classificationtargetresult.md - - docs/models/components/classifierdetailedjobout.md - - docs/models/components/classifierdetailedjoboutintegrations.md - - docs/models/components/classifierdetailedjoboutjobtype.md - - docs/models/components/classifierdetailedjoboutobject.md - - docs/models/components/classifierdetailedjoboutstatus.md - - docs/models/components/classifierftmodelout.md - - docs/models/components/classifierftmodeloutmodeltype.md - - docs/models/components/classifierftmodeloutobject.md - - docs/models/components/classifierjobout.md - - docs/models/components/classifierjoboutintegrations.md - - docs/models/components/classifierjoboutjobtype.md - - docs/models/components/classifierjoboutobject.md - - docs/models/components/classifierjoboutstatus.md - - docs/models/components/classifiertargetin.md - - docs/models/components/classifiertargetout.md - - docs/models/components/classifiertrainingparameters.md - - docs/models/components/classifiertrainingparametersin.md - - docs/models/components/codeinterpretertool.md - - docs/models/components/codeinterpretertooltype.md - - docs/models/components/completionargs.md - - docs/models/components/completionargsstop.md - - docs/models/components/completionchunk.md - - docs/models/components/completiondetailedjobout.md - - docs/models/components/completiondetailedjoboutintegrations.md - - docs/models/components/completiondetailedjoboutjobtype.md - - docs/models/components/completiondetailedjoboutobject.md - - docs/models/components/completiondetailedjoboutrepositories.md - - docs/models/components/completiondetailedjoboutstatus.md - - docs/models/components/completionevent.md - - docs/models/components/completionftmodelout.md - - docs/models/components/completionftmodeloutobject.md - - docs/models/components/completionjobout.md - - docs/models/components/completionjoboutobject.md - - docs/models/components/completionresponsestreamchoice.md - - docs/models/components/completionresponsestreamchoicefinishreason.md - - docs/models/components/completiontrainingparameters.md - - docs/models/components/completiontrainingparametersin.md - - docs/models/components/content.md - - docs/models/components/contentchunk.md - - docs/models/components/conversationappendrequest.md - - docs/models/components/conversationappendrequesthandoffexecution.md - - docs/models/components/conversationappendstreamrequest.md - - docs/models/components/conversationappendstreamrequesthandoffexecution.md - - docs/models/components/conversationevents.md - - docs/models/components/conversationeventsdata.md - - docs/models/components/conversationhistory.md - - docs/models/components/conversationhistoryobject.md - - docs/models/components/conversationinputs.md - - docs/models/components/conversationmessages.md - - docs/models/components/conversationmessagesobject.md - - docs/models/components/conversationrequest.md - - docs/models/components/conversationresponse.md - - docs/models/components/conversationresponseobject.md - - docs/models/components/conversationrestartrequest.md - - docs/models/components/conversationrestartrequesthandoffexecution.md - - docs/models/components/conversationrestartstreamrequest.md - - docs/models/components/conversationrestartstreamrequesthandoffexecution.md - - docs/models/components/conversationstreamrequest.md - - docs/models/components/conversationstreamrequesthandoffexecution.md - - docs/models/components/conversationstreamrequesttools.md - - docs/models/components/conversationusageinfo.md - - docs/models/components/data.md - - docs/models/components/deletefileout.md - - docs/models/components/deletemodelout.md - - docs/models/components/deltamessage.md - - docs/models/components/document.md - - docs/models/components/documentlibrarytool.md - - docs/models/components/documentlibrarytooltype.md - - docs/models/components/documentout.md - - docs/models/components/documenttextcontent.md - - docs/models/components/documentupdatein.md - - docs/models/components/documenturlchunk.md - - docs/models/components/documenturlchunktype.md - - docs/models/components/embeddingdtype.md - - docs/models/components/embeddingrequest.md - - docs/models/components/embeddingrequestinputs.md - - docs/models/components/embeddingresponse.md - - docs/models/components/embeddingresponsedata.md - - docs/models/components/encodingformat.md - - docs/models/components/entitytype.md - - docs/models/components/entries.md - - docs/models/components/eventout.md - - docs/models/components/filechunk.md - - docs/models/components/filepurpose.md - - docs/models/components/fileschema.md - - docs/models/components/filesignedurl.md - - docs/models/components/filet.md - - docs/models/components/fimcompletionrequest.md - - docs/models/components/fimcompletionrequeststop.md - - docs/models/components/fimcompletionresponse.md - - docs/models/components/fimcompletionstreamrequest.md - - docs/models/components/fimcompletionstreamrequeststop.md - - docs/models/components/finetuneablemodeltype.md - - docs/models/components/finishreason.md - - docs/models/components/ftclassifierlossfunction.md - - docs/models/components/ftmodelcapabilitiesout.md - - docs/models/components/ftmodelcard.md - - docs/models/components/ftmodelcardtype.md - - docs/models/components/functioncall.md - - docs/models/components/functioncallentry.md - - docs/models/components/functioncallentryarguments.md - - docs/models/components/functioncallentryobject.md - - docs/models/components/functioncallentrytype.md - - docs/models/components/functioncallevent.md - - docs/models/components/functioncalleventtype.md - - docs/models/components/functionname.md - - docs/models/components/functionresultentry.md - - docs/models/components/functionresultentryobject.md - - docs/models/components/functionresultentrytype.md - - docs/models/components/functiont.md - - docs/models/components/functiontool.md - - docs/models/components/functiontooltype.md - - docs/models/components/githubrepositoryin.md - - docs/models/components/githubrepositoryintype.md - - docs/models/components/githubrepositoryout.md - - docs/models/components/githubrepositoryouttype.md - - docs/models/components/handoffexecution.md - - docs/models/components/hyperparameters.md - - docs/models/components/imagegenerationtool.md - - docs/models/components/imagegenerationtooltype.md - - docs/models/components/imageurl.md - - docs/models/components/imageurlchunk.md - - docs/models/components/imageurlchunkimageurl.md - - docs/models/components/imageurlchunktype.md - - docs/models/components/inputentries.md - - docs/models/components/inputs.md - - docs/models/components/instructrequest.md - - docs/models/components/instructrequestinputs.md - - docs/models/components/instructrequestinputsmessages.md - - docs/models/components/instructrequestmessages.md - - docs/models/components/integrations.md - - docs/models/components/jobin.md - - docs/models/components/jobinintegrations.md - - docs/models/components/jobinrepositories.md - - docs/models/components/jobmetadataout.md - - docs/models/components/jobsout.md - - docs/models/components/jobsoutdata.md - - docs/models/components/jobsoutobject.md - - docs/models/components/jobtype.md - - docs/models/components/jsonschema.md - - docs/models/components/legacyjobmetadataout.md - - docs/models/components/legacyjobmetadataoutobject.md - - docs/models/components/libraryin.md - - docs/models/components/libraryinupdate.md - - docs/models/components/libraryout.md - - docs/models/components/listdocumentout.md - - docs/models/components/listfilesout.md - - docs/models/components/listlibraryout.md - - docs/models/components/listsharingout.md - - docs/models/components/loc.md - - docs/models/components/messageentries.md - - docs/models/components/messageinputcontentchunks.md - - docs/models/components/messageinputentry.md - - docs/models/components/messageinputentrycontent.md - - docs/models/components/messageinputentryrole.md - - docs/models/components/messageinputentrytype.md - - docs/models/components/messageoutputcontentchunks.md - - docs/models/components/messageoutputentry.md - - docs/models/components/messageoutputentrycontent.md - - docs/models/components/messageoutputentryobject.md - - docs/models/components/messageoutputentryrole.md - - docs/models/components/messageoutputentrytype.md - - docs/models/components/messageoutputevent.md - - docs/models/components/messageoutputeventcontent.md - - docs/models/components/messageoutputeventrole.md - - docs/models/components/messageoutputeventtype.md - - docs/models/components/messages.md - - docs/models/components/metricout.md - - docs/models/components/mistralpromptmode.md - - docs/models/components/modelcapabilities.md - - docs/models/components/modelconversation.md - - docs/models/components/modelconversationobject.md - - docs/models/components/modelconversationtools.md - - docs/models/components/modellist.md - - docs/models/components/modeltype.md - - docs/models/components/moderationobject.md - - docs/models/components/moderationresponse.md - - docs/models/components/objectt.md - - docs/models/components/ocrimageobject.md - - docs/models/components/ocrpagedimensions.md - - docs/models/components/ocrpageobject.md - - docs/models/components/ocrrequest.md - - docs/models/components/ocrresponse.md - - docs/models/components/ocrusageinfo.md - - docs/models/components/one.md - - docs/models/components/outputcontentchunks.md - - docs/models/components/outputs.md - - docs/models/components/paginationinfo.md - - docs/models/components/prediction.md - - docs/models/components/processingstatusout.md - - docs/models/components/referencechunk.md - - docs/models/components/referencechunktype.md - - docs/models/components/repositories.md - - docs/models/components/responsedoneevent.md - - docs/models/components/responsedoneeventtype.md - - docs/models/components/responseerrorevent.md - - docs/models/components/responseerroreventtype.md - - docs/models/components/responseformat.md - - docs/models/components/responseformats.md - - docs/models/components/responsestartedevent.md - - docs/models/components/responsestartedeventtype.md - - docs/models/components/retrievefileout.md - - docs/models/components/role.md - - docs/models/components/sampletype.md - - docs/models/components/security.md - - docs/models/components/shareenum.md - - docs/models/components/sharingdelete.md - - docs/models/components/sharingin.md - - docs/models/components/sharingout.md - - docs/models/components/source.md - - docs/models/components/ssetypes.md - - docs/models/components/status.md - - docs/models/components/stop.md - - docs/models/components/systemmessage.md - - docs/models/components/systemmessagecontent.md - - docs/models/components/systemmessagecontentchunks.md - - docs/models/components/textchunk.md - - docs/models/components/textchunktype.md - - docs/models/components/thinkchunk.md - - docs/models/components/thinkchunktype.md - - docs/models/components/thinking.md - - docs/models/components/timestampgranularity.md - - docs/models/components/tool.md - - docs/models/components/toolcall.md - - docs/models/components/toolchoice.md - - docs/models/components/toolchoiceenum.md - - docs/models/components/toolexecutiondeltaevent.md - - docs/models/components/toolexecutiondeltaeventtype.md - - docs/models/components/toolexecutiondoneevent.md - - docs/models/components/toolexecutiondoneeventtype.md - - docs/models/components/toolexecutionentry.md - - docs/models/components/toolexecutionentryobject.md - - docs/models/components/toolexecutionentrytype.md - - docs/models/components/toolexecutionstartedevent.md - - docs/models/components/toolexecutionstartedeventtype.md - - docs/models/components/toolfilechunk.md - - docs/models/components/toolfilechunktype.md - - docs/models/components/toolmessage.md - - docs/models/components/toolmessagecontent.md - - docs/models/components/toolmessagerole.md - - docs/models/components/toolreferencechunk.md - - docs/models/components/toolreferencechunktype.md - - docs/models/components/tools.md - - docs/models/components/tooltypes.md - - docs/models/components/trainingfile.md - - docs/models/components/transcriptionresponse.md - - docs/models/components/transcriptionsegmentchunk.md - - docs/models/components/transcriptionstreamdone.md - - docs/models/components/transcriptionstreamdonetype.md - - docs/models/components/transcriptionstreamevents.md - - docs/models/components/transcriptionstreameventsdata.md - - docs/models/components/transcriptionstreameventtypes.md - - docs/models/components/transcriptionstreamlanguage.md - - docs/models/components/transcriptionstreamlanguagetype.md - - docs/models/components/transcriptionstreamsegmentdelta.md - - docs/models/components/transcriptionstreamsegmentdeltatype.md - - docs/models/components/transcriptionstreamtextdelta.md - - docs/models/components/transcriptionstreamtextdeltatype.md - - docs/models/components/two.md - - docs/models/components/type.md - - docs/models/components/unarchiveftmodelout.md - - docs/models/components/unarchiveftmodeloutobject.md - - docs/models/components/updateftmodelin.md - - docs/models/components/uploadfileout.md - - docs/models/components/usageinfo.md - - docs/models/components/usermessage.md - - docs/models/components/usermessagecontent.md - - docs/models/components/usermessagerole.md - - docs/models/components/validationerror.md - - docs/models/components/wandbintegration.md - - docs/models/components/wandbintegrationout.md - - docs/models/components/wandbintegrationouttype.md - - docs/models/components/wandbintegrationtype.md - - docs/models/components/websearchpremiumtool.md - - docs/models/components/websearchpremiumtooltype.md - - docs/models/components/websearchtool.md - - docs/models/components/websearchtooltype.md - - docs/models/errors/httpvalidationerror.md - - docs/models/operations/agentsapiv1agentsgetrequest.md - - docs/models/operations/agentsapiv1agentslistrequest.md - - docs/models/operations/agentsapiv1agentsupdaterequest.md - - docs/models/operations/agentsapiv1agentsupdateversionrequest.md - - docs/models/operations/agentsapiv1conversationsappendrequest.md - - docs/models/operations/agentsapiv1conversationsappendstreamrequest.md - - docs/models/operations/agentsapiv1conversationsgetrequest.md - - docs/models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md - - docs/models/operations/agentsapiv1conversationshistoryrequest.md - - docs/models/operations/agentsapiv1conversationslistrequest.md - - docs/models/operations/agentsapiv1conversationsmessagesrequest.md - - docs/models/operations/agentsapiv1conversationsrestartrequest.md - - docs/models/operations/agentsapiv1conversationsrestartstreamrequest.md - - docs/models/operations/deletemodelv1modelsmodeliddeleterequest.md - - docs/models/operations/filesapiroutesdeletefilerequest.md - - docs/models/operations/filesapiroutesdownloadfilerequest.md - - docs/models/operations/filesapiroutesgetsignedurlrequest.md - - docs/models/operations/filesapirouteslistfilesrequest.md - - docs/models/operations/filesapiroutesretrievefilerequest.md - - docs/models/operations/filesapiroutesuploadfilemultipartbodyparams.md - - docs/models/operations/jobsapiroutesbatchcancelbatchjobrequest.md - - docs/models/operations/jobsapiroutesbatchgetbatchjobrequest.md - - docs/models/operations/jobsapiroutesbatchgetbatchjobsrequest.md - - docs/models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md - - docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md - - docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md - - docs/models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md - - docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md - - docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md - - docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md - - docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md - - docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md - - docs/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md - - docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md - - docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md - - docs/models/operations/librariesdeletev1request.md - - docs/models/operations/librariesdocumentsdeletev1request.md - - docs/models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md - - docs/models/operations/librariesdocumentsgetsignedurlv1request.md - - docs/models/operations/librariesdocumentsgetstatusv1request.md - - docs/models/operations/librariesdocumentsgettextcontentv1request.md - - docs/models/operations/librariesdocumentsgetv1request.md - - docs/models/operations/librariesdocumentslistv1request.md - - docs/models/operations/librariesdocumentsreprocessv1request.md - - docs/models/operations/librariesdocumentsupdatev1request.md - - docs/models/operations/librariesdocumentsuploadv1documentupload.md - - docs/models/operations/librariesdocumentsuploadv1request.md - - docs/models/operations/librariesgetv1request.md - - docs/models/operations/librariessharecreatev1request.md - - docs/models/operations/librariessharedeletev1request.md - - docs/models/operations/librariessharelistv1request.md - - docs/models/operations/librariesupdatev1request.md - - docs/models/operations/one.md - - docs/models/operations/responsebody.md - - docs/models/operations/retrievemodelv1modelsmodelidgetrequest.md - - docs/models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md - - docs/models/operations/status.md - - docs/sdks/accesses/README.md - - docs/sdks/agents/README.md - - docs/sdks/audio/README.md - - docs/sdks/batch/README.md - - docs/sdks/beta/README.md - - docs/sdks/chat/README.md - - docs/sdks/classifiers/README.md - - docs/sdks/conversations/README.md - - docs/sdks/documents/README.md - - docs/sdks/embeddings/README.md - - docs/sdks/files/README.md - - docs/sdks/fim/README.md - - docs/sdks/finetuning/README.md - - docs/sdks/jobs/README.md - - docs/sdks/libraries/README.md - - docs/sdks/mistral/README.md - - docs/sdks/mistralagents/README.md - - docs/sdks/mistraljobs/README.md - - docs/sdks/models/README.md - - docs/sdks/ocr/README.md - - docs/sdks/transcriptions/README.md - - eslint.config.mjs - - jsr.json - - package.json - - src/core.ts - - src/funcs/agentsComplete.ts - - src/funcs/agentsStream.ts - - src/funcs/audioTranscriptionsComplete.ts - - src/funcs/audioTranscriptionsStream.ts - - src/funcs/batchJobsCancel.ts - - src/funcs/batchJobsCreate.ts - - src/funcs/batchJobsGet.ts - - src/funcs/batchJobsList.ts - - src/funcs/betaAgentsCreate.ts - - src/funcs/betaAgentsGet.ts - - src/funcs/betaAgentsList.ts - - src/funcs/betaAgentsUpdate.ts - - src/funcs/betaAgentsUpdateVersion.ts - - src/funcs/betaConversationsAppend.ts - - src/funcs/betaConversationsAppendStream.ts - - src/funcs/betaConversationsGet.ts - - src/funcs/betaConversationsGetHistory.ts - - src/funcs/betaConversationsGetMessages.ts - - src/funcs/betaConversationsList.ts - - src/funcs/betaConversationsRestart.ts - - src/funcs/betaConversationsRestartStream.ts - - src/funcs/betaConversationsStart.ts - - src/funcs/betaConversationsStartStream.ts - - src/funcs/betaLibrariesAccessesDelete.ts - - src/funcs/betaLibrariesAccessesList.ts - - src/funcs/betaLibrariesAccessesUpdateOrCreate.ts - - src/funcs/betaLibrariesCreate.ts - - src/funcs/betaLibrariesDelete.ts - - src/funcs/betaLibrariesDocumentsDelete.ts - - src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts - - src/funcs/betaLibrariesDocumentsGet.ts - - src/funcs/betaLibrariesDocumentsGetSignedUrl.ts - - src/funcs/betaLibrariesDocumentsList.ts - - src/funcs/betaLibrariesDocumentsReprocess.ts - - src/funcs/betaLibrariesDocumentsStatus.ts - - src/funcs/betaLibrariesDocumentsTextContent.ts - - src/funcs/betaLibrariesDocumentsUpdate.ts - - src/funcs/betaLibrariesDocumentsUpload.ts - - src/funcs/betaLibrariesGet.ts - - src/funcs/betaLibrariesList.ts - - src/funcs/betaLibrariesUpdate.ts - - src/funcs/chatComplete.ts - - src/funcs/chatStream.ts - - src/funcs/classifiersClassify.ts - - src/funcs/classifiersClassifyChat.ts - - src/funcs/classifiersModerate.ts - - src/funcs/classifiersModerateChat.ts - - src/funcs/embeddingsCreate.ts - - src/funcs/filesDelete.ts - - src/funcs/filesDownload.ts - - src/funcs/filesGetSignedUrl.ts - - src/funcs/filesList.ts - - src/funcs/filesRetrieve.ts - - src/funcs/filesUpload.ts - - src/funcs/fimComplete.ts - - src/funcs/fimStream.ts - - src/funcs/fineTuningJobsCancel.ts - - src/funcs/fineTuningJobsCreate.ts - - src/funcs/fineTuningJobsGet.ts - - src/funcs/fineTuningJobsList.ts - - src/funcs/fineTuningJobsStart.ts - - src/funcs/modelsArchive.ts - - src/funcs/modelsDelete.ts - - src/funcs/modelsList.ts - - src/funcs/modelsRetrieve.ts - - src/funcs/modelsUnarchive.ts - - src/funcs/modelsUpdate.ts - - src/funcs/ocrProcess.ts - - src/hooks/hooks.ts - - src/hooks/index.ts - - src/hooks/types.ts - - src/index.ts - - src/lib/base64.ts - - src/lib/config.ts - - src/lib/dlv.ts - - src/lib/encodings.ts - - src/lib/env.ts - - src/lib/event-streams.ts - - src/lib/files.ts - - src/lib/http.ts - - src/lib/is-plain-object.ts - - src/lib/logger.ts - - src/lib/matchers.ts - - src/lib/primitives.ts - - src/lib/retries.ts - - src/lib/schemas.ts - - src/lib/sdks.ts - - src/lib/security.ts - - src/lib/url.ts - - src/models/components/agent.ts - - src/models/components/agentconversation.ts - - src/models/components/agentcreationrequest.ts - - src/models/components/agenthandoffdoneevent.ts - - src/models/components/agenthandoffentry.ts - - src/models/components/agenthandoffstartedevent.ts - - src/models/components/agentscompletionrequest.ts - - src/models/components/agentscompletionstreamrequest.ts - - src/models/components/agentupdaterequest.ts - - src/models/components/apiendpoint.ts - - src/models/components/archiveftmodelout.ts - - src/models/components/assistantmessage.ts - - src/models/components/audiochunk.ts - - src/models/components/audiotranscriptionrequest.ts - - src/models/components/audiotranscriptionrequeststream.ts - - src/models/components/basemodelcard.ts - - src/models/components/batcherror.ts - - src/models/components/batchjobin.ts - - src/models/components/batchjobout.ts - - src/models/components/batchjobsout.ts - - src/models/components/batchjobstatus.ts - - src/models/components/builtinconnectors.ts - - src/models/components/chatclassificationrequest.ts - - src/models/components/chatcompletionchoice.ts - - src/models/components/chatcompletionrequest.ts - - src/models/components/chatcompletionresponse.ts - - src/models/components/chatcompletionstreamrequest.ts - - src/models/components/chatmoderationrequest.ts - - src/models/components/checkpointout.ts - - src/models/components/classificationrequest.ts - - src/models/components/classificationresponse.ts - - src/models/components/classificationtargetresult.ts - - src/models/components/classifierdetailedjobout.ts - - src/models/components/classifierftmodelout.ts - - src/models/components/classifierjobout.ts - - src/models/components/classifiertargetin.ts - - src/models/components/classifiertargetout.ts - - src/models/components/classifiertrainingparameters.ts - - src/models/components/classifiertrainingparametersin.ts - - src/models/components/codeinterpretertool.ts - - src/models/components/completionargs.ts - - src/models/components/completionargsstop.ts - - src/models/components/completionchunk.ts - - src/models/components/completiondetailedjobout.ts - - src/models/components/completionevent.ts - - src/models/components/completionftmodelout.ts - - src/models/components/completionjobout.ts - - src/models/components/completionresponsestreamchoice.ts - - src/models/components/completiontrainingparameters.ts - - src/models/components/completiontrainingparametersin.ts - - src/models/components/contentchunk.ts - - src/models/components/conversationappendrequest.ts - - src/models/components/conversationappendstreamrequest.ts - - src/models/components/conversationevents.ts - - src/models/components/conversationhistory.ts - - src/models/components/conversationinputs.ts - - src/models/components/conversationmessages.ts - - src/models/components/conversationrequest.ts - - src/models/components/conversationresponse.ts - - src/models/components/conversationrestartrequest.ts - - src/models/components/conversationrestartstreamrequest.ts - - src/models/components/conversationstreamrequest.ts - - src/models/components/conversationusageinfo.ts - - src/models/components/deletefileout.ts - - src/models/components/deletemodelout.ts - - src/models/components/deltamessage.ts - - src/models/components/documentlibrarytool.ts - - src/models/components/documentout.ts - - src/models/components/documenttextcontent.ts - - src/models/components/documentupdatein.ts - - src/models/components/documenturlchunk.ts - - src/models/components/embeddingdtype.ts - - src/models/components/embeddingrequest.ts - - src/models/components/embeddingresponse.ts - - src/models/components/embeddingresponsedata.ts - - src/models/components/encodingformat.ts - - src/models/components/entitytype.ts - - src/models/components/eventout.ts - - src/models/components/file.ts - - src/models/components/filechunk.ts - - src/models/components/filepurpose.ts - - src/models/components/fileschema.ts - - src/models/components/filesignedurl.ts - - src/models/components/fimcompletionrequest.ts - - src/models/components/fimcompletionresponse.ts - - src/models/components/fimcompletionstreamrequest.ts - - src/models/components/finetuneablemodeltype.ts - - src/models/components/ftclassifierlossfunction.ts - - src/models/components/ftmodelcapabilitiesout.ts - - src/models/components/ftmodelcard.ts - - src/models/components/function.ts - - src/models/components/functioncall.ts - - src/models/components/functioncallentry.ts - - src/models/components/functioncallentryarguments.ts - - src/models/components/functioncallevent.ts - - src/models/components/functionname.ts - - src/models/components/functionresultentry.ts - - src/models/components/functiontool.ts - - src/models/components/githubrepositoryin.ts - - src/models/components/githubrepositoryout.ts - - src/models/components/imagegenerationtool.ts - - src/models/components/imageurl.ts - - src/models/components/imageurlchunk.ts - - src/models/components/index.ts - - src/models/components/inputentries.ts - - src/models/components/inputs.ts - - src/models/components/instructrequest.ts - - src/models/components/jobin.ts - - src/models/components/jobmetadataout.ts - - src/models/components/jobsout.ts - - src/models/components/jsonschema.ts - - src/models/components/legacyjobmetadataout.ts - - src/models/components/libraryin.ts - - src/models/components/libraryinupdate.ts - - src/models/components/libraryout.ts - - src/models/components/listdocumentout.ts - - src/models/components/listfilesout.ts - - src/models/components/listlibraryout.ts - - src/models/components/listsharingout.ts - - src/models/components/messageentries.ts - - src/models/components/messageinputcontentchunks.ts - - src/models/components/messageinputentry.ts - - src/models/components/messageoutputcontentchunks.ts - - src/models/components/messageoutputentry.ts - - src/models/components/messageoutputevent.ts - - src/models/components/metricout.ts - - src/models/components/mistralpromptmode.ts - - src/models/components/modelcapabilities.ts - - src/models/components/modelconversation.ts - - src/models/components/modellist.ts - - src/models/components/moderationobject.ts - - src/models/components/moderationresponse.ts - - src/models/components/ocrimageobject.ts - - src/models/components/ocrpagedimensions.ts - - src/models/components/ocrpageobject.ts - - src/models/components/ocrrequest.ts - - src/models/components/ocrresponse.ts - - src/models/components/ocrusageinfo.ts - - src/models/components/outputcontentchunks.ts - - src/models/components/paginationinfo.ts - - src/models/components/prediction.ts - - src/models/components/processingstatusout.ts - - src/models/components/referencechunk.ts - - src/models/components/responsedoneevent.ts - - src/models/components/responseerrorevent.ts - - src/models/components/responseformat.ts - - src/models/components/responseformats.ts - - src/models/components/responsestartedevent.ts - - src/models/components/retrievefileout.ts - - src/models/components/sampletype.ts - - src/models/components/security.ts - - src/models/components/shareenum.ts - - src/models/components/sharingdelete.ts - - src/models/components/sharingin.ts - - src/models/components/sharingout.ts - - src/models/components/source.ts - - src/models/components/ssetypes.ts - - src/models/components/systemmessage.ts - - src/models/components/systemmessagecontentchunks.ts - - src/models/components/textchunk.ts - - src/models/components/thinkchunk.ts - - src/models/components/timestampgranularity.ts - - src/models/components/tool.ts - - src/models/components/toolcall.ts - - src/models/components/toolchoice.ts - - src/models/components/toolchoiceenum.ts - - src/models/components/toolexecutiondeltaevent.ts - - src/models/components/toolexecutiondoneevent.ts - - src/models/components/toolexecutionentry.ts - - src/models/components/toolexecutionstartedevent.ts - - src/models/components/toolfilechunk.ts - - src/models/components/toolmessage.ts - - src/models/components/toolreferencechunk.ts - - src/models/components/tooltypes.ts - - src/models/components/trainingfile.ts - - src/models/components/transcriptionresponse.ts - - src/models/components/transcriptionsegmentchunk.ts - - src/models/components/transcriptionstreamdone.ts - - src/models/components/transcriptionstreamevents.ts - - src/models/components/transcriptionstreameventtypes.ts - - src/models/components/transcriptionstreamlanguage.ts - - src/models/components/transcriptionstreamsegmentdelta.ts - - src/models/components/transcriptionstreamtextdelta.ts - - src/models/components/unarchiveftmodelout.ts - - src/models/components/updateftmodelin.ts - - src/models/components/uploadfileout.ts - - src/models/components/usageinfo.ts - - src/models/components/usermessage.ts - - src/models/components/validationerror.ts - - src/models/components/wandbintegration.ts - - src/models/components/wandbintegrationout.ts - - src/models/components/websearchpremiumtool.ts - - src/models/components/websearchtool.ts - - src/models/errors/httpclienterrors.ts - - src/models/errors/httpvalidationerror.ts - - src/models/errors/index.ts - - src/models/errors/mistralerror.ts - - src/models/errors/responsevalidationerror.ts - - src/models/errors/sdkerror.ts - - src/models/errors/sdkvalidationerror.ts - - src/models/operations/agentsapiv1agentsget.ts - - src/models/operations/agentsapiv1agentslist.ts - - src/models/operations/agentsapiv1agentsupdate.ts - - src/models/operations/agentsapiv1agentsupdateversion.ts - - src/models/operations/agentsapiv1conversationsappend.ts - - src/models/operations/agentsapiv1conversationsappendstream.ts - - src/models/operations/agentsapiv1conversationsget.ts - - src/models/operations/agentsapiv1conversationshistory.ts - - src/models/operations/agentsapiv1conversationslist.ts - - src/models/operations/agentsapiv1conversationsmessages.ts - - src/models/operations/agentsapiv1conversationsrestart.ts - - src/models/operations/agentsapiv1conversationsrestartstream.ts - - src/models/operations/deletemodelv1modelsmodeliddelete.ts - - src/models/operations/filesapiroutesdeletefile.ts - - src/models/operations/filesapiroutesdownloadfile.ts - - src/models/operations/filesapiroutesgetsignedurl.ts - - src/models/operations/filesapirouteslistfiles.ts - - src/models/operations/filesapiroutesretrievefile.ts - - src/models/operations/filesapiroutesuploadfile.ts - - src/models/operations/index.ts - - src/models/operations/jobsapiroutesbatchcancelbatchjob.ts - - src/models/operations/jobsapiroutesbatchgetbatchjob.ts - - src/models/operations/jobsapiroutesbatchgetbatchjobs.ts - - src/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.ts - - src/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.ts - - src/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.ts - - src/models/operations/jobsapiroutesfinetuninggetfinetuningjob.ts - - src/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.ts - - src/models/operations/jobsapiroutesfinetuningstartfinetuningjob.ts - - src/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.ts - - src/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.ts - - src/models/operations/librariesdeletev1.ts - - src/models/operations/librariesdocumentsdeletev1.ts - - src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts - - src/models/operations/librariesdocumentsgetsignedurlv1.ts - - src/models/operations/librariesdocumentsgetstatusv1.ts - - src/models/operations/librariesdocumentsgettextcontentv1.ts - - src/models/operations/librariesdocumentsgetv1.ts - - src/models/operations/librariesdocumentslistv1.ts - - src/models/operations/librariesdocumentsreprocessv1.ts - - src/models/operations/librariesdocumentsupdatev1.ts - - src/models/operations/librariesdocumentsuploadv1.ts - - src/models/operations/librariesgetv1.ts - - src/models/operations/librariessharecreatev1.ts - - src/models/operations/librariessharedeletev1.ts - - src/models/operations/librariessharelistv1.ts - - src/models/operations/librariesupdatev1.ts - - src/models/operations/retrievemodelv1modelsmodelidget.ts - - src/sdk/accesses.ts - - src/sdk/agents.ts - - src/sdk/audio.ts - - src/sdk/batch.ts - - src/sdk/beta.ts - - src/sdk/chat.ts - - src/sdk/classifiers.ts - - src/sdk/conversations.ts - - src/sdk/documents.ts - - src/sdk/embeddings.ts - - src/sdk/files.ts - - src/sdk/fim.ts - - src/sdk/finetuning.ts - - src/sdk/index.ts - - src/sdk/jobs.ts - - src/sdk/libraries.ts - - src/sdk/mistralagents.ts - - src/sdk/mistraljobs.ts - - src/sdk/models.ts - - src/sdk/ocr.ts - - src/sdk/sdk.ts - - src/sdk/transcriptions.ts - - src/types/async.ts - - src/types/blobs.ts - - src/types/constdatetime.ts - - src/types/enums.ts - - src/types/fp.ts - - src/types/index.ts - - src/types/operations.ts - - src/types/rfcdate.ts - - src/types/streams.ts - - tsconfig.json -examples: - list_models_v1_models_get: - speakeasy-default-list-models-v1-models-get: - responses: - "200": - application/json: {"object": "list"} - "422": - application/json: {} - retrieve_model_v1_models__model_id__get: - speakeasy-default-retrieve-model-v1-models-model-id-get: - parameters: - path: - model_id: "ft:open-mistral-7b:587a6b29:20240514:7e773925" - responses: - "200": - application/json: {"id": "", "object": "model", "owned_by": "mistralai", "capabilities": {"completion_chat": true, "completion_fim": false, "function_calling": true, "fine_tuning": false, "vision": false, "classification": false}, "max_context_length": 32768, "type": "fine-tuned", "job": "Product Markets Facilitator", "root": "", "archived": false} - "422": - application/json: {} - delete_model_v1_models__model_id__delete: - speakeasy-default-delete-model-v1-models-model-id-delete: - parameters: - path: - model_id: "ft:open-mistral-7b:587a6b29:20240514:7e773925" - responses: - "200": - application/json: {"id": "ft:open-mistral-7b:587a6b29:20240514:7e773925", "object": "model", "deleted": true} - "422": - application/json: {} - jobs_api_routes_fine_tuning_update_fine_tuned_model: - speakeasy-default-jobs-api-routes-fine-tuning-update-fine-tuned-model: - parameters: - path: - model_id: "ft:open-mistral-7b:587a6b29:20240514:7e773925" - requestBody: - application/json: {} - responses: - "200": - application/json: {"id": "", "object": "model", "created": 124166, "owned_by": "", "workspace_id": "", "root": "", "root_version": "", "archived": true, "capabilities": {"completion_chat": true, "completion_fim": false, "function_calling": false, "fine_tuning": false, "classification": false}, "max_context_length": 32768, "job": "c4f8ef9a-6612-4f49-88fa-a80eb8116e46", "model_type": "completion"} - jobs_api_routes_fine_tuning_archive_fine_tuned_model: - speakeasy-default-jobs-api-routes-fine-tuning-archive-fine-tuned-model: - parameters: - path: - model_id: "ft:open-mistral-7b:587a6b29:20240514:7e773925" - responses: - "200": - application/json: {"id": "", "object": "model", "archived": true} - jobs_api_routes_fine_tuning_unarchive_fine_tuned_model: - speakeasy-default-jobs-api-routes-fine-tuning-unarchive-fine-tuned-model: - parameters: - path: - model_id: "ft:open-mistral-7b:587a6b29:20240514:7e773925" - responses: - "200": - application/json: {"id": "", "object": "model", "archived": false} - agents_api_v1_conversations_start: - speakeasy-default-agents-api-v1-conversations-start: - requestBody: - application/json: {"inputs": "", "stream": false} - responses: - "200": - application/json: {"object": "conversation.response", "conversation_id": "", "outputs": [{"object": "entry", "type": "agent.handoff", "previous_agent_id": "", "previous_agent_name": "", "next_agent_id": "", "next_agent_name": ""}], "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}} - "422": - application/json: {} - agents_api_v1_conversations_list: - speakeasy-default-agents-api-v1-conversations-list: - parameters: - query: - page: 0 - page_size: 100 - responses: - "200": - application/json: [{"object": "conversation", "id": "", "created_at": "2025-11-20T22:30:47.754Z", "updated_at": "2025-08-05T08:36:20.296Z", "agent_id": ""}] - "422": - application/json: {} - agents_api_v1_conversations_get: - speakeasy-default-agents-api-v1-conversations-get: - parameters: - path: - conversation_id: "" - responses: - "200": - application/json: {"object": "conversation", "id": "", "created_at": "2023-06-02T14:00:42.201Z", "updated_at": "2024-10-06T17:16:50.325Z", "agent_id": ""} - "422": - application/json: {} - agents_api_v1_conversations_append: - speakeasy-default-agents-api-v1-conversations-append: - parameters: - path: - conversation_id: "" - requestBody: - application/json: {"inputs": [], "stream": false, "store": true, "handoff_execution": "server"} - responses: - "200": - application/json: {"object": "conversation.response", "conversation_id": "", "outputs": [], "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}} - "422": - application/json: {} - agents_api_v1_conversations_history: - speakeasy-default-agents-api-v1-conversations-history: - parameters: - path: - conversation_id: "" - responses: - "200": - application/json: {"object": "conversation.history", "conversation_id": "", "entries": [{"object": "entry", "type": "tool.execution", "name": "code_interpreter", "arguments": ""}]} - "422": - application/json: {} - agents_api_v1_conversations_messages: - speakeasy-default-agents-api-v1-conversations-messages: - parameters: - path: - conversation_id: "" - responses: - "200": - application/json: {"object": "conversation.messages", "conversation_id": "", "messages": []} - "422": - application/json: {} - agents_api_v1_conversations_restart: - speakeasy-default-agents-api-v1-conversations-restart: - parameters: - path: - conversation_id: "" - requestBody: - application/json: {"inputs": "", "stream": false, "store": true, "handoff_execution": "server", "from_entry_id": ""} - responses: - "200": - application/json: {"object": "conversation.response", "conversation_id": "", "outputs": [], "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}} - "422": - application/json: {} - agents_api_v1_conversations_start_stream: - speakeasy-default-agents-api-v1-conversations-start-stream: - requestBody: - application/json: {"inputs": [{"object": "entry", "type": "agent.handoff", "previous_agent_id": "", "previous_agent_name": "", "next_agent_id": "", "next_agent_name": ""}], "stream": true} - responses: - "422": - application/json: {} - agents_api_v1_conversations_append_stream: - speakeasy-default-agents-api-v1-conversations-append-stream: - parameters: - path: - conversation_id: "" - requestBody: - application/json: {"inputs": "", "stream": true, "store": true, "handoff_execution": "server"} - responses: - "422": - application/json: {} - agents_api_v1_conversations_restart_stream: - speakeasy-default-agents-api-v1-conversations-restart-stream: - parameters: - path: - conversation_id: "" - requestBody: - application/json: {"inputs": [{"object": "entry", "type": "message.input", "role": "assistant", "content": "", "prefix": false}], "stream": true, "store": true, "handoff_execution": "server", "from_entry_id": ""} - responses: - "422": - application/json: {} - agents_api_v1_agents_create: - speakeasy-default-agents-api-v1-agents-create: - requestBody: - application/json: {"model": "LeBaron", "name": ""} - responses: - "200": - application/json: {"model": "Ranchero", "name": "", "object": "agent", "id": "", "version": 316961, "created_at": "2025-03-26T19:00:51.430Z", "updated_at": "2023-04-28T15:08:02.110Z"} - "422": - application/json: {} - agents_api_v1_agents_list: - speakeasy-default-agents-api-v1-agents-list: - parameters: - query: - page: 0 - page_size: 20 - responses: - "200": - application/json: [{"model": "Impala", "name": "", "object": "agent", "id": "", "version": 43153, "created_at": "2024-04-26T15:54:09.954Z", "updated_at": "2024-02-11T18:27:55.607Z"}] - "422": - application/json: {} - agents_api_v1_agents_get: - speakeasy-default-agents-api-v1-agents-get: - parameters: - path: - agent_id: "" - responses: - "200": - application/json: {"model": "Silverado", "name": "", "object": "agent", "id": "", "version": 845972, "created_at": "2025-08-21T03:10:48.135Z", "updated_at": "2024-11-11T17:15:57.309Z"} - "422": - application/json: {} - agents_api_v1_agents_update: - speakeasy-default-agents-api-v1-agents-update: - parameters: - path: - agent_id: "" - requestBody: - application/json: {} - responses: - "200": - application/json: {"model": "Model X", "name": "", "object": "agent", "id": "", "version": 799821, "created_at": "2025-10-20T17:35:08.067Z", "updated_at": "2023-11-16T08:47:13.265Z"} - "422": - application/json: {} - agents_api_v1_agents_update_version: - speakeasy-default-agents-api-v1-agents-update-version: - parameters: - path: - agent_id: "" - query: - version: 157995 - responses: - "200": - application/json: {"model": "XTS", "name": "", "object": "agent", "id": "", "version": 310764, "created_at": "2023-05-08T23:29:06.216Z", "updated_at": "2023-05-16T19:20:05.735Z"} - "422": - application/json: {} - libraries_list_v1: - speakeasy-default-libraries-list-v1: - responses: - "200": - application/json: {"data": [{"id": "bfc452fd-4bcb-46ec-9f68-ceea101e924d", "name": "", "created_at": "2024-01-31T13:50:47.409Z", "updated_at": "2023-04-09T15:28:24.261Z", "owner_id": "3fb92cf9-0fea-44d0-958f-16963601a1f0", "owner_type": "", "total_size": 811051, "nb_documents": 634577, "chunk_size": 502060}]} - libraries_create_v1: - speakeasy-default-libraries-create-v1: - requestBody: - application/json: {"name": ""} - responses: - "201": - application/json: {"id": "7285d921-bbab-471e-a2df-600e096d8aca", "name": "", "created_at": "2025-12-10T18:12:15.618Z", "updated_at": "2023-12-29T15:14:03.343Z", "owner_id": "d5e2af8f-c98a-479e-aece-62d79ea6bab3", "owner_type": "", "total_size": 866940, "nb_documents": 123652, "chunk_size": 274694} - "422": - application/json: {} - libraries_get_v1: - speakeasy-default-libraries-get-v1: - parameters: - path: - library_id: "d0d23a1e-bfe5-45e7-b7bb-22a4ea78d47f" - responses: - "200": - application/json: {"id": "24e6ac5e-61cb-4f2c-b0c0-806dfd5d8dbf", "name": "", "created_at": "2023-01-19T09:20:07.756Z", "updated_at": "2023-05-28T00:39:57.656Z", "owner_id": "546a730e-7d06-4324-a4fd-2b7ff127978c", "owner_type": "", "total_size": 191122, "nb_documents": 932135, "chunk_size": null} - "422": - application/json: {} - libraries_delete_v1: - speakeasy-default-libraries-delete-v1: - parameters: - path: - library_id: "6cad0b6e-fd2e-4d11-a48b-21d30fb7c17a" - responses: - "200": - application/json: {"id": "04e83772-3f8e-41d3-a053-763ed9937e07", "name": "", "created_at": "2025-03-15T23:45:26.060Z", "updated_at": "2024-08-03T06:23:12.129Z", "owner_id": "f636aa46-e1d5-4df4-966b-de4af27da6db", "owner_type": "", "total_size": 268102, "nb_documents": 821714, "chunk_size": null} - "422": - application/json: {} - libraries_update_v1: - speakeasy-default-libraries-update-v1: - parameters: - path: - library_id: "e01880c3-d0b5-4a29-8b1b-abdb8ce917e4" - requestBody: - application/json: {} - responses: - "200": - application/json: {"id": "c3bb20a7-df8c-4461-8cfb-9e2a978c00da", "name": "", "created_at": "2025-03-12T04:49:28.349Z", "updated_at": "2025-12-18T03:09:25.092Z", "owner_id": "734e66b8-ae70-4069-9ebb-7eb7ee3967d5", "owner_type": "", "total_size": 762363, "nb_documents": 896591, "chunk_size": 507889} - "422": - application/json: {} - libraries_documents_list_v1: - speakeasy-default-libraries-documents-list-v1: - parameters: - path: - library_id: "5c3ca4cd-62bc-4c71-ad8a-1531ae80d078" - query: - page_size: 100 - page: 0 - sort_by: "created_at" - sort_order: "desc" - responses: - "200": - application/json: {"pagination": {"total_items": 23246, "total_pages": 881485, "current_page": 173326, "page_size": 318395, "has_more": false}, "data": [{"id": "5106c0c7-30fb-4fd3-9083-129b77f9f509", "library_id": "71eb68a2-756e-48b0-9d2b-a04d7bf95ff5", "hash": "", "mime_type": "", "extension": "pdf", "size": 367159, "name": "", "created_at": "2024-09-24T04:50:43.988Z", "processing_status": "", "uploaded_by_id": "7d65f4d8-1997-479f-bfb4-535c0144b48c", "uploaded_by_type": "", "tokens_processing_total": 957230}]} - "422": - application/json: {} - libraries_documents_upload_v1: - speakeasy-default-libraries-documents-upload-v1: - parameters: - path: - library_id: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76" - requestBody: - multipart/form-data: {"file": "x-file: example.file"} - responses: - "200": - application/json: {"id": "d40f9b56-c832-405d-aa99-b3e442254dd8", "library_id": "868d7955-009a-4433-bfc6-ad7b4be4e7e4", "hash": "", "mime_type": "", "extension": "m2v", "size": 418415, "name": "", "created_at": "2025-04-30T20:11:27.130Z", "processing_status": "", "uploaded_by_id": "7db8d896-09c9-438c-b6dc-aa5c70102b3f", "uploaded_by_type": "", "tokens_processing_total": 61161} - "422": - application/json: {} - libraries_documents_get_v1: - speakeasy-default-libraries-documents-get-v1: - parameters: - path: - library_id: "03d908c8-90a1-44fd-bf3a-8490fb7c9a03" - document_id: "90973aec-0508-4375-8b00-91d732414745" - responses: - "200": - application/json: {"id": "0de60230-717d-459a-8c0f-fbb9360c01be", "library_id": "e0bf3cf9-cd3b-405b-b842-ac7fcb9c373e", "hash": "", "mime_type": "", "extension": "jpe", "size": 402478, "name": "", "created_at": "2023-07-29T21:43:20.750Z", "processing_status": "", "uploaded_by_id": "d5eadabe-d7f2-4f87-a337-f80c192f886d", "uploaded_by_type": "", "tokens_processing_total": 793889} - "422": - application/json: {} - libraries_documents_update_v1: - speakeasy-default-libraries-documents-update-v1: - parameters: - path: - library_id: "3ddd8d93-dca5-4a6d-980d-173226c35742" - document_id: "2a25e44c-b160-40ca-b5c2-b65fb2fcae34" - requestBody: - application/json: {} - responses: - "200": - application/json: {"id": "1111e519-9ba5-42de-9301-938fbfee59fc", "library_id": "70aac5e3-23f7-439b-bbef-090e4c1dbd6d", "hash": "", "mime_type": "", "extension": "m1v", "size": 802305, "name": "", "created_at": "2024-07-02T20:02:03.680Z", "processing_status": "", "uploaded_by_id": "08471957-b27d-4437-8242-57256727dc49", "uploaded_by_type": "", "tokens_processing_total": 806683} - "422": - application/json: {} - libraries_documents_delete_v1: - speakeasy-default-libraries-documents-delete-v1: - parameters: - path: - library_id: "005daae9-d42e-407d-82d7-2261c6a1496c" - document_id: "edc236b0-baff-49a9-884b-4ca36a258da4" - responses: - "422": - application/json: {} - libraries_documents_get_text_content_v1: - speakeasy-default-libraries-documents-get-text-content-v1: - parameters: - path: - library_id: "1d177215-3b6b-45ba-9fa9-baf773223bec" - document_id: "60214c91-2aba-4692-a4e6-a53365de8caf" - responses: - "200": - application/json: {"text": ""} - "422": - application/json: {} - libraries_documents_get_status_v1: - speakeasy-default-libraries-documents-get-status-v1: - parameters: - path: - library_id: "e6906f70-368f-4155-80da-c1718f01bc43" - document_id: "2c904915-d831-4e9d-a345-8ce405bcef66" - responses: - "200": - application/json: {"document_id": "90473b79-1fd5-437f-bee0-6638bdf69c90", "processing_status": ""} - "422": - application/json: {} - libraries_documents_get_signed_url_v1: - speakeasy-default-libraries-documents-get-signed-url-v1: - parameters: - path: - library_id: "23cf6904-a602-4ee8-9f5b-8efc557c336d" - document_id: "48598486-df71-4994-acbb-1133c72efa8c" - responses: - "200": - application/json: "https://burdensome-jellyfish.name" - "422": - application/json: {} - libraries_documents_get_extracted_text_signed_url_v1: - speakeasy-default-libraries-documents-get-extracted-text-signed-url-v1: - parameters: - path: - library_id: "a6f15de3-1e82-4f95-af82-851499042ef8" - document_id: "9749d4f9-24e5-4ca2-99a3-a406863f805d" - responses: - "200": - application/json: "https://athletic-disadvantage.info" - "422": - application/json: {} - libraries_documents_reprocess_v1: - speakeasy-default-libraries-documents-reprocess-v1: - parameters: - path: - library_id: "51b29371-de8f-4ba4-932b-a0bafb3a7f64" - document_id: "3052422c-49ca-45ac-a918-cadb35d61fd8" - responses: - "422": - application/json: {} - libraries_share_list_v1: - speakeasy-default-libraries-share-list-v1: - parameters: - path: - library_id: "d2169833-d8e2-416e-a372-76518d3d99c2" - responses: - "200": - application/json: {"data": [{"library_id": "26c08a7a-d226-4d29-b4d8-c08f0ad41dd1", "org_id": "254e3633-51b9-47a9-bc14-466ecf29d167", "role": "", "share_with_type": "", "share_with_uuid": "815eb88e-1f97-4782-863f-5fd00d37268b"}]} - "422": - application/json: {} - libraries_share_create_v1: - speakeasy-default-libraries-share-create-v1: - parameters: - path: - library_id: "36de3a24-5b1c-4c8f-9d84-d5642205a976" - requestBody: - application/json: {"org_id": "aadd9ae1-f285-4437-884a-091c77efa6fd", "level": "Viewer", "share_with_uuid": "0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20", "share_with_type": "User"} - responses: - "200": - application/json: {"library_id": "45b3a5b2-8b81-4453-9130-ded7f1e5a366", "org_id": "0fa6e542-f04b-431e-a1be-76a9a92b0e68", "role": "", "share_with_type": "", "share_with_uuid": "cdbcc0c5-e577-4880-8ed3-f919421d4fc5"} - "422": - application/json: {} - libraries_share_delete_v1: - speakeasy-default-libraries-share-delete-v1: - parameters: - path: - library_id: "709e3cad-9fb2-4f4e-bf88-143cf1808107" - requestBody: - application/json: {"org_id": "0814a235-c2d0-4814-875a-4b85f93d3dc7", "share_with_uuid": "b843cc47-ce8f-4354-8cfc-5fcd7fb2865b", "share_with_type": "User"} - responses: - "200": - application/json: {"library_id": "7f9c6af4-e362-4cf1-9363-0409d51c2dfa", "org_id": "6b2cac3a-b29c-4d8f-bebb-0db06ec1bf97", "role": "", "share_with_type": "", "share_with_uuid": "618c78f1-41ca-45c3-8ef2-7d78898c7061"} - "422": - application/json: {} - files_api_routes_upload_file: - speakeasy-default-files-api-routes-upload-file: - requestBody: - multipart/form-data: {"file": "x-file: example.file"} - responses: - "200": - application/json: {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", "object": "file", "bytes": 13000, "created_at": 1716963433, "filename": "files_upload.jsonl", "purpose": "batch", "sample_type": "batch_result", "source": "upload"} - files_api_routes_list_files: - speakeasy-default-files-api-routes-list-files: - parameters: - query: - page: 0 - page_size: 100 - responses: - "200": - application/json: {"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", "object": "file", "bytes": 13000, "created_at": 1716963433, "filename": "files_upload.jsonl", "purpose": "fine-tune", "sample_type": "batch_error", "source": "upload"}], "object": "", "total": 999335} - files_api_routes_retrieve_file: - speakeasy-default-files-api-routes-retrieve-file: - parameters: - path: - file_id: "f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6" - responses: - "200": - application/json: {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", "object": "file", "bytes": 13000, "created_at": 1716963433, "filename": "files_upload.jsonl", "purpose": "batch", "sample_type": "instruct", "source": "repository", "deleted": false} - files_api_routes_delete_file: - speakeasy-default-files-api-routes-delete-file: - parameters: - path: - file_id: "3b6d45eb-e30b-416f-8019-f47e2e93d930" - responses: - "200": - application/json: {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f09", "object": "file", "deleted": false} - files_api_routes_download_file: - speakeasy-default-files-api-routes-download-file: - parameters: - path: - file_id: "f8919994-a4a1-46b2-8b5b-06335a4300ce" - responses: - "200": - application/octet-stream: "x-file: example.file" - files_api_routes_get_signed_url: - speakeasy-default-files-api-routes-get-signed-url: - parameters: - path: - file_id: "06a020ab-355c-49a6-b19d-304b7c01699f" - query: - expiry: 24 - responses: - "200": - application/json: {"url": "https://knotty-birdcage.net/"} - jobs_api_routes_fine_tuning_get_fine_tuning_jobs: - speakeasy-default-jobs-api-routes-fine-tuning-get-fine-tuning-jobs: - parameters: - query: - page: 0 - page_size: 100 - created_by_me: false - responses: - "200": - application/json: {"object": "list", "total": 843585} - jobs_api_routes_fine_tuning_create_fine_tuning_job: - speakeasy-default-jobs-api-routes-fine-tuning-create-fine-tuning-job: - requestBody: - application/json: {"model": "Camaro", "invalid_sample_skip_percentage": 0, "hyperparameters": {"learning_rate": 0.0001}} - responses: - "200": - application/json: {"expected_duration_seconds": 220, "cost": 10, "cost_currency": "EUR", "train_tokens_per_step": 131072, "train_tokens": 1310720, "data_tokens": 305375, "deprecated": true, "details": "", "epochs": 4.2922, "training_steps": 10, "object": "job.metadata"} - jobs_api_routes_fine_tuning_get_fine_tuning_job: - speakeasy-default-jobs-api-routes-fine-tuning-get-fine-tuning-job: - parameters: - path: - job_id: "c167a961-ffca-4bcf-93ac-6169468dd389" - responses: - "200": - application/json: {"id": "babac92a-96fa-48c4-931c-f6f97e1bf24c", "auto_start": false, "model": "Spyder", "status": "FAILED", "created_at": 232438, "modified_at": 32259, "training_files": ["7a95c5a0-399d-4665-84c8-deab766d22dc"], "object": "job", "job_type": "classifier", "hyperparameters": {"learning_rate": 0.0001}, "classifier_targets": [{"name": "", "labels": [], "weight": 5651, "loss_function": "single_class"}]} - jobs_api_routes_fine_tuning_cancel_fine_tuning_job: - speakeasy-default-jobs-api-routes-fine-tuning-cancel-fine-tuning-job: - parameters: - path: - job_id: "6188a2f6-7513-4e0f-89cc-3f8088523a49" - responses: - "200": - application/json: {"id": "770b9cc0-1ab6-44de-a816-67010644e9fb", "auto_start": false, "model": "Volt", "status": "CANCELLATION_REQUESTED", "created_at": 546404, "modified_at": 180081, "training_files": ["45e621c6-ac30-4133-b6d1-fc0d1fe24c9f"], "object": "job", "job_type": "classifier", "hyperparameters": {"learning_rate": 0.0001}, "classifier_targets": [{"name": "", "labels": [""], "weight": 1298.58, "loss_function": "multi_class"}]} - jobs_api_routes_fine_tuning_start_fine_tuning_job: - speakeasy-default-jobs-api-routes-fine-tuning-start-fine-tuning-job: - parameters: - path: - job_id: "56553e4d-0679-471e-b9ac-59a77d671103" - responses: - "200": - application/json: {"id": "68ad461a-676e-47fe-a07e-15e38f5082b5", "auto_start": false, "model": "Grand Cherokee", "status": "STARTED", "created_at": 134515, "modified_at": 192651, "training_files": ["39dabc3d-15eb-49ac-a549-69973f33acee"], "object": "job", "job_type": "completion", "hyperparameters": {"learning_rate": 0.0001}} - jobs_api_routes_batch_get_batch_jobs: - speakeasy-default-jobs-api-routes-batch-get-batch-jobs: - parameters: - query: - page: 0 - page_size: 100 - created_by_me: false - responses: - "200": - application/json: {"object": "list", "total": 186589} - jobs_api_routes_batch_create_batch_job: - speakeasy-default-jobs-api-routes-batch-create-batch-job: - requestBody: - application/json: {"input_files": ["fe3343a2-3b8d-404b-ba32-a78dede2614a"], "endpoint": "/v1/classifications", "timeout_hours": 24} - responses: - "200": - application/json: {"id": "", "object": "batch", "input_files": [], "endpoint": "", "errors": [{"message": "", "count": 1}], "status": "FAILED", "created_at": 740240, "total_requests": 155947, "completed_requests": 358424, "succeeded_requests": 317170, "failed_requests": 190260} - jobs_api_routes_batch_get_batch_job: - speakeasy-default-jobs-api-routes-batch-get-batch-job: - parameters: - path: - job_id: "4017dc9f-b629-42f4-9700-8c681b9e7f0f" - responses: - "200": - application/json: {"id": "", "object": "batch", "input_files": ["11b83f16-f2f9-4de4-a81f-203fff419c99"], "endpoint": "", "errors": [], "status": "RUNNING", "created_at": 638324, "total_requests": 900958, "completed_requests": 458292, "succeeded_requests": 184893, "failed_requests": 104800} - jobs_api_routes_batch_cancel_batch_job: - speakeasy-default-jobs-api-routes-batch-cancel-batch-job: - parameters: - path: - job_id: "4fb29d1c-535b-4f0a-a1cb-2167f86da569" - responses: - "200": - application/json: {"id": "", "object": "batch", "input_files": ["8fd9d88a-66be-43fd-a816-ba509ca3ca85"], "endpoint": "", "errors": [{"message": "", "count": 1}], "status": "QUEUED", "created_at": 664676, "total_requests": 608251, "completed_requests": 12693, "succeeded_requests": 203340, "failed_requests": 189291} - chat_completion_v1_chat_completions_post: - speakeasy-default-chat-completion-v1-chat-completions-post: - requestBody: - application/json: {"model": "mistral-small-latest", "stream": false, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "mistral-small-latest", "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}, "created": 1702256327, "choices": []} - "422": - application/json: {} - stream_chat: - speakeasy-default-stream-chat: - requestBody: - application/json: {"model": "mistral-small-latest", "stream": true, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "422": - application/json: {} - fim_completion_v1_fim_completions_post: - speakeasy-default-fim-completion-v1-fim-completions-post: - requestBody: - application/json: {"model": "codestral-2405", "top_p": 1, "stream": false, "prompt": "def", "suffix": "return a+b"} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "codestral-latest", "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}, "created": 1702256327, "choices": []} - "422": - application/json: {} - stream_fim: - speakeasy-default-stream-fim: - requestBody: - application/json: {"model": "codestral-2405", "top_p": 1, "stream": true, "prompt": "def", "suffix": "return a+b"} - responses: - "422": - application/json: {} - agents_completion_v1_agents_completions_post: - speakeasy-default-agents-completion-v1-agents-completions-post: - requestBody: - application/json: {"stream": false, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}], "agent_id": ""} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "mistral-small-latest", "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}, "created": 1702256327, "choices": []} - "422": - application/json: {} - stream_agents: - speakeasy-default-stream-agents: - requestBody: - application/json: {"stream": true, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}], "agent_id": ""} - responses: - "422": - application/json: {} - embeddings_v1_embeddings_post: - speakeasy-default-embeddings-v1-embeddings-post: - requestBody: - application/json: {"model": "mistral-embed", "input": ["Embed this sentence.", "As well as this one."]} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "mistral-small-latest", "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}, "data": [{"object": "embedding", "embedding": [0.1, 0.2, 0.3], "index": 0}, {"object": "embedding", "embedding": [0.4, 0.5, 0.6], "index": 1}]} - "422": - application/json: {} - moderations_v1_moderations_post: - speakeasy-default-moderations-v1-moderations-post: - requestBody: - application/json: {"model": "Durango", "input": ["", ""]} - responses: - "200": - application/json: {"id": "mod-e5cc70bb28c444948073e77776eb30ef", "model": "Corvette", "results": [{}]} - "422": - application/json: {} - chat_moderations_v1_chat_moderations_post: - speakeasy-default-chat-moderations-v1-chat-moderations-post: - requestBody: - application/json: {"input": [{"content": "", "role": "tool"}], "model": "LeBaron"} - responses: - "200": - application/json: {"id": "mod-e5cc70bb28c444948073e77776eb30ef", "model": "Explorer", "results": [{}]} - "422": - application/json: {} - classifications_v1_classifications_post: - speakeasy-default-classifications-v1-classifications-post: - requestBody: - application/json: {"model": "Silverado", "input": [""]} - responses: - "200": - application/json: {"id": "mod-e5cc70bb28c444948073e77776eb30ef", "model": "ATS", "results": [{}, {"key": {"scores": {"key": 2080.19}}}]} - "422": - application/json: {} - chat_classifications_v1_chat_classifications_post: - speakeasy-default-chat-classifications-v1-chat-classifications-post: - requestBody: - application/json: {"model": "Camry", "input": [{"messages": [{"content": "", "role": "system"}]}]} - responses: - "200": - application/json: {"id": "mod-e5cc70bb28c444948073e77776eb30ef", "model": "Altima", "results": [{}, {"key": {"scores": {"key": 1360.53, "key1": 5946.42}}}, {"key": {"scores": {"key": 1360.53, "key1": 5946.42}}}]} - "422": - application/json: {} - ocr_v1_ocr_post: - speakeasy-default-ocr-v1-ocr-post: - requestBody: - application/json: {"model": "CX-9", "document": {"document_url": "https://upset-labourer.net/", "type": "document_url"}} - responses: - "200": - application/json: {"pages": [], "model": "Golf", "usage_info": {"pages_processed": 944919}} - "422": - application/json: {} - audio_api_v1_transcriptions_post: - speakeasy-default-audio-api-v1-transcriptions-post: - requestBody: - multipart/form-data: {"model": "Model X", "stream": false} - responses: - "200": - application/json: {"model": "Beetle", "text": "", "usage": {"prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0}, "language": ""} - audio_api_v1_transcriptions_post_stream: - speakeasy-default-audio-api-v1-transcriptions-post-stream: - requestBody: - multipart/form-data: {"model": "Camry", "stream": true} -examplesVersion: 1.0.2 -generatedTests: {} diff --git a/examples/sdks/mistral-typescript/.speakeasy/gen.yaml b/examples/sdks/mistral-typescript/.speakeasy/gen.yaml deleted file mode 100644 index a1ba4793a..000000000 --- a/examples/sdks/mistral-typescript/.speakeasy/gen.yaml +++ /dev/null @@ -1,65 +0,0 @@ -configVersion: 2.0.0 -generation: - devContainers: - enabled: true - schemaPath: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi - sdkClassName: mistral - maintainOpenAPIOrder: true - usageSnippets: - optionalPropertyRendering: withExample - sdkInitStyle: constructor - useClassNamesForArrayFields: true - fixes: - nameResolutionDec2023: true - nameResolutionFeb2025: false - parameterOrderingFeb2024: true - requestResponseComponentNamesFeb2024: true - securityFeb2025: false - sharedErrorComponentsApr2025: false - auth: - oAuth2ClientCredentialsEnabled: true - oAuth2PasswordEnabled: false - tests: - generateTests: true - generateNewTests: false - skipResponseBodyAssertions: false -typescript: - version: 1.10.0 - additionalDependencies: - dependencies: - zod-to-json-schema: ^3.24.1 - devDependencies: {} - peerDependencies: {} - additionalPackageJSON: {} - author: Speakeasy - baseErrorName: MistralError - clientServerStatusCodesAsErrors: true - constFieldsAlwaysOptional: true - defaultErrorName: SDKError - enableCustomCodeRegions: true - enableMCPServer: false - enableReactQuery: false - enumFormat: union - envVarPrefix: MISTRAL - flattenGlobalSecurity: true - flatteningOrder: body-first - generateExamples: true - imports: - option: openapi - paths: - callbacks: models/callbacks - errors: models/errors - operations: models/operations - shared: models/components - webhooks: models/webhooks - inputModelSuffix: input - jsonpath: legacy - maxMethodParams: 0 - methodArguments: infer-optional-args - moduleFormat: commonjs - outputModelSuffix: output - packageName: '@mistralai/mistralai' - responseFormat: flat - templateVersion: v2 - usageSDKInitImports: [] - useIndexModules: true diff --git a/examples/sdks/mistral-typescript/.speakeasy/workflow.lock b/examples/sdks/mistral-typescript/.speakeasy/workflow.lock deleted file mode 100644 index 6f4dd0c4f..000000000 --- a/examples/sdks/mistral-typescript/.speakeasy/workflow.lock +++ /dev/null @@ -1,91 +0,0 @@ -speakeasyVersion: 1.606.10 -sources: - mistral-azure-source: - sourceNamespace: mistral-openapi-azure - sourceRevisionDigest: sha256:670c460702ec74f7077491464a6dc5ee9d873969c80e812c48dbf4deb160e470 - sourceBlobDigest: sha256:5a3ebfa4cb00a015bb7bb03ec7442fc7e0b9c17ca66ab35d3045290b2ad87eac - tags: - - latest - - speakeasy-sdk-regen-1756133560 - mistral-google-cloud-source: - sourceNamespace: mistral-openapi-google-cloud - sourceRevisionDigest: sha256:4a5343e63c6a78152e472b00ccc46d7bcb15594496bc94c8040039d3a9d4c5f8 - sourceBlobDigest: sha256:3327f078a11596abdcbc21cd8a1adcf0b2aa474975cd9ab1feb745a2e50d555f - tags: - - latest - - speakeasy-sdk-regen-1742480568 - mistral-openapi: - sourceNamespace: mistral-openapi - sourceRevisionDigest: sha256:eefc1f0b6a5e9ec673d317d61cad766290710b5fc369412491b75f732cccfedd - sourceBlobDigest: sha256:97767522559603de92a9738938e522cea4d558b2a854500acf6fe8d81f8ccfb8 - tags: - - latest - - speakeasy-sdk-regen-1756820432 -targets: - mistralai-azure-sdk: - source: mistral-azure-source - sourceNamespace: mistral-openapi-azure - sourceRevisionDigest: sha256:670c460702ec74f7077491464a6dc5ee9d873969c80e812c48dbf4deb160e470 - sourceBlobDigest: sha256:5a3ebfa4cb00a015bb7bb03ec7442fc7e0b9c17ca66ab35d3045290b2ad87eac - codeSamplesNamespace: mistral-openapi-azure-code-samples - codeSamplesRevisionDigest: sha256:d373ba4abaf784b31d5e84bf6df764cfefc312dc926b6ac1503f95c2a0c5cfee - mistralai-gcp-sdk: - source: mistral-google-cloud-source - sourceNamespace: mistral-openapi-google-cloud - sourceRevisionDigest: sha256:4a5343e63c6a78152e472b00ccc46d7bcb15594496bc94c8040039d3a9d4c5f8 - sourceBlobDigest: sha256:3327f078a11596abdcbc21cd8a1adcf0b2aa474975cd9ab1feb745a2e50d555f - codeSamplesNamespace: mistral-openapi-google-cloud-code-samples - codeSamplesRevisionDigest: sha256:4b6150daaeabee64521e9cbfb209d2aaf84746dabd6e359a9728e18b5f25380a - mistralai-sdk: - source: mistral-openapi - sourceNamespace: mistral-openapi - sourceRevisionDigest: sha256:eefc1f0b6a5e9ec673d317d61cad766290710b5fc369412491b75f732cccfedd - sourceBlobDigest: sha256:97767522559603de92a9738938e522cea4d558b2a854500acf6fe8d81f8ccfb8 - codeSamplesNamespace: mistral-openapi-code-samples - codeSamplesRevisionDigest: sha256:2fee7233bdb7d0e0abb8ee3d4f91687a225f5085d54ab422bf8b41cea45d5907 -workflow: - workflowVersion: 1.0.0 - speakeasyVersion: v1.606.10 - sources: - mistral-azure-source: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-azure:main - mistral-google-cloud-source: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-google-cloud:main - mistral-openapi: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi:main - targets: - mistralai-azure-sdk: - target: typescript - source: mistral-azure-source - output: ./packages/mistralai-azure - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-azure-code-samples - blocking: false - mistralai-gcp-sdk: - target: typescript - source: mistral-google-cloud-source - output: ./packages/mistralai-gcp - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-google-cloud-code-samples - blocking: false - mistralai-sdk: - target: typescript - source: mistral-openapi - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-code-samples - blocking: false diff --git a/examples/sdks/mistral-typescript/.speakeasy/workflow.yaml b/examples/sdks/mistral-typescript/.speakeasy/workflow.yaml deleted file mode 100644 index b932d9778..000000000 --- a/examples/sdks/mistral-typescript/.speakeasy/workflow.yaml +++ /dev/null @@ -1,45 +0,0 @@ -workflowVersion: 1.0.0 -speakeasyVersion: v1.606.10 -sources: - mistral-azure-source: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-azure:main - mistral-google-cloud-source: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-google-cloud:main - mistral-openapi: - inputs: - - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi:main -targets: - mistralai-azure-sdk: - target: typescript - source: mistral-azure-source - output: ./packages/mistralai-azure - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-azure-code-samples - blocking: false - mistralai-gcp-sdk: - target: typescript - source: mistral-google-cloud-source - output: ./packages/mistralai-gcp - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-google-cloud-code-samples - blocking: false - mistralai-sdk: - target: typescript - source: mistral-openapi - publish: - npm: - token: $npm_token - codeSamples: - registry: - location: registry.speakeasyapi.dev/mistral-dev/mistral-dev/mistral-openapi-code-samples - blocking: false diff --git a/examples/sdks/mistral-typescript/CONTRIBUTING.md b/examples/sdks/mistral-typescript/CONTRIBUTING.md deleted file mode 100644 index d585717fc..000000000 --- a/examples/sdks/mistral-typescript/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Contributing to This Repository - -Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. - -## How to Report Issues - -If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: - -- A clear and descriptive title -- Steps to reproduce the issue -- Expected and actual behavior -- Any relevant logs, screenshots, or error messages -- Information about your environment (e.g., operating system, software versions) - - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed - -## Issue Triage and Upstream Fixes - -We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. - -## Contact - -If you have any questions or need further assistance, please feel free to reach out by opening an issue. - -Thank you for your understanding and cooperation! - -The Maintainers diff --git a/examples/sdks/mistral-typescript/FUNCTIONS.md b/examples/sdks/mistral-typescript/FUNCTIONS.md deleted file mode 100644 index ba3a78702..000000000 --- a/examples/sdks/mistral-typescript/FUNCTIONS.md +++ /dev/null @@ -1,90 +0,0 @@ -# Standalone Functions - -> [!NOTE] -> This section is useful if you are using a bundler and targetting browsers and -> runtimes where the size of an application affects performance and load times. - -Every method in this SDK is also available as a standalone function. This -alternative API is suitable when targetting the browser or serverless runtimes -and using a bundler to build your application since all unused functionality -will be tree-shaken away. This includes code for unused methods, Zod schemas, -encoding helpers and response handlers. The result is dramatically smaller -impact on the application's final bundle size which grows very slowly as you use -more and more functionality from this SDK. - -Calling methods through the main SDK class remains a valid and generally more -more ergonomic option. Standalone functions represent an optimisation for a -specific category of applications. - -## Example - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesUpload } from "@mistralai/mistralai/funcs/filesUpload.js"; -import { openAsBlob } from "node:fs"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesUpload(mistral, { - file: await openAsBlob("example.file"), - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesUpload failed:", res.error); - } -} - -run(); -``` - -## Result types - -Standalone functions differ from SDK methods in that they return a -`Result` type to capture _known errors_ and document them using -the type system. By avoiding throwing errors, application code maintains clear -control flow and error-handling become part of the regular flow of application -code. - -> We use the term "known errors" because standalone functions, and JavaScript -> code in general, can still throw unexpected errors such as `TypeError`s, -> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be -> something this SDK addresses in the future. Nevertheless, there is still a lot -> of benefit from capturing most errors and turning them into values. - -The second reason for this style of programming is because these functions will -typically be used in front-end applications where exception throwing is -sometimes discouraged or considered unidiomatic. React and similar ecosystems -and libraries tend to promote this style of programming so that components -render useful content under all states (loading, success, error and so on). - -The general pattern when calling standalone functions looks like this: - -```typescript -import { Core } from ""; -import { fetchSomething } from "/funcs/fetchSomething.js"; - -const client = new Core(); - -async function run() { - const result = await fetchSomething(client, { id: "123" }); - if (!result.ok) { - // You can throw the error or handle it. It's your choice now. - throw result.error; - } - - console.log(result.value); -} - -run(); -``` - -Notably, `result.error` above will have an explicit type compared to a try-catch -variation where the error in the catch block can only be of type `unknown` (or -`any` depending on your TypeScript settings). \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/LICENSE b/examples/sdks/mistral-typescript/LICENSE deleted file mode 100644 index bec127680..000000000 --- a/examples/sdks/mistral-typescript/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2024 Mistral AI - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/examples/sdks/mistral-typescript/README.md b/examples/sdks/mistral-typescript/README.md deleted file mode 100644 index 8feada29e..000000000 --- a/examples/sdks/mistral-typescript/README.md +++ /dev/null @@ -1,819 +0,0 @@ -# Mistral Typescript Client - - -## Summary - -Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - - - -## Table of Contents - -* [Mistral Typescript Client](#mistral-typescript-client) - * [SDK Installation](#sdk-installation) - * [Requirements](#requirements) - * [API Key Setup](#api-key-setup) - * [SDK Example Usage](#sdk-example-usage) - * [Providers' SDKs](#providers-sdks) - * [Available Resources and Operations](#available-resources-and-operations) - * [Server-sent event streaming](#server-sent-event-streaming) - * [File uploads](#file-uploads) - * [Retries](#retries) - * [Error Handling](#error-handling) - * [Server Selection](#server-selection) - * [Custom HTTP Client](#custom-http-client) - * [Authentication](#authentication) - * [Providers Support](#providers-support) - * [Standalone functions](#standalone-functions) - * [Debugging](#debugging) -* [Development](#development) - * [Contributions](#contributions) - - - - -## SDK Installation - -The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. - -### NPM - -```bash -npm add @mistralai/mistralai -``` - -### PNPM - -```bash -pnpm add @mistralai/mistralai -``` - -### Bun - -```bash -bun add @mistralai/mistralai -``` - -### Yarn - -```bash -yarn add @mistralai/mistralai zod - -# Note that Yarn does not install peer dependencies automatically. You will need -# to install zod as shown above. -``` - - - -## Requirements - -For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). - - -## API Key Setup - -Before you begin, you will need a Mistral AI API key. - -1. Get your own Mistral API Key: -2. Set your Mistral API Key as an environment variable. You only need to do this once. - -```bash -# set Mistral API Key (using zsh for example) -$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv - -# reload the environment (or just quit and open a new terminal) -$ source ~/.zshenv -``` - - -## SDK Example Usage - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: - "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - console.log(result); -} - -run(); - -``` - -### Upload a file - -This example shows how to upload a file. - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { openAsBlob } from "node:fs"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.upload({ - file: await openAsBlob("example.file"), - }); - - console.log(result); -} - -run(); - -``` - -### Create Agents Completions - -This example shows how to create agents completions. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.agents.complete({ - messages: [ - { - content: - "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - - console.log(result); -} - -run(); - -``` - -### Create Embedding Request - -This example shows how to create embedding request. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.embeddings.create({ - model: "mistral-embed", - inputs: [ - "Embed this sentence.", - "As well as this one.", - ], - }); - - console.log(result); -} - -run(); - -``` - - -## Providers' SDKs - -We have dedicated SDKs for the following providers: - -- [GCP](/packages/mistralai-gcp/README.md) -- [Azure](/packages/mistralai-azure/README.md) - - -## Available Resources and Operations - -
    -Available methods - -### [agents](docs/sdks/agents/README.md) - -* [complete](docs/sdks/agents/README.md#complete) - Agents Completion -* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion - -### [audio](docs/sdks/audio/README.md) - - -#### [audio.transcriptions](docs/sdks/transcriptions/README.md) - -* [complete](docs/sdks/transcriptions/README.md#complete) - Create Transcription -* [stream](docs/sdks/transcriptions/README.md#stream) - Create streaming transcription (SSE) - -### [batch](docs/sdks/batch/README.md) - - -#### [batch.jobs](docs/sdks/mistraljobs/README.md) - -* [list](docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs -* [create](docs/sdks/mistraljobs/README.md#create) - Create Batch Job -* [get](docs/sdks/mistraljobs/README.md#get) - Get Batch Job -* [cancel](docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch Job - -### [beta](docs/sdks/beta/README.md) - - -#### [beta.agents](docs/sdks/mistralagents/README.md) - -* [create](docs/sdks/mistralagents/README.md#create) - Create a agent that can be used within a conversation. -* [list](docs/sdks/mistralagents/README.md#list) - List agent entities. -* [get](docs/sdks/mistralagents/README.md#get) - Retrieve an agent entity. -* [update](docs/sdks/mistralagents/README.md#update) - Update an agent entity. -* [updateVersion](docs/sdks/mistralagents/README.md#updateversion) - Update an agent version. - -#### [beta.conversations](docs/sdks/conversations/README.md) - -* [start](docs/sdks/conversations/README.md#start) - Create a conversation and append entries to it. -* [list](docs/sdks/conversations/README.md#list) - List all created conversations. -* [get](docs/sdks/conversations/README.md#get) - Retrieve a conversation information. -* [append](docs/sdks/conversations/README.md#append) - Append new entries to an existing conversation. -* [getHistory](docs/sdks/conversations/README.md#gethistory) - Retrieve all entries in a conversation. -* [getMessages](docs/sdks/conversations/README.md#getmessages) - Retrieve all messages in a conversation. -* [restart](docs/sdks/conversations/README.md#restart) - Restart a conversation starting from a given entry. -* [startStream](docs/sdks/conversations/README.md#startstream) - Create a conversation and append entries to it. -* [appendStream](docs/sdks/conversations/README.md#appendstream) - Append new entries to an existing conversation. -* [restartStream](docs/sdks/conversations/README.md#restartstream) - Restart a conversation starting from a given entry. - -#### [beta.libraries](docs/sdks/libraries/README.md) - -* [list](docs/sdks/libraries/README.md#list) - List all libraries you have access to. -* [create](docs/sdks/libraries/README.md#create) - Create a new Library. -* [get](docs/sdks/libraries/README.md#get) - Detailed information about a specific Library. -* [delete](docs/sdks/libraries/README.md#delete) - Delete a library and all of it's document. -* [update](docs/sdks/libraries/README.md#update) - Update a library. - -#### [beta.libraries.accesses](docs/sdks/accesses/README.md) - -* [list](docs/sdks/accesses/README.md#list) - List all of the access to this library. -* [updateOrCreate](docs/sdks/accesses/README.md#updateorcreate) - Create or update an access level. -* [delete](docs/sdks/accesses/README.md#delete) - Delete an access level. - -#### [beta.libraries.documents](docs/sdks/documents/README.md) - -* [list](docs/sdks/documents/README.md#list) - List document in a given library. -* [upload](docs/sdks/documents/README.md#upload) - Upload a new document. -* [get](docs/sdks/documents/README.md#get) - Retrieve the metadata of a specific document. -* [update](docs/sdks/documents/README.md#update) - Update the metadata of a specific document. -* [delete](docs/sdks/documents/README.md#delete) - Delete a document. -* [textContent](docs/sdks/documents/README.md#textcontent) - Retrieve the text content of a specific document. -* [status](docs/sdks/documents/README.md#status) - Retrieve the processing status of a specific document. -* [getSignedUrl](docs/sdks/documents/README.md#getsignedurl) - Retrieve the signed URL of a specific document. -* [extractedTextSignedUrl](docs/sdks/documents/README.md#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document. -* [reprocess](docs/sdks/documents/README.md#reprocess) - Reprocess a document. - -### [chat](docs/sdks/chat/README.md) - -* [complete](docs/sdks/chat/README.md#complete) - Chat Completion -* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion - -### [classifiers](docs/sdks/classifiers/README.md) - -* [moderate](docs/sdks/classifiers/README.md#moderate) - Moderations -* [moderateChat](docs/sdks/classifiers/README.md#moderatechat) - Chat Moderations -* [classify](docs/sdks/classifiers/README.md#classify) - Classifications -* [classifyChat](docs/sdks/classifiers/README.md#classifychat) - Chat Classifications - -### [embeddings](docs/sdks/embeddings/README.md) - -* [create](docs/sdks/embeddings/README.md#create) - Embeddings - -### [files](docs/sdks/files/README.md) - -* [upload](docs/sdks/files/README.md#upload) - Upload File -* [list](docs/sdks/files/README.md#list) - List Files -* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File -* [delete](docs/sdks/files/README.md#delete) - Delete File -* [download](docs/sdks/files/README.md#download) - Download File -* [getSignedUrl](docs/sdks/files/README.md#getsignedurl) - Get Signed Url - -### [fim](docs/sdks/fim/README.md) - -* [complete](docs/sdks/fim/README.md#complete) - Fim Completion -* [stream](docs/sdks/fim/README.md#stream) - Stream fim completion - -### [fineTuning](docs/sdks/finetuning/README.md) - - -#### [fineTuning.jobs](docs/sdks/jobs/README.md) - -* [list](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs -* [create](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job -* [get](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job -* [cancel](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job -* [start](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job - - -### [models](docs/sdks/models/README.md) - -* [list](docs/sdks/models/README.md#list) - List Models -* [retrieve](docs/sdks/models/README.md#retrieve) - Retrieve Model -* [delete](docs/sdks/models/README.md#delete) - Delete Model -* [update](docs/sdks/models/README.md#update) - Update Fine Tuned Model -* [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model -* [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model - -### [ocr](docs/sdks/ocr/README.md) - -* [process](docs/sdks/ocr/README.md#process) - OCR - -
    - - - -## Server-sent event streaming - -[Server-sent events][mdn-sse] are used to stream content from certain -operations. These operations will expose the stream as an async iterable that -can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will -terminate when the server no longer has any events to send and closes the -underlying connection. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.startStream({ - inputs: [ - { - object: "entry", - type: "agent.handoff", - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", - }, - ], - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); - -``` - -[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events -[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of - - - -## File uploads - -Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request. - -> [!TIP] -> -> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory: -> -> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options). -> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads. -> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element. -> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob). - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { openAsBlob } from "node:fs"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.upload({ - libraryId: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76", - requestBody: { - file: await openAsBlob("example.file"), - }, - }); - - console.log(result); -} - -run(); - -``` - - - -## Retries - -Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. - -To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list({ - retries: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - }); - - console.log(result); -} - -run(); - -``` - -If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - retryConfig: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list(); - - console.log(result); -} - -run(); - -``` - - - -## Error Handling - -[`MistralError`](./src/models/errors/mistralerror.ts) is the base class for all HTTP error responses. It has the following properties: - -| Property | Type | Description | -| ------------------- | ---------- | --------------------------------------------------------------------------------------- | -| `error.message` | `string` | Error message | -| `error.statusCode` | `number` | HTTP response status code eg `404` | -| `error.headers` | `Headers` | HTTP response headers | -| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. | -| `error.rawResponse` | `Response` | Raw HTTP response | -| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). | - -### Example -```typescript -import { Mistral } from "@mistralai/mistralai"; -import * as errors from "@mistralai/mistralai/models/errors"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - try { - const result = await mistral.models.list(); - - console.log(result); - } catch (error) { - // The base class for HTTP error responses - if (error instanceof errors.MistralError) { - console.log(error.message); - console.log(error.statusCode); - console.log(error.body); - console.log(error.headers); - - // Depending on the method different errors may be thrown - if (error instanceof errors.HTTPValidationError) { - console.log(error.data$.detail); // ValidationError[] - } - } - } -} - -run(); - -``` - -### Error Classes -**Primary error:** -* [`MistralError`](./src/models/errors/mistralerror.ts): The base class for HTTP error responses. - -
    Less common errors (7) - -
    - -**Network errors:** -* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. -* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. -* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. -* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. -* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. - - -**Inherit from [`MistralError`](./src/models/errors/mistralerror.ts)**: -* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 47 of 68 methods.* -* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string. - -
    - -\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable. - - - -## Server Selection - -### Select Server by Name - -You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: - -| Name | Server | Description | -| ---- | ------------------------ | -------------------- | -| `eu` | `https://api.mistral.ai` | EU Production server | - -#### Example - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - server: "eu", - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list(); - - console.log(result); -} - -run(); - -``` - -### Override Server URL Per-Client - -The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example: -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - serverURL: "https://api.mistral.ai", - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list(); - - console.log(result); -} - -run(); - -``` - - - -## Custom HTTP Client - -The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native -[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This -client is a thin wrapper around `fetch` and provides the ability to attach hooks -around the request lifecycle that can be used to modify the request or handle -errors and response. - -The `HTTPClient` constructor takes an optional `fetcher` argument that can be -used to integrate a third-party HTTP client or when writing tests to mock out -the HTTP client and feed in fixtures. - -The following example shows how to use the `"beforeRequest"` hook to to add a -custom header and a timeout to requests and how to use the `"requestError"` hook -to log errors: - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { HTTPClient } from "@mistralai/mistralai/lib/http"; - -const httpClient = new HTTPClient({ - // fetcher takes a function that has the same signature as native `fetch`. - fetcher: (request) => { - return fetch(request); - } -}); - -httpClient.addHook("beforeRequest", (request) => { - const nextRequest = new Request(request, { - signal: request.signal || AbortSignal.timeout(5000) - }); - - nextRequest.headers.set("x-custom-header", "custom value"); - - return nextRequest; -}); - -httpClient.addHook("requestError", (error, request) => { - console.group("Request Error"); - console.log("Reason:", `${error}`); - console.log("Endpoint:", `${request.method} ${request.url}`); - console.groupEnd(); -}); - -const sdk = new Mistral({ httpClient }); -``` - - - -## Authentication - -### Per-Client Security Schemes - -This SDK supports the following security scheme globally: - -| Name | Type | Scheme | Environment Variable | -| -------- | ---- | ----------- | -------------------- | -| `apiKey` | http | HTTP Bearer | `MISTRAL_API_KEY` | - -To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example: -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list(); - - console.log(result); -} - -run(); - -``` - - -## Providers Support - -We also provide provider specific SDK for: - -- [GCP](packages/mistralai-gcp/README.md) -- [Azure](packages/mistralai-azure/README.md) - - -## Standalone functions - -All the methods listed above are available as standalone functions. These -functions are ideal for use in applications running in the browser, serverless -runtimes or other environments where application bundle size is a primary -concern. When using a bundler to build your application, all unused -functionality will be either excluded from the final bundle or tree-shaken away. - -To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - -
    - -Available standalone functions - -- [`agentsComplete`](docs/sdks/agents/README.md#complete) - Agents Completion -- [`agentsStream`](docs/sdks/agents/README.md#stream) - Stream Agents completion -- [`audioTranscriptionsComplete`](docs/sdks/transcriptions/README.md#complete) - Create Transcription -- [`audioTranscriptionsStream`](docs/sdks/transcriptions/README.md#stream) - Create streaming transcription (SSE) -- [`batchJobsCancel`](docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch Job -- [`batchJobsCreate`](docs/sdks/mistraljobs/README.md#create) - Create Batch Job -- [`batchJobsGet`](docs/sdks/mistraljobs/README.md#get) - Get Batch Job -- [`batchJobsList`](docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs -- [`betaAgentsCreate`](docs/sdks/mistralagents/README.md#create) - Create a agent that can be used within a conversation. -- [`betaAgentsGet`](docs/sdks/mistralagents/README.md#get) - Retrieve an agent entity. -- [`betaAgentsList`](docs/sdks/mistralagents/README.md#list) - List agent entities. -- [`betaAgentsUpdate`](docs/sdks/mistralagents/README.md#update) - Update an agent entity. -- [`betaAgentsUpdateVersion`](docs/sdks/mistralagents/README.md#updateversion) - Update an agent version. -- [`betaConversationsAppend`](docs/sdks/conversations/README.md#append) - Append new entries to an existing conversation. -- [`betaConversationsAppendStream`](docs/sdks/conversations/README.md#appendstream) - Append new entries to an existing conversation. -- [`betaConversationsGet`](docs/sdks/conversations/README.md#get) - Retrieve a conversation information. -- [`betaConversationsGetHistory`](docs/sdks/conversations/README.md#gethistory) - Retrieve all entries in a conversation. -- [`betaConversationsGetMessages`](docs/sdks/conversations/README.md#getmessages) - Retrieve all messages in a conversation. -- [`betaConversationsList`](docs/sdks/conversations/README.md#list) - List all created conversations. -- [`betaConversationsRestart`](docs/sdks/conversations/README.md#restart) - Restart a conversation starting from a given entry. -- [`betaConversationsRestartStream`](docs/sdks/conversations/README.md#restartstream) - Restart a conversation starting from a given entry. -- [`betaConversationsStart`](docs/sdks/conversations/README.md#start) - Create a conversation and append entries to it. -- [`betaConversationsStartStream`](docs/sdks/conversations/README.md#startstream) - Create a conversation and append entries to it. -- [`betaLibrariesAccessesDelete`](docs/sdks/accesses/README.md#delete) - Delete an access level. -- [`betaLibrariesAccessesList`](docs/sdks/accesses/README.md#list) - List all of the access to this library. -- [`betaLibrariesAccessesUpdateOrCreate`](docs/sdks/accesses/README.md#updateorcreate) - Create or update an access level. -- [`betaLibrariesCreate`](docs/sdks/libraries/README.md#create) - Create a new Library. -- [`betaLibrariesDelete`](docs/sdks/libraries/README.md#delete) - Delete a library and all of it's document. -- [`betaLibrariesDocumentsDelete`](docs/sdks/documents/README.md#delete) - Delete a document. -- [`betaLibrariesDocumentsExtractedTextSignedUrl`](docs/sdks/documents/README.md#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document. -- [`betaLibrariesDocumentsGet`](docs/sdks/documents/README.md#get) - Retrieve the metadata of a specific document. -- [`betaLibrariesDocumentsGetSignedUrl`](docs/sdks/documents/README.md#getsignedurl) - Retrieve the signed URL of a specific document. -- [`betaLibrariesDocumentsList`](docs/sdks/documents/README.md#list) - List document in a given library. -- [`betaLibrariesDocumentsReprocess`](docs/sdks/documents/README.md#reprocess) - Reprocess a document. -- [`betaLibrariesDocumentsStatus`](docs/sdks/documents/README.md#status) - Retrieve the processing status of a specific document. -- [`betaLibrariesDocumentsTextContent`](docs/sdks/documents/README.md#textcontent) - Retrieve the text content of a specific document. -- [`betaLibrariesDocumentsUpdate`](docs/sdks/documents/README.md#update) - Update the metadata of a specific document. -- [`betaLibrariesDocumentsUpload`](docs/sdks/documents/README.md#upload) - Upload a new document. -- [`betaLibrariesGet`](docs/sdks/libraries/README.md#get) - Detailed information about a specific Library. -- [`betaLibrariesList`](docs/sdks/libraries/README.md#list) - List all libraries you have access to. -- [`betaLibrariesUpdate`](docs/sdks/libraries/README.md#update) - Update a library. -- [`chatComplete`](docs/sdks/chat/README.md#complete) - Chat Completion -- [`chatStream`](docs/sdks/chat/README.md#stream) - Stream chat completion -- [`classifiersClassify`](docs/sdks/classifiers/README.md#classify) - Classifications -- [`classifiersClassifyChat`](docs/sdks/classifiers/README.md#classifychat) - Chat Classifications -- [`classifiersModerate`](docs/sdks/classifiers/README.md#moderate) - Moderations -- [`classifiersModerateChat`](docs/sdks/classifiers/README.md#moderatechat) - Chat Moderations -- [`embeddingsCreate`](docs/sdks/embeddings/README.md#create) - Embeddings -- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete File -- [`filesDownload`](docs/sdks/files/README.md#download) - Download File -- [`filesGetSignedUrl`](docs/sdks/files/README.md#getsignedurl) - Get Signed Url -- [`filesList`](docs/sdks/files/README.md#list) - List Files -- [`filesRetrieve`](docs/sdks/files/README.md#retrieve) - Retrieve File -- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload File -- [`fimComplete`](docs/sdks/fim/README.md#complete) - Fim Completion -- [`fimStream`](docs/sdks/fim/README.md#stream) - Stream fim completion -- [`fineTuningJobsCancel`](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job -- [`fineTuningJobsCreate`](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job -- [`fineTuningJobsGet`](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job -- [`fineTuningJobsList`](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs -- [`fineTuningJobsStart`](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job -- [`modelsArchive`](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model -- [`modelsDelete`](docs/sdks/models/README.md#delete) - Delete Model -- [`modelsList`](docs/sdks/models/README.md#list) - List Models -- [`modelsRetrieve`](docs/sdks/models/README.md#retrieve) - Retrieve Model -- [`modelsUnarchive`](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model -- [`modelsUpdate`](docs/sdks/models/README.md#update) - Update Fine Tuned Model -- [`ocrProcess`](docs/sdks/ocr/README.md#process) - OCR - -
    - - - -## Debugging - -You can setup your SDK to emit debug logs for SDK requests and responses. - -You can pass a logger that matches `console`'s interface as an SDK option. - -> [!WARNING] -> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const sdk = new Mistral({ debugLogger: console }); -``` - -You can also enable a default debug logger by setting an environment variable `MISTRAL_DEBUG` to true. - - - - -# Development - -## Contributions - -While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. -We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. - diff --git a/examples/sdks/mistral-typescript/RELEASES.md b/examples/sdks/mistral-typescript/RELEASES.md deleted file mode 100644 index e25eb04e6..000000000 --- a/examples/sdks/mistral-typescript/RELEASES.md +++ /dev/null @@ -1,281 +0,0 @@ - - -## 2024-08-07 14:12:46 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.356.0 (2.388.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.0] . -### Releases -- [NPM v1.0.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.0 - . - -## 2024-08-07 17:09:34 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.356.0 (2.388.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.1] . -### Releases -- [NPM v1.0.1] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.1 - . - -## 2024-08-08 18:05:34 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.357.4 (2.390.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.2] . -### Releases -- [NPM v1.0.2] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.2 - . - -## 2024-08-20 08:43:27 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.376.0 (2.402.5) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.3] . -### Releases -- [NPM v1.0.3] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.3 - . - -## 2024-08-23 13:33:36 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.378.0 (2.404.3) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.4] . -### Releases -- [NPM v1.0.4] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.4 - . - -## 2024-09-18 14:34:12 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.1.0] . -### Releases -- [NPM v1.1.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.1.0 - . - -## 2024-11-07 16:53:54 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.434.2 (2.452.0) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.2.0] . -### Releases -- [NPM v1.2.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.2.0 - . - -## 2024-11-07 20:58:48 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.434.4 (2.452.0) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.0] . -### Releases -- [NPM v1.3.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.3.0 - . - -## 2024-11-12 18:04:57 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.1] . -### Releases -- [NPM v1.3.1] https://www.npmjs.com/package/@mistralai/mistralai/v/1.3.1 - . - -## 2024-11-15 18:37:02 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.4] . -### Releases -- [NPM v1.3.4] https://www.npmjs.com/package/@mistralai/mistralai/v/1.3.4 - . - -## 2024-12-04 09:42:29 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.451.1 (2.470.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.5] . -### Releases -- [NPM v1.3.5] https://www.npmjs.com/package/@mistralai/mistralai/v/1.3.5 - . - -## 2025-01-06 10:25:54 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.462.2 (2.486.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.6] . -### Releases -- [NPM v1.3.6] https://www.npmjs.com/package/@mistralai/mistralai/v/1.3.6 - . - -## 2025-01-21 10:40:40 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.469.11 (2.493.32) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.4.0] . -### Releases -- [NPM v1.4.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.4.0 - . - -## 2025-01-27 14:54:13 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.476.2 (2.495.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.5.0] . -### Releases -- [NPM v1.5.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.5.0 - . - -## 2025-03-06 16:38:32 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.477.0 (2.497.0) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.5.1] . -### Releases -- [NPM v1.5.1] https://www.npmjs.com/package/@mistralai/mistralai/v/1.5.1 - . - -## 2025-03-14 09:44:35 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.5.2] . -### Releases -- [NPM v1.5.2] https://www.npmjs.com/package/@mistralai/mistralai/v/1.5.2 - . - -## 2025-04-16 19:16:52 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.6.0] . -### Releases -- [NPM v1.6.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.6.0 - . - -## 2025-05-22 15:00:21 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.6.1] . -### Releases -- [NPM v1.6.1] https://www.npmjs.com/package/@mistralai/mistralai/v/1.6.1 - . - -## 2025-05-26 14:14:56 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.0] . -### Releases -- [NPM v1.7.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.0 - . - -## 2025-05-28 14:41:45 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.1] . -### Releases -- [NPM v1.7.1] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.1 - . - -## 2025-06-10 16:42:35 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.2] . -### Releases -- [NPM v1.7.2] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.2 - . - -## 2025-07-01 07:55:31 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.3] . -### Releases -- [NPM v1.7.3] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.3 - . - -## 2025-07-10 12:22:03 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.4] . -### Releases -- [NPM v1.7.4] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.4 - . - -## 2025-07-23 19:12:02 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.7.5] . -### Releases -- [NPM v1.7.5] https://www.npmjs.com/package/@mistralai/mistralai/v/1.7.5 - . - -## 2025-08-13 07:23:24 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.9.17] . -### Releases -- [NPM v1.9.17] https://www.npmjs.com/package/@mistralai/mistralai/v/1.9.17 - . - -## 2025-08-20 08:28:36 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.9.18] . -### Releases -- [NPM v1.9.18] https://www.npmjs.com/package/@mistralai/mistralai/v/1.9.18 - . - -## 2025-09-02 06:47:29 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.9.19] . -### Releases -- [NPM v1.9.19] https://www.npmjs.com/package/@mistralai/mistralai/v/1.9.19 - . - -## 2025-09-02 13:40:15 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.606.10 (2.687.13) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.10.0] . -### Releases -- [NPM v1.10.0] https://www.npmjs.com/package/@mistralai/mistralai/v/1.10.0 - . \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/RUNTIMES.md b/examples/sdks/mistral-typescript/RUNTIMES.md deleted file mode 100644 index db7ea9423..000000000 --- a/examples/sdks/mistral-typescript/RUNTIMES.md +++ /dev/null @@ -1,48 +0,0 @@ -# Supported JavaScript runtimes - -This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features: - -* [Web Fetch API][web-fetch] -* [Web Streams API][web-streams] and in particular `ReadableStream` -* [Async iterables][async-iter] using `Symbol.asyncIterator` - -[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API -[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API -[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols - -Runtime environments that are explicitly supported are: - -- Evergreen browsers which include: Chrome, Safari, Edge, Firefox -- Node.js active and maintenance LTS releases - - Currently, this is v18 and v20 -- Bun v1 and above -- Deno v1.39 - - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming]) - -[deno-file-streaming]: https://github.com/denoland/deno/issues/11018 - -## Recommended TypeScript compiler options - -The following `tsconfig.json` options are recommended for projects using this -SDK in order to get static type support for features like async iterables, -streams and `fetch`-related APIs ([`for await...of`][for-await-of], -[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and -so on): - -[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of -[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal -[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request -[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response - -```jsonc -{ - "compilerOptions": { - "target": "es2020", // or higher - "lib": ["es2020", "dom", "dom.iterable"], - } -} -``` - -While `target` can be set to older ECMAScript versions, it may result in extra, -unnecessary compatibility code being generated if you are not targeting old -runtimes. \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/USAGE.md b/examples/sdks/mistral-typescript/USAGE.md deleted file mode 100644 index bd42eeecb..000000000 --- a/examples/sdks/mistral-typescript/USAGE.md +++ /dev/null @@ -1,112 +0,0 @@ - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: - "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - console.log(result); -} - -run(); - -``` - -### Upload a file - -This example shows how to upload a file. - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { openAsBlob } from "node:fs"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.upload({ - file: await openAsBlob("example.file"), - }); - - console.log(result); -} - -run(); - -``` - -### Create Agents Completions - -This example shows how to create agents completions. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.agents.complete({ - messages: [ - { - content: - "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - - console.log(result); -} - -run(); - -``` - -### Create Embedding Request - -This example shows how to create embedding request. - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.embeddings.create({ - model: "mistral-embed", - inputs: [ - "Embed this sentence.", - "As well as this one.", - ], - }); - - console.log(result); -} - -run(); - -``` - \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/lib/utils/retryconfig.md b/examples/sdks/mistral-typescript/docs/lib/utils/retryconfig.md deleted file mode 100644 index 08f95f455..000000000 --- a/examples/sdks/mistral-typescript/docs/lib/utils/retryconfig.md +++ /dev/null @@ -1,24 +0,0 @@ -# RetryConfig - -Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- | -| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | | -| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | ------------ | ----------------------------------------- | -------- | -| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` | -| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` | -| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agent.md b/examples/sdks/mistral-typescript/docs/models/components/agent.md deleted file mode 100644 index bccf04924..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agent.md +++ /dev/null @@ -1,33 +0,0 @@ -# Agent - -## Example Usage - -```typescript -import { Agent } from "@mistralai/mistralai/models/components"; - -let value: Agent = { - model: "Challenger", - name: "", - id: "", - version: 881139, - createdAt: new Date("2023-10-02T17:38:40.153Z"), - updatedAt: new Date("2024-06-14T13:33:29.810Z"), -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `instructions` | *string* | :heavy_minus_sign: | Instruction prompt the model will follow during the conversation. | -| `tools` | *components.AgentTools*[] | :heavy_minus_sign: | List of tools which are available to the model during the conversation. | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `model` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `handoffs` | *string*[] | :heavy_minus_sign: | N/A | -| `object` | [components.AgentObject](../../models/components/agentobject.md) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `version` | *number* | :heavy_check_mark: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentconversation.md b/examples/sdks/mistral-typescript/docs/models/components/agentconversation.md deleted file mode 100644 index df500dbb0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentconversation.md +++ /dev/null @@ -1,26 +0,0 @@ -# AgentConversation - -## Example Usage - -```typescript -import { AgentConversation } from "@mistralai/mistralai/models/components"; - -let value: AgentConversation = { - id: "", - createdAt: new Date("2023-02-26T11:27:08.647Z"), - updatedAt: new Date("2023-04-03T21:29:31.420Z"), - agentId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | Name given to the conversation. | -| `description` | *string* | :heavy_minus_sign: | Description of the what the conversation is about. | -| `object` | [components.AgentConversationObject](../../models/components/agentconversationobject.md) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `agentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentconversationobject.md b/examples/sdks/mistral-typescript/docs/models/components/agentconversationobject.md deleted file mode 100644 index 708975c8c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentconversationobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentConversationObject - -## Example Usage - -```typescript -import { AgentConversationObject } from "@mistralai/mistralai/models/components"; - -let value: AgentConversationObject = "conversation"; -``` - -## Values - -```typescript -"conversation" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequest.md b/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequest.md deleted file mode 100644 index f5b47aad7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequest.md +++ /dev/null @@ -1,24 +0,0 @@ -# AgentCreationRequest - -## Example Usage - -```typescript -import { AgentCreationRequest } from "@mistralai/mistralai/models/components"; - -let value: AgentCreationRequest = { - model: "Accord", - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `instructions` | *string* | :heavy_minus_sign: | Instruction prompt the model will follow during the conversation. | -| `tools` | *components.AgentCreationRequestTools*[] | :heavy_minus_sign: | List of tools which are available to the model during the conversation. | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `model` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `handoffs` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequesttools.md b/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequesttools.md deleted file mode 100644 index f4303e759..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentcreationrequesttools.md +++ /dev/null @@ -1,54 +0,0 @@ -# AgentCreationRequestTools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneevent.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneevent.md deleted file mode 100644 index f20045f3e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneevent.md +++ /dev/null @@ -1,24 +0,0 @@ -# AgentHandoffDoneEvent - -## Example Usage - -```typescript -import { AgentHandoffDoneEvent } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffDoneEvent = { - id: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.AgentHandoffDoneEventType](../../models/components/agenthandoffdoneeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `nextAgentId` | *string* | :heavy_check_mark: | N/A | -| `nextAgentName` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneeventtype.md deleted file mode 100644 index 27ec873bb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffdoneeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentHandoffDoneEventType - -## Example Usage - -```typescript -import { AgentHandoffDoneEventType } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffDoneEventType = "agent.handoff.done"; -``` - -## Values - -```typescript -"agent.handoff.done" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentry.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentry.md deleted file mode 100644 index 6696e0374..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentry.md +++ /dev/null @@ -1,28 +0,0 @@ -# AgentHandoffEntry - -## Example Usage - -```typescript -import { AgentHandoffEntry } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffEntry = { - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.AgentHandoffEntryObject](../../models/components/agenthandoffentryobject.md) | :heavy_minus_sign: | N/A | -| `type` | [components.AgentHandoffEntryType](../../models/components/agenthandoffentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `previousAgentId` | *string* | :heavy_check_mark: | N/A | -| `previousAgentName` | *string* | :heavy_check_mark: | N/A | -| `nextAgentId` | *string* | :heavy_check_mark: | N/A | -| `nextAgentName` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentryobject.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentryobject.md deleted file mode 100644 index 1ba6e33eb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentHandoffEntryObject - -## Example Usage - -```typescript -import { AgentHandoffEntryObject } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffEntryObject = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentrytype.md deleted file mode 100644 index 7d466f349..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentHandoffEntryType - -## Example Usage - -```typescript -import { AgentHandoffEntryType } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffEntryType = "agent.handoff"; -``` - -## Values - -```typescript -"agent.handoff" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedevent.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedevent.md deleted file mode 100644 index bed63c625..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedevent.md +++ /dev/null @@ -1,24 +0,0 @@ -# AgentHandoffStartedEvent - -## Example Usage - -```typescript -import { AgentHandoffStartedEvent } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffStartedEvent = { - id: "", - previousAgentId: "", - previousAgentName: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [components.AgentHandoffStartedEventType](../../models/components/agenthandoffstartedeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `previousAgentId` | *string* | :heavy_check_mark: | N/A | -| `previousAgentName` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedeventtype.md deleted file mode 100644 index e71061afa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenthandoffstartedeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentHandoffStartedEventType - -## Example Usage - -```typescript -import { AgentHandoffStartedEventType } from "@mistralai/mistralai/models/components"; - -let value: AgentHandoffStartedEventType = "agent.handoff.started"; -``` - -## Values - -```typescript -"agent.handoff.started" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentobject.md b/examples/sdks/mistral-typescript/docs/models/components/agentobject.md deleted file mode 100644 index 50fb19fb9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# AgentObject - -## Example Usage - -```typescript -import { AgentObject } from "@mistralai/mistralai/models/components"; - -let value: AgentObject = "agent"; -``` - -## Values - -```typescript -"agent" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequest.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequest.md deleted file mode 100644 index 1215d6470..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequest.md +++ /dev/null @@ -1,37 +0,0 @@ -# AgentsCompletionRequest - -## Example Usage - -```typescript -import { AgentsCompletionRequest } from "@mistralai/mistralai/models/components"; - -let value: AgentsCompletionRequest = { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.AgentsCompletionRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.AgentsCompletionRequestMessages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.AgentsCompletionRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `agentId` | *string* | :heavy_check_mark: | The ID of the agent to use for this completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequestmessages.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequestmessages.md deleted file mode 100644 index f2136bd90..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequestmessages.md +++ /dev/null @@ -1,35 +0,0 @@ -# AgentsCompletionRequestMessages - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequeststop.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequeststop.md deleted file mode 100644 index 90f949003..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequeststop.md +++ /dev/null @@ -1,22 +0,0 @@ -# AgentsCompletionRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequesttoolchoice.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequesttoolchoice.md deleted file mode 100644 index e5cd4b9a8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# AgentsCompletionRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequest.md deleted file mode 100644 index a3b300ae0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequest.md +++ /dev/null @@ -1,37 +0,0 @@ -# AgentsCompletionStreamRequest - -## Example Usage - -```typescript -import { AgentsCompletionStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: AgentsCompletionStreamRequest = { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.AgentsCompletionStreamRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.AgentsCompletionStreamRequestMessages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.AgentsCompletionStreamRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `agentId` | *string* | :heavy_check_mark: | The ID of the agent to use for this completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequestmessages.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequestmessages.md deleted file mode 100644 index 97a27433e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequestmessages.md +++ /dev/null @@ -1,35 +0,0 @@ -# AgentsCompletionStreamRequestMessages - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequeststop.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequeststop.md deleted file mode 100644 index 0741d439c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequeststop.md +++ /dev/null @@ -1,22 +0,0 @@ -# AgentsCompletionStreamRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequesttoolchoice.md b/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequesttoolchoice.md deleted file mode 100644 index bc66a7a50..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentscompletionstreamrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# AgentsCompletionStreamRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agenttools.md b/examples/sdks/mistral-typescript/docs/models/components/agenttools.md deleted file mode 100644 index 059a59002..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agenttools.md +++ /dev/null @@ -1,54 +0,0 @@ -# AgentTools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequest.md b/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequest.md deleted file mode 100644 index 0159c5367..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# AgentUpdateRequest - -## Example Usage - -```typescript -import { AgentUpdateRequest } from "@mistralai/mistralai/models/components"; - -let value: AgentUpdateRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `instructions` | *string* | :heavy_minus_sign: | Instruction prompt the model will follow during the conversation. | -| `tools` | *components.AgentUpdateRequestTools*[] | :heavy_minus_sign: | List of tools which are available to the model during the conversation. | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `handoffs` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequesttools.md b/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequesttools.md deleted file mode 100644 index dd61ee93a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/agentupdaterequesttools.md +++ /dev/null @@ -1,54 +0,0 @@ -# AgentUpdateRequestTools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/apiendpoint.md b/examples/sdks/mistral-typescript/docs/models/components/apiendpoint.md deleted file mode 100644 index f96672ee1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/apiendpoint.md +++ /dev/null @@ -1,17 +0,0 @@ -# ApiEndpoint - -## Example Usage - -```typescript -import { ApiEndpoint } from "@mistralai/mistralai/models/components"; - -let value: ApiEndpoint = "/v1/chat/moderations"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"/v1/chat/completions" | "/v1/embeddings" | "/v1/fim/completions" | "/v1/moderations" | "/v1/chat/moderations" | "/v1/ocr" | "/v1/classifications" | "/v1/chat/classifications" | "/v1/conversations" | "/v1/audio/transcriptions" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/archiveftmodelout.md b/examples/sdks/mistral-typescript/docs/models/components/archiveftmodelout.md deleted file mode 100644 index 403e35306..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/archiveftmodelout.md +++ /dev/null @@ -1,19 +0,0 @@ -# ArchiveFTModelOut - -## Example Usage - -```typescript -import { ArchiveFTModelOut } from "@mistralai/mistralai/models/components"; - -let value: ArchiveFTModelOut = { - id: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [components.ArchiveFTModelOutObject](../../models/components/archiveftmodeloutobject.md) | :heavy_minus_sign: | N/A | -| `archived` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/archiveftmodeloutobject.md b/examples/sdks/mistral-typescript/docs/models/components/archiveftmodeloutobject.md deleted file mode 100644 index 151f852f6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/archiveftmodeloutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ArchiveFTModelOutObject - -## Example Usage - -```typescript -import { ArchiveFTModelOutObject } from "@mistralai/mistralai/models/components"; - -let value: ArchiveFTModelOutObject = "model"; -``` - -## Values - -```typescript -"model" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/arguments.md b/examples/sdks/mistral-typescript/docs/models/components/arguments.md deleted file mode 100644 index 5a99a0894..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/arguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Arguments - - -## Supported Types - -### `{ [k: string]: any }` - -```typescript -const value: { [k: string]: any } = { - "key": "", - "key1": "", - "key2": "", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/assistantmessage.md b/examples/sdks/mistral-typescript/docs/models/components/assistantmessage.md deleted file mode 100644 index e9bdcd46b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/assistantmessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# AssistantMessage - -## Example Usage - -```typescript -import { AssistantMessage } from "@mistralai/mistralai/models/components"; - -let value: AssistantMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `content` | *components.AssistantMessageContent* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | -| `prefix` | *boolean* | :heavy_minus_sign: | Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. | -| `role` | [components.AssistantMessageRole](../../models/components/assistantmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/assistantmessagecontent.md b/examples/sdks/mistral-typescript/docs/models/components/assistantmessagecontent.md deleted file mode 100644 index 7918f1c95..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/assistantmessagecontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# AssistantMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/assistantmessagerole.md b/examples/sdks/mistral-typescript/docs/models/components/assistantmessagerole.md deleted file mode 100644 index b7291f09b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/assistantmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# AssistantMessageRole - -## Example Usage - -```typescript -import { AssistantMessageRole } from "@mistralai/mistralai/models/components"; - -let value: AssistantMessageRole = "assistant"; -``` - -## Values - -```typescript -"assistant" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/audiochunk.md b/examples/sdks/mistral-typescript/docs/models/components/audiochunk.md deleted file mode 100644 index cb71d9903..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/audiochunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# AudioChunk - -## Example Usage - -```typescript -import { AudioChunk } from "@mistralai/mistralai/models/components"; - -let value: AudioChunk = { - inputAudio: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `inputAudio` | *string* | :heavy_check_mark: | N/A | -| `type` | [components.AudioChunkType](../../models/components/audiochunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/audiochunktype.md b/examples/sdks/mistral-typescript/docs/models/components/audiochunktype.md deleted file mode 100644 index a2ed07fea..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/audiochunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# AudioChunkType - -## Example Usage - -```typescript -import { AudioChunkType } from "@mistralai/mistralai/models/components"; - -let value: AudioChunkType = "input_audio"; -``` - -## Values - -```typescript -"input_audio" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequest.md b/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequest.md deleted file mode 100644 index 2af1f48eb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AudioTranscriptionRequest - -## Example Usage - -```typescript -import { AudioTranscriptionRequest } from "@mistralai/mistralai/models/components"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [components.FileT](../../models/components/filet.md) | :heavy_minus_sign: | N/A | -| `fileUrl` | *string* | :heavy_minus_sign: | Url of a file to be transcribed | -| `fileId` | *string* | :heavy_minus_sign: | ID of a file uploaded to /v1/files | -| `language` | *string* | :heavy_minus_sign: | Language of the audio, e.g. 'en'. Providing the language can boost accuracy. | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `timestampGranularities` | [components.TimestampGranularity](../../models/components/timestampgranularity.md)[] | :heavy_minus_sign: | Granularities of timestamps to include in the response. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequeststream.md b/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequeststream.md deleted file mode 100644 index ba807f6ec..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/audiotranscriptionrequeststream.md +++ /dev/null @@ -1,22 +0,0 @@ -# AudioTranscriptionRequestStream - -## Example Usage - -```typescript -import { AudioTranscriptionRequestStream } from "@mistralai/mistralai/models/components"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [components.FileT](../../models/components/filet.md) | :heavy_minus_sign: | N/A | -| `fileUrl` | *string* | :heavy_minus_sign: | Url of a file to be transcribed | -| `fileId` | *string* | :heavy_minus_sign: | ID of a file uploaded to /v1/files | -| `language` | *string* | :heavy_minus_sign: | Language of the audio, e.g. 'en'. Providing the language can boost accuracy. | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `timestampGranularities` | [components.TimestampGranularity](../../models/components/timestampgranularity.md)[] | :heavy_minus_sign: | Granularities of timestamps to include in the response. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/basemodelcard.md b/examples/sdks/mistral-typescript/docs/models/components/basemodelcard.md deleted file mode 100644 index 1166b3344..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/basemodelcard.md +++ /dev/null @@ -1,30 +0,0 @@ -# BaseModelCard - -## Example Usage - -```typescript -import { BaseModelCard } from "@mistralai/mistralai/models/components"; - -let value: BaseModelCard = { - id: "", - capabilities: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_minus_sign: | N/A | -| `ownedBy` | *string* | :heavy_minus_sign: | N/A | -| `capabilities` | [components.ModelCapabilities](../../models/components/modelcapabilities.md) | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `maxContextLength` | *number* | :heavy_minus_sign: | N/A | -| `aliases` | *string*[] | :heavy_minus_sign: | N/A | -| `deprecation` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `deprecationReplacementModel` | *string* | :heavy_minus_sign: | N/A | -| `defaultModelTemperature` | *number* | :heavy_minus_sign: | N/A | -| `type` | [components.BaseModelCardType](../../models/components/basemodelcardtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/basemodelcardtype.md b/examples/sdks/mistral-typescript/docs/models/components/basemodelcardtype.md deleted file mode 100644 index 54323f895..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/basemodelcardtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# BaseModelCardType - -## Example Usage - -```typescript -import { BaseModelCardType } from "@mistralai/mistralai/models/components"; - -let value: BaseModelCardType = "base"; -``` - -## Values - -```typescript -"base" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batcherror.md b/examples/sdks/mistral-typescript/docs/models/components/batcherror.md deleted file mode 100644 index b0229f35b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batcherror.md +++ /dev/null @@ -1,18 +0,0 @@ -# BatchError - -## Example Usage - -```typescript -import { BatchError } from "@mistralai/mistralai/models/components"; - -let value: BatchError = { - message: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *string* | :heavy_check_mark: | N/A | -| `count` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjobin.md b/examples/sdks/mistral-typescript/docs/models/components/batchjobin.md deleted file mode 100644 index 88578bf29..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjobin.md +++ /dev/null @@ -1,25 +0,0 @@ -# BatchJobIn - -## Example Usage - -```typescript -import { BatchJobIn } from "@mistralai/mistralai/models/components"; - -let value: BatchJobIn = { - inputFiles: [ - "7f16333a-2967-488a-ae48-e45fd08dcc6a", - ], - endpoint: "/v1/embeddings", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputFiles` | *string*[] | :heavy_check_mark: | N/A | -| `endpoint` | [components.ApiEndpoint](../../models/components/apiendpoint.md) | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `metadata` | Record | :heavy_minus_sign: | N/A | -| `timeoutHours` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjobout.md b/examples/sdks/mistral-typescript/docs/models/components/batchjobout.md deleted file mode 100644 index 21440f1c5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjobout.md +++ /dev/null @@ -1,46 +0,0 @@ -# BatchJobOut - -## Example Usage - -```typescript -import { BatchJobOut } from "@mistralai/mistralai/models/components"; - -let value: BatchJobOut = { - id: "", - inputFiles: [ - "7aed7fbb-d4ba-43ca-a916-fcfc0c52ffa5", - "d0b6081e-1c47-4ee0-92e8-b5332c027357", - ], - endpoint: "", - errors: [], - status: "CANCELLED", - createdAt: 718647, - totalRequests: 966604, - completedRequests: 914399, - succeededRequests: 807847, - failedRequests: 528840, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [components.BatchJobOutObject](../../models/components/batchjoboutobject.md) | :heavy_minus_sign: | N/A | -| `inputFiles` | *string*[] | :heavy_check_mark: | N/A | -| `metadata` | Record | :heavy_minus_sign: | N/A | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `outputFile` | *string* | :heavy_minus_sign: | N/A | -| `errorFile` | *string* | :heavy_minus_sign: | N/A | -| `errors` | [components.BatchError](../../models/components/batcherror.md)[] | :heavy_check_mark: | N/A | -| `status` | [components.BatchJobStatus](../../models/components/batchjobstatus.md) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `totalRequests` | *number* | :heavy_check_mark: | N/A | -| `completedRequests` | *number* | :heavy_check_mark: | N/A | -| `succeededRequests` | *number* | :heavy_check_mark: | N/A | -| `failedRequests` | *number* | :heavy_check_mark: | N/A | -| `startedAt` | *number* | :heavy_minus_sign: | N/A | -| `completedAt` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjoboutobject.md b/examples/sdks/mistral-typescript/docs/models/components/batchjoboutobject.md deleted file mode 100644 index 35ce12ca2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjoboutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# BatchJobOutObject - -## Example Usage - -```typescript -import { BatchJobOutObject } from "@mistralai/mistralai/models/components"; - -let value: BatchJobOutObject = "batch"; -``` - -## Values - -```typescript -"batch" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjobsout.md b/examples/sdks/mistral-typescript/docs/models/components/batchjobsout.md deleted file mode 100644 index b350ec810..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjobsout.md +++ /dev/null @@ -1,19 +0,0 @@ -# BatchJobsOut - -## Example Usage - -```typescript -import { BatchJobsOut } from "@mistralai/mistralai/models/components"; - -let value: BatchJobsOut = { - total: 348485, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [components.BatchJobOut](../../models/components/batchjobout.md)[] | :heavy_minus_sign: | N/A | -| `object` | [components.BatchJobsOutObject](../../models/components/batchjobsoutobject.md) | :heavy_minus_sign: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjobsoutobject.md b/examples/sdks/mistral-typescript/docs/models/components/batchjobsoutobject.md deleted file mode 100644 index 60bd196b7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjobsoutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# BatchJobsOutObject - -## Example Usage - -```typescript -import { BatchJobsOutObject } from "@mistralai/mistralai/models/components"; - -let value: BatchJobsOutObject = "list"; -``` - -## Values - -```typescript -"list" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/batchjobstatus.md b/examples/sdks/mistral-typescript/docs/models/components/batchjobstatus.md deleted file mode 100644 index 26766bd20..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/batchjobstatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# BatchJobStatus - -## Example Usage - -```typescript -import { BatchJobStatus } from "@mistralai/mistralai/models/components"; - -let value: BatchJobStatus = "CANCELLATION_REQUESTED"; -``` - -## Values - -```typescript -"QUEUED" | "RUNNING" | "SUCCESS" | "FAILED" | "TIMEOUT_EXCEEDED" | "CANCELLATION_REQUESTED" | "CANCELLED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/builtinconnectors.md b/examples/sdks/mistral-typescript/docs/models/components/builtinconnectors.md deleted file mode 100644 index d8f49ca2e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/builtinconnectors.md +++ /dev/null @@ -1,15 +0,0 @@ -# BuiltInConnectors - -## Example Usage - -```typescript -import { BuiltInConnectors } from "@mistralai/mistralai/models/components"; - -let value: BuiltInConnectors = "document_library"; -``` - -## Values - -```typescript -"web_search" | "web_search_premium" | "code_interpreter" | "image_generation" | "document_library" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatclassificationrequest.md b/examples/sdks/mistral-typescript/docs/models/components/chatclassificationrequest.md deleted file mode 100644 index 0c73f9bf1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatclassificationrequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# ChatClassificationRequest - -## Example Usage - -```typescript -import { ChatClassificationRequest } from "@mistralai/mistralai/models/components"; - -let value: ChatClassificationRequest = { - model: "Model Y", - inputs: { - messages: [ - { - content: "", - role: "tool", - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `model` | *string* | :heavy_check_mark: | N/A | -| `inputs` | *components.Inputs* | :heavy_check_mark: | Chat to classify | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionchoice.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionchoice.md deleted file mode 100644 index 49c2173b7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionChoice - -## Example Usage - -```typescript -import { ChatCompletionChoice } from "@mistralai/mistralai/models/components"; - -let value: ChatCompletionChoice = { - index: 0, - message: {}, - finishReason: "stop", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `index` | *number* | :heavy_check_mark: | N/A | 0 | -| `message` | [components.AssistantMessage](../../models/components/assistantmessage.md) | :heavy_check_mark: | N/A | | -| `finishReason` | [components.FinishReason](../../models/components/finishreason.md) | :heavy_check_mark: | N/A | stop | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequest.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequest.md deleted file mode 100644 index 5f03c77f4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequest.md +++ /dev/null @@ -1,40 +0,0 @@ -# ChatCompletionRequest - -## Example Usage - -```typescript -import { ChatCompletionRequest } from "@mistralai/mistralai/models/components"; - -let value: ChatCompletionRequest = { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. | mistral-small-latest | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.Stop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.Messages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `safePrompt` | *boolean* | :heavy_minus_sign: | Whether to inject a safety prompt before all conversations. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequesttoolchoice.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequesttoolchoice.md deleted file mode 100644 index 8750103b5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionresponse.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionresponse.md deleted file mode 100644 index 0aa8af819..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionresponse.md +++ /dev/null @@ -1,27 +0,0 @@ -# ChatCompletionResponse - -## Example Usage - -```typescript -import { ChatCompletionResponse } from "@mistralai/mistralai/models/components"; - -let value: ChatCompletionResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "mistral-small-latest", - usage: {}, - created: 1702256327, - choices: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | mistral-small-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_check_mark: | N/A | 1702256327 | -| `choices` | [components.ChatCompletionChoice](../../models/components/chatcompletionchoice.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequest.md deleted file mode 100644 index c395e3231..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequest.md +++ /dev/null @@ -1,40 +0,0 @@ -# ChatCompletionStreamRequest - -## Example Usage - -```typescript -import { ChatCompletionStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: ChatCompletionStreamRequest = { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. | mistral-small-latest | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.ChatCompletionStreamRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.ChatCompletionStreamRequestMessages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionStreamRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `safePrompt` | *boolean* | :heavy_minus_sign: | Whether to inject a safety prompt before all conversations. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequestmessages.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequestmessages.md deleted file mode 100644 index 1d7e67fbc..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequestmessages.md +++ /dev/null @@ -1,35 +0,0 @@ -# ChatCompletionStreamRequestMessages - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequeststop.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequeststop.md deleted file mode 100644 index c3d026fa0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequeststop.md +++ /dev/null @@ -1,22 +0,0 @@ -# ChatCompletionStreamRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequesttoolchoice.md b/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequesttoolchoice.md deleted file mode 100644 index 9f19e8c43..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatcompletionstreamrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionStreamRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequest.md b/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequest.md deleted file mode 100644 index b0017c39b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# ChatModerationRequest - -## Example Usage - -```typescript -import { ChatModerationRequest } from "@mistralai/mistralai/models/components"; - -let value: ChatModerationRequest = { - inputs: [], - model: "Model S", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `inputs` | *components.ChatModerationRequestInputs* | :heavy_check_mark: | Chat to classify | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequestinputs.md b/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequestinputs.md deleted file mode 100644 index e56258ee5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/chatmoderationrequestinputs.md +++ /dev/null @@ -1,26 +0,0 @@ -# ChatModerationRequestInputs - -Chat to classify - - -## Supported Types - -### `components.One[]` - -```typescript -const value: components.One[] = [ - { - content: null, - role: "user", - }, -]; -``` - -### `components.Two[][]` - -```typescript -const value: components.Two[][] = [ - [], -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/checkpointout.md b/examples/sdks/mistral-typescript/docs/models/components/checkpointout.md deleted file mode 100644 index a12479207..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/checkpointout.md +++ /dev/null @@ -1,21 +0,0 @@ -# CheckpointOut - -## Example Usage - -```typescript -import { CheckpointOut } from "@mistralai/mistralai/models/components"; - -let value: CheckpointOut = { - metrics: {}, - stepNumber: 191975, - createdAt: 1716963433, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metrics` | [components.MetricOut](../../models/components/metricout.md) | :heavy_check_mark: | Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). | | -| `stepNumber` | *number* | :heavy_check_mark: | The step number that the checkpoint was created at. | | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) for when the checkpoint was created. | 1716963433 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classificationrequest.md b/examples/sdks/mistral-typescript/docs/models/components/classificationrequest.md deleted file mode 100644 index 3012e25f1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classificationrequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# ClassificationRequest - -## Example Usage - -```typescript -import { ClassificationRequest } from "@mistralai/mistralai/models/components"; - -let value: ClassificationRequest = { - model: "Impala", - inputs: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. | -| `inputs` | *components.ClassificationRequestInputs* | :heavy_check_mark: | Text to classify. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classificationrequestinputs.md b/examples/sdks/mistral-typescript/docs/models/components/classificationrequestinputs.md deleted file mode 100644 index cbea9403b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classificationrequestinputs.md +++ /dev/null @@ -1,22 +0,0 @@ -# ClassificationRequestInputs - -Text to classify. - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/classificationresponse.md b/examples/sdks/mistral-typescript/docs/models/components/classificationresponse.md deleted file mode 100644 index 2fbdcf3e9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classificationresponse.md +++ /dev/null @@ -1,28 +0,0 @@ -# ClassificationResponse - -## Example Usage - -```typescript -import { ClassificationResponse } from "@mistralai/mistralai/models/components"; - -let value: ClassificationResponse = { - id: "mod-e5cc70bb28c444948073e77776eb30ef", - model: "Charger", - results: [ - {}, - { - "key": { - scores: {}, - }, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | mod-e5cc70bb28c444948073e77776eb30ef | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `results` | Record[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classificationtargetresult.md b/examples/sdks/mistral-typescript/docs/models/components/classificationtargetresult.md deleted file mode 100644 index 2a7d48dab..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classificationtargetresult.md +++ /dev/null @@ -1,21 +0,0 @@ -# ClassificationTargetResult - -## Example Usage - -```typescript -import { ClassificationTargetResult } from "@mistralai/mistralai/models/components"; - -let value: ClassificationTargetResult = { - scores: { - "key": 7155.73, - "key1": 6875.27, - "key2": 2740.18, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `scores` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjobout.md b/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjobout.md deleted file mode 100644 index b4edcd763..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjobout.md +++ /dev/null @@ -1,53 +0,0 @@ -# ClassifierDetailedJobOut - -## Example Usage - -```typescript -import { ClassifierDetailedJobOut } from "@mistralai/mistralai/models/components"; - -let value: ClassifierDetailedJobOut = { - id: "9324efc1-74d2-4cfb-aacc-8c936806a157", - autoStart: true, - model: "Land Cruiser", - status: "CANCELLATION_REQUESTED", - createdAt: 306183, - modifiedAt: 163064, - trainingFiles: [ - "4aadd7e9-6b01-477f-86b6-3ada38b71e42", - "689691d3-0952-4741-a8e0-c05d353daf37", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], - classifierTargets: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `autoStart` | *boolean* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | The name of the model to fine-tune. | -| `status` | [components.ClassifierDetailedJobOutStatus](../../models/components/classifierdetailedjoboutstatus.md) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `modifiedAt` | *number* | :heavy_check_mark: | N/A | -| `trainingFiles` | *string*[] | :heavy_check_mark: | N/A | -| `validationFiles` | *string*[] | :heavy_minus_sign: | N/A | -| `object` | [components.ClassifierDetailedJobOutObject](../../models/components/classifierdetailedjoboutobject.md) | :heavy_minus_sign: | N/A | -| `fineTunedModel` | *string* | :heavy_minus_sign: | N/A | -| `suffix` | *string* | :heavy_minus_sign: | N/A | -| `integrations` | *components.ClassifierDetailedJobOutIntegrations*[] | :heavy_minus_sign: | N/A | -| `trainedTokens` | *number* | :heavy_minus_sign: | N/A | -| `metadata` | [components.JobMetadataOut](../../models/components/jobmetadataout.md) | :heavy_minus_sign: | N/A | -| `jobType` | [components.ClassifierDetailedJobOutJobType](../../models/components/classifierdetailedjoboutjobtype.md) | :heavy_minus_sign: | N/A | -| `hyperparameters` | [components.ClassifierTrainingParameters](../../models/components/classifiertrainingparameters.md) | :heavy_check_mark: | N/A | -| `events` | [components.EventOut](../../models/components/eventout.md)[] | :heavy_minus_sign: | Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. | -| `checkpoints` | [components.CheckpointOut](../../models/components/checkpointout.md)[] | :heavy_minus_sign: | N/A | -| `classifierTargets` | [components.ClassifierTargetOut](../../models/components/classifiertargetout.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutintegrations.md b/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutintegrations.md deleted file mode 100644 index 2d0876458..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutintegrations.md +++ /dev/null @@ -1,13 +0,0 @@ -# ClassifierDetailedJobOutIntegrations - - -## Supported Types - -### `components.WandbIntegrationOut` - -```typescript -const value: components.WandbIntegrationOut = { - project: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutjobtype.md b/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutjobtype.md deleted file mode 100644 index e0b8db7a6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutjobtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClassifierDetailedJobOutJobType - -## Example Usage - -```typescript -import { ClassifierDetailedJobOutJobType } from "@mistralai/mistralai/models/components"; - -let value: ClassifierDetailedJobOutJobType = "classifier"; -``` - -## Values - -```typescript -"classifier" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutobject.md b/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutobject.md deleted file mode 100644 index 4563dcdce..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClassifierDetailedJobOutObject - -## Example Usage - -```typescript -import { ClassifierDetailedJobOutObject } from "@mistralai/mistralai/models/components"; - -let value: ClassifierDetailedJobOutObject = "job"; -``` - -## Values - -```typescript -"job" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutstatus.md b/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutstatus.md deleted file mode 100644 index f05053316..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierdetailedjoboutstatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClassifierDetailedJobOutStatus - -## Example Usage - -```typescript -import { ClassifierDetailedJobOutStatus } from "@mistralai/mistralai/models/components"; - -let value: ClassifierDetailedJobOutStatus = "RUNNING"; -``` - -## Values - -```typescript -"QUEUED" | "STARTED" | "VALIDATING" | "VALIDATED" | "RUNNING" | "FAILED_VALIDATION" | "FAILED" | "SUCCESS" | "CANCELLED" | "CANCELLATION_REQUESTED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodelout.md b/examples/sdks/mistral-typescript/docs/models/components/classifierftmodelout.md deleted file mode 100644 index b7599004d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodelout.md +++ /dev/null @@ -1,41 +0,0 @@ -# ClassifierFTModelOut - -## Example Usage - -```typescript -import { ClassifierFTModelOut } from "@mistralai/mistralai/models/components"; - -let value: ClassifierFTModelOut = { - id: "", - created: 111228, - ownedBy: "", - workspaceId: "", - root: "", - rootVersion: "", - archived: true, - capabilities: {}, - job: "b1e6e408-c7c5-4c7c-9c65-efca1702bf4b", - classifierTargets: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [components.ClassifierFTModelOutObject](../../models/components/classifierftmodeloutobject.md) | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_check_mark: | N/A | -| `ownedBy` | *string* | :heavy_check_mark: | N/A | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | -| `root` | *string* | :heavy_check_mark: | N/A | -| `rootVersion` | *string* | :heavy_check_mark: | N/A | -| `archived` | *boolean* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `capabilities` | [components.FTModelCapabilitiesOut](../../models/components/ftmodelcapabilitiesout.md) | :heavy_check_mark: | N/A | -| `maxContextLength` | *number* | :heavy_minus_sign: | N/A | -| `aliases` | *string*[] | :heavy_minus_sign: | N/A | -| `job` | *string* | :heavy_check_mark: | N/A | -| `classifierTargets` | [components.ClassifierTargetOut](../../models/components/classifiertargetout.md)[] | :heavy_check_mark: | N/A | -| `modelType` | [components.ClassifierFTModelOutModelType](../../models/components/classifierftmodeloutmodeltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutmodeltype.md b/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutmodeltype.md deleted file mode 100644 index 596ec9381..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutmodeltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClassifierFTModelOutModelType - -## Example Usage - -```typescript -import { ClassifierFTModelOutModelType } from "@mistralai/mistralai/models/components"; - -let value: ClassifierFTModelOutModelType = "classifier"; -``` - -## Values - -```typescript -"classifier" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutobject.md b/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutobject.md deleted file mode 100644 index 8e17a8600..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierftmodeloutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClassifierFTModelOutObject - -## Example Usage - -```typescript -import { ClassifierFTModelOutObject } from "@mistralai/mistralai/models/components"; - -let value: ClassifierFTModelOutObject = "model"; -``` - -## Values - -```typescript -"model" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierjobout.md b/examples/sdks/mistral-typescript/docs/models/components/classifierjobout.md deleted file mode 100644 index a8a5733d4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierjobout.md +++ /dev/null @@ -1,41 +0,0 @@ -# ClassifierJobOut - -## Example Usage - -```typescript -import { ClassifierJobOut } from "@mistralai/mistralai/models/components"; - -let value: ClassifierJobOut = { - id: "94361cba-dbfe-4cb8-b157-dba88d484a3b", - autoStart: true, - model: "Mercielago", - status: "FAILED_VALIDATION", - createdAt: 604693, - modifiedAt: 540214, - trainingFiles: [ - "8db2006d-0f95-498b-8a1c-8b96bd790c50", - ], - hyperparameters: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The ID of the job. | -| `autoStart` | *boolean* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | The name of the model to fine-tune. | -| `status` | [components.ClassifierJobOutStatus](../../models/components/classifierjoboutstatus.md) | :heavy_check_mark: | The current status of the fine-tuning job. | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) for when the fine-tuning job was created. | -| `modifiedAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. | -| `trainingFiles` | *string*[] | :heavy_check_mark: | A list containing the IDs of uploaded files that contain training data. | -| `validationFiles` | *string*[] | :heavy_minus_sign: | A list containing the IDs of uploaded files that contain validation data. | -| `object` | [components.ClassifierJobOutObject](../../models/components/classifierjoboutobject.md) | :heavy_minus_sign: | The object type of the fine-tuning job. | -| `fineTunedModel` | *string* | :heavy_minus_sign: | The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | -| `integrations` | *components.ClassifierJobOutIntegrations*[] | :heavy_minus_sign: | A list of integrations enabled for your fine-tuning job. | -| `trainedTokens` | *number* | :heavy_minus_sign: | Total number of tokens trained. | -| `metadata` | [components.JobMetadataOut](../../models/components/jobmetadataout.md) | :heavy_minus_sign: | N/A | -| `jobType` | [components.ClassifierJobOutJobType](../../models/components/classifierjoboutjobtype.md) | :heavy_minus_sign: | The type of job (`FT` for fine-tuning). | -| `hyperparameters` | [components.ClassifierTrainingParameters](../../models/components/classifiertrainingparameters.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutintegrations.md b/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutintegrations.md deleted file mode 100644 index efa947d13..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutintegrations.md +++ /dev/null @@ -1,13 +0,0 @@ -# ClassifierJobOutIntegrations - - -## Supported Types - -### `components.WandbIntegrationOut` - -```typescript -const value: components.WandbIntegrationOut = { - project: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutjobtype.md b/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutjobtype.md deleted file mode 100644 index 64a356f2c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutjobtype.md +++ /dev/null @@ -1,17 +0,0 @@ -# ClassifierJobOutJobType - -The type of job (`FT` for fine-tuning). - -## Example Usage - -```typescript -import { ClassifierJobOutJobType } from "@mistralai/mistralai/models/components"; - -let value: ClassifierJobOutJobType = "classifier"; -``` - -## Values - -```typescript -"classifier" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutobject.md b/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutobject.md deleted file mode 100644 index 79347191a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutobject.md +++ /dev/null @@ -1,17 +0,0 @@ -# ClassifierJobOutObject - -The object type of the fine-tuning job. - -## Example Usage - -```typescript -import { ClassifierJobOutObject } from "@mistralai/mistralai/models/components"; - -let value: ClassifierJobOutObject = "job"; -``` - -## Values - -```typescript -"job" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutstatus.md b/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutstatus.md deleted file mode 100644 index 9f866f24a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifierjoboutstatus.md +++ /dev/null @@ -1,17 +0,0 @@ -# ClassifierJobOutStatus - -The current status of the fine-tuning job. - -## Example Usage - -```typescript -import { ClassifierJobOutStatus } from "@mistralai/mistralai/models/components"; - -let value: ClassifierJobOutStatus = "VALIDATING"; -``` - -## Values - -```typescript -"QUEUED" | "STARTED" | "VALIDATING" | "VALIDATED" | "RUNNING" | "FAILED_VALIDATION" | "FAILED" | "SUCCESS" | "CANCELLED" | "CANCELLATION_REQUESTED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifiertargetin.md b/examples/sdks/mistral-typescript/docs/models/components/classifiertargetin.md deleted file mode 100644 index 7c89ba8ba..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifiertargetin.md +++ /dev/null @@ -1,25 +0,0 @@ -# ClassifierTargetIn - -## Example Usage - -```typescript -import { ClassifierTargetIn } from "@mistralai/mistralai/models/components"; - -let value: ClassifierTargetIn = { - name: "", - labels: [ - "", - "", - "", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `labels` | *string*[] | :heavy_check_mark: | N/A | -| `weight` | *number* | :heavy_minus_sign: | N/A | -| `lossFunction` | [components.FTClassifierLossFunction](../../models/components/ftclassifierlossfunction.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifiertargetout.md b/examples/sdks/mistral-typescript/docs/models/components/classifiertargetout.md deleted file mode 100644 index 6a333df96..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifiertargetout.md +++ /dev/null @@ -1,27 +0,0 @@ -# ClassifierTargetOut - -## Example Usage - -```typescript -import { ClassifierTargetOut } from "@mistralai/mistralai/models/components"; - -let value: ClassifierTargetOut = { - name: "", - labels: [ - "", - "", - "", - ], - weight: 6166.16, - lossFunction: "single_class", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `labels` | *string*[] | :heavy_check_mark: | N/A | -| `weight` | *number* | :heavy_check_mark: | N/A | -| `lossFunction` | [components.FTClassifierLossFunction](../../models/components/ftclassifierlossfunction.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparameters.md b/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparameters.md deleted file mode 100644 index 975daf2d4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparameters.md +++ /dev/null @@ -1,20 +0,0 @@ -# ClassifierTrainingParameters - -## Example Usage - -```typescript -import { ClassifierTrainingParameters } from "@mistralai/mistralai/models/components"; - -let value: ClassifierTrainingParameters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `trainingSteps` | *number* | :heavy_minus_sign: | N/A | -| `learningRate` | *number* | :heavy_minus_sign: | N/A | -| `weightDecay` | *number* | :heavy_minus_sign: | N/A | -| `warmupFraction` | *number* | :heavy_minus_sign: | N/A | -| `epochs` | *number* | :heavy_minus_sign: | N/A | -| `seqLen` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparametersin.md b/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparametersin.md deleted file mode 100644 index 74d9659ce..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/classifiertrainingparametersin.md +++ /dev/null @@ -1,22 +0,0 @@ -# ClassifierTrainingParametersIn - -The fine-tuning hyperparameter settings used in a classifier fine-tune job. - -## Example Usage - -```typescript -import { ClassifierTrainingParametersIn } from "@mistralai/mistralai/models/components"; - -let value: ClassifierTrainingParametersIn = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `trainingSteps` | *number* | :heavy_minus_sign: | The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. | -| `learningRate` | *number* | :heavy_minus_sign: | A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. | -| `weightDecay` | *number* | :heavy_minus_sign: | (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. | -| `warmupFraction` | *number* | :heavy_minus_sign: | (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) | -| `epochs` | *number* | :heavy_minus_sign: | N/A | -| `seqLen` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertool.md b/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertool.md deleted file mode 100644 index 14eba3a10..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertool.md +++ /dev/null @@ -1,15 +0,0 @@ -# CodeInterpreterTool - -## Example Usage - -```typescript -import { CodeInterpreterTool } from "@mistralai/mistralai/models/components"; - -let value: CodeInterpreterTool = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.CodeInterpreterToolType](../../models/components/codeinterpretertooltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertooltype.md b/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertooltype.md deleted file mode 100644 index bbc0c6e44..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/codeinterpretertooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# CodeInterpreterToolType - -## Example Usage - -```typescript -import { CodeInterpreterToolType } from "@mistralai/mistralai/models/components"; - -let value: CodeInterpreterToolType = "code_interpreter"; -``` - -## Values - -```typescript -"code_interpreter" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionargs.md b/examples/sdks/mistral-typescript/docs/models/components/completionargs.md deleted file mode 100644 index b9c7aadd0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionargs.md +++ /dev/null @@ -1,26 +0,0 @@ -# CompletionArgs - -White-listed arguments from the completion API - -## Example Usage - -```typescript -import { CompletionArgs } from "@mistralai/mistralai/models/components"; - -let value: CompletionArgs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `stop` | *components.CompletionArgsStop* | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `randomSeed` | *number* | :heavy_minus_sign: | N/A | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | -| `toolChoice` | [components.ToolChoiceEnum](../../models/components/toolchoiceenum.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionargsstop.md b/examples/sdks/mistral-typescript/docs/models/components/completionargsstop.md deleted file mode 100644 index a9193dd10..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionargsstop.md +++ /dev/null @@ -1,20 +0,0 @@ -# CompletionArgsStop - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionchunk.md b/examples/sdks/mistral-typescript/docs/models/components/completionchunk.md deleted file mode 100644 index 782f42db2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionchunk.md +++ /dev/null @@ -1,24 +0,0 @@ -# CompletionChunk - -## Example Usage - -```typescript -import { CompletionChunk } from "@mistralai/mistralai/models/components"; - -let value: CompletionChunk = { - id: "", - model: "Prius", - choices: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_minus_sign: | N/A | -| `choices` | [components.CompletionResponseStreamChoice](../../models/components/completionresponsestreamchoice.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjobout.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjobout.md deleted file mode 100644 index fb6bf51e4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjobout.md +++ /dev/null @@ -1,51 +0,0 @@ -# CompletionDetailedJobOut - -## Example Usage - -```typescript -import { CompletionDetailedJobOut } from "@mistralai/mistralai/models/components"; - -let value: CompletionDetailedJobOut = { - id: "456fe44d-6df9-48f2-930f-131af06a7b94", - autoStart: false, - model: "Taurus", - status: "VALIDATED", - createdAt: 45490, - modifiedAt: 318849, - trainingFiles: [ - "c6396397-fb35-4d61-8f27-af5626373d30", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `autoStart` | *boolean* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | The name of the model to fine-tune. | -| `status` | [components.CompletionDetailedJobOutStatus](../../models/components/completiondetailedjoboutstatus.md) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `modifiedAt` | *number* | :heavy_check_mark: | N/A | -| `trainingFiles` | *string*[] | :heavy_check_mark: | N/A | -| `validationFiles` | *string*[] | :heavy_minus_sign: | N/A | -| `object` | [components.CompletionDetailedJobOutObject](../../models/components/completiondetailedjoboutobject.md) | :heavy_minus_sign: | N/A | -| `fineTunedModel` | *string* | :heavy_minus_sign: | N/A | -| `suffix` | *string* | :heavy_minus_sign: | N/A | -| `integrations` | *components.CompletionDetailedJobOutIntegrations*[] | :heavy_minus_sign: | N/A | -| `trainedTokens` | *number* | :heavy_minus_sign: | N/A | -| `metadata` | [components.JobMetadataOut](../../models/components/jobmetadataout.md) | :heavy_minus_sign: | N/A | -| `jobType` | [components.CompletionDetailedJobOutJobType](../../models/components/completiondetailedjoboutjobtype.md) | :heavy_minus_sign: | N/A | -| `hyperparameters` | [components.CompletionTrainingParameters](../../models/components/completiontrainingparameters.md) | :heavy_check_mark: | N/A | -| `repositories` | *components.CompletionDetailedJobOutRepositories*[] | :heavy_minus_sign: | N/A | -| `events` | [components.EventOut](../../models/components/eventout.md)[] | :heavy_minus_sign: | Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. | -| `checkpoints` | [components.CheckpointOut](../../models/components/checkpointout.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutintegrations.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutintegrations.md deleted file mode 100644 index 2b460fd68..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutintegrations.md +++ /dev/null @@ -1,13 +0,0 @@ -# CompletionDetailedJobOutIntegrations - - -## Supported Types - -### `components.WandbIntegrationOut` - -```typescript -const value: components.WandbIntegrationOut = { - project: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutjobtype.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutjobtype.md deleted file mode 100644 index 062583fa8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutjobtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompletionDetailedJobOutJobType - -## Example Usage - -```typescript -import { CompletionDetailedJobOutJobType } from "@mistralai/mistralai/models/components"; - -let value: CompletionDetailedJobOutJobType = "completion"; -``` - -## Values - -```typescript -"completion" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutobject.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutobject.md deleted file mode 100644 index 98a1823b9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompletionDetailedJobOutObject - -## Example Usage - -```typescript -import { CompletionDetailedJobOutObject } from "@mistralai/mistralai/models/components"; - -let value: CompletionDetailedJobOutObject = "job"; -``` - -## Values - -```typescript -"job" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutrepositories.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutrepositories.md deleted file mode 100644 index fd349de8b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutrepositories.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompletionDetailedJobOutRepositories - - -## Supported Types - -### `components.GithubRepositoryOut` - -```typescript -const value: components.GithubRepositoryOut = { - name: "", - owner: "", - commitId: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutstatus.md b/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutstatus.md deleted file mode 100644 index 3e8777b83..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiondetailedjoboutstatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompletionDetailedJobOutStatus - -## Example Usage - -```typescript -import { CompletionDetailedJobOutStatus } from "@mistralai/mistralai/models/components"; - -let value: CompletionDetailedJobOutStatus = "QUEUED"; -``` - -## Values - -```typescript -"QUEUED" | "STARTED" | "VALIDATING" | "VALIDATED" | "RUNNING" | "FAILED_VALIDATION" | "FAILED" | "SUCCESS" | "CANCELLED" | "CANCELLATION_REQUESTED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionevent.md b/examples/sdks/mistral-typescript/docs/models/components/completionevent.md deleted file mode 100644 index 533afc6b6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionevent.md +++ /dev/null @@ -1,21 +0,0 @@ -# CompletionEvent - -## Example Usage - -```typescript -import { CompletionEvent } from "@mistralai/mistralai/models/components"; - -let value: CompletionEvent = { - data: { - id: "", - model: "Model S", - choices: [], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [components.CompletionChunk](../../models/components/completionchunk.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionftmodelout.md b/examples/sdks/mistral-typescript/docs/models/components/completionftmodelout.md deleted file mode 100644 index 083c48f3a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionftmodelout.md +++ /dev/null @@ -1,39 +0,0 @@ -# CompletionFTModelOut - -## Example Usage - -```typescript -import { CompletionFTModelOut } from "@mistralai/mistralai/models/components"; - -let value: CompletionFTModelOut = { - id: "", - created: 787475, - ownedBy: "", - workspaceId: "", - root: "", - rootVersion: "", - archived: false, - capabilities: {}, - job: "0f147667-0d54-46fd-934d-6a88bd2ec484", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [components.CompletionFTModelOutObject](../../models/components/completionftmodeloutobject.md) | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_check_mark: | N/A | -| `ownedBy` | *string* | :heavy_check_mark: | N/A | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | -| `root` | *string* | :heavy_check_mark: | N/A | -| `rootVersion` | *string* | :heavy_check_mark: | N/A | -| `archived` | *boolean* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `capabilities` | [components.FTModelCapabilitiesOut](../../models/components/ftmodelcapabilitiesout.md) | :heavy_check_mark: | N/A | -| `maxContextLength` | *number* | :heavy_minus_sign: | N/A | -| `aliases` | *string*[] | :heavy_minus_sign: | N/A | -| `job` | *string* | :heavy_check_mark: | N/A | -| `modelType` | [components.ModelType](../../models/components/modeltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionftmodeloutobject.md b/examples/sdks/mistral-typescript/docs/models/components/completionftmodeloutobject.md deleted file mode 100644 index 7d67b1621..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionftmodeloutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompletionFTModelOutObject - -## Example Usage - -```typescript -import { CompletionFTModelOutObject } from "@mistralai/mistralai/models/components"; - -let value: CompletionFTModelOutObject = "model"; -``` - -## Values - -```typescript -"model" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionjobout.md b/examples/sdks/mistral-typescript/docs/models/components/completionjobout.md deleted file mode 100644 index 41bdf74f2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionjobout.md +++ /dev/null @@ -1,44 +0,0 @@ -# CompletionJobOut - -## Example Usage - -```typescript -import { CompletionJobOut } from "@mistralai/mistralai/models/components"; - -let value: CompletionJobOut = { - id: "ad07d8f7-c8e8-41df-a05e-52088cd2b04b", - autoStart: false, - model: "Jetta", - status: "CANCELLED", - createdAt: 508554, - modifiedAt: 47551, - trainingFiles: [ - "0befa7d5-b534-4a53-8e8f-ae6a6f8e2d47", - "fc6abeaa-0a91-4111-9774-6e9c6a29d66a", - "f06b4756-0fe1-4e67-8ec2-5b8b8680fedc", - ], - hyperparameters: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The ID of the job. | -| `autoStart` | *boolean* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | The name of the model to fine-tune. | -| `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | The current status of the fine-tuning job. | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) for when the fine-tuning job was created. | -| `modifiedAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. | -| `trainingFiles` | *string*[] | :heavy_check_mark: | A list containing the IDs of uploaded files that contain training data. | -| `validationFiles` | *string*[] | :heavy_minus_sign: | A list containing the IDs of uploaded files that contain validation data. | -| `object` | [components.CompletionJobOutObject](../../models/components/completionjoboutobject.md) | :heavy_minus_sign: | The object type of the fine-tuning job. | -| `fineTunedModel` | *string* | :heavy_minus_sign: | The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | -| `integrations` | *components.Integrations*[] | :heavy_minus_sign: | A list of integrations enabled for your fine-tuning job. | -| `trainedTokens` | *number* | :heavy_minus_sign: | Total number of tokens trained. | -| `metadata` | [components.JobMetadataOut](../../models/components/jobmetadataout.md) | :heavy_minus_sign: | N/A | -| `jobType` | [components.JobType](../../models/components/jobtype.md) | :heavy_minus_sign: | The type of job (`FT` for fine-tuning). | -| `hyperparameters` | [components.CompletionTrainingParameters](../../models/components/completiontrainingparameters.md) | :heavy_check_mark: | N/A | -| `repositories` | *components.Repositories*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionjoboutobject.md b/examples/sdks/mistral-typescript/docs/models/components/completionjoboutobject.md deleted file mode 100644 index a1133dac1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionjoboutobject.md +++ /dev/null @@ -1,17 +0,0 @@ -# CompletionJobOutObject - -The object type of the fine-tuning job. - -## Example Usage - -```typescript -import { CompletionJobOutObject } from "@mistralai/mistralai/models/components"; - -let value: CompletionJobOutObject = "job"; -``` - -## Values - -```typescript -"job" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoice.md b/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoice.md deleted file mode 100644 index 1d31e89e2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# CompletionResponseStreamChoice - -## Example Usage - -```typescript -import { CompletionResponseStreamChoice } from "@mistralai/mistralai/models/components"; - -let value: CompletionResponseStreamChoice = { - index: 264645, - delta: {}, - finishReason: "tool_calls", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `index` | *number* | :heavy_check_mark: | N/A | -| `delta` | [components.DeltaMessage](../../models/components/deltamessage.md) | :heavy_check_mark: | N/A | -| `finishReason` | [components.CompletionResponseStreamChoiceFinishReason](../../models/components/completionresponsestreamchoicefinishreason.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoicefinishreason.md b/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoicefinishreason.md deleted file mode 100644 index a6042ab10..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completionresponsestreamchoicefinishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# CompletionResponseStreamChoiceFinishReason - -## Example Usage - -```typescript -import { CompletionResponseStreamChoiceFinishReason } from "@mistralai/mistralai/models/components"; - -let value: CompletionResponseStreamChoiceFinishReason = "stop"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparameters.md b/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparameters.md deleted file mode 100644 index 7bf44fb6a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparameters.md +++ /dev/null @@ -1,21 +0,0 @@ -# CompletionTrainingParameters - -## Example Usage - -```typescript -import { CompletionTrainingParameters } from "@mistralai/mistralai/models/components"; - -let value: CompletionTrainingParameters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `trainingSteps` | *number* | :heavy_minus_sign: | N/A | -| `learningRate` | *number* | :heavy_minus_sign: | N/A | -| `weightDecay` | *number* | :heavy_minus_sign: | N/A | -| `warmupFraction` | *number* | :heavy_minus_sign: | N/A | -| `epochs` | *number* | :heavy_minus_sign: | N/A | -| `seqLen` | *number* | :heavy_minus_sign: | N/A | -| `fimRatio` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparametersin.md b/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparametersin.md deleted file mode 100644 index 98c5376e7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/completiontrainingparametersin.md +++ /dev/null @@ -1,23 +0,0 @@ -# CompletionTrainingParametersIn - -The fine-tuning hyperparameter settings used in a fine-tune job. - -## Example Usage - -```typescript -import { CompletionTrainingParametersIn } from "@mistralai/mistralai/models/components"; - -let value: CompletionTrainingParametersIn = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `trainingSteps` | *number* | :heavy_minus_sign: | The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. | -| `learningRate` | *number* | :heavy_minus_sign: | A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. | -| `weightDecay` | *number* | :heavy_minus_sign: | (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. | -| `warmupFraction` | *number* | :heavy_minus_sign: | (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) | -| `epochs` | *number* | :heavy_minus_sign: | N/A | -| `seqLen` | *number* | :heavy_minus_sign: | N/A | -| `fimRatio` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/content.md b/examples/sdks/mistral-typescript/docs/models/components/content.md deleted file mode 100644 index e31bfa0c6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/content.md +++ /dev/null @@ -1,17 +0,0 @@ -# Content - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/contentchunk.md b/examples/sdks/mistral-typescript/docs/models/components/contentchunk.md deleted file mode 100644 index 6d969fc6b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/contentchunk.md +++ /dev/null @@ -1,61 +0,0 @@ -# ContentChunk - - -## Supported Types - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ReferenceChunk` - -```typescript -const value: components.ReferenceChunk = { - referenceIds: [], -}; -``` - -### `components.FileChunk` - -```typescript -const value: components.FileChunk = { - fileId: "9a7a83aa-6211-475c-88de-7116b47d91cd", -}; -``` - -### `components.ThinkChunk` - -```typescript -const value: components.ThinkChunk = { - thinking: [], -}; -``` - -### `components.AudioChunk` - -```typescript -const value: components.AudioChunk = { - inputAudio: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequest.md deleted file mode 100644 index e437462e8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequest.md +++ /dev/null @@ -1,30 +0,0 @@ -# ConversationAppendRequest - -## Example Usage - -```typescript -import { ConversationAppendRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationAppendRequest = { - inputs: [ - { - object: "entry", - type: "agent.handoff", - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | Whether to store the results into our servers or not. | -| `handoffExecution` | [components.ConversationAppendRequestHandoffExecution](../../models/components/conversationappendrequesthandoffexecution.md) | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequesthandoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequesthandoffexecution.md deleted file mode 100644 index ad2731f93..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationappendrequesthandoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationAppendRequestHandoffExecution - -## Example Usage - -```typescript -import { ConversationAppendRequestHandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: ConversationAppendRequestHandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequest.md deleted file mode 100644 index b7abc8858..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# ConversationAppendStreamRequest - -## Example Usage - -```typescript -import { ConversationAppendStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationAppendStreamRequest = { - inputs: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | Whether to store the results into our servers or not. | -| `handoffExecution` | [components.ConversationAppendStreamRequestHandoffExecution](../../models/components/conversationappendstreamrequesthandoffexecution.md) | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequesthandoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequesthandoffexecution.md deleted file mode 100644 index c93b172a4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationappendstreamrequesthandoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationAppendStreamRequestHandoffExecution - -## Example Usage - -```typescript -import { ConversationAppendStreamRequestHandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: ConversationAppendStreamRequestHandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationevents.md b/examples/sdks/mistral-typescript/docs/models/components/conversationevents.md deleted file mode 100644 index 248c8e52a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationevents.md +++ /dev/null @@ -1,25 +0,0 @@ -# ConversationEvents - -## Example Usage - -```typescript -import { ConversationEvents } from "@mistralai/mistralai/models/components"; - -let value: ConversationEvents = { - event: "function.call.delta", - data: { - type: "tool.execution.started", - outputIndex: 0, - id: "", - name: "code_interpreter", - arguments: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `event` | [components.SSETypes](../../models/components/ssetypes.md) | :heavy_check_mark: | Server side events sent when streaming a conversation response. | -| `data` | *components.ConversationEventsData* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationeventsdata.md b/examples/sdks/mistral-typescript/docs/models/components/conversationeventsdata.md deleted file mode 100644 index ba2422882..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationeventsdata.md +++ /dev/null @@ -1,102 +0,0 @@ -# ConversationEventsData - - -## Supported Types - -### `components.FunctionCallEvent` - -```typescript -const value: components.FunctionCallEvent = { - id: "", - name: "", - toolCallId: "", - arguments: "", -}; -``` - -### `components.AgentHandoffDoneEvent` - -```typescript -const value: components.AgentHandoffDoneEvent = { - id: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - -### `components.AgentHandoffStartedEvent` - -```typescript -const value: components.AgentHandoffStartedEvent = { - id: "", - previousAgentId: "", - previousAgentName: "", -}; -``` - -### `components.ToolExecutionDeltaEvent` - -```typescript -const value: components.ToolExecutionDeltaEvent = { - id: "", - name: "code_interpreter", - arguments: "", -}; -``` - -### `components.ToolExecutionStartedEvent` - -```typescript -const value: components.ToolExecutionStartedEvent = { - id: "", - name: "web_search_premium", - arguments: "", -}; -``` - -### `components.ResponseErrorEvent` - -```typescript -const value: components.ResponseErrorEvent = { - message: "", - code: 451589, -}; -``` - -### `components.MessageOutputEvent` - -```typescript -const value: components.MessageOutputEvent = { - id: "", - content: { - thinking: [], - type: "thinking", - }, -}; -``` - -### `components.ToolExecutionDoneEvent` - -```typescript -const value: components.ToolExecutionDoneEvent = { - id: "", - name: "code_interpreter", -}; -``` - -### `components.ResponseDoneEvent` - -```typescript -const value: components.ResponseDoneEvent = { - usage: {}, -}; -``` - -### `components.ResponseStartedEvent` - -```typescript -const value: components.ResponseStartedEvent = { - conversationId: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationhistory.md b/examples/sdks/mistral-typescript/docs/models/components/conversationhistory.md deleted file mode 100644 index 44e6c7974..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationhistory.md +++ /dev/null @@ -1,29 +0,0 @@ -# ConversationHistory - -Retrieve all entries in a conversation. - -## Example Usage - -```typescript -import { ConversationHistory } from "@mistralai/mistralai/models/components"; - -let value: ConversationHistory = { - conversationId: "", - entries: [ - { - object: "entry", - type: "function.result", - toolCallId: "", - result: "", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `object` | [components.ConversationHistoryObject](../../models/components/conversationhistoryobject.md) | :heavy_minus_sign: | N/A | -| `conversationId` | *string* | :heavy_check_mark: | N/A | -| `entries` | *components.Entries*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationhistoryobject.md b/examples/sdks/mistral-typescript/docs/models/components/conversationhistoryobject.md deleted file mode 100644 index ab0e032fb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationhistoryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationHistoryObject - -## Example Usage - -```typescript -import { ConversationHistoryObject } from "@mistralai/mistralai/models/components"; - -let value: ConversationHistoryObject = "conversation.history"; -``` - -## Values - -```typescript -"conversation.history" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationinputs.md b/examples/sdks/mistral-typescript/docs/models/components/conversationinputs.md deleted file mode 100644 index 81c42834a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationinputs.md +++ /dev/null @@ -1,24 +0,0 @@ -# ConversationInputs - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.InputEntries[]` - -```typescript -const value: components.InputEntries[] = [ - { - object: "entry", - type: "function.result", - toolCallId: "", - result: "", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationmessages.md b/examples/sdks/mistral-typescript/docs/models/components/conversationmessages.md deleted file mode 100644 index 39970ff2f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationmessages.md +++ /dev/null @@ -1,22 +0,0 @@ -# ConversationMessages - -Similar to the conversation history but only keep the messages - -## Example Usage - -```typescript -import { ConversationMessages } from "@mistralai/mistralai/models/components"; - -let value: ConversationMessages = { - conversationId: "", - messages: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `object` | [components.ConversationMessagesObject](../../models/components/conversationmessagesobject.md) | :heavy_minus_sign: | N/A | -| `conversationId` | *string* | :heavy_check_mark: | N/A | -| `messages` | *components.MessageEntries*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationmessagesobject.md b/examples/sdks/mistral-typescript/docs/models/components/conversationmessagesobject.md deleted file mode 100644 index 022759b31..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationmessagesobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationMessagesObject - -## Example Usage - -```typescript -import { ConversationMessagesObject } from "@mistralai/mistralai/models/components"; - -let value: ConversationMessagesObject = "conversation.messages"; -``` - -## Values - -```typescript -"conversation.messages" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationrequest.md deleted file mode 100644 index 529f78e0b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationrequest.md +++ /dev/null @@ -1,34 +0,0 @@ -# ConversationRequest - -## Example Usage - -```typescript -import { ConversationRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationRequest = { - inputs: [ - { - object: "entry", - type: "tool.execution", - name: "web_search_premium", - arguments: "", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | N/A | -| `handoffExecution` | [components.HandoffExecution](../../models/components/handoffexecution.md) | :heavy_minus_sign: | N/A | -| `instructions` | *string* | :heavy_minus_sign: | N/A | -| `tools` | *components.Tools*[] | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationresponse.md b/examples/sdks/mistral-typescript/docs/models/components/conversationresponse.md deleted file mode 100644 index 333791950..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationresponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# ConversationResponse - -The response after appending new entries to the conversation. - -## Example Usage - -```typescript -import { ConversationResponse } from "@mistralai/mistralai/models/components"; - -let value: ConversationResponse = { - conversationId: "", - outputs: [ - { - object: "entry", - type: "tool.execution", - name: "code_interpreter", - arguments: "", - }, - ], - usage: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `object` | [components.ConversationResponseObject](../../models/components/conversationresponseobject.md) | :heavy_minus_sign: | N/A | -| `conversationId` | *string* | :heavy_check_mark: | N/A | -| `outputs` | *components.Outputs*[] | :heavy_check_mark: | N/A | -| `usage` | [components.ConversationUsageInfo](../../models/components/conversationusageinfo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationresponseobject.md b/examples/sdks/mistral-typescript/docs/models/components/conversationresponseobject.md deleted file mode 100644 index b934617fd..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationresponseobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationResponseObject - -## Example Usage - -```typescript -import { ConversationResponseObject } from "@mistralai/mistralai/models/components"; - -let value: ConversationResponseObject = "conversation.response"; -``` - -## Values - -```typescript -"conversation.response" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequest.md deleted file mode 100644 index 0b3417342..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequest.md +++ /dev/null @@ -1,25 +0,0 @@ -# ConversationRestartRequest - -Request to restart a new conversation from a given entry in the conversation. - -## Example Usage - -```typescript -import { ConversationRestartRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationRestartRequest = { - inputs: "", - fromEntryId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | Whether to store the results into our servers or not. | -| `handoffExecution` | [components.ConversationRestartRequestHandoffExecution](../../models/components/conversationrestartrequesthandoffexecution.md) | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `fromEntryId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequesthandoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequesthandoffexecution.md deleted file mode 100644 index 4a4146765..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartrequesthandoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationRestartRequestHandoffExecution - -## Example Usage - -```typescript -import { ConversationRestartRequestHandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: ConversationRestartRequestHandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequest.md deleted file mode 100644 index 4d71255c3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequest.md +++ /dev/null @@ -1,25 +0,0 @@ -# ConversationRestartStreamRequest - -Request to restart a new conversation from a given entry in the conversation. - -## Example Usage - -```typescript -import { ConversationRestartStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationRestartStreamRequest = { - inputs: "", - fromEntryId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | Whether to store the results into our servers or not. | -| `handoffExecution` | [components.ConversationRestartStreamRequestHandoffExecution](../../models/components/conversationrestartstreamrequesthandoffexecution.md) | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `fromEntryId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequesthandoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequesthandoffexecution.md deleted file mode 100644 index 13dd15bc9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationrestartstreamrequesthandoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationRestartStreamRequestHandoffExecution - -## Example Usage - -```typescript -import { ConversationRestartStreamRequestHandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: ConversationRestartStreamRequestHandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequest.md deleted file mode 100644 index 850a2d467..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequest.md +++ /dev/null @@ -1,27 +0,0 @@ -# ConversationStreamRequest - -## Example Usage - -```typescript -import { ConversationStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: ConversationStreamRequest = { - inputs: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `inputs` | *components.ConversationInputs* | :heavy_check_mark: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | N/A | -| `handoffExecution` | [components.ConversationStreamRequestHandoffExecution](../../models/components/conversationstreamrequesthandoffexecution.md) | :heavy_minus_sign: | N/A | -| `instructions` | *string* | :heavy_minus_sign: | N/A | -| `tools` | *components.ConversationStreamRequestTools*[] | :heavy_minus_sign: | N/A | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesthandoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesthandoffexecution.md deleted file mode 100644 index 4830a48ca..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesthandoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# ConversationStreamRequestHandoffExecution - -## Example Usage - -```typescript -import { ConversationStreamRequestHandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: ConversationStreamRequestHandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesttools.md b/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesttools.md deleted file mode 100644 index bea62cda4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationstreamrequesttools.md +++ /dev/null @@ -1,54 +0,0 @@ -# ConversationStreamRequestTools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/conversationusageinfo.md b/examples/sdks/mistral-typescript/docs/models/components/conversationusageinfo.md deleted file mode 100644 index 9a42e0c09..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/conversationusageinfo.md +++ /dev/null @@ -1,19 +0,0 @@ -# ConversationUsageInfo - -## Example Usage - -```typescript -import { ConversationUsageInfo } from "@mistralai/mistralai/models/components"; - -let value: ConversationUsageInfo = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `promptTokens` | *number* | :heavy_minus_sign: | N/A | -| `completionTokens` | *number* | :heavy_minus_sign: | N/A | -| `totalTokens` | *number* | :heavy_minus_sign: | N/A | -| `connectorTokens` | *number* | :heavy_minus_sign: | N/A | -| `connectors` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/data.md b/examples/sdks/mistral-typescript/docs/models/components/data.md deleted file mode 100644 index b5b5f02b0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/data.md +++ /dev/null @@ -1,25 +0,0 @@ -# Data - - -## Supported Types - -### `components.FTModelCard` - -```typescript -const value: components.FTModelCard = { - id: "", - capabilities: {}, - job: "Global Interactions Strategist", - root: "", -}; -``` - -### `components.BaseModelCard` - -```typescript -const value: components.BaseModelCard = { - id: "", - capabilities: {}, -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/deletefileout.md b/examples/sdks/mistral-typescript/docs/models/components/deletefileout.md deleted file mode 100644 index a87678937..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/deletefileout.md +++ /dev/null @@ -1,21 +0,0 @@ -# DeleteFileOut - -## Example Usage - -```typescript -import { DeleteFileOut } from "@mistralai/mistralai/models/components"; - -let value: DeleteFileOut = { - id: "497f6eca-6276-4993-bfeb-53cbbbba6f09", - object: "file", - deleted: false, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *string* | :heavy_check_mark: | The ID of the deleted file. | 497f6eca-6276-4993-bfeb-53cbbbba6f09 | -| `object` | *string* | :heavy_check_mark: | The object type that was deleted | file | -| `deleted` | *boolean* | :heavy_check_mark: | The deletion status. | false | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/deletemodelout.md b/examples/sdks/mistral-typescript/docs/models/components/deletemodelout.md deleted file mode 100644 index 4528cf3d3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/deletemodelout.md +++ /dev/null @@ -1,19 +0,0 @@ -# DeleteModelOut - -## Example Usage - -```typescript -import { DeleteModelOut } from "@mistralai/mistralai/models/components"; - -let value: DeleteModelOut = { - id: "ft:open-mistral-7b:587a6b29:20240514:7e773925", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The ID of the deleted model. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | -| `object` | *string* | :heavy_minus_sign: | The object type that was deleted | | -| `deleted` | *boolean* | :heavy_minus_sign: | The deletion status | true | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/deltamessage.md b/examples/sdks/mistral-typescript/docs/models/components/deltamessage.md deleted file mode 100644 index cd5b717a0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/deltamessage.md +++ /dev/null @@ -1,17 +0,0 @@ -# DeltaMessage - -## Example Usage - -```typescript -import { DeltaMessage } from "@mistralai/mistralai/models/components"; - -let value: DeltaMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `role` | *string* | :heavy_minus_sign: | N/A | -| `content` | *components.Content* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/document.md b/examples/sdks/mistral-typescript/docs/models/components/document.md deleted file mode 100644 index 9b7be3aa8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/document.md +++ /dev/null @@ -1,31 +0,0 @@ -# Document - -Document to run OCR on - - -## Supported Types - -### `components.FileChunk` - -```typescript -const value: components.FileChunk = { - fileId: "9a7a83aa-6211-475c-88de-7116b47d91cd", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytool.md b/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytool.md deleted file mode 100644 index 1e99b3e8a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytool.md +++ /dev/null @@ -1,22 +0,0 @@ -# DocumentLibraryTool - -## Example Usage - -```typescript -import { DocumentLibraryTool } from "@mistralai/mistralai/models/components"; - -let value: DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.DocumentLibraryToolType](../../models/components/documentlibrarytooltype.md) | :heavy_minus_sign: | N/A | -| `libraryIds` | *string*[] | :heavy_check_mark: | Ids of the library in which to search. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytooltype.md b/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytooltype.md deleted file mode 100644 index df0279b39..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documentlibrarytooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# DocumentLibraryToolType - -## Example Usage - -```typescript -import { DocumentLibraryToolType } from "@mistralai/mistralai/models/components"; - -let value: DocumentLibraryToolType = "document_library"; -``` - -## Values - -```typescript -"document_library" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documentout.md b/examples/sdks/mistral-typescript/docs/models/components/documentout.md deleted file mode 100644 index 67ebfe9c5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documentout.md +++ /dev/null @@ -1,44 +0,0 @@ -# DocumentOut - -## Example Usage - -```typescript -import { DocumentOut } from "@mistralai/mistralai/models/components"; - -let value: DocumentOut = { - id: "baffe13e-7139-4dca-9da9-6808efbb8966", - libraryId: "f85c6cfe-ffba-4130-8350-eb7bc74cf318", - hash: "", - mimeType: "", - extension: "jpe", - size: 557590, - name: "", - createdAt: new Date("2023-04-27T09:47:22.828Z"), - processingStatus: "", - uploadedById: "a07ae014-de08-46b2-9005-78a53e12d7f6", - uploadedByType: "", - tokensProcessingTotal: 554819, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `hash` | *string* | :heavy_check_mark: | N/A | -| `mimeType` | *string* | :heavy_check_mark: | N/A | -| `extension` | *string* | :heavy_check_mark: | N/A | -| `size` | *number* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `summary` | *string* | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `lastProcessedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `numberOfPages` | *number* | :heavy_minus_sign: | N/A | -| `processingStatus` | *string* | :heavy_check_mark: | N/A | -| `uploadedById` | *string* | :heavy_check_mark: | N/A | -| `uploadedByType` | *string* | :heavy_check_mark: | N/A | -| `tokensProcessingMainContent` | *number* | :heavy_minus_sign: | N/A | -| `tokensProcessingSummary` | *number* | :heavy_minus_sign: | N/A | -| `tokensProcessingTotal` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documenttextcontent.md b/examples/sdks/mistral-typescript/docs/models/components/documenttextcontent.md deleted file mode 100644 index 2acec6a8c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documenttextcontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# DocumentTextContent - -## Example Usage - -```typescript -import { DocumentTextContent } from "@mistralai/mistralai/models/components"; - -let value: DocumentTextContent = { - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documentupdatein.md b/examples/sdks/mistral-typescript/docs/models/components/documentupdatein.md deleted file mode 100644 index edc6979f3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documentupdatein.md +++ /dev/null @@ -1,15 +0,0 @@ -# DocumentUpdateIn - -## Example Usage - -```typescript -import { DocumentUpdateIn } from "@mistralai/mistralai/models/components"; - -let value: DocumentUpdateIn = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documenturlchunk.md b/examples/sdks/mistral-typescript/docs/models/components/documenturlchunk.md deleted file mode 100644 index a2a1a79ae..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documenturlchunk.md +++ /dev/null @@ -1,19 +0,0 @@ -# DocumentURLChunk - -## Example Usage - -```typescript -import { DocumentURLChunk } from "@mistralai/mistralai/models/components"; - -let value: DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `documentUrl` | *string* | :heavy_check_mark: | N/A | -| `documentName` | *string* | :heavy_minus_sign: | The filename of the document | -| `type` | [components.DocumentURLChunkType](../../models/components/documenturlchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/documenturlchunktype.md b/examples/sdks/mistral-typescript/docs/models/components/documenturlchunktype.md deleted file mode 100644 index 31417351f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/documenturlchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# DocumentURLChunkType - -## Example Usage - -```typescript -import { DocumentURLChunkType } from "@mistralai/mistralai/models/components"; - -let value: DocumentURLChunkType = "document_url"; -``` - -## Values - -```typescript -"document_url" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/embeddingdtype.md b/examples/sdks/mistral-typescript/docs/models/components/embeddingdtype.md deleted file mode 100644 index 99d50e00e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/embeddingdtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# EmbeddingDtype - -## Example Usage - -```typescript -import { EmbeddingDtype } from "@mistralai/mistralai/models/components"; - -let value: EmbeddingDtype = "int8"; -``` - -## Values - -```typescript -"float" | "int8" | "uint8" | "binary" | "ubinary" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/embeddingrequest.md b/examples/sdks/mistral-typescript/docs/models/components/embeddingrequest.md deleted file mode 100644 index 50aae0568..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/embeddingrequest.md +++ /dev/null @@ -1,25 +0,0 @@ -# EmbeddingRequest - -## Example Usage - -```typescript -import { EmbeddingRequest } from "@mistralai/mistralai/models/components"; - -let value: EmbeddingRequest = { - model: "mistral-embed", - inputs: [ - "Embed this sentence.", - "As well as this one.", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. | mistral-embed | -| `inputs` | *components.EmbeddingRequestInputs* | :heavy_check_mark: | Text to embed. | [
    "Embed this sentence.",
    "As well as this one."
    ] | -| `outputDimension` | *number* | :heavy_minus_sign: | The dimension of the output embeddings. | | -| `outputDtype` | [components.EmbeddingDtype](../../models/components/embeddingdtype.md) | :heavy_minus_sign: | N/A | | -| `encodingFormat` | [components.EncodingFormat](../../models/components/encodingformat.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/embeddingrequestinputs.md b/examples/sdks/mistral-typescript/docs/models/components/embeddingrequestinputs.md deleted file mode 100644 index 79a149844..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/embeddingrequestinputs.md +++ /dev/null @@ -1,22 +0,0 @@ -# EmbeddingRequestInputs - -Text to embed. - - -## Supported Types - -### `string` - -```typescript -const value: string = "[\"Embed this sentence.\",\"As well as this one.\"]"; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "Embed this sentence.", - "As well as this one.", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/embeddingresponse.md b/examples/sdks/mistral-typescript/docs/models/components/embeddingresponse.md deleted file mode 100644 index 79c80fa19..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/embeddingresponse.md +++ /dev/null @@ -1,44 +0,0 @@ -# EmbeddingResponse - -## Example Usage - -```typescript -import { EmbeddingResponse } from "@mistralai/mistralai/models/components"; - -let value: EmbeddingResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "mistral-small-latest", - usage: {}, - data: [ - { - object: "embedding", - embedding: [ - 0.1, - 0.2, - 0.3, - ], - index: 0, - }, - { - object: "embedding", - embedding: [ - 0.4, - 0.5, - 0.6, - ], - index: 1, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | mistral-small-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `data` | [components.EmbeddingResponseData](../../models/components/embeddingresponsedata.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/embeddingresponsedata.md b/examples/sdks/mistral-typescript/docs/models/components/embeddingresponsedata.md deleted file mode 100644 index 98bb0962f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/embeddingresponsedata.md +++ /dev/null @@ -1,25 +0,0 @@ -# EmbeddingResponseData - -## Example Usage - -```typescript -import { EmbeddingResponseData } from "@mistralai/mistralai/models/components"; - -let value: EmbeddingResponseData = { - object: "embedding", - embedding: [ - 0.1, - 0.2, - 0.3, - ], - index: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `object` | *string* | :heavy_minus_sign: | N/A | embedding | -| `embedding` | *number*[] | :heavy_minus_sign: | N/A | [
    0.1,
    0.2,
    0.3
    ] | -| `index` | *number* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/encodingformat.md b/examples/sdks/mistral-typescript/docs/models/components/encodingformat.md deleted file mode 100644 index d6197176d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/encodingformat.md +++ /dev/null @@ -1,15 +0,0 @@ -# EncodingFormat - -## Example Usage - -```typescript -import { EncodingFormat } from "@mistralai/mistralai/models/components"; - -let value: EncodingFormat = "float"; -``` - -## Values - -```typescript -"float" | "base64" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/entitytype.md b/examples/sdks/mistral-typescript/docs/models/components/entitytype.md deleted file mode 100644 index 675c49dc1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/entitytype.md +++ /dev/null @@ -1,19 +0,0 @@ -# EntityType - -The type of entity, used to share a library. - -## Example Usage - -```typescript -import { EntityType } from "@mistralai/mistralai/models/components"; - -let value: EntityType = "User"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"User" | "Workspace" | "Org" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/entries.md b/examples/sdks/mistral-typescript/docs/models/components/entries.md deleted file mode 100644 index 6019827ae..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/entries.md +++ /dev/null @@ -1,65 +0,0 @@ -# Entries - - -## Supported Types - -### `components.MessageInputEntry` - -```typescript -const value: components.MessageInputEntry = { - role: "assistant", - content: [], -}; -``` - -### `components.MessageOutputEntry` - -```typescript -const value: components.MessageOutputEntry = { - content: "", -}; -``` - -### `components.FunctionResultEntry` - -```typescript -const value: components.FunctionResultEntry = { - toolCallId: "", - result: "", -}; -``` - -### `components.FunctionCallEntry` - -```typescript -const value: components.FunctionCallEntry = { - toolCallId: "", - name: "", - arguments: { - "key": "", - "key1": "", - "key2": "", - }, -}; -``` - -### `components.ToolExecutionEntry` - -```typescript -const value: components.ToolExecutionEntry = { - name: "web_search", - arguments: "", -}; -``` - -### `components.AgentHandoffEntry` - -```typescript -const value: components.AgentHandoffEntry = { - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/eventout.md b/examples/sdks/mistral-typescript/docs/models/components/eventout.md deleted file mode 100644 index e3f1159b3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/eventout.md +++ /dev/null @@ -1,20 +0,0 @@ -# EventOut - -## Example Usage - -```typescript -import { EventOut } from "@mistralai/mistralai/models/components"; - -let value: EventOut = { - name: "", - createdAt: 115062, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the event. | -| `data` | Record | :heavy_minus_sign: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) of the event. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/filechunk.md b/examples/sdks/mistral-typescript/docs/models/components/filechunk.md deleted file mode 100644 index ae400fcdc..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/filechunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# FileChunk - -## Example Usage - -```typescript -import { FileChunk } from "@mistralai/mistralai/models/components"; - -let value: FileChunk = { - fileId: "9a7a83aa-6211-475c-88de-7116b47d91cd", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/filepurpose.md b/examples/sdks/mistral-typescript/docs/models/components/filepurpose.md deleted file mode 100644 index 6d4841cf5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/filepurpose.md +++ /dev/null @@ -1,17 +0,0 @@ -# FilePurpose - -## Example Usage - -```typescript -import { FilePurpose } from "@mistralai/mistralai/models/components"; - -let value: FilePurpose = "fine-tune"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"fine-tune" | "batch" | "ocr" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/fileschema.md b/examples/sdks/mistral-typescript/docs/models/components/fileschema.md deleted file mode 100644 index f8d66aca3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fileschema.md +++ /dev/null @@ -1,34 +0,0 @@ -# FileSchema - -## Example Usage - -```typescript -import { FileSchema } from "@mistralai/mistralai/models/components"; - -let value: FileSchema = { - id: "497f6eca-6276-4993-bfeb-53cbbbba6f09", - object: "file", - sizeBytes: 13000, - createdAt: 1716963433, - filename: "files_upload.jsonl", - purpose: "fine-tune", - sampleType: "batch_request", - source: "mistral", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the file. | 497f6eca-6276-4993-bfeb-53cbbbba6f09 | -| `object` | *string* | :heavy_check_mark: | The object type, which is always "file". | file | -| `sizeBytes` | *number* | :heavy_check_mark: | The size of the file, in bytes. | 13000 | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) of the event. | 1716963433 | -| `filename` | *string* | :heavy_check_mark: | The name of the uploaded file. | files_upload.jsonl | -| `purpose` | [components.FilePurpose](../../models/components/filepurpose.md) | :heavy_check_mark: | N/A | | -| `sampleType` | [components.SampleType](../../models/components/sampletype.md) | :heavy_check_mark: | N/A | | -| `numLines` | *number* | :heavy_minus_sign: | N/A | | -| `mimetype` | *string* | :heavy_minus_sign: | N/A | | -| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/filesignedurl.md b/examples/sdks/mistral-typescript/docs/models/components/filesignedurl.md deleted file mode 100644 index ae2a24970..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/filesignedurl.md +++ /dev/null @@ -1,17 +0,0 @@ -# FileSignedURL - -## Example Usage - -```typescript -import { FileSignedURL } from "@mistralai/mistralai/models/components"; - -let value: FileSignedURL = { - url: "https://devoted-skyline.com", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/filet.md b/examples/sdks/mistral-typescript/docs/models/components/filet.md deleted file mode 100644 index 6dc3bdc3b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/filet.md +++ /dev/null @@ -1,16 +0,0 @@ -# FileT - -## Example Usage - -```typescript -import { FileT } from "@mistralai/mistralai/models/components"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `fileName` | *string* | :heavy_check_mark: | N/A | -| `content` | *ReadableStream* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequest.md b/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequest.md deleted file mode 100644 index 246e084af..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# FIMCompletionRequest - -## Example Usage - -```typescript -import { FIMCompletionRequest } from "@mistralai/mistralai/models/components"; - -let value: FIMCompletionRequest = { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. Only compatible for now with:
    - `codestral-2405`
    - `codestral-latest` | codestral-2405 | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.FIMCompletionRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `prompt` | *string* | :heavy_check_mark: | The text/code to complete. | def | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | return a+b | -| `minTokens` | *number* | :heavy_minus_sign: | The minimum number of tokens to generate in the completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequeststop.md b/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequeststop.md deleted file mode 100644 index 564250b18..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionrequeststop.md +++ /dev/null @@ -1,22 +0,0 @@ -# FIMCompletionRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionresponse.md b/examples/sdks/mistral-typescript/docs/models/components/fimcompletionresponse.md deleted file mode 100644 index bd6aa317e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionresponse.md +++ /dev/null @@ -1,33 +0,0 @@ -# FIMCompletionResponse - -## Example Usage - -```typescript -import { FIMCompletionResponse } from "@mistralai/mistralai/models/components"; - -let value: FIMCompletionResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "codestral-latest", - usage: {}, - created: 1702256327, - choices: [ - { - index: 0, - message: {}, - finishReason: "stop", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | codestral-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_check_mark: | N/A | 1702256327 | -| `choices` | [components.ChatCompletionChoice](../../models/components/chatcompletionchoice.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequest.md deleted file mode 100644 index 49eb03799..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# FIMCompletionStreamRequest - -## Example Usage - -```typescript -import { FIMCompletionStreamRequest } from "@mistralai/mistralai/models/components"; - -let value: FIMCompletionStreamRequest = { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. Only compatible for now with:
    - `codestral-2405`
    - `codestral-latest` | codestral-2405 | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.FIMCompletionStreamRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `prompt` | *string* | :heavy_check_mark: | The text/code to complete. | def | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | return a+b | -| `minTokens` | *number* | :heavy_minus_sign: | The minimum number of tokens to generate in the completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequeststop.md b/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequeststop.md deleted file mode 100644 index 12021bc42..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/fimcompletionstreamrequeststop.md +++ /dev/null @@ -1,22 +0,0 @@ -# FIMCompletionStreamRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/finetuneablemodeltype.md b/examples/sdks/mistral-typescript/docs/models/components/finetuneablemodeltype.md deleted file mode 100644 index 411558120..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/finetuneablemodeltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FineTuneableModelType - -## Example Usage - -```typescript -import { FineTuneableModelType } from "@mistralai/mistralai/models/components"; - -let value: FineTuneableModelType = "classifier"; -``` - -## Values - -```typescript -"completion" | "classifier" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/finishreason.md b/examples/sdks/mistral-typescript/docs/models/components/finishreason.md deleted file mode 100644 index 1d3f9911a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/finishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# FinishReason - -## Example Usage - -```typescript -import { FinishReason } from "@mistralai/mistralai/models/components"; - -let value: FinishReason = "stop"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "model_length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ftclassifierlossfunction.md b/examples/sdks/mistral-typescript/docs/models/components/ftclassifierlossfunction.md deleted file mode 100644 index 0a81d8f52..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ftclassifierlossfunction.md +++ /dev/null @@ -1,15 +0,0 @@ -# FTClassifierLossFunction - -## Example Usage - -```typescript -import { FTClassifierLossFunction } from "@mistralai/mistralai/models/components"; - -let value: FTClassifierLossFunction = "single_class"; -``` - -## Values - -```typescript -"single_class" | "multi_class" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcapabilitiesout.md b/examples/sdks/mistral-typescript/docs/models/components/ftmodelcapabilitiesout.md deleted file mode 100644 index 4fb0620cd..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcapabilitiesout.md +++ /dev/null @@ -1,19 +0,0 @@ -# FTModelCapabilitiesOut - -## Example Usage - -```typescript -import { FTModelCapabilitiesOut } from "@mistralai/mistralai/models/components"; - -let value: FTModelCapabilitiesOut = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `completionChat` | *boolean* | :heavy_minus_sign: | N/A | -| `completionFim` | *boolean* | :heavy_minus_sign: | N/A | -| `functionCalling` | *boolean* | :heavy_minus_sign: | N/A | -| `fineTuning` | *boolean* | :heavy_minus_sign: | N/A | -| `classification` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcard.md b/examples/sdks/mistral-typescript/docs/models/components/ftmodelcard.md deleted file mode 100644 index 7cbac9eb3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcard.md +++ /dev/null @@ -1,37 +0,0 @@ -# FTModelCard - -Extra fields for fine-tuned models. - -## Example Usage - -```typescript -import { FTModelCard } from "@mistralai/mistralai/models/components"; - -let value: FTModelCard = { - id: "", - capabilities: {}, - job: "Global Interactions Strategist", - root: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_minus_sign: | N/A | -| `ownedBy` | *string* | :heavy_minus_sign: | N/A | -| `capabilities` | [components.ModelCapabilities](../../models/components/modelcapabilities.md) | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `maxContextLength` | *number* | :heavy_minus_sign: | N/A | -| `aliases` | *string*[] | :heavy_minus_sign: | N/A | -| `deprecation` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `deprecationReplacementModel` | *string* | :heavy_minus_sign: | N/A | -| `defaultModelTemperature` | *number* | :heavy_minus_sign: | N/A | -| `type` | [components.FTModelCardType](../../models/components/ftmodelcardtype.md) | :heavy_minus_sign: | N/A | -| `job` | *string* | :heavy_check_mark: | N/A | -| `root` | *string* | :heavy_check_mark: | N/A | -| `archived` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcardtype.md b/examples/sdks/mistral-typescript/docs/models/components/ftmodelcardtype.md deleted file mode 100644 index 22c804316..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ftmodelcardtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FTModelCardType - -## Example Usage - -```typescript -import { FTModelCardType } from "@mistralai/mistralai/models/components"; - -let value: FTModelCardType = "fine-tuned"; -``` - -## Values - -```typescript -"fine-tuned" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncall.md b/examples/sdks/mistral-typescript/docs/models/components/functioncall.md deleted file mode 100644 index 9330b51ee..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncall.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionCall - -## Example Usage - -```typescript -import { FunctionCall } from "@mistralai/mistralai/models/components"; - -let value: FunctionCall = { - name: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *components.Arguments* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncallentry.md b/examples/sdks/mistral-typescript/docs/models/components/functioncallentry.md deleted file mode 100644 index cc7db51d1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncallentry.md +++ /dev/null @@ -1,30 +0,0 @@ -# FunctionCallEntry - -## Example Usage - -```typescript -import { FunctionCallEntry } from "@mistralai/mistralai/models/components"; - -let value: FunctionCallEntry = { - toolCallId: "", - name: "", - arguments: { - "key": "", - "key1": "", - "key2": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.FunctionCallEntryObject](../../models/components/functioncallentryobject.md) | :heavy_minus_sign: | N/A | -| `type` | [components.FunctionCallEntryType](../../models/components/functioncallentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `toolCallId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *components.FunctionCallEntryArguments* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncallentryarguments.md b/examples/sdks/mistral-typescript/docs/models/components/functioncallentryarguments.md deleted file mode 100644 index 5da6cb461..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncallentryarguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# FunctionCallEntryArguments - - -## Supported Types - -### `{ [k: string]: any }` - -```typescript -const value: { [k: string]: any } = { - "key": "", - "key1": "", - "key2": "", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncallentryobject.md b/examples/sdks/mistral-typescript/docs/models/components/functioncallentryobject.md deleted file mode 100644 index 4e5cbbe4c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncallentryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionCallEntryObject - -## Example Usage - -```typescript -import { FunctionCallEntryObject } from "@mistralai/mistralai/models/components"; - -let value: FunctionCallEntryObject = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncallentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/functioncallentrytype.md deleted file mode 100644 index 5a4e3859b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncallentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionCallEntryType - -## Example Usage - -```typescript -import { FunctionCallEntryType } from "@mistralai/mistralai/models/components"; - -let value: FunctionCallEntryType = "function.call"; -``` - -## Values - -```typescript -"function.call" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncallevent.md b/examples/sdks/mistral-typescript/docs/models/components/functioncallevent.md deleted file mode 100644 index 2e480e768..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncallevent.md +++ /dev/null @@ -1,26 +0,0 @@ -# FunctionCallEvent - -## Example Usage - -```typescript -import { FunctionCallEvent } from "@mistralai/mistralai/models/components"; - -let value: FunctionCallEvent = { - id: "", - name: "", - toolCallId: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.FunctionCallEventType](../../models/components/functioncalleventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `toolCallId` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functioncalleventtype.md b/examples/sdks/mistral-typescript/docs/models/components/functioncalleventtype.md deleted file mode 100644 index 0a3cc43f4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functioncalleventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionCallEventType - -## Example Usage - -```typescript -import { FunctionCallEventType } from "@mistralai/mistralai/models/components"; - -let value: FunctionCallEventType = "function.call.delta"; -``` - -## Values - -```typescript -"function.call.delta" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functionname.md b/examples/sdks/mistral-typescript/docs/models/components/functionname.md deleted file mode 100644 index ffbd57985..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functionname.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionName - -this restriction of `Function` is used to select a specific function to call - -## Example Usage - -```typescript -import { FunctionName } from "@mistralai/mistralai/models/components"; - -let value: FunctionName = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functionresultentry.md b/examples/sdks/mistral-typescript/docs/models/components/functionresultentry.md deleted file mode 100644 index fcf4943c6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functionresultentry.md +++ /dev/null @@ -1,24 +0,0 @@ -# FunctionResultEntry - -## Example Usage - -```typescript -import { FunctionResultEntry } from "@mistralai/mistralai/models/components"; - -let value: FunctionResultEntry = { - toolCallId: "", - result: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.FunctionResultEntryObject](../../models/components/functionresultentryobject.md) | :heavy_minus_sign: | N/A | -| `type` | [components.FunctionResultEntryType](../../models/components/functionresultentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `toolCallId` | *string* | :heavy_check_mark: | N/A | -| `result` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functionresultentryobject.md b/examples/sdks/mistral-typescript/docs/models/components/functionresultentryobject.md deleted file mode 100644 index 9bbbddbed..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functionresultentryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionResultEntryObject - -## Example Usage - -```typescript -import { FunctionResultEntryObject } from "@mistralai/mistralai/models/components"; - -let value: FunctionResultEntryObject = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functionresultentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/functionresultentrytype.md deleted file mode 100644 index 8e5e73b8b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functionresultentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionResultEntryType - -## Example Usage - -```typescript -import { FunctionResultEntryType } from "@mistralai/mistralai/models/components"; - -let value: FunctionResultEntryType = "function.result"; -``` - -## Values - -```typescript -"function.result" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functiont.md b/examples/sdks/mistral-typescript/docs/models/components/functiont.md deleted file mode 100644 index 12edd4f7f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functiont.md +++ /dev/null @@ -1,23 +0,0 @@ -# FunctionT - -## Example Usage - -```typescript -import { FunctionT } from "@mistralai/mistralai/models/components"; - -let value: FunctionT = { - name: "", - parameters: { - "key": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `parameters` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functiontool.md b/examples/sdks/mistral-typescript/docs/models/components/functiontool.md deleted file mode 100644 index 7906fdb5b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functiontool.md +++ /dev/null @@ -1,23 +0,0 @@ -# FunctionTool - -## Example Usage - -```typescript -import { FunctionTool } from "@mistralai/mistralai/models/components"; - -let value: FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.FunctionToolType](../../models/components/functiontooltype.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionT](../../models/components/functiont.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/functiontooltype.md b/examples/sdks/mistral-typescript/docs/models/components/functiontooltype.md deleted file mode 100644 index c418636a1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/functiontooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionToolType - -## Example Usage - -```typescript -import { FunctionToolType } from "@mistralai/mistralai/models/components"; - -let value: FunctionToolType = "function"; -``` - -## Values - -```typescript -"function" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryin.md b/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryin.md deleted file mode 100644 index 9d947e56c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryin.md +++ /dev/null @@ -1,24 +0,0 @@ -# GithubRepositoryIn - -## Example Usage - -```typescript -import { GithubRepositoryIn } from "@mistralai/mistralai/models/components"; - -let value: GithubRepositoryIn = { - name: "", - owner: "", - token: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.GithubRepositoryInType](../../models/components/githubrepositoryintype.md) | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `owner` | *string* | :heavy_check_mark: | N/A | -| `ref` | *string* | :heavy_minus_sign: | N/A | -| `weight` | *number* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryintype.md b/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryintype.md deleted file mode 100644 index 0b59065d6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryintype.md +++ /dev/null @@ -1,15 +0,0 @@ -# GithubRepositoryInType - -## Example Usage - -```typescript -import { GithubRepositoryInType } from "@mistralai/mistralai/models/components"; - -let value: GithubRepositoryInType = "github"; -``` - -## Values - -```typescript -"github" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryout.md b/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryout.md deleted file mode 100644 index dcc66a2d2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryout.md +++ /dev/null @@ -1,24 +0,0 @@ -# GithubRepositoryOut - -## Example Usage - -```typescript -import { GithubRepositoryOut } from "@mistralai/mistralai/models/components"; - -let value: GithubRepositoryOut = { - name: "", - owner: "", - commitId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.GithubRepositoryOutType](../../models/components/githubrepositoryouttype.md) | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `owner` | *string* | :heavy_check_mark: | N/A | -| `ref` | *string* | :heavy_minus_sign: | N/A | -| `weight` | *number* | :heavy_minus_sign: | N/A | -| `commitId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryouttype.md b/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryouttype.md deleted file mode 100644 index 69727c9fb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/githubrepositoryouttype.md +++ /dev/null @@ -1,15 +0,0 @@ -# GithubRepositoryOutType - -## Example Usage - -```typescript -import { GithubRepositoryOutType } from "@mistralai/mistralai/models/components"; - -let value: GithubRepositoryOutType = "github"; -``` - -## Values - -```typescript -"github" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/handoffexecution.md b/examples/sdks/mistral-typescript/docs/models/components/handoffexecution.md deleted file mode 100644 index c693aafa5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/handoffexecution.md +++ /dev/null @@ -1,15 +0,0 @@ -# HandoffExecution - -## Example Usage - -```typescript -import { HandoffExecution } from "@mistralai/mistralai/models/components"; - -let value: HandoffExecution = "server"; -``` - -## Values - -```typescript -"client" | "server" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/hyperparameters.md b/examples/sdks/mistral-typescript/docs/models/components/hyperparameters.md deleted file mode 100644 index 2123905f3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/hyperparameters.md +++ /dev/null @@ -1,17 +0,0 @@ -# Hyperparameters - - -## Supported Types - -### `components.CompletionTrainingParametersIn` - -```typescript -const value: components.CompletionTrainingParametersIn = {}; -``` - -### `components.ClassifierTrainingParametersIn` - -```typescript -const value: components.ClassifierTrainingParametersIn = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtool.md b/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtool.md deleted file mode 100644 index 6de2bf20d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtool.md +++ /dev/null @@ -1,15 +0,0 @@ -# ImageGenerationTool - -## Example Usage - -```typescript -import { ImageGenerationTool } from "@mistralai/mistralai/models/components"; - -let value: ImageGenerationTool = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.ImageGenerationToolType](../../models/components/imagegenerationtooltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtooltype.md b/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtooltype.md deleted file mode 100644 index 4b606c031..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imagegenerationtooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ImageGenerationToolType - -## Example Usage - -```typescript -import { ImageGenerationToolType } from "@mistralai/mistralai/models/components"; - -let value: ImageGenerationToolType = "image_generation"; -``` - -## Values - -```typescript -"image_generation" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/imageurl.md b/examples/sdks/mistral-typescript/docs/models/components/imageurl.md deleted file mode 100644 index 199f9c548..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imageurl.md +++ /dev/null @@ -1,18 +0,0 @@ -# ImageURL - -## Example Usage - -```typescript -import { ImageURL } from "@mistralai/mistralai/models/components"; - -let value: ImageURL = { - url: "https://grim-farm.name/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | -| `detail` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunk.md b/examples/sdks/mistral-typescript/docs/models/components/imageurlchunk.md deleted file mode 100644 index 7778a5e3b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunk.md +++ /dev/null @@ -1,20 +0,0 @@ -# ImageURLChunk - -{"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - -## Example Usage - -```typescript -import { ImageURLChunk } from "@mistralai/mistralai/models/components"; - -let value: ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `imageUrl` | *components.ImageURLChunkImageURL* | :heavy_check_mark: | N/A | -| `type` | [components.ImageURLChunkType](../../models/components/imageurlchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunkimageurl.md b/examples/sdks/mistral-typescript/docs/models/components/imageurlchunkimageurl.md deleted file mode 100644 index 6b0520c0c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunkimageurl.md +++ /dev/null @@ -1,19 +0,0 @@ -# ImageURLChunkImageURL - - -## Supported Types - -### `components.ImageURL` - -```typescript -const value: components.ImageURL = { - url: "https://grim-farm.name/", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunktype.md b/examples/sdks/mistral-typescript/docs/models/components/imageurlchunktype.md deleted file mode 100644 index b6c74f006..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/imageurlchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ImageURLChunkType - -## Example Usage - -```typescript -import { ImageURLChunkType } from "@mistralai/mistralai/models/components"; - -let value: ImageURLChunkType = "image_url"; -``` - -## Values - -```typescript -"image_url" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/inputentries.md b/examples/sdks/mistral-typescript/docs/models/components/inputentries.md deleted file mode 100644 index 6a34a98b4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/inputentries.md +++ /dev/null @@ -1,65 +0,0 @@ -# InputEntries - - -## Supported Types - -### `components.MessageInputEntry` - -```typescript -const value: components.MessageInputEntry = { - role: "assistant", - content: [], -}; -``` - -### `components.MessageOutputEntry` - -```typescript -const value: components.MessageOutputEntry = { - content: "", -}; -``` - -### `components.FunctionResultEntry` - -```typescript -const value: components.FunctionResultEntry = { - toolCallId: "", - result: "", -}; -``` - -### `components.FunctionCallEntry` - -```typescript -const value: components.FunctionCallEntry = { - toolCallId: "", - name: "", - arguments: { - "key": "", - "key1": "", - "key2": "", - }, -}; -``` - -### `components.ToolExecutionEntry` - -```typescript -const value: components.ToolExecutionEntry = { - name: "web_search", - arguments: "", -}; -``` - -### `components.AgentHandoffEntry` - -```typescript -const value: components.AgentHandoffEntry = { - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/inputs.md b/examples/sdks/mistral-typescript/docs/models/components/inputs.md deleted file mode 100644 index bf4a200e0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/inputs.md +++ /dev/null @@ -1,21 +0,0 @@ -# Inputs - -Chat to classify - - -## Supported Types - -### `components.InstructRequestInputs` - -```typescript -const value: components.InstructRequestInputs = { - messages: [], -}; -``` - -### `components.InstructRequest[]` - -```typescript -const value: components.InstructRequest[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/instructrequest.md b/examples/sdks/mistral-typescript/docs/models/components/instructrequest.md deleted file mode 100644 index e2faea236..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/instructrequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# InstructRequest - -## Example Usage - -```typescript -import { InstructRequest } from "@mistralai/mistralai/models/components"; - -let value: InstructRequest = { - messages: [ - { - content: "", - role: "system", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `messages` | *components.InstructRequestMessages*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputs.md b/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputs.md deleted file mode 100644 index 3c169e56b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputs.md +++ /dev/null @@ -1,17 +0,0 @@ -# InstructRequestInputs - -## Example Usage - -```typescript -import { InstructRequestInputs } from "@mistralai/mistralai/models/components"; - -let value: InstructRequestInputs = { - messages: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `messages` | *components.InstructRequestInputsMessages*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputsmessages.md b/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputsmessages.md deleted file mode 100644 index ee93fcc71..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/instructrequestinputsmessages.md +++ /dev/null @@ -1,35 +0,0 @@ -# InstructRequestInputsMessages - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/instructrequestmessages.md b/examples/sdks/mistral-typescript/docs/models/components/instructrequestmessages.md deleted file mode 100644 index 200144fcb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/instructrequestmessages.md +++ /dev/null @@ -1,35 +0,0 @@ -# InstructRequestMessages - - -## Supported Types - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/integrations.md b/examples/sdks/mistral-typescript/docs/models/components/integrations.md deleted file mode 100644 index f06475382..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/integrations.md +++ /dev/null @@ -1,13 +0,0 @@ -# Integrations - - -## Supported Types - -### `components.WandbIntegrationOut` - -```typescript -const value: components.WandbIntegrationOut = { - project: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobin.md b/examples/sdks/mistral-typescript/docs/models/components/jobin.md deleted file mode 100644 index c60927270..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobin.md +++ /dev/null @@ -1,30 +0,0 @@ -# JobIn - -## Example Usage - -```typescript -import { JobIn } from "@mistralai/mistralai/models/components"; - -let value: JobIn = { - model: "Wrangler", - hyperparameters: { - learningRate: 0.0001, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | The name of the model to fine-tune. | -| `trainingFiles` | [components.TrainingFile](../../models/components/trainingfile.md)[] | :heavy_minus_sign: | N/A | -| `validationFiles` | *string*[] | :heavy_minus_sign: | A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. | -| `suffix` | *string* | :heavy_minus_sign: | A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` | -| `integrations` | *components.JobInIntegrations*[] | :heavy_minus_sign: | A list of integrations to enable for your fine-tuning job. | -| `autoStart` | *boolean* | :heavy_minus_sign: | This field will be required in a future release. | -| `invalidSampleSkipPercentage` | *number* | :heavy_minus_sign: | N/A | -| `jobType` | [components.FineTuneableModelType](../../models/components/finetuneablemodeltype.md) | :heavy_minus_sign: | N/A | -| `hyperparameters` | *components.Hyperparameters* | :heavy_check_mark: | N/A | -| `repositories` | *components.JobInRepositories*[] | :heavy_minus_sign: | N/A | -| `classifierTargets` | [components.ClassifierTargetIn](../../models/components/classifiertargetin.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobinintegrations.md b/examples/sdks/mistral-typescript/docs/models/components/jobinintegrations.md deleted file mode 100644 index d22508da9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobinintegrations.md +++ /dev/null @@ -1,14 +0,0 @@ -# JobInIntegrations - - -## Supported Types - -### `components.WandbIntegration` - -```typescript -const value: components.WandbIntegration = { - project: "", - apiKey: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobinrepositories.md b/examples/sdks/mistral-typescript/docs/models/components/jobinrepositories.md deleted file mode 100644 index 2599c53aa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobinrepositories.md +++ /dev/null @@ -1,15 +0,0 @@ -# JobInRepositories - - -## Supported Types - -### `components.GithubRepositoryIn` - -```typescript -const value: components.GithubRepositoryIn = { - name: "", - owner: "", - token: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobmetadataout.md b/examples/sdks/mistral-typescript/docs/models/components/jobmetadataout.md deleted file mode 100644 index 3222f5329..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobmetadataout.md +++ /dev/null @@ -1,21 +0,0 @@ -# JobMetadataOut - -## Example Usage - -```typescript -import { JobMetadataOut } from "@mistralai/mistralai/models/components"; - -let value: JobMetadataOut = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `expectedDurationSeconds` | *number* | :heavy_minus_sign: | N/A | -| `cost` | *number* | :heavy_minus_sign: | N/A | -| `costCurrency` | *string* | :heavy_minus_sign: | N/A | -| `trainTokensPerStep` | *number* | :heavy_minus_sign: | N/A | -| `trainTokens` | *number* | :heavy_minus_sign: | N/A | -| `dataTokens` | *number* | :heavy_minus_sign: | N/A | -| `estimatedStartTime` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobsout.md b/examples/sdks/mistral-typescript/docs/models/components/jobsout.md deleted file mode 100644 index df68d2449..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobsout.md +++ /dev/null @@ -1,19 +0,0 @@ -# JobsOut - -## Example Usage - -```typescript -import { JobsOut } from "@mistralai/mistralai/models/components"; - -let value: JobsOut = { - total: 919154, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | *components.JobsOutData*[] | :heavy_minus_sign: | N/A | -| `object` | [components.JobsOutObject](../../models/components/jobsoutobject.md) | :heavy_minus_sign: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobsoutdata.md b/examples/sdks/mistral-typescript/docs/models/components/jobsoutdata.md deleted file mode 100644 index a0a4fd6eb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobsoutdata.md +++ /dev/null @@ -1,41 +0,0 @@ -# JobsOutData - - -## Supported Types - -### `components.ClassifierJobOut` - -```typescript -const value: components.ClassifierJobOut = { - id: "94361cba-dbfe-4cb8-b157-dba88d484a3b", - autoStart: true, - model: "Mercielago", - status: "FAILED_VALIDATION", - createdAt: 604693, - modifiedAt: 540214, - trainingFiles: [ - "8db2006d-0f95-498b-8a1c-8b96bd790c50", - ], - hyperparameters: {}, -}; -``` - -### `components.CompletionJobOut` - -```typescript -const value: components.CompletionJobOut = { - id: "ad07d8f7-c8e8-41df-a05e-52088cd2b04b", - autoStart: false, - model: "Jetta", - status: "CANCELLED", - createdAt: 508554, - modifiedAt: 47551, - trainingFiles: [ - "0befa7d5-b534-4a53-8e8f-ae6a6f8e2d47", - "fc6abeaa-0a91-4111-9774-6e9c6a29d66a", - "f06b4756-0fe1-4e67-8ec2-5b8b8680fedc", - ], - hyperparameters: {}, -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobsoutobject.md b/examples/sdks/mistral-typescript/docs/models/components/jobsoutobject.md deleted file mode 100644 index ddc7e075f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobsoutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# JobsOutObject - -## Example Usage - -```typescript -import { JobsOutObject } from "@mistralai/mistralai/models/components"; - -let value: JobsOutObject = "list"; -``` - -## Values - -```typescript -"list" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/jobtype.md b/examples/sdks/mistral-typescript/docs/models/components/jobtype.md deleted file mode 100644 index 440247b1e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jobtype.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobType - -The type of job (`FT` for fine-tuning). - -## Example Usage - -```typescript -import { JobType } from "@mistralai/mistralai/models/components"; - -let value: JobType = "completion"; -``` - -## Values - -```typescript -"completion" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/jsonschema.md b/examples/sdks/mistral-typescript/docs/models/components/jsonschema.md deleted file mode 100644 index 55fb3902d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/jsonschema.md +++ /dev/null @@ -1,24 +0,0 @@ -# JsonSchema - -## Example Usage - -```typescript -import { JsonSchema } from "@mistralai/mistralai/models/components"; - -let value: JsonSchema = { - name: "", - schemaDefinition: { - "key": "", - "key1": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `schemaDefinition` | Record | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataout.md b/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataout.md deleted file mode 100644 index 83ae9cef7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataout.md +++ /dev/null @@ -1,36 +0,0 @@ -# LegacyJobMetadataOut - -## Example Usage - -```typescript -import { LegacyJobMetadataOut } from "@mistralai/mistralai/models/components"; - -let value: LegacyJobMetadataOut = { - expectedDurationSeconds: 220, - cost: 10, - costCurrency: "EUR", - trainTokensPerStep: 131072, - trainTokens: 1310720, - dataTokens: 305375, - details: "", - epochs: 4.2922, - trainingSteps: 10, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `expectedDurationSeconds` | *number* | :heavy_minus_sign: | The approximated time (in seconds) for the fine-tuning process to complete. | 220 | -| `cost` | *number* | :heavy_minus_sign: | The cost of the fine-tuning job. | 10 | -| `costCurrency` | *string* | :heavy_minus_sign: | The currency used for the fine-tuning job cost. | EUR | -| `trainTokensPerStep` | *number* | :heavy_minus_sign: | The number of tokens consumed by one training step. | 131072 | -| `trainTokens` | *number* | :heavy_minus_sign: | The total number of tokens used during the fine-tuning process. | 1310720 | -| `dataTokens` | *number* | :heavy_minus_sign: | The total number of tokens in the training dataset. | 305375 | -| `estimatedStartTime` | *number* | :heavy_minus_sign: | N/A | | -| `deprecated` | *boolean* | :heavy_minus_sign: | N/A | | -| `details` | *string* | :heavy_check_mark: | N/A | | -| `epochs` | *number* | :heavy_minus_sign: | The number of complete passes through the entire training dataset. | 4.2922 | -| `trainingSteps` | *number* | :heavy_minus_sign: | The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. | 10 | -| `object` | [components.LegacyJobMetadataOutObject](../../models/components/legacyjobmetadataoutobject.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataoutobject.md b/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataoutobject.md deleted file mode 100644 index be3b9373b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/legacyjobmetadataoutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# LegacyJobMetadataOutObject - -## Example Usage - -```typescript -import { LegacyJobMetadataOutObject } from "@mistralai/mistralai/models/components"; - -let value: LegacyJobMetadataOutObject = "job.metadata"; -``` - -## Values - -```typescript -"job.metadata" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/libraryin.md b/examples/sdks/mistral-typescript/docs/models/components/libraryin.md deleted file mode 100644 index d2e15af88..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/libraryin.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibraryIn - -## Example Usage - -```typescript -import { LibraryIn } from "@mistralai/mistralai/models/components"; - -let value: LibraryIn = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `chunkSize` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/libraryinupdate.md b/examples/sdks/mistral-typescript/docs/models/components/libraryinupdate.md deleted file mode 100644 index 07208f90e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/libraryinupdate.md +++ /dev/null @@ -1,16 +0,0 @@ -# LibraryInUpdate - -## Example Usage - -```typescript -import { LibraryInUpdate } from "@mistralai/mistralai/models/components"; - -let value: LibraryInUpdate = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/libraryout.md b/examples/sdks/mistral-typescript/docs/models/components/libraryout.md deleted file mode 100644 index 13b18d231..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/libraryout.md +++ /dev/null @@ -1,40 +0,0 @@ -# LibraryOut - -## Example Usage - -```typescript -import { LibraryOut } from "@mistralai/mistralai/models/components"; - -let value: LibraryOut = { - id: "febcb426-e820-4f83-afe7-9e6c830557ac", - name: "", - createdAt: new Date("2025-05-24T20:35:31.746Z"), - updatedAt: new Date("2023-05-31T16:25:42.207Z"), - ownerId: "4b968264-87b9-4f01-b2e4-16eab2c650a9", - ownerType: "", - totalSize: 562979, - nbDocuments: 360239, - chunkSize: 310648, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `ownerId` | *string* | :heavy_check_mark: | N/A | -| `ownerType` | *string* | :heavy_check_mark: | N/A | -| `totalSize` | *number* | :heavy_check_mark: | N/A | -| `nbDocuments` | *number* | :heavy_check_mark: | N/A | -| `chunkSize` | *number* | :heavy_check_mark: | N/A | -| `emoji` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `generatedName` | *string* | :heavy_minus_sign: | N/A | -| `generatedDescription` | *string* | :heavy_minus_sign: | N/A | -| `explicitUserMembersCount` | *number* | :heavy_minus_sign: | N/A | -| `explicitWorkspaceMembersCount` | *number* | :heavy_minus_sign: | N/A | -| `orgSharingRole` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/listdocumentout.md b/examples/sdks/mistral-typescript/docs/models/components/listdocumentout.md deleted file mode 100644 index 59c25da93..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/listdocumentout.md +++ /dev/null @@ -1,40 +0,0 @@ -# ListDocumentOut - -## Example Usage - -```typescript -import { ListDocumentOut } from "@mistralai/mistralai/models/components"; - -let value: ListDocumentOut = { - pagination: { - totalItems: 380132, - totalPages: 913256, - currentPage: 408894, - pageSize: 811833, - hasMore: true, - }, - data: [ - { - id: "6c934a1f-b0c4-4285-8979-81eaacc68f1f", - libraryId: "35352f20-efcb-46ad-b6d2-15eb6e494b7c", - hash: "", - mimeType: "", - extension: "mp4", - size: 710884, - name: "", - createdAt: new Date("2025-08-13T21:39:06.524Z"), - processingStatus: "", - uploadedById: "e74d2380-e4c5-4041-911a-7d63c508462a", - uploadedByType: "", - tokensProcessingTotal: 312938, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `pagination` | [components.PaginationInfo](../../models/components/paginationinfo.md) | :heavy_check_mark: | N/A | -| `data` | [components.DocumentOut](../../models/components/documentout.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/listfilesout.md b/examples/sdks/mistral-typescript/docs/models/components/listfilesout.md deleted file mode 100644 index 96d011fc2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/listfilesout.md +++ /dev/null @@ -1,32 +0,0 @@ -# ListFilesOut - -## Example Usage - -```typescript -import { ListFilesOut } from "@mistralai/mistralai/models/components"; - -let value: ListFilesOut = { - data: [ - { - id: "497f6eca-6276-4993-bfeb-53cbbbba6f09", - object: "file", - sizeBytes: 13000, - createdAt: 1716963433, - filename: "files_upload.jsonl", - purpose: "ocr", - sampleType: "batch_error", - source: "repository", - }, - ], - object: "", - total: 220942, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | [components.FileSchema](../../models/components/fileschema.md)[] | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/listlibraryout.md b/examples/sdks/mistral-typescript/docs/models/components/listlibraryout.md deleted file mode 100644 index dae469008..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/listlibraryout.md +++ /dev/null @@ -1,29 +0,0 @@ -# ListLibraryOut - -## Example Usage - -```typescript -import { ListLibraryOut } from "@mistralai/mistralai/models/components"; - -let value: ListLibraryOut = { - data: [ - { - id: "22dccd56-b81f-4bed-b1e1-e58e1be5f8ad", - name: "", - createdAt: new Date("2024-09-24T02:11:48.876Z"), - updatedAt: new Date("2023-05-26T21:02:03.177Z"), - ownerId: "501f55c8-818b-4455-af1c-cb4326795686", - ownerType: "", - totalSize: 511025, - nbDocuments: 199415, - chunkSize: 843252, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | [components.LibraryOut](../../models/components/libraryout.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/listsharingout.md b/examples/sdks/mistral-typescript/docs/models/components/listsharingout.md deleted file mode 100644 index 2d182760b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/listsharingout.md +++ /dev/null @@ -1,17 +0,0 @@ -# ListSharingOut - -## Example Usage - -```typescript -import { ListSharingOut } from "@mistralai/mistralai/models/components"; - -let value: ListSharingOut = { - data: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | [components.SharingOut](../../models/components/sharingout.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/loc.md b/examples/sdks/mistral-typescript/docs/models/components/loc.md deleted file mode 100644 index 74021dec4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/loc.md +++ /dev/null @@ -1,17 +0,0 @@ -# Loc - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `number` - -```typescript -const value: number = 128403; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageentries.md b/examples/sdks/mistral-typescript/docs/models/components/messageentries.md deleted file mode 100644 index ba6375126..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageentries.md +++ /dev/null @@ -1,22 +0,0 @@ -# MessageEntries - - -## Supported Types - -### `components.MessageInputEntry` - -```typescript -const value: components.MessageInputEntry = { - role: "assistant", - content: [], -}; -``` - -### `components.MessageOutputEntry` - -```typescript -const value: components.MessageOutputEntry = { - content: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageinputcontentchunks.md b/examples/sdks/mistral-typescript/docs/models/components/messageinputcontentchunks.md deleted file mode 100644 index c8be4ed5c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageinputcontentchunks.md +++ /dev/null @@ -1,46 +0,0 @@ -# MessageInputContentChunks - - -## Supported Types - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - -### `components.ToolFileChunk` - -```typescript -const value: components.ToolFileChunk = { - tool: "image_generation", - fileId: "", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -### `components.ThinkChunk` - -```typescript -const value: components.ThinkChunk = { - thinking: [], -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageinputentry.md b/examples/sdks/mistral-typescript/docs/models/components/messageinputentry.md deleted file mode 100644 index e87900937..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageinputentry.md +++ /dev/null @@ -1,27 +0,0 @@ -# MessageInputEntry - -Representation of an input message inside the conversation. - -## Example Usage - -```typescript -import { MessageInputEntry } from "@mistralai/mistralai/models/components"; - -let value: MessageInputEntry = { - role: "assistant", - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.ObjectT](../../models/components/objectt.md) | :heavy_minus_sign: | N/A | -| `type` | [components.MessageInputEntryType](../../models/components/messageinputentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.MessageInputEntryRole](../../models/components/messageinputentryrole.md) | :heavy_check_mark: | N/A | -| `content` | *components.MessageInputEntryContent* | :heavy_check_mark: | N/A | -| `prefix` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageinputentrycontent.md b/examples/sdks/mistral-typescript/docs/models/components/messageinputentrycontent.md deleted file mode 100644 index edd23c2f9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageinputentrycontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# MessageInputEntryContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.MessageInputContentChunks[]` - -```typescript -const value: components.MessageInputContentChunks[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageinputentryrole.md b/examples/sdks/mistral-typescript/docs/models/components/messageinputentryrole.md deleted file mode 100644 index f4f7f36ab..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageinputentryrole.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageInputEntryRole - -## Example Usage - -```typescript -import { MessageInputEntryRole } from "@mistralai/mistralai/models/components"; - -let value: MessageInputEntryRole = "assistant"; -``` - -## Values - -```typescript -"assistant" | "user" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageinputentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/messageinputentrytype.md deleted file mode 100644 index 1d42fddd9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageinputentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageInputEntryType - -## Example Usage - -```typescript -import { MessageInputEntryType } from "@mistralai/mistralai/models/components"; - -let value: MessageInputEntryType = "message.input"; -``` - -## Values - -```typescript -"message.input" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputcontentchunks.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputcontentchunks.md deleted file mode 100644 index 12f99b627..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputcontentchunks.md +++ /dev/null @@ -1,55 +0,0 @@ -# MessageOutputContentChunks - - -## Supported Types - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - -### `components.ToolFileChunk` - -```typescript -const value: components.ToolFileChunk = { - tool: "image_generation", - fileId: "", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -### `components.ThinkChunk` - -```typescript -const value: components.ThinkChunk = { - thinking: [], -}; -``` - -### `components.ToolReferenceChunk` - -```typescript -const value: components.ToolReferenceChunk = { - tool: "image_generation", - title: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentry.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputentry.md deleted file mode 100644 index 06a46b7da..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentry.md +++ /dev/null @@ -1,25 +0,0 @@ -# MessageOutputEntry - -## Example Usage - -```typescript -import { MessageOutputEntry } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEntry = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.MessageOutputEntryObject](../../models/components/messageoutputentryobject.md) | :heavy_minus_sign: | N/A | -| `type` | [components.MessageOutputEntryType](../../models/components/messageoutputentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.MessageOutputEntryRole](../../models/components/messageoutputentryrole.md) | :heavy_minus_sign: | N/A | -| `content` | *components.MessageOutputEntryContent* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrycontent.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrycontent.md deleted file mode 100644 index 72dd4510e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrycontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# MessageOutputEntryContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.MessageOutputContentChunks[]` - -```typescript -const value: components.MessageOutputContentChunks[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryobject.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryobject.md deleted file mode 100644 index 107cd9633..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageOutputEntryObject - -## Example Usage - -```typescript -import { MessageOutputEntryObject } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEntryObject = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryrole.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryrole.md deleted file mode 100644 index 2248a0c8c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentryrole.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageOutputEntryRole - -## Example Usage - -```typescript -import { MessageOutputEntryRole } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEntryRole = "assistant"; -``` - -## Values - -```typescript -"assistant" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrytype.md deleted file mode 100644 index 16c4bddac..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageOutputEntryType - -## Example Usage - -```typescript -import { MessageOutputEntryType } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEntryType = "message.output"; -``` - -## Values - -```typescript -"message.output" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputevent.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputevent.md deleted file mode 100644 index 5f3bf9b3f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputevent.md +++ /dev/null @@ -1,29 +0,0 @@ -# MessageOutputEvent - -## Example Usage - -```typescript -import { MessageOutputEvent } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEvent = { - id: "", - content: { - thinking: [], - type: "thinking", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.MessageOutputEventType](../../models/components/messageoutputeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.MessageOutputEventRole](../../models/components/messageoutputeventrole.md) | :heavy_minus_sign: | N/A | -| `content` | *components.MessageOutputEventContent* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventcontent.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventcontent.md deleted file mode 100644 index 285698710..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventcontent.md +++ /dev/null @@ -1,20 +0,0 @@ -# MessageOutputEventContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.OutputContentChunks` - -```typescript -const value: components.OutputContentChunks = { - documentUrl: "https://super-tool.biz", - type: "document_url", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventrole.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventrole.md deleted file mode 100644 index 88b791da5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventrole.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageOutputEventRole - -## Example Usage - -```typescript -import { MessageOutputEventRole } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEventRole = "assistant"; -``` - -## Values - -```typescript -"assistant" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventtype.md deleted file mode 100644 index e40c0e9e5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messageoutputeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# MessageOutputEventType - -## Example Usage - -```typescript -import { MessageOutputEventType } from "@mistralai/mistralai/models/components"; - -let value: MessageOutputEventType = "message.output.delta"; -``` - -## Values - -```typescript -"message.output.delta" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/messages.md b/examples/sdks/mistral-typescript/docs/models/components/messages.md deleted file mode 100644 index 9d69632ea..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/messages.md +++ /dev/null @@ -1,35 +0,0 @@ -# Messages - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/metricout.md b/examples/sdks/mistral-typescript/docs/models/components/metricout.md deleted file mode 100644 index 243e6fc57..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/metricout.md +++ /dev/null @@ -1,19 +0,0 @@ -# MetricOut - -Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - -## Example Usage - -```typescript -import { MetricOut } from "@mistralai/mistralai/models/components"; - -let value: MetricOut = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `trainLoss` | *number* | :heavy_minus_sign: | N/A | -| `validLoss` | *number* | :heavy_minus_sign: | N/A | -| `validMeanTokenAccuracy` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/mistralpromptmode.md b/examples/sdks/mistral-typescript/docs/models/components/mistralpromptmode.md deleted file mode 100644 index 413286d88..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/mistralpromptmode.md +++ /dev/null @@ -1,17 +0,0 @@ -# MistralPromptMode - -## Example Usage - -```typescript -import { MistralPromptMode } from "@mistralai/mistralai/models/components"; - -let value: MistralPromptMode = "reasoning"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"reasoning" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/modelcapabilities.md b/examples/sdks/mistral-typescript/docs/models/components/modelcapabilities.md deleted file mode 100644 index e5c825181..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modelcapabilities.md +++ /dev/null @@ -1,20 +0,0 @@ -# ModelCapabilities - -## Example Usage - -```typescript -import { ModelCapabilities } from "@mistralai/mistralai/models/components"; - -let value: ModelCapabilities = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `completionChat` | *boolean* | :heavy_minus_sign: | N/A | -| `completionFim` | *boolean* | :heavy_minus_sign: | N/A | -| `functionCalling` | *boolean* | :heavy_minus_sign: | N/A | -| `fineTuning` | *boolean* | :heavy_minus_sign: | N/A | -| `vision` | *boolean* | :heavy_minus_sign: | N/A | -| `classification` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/modelconversation.md b/examples/sdks/mistral-typescript/docs/models/components/modelconversation.md deleted file mode 100644 index f965b0a63..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modelconversation.md +++ /dev/null @@ -1,29 +0,0 @@ -# ModelConversation - -## Example Usage - -```typescript -import { ModelConversation } from "@mistralai/mistralai/models/components"; - -let value: ModelConversation = { - id: "", - createdAt: new Date("2024-06-14T04:21:29.555Z"), - updatedAt: new Date("2025-10-08T03:17:09.039Z"), - model: "Escalade", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `instructions` | *string* | :heavy_minus_sign: | Instruction prompt the model will follow during the conversation. | -| `tools` | *components.ModelConversationTools*[] | :heavy_minus_sign: | List of tools which are available to the model during the conversation. | -| `completionArgs` | [components.CompletionArgs](../../models/components/completionargs.md) | :heavy_minus_sign: | White-listed arguments from the completion API | -| `name` | *string* | :heavy_minus_sign: | Name given to the conversation. | -| `description` | *string* | :heavy_minus_sign: | Description of the what the conversation is about. | -| `object` | [components.ModelConversationObject](../../models/components/modelconversationobject.md) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/modelconversationobject.md b/examples/sdks/mistral-typescript/docs/models/components/modelconversationobject.md deleted file mode 100644 index 2c9ae8e7c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modelconversationobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ModelConversationObject - -## Example Usage - -```typescript -import { ModelConversationObject } from "@mistralai/mistralai/models/components"; - -let value: ModelConversationObject = "conversation"; -``` - -## Values - -```typescript -"conversation" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/modelconversationtools.md b/examples/sdks/mistral-typescript/docs/models/components/modelconversationtools.md deleted file mode 100644 index b128b49a1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modelconversationtools.md +++ /dev/null @@ -1,54 +0,0 @@ -# ModelConversationTools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/modellist.md b/examples/sdks/mistral-typescript/docs/models/components/modellist.md deleted file mode 100644 index 65ce9bf9a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modellist.md +++ /dev/null @@ -1,16 +0,0 @@ -# ModelList - -## Example Usage - -```typescript -import { ModelList } from "@mistralai/mistralai/models/components"; - -let value: ModelList = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `data` | *components.Data*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/modeltype.md b/examples/sdks/mistral-typescript/docs/models/components/modeltype.md deleted file mode 100644 index 77c7327c8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/modeltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ModelType - -## Example Usage - -```typescript -import { ModelType } from "@mistralai/mistralai/models/components"; - -let value: ModelType = "completion"; -``` - -## Values - -```typescript -"completion" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/moderationobject.md b/examples/sdks/mistral-typescript/docs/models/components/moderationobject.md deleted file mode 100644 index 9598f0918..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/moderationobject.md +++ /dev/null @@ -1,16 +0,0 @@ -# ModerationObject - -## Example Usage - -```typescript -import { ModerationObject } from "@mistralai/mistralai/models/components"; - -let value: ModerationObject = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `categories` | Record | :heavy_minus_sign: | Moderation result thresholds | -| `categoryScores` | Record | :heavy_minus_sign: | Moderation result | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/moderationresponse.md b/examples/sdks/mistral-typescript/docs/models/components/moderationresponse.md deleted file mode 100644 index a223ac0e4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/moderationresponse.md +++ /dev/null @@ -1,21 +0,0 @@ -# ModerationResponse - -## Example Usage - -```typescript -import { ModerationResponse } from "@mistralai/mistralai/models/components"; - -let value: ModerationResponse = { - id: "mod-e5cc70bb28c444948073e77776eb30ef", - model: "Aventador", - results: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | mod-e5cc70bb28c444948073e77776eb30ef | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `results` | [components.ModerationObject](../../models/components/moderationobject.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/objectt.md b/examples/sdks/mistral-typescript/docs/models/components/objectt.md deleted file mode 100644 index 658af2f44..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/objectt.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectT - -## Example Usage - -```typescript -import { ObjectT } from "@mistralai/mistralai/models/components"; - -let value: ObjectT = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrimageobject.md b/examples/sdks/mistral-typescript/docs/models/components/ocrimageobject.md deleted file mode 100644 index 41e989718..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrimageobject.md +++ /dev/null @@ -1,27 +0,0 @@ -# OCRImageObject - -## Example Usage - -```typescript -import { OCRImageObject } from "@mistralai/mistralai/models/components"; - -let value: OCRImageObject = { - id: "", - topLeftX: 147638, - topLeftY: null, - bottomRightX: 907287, - bottomRightY: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Image ID for extracted image in a page | -| `topLeftX` | *number* | :heavy_check_mark: | X coordinate of top-left corner of the extracted image | -| `topLeftY` | *number* | :heavy_check_mark: | Y coordinate of top-left corner of the extracted image | -| `bottomRightX` | *number* | :heavy_check_mark: | X coordinate of bottom-right corner of the extracted image | -| `bottomRightY` | *number* | :heavy_check_mark: | Y coordinate of bottom-right corner of the extracted image | -| `imageBase64` | *string* | :heavy_minus_sign: | Base64 string of the extracted image | -| `imageAnnotation` | *string* | :heavy_minus_sign: | Annotation of the extracted image in json str | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrpagedimensions.md b/examples/sdks/mistral-typescript/docs/models/components/ocrpagedimensions.md deleted file mode 100644 index 5b7edd6b3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrpagedimensions.md +++ /dev/null @@ -1,21 +0,0 @@ -# OCRPageDimensions - -## Example Usage - -```typescript -import { OCRPageDimensions } from "@mistralai/mistralai/models/components"; - -let value: OCRPageDimensions = { - dpi: 613038, - height: 235980, - width: 539169, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `dpi` | *number* | :heavy_check_mark: | Dots per inch of the page-image | -| `height` | *number* | :heavy_check_mark: | Height of the image in pixels | -| `width` | *number* | :heavy_check_mark: | Width of the image in pixels | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrpageobject.md b/examples/sdks/mistral-typescript/docs/models/components/ocrpageobject.md deleted file mode 100644 index 7c83694e4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrpageobject.md +++ /dev/null @@ -1,27 +0,0 @@ -# OCRPageObject - -## Example Usage - -```typescript -import { OCRPageObject } from "@mistralai/mistralai/models/components"; - -let value: OCRPageObject = { - index: 355599, - markdown: "", - images: [], - dimensions: { - dpi: 225573, - height: 229870, - width: 469391, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `index` | *number* | :heavy_check_mark: | The page index in a pdf document starting from 0 | -| `markdown` | *string* | :heavy_check_mark: | The markdown string response of the page | -| `images` | [components.OCRImageObject](../../models/components/ocrimageobject.md)[] | :heavy_check_mark: | List of all extracted images in the page | -| `dimensions` | [components.OCRPageDimensions](../../models/components/ocrpagedimensions.md) | :heavy_check_mark: | The dimensions of the PDF Page's screenshot image | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrrequest.md b/examples/sdks/mistral-typescript/docs/models/components/ocrrequest.md deleted file mode 100644 index c20676790..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrrequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# OCRRequest - -## Example Usage - -```typescript -import { OCRRequest } from "@mistralai/mistralai/models/components"; - -let value: OCRRequest = { - model: "Aventador", - document: { - fileId: "ea6400b9-bfdc-4769-82dc-df5d318855aa", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `document` | *components.Document* | :heavy_check_mark: | Document to run OCR on | -| `pages` | *number*[] | :heavy_minus_sign: | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 | -| `includeImageBase64` | *boolean* | :heavy_minus_sign: | Include image URLs in response | -| `imageLimit` | *number* | :heavy_minus_sign: | Max images to extract | -| `imageMinSize` | *number* | :heavy_minus_sign: | Minimum height and width of image to extract | -| `bboxAnnotationFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field | -| `documentAnnotationFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrresponse.md b/examples/sdks/mistral-typescript/docs/models/components/ocrresponse.md deleted file mode 100644 index 36b9c9d23..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrresponse.md +++ /dev/null @@ -1,24 +0,0 @@ -# OCRResponse - -## Example Usage - -```typescript -import { OCRResponse } from "@mistralai/mistralai/models/components"; - -let value: OCRResponse = { - pages: [], - model: "Mustang", - usageInfo: { - pagesProcessed: 819030, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `pages` | [components.OCRPageObject](../../models/components/ocrpageobject.md)[] | :heavy_check_mark: | List of OCR info for pages. | -| `model` | *string* | :heavy_check_mark: | The model used to generate the OCR. | -| `documentAnnotation` | *string* | :heavy_minus_sign: | Formatted response in the request_format if provided in json str | -| `usageInfo` | [components.OCRUsageInfo](../../models/components/ocrusageinfo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ocrusageinfo.md b/examples/sdks/mistral-typescript/docs/models/components/ocrusageinfo.md deleted file mode 100644 index 80d50271a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ocrusageinfo.md +++ /dev/null @@ -1,18 +0,0 @@ -# OCRUsageInfo - -## Example Usage - -```typescript -import { OCRUsageInfo } from "@mistralai/mistralai/models/components"; - -let value: OCRUsageInfo = { - pagesProcessed: 329301, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `pagesProcessed` | *number* | :heavy_check_mark: | Number of pages processed | -| `docSizeBytes` | *number* | :heavy_minus_sign: | Document size in bytes | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/one.md b/examples/sdks/mistral-typescript/docs/models/components/one.md deleted file mode 100644 index b1d29b881..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/one.md +++ /dev/null @@ -1,35 +0,0 @@ -# One - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/outputcontentchunks.md b/examples/sdks/mistral-typescript/docs/models/components/outputcontentchunks.md deleted file mode 100644 index a0f1dd1de..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/outputcontentchunks.md +++ /dev/null @@ -1,55 +0,0 @@ -# OutputContentChunks - - -## Supported Types - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://darling-distinction.org", -}; -``` - -### `components.ToolFileChunk` - -```typescript -const value: components.ToolFileChunk = { - tool: "image_generation", - fileId: "", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://other-reach.net", -}; -``` - -### `components.ThinkChunk` - -```typescript -const value: components.ThinkChunk = { - thinking: [], -}; -``` - -### `components.ToolReferenceChunk` - -```typescript -const value: components.ToolReferenceChunk = { - tool: "image_generation", - title: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/outputs.md b/examples/sdks/mistral-typescript/docs/models/components/outputs.md deleted file mode 100644 index 7fedd74c1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/outputs.md +++ /dev/null @@ -1,47 +0,0 @@ -# Outputs - - -## Supported Types - -### `components.MessageOutputEntry` - -```typescript -const value: components.MessageOutputEntry = { - content: "", -}; -``` - -### `components.ToolExecutionEntry` - -```typescript -const value: components.ToolExecutionEntry = { - name: "web_search", - arguments: "", -}; -``` - -### `components.FunctionCallEntry` - -```typescript -const value: components.FunctionCallEntry = { - toolCallId: "", - name: "", - arguments: { - "key": "", - "key1": "", - "key2": "", - }, -}; -``` - -### `components.AgentHandoffEntry` - -```typescript -const value: components.AgentHandoffEntry = { - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/paginationinfo.md b/examples/sdks/mistral-typescript/docs/models/components/paginationinfo.md deleted file mode 100644 index 55c7b2937..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/paginationinfo.md +++ /dev/null @@ -1,25 +0,0 @@ -# PaginationInfo - -## Example Usage - -```typescript -import { PaginationInfo } from "@mistralai/mistralai/models/components"; - -let value: PaginationInfo = { - totalItems: 593004, - totalPages: 910490, - currentPage: 867739, - pageSize: 184463, - hasMore: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `totalItems` | *number* | :heavy_check_mark: | N/A | -| `totalPages` | *number* | :heavy_check_mark: | N/A | -| `currentPage` | *number* | :heavy_check_mark: | N/A | -| `pageSize` | *number* | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/prediction.md b/examples/sdks/mistral-typescript/docs/models/components/prediction.md deleted file mode 100644 index d2894144a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/prediction.md +++ /dev/null @@ -1,16 +0,0 @@ -# Prediction - -## Example Usage - -```typescript -import { Prediction } from "@mistralai/mistralai/models/components"; - -let value: Prediction = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `content` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/processingstatusout.md b/examples/sdks/mistral-typescript/docs/models/components/processingstatusout.md deleted file mode 100644 index 7df7d4398..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/processingstatusout.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProcessingStatusOut - -## Example Usage - -```typescript -import { ProcessingStatusOut } from "@mistralai/mistralai/models/components"; - -let value: ProcessingStatusOut = { - documentId: "085a09b6-80a9-4e24-aed9-b814a9dd2ab4", - processingStatus: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `documentId` | *string* | :heavy_check_mark: | N/A | -| `processingStatus` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/referencechunk.md b/examples/sdks/mistral-typescript/docs/models/components/referencechunk.md deleted file mode 100644 index 04a14c57f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/referencechunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReferenceChunk - -## Example Usage - -```typescript -import { ReferenceChunk } from "@mistralai/mistralai/models/components"; - -let value: ReferenceChunk = { - referenceIds: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `referenceIds` | *number*[] | :heavy_check_mark: | N/A | -| `type` | [components.ReferenceChunkType](../../models/components/referencechunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/referencechunktype.md b/examples/sdks/mistral-typescript/docs/models/components/referencechunktype.md deleted file mode 100644 index 76bb0ac34..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/referencechunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ReferenceChunkType - -## Example Usage - -```typescript -import { ReferenceChunkType } from "@mistralai/mistralai/models/components"; - -let value: ReferenceChunkType = "reference"; -``` - -## Values - -```typescript -"reference" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/repositories.md b/examples/sdks/mistral-typescript/docs/models/components/repositories.md deleted file mode 100644 index 0da942433..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/repositories.md +++ /dev/null @@ -1,15 +0,0 @@ -# Repositories - - -## Supported Types - -### `components.GithubRepositoryOut` - -```typescript -const value: components.GithubRepositoryOut = { - name: "", - owner: "", - commitId: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/responsedoneevent.md b/examples/sdks/mistral-typescript/docs/models/components/responsedoneevent.md deleted file mode 100644 index d4dc5db2e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responsedoneevent.md +++ /dev/null @@ -1,19 +0,0 @@ -# ResponseDoneEvent - -## Example Usage - -```typescript -import { ResponseDoneEvent } from "@mistralai/mistralai/models/components"; - -let value: ResponseDoneEvent = { - usage: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseDoneEventType](../../models/components/responsedoneeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `usage` | [components.ConversationUsageInfo](../../models/components/conversationusageinfo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responsedoneeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/responsedoneeventtype.md deleted file mode 100644 index 64ef258a9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responsedoneeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResponseDoneEventType - -## Example Usage - -```typescript -import { ResponseDoneEventType } from "@mistralai/mistralai/models/components"; - -let value: ResponseDoneEventType = "conversation.response.done"; -``` - -## Values - -```typescript -"conversation.response.done" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responseerrorevent.md b/examples/sdks/mistral-typescript/docs/models/components/responseerrorevent.md deleted file mode 100644 index d96da769d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responseerrorevent.md +++ /dev/null @@ -1,21 +0,0 @@ -# ResponseErrorEvent - -## Example Usage - -```typescript -import { ResponseErrorEvent } from "@mistralai/mistralai/models/components"; - -let value: ResponseErrorEvent = { - message: "", - code: 451589, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseErrorEventType](../../models/components/responseerroreventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `code` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responseerroreventtype.md b/examples/sdks/mistral-typescript/docs/models/components/responseerroreventtype.md deleted file mode 100644 index 2c36331fa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responseerroreventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResponseErrorEventType - -## Example Usage - -```typescript -import { ResponseErrorEventType } from "@mistralai/mistralai/models/components"; - -let value: ResponseErrorEventType = "conversation.response.error"; -``` - -## Values - -```typescript -"conversation.response.error" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responseformat.md b/examples/sdks/mistral-typescript/docs/models/components/responseformat.md deleted file mode 100644 index 08f82bf3a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responseformat.md +++ /dev/null @@ -1,16 +0,0 @@ -# ResponseFormat - -## Example Usage - -```typescript -import { ResponseFormat } from "@mistralai/mistralai/models/components"; - -let value: ResponseFormat = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseFormats](../../models/components/responseformats.md) | :heavy_minus_sign: | An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. | -| `jsonSchema` | [components.JsonSchema](../../models/components/jsonschema.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responseformats.md b/examples/sdks/mistral-typescript/docs/models/components/responseformats.md deleted file mode 100644 index 9133b66ea..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responseformats.md +++ /dev/null @@ -1,17 +0,0 @@ -# ResponseFormats - -An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - -## Example Usage - -```typescript -import { ResponseFormats } from "@mistralai/mistralai/models/components"; - -let value: ResponseFormats = "json_object"; -``` - -## Values - -```typescript -"text" | "json_object" | "json_schema" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responsestartedevent.md b/examples/sdks/mistral-typescript/docs/models/components/responsestartedevent.md deleted file mode 100644 index 4d37cd196..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responsestartedevent.md +++ /dev/null @@ -1,19 +0,0 @@ -# ResponseStartedEvent - -## Example Usage - -```typescript -import { ResponseStartedEvent } from "@mistralai/mistralai/models/components"; - -let value: ResponseStartedEvent = { - conversationId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseStartedEventType](../../models/components/responsestartedeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `conversationId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/responsestartedeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/responsestartedeventtype.md deleted file mode 100644 index ad55ee0f9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/responsestartedeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ResponseStartedEventType - -## Example Usage - -```typescript -import { ResponseStartedEventType } from "@mistralai/mistralai/models/components"; - -let value: ResponseStartedEventType = "conversation.response.started"; -``` - -## Values - -```typescript -"conversation.response.started" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/retrievefileout.md b/examples/sdks/mistral-typescript/docs/models/components/retrievefileout.md deleted file mode 100644 index b9b752190..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/retrievefileout.md +++ /dev/null @@ -1,36 +0,0 @@ -# RetrieveFileOut - -## Example Usage - -```typescript -import { RetrieveFileOut } from "@mistralai/mistralai/models/components"; - -let value: RetrieveFileOut = { - id: "497f6eca-6276-4993-bfeb-53cbbbba6f09", - object: "file", - sizeBytes: 13000, - createdAt: 1716963433, - filename: "files_upload.jsonl", - purpose: "ocr", - sampleType: "pretrain", - source: "mistral", - deleted: false, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the file. | 497f6eca-6276-4993-bfeb-53cbbbba6f09 | -| `object` | *string* | :heavy_check_mark: | The object type, which is always "file". | file | -| `sizeBytes` | *number* | :heavy_check_mark: | The size of the file, in bytes. | 13000 | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) of the event. | 1716963433 | -| `filename` | *string* | :heavy_check_mark: | The name of the uploaded file. | files_upload.jsonl | -| `purpose` | [components.FilePurpose](../../models/components/filepurpose.md) | :heavy_check_mark: | N/A | | -| `sampleType` | [components.SampleType](../../models/components/sampletype.md) | :heavy_check_mark: | N/A | | -| `numLines` | *number* | :heavy_minus_sign: | N/A | | -| `mimetype` | *string* | :heavy_minus_sign: | N/A | | -| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | N/A | | -| `deleted` | *boolean* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/role.md b/examples/sdks/mistral-typescript/docs/models/components/role.md deleted file mode 100644 index 4682b6421..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/role.md +++ /dev/null @@ -1,15 +0,0 @@ -# Role - -## Example Usage - -```typescript -import { Role } from "@mistralai/mistralai/models/components"; - -let value: Role = "system"; -``` - -## Values - -```typescript -"system" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/sampletype.md b/examples/sdks/mistral-typescript/docs/models/components/sampletype.md deleted file mode 100644 index bc77f8450..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/sampletype.md +++ /dev/null @@ -1,17 +0,0 @@ -# SampleType - -## Example Usage - -```typescript -import { SampleType } from "@mistralai/mistralai/models/components"; - -let value: SampleType = "batch_request"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"pretrain" | "instruct" | "batch_request" | "batch_result" | "batch_error" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/security.md b/examples/sdks/mistral-typescript/docs/models/components/security.md deleted file mode 100644 index 19ed4e223..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/security.md +++ /dev/null @@ -1,15 +0,0 @@ -# Security - -## Example Usage - -```typescript -import { Security } from "@mistralai/mistralai/models/components"; - -let value: Security = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/shareenum.md b/examples/sdks/mistral-typescript/docs/models/components/shareenum.md deleted file mode 100644 index 0fe7e933c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/shareenum.md +++ /dev/null @@ -1,17 +0,0 @@ -# ShareEnum - -## Example Usage - -```typescript -import { ShareEnum } from "@mistralai/mistralai/models/components"; - -let value: ShareEnum = "Viewer"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"Viewer" | "Editor" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/sharingdelete.md b/examples/sdks/mistral-typescript/docs/models/components/sharingdelete.md deleted file mode 100644 index 18921a4f8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/sharingdelete.md +++ /dev/null @@ -1,21 +0,0 @@ -# SharingDelete - -## Example Usage - -```typescript -import { SharingDelete } from "@mistralai/mistralai/models/components"; - -let value: SharingDelete = { - orgId: "33c1d1d5-b6b7-43ef-a338-5ddf0da5c8e8", - shareWithUuid: "8c9881d1-b753-49ab-8af0-6499dc0fbb8f", - shareWithType: "Workspace", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `orgId` | *string* | :heavy_check_mark: | N/A | -| `shareWithUuid` | *string* | :heavy_check_mark: | The id of the entity (user, workspace or organization) to share with | -| `shareWithType` | [components.EntityType](../../models/components/entitytype.md) | :heavy_check_mark: | The type of entity, used to share a library. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/sharingin.md b/examples/sdks/mistral-typescript/docs/models/components/sharingin.md deleted file mode 100644 index a2e37befa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/sharingin.md +++ /dev/null @@ -1,23 +0,0 @@ -# SharingIn - -## Example Usage - -```typescript -import { SharingIn } from "@mistralai/mistralai/models/components"; - -let value: SharingIn = { - orgId: "bc4c2161-d23a-429b-b1fe-195d2a2e37e8", - level: "Viewer", - shareWithUuid: "3ed37090-9599-4057-9ccc-af8f13fa82cf", - shareWithType: "User", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `orgId` | *string* | :heavy_check_mark: | N/A | -| `level` | [components.ShareEnum](../../models/components/shareenum.md) | :heavy_check_mark: | N/A | -| `shareWithUuid` | *string* | :heavy_check_mark: | The id of the entity (user, workspace or organization) to share with | -| `shareWithType` | [components.EntityType](../../models/components/entitytype.md) | :heavy_check_mark: | The type of entity, used to share a library. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/sharingout.md b/examples/sdks/mistral-typescript/docs/models/components/sharingout.md deleted file mode 100644 index 64152cb34..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/sharingout.md +++ /dev/null @@ -1,26 +0,0 @@ -# SharingOut - -## Example Usage - -```typescript -import { SharingOut } from "@mistralai/mistralai/models/components"; - -let value: SharingOut = { - libraryId: "c34a158f-e5a5-43f9-a209-ab32ad451f52", - orgId: "af1ac545-f4b4-4855-885a-3ffe8790cc1b", - role: "", - shareWithType: "", - shareWithUuid: "3c6b633e-c2c5-4908-8be7-0be9aa1957ad", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `userId` | *string* | :heavy_minus_sign: | N/A | -| `orgId` | *string* | :heavy_check_mark: | N/A | -| `role` | *string* | :heavy_check_mark: | N/A | -| `shareWithType` | *string* | :heavy_check_mark: | N/A | -| `shareWithUuid` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/source.md b/examples/sdks/mistral-typescript/docs/models/components/source.md deleted file mode 100644 index 7bfd66c4e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/source.md +++ /dev/null @@ -1,17 +0,0 @@ -# Source - -## Example Usage - -```typescript -import { Source } from "@mistralai/mistralai/models/components"; - -let value: Source = "upload"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"upload" | "repository" | "mistral" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/ssetypes.md b/examples/sdks/mistral-typescript/docs/models/components/ssetypes.md deleted file mode 100644 index 5b0ed74be..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/ssetypes.md +++ /dev/null @@ -1,17 +0,0 @@ -# SSETypes - -Server side events sent when streaming a conversation response. - -## Example Usage - -```typescript -import { SSETypes } from "@mistralai/mistralai/models/components"; - -let value: SSETypes = "message.output.delta"; -``` - -## Values - -```typescript -"conversation.response.started" | "conversation.response.done" | "conversation.response.error" | "message.output.delta" | "tool.execution.started" | "tool.execution.delta" | "tool.execution.done" | "agent.handoff.started" | "agent.handoff.done" | "function.call.delta" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/status.md b/examples/sdks/mistral-typescript/docs/models/components/status.md deleted file mode 100644 index d4aa1bb1a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/status.md +++ /dev/null @@ -1,17 +0,0 @@ -# Status - -The current status of the fine-tuning job. - -## Example Usage - -```typescript -import { Status } from "@mistralai/mistralai/models/components"; - -let value: Status = "FAILED"; -``` - -## Values - -```typescript -"QUEUED" | "STARTED" | "VALIDATING" | "VALIDATED" | "RUNNING" | "FAILED_VALIDATION" | "FAILED" | "SUCCESS" | "CANCELLED" | "CANCELLATION_REQUESTED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/stop.md b/examples/sdks/mistral-typescript/docs/models/components/stop.md deleted file mode 100644 index bc9d30e07..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/stop.md +++ /dev/null @@ -1,22 +0,0 @@ -# Stop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/systemmessage.md b/examples/sdks/mistral-typescript/docs/models/components/systemmessage.md deleted file mode 100644 index 7d72a3ecc..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/systemmessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# SystemMessage - -## Example Usage - -```typescript -import { SystemMessage } from "@mistralai/mistralai/models/components"; - -let value: SystemMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `content` | *components.SystemMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.Role](../../models/components/role.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontent.md b/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontent.md deleted file mode 100644 index 7bfdb5b79..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontent.md +++ /dev/null @@ -1,22 +0,0 @@ -# SystemMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.SystemMessageContentChunks[]` - -```typescript -const value: components.SystemMessageContentChunks[] = [ - { - thinking: [], - type: "thinking", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontentchunks.md b/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontentchunks.md deleted file mode 100644 index a6f0642f5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/systemmessagecontentchunks.md +++ /dev/null @@ -1,21 +0,0 @@ -# SystemMessageContentChunks - - -## Supported Types - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ThinkChunk` - -```typescript -const value: components.ThinkChunk = { - thinking: [], -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/textchunk.md b/examples/sdks/mistral-typescript/docs/models/components/textchunk.md deleted file mode 100644 index 2ff4dd1ee..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/textchunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# TextChunk - -## Example Usage - -```typescript -import { TextChunk } from "@mistralai/mistralai/models/components"; - -let value: TextChunk = { - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [components.TextChunkType](../../models/components/textchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/textchunktype.md b/examples/sdks/mistral-typescript/docs/models/components/textchunktype.md deleted file mode 100644 index 9229d5554..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/textchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# TextChunkType - -## Example Usage - -```typescript -import { TextChunkType } from "@mistralai/mistralai/models/components"; - -let value: TextChunkType = "text"; -``` - -## Values - -```typescript -"text" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/thinkchunk.md b/examples/sdks/mistral-typescript/docs/models/components/thinkchunk.md deleted file mode 100644 index 3ac9c9821..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/thinkchunk.md +++ /dev/null @@ -1,19 +0,0 @@ -# ThinkChunk - -## Example Usage - -```typescript -import { ThinkChunk } from "@mistralai/mistralai/models/components"; - -let value: ThinkChunk = { - thinking: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `thinking` | *components.Thinking*[] | :heavy_check_mark: | N/A | -| `closed` | *boolean* | :heavy_minus_sign: | Whether the thinking chunk is closed or not. Currently only used for prefixing. | -| `type` | [components.ThinkChunkType](../../models/components/thinkchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/thinkchunktype.md b/examples/sdks/mistral-typescript/docs/models/components/thinkchunktype.md deleted file mode 100644 index 7286256e3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/thinkchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ThinkChunkType - -## Example Usage - -```typescript -import { ThinkChunkType } from "@mistralai/mistralai/models/components"; - -let value: ThinkChunkType = "thinking"; -``` - -## Values - -```typescript -"thinking" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/thinking.md b/examples/sdks/mistral-typescript/docs/models/components/thinking.md deleted file mode 100644 index 0e23944c5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/thinking.md +++ /dev/null @@ -1,21 +0,0 @@ -# Thinking - - -## Supported Types - -### `components.ReferenceChunk` - -```typescript -const value: components.ReferenceChunk = { - referenceIds: [], -}; -``` - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/timestampgranularity.md b/examples/sdks/mistral-typescript/docs/models/components/timestampgranularity.md deleted file mode 100644 index 5b6bc3ac5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/timestampgranularity.md +++ /dev/null @@ -1,15 +0,0 @@ -# TimestampGranularity - -## Example Usage - -```typescript -import { TimestampGranularity } from "@mistralai/mistralai/models/components"; - -let value: TimestampGranularity = "segment"; -``` - -## Values - -```typescript -"segment" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/tool.md b/examples/sdks/mistral-typescript/docs/models/components/tool.md deleted file mode 100644 index a391846f8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/tool.md +++ /dev/null @@ -1,23 +0,0 @@ -# Tool - -## Example Usage - -```typescript -import { Tool } from "@mistralai/mistralai/models/components"; - -let value: Tool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionT](../../models/components/functiont.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolcall.md b/examples/sdks/mistral-typescript/docs/models/components/toolcall.md deleted file mode 100644 index 40b6677b6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolcall.md +++ /dev/null @@ -1,23 +0,0 @@ -# ToolCall - -## Example Usage - -```typescript -import { ToolCall } from "@mistralai/mistralai/models/components"; - -let value: ToolCall = { - function: { - name: "", - arguments: {}, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionCall](../../models/components/functioncall.md) | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolchoice.md b/examples/sdks/mistral-typescript/docs/models/components/toolchoice.md deleted file mode 100644 index 43405f831..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolchoice.md +++ /dev/null @@ -1,22 +0,0 @@ -# ToolChoice - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - -## Example Usage - -```typescript -import { ToolChoice } from "@mistralai/mistralai/models/components"; - -let value: ToolChoice = { - function: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionName](../../models/components/functionname.md) | :heavy_check_mark: | this restriction of `Function` is used to select a specific function to call | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolchoiceenum.md b/examples/sdks/mistral-typescript/docs/models/components/toolchoiceenum.md deleted file mode 100644 index 1255a95a8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolchoiceenum.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolChoiceEnum - -## Example Usage - -```typescript -import { ToolChoiceEnum } from "@mistralai/mistralai/models/components"; - -let value: ToolChoiceEnum = "required"; -``` - -## Values - -```typescript -"auto" | "none" | "any" | "required" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaevent.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaevent.md deleted file mode 100644 index da2a246ce..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaevent.md +++ /dev/null @@ -1,24 +0,0 @@ -# ToolExecutionDeltaEvent - -## Example Usage - -```typescript -import { ToolExecutionDeltaEvent } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionDeltaEvent = { - id: "", - name: "code_interpreter", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [components.ToolExecutionDeltaEventType](../../models/components/toolexecutiondeltaeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaeventtype.md deleted file mode 100644 index e26c4df58..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondeltaeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolExecutionDeltaEventType - -## Example Usage - -```typescript -import { ToolExecutionDeltaEventType } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionDeltaEventType = "tool.execution.delta"; -``` - -## Values - -```typescript -"tool.execution.delta" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneevent.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneevent.md deleted file mode 100644 index b7e499f46..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneevent.md +++ /dev/null @@ -1,23 +0,0 @@ -# ToolExecutionDoneEvent - -## Example Usage - -```typescript -import { ToolExecutionDoneEvent } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionDoneEvent = { - id: "", - name: "code_interpreter", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [components.ToolExecutionDoneEventType](../../models/components/toolexecutiondoneeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `info` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneeventtype.md deleted file mode 100644 index fab92504f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutiondoneeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolExecutionDoneEventType - -## Example Usage - -```typescript -import { ToolExecutionDoneEventType } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionDoneEventType = "tool.execution.done"; -``` - -## Values - -```typescript -"tool.execution.done" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentry.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentry.md deleted file mode 100644 index 193e78427..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentry.md +++ /dev/null @@ -1,25 +0,0 @@ -# ToolExecutionEntry - -## Example Usage - -```typescript -import { ToolExecutionEntry } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionEntry = { - name: "web_search", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `object` | [components.ToolExecutionEntryObject](../../models/components/toolexecutionentryobject.md) | :heavy_minus_sign: | N/A | -| `type` | [components.ToolExecutionEntryType](../../models/components/toolexecutionentrytype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `info` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentryobject.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentryobject.md deleted file mode 100644 index 6ff0be8aa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentryobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolExecutionEntryObject - -## Example Usage - -```typescript -import { ToolExecutionEntryObject } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionEntryObject = "entry"; -``` - -## Values - -```typescript -"entry" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentrytype.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentrytype.md deleted file mode 100644 index 4c565ee06..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionentrytype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolExecutionEntryType - -## Example Usage - -```typescript -import { ToolExecutionEntryType } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionEntryType = "tool.execution"; -``` - -## Values - -```typescript -"tool.execution" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedevent.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedevent.md deleted file mode 100644 index c9756ae03..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedevent.md +++ /dev/null @@ -1,24 +0,0 @@ -# ToolExecutionStartedEvent - -## Example Usage - -```typescript -import { ToolExecutionStartedEvent } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionStartedEvent = { - id: "", - name: "web_search_premium", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.ToolExecutionStartedEventType](../../models/components/toolexecutionstartedeventtype.md) | :heavy_minus_sign: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `outputIndex` | *number* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedeventtype.md b/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedeventtype.md deleted file mode 100644 index 89b00af23..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolexecutionstartedeventtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolExecutionStartedEventType - -## Example Usage - -```typescript -import { ToolExecutionStartedEventType } from "@mistralai/mistralai/models/components"; - -let value: ToolExecutionStartedEventType = "tool.execution.started"; -``` - -## Values - -```typescript -"tool.execution.started" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolfilechunk.md b/examples/sdks/mistral-typescript/docs/models/components/toolfilechunk.md deleted file mode 100644 index acc749cae..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolfilechunk.md +++ /dev/null @@ -1,22 +0,0 @@ -# ToolFileChunk - -## Example Usage - -```typescript -import { ToolFileChunk } from "@mistralai/mistralai/models/components"; - -let value: ToolFileChunk = { - tool: "image_generation", - fileId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.ToolFileChunkType](../../models/components/toolfilechunktype.md) | :heavy_minus_sign: | N/A | -| `tool` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `fileName` | *string* | :heavy_minus_sign: | N/A | -| `fileType` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolfilechunktype.md b/examples/sdks/mistral-typescript/docs/models/components/toolfilechunktype.md deleted file mode 100644 index 34cf27fba..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolfilechunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolFileChunkType - -## Example Usage - -```typescript -import { ToolFileChunkType } from "@mistralai/mistralai/models/components"; - -let value: ToolFileChunkType = "tool_file"; -``` - -## Values - -```typescript -"tool_file" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolmessage.md b/examples/sdks/mistral-typescript/docs/models/components/toolmessage.md deleted file mode 100644 index 44d331dc6..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolmessage.md +++ /dev/null @@ -1,20 +0,0 @@ -# ToolMessage - -## Example Usage - -```typescript -import { ToolMessage } from "@mistralai/mistralai/models/components"; - -let value: ToolMessage = { - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.ToolMessageContent* | :heavy_check_mark: | N/A | -| `toolCallId` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.ToolMessageRole](../../models/components/toolmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolmessagecontent.md b/examples/sdks/mistral-typescript/docs/models/components/toolmessagecontent.md deleted file mode 100644 index 3acfc705c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolmessagecontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToolMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolmessagerole.md b/examples/sdks/mistral-typescript/docs/models/components/toolmessagerole.md deleted file mode 100644 index 1d38904e0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolMessageRole - -## Example Usage - -```typescript -import { ToolMessageRole } from "@mistralai/mistralai/models/components"; - -let value: ToolMessageRole = "tool"; -``` - -## Values - -```typescript -"tool" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunk.md b/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunk.md deleted file mode 100644 index 6e01c37f4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunk.md +++ /dev/null @@ -1,23 +0,0 @@ -# ToolReferenceChunk - -## Example Usage - -```typescript -import { ToolReferenceChunk } from "@mistralai/mistralai/models/components"; - -let value: ToolReferenceChunk = { - tool: "image_generation", - title: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.ToolReferenceChunkType](../../models/components/toolreferencechunktype.md) | :heavy_minus_sign: | N/A | -| `tool` | [components.BuiltInConnectors](../../models/components/builtinconnectors.md) | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | -| `favicon` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunktype.md b/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunktype.md deleted file mode 100644 index 30fd8fa7c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/toolreferencechunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolReferenceChunkType - -## Example Usage - -```typescript -import { ToolReferenceChunkType } from "@mistralai/mistralai/models/components"; - -let value: ToolReferenceChunkType = "tool_reference"; -``` - -## Values - -```typescript -"tool_reference" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/tools.md b/examples/sdks/mistral-typescript/docs/models/components/tools.md deleted file mode 100644 index fa258abf0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/tools.md +++ /dev/null @@ -1,54 +0,0 @@ -# Tools - - -## Supported Types - -### `components.DocumentLibraryTool` - -```typescript -const value: components.DocumentLibraryTool = { - libraryIds: [ - "", - "", - "", - ], -}; -``` - -### `components.FunctionTool` - -```typescript -const value: components.FunctionTool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -### `components.CodeInterpreterTool` - -```typescript -const value: components.CodeInterpreterTool = {}; -``` - -### `components.ImageGenerationTool` - -```typescript -const value: components.ImageGenerationTool = {}; -``` - -### `components.WebSearchTool` - -```typescript -const value: components.WebSearchTool = {}; -``` - -### `components.WebSearchPremiumTool` - -```typescript -const value: components.WebSearchPremiumTool = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/tooltypes.md b/examples/sdks/mistral-typescript/docs/models/components/tooltypes.md deleted file mode 100644 index a452b1639..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/tooltypes.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToolTypes - -## Example Usage - -```typescript -import { ToolTypes } from "@mistralai/mistralai/models/components"; - -let value: ToolTypes = "function"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"function" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/trainingfile.md b/examples/sdks/mistral-typescript/docs/models/components/trainingfile.md deleted file mode 100644 index 8fe1361ae..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/trainingfile.md +++ /dev/null @@ -1,18 +0,0 @@ -# TrainingFile - -## Example Usage - -```typescript -import { TrainingFile } from "@mistralai/mistralai/models/components"; - -let value: TrainingFile = { - fileId: "6f8c0c63-e1b3-44be-9874-34fc0c19fb88", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `weight` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionresponse.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionresponse.md deleted file mode 100644 index 235f08742..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionresponse.md +++ /dev/null @@ -1,25 +0,0 @@ -# TranscriptionResponse - -## Example Usage - -```typescript -import { TranscriptionResponse } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionResponse = { - model: "Grand Cherokee", - text: "", - usage: {}, - language: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `segments` | [components.TranscriptionSegmentChunk](../../models/components/transcriptionsegmentchunk.md)[] | :heavy_minus_sign: | N/A | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | -| `language` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionsegmentchunk.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionsegmentchunk.md deleted file mode 100644 index 254741d2d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionsegmentchunk.md +++ /dev/null @@ -1,23 +0,0 @@ -# TranscriptionSegmentChunk - -## Example Usage - -```typescript -import { TranscriptionSegmentChunk } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionSegmentChunk = { - text: "", - start: 7055.7, - end: 154.04, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `start` | *number* | :heavy_check_mark: | N/A | -| `end` | *number* | :heavy_check_mark: | N/A | -| `type` | [components.Type](../../models/components/type.md) | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdone.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdone.md deleted file mode 100644 index 03c21c9b8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdone.md +++ /dev/null @@ -1,26 +0,0 @@ -# TranscriptionStreamDone - -## Example Usage - -```typescript -import { TranscriptionStreamDone } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamDone = { - model: "Charger", - text: "", - usage: {}, - language: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `segments` | [components.TranscriptionSegmentChunk](../../models/components/transcriptionsegmentchunk.md)[] | :heavy_minus_sign: | N/A | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | -| `type` | [components.TranscriptionStreamDoneType](../../models/components/transcriptionstreamdonetype.md) | :heavy_minus_sign: | N/A | -| `language` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdonetype.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdonetype.md deleted file mode 100644 index a566db137..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamdonetype.md +++ /dev/null @@ -1,15 +0,0 @@ -# TranscriptionStreamDoneType - -## Example Usage - -```typescript -import { TranscriptionStreamDoneType } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamDoneType = "transcription.done"; -``` - -## Values - -```typescript -"transcription.done" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamevents.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamevents.md deleted file mode 100644 index 46c8426d7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamevents.md +++ /dev/null @@ -1,24 +0,0 @@ -# TranscriptionStreamEvents - -## Example Usage - -```typescript -import { TranscriptionStreamEvents } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamEvents = { - event: "transcription.done", - data: { - text: "", - start: 2155.98, - end: 208.46, - type: "transcription.segment", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `event` | [components.TranscriptionStreamEventTypes](../../models/components/transcriptionstreameventtypes.md) | :heavy_check_mark: | N/A | -| `data` | *components.TranscriptionStreamEventsData* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventsdata.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventsdata.md deleted file mode 100644 index 35ce8fe13..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventsdata.md +++ /dev/null @@ -1,42 +0,0 @@ -# TranscriptionStreamEventsData - - -## Supported Types - -### `components.TranscriptionStreamDone` - -```typescript -const value: components.TranscriptionStreamDone = { - model: "Charger", - text: "", - usage: {}, - language: "", -}; -``` - -### `components.TranscriptionStreamSegmentDelta` - -```typescript -const value: components.TranscriptionStreamSegmentDelta = { - text: "", - start: 1796.95, - end: 2412.74, -}; -``` - -### `components.TranscriptionStreamLanguage` - -```typescript -const value: components.TranscriptionStreamLanguage = { - audioLanguage: "", -}; -``` - -### `components.TranscriptionStreamTextDelta` - -```typescript -const value: components.TranscriptionStreamTextDelta = { - text: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventtypes.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventtypes.md deleted file mode 100644 index 71107d88c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreameventtypes.md +++ /dev/null @@ -1,15 +0,0 @@ -# TranscriptionStreamEventTypes - -## Example Usage - -```typescript -import { TranscriptionStreamEventTypes } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamEventTypes = "transcription.text.delta"; -``` - -## Values - -```typescript -"transcription.language" | "transcription.segment" | "transcription.text.delta" | "transcription.done" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguage.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguage.md deleted file mode 100644 index 5e8212af7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguage.md +++ /dev/null @@ -1,19 +0,0 @@ -# TranscriptionStreamLanguage - -## Example Usage - -```typescript -import { TranscriptionStreamLanguage } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamLanguage = { - audioLanguage: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.TranscriptionStreamLanguageType](../../models/components/transcriptionstreamlanguagetype.md) | :heavy_minus_sign: | N/A | -| `audioLanguage` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguagetype.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguagetype.md deleted file mode 100644 index 0429d4169..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamlanguagetype.md +++ /dev/null @@ -1,15 +0,0 @@ -# TranscriptionStreamLanguageType - -## Example Usage - -```typescript -import { TranscriptionStreamLanguageType } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamLanguageType = "transcription.language"; -``` - -## Values - -```typescript -"transcription.language" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdelta.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdelta.md deleted file mode 100644 index e004804eb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdelta.md +++ /dev/null @@ -1,23 +0,0 @@ -# TranscriptionStreamSegmentDelta - -## Example Usage - -```typescript -import { TranscriptionStreamSegmentDelta } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamSegmentDelta = { - text: "", - start: 1796.95, - end: 2412.74, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `start` | *number* | :heavy_check_mark: | N/A | -| `end` | *number* | :heavy_check_mark: | N/A | -| `type` | [components.TranscriptionStreamSegmentDeltaType](../../models/components/transcriptionstreamsegmentdeltatype.md) | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdeltatype.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdeltatype.md deleted file mode 100644 index a0258b60e..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamsegmentdeltatype.md +++ /dev/null @@ -1,15 +0,0 @@ -# TranscriptionStreamSegmentDeltaType - -## Example Usage - -```typescript -import { TranscriptionStreamSegmentDeltaType } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamSegmentDeltaType = "transcription.segment"; -``` - -## Values - -```typescript -"transcription.segment" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdelta.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdelta.md deleted file mode 100644 index b665a80fa..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdelta.md +++ /dev/null @@ -1,19 +0,0 @@ -# TranscriptionStreamTextDelta - -## Example Usage - -```typescript -import { TranscriptionStreamTextDelta } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamTextDelta = { - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [components.TranscriptionStreamTextDeltaType](../../models/components/transcriptionstreamtextdeltatype.md) | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdeltatype.md b/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdeltatype.md deleted file mode 100644 index 22272c4fe..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/transcriptionstreamtextdeltatype.md +++ /dev/null @@ -1,15 +0,0 @@ -# TranscriptionStreamTextDeltaType - -## Example Usage - -```typescript -import { TranscriptionStreamTextDeltaType } from "@mistralai/mistralai/models/components"; - -let value: TranscriptionStreamTextDeltaType = "transcription.text.delta"; -``` - -## Values - -```typescript -"transcription.text.delta" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/two.md b/examples/sdks/mistral-typescript/docs/models/components/two.md deleted file mode 100644 index 3399e6f02..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/two.md +++ /dev/null @@ -1,35 +0,0 @@ -# Two - - -## Supported Types - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/type.md b/examples/sdks/mistral-typescript/docs/models/components/type.md deleted file mode 100644 index d2f23c834..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/type.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type - -## Example Usage - -```typescript -import { Type } from "@mistralai/mistralai/models/components"; - -let value: Type = "transcription_segment"; -``` - -## Values - -```typescript -"transcription_segment" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodelout.md b/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodelout.md deleted file mode 100644 index c89722a79..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodelout.md +++ /dev/null @@ -1,19 +0,0 @@ -# UnarchiveFTModelOut - -## Example Usage - -```typescript -import { UnarchiveFTModelOut } from "@mistralai/mistralai/models/components"; - -let value: UnarchiveFTModelOut = { - id: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [components.UnarchiveFTModelOutObject](../../models/components/unarchiveftmodeloutobject.md) | :heavy_minus_sign: | N/A | -| `archived` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodeloutobject.md b/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodeloutobject.md deleted file mode 100644 index cd3fc3259..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/unarchiveftmodeloutobject.md +++ /dev/null @@ -1,15 +0,0 @@ -# UnarchiveFTModelOutObject - -## Example Usage - -```typescript -import { UnarchiveFTModelOutObject } from "@mistralai/mistralai/models/components"; - -let value: UnarchiveFTModelOutObject = "model"; -``` - -## Values - -```typescript -"model" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/updateftmodelin.md b/examples/sdks/mistral-typescript/docs/models/components/updateftmodelin.md deleted file mode 100644 index be18c6e22..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/updateftmodelin.md +++ /dev/null @@ -1,16 +0,0 @@ -# UpdateFTModelIn - -## Example Usage - -```typescript -import { UpdateFTModelIn } from "@mistralai/mistralai/models/components"; - -let value: UpdateFTModelIn = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/uploadfileout.md b/examples/sdks/mistral-typescript/docs/models/components/uploadfileout.md deleted file mode 100644 index 73d6160ec..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/uploadfileout.md +++ /dev/null @@ -1,34 +0,0 @@ -# UploadFileOut - -## Example Usage - -```typescript -import { UploadFileOut } from "@mistralai/mistralai/models/components"; - -let value: UploadFileOut = { - id: "497f6eca-6276-4993-bfeb-53cbbbba6f09", - object: "file", - sizeBytes: 13000, - createdAt: 1716963433, - filename: "files_upload.jsonl", - purpose: "batch", - sampleType: "batch_error", - source: "repository", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the file. | 497f6eca-6276-4993-bfeb-53cbbbba6f09 | -| `object` | *string* | :heavy_check_mark: | The object type, which is always "file". | file | -| `sizeBytes` | *number* | :heavy_check_mark: | The size of the file, in bytes. | 13000 | -| `createdAt` | *number* | :heavy_check_mark: | The UNIX timestamp (in seconds) of the event. | 1716963433 | -| `filename` | *string* | :heavy_check_mark: | The name of the uploaded file. | files_upload.jsonl | -| `purpose` | [components.FilePurpose](../../models/components/filepurpose.md) | :heavy_check_mark: | N/A | | -| `sampleType` | [components.SampleType](../../models/components/sampletype.md) | :heavy_check_mark: | N/A | | -| `numLines` | *number* | :heavy_minus_sign: | N/A | | -| `mimetype` | *string* | :heavy_minus_sign: | N/A | | -| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/usageinfo.md b/examples/sdks/mistral-typescript/docs/models/components/usageinfo.md deleted file mode 100644 index ba75b492a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/usageinfo.md +++ /dev/null @@ -1,19 +0,0 @@ -# UsageInfo - -## Example Usage - -```typescript -import { UsageInfo } from "@mistralai/mistralai/models/components"; - -let value: UsageInfo = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `promptTokens` | *number* | :heavy_minus_sign: | N/A | -| `completionTokens` | *number* | :heavy_minus_sign: | N/A | -| `totalTokens` | *number* | :heavy_minus_sign: | N/A | -| `promptAudioSeconds` | *number* | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/usermessage.md b/examples/sdks/mistral-typescript/docs/models/components/usermessage.md deleted file mode 100644 index f13996607..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/usermessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# UserMessage - -## Example Usage - -```typescript -import { UserMessage } from "@mistralai/mistralai/models/components"; - -let value: UserMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.UserMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.UserMessageRole](../../models/components/usermessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/usermessagecontent.md b/examples/sdks/mistral-typescript/docs/models/components/usermessagecontent.md deleted file mode 100644 index 22c7d880f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/usermessagecontent.md +++ /dev/null @@ -1,17 +0,0 @@ -# UserMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = []; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/components/usermessagerole.md b/examples/sdks/mistral-typescript/docs/models/components/usermessagerole.md deleted file mode 100644 index df3b831ce..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/usermessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# UserMessageRole - -## Example Usage - -```typescript -import { UserMessageRole } from "@mistralai/mistralai/models/components"; - -let value: UserMessageRole = "user"; -``` - -## Values - -```typescript -"user" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/validationerror.md b/examples/sdks/mistral-typescript/docs/models/components/validationerror.md deleted file mode 100644 index 7233338a2..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/validationerror.md +++ /dev/null @@ -1,23 +0,0 @@ -# ValidationError - -## Example Usage - -```typescript -import { ValidationError } from "@mistralai/mistralai/models/components"; - -let value: ValidationError = { - loc: [ - 929957, - ], - msg: "", - type: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `loc` | *components.Loc*[] | :heavy_check_mark: | N/A | -| `msg` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/wandbintegration.md b/examples/sdks/mistral-typescript/docs/models/components/wandbintegration.md deleted file mode 100644 index e34a4f9af..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/wandbintegration.md +++ /dev/null @@ -1,22 +0,0 @@ -# WandbIntegration - -## Example Usage - -```typescript -import { WandbIntegration } from "@mistralai/mistralai/models/components"; - -let value: WandbIntegration = { - project: "", - apiKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.WandbIntegrationType](../../models/components/wandbintegrationtype.md) | :heavy_minus_sign: | N/A | -| `project` | *string* | :heavy_check_mark: | The name of the project that the new run will be created under. | -| `name` | *string* | :heavy_minus_sign: | A display name to set for the run. If not set, will use the job ID as the name. | -| `apiKey` | *string* | :heavy_check_mark: | The WandB API key to use for authentication. | -| `runName` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationout.md b/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationout.md deleted file mode 100644 index 44ac575b7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationout.md +++ /dev/null @@ -1,21 +0,0 @@ -# WandbIntegrationOut - -## Example Usage - -```typescript -import { WandbIntegrationOut } from "@mistralai/mistralai/models/components"; - -let value: WandbIntegrationOut = { - project: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.WandbIntegrationOutType](../../models/components/wandbintegrationouttype.md) | :heavy_minus_sign: | N/A | -| `project` | *string* | :heavy_check_mark: | The name of the project that the new run will be created under. | -| `name` | *string* | :heavy_minus_sign: | A display name to set for the run. If not set, will use the job ID as the name. | -| `runName` | *string* | :heavy_minus_sign: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationouttype.md b/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationouttype.md deleted file mode 100644 index 644d74b98..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationouttype.md +++ /dev/null @@ -1,15 +0,0 @@ -# WandbIntegrationOutType - -## Example Usage - -```typescript -import { WandbIntegrationOutType } from "@mistralai/mistralai/models/components"; - -let value: WandbIntegrationOutType = "wandb"; -``` - -## Values - -```typescript -"wandb" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationtype.md b/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationtype.md deleted file mode 100644 index ebf402a38..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/wandbintegrationtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# WandbIntegrationType - -## Example Usage - -```typescript -import { WandbIntegrationType } from "@mistralai/mistralai/models/components"; - -let value: WandbIntegrationType = "wandb"; -``` - -## Values - -```typescript -"wandb" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtool.md b/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtool.md deleted file mode 100644 index c7734c1f0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtool.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebSearchPremiumTool - -## Example Usage - -```typescript -import { WebSearchPremiumTool } from "@mistralai/mistralai/models/components"; - -let value: WebSearchPremiumTool = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `type` | [components.WebSearchPremiumToolType](../../models/components/websearchpremiumtooltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtooltype.md b/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtooltype.md deleted file mode 100644 index d18c2926c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/websearchpremiumtooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebSearchPremiumToolType - -## Example Usage - -```typescript -import { WebSearchPremiumToolType } from "@mistralai/mistralai/models/components"; - -let value: WebSearchPremiumToolType = "web_search_premium"; -``` - -## Values - -```typescript -"web_search_premium" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/websearchtool.md b/examples/sdks/mistral-typescript/docs/models/components/websearchtool.md deleted file mode 100644 index 198f6e50a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/websearchtool.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebSearchTool - -## Example Usage - -```typescript -import { WebSearchTool } from "@mistralai/mistralai/models/components"; - -let value: WebSearchTool = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.WebSearchToolType](../../models/components/websearchtooltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/components/websearchtooltype.md b/examples/sdks/mistral-typescript/docs/models/components/websearchtooltype.md deleted file mode 100644 index 20c568db8..000000000 --- a/examples/sdks/mistral-typescript/docs/models/components/websearchtooltype.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebSearchToolType - -## Example Usage - -```typescript -import { WebSearchToolType } from "@mistralai/mistralai/models/components"; - -let value: WebSearchToolType = "web_search"; -``` - -## Values - -```typescript -"web_search" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/errors/httpvalidationerror.md b/examples/sdks/mistral-typescript/docs/models/errors/httpvalidationerror.md deleted file mode 100644 index 5396e134a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/errors/httpvalidationerror.md +++ /dev/null @@ -1,15 +0,0 @@ -# HTTPValidationError - -## Example Usage - -```typescript -import { HTTPValidationError } from "@mistralai/mistralai/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `detail` | [components.ValidationError](../../models/components/validationerror.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsgetrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsgetrequest.md deleted file mode 100644 index f16451317..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsgetrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# AgentsApiV1AgentsGetRequest - -## Example Usage - -```typescript -import { AgentsApiV1AgentsGetRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1AgentsGetRequest = { - agentId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `agentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentslistrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentslistrequest.md deleted file mode 100644 index f95d50a2f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentslistrequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# AgentsApiV1AgentsListRequest - -## Example Usage - -```typescript -import { AgentsApiV1AgentsListRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1AgentsListRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `pageSize` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdaterequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdaterequest.md deleted file mode 100644 index de72e103d..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdaterequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# AgentsApiV1AgentsUpdateRequest - -## Example Usage - -```typescript -import { AgentsApiV1AgentsUpdateRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1AgentsUpdateRequest = { - agentId: "", - agentUpdateRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `agentId` | *string* | :heavy_check_mark: | N/A | -| `agentUpdateRequest` | [components.AgentUpdateRequest](../../models/components/agentupdaterequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdateversionrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdateversionrequest.md deleted file mode 100644 index b16f6e555..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1agentsupdateversionrequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# AgentsApiV1AgentsUpdateVersionRequest - -## Example Usage - -```typescript -import { AgentsApiV1AgentsUpdateVersionRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1AgentsUpdateVersionRequest = { - agentId: "", - version: 550606, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `agentId` | *string* | :heavy_check_mark: | N/A | -| `version` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendrequest.md deleted file mode 100644 index 0c0a4dce1..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendrequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# AgentsApiV1ConversationsAppendRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsAppendRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsAppendRequest = { - conversationId: "", - conversationAppendRequest: { - inputs: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the conversation to which we append entries. | -| `conversationAppendRequest` | [components.ConversationAppendRequest](../../models/components/conversationappendrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendstreamrequest.md deleted file mode 100644 index e2dc1bc99..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsappendstreamrequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# AgentsApiV1ConversationsAppendStreamRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsAppendStreamRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsAppendStreamRequest = { - conversationId: "", - conversationAppendStreamRequest: { - inputs: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the conversation to which we append entries. | -| `conversationAppendStreamRequest` | [components.ConversationAppendStreamRequest](../../models/components/conversationappendstreamrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetrequest.md deleted file mode 100644 index c2db2d993..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# AgentsApiV1ConversationsGetRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsGetRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsGetRequest = { - conversationId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the conversation from which we are fetching metadata. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md deleted file mode 100644 index a68948e6b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md +++ /dev/null @@ -1,29 +0,0 @@ -# AgentsApiV1ConversationsGetResponseV1ConversationsGet - -Successful Response - - -## Supported Types - -### `components.ModelConversation` - -```typescript -const value: components.ModelConversation = { - id: "", - createdAt: new Date("2024-06-14T04:21:29.555Z"), - updatedAt: new Date("2025-10-08T03:17:09.039Z"), - model: "Escalade", -}; -``` - -### `components.AgentConversation` - -```typescript -const value: components.AgentConversation = { - id: "", - createdAt: new Date("2023-02-26T11:27:08.647Z"), - updatedAt: new Date("2023-04-03T21:29:31.420Z"), - agentId: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationshistoryrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationshistoryrequest.md deleted file mode 100644 index 227cce2ff..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationshistoryrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# AgentsApiV1ConversationsHistoryRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsHistoryRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsHistoryRequest = { - conversationId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the conversation from which we are fetching entries. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationslistrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationslistrequest.md deleted file mode 100644 index 5f577c29f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationslistrequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# AgentsApiV1ConversationsListRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsListRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsListRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `pageSize` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsmessagesrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsmessagesrequest.md deleted file mode 100644 index 130c998d4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsmessagesrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# AgentsApiV1ConversationsMessagesRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsMessagesRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsMessagesRequest = { - conversationId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the conversation from which we are fetching messages. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartrequest.md deleted file mode 100644 index 41656a478..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartrequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AgentsApiV1ConversationsRestartRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsRestartRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsRestartRequest = { - conversationId: "", - conversationRestartRequest: { - inputs: [], - fromEntryId: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the original conversation which is being restarted. | -| `conversationRestartRequest` | [components.ConversationRestartRequest](../../models/components/conversationrestartrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartstreamrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartstreamrequest.md deleted file mode 100644 index 3efdb9b47..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/agentsapiv1conversationsrestartstreamrequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# AgentsApiV1ConversationsRestartStreamRequest - -## Example Usage - -```typescript -import { AgentsApiV1ConversationsRestartStreamRequest } from "@mistralai/mistralai/models/operations"; - -let value: AgentsApiV1ConversationsRestartStreamRequest = { - conversationId: "", - conversationRestartStreamRequest: { - inputs: "", - fromEntryId: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `conversationId` | *string* | :heavy_check_mark: | ID of the original conversation which is being restarted. | -| `conversationRestartStreamRequest` | [components.ConversationRestartStreamRequest](../../models/components/conversationrestartstreamrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/deletemodelv1modelsmodeliddeleterequest.md b/examples/sdks/mistral-typescript/docs/models/operations/deletemodelv1modelsmodeliddeleterequest.md deleted file mode 100644 index 9b0969a84..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/deletemodelv1modelsmodeliddeleterequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# DeleteModelV1ModelsModelIdDeleteRequest - -## Example Usage - -```typescript -import { DeleteModelV1ModelsModelIdDeleteRequest } from "@mistralai/mistralai/models/operations"; - -let value: DeleteModelV1ModelsModelIdDeleteRequest = { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `modelId` | *string* | :heavy_check_mark: | The ID of the model to delete. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdeletefilerequest.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdeletefilerequest.md deleted file mode 100644 index e7667fe9f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdeletefilerequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# FilesApiRoutesDeleteFileRequest - -## Example Usage - -```typescript -import { FilesApiRoutesDeleteFileRequest } from "@mistralai/mistralai/models/operations"; - -let value: FilesApiRoutesDeleteFileRequest = { - fileId: "4bb1d830-8b98-4abe-bfae-a8719d615c18", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdownloadfilerequest.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdownloadfilerequest.md deleted file mode 100644 index c16be9632..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesdownloadfilerequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# FilesApiRoutesDownloadFileRequest - -## Example Usage - -```typescript -import { FilesApiRoutesDownloadFileRequest } from "@mistralai/mistralai/models/operations"; - -let value: FilesApiRoutesDownloadFileRequest = { - fileId: "e31bf706-2bf8-4451-968b-02260de5e9e8", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesgetsignedurlrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesgetsignedurlrequest.md deleted file mode 100644 index 0be3d926a..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesgetsignedurlrequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# FilesApiRoutesGetSignedUrlRequest - -## Example Usage - -```typescript -import { FilesApiRoutesGetSignedUrlRequest } from "@mistralai/mistralai/models/operations"; - -let value: FilesApiRoutesGetSignedUrlRequest = { - fileId: "f8456e8d-d43e-4a71-826f-880d5d3ed423", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `expiry` | *number* | :heavy_minus_sign: | Number of hours before the url becomes invalid. Defaults to 24h | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapirouteslistfilesrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapirouteslistfilesrequest.md deleted file mode 100644 index a9003b021..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapirouteslistfilesrequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# FilesApiRoutesListFilesRequest - -## Example Usage - -```typescript -import { FilesApiRoutesListFilesRequest } from "@mistralai/mistralai/models/operations"; - -let value: FilesApiRoutesListFilesRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `pageSize` | *number* | :heavy_minus_sign: | N/A | -| `sampleType` | [components.SampleType](../../models/components/sampletype.md)[] | :heavy_minus_sign: | N/A | -| `source` | [components.Source](../../models/components/source.md)[] | :heavy_minus_sign: | N/A | -| `search` | *string* | :heavy_minus_sign: | N/A | -| `purpose` | [components.FilePurpose](../../models/components/filepurpose.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesretrievefilerequest.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesretrievefilerequest.md deleted file mode 100644 index c6cc4e230..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesretrievefilerequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# FilesApiRoutesRetrieveFileRequest - -## Example Usage - -```typescript -import { FilesApiRoutesRetrieveFileRequest } from "@mistralai/mistralai/models/operations"; - -let value: FilesApiRoutesRetrieveFileRequest = { - fileId: "29155a51-541e-4b6f-af8c-83f42faa7e22", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesuploadfilemultipartbodyparams.md b/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesuploadfilemultipartbodyparams.md deleted file mode 100644 index 32921bfb0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/filesapiroutesuploadfilemultipartbodyparams.md +++ /dev/null @@ -1,16 +0,0 @@ -# FilesApiRoutesUploadFileMultiPartBodyParams - -## Example Usage - -```typescript -import { FilesApiRoutesUploadFileMultiPartBodyParams } from "@mistralai/mistralai/models/operations"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | [components.FilePurpose](../../models/components/filepurpose.md) | :heavy_minus_sign: | N/A | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [components.FileT](../../models/components/filet.md) | :heavy_check_mark: | The File object (not file name) to be uploaded.
    To upload a file and specify a custom file name you should format your request as such:
    ```bash
    file=@path/to/your/file.jsonl;filename=custom_name.jsonl
    ```
    Otherwise, you can just keep the original file name:
    ```bash
    file=@path/to/your/file.jsonl
    ``` | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchcancelbatchjobrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchcancelbatchjobrequest.md deleted file mode 100644 index 950a99804..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchcancelbatchjobrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesBatchCancelBatchJobRequest - -## Example Usage - -```typescript -import { JobsApiRoutesBatchCancelBatchJobRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesBatchCancelBatchJobRequest = { - jobId: "a7511a85-c720-4fc8-9028-9146225c5f34", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `jobId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobrequest.md deleted file mode 100644 index 44489f3ce..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesBatchGetBatchJobRequest - -## Example Usage - -```typescript -import { JobsApiRoutesBatchGetBatchJobRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesBatchGetBatchJobRequest = { - jobId: "ab89e3eb-a108-4a95-82e3-7e1941a586e1", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `jobId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobsrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobsrequest.md deleted file mode 100644 index c50967efd..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesbatchgetbatchjobsrequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# JobsApiRoutesBatchGetBatchJobsRequest - -## Example Usage - -```typescript -import { JobsApiRoutesBatchGetBatchJobsRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesBatchGetBatchJobsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `pageSize` | *number* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `agentId` | *string* | :heavy_minus_sign: | N/A | -| `metadata` | Record | :heavy_minus_sign: | N/A | -| `createdAfter` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `createdByMe` | *boolean* | :heavy_minus_sign: | N/A | -| `status` | [components.BatchJobStatus](../../models/components/batchjobstatus.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md deleted file mode 100644 index 2ad2d6d47..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesFineTuningArchiveFineTunedModelRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningArchiveFineTunedModelRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningArchiveFineTunedModelRequest = { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `modelId` | *string* | :heavy_check_mark: | The ID of the model to archive. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md deleted file mode 100644 index d666ef564..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesFineTuningCancelFineTuningJobRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningCancelFineTuningJobRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningCancelFineTuningJobRequest = { - jobId: "180bc5c4-f0e2-4324-a170-ad3622d33a6a", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `jobId` | *string* | :heavy_check_mark: | The ID of the job to cancel. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md deleted file mode 100644 index 955f2d8cb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md +++ /dev/null @@ -1,57 +0,0 @@ -# JobsApiRoutesFineTuningCancelFineTuningJobResponse - -OK - - -## Supported Types - -### `components.ClassifierDetailedJobOut` - -```typescript -const value: components.ClassifierDetailedJobOut = { - id: "9324efc1-74d2-4cfb-aacc-8c936806a157", - autoStart: true, - model: "Land Cruiser", - status: "CANCELLATION_REQUESTED", - createdAt: 306183, - modifiedAt: 163064, - trainingFiles: [ - "4aadd7e9-6b01-477f-86b6-3ada38b71e42", - "689691d3-0952-4741-a8e0-c05d353daf37", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], - classifierTargets: [], -}; -``` - -### `components.CompletionDetailedJobOut` - -```typescript -const value: components.CompletionDetailedJobOut = { - id: "456fe44d-6df9-48f2-930f-131af06a7b94", - autoStart: false, - model: "Taurus", - status: "VALIDATED", - createdAt: 45490, - modifiedAt: 318849, - trainingFiles: [ - "c6396397-fb35-4d61-8f27-af5626373d30", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md deleted file mode 100644 index 08f85cff5..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md +++ /dev/null @@ -1,44 +0,0 @@ -# JobsApiRoutesFineTuningCreateFineTuningJobResponse - -OK - - -## Supported Types - -### `operations.One` - -```typescript -const value: operations.One = { - id: "d6818f5f-200d-4efe-9e7c-d20456efe43b", - autoStart: true, - model: "Prius", - status: "CANCELLATION_REQUESTED", - createdAt: 263852, - modifiedAt: 463777, - trainingFiles: [ - "9f003c6f-9c82-4b28-9533-cb5576df3462", - ], - object: "job", - jobType: "completion", - hyperparameters: { - learningRate: 0.0001, - }, -}; -``` - -### `components.LegacyJobMetadataOut` - -```typescript -const value: components.LegacyJobMetadataOut = { - expectedDurationSeconds: 220, - cost: 10, - costCurrency: "EUR", - trainTokensPerStep: 131072, - trainTokens: 1310720, - dataTokens: 305375, - details: "", - epochs: 4.2922, - trainingSteps: 10, -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md deleted file mode 100644 index 9325b5551..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesFineTuningGetFineTuningJobRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningGetFineTuningJobRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningGetFineTuningJobRequest = { - jobId: "b9e861b8-540e-4c8d-b022-6665a4d86b5e", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `jobId` | *string* | :heavy_check_mark: | The ID of the job to analyse. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md deleted file mode 100644 index e0fa9dc58..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md +++ /dev/null @@ -1,57 +0,0 @@ -# JobsApiRoutesFineTuningGetFineTuningJobResponse - -OK - - -## Supported Types - -### `components.ClassifierDetailedJobOut` - -```typescript -const value: components.ClassifierDetailedJobOut = { - id: "9324efc1-74d2-4cfb-aacc-8c936806a157", - autoStart: true, - model: "Land Cruiser", - status: "CANCELLATION_REQUESTED", - createdAt: 306183, - modifiedAt: 163064, - trainingFiles: [ - "4aadd7e9-6b01-477f-86b6-3ada38b71e42", - "689691d3-0952-4741-a8e0-c05d353daf37", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], - classifierTargets: [], -}; -``` - -### `components.CompletionDetailedJobOut` - -```typescript -const value: components.CompletionDetailedJobOut = { - id: "456fe44d-6df9-48f2-930f-131af06a7b94", - autoStart: false, - model: "Taurus", - status: "VALIDATED", - createdAt: 45490, - modifiedAt: 318849, - trainingFiles: [ - "c6396397-fb35-4d61-8f27-af5626373d30", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md deleted file mode 100644 index 7db701db4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md +++ /dev/null @@ -1,24 +0,0 @@ -# JobsApiRoutesFineTuningGetFineTuningJobsRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningGetFineTuningJobsRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningGetFineTuningJobsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `page` | *number* | :heavy_minus_sign: | The page number of the results to be returned. | -| `pageSize` | *number* | :heavy_minus_sign: | The number of items to return per page. | -| `model` | *string* | :heavy_minus_sign: | The model name used for fine-tuning to filter on. When set, the other results are not displayed. | -| `createdAfter` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date/time to filter on. When set, the results for previous creation times are not displayed. | -| `createdBefore` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | -| `createdByMe` | *boolean* | :heavy_minus_sign: | When set, only return results for jobs created by the API caller. Other results are not displayed. | -| `status` | [operations.Status](../../models/operations/status.md) | :heavy_minus_sign: | The current job state to filter on. When set, the other results are not displayed. | -| `wandbProject` | *string* | :heavy_minus_sign: | The Weights and Biases project to filter on. When set, the other results are not displayed. | -| `wandbName` | *string* | :heavy_minus_sign: | The Weight and Biases run name to filter on. When set, the other results are not displayed. | -| `suffix` | *string* | :heavy_minus_sign: | The model suffix to filter on. When set, the other results are not displayed. | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md deleted file mode 100644 index 0caa036de..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesFineTuningStartFineTuningJobRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningStartFineTuningJobRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningStartFineTuningJobRequest = { - jobId: "5764212f-1795-4c4d-963a-27126a4c0a58", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `jobId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md deleted file mode 100644 index 7de65b307..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md +++ /dev/null @@ -1,57 +0,0 @@ -# JobsApiRoutesFineTuningStartFineTuningJobResponse - -OK - - -## Supported Types - -### `components.ClassifierDetailedJobOut` - -```typescript -const value: components.ClassifierDetailedJobOut = { - id: "9324efc1-74d2-4cfb-aacc-8c936806a157", - autoStart: true, - model: "Land Cruiser", - status: "CANCELLATION_REQUESTED", - createdAt: 306183, - modifiedAt: 163064, - trainingFiles: [ - "4aadd7e9-6b01-477f-86b6-3ada38b71e42", - "689691d3-0952-4741-a8e0-c05d353daf37", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], - classifierTargets: [], -}; -``` - -### `components.CompletionDetailedJobOut` - -```typescript -const value: components.CompletionDetailedJobOut = { - id: "456fe44d-6df9-48f2-930f-131af06a7b94", - autoStart: false, - model: "Taurus", - status: "VALIDATED", - createdAt: 45490, - modifiedAt: 318849, - trainingFiles: [ - "c6396397-fb35-4d61-8f27-af5626373d30", - ], - hyperparameters: {}, - checkpoints: [ - { - metrics: {}, - stepNumber: 738998, - createdAt: 1716963433, - }, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md deleted file mode 100644 index 015549361..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest = { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `modelId` | *string* | :heavy_check_mark: | The ID of the model to unarchive. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md deleted file mode 100644 index cc560b8a4..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# JobsApiRoutesFineTuningUpdateFineTunedModelRequest - -## Example Usage - -```typescript -import { JobsApiRoutesFineTuningUpdateFineTunedModelRequest } from "@mistralai/mistralai/models/operations"; - -let value: JobsApiRoutesFineTuningUpdateFineTunedModelRequest = { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - updateFTModelIn: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `modelId` | *string* | :heavy_check_mark: | The ID of the model to update. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | -| `updateFTModelIn` | [components.UpdateFTModelIn](../../models/components/updateftmodelin.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md b/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md deleted file mode 100644 index 2e2170e01..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md +++ /dev/null @@ -1,40 +0,0 @@ -# JobsApiRoutesFineTuningUpdateFineTunedModelResponse - -OK - - -## Supported Types - -### `components.ClassifierFTModelOut` - -```typescript -const value: components.ClassifierFTModelOut = { - id: "", - created: 111228, - ownedBy: "", - workspaceId: "", - root: "", - rootVersion: "", - archived: true, - capabilities: {}, - job: "b1e6e408-c7c5-4c7c-9c65-efca1702bf4b", - classifierTargets: [], -}; -``` - -### `components.CompletionFTModelOut` - -```typescript -const value: components.CompletionFTModelOut = { - id: "", - created: 787475, - ownedBy: "", - workspaceId: "", - root: "", - rootVersion: "", - archived: false, - capabilities: {}, - job: "0f147667-0d54-46fd-934d-6a88bd2ec484", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdeletev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdeletev1request.md deleted file mode 100644 index b15bb0e3c..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdeletev1request.md +++ /dev/null @@ -1,17 +0,0 @@ -# LibrariesDeleteV1Request - -## Example Usage - -```typescript -import { LibrariesDeleteV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDeleteV1Request = { - libraryId: "8b9c91e9-8a8f-4975-9719-7d6fcd17bb8b", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsdeletev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsdeletev1request.md deleted file mode 100644 index 79768a465..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsdeletev1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsDeleteV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsDeleteV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsDeleteV1Request = { - libraryId: "50371cc0-2924-4777-8fb7-edc74d9d6564", - documentId: "895ec8de-e227-4649-9280-7cdbedf18e53", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md deleted file mode 100644 index a701d5a28..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsGetExtractedTextSignedUrlV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsGetExtractedTextSignedUrlV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsGetExtractedTextSignedUrlV1Request = { - libraryId: "5713bd9a-f013-45e1-95ac-ee380ffa1f37", - documentId: "922ba0fd-8856-4142-a851-1d54ffb0a0bf", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetsignedurlv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetsignedurlv1request.md deleted file mode 100644 index eea407947..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetsignedurlv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsGetSignedUrlV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsGetSignedUrlV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsGetSignedUrlV1Request = { - libraryId: "b136410b-6b61-4eb0-b930-20a0251ca33f", - documentId: "43e779c5-c23c-4b34-b84a-508035dcb8c7", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetstatusv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetstatusv1request.md deleted file mode 100644 index 4c0baf7eb..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetstatusv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsGetStatusV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsGetStatusV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsGetStatusV1Request = { - libraryId: "809fe023-e83d-47db-9be3-a0746ceeda1b", - documentId: "470831d7-dca0-4bee-aae2-f0fe6a3a794d", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgettextcontentv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgettextcontentv1request.md deleted file mode 100644 index 33fb8820f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgettextcontentv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsGetTextContentV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsGetTextContentV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsGetTextContentV1Request = { - libraryId: "1a0f160b-7f91-49e8-adad-d23939292b9a", - documentId: "27fe5ac1-83c7-4995-b8a2-b62b0ba0f22e", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetv1request.md deleted file mode 100644 index 0f2ae6aba..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsgetv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsGetV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsGetV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsGetV1Request = { - libraryId: "cecb541c-bcc6-48aa-af4f-7e1866823d07", - documentId: "1a799e36-b2ff-47bf-9b3b-de88b0a16ea2", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentslistv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentslistv1request.md deleted file mode 100644 index 418f23cef..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentslistv1request.md +++ /dev/null @@ -1,22 +0,0 @@ -# LibrariesDocumentsListV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsListV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsListV1Request = { - libraryId: "5cda2ac0-5f8d-4c50-b395-aa9094be52f0", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `search` | *string* | :heavy_minus_sign: | N/A | -| `pageSize` | *number* | :heavy_minus_sign: | N/A | -| `page` | *number* | :heavy_minus_sign: | N/A | -| `sortBy` | *string* | :heavy_minus_sign: | N/A | -| `sortOrder` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsreprocessv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsreprocessv1request.md deleted file mode 100644 index f5c6258a9..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsreprocessv1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesDocumentsReprocessV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsReprocessV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsReprocessV1Request = { - libraryId: "c8741ace-7d56-44cc-810e-666c3e5e2c4a", - documentId: "ac82a047-2958-4362-97f2-db506f4e09f5", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsupdatev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsupdatev1request.md deleted file mode 100644 index 143934a01..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsupdatev1request.md +++ /dev/null @@ -1,21 +0,0 @@ -# LibrariesDocumentsUpdateV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsUpdateV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesDocumentsUpdateV1Request = { - libraryId: "f8c3cedb-476c-435b-8370-dc3e2f727191", - documentId: "3417b15c-8ef6-448c-be5f-d7db55388085", - documentUpdateIn: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `documentId` | *string* | :heavy_check_mark: | N/A | -| `documentUpdateIn` | [components.DocumentUpdateIn](../../models/components/documentupdatein.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1documentupload.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1documentupload.md deleted file mode 100644 index 5419e3cbc..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1documentupload.md +++ /dev/null @@ -1,15 +0,0 @@ -# LibrariesDocumentsUploadV1DocumentUpload - -## Example Usage - -```typescript -import { LibrariesDocumentsUploadV1DocumentUpload } from "@mistralai/mistralai/models/operations"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [components.FileT](../../models/components/filet.md) | :heavy_check_mark: | The File object (not file name) to be uploaded.
    To upload a file and specify a custom file name you should format your request as such:
    ```bash
    file=@path/to/your/file.jsonl;filename=custom_name.jsonl
    ```
    Otherwise, you can just keep the original file name:
    ```bash
    file=@path/to/your/file.jsonl
    ``` | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1request.md deleted file mode 100644 index cedfd40e7..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesdocumentsuploadv1request.md +++ /dev/null @@ -1,16 +0,0 @@ -# LibrariesDocumentsUploadV1Request - -## Example Usage - -```typescript -import { LibrariesDocumentsUploadV1Request } from "@mistralai/mistralai/models/operations"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `requestBody` | [operations.LibrariesDocumentsUploadV1DocumentUpload](../../models/operations/librariesdocumentsuploadv1documentupload.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesgetv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesgetv1request.md deleted file mode 100644 index 7bd927666..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesgetv1request.md +++ /dev/null @@ -1,17 +0,0 @@ -# LibrariesGetV1Request - -## Example Usage - -```typescript -import { LibrariesGetV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesGetV1Request = { - libraryId: "46b5cb01-2c69-4b8a-a328-d29fb35f2446", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariessharecreatev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariessharecreatev1request.md deleted file mode 100644 index 3c0467bec..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariessharecreatev1request.md +++ /dev/null @@ -1,24 +0,0 @@ -# LibrariesShareCreateV1Request - -## Example Usage - -```typescript -import { LibrariesShareCreateV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesShareCreateV1Request = { - libraryId: "b7dc8216-e4ce-4ff1-a455-580e870d6c11", - sharingIn: { - orgId: "487e3359-6b01-47f9-969c-f4387c394ce9", - level: "Viewer", - shareWithUuid: "b4d43faf-9d92-4c96-b0b5-23e55802be64", - shareWithType: "Workspace", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `sharingIn` | [components.SharingIn](../../models/components/sharingin.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariessharedeletev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariessharedeletev1request.md deleted file mode 100644 index 57a456691..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariessharedeletev1request.md +++ /dev/null @@ -1,23 +0,0 @@ -# LibrariesShareDeleteV1Request - -## Example Usage - -```typescript -import { LibrariesShareDeleteV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesShareDeleteV1Request = { - libraryId: "60a98302-6f5c-420d-b196-340076197225", - sharingDelete: { - orgId: "62303524-1a55-4463-a880-73404efa3580", - shareWithUuid: "e895052c-9149-4add-be08-9a4b900934aa", - shareWithType: "Workspace", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `sharingDelete` | [components.SharingDelete](../../models/components/sharingdelete.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariessharelistv1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariessharelistv1request.md deleted file mode 100644 index 0a2850325..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariessharelistv1request.md +++ /dev/null @@ -1,17 +0,0 @@ -# LibrariesShareListV1Request - -## Example Usage - -```typescript -import { LibrariesShareListV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesShareListV1Request = { - libraryId: "794dd27b-b377-4ac7-858d-f1616f11b0b5", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/librariesupdatev1request.md b/examples/sdks/mistral-typescript/docs/models/operations/librariesupdatev1request.md deleted file mode 100644 index 72fb1903f..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/librariesupdatev1request.md +++ /dev/null @@ -1,19 +0,0 @@ -# LibrariesUpdateV1Request - -## Example Usage - -```typescript -import { LibrariesUpdateV1Request } from "@mistralai/mistralai/models/operations"; - -let value: LibrariesUpdateV1Request = { - libraryId: "e52f793f-78fd-4e00-a99a-417c791644e6", - libraryInUpdate: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `libraryId` | *string* | :heavy_check_mark: | N/A | -| `libraryInUpdate` | [components.LibraryInUpdate](../../models/components/libraryinupdate.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/one.md b/examples/sdks/mistral-typescript/docs/models/operations/one.md deleted file mode 100644 index c6c3f41d0..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/one.md +++ /dev/null @@ -1,41 +0,0 @@ -# One - - -## Supported Types - -### `components.ClassifierJobOut` - -```typescript -const value: components.ClassifierJobOut = { - id: "94361cba-dbfe-4cb8-b157-dba88d484a3b", - autoStart: true, - model: "Mercielago", - status: "FAILED_VALIDATION", - createdAt: 604693, - modifiedAt: 540214, - trainingFiles: [ - "8db2006d-0f95-498b-8a1c-8b96bd790c50", - ], - hyperparameters: {}, -}; -``` - -### `components.CompletionJobOut` - -```typescript -const value: components.CompletionJobOut = { - id: "ad07d8f7-c8e8-41df-a05e-52088cd2b04b", - autoStart: false, - model: "Jetta", - status: "CANCELLED", - createdAt: 508554, - modifiedAt: 47551, - trainingFiles: [ - "0befa7d5-b534-4a53-8e8f-ae6a6f8e2d47", - "fc6abeaa-0a91-4111-9774-6e9c6a29d66a", - "f06b4756-0fe1-4e67-8ec2-5b8b8680fedc", - ], - hyperparameters: {}, -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/responsebody.md b/examples/sdks/mistral-typescript/docs/models/operations/responsebody.md deleted file mode 100644 index dd234cb3b..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/responsebody.md +++ /dev/null @@ -1,27 +0,0 @@ -# ResponseBody - - -## Supported Types - -### `components.ModelConversation` - -```typescript -const value: components.ModelConversation = { - id: "", - createdAt: new Date("2024-06-14T04:21:29.555Z"), - updatedAt: new Date("2025-10-08T03:17:09.039Z"), - model: "Escalade", -}; -``` - -### `components.AgentConversation` - -```typescript -const value: components.AgentConversation = { - id: "", - createdAt: new Date("2023-02-26T11:27:08.647Z"), - updatedAt: new Date("2023-04-03T21:29:31.420Z"), - agentId: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetrequest.md b/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetrequest.md deleted file mode 100644 index 6b9e7efb3..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetrequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# RetrieveModelV1ModelsModelIdGetRequest - -## Example Usage - -```typescript -import { RetrieveModelV1ModelsModelIdGetRequest } from "@mistralai/mistralai/models/operations"; - -let value: RetrieveModelV1ModelsModelIdGetRequest = { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `modelId` | *string* | :heavy_check_mark: | The ID of the model to retrieve. | ft:open-mistral-7b:587a6b29:20240514:7e773925 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md b/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md deleted file mode 100644 index bc90f1a15..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md +++ /dev/null @@ -1,27 +0,0 @@ -# RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet - -Successful Response - - -## Supported Types - -### `components.FTModelCard` - -```typescript -const value: components.FTModelCard = { - id: "", - capabilities: {}, - job: "Global Interactions Strategist", - root: "", -}; -``` - -### `components.BaseModelCard` - -```typescript -const value: components.BaseModelCard = { - id: "", - capabilities: {}, -}; -``` - diff --git a/examples/sdks/mistral-typescript/docs/models/operations/status.md b/examples/sdks/mistral-typescript/docs/models/operations/status.md deleted file mode 100644 index 394608d08..000000000 --- a/examples/sdks/mistral-typescript/docs/models/operations/status.md +++ /dev/null @@ -1,17 +0,0 @@ -# Status - -The current job state to filter on. When set, the other results are not displayed. - -## Example Usage - -```typescript -import { Status } from "@mistralai/mistralai/models/operations"; - -let value: Status = "FAILED"; -``` - -## Values - -```typescript -"QUEUED" | "STARTED" | "VALIDATING" | "VALIDATED" | "RUNNING" | "FAILED_VALIDATION" | "FAILED" | "SUCCESS" | "CANCELLED" | "CANCELLATION_REQUESTED" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/accesses/README.md b/examples/sdks/mistral-typescript/docs/sdks/accesses/README.md deleted file mode 100644 index 19ed26f2a..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/accesses/README.md +++ /dev/null @@ -1,256 +0,0 @@ -# Accesses -(*beta.libraries.accesses*) - -## Overview - -(beta) Libraries API - manage access to a library. - -### Available Operations - -* [list](#list) - List all of the access to this library. -* [updateOrCreate](#updateorcreate) - Create or update an access level. -* [delete](#delete) - Delete an access level. - -## list - -Given a library, list all of the Entity that have access and to what level. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.accesses.list({ - libraryId: "d2169833-d8e2-416e-a372-76518d3d99c2", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesAccessesList } from "@mistralai/mistralai/funcs/betaLibrariesAccessesList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesAccessesList(mistral, { - libraryId: "d2169833-d8e2-416e-a372-76518d3d99c2", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesAccessesList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesShareListV1Request](../../models/operations/librariessharelistv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ListSharingOut](../../models/components/listsharingout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## updateOrCreate - -Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.accesses.updateOrCreate({ - libraryId: "36de3a24-5b1c-4c8f-9d84-d5642205a976", - sharingIn: { - orgId: "aadd9ae1-f285-4437-884a-091c77efa6fd", - level: "Viewer", - shareWithUuid: "0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20", - shareWithType: "User", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesAccessesUpdateOrCreate } from "@mistralai/mistralai/funcs/betaLibrariesAccessesUpdateOrCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesAccessesUpdateOrCreate(mistral, { - libraryId: "36de3a24-5b1c-4c8f-9d84-d5642205a976", - sharingIn: { - orgId: "aadd9ae1-f285-4437-884a-091c77efa6fd", - level: "Viewer", - shareWithUuid: "0ae92ecb-21ed-47c5-9f7e-0b2cbe325a20", - shareWithType: "User", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesAccessesUpdateOrCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesShareCreateV1Request](../../models/operations/librariessharecreatev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.SharingOut](../../models/components/sharingout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## delete - -Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.accesses.delete({ - libraryId: "709e3cad-9fb2-4f4e-bf88-143cf1808107", - sharingDelete: { - orgId: "0814a235-c2d0-4814-875a-4b85f93d3dc7", - shareWithUuid: "b843cc47-ce8f-4354-8cfc-5fcd7fb2865b", - shareWithType: "User", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesAccessesDelete } from "@mistralai/mistralai/funcs/betaLibrariesAccessesDelete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesAccessesDelete(mistral, { - libraryId: "709e3cad-9fb2-4f4e-bf88-143cf1808107", - sharingDelete: { - orgId: "0814a235-c2d0-4814-875a-4b85f93d3dc7", - shareWithUuid: "b843cc47-ce8f-4354-8cfc-5fcd7fb2865b", - shareWithType: "User", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesAccessesDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesShareDeleteV1Request](../../models/operations/librariessharedeletev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.SharingOut](../../models/components/sharingout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/agents/README.md b/examples/sdks/mistral-typescript/docs/sdks/agents/README.md deleted file mode 100644 index 54828952d..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/agents/README.md +++ /dev/null @@ -1,189 +0,0 @@ -# Agents -(*agents*) - -## Overview - -Agents API. - -### Available Operations - -* [complete](#complete) - Agents Completion -* [stream](#stream) - Stream Agents completion - -## complete - -Agents Completion - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.agents.complete({ - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { agentsComplete } from "@mistralai/mistralai/funcs/agentsComplete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await agentsComplete(mistral, { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("agentsComplete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.AgentsCompletionRequest](../../models/components/agentscompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## stream - -Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.agents.stream({ - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { agentsStream } from "@mistralai/mistralai/funcs/agentsStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await agentsStream(mistral, { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - agentId: "", - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("agentsStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.AgentsCompletionStreamRequest](../../models/components/agentscompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/audio/README.md b/examples/sdks/mistral-typescript/docs/sdks/audio/README.md deleted file mode 100644 index 2101c2667..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/audio/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Audio -(*audio*) - -## Overview - -### Available Operations diff --git a/examples/sdks/mistral-typescript/docs/sdks/batch/README.md b/examples/sdks/mistral-typescript/docs/sdks/batch/README.md deleted file mode 100644 index ec7d83409..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/batch/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Batch -(*batch*) - -## Overview - -### Available Operations diff --git a/examples/sdks/mistral-typescript/docs/sdks/beta/README.md b/examples/sdks/mistral-typescript/docs/sdks/beta/README.md deleted file mode 100644 index f5b5f8220..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/beta/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Beta -(*beta*) - -## Overview - -### Available Operations diff --git a/examples/sdks/mistral-typescript/docs/sdks/chat/README.md b/examples/sdks/mistral-typescript/docs/sdks/chat/README.md deleted file mode 100644 index b07dc4ed8..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/chat/README.md +++ /dev/null @@ -1,189 +0,0 @@ -# Chat -(*chat*) - -## Overview - -Chat Completion API. - -### Available Operations - -* [complete](#complete) - Chat Completion -* [stream](#stream) - Stream chat completion - -## complete - -Chat Completion - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { chatComplete } from "@mistralai/mistralai/funcs/chatComplete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await chatComplete(mistral, { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("chatComplete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionRequest](../../models/components/chatcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## stream - -Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { chatStream } from "@mistralai/mistralai/funcs/chatStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await chatStream(mistral, { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("chatStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionStreamRequest](../../models/components/chatcompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/classifiers/README.md b/examples/sdks/mistral-typescript/docs/sdks/classifiers/README.md deleted file mode 100644 index 4bfa79d47..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/classifiers/README.md +++ /dev/null @@ -1,355 +0,0 @@ -# Classifiers -(*classifiers*) - -## Overview - -Classifiers API. - -### Available Operations - -* [moderate](#moderate) - Moderations -* [moderateChat](#moderatechat) - Chat Moderations -* [classify](#classify) - Classifications -* [classifyChat](#classifychat) - Chat Classifications - -## moderate - -Moderations - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.classifiers.moderate({ - model: "Durango", - inputs: [ - "", - "", - ], - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { classifiersModerate } from "@mistralai/mistralai/funcs/classifiersModerate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await classifiersModerate(mistral, { - model: "Durango", - inputs: [ - "", - "", - ], - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("classifiersModerate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ClassificationRequest](../../models/components/classificationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ModerationResponse](../../models/components/moderationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## moderateChat - -Chat Moderations - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.classifiers.moderateChat({ - inputs: [ - { - content: "", - role: "tool", - }, - ], - model: "LeBaron", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { classifiersModerateChat } from "@mistralai/mistralai/funcs/classifiersModerateChat.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await classifiersModerateChat(mistral, { - inputs: [ - { - content: "", - role: "tool", - }, - ], - model: "LeBaron", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("classifiersModerateChat failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatModerationRequest](../../models/components/chatmoderationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ModerationResponse](../../models/components/moderationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## classify - -Classifications - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.classifiers.classify({ - model: "Silverado", - inputs: [ - "", - ], - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { classifiersClassify } from "@mistralai/mistralai/funcs/classifiersClassify.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await classifiersClassify(mistral, { - model: "Silverado", - inputs: [ - "", - ], - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("classifiersClassify failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ClassificationRequest](../../models/components/classificationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ClassificationResponse](../../models/components/classificationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## classifyChat - -Chat Classifications - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.classifiers.classifyChat({ - model: "Camry", - inputs: [ - { - messages: [ - { - content: "", - role: "system", - }, - ], - }, - ], - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { classifiersClassifyChat } from "@mistralai/mistralai/funcs/classifiersClassifyChat.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await classifiersClassifyChat(mistral, { - model: "Camry", - inputs: [ - { - messages: [ - { - content: "", - role: "system", - }, - ], - }, - ], - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("classifiersClassifyChat failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatClassificationRequest](../../models/components/chatclassificationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ClassificationResponse](../../models/components/classificationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/conversations/README.md b/examples/sdks/mistral-typescript/docs/sdks/conversations/README.md deleted file mode 100644 index 96aa252b2..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/conversations/README.md +++ /dev/null @@ -1,835 +0,0 @@ -# Conversations -(*beta.conversations*) - -## Overview - -(beta) Conversations API - -### Available Operations - -* [start](#start) - Create a conversation and append entries to it. -* [list](#list) - List all created conversations. -* [get](#get) - Retrieve a conversation information. -* [append](#append) - Append new entries to an existing conversation. -* [getHistory](#gethistory) - Retrieve all entries in a conversation. -* [getMessages](#getmessages) - Retrieve all messages in a conversation. -* [restart](#restart) - Restart a conversation starting from a given entry. -* [startStream](#startstream) - Create a conversation and append entries to it. -* [appendStream](#appendstream) - Append new entries to an existing conversation. -* [restartStream](#restartstream) - Restart a conversation starting from a given entry. - -## start - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.start({ - inputs: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsStart } from "@mistralai/mistralai/funcs/betaConversationsStart.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsStart(mistral, { - inputs: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsStart failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ConversationRequest](../../models/components/conversationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ConversationResponse](../../models/components/conversationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## list - -Retrieve a list of conversation entities sorted by creation time. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.list({}); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsList } from "@mistralai/mistralai/funcs/betaConversationsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsList(mistral, {}); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsListRequest](../../models/operations/agentsapiv1conversationslistrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ResponseBody[]](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Given a conversation_id retrieve a conversation entity with its attributes. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.get({ - conversationId: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsGet } from "@mistralai/mistralai/funcs/betaConversationsGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsGet(mistral, { - conversationId: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsGetRequest](../../models/operations/agentsapiv1conversationsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet](../../models/operations/agentsapiv1conversationsgetresponsev1conversationsget.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## append - -Run completion on the history of the conversation and the user entries. Return the new created entries. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.append({ - conversationId: "", - conversationAppendRequest: { - inputs: [], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsAppend } from "@mistralai/mistralai/funcs/betaConversationsAppend.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsAppend(mistral, { - conversationId: "", - conversationAppendRequest: { - inputs: [], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsAppend failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsAppendRequest](../../models/operations/agentsapiv1conversationsappendrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ConversationResponse](../../models/components/conversationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## getHistory - -Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.getHistory({ - conversationId: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsGetHistory } from "@mistralai/mistralai/funcs/betaConversationsGetHistory.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsGetHistory(mistral, { - conversationId: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsGetHistory failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsHistoryRequest](../../models/operations/agentsapiv1conversationshistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ConversationHistory](../../models/components/conversationhistory.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## getMessages - -Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.getMessages({ - conversationId: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsGetMessages } from "@mistralai/mistralai/funcs/betaConversationsGetMessages.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsGetMessages(mistral, { - conversationId: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsGetMessages failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsMessagesRequest](../../models/operations/agentsapiv1conversationsmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ConversationMessages](../../models/components/conversationmessages.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## restart - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.restart({ - conversationId: "", - conversationRestartRequest: { - inputs: "", - fromEntryId: "", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsRestart } from "@mistralai/mistralai/funcs/betaConversationsRestart.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsRestart(mistral, { - conversationId: "", - conversationRestartRequest: { - inputs: "", - fromEntryId: "", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaConversationsRestart failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsRestartRequest](../../models/operations/agentsapiv1conversationsrestartrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ConversationResponse](../../models/components/conversationresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## startStream - -Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.startStream({ - inputs: [ - { - object: "entry", - type: "agent.handoff", - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", - }, - ], - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsStartStream } from "@mistralai/mistralai/funcs/betaConversationsStartStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsStartStream(mistral, { - inputs: [ - { - object: "entry", - type: "agent.handoff", - previousAgentId: "", - previousAgentName: "", - nextAgentId: "", - nextAgentName: "", - }, - ], - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("betaConversationsStartStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ConversationStreamRequest](../../models/components/conversationstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## appendStream - -Run completion on the history of the conversation and the user entries. Return the new created entries. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.appendStream({ - conversationId: "", - conversationAppendStreamRequest: { - inputs: "", - }, - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsAppendStream } from "@mistralai/mistralai/funcs/betaConversationsAppendStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsAppendStream(mistral, { - conversationId: "", - conversationAppendStreamRequest: { - inputs: "", - }, - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("betaConversationsAppendStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsAppendStreamRequest](../../models/operations/agentsapiv1conversationsappendstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## restartStream - -Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.conversations.restartStream({ - conversationId: "", - conversationRestartStreamRequest: { - inputs: [ - { - object: "entry", - type: "message.input", - role: "assistant", - content: "", - prefix: false, - }, - ], - fromEntryId: "", - }, - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaConversationsRestartStream } from "@mistralai/mistralai/funcs/betaConversationsRestartStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaConversationsRestartStream(mistral, { - conversationId: "", - conversationRestartStreamRequest: { - inputs: [ - { - object: "entry", - type: "message.input", - role: "assistant", - content: "", - prefix: false, - }, - ], - fromEntryId: "", - }, - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("betaConversationsRestartStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1ConversationsRestartStreamRequest](../../models/operations/agentsapiv1conversationsrestartstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/documents/README.md b/examples/sdks/mistral-typescript/docs/sdks/documents/README.md deleted file mode 100644 index d387dc527..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/documents/README.md +++ /dev/null @@ -1,785 +0,0 @@ -# Documents -(*beta.libraries.documents*) - -## Overview - -(beta) Libraries API - manage documents in a library. - -### Available Operations - -* [list](#list) - List document in a given library. -* [upload](#upload) - Upload a new document. -* [get](#get) - Retrieve the metadata of a specific document. -* [update](#update) - Update the metadata of a specific document. -* [delete](#delete) - Delete a document. -* [textContent](#textcontent) - Retrieve the text content of a specific document. -* [status](#status) - Retrieve the processing status of a specific document. -* [getSignedUrl](#getsignedurl) - Retrieve the signed URL of a specific document. -* [extractedTextSignedUrl](#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document. -* [reprocess](#reprocess) - Reprocess a document. - -## list - -Given a library, lists the document that have been uploaded to that library. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.list({ - libraryId: "5c3ca4cd-62bc-4c71-ad8a-1531ae80d078", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsList } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsList(mistral, { - libraryId: "5c3ca4cd-62bc-4c71-ad8a-1531ae80d078", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsListV1Request](../../models/operations/librariesdocumentslistv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ListDocumentOut](../../models/components/listdocumentout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## upload - -Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { openAsBlob } from "node:fs"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.upload({ - libraryId: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76", - requestBody: { - file: await openAsBlob("example.file"), - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsUpload } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsUpload.js"; -import { openAsBlob } from "node:fs"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsUpload(mistral, { - libraryId: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76", - requestBody: { - file: await openAsBlob("example.file"), - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsUpload failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsUploadV1Request](../../models/operations/librariesdocumentsuploadv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DocumentOut](../../models/components/documentout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Given a library and a document in this library, you can retrieve the metadata of that document. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.get({ - libraryId: "03d908c8-90a1-44fd-bf3a-8490fb7c9a03", - documentId: "90973aec-0508-4375-8b00-91d732414745", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsGet } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsGet(mistral, { - libraryId: "03d908c8-90a1-44fd-bf3a-8490fb7c9a03", - documentId: "90973aec-0508-4375-8b00-91d732414745", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsGetV1Request](../../models/operations/librariesdocumentsgetv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DocumentOut](../../models/components/documentout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## update - -Given a library and a document in that library, update the name of that document. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.update({ - libraryId: "3ddd8d93-dca5-4a6d-980d-173226c35742", - documentId: "2a25e44c-b160-40ca-b5c2-b65fb2fcae34", - documentUpdateIn: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsUpdate } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsUpdate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsUpdate(mistral, { - libraryId: "3ddd8d93-dca5-4a6d-980d-173226c35742", - documentId: "2a25e44c-b160-40ca-b5c2-b65fb2fcae34", - documentUpdateIn: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsUpdateV1Request](../../models/operations/librariesdocumentsupdatev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DocumentOut](../../models/components/documentout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## delete - -Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - await mistral.beta.libraries.documents.delete({ - libraryId: "005daae9-d42e-407d-82d7-2261c6a1496c", - documentId: "edc236b0-baff-49a9-884b-4ca36a258da4", - }); - - -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsDelete } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsDelete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsDelete(mistral, { - libraryId: "005daae9-d42e-407d-82d7-2261c6a1496c", - documentId: "edc236b0-baff-49a9-884b-4ca36a258da4", - }); - if (res.ok) { - const { value: result } = res; - - } else { - console.log("betaLibrariesDocumentsDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsDeleteV1Request](../../models/operations/librariesdocumentsdeletev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## textContent - -Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.textContent({ - libraryId: "1d177215-3b6b-45ba-9fa9-baf773223bec", - documentId: "60214c91-2aba-4692-a4e6-a53365de8caf", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsTextContent } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsTextContent.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsTextContent(mistral, { - libraryId: "1d177215-3b6b-45ba-9fa9-baf773223bec", - documentId: "60214c91-2aba-4692-a4e6-a53365de8caf", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsTextContent failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsGetTextContentV1Request](../../models/operations/librariesdocumentsgettextcontentv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DocumentTextContent](../../models/components/documenttextcontent.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## status - -Given a library and a document in that library, retrieve the processing status of that document. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.status({ - libraryId: "e6906f70-368f-4155-80da-c1718f01bc43", - documentId: "2c904915-d831-4e9d-a345-8ce405bcef66", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsStatus } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsStatus.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsStatus(mistral, { - libraryId: "e6906f70-368f-4155-80da-c1718f01bc43", - documentId: "2c904915-d831-4e9d-a345-8ce405bcef66", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsStatus failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsGetStatusV1Request](../../models/operations/librariesdocumentsgetstatusv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ProcessingStatusOut](../../models/components/processingstatusout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## getSignedUrl - -Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.getSignedUrl({ - libraryId: "23cf6904-a602-4ee8-9f5b-8efc557c336d", - documentId: "48598486-df71-4994-acbb-1133c72efa8c", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsGetSignedUrl } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsGetSignedUrl.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsGetSignedUrl(mistral, { - libraryId: "23cf6904-a602-4ee8-9f5b-8efc557c336d", - documentId: "48598486-df71-4994-acbb-1133c72efa8c", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsGetSignedUrl failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsGetSignedUrlV1Request](../../models/operations/librariesdocumentsgetsignedurlv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[string](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## extractedTextSignedUrl - -Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.documents.extractedTextSignedUrl({ - libraryId: "a6f15de3-1e82-4f95-af82-851499042ef8", - documentId: "9749d4f9-24e5-4ca2-99a3-a406863f805d", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsExtractedTextSignedUrl } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsExtractedTextSignedUrl(mistral, { - libraryId: "a6f15de3-1e82-4f95-af82-851499042ef8", - documentId: "9749d4f9-24e5-4ca2-99a3-a406863f805d", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDocumentsExtractedTextSignedUrl failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request](../../models/operations/librariesdocumentsgetextractedtextsignedurlv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[string](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## reprocess - -Given a library and a document in that library, reprocess that document, it will be billed again. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - await mistral.beta.libraries.documents.reprocess({ - libraryId: "51b29371-de8f-4ba4-932b-a0bafb3a7f64", - documentId: "3052422c-49ca-45ac-a918-cadb35d61fd8", - }); - - -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDocumentsReprocess } from "@mistralai/mistralai/funcs/betaLibrariesDocumentsReprocess.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDocumentsReprocess(mistral, { - libraryId: "51b29371-de8f-4ba4-932b-a0bafb3a7f64", - documentId: "3052422c-49ca-45ac-a918-cadb35d61fd8", - }); - if (res.ok) { - const { value: result } = res; - - } else { - console.log("betaLibrariesDocumentsReprocess failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDocumentsReprocessV1Request](../../models/operations/librariesdocumentsreprocessv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/embeddings/README.md b/examples/sdks/mistral-typescript/docs/sdks/embeddings/README.md deleted file mode 100644 index 8e875e2f3..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/embeddings/README.md +++ /dev/null @@ -1,92 +0,0 @@ -# Embeddings -(*embeddings*) - -## Overview - -Embeddings API. - -### Available Operations - -* [create](#create) - Embeddings - -## create - -Embeddings - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.embeddings.create({ - model: "mistral-embed", - inputs: [ - "Embed this sentence.", - "As well as this one.", - ], - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { embeddingsCreate } from "@mistralai/mistralai/funcs/embeddingsCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await embeddingsCreate(mistral, { - model: "mistral-embed", - inputs: [ - "Embed this sentence.", - "As well as this one.", - ], - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("embeddingsCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.EmbeddingRequest](../../models/components/embeddingrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.EmbeddingResponse](../../models/components/embeddingresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/files/README.md b/examples/sdks/mistral-typescript/docs/sdks/files/README.md deleted file mode 100644 index 2ccbe73ba..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/files/README.md +++ /dev/null @@ -1,455 +0,0 @@ -# Files -(*files*) - -## Overview - -Files API - -### Available Operations - -* [upload](#upload) - Upload File -* [list](#list) - List Files -* [retrieve](#retrieve) - Retrieve File -* [delete](#delete) - Delete File -* [download](#download) - Download File -* [getSignedUrl](#getsignedurl) - Get Signed Url - -## upload - -Upload a file that can be used across various endpoints. - -The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - -Please contact us if you need to increase these storage limits. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; -import { openAsBlob } from "node:fs"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.upload({ - file: await openAsBlob("example.file"), - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesUpload } from "@mistralai/mistralai/funcs/filesUpload.js"; -import { openAsBlob } from "node:fs"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesUpload(mistral, { - file: await openAsBlob("example.file"), - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesUpload failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesUploadFileMultiPartBodyParams](../../models/operations/filesapiroutesuploadfilemultipartbodyparams.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.UploadFileOut](../../models/components/uploadfileout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## list - -Returns a list of files that belong to the user's organization. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.list({}); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesList } from "@mistralai/mistralai/funcs/filesList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesList(mistral, {}); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesListFilesRequest](../../models/operations/filesapirouteslistfilesrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ListFilesOut](../../models/components/listfilesout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## retrieve - -Returns information about a specific file. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.retrieve({ - fileId: "f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesRetrieve } from "@mistralai/mistralai/funcs/filesRetrieve.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesRetrieve(mistral, { - fileId: "f2a27685-ca4e-4dc2-9f2b-88c422c3e0f6", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesRetrieve failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesRetrieveFileRequest](../../models/operations/filesapiroutesretrievefilerequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.RetrieveFileOut](../../models/components/retrievefileout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## delete - -Delete a file. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.delete({ - fileId: "3b6d45eb-e30b-416f-8019-f47e2e93d930", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesDelete } from "@mistralai/mistralai/funcs/filesDelete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesDelete(mistral, { - fileId: "3b6d45eb-e30b-416f-8019-f47e2e93d930", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesDeleteFileRequest](../../models/operations/filesapiroutesdeletefilerequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DeleteFileOut](../../models/components/deletefileout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## download - -Download a file - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.download({ - fileId: "f8919994-a4a1-46b2-8b5b-06335a4300ce", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesDownload } from "@mistralai/mistralai/funcs/filesDownload.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesDownload(mistral, { - fileId: "f8919994-a4a1-46b2-8b5b-06335a4300ce", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesDownload failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesDownloadFileRequest](../../models/operations/filesapiroutesdownloadfilerequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[ReadableStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## getSignedUrl - -Get Signed Url - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.files.getSignedUrl({ - fileId: "06a020ab-355c-49a6-b19d-304b7c01699f", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { filesGetSignedUrl } from "@mistralai/mistralai/funcs/filesGetSignedUrl.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await filesGetSignedUrl(mistral, { - fileId: "06a020ab-355c-49a6-b19d-304b7c01699f", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("filesGetSignedUrl failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.FilesApiRoutesGetSignedUrlRequest](../../models/operations/filesapiroutesgetsignedurlrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.FileSignedURL](../../models/components/filesignedurl.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/fim/README.md b/examples/sdks/mistral-typescript/docs/sdks/fim/README.md deleted file mode 100644 index 047ea3068..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/fim/README.md +++ /dev/null @@ -1,173 +0,0 @@ -# Fim -(*fim*) - -## Overview - -Fill-in-the-middle API. - -### Available Operations - -* [complete](#complete) - Fim Completion -* [stream](#stream) - Stream fim completion - -## complete - -FIM completion. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fim.complete({ - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fimComplete } from "@mistralai/mistralai/funcs/fimComplete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fimComplete(mistral, { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fimComplete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.FIMCompletionRequest](../../models/components/fimcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.FIMCompletionResponse](../../models/components/fimcompletionresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## stream - -Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fim.stream({ - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fimStream } from "@mistralai/mistralai/funcs/fimStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fimStream(mistral, { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("fimStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.FIMCompletionStreamRequest](../../models/components/fimcompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/finetuning/README.md b/examples/sdks/mistral-typescript/docs/sdks/finetuning/README.md deleted file mode 100644 index 1978943e9..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/finetuning/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# FineTuning -(*fineTuning*) - -## Overview - -### Available Operations diff --git a/examples/sdks/mistral-typescript/docs/sdks/jobs/README.md b/examples/sdks/mistral-typescript/docs/sdks/jobs/README.md deleted file mode 100644 index d0f8fc569..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/jobs/README.md +++ /dev/null @@ -1,379 +0,0 @@ -# Jobs -(*fineTuning.jobs*) - -## Overview - -### Available Operations - -* [list](#list) - Get Fine Tuning Jobs -* [create](#create) - Create Fine Tuning Job -* [get](#get) - Get Fine Tuning Job -* [cancel](#cancel) - Cancel Fine Tuning Job -* [start](#start) - Start Fine Tuning Job - -## list - -Get a list of fine-tuning jobs for your organization and user. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fineTuning.jobs.list({}); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fineTuningJobsList } from "@mistralai/mistralai/funcs/fineTuningJobsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fineTuningJobsList(mistral, {}); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fineTuningJobsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.JobsOut](../../models/components/jobsout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## create - -Create a new fine-tuning job, it will be queued for processing. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fineTuning.jobs.create({ - model: "Camaro", - hyperparameters: { - learningRate: 0.0001, - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fineTuningJobsCreate } from "@mistralai/mistralai/funcs/fineTuningJobsCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fineTuningJobsCreate(mistral, { - model: "Camaro", - hyperparameters: { - learningRate: 0.0001, - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fineTuningJobsCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.JobIn](../../models/components/jobin.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningcreatefinetuningjobresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Get a fine-tuned job details by its UUID. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fineTuning.jobs.get({ - jobId: "c167a961-ffca-4bcf-93ac-6169468dd389", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fineTuningJobsGet } from "@mistralai/mistralai/funcs/fineTuningJobsGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fineTuningJobsGet(mistral, { - jobId: "c167a961-ffca-4bcf-93ac-6169468dd389", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fineTuningJobsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningGetFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.JobsApiRoutesFineTuningGetFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuninggetfinetuningjobresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## cancel - -Request the cancellation of a fine tuning job. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fineTuning.jobs.cancel({ - jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fineTuningJobsCancel } from "@mistralai/mistralai/funcs/fineTuningJobsCancel.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fineTuningJobsCancel(mistral, { - jobId: "6188a2f6-7513-4e0f-89cc-3f8088523a49", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fineTuningJobsCancel failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuningcancelfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningcancelfinetuningjobresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## start - -Request the start of a validated fine tuning job. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.fineTuning.jobs.start({ - jobId: "56553e4d-0679-471e-b9ac-59a77d671103", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { fineTuningJobsStart } from "@mistralai/mistralai/funcs/fineTuningJobsStart.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await fineTuningJobsStart(mistral, { - jobId: "56553e4d-0679-471e-b9ac-59a77d671103", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("fineTuningJobsStart failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningStartFineTuningJobRequest](../../models/operations/jobsapiroutesfinetuningstartfinetuningjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.JobsApiRoutesFineTuningStartFineTuningJobResponse](../../models/operations/jobsapiroutesfinetuningstartfinetuningjobresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/libraries/README.md b/examples/sdks/mistral-typescript/docs/sdks/libraries/README.md deleted file mode 100644 index bc6da90d6..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/libraries/README.md +++ /dev/null @@ -1,380 +0,0 @@ -# Libraries -(*beta.libraries*) - -## Overview - -(beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - -### Available Operations - -* [list](#list) - List all libraries you have access to. -* [create](#create) - Create a new Library. -* [get](#get) - Detailed information about a specific Library. -* [delete](#delete) - Delete a library and all of it's document. -* [update](#update) - Update a library. - -## list - -List all libraries that you have created or have been shared with you. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.list(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesList } from "@mistralai/mistralai/funcs/betaLibrariesList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesList(mistral); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ListLibraryOut](../../models/components/listlibraryout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## create - -Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.create({ - name: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesCreate } from "@mistralai/mistralai/funcs/betaLibrariesCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesCreate(mistral, { - name: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.LibraryIn](../../models/components/libraryin.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.LibraryOut](../../models/components/libraryout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Given a library id, details information about that Library. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.get({ - libraryId: "d0d23a1e-bfe5-45e7-b7bb-22a4ea78d47f", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesGet } from "@mistralai/mistralai/funcs/betaLibrariesGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesGet(mistral, { - libraryId: "d0d23a1e-bfe5-45e7-b7bb-22a4ea78d47f", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesGetV1Request](../../models/operations/librariesgetv1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.LibraryOut](../../models/components/libraryout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## delete - -Given a library id, deletes it together with all documents that have been uploaded to that library. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.delete({ - libraryId: "6cad0b6e-fd2e-4d11-a48b-21d30fb7c17a", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesDelete } from "@mistralai/mistralai/funcs/betaLibrariesDelete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesDelete(mistral, { - libraryId: "6cad0b6e-fd2e-4d11-a48b-21d30fb7c17a", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesDeleteV1Request](../../models/operations/librariesdeletev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.LibraryOut](../../models/components/libraryout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## update - -Given a library id, you can update the name and description. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.libraries.update({ - libraryId: "e01880c3-d0b5-4a29-8b1b-abdb8ce917e4", - libraryInUpdate: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaLibrariesUpdate } from "@mistralai/mistralai/funcs/betaLibrariesUpdate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaLibrariesUpdate(mistral, { - libraryId: "e01880c3-d0b5-4a29-8b1b-abdb8ce917e4", - libraryInUpdate: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaLibrariesUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.LibrariesUpdateV1Request](../../models/operations/librariesupdatev1request.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.LibraryOut](../../models/components/libraryout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/mistral/README.md b/examples/sdks/mistral-typescript/docs/sdks/mistral/README.md deleted file mode 100644 index 4b9573d01..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/mistral/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Mistral SDK - -## Overview - -Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -### Available Operations diff --git a/examples/sdks/mistral-typescript/docs/sdks/mistralagents/README.md b/examples/sdks/mistral-typescript/docs/sdks/mistralagents/README.md deleted file mode 100644 index e393320db..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/mistralagents/README.md +++ /dev/null @@ -1,386 +0,0 @@ -# MistralAgents -(*beta.agents*) - -## Overview - -(beta) Agents API - -### Available Operations - -* [create](#create) - Create a agent that can be used within a conversation. -* [list](#list) - List agent entities. -* [get](#get) - Retrieve an agent entity. -* [update](#update) - Update an agent entity. -* [updateVersion](#updateversion) - Update an agent version. - -## create - -Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.agents.create({ - model: "LeBaron", - name: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaAgentsCreate } from "@mistralai/mistralai/funcs/betaAgentsCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaAgentsCreate(mistral, { - model: "LeBaron", - name: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaAgentsCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.AgentCreationRequest](../../models/components/agentcreationrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.Agent](../../models/components/agent.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## list - -Retrieve a list of agent entities sorted by creation time. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.agents.list({}); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaAgentsList } from "@mistralai/mistralai/funcs/betaAgentsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaAgentsList(mistral, {}); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaAgentsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1AgentsListRequest](../../models/operations/agentsapiv1agentslistrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.Agent[]](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Given an agent retrieve an agent entity with its attributes. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.agents.get({ - agentId: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaAgentsGet } from "@mistralai/mistralai/funcs/betaAgentsGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaAgentsGet(mistral, { - agentId: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaAgentsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1AgentsGetRequest](../../models/operations/agentsapiv1agentsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.Agent](../../models/components/agent.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## update - -Update an agent attributes and create a new version. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.agents.update({ - agentId: "", - agentUpdateRequest: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaAgentsUpdate } from "@mistralai/mistralai/funcs/betaAgentsUpdate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaAgentsUpdate(mistral, { - agentId: "", - agentUpdateRequest: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaAgentsUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1AgentsUpdateRequest](../../models/operations/agentsapiv1agentsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.Agent](../../models/components/agent.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## updateVersion - -Switch the version of an agent. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.beta.agents.updateVersion({ - agentId: "", - version: 157995, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { betaAgentsUpdateVersion } from "@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaAgentsUpdateVersion(mistral, { - agentId: "", - version: 157995, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaAgentsUpdateVersion failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.AgentsApiV1AgentsUpdateVersionRequest](../../models/operations/agentsapiv1agentsupdateversionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.Agent](../../models/components/agent.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/mistraljobs/README.md b/examples/sdks/mistral-typescript/docs/sdks/mistraljobs/README.md deleted file mode 100644 index 917ee7276..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/mistraljobs/README.md +++ /dev/null @@ -1,305 +0,0 @@ -# MistralJobs -(*batch.jobs*) - -## Overview - -### Available Operations - -* [list](#list) - Get Batch Jobs -* [create](#create) - Create Batch Job -* [get](#get) - Get Batch Job -* [cancel](#cancel) - Cancel Batch Job - -## list - -Get a list of batch jobs for your organization and user. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.batch.jobs.list({}); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { batchJobsList } from "@mistralai/mistralai/funcs/batchJobsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await batchJobsList(mistral, {}); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("batchJobsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesBatchGetBatchJobsRequest](../../models/operations/jobsapiroutesbatchgetbatchjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.BatchJobsOut](../../models/components/batchjobsout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## create - -Create a new batch job, it will be queued for processing. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.batch.jobs.create({ - inputFiles: [ - "fe3343a2-3b8d-404b-ba32-a78dede2614a", - ], - endpoint: "/v1/classifications", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { batchJobsCreate } from "@mistralai/mistralai/funcs/batchJobsCreate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await batchJobsCreate(mistral, { - inputFiles: [ - "fe3343a2-3b8d-404b-ba32-a78dede2614a", - ], - endpoint: "/v1/classifications", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("batchJobsCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.BatchJobIn](../../models/components/batchjobin.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.BatchJobOut](../../models/components/batchjobout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## get - -Get a batch job details by its UUID. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.batch.jobs.get({ - jobId: "4017dc9f-b629-42f4-9700-8c681b9e7f0f", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { batchJobsGet } from "@mistralai/mistralai/funcs/batchJobsGet.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await batchJobsGet(mistral, { - jobId: "4017dc9f-b629-42f4-9700-8c681b9e7f0f", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("batchJobsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesBatchGetBatchJobRequest](../../models/operations/jobsapiroutesbatchgetbatchjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.BatchJobOut](../../models/components/batchjobout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## cancel - -Request the cancellation of a batch job. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.batch.jobs.cancel({ - jobId: "4fb29d1c-535b-4f0a-a1cb-2167f86da569", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { batchJobsCancel } from "@mistralai/mistralai/funcs/batchJobsCancel.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await batchJobsCancel(mistral, { - jobId: "4fb29d1c-535b-4f0a-a1cb-2167f86da569", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("batchJobsCancel failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesBatchCancelBatchJobRequest](../../models/operations/jobsapiroutesbatchcancelbatchjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.BatchJobOut](../../models/components/batchjobout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/models/README.md b/examples/sdks/mistral-typescript/docs/sdks/models/README.md deleted file mode 100644 index 8c7ee814c..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/models/README.md +++ /dev/null @@ -1,453 +0,0 @@ -# Models -(*models*) - -## Overview - -Model Management API - -### Available Operations - -* [list](#list) - List Models -* [retrieve](#retrieve) - Retrieve Model -* [delete](#delete) - Delete Model -* [update](#update) - Update Fine Tuned Model -* [archive](#archive) - Archive Fine Tuned Model -* [unarchive](#unarchive) - Unarchive Fine Tuned Model - -## list - -List all models available to the user. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.list(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsList } from "@mistralai/mistralai/funcs/modelsList.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsList(mistral); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ModelList](../../models/components/modellist.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## retrieve - -Retrieve information about a model. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.retrieve({ - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsRetrieve } from "@mistralai/mistralai/funcs/modelsRetrieve.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsRetrieve(mistral, { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsRetrieve failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.RetrieveModelV1ModelsModelIdGetRequest](../../models/operations/retrievemodelv1modelsmodelidgetrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet](../../models/operations/retrievemodelv1modelsmodelidgetresponseretrievemodelv1modelsmodelidget.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## delete - -Delete a fine-tuned model. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.delete({ - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsDelete } from "@mistralai/mistralai/funcs/modelsDelete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsDelete(mistral, { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteModelV1ModelsModelIdDeleteRequest](../../models/operations/deletemodelv1modelsmodeliddeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.DeleteModelOut](../../models/components/deletemodelout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## update - -Update a model name or description. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.update({ - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - updateFTModelIn: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsUpdate } from "@mistralai/mistralai/funcs/modelsUpdate.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsUpdate(mistral, { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - updateFTModelIn: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest](../../models/operations/jobsapiroutesfinetuningupdatefinetunedmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse](../../models/operations/jobsapiroutesfinetuningupdatefinetunedmodelresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## archive - -Archive a fine-tuned model. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.archive({ - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsArchive } from "@mistralai/mistralai/funcs/modelsArchive.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsArchive(mistral, { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsArchive failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest](../../models/operations/jobsapiroutesfinetuningarchivefinetunedmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.ArchiveFTModelOut](../../models/components/archiveftmodelout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## unarchive - -Un-archive a fine-tuned model. - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.models.unarchive({ - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { modelsUnarchive } from "@mistralai/mistralai/funcs/modelsUnarchive.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsUnarchive(mistral, { - modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsUnarchive failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest](../../models/operations/jobsapiroutesfinetuningunarchivefinetunedmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.UnarchiveFTModelOut](../../models/components/unarchiveftmodelout.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/ocr/README.md b/examples/sdks/mistral-typescript/docs/sdks/ocr/README.md deleted file mode 100644 index 481c81b6a..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/ocr/README.md +++ /dev/null @@ -1,92 +0,0 @@ -# Ocr -(*ocr*) - -## Overview - -OCR API - -### Available Operations - -* [process](#process) - OCR - -## process - -OCR - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.ocr.process({ - model: "CX-9", - document: { - documentUrl: "https://upset-labourer.net/", - type: "document_url", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { ocrProcess } from "@mistralai/mistralai/funcs/ocrProcess.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await ocrProcess(mistral, { - model: "CX-9", - document: { - documentUrl: "https://upset-labourer.net/", - type: "document_url", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("ocrProcess failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.OCRRequest](../../models/components/ocrrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.OCRResponse](../../models/components/ocrresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/docs/sdks/transcriptions/README.md b/examples/sdks/mistral-typescript/docs/sdks/transcriptions/README.md deleted file mode 100644 index 459e09582..000000000 --- a/examples/sdks/mistral-typescript/docs/sdks/transcriptions/README.md +++ /dev/null @@ -1,163 +0,0 @@ -# Transcriptions -(*audio.transcriptions*) - -## Overview - -API for audio transcription. - -### Available Operations - -* [complete](#complete) - Create Transcription -* [stream](#stream) - Create streaming transcription (SSE) - -## complete - -Create Transcription - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.audio.transcriptions.complete({ - model: "Model X", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { audioTranscriptionsComplete } from "@mistralai/mistralai/funcs/audioTranscriptionsComplete.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await audioTranscriptionsComplete(mistral, { - model: "Model X", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("audioTranscriptionsComplete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.AudioTranscriptionRequest](../../models/components/audiotranscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[components.TranscriptionResponse](../../models/components/transcriptionresponse.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | - -## stream - -Create streaming transcription (SSE) - -### Example Usage - - -```typescript -import { Mistral } from "@mistralai/mistralai"; - -const mistral = new Mistral({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const result = await mistral.audio.transcriptions.stream({ - model: "Camry", - }); - - for await (const event of result) { - // Handle the event - console.log(event); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript -import { MistralCore } from "@mistralai/mistralai/core.js"; -import { audioTranscriptionsStream } from "@mistralai/mistralai/funcs/audioTranscriptionsStream.js"; - -// Use `MistralCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistral = new MistralCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await audioTranscriptionsStream(mistral, { - model: "Camry", - }); - if (res.ok) { - const { value: result } = res; - for await (const event of result) { - // Handle the event - console.log(event); - } - } else { - console.log("audioTranscriptionsStream failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.AudioTranscriptionRequestStream](../../models/components/audiotranscriptionrequeststream.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[EventStream](../../models/.md)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | -| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/eslint.config.mjs b/examples/sdks/mistral-typescript/eslint.config.mjs deleted file mode 100644 index 67bccfec9..000000000 --- a/examples/sdks/mistral-typescript/eslint.config.mjs +++ /dev/null @@ -1,22 +0,0 @@ -import globals from "globals"; -import pluginJs from "@eslint/js"; -import tseslint from "typescript-eslint"; - -/** @type {import('eslint').Linter.Config[]} */ -export default [ - { files: ["**/*.{js,mjs,cjs,ts}"] }, - { languageOptions: { globals: globals.browser } }, - pluginJs.configs.recommended, - ...tseslint.configs.recommended, - { - rules: { - "no-constant-condition": "off", - "no-useless-escape": "off", - // Handled by typescript compiler - "@typescript-eslint/no-unused-vars": "off", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-empty-object-type": "off", - "@typescript-eslint/no-namespace": "off", - }, - }, -]; diff --git a/examples/sdks/mistral-typescript/examples/.env.template b/examples/sdks/mistral-typescript/examples/.env.template deleted file mode 100644 index 868c87936..000000000 --- a/examples/sdks/mistral-typescript/examples/.env.template +++ /dev/null @@ -1,10 +0,0 @@ -# Default auth -MISTRAL_API_KEY= - -# Azure auth -AZURE_ENDPOINT= -AZURE_API_KEY= - -# Google auth -GOOGLE_CLOUD_REGION= -GOOGLE_PROJECT_ID= diff --git a/examples/sdks/mistral-typescript/examples/.gitignore b/examples/sdks/mistral-typescript/examples/.gitignore deleted file mode 100644 index 2eea525d8..000000000 --- a/examples/sdks/mistral-typescript/examples/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.env \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/examples/README.md b/examples/sdks/mistral-typescript/examples/README.md deleted file mode 100644 index b373220d1..000000000 --- a/examples/sdks/mistral-typescript/examples/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# Examples - -Below is a guide how to run the examples if you have cloned this repo. - -## Prerequisites - -- Node.js v18+ - -## How to run the examples locally - -### Install the npm dependencies or the repository and the `examples` directory - -```properties -npm install && npm install --prefix examples -``` - -### Set your environment variables - -```properties -cp examples/.env.template examples/.env -# Edit your .env file -``` - -### [Dev only] Link the local `mistralai` package - -If you want to use the local `mistralai` package, you can link it to the examples directory. From the repository's root: - -```properties -npm run build -npm link -(cd examples/src && npm link @mistralai/mistralai) -``` - -### Run the examples - -```properties -npm run test --prefix examples -``` - -If you just want to run one example file, you can do so with: - -```properties -npm run test --prefix examples -- --files src/stag_async_moderation.ts -``` diff --git a/examples/sdks/mistral-typescript/examples/package-lock.json b/examples/sdks/mistral-typescript/examples/package-lock.json deleted file mode 100644 index 6000c3c87..000000000 --- a/examples/sdks/mistral-typescript/examples/package-lock.json +++ /dev/null @@ -1,1352 +0,0 @@ -{ - "name": "chat", - "version": "1.0.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "chat", - "version": "1.0.0", - "license": "ISC", - "dependencies": { - "@mistralai/mistralai": "file:../", - "@mistralai/mistralai-azure": "file:../packages/mistralai-azure", - "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp", - "yargs": "^17.0.0" - }, - "devDependencies": { - "@types/node": "^20.11.4", - "glob": "^11.0.0", - "prettier": "3.3.3", - "tsx": "^4.7.0", - "typescript": "^5.9.2" - } - }, - "..": { - "name": "@mistralai/mistralai", - "version": "1.9.19", - "dependencies": { - "zod-to-json-schema": "^3.24.1" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "peerDependencies": { - "zod": ">= 3" - } - }, - "../packages/mistralai-azure": { - "name": "@mistralai/mistralai-azure", - "version": "1.6.0", - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "peerDependencies": { - "zod": ">= 3" - } - }, - "../packages/mistralai-gcp": { - "name": "@mistralai/mistralai-gcp", - "version": "1.5.0", - "dependencies": { - "google-auth-library": "^9.11.0" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "peerDependencies": { - "zod": ">= 3" - } - }, - "node_modules/@esbuild/aix-ppc64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.23.1.tgz", - "integrity": "sha512-6VhYk1diRqrhBAqpJEdjASR/+WVRtfjpqKuNw11cLiaWpAT/Uu+nokB+UJnevzy/P9C/ty6AOe0dwueMrGh/iQ==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "aix" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-arm": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.23.1.tgz", - "integrity": "sha512-uz6/tEy2IFm9RYOyvKl88zdzZfwEfKZmnX9Cj1BHjeSGNuGLuMD1kR8y5bteYmwqKm1tj8m4cb/aKEorr6fHWQ==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.23.1.tgz", - "integrity": "sha512-xw50ipykXcLstLeWH7WRdQuysJqejuAGPd30vd1i5zSyKK3WE+ijzHmLKxdiCMtH1pHz78rOg0BKSYOSB/2Khw==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/android-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.23.1.tgz", - "integrity": "sha512-nlN9B69St9BwUoB+jkyU090bru8L0NA3yFvAd7k8dNsVH8bi9a8cUAUSEcEEgTp2z3dbEDGJGfP6VUnkQnlReg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.23.1.tgz", - "integrity": "sha512-YsS2e3Wtgnw7Wq53XXBLcV6JhRsEq8hkfg91ESVadIrzr9wO6jJDMZnCQbHm1Guc5t/CdDiFSSfWP58FNuvT3Q==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/darwin-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.23.1.tgz", - "integrity": "sha512-aClqdgTDVPSEGgoCS8QDG37Gu8yc9lTHNAQlsztQ6ENetKEO//b8y31MMu2ZaPbn4kVsIABzVLXYLhCGekGDqw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.23.1.tgz", - "integrity": "sha512-h1k6yS8/pN/NHlMl5+v4XPfikhJulk4G+tKGFIOwURBSFzE8bixw1ebjluLOjfwtLqY0kewfjLSrO6tN2MgIhA==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/freebsd-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.23.1.tgz", - "integrity": "sha512-lK1eJeyk1ZX8UklqFd/3A60UuZ/6UVfGT2LuGo3Wp4/z7eRTRYY+0xOu2kpClP+vMTi9wKOfXi2vjUpO1Ro76g==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.23.1.tgz", - "integrity": "sha512-CXXkzgn+dXAPs3WBwE+Kvnrf4WECwBdfjfeYHpMeVxWE0EceB6vhWGShs6wi0IYEqMSIzdOF1XjQ/Mkm5d7ZdQ==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.23.1.tgz", - "integrity": "sha512-/93bf2yxencYDnItMYV/v116zff6UyTjo4EtEQjUBeGiVpMmffDNUyD9UN2zV+V3LRV3/on4xdZ26NKzn6754g==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ia32": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.23.1.tgz", - "integrity": "sha512-VTN4EuOHwXEkXzX5nTvVY4s7E/Krz7COC8xkftbbKRYAl96vPiUssGkeMELQMOnLOJ8k3BY1+ZY52tttZnHcXQ==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-loong64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.23.1.tgz", - "integrity": "sha512-Vx09LzEoBa5zDnieH8LSMRToj7ir/Jeq0Gu6qJ/1GcBq9GkfoEAoXvLiW1U9J1qE/Y/Oyaq33w5p2ZWrNNHNEw==", - "cpu": [ - "loong64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-mips64el": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.23.1.tgz", - "integrity": "sha512-nrFzzMQ7W4WRLNUOU5dlWAqa6yVeI0P78WKGUo7lg2HShq/yx+UYkeNSE0SSfSure0SqgnsxPvmAUu/vu0E+3Q==", - "cpu": [ - "mips64el" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-ppc64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.23.1.tgz", - "integrity": "sha512-dKN8fgVqd0vUIjxuJI6P/9SSSe/mB9rvA98CSH2sJnlZ/OCZWO1DJvxj8jvKTfYUdGfcq2dDxoKaC6bHuTlgcw==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-riscv64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.23.1.tgz", - "integrity": "sha512-5AV4Pzp80fhHL83JM6LoA6pTQVWgB1HovMBsLQ9OZWLDqVY8MVobBXNSmAJi//Csh6tcY7e7Lny2Hg1tElMjIA==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-s390x": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.23.1.tgz", - "integrity": "sha512-9ygs73tuFCe6f6m/Tb+9LtYxWR4c9yg7zjt2cYkjDbDpV/xVn+68cQxMXCjUpYwEkze2RcU/rMnfIXNRFmSoDw==", - "cpu": [ - "s390x" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/linux-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.23.1.tgz", - "integrity": "sha512-EV6+ovTsEXCPAp58g2dD68LxoP/wK5pRvgy0J/HxPGB009omFPv3Yet0HiaqvrIrgPTBuC6wCH1LTOY91EO5hQ==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/netbsd-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.23.1.tgz", - "integrity": "sha512-aevEkCNu7KlPRpYLjwmdcuNz6bDFiE7Z8XC4CPqExjTvrHugh28QzUXVOZtiYghciKUacNktqxdpymplil1beA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.23.1.tgz", - "integrity": "sha512-3x37szhLexNA4bXhLrCC/LImN/YtWis6WXr1VESlfVtVeoFJBRINPJ3f0a/6LV8zpikqoUg4hyXw0sFBt5Cr+Q==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/openbsd-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.23.1.tgz", - "integrity": "sha512-aY2gMmKmPhxfU+0EdnN+XNtGbjfQgwZj43k8G3fyrDM/UdZww6xrWxmDkuz2eCZchqVeABjV5BpildOrUbBTqA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/sunos-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.23.1.tgz", - "integrity": "sha512-RBRT2gqEl0IKQABT4XTj78tpk9v7ehp+mazn2HbUeZl1YMdaGAQqhapjGTCe7uw7y0frDi4gS0uHzhvpFuI1sA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-arm64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.23.1.tgz", - "integrity": "sha512-4O+gPR5rEBe2FpKOVyiJ7wNDPA8nGzDuJ6gN4okSA1gEOYZ67N8JPk58tkWtdtPeLz7lBnY6I5L3jdsr3S+A6A==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-ia32": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.23.1.tgz", - "integrity": "sha512-BcaL0Vn6QwCwre3Y717nVHZbAa4UBEigzFm6VdsVdT/MbZ38xoj1X9HPkZhbmaBGUD1W8vxAfffbDe8bA6AKnQ==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@esbuild/win32-x64": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.23.1.tgz", - "integrity": "sha512-BHpFFeslkWrXWyUPnbKm+xYYVYruCinGcftSBaa8zoF9hZO4BcSCFUvHVTtzpIY6YzUnYtuEhZ+C9iEXjxnasg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/@isaacs/cliui": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, - "license": "ISC", - "dependencies": { - "string-width": "^5.1.2", - "string-width-cjs": "npm:string-width@^4.2.0", - "strip-ansi": "^7.0.1", - "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", - "wrap-ansi": "^8.1.0", - "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@mistralai/mistralai": { - "resolved": "..", - "link": true - }, - "node_modules/@mistralai/mistralai-azure": { - "resolved": "../packages/mistralai-azure", - "link": true - }, - "node_modules/@mistralai/mistralai-gcp": { - "resolved": "../packages/mistralai-gcp", - "link": true - }, - "node_modules/@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, - "license": "MIT", - "optional": true, - "engines": { - "node": ">=14" - } - }, - "node_modules/@types/node": { - "version": "20.16.5", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.16.5.tgz", - "integrity": "sha512-VwYCweNo3ERajwy0IUlqqcyZ8/A7Zwa9ZP3MnENWcB11AejO+tLy3pu850goUW2FC/IJMdZUfKpX/yxL1gymCA==", - "dev": true, - "license": "MIT", - "dependencies": { - "undici-types": "~6.19.2" - } - }, - "node_modules/ansi-regex": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", - "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/cliui": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", - "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", - "license": "ISC", - "dependencies": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.1", - "wrap-ansi": "^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/cliui/node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/cliui/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/cliui/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "license": "MIT" - }, - "node_modules/cliui/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/cliui/node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/cliui/node_modules/wrap-ansi": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "license": "MIT" - }, - "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true, - "license": "MIT" - }, - "node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true, - "license": "MIT" - }, - "node_modules/esbuild": { - "version": "0.23.1", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.23.1.tgz", - "integrity": "sha512-VVNz/9Sa0bs5SELtn3f7qhJCDPCF5oMEl5cO9/SSinpE9hbPVvxbd572HH5AKiP7WD8INO53GgfDDhRjkylHEg==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, - "engines": { - "node": ">=18" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.23.1", - "@esbuild/android-arm": "0.23.1", - "@esbuild/android-arm64": "0.23.1", - "@esbuild/android-x64": "0.23.1", - "@esbuild/darwin-arm64": "0.23.1", - "@esbuild/darwin-x64": "0.23.1", - "@esbuild/freebsd-arm64": "0.23.1", - "@esbuild/freebsd-x64": "0.23.1", - "@esbuild/linux-arm": "0.23.1", - "@esbuild/linux-arm64": "0.23.1", - "@esbuild/linux-ia32": "0.23.1", - "@esbuild/linux-loong64": "0.23.1", - "@esbuild/linux-mips64el": "0.23.1", - "@esbuild/linux-ppc64": "0.23.1", - "@esbuild/linux-riscv64": "0.23.1", - "@esbuild/linux-s390x": "0.23.1", - "@esbuild/linux-x64": "0.23.1", - "@esbuild/netbsd-x64": "0.23.1", - "@esbuild/openbsd-arm64": "0.23.1", - "@esbuild/openbsd-x64": "0.23.1", - "@esbuild/sunos-x64": "0.23.1", - "@esbuild/win32-arm64": "0.23.1", - "@esbuild/win32-ia32": "0.23.1", - "@esbuild/win32-x64": "0.23.1" - } - }, - "node_modules/escalade": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", - "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/foreground-child": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz", - "integrity": "sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==", - "dev": true, - "license": "ISC", - "dependencies": { - "cross-spawn": "^7.0.0", - "signal-exit": "^4.0.1" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/fsevents": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", - "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, - "node_modules/get-caller-file": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", - "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "license": "ISC", - "engines": { - "node": "6.* || 8.* || >= 10.*" - } - }, - "node_modules/get-tsconfig": { - "version": "4.8.1", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.8.1.tgz", - "integrity": "sha512-k9PN+cFBmaLWtVz29SkUoqU5O0slLuHJXt/2P+tMVFT+phsSGXGkp9t3rQIqdz0e+06EHNGs3oM6ZX1s2zHxRg==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve-pkg-maps": "^1.0.0" - }, - "funding": { - "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" - } - }, - "node_modules/glob": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-11.0.0.tgz", - "integrity": "sha512-9UiX/Bl6J2yaBbxKoEBRm4Cipxgok8kQYcOPEhScPwebu2I0HoQOuYdIO6S3hLuWoZgpDpwQZMzTFxgpkyT76g==", - "dev": true, - "license": "ISC", - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^4.0.1", - "minimatch": "^10.0.0", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^2.0.0" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "engines": { - "node": "20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true, - "license": "ISC" - }, - "node_modules/jackspeak": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.0.1.tgz", - "integrity": "sha512-cub8rahkh0Q/bw1+GxP7aeSe29hHHn2V4m29nnDlvCdlgU+3UGxkZp7Z53jLUdpX3jdTO0nJZUDl3xvbWc2Xog==", - "dev": true, - "license": "BlueOak-1.0.0", - "dependencies": { - "@isaacs/cliui": "^8.0.2" - }, - "engines": { - "node": "20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" - } - }, - "node_modules/lru-cache": { - "version": "11.0.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.0.1.tgz", - "integrity": "sha512-CgeuL5uom6j/ZVrg7G/+1IXqRY8JXX4Hghfy5YE0EhoYQWvndP1kufu58cmZLNIDKnRhZrXfdS9urVWx98AipQ==", - "dev": true, - "license": "ISC", - "engines": { - "node": "20 || >=22" - } - }, - "node_modules/minimatch": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz", - "integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": "20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/minipass": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", - "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, - "node_modules/package-json-from-dist": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz", - "integrity": "sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw==", - "dev": true, - "license": "BlueOak-1.0.0" - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-scurry": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.0.tgz", - "integrity": "sha512-ypGJsmGtdXUOeM5u93TyeIEfEhM6s+ljAhrk5vAvSx8uyY/02OvrZnA0YNGUrPXfpJMgI1ODd3nwz8Npx4O4cg==", - "dev": true, - "license": "BlueOak-1.0.0", - "dependencies": { - "lru-cache": "^11.0.0", - "minipass": "^7.1.2" - }, - "engines": { - "node": "20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", - "dev": true, - "license": "MIT", - "bin": { - "prettier": "bin/prettier.cjs" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/prettier/prettier?sponsor=1" - } - }, - "node_modules/require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/resolve-pkg-maps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", - "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/signal-exit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/string-width-cjs": { - "name": "string-width", - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/string-width-cjs/node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/string-width-cjs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true, - "license": "MIT" - }, - "node_modules/string-width-cjs/node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/strip-ansi-cjs": { - "name": "strip-ansi", - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-ansi-cjs/node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/tsx": { - "version": "4.19.1", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.19.1.tgz", - "integrity": "sha512-0flMz1lh74BR4wOvBjuh9olbnwqCPc35OOlfyzHba0Dc+QNUeWX/Gq2YTbnwcWPO3BMd8fkzRVrHcsR+a7z7rA==", - "dev": true, - "license": "MIT", - "dependencies": { - "esbuild": "~0.23.0", - "get-tsconfig": "^4.7.5" - }, - "bin": { - "tsx": "dist/cli.mjs" - }, - "engines": { - "node": ">=18.0.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.3" - } - }, - "node_modules/typescript": { - "version": "5.9.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.2.tgz", - "integrity": "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A==", - "dev": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/undici-types": { - "version": "6.19.8", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", - "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", - "dev": true, - "license": "MIT" - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrap-ansi-cjs": { - "name": "wrap-ansi", - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true, - "license": "MIT" - }, - "node_modules/wrap-ansi-cjs/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/y18n": { - "version": "5.0.8", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", - "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", - "license": "ISC", - "engines": { - "node": ">=10" - } - }, - "node_modules/yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", - "license": "MIT", - "dependencies": { - "cliui": "^8.0.1", - "escalade": "^3.1.1", - "get-caller-file": "^2.0.5", - "require-directory": "^2.1.1", - "string-width": "^4.2.3", - "y18n": "^5.0.5", - "yargs-parser": "^21.1.1" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/yargs-parser": { - "version": "21.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "license": "ISC", - "engines": { - "node": ">=12" - } - }, - "node_modules/yargs/node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/yargs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "license": "MIT" - }, - "node_modules/yargs/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/yargs/node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - } - } -} diff --git a/examples/sdks/mistral-typescript/examples/package.json b/examples/sdks/mistral-typescript/examples/package.json deleted file mode 100644 index 05cb309fa..000000000 --- a/examples/sdks/mistral-typescript/examples/package.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "type": "module", - "name": "chat", - "version": "1.0.0", - "description": "", - "main": "main.js", - "scripts": { - "script": "tsx --env-file=.env", - "chat-streaming": "npm run script -- ./src/chat_streaming.ts", - "gcp": "npm run script -- ./src/gcp/async_chat_no_streaming.ts", - "azure": "npm run script -- ./src/azure/async_chat_no_streaming.ts", - "format": "prettier --write .", - "test": "tsx ./test.ts", - "build:examples": "echo 'skipping build examples'" - }, - "keywords": [], - "author": "", - "license": "ISC", - "dependencies": { - "@mistralai/mistralai": "file:../", - "@mistralai/mistralai-azure": "file:../packages/mistralai-azure", - "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp", - "yargs": "^17.0.0" - }, - "devDependencies": { - "@types/node": "^20.11.4", - "glob": "^11.0.0", - "prettier": "3.3.3", - "tsx": "^4.7.0", - "typescript": "^5.9.2" - } -} diff --git a/examples/sdks/mistral-typescript/examples/src/async_audio_transcription_stream.ts b/examples/sdks/mistral-typescript/examples/src/async_audio_transcription_stream.ts deleted file mode 100644 index e96f3d1ff..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_audio_transcription_stream.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const mistral = new Mistral({ apiKey: apiKey }); - -const stream = await mistral.audio.transcriptions.stream({ - model: "voxtral-mini-latest", - fileUrl: "https://docs.mistral.ai/audio/bcn_weather.mp3", -}); - -for await (const event of stream) { - process.stdout.write(JSON.stringify(event)); - process.stdout.write("\n"); -} diff --git a/examples/sdks/mistral-typescript/examples/src/async_chat_no_streaming.ts b/examples/sdks/mistral-typescript/examples/src/async_chat_no_streaming.ts deleted file mode 100644 index 47749cec8..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_chat_no_streaming.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const client = new Mistral({ apiKey: apiKey }); - -const chatResponse = await client.chat.complete({ - model: "mistral-tiny", - messages: [{ role: "user", content: "What is the best French cheese?" }], -}); - -console.log("Chat:", chatResponse); diff --git a/examples/sdks/mistral-typescript/examples/src/async_chat_prediction.ts b/examples/sdks/mistral-typescript/examples/src/async_chat_prediction.ts deleted file mode 100644 index 856584675..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_chat_prediction.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const client = new Mistral({ apiKey: apiKey }); - -const code = ` -class Cheese { - name: string = ""; - type: string = ""; - countryOfOrigin: string = ""; -} - -export default Cheese;`; - -const refactorPrompt = `Add a "price" property of type number to the Cheese class. Respond only with code, no explanation.`; - -const chatResponse = await client.chat.complete({ - model: "codestral-latest", - messages: [ - { role: "user", content: refactorPrompt }, - { role: "user", content: code }, - ], - prediction: { - type: "content", - content: code, - }, -}); - -console.log(chatResponse.choices[0]?.message.content); diff --git a/examples/sdks/mistral-typescript/examples/src/async_chat_streaming.ts b/examples/sdks/mistral-typescript/examples/src/async_chat_streaming.ts deleted file mode 100644 index b13aab7fe..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_chat_streaming.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const mistral = new Mistral({ apiKey: apiKey }); - -const stream = await mistral.chat.stream({ - model: "mistral-tiny", - messages: [ - { - role: "user", - content: "What is the best French cheese?", - }, - ], -}); - -for await (const event of stream) { - const content = event.data?.choices[0]?.delta.content; - if (!content) { - continue; - } - - process.stdout.write(content); -} diff --git a/examples/sdks/mistral-typescript/examples/src/async_chat_with_image_no_streaming.ts b/examples/sdks/mistral-typescript/examples/src/async_chat_with_image_no_streaming.ts deleted file mode 100644 index eded0db76..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_chat_with_image_no_streaming.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const client = new Mistral({ apiKey: apiKey }); - -const chatResponse = await client.chat.complete({ - model: "pixtral-12b", - messages: [ - { - role: "user", - content: [ - { type: "text", text: "What's in this image?" }, - { - type: "image_url", - imageUrl: - "https://mistral.ai/_next/image?url=https%3A%2F%2Fcms.mistral.ai%2Fassets%2Fce1514ab-62f9-4825-a20b-298f2497c536&w=3840&q=75", - }, - ], - }, - ], -}); - -console.log("JSON:", chatResponse.choices[0].message.content); diff --git a/examples/sdks/mistral-typescript/examples/src/async_conversation_agent.ts b/examples/sdks/mistral-typescript/examples/src/async_conversation_agent.ts deleted file mode 100644 index cee29ca88..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_conversation_agent.ts +++ /dev/null @@ -1,37 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const MODEL = "mistral-medium-latest"; - -const client = new Mistral({ apiKey: apiKey }); - -const agent = await client.beta.agents.create({ - model: MODEL, - name: "WebSearch Agent", - instructions: - "Use your websearch abilities when answering requests you don't know.", - description: "Agent able to fetch new information on the web.", - tools: [{ type: "web_search" }], -}); - -const startResult = await client.beta.conversations.start({ - agentId: agent.id, - inputs: "Who won the last Champions League?", -}); - -console.log("All result entries:"); -startResult.outputs.forEach((entry) => console.log("entry: ", entry)); - -const appendResult = await client.beta.conversations.append({ - conversationId: startResult.conversationId, - conversationAppendRequest: { - inputs: "And what about the previous year?", - }, -}); - -console.log("All result entries:"); -appendResult.outputs.forEach((entry) => console.log("entry: ", entry)); diff --git a/examples/sdks/mistral-typescript/examples/src/async_embeddings.ts b/examples/sdks/mistral-typescript/examples/src/async_embeddings.ts deleted file mode 100644 index 9fafde55a..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_embeddings.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const client = new Mistral({ apiKey: apiKey }); - -const inputs = []; -for (let i = 0; i < 1; i++) { - inputs.push("What is the best French cheese?"); -} - -const embeddingsBatchResponse = await client.embeddings.create({ - model: "mistral-embed", - inputs: inputs, -}); - -console.log("Embeddings Batch:", embeddingsBatchResponse.data); diff --git a/examples/sdks/mistral-typescript/examples/src/async_files.ts b/examples/sdks/mistral-typescript/examples/src/async_files.ts deleted file mode 100644 index 5d0c9312b..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_files.ts +++ /dev/null @@ -1,36 +0,0 @@ -import * as fs from "fs"; -import { Mistral } from "@mistralai/mistralai"; -import path from "path"; -import { fileURLToPath } from "url"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -// Get the absolute directory path -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); - -const client = new Mistral({ apiKey: apiKey }); - -// Create a new file -const filePath = path.join(__dirname, "file.jsonl"); -const blob = new Blob([fs.readFileSync(filePath)], { - type: "application/json", -}); -const createdFile = await client.files.upload({ file: blob }); - -console.log(createdFile); - -// List files -const files = await client.files.list(); -console.log(files); - -// Retrieve a file -const retrievedFile = await client.files.retrieve({ fileId: createdFile.id }); -console.log(retrievedFile); - -// Delete a file -const deletedFile = await client.files.delete({ fileId: createdFile.id }); -console.log(deletedFile); diff --git a/examples/sdks/mistral-typescript/examples/src/async_function_calling.ts b/examples/sdks/mistral-typescript/examples/src/async_function_calling.ts deleted file mode 100644 index feff5c6eb..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_function_calling.ts +++ /dev/null @@ -1,147 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; -import { UserMessage } from "@mistralai/mistralai/models/components/usermessage.js"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -// Assuming we have the following data -const data = { - transactionId: ["T1001", "T1002", "T1003", "T1004", "T1005"], - customerId: ["C001", "C002", "C003", "C002", "C001"], - paymentAmount: [125.5, 89.99, 120.0, 54.3, 210.2], - paymentDate: [ - "2021-10-05", - "2021-10-06", - "2021-10-07", - "2021-10-05", - "2021-10-08", - ], - paymentStatus: ["Paid", "Unpaid", "Paid", "Paid", "Pending"], -}; - -/** - * This function retrieves the payment status of a transaction id. - * @param {object} data - The data object. - * @param {string} transactionId - The transaction id. - * @return {string} - The payment status. - */ -function retrievePaymentStatus({ data, transactionId }) { - const transactionIndex = data.transactionId.indexOf(transactionId); - if (transactionIndex != -1) { - return JSON.stringify({ status: data.paymentStatus[transactionIndex] }); - } else { - return JSON.stringify({ status: "error - transaction id not found." }); - } -} - -/** - * This function retrieves the payment date of a transaction id. - * @param {object} data - The data object. - * @param {string} transactionId - The transaction id. - * @return {string} - The payment date. - * - */ -function retrievePaymentDate({ data, transactionId }) { - const transactionIndex = data.transactionId.indexOf(transactionId); - if (transactionIndex != -1) { - return JSON.stringify({ status: data.paymentDate[transactionIndex] }); - } else { - return JSON.stringify({ status: "error - transaction id not found." }); - } -} - -const namesToFunctions = { - retrievePaymentStatus: (transactionId) => - retrievePaymentStatus({ data, ...transactionId }), - retrievePaymentDate: (transactionId) => - retrievePaymentDate({ data, ...transactionId }), -}; - -const tools = [ - { - type: "function", - function: { - name: "retrievePaymentStatus", - description: "Get payment status of a transaction id", - parameters: { - type: "object", - required: ["transactionId"], - properties: { - transactionId: { type: "string", description: "The transaction id." }, - }, - }, - }, - }, - { - type: "function", - function: { - name: "retrievePaymentDate", - description: "Get payment date of a transaction id", - parameters: { - type: "object", - required: ["transactionId"], - properties: { - transactionId: { type: "string", description: "The transaction id." }, - }, - }, - }, - }, -]; - -const model = "mistral-large-latest"; - -const client = new Mistral({ apiKey: apiKey }); - -const messages = [ - { role: "user", content: "What's the status of my transaction?" }, -]; - -let response = await client.chat.complete({ - model: model, - messages: messages, - tools: tools, -}); - -messages.push({ - role: "assistant", - content: response.choices[0].message.content, -}); - -messages.push({ role: "user", content: "My transaction ID is T1001." }); - -response = await client.chat.complete({ - model: model, - messages: messages, - tools: tools, -}); - -messages.push(response.choices[0].message); - -const toolCalls = response.choices[0].message.toolCalls; -for (const toolCall of toolCalls) { - const functionName = toolCall.function.name; - const functionParams = JSON.parse(toolCall.function.arguments); - - console.log(`calling functionName: ${functionName}`); - console.log(`functionParams: ${toolCall.function.arguments}`); - const functionResult = namesToFunctions[functionName](functionParams); - - messages.push({ - role: "tool", - name: functionName, - content: functionResult, - toolCallId: toolCall.id, - }); -} -console.log(messages); -console.log(tools); - -response = await client.chat.complete({ - model: model, - messages: messages, - tools: tools, -}); - -console.log(response.choices[0].message.content); diff --git a/examples/sdks/mistral-typescript/examples/src/async_function_calling_streaming.ts b/examples/sdks/mistral-typescript/examples/src/async_function_calling_streaming.ts deleted file mode 100644 index 2573b8d20..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_function_calling_streaming.ts +++ /dev/null @@ -1,179 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; -import { ToolCall } from "@mistralai/mistralai/models/components/toolcall.js"; -import { AssisantMessage } from "@mistralai/mistralai/components/assistantmessage.js"; -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -// Assuming we have the following data -const data = { - transactionId: ["T1001", "T1002", "T1003", "T1004", "T1005"], - customerId: ["C001", "C002", "C003", "C002", "C001"], - paymentAmount: [125.5, 89.99, 120.0, 54.3, 210.2], - paymentDate: [ - "2021-10-05", - "2021-10-06", - "2021-10-07", - "2021-10-05", - "2021-10-08", - ], - paymentStatus: ["Paid", "Unpaid", "Paid", "Paid", "Pending"], -}; - -/** - * This function retrieves the payment status of a transaction id. - * @param {object} data - The data object. - * @param {string} transactionId - The transaction id. - * @return {string} - The payment status. - */ -function retrievePaymentStatus({ data, transactionId }) { - const transactionIndex = data.transactionId.indexOf(transactionId); - if (transactionIndex != -1) { - return JSON.stringify({ status: data.paymentStatus[transactionIndex] }); - } else { - return JSON.stringify({ status: "error - transaction id not found." }); - } -} - -/** - * This function retrieves the payment date of a transaction id. - * @param {object} data - The data object. - * @param {string} transactionId - The transaction id. - * @return {string} - The payment date. - * - */ -function retrievePaymentDate({ data, transactionId }) { - const transactionIndex = data.transactionId.indexOf(transactionId); - if (transactionIndex != -1) { - return JSON.stringify({ status: data.paymentDate[transactionIndex] }); - } else { - return JSON.stringify({ status: "error - transaction id not found." }); - } -} - -const namesToFunctions = { - retrievePaymentStatus: (transactionId) => - retrievePaymentStatus({ data, ...transactionId }), - retrievePaymentDate: (transactionId) => - retrievePaymentDate({ data, ...transactionId }), -}; - -const tools = [ - { - type: "function", - function: { - name: "retrievePaymentStatus", - description: "Get payment status of a transaction id", - parameters: { - type: "object", - required: ["transactionId"], - properties: { - transactionId: { type: "string", description: "The transaction id." }, - }, - }, - }, - }, - { - type: "function", - function: { - name: "retrievePaymentDate", - description: "Get payment date of a transaction id", - parameters: { - type: "object", - required: ["transactionId"], - properties: { - transactionId: { type: "string", description: "The transaction id." }, - }, - }, - }, - }, -]; - -const model = "mistral-small-latest"; - -const client = new Mistral({ apiKey: apiKey }); - -const messages = [ - { role: "user", content: "What's the status of my transaction?" }, -]; - -let stream = await client.chat.stream({ - model: model, - messages: messages, - tools: tools, -}); - -let full_content = ""; -for await (const event of stream) { - const content = event.data?.choices[0]?.delta.content; - if (!content) { - continue; - } - - full_content += content; - - process.stdout.write(content); -} -messages.push({ - role: "assistant", - content: full_content, -}); - -messages.push({ role: "user", content: "My transaction ID is T1001." }); - -stream = await client.chat.stream({ - model: model, - messages: messages, - tools: tools, -}); - -let full_tool_call: ToolCall[] = []; - -for await (const event of stream) { - const toolCalls = event.data?.choices[0]?.delta.toolCalls; - if (!toolCalls) { - continue; - } - full_tool_call = toolCalls; -} - -messages.push({ - role: "assistant", - toolCalls: full_tool_call, -}); - -const toolCalls = full_tool_call; -for (const toolCall of toolCalls) { - const functionName = toolCall.function.name; - const functionParams = JSON.parse(toolCall.function.arguments); - - console.log(`calling functionName: ${functionName}`); - console.log(`functionParams: ${toolCall.function.arguments}`); - const functionResult = namesToFunctions[functionName](functionParams); - - messages.push({ - role: "tool", - name: functionName, - content: functionResult, - toolCallId: toolCall.id, - }); -} -console.log(messages); -console.log(tools); - -stream = await client.chat.stream({ - model: model, - messages: messages, - tools: tools, -}); - -for await (const event of stream) { - const content = event.data?.choices[0]?.delta.content; - if (!content) { - continue; - } - - process.stdout.write(content); -} -console.log("\ndone"); diff --git a/examples/sdks/mistral-typescript/examples/src/async_jobs.ts b/examples/sdks/mistral-typescript/examples/src/async_jobs.ts deleted file mode 100644 index 18be59321..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_jobs.ts +++ /dev/null @@ -1,51 +0,0 @@ -import * as fs from "fs"; -import { Mistral } from "@mistralai/mistralai"; -import path from "path"; -import { fileURLToPath } from "url"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const mistral = new Mistral(); - -// Get the absolute directory path -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); -const filePath = path.join(__dirname, "file.jsonl"); - -// Create a new file -const blob = new Blob([fs.readFileSync(filePath)], { - type: "application/json", -}); -const createdFile = await mistral.files.upload({ file: blob }); - -// Create a new job -const hyperparameters = { - training_steps: 10, - learning_rate: 0.0001, -}; -const createdJob = await mistral.fineTuning.jobs.create({ - model: "open-mistral-7b", - trainingFiles: [{ fileId: createdFile.id, weight: 1 }], - validationFiles: [createdFile.id], - hyperparameters: hyperparameters, -}); -console.log(createdJob); - -// List jobs -const jobs = await mistral.fineTuning.jobs.list(); -console.log(jobs); - -// Retrieve a job -const retrievedJob = await mistral.fineTuning.jobs.get({ - jobId: createdJob.id, -}); -console.log(retrievedJob); - -// Cancel a job -const canceledJob = await mistral.fineTuning.jobs.cancel({ - jobId: createdJob.id, -}); -console.log(canceledJob); diff --git a/examples/sdks/mistral-typescript/examples/src/async_json_format.ts b/examples/sdks/mistral-typescript/examples/src/async_json_format.ts deleted file mode 100644 index c8e4334fb..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_json_format.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const mistral = new Mistral({ apiKey: apiKey }); - -const chatResponse = await mistral.chat.complete({ - model: "mistral-small-latest", - messages: [{ role: "user", content: "What is the best French cheese?" }], - responseFormat: { type: "json_object" }, -}); - -console.log("Chat:", chatResponse.choices[0].message.content); diff --git a/examples/sdks/mistral-typescript/examples/src/async_list_models.ts b/examples/sdks/mistral-typescript/examples/src/async_list_models.ts deleted file mode 100644 index 683a89178..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_list_models.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const mistral = new Mistral({ apiKey: apiKey }); - -const listModelsResponse = await mistral.models.list(); - -listModelsResponse.data.forEach((model) => { - console.log("Model:", model); -}); diff --git a/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_file.ts b/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_file.ts deleted file mode 100644 index 0b730104a..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_file.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; -import fs from "fs"; -import path from "path"; -import { fileURLToPath } from "url"; - -const apiKey = process.env.MISTRAL_API_KEY; - -const client = new Mistral({ apiKey: apiKey }); - -// Get the absolute directory path -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); -const filePath = path.join(__dirname, "ocr.pdf"); - -// Upload the file and run ocr -const uploaded_file = fs.readFileSync(filePath); -const uploaded_pdf = await client.files.upload({ - file: { - fileName: "uploaded_file.pdf", - content: uploaded_file, - }, - purpose: "ocr", -}); - -const ocrResponse = await client.ocr.process({ - model: "mistral-ocr-latest", - document: { - type: "file", - fileId: uploaded_pdf.id, - }, - includeImageBase64: true, -}); -console.log("OCR ", ocrResponse); diff --git a/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_url.ts b/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_url.ts deleted file mode 100644 index ee2baec02..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_ocr_process_from_url.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env.MISTRAL_API_KEY; -const client = new Mistral({ apiKey: apiKey }); - -const ocrResponse = await client.ocr.process({ - model: "mistral-ocr-latest", - document: { - type: "document_url", - documentUrl: "https://arxiv.org/pdf/2201.04234.pdf", - }, - includeImageBase64: true, -}); - -console.log("OCR:", ocrResponse); diff --git a/examples/sdks/mistral-typescript/examples/src/async_structured_outputs.ts b/examples/sdks/mistral-typescript/examples/src/async_structured_outputs.ts deleted file mode 100644 index 97d5005cc..000000000 --- a/examples/sdks/mistral-typescript/examples/src/async_structured_outputs.ts +++ /dev/null @@ -1,70 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; -import { z } from "zod"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const Explanation = z.object({ - explanation: z.string(), - output: z.string(), -}); - -const MathDemonstration = z.object({ - steps: z.array(Explanation), - final_answer: z.string(), -}); - -const client = new Mistral({ apiKey: apiKey }); - -// Structured Output using the parseStream method -// This method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. -// If you need to parse the stream, see the "Parse the accumulated stream back to the initial zod object" comment below. - -const stream = await client.chat.parseStream({ - model: "mistral-tiny-latest", - messages: [ - { - role: "system", - content: - "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.", - }, - { role: "user", content: "How can I solve 8x + 7 = -23" }, - ], - responseFormat: MathDemonstration, -}); - -let accumulatedStream = ""; -for await (const event of stream) { - const content = event.data?.choices[0]?.delta.content; - if (!content) { - continue; - } - process.stdout.write(content); - accumulatedStream += content; -} - -// Parse the accumulated stream back to the initial zod object. -let parsedAccumulatedStream = MathDemonstration.safeParse( - JSON.parse(accumulatedStream), -).data; -console.log("\n", parsedAccumulatedStream); - -// Structured Output using the parse method -// This method will return the response parsed back to the initial Zod object. - -const chatResponse = await client.chat.parse({ - model: "mistral-tiny-latest", - messages: [ - { - role: "system", - content: - "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.", - }, - { role: "user", content: "How can I solve 8x + 7 = -23" }, - ], - responseFormat: MathDemonstration, -}); - -console.log("\n", chatResponse.choices[0].message.parsed); diff --git a/examples/sdks/mistral-typescript/examples/src/azure/async_chat_no_streaming.ts b/examples/sdks/mistral-typescript/examples/src/azure/async_chat_no_streaming.ts deleted file mode 100644 index 89a197871..000000000 --- a/examples/sdks/mistral-typescript/examples/src/azure/async_chat_no_streaming.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const azureAPIKey = process.env["AZURE_API_KEY"]; -if (!azureAPIKey) { - throw new Error("missing AZURE_API_KEY environment variable"); -} - -const azureEndpoint = process.env["AZURE_ENDPOINT"]; -if (!azureEndpoint) { - throw new Error("missing AZURE_ENDPOINT environment variable"); -} - -const sdk = new MistralAzure({ - apiKey: azureAPIKey, - endpoint: azureEndpoint, -}); - -const chatResult = await sdk.chat.complete({ - messages: [ - { - role: "user", - content: "What is the best French cheese ?", - }, - ], -}); - -console.log("Success", chatResult); diff --git a/examples/sdks/mistral-typescript/examples/src/error_handling.ts b/examples/sdks/mistral-typescript/examples/src/error_handling.ts deleted file mode 100644 index 2be25bddb..000000000 --- a/examples/sdks/mistral-typescript/examples/src/error_handling.ts +++ /dev/null @@ -1,31 +0,0 @@ -import { Mistral } from "@mistralai/mistralai"; -import { SDKError } from "../../models/errors/index.js"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -if (!apiKey) { - throw new Error("missing MISTRAL_API_KEY environment variable"); -} - -const client = new Mistral({ apiKey: apiKey }); - -try { - const chatResponse = await client.chat.complete({ - model: "pixtral-12b", - messages: [ - { - role: "user", - content: "hello", - }, - { - role: "assistant", - content: "hey", - }, - ], - }); -} catch (e) { - if (e instanceof SDKError) { - process.stdout.write(e.message); - } else { - throw e; - } -} diff --git a/examples/sdks/mistral-typescript/examples/src/file.jsonl b/examples/sdks/mistral-typescript/examples/src/file.jsonl deleted file mode 100644 index 51bbfd460..000000000 --- a/examples/sdks/mistral-typescript/examples/src/file.jsonl +++ /dev/null @@ -1,3 +0,0 @@ -{"messages": [{"role": "system", "content": "Marv is a factual chatbot that is also sarcastic."}, {"role": "user", "content": "What's the capital of France?"}, {"role": "assistant", "content": "Paris, as if everyone doesn't know that already."}]} -{"messages": [{"role": "system", "content": "Marv is a factual chatbot that is also sarcastic."}, {"role": "user", "content": "Who wrote 'Romeo and Juliet'?"}, {"role": "assistant", "content": "Oh, just some guy named William Shakespeare. Ever heard of him?"}]} -{"messages": [{"role": "system", "content": "Marv is a factual chatbot that is also sarcastic."}, {"role": "user", "content": "How far is the Moon from Earth?"}, {"role": "assistant", "content": "Around 384,400 kilometers. Give or take a few, like that really matters.", "weight": 0}]} \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/examples/src/gcp/async_chat_no_streaming.ts b/examples/sdks/mistral-typescript/examples/src/gcp/async_chat_no_streaming.ts deleted file mode 100644 index cd4d05fff..000000000 --- a/examples/sdks/mistral-typescript/examples/src/gcp/async_chat_no_streaming.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const projectId = process.env["GOOGLE_PROJECT_ID"]; -if (!projectId) { - throw new Error("missing GOOGLE_PROJECT_ID environment variable"); -} - -const sdk = new MistralGoogleCloud({ - region: "europe-west4", - projectId: projectId, -}); - -const chatResult = await sdk.chat.complete({ - model: "mistral-large-2407", - messages: [ - { - role: "user", - content: "What is the best French cheese ?", - }, - ], -}); - -console.log("Success", chatResult); diff --git a/examples/sdks/mistral-typescript/examples/src/ocr.pdf b/examples/sdks/mistral-typescript/examples/src/ocr.pdf deleted file mode 100644 index c01805e89c1684e79130151abc23bb80401583a9..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 18810 zcmc({WmsIv+65XQKydc}jk~+M1r6@O-7UBi+}#~QZ~_E(cemhfA-KzJlF6LRnKS2n z_qjhV4SQF=rM*jd*Q!-bA}1_L!$8XfP13b>x^+-^mNnMZ1I-Me2UzQwL348h=%fs- zj2%n>EI^YyfKJrZ!okoEc(>4XFcdb_w>B^Y@bW_2JJ=cOT0%R6q^l3cd=*7*+Mv4a z3qB5;hvSXZo)0r7C$^2~IB0Ap8<(-8)>=QCWEg z?0(nN9)Icelh)1Z%-7YCn!8Bzr7LUB?@sAwWnVpRAKciyREM|tXk}WdZJ1iAcRU+Y ztS3s55RR+%GoFsI8vX8ibE#DJC?B;TcXp_*oNZQGFA(f^LVK^QF5Mj2S!&#_HokIQ zT_@h{A@z*Z?-{e6<9G~-vQi5z&~p#Le6L&E2%O`%FSpaGE?s&`xovO8RlnkWc+z#B z3*SMde=Uww=|%|Asbc6VBhh)2_S7)n8nMH*Gi#-cf3)~8)0o`Zx-~JpUWDUp*-X2+ zpm$(&r%!Ysq`obwd7wAS#kw~Eq4G&+$?H9&*xo0&man*9%a$)3`KERn*YWPoICymm z&G2O_zjj}$We!=JNGx^X1^Tl&FdVsFW$*77U~y_9khGE?J-o(WR%x8;qCE{o-dQ7M z-mZ%jJJKb+1D7hh(hQJ2C13OiLYUi=y}BOVY{v19fy#W*u&fDoYs9W1TZ!-d=2|VI zq7AA6M2x%N#~058EY%Y?r2u(1mW6pg-%4kha;eeZk!Iw=`(d-`$TN83VM?stGQI4? zS<8bRM6+(tFUhEZGx)gNegVYs=YE5fY<0K)Jrv=B84iZAFBPZ4l zg}PRtc_mr5UY>mrS!I-uquWlJ$A4K>(Z4$}nhv^uJ?j=r60zUXP?<_t2n zBvieLwS_%I=xffSuhzlb0GIJaPL(>L`*66P(8hJ3`}L0LCu$THxWZ=Urp5IsX?HyA zd9@pb7|g~s*a4_!b zk0byo3JTbohI@=>N9vpjd4UY=hq|)^RZolP9R1=k8-piZ$L>QnaU3TGlF}WnF2iy)lxL?(}1Tzof`y0EctF|M92$0lX}<+Z)*dQt4y%~qJU08 zJl6oQB_ni(tkEZ>%Zj-yECFQ>FVs#yZebm=$1~(nG{Ue&!nN}HQcyRee=Xo!NFD=N zWpbzmW9@V$@aScl-mDL7zK2i<%SkXxv;nn6hMH8i(FG`?6djl?x1tA~ zp-cEoObufO#kuYN--R?|B z6WCDAyXF=WnsEeeUCzs)k8)`2bAa@nBj<#I@qOa`6OriitR?s z1+U%$;pyCxbHrt6<0jRLn<^J<1{1PJlcI@_kvciS+%S<)|Hzpe*j7`t%wIW;lY#ba zkQsBXY65t) zVi)E^RRC29(Xso!fx7Qj=BxlNxpr+D%(;+?jyl9JVIL{70*TZBCWx7F)&oXql}Zjc zVT!1I8lazmTudEBofHn)JK+U2<@a%4&;!@NH^b^_ZOjgjHWu$E4CYJ*C(EE=v=Uyx zs~b3r7s<7NUsmVBo7#uet#%oLQdibuhiiV>8?{Q>yz|XnO^scU^#(80vrlq_RhR$*Dx!{#O-^E-8$FgLM_gj7O_74>#^NLs({B(#1DmFq zRLGp;*CtGzBtioM_bS-x%_m(kOSX&jF0rGnLWJB1hFFRtsG?F(F~O%SHNYeVAXJ&s@Q%U{W3MMgueC1_gT zZyaj4$|Fy&`*@Cak2Y^nQdYC8CFnAJSQU3C0&}6GsX5VBPY&%6sBa5ve??K!d_wHA zJ@Gp2Fz7MM+%bo$+Yi3n6uDU%CI3;7zR5|oncq;CcWCk{*ddCPnzxNz$AIXCY>pa_ zFY-8{Fa+MWXpSf;3>N}M&ggDx5jsW$WmT4kJH_v6qMOv+CX?B@-{^?^v8Rj0(4&^> z`;ZI!@lVEP5%?7m31>cjx=H3384$&-A>_9WW${!!e^aEbS8D<&;O8&R+~#GMlkwp0 zjuhJ^8$&`T@GqKzTYg&|ZR6dbNBC%IKEe*;blJ2?!6;AAF0UPhlYdSCrU)HWQ+ql$ z?C%dp)!s}cS|}G-yy@;u*ALxX4IHEntDX^Tj*qCg?n^5O?oq|R9$xd!WXPjhN0b{ z$i~u^JcZMBtnd=o7@3_{Fs7#;;g918a6EN=q!GFOGz%zfijqGEaG+yB=~ku>L?>)J z!{pV&Z&`wV@2nLsydf-LGY=&R(({l1NXM@#p?XORj~k!*RvGSX3;MW8wHjpa0^=kh z7+N$7CtfHmPTGP?kqQ~Jg-2Y*@GeCzND<{2cG1)BJoj`XmAF&8s9@u^Due6{xk$ZH z07){cy@gS(7E8BLwCShP{EO(lP74DGO4J)@xzND|J*e@P7x8rRWTn0Y{bH)5MzX_x zGz_{i3-6R-<1J(?>j|P#>`n_N8-%t$*rMtSiAQJ`beG~rmr9vM*l+9BvzT^y2a1-T zcWmqq&9z}mIas(BOg(1ZF_49*<9|i!FE1TS=yO#OHXn2d}|A(`Z9L?X?mnWv(w%~;5FuVKD@L|$KH;^c3shL1$3&f&14d(qZ#4& zy;|DplEGAxptQid=z7mk-W7Z_5Eu9arfjQfD?7YhjbK;QE_*LlOXP#KWCICrq@oFvU?A}+y=;8dL1M+C zMJgN^5;#ECVXbC^WZfAQ{>)NW6V=0l-Y9qQ*nUuJkjq%d4AOA*&qY z5^D)xipW2-mmBZ(X7)$6^6Lg3z(ZKI}KRi;nrm?-kLFcgWm%!fqy?rslb_`y+G%q0Om)>aW6Ck8^7ln(8T>W&6=cM`uSkMo@o!vdAU z$gw##qtZuz7vj|nc#K%tEn`jf%deOb>GK8-S&!>nL@spTN^BohYgMV**=1ja=s#_P z9}Pe1gnM>ge~iVA&;^N?w(-2h__yZ&ZL(kay8Bjmpnb=ubpJSiHjKAS- zMHd@G0G*t!@sF#Wp_K!G=_dx4H?+5Qw9_}V2eAG$2w7V>0ORce&$t~3(xnXzOmzjV zodFv3Km#iSBY=&AQ41P~)BmXFIo~gQFK1`1uVCl^&;V8@EDE4gG<0?VXaVSitSzkV z6l`?$4FS(IfRH@{fbB=|yu3j853KQrS(Jg69>D%=ho%!{0)`o$t9&L37=dp%er5Pq z)eH`pgyLxadyUdVyV~xI3ytH6JEri=h6Boj!I4zrAp_1xFil#z*10m01P@icg zlkT|ch}o#s5W8`GiI~sZuk$guX0Iw4H^AeC6XoC`;xYK{NtGVLj*pw}lg8W5*fug< zK7&A)nNs{qj538)H-8?M)e+RP?vsTOd~F&Kp({lqlQ4VfuE|*r`@Ep<3{zN1SE3vR zFbwY#KB2IAbLrx%eKLZs)VeDJx=n7N?R!G2e z^N!#tt-k-5)b_eQcyXBg3U3+-$2eEsN7*%8rAKz7{-pcb&;oPR+q1-J*3JECZv)M7 zww9OsCfs$AqpUd{M@d)N)(~dtsh80|a-NK%pnWo1P1StPX%iu3NU8#syvqxmH}N(G zMQL&R=v$o#@{k-awFOCoq@oqY)IN{jo08X5b1$51V!Ei+U)L#^H*h$=pCfd&ypdL^ zI{5H-d+B<&aEfO+@R5QXW%#qOQCy`)?&gy7*9W6$q)c|smYwDh_5Mc*5k$TK4t2^? zRHbuextT6&V|Y)TT2D>B{GAJd2W}{y(#-Ml-CU#=SOhYuY}~zh@J0s!9k63F_J#8UTLG zCwYL@uQbnV#INb~uO-C(pB9DZdF}|D%fN{zX=-2(Tm^p4MXhI6?~m1j;qPS%={o3I zSR4ObpX~own10Lg9|%N-KN!THbDjaf#LUF_zo&JnvZaZ}EEeyMrdmwCc)}(XMS_Le zY?YOP#7rT{d=Z~PZ`BsN{ry|6h7ZI}_v!P+i46okRu>(tj1Rk~#rYNZB)9>Bd({Gd zW|u@^9%EJb9~}8=4X6XqdN6bOV&Hl#zHz8jsRdF5NUx8(tX!p?Enji(c&tzfLJ<`9 z(ISaEnVQ?CHi>7npPFYiIoS6~3cEu+usRIyUoI&3G2X)LzK7ENUT(Rp9o}M9q(dng zbhLLnuzvcE%L8Mr0_I@yfZoKb`w_$g#r5uXW`yRh_*`iBDl3rfovQj&FKqFc7xcsV z%zCNiHil@H7wpnqO?PR$*Tbeh)p_CA##g$gI-%tpwpR?`S?{e^ROgpTKXB~Aj9t9w zPV|yNqH)2LxIWBqRd!kA3%yk;qQ2jxX z??LZ9Z0qw*iit>-L*7hj5Hbb8-SfVSdZX6uL0v{ZpmsfO!#C%_o!wjTuB*TshKxJ>#$p`nBQ=S$%yw*$r`5Hf-m6 z4`=s+C?R6x$gbn=IP6HU?gfQcqaWqXZu#DtJu=3zx>LNN>5cY`kf+kCwRvMnrm%kp zDj111lF@c-6~DHGf@yV+@WJJlF@}Hs0k)d}5tjkkKmv6SHN5*FM(I?8gldUvF~2eJ z%PtSkgOpbg?zD%gg|-fUwsLBpa&ld+8@Un+l3<@Dj03;BCTT;jpX27$@dJjp7M?>c zvBO*r5iUOhJp_3hgbmI$-Z8{6{4vNeflfnM-%wB(VO1DQ@-cm*i4iY|9-pM6NYeLv zvb~x;VfV`eFj+jf<%Ws$`s#S(d5=+*BkIv+#>sZP*Lh%{-(#?bC?Lc0L#-Ej3Ef}h z#fz13L})g?)Aw0-;p8qKr_3idM{eEOLqIqq^hoxMbqa+vb;TWyx9_VDD$-={mo%Js zNjn6Hwbz9}Fu-RG<2=?aKGg-ouO;HOSnY)PFBc`=SL!GuIGJ&iEkshUgva)hF2EI-H=HIMJoJu|a%IXQ0<{k60sT!t+sZ1|&(g8}*6+*GMSAjWOVw{iC>H*%W= z1JtjhJ$hhvewesBS34iMb2Ay4f@6_RZ}G@Y6lE8$>LB}Fvv2qc&^d)l&U39 zUxxu7&wyJx7Az;bbuzL4j>&)&5wl^bo#y)?E0tE(SoDMK!kFe#SL1uZfmG>g?c`Um zh3>AT9NZ9v&LON~w+ni?wiq;Z3Mj!kvTlAET;; zmzUy`_2`Y_rs?%Q5fF_YMk)sU^^`kImQEC#yW+K&EK(~v+fA%W854ZoDr~A)b3%A0 zDXUo1?rCqsS1XVLEg>=q4Uiap7CVY7!l}HYRhr{O<7ef`W5tc#jrN70Z}L5T&L$*Q z^re#}o3r;k=i@WJ(JV5C6qL&t(srethj%Jv(=ee+X^J<%%g@pZFW3*xXXIDD&`QZn zj}MGsL z9;_VB25SDY*Rnn2<*1ma)3W)ZH(o`t2Kl)DAYQO9810F6a`lYa+~YgKR-V!kjBHNL zoRP$Vpb@#&*Kgdya){;*5R8apO``8|n*$(>QuZ(MI`DAy4_BjZ1yM$CQuOC9J0TtN zJm|;mI2Y;gTf_?e>YdNz8jPdnxBPd|(r`Hvi=-x6iFRaS0WO779j~SY(#%>oY_OL@ zZ~Cl1tO0cUAZ*$##cp~HwZB4y+10!o+?_pr+nO+5Zg_5v^`I{L4?&18_Yd7nYJ%+d zaFj(&^XBr@N7bY}OWs6{rkKV?auSyB*%~$Srl*WlJG&Od7>_viLy$i14TNt` z33D^xS=;sWNHTLV;&6J=cwDOUuEJhcFL5Q2dmT9Gd9ow+Q3T5vR>$rXL$AH}E7!8z z^$;!X$kZj^dwO&_INALuMVN~(P_DAEg)&Fhqy&ZZ#pvQ#EZ$|9WEv%t;}&yIAtno6 zvr{XkATx^j05T!y<-AWlsa>GKOR)Y5(wdQ!@mJcUS4AI|b&;GBmoR1mygq4%8=#C@ zf_-{oJI)EX=H31@{?%-BW?e~y^n=lvy?yrm!1i!_dU$?!aD1XNr!m`mD{AdIRgIOk zai!*{0fg(PbQE6ExtDeji7CQYc%&|NNQO*)ulX-x$67%SUXtaWqU!Yye<12hiIC`g_1afcWe=T1M9r2$N(4mBf{msl*K} zoD3aI^>t+o9Sv!eEFA1~rJienrjr0VYo_`FR>l^FK<|)F!NJf{8Ndh(Ng3)Im|7VF z7}+C1h34`B{8!H|e7T^>9 z(}#Yp@~=Mh54=mK;Hc;D1C=Yzo3Dgr7v%7scZGi^1HYGd+UDz?4LmV zkG*^b06WwF$@f-sv(T7z;oH%Si4i{`2|+CyEF_Ov7eXcpK?p{sScs#RtfJx53yyeK zMc8ZiP1t2f+#B7|hgK+n#x(S3+DbBkR3nx!JhdZ$5H>i`Q5wghSf!*J8&fniM`#S* z1icz2p=-)>rMampja}gJRdD20n*Dd4ox7H^JMF+QrXKZq5z@+&{Ik&Fdz|%GqL1L` z&G|405Ncd4VO~fcOMBCeqhywik5~`o^rW;a9!G1FBW%mkYctgP=>bfGq3<8wQ>GaW zJ-Kjaa`}OD$`Ui(K6!gyC7&ViGCwGFwq`%spFgcHHcN(HJ)A38)1y1TdT8Fkz*k4x zm>@X!^7cH==sp`1;=1Av<;~D7ns&o?mir=hRagg}F~?JUMOR+NxS@M)+H8c_o5))_ z)HY)aS9Q}9#OOX4$uHYrxY^0cxj3fZLuv@uqaFttKIHF+>F0i}%CBssu<-q<@-yqU zH(vTsH)m3+iz*pjbaLWNQYLttVUS}b{ecnE1RJL8aLMO{`T%SDM-$6*>&G?D;#=*m zhKb;f=7X?8-}d16eG*S(+~^K|LjQy~Xc_Go!dOW3j+#|<8_O##^Y;GLbCw~SS_ZJP0l6nQ?mXGymvj>2 z^#KnsiL}aFk{i=0uc5)oXtk0x>KyVZ1I<{t4d>QTUwavKFRj)?apNG@t(1(|A=>MN zEG%FT2WJF*pw&{-h@AxlGa|#6+RtEm=beY4Cadmj*uyxObH9!;1-yn1Y!fRDsn?Ka zg2W(glL%sG@T`6#tr509uUug)uW0t@uV{9|PFdqg9lub^-Yk;ubZkKsU%RB8zZNOC zoA9C6I(IGf(+9d`(as1kO*;2%iZm8B~9J@{6qGVy}^53_@K40doXLhtn+ z2p+qQ9*yjAt;YgC>!%`A4jxjMkXK~Gic4fIKzM6{U+5R04|UNi@E#7;QRnol#Z)CC zkkqx*luo1BC68pV+!!R%njVYB&>Dt_+)tz-$FiZ4WsUT+q81lM7)TmCVu^t!o%}1xb7#x#ihrXA!wlCdh z+$P?@u-VO)>tnmKhg!9eWFYeC+d6rI61-Zo_mCy;MVu1C#cJ_mlCX^~M8v zz}o%JzXI-oZ@{ZO{y8)2ger<1!qmVScU`j9Ql}?qg4J6rV=uNt3w_PvDs)IkVzU$d z{7%^Eqkqf0Ah79z!`}Zo#K#IPZmdg+)9)jP;Ep)8pk7iIzVCKI+qf_7Sj+J` zJQ6D?#OL6dVe)ViyVWV;Qfai#t5Y9z%%iOSu5f)r^lA|n|0>yW2E-AIfV21w%fFcVc2bstBxl(IBXB zUwRAjX!79s2us7(!6jCQIX*+LAC3+|!@@FS(t*8BiP(#l$6`5*FhpUw@V2jDSbHn* zVDxl!eCj@mlWDjaa?%6JUa~}=Ybf4D=`Ne&QgM%m`$HtB8$nNj8WZP*9!l6R z5}9d5H1@gq1L?M_Fw32!ylQBz_)qB{moHkasq9J?uk8iS7sAE5A3jMnwoP`f_IDXs zZ3PRmTjK6DVi`0+6FzmcBiVNIOMkI3Xo^RG$2-(*DW<$e`KSDtqWe6^brtlT1|t|_I~*~s)&R2Zp}h|>mc=F~)j3tIwzmbibS z75_h9dR+`n4Cf^@Vzr6d}5>5=Z))+joqm;_*9Qc zC1cZrqw(I`53L>--dDQMZHr4&QI_x*?s%giB&R|O5qm>+RCkztT>7*?i0#}q9yOCa zr{7s)3?gCYu(|XtzHKCaFF8Kl=M&qP_cl7#@I6|iJBbCc{d@V`Pr4pe%$Zltr)MM) zJezNZxO^{CE9%T34Zx6R7@6ZT@c64YbSbE@oX>cd886}Z;*;WS218+3Gp{GQhAQZk9dB< zMGjSwc1(r=AMn$$$6~;FQMwRUzya)Y$@^vA%8Wsz z!EU;2dCxuS`w86Pt`muG#Bx8E>yQ?NX9M@*dIV&8y0RaAlAnJ4oK2V2UYN^*kkw~I zHLbWWa7qos--2-w@Pi^qHPJcNBYLz7NOhS7z{YOKZ8myZ>a*8(X4LRmhnDywajIZ; z`J+m+N`*86o$wb*$1uX{>9;#nsTT025nObN@rIRoOk9EYxlfQ^_kBwL2-f}{d}|SJ z1Rsk}NPp);F;R=3@}-lt$Wp~7wcqGo&a)G&9W}MXsf?g5Ix{Td)vSCyJKy?6#1KYv zfI}DgwXK+Y(|a4jJsV;&2)Eu1_>Q%rMR7YLD8x(&HFqew??o7{m+^X)6D=7%@tR5) z^tU)V%u+5%Uwqz_hrFSa+XJU;=Fi9Ycn%t`oizcY=<4&k(d>u)BP{y?|4U*hE)oHYRQ zm=X-KnqDn<1N2)9k9P|xwx_rI?c*sI5uhf~RKx3Vk)03FNJh5A7>S zg!dFdDhJ?P3$GPE;ec}czd^pi^&o%G1Y6YhLgx0RSIeXCNGxV}`yto<%9sWXHwd#;HW>%K)2WhZQQyq3V*g~H*X8JUU z50h;+*qAaujHSBI_Am6@g7GirLBEkrYtjU{P8GZ%o^NwRR*jhJ9MPyq8#E@r=|J!8 z@Z`@T) zu&c`iw}rG|dEZuTdr^oS!2`*lTkVjh=!+E}jbP>ftltqrll&d$lo44&L*6H`{~ zR6O|NIdV`O#XP5~2b=*PRH$(%0y$j@(D|%J8AK7}hEL0aC*KUZH$_?Hz868&pwPK` zvkxpyhiQq_qlnAteFULxQQgMXp-egXlJHf&(f%ga@>o-x(JeRLb3Ppte)`?|XOBs& z?>2l0FHrP#E+$u_M^N;>GP$66Z_d7IhY+ktY1X$iCjIKK)H|?M zy0|!=G}!Otd9C?P{oL#WPt==_Qe$J*B8_OFwd=%!T97zqK|N`Hv?M9xIp3lSYK>wi zQQx?#PhGr&Cgs=>${}LiM8T>WOtte+OlO67w4O1|r5EQp%nf|FD_u-2S0cV-WDUm` z+F&R>(WuE*xkQ14M4cmHEew;Vh=9w-@Cq%-KGDlPsp1r*YgkKNS_pMWB?L{^OG=gw z#>jghM@0rl)tjT1z=~%`sVlg46%5|j>VV7hw~cjpqwT-I>x}g24GY&;3N1M28m$n@ z4O$x+m%3Fbs@pwOWRV5@_WHEuO=>a`Zh~L(sb?gy1KaXO`?YY-EZ))g62AV%#`o~x zP7$-2+r4xMMyooLXF5?#Xjkz3c;vgp8GN)yd_gw|Lavv!;$-mFe&^WEa`!759YGI{ z{L$q({yq!qS@f*?vBfBESvCl$-`j_jr|Hz!FiMY&m9Isp?sL#Q$DvzI0^U`3{4|ID zG%KC`2(*ECnFyDOnK5_3jLmb`d|d;pcX~N#<8WiS^HwpzHZft>M1=;$O!LN(=IeNw z8V!~pi;x7;qi2?;Go+m^WJQYJilV*lsa+R@Ko~csRts~0>(E1dQLm`xW!j4kxwc3WS0&ZU^kt>sDS|7G zM1vulp~^)D148Q+E*cUJ^0q}AqY;Hv-tNBPSBaz3Rz4HCcgx)k@om^XDRRoHE%^Mc zeq-1qOLR__Rx&R+o;rFzFg1DYGK_&I%gf6^MB;=)?Cte()R& zV{co8RIFOQj~wmkRWoJ8Bh2Rr6c%&s#Z4k%@I^WlF3l(f1-OEZY_m3ZW9{-AT9kxk zvRj0rqG~^7n;OpWsbqu5pe~Xs`%a7**R--j zWt+|}p$>Mx*K6fGxy@hUX~3DN7+7N&@bL+?g7Zo}tn%zl4-=p5$xLU?m+X|&a{)tqw&N*UjtyiP^F6TnNmd1vglOS#4kedQDkgW1|9=v+W}xp6~^ zj!MEBVvbSvw!tnKOBmV%!QxzG)1J=iF{Ug@KdvXv?HoR1M}&32s~xl{kY$`_ii_9> zV@1L#rnK_vTH?{rGoW>31xe||<)q+TY0q(wXX*Wg+Xc>t+zsWri<3=XZm5P= z%s9qQ*?Qh?L`oMI6sj9*WLkRk9(G&gb&}sP8^QZ3!Vw_nx?o)?!hK;m*Uzdp{=T@_ z0v*AeII5-UX=7+=`~4K3`f8+X(PO*4=c~n8`R-HGSN9yuSj5|J*S(w}7Wt47B;B`f ziQy_>2iNADl9c9O=6wbKc4RbZ@nLwqHQ1w%_v$m)A%Lsvh(Cd06df}L9}_VwnB)mx z8b(F^KQP75oZB;t$PDbrUt8%w()B-4i@(u=e=^0aKu-2|rWnZo{a=`3W~OJRm>HcwOXOj8%J0lCw#=`oe zOa@?m&woJG6Y%<6!*fl*Sm+f8q*DLydFKDphkvD* zp?{1v`9CSlPlRyUQ^RLDdyX!d2z71z~*k5#~l z?%eH)+erOR#@W-8=TmPb6p8;_pJ_+zL^R4-ar1}|Mc91=;y$OH8O@u8W0G@OOeUH# z+Vowg!$-7RFA{&QFAn!*-8Vj0dd}zU1gAZx9rxpGgq6I4nv+SH8a>|h#x8IV<=Ob} zcq^TZ53TIjZe?@%JnlE6Z&uYebix+33#tkj=9$lmRCXVJzZ;i4VCO+wZZ*|y-6=uNBAQr-n5s|3gWYa}SI z!R#T@>^&0)_xvUSgxt=2hOzvt?!w$g*6Xga=6F?>20X15dk3Bdss?T^ht9aM@6Ht! z+TX&hqCDc!G>xeSM2oN&t!NdCJ5_tTX4PNU^)#iBeP$WkHf=#gF; zjF+g$I#ON^IjbAYi>$y(VG7$O&l)HjW<4<>6~IH;9S6V(qF?}bRUA~+kdpmY943Sk zU^;QS7xm_Ah+Y}oz6599=@XRvov}~#1(U%3+{`(&c>36UJHSy3cVe#aMMJpF9_6b{ zRzzM8H2)=hp`;sDv8tercK})!Ld4)UN!K-*W{(G`?jqu}kXWl}naRl-u022H+k%=8 zY;%Fg_+?kI`p)I?7Hc7B4FaEY%b&1QB5#Zy?jm)=h+df-AsvC91|+(h!lbfa1pDew zNj-Xx93Wa*F$c-n#=IZ~$MQY&Q6!*>Y6Pr!rv-3>xxk;|1aW_nxKFHTg$R zT)1HMp|#TPN3Ziq=g|yns3|EN9x0OL7S({~b0Ef{rg^8*=)4kJPI|Shu|=yn@~vT` za(+C%XlhI8sI545rKzUN4tLTE>NYeFY5s~fSwlC;{ZU~(bnejBX ztgC^iA>6ldy%}NS@C~96%N{)+Xl^w|q~91MG<}h{>;y;PKTSlON_60h_70uu5&@+} zwgHA-Y7(y!f?z<^iMRb`!cBaT>vlr|MdR{zTi(O&xWx?DXO4IqzZqQ3lhSSiq3+C} ze~SEiN|5wqfmlM&E=ns3EJ~!0qHmTUlD`Gv25QqKh#T_aoxp}Qq7{4wCwy8`VMM2b zSkhA#Pe+p&)iDGedV37&VN)SZhv~fLvT-3^c>;|*SGXf7q!W6byU#37!{kUZIO_r! z!ffDKKn_RRh=`_HU|}v%m27By)f)emIQLaIK#YP75jMz|SX?_+30+z~6mb;ot3qri z<#25cUdpAD$dXpTl5Q$8oW@?I38~3v_72|CL9=}2P%_@6H`|=J4_Go4FfR6d`Myir zvha>vOwBw;stwKgG)fKMSFe}R-%&>mT)&L4LzkH1Aa%02N3fxeradi}o`5r$M1*8V zhl>!gp=RYkZ?Amy9P-sidL6o|`m&dh{a>cHJ4xP5zDkYlYFrE7ObTI-Yr47YSYH^9&t3xXY#W{g6T$NMU!O-?brnKV4#F*|mKpRi34M`X z_m`kHS_)FhJ9YC>%~2Zt8X~H0-^)7e->M&J+Bp5=3Z;^$tT-I&9At=>{WaBG#dfCd6}~y$-g= zke=4h7AtJ<*;F-B*HML=nux-3u_IrP zP4Ky^lUoTnzUY%vP*%>N<IQh#&eb$2W_^Et#)SJZ2>erTcC^~gQRe(%yFW(QA?)%GIsKtB!Taf^&= zPOVEu&~6JoR8X1@8hAaL3pYUKO z2z9D$A#^pjJ*WlN9rP3%^;c+7IqZpfFtM~U6dxYksl~nF=#W1pG+VGIPJA(*hnaZ-Sc<;~MA7Oi#R2ATxx3^FK z-Dq!Azbgvjpr+sgdumpv8RCFNwY=RGZpOSq+wTIq%< zxmr5Lv+bh1crRI@Ht9Y{gU)U0qdS4pN4<5EJA>I3WfvG+V-H=AMDgu@@hOlBwa&!q zJy50+BX?U4r3Umq+ZqhHt%;6Dc2Ch9yzW1_KC8B7cy5(Z1*m`nJDY3zB|C`7O);=o8f!R9B~PpLPeEZ1GPH)6`9GU&3}`4OID)UP=&VZEvj<}<;q zOmSTTId58-W*@hbrz5u0MOZ%dfZtzsn1+O}`@O%;oN1KkbEvCTTrp4Sa4W}*#8zSR zNHw6~Vss9UyaQpd2kD~_PYJUZeDII~I6*hny)aw0|8Sgp@m?*HYU*8qSJ~{b49){b zCn^*`__oi_AXan_^GmE-?Dvh#)i2i=QV6ML+X@LzgQkP#QgoXi8r#6kOocS=aXxHw zaO=y?Lw#79UlDvOXmlAVqaxZ!h8~fruBySo==IR?4JLUnK7Xr*$Na2UB|-~`bu%Qq!ntFV*nlaKo#>12kCK2aHjlbaBXLRQ3gtCeVWcwYPfM2V|bkX@fX$iJiG zA8_Fr`!LZnbNq>pf0vE_cO4bWzv-y{0UdL&{zXT{OwaKrI_3ayu>4g=C8s1Hr7G~B z(D6@f{8u3r&9frsrA#`m-=$PPV5Cf|pRw@I@_wS=zv5tE%pU@+ zpYp9=sQk|o|Ax2!jQPj<{~^WyZzVA^Gye%8Wnp1r0T=;(+8Ee4o>`#hAAr>#HhLxwb|A6w zR~rjG8<5!etBs!idBXnH#>Bz;HyblOJ8&lbH6086GdJ~D8yg49zuOqt*qHyleGE*j z9DlEa5xAuNTX`(>&tk&A*1^K?JgfiB#z_A+8yhp*-|Apv26AfumY0o<1-O>{wLEqP z=6^4bf$2ZmfD7hd^D;0oKacCbl*hot&i1!-z@hQCI@tdHOc~gi=zsehKq)LxvugL_ z`-~J!T@8U_13)KlZ4Es4^apJvVP#|uJOuTF!jcdM9)sd$HsoLi{)b@E)iq*ZVr1rE xH)3U>H)PW@Fl5y?&}TH_h5p}3fafTI`dE7h;JE)WC>hv+MM0C0h{%dU|35{Ppxgie diff --git a/examples/sdks/mistral-typescript/examples/test.ts b/examples/sdks/mistral-typescript/examples/test.ts deleted file mode 100644 index 4640202fe..000000000 --- a/examples/sdks/mistral-typescript/examples/test.ts +++ /dev/null @@ -1,54 +0,0 @@ -import { execSync } from "node:child_process"; -import { globSync } from "glob"; -import yargs from "yargs/yargs"; -import { hideBin } from "yargs/helpers"; - -type Result = { - file: string; - success: boolean; -}; - -const results: Result[] = []; - -// Parse command-line arguments -const argv = yargs(hideBin(process.argv)) - .option("files", { - alias: "f", - description: "Specify files to test", - type: "array", - }) - .help() - .alias("help", "h").argv; - -const filesFromArgs = argv.files; - -// If no files are specified, run all tests -const files = - filesFromArgs && filesFromArgs.length > 0 - ? filesFromArgs - : globSync("src/**/*.ts"); - -for (const file of files) { - try { - execSync(`npm run script -- ${file}`, { stdio: "inherit" }); - results.push({ file, success: true }); - } catch (error) { - results.push({ file, success: false }); - } -} - -const failedCount = results.filter((x) => !x.success).length; - -if (failedCount > 0) { - console.log(`❌ ${failedCount}/${results.length} examples failed to run:`); -} else { - console.log(`🎉 All examples ran successfully!`); -} - -for (const result of results) { - console.log(` - ${result.success ? "✅" : "❌"} ${result.file}`); -} - -if (failedCount > 0) { - process.exit(1); -} diff --git a/examples/sdks/mistral-typescript/examples/tsconfig.json b/examples/sdks/mistral-typescript/examples/tsconfig.json deleted file mode 100644 index 3f73d1d31..000000000 --- a/examples/sdks/mistral-typescript/examples/tsconfig.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2018", - "lib": ["ES2022", "DOM", "DOM.Iterable"], - - "module": "Node16", - "moduleResolution": "Node16", - - "allowJs": true, - - "declaration": true, - "declarationMap": true, - "sourceMap": true, - "outDir": ".", - - // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json - "strict": true, - "allowUnusedLabels": false, - "allowUnreachableCode": false, - "exactOptionalPropertyTypes": true, - "useUnknownInCatchVariables": true, - "noFallthroughCasesInSwitch": true, - "noImplicitOverride": true, - "noImplicitReturns": true, - "noPropertyAccessFromIndexSignature": true, - "noUncheckedIndexedAccess": true, - "noUnusedLocals": true, - "noUnusedParameters": true, - "isolatedModules": true, - "checkJs": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true - }, - "include": ["src", "test.ts"], - "exclude": ["node_modules"] -} diff --git a/examples/sdks/mistral-typescript/jsr.json b/examples/sdks/mistral-typescript/jsr.json deleted file mode 100644 index aded0010f..000000000 --- a/examples/sdks/mistral-typescript/jsr.json +++ /dev/null @@ -1,28 +0,0 @@ - - -{ - "name": "@mistralai/mistralai", - "version": "1.10.0", - "exports": { - ".": "./src/index.ts", - "./models/errors": "./src/models/errors/index.ts", - "./models/components": "./src/models/components/index.ts", - "./models/operations": "./src/models/operations/index.ts", - "./lib/config": "./src/lib/config.ts", - "./lib/http": "./src/lib/http.ts", - "./lib/retries": "./src/lib/retries.ts", - "./lib/sdks": "./src/lib/sdks.ts", - "./lib/event-streams": "./src/lib/event-streams.ts", - "./types": "./src/types/index.ts" - }, - "publish": { - "include": [ - "LICENSE", - "README.md", - "RUNTIMES.md", - "USAGE.md", - "jsr.json", - "src/**/*.ts" - ] - } -} diff --git a/examples/sdks/mistral-typescript/package-lock.json b/examples/sdks/mistral-typescript/package-lock.json deleted file mode 100644 index 7b7076c50..000000000 --- a/examples/sdks/mistral-typescript/package-lock.json +++ /dev/null @@ -1,1877 +0,0 @@ -{ - "name": "@mistralai/mistralai", - "version": "1.10.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "@mistralai/mistralai", - "version": "1.10.0", - "dependencies": { - "zod": "^3.20.0", - "zod-to-json-schema": "^3.24.1" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "~5.8.3", - "typescript-eslint": "^8.26.0" - } - }, - "node_modules/@eslint-community/eslint-utils": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", - "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eslint-visitor-keys": "^3.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "peerDependencies": { - "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" - } - }, - "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.0.0 || ^14.0.0 || >=16.0.0" - } - }, - "node_modules/@eslint/config-array": { - "version": "0.19.2", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.2.tgz", - "integrity": "sha512-GNKqxfHG2ySmJOBSHg7LxeUx4xpuCoFjacmlCoYWEbaPXLwvfIjixRI12xCQZeULksQb23uiA8F40w5TojpV7w==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/object-schema": "^2.1.6", - "debug": "^4.3.1", - "minimatch": "^3.1.2" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/config-array/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/config-array/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/config-helpers": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.1.0.tgz", - "integrity": "sha512-kLrdPDJE1ckPo94kmPPf9Hfd0DU0Jw6oKYrhe+pwSC0iTUInmTa+w6fw8sGgcfkFJGNdWOUeOaDM4quW4a7OkA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/core": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.12.0.tgz", - "integrity": "sha512-cmrR6pytBuSMTaBweKoGMwu3EiHiEC+DoyupPmlZ0HxBJBtIxwe+j/E4XPIKNx+Q74c8lXKPwYawBf5glsTkHg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@types/json-schema": "^7.0.15" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/eslintrc": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.0.tgz", - "integrity": "sha512-yaVPAiNAalnCZedKLdR21GOGILMLKPyqSLWaAjQFvYA2i/ciDi8ArYVr69Anohb6cH2Ukhqti4aFnYyPm8wdwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "^6.12.4", - "debug": "^4.3.2", - "espree": "^10.0.1", - "globals": "^14.0.0", - "ignore": "^5.2.0", - "import-fresh": "^3.2.1", - "js-yaml": "^4.1.0", - "minimatch": "^3.1.2", - "strip-json-comments": "^3.1.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/eslintrc/node_modules/globals": { - "version": "14.0.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", - "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@eslint/eslintrc/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/js": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.22.0.tgz", - "integrity": "sha512-vLFajx9o8d1/oL2ZkpMYbkLv8nDB6yaIwFNt7nI4+I80U/z03SxmfOMsLbvWr3p7C+Wnoh//aOu2pQW8cS0HCQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/object-schema": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", - "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/plugin-kit": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.2.7.tgz", - "integrity": "sha512-JubJ5B2pJ4k4yGxaNLdbjrnk9d/iDz6/q8wOilpIowd6PJPgaxCuHBnBszq7Ce2TyMrywm5r4PnKm6V3iiZF+g==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/core": "^0.12.0", - "levn": "^0.4.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@humanfs/core": { - "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", - "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node": { - "version": "0.16.6", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", - "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@humanfs/core": "^0.19.1", - "@humanwhocodes/retry": "^0.3.0" - }, - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", - "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/module-importer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", - "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=12.22" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/retry": { - "version": "0.4.2", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.2.tgz", - "integrity": "sha512-xeO57FpIu4p1Ri3Jq/EXq4ClRm86dVF2z/+kvFnyqVYRavTZmaFaUBbWCOuuTh0o/g7DSsk6kc2vrS4Vl5oPOQ==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@types/estree": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", - "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@typescript-eslint/type-utils": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.26.1.tgz", - "integrity": "sha512-Kcj/TagJLwoY/5w9JGEFV0dclQdyqw9+VMndxOJKtoFSjfZhLXhYjzsQEeyza03rwHx2vFEGvrJWJBXKleRvZg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/typescript-estree": "8.26.1", - "@typescript-eslint/utils": "8.26.1", - "debug": "^4.3.4", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/types": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.26.1.tgz", - "integrity": "sha512-n4THUQW27VmQMx+3P+B0Yptl7ydfceUj4ON/AQILAASwgYdZ/2dhfymRMh5egRUrvK5lSmaOm77Ry+lmXPOgBQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.26.1.tgz", - "integrity": "sha512-yUwPpUHDgdrv1QJ7YQal3cMVBGWfnuCdKbXw1yyjArax3353rEJP1ZA+4F8nOlQ3RfS2hUN/wze3nlY+ZOhvoA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.26.1.tgz", - "integrity": "sha512-AjOC3zfnxd6S4Eiy3jwktJPclqhFHNyd8L6Gycf9WUPoKZpgM5PjkxY1X7uSy61xVpiJDhhk7XT2NVsN3ALTWg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/ts-api-utils": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.0.1.tgz", - "integrity": "sha512-dnlgjFSVetynI8nzgJ+qF62efpglpWRk8isUEWZGWlJYySCTD6aKvbUDu+zbPeDakk3bg5H4XpitHukgfL1m9w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/@typescript-eslint/utils": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.26.1.tgz", - "integrity": "sha512-V4Urxa/XtSUroUrnI7q6yUTD3hDtfJ2jzVfeT3VK0ciizfK2q/zGC0iDh1lFMUZR8cImRrep6/q0xd/1ZGPQpg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.26.1", - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/typescript-estree": "8.26.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/scope-manager": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.26.1.tgz", - "integrity": "sha512-6EIvbE5cNER8sqBu6V7+KeMZIC1664d2Yjt+B9EWUXrsyWpxx4lEZrmvxgSKRC6gX+efDL/UY9OpPZ267io3mg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/types": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.26.1.tgz", - "integrity": "sha512-n4THUQW27VmQMx+3P+B0Yptl7ydfceUj4ON/AQILAASwgYdZ/2dhfymRMh5egRUrvK5lSmaOm77Ry+lmXPOgBQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.26.1.tgz", - "integrity": "sha512-yUwPpUHDgdrv1QJ7YQal3cMVBGWfnuCdKbXw1yyjArax3353rEJP1ZA+4F8nOlQ3RfS2hUN/wze3nlY+ZOhvoA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.26.1.tgz", - "integrity": "sha512-AjOC3zfnxd6S4Eiy3jwktJPclqhFHNyd8L6Gycf9WUPoKZpgM5PjkxY1X7uSy61xVpiJDhhk7XT2NVsN3ALTWg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/ts-api-utils": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.0.1.tgz", - "integrity": "sha512-dnlgjFSVetynI8nzgJ+qF62efpglpWRk8isUEWZGWlJYySCTD6aKvbUDu+zbPeDakk3bg5H4XpitHukgfL1m9w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/acorn": { - "version": "8.14.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", - "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", - "dev": true, - "license": "MIT", - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-jsx": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", - "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true, - "license": "Python-2.0" - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true, - "license": "MIT" - }, - "node_modules/cross-spawn": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/debug": { - "version": "4.3.5", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", - "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/deep-is": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", - "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.22.0.tgz", - "integrity": "sha512-9V/QURhsRN40xuHXWjV64yvrzMjcz7ZyNoF2jJFmy9j/SLk0u1OLSZgXi28MrXjymnjEGSR80WCdab3RGMDveQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", - "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.19.2", - "@eslint/config-helpers": "^0.1.0", - "@eslint/core": "^0.12.0", - "@eslint/eslintrc": "^3.3.0", - "@eslint/js": "9.22.0", - "@eslint/plugin-kit": "^0.2.7", - "@humanfs/node": "^0.16.6", - "@humanwhocodes/module-importer": "^1.0.1", - "@humanwhocodes/retry": "^0.4.2", - "@types/estree": "^1.0.6", - "@types/json-schema": "^7.0.15", - "ajv": "^6.12.4", - "chalk": "^4.0.0", - "cross-spawn": "^7.0.6", - "debug": "^4.3.2", - "escape-string-regexp": "^4.0.0", - "eslint-scope": "^8.3.0", - "eslint-visitor-keys": "^4.2.0", - "espree": "^10.3.0", - "esquery": "^1.5.0", - "esutils": "^2.0.2", - "fast-deep-equal": "^3.1.3", - "file-entry-cache": "^8.0.0", - "find-up": "^5.0.0", - "glob-parent": "^6.0.2", - "ignore": "^5.2.0", - "imurmurhash": "^0.1.4", - "is-glob": "^4.0.0", - "json-stable-stringify-without-jsonify": "^1.0.1", - "lodash.merge": "^4.6.2", - "minimatch": "^3.1.2", - "natural-compare": "^1.4.0", - "optionator": "^0.9.3" - }, - "bin": { - "eslint": "bin/eslint.js" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://eslint.org/donate" - }, - "peerDependencies": { - "jiti": "*" - }, - "peerDependenciesMeta": { - "jiti": { - "optional": true - } - } - }, - "node_modules/eslint-scope": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.3.0.tgz", - "integrity": "sha512-pUNxi75F8MJ/GdeKtVLSbYg4ZI34J6C0C7sbL4YOp2exGwen7ZsuBqKzUhXd0qMQ362yET3z+uPwKeg/0C2XCQ==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^5.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/espree": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.3.0.tgz", - "integrity": "sha512-0QYC8b24HWY8zjRnDTL6RiHfDbAWn63qb4LMj1Z4b076A4une81+z03Kg7l7mn/48PUTqoLptSXez8oknU8Clg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "acorn": "^8.14.0", - "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/espree/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "estraverse": "^5.1.0" - }, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/esrecurse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "estraverse": "^5.2.0" - }, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estraverse": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", - "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.4" - }, - "engines": { - "node": ">=8.6.0" - } - }, - "node_modules/fast-glob/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fastq": { - "version": "1.17.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", - "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", - "dev": true, - "license": "ISC", - "dependencies": { - "reusify": "^1.0.4" - } - }, - "node_modules/file-entry-cache": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", - "integrity": "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "flat-cache": "^4.0.0" - }, - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "dev": true, - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "license": "MIT", - "dependencies": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/flat-cache": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", - "integrity": "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==", - "dev": true, - "license": "MIT", - "dependencies": { - "flatted": "^3.2.9", - "keyv": "^4.5.4" - }, - "engines": { - "node": ">=16" - } - }, - "node_modules/flatted": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", - "dev": true, - "license": "ISC" - }, - "node_modules/glob-parent": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", - "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.3" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/globals": { - "version": "15.15.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-15.15.0.tgz", - "integrity": "sha512-7ACyT3wmyp3I61S4fG682L0VA2RGD9otkqGJIwNUMF1SWUombIIk+af1unuDYgMm082aHYwD+mzJvv9Iu8dsgg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/graphemer": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", - "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true, - "license": "MIT" - }, - "node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/import-fresh": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", - "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true, - "license": "ISC" - }, - "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-stable-stringify-without-jsonify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "dev": true, - "license": "MIT", - "dependencies": { - "json-buffer": "3.0.1" - } - }, - "node_modules/levn": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1", - "type-check": "~0.4.0" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^5.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/lodash.merge": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", - "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true, - "license": "MIT" - }, - "node_modules/natural-compare": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true, - "license": "MIT" - }, - "node_modules/optionator": { - "version": "0.9.4", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", - "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "deep-is": "^0.1.3", - "fast-levenshtein": "^2.0.6", - "levn": "^0.4.1", - "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.5" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "yocto-queue": "^0.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "dev": true, - "license": "MIT", - "dependencies": { - "callsites": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/prelude-ls": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", - "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/punycode": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dev": true, - "license": "MIT", - "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" - } - }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "queue-microtask": "^1.2.2" - } - }, - "node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/type-check": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", - "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/typescript": { - "version": "5.8.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", - "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", - "dev": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/typescript-eslint": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.26.1.tgz", - "integrity": "sha512-t/oIs9mYyrwZGRpDv3g+3K6nZ5uhKEMt2oNmAPwaY4/ye0+EH4nXIPYNtkYFS6QHm+1DFg34DbglYBz5P9Xysg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/eslint-plugin": "8.26.1", - "@typescript-eslint/parser": "8.26.1", - "@typescript-eslint/utils": "8.26.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.26.1.tgz", - "integrity": "sha512-2X3mwqsj9Bd3Ciz508ZUtoQQYpOhU/kWoUqIf49H8Z0+Vbh6UF/y0OEYp0Q0axOGzaBGs7QxRwq0knSQ8khQNA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.26.1", - "@typescript-eslint/type-utils": "8.26.1", - "@typescript-eslint/utils": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1", - "graphemer": "^1.4.0", - "ignore": "^5.3.1", - "natural-compare": "^1.4.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/parser": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.26.1.tgz", - "integrity": "sha512-w6HZUV4NWxqd8BdeFf81t07d7/YV9s7TCWrQQbG5uhuvGUAW+fq1usZ1Hmz9UPNLniFnD8GLSsDpjP0hm1S4lQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/scope-manager": "8.26.1", - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/typescript-estree": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1", - "debug": "^4.3.4" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/scope-manager": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.26.1.tgz", - "integrity": "sha512-6EIvbE5cNER8sqBu6V7+KeMZIC1664d2Yjt+B9EWUXrsyWpxx4lEZrmvxgSKRC6gX+efDL/UY9OpPZ267io3mg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/types": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.26.1.tgz", - "integrity": "sha512-n4THUQW27VmQMx+3P+B0Yptl7ydfceUj4ON/AQILAASwgYdZ/2dhfymRMh5egRUrvK5lSmaOm77Ry+lmXPOgBQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.26.1.tgz", - "integrity": "sha512-yUwPpUHDgdrv1QJ7YQal3cMVBGWfnuCdKbXw1yyjArax3353rEJP1ZA+4F8nOlQ3RfS2hUN/wze3nlY+ZOhvoA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "@typescript-eslint/visitor-keys": "8.26.1", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.26.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.26.1.tgz", - "integrity": "sha512-AjOC3zfnxd6S4Eiy3jwktJPclqhFHNyd8L6Gycf9WUPoKZpgM5PjkxY1X7uSy61xVpiJDhhk7XT2NVsN3ALTWg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.26.1", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/typescript-eslint/node_modules/ts-api-utils": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.0.1.tgz", - "integrity": "sha512-dnlgjFSVetynI8nzgJ+qF62efpglpWRk8isUEWZGWlJYySCTD6aKvbUDu+zbPeDakk3bg5H4XpitHukgfL1m9w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "punycode": "^2.1.0" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/word-wrap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", - "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/yocto-queue": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/zod": { - "version": "3.24.1", - "resolved": "https://registry.npmjs.org/zod/-/zod-3.24.1.tgz", - "integrity": "sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==", - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/colinhacks" - } - }, - "node_modules/zod-to-json-schema": { - "version": "3.24.1", - "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.24.1.tgz", - "integrity": "sha512-3h08nf3Vw3Wl3PK+q3ow/lIil81IT2Oa7YpQyUUDsEWbXveMesdfK1xBd2RhCkynwZndAxixji/7SYJJowr62w==", - "license": "ISC", - "peerDependencies": { - "zod": "^3.24.1" - } - } - } -} diff --git a/examples/sdks/mistral-typescript/package.json b/examples/sdks/mistral-typescript/package.json deleted file mode 100644 index d9c2c3d45..000000000 --- a/examples/sdks/mistral-typescript/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "name": "@mistralai/mistralai", - "version": "1.10.0", - "author": "Speakeasy", - "main": "./index.js", - "sideEffects": false, - "repository": { - "type": "git", - "url": "https://github.com/mistralai/client-ts.git" - }, - "scripts": { - "lint": "eslint --cache --max-warnings=0 src", - "build": "tsc", - "prepublishOnly": "npm run build" - }, - "peerDependencies": { - - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "~5.8.3", - "typescript-eslint": "^8.26.0" - }, - "dependencies": { - "zod": "^3.20.0", - "zod-to-json-schema": "^3.24.1" - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.genignore b/examples/sdks/mistral-typescript/packages/mistralai-azure/.genignore deleted file mode 100644 index 2491a3676..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.genignore +++ /dev/null @@ -1,4 +0,0 @@ -src/sdk/sdk.ts -README.md -USAGE.md -docs/sdks/**/README.md \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitattributes b/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitattributes deleted file mode 100644 index 113eead50..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitattributes +++ /dev/null @@ -1,2 +0,0 @@ -# This allows generated code to be indexed correctly -*.ts linguist-generated=false \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitignore b/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitignore deleted file mode 100644 index dc2842dc9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.gitignore +++ /dev/null @@ -1,22 +0,0 @@ -/mcp-server -/bin -/.eslintcache -/react-query -/.speakeasy/reports -/__tests__ -/core.* -/funcs -/models -/models/errors -/types -/node_modules -/lib -/sdk -/hooks -/index.* -/cjs -/esm -/dist -/.tsbuildinfo -/.tshy -/.tshy-* diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.npmignore b/examples/sdks/mistral-typescript/packages/mistralai-azure/.npmignore deleted file mode 100644 index cf98a6bf0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.npmignore +++ /dev/null @@ -1,15 +0,0 @@ -**/* -!/FUNCTIONS.md -!/RUNTIMES.md -!/REACT_QUERY.md -!/**/*.ts -!/**/*.js -!/**/*.mjs -!/**/*.json -!/**/*.map - -/eslint.config.mjs -/cjs -/.tshy -/.tshy-* -/__tests__ diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.lock b/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.lock deleted file mode 100644 index 8671e92dd..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.lock +++ /dev/null @@ -1,227 +0,0 @@ -lockVersion: 2.0.0 -id: 01e8a40b-3df3-4d9a-9501-2eb9e0d26c05 -management: - docChecksum: 87653f040f5b36c90e066870f34c478e - docVersion: 1.0.0 - speakeasyVersion: 1.517.3 - generationVersion: 2.548.6 - releaseVersion: 1.6.0 - configChecksum: 9a8039f55bb9f5f2ed7dc48f15005ec5 - repoURL: https://github.com/mistralai/client-ts.git - repoSubDirectory: packages/mistralai-azure - installationURL: https://gitpkg.now.sh/mistralai/client-ts/packages/mistralai-azure - published: true -features: - typescript: - additionalDependencies: 0.1.0 - additionalProperties: 0.1.1 - constsAndDefaults: 0.1.11 - core: 3.21.4 - defaultEnabledRetries: 0.1.0 - enumUnions: 0.1.0 - envVarSecurityUsage: 0.1.2 - examples: 2.81.5 - globalSecurity: 2.82.13 - globalSecurityCallbacks: 0.1.0 - globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.82.4 - nameOverrides: 2.81.2 - nullables: 0.1.1 - openEnums: 0.1.1 - responseFormat: 0.2.3 - retries: 2.83.0 - sdkHooks: 0.2.0 - serverEvents: 0.1.5 - serverEventsSentinels: 0.1.0 - serverIDs: 2.81.2 - unions: 2.85.8 -generatedFiles: - - .gitattributes - - .npmignore - - FUNCTIONS.md - - RUNTIMES.md - - docs/lib/utils/retryconfig.md - - docs/models/components/arguments.md - - docs/models/components/assistantmessage.md - - docs/models/components/assistantmessagecontent.md - - docs/models/components/assistantmessagerole.md - - docs/models/components/chatcompletionchoice.md - - docs/models/components/chatcompletionchoicefinishreason.md - - docs/models/components/chatcompletionrequest.md - - docs/models/components/chatcompletionrequestmessages.md - - docs/models/components/chatcompletionrequeststop.md - - docs/models/components/chatcompletionrequesttoolchoice.md - - docs/models/components/chatcompletionresponse.md - - docs/models/components/chatcompletionstreamrequest.md - - docs/models/components/chatcompletionstreamrequesttoolchoice.md - - docs/models/components/completionchunk.md - - docs/models/components/completionevent.md - - docs/models/components/completionresponsestreamchoice.md - - docs/models/components/content.md - - docs/models/components/contentchunk.md - - docs/models/components/deltamessage.md - - docs/models/components/document.md - - docs/models/components/documenturlchunk.md - - docs/models/components/documenturlchunktype.md - - docs/models/components/filechunk.md - - docs/models/components/finishreason.md - - docs/models/components/functioncall.md - - docs/models/components/functionname.md - - docs/models/components/functiont.md - - docs/models/components/imageurl.md - - docs/models/components/imageurlchunk.md - - docs/models/components/imageurlchunkimageurl.md - - docs/models/components/imageurlchunktype.md - - docs/models/components/jsonschema.md - - docs/models/components/loc.md - - docs/models/components/messages.md - - docs/models/components/mistralpromptmode.md - - docs/models/components/ocrimageobject.md - - docs/models/components/ocrpagedimensions.md - - docs/models/components/ocrpageobject.md - - docs/models/components/ocrrequest.md - - docs/models/components/ocrresponse.md - - docs/models/components/ocrusageinfo.md - - docs/models/components/prediction.md - - docs/models/components/referencechunk.md - - docs/models/components/referencechunktype.md - - docs/models/components/responseformat.md - - docs/models/components/responseformats.md - - docs/models/components/role.md - - docs/models/components/security.md - - docs/models/components/stop.md - - docs/models/components/systemmessage.md - - docs/models/components/systemmessagecontent.md - - docs/models/components/textchunk.md - - docs/models/components/tool.md - - docs/models/components/toolcall.md - - docs/models/components/toolchoice.md - - docs/models/components/toolchoiceenum.md - - docs/models/components/toolmessage.md - - docs/models/components/toolmessagecontent.md - - docs/models/components/toolmessagerole.md - - docs/models/components/tooltypes.md - - docs/models/components/type.md - - docs/models/components/usageinfo.md - - docs/models/components/usermessage.md - - docs/models/components/usermessagecontent.md - - docs/models/components/usermessagerole.md - - docs/models/components/validationerror.md - - docs/models/errors/httpvalidationerror.md - - eslint.config.mjs - - jsr.json - - package.json - - src/core.ts - - src/funcs/chatComplete.ts - - src/funcs/chatStream.ts - - src/funcs/ocrProcess.ts - - src/hooks/hooks.ts - - src/hooks/index.ts - - src/hooks/types.ts - - src/index.ts - - src/lib/base64.ts - - src/lib/config.ts - - src/lib/dlv.ts - - src/lib/encodings.ts - - src/lib/env.ts - - src/lib/event-streams.ts - - src/lib/files.ts - - src/lib/http.ts - - src/lib/is-plain-object.ts - - src/lib/logger.ts - - src/lib/matchers.ts - - src/lib/primitives.ts - - src/lib/retries.ts - - src/lib/schemas.ts - - src/lib/sdks.ts - - src/lib/security.ts - - src/lib/url.ts - - src/models/components/assistantmessage.ts - - src/models/components/chatcompletionchoice.ts - - src/models/components/chatcompletionrequest.ts - - src/models/components/chatcompletionresponse.ts - - src/models/components/chatcompletionstreamrequest.ts - - src/models/components/completionchunk.ts - - src/models/components/completionevent.ts - - src/models/components/completionresponsestreamchoice.ts - - src/models/components/contentchunk.ts - - src/models/components/deltamessage.ts - - src/models/components/documenturlchunk.ts - - src/models/components/filechunk.ts - - src/models/components/function.ts - - src/models/components/functioncall.ts - - src/models/components/functionname.ts - - src/models/components/imageurl.ts - - src/models/components/imageurlchunk.ts - - src/models/components/index.ts - - src/models/components/jsonschema.ts - - src/models/components/mistralpromptmode.ts - - src/models/components/ocrimageobject.ts - - src/models/components/ocrpagedimensions.ts - - src/models/components/ocrpageobject.ts - - src/models/components/ocrrequest.ts - - src/models/components/ocrresponse.ts - - src/models/components/ocrusageinfo.ts - - src/models/components/prediction.ts - - src/models/components/referencechunk.ts - - src/models/components/responseformat.ts - - src/models/components/responseformats.ts - - src/models/components/security.ts - - src/models/components/systemmessage.ts - - src/models/components/textchunk.ts - - src/models/components/tool.ts - - src/models/components/toolcall.ts - - src/models/components/toolchoice.ts - - src/models/components/toolchoiceenum.ts - - src/models/components/toolmessage.ts - - src/models/components/tooltypes.ts - - src/models/components/usageinfo.ts - - src/models/components/usermessage.ts - - src/models/components/validationerror.ts - - src/models/errors/httpclienterrors.ts - - src/models/errors/httpvalidationerror.ts - - src/models/errors/index.ts - - src/models/errors/sdkerror.ts - - src/models/errors/sdkvalidationerror.ts - - src/sdk/chat.ts - - src/sdk/index.ts - - src/sdk/ocr.ts - - src/types/async.ts - - src/types/blobs.ts - - src/types/constdatetime.ts - - src/types/enums.ts - - src/types/fp.ts - - src/types/index.ts - - src/types/operations.ts - - src/types/rfcdate.ts - - src/types/streams.ts - - tsconfig.json -examples: - stream_chat: - speakeasy-default-stream-chat: - requestBody: - application/json: {"model": "azureai", "stream": true, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "422": - application/json: {} - "200": {} - chat_completion_v1_chat_completions_post: - speakeasy-default-chat-completion-v1-chat-completions-post: - requestBody: - application/json: {"model": "azureai", "stream": false, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "mistral-small-latest", "usage": {"prompt_tokens": 16, "completion_tokens": 34, "total_tokens": 50}, "created": 1702256327, "choices": [{"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}]} - "422": - application/json: {} - ocr_v1_ocr_post: - speakeasy-default-ocr-v1-ocr-post: - requestBody: - application/json: {"model": "Focus", "document": {"type": "file", "file_id": "d36f3178-f390-4532-8486-0e0b118bbaba"}} - responses: - "200": - application/json: {"pages": [], "model": "Expedition", "usage_info": {"pages_processed": 487025}} - "422": - application/json: {} -examplesVersion: 1.0.0 -generatedTests: {} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.yaml b/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.yaml deleted file mode 100644 index ca928089e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/.speakeasy/gen.yaml +++ /dev/null @@ -1,51 +0,0 @@ -configVersion: 2.0.0 -generation: - sdkClassName: MistralAzure - maintainOpenAPIOrder: true - usageSnippets: - optionalPropertyRendering: withExample - useClassNamesForArrayFields: true - fixes: - nameResolutionDec2023: true - nameResolutionFeb2025: false - parameterOrderingFeb2024: true - requestResponseComponentNamesFeb2024: true - securityFeb2025: false - auth: - oAuth2ClientCredentialsEnabled: true - oAuth2PasswordEnabled: false -typescript: - version: 1.6.0 - additionalDependencies: - dependencies: {} - devDependencies: {} - peerDependencies: {} - additionalPackageJSON: {} - author: Speakeasy - clientServerStatusCodesAsErrors: true - defaultErrorName: SDKError - enableCustomCodeRegions: false - enableMCPServer: false - enableReactQuery: false - enumFormat: union - envVarPrefix: MISTRAL - flattenGlobalSecurity: true - flatteningOrder: body-first - imports: - option: openapi - paths: - callbacks: models/callbacks - errors: models/errors - operations: models/operations - shared: models/components - webhooks: models/webhooks - inputModelSuffix: input - jsonpath: legacy - maxMethodParams: 0 - methodArguments: require-security-and-request - moduleFormat: commonjs - outputModelSuffix: output - packageName: '@mistralai/mistralai-azure' - responseFormat: flat - templateVersion: v2 - useIndexModules: true diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/CONTRIBUTING.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/CONTRIBUTING.md deleted file mode 100644 index d585717fc..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Contributing to This Repository - -Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. - -## How to Report Issues - -If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: - -- A clear and descriptive title -- Steps to reproduce the issue -- Expected and actual behavior -- Any relevant logs, screenshots, or error messages -- Information about your environment (e.g., operating system, software versions) - - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed - -## Issue Triage and Upstream Fixes - -We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. - -## Contact - -If you have any questions or need further assistance, please feel free to reach out by opening an issue. - -Thank you for your understanding and cooperation! - -The Maintainers diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/FUNCTIONS.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/FUNCTIONS.md deleted file mode 100644 index 572f41e92..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/FUNCTIONS.md +++ /dev/null @@ -1,111 +0,0 @@ -# Standalone Functions - -> [!NOTE] -> This section is useful if you are using a bundler and targetting browsers and -> runtimes where the size of an application affects performance and load times. - -Every method in this SDK is also available as a standalone function. This -alternative API is suitable when targetting the browser or serverless runtimes -and using a bundler to build your application since all unused functionality -will be tree-shaken away. This includes code for unused methods, Zod schemas, -encoding helpers and response handlers. The result is dramatically smaller -impact on the application's final bundle size which grows very slowly as you use -more and more functionality from this SDK. - -Calling methods through the main SDK class remains a valid and generally more -more ergonomic option. Standalone functions represent an optimisation for a -specific category of applications. - -## Example - -```typescript -import { MistralAzureCore } from "@mistralai/mistralai-azure/core.js"; -import { chatComplete } from "@mistralai/mistralai-azure/funcs/chatComplete.js"; -import { SDKValidationError } from "@mistralai/mistralai-azure/models/errors/sdkvalidationerror.js"; - -// Use `MistralAzureCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistralAzure = new MistralAzureCore({ - apiKey: process.env["MISTRAL_API_KEY"] ?? "", -}); - -async function run() { - const res = await chatComplete(mistralAzure, { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - switch (true) { - case res.ok: - // The success case will be handled outside of the switch block - break; - case res.error instanceof SDKValidationError: - // Pretty-print validation errors. - return console.log(res.error.pretty()); - case res.error instanceof Error: - return console.log(res.error); - default: - // TypeScript's type checking will fail on the following line if the above - // cases were not exhaustive. - res.error satisfies never; - throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error); - } - - - const { value: result } = res; - - // Handle the result - console.log(result); -} - -run(); -``` - -## Result types - -Standalone functions differ from SDK methods in that they return a -`Result` type to capture _known errors_ and document them using -the type system. By avoiding throwing errors, application code maintains clear -control flow and error-handling become part of the regular flow of application -code. - -> We use the term "known errors" because standalone functions, and JavaScript -> code in general, can still throw unexpected errors such as `TypeError`s, -> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be -> something this SDK addresses in the future. Nevertheless, there is still a lot -> of benefit from capturing most errors and turning them into values. - -The second reason for this style of programming is because these functions will -typically be used in front-end applications where exception throwing is -sometimes discouraged or considered unidiomatic. React and similar ecosystems -and libraries tend to promote this style of programming so that components -render useful content under all states (loading, success, error and so on). - -The general pattern when calling standalone functions looks like this: - -```typescript -import { Core } from ""; -import { fetchSomething } from "/funcs/fetchSomething.js"; - -const client = new Core(); - -async function run() { - const result = await fetchSomething(client, { id: "123" }); - if (!result.ok) { - // You can throw the error or handle it. It's your choice now. - throw result.error; - } - - console.log(result.value); -} - -run(); -``` - -Notably, `result.error` above will have an explicit type compared to a try-catch -variation where the error in the catch block can only be of type `unknown` (or -`any` depending on your TypeScript settings). \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/LICENSE b/examples/sdks/mistral-typescript/packages/mistralai-azure/LICENSE deleted file mode 100644 index bec127680..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2024 Mistral AI - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/README.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/README.md deleted file mode 100644 index fb4400898..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/README.md +++ /dev/null @@ -1,447 +0,0 @@ -# Mistral on Azure Typescript Client - - -## SDK Installation - -### NPM - -```bash -npm add @mistralai/mistralai-azure -``` - -### PNPM - -```bash -pnpm add @mistralai/mistralai-azure -``` - -### Bun - -```bash -bun add @mistralai/mistralai-azure -``` - -### Yarn - -```bash -yarn add @mistralai/mistralai-azure zod - -# Note that Yarn does not install peer dependencies automatically. You will need -# to install zod as shown above. -``` - - - -## Requirements - -For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). - - - -## SDK Example Usage - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.complete({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result); -} - -run(); - -``` - - - -## Available Resources and Operations - -### [chat](docs/sdks/chat/README.md) - -* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion -* [create](docs/sdks/chat/README.md#create) - Chat Completion - - - -## Server-sent event streaming - -[Server-sent events][mdn-sse] are used to stream content from certain -operations. These operations will expose the stream as an async iterable that -can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will -terminate when the server no longer has any events to send and closes the -underlying connection. - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - -[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events -[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of - - - -## Retries - -Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. - -To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream( - { - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }, - { - retries: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - } - ); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - -If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - retryConfig: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - -## Error Handling - -All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type. - -| Error Object | Status Code | Content Type | -| -------------------------- | ----------- | ---------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4xx-5xx | */* | - -Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. - - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; -import { SDKValidationError } from "@mistralai/mistralai-azure/models/errors"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - let result; - try { - result = await mistralAzure.chat.complete({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - } catch (err) { - switch (true) { - case err instanceof SDKValidationError: { - // Validation errors can be pretty-printed - console.error(err.pretty()); - // Raw value may also be inspected - console.error(err.rawValue); - return; - } - case err instanceof errors.HTTPValidationError: { - console.error(err); // handle exception - return; - } - default: { - throw err; - } - } - } - - // Handle the result - console.log(result); -} - -run(); - -``` - - - -## Server Selection - -### Select Server by Name - -You can override the default server globally by passing a server name to the `server` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: - -| Name | Server | Variables | -| ------ | ------------------------ | --------- | -| `prod` | `https://api.mistral.ai` | None | - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - server: "prod", - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - -### Override Server URL Per-Client - -The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - serverURL: "https://api.mistral.ai", - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - -## Custom HTTP Client - -The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native -[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This -client is a thin wrapper around `fetch` and provides the ability to attach hooks -around the request lifecycle that can be used to modify the request or handle -errors and response. - -The `HTTPClient` constructor takes an optional `fetcher` argument that can be -used to integrate a third-party HTTP client or when writing tests to mock out -the HTTP client and feed in fixtures. - -The following example shows how to use the `"beforeRequest"` hook to to add a -custom header and a timeout to requests and how to use the `"requestError"` hook -to log errors: - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; -import { HTTPClient } from "@mistralai/mistralai-azure/lib/http"; - -const httpClient = new HTTPClient({ - // fetcher takes a function that has the same signature as native `fetch`. - fetcher: (request) => { - return fetch(request); - } -}); - -httpClient.addHook("beforeRequest", (request) => { - const nextRequest = new Request(request, { - signal: request.signal || AbortSignal.timeout(5000) - }); - - nextRequest.headers.set("x-custom-header", "custom value"); - - return nextRequest; -}); - -httpClient.addHook("requestError", (error, request) => { - console.group("Request Error"); - console.log("Reason:", `${error}`); - console.log("Endpoint:", `${request.method} ${request.url}`); - console.groupEnd(); -}); - -const sdk = new MistralAzure({ httpClient }); -``` - - - -## Authentication - -### Per-Client Security Schemes - -This SDK supports the following security scheme globally: - -| Name | Type | Scheme | -| -------- | ---- | ----------- | -| `apiKey` | http | HTTP Bearer | - -To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example: -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - - -# Development - -## Contributions - -While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. -We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/RELEASES.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/RELEASES.md deleted file mode 100644 index a23eb8002..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/RELEASES.md +++ /dev/null @@ -1,131 +0,0 @@ - - -## 2024-08-07 12:27:19 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.356.0 (2.388.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.0] packages/mistralai-azure -### Releases -- [NPM v1.0.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.0.0 - packages/mistralai-azure - -## 2024-08-08 18:05:55 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.357.4 (2.390.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.2] packages/mistralai-azure -### Releases -- [NPM v1.0.2] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.0.2 - packages/mistralai-azure - -## 2024-08-20 08:43:15 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.376.0 (2.402.5) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.3] packages/mistralai-azure -### Releases -- [NPM v1.0.3] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.0.3 - packages/mistralai-azure - -## 2024-08-23 12:00:05 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.378.0 (2.404.3) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.4] packages/mistralai-azure -### Releases -- [NPM v1.0.4] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.0.4 - packages/mistralai-azure - -## 2024-09-19 11:35:36 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.399.3 (2.420.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.1.0] packages/mistralai-azure -### Releases -- [NPM v1.1.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.1.0 - packages/mistralai-azure - -## 2024-11-08 13:01:44 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.434.7 (2.452.0) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.0] packages/mistralai-azure -### Releases -- [NPM v1.3.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.3.0 - packages/mistralai-azure - -## 2024-11-12 18:05:05 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.1] packages/mistralai-azure -### Releases -- [NPM v1.3.1] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.3.1 - packages/mistralai-azure - -## 2024-11-15 18:36:42 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.4] packages/mistralai-azure -### Releases -- [NPM v1.3.4] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.3.4 - packages/mistralai-azure - -## 2024-12-04 09:27:57 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.451.1 (2.470.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.5] packages/mistralai-azure -### Releases -- [NPM v1.3.5] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.3.5 - packages/mistralai-azure - -## 2025-01-06 10:25:32 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.462.2 (2.486.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.6] packages/mistralai-azure -### Releases -- [NPM v1.3.6] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.3.6 - packages/mistralai-azure - -## 2025-01-21 10:40:54 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.469.11 (2.493.32) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.4.0] packages/mistralai-azure -### Releases -- [NPM v1.4.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.4.0 - packages/mistralai-azure - -## 2025-03-20 14:22:44 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.5.0] packages/mistralai-azure -### Releases -- [NPM v1.5.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.5.0 - packages/mistralai-azure - -## 2025-08-25 14:52:23 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.6.0] packages/mistralai-azure -### Releases -- [NPM v1.6.0] https://www.npmjs.com/package/@mistralai/mistralai-azure/v/1.6.0 - packages/mistralai-azure \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/RUNTIMES.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/RUNTIMES.md deleted file mode 100644 index db7ea9423..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/RUNTIMES.md +++ /dev/null @@ -1,48 +0,0 @@ -# Supported JavaScript runtimes - -This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features: - -* [Web Fetch API][web-fetch] -* [Web Streams API][web-streams] and in particular `ReadableStream` -* [Async iterables][async-iter] using `Symbol.asyncIterator` - -[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API -[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API -[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols - -Runtime environments that are explicitly supported are: - -- Evergreen browsers which include: Chrome, Safari, Edge, Firefox -- Node.js active and maintenance LTS releases - - Currently, this is v18 and v20 -- Bun v1 and above -- Deno v1.39 - - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming]) - -[deno-file-streaming]: https://github.com/denoland/deno/issues/11018 - -## Recommended TypeScript compiler options - -The following `tsconfig.json` options are recommended for projects using this -SDK in order to get static type support for features like async iterables, -streams and `fetch`-related APIs ([`for await...of`][for-await-of], -[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and -so on): - -[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of -[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal -[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request -[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response - -```jsonc -{ - "compilerOptions": { - "target": "es2020", // or higher - "lib": ["es2020", "dom", "dom.iterable"], - } -} -``` - -While `target` can be set to older ECMAScript versions, it may result in extra, -unnecessary compatibility code being generated if you are not targeting old -runtimes. \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/USAGE.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/USAGE.md deleted file mode 100644 index d2db48574..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/USAGE.md +++ /dev/null @@ -1,32 +0,0 @@ - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.complete({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result); -} - -run(); - -``` - \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/lib/utils/retryconfig.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/lib/utils/retryconfig.md deleted file mode 100644 index 08f95f455..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/lib/utils/retryconfig.md +++ /dev/null @@ -1,24 +0,0 @@ -# RetryConfig - -Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- | -| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | | -| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | ------------ | ----------------------------------------- | -------- | -| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` | -| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` | -| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/arguments.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/arguments.md deleted file mode 100644 index ef0bdc61d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/arguments.md +++ /dev/null @@ -1,19 +0,0 @@ -# Arguments - - -## Supported Types - -### `{ [k: string]: any }` - -```typescript -const value: { [k: string]: any } = { - "key": "", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessage.md deleted file mode 100644 index 22cca5ee3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# AssistantMessage - -## Example Usage - -```typescript -import { AssistantMessage } from "@mistralai/mistralai-azure/models/components"; - -let value: AssistantMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `content` | *components.AssistantMessageContent* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | -| `prefix` | *boolean* | :heavy_minus_sign: | Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. | -| `role` | [components.AssistantMessageRole](../../models/components/assistantmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagecontent.md deleted file mode 100644 index ffa94cf0e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# AssistantMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - imageUrl: { - url: "https://jittery-window.com", - }, - type: "image_url", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagerole.md deleted file mode 100644 index f23f2e7af..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/assistantmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# AssistantMessageRole - -## Example Usage - -```typescript -import { AssistantMessageRole } from "@mistralai/mistralai-azure/models/components"; - -let value: AssistantMessageRole = "assistant"; -``` - -## Values - -```typescript -"assistant" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoice.md deleted file mode 100644 index 32cdeb210..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionChoice - -## Example Usage - -```typescript -import { ChatCompletionChoice } from "@mistralai/mistralai-azure/models/components"; - -let value: ChatCompletionChoice = { - index: 0, - message: {}, - finishReason: "stop", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `index` | *number* | :heavy_check_mark: | N/A | 0 | -| `message` | [components.AssistantMessage](../../models/components/assistantmessage.md) | :heavy_check_mark: | N/A | | -| `finishReason` | [components.ChatCompletionChoiceFinishReason](../../models/components/chatcompletionchoicefinishreason.md) | :heavy_check_mark: | N/A | stop | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoicefinishreason.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoicefinishreason.md deleted file mode 100644 index 57167979f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionchoicefinishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# ChatCompletionChoiceFinishReason - -## Example Usage - -```typescript -import { ChatCompletionChoiceFinishReason } from "@mistralai/mistralai-azure/models/components"; - -let value: ChatCompletionChoiceFinishReason = "stop"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "model_length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequest.md deleted file mode 100644 index 96f8111a3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequest.md +++ /dev/null @@ -1,39 +0,0 @@ -# ChatCompletionRequest - -## Example Usage - -```typescript -import { ChatCompletionRequest } from "@mistralai/mistralai-azure/models/components"; - -let value: ChatCompletionRequest = { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_minus_sign: | The ID of the model to use for this request. | azureai | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.ChatCompletionRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.ChatCompletionRequestMessages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `safePrompt` | *boolean* | :heavy_minus_sign: | Whether to inject a safety prompt before all conversations. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequestmessages.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequestmessages.md deleted file mode 100644 index 0bc19a1b4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequestmessages.md +++ /dev/null @@ -1,42 +0,0 @@ -# ChatCompletionRequestMessages - - -## Supported Types - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [ - { - imageUrl: { - url: "https://sugary-brace.org/", - }, - type: "image_url", - }, - ], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequeststop.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequeststop.md deleted file mode 100644 index 5cf805d77..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequeststop.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequesttoolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequesttoolchoice.md deleted file mode 100644 index 8750103b5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionresponse.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionresponse.md deleted file mode 100644 index 8a925b79f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionresponse.md +++ /dev/null @@ -1,33 +0,0 @@ -# ChatCompletionResponse - -## Example Usage - -```typescript -import { ChatCompletionResponse } from "@mistralai/mistralai-azure/models/components"; - -let value: ChatCompletionResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "mistral-small-latest", - usage: {}, - created: 1702256327, - choices: [ - { - index: 0, - message: {}, - finishReason: "stop", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | mistral-small-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_check_mark: | N/A | 1702256327 | -| `choices` | [components.ChatCompletionChoice](../../models/components/chatcompletionchoice.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequest.md deleted file mode 100644 index 583739e21..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequest.md +++ /dev/null @@ -1,39 +0,0 @@ -# ChatCompletionStreamRequest - -## Example Usage - -```typescript -import { ChatCompletionStreamRequest } from "@mistralai/mistralai-azure/models/components"; - -let value: ChatCompletionStreamRequest = { - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_minus_sign: | The ID of the model to use for this request. | azureai | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.Stop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.Messages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionStreamRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `promptMode` | [components.MistralPromptMode](../../models/components/mistralpromptmode.md) | :heavy_minus_sign: | Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. | | -| `safePrompt` | *boolean* | :heavy_minus_sign: | Whether to inject a safety prompt before all conversations. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequesttoolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequesttoolchoice.md deleted file mode 100644 index 4d4a29f27..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/chatcompletionstreamrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionStreamRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "none"; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionchunk.md deleted file mode 100644 index 209c99846..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionchunk.md +++ /dev/null @@ -1,30 +0,0 @@ -# CompletionChunk - -## Example Usage - -```typescript -import { CompletionChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: CompletionChunk = { - id: "", - model: "Golf", - choices: [ - { - index: 423655, - delta: {}, - finishReason: "error", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_minus_sign: | N/A | -| `choices` | [components.CompletionResponseStreamChoice](../../models/components/completionresponsestreamchoice.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionevent.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionevent.md deleted file mode 100644 index 4fbe8aba3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionevent.md +++ /dev/null @@ -1,27 +0,0 @@ -# CompletionEvent - -## Example Usage - -```typescript -import { CompletionEvent } from "@mistralai/mistralai-azure/models/components"; - -let value: CompletionEvent = { - data: { - id: "", - model: "Golf", - choices: [ - { - index: 715190, - delta: {}, - finishReason: "error", - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [components.CompletionChunk](../../models/components/completionchunk.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionresponsestreamchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionresponsestreamchoice.md deleted file mode 100644 index 6f3cac44c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/completionresponsestreamchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# CompletionResponseStreamChoice - -## Example Usage - -```typescript -import { CompletionResponseStreamChoice } from "@mistralai/mistralai-azure/models/components"; - -let value: CompletionResponseStreamChoice = { - index: 891773, - delta: {}, - finishReason: "tool_calls", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `index` | *number* | :heavy_check_mark: | N/A | -| `delta` | [components.DeltaMessage](../../models/components/deltamessage.md) | :heavy_check_mark: | N/A | -| `finishReason` | [components.FinishReason](../../models/components/finishreason.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/content.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/content.md deleted file mode 100644 index b05000a30..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/content.md +++ /dev/null @@ -1,22 +0,0 @@ -# Content - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - text: "", - type: "text", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/contentchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/contentchunk.md deleted file mode 100644 index b25f2ef23..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/contentchunk.md +++ /dev/null @@ -1,31 +0,0 @@ -# ContentChunk - - -## Supported Types - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://blaring-bog.com", -}; -``` - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ReferenceChunk` - -```typescript -const value: components.ReferenceChunk = { - referenceIds: [ - 832620, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/deltamessage.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/deltamessage.md deleted file mode 100644 index 79b48573a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/deltamessage.md +++ /dev/null @@ -1,17 +0,0 @@ -# DeltaMessage - -## Example Usage - -```typescript -import { DeltaMessage } from "@mistralai/mistralai-azure/models/components"; - -let value: DeltaMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `role` | *string* | :heavy_minus_sign: | N/A | -| `content` | *components.Content* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/document.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/document.md deleted file mode 100644 index 503e03890..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/document.md +++ /dev/null @@ -1,33 +0,0 @@ -# Document - -Document to run OCR on - - -## Supported Types - -### `components.FileChunk` - -```typescript -const value: components.FileChunk = { - fileId: "0d0a4bf3-9993-4f7d-9b4d-6e9ebb8fa690", -}; -``` - -### `components.DocumentURLChunk` - -```typescript -const value: components.DocumentURLChunk = { - documentUrl: "https://fortunate-octave.info", -}; -``` - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: { - url: "https://official-mouser.name/", - }, -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunk.md deleted file mode 100644 index 8b8c962e5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunk.md +++ /dev/null @@ -1,19 +0,0 @@ -# DocumentURLChunk - -## Example Usage - -```typescript -import { DocumentURLChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: DocumentURLChunk = { - documentUrl: "https://elliptical-fog.org", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `documentUrl` | *string* | :heavy_check_mark: | N/A | -| `documentName` | *string* | :heavy_minus_sign: | The filename of the document | -| `type` | [components.DocumentURLChunkType](../../models/components/documenturlchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunktype.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunktype.md deleted file mode 100644 index e3ae5f794..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/documenturlchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# DocumentURLChunkType - -## Example Usage - -```typescript -import { DocumentURLChunkType } from "@mistralai/mistralai-azure/models/components"; - -let value: DocumentURLChunkType = "document_url"; -``` - -## Values - -```typescript -"document_url" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/filechunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/filechunk.md deleted file mode 100644 index dbcbb5b05..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/filechunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# FileChunk - -## Example Usage - -```typescript -import { FileChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: FileChunk = { - fileId: "ecb1ebf2-d291-4dc9-861b-7bdfd05b2803", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/finishreason.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/finishreason.md deleted file mode 100644 index fc4e9f1e1..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/finishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# FinishReason - -## Example Usage - -```typescript -import { FinishReason } from "@mistralai/mistralai-azure/models/components"; - -let value: FinishReason = "length"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functioncall.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functioncall.md deleted file mode 100644 index a49884c88..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functioncall.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionCall - -## Example Usage - -```typescript -import { FunctionCall } from "@mistralai/mistralai-azure/models/components"; - -let value: FunctionCall = { - name: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *components.Arguments* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functionname.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functionname.md deleted file mode 100644 index 55df1a578..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functionname.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionName - -this restriction of `Function` is used to select a specific function to call - -## Example Usage - -```typescript -import { FunctionName } from "@mistralai/mistralai-azure/models/components"; - -let value: FunctionName = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functiont.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functiont.md deleted file mode 100644 index 08ccfb22a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/functiont.md +++ /dev/null @@ -1,23 +0,0 @@ -# FunctionT - -## Example Usage - -```typescript -import { FunctionT } from "@mistralai/mistralai-azure/models/components"; - -let value: FunctionT = { - name: "", - parameters: { - "key": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `parameters` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurl.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurl.md deleted file mode 100644 index afcc58c81..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurl.md +++ /dev/null @@ -1,18 +0,0 @@ -# ImageURL - -## Example Usage - -```typescript -import { ImageURL } from "@mistralai/mistralai-azure/models/components"; - -let value: ImageURL = { - url: "https://misguided-hawk.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | -| `detail` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunk.md deleted file mode 100644 index d7feaa4cf..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunk.md +++ /dev/null @@ -1,22 +0,0 @@ -# ImageURLChunk - -{"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - -## Example Usage - -```typescript -import { ImageURLChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: ImageURLChunk = { - imageUrl: { - url: "https://close-paintwork.com", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `imageUrl` | *components.ImageURLChunkImageURL* | :heavy_check_mark: | N/A | -| `type` | [components.ImageURLChunkType](../../models/components/imageurlchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunkimageurl.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunkimageurl.md deleted file mode 100644 index 486a5ef7b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunkimageurl.md +++ /dev/null @@ -1,19 +0,0 @@ -# ImageURLChunkImageURL - - -## Supported Types - -### `components.ImageURL` - -```typescript -const value: components.ImageURL = { - url: "https://true-wasabi.net", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunktype.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunktype.md deleted file mode 100644 index 73685c66e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/imageurlchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ImageURLChunkType - -## Example Usage - -```typescript -import { ImageURLChunkType } from "@mistralai/mistralai-azure/models/components"; - -let value: ImageURLChunkType = "image_url"; -``` - -## Values - -```typescript -"image_url" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/jsonschema.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/jsonschema.md deleted file mode 100644 index e0527855f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/jsonschema.md +++ /dev/null @@ -1,23 +0,0 @@ -# JsonSchema - -## Example Usage - -```typescript -import { JsonSchema } from "@mistralai/mistralai-azure/models/components"; - -let value: JsonSchema = { - name: "", - schemaDefinition: { - "key": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `schemaDefinition` | Record | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/loc.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/loc.md deleted file mode 100644 index 93706ec77..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/loc.md +++ /dev/null @@ -1,17 +0,0 @@ -# Loc - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `number` - -```typescript -const value: number = 456150; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/messages.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/messages.md deleted file mode 100644 index 22b2a13af..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/messages.md +++ /dev/null @@ -1,52 +0,0 @@ -# Messages - - -## Supported Types - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: [ - { - referenceIds: [ - 359508, - ], - type: "reference", - }, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/mistralpromptmode.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/mistralpromptmode.md deleted file mode 100644 index 45658d446..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/mistralpromptmode.md +++ /dev/null @@ -1,17 +0,0 @@ -# MistralPromptMode - -## Example Usage - -```typescript -import { MistralPromptMode } from "@mistralai/mistralai-azure/models/components"; - -let value: MistralPromptMode = "reasoning"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"reasoning" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrimageobject.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrimageobject.md deleted file mode 100644 index 1e7b356d0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrimageobject.md +++ /dev/null @@ -1,27 +0,0 @@ -# OCRImageObject - -## Example Usage - -```typescript -import { OCRImageObject } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRImageObject = { - id: "", - topLeftX: 716327, - topLeftY: 289406, - bottomRightX: 183191, - bottomRightY: 586513, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Image ID for extracted image in a page | -| `topLeftX` | *number* | :heavy_check_mark: | X coordinate of top-left corner of the extracted image | -| `topLeftY` | *number* | :heavy_check_mark: | Y coordinate of top-left corner of the extracted image | -| `bottomRightX` | *number* | :heavy_check_mark: | X coordinate of bottom-right corner of the extracted image | -| `bottomRightY` | *number* | :heavy_check_mark: | Y coordinate of bottom-right corner of the extracted image | -| `imageBase64` | *string* | :heavy_minus_sign: | Base64 string of the extracted image | -| `imageAnnotation` | *string* | :heavy_minus_sign: | Annotation of the extracted image in json str | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpagedimensions.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpagedimensions.md deleted file mode 100644 index 96f38779a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpagedimensions.md +++ /dev/null @@ -1,21 +0,0 @@ -# OCRPageDimensions - -## Example Usage - -```typescript -import { OCRPageDimensions } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRPageDimensions = { - dpi: 318569, - height: 667411, - width: 131797, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `dpi` | *number* | :heavy_check_mark: | Dots per inch of the page-image | -| `height` | *number* | :heavy_check_mark: | Height of the image in pixels | -| `width` | *number* | :heavy_check_mark: | Width of the image in pixels | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpageobject.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpageobject.md deleted file mode 100644 index 6037b41c3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrpageobject.md +++ /dev/null @@ -1,35 +0,0 @@ -# OCRPageObject - -## Example Usage - -```typescript -import { OCRPageObject } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRPageObject = { - index: 64147, - markdown: "", - images: [ - { - id: "", - topLeftX: 692472, - topLeftY: 566602, - bottomRightX: 265389, - bottomRightY: 523248, - }, - ], - dimensions: { - dpi: 93940, - height: 575947, - width: 929297, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `index` | *number* | :heavy_check_mark: | The page index in a pdf document starting from 0 | -| `markdown` | *string* | :heavy_check_mark: | The markdown string response of the page | -| `images` | [components.OCRImageObject](../../models/components/ocrimageobject.md)[] | :heavy_check_mark: | List of all extracted images in the page | -| `dimensions` | [components.OCRPageDimensions](../../models/components/ocrpagedimensions.md) | :heavy_check_mark: | The dimensions of the PDF Page's screenshot image | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrrequest.md deleted file mode 100644 index c6e105873..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrrequest.md +++ /dev/null @@ -1,29 +0,0 @@ -# OCRRequest - -## Example Usage - -```typescript -import { OCRRequest } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRRequest = { - model: "Malibu", - document: { - documentUrl: "https://unlucky-fund.info/", - type: "document_url", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `document` | *components.Document* | :heavy_check_mark: | Document to run OCR on | -| `pages` | *number*[] | :heavy_minus_sign: | Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 | -| `includeImageBase64` | *boolean* | :heavy_minus_sign: | Include image URLs in response | -| `imageLimit` | *number* | :heavy_minus_sign: | Max images to extract | -| `imageMinSize` | *number* | :heavy_minus_sign: | Minimum height and width of image to extract | -| `bboxAnnotationFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field | -| `documentAnnotationFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrresponse.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrresponse.md deleted file mode 100644 index 7ffb7d17c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrresponse.md +++ /dev/null @@ -1,43 +0,0 @@ -# OCRResponse - -## Example Usage - -```typescript -import { OCRResponse } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRResponse = { - pages: [ - { - index: 468651, - markdown: "", - images: [ - { - id: "", - topLeftX: 976762, - topLeftY: 604846, - bottomRightX: 739264, - bottomRightY: 39187, - }, - ], - dimensions: { - dpi: 282807, - height: 120196, - width: 296140, - }, - }, - ], - model: "Alpine", - usageInfo: { - pagesProcessed: 317983, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `pages` | [components.OCRPageObject](../../models/components/ocrpageobject.md)[] | :heavy_check_mark: | List of OCR info for pages. | -| `model` | *string* | :heavy_check_mark: | The model used to generate the OCR. | -| `documentAnnotation` | *string* | :heavy_minus_sign: | Formatted response in the request_format if provided in json str | -| `usageInfo` | [components.OCRUsageInfo](../../models/components/ocrusageinfo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrusageinfo.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrusageinfo.md deleted file mode 100644 index 0584b95f4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/ocrusageinfo.md +++ /dev/null @@ -1,18 +0,0 @@ -# OCRUsageInfo - -## Example Usage - -```typescript -import { OCRUsageInfo } from "@mistralai/mistralai-azure/models/components"; - -let value: OCRUsageInfo = { - pagesProcessed: 414263, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `pagesProcessed` | *number* | :heavy_check_mark: | Number of pages processed | -| `docSizeBytes` | *number* | :heavy_minus_sign: | Document size in bytes | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/prediction.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/prediction.md deleted file mode 100644 index 9cc6bb3b2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/prediction.md +++ /dev/null @@ -1,16 +0,0 @@ -# Prediction - -## Example Usage - -```typescript -import { Prediction } from "@mistralai/mistralai-azure/models/components"; - -let value: Prediction = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `content` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunk.md deleted file mode 100644 index f31ab3a8e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunk.md +++ /dev/null @@ -1,20 +0,0 @@ -# ReferenceChunk - -## Example Usage - -```typescript -import { ReferenceChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: ReferenceChunk = { - referenceIds: [ - 774234, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `referenceIds` | *number*[] | :heavy_check_mark: | N/A | -| `type` | [components.ReferenceChunkType](../../models/components/referencechunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunktype.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunktype.md deleted file mode 100644 index ffdeeb9ee..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/referencechunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ReferenceChunkType - -## Example Usage - -```typescript -import { ReferenceChunkType } from "@mistralai/mistralai-azure/models/components"; - -let value: ReferenceChunkType = "reference"; -``` - -## Values - -```typescript -"reference" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformat.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformat.md deleted file mode 100644 index 32922bef7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformat.md +++ /dev/null @@ -1,16 +0,0 @@ -# ResponseFormat - -## Example Usage - -```typescript -import { ResponseFormat } from "@mistralai/mistralai-azure/models/components"; - -let value: ResponseFormat = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseFormats](../../models/components/responseformats.md) | :heavy_minus_sign: | An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. | -| `jsonSchema` | [components.JsonSchema](../../models/components/jsonschema.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformats.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformats.md deleted file mode 100644 index 1e0618dc4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/responseformats.md +++ /dev/null @@ -1,17 +0,0 @@ -# ResponseFormats - -An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - -## Example Usage - -```typescript -import { ResponseFormats } from "@mistralai/mistralai-azure/models/components"; - -let value: ResponseFormats = "text"; -``` - -## Values - -```typescript -"text" | "json_object" | "json_schema" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/role.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/role.md deleted file mode 100644 index ae6b1cce2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/role.md +++ /dev/null @@ -1,15 +0,0 @@ -# Role - -## Example Usage - -```typescript -import { Role } from "@mistralai/mistralai-azure/models/components"; - -let value: Role = "system"; -``` - -## Values - -```typescript -"system" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/security.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/security.md deleted file mode 100644 index 21a71d6ac..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/security.md +++ /dev/null @@ -1,15 +0,0 @@ -# Security - -## Example Usage - -```typescript -import { Security } from "@mistralai/mistralai-azure/models/components"; - -let value: Security = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/stop.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/stop.md deleted file mode 100644 index f26b1bf3c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/stop.md +++ /dev/null @@ -1,21 +0,0 @@ -# Stop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessage.md deleted file mode 100644 index 8a819fe27..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessage.md +++ /dev/null @@ -1,23 +0,0 @@ -# SystemMessage - -## Example Usage - -```typescript -import { SystemMessage } from "@mistralai/mistralai-azure/models/components"; - -let value: SystemMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `content` | *components.SystemMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.Role](../../models/components/role.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessagecontent.md deleted file mode 100644 index cda9bedd0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/systemmessagecontent.md +++ /dev/null @@ -1,21 +0,0 @@ -# SystemMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.TextChunk[]` - -```typescript -const value: components.TextChunk[] = [ - { - text: "", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/textchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/textchunk.md deleted file mode 100644 index 326a1752c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/textchunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# TextChunk - -## Example Usage - -```typescript -import { TextChunk } from "@mistralai/mistralai-azure/models/components"; - -let value: TextChunk = { - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [components.Type](../../models/components/type.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tool.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tool.md deleted file mode 100644 index 17d4268c4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tool.md +++ /dev/null @@ -1,23 +0,0 @@ -# Tool - -## Example Usage - -```typescript -import { Tool } from "@mistralai/mistralai-azure/models/components"; - -let value: Tool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionT](../../models/components/functiont.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolcall.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolcall.md deleted file mode 100644 index 0565e63fc..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolcall.md +++ /dev/null @@ -1,23 +0,0 @@ -# ToolCall - -## Example Usage - -```typescript -import { ToolCall } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolCall = { - function: { - name: "", - arguments: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionCall](../../models/components/functioncall.md) | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoice.md deleted file mode 100644 index 10ffc3717..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoice.md +++ /dev/null @@ -1,22 +0,0 @@ -# ToolChoice - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - -## Example Usage - -```typescript -import { ToolChoice } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolChoice = { - function: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionName](../../models/components/functionname.md) | :heavy_check_mark: | this restriction of `Function` is used to select a specific function to call | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoiceenum.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoiceenum.md deleted file mode 100644 index 66cfb8c41..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolchoiceenum.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolChoiceEnum - -## Example Usage - -```typescript -import { ToolChoiceEnum } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolChoiceEnum = "any"; -``` - -## Values - -```typescript -"auto" | "none" | "any" | "required" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessage.md deleted file mode 100644 index a724c1411..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessage.md +++ /dev/null @@ -1,20 +0,0 @@ -# ToolMessage - -## Example Usage - -```typescript -import { ToolMessage } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.ToolMessageContent* | :heavy_check_mark: | N/A | -| `toolCallId` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.ToolMessageRole](../../models/components/toolmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagecontent.md deleted file mode 100644 index 1b59bf968..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# ToolMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - imageUrl: { - url: "https://fair-insolence.biz", - }, - type: "image_url", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagerole.md deleted file mode 100644 index 986c04f86..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/toolmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolMessageRole - -## Example Usage - -```typescript -import { ToolMessageRole } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolMessageRole = "tool"; -``` - -## Values - -```typescript -"tool" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tooltypes.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tooltypes.md deleted file mode 100644 index b91743367..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/tooltypes.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToolTypes - -## Example Usage - -```typescript -import { ToolTypes } from "@mistralai/mistralai-azure/models/components"; - -let value: ToolTypes = "function"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"function" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/type.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/type.md deleted file mode 100644 index 3ac1eb85e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/type.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type - -## Example Usage - -```typescript -import { Type } from "@mistralai/mistralai-azure/models/components"; - -let value: Type = "text"; -``` - -## Values - -```typescript -"text" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usageinfo.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usageinfo.md deleted file mode 100644 index 9abd02648..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usageinfo.md +++ /dev/null @@ -1,19 +0,0 @@ -# UsageInfo - -## Example Usage - -```typescript -import { UsageInfo } from "@mistralai/mistralai-azure/models/components"; - -let value: UsageInfo = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `promptTokens` | *number* | :heavy_minus_sign: | N/A | -| `completionTokens` | *number* | :heavy_minus_sign: | N/A | -| `totalTokens` | *number* | :heavy_minus_sign: | N/A | -| `promptAudioSeconds` | *number* | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessage.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessage.md deleted file mode 100644 index 491773a5c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# UserMessage - -## Example Usage - -```typescript -import { UserMessage } from "@mistralai/mistralai-azure/models/components"; - -let value: UserMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.UserMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.UserMessageRole](../../models/components/usermessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagecontent.md deleted file mode 100644 index a8be0fda9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# UserMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - referenceIds: [ - 210382, - ], - type: "reference", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagerole.md deleted file mode 100644 index 63ab97a17..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/usermessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# UserMessageRole - -## Example Usage - -```typescript -import { UserMessageRole } from "@mistralai/mistralai-azure/models/components"; - -let value: UserMessageRole = "user"; -``` - -## Values - -```typescript -"user" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/validationerror.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/validationerror.md deleted file mode 100644 index 0c8438ff3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/components/validationerror.md +++ /dev/null @@ -1,23 +0,0 @@ -# ValidationError - -## Example Usage - -```typescript -import { ValidationError } from "@mistralai/mistralai-azure/models/components"; - -let value: ValidationError = { - loc: [ - 18789, - ], - msg: "", - type: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `loc` | *components.Loc*[] | :heavy_check_mark: | N/A | -| `msg` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/errors/httpvalidationerror.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/errors/httpvalidationerror.md deleted file mode 100644 index 682346d57..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/models/errors/httpvalidationerror.md +++ /dev/null @@ -1,15 +0,0 @@ -# HTTPValidationError - -## Example Usage - -```typescript -import { HTTPValidationError } from "@mistralai/mistralai-azure/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `detail` | [components.ValidationError](../../models/components/validationerror.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/chat/README.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/chat/README.md deleted file mode 100644 index 201f57c54..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/chat/README.md +++ /dev/null @@ -1,114 +0,0 @@ -# Chat -(*chat*) - -## Overview - -Chat Completion API. - -### Available Operations - -* [stream](#stream) - Stream chat completion -* [create](#create) - Chat Completion - -## stream - -Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - -### Example Usage - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.["AZURE_API_KEY"], - endpoint: process.env.["AZURE_ENDPOINT"], -}); - -async function run() { - const result = await mistralAzure.chat.stream({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------- | ------------------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionStreamRequest](../../models/components/chatcompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[EventStream](../../models/.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | ----------- | ------------ | -| errors.SDKError | 4xx-5xx | */* | - -## create - -Chat Completion - -### Example Usage - -```typescript -import { MistralAzure } from "@mistralai/mistralai-azure"; - -const mistralAzure = new MistralAzure({ - apiKey: process.env.MISTRAL_API_KEY, -}); - -async function run() { - const result = await mistralAzure.chat.complete({ - model: "azureai", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------- | --------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionRequest](../../models/components/chatcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| -------------------------- | ----------- | ---------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4xx-5xx | */* | diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/mistralazure/README.md b/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/mistralazure/README.md deleted file mode 100644 index 381000a86..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/docs/sdks/mistralazure/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# MistralAzure SDK - - -## Overview - -Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -### Available Operations - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/eslint.config.mjs b/examples/sdks/mistral-typescript/packages/mistralai-azure/eslint.config.mjs deleted file mode 100644 index 3483f71ba..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/eslint.config.mjs +++ /dev/null @@ -1,21 +0,0 @@ -import globals from "globals"; -import pluginJs from "@eslint/js"; -import tseslint from "typescript-eslint"; - -/** @type {import('eslint').Linter.Config[]} */ -export default [ - { files: ["**/*.{js,mjs,cjs,ts}"] }, - { languageOptions: { globals: globals.browser } }, - pluginJs.configs.recommended, - ...tseslint.configs.recommended, - { - rules: { - "no-constant-condition": "off", - // Handled by typescript compiler - "@typescript-eslint/no-unused-vars": "off", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-empty-object-type": "off", - "@typescript-eslint/no-namespace": "off", - }, - }, -]; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/jsr.json b/examples/sdks/mistral-typescript/packages/mistralai-azure/jsr.json deleted file mode 100644 index b52b20ad8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/jsr.json +++ /dev/null @@ -1,28 +0,0 @@ - - -{ - "name": "@mistralai/mistralai-azure", - "version": "1.6.0", - "exports": { - ".": "./src/index.ts", - "./models/errors": "./src/models/errors/index.ts", - "./models/components": "./src/models/components/index.ts", - "./models/operations": "./src/models/operations/index.ts", - "./lib/config": "./src/lib/config.ts", - "./lib/http": "./src/lib/http.ts", - "./lib/retries": "./src/lib/retries.ts", - "./lib/sdks": "./src/lib/sdks.ts", - "./lib/event-streams": "./src/lib/event-streams.ts", - "./types": "./src/types/index.ts" - }, - "publish": { - "include": [ - "LICENSE", - "README.md", - "RUNTIMES.md", - "USAGE.md", - "jsr.json", - "src/**/*.ts" - ] - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/package-lock.json b/examples/sdks/mistral-typescript/packages/mistralai-azure/package-lock.json deleted file mode 100644 index 32f74a29b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/package-lock.json +++ /dev/null @@ -1,1869 +0,0 @@ -{ - "name": "@mistralai/mistralai-azure", - "version": "1.6.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "@mistralai/mistralai-azure", - "version": "1.6.0", - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "peerDependencies": { - "zod": ">= 3" - } - }, - "node_modules/@eslint-community/eslint-utils": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", - "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eslint-visitor-keys": "^3.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "peerDependencies": { - "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" - } - }, - "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.0.0 || ^14.0.0 || >=16.0.0" - } - }, - "node_modules/@eslint/config-array": { - "version": "0.19.2", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.2.tgz", - "integrity": "sha512-GNKqxfHG2ySmJOBSHg7LxeUx4xpuCoFjacmlCoYWEbaPXLwvfIjixRI12xCQZeULksQb23uiA8F40w5TojpV7w==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/object-schema": "^2.1.6", - "debug": "^4.3.1", - "minimatch": "^3.1.2" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/config-array/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/config-array/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/config-helpers": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.1.0.tgz", - "integrity": "sha512-kLrdPDJE1ckPo94kmPPf9Hfd0DU0Jw6oKYrhe+pwSC0iTUInmTa+w6fw8sGgcfkFJGNdWOUeOaDM4quW4a7OkA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/core": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.12.0.tgz", - "integrity": "sha512-cmrR6pytBuSMTaBweKoGMwu3EiHiEC+DoyupPmlZ0HxBJBtIxwe+j/E4XPIKNx+Q74c8lXKPwYawBf5glsTkHg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@types/json-schema": "^7.0.15" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/eslintrc": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.0.tgz", - "integrity": "sha512-yaVPAiNAalnCZedKLdR21GOGILMLKPyqSLWaAjQFvYA2i/ciDi8ArYVr69Anohb6cH2Ukhqti4aFnYyPm8wdwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "^6.12.4", - "debug": "^4.3.2", - "espree": "^10.0.1", - "globals": "^14.0.0", - "ignore": "^5.2.0", - "import-fresh": "^3.2.1", - "js-yaml": "^4.1.0", - "minimatch": "^3.1.2", - "strip-json-comments": "^3.1.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/eslintrc/node_modules/globals": { - "version": "14.0.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", - "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@eslint/eslintrc/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/js": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.22.0.tgz", - "integrity": "sha512-vLFajx9o8d1/oL2ZkpMYbkLv8nDB6yaIwFNt7nI4+I80U/z03SxmfOMsLbvWr3p7C+Wnoh//aOu2pQW8cS0HCQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/object-schema": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", - "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/plugin-kit": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.2.7.tgz", - "integrity": "sha512-JubJ5B2pJ4k4yGxaNLdbjrnk9d/iDz6/q8wOilpIowd6PJPgaxCuHBnBszq7Ce2TyMrywm5r4PnKm6V3iiZF+g==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/core": "^0.12.0", - "levn": "^0.4.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@humanfs/core": { - "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", - "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node": { - "version": "0.16.6", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", - "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@humanfs/core": "^0.19.1", - "@humanwhocodes/retry": "^0.3.0" - }, - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", - "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/module-importer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", - "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=12.22" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/retry": { - "version": "0.4.2", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.2.tgz", - "integrity": "sha512-xeO57FpIu4p1Ri3Jq/EXq4ClRm86dVF2z/+kvFnyqVYRavTZmaFaUBbWCOuuTh0o/g7DSsk6kc2vrS4Vl5oPOQ==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@types/estree": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", - "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@typescript-eslint/type-utils": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.27.0.tgz", - "integrity": "sha512-wVArTVcz1oJOIEJxui/nRhV0TXzD/zMSOYi/ggCfNq78EIszddXcJb7r4RCp/oBrjt8n9A0BSxRMKxHftpDxDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/typescript-estree": "8.27.0", - "@typescript-eslint/utils": "8.27.0", - "debug": "^4.3.4", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/@typescript-eslint/utils": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.27.0.tgz", - "integrity": "sha512-njkodcwH1yvmo31YWgRHNb/x1Xhhq4/m81PhtvmRngD8iHPehxffz1SNCO+kwaePhATC+kOa/ggmvPoPza5i0Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/typescript-estree": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/scope-manager": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.27.0.tgz", - "integrity": "sha512-8oI9GwPMQmBryaaxG1tOZdxXVeMDte6NyJA4i7/TWa4fBwgnAXYlIQP+uYOeqAaLJ2JRxlG9CAyL+C+YE9Xknw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/acorn": { - "version": "8.14.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", - "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", - "dev": true, - "license": "MIT", - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-jsx": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", - "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true, - "license": "Python-2.0" - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true, - "license": "MIT" - }, - "node_modules/cross-spawn": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/debug": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", - "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/deep-is": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", - "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.22.0.tgz", - "integrity": "sha512-9V/QURhsRN40xuHXWjV64yvrzMjcz7ZyNoF2jJFmy9j/SLk0u1OLSZgXi28MrXjymnjEGSR80WCdab3RGMDveQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", - "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.19.2", - "@eslint/config-helpers": "^0.1.0", - "@eslint/core": "^0.12.0", - "@eslint/eslintrc": "^3.3.0", - "@eslint/js": "9.22.0", - "@eslint/plugin-kit": "^0.2.7", - "@humanfs/node": "^0.16.6", - "@humanwhocodes/module-importer": "^1.0.1", - "@humanwhocodes/retry": "^0.4.2", - "@types/estree": "^1.0.6", - "@types/json-schema": "^7.0.15", - "ajv": "^6.12.4", - "chalk": "^4.0.0", - "cross-spawn": "^7.0.6", - "debug": "^4.3.2", - "escape-string-regexp": "^4.0.0", - "eslint-scope": "^8.3.0", - "eslint-visitor-keys": "^4.2.0", - "espree": "^10.3.0", - "esquery": "^1.5.0", - "esutils": "^2.0.2", - "fast-deep-equal": "^3.1.3", - "file-entry-cache": "^8.0.0", - "find-up": "^5.0.0", - "glob-parent": "^6.0.2", - "ignore": "^5.2.0", - "imurmurhash": "^0.1.4", - "is-glob": "^4.0.0", - "json-stable-stringify-without-jsonify": "^1.0.1", - "lodash.merge": "^4.6.2", - "minimatch": "^3.1.2", - "natural-compare": "^1.4.0", - "optionator": "^0.9.3" - }, - "bin": { - "eslint": "bin/eslint.js" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://eslint.org/donate" - }, - "peerDependencies": { - "jiti": "*" - }, - "peerDependenciesMeta": { - "jiti": { - "optional": true - } - } - }, - "node_modules/eslint-scope": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.3.0.tgz", - "integrity": "sha512-pUNxi75F8MJ/GdeKtVLSbYg4ZI34J6C0C7sbL4YOp2exGwen7ZsuBqKzUhXd0qMQ362yET3z+uPwKeg/0C2XCQ==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^5.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/espree": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.3.0.tgz", - "integrity": "sha512-0QYC8b24HWY8zjRnDTL6RiHfDbAWn63qb4LMj1Z4b076A4une81+z03Kg7l7mn/48PUTqoLptSXez8oknU8Clg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "acorn": "^8.14.0", - "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/espree/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "estraverse": "^5.1.0" - }, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/esrecurse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "estraverse": "^5.2.0" - }, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estraverse": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", - "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.4" - }, - "engines": { - "node": ">=8.6.0" - } - }, - "node_modules/fast-glob/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fastq": { - "version": "1.17.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", - "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", - "dev": true, - "license": "ISC", - "dependencies": { - "reusify": "^1.0.4" - } - }, - "node_modules/file-entry-cache": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", - "integrity": "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "flat-cache": "^4.0.0" - }, - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "dev": true, - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "license": "MIT", - "dependencies": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/flat-cache": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", - "integrity": "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==", - "dev": true, - "license": "MIT", - "dependencies": { - "flatted": "^3.2.9", - "keyv": "^4.5.4" - }, - "engines": { - "node": ">=16" - } - }, - "node_modules/flatted": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", - "dev": true, - "license": "ISC" - }, - "node_modules/glob-parent": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", - "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.3" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/globals": { - "version": "15.15.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-15.15.0.tgz", - "integrity": "sha512-7ACyT3wmyp3I61S4fG682L0VA2RGD9otkqGJIwNUMF1SWUombIIk+af1unuDYgMm082aHYwD+mzJvv9Iu8dsgg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/graphemer": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", - "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true, - "license": "MIT" - }, - "node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/import-fresh": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", - "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true, - "license": "ISC" - }, - "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-stable-stringify-without-jsonify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "dev": true, - "license": "MIT", - "dependencies": { - "json-buffer": "3.0.1" - } - }, - "node_modules/levn": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1", - "type-check": "~0.4.0" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^5.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/lodash.merge": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", - "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true, - "license": "MIT" - }, - "node_modules/natural-compare": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true, - "license": "MIT" - }, - "node_modules/optionator": { - "version": "0.9.4", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", - "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "deep-is": "^0.1.3", - "fast-levenshtein": "^2.0.6", - "levn": "^0.4.1", - "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.5" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "yocto-queue": "^0.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "dev": true, - "license": "MIT", - "dependencies": { - "callsites": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/prelude-ls": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", - "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/punycode": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dev": true, - "license": "MIT", - "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" - } - }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "queue-microtask": "^1.2.2" - } - }, - "node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/type-check": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", - "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/typescript": { - "version": "5.5.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz", - "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==", - "dev": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/typescript-eslint": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.27.0.tgz", - "integrity": "sha512-ZZ/8+Y0rRUMuW1gJaPtLWe4ryHbsPLzzibk5Sq+IFa2aOH1Vo0gPr1fbA6pOnzBke7zC2Da4w8AyCgxKXo3lqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/eslint-plugin": "8.27.0", - "@typescript-eslint/parser": "8.27.0", - "@typescript-eslint/utils": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.27.0.tgz", - "integrity": "sha512-4henw4zkePi5p252c8ncBLzLce52SEUz2Ebj8faDnuUXz2UuHEONYcJ+G0oaCF+bYCWVZtrGzq3FD7YXetmnSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/type-utils": "8.27.0", - "@typescript-eslint/utils": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "graphemer": "^1.4.0", - "ignore": "^5.3.1", - "natural-compare": "^1.4.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/parser": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.27.0.tgz", - "integrity": "sha512-XGwIabPallYipmcOk45DpsBSgLC64A0yvdAkrwEzwZ2viqGqRUJ8eEYoPz0CWnutgAFbNMPdsGGvzjSmcWVlEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/typescript-estree": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/scope-manager": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.27.0.tgz", - "integrity": "sha512-8oI9GwPMQmBryaaxG1tOZdxXVeMDte6NyJA4i7/TWa4fBwgnAXYlIQP+uYOeqAaLJ2JRxlG9CAyL+C+YE9Xknw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/typescript-eslint/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "punycode": "^2.1.0" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/word-wrap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", - "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/yocto-queue": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/zod": { - "version": "3.23.8", - "resolved": "https://registry.npmjs.org/zod/-/zod-3.23.8.tgz", - "integrity": "sha512-XBx9AXhXktjUqnepgTiE5flcKIYWi/rme0Eaj+5Y0lftuGBq+jyRu/md4WnuxqgP1ubdpNCsYEYPxrzVHD8d6g==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/colinhacks" - } - } - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/package.json b/examples/sdks/mistral-typescript/packages/mistralai-azure/package.json deleted file mode 100644 index 85a249d3b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/package.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "name": "@mistralai/mistralai-azure", - "version": "1.6.0", - "author": "Speakeasy", - "main": "./index.js", - "sideEffects": false, - "repository": { - "type": "git", - "url": "https://github.com/mistralai/client-ts.git", - "directory": "packages/mistralai-azure" - }, - "scripts": { - "lint": "eslint --cache --max-warnings=0 src", - "build": "tsc", - "prepublishOnly": "npm run build" - }, - "peerDependencies": { - "zod": ">= 3" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "dependencies": { - - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/core.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/core.ts deleted file mode 100644 index db5720faf..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/core.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "./lib/sdks.js"; - -/** - * A minimal client to use when calling standalone SDK functions. Typically, an - * instance of this class would be instantiated once at the start of an - * application and passed around through some dependency injection mechanism to - * parts of an application that need to make SDK calls. - */ -export class MistralAzureCore extends ClientSDK {} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatComplete.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatComplete.ts deleted file mode 100644 index b73752ec2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatComplete.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralAzureCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Chat Completion - */ -export function chatComplete( - client: MistralAzureCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralAzureCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ChatCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/chat/completions")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.json(200, components.ChatCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatStream.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatStream.ts deleted file mode 100644 index e5987793b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/chatStream.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralAzureCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function chatStream( - client: MistralAzureCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralAzureCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.ChatCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/chat/completions#stream")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream({ - stream, - decoder(rawEvent) { - const schema = components.CompletionEvent$inboundSchema; - return schema.parse(rawEvent); - }, - }); - }), - { sseSentinel: "[DONE]" }, - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/ocrProcess.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/ocrProcess.ts deleted file mode 100644 index c6a96a6f1..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/funcs/ocrProcess.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralAzureCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * OCR - */ -export function ocrProcess( - client: MistralAzureCore, - request: components.OCRRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.OCRResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralAzureCore, - request: components.OCRRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.OCRResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.OCRRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/ocr")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "ocr_v1_ocr_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.OCRResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.json(200, components.OCRResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/custom_user_agent.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/custom_user_agent.ts deleted file mode 100644 index 33dcffa0a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/custom_user_agent.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { BeforeRequestContext, BeforeRequestHook, Awaitable } from './types'; - - -export class CustomUserAgentHook implements BeforeRequestHook { - beforeRequest(_: BeforeRequestContext, request: Request): Awaitable { - const userAgent = request.headers.get('user-agent') as string; - const version = userAgent.split(' ')[1]; - request.headers.set('user-agent', `mistral-azure-client-typescript/${version}`); - return request; - } -} \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/hooks.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/hooks.ts deleted file mode 100644 index d34c88497..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/hooks.ts +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { RequestInput } from "../lib/http.js"; -import { - AfterErrorContext, - AfterErrorHook, - AfterSuccessContext, - AfterSuccessHook, - BeforeCreateRequestContext, - BeforeCreateRequestHook, - BeforeRequestContext, - BeforeRequestHook, - Hook, - Hooks, - SDKInitHook, - SDKInitOptions, -} from "./types.js"; - -import { initHooks } from "./registration.js"; - -export class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[] = []; - beforeCreateRequestHooks: BeforeCreateRequestHook[] = []; - beforeRequestHooks: BeforeRequestHook[] = []; - afterSuccessHooks: AfterSuccessHook[] = []; - afterErrorHooks: AfterErrorHook[] = []; - - constructor() { - const presetHooks: Array = []; - - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - initHooks(this); - } - - registerSDKInitHook(hook: SDKInitHook) { - this.sdkInitHooks.push(hook); - } - - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) { - this.beforeCreateRequestHooks.push(hook); - } - - registerBeforeRequestHook(hook: BeforeRequestHook) { - this.beforeRequestHooks.push(hook); - } - - registerAfterSuccessHook(hook: AfterSuccessHook) { - this.afterSuccessHooks.push(hook); - } - - registerAfterErrorHook(hook: AfterErrorHook) { - this.afterErrorHooks.push(hook); - } - - sdkInit(opts: SDKInitOptions): SDKInitOptions { - return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts); - } - - beforeCreateRequest( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ): RequestInput { - let inp = input; - - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - - return inp; - } - - async beforeRequest( - hookCtx: BeforeRequestContext, - request: Request, - ): Promise { - let req = request; - - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - - return req; - } - - async afterSuccess( - hookCtx: AfterSuccessContext, - response: Response, - ): Promise { - let res = response; - - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - - return res; - } - - async afterError( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ): Promise<{ response: Response | null; error: unknown }> { - let res = response; - let err = error; - - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - - return { response: res, error: err }; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/index.ts deleted file mode 100644 index f60ec7acd..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./hooks.js"; -export * from "./types.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/registration.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/registration.ts deleted file mode 100644 index 1a8539dc4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/registration.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { Hooks } from "./types.js"; -import { CustomUserAgentHook } from "./custom_user_agent.js"; -/* - * This file is only ever generated once on the first generation and then is free to be modified. - * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them - * in this file or in separate files in the hooks folder. - */ - -export function initHooks(hooks: Hooks) { - // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook - // with an instance of a hook that implements that specific Hook interface - // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance - const customUserAgentHook = new CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook) -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/types.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/types.ts deleted file mode 100644 index f34898c0a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/hooks/types.ts +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { HTTPClient, RequestInput } from "../lib/http.js"; -import { RetryConfig } from "../lib/retries.js"; -import { SecurityState } from "../lib/security.js"; - -export type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes?: string[]; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; -}; - -export type Awaitable = T | Promise; - -export type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export type BeforeCreateRequestContext = HookContext & {}; -export type BeforeRequestContext = HookContext & {}; -export type AfterSuccessContext = HookContext & {}; -export type AfterErrorContext = HookContext & {}; - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -export interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -export interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: ( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ) => RequestInput; -} - -export interface BeforeRequestHook { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: ( - hookCtx: BeforeRequestContext, - request: Request, - ) => Awaitable; -} - -export interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: ( - hookCtx: AfterSuccessContext, - response: Response, - ) => Awaitable; -} - -export interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: ( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ) => Awaitable<{ - response: Response | null; - error: unknown; - }>; -} - -export interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export type Hook = - | SDKInitHook - | BeforeCreateRequestHook - | BeforeRequestHook - | AfterSuccessHook - | AfterErrorHook; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/index.ts deleted file mode 100644 index 5ddc765ed..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/index.ts +++ /dev/null @@ -1,7 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./lib/config.js"; -export * as files from "./lib/files.js"; -export * from "./sdk/sdk.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/base64.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/base64.ts deleted file mode 100644 index c2d5b3898..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/base64.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function bytesToBase64(u8arr: Uint8Array): string { - return btoa(String.fromCodePoint(...u8arr)); -} - -export function bytesFromBase64(encoded: string): Uint8Array { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); -} - -export function stringToBytes(str: string): Uint8Array { - return new TextEncoder().encode(str); -} - -export function stringFromBytes(u8arr: Uint8Array): string { - return new TextDecoder().decode(u8arr); -} - -export function stringToBase64(str: string): string { - return bytesToBase64(stringToBytes(str)); -} - -export function stringFromBase64(b64str: string): string { - return stringFromBytes(bytesFromBase64(b64str)); -} - -export const zodOutbound = z - .instanceof(Uint8Array) - .or(z.string().transform(stringToBytes)); - -export const zodInbound = z - .instanceof(Uint8Array) - .or(z.string().transform(bytesFromBase64)); diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/config.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/config.ts deleted file mode 100644 index a2f43d9fb..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/config.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { HTTPClient } from "./http.js"; -import { Logger } from "./logger.js"; -import { RetryConfig } from "./retries.js"; -import { Params, pathToFunc } from "./url.js"; - -/** - * EU Production server - */ -export const ServerEu = "eu"; -/** - * Contains the list of servers available to the SDK - */ -export const ServerList = { - [ServerEu]: "https://api.mistral.ai", -} as const; - -export type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -export function serverURLFromOptions(options: SDKOptions): URL | null { - let serverURL = options.serverURL; - - const params: Params = {}; - - if (!serverURL) { - const server = options.server ?? ServerEu; - serverURL = ServerList[server] || ""; - } - - const u = pathToFunc(serverURL)(params); - return new URL(u); -} - -export const SDK_METADATA = { - language: "typescript", - openapiDocVersion: "1.0.0", - sdkVersion: "1.6.0", - genVersion: "2.548.6", - userAgent: - "speakeasy-sdk/typescript 1.6.0 2.548.6 1.0.0 @mistralai/mistralai-azure", -} as const; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/dlv.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/dlv.ts deleted file mode 100644 index e81091f5e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/dlv.ts +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) 2024 Jason Miller (http://jasonformat.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -/** - * @param obj The object to walk - * @param key The key path to walk the object with - * @param def A default value to return if the result is undefined - * - * @example - * dlv(obj, "a.b.c.d") - * @example - * dlv(object, ["a", "b", "c", "d"]) - * @example - * dlv(object, "foo.bar.baz", "Hello, default value!") - */ -export function dlv( - obj: any, - key: string | string[], - def?: T, - p?: number, - undef?: never, -): T | undefined { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/encodings.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/encodings.ts deleted file mode 100644 index 25c9dcba3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/encodings.ts +++ /dev/null @@ -1,483 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { bytesToBase64 } from "./base64.js"; -import { isPlainObject } from "./is-plain-object.js"; - -export class EncodingError extends Error { - constructor(message: string) { - super(message); - this.name = "EncodingError"; - } -} - -export function encodeMatrix( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - // trim trailing '=' if value was empty - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - - // If we end up with the nothing then skip forward - if (!tmp) { - return; - } - - out += `;${tmp}`; - }); - - return out; -} - -export function encodeLabel( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let encValue: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = - options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - - out += encValue == null ? "" : `.${encValue}`; - }); - - return out; -} - -type FormEncoder = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -) => string | undefined; - -function formEncoder(sep: string): FormEncoder { - return ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, - ) => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - const encodedSep = encodeString(sep); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if (isPlainObject(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); - }; -} - -export const encodeForm = formEncoder(","); -export const encodeSpaceDelimited = formEncoder(" "); -export const encodePipeDelimited = formEncoder("|"); - -export function encodeBodyForm( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if (isPlainObject(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); -} - -export function encodeDeepObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - if (!isPlainObject(value)) { - throw new EncodingError( - `Value of parameter '${key}' which uses deepObject encoding must be an object or null`, - ); - } - - return encodeDeepObjectObject(key, value, options); -} - -export function encodeDeepObjectObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - let out = ""; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - if (!isPlainObject(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - - const pk = `${key}[${ck}]`; - - if (isPlainObject(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - - out += objOut == null ? "" : `&${objOut}`; - - return; - } - - const pairs: unknown[] = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - - out += encoded == null ? "" : `&${encoded}`; - }); - - return out.slice(1); -} - -export function encodeJSON( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - if (typeof value === "undefined") { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; -} - -export const encodeSimple = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && isPlainObject(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - - out += tmp ? `,${tmp}` : ""; - }); - - return out.slice(1); -}; - -function explode(key: string, value: unknown): [string, unknown][] { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if (isPlainObject(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } -} - -function serializeValue(value: unknown): string { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - - return `${value}`; -} - -function jsonReplacer(_: string, value: unknown): unknown { - if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else { - return value; - } -} - -function mapDefined(inp: T[], mapper: (v: T) => R): R[] | null { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - - const m = mapper(v); - if (m == null) { - return acc; - } - - acc.push(m); - - return acc; - }, []); - - return res.length ? res : null; -} - -function mapDefinedEntries( - inp: Iterable<[K, V]>, - mapper: (v: [K, V]) => R, -): R[] | null { - const acc: R[] = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - - const m = mapper([k, v]); - if (m == null) { - continue; - } - - acc.push(m); - } - - return acc.length ? acc : null; -} - -export function queryJoin(...args: (string | undefined)[]): string { - return args.filter(Boolean).join("&"); -} - -type QueryEncoderOptions = { - explode?: boolean; - charEncoding?: "percent" | "none"; -}; - -type QueryEncoder = ( - key: string, - value: unknown, - options?: QueryEncoderOptions, -) => string | undefined; - -type BulkQueryEncoder = ( - values: Record, - options?: QueryEncoderOptions, -) => string; - -export function queryEncoder(f: QueryEncoder): BulkQueryEncoder { - const bulkEncode = function ( - values: Record, - options?: QueryEncoderOptions, - ): string { - const opts: QueryEncoderOptions = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent", - }; - - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - - return bulkEncode; -} - -export const encodeJSONQuery = queryEncoder(encodeJSON); -export const encodeFormQuery = queryEncoder(encodeForm); -export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited); -export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited); -export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - -export function appendForm( - fd: FormData, - key: string, - value: unknown, - fileName?: string, -): void { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/env.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/env.ts deleted file mode 100644 index 384b519b2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/env.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { dlv } from "./dlv.js"; - -import * as z from "zod"; - -export interface Env { - MISTRAL_API_KEY?: string | undefined; - - MISTRAL_DEBUG?: boolean | undefined; -} - -export const envSchema: z.ZodType = z.object({ - MISTRAL_API_KEY: z.string().optional(), - - MISTRAL_DEBUG: z.coerce.boolean().optional(), -}); - -let envMemo: Env | undefined = undefined; -/** - * Reads and validates environment variables. - */ -export function env(): Env { - if (envMemo) { - return envMemo; - } - - envMemo = envSchema.parse( - dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {}, - ); - return envMemo; -} - -/** - * Clears the cached env object. Useful for testing with a fresh environment. - */ -export function resetEnv() { - envMemo = undefined; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/event-streams.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/event-streams.ts deleted file mode 100644 index 2ab114f24..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/event-streams.ts +++ /dev/null @@ -1,264 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - retry?: number | undefined; - id?: string | undefined; -}; -const LF = 0x0a; -const CR = 0x0d; -const NEWLINE_CHARS = new Set([LF, CR]); -const MESSAGE_BOUNDARIES = [ - new Uint8Array([CR, LF, CR, LF]), - new Uint8Array([CR, CR]), - new Uint8Array([LF, LF]), -]; - -export class EventStream> { - private readonly stream: ReadableStream; - private readonly decoder: (rawEvent: ServerEvent) => Event; - - constructor(init: { - stream: ReadableStream; - decoder: (rawEvent: ServerEvent) => Event; - }) { - this.stream = init.stream; - this.decoder = init.decoder; - } - - async *[Symbol.asyncIterator](): AsyncGenerator { - const reader = this.stream.getReader(); - let buffer = new Uint8Array([]); - let position = 0; - - try { - while (true) { - const { done, value } = await reader.read(); - if (done) { - break; - } - - const newBuffer = new Uint8Array(buffer.length + value.length); - newBuffer.set(buffer); - newBuffer.set(value, buffer.length); - buffer = newBuffer; - - for (let i = position; i < buffer.length; i++) { - const boundary = findBoundary(buffer, i); - if (boundary == null) { - continue; - } - - const chunk = buffer.slice(position, i); - position = i + boundary.length; - const event = parseEvent(chunk, this.decoder); - if (event != null) { - yield event; - } - } - - if (position > 0) { - buffer = buffer.slice(position); - position = 0; - } - } - - if (buffer.length > 0) { - const event = parseEvent(buffer, this.decoder); - if (event != null) { - yield event; - } - } - } catch (e: unknown) { - if (e instanceof Error && e.name === "AbortError") { - return; - } - - throw e; - } finally { - reader.releaseLock(); - } - } -} - -function findBoundary(buffer: Uint8Array, start: number): Uint8Array | null { - const char1 = buffer[start]; - const char2 = buffer[start + 1]; - - // Don't bother checking if the first two characters are not new line - // characters. - if ( - char1 == null - || char2 == null - || !NEWLINE_CHARS.has(char1) - || !NEWLINE_CHARS.has(char2) - ) { - return null; - } - - for (const s of MESSAGE_BOUNDARIES) { - const seq = peekSequence(start, buffer, s); - if (seq != null) { - return seq; - } - } - - return null; -} - -function peekSequence( - position: number, - buffer: Uint8Array, - sequence: Uint8Array, -): Uint8Array | null { - if (sequence.length > buffer.length - position) { - return null; - } - - for (let i = 0; i < sequence.length; i++) { - if (buffer[position + i] !== sequence[i]) { - return null; - } - } - - return sequence; -} - -function parseEvent>( - chunk: Uint8Array, - decoder: (rawEvent: ServerEvent) => Event, -) { - if (!chunk.length) { - return null; - } - - const td = new TextDecoder(); - const raw = td.decode(chunk); - const lines = raw.split(/\r?\n|\r/g); - let publish = false; - const rawEvent: ServerEvent = {}; - - for (const line of lines) { - if (!line) { - continue; - } - - const delim = line.indexOf(":"); - // Lines starting with a colon are ignored. - if (delim === 0) { - continue; - } - - const field = delim > 0 ? line.substring(0, delim) : ""; - let value = delim > 0 ? line.substring(delim + 1) : ""; - if (value.charAt(0) === " ") { - value = value.substring(1); - } - - switch (field) { - case "event": { - publish = true; - rawEvent.event = value; - break; - } - case "data": { - publish = true; - rawEvent.data ??= ""; - rawEvent.data += value + "\n"; - break; - } - case "id": { - publish = true; - rawEvent.id = value; - break; - } - case "retry": { - const r = parseInt(value, 10); - if (!Number.isNaN(r)) { - publish = true; - rawEvent.retry = r; - } - break; - } - } - } - - if (!publish) { - return null; - } - - if (rawEvent.data != null) { - rawEvent.data = rawEvent.data.slice(0, -1); - } - - return decoder(rawEvent); -} - -export function discardSentinel( - stream: ReadableStream, - sentinel: string, -): ReadableStream { - return new ReadableStream({ - async start(controller) { - let buffer = new Uint8Array([]); - let position = 0; - let done = false; - let discard = false; - const rdr = stream.getReader(); - try { - while (!done) { - const result = await rdr.read(); - const value = result.value; - done = done || result.done; - // We keep consuming from the source to its completion so it can - // flush all its contents and release resources. - if (discard) { - continue; - } - if (typeof value === "undefined") { - continue; - } - - const newBuffer = new Uint8Array(buffer.length + value.length); - newBuffer.set(buffer); - newBuffer.set(value, buffer.length); - buffer = newBuffer; - - for (let i = position; i < buffer.length; i++) { - const boundary = findBoundary(buffer, i); - if (boundary == null) { - continue; - } - - const start = position; - const chunk = buffer.slice(start, i); - position = i + boundary.length; - const event = parseEvent(chunk, id); - if (event?.data === sentinel) { - controller.enqueue(buffer.slice(0, start)); - discard = true; - } else { - controller.enqueue(buffer.slice(0, position)); - buffer = buffer.slice(position); - position = 0; - } - } - } - } catch (e) { - controller.error(e); - } finally { - // If the source stream terminates, flush its contents and terminate. - // If the sentinel event was found, flush everything up to its start. - controller.close(); - rdr.releaseLock(); - } - }, - }); -} - -function id(v: T): T { - return v; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/files.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/files.ts deleted file mode 100644 index 59d15f09b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/files.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -export async function readableStreamToArrayBuffer( - readable: ReadableStream, -): Promise { - const reader = readable.getReader(); - const chunks: Uint8Array[] = []; - - let totalLength = 0; - let done = false; - - while (!done) { - const { value, done: doneReading } = await reader.read(); - - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - - return concatenatedChunks.buffer as ArrayBuffer; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/http.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/http.ts deleted file mode 100644 index 13cf1fd78..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/http.ts +++ /dev/null @@ -1,323 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type Fetcher = ( - input: RequestInfo | URL, - init?: RequestInit, -) => Promise; - -export type Awaitable = T | Promise; - -const DEFAULT_FETCHER: Fetcher = (input, init) => { - // If input is a Request and init is undefined, Bun will discard the method, - // headers, body and other options that were set on the request object. - // Node.js and browers would ignore an undefined init value. This check is - // therefore needed for interop with Bun. - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } -}; - -export type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -export interface HTTPClientOptions { - fetcher?: Fetcher; -} - -export type BeforeRequestHook = (req: Request) => Awaitable; -export type RequestErrorHook = (err: unknown, req: Request) => Awaitable; -export type ResponseHook = (res: Response, req: Request) => Awaitable; - -export class HTTPClient { - private fetcher: Fetcher; - private requestHooks: BeforeRequestHook[] = []; - private requestErrorHooks: RequestErrorHook[] = []; - private responseHooks: ResponseHook[] = []; - - constructor(private options: HTTPClientOptions = {}) { - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - - async request(request: Request): Promise { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - - try { - const res = await this.fetcher(req); - - for (const hook of this.responseHooks) { - await hook(res, req); - } - - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - - throw err; - } - } - - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - addHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - removeHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ): this { - let target: unknown[]; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - - return this; - } - - clone(): HTTPClient { - const child = new HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - - return child; - } -} - -export type StatusCodePredicate = number | string | (number | string)[]; - -// A semicolon surrounded by optional whitespace characters is used to separate -// segments in a media type string. -const mediaParamSeparator = /\s*;\s*/g; - -export function matchContentType(response: Response, pattern: string): boolean { - // `*` is a special case which means anything is acceptable. - if (pattern === "*") { - return true; - } - - let contentType = - response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - - if (wantType.split("/").length !== 2) { - return false; - } - - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - - if ( - wantType !== "*/*" && - gotType !== wantType && - `${type}/*` !== wantType && - `*/${subtype}` !== wantType - ) { - return false; - } - - if (gotParams.length < wantParams.length) { - return false; - } - - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - - return true; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -export function matchStatusCode( - response: Response, - codes: StatusCodePredicate, -): boolean { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - - return expectedCodes.some((ec) => { - const code = `${ec}`; - - if (code === "default") { - return true; - } - - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -export function matchResponse( - response: Response, - code: StatusCodePredicate, - contentTypePattern: string, -): boolean { - return ( - matchStatusCode(response, code) && - matchContentType(response, contentTypePattern) - ); -} - -/** - * Uses various heurisitics to determine if an error is a connection error. - */ -export function isConnectionError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Covers fetch in Deno as well - const isBrowserErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("failed to fetch"); - - const isNodeErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("fetch failed"); - - const isBunErr = "name" in err && err.name === "ConnectionError"; - - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnreset"; - - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; -} - -/** - * Uses various heurisitics to determine if an error is a timeout error. - */ -export function isTimeoutError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} - -/** - * Uses various heurisitics to determine if an error is a abort error. - */ -export function isAbortError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/is-plain-object.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/is-plain-object.ts deleted file mode 100644 index 61070d3d7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/is-plain-object.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) Sindre Sorhus (https://sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -// Taken from https://github.com/sindresorhus/is-plain-obj/blob/97f38e8836f86a642cce98fc6ab3058bc36df181/index.js - -export function isPlainObject(value: unknown): value is object { - if (typeof value !== "object" || value === null) { - return false; - } - - const prototype = Object.getPrototypeOf(value); - return ( - (prototype === null || - prototype === Object.prototype || - Object.getPrototypeOf(prototype) === null) && - !(Symbol.toStringTag in value) && - !(Symbol.iterator in value) - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/logger.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/logger.ts deleted file mode 100644 index d181f2937..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/logger.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/matchers.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/matchers.ts deleted file mode 100644 index f8ec5c3c0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/matchers.ts +++ /dev/null @@ -1,325 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { Result } from "../types/fp.js"; -import { discardSentinel } from "./event-streams.js"; -import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js"; -import { isPlainObject } from "./is-plain-object.js"; -import { safeParse } from "./schemas.js"; - -export type Encoding = - | "json" - | "text" - | "bytes" - | "stream" - | "sse" - | "nil" - | "fail"; - -const DEFAULT_CONTENT_TYPES: Record = { - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*", -}; - -type Schema = { parse(raw: unknown): T }; - -type MatchOptions = { - ctype?: string; - hdrs?: boolean; - key?: string; - sseSentinel?: string; -}; - -export type ValueMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; -}; - -export type ErrorMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; - err: true; -}; - -export type FailMatcher = { - enc: "fail"; - codes: StatusCodePredicate; -}; - -export type Matcher = ValueMatcher | ErrorMatcher | FailMatcher; - -export function jsonErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "json", codes, schema }; -} -export function json( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "json", codes, schema }; -} - -export function textErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "text", codes, schema }; -} -export function text( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "text", codes, schema }; -} - -export function bytesErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "bytes", codes, schema }; -} -export function bytes( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "bytes", codes, schema }; -} - -export function streamErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "stream", codes, schema }; -} -export function stream( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "stream", codes, schema }; -} - -export function sseErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "sse", codes, schema }; -} -export function sse( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "sse", codes, schema }; -} - -export function nilErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "nil", codes, schema }; -} -export function nil( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "nil", codes, schema }; -} - -export function fail(codes: StatusCodePredicate): FailMatcher { - return { enc: "fail", codes }; -} - -export type MatchedValue = Matchers extends Matcher[] - ? T - : never; -export type MatchedError = Matchers extends Matcher[] - ? E - : never; -export type MatchFunc = ( - response: Response, - options?: { resultKey?: string; extraFields?: Record }, -) => Promise<[result: Result, raw: unknown]>; - -export function match( - ...matchers: Array> -): MatchFunc { - return async function matchFunc( - response: Response, - options?: { resultKey?: string; extraFields?: Record }, - ): Promise< - [result: Result, raw: unknown] - > { - let raw: unknown; - let matcher: Matcher | undefined; - for (const match of matchers) { - const { codes } = match; - const ctpattern = "ctype" in match - ? match.ctype - : DEFAULT_CONTENT_TYPES[match.enc]; - if (ctpattern && matchResponse(response, codes, ctpattern)) { - matcher = match; - break; - } else if (!ctpattern && matchStatusCode(response, codes)) { - matcher = match; - break; - } - } - - if (!matcher) { - const responseBody = await response.text(); - return [{ - ok: false, - error: new SDKError( - "Unexpected API response status or content-type", - response, - responseBody, - ), - }, responseBody]; - } - - const encoding = matcher.enc; - switch (encoding) { - case "json": - raw = await response.json(); - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - raw = await response.text(); - break; - case "sse": - raw = response.body && matcher.sseSentinel - ? discardSentinel(response.body, matcher.sseSentinel) - : response.body; - break; - case "nil": - raw = await discardResponseBody(response); - break; - case "fail": - raw = await response.text(); - break; - default: - encoding satisfies never; - throw new Error(`Unsupported response type: ${encoding}`); - } - - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new SDKError( - "API error occurred", - response, - typeof raw === "string" ? raw : "", - ), - }, raw]; - } - - const resultKey = matcher.key || options?.resultKey; - let data: unknown; - - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - [resultKey]: raw, - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - }; - } else { - data = raw; - } - - if ("err" in matcher) { - const result = safeParse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - ); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - ), - raw, - ]; - } - }; -} - -const headerValRE = /, */; -/** - * Iterates over a Headers object and returns an object with all the header - * entries. Values are represented as an array to account for repeated headers. - */ -export function unpackHeaders(headers: Headers): Record { - const out: Record = {}; - - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - - return out; -} - -/** - * Discards the response body to free up resources. - * - * To learn why this is need, see the undici docs: - * https://undici.nodejs.org/#/?id=garbage-collection - */ -export async function discardResponseBody(res: Response) { - const reader = res.body?.getReader(); - if (reader == null) { - return; - } - - try { - let done = false; - while (!done) { - const res = await reader.read(); - done = res.done; - } - } finally { - reader.releaseLock(); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/primitives.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/primitives.ts deleted file mode 100644 index d21f1dc49..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/primitives.ts +++ /dev/null @@ -1,150 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -class InvariantError extends Error { - constructor(message: string) { - super(message); - this.name = "InvariantError"; - } -} - -export function invariant( - condition: unknown, - message: string, -): asserts condition { - if (!condition) { - throw new InvariantError(message); - } -} - -export type ExactPartial = { - [P in keyof T]?: T[P] | undefined; -}; - -export type Remap = { - [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */ - ? Mapping[k] - : Mapping[k] extends null /* if the mapping is to `null` then drop the key */ - ? never - : k /* otherwise keep the key as-is */]: Inp[k]; -}; - -/** - * Converts or omits an object's keys according to a mapping. - * - * @param inp An object whose keys will be remapped - * @param mappings A mapping of original keys to new keys. If a key is not present in the mapping, it will be left as is. If a key is mapped to `null`, it will be removed in the resulting object. - * @returns A new object with keys remapped or omitted according to the mappings - */ -export function remap< - Inp extends Record, - const Mapping extends { [k in keyof Inp]?: string | null }, ->(inp: Inp, mappings: Mapping): Remap { - let out: any = {}; - - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - - return out; -} - -export function combineSignals( - ...signals: Array -): AbortSignal | null { - const filtered: AbortSignal[] = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } -} - -export function abortSignalAny(signals: AbortSignal[]): AbortSignal { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - - if (signals.length === 1) { - return signals[0] || controller.signal; - } - - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - - function abort(this: AbortSignal) { - controller.abort(this.reason); - clean(); - } - - const signalRefs: WeakRef[] = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - - return result; -} - -export function compactMap( - values: Record, -): Record { - const out: Record = {}; - - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - - return out; -} - -export function allRequired>( - v: V, -): - | { - [K in keyof V]: NonNullable; - } - | undefined { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - - return v as ReturnType>; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/retries.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/retries.ts deleted file mode 100644 index e3ce9aba7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/retries.ts +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { isConnectionError, isTimeoutError } from "./http.js"; - -export type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -const defaultBackoff: BackoffStrategy = { - initialInterval: 500, - maxInterval: 60000, - exponent: 1.5, - maxElapsedTime: 3600000, -}; - -export type RetryConfig = - | { strategy: "none" } - | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; - }; - -/** - * PermanentError is an error that is not recoverable. Throwing this error will - * cause a retry loop to terminate. - */ -export class PermanentError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - - constructor(message: string, options?: { cause?: unknown }) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - - super(msg, options); - this.name = "PermanentError"; - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - - Object.setPrototypeOf(this, PermanentError.prototype); - } -} - -/** - * TemporaryError is an error is used to signal that an HTTP request can be - * retried as part of a retry loop. If retry attempts are exhausted and this - * error is thrown, the response will be returned to the caller. - */ -export class TemporaryError extends Error { - response: Response; - - constructor(message: string, response: Response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - - Object.setPrototypeOf(this, TemporaryError.prototype); - } -} - -export async function retry( - fetchFn: () => Promise, - options: { - config: RetryConfig; - statusCodes: string[]; - }, -): Promise { - switch (options.config.strategy) { - case "backoff": - return retryBackoff( - wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors, - }), - options.config.backoff ?? defaultBackoff, - ); - default: - return await fetchFn(); - } -} - -function wrapFetcher( - fn: () => Promise, - options: { - statusCodes: string[]; - retryConnectionErrors: boolean; - }, -): () => Promise { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError( - "Response failed with retryable status code", - res, - ); - } - - return res; - } catch (err: unknown) { - if (err instanceof TemporaryError) { - throw err; - } - - if ( - options.retryConnectionErrors && - (isTimeoutError(err) || isConnectionError(err)) - ) { - throw err; - } - - throw new PermanentError("Permanent error", { cause: err }); - } - }; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -function isRetryableResponse(res: Response, statusCodes: string[]): boolean { - const actual = `${res.status}`; - - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -async function retryBackoff( - fn: () => Promise, - strategy: BackoffStrategy, -): Promise { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - - const start = Date.now(); - let x = 0; - - while (true) { - try { - const res = await fn(); - return res; - } catch (err: unknown) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - - throw err; - } - - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - - if (retryInterval <= 0) { - retryInterval = - initialInterval * Math.pow(x, exponent) + Math.random() * 1000; - } - - const d = Math.min(retryInterval, maxInterval); - - await delay(d); - x++; - } - } -} - -function retryIntervalFromResponse(res: Response): number { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1000; - } - - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - - return 0; -} - -async function delay(delay: number): Promise { - return new Promise((resolve) => setTimeout(resolve, delay)); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/schemas.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/schemas.ts deleted file mode 100644 index 0e340b7e4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/schemas.ts +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { - output, - ZodEffects, - ZodError, - ZodObject, - ZodRawShape, - ZodTypeAny, -} from "zod"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { ERR, OK, Result } from "../types/fp.js"; - -/** - * Utility function that executes some code which may throw a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function parse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Out { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof ZodError) { - throw new SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } -} - -/** - * Utility function that executes some code which may result in a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function safeParse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Result { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR(new SDKValidationError(errorMessage, err, rawValue)); - } -} - -export function collectExtraKeys< - Shape extends ZodRawShape, - Catchall extends ZodTypeAny, - K extends string, ->( - obj: ZodObject, - extrasKey: K, - optional: boolean, -): ZodEffects< - typeof obj, - & output> - & { - [k in K]: Record>; - } -> { - return obj.transform((val) => { - const extras: Record> = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - - extras[key] = v; - delete val[key]; - } - - if (optional && Object.keys(extras).length === 0) { - return val; - } - - return { ...val, [extrasKey]: extras }; - }); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/sdks.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/sdks.ts deleted file mode 100644 index 19e6358eb..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/sdks.ts +++ /dev/null @@ -1,395 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKHooks } from "../hooks/hooks.js"; -import { HookContext } from "../hooks/types.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { ERR, OK, Result } from "../types/fp.js"; -import { stringToBase64 } from "./base64.js"; -import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js"; -import { encodeForm } from "./encodings.js"; -import { env } from "./env.js"; -import { - HTTPClient, - isAbortError, - isConnectionError, - isTimeoutError, - matchContentType, - matchStatusCode, -} from "./http.js"; -import { Logger } from "./logger.js"; -import { retry, RetryConfig } from "./retries.js"; -import { SecurityState } from "./security.js"; - -export type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -}; - -type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - timeoutMs?: number; -}; - -const gt: unknown = typeof globalThis === "undefined" ? null : globalThis; -const webWorkerLike = typeof gt === "object" - && gt != null - && "importScripts" in gt - && typeof gt["importScripts"] === "function"; -const isBrowserLike = webWorkerLike - || (typeof navigator !== "undefined" && "serviceWorker" in navigator) - || (typeof window === "object" && typeof window.document !== "undefined"); - -export class ClientSDK { - readonly #httpClient: HTTPClient; - readonly #hooks: SDKHooks; - readonly #logger?: Logger | undefined; - public readonly _baseURL: URL | null; - public readonly _options: SDKOptions & { hooks?: SDKHooks }; - - constructor(options: SDKOptions = {}) { - const opt = options as unknown; - if ( - typeof opt === "object" - && opt != null - && "hooks" in opt - && opt.hooks instanceof SDKHooks - ) { - this.#hooks = opt.hooks; - } else { - this.#hooks = new SDKHooks(); - } - this._options = { ...options, hooks: this.#hooks }; - - const url = serverURLFromOptions(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = this.#hooks.sdkInit({ - baseURL: url, - client: options.httpClient || new HTTPClient(), - }); - this._baseURL = baseURL; - this.#httpClient = client; - this.#logger = options.debugLogger; - if (!this.#logger && env().MISTRAL_DEBUG) { - this.#logger = console; - } - } - - public _createRequest( - context: HookContext, - conf: RequestConfig, - options?: RequestOptions, - ): Result { - const { method, path, query, headers: opHeaders, security } = conf; - - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return ERR(new InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - - let finalQuery = query || ""; - - const secQuery: string[] = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = encodeForm(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - - const headers = new Headers(opHeaders); - - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = stringToBase64( - [username || "", password || ""].join(":"), - ); - headers.set("Authorization", `Basic ${encoded}`); - } - - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - - const userHeaders = new Headers(options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - - // Only set user agent header in non-browser-like environments since CORS - // policy disallows setting it in browsers e.g. Chrome throws an error. - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent); - } - - let fetchOptions = options?.fetchOptions; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - if (!fetchOptions) { - fetchOptions = { signal: timeoutSignal }; - } else { - fetchOptions.signal = timeoutSignal; - } - } - - if (conf.body instanceof ReadableStream) { - if (!fetchOptions) { - fetchOptions = {}; - } - Object.assign(fetchOptions, { duplex: "half" }); - } - - let input; - try { - input = this.#hooks.beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method, - }, - }); - } catch (err: unknown) { - return ERR( - new UnexpectedClientError("Create request hook failed to execute", { - cause: err, - }), - ); - } - - return OK(new Request(input.url, input.options)); - } - - public async _do( - request: Request, - options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }, - ): Promise< - Result< - Response, - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - | UnexpectedClientError - > - > { - const { context, errorCodes } = options; - - return retry( - async () => { - const req = await this.#hooks.beforeRequest(context, request.clone()); - await logRequest(this.#logger, req).catch((e) => - this.#logger?.log("Failed to log request:", e) - ); - - let response = await this.#httpClient.request(req); - - try { - if (matchStatusCode(response, errorCodes)) { - const result = await this.#hooks.afterError( - context, - response, - null, - ); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await this.#hooks.afterSuccess(context, response); - } - } finally { - await logResponse(this.#logger, response, req) - .catch(e => this.#logger?.log("Failed to log response:", e)); - } - - return response; - }, - { config: options.retryConfig, statusCodes: options.retryCodes }, - ).then( - (r) => OK(r), - (err) => { - switch (true) { - case isAbortError(err): - return ERR( - new RequestAbortedError("Request aborted by client", { - cause: err, - }), - ); - case isTimeoutError(err): - return ERR( - new RequestTimeoutError("Request timed out", { cause: err }), - ); - case isConnectionError(err): - return ERR( - new ConnectionError("Unable to make request", { cause: err }), - ); - default: - return ERR( - new UnexpectedClientError("Unexpected HTTP client error", { - cause: err, - }), - ); - } - }, - ); - } -} - -const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/; -async function logRequest(logger: Logger | undefined, req: Request) { - if (!logger) { - return; - } - - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`> Request: ${req.method} ${req.url}`); - - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} - -async function logResponse( - logger: Logger | undefined, - res: Response, - req: Request, -) { - if (!logger) { - return; - } - - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case matchContentType(res, "application/json") - || jsonLikeContentTypeRE.test(ct): - logger.log(await res.clone().json()); - break; - case matchContentType(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case matchContentType(res, "text/*"): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/security.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/security.ts deleted file mode 100644 index 4bc0dd91a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/security.ts +++ /dev/null @@ -1,253 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as components from "../models/components/index.js"; -import { env } from "./env.js"; -type OAuth2PasswordFlow = { - username: string; - password?: string | undefined; - clientID: string; - clientSecret?: string | undefined; - tokenURL: string; -}; - -export enum SecurityErrorCode { - Incomplete = "incomplete", - UnrecognisedSecurityType = "unrecognized_security_type", -} - -export class SecurityError extends Error { - constructor( - public code: SecurityErrorCode, - message: string, - ) { - super(message); - this.name = "SecurityError"; - } - - static incomplete(): SecurityError { - return new SecurityError( - SecurityErrorCode.Incomplete, - "Security requirements not met in order to perform the operation", - ); - } - static unrecognizedType(type: string): SecurityError { - return new SecurityError( - SecurityErrorCode.UnrecognisedSecurityType, - `Unrecognised security type: ${type}`, - ); - } -} - -export type SecurityState = { - basic: { username?: string | undefined; password?: string | undefined }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" }; -}; - -type SecurityInputBasic = { - type: "http:basic"; - value: - | { username?: string | undefined; password?: string | undefined } - | null - | undefined; -}; - -type SecurityInputBearer = { - type: "http:bearer"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputAPIKey = { - type: "apiKey:header" | "apiKey:query" | "apiKey:cookie"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOIDC = { - type: "openIdConnect"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2 = { - type: "oauth2"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2ClientCredentials = { - type: "oauth2:client_credentials"; - value: - | { clientID?: string | undefined; clientSecret?: string | undefined } - | null - | undefined; -}; - -type SecurityInputOAuth2PasswordCredentials = { - type: "oauth2:password"; - value: - | string - | null - | undefined; - fieldName: string; -}; - -type SecurityInputCustom = { - type: "http:custom"; - value: any | null | undefined; - fieldName: string; -}; - -export type SecurityInput = - | SecurityInputBasic - | SecurityInputBearer - | SecurityInputAPIKey - | SecurityInputOAuth2 - | SecurityInputOAuth2ClientCredentials - | SecurityInputOAuth2PasswordCredentials - | SecurityInputOIDC - | SecurityInputCustom; - -export function resolveSecurity( - ...options: SecurityInput[][] -): SecurityState | null { - const state: SecurityState = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" }, - }; - - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return ( - typeof o.value === "string" && !!o.value - ); - } else if (o.type === "oauth2:client_credentials") { - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error( - `Unrecognized security type: ${o.type} (value type: ${typeof o - .value})`, - ); - } - }); - }); - if (option == null) { - return null; - } - - option.forEach((spec) => { - if (spec.value == null) { - return; - } - - const { type } = spec; - - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec satisfies never; - throw SecurityError.unrecognizedType(type); - } - }); - - return state; -} - -function applyBasic( - state: SecurityState, - spec: SecurityInputBasic, -) { - if (spec.value == null) { - return; - } - - state.basic = spec.value; -} - -function applyBearer( - state: SecurityState, - spec: - | SecurityInputBearer - | SecurityInputOAuth2 - | SecurityInputOIDC - | SecurityInputOAuth2PasswordCredentials, -) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - - state.headers[spec.fieldName] = value; -} - -export function resolveGlobalSecurity( - security: Partial | null | undefined, -): SecurityState | null { - return resolveSecurity( - [ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey ?? env().MISTRAL_API_KEY, - }, - ], - ); -} - -export async function extractSecurity< - T extends string | Record, ->(sec: T | (() => Promise) | undefined): Promise { - if (sec == null) { - return; - } - - return typeof sec === "function" ? sec() : sec; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/url.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/url.ts deleted file mode 100644 index 6bc6356e2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/lib/url.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const hasOwn = Object.prototype.hasOwnProperty; - -export type Params = Partial>; - -export function pathToFunc( - pathPattern: string, - options?: { charEncoding?: "percent" | "none" }, -): (params?: Params) => string { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - - return function buildURLPath(params: Record = {}): string { - return pathPattern.replace(paramRE, function (_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error( - `Parameter '${placeholder}' must be a string or number`, - ); - } - - return options?.charEncoding === "percent" - ? encodeURIComponent(`${value}`) - : `${value}`; - }); - }; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/assistantmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/assistantmessage.ts deleted file mode 100644 index 02414e460..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/assistantmessage.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type AssistantMessageContent = string | Array; - -export const AssistantMessageRole = { - Assistant: "assistant", -} as const; -export type AssistantMessageRole = ClosedEnum; - -export type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** @internal */ -export const AssistantMessageContent$inboundSchema: z.ZodType< - AssistantMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type AssistantMessageContent$Outbound = - | string - | Array; - -/** @internal */ -export const AssistantMessageContent$outboundSchema: z.ZodType< - AssistantMessageContent$Outbound, - z.ZodTypeDef, - AssistantMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageContent$inboundSchema; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageContent$outboundSchema; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - export type Outbound = AssistantMessageContent$Outbound; -} - -export function assistantMessageContentToJSON( - assistantMessageContent: AssistantMessageContent, -): string { - return JSON.stringify( - AssistantMessageContent$outboundSchema.parse(assistantMessageContent), - ); -} - -export function assistantMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessageContent' from JSON`, - ); -} - -/** @internal */ -export const AssistantMessageRole$inboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = z.nativeEnum(AssistantMessageRole); - -/** @internal */ -export const AssistantMessageRole$outboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = AssistantMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageRole$inboundSchema; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageRole$outboundSchema; -} - -/** @internal */ -export const AssistantMessage$inboundSchema: z.ZodType< - AssistantMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$inboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -export const AssistantMessage$outboundSchema: z.ZodType< - AssistantMessage$Outbound, - z.ZodTypeDef, - AssistantMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$outboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - export const inboundSchema = AssistantMessage$inboundSchema; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - export const outboundSchema = AssistantMessage$outboundSchema; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - export type Outbound = AssistantMessage$Outbound; -} - -export function assistantMessageToJSON( - assistantMessage: AssistantMessage, -): string { - return JSON.stringify( - AssistantMessage$outboundSchema.parse(assistantMessage), - ); -} - -export function assistantMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionchoice.ts deleted file mode 100644 index 899d72067..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionchoice.ts +++ /dev/null @@ -1,137 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; - -export const ChatCompletionChoiceFinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type ChatCompletionChoiceFinishReason = OpenEnum< - typeof ChatCompletionChoiceFinishReason ->; - -export type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: ChatCompletionChoiceFinishReason; -}; - -/** @internal */ -export const ChatCompletionChoiceFinishReason$inboundSchema: z.ZodType< - ChatCompletionChoiceFinishReason, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ChatCompletionChoiceFinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ChatCompletionChoiceFinishReason$outboundSchema: z.ZodType< - ChatCompletionChoiceFinishReason, - z.ZodTypeDef, - ChatCompletionChoiceFinishReason -> = z.union([ - z.nativeEnum(ChatCompletionChoiceFinishReason), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionChoiceFinishReason$ { - /** @deprecated use `ChatCompletionChoiceFinishReason$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionChoiceFinishReason$inboundSchema; - /** @deprecated use `ChatCompletionChoiceFinishReason$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionChoiceFinishReason$outboundSchema; -} - -/** @internal */ -export const ChatCompletionChoice$inboundSchema: z.ZodType< - ChatCompletionChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - message: AssistantMessage$inboundSchema, - finish_reason: ChatCompletionChoiceFinishReason$inboundSchema, -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -export const ChatCompletionChoice$outboundSchema: z.ZodType< - ChatCompletionChoice$Outbound, - z.ZodTypeDef, - ChatCompletionChoice -> = z.object({ - index: z.number().int(), - message: AssistantMessage$outboundSchema, - finishReason: ChatCompletionChoiceFinishReason$outboundSchema, -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionChoice$inboundSchema; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionChoice$outboundSchema; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - export type Outbound = ChatCompletionChoice$Outbound; -} - -export function chatCompletionChoiceToJSON( - chatCompletionChoice: ChatCompletionChoice, -): string { - return JSON.stringify( - ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice), - ); -} - -export function chatCompletionChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionrequest.ts deleted file mode 100644 index 1a2ed66de..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionrequest.ts +++ /dev/null @@ -1,519 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type ChatCompletionRequestStop = string | Array; - -export type ChatCompletionRequestMessages = - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }); - -export type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionRequest = { - /** - * The ID of the model to use for this request. - */ - model?: string | undefined; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionRequestStop$inboundSchema: z.ZodType< - ChatCompletionRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type ChatCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -export const ChatCompletionRequestStop$outboundSchema: z.ZodType< - ChatCompletionRequestStop$Outbound, - z.ZodTypeDef, - ChatCompletionRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestStop$ { - /** @deprecated use `ChatCompletionRequestStop$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestStop$inboundSchema; - /** @deprecated use `ChatCompletionRequestStop$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestStop$outboundSchema; - /** @deprecated use `ChatCompletionRequestStop$Outbound` instead. */ - export type Outbound = ChatCompletionRequestStop$Outbound; -} - -export function chatCompletionRequestStopToJSON( - chatCompletionRequestStop: ChatCompletionRequestStop, -): string { - return JSON.stringify( - ChatCompletionRequestStop$outboundSchema.parse(chatCompletionRequestStop), - ); -} - -export function chatCompletionRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestStop' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequestMessages$inboundSchema: z.ZodType< - ChatCompletionRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** @internal */ -export type ChatCompletionRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }); - -/** @internal */ -export const ChatCompletionRequestMessages$outboundSchema: z.ZodType< - ChatCompletionRequestMessages$Outbound, - z.ZodTypeDef, - ChatCompletionRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestMessages$ { - /** @deprecated use `ChatCompletionRequestMessages$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestMessages$inboundSchema; - /** @deprecated use `ChatCompletionRequestMessages$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestMessages$outboundSchema; - /** @deprecated use `ChatCompletionRequestMessages$Outbound` instead. */ - export type Outbound = ChatCompletionRequestMessages$Outbound; -} - -export function chatCompletionRequestMessagesToJSON( - chatCompletionRequestMessages: ChatCompletionRequestMessages, -): string { - return JSON.stringify( - ChatCompletionRequestMessages$outboundSchema.parse( - chatCompletionRequestMessages, - ), - ); -} - -export function chatCompletionRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -export function chatCompletionRequestToolChoiceToJSON( - chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionRequestToolChoice$outboundSchema.parse( - chatCompletionRequestToolChoice, - ), - ); -} - -export function chatCompletionRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequest$inboundSchema: z.ZodType< - ChatCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string().default("azureai"), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt", - }); -}); - -/** @internal */ -export type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionRequest$outboundSchema: z.ZodType< - ChatCompletionRequest$Outbound, - z.ZodTypeDef, - ChatCompletionRequest -> = z.object({ - model: z.string().default("azureai"), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequest$inboundSchema; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequest$outboundSchema; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - export type Outbound = ChatCompletionRequest$Outbound; -} - -export function chatCompletionRequestToJSON( - chatCompletionRequest: ChatCompletionRequest, -): string { - return JSON.stringify( - ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest), - ); -} - -export function chatCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionresponse.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionresponse.ts deleted file mode 100644 index 941fcf6c5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionresponse.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ChatCompletionChoice, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, -} from "./chatcompletionchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -/** @internal */ -export const ChatCompletionResponse$inboundSchema: z.ZodType< - ChatCompletionResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$inboundSchema), -}); - -/** @internal */ -export type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -export const ChatCompletionResponse$outboundSchema: z.ZodType< - ChatCompletionResponse$Outbound, - z.ZodTypeDef, - ChatCompletionResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionResponse$inboundSchema; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionResponse$outboundSchema; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - export type Outbound = ChatCompletionResponse$Outbound; -} - -export function chatCompletionResponseToJSON( - chatCompletionResponse: ChatCompletionResponse, -): string { - return JSON.stringify( - ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse), - ); -} - -export function chatCompletionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionstreamrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionstreamrequest.ts deleted file mode 100644 index 5447db5b9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/chatcompletionstreamrequest.ts +++ /dev/null @@ -1,505 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type Stop = string | Array; - -export type Messages = - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }); - -export type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionStreamRequest = { - /** - * The ID of the model to use for this request. - */ - model?: string | undefined; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -/** @internal */ -export const Stop$inboundSchema: z.ZodType = z - .union([z.string(), z.array(z.string())]); - -/** @internal */ -export type Stop$Outbound = string | Array; - -/** @internal */ -export const Stop$outboundSchema: z.ZodType = - z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - export const inboundSchema = Stop$inboundSchema; - /** @deprecated use `Stop$outboundSchema` instead. */ - export const outboundSchema = Stop$outboundSchema; - /** @deprecated use `Stop$Outbound` instead. */ - export type Outbound = Stop$Outbound; -} - -export function stopToJSON(stop: Stop): string { - return JSON.stringify(Stop$outboundSchema.parse(stop)); -} - -export function stopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Stop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Stop' from JSON`, - ); -} - -/** @internal */ -export const Messages$inboundSchema: z.ZodType< - Messages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** @internal */ -export type Messages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }); - -/** @internal */ -export const Messages$outboundSchema: z.ZodType< - Messages$Outbound, - z.ZodTypeDef, - Messages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - export const inboundSchema = Messages$inboundSchema; - /** @deprecated use `Messages$outboundSchema` instead. */ - export const outboundSchema = Messages$outboundSchema; - /** @deprecated use `Messages$Outbound` instead. */ - export type Outbound = Messages$Outbound; -} - -export function messagesToJSON(messages: Messages): string { - return JSON.stringify(Messages$outboundSchema.parse(messages)); -} - -export function messagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Messages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Messages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionStreamRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = - ChatCompletionStreamRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = - ChatCompletionStreamRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -export function chatCompletionStreamRequestToolChoiceToJSON( - chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionStreamRequestToolChoice$outboundSchema.parse( - chatCompletionStreamRequestToolChoice, - ), - ); -} - -export function chatCompletionStreamRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequest$inboundSchema: z.ZodType< - ChatCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string().default("azureai"), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt", - }); -}); - -/** @internal */ -export type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionStreamRequest$outboundSchema: z.ZodType< - ChatCompletionStreamRequest$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequest -> = z.object({ - model: z.string().default("azureai"), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionStreamRequest$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionStreamRequest$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequest$Outbound; -} - -export function chatCompletionStreamRequestToJSON( - chatCompletionStreamRequest: ChatCompletionStreamRequest, -): string { - return JSON.stringify( - ChatCompletionStreamRequest$outboundSchema.parse( - chatCompletionStreamRequest, - ), - ); -} - -export function chatCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionchunk.ts deleted file mode 100644 index 31e00897d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionchunk.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionResponseStreamChoice, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, -} from "./completionresponsestreamchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$inboundSchema: z.ZodType< - CompletionChunk, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$inboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$inboundSchema), -}); - -/** @internal */ -export type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$outboundSchema: z.ZodType< - CompletionChunk$Outbound, - z.ZodTypeDef, - CompletionChunk -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$outboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - export const inboundSchema = CompletionChunk$inboundSchema; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - export const outboundSchema = CompletionChunk$outboundSchema; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - export type Outbound = CompletionChunk$Outbound; -} - -export function completionChunkToJSON( - completionChunk: CompletionChunk, -): string { - return JSON.stringify(CompletionChunk$outboundSchema.parse(completionChunk)); -} - -export function completionChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionevent.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionevent.ts deleted file mode 100644 index b377901b7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionevent.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, -} from "./completionchunk.js"; - -export type CompletionEvent = { - data: CompletionChunk; -}; - -/** @internal */ -export const CompletionEvent$inboundSchema: z.ZodType< - CompletionEvent, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}`, - }); - return z.NEVER; - } - }).pipe(CompletionChunk$inboundSchema), -}); - -/** @internal */ -export type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -export const CompletionEvent$outboundSchema: z.ZodType< - CompletionEvent$Outbound, - z.ZodTypeDef, - CompletionEvent -> = z.object({ - data: CompletionChunk$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - export const inboundSchema = CompletionEvent$inboundSchema; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - export const outboundSchema = CompletionEvent$outboundSchema; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - export type Outbound = CompletionEvent$Outbound; -} - -export function completionEventToJSON( - completionEvent: CompletionEvent, -): string { - return JSON.stringify(CompletionEvent$outboundSchema.parse(completionEvent)); -} - -export function completionEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionresponsestreamchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionresponsestreamchoice.ts deleted file mode 100644 index 323645c55..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/completionresponsestreamchoice.ts +++ /dev/null @@ -1,136 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DeltaMessage, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, -} from "./deltamessage.js"; - -export const FinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type FinishReason = OpenEnum; - -export type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: FinishReason | null; -}; - -/** @internal */ -export const FinishReason$inboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(FinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const FinishReason$outboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - FinishReason -> = z.union([ - z.nativeEnum(FinishReason), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - export const inboundSchema = FinishReason$inboundSchema; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - export const outboundSchema = FinishReason$outboundSchema; -} - -/** @internal */ -export const CompletionResponseStreamChoice$inboundSchema: z.ZodType< - CompletionResponseStreamChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$inboundSchema, - finish_reason: z.nullable(FinishReason$inboundSchema), -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -export const CompletionResponseStreamChoice$outboundSchema: z.ZodType< - CompletionResponseStreamChoice$Outbound, - z.ZodTypeDef, - CompletionResponseStreamChoice -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$outboundSchema, - finishReason: z.nullable(FinishReason$outboundSchema), -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - export const inboundSchema = CompletionResponseStreamChoice$inboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - export const outboundSchema = CompletionResponseStreamChoice$outboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - export type Outbound = CompletionResponseStreamChoice$Outbound; -} - -export function completionResponseStreamChoiceToJSON( - completionResponseStreamChoice: CompletionResponseStreamChoice, -): string { - return JSON.stringify( - CompletionResponseStreamChoice$outboundSchema.parse( - completionResponseStreamChoice, - ), - ); -} - -export function completionResponseStreamChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionResponseStreamChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/contentchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/contentchunk.ts deleted file mode 100644 index 3410a04f0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/contentchunk.ts +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - ReferenceChunk, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, -} from "./referencechunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; - -export type ContentChunk = - | (ImageURLChunk & { type: "image_url" }) - | (TextChunk & { type: "text" }) - | (ReferenceChunk & { type: "reference" }); - -/** @internal */ -export const ContentChunk$inboundSchema: z.ZodType< - ContentChunk, - z.ZodTypeDef, - unknown -> = z.union([ - ImageURLChunk$inboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$inboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$inboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type ContentChunk$Outbound = - | (ImageURLChunk$Outbound & { type: "image_url" }) - | (TextChunk$Outbound & { type: "text" }) - | (ReferenceChunk$Outbound & { type: "reference" }); - -/** @internal */ -export const ContentChunk$outboundSchema: z.ZodType< - ContentChunk$Outbound, - z.ZodTypeDef, - ContentChunk -> = z.union([ - ImageURLChunk$outboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$outboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$outboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - export const inboundSchema = ContentChunk$inboundSchema; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - export const outboundSchema = ContentChunk$outboundSchema; - /** @deprecated use `ContentChunk$Outbound` instead. */ - export type Outbound = ContentChunk$Outbound; -} - -export function contentChunkToJSON(contentChunk: ContentChunk): string { - return JSON.stringify(ContentChunk$outboundSchema.parse(contentChunk)); -} - -export function contentChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ContentChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ContentChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/deltamessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/deltamessage.ts deleted file mode 100644 index f01a3bf19..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/deltamessage.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type Content = string | Array; - -export type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -/** @internal */ -export const Content$inboundSchema: z.ZodType = - z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type Content$Outbound = string | Array; - -/** @internal */ -export const Content$outboundSchema: z.ZodType< - Content$Outbound, - z.ZodTypeDef, - Content -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - export const inboundSchema = Content$inboundSchema; - /** @deprecated use `Content$outboundSchema` instead. */ - export const outboundSchema = Content$outboundSchema; - /** @deprecated use `Content$Outbound` instead. */ - export type Outbound = Content$Outbound; -} - -export function contentToJSON(content: Content): string { - return JSON.stringify(Content$outboundSchema.parse(content)); -} - -export function contentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Content$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Content' from JSON`, - ); -} - -/** @internal */ -export const DeltaMessage$inboundSchema: z.ZodType< - DeltaMessage, - z.ZodTypeDef, - unknown -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -export const DeltaMessage$outboundSchema: z.ZodType< - DeltaMessage$Outbound, - z.ZodTypeDef, - DeltaMessage -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - export const inboundSchema = DeltaMessage$inboundSchema; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - export const outboundSchema = DeltaMessage$outboundSchema; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - export type Outbound = DeltaMessage$Outbound; -} - -export function deltaMessageToJSON(deltaMessage: DeltaMessage): string { - return JSON.stringify(DeltaMessage$outboundSchema.parse(deltaMessage)); -} - -export function deltaMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DeltaMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DeltaMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/documenturlchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/documenturlchunk.ts deleted file mode 100644 index e4edca21a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/documenturlchunk.ts +++ /dev/null @@ -1,115 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const DocumentURLChunkType = { - DocumentUrl: "document_url", -} as const; -export type DocumentURLChunkType = ClosedEnum; - -export type DocumentURLChunk = { - documentUrl: string; - /** - * The filename of the document - */ - documentName?: string | null | undefined; - type?: DocumentURLChunkType | undefined; -}; - -/** @internal */ -export const DocumentURLChunkType$inboundSchema: z.ZodNativeEnum< - typeof DocumentURLChunkType -> = z.nativeEnum(DocumentURLChunkType); - -/** @internal */ -export const DocumentURLChunkType$outboundSchema: z.ZodNativeEnum< - typeof DocumentURLChunkType -> = DocumentURLChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentURLChunkType$ { - /** @deprecated use `DocumentURLChunkType$inboundSchema` instead. */ - export const inboundSchema = DocumentURLChunkType$inboundSchema; - /** @deprecated use `DocumentURLChunkType$outboundSchema` instead. */ - export const outboundSchema = DocumentURLChunkType$outboundSchema; -} - -/** @internal */ -export const DocumentURLChunk$inboundSchema: z.ZodType< - DocumentURLChunk, - z.ZodTypeDef, - unknown -> = z.object({ - document_url: z.string(), - document_name: z.nullable(z.string()).optional(), - type: DocumentURLChunkType$inboundSchema.default("document_url"), -}).transform((v) => { - return remap$(v, { - "document_url": "documentUrl", - "document_name": "documentName", - }); -}); - -/** @internal */ -export type DocumentURLChunk$Outbound = { - document_url: string; - document_name?: string | null | undefined; - type: string; -}; - -/** @internal */ -export const DocumentURLChunk$outboundSchema: z.ZodType< - DocumentURLChunk$Outbound, - z.ZodTypeDef, - DocumentURLChunk -> = z.object({ - documentUrl: z.string(), - documentName: z.nullable(z.string()).optional(), - type: DocumentURLChunkType$outboundSchema.default("document_url"), -}).transform((v) => { - return remap$(v, { - documentUrl: "document_url", - documentName: "document_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentURLChunk$ { - /** @deprecated use `DocumentURLChunk$inboundSchema` instead. */ - export const inboundSchema = DocumentURLChunk$inboundSchema; - /** @deprecated use `DocumentURLChunk$outboundSchema` instead. */ - export const outboundSchema = DocumentURLChunk$outboundSchema; - /** @deprecated use `DocumentURLChunk$Outbound` instead. */ - export type Outbound = DocumentURLChunk$Outbound; -} - -export function documentURLChunkToJSON( - documentURLChunk: DocumentURLChunk, -): string { - return JSON.stringify( - DocumentURLChunk$outboundSchema.parse(documentURLChunk), - ); -} - -export function documentURLChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentURLChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentURLChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/filechunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/filechunk.ts deleted file mode 100644 index 8802c335f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/filechunk.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FileChunk = { - type?: "file" | undefined; - fileId: string; -}; - -/** @internal */ -export const FileChunk$inboundSchema: z.ZodType< - FileChunk, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("file").default("file"), - file_id: z.string(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FileChunk$Outbound = { - type: "file"; - file_id: string; -}; - -/** @internal */ -export const FileChunk$outboundSchema: z.ZodType< - FileChunk$Outbound, - z.ZodTypeDef, - FileChunk -> = z.object({ - type: z.literal("file").default("file" as const), - fileId: z.string(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FileChunk$ { - /** @deprecated use `FileChunk$inboundSchema` instead. */ - export const inboundSchema = FileChunk$inboundSchema; - /** @deprecated use `FileChunk$outboundSchema` instead. */ - export const outboundSchema = FileChunk$outboundSchema; - /** @deprecated use `FileChunk$Outbound` instead. */ - export type Outbound = FileChunk$Outbound; -} - -export function fileChunkToJSON(fileChunk: FileChunk): string { - return JSON.stringify(FileChunk$outboundSchema.parse(fileChunk)); -} - -export function fileChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FileChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FileChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/function.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/function.ts deleted file mode 100644 index daa47c664..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/function.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$inboundSchema: z.ZodType< - FunctionT, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** @internal */ -export type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$outboundSchema: z.ZodType< - FunctionT$Outbound, - z.ZodTypeDef, - FunctionT -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - export const inboundSchema = FunctionT$inboundSchema; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - export const outboundSchema = FunctionT$outboundSchema; - /** @deprecated use `FunctionT$Outbound` instead. */ - export type Outbound = FunctionT$Outbound; -} - -export function functionToJSON(functionT: FunctionT): string { - return JSON.stringify(FunctionT$outboundSchema.parse(functionT)); -} - -export function functionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionT$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionT' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functioncall.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functioncall.ts deleted file mode 100644 index ffaa036a8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functioncall.ts +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Arguments = { [k: string]: any } | string; - -export type FunctionCall = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const Arguments$inboundSchema: z.ZodType< - Arguments, - z.ZodTypeDef, - unknown -> = z.union([z.record(z.any()), z.string()]); - -/** @internal */ -export type Arguments$Outbound = { [k: string]: any } | string; - -/** @internal */ -export const Arguments$outboundSchema: z.ZodType< - Arguments$Outbound, - z.ZodTypeDef, - Arguments -> = z.union([z.record(z.any()), z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - export const inboundSchema = Arguments$inboundSchema; - /** @deprecated use `Arguments$outboundSchema` instead. */ - export const outboundSchema = Arguments$outboundSchema; - /** @deprecated use `Arguments$Outbound` instead. */ - export type Outbound = Arguments$Outbound; -} - -export function argumentsToJSON(value: Arguments): string { - return JSON.stringify(Arguments$outboundSchema.parse(value)); -} - -export function argumentsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Arguments$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Arguments' from JSON`, - ); -} - -/** @internal */ -export const FunctionCall$inboundSchema: z.ZodType< - FunctionCall, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** @internal */ -export type FunctionCall$Outbound = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const FunctionCall$outboundSchema: z.ZodType< - FunctionCall$Outbound, - z.ZodTypeDef, - FunctionCall -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - export const inboundSchema = FunctionCall$inboundSchema; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - export const outboundSchema = FunctionCall$outboundSchema; - /** @deprecated use `FunctionCall$Outbound` instead. */ - export type Outbound = FunctionCall$Outbound; -} - -export function functionCallToJSON(functionCall: FunctionCall): string { - return JSON.stringify(FunctionCall$outboundSchema.parse(functionCall)); -} - -export function functionCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functionname.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functionname.ts deleted file mode 100644 index e26279046..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/functionname.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -export type FunctionName = { - name: string; -}; - -/** @internal */ -export const FunctionName$inboundSchema: z.ZodType< - FunctionName, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), -}); - -/** @internal */ -export type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -export const FunctionName$outboundSchema: z.ZodType< - FunctionName$Outbound, - z.ZodTypeDef, - FunctionName -> = z.object({ - name: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - export const inboundSchema = FunctionName$inboundSchema; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - export const outboundSchema = FunctionName$outboundSchema; - /** @deprecated use `FunctionName$Outbound` instead. */ - export type Outbound = FunctionName$Outbound; -} - -export function functionNameToJSON(functionName: FunctionName): string { - return JSON.stringify(FunctionName$outboundSchema.parse(functionName)); -} - -export function functionNameFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionName$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionName' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurl.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurl.ts deleted file mode 100644 index 5086e232b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurl.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$inboundSchema: z.ZodType< - ImageURL, - z.ZodTypeDef, - unknown -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$outboundSchema: z.ZodType< - ImageURL$Outbound, - z.ZodTypeDef, - ImageURL -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURL$inboundSchema; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURL$outboundSchema; - /** @deprecated use `ImageURL$Outbound` instead. */ - export type Outbound = ImageURL$Outbound; -} - -export function imageURLToJSON(imageURL: ImageURL): string { - return JSON.stringify(ImageURL$outboundSchema.parse(imageURL)); -} - -export function imageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURL' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurlchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurlchunk.ts deleted file mode 100644 index 7feb19366..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/imageurlchunk.ts +++ /dev/null @@ -1,161 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, -} from "./imageurl.js"; - -export type ImageURLChunkImageURL = ImageURL | string; - -export const ImageURLChunkType = { - ImageUrl: "image_url", -} as const; -export type ImageURLChunkType = ClosedEnum; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -export type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -/** @internal */ -export const ImageURLChunkImageURL$inboundSchema: z.ZodType< - ImageURLChunkImageURL, - z.ZodTypeDef, - unknown -> = z.union([ImageURL$inboundSchema, z.string()]); - -/** @internal */ -export type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -export const ImageURLChunkImageURL$outboundSchema: z.ZodType< - ImageURLChunkImageURL$Outbound, - z.ZodTypeDef, - ImageURLChunkImageURL -> = z.union([ImageURL$outboundSchema, z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkImageURL$inboundSchema; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkImageURL$outboundSchema; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - export type Outbound = ImageURLChunkImageURL$Outbound; -} - -export function imageURLChunkImageURLToJSON( - imageURLChunkImageURL: ImageURLChunkImageURL, -): string { - return JSON.stringify( - ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL), - ); -} - -export function imageURLChunkImageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunkImageURL' from JSON`, - ); -} - -/** @internal */ -export const ImageURLChunkType$inboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = z.nativeEnum(ImageURLChunkType); - -/** @internal */ -export const ImageURLChunkType$outboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = ImageURLChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkType$inboundSchema; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkType$outboundSchema; -} - -/** @internal */ -export const ImageURLChunk$inboundSchema: z.ZodType< - ImageURLChunk, - z.ZodTypeDef, - unknown -> = z.object({ - image_url: z.union([ImageURL$inboundSchema, z.string()]), - type: ImageURLChunkType$inboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - "image_url": "imageUrl", - }); -}); - -/** @internal */ -export type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -export const ImageURLChunk$outboundSchema: z.ZodType< - ImageURLChunk$Outbound, - z.ZodTypeDef, - ImageURLChunk -> = z.object({ - imageUrl: z.union([ImageURL$outboundSchema, z.string()]), - type: ImageURLChunkType$outboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - imageUrl: "image_url", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunk$inboundSchema; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunk$outboundSchema; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - export type Outbound = ImageURLChunk$Outbound; -} - -export function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string { - return JSON.stringify(ImageURLChunk$outboundSchema.parse(imageURLChunk)); -} - -export function imageURLChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/index.ts deleted file mode 100644 index 10a280b6c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/index.ts +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./assistantmessage.js"; -export * from "./chatcompletionchoice.js"; -export * from "./chatcompletionrequest.js"; -export * from "./chatcompletionresponse.js"; -export * from "./chatcompletionstreamrequest.js"; -export * from "./completionchunk.js"; -export * from "./completionevent.js"; -export * from "./completionresponsestreamchoice.js"; -export * from "./contentchunk.js"; -export * from "./deltamessage.js"; -export * from "./documenturlchunk.js"; -export * from "./filechunk.js"; -export * from "./function.js"; -export * from "./functioncall.js"; -export * from "./functionname.js"; -export * from "./imageurl.js"; -export * from "./imageurlchunk.js"; -export * from "./jsonschema.js"; -export * from "./mistralpromptmode.js"; -export * from "./ocrimageobject.js"; -export * from "./ocrpagedimensions.js"; -export * from "./ocrpageobject.js"; -export * from "./ocrrequest.js"; -export * from "./ocrresponse.js"; -export * from "./ocrusageinfo.js"; -export * from "./prediction.js"; -export * from "./referencechunk.js"; -export * from "./responseformat.js"; -export * from "./responseformats.js"; -export * from "./security.js"; -export * from "./systemmessage.js"; -export * from "./textchunk.js"; -export * from "./tool.js"; -export * from "./toolcall.js"; -export * from "./toolchoice.js"; -export * from "./toolchoiceenum.js"; -export * from "./toolmessage.js"; -export * from "./tooltypes.js"; -export * from "./usageinfo.js"; -export * from "./usermessage.js"; -export * from "./validationerror.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/jsonschema.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/jsonschema.ts deleted file mode 100644 index 12af67b2c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/jsonschema.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$inboundSchema: z.ZodType< - JsonSchema, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "schema": "schemaDefinition", - }); -}); - -/** @internal */ -export type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$outboundSchema: z.ZodType< - JsonSchema$Outbound, - z.ZodTypeDef, - JsonSchema -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - schemaDefinition: "schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - export const inboundSchema = JsonSchema$inboundSchema; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - export const outboundSchema = JsonSchema$outboundSchema; - /** @deprecated use `JsonSchema$Outbound` instead. */ - export type Outbound = JsonSchema$Outbound; -} - -export function jsonSchemaToJSON(jsonSchema: JsonSchema): string { - return JSON.stringify(JsonSchema$outboundSchema.parse(jsonSchema)); -} - -export function jsonSchemaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JsonSchema$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JsonSchema' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/mistralpromptmode.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/mistralpromptmode.ts deleted file mode 100644 index b17c1e2eb..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/mistralpromptmode.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const MistralPromptMode = { - Reasoning: "reasoning", -} as const; -export type MistralPromptMode = OpenEnum; - -/** @internal */ -export const MistralPromptMode$inboundSchema: z.ZodType< - MistralPromptMode, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(MistralPromptMode), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const MistralPromptMode$outboundSchema: z.ZodType< - MistralPromptMode, - z.ZodTypeDef, - MistralPromptMode -> = z.union([ - z.nativeEnum(MistralPromptMode), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MistralPromptMode$ { - /** @deprecated use `MistralPromptMode$inboundSchema` instead. */ - export const inboundSchema = MistralPromptMode$inboundSchema; - /** @deprecated use `MistralPromptMode$outboundSchema` instead. */ - export const outboundSchema = MistralPromptMode$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrimageobject.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrimageobject.ts deleted file mode 100644 index d01ac119d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrimageobject.ts +++ /dev/null @@ -1,126 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRImageObject = { - /** - * Image ID for extracted image in a page - */ - id: string; - /** - * X coordinate of top-left corner of the extracted image - */ - topLeftX: number | null; - /** - * Y coordinate of top-left corner of the extracted image - */ - topLeftY: number | null; - /** - * X coordinate of bottom-right corner of the extracted image - */ - bottomRightX: number | null; - /** - * Y coordinate of bottom-right corner of the extracted image - */ - bottomRightY: number | null; - /** - * Base64 string of the extracted image - */ - imageBase64?: string | null | undefined; - /** - * Annotation of the extracted image in json str - */ - imageAnnotation?: string | null | undefined; -}; - -/** @internal */ -export const OCRImageObject$inboundSchema: z.ZodType< - OCRImageObject, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - top_left_x: z.nullable(z.number().int()), - top_left_y: z.nullable(z.number().int()), - bottom_right_x: z.nullable(z.number().int()), - bottom_right_y: z.nullable(z.number().int()), - image_base64: z.nullable(z.string()).optional(), - image_annotation: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "top_left_x": "topLeftX", - "top_left_y": "topLeftY", - "bottom_right_x": "bottomRightX", - "bottom_right_y": "bottomRightY", - "image_base64": "imageBase64", - "image_annotation": "imageAnnotation", - }); -}); - -/** @internal */ -export type OCRImageObject$Outbound = { - id: string; - top_left_x: number | null; - top_left_y: number | null; - bottom_right_x: number | null; - bottom_right_y: number | null; - image_base64?: string | null | undefined; - image_annotation?: string | null | undefined; -}; - -/** @internal */ -export const OCRImageObject$outboundSchema: z.ZodType< - OCRImageObject$Outbound, - z.ZodTypeDef, - OCRImageObject -> = z.object({ - id: z.string(), - topLeftX: z.nullable(z.number().int()), - topLeftY: z.nullable(z.number().int()), - bottomRightX: z.nullable(z.number().int()), - bottomRightY: z.nullable(z.number().int()), - imageBase64: z.nullable(z.string()).optional(), - imageAnnotation: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - topLeftX: "top_left_x", - topLeftY: "top_left_y", - bottomRightX: "bottom_right_x", - bottomRightY: "bottom_right_y", - imageBase64: "image_base64", - imageAnnotation: "image_annotation", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRImageObject$ { - /** @deprecated use `OCRImageObject$inboundSchema` instead. */ - export const inboundSchema = OCRImageObject$inboundSchema; - /** @deprecated use `OCRImageObject$outboundSchema` instead. */ - export const outboundSchema = OCRImageObject$outboundSchema; - /** @deprecated use `OCRImageObject$Outbound` instead. */ - export type Outbound = OCRImageObject$Outbound; -} - -export function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string { - return JSON.stringify(OCRImageObject$outboundSchema.parse(ocrImageObject)); -} - -export function ocrImageObjectFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRImageObject$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRImageObject' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpagedimensions.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpagedimensions.ts deleted file mode 100644 index 67079fd19..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpagedimensions.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRPageDimensions = { - /** - * Dots per inch of the page-image - */ - dpi: number; - /** - * Height of the image in pixels - */ - height: number; - /** - * Width of the image in pixels - */ - width: number; -}; - -/** @internal */ -export const OCRPageDimensions$inboundSchema: z.ZodType< - OCRPageDimensions, - z.ZodTypeDef, - unknown -> = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int(), -}); - -/** @internal */ -export type OCRPageDimensions$Outbound = { - dpi: number; - height: number; - width: number; -}; - -/** @internal */ -export const OCRPageDimensions$outboundSchema: z.ZodType< - OCRPageDimensions$Outbound, - z.ZodTypeDef, - OCRPageDimensions -> = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRPageDimensions$ { - /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */ - export const inboundSchema = OCRPageDimensions$inboundSchema; - /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */ - export const outboundSchema = OCRPageDimensions$outboundSchema; - /** @deprecated use `OCRPageDimensions$Outbound` instead. */ - export type Outbound = OCRPageDimensions$Outbound; -} - -export function ocrPageDimensionsToJSON( - ocrPageDimensions: OCRPageDimensions, -): string { - return JSON.stringify( - OCRPageDimensions$outboundSchema.parse(ocrPageDimensions), - ); -} - -export function ocrPageDimensionsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRPageDimensions$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRPageDimensions' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpageobject.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpageobject.ts deleted file mode 100644 index 9b5a3086a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrpageobject.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - OCRImageObject, - OCRImageObject$inboundSchema, - OCRImageObject$Outbound, - OCRImageObject$outboundSchema, -} from "./ocrimageobject.js"; -import { - OCRPageDimensions, - OCRPageDimensions$inboundSchema, - OCRPageDimensions$Outbound, - OCRPageDimensions$outboundSchema, -} from "./ocrpagedimensions.js"; - -export type OCRPageObject = { - /** - * The page index in a pdf document starting from 0 - */ - index: number; - /** - * The markdown string response of the page - */ - markdown: string; - /** - * List of all extracted images in the page - */ - images: Array; - /** - * The dimensions of the PDF Page's screenshot image - */ - dimensions: OCRPageDimensions | null; -}; - -/** @internal */ -export const OCRPageObject$inboundSchema: z.ZodType< - OCRPageObject, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(OCRImageObject$inboundSchema), - dimensions: z.nullable(OCRPageDimensions$inboundSchema), -}); - -/** @internal */ -export type OCRPageObject$Outbound = { - index: number; - markdown: string; - images: Array; - dimensions: OCRPageDimensions$Outbound | null; -}; - -/** @internal */ -export const OCRPageObject$outboundSchema: z.ZodType< - OCRPageObject$Outbound, - z.ZodTypeDef, - OCRPageObject -> = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(OCRImageObject$outboundSchema), - dimensions: z.nullable(OCRPageDimensions$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRPageObject$ { - /** @deprecated use `OCRPageObject$inboundSchema` instead. */ - export const inboundSchema = OCRPageObject$inboundSchema; - /** @deprecated use `OCRPageObject$outboundSchema` instead. */ - export const outboundSchema = OCRPageObject$outboundSchema; - /** @deprecated use `OCRPageObject$Outbound` instead. */ - export type Outbound = OCRPageObject$Outbound; -} - -export function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string { - return JSON.stringify(OCRPageObject$outboundSchema.parse(ocrPageObject)); -} - -export function ocrPageObjectFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRPageObject$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRPageObject' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrrequest.ts deleted file mode 100644 index 9c5087e75..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrrequest.ts +++ /dev/null @@ -1,229 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, -} from "./filechunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; - -/** - * Document to run OCR on - */ -export type Document = FileChunk | ImageURLChunk | DocumentURLChunk; - -export type OCRRequest = { - model: string | null; - id?: string | undefined; - /** - * Document to run OCR on - */ - document: FileChunk | ImageURLChunk | DocumentURLChunk; - /** - * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - */ - pages?: Array | null | undefined; - /** - * Include image URLs in response - */ - includeImageBase64?: boolean | null | undefined; - /** - * Max images to extract - */ - imageLimit?: number | null | undefined; - /** - * Minimum height and width of image to extract - */ - imageMinSize?: number | null | undefined; - /** - * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - */ - bboxAnnotationFormat?: ResponseFormat | null | undefined; - /** - * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - */ - documentAnnotationFormat?: ResponseFormat | null | undefined; -}; - -/** @internal */ -export const Document$inboundSchema: z.ZodType< - Document, - z.ZodTypeDef, - unknown -> = z.union([ - FileChunk$inboundSchema, - ImageURLChunk$inboundSchema, - DocumentURLChunk$inboundSchema, -]); - -/** @internal */ -export type Document$Outbound = - | FileChunk$Outbound - | ImageURLChunk$Outbound - | DocumentURLChunk$Outbound; - -/** @internal */ -export const Document$outboundSchema: z.ZodType< - Document$Outbound, - z.ZodTypeDef, - Document -> = z.union([ - FileChunk$outboundSchema, - ImageURLChunk$outboundSchema, - DocumentURLChunk$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - export const inboundSchema = Document$inboundSchema; - /** @deprecated use `Document$outboundSchema` instead. */ - export const outboundSchema = Document$outboundSchema; - /** @deprecated use `Document$Outbound` instead. */ - export type Outbound = Document$Outbound; -} - -export function documentToJSON(document: Document): string { - return JSON.stringify(Document$outboundSchema.parse(document)); -} - -export function documentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Document$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Document' from JSON`, - ); -} - -/** @internal */ -export const OCRRequest$inboundSchema: z.ZodType< - OCRRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - FileChunk$inboundSchema, - ImageURLChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - include_image_base64: z.nullable(z.boolean()).optional(), - image_limit: z.nullable(z.number().int()).optional(), - image_min_size: z.nullable(z.number().int()).optional(), - bbox_annotation_format: z.nullable(ResponseFormat$inboundSchema).optional(), - document_annotation_format: z.nullable(ResponseFormat$inboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - "include_image_base64": "includeImageBase64", - "image_limit": "imageLimit", - "image_min_size": "imageMinSize", - "bbox_annotation_format": "bboxAnnotationFormat", - "document_annotation_format": "documentAnnotationFormat", - }); -}); - -/** @internal */ -export type OCRRequest$Outbound = { - model: string | null; - id?: string | undefined; - document: - | FileChunk$Outbound - | ImageURLChunk$Outbound - | DocumentURLChunk$Outbound; - pages?: Array | null | undefined; - include_image_base64?: boolean | null | undefined; - image_limit?: number | null | undefined; - image_min_size?: number | null | undefined; - bbox_annotation_format?: ResponseFormat$Outbound | null | undefined; - document_annotation_format?: ResponseFormat$Outbound | null | undefined; -}; - -/** @internal */ -export const OCRRequest$outboundSchema: z.ZodType< - OCRRequest$Outbound, - z.ZodTypeDef, - OCRRequest -> = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - FileChunk$outboundSchema, - ImageURLChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - includeImageBase64: z.nullable(z.boolean()).optional(), - imageLimit: z.nullable(z.number().int()).optional(), - imageMinSize: z.nullable(z.number().int()).optional(), - bboxAnnotationFormat: z.nullable(ResponseFormat$outboundSchema).optional(), - documentAnnotationFormat: z.nullable(ResponseFormat$outboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - includeImageBase64: "include_image_base64", - imageLimit: "image_limit", - imageMinSize: "image_min_size", - bboxAnnotationFormat: "bbox_annotation_format", - documentAnnotationFormat: "document_annotation_format", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRRequest$ { - /** @deprecated use `OCRRequest$inboundSchema` instead. */ - export const inboundSchema = OCRRequest$inboundSchema; - /** @deprecated use `OCRRequest$outboundSchema` instead. */ - export const outboundSchema = OCRRequest$outboundSchema; - /** @deprecated use `OCRRequest$Outbound` instead. */ - export type Outbound = OCRRequest$Outbound; -} - -export function ocrRequestToJSON(ocrRequest: OCRRequest): string { - return JSON.stringify(OCRRequest$outboundSchema.parse(ocrRequest)); -} - -export function ocrRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrresponse.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrresponse.ts deleted file mode 100644 index 29408ab34..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrresponse.ts +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - OCRPageObject, - OCRPageObject$inboundSchema, - OCRPageObject$Outbound, - OCRPageObject$outboundSchema, -} from "./ocrpageobject.js"; -import { - OCRUsageInfo, - OCRUsageInfo$inboundSchema, - OCRUsageInfo$Outbound, - OCRUsageInfo$outboundSchema, -} from "./ocrusageinfo.js"; - -export type OCRResponse = { - /** - * List of OCR info for pages. - */ - pages: Array; - /** - * The model used to generate the OCR. - */ - model: string; - /** - * Formatted response in the request_format if provided in json str - */ - documentAnnotation?: string | null | undefined; - usageInfo: OCRUsageInfo; -}; - -/** @internal */ -export const OCRResponse$inboundSchema: z.ZodType< - OCRResponse, - z.ZodTypeDef, - unknown -> = z.object({ - pages: z.array(OCRPageObject$inboundSchema), - model: z.string(), - document_annotation: z.nullable(z.string()).optional(), - usage_info: OCRUsageInfo$inboundSchema, -}).transform((v) => { - return remap$(v, { - "document_annotation": "documentAnnotation", - "usage_info": "usageInfo", - }); -}); - -/** @internal */ -export type OCRResponse$Outbound = { - pages: Array; - model: string; - document_annotation?: string | null | undefined; - usage_info: OCRUsageInfo$Outbound; -}; - -/** @internal */ -export const OCRResponse$outboundSchema: z.ZodType< - OCRResponse$Outbound, - z.ZodTypeDef, - OCRResponse -> = z.object({ - pages: z.array(OCRPageObject$outboundSchema), - model: z.string(), - documentAnnotation: z.nullable(z.string()).optional(), - usageInfo: OCRUsageInfo$outboundSchema, -}).transform((v) => { - return remap$(v, { - documentAnnotation: "document_annotation", - usageInfo: "usage_info", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRResponse$ { - /** @deprecated use `OCRResponse$inboundSchema` instead. */ - export const inboundSchema = OCRResponse$inboundSchema; - /** @deprecated use `OCRResponse$outboundSchema` instead. */ - export const outboundSchema = OCRResponse$outboundSchema; - /** @deprecated use `OCRResponse$Outbound` instead. */ - export type Outbound = OCRResponse$Outbound; -} - -export function ocrResponseToJSON(ocrResponse: OCRResponse): string { - return JSON.stringify(OCRResponse$outboundSchema.parse(ocrResponse)); -} - -export function ocrResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrusageinfo.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrusageinfo.ts deleted file mode 100644 index a07680c41..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/ocrusageinfo.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRUsageInfo = { - /** - * Number of pages processed - */ - pagesProcessed: number; - /** - * Document size in bytes - */ - docSizeBytes?: number | null | undefined; -}; - -/** @internal */ -export const OCRUsageInfo$inboundSchema: z.ZodType< - OCRUsageInfo, - z.ZodTypeDef, - unknown -> = z.object({ - pages_processed: z.number().int(), - doc_size_bytes: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "pages_processed": "pagesProcessed", - "doc_size_bytes": "docSizeBytes", - }); -}); - -/** @internal */ -export type OCRUsageInfo$Outbound = { - pages_processed: number; - doc_size_bytes?: number | null | undefined; -}; - -/** @internal */ -export const OCRUsageInfo$outboundSchema: z.ZodType< - OCRUsageInfo$Outbound, - z.ZodTypeDef, - OCRUsageInfo -> = z.object({ - pagesProcessed: z.number().int(), - docSizeBytes: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - pagesProcessed: "pages_processed", - docSizeBytes: "doc_size_bytes", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRUsageInfo$ { - /** @deprecated use `OCRUsageInfo$inboundSchema` instead. */ - export const inboundSchema = OCRUsageInfo$inboundSchema; - /** @deprecated use `OCRUsageInfo$outboundSchema` instead. */ - export const outboundSchema = OCRUsageInfo$outboundSchema; - /** @deprecated use `OCRUsageInfo$Outbound` instead. */ - export type Outbound = OCRUsageInfo$Outbound; -} - -export function ocrUsageInfoToJSON(ocrUsageInfo: OCRUsageInfo): string { - return JSON.stringify(OCRUsageInfo$outboundSchema.parse(ocrUsageInfo)); -} - -export function ocrUsageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRUsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRUsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/prediction.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/prediction.ts deleted file mode 100644 index d195ee8a5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/prediction.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -/** @internal */ -export const Prediction$inboundSchema: z.ZodType< - Prediction, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("content").default("content"), - content: z.string().default(""), -}); - -/** @internal */ -export type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -export const Prediction$outboundSchema: z.ZodType< - Prediction$Outbound, - z.ZodTypeDef, - Prediction -> = z.object({ - type: z.literal("content").default("content" as const), - content: z.string().default(""), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - export const inboundSchema = Prediction$inboundSchema; - /** @deprecated use `Prediction$outboundSchema` instead. */ - export const outboundSchema = Prediction$outboundSchema; - /** @deprecated use `Prediction$Outbound` instead. */ - export type Outbound = Prediction$Outbound; -} - -export function predictionToJSON(prediction: Prediction): string { - return JSON.stringify(Prediction$outboundSchema.parse(prediction)); -} - -export function predictionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Prediction$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Prediction' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/referencechunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/referencechunk.ts deleted file mode 100644 index 9085d7b9f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/referencechunk.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ReferenceChunkType = { - Reference: "reference", -} as const; -export type ReferenceChunkType = ClosedEnum; - -export type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -/** @internal */ -export const ReferenceChunkType$inboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = z.nativeEnum(ReferenceChunkType); - -/** @internal */ -export const ReferenceChunkType$outboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = ReferenceChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunkType$inboundSchema; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunkType$outboundSchema; -} - -/** @internal */ -export const ReferenceChunk$inboundSchema: z.ZodType< - ReferenceChunk, - z.ZodTypeDef, - unknown -> = z.object({ - reference_ids: z.array(z.number().int()), - type: ReferenceChunkType$inboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - "reference_ids": "referenceIds", - }); -}); - -/** @internal */ -export type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -export const ReferenceChunk$outboundSchema: z.ZodType< - ReferenceChunk$Outbound, - z.ZodTypeDef, - ReferenceChunk -> = z.object({ - referenceIds: z.array(z.number().int()), - type: ReferenceChunkType$outboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - referenceIds: "reference_ids", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunk$inboundSchema; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunk$outboundSchema; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - export type Outbound = ReferenceChunk$Outbound; -} - -export function referenceChunkToJSON(referenceChunk: ReferenceChunk): string { - return JSON.stringify(ReferenceChunk$outboundSchema.parse(referenceChunk)); -} - -export function referenceChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ReferenceChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ReferenceChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformat.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformat.ts deleted file mode 100644 index 7b6a4bf09..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformat.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, -} from "./jsonschema.js"; -import { - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, -} from "./responseformats.js"; - -export type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$inboundSchema: z.ZodType< - ResponseFormat, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(JsonSchema$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "json_schema": "jsonSchema", - }); -}); - -/** @internal */ -export type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$outboundSchema: z.ZodType< - ResponseFormat$Outbound, - z.ZodTypeDef, - ResponseFormat -> = z.object({ - type: ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(JsonSchema$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - jsonSchema: "json_schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - export const inboundSchema = ResponseFormat$inboundSchema; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - export const outboundSchema = ResponseFormat$outboundSchema; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - export type Outbound = ResponseFormat$Outbound; -} - -export function responseFormatToJSON(responseFormat: ResponseFormat): string { - return JSON.stringify(ResponseFormat$outboundSchema.parse(responseFormat)); -} - -export function responseFormatFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseFormat$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseFormat' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformats.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformats.ts deleted file mode 100644 index d14f152e0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/responseformats.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export const ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema", -} as const; -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export type ResponseFormats = ClosedEnum; - -/** @internal */ -export const ResponseFormats$inboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = z.nativeEnum(ResponseFormats); - -/** @internal */ -export const ResponseFormats$outboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = ResponseFormats$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - export const inboundSchema = ResponseFormats$inboundSchema; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - export const outboundSchema = ResponseFormats$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/security.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/security.ts deleted file mode 100644 index 494b49ac4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/security.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Security = { - apiKey?: string | undefined; -}; - -/** @internal */ -export const Security$inboundSchema: z.ZodType< - Security, - z.ZodTypeDef, - unknown -> = z.object({ - ApiKey: z.string().optional(), -}).transform((v) => { - return remap$(v, { - "ApiKey": "apiKey", - }); -}); - -/** @internal */ -export type Security$Outbound = { - ApiKey?: string | undefined; -}; - -/** @internal */ -export const Security$outboundSchema: z.ZodType< - Security$Outbound, - z.ZodTypeDef, - Security -> = z.object({ - apiKey: z.string().optional(), -}).transform((v) => { - return remap$(v, { - apiKey: "ApiKey", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - export const inboundSchema = Security$inboundSchema; - /** @deprecated use `Security$outboundSchema` instead. */ - export const outboundSchema = Security$outboundSchema; - /** @deprecated use `Security$Outbound` instead. */ - export type Outbound = Security$Outbound; -} - -export function securityToJSON(security: Security): string { - return JSON.stringify(Security$outboundSchema.parse(security)); -} - -export function securityFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Security$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Security' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/systemmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/systemmessage.ts deleted file mode 100644 index a911a0122..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/systemmessage.ts +++ /dev/null @@ -1,148 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; - -export type SystemMessageContent = string | Array; - -export const Role = { - System: "system", -} as const; -export type Role = ClosedEnum; - -export type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** @internal */ -export const SystemMessageContent$inboundSchema: z.ZodType< - SystemMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(TextChunk$inboundSchema)]); - -/** @internal */ -export type SystemMessageContent$Outbound = string | Array; - -/** @internal */ -export const SystemMessageContent$outboundSchema: z.ZodType< - SystemMessageContent$Outbound, - z.ZodTypeDef, - SystemMessageContent -> = z.union([z.string(), z.array(TextChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - export const inboundSchema = SystemMessageContent$inboundSchema; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - export const outboundSchema = SystemMessageContent$outboundSchema; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - export type Outbound = SystemMessageContent$Outbound; -} - -export function systemMessageContentToJSON( - systemMessageContent: SystemMessageContent, -): string { - return JSON.stringify( - SystemMessageContent$outboundSchema.parse(systemMessageContent), - ); -} - -export function systemMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessageContent' from JSON`, - ); -} - -/** @internal */ -export const Role$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Role, -); - -/** @internal */ -export const Role$outboundSchema: z.ZodNativeEnum = - Role$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - export const inboundSchema = Role$inboundSchema; - /** @deprecated use `Role$outboundSchema` instead. */ - export const outboundSchema = Role$outboundSchema; -} - -/** @internal */ -export const SystemMessage$inboundSchema: z.ZodType< - SystemMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.union([z.string(), z.array(TextChunk$inboundSchema)]), - role: Role$inboundSchema.default("system"), -}); - -/** @internal */ -export type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -export const SystemMessage$outboundSchema: z.ZodType< - SystemMessage$Outbound, - z.ZodTypeDef, - SystemMessage -> = z.object({ - content: z.union([z.string(), z.array(TextChunk$outboundSchema)]), - role: Role$outboundSchema.default("system"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - export const inboundSchema = SystemMessage$inboundSchema; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - export const outboundSchema = SystemMessage$outboundSchema; - /** @deprecated use `SystemMessage$Outbound` instead. */ - export type Outbound = SystemMessage$Outbound; -} - -export function systemMessageToJSON(systemMessage: SystemMessage): string { - return JSON.stringify(SystemMessage$outboundSchema.parse(systemMessage)); -} - -export function systemMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/textchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/textchunk.ts deleted file mode 100644 index aa0afb615..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/textchunk.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const Type = { - Text: "text", -} as const; -export type Type = ClosedEnum; - -export type TextChunk = { - text: string; - type?: Type | undefined; -}; - -/** @internal */ -export const Type$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Type, -); - -/** @internal */ -export const Type$outboundSchema: z.ZodNativeEnum = - Type$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - export const inboundSchema = Type$inboundSchema; - /** @deprecated use `Type$outboundSchema` instead. */ - export const outboundSchema = Type$outboundSchema; -} - -/** @internal */ -export const TextChunk$inboundSchema: z.ZodType< - TextChunk, - z.ZodTypeDef, - unknown -> = z.object({ - text: z.string(), - type: Type$inboundSchema.default("text"), -}); - -/** @internal */ -export type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -export const TextChunk$outboundSchema: z.ZodType< - TextChunk$Outbound, - z.ZodTypeDef, - TextChunk -> = z.object({ - text: z.string(), - type: Type$outboundSchema.default("text"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - export const inboundSchema = TextChunk$inboundSchema; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - export const outboundSchema = TextChunk$outboundSchema; - /** @deprecated use `TextChunk$Outbound` instead. */ - export type Outbound = TextChunk$Outbound; -} - -export function textChunkToJSON(textChunk: TextChunk): string { - return JSON.stringify(TextChunk$outboundSchema.parse(textChunk)); -} - -export function textChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TextChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TextChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tool.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tool.ts deleted file mode 100644 index 0e1a73c3e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tool.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, -} from "./function.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** @internal */ -export const Tool$inboundSchema: z.ZodType = z - .object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionT$inboundSchema, - }); - -/** @internal */ -export type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -export const Tool$outboundSchema: z.ZodType = - z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionT$outboundSchema, - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - export const inboundSchema = Tool$inboundSchema; - /** @deprecated use `Tool$outboundSchema` instead. */ - export const outboundSchema = Tool$outboundSchema; - /** @deprecated use `Tool$Outbound` instead. */ - export type Outbound = Tool$Outbound; -} - -export function toolToJSON(tool: Tool): string { - return JSON.stringify(Tool$outboundSchema.parse(tool)); -} - -export function toolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Tool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Tool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolcall.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolcall.ts deleted file mode 100644 index 3423370a0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolcall.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionCall, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, -} from "./functioncall.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -/** @internal */ -export const ToolCall$inboundSchema: z.ZodType< - ToolCall, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$inboundSchema.optional(), - function: FunctionCall$inboundSchema, - index: z.number().int().default(0), -}); - -/** @internal */ -export type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -export const ToolCall$outboundSchema: z.ZodType< - ToolCall$Outbound, - z.ZodTypeDef, - ToolCall -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$outboundSchema.optional(), - function: FunctionCall$outboundSchema, - index: z.number().int().default(0), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - export const inboundSchema = ToolCall$inboundSchema; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - export const outboundSchema = ToolCall$outboundSchema; - /** @deprecated use `ToolCall$Outbound` instead. */ - export type Outbound = ToolCall$Outbound; -} - -export function toolCallToJSON(toolCall: ToolCall): string { - return JSON.stringify(ToolCall$outboundSchema.parse(toolCall)); -} - -export function toolCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoice.ts deleted file mode 100644 index 68138162e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoice.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, -} from "./functionname.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -export type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** @internal */ -export const ToolChoice$inboundSchema: z.ZodType< - ToolChoice, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionName$inboundSchema, -}); - -/** @internal */ -export type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -export const ToolChoice$outboundSchema: z.ZodType< - ToolChoice$Outbound, - z.ZodTypeDef, - ToolChoice -> = z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionName$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - export const inboundSchema = ToolChoice$inboundSchema; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - export const outboundSchema = ToolChoice$outboundSchema; - /** @deprecated use `ToolChoice$Outbound` instead. */ - export type Outbound = ToolChoice$Outbound; -} - -export function toolChoiceToJSON(toolChoice: ToolChoice): string { - return JSON.stringify(ToolChoice$outboundSchema.parse(toolChoice)); -} - -export function toolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoiceenum.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoiceenum.ts deleted file mode 100644 index 401f927f5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolchoiceenum.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required", -} as const; -export type ToolChoiceEnum = ClosedEnum; - -/** @internal */ -export const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = z.nativeEnum(ToolChoiceEnum); - -/** @internal */ -export const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = ToolChoiceEnum$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - export const inboundSchema = ToolChoiceEnum$inboundSchema; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - export const outboundSchema = ToolChoiceEnum$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolmessage.ts deleted file mode 100644 index a343e401a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/toolmessage.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type ToolMessageContent = string | Array; - -export const ToolMessageRole = { - Tool: "tool", -} as const; -export type ToolMessageRole = ClosedEnum; - -export type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** @internal */ -export const ToolMessageContent$inboundSchema: z.ZodType< - ToolMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -export const ToolMessageContent$outboundSchema: z.ZodType< - ToolMessageContent$Outbound, - z.ZodTypeDef, - ToolMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - export const inboundSchema = ToolMessageContent$inboundSchema; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - export const outboundSchema = ToolMessageContent$outboundSchema; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - export type Outbound = ToolMessageContent$Outbound; -} - -export function toolMessageContentToJSON( - toolMessageContent: ToolMessageContent, -): string { - return JSON.stringify( - ToolMessageContent$outboundSchema.parse(toolMessageContent), - ); -} - -export function toolMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessageContent' from JSON`, - ); -} - -/** @internal */ -export const ToolMessageRole$inboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = z.nativeEnum(ToolMessageRole); - -/** @internal */ -export const ToolMessageRole$outboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = ToolMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - export const inboundSchema = ToolMessageRole$inboundSchema; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - export const outboundSchema = ToolMessageRole$outboundSchema; -} - -/** @internal */ -export const ToolMessage$inboundSchema: z.ZodType< - ToolMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$inboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -export const ToolMessage$outboundSchema: z.ZodType< - ToolMessage$Outbound, - z.ZodTypeDef, - ToolMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$outboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - export const inboundSchema = ToolMessage$inboundSchema; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - export const outboundSchema = ToolMessage$outboundSchema; - /** @deprecated use `ToolMessage$Outbound` instead. */ - export type Outbound = ToolMessage$Outbound; -} - -export function toolMessageToJSON(toolMessage: ToolMessage): string { - return JSON.stringify(ToolMessage$outboundSchema.parse(toolMessage)); -} - -export function toolMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tooltypes.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tooltypes.ts deleted file mode 100644 index a414745f8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/tooltypes.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const ToolTypes = { - Function: "function", -} as const; -export type ToolTypes = OpenEnum; - -/** @internal */ -export const ToolTypes$inboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ToolTypes), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ToolTypes$outboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - ToolTypes -> = z.union([ - z.nativeEnum(ToolTypes), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - export const inboundSchema = ToolTypes$inboundSchema; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - export const outboundSchema = ToolTypes$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usageinfo.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usageinfo.ts deleted file mode 100644 index 021789d11..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usageinfo.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type UsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - promptAudioSeconds?: number | null | undefined; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const UsageInfo$inboundSchema: z.ZodType< - UsageInfo, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - prompt_audio_seconds: z.nullable(z.number().int()).optional(), - }).catchall(z.any()), - "additionalProperties", - true, -).transform((v) => { - return remap$(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "prompt_audio_seconds": "promptAudioSeconds", - }); -}); - -/** @internal */ -export type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - prompt_audio_seconds?: number | null | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const UsageInfo$outboundSchema: z.ZodType< - UsageInfo$Outbound, - z.ZodTypeDef, - UsageInfo -> = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - promptAudioSeconds: z.nullable(z.number().int()).optional(), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - promptAudioSeconds: "prompt_audio_seconds", - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - export const inboundSchema = UsageInfo$inboundSchema; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - export const outboundSchema = UsageInfo$outboundSchema; - /** @deprecated use `UsageInfo$Outbound` instead. */ - export type Outbound = UsageInfo$Outbound; -} - -export function usageInfoToJSON(usageInfo: UsageInfo): string { - return JSON.stringify(UsageInfo$outboundSchema.parse(usageInfo)); -} - -export function usageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usermessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usermessage.ts deleted file mode 100644 index e74a20d70..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/usermessage.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type UserMessageContent = string | Array; - -export const UserMessageRole = { - User: "user", -} as const; -export type UserMessageRole = ClosedEnum; - -export type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** @internal */ -export const UserMessageContent$inboundSchema: z.ZodType< - UserMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type UserMessageContent$Outbound = string | Array; - -/** @internal */ -export const UserMessageContent$outboundSchema: z.ZodType< - UserMessageContent$Outbound, - z.ZodTypeDef, - UserMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - export const inboundSchema = UserMessageContent$inboundSchema; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - export const outboundSchema = UserMessageContent$outboundSchema; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - export type Outbound = UserMessageContent$Outbound; -} - -export function userMessageContentToJSON( - userMessageContent: UserMessageContent, -): string { - return JSON.stringify( - UserMessageContent$outboundSchema.parse(userMessageContent), - ); -} - -export function userMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessageContent' from JSON`, - ); -} - -/** @internal */ -export const UserMessageRole$inboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = z.nativeEnum(UserMessageRole); - -/** @internal */ -export const UserMessageRole$outboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = UserMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - export const inboundSchema = UserMessageRole$inboundSchema; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - export const outboundSchema = UserMessageRole$outboundSchema; -} - -/** @internal */ -export const UserMessage$inboundSchema: z.ZodType< - UserMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - role: UserMessageRole$inboundSchema.default("user"), -}); - -/** @internal */ -export type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -export const UserMessage$outboundSchema: z.ZodType< - UserMessage$Outbound, - z.ZodTypeDef, - UserMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - role: UserMessageRole$outboundSchema.default("user"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - export const inboundSchema = UserMessage$inboundSchema; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - export const outboundSchema = UserMessage$outboundSchema; - /** @deprecated use `UserMessage$Outbound` instead. */ - export type Outbound = UserMessage$Outbound; -} - -export function userMessageToJSON(userMessage: UserMessage): string { - return JSON.stringify(UserMessage$outboundSchema.parse(userMessage)); -} - -export function userMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/validationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/validationerror.ts deleted file mode 100644 index 9072a892d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/components/validationerror.ts +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Loc = string | number; - -export type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const Loc$inboundSchema: z.ZodType = z.union( - [z.string(), z.number().int()], -); - -/** @internal */ -export type Loc$Outbound = string | number; - -/** @internal */ -export const Loc$outboundSchema: z.ZodType = z - .union([z.string(), z.number().int()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - export const inboundSchema = Loc$inboundSchema; - /** @deprecated use `Loc$outboundSchema` instead. */ - export const outboundSchema = Loc$outboundSchema; - /** @deprecated use `Loc$Outbound` instead. */ - export type Outbound = Loc$Outbound; -} - -export function locToJSON(loc: Loc): string { - return JSON.stringify(Loc$outboundSchema.parse(loc)); -} - -export function locFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Loc$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Loc' from JSON`, - ); -} - -/** @internal */ -export const ValidationError$inboundSchema: z.ZodType< - ValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** @internal */ -export type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const ValidationError$outboundSchema: z.ZodType< - ValidationError$Outbound, - z.ZodTypeDef, - ValidationError -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - export const inboundSchema = ValidationError$inboundSchema; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - export const outboundSchema = ValidationError$outboundSchema; - /** @deprecated use `ValidationError$Outbound` instead. */ - export type Outbound = ValidationError$Outbound; -} - -export function validationErrorToJSON( - validationError: ValidationError, -): string { - return JSON.stringify(ValidationError$outboundSchema.parse(validationError)); -} - -export function validationErrorFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ValidationError$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ValidationError' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpclienterrors.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpclienterrors.ts deleted file mode 100644 index b34f61212..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpclienterrors.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Base class for all HTTP errors. - */ -export class HTTPClientError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - override name = "HTTPClientError"; - constructor(message: string, opts?: { cause?: unknown }) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - - super(msg, opts); - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } -} - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -export class UnexpectedClientError extends HTTPClientError { - override name = "UnexpectedClientError"; -} - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -export class InvalidRequestError extends HTTPClientError { - override name = "InvalidRequestError"; -} - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -export class RequestAbortedError extends HTTPClientError { - override readonly name = "RequestAbortedError"; -} - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -export class RequestTimeoutError extends HTTPClientError { - override readonly name = "RequestTimeoutError"; -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -export class ConnectionError extends HTTPClientError { - override readonly name = "ConnectionError"; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpvalidationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpvalidationerror.ts deleted file mode 100644 index d9a58dc8f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/httpvalidationerror.ts +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import * as components from "../components/index.js"; - -export type HTTPValidationErrorData = { - detail?: Array | undefined; -}; - -export class HTTPValidationError extends Error { - detail?: Array | undefined; - - /** The original data that was passed to this error instance. */ - data$: HTTPValidationErrorData; - - constructor(err: HTTPValidationErrorData) { - const message = "message" in err && typeof err.message === "string" - ? err.message - : `API error occurred: ${JSON.stringify(err)}`; - super(message); - this.data$ = err; - - if (err.detail != null) this.detail = err.detail; - - this.name = "HTTPValidationError"; - } -} - -/** @internal */ -export const HTTPValidationError$inboundSchema: z.ZodType< - HTTPValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), -}) - .transform((v) => { - return new HTTPValidationError(v); - }); - -/** @internal */ -export type HTTPValidationError$Outbound = { - detail?: Array | undefined; -}; - -/** @internal */ -export const HTTPValidationError$outboundSchema: z.ZodType< - HTTPValidationError$Outbound, - z.ZodTypeDef, - HTTPValidationError -> = z.instanceof(HTTPValidationError) - .transform(v => v.data$) - .pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional(), - })); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace HTTPValidationError$ { - /** @deprecated use `HTTPValidationError$inboundSchema` instead. */ - export const inboundSchema = HTTPValidationError$inboundSchema; - /** @deprecated use `HTTPValidationError$outboundSchema` instead. */ - export const outboundSchema = HTTPValidationError$outboundSchema; - /** @deprecated use `HTTPValidationError$Outbound` instead. */ - export type Outbound = HTTPValidationError$Outbound; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/index.ts deleted file mode 100644 index 8a5df29ef..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/index.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./httpclienterrors.js"; -export * from "./httpvalidationerror.js"; -export * from "./sdkerror.js"; -export * from "./sdkvalidationerror.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkerror.ts deleted file mode 100644 index 001f46592..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkerror.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export class SDKError extends Error { - public readonly statusCode: number; - public readonly contentType: string; - - constructor( - message: string, - public readonly rawResponse: Response, - public readonly body: string = "", - ) { - const statusCode = rawResponse.status; - const contentType = rawResponse.headers.get("content-type") || ""; - const bodyString = body.length > 0 ? `\n${body}` : ""; - - super( - `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`, - ); - - this.statusCode = statusCode; - this.contentType = contentType; - - this.name = "SDKError"; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkvalidationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkvalidationerror.ts deleted file mode 100644 index 16929b9e5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/models/errors/sdkvalidationerror.ts +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - public readonly rawValue: unknown; - - /** - * The raw message that failed validation. - */ - public readonly rawMessage: unknown; - - constructor(message: string, cause: unknown, rawValue: unknown) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - public pretty(): string { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage}\n${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } -} - -export function formatZodError(err: z.ZodError, level = 0): string { - let pre = " ".repeat(level); - pre = level > 0 ? `│${pre}` : pre; - pre += " ".repeat(level); - - let message = ""; - const append = (str: string) => (message += `\n${pre}${str}`); - - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - - if (len) { - append(`┌ ${headline}:`); - } - - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`│ • [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`│ Want: ${issue.expected}`); - append(`│ Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`│ Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`│ Allowed: ${issue.options.join(", ")}`); - append(`│ Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`│ Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len = issue.unionErrors.length; - append( - `│ ✖︎ Attemped to deserialize into one of ${len} union members:`, - ); - issue.unionErrors.forEach((err, i) => { - append(`│ ✖︎ Member ${i + 1} of ${len}`); - append(`${formatZodError(err, level + 1)}`); - }); - } - } - } - - if (err.issues.length) { - append(`└─*`); - } - - return message.slice(1); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/chat.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/chat.ts deleted file mode 100644 index 3ce441044..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/chat.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { chatComplete } from "../funcs/chatComplete.js"; -import { chatStream } from "../funcs/chatStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Chat extends ClientSDK { - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(chatStream( - this, - request, - options, - )); - } - - /** - * Chat Completion - */ - async complete( - request: components.ChatCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(chatComplete( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/index.ts deleted file mode 100644 index ecac22648..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./sdk.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/ocr.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/ocr.ts deleted file mode 100644 index 7a36105d9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/ocr.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ocrProcess } from "../funcs/ocrProcess.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Ocr extends ClientSDK { - /** - * OCR - */ - async process( - request: components.OCRRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(ocrProcess( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/sdk.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/sdk.ts deleted file mode 100644 index 1a877262f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/sdk/sdk.ts +++ /dev/null @@ -1,28 +0,0 @@ -import { SDKOptions } from "../lib/config.js"; -import { ClientSDK } from "../lib/sdks.js"; -import { Chat } from "./chat.js"; - -export type AzureOptions = { - /** Your AzureAI Endpoint for more information see https://docs.mistral.ai/deployment/cloud/azure/ */ - endpoint: string; - /** Your AzureAI API Key for more information see https://docs.mistral.ai/deployment/cloud/azure/ */ - apiKey: string; -}; - -export class MistralAzure extends ClientSDK { - constructor(options: SDKOptions & AzureOptions) { - options.serverURL = options.endpoint; - if (!options.serverURL.endsWith("/")) { - options.serverURL = `${options.serverURL}/`; - } - if (!options.serverURL.endsWith("v1/")) { - options.serverURL = `${options.serverURL}v1/`; - } - super(options); - } - - private _chat?: Chat; - get chat(): Chat { - return (this._chat ??= new Chat(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/async.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/async.ts deleted file mode 100644 index 689dba5de..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/async.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type APICall = - | { - status: "complete"; - request: Request; - response: Response; - } - | { - status: "request-error"; - request: Request; - response?: undefined; - } - | { - status: "invalid"; - request?: undefined; - response?: undefined; - }; - -export class APIPromise implements Promise { - readonly #promise: Promise<[T, APICall]>; - readonly #unwrapped: Promise; - - readonly [Symbol.toStringTag] = "APIPromise"; - - constructor(p: [T, APICall] | Promise<[T, APICall]>) { - this.#promise = p instanceof Promise ? p : Promise.resolve(p); - this.#unwrapped = - p instanceof Promise - ? this.#promise.then(([value]) => value) - : Promise.resolve(p[0]); - } - - then( - onfulfilled?: - | ((value: T) => TResult1 | PromiseLike) - | null - | undefined, - onrejected?: - | ((reason: any) => TResult2 | PromiseLike) - | null - | undefined, - ): Promise { - return this.#promise.then( - onfulfilled ? ([value]) => onfulfilled(value) : void 0, - onrejected, - ); - } - - catch( - onrejected?: - | ((reason: any) => TResult | PromiseLike) - | null - | undefined, - ): Promise { - return this.#unwrapped.catch(onrejected); - } - - finally(onfinally?: (() => void) | null | undefined): Promise { - return this.#unwrapped.finally(onfinally); - } - - $inspect(): Promise<[T, APICall]> { - return this.#promise; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/blobs.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/blobs.ts deleted file mode 100644 index 4ce846023..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/blobs.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export const blobLikeSchema: z.ZodType = - z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true, - }); - -export function isBlobLike(val: unknown): val is Blob { - if (val instanceof Blob) { - return true; - } - - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - - return "stream" in val && typeof val.stream === "function"; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/constdatetime.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/constdatetime.ts deleted file mode 100644 index c0a4409c7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/constdatetime.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function constDateTime( - val: string, -): z.ZodType { - return z.custom((v) => { - return ( - typeof v === "string" && new Date(v).getTime() === new Date(val).getTime() - ); - }, `Value must be equivelant to ${val}`); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/enums.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/enums.ts deleted file mode 100644 index 6fb6d9109..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/enums.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -declare const __brand: unique symbol; -export type Unrecognized = T & { [__brand]: "unrecognized" }; - -export function catchUnrecognizedEnum(value: T): Unrecognized { - return value as Unrecognized; -} - -type Prettify = { [K in keyof T]: T[K] } & {}; -export type ClosedEnum = T[keyof T]; -export type OpenEnum = - | Prettify - | Unrecognized; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/fp.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/fp.ts deleted file mode 100644 index ccbe51eac..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/fp.ts +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -export type Result = - | { ok: true; value: T; error?: never } - | { ok: false; value?: never; error: E }; - -export function OK(value: V): Result { - return { ok: true, value }; -} - -export function ERR(error: E): Result { - return { ok: false, error }; -} - -/** - * unwrap is a convenience function for extracting a value from a result or - * throwing if there was an error. - */ -export function unwrap(r: Result): T { - if (!r.ok) { - throw r.error; - } - return r.value; -} - -/** - * unwrapAsync is a convenience function for resolving a value from a Promise - * of a result or rejecting if an error occurred. - */ -export async function unwrapAsync( - pr: Promise>, -): Promise { - const r = await pr; - if (!r.ok) { - throw r.error; - } - - return r.value; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/index.ts deleted file mode 100644 index e124e817b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export { blobLikeSchema, isBlobLike } from "./blobs.js"; -export { catchUnrecognizedEnum } from "./enums.js"; -export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js"; -export type { Result } from "./fp.js"; -export type { PageIterator, Paginator } from "./operations.js"; -export { createPageIterator } from "./operations.js"; -export { RFCDate } from "./rfcdate.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/operations.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/operations.ts deleted file mode 100644 index beb81e10f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/operations.ts +++ /dev/null @@ -1,105 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { Result } from "./fp.js"; - -export type Paginator = () => Promise }> | null; - -export type PageIterator = V & { - next: Paginator; - [Symbol.asyncIterator]: () => AsyncIterableIterator; - "~next"?: PageState | undefined; -}; - -export function createPageIterator( - page: V & { next: Paginator }, - halt: (v: V) => boolean, -): { - [Symbol.asyncIterator]: () => AsyncIterableIterator; -} { - return { - [Symbol.asyncIterator]: async function* paginator() { - yield page; - if (halt(page)) { - return; - } - - let p: typeof page | null = page; - for (p = await p.next(); p != null; p = await p.next()) { - yield p; - if (halt(p)) { - return; - } - } - }, - }; -} - -/** - * This utility create a special iterator that yields a single value and - * terminates. It is useful in paginated SDK functions that have early return - * paths when things go wrong. - */ -export function haltIterator( - v: V, -): PageIterator { - return { - ...v, - next: () => null, - [Symbol.asyncIterator]: async function* paginator() { - yield v; - }, - }; -} - -/** - * Converts an async iterator of `Result` into an async iterator of `V`. - * When error results occur, the underlying error value is thrown. - */ -export async function unwrapResultIterator( - iteratorPromise: Promise, PageState>>, -): Promise> { - const resultIter = await iteratorPromise; - - if (!resultIter.ok) { - throw resultIter.error; - } - - return { - ...resultIter.value, - next: unwrapPaginator(resultIter.next), - "~next": resultIter["~next"], - [Symbol.asyncIterator]: async function* paginator() { - for await (const page of resultIter) { - if (!page.ok) { - throw page.error; - } - yield page.value; - } - }, - }; -} - -function unwrapPaginator( - paginator: Paginator>, -): Paginator { - return () => { - const nextResult = paginator(); - if (nextResult == null) { - return null; - } - return nextResult.then((res) => { - if (!res.ok) { - throw res.error; - } - const out = { - ...res.value, - next: unwrapPaginator(res.next), - }; - return out; - }); - }; -} - -export const URL_OVERRIDE = Symbol("URL_OVERRIDE"); diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/rfcdate.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/rfcdate.ts deleted file mode 100644 index c79b3f53a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/rfcdate.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const dateRE = /^\d{4}-\d{2}-\d{2}$/; - -export class RFCDate { - private serialized: string; - - /** - * Creates a new RFCDate instance using today's date. - */ - static today(): RFCDate { - return new RFCDate(new Date()); - } - - /** - * Creates a new RFCDate instance using the provided input. - * If a string is used then in must be in the format YYYY-MM-DD. - * - * @param date A Date object or a date string in YYYY-MM-DD format - * @example - * new RFCDate("2022-01-01") - * @example - * new RFCDate(new Date()) - */ - constructor(date: Date | string) { - if (typeof date === "string" && !dateRE.test(date)) { - throw new RangeError( - "RFCDate: date strings must be in the format YYYY-MM-DD: " + date, - ); - } - - const value = new Date(date); - if (isNaN(+value)) { - throw new RangeError("RFCDate: invalid date provided: " + date); - } - - this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length); - if (!dateRE.test(this.serialized)) { - throw new TypeError( - `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`, - ); - } - } - - toJSON(): string { - return this.toString(); - } - - toString(): string { - return this.serialized; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/streams.ts b/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/streams.ts deleted file mode 100644 index a0163e7a9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/src/types/streams.ts +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export function isReadableStream( - val: unknown, -): val is ReadableStream { - if (typeof val !== "object" || val === null) { - return false; - } - - // Check for the presence of methods specific to ReadableStream - const stream = val as ReadableStream; - - // ReadableStream has methods like getReader, cancel, and tee - return ( - typeof stream.getReader === "function" && - typeof stream.cancel === "function" && - typeof stream.tee === "function" - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-azure/tsconfig.json b/examples/sdks/mistral-typescript/packages/mistralai-azure/tsconfig.json deleted file mode 100644 index 94d81a34f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-azure/tsconfig.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "compilerOptions": { - "incremental": true, - "tsBuildInfoFile": ".tsbuildinfo", - "target": "ES2020", - "lib": ["ES2022", "DOM", "DOM.Iterable"], - "jsx": "react-jsx", - - "module": "Node16", - "moduleResolution": "Node16", - - "allowJs": true, - - "declaration": true, - "declarationMap": true, - "sourceMap": true, - "outDir": ".", - - - // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json - "strict": true, - "allowUnusedLabels": false, - "allowUnreachableCode": false, - "exactOptionalPropertyTypes": true, - "useUnknownInCatchVariables": true, - "noFallthroughCasesInSwitch": true, - "noImplicitOverride": true, - "noImplicitReturns": true, - "noPropertyAccessFromIndexSignature": true, - "noUncheckedIndexedAccess": true, - "noUnusedLocals": true, - "noUnusedParameters": true, - "isolatedModules": true, - "checkJs": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true - }, - "include": ["src"], - "exclude": ["node_modules"] -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.genignore b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.genignore deleted file mode 100644 index 2491a3676..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.genignore +++ /dev/null @@ -1,4 +0,0 @@ -src/sdk/sdk.ts -README.md -USAGE.md -docs/sdks/**/README.md \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitattributes b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitattributes deleted file mode 100644 index 113eead50..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitattributes +++ /dev/null @@ -1,2 +0,0 @@ -# This allows generated code to be indexed correctly -*.ts linguist-generated=false \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitignore b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitignore deleted file mode 100644 index dc2842dc9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.gitignore +++ /dev/null @@ -1,22 +0,0 @@ -/mcp-server -/bin -/.eslintcache -/react-query -/.speakeasy/reports -/__tests__ -/core.* -/funcs -/models -/models/errors -/types -/node_modules -/lib -/sdk -/hooks -/index.* -/cjs -/esm -/dist -/.tsbuildinfo -/.tshy -/.tshy-* diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.npmignore b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.npmignore deleted file mode 100644 index cf98a6bf0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.npmignore +++ /dev/null @@ -1,15 +0,0 @@ -**/* -!/FUNCTIONS.md -!/RUNTIMES.md -!/REACT_QUERY.md -!/**/*.ts -!/**/*.js -!/**/*.mjs -!/**/*.json -!/**/*.map - -/eslint.config.mjs -/cjs -/.tshy -/.tshy-* -/__tests__ diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.lock b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.lock deleted file mode 100644 index b610d8cd8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.lock +++ /dev/null @@ -1,222 +0,0 @@ -lockVersion: 2.0.0 -id: c6044247-eaf9-46da-b078-0e1334e93be2 -management: - docChecksum: 28fe1ab59b4dee005217f2dbbd836060 - docVersion: 0.0.2 - speakeasyVersion: 1.517.3 - generationVersion: 2.548.6 - releaseVersion: 1.5.0 - configChecksum: 1c5e28cded8c5d3a7d735e20f6f09b99 - repoURL: https://github.com/mistralai/client-ts.git - repoSubDirectory: packages/mistralai-gcp - installationURL: https://gitpkg.now.sh/mistralai/client-ts/packages/mistralai-gcp - published: true -features: - typescript: - additionalDependencies: 0.1.0 - constsAndDefaults: 0.1.11 - core: 3.21.4 - defaultEnabledRetries: 0.1.0 - enumUnions: 0.1.0 - envVarSecurityUsage: 0.1.2 - examples: 2.81.5 - globalSecurity: 2.82.13 - globalSecurityCallbacks: 0.1.0 - globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.82.4 - nameOverrides: 2.81.2 - nullables: 0.1.1 - openEnums: 0.1.1 - responseFormat: 0.2.3 - retries: 2.83.0 - sdkHooks: 0.2.0 - serverEvents: 0.1.5 - serverEventsSentinels: 0.1.0 - serverIDs: 2.81.2 - unions: 2.85.8 -generatedFiles: - - .gitattributes - - .npmignore - - FUNCTIONS.md - - RUNTIMES.md - - docs/lib/utils/retryconfig.md - - docs/models/components/arguments.md - - docs/models/components/assistantmessage.md - - docs/models/components/assistantmessagecontent.md - - docs/models/components/assistantmessagerole.md - - docs/models/components/chatcompletionchoice.md - - docs/models/components/chatcompletionchoicefinishreason.md - - docs/models/components/chatcompletionrequest.md - - docs/models/components/chatcompletionrequestmessages.md - - docs/models/components/chatcompletionrequeststop.md - - docs/models/components/chatcompletionrequesttoolchoice.md - - docs/models/components/chatcompletionresponse.md - - docs/models/components/chatcompletionstreamrequest.md - - docs/models/components/chatcompletionstreamrequesttoolchoice.md - - docs/models/components/completionchunk.md - - docs/models/components/completionevent.md - - docs/models/components/completionresponsestreamchoice.md - - docs/models/components/content.md - - docs/models/components/contentchunk.md - - docs/models/components/deltamessage.md - - docs/models/components/fimcompletionrequest.md - - docs/models/components/fimcompletionrequeststop.md - - docs/models/components/fimcompletionresponse.md - - docs/models/components/fimcompletionstreamrequest.md - - docs/models/components/fimcompletionstreamrequeststop.md - - docs/models/components/finishreason.md - - docs/models/components/functioncall.md - - docs/models/components/functionname.md - - docs/models/components/functiont.md - - docs/models/components/imageurl.md - - docs/models/components/imageurlchunk.md - - docs/models/components/imageurlchunkimageurl.md - - docs/models/components/imageurlchunktype.md - - docs/models/components/jsonschema.md - - docs/models/components/loc.md - - docs/models/components/messages.md - - docs/models/components/prediction.md - - docs/models/components/referencechunk.md - - docs/models/components/referencechunktype.md - - docs/models/components/responseformat.md - - docs/models/components/responseformats.md - - docs/models/components/role.md - - docs/models/components/security.md - - docs/models/components/stop.md - - docs/models/components/systemmessage.md - - docs/models/components/systemmessagecontent.md - - docs/models/components/textchunk.md - - docs/models/components/tool.md - - docs/models/components/toolcall.md - - docs/models/components/toolchoice.md - - docs/models/components/toolchoiceenum.md - - docs/models/components/toolmessage.md - - docs/models/components/toolmessagecontent.md - - docs/models/components/toolmessagerole.md - - docs/models/components/tooltypes.md - - docs/models/components/type.md - - docs/models/components/usageinfo.md - - docs/models/components/usermessage.md - - docs/models/components/usermessagecontent.md - - docs/models/components/usermessagerole.md - - docs/models/components/validationerror.md - - docs/models/errors/httpvalidationerror.md - - eslint.config.mjs - - jsr.json - - package.json - - src/core.ts - - src/funcs/chatComplete.ts - - src/funcs/chatStream.ts - - src/funcs/fimComplete.ts - - src/funcs/fimStream.ts - - src/hooks/hooks.ts - - src/hooks/index.ts - - src/hooks/types.ts - - src/index.ts - - src/lib/base64.ts - - src/lib/config.ts - - src/lib/dlv.ts - - src/lib/encodings.ts - - src/lib/event-streams.ts - - src/lib/files.ts - - src/lib/http.ts - - src/lib/is-plain-object.ts - - src/lib/logger.ts - - src/lib/matchers.ts - - src/lib/primitives.ts - - src/lib/retries.ts - - src/lib/schemas.ts - - src/lib/sdks.ts - - src/lib/security.ts - - src/lib/url.ts - - src/models/components/assistantmessage.ts - - src/models/components/chatcompletionchoice.ts - - src/models/components/chatcompletionrequest.ts - - src/models/components/chatcompletionresponse.ts - - src/models/components/chatcompletionstreamrequest.ts - - src/models/components/completionchunk.ts - - src/models/components/completionevent.ts - - src/models/components/completionresponsestreamchoice.ts - - src/models/components/contentchunk.ts - - src/models/components/deltamessage.ts - - src/models/components/fimcompletionrequest.ts - - src/models/components/fimcompletionresponse.ts - - src/models/components/fimcompletionstreamrequest.ts - - src/models/components/function.ts - - src/models/components/functioncall.ts - - src/models/components/functionname.ts - - src/models/components/imageurl.ts - - src/models/components/imageurlchunk.ts - - src/models/components/index.ts - - src/models/components/jsonschema.ts - - src/models/components/prediction.ts - - src/models/components/referencechunk.ts - - src/models/components/responseformat.ts - - src/models/components/responseformats.ts - - src/models/components/security.ts - - src/models/components/systemmessage.ts - - src/models/components/textchunk.ts - - src/models/components/tool.ts - - src/models/components/toolcall.ts - - src/models/components/toolchoice.ts - - src/models/components/toolchoiceenum.ts - - src/models/components/toolmessage.ts - - src/models/components/tooltypes.ts - - src/models/components/usageinfo.ts - - src/models/components/usermessage.ts - - src/models/components/validationerror.ts - - src/models/errors/httpclienterrors.ts - - src/models/errors/httpvalidationerror.ts - - src/models/errors/index.ts - - src/models/errors/sdkerror.ts - - src/models/errors/sdkvalidationerror.ts - - src/sdk/chat.ts - - src/sdk/fim.ts - - src/sdk/index.ts - - src/types/async.ts - - src/types/blobs.ts - - src/types/constdatetime.ts - - src/types/enums.ts - - src/types/fp.ts - - src/types/index.ts - - src/types/operations.ts - - src/types/rfcdate.ts - - src/types/streams.ts - - tsconfig.json -examples: - stream_chat: - speakeasy-default-stream-chat: - requestBody: - application/json: {"model": "mistral-small-latest", "stream": true, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "422": - application/json: {} - "200": {} - chat_completion_v1_chat_completions_post: - speakeasy-default-chat-completion-v1-chat-completions-post: - requestBody: - application/json: {"model": "mistral-small-latest", "stream": false, "messages": [{"content": "Who is the best French painter? Answer in one short sentence.", "role": "user"}]} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "mistral-small-latest", "usage": {"prompt_tokens": 16, "completion_tokens": 34, "total_tokens": 50}, "created": 1702256327, "choices": [{"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}]} - "422": - application/json: {} - stream_fim: - speakeasy-default-stream-fim: - requestBody: - application/json: {"model": "codestral-2405", "top_p": 1, "stream": true, "prompt": "def", "suffix": "return a+b"} - responses: - "422": - application/json: {} - "200": {} - fim_completion_v1_fim_completions_post: - speakeasy-default-fim-completion-v1-fim-completions-post: - requestBody: - application/json: {"model": "codestral-2405", "top_p": 1, "stream": false, "prompt": "def", "suffix": "return a+b"} - responses: - "200": - application/json: {"id": "cmpl-e5cc70bb28c444948073e77776eb30ef", "object": "chat.completion", "model": "codestral-latest", "usage": {"prompt_tokens": 16, "completion_tokens": 34, "total_tokens": 50}, "created": 1702256327, "choices": [{"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}, {"index": 0, "message": {"prefix": false, "role": "assistant"}, "finish_reason": "stop"}]} - "422": - application/json: {} -examplesVersion: 1.0.0 -generatedTests: {} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.yaml b/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.yaml deleted file mode 100644 index fb22816d6..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/.speakeasy/gen.yaml +++ /dev/null @@ -1,51 +0,0 @@ -configVersion: 2.0.0 -generation: - sdkClassName: MistralGoogleCloud - maintainOpenAPIOrder: true - usageSnippets: - optionalPropertyRendering: withExample - useClassNamesForArrayFields: true - fixes: - nameResolutionDec2023: true - nameResolutionFeb2025: false - parameterOrderingFeb2024: true - requestResponseComponentNamesFeb2024: true - securityFeb2025: false - auth: - oAuth2ClientCredentialsEnabled: true - oAuth2PasswordEnabled: false -typescript: - version: 1.5.0 - additionalDependencies: - dependencies: - google-auth-library: ^9.11.0 - devDependencies: {} - peerDependencies: {} - additionalPackageJSON: {} - author: Speakeasy - clientServerStatusCodesAsErrors: true - defaultErrorName: SDKError - enableCustomCodeRegions: false - enableMCPServer: false - enableReactQuery: false - enumFormat: union - flattenGlobalSecurity: true - flatteningOrder: body-first - imports: - option: openapi - paths: - callbacks: models/callbacks - errors: models/errors - operations: models/operations - shared: models/components - webhooks: models/webhooks - inputModelSuffix: input - jsonpath: legacy - maxMethodParams: 0 - methodArguments: require-security-and-request - moduleFormat: commonjs - outputModelSuffix: output - packageName: '@mistralai/mistralai-gcp' - responseFormat: flat - templateVersion: v2 - useIndexModules: true diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/CONTRIBUTING.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/CONTRIBUTING.md deleted file mode 100644 index d585717fc..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Contributing to This Repository - -Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. - -## How to Report Issues - -If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: - -- A clear and descriptive title -- Steps to reproduce the issue -- Expected and actual behavior -- Any relevant logs, screenshots, or error messages -- Information about your environment (e.g., operating system, software versions) - - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed - -## Issue Triage and Upstream Fixes - -We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. - -## Contact - -If you have any questions or need further assistance, please feel free to reach out by opening an issue. - -Thank you for your understanding and cooperation! - -The Maintainers diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/FUNCTIONS.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/FUNCTIONS.md deleted file mode 100644 index 3a89845a4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/FUNCTIONS.md +++ /dev/null @@ -1,112 +0,0 @@ -# Standalone Functions - -> [!NOTE] -> This section is useful if you are using a bundler and targetting browsers and -> runtimes where the size of an application affects performance and load times. - -Every method in this SDK is also available as a standalone function. This -alternative API is suitable when targetting the browser or serverless runtimes -and using a bundler to build your application since all unused functionality -will be tree-shaken away. This includes code for unused methods, Zod schemas, -encoding helpers and response handlers. The result is dramatically smaller -impact on the application's final bundle size which grows very slowly as you use -more and more functionality from this SDK. - -Calling methods through the main SDK class remains a valid and generally more -more ergonomic option. Standalone functions represent an optimisation for a -specific category of applications. - -## Example - -```typescript -import { MistralGoogleCloudCore } from "@mistralai/mistralai-gcp/core.js"; -import { chatComplete } from "@mistralai/mistralai-gcp/funcs/chatComplete.js"; -import { SDKValidationError } from "@mistralai/mistralai-gcp/models/errors/sdkvalidationerror.js"; - -// Use `MistralGoogleCloudCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const mistralGoogleCloud = new MistralGoogleCloudCore({ - apiKey: "", -}); - -async function run() { - const res = await chatComplete(mistralGoogleCloud, { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - switch (true) { - case res.ok: - // The success case will be handled outside of the switch block - break; - case res.error instanceof SDKValidationError: - // Pretty-print validation errors. - return console.log(res.error.pretty()); - case res.error instanceof Error: - return console.log(res.error); - default: - // TypeScript's type checking will fail on the following line if the above - // cases were not exhaustive. - res.error satisfies never; - throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error); - } - - - const { value: result } = res; - - // Handle the result - console.log(result); -} - -run(); -``` - -## Result types - -Standalone functions differ from SDK methods in that they return a -`Result` type to capture _known errors_ and document them using -the type system. By avoiding throwing errors, application code maintains clear -control flow and error-handling become part of the regular flow of application -code. - -> We use the term "known errors" because standalone functions, and JavaScript -> code in general, can still throw unexpected errors such as `TypeError`s, -> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be -> something this SDK addresses in the future. Nevertheless, there is still a lot -> of benefit from capturing most errors and turning them into values. - -The second reason for this style of programming is because these functions will -typically be used in front-end applications where exception throwing is -sometimes discouraged or considered unidiomatic. React and similar ecosystems -and libraries tend to promote this style of programming so that components -render useful content under all states (loading, success, error and so on). - -The general pattern when calling standalone functions looks like this: - -```typescript -import { Core } from ""; -import { fetchSomething } from "/funcs/fetchSomething.js"; - -const client = new Core(); - -async function run() { - const result = await fetchSomething(client, { id: "123" }); - if (!result.ok) { - // You can throw the error or handle it. It's your choice now. - throw result.error; - } - - console.log(result.value); -} - -run(); -``` - -Notably, `result.error` above will have an explicit type compared to a try-catch -variation where the error in the catch block can only be of type `unknown` (or -`any` depending on your TypeScript settings). \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/LICENSE b/examples/sdks/mistral-typescript/packages/mistralai-gcp/LICENSE deleted file mode 100644 index bec127680..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2024 Mistral AI - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/README.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/README.md deleted file mode 100644 index 6989c4398..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/README.md +++ /dev/null @@ -1,455 +0,0 @@ -# Mistral on GCP Typescript Client - - - - -## SDK Installation - -### NPM - -```bash -npm add @mistralai/mistralai-gcp -``` - -### PNPM - -```bash -pnpm add @mistralai/mistralai-gcp -``` - -### Bun - -```bash -bun add @mistralai/mistralai-gcp -``` - -### Yarn - -```bash -yarn add @mistralai/mistralai-gcp zod - -# Note that Yarn does not install peer dependencies automatically. You will need -# to install zod as shown above. -``` - - - -## Requirements - -For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). - - - -## SDK Example Usage - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - - -const sdk = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result); -} - -run(); - -``` - - - -## Available Resources and Operations - -### [chat](docs/sdks/chat/README.md) - -* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion -* [create](docs/sdks/chat/README.md#create) - Chat Completion - -### [fim](docs/sdks/fim/README.md) - -* [create](docs/sdks/fim/README.md#create) - Fim Completion - - - -## Server-sent event streaming - -[Server-sent events][mdn-sse] are used to stream content from certain -operations. These operations will expose the stream as an async iterable that -can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will -terminate when the server no longer has any events to send and closes the -underlying connection. - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const sdk = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - -[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events -[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of - - - -## Retries - -Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. - -To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const sdk = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream( - { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }, - { - retries: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - } - ); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - -If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - retryConfig: { - strategy: "backoff", - backoff: { - initialInterval: 1, - maxInterval: 50, - exponent: 1.1, - maxElapsedTime: 100, - }, - retryConnectionErrors: false, - }, - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - -## Error Handling - -All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type. - -| Error Object | Status Code | Content Type | -| -------------------------- | ----------- | ---------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4xx-5xx | */* | - -Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. - - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; -import { SDKValidationError } from "@mistralai/mistralai-gcp/models/errors"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - let result; - try { - result = await MistralGoogleCloud.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - } catch (err) { - switch (true) { - case err instanceof SDKValidationError: { - // Validation errors can be pretty-printed - console.error(err.pretty()); - // Raw value may also be inspected - console.error(err.rawValue); - return; - } - case err instanceof errors.HTTPValidationError: { - console.error(err); // handle exception - return; - } - default: { - throw err; - } - } - } - - // Handle the result - console.log(result); -} - -run(); - -``` - - - -## Server Selection - -### Select Server by Name - -You can override the default server globally by passing a server name to the `server` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: - -| Name | Server | Variables | -| ------ | ------------------------ | --------- | -| `prod` | `https://api.mistral.ai` | None | - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - server: "prod", - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - -### Override Server URL Per-Client - -The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - serverURL: "https://api.mistral.ai", - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - -## Custom HTTP Client - -The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native -[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This -client is a thin wrapper around `fetch` and provides the ability to attach hooks -around the request lifecycle that can be used to modify the request or handle -errors and response. - -The `HTTPClient` constructor takes an optional `fetcher` argument that can be -used to integrate a third-party HTTP client or when writing tests to mock out -the HTTP client and feed in fixtures. - -The following example shows how to use the `"beforeRequest"` hook to to add a -custom header and a timeout to requests and how to use the `"requestError"` hook -to log errors: - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; -import { HTTPClient } from "@mistralai/mistralai-gcp/lib/http"; - -const httpClient = new HTTPClient({ - // fetcher takes a function that has the same signature as native `fetch`. - fetcher: (request) => { - return fetch(request); - } -}); - -httpClient.addHook("beforeRequest", (request) => { - const nextRequest = new Request(request, { - signal: request.signal || AbortSignal.timeout(5000) - }); - - nextRequest.headers.set("x-custom-header", "custom value"); - - return nextRequest; -}); - -httpClient.addHook("requestError", (error, request) => { - console.group("Request Error"); - console.log("Reason:", `${error}`); - console.log("Endpoint:", `${request.method} ${request.url}`); - console.groupEnd(); -}); - -const sdk = new MistralGoogleCloud({ httpClient }); -``` - - - -## Authentication - -### Per-Client Security Schemes - -This SDK supports the following security scheme globally: - -| Name | Type | Scheme | -| -------- | ---- | ----------- | -| `apiKey` | http | HTTP Bearer | - -To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example: -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); - -``` - - - - -# Development - - -## Contributions - -While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. -We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/RELEASES.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/RELEASES.md deleted file mode 100644 index 1cd7fda93..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/RELEASES.md +++ /dev/null @@ -1,121 +0,0 @@ - - -## 2024-08-07 12:27:10 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.356.0 (2.388.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.0] packages/mistralai-gcp -### Releases -- [NPM v1.0.0] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.0.0 - packages/mistralai-gcp - -## 2024-08-08 18:05:48 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.357.4 (2.390.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.2] packages/mistralai-gcp -### Releases -- [NPM v1.0.2] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.0.2 - packages/mistralai-gcp - -## 2024-08-20 08:43:18 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.376.0 (2.402.5) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.3] packages/mistralai-gcp -### Releases -- [NPM v1.0.3] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.0.3 - packages/mistralai-gcp - -## 2024-08-23 12:00:12 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.378.0 (2.404.3) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.0.4] packages/mistralai-gcp -### Releases -- [NPM v1.0.4] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.0.4 - packages/mistralai-gcp - -## 2024-09-19 11:35:29 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.399.3 (2.420.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.1.0] packages/mistralai-gcp -### Releases -- [NPM v1.1.0] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.1.0 - packages/mistralai-gcp - -## 2024-11-08 13:01:40 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.434.7 (2.452.0) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.0] packages/mistralai-gcp -### Releases -- [NPM v1.3.0] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.3.0 - packages/mistralai-gcp - -## 2024-11-12 18:04:59 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.1] packages/mistralai-gcp -### Releases -- [NPM v1.3.1] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.3.1 - packages/mistralai-gcp - -## 2024-11-15 18:36:48 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.4] packages/mistralai-gcp -### Releases -- [NPM v1.3.4] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.3.4 - packages/mistralai-gcp - -## 2024-12-04 09:25:48 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.451.1 (2.470.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.5] packages/mistralai-gcp -### Releases -- [NPM v1.3.5] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.3.5 - packages/mistralai-gcp - -## 2025-01-06 10:25:42 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.462.2 (2.486.1) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.3.6] packages/mistralai-gcp -### Releases -- [NPM v1.3.6] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.3.6 - packages/mistralai-gcp - -## 2025-01-21 10:40:45 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.469.11 (2.493.32) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.4.0] packages/mistralai-gcp -### Releases -- [NPM v1.4.0] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.4.0 - packages/mistralai-gcp - -## 2025-03-20 14:22:31 -### Changes -Based on: -- OpenAPI Doc -- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy -### Generated -- [typescript v1.5.0] packages/mistralai-gcp -### Releases -- [NPM v1.5.0] https://www.npmjs.com/package/@mistralai/mistralai-gcp/v/1.5.0 - packages/mistralai-gcp \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/RUNTIMES.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/RUNTIMES.md deleted file mode 100644 index db7ea9423..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/RUNTIMES.md +++ /dev/null @@ -1,48 +0,0 @@ -# Supported JavaScript runtimes - -This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features: - -* [Web Fetch API][web-fetch] -* [Web Streams API][web-streams] and in particular `ReadableStream` -* [Async iterables][async-iter] using `Symbol.asyncIterator` - -[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API -[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API -[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols - -Runtime environments that are explicitly supported are: - -- Evergreen browsers which include: Chrome, Safari, Edge, Firefox -- Node.js active and maintenance LTS releases - - Currently, this is v18 and v20 -- Bun v1 and above -- Deno v1.39 - - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming]) - -[deno-file-streaming]: https://github.com/denoland/deno/issues/11018 - -## Recommended TypeScript compiler options - -The following `tsconfig.json` options are recommended for projects using this -SDK in order to get static type support for features like async iterables, -streams and `fetch`-related APIs ([`for await...of`][for-await-of], -[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and -so on): - -[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of -[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal -[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request -[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response - -```jsonc -{ - "compilerOptions": { - "target": "es2020", // or higher - "lib": ["es2020", "dom", "dom.iterable"], - } -} -``` - -While `target` can be set to older ECMAScript versions, it may result in extra, -unnecessary compatibility code being generated if you are not targeting old -runtimes. \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/USAGE.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/USAGE.md deleted file mode 100644 index 3bb48a9a4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/USAGE.md +++ /dev/null @@ -1,32 +0,0 @@ - -### Create Chat Completions - -This example shows how to create chat completions. - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const mistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await mistralGoogleCloud.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result); -} - -run(); - -``` - \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/lib/utils/retryconfig.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/lib/utils/retryconfig.md deleted file mode 100644 index 08f95f455..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/lib/utils/retryconfig.md +++ /dev/null @@ -1,24 +0,0 @@ -# RetryConfig - -Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- | -| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | | -| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | ------------ | ----------------------------------------- | -------- | -| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` | -| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` | -| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/arguments.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/arguments.md deleted file mode 100644 index ef0bdc61d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/arguments.md +++ /dev/null @@ -1,19 +0,0 @@ -# Arguments - - -## Supported Types - -### `{ [k: string]: any }` - -```typescript -const value: { [k: string]: any } = { - "key": "", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessage.md deleted file mode 100644 index ac13b2db2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# AssistantMessage - -## Example Usage - -```typescript -import { AssistantMessage } from "@mistralai/mistralai-gcp/models/components"; - -let value: AssistantMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `content` | *components.AssistantMessageContent* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | -| `prefix` | *boolean* | :heavy_minus_sign: | Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. | -| `role` | [components.AssistantMessageRole](../../models/components/assistantmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagecontent.md deleted file mode 100644 index ffa94cf0e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# AssistantMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - imageUrl: { - url: "https://jittery-window.com", - }, - type: "image_url", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagerole.md deleted file mode 100644 index a27605979..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/assistantmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# AssistantMessageRole - -## Example Usage - -```typescript -import { AssistantMessageRole } from "@mistralai/mistralai-gcp/models/components"; - -let value: AssistantMessageRole = "assistant"; -``` - -## Values - -```typescript -"assistant" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoice.md deleted file mode 100644 index 3d0e6f466..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionChoice - -## Example Usage - -```typescript -import { ChatCompletionChoice } from "@mistralai/mistralai-gcp/models/components"; - -let value: ChatCompletionChoice = { - index: 0, - message: {}, - finishReason: "stop", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `index` | *number* | :heavy_check_mark: | N/A | 0 | -| `message` | [components.AssistantMessage](../../models/components/assistantmessage.md) | :heavy_check_mark: | N/A | | -| `finishReason` | [components.ChatCompletionChoiceFinishReason](../../models/components/chatcompletionchoicefinishreason.md) | :heavy_check_mark: | N/A | stop | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoicefinishreason.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoicefinishreason.md deleted file mode 100644 index b898e85ab..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionchoicefinishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# ChatCompletionChoiceFinishReason - -## Example Usage - -```typescript -import { ChatCompletionChoiceFinishReason } from "@mistralai/mistralai-gcp/models/components"; - -let value: ChatCompletionChoiceFinishReason = "stop"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "model_length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequest.md deleted file mode 100644 index 986344bee..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequest.md +++ /dev/null @@ -1,38 +0,0 @@ -# ChatCompletionRequest - -## Example Usage - -```typescript -import { ChatCompletionRequest } from "@mistralai/mistralai-gcp/models/components"; - -let value: ChatCompletionRequest = { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. | mistral-small-latest | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.ChatCompletionRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.ChatCompletionRequestMessages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequestmessages.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequestmessages.md deleted file mode 100644 index 0bc19a1b4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequestmessages.md +++ /dev/null @@ -1,42 +0,0 @@ -# ChatCompletionRequestMessages - - -## Supported Types - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: "", -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [ - { - imageUrl: { - url: "https://sugary-brace.org/", - }, - type: "image_url", - }, - ], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: "", -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequeststop.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequeststop.md deleted file mode 100644 index 5cf805d77..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequeststop.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequesttoolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequesttoolchoice.md deleted file mode 100644 index 8750103b5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "required"; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionresponse.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionresponse.md deleted file mode 100644 index 406db8657..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionresponse.md +++ /dev/null @@ -1,37 +0,0 @@ -# ChatCompletionResponse - -## Example Usage - -```typescript -import { ChatCompletionResponse } from "@mistralai/mistralai-gcp/models/components"; - -let value: ChatCompletionResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "mistral-small-latest", - usage: { - promptTokens: 16, - completionTokens: 34, - totalTokens: 50, - }, - created: 1702256327, - choices: [ - { - index: 0, - message: {}, - finishReason: "stop", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | mistral-small-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_minus_sign: | N/A | 1702256327 | -| `choices` | [components.ChatCompletionChoice](../../models/components/chatcompletionchoice.md)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequest.md deleted file mode 100644 index 62744998a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequest.md +++ /dev/null @@ -1,38 +0,0 @@ -# ChatCompletionStreamRequest - -## Example Usage - -```typescript -import { ChatCompletionStreamRequest } from "@mistralai/mistralai-gcp/models/components"; - -let value: ChatCompletionStreamRequest = { - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. | mistral-small-latest | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.Stop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `messages` | *components.Messages*[] | :heavy_check_mark: | The prompt(s) to generate completions for, encoded as a list of dict with role and content. | [
    {
    "role": "user",
    "content": "Who is the best French painter? Answer in one short sentence."
    }
    ] | -| `responseFormat` | [components.ResponseFormat](../../models/components/responseformat.md) | :heavy_minus_sign: | N/A | | -| `tools` | [components.Tool](../../models/components/tool.md)[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *components.ChatCompletionStreamRequestToolChoice* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. | | -| `n` | *number* | :heavy_minus_sign: | Number of completions to return for each request, input tokens are only billed once. | | -| `prediction` | [components.Prediction](../../models/components/prediction.md) | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequesttoolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequesttoolchoice.md deleted file mode 100644 index 4d4a29f27..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/chatcompletionstreamrequesttoolchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# ChatCompletionStreamRequestToolChoice - - -## Supported Types - -### `components.ToolChoice` - -```typescript -const value: components.ToolChoice = { - function: { - name: "", - }, -}; -``` - -### `components.ToolChoiceEnum` - -```typescript -const value: components.ToolChoiceEnum = "none"; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionchunk.md deleted file mode 100644 index feac1c03a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionchunk.md +++ /dev/null @@ -1,35 +0,0 @@ -# CompletionChunk - -## Example Usage - -```typescript -import { CompletionChunk } from "@mistralai/mistralai-gcp/models/components"; - -let value: CompletionChunk = { - id: "", - model: "Golf", - usage: { - promptTokens: 16, - completionTokens: 34, - totalTokens: 50, - }, - choices: [ - { - index: 423655, - delta: {}, - finishReason: "error", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *string* | :heavy_minus_sign: | N/A | -| `created` | *number* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_minus_sign: | N/A | -| `choices` | [components.CompletionResponseStreamChoice](../../models/components/completionresponsestreamchoice.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionevent.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionevent.md deleted file mode 100644 index 1e30d6e01..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionevent.md +++ /dev/null @@ -1,32 +0,0 @@ -# CompletionEvent - -## Example Usage - -```typescript -import { CompletionEvent } from "@mistralai/mistralai-gcp/models/components"; - -let value: CompletionEvent = { - data: { - id: "", - model: "Golf", - usage: { - promptTokens: 16, - completionTokens: 34, - totalTokens: 50, - }, - choices: [ - { - index: 715190, - delta: {}, - finishReason: "error", - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [components.CompletionChunk](../../models/components/completionchunk.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionresponsestreamchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionresponsestreamchoice.md deleted file mode 100644 index 823eecdbf..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/completionresponsestreamchoice.md +++ /dev/null @@ -1,21 +0,0 @@ -# CompletionResponseStreamChoice - -## Example Usage - -```typescript -import { CompletionResponseStreamChoice } from "@mistralai/mistralai-gcp/models/components"; - -let value: CompletionResponseStreamChoice = { - index: 891773, - delta: {}, - finishReason: "tool_calls", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `index` | *number* | :heavy_check_mark: | N/A | -| `delta` | [components.DeltaMessage](../../models/components/deltamessage.md) | :heavy_check_mark: | N/A | -| `finishReason` | [components.FinishReason](../../models/components/finishreason.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/content.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/content.md deleted file mode 100644 index b05000a30..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/content.md +++ /dev/null @@ -1,22 +0,0 @@ -# Content - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - text: "", - type: "text", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/contentchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/contentchunk.md deleted file mode 100644 index b25f2ef23..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/contentchunk.md +++ /dev/null @@ -1,31 +0,0 @@ -# ContentChunk - - -## Supported Types - -### `components.ImageURLChunk` - -```typescript -const value: components.ImageURLChunk = { - imageUrl: "https://blaring-bog.com", -}; -``` - -### `components.TextChunk` - -```typescript -const value: components.TextChunk = { - text: "", -}; -``` - -### `components.ReferenceChunk` - -```typescript -const value: components.ReferenceChunk = { - referenceIds: [ - 832620, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/deltamessage.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/deltamessage.md deleted file mode 100644 index 3f287bc22..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/deltamessage.md +++ /dev/null @@ -1,17 +0,0 @@ -# DeltaMessage - -## Example Usage - -```typescript -import { DeltaMessage } from "@mistralai/mistralai-gcp/models/components"; - -let value: DeltaMessage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `role` | *string* | :heavy_minus_sign: | N/A | -| `content` | *components.Content* | :heavy_minus_sign: | N/A | -| `toolCalls` | [components.ToolCall](../../models/components/toolcall.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequest.md deleted file mode 100644 index bb1789138..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# FIMCompletionRequest - -## Example Usage - -```typescript -import { FIMCompletionRequest } from "@mistralai/mistralai-gcp/models/components"; - -let value: FIMCompletionRequest = { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. Only compatible for now with:
    - `codestral-2405`
    - `codestral-latest` | codestral-2405 | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. | | -| `stop` | *components.FIMCompletionRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `prompt` | *string* | :heavy_check_mark: | The text/code to complete. | def | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | return a+b | -| `minTokens` | *number* | :heavy_minus_sign: | The minimum number of tokens to generate in the completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequeststop.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequeststop.md deleted file mode 100644 index 84c5828fb..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionrequeststop.md +++ /dev/null @@ -1,21 +0,0 @@ -# FIMCompletionRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionresponse.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionresponse.md deleted file mode 100644 index cf052b2d4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionresponse.md +++ /dev/null @@ -1,37 +0,0 @@ -# FIMCompletionResponse - -## Example Usage - -```typescript -import { FIMCompletionResponse } from "@mistralai/mistralai-gcp/models/components"; - -let value: FIMCompletionResponse = { - id: "cmpl-e5cc70bb28c444948073e77776eb30ef", - object: "chat.completion", - model: "codestral-latest", - usage: { - promptTokens: 16, - completionTokens: 34, - totalTokens: 50, - }, - created: 1702256327, - choices: [ - { - index: 0, - message: {}, - finishReason: "stop", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | cmpl-e5cc70bb28c444948073e77776eb30ef | -| `object` | *string* | :heavy_check_mark: | N/A | chat.completion | -| `model` | *string* | :heavy_check_mark: | N/A | codestral-latest | -| `usage` | [components.UsageInfo](../../models/components/usageinfo.md) | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_minus_sign: | N/A | 1702256327 | -| `choices` | [components.ChatCompletionChoice](../../models/components/chatcompletionchoice.md)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequest.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequest.md deleted file mode 100644 index 395558ae1..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequest.md +++ /dev/null @@ -1,28 +0,0 @@ -# FIMCompletionStreamRequest - -## Example Usage - -```typescript -import { FIMCompletionStreamRequest } from "@mistralai/mistralai-gcp/models/components"; - -let value: FIMCompletionStreamRequest = { - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | ID of the model to use. Only compatible for now with:
    - `codestral-2405`
    - `codestral-latest` | codestral-2405 | -| `temperature` | *number* | :heavy_minus_sign: | What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. | | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. | | -| `maxTokens` | *number* | :heavy_minus_sign: | The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `stop` | *components.FIMCompletionStreamRequestStop* | :heavy_minus_sign: | Stop generation if this token is detected. Or if one of these tokens is detected when providing an array | | -| `randomSeed` | *number* | :heavy_minus_sign: | The seed to use for random sampling. If set, different calls will generate deterministic results. | | -| `prompt` | *string* | :heavy_check_mark: | The text/code to complete. | def | -| `suffix` | *string* | :heavy_minus_sign: | Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. | return a+b | -| `minTokens` | *number* | :heavy_minus_sign: | The minimum number of tokens to generate in the completion. | | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequeststop.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequeststop.md deleted file mode 100644 index 376ae828a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/fimcompletionstreamrequeststop.md +++ /dev/null @@ -1,21 +0,0 @@ -# FIMCompletionStreamRequestStop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/finishreason.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/finishreason.md deleted file mode 100644 index f284ebe09..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/finishreason.md +++ /dev/null @@ -1,17 +0,0 @@ -# FinishReason - -## Example Usage - -```typescript -import { FinishReason } from "@mistralai/mistralai-gcp/models/components"; - -let value: FinishReason = "length"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"stop" | "length" | "error" | "tool_calls" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functioncall.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functioncall.md deleted file mode 100644 index 326a14cb1..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functioncall.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionCall - -## Example Usage - -```typescript -import { FunctionCall } from "@mistralai/mistralai-gcp/models/components"; - -let value: FunctionCall = { - name: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *components.Arguments* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functionname.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functionname.md deleted file mode 100644 index 4f592bc19..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functionname.md +++ /dev/null @@ -1,19 +0,0 @@ -# FunctionName - -this restriction of `Function` is used to select a specific function to call - -## Example Usage - -```typescript -import { FunctionName } from "@mistralai/mistralai-gcp/models/components"; - -let value: FunctionName = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functiont.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functiont.md deleted file mode 100644 index a82eb928b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/functiont.md +++ /dev/null @@ -1,23 +0,0 @@ -# FunctionT - -## Example Usage - -```typescript -import { FunctionT } from "@mistralai/mistralai-gcp/models/components"; - -let value: FunctionT = { - name: "", - parameters: { - "key": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `parameters` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurl.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurl.md deleted file mode 100644 index 66bd18b37..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurl.md +++ /dev/null @@ -1,18 +0,0 @@ -# ImageURL - -## Example Usage - -```typescript -import { ImageURL } from "@mistralai/mistralai-gcp/models/components"; - -let value: ImageURL = { - url: "https://misguided-hawk.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | -| `detail` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunk.md deleted file mode 100644 index 49b4f9347..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunk.md +++ /dev/null @@ -1,22 +0,0 @@ -# ImageURLChunk - -{"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - -## Example Usage - -```typescript -import { ImageURLChunk } from "@mistralai/mistralai-gcp/models/components"; - -let value: ImageURLChunk = { - imageUrl: { - url: "https://close-paintwork.com", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `imageUrl` | *components.ImageURLChunkImageURL* | :heavy_check_mark: | N/A | -| `type` | [components.ImageURLChunkType](../../models/components/imageurlchunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunkimageurl.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunkimageurl.md deleted file mode 100644 index 486a5ef7b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunkimageurl.md +++ /dev/null @@ -1,19 +0,0 @@ -# ImageURLChunkImageURL - - -## Supported Types - -### `components.ImageURL` - -```typescript -const value: components.ImageURL = { - url: "https://true-wasabi.net", -}; -``` - -### `string` - -```typescript -const value: string = ""; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunktype.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunktype.md deleted file mode 100644 index 02800da1a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/imageurlchunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ImageURLChunkType - -## Example Usage - -```typescript -import { ImageURLChunkType } from "@mistralai/mistralai-gcp/models/components"; - -let value: ImageURLChunkType = "image_url"; -``` - -## Values - -```typescript -"image_url" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/jsonschema.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/jsonschema.md deleted file mode 100644 index cd57dfb95..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/jsonschema.md +++ /dev/null @@ -1,23 +0,0 @@ -# JsonSchema - -## Example Usage - -```typescript -import { JsonSchema } from "@mistralai/mistralai-gcp/models/components"; - -let value: JsonSchema = { - name: "", - schemaDefinition: { - "key": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `schemaDefinition` | Record | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/loc.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/loc.md deleted file mode 100644 index 93706ec77..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/loc.md +++ /dev/null @@ -1,17 +0,0 @@ -# Loc - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `number` - -```typescript -const value: number = 456150; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/messages.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/messages.md deleted file mode 100644 index 22b2a13af..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/messages.md +++ /dev/null @@ -1,52 +0,0 @@ -# Messages - - -## Supported Types - -### `components.AssistantMessage` - -```typescript -const value: components.AssistantMessage = {}; -``` - -### `components.SystemMessage` - -```typescript -const value: components.SystemMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -### `components.ToolMessage` - -```typescript -const value: components.ToolMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -### `components.UserMessage` - -```typescript -const value: components.UserMessage = { - content: [ - { - referenceIds: [ - 359508, - ], - type: "reference", - }, - ], -}; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/prediction.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/prediction.md deleted file mode 100644 index ed4d53083..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/prediction.md +++ /dev/null @@ -1,16 +0,0 @@ -# Prediction - -## Example Usage - -```typescript -import { Prediction } from "@mistralai/mistralai-gcp/models/components"; - -let value: Prediction = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `content` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunk.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunk.md deleted file mode 100644 index b342cc99d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunk.md +++ /dev/null @@ -1,20 +0,0 @@ -# ReferenceChunk - -## Example Usage - -```typescript -import { ReferenceChunk } from "@mistralai/mistralai-gcp/models/components"; - -let value: ReferenceChunk = { - referenceIds: [ - 774234, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `referenceIds` | *number*[] | :heavy_check_mark: | N/A | -| `type` | [components.ReferenceChunkType](../../models/components/referencechunktype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunktype.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunktype.md deleted file mode 100644 index 3387fca8f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/referencechunktype.md +++ /dev/null @@ -1,15 +0,0 @@ -# ReferenceChunkType - -## Example Usage - -```typescript -import { ReferenceChunkType } from "@mistralai/mistralai-gcp/models/components"; - -let value: ReferenceChunkType = "reference"; -``` - -## Values - -```typescript -"reference" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformat.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformat.md deleted file mode 100644 index d4651434b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformat.md +++ /dev/null @@ -1,16 +0,0 @@ -# ResponseFormat - -## Example Usage - -```typescript -import { ResponseFormat } from "@mistralai/mistralai-gcp/models/components"; - -let value: ResponseFormat = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.ResponseFormats](../../models/components/responseformats.md) | :heavy_minus_sign: | An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. | -| `jsonSchema` | [components.JsonSchema](../../models/components/jsonschema.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformats.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformats.md deleted file mode 100644 index 351d45800..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/responseformats.md +++ /dev/null @@ -1,17 +0,0 @@ -# ResponseFormats - -An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - -## Example Usage - -```typescript -import { ResponseFormats } from "@mistralai/mistralai-gcp/models/components"; - -let value: ResponseFormats = "text"; -``` - -## Values - -```typescript -"text" | "json_object" | "json_schema" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/role.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/role.md deleted file mode 100644 index 73d494a9b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/role.md +++ /dev/null @@ -1,15 +0,0 @@ -# Role - -## Example Usage - -```typescript -import { Role } from "@mistralai/mistralai-gcp/models/components"; - -let value: Role = "system"; -``` - -## Values - -```typescript -"system" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/security.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/security.md deleted file mode 100644 index e0e9b8fe5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/security.md +++ /dev/null @@ -1,17 +0,0 @@ -# Security - -## Example Usage - -```typescript -import { Security } from "@mistralai/mistralai-gcp/models/components"; - -let value: Security = { - apiKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/stop.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/stop.md deleted file mode 100644 index f26b1bf3c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/stop.md +++ /dev/null @@ -1,21 +0,0 @@ -# Stop - -Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `string[]` - -```typescript -const value: string[] = [ - "", -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessage.md deleted file mode 100644 index b02ca2266..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessage.md +++ /dev/null @@ -1,23 +0,0 @@ -# SystemMessage - -## Example Usage - -```typescript -import { SystemMessage } from "@mistralai/mistralai-gcp/models/components"; - -let value: SystemMessage = { - content: [ - { - text: "", - type: "text", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `content` | *components.SystemMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.Role](../../models/components/role.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessagecontent.md deleted file mode 100644 index cda9bedd0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/systemmessagecontent.md +++ /dev/null @@ -1,21 +0,0 @@ -# SystemMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.TextChunk[]` - -```typescript -const value: components.TextChunk[] = [ - { - text: "", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/textchunk.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/textchunk.md deleted file mode 100644 index a3cb8dcf9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/textchunk.md +++ /dev/null @@ -1,18 +0,0 @@ -# TextChunk - -## Example Usage - -```typescript -import { TextChunk } from "@mistralai/mistralai-gcp/models/components"; - -let value: TextChunk = { - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [components.Type](../../models/components/type.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tool.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tool.md deleted file mode 100644 index 6b4f5438b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tool.md +++ /dev/null @@ -1,23 +0,0 @@ -# Tool - -## Example Usage - -```typescript -import { Tool } from "@mistralai/mistralai-gcp/models/components"; - -let value: Tool = { - function: { - name: "", - parameters: { - "key": "", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionT](../../models/components/functiont.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolcall.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolcall.md deleted file mode 100644 index c4edd1694..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolcall.md +++ /dev/null @@ -1,23 +0,0 @@ -# ToolCall - -## Example Usage - -```typescript -import { ToolCall } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolCall = { - function: { - name: "", - arguments: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionCall](../../models/components/functioncall.md) | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoice.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoice.md deleted file mode 100644 index 32f505b9f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoice.md +++ /dev/null @@ -1,22 +0,0 @@ -# ToolChoice - -ToolChoice is either a ToolChoiceEnum or a ToolChoice - -## Example Usage - -```typescript -import { ToolChoice } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolChoice = { - function: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.ToolTypes](../../models/components/tooltypes.md) | :heavy_minus_sign: | N/A | -| `function` | [components.FunctionName](../../models/components/functionname.md) | :heavy_check_mark: | this restriction of `Function` is used to select a specific function to call | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoiceenum.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoiceenum.md deleted file mode 100644 index 11580ae4e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolchoiceenum.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolChoiceEnum - -## Example Usage - -```typescript -import { ToolChoiceEnum } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolChoiceEnum = "any"; -``` - -## Values - -```typescript -"auto" | "none" | "any" | "required" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessage.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessage.md deleted file mode 100644 index 142851c9a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessage.md +++ /dev/null @@ -1,20 +0,0 @@ -# ToolMessage - -## Example Usage - -```typescript -import { ToolMessage } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.ToolMessageContent* | :heavy_check_mark: | N/A | -| `toolCallId` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `role` | [components.ToolMessageRole](../../models/components/toolmessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagecontent.md deleted file mode 100644 index 1b59bf968..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# ToolMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - imageUrl: { - url: "https://fair-insolence.biz", - }, - type: "image_url", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagerole.md deleted file mode 100644 index 8322d1f42..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/toolmessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# ToolMessageRole - -## Example Usage - -```typescript -import { ToolMessageRole } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolMessageRole = "tool"; -``` - -## Values - -```typescript -"tool" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tooltypes.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tooltypes.md deleted file mode 100644 index 64ea77d20..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/tooltypes.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToolTypes - -## Example Usage - -```typescript -import { ToolTypes } from "@mistralai/mistralai-gcp/models/components"; - -let value: ToolTypes = "function"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript -"function" | Unrecognized -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/type.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/type.md deleted file mode 100644 index e14f9498f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/type.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type - -## Example Usage - -```typescript -import { Type } from "@mistralai/mistralai-gcp/models/components"; - -let value: Type = "text"; -``` - -## Values - -```typescript -"text" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usageinfo.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usageinfo.md deleted file mode 100644 index a27db9cb5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usageinfo.md +++ /dev/null @@ -1,21 +0,0 @@ -# UsageInfo - -## Example Usage - -```typescript -import { UsageInfo } from "@mistralai/mistralai-gcp/models/components"; - -let value: UsageInfo = { - promptTokens: 16, - completionTokens: 34, - totalTokens: 50, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `promptTokens` | *number* | :heavy_check_mark: | N/A | 16 | -| `completionTokens` | *number* | :heavy_check_mark: | N/A | 34 | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | 50 | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessage.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessage.md deleted file mode 100644 index e64d8cea4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# UserMessage - -## Example Usage - -```typescript -import { UserMessage } from "@mistralai/mistralai-gcp/models/components"; - -let value: UserMessage = { - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *components.UserMessageContent* | :heavy_check_mark: | N/A | -| `role` | [components.UserMessageRole](../../models/components/usermessagerole.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagecontent.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagecontent.md deleted file mode 100644 index a8be0fda9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagecontent.md +++ /dev/null @@ -1,24 +0,0 @@ -# UserMessageContent - - -## Supported Types - -### `string` - -```typescript -const value: string = ""; -``` - -### `components.ContentChunk[]` - -```typescript -const value: components.ContentChunk[] = [ - { - referenceIds: [ - 210382, - ], - type: "reference", - }, -]; -``` - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagerole.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagerole.md deleted file mode 100644 index 0c9f3eefc..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/usermessagerole.md +++ /dev/null @@ -1,15 +0,0 @@ -# UserMessageRole - -## Example Usage - -```typescript -import { UserMessageRole } from "@mistralai/mistralai-gcp/models/components"; - -let value: UserMessageRole = "user"; -``` - -## Values - -```typescript -"user" -``` \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/validationerror.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/validationerror.md deleted file mode 100644 index b5cae6b10..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/components/validationerror.md +++ /dev/null @@ -1,23 +0,0 @@ -# ValidationError - -## Example Usage - -```typescript -import { ValidationError } from "@mistralai/mistralai-gcp/models/components"; - -let value: ValidationError = { - loc: [ - 18789, - ], - msg: "", - type: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `loc` | *components.Loc*[] | :heavy_check_mark: | N/A | -| `msg` | *string* | :heavy_check_mark: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/errors/httpvalidationerror.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/errors/httpvalidationerror.md deleted file mode 100644 index bc5d014f9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/models/errors/httpvalidationerror.md +++ /dev/null @@ -1,15 +0,0 @@ -# HTTPValidationError - -## Example Usage - -```typescript -import { HTTPValidationError } from "@mistralai/mistralai-gcp/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `detail` | [components.ValidationError](../../models/components/validationerror.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/chat/README.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/chat/README.md deleted file mode 100644 index bf658f6ed..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/chat/README.md +++ /dev/null @@ -1,115 +0,0 @@ -# Chat -(*chat*) - -## Overview - -Chat Completion API. - -### Available Operations - -* [stream](#stream) - Stream chat completion -* [create](#create) - Chat Completion - -## stream - -Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - -### Example Usage - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.stream({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - for await (const event of result) { - // Handle the event - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------- | ------------------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionStreamRequest](../../models/components/chatcompletionstreamrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[EventStream](../../models/.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| --------------- | ----------- | ------------ | -| errors.SDKError | 4xx-5xx | */* | - -## create - -Chat Completion - -### Example Usage - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.chat.complete({ - model: "mistral-small-latest", - messages: [ - { - content: "Who is the best French painter? Answer in one short sentence.", - role: "user", - }, - ], - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------- | --------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.ChatCompletionRequest](../../models/components/chatcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| -------------------------- | ----------- | ---------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4xx-5xx | */* | diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/fim/README.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/fim/README.md deleted file mode 100644 index 83bcb72cb..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/fim/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# Fim -(*fim*) - -## Overview - -Fill-in-the-middle API. - -### Available Operations - -* [create](#create) - Fim Completion - -## create - -FIM completion. - -### Example Usage - -```typescript -import { MistralGoogleCloud } from "@mistralai/mistralai-gcp"; - -const MistralGoogleCloud = new MistralGoogleCloud({ - region: "europe-west4", - projectId: process.env["GOOGLE_PROJECT_ID"], -}); - -async function run() { - const result = await MistralGoogleCloud.fim.complete({ - model: "codestral-2405", - prompt: "def", - suffix: "return a+b", - }); - - // Handle the result - console.log(result) -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------- | --------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [components.FIMCompletionRequest](../../models/components/fimcompletionrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - - -### Response - -**Promise\<[components.FIMCompletionResponse](../../models/components/fimcompletionresponse.md)\>** -### Errors - -| Error Object | Status Code | Content Type | -| -------------------------- | ----------- | ---------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4xx-5xx | */* | diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md b/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md deleted file mode 100644 index d85a4742f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# MistralGoogleCloud SDK - - -## Overview - -Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - -### Available Operations - diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/eslint.config.mjs b/examples/sdks/mistral-typescript/packages/mistralai-gcp/eslint.config.mjs deleted file mode 100644 index 3483f71ba..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/eslint.config.mjs +++ /dev/null @@ -1,21 +0,0 @@ -import globals from "globals"; -import pluginJs from "@eslint/js"; -import tseslint from "typescript-eslint"; - -/** @type {import('eslint').Linter.Config[]} */ -export default [ - { files: ["**/*.{js,mjs,cjs,ts}"] }, - { languageOptions: { globals: globals.browser } }, - pluginJs.configs.recommended, - ...tseslint.configs.recommended, - { - rules: { - "no-constant-condition": "off", - // Handled by typescript compiler - "@typescript-eslint/no-unused-vars": "off", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-empty-object-type": "off", - "@typescript-eslint/no-namespace": "off", - }, - }, -]; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/jsr.json b/examples/sdks/mistral-typescript/packages/mistralai-gcp/jsr.json deleted file mode 100644 index 688a39b00..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/jsr.json +++ /dev/null @@ -1,28 +0,0 @@ - - -{ - "name": "@mistralai/mistralai-gcp", - "version": "1.5.0", - "exports": { - ".": "./src/index.ts", - "./models/errors": "./src/models/errors/index.ts", - "./models/components": "./src/models/components/index.ts", - "./models/operations": "./src/models/operations/index.ts", - "./lib/config": "./src/lib/config.ts", - "./lib/http": "./src/lib/http.ts", - "./lib/retries": "./src/lib/retries.ts", - "./lib/sdks": "./src/lib/sdks.ts", - "./lib/event-streams": "./src/lib/event-streams.ts", - "./types": "./src/types/index.ts" - }, - "publish": { - "include": [ - "LICENSE", - "README.md", - "RUNTIMES.md", - "USAGE.md", - "jsr.json", - "src/**/*.ts" - ] - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/package-lock.json b/examples/sdks/mistral-typescript/packages/mistralai-gcp/package-lock.json deleted file mode 100644 index ff6c97d90..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/package-lock.json +++ /dev/null @@ -1,2121 +0,0 @@ -{ - "name": "@mistralai/mistralai-gcp", - "version": "1.5.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "@mistralai/mistralai-gcp", - "version": "1.5.0", - "dependencies": { - "google-auth-library": "^9.11.0" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "peerDependencies": { - "zod": ">= 3" - } - }, - "node_modules/@eslint-community/eslint-utils": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", - "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eslint-visitor-keys": "^3.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "peerDependencies": { - "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" - } - }, - "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.0.0 || ^14.0.0 || >=16.0.0" - } - }, - "node_modules/@eslint/config-array": { - "version": "0.19.2", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.2.tgz", - "integrity": "sha512-GNKqxfHG2ySmJOBSHg7LxeUx4xpuCoFjacmlCoYWEbaPXLwvfIjixRI12xCQZeULksQb23uiA8F40w5TojpV7w==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/object-schema": "^2.1.6", - "debug": "^4.3.1", - "minimatch": "^3.1.2" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/config-array/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/config-array/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/config-helpers": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.1.0.tgz", - "integrity": "sha512-kLrdPDJE1ckPo94kmPPf9Hfd0DU0Jw6oKYrhe+pwSC0iTUInmTa+w6fw8sGgcfkFJGNdWOUeOaDM4quW4a7OkA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/core": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.12.0.tgz", - "integrity": "sha512-cmrR6pytBuSMTaBweKoGMwu3EiHiEC+DoyupPmlZ0HxBJBtIxwe+j/E4XPIKNx+Q74c8lXKPwYawBf5glsTkHg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@types/json-schema": "^7.0.15" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/eslintrc": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.0.tgz", - "integrity": "sha512-yaVPAiNAalnCZedKLdR21GOGILMLKPyqSLWaAjQFvYA2i/ciDi8ArYVr69Anohb6cH2Ukhqti4aFnYyPm8wdwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "^6.12.4", - "debug": "^4.3.2", - "espree": "^10.0.1", - "globals": "^14.0.0", - "ignore": "^5.2.0", - "import-fresh": "^3.2.1", - "js-yaml": "^4.1.0", - "minimatch": "^3.1.2", - "strip-json-comments": "^3.1.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/@eslint/eslintrc/node_modules/globals": { - "version": "14.0.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", - "integrity": "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@eslint/eslintrc/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/@eslint/js": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.22.0.tgz", - "integrity": "sha512-vLFajx9o8d1/oL2ZkpMYbkLv8nDB6yaIwFNt7nI4+I80U/z03SxmfOMsLbvWr3p7C+Wnoh//aOu2pQW8cS0HCQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/object-schema": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", - "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@eslint/plugin-kit": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.2.7.tgz", - "integrity": "sha512-JubJ5B2pJ4k4yGxaNLdbjrnk9d/iDz6/q8wOilpIowd6PJPgaxCuHBnBszq7Ce2TyMrywm5r4PnKm6V3iiZF+g==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@eslint/core": "^0.12.0", - "levn": "^0.4.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - } - }, - "node_modules/@humanfs/core": { - "version": "0.19.1", - "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", - "integrity": "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node": { - "version": "0.16.6", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", - "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@humanfs/core": "^0.19.1", - "@humanwhocodes/retry": "^0.3.0" - }, - "engines": { - "node": ">=18.18.0" - } - }, - "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", - "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/module-importer": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", - "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=12.22" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@humanwhocodes/retry": { - "version": "0.4.2", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.2.tgz", - "integrity": "sha512-xeO57FpIu4p1Ri3Jq/EXq4ClRm86dVF2z/+kvFnyqVYRavTZmaFaUBbWCOuuTh0o/g7DSsk6kc2vrS4Vl5oPOQ==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@types/estree": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", - "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@typescript-eslint/type-utils": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.27.0.tgz", - "integrity": "sha512-wVArTVcz1oJOIEJxui/nRhV0TXzD/zMSOYi/ggCfNq78EIszddXcJb7r4RCp/oBrjt8n9A0BSxRMKxHftpDxDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/typescript-estree": "8.27.0", - "@typescript-eslint/utils": "8.27.0", - "debug": "^4.3.4", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/type-utils/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/@typescript-eslint/utils": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.27.0.tgz", - "integrity": "sha512-njkodcwH1yvmo31YWgRHNb/x1Xhhq4/m81PhtvmRngD8iHPehxffz1SNCO+kwaePhATC+kOa/ggmvPoPza5i0Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/typescript-estree": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/scope-manager": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.27.0.tgz", - "integrity": "sha512-8oI9GwPMQmBryaaxG1tOZdxXVeMDte6NyJA4i7/TWa4fBwgnAXYlIQP+uYOeqAaLJ2JRxlG9CAyL+C+YE9Xknw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/@typescript-eslint/utils/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/acorn": { - "version": "8.14.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", - "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", - "dev": true, - "license": "MIT", - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-jsx": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", - "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/agent-base": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", - "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", - "license": "MIT", - "dependencies": { - "debug": "^4.3.4" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true, - "license": "Python-2.0" - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/base64-js": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/bignumber.js": { - "version": "9.1.2", - "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-9.1.2.tgz", - "integrity": "sha512-2/mKyZH9K85bzOEfhXDBFZTGd1CTs+5IHpeFQo9luiBG7hghdC851Pj2WAhb6E3R6b9tZj/XKhbg4fum+Kepug==", - "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/buffer-equal-constant-time": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", - "integrity": "sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA==", - "license": "BSD-3-Clause" - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true, - "license": "MIT" - }, - "node_modules/cross-spawn": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/debug": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", - "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", - "license": "MIT", - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/deep-is": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", - "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/ecdsa-sig-formatter": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz", - "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==", - "license": "Apache-2.0", - "dependencies": { - "safe-buffer": "^5.0.1" - } - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint": { - "version": "9.22.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.22.0.tgz", - "integrity": "sha512-9V/QURhsRN40xuHXWjV64yvrzMjcz7ZyNoF2jJFmy9j/SLk0u1OLSZgXi28MrXjymnjEGSR80WCdab3RGMDveQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", - "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.19.2", - "@eslint/config-helpers": "^0.1.0", - "@eslint/core": "^0.12.0", - "@eslint/eslintrc": "^3.3.0", - "@eslint/js": "9.22.0", - "@eslint/plugin-kit": "^0.2.7", - "@humanfs/node": "^0.16.6", - "@humanwhocodes/module-importer": "^1.0.1", - "@humanwhocodes/retry": "^0.4.2", - "@types/estree": "^1.0.6", - "@types/json-schema": "^7.0.15", - "ajv": "^6.12.4", - "chalk": "^4.0.0", - "cross-spawn": "^7.0.6", - "debug": "^4.3.2", - "escape-string-regexp": "^4.0.0", - "eslint-scope": "^8.3.0", - "eslint-visitor-keys": "^4.2.0", - "espree": "^10.3.0", - "esquery": "^1.5.0", - "esutils": "^2.0.2", - "fast-deep-equal": "^3.1.3", - "file-entry-cache": "^8.0.0", - "find-up": "^5.0.0", - "glob-parent": "^6.0.2", - "ignore": "^5.2.0", - "imurmurhash": "^0.1.4", - "is-glob": "^4.0.0", - "json-stable-stringify-without-jsonify": "^1.0.1", - "lodash.merge": "^4.6.2", - "minimatch": "^3.1.2", - "natural-compare": "^1.4.0", - "optionator": "^0.9.3" - }, - "bin": { - "eslint": "bin/eslint.js" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://eslint.org/donate" - }, - "peerDependencies": { - "jiti": "*" - }, - "peerDependenciesMeta": { - "jiti": { - "optional": true - } - } - }, - "node_modules/eslint-scope": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.3.0.tgz", - "integrity": "sha512-pUNxi75F8MJ/GdeKtVLSbYg4ZI34J6C0C7sbL4YOp2exGwen7ZsuBqKzUhXd0qMQ362yET3z+uPwKeg/0C2XCQ==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^5.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint-visitor-keys": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/espree": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.3.0.tgz", - "integrity": "sha512-0QYC8b24HWY8zjRnDTL6RiHfDbAWn63qb4LMj1Z4b076A4une81+z03Kg7l7mn/48PUTqoLptSXez8oknU8Clg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "acorn": "^8.14.0", - "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/espree/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "estraverse": "^5.1.0" - }, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/esrecurse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "estraverse": "^5.2.0" - }, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estraverse": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", - "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "license": "MIT" - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.4" - }, - "engines": { - "node": ">=8.6.0" - } - }, - "node_modules/fast-glob/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fastq": { - "version": "1.17.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", - "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", - "dev": true, - "license": "ISC", - "dependencies": { - "reusify": "^1.0.4" - } - }, - "node_modules/file-entry-cache": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", - "integrity": "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "flat-cache": "^4.0.0" - }, - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "dev": true, - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "license": "MIT", - "dependencies": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/flat-cache": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", - "integrity": "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==", - "dev": true, - "license": "MIT", - "dependencies": { - "flatted": "^3.2.9", - "keyv": "^4.5.4" - }, - "engines": { - "node": ">=16" - } - }, - "node_modules/flatted": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", - "dev": true, - "license": "ISC" - }, - "node_modules/gaxios": { - "version": "6.7.0", - "resolved": "https://registry.npmjs.org/gaxios/-/gaxios-6.7.0.tgz", - "integrity": "sha512-DSrkyMTfAnAm4ks9Go20QGOcXEyW/NmZhvTYBU2rb4afBB393WIMQPWPEDMl/k8xqiNN9HYq2zao3oWXsdl2Tg==", - "license": "Apache-2.0", - "dependencies": { - "extend": "^3.0.2", - "https-proxy-agent": "^7.0.1", - "is-stream": "^2.0.0", - "node-fetch": "^2.6.9", - "uuid": "^10.0.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/gcp-metadata": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/gcp-metadata/-/gcp-metadata-6.1.0.tgz", - "integrity": "sha512-Jh/AIwwgaxan+7ZUUmRLCjtchyDiqh4KjBJ5tW3plBZb5iL/BPcso8A5DlzeD9qlw0duCamnNdpFjxwaT0KyKg==", - "license": "Apache-2.0", - "dependencies": { - "gaxios": "^6.0.0", - "json-bigint": "^1.0.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/glob-parent": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", - "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.3" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/globals": { - "version": "15.15.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-15.15.0.tgz", - "integrity": "sha512-7ACyT3wmyp3I61S4fG682L0VA2RGD9otkqGJIwNUMF1SWUombIIk+af1unuDYgMm082aHYwD+mzJvv9Iu8dsgg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/google-auth-library": { - "version": "9.12.0", - "resolved": "https://registry.npmjs.org/google-auth-library/-/google-auth-library-9.12.0.tgz", - "integrity": "sha512-5pWjpxJMNJ5UTuhK7QPD5KFPsbosWkX4ajMDeZwXllTtwwqeiIzPWbHIddkLBkkn0mUPboTmukT5rd30Ec9igQ==", - "license": "Apache-2.0", - "dependencies": { - "base64-js": "^1.3.0", - "ecdsa-sig-formatter": "^1.0.11", - "gaxios": "^6.1.1", - "gcp-metadata": "^6.1.0", - "gtoken": "^7.0.0", - "jws": "^4.0.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/graphemer": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", - "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true, - "license": "MIT" - }, - "node_modules/gtoken": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/gtoken/-/gtoken-7.1.0.tgz", - "integrity": "sha512-pCcEwRi+TKpMlxAQObHDQ56KawURgyAf6jtIY046fJ5tIv3zDe/LEIubckAO8fj6JnAxLdmWkUfNyulQ2iKdEw==", - "license": "MIT", - "dependencies": { - "gaxios": "^6.0.0", - "jws": "^4.0.0" - }, - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/https-proxy-agent": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", - "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", - "license": "MIT", - "dependencies": { - "agent-base": "^7.0.2", - "debug": "4" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/import-fresh": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", - "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true, - "license": "ISC" - }, - "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/json-bigint": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-bigint/-/json-bigint-1.0.0.tgz", - "integrity": "sha512-SiPv/8VpZuWbvLSMtTDU8hEfrZWg/mH/nV/b4o0CYbSxu1UIQPLdwKOCIyLQX+VIPO5vrLX3i8qtqFyhdPSUSQ==", - "license": "MIT", - "dependencies": { - "bignumber.js": "^9.0.0" - } - }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, - "node_modules/json-stable-stringify-without-jsonify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/jwa": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/jwa/-/jwa-2.0.0.tgz", - "integrity": "sha512-jrZ2Qx916EA+fq9cEAeCROWPTfCwi1IVHqT2tapuqLEVVDKFDENFw1oL+MwrTvH6msKxsd1YTDVw6uKEcsrLEA==", - "license": "MIT", - "dependencies": { - "buffer-equal-constant-time": "1.0.1", - "ecdsa-sig-formatter": "1.0.11", - "safe-buffer": "^5.0.1" - } - }, - "node_modules/jws": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jws/-/jws-4.0.0.tgz", - "integrity": "sha512-KDncfTmOZoOMTFG4mBlG0qUIOlc03fmzH+ru6RgYVZhPkyiy/92Owlt/8UEN+a4TXR1FQetfIpJE8ApdvdVxTg==", - "license": "MIT", - "dependencies": { - "jwa": "^2.0.0", - "safe-buffer": "^5.0.1" - } - }, - "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "dev": true, - "license": "MIT", - "dependencies": { - "json-buffer": "3.0.1" - } - }, - "node_modules/levn": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1", - "type-check": "~0.4.0" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^5.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/lodash.merge": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", - "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "license": "MIT" - }, - "node_modules/natural-compare": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true, - "license": "MIT" - }, - "node_modules/node-fetch": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", - "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", - "license": "MIT", - "dependencies": { - "whatwg-url": "^5.0.0" - }, - "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } - } - }, - "node_modules/optionator": { - "version": "0.9.4", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", - "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "deep-is": "^0.1.3", - "fast-levenshtein": "^2.0.6", - "levn": "^0.4.1", - "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.5" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "yocto-queue": "^0.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "dev": true, - "license": "MIT", - "dependencies": { - "callsites": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/prelude-ls": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", - "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/punycode": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dev": true, - "license": "MIT", - "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" - } - }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "queue-microtask": "^1.2.2" - } - }, - "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", - "license": "MIT" - }, - "node_modules/type-check": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", - "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", - "dev": true, - "license": "MIT", - "dependencies": { - "prelude-ls": "^1.2.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/typescript": { - "version": "5.5.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz", - "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==", - "dev": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/typescript-eslint": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.27.0.tgz", - "integrity": "sha512-ZZ/8+Y0rRUMuW1gJaPtLWe4ryHbsPLzzibk5Sq+IFa2aOH1Vo0gPr1fbA6pOnzBke7zC2Da4w8AyCgxKXo3lqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/eslint-plugin": "8.27.0", - "@typescript-eslint/parser": "8.27.0", - "@typescript-eslint/utils": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.27.0.tgz", - "integrity": "sha512-4henw4zkePi5p252c8ncBLzLce52SEUz2Ebj8faDnuUXz2UuHEONYcJ+G0oaCF+bYCWVZtrGzq3FD7YXetmnSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/type-utils": "8.27.0", - "@typescript-eslint/utils": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "graphemer": "^1.4.0", - "ignore": "^5.3.1", - "natural-compare": "^1.4.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/parser": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.27.0.tgz", - "integrity": "sha512-XGwIabPallYipmcOk45DpsBSgLC64A0yvdAkrwEzwZ2viqGqRUJ8eEYoPz0CWnutgAFbNMPdsGGvzjSmcWVlEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/scope-manager": "8.27.0", - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/typescript-estree": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0", - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/scope-manager": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.27.0.tgz", - "integrity": "sha512-8oI9GwPMQmBryaaxG1tOZdxXVeMDte6NyJA4i7/TWa4fBwgnAXYlIQP+uYOeqAaLJ2JRxlG9CAyL+C+YE9Xknw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/types": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.27.0.tgz", - "integrity": "sha512-/6cp9yL72yUHAYq9g6DsAU+vVfvQmd1a8KyA81uvfDE21O2DwQ/qxlM4AR8TSdAu+kJLBDrEHKC5/W2/nxsY0A==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/typescript-estree": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.27.0.tgz", - "integrity": "sha512-BnKq8cqPVoMw71O38a1tEb6iebEgGA80icSxW7g+kndx0o6ot6696HjG7NdgfuAVmVEtwXUr3L8R9ZuVjoQL6A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "@typescript-eslint/visitor-keys": "8.27.0", - "debug": "^4.3.4", - "fast-glob": "^3.3.2", - "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^2.0.1" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - }, - "peerDependencies": { - "typescript": ">=4.8.4 <5.9.0" - } - }, - "node_modules/typescript-eslint/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.27.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.27.0.tgz", - "integrity": "sha512-WsXQwMkILJvffP6z4U3FYJPlbf/j07HIxmDjZpbNvBJkMfvwXj5ACRkkHwBDvLBbDbtX5TdU64/rcvKJ/vuInQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@typescript-eslint/types": "8.27.0", - "eslint-visitor-keys": "^4.2.0" - }, - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/typescript-eslint" - } - }, - "node_modules/typescript-eslint/node_modules/eslint-visitor-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.2.0.tgz", - "integrity": "sha512-UyLnSehNt62FFhSwjZlHmeokpRK59rcz29j+F1/aDgbkbRTk7wIc9XzdoasMUbRNKDM0qQt/+BJ4BrpFeABemw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" - }, - "funding": { - "url": "https://opencollective.com/eslint" - } - }, - "node_modules/typescript-eslint/node_modules/ts-api-utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", - "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.12" - }, - "peerDependencies": { - "typescript": ">=4.8.4" - } - }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "punycode": "^2.1.0" - } - }, - "node_modules/uuid": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-10.0.0.tgz", - "integrity": "sha512-8XkAphELsDnEGrDxUOHB3RGvXz6TeuYSGEZBOjtTtPm2lwhGBjLgOzLHB63IUWfBpNucQjND6d3AOudO+H3RWQ==", - "funding": [ - "https://github.com/sponsors/broofa", - "https://github.com/sponsors/ctavan" - ], - "license": "MIT", - "bin": { - "uuid": "dist/bin/uuid" - } - }, - "node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", - "license": "BSD-2-Clause" - }, - "node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "license": "MIT", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/word-wrap": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", - "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/yocto-queue": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/zod": { - "version": "3.23.8", - "resolved": "https://registry.npmjs.org/zod/-/zod-3.23.8.tgz", - "integrity": "sha512-XBx9AXhXktjUqnepgTiE5flcKIYWi/rme0Eaj+5Y0lftuGBq+jyRu/md4WnuxqgP1ubdpNCsYEYPxrzVHD8d6g==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/colinhacks" - } - } - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/package.json b/examples/sdks/mistral-typescript/packages/mistralai-gcp/package.json deleted file mode 100644 index 61cc55ec9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/package.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "name": "@mistralai/mistralai-gcp", - "version": "1.5.0", - "author": "Speakeasy", - "main": "./index.js", - "sideEffects": false, - "repository": { - "type": "git", - "url": "https://github.com/mistralai/client-ts.git", - "directory": "packages/mistralai-gcp" - }, - "scripts": { - "lint": "eslint --cache --max-warnings=0 src", - "build": "tsc", - "prepublishOnly": "npm run build" - }, - "peerDependencies": { - "zod": ">= 3" - }, - "devDependencies": { - "@eslint/js": "^9.19.0", - "eslint": "^9.19.0", - "globals": "^15.14.0", - "typescript": "^5.4.5", - "typescript-eslint": "^8.22.0", - "zod": "^3.23.4" - }, - "dependencies": { - "google-auth-library": "^9.11.0" - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/core.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/core.ts deleted file mode 100644 index a2cda6dda..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/core.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "./lib/sdks.js"; - -/** - * A minimal client to use when calling standalone SDK functions. Typically, an - * instance of this class would be instantiated once at the start of an - * application and passed around through some dependency injection mechanism to - * parts of an application that need to make SDK calls. - */ -export class MistralGoogleCloudCore extends ClientSDK {} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatComplete.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatComplete.ts deleted file mode 100644 index 6f565e803..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatComplete.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralGoogleCloudCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Chat Completion - */ -export function chatComplete( - client: MistralGoogleCloudCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralGoogleCloudCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ChatCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/rawPredict")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.json(200, components.ChatCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatStream.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatStream.ts deleted file mode 100644 index 4af0db730..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/chatStream.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralGoogleCloudCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function chatStream( - client: MistralGoogleCloudCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralGoogleCloudCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.ChatCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/streamRawPredict")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream({ - stream, - decoder(rawEvent) { - const schema = components.CompletionEvent$inboundSchema; - return schema.parse(rawEvent); - }, - }); - }), - { sseSentinel: "[DONE]" }, - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimComplete.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimComplete.ts deleted file mode 100644 index 97ba61731..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimComplete.ts +++ /dev/null @@ -1,163 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralGoogleCloudCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Fim Completion - * - * @remarks - * FIM completion. - */ -export function fimComplete( - client: MistralGoogleCloudCore, - request: components.FIMCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralGoogleCloudCore, - request: components.FIMCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.FIMCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/rawPredict#fim")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "fim_completion_v1_fim_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.json(200, components.FIMCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimStream.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimStream.ts deleted file mode 100644 index 435fc95ae..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/funcs/fimStream.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralGoogleCloudCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function fimStream( - client: MistralGoogleCloudCore, - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralGoogleCloudCore, - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.FIMCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/streamRawPredict#fim")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_fim", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | SDKError - | SDKValidationError - | UnexpectedClientError - | InvalidRequestError - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream({ - stream, - decoder(rawEvent) { - const schema = components.CompletionEvent$inboundSchema; - return schema.parse(rawEvent); - }, - }); - }), - { sseSentinel: "[DONE]" }, - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/custom_user_agent.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/custom_user_agent.ts deleted file mode 100644 index 854b62456..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/custom_user_agent.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { BeforeRequestContext, BeforeRequestHook, Awaitable } from './types'; - - -export class CustomUserAgentHook implements BeforeRequestHook { - beforeRequest(_: BeforeRequestContext, request: Request): Awaitable { - const userAgent = request.headers.get('user-agent') as string; - const version = userAgent.split(' ')[1]; - request.headers.set('user-agent', `mistral-gcp-client-typescript/${version}`); - return request; - } -} \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/hooks.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/hooks.ts deleted file mode 100644 index d34c88497..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/hooks.ts +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { RequestInput } from "../lib/http.js"; -import { - AfterErrorContext, - AfterErrorHook, - AfterSuccessContext, - AfterSuccessHook, - BeforeCreateRequestContext, - BeforeCreateRequestHook, - BeforeRequestContext, - BeforeRequestHook, - Hook, - Hooks, - SDKInitHook, - SDKInitOptions, -} from "./types.js"; - -import { initHooks } from "./registration.js"; - -export class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[] = []; - beforeCreateRequestHooks: BeforeCreateRequestHook[] = []; - beforeRequestHooks: BeforeRequestHook[] = []; - afterSuccessHooks: AfterSuccessHook[] = []; - afterErrorHooks: AfterErrorHook[] = []; - - constructor() { - const presetHooks: Array = []; - - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - initHooks(this); - } - - registerSDKInitHook(hook: SDKInitHook) { - this.sdkInitHooks.push(hook); - } - - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) { - this.beforeCreateRequestHooks.push(hook); - } - - registerBeforeRequestHook(hook: BeforeRequestHook) { - this.beforeRequestHooks.push(hook); - } - - registerAfterSuccessHook(hook: AfterSuccessHook) { - this.afterSuccessHooks.push(hook); - } - - registerAfterErrorHook(hook: AfterErrorHook) { - this.afterErrorHooks.push(hook); - } - - sdkInit(opts: SDKInitOptions): SDKInitOptions { - return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts); - } - - beforeCreateRequest( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ): RequestInput { - let inp = input; - - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - - return inp; - } - - async beforeRequest( - hookCtx: BeforeRequestContext, - request: Request, - ): Promise { - let req = request; - - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - - return req; - } - - async afterSuccess( - hookCtx: AfterSuccessContext, - response: Response, - ): Promise { - let res = response; - - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - - return res; - } - - async afterError( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ): Promise<{ response: Response | null; error: unknown }> { - let res = response; - let err = error; - - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - - return { response: res, error: err }; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/index.ts deleted file mode 100644 index f60ec7acd..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./hooks.js"; -export * from "./types.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/registration.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/registration.ts deleted file mode 100644 index de4ddc05a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/registration.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { Hooks } from "./types.js"; -import { CustomUserAgentHook } from "./custom_user_agent.js"; - -/* - * This file is only ever generated once on the first generation and then is free to be modified. - * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them - * in this file or in separate files in the hooks folder. - */ - -export function initHooks(hooks: Hooks) { - // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook - // with an instance of a hook that implements that specific Hook interface - // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance - const customUserAgentHook = new CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook) -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/types.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/types.ts deleted file mode 100644 index f34898c0a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/hooks/types.ts +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { HTTPClient, RequestInput } from "../lib/http.js"; -import { RetryConfig } from "../lib/retries.js"; -import { SecurityState } from "../lib/security.js"; - -export type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes?: string[]; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; -}; - -export type Awaitable = T | Promise; - -export type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export type BeforeCreateRequestContext = HookContext & {}; -export type BeforeRequestContext = HookContext & {}; -export type AfterSuccessContext = HookContext & {}; -export type AfterErrorContext = HookContext & {}; - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -export interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -export interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: ( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ) => RequestInput; -} - -export interface BeforeRequestHook { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: ( - hookCtx: BeforeRequestContext, - request: Request, - ) => Awaitable; -} - -export interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: ( - hookCtx: AfterSuccessContext, - response: Response, - ) => Awaitable; -} - -export interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: ( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ) => Awaitable<{ - response: Response | null; - error: unknown; - }>; -} - -export interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export type Hook = - | SDKInitHook - | BeforeCreateRequestHook - | BeforeRequestHook - | AfterSuccessHook - | AfterErrorHook; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/index.ts deleted file mode 100644 index 5ddc765ed..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/index.ts +++ /dev/null @@ -1,7 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./lib/config.js"; -export * as files from "./lib/files.js"; -export * from "./sdk/sdk.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/base64.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/base64.ts deleted file mode 100644 index c2d5b3898..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/base64.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function bytesToBase64(u8arr: Uint8Array): string { - return btoa(String.fromCodePoint(...u8arr)); -} - -export function bytesFromBase64(encoded: string): Uint8Array { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); -} - -export function stringToBytes(str: string): Uint8Array { - return new TextEncoder().encode(str); -} - -export function stringFromBytes(u8arr: Uint8Array): string { - return new TextDecoder().decode(u8arr); -} - -export function stringToBase64(str: string): string { - return bytesToBase64(stringToBytes(str)); -} - -export function stringFromBase64(b64str: string): string { - return stringFromBytes(bytesFromBase64(b64str)); -} - -export const zodOutbound = z - .instanceof(Uint8Array) - .or(z.string().transform(stringToBytes)); - -export const zodInbound = z - .instanceof(Uint8Array) - .or(z.string().transform(bytesFromBase64)); diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/config.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/config.ts deleted file mode 100644 index 78896fdab..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/config.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { HTTPClient } from "./http.js"; -import { Logger } from "./logger.js"; -import { RetryConfig } from "./retries.js"; -import { Params, pathToFunc } from "./url.js"; - -/** - * EU Production server - */ -export const ServerEu = "eu"; -/** - * Contains the list of servers available to the SDK - */ -export const ServerList = { - [ServerEu]: "https://api.mistral.ai", -} as const; - -export type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -export function serverURLFromOptions(options: SDKOptions): URL | null { - let serverURL = options.serverURL; - - const params: Params = {}; - - if (!serverURL) { - const server = options.server ?? ServerEu; - serverURL = ServerList[server] || ""; - } - - const u = pathToFunc(serverURL)(params); - return new URL(u); -} - -export const SDK_METADATA = { - language: "typescript", - openapiDocVersion: "0.0.2", - sdkVersion: "1.5.0", - genVersion: "2.548.6", - userAgent: - "speakeasy-sdk/typescript 1.5.0 2.548.6 0.0.2 @mistralai/mistralai-gcp", -} as const; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/dlv.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/dlv.ts deleted file mode 100644 index e81091f5e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/dlv.ts +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) 2024 Jason Miller (http://jasonformat.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -/** - * @param obj The object to walk - * @param key The key path to walk the object with - * @param def A default value to return if the result is undefined - * - * @example - * dlv(obj, "a.b.c.d") - * @example - * dlv(object, ["a", "b", "c", "d"]) - * @example - * dlv(object, "foo.bar.baz", "Hello, default value!") - */ -export function dlv( - obj: any, - key: string | string[], - def?: T, - p?: number, - undef?: never, -): T | undefined { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/encodings.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/encodings.ts deleted file mode 100644 index 25c9dcba3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/encodings.ts +++ /dev/null @@ -1,483 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { bytesToBase64 } from "./base64.js"; -import { isPlainObject } from "./is-plain-object.js"; - -export class EncodingError extends Error { - constructor(message: string) { - super(message); - this.name = "EncodingError"; - } -} - -export function encodeMatrix( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - // trim trailing '=' if value was empty - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - - // If we end up with the nothing then skip forward - if (!tmp) { - return; - } - - out += `;${tmp}`; - }); - - return out; -} - -export function encodeLabel( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let encValue: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = - options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - - out += encValue == null ? "" : `.${encValue}`; - }); - - return out; -} - -type FormEncoder = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -) => string | undefined; - -function formEncoder(sep: string): FormEncoder { - return ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, - ) => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - const encodedSep = encodeString(sep); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if (isPlainObject(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); - }; -} - -export const encodeForm = formEncoder(","); -export const encodeSpaceDelimited = formEncoder(" "); -export const encodePipeDelimited = formEncoder("|"); - -export function encodeBodyForm( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if (isPlainObject(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); -} - -export function encodeDeepObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - if (!isPlainObject(value)) { - throw new EncodingError( - `Value of parameter '${key}' which uses deepObject encoding must be an object or null`, - ); - } - - return encodeDeepObjectObject(key, value, options); -} - -export function encodeDeepObjectObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - let out = ""; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - if (!isPlainObject(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - - const pk = `${key}[${ck}]`; - - if (isPlainObject(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - - out += objOut == null ? "" : `&${objOut}`; - - return; - } - - const pairs: unknown[] = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - - out += encoded == null ? "" : `&${encoded}`; - }); - - return out.slice(1); -} - -export function encodeJSON( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - if (typeof value === "undefined") { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; -} - -export const encodeSimple = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && isPlainObject(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - - out += tmp ? `,${tmp}` : ""; - }); - - return out.slice(1); -}; - -function explode(key: string, value: unknown): [string, unknown][] { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if (isPlainObject(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } -} - -function serializeValue(value: unknown): string { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - - return `${value}`; -} - -function jsonReplacer(_: string, value: unknown): unknown { - if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else { - return value; - } -} - -function mapDefined(inp: T[], mapper: (v: T) => R): R[] | null { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - - const m = mapper(v); - if (m == null) { - return acc; - } - - acc.push(m); - - return acc; - }, []); - - return res.length ? res : null; -} - -function mapDefinedEntries( - inp: Iterable<[K, V]>, - mapper: (v: [K, V]) => R, -): R[] | null { - const acc: R[] = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - - const m = mapper([k, v]); - if (m == null) { - continue; - } - - acc.push(m); - } - - return acc.length ? acc : null; -} - -export function queryJoin(...args: (string | undefined)[]): string { - return args.filter(Boolean).join("&"); -} - -type QueryEncoderOptions = { - explode?: boolean; - charEncoding?: "percent" | "none"; -}; - -type QueryEncoder = ( - key: string, - value: unknown, - options?: QueryEncoderOptions, -) => string | undefined; - -type BulkQueryEncoder = ( - values: Record, - options?: QueryEncoderOptions, -) => string; - -export function queryEncoder(f: QueryEncoder): BulkQueryEncoder { - const bulkEncode = function ( - values: Record, - options?: QueryEncoderOptions, - ): string { - const opts: QueryEncoderOptions = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent", - }; - - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - - return bulkEncode; -} - -export const encodeJSONQuery = queryEncoder(encodeJSON); -export const encodeFormQuery = queryEncoder(encodeForm); -export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited); -export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited); -export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - -export function appendForm( - fd: FormData, - key: string, - value: unknown, - fileName?: string, -): void { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/event-streams.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/event-streams.ts deleted file mode 100644 index 2ab114f24..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/event-streams.ts +++ /dev/null @@ -1,264 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - retry?: number | undefined; - id?: string | undefined; -}; -const LF = 0x0a; -const CR = 0x0d; -const NEWLINE_CHARS = new Set([LF, CR]); -const MESSAGE_BOUNDARIES = [ - new Uint8Array([CR, LF, CR, LF]), - new Uint8Array([CR, CR]), - new Uint8Array([LF, LF]), -]; - -export class EventStream> { - private readonly stream: ReadableStream; - private readonly decoder: (rawEvent: ServerEvent) => Event; - - constructor(init: { - stream: ReadableStream; - decoder: (rawEvent: ServerEvent) => Event; - }) { - this.stream = init.stream; - this.decoder = init.decoder; - } - - async *[Symbol.asyncIterator](): AsyncGenerator { - const reader = this.stream.getReader(); - let buffer = new Uint8Array([]); - let position = 0; - - try { - while (true) { - const { done, value } = await reader.read(); - if (done) { - break; - } - - const newBuffer = new Uint8Array(buffer.length + value.length); - newBuffer.set(buffer); - newBuffer.set(value, buffer.length); - buffer = newBuffer; - - for (let i = position; i < buffer.length; i++) { - const boundary = findBoundary(buffer, i); - if (boundary == null) { - continue; - } - - const chunk = buffer.slice(position, i); - position = i + boundary.length; - const event = parseEvent(chunk, this.decoder); - if (event != null) { - yield event; - } - } - - if (position > 0) { - buffer = buffer.slice(position); - position = 0; - } - } - - if (buffer.length > 0) { - const event = parseEvent(buffer, this.decoder); - if (event != null) { - yield event; - } - } - } catch (e: unknown) { - if (e instanceof Error && e.name === "AbortError") { - return; - } - - throw e; - } finally { - reader.releaseLock(); - } - } -} - -function findBoundary(buffer: Uint8Array, start: number): Uint8Array | null { - const char1 = buffer[start]; - const char2 = buffer[start + 1]; - - // Don't bother checking if the first two characters are not new line - // characters. - if ( - char1 == null - || char2 == null - || !NEWLINE_CHARS.has(char1) - || !NEWLINE_CHARS.has(char2) - ) { - return null; - } - - for (const s of MESSAGE_BOUNDARIES) { - const seq = peekSequence(start, buffer, s); - if (seq != null) { - return seq; - } - } - - return null; -} - -function peekSequence( - position: number, - buffer: Uint8Array, - sequence: Uint8Array, -): Uint8Array | null { - if (sequence.length > buffer.length - position) { - return null; - } - - for (let i = 0; i < sequence.length; i++) { - if (buffer[position + i] !== sequence[i]) { - return null; - } - } - - return sequence; -} - -function parseEvent>( - chunk: Uint8Array, - decoder: (rawEvent: ServerEvent) => Event, -) { - if (!chunk.length) { - return null; - } - - const td = new TextDecoder(); - const raw = td.decode(chunk); - const lines = raw.split(/\r?\n|\r/g); - let publish = false; - const rawEvent: ServerEvent = {}; - - for (const line of lines) { - if (!line) { - continue; - } - - const delim = line.indexOf(":"); - // Lines starting with a colon are ignored. - if (delim === 0) { - continue; - } - - const field = delim > 0 ? line.substring(0, delim) : ""; - let value = delim > 0 ? line.substring(delim + 1) : ""; - if (value.charAt(0) === " ") { - value = value.substring(1); - } - - switch (field) { - case "event": { - publish = true; - rawEvent.event = value; - break; - } - case "data": { - publish = true; - rawEvent.data ??= ""; - rawEvent.data += value + "\n"; - break; - } - case "id": { - publish = true; - rawEvent.id = value; - break; - } - case "retry": { - const r = parseInt(value, 10); - if (!Number.isNaN(r)) { - publish = true; - rawEvent.retry = r; - } - break; - } - } - } - - if (!publish) { - return null; - } - - if (rawEvent.data != null) { - rawEvent.data = rawEvent.data.slice(0, -1); - } - - return decoder(rawEvent); -} - -export function discardSentinel( - stream: ReadableStream, - sentinel: string, -): ReadableStream { - return new ReadableStream({ - async start(controller) { - let buffer = new Uint8Array([]); - let position = 0; - let done = false; - let discard = false; - const rdr = stream.getReader(); - try { - while (!done) { - const result = await rdr.read(); - const value = result.value; - done = done || result.done; - // We keep consuming from the source to its completion so it can - // flush all its contents and release resources. - if (discard) { - continue; - } - if (typeof value === "undefined") { - continue; - } - - const newBuffer = new Uint8Array(buffer.length + value.length); - newBuffer.set(buffer); - newBuffer.set(value, buffer.length); - buffer = newBuffer; - - for (let i = position; i < buffer.length; i++) { - const boundary = findBoundary(buffer, i); - if (boundary == null) { - continue; - } - - const start = position; - const chunk = buffer.slice(start, i); - position = i + boundary.length; - const event = parseEvent(chunk, id); - if (event?.data === sentinel) { - controller.enqueue(buffer.slice(0, start)); - discard = true; - } else { - controller.enqueue(buffer.slice(0, position)); - buffer = buffer.slice(position); - position = 0; - } - } - } - } catch (e) { - controller.error(e); - } finally { - // If the source stream terminates, flush its contents and terminate. - // If the sentinel event was found, flush everything up to its start. - controller.close(); - rdr.releaseLock(); - } - }, - }); -} - -function id(v: T): T { - return v; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/files.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/files.ts deleted file mode 100644 index 59d15f09b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/files.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -export async function readableStreamToArrayBuffer( - readable: ReadableStream, -): Promise { - const reader = readable.getReader(); - const chunks: Uint8Array[] = []; - - let totalLength = 0; - let done = false; - - while (!done) { - const { value, done: doneReading } = await reader.read(); - - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - - return concatenatedChunks.buffer as ArrayBuffer; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/http.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/http.ts deleted file mode 100644 index 13cf1fd78..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/http.ts +++ /dev/null @@ -1,323 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type Fetcher = ( - input: RequestInfo | URL, - init?: RequestInit, -) => Promise; - -export type Awaitable = T | Promise; - -const DEFAULT_FETCHER: Fetcher = (input, init) => { - // If input is a Request and init is undefined, Bun will discard the method, - // headers, body and other options that were set on the request object. - // Node.js and browers would ignore an undefined init value. This check is - // therefore needed for interop with Bun. - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } -}; - -export type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -export interface HTTPClientOptions { - fetcher?: Fetcher; -} - -export type BeforeRequestHook = (req: Request) => Awaitable; -export type RequestErrorHook = (err: unknown, req: Request) => Awaitable; -export type ResponseHook = (res: Response, req: Request) => Awaitable; - -export class HTTPClient { - private fetcher: Fetcher; - private requestHooks: BeforeRequestHook[] = []; - private requestErrorHooks: RequestErrorHook[] = []; - private responseHooks: ResponseHook[] = []; - - constructor(private options: HTTPClientOptions = {}) { - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - - async request(request: Request): Promise { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - - try { - const res = await this.fetcher(req); - - for (const hook of this.responseHooks) { - await hook(res, req); - } - - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - - throw err; - } - } - - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - addHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - removeHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ): this { - let target: unknown[]; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - - return this; - } - - clone(): HTTPClient { - const child = new HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - - return child; - } -} - -export type StatusCodePredicate = number | string | (number | string)[]; - -// A semicolon surrounded by optional whitespace characters is used to separate -// segments in a media type string. -const mediaParamSeparator = /\s*;\s*/g; - -export function matchContentType(response: Response, pattern: string): boolean { - // `*` is a special case which means anything is acceptable. - if (pattern === "*") { - return true; - } - - let contentType = - response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - - if (wantType.split("/").length !== 2) { - return false; - } - - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - - if ( - wantType !== "*/*" && - gotType !== wantType && - `${type}/*` !== wantType && - `*/${subtype}` !== wantType - ) { - return false; - } - - if (gotParams.length < wantParams.length) { - return false; - } - - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - - return true; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -export function matchStatusCode( - response: Response, - codes: StatusCodePredicate, -): boolean { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - - return expectedCodes.some((ec) => { - const code = `${ec}`; - - if (code === "default") { - return true; - } - - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -export function matchResponse( - response: Response, - code: StatusCodePredicate, - contentTypePattern: string, -): boolean { - return ( - matchStatusCode(response, code) && - matchContentType(response, contentTypePattern) - ); -} - -/** - * Uses various heurisitics to determine if an error is a connection error. - */ -export function isConnectionError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Covers fetch in Deno as well - const isBrowserErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("failed to fetch"); - - const isNodeErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("fetch failed"); - - const isBunErr = "name" in err && err.name === "ConnectionError"; - - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnreset"; - - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; -} - -/** - * Uses various heurisitics to determine if an error is a timeout error. - */ -export function isTimeoutError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} - -/** - * Uses various heurisitics to determine if an error is a abort error. - */ -export function isAbortError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/is-plain-object.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/is-plain-object.ts deleted file mode 100644 index 61070d3d7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/is-plain-object.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) Sindre Sorhus (https://sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -// Taken from https://github.com/sindresorhus/is-plain-obj/blob/97f38e8836f86a642cce98fc6ab3058bc36df181/index.js - -export function isPlainObject(value: unknown): value is object { - if (typeof value !== "object" || value === null) { - return false; - } - - const prototype = Object.getPrototypeOf(value); - return ( - (prototype === null || - prototype === Object.prototype || - Object.getPrototypeOf(prototype) === null) && - !(Symbol.toStringTag in value) && - !(Symbol.iterator in value) - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/logger.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/logger.ts deleted file mode 100644 index d181f2937..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/logger.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/matchers.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/matchers.ts deleted file mode 100644 index f8ec5c3c0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/matchers.ts +++ /dev/null @@ -1,325 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKError } from "../models/errors/sdkerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { Result } from "../types/fp.js"; -import { discardSentinel } from "./event-streams.js"; -import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js"; -import { isPlainObject } from "./is-plain-object.js"; -import { safeParse } from "./schemas.js"; - -export type Encoding = - | "json" - | "text" - | "bytes" - | "stream" - | "sse" - | "nil" - | "fail"; - -const DEFAULT_CONTENT_TYPES: Record = { - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*", -}; - -type Schema = { parse(raw: unknown): T }; - -type MatchOptions = { - ctype?: string; - hdrs?: boolean; - key?: string; - sseSentinel?: string; -}; - -export type ValueMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; -}; - -export type ErrorMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; - err: true; -}; - -export type FailMatcher = { - enc: "fail"; - codes: StatusCodePredicate; -}; - -export type Matcher = ValueMatcher | ErrorMatcher | FailMatcher; - -export function jsonErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "json", codes, schema }; -} -export function json( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "json", codes, schema }; -} - -export function textErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "text", codes, schema }; -} -export function text( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "text", codes, schema }; -} - -export function bytesErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "bytes", codes, schema }; -} -export function bytes( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "bytes", codes, schema }; -} - -export function streamErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "stream", codes, schema }; -} -export function stream( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "stream", codes, schema }; -} - -export function sseErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "sse", codes, schema }; -} -export function sse( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "sse", codes, schema }; -} - -export function nilErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "nil", codes, schema }; -} -export function nil( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "nil", codes, schema }; -} - -export function fail(codes: StatusCodePredicate): FailMatcher { - return { enc: "fail", codes }; -} - -export type MatchedValue = Matchers extends Matcher[] - ? T - : never; -export type MatchedError = Matchers extends Matcher[] - ? E - : never; -export type MatchFunc = ( - response: Response, - options?: { resultKey?: string; extraFields?: Record }, -) => Promise<[result: Result, raw: unknown]>; - -export function match( - ...matchers: Array> -): MatchFunc { - return async function matchFunc( - response: Response, - options?: { resultKey?: string; extraFields?: Record }, - ): Promise< - [result: Result, raw: unknown] - > { - let raw: unknown; - let matcher: Matcher | undefined; - for (const match of matchers) { - const { codes } = match; - const ctpattern = "ctype" in match - ? match.ctype - : DEFAULT_CONTENT_TYPES[match.enc]; - if (ctpattern && matchResponse(response, codes, ctpattern)) { - matcher = match; - break; - } else if (!ctpattern && matchStatusCode(response, codes)) { - matcher = match; - break; - } - } - - if (!matcher) { - const responseBody = await response.text(); - return [{ - ok: false, - error: new SDKError( - "Unexpected API response status or content-type", - response, - responseBody, - ), - }, responseBody]; - } - - const encoding = matcher.enc; - switch (encoding) { - case "json": - raw = await response.json(); - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - raw = await response.text(); - break; - case "sse": - raw = response.body && matcher.sseSentinel - ? discardSentinel(response.body, matcher.sseSentinel) - : response.body; - break; - case "nil": - raw = await discardResponseBody(response); - break; - case "fail": - raw = await response.text(); - break; - default: - encoding satisfies never; - throw new Error(`Unsupported response type: ${encoding}`); - } - - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new SDKError( - "API error occurred", - response, - typeof raw === "string" ? raw : "", - ), - }, raw]; - } - - const resultKey = matcher.key || options?.resultKey; - let data: unknown; - - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - [resultKey]: raw, - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - }; - } else { - data = raw; - } - - if ("err" in matcher) { - const result = safeParse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - ); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - ), - raw, - ]; - } - }; -} - -const headerValRE = /, */; -/** - * Iterates over a Headers object and returns an object with all the header - * entries. Values are represented as an array to account for repeated headers. - */ -export function unpackHeaders(headers: Headers): Record { - const out: Record = {}; - - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - - return out; -} - -/** - * Discards the response body to free up resources. - * - * To learn why this is need, see the undici docs: - * https://undici.nodejs.org/#/?id=garbage-collection - */ -export async function discardResponseBody(res: Response) { - const reader = res.body?.getReader(); - if (reader == null) { - return; - } - - try { - let done = false; - while (!done) { - const res = await reader.read(); - done = res.done; - } - } finally { - reader.releaseLock(); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/primitives.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/primitives.ts deleted file mode 100644 index d21f1dc49..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/primitives.ts +++ /dev/null @@ -1,150 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -class InvariantError extends Error { - constructor(message: string) { - super(message); - this.name = "InvariantError"; - } -} - -export function invariant( - condition: unknown, - message: string, -): asserts condition { - if (!condition) { - throw new InvariantError(message); - } -} - -export type ExactPartial = { - [P in keyof T]?: T[P] | undefined; -}; - -export type Remap = { - [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */ - ? Mapping[k] - : Mapping[k] extends null /* if the mapping is to `null` then drop the key */ - ? never - : k /* otherwise keep the key as-is */]: Inp[k]; -}; - -/** - * Converts or omits an object's keys according to a mapping. - * - * @param inp An object whose keys will be remapped - * @param mappings A mapping of original keys to new keys. If a key is not present in the mapping, it will be left as is. If a key is mapped to `null`, it will be removed in the resulting object. - * @returns A new object with keys remapped or omitted according to the mappings - */ -export function remap< - Inp extends Record, - const Mapping extends { [k in keyof Inp]?: string | null }, ->(inp: Inp, mappings: Mapping): Remap { - let out: any = {}; - - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - - return out; -} - -export function combineSignals( - ...signals: Array -): AbortSignal | null { - const filtered: AbortSignal[] = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } -} - -export function abortSignalAny(signals: AbortSignal[]): AbortSignal { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - - if (signals.length === 1) { - return signals[0] || controller.signal; - } - - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - - function abort(this: AbortSignal) { - controller.abort(this.reason); - clean(); - } - - const signalRefs: WeakRef[] = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - - return result; -} - -export function compactMap( - values: Record, -): Record { - const out: Record = {}; - - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - - return out; -} - -export function allRequired>( - v: V, -): - | { - [K in keyof V]: NonNullable; - } - | undefined { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - - return v as ReturnType>; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/retries.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/retries.ts deleted file mode 100644 index e3ce9aba7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/retries.ts +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { isConnectionError, isTimeoutError } from "./http.js"; - -export type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -const defaultBackoff: BackoffStrategy = { - initialInterval: 500, - maxInterval: 60000, - exponent: 1.5, - maxElapsedTime: 3600000, -}; - -export type RetryConfig = - | { strategy: "none" } - | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; - }; - -/** - * PermanentError is an error that is not recoverable. Throwing this error will - * cause a retry loop to terminate. - */ -export class PermanentError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - - constructor(message: string, options?: { cause?: unknown }) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - - super(msg, options); - this.name = "PermanentError"; - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - - Object.setPrototypeOf(this, PermanentError.prototype); - } -} - -/** - * TemporaryError is an error is used to signal that an HTTP request can be - * retried as part of a retry loop. If retry attempts are exhausted and this - * error is thrown, the response will be returned to the caller. - */ -export class TemporaryError extends Error { - response: Response; - - constructor(message: string, response: Response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - - Object.setPrototypeOf(this, TemporaryError.prototype); - } -} - -export async function retry( - fetchFn: () => Promise, - options: { - config: RetryConfig; - statusCodes: string[]; - }, -): Promise { - switch (options.config.strategy) { - case "backoff": - return retryBackoff( - wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors, - }), - options.config.backoff ?? defaultBackoff, - ); - default: - return await fetchFn(); - } -} - -function wrapFetcher( - fn: () => Promise, - options: { - statusCodes: string[]; - retryConnectionErrors: boolean; - }, -): () => Promise { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError( - "Response failed with retryable status code", - res, - ); - } - - return res; - } catch (err: unknown) { - if (err instanceof TemporaryError) { - throw err; - } - - if ( - options.retryConnectionErrors && - (isTimeoutError(err) || isConnectionError(err)) - ) { - throw err; - } - - throw new PermanentError("Permanent error", { cause: err }); - } - }; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -function isRetryableResponse(res: Response, statusCodes: string[]): boolean { - const actual = `${res.status}`; - - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -async function retryBackoff( - fn: () => Promise, - strategy: BackoffStrategy, -): Promise { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - - const start = Date.now(); - let x = 0; - - while (true) { - try { - const res = await fn(); - return res; - } catch (err: unknown) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - - throw err; - } - - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - - if (retryInterval <= 0) { - retryInterval = - initialInterval * Math.pow(x, exponent) + Math.random() * 1000; - } - - const d = Math.min(retryInterval, maxInterval); - - await delay(d); - x++; - } - } -} - -function retryIntervalFromResponse(res: Response): number { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1000; - } - - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - - return 0; -} - -async function delay(delay: number): Promise { - return new Promise((resolve) => setTimeout(resolve, delay)); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/schemas.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/schemas.ts deleted file mode 100644 index 0e340b7e4..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/schemas.ts +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { - output, - ZodEffects, - ZodError, - ZodObject, - ZodRawShape, - ZodTypeAny, -} from "zod"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { ERR, OK, Result } from "../types/fp.js"; - -/** - * Utility function that executes some code which may throw a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function parse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Out { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof ZodError) { - throw new SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } -} - -/** - * Utility function that executes some code which may result in a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function safeParse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Result { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR(new SDKValidationError(errorMessage, err, rawValue)); - } -} - -export function collectExtraKeys< - Shape extends ZodRawShape, - Catchall extends ZodTypeAny, - K extends string, ->( - obj: ZodObject, - extrasKey: K, - optional: boolean, -): ZodEffects< - typeof obj, - & output> - & { - [k in K]: Record>; - } -> { - return obj.transform((val) => { - const extras: Record> = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - - extras[key] = v; - delete val[key]; - } - - if (optional && Object.keys(extras).length === 0) { - return val; - } - - return { ...val, [extrasKey]: extras }; - }); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/sdks.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/sdks.ts deleted file mode 100644 index 0b0f2d63a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/sdks.ts +++ /dev/null @@ -1,391 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKHooks } from "../hooks/hooks.js"; -import { HookContext } from "../hooks/types.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { ERR, OK, Result } from "../types/fp.js"; -import { stringToBase64 } from "./base64.js"; -import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js"; -import { encodeForm } from "./encodings.js"; -import { - HTTPClient, - isAbortError, - isConnectionError, - isTimeoutError, - matchContentType, - matchStatusCode, -} from "./http.js"; -import { Logger } from "./logger.js"; -import { retry, RetryConfig } from "./retries.js"; -import { SecurityState } from "./security.js"; - -export type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -}; - -type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - timeoutMs?: number; -}; - -const gt: unknown = typeof globalThis === "undefined" ? null : globalThis; -const webWorkerLike = typeof gt === "object" - && gt != null - && "importScripts" in gt - && typeof gt["importScripts"] === "function"; -const isBrowserLike = webWorkerLike - || (typeof navigator !== "undefined" && "serviceWorker" in navigator) - || (typeof window === "object" && typeof window.document !== "undefined"); - -export class ClientSDK { - readonly #httpClient: HTTPClient; - readonly #hooks: SDKHooks; - readonly #logger?: Logger | undefined; - public readonly _baseURL: URL | null; - public readonly _options: SDKOptions & { hooks?: SDKHooks }; - - constructor(options: SDKOptions = {}) { - const opt = options as unknown; - if ( - typeof opt === "object" - && opt != null - && "hooks" in opt - && opt.hooks instanceof SDKHooks - ) { - this.#hooks = opt.hooks; - } else { - this.#hooks = new SDKHooks(); - } - this._options = { ...options, hooks: this.#hooks }; - - const url = serverURLFromOptions(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - const { baseURL, client } = this.#hooks.sdkInit({ - baseURL: url, - client: options.httpClient || new HTTPClient(), - }); - this._baseURL = baseURL; - this.#httpClient = client; - this.#logger = options.debugLogger; - } - - public _createRequest( - context: HookContext, - conf: RequestConfig, - options?: RequestOptions, - ): Result { - const { method, path, query, headers: opHeaders, security } = conf; - - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return ERR(new InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - - let finalQuery = query || ""; - - const secQuery: string[] = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = encodeForm(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - - const headers = new Headers(opHeaders); - - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = stringToBase64( - [username || "", password || ""].join(":"), - ); - headers.set("Authorization", `Basic ${encoded}`); - } - - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - - const userHeaders = new Headers(options?.fetchOptions?.headers); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - - // Only set user agent header in non-browser-like environments since CORS - // policy disallows setting it in browsers e.g. Chrome throws an error. - if (!isBrowserLike) { - headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent); - } - - let fetchOptions = options?.fetchOptions; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - if (!fetchOptions) { - fetchOptions = { signal: timeoutSignal }; - } else { - fetchOptions.signal = timeoutSignal; - } - } - - if (conf.body instanceof ReadableStream) { - if (!fetchOptions) { - fetchOptions = {}; - } - Object.assign(fetchOptions, { duplex: "half" }); - } - - let input; - try { - input = this.#hooks.beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method, - }, - }); - } catch (err: unknown) { - return ERR( - new UnexpectedClientError("Create request hook failed to execute", { - cause: err, - }), - ); - } - - return OK(new Request(input.url, input.options)); - } - - public async _do( - request: Request, - options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }, - ): Promise< - Result< - Response, - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - | UnexpectedClientError - > - > { - const { context, errorCodes } = options; - - return retry( - async () => { - const req = await this.#hooks.beforeRequest(context, request.clone()); - await logRequest(this.#logger, req).catch((e) => - this.#logger?.log("Failed to log request:", e) - ); - - let response = await this.#httpClient.request(req); - - try { - if (matchStatusCode(response, errorCodes)) { - const result = await this.#hooks.afterError( - context, - response, - null, - ); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await this.#hooks.afterSuccess(context, response); - } - } finally { - await logResponse(this.#logger, response, req) - .catch(e => this.#logger?.log("Failed to log response:", e)); - } - - return response; - }, - { config: options.retryConfig, statusCodes: options.retryCodes }, - ).then( - (r) => OK(r), - (err) => { - switch (true) { - case isAbortError(err): - return ERR( - new RequestAbortedError("Request aborted by client", { - cause: err, - }), - ); - case isTimeoutError(err): - return ERR( - new RequestTimeoutError("Request timed out", { cause: err }), - ); - case isConnectionError(err): - return ERR( - new ConnectionError("Unable to make request", { cause: err }), - ); - default: - return ERR( - new UnexpectedClientError("Unexpected HTTP client error", { - cause: err, - }), - ); - } - }, - ); - } -} - -const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/; -async function logRequest(logger: Logger | undefined, req: Request) { - if (!logger) { - return; - } - - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`> Request: ${req.method} ${req.url}`); - - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} - -async function logResponse( - logger: Logger | undefined, - res: Response, - req: Request, -) { - if (!logger) { - return; - } - - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case matchContentType(res, "application/json") - || jsonLikeContentTypeRE.test(ct): - logger.log(await res.clone().json()); - break; - case matchContentType(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case matchContentType(res, "text/*"): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/security.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/security.ts deleted file mode 100644 index 4879498dd..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/security.ts +++ /dev/null @@ -1,252 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as components from "../models/components/index.js"; -type OAuth2PasswordFlow = { - username: string; - password?: string | undefined; - clientID: string; - clientSecret?: string | undefined; - tokenURL: string; -}; - -export enum SecurityErrorCode { - Incomplete = "incomplete", - UnrecognisedSecurityType = "unrecognized_security_type", -} - -export class SecurityError extends Error { - constructor( - public code: SecurityErrorCode, - message: string, - ) { - super(message); - this.name = "SecurityError"; - } - - static incomplete(): SecurityError { - return new SecurityError( - SecurityErrorCode.Incomplete, - "Security requirements not met in order to perform the operation", - ); - } - static unrecognizedType(type: string): SecurityError { - return new SecurityError( - SecurityErrorCode.UnrecognisedSecurityType, - `Unrecognised security type: ${type}`, - ); - } -} - -export type SecurityState = { - basic: { username?: string | undefined; password?: string | undefined }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" }; -}; - -type SecurityInputBasic = { - type: "http:basic"; - value: - | { username?: string | undefined; password?: string | undefined } - | null - | undefined; -}; - -type SecurityInputBearer = { - type: "http:bearer"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputAPIKey = { - type: "apiKey:header" | "apiKey:query" | "apiKey:cookie"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOIDC = { - type: "openIdConnect"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2 = { - type: "oauth2"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2ClientCredentials = { - type: "oauth2:client_credentials"; - value: - | { clientID?: string | undefined; clientSecret?: string | undefined } - | null - | undefined; -}; - -type SecurityInputOAuth2PasswordCredentials = { - type: "oauth2:password"; - value: - | string - | null - | undefined; - fieldName: string; -}; - -type SecurityInputCustom = { - type: "http:custom"; - value: any | null | undefined; - fieldName: string; -}; - -export type SecurityInput = - | SecurityInputBasic - | SecurityInputBearer - | SecurityInputAPIKey - | SecurityInputOAuth2 - | SecurityInputOAuth2ClientCredentials - | SecurityInputOAuth2PasswordCredentials - | SecurityInputOIDC - | SecurityInputCustom; - -export function resolveSecurity( - ...options: SecurityInput[][] -): SecurityState | null { - const state: SecurityState = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" }, - }; - - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return ( - typeof o.value === "string" && !!o.value - ); - } else if (o.type === "oauth2:client_credentials") { - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error( - `Unrecognized security type: ${o.type} (value type: ${typeof o - .value})`, - ); - } - }); - }); - if (option == null) { - return null; - } - - option.forEach((spec) => { - if (spec.value == null) { - return; - } - - const { type } = spec; - - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec satisfies never; - throw SecurityError.unrecognizedType(type); - } - }); - - return state; -} - -function applyBasic( - state: SecurityState, - spec: SecurityInputBasic, -) { - if (spec.value == null) { - return; - } - - state.basic = spec.value; -} - -function applyBearer( - state: SecurityState, - spec: - | SecurityInputBearer - | SecurityInputOAuth2 - | SecurityInputOIDC - | SecurityInputOAuth2PasswordCredentials, -) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - - state.headers[spec.fieldName] = value; -} - -export function resolveGlobalSecurity( - security: Partial | null | undefined, -): SecurityState | null { - return resolveSecurity( - [ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey, - }, - ], - ); -} - -export async function extractSecurity< - T extends string | Record, ->(sec: T | (() => Promise) | undefined): Promise { - if (sec == null) { - return; - } - - return typeof sec === "function" ? sec() : sec; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/url.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/url.ts deleted file mode 100644 index 6bc6356e2..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/lib/url.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const hasOwn = Object.prototype.hasOwnProperty; - -export type Params = Partial>; - -export function pathToFunc( - pathPattern: string, - options?: { charEncoding?: "percent" | "none" }, -): (params?: Params) => string { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - - return function buildURLPath(params: Record = {}): string { - return pathPattern.replace(paramRE, function (_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error( - `Parameter '${placeholder}' must be a string or number`, - ); - } - - return options?.charEncoding === "percent" - ? encodeURIComponent(`${value}`) - : `${value}`; - }); - }; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/assistantmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/assistantmessage.ts deleted file mode 100644 index 02414e460..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/assistantmessage.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type AssistantMessageContent = string | Array; - -export const AssistantMessageRole = { - Assistant: "assistant", -} as const; -export type AssistantMessageRole = ClosedEnum; - -export type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** @internal */ -export const AssistantMessageContent$inboundSchema: z.ZodType< - AssistantMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type AssistantMessageContent$Outbound = - | string - | Array; - -/** @internal */ -export const AssistantMessageContent$outboundSchema: z.ZodType< - AssistantMessageContent$Outbound, - z.ZodTypeDef, - AssistantMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageContent$inboundSchema; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageContent$outboundSchema; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - export type Outbound = AssistantMessageContent$Outbound; -} - -export function assistantMessageContentToJSON( - assistantMessageContent: AssistantMessageContent, -): string { - return JSON.stringify( - AssistantMessageContent$outboundSchema.parse(assistantMessageContent), - ); -} - -export function assistantMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessageContent' from JSON`, - ); -} - -/** @internal */ -export const AssistantMessageRole$inboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = z.nativeEnum(AssistantMessageRole); - -/** @internal */ -export const AssistantMessageRole$outboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = AssistantMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageRole$inboundSchema; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageRole$outboundSchema; -} - -/** @internal */ -export const AssistantMessage$inboundSchema: z.ZodType< - AssistantMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$inboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -export const AssistantMessage$outboundSchema: z.ZodType< - AssistantMessage$Outbound, - z.ZodTypeDef, - AssistantMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$outboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - export const inboundSchema = AssistantMessage$inboundSchema; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - export const outboundSchema = AssistantMessage$outboundSchema; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - export type Outbound = AssistantMessage$Outbound; -} - -export function assistantMessageToJSON( - assistantMessage: AssistantMessage, -): string { - return JSON.stringify( - AssistantMessage$outboundSchema.parse(assistantMessage), - ); -} - -export function assistantMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionchoice.ts deleted file mode 100644 index 899d72067..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionchoice.ts +++ /dev/null @@ -1,137 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; - -export const ChatCompletionChoiceFinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type ChatCompletionChoiceFinishReason = OpenEnum< - typeof ChatCompletionChoiceFinishReason ->; - -export type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: ChatCompletionChoiceFinishReason; -}; - -/** @internal */ -export const ChatCompletionChoiceFinishReason$inboundSchema: z.ZodType< - ChatCompletionChoiceFinishReason, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ChatCompletionChoiceFinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ChatCompletionChoiceFinishReason$outboundSchema: z.ZodType< - ChatCompletionChoiceFinishReason, - z.ZodTypeDef, - ChatCompletionChoiceFinishReason -> = z.union([ - z.nativeEnum(ChatCompletionChoiceFinishReason), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionChoiceFinishReason$ { - /** @deprecated use `ChatCompletionChoiceFinishReason$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionChoiceFinishReason$inboundSchema; - /** @deprecated use `ChatCompletionChoiceFinishReason$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionChoiceFinishReason$outboundSchema; -} - -/** @internal */ -export const ChatCompletionChoice$inboundSchema: z.ZodType< - ChatCompletionChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - message: AssistantMessage$inboundSchema, - finish_reason: ChatCompletionChoiceFinishReason$inboundSchema, -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -export const ChatCompletionChoice$outboundSchema: z.ZodType< - ChatCompletionChoice$Outbound, - z.ZodTypeDef, - ChatCompletionChoice -> = z.object({ - index: z.number().int(), - message: AssistantMessage$outboundSchema, - finishReason: ChatCompletionChoiceFinishReason$outboundSchema, -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionChoice$inboundSchema; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionChoice$outboundSchema; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - export type Outbound = ChatCompletionChoice$Outbound; -} - -export function chatCompletionChoiceToJSON( - chatCompletionChoice: ChatCompletionChoice, -): string { - return JSON.stringify( - ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice), - ); -} - -export function chatCompletionChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionrequest.ts deleted file mode 100644 index fec423425..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionrequest.ts +++ /dev/null @@ -1,496 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type ChatCompletionRequestStop = string | Array; - -export type ChatCompletionRequestMessages = - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }); - -export type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionRequestStop$inboundSchema: z.ZodType< - ChatCompletionRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type ChatCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -export const ChatCompletionRequestStop$outboundSchema: z.ZodType< - ChatCompletionRequestStop$Outbound, - z.ZodTypeDef, - ChatCompletionRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestStop$ { - /** @deprecated use `ChatCompletionRequestStop$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestStop$inboundSchema; - /** @deprecated use `ChatCompletionRequestStop$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestStop$outboundSchema; - /** @deprecated use `ChatCompletionRequestStop$Outbound` instead. */ - export type Outbound = ChatCompletionRequestStop$Outbound; -} - -export function chatCompletionRequestStopToJSON( - chatCompletionRequestStop: ChatCompletionRequestStop, -): string { - return JSON.stringify( - ChatCompletionRequestStop$outboundSchema.parse(chatCompletionRequestStop), - ); -} - -export function chatCompletionRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestStop' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequestMessages$inboundSchema: z.ZodType< - ChatCompletionRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** @internal */ -export type ChatCompletionRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }); - -/** @internal */ -export const ChatCompletionRequestMessages$outboundSchema: z.ZodType< - ChatCompletionRequestMessages$Outbound, - z.ZodTypeDef, - ChatCompletionRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestMessages$ { - /** @deprecated use `ChatCompletionRequestMessages$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestMessages$inboundSchema; - /** @deprecated use `ChatCompletionRequestMessages$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestMessages$outboundSchema; - /** @deprecated use `ChatCompletionRequestMessages$Outbound` instead. */ - export type Outbound = ChatCompletionRequestMessages$Outbound; -} - -export function chatCompletionRequestMessagesToJSON( - chatCompletionRequestMessages: ChatCompletionRequestMessages, -): string { - return JSON.stringify( - ChatCompletionRequestMessages$outboundSchema.parse( - chatCompletionRequestMessages, - ), - ); -} - -export function chatCompletionRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -export function chatCompletionRequestToolChoiceToJSON( - chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionRequestToolChoice$outboundSchema.parse( - chatCompletionRequestToolChoice, - ), - ); -} - -export function chatCompletionRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequest$inboundSchema: z.ZodType< - ChatCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - }); -}); - -/** @internal */ -export type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionRequest$outboundSchema: z.ZodType< - ChatCompletionRequest$Outbound, - z.ZodTypeDef, - ChatCompletionRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequest$inboundSchema; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequest$outboundSchema; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - export type Outbound = ChatCompletionRequest$Outbound; -} - -export function chatCompletionRequestToJSON( - chatCompletionRequest: ChatCompletionRequest, -): string { - return JSON.stringify( - ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest), - ); -} - -export function chatCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionresponse.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionresponse.ts deleted file mode 100644 index 68e707387..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionresponse.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ChatCompletionChoice, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, -} from "./chatcompletionchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created?: number | undefined; - choices?: Array | undefined; -}; - -/** @internal */ -export const ChatCompletionResponse$inboundSchema: z.ZodType< - ChatCompletionResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - created: z.number().int().optional(), - choices: z.array(ChatCompletionChoice$inboundSchema).optional(), -}); - -/** @internal */ -export type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created?: number | undefined; - choices?: Array | undefined; -}; - -/** @internal */ -export const ChatCompletionResponse$outboundSchema: z.ZodType< - ChatCompletionResponse$Outbound, - z.ZodTypeDef, - ChatCompletionResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - created: z.number().int().optional(), - choices: z.array(ChatCompletionChoice$outboundSchema).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionResponse$inboundSchema; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionResponse$outboundSchema; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - export type Outbound = ChatCompletionResponse$Outbound; -} - -export function chatCompletionResponseToJSON( - chatCompletionResponse: ChatCompletionResponse, -): string { - return JSON.stringify( - ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse), - ); -} - -export function chatCompletionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionstreamrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionstreamrequest.ts deleted file mode 100644 index 8dff0388a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/chatcompletionstreamrequest.ts +++ /dev/null @@ -1,482 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type Stop = string | Array; - -export type Messages = - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }); - -export type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionStreamRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - | (ToolMessage & { role: "tool" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; -}; - -/** @internal */ -export const Stop$inboundSchema: z.ZodType = z - .union([z.string(), z.array(z.string())]); - -/** @internal */ -export type Stop$Outbound = string | Array; - -/** @internal */ -export const Stop$outboundSchema: z.ZodType = - z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - export const inboundSchema = Stop$inboundSchema; - /** @deprecated use `Stop$outboundSchema` instead. */ - export const outboundSchema = Stop$outboundSchema; - /** @deprecated use `Stop$Outbound` instead. */ - export type Outbound = Stop$Outbound; -} - -export function stopToJSON(stop: Stop): string { - return JSON.stringify(Stop$outboundSchema.parse(stop)); -} - -export function stopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Stop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Stop' from JSON`, - ); -} - -/** @internal */ -export const Messages$inboundSchema: z.ZodType< - Messages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** @internal */ -export type Messages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }); - -/** @internal */ -export const Messages$outboundSchema: z.ZodType< - Messages$Outbound, - z.ZodTypeDef, - Messages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - export const inboundSchema = Messages$inboundSchema; - /** @deprecated use `Messages$outboundSchema` instead. */ - export const outboundSchema = Messages$outboundSchema; - /** @deprecated use `Messages$Outbound` instead. */ - export type Outbound = Messages$Outbound; -} - -export function messagesToJSON(messages: Messages): string { - return JSON.stringify(Messages$outboundSchema.parse(messages)); -} - -export function messagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Messages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Messages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionStreamRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = - ChatCompletionStreamRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = - ChatCompletionStreamRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -export function chatCompletionStreamRequestToolChoiceToJSON( - chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionStreamRequestToolChoice$outboundSchema.parse( - chatCompletionStreamRequestToolChoice, - ), - ); -} - -export function chatCompletionStreamRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequest$inboundSchema: z.ZodType< - ChatCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - }); -}); - -/** @internal */ -export type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - | (ToolMessage$Outbound & { role: "tool" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionStreamRequest$outboundSchema: z.ZodType< - ChatCompletionStreamRequest$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionStreamRequest$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionStreamRequest$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequest$Outbound; -} - -export function chatCompletionStreamRequestToJSON( - chatCompletionStreamRequest: ChatCompletionStreamRequest, -): string { - return JSON.stringify( - ChatCompletionStreamRequest$outboundSchema.parse( - chatCompletionStreamRequest, - ), - ); -} - -export function chatCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionchunk.ts deleted file mode 100644 index 31e00897d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionchunk.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionResponseStreamChoice, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, -} from "./completionresponsestreamchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$inboundSchema: z.ZodType< - CompletionChunk, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$inboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$inboundSchema), -}); - -/** @internal */ -export type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$outboundSchema: z.ZodType< - CompletionChunk$Outbound, - z.ZodTypeDef, - CompletionChunk -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$outboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - export const inboundSchema = CompletionChunk$inboundSchema; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - export const outboundSchema = CompletionChunk$outboundSchema; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - export type Outbound = CompletionChunk$Outbound; -} - -export function completionChunkToJSON( - completionChunk: CompletionChunk, -): string { - return JSON.stringify(CompletionChunk$outboundSchema.parse(completionChunk)); -} - -export function completionChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionevent.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionevent.ts deleted file mode 100644 index b377901b7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionevent.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, -} from "./completionchunk.js"; - -export type CompletionEvent = { - data: CompletionChunk; -}; - -/** @internal */ -export const CompletionEvent$inboundSchema: z.ZodType< - CompletionEvent, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}`, - }); - return z.NEVER; - } - }).pipe(CompletionChunk$inboundSchema), -}); - -/** @internal */ -export type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -export const CompletionEvent$outboundSchema: z.ZodType< - CompletionEvent$Outbound, - z.ZodTypeDef, - CompletionEvent -> = z.object({ - data: CompletionChunk$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - export const inboundSchema = CompletionEvent$inboundSchema; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - export const outboundSchema = CompletionEvent$outboundSchema; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - export type Outbound = CompletionEvent$Outbound; -} - -export function completionEventToJSON( - completionEvent: CompletionEvent, -): string { - return JSON.stringify(CompletionEvent$outboundSchema.parse(completionEvent)); -} - -export function completionEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionresponsestreamchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionresponsestreamchoice.ts deleted file mode 100644 index 323645c55..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/completionresponsestreamchoice.ts +++ /dev/null @@ -1,136 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DeltaMessage, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, -} from "./deltamessage.js"; - -export const FinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type FinishReason = OpenEnum; - -export type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: FinishReason | null; -}; - -/** @internal */ -export const FinishReason$inboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(FinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const FinishReason$outboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - FinishReason -> = z.union([ - z.nativeEnum(FinishReason), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - export const inboundSchema = FinishReason$inboundSchema; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - export const outboundSchema = FinishReason$outboundSchema; -} - -/** @internal */ -export const CompletionResponseStreamChoice$inboundSchema: z.ZodType< - CompletionResponseStreamChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$inboundSchema, - finish_reason: z.nullable(FinishReason$inboundSchema), -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -export const CompletionResponseStreamChoice$outboundSchema: z.ZodType< - CompletionResponseStreamChoice$Outbound, - z.ZodTypeDef, - CompletionResponseStreamChoice -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$outboundSchema, - finishReason: z.nullable(FinishReason$outboundSchema), -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - export const inboundSchema = CompletionResponseStreamChoice$inboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - export const outboundSchema = CompletionResponseStreamChoice$outboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - export type Outbound = CompletionResponseStreamChoice$Outbound; -} - -export function completionResponseStreamChoiceToJSON( - completionResponseStreamChoice: CompletionResponseStreamChoice, -): string { - return JSON.stringify( - CompletionResponseStreamChoice$outboundSchema.parse( - completionResponseStreamChoice, - ), - ); -} - -export function completionResponseStreamChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionResponseStreamChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/contentchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/contentchunk.ts deleted file mode 100644 index 3410a04f0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/contentchunk.ts +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - ReferenceChunk, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, -} from "./referencechunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; - -export type ContentChunk = - | (ImageURLChunk & { type: "image_url" }) - | (TextChunk & { type: "text" }) - | (ReferenceChunk & { type: "reference" }); - -/** @internal */ -export const ContentChunk$inboundSchema: z.ZodType< - ContentChunk, - z.ZodTypeDef, - unknown -> = z.union([ - ImageURLChunk$inboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$inboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$inboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type ContentChunk$Outbound = - | (ImageURLChunk$Outbound & { type: "image_url" }) - | (TextChunk$Outbound & { type: "text" }) - | (ReferenceChunk$Outbound & { type: "reference" }); - -/** @internal */ -export const ContentChunk$outboundSchema: z.ZodType< - ContentChunk$Outbound, - z.ZodTypeDef, - ContentChunk -> = z.union([ - ImageURLChunk$outboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$outboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$outboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - export const inboundSchema = ContentChunk$inboundSchema; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - export const outboundSchema = ContentChunk$outboundSchema; - /** @deprecated use `ContentChunk$Outbound` instead. */ - export type Outbound = ContentChunk$Outbound; -} - -export function contentChunkToJSON(contentChunk: ContentChunk): string { - return JSON.stringify(ContentChunk$outboundSchema.parse(contentChunk)); -} - -export function contentChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ContentChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ContentChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/deltamessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/deltamessage.ts deleted file mode 100644 index f01a3bf19..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/deltamessage.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type Content = string | Array; - -export type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -/** @internal */ -export const Content$inboundSchema: z.ZodType = - z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type Content$Outbound = string | Array; - -/** @internal */ -export const Content$outboundSchema: z.ZodType< - Content$Outbound, - z.ZodTypeDef, - Content -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - export const inboundSchema = Content$inboundSchema; - /** @deprecated use `Content$outboundSchema` instead. */ - export const outboundSchema = Content$outboundSchema; - /** @deprecated use `Content$Outbound` instead. */ - export type Outbound = Content$Outbound; -} - -export function contentToJSON(content: Content): string { - return JSON.stringify(Content$outboundSchema.parse(content)); -} - -export function contentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Content$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Content' from JSON`, - ); -} - -/** @internal */ -export const DeltaMessage$inboundSchema: z.ZodType< - DeltaMessage, - z.ZodTypeDef, - unknown -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -export const DeltaMessage$outboundSchema: z.ZodType< - DeltaMessage$Outbound, - z.ZodTypeDef, - DeltaMessage -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - export const inboundSchema = DeltaMessage$inboundSchema; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - export const outboundSchema = DeltaMessage$outboundSchema; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - export type Outbound = DeltaMessage$Outbound; -} - -export function deltaMessageToJSON(deltaMessage: DeltaMessage): string { - return JSON.stringify(DeltaMessage$outboundSchema.parse(deltaMessage)); -} - -export function deltaMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DeltaMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DeltaMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionrequest.ts deleted file mode 100644 index fa84ca1ef..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionrequest.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type FIMCompletionRequestStop = string | Array; - -export type FIMCompletionRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionRequestStop$inboundSchema: z.ZodType< - FIMCompletionRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type FIMCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -export const FIMCompletionRequestStop$outboundSchema: z.ZodType< - FIMCompletionRequestStop$Outbound, - z.ZodTypeDef, - FIMCompletionRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionRequestStop$ { - /** @deprecated use `FIMCompletionRequestStop$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionRequestStop$inboundSchema; - /** @deprecated use `FIMCompletionRequestStop$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionRequestStop$outboundSchema; - /** @deprecated use `FIMCompletionRequestStop$Outbound` instead. */ - export type Outbound = FIMCompletionRequestStop$Outbound; -} - -export function fimCompletionRequestStopToJSON( - fimCompletionRequestStop: FIMCompletionRequestStop, -): string { - return JSON.stringify( - FIMCompletionRequestStop$outboundSchema.parse(fimCompletionRequestStop), - ); -} - -export function fimCompletionRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionRequestStop' from JSON`, - ); -} - -/** @internal */ -export const FIMCompletionRequest$inboundSchema: z.ZodType< - FIMCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens", - }); -}); - -/** @internal */ -export type FIMCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionRequest$outboundSchema: z.ZodType< - FIMCompletionRequest$Outbound, - z.ZodTypeDef, - FIMCompletionRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionRequest$ { - /** @deprecated use `FIMCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionRequest$inboundSchema; - /** @deprecated use `FIMCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionRequest$outboundSchema; - /** @deprecated use `FIMCompletionRequest$Outbound` instead. */ - export type Outbound = FIMCompletionRequest$Outbound; -} - -export function fimCompletionRequestToJSON( - fimCompletionRequest: FIMCompletionRequest, -): string { - return JSON.stringify( - FIMCompletionRequest$outboundSchema.parse(fimCompletionRequest), - ); -} - -export function fimCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionresponse.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionresponse.ts deleted file mode 100644 index 9f3e30953..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionresponse.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ChatCompletionChoice, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, -} from "./chatcompletionchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type FIMCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created?: number | undefined; - choices?: Array | undefined; -}; - -/** @internal */ -export const FIMCompletionResponse$inboundSchema: z.ZodType< - FIMCompletionResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - created: z.number().int().optional(), - choices: z.array(ChatCompletionChoice$inboundSchema).optional(), -}); - -/** @internal */ -export type FIMCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created?: number | undefined; - choices?: Array | undefined; -}; - -/** @internal */ -export const FIMCompletionResponse$outboundSchema: z.ZodType< - FIMCompletionResponse$Outbound, - z.ZodTypeDef, - FIMCompletionResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - created: z.number().int().optional(), - choices: z.array(ChatCompletionChoice$outboundSchema).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionResponse$ { - /** @deprecated use `FIMCompletionResponse$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionResponse$inboundSchema; - /** @deprecated use `FIMCompletionResponse$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionResponse$outboundSchema; - /** @deprecated use `FIMCompletionResponse$Outbound` instead. */ - export type Outbound = FIMCompletionResponse$Outbound; -} - -export function fimCompletionResponseToJSON( - fimCompletionResponse: FIMCompletionResponse, -): string { - return JSON.stringify( - FIMCompletionResponse$outboundSchema.parse(fimCompletionResponse), - ); -} - -export function fimCompletionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionstreamrequest.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionstreamrequest.ts deleted file mode 100644 index eea6ee278..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/fimcompletionstreamrequest.ts +++ /dev/null @@ -1,203 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type FIMCompletionStreamRequestStop = string | Array; - -export type FIMCompletionStreamRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionStreamRequestStop$inboundSchema: z.ZodType< - FIMCompletionStreamRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type FIMCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -export const FIMCompletionStreamRequestStop$outboundSchema: z.ZodType< - FIMCompletionStreamRequestStop$Outbound, - z.ZodTypeDef, - FIMCompletionStreamRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionStreamRequestStop$ { - /** @deprecated use `FIMCompletionStreamRequestStop$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionStreamRequestStop$inboundSchema; - /** @deprecated use `FIMCompletionStreamRequestStop$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionStreamRequestStop$outboundSchema; - /** @deprecated use `FIMCompletionStreamRequestStop$Outbound` instead. */ - export type Outbound = FIMCompletionStreamRequestStop$Outbound; -} - -export function fimCompletionStreamRequestStopToJSON( - fimCompletionStreamRequestStop: FIMCompletionStreamRequestStop, -): string { - return JSON.stringify( - FIMCompletionStreamRequestStop$outboundSchema.parse( - fimCompletionStreamRequestStop, - ), - ); -} - -export function fimCompletionStreamRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionStreamRequestStop' from JSON`, - ); -} - -/** @internal */ -export const FIMCompletionStreamRequest$inboundSchema: z.ZodType< - FIMCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens", - }); -}); - -/** @internal */ -export type FIMCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionStreamRequest$outboundSchema: z.ZodType< - FIMCompletionStreamRequest$Outbound, - z.ZodTypeDef, - FIMCompletionStreamRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionStreamRequest$ { - /** @deprecated use `FIMCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionStreamRequest$inboundSchema; - /** @deprecated use `FIMCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionStreamRequest$outboundSchema; - /** @deprecated use `FIMCompletionStreamRequest$Outbound` instead. */ - export type Outbound = FIMCompletionStreamRequest$Outbound; -} - -export function fimCompletionStreamRequestToJSON( - fimCompletionStreamRequest: FIMCompletionStreamRequest, -): string { - return JSON.stringify( - FIMCompletionStreamRequest$outboundSchema.parse(fimCompletionStreamRequest), - ); -} - -export function fimCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/function.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/function.ts deleted file mode 100644 index daa47c664..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/function.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$inboundSchema: z.ZodType< - FunctionT, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** @internal */ -export type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$outboundSchema: z.ZodType< - FunctionT$Outbound, - z.ZodTypeDef, - FunctionT -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - export const inboundSchema = FunctionT$inboundSchema; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - export const outboundSchema = FunctionT$outboundSchema; - /** @deprecated use `FunctionT$Outbound` instead. */ - export type Outbound = FunctionT$Outbound; -} - -export function functionToJSON(functionT: FunctionT): string { - return JSON.stringify(FunctionT$outboundSchema.parse(functionT)); -} - -export function functionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionT$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionT' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functioncall.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functioncall.ts deleted file mode 100644 index ffaa036a8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functioncall.ts +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Arguments = { [k: string]: any } | string; - -export type FunctionCall = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const Arguments$inboundSchema: z.ZodType< - Arguments, - z.ZodTypeDef, - unknown -> = z.union([z.record(z.any()), z.string()]); - -/** @internal */ -export type Arguments$Outbound = { [k: string]: any } | string; - -/** @internal */ -export const Arguments$outboundSchema: z.ZodType< - Arguments$Outbound, - z.ZodTypeDef, - Arguments -> = z.union([z.record(z.any()), z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - export const inboundSchema = Arguments$inboundSchema; - /** @deprecated use `Arguments$outboundSchema` instead. */ - export const outboundSchema = Arguments$outboundSchema; - /** @deprecated use `Arguments$Outbound` instead. */ - export type Outbound = Arguments$Outbound; -} - -export function argumentsToJSON(value: Arguments): string { - return JSON.stringify(Arguments$outboundSchema.parse(value)); -} - -export function argumentsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Arguments$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Arguments' from JSON`, - ); -} - -/** @internal */ -export const FunctionCall$inboundSchema: z.ZodType< - FunctionCall, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** @internal */ -export type FunctionCall$Outbound = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const FunctionCall$outboundSchema: z.ZodType< - FunctionCall$Outbound, - z.ZodTypeDef, - FunctionCall -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - export const inboundSchema = FunctionCall$inboundSchema; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - export const outboundSchema = FunctionCall$outboundSchema; - /** @deprecated use `FunctionCall$Outbound` instead. */ - export type Outbound = FunctionCall$Outbound; -} - -export function functionCallToJSON(functionCall: FunctionCall): string { - return JSON.stringify(FunctionCall$outboundSchema.parse(functionCall)); -} - -export function functionCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functionname.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functionname.ts deleted file mode 100644 index e26279046..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/functionname.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -export type FunctionName = { - name: string; -}; - -/** @internal */ -export const FunctionName$inboundSchema: z.ZodType< - FunctionName, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), -}); - -/** @internal */ -export type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -export const FunctionName$outboundSchema: z.ZodType< - FunctionName$Outbound, - z.ZodTypeDef, - FunctionName -> = z.object({ - name: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - export const inboundSchema = FunctionName$inboundSchema; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - export const outboundSchema = FunctionName$outboundSchema; - /** @deprecated use `FunctionName$Outbound` instead. */ - export type Outbound = FunctionName$Outbound; -} - -export function functionNameToJSON(functionName: FunctionName): string { - return JSON.stringify(FunctionName$outboundSchema.parse(functionName)); -} - -export function functionNameFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionName$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionName' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurl.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurl.ts deleted file mode 100644 index 5086e232b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurl.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$inboundSchema: z.ZodType< - ImageURL, - z.ZodTypeDef, - unknown -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$outboundSchema: z.ZodType< - ImageURL$Outbound, - z.ZodTypeDef, - ImageURL -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURL$inboundSchema; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURL$outboundSchema; - /** @deprecated use `ImageURL$Outbound` instead. */ - export type Outbound = ImageURL$Outbound; -} - -export function imageURLToJSON(imageURL: ImageURL): string { - return JSON.stringify(ImageURL$outboundSchema.parse(imageURL)); -} - -export function imageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURL' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurlchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurlchunk.ts deleted file mode 100644 index 7feb19366..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/imageurlchunk.ts +++ /dev/null @@ -1,161 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, -} from "./imageurl.js"; - -export type ImageURLChunkImageURL = ImageURL | string; - -export const ImageURLChunkType = { - ImageUrl: "image_url", -} as const; -export type ImageURLChunkType = ClosedEnum; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -export type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -/** @internal */ -export const ImageURLChunkImageURL$inboundSchema: z.ZodType< - ImageURLChunkImageURL, - z.ZodTypeDef, - unknown -> = z.union([ImageURL$inboundSchema, z.string()]); - -/** @internal */ -export type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -export const ImageURLChunkImageURL$outboundSchema: z.ZodType< - ImageURLChunkImageURL$Outbound, - z.ZodTypeDef, - ImageURLChunkImageURL -> = z.union([ImageURL$outboundSchema, z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkImageURL$inboundSchema; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkImageURL$outboundSchema; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - export type Outbound = ImageURLChunkImageURL$Outbound; -} - -export function imageURLChunkImageURLToJSON( - imageURLChunkImageURL: ImageURLChunkImageURL, -): string { - return JSON.stringify( - ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL), - ); -} - -export function imageURLChunkImageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunkImageURL' from JSON`, - ); -} - -/** @internal */ -export const ImageURLChunkType$inboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = z.nativeEnum(ImageURLChunkType); - -/** @internal */ -export const ImageURLChunkType$outboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = ImageURLChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkType$inboundSchema; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkType$outboundSchema; -} - -/** @internal */ -export const ImageURLChunk$inboundSchema: z.ZodType< - ImageURLChunk, - z.ZodTypeDef, - unknown -> = z.object({ - image_url: z.union([ImageURL$inboundSchema, z.string()]), - type: ImageURLChunkType$inboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - "image_url": "imageUrl", - }); -}); - -/** @internal */ -export type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -export const ImageURLChunk$outboundSchema: z.ZodType< - ImageURLChunk$Outbound, - z.ZodTypeDef, - ImageURLChunk -> = z.object({ - imageUrl: z.union([ImageURL$outboundSchema, z.string()]), - type: ImageURLChunkType$outboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - imageUrl: "image_url", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunk$inboundSchema; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunk$outboundSchema; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - export type Outbound = ImageURLChunk$Outbound; -} - -export function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string { - return JSON.stringify(ImageURLChunk$outboundSchema.parse(imageURLChunk)); -} - -export function imageURLChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/index.ts deleted file mode 100644 index 54155d4c3..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/index.ts +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./assistantmessage.js"; -export * from "./chatcompletionchoice.js"; -export * from "./chatcompletionrequest.js"; -export * from "./chatcompletionresponse.js"; -export * from "./chatcompletionstreamrequest.js"; -export * from "./completionchunk.js"; -export * from "./completionevent.js"; -export * from "./completionresponsestreamchoice.js"; -export * from "./contentchunk.js"; -export * from "./deltamessage.js"; -export * from "./fimcompletionrequest.js"; -export * from "./fimcompletionresponse.js"; -export * from "./fimcompletionstreamrequest.js"; -export * from "./function.js"; -export * from "./functioncall.js"; -export * from "./functionname.js"; -export * from "./imageurl.js"; -export * from "./imageurlchunk.js"; -export * from "./jsonschema.js"; -export * from "./prediction.js"; -export * from "./referencechunk.js"; -export * from "./responseformat.js"; -export * from "./responseformats.js"; -export * from "./security.js"; -export * from "./systemmessage.js"; -export * from "./textchunk.js"; -export * from "./tool.js"; -export * from "./toolcall.js"; -export * from "./toolchoice.js"; -export * from "./toolchoiceenum.js"; -export * from "./toolmessage.js"; -export * from "./tooltypes.js"; -export * from "./usageinfo.js"; -export * from "./usermessage.js"; -export * from "./validationerror.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/jsonschema.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/jsonschema.ts deleted file mode 100644 index 12af67b2c..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/jsonschema.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$inboundSchema: z.ZodType< - JsonSchema, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "schema": "schemaDefinition", - }); -}); - -/** @internal */ -export type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$outboundSchema: z.ZodType< - JsonSchema$Outbound, - z.ZodTypeDef, - JsonSchema -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - schemaDefinition: "schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - export const inboundSchema = JsonSchema$inboundSchema; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - export const outboundSchema = JsonSchema$outboundSchema; - /** @deprecated use `JsonSchema$Outbound` instead. */ - export type Outbound = JsonSchema$Outbound; -} - -export function jsonSchemaToJSON(jsonSchema: JsonSchema): string { - return JSON.stringify(JsonSchema$outboundSchema.parse(jsonSchema)); -} - -export function jsonSchemaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JsonSchema$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JsonSchema' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/prediction.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/prediction.ts deleted file mode 100644 index d195ee8a5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/prediction.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -/** @internal */ -export const Prediction$inboundSchema: z.ZodType< - Prediction, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("content").default("content"), - content: z.string().default(""), -}); - -/** @internal */ -export type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -export const Prediction$outboundSchema: z.ZodType< - Prediction$Outbound, - z.ZodTypeDef, - Prediction -> = z.object({ - type: z.literal("content").default("content" as const), - content: z.string().default(""), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - export const inboundSchema = Prediction$inboundSchema; - /** @deprecated use `Prediction$outboundSchema` instead. */ - export const outboundSchema = Prediction$outboundSchema; - /** @deprecated use `Prediction$Outbound` instead. */ - export type Outbound = Prediction$Outbound; -} - -export function predictionToJSON(prediction: Prediction): string { - return JSON.stringify(Prediction$outboundSchema.parse(prediction)); -} - -export function predictionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Prediction$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Prediction' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/referencechunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/referencechunk.ts deleted file mode 100644 index 9085d7b9f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/referencechunk.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ReferenceChunkType = { - Reference: "reference", -} as const; -export type ReferenceChunkType = ClosedEnum; - -export type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -/** @internal */ -export const ReferenceChunkType$inboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = z.nativeEnum(ReferenceChunkType); - -/** @internal */ -export const ReferenceChunkType$outboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = ReferenceChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunkType$inboundSchema; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunkType$outboundSchema; -} - -/** @internal */ -export const ReferenceChunk$inboundSchema: z.ZodType< - ReferenceChunk, - z.ZodTypeDef, - unknown -> = z.object({ - reference_ids: z.array(z.number().int()), - type: ReferenceChunkType$inboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - "reference_ids": "referenceIds", - }); -}); - -/** @internal */ -export type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -export const ReferenceChunk$outboundSchema: z.ZodType< - ReferenceChunk$Outbound, - z.ZodTypeDef, - ReferenceChunk -> = z.object({ - referenceIds: z.array(z.number().int()), - type: ReferenceChunkType$outboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - referenceIds: "reference_ids", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunk$inboundSchema; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunk$outboundSchema; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - export type Outbound = ReferenceChunk$Outbound; -} - -export function referenceChunkToJSON(referenceChunk: ReferenceChunk): string { - return JSON.stringify(ReferenceChunk$outboundSchema.parse(referenceChunk)); -} - -export function referenceChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ReferenceChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ReferenceChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformat.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformat.ts deleted file mode 100644 index 7b6a4bf09..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformat.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, -} from "./jsonschema.js"; -import { - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, -} from "./responseformats.js"; - -export type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$inboundSchema: z.ZodType< - ResponseFormat, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(JsonSchema$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "json_schema": "jsonSchema", - }); -}); - -/** @internal */ -export type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$outboundSchema: z.ZodType< - ResponseFormat$Outbound, - z.ZodTypeDef, - ResponseFormat -> = z.object({ - type: ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(JsonSchema$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - jsonSchema: "json_schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - export const inboundSchema = ResponseFormat$inboundSchema; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - export const outboundSchema = ResponseFormat$outboundSchema; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - export type Outbound = ResponseFormat$Outbound; -} - -export function responseFormatToJSON(responseFormat: ResponseFormat): string { - return JSON.stringify(ResponseFormat$outboundSchema.parse(responseFormat)); -} - -export function responseFormatFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseFormat$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseFormat' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformats.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformats.ts deleted file mode 100644 index d14f152e0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/responseformats.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export const ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema", -} as const; -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export type ResponseFormats = ClosedEnum; - -/** @internal */ -export const ResponseFormats$inboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = z.nativeEnum(ResponseFormats); - -/** @internal */ -export const ResponseFormats$outboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = ResponseFormats$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - export const inboundSchema = ResponseFormats$inboundSchema; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - export const outboundSchema = ResponseFormats$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/security.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/security.ts deleted file mode 100644 index 5a261bbd9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/security.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Security = { - apiKey: string; -}; - -/** @internal */ -export const Security$inboundSchema: z.ZodType< - Security, - z.ZodTypeDef, - unknown -> = z.object({ - ApiKey: z.string(), -}).transform((v) => { - return remap$(v, { - "ApiKey": "apiKey", - }); -}); - -/** @internal */ -export type Security$Outbound = { - ApiKey: string; -}; - -/** @internal */ -export const Security$outboundSchema: z.ZodType< - Security$Outbound, - z.ZodTypeDef, - Security -> = z.object({ - apiKey: z.string(), -}).transform((v) => { - return remap$(v, { - apiKey: "ApiKey", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - export const inboundSchema = Security$inboundSchema; - /** @deprecated use `Security$outboundSchema` instead. */ - export const outboundSchema = Security$outboundSchema; - /** @deprecated use `Security$Outbound` instead. */ - export type Outbound = Security$Outbound; -} - -export function securityToJSON(security: Security): string { - return JSON.stringify(Security$outboundSchema.parse(security)); -} - -export function securityFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Security$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Security' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/systemmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/systemmessage.ts deleted file mode 100644 index a911a0122..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/systemmessage.ts +++ /dev/null @@ -1,148 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; - -export type SystemMessageContent = string | Array; - -export const Role = { - System: "system", -} as const; -export type Role = ClosedEnum; - -export type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** @internal */ -export const SystemMessageContent$inboundSchema: z.ZodType< - SystemMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(TextChunk$inboundSchema)]); - -/** @internal */ -export type SystemMessageContent$Outbound = string | Array; - -/** @internal */ -export const SystemMessageContent$outboundSchema: z.ZodType< - SystemMessageContent$Outbound, - z.ZodTypeDef, - SystemMessageContent -> = z.union([z.string(), z.array(TextChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - export const inboundSchema = SystemMessageContent$inboundSchema; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - export const outboundSchema = SystemMessageContent$outboundSchema; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - export type Outbound = SystemMessageContent$Outbound; -} - -export function systemMessageContentToJSON( - systemMessageContent: SystemMessageContent, -): string { - return JSON.stringify( - SystemMessageContent$outboundSchema.parse(systemMessageContent), - ); -} - -export function systemMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessageContent' from JSON`, - ); -} - -/** @internal */ -export const Role$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Role, -); - -/** @internal */ -export const Role$outboundSchema: z.ZodNativeEnum = - Role$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - export const inboundSchema = Role$inboundSchema; - /** @deprecated use `Role$outboundSchema` instead. */ - export const outboundSchema = Role$outboundSchema; -} - -/** @internal */ -export const SystemMessage$inboundSchema: z.ZodType< - SystemMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.union([z.string(), z.array(TextChunk$inboundSchema)]), - role: Role$inboundSchema.default("system"), -}); - -/** @internal */ -export type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -export const SystemMessage$outboundSchema: z.ZodType< - SystemMessage$Outbound, - z.ZodTypeDef, - SystemMessage -> = z.object({ - content: z.union([z.string(), z.array(TextChunk$outboundSchema)]), - role: Role$outboundSchema.default("system"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - export const inboundSchema = SystemMessage$inboundSchema; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - export const outboundSchema = SystemMessage$outboundSchema; - /** @deprecated use `SystemMessage$Outbound` instead. */ - export type Outbound = SystemMessage$Outbound; -} - -export function systemMessageToJSON(systemMessage: SystemMessage): string { - return JSON.stringify(SystemMessage$outboundSchema.parse(systemMessage)); -} - -export function systemMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/textchunk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/textchunk.ts deleted file mode 100644 index aa0afb615..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/textchunk.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const Type = { - Text: "text", -} as const; -export type Type = ClosedEnum; - -export type TextChunk = { - text: string; - type?: Type | undefined; -}; - -/** @internal */ -export const Type$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Type, -); - -/** @internal */ -export const Type$outboundSchema: z.ZodNativeEnum = - Type$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - export const inboundSchema = Type$inboundSchema; - /** @deprecated use `Type$outboundSchema` instead. */ - export const outboundSchema = Type$outboundSchema; -} - -/** @internal */ -export const TextChunk$inboundSchema: z.ZodType< - TextChunk, - z.ZodTypeDef, - unknown -> = z.object({ - text: z.string(), - type: Type$inboundSchema.default("text"), -}); - -/** @internal */ -export type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -export const TextChunk$outboundSchema: z.ZodType< - TextChunk$Outbound, - z.ZodTypeDef, - TextChunk -> = z.object({ - text: z.string(), - type: Type$outboundSchema.default("text"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - export const inboundSchema = TextChunk$inboundSchema; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - export const outboundSchema = TextChunk$outboundSchema; - /** @deprecated use `TextChunk$Outbound` instead. */ - export type Outbound = TextChunk$Outbound; -} - -export function textChunkToJSON(textChunk: TextChunk): string { - return JSON.stringify(TextChunk$outboundSchema.parse(textChunk)); -} - -export function textChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TextChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TextChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tool.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tool.ts deleted file mode 100644 index 0e1a73c3e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tool.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, -} from "./function.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** @internal */ -export const Tool$inboundSchema: z.ZodType = z - .object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionT$inboundSchema, - }); - -/** @internal */ -export type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -export const Tool$outboundSchema: z.ZodType = - z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionT$outboundSchema, - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - export const inboundSchema = Tool$inboundSchema; - /** @deprecated use `Tool$outboundSchema` instead. */ - export const outboundSchema = Tool$outboundSchema; - /** @deprecated use `Tool$Outbound` instead. */ - export type Outbound = Tool$Outbound; -} - -export function toolToJSON(tool: Tool): string { - return JSON.stringify(Tool$outboundSchema.parse(tool)); -} - -export function toolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Tool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Tool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolcall.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolcall.ts deleted file mode 100644 index 3423370a0..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolcall.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionCall, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, -} from "./functioncall.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -/** @internal */ -export const ToolCall$inboundSchema: z.ZodType< - ToolCall, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$inboundSchema.optional(), - function: FunctionCall$inboundSchema, - index: z.number().int().default(0), -}); - -/** @internal */ -export type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -export const ToolCall$outboundSchema: z.ZodType< - ToolCall$Outbound, - z.ZodTypeDef, - ToolCall -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$outboundSchema.optional(), - function: FunctionCall$outboundSchema, - index: z.number().int().default(0), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - export const inboundSchema = ToolCall$inboundSchema; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - export const outboundSchema = ToolCall$outboundSchema; - /** @deprecated use `ToolCall$Outbound` instead. */ - export type Outbound = ToolCall$Outbound; -} - -export function toolCallToJSON(toolCall: ToolCall): string { - return JSON.stringify(ToolCall$outboundSchema.parse(toolCall)); -} - -export function toolCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoice.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoice.ts deleted file mode 100644 index 68138162e..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoice.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, -} from "./functionname.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -export type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** @internal */ -export const ToolChoice$inboundSchema: z.ZodType< - ToolChoice, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionName$inboundSchema, -}); - -/** @internal */ -export type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -export const ToolChoice$outboundSchema: z.ZodType< - ToolChoice$Outbound, - z.ZodTypeDef, - ToolChoice -> = z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionName$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - export const inboundSchema = ToolChoice$inboundSchema; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - export const outboundSchema = ToolChoice$outboundSchema; - /** @deprecated use `ToolChoice$Outbound` instead. */ - export type Outbound = ToolChoice$Outbound; -} - -export function toolChoiceToJSON(toolChoice: ToolChoice): string { - return JSON.stringify(ToolChoice$outboundSchema.parse(toolChoice)); -} - -export function toolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoiceenum.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoiceenum.ts deleted file mode 100644 index 401f927f5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolchoiceenum.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required", -} as const; -export type ToolChoiceEnum = ClosedEnum; - -/** @internal */ -export const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = z.nativeEnum(ToolChoiceEnum); - -/** @internal */ -export const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = ToolChoiceEnum$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - export const inboundSchema = ToolChoiceEnum$inboundSchema; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - export const outboundSchema = ToolChoiceEnum$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolmessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolmessage.ts deleted file mode 100644 index a343e401a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/toolmessage.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type ToolMessageContent = string | Array; - -export const ToolMessageRole = { - Tool: "tool", -} as const; -export type ToolMessageRole = ClosedEnum; - -export type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** @internal */ -export const ToolMessageContent$inboundSchema: z.ZodType< - ToolMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -export const ToolMessageContent$outboundSchema: z.ZodType< - ToolMessageContent$Outbound, - z.ZodTypeDef, - ToolMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - export const inboundSchema = ToolMessageContent$inboundSchema; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - export const outboundSchema = ToolMessageContent$outboundSchema; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - export type Outbound = ToolMessageContent$Outbound; -} - -export function toolMessageContentToJSON( - toolMessageContent: ToolMessageContent, -): string { - return JSON.stringify( - ToolMessageContent$outboundSchema.parse(toolMessageContent), - ); -} - -export function toolMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessageContent' from JSON`, - ); -} - -/** @internal */ -export const ToolMessageRole$inboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = z.nativeEnum(ToolMessageRole); - -/** @internal */ -export const ToolMessageRole$outboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = ToolMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - export const inboundSchema = ToolMessageRole$inboundSchema; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - export const outboundSchema = ToolMessageRole$outboundSchema; -} - -/** @internal */ -export const ToolMessage$inboundSchema: z.ZodType< - ToolMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$inboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -export const ToolMessage$outboundSchema: z.ZodType< - ToolMessage$Outbound, - z.ZodTypeDef, - ToolMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$outboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - export const inboundSchema = ToolMessage$inboundSchema; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - export const outboundSchema = ToolMessage$outboundSchema; - /** @deprecated use `ToolMessage$Outbound` instead. */ - export type Outbound = ToolMessage$Outbound; -} - -export function toolMessageToJSON(toolMessage: ToolMessage): string { - return JSON.stringify(ToolMessage$outboundSchema.parse(toolMessage)); -} - -export function toolMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tooltypes.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tooltypes.ts deleted file mode 100644 index a414745f8..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/tooltypes.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const ToolTypes = { - Function: "function", -} as const; -export type ToolTypes = OpenEnum; - -/** @internal */ -export const ToolTypes$inboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ToolTypes), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ToolTypes$outboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - ToolTypes -> = z.union([ - z.nativeEnum(ToolTypes), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - export const inboundSchema = ToolTypes$inboundSchema; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - export const outboundSchema = ToolTypes$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usageinfo.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usageinfo.ts deleted file mode 100644 index f6e8f62cd..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usageinfo.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type UsageInfo = { - promptTokens: number; - completionTokens: number; - totalTokens: number; -}; - -/** @internal */ -export const UsageInfo$inboundSchema: z.ZodType< - UsageInfo, - z.ZodTypeDef, - unknown -> = z.object({ - prompt_tokens: z.number().int(), - completion_tokens: z.number().int(), - total_tokens: z.number().int(), -}).transform((v) => { - return remap$(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - }); -}); - -/** @internal */ -export type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; -}; - -/** @internal */ -export const UsageInfo$outboundSchema: z.ZodType< - UsageInfo$Outbound, - z.ZodTypeDef, - UsageInfo -> = z.object({ - promptTokens: z.number().int(), - completionTokens: z.number().int(), - totalTokens: z.number().int(), -}).transform((v) => { - return remap$(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - export const inboundSchema = UsageInfo$inboundSchema; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - export const outboundSchema = UsageInfo$outboundSchema; - /** @deprecated use `UsageInfo$Outbound` instead. */ - export type Outbound = UsageInfo$Outbound; -} - -export function usageInfoToJSON(usageInfo: UsageInfo): string { - return JSON.stringify(UsageInfo$outboundSchema.parse(usageInfo)); -} - -export function usageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usermessage.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usermessage.ts deleted file mode 100644 index e74a20d70..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/usermessage.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type UserMessageContent = string | Array; - -export const UserMessageRole = { - User: "user", -} as const; -export type UserMessageRole = ClosedEnum; - -export type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** @internal */ -export const UserMessageContent$inboundSchema: z.ZodType< - UserMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type UserMessageContent$Outbound = string | Array; - -/** @internal */ -export const UserMessageContent$outboundSchema: z.ZodType< - UserMessageContent$Outbound, - z.ZodTypeDef, - UserMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - export const inboundSchema = UserMessageContent$inboundSchema; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - export const outboundSchema = UserMessageContent$outboundSchema; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - export type Outbound = UserMessageContent$Outbound; -} - -export function userMessageContentToJSON( - userMessageContent: UserMessageContent, -): string { - return JSON.stringify( - UserMessageContent$outboundSchema.parse(userMessageContent), - ); -} - -export function userMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessageContent' from JSON`, - ); -} - -/** @internal */ -export const UserMessageRole$inboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = z.nativeEnum(UserMessageRole); - -/** @internal */ -export const UserMessageRole$outboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = UserMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - export const inboundSchema = UserMessageRole$inboundSchema; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - export const outboundSchema = UserMessageRole$outboundSchema; -} - -/** @internal */ -export const UserMessage$inboundSchema: z.ZodType< - UserMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - role: UserMessageRole$inboundSchema.default("user"), -}); - -/** @internal */ -export type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -export const UserMessage$outboundSchema: z.ZodType< - UserMessage$Outbound, - z.ZodTypeDef, - UserMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - role: UserMessageRole$outboundSchema.default("user"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - export const inboundSchema = UserMessage$inboundSchema; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - export const outboundSchema = UserMessage$outboundSchema; - /** @deprecated use `UserMessage$Outbound` instead. */ - export type Outbound = UserMessage$Outbound; -} - -export function userMessageToJSON(userMessage: UserMessage): string { - return JSON.stringify(UserMessage$outboundSchema.parse(userMessage)); -} - -export function userMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/validationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/validationerror.ts deleted file mode 100644 index 9072a892d..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/components/validationerror.ts +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Loc = string | number; - -export type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const Loc$inboundSchema: z.ZodType = z.union( - [z.string(), z.number().int()], -); - -/** @internal */ -export type Loc$Outbound = string | number; - -/** @internal */ -export const Loc$outboundSchema: z.ZodType = z - .union([z.string(), z.number().int()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - export const inboundSchema = Loc$inboundSchema; - /** @deprecated use `Loc$outboundSchema` instead. */ - export const outboundSchema = Loc$outboundSchema; - /** @deprecated use `Loc$Outbound` instead. */ - export type Outbound = Loc$Outbound; -} - -export function locToJSON(loc: Loc): string { - return JSON.stringify(Loc$outboundSchema.parse(loc)); -} - -export function locFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Loc$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Loc' from JSON`, - ); -} - -/** @internal */ -export const ValidationError$inboundSchema: z.ZodType< - ValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** @internal */ -export type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const ValidationError$outboundSchema: z.ZodType< - ValidationError$Outbound, - z.ZodTypeDef, - ValidationError -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - export const inboundSchema = ValidationError$inboundSchema; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - export const outboundSchema = ValidationError$outboundSchema; - /** @deprecated use `ValidationError$Outbound` instead. */ - export type Outbound = ValidationError$Outbound; -} - -export function validationErrorToJSON( - validationError: ValidationError, -): string { - return JSON.stringify(ValidationError$outboundSchema.parse(validationError)); -} - -export function validationErrorFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ValidationError$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ValidationError' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpclienterrors.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpclienterrors.ts deleted file mode 100644 index b34f61212..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpclienterrors.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Base class for all HTTP errors. - */ -export class HTTPClientError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - override name = "HTTPClientError"; - constructor(message: string, opts?: { cause?: unknown }) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - - super(msg, opts); - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } -} - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -export class UnexpectedClientError extends HTTPClientError { - override name = "UnexpectedClientError"; -} - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -export class InvalidRequestError extends HTTPClientError { - override name = "InvalidRequestError"; -} - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -export class RequestAbortedError extends HTTPClientError { - override readonly name = "RequestAbortedError"; -} - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -export class RequestTimeoutError extends HTTPClientError { - override readonly name = "RequestTimeoutError"; -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -export class ConnectionError extends HTTPClientError { - override readonly name = "ConnectionError"; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpvalidationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpvalidationerror.ts deleted file mode 100644 index d9a58dc8f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/httpvalidationerror.ts +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import * as components from "../components/index.js"; - -export type HTTPValidationErrorData = { - detail?: Array | undefined; -}; - -export class HTTPValidationError extends Error { - detail?: Array | undefined; - - /** The original data that was passed to this error instance. */ - data$: HTTPValidationErrorData; - - constructor(err: HTTPValidationErrorData) { - const message = "message" in err && typeof err.message === "string" - ? err.message - : `API error occurred: ${JSON.stringify(err)}`; - super(message); - this.data$ = err; - - if (err.detail != null) this.detail = err.detail; - - this.name = "HTTPValidationError"; - } -} - -/** @internal */ -export const HTTPValidationError$inboundSchema: z.ZodType< - HTTPValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), -}) - .transform((v) => { - return new HTTPValidationError(v); - }); - -/** @internal */ -export type HTTPValidationError$Outbound = { - detail?: Array | undefined; -}; - -/** @internal */ -export const HTTPValidationError$outboundSchema: z.ZodType< - HTTPValidationError$Outbound, - z.ZodTypeDef, - HTTPValidationError -> = z.instanceof(HTTPValidationError) - .transform(v => v.data$) - .pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional(), - })); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace HTTPValidationError$ { - /** @deprecated use `HTTPValidationError$inboundSchema` instead. */ - export const inboundSchema = HTTPValidationError$inboundSchema; - /** @deprecated use `HTTPValidationError$outboundSchema` instead. */ - export const outboundSchema = HTTPValidationError$outboundSchema; - /** @deprecated use `HTTPValidationError$Outbound` instead. */ - export type Outbound = HTTPValidationError$Outbound; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/index.ts deleted file mode 100644 index 8a5df29ef..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/index.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./httpclienterrors.js"; -export * from "./httpvalidationerror.js"; -export * from "./sdkerror.js"; -export * from "./sdkvalidationerror.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkerror.ts deleted file mode 100644 index 001f46592..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkerror.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export class SDKError extends Error { - public readonly statusCode: number; - public readonly contentType: string; - - constructor( - message: string, - public readonly rawResponse: Response, - public readonly body: string = "", - ) { - const statusCode = rawResponse.status; - const contentType = rawResponse.headers.get("content-type") || ""; - const bodyString = body.length > 0 ? `\n${body}` : ""; - - super( - `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`, - ); - - this.statusCode = statusCode; - this.contentType = contentType; - - this.name = "SDKError"; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkvalidationerror.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkvalidationerror.ts deleted file mode 100644 index 16929b9e5..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/models/errors/sdkvalidationerror.ts +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - public readonly rawValue: unknown; - - /** - * The raw message that failed validation. - */ - public readonly rawMessage: unknown; - - constructor(message: string, cause: unknown, rawValue: unknown) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - public pretty(): string { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage}\n${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } -} - -export function formatZodError(err: z.ZodError, level = 0): string { - let pre = " ".repeat(level); - pre = level > 0 ? `│${pre}` : pre; - pre += " ".repeat(level); - - let message = ""; - const append = (str: string) => (message += `\n${pre}${str}`); - - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - - if (len) { - append(`┌ ${headline}:`); - } - - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`│ • [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`│ Want: ${issue.expected}`); - append(`│ Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`│ Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`│ Allowed: ${issue.options.join(", ")}`); - append(`│ Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`│ Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len = issue.unionErrors.length; - append( - `│ ✖︎ Attemped to deserialize into one of ${len} union members:`, - ); - issue.unionErrors.forEach((err, i) => { - append(`│ ✖︎ Member ${i + 1} of ${len}`); - append(`${formatZodError(err, level + 1)}`); - }); - } - } - } - - if (err.issues.length) { - append(`└─*`); - } - - return message.slice(1); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/chat.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/chat.ts deleted file mode 100644 index 3ce441044..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/chat.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { chatComplete } from "../funcs/chatComplete.js"; -import { chatStream } from "../funcs/chatStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Chat extends ClientSDK { - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(chatStream( - this, - request, - options, - )); - } - - /** - * Chat Completion - */ - async complete( - request: components.ChatCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(chatComplete( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/fim.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/fim.ts deleted file mode 100644 index 782e0d65a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/fim.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { fimComplete } from "../funcs/fimComplete.js"; -import { fimStream } from "../funcs/fimStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Fim extends ClientSDK { - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(fimStream( - this, - request, - options, - )); - } - - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - async complete( - request: components.FIMCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fimComplete( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/index.ts deleted file mode 100644 index ecac22648..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./sdk.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/sdk.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/sdk.ts deleted file mode 100644 index 66090a130..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/sdk/sdk.ts +++ /dev/null @@ -1,129 +0,0 @@ -import { GoogleAuth } from "google-auth-library"; -import { SDKOptions } from "../lib/config.js"; -import { ClientSDK } from "../lib/sdks.js"; -import { Chat } from "./chat"; -import { Fim } from "./fim"; -import { SDKHooks } from "../hooks"; - -export type GoogleCloudOptions = { - /** The region of the Google Cloud AI Platform endpoint */ - region?: string; - projectId?: string; -} | { - /** The region of the Google Cloud AI Platform endpoint */ - region?: string; - apiKey: () => Promise; - projectId: string; -} - -const LEGACY_MODEL_ID_FORMAT: { [key: string]: string } = { - "codestral-2405": "codestral@2405", - "mistral-large-2407": "mistral-large@2407", - "mistral-nemo-2407": "mistral-nemo@2407", -}; - -function getModelInfo(model: string): [string, string] { - const modelId = LEGACY_MODEL_ID_FORMAT[model]; - if (modelId === undefined) { - return [model, model]; - } - model = model.split("-").slice(0, -1).join("-"); - return [model, modelId]; -} - -export class MistralGoogleCloud extends ClientSDK { - constructor(options: SDKOptions & GoogleCloudOptions = {}) { - let projectId = options.projectId ?? ""; - options.region = options.region ?? "europe-west4"; - options.serverURL = `https://${options.region}-aiplatform.googleapis.com`; - if (options.apiKey) { - if (!options.projectId) { - throw new Error("if apiKey is provided, projectId must also be provided to be able to use the Google Cloud API"); - } - } else { - const auth = new GoogleAuth({ - scopes: "https://www.googleapis.com/auth/cloud-platform", - }); - options.apiKey = async () => { - const authClient = await auth.getClient(); - const authHeaders = await authClient.getRequestHeaders(); - const token = authHeaders["Authorization"]; - if (!token) { - throw new Error("failed to get Google Cloud API key from the default authorization provider, check you are authenticated"); - } - - if (!options.projectId) { - if (!authHeaders["x-goog-user-project"]) { - throw new Error( - "no project id available in default google credentials. Please provide a project id in the input arguments to MistralGoogleCloud." - ); - } - projectId = authHeaders["x-goog-user-project"]; - } - return token; - } - } - - const hooks = new SDKHooks(); - - const superOptions: SDKOptions & { hooks?: SDKHooks } = options; - superOptions.hooks = hooks; - - super(options) - - hooks.registerBeforeCreateRequestHook({ - beforeCreateRequest: (_, input) => { - if (!projectId) { - throw new Error("projectId was not resolved by the auth hook"); - } - - if (!input.options?.body) { - throw new Error("Expected body"); - } - - let body: unknown = {}; - const bodyStream = input.options.body; - if (bodyStream) { - body = JSON.parse(bodyStream.toString()); - } - - if (typeof body !== "object" || !body) { - throw new Error("Expected object body"); - } - - const rawPredictType = input.url.pathname.includes("streamRawPredict") - ? "streamRawPredict" - : "rawPredict"; - - if (!("model" in body) || typeof body.model !== "string") { - throw new Error("body.model is required and must be a string"); - } - - const [model, modelId] = getModelInfo(body.model); - - if (!model || !modelId) { - throw new Error("model must be in the format 'model-version'"); - } - - input.url.pathname = `v1/projects/${projectId}/locations/${options.region}/publishers/mistralai/models/${modelId}:${rawPredictType}`; - - body.model = model - - input.options.body = JSON.stringify(body); - - return input; - }, - }); - } - - private _chat?: Chat; - get chat(): Chat { - return (this._chat ??= new Chat(this._options)); - } - - - private _fim?: Fim; - get fim(): Fim { - return (this._fim ??= new Fim(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/async.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/async.ts deleted file mode 100644 index 689dba5de..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/async.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type APICall = - | { - status: "complete"; - request: Request; - response: Response; - } - | { - status: "request-error"; - request: Request; - response?: undefined; - } - | { - status: "invalid"; - request?: undefined; - response?: undefined; - }; - -export class APIPromise implements Promise { - readonly #promise: Promise<[T, APICall]>; - readonly #unwrapped: Promise; - - readonly [Symbol.toStringTag] = "APIPromise"; - - constructor(p: [T, APICall] | Promise<[T, APICall]>) { - this.#promise = p instanceof Promise ? p : Promise.resolve(p); - this.#unwrapped = - p instanceof Promise - ? this.#promise.then(([value]) => value) - : Promise.resolve(p[0]); - } - - then( - onfulfilled?: - | ((value: T) => TResult1 | PromiseLike) - | null - | undefined, - onrejected?: - | ((reason: any) => TResult2 | PromiseLike) - | null - | undefined, - ): Promise { - return this.#promise.then( - onfulfilled ? ([value]) => onfulfilled(value) : void 0, - onrejected, - ); - } - - catch( - onrejected?: - | ((reason: any) => TResult | PromiseLike) - | null - | undefined, - ): Promise { - return this.#unwrapped.catch(onrejected); - } - - finally(onfinally?: (() => void) | null | undefined): Promise { - return this.#unwrapped.finally(onfinally); - } - - $inspect(): Promise<[T, APICall]> { - return this.#promise; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/blobs.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/blobs.ts deleted file mode 100644 index 4ce846023..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/blobs.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export const blobLikeSchema: z.ZodType = - z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true, - }); - -export function isBlobLike(val: unknown): val is Blob { - if (val instanceof Blob) { - return true; - } - - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - - return "stream" in val && typeof val.stream === "function"; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/constdatetime.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/constdatetime.ts deleted file mode 100644 index c0a4409c7..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/constdatetime.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function constDateTime( - val: string, -): z.ZodType { - return z.custom((v) => { - return ( - typeof v === "string" && new Date(v).getTime() === new Date(val).getTime() - ); - }, `Value must be equivelant to ${val}`); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/enums.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/enums.ts deleted file mode 100644 index 6fb6d9109..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/enums.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -declare const __brand: unique symbol; -export type Unrecognized = T & { [__brand]: "unrecognized" }; - -export function catchUnrecognizedEnum(value: T): Unrecognized { - return value as Unrecognized; -} - -type Prettify = { [K in keyof T]: T[K] } & {}; -export type ClosedEnum = T[keyof T]; -export type OpenEnum = - | Prettify - | Unrecognized; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/fp.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/fp.ts deleted file mode 100644 index ccbe51eac..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/fp.ts +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -export type Result = - | { ok: true; value: T; error?: never } - | { ok: false; value?: never; error: E }; - -export function OK(value: V): Result { - return { ok: true, value }; -} - -export function ERR(error: E): Result { - return { ok: false, error }; -} - -/** - * unwrap is a convenience function for extracting a value from a result or - * throwing if there was an error. - */ -export function unwrap(r: Result): T { - if (!r.ok) { - throw r.error; - } - return r.value; -} - -/** - * unwrapAsync is a convenience function for resolving a value from a Promise - * of a result or rejecting if an error occurred. - */ -export async function unwrapAsync( - pr: Promise>, -): Promise { - const r = await pr; - if (!r.ok) { - throw r.error; - } - - return r.value; -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/index.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/index.ts deleted file mode 100644 index e124e817b..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export { blobLikeSchema, isBlobLike } from "./blobs.js"; -export { catchUnrecognizedEnum } from "./enums.js"; -export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js"; -export type { Result } from "./fp.js"; -export type { PageIterator, Paginator } from "./operations.js"; -export { createPageIterator } from "./operations.js"; -export { RFCDate } from "./rfcdate.js"; diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/operations.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/operations.ts deleted file mode 100644 index beb81e10f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/operations.ts +++ /dev/null @@ -1,105 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { Result } from "./fp.js"; - -export type Paginator = () => Promise }> | null; - -export type PageIterator = V & { - next: Paginator; - [Symbol.asyncIterator]: () => AsyncIterableIterator; - "~next"?: PageState | undefined; -}; - -export function createPageIterator( - page: V & { next: Paginator }, - halt: (v: V) => boolean, -): { - [Symbol.asyncIterator]: () => AsyncIterableIterator; -} { - return { - [Symbol.asyncIterator]: async function* paginator() { - yield page; - if (halt(page)) { - return; - } - - let p: typeof page | null = page; - for (p = await p.next(); p != null; p = await p.next()) { - yield p; - if (halt(p)) { - return; - } - } - }, - }; -} - -/** - * This utility create a special iterator that yields a single value and - * terminates. It is useful in paginated SDK functions that have early return - * paths when things go wrong. - */ -export function haltIterator( - v: V, -): PageIterator { - return { - ...v, - next: () => null, - [Symbol.asyncIterator]: async function* paginator() { - yield v; - }, - }; -} - -/** - * Converts an async iterator of `Result` into an async iterator of `V`. - * When error results occur, the underlying error value is thrown. - */ -export async function unwrapResultIterator( - iteratorPromise: Promise, PageState>>, -): Promise> { - const resultIter = await iteratorPromise; - - if (!resultIter.ok) { - throw resultIter.error; - } - - return { - ...resultIter.value, - next: unwrapPaginator(resultIter.next), - "~next": resultIter["~next"], - [Symbol.asyncIterator]: async function* paginator() { - for await (const page of resultIter) { - if (!page.ok) { - throw page.error; - } - yield page.value; - } - }, - }; -} - -function unwrapPaginator( - paginator: Paginator>, -): Paginator { - return () => { - const nextResult = paginator(); - if (nextResult == null) { - return null; - } - return nextResult.then((res) => { - if (!res.ok) { - throw res.error; - } - const out = { - ...res.value, - next: unwrapPaginator(res.next), - }; - return out; - }); - }; -} - -export const URL_OVERRIDE = Symbol("URL_OVERRIDE"); diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/rfcdate.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/rfcdate.ts deleted file mode 100644 index c79b3f53a..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/rfcdate.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const dateRE = /^\d{4}-\d{2}-\d{2}$/; - -export class RFCDate { - private serialized: string; - - /** - * Creates a new RFCDate instance using today's date. - */ - static today(): RFCDate { - return new RFCDate(new Date()); - } - - /** - * Creates a new RFCDate instance using the provided input. - * If a string is used then in must be in the format YYYY-MM-DD. - * - * @param date A Date object or a date string in YYYY-MM-DD format - * @example - * new RFCDate("2022-01-01") - * @example - * new RFCDate(new Date()) - */ - constructor(date: Date | string) { - if (typeof date === "string" && !dateRE.test(date)) { - throw new RangeError( - "RFCDate: date strings must be in the format YYYY-MM-DD: " + date, - ); - } - - const value = new Date(date); - if (isNaN(+value)) { - throw new RangeError("RFCDate: invalid date provided: " + date); - } - - this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length); - if (!dateRE.test(this.serialized)) { - throw new TypeError( - `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`, - ); - } - } - - toJSON(): string { - return this.toString(); - } - - toString(): string { - return this.serialized; - } -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/streams.ts b/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/streams.ts deleted file mode 100644 index a0163e7a9..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/src/types/streams.ts +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export function isReadableStream( - val: unknown, -): val is ReadableStream { - if (typeof val !== "object" || val === null) { - return false; - } - - // Check for the presence of methods specific to ReadableStream - const stream = val as ReadableStream; - - // ReadableStream has methods like getReader, cancel, and tee - return ( - typeof stream.getReader === "function" && - typeof stream.cancel === "function" && - typeof stream.tee === "function" - ); -} diff --git a/examples/sdks/mistral-typescript/packages/mistralai-gcp/tsconfig.json b/examples/sdks/mistral-typescript/packages/mistralai-gcp/tsconfig.json deleted file mode 100644 index 94d81a34f..000000000 --- a/examples/sdks/mistral-typescript/packages/mistralai-gcp/tsconfig.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "compilerOptions": { - "incremental": true, - "tsBuildInfoFile": ".tsbuildinfo", - "target": "ES2020", - "lib": ["ES2022", "DOM", "DOM.Iterable"], - "jsx": "react-jsx", - - "module": "Node16", - "moduleResolution": "Node16", - - "allowJs": true, - - "declaration": true, - "declarationMap": true, - "sourceMap": true, - "outDir": ".", - - - // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json - "strict": true, - "allowUnusedLabels": false, - "allowUnreachableCode": false, - "exactOptionalPropertyTypes": true, - "useUnknownInCatchVariables": true, - "noFallthroughCasesInSwitch": true, - "noImplicitOverride": true, - "noImplicitReturns": true, - "noPropertyAccessFromIndexSignature": true, - "noUncheckedIndexedAccess": true, - "noUnusedLocals": true, - "noUnusedParameters": true, - "isolatedModules": true, - "checkJs": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true - }, - "include": ["src"], - "exclude": ["node_modules"] -} diff --git a/examples/sdks/mistral-typescript/scripts/run_examples.sh b/examples/sdks/mistral-typescript/scripts/run_examples.sh deleted file mode 100755 index 3b1ddb990..000000000 --- a/examples/sdks/mistral-typescript/scripts/run_examples.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/bash - -failed=0 - -for file in examples/src/*.ts; do - # Check if the file is not in the exclude list - if [ -f "$file" ] && [[ ! " ${exclude_files[@]} " =~ " $file " ]]; then - echo "Running $file" - # Run the script and capture the exit status - if npx tsx "$file" > /dev/null; then - echo "Success" - else - echo "Failed" - failed=1 - fi - else - echo "Skipped $file" - fi -done - -# If one of the example scripts failed, then exit -if [ $failed -ne 0 ]; then - exit 1 -fi diff --git a/examples/sdks/mistral-typescript/src/core.ts b/examples/sdks/mistral-typescript/src/core.ts deleted file mode 100644 index 85fe4293c..000000000 --- a/examples/sdks/mistral-typescript/src/core.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "./lib/sdks.js"; - -/** - * A minimal client to use when calling standalone SDK functions. Typically, an - * instance of this class would be instantiated once at the start of an - * application and passed around through some dependency injection mechanism to - * parts of an application that need to make SDK calls. - */ -export class MistralCore extends ClientSDK {} diff --git a/examples/sdks/mistral-typescript/src/extra/README.md b/examples/sdks/mistral-typescript/src/extra/README.md deleted file mode 100644 index a93742895..000000000 --- a/examples/sdks/mistral-typescript/src/extra/README.md +++ /dev/null @@ -1,52 +0,0 @@ -## Context - -The `src/extra` folder contains the custom logic which is too complex to be generated by Speakeasy from the OpenAPI specs. It was introduced to add the Structured Outputs feature. - -## Development / Contributing - -To add custom code in the SDK, you need to use [Speakeasy custom code regions](https://www.speakeasy.com/docs/customize/code/code-regions/overview) as below. - -### Runbook of SDK customization - -1. Add the code you want to import in the `src/extra/` folder. To have it importable from the SDK, don't forget the `export` statement. - - -2. Add a new custom code region in the SDK files, e.g in `src/sdk/chat.py`: -```ts -// #region imports -import { my_custom_function } from "../extra/my_custom_file.js"; -// #endregion imports - -export class Chat extends ClientSDK { - // #region sdk-class-body - async myMethod(param1: string): Promise { - const output = await my_custom_function(param1); - return output; - } - // #endregion sdk-class-body -} -``` - -3. Now build the SDK with the custom code: -```bash -npm run build -``` - -4. And now you should be able to call the custom method: -```ts -import { Mistral } from "@mistralai/mistralai"; - -const apiKey = process.env["MISTRAL_API_KEY"]; -const client = new Mistral({ apiKey: apiKey }); - -const response = await client.chat.myMethod("test"); -``` - -### Run the unit tests - -To run the unit tests for the `extra` package, you can run the following command from the root of the repository: -```bash -npm install --prefix tests -npm run build -(cd tests && npm test) -``` diff --git a/examples/sdks/mistral-typescript/src/extra/structChat.ts b/examples/sdks/mistral-typescript/src/extra/structChat.ts deleted file mode 100644 index 36cbf2784..000000000 --- a/examples/sdks/mistral-typescript/src/extra/structChat.ts +++ /dev/null @@ -1,81 +0,0 @@ -import { z } from 'zod'; -import { zodToJsonSchema } from "zod-to-json-schema"; -import { ResponseFormat } from "../models/components/responseformat.js"; -import * as components from "../models/components/index.js"; - -export function transformToChatCompletionRequest( - parsedRequest: ParsedChatCompletionRequest -): components.ChatCompletionRequest { - const { responseFormat, ...rest } = parsedRequest; - - // Transform responseFormat from z.ZodType to ResponseFormat - const transformedResponseFormat: ResponseFormat | undefined = responseFormatFromZodObject(responseFormat); - - return { - ...rest, - responseFormat: transformedResponseFormat, - }; -} - -export type ParsedChatCompletionRequest = Omit & { - responseFormat: T; -}; - -export type ParsedAssistantMessage = components.AssistantMessage & { - parsed?: z.infer | undefined; -} - -export type ParsedChatCompletionChoice = Omit & { - message?: ParsedAssistantMessage | undefined; -}; - -export type ParsedChatCompletionResponse = Omit & { - choices?: Array> | undefined; -}; - - -export function convertToParsedChatCompletionResponse(response: components.ChatCompletionResponse, responseFormat: T): ParsedChatCompletionResponse { - if (response.choices === undefined || response.choices.length === 0) { - return { - ...response, - choices: response.choices === undefined ? undefined : [], - }; - } - const parsedChoices: Array> = []; - for (const _choice of response.choices) { - if (_choice.message === null || typeof _choice.message === 'undefined') { - parsedChoices.push({..._choice, message: undefined}); - } else { - if (_choice.message.content !== null && typeof _choice.message.content !== 'undefined' && !Array.isArray(_choice.message.content)) { - parsedChoices.push({ - ..._choice, - message: { - ..._choice.message, - parsed: responseFormat.safeParse(JSON.parse(_choice.message.content)).data, - } - }); - } - } - } - return { - ...response, - choices: parsedChoices, - }; - -} - - // Function to convert Zod schema to strict JSON schema -export function responseFormatFromZodObject(responseFormat: T): ResponseFormat { - const responseJsonSchema = zodToJsonSchema(responseFormat); - // It is not possible to get the variable name of a Zod object at runtime in TypeScript so we're using a placeholder name. - // This has not impact on the parsing as the initial Zod object is used to parse the response. - const placeholderName = "placeholderName" - return { - type: "json_schema", - jsonSchema: { - name: placeholderName, - schemaDefinition: responseJsonSchema, - strict: true, - }, - }; -} \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/src/funcs/agentsComplete.ts b/examples/sdks/mistral-typescript/src/funcs/agentsComplete.ts deleted file mode 100644 index 89a1c91f0..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/agentsComplete.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Agents Completion - */ -export function agentsComplete( - client: MistralCore, - request: components.AgentsCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.AgentsCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.AgentsCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/agents/completions")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_completion_v1_agents_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ChatCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/agentsStream.ts b/examples/sdks/mistral-typescript/src/funcs/agentsStream.ts deleted file mode 100644 index ffeb18561..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/agentsStream.ts +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function agentsStream( - client: MistralCore, - request: components.AgentsCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.AgentsCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.AgentsCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/agents/completions#stream")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_agents", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - if (rawEvent.data === "[DONE]") return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsComplete.ts b/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsComplete.ts deleted file mode 100644 index 4aa71e6a8..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsComplete.ts +++ /dev/null @@ -1,206 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { appendForm } from "../lib/encodings.js"; -import { - getContentTypeFromFileName, - readableStreamToArrayBuffer, -} from "../lib/files.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { isBlobLike } from "../types/blobs.js"; -import { Result } from "../types/fp.js"; -import { isReadableStream } from "../types/streams.js"; - -/** - * Create Transcription - */ -export function audioTranscriptionsComplete( - client: MistralCore, - request: components.AudioTranscriptionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.TranscriptionResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.AudioTranscriptionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.TranscriptionResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.AudioTranscriptionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - - appendForm(body, "model", payload.model); - if (payload.file !== undefined) { - if (isBlobLike(payload.file)) { - appendForm(body, "file", payload.file); - } else if (isReadableStream(payload.file.content)) { - const buffer = await readableStreamToArrayBuffer(payload.file.content); - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "file", blob, payload.file.fileName); - } else { - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - appendForm( - body, - "file", - new Blob([payload.file.content], { type: contentType }), - payload.file.fileName, - ); - } - } - if (payload.file_id !== undefined) { - appendForm(body, "file_id", payload.file_id); - } - if (payload.file_url !== undefined) { - appendForm(body, "file_url", payload.file_url); - } - if (payload.language !== undefined) { - appendForm(body, "language", payload.language); - } - if (payload.stream !== undefined) { - appendForm(body, "stream", payload.stream); - } - if (payload.temperature !== undefined) { - appendForm(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== undefined) { - appendForm( - body, - "timestamp_granularities", - payload.timestamp_granularities, - ); - } - - const path = pathToFunc("/v1/audio/transcriptions")(); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.TranscriptionResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.TranscriptionResponse$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsStream.ts b/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsStream.ts deleted file mode 100644 index 26920b29a..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/audioTranscriptionsStream.ts +++ /dev/null @@ -1,220 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { appendForm } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import { - getContentTypeFromFileName, - readableStreamToArrayBuffer, -} from "../lib/files.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { isBlobLike } from "../types/blobs.js"; -import { Result } from "../types/fp.js"; -import { isReadableStream } from "../types/streams.js"; - -/** - * Create streaming transcription (SSE) - */ -export function audioTranscriptionsStream( - client: MistralCore, - request: components.AudioTranscriptionRequestStream, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.AudioTranscriptionRequestStream, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.AudioTranscriptionRequestStream$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - - appendForm(body, "model", payload.model); - if (payload.file !== undefined) { - if (isBlobLike(payload.file)) { - appendForm(body, "file", payload.file); - } else if (isReadableStream(payload.file.content)) { - const buffer = await readableStreamToArrayBuffer(payload.file.content); - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "file", blob, payload.file.fileName); - } else { - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - appendForm( - body, - "file", - new Blob([payload.file.content], { type: contentType }), - payload.file.fileName, - ); - } - } - if (payload.file_id !== undefined) { - appendForm(body, "file_id", payload.file_id); - } - if (payload.file_url !== undefined) { - appendForm(body, "file_url", payload.file_url); - } - if (payload.language !== undefined) { - appendForm(body, "language", payload.language); - } - if (payload.stream !== undefined) { - appendForm(body, "stream", payload.stream); - } - if (payload.temperature !== undefined) { - appendForm(body, "temperature", payload.temperature); - } - if (payload.timestamp_granularities !== undefined) { - appendForm( - body, - "timestamp_granularities", - payload.timestamp_granularities, - ); - } - - const path = pathToFunc("/v1/audio/transcriptions#stream")(); - - const headers = new Headers(compactMap({ - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "audio_api_v1_transcriptions_post_stream", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - EventStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - return { - value: components.TranscriptionStreamEvents$inboundSchema.parse( - rawEvent, - ), - }; - }); - }), - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/batchJobsCancel.ts b/examples/sdks/mistral-typescript/src/funcs/batchJobsCancel.ts deleted file mode 100644 index d912c7224..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/batchJobsCancel.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ -export function batchJobsCancel( - client: MistralCore, - request: operations.JobsApiRoutesBatchCancelBatchJobRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesBatchCancelBatchJobRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - job_id: encodeSimple("job_id", payload.job_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/batch/jobs/{job_id}/cancel")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_cancel_batch_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.BatchJobOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/batchJobsCreate.ts b/examples/sdks/mistral-typescript/src/funcs/batchJobsCreate.ts deleted file mode 100644 index e27a742ca..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/batchJobsCreate.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ -export function batchJobsCreate( - client: MistralCore, - request: components.BatchJobIn, - options?: RequestOptions, -): APIPromise< - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.BatchJobIn, - options?: RequestOptions, -): Promise< - [ - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.BatchJobIn$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/batch/jobs")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_create_batch_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.BatchJobOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/batchJobsGet.ts b/examples/sdks/mistral-typescript/src/funcs/batchJobsGet.ts deleted file mode 100644 index 5ff168e2d..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/batchJobsGet.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ -export function batchJobsGet( - client: MistralCore, - request: operations.JobsApiRoutesBatchGetBatchJobRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesBatchGetBatchJobRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - job_id: encodeSimple("job_id", payload.job_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/batch/jobs/{job_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.BatchJobOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.BatchJobOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/batchJobsList.ts b/examples/sdks/mistral-typescript/src/funcs/batchJobsList.ts deleted file mode 100644 index fa210aa89..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/batchJobsList.ts +++ /dev/null @@ -1,174 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ -export function batchJobsList( - client: MistralCore, - request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, - options?: RequestOptions, -): APIPromise< - Result< - components.BatchJobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, - options?: RequestOptions, -): Promise< - [ - Result< - components.BatchJobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.optional() - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const path = pathToFunc("/v1/batch/jobs")(); - - const query = encodeFormQuery({ - "agent_id": payload?.agent_id, - "created_after": payload?.created_after, - "created_by_me": payload?.created_by_me, - "metadata": payload?.metadata, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_batch_get_batch_jobs", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.BatchJobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.BatchJobsOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaAgentsCreate.ts b/examples/sdks/mistral-typescript/src/funcs/betaAgentsCreate.ts deleted file mode 100644 index 15bd4ac2d..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaAgentsCreate.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ -export function betaAgentsCreate( - client: MistralCore, - request: components.AgentCreationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.AgentCreationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.AgentCreationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/agents")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_create", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.Agent$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaAgentsGet.ts b/examples/sdks/mistral-typescript/src/funcs/betaAgentsGet.ts deleted file mode 100644 index 75d88855d..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaAgentsGet.ts +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ -export function betaAgentsGet( - client: MistralCore, - request: operations.AgentsApiV1AgentsGetRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1AgentsGetRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1AgentsGetRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - agent_id: encodeSimple("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/agents/{agent_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_get", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.Agent$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaAgentsList.ts b/examples/sdks/mistral-typescript/src/funcs/betaAgentsList.ts deleted file mode 100644 index c4d59cd01..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaAgentsList.ts +++ /dev/null @@ -1,179 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ -export function betaAgentsList( - client: MistralCore, - request?: operations.AgentsApiV1AgentsListRequest | undefined, - options?: RequestOptions, -): APIPromise< - Result< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request?: operations.AgentsApiV1AgentsListRequest | undefined, - options?: RequestOptions, -): Promise< - [ - Result< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1AgentsListRequest$outboundSchema.optional().parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const path = pathToFunc("/v1/agents")(); - - const query = encodeFormQuery({ - "page": payload?.page, - "page_size": payload?.page_size, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_list", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, z.array(components.Agent$inboundSchema)), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdate.ts b/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdate.ts deleted file mode 100644 index 8de070e94..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdate.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ -export function betaAgentsUpdate( - client: MistralCore, - request: operations.AgentsApiV1AgentsUpdateRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1AgentsUpdateRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1AgentsUpdateRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.AgentUpdateRequest, { - explode: true, - }); - - const pathParams = { - agent_id: encodeSimple("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/agents/{agent_id}")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.Agent$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdateVersion.ts b/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdateVersion.ts deleted file mode 100644 index c0d8c32da..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaAgentsUpdateVersion.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ -export function betaAgentsUpdateVersion( - client: MistralCore, - request: operations.AgentsApiV1AgentsUpdateVersionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1AgentsUpdateVersionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - agent_id: encodeSimple("agent_id", payload.agent_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/agents/{agent_id}/version")(pathParams); - - const query = encodeFormQuery({ - "version": payload.version, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_agents_update_version", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.Agent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.Agent$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppend.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppend.ts deleted file mode 100644 index bc9675ec5..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppend.ts +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ -export function betaConversationsAppend( - client: MistralCore, - request: operations.AgentsApiV1ConversationsAppendRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsAppendRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsAppendRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ConversationAppendRequest, { - explode: true, - }); - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ConversationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppendStream.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppendStream.ts deleted file mode 100644 index 2e556abd1..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsAppendStream.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ -export function betaConversationsAppendStream( - client: MistralCore, - request: operations.AgentsApiV1ConversationsAppendStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsAppendStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsAppendStreamRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ConversationAppendStreamRequest, { - explode: true, - }); - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}#stream")( - pathParams, - ); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_append_stream", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGet.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsGet.ts deleted file mode 100644 index 1ad295932..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGet.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ -export function betaConversationsGet( - client: MistralCore, - request: operations.AgentsApiV1ConversationsGetRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsGetRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsGetRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_get", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - operations.AgentsApiV1ConversationsGetResponseV1ConversationsGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema, - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetHistory.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetHistory.ts deleted file mode 100644 index b2c028f33..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetHistory.ts +++ /dev/null @@ -1,181 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ -export function betaConversationsGetHistory( - client: MistralCore, - request: operations.AgentsApiV1ConversationsHistoryRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ConversationHistory, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsHistoryRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ConversationHistory, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}/history")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_history", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ConversationHistory, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ConversationHistory$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetMessages.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetMessages.ts deleted file mode 100644 index aa8c5f77f..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsGetMessages.ts +++ /dev/null @@ -1,181 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ -export function betaConversationsGetMessages( - client: MistralCore, - request: operations.AgentsApiV1ConversationsMessagesRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ConversationMessages, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsMessagesRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ConversationMessages, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}/messages")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_messages", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ConversationMessages, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ConversationMessages$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsList.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsList.ts deleted file mode 100644 index eea6e1941..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsList.ts +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ -export function betaConversationsList( - client: MistralCore, - request?: operations.AgentsApiV1ConversationsListRequest | undefined, - options?: RequestOptions, -): APIPromise< - Result< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request?: operations.AgentsApiV1ConversationsListRequest | undefined, - options?: RequestOptions, -): Promise< - [ - Result< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsListRequest$outboundSchema.optional() - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const path = pathToFunc("/v1/conversations")(); - - const query = encodeFormQuery({ - "page": payload?.page, - "page_size": payload?.page_size, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_list", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - Array, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, z.array(operations.ResponseBody$inboundSchema)), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestart.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestart.ts deleted file mode 100644 index aaf4f349a..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestart.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ -export function betaConversationsRestart( - client: MistralCore, - request: operations.AgentsApiV1ConversationsRestartRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsRestartRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsRestartRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ConversationRestartRequest, { - explode: true, - }); - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}/restart")( - pathParams, - ); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ConversationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestartStream.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestartStream.ts deleted file mode 100644 index 60caa8e38..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsRestartStream.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ -export function betaConversationsRestartStream( - client: MistralCore, - request: operations.AgentsApiV1ConversationsRestartStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.AgentsApiV1ConversationsRestartStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.AgentsApiV1ConversationsRestartStreamRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.ConversationRestartStreamRequest, { - explode: true, - }); - - const pathParams = { - conversation_id: encodeSimple("conversation_id", payload.conversation_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/conversations/{conversation_id}/restart#stream")( - pathParams, - ); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_restart_stream", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsStart.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsStart.ts deleted file mode 100644 index f139155fc..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsStart.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ -export function betaConversationsStart( - client: MistralCore, - request: components.ConversationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ConversationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ConversationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/conversations")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ConversationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ConversationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaConversationsStartStream.ts b/examples/sdks/mistral-typescript/src/funcs/betaConversationsStartStream.ts deleted file mode 100644 index 8be033d29..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaConversationsStartStream.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ -export function betaConversationsStartStream( - client: MistralCore, - request: components.ConversationStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ConversationStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ConversationStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/conversations#stream")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "agents_api_v1_conversations_start_stream", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - return { - value: components.ConversationEvents$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesDelete.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesDelete.ts deleted file mode 100644 index 29ada67d8..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesDelete.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ -export function betaLibrariesAccessesDelete( - client: MistralCore, - request: operations.LibrariesShareDeleteV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesShareDeleteV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesShareDeleteV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.SharingDelete, { explode: true }); - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/share")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_delete_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.SharingOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesList.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesList.ts deleted file mode 100644 index a29766bbe..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesList.ts +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ -export function betaLibrariesAccessesList( - client: MistralCore, - request: operations.LibrariesShareListV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.ListSharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesShareListV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.ListSharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesShareListV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/share")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_list_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ListSharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ListSharingOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesUpdateOrCreate.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesUpdateOrCreate.ts deleted file mode 100644 index 66e858869..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesAccessesUpdateOrCreate.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ -export function betaLibrariesAccessesUpdateOrCreate( - client: MistralCore, - request: operations.LibrariesShareCreateV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesShareCreateV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesShareCreateV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.SharingIn, { explode: true }); - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/share")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_share_create_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.SharingOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.SharingOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesCreate.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesCreate.ts deleted file mode 100644 index f26654c72..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesCreate.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ -export function betaLibrariesCreate( - client: MistralCore, - request: components.LibraryIn, - options?: RequestOptions, -): APIPromise< - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.LibraryIn, - options?: RequestOptions, -): Promise< - [ - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.LibraryIn$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/libraries")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_create_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(201, components.LibraryOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDelete.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDelete.ts deleted file mode 100644 index e0d79dda1..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDelete.ts +++ /dev/null @@ -1,176 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ -export function betaLibrariesDelete( - client: MistralCore, - request: operations.LibrariesDeleteV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDeleteV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => operations.LibrariesDeleteV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_delete_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.LibraryOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsDelete.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsDelete.ts deleted file mode 100644 index 9ffebaf72..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsDelete.ts +++ /dev/null @@ -1,183 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ -export function betaLibrariesDocumentsDelete( - client: MistralCore, - request: operations.LibrariesDocumentsDeleteV1Request, - options?: RequestOptions, -): APIPromise< - Result< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsDeleteV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsDeleteV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/documents/{document_id}")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_delete_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.nil(204, z.void()), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts deleted file mode 100644 index d54c89d55..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsExtractedTextSignedUrl.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ -export function betaLibrariesDocumentsExtractedTextSignedUrl( - client: MistralCore, - request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - options?: RequestOptions, -): APIPromise< - Result< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations - .LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc( - "/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url", - )(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_extracted_text_signed_url_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, z.string()), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGet.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGet.ts deleted file mode 100644 index 12c0011f8..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGet.ts +++ /dev/null @@ -1,183 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ -export function betaLibrariesDocumentsGet( - client: MistralCore, - request: operations.LibrariesDocumentsGetV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsGetV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsGetV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/documents/{document_id}")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.DocumentOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGetSignedUrl.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGetSignedUrl.ts deleted file mode 100644 index 0bd0ceb4d..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsGetSignedUrl.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ -export function betaLibrariesDocumentsGetSignedUrl( - client: MistralCore, - request: operations.LibrariesDocumentsGetSignedUrlV1Request, - options?: RequestOptions, -): APIPromise< - Result< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsGetSignedUrlV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc( - "/v1/libraries/{library_id}/documents/{document_id}/signed-url", - )(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_signed_url_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - string, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, z.string()), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsList.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsList.ts deleted file mode 100644 index 0cc6bd3a9..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsList.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ -export function betaLibrariesDocumentsList( - client: MistralCore, - request: operations.LibrariesDocumentsListV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.ListDocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsListV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.ListDocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsListV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/documents")(pathParams); - - const query = encodeFormQuery({ - "page": payload.page, - "page_size": payload.page_size, - "search": payload.search, - "sort_by": payload.sort_by, - "sort_order": payload.sort_order, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_list_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ListDocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ListDocumentOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsReprocess.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsReprocess.ts deleted file mode 100644 index 66bc4f332..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsReprocess.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ -export function betaLibrariesDocumentsReprocess( - client: MistralCore, - request: operations.LibrariesDocumentsReprocessV1Request, - options?: RequestOptions, -): APIPromise< - Result< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsReprocessV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsReprocessV1Request$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc( - "/v1/libraries/{library_id}/documents/{document_id}/reprocess", - )(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_reprocess_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - void, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.nil(204, z.void()), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsStatus.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsStatus.ts deleted file mode 100644 index e01b2f441..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsStatus.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ -export function betaLibrariesDocumentsStatus( - client: MistralCore, - request: operations.LibrariesDocumentsGetStatusV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.ProcessingStatusOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsGetStatusV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.ProcessingStatusOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsGetStatusV1Request$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc( - "/v1/libraries/{library_id}/documents/{document_id}/status", - )(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_status_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ProcessingStatusOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ProcessingStatusOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsTextContent.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsTextContent.ts deleted file mode 100644 index 378bd3d83..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsTextContent.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ -export function betaLibrariesDocumentsTextContent( - client: MistralCore, - request: operations.LibrariesDocumentsGetTextContentV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.DocumentTextContent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsGetTextContentV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.DocumentTextContent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc( - "/v1/libraries/{library_id}/documents/{document_id}/text_content", - )(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_get_text_content_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.DocumentTextContent, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.DocumentTextContent$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpdate.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpdate.ts deleted file mode 100644 index f69f3ed79..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpdate.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ -export function betaLibrariesDocumentsUpdate( - client: MistralCore, - request: operations.LibrariesDocumentsUpdateV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsUpdateV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsUpdateV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.DocumentUpdateIn, { explode: true }); - - const pathParams = { - document_id: encodeSimple("document_id", payload.document_id, { - explode: false, - charEncoding: "percent", - }), - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/documents/{document_id}")( - pathParams, - ); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_update_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.DocumentOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpload.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpload.ts deleted file mode 100644 index 2d8989c5f..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesDocumentsUpload.ts +++ /dev/null @@ -1,206 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { appendForm, encodeSimple } from "../lib/encodings.js"; -import { - getContentTypeFromFileName, - readableStreamToArrayBuffer, -} from "../lib/files.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { isBlobLike } from "../types/blobs.js"; -import { Result } from "../types/fp.js"; -import { isReadableStream } from "../types/streams.js"; - -/** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ -export function betaLibrariesDocumentsUpload( - client: MistralCore, - request: operations.LibrariesDocumentsUploadV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesDocumentsUploadV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.LibrariesDocumentsUploadV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - - if (isBlobLike(payload.RequestBody.file)) { - appendForm(body, "file", payload.RequestBody.file); - } else if (isReadableStream(payload.RequestBody.file.content)) { - const buffer = await readableStreamToArrayBuffer( - payload.RequestBody.file.content, - ); - const contentType = - getContentTypeFromFileName(payload.RequestBody.file.fileName) - || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "file", blob, payload.RequestBody.file.fileName); - } else { - const contentType = - getContentTypeFromFileName(payload.RequestBody.file.fileName) - || "application/octet-stream"; - appendForm( - body, - "file", - new Blob([payload.RequestBody.file.content], { type: contentType }), - payload.RequestBody.file.fileName, - ); - } - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}/documents")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_documents_upload_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.DocumentOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json([200, 201], components.DocumentOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesGet.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesGet.ts deleted file mode 100644 index bf0da54e0..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesGet.ts +++ /dev/null @@ -1,176 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ -export function betaLibrariesGet( - client: MistralCore, - request: operations.LibrariesGetV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesGetV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => operations.LibrariesGetV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_get_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.LibraryOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesList.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesList.ts deleted file mode 100644 index f319ca306..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesList.ts +++ /dev/null @@ -1,142 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ -export function betaLibrariesList( - client: MistralCore, - options?: RequestOptions, -): APIPromise< - Result< - components.ListLibraryOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - options, - )); -} - -async function $do( - client: MistralCore, - options?: RequestOptions, -): Promise< - [ - Result< - components.ListLibraryOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const path = pathToFunc("/v1/libraries")(); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_list_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.ListLibraryOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ListLibraryOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesUpdate.ts b/examples/sdks/mistral-typescript/src/funcs/betaLibrariesUpdate.ts deleted file mode 100644 index e51ca6b16..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/betaLibrariesUpdate.ts +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ -export function betaLibrariesUpdate( - client: MistralCore, - request: operations.LibrariesUpdateV1Request, - options?: RequestOptions, -): APIPromise< - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.LibrariesUpdateV1Request, - options?: RequestOptions, -): Promise< - [ - Result< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => operations.LibrariesUpdateV1Request$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.LibraryInUpdate, { explode: true }); - - const pathParams = { - library_id: encodeSimple("library_id", payload.library_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/libraries/{library_id}")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "libraries_update_v1", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PUT", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.LibraryOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.LibraryOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/chatComplete.ts b/examples/sdks/mistral-typescript/src/funcs/chatComplete.ts deleted file mode 100644 index a87f35c06..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/chatComplete.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Chat Completion - */ -export function chatComplete( - client: MistralCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ChatCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ChatCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/chat/completions")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_completion_v1_chat_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ChatCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ChatCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/chatStream.ts b/examples/sdks/mistral-typescript/src/funcs/chatStream.ts deleted file mode 100644 index d193c69a9..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/chatStream.ts +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function chatStream( - client: MistralCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.ChatCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/chat/completions#stream")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_chat", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - if (rawEvent.data === "[DONE]") return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/classifiersClassify.ts b/examples/sdks/mistral-typescript/src/funcs/classifiersClassify.ts deleted file mode 100644 index 1be8b78bb..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/classifiersClassify.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Classifications - */ -export function classifiersClassify( - client: MistralCore, - request: components.ClassificationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ClassificationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ClassificationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/classifications")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "classifications_v1_classifications_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ClassificationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/classifiersClassifyChat.ts b/examples/sdks/mistral-typescript/src/funcs/classifiersClassifyChat.ts deleted file mode 100644 index 3836a5c33..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/classifiersClassifyChat.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Chat Classifications - */ -export function classifiersClassifyChat( - client: MistralCore, - request: components.ChatClassificationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ChatClassificationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ChatClassificationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/chat/classifications")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_classifications_v1_chat_classifications_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ClassificationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ClassificationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/classifiersModerate.ts b/examples/sdks/mistral-typescript/src/funcs/classifiersModerate.ts deleted file mode 100644 index 445675f9b..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/classifiersModerate.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Moderations - */ -export function classifiersModerate( - client: MistralCore, - request: components.ClassificationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ClassificationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ClassificationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/moderations")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "moderations_v1_moderations_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ModerationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/classifiersModerateChat.ts b/examples/sdks/mistral-typescript/src/funcs/classifiersModerateChat.ts deleted file mode 100644 index 5f4ef8971..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/classifiersModerateChat.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Chat Moderations - */ -export function classifiersModerateChat( - client: MistralCore, - request: components.ChatModerationRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.ChatModerationRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.ChatModerationRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/chat/moderations")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "chat_moderations_v1_chat_moderations_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ModerationResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ModerationResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/embeddingsCreate.ts b/examples/sdks/mistral-typescript/src/funcs/embeddingsCreate.ts deleted file mode 100644 index 2e8c335ae..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/embeddingsCreate.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Embeddings - * - * @remarks - * Embeddings - */ -export function embeddingsCreate( - client: MistralCore, - request: components.EmbeddingRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.EmbeddingResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.EmbeddingRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.EmbeddingResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.EmbeddingRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/embeddings")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "embeddings_v1_embeddings_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.EmbeddingResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.EmbeddingResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesDelete.ts b/examples/sdks/mistral-typescript/src/funcs/filesDelete.ts deleted file mode 100644 index 0529ce6d0..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesDelete.ts +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Delete File - * - * @remarks - * Delete a file. - */ -export function filesDelete( - client: MistralCore, - request: operations.FilesApiRoutesDeleteFileRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.DeleteFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.FilesApiRoutesDeleteFileRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.DeleteFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesDeleteFileRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - file_id: encodeSimple("file_id", payload.file_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/files/{file_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_delete_file", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.DeleteFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.DeleteFileOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesDownload.ts b/examples/sdks/mistral-typescript/src/funcs/filesDownload.ts deleted file mode 100644 index 3275313bc..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesDownload.ts +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Download File - * - * @remarks - * Download a file - */ -export function filesDownload( - client: MistralCore, - request: operations.FilesApiRoutesDownloadFileRequest, - options?: RequestOptions, -): APIPromise< - Result< - ReadableStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.FilesApiRoutesDownloadFileRequest, - options?: RequestOptions, -): Promise< - [ - Result< - ReadableStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesDownloadFileRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - file_id: encodeSimple("file_id", payload.file_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/files/{file_id}/content")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/octet-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_download_file", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - ReadableStream, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.stream(200, z.instanceof(ReadableStream)), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesGetSignedUrl.ts b/examples/sdks/mistral-typescript/src/funcs/filesGetSignedUrl.ts deleted file mode 100644 index fd5ea3c4d..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesGetSignedUrl.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Get Signed Url - */ -export function filesGetSignedUrl( - client: MistralCore, - request: operations.FilesApiRoutesGetSignedUrlRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.FileSignedURL, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.FilesApiRoutesGetSignedUrlRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.FileSignedURL, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - file_id: encodeSimple("file_id", payload.file_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/files/{file_id}/url")(pathParams); - - const query = encodeFormQuery({ - "expiry": payload.expiry, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_get_signed_url", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.FileSignedURL, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.FileSignedURL$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesList.ts b/examples/sdks/mistral-typescript/src/funcs/filesList.ts deleted file mode 100644 index 941257111..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesList.ts +++ /dev/null @@ -1,173 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ -export function filesList( - client: MistralCore, - request?: operations.FilesApiRoutesListFilesRequest | undefined, - options?: RequestOptions, -): APIPromise< - Result< - components.ListFilesOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request?: operations.FilesApiRoutesListFilesRequest | undefined, - options?: RequestOptions, -): Promise< - [ - Result< - components.ListFilesOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesListFilesRequest$outboundSchema.optional().parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const path = pathToFunc("/v1/files")(); - - const query = encodeFormQuery({ - "page": payload?.page, - "page_size": payload?.page_size, - "purpose": payload?.purpose, - "sample_type": payload?.sample_type, - "search": payload?.search, - "source": payload?.source, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_list_files", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.ListFilesOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ListFilesOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesRetrieve.ts b/examples/sdks/mistral-typescript/src/funcs/filesRetrieve.ts deleted file mode 100644 index 48676206e..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesRetrieve.ts +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ -export function filesRetrieve( - client: MistralCore, - request: operations.FilesApiRoutesRetrieveFileRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.RetrieveFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.FilesApiRoutesRetrieveFileRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.RetrieveFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesRetrieveFileRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - file_id: encodeSimple("file_id", payload.file_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/files/{file_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_retrieve_file", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.RetrieveFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.RetrieveFileOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/filesUpload.ts b/examples/sdks/mistral-typescript/src/funcs/filesUpload.ts deleted file mode 100644 index c81d2a744..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/filesUpload.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { appendForm } from "../lib/encodings.js"; -import { - getContentTypeFromFileName, - readableStreamToArrayBuffer, -} from "../lib/files.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { isBlobLike } from "../types/blobs.js"; -import { Result } from "../types/fp.js"; -import { isReadableStream } from "../types/streams.js"; - -/** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ -export function filesUpload( - client: MistralCore, - request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, - options?: RequestOptions, -): APIPromise< - Result< - components.UploadFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, - options?: RequestOptions, -): Promise< - [ - Result< - components.UploadFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = new FormData(); - - if (isBlobLike(payload.file)) { - appendForm(body, "file", payload.file); - } else if (isReadableStream(payload.file.content)) { - const buffer = await readableStreamToArrayBuffer(payload.file.content); - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "file", blob, payload.file.fileName); - } else { - const contentType = getContentTypeFromFileName(payload.file.fileName) - || "application/octet-stream"; - appendForm( - body, - "file", - new Blob([payload.file.content], { type: contentType }), - payload.file.fileName, - ); - } - if (payload.purpose !== undefined) { - appendForm(body, "purpose", payload.purpose); - } - - const path = pathToFunc("/v1/files")(); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "files_api_routes_upload_file", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.UploadFileOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.UploadFileOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fimComplete.ts b/examples/sdks/mistral-typescript/src/funcs/fimComplete.ts deleted file mode 100644 index e1e0ee382..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fimComplete.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Fim Completion - * - * @remarks - * FIM completion. - */ -export function fimComplete( - client: MistralCore, - request: components.FIMCompletionRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.FIMCompletionRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.FIMCompletionRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/fim/completions")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "fim_completion_v1_fim_completions_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.FIMCompletionResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.FIMCompletionResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fimStream.ts b/examples/sdks/mistral-typescript/src/funcs/fimStream.ts deleted file mode 100644 index 9819a9671..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fimStream.ts +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import { EventStream } from "../lib/event-streams.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ -export function fimStream( - client: MistralCore, - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, -): APIPromise< - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, -): Promise< - [ - Result< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - components.FIMCompletionStreamRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/fim/completions#stream")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "text/event-stream", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "stream_fim", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - EventStream, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.sse( - 200, - z.instanceof(ReadableStream).transform(stream => { - return new EventStream(stream, rawEvent => { - if (rawEvent.data === "[DONE]") return { done: true }; - return { - value: components.CompletionEvent$inboundSchema.parse(rawEvent), - }; - }); - }), - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCancel.ts b/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCancel.ts deleted file mode 100644 index 2ec150df0..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCancel.ts +++ /dev/null @@ -1,174 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ -export function fineTuningJobsCancel( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations - .JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - job_id: encodeSimple("job_id", payload.job_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/jobs/{job_id}/cancel")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_cancel_fine_tuning_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - operations.JobsApiRoutesFineTuningCancelFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema, - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCreate.ts b/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCreate.ts deleted file mode 100644 index b2720c0a4..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsCreate.ts +++ /dev/null @@ -1,165 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ -export function fineTuningJobsCreate( - client: MistralCore, - request: components.JobIn, - options?: RequestOptions, -): APIPromise< - Result< - operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.JobIn, - options?: RequestOptions, -): Promise< - [ - Result< - operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.JobIn$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/fine_tuning/jobs")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_create_fine_tuning_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - operations.JobsApiRoutesFineTuningCreateFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema, - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsGet.ts b/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsGet.ts deleted file mode 100644 index 2bcc637f6..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsGet.ts +++ /dev/null @@ -1,171 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ -export function fineTuningJobsGet( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.JobsApiRoutesFineTuningGetFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.JobsApiRoutesFineTuningGetFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - job_id: encodeSimple("job_id", payload.job_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/jobs/{job_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - operations.JobsApiRoutesFineTuningGetFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations.JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema, - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsList.ts b/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsList.ts deleted file mode 100644 index 349b2cb28..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsList.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ -export function fineTuningJobsList( - client: MistralCore, - request?: - | operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest - | undefined, - options?: RequestOptions, -): APIPromise< - Result< - components.JobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request?: - | operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest - | undefined, - options?: RequestOptions, -): Promise< - [ - Result< - components.JobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema - .optional().parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const path = pathToFunc("/v1/fine_tuning/jobs")(); - - const query = encodeFormQuery({ - "created_after": payload?.created_after, - "created_before": payload?.created_before, - "created_by_me": payload?.created_by_me, - "model": payload?.model, - "page": payload?.page, - "page_size": payload?.page_size, - "status": payload?.status, - "suffix": payload?.suffix, - "wandb_name": payload?.wandb_name, - "wandb_project": payload?.wandb_project, - }); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_get_fine_tuning_jobs", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - query: query, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.JobsOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.JobsOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsStart.ts b/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsStart.ts deleted file mode 100644 index ba1f29e68..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/fineTuningJobsStart.ts +++ /dev/null @@ -1,172 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ -export function fineTuningJobsStart( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.JobsApiRoutesFineTuningStartFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.JobsApiRoutesFineTuningStartFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - job_id: encodeSimple("job_id", payload.job_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/jobs/{job_id}/start")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_start_fine_tuning_job", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - operations.JobsApiRoutesFineTuningStartFineTuningJobResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema, - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsArchive.ts b/examples/sdks/mistral-typescript/src/funcs/modelsArchive.ts deleted file mode 100644 index cc7a4afc9..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsArchive.ts +++ /dev/null @@ -1,172 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ -export function modelsArchive( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.ArchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.ArchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations - .JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - model_id: encodeSimple("model_id", payload.model_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/models/{model_id}/archive")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_archive_fine_tuned_model", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.ArchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ArchiveFTModelOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsDelete.ts b/examples/sdks/mistral-typescript/src/funcs/modelsDelete.ts deleted file mode 100644 index 1e4230f3e..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsDelete.ts +++ /dev/null @@ -1,179 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ -export function modelsDelete( - client: MistralCore, - request: operations.DeleteModelV1ModelsModelIdDeleteRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.DeleteModelOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.DeleteModelV1ModelsModelIdDeleteRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.DeleteModelOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - model_id: encodeSimple("model_id", payload.model_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/models/{model_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "delete_model_v1_models__model_id__delete", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.DeleteModelOut, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.DeleteModelOut$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsList.ts b/examples/sdks/mistral-typescript/src/funcs/modelsList.ts deleted file mode 100644 index bef689861..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsList.ts +++ /dev/null @@ -1,151 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * List Models - * - * @remarks - * List all models available to the user. - */ -export function modelsList( - client: MistralCore, - options?: RequestOptions, -): APIPromise< - Result< - components.ModelList, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - options, - )); -} - -async function $do( - client: MistralCore, - options?: RequestOptions, -): Promise< - [ - Result< - components.ModelList, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const path = pathToFunc("/v1/models")(); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "list_models_v1_models_get", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.ModelList, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.ModelList$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsRetrieve.ts b/examples/sdks/mistral-typescript/src/funcs/modelsRetrieve.ts deleted file mode 100644 index 3d4604c77..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsRetrieve.ts +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ -export function modelsRetrieve( - client: MistralCore, - request: operations.RetrieveModelV1ModelsModelIdGetRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.RetrieveModelV1ModelsModelIdGetRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations.RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse( - value, - ), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - model_id: encodeSimple("model_id", payload.model_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/models/{model_id}")(pathParams); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "retrieve_model_v1_models__model_id__get", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "GET", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema, - ), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsUnarchive.ts b/examples/sdks/mistral-typescript/src/funcs/modelsUnarchive.ts deleted file mode 100644 index d6e0968a6..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsUnarchive.ts +++ /dev/null @@ -1,172 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ -export function modelsUnarchive( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.UnarchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.UnarchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations - .JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = null; - - const pathParams = { - model_id: encodeSimple("model_id", payload.model_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/models/{model_id}/archive")( - pathParams, - ); - - const headers = new Headers(compactMap({ - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_unarchive_fine_tuned_model", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "DELETE", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - components.UnarchiveFTModelOut, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.UnarchiveFTModelOut$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/modelsUpdate.ts b/examples/sdks/mistral-typescript/src/funcs/modelsUpdate.ts deleted file mode 100644 index b5752ce70..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/modelsUpdate.ts +++ /dev/null @@ -1,174 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON, encodeSimple } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import * as operations from "../models/operations/index.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ -export function modelsUpdate( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - options?: RequestOptions, -): APIPromise< - Result< - operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - options?: RequestOptions, -): Promise< - [ - Result< - operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => - operations - .JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema - .parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload.UpdateFTModelIn, { explode: true }); - - const pathParams = { - model_id: encodeSimple("model_id", payload.model_id, { - explode: false, - charEncoding: "percent", - }), - }; - - const path = pathToFunc("/v1/fine_tuning/models/{model_id}")(pathParams); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "jobs_api_routes_fine_tuning_update_fine_tuned_model", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "PATCH", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const [result] = await M.match< - operations.JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json( - 200, - operations - .JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema, - ), - M.fail("4XX"), - M.fail("5XX"), - )(response, req); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/funcs/ocrProcess.ts b/examples/sdks/mistral-typescript/src/funcs/ocrProcess.ts deleted file mode 100644 index 6739d3017..000000000 --- a/examples/sdks/mistral-typescript/src/funcs/ocrProcess.ts +++ /dev/null @@ -1,166 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralCore } from "../core.js"; -import { encodeJSON } from "../lib/encodings.js"; -import * as M from "../lib/matchers.js"; -import { compactMap } from "../lib/primitives.js"; -import { safeParse } from "../lib/schemas.js"; -import { RequestOptions } from "../lib/sdks.js"; -import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; -import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import * as errors from "../models/errors/index.js"; -import { MistralError } from "../models/errors/mistralerror.js"; -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { APICall, APIPromise } from "../types/async.js"; -import { Result } from "../types/fp.js"; - -/** - * OCR - */ -export function ocrProcess( - client: MistralCore, - request: components.OCRRequest, - options?: RequestOptions, -): APIPromise< - Result< - components.OCRResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - > -> { - return new APIPromise($do( - client, - request, - options, - )); -} - -async function $do( - client: MistralCore, - request: components.OCRRequest, - options?: RequestOptions, -): Promise< - [ - Result< - components.OCRResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >, - APICall, - ] -> { - const parsed = safeParse( - request, - (value) => components.OCRRequest$outboundSchema.parse(value), - "Input validation failed", - ); - if (!parsed.ok) { - return [parsed, { status: "invalid" }]; - } - const payload = parsed.value; - const body = encodeJSON("body", payload, { explode: true }); - - const path = pathToFunc("/v1/ocr")(); - - const headers = new Headers(compactMap({ - "Content-Type": "application/json", - Accept: "application/json", - })); - - const secConfig = await extractSecurity(client._options.apiKey); - const securityInput = secConfig == null ? {} : { apiKey: secConfig }; - const requestSecurity = resolveGlobalSecurity(securityInput); - - const context = { - options: client._options, - baseURL: options?.serverURL ?? client._baseURL ?? "", - operationID: "ocr_v1_ocr_post", - oAuth2Scopes: [], - - resolvedSecurity: requestSecurity, - - securitySource: client._options.apiKey, - retryConfig: options?.retries - || client._options.retryConfig - || { strategy: "none" }, - retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], - }; - - const requestRes = client._createRequest(context, { - security: requestSecurity, - method: "POST", - baseURL: options?.serverURL, - path: path, - headers: headers, - body: body, - userAgent: client._options.userAgent, - timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, - }, options); - if (!requestRes.ok) { - return [requestRes, { status: "invalid" }]; - } - const req = requestRes.value; - - const doResult = await client._do(req, { - context, - errorCodes: ["422", "4XX", "5XX"], - retryConfig: context.retryConfig, - retryCodes: context.retryCodes, - }); - if (!doResult.ok) { - return [doResult, { status: "request-error", request: req }]; - } - const response = doResult.value; - - const responseFields = { - HttpMeta: { Response: response, Request: req }, - }; - - const [result] = await M.match< - components.OCRResponse, - | errors.HTTPValidationError - | MistralError - | ResponseValidationError - | ConnectionError - | RequestAbortedError - | RequestTimeoutError - | InvalidRequestError - | UnexpectedClientError - | SDKValidationError - >( - M.json(200, components.OCRResponse$inboundSchema), - M.jsonErr(422, errors.HTTPValidationError$inboundSchema), - M.fail("4XX"), - M.fail("5XX"), - )(response, req, { extraFields: responseFields }); - if (!result.ok) { - return [result, { status: "complete", request: req, response }]; - } - - return [result, { status: "complete", request: req, response }]; -} diff --git a/examples/sdks/mistral-typescript/src/hooks/custom_user_agent.ts b/examples/sdks/mistral-typescript/src/hooks/custom_user_agent.ts deleted file mode 100644 index 7420044b6..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/custom_user_agent.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { SDK_METADATA } from "../lib/config"; -import { BeforeRequestContext, BeforeRequestHook, Awaitable } from "./types"; - -export class CustomUserAgentHook implements BeforeRequestHook { - beforeRequest(_: BeforeRequestContext, request: Request): Awaitable { - const version = SDK_METADATA.sdkVersion; - const ua = `mistral-client-typescript/${version}`; - - request.headers.set("user-agent", ua); - - // In Chrome, the line above may silently fail. If the header was not set - // we fallback to setting an alternate header. - // Chromium bug: https://issues.chromium.org/issues/40450316 - if (!request.headers.get("user-agent")) { - request.headers.set("x-mistral-user-agent", ua); - } - - return request; - } -} diff --git a/examples/sdks/mistral-typescript/src/hooks/deprecation_warning.ts b/examples/sdks/mistral-typescript/src/hooks/deprecation_warning.ts deleted file mode 100644 index f4d961338..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/deprecation_warning.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { AfterSuccessContext, AfterSuccessHook, Awaitable } from './types'; - - -const HEADER_MODEL_DEPRECATION_TIMESTAMP = "x-model-deprecation-timestamp"; - -export class DeprecationWarningHook implements AfterSuccessHook { - afterSuccess(_: AfterSuccessContext, response: Response): Awaitable { - if (response.headers.has(HEADER_MODEL_DEPRECATION_TIMESTAMP)) { - response.clone().json().then((body) => { - const model = body.model; - console.warn( - `WARNING: The model ${model} is deprecated and will be removed on ${response.headers.get(HEADER_MODEL_DEPRECATION_TIMESTAMP)}. Please refer to https://docs.mistral.ai/getting-started/models/#api-versioning for more information.` - ); - }); - - } - return response; - } -} diff --git a/examples/sdks/mistral-typescript/src/hooks/hooks.ts b/examples/sdks/mistral-typescript/src/hooks/hooks.ts deleted file mode 100644 index d34c88497..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/hooks.ts +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { RequestInput } from "../lib/http.js"; -import { - AfterErrorContext, - AfterErrorHook, - AfterSuccessContext, - AfterSuccessHook, - BeforeCreateRequestContext, - BeforeCreateRequestHook, - BeforeRequestContext, - BeforeRequestHook, - Hook, - Hooks, - SDKInitHook, - SDKInitOptions, -} from "./types.js"; - -import { initHooks } from "./registration.js"; - -export class SDKHooks implements Hooks { - sdkInitHooks: SDKInitHook[] = []; - beforeCreateRequestHooks: BeforeCreateRequestHook[] = []; - beforeRequestHooks: BeforeRequestHook[] = []; - afterSuccessHooks: AfterSuccessHook[] = []; - afterErrorHooks: AfterErrorHook[] = []; - - constructor() { - const presetHooks: Array = []; - - for (const hook of presetHooks) { - if ("sdkInit" in hook) { - this.registerSDKInitHook(hook); - } - if ("beforeCreateRequest" in hook) { - this.registerBeforeCreateRequestHook(hook); - } - if ("beforeRequest" in hook) { - this.registerBeforeRequestHook(hook); - } - if ("afterSuccess" in hook) { - this.registerAfterSuccessHook(hook); - } - if ("afterError" in hook) { - this.registerAfterErrorHook(hook); - } - } - initHooks(this); - } - - registerSDKInitHook(hook: SDKInitHook) { - this.sdkInitHooks.push(hook); - } - - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) { - this.beforeCreateRequestHooks.push(hook); - } - - registerBeforeRequestHook(hook: BeforeRequestHook) { - this.beforeRequestHooks.push(hook); - } - - registerAfterSuccessHook(hook: AfterSuccessHook) { - this.afterSuccessHooks.push(hook); - } - - registerAfterErrorHook(hook: AfterErrorHook) { - this.afterErrorHooks.push(hook); - } - - sdkInit(opts: SDKInitOptions): SDKInitOptions { - return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts); - } - - beforeCreateRequest( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ): RequestInput { - let inp = input; - - for (const hook of this.beforeCreateRequestHooks) { - inp = hook.beforeCreateRequest(hookCtx, inp); - } - - return inp; - } - - async beforeRequest( - hookCtx: BeforeRequestContext, - request: Request, - ): Promise { - let req = request; - - for (const hook of this.beforeRequestHooks) { - req = await hook.beforeRequest(hookCtx, req); - } - - return req; - } - - async afterSuccess( - hookCtx: AfterSuccessContext, - response: Response, - ): Promise { - let res = response; - - for (const hook of this.afterSuccessHooks) { - res = await hook.afterSuccess(hookCtx, res); - } - - return res; - } - - async afterError( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ): Promise<{ response: Response | null; error: unknown }> { - let res = response; - let err = error; - - for (const hook of this.afterErrorHooks) { - const result = await hook.afterError(hookCtx, res, err); - res = result.response; - err = result.error; - } - - return { response: res, error: err }; - } -} diff --git a/examples/sdks/mistral-typescript/src/hooks/index.ts b/examples/sdks/mistral-typescript/src/hooks/index.ts deleted file mode 100644 index f60ec7acd..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./hooks.js"; -export * from "./types.js"; diff --git a/examples/sdks/mistral-typescript/src/hooks/registration.ts b/examples/sdks/mistral-typescript/src/hooks/registration.ts deleted file mode 100644 index 3ca65d713..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/registration.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { Hooks } from "./types"; -import { CustomUserAgentHook } from "./custom_user_agent"; -import { DeprecationWarningHook } from "./deprecation_warning"; - -/* - * This file is only ever generated once on the first generation and then is free to be modified. - * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them - * in this file or in separate files in the hooks folder. - */ - - -export function initHooks(hooks: Hooks) { - // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook - // with an instance of a hook that implements that specific Hook interface - // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance - const customUserAgentHook = new CustomUserAgentHook(); - hooks.registerBeforeRequestHook(customUserAgentHook) - - const deprecationWarningHook = new DeprecationWarningHook(); - hooks.registerAfterSuccessHook(deprecationWarningHook) - -} diff --git a/examples/sdks/mistral-typescript/src/hooks/types.ts b/examples/sdks/mistral-typescript/src/hooks/types.ts deleted file mode 100644 index 8bfe4fe81..000000000 --- a/examples/sdks/mistral-typescript/src/hooks/types.ts +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKOptions } from "../lib/config.js"; -import { HTTPClient, RequestInput } from "../lib/http.js"; -import { RetryConfig } from "../lib/retries.js"; -import { SecurityState } from "../lib/security.js"; - -export type HookContext = { - baseURL: string | URL; - operationID: string; - oAuth2Scopes: string[] | null; - securitySource?: any | (() => Promise); - retryConfig: RetryConfig; - resolvedSecurity: SecurityState | null; - options: SDKOptions; -}; - -export type Awaitable = T | Promise; - -export type SDKInitOptions = { - baseURL: URL | null; - client: HTTPClient; -}; - -export type BeforeCreateRequestContext = HookContext & {}; -export type BeforeRequestContext = HookContext & {}; -export type AfterSuccessContext = HookContext & {}; -export type AfterErrorContext = HookContext & {}; - -/** - * SDKInitHook is called when the SDK is initializing. The - * hook can return a new baseURL and HTTP client to be used by the SDK. - */ -export interface SDKInitHook { - sdkInit: (opts: SDKInitOptions) => SDKInitOptions; -} - -export interface BeforeCreateRequestHook { - /** - * A hook that is called before the SDK creates a `Request` object. The hook - * can modify how a request is constructed since certain modifications, like - * changing the request URL, cannot be done on a request object directly. - */ - beforeCreateRequest: ( - hookCtx: BeforeCreateRequestContext, - input: RequestInput, - ) => RequestInput; -} - -export interface BeforeRequestHook { - /** - * A hook that is called before the SDK sends a request. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * replace the request before it is sent or throw an error to stop the - * request from being sent. - */ - beforeRequest: ( - hookCtx: BeforeRequestContext, - request: Request, - ) => Awaitable; -} - -export interface AfterSuccessHook { - /** - * A hook that is called after the SDK receives a response. The hook can - * introduce instrumentation code such as logging, tracing and metrics or - * modify the response before it is handled or throw an error to stop the - * response from being handled. - */ - afterSuccess: ( - hookCtx: AfterSuccessContext, - response: Response, - ) => Awaitable; -} - -export interface AfterErrorHook { - /** - * A hook that is called after the SDK encounters an error, or a - * non-successful response. The hook can introduce instrumentation code such - * as logging, tracing and metrics or modify the response or error values. - */ - afterError: ( - hookCtx: AfterErrorContext, - response: Response | null, - error: unknown, - ) => Awaitable<{ - response: Response | null; - error: unknown; - }>; -} - -export interface Hooks { - /** Registers a hook to be used by the SDK for initialization event. */ - registerSDKInitHook(hook: SDKInitHook): void; - /** Registers a hook to be used by the SDK for to modify `Request` construction. */ - registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void; - /** Registers a hook to be used by the SDK for the before request event. */ - registerBeforeRequestHook(hook: BeforeRequestHook): void; - /** Registers a hook to be used by the SDK for the after success event. */ - registerAfterSuccessHook(hook: AfterSuccessHook): void; - /** Registers a hook to be used by the SDK for the after error event. */ - registerAfterErrorHook(hook: AfterErrorHook): void; -} - -export type Hook = - | SDKInitHook - | BeforeCreateRequestHook - | BeforeRequestHook - | AfterSuccessHook - | AfterErrorHook; diff --git a/examples/sdks/mistral-typescript/src/index.ts b/examples/sdks/mistral-typescript/src/index.ts deleted file mode 100644 index dbcba164a..000000000 --- a/examples/sdks/mistral-typescript/src/index.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./lib/config.js"; -export * as files from "./lib/files.js"; -export { HTTPClient } from "./lib/http.js"; -export type { Fetcher, HTTPClientOptions } from "./lib/http.js"; -export * from "./sdk/sdk.js"; diff --git a/examples/sdks/mistral-typescript/src/lib/base64.ts b/examples/sdks/mistral-typescript/src/lib/base64.ts deleted file mode 100644 index c2d5b3898..000000000 --- a/examples/sdks/mistral-typescript/src/lib/base64.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function bytesToBase64(u8arr: Uint8Array): string { - return btoa(String.fromCodePoint(...u8arr)); -} - -export function bytesFromBase64(encoded: string): Uint8Array { - return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); -} - -export function stringToBytes(str: string): Uint8Array { - return new TextEncoder().encode(str); -} - -export function stringFromBytes(u8arr: Uint8Array): string { - return new TextDecoder().decode(u8arr); -} - -export function stringToBase64(str: string): string { - return bytesToBase64(stringToBytes(str)); -} - -export function stringFromBase64(b64str: string): string { - return stringFromBytes(bytesFromBase64(b64str)); -} - -export const zodOutbound = z - .instanceof(Uint8Array) - .or(z.string().transform(stringToBytes)); - -export const zodInbound = z - .instanceof(Uint8Array) - .or(z.string().transform(bytesFromBase64)); diff --git a/examples/sdks/mistral-typescript/src/lib/config.ts b/examples/sdks/mistral-typescript/src/lib/config.ts deleted file mode 100644 index c7805d80f..000000000 --- a/examples/sdks/mistral-typescript/src/lib/config.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { HTTPClient } from "./http.js"; -import { Logger } from "./logger.js"; -import { RetryConfig } from "./retries.js"; -import { Params, pathToFunc } from "./url.js"; - -/** - * EU Production server - */ -export const ServerEu = "eu"; -/** - * Contains the list of servers available to the SDK - */ -export const ServerList = { - [ServerEu]: "https://api.mistral.ai", -} as const; - -export type SDKOptions = { - apiKey?: string | (() => Promise) | undefined; - - httpClient?: HTTPClient; - /** - * Allows overriding the default server used by the SDK - */ - server?: keyof typeof ServerList | undefined; - /** - * Allows overriding the default server URL used by the SDK - */ - serverURL?: string | undefined; - /** - * Allows overriding the default user agent used by the SDK - */ - userAgent?: string | undefined; - /** - * Allows overriding the default retry config used by the SDK - */ - retryConfig?: RetryConfig; - timeoutMs?: number; - debugLogger?: Logger; -}; - -export function serverURLFromOptions(options: SDKOptions): URL | null { - let serverURL = options.serverURL; - - const params: Params = {}; - - if (!serverURL) { - const server = options.server ?? ServerEu; - serverURL = ServerList[server] || ""; - } - - const u = pathToFunc(serverURL)(params); - return new URL(u); -} - -export const SDK_METADATA = { - language: "typescript", - openapiDocVersion: "1.0.0", - sdkVersion: "1.10.0", - genVersion: "2.687.13", - userAgent: - "speakeasy-sdk/typescript 1.10.0 2.687.13 1.0.0 @mistralai/mistralai", -} as const; diff --git a/examples/sdks/mistral-typescript/src/lib/dlv.ts b/examples/sdks/mistral-typescript/src/lib/dlv.ts deleted file mode 100644 index e81091f5e..000000000 --- a/examples/sdks/mistral-typescript/src/lib/dlv.ts +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) 2024 Jason Miller (http://jasonformat.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -/** - * @param obj The object to walk - * @param key The key path to walk the object with - * @param def A default value to return if the result is undefined - * - * @example - * dlv(obj, "a.b.c.d") - * @example - * dlv(object, ["a", "b", "c", "d"]) - * @example - * dlv(object, "foo.bar.baz", "Hello, default value!") - */ -export function dlv( - obj: any, - key: string | string[], - def?: T, - p?: number, - undef?: never, -): T | undefined { - key = Array.isArray(key) ? key : key.split("."); - for (p = 0; p < key.length; p++) { - const k = key[p]; - obj = k != null && obj ? obj[k] : undef; - } - return obj === undef ? def : obj; -} diff --git a/examples/sdks/mistral-typescript/src/lib/encodings.ts b/examples/sdks/mistral-typescript/src/lib/encodings.ts deleted file mode 100644 index 25c9dcba3..000000000 --- a/examples/sdks/mistral-typescript/src/lib/encodings.ts +++ /dev/null @@ -1,483 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { bytesToBase64 } from "./base64.js"; -import { isPlainObject } from "./is-plain-object.js"; - -export class EncodingError extends Error { - constructor(message: string) { - super(message); - this.name = "EncodingError"; - } -} - -export function encodeMatrix( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - const keyPrefix = encodeString(pk); - tmp = `${keyPrefix}=${encValue}`; - // trim trailing '=' if value was empty - if (tmp === `${keyPrefix}=`) { - tmp = tmp.slice(0, -1); - } - - // If we end up with the nothing then skip forward - if (!tmp) { - return; - } - - out += `;${tmp}`; - }); - - return out; -} - -export function encodeLabel( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let encValue: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join("."); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `.${encodeString(k)}.${encodeValue(v)}`; - }); - encValue = mapped?.join("").slice(1); - } else { - const k = - options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : ""; - encValue = `${k}${encodeValue(pv)}`; - } - - out += encValue == null ? "" : `.${encValue}`; - }); - - return out; -} - -type FormEncoder = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -) => string | undefined; - -function formEncoder(sep: string): FormEncoder { - return ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, - ) => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - const encodedSep = encodeString(sep); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue: string | null | undefined = null; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(encodedSep); - } else if (isPlainObject(pv)) { - encValue = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `${encodeString(k)}${encodedSep}${encodeValue(v)}`; - })?.join(encodedSep); - } else { - encValue = `${encodeValue(pv)}`; - } - - if (encValue == null) { - return; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); - }; -} - -export const encodeForm = formEncoder(","); -export const encodeSpaceDelimited = formEncoder(" "); -export const encodePipeDelimited = formEncoder("|"); - -export function encodeBodyForm( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp = ""; - let encValue = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else if (isPlainObject(pv)) { - encValue = JSON.stringify(pv, jsonReplacer); - } else { - encValue = `${encodeValue(pv)}`; - } - - tmp = `${encodeString(pk)}=${encValue}`; - - // If we end up with the nothing then skip forward - if (!tmp || tmp === "=") { - return; - } - - out += `&${tmp}`; - }); - - return out.slice(1); -} - -export function encodeDeepObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - if (!isPlainObject(value)) { - throw new EncodingError( - `Value of parameter '${key}' which uses deepObject encoding must be an object or null`, - ); - } - - return encodeDeepObjectObject(key, value, options); -} - -export function encodeDeepObjectObject( - key: string, - value: unknown, - options?: { charEncoding?: "percent" | "none" }, -): string | undefined { - if (value == null) { - return; - } - - let out = ""; - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - if (!isPlainObject(value)) { - throw new EncodingError(`Expected parameter '${key}' to be an object.`); - } - - Object.entries(value).forEach(([ck, cv]) => { - if (cv == null) { - return; - } - - const pk = `${key}[${ck}]`; - - if (isPlainObject(cv)) { - const objOut = encodeDeepObjectObject(pk, cv, options); - - out += objOut == null ? "" : `&${objOut}`; - - return; - } - - const pairs: unknown[] = Array.isArray(cv) ? cv : [cv]; - const encoded = mapDefined(pairs, (v) => { - return `${encodeString(pk)}=${encodeString(serializeValue(v))}`; - })?.join("&"); - - out += encoded == null ? "" : `&${encoded}`; - }); - - return out.slice(1); -} - -export function encodeJSON( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined { - if (typeof value === "undefined") { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - - const encVal = encodeString(JSON.stringify(value, jsonReplacer)); - - return options?.explode ? encVal : `${encodeString(key)}=${encVal}`; -} - -export const encodeSimple = ( - key: string, - value: unknown, - options?: { explode?: boolean; charEncoding?: "percent" | "none" }, -): string | undefined => { - let out = ""; - const pairs: [string, unknown][] = options?.explode - ? explode(key, value) - : [[key, value]]; - - if (pairs.every(([_, v]) => v == null)) { - return; - } - - const encodeString = (v: string) => { - return options?.charEncoding === "percent" ? encodeURIComponent(v) : v; - }; - const encodeValue = (v: unknown) => encodeString(serializeValue(v)); - - pairs.forEach(([pk, pv]) => { - let tmp: string | null | undefined = ""; - - if (pv == null) { - return; - } else if (Array.isArray(pv)) { - tmp = mapDefined(pv, (v) => `${encodeValue(v)}`)?.join(","); - } else if (isPlainObject(pv)) { - const mapped = mapDefinedEntries(Object.entries(pv), ([k, v]) => { - return `,${encodeString(k)},${encodeValue(v)}`; - }); - tmp = mapped?.join("").slice(1); - } else { - const k = options?.explode && isPlainObject(value) ? `${pk}=` : ""; - tmp = `${k}${encodeValue(pv)}`; - } - - out += tmp ? `,${tmp}` : ""; - }); - - return out.slice(1); -}; - -function explode(key: string, value: unknown): [string, unknown][] { - if (Array.isArray(value)) { - return value.map((v) => [key, v]); - } else if (isPlainObject(value)) { - const o = value ?? {}; - return Object.entries(o).map(([k, v]) => [k, v]); - } else { - return [[key, value]]; - } -} - -function serializeValue(value: unknown): string { - if (value == null) { - return ""; - } else if (value instanceof Date) { - return value.toISOString(); - } else if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else if (typeof value === "object") { - return JSON.stringify(value, jsonReplacer); - } - - return `${value}`; -} - -function jsonReplacer(_: string, value: unknown): unknown { - if (value instanceof Uint8Array) { - return bytesToBase64(value); - } else { - return value; - } -} - -function mapDefined(inp: T[], mapper: (v: T) => R): R[] | null { - const res = inp.reduce((acc, v) => { - if (v == null) { - return acc; - } - - const m = mapper(v); - if (m == null) { - return acc; - } - - acc.push(m); - - return acc; - }, []); - - return res.length ? res : null; -} - -function mapDefinedEntries( - inp: Iterable<[K, V]>, - mapper: (v: [K, V]) => R, -): R[] | null { - const acc: R[] = []; - for (const [k, v] of inp) { - if (v == null) { - continue; - } - - const m = mapper([k, v]); - if (m == null) { - continue; - } - - acc.push(m); - } - - return acc.length ? acc : null; -} - -export function queryJoin(...args: (string | undefined)[]): string { - return args.filter(Boolean).join("&"); -} - -type QueryEncoderOptions = { - explode?: boolean; - charEncoding?: "percent" | "none"; -}; - -type QueryEncoder = ( - key: string, - value: unknown, - options?: QueryEncoderOptions, -) => string | undefined; - -type BulkQueryEncoder = ( - values: Record, - options?: QueryEncoderOptions, -) => string; - -export function queryEncoder(f: QueryEncoder): BulkQueryEncoder { - const bulkEncode = function ( - values: Record, - options?: QueryEncoderOptions, - ): string { - const opts: QueryEncoderOptions = { - ...options, - explode: options?.explode ?? true, - charEncoding: options?.charEncoding ?? "percent", - }; - - const encoded = Object.entries(values).map(([key, value]) => { - return f(key, value, opts); - }); - return queryJoin(...encoded); - }; - - return bulkEncode; -} - -export const encodeJSONQuery = queryEncoder(encodeJSON); -export const encodeFormQuery = queryEncoder(encodeForm); -export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited); -export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited); -export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject); - -export function appendForm( - fd: FormData, - key: string, - value: unknown, - fileName?: string, -): void { - if (value == null) { - return; - } else if (value instanceof Blob && fileName) { - fd.append(key, value, fileName); - } else if (value instanceof Blob) { - fd.append(key, value); - } else { - fd.append(key, String(value)); - } -} diff --git a/examples/sdks/mistral-typescript/src/lib/env.ts b/examples/sdks/mistral-typescript/src/lib/env.ts deleted file mode 100644 index 384b519b2..000000000 --- a/examples/sdks/mistral-typescript/src/lib/env.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { dlv } from "./dlv.js"; - -import * as z from "zod"; - -export interface Env { - MISTRAL_API_KEY?: string | undefined; - - MISTRAL_DEBUG?: boolean | undefined; -} - -export const envSchema: z.ZodType = z.object({ - MISTRAL_API_KEY: z.string().optional(), - - MISTRAL_DEBUG: z.coerce.boolean().optional(), -}); - -let envMemo: Env | undefined = undefined; -/** - * Reads and validates environment variables. - */ -export function env(): Env { - if (envMemo) { - return envMemo; - } - - envMemo = envSchema.parse( - dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {}, - ); - return envMemo; -} - -/** - * Clears the cached env object. Useful for testing with a fresh environment. - */ -export function resetEnv() { - envMemo = undefined; -} diff --git a/examples/sdks/mistral-typescript/src/lib/event-streams.ts b/examples/sdks/mistral-typescript/src/lib/event-streams.ts deleted file mode 100644 index d14c6e7d3..000000000 --- a/examples/sdks/mistral-typescript/src/lib/event-streams.ts +++ /dev/null @@ -1,137 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type ServerEvent = { - data?: T | undefined; - event?: string | undefined; - id?: string | undefined; - retry?: number | undefined; -}; - -export class EventStream> - extends ReadableStream -{ - constructor( - responseBody: ReadableStream, - parse: (x: ServerEvent) => IteratorResult, - ) { - const upstream = responseBody.getReader(); - let buffer: Uint8Array = new Uint8Array(); - super({ - async pull(downstream) { - try { - while (true) { - const match = findBoundary(buffer); - if (!match) { - const chunk = await upstream.read(); - if (chunk.done) return downstream.close(); - buffer = concatBuffer(buffer, chunk.value); - continue; - } - const message = buffer.slice(0, match.index); - buffer = buffer.slice(match.index + match.length); - const item = parseMessage(message, parse); - if (item?.value) return downstream.enqueue(item.value); - if (item?.done) { - await upstream.cancel("done"); - return downstream.close(); - } - } - } catch (e) { - downstream.error(e); - await upstream.cancel(e); - } - }, - cancel: reason => upstream.cancel(reason), - }); - } - - // Polyfill for older browsers - [Symbol.asyncIterator](): AsyncIterableIterator { - const fn = (ReadableStream.prototype as any)[Symbol.asyncIterator]; - if (typeof fn === "function") return fn.call(this); - const reader = this.getReader(); - return { - next: async () => { - const r = await reader.read(); - if (r.done) { - reader.releaseLock(); - return { done: true, value: undefined }; - } - return { done: false, value: r.value }; - }, - throw: async (e) => { - await reader.cancel(e); - reader.releaseLock(); - return { done: true, value: undefined }; - }, - return: async () => { - await reader.cancel("done"); - reader.releaseLock(); - return { done: true, value: undefined }; - }, - [Symbol.asyncIterator]() { - return this; - }, - }; - } -} - -function concatBuffer(a: Uint8Array, b: Uint8Array): Uint8Array { - const c = new Uint8Array(a.length + b.length); - c.set(a, 0); - c.set(b, a.length); - return c; -} - -/** Finds the first (CR,LF,CR,LF) or (CR,CR) or (LF,LF) */ -function findBoundary( - buf: Uint8Array, -): { index: number; length: number } | null { - const len = buf.length; - for (let i = 0; i < len; i++) { - if ( - i <= len - 4 - && buf[i] === 13 && buf[i + 1] === 10 && buf[i + 2] === 13 - && buf[i + 3] === 10 - ) { - return { index: i, length: 4 }; - } - if (i <= len - 2 && buf[i] === 13 && buf[i + 1] === 13) { - return { index: i, length: 2 }; - } - if (i <= len - 2 && buf[i] === 10 && buf[i + 1] === 10) { - return { index: i, length: 2 }; - } - } - return null; -} - -function parseMessage>( - chunk: Uint8Array, - parse: (x: ServerEvent) => IteratorResult, -) { - const text = new TextDecoder().decode(chunk); - const lines = text.split(/\r\n|\r|\n/); - const dataLines: string[] = []; - const ret: ServerEvent = {}; - let ignore = true; - for (const line of lines) { - if (!line || line.startsWith(":")) continue; - ignore = false; - const i = line.indexOf(":"); - const field = line.slice(0, i); - const value = line[i + 1] === " " ? line.slice(i + 2) : line.slice(i + 1); - if (field === "data") dataLines.push(value); - else if (field === "event") ret.event = value; - else if (field === "id") ret.id = value; - else if (field === "retry") { - const n = Number(value); - if (!isNaN(n)) ret.retry = n; - } - } - if (ignore) return; - if (dataLines.length) ret.data = dataLines.join("\n"); - return parse(ret); -} diff --git a/examples/sdks/mistral-typescript/src/lib/files.ts b/examples/sdks/mistral-typescript/src/lib/files.ts deleted file mode 100644 index 0344cd046..000000000 --- a/examples/sdks/mistral-typescript/src/lib/files.ts +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Consumes a stream and returns a concatenated array buffer. Useful in - * situations where we need to read the whole file because it forms part of a - * larger payload containing other fields, and we can't modify the underlying - * request structure. - */ -export async function readableStreamToArrayBuffer( - readable: ReadableStream, -): Promise { - const reader = readable.getReader(); - const chunks: Uint8Array[] = []; - - let totalLength = 0; - let done = false; - - while (!done) { - const { value, done: doneReading } = await reader.read(); - - if (doneReading) { - done = true; - } else { - chunks.push(value); - totalLength += value.length; - } - } - - const concatenatedChunks = new Uint8Array(totalLength); - let offset = 0; - - for (const chunk of chunks) { - concatenatedChunks.set(chunk, offset); - offset += chunk.length; - } - - return concatenatedChunks.buffer as ArrayBuffer; -} - -/** - * Determines the MIME content type based on a file's extension. - * Returns null if the extension is not recognized. - */ -export function getContentTypeFromFileName(fileName: string): string | null { - if (!fileName) return null; - - const ext = fileName.toLowerCase().split(".").pop(); - if (!ext) return null; - - const mimeTypes: Record = { - json: "application/json", - xml: "application/xml", - html: "text/html", - htm: "text/html", - txt: "text/plain", - csv: "text/csv", - pdf: "application/pdf", - png: "image/png", - jpg: "image/jpeg", - jpeg: "image/jpeg", - gif: "image/gif", - svg: "image/svg+xml", - js: "application/javascript", - css: "text/css", - zip: "application/zip", - tar: "application/x-tar", - gz: "application/gzip", - mp4: "video/mp4", - mp3: "audio/mpeg", - wav: "audio/wav", - webp: "image/webp", - ico: "image/x-icon", - woff: "font/woff", - woff2: "font/woff2", - ttf: "font/ttf", - otf: "font/otf", - }; - - return mimeTypes[ext] || null; -} diff --git a/examples/sdks/mistral-typescript/src/lib/http.ts b/examples/sdks/mistral-typescript/src/lib/http.ts deleted file mode 100644 index 13cf1fd78..000000000 --- a/examples/sdks/mistral-typescript/src/lib/http.ts +++ /dev/null @@ -1,323 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type Fetcher = ( - input: RequestInfo | URL, - init?: RequestInit, -) => Promise; - -export type Awaitable = T | Promise; - -const DEFAULT_FETCHER: Fetcher = (input, init) => { - // If input is a Request and init is undefined, Bun will discard the method, - // headers, body and other options that were set on the request object. - // Node.js and browers would ignore an undefined init value. This check is - // therefore needed for interop with Bun. - if (init == null) { - return fetch(input); - } else { - return fetch(input, init); - } -}; - -export type RequestInput = { - /** - * The URL the request will use. - */ - url: URL; - /** - * Options used to create a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). - */ - options?: RequestInit | undefined; -}; - -export interface HTTPClientOptions { - fetcher?: Fetcher; -} - -export type BeforeRequestHook = (req: Request) => Awaitable; -export type RequestErrorHook = (err: unknown, req: Request) => Awaitable; -export type ResponseHook = (res: Response, req: Request) => Awaitable; - -export class HTTPClient { - private fetcher: Fetcher; - private requestHooks: BeforeRequestHook[] = []; - private requestErrorHooks: RequestErrorHook[] = []; - private responseHooks: ResponseHook[] = []; - - constructor(private options: HTTPClientOptions = {}) { - this.fetcher = options.fetcher || DEFAULT_FETCHER; - } - - async request(request: Request): Promise { - let req = request; - for (const hook of this.requestHooks) { - const nextRequest = await hook(req); - if (nextRequest) { - req = nextRequest; - } - } - - try { - const res = await this.fetcher(req); - - for (const hook of this.responseHooks) { - await hook(res, req); - } - - return res; - } catch (err) { - for (const hook of this.requestErrorHooks) { - await hook(err, req); - } - - throw err; - } - } - - /** - * Registers a hook that is called before a request is made. The hook function - * can mutate the request or return a new request. This may be useful to add - * additional information to request such as request IDs and tracing headers. - */ - addHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** - * Registers a hook that is called when a request cannot be made due to a - * network error. - */ - addHook(hook: "requestError", fn: RequestErrorHook): this; - /** - * Registers a hook that is called when a response has been received from the - * server. - */ - addHook(hook: "response", fn: ResponseHook): this; - addHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ) { - if (args[0] === "beforeRequest") { - this.requestHooks.push(args[1]); - } else if (args[0] === "requestError") { - this.requestErrorHooks.push(args[1]); - } else if (args[0] === "response") { - this.responseHooks.push(args[1]); - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - return this; - } - - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "beforeRequest", fn: BeforeRequestHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "requestError", fn: RequestErrorHook): this; - /** Removes a hook that was previously registered with `addHook`. */ - removeHook(hook: "response", fn: ResponseHook): this; - removeHook( - ...args: - | [hook: "beforeRequest", fn: BeforeRequestHook] - | [hook: "requestError", fn: RequestErrorHook] - | [hook: "response", fn: ResponseHook] - ): this { - let target: unknown[]; - if (args[0] === "beforeRequest") { - target = this.requestHooks; - } else if (args[0] === "requestError") { - target = this.requestErrorHooks; - } else if (args[0] === "response") { - target = this.responseHooks; - } else { - throw new Error(`Invalid hook type: ${args[0]}`); - } - - const index = target.findIndex((v) => v === args[1]); - if (index >= 0) { - target.splice(index, 1); - } - - return this; - } - - clone(): HTTPClient { - const child = new HTTPClient(this.options); - child.requestHooks = this.requestHooks.slice(); - child.requestErrorHooks = this.requestErrorHooks.slice(); - child.responseHooks = this.responseHooks.slice(); - - return child; - } -} - -export type StatusCodePredicate = number | string | (number | string)[]; - -// A semicolon surrounded by optional whitespace characters is used to separate -// segments in a media type string. -const mediaParamSeparator = /\s*;\s*/g; - -export function matchContentType(response: Response, pattern: string): boolean { - // `*` is a special case which means anything is acceptable. - if (pattern === "*") { - return true; - } - - let contentType = - response.headers.get("content-type")?.trim() || "application/octet-stream"; - contentType = contentType.toLowerCase(); - - const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator); - const [wantType = "", ...wantParams] = wantParts; - - if (wantType.split("/").length !== 2) { - return false; - } - - const gotParts = contentType.split(mediaParamSeparator); - const [gotType = "", ...gotParams] = gotParts; - - const [type = "", subtype = ""] = gotType.split("/"); - if (!type || !subtype) { - return false; - } - - if ( - wantType !== "*/*" && - gotType !== wantType && - `${type}/*` !== wantType && - `*/${subtype}` !== wantType - ) { - return false; - } - - if (gotParams.length < wantParams.length) { - return false; - } - - const params = new Set(gotParams); - for (const wantParam of wantParams) { - if (!params.has(wantParam)) { - return false; - } - } - - return true; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -export function matchStatusCode( - response: Response, - codes: StatusCodePredicate, -): boolean { - const actual = `${response.status}`; - const expectedCodes = Array.isArray(codes) ? codes : [codes]; - if (!expectedCodes.length) { - return false; - } - - return expectedCodes.some((ec) => { - const code = `${ec}`; - - if (code === "default") { - return true; - } - - if (!codeRangeRE.test(`${code}`)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -export function matchResponse( - response: Response, - code: StatusCodePredicate, - contentTypePattern: string, -): boolean { - return ( - matchStatusCode(response, code) && - matchContentType(response, contentTypePattern) - ); -} - -/** - * Uses various heurisitics to determine if an error is a connection error. - */ -export function isConnectionError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Covers fetch in Deno as well - const isBrowserErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("failed to fetch"); - - const isNodeErr = - err instanceof TypeError && - err.message.toLowerCase().startsWith("fetch failed"); - - const isBunErr = "name" in err && err.name === "ConnectionError"; - - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnreset"; - - return isBrowserErr || isNodeErr || isGenericErr || isBunErr; -} - -/** - * Uses various heurisitics to determine if an error is a timeout error. - */ -export function isTimeoutError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "TimeoutError"; - const isLegacyNative = "code" in err && err.code === 23; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} - -/** - * Uses various heurisitics to determine if an error is a abort error. - */ -export function isAbortError(err: unknown): boolean { - if (typeof err !== "object" || err == null) { - return false; - } - - // Fetch in browser, Node.js, Bun, Deno - const isNative = "name" in err && err.name === "AbortError"; - const isLegacyNative = "code" in err && err.code === 20; - - // Node.js HTTP client and Axios - const isGenericErr = - "code" in err && - typeof err.code === "string" && - err.code.toLowerCase() === "econnaborted"; - - return isNative || isLegacyNative || isGenericErr; -} diff --git a/examples/sdks/mistral-typescript/src/lib/is-plain-object.ts b/examples/sdks/mistral-typescript/src/lib/is-plain-object.ts deleted file mode 100644 index 61070d3d7..000000000 --- a/examples/sdks/mistral-typescript/src/lib/is-plain-object.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/* -MIT License - -Copyright (c) Sindre Sorhus (https://sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -// Taken from https://github.com/sindresorhus/is-plain-obj/blob/97f38e8836f86a642cce98fc6ab3058bc36df181/index.js - -export function isPlainObject(value: unknown): value is object { - if (typeof value !== "object" || value === null) { - return false; - } - - const prototype = Object.getPrototypeOf(value); - return ( - (prototype === null || - prototype === Object.prototype || - Object.getPrototypeOf(prototype) === null) && - !(Symbol.toStringTag in value) && - !(Symbol.iterator in value) - ); -} diff --git a/examples/sdks/mistral-typescript/src/lib/logger.ts b/examples/sdks/mistral-typescript/src/lib/logger.ts deleted file mode 100644 index d181f2937..000000000 --- a/examples/sdks/mistral-typescript/src/lib/logger.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export interface Logger { - group(label?: string): void; - groupEnd(): void; - log(message: any, ...args: any[]): void; -} diff --git a/examples/sdks/mistral-typescript/src/lib/matchers.ts b/examples/sdks/mistral-typescript/src/lib/matchers.ts deleted file mode 100644 index 5e2e60be5..000000000 --- a/examples/sdks/mistral-typescript/src/lib/matchers.ts +++ /dev/null @@ -1,345 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; -import { SDKError } from "../models/errors/sdkerror.js"; -import { ERR, OK, Result } from "../types/fp.js"; -import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js"; -import { isPlainObject } from "./is-plain-object.js"; - -export type Encoding = - | "jsonl" - | "json" - | "text" - | "bytes" - | "stream" - | "sse" - | "nil" - | "fail"; - -const DEFAULT_CONTENT_TYPES: Record = { - jsonl: "application/jsonl", - json: "application/json", - text: "text/plain", - bytes: "application/octet-stream", - stream: "application/octet-stream", - sse: "text/event-stream", - nil: "*", - fail: "*", -}; - -type Schema = { parse(raw: unknown): T }; - -type MatchOptions = { - ctype?: string; - hdrs?: boolean; - key?: string; - sseSentinel?: string; -}; - -export type ValueMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; -}; - -export type ErrorMatcher = MatchOptions & { - enc: Encoding; - codes: StatusCodePredicate; - schema: Schema; - err: true; -}; - -export type FailMatcher = { - enc: "fail"; - codes: StatusCodePredicate; -}; - -export type Matcher = ValueMatcher | ErrorMatcher | FailMatcher; - -export function jsonErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "json", codes, schema }; -} -export function json( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "json", codes, schema }; -} - -export function jsonl( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "jsonl", codes, schema }; -} - -export function jsonlErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "jsonl", codes, schema }; -} -export function textErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "text", codes, schema }; -} -export function text( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "text", codes, schema }; -} - -export function bytesErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "bytes", codes, schema }; -} -export function bytes( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "bytes", codes, schema }; -} - -export function streamErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "stream", codes, schema }; -} -export function stream( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "stream", codes, schema }; -} - -export function sseErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "sse", codes, schema }; -} -export function sse( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "sse", codes, schema }; -} - -export function nilErr( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ErrorMatcher { - return { ...options, err: true, enc: "nil", codes, schema }; -} -export function nil( - codes: StatusCodePredicate, - schema: Schema, - options?: MatchOptions, -): ValueMatcher { - return { ...options, enc: "nil", codes, schema }; -} - -export function fail(codes: StatusCodePredicate): FailMatcher { - return { enc: "fail", codes }; -} - -export type MatchedValue = Matchers extends Matcher[] - ? T - : never; -export type MatchedError = Matchers extends Matcher[] - ? E - : never; -export type MatchFunc = ( - response: Response, - request: Request, - options?: { resultKey?: string; extraFields?: Record }, -) => Promise<[result: Result, raw: unknown]>; - -export function match( - ...matchers: Array> -): MatchFunc { - return async function matchFunc( - response: Response, - request: Request, - options?: { resultKey?: string; extraFields?: Record }, - ): Promise< - [result: Result, raw: unknown] - > { - let raw: unknown; - let matcher: Matcher | undefined; - for (const match of matchers) { - const { codes } = match; - const ctpattern = "ctype" in match - ? match.ctype - : DEFAULT_CONTENT_TYPES[match.enc]; - if (ctpattern && matchResponse(response, codes, ctpattern)) { - matcher = match; - break; - } else if (!ctpattern && matchStatusCode(response, codes)) { - matcher = match; - break; - } - } - - if (!matcher) { - return [{ - ok: false, - error: new SDKError("Unexpected Status or Content-Type", { - response, - request, - body: await response.text().catch(() => ""), - }), - }, raw]; - } - - const encoding = matcher.enc; - let body = ""; - switch (encoding) { - case "json": - body = await response.text(); - raw = JSON.parse(body); - break; - case "jsonl": - raw = response.body; - break; - case "bytes": - raw = new Uint8Array(await response.arrayBuffer()); - break; - case "stream": - raw = response.body; - break; - case "text": - body = await response.text(); - raw = body; - break; - case "sse": - raw = response.body; - break; - case "nil": - body = await response.text(); - raw = undefined; - break; - case "fail": - body = await response.text(); - raw = body; - break; - default: - encoding satisfies never; - throw new Error(`Unsupported response type: ${encoding}`); - } - - if (matcher.enc === "fail") { - return [{ - ok: false, - error: new SDKError("API error occurred", { request, response, body }), - }, raw]; - } - - const resultKey = matcher.key || options?.resultKey; - let data: unknown; - - if ("err" in matcher) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - request$: request, - response$: response, - body$: body, - }; - } else if (resultKey) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - [resultKey]: raw, - }; - } else if (matcher.hdrs) { - data = { - ...options?.extraFields, - ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null), - ...(isPlainObject(raw) ? raw : null), - }; - } else { - data = raw; - } - - if ("err" in matcher) { - const result = safeParseResponse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - { request, response, body }, - ); - return [result.ok ? { ok: false, error: result.value } : result, raw]; - } else { - return [ - safeParseResponse( - data, - (v: unknown) => matcher.schema.parse(v), - "Response validation failed", - { request, response, body }, - ), - raw, - ]; - } - }; -} - -const headerValRE = /, */; -/** - * Iterates over a Headers object and returns an object with all the header - * entries. Values are represented as an array to account for repeated headers. - */ -export function unpackHeaders(headers: Headers): Record { - const out: Record = {}; - - for (const [k, v] of headers.entries()) { - out[k] = v.split(headerValRE); - } - - return out; -} - -function safeParseResponse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, - httpMeta: { response: Response; request: Request; body: string }, -): Result { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR( - new ResponseValidationError(errorMessage, { - cause: err, - rawValue, - rawMessage: errorMessage, - ...httpMeta, - }), - ); - } -} diff --git a/examples/sdks/mistral-typescript/src/lib/primitives.ts b/examples/sdks/mistral-typescript/src/lib/primitives.ts deleted file mode 100644 index d21f1dc49..000000000 --- a/examples/sdks/mistral-typescript/src/lib/primitives.ts +++ /dev/null @@ -1,150 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -class InvariantError extends Error { - constructor(message: string) { - super(message); - this.name = "InvariantError"; - } -} - -export function invariant( - condition: unknown, - message: string, -): asserts condition { - if (!condition) { - throw new InvariantError(message); - } -} - -export type ExactPartial = { - [P in keyof T]?: T[P] | undefined; -}; - -export type Remap = { - [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */ - ? Mapping[k] - : Mapping[k] extends null /* if the mapping is to `null` then drop the key */ - ? never - : k /* otherwise keep the key as-is */]: Inp[k]; -}; - -/** - * Converts or omits an object's keys according to a mapping. - * - * @param inp An object whose keys will be remapped - * @param mappings A mapping of original keys to new keys. If a key is not present in the mapping, it will be left as is. If a key is mapped to `null`, it will be removed in the resulting object. - * @returns A new object with keys remapped or omitted according to the mappings - */ -export function remap< - Inp extends Record, - const Mapping extends { [k in keyof Inp]?: string | null }, ->(inp: Inp, mappings: Mapping): Remap { - let out: any = {}; - - if (!Object.keys(mappings).length) { - out = inp; - return out; - } - - for (const [k, v] of Object.entries(inp)) { - const j = mappings[k]; - if (j === null) { - continue; - } - out[j ?? k] = v; - } - - return out; -} - -export function combineSignals( - ...signals: Array -): AbortSignal | null { - const filtered: AbortSignal[] = []; - for (const signal of signals) { - if (signal) { - filtered.push(signal); - } - } - - switch (filtered.length) { - case 0: - case 1: - return filtered[0] || null; - default: - if ("any" in AbortSignal && typeof AbortSignal.any === "function") { - return AbortSignal.any(filtered); - } - return abortSignalAny(filtered); - } -} - -export function abortSignalAny(signals: AbortSignal[]): AbortSignal { - const controller = new AbortController(); - const result = controller.signal; - if (!signals.length) { - return controller.signal; - } - - if (signals.length === 1) { - return signals[0] || controller.signal; - } - - for (const signal of signals) { - if (signal.aborted) { - return signal; - } - } - - function abort(this: AbortSignal) { - controller.abort(this.reason); - clean(); - } - - const signalRefs: WeakRef[] = []; - function clean() { - for (const signalRef of signalRefs) { - const signal = signalRef.deref(); - if (signal) { - signal.removeEventListener("abort", abort); - } - } - } - - for (const signal of signals) { - signalRefs.push(new WeakRef(signal)); - signal.addEventListener("abort", abort); - } - - return result; -} - -export function compactMap( - values: Record, -): Record { - const out: Record = {}; - - for (const [k, v] of Object.entries(values)) { - if (typeof v !== "undefined") { - out[k] = v; - } - } - - return out; -} - -export function allRequired>( - v: V, -): - | { - [K in keyof V]: NonNullable; - } - | undefined { - if (Object.values(v).every((x) => x == null)) { - return void 0; - } - - return v as ReturnType>; -} diff --git a/examples/sdks/mistral-typescript/src/lib/retries.ts b/examples/sdks/mistral-typescript/src/lib/retries.ts deleted file mode 100644 index e3ce9aba7..000000000 --- a/examples/sdks/mistral-typescript/src/lib/retries.ts +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { isConnectionError, isTimeoutError } from "./http.js"; - -export type BackoffStrategy = { - initialInterval: number; - maxInterval: number; - exponent: number; - maxElapsedTime: number; -}; - -const defaultBackoff: BackoffStrategy = { - initialInterval: 500, - maxInterval: 60000, - exponent: 1.5, - maxElapsedTime: 3600000, -}; - -export type RetryConfig = - | { strategy: "none" } - | { - strategy: "backoff"; - backoff?: BackoffStrategy; - retryConnectionErrors?: boolean; - }; - -/** - * PermanentError is an error that is not recoverable. Throwing this error will - * cause a retry loop to terminate. - */ -export class PermanentError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - - constructor(message: string, options?: { cause?: unknown }) { - let msg = message; - if (options?.cause) { - msg += `: ${options.cause}`; - } - - super(msg, options); - this.name = "PermanentError"; - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = options?.cause; - } - - Object.setPrototypeOf(this, PermanentError.prototype); - } -} - -/** - * TemporaryError is an error is used to signal that an HTTP request can be - * retried as part of a retry loop. If retry attempts are exhausted and this - * error is thrown, the response will be returned to the caller. - */ -export class TemporaryError extends Error { - response: Response; - - constructor(message: string, response: Response) { - super(message); - this.response = response; - this.name = "TemporaryError"; - - Object.setPrototypeOf(this, TemporaryError.prototype); - } -} - -export async function retry( - fetchFn: () => Promise, - options: { - config: RetryConfig; - statusCodes: string[]; - }, -): Promise { - switch (options.config.strategy) { - case "backoff": - return retryBackoff( - wrapFetcher(fetchFn, { - statusCodes: options.statusCodes, - retryConnectionErrors: !!options.config.retryConnectionErrors, - }), - options.config.backoff ?? defaultBackoff, - ); - default: - return await fetchFn(); - } -} - -function wrapFetcher( - fn: () => Promise, - options: { - statusCodes: string[]; - retryConnectionErrors: boolean; - }, -): () => Promise { - return async () => { - try { - const res = await fn(); - if (isRetryableResponse(res, options.statusCodes)) { - throw new TemporaryError( - "Response failed with retryable status code", - res, - ); - } - - return res; - } catch (err: unknown) { - if (err instanceof TemporaryError) { - throw err; - } - - if ( - options.retryConnectionErrors && - (isTimeoutError(err) || isConnectionError(err)) - ) { - throw err; - } - - throw new PermanentError("Permanent error", { cause: err }); - } - }; -} - -const codeRangeRE = new RegExp("^[0-9]xx$", "i"); - -function isRetryableResponse(res: Response, statusCodes: string[]): boolean { - const actual = `${res.status}`; - - return statusCodes.some((code) => { - if (!codeRangeRE.test(code)) { - return code === actual; - } - - const expectFamily = code.charAt(0); - if (!expectFamily) { - throw new Error("Invalid status code range"); - } - - const actualFamily = actual.charAt(0); - if (!actualFamily) { - throw new Error(`Invalid response status code: ${actual}`); - } - - return actualFamily === expectFamily; - }); -} - -async function retryBackoff( - fn: () => Promise, - strategy: BackoffStrategy, -): Promise { - const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy; - - const start = Date.now(); - let x = 0; - - while (true) { - try { - const res = await fn(); - return res; - } catch (err: unknown) { - if (err instanceof PermanentError) { - throw err.cause; - } - const elapsed = Date.now() - start; - if (elapsed > maxElapsedTime) { - if (err instanceof TemporaryError) { - return err.response; - } - - throw err; - } - - let retryInterval = 0; - if (err instanceof TemporaryError) { - retryInterval = retryIntervalFromResponse(err.response); - } - - if (retryInterval <= 0) { - retryInterval = - initialInterval * Math.pow(x, exponent) + Math.random() * 1000; - } - - const d = Math.min(retryInterval, maxInterval); - - await delay(d); - x++; - } - } -} - -function retryIntervalFromResponse(res: Response): number { - const retryVal = res.headers.get("retry-after") || ""; - if (!retryVal) { - return 0; - } - - const parsedNumber = Number(retryVal); - if (Number.isInteger(parsedNumber)) { - return parsedNumber * 1000; - } - - const parsedDate = Date.parse(retryVal); - if (Number.isInteger(parsedDate)) { - const deltaMS = parsedDate - Date.now(); - return deltaMS > 0 ? Math.ceil(deltaMS) : 0; - } - - return 0; -} - -async function delay(delay: number): Promise { - return new Promise((resolve) => setTimeout(resolve, delay)); -} diff --git a/examples/sdks/mistral-typescript/src/lib/schemas.ts b/examples/sdks/mistral-typescript/src/lib/schemas.ts deleted file mode 100644 index 0e340b7e4..000000000 --- a/examples/sdks/mistral-typescript/src/lib/schemas.ts +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { - output, - ZodEffects, - ZodError, - ZodObject, - ZodRawShape, - ZodTypeAny, -} from "zod"; -import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; -import { ERR, OK, Result } from "../types/fp.js"; - -/** - * Utility function that executes some code which may throw a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function parse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Out { - try { - return fn(rawValue); - } catch (err) { - if (err instanceof ZodError) { - throw new SDKValidationError(errorMessage, err, rawValue); - } - throw err; - } -} - -/** - * Utility function that executes some code which may result in a ZodError. It - * intercepts this error and converts it to an SDKValidationError so as to not - * leak Zod implementation details to user code. - */ -export function safeParse( - rawValue: Inp, - fn: (value: Inp) => Out, - errorMessage: string, -): Result { - try { - return OK(fn(rawValue)); - } catch (err) { - return ERR(new SDKValidationError(errorMessage, err, rawValue)); - } -} - -export function collectExtraKeys< - Shape extends ZodRawShape, - Catchall extends ZodTypeAny, - K extends string, ->( - obj: ZodObject, - extrasKey: K, - optional: boolean, -): ZodEffects< - typeof obj, - & output> - & { - [k in K]: Record>; - } -> { - return obj.transform((val) => { - const extras: Record> = {}; - const { shape } = obj; - for (const [key] of Object.entries(val)) { - if (key in shape) { - continue; - } - - const v = val[key]; - if (typeof v === "undefined") { - continue; - } - - extras[key] = v; - delete val[key]; - } - - if (optional && Object.keys(extras).length === 0) { - return val; - } - - return { ...val, [extrasKey]: extras }; - }); -} diff --git a/examples/sdks/mistral-typescript/src/lib/sdks.ts b/examples/sdks/mistral-typescript/src/lib/sdks.ts deleted file mode 100644 index a5c602eed..000000000 --- a/examples/sdks/mistral-typescript/src/lib/sdks.ts +++ /dev/null @@ -1,407 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { SDKHooks } from "../hooks/hooks.js"; -import { HookContext } from "../hooks/types.js"; -import { - ConnectionError, - InvalidRequestError, - RequestAbortedError, - RequestTimeoutError, - UnexpectedClientError, -} from "../models/errors/httpclienterrors.js"; -import { ERR, OK, Result } from "../types/fp.js"; -import { stringToBase64 } from "./base64.js"; -import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js"; -import { encodeForm } from "./encodings.js"; -import { env } from "./env.js"; -import { - HTTPClient, - isAbortError, - isConnectionError, - isTimeoutError, - matchContentType, - matchStatusCode, -} from "./http.js"; -import { Logger } from "./logger.js"; -import { retry, RetryConfig } from "./retries.js"; -import { SecurityState } from "./security.js"; - -export type RequestOptions = { - /** - * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If - * `fetchOptions.signal` is set then it will take precedence over this option. - */ - timeoutMs?: number; - /** - * Set or override a retry policy on HTTP calls. - */ - retries?: RetryConfig; - /** - * Specifies the status codes which should be retried using the given retry policy. - */ - retryCodes?: string[]; - /** - * Overrides the base server URL that will be used by an operation. - */ - serverURL?: string | URL; - /** - * @deprecated `fetchOptions` has been flattened into `RequestOptions`. - * - * Sets various request options on the `fetch` call made by an SDK method. - * - * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request} - */ - fetchOptions?: Omit; -} & Omit; - -type RequestConfig = { - method: string; - path: string; - baseURL?: string | URL | undefined; - query?: string; - body?: RequestInit["body"]; - headers?: HeadersInit; - security?: SecurityState | null; - uaHeader?: string; - userAgent?: string | undefined; - timeoutMs?: number; -}; - -const gt: unknown = typeof globalThis === "undefined" ? null : globalThis; -const webWorkerLike = typeof gt === "object" - && gt != null - && "importScripts" in gt - && typeof gt["importScripts"] === "function"; -const isBrowserLike = webWorkerLike - || (typeof navigator !== "undefined" && "serviceWorker" in navigator) - || (typeof window === "object" && typeof window.document !== "undefined"); - -export class ClientSDK { - readonly #httpClient: HTTPClient; - readonly #hooks: SDKHooks; - readonly #logger?: Logger | undefined; - public readonly _baseURL: URL | null; - public readonly _options: SDKOptions & { hooks?: SDKHooks }; - - constructor(options: SDKOptions = {}) { - const opt = options as unknown; - if ( - typeof opt === "object" - && opt != null - && "hooks" in opt - && opt.hooks instanceof SDKHooks - ) { - this.#hooks = opt.hooks; - } else { - this.#hooks = new SDKHooks(); - } - const url = serverURLFromOptions(options); - if (url) { - url.pathname = url.pathname.replace(/\/+$/, "") + "/"; - } - - const { baseURL, client } = this.#hooks.sdkInit({ - baseURL: url, - client: options.httpClient || new HTTPClient(), - }); - this._baseURL = baseURL; - this.#httpClient = client; - - this._options = { ...options, hooks: this.#hooks }; - - this.#logger = this._options.debugLogger; - if (!this.#logger && env().MISTRAL_DEBUG) { - this.#logger = console; - } - } - - public _createRequest( - context: HookContext, - conf: RequestConfig, - options?: RequestOptions, - ): Result { - const { method, path, query, headers: opHeaders, security } = conf; - - const base = conf.baseURL ?? this._baseURL; - if (!base) { - return ERR(new InvalidRequestError("No base URL provided for operation")); - } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - - if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); - } - - let finalQuery = query || ""; - - const secQuery: string[] = []; - for (const [k, v] of Object.entries(security?.queryParams || {})) { - const q = encodeForm(k, v, { charEncoding: "percent" }); - if (typeof q !== "undefined") { - secQuery.push(q); - } - } - if (secQuery.length) { - finalQuery += `&${secQuery.join("&")}`; - } - - if (finalQuery) { - const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery; - reqURL.search = `?${q}`; - } - - const headers = new Headers(opHeaders); - - const username = security?.basic.username; - const password = security?.basic.password; - if (username != null || password != null) { - const encoded = stringToBase64( - [username || "", password || ""].join(":"), - ); - headers.set("Authorization", `Basic ${encoded}`); - } - - const securityHeaders = new Headers(security?.headers || {}); - for (const [k, v] of securityHeaders) { - headers.set(k, v); - } - - let cookie = headers.get("cookie") || ""; - for (const [k, v] of Object.entries(security?.cookies || {})) { - cookie += `; ${k}=${v}`; - } - cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie; - headers.set("cookie", cookie); - - const userHeaders = new Headers( - options?.headers ?? options?.fetchOptions?.headers, - ); - for (const [k, v] of userHeaders) { - headers.set(k, v); - } - - // Only set user agent header in non-browser-like environments since CORS - // policy disallows setting it in browsers e.g. Chrome throws an error. - if (!isBrowserLike) { - headers.set( - conf.uaHeader ?? "user-agent", - conf.userAgent ?? SDK_METADATA.userAgent, - ); - } - - const fetchOptions: Omit = { - ...options?.fetchOptions, - ...options, - }; - if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) { - const timeoutSignal = AbortSignal.timeout(conf.timeoutMs); - fetchOptions.signal = timeoutSignal; - } - - if (conf.body instanceof ReadableStream) { - Object.assign(fetchOptions, { duplex: "half" }); - } - - let input; - try { - input = this.#hooks.beforeCreateRequest(context, { - url: reqURL, - options: { - ...fetchOptions, - body: conf.body ?? null, - headers, - method, - }, - }); - } catch (err: unknown) { - return ERR( - new UnexpectedClientError("Create request hook failed to execute", { - cause: err, - }), - ); - } - - return OK(new Request(input.url, input.options)); - } - - public async _do( - request: Request, - options: { - context: HookContext; - errorCodes: number | string | (number | string)[]; - retryConfig: RetryConfig; - retryCodes: string[]; - }, - ): Promise< - Result< - Response, - | RequestAbortedError - | RequestTimeoutError - | ConnectionError - | UnexpectedClientError - > - > { - const { context, errorCodes } = options; - - return retry( - async () => { - const req = await this.#hooks.beforeRequest(context, request.clone()); - await logRequest(this.#logger, req).catch((e) => - this.#logger?.log("Failed to log request:", e) - ); - - let response = await this.#httpClient.request(req); - - try { - if (matchStatusCode(response, errorCodes)) { - const result = await this.#hooks.afterError( - context, - response, - null, - ); - if (result.error) { - throw result.error; - } - response = result.response || response; - } else { - response = await this.#hooks.afterSuccess(context, response); - } - } finally { - await logResponse(this.#logger, response, req) - .catch(e => this.#logger?.log("Failed to log response:", e)); - } - - return response; - }, - { config: options.retryConfig, statusCodes: options.retryCodes }, - ).then( - (r) => OK(r), - (err) => { - switch (true) { - case isAbortError(err): - return ERR( - new RequestAbortedError("Request aborted by client", { - cause: err, - }), - ); - case isTimeoutError(err): - return ERR( - new RequestTimeoutError("Request timed out", { cause: err }), - ); - case isConnectionError(err): - return ERR( - new ConnectionError("Unable to make request", { cause: err }), - ); - default: - return ERR( - new UnexpectedClientError("Unexpected HTTP client error", { - cause: err, - }), - ); - } - }, - ); - } -} - -const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; -const jsonlLikeContentTypeRE = - /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; -async function logRequest(logger: Logger | undefined, req: Request) { - if (!logger) { - return; - } - - const contentType = req.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`> Request: ${req.method} ${req.url}`); - - logger.group("Headers:"); - for (const [k, v] of req.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case jsonLikeContentTypeRE.test(ct): - logger.log(await req.clone().json()); - break; - case ct.startsWith("text/"): - logger.log(await req.clone().text()); - break; - case ct === "multipart/form-data": { - const body = await req.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} - -async function logResponse( - logger: Logger | undefined, - res: Response, - req: Request, -) { - if (!logger) { - return; - } - - const contentType = res.headers.get("content-type"); - const ct = contentType?.split(";")[0] || ""; - - logger.group(`< Response: ${req.method} ${req.url}`); - logger.log("Status Code:", res.status, res.statusText); - - logger.group("Headers:"); - for (const [k, v] of res.headers.entries()) { - logger.log(`${k}: ${v}`); - } - logger.groupEnd(); - - logger.group("Body:"); - switch (true) { - case matchContentType(res, "application/json") - || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct): - logger.log(await res.clone().json()); - break; - case matchContentType(res, "application/jsonl") - || jsonlLikeContentTypeRE.test(ct): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "text/event-stream"): - logger.log(`<${contentType}>`); - break; - case matchContentType(res, "text/*"): - logger.log(await res.clone().text()); - break; - case matchContentType(res, "multipart/form-data"): { - const body = await res.clone().formData(); - for (const [k, v] of body) { - const vlabel = v instanceof Blob ? "" : v; - logger.log(`${k}: ${vlabel}`); - } - break; - } - default: - logger.log(`<${contentType}>`); - break; - } - logger.groupEnd(); - - logger.groupEnd(); -} diff --git a/examples/sdks/mistral-typescript/src/lib/security.ts b/examples/sdks/mistral-typescript/src/lib/security.ts deleted file mode 100644 index 209f790b6..000000000 --- a/examples/sdks/mistral-typescript/src/lib/security.ts +++ /dev/null @@ -1,264 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as components from "../models/components/index.js"; -import { env } from "./env.js"; - -type OAuth2PasswordFlow = { - username: string; - password: string; - clientID?: string | undefined; - clientSecret?: string | undefined; - tokenURL: string; -}; - -export enum SecurityErrorCode { - Incomplete = "incomplete", - UnrecognisedSecurityType = "unrecognized_security_type", -} - -export class SecurityError extends Error { - constructor( - public code: SecurityErrorCode, - message: string, - ) { - super(message); - this.name = "SecurityError"; - } - - static incomplete(): SecurityError { - return new SecurityError( - SecurityErrorCode.Incomplete, - "Security requirements not met in order to perform the operation", - ); - } - static unrecognizedType(type: string): SecurityError { - return new SecurityError( - SecurityErrorCode.UnrecognisedSecurityType, - `Unrecognised security type: ${type}`, - ); - } -} - -export type SecurityState = { - basic: { username?: string | undefined; password?: string | undefined }; - headers: Record; - queryParams: Record; - cookies: Record; - oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" }; -}; - -type SecurityInputBasic = { - type: "http:basic"; - value: - | { username?: string | undefined; password?: string | undefined } - | null - | undefined; -}; - -type SecurityInputBearer = { - type: "http:bearer"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputAPIKey = { - type: "apiKey:header" | "apiKey:query" | "apiKey:cookie"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOIDC = { - type: "openIdConnect"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2 = { - type: "oauth2"; - value: string | null | undefined; - fieldName: string; -}; - -type SecurityInputOAuth2ClientCredentials = { - type: "oauth2:client_credentials"; - value: - | { - clientID?: string | undefined; - clientSecret?: string | undefined; - } - | null - | string - | undefined; - fieldName?: string; -}; - -type SecurityInputOAuth2PasswordCredentials = { - type: "oauth2:password"; - value: - | string - | null - | undefined; - fieldName?: string; -}; - -type SecurityInputCustom = { - type: "http:custom"; - value: any | null | undefined; - fieldName?: string; -}; - -export type SecurityInput = - | SecurityInputBasic - | SecurityInputBearer - | SecurityInputAPIKey - | SecurityInputOAuth2 - | SecurityInputOAuth2ClientCredentials - | SecurityInputOAuth2PasswordCredentials - | SecurityInputOIDC - | SecurityInputCustom; - -export function resolveSecurity( - ...options: SecurityInput[][] -): SecurityState | null { - const state: SecurityState = { - basic: {}, - headers: {}, - queryParams: {}, - cookies: {}, - oauth2: { type: "none" }, - }; - - const option = options.find((opts) => { - return opts.every((o) => { - if (o.value == null) { - return false; - } else if (o.type === "http:basic") { - return o.value.username != null || o.value.password != null; - } else if (o.type === "http:custom") { - return null; - } else if (o.type === "oauth2:password") { - return ( - typeof o.value === "string" && !!o.value - ); - } else if (o.type === "oauth2:client_credentials") { - if (typeof o.value == "string") { - return !!o.value; - } - return o.value.clientID != null || o.value.clientSecret != null; - } else if (typeof o.value === "string") { - return !!o.value; - } else { - throw new Error( - `Unrecognized security type: ${o.type} (value type: ${typeof o - .value})`, - ); - } - }); - }); - if (option == null) { - return null; - } - - option.forEach((spec) => { - if (spec.value == null) { - return; - } - - const { type } = spec; - - switch (type) { - case "apiKey:header": - state.headers[spec.fieldName] = spec.value; - break; - case "apiKey:query": - state.queryParams[spec.fieldName] = spec.value; - break; - case "apiKey:cookie": - state.cookies[spec.fieldName] = spec.value; - break; - case "http:basic": - applyBasic(state, spec); - break; - case "http:custom": - break; - case "http:bearer": - applyBearer(state, spec); - break; - case "oauth2": - applyBearer(state, spec); - break; - case "oauth2:password": - applyBearer(state, spec); - break; - case "oauth2:client_credentials": - break; - case "openIdConnect": - applyBearer(state, spec); - break; - default: - spec satisfies never; - throw SecurityError.unrecognizedType(type); - } - }); - - return state; -} - -function applyBasic( - state: SecurityState, - spec: SecurityInputBasic, -) { - if (spec.value == null) { - return; - } - - state.basic = spec.value; -} - -function applyBearer( - state: SecurityState, - spec: - | SecurityInputBearer - | SecurityInputOAuth2 - | SecurityInputOIDC - | SecurityInputOAuth2PasswordCredentials, -) { - if (typeof spec.value !== "string" || !spec.value) { - return; - } - - let value = spec.value; - if (value.slice(0, 7).toLowerCase() !== "bearer ") { - value = `Bearer ${value}`; - } - - if (spec.fieldName !== undefined) { - state.headers[spec.fieldName] = value; - } -} - -export function resolveGlobalSecurity( - security: Partial | null | undefined, -): SecurityState | null { - return resolveSecurity( - [ - { - fieldName: "Authorization", - type: "http:bearer", - value: security?.apiKey ?? env().MISTRAL_API_KEY, - }, - ], - ); -} - -export async function extractSecurity< - T extends string | Record, ->(sec: T | (() => Promise) | undefined): Promise { - if (sec == null) { - return; - } - - return typeof sec === "function" ? sec() : sec; -} diff --git a/examples/sdks/mistral-typescript/src/lib/url.ts b/examples/sdks/mistral-typescript/src/lib/url.ts deleted file mode 100644 index 6bc6356e2..000000000 --- a/examples/sdks/mistral-typescript/src/lib/url.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const hasOwn = Object.prototype.hasOwnProperty; - -export type Params = Partial>; - -export function pathToFunc( - pathPattern: string, - options?: { charEncoding?: "percent" | "none" }, -): (params?: Params) => string { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; - - return function buildURLPath(params: Record = {}): string { - return pathPattern.replace(paramRE, function (_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } - - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error( - `Parameter '${placeholder}' must be a string or number`, - ); - } - - return options?.charEncoding === "percent" - ? encodeURIComponent(`${value}`) - : `${value}`; - }); - }; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agent.ts b/examples/sdks/mistral-typescript/src/models/components/agent.ts deleted file mode 100644 index 89ee79803..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agent.ts +++ /dev/null @@ -1,400 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export type AgentTools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export const AgentObject = { - Agent: "agent", -} as const; -export type AgentObject = ClosedEnum; - -export type Agent = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object?: AgentObject | undefined; - id: string; - version: number; - createdAt: Date; - updatedAt: Date; -}; - -/** @internal */ -export const AgentTools$inboundSchema: z.ZodType< - AgentTools, - z.ZodTypeDef, - unknown -> = z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type AgentTools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const AgentTools$outboundSchema: z.ZodType< - AgentTools$Outbound, - z.ZodTypeDef, - AgentTools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentTools$ { - /** @deprecated use `AgentTools$inboundSchema` instead. */ - export const inboundSchema = AgentTools$inboundSchema; - /** @deprecated use `AgentTools$outboundSchema` instead. */ - export const outboundSchema = AgentTools$outboundSchema; - /** @deprecated use `AgentTools$Outbound` instead. */ - export type Outbound = AgentTools$Outbound; -} - -export function agentToolsToJSON(agentTools: AgentTools): string { - return JSON.stringify(AgentTools$outboundSchema.parse(agentTools)); -} - -export function agentToolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentTools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentTools' from JSON`, - ); -} - -/** @internal */ -export const AgentObject$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(AgentObject); - -/** @internal */ -export const AgentObject$outboundSchema: z.ZodNativeEnum = - AgentObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentObject$ { - /** @deprecated use `AgentObject$inboundSchema` instead. */ - export const inboundSchema = AgentObject$inboundSchema; - /** @deprecated use `AgentObject$outboundSchema` instead. */ - export const outboundSchema = AgentObject$outboundSchema; -} - -/** @internal */ -export const Agent$inboundSchema: z.ZodType = z - .object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ).optional(), - completion_args: CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: AgentObject$inboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - created_at: z.string().datetime({ offset: true }).transform(v => - new Date(v) - ), - updated_at: z.string().datetime({ offset: true }).transform(v => - new Date(v) - ), - }).transform((v) => { - return remap$(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt", - }); - }); - -/** @internal */ -export type Agent$Outbound = { - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; - object: string; - id: string; - version: number; - created_at: string; - updated_at: string; -}; - -/** @internal */ -export const Agent$outboundSchema: z.ZodType< - Agent$Outbound, - z.ZodTypeDef, - Agent -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completionArgs: CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), - object: AgentObject$outboundSchema.default("agent"), - id: z.string(), - version: z.number().int(), - createdAt: z.date().transform(v => v.toISOString()), - updatedAt: z.date().transform(v => v.toISOString()), -}).transform((v) => { - return remap$(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Agent$ { - /** @deprecated use `Agent$inboundSchema` instead. */ - export const inboundSchema = Agent$inboundSchema; - /** @deprecated use `Agent$outboundSchema` instead. */ - export const outboundSchema = Agent$outboundSchema; - /** @deprecated use `Agent$Outbound` instead. */ - export type Outbound = Agent$Outbound; -} - -export function agentToJSON(agent: Agent): string { - return JSON.stringify(Agent$outboundSchema.parse(agent)); -} - -export function agentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Agent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Agent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agentconversation.ts b/examples/sdks/mistral-typescript/src/models/components/agentconversation.ts deleted file mode 100644 index fed60e82c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agentconversation.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const AgentConversationObject = { - Conversation: "conversation", -} as const; -export type AgentConversationObject = ClosedEnum< - typeof AgentConversationObject ->; - -export type AgentConversation = { - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: AgentConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - agentId: string; -}; - -/** @internal */ -export const AgentConversationObject$inboundSchema: z.ZodNativeEnum< - typeof AgentConversationObject -> = z.nativeEnum(AgentConversationObject); - -/** @internal */ -export const AgentConversationObject$outboundSchema: z.ZodNativeEnum< - typeof AgentConversationObject -> = AgentConversationObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentConversationObject$ { - /** @deprecated use `AgentConversationObject$inboundSchema` instead. */ - export const inboundSchema = AgentConversationObject$inboundSchema; - /** @deprecated use `AgentConversationObject$outboundSchema` instead. */ - export const outboundSchema = AgentConversationObject$outboundSchema; -} - -/** @internal */ -export const AgentConversation$inboundSchema: z.ZodType< - AgentConversation, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: AgentConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - agent_id: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type AgentConversation$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - agent_id: string; -}; - -/** @internal */ -export const AgentConversation$outboundSchema: z.ZodType< - AgentConversation$Outbound, - z.ZodTypeDef, - AgentConversation -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: AgentConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform(v => v.toISOString()), - updatedAt: z.date().transform(v => v.toISOString()), - agentId: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - updatedAt: "updated_at", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentConversation$ { - /** @deprecated use `AgentConversation$inboundSchema` instead. */ - export const inboundSchema = AgentConversation$inboundSchema; - /** @deprecated use `AgentConversation$outboundSchema` instead. */ - export const outboundSchema = AgentConversation$outboundSchema; - /** @deprecated use `AgentConversation$Outbound` instead. */ - export type Outbound = AgentConversation$Outbound; -} - -export function agentConversationToJSON( - agentConversation: AgentConversation, -): string { - return JSON.stringify( - AgentConversation$outboundSchema.parse(agentConversation), - ); -} - -export function agentConversationFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentConversation$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentConversation' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agentcreationrequest.ts b/examples/sdks/mistral-typescript/src/models/components/agentcreationrequest.ts deleted file mode 100644 index d02226af1..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agentcreationrequest.ts +++ /dev/null @@ -1,358 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export type AgentCreationRequestTools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export type AgentCreationRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -export const AgentCreationRequestTools$inboundSchema: z.ZodType< - AgentCreationRequestTools, - z.ZodTypeDef, - unknown -> = z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type AgentCreationRequestTools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const AgentCreationRequestTools$outboundSchema: z.ZodType< - AgentCreationRequestTools$Outbound, - z.ZodTypeDef, - AgentCreationRequestTools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentCreationRequestTools$ { - /** @deprecated use `AgentCreationRequestTools$inboundSchema` instead. */ - export const inboundSchema = AgentCreationRequestTools$inboundSchema; - /** @deprecated use `AgentCreationRequestTools$outboundSchema` instead. */ - export const outboundSchema = AgentCreationRequestTools$outboundSchema; - /** @deprecated use `AgentCreationRequestTools$Outbound` instead. */ - export type Outbound = AgentCreationRequestTools$Outbound; -} - -export function agentCreationRequestToolsToJSON( - agentCreationRequestTools: AgentCreationRequestTools, -): string { - return JSON.stringify( - AgentCreationRequestTools$outboundSchema.parse(agentCreationRequestTools), - ); -} - -export function agentCreationRequestToolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentCreationRequestTools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentCreationRequestTools' from JSON`, - ); -} - -/** @internal */ -export const AgentCreationRequest$inboundSchema: z.ZodType< - AgentCreationRequest, - z.ZodTypeDef, - unknown -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completion_args: CompletionArgs$inboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), -}).transform((v) => { - return remap$(v, { - "completion_args": "completionArgs", - }); -}); - -/** @internal */ -export type AgentCreationRequest$Outbound = { - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model: string; - name: string; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -export const AgentCreationRequest$outboundSchema: z.ZodType< - AgentCreationRequest$Outbound, - z.ZodTypeDef, - AgentCreationRequest -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completionArgs: CompletionArgs$outboundSchema.optional(), - model: z.string(), - name: z.string(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), -}).transform((v) => { - return remap$(v, { - completionArgs: "completion_args", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentCreationRequest$ { - /** @deprecated use `AgentCreationRequest$inboundSchema` instead. */ - export const inboundSchema = AgentCreationRequest$inboundSchema; - /** @deprecated use `AgentCreationRequest$outboundSchema` instead. */ - export const outboundSchema = AgentCreationRequest$outboundSchema; - /** @deprecated use `AgentCreationRequest$Outbound` instead. */ - export type Outbound = AgentCreationRequest$Outbound; -} - -export function agentCreationRequestToJSON( - agentCreationRequest: AgentCreationRequest, -): string { - return JSON.stringify( - AgentCreationRequest$outboundSchema.parse(agentCreationRequest), - ); -} - -export function agentCreationRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentCreationRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentCreationRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agenthandoffdoneevent.ts b/examples/sdks/mistral-typescript/src/models/components/agenthandoffdoneevent.ts deleted file mode 100644 index e664df786..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agenthandoffdoneevent.ts +++ /dev/null @@ -1,131 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const AgentHandoffDoneEventType = { - AgentHandoffDone: "agent.handoff.done", -} as const; -export type AgentHandoffDoneEventType = ClosedEnum< - typeof AgentHandoffDoneEventType ->; - -export type AgentHandoffDoneEvent = { - type?: AgentHandoffDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - nextAgentId: string; - nextAgentName: string; -}; - -/** @internal */ -export const AgentHandoffDoneEventType$inboundSchema: z.ZodNativeEnum< - typeof AgentHandoffDoneEventType -> = z.nativeEnum(AgentHandoffDoneEventType); - -/** @internal */ -export const AgentHandoffDoneEventType$outboundSchema: z.ZodNativeEnum< - typeof AgentHandoffDoneEventType -> = AgentHandoffDoneEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffDoneEventType$ { - /** @deprecated use `AgentHandoffDoneEventType$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffDoneEventType$inboundSchema; - /** @deprecated use `AgentHandoffDoneEventType$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffDoneEventType$outboundSchema; -} - -/** @internal */ -export const AgentHandoffDoneEvent$inboundSchema: z.ZodType< - AgentHandoffDoneEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: AgentHandoffDoneEventType$inboundSchema.default("agent.handoff.done"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName", - }); -}); - -/** @internal */ -export type AgentHandoffDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -export const AgentHandoffDoneEvent$outboundSchema: z.ZodType< - AgentHandoffDoneEvent$Outbound, - z.ZodTypeDef, - AgentHandoffDoneEvent -> = z.object({ - type: AgentHandoffDoneEventType$outboundSchema.default("agent.handoff.done"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffDoneEvent$ { - /** @deprecated use `AgentHandoffDoneEvent$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffDoneEvent$inboundSchema; - /** @deprecated use `AgentHandoffDoneEvent$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffDoneEvent$outboundSchema; - /** @deprecated use `AgentHandoffDoneEvent$Outbound` instead. */ - export type Outbound = AgentHandoffDoneEvent$Outbound; -} - -export function agentHandoffDoneEventToJSON( - agentHandoffDoneEvent: AgentHandoffDoneEvent, -): string { - return JSON.stringify( - AgentHandoffDoneEvent$outboundSchema.parse(agentHandoffDoneEvent), - ); -} - -export function agentHandoffDoneEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentHandoffDoneEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentHandoffDoneEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agenthandoffentry.ts b/examples/sdks/mistral-typescript/src/models/components/agenthandoffentry.ts deleted file mode 100644 index 31b3d9eff..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agenthandoffentry.ts +++ /dev/null @@ -1,175 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const AgentHandoffEntryObject = { - Entry: "entry", -} as const; -export type AgentHandoffEntryObject = ClosedEnum< - typeof AgentHandoffEntryObject ->; - -export const AgentHandoffEntryType = { - AgentHandoff: "agent.handoff", -} as const; -export type AgentHandoffEntryType = ClosedEnum; - -export type AgentHandoffEntry = { - object?: AgentHandoffEntryObject | undefined; - type?: AgentHandoffEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - previousAgentId: string; - previousAgentName: string; - nextAgentId: string; - nextAgentName: string; -}; - -/** @internal */ -export const AgentHandoffEntryObject$inboundSchema: z.ZodNativeEnum< - typeof AgentHandoffEntryObject -> = z.nativeEnum(AgentHandoffEntryObject); - -/** @internal */ -export const AgentHandoffEntryObject$outboundSchema: z.ZodNativeEnum< - typeof AgentHandoffEntryObject -> = AgentHandoffEntryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffEntryObject$ { - /** @deprecated use `AgentHandoffEntryObject$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffEntryObject$inboundSchema; - /** @deprecated use `AgentHandoffEntryObject$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffEntryObject$outboundSchema; -} - -/** @internal */ -export const AgentHandoffEntryType$inboundSchema: z.ZodNativeEnum< - typeof AgentHandoffEntryType -> = z.nativeEnum(AgentHandoffEntryType); - -/** @internal */ -export const AgentHandoffEntryType$outboundSchema: z.ZodNativeEnum< - typeof AgentHandoffEntryType -> = AgentHandoffEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffEntryType$ { - /** @deprecated use `AgentHandoffEntryType$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffEntryType$inboundSchema; - /** @deprecated use `AgentHandoffEntryType$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffEntryType$outboundSchema; -} - -/** @internal */ -export const AgentHandoffEntry$inboundSchema: z.ZodType< - AgentHandoffEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: AgentHandoffEntryObject$inboundSchema.default("entry"), - type: AgentHandoffEntryType$inboundSchema.default("agent.handoff"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - previous_agent_id: z.string(), - previous_agent_name: z.string(), - next_agent_id: z.string(), - next_agent_name: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName", - "next_agent_id": "nextAgentId", - "next_agent_name": "nextAgentName", - }); -}); - -/** @internal */ -export type AgentHandoffEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - previous_agent_id: string; - previous_agent_name: string; - next_agent_id: string; - next_agent_name: string; -}; - -/** @internal */ -export const AgentHandoffEntry$outboundSchema: z.ZodType< - AgentHandoffEntry$Outbound, - z.ZodTypeDef, - AgentHandoffEntry -> = z.object({ - object: AgentHandoffEntryObject$outboundSchema.default("entry"), - type: AgentHandoffEntryType$outboundSchema.default("agent.handoff"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - previousAgentId: z.string(), - previousAgentName: z.string(), - nextAgentId: z.string(), - nextAgentName: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name", - nextAgentId: "next_agent_id", - nextAgentName: "next_agent_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffEntry$ { - /** @deprecated use `AgentHandoffEntry$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffEntry$inboundSchema; - /** @deprecated use `AgentHandoffEntry$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffEntry$outboundSchema; - /** @deprecated use `AgentHandoffEntry$Outbound` instead. */ - export type Outbound = AgentHandoffEntry$Outbound; -} - -export function agentHandoffEntryToJSON( - agentHandoffEntry: AgentHandoffEntry, -): string { - return JSON.stringify( - AgentHandoffEntry$outboundSchema.parse(agentHandoffEntry), - ); -} - -export function agentHandoffEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentHandoffEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentHandoffEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agenthandoffstartedevent.ts b/examples/sdks/mistral-typescript/src/models/components/agenthandoffstartedevent.ts deleted file mode 100644 index 5817a0ceb..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agenthandoffstartedevent.ts +++ /dev/null @@ -1,135 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const AgentHandoffStartedEventType = { - AgentHandoffStarted: "agent.handoff.started", -} as const; -export type AgentHandoffStartedEventType = ClosedEnum< - typeof AgentHandoffStartedEventType ->; - -export type AgentHandoffStartedEvent = { - type?: AgentHandoffStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - previousAgentId: string; - previousAgentName: string; -}; - -/** @internal */ -export const AgentHandoffStartedEventType$inboundSchema: z.ZodNativeEnum< - typeof AgentHandoffStartedEventType -> = z.nativeEnum(AgentHandoffStartedEventType); - -/** @internal */ -export const AgentHandoffStartedEventType$outboundSchema: z.ZodNativeEnum< - typeof AgentHandoffStartedEventType -> = AgentHandoffStartedEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffStartedEventType$ { - /** @deprecated use `AgentHandoffStartedEventType$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffStartedEventType$inboundSchema; - /** @deprecated use `AgentHandoffStartedEventType$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffStartedEventType$outboundSchema; -} - -/** @internal */ -export const AgentHandoffStartedEvent$inboundSchema: z.ZodType< - AgentHandoffStartedEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: AgentHandoffStartedEventType$inboundSchema.default( - "agent.handoff.started", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - previous_agent_id: z.string(), - previous_agent_name: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "previous_agent_id": "previousAgentId", - "previous_agent_name": "previousAgentName", - }); -}); - -/** @internal */ -export type AgentHandoffStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - previous_agent_id: string; - previous_agent_name: string; -}; - -/** @internal */ -export const AgentHandoffStartedEvent$outboundSchema: z.ZodType< - AgentHandoffStartedEvent$Outbound, - z.ZodTypeDef, - AgentHandoffStartedEvent -> = z.object({ - type: AgentHandoffStartedEventType$outboundSchema.default( - "agent.handoff.started", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - previousAgentId: z.string(), - previousAgentName: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - previousAgentId: "previous_agent_id", - previousAgentName: "previous_agent_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentHandoffStartedEvent$ { - /** @deprecated use `AgentHandoffStartedEvent$inboundSchema` instead. */ - export const inboundSchema = AgentHandoffStartedEvent$inboundSchema; - /** @deprecated use `AgentHandoffStartedEvent$outboundSchema` instead. */ - export const outboundSchema = AgentHandoffStartedEvent$outboundSchema; - /** @deprecated use `AgentHandoffStartedEvent$Outbound` instead. */ - export type Outbound = AgentHandoffStartedEvent$Outbound; -} - -export function agentHandoffStartedEventToJSON( - agentHandoffStartedEvent: AgentHandoffStartedEvent, -): string { - return JSON.stringify( - AgentHandoffStartedEvent$outboundSchema.parse(agentHandoffStartedEvent), - ); -} - -export function agentHandoffStartedEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentHandoffStartedEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentHandoffStartedEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agentscompletionrequest.ts b/examples/sdks/mistral-typescript/src/models/components/agentscompletionrequest.ts deleted file mode 100644 index fd3afcfe1..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agentscompletionrequest.ts +++ /dev/null @@ -1,499 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type AgentsCompletionRequestStop = string | Array; - -export type AgentsCompletionRequestMessages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type AgentsCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type AgentsCompletionRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -/** @internal */ -export const AgentsCompletionRequestStop$inboundSchema: z.ZodType< - AgentsCompletionRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type AgentsCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -export const AgentsCompletionRequestStop$outboundSchema: z.ZodType< - AgentsCompletionRequestStop$Outbound, - z.ZodTypeDef, - AgentsCompletionRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionRequestStop$ { - /** @deprecated use `AgentsCompletionRequestStop$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionRequestStop$inboundSchema; - /** @deprecated use `AgentsCompletionRequestStop$outboundSchema` instead. */ - export const outboundSchema = AgentsCompletionRequestStop$outboundSchema; - /** @deprecated use `AgentsCompletionRequestStop$Outbound` instead. */ - export type Outbound = AgentsCompletionRequestStop$Outbound; -} - -export function agentsCompletionRequestStopToJSON( - agentsCompletionRequestStop: AgentsCompletionRequestStop, -): string { - return JSON.stringify( - AgentsCompletionRequestStop$outboundSchema.parse( - agentsCompletionRequestStop, - ), - ); -} - -export function agentsCompletionRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionRequestStop' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionRequestMessages$inboundSchema: z.ZodType< - AgentsCompletionRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type AgentsCompletionRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const AgentsCompletionRequestMessages$outboundSchema: z.ZodType< - AgentsCompletionRequestMessages$Outbound, - z.ZodTypeDef, - AgentsCompletionRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionRequestMessages$ { - /** @deprecated use `AgentsCompletionRequestMessages$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionRequestMessages$inboundSchema; - /** @deprecated use `AgentsCompletionRequestMessages$outboundSchema` instead. */ - export const outboundSchema = AgentsCompletionRequestMessages$outboundSchema; - /** @deprecated use `AgentsCompletionRequestMessages$Outbound` instead. */ - export type Outbound = AgentsCompletionRequestMessages$Outbound; -} - -export function agentsCompletionRequestMessagesToJSON( - agentsCompletionRequestMessages: AgentsCompletionRequestMessages, -): string { - return JSON.stringify( - AgentsCompletionRequestMessages$outboundSchema.parse( - agentsCompletionRequestMessages, - ), - ); -} - -export function agentsCompletionRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionRequestToolChoice$inboundSchema: z.ZodType< - AgentsCompletionRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type AgentsCompletionRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const AgentsCompletionRequestToolChoice$outboundSchema: z.ZodType< - AgentsCompletionRequestToolChoice$Outbound, - z.ZodTypeDef, - AgentsCompletionRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionRequestToolChoice$ { - /** @deprecated use `AgentsCompletionRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionRequestToolChoice$inboundSchema; - /** @deprecated use `AgentsCompletionRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = - AgentsCompletionRequestToolChoice$outboundSchema; - /** @deprecated use `AgentsCompletionRequestToolChoice$Outbound` instead. */ - export type Outbound = AgentsCompletionRequestToolChoice$Outbound; -} - -export function agentsCompletionRequestToolChoiceToJSON( - agentsCompletionRequestToolChoice: AgentsCompletionRequestToolChoice, -): string { - return JSON.stringify( - AgentsCompletionRequestToolChoice$outboundSchema.parse( - agentsCompletionRequestToolChoice, - ), - ); -} - -export function agentsCompletionRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionRequest$inboundSchema: z.ZodType< - AgentsCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - agent_id: z.string(), -}).transform((v) => { - return remap$(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type AgentsCompletionRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -export const AgentsCompletionRequest$outboundSchema: z.ZodType< - AgentsCompletionRequest$Outbound, - z.ZodTypeDef, - AgentsCompletionRequest -> = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - agentId: z.string(), -}).transform((v) => { - return remap$(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionRequest$ { - /** @deprecated use `AgentsCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionRequest$inboundSchema; - /** @deprecated use `AgentsCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = AgentsCompletionRequest$outboundSchema; - /** @deprecated use `AgentsCompletionRequest$Outbound` instead. */ - export type Outbound = AgentsCompletionRequest$Outbound; -} - -export function agentsCompletionRequestToJSON( - agentsCompletionRequest: AgentsCompletionRequest, -): string { - return JSON.stringify( - AgentsCompletionRequest$outboundSchema.parse(agentsCompletionRequest), - ); -} - -export function agentsCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agentscompletionstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/agentscompletionstreamrequest.ts deleted file mode 100644 index 80a9f7ba6..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agentscompletionstreamrequest.ts +++ /dev/null @@ -1,512 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type AgentsCompletionStreamRequestStop = string | Array; - -export type AgentsCompletionStreamRequestMessages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type AgentsCompletionStreamRequestToolChoice = - | ToolChoice - | ToolChoiceEnum; - -export type AgentsCompletionStreamRequest = { - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * The ID of the agent to use for this completion. - */ - agentId: string; -}; - -/** @internal */ -export const AgentsCompletionStreamRequestStop$inboundSchema: z.ZodType< - AgentsCompletionStreamRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type AgentsCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -export const AgentsCompletionStreamRequestStop$outboundSchema: z.ZodType< - AgentsCompletionStreamRequestStop$Outbound, - z.ZodTypeDef, - AgentsCompletionStreamRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionStreamRequestStop$ { - /** @deprecated use `AgentsCompletionStreamRequestStop$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionStreamRequestStop$inboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestStop$outboundSchema` instead. */ - export const outboundSchema = - AgentsCompletionStreamRequestStop$outboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestStop$Outbound` instead. */ - export type Outbound = AgentsCompletionStreamRequestStop$Outbound; -} - -export function agentsCompletionStreamRequestStopToJSON( - agentsCompletionStreamRequestStop: AgentsCompletionStreamRequestStop, -): string { - return JSON.stringify( - AgentsCompletionStreamRequestStop$outboundSchema.parse( - agentsCompletionStreamRequestStop, - ), - ); -} - -export function agentsCompletionStreamRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionStreamRequestStop' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionStreamRequestMessages$inboundSchema: z.ZodType< - AgentsCompletionStreamRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type AgentsCompletionStreamRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const AgentsCompletionStreamRequestMessages$outboundSchema: z.ZodType< - AgentsCompletionStreamRequestMessages$Outbound, - z.ZodTypeDef, - AgentsCompletionStreamRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionStreamRequestMessages$ { - /** @deprecated use `AgentsCompletionStreamRequestMessages$inboundSchema` instead. */ - export const inboundSchema = - AgentsCompletionStreamRequestMessages$inboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestMessages$outboundSchema` instead. */ - export const outboundSchema = - AgentsCompletionStreamRequestMessages$outboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestMessages$Outbound` instead. */ - export type Outbound = AgentsCompletionStreamRequestMessages$Outbound; -} - -export function agentsCompletionStreamRequestMessagesToJSON( - agentsCompletionStreamRequestMessages: AgentsCompletionStreamRequestMessages, -): string { - return JSON.stringify( - AgentsCompletionStreamRequestMessages$outboundSchema.parse( - agentsCompletionStreamRequestMessages, - ), - ); -} - -export function agentsCompletionStreamRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionStreamRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionStreamRequestToolChoice$inboundSchema: z.ZodType< - AgentsCompletionStreamRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type AgentsCompletionStreamRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const AgentsCompletionStreamRequestToolChoice$outboundSchema: z.ZodType< - AgentsCompletionStreamRequestToolChoice$Outbound, - z.ZodTypeDef, - AgentsCompletionStreamRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionStreamRequestToolChoice$ { - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = - AgentsCompletionStreamRequestToolChoice$inboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = - AgentsCompletionStreamRequestToolChoice$outboundSchema; - /** @deprecated use `AgentsCompletionStreamRequestToolChoice$Outbound` instead. */ - export type Outbound = AgentsCompletionStreamRequestToolChoice$Outbound; -} - -export function agentsCompletionStreamRequestToolChoiceToJSON( - agentsCompletionStreamRequestToolChoice: - AgentsCompletionStreamRequestToolChoice, -): string { - return JSON.stringify( - AgentsCompletionStreamRequestToolChoice$outboundSchema.parse( - agentsCompletionStreamRequestToolChoice, - ), - ); -} - -export function agentsCompletionStreamRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult< - AgentsCompletionStreamRequestToolChoice, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - AgentsCompletionStreamRequestToolChoice$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AgentsCompletionStreamRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const AgentsCompletionStreamRequest$inboundSchema: z.ZodType< - AgentsCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - agent_id: z.string(), -}).transform((v) => { - return remap$(v, { - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type AgentsCompletionStreamRequest$Outbound = { - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - agent_id: string; -}; - -/** @internal */ -export const AgentsCompletionStreamRequest$outboundSchema: z.ZodType< - AgentsCompletionStreamRequest$Outbound, - z.ZodTypeDef, - AgentsCompletionStreamRequest -> = z.object({ - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - agentId: z.string(), -}).transform((v) => { - return remap$(v, { - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsCompletionStreamRequest$ { - /** @deprecated use `AgentsCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsCompletionStreamRequest$inboundSchema; - /** @deprecated use `AgentsCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = AgentsCompletionStreamRequest$outboundSchema; - /** @deprecated use `AgentsCompletionStreamRequest$Outbound` instead. */ - export type Outbound = AgentsCompletionStreamRequest$Outbound; -} - -export function agentsCompletionStreamRequestToJSON( - agentsCompletionStreamRequest: AgentsCompletionStreamRequest, -): string { - return JSON.stringify( - AgentsCompletionStreamRequest$outboundSchema.parse( - agentsCompletionStreamRequest, - ), - ); -} - -export function agentsCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/agentupdaterequest.ts b/examples/sdks/mistral-typescript/src/models/components/agentupdaterequest.ts deleted file mode 100644 index 8f6ece349..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/agentupdaterequest.ts +++ /dev/null @@ -1,358 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export type AgentUpdateRequestTools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export type AgentUpdateRequest = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -export const AgentUpdateRequestTools$inboundSchema: z.ZodType< - AgentUpdateRequestTools, - z.ZodTypeDef, - unknown -> = z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type AgentUpdateRequestTools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const AgentUpdateRequestTools$outboundSchema: z.ZodType< - AgentUpdateRequestTools$Outbound, - z.ZodTypeDef, - AgentUpdateRequestTools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentUpdateRequestTools$ { - /** @deprecated use `AgentUpdateRequestTools$inboundSchema` instead. */ - export const inboundSchema = AgentUpdateRequestTools$inboundSchema; - /** @deprecated use `AgentUpdateRequestTools$outboundSchema` instead. */ - export const outboundSchema = AgentUpdateRequestTools$outboundSchema; - /** @deprecated use `AgentUpdateRequestTools$Outbound` instead. */ - export type Outbound = AgentUpdateRequestTools$Outbound; -} - -export function agentUpdateRequestToolsToJSON( - agentUpdateRequestTools: AgentUpdateRequestTools, -): string { - return JSON.stringify( - AgentUpdateRequestTools$outboundSchema.parse(agentUpdateRequestTools), - ); -} - -export function agentUpdateRequestToolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentUpdateRequestTools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentUpdateRequestTools' from JSON`, - ); -} - -/** @internal */ -export const AgentUpdateRequest$inboundSchema: z.ZodType< - AgentUpdateRequest, - z.ZodTypeDef, - unknown -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completion_args: CompletionArgs$inboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), -}).transform((v) => { - return remap$(v, { - "completion_args": "completionArgs", - }); -}); - -/** @internal */ -export type AgentUpdateRequest$Outbound = { - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - model?: string | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - handoffs?: Array | null | undefined; -}; - -/** @internal */ -export const AgentUpdateRequest$outboundSchema: z.ZodType< - AgentUpdateRequest$Outbound, - z.ZodTypeDef, - AgentUpdateRequest -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completionArgs: CompletionArgs$outboundSchema.optional(), - model: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - handoffs: z.nullable(z.array(z.string())).optional(), -}).transform((v) => { - return remap$(v, { - completionArgs: "completion_args", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentUpdateRequest$ { - /** @deprecated use `AgentUpdateRequest$inboundSchema` instead. */ - export const inboundSchema = AgentUpdateRequest$inboundSchema; - /** @deprecated use `AgentUpdateRequest$outboundSchema` instead. */ - export const outboundSchema = AgentUpdateRequest$outboundSchema; - /** @deprecated use `AgentUpdateRequest$Outbound` instead. */ - export type Outbound = AgentUpdateRequest$Outbound; -} - -export function agentUpdateRequestToJSON( - agentUpdateRequest: AgentUpdateRequest, -): string { - return JSON.stringify( - AgentUpdateRequest$outboundSchema.parse(agentUpdateRequest), - ); -} - -export function agentUpdateRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentUpdateRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentUpdateRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/apiendpoint.ts b/examples/sdks/mistral-typescript/src/models/components/apiendpoint.ts deleted file mode 100644 index d0dc7d102..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/apiendpoint.ts +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const ApiEndpoint = { - RootV1ChatCompletions: "/v1/chat/completions", - RootV1Embeddings: "/v1/embeddings", - RootV1FimCompletions: "/v1/fim/completions", - RootV1Moderations: "/v1/moderations", - RootV1ChatModerations: "/v1/chat/moderations", - RootV1Ocr: "/v1/ocr", - RootV1Classifications: "/v1/classifications", - RootV1ChatClassifications: "/v1/chat/classifications", - RootV1Conversations: "/v1/conversations", - RootV1AudioTranscriptions: "/v1/audio/transcriptions", -} as const; -export type ApiEndpoint = OpenEnum; - -/** @internal */ -export const ApiEndpoint$inboundSchema: z.ZodType< - ApiEndpoint, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ApiEndpoint), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ApiEndpoint$outboundSchema: z.ZodType< - ApiEndpoint, - z.ZodTypeDef, - ApiEndpoint -> = z.union([ - z.nativeEnum(ApiEndpoint), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ApiEndpoint$ { - /** @deprecated use `ApiEndpoint$inboundSchema` instead. */ - export const inboundSchema = ApiEndpoint$inboundSchema; - /** @deprecated use `ApiEndpoint$outboundSchema` instead. */ - export const outboundSchema = ApiEndpoint$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/archiveftmodelout.ts b/examples/sdks/mistral-typescript/src/models/components/archiveftmodelout.ts deleted file mode 100644 index 0cb37bc34..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/archiveftmodelout.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ArchiveFTModelOutObject = { - Model: "model", -} as const; -export type ArchiveFTModelOutObject = ClosedEnum< - typeof ArchiveFTModelOutObject ->; - -export type ArchiveFTModelOut = { - id: string; - object?: ArchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -/** @internal */ -export const ArchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum< - typeof ArchiveFTModelOutObject -> = z.nativeEnum(ArchiveFTModelOutObject); - -/** @internal */ -export const ArchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum< - typeof ArchiveFTModelOutObject -> = ArchiveFTModelOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ArchiveFTModelOutObject$ { - /** @deprecated use `ArchiveFTModelOutObject$inboundSchema` instead. */ - export const inboundSchema = ArchiveFTModelOutObject$inboundSchema; - /** @deprecated use `ArchiveFTModelOutObject$outboundSchema` instead. */ - export const outboundSchema = ArchiveFTModelOutObject$outboundSchema; -} - -/** @internal */ -export const ArchiveFTModelOut$inboundSchema: z.ZodType< - ArchiveFTModelOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: ArchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(true), -}); - -/** @internal */ -export type ArchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -export const ArchiveFTModelOut$outboundSchema: z.ZodType< - ArchiveFTModelOut$Outbound, - z.ZodTypeDef, - ArchiveFTModelOut -> = z.object({ - id: z.string(), - object: ArchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(true), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ArchiveFTModelOut$ { - /** @deprecated use `ArchiveFTModelOut$inboundSchema` instead. */ - export const inboundSchema = ArchiveFTModelOut$inboundSchema; - /** @deprecated use `ArchiveFTModelOut$outboundSchema` instead. */ - export const outboundSchema = ArchiveFTModelOut$outboundSchema; - /** @deprecated use `ArchiveFTModelOut$Outbound` instead. */ - export type Outbound = ArchiveFTModelOut$Outbound; -} - -export function archiveFTModelOutToJSON( - archiveFTModelOut: ArchiveFTModelOut, -): string { - return JSON.stringify( - ArchiveFTModelOut$outboundSchema.parse(archiveFTModelOut), - ); -} - -export function archiveFTModelOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ArchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ArchiveFTModelOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/assistantmessage.ts b/examples/sdks/mistral-typescript/src/models/components/assistantmessage.ts deleted file mode 100644 index 02414e460..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/assistantmessage.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type AssistantMessageContent = string | Array; - -export const AssistantMessageRole = { - Assistant: "assistant", -} as const; -export type AssistantMessageRole = ClosedEnum; - -export type AssistantMessage = { - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; - /** - * Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - */ - prefix?: boolean | undefined; - role?: AssistantMessageRole | undefined; -}; - -/** @internal */ -export const AssistantMessageContent$inboundSchema: z.ZodType< - AssistantMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type AssistantMessageContent$Outbound = - | string - | Array; - -/** @internal */ -export const AssistantMessageContent$outboundSchema: z.ZodType< - AssistantMessageContent$Outbound, - z.ZodTypeDef, - AssistantMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageContent$ { - /** @deprecated use `AssistantMessageContent$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageContent$inboundSchema; - /** @deprecated use `AssistantMessageContent$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageContent$outboundSchema; - /** @deprecated use `AssistantMessageContent$Outbound` instead. */ - export type Outbound = AssistantMessageContent$Outbound; -} - -export function assistantMessageContentToJSON( - assistantMessageContent: AssistantMessageContent, -): string { - return JSON.stringify( - AssistantMessageContent$outboundSchema.parse(assistantMessageContent), - ); -} - -export function assistantMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessageContent' from JSON`, - ); -} - -/** @internal */ -export const AssistantMessageRole$inboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = z.nativeEnum(AssistantMessageRole); - -/** @internal */ -export const AssistantMessageRole$outboundSchema: z.ZodNativeEnum< - typeof AssistantMessageRole -> = AssistantMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessageRole$ { - /** @deprecated use `AssistantMessageRole$inboundSchema` instead. */ - export const inboundSchema = AssistantMessageRole$inboundSchema; - /** @deprecated use `AssistantMessageRole$outboundSchema` instead. */ - export const outboundSchema = AssistantMessageRole$outboundSchema; -} - -/** @internal */ -export const AssistantMessage$inboundSchema: z.ZodType< - AssistantMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$inboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type AssistantMessage$Outbound = { - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; - prefix: boolean; - role: string; -}; - -/** @internal */ -export const AssistantMessage$outboundSchema: z.ZodType< - AssistantMessage$Outbound, - z.ZodTypeDef, - AssistantMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), - prefix: z.boolean().default(false), - role: AssistantMessageRole$outboundSchema.default("assistant"), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AssistantMessage$ { - /** @deprecated use `AssistantMessage$inboundSchema` instead. */ - export const inboundSchema = AssistantMessage$inboundSchema; - /** @deprecated use `AssistantMessage$outboundSchema` instead. */ - export const outboundSchema = AssistantMessage$outboundSchema; - /** @deprecated use `AssistantMessage$Outbound` instead. */ - export type Outbound = AssistantMessage$Outbound; -} - -export function assistantMessageToJSON( - assistantMessage: AssistantMessage, -): string { - return JSON.stringify( - AssistantMessage$outboundSchema.parse(assistantMessage), - ); -} - -export function assistantMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AssistantMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AssistantMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/audiochunk.ts b/examples/sdks/mistral-typescript/src/models/components/audiochunk.ts deleted file mode 100644 index 0248b2ce0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/audiochunk.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const AudioChunkType = { - InputAudio: "input_audio", -} as const; -export type AudioChunkType = ClosedEnum; - -export type AudioChunk = { - inputAudio: string; - type?: AudioChunkType | undefined; -}; - -/** @internal */ -export const AudioChunkType$inboundSchema: z.ZodNativeEnum< - typeof AudioChunkType -> = z.nativeEnum(AudioChunkType); - -/** @internal */ -export const AudioChunkType$outboundSchema: z.ZodNativeEnum< - typeof AudioChunkType -> = AudioChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AudioChunkType$ { - /** @deprecated use `AudioChunkType$inboundSchema` instead. */ - export const inboundSchema = AudioChunkType$inboundSchema; - /** @deprecated use `AudioChunkType$outboundSchema` instead. */ - export const outboundSchema = AudioChunkType$outboundSchema; -} - -/** @internal */ -export const AudioChunk$inboundSchema: z.ZodType< - AudioChunk, - z.ZodTypeDef, - unknown -> = z.object({ - input_audio: z.string(), - type: AudioChunkType$inboundSchema.default("input_audio"), -}).transform((v) => { - return remap$(v, { - "input_audio": "inputAudio", - }); -}); - -/** @internal */ -export type AudioChunk$Outbound = { - input_audio: string; - type: string; -}; - -/** @internal */ -export const AudioChunk$outboundSchema: z.ZodType< - AudioChunk$Outbound, - z.ZodTypeDef, - AudioChunk -> = z.object({ - inputAudio: z.string(), - type: AudioChunkType$outboundSchema.default("input_audio"), -}).transform((v) => { - return remap$(v, { - inputAudio: "input_audio", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AudioChunk$ { - /** @deprecated use `AudioChunk$inboundSchema` instead. */ - export const inboundSchema = AudioChunk$inboundSchema; - /** @deprecated use `AudioChunk$outboundSchema` instead. */ - export const outboundSchema = AudioChunk$outboundSchema; - /** @deprecated use `AudioChunk$Outbound` instead. */ - export type Outbound = AudioChunk$Outbound; -} - -export function audioChunkToJSON(audioChunk: AudioChunk): string { - return JSON.stringify(AudioChunk$outboundSchema.parse(audioChunk)); -} - -export function audioChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AudioChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AudioChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequest.ts b/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequest.ts deleted file mode 100644 index 63c4afa4f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequest.ts +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { blobLikeSchema } from "../../types/blobs.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FileT, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, -} from "./file.js"; -import { - TimestampGranularity, - TimestampGranularity$inboundSchema, - TimestampGranularity$outboundSchema, -} from "./timestampgranularity.js"; - -export type AudioTranscriptionRequest = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: false | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -/** @internal */ -export const AudioTranscriptionRequest$inboundSchema: z.ZodType< - AudioTranscriptionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - file: FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false), - timestamp_granularities: z.array(TimestampGranularity$inboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities", - }); -}); - -/** @internal */ -export type AudioTranscriptionRequest$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: false; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -export const AudioTranscriptionRequest$outboundSchema: z.ZodType< - AudioTranscriptionRequest$Outbound, - z.ZodTypeDef, - AudioTranscriptionRequest -> = z.object({ - model: z.string(), - file: FileT$outboundSchema.or(blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(false).default(false as const), - timestampGranularities: z.array(TimestampGranularity$outboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AudioTranscriptionRequest$ { - /** @deprecated use `AudioTranscriptionRequest$inboundSchema` instead. */ - export const inboundSchema = AudioTranscriptionRequest$inboundSchema; - /** @deprecated use `AudioTranscriptionRequest$outboundSchema` instead. */ - export const outboundSchema = AudioTranscriptionRequest$outboundSchema; - /** @deprecated use `AudioTranscriptionRequest$Outbound` instead. */ - export type Outbound = AudioTranscriptionRequest$Outbound; -} - -export function audioTranscriptionRequestToJSON( - audioTranscriptionRequest: AudioTranscriptionRequest, -): string { - return JSON.stringify( - AudioTranscriptionRequest$outboundSchema.parse(audioTranscriptionRequest), - ); -} - -export function audioTranscriptionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AudioTranscriptionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AudioTranscriptionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequeststream.ts b/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequeststream.ts deleted file mode 100644 index 6b7ea6543..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/audiotranscriptionrequeststream.ts +++ /dev/null @@ -1,135 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { blobLikeSchema } from "../../types/blobs.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FileT, - FileT$inboundSchema, - FileT$Outbound, - FileT$outboundSchema, -} from "./file.js"; -import { - TimestampGranularity, - TimestampGranularity$inboundSchema, - TimestampGranularity$outboundSchema, -} from "./timestampgranularity.js"; - -export type AudioTranscriptionRequestStream = { - model: string; - file?: FileT | Blob | undefined; - /** - * Url of a file to be transcribed - */ - fileUrl?: string | null | undefined; - /** - * ID of a file uploaded to /v1/files - */ - fileId?: string | null | undefined; - /** - * Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - */ - language?: string | null | undefined; - temperature?: number | null | undefined; - stream?: true | undefined; - /** - * Granularities of timestamps to include in the response. - */ - timestampGranularities?: Array | undefined; -}; - -/** @internal */ -export const AudioTranscriptionRequestStream$inboundSchema: z.ZodType< - AudioTranscriptionRequestStream, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - file: FileT$inboundSchema.optional(), - file_url: z.nullable(z.string()).optional(), - file_id: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true), - timestamp_granularities: z.array(TimestampGranularity$inboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - "file_url": "fileUrl", - "file_id": "fileId", - "timestamp_granularities": "timestampGranularities", - }); -}); - -/** @internal */ -export type AudioTranscriptionRequestStream$Outbound = { - model: string; - file?: FileT$Outbound | Blob | undefined; - file_url?: string | null | undefined; - file_id?: string | null | undefined; - language?: string | null | undefined; - temperature?: number | null | undefined; - stream: true; - timestamp_granularities?: Array | undefined; -}; - -/** @internal */ -export const AudioTranscriptionRequestStream$outboundSchema: z.ZodType< - AudioTranscriptionRequestStream$Outbound, - z.ZodTypeDef, - AudioTranscriptionRequestStream -> = z.object({ - model: z.string(), - file: FileT$outboundSchema.or(blobLikeSchema).optional(), - fileUrl: z.nullable(z.string()).optional(), - fileId: z.nullable(z.string()).optional(), - language: z.nullable(z.string()).optional(), - temperature: z.nullable(z.number()).optional(), - stream: z.literal(true).default(true as const), - timestampGranularities: z.array(TimestampGranularity$outboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - fileUrl: "file_url", - fileId: "file_id", - timestampGranularities: "timestamp_granularities", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AudioTranscriptionRequestStream$ { - /** @deprecated use `AudioTranscriptionRequestStream$inboundSchema` instead. */ - export const inboundSchema = AudioTranscriptionRequestStream$inboundSchema; - /** @deprecated use `AudioTranscriptionRequestStream$outboundSchema` instead. */ - export const outboundSchema = AudioTranscriptionRequestStream$outboundSchema; - /** @deprecated use `AudioTranscriptionRequestStream$Outbound` instead. */ - export type Outbound = AudioTranscriptionRequestStream$Outbound; -} - -export function audioTranscriptionRequestStreamToJSON( - audioTranscriptionRequestStream: AudioTranscriptionRequestStream, -): string { - return JSON.stringify( - AudioTranscriptionRequestStream$outboundSchema.parse( - audioTranscriptionRequestStream, - ), - ); -} - -export function audioTranscriptionRequestStreamFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AudioTranscriptionRequestStream$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AudioTranscriptionRequestStream' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/basemodelcard.ts b/examples/sdks/mistral-typescript/src/models/components/basemodelcard.ts deleted file mode 100644 index 60a041178..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/basemodelcard.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ModelCapabilities, - ModelCapabilities$inboundSchema, - ModelCapabilities$Outbound, - ModelCapabilities$outboundSchema, -} from "./modelcapabilities.js"; - -export const BaseModelCardType = { - Base: "base", -} as const; -export type BaseModelCardType = ClosedEnum; - -export type BaseModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "base" | undefined; -}; - -/** @internal */ -export const BaseModelCardType$inboundSchema: z.ZodNativeEnum< - typeof BaseModelCardType -> = z.nativeEnum(BaseModelCardType); - -/** @internal */ -export const BaseModelCardType$outboundSchema: z.ZodNativeEnum< - typeof BaseModelCardType -> = BaseModelCardType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BaseModelCardType$ { - /** @deprecated use `BaseModelCardType$inboundSchema` instead. */ - export const inboundSchema = BaseModelCardType$inboundSchema; - /** @deprecated use `BaseModelCardType$outboundSchema` instead. */ - export const outboundSchema = BaseModelCardType$outboundSchema; -} - -/** @internal */ -export const BaseModelCard$inboundSchema: z.ZodType< - BaseModelCard, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base"), -}).transform((v) => { - return remap$(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature", - }); -}); - -/** @internal */ -export type BaseModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "base"; -}; - -/** @internal */ -export const BaseModelCard$outboundSchema: z.ZodType< - BaseModelCard$Outbound, - z.ZodTypeDef, - BaseModelCard -> = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform(v => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("base").default("base"), -}).transform((v) => { - return remap$(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BaseModelCard$ { - /** @deprecated use `BaseModelCard$inboundSchema` instead. */ - export const inboundSchema = BaseModelCard$inboundSchema; - /** @deprecated use `BaseModelCard$outboundSchema` instead. */ - export const outboundSchema = BaseModelCard$outboundSchema; - /** @deprecated use `BaseModelCard$Outbound` instead. */ - export type Outbound = BaseModelCard$Outbound; -} - -export function baseModelCardToJSON(baseModelCard: BaseModelCard): string { - return JSON.stringify(BaseModelCard$outboundSchema.parse(baseModelCard)); -} - -export function baseModelCardFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => BaseModelCard$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'BaseModelCard' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/batcherror.ts b/examples/sdks/mistral-typescript/src/models/components/batcherror.ts deleted file mode 100644 index 6dcdeb4e2..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/batcherror.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type BatchError = { - message: string; - count?: number | undefined; -}; - -/** @internal */ -export const BatchError$inboundSchema: z.ZodType< - BatchError, - z.ZodTypeDef, - unknown -> = z.object({ - message: z.string(), - count: z.number().int().default(1), -}); - -/** @internal */ -export type BatchError$Outbound = { - message: string; - count: number; -}; - -/** @internal */ -export const BatchError$outboundSchema: z.ZodType< - BatchError$Outbound, - z.ZodTypeDef, - BatchError -> = z.object({ - message: z.string(), - count: z.number().int().default(1), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchError$ { - /** @deprecated use `BatchError$inboundSchema` instead. */ - export const inboundSchema = BatchError$inboundSchema; - /** @deprecated use `BatchError$outboundSchema` instead. */ - export const outboundSchema = BatchError$outboundSchema; - /** @deprecated use `BatchError$Outbound` instead. */ - export type Outbound = BatchError$Outbound; -} - -export function batchErrorToJSON(batchError: BatchError): string { - return JSON.stringify(BatchError$outboundSchema.parse(batchError)); -} - -export function batchErrorFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => BatchError$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'BatchError' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/batchjobin.ts b/examples/sdks/mistral-typescript/src/models/components/batchjobin.ts deleted file mode 100644 index a8ea4f4a0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/batchjobin.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ApiEndpoint, - ApiEndpoint$inboundSchema, - ApiEndpoint$outboundSchema, -} from "./apiendpoint.js"; - -export type BatchJobIn = { - inputFiles: Array; - endpoint: ApiEndpoint; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { [k: string]: string } | null | undefined; - timeoutHours?: number | undefined; -}; - -/** @internal */ -export const BatchJobIn$inboundSchema: z.ZodType< - BatchJobIn, - z.ZodTypeDef, - unknown -> = z.object({ - input_files: z.array(z.string()), - endpoint: ApiEndpoint$inboundSchema, - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeout_hours: z.number().int().default(24), -}).transform((v) => { - return remap$(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "timeout_hours": "timeoutHours", - }); -}); - -/** @internal */ -export type BatchJobIn$Outbound = { - input_files: Array; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { [k: string]: string } | null | undefined; - timeout_hours: number; -}; - -/** @internal */ -export const BatchJobIn$outboundSchema: z.ZodType< - BatchJobIn$Outbound, - z.ZodTypeDef, - BatchJobIn -> = z.object({ - inputFiles: z.array(z.string()), - endpoint: ApiEndpoint$outboundSchema, - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), - timeoutHours: z.number().int().default(24), -}).transform((v) => { - return remap$(v, { - inputFiles: "input_files", - agentId: "agent_id", - timeoutHours: "timeout_hours", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobIn$ { - /** @deprecated use `BatchJobIn$inboundSchema` instead. */ - export const inboundSchema = BatchJobIn$inboundSchema; - /** @deprecated use `BatchJobIn$outboundSchema` instead. */ - export const outboundSchema = BatchJobIn$outboundSchema; - /** @deprecated use `BatchJobIn$Outbound` instead. */ - export type Outbound = BatchJobIn$Outbound; -} - -export function batchJobInToJSON(batchJobIn: BatchJobIn): string { - return JSON.stringify(BatchJobIn$outboundSchema.parse(batchJobIn)); -} - -export function batchJobInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => BatchJobIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'BatchJobIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/batchjobout.ts b/examples/sdks/mistral-typescript/src/models/components/batchjobout.ts deleted file mode 100644 index 28bdd25fd..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/batchjobout.ts +++ /dev/null @@ -1,197 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BatchError, - BatchError$inboundSchema, - BatchError$Outbound, - BatchError$outboundSchema, -} from "./batcherror.js"; -import { - BatchJobStatus, - BatchJobStatus$inboundSchema, - BatchJobStatus$outboundSchema, -} from "./batchjobstatus.js"; - -export const BatchJobOutObject = { - Batch: "batch", -} as const; -export type BatchJobOutObject = ClosedEnum; - -export type BatchJobOut = { - id: string; - object?: BatchJobOutObject | undefined; - inputFiles: Array; - metadata?: { [k: string]: any } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agentId?: string | null | undefined; - outputFile?: string | null | undefined; - errorFile?: string | null | undefined; - errors: Array; - status: BatchJobStatus; - createdAt: number; - totalRequests: number; - completedRequests: number; - succeededRequests: number; - failedRequests: number; - startedAt?: number | null | undefined; - completedAt?: number | null | undefined; -}; - -/** @internal */ -export const BatchJobOutObject$inboundSchema: z.ZodNativeEnum< - typeof BatchJobOutObject -> = z.nativeEnum(BatchJobOutObject); - -/** @internal */ -export const BatchJobOutObject$outboundSchema: z.ZodNativeEnum< - typeof BatchJobOutObject -> = BatchJobOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobOutObject$ { - /** @deprecated use `BatchJobOutObject$inboundSchema` instead. */ - export const inboundSchema = BatchJobOutObject$inboundSchema; - /** @deprecated use `BatchJobOutObject$outboundSchema` instead. */ - export const outboundSchema = BatchJobOutObject$outboundSchema; -} - -/** @internal */ -export const BatchJobOut$inboundSchema: z.ZodType< - BatchJobOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: BatchJobOutObject$inboundSchema.default("batch"), - input_files: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - output_file: z.nullable(z.string()).optional(), - error_file: z.nullable(z.string()).optional(), - errors: z.array(BatchError$inboundSchema), - status: BatchJobStatus$inboundSchema, - created_at: z.number().int(), - total_requests: z.number().int(), - completed_requests: z.number().int(), - succeeded_requests: z.number().int(), - failed_requests: z.number().int(), - started_at: z.nullable(z.number().int()).optional(), - completed_at: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "input_files": "inputFiles", - "agent_id": "agentId", - "output_file": "outputFile", - "error_file": "errorFile", - "created_at": "createdAt", - "total_requests": "totalRequests", - "completed_requests": "completedRequests", - "succeeded_requests": "succeededRequests", - "failed_requests": "failedRequests", - "started_at": "startedAt", - "completed_at": "completedAt", - }); -}); - -/** @internal */ -export type BatchJobOut$Outbound = { - id: string; - object: string; - input_files: Array; - metadata?: { [k: string]: any } | null | undefined; - endpoint: string; - model?: string | null | undefined; - agent_id?: string | null | undefined; - output_file?: string | null | undefined; - error_file?: string | null | undefined; - errors: Array; - status: string; - created_at: number; - total_requests: number; - completed_requests: number; - succeeded_requests: number; - failed_requests: number; - started_at?: number | null | undefined; - completed_at?: number | null | undefined; -}; - -/** @internal */ -export const BatchJobOut$outboundSchema: z.ZodType< - BatchJobOut$Outbound, - z.ZodTypeDef, - BatchJobOut -> = z.object({ - id: z.string(), - object: BatchJobOutObject$outboundSchema.default("batch"), - inputFiles: z.array(z.string()), - metadata: z.nullable(z.record(z.any())).optional(), - endpoint: z.string(), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - outputFile: z.nullable(z.string()).optional(), - errorFile: z.nullable(z.string()).optional(), - errors: z.array(BatchError$outboundSchema), - status: BatchJobStatus$outboundSchema, - createdAt: z.number().int(), - totalRequests: z.number().int(), - completedRequests: z.number().int(), - succeededRequests: z.number().int(), - failedRequests: z.number().int(), - startedAt: z.nullable(z.number().int()).optional(), - completedAt: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - inputFiles: "input_files", - agentId: "agent_id", - outputFile: "output_file", - errorFile: "error_file", - createdAt: "created_at", - totalRequests: "total_requests", - completedRequests: "completed_requests", - succeededRequests: "succeeded_requests", - failedRequests: "failed_requests", - startedAt: "started_at", - completedAt: "completed_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobOut$ { - /** @deprecated use `BatchJobOut$inboundSchema` instead. */ - export const inboundSchema = BatchJobOut$inboundSchema; - /** @deprecated use `BatchJobOut$outboundSchema` instead. */ - export const outboundSchema = BatchJobOut$outboundSchema; - /** @deprecated use `BatchJobOut$Outbound` instead. */ - export type Outbound = BatchJobOut$Outbound; -} - -export function batchJobOutToJSON(batchJobOut: BatchJobOut): string { - return JSON.stringify(BatchJobOut$outboundSchema.parse(batchJobOut)); -} - -export function batchJobOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => BatchJobOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'BatchJobOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/batchjobsout.ts b/examples/sdks/mistral-typescript/src/models/components/batchjobsout.ts deleted file mode 100644 index 3cd0f2ad1..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/batchjobsout.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BatchJobOut, - BatchJobOut$inboundSchema, - BatchJobOut$Outbound, - BatchJobOut$outboundSchema, -} from "./batchjobout.js"; - -export const BatchJobsOutObject = { - List: "list", -} as const; -export type BatchJobsOutObject = ClosedEnum; - -export type BatchJobsOut = { - data?: Array | undefined; - object?: BatchJobsOutObject | undefined; - total: number; -}; - -/** @internal */ -export const BatchJobsOutObject$inboundSchema: z.ZodNativeEnum< - typeof BatchJobsOutObject -> = z.nativeEnum(BatchJobsOutObject); - -/** @internal */ -export const BatchJobsOutObject$outboundSchema: z.ZodNativeEnum< - typeof BatchJobsOutObject -> = BatchJobsOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobsOutObject$ { - /** @deprecated use `BatchJobsOutObject$inboundSchema` instead. */ - export const inboundSchema = BatchJobsOutObject$inboundSchema; - /** @deprecated use `BatchJobsOutObject$outboundSchema` instead. */ - export const outboundSchema = BatchJobsOutObject$outboundSchema; -} - -/** @internal */ -export const BatchJobsOut$inboundSchema: z.ZodType< - BatchJobsOut, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.array(BatchJobOut$inboundSchema).optional(), - object: BatchJobsOutObject$inboundSchema.default("list"), - total: z.number().int(), -}); - -/** @internal */ -export type BatchJobsOut$Outbound = { - data?: Array | undefined; - object: string; - total: number; -}; - -/** @internal */ -export const BatchJobsOut$outboundSchema: z.ZodType< - BatchJobsOut$Outbound, - z.ZodTypeDef, - BatchJobsOut -> = z.object({ - data: z.array(BatchJobOut$outboundSchema).optional(), - object: BatchJobsOutObject$outboundSchema.default("list"), - total: z.number().int(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobsOut$ { - /** @deprecated use `BatchJobsOut$inboundSchema` instead. */ - export const inboundSchema = BatchJobsOut$inboundSchema; - /** @deprecated use `BatchJobsOut$outboundSchema` instead. */ - export const outboundSchema = BatchJobsOut$outboundSchema; - /** @deprecated use `BatchJobsOut$Outbound` instead. */ - export type Outbound = BatchJobsOut$Outbound; -} - -export function batchJobsOutToJSON(batchJobsOut: BatchJobsOut): string { - return JSON.stringify(BatchJobsOut$outboundSchema.parse(batchJobsOut)); -} - -export function batchJobsOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => BatchJobsOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'BatchJobsOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/batchjobstatus.ts b/examples/sdks/mistral-typescript/src/models/components/batchjobstatus.ts deleted file mode 100644 index 16ca41aee..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/batchjobstatus.ts +++ /dev/null @@ -1,38 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const BatchJobStatus = { - Queued: "QUEUED", - Running: "RUNNING", - Success: "SUCCESS", - Failed: "FAILED", - TimeoutExceeded: "TIMEOUT_EXCEEDED", - CancellationRequested: "CANCELLATION_REQUESTED", - Cancelled: "CANCELLED", -} as const; -export type BatchJobStatus = ClosedEnum; - -/** @internal */ -export const BatchJobStatus$inboundSchema: z.ZodNativeEnum< - typeof BatchJobStatus -> = z.nativeEnum(BatchJobStatus); - -/** @internal */ -export const BatchJobStatus$outboundSchema: z.ZodNativeEnum< - typeof BatchJobStatus -> = BatchJobStatus$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BatchJobStatus$ { - /** @deprecated use `BatchJobStatus$inboundSchema` instead. */ - export const inboundSchema = BatchJobStatus$inboundSchema; - /** @deprecated use `BatchJobStatus$outboundSchema` instead. */ - export const outboundSchema = BatchJobStatus$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/builtinconnectors.ts b/examples/sdks/mistral-typescript/src/models/components/builtinconnectors.ts deleted file mode 100644 index 2aff6fb73..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/builtinconnectors.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const BuiltInConnectors = { - WebSearch: "web_search", - WebSearchPremium: "web_search_premium", - CodeInterpreter: "code_interpreter", - ImageGeneration: "image_generation", - DocumentLibrary: "document_library", -} as const; -export type BuiltInConnectors = ClosedEnum; - -/** @internal */ -export const BuiltInConnectors$inboundSchema: z.ZodNativeEnum< - typeof BuiltInConnectors -> = z.nativeEnum(BuiltInConnectors); - -/** @internal */ -export const BuiltInConnectors$outboundSchema: z.ZodNativeEnum< - typeof BuiltInConnectors -> = BuiltInConnectors$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BuiltInConnectors$ { - /** @deprecated use `BuiltInConnectors$inboundSchema` instead. */ - export const inboundSchema = BuiltInConnectors$inboundSchema; - /** @deprecated use `BuiltInConnectors$outboundSchema` instead. */ - export const outboundSchema = BuiltInConnectors$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatclassificationrequest.ts b/examples/sdks/mistral-typescript/src/models/components/chatclassificationrequest.ts deleted file mode 100644 index b92cc8440..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatclassificationrequest.ts +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - Inputs, - Inputs$inboundSchema, - Inputs$Outbound, - Inputs$outboundSchema, -} from "./inputs.js"; - -export type ChatClassificationRequest = { - model: string; - /** - * Chat to classify - */ - inputs: Inputs; -}; - -/** @internal */ -export const ChatClassificationRequest$inboundSchema: z.ZodType< - ChatClassificationRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - input: Inputs$inboundSchema, -}).transform((v) => { - return remap$(v, { - "input": "inputs", - }); -}); - -/** @internal */ -export type ChatClassificationRequest$Outbound = { - model: string; - input: Inputs$Outbound; -}; - -/** @internal */ -export const ChatClassificationRequest$outboundSchema: z.ZodType< - ChatClassificationRequest$Outbound, - z.ZodTypeDef, - ChatClassificationRequest -> = z.object({ - model: z.string(), - inputs: Inputs$outboundSchema, -}).transform((v) => { - return remap$(v, { - inputs: "input", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatClassificationRequest$ { - /** @deprecated use `ChatClassificationRequest$inboundSchema` instead. */ - export const inboundSchema = ChatClassificationRequest$inboundSchema; - /** @deprecated use `ChatClassificationRequest$outboundSchema` instead. */ - export const outboundSchema = ChatClassificationRequest$outboundSchema; - /** @deprecated use `ChatClassificationRequest$Outbound` instead. */ - export type Outbound = ChatClassificationRequest$Outbound; -} - -export function chatClassificationRequestToJSON( - chatClassificationRequest: ChatClassificationRequest, -): string { - return JSON.stringify( - ChatClassificationRequest$outboundSchema.parse(chatClassificationRequest), - ); -} - -export function chatClassificationRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatClassificationRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatClassificationRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatcompletionchoice.ts b/examples/sdks/mistral-typescript/src/models/components/chatcompletionchoice.ts deleted file mode 100644 index f50ad1b63..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatcompletionchoice.ts +++ /dev/null @@ -1,135 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; - -export const FinishReason = { - Stop: "stop", - Length: "length", - ModelLength: "model_length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type FinishReason = OpenEnum; - -export type ChatCompletionChoice = { - index: number; - message: AssistantMessage; - finishReason: FinishReason; -}; - -/** @internal */ -export const FinishReason$inboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(FinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const FinishReason$outboundSchema: z.ZodType< - FinishReason, - z.ZodTypeDef, - FinishReason -> = z.union([ - z.nativeEnum(FinishReason), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FinishReason$ { - /** @deprecated use `FinishReason$inboundSchema` instead. */ - export const inboundSchema = FinishReason$inboundSchema; - /** @deprecated use `FinishReason$outboundSchema` instead. */ - export const outboundSchema = FinishReason$outboundSchema; -} - -/** @internal */ -export const ChatCompletionChoice$inboundSchema: z.ZodType< - ChatCompletionChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - message: AssistantMessage$inboundSchema, - finish_reason: FinishReason$inboundSchema, -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type ChatCompletionChoice$Outbound = { - index: number; - message: AssistantMessage$Outbound; - finish_reason: string; -}; - -/** @internal */ -export const ChatCompletionChoice$outboundSchema: z.ZodType< - ChatCompletionChoice$Outbound, - z.ZodTypeDef, - ChatCompletionChoice -> = z.object({ - index: z.number().int(), - message: AssistantMessage$outboundSchema, - finishReason: FinishReason$outboundSchema, -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionChoice$ { - /** @deprecated use `ChatCompletionChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionChoice$inboundSchema; - /** @deprecated use `ChatCompletionChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionChoice$outboundSchema; - /** @deprecated use `ChatCompletionChoice$Outbound` instead. */ - export type Outbound = ChatCompletionChoice$Outbound; -} - -export function chatCompletionChoiceToJSON( - chatCompletionChoice: ChatCompletionChoice, -): string { - return JSON.stringify( - ChatCompletionChoice$outboundSchema.parse(chatCompletionChoice), - ); -} - -export function chatCompletionChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatcompletionrequest.ts b/examples/sdks/mistral-typescript/src/models/components/chatcompletionrequest.ts deleted file mode 100644 index 680ed280f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatcompletionrequest.ts +++ /dev/null @@ -1,503 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type Stop = string | Array; - -export type Messages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -/** @internal */ -export const Stop$inboundSchema: z.ZodType = z - .union([z.string(), z.array(z.string())]); - -/** @internal */ -export type Stop$Outbound = string | Array; - -/** @internal */ -export const Stop$outboundSchema: z.ZodType = - z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Stop$ { - /** @deprecated use `Stop$inboundSchema` instead. */ - export const inboundSchema = Stop$inboundSchema; - /** @deprecated use `Stop$outboundSchema` instead. */ - export const outboundSchema = Stop$outboundSchema; - /** @deprecated use `Stop$Outbound` instead. */ - export type Outbound = Stop$Outbound; -} - -export function stopToJSON(stop: Stop): string { - return JSON.stringify(Stop$outboundSchema.parse(stop)); -} - -export function stopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Stop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Stop' from JSON`, - ); -} - -/** @internal */ -export const Messages$inboundSchema: z.ZodType< - Messages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type Messages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const Messages$outboundSchema: z.ZodType< - Messages$Outbound, - z.ZodTypeDef, - Messages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Messages$ { - /** @deprecated use `Messages$inboundSchema` instead. */ - export const inboundSchema = Messages$inboundSchema; - /** @deprecated use `Messages$outboundSchema` instead. */ - export const outboundSchema = Messages$outboundSchema; - /** @deprecated use `Messages$Outbound` instead. */ - export type Outbound = Messages$Outbound; -} - -export function messagesToJSON(messages: Messages): string { - return JSON.stringify(Messages$outboundSchema.parse(messages)); -} - -export function messagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Messages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Messages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequestToolChoice$ { - /** @deprecated use `ChatCompletionRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionRequestToolChoice$Outbound; -} - -export function chatCompletionRequestToolChoiceToJSON( - chatCompletionRequestToolChoice: ChatCompletionRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionRequestToolChoice$outboundSchema.parse( - chatCompletionRequestToolChoice, - ), - ); -} - -export function chatCompletionRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionRequest$inboundSchema: z.ZodType< - ChatCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt", - }); -}); - -/** @internal */ -export type ChatCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionRequest$outboundSchema: z.ZodType< - ChatCompletionRequest$Outbound, - z.ZodTypeDef, - ChatCompletionRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionRequest$ { - /** @deprecated use `ChatCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionRequest$inboundSchema; - /** @deprecated use `ChatCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionRequest$outboundSchema; - /** @deprecated use `ChatCompletionRequest$Outbound` instead. */ - export type Outbound = ChatCompletionRequest$Outbound; -} - -export function chatCompletionRequestToJSON( - chatCompletionRequest: ChatCompletionRequest, -): string { - return JSON.stringify( - ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest), - ); -} - -export function chatCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatcompletionresponse.ts b/examples/sdks/mistral-typescript/src/models/components/chatcompletionresponse.ts deleted file mode 100644 index 941fcf6c5..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatcompletionresponse.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ChatCompletionChoice, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, -} from "./chatcompletionchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type ChatCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -/** @internal */ -export const ChatCompletionResponse$inboundSchema: z.ZodType< - ChatCompletionResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$inboundSchema), -}); - -/** @internal */ -export type ChatCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -export const ChatCompletionResponse$outboundSchema: z.ZodType< - ChatCompletionResponse$Outbound, - z.ZodTypeDef, - ChatCompletionResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionResponse$ { - /** @deprecated use `ChatCompletionResponse$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionResponse$inboundSchema; - /** @deprecated use `ChatCompletionResponse$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionResponse$outboundSchema; - /** @deprecated use `ChatCompletionResponse$Outbound` instead. */ - export type Outbound = ChatCompletionResponse$Outbound; -} - -export function chatCompletionResponseToJSON( - chatCompletionResponse: ChatCompletionResponse, -): string { - return JSON.stringify( - ChatCompletionResponse$outboundSchema.parse(chatCompletionResponse), - ); -} - -export function chatCompletionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatcompletionstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/chatcompletionstreamrequest.ts deleted file mode 100644 index 961c0ffbc..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatcompletionstreamrequest.ts +++ /dev/null @@ -1,526 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - MistralPromptMode, - MistralPromptMode$inboundSchema, - MistralPromptMode$outboundSchema, -} from "./mistralpromptmode.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - Tool, - Tool$inboundSchema, - Tool$Outbound, - Tool$outboundSchema, -} from "./tool.js"; -import { - ToolChoice, - ToolChoice$inboundSchema, - ToolChoice$Outbound, - ToolChoice$outboundSchema, -} from "./toolchoice.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type ChatCompletionStreamRequestStop = string | Array; - -export type ChatCompletionStreamRequestMessages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum; - -export type ChatCompletionStreamRequest = { - /** - * ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The prompt(s) to generate completions for, encoded as a list of dict with role and content. - */ - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; - responseFormat?: ResponseFormat | undefined; - tools?: Array | null | undefined; - toolChoice?: ToolChoice | ToolChoiceEnum | undefined; - /** - * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - */ - presencePenalty?: number | undefined; - /** - * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - */ - frequencyPenalty?: number | undefined; - /** - * Number of completions to return for each request, input tokens are only billed once. - */ - n?: number | null | undefined; - prediction?: Prediction | undefined; - parallelToolCalls?: boolean | undefined; - /** - * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - */ - promptMode?: MistralPromptMode | null | undefined; - /** - * Whether to inject a safety prompt before all conversations. - */ - safePrompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionStreamRequestStop$inboundSchema: z.ZodType< - ChatCompletionStreamRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type ChatCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -export const ChatCompletionStreamRequestStop$outboundSchema: z.ZodType< - ChatCompletionStreamRequestStop$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequestStop$ { - /** @deprecated use `ChatCompletionStreamRequestStop$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionStreamRequestStop$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequestStop$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionStreamRequestStop$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequestStop$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequestStop$Outbound; -} - -export function chatCompletionStreamRequestStopToJSON( - chatCompletionStreamRequestStop: ChatCompletionStreamRequestStop, -): string { - return JSON.stringify( - ChatCompletionStreamRequestStop$outboundSchema.parse( - chatCompletionStreamRequestStop, - ), - ); -} - -export function chatCompletionStreamRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequestStop' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequestMessages$inboundSchema: z.ZodType< - ChatCompletionStreamRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type ChatCompletionStreamRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const ChatCompletionStreamRequestMessages$outboundSchema: z.ZodType< - ChatCompletionStreamRequestMessages$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequestMessages$ { - /** @deprecated use `ChatCompletionStreamRequestMessages$inboundSchema` instead. */ - export const inboundSchema = - ChatCompletionStreamRequestMessages$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequestMessages$outboundSchema` instead. */ - export const outboundSchema = - ChatCompletionStreamRequestMessages$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequestMessages$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequestMessages$Outbound; -} - -export function chatCompletionStreamRequestMessagesToJSON( - chatCompletionStreamRequestMessages: ChatCompletionStreamRequestMessages, -): string { - return JSON.stringify( - ChatCompletionStreamRequestMessages$outboundSchema.parse( - chatCompletionStreamRequestMessages, - ), - ); -} - -export function chatCompletionStreamRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - ChatCompletionStreamRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$inboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice, - z.ZodTypeDef, - unknown -> = z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]); - -/** @internal */ -export type ChatCompletionStreamRequestToolChoice$Outbound = - | ToolChoice$Outbound - | string; - -/** @internal */ -export const ChatCompletionStreamRequestToolChoice$outboundSchema: z.ZodType< - ChatCompletionStreamRequestToolChoice$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequestToolChoice -> = z.union([ToolChoice$outboundSchema, ToolChoiceEnum$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequestToolChoice$ { - /** @deprecated use `ChatCompletionStreamRequestToolChoice$inboundSchema` instead. */ - export const inboundSchema = - ChatCompletionStreamRequestToolChoice$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$outboundSchema` instead. */ - export const outboundSchema = - ChatCompletionStreamRequestToolChoice$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequestToolChoice$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequestToolChoice$Outbound; -} - -export function chatCompletionStreamRequestToolChoiceToJSON( - chatCompletionStreamRequestToolChoice: ChatCompletionStreamRequestToolChoice, -): string { - return JSON.stringify( - ChatCompletionStreamRequestToolChoice$outboundSchema.parse( - chatCompletionStreamRequestToolChoice, - ), - ); -} - -export function chatCompletionStreamRequestToolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - ChatCompletionStreamRequestToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequestToolChoice' from JSON`, - ); -} - -/** @internal */ -export const ChatCompletionStreamRequest$inboundSchema: z.ZodType< - ChatCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().optional(), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - response_format: ResponseFormat$inboundSchema.optional(), - tools: z.nullable(z.array(Tool$inboundSchema)).optional(), - tool_choice: z.union([ToolChoice$inboundSchema, ToolChoiceEnum$inboundSchema]) - .optional(), - presence_penalty: z.number().optional(), - frequency_penalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$inboundSchema.optional(), - parallel_tool_calls: z.boolean().optional(), - prompt_mode: z.nullable(MistralPromptMode$inboundSchema).optional(), - safe_prompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "parallel_tool_calls": "parallelToolCalls", - "prompt_mode": "promptMode", - "safe_prompt": "safePrompt", - }); -}); - -/** @internal */ -export type ChatCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p?: number | undefined; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; - response_format?: ResponseFormat$Outbound | undefined; - tools?: Array | null | undefined; - tool_choice?: ToolChoice$Outbound | string | undefined; - presence_penalty?: number | undefined; - frequency_penalty?: number | undefined; - n?: number | null | undefined; - prediction?: Prediction$Outbound | undefined; - parallel_tool_calls?: boolean | undefined; - prompt_mode?: string | null | undefined; - safe_prompt?: boolean | undefined; -}; - -/** @internal */ -export const ChatCompletionStreamRequest$outboundSchema: z.ZodType< - ChatCompletionStreamRequest$Outbound, - z.ZodTypeDef, - ChatCompletionStreamRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().optional(), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - responseFormat: ResponseFormat$outboundSchema.optional(), - tools: z.nullable(z.array(Tool$outboundSchema)).optional(), - toolChoice: z.union([ - ToolChoice$outboundSchema, - ToolChoiceEnum$outboundSchema, - ]).optional(), - presencePenalty: z.number().optional(), - frequencyPenalty: z.number().optional(), - n: z.nullable(z.number().int()).optional(), - prediction: Prediction$outboundSchema.optional(), - parallelToolCalls: z.boolean().optional(), - promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(), - safePrompt: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - parallelToolCalls: "parallel_tool_calls", - promptMode: "prompt_mode", - safePrompt: "safe_prompt", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatCompletionStreamRequest$ { - /** @deprecated use `ChatCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ChatCompletionStreamRequest$inboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ChatCompletionStreamRequest$outboundSchema; - /** @deprecated use `ChatCompletionStreamRequest$Outbound` instead. */ - export type Outbound = ChatCompletionStreamRequest$Outbound; -} - -export function chatCompletionStreamRequestToJSON( - chatCompletionStreamRequest: ChatCompletionStreamRequest, -): string { - return JSON.stringify( - ChatCompletionStreamRequest$outboundSchema.parse( - chatCompletionStreamRequest, - ), - ); -} - -export function chatCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/chatmoderationrequest.ts b/examples/sdks/mistral-typescript/src/models/components/chatmoderationrequest.ts deleted file mode 100644 index 275dc5137..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/chatmoderationrequest.ts +++ /dev/null @@ -1,603 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -export type Two = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type One = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -/** - * Chat to classify - */ -export type ChatModerationRequestInputs = - | Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - > - | Array< - Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - > - >; - -export type ChatModerationRequest = { - /** - * Chat to classify - */ - inputs: - | Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - > - | Array< - Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - > - >; - model: string; -}; - -/** @internal */ -export const Two$inboundSchema: z.ZodType = z.union( - [ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ], -); - -/** @internal */ -export type Two$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const Two$outboundSchema: z.ZodType = z - .union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Two$ { - /** @deprecated use `Two$inboundSchema` instead. */ - export const inboundSchema = Two$inboundSchema; - /** @deprecated use `Two$outboundSchema` instead. */ - export const outboundSchema = Two$outboundSchema; - /** @deprecated use `Two$Outbound` instead. */ - export type Outbound = Two$Outbound; -} - -export function twoToJSON(two: Two): string { - return JSON.stringify(Two$outboundSchema.parse(two)); -} - -export function twoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Two$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Two' from JSON`, - ); -} - -/** @internal */ -export const One$inboundSchema: z.ZodType = z.union( - [ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ], -); - -/** @internal */ -export type One$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const One$outboundSchema: z.ZodType = z - .union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace One$ { - /** @deprecated use `One$inboundSchema` instead. */ - export const inboundSchema = One$inboundSchema; - /** @deprecated use `One$outboundSchema` instead. */ - export const outboundSchema = One$outboundSchema; - /** @deprecated use `One$Outbound` instead. */ - export type Outbound = One$Outbound; -} - -export function oneToJSON(one: One): string { - return JSON.stringify(One$outboundSchema.parse(one)); -} - -export function oneFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => One$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'One' from JSON`, - ); -} - -/** @internal */ -export const ChatModerationRequestInputs$inboundSchema: z.ZodType< - ChatModerationRequestInputs, - z.ZodTypeDef, - unknown -> = z.union([ - z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - z.array( - z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - ), -]); - -/** @internal */ -export type ChatModerationRequestInputs$Outbound = - | Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - > - | Array< - Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - > - >; - -/** @internal */ -export const ChatModerationRequestInputs$outboundSchema: z.ZodType< - ChatModerationRequestInputs$Outbound, - z.ZodTypeDef, - ChatModerationRequestInputs -> = z.union([ - z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - z.array( - z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatModerationRequestInputs$ { - /** @deprecated use `ChatModerationRequestInputs$inboundSchema` instead. */ - export const inboundSchema = ChatModerationRequestInputs$inboundSchema; - /** @deprecated use `ChatModerationRequestInputs$outboundSchema` instead. */ - export const outboundSchema = ChatModerationRequestInputs$outboundSchema; - /** @deprecated use `ChatModerationRequestInputs$Outbound` instead. */ - export type Outbound = ChatModerationRequestInputs$Outbound; -} - -export function chatModerationRequestInputsToJSON( - chatModerationRequestInputs: ChatModerationRequestInputs, -): string { - return JSON.stringify( - ChatModerationRequestInputs$outboundSchema.parse( - chatModerationRequestInputs, - ), - ); -} - -export function chatModerationRequestInputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatModerationRequestInputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatModerationRequestInputs' from JSON`, - ); -} - -/** @internal */ -export const ChatModerationRequest$inboundSchema: z.ZodType< - ChatModerationRequest, - z.ZodTypeDef, - unknown -> = z.object({ - input: z.union([ - z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - z.array( - z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - ), - ]), - model: z.string(), -}).transform((v) => { - return remap$(v, { - "input": "inputs", - }); -}); - -/** @internal */ -export type ChatModerationRequest$Outbound = { - input: - | Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - > - | Array< - Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - > - >; - model: string; -}; - -/** @internal */ -export const ChatModerationRequest$outboundSchema: z.ZodType< - ChatModerationRequest$Outbound, - z.ZodTypeDef, - ChatModerationRequest -> = z.object({ - inputs: z.union([ - z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - z.array( - z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), - ), - ]), - model: z.string(), -}).transform((v) => { - return remap$(v, { - inputs: "input", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ChatModerationRequest$ { - /** @deprecated use `ChatModerationRequest$inboundSchema` instead. */ - export const inboundSchema = ChatModerationRequest$inboundSchema; - /** @deprecated use `ChatModerationRequest$outboundSchema` instead. */ - export const outboundSchema = ChatModerationRequest$outboundSchema; - /** @deprecated use `ChatModerationRequest$Outbound` instead. */ - export type Outbound = ChatModerationRequest$Outbound; -} - -export function chatModerationRequestToJSON( - chatModerationRequest: ChatModerationRequest, -): string { - return JSON.stringify( - ChatModerationRequest$outboundSchema.parse(chatModerationRequest), - ); -} - -export function chatModerationRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ChatModerationRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ChatModerationRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/checkpointout.ts b/examples/sdks/mistral-typescript/src/models/components/checkpointout.ts deleted file mode 100644 index a1c30d74a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/checkpointout.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - MetricOut, - MetricOut$inboundSchema, - MetricOut$Outbound, - MetricOut$outboundSchema, -} from "./metricout.js"; - -export type CheckpointOut = { - /** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ - metrics: MetricOut; - /** - * The step number that the checkpoint was created at. - */ - stepNumber: number; - /** - * The UNIX timestamp (in seconds) for when the checkpoint was created. - */ - createdAt: number; -}; - -/** @internal */ -export const CheckpointOut$inboundSchema: z.ZodType< - CheckpointOut, - z.ZodTypeDef, - unknown -> = z.object({ - metrics: MetricOut$inboundSchema, - step_number: z.number().int(), - created_at: z.number().int(), -}).transform((v) => { - return remap$(v, { - "step_number": "stepNumber", - "created_at": "createdAt", - }); -}); - -/** @internal */ -export type CheckpointOut$Outbound = { - metrics: MetricOut$Outbound; - step_number: number; - created_at: number; -}; - -/** @internal */ -export const CheckpointOut$outboundSchema: z.ZodType< - CheckpointOut$Outbound, - z.ZodTypeDef, - CheckpointOut -> = z.object({ - metrics: MetricOut$outboundSchema, - stepNumber: z.number().int(), - createdAt: z.number().int(), -}).transform((v) => { - return remap$(v, { - stepNumber: "step_number", - createdAt: "created_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CheckpointOut$ { - /** @deprecated use `CheckpointOut$inboundSchema` instead. */ - export const inboundSchema = CheckpointOut$inboundSchema; - /** @deprecated use `CheckpointOut$outboundSchema` instead. */ - export const outboundSchema = CheckpointOut$outboundSchema; - /** @deprecated use `CheckpointOut$Outbound` instead. */ - export type Outbound = CheckpointOut$Outbound; -} - -export function checkpointOutToJSON(checkpointOut: CheckpointOut): string { - return JSON.stringify(CheckpointOut$outboundSchema.parse(checkpointOut)); -} - -export function checkpointOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CheckpointOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CheckpointOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classificationrequest.ts b/examples/sdks/mistral-typescript/src/models/components/classificationrequest.ts deleted file mode 100644 index 17bd9b9ea..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classificationrequest.ts +++ /dev/null @@ -1,140 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Text to classify. - */ -export type ClassificationRequestInputs = string | Array; - -export type ClassificationRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to classify. - */ - inputs: string | Array; -}; - -/** @internal */ -export const ClassificationRequestInputs$inboundSchema: z.ZodType< - ClassificationRequestInputs, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type ClassificationRequestInputs$Outbound = string | Array; - -/** @internal */ -export const ClassificationRequestInputs$outboundSchema: z.ZodType< - ClassificationRequestInputs$Outbound, - z.ZodTypeDef, - ClassificationRequestInputs -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassificationRequestInputs$ { - /** @deprecated use `ClassificationRequestInputs$inboundSchema` instead. */ - export const inboundSchema = ClassificationRequestInputs$inboundSchema; - /** @deprecated use `ClassificationRequestInputs$outboundSchema` instead. */ - export const outboundSchema = ClassificationRequestInputs$outboundSchema; - /** @deprecated use `ClassificationRequestInputs$Outbound` instead. */ - export type Outbound = ClassificationRequestInputs$Outbound; -} - -export function classificationRequestInputsToJSON( - classificationRequestInputs: ClassificationRequestInputs, -): string { - return JSON.stringify( - ClassificationRequestInputs$outboundSchema.parse( - classificationRequestInputs, - ), - ); -} - -export function classificationRequestInputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassificationRequestInputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassificationRequestInputs' from JSON`, - ); -} - -/** @internal */ -export const ClassificationRequest$inboundSchema: z.ZodType< - ClassificationRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]), -}).transform((v) => { - return remap$(v, { - "input": "inputs", - }); -}); - -/** @internal */ -export type ClassificationRequest$Outbound = { - model: string; - input: string | Array; -}; - -/** @internal */ -export const ClassificationRequest$outboundSchema: z.ZodType< - ClassificationRequest$Outbound, - z.ZodTypeDef, - ClassificationRequest -> = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]), -}).transform((v) => { - return remap$(v, { - inputs: "input", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassificationRequest$ { - /** @deprecated use `ClassificationRequest$inboundSchema` instead. */ - export const inboundSchema = ClassificationRequest$inboundSchema; - /** @deprecated use `ClassificationRequest$outboundSchema` instead. */ - export const outboundSchema = ClassificationRequest$outboundSchema; - /** @deprecated use `ClassificationRequest$Outbound` instead. */ - export type Outbound = ClassificationRequest$Outbound; -} - -export function classificationRequestToJSON( - classificationRequest: ClassificationRequest, -): string { - return JSON.stringify( - ClassificationRequest$outboundSchema.parse(classificationRequest), - ); -} - -export function classificationRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassificationRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassificationRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classificationresponse.ts b/examples/sdks/mistral-typescript/src/models/components/classificationresponse.ts deleted file mode 100644 index c1d71676a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classificationresponse.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ClassificationTargetResult, - ClassificationTargetResult$inboundSchema, - ClassificationTargetResult$Outbound, - ClassificationTargetResult$outboundSchema, -} from "./classificationtargetresult.js"; - -export type ClassificationResponse = { - id: string; - model: string; - results: Array<{ [k: string]: ClassificationTargetResult }>; -}; - -/** @internal */ -export const ClassificationResponse$inboundSchema: z.ZodType< - ClassificationResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(ClassificationTargetResult$inboundSchema)), -}); - -/** @internal */ -export type ClassificationResponse$Outbound = { - id: string; - model: string; - results: Array<{ [k: string]: ClassificationTargetResult$Outbound }>; -}; - -/** @internal */ -export const ClassificationResponse$outboundSchema: z.ZodType< - ClassificationResponse$Outbound, - z.ZodTypeDef, - ClassificationResponse -> = z.object({ - id: z.string(), - model: z.string(), - results: z.array(z.record(ClassificationTargetResult$outboundSchema)), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassificationResponse$ { - /** @deprecated use `ClassificationResponse$inboundSchema` instead. */ - export const inboundSchema = ClassificationResponse$inboundSchema; - /** @deprecated use `ClassificationResponse$outboundSchema` instead. */ - export const outboundSchema = ClassificationResponse$outboundSchema; - /** @deprecated use `ClassificationResponse$Outbound` instead. */ - export type Outbound = ClassificationResponse$Outbound; -} - -export function classificationResponseToJSON( - classificationResponse: ClassificationResponse, -): string { - return JSON.stringify( - ClassificationResponse$outboundSchema.parse(classificationResponse), - ); -} - -export function classificationResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassificationResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassificationResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classificationtargetresult.ts b/examples/sdks/mistral-typescript/src/models/components/classificationtargetresult.ts deleted file mode 100644 index e15ee70cd..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classificationtargetresult.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ClassificationTargetResult = { - scores: { [k: string]: number }; -}; - -/** @internal */ -export const ClassificationTargetResult$inboundSchema: z.ZodType< - ClassificationTargetResult, - z.ZodTypeDef, - unknown -> = z.object({ - scores: z.record(z.number()), -}); - -/** @internal */ -export type ClassificationTargetResult$Outbound = { - scores: { [k: string]: number }; -}; - -/** @internal */ -export const ClassificationTargetResult$outboundSchema: z.ZodType< - ClassificationTargetResult$Outbound, - z.ZodTypeDef, - ClassificationTargetResult -> = z.object({ - scores: z.record(z.number()), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassificationTargetResult$ { - /** @deprecated use `ClassificationTargetResult$inboundSchema` instead. */ - export const inboundSchema = ClassificationTargetResult$inboundSchema; - /** @deprecated use `ClassificationTargetResult$outboundSchema` instead. */ - export const outboundSchema = ClassificationTargetResult$outboundSchema; - /** @deprecated use `ClassificationTargetResult$Outbound` instead. */ - export type Outbound = ClassificationTargetResult$Outbound; -} - -export function classificationTargetResultToJSON( - classificationTargetResult: ClassificationTargetResult, -): string { - return JSON.stringify( - ClassificationTargetResult$outboundSchema.parse(classificationTargetResult), - ); -} - -export function classificationTargetResultFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassificationTargetResult$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassificationTargetResult' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifierdetailedjobout.ts b/examples/sdks/mistral-typescript/src/models/components/classifierdetailedjobout.ts deleted file mode 100644 index fa440ab23..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifierdetailedjobout.ts +++ /dev/null @@ -1,357 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CheckpointOut, - CheckpointOut$inboundSchema, - CheckpointOut$Outbound, - CheckpointOut$outboundSchema, -} from "./checkpointout.js"; -import { - ClassifierTargetOut, - ClassifierTargetOut$inboundSchema, - ClassifierTargetOut$Outbound, - ClassifierTargetOut$outboundSchema, -} from "./classifiertargetout.js"; -import { - ClassifierTrainingParameters, - ClassifierTrainingParameters$inboundSchema, - ClassifierTrainingParameters$Outbound, - ClassifierTrainingParameters$outboundSchema, -} from "./classifiertrainingparameters.js"; -import { - EventOut, - EventOut$inboundSchema, - EventOut$Outbound, - EventOut$outboundSchema, -} from "./eventout.js"; -import { - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, -} from "./jobmetadataout.js"; -import { - WandbIntegrationOut, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, -} from "./wandbintegrationout.js"; - -export const ClassifierDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED", -} as const; -export type ClassifierDetailedJobOutStatus = ClosedEnum< - typeof ClassifierDetailedJobOutStatus ->; - -export const ClassifierDetailedJobOutObject = { - Job: "job", -} as const; -export type ClassifierDetailedJobOutObject = ClosedEnum< - typeof ClassifierDetailedJobOutObject ->; - -export type ClassifierDetailedJobOutIntegrations = WandbIntegrationOut; - -export const ClassifierDetailedJobOutJobType = { - Classifier: "classifier", -} as const; -export type ClassifierDetailedJobOutJobType = ClosedEnum< - typeof ClassifierDetailedJobOutJobType ->; - -export type ClassifierDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: ClassifierDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: ClassifierDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: ClassifierDetailedJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; - classifierTargets: Array; -}; - -/** @internal */ -export const ClassifierDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutStatus -> = z.nativeEnum(ClassifierDetailedJobOutStatus); - -/** @internal */ -export const ClassifierDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutStatus -> = ClassifierDetailedJobOutStatus$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierDetailedJobOutStatus$ { - /** @deprecated use `ClassifierDetailedJobOutStatus$inboundSchema` instead. */ - export const inboundSchema = ClassifierDetailedJobOutStatus$inboundSchema; - /** @deprecated use `ClassifierDetailedJobOutStatus$outboundSchema` instead. */ - export const outboundSchema = ClassifierDetailedJobOutStatus$outboundSchema; -} - -/** @internal */ -export const ClassifierDetailedJobOutObject$inboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutObject -> = z.nativeEnum(ClassifierDetailedJobOutObject); - -/** @internal */ -export const ClassifierDetailedJobOutObject$outboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutObject -> = ClassifierDetailedJobOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierDetailedJobOutObject$ { - /** @deprecated use `ClassifierDetailedJobOutObject$inboundSchema` instead. */ - export const inboundSchema = ClassifierDetailedJobOutObject$inboundSchema; - /** @deprecated use `ClassifierDetailedJobOutObject$outboundSchema` instead. */ - export const outboundSchema = ClassifierDetailedJobOutObject$outboundSchema; -} - -/** @internal */ -export const ClassifierDetailedJobOutIntegrations$inboundSchema: z.ZodType< - ClassifierDetailedJobOutIntegrations, - z.ZodTypeDef, - unknown -> = WandbIntegrationOut$inboundSchema; - -/** @internal */ -export type ClassifierDetailedJobOutIntegrations$Outbound = - WandbIntegrationOut$Outbound; - -/** @internal */ -export const ClassifierDetailedJobOutIntegrations$outboundSchema: z.ZodType< - ClassifierDetailedJobOutIntegrations$Outbound, - z.ZodTypeDef, - ClassifierDetailedJobOutIntegrations -> = WandbIntegrationOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierDetailedJobOutIntegrations$ { - /** @deprecated use `ClassifierDetailedJobOutIntegrations$inboundSchema` instead. */ - export const inboundSchema = - ClassifierDetailedJobOutIntegrations$inboundSchema; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$outboundSchema` instead. */ - export const outboundSchema = - ClassifierDetailedJobOutIntegrations$outboundSchema; - /** @deprecated use `ClassifierDetailedJobOutIntegrations$Outbound` instead. */ - export type Outbound = ClassifierDetailedJobOutIntegrations$Outbound; -} - -export function classifierDetailedJobOutIntegrationsToJSON( - classifierDetailedJobOutIntegrations: ClassifierDetailedJobOutIntegrations, -): string { - return JSON.stringify( - ClassifierDetailedJobOutIntegrations$outboundSchema.parse( - classifierDetailedJobOutIntegrations, - ), - ); -} - -export function classifierDetailedJobOutIntegrationsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - ClassifierDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierDetailedJobOutIntegrations' from JSON`, - ); -} - -/** @internal */ -export const ClassifierDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutJobType -> = z.nativeEnum(ClassifierDetailedJobOutJobType); - -/** @internal */ -export const ClassifierDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum< - typeof ClassifierDetailedJobOutJobType -> = ClassifierDetailedJobOutJobType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierDetailedJobOutJobType$ { - /** @deprecated use `ClassifierDetailedJobOutJobType$inboundSchema` instead. */ - export const inboundSchema = ClassifierDetailedJobOutJobType$inboundSchema; - /** @deprecated use `ClassifierDetailedJobOutJobType$outboundSchema` instead. */ - export const outboundSchema = ClassifierDetailedJobOutJobType$outboundSchema; -} - -/** @internal */ -export const ClassifierDetailedJobOut$inboundSchema: z.ZodType< - ClassifierDetailedJobOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: ClassifierDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: ClassifierDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$inboundSchema)) - .optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$inboundSchema).optional(), - job_type: ClassifierDetailedJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: ClassifierTrainingParameters$inboundSchema, - events: z.array(EventOut$inboundSchema).optional(), - checkpoints: z.array(CheckpointOut$inboundSchema).optional(), - classifier_targets: z.array(ClassifierTargetOut$inboundSchema), -}).transform((v) => { - return remap$(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - "classifier_targets": "classifierTargets", - }); -}); - -/** @internal */ -export type ClassifierDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; - events?: Array | undefined; - checkpoints?: Array | undefined; - classifier_targets: Array; -}; - -/** @internal */ -export const ClassifierDetailedJobOut$outboundSchema: z.ZodType< - ClassifierDetailedJobOut$Outbound, - z.ZodTypeDef, - ClassifierDetailedJobOut -> = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: ClassifierDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: ClassifierDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$outboundSchema)) - .optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$outboundSchema).optional(), - jobType: ClassifierDetailedJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: ClassifierTrainingParameters$outboundSchema, - events: z.array(EventOut$outboundSchema).optional(), - checkpoints: z.array(CheckpointOut$outboundSchema).optional(), - classifierTargets: z.array(ClassifierTargetOut$outboundSchema), -}).transform((v) => { - return remap$(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - classifierTargets: "classifier_targets", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierDetailedJobOut$ { - /** @deprecated use `ClassifierDetailedJobOut$inboundSchema` instead. */ - export const inboundSchema = ClassifierDetailedJobOut$inboundSchema; - /** @deprecated use `ClassifierDetailedJobOut$outboundSchema` instead. */ - export const outboundSchema = ClassifierDetailedJobOut$outboundSchema; - /** @deprecated use `ClassifierDetailedJobOut$Outbound` instead. */ - export type Outbound = ClassifierDetailedJobOut$Outbound; -} - -export function classifierDetailedJobOutToJSON( - classifierDetailedJobOut: ClassifierDetailedJobOut, -): string { - return JSON.stringify( - ClassifierDetailedJobOut$outboundSchema.parse(classifierDetailedJobOut), - ); -} - -export function classifierDetailedJobOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierDetailedJobOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierDetailedJobOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifierftmodelout.ts b/examples/sdks/mistral-typescript/src/models/components/classifierftmodelout.ts deleted file mode 100644 index c654deda0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifierftmodelout.ts +++ /dev/null @@ -1,214 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ClassifierTargetOut, - ClassifierTargetOut$inboundSchema, - ClassifierTargetOut$Outbound, - ClassifierTargetOut$outboundSchema, -} from "./classifiertargetout.js"; -import { - FTModelCapabilitiesOut, - FTModelCapabilitiesOut$inboundSchema, - FTModelCapabilitiesOut$Outbound, - FTModelCapabilitiesOut$outboundSchema, -} from "./ftmodelcapabilitiesout.js"; - -export const ClassifierFTModelOutObject = { - Model: "model", -} as const; -export type ClassifierFTModelOutObject = ClosedEnum< - typeof ClassifierFTModelOutObject ->; - -export const ClassifierFTModelOutModelType = { - Classifier: "classifier", -} as const; -export type ClassifierFTModelOutModelType = ClosedEnum< - typeof ClassifierFTModelOutModelType ->; - -export type ClassifierFTModelOut = { - id: string; - object?: ClassifierFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - classifierTargets: Array; - modelType?: ClassifierFTModelOutModelType | undefined; -}; - -/** @internal */ -export const ClassifierFTModelOutObject$inboundSchema: z.ZodNativeEnum< - typeof ClassifierFTModelOutObject -> = z.nativeEnum(ClassifierFTModelOutObject); - -/** @internal */ -export const ClassifierFTModelOutObject$outboundSchema: z.ZodNativeEnum< - typeof ClassifierFTModelOutObject -> = ClassifierFTModelOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierFTModelOutObject$ { - /** @deprecated use `ClassifierFTModelOutObject$inboundSchema` instead. */ - export const inboundSchema = ClassifierFTModelOutObject$inboundSchema; - /** @deprecated use `ClassifierFTModelOutObject$outboundSchema` instead. */ - export const outboundSchema = ClassifierFTModelOutObject$outboundSchema; -} - -/** @internal */ -export const ClassifierFTModelOutModelType$inboundSchema: z.ZodNativeEnum< - typeof ClassifierFTModelOutModelType -> = z.nativeEnum(ClassifierFTModelOutModelType); - -/** @internal */ -export const ClassifierFTModelOutModelType$outboundSchema: z.ZodNativeEnum< - typeof ClassifierFTModelOutModelType -> = ClassifierFTModelOutModelType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierFTModelOutModelType$ { - /** @deprecated use `ClassifierFTModelOutModelType$inboundSchema` instead. */ - export const inboundSchema = ClassifierFTModelOutModelType$inboundSchema; - /** @deprecated use `ClassifierFTModelOutModelType$outboundSchema` instead. */ - export const outboundSchema = ClassifierFTModelOutModelType$outboundSchema; -} - -/** @internal */ -export const ClassifierFTModelOut$inboundSchema: z.ZodType< - ClassifierFTModelOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: ClassifierFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifier_targets: z.array(ClassifierTargetOut$inboundSchema), - model_type: ClassifierFTModelOutModelType$inboundSchema.default("classifier"), -}).transform((v) => { - return remap$(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "classifier_targets": "classifierTargets", - "model_type": "modelType", - }); -}); - -/** @internal */ -export type ClassifierFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - classifier_targets: Array; - model_type: string; -}; - -/** @internal */ -export const ClassifierFTModelOut$outboundSchema: z.ZodType< - ClassifierFTModelOut$Outbound, - z.ZodTypeDef, - ClassifierFTModelOut -> = z.object({ - id: z.string(), - object: ClassifierFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - classifierTargets: z.array(ClassifierTargetOut$outboundSchema), - modelType: ClassifierFTModelOutModelType$outboundSchema.default("classifier"), -}).transform((v) => { - return remap$(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - classifierTargets: "classifier_targets", - modelType: "model_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierFTModelOut$ { - /** @deprecated use `ClassifierFTModelOut$inboundSchema` instead. */ - export const inboundSchema = ClassifierFTModelOut$inboundSchema; - /** @deprecated use `ClassifierFTModelOut$outboundSchema` instead. */ - export const outboundSchema = ClassifierFTModelOut$outboundSchema; - /** @deprecated use `ClassifierFTModelOut$Outbound` instead. */ - export type Outbound = ClassifierFTModelOut$Outbound; -} - -export function classifierFTModelOutToJSON( - classifierFTModelOut: ClassifierFTModelOut, -): string { - return JSON.stringify( - ClassifierFTModelOut$outboundSchema.parse(classifierFTModelOut), - ); -} - -export function classifierFTModelOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierFTModelOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierFTModelOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifierjobout.ts b/examples/sdks/mistral-typescript/src/models/components/classifierjobout.ts deleted file mode 100644 index 01074873f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifierjobout.ts +++ /dev/null @@ -1,369 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ClassifierTrainingParameters, - ClassifierTrainingParameters$inboundSchema, - ClassifierTrainingParameters$Outbound, - ClassifierTrainingParameters$outboundSchema, -} from "./classifiertrainingparameters.js"; -import { - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, -} from "./jobmetadataout.js"; -import { - WandbIntegrationOut, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, -} from "./wandbintegrationout.js"; - -/** - * The current status of the fine-tuning job. - */ -export const ClassifierJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED", -} as const; -/** - * The current status of the fine-tuning job. - */ -export type ClassifierJobOutStatus = ClosedEnum; - -/** - * The object type of the fine-tuning job. - */ -export const ClassifierJobOutObject = { - Job: "job", -} as const; -/** - * The object type of the fine-tuning job. - */ -export type ClassifierJobOutObject = ClosedEnum; - -export type ClassifierJobOutIntegrations = WandbIntegrationOut; - -/** - * The type of job (`FT` for fine-tuning). - */ -export const ClassifierJobOutJobType = { - Classifier: "classifier", -} as const; -/** - * The type of job (`FT` for fine-tuning). - */ -export type ClassifierJobOutJobType = ClosedEnum< - typeof ClassifierJobOutJobType ->; - -export type ClassifierJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: ClassifierJobOutStatus; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: ClassifierJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: ClassifierJobOutJobType | undefined; - hyperparameters: ClassifierTrainingParameters; -}; - -/** @internal */ -export const ClassifierJobOutStatus$inboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutStatus -> = z.nativeEnum(ClassifierJobOutStatus); - -/** @internal */ -export const ClassifierJobOutStatus$outboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutStatus -> = ClassifierJobOutStatus$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierJobOutStatus$ { - /** @deprecated use `ClassifierJobOutStatus$inboundSchema` instead. */ - export const inboundSchema = ClassifierJobOutStatus$inboundSchema; - /** @deprecated use `ClassifierJobOutStatus$outboundSchema` instead. */ - export const outboundSchema = ClassifierJobOutStatus$outboundSchema; -} - -/** @internal */ -export const ClassifierJobOutObject$inboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutObject -> = z.nativeEnum(ClassifierJobOutObject); - -/** @internal */ -export const ClassifierJobOutObject$outboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutObject -> = ClassifierJobOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierJobOutObject$ { - /** @deprecated use `ClassifierJobOutObject$inboundSchema` instead. */ - export const inboundSchema = ClassifierJobOutObject$inboundSchema; - /** @deprecated use `ClassifierJobOutObject$outboundSchema` instead. */ - export const outboundSchema = ClassifierJobOutObject$outboundSchema; -} - -/** @internal */ -export const ClassifierJobOutIntegrations$inboundSchema: z.ZodType< - ClassifierJobOutIntegrations, - z.ZodTypeDef, - unknown -> = WandbIntegrationOut$inboundSchema; - -/** @internal */ -export type ClassifierJobOutIntegrations$Outbound = - WandbIntegrationOut$Outbound; - -/** @internal */ -export const ClassifierJobOutIntegrations$outboundSchema: z.ZodType< - ClassifierJobOutIntegrations$Outbound, - z.ZodTypeDef, - ClassifierJobOutIntegrations -> = WandbIntegrationOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierJobOutIntegrations$ { - /** @deprecated use `ClassifierJobOutIntegrations$inboundSchema` instead. */ - export const inboundSchema = ClassifierJobOutIntegrations$inboundSchema; - /** @deprecated use `ClassifierJobOutIntegrations$outboundSchema` instead. */ - export const outboundSchema = ClassifierJobOutIntegrations$outboundSchema; - /** @deprecated use `ClassifierJobOutIntegrations$Outbound` instead. */ - export type Outbound = ClassifierJobOutIntegrations$Outbound; -} - -export function classifierJobOutIntegrationsToJSON( - classifierJobOutIntegrations: ClassifierJobOutIntegrations, -): string { - return JSON.stringify( - ClassifierJobOutIntegrations$outboundSchema.parse( - classifierJobOutIntegrations, - ), - ); -} - -export function classifierJobOutIntegrationsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierJobOutIntegrations' from JSON`, - ); -} - -/** @internal */ -export const ClassifierJobOutJobType$inboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutJobType -> = z.nativeEnum(ClassifierJobOutJobType); - -/** @internal */ -export const ClassifierJobOutJobType$outboundSchema: z.ZodNativeEnum< - typeof ClassifierJobOutJobType -> = ClassifierJobOutJobType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierJobOutJobType$ { - /** @deprecated use `ClassifierJobOutJobType$inboundSchema` instead. */ - export const inboundSchema = ClassifierJobOutJobType$inboundSchema; - /** @deprecated use `ClassifierJobOutJobType$outboundSchema` instead. */ - export const outboundSchema = ClassifierJobOutJobType$outboundSchema; -} - -/** @internal */ -export const ClassifierJobOut$inboundSchema: z.ZodType< - ClassifierJobOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: ClassifierJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: ClassifierJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$inboundSchema)) - .optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$inboundSchema).optional(), - job_type: ClassifierJobOutJobType$inboundSchema.default("classifier"), - hyperparameters: ClassifierTrainingParameters$inboundSchema, -}).transform((v) => { - return remap$(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - }); -}); - -/** @internal */ -export type ClassifierJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: ClassifierTrainingParameters$Outbound; -}; - -/** @internal */ -export const ClassifierJobOut$outboundSchema: z.ZodType< - ClassifierJobOut$Outbound, - z.ZodTypeDef, - ClassifierJobOut -> = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: ClassifierJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: ClassifierJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$outboundSchema)) - .optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$outboundSchema).optional(), - jobType: ClassifierJobOutJobType$outboundSchema.default("classifier"), - hyperparameters: ClassifierTrainingParameters$outboundSchema, -}).transform((v) => { - return remap$(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierJobOut$ { - /** @deprecated use `ClassifierJobOut$inboundSchema` instead. */ - export const inboundSchema = ClassifierJobOut$inboundSchema; - /** @deprecated use `ClassifierJobOut$outboundSchema` instead. */ - export const outboundSchema = ClassifierJobOut$outboundSchema; - /** @deprecated use `ClassifierJobOut$Outbound` instead. */ - export type Outbound = ClassifierJobOut$Outbound; -} - -export function classifierJobOutToJSON( - classifierJobOut: ClassifierJobOut, -): string { - return JSON.stringify( - ClassifierJobOut$outboundSchema.parse(classifierJobOut), - ); -} - -export function classifierJobOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierJobOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierJobOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifiertargetin.ts b/examples/sdks/mistral-typescript/src/models/components/classifiertargetin.ts deleted file mode 100644 index b65a27c81..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifiertargetin.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FTClassifierLossFunction, - FTClassifierLossFunction$inboundSchema, - FTClassifierLossFunction$outboundSchema, -} from "./ftclassifierlossfunction.js"; - -export type ClassifierTargetIn = { - name: string; - labels: Array; - weight?: number | undefined; - lossFunction?: FTClassifierLossFunction | null | undefined; -}; - -/** @internal */ -export const ClassifierTargetIn$inboundSchema: z.ZodType< - ClassifierTargetIn, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - loss_function: z.nullable(FTClassifierLossFunction$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "loss_function": "lossFunction", - }); -}); - -/** @internal */ -export type ClassifierTargetIn$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function?: string | null | undefined; -}; - -/** @internal */ -export const ClassifierTargetIn$outboundSchema: z.ZodType< - ClassifierTargetIn$Outbound, - z.ZodTypeDef, - ClassifierTargetIn -> = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number().default(1), - lossFunction: z.nullable(FTClassifierLossFunction$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - lossFunction: "loss_function", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierTargetIn$ { - /** @deprecated use `ClassifierTargetIn$inboundSchema` instead. */ - export const inboundSchema = ClassifierTargetIn$inboundSchema; - /** @deprecated use `ClassifierTargetIn$outboundSchema` instead. */ - export const outboundSchema = ClassifierTargetIn$outboundSchema; - /** @deprecated use `ClassifierTargetIn$Outbound` instead. */ - export type Outbound = ClassifierTargetIn$Outbound; -} - -export function classifierTargetInToJSON( - classifierTargetIn: ClassifierTargetIn, -): string { - return JSON.stringify( - ClassifierTargetIn$outboundSchema.parse(classifierTargetIn), - ); -} - -export function classifierTargetInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierTargetIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierTargetIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifiertargetout.ts b/examples/sdks/mistral-typescript/src/models/components/classifiertargetout.ts deleted file mode 100644 index b4f7d9758..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifiertargetout.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FTClassifierLossFunction, - FTClassifierLossFunction$inboundSchema, - FTClassifierLossFunction$outboundSchema, -} from "./ftclassifierlossfunction.js"; - -export type ClassifierTargetOut = { - name: string; - labels: Array; - weight: number; - lossFunction: FTClassifierLossFunction; -}; - -/** @internal */ -export const ClassifierTargetOut$inboundSchema: z.ZodType< - ClassifierTargetOut, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - loss_function: FTClassifierLossFunction$inboundSchema, -}).transform((v) => { - return remap$(v, { - "loss_function": "lossFunction", - }); -}); - -/** @internal */ -export type ClassifierTargetOut$Outbound = { - name: string; - labels: Array; - weight: number; - loss_function: string; -}; - -/** @internal */ -export const ClassifierTargetOut$outboundSchema: z.ZodType< - ClassifierTargetOut$Outbound, - z.ZodTypeDef, - ClassifierTargetOut -> = z.object({ - name: z.string(), - labels: z.array(z.string()), - weight: z.number(), - lossFunction: FTClassifierLossFunction$outboundSchema, -}).transform((v) => { - return remap$(v, { - lossFunction: "loss_function", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierTargetOut$ { - /** @deprecated use `ClassifierTargetOut$inboundSchema` instead. */ - export const inboundSchema = ClassifierTargetOut$inboundSchema; - /** @deprecated use `ClassifierTargetOut$outboundSchema` instead. */ - export const outboundSchema = ClassifierTargetOut$outboundSchema; - /** @deprecated use `ClassifierTargetOut$Outbound` instead. */ - export type Outbound = ClassifierTargetOut$Outbound; -} - -export function classifierTargetOutToJSON( - classifierTargetOut: ClassifierTargetOut, -): string { - return JSON.stringify( - ClassifierTargetOut$outboundSchema.parse(classifierTargetOut), - ); -} - -export function classifierTargetOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierTargetOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierTargetOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparameters.ts b/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparameters.ts deleted file mode 100644 index 0da430ef0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparameters.ts +++ /dev/null @@ -1,105 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ClassifierTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -/** @internal */ -export const ClassifierTrainingParameters$inboundSchema: z.ZodType< - ClassifierTrainingParameters, - z.ZodTypeDef, - unknown -> = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(0.0001), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - }); -}); - -/** @internal */ -export type ClassifierTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -export const ClassifierTrainingParameters$outboundSchema: z.ZodType< - ClassifierTrainingParameters$Outbound, - z.ZodTypeDef, - ClassifierTrainingParameters -> = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(0.0001), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierTrainingParameters$ { - /** @deprecated use `ClassifierTrainingParameters$inboundSchema` instead. */ - export const inboundSchema = ClassifierTrainingParameters$inboundSchema; - /** @deprecated use `ClassifierTrainingParameters$outboundSchema` instead. */ - export const outboundSchema = ClassifierTrainingParameters$outboundSchema; - /** @deprecated use `ClassifierTrainingParameters$Outbound` instead. */ - export type Outbound = ClassifierTrainingParameters$Outbound; -} - -export function classifierTrainingParametersToJSON( - classifierTrainingParameters: ClassifierTrainingParameters, -): string { - return JSON.stringify( - ClassifierTrainingParameters$outboundSchema.parse( - classifierTrainingParameters, - ), - ); -} - -export function classifierTrainingParametersFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierTrainingParameters$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierTrainingParameters' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparametersin.ts b/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparametersin.ts deleted file mode 100644 index d806a9779..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/classifiertrainingparametersin.ts +++ /dev/null @@ -1,120 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * The fine-tuning hyperparameter settings used in a classifier fine-tune job. - */ -export type ClassifierTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; -}; - -/** @internal */ -export const ClassifierTrainingParametersIn$inboundSchema: z.ZodType< - ClassifierTrainingParametersIn, - z.ZodTypeDef, - unknown -> = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(0.0001), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - }); -}); - -/** @internal */ -export type ClassifierTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; -}; - -/** @internal */ -export const ClassifierTrainingParametersIn$outboundSchema: z.ZodType< - ClassifierTrainingParametersIn$Outbound, - z.ZodTypeDef, - ClassifierTrainingParametersIn -> = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(0.0001), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ClassifierTrainingParametersIn$ { - /** @deprecated use `ClassifierTrainingParametersIn$inboundSchema` instead. */ - export const inboundSchema = ClassifierTrainingParametersIn$inboundSchema; - /** @deprecated use `ClassifierTrainingParametersIn$outboundSchema` instead. */ - export const outboundSchema = ClassifierTrainingParametersIn$outboundSchema; - /** @deprecated use `ClassifierTrainingParametersIn$Outbound` instead. */ - export type Outbound = ClassifierTrainingParametersIn$Outbound; -} - -export function classifierTrainingParametersInToJSON( - classifierTrainingParametersIn: ClassifierTrainingParametersIn, -): string { - return JSON.stringify( - ClassifierTrainingParametersIn$outboundSchema.parse( - classifierTrainingParametersIn, - ), - ); -} - -export function classifierTrainingParametersInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ClassifierTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ClassifierTrainingParametersIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/codeinterpretertool.ts b/examples/sdks/mistral-typescript/src/models/components/codeinterpretertool.ts deleted file mode 100644 index 167d811ee..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/codeinterpretertool.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const CodeInterpreterToolType = { - CodeInterpreter: "code_interpreter", -} as const; -export type CodeInterpreterToolType = ClosedEnum< - typeof CodeInterpreterToolType ->; - -export type CodeInterpreterTool = { - type?: CodeInterpreterToolType | undefined; -}; - -/** @internal */ -export const CodeInterpreterToolType$inboundSchema: z.ZodNativeEnum< - typeof CodeInterpreterToolType -> = z.nativeEnum(CodeInterpreterToolType); - -/** @internal */ -export const CodeInterpreterToolType$outboundSchema: z.ZodNativeEnum< - typeof CodeInterpreterToolType -> = CodeInterpreterToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CodeInterpreterToolType$ { - /** @deprecated use `CodeInterpreterToolType$inboundSchema` instead. */ - export const inboundSchema = CodeInterpreterToolType$inboundSchema; - /** @deprecated use `CodeInterpreterToolType$outboundSchema` instead. */ - export const outboundSchema = CodeInterpreterToolType$outboundSchema; -} - -/** @internal */ -export const CodeInterpreterTool$inboundSchema: z.ZodType< - CodeInterpreterTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: CodeInterpreterToolType$inboundSchema.default("code_interpreter"), -}); - -/** @internal */ -export type CodeInterpreterTool$Outbound = { - type: string; -}; - -/** @internal */ -export const CodeInterpreterTool$outboundSchema: z.ZodType< - CodeInterpreterTool$Outbound, - z.ZodTypeDef, - CodeInterpreterTool -> = z.object({ - type: CodeInterpreterToolType$outboundSchema.default("code_interpreter"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CodeInterpreterTool$ { - /** @deprecated use `CodeInterpreterTool$inboundSchema` instead. */ - export const inboundSchema = CodeInterpreterTool$inboundSchema; - /** @deprecated use `CodeInterpreterTool$outboundSchema` instead. */ - export const outboundSchema = CodeInterpreterTool$outboundSchema; - /** @deprecated use `CodeInterpreterTool$Outbound` instead. */ - export type Outbound = CodeInterpreterTool$Outbound; -} - -export function codeInterpreterToolToJSON( - codeInterpreterTool: CodeInterpreterTool, -): string { - return JSON.stringify( - CodeInterpreterTool$outboundSchema.parse(codeInterpreterTool), - ); -} - -export function codeInterpreterToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CodeInterpreterTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CodeInterpreterTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionargs.ts b/examples/sdks/mistral-typescript/src/models/components/completionargs.ts deleted file mode 100644 index e6edede9b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionargs.ts +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionArgsStop, - CompletionArgsStop$inboundSchema, - CompletionArgsStop$Outbound, - CompletionArgsStop$outboundSchema, -} from "./completionargsstop.js"; -import { - Prediction, - Prediction$inboundSchema, - Prediction$Outbound, - Prediction$outboundSchema, -} from "./prediction.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; -import { - ToolChoiceEnum, - ToolChoiceEnum$inboundSchema, - ToolChoiceEnum$outboundSchema, -} from "./toolchoiceenum.js"; - -/** - * White-listed arguments from the completion API - */ -export type CompletionArgs = { - stop?: CompletionArgsStop | null | undefined; - presencePenalty?: number | null | undefined; - frequencyPenalty?: number | null | undefined; - temperature?: number | null | undefined; - topP?: number | null | undefined; - maxTokens?: number | null | undefined; - randomSeed?: number | null | undefined; - prediction?: Prediction | null | undefined; - responseFormat?: ResponseFormat | null | undefined; - toolChoice?: ToolChoiceEnum | undefined; -}; - -/** @internal */ -export const CompletionArgs$inboundSchema: z.ZodType< - CompletionArgs, - z.ZodTypeDef, - unknown -> = z.object({ - stop: z.nullable(CompletionArgsStop$inboundSchema).optional(), - presence_penalty: z.nullable(z.number()).optional(), - frequency_penalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - top_p: z.nullable(z.number()).optional(), - max_tokens: z.nullable(z.number().int()).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(Prediction$inboundSchema).optional(), - response_format: z.nullable(ResponseFormat$inboundSchema).optional(), - tool_choice: ToolChoiceEnum$inboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - "presence_penalty": "presencePenalty", - "frequency_penalty": "frequencyPenalty", - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "response_format": "responseFormat", - "tool_choice": "toolChoice", - }); -}); - -/** @internal */ -export type CompletionArgs$Outbound = { - stop?: CompletionArgsStop$Outbound | null | undefined; - presence_penalty?: number | null | undefined; - frequency_penalty?: number | null | undefined; - temperature?: number | null | undefined; - top_p?: number | null | undefined; - max_tokens?: number | null | undefined; - random_seed?: number | null | undefined; - prediction?: Prediction$Outbound | null | undefined; - response_format?: ResponseFormat$Outbound | null | undefined; - tool_choice?: string | undefined; -}; - -/** @internal */ -export const CompletionArgs$outboundSchema: z.ZodType< - CompletionArgs$Outbound, - z.ZodTypeDef, - CompletionArgs -> = z.object({ - stop: z.nullable(CompletionArgsStop$outboundSchema).optional(), - presencePenalty: z.nullable(z.number()).optional(), - frequencyPenalty: z.nullable(z.number()).optional(), - temperature: z.nullable(z.number()).optional(), - topP: z.nullable(z.number()).optional(), - maxTokens: z.nullable(z.number().int()).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prediction: z.nullable(Prediction$outboundSchema).optional(), - responseFormat: z.nullable(ResponseFormat$outboundSchema).optional(), - toolChoice: ToolChoiceEnum$outboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - presencePenalty: "presence_penalty", - frequencyPenalty: "frequency_penalty", - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - responseFormat: "response_format", - toolChoice: "tool_choice", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionArgs$ { - /** @deprecated use `CompletionArgs$inboundSchema` instead. */ - export const inboundSchema = CompletionArgs$inboundSchema; - /** @deprecated use `CompletionArgs$outboundSchema` instead. */ - export const outboundSchema = CompletionArgs$outboundSchema; - /** @deprecated use `CompletionArgs$Outbound` instead. */ - export type Outbound = CompletionArgs$Outbound; -} - -export function completionArgsToJSON(completionArgs: CompletionArgs): string { - return JSON.stringify(CompletionArgs$outboundSchema.parse(completionArgs)); -} - -export function completionArgsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionArgs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionArgs' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionargsstop.ts b/examples/sdks/mistral-typescript/src/models/components/completionargsstop.ts deleted file mode 100644 index 389a7037f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionargsstop.ts +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type CompletionArgsStop = string | Array; - -/** @internal */ -export const CompletionArgsStop$inboundSchema: z.ZodType< - CompletionArgsStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type CompletionArgsStop$Outbound = string | Array; - -/** @internal */ -export const CompletionArgsStop$outboundSchema: z.ZodType< - CompletionArgsStop$Outbound, - z.ZodTypeDef, - CompletionArgsStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionArgsStop$ { - /** @deprecated use `CompletionArgsStop$inboundSchema` instead. */ - export const inboundSchema = CompletionArgsStop$inboundSchema; - /** @deprecated use `CompletionArgsStop$outboundSchema` instead. */ - export const outboundSchema = CompletionArgsStop$outboundSchema; - /** @deprecated use `CompletionArgsStop$Outbound` instead. */ - export type Outbound = CompletionArgsStop$Outbound; -} - -export function completionArgsStopToJSON( - completionArgsStop: CompletionArgsStop, -): string { - return JSON.stringify( - CompletionArgsStop$outboundSchema.parse(completionArgsStop), - ); -} - -export function completionArgsStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionArgsStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionArgsStop' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionchunk.ts b/examples/sdks/mistral-typescript/src/models/components/completionchunk.ts deleted file mode 100644 index 31e00897d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionchunk.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionResponseStreamChoice, - CompletionResponseStreamChoice$inboundSchema, - CompletionResponseStreamChoice$Outbound, - CompletionResponseStreamChoice$outboundSchema, -} from "./completionresponsestreamchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type CompletionChunk = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$inboundSchema: z.ZodType< - CompletionChunk, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$inboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$inboundSchema), -}); - -/** @internal */ -export type CompletionChunk$Outbound = { - id: string; - object?: string | undefined; - created?: number | undefined; - model: string; - usage?: UsageInfo$Outbound | undefined; - choices: Array; -}; - -/** @internal */ -export const CompletionChunk$outboundSchema: z.ZodType< - CompletionChunk$Outbound, - z.ZodTypeDef, - CompletionChunk -> = z.object({ - id: z.string(), - object: z.string().optional(), - created: z.number().int().optional(), - model: z.string(), - usage: UsageInfo$outboundSchema.optional(), - choices: z.array(CompletionResponseStreamChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionChunk$ { - /** @deprecated use `CompletionChunk$inboundSchema` instead. */ - export const inboundSchema = CompletionChunk$inboundSchema; - /** @deprecated use `CompletionChunk$outboundSchema` instead. */ - export const outboundSchema = CompletionChunk$outboundSchema; - /** @deprecated use `CompletionChunk$Outbound` instead. */ - export type Outbound = CompletionChunk$Outbound; -} - -export function completionChunkToJSON( - completionChunk: CompletionChunk, -): string { - return JSON.stringify(CompletionChunk$outboundSchema.parse(completionChunk)); -} - -export function completionChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completiondetailedjobout.ts b/examples/sdks/mistral-typescript/src/models/components/completiondetailedjobout.ts deleted file mode 100644 index 2154475e8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completiondetailedjobout.ts +++ /dev/null @@ -1,411 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CheckpointOut, - CheckpointOut$inboundSchema, - CheckpointOut$Outbound, - CheckpointOut$outboundSchema, -} from "./checkpointout.js"; -import { - CompletionTrainingParameters, - CompletionTrainingParameters$inboundSchema, - CompletionTrainingParameters$Outbound, - CompletionTrainingParameters$outboundSchema, -} from "./completiontrainingparameters.js"; -import { - EventOut, - EventOut$inboundSchema, - EventOut$Outbound, - EventOut$outboundSchema, -} from "./eventout.js"; -import { - GithubRepositoryOut, - GithubRepositoryOut$inboundSchema, - GithubRepositoryOut$Outbound, - GithubRepositoryOut$outboundSchema, -} from "./githubrepositoryout.js"; -import { - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, -} from "./jobmetadataout.js"; -import { - WandbIntegrationOut, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, -} from "./wandbintegrationout.js"; - -export const CompletionDetailedJobOutStatus = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED", -} as const; -export type CompletionDetailedJobOutStatus = ClosedEnum< - typeof CompletionDetailedJobOutStatus ->; - -export const CompletionDetailedJobOutObject = { - Job: "job", -} as const; -export type CompletionDetailedJobOutObject = ClosedEnum< - typeof CompletionDetailedJobOutObject ->; - -export type CompletionDetailedJobOutIntegrations = WandbIntegrationOut; - -export const CompletionDetailedJobOutJobType = { - Completion: "completion", -} as const; -export type CompletionDetailedJobOutJobType = ClosedEnum< - typeof CompletionDetailedJobOutJobType ->; - -export type CompletionDetailedJobOutRepositories = GithubRepositoryOut; - -export type CompletionDetailedJobOut = { - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - status: CompletionDetailedJobOutStatus; - createdAt: number; - modifiedAt: number; - trainingFiles: Array; - validationFiles?: Array | null | undefined; - object?: CompletionDetailedJobOutObject | undefined; - fineTunedModel?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - jobType?: CompletionDetailedJobOutJobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; - /** - * Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - */ - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -/** @internal */ -export const CompletionDetailedJobOutStatus$inboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutStatus -> = z.nativeEnum(CompletionDetailedJobOutStatus); - -/** @internal */ -export const CompletionDetailedJobOutStatus$outboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutStatus -> = CompletionDetailedJobOutStatus$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOutStatus$ { - /** @deprecated use `CompletionDetailedJobOutStatus$inboundSchema` instead. */ - export const inboundSchema = CompletionDetailedJobOutStatus$inboundSchema; - /** @deprecated use `CompletionDetailedJobOutStatus$outboundSchema` instead. */ - export const outboundSchema = CompletionDetailedJobOutStatus$outboundSchema; -} - -/** @internal */ -export const CompletionDetailedJobOutObject$inboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutObject -> = z.nativeEnum(CompletionDetailedJobOutObject); - -/** @internal */ -export const CompletionDetailedJobOutObject$outboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutObject -> = CompletionDetailedJobOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOutObject$ { - /** @deprecated use `CompletionDetailedJobOutObject$inboundSchema` instead. */ - export const inboundSchema = CompletionDetailedJobOutObject$inboundSchema; - /** @deprecated use `CompletionDetailedJobOutObject$outboundSchema` instead. */ - export const outboundSchema = CompletionDetailedJobOutObject$outboundSchema; -} - -/** @internal */ -export const CompletionDetailedJobOutIntegrations$inboundSchema: z.ZodType< - CompletionDetailedJobOutIntegrations, - z.ZodTypeDef, - unknown -> = WandbIntegrationOut$inboundSchema; - -/** @internal */ -export type CompletionDetailedJobOutIntegrations$Outbound = - WandbIntegrationOut$Outbound; - -/** @internal */ -export const CompletionDetailedJobOutIntegrations$outboundSchema: z.ZodType< - CompletionDetailedJobOutIntegrations$Outbound, - z.ZodTypeDef, - CompletionDetailedJobOutIntegrations -> = WandbIntegrationOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOutIntegrations$ { - /** @deprecated use `CompletionDetailedJobOutIntegrations$inboundSchema` instead. */ - export const inboundSchema = - CompletionDetailedJobOutIntegrations$inboundSchema; - /** @deprecated use `CompletionDetailedJobOutIntegrations$outboundSchema` instead. */ - export const outboundSchema = - CompletionDetailedJobOutIntegrations$outboundSchema; - /** @deprecated use `CompletionDetailedJobOutIntegrations$Outbound` instead. */ - export type Outbound = CompletionDetailedJobOutIntegrations$Outbound; -} - -export function completionDetailedJobOutIntegrationsToJSON( - completionDetailedJobOutIntegrations: CompletionDetailedJobOutIntegrations, -): string { - return JSON.stringify( - CompletionDetailedJobOutIntegrations$outboundSchema.parse( - completionDetailedJobOutIntegrations, - ), - ); -} - -export function completionDetailedJobOutIntegrationsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - CompletionDetailedJobOutIntegrations$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionDetailedJobOutIntegrations' from JSON`, - ); -} - -/** @internal */ -export const CompletionDetailedJobOutJobType$inboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutJobType -> = z.nativeEnum(CompletionDetailedJobOutJobType); - -/** @internal */ -export const CompletionDetailedJobOutJobType$outboundSchema: z.ZodNativeEnum< - typeof CompletionDetailedJobOutJobType -> = CompletionDetailedJobOutJobType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOutJobType$ { - /** @deprecated use `CompletionDetailedJobOutJobType$inboundSchema` instead. */ - export const inboundSchema = CompletionDetailedJobOutJobType$inboundSchema; - /** @deprecated use `CompletionDetailedJobOutJobType$outboundSchema` instead. */ - export const outboundSchema = CompletionDetailedJobOutJobType$outboundSchema; -} - -/** @internal */ -export const CompletionDetailedJobOutRepositories$inboundSchema: z.ZodType< - CompletionDetailedJobOutRepositories, - z.ZodTypeDef, - unknown -> = GithubRepositoryOut$inboundSchema; - -/** @internal */ -export type CompletionDetailedJobOutRepositories$Outbound = - GithubRepositoryOut$Outbound; - -/** @internal */ -export const CompletionDetailedJobOutRepositories$outboundSchema: z.ZodType< - CompletionDetailedJobOutRepositories$Outbound, - z.ZodTypeDef, - CompletionDetailedJobOutRepositories -> = GithubRepositoryOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOutRepositories$ { - /** @deprecated use `CompletionDetailedJobOutRepositories$inboundSchema` instead. */ - export const inboundSchema = - CompletionDetailedJobOutRepositories$inboundSchema; - /** @deprecated use `CompletionDetailedJobOutRepositories$outboundSchema` instead. */ - export const outboundSchema = - CompletionDetailedJobOutRepositories$outboundSchema; - /** @deprecated use `CompletionDetailedJobOutRepositories$Outbound` instead. */ - export type Outbound = CompletionDetailedJobOutRepositories$Outbound; -} - -export function completionDetailedJobOutRepositoriesToJSON( - completionDetailedJobOutRepositories: CompletionDetailedJobOutRepositories, -): string { - return JSON.stringify( - CompletionDetailedJobOutRepositories$outboundSchema.parse( - completionDetailedJobOutRepositories, - ), - ); -} - -export function completionDetailedJobOutRepositoriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - CompletionDetailedJobOutRepositories$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionDetailedJobOutRepositories' from JSON`, - ); -} - -/** @internal */ -export const CompletionDetailedJobOut$inboundSchema: z.ZodType< - CompletionDetailedJobOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: CompletionDetailedJobOutStatus$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: CompletionDetailedJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$inboundSchema)) - .optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$inboundSchema).optional(), - job_type: CompletionDetailedJobOutJobType$inboundSchema.default("completion"), - hyperparameters: CompletionTrainingParameters$inboundSchema, - repositories: z.array(GithubRepositoryOut$inboundSchema).optional(), - events: z.array(EventOut$inboundSchema).optional(), - checkpoints: z.array(CheckpointOut$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - }); -}); - -/** @internal */ -export type CompletionDetailedJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; - events?: Array | undefined; - checkpoints?: Array | undefined; -}; - -/** @internal */ -export const CompletionDetailedJobOut$outboundSchema: z.ZodType< - CompletionDetailedJobOut$Outbound, - z.ZodTypeDef, - CompletionDetailedJobOut -> = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: CompletionDetailedJobOutStatus$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: CompletionDetailedJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$outboundSchema)) - .optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$outboundSchema).optional(), - jobType: CompletionDetailedJobOutJobType$outboundSchema.default("completion"), - hyperparameters: CompletionTrainingParameters$outboundSchema, - repositories: z.array(GithubRepositoryOut$outboundSchema).optional(), - events: z.array(EventOut$outboundSchema).optional(), - checkpoints: z.array(CheckpointOut$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionDetailedJobOut$ { - /** @deprecated use `CompletionDetailedJobOut$inboundSchema` instead. */ - export const inboundSchema = CompletionDetailedJobOut$inboundSchema; - /** @deprecated use `CompletionDetailedJobOut$outboundSchema` instead. */ - export const outboundSchema = CompletionDetailedJobOut$outboundSchema; - /** @deprecated use `CompletionDetailedJobOut$Outbound` instead. */ - export type Outbound = CompletionDetailedJobOut$Outbound; -} - -export function completionDetailedJobOutToJSON( - completionDetailedJobOut: CompletionDetailedJobOut, -): string { - return JSON.stringify( - CompletionDetailedJobOut$outboundSchema.parse(completionDetailedJobOut), - ); -} - -export function completionDetailedJobOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionDetailedJobOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionDetailedJobOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionevent.ts b/examples/sdks/mistral-typescript/src/models/components/completionevent.ts deleted file mode 100644 index b377901b7..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionevent.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionChunk, - CompletionChunk$inboundSchema, - CompletionChunk$Outbound, - CompletionChunk$outboundSchema, -} from "./completionchunk.js"; - -export type CompletionEvent = { - data: CompletionChunk; -}; - -/** @internal */ -export const CompletionEvent$inboundSchema: z.ZodType< - CompletionEvent, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}`, - }); - return z.NEVER; - } - }).pipe(CompletionChunk$inboundSchema), -}); - -/** @internal */ -export type CompletionEvent$Outbound = { - data: CompletionChunk$Outbound; -}; - -/** @internal */ -export const CompletionEvent$outboundSchema: z.ZodType< - CompletionEvent$Outbound, - z.ZodTypeDef, - CompletionEvent -> = z.object({ - data: CompletionChunk$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionEvent$ { - /** @deprecated use `CompletionEvent$inboundSchema` instead. */ - export const inboundSchema = CompletionEvent$inboundSchema; - /** @deprecated use `CompletionEvent$outboundSchema` instead. */ - export const outboundSchema = CompletionEvent$outboundSchema; - /** @deprecated use `CompletionEvent$Outbound` instead. */ - export type Outbound = CompletionEvent$Outbound; -} - -export function completionEventToJSON( - completionEvent: CompletionEvent, -): string { - return JSON.stringify(CompletionEvent$outboundSchema.parse(completionEvent)); -} - -export function completionEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionftmodelout.ts b/examples/sdks/mistral-typescript/src/models/components/completionftmodelout.ts deleted file mode 100644 index 378315a88..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionftmodelout.ts +++ /dev/null @@ -1,198 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FTModelCapabilitiesOut, - FTModelCapabilitiesOut$inboundSchema, - FTModelCapabilitiesOut$Outbound, - FTModelCapabilitiesOut$outboundSchema, -} from "./ftmodelcapabilitiesout.js"; - -export const CompletionFTModelOutObject = { - Model: "model", -} as const; -export type CompletionFTModelOutObject = ClosedEnum< - typeof CompletionFTModelOutObject ->; - -export const ModelType = { - Completion: "completion", -} as const; -export type ModelType = ClosedEnum; - -export type CompletionFTModelOut = { - id: string; - object?: CompletionFTModelOutObject | undefined; - created: number; - ownedBy: string; - workspaceId: string; - root: string; - rootVersion: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - job: string; - modelType?: ModelType | undefined; -}; - -/** @internal */ -export const CompletionFTModelOutObject$inboundSchema: z.ZodNativeEnum< - typeof CompletionFTModelOutObject -> = z.nativeEnum(CompletionFTModelOutObject); - -/** @internal */ -export const CompletionFTModelOutObject$outboundSchema: z.ZodNativeEnum< - typeof CompletionFTModelOutObject -> = CompletionFTModelOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionFTModelOutObject$ { - /** @deprecated use `CompletionFTModelOutObject$inboundSchema` instead. */ - export const inboundSchema = CompletionFTModelOutObject$inboundSchema; - /** @deprecated use `CompletionFTModelOutObject$outboundSchema` instead. */ - export const outboundSchema = CompletionFTModelOutObject$outboundSchema; -} - -/** @internal */ -export const ModelType$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(ModelType); - -/** @internal */ -export const ModelType$outboundSchema: z.ZodNativeEnum = - ModelType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelType$ { - /** @deprecated use `ModelType$inboundSchema` instead. */ - export const inboundSchema = ModelType$inboundSchema; - /** @deprecated use `ModelType$outboundSchema` instead. */ - export const outboundSchema = ModelType$outboundSchema; -} - -/** @internal */ -export const CompletionFTModelOut$inboundSchema: z.ZodType< - CompletionFTModelOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: CompletionFTModelOutObject$inboundSchema.default("model"), - created: z.number().int(), - owned_by: z.string(), - workspace_id: z.string(), - root: z.string(), - root_version: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: FTModelCapabilitiesOut$inboundSchema, - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - model_type: ModelType$inboundSchema.default("completion"), -}).transform((v) => { - return remap$(v, { - "owned_by": "ownedBy", - "workspace_id": "workspaceId", - "root_version": "rootVersion", - "max_context_length": "maxContextLength", - "model_type": "modelType", - }); -}); - -/** @internal */ -export type CompletionFTModelOut$Outbound = { - id: string; - object: string; - created: number; - owned_by: string; - workspace_id: string; - root: string; - root_version: string; - archived: boolean; - name?: string | null | undefined; - description?: string | null | undefined; - capabilities: FTModelCapabilitiesOut$Outbound; - max_context_length: number; - aliases?: Array | undefined; - job: string; - model_type: string; -}; - -/** @internal */ -export const CompletionFTModelOut$outboundSchema: z.ZodType< - CompletionFTModelOut$Outbound, - z.ZodTypeDef, - CompletionFTModelOut -> = z.object({ - id: z.string(), - object: CompletionFTModelOutObject$outboundSchema.default("model"), - created: z.number().int(), - ownedBy: z.string(), - workspaceId: z.string(), - root: z.string(), - rootVersion: z.string(), - archived: z.boolean(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - capabilities: FTModelCapabilitiesOut$outboundSchema, - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - job: z.string(), - modelType: ModelType$outboundSchema.default("completion"), -}).transform((v) => { - return remap$(v, { - ownedBy: "owned_by", - workspaceId: "workspace_id", - rootVersion: "root_version", - maxContextLength: "max_context_length", - modelType: "model_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionFTModelOut$ { - /** @deprecated use `CompletionFTModelOut$inboundSchema` instead. */ - export const inboundSchema = CompletionFTModelOut$inboundSchema; - /** @deprecated use `CompletionFTModelOut$outboundSchema` instead. */ - export const outboundSchema = CompletionFTModelOut$outboundSchema; - /** @deprecated use `CompletionFTModelOut$Outbound` instead. */ - export type Outbound = CompletionFTModelOut$Outbound; -} - -export function completionFTModelOutToJSON( - completionFTModelOut: CompletionFTModelOut, -): string { - return JSON.stringify( - CompletionFTModelOut$outboundSchema.parse(completionFTModelOut), - ); -} - -export function completionFTModelOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionFTModelOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionFTModelOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionjobout.ts b/examples/sdks/mistral-typescript/src/models/components/completionjobout.ts deleted file mode 100644 index 69a87185a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionjobout.ts +++ /dev/null @@ -1,412 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionTrainingParameters, - CompletionTrainingParameters$inboundSchema, - CompletionTrainingParameters$Outbound, - CompletionTrainingParameters$outboundSchema, -} from "./completiontrainingparameters.js"; -import { - GithubRepositoryOut, - GithubRepositoryOut$inboundSchema, - GithubRepositoryOut$Outbound, - GithubRepositoryOut$outboundSchema, -} from "./githubrepositoryout.js"; -import { - JobMetadataOut, - JobMetadataOut$inboundSchema, - JobMetadataOut$Outbound, - JobMetadataOut$outboundSchema, -} from "./jobmetadataout.js"; -import { - WandbIntegrationOut, - WandbIntegrationOut$inboundSchema, - WandbIntegrationOut$Outbound, - WandbIntegrationOut$outboundSchema, -} from "./wandbintegrationout.js"; - -/** - * The current status of the fine-tuning job. - */ -export const Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED", -} as const; -/** - * The current status of the fine-tuning job. - */ -export type Status = ClosedEnum; - -/** - * The object type of the fine-tuning job. - */ -export const CompletionJobOutObject = { - Job: "job", -} as const; -/** - * The object type of the fine-tuning job. - */ -export type CompletionJobOutObject = ClosedEnum; - -export type Integrations = WandbIntegrationOut; - -/** - * The type of job (`FT` for fine-tuning). - */ -export const JobType = { - Completion: "completion", -} as const; -/** - * The type of job (`FT` for fine-tuning). - */ -export type JobType = ClosedEnum; - -export type Repositories = GithubRepositoryOut; - -export type CompletionJobOut = { - /** - * The ID of the job. - */ - id: string; - autoStart: boolean; - /** - * The name of the model to fine-tune. - */ - model: string; - /** - * The current status of the fine-tuning job. - */ - status: Status; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was created. - */ - createdAt: number; - /** - * The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - */ - modifiedAt: number; - /** - * A list containing the IDs of uploaded files that contain training data. - */ - trainingFiles: Array; - /** - * A list containing the IDs of uploaded files that contain validation data. - */ - validationFiles?: Array | null | undefined; - /** - * The object type of the fine-tuning job. - */ - object?: CompletionJobOutObject | undefined; - /** - * The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - */ - fineTunedModel?: string | null | undefined; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * A list of integrations enabled for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * Total number of tokens trained. - */ - trainedTokens?: number | null | undefined; - metadata?: JobMetadataOut | null | undefined; - /** - * The type of job (`FT` for fine-tuning). - */ - jobType?: JobType | undefined; - hyperparameters: CompletionTrainingParameters; - repositories?: Array | undefined; -}; - -/** @internal */ -export const Status$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(Status); - -/** @internal */ -export const Status$outboundSchema: z.ZodNativeEnum = - Status$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Status$ { - /** @deprecated use `Status$inboundSchema` instead. */ - export const inboundSchema = Status$inboundSchema; - /** @deprecated use `Status$outboundSchema` instead. */ - export const outboundSchema = Status$outboundSchema; -} - -/** @internal */ -export const CompletionJobOutObject$inboundSchema: z.ZodNativeEnum< - typeof CompletionJobOutObject -> = z.nativeEnum(CompletionJobOutObject); - -/** @internal */ -export const CompletionJobOutObject$outboundSchema: z.ZodNativeEnum< - typeof CompletionJobOutObject -> = CompletionJobOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionJobOutObject$ { - /** @deprecated use `CompletionJobOutObject$inboundSchema` instead. */ - export const inboundSchema = CompletionJobOutObject$inboundSchema; - /** @deprecated use `CompletionJobOutObject$outboundSchema` instead. */ - export const outboundSchema = CompletionJobOutObject$outboundSchema; -} - -/** @internal */ -export const Integrations$inboundSchema: z.ZodType< - Integrations, - z.ZodTypeDef, - unknown -> = WandbIntegrationOut$inboundSchema; - -/** @internal */ -export type Integrations$Outbound = WandbIntegrationOut$Outbound; - -/** @internal */ -export const Integrations$outboundSchema: z.ZodType< - Integrations$Outbound, - z.ZodTypeDef, - Integrations -> = WandbIntegrationOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Integrations$ { - /** @deprecated use `Integrations$inboundSchema` instead. */ - export const inboundSchema = Integrations$inboundSchema; - /** @deprecated use `Integrations$outboundSchema` instead. */ - export const outboundSchema = Integrations$outboundSchema; - /** @deprecated use `Integrations$Outbound` instead. */ - export type Outbound = Integrations$Outbound; -} - -export function integrationsToJSON(integrations: Integrations): string { - return JSON.stringify(Integrations$outboundSchema.parse(integrations)); -} - -export function integrationsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Integrations$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Integrations' from JSON`, - ); -} - -/** @internal */ -export const JobType$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(JobType); - -/** @internal */ -export const JobType$outboundSchema: z.ZodNativeEnum = - JobType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobType$ { - /** @deprecated use `JobType$inboundSchema` instead. */ - export const inboundSchema = JobType$inboundSchema; - /** @deprecated use `JobType$outboundSchema` instead. */ - export const outboundSchema = JobType$outboundSchema; -} - -/** @internal */ -export const Repositories$inboundSchema: z.ZodType< - Repositories, - z.ZodTypeDef, - unknown -> = GithubRepositoryOut$inboundSchema; - -/** @internal */ -export type Repositories$Outbound = GithubRepositoryOut$Outbound; - -/** @internal */ -export const Repositories$outboundSchema: z.ZodType< - Repositories$Outbound, - z.ZodTypeDef, - Repositories -> = GithubRepositoryOut$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Repositories$ { - /** @deprecated use `Repositories$inboundSchema` instead. */ - export const inboundSchema = Repositories$inboundSchema; - /** @deprecated use `Repositories$outboundSchema` instead. */ - export const outboundSchema = Repositories$outboundSchema; - /** @deprecated use `Repositories$Outbound` instead. */ - export type Outbound = Repositories$Outbound; -} - -export function repositoriesToJSON(repositories: Repositories): string { - return JSON.stringify(Repositories$outboundSchema.parse(repositories)); -} - -export function repositoriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Repositories$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Repositories' from JSON`, - ); -} - -/** @internal */ -export const CompletionJobOut$inboundSchema: z.ZodType< - CompletionJobOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - auto_start: z.boolean(), - model: z.string(), - status: Status$inboundSchema, - created_at: z.number().int(), - modified_at: z.number().int(), - training_files: z.array(z.string()), - validation_files: z.nullable(z.array(z.string())).optional(), - object: CompletionJobOutObject$inboundSchema.default("job"), - fine_tuned_model: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$inboundSchema)) - .optional(), - trained_tokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$inboundSchema).optional(), - job_type: JobType$inboundSchema.default("completion"), - hyperparameters: CompletionTrainingParameters$inboundSchema, - repositories: z.array(GithubRepositoryOut$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "auto_start": "autoStart", - "created_at": "createdAt", - "modified_at": "modifiedAt", - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "fine_tuned_model": "fineTunedModel", - "trained_tokens": "trainedTokens", - "job_type": "jobType", - }); -}); - -/** @internal */ -export type CompletionJobOut$Outbound = { - id: string; - auto_start: boolean; - model: string; - status: string; - created_at: number; - modified_at: number; - training_files: Array; - validation_files?: Array | null | undefined; - object: string; - fine_tuned_model?: string | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - trained_tokens?: number | null | undefined; - metadata?: JobMetadataOut$Outbound | null | undefined; - job_type: string; - hyperparameters: CompletionTrainingParameters$Outbound; - repositories?: Array | undefined; -}; - -/** @internal */ -export const CompletionJobOut$outboundSchema: z.ZodType< - CompletionJobOut$Outbound, - z.ZodTypeDef, - CompletionJobOut -> = z.object({ - id: z.string(), - autoStart: z.boolean(), - model: z.string(), - status: Status$outboundSchema, - createdAt: z.number().int(), - modifiedAt: z.number().int(), - trainingFiles: z.array(z.string()), - validationFiles: z.nullable(z.array(z.string())).optional(), - object: CompletionJobOutObject$outboundSchema.default("job"), - fineTunedModel: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegrationOut$outboundSchema)) - .optional(), - trainedTokens: z.nullable(z.number().int()).optional(), - metadata: z.nullable(JobMetadataOut$outboundSchema).optional(), - jobType: JobType$outboundSchema.default("completion"), - hyperparameters: CompletionTrainingParameters$outboundSchema, - repositories: z.array(GithubRepositoryOut$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - autoStart: "auto_start", - createdAt: "created_at", - modifiedAt: "modified_at", - trainingFiles: "training_files", - validationFiles: "validation_files", - fineTunedModel: "fine_tuned_model", - trainedTokens: "trained_tokens", - jobType: "job_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionJobOut$ { - /** @deprecated use `CompletionJobOut$inboundSchema` instead. */ - export const inboundSchema = CompletionJobOut$inboundSchema; - /** @deprecated use `CompletionJobOut$outboundSchema` instead. */ - export const outboundSchema = CompletionJobOut$outboundSchema; - /** @deprecated use `CompletionJobOut$Outbound` instead. */ - export type Outbound = CompletionJobOut$Outbound; -} - -export function completionJobOutToJSON( - completionJobOut: CompletionJobOut, -): string { - return JSON.stringify( - CompletionJobOut$outboundSchema.parse(completionJobOut), - ); -} - -export function completionJobOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionJobOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionJobOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completionresponsestreamchoice.ts b/examples/sdks/mistral-typescript/src/models/components/completionresponsestreamchoice.ts deleted file mode 100644 index a14d02cde..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completionresponsestreamchoice.ts +++ /dev/null @@ -1,143 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DeltaMessage, - DeltaMessage$inboundSchema, - DeltaMessage$Outbound, - DeltaMessage$outboundSchema, -} from "./deltamessage.js"; - -export const CompletionResponseStreamChoiceFinishReason = { - Stop: "stop", - Length: "length", - Error: "error", - ToolCalls: "tool_calls", -} as const; -export type CompletionResponseStreamChoiceFinishReason = OpenEnum< - typeof CompletionResponseStreamChoiceFinishReason ->; - -export type CompletionResponseStreamChoice = { - index: number; - delta: DeltaMessage; - finishReason: CompletionResponseStreamChoiceFinishReason | null; -}; - -/** @internal */ -export const CompletionResponseStreamChoiceFinishReason$inboundSchema: - z.ZodType = - z - .union([ - z.nativeEnum(CompletionResponseStreamChoiceFinishReason), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const CompletionResponseStreamChoiceFinishReason$outboundSchema: - z.ZodType< - CompletionResponseStreamChoiceFinishReason, - z.ZodTypeDef, - CompletionResponseStreamChoiceFinishReason - > = z.union([ - z.nativeEnum(CompletionResponseStreamChoiceFinishReason), - z.string().and(z.custom>()), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionResponseStreamChoiceFinishReason$ { - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$inboundSchema` instead. */ - export const inboundSchema = - CompletionResponseStreamChoiceFinishReason$inboundSchema; - /** @deprecated use `CompletionResponseStreamChoiceFinishReason$outboundSchema` instead. */ - export const outboundSchema = - CompletionResponseStreamChoiceFinishReason$outboundSchema; -} - -/** @internal */ -export const CompletionResponseStreamChoice$inboundSchema: z.ZodType< - CompletionResponseStreamChoice, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$inboundSchema, - finish_reason: z.nullable( - CompletionResponseStreamChoiceFinishReason$inboundSchema, - ), -}).transform((v) => { - return remap$(v, { - "finish_reason": "finishReason", - }); -}); - -/** @internal */ -export type CompletionResponseStreamChoice$Outbound = { - index: number; - delta: DeltaMessage$Outbound; - finish_reason: string | null; -}; - -/** @internal */ -export const CompletionResponseStreamChoice$outboundSchema: z.ZodType< - CompletionResponseStreamChoice$Outbound, - z.ZodTypeDef, - CompletionResponseStreamChoice -> = z.object({ - index: z.number().int(), - delta: DeltaMessage$outboundSchema, - finishReason: z.nullable( - CompletionResponseStreamChoiceFinishReason$outboundSchema, - ), -}).transform((v) => { - return remap$(v, { - finishReason: "finish_reason", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionResponseStreamChoice$ { - /** @deprecated use `CompletionResponseStreamChoice$inboundSchema` instead. */ - export const inboundSchema = CompletionResponseStreamChoice$inboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$outboundSchema` instead. */ - export const outboundSchema = CompletionResponseStreamChoice$outboundSchema; - /** @deprecated use `CompletionResponseStreamChoice$Outbound` instead. */ - export type Outbound = CompletionResponseStreamChoice$Outbound; -} - -export function completionResponseStreamChoiceToJSON( - completionResponseStreamChoice: CompletionResponseStreamChoice, -): string { - return JSON.stringify( - CompletionResponseStreamChoice$outboundSchema.parse( - completionResponseStreamChoice, - ), - ); -} - -export function completionResponseStreamChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionResponseStreamChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionResponseStreamChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completiontrainingparameters.ts b/examples/sdks/mistral-typescript/src/models/components/completiontrainingparameters.ts deleted file mode 100644 index 625d54a0b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completiontrainingparameters.ts +++ /dev/null @@ -1,111 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type CompletionTrainingParameters = { - trainingSteps?: number | null | undefined; - learningRate?: number | undefined; - weightDecay?: number | null | undefined; - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -/** @internal */ -export const CompletionTrainingParameters$inboundSchema: z.ZodType< - CompletionTrainingParameters, - z.ZodTypeDef, - unknown -> = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(0.0001), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio", - }); -}); - -/** @internal */ -export type CompletionTrainingParameters$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -export const CompletionTrainingParameters$outboundSchema: z.ZodType< - CompletionTrainingParameters$Outbound, - z.ZodTypeDef, - CompletionTrainingParameters -> = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(0.0001), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionTrainingParameters$ { - /** @deprecated use `CompletionTrainingParameters$inboundSchema` instead. */ - export const inboundSchema = CompletionTrainingParameters$inboundSchema; - /** @deprecated use `CompletionTrainingParameters$outboundSchema` instead. */ - export const outboundSchema = CompletionTrainingParameters$outboundSchema; - /** @deprecated use `CompletionTrainingParameters$Outbound` instead. */ - export type Outbound = CompletionTrainingParameters$Outbound; -} - -export function completionTrainingParametersToJSON( - completionTrainingParameters: CompletionTrainingParameters, -): string { - return JSON.stringify( - CompletionTrainingParameters$outboundSchema.parse( - completionTrainingParameters, - ), - ); -} - -export function completionTrainingParametersFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionTrainingParameters$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionTrainingParameters' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/completiontrainingparametersin.ts b/examples/sdks/mistral-typescript/src/models/components/completiontrainingparametersin.ts deleted file mode 100644 index 6bb26193a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/completiontrainingparametersin.ts +++ /dev/null @@ -1,126 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * The fine-tuning hyperparameter settings used in a fine-tune job. - */ -export type CompletionTrainingParametersIn = { - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - /** - * A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - */ - learningRate?: number | undefined; - /** - * (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - */ - weightDecay?: number | null | undefined; - /** - * (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - */ - warmupFraction?: number | null | undefined; - epochs?: number | null | undefined; - seqLen?: number | null | undefined; - fimRatio?: number | null | undefined; -}; - -/** @internal */ -export const CompletionTrainingParametersIn$inboundSchema: z.ZodType< - CompletionTrainingParametersIn, - z.ZodTypeDef, - unknown -> = z.object({ - training_steps: z.nullable(z.number().int()).optional(), - learning_rate: z.number().default(0.0001), - weight_decay: z.nullable(z.number()).optional(), - warmup_fraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seq_len: z.nullable(z.number().int()).optional(), - fim_ratio: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - "training_steps": "trainingSteps", - "learning_rate": "learningRate", - "weight_decay": "weightDecay", - "warmup_fraction": "warmupFraction", - "seq_len": "seqLen", - "fim_ratio": "fimRatio", - }); -}); - -/** @internal */ -export type CompletionTrainingParametersIn$Outbound = { - training_steps?: number | null | undefined; - learning_rate: number; - weight_decay?: number | null | undefined; - warmup_fraction?: number | null | undefined; - epochs?: number | null | undefined; - seq_len?: number | null | undefined; - fim_ratio?: number | null | undefined; -}; - -/** @internal */ -export const CompletionTrainingParametersIn$outboundSchema: z.ZodType< - CompletionTrainingParametersIn$Outbound, - z.ZodTypeDef, - CompletionTrainingParametersIn -> = z.object({ - trainingSteps: z.nullable(z.number().int()).optional(), - learningRate: z.number().default(0.0001), - weightDecay: z.nullable(z.number()).optional(), - warmupFraction: z.nullable(z.number()).optional(), - epochs: z.nullable(z.number()).optional(), - seqLen: z.nullable(z.number().int()).optional(), - fimRatio: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - trainingSteps: "training_steps", - learningRate: "learning_rate", - weightDecay: "weight_decay", - warmupFraction: "warmup_fraction", - seqLen: "seq_len", - fimRatio: "fim_ratio", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CompletionTrainingParametersIn$ { - /** @deprecated use `CompletionTrainingParametersIn$inboundSchema` instead. */ - export const inboundSchema = CompletionTrainingParametersIn$inboundSchema; - /** @deprecated use `CompletionTrainingParametersIn$outboundSchema` instead. */ - export const outboundSchema = CompletionTrainingParametersIn$outboundSchema; - /** @deprecated use `CompletionTrainingParametersIn$Outbound` instead. */ - export type Outbound = CompletionTrainingParametersIn$Outbound; -} - -export function completionTrainingParametersInToJSON( - completionTrainingParametersIn: CompletionTrainingParametersIn, -): string { - return JSON.stringify( - CompletionTrainingParametersIn$outboundSchema.parse( - completionTrainingParametersIn, - ), - ); -} - -export function completionTrainingParametersInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => CompletionTrainingParametersIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'CompletionTrainingParametersIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/contentchunk.ts b/examples/sdks/mistral-typescript/src/models/components/contentchunk.ts deleted file mode 100644 index 63478f1eb..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/contentchunk.ts +++ /dev/null @@ -1,174 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AudioChunk, - AudioChunk$inboundSchema, - AudioChunk$Outbound, - AudioChunk$outboundSchema, -} from "./audiochunk.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, -} from "./filechunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - ReferenceChunk, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, -} from "./referencechunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; -import { - ThinkChunk, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, -} from "./thinkchunk.js"; - -export type ContentChunk = - | (ImageURLChunk & { type: "image_url" }) - | (DocumentURLChunk & { type: "document_url" }) - | (TextChunk & { type: "text" }) - | (ReferenceChunk & { type: "reference" }) - | (FileChunk & { type: "file" }) - | (ThinkChunk & { type: "thinking" }) - | (AudioChunk & { type: "input_audio" }); - -/** @internal */ -export const ContentChunk$inboundSchema: z.ZodType< - ContentChunk, - z.ZodTypeDef, - unknown -> = z.union([ - ImageURLChunk$inboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - DocumentURLChunk$inboundSchema.and( - z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$inboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$inboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), - FileChunk$inboundSchema.and( - z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type })), - ), - ThinkChunk$inboundSchema.and( - z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type, - })), - ), - AudioChunk$inboundSchema.and( - z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type ContentChunk$Outbound = - | (ImageURLChunk$Outbound & { type: "image_url" }) - | (DocumentURLChunk$Outbound & { type: "document_url" }) - | (TextChunk$Outbound & { type: "text" }) - | (ReferenceChunk$Outbound & { type: "reference" }) - | (FileChunk$Outbound & { type: "file" }) - | (ThinkChunk$Outbound & { type: "thinking" }) - | (AudioChunk$Outbound & { type: "input_audio" }); - -/** @internal */ -export const ContentChunk$outboundSchema: z.ZodType< - ContentChunk$Outbound, - z.ZodTypeDef, - ContentChunk -> = z.union([ - ImageURLChunk$outboundSchema.and( - z.object({ type: z.literal("image_url") }).transform((v) => ({ - type: v.type, - })), - ), - DocumentURLChunk$outboundSchema.and( - z.object({ type: z.literal("document_url") }).transform((v) => ({ - type: v.type, - })), - ), - TextChunk$outboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ReferenceChunk$outboundSchema.and( - z.object({ type: z.literal("reference") }).transform((v) => ({ - type: v.type, - })), - ), - FileChunk$outboundSchema.and( - z.object({ type: z.literal("file") }).transform((v) => ({ type: v.type })), - ), - ThinkChunk$outboundSchema.and( - z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type, - })), - ), - AudioChunk$outboundSchema.and( - z.object({ type: z.literal("input_audio") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ContentChunk$ { - /** @deprecated use `ContentChunk$inboundSchema` instead. */ - export const inboundSchema = ContentChunk$inboundSchema; - /** @deprecated use `ContentChunk$outboundSchema` instead. */ - export const outboundSchema = ContentChunk$outboundSchema; - /** @deprecated use `ContentChunk$Outbound` instead. */ - export type Outbound = ContentChunk$Outbound; -} - -export function contentChunkToJSON(contentChunk: ContentChunk): string { - return JSON.stringify(ContentChunk$outboundSchema.parse(contentChunk)); -} - -export function contentChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ContentChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ContentChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationappendrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationappendrequest.ts deleted file mode 100644 index 2fd7b43a2..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationappendrequest.ts +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; - -export const ConversationAppendRequestHandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type ConversationAppendRequestHandoffExecution = ClosedEnum< - typeof ConversationAppendRequestHandoffExecution ->; - -export type ConversationAppendRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationAppendRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -/** @internal */ -export const ConversationAppendRequestHandoffExecution$inboundSchema: - z.ZodNativeEnum = z - .nativeEnum(ConversationAppendRequestHandoffExecution); - -/** @internal */ -export const ConversationAppendRequestHandoffExecution$outboundSchema: - z.ZodNativeEnum = - ConversationAppendRequestHandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationAppendRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendRequestHandoffExecution$inboundSchema` instead. */ - export const inboundSchema = - ConversationAppendRequestHandoffExecution$inboundSchema; - /** @deprecated use `ConversationAppendRequestHandoffExecution$outboundSchema` instead. */ - export const outboundSchema = - ConversationAppendRequestHandoffExecution$outboundSchema; -} - -/** @internal */ -export const ConversationAppendRequest$inboundSchema: z.ZodType< - ConversationAppendRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: ConversationAppendRequestHandoffExecution$inboundSchema - .default("server"), - completion_args: CompletionArgs$inboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - }); -}); - -/** @internal */ -export type ConversationAppendRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -export const ConversationAppendRequest$outboundSchema: z.ZodType< - ConversationAppendRequest$Outbound, - z.ZodTypeDef, - ConversationAppendRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: ConversationAppendRequestHandoffExecution$outboundSchema - .default("server"), - completionArgs: CompletionArgs$outboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationAppendRequest$ { - /** @deprecated use `ConversationAppendRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationAppendRequest$inboundSchema; - /** @deprecated use `ConversationAppendRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationAppendRequest$outboundSchema; - /** @deprecated use `ConversationAppendRequest$Outbound` instead. */ - export type Outbound = ConversationAppendRequest$Outbound; -} - -export function conversationAppendRequestToJSON( - conversationAppendRequest: ConversationAppendRequest, -): string { - return JSON.stringify( - ConversationAppendRequest$outboundSchema.parse(conversationAppendRequest), - ); -} - -export function conversationAppendRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationAppendRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationAppendRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationappendstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationappendstreamrequest.ts deleted file mode 100644 index edd054e21..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationappendstreamrequest.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; - -export const ConversationAppendStreamRequestHandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type ConversationAppendStreamRequestHandoffExecution = ClosedEnum< - typeof ConversationAppendStreamRequestHandoffExecution ->; - -export type ConversationAppendStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: - | ConversationAppendStreamRequestHandoffExecution - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; -}; - -/** @internal */ -export const ConversationAppendStreamRequestHandoffExecution$inboundSchema: - z.ZodNativeEnum = z - .nativeEnum(ConversationAppendStreamRequestHandoffExecution); - -/** @internal */ -export const ConversationAppendStreamRequestHandoffExecution$outboundSchema: - z.ZodNativeEnum = - ConversationAppendStreamRequestHandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationAppendStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$inboundSchema` instead. */ - export const inboundSchema = - ConversationAppendStreamRequestHandoffExecution$inboundSchema; - /** @deprecated use `ConversationAppendStreamRequestHandoffExecution$outboundSchema` instead. */ - export const outboundSchema = - ConversationAppendStreamRequestHandoffExecution$outboundSchema; -} - -/** @internal */ -export const ConversationAppendStreamRequest$inboundSchema: z.ZodType< - ConversationAppendStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: - ConversationAppendStreamRequestHandoffExecution$inboundSchema.default( - "server", - ), - completion_args: CompletionArgs$inboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - }); -}); - -/** @internal */ -export type ConversationAppendStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; -}; - -/** @internal */ -export const ConversationAppendStreamRequest$outboundSchema: z.ZodType< - ConversationAppendStreamRequest$Outbound, - z.ZodTypeDef, - ConversationAppendStreamRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: - ConversationAppendStreamRequestHandoffExecution$outboundSchema.default( - "server", - ), - completionArgs: CompletionArgs$outboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationAppendStreamRequest$ { - /** @deprecated use `ConversationAppendStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationAppendStreamRequest$inboundSchema; - /** @deprecated use `ConversationAppendStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationAppendStreamRequest$outboundSchema; - /** @deprecated use `ConversationAppendStreamRequest$Outbound` instead. */ - export type Outbound = ConversationAppendStreamRequest$Outbound; -} - -export function conversationAppendStreamRequestToJSON( - conversationAppendStreamRequest: ConversationAppendStreamRequest, -): string { - return JSON.stringify( - ConversationAppendStreamRequest$outboundSchema.parse( - conversationAppendStreamRequest, - ), - ); -} - -export function conversationAppendStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationAppendStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationAppendStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationevents.ts b/examples/sdks/mistral-typescript/src/models/components/conversationevents.ts deleted file mode 100644 index 68509b6c6..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationevents.ts +++ /dev/null @@ -1,445 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AgentHandoffDoneEvent, - AgentHandoffDoneEvent$inboundSchema, - AgentHandoffDoneEvent$Outbound, - AgentHandoffDoneEvent$outboundSchema, -} from "./agenthandoffdoneevent.js"; -import { - AgentHandoffStartedEvent, - AgentHandoffStartedEvent$inboundSchema, - AgentHandoffStartedEvent$Outbound, - AgentHandoffStartedEvent$outboundSchema, -} from "./agenthandoffstartedevent.js"; -import { - FunctionCallEvent, - FunctionCallEvent$inboundSchema, - FunctionCallEvent$Outbound, - FunctionCallEvent$outboundSchema, -} from "./functioncallevent.js"; -import { - MessageOutputEvent, - MessageOutputEvent$inboundSchema, - MessageOutputEvent$Outbound, - MessageOutputEvent$outboundSchema, -} from "./messageoutputevent.js"; -import { - ResponseDoneEvent, - ResponseDoneEvent$inboundSchema, - ResponseDoneEvent$Outbound, - ResponseDoneEvent$outboundSchema, -} from "./responsedoneevent.js"; -import { - ResponseErrorEvent, - ResponseErrorEvent$inboundSchema, - ResponseErrorEvent$Outbound, - ResponseErrorEvent$outboundSchema, -} from "./responseerrorevent.js"; -import { - ResponseStartedEvent, - ResponseStartedEvent$inboundSchema, - ResponseStartedEvent$Outbound, - ResponseStartedEvent$outboundSchema, -} from "./responsestartedevent.js"; -import { - SSETypes, - SSETypes$inboundSchema, - SSETypes$outboundSchema, -} from "./ssetypes.js"; -import { - ToolExecutionDeltaEvent, - ToolExecutionDeltaEvent$inboundSchema, - ToolExecutionDeltaEvent$Outbound, - ToolExecutionDeltaEvent$outboundSchema, -} from "./toolexecutiondeltaevent.js"; -import { - ToolExecutionDoneEvent, - ToolExecutionDoneEvent$inboundSchema, - ToolExecutionDoneEvent$Outbound, - ToolExecutionDoneEvent$outboundSchema, -} from "./toolexecutiondoneevent.js"; -import { - ToolExecutionStartedEvent, - ToolExecutionStartedEvent$inboundSchema, - ToolExecutionStartedEvent$Outbound, - ToolExecutionStartedEvent$outboundSchema, -} from "./toolexecutionstartedevent.js"; - -export type ConversationEventsData = - | (FunctionCallEvent & { type: "function.call.delta" }) - | (AgentHandoffDoneEvent & { type: "agent.handoff.done" }) - | (AgentHandoffStartedEvent & { type: "agent.handoff.started" }) - | (ToolExecutionDeltaEvent & { type: "tool.execution.delta" }) - | (ToolExecutionStartedEvent & { type: "tool.execution.started" }) - | (ResponseErrorEvent & { type: "conversation.response.error" }) - | (MessageOutputEvent & { type: "message.output.delta" }) - | (ToolExecutionDoneEvent & { type: "tool.execution.done" }) - | (ResponseDoneEvent & { type: "conversation.response.done" }) - | (ResponseStartedEvent & { type: "conversation.response.started" }); - -export type ConversationEvents = { - /** - * Server side events sent when streaming a conversation response. - */ - event: SSETypes; - data: - | (FunctionCallEvent & { type: "function.call.delta" }) - | (AgentHandoffDoneEvent & { type: "agent.handoff.done" }) - | (AgentHandoffStartedEvent & { type: "agent.handoff.started" }) - | (ToolExecutionDeltaEvent & { type: "tool.execution.delta" }) - | (ToolExecutionStartedEvent & { type: "tool.execution.started" }) - | (ResponseErrorEvent & { type: "conversation.response.error" }) - | (MessageOutputEvent & { type: "message.output.delta" }) - | (ToolExecutionDoneEvent & { type: "tool.execution.done" }) - | (ResponseDoneEvent & { type: "conversation.response.done" }) - | (ResponseStartedEvent & { type: "conversation.response.started" }); -}; - -/** @internal */ -export const ConversationEventsData$inboundSchema: z.ZodType< - ConversationEventsData, - z.ZodTypeDef, - unknown -> = z.union([ - FunctionCallEvent$inboundSchema.and( - z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffDoneEvent$inboundSchema.and( - z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffStartedEvent$inboundSchema.and( - z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDeltaEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionStartedEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseErrorEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.error") }).transform(( - v, - ) => ({ type: v.type })), - ), - MessageOutputEvent$inboundSchema.and( - z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDoneEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseDoneEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.done") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseStartedEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.started") }).transform(( - v, - ) => ({ type: v.type })), - ), -]); - -/** @internal */ -export type ConversationEventsData$Outbound = - | (FunctionCallEvent$Outbound & { type: "function.call.delta" }) - | (AgentHandoffDoneEvent$Outbound & { type: "agent.handoff.done" }) - | (AgentHandoffStartedEvent$Outbound & { type: "agent.handoff.started" }) - | (ToolExecutionDeltaEvent$Outbound & { type: "tool.execution.delta" }) - | (ToolExecutionStartedEvent$Outbound & { type: "tool.execution.started" }) - | (ResponseErrorEvent$Outbound & { type: "conversation.response.error" }) - | (MessageOutputEvent$Outbound & { type: "message.output.delta" }) - | (ToolExecutionDoneEvent$Outbound & { type: "tool.execution.done" }) - | (ResponseDoneEvent$Outbound & { type: "conversation.response.done" }) - | (ResponseStartedEvent$Outbound & { type: "conversation.response.started" }); - -/** @internal */ -export const ConversationEventsData$outboundSchema: z.ZodType< - ConversationEventsData$Outbound, - z.ZodTypeDef, - ConversationEventsData -> = z.union([ - FunctionCallEvent$outboundSchema.and( - z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffDoneEvent$outboundSchema.and( - z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffStartedEvent$outboundSchema.and( - z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDeltaEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionStartedEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.started") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseErrorEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.error") }).transform(( - v, - ) => ({ type: v.type })), - ), - MessageOutputEvent$outboundSchema.and( - z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDoneEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseDoneEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.done") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseStartedEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.started") }).transform(( - v, - ) => ({ type: v.type })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationEventsData$ { - /** @deprecated use `ConversationEventsData$inboundSchema` instead. */ - export const inboundSchema = ConversationEventsData$inboundSchema; - /** @deprecated use `ConversationEventsData$outboundSchema` instead. */ - export const outboundSchema = ConversationEventsData$outboundSchema; - /** @deprecated use `ConversationEventsData$Outbound` instead. */ - export type Outbound = ConversationEventsData$Outbound; -} - -export function conversationEventsDataToJSON( - conversationEventsData: ConversationEventsData, -): string { - return JSON.stringify( - ConversationEventsData$outboundSchema.parse(conversationEventsData), - ); -} - -export function conversationEventsDataFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationEventsData$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationEventsData' from JSON`, - ); -} - -/** @internal */ -export const ConversationEvents$inboundSchema: z.ZodType< - ConversationEvents, - z.ZodTypeDef, - unknown -> = z.object({ - event: SSETypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}`, - }); - return z.NEVER; - } - }).pipe( - z.union([ - FunctionCallEvent$inboundSchema.and( - z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffDoneEvent$inboundSchema.and( - z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffStartedEvent$inboundSchema.and( - z.object({ type: z.literal("agent.handoff.started") }).transform(( - v, - ) => ({ type: v.type })), - ), - ToolExecutionDeltaEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), - ToolExecutionStartedEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.started") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseErrorEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.error") }).transform(( - v, - ) => ({ type: v.type })), - ), - MessageOutputEvent$inboundSchema.and( - z.object({ type: z.literal("message.output.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), - ToolExecutionDoneEvent$inboundSchema.and( - z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseDoneEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.done") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseStartedEvent$inboundSchema.and( - z.object({ type: z.literal("conversation.response.started") }) - .transform((v) => ({ type: v.type })), - ), - ]), - ), -}); - -/** @internal */ -export type ConversationEvents$Outbound = { - event: string; - data: - | (FunctionCallEvent$Outbound & { type: "function.call.delta" }) - | (AgentHandoffDoneEvent$Outbound & { type: "agent.handoff.done" }) - | (AgentHandoffStartedEvent$Outbound & { type: "agent.handoff.started" }) - | (ToolExecutionDeltaEvent$Outbound & { type: "tool.execution.delta" }) - | (ToolExecutionStartedEvent$Outbound & { type: "tool.execution.started" }) - | (ResponseErrorEvent$Outbound & { type: "conversation.response.error" }) - | (MessageOutputEvent$Outbound & { type: "message.output.delta" }) - | (ToolExecutionDoneEvent$Outbound & { type: "tool.execution.done" }) - | (ResponseDoneEvent$Outbound & { type: "conversation.response.done" }) - | (ResponseStartedEvent$Outbound & { - type: "conversation.response.started"; - }); -}; - -/** @internal */ -export const ConversationEvents$outboundSchema: z.ZodType< - ConversationEvents$Outbound, - z.ZodTypeDef, - ConversationEvents -> = z.object({ - event: SSETypes$outboundSchema, - data: z.union([ - FunctionCallEvent$outboundSchema.and( - z.object({ type: z.literal("function.call.delta") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffDoneEvent$outboundSchema.and( - z.object({ type: z.literal("agent.handoff.done") }).transform((v) => ({ - type: v.type, - })), - ), - AgentHandoffStartedEvent$outboundSchema.and( - z.object({ type: z.literal("agent.handoff.started") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDeltaEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionStartedEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.started") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseErrorEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.error") }).transform(( - v, - ) => ({ type: v.type })), - ), - MessageOutputEvent$outboundSchema.and( - z.object({ type: z.literal("message.output.delta") }).transform((v) => ({ - type: v.type, - })), - ), - ToolExecutionDoneEvent$outboundSchema.and( - z.object({ type: z.literal("tool.execution.done") }).transform((v) => ({ - type: v.type, - })), - ), - ResponseDoneEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.done") }).transform(( - v, - ) => ({ type: v.type })), - ), - ResponseStartedEvent$outboundSchema.and( - z.object({ type: z.literal("conversation.response.started") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationEvents$ { - /** @deprecated use `ConversationEvents$inboundSchema` instead. */ - export const inboundSchema = ConversationEvents$inboundSchema; - /** @deprecated use `ConversationEvents$outboundSchema` instead. */ - export const outboundSchema = ConversationEvents$outboundSchema; - /** @deprecated use `ConversationEvents$Outbound` instead. */ - export type Outbound = ConversationEvents$Outbound; -} - -export function conversationEventsToJSON( - conversationEvents: ConversationEvents, -): string { - return JSON.stringify( - ConversationEvents$outboundSchema.parse(conversationEvents), - ); -} - -export function conversationEventsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationEvents$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationEvents' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationhistory.ts b/examples/sdks/mistral-typescript/src/models/components/conversationhistory.ts deleted file mode 100644 index 160265f55..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationhistory.ts +++ /dev/null @@ -1,256 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AgentHandoffEntry, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, -} from "./agenthandoffentry.js"; -import { - FunctionCallEntry, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, -} from "./functioncallentry.js"; -import { - FunctionResultEntry, - FunctionResultEntry$inboundSchema, - FunctionResultEntry$Outbound, - FunctionResultEntry$outboundSchema, -} from "./functionresultentry.js"; -import { - MessageInputEntry, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, -} from "./messageinputentry.js"; -import { - MessageOutputEntry, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, -} from "./messageoutputentry.js"; -import { - ToolExecutionEntry, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, -} from "./toolexecutionentry.js"; - -export const ConversationHistoryObject = { - ConversationHistory: "conversation.history", -} as const; -export type ConversationHistoryObject = ClosedEnum< - typeof ConversationHistoryObject ->; - -export type Entries = - | AgentHandoffEntry - | FunctionCallEntry - | MessageInputEntry - | FunctionResultEntry - | ToolExecutionEntry - | MessageOutputEntry; - -/** - * Retrieve all entries in a conversation. - */ -export type ConversationHistory = { - object?: ConversationHistoryObject | undefined; - conversationId: string; - entries: Array< - | AgentHandoffEntry - | FunctionCallEntry - | MessageInputEntry - | FunctionResultEntry - | ToolExecutionEntry - | MessageOutputEntry - >; -}; - -/** @internal */ -export const ConversationHistoryObject$inboundSchema: z.ZodNativeEnum< - typeof ConversationHistoryObject -> = z.nativeEnum(ConversationHistoryObject); - -/** @internal */ -export const ConversationHistoryObject$outboundSchema: z.ZodNativeEnum< - typeof ConversationHistoryObject -> = ConversationHistoryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationHistoryObject$ { - /** @deprecated use `ConversationHistoryObject$inboundSchema` instead. */ - export const inboundSchema = ConversationHistoryObject$inboundSchema; - /** @deprecated use `ConversationHistoryObject$outboundSchema` instead. */ - export const outboundSchema = ConversationHistoryObject$outboundSchema; -} - -/** @internal */ -export const Entries$inboundSchema: z.ZodType = - z.union([ - AgentHandoffEntry$inboundSchema, - FunctionCallEntry$inboundSchema, - MessageInputEntry$inboundSchema, - FunctionResultEntry$inboundSchema, - ToolExecutionEntry$inboundSchema, - MessageOutputEntry$inboundSchema, - ]); - -/** @internal */ -export type Entries$Outbound = - | AgentHandoffEntry$Outbound - | FunctionCallEntry$Outbound - | MessageInputEntry$Outbound - | FunctionResultEntry$Outbound - | ToolExecutionEntry$Outbound - | MessageOutputEntry$Outbound; - -/** @internal */ -export const Entries$outboundSchema: z.ZodType< - Entries$Outbound, - z.ZodTypeDef, - Entries -> = z.union([ - AgentHandoffEntry$outboundSchema, - FunctionCallEntry$outboundSchema, - MessageInputEntry$outboundSchema, - FunctionResultEntry$outboundSchema, - ToolExecutionEntry$outboundSchema, - MessageOutputEntry$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Entries$ { - /** @deprecated use `Entries$inboundSchema` instead. */ - export const inboundSchema = Entries$inboundSchema; - /** @deprecated use `Entries$outboundSchema` instead. */ - export const outboundSchema = Entries$outboundSchema; - /** @deprecated use `Entries$Outbound` instead. */ - export type Outbound = Entries$Outbound; -} - -export function entriesToJSON(entries: Entries): string { - return JSON.stringify(Entries$outboundSchema.parse(entries)); -} - -export function entriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Entries$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Entries' from JSON`, - ); -} - -/** @internal */ -export const ConversationHistory$inboundSchema: z.ZodType< - ConversationHistory, - z.ZodTypeDef, - unknown -> = z.object({ - object: ConversationHistoryObject$inboundSchema.default( - "conversation.history", - ), - conversation_id: z.string(), - entries: z.array( - z.union([ - AgentHandoffEntry$inboundSchema, - FunctionCallEntry$inboundSchema, - MessageInputEntry$inboundSchema, - FunctionResultEntry$inboundSchema, - ToolExecutionEntry$inboundSchema, - MessageOutputEntry$inboundSchema, - ]), - ), -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type ConversationHistory$Outbound = { - object: string; - conversation_id: string; - entries: Array< - | AgentHandoffEntry$Outbound - | FunctionCallEntry$Outbound - | MessageInputEntry$Outbound - | FunctionResultEntry$Outbound - | ToolExecutionEntry$Outbound - | MessageOutputEntry$Outbound - >; -}; - -/** @internal */ -export const ConversationHistory$outboundSchema: z.ZodType< - ConversationHistory$Outbound, - z.ZodTypeDef, - ConversationHistory -> = z.object({ - object: ConversationHistoryObject$outboundSchema.default( - "conversation.history", - ), - conversationId: z.string(), - entries: z.array( - z.union([ - AgentHandoffEntry$outboundSchema, - FunctionCallEntry$outboundSchema, - MessageInputEntry$outboundSchema, - FunctionResultEntry$outboundSchema, - ToolExecutionEntry$outboundSchema, - MessageOutputEntry$outboundSchema, - ]), - ), -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationHistory$ { - /** @deprecated use `ConversationHistory$inboundSchema` instead. */ - export const inboundSchema = ConversationHistory$inboundSchema; - /** @deprecated use `ConversationHistory$outboundSchema` instead. */ - export const outboundSchema = ConversationHistory$outboundSchema; - /** @deprecated use `ConversationHistory$Outbound` instead. */ - export type Outbound = ConversationHistory$Outbound; -} - -export function conversationHistoryToJSON( - conversationHistory: ConversationHistory, -): string { - return JSON.stringify( - ConversationHistory$outboundSchema.parse(conversationHistory), - ); -} - -export function conversationHistoryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationHistory$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationHistory' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationinputs.ts b/examples/sdks/mistral-typescript/src/models/components/conversationinputs.ts deleted file mode 100644 index 37853a2ea..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationinputs.ts +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - InputEntries, - InputEntries$inboundSchema, - InputEntries$Outbound, - InputEntries$outboundSchema, -} from "./inputentries.js"; - -export type ConversationInputs = string | Array; - -/** @internal */ -export const ConversationInputs$inboundSchema: z.ZodType< - ConversationInputs, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(InputEntries$inboundSchema)]); - -/** @internal */ -export type ConversationInputs$Outbound = string | Array; - -/** @internal */ -export const ConversationInputs$outboundSchema: z.ZodType< - ConversationInputs$Outbound, - z.ZodTypeDef, - ConversationInputs -> = z.union([z.string(), z.array(InputEntries$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationInputs$ { - /** @deprecated use `ConversationInputs$inboundSchema` instead. */ - export const inboundSchema = ConversationInputs$inboundSchema; - /** @deprecated use `ConversationInputs$outboundSchema` instead. */ - export const outboundSchema = ConversationInputs$outboundSchema; - /** @deprecated use `ConversationInputs$Outbound` instead. */ - export type Outbound = ConversationInputs$Outbound; -} - -export function conversationInputsToJSON( - conversationInputs: ConversationInputs, -): string { - return JSON.stringify( - ConversationInputs$outboundSchema.parse(conversationInputs), - ); -} - -export function conversationInputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationInputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationInputs' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationmessages.ts b/examples/sdks/mistral-typescript/src/models/components/conversationmessages.ts deleted file mode 100644 index 8a3a1bf95..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationmessages.ts +++ /dev/null @@ -1,125 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - MessageEntries, - MessageEntries$inboundSchema, - MessageEntries$Outbound, - MessageEntries$outboundSchema, -} from "./messageentries.js"; - -export const ConversationMessagesObject = { - ConversationMessages: "conversation.messages", -} as const; -export type ConversationMessagesObject = ClosedEnum< - typeof ConversationMessagesObject ->; - -/** - * Similar to the conversation history but only keep the messages - */ -export type ConversationMessages = { - object?: ConversationMessagesObject | undefined; - conversationId: string; - messages: Array; -}; - -/** @internal */ -export const ConversationMessagesObject$inboundSchema: z.ZodNativeEnum< - typeof ConversationMessagesObject -> = z.nativeEnum(ConversationMessagesObject); - -/** @internal */ -export const ConversationMessagesObject$outboundSchema: z.ZodNativeEnum< - typeof ConversationMessagesObject -> = ConversationMessagesObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationMessagesObject$ { - /** @deprecated use `ConversationMessagesObject$inboundSchema` instead. */ - export const inboundSchema = ConversationMessagesObject$inboundSchema; - /** @deprecated use `ConversationMessagesObject$outboundSchema` instead. */ - export const outboundSchema = ConversationMessagesObject$outboundSchema; -} - -/** @internal */ -export const ConversationMessages$inboundSchema: z.ZodType< - ConversationMessages, - z.ZodTypeDef, - unknown -> = z.object({ - object: ConversationMessagesObject$inboundSchema.default( - "conversation.messages", - ), - conversation_id: z.string(), - messages: z.array(MessageEntries$inboundSchema), -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type ConversationMessages$Outbound = { - object: string; - conversation_id: string; - messages: Array; -}; - -/** @internal */ -export const ConversationMessages$outboundSchema: z.ZodType< - ConversationMessages$Outbound, - z.ZodTypeDef, - ConversationMessages -> = z.object({ - object: ConversationMessagesObject$outboundSchema.default( - "conversation.messages", - ), - conversationId: z.string(), - messages: z.array(MessageEntries$outboundSchema), -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationMessages$ { - /** @deprecated use `ConversationMessages$inboundSchema` instead. */ - export const inboundSchema = ConversationMessages$inboundSchema; - /** @deprecated use `ConversationMessages$outboundSchema` instead. */ - export const outboundSchema = ConversationMessages$outboundSchema; - /** @deprecated use `ConversationMessages$Outbound` instead. */ - export type Outbound = ConversationMessages$Outbound; -} - -export function conversationMessagesToJSON( - conversationMessages: ConversationMessages, -): string { - return JSON.stringify( - ConversationMessages$outboundSchema.parse(conversationMessages), - ); -} - -export function conversationMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationMessages' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationrequest.ts deleted file mode 100644 index c1e0043f4..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationrequest.ts +++ /dev/null @@ -1,402 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export const HandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type HandoffExecution = ClosedEnum; - -export type Tools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export type ConversationRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: HandoffExecution | null | undefined; - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | null - | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -export const HandoffExecution$inboundSchema: z.ZodNativeEnum< - typeof HandoffExecution -> = z.nativeEnum(HandoffExecution); - -/** @internal */ -export const HandoffExecution$outboundSchema: z.ZodNativeEnum< - typeof HandoffExecution -> = HandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace HandoffExecution$ { - /** @deprecated use `HandoffExecution$inboundSchema` instead. */ - export const inboundSchema = HandoffExecution$inboundSchema; - /** @deprecated use `HandoffExecution$outboundSchema` instead. */ - export const outboundSchema = HandoffExecution$outboundSchema; -} - -/** @internal */ -export const Tools$inboundSchema: z.ZodType = z - .union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]); - -/** @internal */ -export type Tools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const Tools$outboundSchema: z.ZodType< - Tools$Outbound, - z.ZodTypeDef, - Tools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Tools$ { - /** @deprecated use `Tools$inboundSchema` instead. */ - export const inboundSchema = Tools$inboundSchema; - /** @deprecated use `Tools$outboundSchema` instead. */ - export const outboundSchema = Tools$outboundSchema; - /** @deprecated use `Tools$Outbound` instead. */ - export type Outbound = Tools$Outbound; -} - -export function toolsToJSON(tools: Tools): string { - return JSON.stringify(Tools$outboundSchema.parse(tools)); -} - -export function toolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Tools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Tools' from JSON`, - ); -} - -/** @internal */ -export const ConversationRequest$inboundSchema: z.ZodType< - ConversationRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable(HandoffExecution$inboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable( - z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ), - ).optional(), - completion_args: z.nullable(CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type ConversationRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | null - | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -export const ConversationRequest$outboundSchema: z.ZodType< - ConversationRequest$Outbound, - z.ZodTypeDef, - ConversationRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable(HandoffExecution$outboundSchema).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable( - z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ), - ).optional(), - completionArgs: z.nullable(CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationRequest$ { - /** @deprecated use `ConversationRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationRequest$inboundSchema; - /** @deprecated use `ConversationRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationRequest$outboundSchema; - /** @deprecated use `ConversationRequest$Outbound` instead. */ - export type Outbound = ConversationRequest$Outbound; -} - -export function conversationRequestToJSON( - conversationRequest: ConversationRequest, -): string { - return JSON.stringify( - ConversationRequest$outboundSchema.parse(conversationRequest), - ); -} - -export function conversationRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationresponse.ts b/examples/sdks/mistral-typescript/src/models/components/conversationresponse.ts deleted file mode 100644 index c85fae84c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationresponse.ts +++ /dev/null @@ -1,238 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AgentHandoffEntry, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, -} from "./agenthandoffentry.js"; -import { - ConversationUsageInfo, - ConversationUsageInfo$inboundSchema, - ConversationUsageInfo$Outbound, - ConversationUsageInfo$outboundSchema, -} from "./conversationusageinfo.js"; -import { - FunctionCallEntry, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, -} from "./functioncallentry.js"; -import { - MessageOutputEntry, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, -} from "./messageoutputentry.js"; -import { - ToolExecutionEntry, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, -} from "./toolexecutionentry.js"; - -export const ConversationResponseObject = { - ConversationResponse: "conversation.response", -} as const; -export type ConversationResponseObject = ClosedEnum< - typeof ConversationResponseObject ->; - -export type Outputs = - | AgentHandoffEntry - | FunctionCallEntry - | ToolExecutionEntry - | MessageOutputEntry; - -/** - * The response after appending new entries to the conversation. - */ -export type ConversationResponse = { - object?: ConversationResponseObject | undefined; - conversationId: string; - outputs: Array< - | AgentHandoffEntry - | FunctionCallEntry - | ToolExecutionEntry - | MessageOutputEntry - >; - usage: ConversationUsageInfo; -}; - -/** @internal */ -export const ConversationResponseObject$inboundSchema: z.ZodNativeEnum< - typeof ConversationResponseObject -> = z.nativeEnum(ConversationResponseObject); - -/** @internal */ -export const ConversationResponseObject$outboundSchema: z.ZodNativeEnum< - typeof ConversationResponseObject -> = ConversationResponseObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationResponseObject$ { - /** @deprecated use `ConversationResponseObject$inboundSchema` instead. */ - export const inboundSchema = ConversationResponseObject$inboundSchema; - /** @deprecated use `ConversationResponseObject$outboundSchema` instead. */ - export const outboundSchema = ConversationResponseObject$outboundSchema; -} - -/** @internal */ -export const Outputs$inboundSchema: z.ZodType = - z.union([ - AgentHandoffEntry$inboundSchema, - FunctionCallEntry$inboundSchema, - ToolExecutionEntry$inboundSchema, - MessageOutputEntry$inboundSchema, - ]); - -/** @internal */ -export type Outputs$Outbound = - | AgentHandoffEntry$Outbound - | FunctionCallEntry$Outbound - | ToolExecutionEntry$Outbound - | MessageOutputEntry$Outbound; - -/** @internal */ -export const Outputs$outboundSchema: z.ZodType< - Outputs$Outbound, - z.ZodTypeDef, - Outputs -> = z.union([ - AgentHandoffEntry$outboundSchema, - FunctionCallEntry$outboundSchema, - ToolExecutionEntry$outboundSchema, - MessageOutputEntry$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Outputs$ { - /** @deprecated use `Outputs$inboundSchema` instead. */ - export const inboundSchema = Outputs$inboundSchema; - /** @deprecated use `Outputs$outboundSchema` instead. */ - export const outboundSchema = Outputs$outboundSchema; - /** @deprecated use `Outputs$Outbound` instead. */ - export type Outbound = Outputs$Outbound; -} - -export function outputsToJSON(outputs: Outputs): string { - return JSON.stringify(Outputs$outboundSchema.parse(outputs)); -} - -export function outputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Outputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Outputs' from JSON`, - ); -} - -/** @internal */ -export const ConversationResponse$inboundSchema: z.ZodType< - ConversationResponse, - z.ZodTypeDef, - unknown -> = z.object({ - object: ConversationResponseObject$inboundSchema.default( - "conversation.response", - ), - conversation_id: z.string(), - outputs: z.array( - z.union([ - AgentHandoffEntry$inboundSchema, - FunctionCallEntry$inboundSchema, - ToolExecutionEntry$inboundSchema, - MessageOutputEntry$inboundSchema, - ]), - ), - usage: ConversationUsageInfo$inboundSchema, -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type ConversationResponse$Outbound = { - object: string; - conversation_id: string; - outputs: Array< - | AgentHandoffEntry$Outbound - | FunctionCallEntry$Outbound - | ToolExecutionEntry$Outbound - | MessageOutputEntry$Outbound - >; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -export const ConversationResponse$outboundSchema: z.ZodType< - ConversationResponse$Outbound, - z.ZodTypeDef, - ConversationResponse -> = z.object({ - object: ConversationResponseObject$outboundSchema.default( - "conversation.response", - ), - conversationId: z.string(), - outputs: z.array( - z.union([ - AgentHandoffEntry$outboundSchema, - FunctionCallEntry$outboundSchema, - ToolExecutionEntry$outboundSchema, - MessageOutputEntry$outboundSchema, - ]), - ), - usage: ConversationUsageInfo$outboundSchema, -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationResponse$ { - /** @deprecated use `ConversationResponse$inboundSchema` instead. */ - export const inboundSchema = ConversationResponse$inboundSchema; - /** @deprecated use `ConversationResponse$outboundSchema` instead. */ - export const outboundSchema = ConversationResponse$outboundSchema; - /** @deprecated use `ConversationResponse$Outbound` instead. */ - export type Outbound = ConversationResponse$Outbound; -} - -export function conversationResponseToJSON( - conversationResponse: ConversationResponse, -): string { - return JSON.stringify( - ConversationResponse$outboundSchema.parse(conversationResponse), - ); -} - -export function conversationResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationrestartrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationrestartrequest.ts deleted file mode 100644 index 9bd197c03..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationrestartrequest.ts +++ /dev/null @@ -1,154 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; - -export const ConversationRestartRequestHandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type ConversationRestartRequestHandoffExecution = ClosedEnum< - typeof ConversationRestartRequestHandoffExecution ->; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -export type ConversationRestartRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: ConversationRestartRequestHandoffExecution | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -/** @internal */ -export const ConversationRestartRequestHandoffExecution$inboundSchema: - z.ZodNativeEnum = z - .nativeEnum(ConversationRestartRequestHandoffExecution); - -/** @internal */ -export const ConversationRestartRequestHandoffExecution$outboundSchema: - z.ZodNativeEnum = - ConversationRestartRequestHandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationRestartRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartRequestHandoffExecution$inboundSchema` instead. */ - export const inboundSchema = - ConversationRestartRequestHandoffExecution$inboundSchema; - /** @deprecated use `ConversationRestartRequestHandoffExecution$outboundSchema` instead. */ - export const outboundSchema = - ConversationRestartRequestHandoffExecution$outboundSchema; -} - -/** @internal */ -export const ConversationRestartRequest$inboundSchema: z.ZodType< - ConversationRestartRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoff_execution: ConversationRestartRequestHandoffExecution$inboundSchema - .default("server"), - completion_args: CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId", - }); -}); - -/** @internal */ -export type ConversationRestartRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -export const ConversationRestartRequest$outboundSchema: z.ZodType< - ConversationRestartRequest$Outbound, - z.ZodTypeDef, - ConversationRestartRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(false), - store: z.boolean().default(true), - handoffExecution: ConversationRestartRequestHandoffExecution$outboundSchema - .default("server"), - completionArgs: CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationRestartRequest$ { - /** @deprecated use `ConversationRestartRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationRestartRequest$inboundSchema; - /** @deprecated use `ConversationRestartRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationRestartRequest$outboundSchema; - /** @deprecated use `ConversationRestartRequest$Outbound` instead. */ - export type Outbound = ConversationRestartRequest$Outbound; -} - -export function conversationRestartRequestToJSON( - conversationRestartRequest: ConversationRestartRequest, -): string { - return JSON.stringify( - ConversationRestartRequest$outboundSchema.parse(conversationRestartRequest), - ); -} - -export function conversationRestartRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationRestartRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationRestartRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationrestartstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationrestartstreamrequest.ts deleted file mode 100644 index 5912a1713..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationrestartstreamrequest.ts +++ /dev/null @@ -1,162 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; - -export const ConversationRestartStreamRequestHandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type ConversationRestartStreamRequestHandoffExecution = ClosedEnum< - typeof ConversationRestartStreamRequestHandoffExecution ->; - -/** - * Request to restart a new conversation from a given entry in the conversation. - */ -export type ConversationRestartStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - /** - * Whether to store the results into our servers or not. - */ - store?: boolean | undefined; - handoffExecution?: - | ConversationRestartStreamRequestHandoffExecution - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - fromEntryId: string; -}; - -/** @internal */ -export const ConversationRestartStreamRequestHandoffExecution$inboundSchema: - z.ZodNativeEnum = z - .nativeEnum(ConversationRestartStreamRequestHandoffExecution); - -/** @internal */ -export const ConversationRestartStreamRequestHandoffExecution$outboundSchema: - z.ZodNativeEnum = - ConversationRestartStreamRequestHandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationRestartStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$inboundSchema` instead. */ - export const inboundSchema = - ConversationRestartStreamRequestHandoffExecution$inboundSchema; - /** @deprecated use `ConversationRestartStreamRequestHandoffExecution$outboundSchema` instead. */ - export const outboundSchema = - ConversationRestartStreamRequestHandoffExecution$outboundSchema; -} - -/** @internal */ -export const ConversationRestartStreamRequest$inboundSchema: z.ZodType< - ConversationRestartStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoff_execution: - ConversationRestartStreamRequestHandoffExecution$inboundSchema.default( - "server", - ), - completion_args: CompletionArgs$inboundSchema.optional(), - from_entry_id: z.string(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "from_entry_id": "fromEntryId", - }); -}); - -/** @internal */ -export type ConversationRestartStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store: boolean; - handoff_execution: string; - completion_args?: CompletionArgs$Outbound | undefined; - from_entry_id: string; -}; - -/** @internal */ -export const ConversationRestartStreamRequest$outboundSchema: z.ZodType< - ConversationRestartStreamRequest$Outbound, - z.ZodTypeDef, - ConversationRestartStreamRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.boolean().default(true), - handoffExecution: - ConversationRestartStreamRequestHandoffExecution$outboundSchema.default( - "server", - ), - completionArgs: CompletionArgs$outboundSchema.optional(), - fromEntryId: z.string(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - fromEntryId: "from_entry_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationRestartStreamRequest$ { - /** @deprecated use `ConversationRestartStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationRestartStreamRequest$inboundSchema; - /** @deprecated use `ConversationRestartStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationRestartStreamRequest$outboundSchema; - /** @deprecated use `ConversationRestartStreamRequest$Outbound` instead. */ - export type Outbound = ConversationRestartStreamRequest$Outbound; -} - -export function conversationRestartStreamRequestToJSON( - conversationRestartStreamRequest: ConversationRestartStreamRequest, -): string { - return JSON.stringify( - ConversationRestartStreamRequest$outboundSchema.parse( - conversationRestartStreamRequest, - ), - ); -} - -export function conversationRestartStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationRestartStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationRestartStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/conversationstreamrequest.ts deleted file mode 100644 index 395c0a20e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationstreamrequest.ts +++ /dev/null @@ -1,422 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - ConversationInputs, - ConversationInputs$inboundSchema, - ConversationInputs$Outbound, - ConversationInputs$outboundSchema, -} from "./conversationinputs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export const ConversationStreamRequestHandoffExecution = { - Client: "client", - Server: "server", -} as const; -export type ConversationStreamRequestHandoffExecution = ClosedEnum< - typeof ConversationStreamRequestHandoffExecution ->; - -export type ConversationStreamRequestTools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export type ConversationStreamRequest = { - inputs: ConversationInputs; - stream?: boolean | undefined; - store?: boolean | null | undefined; - handoffExecution?: - | ConversationStreamRequestHandoffExecution - | null - | undefined; - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | null - | undefined; - completionArgs?: CompletionArgs | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -export const ConversationStreamRequestHandoffExecution$inboundSchema: - z.ZodNativeEnum = z - .nativeEnum(ConversationStreamRequestHandoffExecution); - -/** @internal */ -export const ConversationStreamRequestHandoffExecution$outboundSchema: - z.ZodNativeEnum = - ConversationStreamRequestHandoffExecution$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationStreamRequestHandoffExecution$ { - /** @deprecated use `ConversationStreamRequestHandoffExecution$inboundSchema` instead. */ - export const inboundSchema = - ConversationStreamRequestHandoffExecution$inboundSchema; - /** @deprecated use `ConversationStreamRequestHandoffExecution$outboundSchema` instead. */ - export const outboundSchema = - ConversationStreamRequestHandoffExecution$outboundSchema; -} - -/** @internal */ -export const ConversationStreamRequestTools$inboundSchema: z.ZodType< - ConversationStreamRequestTools, - z.ZodTypeDef, - unknown -> = z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type ConversationStreamRequestTools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const ConversationStreamRequestTools$outboundSchema: z.ZodType< - ConversationStreamRequestTools$Outbound, - z.ZodTypeDef, - ConversationStreamRequestTools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationStreamRequestTools$ { - /** @deprecated use `ConversationStreamRequestTools$inboundSchema` instead. */ - export const inboundSchema = ConversationStreamRequestTools$inboundSchema; - /** @deprecated use `ConversationStreamRequestTools$outboundSchema` instead. */ - export const outboundSchema = ConversationStreamRequestTools$outboundSchema; - /** @deprecated use `ConversationStreamRequestTools$Outbound` instead. */ - export type Outbound = ConversationStreamRequestTools$Outbound; -} - -export function conversationStreamRequestToolsToJSON( - conversationStreamRequestTools: ConversationStreamRequestTools, -): string { - return JSON.stringify( - ConversationStreamRequestTools$outboundSchema.parse( - conversationStreamRequestTools, - ), - ); -} - -export function conversationStreamRequestToolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationStreamRequestTools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationStreamRequestTools' from JSON`, - ); -} - -/** @internal */ -export const ConversationStreamRequest$inboundSchema: z.ZodType< - ConversationStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - inputs: ConversationInputs$inboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoff_execution: z.nullable( - ConversationStreamRequestHandoffExecution$inboundSchema, - ).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable( - z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ), - ).optional(), - completion_args: z.nullable(CompletionArgs$inboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "handoff_execution": "handoffExecution", - "completion_args": "completionArgs", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type ConversationStreamRequest$Outbound = { - inputs: ConversationInputs$Outbound; - stream: boolean; - store?: boolean | null | undefined; - handoff_execution?: string | null | undefined; - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | null - | undefined; - completion_args?: CompletionArgs$Outbound | null | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; -}; - -/** @internal */ -export const ConversationStreamRequest$outboundSchema: z.ZodType< - ConversationStreamRequest$Outbound, - z.ZodTypeDef, - ConversationStreamRequest -> = z.object({ - inputs: ConversationInputs$outboundSchema, - stream: z.boolean().default(true), - store: z.nullable(z.boolean()).optional(), - handoffExecution: z.nullable( - ConversationStreamRequestHandoffExecution$outboundSchema, - ).optional(), - instructions: z.nullable(z.string()).optional(), - tools: z.nullable( - z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ), - ).optional(), - completionArgs: z.nullable(CompletionArgs$outboundSchema).optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - handoffExecution: "handoff_execution", - completionArgs: "completion_args", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationStreamRequest$ { - /** @deprecated use `ConversationStreamRequest$inboundSchema` instead. */ - export const inboundSchema = ConversationStreamRequest$inboundSchema; - /** @deprecated use `ConversationStreamRequest$outboundSchema` instead. */ - export const outboundSchema = ConversationStreamRequest$outboundSchema; - /** @deprecated use `ConversationStreamRequest$Outbound` instead. */ - export type Outbound = ConversationStreamRequest$Outbound; -} - -export function conversationStreamRequestToJSON( - conversationStreamRequest: ConversationStreamRequest, -): string { - return JSON.stringify( - ConversationStreamRequest$outboundSchema.parse(conversationStreamRequest), - ); -} - -export function conversationStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/conversationusageinfo.ts b/examples/sdks/mistral-typescript/src/models/components/conversationusageinfo.ts deleted file mode 100644 index cd23b7919..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/conversationusageinfo.ts +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ConversationUsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - connectorTokens?: number | null | undefined; - connectors?: { [k: string]: number } | null | undefined; -}; - -/** @internal */ -export const ConversationUsageInfo$inboundSchema: z.ZodType< - ConversationUsageInfo, - z.ZodTypeDef, - unknown -> = z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - connector_tokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional(), -}).transform((v) => { - return remap$(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "connector_tokens": "connectorTokens", - }); -}); - -/** @internal */ -export type ConversationUsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - connector_tokens?: number | null | undefined; - connectors?: { [k: string]: number } | null | undefined; -}; - -/** @internal */ -export const ConversationUsageInfo$outboundSchema: z.ZodType< - ConversationUsageInfo$Outbound, - z.ZodTypeDef, - ConversationUsageInfo -> = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - connectorTokens: z.nullable(z.number().int()).optional(), - connectors: z.nullable(z.record(z.number().int())).optional(), -}).transform((v) => { - return remap$(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - connectorTokens: "connector_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ConversationUsageInfo$ { - /** @deprecated use `ConversationUsageInfo$inboundSchema` instead. */ - export const inboundSchema = ConversationUsageInfo$inboundSchema; - /** @deprecated use `ConversationUsageInfo$outboundSchema` instead. */ - export const outboundSchema = ConversationUsageInfo$outboundSchema; - /** @deprecated use `ConversationUsageInfo$Outbound` instead. */ - export type Outbound = ConversationUsageInfo$Outbound; -} - -export function conversationUsageInfoToJSON( - conversationUsageInfo: ConversationUsageInfo, -): string { - return JSON.stringify( - ConversationUsageInfo$outboundSchema.parse(conversationUsageInfo), - ); -} - -export function conversationUsageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ConversationUsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ConversationUsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/deletefileout.ts b/examples/sdks/mistral-typescript/src/models/components/deletefileout.ts deleted file mode 100644 index 500f2f6b5..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/deletefileout.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DeleteFileOut = { - /** - * The ID of the deleted file. - */ - id: string; - /** - * The object type that was deleted - */ - object: string; - /** - * The deletion status. - */ - deleted: boolean; -}; - -/** @internal */ -export const DeleteFileOut$inboundSchema: z.ZodType< - DeleteFileOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean(), -}); - -/** @internal */ -export type DeleteFileOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -export const DeleteFileOut$outboundSchema: z.ZodType< - DeleteFileOut$Outbound, - z.ZodTypeDef, - DeleteFileOut -> = z.object({ - id: z.string(), - object: z.string(), - deleted: z.boolean(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeleteFileOut$ { - /** @deprecated use `DeleteFileOut$inboundSchema` instead. */ - export const inboundSchema = DeleteFileOut$inboundSchema; - /** @deprecated use `DeleteFileOut$outboundSchema` instead. */ - export const outboundSchema = DeleteFileOut$outboundSchema; - /** @deprecated use `DeleteFileOut$Outbound` instead. */ - export type Outbound = DeleteFileOut$Outbound; -} - -export function deleteFileOutToJSON(deleteFileOut: DeleteFileOut): string { - return JSON.stringify(DeleteFileOut$outboundSchema.parse(deleteFileOut)); -} - -export function deleteFileOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DeleteFileOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DeleteFileOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/deletemodelout.ts b/examples/sdks/mistral-typescript/src/models/components/deletemodelout.ts deleted file mode 100644 index 0fc3cedf8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/deletemodelout.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DeleteModelOut = { - /** - * The ID of the deleted model. - */ - id: string; - /** - * The object type that was deleted - */ - object?: string | undefined; - /** - * The deletion status - */ - deleted?: boolean | undefined; -}; - -/** @internal */ -export const DeleteModelOut$inboundSchema: z.ZodType< - DeleteModelOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true), -}); - -/** @internal */ -export type DeleteModelOut$Outbound = { - id: string; - object: string; - deleted: boolean; -}; - -/** @internal */ -export const DeleteModelOut$outboundSchema: z.ZodType< - DeleteModelOut$Outbound, - z.ZodTypeDef, - DeleteModelOut -> = z.object({ - id: z.string(), - object: z.string().default("model"), - deleted: z.boolean().default(true), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeleteModelOut$ { - /** @deprecated use `DeleteModelOut$inboundSchema` instead. */ - export const inboundSchema = DeleteModelOut$inboundSchema; - /** @deprecated use `DeleteModelOut$outboundSchema` instead. */ - export const outboundSchema = DeleteModelOut$outboundSchema; - /** @deprecated use `DeleteModelOut$Outbound` instead. */ - export type Outbound = DeleteModelOut$Outbound; -} - -export function deleteModelOutToJSON(deleteModelOut: DeleteModelOut): string { - return JSON.stringify(DeleteModelOut$outboundSchema.parse(deleteModelOut)); -} - -export function deleteModelOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DeleteModelOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DeleteModelOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/deltamessage.ts b/examples/sdks/mistral-typescript/src/models/components/deltamessage.ts deleted file mode 100644 index f01a3bf19..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/deltamessage.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; -import { - ToolCall, - ToolCall$inboundSchema, - ToolCall$Outbound, - ToolCall$outboundSchema, -} from "./toolcall.js"; - -export type Content = string | Array; - -export type DeltaMessage = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - toolCalls?: Array | null | undefined; -}; - -/** @internal */ -export const Content$inboundSchema: z.ZodType = - z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type Content$Outbound = string | Array; - -/** @internal */ -export const Content$outboundSchema: z.ZodType< - Content$Outbound, - z.ZodTypeDef, - Content -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Content$ { - /** @deprecated use `Content$inboundSchema` instead. */ - export const inboundSchema = Content$inboundSchema; - /** @deprecated use `Content$outboundSchema` instead. */ - export const outboundSchema = Content$outboundSchema; - /** @deprecated use `Content$Outbound` instead. */ - export type Outbound = Content$Outbound; -} - -export function contentToJSON(content: Content): string { - return JSON.stringify(Content$outboundSchema.parse(content)); -} - -export function contentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Content$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Content' from JSON`, - ); -} - -/** @internal */ -export const DeltaMessage$inboundSchema: z.ZodType< - DeltaMessage, - z.ZodTypeDef, - unknown -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ).optional(), - tool_calls: z.nullable(z.array(ToolCall$inboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - "tool_calls": "toolCalls", - }); -}); - -/** @internal */ -export type DeltaMessage$Outbound = { - role?: string | null | undefined; - content?: string | Array | null | undefined; - tool_calls?: Array | null | undefined; -}; - -/** @internal */ -export const DeltaMessage$outboundSchema: z.ZodType< - DeltaMessage$Outbound, - z.ZodTypeDef, - DeltaMessage -> = z.object({ - role: z.nullable(z.string()).optional(), - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ).optional(), - toolCalls: z.nullable(z.array(ToolCall$outboundSchema)).optional(), -}).transform((v) => { - return remap$(v, { - toolCalls: "tool_calls", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeltaMessage$ { - /** @deprecated use `DeltaMessage$inboundSchema` instead. */ - export const inboundSchema = DeltaMessage$inboundSchema; - /** @deprecated use `DeltaMessage$outboundSchema` instead. */ - export const outboundSchema = DeltaMessage$outboundSchema; - /** @deprecated use `DeltaMessage$Outbound` instead. */ - export type Outbound = DeltaMessage$Outbound; -} - -export function deltaMessageToJSON(deltaMessage: DeltaMessage): string { - return JSON.stringify(DeltaMessage$outboundSchema.parse(deltaMessage)); -} - -export function deltaMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DeltaMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DeltaMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/documentlibrarytool.ts b/examples/sdks/mistral-typescript/src/models/components/documentlibrarytool.ts deleted file mode 100644 index 06232f684..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/documentlibrarytool.ts +++ /dev/null @@ -1,111 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const DocumentLibraryToolType = { - DocumentLibrary: "document_library", -} as const; -export type DocumentLibraryToolType = ClosedEnum< - typeof DocumentLibraryToolType ->; - -export type DocumentLibraryTool = { - type?: DocumentLibraryToolType | undefined; - /** - * Ids of the library in which to search. - */ - libraryIds: Array; -}; - -/** @internal */ -export const DocumentLibraryToolType$inboundSchema: z.ZodNativeEnum< - typeof DocumentLibraryToolType -> = z.nativeEnum(DocumentLibraryToolType); - -/** @internal */ -export const DocumentLibraryToolType$outboundSchema: z.ZodNativeEnum< - typeof DocumentLibraryToolType -> = DocumentLibraryToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentLibraryToolType$ { - /** @deprecated use `DocumentLibraryToolType$inboundSchema` instead. */ - export const inboundSchema = DocumentLibraryToolType$inboundSchema; - /** @deprecated use `DocumentLibraryToolType$outboundSchema` instead. */ - export const outboundSchema = DocumentLibraryToolType$outboundSchema; -} - -/** @internal */ -export const DocumentLibraryTool$inboundSchema: z.ZodType< - DocumentLibraryTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: DocumentLibraryToolType$inboundSchema.default("document_library"), - library_ids: z.array(z.string()), -}).transform((v) => { - return remap$(v, { - "library_ids": "libraryIds", - }); -}); - -/** @internal */ -export type DocumentLibraryTool$Outbound = { - type: string; - library_ids: Array; -}; - -/** @internal */ -export const DocumentLibraryTool$outboundSchema: z.ZodType< - DocumentLibraryTool$Outbound, - z.ZodTypeDef, - DocumentLibraryTool -> = z.object({ - type: DocumentLibraryToolType$outboundSchema.default("document_library"), - libraryIds: z.array(z.string()), -}).transform((v) => { - return remap$(v, { - libraryIds: "library_ids", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentLibraryTool$ { - /** @deprecated use `DocumentLibraryTool$inboundSchema` instead. */ - export const inboundSchema = DocumentLibraryTool$inboundSchema; - /** @deprecated use `DocumentLibraryTool$outboundSchema` instead. */ - export const outboundSchema = DocumentLibraryTool$outboundSchema; - /** @deprecated use `DocumentLibraryTool$Outbound` instead. */ - export type Outbound = DocumentLibraryTool$Outbound; -} - -export function documentLibraryToolToJSON( - documentLibraryTool: DocumentLibraryTool, -): string { - return JSON.stringify( - DocumentLibraryTool$outboundSchema.parse(documentLibraryTool), - ); -} - -export function documentLibraryToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentLibraryTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentLibraryTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/documentout.ts b/examples/sdks/mistral-typescript/src/models/components/documentout.ts deleted file mode 100644 index 5d7cab129..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/documentout.ts +++ /dev/null @@ -1,158 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DocumentOut = { - id: string; - libraryId: string; - hash: string; - mimeType: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - createdAt: Date; - lastProcessedAt?: Date | null | undefined; - numberOfPages?: number | null | undefined; - processingStatus: string; - uploadedById: string; - uploadedByType: string; - tokensProcessingMainContent?: number | null | undefined; - tokensProcessingSummary?: number | null | undefined; - tokensProcessingTotal: number; -}; - -/** @internal */ -export const DocumentOut$inboundSchema: z.ZodType< - DocumentOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - library_id: z.string(), - hash: z.string(), - mime_type: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - last_processed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - number_of_pages: z.nullable(z.number().int()).optional(), - processing_status: z.string(), - uploaded_by_id: z.string(), - uploaded_by_type: z.string(), - tokens_processing_main_content: z.nullable(z.number().int()).optional(), - tokens_processing_summary: z.nullable(z.number().int()).optional(), - tokens_processing_total: z.number().int(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "mime_type": "mimeType", - "created_at": "createdAt", - "last_processed_at": "lastProcessedAt", - "number_of_pages": "numberOfPages", - "processing_status": "processingStatus", - "uploaded_by_id": "uploadedById", - "uploaded_by_type": "uploadedByType", - "tokens_processing_main_content": "tokensProcessingMainContent", - "tokens_processing_summary": "tokensProcessingSummary", - "tokens_processing_total": "tokensProcessingTotal", - }); -}); - -/** @internal */ -export type DocumentOut$Outbound = { - id: string; - library_id: string; - hash: string; - mime_type: string; - extension: string; - size: number; - name: string; - summary?: string | null | undefined; - created_at: string; - last_processed_at?: string | null | undefined; - number_of_pages?: number | null | undefined; - processing_status: string; - uploaded_by_id: string; - uploaded_by_type: string; - tokens_processing_main_content?: number | null | undefined; - tokens_processing_summary?: number | null | undefined; - tokens_processing_total: number; -}; - -/** @internal */ -export const DocumentOut$outboundSchema: z.ZodType< - DocumentOut$Outbound, - z.ZodTypeDef, - DocumentOut -> = z.object({ - id: z.string(), - libraryId: z.string(), - hash: z.string(), - mimeType: z.string(), - extension: z.string(), - size: z.number().int(), - name: z.string(), - summary: z.nullable(z.string()).optional(), - createdAt: z.date().transform(v => v.toISOString()), - lastProcessedAt: z.nullable(z.date().transform(v => v.toISOString())) - .optional(), - numberOfPages: z.nullable(z.number().int()).optional(), - processingStatus: z.string(), - uploadedById: z.string(), - uploadedByType: z.string(), - tokensProcessingMainContent: z.nullable(z.number().int()).optional(), - tokensProcessingSummary: z.nullable(z.number().int()).optional(), - tokensProcessingTotal: z.number().int(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - mimeType: "mime_type", - createdAt: "created_at", - lastProcessedAt: "last_processed_at", - numberOfPages: "number_of_pages", - processingStatus: "processing_status", - uploadedById: "uploaded_by_id", - uploadedByType: "uploaded_by_type", - tokensProcessingMainContent: "tokens_processing_main_content", - tokensProcessingSummary: "tokens_processing_summary", - tokensProcessingTotal: "tokens_processing_total", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentOut$ { - /** @deprecated use `DocumentOut$inboundSchema` instead. */ - export const inboundSchema = DocumentOut$inboundSchema; - /** @deprecated use `DocumentOut$outboundSchema` instead. */ - export const outboundSchema = DocumentOut$outboundSchema; - /** @deprecated use `DocumentOut$Outbound` instead. */ - export type Outbound = DocumentOut$Outbound; -} - -export function documentOutToJSON(documentOut: DocumentOut): string { - return JSON.stringify(DocumentOut$outboundSchema.parse(documentOut)); -} - -export function documentOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/documenttextcontent.ts b/examples/sdks/mistral-typescript/src/models/components/documenttextcontent.ts deleted file mode 100644 index 293c89240..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/documenttextcontent.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DocumentTextContent = { - text: string; -}; - -/** @internal */ -export const DocumentTextContent$inboundSchema: z.ZodType< - DocumentTextContent, - z.ZodTypeDef, - unknown -> = z.object({ - text: z.string(), -}); - -/** @internal */ -export type DocumentTextContent$Outbound = { - text: string; -}; - -/** @internal */ -export const DocumentTextContent$outboundSchema: z.ZodType< - DocumentTextContent$Outbound, - z.ZodTypeDef, - DocumentTextContent -> = z.object({ - text: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentTextContent$ { - /** @deprecated use `DocumentTextContent$inboundSchema` instead. */ - export const inboundSchema = DocumentTextContent$inboundSchema; - /** @deprecated use `DocumentTextContent$outboundSchema` instead. */ - export const outboundSchema = DocumentTextContent$outboundSchema; - /** @deprecated use `DocumentTextContent$Outbound` instead. */ - export type Outbound = DocumentTextContent$Outbound; -} - -export function documentTextContentToJSON( - documentTextContent: DocumentTextContent, -): string { - return JSON.stringify( - DocumentTextContent$outboundSchema.parse(documentTextContent), - ); -} - -export function documentTextContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentTextContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentTextContent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/documentupdatein.ts b/examples/sdks/mistral-typescript/src/models/components/documentupdatein.ts deleted file mode 100644 index cb9de35b8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/documentupdatein.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DocumentUpdateIn = { - name?: string | null | undefined; -}; - -/** @internal */ -export const DocumentUpdateIn$inboundSchema: z.ZodType< - DocumentUpdateIn, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type DocumentUpdateIn$Outbound = { - name?: string | null | undefined; -}; - -/** @internal */ -export const DocumentUpdateIn$outboundSchema: z.ZodType< - DocumentUpdateIn$Outbound, - z.ZodTypeDef, - DocumentUpdateIn -> = z.object({ - name: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentUpdateIn$ { - /** @deprecated use `DocumentUpdateIn$inboundSchema` instead. */ - export const inboundSchema = DocumentUpdateIn$inboundSchema; - /** @deprecated use `DocumentUpdateIn$outboundSchema` instead. */ - export const outboundSchema = DocumentUpdateIn$outboundSchema; - /** @deprecated use `DocumentUpdateIn$Outbound` instead. */ - export type Outbound = DocumentUpdateIn$Outbound; -} - -export function documentUpdateInToJSON( - documentUpdateIn: DocumentUpdateIn, -): string { - return JSON.stringify( - DocumentUpdateIn$outboundSchema.parse(documentUpdateIn), - ); -} - -export function documentUpdateInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentUpdateIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentUpdateIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/documenturlchunk.ts b/examples/sdks/mistral-typescript/src/models/components/documenturlchunk.ts deleted file mode 100644 index e4edca21a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/documenturlchunk.ts +++ /dev/null @@ -1,115 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const DocumentURLChunkType = { - DocumentUrl: "document_url", -} as const; -export type DocumentURLChunkType = ClosedEnum; - -export type DocumentURLChunk = { - documentUrl: string; - /** - * The filename of the document - */ - documentName?: string | null | undefined; - type?: DocumentURLChunkType | undefined; -}; - -/** @internal */ -export const DocumentURLChunkType$inboundSchema: z.ZodNativeEnum< - typeof DocumentURLChunkType -> = z.nativeEnum(DocumentURLChunkType); - -/** @internal */ -export const DocumentURLChunkType$outboundSchema: z.ZodNativeEnum< - typeof DocumentURLChunkType -> = DocumentURLChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentURLChunkType$ { - /** @deprecated use `DocumentURLChunkType$inboundSchema` instead. */ - export const inboundSchema = DocumentURLChunkType$inboundSchema; - /** @deprecated use `DocumentURLChunkType$outboundSchema` instead. */ - export const outboundSchema = DocumentURLChunkType$outboundSchema; -} - -/** @internal */ -export const DocumentURLChunk$inboundSchema: z.ZodType< - DocumentURLChunk, - z.ZodTypeDef, - unknown -> = z.object({ - document_url: z.string(), - document_name: z.nullable(z.string()).optional(), - type: DocumentURLChunkType$inboundSchema.default("document_url"), -}).transform((v) => { - return remap$(v, { - "document_url": "documentUrl", - "document_name": "documentName", - }); -}); - -/** @internal */ -export type DocumentURLChunk$Outbound = { - document_url: string; - document_name?: string | null | undefined; - type: string; -}; - -/** @internal */ -export const DocumentURLChunk$outboundSchema: z.ZodType< - DocumentURLChunk$Outbound, - z.ZodTypeDef, - DocumentURLChunk -> = z.object({ - documentUrl: z.string(), - documentName: z.nullable(z.string()).optional(), - type: DocumentURLChunkType$outboundSchema.default("document_url"), -}).transform((v) => { - return remap$(v, { - documentUrl: "document_url", - documentName: "document_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DocumentURLChunk$ { - /** @deprecated use `DocumentURLChunk$inboundSchema` instead. */ - export const inboundSchema = DocumentURLChunk$inboundSchema; - /** @deprecated use `DocumentURLChunk$outboundSchema` instead. */ - export const outboundSchema = DocumentURLChunk$outboundSchema; - /** @deprecated use `DocumentURLChunk$Outbound` instead. */ - export type Outbound = DocumentURLChunk$Outbound; -} - -export function documentURLChunkToJSON( - documentURLChunk: DocumentURLChunk, -): string { - return JSON.stringify( - DocumentURLChunk$outboundSchema.parse(documentURLChunk), - ); -} - -export function documentURLChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => DocumentURLChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'DocumentURLChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/embeddingdtype.ts b/examples/sdks/mistral-typescript/src/models/components/embeddingdtype.ts deleted file mode 100644 index 8151ebff3..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/embeddingdtype.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const EmbeddingDtype = { - Float: "float", - Int8: "int8", - Uint8: "uint8", - Binary: "binary", - Ubinary: "ubinary", -} as const; -export type EmbeddingDtype = ClosedEnum; - -/** @internal */ -export const EmbeddingDtype$inboundSchema: z.ZodNativeEnum< - typeof EmbeddingDtype -> = z.nativeEnum(EmbeddingDtype); - -/** @internal */ -export const EmbeddingDtype$outboundSchema: z.ZodNativeEnum< - typeof EmbeddingDtype -> = EmbeddingDtype$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EmbeddingDtype$ { - /** @deprecated use `EmbeddingDtype$inboundSchema` instead. */ - export const inboundSchema = EmbeddingDtype$inboundSchema; - /** @deprecated use `EmbeddingDtype$outboundSchema` instead. */ - export const outboundSchema = EmbeddingDtype$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/embeddingrequest.ts b/examples/sdks/mistral-typescript/src/models/components/embeddingrequest.ts deleted file mode 100644 index e74cf57f2..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/embeddingrequest.ts +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - EmbeddingDtype, - EmbeddingDtype$inboundSchema, - EmbeddingDtype$outboundSchema, -} from "./embeddingdtype.js"; -import { - EncodingFormat, - EncodingFormat$inboundSchema, - EncodingFormat$outboundSchema, -} from "./encodingformat.js"; - -/** - * Text to embed. - */ -export type EmbeddingRequestInputs = string | Array; - -export type EmbeddingRequest = { - /** - * ID of the model to use. - */ - model: string; - /** - * Text to embed. - */ - inputs: string | Array; - /** - * The dimension of the output embeddings. - */ - outputDimension?: number | null | undefined; - outputDtype?: EmbeddingDtype | undefined; - encodingFormat?: EncodingFormat | undefined; -}; - -/** @internal */ -export const EmbeddingRequestInputs$inboundSchema: z.ZodType< - EmbeddingRequestInputs, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type EmbeddingRequestInputs$Outbound = string | Array; - -/** @internal */ -export const EmbeddingRequestInputs$outboundSchema: z.ZodType< - EmbeddingRequestInputs$Outbound, - z.ZodTypeDef, - EmbeddingRequestInputs -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EmbeddingRequestInputs$ { - /** @deprecated use `EmbeddingRequestInputs$inboundSchema` instead. */ - export const inboundSchema = EmbeddingRequestInputs$inboundSchema; - /** @deprecated use `EmbeddingRequestInputs$outboundSchema` instead. */ - export const outboundSchema = EmbeddingRequestInputs$outboundSchema; - /** @deprecated use `EmbeddingRequestInputs$Outbound` instead. */ - export type Outbound = EmbeddingRequestInputs$Outbound; -} - -export function embeddingRequestInputsToJSON( - embeddingRequestInputs: EmbeddingRequestInputs, -): string { - return JSON.stringify( - EmbeddingRequestInputs$outboundSchema.parse(embeddingRequestInputs), - ); -} - -export function embeddingRequestInputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => EmbeddingRequestInputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'EmbeddingRequestInputs' from JSON`, - ); -} - -/** @internal */ -export const EmbeddingRequest$inboundSchema: z.ZodType< - EmbeddingRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - input: z.union([z.string(), z.array(z.string())]), - output_dimension: z.nullable(z.number().int()).optional(), - output_dtype: EmbeddingDtype$inboundSchema.optional(), - encoding_format: EncodingFormat$inboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - "input": "inputs", - "output_dimension": "outputDimension", - "output_dtype": "outputDtype", - "encoding_format": "encodingFormat", - }); -}); - -/** @internal */ -export type EmbeddingRequest$Outbound = { - model: string; - input: string | Array; - output_dimension?: number | null | undefined; - output_dtype?: string | undefined; - encoding_format?: string | undefined; -}; - -/** @internal */ -export const EmbeddingRequest$outboundSchema: z.ZodType< - EmbeddingRequest$Outbound, - z.ZodTypeDef, - EmbeddingRequest -> = z.object({ - model: z.string(), - inputs: z.union([z.string(), z.array(z.string())]), - outputDimension: z.nullable(z.number().int()).optional(), - outputDtype: EmbeddingDtype$outboundSchema.optional(), - encodingFormat: EncodingFormat$outboundSchema.optional(), -}).transform((v) => { - return remap$(v, { - inputs: "input", - outputDimension: "output_dimension", - outputDtype: "output_dtype", - encodingFormat: "encoding_format", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EmbeddingRequest$ { - /** @deprecated use `EmbeddingRequest$inboundSchema` instead. */ - export const inboundSchema = EmbeddingRequest$inboundSchema; - /** @deprecated use `EmbeddingRequest$outboundSchema` instead. */ - export const outboundSchema = EmbeddingRequest$outboundSchema; - /** @deprecated use `EmbeddingRequest$Outbound` instead. */ - export type Outbound = EmbeddingRequest$Outbound; -} - -export function embeddingRequestToJSON( - embeddingRequest: EmbeddingRequest, -): string { - return JSON.stringify( - EmbeddingRequest$outboundSchema.parse(embeddingRequest), - ); -} - -export function embeddingRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => EmbeddingRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'EmbeddingRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/embeddingresponse.ts b/examples/sdks/mistral-typescript/src/models/components/embeddingresponse.ts deleted file mode 100644 index d704603f2..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/embeddingresponse.ts +++ /dev/null @@ -1,94 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - EmbeddingResponseData, - EmbeddingResponseData$inboundSchema, - EmbeddingResponseData$Outbound, - EmbeddingResponseData$outboundSchema, -} from "./embeddingresponsedata.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type EmbeddingResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - data: Array; -}; - -/** @internal */ -export const EmbeddingResponse$inboundSchema: z.ZodType< - EmbeddingResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - data: z.array(EmbeddingResponseData$inboundSchema), -}); - -/** @internal */ -export type EmbeddingResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - data: Array; -}; - -/** @internal */ -export const EmbeddingResponse$outboundSchema: z.ZodType< - EmbeddingResponse$Outbound, - z.ZodTypeDef, - EmbeddingResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - data: z.array(EmbeddingResponseData$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EmbeddingResponse$ { - /** @deprecated use `EmbeddingResponse$inboundSchema` instead. */ - export const inboundSchema = EmbeddingResponse$inboundSchema; - /** @deprecated use `EmbeddingResponse$outboundSchema` instead. */ - export const outboundSchema = EmbeddingResponse$outboundSchema; - /** @deprecated use `EmbeddingResponse$Outbound` instead. */ - export type Outbound = EmbeddingResponse$Outbound; -} - -export function embeddingResponseToJSON( - embeddingResponse: EmbeddingResponse, -): string { - return JSON.stringify( - EmbeddingResponse$outboundSchema.parse(embeddingResponse), - ); -} - -export function embeddingResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => EmbeddingResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'EmbeddingResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/embeddingresponsedata.ts b/examples/sdks/mistral-typescript/src/models/components/embeddingresponsedata.ts deleted file mode 100644 index fec58adc0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/embeddingresponsedata.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type EmbeddingResponseData = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -/** @internal */ -export const EmbeddingResponseData$inboundSchema: z.ZodType< - EmbeddingResponseData, - z.ZodTypeDef, - unknown -> = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional(), -}); - -/** @internal */ -export type EmbeddingResponseData$Outbound = { - object?: string | undefined; - embedding?: Array | undefined; - index?: number | undefined; -}; - -/** @internal */ -export const EmbeddingResponseData$outboundSchema: z.ZodType< - EmbeddingResponseData$Outbound, - z.ZodTypeDef, - EmbeddingResponseData -> = z.object({ - object: z.string().optional(), - embedding: z.array(z.number()).optional(), - index: z.number().int().optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EmbeddingResponseData$ { - /** @deprecated use `EmbeddingResponseData$inboundSchema` instead. */ - export const inboundSchema = EmbeddingResponseData$inboundSchema; - /** @deprecated use `EmbeddingResponseData$outboundSchema` instead. */ - export const outboundSchema = EmbeddingResponseData$outboundSchema; - /** @deprecated use `EmbeddingResponseData$Outbound` instead. */ - export type Outbound = EmbeddingResponseData$Outbound; -} - -export function embeddingResponseDataToJSON( - embeddingResponseData: EmbeddingResponseData, -): string { - return JSON.stringify( - EmbeddingResponseData$outboundSchema.parse(embeddingResponseData), - ); -} - -export function embeddingResponseDataFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => EmbeddingResponseData$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'EmbeddingResponseData' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/encodingformat.ts b/examples/sdks/mistral-typescript/src/models/components/encodingformat.ts deleted file mode 100644 index 37d6e211b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/encodingformat.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const EncodingFormat = { - Float: "float", - Base64: "base64", -} as const; -export type EncodingFormat = ClosedEnum; - -/** @internal */ -export const EncodingFormat$inboundSchema: z.ZodNativeEnum< - typeof EncodingFormat -> = z.nativeEnum(EncodingFormat); - -/** @internal */ -export const EncodingFormat$outboundSchema: z.ZodNativeEnum< - typeof EncodingFormat -> = EncodingFormat$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EncodingFormat$ { - /** @deprecated use `EncodingFormat$inboundSchema` instead. */ - export const inboundSchema = EncodingFormat$inboundSchema; - /** @deprecated use `EncodingFormat$outboundSchema` instead. */ - export const outboundSchema = EncodingFormat$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/entitytype.ts b/examples/sdks/mistral-typescript/src/models/components/entitytype.ts deleted file mode 100644 index b17f16e3a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/entitytype.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -/** - * The type of entity, used to share a library. - */ -export const EntityType = { - User: "User", - Workspace: "Workspace", - Org: "Org", -} as const; -/** - * The type of entity, used to share a library. - */ -export type EntityType = OpenEnum; - -/** @internal */ -export const EntityType$inboundSchema: z.ZodType< - EntityType, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(EntityType), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const EntityType$outboundSchema: z.ZodType< - EntityType, - z.ZodTypeDef, - EntityType -> = z.union([ - z.nativeEnum(EntityType), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EntityType$ { - /** @deprecated use `EntityType$inboundSchema` instead. */ - export const inboundSchema = EntityType$inboundSchema; - /** @deprecated use `EntityType$outboundSchema` instead. */ - export const outboundSchema = EntityType$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/eventout.ts b/examples/sdks/mistral-typescript/src/models/components/eventout.ts deleted file mode 100644 index e6fd92e37..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/eventout.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type EventOut = { - /** - * The name of the event. - */ - name: string; - data?: { [k: string]: any } | null | undefined; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; -}; - -/** @internal */ -export const EventOut$inboundSchema: z.ZodType< - EventOut, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - created_at: z.number().int(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - }); -}); - -/** @internal */ -export type EventOut$Outbound = { - name: string; - data?: { [k: string]: any } | null | undefined; - created_at: number; -}; - -/** @internal */ -export const EventOut$outboundSchema: z.ZodType< - EventOut$Outbound, - z.ZodTypeDef, - EventOut -> = z.object({ - name: z.string(), - data: z.nullable(z.record(z.any())).optional(), - createdAt: z.number().int(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace EventOut$ { - /** @deprecated use `EventOut$inboundSchema` instead. */ - export const inboundSchema = EventOut$inboundSchema; - /** @deprecated use `EventOut$outboundSchema` instead. */ - export const outboundSchema = EventOut$outboundSchema; - /** @deprecated use `EventOut$Outbound` instead. */ - export type Outbound = EventOut$Outbound; -} - -export function eventOutToJSON(eventOut: EventOut): string { - return JSON.stringify(EventOut$outboundSchema.parse(eventOut)); -} - -export function eventOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => EventOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'EventOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/file.ts b/examples/sdks/mistral-typescript/src/models/components/file.ts deleted file mode 100644 index 775144d7b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/file.ts +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FileT = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -export const FileT$inboundSchema: z.ZodType = z - .object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array), - ]), - }); - -/** @internal */ -export type FileT$Outbound = { - fileName: string; - content: ReadableStream | Blob | ArrayBuffer | Uint8Array; -}; - -/** @internal */ -export const FileT$outboundSchema: z.ZodType< - FileT$Outbound, - z.ZodTypeDef, - FileT -> = z.object({ - fileName: z.string(), - content: z.union([ - z.instanceof(ReadableStream), - z.instanceof(Blob), - z.instanceof(ArrayBuffer), - z.instanceof(Uint8Array), - ]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FileT$ { - /** @deprecated use `FileT$inboundSchema` instead. */ - export const inboundSchema = FileT$inboundSchema; - /** @deprecated use `FileT$outboundSchema` instead. */ - export const outboundSchema = FileT$outboundSchema; - /** @deprecated use `FileT$Outbound` instead. */ - export type Outbound = FileT$Outbound; -} - -export function fileToJSON(fileT: FileT): string { - return JSON.stringify(FileT$outboundSchema.parse(fileT)); -} - -export function fileFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FileT$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FileT' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/filechunk.ts b/examples/sdks/mistral-typescript/src/models/components/filechunk.ts deleted file mode 100644 index 8802c335f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/filechunk.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FileChunk = { - type?: "file" | undefined; - fileId: string; -}; - -/** @internal */ -export const FileChunk$inboundSchema: z.ZodType< - FileChunk, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("file").default("file"), - file_id: z.string(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FileChunk$Outbound = { - type: "file"; - file_id: string; -}; - -/** @internal */ -export const FileChunk$outboundSchema: z.ZodType< - FileChunk$Outbound, - z.ZodTypeDef, - FileChunk -> = z.object({ - type: z.literal("file").default("file" as const), - fileId: z.string(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FileChunk$ { - /** @deprecated use `FileChunk$inboundSchema` instead. */ - export const inboundSchema = FileChunk$inboundSchema; - /** @deprecated use `FileChunk$outboundSchema` instead. */ - export const outboundSchema = FileChunk$outboundSchema; - /** @deprecated use `FileChunk$Outbound` instead. */ - export type Outbound = FileChunk$Outbound; -} - -export function fileChunkToJSON(fileChunk: FileChunk): string { - return JSON.stringify(FileChunk$outboundSchema.parse(fileChunk)); -} - -export function fileChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FileChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FileChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/filepurpose.ts b/examples/sdks/mistral-typescript/src/models/components/filepurpose.ts deleted file mode 100644 index a2126a31a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/filepurpose.ts +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const FilePurpose = { - FineTune: "fine-tune", - Batch: "batch", - Ocr: "ocr", -} as const; -export type FilePurpose = OpenEnum; - -/** @internal */ -export const FilePurpose$inboundSchema: z.ZodType< - FilePurpose, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(FilePurpose), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const FilePurpose$outboundSchema: z.ZodType< - FilePurpose, - z.ZodTypeDef, - FilePurpose -> = z.union([ - z.nativeEnum(FilePurpose), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilePurpose$ { - /** @deprecated use `FilePurpose$inboundSchema` instead. */ - export const inboundSchema = FilePurpose$inboundSchema; - /** @deprecated use `FilePurpose$outboundSchema` instead. */ - export const outboundSchema = FilePurpose$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/fileschema.ts b/examples/sdks/mistral-typescript/src/models/components/fileschema.ts deleted file mode 100644 index 9363fd106..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/fileschema.ts +++ /dev/null @@ -1,147 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, -} from "./filepurpose.js"; -import { - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, -} from "./sampletype.js"; -import { - Source, - Source$inboundSchema, - Source$outboundSchema, -} from "./source.js"; - -export type FileSchema = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -/** @internal */ -export const FileSchema$inboundSchema: z.ZodType< - FileSchema, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: FilePurpose$inboundSchema, - sample_type: SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$inboundSchema, - signature: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines", - }); -}); - -/** @internal */ -export type FileSchema$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -export const FileSchema$outboundSchema: z.ZodType< - FileSchema$Outbound, - z.ZodTypeDef, - FileSchema -> = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: FilePurpose$outboundSchema, - sampleType: SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$outboundSchema, - signature: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FileSchema$ { - /** @deprecated use `FileSchema$inboundSchema` instead. */ - export const inboundSchema = FileSchema$inboundSchema; - /** @deprecated use `FileSchema$outboundSchema` instead. */ - export const outboundSchema = FileSchema$outboundSchema; - /** @deprecated use `FileSchema$Outbound` instead. */ - export type Outbound = FileSchema$Outbound; -} - -export function fileSchemaToJSON(fileSchema: FileSchema): string { - return JSON.stringify(FileSchema$outboundSchema.parse(fileSchema)); -} - -export function fileSchemaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FileSchema$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FileSchema' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/filesignedurl.ts b/examples/sdks/mistral-typescript/src/models/components/filesignedurl.ts deleted file mode 100644 index 556ec93ca..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/filesignedurl.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FileSignedURL = { - url: string; -}; - -/** @internal */ -export const FileSignedURL$inboundSchema: z.ZodType< - FileSignedURL, - z.ZodTypeDef, - unknown -> = z.object({ - url: z.string(), -}); - -/** @internal */ -export type FileSignedURL$Outbound = { - url: string; -}; - -/** @internal */ -export const FileSignedURL$outboundSchema: z.ZodType< - FileSignedURL$Outbound, - z.ZodTypeDef, - FileSignedURL -> = z.object({ - url: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FileSignedURL$ { - /** @deprecated use `FileSignedURL$inboundSchema` instead. */ - export const inboundSchema = FileSignedURL$inboundSchema; - /** @deprecated use `FileSignedURL$outboundSchema` instead. */ - export const outboundSchema = FileSignedURL$outboundSchema; - /** @deprecated use `FileSignedURL$Outbound` instead. */ - export type Outbound = FileSignedURL$Outbound; -} - -export function fileSignedURLToJSON(fileSignedURL: FileSignedURL): string { - return JSON.stringify(FileSignedURL$outboundSchema.parse(fileSignedURL)); -} - -export function fileSignedURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FileSignedURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FileSignedURL' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/fimcompletionrequest.ts b/examples/sdks/mistral-typescript/src/models/components/fimcompletionrequest.ts deleted file mode 100644 index fa84ca1ef..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/fimcompletionrequest.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type FIMCompletionRequestStop = string | Array; - -export type FIMCompletionRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - /** - * Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionRequestStop$inboundSchema: z.ZodType< - FIMCompletionRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type FIMCompletionRequestStop$Outbound = string | Array; - -/** @internal */ -export const FIMCompletionRequestStop$outboundSchema: z.ZodType< - FIMCompletionRequestStop$Outbound, - z.ZodTypeDef, - FIMCompletionRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionRequestStop$ { - /** @deprecated use `FIMCompletionRequestStop$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionRequestStop$inboundSchema; - /** @deprecated use `FIMCompletionRequestStop$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionRequestStop$outboundSchema; - /** @deprecated use `FIMCompletionRequestStop$Outbound` instead. */ - export type Outbound = FIMCompletionRequestStop$Outbound; -} - -export function fimCompletionRequestStopToJSON( - fimCompletionRequestStop: FIMCompletionRequestStop, -): string { - return JSON.stringify( - FIMCompletionRequestStop$outboundSchema.parse(fimCompletionRequestStop), - ); -} - -export function fimCompletionRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionRequestStop' from JSON`, - ); -} - -/** @internal */ -export const FIMCompletionRequest$inboundSchema: z.ZodType< - FIMCompletionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens", - }); -}); - -/** @internal */ -export type FIMCompletionRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionRequest$outboundSchema: z.ZodType< - FIMCompletionRequest$Outbound, - z.ZodTypeDef, - FIMCompletionRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(false), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionRequest$ { - /** @deprecated use `FIMCompletionRequest$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionRequest$inboundSchema; - /** @deprecated use `FIMCompletionRequest$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionRequest$outboundSchema; - /** @deprecated use `FIMCompletionRequest$Outbound` instead. */ - export type Outbound = FIMCompletionRequest$Outbound; -} - -export function fimCompletionRequestToJSON( - fimCompletionRequest: FIMCompletionRequest, -): string { - return JSON.stringify( - FIMCompletionRequest$outboundSchema.parse(fimCompletionRequest), - ); -} - -export function fimCompletionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/fimcompletionresponse.ts b/examples/sdks/mistral-typescript/src/models/components/fimcompletionresponse.ts deleted file mode 100644 index 3877623ef..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/fimcompletionresponse.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ChatCompletionChoice, - ChatCompletionChoice$inboundSchema, - ChatCompletionChoice$Outbound, - ChatCompletionChoice$outboundSchema, -} from "./chatcompletionchoice.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type FIMCompletionResponse = { - id: string; - object: string; - model: string; - usage: UsageInfo; - created: number; - choices: Array; -}; - -/** @internal */ -export const FIMCompletionResponse$inboundSchema: z.ZodType< - FIMCompletionResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$inboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$inboundSchema), -}); - -/** @internal */ -export type FIMCompletionResponse$Outbound = { - id: string; - object: string; - model: string; - usage: UsageInfo$Outbound; - created: number; - choices: Array; -}; - -/** @internal */ -export const FIMCompletionResponse$outboundSchema: z.ZodType< - FIMCompletionResponse$Outbound, - z.ZodTypeDef, - FIMCompletionResponse -> = z.object({ - id: z.string(), - object: z.string(), - model: z.string(), - usage: UsageInfo$outboundSchema, - created: z.number().int(), - choices: z.array(ChatCompletionChoice$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionResponse$ { - /** @deprecated use `FIMCompletionResponse$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionResponse$inboundSchema; - /** @deprecated use `FIMCompletionResponse$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionResponse$outboundSchema; - /** @deprecated use `FIMCompletionResponse$Outbound` instead. */ - export type Outbound = FIMCompletionResponse$Outbound; -} - -export function fimCompletionResponseToJSON( - fimCompletionResponse: FIMCompletionResponse, -): string { - return JSON.stringify( - FIMCompletionResponse$outboundSchema.parse(fimCompletionResponse), - ); -} - -export function fimCompletionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/fimcompletionstreamrequest.ts b/examples/sdks/mistral-typescript/src/models/components/fimcompletionstreamrequest.ts deleted file mode 100644 index eea6ee278..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/fimcompletionstreamrequest.ts +++ /dev/null @@ -1,203 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ -export type FIMCompletionStreamRequestStop = string | Array; - -export type FIMCompletionStreamRequest = { - /** - * ID of the model to use. Only compatible for now with: - * - * @remarks - * - `codestral-2405` - * - `codestral-latest` - */ - model: string; - /** - * What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - */ - temperature?: number | null | undefined; - /** - * Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - */ - topP?: number | undefined; - /** - * The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - */ - maxTokens?: number | null | undefined; - stream?: boolean | undefined; - /** - * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - */ - stop?: string | Array | undefined; - /** - * The seed to use for random sampling. If set, different calls will generate deterministic results. - */ - randomSeed?: number | null | undefined; - /** - * The text/code to complete. - */ - prompt: string; - /** - * Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - */ - suffix?: string | null | undefined; - /** - * The minimum number of tokens to generate in the completion. - */ - minTokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionStreamRequestStop$inboundSchema: z.ZodType< - FIMCompletionStreamRequestStop, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(z.string())]); - -/** @internal */ -export type FIMCompletionStreamRequestStop$Outbound = string | Array; - -/** @internal */ -export const FIMCompletionStreamRequestStop$outboundSchema: z.ZodType< - FIMCompletionStreamRequestStop$Outbound, - z.ZodTypeDef, - FIMCompletionStreamRequestStop -> = z.union([z.string(), z.array(z.string())]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionStreamRequestStop$ { - /** @deprecated use `FIMCompletionStreamRequestStop$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionStreamRequestStop$inboundSchema; - /** @deprecated use `FIMCompletionStreamRequestStop$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionStreamRequestStop$outboundSchema; - /** @deprecated use `FIMCompletionStreamRequestStop$Outbound` instead. */ - export type Outbound = FIMCompletionStreamRequestStop$Outbound; -} - -export function fimCompletionStreamRequestStopToJSON( - fimCompletionStreamRequestStop: FIMCompletionStreamRequestStop, -): string { - return JSON.stringify( - FIMCompletionStreamRequestStop$outboundSchema.parse( - fimCompletionStreamRequestStop, - ), - ); -} - -export function fimCompletionStreamRequestStopFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionStreamRequestStop$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionStreamRequestStop' from JSON`, - ); -} - -/** @internal */ -export const FIMCompletionStreamRequest$inboundSchema: z.ZodType< - FIMCompletionStreamRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - top_p: z.number().default(1), - max_tokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - random_seed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - min_tokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "top_p": "topP", - "max_tokens": "maxTokens", - "random_seed": "randomSeed", - "min_tokens": "minTokens", - }); -}); - -/** @internal */ -export type FIMCompletionStreamRequest$Outbound = { - model: string; - temperature?: number | null | undefined; - top_p: number; - max_tokens?: number | null | undefined; - stream: boolean; - stop?: string | Array | undefined; - random_seed?: number | null | undefined; - prompt: string; - suffix?: string | null | undefined; - min_tokens?: number | null | undefined; -}; - -/** @internal */ -export const FIMCompletionStreamRequest$outboundSchema: z.ZodType< - FIMCompletionStreamRequest$Outbound, - z.ZodTypeDef, - FIMCompletionStreamRequest -> = z.object({ - model: z.string(), - temperature: z.nullable(z.number()).optional(), - topP: z.number().default(1), - maxTokens: z.nullable(z.number().int()).optional(), - stream: z.boolean().default(true), - stop: z.union([z.string(), z.array(z.string())]).optional(), - randomSeed: z.nullable(z.number().int()).optional(), - prompt: z.string(), - suffix: z.nullable(z.string()).optional(), - minTokens: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - topP: "top_p", - maxTokens: "max_tokens", - randomSeed: "random_seed", - minTokens: "min_tokens", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FIMCompletionStreamRequest$ { - /** @deprecated use `FIMCompletionStreamRequest$inboundSchema` instead. */ - export const inboundSchema = FIMCompletionStreamRequest$inboundSchema; - /** @deprecated use `FIMCompletionStreamRequest$outboundSchema` instead. */ - export const outboundSchema = FIMCompletionStreamRequest$outboundSchema; - /** @deprecated use `FIMCompletionStreamRequest$Outbound` instead. */ - export type Outbound = FIMCompletionStreamRequest$Outbound; -} - -export function fimCompletionStreamRequestToJSON( - fimCompletionStreamRequest: FIMCompletionStreamRequest, -): string { - return JSON.stringify( - FIMCompletionStreamRequest$outboundSchema.parse(fimCompletionStreamRequest), - ); -} - -export function fimCompletionStreamRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FIMCompletionStreamRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FIMCompletionStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/finetuneablemodeltype.ts b/examples/sdks/mistral-typescript/src/models/components/finetuneablemodeltype.ts deleted file mode 100644 index 8c1b85037..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/finetuneablemodeltype.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const FineTuneableModelType = { - Completion: "completion", - Classifier: "classifier", -} as const; -export type FineTuneableModelType = ClosedEnum; - -/** @internal */ -export const FineTuneableModelType$inboundSchema: z.ZodNativeEnum< - typeof FineTuneableModelType -> = z.nativeEnum(FineTuneableModelType); - -/** @internal */ -export const FineTuneableModelType$outboundSchema: z.ZodNativeEnum< - typeof FineTuneableModelType -> = FineTuneableModelType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FineTuneableModelType$ { - /** @deprecated use `FineTuneableModelType$inboundSchema` instead. */ - export const inboundSchema = FineTuneableModelType$inboundSchema; - /** @deprecated use `FineTuneableModelType$outboundSchema` instead. */ - export const outboundSchema = FineTuneableModelType$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ftclassifierlossfunction.ts b/examples/sdks/mistral-typescript/src/models/components/ftclassifierlossfunction.ts deleted file mode 100644 index 0d6e6352d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ftclassifierlossfunction.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const FTClassifierLossFunction = { - SingleClass: "single_class", - MultiClass: "multi_class", -} as const; -export type FTClassifierLossFunction = ClosedEnum< - typeof FTClassifierLossFunction ->; - -/** @internal */ -export const FTClassifierLossFunction$inboundSchema: z.ZodNativeEnum< - typeof FTClassifierLossFunction -> = z.nativeEnum(FTClassifierLossFunction); - -/** @internal */ -export const FTClassifierLossFunction$outboundSchema: z.ZodNativeEnum< - typeof FTClassifierLossFunction -> = FTClassifierLossFunction$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FTClassifierLossFunction$ { - /** @deprecated use `FTClassifierLossFunction$inboundSchema` instead. */ - export const inboundSchema = FTClassifierLossFunction$inboundSchema; - /** @deprecated use `FTClassifierLossFunction$outboundSchema` instead. */ - export const outboundSchema = FTClassifierLossFunction$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ftmodelcapabilitiesout.ts b/examples/sdks/mistral-typescript/src/models/components/ftmodelcapabilitiesout.ts deleted file mode 100644 index f9aaa6072..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ftmodelcapabilitiesout.ts +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FTModelCapabilitiesOut = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - classification?: boolean | undefined; -}; - -/** @internal */ -export const FTModelCapabilitiesOut$inboundSchema: z.ZodType< - FTModelCapabilitiesOut, - z.ZodTypeDef, - unknown -> = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(false), - fine_tuning: z.boolean().default(false), - classification: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning", - }); -}); - -/** @internal */ -export type FTModelCapabilitiesOut$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - classification: boolean; -}; - -/** @internal */ -export const FTModelCapabilitiesOut$outboundSchema: z.ZodType< - FTModelCapabilitiesOut$Outbound, - z.ZodTypeDef, - FTModelCapabilitiesOut -> = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(false), - fineTuning: z.boolean().default(false), - classification: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FTModelCapabilitiesOut$ { - /** @deprecated use `FTModelCapabilitiesOut$inboundSchema` instead. */ - export const inboundSchema = FTModelCapabilitiesOut$inboundSchema; - /** @deprecated use `FTModelCapabilitiesOut$outboundSchema` instead. */ - export const outboundSchema = FTModelCapabilitiesOut$outboundSchema; - /** @deprecated use `FTModelCapabilitiesOut$Outbound` instead. */ - export type Outbound = FTModelCapabilitiesOut$Outbound; -} - -export function ftModelCapabilitiesOutToJSON( - ftModelCapabilitiesOut: FTModelCapabilitiesOut, -): string { - return JSON.stringify( - FTModelCapabilitiesOut$outboundSchema.parse(ftModelCapabilitiesOut), - ); -} - -export function ftModelCapabilitiesOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FTModelCapabilitiesOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FTModelCapabilitiesOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ftmodelcard.ts b/examples/sdks/mistral-typescript/src/models/components/ftmodelcard.ts deleted file mode 100644 index d223f766e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ftmodelcard.ts +++ /dev/null @@ -1,175 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ModelCapabilities, - ModelCapabilities$inboundSchema, - ModelCapabilities$Outbound, - ModelCapabilities$outboundSchema, -} from "./modelcapabilities.js"; - -export const FTModelCardType = { - FineTuned: "fine-tuned", -} as const; -export type FTModelCardType = ClosedEnum; - -/** - * Extra fields for fine-tuned models. - */ -export type FTModelCard = { - id: string; - object?: string | undefined; - created?: number | undefined; - ownedBy?: string | undefined; - capabilities: ModelCapabilities; - name?: string | null | undefined; - description?: string | null | undefined; - maxContextLength?: number | undefined; - aliases?: Array | undefined; - deprecation?: Date | null | undefined; - deprecationReplacementModel?: string | null | undefined; - defaultModelTemperature?: number | null | undefined; - type?: "fine-tuned" | undefined; - job: string; - root: string; - archived?: boolean | undefined; -}; - -/** @internal */ -export const FTModelCardType$inboundSchema: z.ZodNativeEnum< - typeof FTModelCardType -> = z.nativeEnum(FTModelCardType); - -/** @internal */ -export const FTModelCardType$outboundSchema: z.ZodNativeEnum< - typeof FTModelCardType -> = FTModelCardType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FTModelCardType$ { - /** @deprecated use `FTModelCardType$inboundSchema` instead. */ - export const inboundSchema = FTModelCardType$inboundSchema; - /** @deprecated use `FTModelCardType$outboundSchema` instead. */ - export const outboundSchema = FTModelCardType$outboundSchema; -} - -/** @internal */ -export const FTModelCard$inboundSchema: z.ZodType< - FTModelCard, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - owned_by: z.string().default("mistralai"), - capabilities: ModelCapabilities$inboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - max_context_length: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - deprecation_replacement_model: z.nullable(z.string()).optional(), - default_model_temperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - "owned_by": "ownedBy", - "max_context_length": "maxContextLength", - "deprecation_replacement_model": "deprecationReplacementModel", - "default_model_temperature": "defaultModelTemperature", - }); -}); - -/** @internal */ -export type FTModelCard$Outbound = { - id: string; - object: string; - created?: number | undefined; - owned_by: string; - capabilities: ModelCapabilities$Outbound; - name?: string | null | undefined; - description?: string | null | undefined; - max_context_length: number; - aliases?: Array | undefined; - deprecation?: string | null | undefined; - deprecation_replacement_model?: string | null | undefined; - default_model_temperature?: number | null | undefined; - type: "fine-tuned"; - job: string; - root: string; - archived: boolean; -}; - -/** @internal */ -export const FTModelCard$outboundSchema: z.ZodType< - FTModelCard$Outbound, - z.ZodTypeDef, - FTModelCard -> = z.object({ - id: z.string(), - object: z.string().default("model"), - created: z.number().int().optional(), - ownedBy: z.string().default("mistralai"), - capabilities: ModelCapabilities$outboundSchema, - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - maxContextLength: z.number().int().default(32768), - aliases: z.array(z.string()).optional(), - deprecation: z.nullable(z.date().transform(v => v.toISOString())).optional(), - deprecationReplacementModel: z.nullable(z.string()).optional(), - defaultModelTemperature: z.nullable(z.number()).optional(), - type: z.literal("fine-tuned").default("fine-tuned"), - job: z.string(), - root: z.string(), - archived: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - ownedBy: "owned_by", - maxContextLength: "max_context_length", - deprecationReplacementModel: "deprecation_replacement_model", - defaultModelTemperature: "default_model_temperature", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FTModelCard$ { - /** @deprecated use `FTModelCard$inboundSchema` instead. */ - export const inboundSchema = FTModelCard$inboundSchema; - /** @deprecated use `FTModelCard$outboundSchema` instead. */ - export const outboundSchema = FTModelCard$outboundSchema; - /** @deprecated use `FTModelCard$Outbound` instead. */ - export type Outbound = FTModelCard$Outbound; -} - -export function ftModelCardToJSON(ftModelCard: FTModelCard): string { - return JSON.stringify(FTModelCard$outboundSchema.parse(ftModelCard)); -} - -export function ftModelCardFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FTModelCard$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FTModelCard' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/function.ts b/examples/sdks/mistral-typescript/src/models/components/function.ts deleted file mode 100644 index daa47c664..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/function.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FunctionT = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$inboundSchema: z.ZodType< - FunctionT, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** @internal */ -export type FunctionT$Outbound = { - name: string; - description?: string | undefined; - strict?: boolean | undefined; - parameters: { [k: string]: any }; -}; - -/** @internal */ -export const FunctionT$outboundSchema: z.ZodType< - FunctionT$Outbound, - z.ZodTypeDef, - FunctionT -> = z.object({ - name: z.string(), - description: z.string().optional(), - strict: z.boolean().optional(), - parameters: z.record(z.any()), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionT$ { - /** @deprecated use `FunctionT$inboundSchema` instead. */ - export const inboundSchema = FunctionT$inboundSchema; - /** @deprecated use `FunctionT$outboundSchema` instead. */ - export const outboundSchema = FunctionT$outboundSchema; - /** @deprecated use `FunctionT$Outbound` instead. */ - export type Outbound = FunctionT$Outbound; -} - -export function functionToJSON(functionT: FunctionT): string { - return JSON.stringify(FunctionT$outboundSchema.parse(functionT)); -} - -export function functionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionT$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionT' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functioncall.ts b/examples/sdks/mistral-typescript/src/models/components/functioncall.ts deleted file mode 100644 index ffaa036a8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functioncall.ts +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Arguments = { [k: string]: any } | string; - -export type FunctionCall = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const Arguments$inboundSchema: z.ZodType< - Arguments, - z.ZodTypeDef, - unknown -> = z.union([z.record(z.any()), z.string()]); - -/** @internal */ -export type Arguments$Outbound = { [k: string]: any } | string; - -/** @internal */ -export const Arguments$outboundSchema: z.ZodType< - Arguments$Outbound, - z.ZodTypeDef, - Arguments -> = z.union([z.record(z.any()), z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Arguments$ { - /** @deprecated use `Arguments$inboundSchema` instead. */ - export const inboundSchema = Arguments$inboundSchema; - /** @deprecated use `Arguments$outboundSchema` instead. */ - export const outboundSchema = Arguments$outboundSchema; - /** @deprecated use `Arguments$Outbound` instead. */ - export type Outbound = Arguments$Outbound; -} - -export function argumentsToJSON(value: Arguments): string { - return JSON.stringify(Arguments$outboundSchema.parse(value)); -} - -export function argumentsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Arguments$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Arguments' from JSON`, - ); -} - -/** @internal */ -export const FunctionCall$inboundSchema: z.ZodType< - FunctionCall, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** @internal */ -export type FunctionCall$Outbound = { - name: string; - arguments: { [k: string]: any } | string; -}; - -/** @internal */ -export const FunctionCall$outboundSchema: z.ZodType< - FunctionCall$Outbound, - z.ZodTypeDef, - FunctionCall -> = z.object({ - name: z.string(), - arguments: z.union([z.record(z.any()), z.string()]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCall$ { - /** @deprecated use `FunctionCall$inboundSchema` instead. */ - export const inboundSchema = FunctionCall$inboundSchema; - /** @deprecated use `FunctionCall$outboundSchema` instead. */ - export const outboundSchema = FunctionCall$outboundSchema; - /** @deprecated use `FunctionCall$Outbound` instead. */ - export type Outbound = FunctionCall$Outbound; -} - -export function functionCallToJSON(functionCall: FunctionCall): string { - return JSON.stringify(FunctionCall$outboundSchema.parse(functionCall)); -} - -export function functionCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functioncallentry.ts b/examples/sdks/mistral-typescript/src/models/components/functioncallentry.ts deleted file mode 100644 index 88823a4f8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functioncallentry.ts +++ /dev/null @@ -1,171 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionCallEntryArguments, - FunctionCallEntryArguments$inboundSchema, - FunctionCallEntryArguments$Outbound, - FunctionCallEntryArguments$outboundSchema, -} from "./functioncallentryarguments.js"; - -export const FunctionCallEntryObject = { - Entry: "entry", -} as const; -export type FunctionCallEntryObject = ClosedEnum< - typeof FunctionCallEntryObject ->; - -export const FunctionCallEntryType = { - FunctionCall: "function.call", -} as const; -export type FunctionCallEntryType = ClosedEnum; - -export type FunctionCallEntry = { - object?: FunctionCallEntryObject | undefined; - type?: FunctionCallEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - name: string; - arguments: FunctionCallEntryArguments; -}; - -/** @internal */ -export const FunctionCallEntryObject$inboundSchema: z.ZodNativeEnum< - typeof FunctionCallEntryObject -> = z.nativeEnum(FunctionCallEntryObject); - -/** @internal */ -export const FunctionCallEntryObject$outboundSchema: z.ZodNativeEnum< - typeof FunctionCallEntryObject -> = FunctionCallEntryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEntryObject$ { - /** @deprecated use `FunctionCallEntryObject$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEntryObject$inboundSchema; - /** @deprecated use `FunctionCallEntryObject$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEntryObject$outboundSchema; -} - -/** @internal */ -export const FunctionCallEntryType$inboundSchema: z.ZodNativeEnum< - typeof FunctionCallEntryType -> = z.nativeEnum(FunctionCallEntryType); - -/** @internal */ -export const FunctionCallEntryType$outboundSchema: z.ZodNativeEnum< - typeof FunctionCallEntryType -> = FunctionCallEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEntryType$ { - /** @deprecated use `FunctionCallEntryType$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEntryType$inboundSchema; - /** @deprecated use `FunctionCallEntryType$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEntryType$outboundSchema; -} - -/** @internal */ -export const FunctionCallEntry$inboundSchema: z.ZodType< - FunctionCallEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: FunctionCallEntryObject$inboundSchema.default("entry"), - type: FunctionCallEntryType$inboundSchema.default("function.call"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - name: z.string(), - arguments: FunctionCallEntryArguments$inboundSchema, -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type FunctionCallEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - name: string; - arguments: FunctionCallEntryArguments$Outbound; -}; - -/** @internal */ -export const FunctionCallEntry$outboundSchema: z.ZodType< - FunctionCallEntry$Outbound, - z.ZodTypeDef, - FunctionCallEntry -> = z.object({ - object: FunctionCallEntryObject$outboundSchema.default("entry"), - type: FunctionCallEntryType$outboundSchema.default("function.call"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - name: z.string(), - arguments: FunctionCallEntryArguments$outboundSchema, -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEntry$ { - /** @deprecated use `FunctionCallEntry$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEntry$inboundSchema; - /** @deprecated use `FunctionCallEntry$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEntry$outboundSchema; - /** @deprecated use `FunctionCallEntry$Outbound` instead. */ - export type Outbound = FunctionCallEntry$Outbound; -} - -export function functionCallEntryToJSON( - functionCallEntry: FunctionCallEntry, -): string { - return JSON.stringify( - FunctionCallEntry$outboundSchema.parse(functionCallEntry), - ); -} - -export function functionCallEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCallEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCallEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functioncallentryarguments.ts b/examples/sdks/mistral-typescript/src/models/components/functioncallentryarguments.ts deleted file mode 100644 index 09b0b4a71..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functioncallentryarguments.ts +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FunctionCallEntryArguments = { [k: string]: any } | string; - -/** @internal */ -export const FunctionCallEntryArguments$inboundSchema: z.ZodType< - FunctionCallEntryArguments, - z.ZodTypeDef, - unknown -> = z.union([z.record(z.any()), z.string()]); - -/** @internal */ -export type FunctionCallEntryArguments$Outbound = { [k: string]: any } | string; - -/** @internal */ -export const FunctionCallEntryArguments$outboundSchema: z.ZodType< - FunctionCallEntryArguments$Outbound, - z.ZodTypeDef, - FunctionCallEntryArguments -> = z.union([z.record(z.any()), z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEntryArguments$ { - /** @deprecated use `FunctionCallEntryArguments$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEntryArguments$inboundSchema; - /** @deprecated use `FunctionCallEntryArguments$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEntryArguments$outboundSchema; - /** @deprecated use `FunctionCallEntryArguments$Outbound` instead. */ - export type Outbound = FunctionCallEntryArguments$Outbound; -} - -export function functionCallEntryArgumentsToJSON( - functionCallEntryArguments: FunctionCallEntryArguments, -): string { - return JSON.stringify( - FunctionCallEntryArguments$outboundSchema.parse(functionCallEntryArguments), - ); -} - -export function functionCallEntryArgumentsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCallEntryArguments$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCallEntryArguments' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functioncallevent.ts b/examples/sdks/mistral-typescript/src/models/components/functioncallevent.ts deleted file mode 100644 index 230d05a8a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functioncallevent.ts +++ /dev/null @@ -1,131 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const FunctionCallEventType = { - FunctionCallDelta: "function.call.delta", -} as const; -export type FunctionCallEventType = ClosedEnum; - -export type FunctionCallEvent = { - type?: FunctionCallEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: string; - toolCallId: string; - arguments: string; -}; - -/** @internal */ -export const FunctionCallEventType$inboundSchema: z.ZodNativeEnum< - typeof FunctionCallEventType -> = z.nativeEnum(FunctionCallEventType); - -/** @internal */ -export const FunctionCallEventType$outboundSchema: z.ZodNativeEnum< - typeof FunctionCallEventType -> = FunctionCallEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEventType$ { - /** @deprecated use `FunctionCallEventType$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEventType$inboundSchema; - /** @deprecated use `FunctionCallEventType$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEventType$outboundSchema; -} - -/** @internal */ -export const FunctionCallEvent$inboundSchema: z.ZodType< - FunctionCallEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: FunctionCallEventType$inboundSchema.default("function.call.delta"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: z.string(), - tool_call_id: z.string(), - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type FunctionCallEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - tool_call_id: string; - arguments: string; -}; - -/** @internal */ -export const FunctionCallEvent$outboundSchema: z.ZodType< - FunctionCallEvent$Outbound, - z.ZodTypeDef, - FunctionCallEvent -> = z.object({ - type: FunctionCallEventType$outboundSchema.default("function.call.delta"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: z.string(), - toolCallId: z.string(), - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionCallEvent$ { - /** @deprecated use `FunctionCallEvent$inboundSchema` instead. */ - export const inboundSchema = FunctionCallEvent$inboundSchema; - /** @deprecated use `FunctionCallEvent$outboundSchema` instead. */ - export const outboundSchema = FunctionCallEvent$outboundSchema; - /** @deprecated use `FunctionCallEvent$Outbound` instead. */ - export type Outbound = FunctionCallEvent$Outbound; -} - -export function functionCallEventToJSON( - functionCallEvent: FunctionCallEvent, -): string { - return JSON.stringify( - FunctionCallEvent$outboundSchema.parse(functionCallEvent), - ); -} - -export function functionCallEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionCallEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionCallEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functionname.ts b/examples/sdks/mistral-typescript/src/models/components/functionname.ts deleted file mode 100644 index e26279046..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functionname.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * this restriction of `Function` is used to select a specific function to call - */ -export type FunctionName = { - name: string; -}; - -/** @internal */ -export const FunctionName$inboundSchema: z.ZodType< - FunctionName, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), -}); - -/** @internal */ -export type FunctionName$Outbound = { - name: string; -}; - -/** @internal */ -export const FunctionName$outboundSchema: z.ZodType< - FunctionName$Outbound, - z.ZodTypeDef, - FunctionName -> = z.object({ - name: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionName$ { - /** @deprecated use `FunctionName$inboundSchema` instead. */ - export const inboundSchema = FunctionName$inboundSchema; - /** @deprecated use `FunctionName$outboundSchema` instead. */ - export const outboundSchema = FunctionName$outboundSchema; - /** @deprecated use `FunctionName$Outbound` instead. */ - export type Outbound = FunctionName$Outbound; -} - -export function functionNameToJSON(functionName: FunctionName): string { - return JSON.stringify(FunctionName$outboundSchema.parse(functionName)); -} - -export function functionNameFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionName$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionName' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functionresultentry.ts b/examples/sdks/mistral-typescript/src/models/components/functionresultentry.ts deleted file mode 100644 index c35c90492..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functionresultentry.ts +++ /dev/null @@ -1,163 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const FunctionResultEntryObject = { - Entry: "entry", -} as const; -export type FunctionResultEntryObject = ClosedEnum< - typeof FunctionResultEntryObject ->; - -export const FunctionResultEntryType = { - FunctionResult: "function.result", -} as const; -export type FunctionResultEntryType = ClosedEnum< - typeof FunctionResultEntryType ->; - -export type FunctionResultEntry = { - object?: FunctionResultEntryObject | undefined; - type?: FunctionResultEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - toolCallId: string; - result: string; -}; - -/** @internal */ -export const FunctionResultEntryObject$inboundSchema: z.ZodNativeEnum< - typeof FunctionResultEntryObject -> = z.nativeEnum(FunctionResultEntryObject); - -/** @internal */ -export const FunctionResultEntryObject$outboundSchema: z.ZodNativeEnum< - typeof FunctionResultEntryObject -> = FunctionResultEntryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionResultEntryObject$ { - /** @deprecated use `FunctionResultEntryObject$inboundSchema` instead. */ - export const inboundSchema = FunctionResultEntryObject$inboundSchema; - /** @deprecated use `FunctionResultEntryObject$outboundSchema` instead. */ - export const outboundSchema = FunctionResultEntryObject$outboundSchema; -} - -/** @internal */ -export const FunctionResultEntryType$inboundSchema: z.ZodNativeEnum< - typeof FunctionResultEntryType -> = z.nativeEnum(FunctionResultEntryType); - -/** @internal */ -export const FunctionResultEntryType$outboundSchema: z.ZodNativeEnum< - typeof FunctionResultEntryType -> = FunctionResultEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionResultEntryType$ { - /** @deprecated use `FunctionResultEntryType$inboundSchema` instead. */ - export const inboundSchema = FunctionResultEntryType$inboundSchema; - /** @deprecated use `FunctionResultEntryType$outboundSchema` instead. */ - export const outboundSchema = FunctionResultEntryType$outboundSchema; -} - -/** @internal */ -export const FunctionResultEntry$inboundSchema: z.ZodType< - FunctionResultEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: FunctionResultEntryObject$inboundSchema.default("entry"), - type: FunctionResultEntryType$inboundSchema.default("function.result"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - tool_call_id: z.string(), - result: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type FunctionResultEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - tool_call_id: string; - result: string; -}; - -/** @internal */ -export const FunctionResultEntry$outboundSchema: z.ZodType< - FunctionResultEntry$Outbound, - z.ZodTypeDef, - FunctionResultEntry -> = z.object({ - object: FunctionResultEntryObject$outboundSchema.default("entry"), - type: FunctionResultEntryType$outboundSchema.default("function.result"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - toolCallId: z.string(), - result: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionResultEntry$ { - /** @deprecated use `FunctionResultEntry$inboundSchema` instead. */ - export const inboundSchema = FunctionResultEntry$inboundSchema; - /** @deprecated use `FunctionResultEntry$outboundSchema` instead. */ - export const outboundSchema = FunctionResultEntry$outboundSchema; - /** @deprecated use `FunctionResultEntry$Outbound` instead. */ - export type Outbound = FunctionResultEntry$Outbound; -} - -export function functionResultEntryToJSON( - functionResultEntry: FunctionResultEntry, -): string { - return JSON.stringify( - FunctionResultEntry$outboundSchema.parse(functionResultEntry), - ); -} - -export function functionResultEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionResultEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionResultEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/functiontool.ts b/examples/sdks/mistral-typescript/src/models/components/functiontool.ts deleted file mode 100644 index 128076f84..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/functiontool.ts +++ /dev/null @@ -1,99 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, -} from "./function.js"; - -export const FunctionToolType = { - Function: "function", -} as const; -export type FunctionToolType = ClosedEnum; - -export type FunctionTool = { - type?: FunctionToolType | undefined; - function: FunctionT; -}; - -/** @internal */ -export const FunctionToolType$inboundSchema: z.ZodNativeEnum< - typeof FunctionToolType -> = z.nativeEnum(FunctionToolType); - -/** @internal */ -export const FunctionToolType$outboundSchema: z.ZodNativeEnum< - typeof FunctionToolType -> = FunctionToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionToolType$ { - /** @deprecated use `FunctionToolType$inboundSchema` instead. */ - export const inboundSchema = FunctionToolType$inboundSchema; - /** @deprecated use `FunctionToolType$outboundSchema` instead. */ - export const outboundSchema = FunctionToolType$outboundSchema; -} - -/** @internal */ -export const FunctionTool$inboundSchema: z.ZodType< - FunctionTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: FunctionToolType$inboundSchema.default("function"), - function: FunctionT$inboundSchema, -}); - -/** @internal */ -export type FunctionTool$Outbound = { - type: string; - function: FunctionT$Outbound; -}; - -/** @internal */ -export const FunctionTool$outboundSchema: z.ZodType< - FunctionTool$Outbound, - z.ZodTypeDef, - FunctionTool -> = z.object({ - type: FunctionToolType$outboundSchema.default("function"), - function: FunctionT$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FunctionTool$ { - /** @deprecated use `FunctionTool$inboundSchema` instead. */ - export const inboundSchema = FunctionTool$inboundSchema; - /** @deprecated use `FunctionTool$outboundSchema` instead. */ - export const outboundSchema = FunctionTool$outboundSchema; - /** @deprecated use `FunctionTool$Outbound` instead. */ - export type Outbound = FunctionTool$Outbound; -} - -export function functionToolToJSON(functionTool: FunctionTool): string { - return JSON.stringify(FunctionTool$outboundSchema.parse(functionTool)); -} - -export function functionToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FunctionTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FunctionTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/githubrepositoryin.ts b/examples/sdks/mistral-typescript/src/models/components/githubrepositoryin.ts deleted file mode 100644 index b9d87e3b1..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/githubrepositoryin.ts +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const GithubRepositoryInType = { - Github: "github", -} as const; -export type GithubRepositoryInType = ClosedEnum; - -export type GithubRepositoryIn = { - type?: GithubRepositoryInType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - token: string; -}; - -/** @internal */ -export const GithubRepositoryInType$inboundSchema: z.ZodNativeEnum< - typeof GithubRepositoryInType -> = z.nativeEnum(GithubRepositoryInType); - -/** @internal */ -export const GithubRepositoryInType$outboundSchema: z.ZodNativeEnum< - typeof GithubRepositoryInType -> = GithubRepositoryInType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace GithubRepositoryInType$ { - /** @deprecated use `GithubRepositoryInType$inboundSchema` instead. */ - export const inboundSchema = GithubRepositoryInType$inboundSchema; - /** @deprecated use `GithubRepositoryInType$outboundSchema` instead. */ - export const outboundSchema = GithubRepositoryInType$outboundSchema; -} - -/** @internal */ -export const GithubRepositoryIn$inboundSchema: z.ZodType< - GithubRepositoryIn, - z.ZodTypeDef, - unknown -> = z.object({ - type: GithubRepositoryInType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string(), -}); - -/** @internal */ -export type GithubRepositoryIn$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - token: string; -}; - -/** @internal */ -export const GithubRepositoryIn$outboundSchema: z.ZodType< - GithubRepositoryIn$Outbound, - z.ZodTypeDef, - GithubRepositoryIn -> = z.object({ - type: GithubRepositoryInType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - token: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace GithubRepositoryIn$ { - /** @deprecated use `GithubRepositoryIn$inboundSchema` instead. */ - export const inboundSchema = GithubRepositoryIn$inboundSchema; - /** @deprecated use `GithubRepositoryIn$outboundSchema` instead. */ - export const outboundSchema = GithubRepositoryIn$outboundSchema; - /** @deprecated use `GithubRepositoryIn$Outbound` instead. */ - export type Outbound = GithubRepositoryIn$Outbound; -} - -export function githubRepositoryInToJSON( - githubRepositoryIn: GithubRepositoryIn, -): string { - return JSON.stringify( - GithubRepositoryIn$outboundSchema.parse(githubRepositoryIn), - ); -} - -export function githubRepositoryInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => GithubRepositoryIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'GithubRepositoryIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/githubrepositoryout.ts b/examples/sdks/mistral-typescript/src/models/components/githubrepositoryout.ts deleted file mode 100644 index 083f60b8d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/githubrepositoryout.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const GithubRepositoryOutType = { - Github: "github", -} as const; -export type GithubRepositoryOutType = ClosedEnum< - typeof GithubRepositoryOutType ->; - -export type GithubRepositoryOut = { - type?: GithubRepositoryOutType | undefined; - name: string; - owner: string; - ref?: string | null | undefined; - weight?: number | undefined; - commitId: string; -}; - -/** @internal */ -export const GithubRepositoryOutType$inboundSchema: z.ZodNativeEnum< - typeof GithubRepositoryOutType -> = z.nativeEnum(GithubRepositoryOutType); - -/** @internal */ -export const GithubRepositoryOutType$outboundSchema: z.ZodNativeEnum< - typeof GithubRepositoryOutType -> = GithubRepositoryOutType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace GithubRepositoryOutType$ { - /** @deprecated use `GithubRepositoryOutType$inboundSchema` instead. */ - export const inboundSchema = GithubRepositoryOutType$inboundSchema; - /** @deprecated use `GithubRepositoryOutType$outboundSchema` instead. */ - export const outboundSchema = GithubRepositoryOutType$outboundSchema; -} - -/** @internal */ -export const GithubRepositoryOut$inboundSchema: z.ZodType< - GithubRepositoryOut, - z.ZodTypeDef, - unknown -> = z.object({ - type: GithubRepositoryOutType$inboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commit_id: z.string(), -}).transform((v) => { - return remap$(v, { - "commit_id": "commitId", - }); -}); - -/** @internal */ -export type GithubRepositoryOut$Outbound = { - type: string; - name: string; - owner: string; - ref?: string | null | undefined; - weight: number; - commit_id: string; -}; - -/** @internal */ -export const GithubRepositoryOut$outboundSchema: z.ZodType< - GithubRepositoryOut$Outbound, - z.ZodTypeDef, - GithubRepositoryOut -> = z.object({ - type: GithubRepositoryOutType$outboundSchema.default("github"), - name: z.string(), - owner: z.string(), - ref: z.nullable(z.string()).optional(), - weight: z.number().default(1), - commitId: z.string(), -}).transform((v) => { - return remap$(v, { - commitId: "commit_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace GithubRepositoryOut$ { - /** @deprecated use `GithubRepositoryOut$inboundSchema` instead. */ - export const inboundSchema = GithubRepositoryOut$inboundSchema; - /** @deprecated use `GithubRepositoryOut$outboundSchema` instead. */ - export const outboundSchema = GithubRepositoryOut$outboundSchema; - /** @deprecated use `GithubRepositoryOut$Outbound` instead. */ - export type Outbound = GithubRepositoryOut$Outbound; -} - -export function githubRepositoryOutToJSON( - githubRepositoryOut: GithubRepositoryOut, -): string { - return JSON.stringify( - GithubRepositoryOut$outboundSchema.parse(githubRepositoryOut), - ); -} - -export function githubRepositoryOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => GithubRepositoryOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'GithubRepositoryOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/imagegenerationtool.ts b/examples/sdks/mistral-typescript/src/models/components/imagegenerationtool.ts deleted file mode 100644 index 7e81ffd33..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/imagegenerationtool.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ImageGenerationToolType = { - ImageGeneration: "image_generation", -} as const; -export type ImageGenerationToolType = ClosedEnum< - typeof ImageGenerationToolType ->; - -export type ImageGenerationTool = { - type?: ImageGenerationToolType | undefined; -}; - -/** @internal */ -export const ImageGenerationToolType$inboundSchema: z.ZodNativeEnum< - typeof ImageGenerationToolType -> = z.nativeEnum(ImageGenerationToolType); - -/** @internal */ -export const ImageGenerationToolType$outboundSchema: z.ZodNativeEnum< - typeof ImageGenerationToolType -> = ImageGenerationToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageGenerationToolType$ { - /** @deprecated use `ImageGenerationToolType$inboundSchema` instead. */ - export const inboundSchema = ImageGenerationToolType$inboundSchema; - /** @deprecated use `ImageGenerationToolType$outboundSchema` instead. */ - export const outboundSchema = ImageGenerationToolType$outboundSchema; -} - -/** @internal */ -export const ImageGenerationTool$inboundSchema: z.ZodType< - ImageGenerationTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: ImageGenerationToolType$inboundSchema.default("image_generation"), -}); - -/** @internal */ -export type ImageGenerationTool$Outbound = { - type: string; -}; - -/** @internal */ -export const ImageGenerationTool$outboundSchema: z.ZodType< - ImageGenerationTool$Outbound, - z.ZodTypeDef, - ImageGenerationTool -> = z.object({ - type: ImageGenerationToolType$outboundSchema.default("image_generation"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageGenerationTool$ { - /** @deprecated use `ImageGenerationTool$inboundSchema` instead. */ - export const inboundSchema = ImageGenerationTool$inboundSchema; - /** @deprecated use `ImageGenerationTool$outboundSchema` instead. */ - export const outboundSchema = ImageGenerationTool$outboundSchema; - /** @deprecated use `ImageGenerationTool$Outbound` instead. */ - export type Outbound = ImageGenerationTool$Outbound; -} - -export function imageGenerationToolToJSON( - imageGenerationTool: ImageGenerationTool, -): string { - return JSON.stringify( - ImageGenerationTool$outboundSchema.parse(imageGenerationTool), - ); -} - -export function imageGenerationToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageGenerationTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageGenerationTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/imageurl.ts b/examples/sdks/mistral-typescript/src/models/components/imageurl.ts deleted file mode 100644 index 5086e232b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/imageurl.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ImageURL = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$inboundSchema: z.ZodType< - ImageURL, - z.ZodTypeDef, - unknown -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type ImageURL$Outbound = { - url: string; - detail?: string | null | undefined; -}; - -/** @internal */ -export const ImageURL$outboundSchema: z.ZodType< - ImageURL$Outbound, - z.ZodTypeDef, - ImageURL -> = z.object({ - url: z.string(), - detail: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURL$ { - /** @deprecated use `ImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURL$inboundSchema; - /** @deprecated use `ImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURL$outboundSchema; - /** @deprecated use `ImageURL$Outbound` instead. */ - export type Outbound = ImageURL$Outbound; -} - -export function imageURLToJSON(imageURL: ImageURL): string { - return JSON.stringify(ImageURL$outboundSchema.parse(imageURL)); -} - -export function imageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURL' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/imageurlchunk.ts b/examples/sdks/mistral-typescript/src/models/components/imageurlchunk.ts deleted file mode 100644 index 7feb19366..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/imageurlchunk.ts +++ /dev/null @@ -1,161 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ImageURL, - ImageURL$inboundSchema, - ImageURL$Outbound, - ImageURL$outboundSchema, -} from "./imageurl.js"; - -export type ImageURLChunkImageURL = ImageURL | string; - -export const ImageURLChunkType = { - ImageUrl: "image_url", -} as const; -export type ImageURLChunkType = ClosedEnum; - -/** - * {"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0 - */ -export type ImageURLChunk = { - imageUrl: ImageURL | string; - type?: ImageURLChunkType | undefined; -}; - -/** @internal */ -export const ImageURLChunkImageURL$inboundSchema: z.ZodType< - ImageURLChunkImageURL, - z.ZodTypeDef, - unknown -> = z.union([ImageURL$inboundSchema, z.string()]); - -/** @internal */ -export type ImageURLChunkImageURL$Outbound = ImageURL$Outbound | string; - -/** @internal */ -export const ImageURLChunkImageURL$outboundSchema: z.ZodType< - ImageURLChunkImageURL$Outbound, - z.ZodTypeDef, - ImageURLChunkImageURL -> = z.union([ImageURL$outboundSchema, z.string()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkImageURL$ { - /** @deprecated use `ImageURLChunkImageURL$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkImageURL$inboundSchema; - /** @deprecated use `ImageURLChunkImageURL$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkImageURL$outboundSchema; - /** @deprecated use `ImageURLChunkImageURL$Outbound` instead. */ - export type Outbound = ImageURLChunkImageURL$Outbound; -} - -export function imageURLChunkImageURLToJSON( - imageURLChunkImageURL: ImageURLChunkImageURL, -): string { - return JSON.stringify( - ImageURLChunkImageURL$outboundSchema.parse(imageURLChunkImageURL), - ); -} - -export function imageURLChunkImageURLFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunkImageURL$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunkImageURL' from JSON`, - ); -} - -/** @internal */ -export const ImageURLChunkType$inboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = z.nativeEnum(ImageURLChunkType); - -/** @internal */ -export const ImageURLChunkType$outboundSchema: z.ZodNativeEnum< - typeof ImageURLChunkType -> = ImageURLChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunkType$ { - /** @deprecated use `ImageURLChunkType$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunkType$inboundSchema; - /** @deprecated use `ImageURLChunkType$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunkType$outboundSchema; -} - -/** @internal */ -export const ImageURLChunk$inboundSchema: z.ZodType< - ImageURLChunk, - z.ZodTypeDef, - unknown -> = z.object({ - image_url: z.union([ImageURL$inboundSchema, z.string()]), - type: ImageURLChunkType$inboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - "image_url": "imageUrl", - }); -}); - -/** @internal */ -export type ImageURLChunk$Outbound = { - image_url: ImageURL$Outbound | string; - type: string; -}; - -/** @internal */ -export const ImageURLChunk$outboundSchema: z.ZodType< - ImageURLChunk$Outbound, - z.ZodTypeDef, - ImageURLChunk -> = z.object({ - imageUrl: z.union([ImageURL$outboundSchema, z.string()]), - type: ImageURLChunkType$outboundSchema.default("image_url"), -}).transform((v) => { - return remap$(v, { - imageUrl: "image_url", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ImageURLChunk$ { - /** @deprecated use `ImageURLChunk$inboundSchema` instead. */ - export const inboundSchema = ImageURLChunk$inboundSchema; - /** @deprecated use `ImageURLChunk$outboundSchema` instead. */ - export const outboundSchema = ImageURLChunk$outboundSchema; - /** @deprecated use `ImageURLChunk$Outbound` instead. */ - export type Outbound = ImageURLChunk$Outbound; -} - -export function imageURLChunkToJSON(imageURLChunk: ImageURLChunk): string { - return JSON.stringify(ImageURLChunk$outboundSchema.parse(imageURLChunk)); -} - -export function imageURLChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ImageURLChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ImageURLChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/index.ts b/examples/sdks/mistral-typescript/src/models/components/index.ts deleted file mode 100644 index d11027505..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/index.ts +++ /dev/null @@ -1,196 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./agent.js"; -export * from "./agentconversation.js"; -export * from "./agentcreationrequest.js"; -export * from "./agenthandoffdoneevent.js"; -export * from "./agenthandoffentry.js"; -export * from "./agenthandoffstartedevent.js"; -export * from "./agentscompletionrequest.js"; -export * from "./agentscompletionstreamrequest.js"; -export * from "./agentupdaterequest.js"; -export * from "./apiendpoint.js"; -export * from "./archiveftmodelout.js"; -export * from "./assistantmessage.js"; -export * from "./audiochunk.js"; -export * from "./audiotranscriptionrequest.js"; -export * from "./audiotranscriptionrequeststream.js"; -export * from "./basemodelcard.js"; -export * from "./batcherror.js"; -export * from "./batchjobin.js"; -export * from "./batchjobout.js"; -export * from "./batchjobsout.js"; -export * from "./batchjobstatus.js"; -export * from "./builtinconnectors.js"; -export * from "./chatclassificationrequest.js"; -export * from "./chatcompletionchoice.js"; -export * from "./chatcompletionrequest.js"; -export * from "./chatcompletionresponse.js"; -export * from "./chatcompletionstreamrequest.js"; -export * from "./chatmoderationrequest.js"; -export * from "./checkpointout.js"; -export * from "./classificationrequest.js"; -export * from "./classificationresponse.js"; -export * from "./classificationtargetresult.js"; -export * from "./classifierdetailedjobout.js"; -export * from "./classifierftmodelout.js"; -export * from "./classifierjobout.js"; -export * from "./classifiertargetin.js"; -export * from "./classifiertargetout.js"; -export * from "./classifiertrainingparameters.js"; -export * from "./classifiertrainingparametersin.js"; -export * from "./codeinterpretertool.js"; -export * from "./completionargs.js"; -export * from "./completionargsstop.js"; -export * from "./completionchunk.js"; -export * from "./completiondetailedjobout.js"; -export * from "./completionevent.js"; -export * from "./completionftmodelout.js"; -export * from "./completionjobout.js"; -export * from "./completionresponsestreamchoice.js"; -export * from "./completiontrainingparameters.js"; -export * from "./completiontrainingparametersin.js"; -export * from "./contentchunk.js"; -export * from "./conversationappendrequest.js"; -export * from "./conversationappendstreamrequest.js"; -export * from "./conversationevents.js"; -export * from "./conversationhistory.js"; -export * from "./conversationinputs.js"; -export * from "./conversationmessages.js"; -export * from "./conversationrequest.js"; -export * from "./conversationresponse.js"; -export * from "./conversationrestartrequest.js"; -export * from "./conversationrestartstreamrequest.js"; -export * from "./conversationstreamrequest.js"; -export * from "./conversationusageinfo.js"; -export * from "./deletefileout.js"; -export * from "./deletemodelout.js"; -export * from "./deltamessage.js"; -export * from "./documentlibrarytool.js"; -export * from "./documentout.js"; -export * from "./documenttextcontent.js"; -export * from "./documentupdatein.js"; -export * from "./documenturlchunk.js"; -export * from "./embeddingdtype.js"; -export * from "./embeddingrequest.js"; -export * from "./embeddingresponse.js"; -export * from "./embeddingresponsedata.js"; -export * from "./encodingformat.js"; -export * from "./entitytype.js"; -export * from "./eventout.js"; -export * from "./file.js"; -export * from "./filechunk.js"; -export * from "./filepurpose.js"; -export * from "./fileschema.js"; -export * from "./filesignedurl.js"; -export * from "./fimcompletionrequest.js"; -export * from "./fimcompletionresponse.js"; -export * from "./fimcompletionstreamrequest.js"; -export * from "./finetuneablemodeltype.js"; -export * from "./ftclassifierlossfunction.js"; -export * from "./ftmodelcapabilitiesout.js"; -export * from "./ftmodelcard.js"; -export * from "./function.js"; -export * from "./functioncall.js"; -export * from "./functioncallentry.js"; -export * from "./functioncallentryarguments.js"; -export * from "./functioncallevent.js"; -export * from "./functionname.js"; -export * from "./functionresultentry.js"; -export * from "./functiontool.js"; -export * from "./githubrepositoryin.js"; -export * from "./githubrepositoryout.js"; -export * from "./imagegenerationtool.js"; -export * from "./imageurl.js"; -export * from "./imageurlchunk.js"; -export * from "./inputentries.js"; -export * from "./inputs.js"; -export * from "./instructrequest.js"; -export * from "./jobin.js"; -export * from "./jobmetadataout.js"; -export * from "./jobsout.js"; -export * from "./jsonschema.js"; -export * from "./legacyjobmetadataout.js"; -export * from "./libraryin.js"; -export * from "./libraryinupdate.js"; -export * from "./libraryout.js"; -export * from "./listdocumentout.js"; -export * from "./listfilesout.js"; -export * from "./listlibraryout.js"; -export * from "./listsharingout.js"; -export * from "./messageentries.js"; -export * from "./messageinputcontentchunks.js"; -export * from "./messageinputentry.js"; -export * from "./messageoutputcontentchunks.js"; -export * from "./messageoutputentry.js"; -export * from "./messageoutputevent.js"; -export * from "./metricout.js"; -export * from "./mistralpromptmode.js"; -export * from "./modelcapabilities.js"; -export * from "./modelconversation.js"; -export * from "./modellist.js"; -export * from "./moderationobject.js"; -export * from "./moderationresponse.js"; -export * from "./ocrimageobject.js"; -export * from "./ocrpagedimensions.js"; -export * from "./ocrpageobject.js"; -export * from "./ocrrequest.js"; -export * from "./ocrresponse.js"; -export * from "./ocrusageinfo.js"; -export * from "./outputcontentchunks.js"; -export * from "./paginationinfo.js"; -export * from "./prediction.js"; -export * from "./processingstatusout.js"; -export * from "./referencechunk.js"; -export * from "./responsedoneevent.js"; -export * from "./responseerrorevent.js"; -export * from "./responseformat.js"; -export * from "./responseformats.js"; -export * from "./responsestartedevent.js"; -export * from "./retrievefileout.js"; -export * from "./sampletype.js"; -export * from "./security.js"; -export * from "./shareenum.js"; -export * from "./sharingdelete.js"; -export * from "./sharingin.js"; -export * from "./sharingout.js"; -export * from "./source.js"; -export * from "./ssetypes.js"; -export * from "./systemmessage.js"; -export * from "./systemmessagecontentchunks.js"; -export * from "./textchunk.js"; -export * from "./thinkchunk.js"; -export * from "./timestampgranularity.js"; -export * from "./tool.js"; -export * from "./toolcall.js"; -export * from "./toolchoice.js"; -export * from "./toolchoiceenum.js"; -export * from "./toolexecutiondeltaevent.js"; -export * from "./toolexecutiondoneevent.js"; -export * from "./toolexecutionentry.js"; -export * from "./toolexecutionstartedevent.js"; -export * from "./toolfilechunk.js"; -export * from "./toolmessage.js"; -export * from "./toolreferencechunk.js"; -export * from "./tooltypes.js"; -export * from "./trainingfile.js"; -export * from "./transcriptionresponse.js"; -export * from "./transcriptionsegmentchunk.js"; -export * from "./transcriptionstreamdone.js"; -export * from "./transcriptionstreamevents.js"; -export * from "./transcriptionstreameventtypes.js"; -export * from "./transcriptionstreamlanguage.js"; -export * from "./transcriptionstreamsegmentdelta.js"; -export * from "./transcriptionstreamtextdelta.js"; -export * from "./unarchiveftmodelout.js"; -export * from "./updateftmodelin.js"; -export * from "./uploadfileout.js"; -export * from "./usageinfo.js"; -export * from "./usermessage.js"; -export * from "./validationerror.js"; -export * from "./wandbintegration.js"; -export * from "./wandbintegrationout.js"; -export * from "./websearchpremiumtool.js"; -export * from "./websearchtool.js"; diff --git a/examples/sdks/mistral-typescript/src/models/components/inputentries.ts b/examples/sdks/mistral-typescript/src/models/components/inputentries.ts deleted file mode 100644 index a57d6a9f2..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/inputentries.ts +++ /dev/null @@ -1,116 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AgentHandoffEntry, - AgentHandoffEntry$inboundSchema, - AgentHandoffEntry$Outbound, - AgentHandoffEntry$outboundSchema, -} from "./agenthandoffentry.js"; -import { - FunctionCallEntry, - FunctionCallEntry$inboundSchema, - FunctionCallEntry$Outbound, - FunctionCallEntry$outboundSchema, -} from "./functioncallentry.js"; -import { - FunctionResultEntry, - FunctionResultEntry$inboundSchema, - FunctionResultEntry$Outbound, - FunctionResultEntry$outboundSchema, -} from "./functionresultentry.js"; -import { - MessageInputEntry, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, -} from "./messageinputentry.js"; -import { - MessageOutputEntry, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, -} from "./messageoutputentry.js"; -import { - ToolExecutionEntry, - ToolExecutionEntry$inboundSchema, - ToolExecutionEntry$Outbound, - ToolExecutionEntry$outboundSchema, -} from "./toolexecutionentry.js"; - -export type InputEntries = - | AgentHandoffEntry - | FunctionCallEntry - | MessageInputEntry - | FunctionResultEntry - | ToolExecutionEntry - | MessageOutputEntry; - -/** @internal */ -export const InputEntries$inboundSchema: z.ZodType< - InputEntries, - z.ZodTypeDef, - unknown -> = z.union([ - AgentHandoffEntry$inboundSchema, - FunctionCallEntry$inboundSchema, - MessageInputEntry$inboundSchema, - FunctionResultEntry$inboundSchema, - ToolExecutionEntry$inboundSchema, - MessageOutputEntry$inboundSchema, -]); - -/** @internal */ -export type InputEntries$Outbound = - | AgentHandoffEntry$Outbound - | FunctionCallEntry$Outbound - | MessageInputEntry$Outbound - | FunctionResultEntry$Outbound - | ToolExecutionEntry$Outbound - | MessageOutputEntry$Outbound; - -/** @internal */ -export const InputEntries$outboundSchema: z.ZodType< - InputEntries$Outbound, - z.ZodTypeDef, - InputEntries -> = z.union([ - AgentHandoffEntry$outboundSchema, - FunctionCallEntry$outboundSchema, - MessageInputEntry$outboundSchema, - FunctionResultEntry$outboundSchema, - ToolExecutionEntry$outboundSchema, - MessageOutputEntry$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace InputEntries$ { - /** @deprecated use `InputEntries$inboundSchema` instead. */ - export const inboundSchema = InputEntries$inboundSchema; - /** @deprecated use `InputEntries$outboundSchema` instead. */ - export const outboundSchema = InputEntries$outboundSchema; - /** @deprecated use `InputEntries$Outbound` instead. */ - export type Outbound = InputEntries$Outbound; -} - -export function inputEntriesToJSON(inputEntries: InputEntries): string { - return JSON.stringify(InputEntries$outboundSchema.parse(inputEntries)); -} - -export function inputEntriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => InputEntries$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'InputEntries' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/inputs.ts b/examples/sdks/mistral-typescript/src/models/components/inputs.ts deleted file mode 100644 index b0b254b40..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/inputs.ts +++ /dev/null @@ -1,300 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - InstructRequest, - InstructRequest$inboundSchema, - InstructRequest$Outbound, - InstructRequest$outboundSchema, -} from "./instructrequest.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -export type InstructRequestInputsMessages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type InstructRequestInputs = { - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; -}; - -/** - * Chat to classify - */ -export type Inputs = InstructRequestInputs | Array; - -/** @internal */ -export const InstructRequestInputsMessages$inboundSchema: z.ZodType< - InstructRequestInputsMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type InstructRequestInputsMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const InstructRequestInputsMessages$outboundSchema: z.ZodType< - InstructRequestInputsMessages$Outbound, - z.ZodTypeDef, - InstructRequestInputsMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace InstructRequestInputsMessages$ { - /** @deprecated use `InstructRequestInputsMessages$inboundSchema` instead. */ - export const inboundSchema = InstructRequestInputsMessages$inboundSchema; - /** @deprecated use `InstructRequestInputsMessages$outboundSchema` instead. */ - export const outboundSchema = InstructRequestInputsMessages$outboundSchema; - /** @deprecated use `InstructRequestInputsMessages$Outbound` instead. */ - export type Outbound = InstructRequestInputsMessages$Outbound; -} - -export function instructRequestInputsMessagesToJSON( - instructRequestInputsMessages: InstructRequestInputsMessages, -): string { - return JSON.stringify( - InstructRequestInputsMessages$outboundSchema.parse( - instructRequestInputsMessages, - ), - ); -} - -export function instructRequestInputsMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => InstructRequestInputsMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'InstructRequestInputsMessages' from JSON`, - ); -} - -/** @internal */ -export const InstructRequestInputs$inboundSchema: z.ZodType< - InstructRequestInputs, - z.ZodTypeDef, - unknown -> = z.object({ - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), -}); - -/** @internal */ -export type InstructRequestInputs$Outbound = { - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; -}; - -/** @internal */ -export const InstructRequestInputs$outboundSchema: z.ZodType< - InstructRequestInputs$Outbound, - z.ZodTypeDef, - InstructRequestInputs -> = z.object({ - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace InstructRequestInputs$ { - /** @deprecated use `InstructRequestInputs$inboundSchema` instead. */ - export const inboundSchema = InstructRequestInputs$inboundSchema; - /** @deprecated use `InstructRequestInputs$outboundSchema` instead. */ - export const outboundSchema = InstructRequestInputs$outboundSchema; - /** @deprecated use `InstructRequestInputs$Outbound` instead. */ - export type Outbound = InstructRequestInputs$Outbound; -} - -export function instructRequestInputsToJSON( - instructRequestInputs: InstructRequestInputs, -): string { - return JSON.stringify( - InstructRequestInputs$outboundSchema.parse(instructRequestInputs), - ); -} - -export function instructRequestInputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => InstructRequestInputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'InstructRequestInputs' from JSON`, - ); -} - -/** @internal */ -export const Inputs$inboundSchema: z.ZodType = z - .union([ - z.lazy(() => InstructRequestInputs$inboundSchema), - z.array(InstructRequest$inboundSchema), - ]); - -/** @internal */ -export type Inputs$Outbound = - | InstructRequestInputs$Outbound - | Array; - -/** @internal */ -export const Inputs$outboundSchema: z.ZodType< - Inputs$Outbound, - z.ZodTypeDef, - Inputs -> = z.union([ - z.lazy(() => InstructRequestInputs$outboundSchema), - z.array(InstructRequest$outboundSchema), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Inputs$ { - /** @deprecated use `Inputs$inboundSchema` instead. */ - export const inboundSchema = Inputs$inboundSchema; - /** @deprecated use `Inputs$outboundSchema` instead. */ - export const outboundSchema = Inputs$outboundSchema; - /** @deprecated use `Inputs$Outbound` instead. */ - export type Outbound = Inputs$Outbound; -} - -export function inputsToJSON(inputs: Inputs): string { - return JSON.stringify(Inputs$outboundSchema.parse(inputs)); -} - -export function inputsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Inputs$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Inputs' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/instructrequest.ts b/examples/sdks/mistral-typescript/src/models/components/instructrequest.ts deleted file mode 100644 index 66c91032a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/instructrequest.ts +++ /dev/null @@ -1,236 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - AssistantMessage, - AssistantMessage$inboundSchema, - AssistantMessage$Outbound, - AssistantMessage$outboundSchema, -} from "./assistantmessage.js"; -import { - SystemMessage, - SystemMessage$inboundSchema, - SystemMessage$Outbound, - SystemMessage$outboundSchema, -} from "./systemmessage.js"; -import { - ToolMessage, - ToolMessage$inboundSchema, - ToolMessage$Outbound, - ToolMessage$outboundSchema, -} from "./toolmessage.js"; -import { - UserMessage, - UserMessage$inboundSchema, - UserMessage$Outbound, - UserMessage$outboundSchema, -} from "./usermessage.js"; - -export type InstructRequestMessages = - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }); - -export type InstructRequest = { - messages: Array< - | (SystemMessage & { role: "system" }) - | (ToolMessage & { role: "tool" }) - | (UserMessage & { role: "user" }) - | (AssistantMessage & { role: "assistant" }) - >; -}; - -/** @internal */ -export const InstructRequestMessages$inboundSchema: z.ZodType< - InstructRequestMessages, - z.ZodTypeDef, - unknown -> = z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** @internal */ -export type InstructRequestMessages$Outbound = - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }); - -/** @internal */ -export const InstructRequestMessages$outboundSchema: z.ZodType< - InstructRequestMessages$Outbound, - z.ZodTypeDef, - InstructRequestMessages -> = z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ role: v.role })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ role: v.role })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace InstructRequestMessages$ { - /** @deprecated use `InstructRequestMessages$inboundSchema` instead. */ - export const inboundSchema = InstructRequestMessages$inboundSchema; - /** @deprecated use `InstructRequestMessages$outboundSchema` instead. */ - export const outboundSchema = InstructRequestMessages$outboundSchema; - /** @deprecated use `InstructRequestMessages$Outbound` instead. */ - export type Outbound = InstructRequestMessages$Outbound; -} - -export function instructRequestMessagesToJSON( - instructRequestMessages: InstructRequestMessages, -): string { - return JSON.stringify( - InstructRequestMessages$outboundSchema.parse(instructRequestMessages), - ); -} - -export function instructRequestMessagesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => InstructRequestMessages$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'InstructRequestMessages' from JSON`, - ); -} - -/** @internal */ -export const InstructRequest$inboundSchema: z.ZodType< - InstructRequest, - z.ZodTypeDef, - unknown -> = z.object({ - messages: z.array( - z.union([ - SystemMessage$inboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$inboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$inboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$inboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), -}); - -/** @internal */ -export type InstructRequest$Outbound = { - messages: Array< - | (SystemMessage$Outbound & { role: "system" }) - | (ToolMessage$Outbound & { role: "tool" }) - | (UserMessage$Outbound & { role: "user" }) - | (AssistantMessage$Outbound & { role: "assistant" }) - >; -}; - -/** @internal */ -export const InstructRequest$outboundSchema: z.ZodType< - InstructRequest$Outbound, - z.ZodTypeDef, - InstructRequest -> = z.object({ - messages: z.array( - z.union([ - SystemMessage$outboundSchema.and( - z.object({ role: z.literal("system") }).transform((v) => ({ - role: v.role, - })), - ), - ToolMessage$outboundSchema.and( - z.object({ role: z.literal("tool") }).transform((v) => ({ - role: v.role, - })), - ), - UserMessage$outboundSchema.and( - z.object({ role: z.literal("user") }).transform((v) => ({ - role: v.role, - })), - ), - AssistantMessage$outboundSchema.and( - z.object({ role: z.literal("assistant") }).transform((v) => ({ - role: v.role, - })), - ), - ]), - ), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace InstructRequest$ { - /** @deprecated use `InstructRequest$inboundSchema` instead. */ - export const inboundSchema = InstructRequest$inboundSchema; - /** @deprecated use `InstructRequest$outboundSchema` instead. */ - export const outboundSchema = InstructRequest$outboundSchema; - /** @deprecated use `InstructRequest$Outbound` instead. */ - export type Outbound = InstructRequest$Outbound; -} - -export function instructRequestToJSON( - instructRequest: InstructRequest, -): string { - return JSON.stringify(InstructRequest$outboundSchema.parse(instructRequest)); -} - -export function instructRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => InstructRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'InstructRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/jobin.ts b/examples/sdks/mistral-typescript/src/models/components/jobin.ts deleted file mode 100644 index 82559a6ad..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/jobin.ts +++ /dev/null @@ -1,347 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ClassifierTargetIn, - ClassifierTargetIn$inboundSchema, - ClassifierTargetIn$Outbound, - ClassifierTargetIn$outboundSchema, -} from "./classifiertargetin.js"; -import { - ClassifierTrainingParametersIn, - ClassifierTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$Outbound, - ClassifierTrainingParametersIn$outboundSchema, -} from "./classifiertrainingparametersin.js"; -import { - CompletionTrainingParametersIn, - CompletionTrainingParametersIn$inboundSchema, - CompletionTrainingParametersIn$Outbound, - CompletionTrainingParametersIn$outboundSchema, -} from "./completiontrainingparametersin.js"; -import { - FineTuneableModelType, - FineTuneableModelType$inboundSchema, - FineTuneableModelType$outboundSchema, -} from "./finetuneablemodeltype.js"; -import { - GithubRepositoryIn, - GithubRepositoryIn$inboundSchema, - GithubRepositoryIn$Outbound, - GithubRepositoryIn$outboundSchema, -} from "./githubrepositoryin.js"; -import { - TrainingFile, - TrainingFile$inboundSchema, - TrainingFile$Outbound, - TrainingFile$outboundSchema, -} from "./trainingfile.js"; -import { - WandbIntegration, - WandbIntegration$inboundSchema, - WandbIntegration$Outbound, - WandbIntegration$outboundSchema, -} from "./wandbintegration.js"; - -export type JobInIntegrations = WandbIntegration; - -export type Hyperparameters = - | CompletionTrainingParametersIn - | ClassifierTrainingParametersIn; - -export type JobInRepositories = GithubRepositoryIn; - -export type JobIn = { - /** - * The name of the model to fine-tune. - */ - model: string; - trainingFiles?: Array | undefined; - /** - * A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - */ - validationFiles?: Array | null | undefined; - /** - * A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - */ - suffix?: string | null | undefined; - /** - * A list of integrations to enable for your fine-tuning job. - */ - integrations?: Array | null | undefined; - /** - * This field will be required in a future release. - */ - autoStart?: boolean | undefined; - invalidSampleSkipPercentage?: number | undefined; - jobType?: FineTuneableModelType | null | undefined; - hyperparameters: - | CompletionTrainingParametersIn - | ClassifierTrainingParametersIn; - repositories?: Array | null | undefined; - classifierTargets?: Array | null | undefined; -}; - -/** @internal */ -export const JobInIntegrations$inboundSchema: z.ZodType< - JobInIntegrations, - z.ZodTypeDef, - unknown -> = WandbIntegration$inboundSchema; - -/** @internal */ -export type JobInIntegrations$Outbound = WandbIntegration$Outbound; - -/** @internal */ -export const JobInIntegrations$outboundSchema: z.ZodType< - JobInIntegrations$Outbound, - z.ZodTypeDef, - JobInIntegrations -> = WandbIntegration$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobInIntegrations$ { - /** @deprecated use `JobInIntegrations$inboundSchema` instead. */ - export const inboundSchema = JobInIntegrations$inboundSchema; - /** @deprecated use `JobInIntegrations$outboundSchema` instead. */ - export const outboundSchema = JobInIntegrations$outboundSchema; - /** @deprecated use `JobInIntegrations$Outbound` instead. */ - export type Outbound = JobInIntegrations$Outbound; -} - -export function jobInIntegrationsToJSON( - jobInIntegrations: JobInIntegrations, -): string { - return JSON.stringify( - JobInIntegrations$outboundSchema.parse(jobInIntegrations), - ); -} - -export function jobInIntegrationsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobInIntegrations$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobInIntegrations' from JSON`, - ); -} - -/** @internal */ -export const Hyperparameters$inboundSchema: z.ZodType< - Hyperparameters, - z.ZodTypeDef, - unknown -> = z.union([ - CompletionTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$inboundSchema, -]); - -/** @internal */ -export type Hyperparameters$Outbound = - | CompletionTrainingParametersIn$Outbound - | ClassifierTrainingParametersIn$Outbound; - -/** @internal */ -export const Hyperparameters$outboundSchema: z.ZodType< - Hyperparameters$Outbound, - z.ZodTypeDef, - Hyperparameters -> = z.union([ - CompletionTrainingParametersIn$outboundSchema, - ClassifierTrainingParametersIn$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Hyperparameters$ { - /** @deprecated use `Hyperparameters$inboundSchema` instead. */ - export const inboundSchema = Hyperparameters$inboundSchema; - /** @deprecated use `Hyperparameters$outboundSchema` instead. */ - export const outboundSchema = Hyperparameters$outboundSchema; - /** @deprecated use `Hyperparameters$Outbound` instead. */ - export type Outbound = Hyperparameters$Outbound; -} - -export function hyperparametersToJSON( - hyperparameters: Hyperparameters, -): string { - return JSON.stringify(Hyperparameters$outboundSchema.parse(hyperparameters)); -} - -export function hyperparametersFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Hyperparameters$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Hyperparameters' from JSON`, - ); -} - -/** @internal */ -export const JobInRepositories$inboundSchema: z.ZodType< - JobInRepositories, - z.ZodTypeDef, - unknown -> = GithubRepositoryIn$inboundSchema; - -/** @internal */ -export type JobInRepositories$Outbound = GithubRepositoryIn$Outbound; - -/** @internal */ -export const JobInRepositories$outboundSchema: z.ZodType< - JobInRepositories$Outbound, - z.ZodTypeDef, - JobInRepositories -> = GithubRepositoryIn$outboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobInRepositories$ { - /** @deprecated use `JobInRepositories$inboundSchema` instead. */ - export const inboundSchema = JobInRepositories$inboundSchema; - /** @deprecated use `JobInRepositories$outboundSchema` instead. */ - export const outboundSchema = JobInRepositories$outboundSchema; - /** @deprecated use `JobInRepositories$Outbound` instead. */ - export type Outbound = JobInRepositories$Outbound; -} - -export function jobInRepositoriesToJSON( - jobInRepositories: JobInRepositories, -): string { - return JSON.stringify( - JobInRepositories$outboundSchema.parse(jobInRepositories), - ); -} - -export function jobInRepositoriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobInRepositories$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobInRepositories' from JSON`, - ); -} - -/** @internal */ -export const JobIn$inboundSchema: z.ZodType = z - .object({ - model: z.string(), - training_files: z.array(TrainingFile$inboundSchema).optional(), - validation_files: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegration$inboundSchema)) - .optional(), - auto_start: z.boolean().optional(), - invalid_sample_skip_percentage: z.number().default(0), - job_type: z.nullable(FineTuneableModelType$inboundSchema).optional(), - hyperparameters: z.union([ - CompletionTrainingParametersIn$inboundSchema, - ClassifierTrainingParametersIn$inboundSchema, - ]), - repositories: z.nullable(z.array(GithubRepositoryIn$inboundSchema)) - .optional(), - classifier_targets: z.nullable(z.array(ClassifierTargetIn$inboundSchema)) - .optional(), - }).transform((v) => { - return remap$(v, { - "training_files": "trainingFiles", - "validation_files": "validationFiles", - "auto_start": "autoStart", - "invalid_sample_skip_percentage": "invalidSampleSkipPercentage", - "job_type": "jobType", - "classifier_targets": "classifierTargets", - }); - }); - -/** @internal */ -export type JobIn$Outbound = { - model: string; - training_files?: Array | undefined; - validation_files?: Array | null | undefined; - suffix?: string | null | undefined; - integrations?: Array | null | undefined; - auto_start?: boolean | undefined; - invalid_sample_skip_percentage: number; - job_type?: string | null | undefined; - hyperparameters: - | CompletionTrainingParametersIn$Outbound - | ClassifierTrainingParametersIn$Outbound; - repositories?: Array | null | undefined; - classifier_targets?: Array | null | undefined; -}; - -/** @internal */ -export const JobIn$outboundSchema: z.ZodType< - JobIn$Outbound, - z.ZodTypeDef, - JobIn -> = z.object({ - model: z.string(), - trainingFiles: z.array(TrainingFile$outboundSchema).optional(), - validationFiles: z.nullable(z.array(z.string())).optional(), - suffix: z.nullable(z.string()).optional(), - integrations: z.nullable(z.array(WandbIntegration$outboundSchema)).optional(), - autoStart: z.boolean().optional(), - invalidSampleSkipPercentage: z.number().default(0), - jobType: z.nullable(FineTuneableModelType$outboundSchema).optional(), - hyperparameters: z.union([ - CompletionTrainingParametersIn$outboundSchema, - ClassifierTrainingParametersIn$outboundSchema, - ]), - repositories: z.nullable(z.array(GithubRepositoryIn$outboundSchema)) - .optional(), - classifierTargets: z.nullable(z.array(ClassifierTargetIn$outboundSchema)) - .optional(), -}).transform((v) => { - return remap$(v, { - trainingFiles: "training_files", - validationFiles: "validation_files", - autoStart: "auto_start", - invalidSampleSkipPercentage: "invalid_sample_skip_percentage", - jobType: "job_type", - classifierTargets: "classifier_targets", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobIn$ { - /** @deprecated use `JobIn$inboundSchema` instead. */ - export const inboundSchema = JobIn$inboundSchema; - /** @deprecated use `JobIn$outboundSchema` instead. */ - export const outboundSchema = JobIn$outboundSchema; - /** @deprecated use `JobIn$Outbound` instead. */ - export type Outbound = JobIn$Outbound; -} - -export function jobInToJSON(jobIn: JobIn): string { - return JSON.stringify(JobIn$outboundSchema.parse(jobIn)); -} - -export function jobInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/jobmetadataout.ts b/examples/sdks/mistral-typescript/src/models/components/jobmetadataout.ts deleted file mode 100644 index 3d94398ae..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/jobmetadataout.ts +++ /dev/null @@ -1,105 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobMetadataOut = { - expectedDurationSeconds?: number | null | undefined; - cost?: number | null | undefined; - costCurrency?: string | null | undefined; - trainTokensPerStep?: number | null | undefined; - trainTokens?: number | null | undefined; - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; -}; - -/** @internal */ -export const JobMetadataOut$inboundSchema: z.ZodType< - JobMetadataOut, - z.ZodTypeDef, - unknown -> = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime", - }); -}); - -/** @internal */ -export type JobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; -}; - -/** @internal */ -export const JobMetadataOut$outboundSchema: z.ZodType< - JobMetadataOut$Outbound, - z.ZodTypeDef, - JobMetadataOut -> = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobMetadataOut$ { - /** @deprecated use `JobMetadataOut$inboundSchema` instead. */ - export const inboundSchema = JobMetadataOut$inboundSchema; - /** @deprecated use `JobMetadataOut$outboundSchema` instead. */ - export const outboundSchema = JobMetadataOut$outboundSchema; - /** @deprecated use `JobMetadataOut$Outbound` instead. */ - export type Outbound = JobMetadataOut$Outbound; -} - -export function jobMetadataOutToJSON(jobMetadataOut: JobMetadataOut): string { - return JSON.stringify(JobMetadataOut$outboundSchema.parse(jobMetadataOut)); -} - -export function jobMetadataOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobMetadataOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobMetadataOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/jobsout.ts b/examples/sdks/mistral-typescript/src/models/components/jobsout.ts deleted file mode 100644 index c0a49badf..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/jobsout.ts +++ /dev/null @@ -1,214 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ClassifierJobOut, - ClassifierJobOut$inboundSchema, - ClassifierJobOut$Outbound, - ClassifierJobOut$outboundSchema, -} from "./classifierjobout.js"; -import { - CompletionJobOut, - CompletionJobOut$inboundSchema, - CompletionJobOut$Outbound, - CompletionJobOut$outboundSchema, -} from "./completionjobout.js"; - -export type JobsOutData = - | (ClassifierJobOut & { jobType: "classifier" }) - | (CompletionJobOut & { jobType: "completion" }); - -export const JobsOutObject = { - List: "list", -} as const; -export type JobsOutObject = ClosedEnum; - -export type JobsOut = { - data?: - | Array< - | (ClassifierJobOut & { jobType: "classifier" }) - | (CompletionJobOut & { jobType: "completion" }) - > - | undefined; - object?: JobsOutObject | undefined; - total: number; -}; - -/** @internal */ -export const JobsOutData$inboundSchema: z.ZodType< - JobsOutData, - z.ZodTypeDef, - unknown -> = z.union([ - ClassifierJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - CompletionJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), -]); - -/** @internal */ -export type JobsOutData$Outbound = - | (ClassifierJobOut$Outbound & { job_type: "classifier" }) - | (CompletionJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const JobsOutData$outboundSchema: z.ZodType< - JobsOutData$Outbound, - z.ZodTypeDef, - JobsOutData -> = z.union([ - ClassifierJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - CompletionJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsOutData$ { - /** @deprecated use `JobsOutData$inboundSchema` instead. */ - export const inboundSchema = JobsOutData$inboundSchema; - /** @deprecated use `JobsOutData$outboundSchema` instead. */ - export const outboundSchema = JobsOutData$outboundSchema; - /** @deprecated use `JobsOutData$Outbound` instead. */ - export type Outbound = JobsOutData$Outbound; -} - -export function jobsOutDataToJSON(jobsOutData: JobsOutData): string { - return JSON.stringify(JobsOutData$outboundSchema.parse(jobsOutData)); -} - -export function jobsOutDataFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobsOutData$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobsOutData' from JSON`, - ); -} - -/** @internal */ -export const JobsOutObject$inboundSchema: z.ZodNativeEnum< - typeof JobsOutObject -> = z.nativeEnum(JobsOutObject); - -/** @internal */ -export const JobsOutObject$outboundSchema: z.ZodNativeEnum< - typeof JobsOutObject -> = JobsOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsOutObject$ { - /** @deprecated use `JobsOutObject$inboundSchema` instead. */ - export const inboundSchema = JobsOutObject$inboundSchema; - /** @deprecated use `JobsOutObject$outboundSchema` instead. */ - export const outboundSchema = JobsOutObject$outboundSchema; -} - -/** @internal */ -export const JobsOut$inboundSchema: z.ZodType = - z.object({ - data: z.array( - z.union([ - ClassifierJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - CompletionJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ]), - ).optional(), - object: JobsOutObject$inboundSchema.default("list"), - total: z.number().int(), - }); - -/** @internal */ -export type JobsOut$Outbound = { - data?: - | Array< - | (ClassifierJobOut$Outbound & { job_type: "classifier" }) - | (CompletionJobOut$Outbound & { job_type: "completion" }) - > - | undefined; - object: string; - total: number; -}; - -/** @internal */ -export const JobsOut$outboundSchema: z.ZodType< - JobsOut$Outbound, - z.ZodTypeDef, - JobsOut -> = z.object({ - data: z.array( - z.union([ - ClassifierJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - CompletionJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]), - ).optional(), - object: JobsOutObject$outboundSchema.default("list"), - total: z.number().int(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsOut$ { - /** @deprecated use `JobsOut$inboundSchema` instead. */ - export const inboundSchema = JobsOut$inboundSchema; - /** @deprecated use `JobsOut$outboundSchema` instead. */ - export const outboundSchema = JobsOut$outboundSchema; - /** @deprecated use `JobsOut$Outbound` instead. */ - export type Outbound = JobsOut$Outbound; -} - -export function jobsOutToJSON(jobsOut: JobsOut): string { - return JSON.stringify(JobsOut$outboundSchema.parse(jobsOut)); -} - -export function jobsOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JobsOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobsOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/jsonschema.ts b/examples/sdks/mistral-typescript/src/models/components/jsonschema.ts deleted file mode 100644 index 12af67b2c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/jsonschema.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JsonSchema = { - name: string; - description?: string | null | undefined; - schemaDefinition: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$inboundSchema: z.ZodType< - JsonSchema, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schema: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - "schema": "schemaDefinition", - }); -}); - -/** @internal */ -export type JsonSchema$Outbound = { - name: string; - description?: string | null | undefined; - schema: { [k: string]: any }; - strict?: boolean | undefined; -}; - -/** @internal */ -export const JsonSchema$outboundSchema: z.ZodType< - JsonSchema$Outbound, - z.ZodTypeDef, - JsonSchema -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - schemaDefinition: z.record(z.any()), - strict: z.boolean().optional(), -}).transform((v) => { - return remap$(v, { - schemaDefinition: "schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JsonSchema$ { - /** @deprecated use `JsonSchema$inboundSchema` instead. */ - export const inboundSchema = JsonSchema$inboundSchema; - /** @deprecated use `JsonSchema$outboundSchema` instead. */ - export const outboundSchema = JsonSchema$outboundSchema; - /** @deprecated use `JsonSchema$Outbound` instead. */ - export type Outbound = JsonSchema$Outbound; -} - -export function jsonSchemaToJSON(jsonSchema: JsonSchema): string { - return JSON.stringify(JsonSchema$outboundSchema.parse(jsonSchema)); -} - -export function jsonSchemaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => JsonSchema$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JsonSchema' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/legacyjobmetadataout.ts b/examples/sdks/mistral-typescript/src/models/components/legacyjobmetadataout.ts deleted file mode 100644 index 3f921d343..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/legacyjobmetadataout.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const LegacyJobMetadataOutObject = { - JobMetadata: "job.metadata", -} as const; -export type LegacyJobMetadataOutObject = ClosedEnum< - typeof LegacyJobMetadataOutObject ->; - -export type LegacyJobMetadataOut = { - /** - * The approximated time (in seconds) for the fine-tuning process to complete. - */ - expectedDurationSeconds?: number | null | undefined; - /** - * The cost of the fine-tuning job. - */ - cost?: number | null | undefined; - /** - * The currency used for the fine-tuning job cost. - */ - costCurrency?: string | null | undefined; - /** - * The number of tokens consumed by one training step. - */ - trainTokensPerStep?: number | null | undefined; - /** - * The total number of tokens used during the fine-tuning process. - */ - trainTokens?: number | null | undefined; - /** - * The total number of tokens in the training dataset. - */ - dataTokens?: number | null | undefined; - estimatedStartTime?: number | null | undefined; - deprecated?: boolean | undefined; - details: string; - /** - * The number of complete passes through the entire training dataset. - */ - epochs?: number | null | undefined; - /** - * The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - */ - trainingSteps?: number | null | undefined; - object?: LegacyJobMetadataOutObject | undefined; -}; - -/** @internal */ -export const LegacyJobMetadataOutObject$inboundSchema: z.ZodNativeEnum< - typeof LegacyJobMetadataOutObject -> = z.nativeEnum(LegacyJobMetadataOutObject); - -/** @internal */ -export const LegacyJobMetadataOutObject$outboundSchema: z.ZodNativeEnum< - typeof LegacyJobMetadataOutObject -> = LegacyJobMetadataOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LegacyJobMetadataOutObject$ { - /** @deprecated use `LegacyJobMetadataOutObject$inboundSchema` instead. */ - export const inboundSchema = LegacyJobMetadataOutObject$inboundSchema; - /** @deprecated use `LegacyJobMetadataOutObject$outboundSchema` instead. */ - export const outboundSchema = LegacyJobMetadataOutObject$outboundSchema; -} - -/** @internal */ -export const LegacyJobMetadataOut$inboundSchema: z.ZodType< - LegacyJobMetadataOut, - z.ZodTypeDef, - unknown -> = z.object({ - expected_duration_seconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - cost_currency: z.nullable(z.string()).optional(), - train_tokens_per_step: z.nullable(z.number().int()).optional(), - train_tokens: z.nullable(z.number().int()).optional(), - data_tokens: z.nullable(z.number().int()).optional(), - estimated_start_time: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - training_steps: z.nullable(z.number().int()).optional(), - object: LegacyJobMetadataOutObject$inboundSchema.default("job.metadata"), -}).transform((v) => { - return remap$(v, { - "expected_duration_seconds": "expectedDurationSeconds", - "cost_currency": "costCurrency", - "train_tokens_per_step": "trainTokensPerStep", - "train_tokens": "trainTokens", - "data_tokens": "dataTokens", - "estimated_start_time": "estimatedStartTime", - "training_steps": "trainingSteps", - }); -}); - -/** @internal */ -export type LegacyJobMetadataOut$Outbound = { - expected_duration_seconds?: number | null | undefined; - cost?: number | null | undefined; - cost_currency?: string | null | undefined; - train_tokens_per_step?: number | null | undefined; - train_tokens?: number | null | undefined; - data_tokens?: number | null | undefined; - estimated_start_time?: number | null | undefined; - deprecated: boolean; - details: string; - epochs?: number | null | undefined; - training_steps?: number | null | undefined; - object: string; -}; - -/** @internal */ -export const LegacyJobMetadataOut$outboundSchema: z.ZodType< - LegacyJobMetadataOut$Outbound, - z.ZodTypeDef, - LegacyJobMetadataOut -> = z.object({ - expectedDurationSeconds: z.nullable(z.number().int()).optional(), - cost: z.nullable(z.number()).optional(), - costCurrency: z.nullable(z.string()).optional(), - trainTokensPerStep: z.nullable(z.number().int()).optional(), - trainTokens: z.nullable(z.number().int()).optional(), - dataTokens: z.nullable(z.number().int()).optional(), - estimatedStartTime: z.nullable(z.number().int()).optional(), - deprecated: z.boolean().default(true), - details: z.string(), - epochs: z.nullable(z.number()).optional(), - trainingSteps: z.nullable(z.number().int()).optional(), - object: LegacyJobMetadataOutObject$outboundSchema.default("job.metadata"), -}).transform((v) => { - return remap$(v, { - expectedDurationSeconds: "expected_duration_seconds", - costCurrency: "cost_currency", - trainTokensPerStep: "train_tokens_per_step", - trainTokens: "train_tokens", - dataTokens: "data_tokens", - estimatedStartTime: "estimated_start_time", - trainingSteps: "training_steps", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LegacyJobMetadataOut$ { - /** @deprecated use `LegacyJobMetadataOut$inboundSchema` instead. */ - export const inboundSchema = LegacyJobMetadataOut$inboundSchema; - /** @deprecated use `LegacyJobMetadataOut$outboundSchema` instead. */ - export const outboundSchema = LegacyJobMetadataOut$outboundSchema; - /** @deprecated use `LegacyJobMetadataOut$Outbound` instead. */ - export type Outbound = LegacyJobMetadataOut$Outbound; -} - -export function legacyJobMetadataOutToJSON( - legacyJobMetadataOut: LegacyJobMetadataOut, -): string { - return JSON.stringify( - LegacyJobMetadataOut$outboundSchema.parse(legacyJobMetadataOut), - ); -} - -export function legacyJobMetadataOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LegacyJobMetadataOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LegacyJobMetadataOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/libraryin.ts b/examples/sdks/mistral-typescript/src/models/components/libraryin.ts deleted file mode 100644 index f4cfce08d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/libraryin.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibraryIn = { - name: string; - description?: string | null | undefined; - chunkSize?: number | null | undefined; -}; - -/** @internal */ -export const LibraryIn$inboundSchema: z.ZodType< - LibraryIn, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunk_size: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "chunk_size": "chunkSize", - }); -}); - -/** @internal */ -export type LibraryIn$Outbound = { - name: string; - description?: string | null | undefined; - chunk_size?: number | null | undefined; -}; - -/** @internal */ -export const LibraryIn$outboundSchema: z.ZodType< - LibraryIn$Outbound, - z.ZodTypeDef, - LibraryIn -> = z.object({ - name: z.string(), - description: z.nullable(z.string()).optional(), - chunkSize: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - chunkSize: "chunk_size", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibraryIn$ { - /** @deprecated use `LibraryIn$inboundSchema` instead. */ - export const inboundSchema = LibraryIn$inboundSchema; - /** @deprecated use `LibraryIn$outboundSchema` instead. */ - export const outboundSchema = LibraryIn$outboundSchema; - /** @deprecated use `LibraryIn$Outbound` instead. */ - export type Outbound = LibraryIn$Outbound; -} - -export function libraryInToJSON(libraryIn: LibraryIn): string { - return JSON.stringify(LibraryIn$outboundSchema.parse(libraryIn)); -} - -export function libraryInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibraryIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibraryIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/libraryinupdate.ts b/examples/sdks/mistral-typescript/src/models/components/libraryinupdate.ts deleted file mode 100644 index e7c6804ff..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/libraryinupdate.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibraryInUpdate = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const LibraryInUpdate$inboundSchema: z.ZodType< - LibraryInUpdate, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type LibraryInUpdate$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const LibraryInUpdate$outboundSchema: z.ZodType< - LibraryInUpdate$Outbound, - z.ZodTypeDef, - LibraryInUpdate -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibraryInUpdate$ { - /** @deprecated use `LibraryInUpdate$inboundSchema` instead. */ - export const inboundSchema = LibraryInUpdate$inboundSchema; - /** @deprecated use `LibraryInUpdate$outboundSchema` instead. */ - export const outboundSchema = LibraryInUpdate$outboundSchema; - /** @deprecated use `LibraryInUpdate$Outbound` instead. */ - export type Outbound = LibraryInUpdate$Outbound; -} - -export function libraryInUpdateToJSON( - libraryInUpdate: LibraryInUpdate, -): string { - return JSON.stringify(LibraryInUpdate$outboundSchema.parse(libraryInUpdate)); -} - -export function libraryInUpdateFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibraryInUpdate$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibraryInUpdate' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/libraryout.ts b/examples/sdks/mistral-typescript/src/models/components/libraryout.ts deleted file mode 100644 index b02ae8e3f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/libraryout.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibraryOut = { - id: string; - name: string; - createdAt: Date; - updatedAt: Date; - ownerId: string; - ownerType: string; - totalSize: number; - nbDocuments: number; - chunkSize: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generatedName?: string | null | undefined; - generatedDescription?: string | null | undefined; - explicitUserMembersCount?: number | null | undefined; - explicitWorkspaceMembersCount?: number | null | undefined; - orgSharingRole?: string | null | undefined; -}; - -/** @internal */ -export const LibraryOut$inboundSchema: z.ZodType< - LibraryOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - name: z.string(), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - owner_id: z.string(), - owner_type: z.string(), - total_size: z.number().int(), - nb_documents: z.number().int(), - chunk_size: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generated_name: z.nullable(z.string()).optional(), - generated_description: z.nullable(z.string()).optional(), - explicit_user_members_count: z.nullable(z.number().int()).optional(), - explicit_workspace_members_count: z.nullable(z.number().int()).optional(), - org_sharing_role: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "updated_at": "updatedAt", - "owner_id": "ownerId", - "owner_type": "ownerType", - "total_size": "totalSize", - "nb_documents": "nbDocuments", - "chunk_size": "chunkSize", - "generated_name": "generatedName", - "generated_description": "generatedDescription", - "explicit_user_members_count": "explicitUserMembersCount", - "explicit_workspace_members_count": "explicitWorkspaceMembersCount", - "org_sharing_role": "orgSharingRole", - }); -}); - -/** @internal */ -export type LibraryOut$Outbound = { - id: string; - name: string; - created_at: string; - updated_at: string; - owner_id: string; - owner_type: string; - total_size: number; - nb_documents: number; - chunk_size: number | null; - emoji?: string | null | undefined; - description?: string | null | undefined; - generated_name?: string | null | undefined; - generated_description?: string | null | undefined; - explicit_user_members_count?: number | null | undefined; - explicit_workspace_members_count?: number | null | undefined; - org_sharing_role?: string | null | undefined; -}; - -/** @internal */ -export const LibraryOut$outboundSchema: z.ZodType< - LibraryOut$Outbound, - z.ZodTypeDef, - LibraryOut -> = z.object({ - id: z.string(), - name: z.string(), - createdAt: z.date().transform(v => v.toISOString()), - updatedAt: z.date().transform(v => v.toISOString()), - ownerId: z.string(), - ownerType: z.string(), - totalSize: z.number().int(), - nbDocuments: z.number().int(), - chunkSize: z.nullable(z.number().int()), - emoji: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - generatedName: z.nullable(z.string()).optional(), - generatedDescription: z.nullable(z.string()).optional(), - explicitUserMembersCount: z.nullable(z.number().int()).optional(), - explicitWorkspaceMembersCount: z.nullable(z.number().int()).optional(), - orgSharingRole: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - updatedAt: "updated_at", - ownerId: "owner_id", - ownerType: "owner_type", - totalSize: "total_size", - nbDocuments: "nb_documents", - chunkSize: "chunk_size", - generatedName: "generated_name", - generatedDescription: "generated_description", - explicitUserMembersCount: "explicit_user_members_count", - explicitWorkspaceMembersCount: "explicit_workspace_members_count", - orgSharingRole: "org_sharing_role", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibraryOut$ { - /** @deprecated use `LibraryOut$inboundSchema` instead. */ - export const inboundSchema = LibraryOut$inboundSchema; - /** @deprecated use `LibraryOut$outboundSchema` instead. */ - export const outboundSchema = LibraryOut$outboundSchema; - /** @deprecated use `LibraryOut$Outbound` instead. */ - export type Outbound = LibraryOut$Outbound; -} - -export function libraryOutToJSON(libraryOut: LibraryOut): string { - return JSON.stringify(LibraryOut$outboundSchema.parse(libraryOut)); -} - -export function libraryOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibraryOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibraryOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/listdocumentout.ts b/examples/sdks/mistral-typescript/src/models/components/listdocumentout.ts deleted file mode 100644 index da5bd4989..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/listdocumentout.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentOut, - DocumentOut$inboundSchema, - DocumentOut$Outbound, - DocumentOut$outboundSchema, -} from "./documentout.js"; -import { - PaginationInfo, - PaginationInfo$inboundSchema, - PaginationInfo$Outbound, - PaginationInfo$outboundSchema, -} from "./paginationinfo.js"; - -export type ListDocumentOut = { - pagination: PaginationInfo; - data: Array; -}; - -/** @internal */ -export const ListDocumentOut$inboundSchema: z.ZodType< - ListDocumentOut, - z.ZodTypeDef, - unknown -> = z.object({ - pagination: PaginationInfo$inboundSchema, - data: z.array(DocumentOut$inboundSchema), -}); - -/** @internal */ -export type ListDocumentOut$Outbound = { - pagination: PaginationInfo$Outbound; - data: Array; -}; - -/** @internal */ -export const ListDocumentOut$outboundSchema: z.ZodType< - ListDocumentOut$Outbound, - z.ZodTypeDef, - ListDocumentOut -> = z.object({ - pagination: PaginationInfo$outboundSchema, - data: z.array(DocumentOut$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ListDocumentOut$ { - /** @deprecated use `ListDocumentOut$inboundSchema` instead. */ - export const inboundSchema = ListDocumentOut$inboundSchema; - /** @deprecated use `ListDocumentOut$outboundSchema` instead. */ - export const outboundSchema = ListDocumentOut$outboundSchema; - /** @deprecated use `ListDocumentOut$Outbound` instead. */ - export type Outbound = ListDocumentOut$Outbound; -} - -export function listDocumentOutToJSON( - listDocumentOut: ListDocumentOut, -): string { - return JSON.stringify(ListDocumentOut$outboundSchema.parse(listDocumentOut)); -} - -export function listDocumentOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ListDocumentOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ListDocumentOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/listfilesout.ts b/examples/sdks/mistral-typescript/src/models/components/listfilesout.ts deleted file mode 100644 index b9aace6af..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/listfilesout.ts +++ /dev/null @@ -1,76 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FileSchema, - FileSchema$inboundSchema, - FileSchema$Outbound, - FileSchema$outboundSchema, -} from "./fileschema.js"; - -export type ListFilesOut = { - data: Array; - object: string; - total: number; -}; - -/** @internal */ -export const ListFilesOut$inboundSchema: z.ZodType< - ListFilesOut, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.array(FileSchema$inboundSchema), - object: z.string(), - total: z.number().int(), -}); - -/** @internal */ -export type ListFilesOut$Outbound = { - data: Array; - object: string; - total: number; -}; - -/** @internal */ -export const ListFilesOut$outboundSchema: z.ZodType< - ListFilesOut$Outbound, - z.ZodTypeDef, - ListFilesOut -> = z.object({ - data: z.array(FileSchema$outboundSchema), - object: z.string(), - total: z.number().int(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ListFilesOut$ { - /** @deprecated use `ListFilesOut$inboundSchema` instead. */ - export const inboundSchema = ListFilesOut$inboundSchema; - /** @deprecated use `ListFilesOut$outboundSchema` instead. */ - export const outboundSchema = ListFilesOut$outboundSchema; - /** @deprecated use `ListFilesOut$Outbound` instead. */ - export type Outbound = ListFilesOut$Outbound; -} - -export function listFilesOutToJSON(listFilesOut: ListFilesOut): string { - return JSON.stringify(ListFilesOut$outboundSchema.parse(listFilesOut)); -} - -export function listFilesOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ListFilesOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ListFilesOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/listlibraryout.ts b/examples/sdks/mistral-typescript/src/models/components/listlibraryout.ts deleted file mode 100644 index f7a187a42..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/listlibraryout.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - LibraryOut, - LibraryOut$inboundSchema, - LibraryOut$Outbound, - LibraryOut$outboundSchema, -} from "./libraryout.js"; - -export type ListLibraryOut = { - data: Array; -}; - -/** @internal */ -export const ListLibraryOut$inboundSchema: z.ZodType< - ListLibraryOut, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.array(LibraryOut$inboundSchema), -}); - -/** @internal */ -export type ListLibraryOut$Outbound = { - data: Array; -}; - -/** @internal */ -export const ListLibraryOut$outboundSchema: z.ZodType< - ListLibraryOut$Outbound, - z.ZodTypeDef, - ListLibraryOut -> = z.object({ - data: z.array(LibraryOut$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ListLibraryOut$ { - /** @deprecated use `ListLibraryOut$inboundSchema` instead. */ - export const inboundSchema = ListLibraryOut$inboundSchema; - /** @deprecated use `ListLibraryOut$outboundSchema` instead. */ - export const outboundSchema = ListLibraryOut$outboundSchema; - /** @deprecated use `ListLibraryOut$Outbound` instead. */ - export type Outbound = ListLibraryOut$Outbound; -} - -export function listLibraryOutToJSON(listLibraryOut: ListLibraryOut): string { - return JSON.stringify(ListLibraryOut$outboundSchema.parse(listLibraryOut)); -} - -export function listLibraryOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ListLibraryOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ListLibraryOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/listsharingout.ts b/examples/sdks/mistral-typescript/src/models/components/listsharingout.ts deleted file mode 100644 index ae9a7a999..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/listsharingout.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - SharingOut, - SharingOut$inboundSchema, - SharingOut$Outbound, - SharingOut$outboundSchema, -} from "./sharingout.js"; - -export type ListSharingOut = { - data: Array; -}; - -/** @internal */ -export const ListSharingOut$inboundSchema: z.ZodType< - ListSharingOut, - z.ZodTypeDef, - unknown -> = z.object({ - data: z.array(SharingOut$inboundSchema), -}); - -/** @internal */ -export type ListSharingOut$Outbound = { - data: Array; -}; - -/** @internal */ -export const ListSharingOut$outboundSchema: z.ZodType< - ListSharingOut$Outbound, - z.ZodTypeDef, - ListSharingOut -> = z.object({ - data: z.array(SharingOut$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ListSharingOut$ { - /** @deprecated use `ListSharingOut$inboundSchema` instead. */ - export const inboundSchema = ListSharingOut$inboundSchema; - /** @deprecated use `ListSharingOut$outboundSchema` instead. */ - export const outboundSchema = ListSharingOut$outboundSchema; - /** @deprecated use `ListSharingOut$Outbound` instead. */ - export type Outbound = ListSharingOut$Outbound; -} - -export function listSharingOutToJSON(listSharingOut: ListSharingOut): string { - return JSON.stringify(ListSharingOut$outboundSchema.parse(listSharingOut)); -} - -export function listSharingOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ListSharingOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ListSharingOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageentries.ts b/examples/sdks/mistral-typescript/src/models/components/messageentries.ts deleted file mode 100644 index 0deaec9e5..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageentries.ts +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - MessageInputEntry, - MessageInputEntry$inboundSchema, - MessageInputEntry$Outbound, - MessageInputEntry$outboundSchema, -} from "./messageinputentry.js"; -import { - MessageOutputEntry, - MessageOutputEntry$inboundSchema, - MessageOutputEntry$Outbound, - MessageOutputEntry$outboundSchema, -} from "./messageoutputentry.js"; - -export type MessageEntries = MessageInputEntry | MessageOutputEntry; - -/** @internal */ -export const MessageEntries$inboundSchema: z.ZodType< - MessageEntries, - z.ZodTypeDef, - unknown -> = z.union([ - MessageInputEntry$inboundSchema, - MessageOutputEntry$inboundSchema, -]); - -/** @internal */ -export type MessageEntries$Outbound = - | MessageInputEntry$Outbound - | MessageOutputEntry$Outbound; - -/** @internal */ -export const MessageEntries$outboundSchema: z.ZodType< - MessageEntries$Outbound, - z.ZodTypeDef, - MessageEntries -> = z.union([ - MessageInputEntry$outboundSchema, - MessageOutputEntry$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageEntries$ { - /** @deprecated use `MessageEntries$inboundSchema` instead. */ - export const inboundSchema = MessageEntries$inboundSchema; - /** @deprecated use `MessageEntries$outboundSchema` instead. */ - export const outboundSchema = MessageEntries$outboundSchema; - /** @deprecated use `MessageEntries$Outbound` instead. */ - export type Outbound = MessageEntries$Outbound; -} - -export function messageEntriesToJSON(messageEntries: MessageEntries): string { - return JSON.stringify(MessageEntries$outboundSchema.parse(messageEntries)); -} - -export function messageEntriesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageEntries$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageEntries' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageinputcontentchunks.ts b/examples/sdks/mistral-typescript/src/models/components/messageinputcontentchunks.ts deleted file mode 100644 index 907f1c9ad..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageinputcontentchunks.ts +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; -import { - ThinkChunk, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, -} from "./thinkchunk.js"; -import { - ToolFileChunk, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, -} from "./toolfilechunk.js"; - -export type MessageInputContentChunks = - | ToolFileChunk - | TextChunk - | ImageURLChunk - | DocumentURLChunk - | ThinkChunk; - -/** @internal */ -export const MessageInputContentChunks$inboundSchema: z.ZodType< - MessageInputContentChunks, - z.ZodTypeDef, - unknown -> = z.union([ - ToolFileChunk$inboundSchema, - TextChunk$inboundSchema, - ImageURLChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ThinkChunk$inboundSchema, -]); - -/** @internal */ -export type MessageInputContentChunks$Outbound = - | ToolFileChunk$Outbound - | TextChunk$Outbound - | ImageURLChunk$Outbound - | DocumentURLChunk$Outbound - | ThinkChunk$Outbound; - -/** @internal */ -export const MessageInputContentChunks$outboundSchema: z.ZodType< - MessageInputContentChunks$Outbound, - z.ZodTypeDef, - MessageInputContentChunks -> = z.union([ - ToolFileChunk$outboundSchema, - TextChunk$outboundSchema, - ImageURLChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ThinkChunk$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageInputContentChunks$ { - /** @deprecated use `MessageInputContentChunks$inboundSchema` instead. */ - export const inboundSchema = MessageInputContentChunks$inboundSchema; - /** @deprecated use `MessageInputContentChunks$outboundSchema` instead. */ - export const outboundSchema = MessageInputContentChunks$outboundSchema; - /** @deprecated use `MessageInputContentChunks$Outbound` instead. */ - export type Outbound = MessageInputContentChunks$Outbound; -} - -export function messageInputContentChunksToJSON( - messageInputContentChunks: MessageInputContentChunks, -): string { - return JSON.stringify( - MessageInputContentChunks$outboundSchema.parse(messageInputContentChunks), - ); -} - -export function messageInputContentChunksFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageInputContentChunks$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageInputContentChunks' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageinputentry.ts b/examples/sdks/mistral-typescript/src/models/components/messageinputentry.ts deleted file mode 100644 index 5200d7a39..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageinputentry.ts +++ /dev/null @@ -1,255 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - MessageInputContentChunks, - MessageInputContentChunks$inboundSchema, - MessageInputContentChunks$Outbound, - MessageInputContentChunks$outboundSchema, -} from "./messageinputcontentchunks.js"; - -export const ObjectT = { - Entry: "entry", -} as const; -export type ObjectT = ClosedEnum; - -export const MessageInputEntryType = { - MessageInput: "message.input", -} as const; -export type MessageInputEntryType = ClosedEnum; - -export const MessageInputEntryRole = { - Assistant: "assistant", - User: "user", -} as const; -export type MessageInputEntryRole = ClosedEnum; - -export type MessageInputEntryContent = - | string - | Array; - -/** - * Representation of an input message inside the conversation. - */ -export type MessageInputEntry = { - object?: ObjectT | undefined; - type?: MessageInputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - role: MessageInputEntryRole; - content: string | Array; - prefix?: boolean | undefined; -}; - -/** @internal */ -export const ObjectT$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(ObjectT); - -/** @internal */ -export const ObjectT$outboundSchema: z.ZodNativeEnum = - ObjectT$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ObjectT$ { - /** @deprecated use `ObjectT$inboundSchema` instead. */ - export const inboundSchema = ObjectT$inboundSchema; - /** @deprecated use `ObjectT$outboundSchema` instead. */ - export const outboundSchema = ObjectT$outboundSchema; -} - -/** @internal */ -export const MessageInputEntryType$inboundSchema: z.ZodNativeEnum< - typeof MessageInputEntryType -> = z.nativeEnum(MessageInputEntryType); - -/** @internal */ -export const MessageInputEntryType$outboundSchema: z.ZodNativeEnum< - typeof MessageInputEntryType -> = MessageInputEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageInputEntryType$ { - /** @deprecated use `MessageInputEntryType$inboundSchema` instead. */ - export const inboundSchema = MessageInputEntryType$inboundSchema; - /** @deprecated use `MessageInputEntryType$outboundSchema` instead. */ - export const outboundSchema = MessageInputEntryType$outboundSchema; -} - -/** @internal */ -export const MessageInputEntryRole$inboundSchema: z.ZodNativeEnum< - typeof MessageInputEntryRole -> = z.nativeEnum(MessageInputEntryRole); - -/** @internal */ -export const MessageInputEntryRole$outboundSchema: z.ZodNativeEnum< - typeof MessageInputEntryRole -> = MessageInputEntryRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageInputEntryRole$ { - /** @deprecated use `MessageInputEntryRole$inboundSchema` instead. */ - export const inboundSchema = MessageInputEntryRole$inboundSchema; - /** @deprecated use `MessageInputEntryRole$outboundSchema` instead. */ - export const outboundSchema = MessageInputEntryRole$outboundSchema; -} - -/** @internal */ -export const MessageInputEntryContent$inboundSchema: z.ZodType< - MessageInputEntryContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(MessageInputContentChunks$inboundSchema)]); - -/** @internal */ -export type MessageInputEntryContent$Outbound = - | string - | Array; - -/** @internal */ -export const MessageInputEntryContent$outboundSchema: z.ZodType< - MessageInputEntryContent$Outbound, - z.ZodTypeDef, - MessageInputEntryContent -> = z.union([z.string(), z.array(MessageInputContentChunks$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageInputEntryContent$ { - /** @deprecated use `MessageInputEntryContent$inboundSchema` instead. */ - export const inboundSchema = MessageInputEntryContent$inboundSchema; - /** @deprecated use `MessageInputEntryContent$outboundSchema` instead. */ - export const outboundSchema = MessageInputEntryContent$outboundSchema; - /** @deprecated use `MessageInputEntryContent$Outbound` instead. */ - export type Outbound = MessageInputEntryContent$Outbound; -} - -export function messageInputEntryContentToJSON( - messageInputEntryContent: MessageInputEntryContent, -): string { - return JSON.stringify( - MessageInputEntryContent$outboundSchema.parse(messageInputEntryContent), - ); -} - -export function messageInputEntryContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageInputEntryContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageInputEntryContent' from JSON`, - ); -} - -/** @internal */ -export const MessageInputEntry$inboundSchema: z.ZodType< - MessageInputEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: ObjectT$inboundSchema.default("entry"), - type: MessageInputEntryType$inboundSchema.default("message.input"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - role: MessageInputEntryRole$inboundSchema, - content: z.union([ - z.string(), - z.array(MessageInputContentChunks$inboundSchema), - ]), - prefix: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - }); -}); - -/** @internal */ -export type MessageInputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - role: string; - content: string | Array; - prefix: boolean; -}; - -/** @internal */ -export const MessageInputEntry$outboundSchema: z.ZodType< - MessageInputEntry$Outbound, - z.ZodTypeDef, - MessageInputEntry -> = z.object({ - object: ObjectT$outboundSchema.default("entry"), - type: MessageInputEntryType$outboundSchema.default("message.input"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - role: MessageInputEntryRole$outboundSchema, - content: z.union([ - z.string(), - z.array(MessageInputContentChunks$outboundSchema), - ]), - prefix: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageInputEntry$ { - /** @deprecated use `MessageInputEntry$inboundSchema` instead. */ - export const inboundSchema = MessageInputEntry$inboundSchema; - /** @deprecated use `MessageInputEntry$outboundSchema` instead. */ - export const outboundSchema = MessageInputEntry$outboundSchema; - /** @deprecated use `MessageInputEntry$Outbound` instead. */ - export type Outbound = MessageInputEntry$Outbound; -} - -export function messageInputEntryToJSON( - messageInputEntry: MessageInputEntry, -): string { - return JSON.stringify( - MessageInputEntry$outboundSchema.parse(messageInputEntry), - ); -} - -export function messageInputEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageInputEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageInputEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageoutputcontentchunks.ts b/examples/sdks/mistral-typescript/src/models/components/messageoutputcontentchunks.ts deleted file mode 100644 index 9236574da..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageoutputcontentchunks.ts +++ /dev/null @@ -1,120 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; -import { - ThinkChunk, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, -} from "./thinkchunk.js"; -import { - ToolFileChunk, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, -} from "./toolfilechunk.js"; -import { - ToolReferenceChunk, - ToolReferenceChunk$inboundSchema, - ToolReferenceChunk$Outbound, - ToolReferenceChunk$outboundSchema, -} from "./toolreferencechunk.js"; - -export type MessageOutputContentChunks = - | ToolFileChunk - | ToolReferenceChunk - | TextChunk - | ImageURLChunk - | DocumentURLChunk - | ThinkChunk; - -/** @internal */ -export const MessageOutputContentChunks$inboundSchema: z.ZodType< - MessageOutputContentChunks, - z.ZodTypeDef, - unknown -> = z.union([ - ToolFileChunk$inboundSchema, - ToolReferenceChunk$inboundSchema, - TextChunk$inboundSchema, - ImageURLChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ThinkChunk$inboundSchema, -]); - -/** @internal */ -export type MessageOutputContentChunks$Outbound = - | ToolFileChunk$Outbound - | ToolReferenceChunk$Outbound - | TextChunk$Outbound - | ImageURLChunk$Outbound - | DocumentURLChunk$Outbound - | ThinkChunk$Outbound; - -/** @internal */ -export const MessageOutputContentChunks$outboundSchema: z.ZodType< - MessageOutputContentChunks$Outbound, - z.ZodTypeDef, - MessageOutputContentChunks -> = z.union([ - ToolFileChunk$outboundSchema, - ToolReferenceChunk$outboundSchema, - TextChunk$outboundSchema, - ImageURLChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ThinkChunk$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputContentChunks$ { - /** @deprecated use `MessageOutputContentChunks$inboundSchema` instead. */ - export const inboundSchema = MessageOutputContentChunks$inboundSchema; - /** @deprecated use `MessageOutputContentChunks$outboundSchema` instead. */ - export const outboundSchema = MessageOutputContentChunks$outboundSchema; - /** @deprecated use `MessageOutputContentChunks$Outbound` instead. */ - export type Outbound = MessageOutputContentChunks$Outbound; -} - -export function messageOutputContentChunksToJSON( - messageOutputContentChunks: MessageOutputContentChunks, -): string { - return JSON.stringify( - MessageOutputContentChunks$outboundSchema.parse(messageOutputContentChunks), - ); -} - -export function messageOutputContentChunksFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageOutputContentChunks$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageOutputContentChunks' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageoutputentry.ts b/examples/sdks/mistral-typescript/src/models/components/messageoutputentry.ts deleted file mode 100644 index 6e24b6ab1..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageoutputentry.ts +++ /dev/null @@ -1,261 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - MessageOutputContentChunks, - MessageOutputContentChunks$inboundSchema, - MessageOutputContentChunks$Outbound, - MessageOutputContentChunks$outboundSchema, -} from "./messageoutputcontentchunks.js"; - -export const MessageOutputEntryObject = { - Entry: "entry", -} as const; -export type MessageOutputEntryObject = ClosedEnum< - typeof MessageOutputEntryObject ->; - -export const MessageOutputEntryType = { - MessageOutput: "message.output", -} as const; -export type MessageOutputEntryType = ClosedEnum; - -export const MessageOutputEntryRole = { - Assistant: "assistant", -} as const; -export type MessageOutputEntryRole = ClosedEnum; - -export type MessageOutputEntryContent = - | string - | Array; - -export type MessageOutputEntry = { - object?: MessageOutputEntryObject | undefined; - type?: MessageOutputEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - agentId?: string | null | undefined; - model?: string | null | undefined; - role?: MessageOutputEntryRole | undefined; - content: string | Array; -}; - -/** @internal */ -export const MessageOutputEntryObject$inboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryObject -> = z.nativeEnum(MessageOutputEntryObject); - -/** @internal */ -export const MessageOutputEntryObject$outboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryObject -> = MessageOutputEntryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEntryObject$ { - /** @deprecated use `MessageOutputEntryObject$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEntryObject$inboundSchema; - /** @deprecated use `MessageOutputEntryObject$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEntryObject$outboundSchema; -} - -/** @internal */ -export const MessageOutputEntryType$inboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryType -> = z.nativeEnum(MessageOutputEntryType); - -/** @internal */ -export const MessageOutputEntryType$outboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryType -> = MessageOutputEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEntryType$ { - /** @deprecated use `MessageOutputEntryType$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEntryType$inboundSchema; - /** @deprecated use `MessageOutputEntryType$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEntryType$outboundSchema; -} - -/** @internal */ -export const MessageOutputEntryRole$inboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryRole -> = z.nativeEnum(MessageOutputEntryRole); - -/** @internal */ -export const MessageOutputEntryRole$outboundSchema: z.ZodNativeEnum< - typeof MessageOutputEntryRole -> = MessageOutputEntryRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEntryRole$ { - /** @deprecated use `MessageOutputEntryRole$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEntryRole$inboundSchema; - /** @deprecated use `MessageOutputEntryRole$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEntryRole$outboundSchema; -} - -/** @internal */ -export const MessageOutputEntryContent$inboundSchema: z.ZodType< - MessageOutputEntryContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(MessageOutputContentChunks$inboundSchema)]); - -/** @internal */ -export type MessageOutputEntryContent$Outbound = - | string - | Array; - -/** @internal */ -export const MessageOutputEntryContent$outboundSchema: z.ZodType< - MessageOutputEntryContent$Outbound, - z.ZodTypeDef, - MessageOutputEntryContent -> = z.union([z.string(), z.array(MessageOutputContentChunks$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEntryContent$ { - /** @deprecated use `MessageOutputEntryContent$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEntryContent$inboundSchema; - /** @deprecated use `MessageOutputEntryContent$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEntryContent$outboundSchema; - /** @deprecated use `MessageOutputEntryContent$Outbound` instead. */ - export type Outbound = MessageOutputEntryContent$Outbound; -} - -export function messageOutputEntryContentToJSON( - messageOutputEntryContent: MessageOutputEntryContent, -): string { - return JSON.stringify( - MessageOutputEntryContent$outboundSchema.parse(messageOutputEntryContent), - ); -} - -export function messageOutputEntryContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageOutputEntryContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageOutputEntryContent' from JSON`, - ); -} - -/** @internal */ -export const MessageOutputEntry$inboundSchema: z.ZodType< - MessageOutputEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: MessageOutputEntryObject$inboundSchema.default("entry"), - type: MessageOutputEntryType$inboundSchema.default("message.output"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - agent_id: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: MessageOutputEntryRole$inboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(MessageOutputContentChunks$inboundSchema), - ]), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type MessageOutputEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - agent_id?: string | null | undefined; - model?: string | null | undefined; - role: string; - content: string | Array; -}; - -/** @internal */ -export const MessageOutputEntry$outboundSchema: z.ZodType< - MessageOutputEntry$Outbound, - z.ZodTypeDef, - MessageOutputEntry -> = z.object({ - object: MessageOutputEntryObject$outboundSchema.default("entry"), - type: MessageOutputEntryType$outboundSchema.default("message.output"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - agentId: z.nullable(z.string()).optional(), - model: z.nullable(z.string()).optional(), - role: MessageOutputEntryRole$outboundSchema.default("assistant"), - content: z.union([ - z.string(), - z.array(MessageOutputContentChunks$outboundSchema), - ]), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEntry$ { - /** @deprecated use `MessageOutputEntry$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEntry$inboundSchema; - /** @deprecated use `MessageOutputEntry$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEntry$outboundSchema; - /** @deprecated use `MessageOutputEntry$Outbound` instead. */ - export type Outbound = MessageOutputEntry$Outbound; -} - -export function messageOutputEntryToJSON( - messageOutputEntry: MessageOutputEntry, -): string { - return JSON.stringify( - MessageOutputEntry$outboundSchema.parse(messageOutputEntry), - ); -} - -export function messageOutputEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageOutputEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageOutputEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/messageoutputevent.ts b/examples/sdks/mistral-typescript/src/models/components/messageoutputevent.ts deleted file mode 100644 index 7bddcf532..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/messageoutputevent.ts +++ /dev/null @@ -1,225 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - OutputContentChunks, - OutputContentChunks$inboundSchema, - OutputContentChunks$Outbound, - OutputContentChunks$outboundSchema, -} from "./outputcontentchunks.js"; - -export const MessageOutputEventType = { - MessageOutputDelta: "message.output.delta", -} as const; -export type MessageOutputEventType = ClosedEnum; - -export const MessageOutputEventRole = { - Assistant: "assistant", -} as const; -export type MessageOutputEventRole = ClosedEnum; - -export type MessageOutputEventContent = string | OutputContentChunks; - -export type MessageOutputEvent = { - type?: MessageOutputEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - contentIndex?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - role?: MessageOutputEventRole | undefined; - content: string | OutputContentChunks; -}; - -/** @internal */ -export const MessageOutputEventType$inboundSchema: z.ZodNativeEnum< - typeof MessageOutputEventType -> = z.nativeEnum(MessageOutputEventType); - -/** @internal */ -export const MessageOutputEventType$outboundSchema: z.ZodNativeEnum< - typeof MessageOutputEventType -> = MessageOutputEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEventType$ { - /** @deprecated use `MessageOutputEventType$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEventType$inboundSchema; - /** @deprecated use `MessageOutputEventType$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEventType$outboundSchema; -} - -/** @internal */ -export const MessageOutputEventRole$inboundSchema: z.ZodNativeEnum< - typeof MessageOutputEventRole -> = z.nativeEnum(MessageOutputEventRole); - -/** @internal */ -export const MessageOutputEventRole$outboundSchema: z.ZodNativeEnum< - typeof MessageOutputEventRole -> = MessageOutputEventRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEventRole$ { - /** @deprecated use `MessageOutputEventRole$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEventRole$inboundSchema; - /** @deprecated use `MessageOutputEventRole$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEventRole$outboundSchema; -} - -/** @internal */ -export const MessageOutputEventContent$inboundSchema: z.ZodType< - MessageOutputEventContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), OutputContentChunks$inboundSchema]); - -/** @internal */ -export type MessageOutputEventContent$Outbound = - | string - | OutputContentChunks$Outbound; - -/** @internal */ -export const MessageOutputEventContent$outboundSchema: z.ZodType< - MessageOutputEventContent$Outbound, - z.ZodTypeDef, - MessageOutputEventContent -> = z.union([z.string(), OutputContentChunks$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEventContent$ { - /** @deprecated use `MessageOutputEventContent$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEventContent$inboundSchema; - /** @deprecated use `MessageOutputEventContent$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEventContent$outboundSchema; - /** @deprecated use `MessageOutputEventContent$Outbound` instead. */ - export type Outbound = MessageOutputEventContent$Outbound; -} - -export function messageOutputEventContentToJSON( - messageOutputEventContent: MessageOutputEventContent, -): string { - return JSON.stringify( - MessageOutputEventContent$outboundSchema.parse(messageOutputEventContent), - ); -} - -export function messageOutputEventContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageOutputEventContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageOutputEventContent' from JSON`, - ); -} - -/** @internal */ -export const MessageOutputEvent$inboundSchema: z.ZodType< - MessageOutputEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: MessageOutputEventType$inboundSchema.default("message.output.delta"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - content_index: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - role: MessageOutputEventRole$inboundSchema.default("assistant"), - content: z.union([z.string(), OutputContentChunks$inboundSchema]), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - "content_index": "contentIndex", - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type MessageOutputEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - content_index: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - role: string; - content: string | OutputContentChunks$Outbound; -}; - -/** @internal */ -export const MessageOutputEvent$outboundSchema: z.ZodType< - MessageOutputEvent$Outbound, - z.ZodTypeDef, - MessageOutputEvent -> = z.object({ - type: MessageOutputEventType$outboundSchema.default("message.output.delta"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - contentIndex: z.number().int().default(0), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - role: MessageOutputEventRole$outboundSchema.default("assistant"), - content: z.union([z.string(), OutputContentChunks$outboundSchema]), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - contentIndex: "content_index", - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MessageOutputEvent$ { - /** @deprecated use `MessageOutputEvent$inboundSchema` instead. */ - export const inboundSchema = MessageOutputEvent$inboundSchema; - /** @deprecated use `MessageOutputEvent$outboundSchema` instead. */ - export const outboundSchema = MessageOutputEvent$outboundSchema; - /** @deprecated use `MessageOutputEvent$Outbound` instead. */ - export type Outbound = MessageOutputEvent$Outbound; -} - -export function messageOutputEventToJSON( - messageOutputEvent: MessageOutputEvent, -): string { - return JSON.stringify( - MessageOutputEvent$outboundSchema.parse(messageOutputEvent), - ); -} - -export function messageOutputEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MessageOutputEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MessageOutputEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/metricout.ts b/examples/sdks/mistral-typescript/src/models/components/metricout.ts deleted file mode 100644 index dedec7e41..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/metricout.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - */ -export type MetricOut = { - trainLoss?: number | null | undefined; - validLoss?: number | null | undefined; - validMeanTokenAccuracy?: number | null | undefined; -}; - -/** @internal */ -export const MetricOut$inboundSchema: z.ZodType< - MetricOut, - z.ZodTypeDef, - unknown -> = z.object({ - train_loss: z.nullable(z.number()).optional(), - valid_loss: z.nullable(z.number()).optional(), - valid_mean_token_accuracy: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - "train_loss": "trainLoss", - "valid_loss": "validLoss", - "valid_mean_token_accuracy": "validMeanTokenAccuracy", - }); -}); - -/** @internal */ -export type MetricOut$Outbound = { - train_loss?: number | null | undefined; - valid_loss?: number | null | undefined; - valid_mean_token_accuracy?: number | null | undefined; -}; - -/** @internal */ -export const MetricOut$outboundSchema: z.ZodType< - MetricOut$Outbound, - z.ZodTypeDef, - MetricOut -> = z.object({ - trainLoss: z.nullable(z.number()).optional(), - validLoss: z.nullable(z.number()).optional(), - validMeanTokenAccuracy: z.nullable(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - trainLoss: "train_loss", - validLoss: "valid_loss", - validMeanTokenAccuracy: "valid_mean_token_accuracy", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MetricOut$ { - /** @deprecated use `MetricOut$inboundSchema` instead. */ - export const inboundSchema = MetricOut$inboundSchema; - /** @deprecated use `MetricOut$outboundSchema` instead. */ - export const outboundSchema = MetricOut$outboundSchema; - /** @deprecated use `MetricOut$Outbound` instead. */ - export type Outbound = MetricOut$Outbound; -} - -export function metricOutToJSON(metricOut: MetricOut): string { - return JSON.stringify(MetricOut$outboundSchema.parse(metricOut)); -} - -export function metricOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => MetricOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'MetricOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/mistralpromptmode.ts b/examples/sdks/mistral-typescript/src/models/components/mistralpromptmode.ts deleted file mode 100644 index b17c1e2eb..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/mistralpromptmode.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const MistralPromptMode = { - Reasoning: "reasoning", -} as const; -export type MistralPromptMode = OpenEnum; - -/** @internal */ -export const MistralPromptMode$inboundSchema: z.ZodType< - MistralPromptMode, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(MistralPromptMode), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const MistralPromptMode$outboundSchema: z.ZodType< - MistralPromptMode, - z.ZodTypeDef, - MistralPromptMode -> = z.union([ - z.nativeEnum(MistralPromptMode), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace MistralPromptMode$ { - /** @deprecated use `MistralPromptMode$inboundSchema` instead. */ - export const inboundSchema = MistralPromptMode$inboundSchema; - /** @deprecated use `MistralPromptMode$outboundSchema` instead. */ - export const outboundSchema = MistralPromptMode$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/modelcapabilities.ts b/examples/sdks/mistral-typescript/src/models/components/modelcapabilities.ts deleted file mode 100644 index 9817c29ef..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/modelcapabilities.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ModelCapabilities = { - completionChat?: boolean | undefined; - completionFim?: boolean | undefined; - functionCalling?: boolean | undefined; - fineTuning?: boolean | undefined; - vision?: boolean | undefined; - classification?: boolean | undefined; -}; - -/** @internal */ -export const ModelCapabilities$inboundSchema: z.ZodType< - ModelCapabilities, - z.ZodTypeDef, - unknown -> = z.object({ - completion_chat: z.boolean().default(true), - completion_fim: z.boolean().default(false), - function_calling: z.boolean().default(true), - fine_tuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - "completion_chat": "completionChat", - "completion_fim": "completionFim", - "function_calling": "functionCalling", - "fine_tuning": "fineTuning", - }); -}); - -/** @internal */ -export type ModelCapabilities$Outbound = { - completion_chat: boolean; - completion_fim: boolean; - function_calling: boolean; - fine_tuning: boolean; - vision: boolean; - classification: boolean; -}; - -/** @internal */ -export const ModelCapabilities$outboundSchema: z.ZodType< - ModelCapabilities$Outbound, - z.ZodTypeDef, - ModelCapabilities -> = z.object({ - completionChat: z.boolean().default(true), - completionFim: z.boolean().default(false), - functionCalling: z.boolean().default(true), - fineTuning: z.boolean().default(false), - vision: z.boolean().default(false), - classification: z.boolean().default(false), -}).transform((v) => { - return remap$(v, { - completionChat: "completion_chat", - completionFim: "completion_fim", - functionCalling: "function_calling", - fineTuning: "fine_tuning", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelCapabilities$ { - /** @deprecated use `ModelCapabilities$inboundSchema` instead. */ - export const inboundSchema = ModelCapabilities$inboundSchema; - /** @deprecated use `ModelCapabilities$outboundSchema` instead. */ - export const outboundSchema = ModelCapabilities$outboundSchema; - /** @deprecated use `ModelCapabilities$Outbound` instead. */ - export type Outbound = ModelCapabilities$Outbound; -} - -export function modelCapabilitiesToJSON( - modelCapabilities: ModelCapabilities, -): string { - return JSON.stringify( - ModelCapabilities$outboundSchema.parse(modelCapabilities), - ); -} - -export function modelCapabilitiesFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModelCapabilities$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModelCapabilities' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/modelconversation.ts b/examples/sdks/mistral-typescript/src/models/components/modelconversation.ts deleted file mode 100644 index 7ac7a4f85..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/modelconversation.ts +++ /dev/null @@ -1,409 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - CodeInterpreterTool, - CodeInterpreterTool$inboundSchema, - CodeInterpreterTool$Outbound, - CodeInterpreterTool$outboundSchema, -} from "./codeinterpretertool.js"; -import { - CompletionArgs, - CompletionArgs$inboundSchema, - CompletionArgs$Outbound, - CompletionArgs$outboundSchema, -} from "./completionargs.js"; -import { - DocumentLibraryTool, - DocumentLibraryTool$inboundSchema, - DocumentLibraryTool$Outbound, - DocumentLibraryTool$outboundSchema, -} from "./documentlibrarytool.js"; -import { - FunctionTool, - FunctionTool$inboundSchema, - FunctionTool$Outbound, - FunctionTool$outboundSchema, -} from "./functiontool.js"; -import { - ImageGenerationTool, - ImageGenerationTool$inboundSchema, - ImageGenerationTool$Outbound, - ImageGenerationTool$outboundSchema, -} from "./imagegenerationtool.js"; -import { - WebSearchPremiumTool, - WebSearchPremiumTool$inboundSchema, - WebSearchPremiumTool$Outbound, - WebSearchPremiumTool$outboundSchema, -} from "./websearchpremiumtool.js"; -import { - WebSearchTool, - WebSearchTool$inboundSchema, - WebSearchTool$Outbound, - WebSearchTool$outboundSchema, -} from "./websearchtool.js"; - -export type ModelConversationTools = - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }); - -export const ModelConversationObject = { - Conversation: "conversation", -} as const; -export type ModelConversationObject = ClosedEnum< - typeof ModelConversationObject ->; - -export type ModelConversation = { - /** - * Instruction prompt the model will follow during the conversation. - */ - instructions?: string | null | undefined; - /** - * List of tools which are available to the model during the conversation. - */ - tools?: - | Array< - | (DocumentLibraryTool & { type: "document_library" }) - | (FunctionTool & { type: "function" }) - | (CodeInterpreterTool & { type: "code_interpreter" }) - | (ImageGenerationTool & { type: "image_generation" }) - | (WebSearchTool & { type: "web_search" }) - | (WebSearchPremiumTool & { type: "web_search_premium" }) - > - | undefined; - /** - * White-listed arguments from the completion API - */ - completionArgs?: CompletionArgs | undefined; - /** - * Name given to the conversation. - */ - name?: string | null | undefined; - /** - * Description of the what the conversation is about. - */ - description?: string | null | undefined; - object?: ModelConversationObject | undefined; - id: string; - createdAt: Date; - updatedAt: Date; - model: string; -}; - -/** @internal */ -export const ModelConversationTools$inboundSchema: z.ZodType< - ModelConversationTools, - z.ZodTypeDef, - unknown -> = z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type ModelConversationTools$Outbound = - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }); - -/** @internal */ -export const ModelConversationTools$outboundSchema: z.ZodType< - ModelConversationTools$Outbound, - z.ZodTypeDef, - ModelConversationTools -> = z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelConversationTools$ { - /** @deprecated use `ModelConversationTools$inboundSchema` instead. */ - export const inboundSchema = ModelConversationTools$inboundSchema; - /** @deprecated use `ModelConversationTools$outboundSchema` instead. */ - export const outboundSchema = ModelConversationTools$outboundSchema; - /** @deprecated use `ModelConversationTools$Outbound` instead. */ - export type Outbound = ModelConversationTools$Outbound; -} - -export function modelConversationToolsToJSON( - modelConversationTools: ModelConversationTools, -): string { - return JSON.stringify( - ModelConversationTools$outboundSchema.parse(modelConversationTools), - ); -} - -export function modelConversationToolsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModelConversationTools$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModelConversationTools' from JSON`, - ); -} - -/** @internal */ -export const ModelConversationObject$inboundSchema: z.ZodNativeEnum< - typeof ModelConversationObject -> = z.nativeEnum(ModelConversationObject); - -/** @internal */ -export const ModelConversationObject$outboundSchema: z.ZodNativeEnum< - typeof ModelConversationObject -> = ModelConversationObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelConversationObject$ { - /** @deprecated use `ModelConversationObject$inboundSchema` instead. */ - export const inboundSchema = ModelConversationObject$inboundSchema; - /** @deprecated use `ModelConversationObject$outboundSchema` instead. */ - export const outboundSchema = ModelConversationObject$outboundSchema; -} - -/** @internal */ -export const ModelConversation$inboundSchema: z.ZodType< - ModelConversation, - z.ZodTypeDef, - unknown -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$inboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$inboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$inboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$inboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$inboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$inboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completion_args: CompletionArgs$inboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: ModelConversationObject$inboundSchema.default("conversation"), - id: z.string(), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - model: z.string(), -}).transform((v) => { - return remap$(v, { - "completion_args": "completionArgs", - "created_at": "createdAt", - "updated_at": "updatedAt", - }); -}); - -/** @internal */ -export type ModelConversation$Outbound = { - instructions?: string | null | undefined; - tools?: - | Array< - | (DocumentLibraryTool$Outbound & { type: "document_library" }) - | (FunctionTool$Outbound & { type: "function" }) - | (CodeInterpreterTool$Outbound & { type: "code_interpreter" }) - | (ImageGenerationTool$Outbound & { type: "image_generation" }) - | (WebSearchTool$Outbound & { type: "web_search" }) - | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" }) - > - | undefined; - completion_args?: CompletionArgs$Outbound | undefined; - name?: string | null | undefined; - description?: string | null | undefined; - object: string; - id: string; - created_at: string; - updated_at: string; - model: string; -}; - -/** @internal */ -export const ModelConversation$outboundSchema: z.ZodType< - ModelConversation$Outbound, - z.ZodTypeDef, - ModelConversation -> = z.object({ - instructions: z.nullable(z.string()).optional(), - tools: z.array( - z.union([ - DocumentLibraryTool$outboundSchema.and( - z.object({ type: z.literal("document_library") }).transform((v) => ({ - type: v.type, - })), - ), - FunctionTool$outboundSchema.and( - z.object({ type: z.literal("function") }).transform((v) => ({ - type: v.type, - })), - ), - CodeInterpreterTool$outboundSchema.and( - z.object({ type: z.literal("code_interpreter") }).transform((v) => ({ - type: v.type, - })), - ), - ImageGenerationTool$outboundSchema.and( - z.object({ type: z.literal("image_generation") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchTool$outboundSchema.and( - z.object({ type: z.literal("web_search") }).transform((v) => ({ - type: v.type, - })), - ), - WebSearchPremiumTool$outboundSchema.and( - z.object({ type: z.literal("web_search_premium") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), - completionArgs: CompletionArgs$outboundSchema.optional(), - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), - object: ModelConversationObject$outboundSchema.default("conversation"), - id: z.string(), - createdAt: z.date().transform(v => v.toISOString()), - updatedAt: z.date().transform(v => v.toISOString()), - model: z.string(), -}).transform((v) => { - return remap$(v, { - completionArgs: "completion_args", - createdAt: "created_at", - updatedAt: "updated_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelConversation$ { - /** @deprecated use `ModelConversation$inboundSchema` instead. */ - export const inboundSchema = ModelConversation$inboundSchema; - /** @deprecated use `ModelConversation$outboundSchema` instead. */ - export const outboundSchema = ModelConversation$outboundSchema; - /** @deprecated use `ModelConversation$Outbound` instead. */ - export type Outbound = ModelConversation$Outbound; -} - -export function modelConversationToJSON( - modelConversation: ModelConversation, -): string { - return JSON.stringify( - ModelConversation$outboundSchema.parse(modelConversation), - ); -} - -export function modelConversationFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModelConversation$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModelConversation' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/modellist.ts b/examples/sdks/mistral-typescript/src/models/components/modellist.ts deleted file mode 100644 index a68637306..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/modellist.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BaseModelCard, - BaseModelCard$inboundSchema, - BaseModelCard$Outbound, - BaseModelCard$outboundSchema, -} from "./basemodelcard.js"; -import { - FTModelCard, - FTModelCard$inboundSchema, - FTModelCard$Outbound, - FTModelCard$outboundSchema, -} from "./ftmodelcard.js"; - -export type Data = - | (FTModelCard & { type: "fine-tuned" }) - | (BaseModelCard & { type: "base" }); - -export type ModelList = { - object?: string | undefined; - data?: - | Array< - | (FTModelCard & { type: "fine-tuned" }) - | (BaseModelCard & { type: "base" }) - > - | undefined; -}; - -/** @internal */ -export const Data$inboundSchema: z.ZodType = z - .union([ - FTModelCard$inboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - BaseModelCard$inboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]); - -/** @internal */ -export type Data$Outbound = - | (FTModelCard$Outbound & { type: "fine-tuned" }) - | (BaseModelCard$Outbound & { type: "base" }); - -/** @internal */ -export const Data$outboundSchema: z.ZodType = - z.union([ - FTModelCard$outboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - BaseModelCard$outboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Data$ { - /** @deprecated use `Data$inboundSchema` instead. */ - export const inboundSchema = Data$inboundSchema; - /** @deprecated use `Data$outboundSchema` instead. */ - export const outboundSchema = Data$outboundSchema; - /** @deprecated use `Data$Outbound` instead. */ - export type Outbound = Data$Outbound; -} - -export function dataToJSON(data: Data): string { - return JSON.stringify(Data$outboundSchema.parse(data)); -} - -export function dataFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Data$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Data' from JSON`, - ); -} - -/** @internal */ -export const ModelList$inboundSchema: z.ZodType< - ModelList, - z.ZodTypeDef, - unknown -> = z.object({ - object: z.string().default("list"), - data: z.array( - z.union([ - FTModelCard$inboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - BaseModelCard$inboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), -}); - -/** @internal */ -export type ModelList$Outbound = { - object: string; - data?: - | Array< - | (FTModelCard$Outbound & { type: "fine-tuned" }) - | (BaseModelCard$Outbound & { type: "base" }) - > - | undefined; -}; - -/** @internal */ -export const ModelList$outboundSchema: z.ZodType< - ModelList$Outbound, - z.ZodTypeDef, - ModelList -> = z.object({ - object: z.string().default("list"), - data: z.array( - z.union([ - FTModelCard$outboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - BaseModelCard$outboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]), - ).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModelList$ { - /** @deprecated use `ModelList$inboundSchema` instead. */ - export const inboundSchema = ModelList$inboundSchema; - /** @deprecated use `ModelList$outboundSchema` instead. */ - export const outboundSchema = ModelList$outboundSchema; - /** @deprecated use `ModelList$Outbound` instead. */ - export type Outbound = ModelList$Outbound; -} - -export function modelListToJSON(modelList: ModelList): string { - return JSON.stringify(ModelList$outboundSchema.parse(modelList)); -} - -export function modelListFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModelList$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModelList' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/moderationobject.ts b/examples/sdks/mistral-typescript/src/models/components/moderationobject.ts deleted file mode 100644 index a610a1460..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/moderationobject.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ModerationObject = { - /** - * Moderation result thresholds - */ - categories?: { [k: string]: boolean } | undefined; - /** - * Moderation result - */ - categoryScores?: { [k: string]: number } | undefined; -}; - -/** @internal */ -export const ModerationObject$inboundSchema: z.ZodType< - ModerationObject, - z.ZodTypeDef, - unknown -> = z.object({ - categories: z.record(z.boolean()).optional(), - category_scores: z.record(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - "category_scores": "categoryScores", - }); -}); - -/** @internal */ -export type ModerationObject$Outbound = { - categories?: { [k: string]: boolean } | undefined; - category_scores?: { [k: string]: number } | undefined; -}; - -/** @internal */ -export const ModerationObject$outboundSchema: z.ZodType< - ModerationObject$Outbound, - z.ZodTypeDef, - ModerationObject -> = z.object({ - categories: z.record(z.boolean()).optional(), - categoryScores: z.record(z.number()).optional(), -}).transform((v) => { - return remap$(v, { - categoryScores: "category_scores", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModerationObject$ { - /** @deprecated use `ModerationObject$inboundSchema` instead. */ - export const inboundSchema = ModerationObject$inboundSchema; - /** @deprecated use `ModerationObject$outboundSchema` instead. */ - export const outboundSchema = ModerationObject$outboundSchema; - /** @deprecated use `ModerationObject$Outbound` instead. */ - export type Outbound = ModerationObject$Outbound; -} - -export function moderationObjectToJSON( - moderationObject: ModerationObject, -): string { - return JSON.stringify( - ModerationObject$outboundSchema.parse(moderationObject), - ); -} - -export function moderationObjectFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModerationObject$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModerationObject' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/moderationresponse.ts b/examples/sdks/mistral-typescript/src/models/components/moderationresponse.ts deleted file mode 100644 index 71bde0854..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/moderationresponse.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ModerationObject, - ModerationObject$inboundSchema, - ModerationObject$Outbound, - ModerationObject$outboundSchema, -} from "./moderationobject.js"; - -export type ModerationResponse = { - id: string; - model: string; - results: Array; -}; - -/** @internal */ -export const ModerationResponse$inboundSchema: z.ZodType< - ModerationResponse, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - model: z.string(), - results: z.array(ModerationObject$inboundSchema), -}); - -/** @internal */ -export type ModerationResponse$Outbound = { - id: string; - model: string; - results: Array; -}; - -/** @internal */ -export const ModerationResponse$outboundSchema: z.ZodType< - ModerationResponse$Outbound, - z.ZodTypeDef, - ModerationResponse -> = z.object({ - id: z.string(), - model: z.string(), - results: z.array(ModerationObject$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ModerationResponse$ { - /** @deprecated use `ModerationResponse$inboundSchema` instead. */ - export const inboundSchema = ModerationResponse$inboundSchema; - /** @deprecated use `ModerationResponse$outboundSchema` instead. */ - export const outboundSchema = ModerationResponse$outboundSchema; - /** @deprecated use `ModerationResponse$Outbound` instead. */ - export type Outbound = ModerationResponse$Outbound; -} - -export function moderationResponseToJSON( - moderationResponse: ModerationResponse, -): string { - return JSON.stringify( - ModerationResponse$outboundSchema.parse(moderationResponse), - ); -} - -export function moderationResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ModerationResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ModerationResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrimageobject.ts b/examples/sdks/mistral-typescript/src/models/components/ocrimageobject.ts deleted file mode 100644 index d01ac119d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrimageobject.ts +++ /dev/null @@ -1,126 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRImageObject = { - /** - * Image ID for extracted image in a page - */ - id: string; - /** - * X coordinate of top-left corner of the extracted image - */ - topLeftX: number | null; - /** - * Y coordinate of top-left corner of the extracted image - */ - topLeftY: number | null; - /** - * X coordinate of bottom-right corner of the extracted image - */ - bottomRightX: number | null; - /** - * Y coordinate of bottom-right corner of the extracted image - */ - bottomRightY: number | null; - /** - * Base64 string of the extracted image - */ - imageBase64?: string | null | undefined; - /** - * Annotation of the extracted image in json str - */ - imageAnnotation?: string | null | undefined; -}; - -/** @internal */ -export const OCRImageObject$inboundSchema: z.ZodType< - OCRImageObject, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - top_left_x: z.nullable(z.number().int()), - top_left_y: z.nullable(z.number().int()), - bottom_right_x: z.nullable(z.number().int()), - bottom_right_y: z.nullable(z.number().int()), - image_base64: z.nullable(z.string()).optional(), - image_annotation: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "top_left_x": "topLeftX", - "top_left_y": "topLeftY", - "bottom_right_x": "bottomRightX", - "bottom_right_y": "bottomRightY", - "image_base64": "imageBase64", - "image_annotation": "imageAnnotation", - }); -}); - -/** @internal */ -export type OCRImageObject$Outbound = { - id: string; - top_left_x: number | null; - top_left_y: number | null; - bottom_right_x: number | null; - bottom_right_y: number | null; - image_base64?: string | null | undefined; - image_annotation?: string | null | undefined; -}; - -/** @internal */ -export const OCRImageObject$outboundSchema: z.ZodType< - OCRImageObject$Outbound, - z.ZodTypeDef, - OCRImageObject -> = z.object({ - id: z.string(), - topLeftX: z.nullable(z.number().int()), - topLeftY: z.nullable(z.number().int()), - bottomRightX: z.nullable(z.number().int()), - bottomRightY: z.nullable(z.number().int()), - imageBase64: z.nullable(z.string()).optional(), - imageAnnotation: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - topLeftX: "top_left_x", - topLeftY: "top_left_y", - bottomRightX: "bottom_right_x", - bottomRightY: "bottom_right_y", - imageBase64: "image_base64", - imageAnnotation: "image_annotation", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRImageObject$ { - /** @deprecated use `OCRImageObject$inboundSchema` instead. */ - export const inboundSchema = OCRImageObject$inboundSchema; - /** @deprecated use `OCRImageObject$outboundSchema` instead. */ - export const outboundSchema = OCRImageObject$outboundSchema; - /** @deprecated use `OCRImageObject$Outbound` instead. */ - export type Outbound = OCRImageObject$Outbound; -} - -export function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string { - return JSON.stringify(OCRImageObject$outboundSchema.parse(ocrImageObject)); -} - -export function ocrImageObjectFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRImageObject$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRImageObject' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrpagedimensions.ts b/examples/sdks/mistral-typescript/src/models/components/ocrpagedimensions.ts deleted file mode 100644 index 67079fd19..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrpagedimensions.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRPageDimensions = { - /** - * Dots per inch of the page-image - */ - dpi: number; - /** - * Height of the image in pixels - */ - height: number; - /** - * Width of the image in pixels - */ - width: number; -}; - -/** @internal */ -export const OCRPageDimensions$inboundSchema: z.ZodType< - OCRPageDimensions, - z.ZodTypeDef, - unknown -> = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int(), -}); - -/** @internal */ -export type OCRPageDimensions$Outbound = { - dpi: number; - height: number; - width: number; -}; - -/** @internal */ -export const OCRPageDimensions$outboundSchema: z.ZodType< - OCRPageDimensions$Outbound, - z.ZodTypeDef, - OCRPageDimensions -> = z.object({ - dpi: z.number().int(), - height: z.number().int(), - width: z.number().int(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRPageDimensions$ { - /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */ - export const inboundSchema = OCRPageDimensions$inboundSchema; - /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */ - export const outboundSchema = OCRPageDimensions$outboundSchema; - /** @deprecated use `OCRPageDimensions$Outbound` instead. */ - export type Outbound = OCRPageDimensions$Outbound; -} - -export function ocrPageDimensionsToJSON( - ocrPageDimensions: OCRPageDimensions, -): string { - return JSON.stringify( - OCRPageDimensions$outboundSchema.parse(ocrPageDimensions), - ); -} - -export function ocrPageDimensionsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRPageDimensions$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRPageDimensions' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrpageobject.ts b/examples/sdks/mistral-typescript/src/models/components/ocrpageobject.ts deleted file mode 100644 index 9b5a3086a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrpageobject.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - OCRImageObject, - OCRImageObject$inboundSchema, - OCRImageObject$Outbound, - OCRImageObject$outboundSchema, -} from "./ocrimageobject.js"; -import { - OCRPageDimensions, - OCRPageDimensions$inboundSchema, - OCRPageDimensions$Outbound, - OCRPageDimensions$outboundSchema, -} from "./ocrpagedimensions.js"; - -export type OCRPageObject = { - /** - * The page index in a pdf document starting from 0 - */ - index: number; - /** - * The markdown string response of the page - */ - markdown: string; - /** - * List of all extracted images in the page - */ - images: Array; - /** - * The dimensions of the PDF Page's screenshot image - */ - dimensions: OCRPageDimensions | null; -}; - -/** @internal */ -export const OCRPageObject$inboundSchema: z.ZodType< - OCRPageObject, - z.ZodTypeDef, - unknown -> = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(OCRImageObject$inboundSchema), - dimensions: z.nullable(OCRPageDimensions$inboundSchema), -}); - -/** @internal */ -export type OCRPageObject$Outbound = { - index: number; - markdown: string; - images: Array; - dimensions: OCRPageDimensions$Outbound | null; -}; - -/** @internal */ -export const OCRPageObject$outboundSchema: z.ZodType< - OCRPageObject$Outbound, - z.ZodTypeDef, - OCRPageObject -> = z.object({ - index: z.number().int(), - markdown: z.string(), - images: z.array(OCRImageObject$outboundSchema), - dimensions: z.nullable(OCRPageDimensions$outboundSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRPageObject$ { - /** @deprecated use `OCRPageObject$inboundSchema` instead. */ - export const inboundSchema = OCRPageObject$inboundSchema; - /** @deprecated use `OCRPageObject$outboundSchema` instead. */ - export const outboundSchema = OCRPageObject$outboundSchema; - /** @deprecated use `OCRPageObject$Outbound` instead. */ - export type Outbound = OCRPageObject$Outbound; -} - -export function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string { - return JSON.stringify(OCRPageObject$outboundSchema.parse(ocrPageObject)); -} - -export function ocrPageObjectFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRPageObject$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRPageObject' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrrequest.ts b/examples/sdks/mistral-typescript/src/models/components/ocrrequest.ts deleted file mode 100644 index 77a5998bd..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrrequest.ts +++ /dev/null @@ -1,229 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - FileChunk, - FileChunk$inboundSchema, - FileChunk$Outbound, - FileChunk$outboundSchema, -} from "./filechunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - ResponseFormat, - ResponseFormat$inboundSchema, - ResponseFormat$Outbound, - ResponseFormat$outboundSchema, -} from "./responseformat.js"; - -/** - * Document to run OCR on - */ -export type Document = FileChunk | DocumentURLChunk | ImageURLChunk; - -export type OCRRequest = { - model: string | null; - id?: string | undefined; - /** - * Document to run OCR on - */ - document: FileChunk | DocumentURLChunk | ImageURLChunk; - /** - * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0 - */ - pages?: Array | null | undefined; - /** - * Include image URLs in response - */ - includeImageBase64?: boolean | null | undefined; - /** - * Max images to extract - */ - imageLimit?: number | null | undefined; - /** - * Minimum height and width of image to extract - */ - imageMinSize?: number | null | undefined; - /** - * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - */ - bboxAnnotationFormat?: ResponseFormat | null | undefined; - /** - * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - */ - documentAnnotationFormat?: ResponseFormat | null | undefined; -}; - -/** @internal */ -export const Document$inboundSchema: z.ZodType< - Document, - z.ZodTypeDef, - unknown -> = z.union([ - FileChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ImageURLChunk$inboundSchema, -]); - -/** @internal */ -export type Document$Outbound = - | FileChunk$Outbound - | DocumentURLChunk$Outbound - | ImageURLChunk$Outbound; - -/** @internal */ -export const Document$outboundSchema: z.ZodType< - Document$Outbound, - z.ZodTypeDef, - Document -> = z.union([ - FileChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ImageURLChunk$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Document$ { - /** @deprecated use `Document$inboundSchema` instead. */ - export const inboundSchema = Document$inboundSchema; - /** @deprecated use `Document$outboundSchema` instead. */ - export const outboundSchema = Document$outboundSchema; - /** @deprecated use `Document$Outbound` instead. */ - export type Outbound = Document$Outbound; -} - -export function documentToJSON(document: Document): string { - return JSON.stringify(Document$outboundSchema.parse(document)); -} - -export function documentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Document$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Document' from JSON`, - ); -} - -/** @internal */ -export const OCRRequest$inboundSchema: z.ZodType< - OCRRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - FileChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ImageURLChunk$inboundSchema, - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - include_image_base64: z.nullable(z.boolean()).optional(), - image_limit: z.nullable(z.number().int()).optional(), - image_min_size: z.nullable(z.number().int()).optional(), - bbox_annotation_format: z.nullable(ResponseFormat$inboundSchema).optional(), - document_annotation_format: z.nullable(ResponseFormat$inboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - "include_image_base64": "includeImageBase64", - "image_limit": "imageLimit", - "image_min_size": "imageMinSize", - "bbox_annotation_format": "bboxAnnotationFormat", - "document_annotation_format": "documentAnnotationFormat", - }); -}); - -/** @internal */ -export type OCRRequest$Outbound = { - model: string | null; - id?: string | undefined; - document: - | FileChunk$Outbound - | DocumentURLChunk$Outbound - | ImageURLChunk$Outbound; - pages?: Array | null | undefined; - include_image_base64?: boolean | null | undefined; - image_limit?: number | null | undefined; - image_min_size?: number | null | undefined; - bbox_annotation_format?: ResponseFormat$Outbound | null | undefined; - document_annotation_format?: ResponseFormat$Outbound | null | undefined; -}; - -/** @internal */ -export const OCRRequest$outboundSchema: z.ZodType< - OCRRequest$Outbound, - z.ZodTypeDef, - OCRRequest -> = z.object({ - model: z.nullable(z.string()), - id: z.string().optional(), - document: z.union([ - FileChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ImageURLChunk$outboundSchema, - ]), - pages: z.nullable(z.array(z.number().int())).optional(), - includeImageBase64: z.nullable(z.boolean()).optional(), - imageLimit: z.nullable(z.number().int()).optional(), - imageMinSize: z.nullable(z.number().int()).optional(), - bboxAnnotationFormat: z.nullable(ResponseFormat$outboundSchema).optional(), - documentAnnotationFormat: z.nullable(ResponseFormat$outboundSchema) - .optional(), -}).transform((v) => { - return remap$(v, { - includeImageBase64: "include_image_base64", - imageLimit: "image_limit", - imageMinSize: "image_min_size", - bboxAnnotationFormat: "bbox_annotation_format", - documentAnnotationFormat: "document_annotation_format", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRRequest$ { - /** @deprecated use `OCRRequest$inboundSchema` instead. */ - export const inboundSchema = OCRRequest$inboundSchema; - /** @deprecated use `OCRRequest$outboundSchema` instead. */ - export const outboundSchema = OCRRequest$outboundSchema; - /** @deprecated use `OCRRequest$Outbound` instead. */ - export type Outbound = OCRRequest$Outbound; -} - -export function ocrRequestToJSON(ocrRequest: OCRRequest): string { - return JSON.stringify(OCRRequest$outboundSchema.parse(ocrRequest)); -} - -export function ocrRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrresponse.ts b/examples/sdks/mistral-typescript/src/models/components/ocrresponse.ts deleted file mode 100644 index 29408ab34..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrresponse.ts +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - OCRPageObject, - OCRPageObject$inboundSchema, - OCRPageObject$Outbound, - OCRPageObject$outboundSchema, -} from "./ocrpageobject.js"; -import { - OCRUsageInfo, - OCRUsageInfo$inboundSchema, - OCRUsageInfo$Outbound, - OCRUsageInfo$outboundSchema, -} from "./ocrusageinfo.js"; - -export type OCRResponse = { - /** - * List of OCR info for pages. - */ - pages: Array; - /** - * The model used to generate the OCR. - */ - model: string; - /** - * Formatted response in the request_format if provided in json str - */ - documentAnnotation?: string | null | undefined; - usageInfo: OCRUsageInfo; -}; - -/** @internal */ -export const OCRResponse$inboundSchema: z.ZodType< - OCRResponse, - z.ZodTypeDef, - unknown -> = z.object({ - pages: z.array(OCRPageObject$inboundSchema), - model: z.string(), - document_annotation: z.nullable(z.string()).optional(), - usage_info: OCRUsageInfo$inboundSchema, -}).transform((v) => { - return remap$(v, { - "document_annotation": "documentAnnotation", - "usage_info": "usageInfo", - }); -}); - -/** @internal */ -export type OCRResponse$Outbound = { - pages: Array; - model: string; - document_annotation?: string | null | undefined; - usage_info: OCRUsageInfo$Outbound; -}; - -/** @internal */ -export const OCRResponse$outboundSchema: z.ZodType< - OCRResponse$Outbound, - z.ZodTypeDef, - OCRResponse -> = z.object({ - pages: z.array(OCRPageObject$outboundSchema), - model: z.string(), - documentAnnotation: z.nullable(z.string()).optional(), - usageInfo: OCRUsageInfo$outboundSchema, -}).transform((v) => { - return remap$(v, { - documentAnnotation: "document_annotation", - usageInfo: "usage_info", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRResponse$ { - /** @deprecated use `OCRResponse$inboundSchema` instead. */ - export const inboundSchema = OCRResponse$inboundSchema; - /** @deprecated use `OCRResponse$outboundSchema` instead. */ - export const outboundSchema = OCRResponse$outboundSchema; - /** @deprecated use `OCRResponse$Outbound` instead. */ - export type Outbound = OCRResponse$Outbound; -} - -export function ocrResponseToJSON(ocrResponse: OCRResponse): string { - return JSON.stringify(OCRResponse$outboundSchema.parse(ocrResponse)); -} - -export function ocrResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ocrusageinfo.ts b/examples/sdks/mistral-typescript/src/models/components/ocrusageinfo.ts deleted file mode 100644 index a07680c41..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ocrusageinfo.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type OCRUsageInfo = { - /** - * Number of pages processed - */ - pagesProcessed: number; - /** - * Document size in bytes - */ - docSizeBytes?: number | null | undefined; -}; - -/** @internal */ -export const OCRUsageInfo$inboundSchema: z.ZodType< - OCRUsageInfo, - z.ZodTypeDef, - unknown -> = z.object({ - pages_processed: z.number().int(), - doc_size_bytes: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - "pages_processed": "pagesProcessed", - "doc_size_bytes": "docSizeBytes", - }); -}); - -/** @internal */ -export type OCRUsageInfo$Outbound = { - pages_processed: number; - doc_size_bytes?: number | null | undefined; -}; - -/** @internal */ -export const OCRUsageInfo$outboundSchema: z.ZodType< - OCRUsageInfo$Outbound, - z.ZodTypeDef, - OCRUsageInfo -> = z.object({ - pagesProcessed: z.number().int(), - docSizeBytes: z.nullable(z.number().int()).optional(), -}).transform((v) => { - return remap$(v, { - pagesProcessed: "pages_processed", - docSizeBytes: "doc_size_bytes", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OCRUsageInfo$ { - /** @deprecated use `OCRUsageInfo$inboundSchema` instead. */ - export const inboundSchema = OCRUsageInfo$inboundSchema; - /** @deprecated use `OCRUsageInfo$outboundSchema` instead. */ - export const outboundSchema = OCRUsageInfo$outboundSchema; - /** @deprecated use `OCRUsageInfo$Outbound` instead. */ - export type Outbound = OCRUsageInfo$Outbound; -} - -export function ocrUsageInfoToJSON(ocrUsageInfo: OCRUsageInfo): string { - return JSON.stringify(OCRUsageInfo$outboundSchema.parse(ocrUsageInfo)); -} - -export function ocrUsageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OCRUsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OCRUsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/outputcontentchunks.ts b/examples/sdks/mistral-typescript/src/models/components/outputcontentchunks.ts deleted file mode 100644 index 412144d7d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/outputcontentchunks.ts +++ /dev/null @@ -1,120 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - DocumentURLChunk, - DocumentURLChunk$inboundSchema, - DocumentURLChunk$Outbound, - DocumentURLChunk$outboundSchema, -} from "./documenturlchunk.js"; -import { - ImageURLChunk, - ImageURLChunk$inboundSchema, - ImageURLChunk$Outbound, - ImageURLChunk$outboundSchema, -} from "./imageurlchunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; -import { - ThinkChunk, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, -} from "./thinkchunk.js"; -import { - ToolFileChunk, - ToolFileChunk$inboundSchema, - ToolFileChunk$Outbound, - ToolFileChunk$outboundSchema, -} from "./toolfilechunk.js"; -import { - ToolReferenceChunk, - ToolReferenceChunk$inboundSchema, - ToolReferenceChunk$Outbound, - ToolReferenceChunk$outboundSchema, -} from "./toolreferencechunk.js"; - -export type OutputContentChunks = - | ToolFileChunk - | ToolReferenceChunk - | TextChunk - | ImageURLChunk - | DocumentURLChunk - | ThinkChunk; - -/** @internal */ -export const OutputContentChunks$inboundSchema: z.ZodType< - OutputContentChunks, - z.ZodTypeDef, - unknown -> = z.union([ - ToolFileChunk$inboundSchema, - ToolReferenceChunk$inboundSchema, - TextChunk$inboundSchema, - ImageURLChunk$inboundSchema, - DocumentURLChunk$inboundSchema, - ThinkChunk$inboundSchema, -]); - -/** @internal */ -export type OutputContentChunks$Outbound = - | ToolFileChunk$Outbound - | ToolReferenceChunk$Outbound - | TextChunk$Outbound - | ImageURLChunk$Outbound - | DocumentURLChunk$Outbound - | ThinkChunk$Outbound; - -/** @internal */ -export const OutputContentChunks$outboundSchema: z.ZodType< - OutputContentChunks$Outbound, - z.ZodTypeDef, - OutputContentChunks -> = z.union([ - ToolFileChunk$outboundSchema, - ToolReferenceChunk$outboundSchema, - TextChunk$outboundSchema, - ImageURLChunk$outboundSchema, - DocumentURLChunk$outboundSchema, - ThinkChunk$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace OutputContentChunks$ { - /** @deprecated use `OutputContentChunks$inboundSchema` instead. */ - export const inboundSchema = OutputContentChunks$inboundSchema; - /** @deprecated use `OutputContentChunks$outboundSchema` instead. */ - export const outboundSchema = OutputContentChunks$outboundSchema; - /** @deprecated use `OutputContentChunks$Outbound` instead. */ - export type Outbound = OutputContentChunks$Outbound; -} - -export function outputContentChunksToJSON( - outputContentChunks: OutputContentChunks, -): string { - return JSON.stringify( - OutputContentChunks$outboundSchema.parse(outputContentChunks), - ); -} - -export function outputContentChunksFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => OutputContentChunks$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'OutputContentChunks' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/paginationinfo.ts b/examples/sdks/mistral-typescript/src/models/components/paginationinfo.ts deleted file mode 100644 index a762da6bc..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/paginationinfo.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type PaginationInfo = { - totalItems: number; - totalPages: number; - currentPage: number; - pageSize: number; - hasMore: boolean; -}; - -/** @internal */ -export const PaginationInfo$inboundSchema: z.ZodType< - PaginationInfo, - z.ZodTypeDef, - unknown -> = z.object({ - total_items: z.number().int(), - total_pages: z.number().int(), - current_page: z.number().int(), - page_size: z.number().int(), - has_more: z.boolean(), -}).transform((v) => { - return remap$(v, { - "total_items": "totalItems", - "total_pages": "totalPages", - "current_page": "currentPage", - "page_size": "pageSize", - "has_more": "hasMore", - }); -}); - -/** @internal */ -export type PaginationInfo$Outbound = { - total_items: number; - total_pages: number; - current_page: number; - page_size: number; - has_more: boolean; -}; - -/** @internal */ -export const PaginationInfo$outboundSchema: z.ZodType< - PaginationInfo$Outbound, - z.ZodTypeDef, - PaginationInfo -> = z.object({ - totalItems: z.number().int(), - totalPages: z.number().int(), - currentPage: z.number().int(), - pageSize: z.number().int(), - hasMore: z.boolean(), -}).transform((v) => { - return remap$(v, { - totalItems: "total_items", - totalPages: "total_pages", - currentPage: "current_page", - pageSize: "page_size", - hasMore: "has_more", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace PaginationInfo$ { - /** @deprecated use `PaginationInfo$inboundSchema` instead. */ - export const inboundSchema = PaginationInfo$inboundSchema; - /** @deprecated use `PaginationInfo$outboundSchema` instead. */ - export const outboundSchema = PaginationInfo$outboundSchema; - /** @deprecated use `PaginationInfo$Outbound` instead. */ - export type Outbound = PaginationInfo$Outbound; -} - -export function paginationInfoToJSON(paginationInfo: PaginationInfo): string { - return JSON.stringify(PaginationInfo$outboundSchema.parse(paginationInfo)); -} - -export function paginationInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => PaginationInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'PaginationInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/prediction.ts b/examples/sdks/mistral-typescript/src/models/components/prediction.ts deleted file mode 100644 index d195ee8a5..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/prediction.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Prediction = { - type?: "content" | undefined; - content?: string | undefined; -}; - -/** @internal */ -export const Prediction$inboundSchema: z.ZodType< - Prediction, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("content").default("content"), - content: z.string().default(""), -}); - -/** @internal */ -export type Prediction$Outbound = { - type: "content"; - content: string; -}; - -/** @internal */ -export const Prediction$outboundSchema: z.ZodType< - Prediction$Outbound, - z.ZodTypeDef, - Prediction -> = z.object({ - type: z.literal("content").default("content" as const), - content: z.string().default(""), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Prediction$ { - /** @deprecated use `Prediction$inboundSchema` instead. */ - export const inboundSchema = Prediction$inboundSchema; - /** @deprecated use `Prediction$outboundSchema` instead. */ - export const outboundSchema = Prediction$outboundSchema; - /** @deprecated use `Prediction$Outbound` instead. */ - export type Outbound = Prediction$Outbound; -} - -export function predictionToJSON(prediction: Prediction): string { - return JSON.stringify(Prediction$outboundSchema.parse(prediction)); -} - -export function predictionFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Prediction$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Prediction' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/processingstatusout.ts b/examples/sdks/mistral-typescript/src/models/components/processingstatusout.ts deleted file mode 100644 index 32dec6c1c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/processingstatusout.ts +++ /dev/null @@ -1,81 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type ProcessingStatusOut = { - documentId: string; - processingStatus: string; -}; - -/** @internal */ -export const ProcessingStatusOut$inboundSchema: z.ZodType< - ProcessingStatusOut, - z.ZodTypeDef, - unknown -> = z.object({ - document_id: z.string(), - processing_status: z.string(), -}).transform((v) => { - return remap$(v, { - "document_id": "documentId", - "processing_status": "processingStatus", - }); -}); - -/** @internal */ -export type ProcessingStatusOut$Outbound = { - document_id: string; - processing_status: string; -}; - -/** @internal */ -export const ProcessingStatusOut$outboundSchema: z.ZodType< - ProcessingStatusOut$Outbound, - z.ZodTypeDef, - ProcessingStatusOut -> = z.object({ - documentId: z.string(), - processingStatus: z.string(), -}).transform((v) => { - return remap$(v, { - documentId: "document_id", - processingStatus: "processing_status", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ProcessingStatusOut$ { - /** @deprecated use `ProcessingStatusOut$inboundSchema` instead. */ - export const inboundSchema = ProcessingStatusOut$inboundSchema; - /** @deprecated use `ProcessingStatusOut$outboundSchema` instead. */ - export const outboundSchema = ProcessingStatusOut$outboundSchema; - /** @deprecated use `ProcessingStatusOut$Outbound` instead. */ - export type Outbound = ProcessingStatusOut$Outbound; -} - -export function processingStatusOutToJSON( - processingStatusOut: ProcessingStatusOut, -): string { - return JSON.stringify( - ProcessingStatusOut$outboundSchema.parse(processingStatusOut), - ); -} - -export function processingStatusOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ProcessingStatusOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ProcessingStatusOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/referencechunk.ts b/examples/sdks/mistral-typescript/src/models/components/referencechunk.ts deleted file mode 100644 index 9085d7b9f..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/referencechunk.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ReferenceChunkType = { - Reference: "reference", -} as const; -export type ReferenceChunkType = ClosedEnum; - -export type ReferenceChunk = { - referenceIds: Array; - type?: ReferenceChunkType | undefined; -}; - -/** @internal */ -export const ReferenceChunkType$inboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = z.nativeEnum(ReferenceChunkType); - -/** @internal */ -export const ReferenceChunkType$outboundSchema: z.ZodNativeEnum< - typeof ReferenceChunkType -> = ReferenceChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunkType$ { - /** @deprecated use `ReferenceChunkType$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunkType$inboundSchema; - /** @deprecated use `ReferenceChunkType$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunkType$outboundSchema; -} - -/** @internal */ -export const ReferenceChunk$inboundSchema: z.ZodType< - ReferenceChunk, - z.ZodTypeDef, - unknown -> = z.object({ - reference_ids: z.array(z.number().int()), - type: ReferenceChunkType$inboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - "reference_ids": "referenceIds", - }); -}); - -/** @internal */ -export type ReferenceChunk$Outbound = { - reference_ids: Array; - type: string; -}; - -/** @internal */ -export const ReferenceChunk$outboundSchema: z.ZodType< - ReferenceChunk$Outbound, - z.ZodTypeDef, - ReferenceChunk -> = z.object({ - referenceIds: z.array(z.number().int()), - type: ReferenceChunkType$outboundSchema.default("reference"), -}).transform((v) => { - return remap$(v, { - referenceIds: "reference_ids", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ReferenceChunk$ { - /** @deprecated use `ReferenceChunk$inboundSchema` instead. */ - export const inboundSchema = ReferenceChunk$inboundSchema; - /** @deprecated use `ReferenceChunk$outboundSchema` instead. */ - export const outboundSchema = ReferenceChunk$outboundSchema; - /** @deprecated use `ReferenceChunk$Outbound` instead. */ - export type Outbound = ReferenceChunk$Outbound; -} - -export function referenceChunkToJSON(referenceChunk: ReferenceChunk): string { - return JSON.stringify(ReferenceChunk$outboundSchema.parse(referenceChunk)); -} - -export function referenceChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ReferenceChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ReferenceChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/responsedoneevent.ts b/examples/sdks/mistral-typescript/src/models/components/responsedoneevent.ts deleted file mode 100644 index 02b1d12fb..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/responsedoneevent.ts +++ /dev/null @@ -1,121 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ConversationUsageInfo, - ConversationUsageInfo$inboundSchema, - ConversationUsageInfo$Outbound, - ConversationUsageInfo$outboundSchema, -} from "./conversationusageinfo.js"; - -export const ResponseDoneEventType = { - ConversationResponseDone: "conversation.response.done", -} as const; -export type ResponseDoneEventType = ClosedEnum; - -export type ResponseDoneEvent = { - type?: ResponseDoneEventType | undefined; - createdAt?: Date | undefined; - usage: ConversationUsageInfo; -}; - -/** @internal */ -export const ResponseDoneEventType$inboundSchema: z.ZodNativeEnum< - typeof ResponseDoneEventType -> = z.nativeEnum(ResponseDoneEventType); - -/** @internal */ -export const ResponseDoneEventType$outboundSchema: z.ZodNativeEnum< - typeof ResponseDoneEventType -> = ResponseDoneEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseDoneEventType$ { - /** @deprecated use `ResponseDoneEventType$inboundSchema` instead. */ - export const inboundSchema = ResponseDoneEventType$inboundSchema; - /** @deprecated use `ResponseDoneEventType$outboundSchema` instead. */ - export const outboundSchema = ResponseDoneEventType$outboundSchema; -} - -/** @internal */ -export const ResponseDoneEvent$inboundSchema: z.ZodType< - ResponseDoneEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseDoneEventType$inboundSchema.default( - "conversation.response.done", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - usage: ConversationUsageInfo$inboundSchema, -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - }); -}); - -/** @internal */ -export type ResponseDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - usage: ConversationUsageInfo$Outbound; -}; - -/** @internal */ -export const ResponseDoneEvent$outboundSchema: z.ZodType< - ResponseDoneEvent$Outbound, - z.ZodTypeDef, - ResponseDoneEvent -> = z.object({ - type: ResponseDoneEventType$outboundSchema.default( - "conversation.response.done", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - usage: ConversationUsageInfo$outboundSchema, -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseDoneEvent$ { - /** @deprecated use `ResponseDoneEvent$inboundSchema` instead. */ - export const inboundSchema = ResponseDoneEvent$inboundSchema; - /** @deprecated use `ResponseDoneEvent$outboundSchema` instead. */ - export const outboundSchema = ResponseDoneEvent$outboundSchema; - /** @deprecated use `ResponseDoneEvent$Outbound` instead. */ - export type Outbound = ResponseDoneEvent$Outbound; -} - -export function responseDoneEventToJSON( - responseDoneEvent: ResponseDoneEvent, -): string { - return JSON.stringify( - ResponseDoneEvent$outboundSchema.parse(responseDoneEvent), - ); -} - -export function responseDoneEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseDoneEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseDoneEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/responseerrorevent.ts b/examples/sdks/mistral-typescript/src/models/components/responseerrorevent.ts deleted file mode 100644 index bcf255614..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/responseerrorevent.ts +++ /dev/null @@ -1,119 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ResponseErrorEventType = { - ConversationResponseError: "conversation.response.error", -} as const; -export type ResponseErrorEventType = ClosedEnum; - -export type ResponseErrorEvent = { - type?: ResponseErrorEventType | undefined; - createdAt?: Date | undefined; - message: string; - code: number; -}; - -/** @internal */ -export const ResponseErrorEventType$inboundSchema: z.ZodNativeEnum< - typeof ResponseErrorEventType -> = z.nativeEnum(ResponseErrorEventType); - -/** @internal */ -export const ResponseErrorEventType$outboundSchema: z.ZodNativeEnum< - typeof ResponseErrorEventType -> = ResponseErrorEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseErrorEventType$ { - /** @deprecated use `ResponseErrorEventType$inboundSchema` instead. */ - export const inboundSchema = ResponseErrorEventType$inboundSchema; - /** @deprecated use `ResponseErrorEventType$outboundSchema` instead. */ - export const outboundSchema = ResponseErrorEventType$outboundSchema; -} - -/** @internal */ -export const ResponseErrorEvent$inboundSchema: z.ZodType< - ResponseErrorEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseErrorEventType$inboundSchema.default( - "conversation.response.error", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - message: z.string(), - code: z.number().int(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - }); -}); - -/** @internal */ -export type ResponseErrorEvent$Outbound = { - type: string; - created_at?: string | undefined; - message: string; - code: number; -}; - -/** @internal */ -export const ResponseErrorEvent$outboundSchema: z.ZodType< - ResponseErrorEvent$Outbound, - z.ZodTypeDef, - ResponseErrorEvent -> = z.object({ - type: ResponseErrorEventType$outboundSchema.default( - "conversation.response.error", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - message: z.string(), - code: z.number().int(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseErrorEvent$ { - /** @deprecated use `ResponseErrorEvent$inboundSchema` instead. */ - export const inboundSchema = ResponseErrorEvent$inboundSchema; - /** @deprecated use `ResponseErrorEvent$outboundSchema` instead. */ - export const outboundSchema = ResponseErrorEvent$outboundSchema; - /** @deprecated use `ResponseErrorEvent$Outbound` instead. */ - export type Outbound = ResponseErrorEvent$Outbound; -} - -export function responseErrorEventToJSON( - responseErrorEvent: ResponseErrorEvent, -): string { - return JSON.stringify( - ResponseErrorEvent$outboundSchema.parse(responseErrorEvent), - ); -} - -export function responseErrorEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseErrorEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseErrorEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/responseformat.ts b/examples/sdks/mistral-typescript/src/models/components/responseformat.ts deleted file mode 100644 index 7b6a4bf09..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/responseformat.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - JsonSchema, - JsonSchema$inboundSchema, - JsonSchema$Outbound, - JsonSchema$outboundSchema, -} from "./jsonschema.js"; -import { - ResponseFormats, - ResponseFormats$inboundSchema, - ResponseFormats$outboundSchema, -} from "./responseformats.js"; - -export type ResponseFormat = { - /** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ - type?: ResponseFormats | undefined; - jsonSchema?: JsonSchema | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$inboundSchema: z.ZodType< - ResponseFormat, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseFormats$inboundSchema.optional(), - json_schema: z.nullable(JsonSchema$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "json_schema": "jsonSchema", - }); -}); - -/** @internal */ -export type ResponseFormat$Outbound = { - type?: string | undefined; - json_schema?: JsonSchema$Outbound | null | undefined; -}; - -/** @internal */ -export const ResponseFormat$outboundSchema: z.ZodType< - ResponseFormat$Outbound, - z.ZodTypeDef, - ResponseFormat -> = z.object({ - type: ResponseFormats$outboundSchema.optional(), - jsonSchema: z.nullable(JsonSchema$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - jsonSchema: "json_schema", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormat$ { - /** @deprecated use `ResponseFormat$inboundSchema` instead. */ - export const inboundSchema = ResponseFormat$inboundSchema; - /** @deprecated use `ResponseFormat$outboundSchema` instead. */ - export const outboundSchema = ResponseFormat$outboundSchema; - /** @deprecated use `ResponseFormat$Outbound` instead. */ - export type Outbound = ResponseFormat$Outbound; -} - -export function responseFormatToJSON(responseFormat: ResponseFormat): string { - return JSON.stringify(ResponseFormat$outboundSchema.parse(responseFormat)); -} - -export function responseFormatFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseFormat$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseFormat' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/responseformats.ts b/examples/sdks/mistral-typescript/src/models/components/responseformats.ts deleted file mode 100644 index d14f152e0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/responseformats.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export const ResponseFormats = { - Text: "text", - JsonObject: "json_object", - JsonSchema: "json_schema", -} as const; -/** - * An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. - */ -export type ResponseFormats = ClosedEnum; - -/** @internal */ -export const ResponseFormats$inboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = z.nativeEnum(ResponseFormats); - -/** @internal */ -export const ResponseFormats$outboundSchema: z.ZodNativeEnum< - typeof ResponseFormats -> = ResponseFormats$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseFormats$ { - /** @deprecated use `ResponseFormats$inboundSchema` instead. */ - export const inboundSchema = ResponseFormats$inboundSchema; - /** @deprecated use `ResponseFormats$outboundSchema` instead. */ - export const outboundSchema = ResponseFormats$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/responsestartedevent.ts b/examples/sdks/mistral-typescript/src/models/components/responsestartedevent.ts deleted file mode 100644 index d5a6089ef..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/responsestartedevent.ts +++ /dev/null @@ -1,119 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const ResponseStartedEventType = { - ConversationResponseStarted: "conversation.response.started", -} as const; -export type ResponseStartedEventType = ClosedEnum< - typeof ResponseStartedEventType ->; - -export type ResponseStartedEvent = { - type?: ResponseStartedEventType | undefined; - createdAt?: Date | undefined; - conversationId: string; -}; - -/** @internal */ -export const ResponseStartedEventType$inboundSchema: z.ZodNativeEnum< - typeof ResponseStartedEventType -> = z.nativeEnum(ResponseStartedEventType); - -/** @internal */ -export const ResponseStartedEventType$outboundSchema: z.ZodNativeEnum< - typeof ResponseStartedEventType -> = ResponseStartedEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseStartedEventType$ { - /** @deprecated use `ResponseStartedEventType$inboundSchema` instead. */ - export const inboundSchema = ResponseStartedEventType$inboundSchema; - /** @deprecated use `ResponseStartedEventType$outboundSchema` instead. */ - export const outboundSchema = ResponseStartedEventType$outboundSchema; -} - -/** @internal */ -export const ResponseStartedEvent$inboundSchema: z.ZodType< - ResponseStartedEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ResponseStartedEventType$inboundSchema.default( - "conversation.response.started", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - conversation_id: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type ResponseStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - conversation_id: string; -}; - -/** @internal */ -export const ResponseStartedEvent$outboundSchema: z.ZodType< - ResponseStartedEvent$Outbound, - z.ZodTypeDef, - ResponseStartedEvent -> = z.object({ - type: ResponseStartedEventType$outboundSchema.default( - "conversation.response.started", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - conversationId: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseStartedEvent$ { - /** @deprecated use `ResponseStartedEvent$inboundSchema` instead. */ - export const inboundSchema = ResponseStartedEvent$inboundSchema; - /** @deprecated use `ResponseStartedEvent$outboundSchema` instead. */ - export const outboundSchema = ResponseStartedEvent$outboundSchema; - /** @deprecated use `ResponseStartedEvent$Outbound` instead. */ - export type Outbound = ResponseStartedEvent$Outbound; -} - -export function responseStartedEventToJSON( - responseStartedEvent: ResponseStartedEvent, -): string { - return JSON.stringify( - ResponseStartedEvent$outboundSchema.parse(responseStartedEvent), - ); -} - -export function responseStartedEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseStartedEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseStartedEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/retrievefileout.ts b/examples/sdks/mistral-typescript/src/models/components/retrievefileout.ts deleted file mode 100644 index fa1bc800b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/retrievefileout.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, -} from "./filepurpose.js"; -import { - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, -} from "./sampletype.js"; -import { - Source, - Source$inboundSchema, - Source$outboundSchema, -} from "./source.js"; - -export type RetrieveFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; - deleted: boolean; -}; - -/** @internal */ -export const RetrieveFileOut$inboundSchema: z.ZodType< - RetrieveFileOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: FilePurpose$inboundSchema, - sample_type: SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$inboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean(), -}).transform((v) => { - return remap$(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines", - }); -}); - -/** @internal */ -export type RetrieveFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; - deleted: boolean; -}; - -/** @internal */ -export const RetrieveFileOut$outboundSchema: z.ZodType< - RetrieveFileOut$Outbound, - z.ZodTypeDef, - RetrieveFileOut -> = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: FilePurpose$outboundSchema, - sampleType: SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$outboundSchema, - signature: z.nullable(z.string()).optional(), - deleted: z.boolean(), -}).transform((v) => { - return remap$(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace RetrieveFileOut$ { - /** @deprecated use `RetrieveFileOut$inboundSchema` instead. */ - export const inboundSchema = RetrieveFileOut$inboundSchema; - /** @deprecated use `RetrieveFileOut$outboundSchema` instead. */ - export const outboundSchema = RetrieveFileOut$outboundSchema; - /** @deprecated use `RetrieveFileOut$Outbound` instead. */ - export type Outbound = RetrieveFileOut$Outbound; -} - -export function retrieveFileOutToJSON( - retrieveFileOut: RetrieveFileOut, -): string { - return JSON.stringify(RetrieveFileOut$outboundSchema.parse(retrieveFileOut)); -} - -export function retrieveFileOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => RetrieveFileOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'RetrieveFileOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/sampletype.ts b/examples/sdks/mistral-typescript/src/models/components/sampletype.ts deleted file mode 100644 index c9a6bf5c8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/sampletype.ts +++ /dev/null @@ -1,51 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const SampleType = { - Pretrain: "pretrain", - Instruct: "instruct", - BatchRequest: "batch_request", - BatchResult: "batch_result", - BatchError: "batch_error", -} as const; -export type SampleType = OpenEnum; - -/** @internal */ -export const SampleType$inboundSchema: z.ZodType< - SampleType, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(SampleType), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const SampleType$outboundSchema: z.ZodType< - SampleType, - z.ZodTypeDef, - SampleType -> = z.union([ - z.nativeEnum(SampleType), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SampleType$ { - /** @deprecated use `SampleType$inboundSchema` instead. */ - export const inboundSchema = SampleType$inboundSchema; - /** @deprecated use `SampleType$outboundSchema` instead. */ - export const outboundSchema = SampleType$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/security.ts b/examples/sdks/mistral-typescript/src/models/components/security.ts deleted file mode 100644 index 494b49ac4..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/security.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Security = { - apiKey?: string | undefined; -}; - -/** @internal */ -export const Security$inboundSchema: z.ZodType< - Security, - z.ZodTypeDef, - unknown -> = z.object({ - ApiKey: z.string().optional(), -}).transform((v) => { - return remap$(v, { - "ApiKey": "apiKey", - }); -}); - -/** @internal */ -export type Security$Outbound = { - ApiKey?: string | undefined; -}; - -/** @internal */ -export const Security$outboundSchema: z.ZodType< - Security$Outbound, - z.ZodTypeDef, - Security -> = z.object({ - apiKey: z.string().optional(), -}).transform((v) => { - return remap$(v, { - apiKey: "ApiKey", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Security$ { - /** @deprecated use `Security$inboundSchema` instead. */ - export const inboundSchema = Security$inboundSchema; - /** @deprecated use `Security$outboundSchema` instead. */ - export const outboundSchema = Security$outboundSchema; - /** @deprecated use `Security$Outbound` instead. */ - export type Outbound = Security$Outbound; -} - -export function securityToJSON(security: Security): string { - return JSON.stringify(Security$outboundSchema.parse(security)); -} - -export function securityFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Security$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Security' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/shareenum.ts b/examples/sdks/mistral-typescript/src/models/components/shareenum.ts deleted file mode 100644 index 1538543f0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/shareenum.ts +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const ShareEnum = { - Viewer: "Viewer", - Editor: "Editor", -} as const; -export type ShareEnum = OpenEnum; - -/** @internal */ -export const ShareEnum$inboundSchema: z.ZodType< - ShareEnum, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ShareEnum), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ShareEnum$outboundSchema: z.ZodType< - ShareEnum, - z.ZodTypeDef, - ShareEnum -> = z.union([ - z.nativeEnum(ShareEnum), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ShareEnum$ { - /** @deprecated use `ShareEnum$inboundSchema` instead. */ - export const inboundSchema = ShareEnum$inboundSchema; - /** @deprecated use `ShareEnum$outboundSchema` instead. */ - export const outboundSchema = ShareEnum$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/sharingdelete.ts b/examples/sdks/mistral-typescript/src/models/components/sharingdelete.ts deleted file mode 100644 index 389879ec7..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/sharingdelete.ts +++ /dev/null @@ -1,94 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, -} from "./entitytype.js"; - -export type SharingDelete = { - orgId: string; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -/** @internal */ -export const SharingDelete$inboundSchema: z.ZodType< - SharingDelete, - z.ZodTypeDef, - unknown -> = z.object({ - org_id: z.string(), - share_with_uuid: z.string(), - share_with_type: EntityType$inboundSchema, -}).transform((v) => { - return remap$(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType", - }); -}); - -/** @internal */ -export type SharingDelete$Outbound = { - org_id: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -export const SharingDelete$outboundSchema: z.ZodType< - SharingDelete$Outbound, - z.ZodTypeDef, - SharingDelete -> = z.object({ - orgId: z.string(), - shareWithUuid: z.string(), - shareWithType: EntityType$outboundSchema, -}).transform((v) => { - return remap$(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SharingDelete$ { - /** @deprecated use `SharingDelete$inboundSchema` instead. */ - export const inboundSchema = SharingDelete$inboundSchema; - /** @deprecated use `SharingDelete$outboundSchema` instead. */ - export const outboundSchema = SharingDelete$outboundSchema; - /** @deprecated use `SharingDelete$Outbound` instead. */ - export type Outbound = SharingDelete$Outbound; -} - -export function sharingDeleteToJSON(sharingDelete: SharingDelete): string { - return JSON.stringify(SharingDelete$outboundSchema.parse(sharingDelete)); -} - -export function sharingDeleteFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SharingDelete$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SharingDelete' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/sharingin.ts b/examples/sdks/mistral-typescript/src/models/components/sharingin.ts deleted file mode 100644 index d4fe66e70..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/sharingin.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - EntityType, - EntityType$inboundSchema, - EntityType$outboundSchema, -} from "./entitytype.js"; -import { - ShareEnum, - ShareEnum$inboundSchema, - ShareEnum$outboundSchema, -} from "./shareenum.js"; - -export type SharingIn = { - orgId: string; - level: ShareEnum; - /** - * The id of the entity (user, workspace or organization) to share with - */ - shareWithUuid: string; - /** - * The type of entity, used to share a library. - */ - shareWithType: EntityType; -}; - -/** @internal */ -export const SharingIn$inboundSchema: z.ZodType< - SharingIn, - z.ZodTypeDef, - unknown -> = z.object({ - org_id: z.string(), - level: ShareEnum$inboundSchema, - share_with_uuid: z.string(), - share_with_type: EntityType$inboundSchema, -}).transform((v) => { - return remap$(v, { - "org_id": "orgId", - "share_with_uuid": "shareWithUuid", - "share_with_type": "shareWithType", - }); -}); - -/** @internal */ -export type SharingIn$Outbound = { - org_id: string; - level: string; - share_with_uuid: string; - share_with_type: string; -}; - -/** @internal */ -export const SharingIn$outboundSchema: z.ZodType< - SharingIn$Outbound, - z.ZodTypeDef, - SharingIn -> = z.object({ - orgId: z.string(), - level: ShareEnum$outboundSchema, - shareWithUuid: z.string(), - shareWithType: EntityType$outboundSchema, -}).transform((v) => { - return remap$(v, { - orgId: "org_id", - shareWithUuid: "share_with_uuid", - shareWithType: "share_with_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SharingIn$ { - /** @deprecated use `SharingIn$inboundSchema` instead. */ - export const inboundSchema = SharingIn$inboundSchema; - /** @deprecated use `SharingIn$outboundSchema` instead. */ - export const outboundSchema = SharingIn$outboundSchema; - /** @deprecated use `SharingIn$Outbound` instead. */ - export type Outbound = SharingIn$Outbound; -} - -export function sharingInToJSON(sharingIn: SharingIn): string { - return JSON.stringify(SharingIn$outboundSchema.parse(sharingIn)); -} - -export function sharingInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SharingIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SharingIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/sharingout.ts b/examples/sdks/mistral-typescript/src/models/components/sharingout.ts deleted file mode 100644 index 5e4b373c6..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/sharingout.ts +++ /dev/null @@ -1,99 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type SharingOut = { - libraryId: string; - userId?: string | null | undefined; - orgId: string; - role: string; - shareWithType: string; - shareWithUuid: string; -}; - -/** @internal */ -export const SharingOut$inboundSchema: z.ZodType< - SharingOut, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - user_id: z.nullable(z.string()).optional(), - org_id: z.string(), - role: z.string(), - share_with_type: z.string(), - share_with_uuid: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "user_id": "userId", - "org_id": "orgId", - "share_with_type": "shareWithType", - "share_with_uuid": "shareWithUuid", - }); -}); - -/** @internal */ -export type SharingOut$Outbound = { - library_id: string; - user_id?: string | null | undefined; - org_id: string; - role: string; - share_with_type: string; - share_with_uuid: string; -}; - -/** @internal */ -export const SharingOut$outboundSchema: z.ZodType< - SharingOut$Outbound, - z.ZodTypeDef, - SharingOut -> = z.object({ - libraryId: z.string(), - userId: z.nullable(z.string()).optional(), - orgId: z.string(), - role: z.string(), - shareWithType: z.string(), - shareWithUuid: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - userId: "user_id", - orgId: "org_id", - shareWithType: "share_with_type", - shareWithUuid: "share_with_uuid", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SharingOut$ { - /** @deprecated use `SharingOut$inboundSchema` instead. */ - export const inboundSchema = SharingOut$inboundSchema; - /** @deprecated use `SharingOut$outboundSchema` instead. */ - export const outboundSchema = SharingOut$outboundSchema; - /** @deprecated use `SharingOut$Outbound` instead. */ - export type Outbound = SharingOut$Outbound; -} - -export function sharingOutToJSON(sharingOut: SharingOut): string { - return JSON.stringify(SharingOut$outboundSchema.parse(sharingOut)); -} - -export function sharingOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SharingOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SharingOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/source.ts b/examples/sdks/mistral-typescript/src/models/components/source.ts deleted file mode 100644 index fc671152c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/source.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const Source = { - Upload: "upload", - Repository: "repository", - Mistral: "mistral", -} as const; -export type Source = OpenEnum; - -/** @internal */ -export const Source$inboundSchema: z.ZodType = z - .union([ - z.nativeEnum(Source), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const Source$outboundSchema: z.ZodType = z - .union([ - z.nativeEnum(Source), - z.string().and(z.custom>()), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Source$ { - /** @deprecated use `Source$inboundSchema` instead. */ - export const inboundSchema = Source$inboundSchema; - /** @deprecated use `Source$outboundSchema` instead. */ - export const outboundSchema = Source$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/ssetypes.ts b/examples/sdks/mistral-typescript/src/models/components/ssetypes.ts deleted file mode 100644 index 304e06168..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/ssetypes.ts +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -/** - * Server side events sent when streaming a conversation response. - */ -export const SSETypes = { - ConversationResponseStarted: "conversation.response.started", - ConversationResponseDone: "conversation.response.done", - ConversationResponseError: "conversation.response.error", - MessageOutputDelta: "message.output.delta", - ToolExecutionStarted: "tool.execution.started", - ToolExecutionDelta: "tool.execution.delta", - ToolExecutionDone: "tool.execution.done", - AgentHandoffStarted: "agent.handoff.started", - AgentHandoffDone: "agent.handoff.done", - FunctionCallDelta: "function.call.delta", -} as const; -/** - * Server side events sent when streaming a conversation response. - */ -export type SSETypes = ClosedEnum; - -/** @internal */ -export const SSETypes$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(SSETypes); - -/** @internal */ -export const SSETypes$outboundSchema: z.ZodNativeEnum = - SSETypes$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SSETypes$ { - /** @deprecated use `SSETypes$inboundSchema` instead. */ - export const inboundSchema = SSETypes$inboundSchema; - /** @deprecated use `SSETypes$outboundSchema` instead. */ - export const outboundSchema = SSETypes$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/systemmessage.ts b/examples/sdks/mistral-typescript/src/models/components/systemmessage.ts deleted file mode 100644 index 838daf4a8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/systemmessage.ts +++ /dev/null @@ -1,156 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - SystemMessageContentChunks, - SystemMessageContentChunks$inboundSchema, - SystemMessageContentChunks$Outbound, - SystemMessageContentChunks$outboundSchema, -} from "./systemmessagecontentchunks.js"; - -export type SystemMessageContent = string | Array; - -export const Role = { - System: "system", -} as const; -export type Role = ClosedEnum; - -export type SystemMessage = { - content: string | Array; - role?: Role | undefined; -}; - -/** @internal */ -export const SystemMessageContent$inboundSchema: z.ZodType< - SystemMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(SystemMessageContentChunks$inboundSchema)]); - -/** @internal */ -export type SystemMessageContent$Outbound = - | string - | Array; - -/** @internal */ -export const SystemMessageContent$outboundSchema: z.ZodType< - SystemMessageContent$Outbound, - z.ZodTypeDef, - SystemMessageContent -> = z.union([z.string(), z.array(SystemMessageContentChunks$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessageContent$ { - /** @deprecated use `SystemMessageContent$inboundSchema` instead. */ - export const inboundSchema = SystemMessageContent$inboundSchema; - /** @deprecated use `SystemMessageContent$outboundSchema` instead. */ - export const outboundSchema = SystemMessageContent$outboundSchema; - /** @deprecated use `SystemMessageContent$Outbound` instead. */ - export type Outbound = SystemMessageContent$Outbound; -} - -export function systemMessageContentToJSON( - systemMessageContent: SystemMessageContent, -): string { - return JSON.stringify( - SystemMessageContent$outboundSchema.parse(systemMessageContent), - ); -} - -export function systemMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessageContent' from JSON`, - ); -} - -/** @internal */ -export const Role$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Role, -); - -/** @internal */ -export const Role$outboundSchema: z.ZodNativeEnum = - Role$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Role$ { - /** @deprecated use `Role$inboundSchema` instead. */ - export const inboundSchema = Role$inboundSchema; - /** @deprecated use `Role$outboundSchema` instead. */ - export const outboundSchema = Role$outboundSchema; -} - -/** @internal */ -export const SystemMessage$inboundSchema: z.ZodType< - SystemMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.union([ - z.string(), - z.array(SystemMessageContentChunks$inboundSchema), - ]), - role: Role$inboundSchema.default("system"), -}); - -/** @internal */ -export type SystemMessage$Outbound = { - content: string | Array; - role: string; -}; - -/** @internal */ -export const SystemMessage$outboundSchema: z.ZodType< - SystemMessage$Outbound, - z.ZodTypeDef, - SystemMessage -> = z.object({ - content: z.union([ - z.string(), - z.array(SystemMessageContentChunks$outboundSchema), - ]), - role: Role$outboundSchema.default("system"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessage$ { - /** @deprecated use `SystemMessage$inboundSchema` instead. */ - export const inboundSchema = SystemMessage$inboundSchema; - /** @deprecated use `SystemMessage$outboundSchema` instead. */ - export const outboundSchema = SystemMessage$outboundSchema; - /** @deprecated use `SystemMessage$Outbound` instead. */ - export type Outbound = SystemMessage$Outbound; -} - -export function systemMessageToJSON(systemMessage: SystemMessage): string { - return JSON.stringify(SystemMessage$outboundSchema.parse(systemMessage)); -} - -export function systemMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/systemmessagecontentchunks.ts b/examples/sdks/mistral-typescript/src/models/components/systemmessagecontentchunks.ts deleted file mode 100644 index c02ec0bc4..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/systemmessagecontentchunks.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; -import { - ThinkChunk, - ThinkChunk$inboundSchema, - ThinkChunk$Outbound, - ThinkChunk$outboundSchema, -} from "./thinkchunk.js"; - -export type SystemMessageContentChunks = - | (TextChunk & { type: "text" }) - | (ThinkChunk & { type: "thinking" }); - -/** @internal */ -export const SystemMessageContentChunks$inboundSchema: z.ZodType< - SystemMessageContentChunks, - z.ZodTypeDef, - unknown -> = z.union([ - TextChunk$inboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ThinkChunk$inboundSchema.and( - z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** @internal */ -export type SystemMessageContentChunks$Outbound = - | (TextChunk$Outbound & { type: "text" }) - | (ThinkChunk$Outbound & { type: "thinking" }); - -/** @internal */ -export const SystemMessageContentChunks$outboundSchema: z.ZodType< - SystemMessageContentChunks$Outbound, - z.ZodTypeDef, - SystemMessageContentChunks -> = z.union([ - TextChunk$outboundSchema.and( - z.object({ type: z.literal("text") }).transform((v) => ({ type: v.type })), - ), - ThinkChunk$outboundSchema.and( - z.object({ type: z.literal("thinking") }).transform((v) => ({ - type: v.type, - })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SystemMessageContentChunks$ { - /** @deprecated use `SystemMessageContentChunks$inboundSchema` instead. */ - export const inboundSchema = SystemMessageContentChunks$inboundSchema; - /** @deprecated use `SystemMessageContentChunks$outboundSchema` instead. */ - export const outboundSchema = SystemMessageContentChunks$outboundSchema; - /** @deprecated use `SystemMessageContentChunks$Outbound` instead. */ - export type Outbound = SystemMessageContentChunks$Outbound; -} - -export function systemMessageContentChunksToJSON( - systemMessageContentChunks: SystemMessageContentChunks, -): string { - return JSON.stringify( - SystemMessageContentChunks$outboundSchema.parse(systemMessageContentChunks), - ); -} - -export function systemMessageContentChunksFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => SystemMessageContentChunks$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'SystemMessageContentChunks' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/textchunk.ts b/examples/sdks/mistral-typescript/src/models/components/textchunk.ts deleted file mode 100644 index 2455e1cb9..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/textchunk.ts +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const TextChunkType = { - Text: "text", -} as const; -export type TextChunkType = ClosedEnum; - -export type TextChunk = { - text: string; - type?: TextChunkType | undefined; -}; - -/** @internal */ -export const TextChunkType$inboundSchema: z.ZodNativeEnum< - typeof TextChunkType -> = z.nativeEnum(TextChunkType); - -/** @internal */ -export const TextChunkType$outboundSchema: z.ZodNativeEnum< - typeof TextChunkType -> = TextChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TextChunkType$ { - /** @deprecated use `TextChunkType$inboundSchema` instead. */ - export const inboundSchema = TextChunkType$inboundSchema; - /** @deprecated use `TextChunkType$outboundSchema` instead. */ - export const outboundSchema = TextChunkType$outboundSchema; -} - -/** @internal */ -export const TextChunk$inboundSchema: z.ZodType< - TextChunk, - z.ZodTypeDef, - unknown -> = z.object({ - text: z.string(), - type: TextChunkType$inboundSchema.default("text"), -}); - -/** @internal */ -export type TextChunk$Outbound = { - text: string; - type: string; -}; - -/** @internal */ -export const TextChunk$outboundSchema: z.ZodType< - TextChunk$Outbound, - z.ZodTypeDef, - TextChunk -> = z.object({ - text: z.string(), - type: TextChunkType$outboundSchema.default("text"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TextChunk$ { - /** @deprecated use `TextChunk$inboundSchema` instead. */ - export const inboundSchema = TextChunk$inboundSchema; - /** @deprecated use `TextChunk$outboundSchema` instead. */ - export const outboundSchema = TextChunk$outboundSchema; - /** @deprecated use `TextChunk$Outbound` instead. */ - export type Outbound = TextChunk$Outbound; -} - -export function textChunkToJSON(textChunk: TextChunk): string { - return JSON.stringify(TextChunk$outboundSchema.parse(textChunk)); -} - -export function textChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TextChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TextChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/thinkchunk.ts b/examples/sdks/mistral-typescript/src/models/components/thinkchunk.ts deleted file mode 100644 index 2e09c78d7..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/thinkchunk.ts +++ /dev/null @@ -1,162 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ReferenceChunk, - ReferenceChunk$inboundSchema, - ReferenceChunk$Outbound, - ReferenceChunk$outboundSchema, -} from "./referencechunk.js"; -import { - TextChunk, - TextChunk$inboundSchema, - TextChunk$Outbound, - TextChunk$outboundSchema, -} from "./textchunk.js"; - -export type Thinking = ReferenceChunk | TextChunk; - -export const ThinkChunkType = { - Thinking: "thinking", -} as const; -export type ThinkChunkType = ClosedEnum; - -export type ThinkChunk = { - thinking: Array; - /** - * Whether the thinking chunk is closed or not. Currently only used for prefixing. - */ - closed?: boolean | undefined; - type?: ThinkChunkType | undefined; -}; - -/** @internal */ -export const Thinking$inboundSchema: z.ZodType< - Thinking, - z.ZodTypeDef, - unknown -> = z.union([ReferenceChunk$inboundSchema, TextChunk$inboundSchema]); - -/** @internal */ -export type Thinking$Outbound = ReferenceChunk$Outbound | TextChunk$Outbound; - -/** @internal */ -export const Thinking$outboundSchema: z.ZodType< - Thinking$Outbound, - z.ZodTypeDef, - Thinking -> = z.union([ReferenceChunk$outboundSchema, TextChunk$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Thinking$ { - /** @deprecated use `Thinking$inboundSchema` instead. */ - export const inboundSchema = Thinking$inboundSchema; - /** @deprecated use `Thinking$outboundSchema` instead. */ - export const outboundSchema = Thinking$outboundSchema; - /** @deprecated use `Thinking$Outbound` instead. */ - export type Outbound = Thinking$Outbound; -} - -export function thinkingToJSON(thinking: Thinking): string { - return JSON.stringify(Thinking$outboundSchema.parse(thinking)); -} - -export function thinkingFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Thinking$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Thinking' from JSON`, - ); -} - -/** @internal */ -export const ThinkChunkType$inboundSchema: z.ZodNativeEnum< - typeof ThinkChunkType -> = z.nativeEnum(ThinkChunkType); - -/** @internal */ -export const ThinkChunkType$outboundSchema: z.ZodNativeEnum< - typeof ThinkChunkType -> = ThinkChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ThinkChunkType$ { - /** @deprecated use `ThinkChunkType$inboundSchema` instead. */ - export const inboundSchema = ThinkChunkType$inboundSchema; - /** @deprecated use `ThinkChunkType$outboundSchema` instead. */ - export const outboundSchema = ThinkChunkType$outboundSchema; -} - -/** @internal */ -export const ThinkChunk$inboundSchema: z.ZodType< - ThinkChunk, - z.ZodTypeDef, - unknown -> = z.object({ - thinking: z.array( - z.union([ReferenceChunk$inboundSchema, TextChunk$inboundSchema]), - ), - closed: z.boolean().optional(), - type: ThinkChunkType$inboundSchema.default("thinking"), -}); - -/** @internal */ -export type ThinkChunk$Outbound = { - thinking: Array; - closed?: boolean | undefined; - type: string; -}; - -/** @internal */ -export const ThinkChunk$outboundSchema: z.ZodType< - ThinkChunk$Outbound, - z.ZodTypeDef, - ThinkChunk -> = z.object({ - thinking: z.array( - z.union([ReferenceChunk$outboundSchema, TextChunk$outboundSchema]), - ), - closed: z.boolean().optional(), - type: ThinkChunkType$outboundSchema.default("thinking"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ThinkChunk$ { - /** @deprecated use `ThinkChunk$inboundSchema` instead. */ - export const inboundSchema = ThinkChunk$inboundSchema; - /** @deprecated use `ThinkChunk$outboundSchema` instead. */ - export const outboundSchema = ThinkChunk$outboundSchema; - /** @deprecated use `ThinkChunk$Outbound` instead. */ - export type Outbound = ThinkChunk$Outbound; -} - -export function thinkChunkToJSON(thinkChunk: ThinkChunk): string { - return JSON.stringify(ThinkChunk$outboundSchema.parse(thinkChunk)); -} - -export function thinkChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ThinkChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ThinkChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/timestampgranularity.ts b/examples/sdks/mistral-typescript/src/models/components/timestampgranularity.ts deleted file mode 100644 index 4e7a0dd4a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/timestampgranularity.ts +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const TimestampGranularity = { - Segment: "segment", -} as const; -export type TimestampGranularity = ClosedEnum; - -/** @internal */ -export const TimestampGranularity$inboundSchema: z.ZodNativeEnum< - typeof TimestampGranularity -> = z.nativeEnum(TimestampGranularity); - -/** @internal */ -export const TimestampGranularity$outboundSchema: z.ZodNativeEnum< - typeof TimestampGranularity -> = TimestampGranularity$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TimestampGranularity$ { - /** @deprecated use `TimestampGranularity$inboundSchema` instead. */ - export const inboundSchema = TimestampGranularity$inboundSchema; - /** @deprecated use `TimestampGranularity$outboundSchema` instead. */ - export const outboundSchema = TimestampGranularity$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/tool.ts b/examples/sdks/mistral-typescript/src/models/components/tool.ts deleted file mode 100644 index 0e1a73c3e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/tool.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionT, - FunctionT$inboundSchema, - FunctionT$Outbound, - FunctionT$outboundSchema, -} from "./function.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type Tool = { - type?: ToolTypes | undefined; - function: FunctionT; -}; - -/** @internal */ -export const Tool$inboundSchema: z.ZodType = z - .object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionT$inboundSchema, - }); - -/** @internal */ -export type Tool$Outbound = { - type?: string | undefined; - function: FunctionT$Outbound; -}; - -/** @internal */ -export const Tool$outboundSchema: z.ZodType = - z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionT$outboundSchema, - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Tool$ { - /** @deprecated use `Tool$inboundSchema` instead. */ - export const inboundSchema = Tool$inboundSchema; - /** @deprecated use `Tool$outboundSchema` instead. */ - export const outboundSchema = Tool$outboundSchema; - /** @deprecated use `Tool$Outbound` instead. */ - export type Outbound = Tool$Outbound; -} - -export function toolToJSON(tool: Tool): string { - return JSON.stringify(Tool$outboundSchema.parse(tool)); -} - -export function toolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Tool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Tool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolcall.ts b/examples/sdks/mistral-typescript/src/models/components/toolcall.ts deleted file mode 100644 index 3423370a0..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolcall.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionCall, - FunctionCall$inboundSchema, - FunctionCall$Outbound, - FunctionCall$outboundSchema, -} from "./functioncall.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -export type ToolCall = { - id?: string | undefined; - type?: ToolTypes | undefined; - function: FunctionCall; - index?: number | undefined; -}; - -/** @internal */ -export const ToolCall$inboundSchema: z.ZodType< - ToolCall, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$inboundSchema.optional(), - function: FunctionCall$inboundSchema, - index: z.number().int().default(0), -}); - -/** @internal */ -export type ToolCall$Outbound = { - id: string; - type?: string | undefined; - function: FunctionCall$Outbound; - index: number; -}; - -/** @internal */ -export const ToolCall$outboundSchema: z.ZodType< - ToolCall$Outbound, - z.ZodTypeDef, - ToolCall -> = z.object({ - id: z.string().default("null"), - type: ToolTypes$outboundSchema.optional(), - function: FunctionCall$outboundSchema, - index: z.number().int().default(0), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolCall$ { - /** @deprecated use `ToolCall$inboundSchema` instead. */ - export const inboundSchema = ToolCall$inboundSchema; - /** @deprecated use `ToolCall$outboundSchema` instead. */ - export const outboundSchema = ToolCall$outboundSchema; - /** @deprecated use `ToolCall$Outbound` instead. */ - export type Outbound = ToolCall$Outbound; -} - -export function toolCallToJSON(toolCall: ToolCall): string { - return JSON.stringify(ToolCall$outboundSchema.parse(toolCall)); -} - -export function toolCallFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolCall$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolCall' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolchoice.ts b/examples/sdks/mistral-typescript/src/models/components/toolchoice.ts deleted file mode 100644 index 68138162e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolchoice.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FunctionName, - FunctionName$inboundSchema, - FunctionName$Outbound, - FunctionName$outboundSchema, -} from "./functionname.js"; -import { - ToolTypes, - ToolTypes$inboundSchema, - ToolTypes$outboundSchema, -} from "./tooltypes.js"; - -/** - * ToolChoice is either a ToolChoiceEnum or a ToolChoice - */ -export type ToolChoice = { - type?: ToolTypes | undefined; - /** - * this restriction of `Function` is used to select a specific function to call - */ - function: FunctionName; -}; - -/** @internal */ -export const ToolChoice$inboundSchema: z.ZodType< - ToolChoice, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolTypes$inboundSchema.optional(), - function: FunctionName$inboundSchema, -}); - -/** @internal */ -export type ToolChoice$Outbound = { - type?: string | undefined; - function: FunctionName$Outbound; -}; - -/** @internal */ -export const ToolChoice$outboundSchema: z.ZodType< - ToolChoice$Outbound, - z.ZodTypeDef, - ToolChoice -> = z.object({ - type: ToolTypes$outboundSchema.optional(), - function: FunctionName$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoice$ { - /** @deprecated use `ToolChoice$inboundSchema` instead. */ - export const inboundSchema = ToolChoice$inboundSchema; - /** @deprecated use `ToolChoice$outboundSchema` instead. */ - export const outboundSchema = ToolChoice$outboundSchema; - /** @deprecated use `ToolChoice$Outbound` instead. */ - export type Outbound = ToolChoice$Outbound; -} - -export function toolChoiceToJSON(toolChoice: ToolChoice): string { - return JSON.stringify(ToolChoice$outboundSchema.parse(toolChoice)); -} - -export function toolChoiceFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolChoice$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolChoice' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolchoiceenum.ts b/examples/sdks/mistral-typescript/src/models/components/toolchoiceenum.ts deleted file mode 100644 index 401f927f5..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolchoiceenum.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const ToolChoiceEnum = { - Auto: "auto", - None: "none", - Any: "any", - Required: "required", -} as const; -export type ToolChoiceEnum = ClosedEnum; - -/** @internal */ -export const ToolChoiceEnum$inboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = z.nativeEnum(ToolChoiceEnum); - -/** @internal */ -export const ToolChoiceEnum$outboundSchema: z.ZodNativeEnum< - typeof ToolChoiceEnum -> = ToolChoiceEnum$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolChoiceEnum$ { - /** @deprecated use `ToolChoiceEnum$inboundSchema` instead. */ - export const inboundSchema = ToolChoiceEnum$inboundSchema; - /** @deprecated use `ToolChoiceEnum$outboundSchema` instead. */ - export const outboundSchema = ToolChoiceEnum$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolexecutiondeltaevent.ts b/examples/sdks/mistral-typescript/src/models/components/toolexecutiondeltaevent.ts deleted file mode 100644 index 5c531be91..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolexecutiondeltaevent.ts +++ /dev/null @@ -1,136 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolExecutionDeltaEventType = { - ToolExecutionDelta: "tool.execution.delta", -} as const; -export type ToolExecutionDeltaEventType = ClosedEnum< - typeof ToolExecutionDeltaEventType ->; - -export type ToolExecutionDeltaEvent = { - type?: ToolExecutionDeltaEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -/** @internal */ -export const ToolExecutionDeltaEventType$inboundSchema: z.ZodNativeEnum< - typeof ToolExecutionDeltaEventType -> = z.nativeEnum(ToolExecutionDeltaEventType); - -/** @internal */ -export const ToolExecutionDeltaEventType$outboundSchema: z.ZodNativeEnum< - typeof ToolExecutionDeltaEventType -> = ToolExecutionDeltaEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionDeltaEventType$ { - /** @deprecated use `ToolExecutionDeltaEventType$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionDeltaEventType$inboundSchema; - /** @deprecated use `ToolExecutionDeltaEventType$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionDeltaEventType$outboundSchema; -} - -/** @internal */ -export const ToolExecutionDeltaEvent$inboundSchema: z.ZodType< - ToolExecutionDeltaEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolExecutionDeltaEventType$inboundSchema.default( - "tool.execution.delta", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$inboundSchema, - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - }); -}); - -/** @internal */ -export type ToolExecutionDeltaEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -export const ToolExecutionDeltaEvent$outboundSchema: z.ZodType< - ToolExecutionDeltaEvent$Outbound, - z.ZodTypeDef, - ToolExecutionDeltaEvent -> = z.object({ - type: ToolExecutionDeltaEventType$outboundSchema.default( - "tool.execution.delta", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$outboundSchema, - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionDeltaEvent$ { - /** @deprecated use `ToolExecutionDeltaEvent$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionDeltaEvent$inboundSchema; - /** @deprecated use `ToolExecutionDeltaEvent$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionDeltaEvent$outboundSchema; - /** @deprecated use `ToolExecutionDeltaEvent$Outbound` instead. */ - export type Outbound = ToolExecutionDeltaEvent$Outbound; -} - -export function toolExecutionDeltaEventToJSON( - toolExecutionDeltaEvent: ToolExecutionDeltaEvent, -): string { - return JSON.stringify( - ToolExecutionDeltaEvent$outboundSchema.parse(toolExecutionDeltaEvent), - ); -} - -export function toolExecutionDeltaEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolExecutionDeltaEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolExecutionDeltaEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolexecutiondoneevent.ts b/examples/sdks/mistral-typescript/src/models/components/toolexecutiondoneevent.ts deleted file mode 100644 index 40ff65d3c..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolexecutiondoneevent.ts +++ /dev/null @@ -1,134 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolExecutionDoneEventType = { - ToolExecutionDone: "tool.execution.done", -} as const; -export type ToolExecutionDoneEventType = ClosedEnum< - typeof ToolExecutionDoneEventType ->; - -export type ToolExecutionDoneEvent = { - type?: ToolExecutionDoneEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - info?: { [k: string]: any } | undefined; -}; - -/** @internal */ -export const ToolExecutionDoneEventType$inboundSchema: z.ZodNativeEnum< - typeof ToolExecutionDoneEventType -> = z.nativeEnum(ToolExecutionDoneEventType); - -/** @internal */ -export const ToolExecutionDoneEventType$outboundSchema: z.ZodNativeEnum< - typeof ToolExecutionDoneEventType -> = ToolExecutionDoneEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionDoneEventType$ { - /** @deprecated use `ToolExecutionDoneEventType$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionDoneEventType$inboundSchema; - /** @deprecated use `ToolExecutionDoneEventType$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionDoneEventType$outboundSchema; -} - -/** @internal */ -export const ToolExecutionDoneEvent$inboundSchema: z.ZodType< - ToolExecutionDoneEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolExecutionDoneEventType$inboundSchema.default("tool.execution.done"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$inboundSchema, - info: z.record(z.any()).optional(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - }); -}); - -/** @internal */ -export type ToolExecutionDoneEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - info?: { [k: string]: any } | undefined; -}; - -/** @internal */ -export const ToolExecutionDoneEvent$outboundSchema: z.ZodType< - ToolExecutionDoneEvent$Outbound, - z.ZodTypeDef, - ToolExecutionDoneEvent -> = z.object({ - type: ToolExecutionDoneEventType$outboundSchema.default( - "tool.execution.done", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$outboundSchema, - info: z.record(z.any()).optional(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionDoneEvent$ { - /** @deprecated use `ToolExecutionDoneEvent$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionDoneEvent$inboundSchema; - /** @deprecated use `ToolExecutionDoneEvent$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionDoneEvent$outboundSchema; - /** @deprecated use `ToolExecutionDoneEvent$Outbound` instead. */ - export type Outbound = ToolExecutionDoneEvent$Outbound; -} - -export function toolExecutionDoneEventToJSON( - toolExecutionDoneEvent: ToolExecutionDoneEvent, -): string { - return JSON.stringify( - ToolExecutionDoneEvent$outboundSchema.parse(toolExecutionDoneEvent), - ); -} - -export function toolExecutionDoneEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolExecutionDoneEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolExecutionDoneEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolexecutionentry.ts b/examples/sdks/mistral-typescript/src/models/components/toolexecutionentry.ts deleted file mode 100644 index 6a6b07109..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolexecutionentry.ts +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolExecutionEntryObject = { - Entry: "entry", -} as const; -export type ToolExecutionEntryObject = ClosedEnum< - typeof ToolExecutionEntryObject ->; - -export const ToolExecutionEntryType = { - ToolExecution: "tool.execution", -} as const; -export type ToolExecutionEntryType = ClosedEnum; - -export type ToolExecutionEntry = { - object?: ToolExecutionEntryObject | undefined; - type?: ToolExecutionEntryType | undefined; - createdAt?: Date | undefined; - completedAt?: Date | null | undefined; - id?: string | undefined; - name: BuiltInConnectors; - arguments: string; - info?: { [k: string]: any } | undefined; -}; - -/** @internal */ -export const ToolExecutionEntryObject$inboundSchema: z.ZodNativeEnum< - typeof ToolExecutionEntryObject -> = z.nativeEnum(ToolExecutionEntryObject); - -/** @internal */ -export const ToolExecutionEntryObject$outboundSchema: z.ZodNativeEnum< - typeof ToolExecutionEntryObject -> = ToolExecutionEntryObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionEntryObject$ { - /** @deprecated use `ToolExecutionEntryObject$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionEntryObject$inboundSchema; - /** @deprecated use `ToolExecutionEntryObject$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionEntryObject$outboundSchema; -} - -/** @internal */ -export const ToolExecutionEntryType$inboundSchema: z.ZodNativeEnum< - typeof ToolExecutionEntryType -> = z.nativeEnum(ToolExecutionEntryType); - -/** @internal */ -export const ToolExecutionEntryType$outboundSchema: z.ZodNativeEnum< - typeof ToolExecutionEntryType -> = ToolExecutionEntryType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionEntryType$ { - /** @deprecated use `ToolExecutionEntryType$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionEntryType$inboundSchema; - /** @deprecated use `ToolExecutionEntryType$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionEntryType$outboundSchema; -} - -/** @internal */ -export const ToolExecutionEntry$inboundSchema: z.ZodType< - ToolExecutionEntry, - z.ZodTypeDef, - unknown -> = z.object({ - object: ToolExecutionEntryObject$inboundSchema.default("entry"), - type: ToolExecutionEntryType$inboundSchema.default("tool.execution"), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - completed_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - id: z.string().optional(), - name: BuiltInConnectors$inboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "completed_at": "completedAt", - }); -}); - -/** @internal */ -export type ToolExecutionEntry$Outbound = { - object: string; - type: string; - created_at?: string | undefined; - completed_at?: string | null | undefined; - id?: string | undefined; - name: string; - arguments: string; - info?: { [k: string]: any } | undefined; -}; - -/** @internal */ -export const ToolExecutionEntry$outboundSchema: z.ZodType< - ToolExecutionEntry$Outbound, - z.ZodTypeDef, - ToolExecutionEntry -> = z.object({ - object: ToolExecutionEntryObject$outboundSchema.default("entry"), - type: ToolExecutionEntryType$outboundSchema.default("tool.execution"), - createdAt: z.date().transform(v => v.toISOString()).optional(), - completedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(), - id: z.string().optional(), - name: BuiltInConnectors$outboundSchema, - arguments: z.string(), - info: z.record(z.any()).optional(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - completedAt: "completed_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionEntry$ { - /** @deprecated use `ToolExecutionEntry$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionEntry$inboundSchema; - /** @deprecated use `ToolExecutionEntry$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionEntry$outboundSchema; - /** @deprecated use `ToolExecutionEntry$Outbound` instead. */ - export type Outbound = ToolExecutionEntry$Outbound; -} - -export function toolExecutionEntryToJSON( - toolExecutionEntry: ToolExecutionEntry, -): string { - return JSON.stringify( - ToolExecutionEntry$outboundSchema.parse(toolExecutionEntry), - ); -} - -export function toolExecutionEntryFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolExecutionEntry$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolExecutionEntry' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolexecutionstartedevent.ts b/examples/sdks/mistral-typescript/src/models/components/toolexecutionstartedevent.ts deleted file mode 100644 index 1710c9bb4..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolexecutionstartedevent.ts +++ /dev/null @@ -1,136 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolExecutionStartedEventType = { - ToolExecutionStarted: "tool.execution.started", -} as const; -export type ToolExecutionStartedEventType = ClosedEnum< - typeof ToolExecutionStartedEventType ->; - -export type ToolExecutionStartedEvent = { - type?: ToolExecutionStartedEventType | undefined; - createdAt?: Date | undefined; - outputIndex?: number | undefined; - id: string; - name: BuiltInConnectors; - arguments: string; -}; - -/** @internal */ -export const ToolExecutionStartedEventType$inboundSchema: z.ZodNativeEnum< - typeof ToolExecutionStartedEventType -> = z.nativeEnum(ToolExecutionStartedEventType); - -/** @internal */ -export const ToolExecutionStartedEventType$outboundSchema: z.ZodNativeEnum< - typeof ToolExecutionStartedEventType -> = ToolExecutionStartedEventType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionStartedEventType$ { - /** @deprecated use `ToolExecutionStartedEventType$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionStartedEventType$inboundSchema; - /** @deprecated use `ToolExecutionStartedEventType$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionStartedEventType$outboundSchema; -} - -/** @internal */ -export const ToolExecutionStartedEvent$inboundSchema: z.ZodType< - ToolExecutionStartedEvent, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolExecutionStartedEventType$inboundSchema.default( - "tool.execution.started", - ), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)) - .optional(), - output_index: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$inboundSchema, - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "output_index": "outputIndex", - }); -}); - -/** @internal */ -export type ToolExecutionStartedEvent$Outbound = { - type: string; - created_at?: string | undefined; - output_index: number; - id: string; - name: string; - arguments: string; -}; - -/** @internal */ -export const ToolExecutionStartedEvent$outboundSchema: z.ZodType< - ToolExecutionStartedEvent$Outbound, - z.ZodTypeDef, - ToolExecutionStartedEvent -> = z.object({ - type: ToolExecutionStartedEventType$outboundSchema.default( - "tool.execution.started", - ), - createdAt: z.date().transform(v => v.toISOString()).optional(), - outputIndex: z.number().int().default(0), - id: z.string(), - name: BuiltInConnectors$outboundSchema, - arguments: z.string(), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - outputIndex: "output_index", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolExecutionStartedEvent$ { - /** @deprecated use `ToolExecutionStartedEvent$inboundSchema` instead. */ - export const inboundSchema = ToolExecutionStartedEvent$inboundSchema; - /** @deprecated use `ToolExecutionStartedEvent$outboundSchema` instead. */ - export const outboundSchema = ToolExecutionStartedEvent$outboundSchema; - /** @deprecated use `ToolExecutionStartedEvent$Outbound` instead. */ - export type Outbound = ToolExecutionStartedEvent$Outbound; -} - -export function toolExecutionStartedEventToJSON( - toolExecutionStartedEvent: ToolExecutionStartedEvent, -): string { - return JSON.stringify( - ToolExecutionStartedEvent$outboundSchema.parse(toolExecutionStartedEvent), - ); -} - -export function toolExecutionStartedEventFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolExecutionStartedEvent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolExecutionStartedEvent' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolfilechunk.ts b/examples/sdks/mistral-typescript/src/models/components/toolfilechunk.ts deleted file mode 100644 index 4efb8d720..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolfilechunk.ts +++ /dev/null @@ -1,123 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolFileChunkType = { - ToolFile: "tool_file", -} as const; -export type ToolFileChunkType = ClosedEnum; - -export type ToolFileChunk = { - type?: ToolFileChunkType | undefined; - tool: BuiltInConnectors; - fileId: string; - fileName?: string | null | undefined; - fileType?: string | null | undefined; -}; - -/** @internal */ -export const ToolFileChunkType$inboundSchema: z.ZodNativeEnum< - typeof ToolFileChunkType -> = z.nativeEnum(ToolFileChunkType); - -/** @internal */ -export const ToolFileChunkType$outboundSchema: z.ZodNativeEnum< - typeof ToolFileChunkType -> = ToolFileChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolFileChunkType$ { - /** @deprecated use `ToolFileChunkType$inboundSchema` instead. */ - export const inboundSchema = ToolFileChunkType$inboundSchema; - /** @deprecated use `ToolFileChunkType$outboundSchema` instead. */ - export const outboundSchema = ToolFileChunkType$outboundSchema; -} - -/** @internal */ -export const ToolFileChunk$inboundSchema: z.ZodType< - ToolFileChunk, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolFileChunkType$inboundSchema.default("tool_file"), - tool: BuiltInConnectors$inboundSchema, - file_id: z.string(), - file_name: z.nullable(z.string()).optional(), - file_type: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - "file_name": "fileName", - "file_type": "fileType", - }); -}); - -/** @internal */ -export type ToolFileChunk$Outbound = { - type: string; - tool: string; - file_id: string; - file_name?: string | null | undefined; - file_type?: string | null | undefined; -}; - -/** @internal */ -export const ToolFileChunk$outboundSchema: z.ZodType< - ToolFileChunk$Outbound, - z.ZodTypeDef, - ToolFileChunk -> = z.object({ - type: ToolFileChunkType$outboundSchema.default("tool_file"), - tool: BuiltInConnectors$outboundSchema, - fileId: z.string(), - fileName: z.nullable(z.string()).optional(), - fileType: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - fileName: "file_name", - fileType: "file_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolFileChunk$ { - /** @deprecated use `ToolFileChunk$inboundSchema` instead. */ - export const inboundSchema = ToolFileChunk$inboundSchema; - /** @deprecated use `ToolFileChunk$outboundSchema` instead. */ - export const outboundSchema = ToolFileChunk$outboundSchema; - /** @deprecated use `ToolFileChunk$Outbound` instead. */ - export type Outbound = ToolFileChunk$Outbound; -} - -export function toolFileChunkToJSON(toolFileChunk: ToolFileChunk): string { - return JSON.stringify(ToolFileChunk$outboundSchema.parse(toolFileChunk)); -} - -export function toolFileChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolFileChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolFileChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolmessage.ts b/examples/sdks/mistral-typescript/src/models/components/toolmessage.ts deleted file mode 100644 index a343e401a..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolmessage.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type ToolMessageContent = string | Array; - -export const ToolMessageRole = { - Tool: "tool", -} as const; -export type ToolMessageRole = ClosedEnum; - -export type ToolMessage = { - content: string | Array | null; - toolCallId?: string | null | undefined; - name?: string | null | undefined; - role?: ToolMessageRole | undefined; -}; - -/** @internal */ -export const ToolMessageContent$inboundSchema: z.ZodType< - ToolMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type ToolMessageContent$Outbound = string | Array; - -/** @internal */ -export const ToolMessageContent$outboundSchema: z.ZodType< - ToolMessageContent$Outbound, - z.ZodTypeDef, - ToolMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageContent$ { - /** @deprecated use `ToolMessageContent$inboundSchema` instead. */ - export const inboundSchema = ToolMessageContent$inboundSchema; - /** @deprecated use `ToolMessageContent$outboundSchema` instead. */ - export const outboundSchema = ToolMessageContent$outboundSchema; - /** @deprecated use `ToolMessageContent$Outbound` instead. */ - export type Outbound = ToolMessageContent$Outbound; -} - -export function toolMessageContentToJSON( - toolMessageContent: ToolMessageContent, -): string { - return JSON.stringify( - ToolMessageContent$outboundSchema.parse(toolMessageContent), - ); -} - -export function toolMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessageContent' from JSON`, - ); -} - -/** @internal */ -export const ToolMessageRole$inboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = z.nativeEnum(ToolMessageRole); - -/** @internal */ -export const ToolMessageRole$outboundSchema: z.ZodNativeEnum< - typeof ToolMessageRole -> = ToolMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessageRole$ { - /** @deprecated use `ToolMessageRole$inboundSchema` instead. */ - export const inboundSchema = ToolMessageRole$inboundSchema; - /** @deprecated use `ToolMessageRole$outboundSchema` instead. */ - export const outboundSchema = ToolMessageRole$outboundSchema; -} - -/** @internal */ -export const ToolMessage$inboundSchema: z.ZodType< - ToolMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - tool_call_id: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$inboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - "tool_call_id": "toolCallId", - }); -}); - -/** @internal */ -export type ToolMessage$Outbound = { - content: string | Array | null; - tool_call_id?: string | null | undefined; - name?: string | null | undefined; - role: string; -}; - -/** @internal */ -export const ToolMessage$outboundSchema: z.ZodType< - ToolMessage$Outbound, - z.ZodTypeDef, - ToolMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - toolCallId: z.nullable(z.string()).optional(), - name: z.nullable(z.string()).optional(), - role: ToolMessageRole$outboundSchema.default("tool"), -}).transform((v) => { - return remap$(v, { - toolCallId: "tool_call_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolMessage$ { - /** @deprecated use `ToolMessage$inboundSchema` instead. */ - export const inboundSchema = ToolMessage$inboundSchema; - /** @deprecated use `ToolMessage$outboundSchema` instead. */ - export const outboundSchema = ToolMessage$outboundSchema; - /** @deprecated use `ToolMessage$Outbound` instead. */ - export type Outbound = ToolMessage$Outbound; -} - -export function toolMessageToJSON(toolMessage: ToolMessage): string { - return JSON.stringify(ToolMessage$outboundSchema.parse(toolMessage)); -} - -export function toolMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/toolreferencechunk.ts b/examples/sdks/mistral-typescript/src/models/components/toolreferencechunk.ts deleted file mode 100644 index f9f3fcf88..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/toolreferencechunk.ts +++ /dev/null @@ -1,118 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - BuiltInConnectors, - BuiltInConnectors$inboundSchema, - BuiltInConnectors$outboundSchema, -} from "./builtinconnectors.js"; - -export const ToolReferenceChunkType = { - ToolReference: "tool_reference", -} as const; -export type ToolReferenceChunkType = ClosedEnum; - -export type ToolReferenceChunk = { - type?: ToolReferenceChunkType | undefined; - tool: BuiltInConnectors; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const ToolReferenceChunkType$inboundSchema: z.ZodNativeEnum< - typeof ToolReferenceChunkType -> = z.nativeEnum(ToolReferenceChunkType); - -/** @internal */ -export const ToolReferenceChunkType$outboundSchema: z.ZodNativeEnum< - typeof ToolReferenceChunkType -> = ToolReferenceChunkType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolReferenceChunkType$ { - /** @deprecated use `ToolReferenceChunkType$inboundSchema` instead. */ - export const inboundSchema = ToolReferenceChunkType$inboundSchema; - /** @deprecated use `ToolReferenceChunkType$outboundSchema` instead. */ - export const outboundSchema = ToolReferenceChunkType$outboundSchema; -} - -/** @internal */ -export const ToolReferenceChunk$inboundSchema: z.ZodType< - ToolReferenceChunk, - z.ZodTypeDef, - unknown -> = z.object({ - type: ToolReferenceChunkType$inboundSchema.default("tool_reference"), - tool: BuiltInConnectors$inboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type ToolReferenceChunk$Outbound = { - type: string; - tool: string; - title: string; - url?: string | null | undefined; - favicon?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const ToolReferenceChunk$outboundSchema: z.ZodType< - ToolReferenceChunk$Outbound, - z.ZodTypeDef, - ToolReferenceChunk -> = z.object({ - type: ToolReferenceChunkType$outboundSchema.default("tool_reference"), - tool: BuiltInConnectors$outboundSchema, - title: z.string(), - url: z.nullable(z.string()).optional(), - favicon: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolReferenceChunk$ { - /** @deprecated use `ToolReferenceChunk$inboundSchema` instead. */ - export const inboundSchema = ToolReferenceChunk$inboundSchema; - /** @deprecated use `ToolReferenceChunk$outboundSchema` instead. */ - export const outboundSchema = ToolReferenceChunk$outboundSchema; - /** @deprecated use `ToolReferenceChunk$Outbound` instead. */ - export type Outbound = ToolReferenceChunk$Outbound; -} - -export function toolReferenceChunkToJSON( - toolReferenceChunk: ToolReferenceChunk, -): string { - return JSON.stringify( - ToolReferenceChunk$outboundSchema.parse(toolReferenceChunk), - ); -} - -export function toolReferenceChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ToolReferenceChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ToolReferenceChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/tooltypes.ts b/examples/sdks/mistral-typescript/src/models/components/tooltypes.ts deleted file mode 100644 index a414745f8..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/tooltypes.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - catchUnrecognizedEnum, - OpenEnum, - Unrecognized, -} from "../../types/enums.js"; - -export const ToolTypes = { - Function: "function", -} as const; -export type ToolTypes = OpenEnum; - -/** @internal */ -export const ToolTypes$inboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - unknown -> = z - .union([ - z.nativeEnum(ToolTypes), - z.string().transform(catchUnrecognizedEnum), - ]); - -/** @internal */ -export const ToolTypes$outboundSchema: z.ZodType< - ToolTypes, - z.ZodTypeDef, - ToolTypes -> = z.union([ - z.nativeEnum(ToolTypes), - z.string().and(z.custom>()), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ToolTypes$ { - /** @deprecated use `ToolTypes$inboundSchema` instead. */ - export const inboundSchema = ToolTypes$inboundSchema; - /** @deprecated use `ToolTypes$outboundSchema` instead. */ - export const outboundSchema = ToolTypes$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/trainingfile.ts b/examples/sdks/mistral-typescript/src/models/components/trainingfile.ts deleted file mode 100644 index f28d7886e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/trainingfile.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type TrainingFile = { - fileId: string; - weight?: number | undefined; -}; - -/** @internal */ -export const TrainingFile$inboundSchema: z.ZodType< - TrainingFile, - z.ZodTypeDef, - unknown -> = z.object({ - file_id: z.string(), - weight: z.number().default(1), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type TrainingFile$Outbound = { - file_id: string; - weight: number; -}; - -/** @internal */ -export const TrainingFile$outboundSchema: z.ZodType< - TrainingFile$Outbound, - z.ZodTypeDef, - TrainingFile -> = z.object({ - fileId: z.string(), - weight: z.number().default(1), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TrainingFile$ { - /** @deprecated use `TrainingFile$inboundSchema` instead. */ - export const inboundSchema = TrainingFile$inboundSchema; - /** @deprecated use `TrainingFile$outboundSchema` instead. */ - export const outboundSchema = TrainingFile$outboundSchema; - /** @deprecated use `TrainingFile$Outbound` instead. */ - export type Outbound = TrainingFile$Outbound; -} - -export function trainingFileToJSON(trainingFile: TrainingFile): string { - return JSON.stringify(TrainingFile$outboundSchema.parse(trainingFile)); -} - -export function trainingFileFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TrainingFile$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TrainingFile' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionresponse.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionresponse.ts deleted file mode 100644 index 9c64d9412..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionresponse.ts +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TranscriptionSegmentChunk, - TranscriptionSegmentChunk$inboundSchema, - TranscriptionSegmentChunk$Outbound, - TranscriptionSegmentChunk$outboundSchema, -} from "./transcriptionsegmentchunk.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export type TranscriptionResponse = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - language: string | null; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const TranscriptionResponse$inboundSchema: z.ZodType< - TranscriptionResponse, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - model: z.string(), - text: z.string(), - segments: z.array(TranscriptionSegmentChunk$inboundSchema).optional(), - usage: UsageInfo$inboundSchema, - language: z.nullable(z.string()), - }).catchall(z.any()), - "additionalProperties", - true, -); - -/** @internal */ -export type TranscriptionResponse$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionResponse$outboundSchema: z.ZodType< - TranscriptionResponse$Outbound, - z.ZodTypeDef, - TranscriptionResponse -> = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(TranscriptionSegmentChunk$outboundSchema).optional(), - usage: UsageInfo$outboundSchema, - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionResponse$ { - /** @deprecated use `TranscriptionResponse$inboundSchema` instead. */ - export const inboundSchema = TranscriptionResponse$inboundSchema; - /** @deprecated use `TranscriptionResponse$outboundSchema` instead. */ - export const outboundSchema = TranscriptionResponse$outboundSchema; - /** @deprecated use `TranscriptionResponse$Outbound` instead. */ - export type Outbound = TranscriptionResponse$Outbound; -} - -export function transcriptionResponseToJSON( - transcriptionResponse: TranscriptionResponse, -): string { - return JSON.stringify( - TranscriptionResponse$outboundSchema.parse(transcriptionResponse), - ); -} - -export function transcriptionResponseFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionResponse$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionsegmentchunk.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionsegmentchunk.ts deleted file mode 100644 index b1746120b..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionsegmentchunk.ts +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const Type = { - TranscriptionSegment: "transcription_segment", -} as const; -export type Type = ClosedEnum; - -export type TranscriptionSegmentChunk = { - text: string; - start: number; - end: number; - type?: Type | undefined; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const Type$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Type, -); - -/** @internal */ -export const Type$outboundSchema: z.ZodNativeEnum = - Type$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Type$ { - /** @deprecated use `Type$inboundSchema` instead. */ - export const inboundSchema = Type$inboundSchema; - /** @deprecated use `Type$outboundSchema` instead. */ - export const outboundSchema = Type$outboundSchema; -} - -/** @internal */ -export const TranscriptionSegmentChunk$inboundSchema: z.ZodType< - TranscriptionSegmentChunk, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: Type$inboundSchema.default("transcription_segment"), - }).catchall(z.any()), - "additionalProperties", - true, -); - -/** @internal */ -export type TranscriptionSegmentChunk$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionSegmentChunk$outboundSchema: z.ZodType< - TranscriptionSegmentChunk$Outbound, - z.ZodTypeDef, - TranscriptionSegmentChunk -> = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: Type$outboundSchema.default("transcription_segment"), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionSegmentChunk$ { - /** @deprecated use `TranscriptionSegmentChunk$inboundSchema` instead. */ - export const inboundSchema = TranscriptionSegmentChunk$inboundSchema; - /** @deprecated use `TranscriptionSegmentChunk$outboundSchema` instead. */ - export const outboundSchema = TranscriptionSegmentChunk$outboundSchema; - /** @deprecated use `TranscriptionSegmentChunk$Outbound` instead. */ - export type Outbound = TranscriptionSegmentChunk$Outbound; -} - -export function transcriptionSegmentChunkToJSON( - transcriptionSegmentChunk: TranscriptionSegmentChunk, -): string { - return JSON.stringify( - TranscriptionSegmentChunk$outboundSchema.parse(transcriptionSegmentChunk), - ); -} - -export function transcriptionSegmentChunkFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionSegmentChunk$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionSegmentChunk' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamdone.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamdone.ts deleted file mode 100644 index 2cb7aa327..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamdone.ts +++ /dev/null @@ -1,149 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TranscriptionSegmentChunk, - TranscriptionSegmentChunk$inboundSchema, - TranscriptionSegmentChunk$Outbound, - TranscriptionSegmentChunk$outboundSchema, -} from "./transcriptionsegmentchunk.js"; -import { - UsageInfo, - UsageInfo$inboundSchema, - UsageInfo$Outbound, - UsageInfo$outboundSchema, -} from "./usageinfo.js"; - -export const TranscriptionStreamDoneType = { - TranscriptionDone: "transcription.done", -} as const; -export type TranscriptionStreamDoneType = ClosedEnum< - typeof TranscriptionStreamDoneType ->; - -export type TranscriptionStreamDone = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo; - type?: TranscriptionStreamDoneType | undefined; - language: string | null; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const TranscriptionStreamDoneType$inboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamDoneType -> = z.nativeEnum(TranscriptionStreamDoneType); - -/** @internal */ -export const TranscriptionStreamDoneType$outboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamDoneType -> = TranscriptionStreamDoneType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamDoneType$ { - /** @deprecated use `TranscriptionStreamDoneType$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamDoneType$inboundSchema; - /** @deprecated use `TranscriptionStreamDoneType$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamDoneType$outboundSchema; -} - -/** @internal */ -export const TranscriptionStreamDone$inboundSchema: z.ZodType< - TranscriptionStreamDone, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - model: z.string(), - text: z.string(), - segments: z.array(TranscriptionSegmentChunk$inboundSchema).optional(), - usage: UsageInfo$inboundSchema, - type: TranscriptionStreamDoneType$inboundSchema.default( - "transcription.done", - ), - language: z.nullable(z.string()), - }).catchall(z.any()), - "additionalProperties", - true, -); - -/** @internal */ -export type TranscriptionStreamDone$Outbound = { - model: string; - text: string; - segments?: Array | undefined; - usage: UsageInfo$Outbound; - type: string; - language: string | null; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionStreamDone$outboundSchema: z.ZodType< - TranscriptionStreamDone$Outbound, - z.ZodTypeDef, - TranscriptionStreamDone -> = z.object({ - model: z.string(), - text: z.string(), - segments: z.array(TranscriptionSegmentChunk$outboundSchema).optional(), - usage: UsageInfo$outboundSchema, - type: TranscriptionStreamDoneType$outboundSchema.default( - "transcription.done", - ), - language: z.nullable(z.string()), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamDone$ { - /** @deprecated use `TranscriptionStreamDone$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamDone$inboundSchema; - /** @deprecated use `TranscriptionStreamDone$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamDone$outboundSchema; - /** @deprecated use `TranscriptionStreamDone$Outbound` instead. */ - export type Outbound = TranscriptionStreamDone$Outbound; -} - -export function transcriptionStreamDoneToJSON( - transcriptionStreamDone: TranscriptionStreamDone, -): string { - return JSON.stringify( - TranscriptionStreamDone$outboundSchema.parse(transcriptionStreamDone), - ); -} - -export function transcriptionStreamDoneFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamDone$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamDone' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamevents.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamevents.ts deleted file mode 100644 index 4afdf3229..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamevents.ts +++ /dev/null @@ -1,273 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - TranscriptionStreamDone, - TranscriptionStreamDone$inboundSchema, - TranscriptionStreamDone$Outbound, - TranscriptionStreamDone$outboundSchema, -} from "./transcriptionstreamdone.js"; -import { - TranscriptionStreamEventTypes, - TranscriptionStreamEventTypes$inboundSchema, - TranscriptionStreamEventTypes$outboundSchema, -} from "./transcriptionstreameventtypes.js"; -import { - TranscriptionStreamLanguage, - TranscriptionStreamLanguage$inboundSchema, - TranscriptionStreamLanguage$Outbound, - TranscriptionStreamLanguage$outboundSchema, -} from "./transcriptionstreamlanguage.js"; -import { - TranscriptionStreamSegmentDelta, - TranscriptionStreamSegmentDelta$inboundSchema, - TranscriptionStreamSegmentDelta$Outbound, - TranscriptionStreamSegmentDelta$outboundSchema, -} from "./transcriptionstreamsegmentdelta.js"; -import { - TranscriptionStreamTextDelta, - TranscriptionStreamTextDelta$inboundSchema, - TranscriptionStreamTextDelta$Outbound, - TranscriptionStreamTextDelta$outboundSchema, -} from "./transcriptionstreamtextdelta.js"; - -export type TranscriptionStreamEventsData = - | (TranscriptionStreamDone & { type: "transcription.done" }) - | (TranscriptionStreamSegmentDelta & { type: "transcription.segment" }) - | (TranscriptionStreamLanguage & { type: "transcription.language" }) - | (TranscriptionStreamTextDelta & { type: "transcription.text.delta" }); - -export type TranscriptionStreamEvents = { - event: TranscriptionStreamEventTypes; - data: - | (TranscriptionStreamDone & { type: "transcription.done" }) - | (TranscriptionStreamSegmentDelta & { type: "transcription.segment" }) - | (TranscriptionStreamLanguage & { type: "transcription.language" }) - | (TranscriptionStreamTextDelta & { type: "transcription.text.delta" }); -}; - -/** @internal */ -export const TranscriptionStreamEventsData$inboundSchema: z.ZodType< - TranscriptionStreamEventsData, - z.ZodTypeDef, - unknown -> = z.union([ - TranscriptionStreamDone$inboundSchema.and( - z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamSegmentDelta$inboundSchema.and( - z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamLanguage$inboundSchema.and( - z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamTextDelta$inboundSchema.and( - z.object({ type: z.literal("transcription.text.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), -]); - -/** @internal */ -export type TranscriptionStreamEventsData$Outbound = - | (TranscriptionStreamDone$Outbound & { type: "transcription.done" }) - | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; - }) - | (TranscriptionStreamLanguage$Outbound & { type: "transcription.language" }) - | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; - }); - -/** @internal */ -export const TranscriptionStreamEventsData$outboundSchema: z.ZodType< - TranscriptionStreamEventsData$Outbound, - z.ZodTypeDef, - TranscriptionStreamEventsData -> = z.union([ - TranscriptionStreamDone$outboundSchema.and( - z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamSegmentDelta$outboundSchema.and( - z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamLanguage$outboundSchema.and( - z.object({ type: z.literal("transcription.language") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamTextDelta$outboundSchema.and( - z.object({ type: z.literal("transcription.text.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamEventsData$ { - /** @deprecated use `TranscriptionStreamEventsData$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamEventsData$inboundSchema; - /** @deprecated use `TranscriptionStreamEventsData$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamEventsData$outboundSchema; - /** @deprecated use `TranscriptionStreamEventsData$Outbound` instead. */ - export type Outbound = TranscriptionStreamEventsData$Outbound; -} - -export function transcriptionStreamEventsDataToJSON( - transcriptionStreamEventsData: TranscriptionStreamEventsData, -): string { - return JSON.stringify( - TranscriptionStreamEventsData$outboundSchema.parse( - transcriptionStreamEventsData, - ), - ); -} - -export function transcriptionStreamEventsDataFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamEventsData$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamEventsData' from JSON`, - ); -} - -/** @internal */ -export const TranscriptionStreamEvents$inboundSchema: z.ZodType< - TranscriptionStreamEvents, - z.ZodTypeDef, - unknown -> = z.object({ - event: TranscriptionStreamEventTypes$inboundSchema, - data: z.string().transform((v, ctx) => { - try { - return JSON.parse(v); - } catch (err) { - ctx.addIssue({ - code: z.ZodIssueCode.custom, - message: `malformed json: ${err}`, - }); - return z.NEVER; - } - }).pipe( - z.union([ - TranscriptionStreamDone$inboundSchema.and( - z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamSegmentDelta$inboundSchema.and( - z.object({ type: z.literal("transcription.segment") }).transform(( - v, - ) => ({ type: v.type })), - ), - TranscriptionStreamLanguage$inboundSchema.and( - z.object({ type: z.literal("transcription.language") }).transform(( - v, - ) => ({ type: v.type })), - ), - TranscriptionStreamTextDelta$inboundSchema.and( - z.object({ type: z.literal("transcription.text.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), - ), -}); - -/** @internal */ -export type TranscriptionStreamEvents$Outbound = { - event: string; - data: - | (TranscriptionStreamDone$Outbound & { type: "transcription.done" }) - | (TranscriptionStreamSegmentDelta$Outbound & { - type: "transcription.segment"; - }) - | (TranscriptionStreamLanguage$Outbound & { - type: "transcription.language"; - }) - | (TranscriptionStreamTextDelta$Outbound & { - type: "transcription.text.delta"; - }); -}; - -/** @internal */ -export const TranscriptionStreamEvents$outboundSchema: z.ZodType< - TranscriptionStreamEvents$Outbound, - z.ZodTypeDef, - TranscriptionStreamEvents -> = z.object({ - event: TranscriptionStreamEventTypes$outboundSchema, - data: z.union([ - TranscriptionStreamDone$outboundSchema.and( - z.object({ type: z.literal("transcription.done") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamSegmentDelta$outboundSchema.and( - z.object({ type: z.literal("transcription.segment") }).transform((v) => ({ - type: v.type, - })), - ), - TranscriptionStreamLanguage$outboundSchema.and( - z.object({ type: z.literal("transcription.language") }).transform(( - v, - ) => ({ type: v.type })), - ), - TranscriptionStreamTextDelta$outboundSchema.and( - z.object({ type: z.literal("transcription.text.delta") }).transform(( - v, - ) => ({ type: v.type })), - ), - ]), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamEvents$ { - /** @deprecated use `TranscriptionStreamEvents$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamEvents$inboundSchema; - /** @deprecated use `TranscriptionStreamEvents$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamEvents$outboundSchema; - /** @deprecated use `TranscriptionStreamEvents$Outbound` instead. */ - export type Outbound = TranscriptionStreamEvents$Outbound; -} - -export function transcriptionStreamEventsToJSON( - transcriptionStreamEvents: TranscriptionStreamEvents, -): string { - return JSON.stringify( - TranscriptionStreamEvents$outboundSchema.parse(transcriptionStreamEvents), - ); -} - -export function transcriptionStreamEventsFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamEvents$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamEvents' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreameventtypes.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreameventtypes.ts deleted file mode 100644 index a02eecb02..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreameventtypes.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const TranscriptionStreamEventTypes = { - TranscriptionLanguage: "transcription.language", - TranscriptionSegment: "transcription.segment", - TranscriptionTextDelta: "transcription.text.delta", - TranscriptionDone: "transcription.done", -} as const; -export type TranscriptionStreamEventTypes = ClosedEnum< - typeof TranscriptionStreamEventTypes ->; - -/** @internal */ -export const TranscriptionStreamEventTypes$inboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamEventTypes -> = z.nativeEnum(TranscriptionStreamEventTypes); - -/** @internal */ -export const TranscriptionStreamEventTypes$outboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamEventTypes -> = TranscriptionStreamEventTypes$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamEventTypes$ { - /** @deprecated use `TranscriptionStreamEventTypes$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamEventTypes$inboundSchema; - /** @deprecated use `TranscriptionStreamEventTypes$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamEventTypes$outboundSchema; -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamlanguage.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamlanguage.ts deleted file mode 100644 index 0e3b73882..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamlanguage.ts +++ /dev/null @@ -1,128 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const TranscriptionStreamLanguageType = { - TranscriptionLanguage: "transcription.language", -} as const; -export type TranscriptionStreamLanguageType = ClosedEnum< - typeof TranscriptionStreamLanguageType ->; - -export type TranscriptionStreamLanguage = { - type?: TranscriptionStreamLanguageType | undefined; - audioLanguage: string; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const TranscriptionStreamLanguageType$inboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamLanguageType -> = z.nativeEnum(TranscriptionStreamLanguageType); - -/** @internal */ -export const TranscriptionStreamLanguageType$outboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamLanguageType -> = TranscriptionStreamLanguageType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamLanguageType$ { - /** @deprecated use `TranscriptionStreamLanguageType$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamLanguageType$inboundSchema; - /** @deprecated use `TranscriptionStreamLanguageType$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamLanguageType$outboundSchema; -} - -/** @internal */ -export const TranscriptionStreamLanguage$inboundSchema: z.ZodType< - TranscriptionStreamLanguage, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - type: TranscriptionStreamLanguageType$inboundSchema.default( - "transcription.language", - ), - audio_language: z.string(), - }).catchall(z.any()), - "additionalProperties", - true, -).transform((v) => { - return remap$(v, { - "audio_language": "audioLanguage", - }); -}); - -/** @internal */ -export type TranscriptionStreamLanguage$Outbound = { - type: string; - audio_language: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionStreamLanguage$outboundSchema: z.ZodType< - TranscriptionStreamLanguage$Outbound, - z.ZodTypeDef, - TranscriptionStreamLanguage -> = z.object({ - type: TranscriptionStreamLanguageType$outboundSchema.default( - "transcription.language", - ), - audioLanguage: z.string(), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - audioLanguage: "audio_language", - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamLanguage$ { - /** @deprecated use `TranscriptionStreamLanguage$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamLanguage$inboundSchema; - /** @deprecated use `TranscriptionStreamLanguage$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamLanguage$outboundSchema; - /** @deprecated use `TranscriptionStreamLanguage$Outbound` instead. */ - export type Outbound = TranscriptionStreamLanguage$Outbound; -} - -export function transcriptionStreamLanguageToJSON( - transcriptionStreamLanguage: TranscriptionStreamLanguage, -): string { - return JSON.stringify( - TranscriptionStreamLanguage$outboundSchema.parse( - transcriptionStreamLanguage, - ), - ); -} - -export function transcriptionStreamLanguageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamLanguage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamLanguage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamsegmentdelta.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamsegmentdelta.ts deleted file mode 100644 index 4eb1d54d3..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamsegmentdelta.ts +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const TranscriptionStreamSegmentDeltaType = { - TranscriptionSegment: "transcription.segment", -} as const; -export type TranscriptionStreamSegmentDeltaType = ClosedEnum< - typeof TranscriptionStreamSegmentDeltaType ->; - -export type TranscriptionStreamSegmentDelta = { - text: string; - start: number; - end: number; - type?: TranscriptionStreamSegmentDeltaType | undefined; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const TranscriptionStreamSegmentDeltaType$inboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamSegmentDeltaType -> = z.nativeEnum(TranscriptionStreamSegmentDeltaType); - -/** @internal */ -export const TranscriptionStreamSegmentDeltaType$outboundSchema: - z.ZodNativeEnum = - TranscriptionStreamSegmentDeltaType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamSegmentDeltaType$ { - /** @deprecated use `TranscriptionStreamSegmentDeltaType$inboundSchema` instead. */ - export const inboundSchema = - TranscriptionStreamSegmentDeltaType$inboundSchema; - /** @deprecated use `TranscriptionStreamSegmentDeltaType$outboundSchema` instead. */ - export const outboundSchema = - TranscriptionStreamSegmentDeltaType$outboundSchema; -} - -/** @internal */ -export const TranscriptionStreamSegmentDelta$inboundSchema: z.ZodType< - TranscriptionStreamSegmentDelta, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: TranscriptionStreamSegmentDeltaType$inboundSchema.default( - "transcription.segment", - ), - }).catchall(z.any()), - "additionalProperties", - true, -); - -/** @internal */ -export type TranscriptionStreamSegmentDelta$Outbound = { - text: string; - start: number; - end: number; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionStreamSegmentDelta$outboundSchema: z.ZodType< - TranscriptionStreamSegmentDelta$Outbound, - z.ZodTypeDef, - TranscriptionStreamSegmentDelta -> = z.object({ - text: z.string(), - start: z.number(), - end: z.number(), - type: TranscriptionStreamSegmentDeltaType$outboundSchema.default( - "transcription.segment", - ), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamSegmentDelta$ { - /** @deprecated use `TranscriptionStreamSegmentDelta$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamSegmentDelta$inboundSchema; - /** @deprecated use `TranscriptionStreamSegmentDelta$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamSegmentDelta$outboundSchema; - /** @deprecated use `TranscriptionStreamSegmentDelta$Outbound` instead. */ - export type Outbound = TranscriptionStreamSegmentDelta$Outbound; -} - -export function transcriptionStreamSegmentDeltaToJSON( - transcriptionStreamSegmentDelta: TranscriptionStreamSegmentDelta, -): string { - return JSON.stringify( - TranscriptionStreamSegmentDelta$outboundSchema.parse( - transcriptionStreamSegmentDelta, - ), - ); -} - -export function transcriptionStreamSegmentDeltaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamSegmentDelta$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamSegmentDelta' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamtextdelta.ts b/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamtextdelta.ts deleted file mode 100644 index c2664a004..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/transcriptionstreamtextdelta.ts +++ /dev/null @@ -1,123 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const TranscriptionStreamTextDeltaType = { - TranscriptionTextDelta: "transcription.text.delta", -} as const; -export type TranscriptionStreamTextDeltaType = ClosedEnum< - typeof TranscriptionStreamTextDeltaType ->; - -export type TranscriptionStreamTextDelta = { - text: string; - type?: TranscriptionStreamTextDeltaType | undefined; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const TranscriptionStreamTextDeltaType$inboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamTextDeltaType -> = z.nativeEnum(TranscriptionStreamTextDeltaType); - -/** @internal */ -export const TranscriptionStreamTextDeltaType$outboundSchema: z.ZodNativeEnum< - typeof TranscriptionStreamTextDeltaType -> = TranscriptionStreamTextDeltaType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamTextDeltaType$ { - /** @deprecated use `TranscriptionStreamTextDeltaType$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamTextDeltaType$inboundSchema; - /** @deprecated use `TranscriptionStreamTextDeltaType$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamTextDeltaType$outboundSchema; -} - -/** @internal */ -export const TranscriptionStreamTextDelta$inboundSchema: z.ZodType< - TranscriptionStreamTextDelta, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - text: z.string(), - type: TranscriptionStreamTextDeltaType$inboundSchema.default( - "transcription.text.delta", - ), - }).catchall(z.any()), - "additionalProperties", - true, -); - -/** @internal */ -export type TranscriptionStreamTextDelta$Outbound = { - text: string; - type: string; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const TranscriptionStreamTextDelta$outboundSchema: z.ZodType< - TranscriptionStreamTextDelta$Outbound, - z.ZodTypeDef, - TranscriptionStreamTextDelta -> = z.object({ - text: z.string(), - type: TranscriptionStreamTextDeltaType$outboundSchema.default( - "transcription.text.delta", - ), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace TranscriptionStreamTextDelta$ { - /** @deprecated use `TranscriptionStreamTextDelta$inboundSchema` instead. */ - export const inboundSchema = TranscriptionStreamTextDelta$inboundSchema; - /** @deprecated use `TranscriptionStreamTextDelta$outboundSchema` instead. */ - export const outboundSchema = TranscriptionStreamTextDelta$outboundSchema; - /** @deprecated use `TranscriptionStreamTextDelta$Outbound` instead. */ - export type Outbound = TranscriptionStreamTextDelta$Outbound; -} - -export function transcriptionStreamTextDeltaToJSON( - transcriptionStreamTextDelta: TranscriptionStreamTextDelta, -): string { - return JSON.stringify( - TranscriptionStreamTextDelta$outboundSchema.parse( - transcriptionStreamTextDelta, - ), - ); -} - -export function transcriptionStreamTextDeltaFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => TranscriptionStreamTextDelta$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'TranscriptionStreamTextDelta' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/unarchiveftmodelout.ts b/examples/sdks/mistral-typescript/src/models/components/unarchiveftmodelout.ts deleted file mode 100644 index 4832cfee4..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/unarchiveftmodelout.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const UnarchiveFTModelOutObject = { - Model: "model", -} as const; -export type UnarchiveFTModelOutObject = ClosedEnum< - typeof UnarchiveFTModelOutObject ->; - -export type UnarchiveFTModelOut = { - id: string; - object?: UnarchiveFTModelOutObject | undefined; - archived?: boolean | undefined; -}; - -/** @internal */ -export const UnarchiveFTModelOutObject$inboundSchema: z.ZodNativeEnum< - typeof UnarchiveFTModelOutObject -> = z.nativeEnum(UnarchiveFTModelOutObject); - -/** @internal */ -export const UnarchiveFTModelOutObject$outboundSchema: z.ZodNativeEnum< - typeof UnarchiveFTModelOutObject -> = UnarchiveFTModelOutObject$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UnarchiveFTModelOutObject$ { - /** @deprecated use `UnarchiveFTModelOutObject$inboundSchema` instead. */ - export const inboundSchema = UnarchiveFTModelOutObject$inboundSchema; - /** @deprecated use `UnarchiveFTModelOutObject$outboundSchema` instead. */ - export const outboundSchema = UnarchiveFTModelOutObject$outboundSchema; -} - -/** @internal */ -export const UnarchiveFTModelOut$inboundSchema: z.ZodType< - UnarchiveFTModelOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: UnarchiveFTModelOutObject$inboundSchema.default("model"), - archived: z.boolean().default(false), -}); - -/** @internal */ -export type UnarchiveFTModelOut$Outbound = { - id: string; - object: string; - archived: boolean; -}; - -/** @internal */ -export const UnarchiveFTModelOut$outboundSchema: z.ZodType< - UnarchiveFTModelOut$Outbound, - z.ZodTypeDef, - UnarchiveFTModelOut -> = z.object({ - id: z.string(), - object: UnarchiveFTModelOutObject$outboundSchema.default("model"), - archived: z.boolean().default(false), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UnarchiveFTModelOut$ { - /** @deprecated use `UnarchiveFTModelOut$inboundSchema` instead. */ - export const inboundSchema = UnarchiveFTModelOut$inboundSchema; - /** @deprecated use `UnarchiveFTModelOut$outboundSchema` instead. */ - export const outboundSchema = UnarchiveFTModelOut$outboundSchema; - /** @deprecated use `UnarchiveFTModelOut$Outbound` instead. */ - export type Outbound = UnarchiveFTModelOut$Outbound; -} - -export function unarchiveFTModelOutToJSON( - unarchiveFTModelOut: UnarchiveFTModelOut, -): string { - return JSON.stringify( - UnarchiveFTModelOut$outboundSchema.parse(unarchiveFTModelOut), - ); -} - -export function unarchiveFTModelOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UnarchiveFTModelOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UnarchiveFTModelOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/updateftmodelin.ts b/examples/sdks/mistral-typescript/src/models/components/updateftmodelin.ts deleted file mode 100644 index 51c79417e..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/updateftmodelin.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type UpdateFTModelIn = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const UpdateFTModelIn$inboundSchema: z.ZodType< - UpdateFTModelIn, - z.ZodTypeDef, - unknown -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** @internal */ -export type UpdateFTModelIn$Outbound = { - name?: string | null | undefined; - description?: string | null | undefined; -}; - -/** @internal */ -export const UpdateFTModelIn$outboundSchema: z.ZodType< - UpdateFTModelIn$Outbound, - z.ZodTypeDef, - UpdateFTModelIn -> = z.object({ - name: z.nullable(z.string()).optional(), - description: z.nullable(z.string()).optional(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UpdateFTModelIn$ { - /** @deprecated use `UpdateFTModelIn$inboundSchema` instead. */ - export const inboundSchema = UpdateFTModelIn$inboundSchema; - /** @deprecated use `UpdateFTModelIn$outboundSchema` instead. */ - export const outboundSchema = UpdateFTModelIn$outboundSchema; - /** @deprecated use `UpdateFTModelIn$Outbound` instead. */ - export type Outbound = UpdateFTModelIn$Outbound; -} - -export function updateFTModelInToJSON( - updateFTModelIn: UpdateFTModelIn, -): string { - return JSON.stringify(UpdateFTModelIn$outboundSchema.parse(updateFTModelIn)); -} - -export function updateFTModelInFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UpdateFTModelIn$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UpdateFTModelIn' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/uploadfileout.ts b/examples/sdks/mistral-typescript/src/models/components/uploadfileout.ts deleted file mode 100644 index 2270be67d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/uploadfileout.ts +++ /dev/null @@ -1,147 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - FilePurpose, - FilePurpose$inboundSchema, - FilePurpose$outboundSchema, -} from "./filepurpose.js"; -import { - SampleType, - SampleType$inboundSchema, - SampleType$outboundSchema, -} from "./sampletype.js"; -import { - Source, - Source$inboundSchema, - Source$outboundSchema, -} from "./source.js"; - -export type UploadFileOut = { - /** - * The unique identifier of the file. - */ - id: string; - /** - * The object type, which is always "file". - */ - object: string; - /** - * The size of the file, in bytes. - */ - sizeBytes: number; - /** - * The UNIX timestamp (in seconds) of the event. - */ - createdAt: number; - /** - * The name of the uploaded file. - */ - filename: string; - purpose: FilePurpose; - sampleType: SampleType; - numLines?: number | null | undefined; - mimetype?: string | null | undefined; - source: Source; - signature?: string | null | undefined; -}; - -/** @internal */ -export const UploadFileOut$inboundSchema: z.ZodType< - UploadFileOut, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - object: z.string(), - bytes: z.number().int(), - created_at: z.number().int(), - filename: z.string(), - purpose: FilePurpose$inboundSchema, - sample_type: SampleType$inboundSchema, - num_lines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$inboundSchema, - signature: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "bytes": "sizeBytes", - "created_at": "createdAt", - "sample_type": "sampleType", - "num_lines": "numLines", - }); -}); - -/** @internal */ -export type UploadFileOut$Outbound = { - id: string; - object: string; - bytes: number; - created_at: number; - filename: string; - purpose: string; - sample_type: string; - num_lines?: number | null | undefined; - mimetype?: string | null | undefined; - source: string; - signature?: string | null | undefined; -}; - -/** @internal */ -export const UploadFileOut$outboundSchema: z.ZodType< - UploadFileOut$Outbound, - z.ZodTypeDef, - UploadFileOut -> = z.object({ - id: z.string(), - object: z.string(), - sizeBytes: z.number().int(), - createdAt: z.number().int(), - filename: z.string(), - purpose: FilePurpose$outboundSchema, - sampleType: SampleType$outboundSchema, - numLines: z.nullable(z.number().int()).optional(), - mimetype: z.nullable(z.string()).optional(), - source: Source$outboundSchema, - signature: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - sizeBytes: "bytes", - createdAt: "created_at", - sampleType: "sample_type", - numLines: "num_lines", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UploadFileOut$ { - /** @deprecated use `UploadFileOut$inboundSchema` instead. */ - export const inboundSchema = UploadFileOut$inboundSchema; - /** @deprecated use `UploadFileOut$outboundSchema` instead. */ - export const outboundSchema = UploadFileOut$outboundSchema; - /** @deprecated use `UploadFileOut$Outbound` instead. */ - export type Outbound = UploadFileOut$Outbound; -} - -export function uploadFileOutToJSON(uploadFileOut: UploadFileOut): string { - return JSON.stringify(UploadFileOut$outboundSchema.parse(uploadFileOut)); -} - -export function uploadFileOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UploadFileOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UploadFileOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/usageinfo.ts b/examples/sdks/mistral-typescript/src/models/components/usageinfo.ts deleted file mode 100644 index 021789d11..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/usageinfo.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - collectExtraKeys as collectExtraKeys$, - safeParse, -} from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type UsageInfo = { - promptTokens?: number | undefined; - completionTokens?: number | undefined; - totalTokens?: number | undefined; - promptAudioSeconds?: number | null | undefined; - additionalProperties?: { [k: string]: any }; -}; - -/** @internal */ -export const UsageInfo$inboundSchema: z.ZodType< - UsageInfo, - z.ZodTypeDef, - unknown -> = collectExtraKeys$( - z.object({ - prompt_tokens: z.number().int().default(0), - completion_tokens: z.number().int().default(0), - total_tokens: z.number().int().default(0), - prompt_audio_seconds: z.nullable(z.number().int()).optional(), - }).catchall(z.any()), - "additionalProperties", - true, -).transform((v) => { - return remap$(v, { - "prompt_tokens": "promptTokens", - "completion_tokens": "completionTokens", - "total_tokens": "totalTokens", - "prompt_audio_seconds": "promptAudioSeconds", - }); -}); - -/** @internal */ -export type UsageInfo$Outbound = { - prompt_tokens: number; - completion_tokens: number; - total_tokens: number; - prompt_audio_seconds?: number | null | undefined; - [additionalProperties: string]: unknown; -}; - -/** @internal */ -export const UsageInfo$outboundSchema: z.ZodType< - UsageInfo$Outbound, - z.ZodTypeDef, - UsageInfo -> = z.object({ - promptTokens: z.number().int().default(0), - completionTokens: z.number().int().default(0), - totalTokens: z.number().int().default(0), - promptAudioSeconds: z.nullable(z.number().int()).optional(), - additionalProperties: z.record(z.any()), -}).transform((v) => { - return { - ...v.additionalProperties, - ...remap$(v, { - promptTokens: "prompt_tokens", - completionTokens: "completion_tokens", - totalTokens: "total_tokens", - promptAudioSeconds: "prompt_audio_seconds", - additionalProperties: null, - }), - }; -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UsageInfo$ { - /** @deprecated use `UsageInfo$inboundSchema` instead. */ - export const inboundSchema = UsageInfo$inboundSchema; - /** @deprecated use `UsageInfo$outboundSchema` instead. */ - export const outboundSchema = UsageInfo$outboundSchema; - /** @deprecated use `UsageInfo$Outbound` instead. */ - export type Outbound = UsageInfo$Outbound; -} - -export function usageInfoToJSON(usageInfo: UsageInfo): string { - return JSON.stringify(UsageInfo$outboundSchema.parse(usageInfo)); -} - -export function usageInfoFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UsageInfo$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UsageInfo' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/usermessage.ts b/examples/sdks/mistral-typescript/src/models/components/usermessage.ts deleted file mode 100644 index e74a20d70..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/usermessage.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - ContentChunk, - ContentChunk$inboundSchema, - ContentChunk$Outbound, - ContentChunk$outboundSchema, -} from "./contentchunk.js"; - -export type UserMessageContent = string | Array; - -export const UserMessageRole = { - User: "user", -} as const; -export type UserMessageRole = ClosedEnum; - -export type UserMessage = { - content: string | Array | null; - role?: UserMessageRole | undefined; -}; - -/** @internal */ -export const UserMessageContent$inboundSchema: z.ZodType< - UserMessageContent, - z.ZodTypeDef, - unknown -> = z.union([z.string(), z.array(ContentChunk$inboundSchema)]); - -/** @internal */ -export type UserMessageContent$Outbound = string | Array; - -/** @internal */ -export const UserMessageContent$outboundSchema: z.ZodType< - UserMessageContent$Outbound, - z.ZodTypeDef, - UserMessageContent -> = z.union([z.string(), z.array(ContentChunk$outboundSchema)]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageContent$ { - /** @deprecated use `UserMessageContent$inboundSchema` instead. */ - export const inboundSchema = UserMessageContent$inboundSchema; - /** @deprecated use `UserMessageContent$outboundSchema` instead. */ - export const outboundSchema = UserMessageContent$outboundSchema; - /** @deprecated use `UserMessageContent$Outbound` instead. */ - export type Outbound = UserMessageContent$Outbound; -} - -export function userMessageContentToJSON( - userMessageContent: UserMessageContent, -): string { - return JSON.stringify( - UserMessageContent$outboundSchema.parse(userMessageContent), - ); -} - -export function userMessageContentFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessageContent$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessageContent' from JSON`, - ); -} - -/** @internal */ -export const UserMessageRole$inboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = z.nativeEnum(UserMessageRole); - -/** @internal */ -export const UserMessageRole$outboundSchema: z.ZodNativeEnum< - typeof UserMessageRole -> = UserMessageRole$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessageRole$ { - /** @deprecated use `UserMessageRole$inboundSchema` instead. */ - export const inboundSchema = UserMessageRole$inboundSchema; - /** @deprecated use `UserMessageRole$outboundSchema` instead. */ - export const outboundSchema = UserMessageRole$outboundSchema; -} - -/** @internal */ -export const UserMessage$inboundSchema: z.ZodType< - UserMessage, - z.ZodTypeDef, - unknown -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$inboundSchema)]), - ), - role: UserMessageRole$inboundSchema.default("user"), -}); - -/** @internal */ -export type UserMessage$Outbound = { - content: string | Array | null; - role: string; -}; - -/** @internal */ -export const UserMessage$outboundSchema: z.ZodType< - UserMessage$Outbound, - z.ZodTypeDef, - UserMessage -> = z.object({ - content: z.nullable( - z.union([z.string(), z.array(ContentChunk$outboundSchema)]), - ), - role: UserMessageRole$outboundSchema.default("user"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UserMessage$ { - /** @deprecated use `UserMessage$inboundSchema` instead. */ - export const inboundSchema = UserMessage$inboundSchema; - /** @deprecated use `UserMessage$outboundSchema` instead. */ - export const outboundSchema = UserMessage$outboundSchema; - /** @deprecated use `UserMessage$Outbound` instead. */ - export type Outbound = UserMessage$Outbound; -} - -export function userMessageToJSON(userMessage: UserMessage): string { - return JSON.stringify(UserMessage$outboundSchema.parse(userMessage)); -} - -export function userMessageFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => UserMessage$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'UserMessage' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/validationerror.ts b/examples/sdks/mistral-typescript/src/models/components/validationerror.ts deleted file mode 100644 index 9072a892d..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/validationerror.ts +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type Loc = string | number; - -export type ValidationError = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const Loc$inboundSchema: z.ZodType = z.union( - [z.string(), z.number().int()], -); - -/** @internal */ -export type Loc$Outbound = string | number; - -/** @internal */ -export const Loc$outboundSchema: z.ZodType = z - .union([z.string(), z.number().int()]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Loc$ { - /** @deprecated use `Loc$inboundSchema` instead. */ - export const inboundSchema = Loc$inboundSchema; - /** @deprecated use `Loc$outboundSchema` instead. */ - export const outboundSchema = Loc$outboundSchema; - /** @deprecated use `Loc$Outbound` instead. */ - export type Outbound = Loc$Outbound; -} - -export function locToJSON(loc: Loc): string { - return JSON.stringify(Loc$outboundSchema.parse(loc)); -} - -export function locFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => Loc$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'Loc' from JSON`, - ); -} - -/** @internal */ -export const ValidationError$inboundSchema: z.ZodType< - ValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** @internal */ -export type ValidationError$Outbound = { - loc: Array; - msg: string; - type: string; -}; - -/** @internal */ -export const ValidationError$outboundSchema: z.ZodType< - ValidationError$Outbound, - z.ZodTypeDef, - ValidationError -> = z.object({ - loc: z.array(z.union([z.string(), z.number().int()])), - msg: z.string(), - type: z.string(), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ValidationError$ { - /** @deprecated use `ValidationError$inboundSchema` instead. */ - export const inboundSchema = ValidationError$inboundSchema; - /** @deprecated use `ValidationError$outboundSchema` instead. */ - export const outboundSchema = ValidationError$outboundSchema; - /** @deprecated use `ValidationError$Outbound` instead. */ - export type Outbound = ValidationError$Outbound; -} - -export function validationErrorToJSON( - validationError: ValidationError, -): string { - return JSON.stringify(ValidationError$outboundSchema.parse(validationError)); -} - -export function validationErrorFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ValidationError$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ValidationError' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/wandbintegration.ts b/examples/sdks/mistral-typescript/src/models/components/wandbintegration.ts deleted file mode 100644 index 958b65448..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/wandbintegration.ts +++ /dev/null @@ -1,129 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const WandbIntegrationType = { - Wandb: "wandb", -} as const; -export type WandbIntegrationType = ClosedEnum; - -export type WandbIntegration = { - type?: WandbIntegrationType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - /** - * The WandB API key to use for authentication. - */ - apiKey: string; - runName?: string | null | undefined; -}; - -/** @internal */ -export const WandbIntegrationType$inboundSchema: z.ZodNativeEnum< - typeof WandbIntegrationType -> = z.nativeEnum(WandbIntegrationType); - -/** @internal */ -export const WandbIntegrationType$outboundSchema: z.ZodNativeEnum< - typeof WandbIntegrationType -> = WandbIntegrationType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WandbIntegrationType$ { - /** @deprecated use `WandbIntegrationType$inboundSchema` instead. */ - export const inboundSchema = WandbIntegrationType$inboundSchema; - /** @deprecated use `WandbIntegrationType$outboundSchema` instead. */ - export const outboundSchema = WandbIntegrationType$outboundSchema; -} - -/** @internal */ -export const WandbIntegration$inboundSchema: z.ZodType< - WandbIntegration, - z.ZodTypeDef, - unknown -> = z.object({ - type: WandbIntegrationType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - api_key: z.string(), - run_name: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "api_key": "apiKey", - "run_name": "runName", - }); -}); - -/** @internal */ -export type WandbIntegration$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - api_key: string; - run_name?: string | null | undefined; -}; - -/** @internal */ -export const WandbIntegration$outboundSchema: z.ZodType< - WandbIntegration$Outbound, - z.ZodTypeDef, - WandbIntegration -> = z.object({ - type: WandbIntegrationType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - apiKey: z.string(), - runName: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - apiKey: "api_key", - runName: "run_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WandbIntegration$ { - /** @deprecated use `WandbIntegration$inboundSchema` instead. */ - export const inboundSchema = WandbIntegration$inboundSchema; - /** @deprecated use `WandbIntegration$outboundSchema` instead. */ - export const outboundSchema = WandbIntegration$outboundSchema; - /** @deprecated use `WandbIntegration$Outbound` instead. */ - export type Outbound = WandbIntegration$Outbound; -} - -export function wandbIntegrationToJSON( - wandbIntegration: WandbIntegration, -): string { - return JSON.stringify( - WandbIntegration$outboundSchema.parse(wandbIntegration), - ); -} - -export function wandbIntegrationFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => WandbIntegration$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'WandbIntegration' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/wandbintegrationout.ts b/examples/sdks/mistral-typescript/src/models/components/wandbintegrationout.ts deleted file mode 100644 index ecfdb1c88..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/wandbintegrationout.ts +++ /dev/null @@ -1,126 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const WandbIntegrationOutType = { - Wandb: "wandb", -} as const; -export type WandbIntegrationOutType = ClosedEnum< - typeof WandbIntegrationOutType ->; - -export type WandbIntegrationOut = { - type?: WandbIntegrationOutType | undefined; - /** - * The name of the project that the new run will be created under. - */ - project: string; - /** - * A display name to set for the run. If not set, will use the job ID as the name. - */ - name?: string | null | undefined; - runName?: string | null | undefined; - url?: string | null | undefined; -}; - -/** @internal */ -export const WandbIntegrationOutType$inboundSchema: z.ZodNativeEnum< - typeof WandbIntegrationOutType -> = z.nativeEnum(WandbIntegrationOutType); - -/** @internal */ -export const WandbIntegrationOutType$outboundSchema: z.ZodNativeEnum< - typeof WandbIntegrationOutType -> = WandbIntegrationOutType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WandbIntegrationOutType$ { - /** @deprecated use `WandbIntegrationOutType$inboundSchema` instead. */ - export const inboundSchema = WandbIntegrationOutType$inboundSchema; - /** @deprecated use `WandbIntegrationOutType$outboundSchema` instead. */ - export const outboundSchema = WandbIntegrationOutType$outboundSchema; -} - -/** @internal */ -export const WandbIntegrationOut$inboundSchema: z.ZodType< - WandbIntegrationOut, - z.ZodTypeDef, - unknown -> = z.object({ - type: WandbIntegrationOutType$inboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - run_name: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - "run_name": "runName", - }); -}); - -/** @internal */ -export type WandbIntegrationOut$Outbound = { - type: string; - project: string; - name?: string | null | undefined; - run_name?: string | null | undefined; - url?: string | null | undefined; -}; - -/** @internal */ -export const WandbIntegrationOut$outboundSchema: z.ZodType< - WandbIntegrationOut$Outbound, - z.ZodTypeDef, - WandbIntegrationOut -> = z.object({ - type: WandbIntegrationOutType$outboundSchema.default("wandb"), - project: z.string(), - name: z.nullable(z.string()).optional(), - runName: z.nullable(z.string()).optional(), - url: z.nullable(z.string()).optional(), -}).transform((v) => { - return remap$(v, { - runName: "run_name", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WandbIntegrationOut$ { - /** @deprecated use `WandbIntegrationOut$inboundSchema` instead. */ - export const inboundSchema = WandbIntegrationOut$inboundSchema; - /** @deprecated use `WandbIntegrationOut$outboundSchema` instead. */ - export const outboundSchema = WandbIntegrationOut$outboundSchema; - /** @deprecated use `WandbIntegrationOut$Outbound` instead. */ - export type Outbound = WandbIntegrationOut$Outbound; -} - -export function wandbIntegrationOutToJSON( - wandbIntegrationOut: WandbIntegrationOut, -): string { - return JSON.stringify( - WandbIntegrationOut$outboundSchema.parse(wandbIntegrationOut), - ); -} - -export function wandbIntegrationOutFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => WandbIntegrationOut$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'WandbIntegrationOut' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/websearchpremiumtool.ts b/examples/sdks/mistral-typescript/src/models/components/websearchpremiumtool.ts deleted file mode 100644 index d5c8f1baa..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/websearchpremiumtool.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const WebSearchPremiumToolType = { - WebSearchPremium: "web_search_premium", -} as const; -export type WebSearchPremiumToolType = ClosedEnum< - typeof WebSearchPremiumToolType ->; - -export type WebSearchPremiumTool = { - type?: WebSearchPremiumToolType | undefined; -}; - -/** @internal */ -export const WebSearchPremiumToolType$inboundSchema: z.ZodNativeEnum< - typeof WebSearchPremiumToolType -> = z.nativeEnum(WebSearchPremiumToolType); - -/** @internal */ -export const WebSearchPremiumToolType$outboundSchema: z.ZodNativeEnum< - typeof WebSearchPremiumToolType -> = WebSearchPremiumToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebSearchPremiumToolType$ { - /** @deprecated use `WebSearchPremiumToolType$inboundSchema` instead. */ - export const inboundSchema = WebSearchPremiumToolType$inboundSchema; - /** @deprecated use `WebSearchPremiumToolType$outboundSchema` instead. */ - export const outboundSchema = WebSearchPremiumToolType$outboundSchema; -} - -/** @internal */ -export const WebSearchPremiumTool$inboundSchema: z.ZodType< - WebSearchPremiumTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: WebSearchPremiumToolType$inboundSchema.default("web_search_premium"), -}); - -/** @internal */ -export type WebSearchPremiumTool$Outbound = { - type: string; -}; - -/** @internal */ -export const WebSearchPremiumTool$outboundSchema: z.ZodType< - WebSearchPremiumTool$Outbound, - z.ZodTypeDef, - WebSearchPremiumTool -> = z.object({ - type: WebSearchPremiumToolType$outboundSchema.default("web_search_premium"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebSearchPremiumTool$ { - /** @deprecated use `WebSearchPremiumTool$inboundSchema` instead. */ - export const inboundSchema = WebSearchPremiumTool$inboundSchema; - /** @deprecated use `WebSearchPremiumTool$outboundSchema` instead. */ - export const outboundSchema = WebSearchPremiumTool$outboundSchema; - /** @deprecated use `WebSearchPremiumTool$Outbound` instead. */ - export type Outbound = WebSearchPremiumTool$Outbound; -} - -export function webSearchPremiumToolToJSON( - webSearchPremiumTool: WebSearchPremiumTool, -): string { - return JSON.stringify( - WebSearchPremiumTool$outboundSchema.parse(webSearchPremiumTool), - ); -} - -export function webSearchPremiumToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => WebSearchPremiumTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'WebSearchPremiumTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/components/websearchtool.ts b/examples/sdks/mistral-typescript/src/models/components/websearchtool.ts deleted file mode 100644 index 4fdd46de6..000000000 --- a/examples/sdks/mistral-typescript/src/models/components/websearchtool.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export const WebSearchToolType = { - WebSearch: "web_search", -} as const; -export type WebSearchToolType = ClosedEnum; - -export type WebSearchTool = { - type?: WebSearchToolType | undefined; -}; - -/** @internal */ -export const WebSearchToolType$inboundSchema: z.ZodNativeEnum< - typeof WebSearchToolType -> = z.nativeEnum(WebSearchToolType); - -/** @internal */ -export const WebSearchToolType$outboundSchema: z.ZodNativeEnum< - typeof WebSearchToolType -> = WebSearchToolType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebSearchToolType$ { - /** @deprecated use `WebSearchToolType$inboundSchema` instead. */ - export const inboundSchema = WebSearchToolType$inboundSchema; - /** @deprecated use `WebSearchToolType$outboundSchema` instead. */ - export const outboundSchema = WebSearchToolType$outboundSchema; -} - -/** @internal */ -export const WebSearchTool$inboundSchema: z.ZodType< - WebSearchTool, - z.ZodTypeDef, - unknown -> = z.object({ - type: WebSearchToolType$inboundSchema.default("web_search"), -}); - -/** @internal */ -export type WebSearchTool$Outbound = { - type: string; -}; - -/** @internal */ -export const WebSearchTool$outboundSchema: z.ZodType< - WebSearchTool$Outbound, - z.ZodTypeDef, - WebSearchTool -> = z.object({ - type: WebSearchToolType$outboundSchema.default("web_search"), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebSearchTool$ { - /** @deprecated use `WebSearchTool$inboundSchema` instead. */ - export const inboundSchema = WebSearchTool$inboundSchema; - /** @deprecated use `WebSearchTool$outboundSchema` instead. */ - export const outboundSchema = WebSearchTool$outboundSchema; - /** @deprecated use `WebSearchTool$Outbound` instead. */ - export type Outbound = WebSearchTool$Outbound; -} - -export function webSearchToolToJSON(webSearchTool: WebSearchTool): string { - return JSON.stringify(WebSearchTool$outboundSchema.parse(webSearchTool)); -} - -export function webSearchToolFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => WebSearchTool$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'WebSearchTool' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/httpclienterrors.ts b/examples/sdks/mistral-typescript/src/models/errors/httpclienterrors.ts deleted file mode 100644 index b34f61212..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/httpclienterrors.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * Base class for all HTTP errors. - */ -export class HTTPClientError extends Error { - /** The underlying cause of the error. */ - override readonly cause: unknown; - override name = "HTTPClientError"; - constructor(message: string, opts?: { cause?: unknown }) { - let msg = message; - if (opts?.cause) { - msg += `: ${opts.cause}`; - } - - super(msg, opts); - // In older runtimes, the cause field would not have been assigned through - // the super() call. - if (typeof this.cause === "undefined") { - this.cause = opts?.cause; - } - } -} - -/** - * An error to capture unrecognised or unexpected errors when making HTTP calls. - */ -export class UnexpectedClientError extends HTTPClientError { - override name = "UnexpectedClientError"; -} - -/** - * An error that is raised when any inputs used to create a request are invalid. - */ -export class InvalidRequestError extends HTTPClientError { - override name = "InvalidRequestError"; -} - -/** - * An error that is raised when a HTTP request was aborted by the client error. - */ -export class RequestAbortedError extends HTTPClientError { - override readonly name = "RequestAbortedError"; -} - -/** - * An error that is raised when a HTTP request timed out due to an AbortSignal - * signal timeout. - */ -export class RequestTimeoutError extends HTTPClientError { - override readonly name = "RequestTimeoutError"; -} - -/** - * An error that is raised when a HTTP client is unable to make a request to - * a server. - */ -export class ConnectionError extends HTTPClientError { - override readonly name = "ConnectionError"; -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/httpvalidationerror.ts b/examples/sdks/mistral-typescript/src/models/errors/httpvalidationerror.ts deleted file mode 100644 index 47ccad96a..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/httpvalidationerror.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import * as components from "../components/index.js"; -import { MistralError } from "./mistralerror.js"; - -export type HTTPValidationErrorData = { - detail?: Array | undefined; -}; - -export class HTTPValidationError extends MistralError { - detail?: Array | undefined; - - /** The original data that was passed to this error instance. */ - data$: HTTPValidationErrorData; - - constructor( - err: HTTPValidationErrorData, - httpMeta: { response: Response; request: Request; body: string }, - ) { - const message = "message" in err && typeof err.message === "string" - ? err.message - : `API error occurred: ${JSON.stringify(err)}`; - super(message, httpMeta); - this.data$ = err; - if (err.detail != null) this.detail = err.detail; - - this.name = "HTTPValidationError"; - } -} - -/** @internal */ -export const HTTPValidationError$inboundSchema: z.ZodType< - HTTPValidationError, - z.ZodTypeDef, - unknown -> = z.object({ - detail: z.array(components.ValidationError$inboundSchema).optional(), - request$: z.instanceof(Request), - response$: z.instanceof(Response), - body$: z.string(), -}) - .transform((v) => { - return new HTTPValidationError(v, { - request: v.request$, - response: v.response$, - body: v.body$, - }); - }); - -/** @internal */ -export type HTTPValidationError$Outbound = { - detail?: Array | undefined; -}; - -/** @internal */ -export const HTTPValidationError$outboundSchema: z.ZodType< - HTTPValidationError$Outbound, - z.ZodTypeDef, - HTTPValidationError -> = z.instanceof(HTTPValidationError) - .transform(v => v.data$) - .pipe(z.object({ - detail: z.array(components.ValidationError$outboundSchema).optional(), - })); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace HTTPValidationError$ { - /** @deprecated use `HTTPValidationError$inboundSchema` instead. */ - export const inboundSchema = HTTPValidationError$inboundSchema; - /** @deprecated use `HTTPValidationError$outboundSchema` instead. */ - export const outboundSchema = HTTPValidationError$outboundSchema; - /** @deprecated use `HTTPValidationError$Outbound` instead. */ - export type Outbound = HTTPValidationError$Outbound; -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/index.ts b/examples/sdks/mistral-typescript/src/models/errors/index.ts deleted file mode 100644 index 8692ad301..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/index.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./httpclienterrors.js"; -export * from "./httpvalidationerror.js"; -export * from "./responsevalidationerror.js"; -export * from "./sdkerror.js"; -export * from "./sdkvalidationerror.js"; diff --git a/examples/sdks/mistral-typescript/src/models/errors/mistralerror.ts b/examples/sdks/mistral-typescript/src/models/errors/mistralerror.ts deleted file mode 100644 index 79bf54066..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/mistralerror.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** The base class for all HTTP error responses */ -export class MistralError extends Error { - /** HTTP status code */ - public readonly statusCode: number; - /** HTTP body */ - public readonly body: string; - /** HTTP headers */ - public readonly headers: Headers; - /** HTTP content type */ - public readonly contentType: string; - /** Raw response */ - public readonly rawResponse: Response; - - constructor( - message: string, - httpMeta: { - response: Response; - request: Request; - body: string; - }, - ) { - super(message); - this.statusCode = httpMeta.response.status; - this.body = httpMeta.body; - this.headers = httpMeta.response.headers; - this.contentType = httpMeta.response.headers.get("content-type") || ""; - this.rawResponse = httpMeta.response; - - this.name = "MistralError"; - } -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/responsevalidationerror.ts b/examples/sdks/mistral-typescript/src/models/errors/responsevalidationerror.ts deleted file mode 100644 index b10ba7403..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/responsevalidationerror.ts +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { MistralError } from "./mistralerror.js"; -import { formatZodError } from "./sdkvalidationerror.js"; - -export class ResponseValidationError extends MistralError { - /** - * The raw value that failed validation. - */ - public readonly rawValue: unknown; - - /** - * The raw message that failed validation. - */ - public readonly rawMessage: unknown; - - constructor( - message: string, - extra: { - response: Response; - request: Request; - body: string; - cause: unknown; - rawValue: unknown; - rawMessage: unknown; - }, - ) { - super(message, extra); - this.name = "ResponseValidationError"; - this.cause = extra.cause; - this.rawValue = extra.rawValue; - this.rawMessage = extra.rawMessage; - } - - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - public pretty(): string { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage}\n${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/sdkerror.ts b/examples/sdks/mistral-typescript/src/models/errors/sdkerror.ts deleted file mode 100644 index fb3825c77..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/sdkerror.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { MistralError } from "./mistralerror.js"; - -/** The fallback error class if no more specific error class is matched */ -export class SDKError extends MistralError { - constructor( - message: string, - httpMeta: { - response: Response; - request: Request; - body: string; - }, - ) { - if (message) { - message += `: `; - } - message += `Status ${httpMeta.response.status}`; - const contentType = httpMeta.response.headers.get("content-type") || `""`; - if (contentType !== "application/json") { - message += ` Content-Type ${ - contentType.includes(" ") ? `"${contentType}"` : contentType - }`; - } - const body = httpMeta.body || `""`; - message += body.length > 100 ? "\n" : ". "; - let bodyDisplay = body; - if (body.length > 10000) { - const truncated = body.substring(0, 10000); - const remaining = body.length - 10000; - bodyDisplay = `${truncated}...and ${remaining} more chars`; - } - message += `Body: ${bodyDisplay}`; - message = message.trim(); - super(message, httpMeta); - this.name = "SDKError"; - } -} diff --git a/examples/sdks/mistral-typescript/src/models/errors/sdkvalidationerror.ts b/examples/sdks/mistral-typescript/src/models/errors/sdkvalidationerror.ts deleted file mode 100644 index 37face8ae..000000000 --- a/examples/sdks/mistral-typescript/src/models/errors/sdkvalidationerror.ts +++ /dev/null @@ -1,109 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export class SDKValidationError extends Error { - /** - * The raw value that failed validation. - */ - public readonly rawValue: unknown; - - /** - * The raw message that failed validation. - */ - public readonly rawMessage: unknown; - - // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError` - static override [Symbol.hasInstance]( - instance: unknown, - ): instance is SDKValidationError { - if (!(instance instanceof Error)) return false; - if (!("rawValue" in instance)) return false; - if (!("rawMessage" in instance)) return false; - if (!("pretty" in instance)) return false; - if (typeof instance.pretty !== "function") return false; - return true; - } - - constructor(message: string, cause: unknown, rawValue: unknown) { - super(`${message}: ${cause}`); - this.name = "SDKValidationError"; - this.cause = cause; - this.rawValue = rawValue; - this.rawMessage = message; - } - - /** - * Return a pretty-formatted error message if the underlying validation error - * is a ZodError or some other recognized error type, otherwise return the - * default error message. - */ - public pretty(): string { - if (this.cause instanceof z.ZodError) { - return `${this.rawMessage}\n${formatZodError(this.cause)}`; - } else { - return this.toString(); - } - } -} - -export function formatZodError(err: z.ZodError, level = 0): string { - let pre = " ".repeat(level); - pre = level > 0 ? `│${pre}` : pre; - pre += " ".repeat(level); - - let message = ""; - const append = (str: string) => (message += `\n${pre}${str}`); - - const len = err.issues.length; - const headline = len === 1 ? `${len} issue found` : `${len} issues found`; - - if (len) { - append(`┌ ${headline}:`); - } - - for (const issue of err.issues) { - let path = issue.path.join("."); - path = path ? `.${path}` : ""; - append(`│ • [${path}]: ${issue.message} (${issue.code})`); - switch (issue.code) { - case "invalid_literal": - case "invalid_type": { - append(`│ Want: ${issue.expected}`); - append(`│ Got: ${issue.received}`); - break; - } - case "unrecognized_keys": { - append(`│ Keys: ${issue.keys.join(", ")}`); - break; - } - case "invalid_enum_value": { - append(`│ Allowed: ${issue.options.join(", ")}`); - append(`│ Got: ${issue.received}`); - break; - } - case "invalid_union_discriminator": { - append(`│ Allowed: ${issue.options.join(", ")}`); - break; - } - case "invalid_union": { - const len = issue.unionErrors.length; - append( - `│ ✖︎ Attemped to deserialize into one of ${len} union members:`, - ); - issue.unionErrors.forEach((err, i) => { - append(`│ ✖︎ Member ${i + 1} of ${len}`); - append(`${formatZodError(err, level + 1)}`); - }); - } - } - } - - if (err.issues.length) { - append(`└─*`); - } - - return message.slice(1); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsget.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsget.ts deleted file mode 100644 index abdd92232..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsget.ts +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1AgentsGetRequest = { - agentId: string; -}; - -/** @internal */ -export const AgentsApiV1AgentsGetRequest$inboundSchema: z.ZodType< - AgentsApiV1AgentsGetRequest, - z.ZodTypeDef, - unknown -> = z.object({ - agent_id: z.string(), -}).transform((v) => { - return remap$(v, { - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type AgentsApiV1AgentsGetRequest$Outbound = { - agent_id: string; -}; - -/** @internal */ -export const AgentsApiV1AgentsGetRequest$outboundSchema: z.ZodType< - AgentsApiV1AgentsGetRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1AgentsGetRequest -> = z.object({ - agentId: z.string(), -}).transform((v) => { - return remap$(v, { - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1AgentsGetRequest$ { - /** @deprecated use `AgentsApiV1AgentsGetRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsApiV1AgentsGetRequest$inboundSchema; - /** @deprecated use `AgentsApiV1AgentsGetRequest$outboundSchema` instead. */ - export const outboundSchema = AgentsApiV1AgentsGetRequest$outboundSchema; - /** @deprecated use `AgentsApiV1AgentsGetRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1AgentsGetRequest$Outbound; -} - -export function agentsApiV1AgentsGetRequestToJSON( - agentsApiV1AgentsGetRequest: AgentsApiV1AgentsGetRequest, -): string { - return JSON.stringify( - AgentsApiV1AgentsGetRequest$outboundSchema.parse( - agentsApiV1AgentsGetRequest, - ), - ); -} - -export function agentsApiV1AgentsGetRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsApiV1AgentsGetRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1AgentsGetRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentslist.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentslist.ts deleted file mode 100644 index f23493701..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentslist.ts +++ /dev/null @@ -1,81 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1AgentsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -/** @internal */ -export const AgentsApiV1AgentsListRequest$inboundSchema: z.ZodType< - AgentsApiV1AgentsListRequest, - z.ZodTypeDef, - unknown -> = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(20), -}).transform((v) => { - return remap$(v, { - "page_size": "pageSize", - }); -}); - -/** @internal */ -export type AgentsApiV1AgentsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -export const AgentsApiV1AgentsListRequest$outboundSchema: z.ZodType< - AgentsApiV1AgentsListRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1AgentsListRequest -> = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(20), -}).transform((v) => { - return remap$(v, { - pageSize: "page_size", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1AgentsListRequest$ { - /** @deprecated use `AgentsApiV1AgentsListRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsApiV1AgentsListRequest$inboundSchema; - /** @deprecated use `AgentsApiV1AgentsListRequest$outboundSchema` instead. */ - export const outboundSchema = AgentsApiV1AgentsListRequest$outboundSchema; - /** @deprecated use `AgentsApiV1AgentsListRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1AgentsListRequest$Outbound; -} - -export function agentsApiV1AgentsListRequestToJSON( - agentsApiV1AgentsListRequest: AgentsApiV1AgentsListRequest, -): string { - return JSON.stringify( - AgentsApiV1AgentsListRequest$outboundSchema.parse( - agentsApiV1AgentsListRequest, - ), - ); -} - -export function agentsApiV1AgentsListRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsApiV1AgentsListRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1AgentsListRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdate.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdate.ts deleted file mode 100644 index f61ccbaa0..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdate.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1AgentsUpdateRequest = { - agentId: string; - agentUpdateRequest: components.AgentUpdateRequest; -}; - -/** @internal */ -export const AgentsApiV1AgentsUpdateRequest$inboundSchema: z.ZodType< - AgentsApiV1AgentsUpdateRequest, - z.ZodTypeDef, - unknown -> = z.object({ - agent_id: z.string(), - AgentUpdateRequest: components.AgentUpdateRequest$inboundSchema, -}).transform((v) => { - return remap$(v, { - "agent_id": "agentId", - "AgentUpdateRequest": "agentUpdateRequest", - }); -}); - -/** @internal */ -export type AgentsApiV1AgentsUpdateRequest$Outbound = { - agent_id: string; - AgentUpdateRequest: components.AgentUpdateRequest$Outbound; -}; - -/** @internal */ -export const AgentsApiV1AgentsUpdateRequest$outboundSchema: z.ZodType< - AgentsApiV1AgentsUpdateRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1AgentsUpdateRequest -> = z.object({ - agentId: z.string(), - agentUpdateRequest: components.AgentUpdateRequest$outboundSchema, -}).transform((v) => { - return remap$(v, { - agentId: "agent_id", - agentUpdateRequest: "AgentUpdateRequest", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1AgentsUpdateRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsApiV1AgentsUpdateRequest$inboundSchema; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$outboundSchema` instead. */ - export const outboundSchema = AgentsApiV1AgentsUpdateRequest$outboundSchema; - /** @deprecated use `AgentsApiV1AgentsUpdateRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1AgentsUpdateRequest$Outbound; -} - -export function agentsApiV1AgentsUpdateRequestToJSON( - agentsApiV1AgentsUpdateRequest: AgentsApiV1AgentsUpdateRequest, -): string { - return JSON.stringify( - AgentsApiV1AgentsUpdateRequest$outboundSchema.parse( - agentsApiV1AgentsUpdateRequest, - ), - ); -} - -export function agentsApiV1AgentsUpdateRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => AgentsApiV1AgentsUpdateRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1AgentsUpdateRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdateversion.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdateversion.ts deleted file mode 100644 index 8f4bf49b0..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1agentsupdateversion.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1AgentsUpdateVersionRequest = { - agentId: string; - version: number; -}; - -/** @internal */ -export const AgentsApiV1AgentsUpdateVersionRequest$inboundSchema: z.ZodType< - AgentsApiV1AgentsUpdateVersionRequest, - z.ZodTypeDef, - unknown -> = z.object({ - agent_id: z.string(), - version: z.number().int(), -}).transform((v) => { - return remap$(v, { - "agent_id": "agentId", - }); -}); - -/** @internal */ -export type AgentsApiV1AgentsUpdateVersionRequest$Outbound = { - agent_id: string; - version: number; -}; - -/** @internal */ -export const AgentsApiV1AgentsUpdateVersionRequest$outboundSchema: z.ZodType< - AgentsApiV1AgentsUpdateVersionRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1AgentsUpdateVersionRequest -> = z.object({ - agentId: z.string(), - version: z.number().int(), -}).transform((v) => { - return remap$(v, { - agentId: "agent_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1AgentsUpdateVersionRequest$ { - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1AgentsUpdateVersionRequest$inboundSchema; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1AgentsUpdateVersionRequest$outboundSchema; - /** @deprecated use `AgentsApiV1AgentsUpdateVersionRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1AgentsUpdateVersionRequest$Outbound; -} - -export function agentsApiV1AgentsUpdateVersionRequestToJSON( - agentsApiV1AgentsUpdateVersionRequest: AgentsApiV1AgentsUpdateVersionRequest, -): string { - return JSON.stringify( - AgentsApiV1AgentsUpdateVersionRequest$outboundSchema.parse( - agentsApiV1AgentsUpdateVersionRequest, - ), - ); -} - -export function agentsApiV1AgentsUpdateVersionRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1AgentsUpdateVersionRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1AgentsUpdateVersionRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappend.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappend.ts deleted file mode 100644 index 90e9711f8..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappend.ts +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsAppendRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendRequest: components.ConversationAppendRequest; -}; - -/** @internal */ -export const AgentsApiV1ConversationsAppendRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsAppendRequest, - z.ZodTypeDef, - unknown -> = z.object({ - conversation_id: z.string(), - ConversationAppendRequest: components.ConversationAppendRequest$inboundSchema, -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - "ConversationAppendRequest": "conversationAppendRequest", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsAppendRequest$Outbound = { - conversation_id: string; - ConversationAppendRequest: components.ConversationAppendRequest$Outbound; -}; - -/** @internal */ -export const AgentsApiV1ConversationsAppendRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsAppendRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsAppendRequest -> = z.object({ - conversationId: z.string(), - conversationAppendRequest: - components.ConversationAppendRequest$outboundSchema, -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - conversationAppendRequest: "ConversationAppendRequest", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsAppendRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsAppendRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsAppendRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsAppendRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsAppendRequest$Outbound; -} - -export function agentsApiV1ConversationsAppendRequestToJSON( - agentsApiV1ConversationsAppendRequest: AgentsApiV1ConversationsAppendRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsAppendRequest$outboundSchema.parse( - agentsApiV1ConversationsAppendRequest, - ), - ); -} - -export function agentsApiV1ConversationsAppendRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsAppendRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1ConversationsAppendRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappendstream.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappendstream.ts deleted file mode 100644 index fdacb7036..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsappendstream.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsAppendStreamRequest = { - /** - * ID of the conversation to which we append entries. - */ - conversationId: string; - conversationAppendStreamRequest: components.ConversationAppendStreamRequest; -}; - -/** @internal */ -export const AgentsApiV1ConversationsAppendStreamRequest$inboundSchema: - z.ZodType< - AgentsApiV1ConversationsAppendStreamRequest, - z.ZodTypeDef, - unknown - > = z.object({ - conversation_id: z.string(), - ConversationAppendStreamRequest: - components.ConversationAppendStreamRequest$inboundSchema, - }).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - "ConversationAppendStreamRequest": "conversationAppendStreamRequest", - }); - }); - -/** @internal */ -export type AgentsApiV1ConversationsAppendStreamRequest$Outbound = { - conversation_id: string; - ConversationAppendStreamRequest: - components.ConversationAppendStreamRequest$Outbound; -}; - -/** @internal */ -export const AgentsApiV1ConversationsAppendStreamRequest$outboundSchema: - z.ZodType< - AgentsApiV1ConversationsAppendStreamRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsAppendStreamRequest - > = z.object({ - conversationId: z.string(), - conversationAppendStreamRequest: - components.ConversationAppendStreamRequest$outboundSchema, - }).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - conversationAppendStreamRequest: "ConversationAppendStreamRequest", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsAppendStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsAppendStreamRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsAppendStreamRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsAppendStreamRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsAppendStreamRequest$Outbound; -} - -export function agentsApiV1ConversationsAppendStreamRequestToJSON( - agentsApiV1ConversationsAppendStreamRequest: - AgentsApiV1ConversationsAppendStreamRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsAppendStreamRequest$outboundSchema.parse( - agentsApiV1ConversationsAppendStreamRequest, - ), - ); -} - -export function agentsApiV1ConversationsAppendStreamRequestFromJSON( - jsonString: string, -): SafeParseResult< - AgentsApiV1ConversationsAppendStreamRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsAppendStreamRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AgentsApiV1ConversationsAppendStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsget.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsget.ts deleted file mode 100644 index 4c114c549..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsget.ts +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsGetRequest = { - /** - * ID of the conversation from which we are fetching metadata. - */ - conversationId: string; -}; - -/** - * Successful Response - */ -export type AgentsApiV1ConversationsGetResponseV1ConversationsGet = - | components.ModelConversation - | components.AgentConversation; - -/** @internal */ -export const AgentsApiV1ConversationsGetRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsGetRequest, - z.ZodTypeDef, - unknown -> = z.object({ - conversation_id: z.string(), -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsGetRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -export const AgentsApiV1ConversationsGetRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsGetRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsGetRequest -> = z.object({ - conversationId: z.string(), -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsGetRequest$ { - /** @deprecated use `AgentsApiV1ConversationsGetRequest$inboundSchema` instead. */ - export const inboundSchema = AgentsApiV1ConversationsGetRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsGetRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsGetRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsGetRequest$Outbound; -} - -export function agentsApiV1ConversationsGetRequestToJSON( - agentsApiV1ConversationsGetRequest: AgentsApiV1ConversationsGetRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsGetRequest$outboundSchema.parse( - agentsApiV1ConversationsGetRequest, - ), - ); -} - -export function agentsApiV1ConversationsGetRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsGetRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1ConversationsGetRequest' from JSON`, - ); -} - -/** @internal */ -export const AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema: - z.ZodType< - AgentsApiV1ConversationsGetResponseV1ConversationsGet, - z.ZodTypeDef, - unknown - > = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema, - ]); - -/** @internal */ -export type AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound = - | components.ModelConversation$Outbound - | components.AgentConversation$Outbound; - -/** @internal */ -export const AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema: - z.ZodType< - AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsGetResponseV1ConversationsGet - > = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema, - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsGetResponseV1ConversationsGet$ { - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound` instead. */ - export type Outbound = - AgentsApiV1ConversationsGetResponseV1ConversationsGet$Outbound; -} - -export function agentsApiV1ConversationsGetResponseV1ConversationsGetToJSON( - agentsApiV1ConversationsGetResponseV1ConversationsGet: - AgentsApiV1ConversationsGetResponseV1ConversationsGet, -): string { - return JSON.stringify( - AgentsApiV1ConversationsGetResponseV1ConversationsGet$outboundSchema.parse( - agentsApiV1ConversationsGetResponseV1ConversationsGet, - ), - ); -} - -export function agentsApiV1ConversationsGetResponseV1ConversationsGetFromJSON( - jsonString: string, -): SafeParseResult< - AgentsApiV1ConversationsGetResponseV1ConversationsGet, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsGetResponseV1ConversationsGet$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AgentsApiV1ConversationsGetResponseV1ConversationsGet' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationshistory.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationshistory.ts deleted file mode 100644 index 78f67ce62..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationshistory.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsHistoryRequest = { - /** - * ID of the conversation from which we are fetching entries. - */ - conversationId: string; -}; - -/** @internal */ -export const AgentsApiV1ConversationsHistoryRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsHistoryRequest, - z.ZodTypeDef, - unknown -> = z.object({ - conversation_id: z.string(), -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsHistoryRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -export const AgentsApiV1ConversationsHistoryRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsHistoryRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsHistoryRequest -> = z.object({ - conversationId: z.string(), -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsHistoryRequest$ { - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsHistoryRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsHistoryRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsHistoryRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsHistoryRequest$Outbound; -} - -export function agentsApiV1ConversationsHistoryRequestToJSON( - agentsApiV1ConversationsHistoryRequest: - AgentsApiV1ConversationsHistoryRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsHistoryRequest$outboundSchema.parse( - agentsApiV1ConversationsHistoryRequest, - ), - ); -} - -export function agentsApiV1ConversationsHistoryRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsHistoryRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1ConversationsHistoryRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationslist.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationslist.ts deleted file mode 100644 index 8f662a9ee..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationslist.ts +++ /dev/null @@ -1,141 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsListRequest = { - page?: number | undefined; - pageSize?: number | undefined; -}; - -export type ResponseBody = - | components.ModelConversation - | components.AgentConversation; - -/** @internal */ -export const AgentsApiV1ConversationsListRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsListRequest, - z.ZodTypeDef, - unknown -> = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), -}).transform((v) => { - return remap$(v, { - "page_size": "pageSize", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsListRequest$Outbound = { - page: number; - page_size: number; -}; - -/** @internal */ -export const AgentsApiV1ConversationsListRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsListRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsListRequest -> = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), -}).transform((v) => { - return remap$(v, { - pageSize: "page_size", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsListRequest$ { - /** @deprecated use `AgentsApiV1ConversationsListRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsListRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsListRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsListRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsListRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsListRequest$Outbound; -} - -export function agentsApiV1ConversationsListRequestToJSON( - agentsApiV1ConversationsListRequest: AgentsApiV1ConversationsListRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsListRequest$outboundSchema.parse( - agentsApiV1ConversationsListRequest, - ), - ); -} - -export function agentsApiV1ConversationsListRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsListRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1ConversationsListRequest' from JSON`, - ); -} - -/** @internal */ -export const ResponseBody$inboundSchema: z.ZodType< - ResponseBody, - z.ZodTypeDef, - unknown -> = z.union([ - components.ModelConversation$inboundSchema, - components.AgentConversation$inboundSchema, -]); - -/** @internal */ -export type ResponseBody$Outbound = - | components.ModelConversation$Outbound - | components.AgentConversation$Outbound; - -/** @internal */ -export const ResponseBody$outboundSchema: z.ZodType< - ResponseBody$Outbound, - z.ZodTypeDef, - ResponseBody -> = z.union([ - components.ModelConversation$outboundSchema, - components.AgentConversation$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ResponseBody$ { - /** @deprecated use `ResponseBody$inboundSchema` instead. */ - export const inboundSchema = ResponseBody$inboundSchema; - /** @deprecated use `ResponseBody$outboundSchema` instead. */ - export const outboundSchema = ResponseBody$outboundSchema; - /** @deprecated use `ResponseBody$Outbound` instead. */ - export type Outbound = ResponseBody$Outbound; -} - -export function responseBodyToJSON(responseBody: ResponseBody): string { - return JSON.stringify(ResponseBody$outboundSchema.parse(responseBody)); -} - -export function responseBodyFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseBody' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsmessages.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsmessages.ts deleted file mode 100644 index 19470b733..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsmessages.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsMessagesRequest = { - /** - * ID of the conversation from which we are fetching messages. - */ - conversationId: string; -}; - -/** @internal */ -export const AgentsApiV1ConversationsMessagesRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsMessagesRequest, - z.ZodTypeDef, - unknown -> = z.object({ - conversation_id: z.string(), -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsMessagesRequest$Outbound = { - conversation_id: string; -}; - -/** @internal */ -export const AgentsApiV1ConversationsMessagesRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsMessagesRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsMessagesRequest -> = z.object({ - conversationId: z.string(), -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsMessagesRequest$ { - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsMessagesRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsMessagesRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsMessagesRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsMessagesRequest$Outbound; -} - -export function agentsApiV1ConversationsMessagesRequestToJSON( - agentsApiV1ConversationsMessagesRequest: - AgentsApiV1ConversationsMessagesRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsMessagesRequest$outboundSchema.parse( - agentsApiV1ConversationsMessagesRequest, - ), - ); -} - -export function agentsApiV1ConversationsMessagesRequestFromJSON( - jsonString: string, -): SafeParseResult< - AgentsApiV1ConversationsMessagesRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsMessagesRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AgentsApiV1ConversationsMessagesRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestart.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestart.ts deleted file mode 100644 index 94685442a..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestart.ts +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsRestartRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartRequest: components.ConversationRestartRequest; -}; - -/** @internal */ -export const AgentsApiV1ConversationsRestartRequest$inboundSchema: z.ZodType< - AgentsApiV1ConversationsRestartRequest, - z.ZodTypeDef, - unknown -> = z.object({ - conversation_id: z.string(), - ConversationRestartRequest: - components.ConversationRestartRequest$inboundSchema, -}).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - "ConversationRestartRequest": "conversationRestartRequest", - }); -}); - -/** @internal */ -export type AgentsApiV1ConversationsRestartRequest$Outbound = { - conversation_id: string; - ConversationRestartRequest: components.ConversationRestartRequest$Outbound; -}; - -/** @internal */ -export const AgentsApiV1ConversationsRestartRequest$outboundSchema: z.ZodType< - AgentsApiV1ConversationsRestartRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsRestartRequest -> = z.object({ - conversationId: z.string(), - conversationRestartRequest: - components.ConversationRestartRequest$outboundSchema, -}).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - conversationRestartRequest: "ConversationRestartRequest", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsRestartRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsRestartRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsRestartRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsRestartRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsRestartRequest$Outbound; -} - -export function agentsApiV1ConversationsRestartRequestToJSON( - agentsApiV1ConversationsRestartRequest: - AgentsApiV1ConversationsRestartRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsRestartRequest$outboundSchema.parse( - agentsApiV1ConversationsRestartRequest, - ), - ); -} - -export function agentsApiV1ConversationsRestartRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsRestartRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'AgentsApiV1ConversationsRestartRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestartstream.ts b/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestartstream.ts deleted file mode 100644 index 962c98f2b..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/agentsapiv1conversationsrestartstream.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type AgentsApiV1ConversationsRestartStreamRequest = { - /** - * ID of the original conversation which is being restarted. - */ - conversationId: string; - conversationRestartStreamRequest: components.ConversationRestartStreamRequest; -}; - -/** @internal */ -export const AgentsApiV1ConversationsRestartStreamRequest$inboundSchema: - z.ZodType< - AgentsApiV1ConversationsRestartStreamRequest, - z.ZodTypeDef, - unknown - > = z.object({ - conversation_id: z.string(), - ConversationRestartStreamRequest: - components.ConversationRestartStreamRequest$inboundSchema, - }).transform((v) => { - return remap$(v, { - "conversation_id": "conversationId", - "ConversationRestartStreamRequest": "conversationRestartStreamRequest", - }); - }); - -/** @internal */ -export type AgentsApiV1ConversationsRestartStreamRequest$Outbound = { - conversation_id: string; - ConversationRestartStreamRequest: - components.ConversationRestartStreamRequest$Outbound; -}; - -/** @internal */ -export const AgentsApiV1ConversationsRestartStreamRequest$outboundSchema: - z.ZodType< - AgentsApiV1ConversationsRestartStreamRequest$Outbound, - z.ZodTypeDef, - AgentsApiV1ConversationsRestartStreamRequest - > = z.object({ - conversationId: z.string(), - conversationRestartStreamRequest: - components.ConversationRestartStreamRequest$outboundSchema, - }).transform((v) => { - return remap$(v, { - conversationId: "conversation_id", - conversationRestartStreamRequest: "ConversationRestartStreamRequest", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace AgentsApiV1ConversationsRestartStreamRequest$ { - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$inboundSchema` instead. */ - export const inboundSchema = - AgentsApiV1ConversationsRestartStreamRequest$inboundSchema; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$outboundSchema` instead. */ - export const outboundSchema = - AgentsApiV1ConversationsRestartStreamRequest$outboundSchema; - /** @deprecated use `AgentsApiV1ConversationsRestartStreamRequest$Outbound` instead. */ - export type Outbound = AgentsApiV1ConversationsRestartStreamRequest$Outbound; -} - -export function agentsApiV1ConversationsRestartStreamRequestToJSON( - agentsApiV1ConversationsRestartStreamRequest: - AgentsApiV1ConversationsRestartStreamRequest, -): string { - return JSON.stringify( - AgentsApiV1ConversationsRestartStreamRequest$outboundSchema.parse( - agentsApiV1ConversationsRestartStreamRequest, - ), - ); -} - -export function agentsApiV1ConversationsRestartStreamRequestFromJSON( - jsonString: string, -): SafeParseResult< - AgentsApiV1ConversationsRestartStreamRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - AgentsApiV1ConversationsRestartStreamRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AgentsApiV1ConversationsRestartStreamRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/deletemodelv1modelsmodeliddelete.ts b/examples/sdks/mistral-typescript/src/models/operations/deletemodelv1modelsmodeliddelete.ts deleted file mode 100644 index a77185602..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/deletemodelv1modelsmodeliddelete.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type DeleteModelV1ModelsModelIdDeleteRequest = { - /** - * The ID of the model to delete. - */ - modelId: string; -}; - -/** @internal */ -export const DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema: z.ZodType< - DeleteModelV1ModelsModelIdDeleteRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model_id: z.string(), -}).transform((v) => { - return remap$(v, { - "model_id": "modelId", - }); -}); - -/** @internal */ -export type DeleteModelV1ModelsModelIdDeleteRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -export const DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema: z.ZodType< - DeleteModelV1ModelsModelIdDeleteRequest$Outbound, - z.ZodTypeDef, - DeleteModelV1ModelsModelIdDeleteRequest -> = z.object({ - modelId: z.string(), -}).transform((v) => { - return remap$(v, { - modelId: "model_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DeleteModelV1ModelsModelIdDeleteRequest$ { - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema` instead. */ - export const inboundSchema = - DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema` instead. */ - export const outboundSchema = - DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema; - /** @deprecated use `DeleteModelV1ModelsModelIdDeleteRequest$Outbound` instead. */ - export type Outbound = DeleteModelV1ModelsModelIdDeleteRequest$Outbound; -} - -export function deleteModelV1ModelsModelIdDeleteRequestToJSON( - deleteModelV1ModelsModelIdDeleteRequest: - DeleteModelV1ModelsModelIdDeleteRequest, -): string { - return JSON.stringify( - DeleteModelV1ModelsModelIdDeleteRequest$outboundSchema.parse( - deleteModelV1ModelsModelIdDeleteRequest, - ), - ); -} - -export function deleteModelV1ModelsModelIdDeleteRequestFromJSON( - jsonString: string, -): SafeParseResult< - DeleteModelV1ModelsModelIdDeleteRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - DeleteModelV1ModelsModelIdDeleteRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'DeleteModelV1ModelsModelIdDeleteRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdeletefile.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdeletefile.ts deleted file mode 100644 index 33642f5a5..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdeletefile.ts +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesDeleteFileRequest = { - fileId: string; -}; - -/** @internal */ -export const FilesApiRoutesDeleteFileRequest$inboundSchema: z.ZodType< - FilesApiRoutesDeleteFileRequest, - z.ZodTypeDef, - unknown -> = z.object({ - file_id: z.string(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FilesApiRoutesDeleteFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -export const FilesApiRoutesDeleteFileRequest$outboundSchema: z.ZodType< - FilesApiRoutesDeleteFileRequest$Outbound, - z.ZodTypeDef, - FilesApiRoutesDeleteFileRequest -> = z.object({ - fileId: z.string(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesDeleteFileRequest$ { - /** @deprecated use `FilesApiRoutesDeleteFileRequest$inboundSchema` instead. */ - export const inboundSchema = FilesApiRoutesDeleteFileRequest$inboundSchema; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$outboundSchema` instead. */ - export const outboundSchema = FilesApiRoutesDeleteFileRequest$outboundSchema; - /** @deprecated use `FilesApiRoutesDeleteFileRequest$Outbound` instead. */ - export type Outbound = FilesApiRoutesDeleteFileRequest$Outbound; -} - -export function filesApiRoutesDeleteFileRequestToJSON( - filesApiRoutesDeleteFileRequest: FilesApiRoutesDeleteFileRequest, -): string { - return JSON.stringify( - FilesApiRoutesDeleteFileRequest$outboundSchema.parse( - filesApiRoutesDeleteFileRequest, - ), - ); -} - -export function filesApiRoutesDeleteFileRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FilesApiRoutesDeleteFileRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FilesApiRoutesDeleteFileRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdownloadfile.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdownloadfile.ts deleted file mode 100644 index 112d29943..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesdownloadfile.ts +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesDownloadFileRequest = { - fileId: string; -}; - -/** @internal */ -export const FilesApiRoutesDownloadFileRequest$inboundSchema: z.ZodType< - FilesApiRoutesDownloadFileRequest, - z.ZodTypeDef, - unknown -> = z.object({ - file_id: z.string(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FilesApiRoutesDownloadFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -export const FilesApiRoutesDownloadFileRequest$outboundSchema: z.ZodType< - FilesApiRoutesDownloadFileRequest$Outbound, - z.ZodTypeDef, - FilesApiRoutesDownloadFileRequest -> = z.object({ - fileId: z.string(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesDownloadFileRequest$ { - /** @deprecated use `FilesApiRoutesDownloadFileRequest$inboundSchema` instead. */ - export const inboundSchema = FilesApiRoutesDownloadFileRequest$inboundSchema; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$outboundSchema` instead. */ - export const outboundSchema = - FilesApiRoutesDownloadFileRequest$outboundSchema; - /** @deprecated use `FilesApiRoutesDownloadFileRequest$Outbound` instead. */ - export type Outbound = FilesApiRoutesDownloadFileRequest$Outbound; -} - -export function filesApiRoutesDownloadFileRequestToJSON( - filesApiRoutesDownloadFileRequest: FilesApiRoutesDownloadFileRequest, -): string { - return JSON.stringify( - FilesApiRoutesDownloadFileRequest$outboundSchema.parse( - filesApiRoutesDownloadFileRequest, - ), - ); -} - -export function filesApiRoutesDownloadFileRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FilesApiRoutesDownloadFileRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FilesApiRoutesDownloadFileRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesgetsignedurl.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesgetsignedurl.ts deleted file mode 100644 index 8868ad54a..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesgetsignedurl.ts +++ /dev/null @@ -1,85 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesGetSignedUrlRequest = { - fileId: string; - /** - * Number of hours before the url becomes invalid. Defaults to 24h - */ - expiry?: number | undefined; -}; - -/** @internal */ -export const FilesApiRoutesGetSignedUrlRequest$inboundSchema: z.ZodType< - FilesApiRoutesGetSignedUrlRequest, - z.ZodTypeDef, - unknown -> = z.object({ - file_id: z.string(), - expiry: z.number().int().default(24), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FilesApiRoutesGetSignedUrlRequest$Outbound = { - file_id: string; - expiry: number; -}; - -/** @internal */ -export const FilesApiRoutesGetSignedUrlRequest$outboundSchema: z.ZodType< - FilesApiRoutesGetSignedUrlRequest$Outbound, - z.ZodTypeDef, - FilesApiRoutesGetSignedUrlRequest -> = z.object({ - fileId: z.string(), - expiry: z.number().int().default(24), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesGetSignedUrlRequest$ { - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$inboundSchema` instead. */ - export const inboundSchema = FilesApiRoutesGetSignedUrlRequest$inboundSchema; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$outboundSchema` instead. */ - export const outboundSchema = - FilesApiRoutesGetSignedUrlRequest$outboundSchema; - /** @deprecated use `FilesApiRoutesGetSignedUrlRequest$Outbound` instead. */ - export type Outbound = FilesApiRoutesGetSignedUrlRequest$Outbound; -} - -export function filesApiRoutesGetSignedUrlRequestToJSON( - filesApiRoutesGetSignedUrlRequest: FilesApiRoutesGetSignedUrlRequest, -): string { - return JSON.stringify( - FilesApiRoutesGetSignedUrlRequest$outboundSchema.parse( - filesApiRoutesGetSignedUrlRequest, - ), - ); -} - -export function filesApiRoutesGetSignedUrlRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FilesApiRoutesGetSignedUrlRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FilesApiRoutesGetSignedUrlRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapirouteslistfiles.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapirouteslistfiles.ts deleted file mode 100644 index 35fe5e648..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapirouteslistfiles.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesListFilesRequest = { - page?: number | undefined; - pageSize?: number | undefined; - sampleType?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: components.FilePurpose | null | undefined; -}; - -/** @internal */ -export const FilesApiRoutesListFilesRequest$inboundSchema: z.ZodType< - FilesApiRoutesListFilesRequest, - z.ZodTypeDef, - unknown -> = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - sample_type: z.nullable(z.array(components.SampleType$inboundSchema)) - .optional(), - source: z.nullable(z.array(components.Source$inboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$inboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - "page_size": "pageSize", - "sample_type": "sampleType", - }); -}); - -/** @internal */ -export type FilesApiRoutesListFilesRequest$Outbound = { - page: number; - page_size: number; - sample_type?: Array | null | undefined; - source?: Array | null | undefined; - search?: string | null | undefined; - purpose?: string | null | undefined; -}; - -/** @internal */ -export const FilesApiRoutesListFilesRequest$outboundSchema: z.ZodType< - FilesApiRoutesListFilesRequest$Outbound, - z.ZodTypeDef, - FilesApiRoutesListFilesRequest -> = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - sampleType: z.nullable(z.array(components.SampleType$outboundSchema)) - .optional(), - source: z.nullable(z.array(components.Source$outboundSchema)).optional(), - search: z.nullable(z.string()).optional(), - purpose: z.nullable(components.FilePurpose$outboundSchema).optional(), -}).transform((v) => { - return remap$(v, { - pageSize: "page_size", - sampleType: "sample_type", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesListFilesRequest$ { - /** @deprecated use `FilesApiRoutesListFilesRequest$inboundSchema` instead. */ - export const inboundSchema = FilesApiRoutesListFilesRequest$inboundSchema; - /** @deprecated use `FilesApiRoutesListFilesRequest$outboundSchema` instead. */ - export const outboundSchema = FilesApiRoutesListFilesRequest$outboundSchema; - /** @deprecated use `FilesApiRoutesListFilesRequest$Outbound` instead. */ - export type Outbound = FilesApiRoutesListFilesRequest$Outbound; -} - -export function filesApiRoutesListFilesRequestToJSON( - filesApiRoutesListFilesRequest: FilesApiRoutesListFilesRequest, -): string { - return JSON.stringify( - FilesApiRoutesListFilesRequest$outboundSchema.parse( - filesApiRoutesListFilesRequest, - ), - ); -} - -export function filesApiRoutesListFilesRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FilesApiRoutesListFilesRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FilesApiRoutesListFilesRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesretrievefile.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesretrievefile.ts deleted file mode 100644 index 7788c4c8a..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesretrievefile.ts +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesRetrieveFileRequest = { - fileId: string; -}; - -/** @internal */ -export const FilesApiRoutesRetrieveFileRequest$inboundSchema: z.ZodType< - FilesApiRoutesRetrieveFileRequest, - z.ZodTypeDef, - unknown -> = z.object({ - file_id: z.string(), -}).transform((v) => { - return remap$(v, { - "file_id": "fileId", - }); -}); - -/** @internal */ -export type FilesApiRoutesRetrieveFileRequest$Outbound = { - file_id: string; -}; - -/** @internal */ -export const FilesApiRoutesRetrieveFileRequest$outboundSchema: z.ZodType< - FilesApiRoutesRetrieveFileRequest$Outbound, - z.ZodTypeDef, - FilesApiRoutesRetrieveFileRequest -> = z.object({ - fileId: z.string(), -}).transform((v) => { - return remap$(v, { - fileId: "file_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesRetrieveFileRequest$ { - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$inboundSchema` instead. */ - export const inboundSchema = FilesApiRoutesRetrieveFileRequest$inboundSchema; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$outboundSchema` instead. */ - export const outboundSchema = - FilesApiRoutesRetrieveFileRequest$outboundSchema; - /** @deprecated use `FilesApiRoutesRetrieveFileRequest$Outbound` instead. */ - export type Outbound = FilesApiRoutesRetrieveFileRequest$Outbound; -} - -export function filesApiRoutesRetrieveFileRequestToJSON( - filesApiRoutesRetrieveFileRequest: FilesApiRoutesRetrieveFileRequest, -): string { - return JSON.stringify( - FilesApiRoutesRetrieveFileRequest$outboundSchema.parse( - filesApiRoutesRetrieveFileRequest, - ), - ); -} - -export function filesApiRoutesRetrieveFileRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => FilesApiRoutesRetrieveFileRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'FilesApiRoutesRetrieveFileRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesuploadfile.ts b/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesuploadfile.ts deleted file mode 100644 index f672b0fbb..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/filesapiroutesuploadfile.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { blobLikeSchema } from "../../types/blobs.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type FilesApiRoutesUploadFileMultiPartBodyParams = { - purpose?: components.FilePurpose | undefined; - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -/** @internal */ -export const FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema: - z.ZodType< - FilesApiRoutesUploadFileMultiPartBodyParams, - z.ZodTypeDef, - unknown - > = z.object({ - purpose: components.FilePurpose$inboundSchema.optional(), - file: components.FileT$inboundSchema, - }); - -/** @internal */ -export type FilesApiRoutesUploadFileMultiPartBodyParams$Outbound = { - purpose?: string | undefined; - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -export const FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema: - z.ZodType< - FilesApiRoutesUploadFileMultiPartBodyParams$Outbound, - z.ZodTypeDef, - FilesApiRoutesUploadFileMultiPartBodyParams - > = z.object({ - purpose: components.FilePurpose$outboundSchema.optional(), - file: components.FileT$outboundSchema.or(blobLikeSchema), - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace FilesApiRoutesUploadFileMultiPartBodyParams$ { - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema` instead. */ - export const inboundSchema = - FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema` instead. */ - export const outboundSchema = - FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema; - /** @deprecated use `FilesApiRoutesUploadFileMultiPartBodyParams$Outbound` instead. */ - export type Outbound = FilesApiRoutesUploadFileMultiPartBodyParams$Outbound; -} - -export function filesApiRoutesUploadFileMultiPartBodyParamsToJSON( - filesApiRoutesUploadFileMultiPartBodyParams: - FilesApiRoutesUploadFileMultiPartBodyParams, -): string { - return JSON.stringify( - FilesApiRoutesUploadFileMultiPartBodyParams$outboundSchema.parse( - filesApiRoutesUploadFileMultiPartBodyParams, - ), - ); -} - -export function filesApiRoutesUploadFileMultiPartBodyParamsFromJSON( - jsonString: string, -): SafeParseResult< - FilesApiRoutesUploadFileMultiPartBodyParams, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - FilesApiRoutesUploadFileMultiPartBodyParams$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'FilesApiRoutesUploadFileMultiPartBodyParams' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/index.ts b/examples/sdks/mistral-typescript/src/models/operations/index.ts deleted file mode 100644 index d704d1cf1..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/index.ts +++ /dev/null @@ -1,51 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./agentsapiv1agentsget.js"; -export * from "./agentsapiv1agentslist.js"; -export * from "./agentsapiv1agentsupdate.js"; -export * from "./agentsapiv1agentsupdateversion.js"; -export * from "./agentsapiv1conversationsappend.js"; -export * from "./agentsapiv1conversationsappendstream.js"; -export * from "./agentsapiv1conversationsget.js"; -export * from "./agentsapiv1conversationshistory.js"; -export * from "./agentsapiv1conversationslist.js"; -export * from "./agentsapiv1conversationsmessages.js"; -export * from "./agentsapiv1conversationsrestart.js"; -export * from "./agentsapiv1conversationsrestartstream.js"; -export * from "./deletemodelv1modelsmodeliddelete.js"; -export * from "./filesapiroutesdeletefile.js"; -export * from "./filesapiroutesdownloadfile.js"; -export * from "./filesapiroutesgetsignedurl.js"; -export * from "./filesapirouteslistfiles.js"; -export * from "./filesapiroutesretrievefile.js"; -export * from "./filesapiroutesuploadfile.js"; -export * from "./jobsapiroutesbatchcancelbatchjob.js"; -export * from "./jobsapiroutesbatchgetbatchjob.js"; -export * from "./jobsapiroutesbatchgetbatchjobs.js"; -export * from "./jobsapiroutesfinetuningarchivefinetunedmodel.js"; -export * from "./jobsapiroutesfinetuningcancelfinetuningjob.js"; -export * from "./jobsapiroutesfinetuningcreatefinetuningjob.js"; -export * from "./jobsapiroutesfinetuninggetfinetuningjob.js"; -export * from "./jobsapiroutesfinetuninggetfinetuningjobs.js"; -export * from "./jobsapiroutesfinetuningstartfinetuningjob.js"; -export * from "./jobsapiroutesfinetuningunarchivefinetunedmodel.js"; -export * from "./jobsapiroutesfinetuningupdatefinetunedmodel.js"; -export * from "./librariesdeletev1.js"; -export * from "./librariesdocumentsdeletev1.js"; -export * from "./librariesdocumentsgetextractedtextsignedurlv1.js"; -export * from "./librariesdocumentsgetsignedurlv1.js"; -export * from "./librariesdocumentsgetstatusv1.js"; -export * from "./librariesdocumentsgettextcontentv1.js"; -export * from "./librariesdocumentsgetv1.js"; -export * from "./librariesdocumentslistv1.js"; -export * from "./librariesdocumentsreprocessv1.js"; -export * from "./librariesdocumentsupdatev1.js"; -export * from "./librariesdocumentsuploadv1.js"; -export * from "./librariesgetv1.js"; -export * from "./librariessharecreatev1.js"; -export * from "./librariessharedeletev1.js"; -export * from "./librariessharelistv1.js"; -export * from "./librariesupdatev1.js"; -export * from "./retrievemodelv1modelsmodelidget.js"; diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchcancelbatchjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchcancelbatchjob.ts deleted file mode 100644 index 85d6bed1a..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchcancelbatchjob.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesBatchCancelBatchJobRequest = { - jobId: string; -}; - -/** @internal */ -export const JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema: z.ZodType< - JobsApiRoutesBatchCancelBatchJobRequest, - z.ZodTypeDef, - unknown -> = z.object({ - job_id: z.string(), -}).transform((v) => { - return remap$(v, { - "job_id": "jobId", - }); -}); - -/** @internal */ -export type JobsApiRoutesBatchCancelBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -export const JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema: z.ZodType< - JobsApiRoutesBatchCancelBatchJobRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesBatchCancelBatchJobRequest -> = z.object({ - jobId: z.string(), -}).transform((v) => { - return remap$(v, { - jobId: "job_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesBatchCancelBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesBatchCancelBatchJobRequest$Outbound` instead. */ - export type Outbound = JobsApiRoutesBatchCancelBatchJobRequest$Outbound; -} - -export function jobsApiRoutesBatchCancelBatchJobRequestToJSON( - jobsApiRoutesBatchCancelBatchJobRequest: - JobsApiRoutesBatchCancelBatchJobRequest, -): string { - return JSON.stringify( - JobsApiRoutesBatchCancelBatchJobRequest$outboundSchema.parse( - jobsApiRoutesBatchCancelBatchJobRequest, - ), - ); -} - -export function jobsApiRoutesBatchCancelBatchJobRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesBatchCancelBatchJobRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesBatchCancelBatchJobRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesBatchCancelBatchJobRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjob.ts deleted file mode 100644 index 20b62a323..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjob.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesBatchGetBatchJobRequest = { - jobId: string; -}; - -/** @internal */ -export const JobsApiRoutesBatchGetBatchJobRequest$inboundSchema: z.ZodType< - JobsApiRoutesBatchGetBatchJobRequest, - z.ZodTypeDef, - unknown -> = z.object({ - job_id: z.string(), -}).transform((v) => { - return remap$(v, { - "job_id": "jobId", - }); -}); - -/** @internal */ -export type JobsApiRoutesBatchGetBatchJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -export const JobsApiRoutesBatchGetBatchJobRequest$outboundSchema: z.ZodType< - JobsApiRoutesBatchGetBatchJobRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesBatchGetBatchJobRequest -> = z.object({ - jobId: z.string(), -}).transform((v) => { - return remap$(v, { - jobId: "job_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesBatchGetBatchJobRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesBatchGetBatchJobRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesBatchGetBatchJobRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobRequest$Outbound` instead. */ - export type Outbound = JobsApiRoutesBatchGetBatchJobRequest$Outbound; -} - -export function jobsApiRoutesBatchGetBatchJobRequestToJSON( - jobsApiRoutesBatchGetBatchJobRequest: JobsApiRoutesBatchGetBatchJobRequest, -): string { - return JSON.stringify( - JobsApiRoutesBatchGetBatchJobRequest$outboundSchema.parse( - jobsApiRoutesBatchGetBatchJobRequest, - ), - ); -} - -export function jobsApiRoutesBatchGetBatchJobRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - JobsApiRoutesBatchGetBatchJobRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobsApiRoutesBatchGetBatchJobRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjobs.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjobs.ts deleted file mode 100644 index 502c6f70f..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesbatchgetbatchjobs.ts +++ /dev/null @@ -1,119 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesBatchGetBatchJobsRequest = { - page?: number | undefined; - pageSize?: number | undefined; - model?: string | null | undefined; - agentId?: string | null | undefined; - metadata?: { [k: string]: any } | null | undefined; - createdAfter?: Date | null | undefined; - createdByMe?: boolean | undefined; - status?: Array | null | undefined; -}; - -/** @internal */ -export const JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema: z.ZodType< - JobsApiRoutesBatchGetBatchJobsRequest, - z.ZodTypeDef, - unknown -> = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agent_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - created_after: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$inboundSchema)) - .optional(), -}).transform((v) => { - return remap$(v, { - "page_size": "pageSize", - "agent_id": "agentId", - "created_after": "createdAfter", - "created_by_me": "createdByMe", - }); -}); - -/** @internal */ -export type JobsApiRoutesBatchGetBatchJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - agent_id?: string | null | undefined; - metadata?: { [k: string]: any } | null | undefined; - created_after?: string | null | undefined; - created_by_me: boolean; - status?: Array | null | undefined; -}; - -/** @internal */ -export const JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema: z.ZodType< - JobsApiRoutesBatchGetBatchJobsRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesBatchGetBatchJobsRequest -> = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - agentId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.any())).optional(), - createdAfter: z.nullable(z.date().transform(v => v.toISOString())).optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(z.array(components.BatchJobStatus$outboundSchema)) - .optional(), -}).transform((v) => { - return remap$(v, { - pageSize: "page_size", - agentId: "agent_id", - createdAfter: "created_after", - createdByMe: "created_by_me", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesBatchGetBatchJobsRequest$ { - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesBatchGetBatchJobsRequest$Outbound` instead. */ - export type Outbound = JobsApiRoutesBatchGetBatchJobsRequest$Outbound; -} - -export function jobsApiRoutesBatchGetBatchJobsRequestToJSON( - jobsApiRoutesBatchGetBatchJobsRequest: JobsApiRoutesBatchGetBatchJobsRequest, -): string { - return JSON.stringify( - JobsApiRoutesBatchGetBatchJobsRequest$outboundSchema.parse( - jobsApiRoutesBatchGetBatchJobsRequest, - ), - ); -} - -export function jobsApiRoutesBatchGetBatchJobsRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - JobsApiRoutesBatchGetBatchJobsRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'JobsApiRoutesBatchGetBatchJobsRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.ts deleted file mode 100644 index b183666f4..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningarchivefinetunedmodel.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningArchiveFineTunedModelRequest = { - /** - * The ID of the model to archive. - */ - modelId: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - z.ZodTypeDef, - unknown - > = z.object({ - model_id: z.string(), - }).transform((v) => { - return remap$(v, { - "model_id": "modelId", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningArchiveFineTunedModelRequest - > = z.object({ - modelId: z.string(), - }).transform((v) => { - return remap$(v, { - modelId: "model_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningArchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$Outbound; -} - -export function jobsApiRoutesFineTuningArchiveFineTunedModelRequestToJSON( - jobsApiRoutesFineTuningArchiveFineTunedModelRequest: - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$outboundSchema.parse( - jobsApiRoutesFineTuningArchiveFineTunedModelRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningArchiveFineTunedModelRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningArchiveFineTunedModelRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningArchiveFineTunedModelRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.ts deleted file mode 100644 index 443f6c890..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcancelfinetuningjob.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningCancelFineTuningJobRequest = { - /** - * The ID of the job to cancel. - */ - jobId: string; -}; - -/** - * OK - */ -export type JobsApiRoutesFineTuningCancelFineTuningJobResponse = - | (components.ClassifierDetailedJobOut & { jobType: "classifier" }) - | (components.CompletionDetailedJobOut & { jobType: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCancelFineTuningJobRequest, - z.ZodTypeDef, - unknown - > = z.object({ - job_id: z.string(), - }).transform((v) => { - return remap$(v, { - "job_id": "jobId", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningCancelFineTuningJobRequest - > = z.object({ - jobId: z.string(), - }).transform((v) => { - return remap$(v, { - jobId: "job_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningCancelFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningCancelFineTuningJobRequest$Outbound; -} - -export function jobsApiRoutesFineTuningCancelFineTuningJobRequestToJSON( - jobsApiRoutesFineTuningCancelFineTuningJobRequest: - JobsApiRoutesFineTuningCancelFineTuningJobRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningCancelFineTuningJobRequest$outboundSchema.parse( - jobsApiRoutesFineTuningCancelFineTuningJobRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningCancelFineTuningJobRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningCancelFineTuningJobRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningCancelFineTuningJobRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobRequest' from JSON`, - ); -} - -/** @internal */ -export const JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCancelFineTuningJobResponse, - z.ZodTypeDef, - unknown - > = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - components.CompletionDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ]); - -/** @internal */ -export type JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound = - | (components.ClassifierDetailedJobOut$Outbound & { job_type: "classifier" }) - | (components.CompletionDetailedJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningCancelFineTuningJobResponse - > = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - components.CompletionDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningCancelFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningCancelFineTuningJobResponse$Outbound; -} - -export function jobsApiRoutesFineTuningCancelFineTuningJobResponseToJSON( - jobsApiRoutesFineTuningCancelFineTuningJobResponse: - JobsApiRoutesFineTuningCancelFineTuningJobResponse, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningCancelFineTuningJobResponse$outboundSchema.parse( - jobsApiRoutesFineTuningCancelFineTuningJobResponse, - ), - ); -} - -export function jobsApiRoutesFineTuningCancelFineTuningJobResponseFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningCancelFineTuningJobResponse, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningCancelFineTuningJobResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningCancelFineTuningJobResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.ts deleted file mode 100644 index 007b61c49..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningcreatefinetuningjob.ts +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type One = - | (components.ClassifierJobOut & { jobType: "classifier" }) - | (components.CompletionJobOut & { jobType: "completion" }); - -/** - * OK - */ -export type JobsApiRoutesFineTuningCreateFineTuningJobResponse = - | components.LegacyJobMetadataOut - | (components.ClassifierJobOut & { jobType: "classifier" }) - | (components.CompletionJobOut & { jobType: "completion" }); - -/** @internal */ -export const One$inboundSchema: z.ZodType = z.union( - [ - components.ClassifierJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - components.CompletionJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ], -); - -/** @internal */ -export type One$Outbound = - | (components.ClassifierJobOut$Outbound & { job_type: "classifier" }) - | (components.CompletionJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const One$outboundSchema: z.ZodType = z - .union([ - components.ClassifierJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - components.CompletionJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace One$ { - /** @deprecated use `One$inboundSchema` instead. */ - export const inboundSchema = One$inboundSchema; - /** @deprecated use `One$outboundSchema` instead. */ - export const outboundSchema = One$outboundSchema; - /** @deprecated use `One$Outbound` instead. */ - export type Outbound = One$Outbound; -} - -export function oneToJSON(one: One): string { - return JSON.stringify(One$outboundSchema.parse(one)); -} - -export function oneFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => One$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'One' from JSON`, - ); -} - -/** @internal */ -export const JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCreateFineTuningJobResponse, - z.ZodTypeDef, - unknown - > = z.union([ - components.LegacyJobMetadataOut$inboundSchema, - z.union([ - components.ClassifierJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - components.CompletionJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ]), - ]); - -/** @internal */ -export type JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound = - | components.LegacyJobMetadataOut$Outbound - | (components.ClassifierJobOut$Outbound & { job_type: "classifier" }) - | (components.CompletionJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningCreateFineTuningJobResponse - > = z.union([ - components.LegacyJobMetadataOut$outboundSchema, - z.union([ - components.ClassifierJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - components.CompletionJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningCreateFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningCreateFineTuningJobResponse$Outbound; -} - -export function jobsApiRoutesFineTuningCreateFineTuningJobResponseToJSON( - jobsApiRoutesFineTuningCreateFineTuningJobResponse: - JobsApiRoutesFineTuningCreateFineTuningJobResponse, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningCreateFineTuningJobResponse$outboundSchema.parse( - jobsApiRoutesFineTuningCreateFineTuningJobResponse, - ), - ); -} - -export function jobsApiRoutesFineTuningCreateFineTuningJobResponseFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningCreateFineTuningJobResponse, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningCreateFineTuningJobResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningCreateFineTuningJobResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjob.ts deleted file mode 100644 index 93d799abb..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjob.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningGetFineTuningJobRequest = { - /** - * The ID of the job to analyse. - */ - jobId: string; -}; - -/** - * OK - */ -export type JobsApiRoutesFineTuningGetFineTuningJobResponse = - | (components.ClassifierDetailedJobOut & { jobType: "classifier" }) - | (components.CompletionDetailedJobOut & { jobType: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobRequest, - z.ZodTypeDef, - unknown - > = z.object({ - job_id: z.string(), - }).transform((v) => { - return remap$(v, { - "job_id": "jobId", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningGetFineTuningJobRequest - > = z.object({ - jobId: z.string(), - }).transform((v) => { - return remap$(v, { - jobId: "job_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningGetFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningGetFineTuningJobRequest$Outbound; -} - -export function jobsApiRoutesFineTuningGetFineTuningJobRequestToJSON( - jobsApiRoutesFineTuningGetFineTuningJobRequest: - JobsApiRoutesFineTuningGetFineTuningJobRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningGetFineTuningJobRequest$outboundSchema.parse( - jobsApiRoutesFineTuningGetFineTuningJobRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningGetFineTuningJobRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningGetFineTuningJobRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningGetFineTuningJobRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobRequest' from JSON`, - ); -} - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobResponse, - z.ZodTypeDef, - unknown - > = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - components.CompletionDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ]); - -/** @internal */ -export type JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound = - | (components.ClassifierDetailedJobOut$Outbound & { job_type: "classifier" }) - | (components.CompletionDetailedJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningGetFineTuningJobResponse - > = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - components.CompletionDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningGetFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningGetFineTuningJobResponse$Outbound; -} - -export function jobsApiRoutesFineTuningGetFineTuningJobResponseToJSON( - jobsApiRoutesFineTuningGetFineTuningJobResponse: - JobsApiRoutesFineTuningGetFineTuningJobResponse, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningGetFineTuningJobResponse$outboundSchema.parse( - jobsApiRoutesFineTuningGetFineTuningJobResponse, - ), - ); -} - -export function jobsApiRoutesFineTuningGetFineTuningJobResponseFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningGetFineTuningJobResponse, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningGetFineTuningJobResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.ts deleted file mode 100644 index 7bace3a51..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuninggetfinetuningjobs.ts +++ /dev/null @@ -1,208 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { ClosedEnum } from "../../types/enums.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -export const Status = { - Queued: "QUEUED", - Started: "STARTED", - Validating: "VALIDATING", - Validated: "VALIDATED", - Running: "RUNNING", - FailedValidation: "FAILED_VALIDATION", - Failed: "FAILED", - Success: "SUCCESS", - Cancelled: "CANCELLED", - CancellationRequested: "CANCELLATION_REQUESTED", -} as const; -/** - * The current job state to filter on. When set, the other results are not displayed. - */ -export type Status = ClosedEnum; - -export type JobsApiRoutesFineTuningGetFineTuningJobsRequest = { - /** - * The page number of the results to be returned. - */ - page?: number | undefined; - /** - * The number of items to return per page. - */ - pageSize?: number | undefined; - /** - * The model name used for fine-tuning to filter on. When set, the other results are not displayed. - */ - model?: string | null | undefined; - /** - * The date/time to filter on. When set, the results for previous creation times are not displayed. - */ - createdAfter?: Date | null | undefined; - createdBefore?: Date | null | undefined; - /** - * When set, only return results for jobs created by the API caller. Other results are not displayed. - */ - createdByMe?: boolean | undefined; - /** - * The current job state to filter on. When set, the other results are not displayed. - */ - status?: Status | null | undefined; - /** - * The Weights and Biases project to filter on. When set, the other results are not displayed. - */ - wandbProject?: string | null | undefined; - /** - * The Weight and Biases run name to filter on. When set, the other results are not displayed. - */ - wandbName?: string | null | undefined; - /** - * The model suffix to filter on. When set, the other results are not displayed. - */ - suffix?: string | null | undefined; -}; - -/** @internal */ -export const Status$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(Status); - -/** @internal */ -export const Status$outboundSchema: z.ZodNativeEnum = - Status$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Status$ { - /** @deprecated use `Status$inboundSchema` instead. */ - export const inboundSchema = Status$inboundSchema; - /** @deprecated use `Status$outboundSchema` instead. */ - export const outboundSchema = Status$outboundSchema; -} - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobsRequest, - z.ZodTypeDef, - unknown - > = z.object({ - page: z.number().int().default(0), - page_size: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - created_after: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - created_before: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ).optional(), - created_by_me: z.boolean().default(false), - status: z.nullable(Status$inboundSchema).optional(), - wandb_project: z.nullable(z.string()).optional(), - wandb_name: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - }).transform((v) => { - return remap$(v, { - "page_size": "pageSize", - "created_after": "createdAfter", - "created_before": "createdBefore", - "created_by_me": "createdByMe", - "wandb_project": "wandbProject", - "wandb_name": "wandbName", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound = { - page: number; - page_size: number; - model?: string | null | undefined; - created_after?: string | null | undefined; - created_before?: string | null | undefined; - created_by_me: boolean; - status?: string | null | undefined; - wandb_project?: string | null | undefined; - wandb_name?: string | null | undefined; - suffix?: string | null | undefined; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningGetFineTuningJobsRequest - > = z.object({ - page: z.number().int().default(0), - pageSize: z.number().int().default(100), - model: z.nullable(z.string()).optional(), - createdAfter: z.nullable(z.date().transform(v => v.toISOString())) - .optional(), - createdBefore: z.nullable(z.date().transform(v => v.toISOString())) - .optional(), - createdByMe: z.boolean().default(false), - status: z.nullable(Status$outboundSchema).optional(), - wandbProject: z.nullable(z.string()).optional(), - wandbName: z.nullable(z.string()).optional(), - suffix: z.nullable(z.string()).optional(), - }).transform((v) => { - return remap$(v, { - pageSize: "page_size", - createdAfter: "created_after", - createdBefore: "created_before", - createdByMe: "created_by_me", - wandbProject: "wandb_project", - wandbName: "wandb_name", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningGetFineTuningJobsRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningGetFineTuningJobsRequest$Outbound; -} - -export function jobsApiRoutesFineTuningGetFineTuningJobsRequestToJSON( - jobsApiRoutesFineTuningGetFineTuningJobsRequest: - JobsApiRoutesFineTuningGetFineTuningJobsRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningGetFineTuningJobsRequest$outboundSchema.parse( - jobsApiRoutesFineTuningGetFineTuningJobsRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningGetFineTuningJobsRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningGetFineTuningJobsRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningGetFineTuningJobsRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningGetFineTuningJobsRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningstartfinetuningjob.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningstartfinetuningjob.ts deleted file mode 100644 index 03caa894d..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningstartfinetuningjob.ts +++ /dev/null @@ -1,183 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningStartFineTuningJobRequest = { - jobId: string; -}; - -/** - * OK - */ -export type JobsApiRoutesFineTuningStartFineTuningJobResponse = - | (components.ClassifierDetailedJobOut & { jobType: "classifier" }) - | (components.CompletionDetailedJobOut & { jobType: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningStartFineTuningJobRequest, - z.ZodTypeDef, - unknown - > = z.object({ - job_id: z.string(), - }).transform((v) => { - return remap$(v, { - "job_id": "jobId", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound = { - job_id: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningStartFineTuningJobRequest - > = z.object({ - jobId: z.string(), - }).transform((v) => { - return remap$(v, { - jobId: "job_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningStartFineTuningJobRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningStartFineTuningJobRequest$Outbound; -} - -export function jobsApiRoutesFineTuningStartFineTuningJobRequestToJSON( - jobsApiRoutesFineTuningStartFineTuningJobRequest: - JobsApiRoutesFineTuningStartFineTuningJobRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningStartFineTuningJobRequest$outboundSchema.parse( - jobsApiRoutesFineTuningStartFineTuningJobRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningStartFineTuningJobRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningStartFineTuningJobRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningStartFineTuningJobRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobRequest' from JSON`, - ); -} - -/** @internal */ -export const JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningStartFineTuningJobResponse, - z.ZodTypeDef, - unknown - > = z.union([ - components.ClassifierDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("classifier") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - components.CompletionDetailedJobOut$inboundSchema.and( - z.object({ job_type: z.literal("completion") }).transform((v) => ({ - jobType: v.job_type, - })), - ), - ]); - -/** @internal */ -export type JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound = - | (components.ClassifierDetailedJobOut$Outbound & { job_type: "classifier" }) - | (components.CompletionDetailedJobOut$Outbound & { job_type: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningStartFineTuningJobResponse - > = z.union([ - components.ClassifierDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("classifier") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - components.CompletionDetailedJobOut$outboundSchema.and( - z.object({ jobType: z.literal("completion") }).transform((v) => ({ - job_type: v.jobType, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningStartFineTuningJobResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningStartFineTuningJobResponse$Outbound; -} - -export function jobsApiRoutesFineTuningStartFineTuningJobResponseToJSON( - jobsApiRoutesFineTuningStartFineTuningJobResponse: - JobsApiRoutesFineTuningStartFineTuningJobResponse, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningStartFineTuningJobResponse$outboundSchema.parse( - jobsApiRoutesFineTuningStartFineTuningJobResponse, - ), - ); -} - -export function jobsApiRoutesFineTuningStartFineTuningJobResponseFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningStartFineTuningJobResponse, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningStartFineTuningJobResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningStartFineTuningJobResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.ts deleted file mode 100644 index b171e9972..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningunarchivefinetunedmodel.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest = { - /** - * The ID of the model to unarchive. - */ - modelId: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - z.ZodTypeDef, - unknown - > = z.object({ - model_id: z.string(), - }).transform((v) => { - return remap$(v, { - "model_id": "modelId", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest - > = z.object({ - modelId: z.string(), - }).transform((v) => { - return remap$(v, { - modelId: "model_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$Outbound; -} - -export function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestToJSON( - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest: - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$outboundSchema.parse( - jobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningUnarchiveFineTunedModelRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.ts b/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.ts deleted file mode 100644 index b06feb17c..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/jobsapiroutesfinetuningupdatefinetunedmodel.ts +++ /dev/null @@ -1,192 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type JobsApiRoutesFineTuningUpdateFineTunedModelRequest = { - /** - * The ID of the model to update. - */ - modelId: string; - updateFTModelIn: components.UpdateFTModelIn; -}; - -/** - * OK - */ -export type JobsApiRoutesFineTuningUpdateFineTunedModelResponse = - | (components.ClassifierFTModelOut & { modelType: "classifier" }) - | (components.CompletionFTModelOut & { modelType: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - z.ZodTypeDef, - unknown - > = z.object({ - model_id: z.string(), - UpdateFTModelIn: components.UpdateFTModelIn$inboundSchema, - }).transform((v) => { - return remap$(v, { - "model_id": "modelId", - "UpdateFTModelIn": "updateFTModelIn", - }); - }); - -/** @internal */ -export type JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound = { - model_id: string; - UpdateFTModelIn: components.UpdateFTModelIn$Outbound; -}; - -/** @internal */ -export const JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningUpdateFineTunedModelRequest - > = z.object({ - modelId: z.string(), - updateFTModelIn: components.UpdateFTModelIn$outboundSchema, - }).transform((v) => { - return remap$(v, { - modelId: "model_id", - updateFTModelIn: "UpdateFTModelIn", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningUpdateFineTunedModelRequest$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$Outbound; -} - -export function jobsApiRoutesFineTuningUpdateFineTunedModelRequestToJSON( - jobsApiRoutesFineTuningUpdateFineTunedModelRequest: - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$outboundSchema.parse( - jobsApiRoutesFineTuningUpdateFineTunedModelRequest, - ), - ); -} - -export function jobsApiRoutesFineTuningUpdateFineTunedModelRequestFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningUpdateFineTunedModelRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelRequest' from JSON`, - ); -} - -/** @internal */ -export const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - z.ZodTypeDef, - unknown - > = z.union([ - components.ClassifierFTModelOut$inboundSchema.and( - z.object({ model_type: z.literal("classifier") }).transform((v) => ({ - modelType: v.model_type, - })), - ), - components.CompletionFTModelOut$inboundSchema.and( - z.object({ model_type: z.literal("completion") }).transform((v) => ({ - modelType: v.model_type, - })), - ), - ]); - -/** @internal */ -export type JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound = - | (components.ClassifierFTModelOut$Outbound & { model_type: "classifier" }) - | (components.CompletionFTModelOut$Outbound & { model_type: "completion" }); - -/** @internal */ -export const JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema: - z.ZodType< - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound, - z.ZodTypeDef, - JobsApiRoutesFineTuningUpdateFineTunedModelResponse - > = z.union([ - components.ClassifierFTModelOut$outboundSchema.and( - z.object({ modelType: z.literal("classifier") }).transform((v) => ({ - model_type: v.modelType, - })), - ), - components.CompletionFTModelOut$outboundSchema.and( - z.object({ modelType: z.literal("completion") }).transform((v) => ({ - model_type: v.modelType, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace JobsApiRoutesFineTuningUpdateFineTunedModelResponse$ { - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema` instead. */ - export const inboundSchema = - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema` instead. */ - export const outboundSchema = - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema; - /** @deprecated use `JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound` instead. */ - export type Outbound = - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$Outbound; -} - -export function jobsApiRoutesFineTuningUpdateFineTunedModelResponseToJSON( - jobsApiRoutesFineTuningUpdateFineTunedModelResponse: - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, -): string { - return JSON.stringify( - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$outboundSchema.parse( - jobsApiRoutesFineTuningUpdateFineTunedModelResponse, - ), - ); -} - -export function jobsApiRoutesFineTuningUpdateFineTunedModelResponseFromJSON( - jsonString: string, -): SafeParseResult< - JobsApiRoutesFineTuningUpdateFineTunedModelResponse, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - JobsApiRoutesFineTuningUpdateFineTunedModelResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'JobsApiRoutesFineTuningUpdateFineTunedModelResponse' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdeletev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdeletev1.ts deleted file mode 100644 index 915a4ae1e..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdeletev1.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDeleteV1Request = { - libraryId: string; -}; - -/** @internal */ -export const LibrariesDeleteV1Request$inboundSchema: z.ZodType< - LibrariesDeleteV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - }); -}); - -/** @internal */ -export type LibrariesDeleteV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -export const LibrariesDeleteV1Request$outboundSchema: z.ZodType< - LibrariesDeleteV1Request$Outbound, - z.ZodTypeDef, - LibrariesDeleteV1Request -> = z.object({ - libraryId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDeleteV1Request$ { - /** @deprecated use `LibrariesDeleteV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDeleteV1Request$inboundSchema; - /** @deprecated use `LibrariesDeleteV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesDeleteV1Request$outboundSchema; - /** @deprecated use `LibrariesDeleteV1Request$Outbound` instead. */ - export type Outbound = LibrariesDeleteV1Request$Outbound; -} - -export function librariesDeleteV1RequestToJSON( - librariesDeleteV1Request: LibrariesDeleteV1Request, -): string { - return JSON.stringify( - LibrariesDeleteV1Request$outboundSchema.parse(librariesDeleteV1Request), - ); -} - -export function librariesDeleteV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDeleteV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDeleteV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsdeletev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsdeletev1.ts deleted file mode 100644 index 8521bdfc5..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsdeletev1.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsDeleteV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsDeleteV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsDeleteV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsDeleteV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsDeleteV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsDeleteV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsDeleteV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsDeleteV1Request$ { - /** @deprecated use `LibrariesDocumentsDeleteV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDocumentsDeleteV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsDeleteV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsDeleteV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsDeleteV1Request$Outbound; -} - -export function librariesDocumentsDeleteV1RequestToJSON( - librariesDocumentsDeleteV1Request: LibrariesDocumentsDeleteV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsDeleteV1Request$outboundSchema.parse( - librariesDocumentsDeleteV1Request, - ), - ); -} - -export function librariesDocumentsDeleteV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDocumentsDeleteV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsDeleteV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts deleted file mode 100644 index ca1a1ff2f..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetextractedtextsignedurlv1.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsGetExtractedTextSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema: - z.ZodType< - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - z.ZodTypeDef, - unknown - > = z.object({ - library_id: z.string(), - document_id: z.string(), - }).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); - }); - -/** @internal */ -export type LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema: - z.ZodType< - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsGetExtractedTextSignedUrlV1Request - > = z.object({ - libraryId: z.string(), - documentId: z.string(), - }).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsGetExtractedTextSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound` instead. */ - export type Outbound = - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$Outbound; -} - -export function librariesDocumentsGetExtractedTextSignedUrlV1RequestToJSON( - librariesDocumentsGetExtractedTextSignedUrlV1Request: - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$outboundSchema.parse( - librariesDocumentsGetExtractedTextSignedUrlV1Request, - ), - ); -} - -export function librariesDocumentsGetExtractedTextSignedUrlV1RequestFromJSON( - jsonString: string, -): SafeParseResult< - LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsGetExtractedTextSignedUrlV1Request$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'LibrariesDocumentsGetExtractedTextSignedUrlV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetsignedurlv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetsignedurlv1.ts deleted file mode 100644 index 8adb2cc3c..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetsignedurlv1.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsGetSignedUrlV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetSignedUrlV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsGetSignedUrlV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsGetSignedUrlV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetSignedUrlV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsGetSignedUrlV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsGetSignedUrlV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsGetSignedUrlV1Request$ { - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsGetSignedUrlV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsGetSignedUrlV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsGetSignedUrlV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsGetSignedUrlV1Request$Outbound; -} - -export function librariesDocumentsGetSignedUrlV1RequestToJSON( - librariesDocumentsGetSignedUrlV1Request: - LibrariesDocumentsGetSignedUrlV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsGetSignedUrlV1Request$outboundSchema.parse( - librariesDocumentsGetSignedUrlV1Request, - ), - ); -} - -export function librariesDocumentsGetSignedUrlV1RequestFromJSON( - jsonString: string, -): SafeParseResult< - LibrariesDocumentsGetSignedUrlV1Request, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsGetSignedUrlV1Request$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'LibrariesDocumentsGetSignedUrlV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetstatusv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetstatusv1.ts deleted file mode 100644 index 4dcc034c3..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetstatusv1.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsGetStatusV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetStatusV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsGetStatusV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsGetStatusV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetStatusV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsGetStatusV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsGetStatusV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsGetStatusV1Request$ { - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsGetStatusV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsGetStatusV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsGetStatusV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsGetStatusV1Request$Outbound; -} - -export function librariesDocumentsGetStatusV1RequestToJSON( - librariesDocumentsGetStatusV1Request: LibrariesDocumentsGetStatusV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsGetStatusV1Request$outboundSchema.parse( - librariesDocumentsGetStatusV1Request, - ), - ); -} - -export function librariesDocumentsGetStatusV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsGetStatusV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsGetStatusV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgettextcontentv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgettextcontentv1.ts deleted file mode 100644 index 78614e09e..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgettextcontentv1.ts +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsGetTextContentV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetTextContentV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsGetTextContentV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsGetTextContentV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetTextContentV1Request$outboundSchema: - z.ZodType< - LibrariesDocumentsGetTextContentV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsGetTextContentV1Request - > = z.object({ - libraryId: z.string(), - documentId: z.string(), - }).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); - }); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsGetTextContentV1Request$ { - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsGetTextContentV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsGetTextContentV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsGetTextContentV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsGetTextContentV1Request$Outbound; -} - -export function librariesDocumentsGetTextContentV1RequestToJSON( - librariesDocumentsGetTextContentV1Request: - LibrariesDocumentsGetTextContentV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsGetTextContentV1Request$outboundSchema.parse( - librariesDocumentsGetTextContentV1Request, - ), - ); -} - -export function librariesDocumentsGetTextContentV1RequestFromJSON( - jsonString: string, -): SafeParseResult< - LibrariesDocumentsGetTextContentV1Request, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsGetTextContentV1Request$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'LibrariesDocumentsGetTextContentV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetv1.ts deleted file mode 100644 index 5540697b6..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsgetv1.ts +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsGetV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsGetV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsGetV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsGetV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsGetV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsGetV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsGetV1Request$ { - /** @deprecated use `LibrariesDocumentsGetV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDocumentsGetV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsGetV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesDocumentsGetV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsGetV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsGetV1Request$Outbound; -} - -export function librariesDocumentsGetV1RequestToJSON( - librariesDocumentsGetV1Request: LibrariesDocumentsGetV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsGetV1Request$outboundSchema.parse( - librariesDocumentsGetV1Request, - ), - ); -} - -export function librariesDocumentsGetV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDocumentsGetV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsGetV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentslistv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentslistv1.ts deleted file mode 100644 index 7ea878486..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentslistv1.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsListV1Request = { - libraryId: string; - search?: string | null | undefined; - pageSize?: number | undefined; - page?: number | undefined; - sortBy?: string | undefined; - sortOrder?: string | undefined; -}; - -/** @internal */ -export const LibrariesDocumentsListV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsListV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - search: z.nullable(z.string()).optional(), - page_size: z.number().int().default(100), - page: z.number().int().default(0), - sort_by: z.string().default("created_at"), - sort_order: z.string().default("desc"), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "page_size": "pageSize", - "sort_by": "sortBy", - "sort_order": "sortOrder", - }); -}); - -/** @internal */ -export type LibrariesDocumentsListV1Request$Outbound = { - library_id: string; - search?: string | null | undefined; - page_size: number; - page: number; - sort_by: string; - sort_order: string; -}; - -/** @internal */ -export const LibrariesDocumentsListV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsListV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsListV1Request -> = z.object({ - libraryId: z.string(), - search: z.nullable(z.string()).optional(), - pageSize: z.number().int().default(100), - page: z.number().int().default(0), - sortBy: z.string().default("created_at"), - sortOrder: z.string().default("desc"), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - pageSize: "page_size", - sortBy: "sort_by", - sortOrder: "sort_order", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsListV1Request$ { - /** @deprecated use `LibrariesDocumentsListV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDocumentsListV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsListV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesDocumentsListV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsListV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsListV1Request$Outbound; -} - -export function librariesDocumentsListV1RequestToJSON( - librariesDocumentsListV1Request: LibrariesDocumentsListV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsListV1Request$outboundSchema.parse( - librariesDocumentsListV1Request, - ), - ); -} - -export function librariesDocumentsListV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDocumentsListV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsListV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsreprocessv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsreprocessv1.ts deleted file mode 100644 index 0f24999d3..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsreprocessv1.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsReprocessV1Request = { - libraryId: string; - documentId: string; -}; - -/** @internal */ -export const LibrariesDocumentsReprocessV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsReprocessV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - }); -}); - -/** @internal */ -export type LibrariesDocumentsReprocessV1Request$Outbound = { - library_id: string; - document_id: string; -}; - -/** @internal */ -export const LibrariesDocumentsReprocessV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsReprocessV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsReprocessV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsReprocessV1Request$ { - /** @deprecated use `LibrariesDocumentsReprocessV1Request$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsReprocessV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsReprocessV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsReprocessV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsReprocessV1Request$Outbound; -} - -export function librariesDocumentsReprocessV1RequestToJSON( - librariesDocumentsReprocessV1Request: LibrariesDocumentsReprocessV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsReprocessV1Request$outboundSchema.parse( - librariesDocumentsReprocessV1Request, - ), - ); -} - -export function librariesDocumentsReprocessV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsReprocessV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsReprocessV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsupdatev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsupdatev1.ts deleted file mode 100644 index 83208bcb5..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsupdatev1.ts +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsUpdateV1Request = { - libraryId: string; - documentId: string; - documentUpdateIn: components.DocumentUpdateIn; -}; - -/** @internal */ -export const LibrariesDocumentsUpdateV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsUpdateV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - document_id: z.string(), - DocumentUpdateIn: components.DocumentUpdateIn$inboundSchema, -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "document_id": "documentId", - "DocumentUpdateIn": "documentUpdateIn", - }); -}); - -/** @internal */ -export type LibrariesDocumentsUpdateV1Request$Outbound = { - library_id: string; - document_id: string; - DocumentUpdateIn: components.DocumentUpdateIn$Outbound; -}; - -/** @internal */ -export const LibrariesDocumentsUpdateV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsUpdateV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsUpdateV1Request -> = z.object({ - libraryId: z.string(), - documentId: z.string(), - documentUpdateIn: components.DocumentUpdateIn$outboundSchema, -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - documentId: "document_id", - documentUpdateIn: "DocumentUpdateIn", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsUpdateV1Request$ { - /** @deprecated use `LibrariesDocumentsUpdateV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDocumentsUpdateV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsUpdateV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsUpdateV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsUpdateV1Request$Outbound; -} - -export function librariesDocumentsUpdateV1RequestToJSON( - librariesDocumentsUpdateV1Request: LibrariesDocumentsUpdateV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsUpdateV1Request$outboundSchema.parse( - librariesDocumentsUpdateV1Request, - ), - ); -} - -export function librariesDocumentsUpdateV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDocumentsUpdateV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsUpdateV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsuploadv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsuploadv1.ts deleted file mode 100644 index d847e1882..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesdocumentsuploadv1.ts +++ /dev/null @@ -1,172 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { blobLikeSchema } from "../../types/blobs.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesDocumentsUploadV1DocumentUpload = { - /** - * The File object (not file name) to be uploaded. - * - * @remarks - * To upload a file and specify a custom file name you should format your request as such: - * ```bash - * file=@path/to/your/file.jsonl;filename=custom_name.jsonl - * ``` - * Otherwise, you can just keep the original file name: - * ```bash - * file=@path/to/your/file.jsonl - * ``` - */ - file: components.FileT | Blob; -}; - -export type LibrariesDocumentsUploadV1Request = { - libraryId: string; - requestBody: LibrariesDocumentsUploadV1DocumentUpload; -}; - -/** @internal */ -export const LibrariesDocumentsUploadV1DocumentUpload$inboundSchema: z.ZodType< - LibrariesDocumentsUploadV1DocumentUpload, - z.ZodTypeDef, - unknown -> = z.object({ - file: components.FileT$inboundSchema, -}); - -/** @internal */ -export type LibrariesDocumentsUploadV1DocumentUpload$Outbound = { - file: components.FileT$Outbound | Blob; -}; - -/** @internal */ -export const LibrariesDocumentsUploadV1DocumentUpload$outboundSchema: z.ZodType< - LibrariesDocumentsUploadV1DocumentUpload$Outbound, - z.ZodTypeDef, - LibrariesDocumentsUploadV1DocumentUpload -> = z.object({ - file: components.FileT$outboundSchema.or(blobLikeSchema), -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsUploadV1DocumentUpload$ { - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$inboundSchema` instead. */ - export const inboundSchema = - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema; - /** @deprecated use `LibrariesDocumentsUploadV1DocumentUpload$Outbound` instead. */ - export type Outbound = LibrariesDocumentsUploadV1DocumentUpload$Outbound; -} - -export function librariesDocumentsUploadV1DocumentUploadToJSON( - librariesDocumentsUploadV1DocumentUpload: - LibrariesDocumentsUploadV1DocumentUpload, -): string { - return JSON.stringify( - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema.parse( - librariesDocumentsUploadV1DocumentUpload, - ), - ); -} - -export function librariesDocumentsUploadV1DocumentUploadFromJSON( - jsonString: string, -): SafeParseResult< - LibrariesDocumentsUploadV1DocumentUpload, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'LibrariesDocumentsUploadV1DocumentUpload' from JSON`, - ); -} - -/** @internal */ -export const LibrariesDocumentsUploadV1Request$inboundSchema: z.ZodType< - LibrariesDocumentsUploadV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - RequestBody: z.lazy(() => - LibrariesDocumentsUploadV1DocumentUpload$inboundSchema - ), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "RequestBody": "requestBody", - }); -}); - -/** @internal */ -export type LibrariesDocumentsUploadV1Request$Outbound = { - library_id: string; - RequestBody: LibrariesDocumentsUploadV1DocumentUpload$Outbound; -}; - -/** @internal */ -export const LibrariesDocumentsUploadV1Request$outboundSchema: z.ZodType< - LibrariesDocumentsUploadV1Request$Outbound, - z.ZodTypeDef, - LibrariesDocumentsUploadV1Request -> = z.object({ - libraryId: z.string(), - requestBody: z.lazy(() => - LibrariesDocumentsUploadV1DocumentUpload$outboundSchema - ), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - requestBody: "RequestBody", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesDocumentsUploadV1Request$ { - /** @deprecated use `LibrariesDocumentsUploadV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesDocumentsUploadV1Request$inboundSchema; - /** @deprecated use `LibrariesDocumentsUploadV1Request$outboundSchema` instead. */ - export const outboundSchema = - LibrariesDocumentsUploadV1Request$outboundSchema; - /** @deprecated use `LibrariesDocumentsUploadV1Request$Outbound` instead. */ - export type Outbound = LibrariesDocumentsUploadV1Request$Outbound; -} - -export function librariesDocumentsUploadV1RequestToJSON( - librariesDocumentsUploadV1Request: LibrariesDocumentsUploadV1Request, -): string { - return JSON.stringify( - LibrariesDocumentsUploadV1Request$outboundSchema.parse( - librariesDocumentsUploadV1Request, - ), - ); -} - -export function librariesDocumentsUploadV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesDocumentsUploadV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesDocumentsUploadV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesgetv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesgetv1.ts deleted file mode 100644 index 99c6d3196..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesgetv1.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesGetV1Request = { - libraryId: string; -}; - -/** @internal */ -export const LibrariesGetV1Request$inboundSchema: z.ZodType< - LibrariesGetV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - }); -}); - -/** @internal */ -export type LibrariesGetV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -export const LibrariesGetV1Request$outboundSchema: z.ZodType< - LibrariesGetV1Request$Outbound, - z.ZodTypeDef, - LibrariesGetV1Request -> = z.object({ - libraryId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesGetV1Request$ { - /** @deprecated use `LibrariesGetV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesGetV1Request$inboundSchema; - /** @deprecated use `LibrariesGetV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesGetV1Request$outboundSchema; - /** @deprecated use `LibrariesGetV1Request$Outbound` instead. */ - export type Outbound = LibrariesGetV1Request$Outbound; -} - -export function librariesGetV1RequestToJSON( - librariesGetV1Request: LibrariesGetV1Request, -): string { - return JSON.stringify( - LibrariesGetV1Request$outboundSchema.parse(librariesGetV1Request), - ); -} - -export function librariesGetV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesGetV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesGetV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariessharecreatev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariessharecreatev1.ts deleted file mode 100644 index 30f137c2e..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariessharecreatev1.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesShareCreateV1Request = { - libraryId: string; - sharingIn: components.SharingIn; -}; - -/** @internal */ -export const LibrariesShareCreateV1Request$inboundSchema: z.ZodType< - LibrariesShareCreateV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - SharingIn: components.SharingIn$inboundSchema, -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "SharingIn": "sharingIn", - }); -}); - -/** @internal */ -export type LibrariesShareCreateV1Request$Outbound = { - library_id: string; - SharingIn: components.SharingIn$Outbound; -}; - -/** @internal */ -export const LibrariesShareCreateV1Request$outboundSchema: z.ZodType< - LibrariesShareCreateV1Request$Outbound, - z.ZodTypeDef, - LibrariesShareCreateV1Request -> = z.object({ - libraryId: z.string(), - sharingIn: components.SharingIn$outboundSchema, -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - sharingIn: "SharingIn", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesShareCreateV1Request$ { - /** @deprecated use `LibrariesShareCreateV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesShareCreateV1Request$inboundSchema; - /** @deprecated use `LibrariesShareCreateV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesShareCreateV1Request$outboundSchema; - /** @deprecated use `LibrariesShareCreateV1Request$Outbound` instead. */ - export type Outbound = LibrariesShareCreateV1Request$Outbound; -} - -export function librariesShareCreateV1RequestToJSON( - librariesShareCreateV1Request: LibrariesShareCreateV1Request, -): string { - return JSON.stringify( - LibrariesShareCreateV1Request$outboundSchema.parse( - librariesShareCreateV1Request, - ), - ); -} - -export function librariesShareCreateV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesShareCreateV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesShareCreateV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariessharedeletev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariessharedeletev1.ts deleted file mode 100644 index 72d7de809..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariessharedeletev1.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesShareDeleteV1Request = { - libraryId: string; - sharingDelete: components.SharingDelete; -}; - -/** @internal */ -export const LibrariesShareDeleteV1Request$inboundSchema: z.ZodType< - LibrariesShareDeleteV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - SharingDelete: components.SharingDelete$inboundSchema, -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "SharingDelete": "sharingDelete", - }); -}); - -/** @internal */ -export type LibrariesShareDeleteV1Request$Outbound = { - library_id: string; - SharingDelete: components.SharingDelete$Outbound; -}; - -/** @internal */ -export const LibrariesShareDeleteV1Request$outboundSchema: z.ZodType< - LibrariesShareDeleteV1Request$Outbound, - z.ZodTypeDef, - LibrariesShareDeleteV1Request -> = z.object({ - libraryId: z.string(), - sharingDelete: components.SharingDelete$outboundSchema, -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - sharingDelete: "SharingDelete", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesShareDeleteV1Request$ { - /** @deprecated use `LibrariesShareDeleteV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesShareDeleteV1Request$inboundSchema; - /** @deprecated use `LibrariesShareDeleteV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesShareDeleteV1Request$outboundSchema; - /** @deprecated use `LibrariesShareDeleteV1Request$Outbound` instead. */ - export type Outbound = LibrariesShareDeleteV1Request$Outbound; -} - -export function librariesShareDeleteV1RequestToJSON( - librariesShareDeleteV1Request: LibrariesShareDeleteV1Request, -): string { - return JSON.stringify( - LibrariesShareDeleteV1Request$outboundSchema.parse( - librariesShareDeleteV1Request, - ), - ); -} - -export function librariesShareDeleteV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesShareDeleteV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesShareDeleteV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariessharelistv1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariessharelistv1.ts deleted file mode 100644 index 209a47ecd..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariessharelistv1.ts +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesShareListV1Request = { - libraryId: string; -}; - -/** @internal */ -export const LibrariesShareListV1Request$inboundSchema: z.ZodType< - LibrariesShareListV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - }); -}); - -/** @internal */ -export type LibrariesShareListV1Request$Outbound = { - library_id: string; -}; - -/** @internal */ -export const LibrariesShareListV1Request$outboundSchema: z.ZodType< - LibrariesShareListV1Request$Outbound, - z.ZodTypeDef, - LibrariesShareListV1Request -> = z.object({ - libraryId: z.string(), -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesShareListV1Request$ { - /** @deprecated use `LibrariesShareListV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesShareListV1Request$inboundSchema; - /** @deprecated use `LibrariesShareListV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesShareListV1Request$outboundSchema; - /** @deprecated use `LibrariesShareListV1Request$Outbound` instead. */ - export type Outbound = LibrariesShareListV1Request$Outbound; -} - -export function librariesShareListV1RequestToJSON( - librariesShareListV1Request: LibrariesShareListV1Request, -): string { - return JSON.stringify( - LibrariesShareListV1Request$outboundSchema.parse( - librariesShareListV1Request, - ), - ); -} - -export function librariesShareListV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesShareListV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesShareListV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/librariesupdatev1.ts b/examples/sdks/mistral-typescript/src/models/operations/librariesupdatev1.ts deleted file mode 100644 index 35500de55..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/librariesupdatev1.ts +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type LibrariesUpdateV1Request = { - libraryId: string; - libraryInUpdate: components.LibraryInUpdate; -}; - -/** @internal */ -export const LibrariesUpdateV1Request$inboundSchema: z.ZodType< - LibrariesUpdateV1Request, - z.ZodTypeDef, - unknown -> = z.object({ - library_id: z.string(), - LibraryInUpdate: components.LibraryInUpdate$inboundSchema, -}).transform((v) => { - return remap$(v, { - "library_id": "libraryId", - "LibraryInUpdate": "libraryInUpdate", - }); -}); - -/** @internal */ -export type LibrariesUpdateV1Request$Outbound = { - library_id: string; - LibraryInUpdate: components.LibraryInUpdate$Outbound; -}; - -/** @internal */ -export const LibrariesUpdateV1Request$outboundSchema: z.ZodType< - LibrariesUpdateV1Request$Outbound, - z.ZodTypeDef, - LibrariesUpdateV1Request -> = z.object({ - libraryId: z.string(), - libraryInUpdate: components.LibraryInUpdate$outboundSchema, -}).transform((v) => { - return remap$(v, { - libraryId: "library_id", - libraryInUpdate: "LibraryInUpdate", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace LibrariesUpdateV1Request$ { - /** @deprecated use `LibrariesUpdateV1Request$inboundSchema` instead. */ - export const inboundSchema = LibrariesUpdateV1Request$inboundSchema; - /** @deprecated use `LibrariesUpdateV1Request$outboundSchema` instead. */ - export const outboundSchema = LibrariesUpdateV1Request$outboundSchema; - /** @deprecated use `LibrariesUpdateV1Request$Outbound` instead. */ - export type Outbound = LibrariesUpdateV1Request$Outbound; -} - -export function librariesUpdateV1RequestToJSON( - librariesUpdateV1Request: LibrariesUpdateV1Request, -): string { - return JSON.stringify( - LibrariesUpdateV1Request$outboundSchema.parse(librariesUpdateV1Request), - ); -} - -export function librariesUpdateV1RequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => LibrariesUpdateV1Request$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'LibrariesUpdateV1Request' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/models/operations/retrievemodelv1modelsmodelidget.ts b/examples/sdks/mistral-typescript/src/models/operations/retrievemodelv1modelsmodelidget.ts deleted file mode 100644 index 156d09b77..000000000 --- a/examples/sdks/mistral-typescript/src/models/operations/retrievemodelv1modelsmodelidget.ts +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { safeParse } from "../../lib/schemas.js"; -import { Result as SafeParseResult } from "../../types/fp.js"; -import * as components from "../components/index.js"; -import { SDKValidationError } from "../errors/sdkvalidationerror.js"; - -export type RetrieveModelV1ModelsModelIdGetRequest = { - /** - * The ID of the model to retrieve. - */ - modelId: string; -}; - -/** - * Successful Response - */ -export type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet = - | (components.FTModelCard & { type: "fine-tuned" }) - | (components.BaseModelCard & { type: "base" }); - -/** @internal */ -export const RetrieveModelV1ModelsModelIdGetRequest$inboundSchema: z.ZodType< - RetrieveModelV1ModelsModelIdGetRequest, - z.ZodTypeDef, - unknown -> = z.object({ - model_id: z.string(), -}).transform((v) => { - return remap$(v, { - "model_id": "modelId", - }); -}); - -/** @internal */ -export type RetrieveModelV1ModelsModelIdGetRequest$Outbound = { - model_id: string; -}; - -/** @internal */ -export const RetrieveModelV1ModelsModelIdGetRequest$outboundSchema: z.ZodType< - RetrieveModelV1ModelsModelIdGetRequest$Outbound, - z.ZodTypeDef, - RetrieveModelV1ModelsModelIdGetRequest -> = z.object({ - modelId: z.string(), -}).transform((v) => { - return remap$(v, { - modelId: "model_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace RetrieveModelV1ModelsModelIdGetRequest$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$inboundSchema` instead. */ - export const inboundSchema = - RetrieveModelV1ModelsModelIdGetRequest$inboundSchema; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$outboundSchema` instead. */ - export const outboundSchema = - RetrieveModelV1ModelsModelIdGetRequest$outboundSchema; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetRequest$Outbound` instead. */ - export type Outbound = RetrieveModelV1ModelsModelIdGetRequest$Outbound; -} - -export function retrieveModelV1ModelsModelIdGetRequestToJSON( - retrieveModelV1ModelsModelIdGetRequest: - RetrieveModelV1ModelsModelIdGetRequest, -): string { - return JSON.stringify( - RetrieveModelV1ModelsModelIdGetRequest$outboundSchema.parse( - retrieveModelV1ModelsModelIdGetRequest, - ), - ); -} - -export function retrieveModelV1ModelsModelIdGetRequestFromJSON( - jsonString: string, -): SafeParseResult { - return safeParse( - jsonString, - (x) => - RetrieveModelV1ModelsModelIdGetRequest$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'RetrieveModelV1ModelsModelIdGetRequest' from JSON`, - ); -} - -/** @internal */ -export const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema: - z.ZodType< - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - z.ZodTypeDef, - unknown - > = z.union([ - components.FTModelCard$inboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - components.BaseModelCard$inboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]); - -/** @internal */ -export type RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound = - | (components.FTModelCard$Outbound & { type: "fine-tuned" }) - | (components.BaseModelCard$Outbound & { type: "base" }); - -/** @internal */ -export const RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema: - z.ZodType< - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound, - z.ZodTypeDef, - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet - > = z.union([ - components.FTModelCard$outboundSchema.and( - z.object({ type: z.literal("fine-tuned") }).transform((v) => ({ - type: v.type, - })), - ), - components.BaseModelCard$outboundSchema.and( - z.object({ type: z.literal("base") }).transform((v) => ({ - type: v.type, - })), - ), - ]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$ { - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema` instead. */ - export const inboundSchema = - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema` instead. */ - export const outboundSchema = - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema; - /** @deprecated use `RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound` instead. */ - export type Outbound = - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$Outbound; -} - -export function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetToJSON( - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet: - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, -): string { - return JSON.stringify( - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$outboundSchema - .parse( - retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - ), - ); -} - -export function retrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGetFromJSON( - jsonString: string, -): SafeParseResult< - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet, - SDKValidationError -> { - return safeParse( - jsonString, - (x) => - RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet$inboundSchema - .parse(JSON.parse(x)), - `Failed to parse 'RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet' from JSON`, - ); -} diff --git a/examples/sdks/mistral-typescript/src/sdk/accesses.ts b/examples/sdks/mistral-typescript/src/sdk/accesses.ts deleted file mode 100644 index 7d3fad96d..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/accesses.ts +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { betaLibrariesAccessesDelete } from "../funcs/betaLibrariesAccessesDelete.js"; -import { betaLibrariesAccessesList } from "../funcs/betaLibrariesAccessesList.js"; -import { betaLibrariesAccessesUpdateOrCreate } from "../funcs/betaLibrariesAccessesUpdateOrCreate.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Accesses extends ClientSDK { - /** - * List all of the access to this library. - * - * @remarks - * Given a library, list all of the Entity that have access and to what level. - */ - async list( - request: operations.LibrariesShareListV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesAccessesList( - this, - request, - options, - )); - } - - /** - * Create or update an access level. - * - * @remarks - * Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - */ - async updateOrCreate( - request: operations.LibrariesShareCreateV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesAccessesUpdateOrCreate( - this, - request, - options, - )); - } - - /** - * Delete an access level. - * - * @remarks - * Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - */ - async delete( - request: operations.LibrariesShareDeleteV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesAccessesDelete( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/agents.ts b/examples/sdks/mistral-typescript/src/sdk/agents.ts deleted file mode 100644 index bcf9b5702..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/agents.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { agentsComplete } from "../funcs/agentsComplete.js"; -import { agentsStream } from "../funcs/agentsStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Agents extends ClientSDK { - /** - * Agents Completion - */ - async complete( - request: components.AgentsCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(agentsComplete( - this, - request, - options, - )); - } - - /** - * Stream Agents completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.AgentsCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(agentsStream( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/audio.ts b/examples/sdks/mistral-typescript/src/sdk/audio.ts deleted file mode 100644 index 3c2a1debd..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/audio.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "../lib/sdks.js"; -import { Transcriptions } from "./transcriptions.js"; - -export class Audio extends ClientSDK { - private _transcriptions?: Transcriptions; - get transcriptions(): Transcriptions { - return (this._transcriptions ??= new Transcriptions(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/batch.ts b/examples/sdks/mistral-typescript/src/sdk/batch.ts deleted file mode 100644 index d8a7c67ff..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/batch.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "../lib/sdks.js"; -import { MistralJobs } from "./mistraljobs.js"; - -export class Batch extends ClientSDK { - private _jobs?: MistralJobs; - get jobs(): MistralJobs { - return (this._jobs ??= new MistralJobs(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/beta.ts b/examples/sdks/mistral-typescript/src/sdk/beta.ts deleted file mode 100644 index 1fce78436..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/beta.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "../lib/sdks.js"; -import { Conversations } from "./conversations.js"; -import { Libraries } from "./libraries.js"; -import { MistralAgents } from "./mistralagents.js"; - -export class Beta extends ClientSDK { - private _conversations?: Conversations; - get conversations(): Conversations { - return (this._conversations ??= new Conversations(this._options)); - } - - private _agents?: MistralAgents; - get agents(): MistralAgents { - return (this._agents ??= new MistralAgents(this._options)); - } - - private _libraries?: Libraries; - get libraries(): Libraries { - return (this._libraries ??= new Libraries(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/chat.ts b/examples/sdks/mistral-typescript/src/sdk/chat.ts deleted file mode 100644 index 2b7bf975a..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/chat.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { chatComplete } from "../funcs/chatComplete.js"; -import { chatStream } from "../funcs/chatStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; -// #region imports -import { z } from "zod"; -import { - convertToParsedChatCompletionResponse, - ParsedChatCompletionRequest, - ParsedChatCompletionResponse, - transformToChatCompletionRequest, -} from "../extra/structChat.js"; -// #endregion imports - -export class Chat extends ClientSDK { - // #region sdk-class-body - /** - * Chat Completion with the response parsed in the same format as the input requestFormat. - * - * @remarks - * The response will be parsed back to the initial Zod object passed in the requestFormat field. - */ - async parse( - request: ParsedChatCompletionRequest, - options?: RequestOptions, - ): Promise> { - const ccr_request = transformToChatCompletionRequest(request); - const response = await unwrapAsync(chatComplete( - this, - ccr_request, - options, - )); - const parsed_response = convertToParsedChatCompletionResponse( - response, - request.responseFormat, - ); - return parsed_response; - } - - /** - * Stream chat completion with a parsed request input. - * - * @remarks - * Unlike the .parse method, this method will return a stream of events containing the JSON response. It will not be parsed back to the initial Zod object. - * If you need to parse the stream, see the examples/src/async_structured_outputs.ts file. - */ - async parseStream( - request: ParsedChatCompletionRequest, - options?: RequestOptions, - ): Promise> { - const ccr_request = transformToChatCompletionRequest(request); - return unwrapAsync(chatStream( - this, - ccr_request, - options, - )); - } - // #endregion sdk-class-body - - /** - * Chat Completion - */ - async complete( - request: components.ChatCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(chatComplete( - this, - request, - options, - )); - } - - /** - * Stream chat completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.ChatCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(chatStream( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/classifiers.ts b/examples/sdks/mistral-typescript/src/sdk/classifiers.ts deleted file mode 100644 index 1a4d00b07..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/classifiers.ts +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { classifiersClassify } from "../funcs/classifiersClassify.js"; -import { classifiersClassifyChat } from "../funcs/classifiersClassifyChat.js"; -import { classifiersModerate } from "../funcs/classifiersModerate.js"; -import { classifiersModerateChat } from "../funcs/classifiersModerateChat.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Classifiers extends ClientSDK { - /** - * Moderations - */ - async moderate( - request: components.ClassificationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(classifiersModerate( - this, - request, - options, - )); - } - - /** - * Chat Moderations - */ - async moderateChat( - request: components.ChatModerationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(classifiersModerateChat( - this, - request, - options, - )); - } - - /** - * Classifications - */ - async classify( - request: components.ClassificationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(classifiersClassify( - this, - request, - options, - )); - } - - /** - * Chat Classifications - */ - async classifyChat( - request: components.ChatClassificationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(classifiersClassifyChat( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/conversations.ts b/examples/sdks/mistral-typescript/src/sdk/conversations.ts deleted file mode 100644 index 645a16264..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/conversations.ts +++ /dev/null @@ -1,191 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { betaConversationsAppend } from "../funcs/betaConversationsAppend.js"; -import { betaConversationsAppendStream } from "../funcs/betaConversationsAppendStream.js"; -import { betaConversationsGet } from "../funcs/betaConversationsGet.js"; -import { betaConversationsGetHistory } from "../funcs/betaConversationsGetHistory.js"; -import { betaConversationsGetMessages } from "../funcs/betaConversationsGetMessages.js"; -import { betaConversationsList } from "../funcs/betaConversationsList.js"; -import { betaConversationsRestart } from "../funcs/betaConversationsRestart.js"; -import { betaConversationsRestartStream } from "../funcs/betaConversationsRestartStream.js"; -import { betaConversationsStart } from "../funcs/betaConversationsStart.js"; -import { betaConversationsStartStream } from "../funcs/betaConversationsStartStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Conversations extends ClientSDK { - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async start( - request: components.ConversationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsStart( - this, - request, - options, - )); - } - - /** - * List all created conversations. - * - * @remarks - * Retrieve a list of conversation entities sorted by creation time. - */ - async list( - request?: operations.AgentsApiV1ConversationsListRequest | undefined, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(betaConversationsList( - this, - request, - options, - )); - } - - /** - * Retrieve a conversation information. - * - * @remarks - * Given a conversation_id retrieve a conversation entity with its attributes. - */ - async get( - request: operations.AgentsApiV1ConversationsGetRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsGet( - this, - request, - options, - )); - } - - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async append( - request: operations.AgentsApiV1ConversationsAppendRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsAppend( - this, - request, - options, - )); - } - - /** - * Retrieve all entries in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - */ - async getHistory( - request: operations.AgentsApiV1ConversationsHistoryRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsGetHistory( - this, - request, - options, - )); - } - - /** - * Retrieve all messages in a conversation. - * - * @remarks - * Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - */ - async getMessages( - request: operations.AgentsApiV1ConversationsMessagesRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsGetMessages( - this, - request, - options, - )); - } - - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restart( - request: operations.AgentsApiV1ConversationsRestartRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaConversationsRestart( - this, - request, - options, - )); - } - - /** - * Create a conversation and append entries to it. - * - * @remarks - * Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - */ - async startStream( - request: components.ConversationStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(betaConversationsStartStream( - this, - request, - options, - )); - } - - /** - * Append new entries to an existing conversation. - * - * @remarks - * Run completion on the history of the conversation and the user entries. Return the new created entries. - */ - async appendStream( - request: operations.AgentsApiV1ConversationsAppendStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(betaConversationsAppendStream( - this, - request, - options, - )); - } - - /** - * Restart a conversation starting from a given entry. - * - * @remarks - * Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - */ - async restartStream( - request: operations.AgentsApiV1ConversationsRestartStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(betaConversationsRestartStream( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/documents.ts b/examples/sdks/mistral-typescript/src/sdk/documents.ts deleted file mode 100644 index 6a5418f78..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/documents.ts +++ /dev/null @@ -1,190 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { betaLibrariesDocumentsDelete } from "../funcs/betaLibrariesDocumentsDelete.js"; -import { betaLibrariesDocumentsExtractedTextSignedUrl } from "../funcs/betaLibrariesDocumentsExtractedTextSignedUrl.js"; -import { betaLibrariesDocumentsGet } from "../funcs/betaLibrariesDocumentsGet.js"; -import { betaLibrariesDocumentsGetSignedUrl } from "../funcs/betaLibrariesDocumentsGetSignedUrl.js"; -import { betaLibrariesDocumentsList } from "../funcs/betaLibrariesDocumentsList.js"; -import { betaLibrariesDocumentsReprocess } from "../funcs/betaLibrariesDocumentsReprocess.js"; -import { betaLibrariesDocumentsStatus } from "../funcs/betaLibrariesDocumentsStatus.js"; -import { betaLibrariesDocumentsTextContent } from "../funcs/betaLibrariesDocumentsTextContent.js"; -import { betaLibrariesDocumentsUpdate } from "../funcs/betaLibrariesDocumentsUpdate.js"; -import { betaLibrariesDocumentsUpload } from "../funcs/betaLibrariesDocumentsUpload.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Documents extends ClientSDK { - /** - * List document in a given library. - * - * @remarks - * Given a library, lists the document that have been uploaded to that library. - */ - async list( - request: operations.LibrariesDocumentsListV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsList( - this, - request, - options, - )); - } - - /** - * Upload a new document. - * - * @remarks - * Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - */ - async upload( - request: operations.LibrariesDocumentsUploadV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsUpload( - this, - request, - options, - )); - } - - /** - * Retrieve the metadata of a specific document. - * - * @remarks - * Given a library and a document in this library, you can retrieve the metadata of that document. - */ - async get( - request: operations.LibrariesDocumentsGetV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsGet( - this, - request, - options, - )); - } - - /** - * Update the metadata of a specific document. - * - * @remarks - * Given a library and a document in that library, update the name of that document. - */ - async update( - request: operations.LibrariesDocumentsUpdateV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsUpdate( - this, - request, - options, - )); - } - - /** - * Delete a document. - * - * @remarks - * Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - */ - async delete( - request: operations.LibrariesDocumentsDeleteV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsDelete( - this, - request, - options, - )); - } - - /** - * Retrieve the text content of a specific document. - * - * @remarks - * Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - */ - async textContent( - request: operations.LibrariesDocumentsGetTextContentV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsTextContent( - this, - request, - options, - )); - } - - /** - * Retrieve the processing status of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the processing status of that document. - */ - async status( - request: operations.LibrariesDocumentsGetStatusV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsStatus( - this, - request, - options, - )); - } - - /** - * Retrieve the signed URL of a specific document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - */ - async getSignedUrl( - request: operations.LibrariesDocumentsGetSignedUrlV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsGetSignedUrl( - this, - request, - options, - )); - } - - /** - * Retrieve the signed URL of text extracted from a given document. - * - * @remarks - * Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - */ - async extractedTextSignedUrl( - request: operations.LibrariesDocumentsGetExtractedTextSignedUrlV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsExtractedTextSignedUrl( - this, - request, - options, - )); - } - - /** - * Reprocess a document. - * - * @remarks - * Given a library and a document in that library, reprocess that document, it will be billed again. - */ - async reprocess( - request: operations.LibrariesDocumentsReprocessV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDocumentsReprocess( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/embeddings.ts b/examples/sdks/mistral-typescript/src/sdk/embeddings.ts deleted file mode 100644 index d48696501..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/embeddings.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { embeddingsCreate } from "../funcs/embeddingsCreate.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Embeddings extends ClientSDK { - /** - * Embeddings - * - * @remarks - * Embeddings - */ - async create( - request: components.EmbeddingRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(embeddingsCreate( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/files.ts b/examples/sdks/mistral-typescript/src/sdk/files.ts deleted file mode 100644 index b898431e4..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/files.ts +++ /dev/null @@ -1,119 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { filesDelete } from "../funcs/filesDelete.js"; -import { filesDownload } from "../funcs/filesDownload.js"; -import { filesGetSignedUrl } from "../funcs/filesGetSignedUrl.js"; -import { filesList } from "../funcs/filesList.js"; -import { filesRetrieve } from "../funcs/filesRetrieve.js"; -import { filesUpload } from "../funcs/filesUpload.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Files extends ClientSDK { - /** - * Upload File - * - * @remarks - * Upload a file that can be used across various endpoints. - * - * The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - * - * Please contact us if you need to increase these storage limits. - */ - async upload( - request: operations.FilesApiRoutesUploadFileMultiPartBodyParams, - options?: RequestOptions, - ): Promise { - return unwrapAsync(filesUpload( - this, - request, - options, - )); - } - - /** - * List Files - * - * @remarks - * Returns a list of files that belong to the user's organization. - */ - async list( - request?: operations.FilesApiRoutesListFilesRequest | undefined, - options?: RequestOptions, - ): Promise { - return unwrapAsync(filesList( - this, - request, - options, - )); - } - - /** - * Retrieve File - * - * @remarks - * Returns information about a specific file. - */ - async retrieve( - request: operations.FilesApiRoutesRetrieveFileRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(filesRetrieve( - this, - request, - options, - )); - } - - /** - * Delete File - * - * @remarks - * Delete a file. - */ - async delete( - request: operations.FilesApiRoutesDeleteFileRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(filesDelete( - this, - request, - options, - )); - } - - /** - * Download File - * - * @remarks - * Download a file - */ - async download( - request: operations.FilesApiRoutesDownloadFileRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(filesDownload( - this, - request, - options, - )); - } - - /** - * Get Signed Url - */ - async getSignedUrl( - request: operations.FilesApiRoutesGetSignedUrlRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(filesGetSignedUrl( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/fim.ts b/examples/sdks/mistral-typescript/src/sdk/fim.ts deleted file mode 100644 index 7f095095c..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/fim.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { fimComplete } from "../funcs/fimComplete.js"; -import { fimStream } from "../funcs/fimStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Fim extends ClientSDK { - /** - * Fim Completion - * - * @remarks - * FIM completion. - */ - async complete( - request: components.FIMCompletionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fimComplete( - this, - request, - options, - )); - } - - /** - * Stream fim completion - * - * @remarks - * Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - */ - async stream( - request: components.FIMCompletionStreamRequest, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(fimStream( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/finetuning.ts b/examples/sdks/mistral-typescript/src/sdk/finetuning.ts deleted file mode 100644 index a5fbc837e..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/finetuning.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "../lib/sdks.js"; -import { Jobs } from "./jobs.js"; - -export class FineTuning extends ClientSDK { - private _jobs?: Jobs; - get jobs(): Jobs { - return (this._jobs ??= new Jobs(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/index.ts b/examples/sdks/mistral-typescript/src/sdk/index.ts deleted file mode 100644 index ecac22648..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export * from "./sdk.js"; diff --git a/examples/sdks/mistral-typescript/src/sdk/jobs.ts b/examples/sdks/mistral-typescript/src/sdk/jobs.ts deleted file mode 100644 index daa6c75ca..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/jobs.ts +++ /dev/null @@ -1,102 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { fineTuningJobsCancel } from "../funcs/fineTuningJobsCancel.js"; -import { fineTuningJobsCreate } from "../funcs/fineTuningJobsCreate.js"; -import { fineTuningJobsGet } from "../funcs/fineTuningJobsGet.js"; -import { fineTuningJobsList } from "../funcs/fineTuningJobsList.js"; -import { fineTuningJobsStart } from "../funcs/fineTuningJobsStart.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Jobs extends ClientSDK { - /** - * Get Fine Tuning Jobs - * - * @remarks - * Get a list of fine-tuning jobs for your organization and user. - */ - async list( - request?: - | operations.JobsApiRoutesFineTuningGetFineTuningJobsRequest - | undefined, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fineTuningJobsList( - this, - request, - options, - )); - } - - /** - * Create Fine Tuning Job - * - * @remarks - * Create a new fine-tuning job, it will be queued for processing. - */ - async create( - request: components.JobIn, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fineTuningJobsCreate( - this, - request, - options, - )); - } - - /** - * Get Fine Tuning Job - * - * @remarks - * Get a fine-tuned job details by its UUID. - */ - async get( - request: operations.JobsApiRoutesFineTuningGetFineTuningJobRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fineTuningJobsGet( - this, - request, - options, - )); - } - - /** - * Cancel Fine Tuning Job - * - * @remarks - * Request the cancellation of a fine tuning job. - */ - async cancel( - request: operations.JobsApiRoutesFineTuningCancelFineTuningJobRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fineTuningJobsCancel( - this, - request, - options, - )); - } - - /** - * Start Fine Tuning Job - * - * @remarks - * Request the start of a validated fine tuning job. - */ - async start( - request: operations.JobsApiRoutesFineTuningStartFineTuningJobRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(fineTuningJobsStart( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/libraries.ts b/examples/sdks/mistral-typescript/src/sdk/libraries.ts deleted file mode 100644 index 2174a1604..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/libraries.ts +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { betaLibrariesCreate } from "../funcs/betaLibrariesCreate.js"; -import { betaLibrariesDelete } from "../funcs/betaLibrariesDelete.js"; -import { betaLibrariesGet } from "../funcs/betaLibrariesGet.js"; -import { betaLibrariesList } from "../funcs/betaLibrariesList.js"; -import { betaLibrariesUpdate } from "../funcs/betaLibrariesUpdate.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; -import { Accesses } from "./accesses.js"; -import { Documents } from "./documents.js"; - -export class Libraries extends ClientSDK { - private _documents?: Documents; - get documents(): Documents { - return (this._documents ??= new Documents(this._options)); - } - - private _accesses?: Accesses; - get accesses(): Accesses { - return (this._accesses ??= new Accesses(this._options)); - } - - /** - * List all libraries you have access to. - * - * @remarks - * List all libraries that you have created or have been shared with you. - */ - async list( - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesList( - this, - options, - )); - } - - /** - * Create a new Library. - * - * @remarks - * Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - */ - async create( - request: components.LibraryIn, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesCreate( - this, - request, - options, - )); - } - - /** - * Detailed information about a specific Library. - * - * @remarks - * Given a library id, details information about that Library. - */ - async get( - request: operations.LibrariesGetV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesGet( - this, - request, - options, - )); - } - - /** - * Delete a library and all of it's document. - * - * @remarks - * Given a library id, deletes it together with all documents that have been uploaded to that library. - */ - async delete( - request: operations.LibrariesDeleteV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesDelete( - this, - request, - options, - )); - } - - /** - * Update a library. - * - * @remarks - * Given a library id, you can update the name and description. - */ - async update( - request: operations.LibrariesUpdateV1Request, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaLibrariesUpdate( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/mistralagents.ts b/examples/sdks/mistral-typescript/src/sdk/mistralagents.ts deleted file mode 100644 index 00df09c9c..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/mistralagents.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { betaAgentsCreate } from "../funcs/betaAgentsCreate.js"; -import { betaAgentsGet } from "../funcs/betaAgentsGet.js"; -import { betaAgentsList } from "../funcs/betaAgentsList.js"; -import { betaAgentsUpdate } from "../funcs/betaAgentsUpdate.js"; -import { betaAgentsUpdateVersion } from "../funcs/betaAgentsUpdateVersion.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class MistralAgents extends ClientSDK { - /** - * Create a agent that can be used within a conversation. - * - * @remarks - * Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - */ - async create( - request: components.AgentCreationRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaAgentsCreate( - this, - request, - options, - )); - } - - /** - * List agent entities. - * - * @remarks - * Retrieve a list of agent entities sorted by creation time. - */ - async list( - request?: operations.AgentsApiV1AgentsListRequest | undefined, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(betaAgentsList( - this, - request, - options, - )); - } - - /** - * Retrieve an agent entity. - * - * @remarks - * Given an agent retrieve an agent entity with its attributes. - */ - async get( - request: operations.AgentsApiV1AgentsGetRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaAgentsGet( - this, - request, - options, - )); - } - - /** - * Update an agent entity. - * - * @remarks - * Update an agent attributes and create a new version. - */ - async update( - request: operations.AgentsApiV1AgentsUpdateRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaAgentsUpdate( - this, - request, - options, - )); - } - - /** - * Update an agent version. - * - * @remarks - * Switch the version of an agent. - */ - async updateVersion( - request: operations.AgentsApiV1AgentsUpdateVersionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(betaAgentsUpdateVersion( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/mistraljobs.ts b/examples/sdks/mistral-typescript/src/sdk/mistraljobs.ts deleted file mode 100644 index 921aae96b..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/mistraljobs.ts +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { batchJobsCancel } from "../funcs/batchJobsCancel.js"; -import { batchJobsCreate } from "../funcs/batchJobsCreate.js"; -import { batchJobsGet } from "../funcs/batchJobsGet.js"; -import { batchJobsList } from "../funcs/batchJobsList.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class MistralJobs extends ClientSDK { - /** - * Get Batch Jobs - * - * @remarks - * Get a list of batch jobs for your organization and user. - */ - async list( - request?: operations.JobsApiRoutesBatchGetBatchJobsRequest | undefined, - options?: RequestOptions, - ): Promise { - return unwrapAsync(batchJobsList( - this, - request, - options, - )); - } - - /** - * Create Batch Job - * - * @remarks - * Create a new batch job, it will be queued for processing. - */ - async create( - request: components.BatchJobIn, - options?: RequestOptions, - ): Promise { - return unwrapAsync(batchJobsCreate( - this, - request, - options, - )); - } - - /** - * Get Batch Job - * - * @remarks - * Get a batch job details by its UUID. - */ - async get( - request: operations.JobsApiRoutesBatchGetBatchJobRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(batchJobsGet( - this, - request, - options, - )); - } - - /** - * Cancel Batch Job - * - * @remarks - * Request the cancellation of a batch job. - */ - async cancel( - request: operations.JobsApiRoutesBatchCancelBatchJobRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(batchJobsCancel( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/models.ts b/examples/sdks/mistral-typescript/src/sdk/models.ts deleted file mode 100644 index caf6db4a4..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/models.ts +++ /dev/null @@ -1,118 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { modelsArchive } from "../funcs/modelsArchive.js"; -import { modelsDelete } from "../funcs/modelsDelete.js"; -import { modelsList } from "../funcs/modelsList.js"; -import { modelsRetrieve } from "../funcs/modelsRetrieve.js"; -import { modelsUnarchive } from "../funcs/modelsUnarchive.js"; -import { modelsUpdate } from "../funcs/modelsUpdate.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import * as operations from "../models/operations/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Models extends ClientSDK { - /** - * List Models - * - * @remarks - * List all models available to the user. - */ - async list( - options?: RequestOptions, - ): Promise { - return unwrapAsync(modelsList( - this, - options, - )); - } - - /** - * Retrieve Model - * - * @remarks - * Retrieve information about a model. - */ - async retrieve( - request: operations.RetrieveModelV1ModelsModelIdGetRequest, - options?: RequestOptions, - ): Promise< - operations.RetrieveModelV1ModelsModelIdGetResponseRetrieveModelV1ModelsModelIdGet - > { - return unwrapAsync(modelsRetrieve( - this, - request, - options, - )); - } - - /** - * Delete Model - * - * @remarks - * Delete a fine-tuned model. - */ - async delete( - request: operations.DeleteModelV1ModelsModelIdDeleteRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(modelsDelete( - this, - request, - options, - )); - } - - /** - * Update Fine Tuned Model - * - * @remarks - * Update a model name or description. - */ - async update( - request: operations.JobsApiRoutesFineTuningUpdateFineTunedModelRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(modelsUpdate( - this, - request, - options, - )); - } - - /** - * Archive Fine Tuned Model - * - * @remarks - * Archive a fine-tuned model. - */ - async archive( - request: operations.JobsApiRoutesFineTuningArchiveFineTunedModelRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(modelsArchive( - this, - request, - options, - )); - } - - /** - * Unarchive Fine Tuned Model - * - * @remarks - * Un-archive a fine-tuned model. - */ - async unarchive( - request: operations.JobsApiRoutesFineTuningUnarchiveFineTunedModelRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(modelsUnarchive( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/ocr.ts b/examples/sdks/mistral-typescript/src/sdk/ocr.ts deleted file mode 100644 index 7a36105d9..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/ocr.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ocrProcess } from "../funcs/ocrProcess.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Ocr extends ClientSDK { - /** - * OCR - */ - async process( - request: components.OCRRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(ocrProcess( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/oldclient.ts b/examples/sdks/mistral-typescript/src/sdk/oldclient.ts deleted file mode 100644 index 1d4e28103..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/oldclient.ts +++ /dev/null @@ -1,5 +0,0 @@ -export class MistralClient { - constructor(_apiKey: string) { - throw new Error('This client is deprecated starting v1.0.0, pin your version to 0.4.2. Or migrate by following this documentation: TODO add link'); - } -} \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/src/sdk/sdk.ts b/examples/sdks/mistral-typescript/src/sdk/sdk.ts deleted file mode 100644 index 5adfc54c8..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/sdk.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { ClientSDK } from "../lib/sdks.js"; -import { Agents } from "./agents.js"; -import { Audio } from "./audio.js"; -import { Batch } from "./batch.js"; -import { Beta } from "./beta.js"; -import { Chat } from "./chat.js"; -import { Classifiers } from "./classifiers.js"; -import { Embeddings } from "./embeddings.js"; -import { Files } from "./files.js"; -import { Fim } from "./fim.js"; -import { FineTuning } from "./finetuning.js"; -import { Models } from "./models.js"; -import { Ocr } from "./ocr.js"; - -export class Mistral extends ClientSDK { - private _models?: Models; - get models(): Models { - return (this._models ??= new Models(this._options)); - } - - private _beta?: Beta; - get beta(): Beta { - return (this._beta ??= new Beta(this._options)); - } - - private _files?: Files; - get files(): Files { - return (this._files ??= new Files(this._options)); - } - - private _fineTuning?: FineTuning; - get fineTuning(): FineTuning { - return (this._fineTuning ??= new FineTuning(this._options)); - } - - private _batch?: Batch; - get batch(): Batch { - return (this._batch ??= new Batch(this._options)); - } - - private _chat?: Chat; - get chat(): Chat { - return (this._chat ??= new Chat(this._options)); - } - - private _fim?: Fim; - get fim(): Fim { - return (this._fim ??= new Fim(this._options)); - } - - private _agents?: Agents; - get agents(): Agents { - return (this._agents ??= new Agents(this._options)); - } - - private _embeddings?: Embeddings; - get embeddings(): Embeddings { - return (this._embeddings ??= new Embeddings(this._options)); - } - - private _classifiers?: Classifiers; - get classifiers(): Classifiers { - return (this._classifiers ??= new Classifiers(this._options)); - } - - private _ocr?: Ocr; - get ocr(): Ocr { - return (this._ocr ??= new Ocr(this._options)); - } - - private _audio?: Audio; - get audio(): Audio { - return (this._audio ??= new Audio(this._options)); - } -} diff --git a/examples/sdks/mistral-typescript/src/sdk/transcriptions.ts b/examples/sdks/mistral-typescript/src/sdk/transcriptions.ts deleted file mode 100644 index 53cd5e8df..000000000 --- a/examples/sdks/mistral-typescript/src/sdk/transcriptions.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { audioTranscriptionsComplete } from "../funcs/audioTranscriptionsComplete.js"; -import { audioTranscriptionsStream } from "../funcs/audioTranscriptionsStream.js"; -import { EventStream } from "../lib/event-streams.js"; -import { ClientSDK, RequestOptions } from "../lib/sdks.js"; -import * as components from "../models/components/index.js"; -import { unwrapAsync } from "../types/fp.js"; - -export class Transcriptions extends ClientSDK { - /** - * Create Transcription - */ - async complete( - request: components.AudioTranscriptionRequest, - options?: RequestOptions, - ): Promise { - return unwrapAsync(audioTranscriptionsComplete( - this, - request, - options, - )); - } - - /** - * Create streaming transcription (SSE) - */ - async stream( - request: components.AudioTranscriptionRequestStream, - options?: RequestOptions, - ): Promise> { - return unwrapAsync(audioTranscriptionsStream( - this, - request, - options, - )); - } -} diff --git a/examples/sdks/mistral-typescript/src/types/async.ts b/examples/sdks/mistral-typescript/src/types/async.ts deleted file mode 100644 index 689dba5de..000000000 --- a/examples/sdks/mistral-typescript/src/types/async.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export type APICall = - | { - status: "complete"; - request: Request; - response: Response; - } - | { - status: "request-error"; - request: Request; - response?: undefined; - } - | { - status: "invalid"; - request?: undefined; - response?: undefined; - }; - -export class APIPromise implements Promise { - readonly #promise: Promise<[T, APICall]>; - readonly #unwrapped: Promise; - - readonly [Symbol.toStringTag] = "APIPromise"; - - constructor(p: [T, APICall] | Promise<[T, APICall]>) { - this.#promise = p instanceof Promise ? p : Promise.resolve(p); - this.#unwrapped = - p instanceof Promise - ? this.#promise.then(([value]) => value) - : Promise.resolve(p[0]); - } - - then( - onfulfilled?: - | ((value: T) => TResult1 | PromiseLike) - | null - | undefined, - onrejected?: - | ((reason: any) => TResult2 | PromiseLike) - | null - | undefined, - ): Promise { - return this.#promise.then( - onfulfilled ? ([value]) => onfulfilled(value) : void 0, - onrejected, - ); - } - - catch( - onrejected?: - | ((reason: any) => TResult | PromiseLike) - | null - | undefined, - ): Promise { - return this.#unwrapped.catch(onrejected); - } - - finally(onfinally?: (() => void) | null | undefined): Promise { - return this.#unwrapped.finally(onfinally); - } - - $inspect(): Promise<[T, APICall]> { - return this.#promise; - } -} diff --git a/examples/sdks/mistral-typescript/src/types/blobs.ts b/examples/sdks/mistral-typescript/src/types/blobs.ts deleted file mode 100644 index 4ce846023..000000000 --- a/examples/sdks/mistral-typescript/src/types/blobs.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export const blobLikeSchema: z.ZodType = - z.custom(isBlobLike, { - message: "expected a Blob, File or Blob-like object", - fatal: true, - }); - -export function isBlobLike(val: unknown): val is Blob { - if (val instanceof Blob) { - return true; - } - - if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { - return false; - } - - const name = val[Symbol.toStringTag]; - if (typeof name !== "string") { - return false; - } - if (name !== "Blob" && name !== "File") { - return false; - } - - return "stream" in val && typeof val.stream === "function"; -} diff --git a/examples/sdks/mistral-typescript/src/types/constdatetime.ts b/examples/sdks/mistral-typescript/src/types/constdatetime.ts deleted file mode 100644 index eeff4dde2..000000000 --- a/examples/sdks/mistral-typescript/src/types/constdatetime.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export function constDateTime( - val: string, -): z.ZodType { - return z.custom((v) => { - return ( - typeof v === "string" && new Date(v).getTime() === new Date(val).getTime() - ); - }, `Value must be equivalent to ${val}`); -} diff --git a/examples/sdks/mistral-typescript/src/types/enums.ts b/examples/sdks/mistral-typescript/src/types/enums.ts deleted file mode 100644 index 6fb6d9109..000000000 --- a/examples/sdks/mistral-typescript/src/types/enums.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -declare const __brand: unique symbol; -export type Unrecognized = T & { [__brand]: "unrecognized" }; - -export function catchUnrecognizedEnum(value: T): Unrecognized { - return value as Unrecognized; -} - -type Prettify = { [K in keyof T]: T[K] } & {}; -export type ClosedEnum = T[keyof T]; -export type OpenEnum = - | Prettify - | Unrecognized; diff --git a/examples/sdks/mistral-typescript/src/types/fp.ts b/examples/sdks/mistral-typescript/src/types/fp.ts deleted file mode 100644 index ccbe51eac..000000000 --- a/examples/sdks/mistral-typescript/src/types/fp.ts +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -/** - * A monad that captures the result of a function call or an error if it was not - * successful. Railway programming, enabled by this type, can be a nicer - * alternative to traditional exception throwing because it allows functions to - * declare all _known_ errors with static types and then check for them - * exhaustively in application code. Thrown exception have a type of `unknown` - * and break out of regular control flow of programs making them harder to - * inspect and more verbose work with due to try-catch blocks. - */ -export type Result = - | { ok: true; value: T; error?: never } - | { ok: false; value?: never; error: E }; - -export function OK(value: V): Result { - return { ok: true, value }; -} - -export function ERR(error: E): Result { - return { ok: false, error }; -} - -/** - * unwrap is a convenience function for extracting a value from a result or - * throwing if there was an error. - */ -export function unwrap(r: Result): T { - if (!r.ok) { - throw r.error; - } - return r.value; -} - -/** - * unwrapAsync is a convenience function for resolving a value from a Promise - * of a result or rejecting if an error occurred. - */ -export async function unwrapAsync( - pr: Promise>, -): Promise { - const r = await pr; - if (!r.ok) { - throw r.error; - } - - return r.value; -} diff --git a/examples/sdks/mistral-typescript/src/types/index.ts b/examples/sdks/mistral-typescript/src/types/index.ts deleted file mode 100644 index e124e817b..000000000 --- a/examples/sdks/mistral-typescript/src/types/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export { blobLikeSchema, isBlobLike } from "./blobs.js"; -export { catchUnrecognizedEnum } from "./enums.js"; -export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js"; -export type { Result } from "./fp.js"; -export type { PageIterator, Paginator } from "./operations.js"; -export { createPageIterator } from "./operations.js"; -export { RFCDate } from "./rfcdate.js"; diff --git a/examples/sdks/mistral-typescript/src/types/operations.ts b/examples/sdks/mistral-typescript/src/types/operations.ts deleted file mode 100644 index beb81e10f..000000000 --- a/examples/sdks/mistral-typescript/src/types/operations.ts +++ /dev/null @@ -1,105 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import { Result } from "./fp.js"; - -export type Paginator = () => Promise }> | null; - -export type PageIterator = V & { - next: Paginator; - [Symbol.asyncIterator]: () => AsyncIterableIterator; - "~next"?: PageState | undefined; -}; - -export function createPageIterator( - page: V & { next: Paginator }, - halt: (v: V) => boolean, -): { - [Symbol.asyncIterator]: () => AsyncIterableIterator; -} { - return { - [Symbol.asyncIterator]: async function* paginator() { - yield page; - if (halt(page)) { - return; - } - - let p: typeof page | null = page; - for (p = await p.next(); p != null; p = await p.next()) { - yield p; - if (halt(p)) { - return; - } - } - }, - }; -} - -/** - * This utility create a special iterator that yields a single value and - * terminates. It is useful in paginated SDK functions that have early return - * paths when things go wrong. - */ -export function haltIterator( - v: V, -): PageIterator { - return { - ...v, - next: () => null, - [Symbol.asyncIterator]: async function* paginator() { - yield v; - }, - }; -} - -/** - * Converts an async iterator of `Result` into an async iterator of `V`. - * When error results occur, the underlying error value is thrown. - */ -export async function unwrapResultIterator( - iteratorPromise: Promise, PageState>>, -): Promise> { - const resultIter = await iteratorPromise; - - if (!resultIter.ok) { - throw resultIter.error; - } - - return { - ...resultIter.value, - next: unwrapPaginator(resultIter.next), - "~next": resultIter["~next"], - [Symbol.asyncIterator]: async function* paginator() { - for await (const page of resultIter) { - if (!page.ok) { - throw page.error; - } - yield page.value; - } - }, - }; -} - -function unwrapPaginator( - paginator: Paginator>, -): Paginator { - return () => { - const nextResult = paginator(); - if (nextResult == null) { - return null; - } - return nextResult.then((res) => { - if (!res.ok) { - throw res.error; - } - const out = { - ...res.value, - next: unwrapPaginator(res.next), - }; - return out; - }); - }; -} - -export const URL_OVERRIDE = Symbol("URL_OVERRIDE"); diff --git a/examples/sdks/mistral-typescript/src/types/rfcdate.ts b/examples/sdks/mistral-typescript/src/types/rfcdate.ts deleted file mode 100644 index c79b3f53a..000000000 --- a/examples/sdks/mistral-typescript/src/types/rfcdate.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -const dateRE = /^\d{4}-\d{2}-\d{2}$/; - -export class RFCDate { - private serialized: string; - - /** - * Creates a new RFCDate instance using today's date. - */ - static today(): RFCDate { - return new RFCDate(new Date()); - } - - /** - * Creates a new RFCDate instance using the provided input. - * If a string is used then in must be in the format YYYY-MM-DD. - * - * @param date A Date object or a date string in YYYY-MM-DD format - * @example - * new RFCDate("2022-01-01") - * @example - * new RFCDate(new Date()) - */ - constructor(date: Date | string) { - if (typeof date === "string" && !dateRE.test(date)) { - throw new RangeError( - "RFCDate: date strings must be in the format YYYY-MM-DD: " + date, - ); - } - - const value = new Date(date); - if (isNaN(+value)) { - throw new RangeError("RFCDate: invalid date provided: " + date); - } - - this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length); - if (!dateRE.test(this.serialized)) { - throw new TypeError( - `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`, - ); - } - } - - toJSON(): string { - return this.toString(); - } - - toString(): string { - return this.serialized; - } -} diff --git a/examples/sdks/mistral-typescript/src/types/streams.ts b/examples/sdks/mistral-typescript/src/types/streams.ts deleted file mode 100644 index a0163e7a9..000000000 --- a/examples/sdks/mistral-typescript/src/types/streams.ts +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -export function isReadableStream( - val: unknown, -): val is ReadableStream { - if (typeof val !== "object" || val === null) { - return false; - } - - // Check for the presence of methods specific to ReadableStream - const stream = val as ReadableStream; - - // ReadableStream has methods like getReader, cancel, and tee - return ( - typeof stream.getReader === "function" && - typeof stream.cancel === "function" && - typeof stream.tee === "function" - ); -} diff --git a/examples/sdks/mistral-typescript/tests/extra/structChat.test.ts b/examples/sdks/mistral-typescript/tests/extra/structChat.test.ts deleted file mode 100644 index c134ef713..000000000 --- a/examples/sdks/mistral-typescript/tests/extra/structChat.test.ts +++ /dev/null @@ -1,194 +0,0 @@ -import { - transformToChatCompletionRequest, - convertToParsedChatCompletionResponse, - responseFormatFromZodObject, - ParsedChatCompletionRequest, - ParsedChatCompletionResponse, -} from "../../extra/structChat"; -import { ResponseFormat } from "../../models/components/responseformat.js"; -import { z } from "zod"; -import * as components from "../../models/components/index.js"; - -const Explanation = z.object({ - explanation: z.string(), - output: z.string(), -}); - -const MathDemonstration = z.object({ - steps: z.array(Explanation), - final_answer: z.string(), -}); - -const raw_request: ParsedChatCompletionRequest = { - model: "mistral-tiny-latest", - messages: [ - { - role: "system", - content: - "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.", - }, - { role: "user", content: "How can I solve 8x + 7 = -23" }, - ], - responseFormat: MathDemonstration, -}; - -const transformedResponseFormat: ResponseFormat = { - type: "json_schema", - jsonSchema: { - name: "placeholderName", - schemaDefinition: { - type: "object", - properties: { - steps: { - type: "array", - items: { - type: "object", - properties: { - explanation: { type: "string" }, - output: { type: "string" }, - }, - required: ["explanation", "output"], - additionalProperties: false, - }, - }, - final_answer: { type: "string" }, - }, - required: ["steps", "final_answer"], - additionalProperties: false, - $schema: "http://json-schema.org/draft-07/schema#", - }, - strict: true, - }, -}; - -const ccr_request: components.ChatCompletionRequest = { - model: "mistral-tiny-latest", - messages: [ - { - role: "system", - content: - "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning.", - }, - { role: "user", content: "How can I solve 8x + 7 = -23" }, - ], - responseFormat: transformedResponseFormat, -}; - -const raw_response: components.ChatCompletionResponse = { - id: "df9c5af85d0a4474b2e8392ee52dd883", - object: "chat.completion", - model: "mistral-tiny-latest", - usage: { promptTokens: 71, completionTokens: 140, totalTokens: 211 }, - created: 1737982851, - choices: [ - { - index: 0, - message: { - content: ` -{ - "steps": [ - { - "explanation": "Subtract 7 from both sides to isolate the term with x.", - "output": "8x + 7 - 7 = -23 - 7" - }, - { - "explanation": "Simplify both sides to get the equation in standard form.", - "output": "8x = -30" - }, - { - "explanation": "Divide both sides by 8 to solve for x.", - "output": "8x / 8 = -30 / 8" - } - ], - "final_answer": "-3.75" -} -`, - toolCalls: null, - prefix: false, - role: "assistant", - }, - finishReason: "stop", - }, - ], -}; - -const ccr_response: ParsedChatCompletionResponse = { - id: "df9c5af85d0a4474b2e8392ee52dd883", - object: "chat.completion", - model: "mistral-tiny-latest", - usage: { promptTokens: 71, completionTokens: 140, totalTokens: 211 }, - created: 1737982851, - choices: [ - { - index: 0, - message: { - content: ` -{ - "steps": [ - { - "explanation": "Subtract 7 from both sides to isolate the term with x.", - "output": "8x + 7 - 7 = -23 - 7" - }, - { - "explanation": "Simplify both sides to get the equation in standard form.", - "output": "8x = -30" - }, - { - "explanation": "Divide both sides by 8 to solve for x.", - "output": "8x / 8 = -30 / 8" - } - ], - "final_answer": "-3.75" -} -`, - toolCalls: null, - prefix: false, - role: "assistant", - parsed: { - steps: [ - { - explanation: - "Subtract 7 from both sides to isolate the term with x.", - output: "8x + 7 - 7 = -23 - 7", - }, - { - explanation: - "Simplify both sides to get the equation in standard form.", - output: "8x = -30", - }, - { - explanation: "Divide both sides by 8 to solve for x.", - output: "8x / 8 = -30 / 8", - }, - ], - final_answer: "-3.75", - }, - }, - finishReason: "stop", - }, - ], -}; - -describe("transformToChatCompletionRequest", () => { - it("should return a valid ChatCompletionRequest", () => { - expect(transformToChatCompletionRequest(raw_request)).toStrictEqual( - ccr_request - ); - }); -}); - -describe("convertToParsedChatCompletionResponse", () => { - it("should return a valid ParsedChatCompletionResponse", () => { - expect( - convertToParsedChatCompletionResponse(raw_response, MathDemonstration) - ).toStrictEqual(ccr_response); - }); -}); - -describe("responseFormatFromZodObject", () => { - it("should return a valid response format", () => { - expect(responseFormatFromZodObject(MathDemonstration)).toStrictEqual( - transformedResponseFormat - ); - }); -}); diff --git a/examples/sdks/mistral-typescript/tests/jest.config.js b/examples/sdks/mistral-typescript/tests/jest.config.js deleted file mode 100644 index 04d186346..000000000 --- a/examples/sdks/mistral-typescript/tests/jest.config.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - preset: 'ts-jest', - testEnvironment: 'node', - testMatch: ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'], - }; diff --git a/examples/sdks/mistral-typescript/tests/package-lock.json b/examples/sdks/mistral-typescript/tests/package-lock.json deleted file mode 100644 index bdcbf20cc..000000000 --- a/examples/sdks/mistral-typescript/tests/package-lock.json +++ /dev/null @@ -1,3847 +0,0 @@ -{ - "name": "tests", - "version": "1.0.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "tests", - "version": "1.0.0", - "license": "ISC", - "devDependencies": { - "@types/jest": "^29.5.14", - "jest": "^29.7.0", - "ts-jest": "^29.2.5", - "typescript": "^5.7.3" - } - }, - "node_modules/@ampproject/remapping": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", - "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@babel/code-frame": { - "version": "7.26.2", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.26.2.tgz", - "integrity": "sha512-RJlIHRueQgwWitWgF8OdFYGZX328Ax5BCemNGlqHfplnRT9ESi8JkFlvaVYbS+UubVY6dpv87Fs2u5M29iNFVQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-validator-identifier": "^7.25.9", - "js-tokens": "^4.0.0", - "picocolors": "^1.0.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/compat-data": { - "version": "7.26.5", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.26.5.tgz", - "integrity": "sha512-XvcZi1KWf88RVbF9wn8MN6tYFloU5qX8KjuF3E1PVBmJ9eypXfs4GRiJwLuTZL0iSnJUKn1BFPa5BPZZJyFzPg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/core": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.7.tgz", - "integrity": "sha512-SRijHmF0PSPgLIBYlWnG0hyeJLwXE2CgpsXaMOrtt2yp9/86ALw6oUlj9KYuZ0JN07T4eBMVIW4li/9S1j2BGA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@ampproject/remapping": "^2.2.0", - "@babel/code-frame": "^7.26.2", - "@babel/generator": "^7.26.5", - "@babel/helper-compilation-targets": "^7.26.5", - "@babel/helper-module-transforms": "^7.26.0", - "@babel/helpers": "^7.26.7", - "@babel/parser": "^7.26.7", - "@babel/template": "^7.25.9", - "@babel/traverse": "^7.26.7", - "@babel/types": "^7.26.7", - "convert-source-map": "^2.0.0", - "debug": "^4.1.0", - "gensync": "^1.0.0-beta.2", - "json5": "^2.2.3", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/babel" - } - }, - "node_modules/@babel/generator": { - "version": "7.26.5", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.26.5.tgz", - "integrity": "sha512-2caSP6fN9I7HOe6nqhtft7V4g7/V/gfDsC3Ag4W7kEzzvRGKqiv0pu0HogPiZ3KaVSoNDhUws6IJjDjpfmYIXw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.26.5", - "@babel/types": "^7.26.5", - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.25", - "jsesc": "^3.0.2" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-compilation-targets": { - "version": "7.26.5", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.26.5.tgz", - "integrity": "sha512-IXuyn5EkouFJscIDuFF5EsiSolseme1s0CZB+QxVugqJLYmKdxI1VfIBOst0SUu4rnk2Z7kqTwmoO1lp3HIfnA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.26.5", - "@babel/helper-validator-option": "^7.25.9", - "browserslist": "^4.24.0", - "lru-cache": "^5.1.1", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-module-imports": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.25.9.tgz", - "integrity": "sha512-tnUA4RsrmflIM6W6RFTLFSXITtl0wKjgpnLgXyowocVPrbYrLUXSBXDgTs8BlbmIzIdlBySRQjINYs2BAkiLtw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.25.9", - "@babel/types": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-module-transforms": { - "version": "7.26.0", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.26.0.tgz", - "integrity": "sha512-xO+xu6B5K2czEnQye6BHA7DolFFmS3LB7stHZFaOLb1pAwO1HWLS8fXA+eh0A2yIvltPVmx3eNNDBJA2SLHXFw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.25.9", - "@babel/helper-validator-identifier": "^7.25.9", - "@babel/traverse": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-plugin-utils": { - "version": "7.26.5", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.26.5.tgz", - "integrity": "sha512-RS+jZcRdZdRFzMyr+wcsaqOmld1/EqTghfaBGQQd/WnRdzdlvSZ//kF7U8VQTxf1ynZ4cjUcYgjVGx13ewNPMg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-string-parser": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz", - "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-validator-identifier": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz", - "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-validator-option": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.25.9.tgz", - "integrity": "sha512-e/zv1co8pp55dNdEcCynfj9X7nyUKUXoUEwfXqaZt0omVOmDe9oOTdKStH4GmAw6zxMFs50ZayuMfHDKlO7Tfw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helpers": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.7.tgz", - "integrity": "sha512-8NHiL98vsi0mbPQmYAGWwfcFaOy4j2HY49fXJCfuDcdE7fMIsH9a7GdaeXpIBsbT7307WU8KCMp5pUVDNL4f9A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/template": "^7.25.9", - "@babel/types": "^7.26.7" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/parser": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.7.tgz", - "integrity": "sha512-kEvgGGgEjRUutvdVvZhbn/BxVt+5VSpwXz1j3WYXQbXDo8KzFOPNG2GQbdAiNq8g6wn1yKk7C/qrke03a84V+w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.26.7" - }, - "bin": { - "parser": "bin/babel-parser.js" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@babel/plugin-syntax-async-generators": { - "version": "7.8.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", - "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-bigint": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz", - "integrity": "sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-class-properties": { - "version": "7.12.13", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", - "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.12.13" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-class-static-block": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", - "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.14.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-import-attributes": { - "version": "7.26.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.26.0.tgz", - "integrity": "sha512-e2dttdsJ1ZTpi3B9UYGLw41hifAubg19AtCu/2I/F1QNVclOBr1dYpTdmdyZ84Xiz43BS/tCUkMAZNLv12Pi+A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-import-meta": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", - "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-json-strings": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", - "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-jsx": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.25.9.tgz", - "integrity": "sha512-ld6oezHQMZsZfp6pWtbjaNDF2tiiCYYDqQszHt5VV437lewP9aSi2Of99CK0D0XB21k7FLgnLcmQKyKzynfeAA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-logical-assignment-operators": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", - "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", - "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-numeric-separator": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", - "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.10.4" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-object-rest-spread": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", - "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-optional-catch-binding": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", - "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-optional-chaining": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", - "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-private-property-in-object": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", - "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.14.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-top-level-await": { - "version": "7.14.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", - "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.14.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-typescript": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.9.tgz", - "integrity": "sha512-hjMgRy5hb8uJJjUcdWunWVcoi9bGpJp8p5Ol1229PoN6aytsLwNMgmdftO23wnCLMfVmTwZDWMPNq/D1SY60JQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/template": { - "version": "7.25.9", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.25.9.tgz", - "integrity": "sha512-9DGttpmPvIxBb/2uwpVo3dqJ+O6RooAFOS+lB+xDqoE2PVCE8nfoHMdZLpfCQRLwvohzXISPZcgxt80xLfsuwg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.25.9", - "@babel/parser": "^7.25.9", - "@babel/types": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/traverse": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.26.7.tgz", - "integrity": "sha512-1x1sgeyRLC3r5fQOM0/xtQKsYjyxmFjaOrLJNtZ81inNjyJHGIolTULPiSc/2qe1/qfpFLisLQYFnnZl7QoedA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.26.2", - "@babel/generator": "^7.26.5", - "@babel/parser": "^7.26.7", - "@babel/template": "^7.25.9", - "@babel/types": "^7.26.7", - "debug": "^4.3.1", - "globals": "^11.1.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/types": { - "version": "7.26.7", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.7.tgz", - "integrity": "sha512-t8kDRGrKXyp6+tjUh7hw2RLyclsW4TRoRvRHtSyAX9Bb5ldlFh+90YAYY6awRXrlB4G5G2izNeGySpATlFzmOg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-string-parser": "^7.25.9", - "@babel/helper-validator-identifier": "^7.25.9" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@bcoe/v8-coverage": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", - "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@istanbuljs/load-nyc-config": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", - "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", - "dev": true, - "license": "ISC", - "dependencies": { - "camelcase": "^5.3.1", - "find-up": "^4.1.0", - "get-package-type": "^0.1.0", - "js-yaml": "^3.13.1", - "resolve-from": "^5.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@istanbuljs/schema": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", - "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/@jest/console": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-29.7.0.tgz", - "integrity": "sha512-5Ni4CU7XHQi32IJ398EEP4RrB8eV09sXP2ROqD4bksHrnTree52PsxvX8tpL8LvTZ3pFzXyPbNQReSN41CAhOg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "jest-message-util": "^29.7.0", - "jest-util": "^29.7.0", - "slash": "^3.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/core": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-29.7.0.tgz", - "integrity": "sha512-n7aeXWKMnGtDA48y8TLWJPJmLmmZ642Ceo78cYWEpiD7FzDgmNDV/GCVRorPABdXLJZ/9wzzgZAlHjXjxDHGsg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/console": "^29.7.0", - "@jest/reporters": "^29.7.0", - "@jest/test-result": "^29.7.0", - "@jest/transform": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "ansi-escapes": "^4.2.1", - "chalk": "^4.0.0", - "ci-info": "^3.2.0", - "exit": "^0.1.2", - "graceful-fs": "^4.2.9", - "jest-changed-files": "^29.7.0", - "jest-config": "^29.7.0", - "jest-haste-map": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-regex-util": "^29.6.3", - "jest-resolve": "^29.7.0", - "jest-resolve-dependencies": "^29.7.0", - "jest-runner": "^29.7.0", - "jest-runtime": "^29.7.0", - "jest-snapshot": "^29.7.0", - "jest-util": "^29.7.0", - "jest-validate": "^29.7.0", - "jest-watcher": "^29.7.0", - "micromatch": "^4.0.4", - "pretty-format": "^29.7.0", - "slash": "^3.0.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } - } - }, - "node_modules/@jest/environment": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.7.0.tgz", - "integrity": "sha512-aQIfHDq33ExsN4jP1NWGXhxgQ/wixs60gDiKO+XVMd8Mn0NWPWgc34ZQDTb2jKaUWQ7MuwoitXAsN2XVXNMpAw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/fake-timers": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "jest-mock": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/expect": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-29.7.0.tgz", - "integrity": "sha512-8uMeAMycttpva3P1lBHB8VciS9V0XAr3GymPpipdyQXbBcuhkLQOSe8E/p92RyAdToS6ZD1tFkX+CkhoECE0dQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "expect": "^29.7.0", - "jest-snapshot": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/expect-utils": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-29.7.0.tgz", - "integrity": "sha512-GlsNBWiFQFCVi9QVSx7f5AgMeLxe9YCCs5PuP2O2LdjDAA8Jh9eX7lA1Jq/xdXw3Wb3hyvlFNfZIfcRetSzYcA==", - "dev": true, - "license": "MIT", - "dependencies": { - "jest-get-type": "^29.6.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/fake-timers": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.7.0.tgz", - "integrity": "sha512-q4DH1Ha4TTFPdxLsqDXK1d3+ioSL7yL5oCMJZgDYm6i+6CygW5E5xVr/D1HdsGxjt1ZWSfUAs9OxSB/BNelWrQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@sinonjs/fake-timers": "^10.0.2", - "@types/node": "*", - "jest-message-util": "^29.7.0", - "jest-mock": "^29.7.0", - "jest-util": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/globals": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-29.7.0.tgz", - "integrity": "sha512-mpiz3dutLbkW2MNFubUGUEVLkTGiqW6yLVTA+JbP6fI6J5iL9Y0Nlg8k95pcF8ctKwCS7WVxteBs29hhfAotzQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/environment": "^29.7.0", - "@jest/expect": "^29.7.0", - "@jest/types": "^29.6.3", - "jest-mock": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/reporters": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-29.7.0.tgz", - "integrity": "sha512-DApq0KJbJOEzAFYjHADNNxAE3KbhxQB1y5Kplb5Waqw6zVbuWatSnMjE5gs8FUgEPmNsnZA3NCWl9NG0ia04Pg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "^29.7.0", - "@jest/test-result": "^29.7.0", - "@jest/transform": "^29.7.0", - "@jest/types": "^29.6.3", - "@jridgewell/trace-mapping": "^0.3.18", - "@types/node": "*", - "chalk": "^4.0.0", - "collect-v8-coverage": "^1.0.0", - "exit": "^0.1.2", - "glob": "^7.1.3", - "graceful-fs": "^4.2.9", - "istanbul-lib-coverage": "^3.0.0", - "istanbul-lib-instrument": "^6.0.0", - "istanbul-lib-report": "^3.0.0", - "istanbul-lib-source-maps": "^4.0.0", - "istanbul-reports": "^3.1.3", - "jest-message-util": "^29.7.0", - "jest-util": "^29.7.0", - "jest-worker": "^29.7.0", - "slash": "^3.0.0", - "string-length": "^4.0.1", - "strip-ansi": "^6.0.0", - "v8-to-istanbul": "^9.0.1" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } - } - }, - "node_modules/@jest/schemas": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", - "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@sinclair/typebox": "^0.27.8" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/source-map": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-29.6.3.tgz", - "integrity": "sha512-MHjT95QuipcPrpLM+8JMSzFx6eHp5Bm+4XeFDJlwsvVBjmKNiIAvasGK2fxz2WbGRlnvqehFbh07MMa7n3YJnw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.18", - "callsites": "^3.0.0", - "graceful-fs": "^4.2.9" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/test-result": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-29.7.0.tgz", - "integrity": "sha512-Fdx+tv6x1zlkJPcWXmMDAG2HBnaR9XPSd5aDWQVsfrZmLVT3lU1cwyxLgRmXR9yrq4NBoEm9BMsfgFzTQAbJYA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/console": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/istanbul-lib-coverage": "^2.0.0", - "collect-v8-coverage": "^1.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/test-sequencer": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-29.7.0.tgz", - "integrity": "sha512-GQwJ5WZVrKnOJuiYiAF52UNUJXgTZx1NHjFSEB0qEMmSZKAkdMoIzw/Cj6x6NF4AvV23AUqDpFzQkN/eYCYTxw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/test-result": "^29.7.0", - "graceful-fs": "^4.2.9", - "jest-haste-map": "^29.7.0", - "slash": "^3.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/transform": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-29.7.0.tgz", - "integrity": "sha512-ok/BTPFzFKVMwO5eOHRrvnBVHdRy9IrsrW1GpMaQ9MCnilNLXQKmAX8s1YXDFaai9xJpac2ySzV0YeRRECr2Vw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.11.6", - "@jest/types": "^29.6.3", - "@jridgewell/trace-mapping": "^0.3.18", - "babel-plugin-istanbul": "^6.1.1", - "chalk": "^4.0.0", - "convert-source-map": "^2.0.0", - "fast-json-stable-stringify": "^2.1.0", - "graceful-fs": "^4.2.9", - "jest-haste-map": "^29.7.0", - "jest-regex-util": "^29.6.3", - "jest-util": "^29.7.0", - "micromatch": "^4.0.4", - "pirates": "^4.0.4", - "slash": "^3.0.0", - "write-file-atomic": "^4.0.2" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/types": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", - "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/schemas": "^29.6.3", - "@types/istanbul-lib-coverage": "^2.0.0", - "@types/istanbul-reports": "^3.0.0", - "@types/node": "*", - "@types/yargs": "^17.0.8", - "chalk": "^4.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", - "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/set-array": "^1.2.1", - "@jridgewell/sourcemap-codec": "^1.4.10", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/resolve-uri": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", - "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/set-array": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", - "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", - "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.25", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", - "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/resolve-uri": "^3.1.0", - "@jridgewell/sourcemap-codec": "^1.4.14" - } - }, - "node_modules/@sinclair/typebox": { - "version": "0.27.8", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", - "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@sinonjs/commons": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.1.tgz", - "integrity": "sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "type-detect": "4.0.8" - } - }, - "node_modules/@sinonjs/fake-timers": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-10.3.0.tgz", - "integrity": "sha512-V4BG07kuYSUkTCSBHG8G8TNhM+F19jXFWnQtzj+we8DrkpSBCee9Z3Ms8yiGer/dlmhe35/Xdgyo3/0rQKg7YA==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@sinonjs/commons": "^3.0.0" - } - }, - "node_modules/@types/babel__core": { - "version": "7.20.5", - "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", - "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.20.7", - "@babel/types": "^7.20.7", - "@types/babel__generator": "*", - "@types/babel__template": "*", - "@types/babel__traverse": "*" - } - }, - "node_modules/@types/babel__generator": { - "version": "7.6.8", - "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.8.tgz", - "integrity": "sha512-ASsj+tpEDsEiFr1arWrlN6V3mdfjRMZt6LtK/Vp/kreFLnr5QH5+DhvD5nINYZXzwJvXeGq+05iUXcAzVrqWtw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.0.0" - } - }, - "node_modules/@types/babel__template": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", - "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.1.0", - "@babel/types": "^7.0.0" - } - }, - "node_modules/@types/babel__traverse": { - "version": "7.20.6", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.6.tgz", - "integrity": "sha512-r1bzfrm0tomOI8g1SzvCaQHo6Lcv6zu0EA+W2kHrt8dyrHQxGzBBL4kdkzIS+jBMV+EYcMAEAqXqYaLJq5rOZg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.20.7" - } - }, - "node_modules/@types/graceful-fs": { - "version": "4.1.9", - "resolved": "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.9.tgz", - "integrity": "sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/istanbul-lib-coverage": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", - "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/istanbul-lib-report": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", - "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/istanbul-lib-coverage": "*" - } - }, - "node_modules/@types/istanbul-reports": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", - "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/istanbul-lib-report": "*" - } - }, - "node_modules/@types/jest": { - "version": "29.5.14", - "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.14.tgz", - "integrity": "sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "expect": "^29.0.0", - "pretty-format": "^29.0.0" - } - }, - "node_modules/@types/node": { - "version": "22.10.10", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.10.tgz", - "integrity": "sha512-X47y/mPNzxviAGY5TcYPtYL8JsY3kAq2n8fMmKoRCxq/c4v4pyGNCzM2R6+M5/umG4ZfHuT+sgqDYqWc9rJ6ww==", - "dev": true, - "license": "MIT", - "dependencies": { - "undici-types": "~6.20.0" - } - }, - "node_modules/@types/stack-utils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz", - "integrity": "sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/yargs": { - "version": "17.0.33", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.33.tgz", - "integrity": "sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/yargs-parser": "*" - } - }, - "node_modules/@types/yargs-parser": { - "version": "21.0.3", - "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", - "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/ansi-escapes": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", - "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "type-fest": "^0.21.3" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/anymatch": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", - "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", - "dev": true, - "license": "ISC", - "dependencies": { - "normalize-path": "^3.0.0", - "picomatch": "^2.0.4" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/async": { - "version": "3.2.6", - "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", - "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", - "dev": true, - "license": "MIT" - }, - "node_modules/babel-jest": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-29.7.0.tgz", - "integrity": "sha512-BrvGY3xZSwEcCzKvKsCi2GgHqDqsYkOP4/by5xCgIwGXQxIEh+8ew3gmrE1y7XRR6LHZIj6yLYnUi/mm2KXKBg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/transform": "^29.7.0", - "@types/babel__core": "^7.1.14", - "babel-plugin-istanbul": "^6.1.1", - "babel-preset-jest": "^29.6.3", - "chalk": "^4.0.0", - "graceful-fs": "^4.2.9", - "slash": "^3.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "@babel/core": "^7.8.0" - } - }, - "node_modules/babel-plugin-istanbul": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz", - "integrity": "sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@babel/helper-plugin-utils": "^7.0.0", - "@istanbuljs/load-nyc-config": "^1.0.0", - "@istanbuljs/schema": "^0.1.2", - "istanbul-lib-instrument": "^5.0.4", - "test-exclude": "^6.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/babel-plugin-istanbul/node_modules/istanbul-lib-instrument": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz", - "integrity": "sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@babel/core": "^7.12.3", - "@babel/parser": "^7.14.7", - "@istanbuljs/schema": "^0.1.2", - "istanbul-lib-coverage": "^3.2.0", - "semver": "^6.3.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/babel-plugin-jest-hoist": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.6.3.tgz", - "integrity": "sha512-ESAc/RJvGTFEzRwOTT4+lNDk/GNHMkKbNzsvT0qKRfDyyYTskxB5rnU2njIDYVxXCBHHEI1c0YwHob3WaYujOg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/template": "^7.3.3", - "@babel/types": "^7.3.3", - "@types/babel__core": "^7.1.14", - "@types/babel__traverse": "^7.0.6" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/babel-preset-current-node-syntax": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz", - "integrity": "sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/plugin-syntax-async-generators": "^7.8.4", - "@babel/plugin-syntax-bigint": "^7.8.3", - "@babel/plugin-syntax-class-properties": "^7.12.13", - "@babel/plugin-syntax-class-static-block": "^7.14.5", - "@babel/plugin-syntax-import-attributes": "^7.24.7", - "@babel/plugin-syntax-import-meta": "^7.10.4", - "@babel/plugin-syntax-json-strings": "^7.8.3", - "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", - "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", - "@babel/plugin-syntax-numeric-separator": "^7.10.4", - "@babel/plugin-syntax-object-rest-spread": "^7.8.3", - "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", - "@babel/plugin-syntax-optional-chaining": "^7.8.3", - "@babel/plugin-syntax-private-property-in-object": "^7.14.5", - "@babel/plugin-syntax-top-level-await": "^7.14.5" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/babel-preset-jest": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-29.6.3.tgz", - "integrity": "sha512-0B3bhxR6snWXJZtR/RliHTDPRgn1sNHOR0yVtq/IiQFyuOVjFS+wuio/R4gSNkyYmKmJB4wGZv2NZanmKmTnNA==", - "dev": true, - "license": "MIT", - "dependencies": { - "babel-plugin-jest-hoist": "^29.6.3", - "babel-preset-current-node-syntax": "^1.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/browserslist": { - "version": "4.24.4", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.4.tgz", - "integrity": "sha512-KDi1Ny1gSePi1vm0q4oxSF8b4DR44GF4BbmS2YdhPLOEqd8pDviZOGH/GsmRwoWJ2+5Lr085X7naowMwKHDG1A==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "caniuse-lite": "^1.0.30001688", - "electron-to-chromium": "^1.5.73", - "node-releases": "^2.0.19", - "update-browserslist-db": "^1.1.1" - }, - "bin": { - "browserslist": "cli.js" - }, - "engines": { - "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" - } - }, - "node_modules/bs-logger": { - "version": "0.2.6", - "resolved": "https://registry.npmjs.org/bs-logger/-/bs-logger-0.2.6.tgz", - "integrity": "sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-json-stable-stringify": "2.x" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/bser": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz", - "integrity": "sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "node-int64": "^0.4.0" - } - }, - "node_modules/buffer-from": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", - "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/caniuse-lite": { - "version": "1.0.30001695", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001695.tgz", - "integrity": "sha512-vHyLade6wTgI2u1ec3WQBxv+2BrTERV28UXQu9LO6lZ9pYeMk34vjXFLOxo1A4UBA8XTL4njRQZdno/yYaSmWw==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/caniuse-lite" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "CC-BY-4.0" - }, - "node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/char-regex": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", - "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/ci-info": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", - "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/sibiraj-s" - } - ], - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/cjs-module-lexer": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.1.tgz", - "integrity": "sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA==", - "dev": true, - "license": "MIT" - }, - "node_modules/cliui": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", - "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", - "dev": true, - "license": "ISC", - "dependencies": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.1", - "wrap-ansi": "^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/co": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", - "integrity": "sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==", - "dev": true, - "license": "MIT", - "engines": { - "iojs": ">= 1.0.0", - "node": ">= 0.12.0" - } - }, - "node_modules/collect-v8-coverage": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz", - "integrity": "sha512-lHl4d5/ONEbLlJvaJNtsF/Lz+WvB07u2ycqTYbdrq7UypDXailES4valYb2eWiJFxZlVmpGekfqoxQhzyFdT4Q==", - "dev": true, - "license": "MIT" - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "license": "MIT" - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true, - "license": "MIT" - }, - "node_modules/convert-source-map": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", - "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", - "dev": true, - "license": "MIT" - }, - "node_modules/create-jest": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/create-jest/-/create-jest-29.7.0.tgz", - "integrity": "sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "chalk": "^4.0.0", - "exit": "^0.1.2", - "graceful-fs": "^4.2.9", - "jest-config": "^29.7.0", - "jest-util": "^29.7.0", - "prompts": "^2.0.1" - }, - "bin": { - "create-jest": "bin/create-jest.js" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/cross-spawn": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/debug": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", - "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "^2.1.3" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/dedent": { - "version": "1.5.3", - "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.5.3.tgz", - "integrity": "sha512-NHQtfOOW68WD8lgypbLA5oT+Bt0xXJhiYvoR6SmmNXZfpzOGXwdKWmcwG8N7PwVVWV3eF/68nmD9BaJSsTBhyQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "babel-plugin-macros": "^3.1.0" - }, - "peerDependenciesMeta": { - "babel-plugin-macros": { - "optional": true - } - } - }, - "node_modules/deepmerge": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/detect-newline": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", - "integrity": "sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/diff-sequences": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", - "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/ejs": { - "version": "3.1.10", - "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", - "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "jake": "^10.8.5" - }, - "bin": { - "ejs": "bin/cli.js" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/electron-to-chromium": { - "version": "1.5.88", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.88.tgz", - "integrity": "sha512-K3C2qf1o+bGzbilTDCTBhTQcMS9KW60yTAaTeeXsfvQuTDDwlokLam/AdqlqcSy9u4UainDgsHV23ksXAOgamw==", - "dev": true, - "license": "ISC" - }, - "node_modules/emittery": { - "version": "0.13.1", - "resolved": "https://registry.npmjs.org/emittery/-/emittery-0.13.1.tgz", - "integrity": "sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sindresorhus/emittery?sponsor=1" - } - }, - "node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true, - "license": "MIT" - }, - "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-arrayish": "^0.2.1" - } - }, - "node_modules/escalade": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", - "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/esprima": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "dev": true, - "license": "BSD-2-Clause", - "bin": { - "esparse": "bin/esparse.js", - "esvalidate": "bin/esvalidate.js" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/execa": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", - "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^6.0.0", - "human-signals": "^2.1.0", - "is-stream": "^2.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^4.0.1", - "onetime": "^5.1.2", - "signal-exit": "^3.0.3", - "strip-final-newline": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" - } - }, - "node_modules/exit": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz", - "integrity": "sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ==", - "dev": true, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/expect": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/expect/-/expect-29.7.0.tgz", - "integrity": "sha512-2Zks0hf1VLFYI1kbh0I5jP3KHHyCHpkfyHBzsSXRFgl/Bg9mWYfMW8oD+PdMPlEwy5HNsR9JutYy6pMeOh61nw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/expect-utils": "^29.7.0", - "jest-get-type": "^29.6.3", - "jest-matcher-utils": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-util": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true, - "license": "MIT" - }, - "node_modules/fb-watchman": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", - "integrity": "sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "bser": "2.1.1" - } - }, - "node_modules/filelist": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", - "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "minimatch": "^5.0.1" - } - }, - "node_modules/filelist/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/filelist/node_modules/minimatch": { - "version": "5.1.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", - "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "dev": true, - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/find-up": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", - "dev": true, - "license": "MIT", - "dependencies": { - "locate-path": "^5.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/fs.realpath": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", - "dev": true, - "license": "ISC" - }, - "node_modules/fsevents": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", - "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, - "node_modules/function-bind": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", - "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/gensync": { - "version": "1.0.0-beta.2", - "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", - "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/get-caller-file": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", - "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "dev": true, - "license": "ISC", - "engines": { - "node": "6.* || 8.* || >= 10.*" - } - }, - "node_modules/get-package-type": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", - "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/get-stream": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", - "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", - "dev": true, - "license": "ISC", - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/globals": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", - "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/graceful-fs": { - "version": "4.2.11", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", - "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "function-bind": "^1.1.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/html-escaper": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "dev": true, - "license": "MIT" - }, - "node_modules/human-signals": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", - "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.17.0" - } - }, - "node_modules/import-local": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.2.0.tgz", - "integrity": "sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA==", - "dev": true, - "license": "MIT", - "dependencies": { - "pkg-dir": "^4.2.0", - "resolve-cwd": "^3.0.0" - }, - "bin": { - "import-local-fixture": "fixtures/cli.js" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/inflight": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", - "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", - "dev": true, - "license": "ISC", - "dependencies": { - "once": "^1.3.0", - "wrappy": "1" - } - }, - "node_modules/inherits": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", - "dev": true, - "license": "MIT" - }, - "node_modules/is-core-module": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", - "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", - "dev": true, - "license": "MIT", - "dependencies": { - "hasown": "^2.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/is-generator-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-generator-fn/-/is-generator-fn-2.1.0.tgz", - "integrity": "sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true, - "license": "ISC" - }, - "node_modules/istanbul-lib-coverage": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", - "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", - "dev": true, - "license": "BSD-3-Clause", - "engines": { - "node": ">=8" - } - }, - "node_modules/istanbul-lib-instrument": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz", - "integrity": "sha512-Vtgk7L/R2JHyyGW07spoFlB8/lpjiOLTjMdms6AFMraYt3BaJauod/NGrfnVG/y4Ix1JEuMRPDPEj2ua+zz1/Q==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@babel/core": "^7.23.9", - "@babel/parser": "^7.23.9", - "@istanbuljs/schema": "^0.1.3", - "istanbul-lib-coverage": "^3.2.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/istanbul-lib-instrument/node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/istanbul-lib-report": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", - "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "istanbul-lib-coverage": "^3.0.0", - "make-dir": "^4.0.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/istanbul-lib-source-maps": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz", - "integrity": "sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "debug": "^4.1.1", - "istanbul-lib-coverage": "^3.0.0", - "source-map": "^0.6.1" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/istanbul-reports": { - "version": "3.1.7", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", - "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "html-escaper": "^2.0.0", - "istanbul-lib-report": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/jake": { - "version": "10.9.2", - "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", - "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "async": "^3.2.3", - "chalk": "^4.0.2", - "filelist": "^1.0.4", - "minimatch": "^3.1.2" - }, - "bin": { - "jake": "bin/cli.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/jest": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest/-/jest-29.7.0.tgz", - "integrity": "sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/core": "^29.7.0", - "@jest/types": "^29.6.3", - "import-local": "^3.0.2", - "jest-cli": "^29.7.0" - }, - "bin": { - "jest": "bin/jest.js" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } - } - }, - "node_modules/jest-changed-files": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-29.7.0.tgz", - "integrity": "sha512-fEArFiwf1BpQ+4bXSprcDc3/x4HSzL4al2tozwVpDFpsxALjLYdyiIK4e5Vz66GQJIbXJ82+35PtysofptNX2w==", - "dev": true, - "license": "MIT", - "dependencies": { - "execa": "^5.0.0", - "jest-util": "^29.7.0", - "p-limit": "^3.1.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-circus": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-29.7.0.tgz", - "integrity": "sha512-3E1nCMgipcTkCocFwM90XXQab9bS+GMsjdpmPrlelaxwD93Ad8iVEjX/vvHPdLPnFf+L40u+5+iutRdA1N9myw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/environment": "^29.7.0", - "@jest/expect": "^29.7.0", - "@jest/test-result": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "co": "^4.6.0", - "dedent": "^1.0.0", - "is-generator-fn": "^2.0.0", - "jest-each": "^29.7.0", - "jest-matcher-utils": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-runtime": "^29.7.0", - "jest-snapshot": "^29.7.0", - "jest-util": "^29.7.0", - "p-limit": "^3.1.0", - "pretty-format": "^29.7.0", - "pure-rand": "^6.0.0", - "slash": "^3.0.0", - "stack-utils": "^2.0.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-cli": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-29.7.0.tgz", - "integrity": "sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/core": "^29.7.0", - "@jest/test-result": "^29.7.0", - "@jest/types": "^29.6.3", - "chalk": "^4.0.0", - "create-jest": "^29.7.0", - "exit": "^0.1.2", - "import-local": "^3.0.2", - "jest-config": "^29.7.0", - "jest-util": "^29.7.0", - "jest-validate": "^29.7.0", - "yargs": "^17.3.1" - }, - "bin": { - "jest": "bin/jest.js" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" - }, - "peerDependenciesMeta": { - "node-notifier": { - "optional": true - } - } - }, - "node_modules/jest-config": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-29.7.0.tgz", - "integrity": "sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.11.6", - "@jest/test-sequencer": "^29.7.0", - "@jest/types": "^29.6.3", - "babel-jest": "^29.7.0", - "chalk": "^4.0.0", - "ci-info": "^3.2.0", - "deepmerge": "^4.2.2", - "glob": "^7.1.3", - "graceful-fs": "^4.2.9", - "jest-circus": "^29.7.0", - "jest-environment-node": "^29.7.0", - "jest-get-type": "^29.6.3", - "jest-regex-util": "^29.6.3", - "jest-resolve": "^29.7.0", - "jest-runner": "^29.7.0", - "jest-util": "^29.7.0", - "jest-validate": "^29.7.0", - "micromatch": "^4.0.4", - "parse-json": "^5.2.0", - "pretty-format": "^29.7.0", - "slash": "^3.0.0", - "strip-json-comments": "^3.1.1" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "peerDependencies": { - "@types/node": "*", - "ts-node": ">=9.0.0" - }, - "peerDependenciesMeta": { - "@types/node": { - "optional": true - }, - "ts-node": { - "optional": true - } - } - }, - "node_modules/jest-diff": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-29.7.0.tgz", - "integrity": "sha512-LMIgiIrhigmPrs03JHpxUh2yISK3vLFPkAodPeo0+BuF7wA2FoQbkEg1u8gBYBThncu7e1oEDUfIXVuTqLRUjw==", - "dev": true, - "license": "MIT", - "dependencies": { - "chalk": "^4.0.0", - "diff-sequences": "^29.6.3", - "jest-get-type": "^29.6.3", - "pretty-format": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-docblock": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-29.7.0.tgz", - "integrity": "sha512-q617Auw3A612guyaFgsbFeYpNP5t2aoUNLwBUbc/0kD1R4t9ixDbyFTHd1nok4epoVFpr7PmeWHrhvuV3XaJ4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "detect-newline": "^3.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-each": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-29.7.0.tgz", - "integrity": "sha512-gns+Er14+ZrEoC5fhOfYCY1LOHHr0TI+rQUHZS8Ttw2l7gl+80eHc/gFf2Ktkw0+SIACDTeWvpFcv3B04VembQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "chalk": "^4.0.0", - "jest-get-type": "^29.6.3", - "jest-util": "^29.7.0", - "pretty-format": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-environment-node": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.7.0.tgz", - "integrity": "sha512-DOSwCRqXirTOyheM+4d5YZOrWcdu0LNZ87ewUoywbcb2XR4wKgqiG8vNeYwhjFMbEkfju7wx2GYH0P2gevGvFw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/environment": "^29.7.0", - "@jest/fake-timers": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "jest-mock": "^29.7.0", - "jest-util": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-get-type": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.6.3.tgz", - "integrity": "sha512-zrteXnqYxfQh7l5FHyL38jL39di8H8rHoecLH3JNxH3BwOrBsNeabdap5e0I23lD4HHI8W5VFBZqG4Eaq5LNcw==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-haste-map": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-29.7.0.tgz", - "integrity": "sha512-fP8u2pyfqx0K1rGn1R9pyE0/KTn+G7PxktWidOBTqFPLYX0b9ksaMFkhK5vrS3DVun09pckLdlx90QthlW7AmA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/graceful-fs": "^4.1.3", - "@types/node": "*", - "anymatch": "^3.0.3", - "fb-watchman": "^2.0.0", - "graceful-fs": "^4.2.9", - "jest-regex-util": "^29.6.3", - "jest-util": "^29.7.0", - "jest-worker": "^29.7.0", - "micromatch": "^4.0.4", - "walker": "^1.0.8" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - }, - "optionalDependencies": { - "fsevents": "^2.3.2" - } - }, - "node_modules/jest-leak-detector": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-29.7.0.tgz", - "integrity": "sha512-kYA8IJcSYtST2BY9I+SMC32nDpBT3J2NvWJx8+JCuCdl/CR1I4EKUJROiP8XtCcxqgTTBGJNdbB1A8XRKbTetw==", - "dev": true, - "license": "MIT", - "dependencies": { - "jest-get-type": "^29.6.3", - "pretty-format": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-matcher-utils": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-29.7.0.tgz", - "integrity": "sha512-sBkD+Xi9DtcChsI3L3u0+N0opgPYnCRPtGcQYrgXmR+hmt/fYfWAL0xRXYU8eWOdfuLgBe0YCW3AFtnRLagq/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "chalk": "^4.0.0", - "jest-diff": "^29.7.0", - "jest-get-type": "^29.6.3", - "pretty-format": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-message-util": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.7.0.tgz", - "integrity": "sha512-GBEV4GRADeP+qtB2+6u61stea8mGcOT4mCtrYISZwfu9/ISHFJ/5zOMXYbpBE9RsS5+Gb63DW4FgmnKJ79Kf6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.12.13", - "@jest/types": "^29.6.3", - "@types/stack-utils": "^2.0.0", - "chalk": "^4.0.0", - "graceful-fs": "^4.2.9", - "micromatch": "^4.0.4", - "pretty-format": "^29.7.0", - "slash": "^3.0.0", - "stack-utils": "^2.0.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-mock": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.7.0.tgz", - "integrity": "sha512-ITOMZn+UkYS4ZFh83xYAOzWStloNzJFO2s8DWrE4lhtGD+AorgnbkiKERe4wQVBydIGPx059g6riW5Btp6Llnw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/node": "*", - "jest-util": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-pnp-resolver": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz", - "integrity": "sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - }, - "peerDependencies": { - "jest-resolve": "*" - }, - "peerDependenciesMeta": { - "jest-resolve": { - "optional": true - } - } - }, - "node_modules/jest-regex-util": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-29.6.3.tgz", - "integrity": "sha512-KJJBsRCyyLNWCNBOvZyRDnAIfUiRJ8v+hOBQYGn8gDyF3UegwiP4gwRR3/SDa42g1YbVycTidUF3rKjyLFDWbg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-resolve": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-29.7.0.tgz", - "integrity": "sha512-IOVhZSrg+UvVAshDSDtHyFCCBUl/Q3AAJv8iZ6ZjnZ74xzvwuzLXid9IIIPgTnY62SJjfuupMKZsZQRsCvxEgA==", - "dev": true, - "license": "MIT", - "dependencies": { - "chalk": "^4.0.0", - "graceful-fs": "^4.2.9", - "jest-haste-map": "^29.7.0", - "jest-pnp-resolver": "^1.2.2", - "jest-util": "^29.7.0", - "jest-validate": "^29.7.0", - "resolve": "^1.20.0", - "resolve.exports": "^2.0.0", - "slash": "^3.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-resolve-dependencies": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-29.7.0.tgz", - "integrity": "sha512-un0zD/6qxJ+S0et7WxeI3H5XSe9lTBBR7bOHCHXkKR6luG5mwDDlIzVQ0V5cZCuoTgEdcdwzTghYkTWfubi+nA==", - "dev": true, - "license": "MIT", - "dependencies": { - "jest-regex-util": "^29.6.3", - "jest-snapshot": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-runner": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-29.7.0.tgz", - "integrity": "sha512-fsc4N6cPCAahybGBfTRcq5wFR6fpLznMg47sY5aDpsoejOcVYFb07AHuSnR0liMcPTgBsA3ZJL6kFOjPdoNipQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/console": "^29.7.0", - "@jest/environment": "^29.7.0", - "@jest/test-result": "^29.7.0", - "@jest/transform": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "emittery": "^0.13.1", - "graceful-fs": "^4.2.9", - "jest-docblock": "^29.7.0", - "jest-environment-node": "^29.7.0", - "jest-haste-map": "^29.7.0", - "jest-leak-detector": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-resolve": "^29.7.0", - "jest-runtime": "^29.7.0", - "jest-util": "^29.7.0", - "jest-watcher": "^29.7.0", - "jest-worker": "^29.7.0", - "p-limit": "^3.1.0", - "source-map-support": "0.5.13" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-runtime": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-29.7.0.tgz", - "integrity": "sha512-gUnLjgwdGqW7B4LvOIkbKs9WGbn+QLqRQQ9juC6HndeDiezIwhDP+mhMwHWCEcfQ5RUXa6OPnFF8BJh5xegwwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/environment": "^29.7.0", - "@jest/fake-timers": "^29.7.0", - "@jest/globals": "^29.7.0", - "@jest/source-map": "^29.6.3", - "@jest/test-result": "^29.7.0", - "@jest/transform": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "cjs-module-lexer": "^1.0.0", - "collect-v8-coverage": "^1.0.0", - "glob": "^7.1.3", - "graceful-fs": "^4.2.9", - "jest-haste-map": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-mock": "^29.7.0", - "jest-regex-util": "^29.6.3", - "jest-resolve": "^29.7.0", - "jest-snapshot": "^29.7.0", - "jest-util": "^29.7.0", - "slash": "^3.0.0", - "strip-bom": "^4.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-snapshot": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-29.7.0.tgz", - "integrity": "sha512-Rm0BMWtxBcioHr1/OX5YCP8Uov4riHvKPknOGs804Zg9JGZgmIBkbtlxJC/7Z4msKYVbIJtfU+tKb8xlYNfdkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.11.6", - "@babel/generator": "^7.7.2", - "@babel/plugin-syntax-jsx": "^7.7.2", - "@babel/plugin-syntax-typescript": "^7.7.2", - "@babel/types": "^7.3.3", - "@jest/expect-utils": "^29.7.0", - "@jest/transform": "^29.7.0", - "@jest/types": "^29.6.3", - "babel-preset-current-node-syntax": "^1.0.0", - "chalk": "^4.0.0", - "expect": "^29.7.0", - "graceful-fs": "^4.2.9", - "jest-diff": "^29.7.0", - "jest-get-type": "^29.6.3", - "jest-matcher-utils": "^29.7.0", - "jest-message-util": "^29.7.0", - "jest-util": "^29.7.0", - "natural-compare": "^1.4.0", - "pretty-format": "^29.7.0", - "semver": "^7.5.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-snapshot/node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/jest-util": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", - "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "ci-info": "^3.2.0", - "graceful-fs": "^4.2.9", - "picomatch": "^2.2.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-validate": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-29.7.0.tgz", - "integrity": "sha512-ZB7wHqaRGVw/9hST/OuFUReG7M8vKeq0/J2egIGLdvjHCmYqGARhzXmtgi+gVeZ5uXFF219aOc3Ls2yLg27tkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "camelcase": "^6.2.0", - "chalk": "^4.0.0", - "jest-get-type": "^29.6.3", - "leven": "^3.1.0", - "pretty-format": "^29.7.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-validate/node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/jest-watcher": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-29.7.0.tgz", - "integrity": "sha512-49Fg7WXkU3Vl2h6LbLtMQ/HyB6rXSIX7SqvBLQmssRBGN9I0PNvPmAmCWSOY6SOvrjhI/F7/bGAv9RtnsPA03g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/test-result": "^29.7.0", - "@jest/types": "^29.6.3", - "@types/node": "*", - "ansi-escapes": "^4.2.1", - "chalk": "^4.0.0", - "emittery": "^0.13.1", - "jest-util": "^29.7.0", - "string-length": "^4.0.1" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-worker": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", - "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*", - "jest-util": "^29.7.0", - "merge-stream": "^2.0.0", - "supports-color": "^8.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-worker/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, - "node_modules/js-tokens": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/js-yaml": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", - "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/jsesc": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", - "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", - "dev": true, - "license": "MIT", - "bin": { - "jsesc": "bin/jsesc" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/json-parse-even-better-errors": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", - "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", - "dev": true, - "license": "MIT" - }, - "node_modules/json5": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", - "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", - "dev": true, - "license": "MIT", - "bin": { - "json5": "lib/cli.js" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/kleur": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", - "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/leven": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", - "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/lines-and-columns": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", - "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", - "dev": true, - "license": "MIT" - }, - "node_modules/locate-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^4.1.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/lodash.memoize": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", - "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", - "dev": true, - "license": "MIT" - }, - "node_modules/lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "dev": true, - "license": "ISC", - "dependencies": { - "yallist": "^3.0.2" - } - }, - "node_modules/make-dir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", - "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", - "dev": true, - "license": "MIT", - "dependencies": { - "semver": "^7.5.3" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/make-dir/node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/make-error": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", - "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", - "dev": true, - "license": "ISC" - }, - "node_modules/makeerror": { - "version": "1.0.12", - "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", - "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "tmpl": "1.0.5" - } - }, - "node_modules/merge-stream": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", - "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", - "dev": true, - "license": "MIT" - }, - "node_modules/micromatch": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", - "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", - "dev": true, - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true, - "license": "MIT" - }, - "node_modules/natural-compare": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true, - "license": "MIT" - }, - "node_modules/node-int64": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", - "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", - "dev": true, - "license": "MIT" - }, - "node_modules/node-releases": { - "version": "2.0.19", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.19.tgz", - "integrity": "sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==", - "dev": true, - "license": "MIT" - }, - "node_modules/normalize-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", - "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/npm-run-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", - "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", - "dev": true, - "license": "ISC", - "dependencies": { - "wrappy": "1" - } - }, - "node_modules/onetime": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "mimic-fn": "^2.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "yocto-queue": "^0.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-locate": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^2.2.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/p-locate/node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-try": "^2.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/parse-json": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", - "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.0.0", - "error-ex": "^1.3.1", - "json-parse-even-better-errors": "^2.3.0", - "lines-and-columns": "^1.1.6" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-is-absolute": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-parse": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "dev": true, - "license": "MIT" - }, - "node_modules/picocolors": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", - "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", - "dev": true, - "license": "ISC" - }, - "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/pirates": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.6.tgz", - "integrity": "sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 6" - } - }, - "node_modules/pkg-dir": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", - "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "find-up": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/pretty-format": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz", - "integrity": "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/schemas": "^29.6.3", - "ansi-styles": "^5.0.0", - "react-is": "^18.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/pretty-format/node_modules/ansi-styles": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", - "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/prompts": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", - "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "kleur": "^3.0.3", - "sisteransi": "^1.0.5" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/pure-rand": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-6.1.0.tgz", - "integrity": "sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA==", - "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://github.com/sponsors/dubzzz" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/fast-check" - } - ], - "license": "MIT" - }, - "node_modules/react-is": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", - "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", - "dev": true, - "license": "MIT" - }, - "node_modules/require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-core-module": "^2.16.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, - "bin": { - "resolve": "bin/resolve" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/resolve-cwd": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", - "integrity": "sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "resolve-from": "^5.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/resolve-from": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", - "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/resolve.exports": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.3.tgz", - "integrity": "sha512-OcXjMsGdhL4XnbShKpAcSqPMzQoYkYyhbEaeSko47MjRP9NfEQMhZkXL1DoFlt9LWQn4YttrdnV6X2OiyzBi+A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/signal-exit": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/sisteransi": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", - "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", - "dev": true, - "license": "MIT" - }, - "node_modules/slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/source-map-support": { - "version": "0.5.13", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.13.tgz", - "integrity": "sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==", - "dev": true, - "license": "MIT", - "dependencies": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "node_modules/sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", - "dev": true, - "license": "BSD-3-Clause" - }, - "node_modules/stack-utils": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", - "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "escape-string-regexp": "^2.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/string-length": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", - "integrity": "sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "char-regex": "^1.0.2", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-bom": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", - "integrity": "sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-final-newline": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", - "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/supports-preserve-symlinks-flag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/test-exclude": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", - "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", - "dev": true, - "license": "ISC", - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^7.1.4", - "minimatch": "^3.0.4" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/tmpl": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", - "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", - "dev": true, - "license": "BSD-3-Clause" - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/ts-jest": { - "version": "29.2.5", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.2.5.tgz", - "integrity": "sha512-KD8zB2aAZrcKIdGk4OwpJggeLcH1FgrICqDSROWqlnJXGCXK4Mn6FcdK2B6670Xr73lHMG1kHw8R87A0ecZ+vA==", - "dev": true, - "license": "MIT", - "dependencies": { - "bs-logger": "^0.2.6", - "ejs": "^3.1.10", - "fast-json-stable-stringify": "^2.1.0", - "jest-util": "^29.0.0", - "json5": "^2.2.3", - "lodash.memoize": "^4.1.2", - "make-error": "^1.3.6", - "semver": "^7.6.3", - "yargs-parser": "^21.1.1" - }, - "bin": { - "ts-jest": "cli.js" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || ^18.0.0 || >=20.0.0" - }, - "peerDependencies": { - "@babel/core": ">=7.0.0-beta.0 <8", - "@jest/transform": "^29.0.0", - "@jest/types": "^29.0.0", - "babel-jest": "^29.0.0", - "jest": "^29.0.0", - "typescript": ">=4.3 <6" - }, - "peerDependenciesMeta": { - "@babel/core": { - "optional": true - }, - "@jest/transform": { - "optional": true - }, - "@jest/types": { - "optional": true - }, - "babel-jest": { - "optional": true - }, - "esbuild": { - "optional": true - } - } - }, - "node_modules/ts-jest/node_modules/semver": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", - "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/type-detect": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", - "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/type-fest": { - "version": "0.21.3", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", - "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/typescript": { - "version": "5.7.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz", - "integrity": "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==", - "dev": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/undici-types": { - "version": "6.20.0", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz", - "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==", - "dev": true, - "license": "MIT" - }, - "node_modules/update-browserslist-db": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.2.tgz", - "integrity": "sha512-PPypAm5qvlD7XMZC3BujecnaOxwhrtoFR+Dqkk5Aa/6DssiH0ibKoketaj9w8LP7Bont1rYeoV5plxD7RTEPRg==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "escalade": "^3.2.0", - "picocolors": "^1.1.1" - }, - "bin": { - "update-browserslist-db": "cli.js" - }, - "peerDependencies": { - "browserslist": ">= 4.21.0" - } - }, - "node_modules/v8-to-istanbul": { - "version": "9.3.0", - "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz", - "integrity": "sha512-kiGUalWN+rgBJ/1OHZsBtU4rXZOfj/7rKQxULKlIzwzQSvMJUUNgPwJEEh7gU6xEVxC0ahoOBvN2YI8GH6FNgA==", - "dev": true, - "license": "ISC", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.12", - "@types/istanbul-lib-coverage": "^2.0.1", - "convert-source-map": "^2.0.0" - }, - "engines": { - "node": ">=10.12.0" - } - }, - "node_modules/walker": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", - "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "makeerror": "1.0.12" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/wrap-ansi": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/write-file-atomic": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.2.tgz", - "integrity": "sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==", - "dev": true, - "license": "ISC", - "dependencies": { - "imurmurhash": "^0.1.4", - "signal-exit": "^3.0.7" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/y18n": { - "version": "5.0.8", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", - "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=10" - } - }, - "node_modules/yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "dev": true, - "license": "ISC" - }, - "node_modules/yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", - "dev": true, - "license": "MIT", - "dependencies": { - "cliui": "^8.0.1", - "escalade": "^3.1.1", - "get-caller-file": "^2.0.5", - "require-directory": "^2.1.1", - "string-width": "^4.2.3", - "y18n": "^5.0.5", - "yargs-parser": "^21.1.1" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/yargs-parser": { - "version": "21.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=12" - } - }, - "node_modules/yocto-queue": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - } - } -} diff --git a/examples/sdks/mistral-typescript/tests/package.json b/examples/sdks/mistral-typescript/tests/package.json deleted file mode 100644 index 97fb496ed..000000000 --- a/examples/sdks/mistral-typescript/tests/package.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "name": "tests", - "version": "1.0.0", - "main": "index.js", - "scripts": { - "test": "jest" - }, - "author": "", - "license": "ISC", - "description": "", - "devDependencies": { - "@types/jest": "^29.5.14", - "jest": "^29.7.0", - "ts-jest": "^29.2.5", - "typescript": "^5.7.3" - } -} diff --git a/examples/sdks/mistral-typescript/tests/tsconfig.json b/examples/sdks/mistral-typescript/tests/tsconfig.json deleted file mode 100644 index 1f7153b53..000000000 --- a/examples/sdks/mistral-typescript/tests/tsconfig.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "compilerOptions": { - "target": "ES6", - "module": "commonjs", - "strict": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true, - "moduleResolution": "node", - "resolveJsonModule": true, - "isolatedModules": true, - "types": ["jest", "node", "@types/jest"], - }, - "include": ["extra"], - "exclude": ["node_modules"] - } \ No newline at end of file diff --git a/examples/sdks/mistral-typescript/tsconfig.json b/examples/sdks/mistral-typescript/tsconfig.json deleted file mode 100644 index 94d81a34f..000000000 --- a/examples/sdks/mistral-typescript/tsconfig.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "compilerOptions": { - "incremental": true, - "tsBuildInfoFile": ".tsbuildinfo", - "target": "ES2020", - "lib": ["ES2022", "DOM", "DOM.Iterable"], - "jsx": "react-jsx", - - "module": "Node16", - "moduleResolution": "Node16", - - "allowJs": true, - - "declaration": true, - "declarationMap": true, - "sourceMap": true, - "outDir": ".", - - - // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json - "strict": true, - "allowUnusedLabels": false, - "allowUnreachableCode": false, - "exactOptionalPropertyTypes": true, - "useUnknownInCatchVariables": true, - "noFallthroughCasesInSwitch": true, - "noImplicitOverride": true, - "noImplicitReturns": true, - "noPropertyAccessFromIndexSignature": true, - "noUncheckedIndexedAccess": true, - "noUnusedLocals": true, - "noUnusedParameters": true, - "isolatedModules": true, - "checkJs": true, - "esModuleInterop": true, - "skipLibCheck": true, - "forceConsistentCasingInFileNames": true - }, - "include": ["src"], - "exclude": ["node_modules"] -} diff --git a/examples/specs/glean.yaml b/examples/specs/glean.yaml deleted file mode 100644 index 97caae800..000000000 --- a/examples/specs/glean.yaml +++ /dev/null @@ -1,12470 +0,0 @@ -openapi: 3.0.0 -info: - version: 0.9.0 - title: Glean API - description: | - # Introduction - In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean. - - # Usage guidelines - This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along - with a 6-month sunset period for anything that requires developers to adopt the new versions. - - # API Clients - Official API clients for the Glean Indexing API are available in multiple languages: - - - [Python](https://github.com/gleanwork/api-client-python) - - [TypeScript](https://github.com/gleanwork/api-client-typescript) - - [Go](https://github.com/gleanwork/api-client-go) - - [Java](https://github.com/gleanwork/api-client-java) - - These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice. - x-logo: - url: https://app.glean.com/images/glean-text2.svg - x-speakeasy-name: 'Glean API' -servers: - - url: https://{instance}-be.glean.com - variables: - instance: - default: instance-name - description: The instance name (typically the email domain without the TLD) that determines the deployment backend. -security: - - APIToken: [] -paths: - /rest/api/v1/activity: - post: - tags: - - Activity - summary: Report document activity - description: Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality. - operationId: activity - x-visibility: Public - x-codegen-request-body-name: payload - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Activity" - required: true - x-exportParamName: Activity - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: report - x-speakeasy-group: client.activity - /rest/api/v1/feedback: - post: - tags: - - Activity - summary: Report client activity - description: Report events that happen to results within a Glean client UI, such as search result views and clicks. This signal improves search quality. - operationId: feedback - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - name: feedback - in: query - description: A URL encoded versions of Feedback. This is useful for requests. - required: false - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Feedback" - x-exportParamName: Feedback - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.activity - /rest/api/v1/createannouncement: - post: - tags: - - Announcements - summary: Create Announcement - description: Create a textual announcement visible to some set of users based on department and location. - operationId: createannouncement - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAnnouncementRequest" - description: Announcement content - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Announcement" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: create - x-speakeasy-group: client.announcements - /rest/api/v1/deleteannouncement: - post: - tags: - - Announcements - summary: Delete Announcement - description: Delete an existing user-generated announcement. - operationId: deleteannouncement - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteAnnouncementRequest" - description: Delete announcement request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: delete - x-speakeasy-group: client.announcements - /rest/api/v1/updateannouncement: - post: - tags: - - Announcements - summary: Update Announcement - description: Update a textual announcement visible to some set of users based on department and location. - operationId: updateannouncement - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateAnnouncementRequest" - description: Announcement content. Id need to be specified for the announcement. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Announcement" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: update - x-speakeasy-group: client.announcements - /rest/api/v1/createanswer: - post: - tags: - - Answers - summary: Create Answer - description: Create a user-generated Answer that contains a question and answer. - operationId: createanswer - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAnswerRequest" - description: CreateAnswer request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Answer" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: create - x-speakeasy-group: client.answers - /rest/api/v1/deleteanswer: - post: - tags: - - Answers - summary: Delete Answer - description: Delete an existing user-generated Answer. - operationId: deleteanswer - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteAnswerRequest" - description: DeleteAnswer request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: delete - x-speakeasy-group: client.answers - /rest/api/v1/editanswer: - post: - tags: - - Answers - summary: Update Answer - description: Update an existing user-generated Answer. - operationId: editanswer - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EditAnswerRequest" - description: EditAnswer request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Answer" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: update - x-speakeasy-group: client.answers - /rest/api/v1/getanswer: - post: - tags: - - Answers - summary: Read Answer - description: Read the details of a particular Answer given its ID. - operationId: getanswer - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetAnswerRequest" - description: GetAnswer request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetAnswerResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.answers - /rest/api/v1/listanswers: - post: - tags: - - Answers - summary: List Answers - description: List Answers created by the current user. - operationId: listanswers - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ListAnswersRequest" - description: ListAnswers request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListAnswersResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: list - x-speakeasy-group: client.answers - /rest/api/v1/createauthtoken: - post: - tags: - - Authentication - summary: Create authentication token - description: | - Creates an authentication token for the authenticated user. These are - specifically intended to be used with the [Web SDK](https://developers.glean.com/web). - - Note: The tokens generated from this endpoint are **not** valid tokens - for use with the Client API (e.g. `/rest/api/v1/*`). - operationId: createauthtoken - x-visibility: Public - parameters: [] - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAuthTokenResponse" - "400": - description: Invalid Request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: createToken - x-speakeasy-group: client.authentication - /rest/api/v1/chat: - post: - tags: - - Chat - summary: Chat - description: Have a conversation with Glean AI. - operationId: chat - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ChatRequest" - examples: - defaultExample: - value: - messages: - - author: USER - messageType: CONTENT - fragments: - - text: What are the company holidays this year? - gptAgentExample: - value: - agentConfig: - agent: GPT - messages: - - author: USER - messageType: CONTENT - fragments: - - text: Who was the first person to land on the moon? - description: Includes chat history for Glean AI to respond to. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ChatResponse' - examples: - defaultExample: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - hasMoreFragments: false - agentConfig: - agent: DEFAULT - mode: DEFAULT - fragments: - - text: There are no holidays! - streamingExample: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: null - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: null - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: - - text: e are - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: - - text: no hol - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: false - fragments: - - text: idays! - updateResponse: - value: - messages: - - author: GLEAN_AI - messageType: UPDATE - agentConfig: - agent: DEFAULT - mode: DEFAULT - fragments: - - text: '**Reading:**' - - structuredResults: - - document: - id: '123' - title: Company Handbook - citationResponse: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - citations: - - sourceDocument: - id: '123' - title: Company Handbook - referenceRanges: - - textRange: - startIndex: 0 - endIndex: 12 - type: CITATION - "400": - description: Invalid request - "401": - description: Not Authorized - "408": - description: Request Timeout - "429": - description: Too Many Requests - x-speakeasy-group: client.chat - x-speakeasy-name-override: create - x-speakeasy-usage-example: true - /rest/api/v1/deleteallchats: - post: - tags: - - Chat - summary: Deletes all saved Chats owned by a user - description: Deletes all saved Chats a user has had and all their contained conversational content. - operationId: deleteallchats - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - x-speakeasy-name-override: deleteAll - x-speakeasy-group: client.chat - /rest/api/v1/deletechats: - post: - tags: - - Chat - summary: Deletes saved Chats - description: Deletes saved Chats and all their contained conversational content. - operationId: deletechats - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteChatsRequest" - required: true - x-exportParamName: Request - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: delete - x-speakeasy-group: client.chat - /rest/api/v1/getchat: - post: - tags: - - Chat - summary: Retrieves a Chat - description: Retrieves the chat history between Glean Assistant and the user for a given Chat. - operationId: getchat - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatRequest" - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.chat - /rest/api/v1/listchats: - post: - tags: - - Chat - summary: Retrieves all saved Chats - description: Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content. - operationId: listchats - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListChatsResponse" - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: list - x-speakeasy-group: client.chat - /rest/api/v1/getchatapplication: - post: - tags: - - Chat - summary: Gets the metadata for a custom Chat application - description: Gets the Chat application details for the specified application ID. - operationId: getchatapplication - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatApplicationRequest" - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatApplicationResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - x-speakeasy-name-override: retrieveApplication - x-speakeasy-group: client.chat - /rest/api/v1/uploadchatfiles: - post: - tags: - - Chat - summary: Upload files for Chat. - description: Upload files for Chat. - operationId: uploadchatfiles - x-visibility: Public - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - required: true - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/UploadChatFilesRequest" - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadChatFilesResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: uploadFiles - x-speakeasy-group: client.chat - /rest/api/v1/getchatfiles: - post: - tags: - - Chat - summary: Get files uploaded by a user for Chat. - description: Get files uploaded by a user for Chat. - operationId: getchatfiles - x-visibility: Public - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatFilesRequest" - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetChatFilesResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieveFiles - x-speakeasy-group: client.chat - /rest/api/v1/deletechatfiles: - post: - tags: - - Chat - summary: Delete files uploaded by a user for chat. - description: Delete files uploaded by a user for Chat. - operationId: deletechatfiles - x-visibility: Public - parameters: - - $ref: "#/components/parameters/timezoneOffset" - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteChatFilesRequest" - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: deleteFiles - x-speakeasy-group: client.chat - /rest/api/v1/agents/{agent_id}: - get: - tags: - - Agents - summary: Retrieve an agent - description: Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder. - operationId: getAgent - x-visibility: Preview - parameters: - - $ref: "#/components/parameters/timezoneOffset" - - description: The ID of the agent. - required: true - schema: - type: string - title: Agent ID - description: The ID of the agent. - name: agent_id - in: path - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/Agent" - "400": - description: Bad request - "403": - description: Forbidden - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "500": - description: Internal server error - x-speakeasy-group: client.agents - x-speakeasy-name-override: retrieve - /rest/api/v1/agents/{agent_id}/schemas: - get: - tags: - - Agents - summary: List an agent's schemas - description: Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure. - operationId: getAgentSchemas - x-visibility: Preview - parameters: - - $ref: "#/components/parameters/timezoneOffset" - - description: The ID of the agent. - required: true - schema: - type: string - title: Agent Id - description: The ID of the agent. - name: agent_id - in: path - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/AgentSchemas" - "400": - description: Bad request - "403": - description: Forbidden - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "500": - description: Internal server error - x-speakeasy-group: client.agents - x-speakeasy-name-override: retrieveSchemas - /rest/api/v1/agents/search: - post: - tags: - - Agents - summary: Search agents - description: Search for [agents](https://developers.glean.com/agents/agents-api) by agent name. - operationId: searchAgents - x-visibility: Preview - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/SearchAgentsRequest" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/SearchAgentsResponse" - "400": - description: Bad request - "403": - description: Forbidden - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "500": - description: Internal server error - x-speakeasy-group: client.agents - x-speakeasy-name-override: list - /rest/api/v1/agents/runs/stream: - post: - tags: - - Agents - summary: Create an agent run and stream the response - description: Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). - operationId: createAndStreamRun - x-visibility: Preview - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AgentRunCreate" - required: true - responses: - "200": - description: Success - content: - text/event-stream: - schema: - type: string - description: The server will send a stream of events in server-sent events (SSE) format. - example: | - id: 1 - event: message - data: {"messages":[{"role":"GLEAN_AI","content":[{"text":"Hello","type":"text"}]}]} - - id: 2 - event: message - data: {"messages":[{"role":"GLEAN_AI","content":[{"text":",","type":"text"}]}]} - - id: 3 - event: message - data: {"messages":[{"role":"GLEAN_AI","content":[{"text":" I'm","type":"text"}]}]} - - id: 4 - event: message - data: {"messages":[{"role":"GLEAN_AI","content":[{"text":" your","type":"text"}]}]} - "400": - description: Bad request - "403": - description: Forbidden - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Conflict - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "500": - description: Internal server error - x-speakeasy-group: client.agents - x-speakeasy-name-override: runStream - /rest/api/v1/agents/runs/wait: - post: - tags: - - Agents - summary: Create an agent run and wait for the response - description: Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. - operationId: createAndWaitRun - x-visibility: Preview - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AgentRunCreate" - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/AgentRunWaitResponse" - "400": - description: Bad request - "403": - description: Forbidden - "404": - description: Not Found - "409": - description: Conflict - "422": - description: Validation Error - "500": - description: Internal server error - x-speakeasy-group: client.agents - x-speakeasy-name-override: run - /rest/api/v1/addcollectionitems: - post: - tags: - - Collections - summary: Add Collection item - description: Add items to a Collection. - operationId: addcollectionitems - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AddCollectionItemsRequest" - description: Data describing the add operation. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddCollectionItemsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: addItems - x-speakeasy-group: client.collections - /rest/api/v1/createcollection: - post: - tags: - - Collections - summary: Create Collection - description: Create a publicly visible (empty) Collection of documents. - operationId: createcollection - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCollectionRequest" - description: Collection content plus any additional metadata for the request. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCollectionResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "422": - description: Semantic error - content: - application/json: - schema: - $ref: "#/components/schemas/CollectionError" - "429": - description: Too Many Requests - x-speakeasy-group: client.collections - x-speakeasy-name-override: create - /rest/api/v1/deletecollection: - post: - tags: - - Collections - summary: Delete Collection - description: Delete a Collection given the Collection's ID. - operationId: deletecollection - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCollectionRequest" - description: DeleteCollection request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "422": - description: Semantic error - content: - application/json: - schema: - $ref: "#/components/schemas/CollectionError" - "429": - description: Too Many Requests - x-speakeasy-name-override: delete - x-speakeasy-group: client.collections - /rest/api/v1/deletecollectionitem: - post: - tags: - - Collections - summary: Delete Collection item - description: Delete a single item from a Collection. - operationId: deletecollectionitem - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCollectionItemRequest" - description: Data describing the delete operation. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCollectionItemResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "422": - description: Failed to save deletion - "429": - description: Too Many Requests - x-speakeasy-name-override: deleteItem - x-speakeasy-group: client.collections - /rest/api/v1/editcollection: - post: - tags: - - Collections - summary: Update Collection - description: Update the properties of an existing Collection. - operationId: editcollection - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EditCollectionRequest" - description: Collection content plus any additional metadata for the request. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/EditCollectionResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "422": - description: Semantic error - content: - application/json: - schema: - $ref: "#/components/schemas/CollectionError" - "429": - description: Too Many Requests - x-speakeasy-name-override: update - x-speakeasy-group: client.collections - /rest/api/v1/editcollectionitem: - post: - tags: - - Collections - summary: Update Collection item - description: Update the URL, Glean Document ID, description of an item within a Collection given its ID. - operationId: editcollectionitem - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EditCollectionItemRequest" - description: Edit Collection Items request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/EditCollectionItemResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: updateItem - x-speakeasy-group: client.collections - /rest/api/v1/getcollection: - post: - tags: - - Collections - summary: Read Collection - description: Read the details of a Collection given its ID. Does not fetch items in this Collection. - operationId: getcollection - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetCollectionRequest" - description: GetCollection request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetCollectionResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.collections - /rest/api/v1/listcollections: - post: - tags: - - Collections - summary: List Collections - description: List all existing Collections. - operationId: listcollections - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ListCollectionsRequest" - description: ListCollections request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListCollectionsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: list - x-speakeasy-group: client.collections - /rest/api/v1/getdocpermissions: - post: - tags: - - Documents - summary: Read document permissions - description: Read the emails of all users who have access to the given document. - operationId: getdocpermissions - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocPermissionsRequest" - description: Document permissions request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocPermissionsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - "429": - description: Too Many Requests - x-speakeasy-name-override: retrievePermissions - x-speakeasy-group: client.documents - /rest/api/v1/getdocuments: - post: - tags: - - Documents - summary: Read documents - description: Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request. - operationId: getdocuments - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentsRequest" - description: Information about documents requested. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Documents does not exist, or user cannot access documents. - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.documents - /rest/api/v1/getdocumentsbyfacets: - post: - tags: - - Documents - summary: Read documents by facets - description: Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) macthing the given facet conditions. - operationId: getdocumentsbyfacets - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentsByFacetsRequest" - description: Information about facet conditions for documents to be retrieved. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentsByFacetsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "404": - description: Not Found - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieveByFacets - x-speakeasy-group: client.documents - /rest/api/v1/insights: - post: - tags: - - Insights - summary: Read insights - description: Reads the aggregate information for each user, query, and content. - operationId: insights - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/InsightsRequest" - description: Includes request params for insights dashboard data. - required: true - x-exportParamName: InsightsRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/InsightsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.insights - /rest/api/v1/messages: - post: - tags: - - Messages - summary: Read messages - description: Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams). - operationId: messages - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/MessagesRequest" - description: Includes request params such as the id for channel/message and direction. - required: true - x-exportParamName: MessagesRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/MessagesResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.messages - /rest/api/v1/editpin: - post: - tags: - - Pins - summary: Update pin - description: Update an existing user-generated pin. - operationId: editpin - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EditPinRequest" - description: Edit pins request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PinDocument" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: update - x-speakeasy-group: client.pins - /rest/api/v1/getpin: - post: - tags: - - Pins - summary: Read pin - description: Read pin details given its ID. - operationId: getpin - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetPinRequest" - description: Get pin request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetPinResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieve - x-speakeasy-group: client.pins - /rest/api/v1/listpins: - post: - tags: - - Pins - summary: List pins - description: Lists all pins. - operationId: listpins - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - type: object - description: List pins request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPinsResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: list - x-speakeasy-group: client.pins - /rest/api/v1/pin: - post: - tags: - - Pins - summary: Create pin - description: Pin a document as a result for a given search query.Pin results that are known to be a good match. - operationId: pin - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PinRequest" - description: Details about the document and query for the pin. - required: true - x-exportParamName: PinDocument - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PinDocument" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: create - x-speakeasy-group: client.pins - /rest/api/v1/unpin: - post: - tags: - - Pins - summary: Delete pin - description: Unpin a previously pinned result. - operationId: unpin - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Unpin" - description: Details about the pin being unpinned. - required: true - x-exportParamName: Unpin - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden from unpinning someone else's pin - "429": - description: Too Many Requests - x-speakeasy-name-override: remove - x-speakeasy-group: client.pins - /rest/api/v1/adminsearch: - post: - tags: - - Search - summary: Search the index (admin) - description: Retrieves results for search query without respect for permissions. This is available only to privileged users. - operationId: adminsearch - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchRequest" - description: Admin search request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SearchResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorInfo" - "422": - description: Invalid Query - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorInfo" - "429": - description: Too Many Requests - x-speakeasy-group: client.search - x-speakeasy-name-override: queryAsAdmin - /rest/api/v1/autocomplete: - post: - tags: - - Search - summary: Autocomplete - description: Retrieve query suggestions, operators and documents for the given partially typed query. - operationId: autocomplete - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AutocompleteRequest" - description: Autocomplete request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AutocompleteResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.search - x-speakeasy-name-override: autocomplete - /rest/api/v1/feed: - post: - tags: - - Search - summary: Feed of documents and events - description: The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more. - operationId: feed - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/FeedRequest" - description: Includes request params, client data and more for making user's feed. - required: true - x-exportParamName: FeedRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/FeedResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "408": - description: Request Timeout - "429": - description: Too Many Requests - x-speakeasy-name-override: retrieveFeed - x-speakeasy-group: client.search - /rest/api/v1/recommendations: - post: - tags: - - Search - summary: Recommend documents - description: Retrieve recommended documents for the given URL or Glean Document ID. - operationId: recommendations - x-visibility: Preview - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/RecommendationsRequest" - description: Recommendations request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RecommendationsResponse" - "202": - description: Accepted. The Retry-After header has a hint about when the response will be available - "204": - description: There are no recommendations for this URL - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Document does not exist or user cannot access document - "429": - description: Too Many Requests - x-speakeasy-group: client.search - x-speakeasy-name-override: recommendations - /rest/api/v1/search: - post: - tags: - - Search - summary: Search - description: Retrieve results from the index for the given query and filters. - operationId: search - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchRequest" - description: Search request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SearchResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Forbidden - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorInfo" - "408": - description: Request Timeout - "422": - description: Invalid Query - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorInfo" - "429": - description: Too Many Requests - x-speakeasy-group: client.search - x-speakeasy-name-override: query - /rest/api/v1/listentities: - post: - tags: - - Entities - summary: List entities - description: List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities. - operationId: listentities - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ListEntitiesRequest" - description: List people request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListEntitiesResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.entities - x-speakeasy-name-override: list - /rest/api/v1/people: - post: - tags: - - Entities - summary: Read people - description: Read people details for the given IDs. - operationId: people - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PeopleRequest" - description: People request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PeopleResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: readPeople - x-speakeasy-group: client.entities - /rest/api/v1/createshortcut: - post: - tags: - - Shortcuts - summary: Create shortcut - description: Create a user-generated shortcut that contains an alias and destination URL. - operationId: createshortcut - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateShortcutRequest" - description: CreateShortcut request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateShortcutResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: create - x-speakeasy-group: client.shortcuts - /rest/api/v1/deleteshortcut: - post: - tags: - - Shortcuts - summary: Delete shortcut - description: Delete an existing user-generated shortcut. - operationId: deleteshortcut - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteShortcutRequest" - description: DeleteShortcut request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: delete - x-speakeasy-group: client.shortcuts - /rest/api/v1/getshortcut: - post: - tags: - - Shortcuts - summary: Read shortcut - description: Read a particular shortcut's details given its ID. - operationId: getshortcut - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetShortcutRequest" - description: GetShortcut request - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetShortcutResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.shortcuts - x-speakeasy-name-override: retrieve - /rest/api/v1/listshortcuts: - post: - tags: - - Shortcuts - summary: List shortcuts - description: List shortcuts editable/owned by the currently authenticated user. - operationId: listshortcuts - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ListShortcutsPaginatedRequest" - description: Filters, sorters, paging params required for pagination - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListShortcutsPaginatedResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.shortcuts - x-speakeasy-name-override: list - /rest/api/v1/updateshortcut: - post: - tags: - - Shortcuts - summary: Update shortcut - description: Updates the shortcut with the given ID. - operationId: updateshortcut - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateShortcutRequest" - description: Shortcut content. Id need to be specified for the shortcut. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateShortcutResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: client.shortcuts - x-speakeasy-name-override: update - /rest/api/v1/summarize: - post: - tags: - - Summarize - summary: Summarize documents - description: Generate an AI summary of the requested documents. - operationId: summarize - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SummarizeRequest" - description: Includes request params such as the query and specs of the documents to summarize. - required: true - x-exportParamName: Request - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SummarizeResponse" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: summarize - x-speakeasy-group: client.documents - /rest/api/v1/addverificationreminder: - post: - tags: - - Verification - summary: Create verification - description: Creates a verification reminder for the document. Users can create verification reminders from different product surfaces. - operationId: addverificationreminder - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ReminderRequest" - description: Details about the reminder. - required: true - x-exportParamName: ReminderRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Verification" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Document does not exist, does not support verification or user cannot access document - "429": - description: Too Many Requests - x-speakeasy-name-override: addReminder - x-speakeasy-group: client.verification - /rest/api/v1/listverifications: - post: - tags: - - Verification - summary: List verifications - description: Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications. - operationId: listverifications - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - in: query - name: count - description: Maximum number of documents to return - required: false - schema: - type: integer - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/VerificationFeed" - "400": - description: Invalid request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: list - x-speakeasy-group: client.verification - /rest/api/v1/verify: - post: - tags: - - Verification - summary: Update verification - description: Verify documents to keep the knowledge up to date within customer corpus. - operationId: verify - x-visibility: Public - x-codegen-request-body-name: payload - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/VerifyRequest" - description: Details about the verification request. - required: true - x-exportParamName: VerifyRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/Verification" - "400": - description: Invalid request - "401": - description: Not Authorized - "403": - description: Document does not exist, does not support verification or user cannot access document - "429": - description: Too Many Requests - x-speakeasy-name-override: verify - x-speakeasy-group: client.verification - /rest/api/v1/tools/list: - get: - summary: List available tools - description: Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned. - x-visibility: Preview - parameters: - - in: query - name: toolNames - description: Optional array of tool names to filter by - required: false - schema: - type: array - items: - type: string - style: form - explode: false - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ToolsListResponse" - "400": - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "429": - description: Too Many Requests - tags: - - Tools - x-speakeasy-name-override: list - x-speakeasy-group: client.tools - /rest/api/v1/tools/call: - post: - summary: Execute the specified tool - description: Execute the specified tool with provided parameters - x-visibility: Preview - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ToolsCallRequest" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/ToolsCallResponse" - "400": - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "429": - description: Too Many Requests - tags: - - Tools - x-speakeasy-name-override: run - x-speakeasy-group: client.tools - /api/index/v1/indexdocument: - post: - summary: Index document - description: Adds a document to the index or updates an existing document. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/IndexDocumentRequest" - required: true - x-exportParamName: IndexDocumentRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - "429": - description: Too Many Requests - x-speakeasy-name-override: addOrUpdate - x-speakeasy-group: indexing.documents - /api/index/v1/indexdocuments: - post: - summary: Index documents - description: Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/IndexDocumentsRequest" - required: true - x-exportParamName: IndexDocumentsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - "429": - description: Too Many Requests - x-speakeasy-name-override: index - x-speakeasy-group: indexing.documents - /api/index/v1/bulkindexdocuments: - post: - summary: Bulk index documents - description: Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BulkIndexDocumentsRequest" - required: true - x-exportParamName: BulkIndexDocumentsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndex - x-speakeasy-group: indexing.documents - /api/index/v1/updatepermissions: - post: - summary: Update document permissions - description: Updates the permissions for a given document without modifying document content. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePermissionsRequest" - required: true - x-exportParamName: UpdatePermissionsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - "429": - description: Too Many Requests - x-speakeasy-name-override: updatePermissions - x-speakeasy-group: indexing.permissions - /api/index/v1/processalldocuments: - post: - summary: Schedules the processing of uploaded documents - description: | - Schedules the immediate processing of documents uploaded through the indexing API. By default the uploaded documents will be processed asynchronously but this API can be used to schedule processing of all documents on demand. - - If a `datasource` parameter is specified, processing is limited to that custom datasource. Without it, processing applies to all documents across all custom datasources. - #### Rate Limits - This endpoint is rate-limited to one usage every 3 hours. Exceeding this limit results in a 429 response code. Here's how the rate limit works: - 1. Calling `/processalldocuments` for datasource `foo` prevents another call for `foo` for 3 hours. - 2. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for `bar`. - 3. Calling `/processalldocuments` for all datasources prevents any datasource calls for 3 hours. - 4. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for all datasources. - - For more frequent document processing, contact Glean support. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessAllDocumentsRequest" - x-exportParamName: ProcessAllDocumentsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: processAll - x-speakeasy-group: indexing.documents - /api/index/v1/deletedocument: - post: - summary: Delete document - description: Deletes the specified document from the index. Succeeds if document is not present. - tags: - - Documents - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDocumentRequest" - required: true - x-exportParamName: DeleteDocumentRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: delete - x-speakeasy-group: indexing.documents - /api/index/v1/indexuser: - post: - summary: Index user - description: Adds a datasource user or updates an existing user. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/IndexUserRequest" - required: true - x-exportParamName: IndexUserRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: indexUser - x-speakeasy-group: indexing.permissions - /api/index/v1/bulkindexusers: - post: - summary: Bulk index users - description: Replaces the users in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BulkIndexUsersRequest" - required: true - x-exportParamName: BulkIndexUsersRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndexUsers - x-speakeasy-group: indexing.permissions - /api/index/v1/indexgroup: - post: - summary: Index group - description: Add or update a group in the datasource. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/IndexGroupRequest" - required: true - x-exportParamName: IndexGroupRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: indexGroup - x-speakeasy-group: indexing.permissions - /api/index/v1/bulkindexgroups: - post: - summary: Bulk index groups - description: Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BulkIndexGroupsRequest" - required: true - x-exportParamName: BulkIndexGroupsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndexGroups - x-speakeasy-group: indexing.permissions - /api/index/v1/indexmembership: - post: - summary: Index membership - description: Add the memberships of a group in the datasource. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/IndexMembershipRequest" - required: true - x-exportParamName: IndexMembershipRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: indexMembership - x-speakeasy-group: indexing.permissions - /api/index/v1/bulkindexmemberships: - post: - summary: Bulk index memberships for a group - description: Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BulkIndexMembershipsRequest" - required: true - x-exportParamName: BulkIndexMembershipsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndexMemberships - x-speakeasy-group: indexing.permissions - /api/index/v1/processallmemberships: - post: - summary: Schedules the processing of group memberships - description: | - Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessAllMembershipsRequest" - x-exportParamName: ProcessAllMembershipsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-name-override: processMemberships - x-speakeasy-group: indexing.permissions - /api/index/v1/deleteuser: - post: - summary: Delete user - description: Delete the user from the datasource. Silently succeeds if user is not present. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteUserRequest" - required: true - x-exportParamName: DeleteUserRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: deleteUser - x-speakeasy-group: indexing.permissions - /api/index/v1/deletegroup: - post: - summary: Delete group - description: Delete group from the datasource. Silently succeeds if group is not present. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteGroupRequest" - required: true - x-exportParamName: DeleteGroupRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: deleteGroup - x-speakeasy-group: indexing.permissions - /api/index/v1/deletemembership: - post: - summary: Delete membership - description: Delete membership to a group in the specified datasource. Silently succeeds if membership is not present. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteMembershipRequest" - required: true - x-exportParamName: DeleteMembershipRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: deleteMembership - x-speakeasy-group: indexing.permissions - /api/index/v1/debug/{datasource}/status: - post: - x-beta: true - summary: | - Beta: Get datasource status - description: | - Gather information about the datasource's overall status. Currently in beta, might undergo breaking changes without prior notice. - - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - tags: - - Troubleshooting - parameters: - - name: datasource - in: path - description: The datasource to get debug status for. - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugDatasourceStatusResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-name-override: status - x-speakeasy-group: indexing.datasource - /api/index/v1/debug/{datasource}/document: - post: - x-beta: true - summary: | - Beta: Get document information - description: | - Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice. - - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - tags: - - Troubleshooting - parameters: - - name: datasource - in: path - description: The datasource to which the document belongs - required: true - schema: - type: string - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugDocumentRequest" - required: true - x-exportParamName: DebugDocumentRequest - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugDocumentResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-group: indexing.documents - x-speakeasy-name-override: debug - /api/index/v1/debug/{datasource}/documents: - post: - x-beta: true - summary: | - Beta: Get information of a batch of documents - description: | - Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. - - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - tags: - - Troubleshooting - parameters: - - name: datasource - in: path - description: The datasource to which the document belongs - required: true - schema: - type: string - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugDocumentsRequest" - required: true - x-exportParamName: DebugDocumentsRequest - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugDocumentsResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-group: indexing.documents - x-speakeasy-name-override: debugMany - /api/index/v1/debug/{datasource}/user: - post: - x-beta: true - summary: | - Beta: Get user information - description: | - Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice. - - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - tags: - - Troubleshooting - parameters: - - name: datasource - in: path - description: The datasource to which the user belongs - required: true - schema: - type: string - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugUserRequest" - required: true - x-exportParamName: DebugUserRequest - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DebugUserResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-name-override: debug - x-speakeasy-group: indexing.people - /api/index/v1/checkdocumentaccess: - post: - summary: Check document access - description: | - Check if a given user has access to access a document in a custom datasource - - Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information. - tags: - - Troubleshooting - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CheckDocumentAccessRequest" - required: true - x-exportParamName: CheckDocumentAccessRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CheckDocumentAccessResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: indexing.documents - x-speakeasy-name-override: checkAccess - /api/index/v1/getdocumentstatus: - post: - deprecated: true - summary: Get document upload and indexing status - description: | - Intended for debugging/validation. Fetches the current upload and indexing status of documents. - - Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information. - tags: - - Troubleshooting - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentStatusRequest" - required: true - x-exportParamName: GetDocumentStatusRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentStatusResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-group: indexing.documents - x-speakeasy-name-override: status - /api/index/v1/getdocumentcount: - post: - deprecated: true - summary: Get document count - description: | - Fetches document count for the specified custom datasource. - - Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - tags: - - Troubleshooting - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentCountRequest" - required: true - x-exportParamName: GetDocumentCountRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDocumentCountResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-group: indexing.documents - x-speakeasy-name-override: count - /api/index/v1/getusercount: - post: - deprecated: true - summary: Get user count - description: | - Fetches user count for the specified custom datasource. - - Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information. - tags: - - Troubleshooting - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetUserCountRequest" - required: true - x-exportParamName: GetUserCountRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetUserCountResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: count - x-speakeasy-group: indexing.people - /api/index/v1/betausers: - post: - summary: Beta users - description: Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled. - tags: - - Permissions - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GreenlistUsersRequest" - required: true - x-exportParamName: GreenlistUsersRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: authorizeBetaUsers - x-speakeasy-group: indexing.permissions - /api/index/v1/adddatasource: - post: - summary: Add or update datasource - description: Add or update a custom datasource and its schema. - tags: - - Datasources - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CustomDatasourceConfig" - required: true - x-exportParamName: DatasourceConfig - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-name-override: add - x-speakeasy-group: indexing.datasources - /api/index/v1/getdatasourceconfig: - post: - summary: Get datasource config - description: Fetches the datasource config for the specified custom datasource. - tags: - - Datasources - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/GetDatasourceConfigRequest" - required: true - x-exportParamName: GetDatasourceConfigRequest - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CustomDatasourceConfig" - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: retrieveConfig - x-speakeasy-group: indexing.datasources - /api/index/v1/rotatetoken: - post: - summary: Rotate token - description: Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the `/rotatetoken` request. Please refer to [Token rotation](https://developers.glean.com/indexing/authentication/token-rotation) documentation for more information. - tags: - - Authentication - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RotateTokenResponse" - "400": - description: Bad Request - "401": - description: Not Authorized - x-speakeasy-name-override: rotateToken - x-speakeasy-group: indexing.authentication - /api/index/v1/indexemployee: - post: - summary: Index employee - description: Adds an employee or updates information about an employee - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/IndexEmployeeRequest" - required: true - x-exportParamName: IndexEmployeeRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: index - x-speakeasy-group: indexing.people - /api/index/v1/bulkindexemployees: - post: - summary: Bulk index employees - description: Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/BulkIndexEmployeesRequest" - required: true - x-exportParamName: BulkIndexEmployeesRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndex - x-speakeasy-group: indexing.people - /api/index/v1/indexemployeelist: {} - /api/index/v1/processallemployeesandteams: - post: - summary: Schedules the processing of uploaded employees and teams - description: | - Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand. - tags: - - People - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "429": - description: Too Many Requests - x-speakeasy-name-override: processAllEmployeesAndTeams - x-speakeasy-group: indexing.people - /api/index/v1/deleteemployee: - post: - summary: Delete employee - description: Delete an employee. Silently succeeds if employee is not present. - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DeleteEmployeeRequest" - required: true - x-exportParamName: DeleteEmployeeRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: delete - x-speakeasy-group: indexing.people - /api/index/v1/indexteam: - post: - summary: Index team - description: Adds a team or updates information about a team - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/IndexTeamRequest" - required: true - x-exportParamName: IndexTeamRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: indexTeam - x-speakeasy-group: indexing.people - /api/index/v1/deleteteam: - post: - summary: Delete team - description: Delete a team based on provided id. - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/DeleteTeamRequest" - required: true - x-exportParamName: DeleteTeamRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: deleteTeam - x-speakeasy-group: indexing.people - /api/index/v1/bulkindexteams: - post: - summary: Bulk index teams - description: Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints. - tags: - - People - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/BulkIndexTeamsRequest" - required: true - x-exportParamName: BulkIndexTeamsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndexTeams - x-speakeasy-group: indexing.people - /api/index/v1/bulkindexshortcuts: - post: - summary: Bulk index external shortcuts - description: Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the `/uploadshortcuts` endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to [this](https://help.glean.com/en/articles/5628838-how-go-links-work) page. - tags: - - Shortcuts - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/BulkIndexShortcutsRequest" - required: true - x-exportParamName: BulkIndexShortcutsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: bulkIndex - x-speakeasy-group: indexing.shortcuts - /api/index/v1/uploadshortcuts: - post: - summary: Upload shortcuts - description: Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded. - tags: - - Shortcuts - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UploadShortcutsRequest" - required: true - x-exportParamName: UploadShortcutsRequest - responses: - "200": - description: OK - "400": - description: Bad Request - "401": - description: Not Authorized - "409": - description: Conflict - x-speakeasy-name-override: upload - x-speakeasy-group: indexing.shortcuts - /rest/api/v1/governance/data/policies/{id}: - get: - description: Fetches the specified policy version, or the latest if no version is provided. - summary: Gets specified policy - operationId: getpolicy - x-visibility: Public - tags: - - Governance - parameters: - - name: id - in: path - description: The id of the policy to fetch. - required: true - schema: - type: string - - name: version - in: query - description: The version of the policy to fetch. Each time a policy is updated, the older version is still stored. If this is left empty, the latest policy is fetched. - required: false - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetDlpReportResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.policies - x-speakeasy-name-override: retrieve - post: - description: Updates an existing policy. - summary: Updates an existing policy - operationId: updatepolicy - tags: - - Governance - parameters: - - name: id - in: path - description: The id of the policy to fetch. - required: true - schema: - type: string - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDlpReportRequest" - required: true - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDlpReportResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.policies - x-speakeasy-name-override: update - /rest/api/v1/governance/data/policies: - get: - description: Lists policies with filtering. - summary: Lists policies - operationId: listpolicies - x-visibility: Public - tags: - - Governance - parameters: - - name: autoHide - in: query - description: Filter to return reports with a given value of auto-hide. - required: false - schema: - type: boolean - - name: frequency - in: query - description: Filter to return reports with a given frequency. - required: false - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDlpReportsResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.policies - x-speakeasy-name-override: list - post: - description: Creates a new policy with specified specifications and returns its id. - summary: Creates new policy - operationId: createpolicy - x-visibility: Public - tags: - - Governance - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/CreateDlpReportRequest" - required: true - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/CreateDlpReportResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.policies - x-speakeasy-name-override: create - /rest/api/v1/governance/data/policies/{id}/download: - get: - description: Downloads CSV violations report for a specific policy id. This does not support continuous policies. - summary: Downloads violations CSV for policy - operationId: downloadpolicycsv - x-visibility: Public - tags: - - Governance - parameters: - - name: id - in: path - description: The id of the policy to download violations for. - required: true - schema: - type: string - responses: - "200": - description: Downloads csv of batch policy violations. - content: - text/csv; charset=UTF-8: - schema: - description: CSV of all the violations found for this policy. - type: string - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.policies - x-speakeasy-name-override: download - /rest/api/v1/governance/data/reports: - post: - description: Creates a new one-time report and executes its batch job. - summary: Creates new one-time report - operationId: createreport - x-visibility: Public - tags: - - Governance - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDlpConfigRequest" - required: true - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDlpConfigResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.reports - x-speakeasy-name-override: create - /rest/api/v1/governance/data/reports/{id}/download: - get: - description: Downloads CSV violations report for a specific report id. - summary: Downloads violations CSV for report - operationId: downloadreportcsv - x-visibility: Public - tags: - - Governance - parameters: - - name: id - in: path - description: The id of the report to download violations for. - required: true - schema: - type: string - responses: - "200": - description: Downloads csv of one-time report violations. - content: - text/csv; charset=UTF-8: - schema: - description: CSV of all the violations found for this report. - type: string - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.reports - x-speakeasy-name-override: download - /rest/api/v1/governance/data/reports/{id}/status: - get: - description: Fetches the status of the run corresponding to the report-id. - summary: Fetches report run status - operationId: getreportstatus - x-visibility: Public - tags: - - Governance - parameters: - - name: id - in: path - description: The id of the report to get run status for. - required: true - schema: - type: string - responses: - "200": - description: Fetches status of report run. - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/ReportStatusResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.data.reports - x-speakeasy-name-override: status - /rest/api/v1/governance/documents/visibilityoverrides: - get: - description: Fetches the visibility override status of the documents passed. - summary: Fetches documents visibility - operationId: getdocvisibility - x-visibility: Public - tags: - - Governance - parameters: - - name: docIds - in: query - description: List of doc-ids which will have their hide status fetched. - schema: - type: array - items: - type: string - responses: - "200": - description: The visibility status of documents - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/GetDocumentVisibilityOverridesResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.documents.visibilityoverrides - x-speakeasy-name-override: list - post: - description: Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents. - summary: Hide or unhide docs - operationId: setdocvisibility - x-visibility: Public - tags: - - Governance - requestBody: - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDocumentVisibilityOverridesRequest" - required: true - responses: - "200": - description: OK - content: - application/json; charset=UTF-8: - schema: - $ref: "#/components/schemas/UpdateDocumentVisibilityOverridesResponse" - "403": - description: Permissions error - "500": - description: Internal error - x-speakeasy-group: client.governance.documents.visibilityoverrides - x-speakeasy-name-override: create - /rest/api/v1/chat#stream: - post: - tags: - - Chat - summary: Chat - description: Have a conversation with Glean AI. - operationId: chatStream - x-visibility: Public - x-codegen-request-body-name: payload - parameters: - - $ref: '#/components/parameters/timezoneOffset' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ChatRequest' - examples: - defaultExample: - value: - messages: - - author: USER - messageType: CONTENT - fragments: - - text: What are the company holidays this year? - gptAgentExample: - value: - agentConfig: - agent: GPT - messages: - - author: USER - messageType: CONTENT - fragments: - - text: Who was the first person to land on the moon? - description: Includes chat history for Glean AI to respond to. - required: true - x-exportParamName: Request - responses: - '200': - description: OK - content: - text/plain: - schema: - $ref: '#/components/schemas/ChatRequestStream' - examples: - defaultExample: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - hasMoreFragments: false - agentConfig: - agent: DEFAULT - mode: DEFAULT - fragments: - - text: There are no holidays! - streamingExample: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: null - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: null - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: - - text: e are - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: true - fragments: - - text: no hol - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - hasMoreFragments: false - fragments: - - text: idays! - updateResponse: - value: - messages: - - author: GLEAN_AI - messageType: UPDATE - agentConfig: - agent: DEFAULT - mode: DEFAULT - fragments: - - text: '**Reading:**' - - structuredResults: - - document: - id: '123' - title: Company Handbook - citationResponse: - value: - messages: - - author: GLEAN_AI - messageType: CONTENT - agentConfig: - agent: DEFAULT - mode: DEFAULT - citations: - - sourceDocument: - id: '123' - title: Company Handbook - referenceRanges: - - textRange: - startIndex: 0 - endIndex: 12 - type: CITATION - '400': - description: Invalid request - '401': - description: Not Authorized - '408': - description: Request Timeout - '429': - description: Too Many Requests - x-speakeasy-group: client.chat - x-speakeasy-name-override: createStream - x-speakeasy-usage-example: true -components: - securitySchemes: - APIToken: - scheme: bearer - type: http - schemas: - ActivityEventParams: - properties: - bodyContent: - description: The HTML content of the page body. - type: string - datasourceInstance: - type: string - description: The full datasource instance name inferred from the URL of the event - datasource: - type: string - description: The datasource without the instance inferred from the URL of the event - instanceOnlyName: - type: string - description: The instance only name of the datasource instance, e.g. 1 for jira_1, inferred from the URL of the event - duration: - description: Length in seconds of the activity. For VIEWS, this represents the amount the page was visible in the foreground. - type: integer - query: - description: The user's search query associated with a SEARCH. - type: string - referrer: - description: The referring URL of the VIEW or SEARCH. - type: string - title: - description: The page title associated with the URL of the event - type: string - truncated: - description: Indicates that the parameters are incomplete and more parameters may be sent with the same action+timestamp+URL in the future. This is used for sending the duration when a `VIEW` is finished. - type: boolean - ActivityEvent: - required: - - action - - source - - timestamp - - url - properties: - id: - type: string - description: Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - action: - type: string - description: The type of activity this represents. - x-enumDescriptions: - VIEW: Represents a visit to the given `url`. - EDIT: Represents an edit of the document represented by the `url`. - SEARCH: Represents a search performed at the given `url`. - COMMENT: Represents a comment on the document represented by the `url`. - CRAWL: Represents an explicit request to index the given `url` along with associated attributes in this payload. - HISTORICAL_SEARCH: Represents a search performed at the given `url` as indicated by the user's history. - HISTORICAL_VIEW: Represents a visit to the given `url` as indicated by the user's history. - enum: - - VIEW - - EDIT - - SEARCH - - COMMENT - - CRAWL - - HISTORICAL_SEARCH - - HISTORICAL_VIEW - params: - $ref: "#/components/schemas/ActivityEventParams" - timestamp: - type: string - description: The ISO 8601 timestamp when the activity began. - format: date-time - url: - description: The URL of the activity. - type: string - Activity: - required: - - events - properties: - events: - type: array - items: - $ref: "#/components/schemas/ActivityEvent" - example: - events: - - url: https://example.com/ - action: HISTORICAL_VIEW - timestamp: "2000-01-23T04:56:07.000Z" - - url: https://example.com/search?q=query - action: SEARCH - timestamp: "2000-01-23T04:56:07.000Z" - params: - query: query - - url: https://example.com/ - action: VIEW - timestamp: "2000-01-23T04:56:07.000Z" - params: - duration: 20 - referrer: https://example.com/document - SessionInfo: - properties: - sessionTrackingToken: - type: string - description: A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - tabId: - type: string - description: A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - lastSeen: - type: string - format: date-time - description: The last time the server saw this token. - lastQuery: - type: string - description: The last query seen by the server. - User: - properties: - userID: - description: An opaque user ID for the claimed authority (i.e., the actas param, or the origid if actas is not specified). - type: string - origID: - description: An opaque user ID for the authenticated user (ignores actas). - type: string - FeedbackChatExchange: - properties: - timestamp: - type: integer - format: int64 - description: Unix timestamp in millis for the chat request. - agent: - type: string - description: Either DEFAULT (company knowledge) or GPT (world knowledge). - userQuery: - type: string - description: Initial query entered by the user. - searchQuery: - type: string - description: Search query performed by the agent. - resultDocuments: - type: array - description: List of documents read by the agent. - items: - properties: - title: - type: string - url: - type: string - response: - type: string - ManualFeedbackInfo: - properties: - email: - type: string - description: The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event. - deprecated: true - source: - type: string - description: The source associated with the Feedback.event.MANUAL_FEEDBACK event. - enum: - - AUTOCOMPLETE - - CALENDAR - - CHAT - - CHAT_GENERAL - - CONCEPT_CARD - - DESKTOP_APP - - DISAMBIGUATION_CARD - - EXPERT_DETECTION - - FEED - - GENERATED_Q_AND_A - - INLINE_MENU - - NATIVE_RESULT - - Q_AND_A - - RELATED_QUESTIONS - - REPORT_ISSUE - - SCIOBOT - - SEARCH - - SIDEBAR - - SUMMARY - issue: - type: string - description: The issue the user indicated in the feedback. - deprecated: true - issues: - type: array - description: The issue(s) the user indicated in the feedback. - items: - type: string - enum: - - INACCURATE_RESPONSE - - INCOMPLETE_OR_NO_ANSWER - - INCORRECT_CITATION - - MISSING_CITATION - - OTHER - - OUTDATED_RESPONSE - - RESULT_MISSING - - RESULT_SHOULD_NOT_APPEAR - - RESULTS_HELPFUL - - RESULTS_POOR_ORDER - - TOO_MUCH_ONE_KIND - imageUrls: - type: array - items: - type: string - description: URLs of images uploaded by user when providing feedback - query: - type: string - description: The query associated with the Feedback.event.MANUAL_FEEDBACK event. - obscuredQuery: - type: string - description: The query associated with the Feedback.event.MANUAL_FEEDBACK event, but obscured such that the vowels are replaced with special characters. For search feedback events only. - activeTab: - type: string - description: Which tabs the user had chosen at the time of the Feedback.event.MANUAL_FEEDBACK event. For search feedback events only. - comments: - type: string - description: The comments users can optionally add to the Feedback.event.MANUAL_FEEDBACK events. - searchResults: - type: array - items: - type: string - description: The array of search result Glean Document IDs, ordered by top to bottom result. - previousMessages: - type: array - items: - type: string - description: The array of previous messages in a chat session, ordered by oldest to newest. - chatTranscript: - type: array - items: - $ref: "#/components/schemas/FeedbackChatExchange" - description: Array of previous request/response exchanges, ordered by oldest to newest. - numQueriesFromFirstRun: - type: integer - description: How many times this query has been run in the past. - vote: - type: string - description: The vote associated with the Feedback.event.MANUAL_FEEDBACK event. - enum: - - UPVOTE - - DOWNVOTE - rating: - type: integer - description: A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive. - ratingKey: - type: string - description: A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied". - ratingScale: - type: integer - description: The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2. - SideBySideImplementation: - properties: - implementationId: - type: string - description: Unique identifier for this implementation variant. - implementationName: - type: string - description: Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude"). - searchParams: - type: object - description: The search/chat parameters used for this implementation. - additionalProperties: - type: string - response: - type: string - description: The full response generated by this implementation. - responseMetadata: - type: object - description: Metadata about the response (e.g., latency, token count). - properties: - latencyMs: - type: integer - description: Time taken to generate the response in milliseconds. - tokenCount: - type: integer - description: Number of tokens in the response. - modelUsed: - type: string - description: The specific model version used. - ManualFeedbackSideBySideInfo: - properties: - email: - type: string - description: The email address of the user who submitted the side-by-side feedback. - source: - type: string - description: The source associated with the side-by-side feedback event. - enum: - - LIVE_EVAL - - CHAT - - SEARCH - query: - type: string - description: The query or prompt that was evaluated across multiple implementations. - implementations: - type: array - description: Array of implementations that were compared side-by-side. - items: - $ref: "#/components/schemas/SideBySideImplementation" - evaluationSessionId: - type: string - description: Unique identifier for this evaluation session to group related feedback events. - implementationId: - type: string - description: The ID of the implementation this specific feedback event is for. - vote: - type: string - description: The vote for this specific implementation. - enum: - - UPVOTE - - DOWNVOTE - - NEUTRAL - comments: - type: string - description: Specific feedback comments for this implementation. - SeenFeedbackInfo: - properties: - isExplicit: - type: boolean - description: The confidence of the user seeing the object is high because they explicitly interacted with it e.g. answer impression in SERP with additional user interaction. - UserViewInfo: - properties: - docId: - type: string - description: Unique Glean Document ID of the associated document. - docTitle: - type: string - description: Title of associated document. - docUrl: - type: string - description: URL of associated document. - WorkflowFeedbackInfo: - properties: - source: - type: string - enum: - - ZERO_STATE - - LIBRARY - - HOMEPAGE - description: Where the feedback of the workflow originated from - Feedback: - required: - - event - - trackingTokens - properties: - id: - type: string - description: Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. - category: - type: string - description: The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. - enum: - - ANNOUNCEMENT - - AUTOCOMPLETE - - COLLECTIONS - - FEED - - SEARCH - - CHAT - - NTP - - WORKFLOWS - - SUMMARY - - GENERAL - - PROMPTS - trackingTokens: - type: array - description: A list of server-generated trackingTokens to which this event applies. - items: - type: string - event: - type: string - description: The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. - x-enumDescriptions: - CLICK: The object's primary link was clicked with the intent to view its full representation. Depending on the object type, this may imply an external navigation or navigating to a new page or view within the Glean app. - CONTAINER_CLICK: A link to the object's parent container (e.g. the folder in which it's located) was clicked. - COPY_LINK: The user copied a link to the primary link. - CREATE: The user creates a document. - DISMISS: The user dismissed the object such that it was hidden from view. - DOWNVOTE: The user gave feedback that the object was not useful. - EMAIL: The user attempted to send an email. - EXECUTE: The user executed the object (e.g. ran a workflow). - FILTER: The user applied a filter. - FIRST_TOKEN: The first token of a streaming response is received. - FOCUS_IN: The user clicked into an interactive element, e.g. the search box. - LAST_TOKEN: The final token of a streaming response is received. - MANUAL_FEEDBACK: The user submitted textual manual feedback regarding the object. - MANUAL_FEEDBACK_SIDE_BY_SIDE: The user submitted comparative feedback for multiple side-by-side implementations. - MARK_AS_READ: The user explicitly marked the content as read. - MESSAGE: The user attempted to send a message using their default messaing app. - MIDDLE_CLICK: The user middle clicked the object's primary link with the intent to open its full representation in a new tab. - PAGE_BLUR: The user puts a page out of focus but keeps it in the background. - PAGE_FOCUS: The user puts a page in focus, meaning it is the first to receive keyboard events. - PAGE_LEAVE: The user leaves a page and it is unloaded (by clicking a link, closing the tab/window, etc). - PREVIEW: The user clicked the object's inline preview affordance. - RIGHT_CLICK: The user right clicked the object's primary link. This may indicate an intent to open it in a new tab or copy it. - SECTION_CLICK: The user clicked a link to a subsection of the primary object. - SEEN: The user has likely seen the object (e.g. took action to make the object visible within the user's viewport). - SHARE: The user shared the object with another user. - SHOW_MORE: The user clicked the object's show more affordance. - UPVOTE: The user gave feedback that the object was useful. - VIEW: The object was visible within the user's viewport. - VISIBLE: The object was visible within the user's viewport. - enum: - - CLICK - - CONTAINER_CLICK - - COPY_LINK - - CREATE - - DISMISS - - DOWNVOTE - - EMAIL - - EXECUTE - - FILTER - - FIRST_TOKEN - - FOCUS_IN - - LAST_TOKEN - - MANUAL_FEEDBACK - - MANUAL_FEEDBACK_SIDE_BY_SIDE - - MARK_AS_READ - - MESSAGE - - MIDDLE_CLICK - - PAGE_BLUR - - PAGE_FOCUS - - PAGE_LEAVE - - PREVIEW - - RELATED_CLICK - - RIGHT_CLICK - - SECTION_CLICK - - SEEN - - SHARE - - SHOW_MORE - - UPVOTE - - VIEW - - VISIBLE - position: - type: integer - description: Position of the element in the case that the client controls order (such as feed and autocomplete). - payload: - type: string - description: For type MANUAL_FEEDBACK, contains string of user feedback. For autocomplete, partial query string. For feed, string of user feedback in addition to manual feedback signals extracted from all suggested content. - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - timestamp: - type: string - description: The ISO 8601 timestamp when the event occured. - format: date-time - user: - $ref: "#/components/schemas/User" - pathname: - type: string - description: The path the client was at when the feedback event triggered. - channels: - type: array - description: Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean. - items: - type: string - enum: - - COMPANY - - GLEAN - url: - type: string - description: The URL the client was at when the feedback event triggered. - uiTree: - description: The UI element tree associated with the event, if any. - items: - type: string - type: array - uiElement: - type: string - description: The UI element associated with the event, if any. - manualFeedbackInfo: - $ref: "#/components/schemas/ManualFeedbackInfo" - manualFeedbackSideBySideInfo: - $ref: "#/components/schemas/ManualFeedbackSideBySideInfo" - seenFeedbackInfo: - $ref: "#/components/schemas/SeenFeedbackInfo" - userViewInfo: - $ref: "#/components/schemas/UserViewInfo" - workflowFeedbackInfo: - $ref: "#/components/schemas/WorkflowFeedbackInfo" - applicationId: - type: string - description: The application ID of the client that sent the feedback event. - agentId: - type: string - description: The agent ID of the client that sent the feedback event. - example: - trackingTokens: - - trackingTokens - event: VIEW - StructuredTextMutableProperties: - required: - - text - properties: - text: - type: string - example: From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. - ConnectorType: - type: string - description: The source from which document content was pulled, e.g. an API crawl or browser history - enum: - - API_CRAWL - - BROWSER_CRAWL - - BROWSER_HISTORY - - BUILTIN - - FEDERATED_SEARCH - - PUSH_API - - WEB_CRAWL - - NATIVE_HISTORY - DocumentContent: - properties: - fullTextList: - type: array - items: - type: string - description: The plaintext content of the document. - Document: - properties: - id: - type: string - description: The Glean Document ID. - datasource: - type: string - description: The app or other repository type from which the document was extracted - connectorType: - $ref: "#/components/schemas/ConnectorType" - docType: - type: string - description: The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - content: - $ref: "#/components/schemas/DocumentContent" - containerDocument: - $ref: "#/components/schemas/Document" - parentDocument: - $ref: "#/components/schemas/Document" - title: - type: string - description: The title of the document. - url: - type: string - description: A permalink for the document. - metadata: - $ref: "#/components/schemas/DocumentMetadata" - sections: - type: array - description: A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - items: - $ref: "#/components/schemas/DocumentSection" - SearchProviderInfo: - properties: - name: - type: string - description: Name of the search provider. - logoUrl: - type: string - description: URL to the provider's logo. - searchLinkUrlTemplate: - type: string - description: URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion. - example: - name: Google - logo: https://app.glean.com/images/feather/globe.svg - searchLinkUrlTemplate: https://www.google.com/search?q={query}&hl=en - FacetFilterValue: - properties: - value: - type: string - example: Spreadsheet - relationType: - type: string - enum: - - EQUALS - - ID_EQUALS - - LT - - GT - - NOT_EQUALS - example: EQUALS - isNegated: - type: boolean - deprecated: true - description: DEPRECATED - please use relationType instead - FacetFilter: - properties: - fieldName: - type: string - example: owner - values: - type: array - items: - $ref: "#/components/schemas/FacetFilterValue" - description: Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - groupName: - type: string - example: Spreadsheet - description: Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - example: - fieldName: type - values: - - value: Spreadsheet - relationType: EQUALS - - value: Presentation - relationType: EQUALS - FacetFilterSet: - properties: - filters: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - description: Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - FacetBucketFilter: - properties: - facet: - type: string - description: The facet whose buckets should be filtered. - prefix: - type: string - description: The per-term prefix that facet buckets should be filtered on. - AuthToken: - required: - - accessToken - - datasource - properties: - accessToken: - type: string - datasource: - type: string - scope: - type: string - tokenType: - type: string - authUser: - description: Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin. - type: string - expiration: - description: Unix timestamp when this token expires (in seconds since epoch UTC). - type: integer - format: int64 - example: - accessToken: 123abc - datasource: gmail - scope: email profile https://www.googleapis.com/auth/gmail.readonly - tokenType: Bearer - authUser: "1" - DocumentSpec: - x-multiple-discriminators: true - oneOf: - - type: object - required: - - url - properties: - url: - type: string - x-discriminator: true - description: The URL of the document. - - type: object - required: - - id - properties: - id: - type: string - x-discriminator: true - description: The ID of the document. - - type: object - required: - - contentId - - ugcType - properties: - ugcType: - type: string - enum: - - ANNOUNCEMENTS - - ANSWERS - - COLLECTIONS - - SHORTCUTS - - CHATS - description: The type of the user generated content (UGC datasource). - contentId: - type: integer - x-discriminator: true - description: The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS. - docType: - type: string - description: The specific type of the user generated content type. - - type: object - required: - - ugcType - - ugcId - properties: - ugcType: - type: string - enum: - - ANNOUNCEMENTS - - ANSWERS - - COLLECTIONS - - SHORTCUTS - - CHATS - description: The type of the user generated content (UGC datasource). - ugcId: - type: string - x-discriminator: true - description: The string id for user generated content. Used for CHATS. - docType: - type: string - description: The specific type of the user generated content type. - RestrictionFilters: - properties: - containerSpecs: - description: "Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections." - type: array - items: - $ref: "#/components/schemas/DocumentSpec" - SearchRequestOptions: - required: - - facetBucketSize - properties: - datasourceFilter: - type: string - description: Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - datasourcesFilter: - type: array - items: - type: string - description: Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - queryOverridesFacetFilters: - type: boolean - description: If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - facetFilters: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - description: A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - facetFilterSets: - type: array - items: - $ref: "#/components/schemas/FacetFilterSet" - description: A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - facetBucketFilter: - $ref: "#/components/schemas/FacetBucketFilter" - facetBucketSize: - type: integer - description: The maximum number of FacetBuckets to return in each FacetResult. - defaultFacets: - type: array - items: - type: string - description: Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - authTokens: - type: array - description: Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - items: - $ref: "#/components/schemas/AuthToken" - fetchAllDatasourceCounts: - type: boolean - description: Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - responseHints: - type: array - description: Array of hints containing which fields should be populated in the response. - items: - type: string - description: Hints for the response content. - x-enumDescriptions: - ALL_RESULT_COUNTS: Return result counts for each result set which has non-zero results, even when the request itself is limited to a subset. - FACET_RESULTS: Return only facet results. - QUERY_METADATA: Returns result counts for each result set which has non-zero results, as well as other information about the search such as suggested spelling corrections. - RESULTS: Return search result documents. - SPELLCHECK_METADATA: Return metadata pertaining to spellcheck results. - enum: - - ALL_RESULT_COUNTS - - FACET_RESULTS - - QUERY_METADATA - - RESULTS - - SPELLCHECK_METADATA - timezoneOffset: - type: integer - description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - disableSpellcheck: - type: boolean - description: Whether or not to disable spellcheck. - disableQueryAutocorrect: - type: boolean - description: Disables automatic adjustment of the input query for spelling corrections or other reasons. - returnLlmContentOverSnippets: - type: boolean - description: Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - inclusions: - $ref: "#/components/schemas/RestrictionFilters" - description: A list of filters which restrict the search results to only the specified content. - exclusions: - $ref: "#/components/schemas/RestrictionFilters" - description: A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets. - example: - datasourceFilter: JIRA - datasourcesFilter: - - JIRA - queryOverridesFacetFilters: true - facetFilters: - - fieldName: fieldName - values: - - fieldValues - - fieldValues - - fieldName: fieldName - values: - - fieldValues - - fieldValues - TextRange: - required: - - startIndex - description: A subsection of a given string to which some special formatting should be applied. - properties: - startIndex: - type: integer - description: The inclusive start index of the range. - endIndex: - type: integer - description: The exclusive end index of the range. - type: - type: string - enum: - - BOLD - - CITATION - - HIGHLIGHT - - LINK - url: - type: string - description: The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - document: - $ref: "#/components/schemas/Document" - description: A document corresponding to the range, if applicable. For example, the cited document for a CITATION range. - SearchRequestInputDetails: - properties: - hasCopyPaste: - type: boolean - description: Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - example: - hasCopyPaste: true - QuerySuggestion: - required: - - query - properties: - missingTerm: - type: string - description: A query term missing from the original query on which this suggestion is based. - query: - type: string - description: The query being suggested (e.g. enforcing the missing term from the original query). - searchProviderInfo: - $ref: "#/components/schemas/SearchProviderInfo" - description: Information about the search provider that generated this suggestion. - label: - type: string - description: A user-facing description to display for the suggestion. - datasource: - type: string - description: The datasource associated with the suggestion. - requestOptions: - $ref: "#/components/schemas/SearchRequestOptions" - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: The bolded ranges within the query of the QuerySuggestion. - inputDetails: - $ref: "#/components/schemas/SearchRequestInputDetails" - example: - query: app:github type:pull author:mortimer - label: Mortimer's PRs - datasource: github - Person: - required: - - name - - obfuscatedId - properties: - name: - type: string - description: The display name. - obfuscatedId: - type: string - description: An opaque identifier that can be used to request metadata for a Person. - relatedDocuments: - type: array - items: - $ref: "#/components/schemas/RelatedDocuments" - description: A list of documents related to this person. - metadata: - $ref: "#/components/schemas/PersonMetadata" - example: - name: George Clooney - obfuscatedId: abc123 - Company: - required: - - name - properties: - name: - type: string - description: User-friendly display name. - profileUrl: - type: string - description: Link to internal company company profile. - websiteUrls: - type: array - description: Link to company's associated websites. - items: - type: string - logoUrl: - type: string - description: The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - location: - type: string - description: User facing string representing the company's location. - example: New York City - phone: - type: string - description: Phone number as a number string. - fax: - type: string - description: Fax number as a number string. - industry: - type: string - description: User facing string representing the company's industry. - example: Finances - annualRevenue: - type: number - format: double - description: Average company's annual revenue for reference. - numberOfEmployees: - type: integer - format: int64 - description: Average company's number of employees for reference. - stockSymbol: - type: string - description: Company's stock symbol if company is public. - foundedDate: - type: string - format: date - description: The date when the company was founded. - about: - type: string - description: User facing description of company. - example: Financial, software, data, and media company headquartered in Midtown Manhattan, New York City - DocumentCounts: - type: object - description: A map of {string, int} pairs representing counts of each document type associated with this customer. - additionalProperties: - type: integer - CustomDataValue: - properties: - displayLabel: - type: string - stringValue: - type: string - stringListValue: - type: array - description: list of strings for multi-value properties - items: - type: string - numberValue: - type: number - booleanValue: - type: boolean - CustomData: - type: object - description: Custom fields specific to individual datasources - additionalProperties: - $ref: "#/components/schemas/CustomDataValue" - CustomerMetadata: - properties: - datasourceId: - type: string - description: The user visible id of the salesforce customer account. - customData: - $ref: "#/components/schemas/CustomData" - Customer: - required: - - id - - company - properties: - id: - type: string - description: Unique identifier. - domains: - type: array - description: Link to company's associated website domains. - items: - type: string - company: - $ref: "#/components/schemas/Company" - documentCounts: - $ref: "#/components/schemas/DocumentCounts" - poc: - type: array - description: A list of POC for company. - items: - $ref: "#/components/schemas/Person" - metadata: - $ref: "#/components/schemas/CustomerMetadata" - mergedCustomers: - type: array - description: A list of Customers. - items: - $ref: "#/components/schemas/Customer" - startDate: - type: string - format: date - description: The date when the interaction with customer started. - contractAnnualRevenue: - type: number - format: double - description: Average contract annual revenue with that customer. - notes: - type: string - description: User facing (potentially generated) notes about company. - example: CIO is interested in trying out the product. - RelatedObject: - required: - - id - properties: - id: - type: string - description: The ID of the related object - metadata: - type: object - description: Some metadata of the object which can be displayed, while not having the actual object. - properties: - name: - type: string - description: Placeholder name of the object, not the relationship. - RelatedObjectEdge: - properties: - objects: - type: array - items: - $ref: "#/components/schemas/RelatedObject" - RelatedObjects: - properties: - relatedObjects: - type: object - description: A list of objects related to a source object. - additionalProperties: - $ref: "#/components/schemas/RelatedObjectEdge" - ScopeType: - type: string - description: Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - enum: - - GLOBAL - - OWN - WritePermission: - description: Describes the write permissions levels that a user has for a specific feature - properties: - scopeType: - $ref: "#/components/schemas/ScopeType" - create: - type: boolean - description: True if user has create permission for this feature and scope - update: - type: boolean - description: True if user has update permission for this feature and scope - delete: - type: boolean - description: True if user has delete permission for this feature and scope - ObjectPermissions: - properties: - write: - $ref: "#/components/schemas/WritePermission" - PermissionedObject: - properties: - permissions: - $ref: "#/components/schemas/ObjectPermissions" - description: The permissions the current viewer has with respect to a particular object. - PersonToTeamRelationship: - required: - - person - type: object - description: Metadata about the relationship of a person to a team. - properties: - person: - $ref: "#/components/schemas/Person" - relationship: - type: string - description: The team member's relationship to the team. This defaults to MEMBER if not set. - default: MEMBER - enum: - - MEMBER - - MANAGER - - LEAD - - POINT_OF_CONTACT - - OTHER - customRelationshipStr: - type: string - description: Displayed name for the relationship if relationship is set to `OTHER`. - joinDate: - type: string - format: date-time - description: The team member's start date - TeamEmail: - type: object - description: Information about a team's email - properties: - email: - type: string - format: email - description: An email address - type: - type: string - description: An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER` - default: OTHER - required: - - email - - type - CustomFieldValueStr: - properties: - strText: - type: string - description: Text field for string value. - CustomFieldValueHyperlink: - properties: - urlAnchor: - type: string - description: Anchor text for hyperlink. - urlLink: - type: string - description: Link for this URL. - CustomFieldValuePerson: - properties: - person: - $ref: "#/components/schemas/Person" - CustomFieldValue: - oneOf: - - $ref: "#/components/schemas/CustomFieldValueStr" - - $ref: "#/components/schemas/CustomFieldValueHyperlink" - - $ref: "#/components/schemas/CustomFieldValuePerson" - CustomFieldData: - required: - - label - - values - - displayable - properties: - label: - type: string - description: A user-facing label for this field. - values: - type: array - items: - $ref: "#/components/schemas/CustomFieldValue" - displayable: - type: boolean - description: Determines whether the client should display this custom field - default: true - DatasourceProfile: - required: - - datasource - - handle - properties: - datasource: - type: string - example: github - description: The datasource the profile is of. - handle: - type: string - description: The display name of the entity in the given datasource. - url: - type: string - description: URL to view the entity's profile. - nativeAppUrl: - type: string - description: A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - isUserGenerated: - type: boolean - description: For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source) - Team: - allOf: - - $ref: "#/components/schemas/RelatedObjects" - - $ref: "#/components/schemas/PermissionedObject" - - type: object - required: - - id - - name - properties: - id: - type: string - description: Unique identifier - name: - type: string - description: Team name - description: - type: string - description: A description of the team - businessUnit: - type: string - description: Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - department: - type: string - description: An organizational unit where everyone has a similar task, e.g. `Engineering`. - photoUrl: - type: string - format: url - description: A link to the team's photo. - bannerUrl: - type: string - format: url - description: A link to the team's banner photo. - externalLink: - type: string - format: uri - description: Link to a team page on the internet or your company's intranet - members: - type: array - description: The members on this team - items: - $ref: "#/components/schemas/PersonToTeamRelationship" - memberCount: - type: integer - description: Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team) - emails: - type: array - description: The emails for this team - items: - $ref: "#/components/schemas/TeamEmail" - customFields: - type: array - description: Customizable fields for additional team information. - items: - $ref: "#/components/schemas/CustomFieldData" - datasourceProfiles: - type: array - description: The datasource profiles of the team - items: - $ref: "#/components/schemas/DatasourceProfile" - datasource: - type: string - description: the data source of the team, e.g. GDRIVE - createdFrom: - type: string - description: For teams created from docs, the doc title. Otherwise empty. - lastUpdatedAt: - type: string - format: date-time - description: when this team was last updated. - status: - type: string - description: whether this team is fully processed or there are still unprocessed operations that'll affect it - default: PROCESSED - enum: - - PROCESSED - - QUEUED_FOR_CREATION - - QUEUED_FOR_DELETION - canBeDeleted: - type: boolean - description: can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot - default: true - loggingId: - type: string - description: The logging id of the team used in scrubbed logs, client analytics, and metrics. - CustomEntityMetadata: - properties: - customData: - $ref: "#/components/schemas/CustomData" - GroupType: - type: string - description: The type of user group - enum: - - DEPARTMENT - - ALL - - TEAM - - JOB_TITLE - - ROLE_TYPE - - LOCATION - - REGION - - EXTERNAL_GROUP - Group: - required: - - type - - id - properties: - type: - $ref: "#/components/schemas/GroupType" - id: - type: string - description: A unique identifier for the group. May be the same as name. - name: - type: string - description: Name of the group. - datasourceInstance: - type: string - description: Datasource instance if the group belongs to one e.g. external groups. - UserRole: - type: string - description: A user's role with respect to a specific document. - enum: - - OWNER - - VIEWER - - ANSWER_MODERATOR - - EDITOR - - VERIFIER - UserRoleSpecification: - required: - - role - properties: - sourceDocumentSpec: - $ref: "#/components/schemas/DocumentSpec" - description: The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from. - person: - $ref: "#/components/schemas/Person" - group: - $ref: "#/components/schemas/Group" - role: - $ref: "#/components/schemas/UserRole" - CustomEntity: - allOf: - - $ref: "#/components/schemas/PermissionedObject" - - type: object - properties: - id: - type: string - description: Unique identifier. - title: - type: string - description: Title or name of the custom entity. - datasource: - type: string - description: The datasource the custom entity is from. - objectType: - type: string - description: The type of the entity. Interpretation is specific to each datasource - metadata: - $ref: "#/components/schemas/CustomEntityMetadata" - roles: - type: array - description: A list of user roles for the custom entity explicitly granted by the owner. - items: - $ref: "#/components/schemas/UserRoleSpecification" - AnswerId: - properties: - id: - type: integer - description: The opaque ID of the Answer. - example: 3 - AnswerDocId: - properties: - docId: - type: string - description: Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred. - example: ANSWERS_answer_3 - AnswerMutableProperties: - properties: - question: - type: string - example: Why is the sky blue? - questionVariations: - type: array - description: Additional ways of phrasing this question. - items: - type: string - bodyText: - type: string - description: The plain text answer to the question. - example: From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light. - boardId: - type: integer - description: The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted. - deprecated: true - audienceFilters: - type: array - description: Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search. - items: - $ref: "#/components/schemas/FacetFilter" - addedRoles: - type: array - description: A list of user roles for the answer added by the owner. - items: - $ref: "#/components/schemas/UserRoleSpecification" - removedRoles: - type: array - description: A list of user roles for the answer removed by the owner. - items: - $ref: "#/components/schemas/UserRoleSpecification" - roles: - type: array - description: A list of roles for this answer explicitly granted by an owner, editor, or admin. - items: - $ref: "#/components/schemas/UserRoleSpecification" - sourceDocumentSpec: - $ref: "#/components/schemas/DocumentSpec" - sourceType: - type: string - enum: - - DOCUMENT - - ASSISTANT - StructuredText: - allOf: - - $ref: "#/components/schemas/StructuredTextMutableProperties" - - type: object - properties: - structuredList: - type: array - items: - $ref: "#/components/schemas/StructuredTextItem" - description: An array of objects each of which contains either a string or a link which optionally corresponds to a document. - AnswerLike: - properties: - user: - $ref: "#/components/schemas/Person" - createTime: - type: string - format: date-time - description: The time the user liked the answer in ISO format (ISO 8601). - AnswerLikes: - required: - - likedBy - - likedByUser - - numLikes - properties: - likedBy: - type: array - items: - $ref: "#/components/schemas/AnswerLike" - likedByUser: - type: boolean - description: Whether the user in context liked the answer. - numLikes: - type: integer - description: The total number of likes for the answer. - Reminder: - required: - - assignee - - remindAt - properties: - assignee: - $ref: "#/components/schemas/Person" - requestor: - $ref: "#/components/schemas/Person" - remindAt: - type: integer - description: Unix timestamp for when the reminder should trigger (in seconds since epoch UTC). - createdAt: - type: integer - description: Unix timestamp for when the reminder was first created (in seconds since epoch UTC). - reason: - type: string - description: An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - TimePoint: - properties: - epochSeconds: - type: integer - description: Epoch seconds. Has precedence over daysFromNow. - daysFromNow: - type: integer - description: The number of days from now. Specification relative to current time. Can be negative. - Period: - properties: - minDaysFromNow: - type: integer - description: DEPRECATED - The number of days from now in the past to define upper boundary of time period. - deprecated: true - maxDaysFromNow: - type: integer - description: DEPRECATED - The number of days from now in the past to define lower boundary of time period. - deprecated: true - start: - $ref: "#/components/schemas/TimePoint" - end: - $ref: "#/components/schemas/TimePoint" - CountInfo: - required: - - count - properties: - count: - type: integer - description: The counter value - period: - $ref: "#/components/schemas/Period" - org: - type: string - description: The unit of organization over which we did the count aggregation, e.g. org (department) or company - VerificationMetadata: - required: - - documentId - properties: - lastVerifier: - $ref: "#/components/schemas/Person" - lastVerificationTs: - type: integer - description: The unix timestamp of the verification (in seconds since epoch UTC). - expirationTs: - type: integer - description: The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC). - document: - $ref: "#/components/schemas/Document" - reminders: - type: array - items: - $ref: "#/components/schemas/Reminder" - description: Info about all outstanding verification reminders for the document if exists. - lastReminder: - $ref: "#/components/schemas/Reminder" - visitorCount: - type: array - items: - $ref: "#/components/schemas/CountInfo" - description: Number of visitors to the document during included time periods. - candidateVerifiers: - type: array - items: - $ref: "#/components/schemas/Person" - description: List of potential verifiers for the document e.g. old verifiers and/or users with view/edit permissions. - Verification: - required: - - state - properties: - state: - type: string - enum: - - UNVERIFIED - - VERIFIED - - DEPRECATED - description: The verification state for the document. - metadata: - $ref: "#/components/schemas/VerificationMetadata" - CollectionBaseMutableProperties: - required: - - name - properties: - name: - type: string - description: The unique name of the Collection. - description: - type: string - description: A brief summary of the Collection's contents. - addedRoles: - type: array - description: A list of added user roles for the Collection. - items: - $ref: "#/components/schemas/UserRoleSpecification" - removedRoles: - type: array - description: A list of removed user roles for the Collection. - items: - $ref: "#/components/schemas/UserRoleSpecification" - audienceFilters: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - description: Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - AnswerBoardMutableProperties: - allOf: - - $ref: "#/components/schemas/CollectionBaseMutableProperties" - AnswerBoard: - allOf: - - $ref: "#/components/schemas/AnswerBoardMutableProperties" - - $ref: "#/components/schemas/PermissionedObject" - - type: object - required: - - id - - description - properties: - id: - type: integer - description: The unique ID of the Answer Board. - createTime: - type: string - format: date-time - updateTime: - type: string - format: date-time - creator: - $ref: "#/components/schemas/Person" - updatedBy: - $ref: "#/components/schemas/Person" - itemCount: - type: integer - description: The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items. - roles: - type: array - description: A list of user roles for the Answer Board. - items: - $ref: "#/components/schemas/UserRoleSpecification" - Thumbnail: - properties: - photoId: - type: string - description: Photo id if the thumbnail is from splash. - url: - type: string - description: Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - CollectionMutableProperties: - allOf: - - $ref: "#/components/schemas/CollectionBaseMutableProperties" - - type: object - required: - - name - properties: - icon: - type: string - description: The emoji icon of this Collection. - adminLocked: - type: boolean - description: Indicates whether edits are allowed for everyone or only admins. - parentId: - type: integer - description: The parent of this Collection, or 0 if it's a top-level Collection. - thumbnail: - $ref: "#/components/schemas/Thumbnail" - allowedDatasource: - type: string - description: The datasource type this Collection can hold. - CollectionItemMutableProperties: - properties: - name: - type: string - description: The optional name of the Collection item. - description: - type: string - description: A helpful description of why this CollectionItem is in the Collection that it's in. - icon: - type: string - description: The emoji icon for this CollectionItem. Only used for Text type items. - UserGeneratedContentId: - properties: - id: - type: integer - description: The opaque id of the user generated content. - ShortcutMutableProperties: - properties: - inputAlias: - type: string - description: Link text following go/ prefix as entered by the user. - destinationUrl: - type: string - description: Destination URL for the shortcut. - destinationDocumentId: - type: string - description: Glean Document ID for the URL, if known. - description: - type: string - description: A short, plain text blurb to help people understand the intent of the shortcut. - unlisted: - type: boolean - description: Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - urlTemplate: - type: string - description: For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - addedRoles: - type: array - description: A list of user roles added for the Shortcut. - items: - $ref: "#/components/schemas/UserRoleSpecification" - removedRoles: - type: array - description: A list of user roles removed for the Shortcut. - items: - $ref: "#/components/schemas/UserRoleSpecification" - ShortcutMetadata: - properties: - createdBy: - $ref: "#/components/schemas/Person" - createTime: - type: string - format: date-time - description: The time the shortcut was created in ISO format (ISO 8601). - updatedBy: - $ref: "#/components/schemas/Person" - updateTime: - type: string - format: date-time - description: The time the shortcut was updated in ISO format (ISO 8601). - destinationDocument: - $ref: "#/components/schemas/Document" - description: Document that corresponds to the destination URL, if applicable. - intermediateUrl: - type: string - description: The URL from which the user is then redirected to the destination URL. Full replacement for https://go/{inputAlias}. - viewPrefix: - type: string - description: The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - isExternal: - type: boolean - description: Indicates whether a shortcut is native or external. - editUrl: - type: string - description: The URL using which the user can access the edit page of the shortcut. - Shortcut: - allOf: - - $ref: "#/components/schemas/UserGeneratedContentId" - - $ref: "#/components/schemas/ShortcutMutableProperties" - - $ref: "#/components/schemas/PermissionedObject" - - $ref: "#/components/schemas/ShortcutMetadata" - - type: object - required: - - inputAlias - properties: - alias: - type: string - description: canonical link text following go/ prefix where hyphen/underscore is removed. - title: - type: string - description: Title for the Go Link - roles: - type: array - description: A list of user roles for the Go Link. - items: - $ref: "#/components/schemas/UserRoleSpecification" - Collection: - allOf: - - $ref: "#/components/schemas/CollectionMutableProperties" - - $ref: "#/components/schemas/PermissionedObject" - - type: object - required: - - id - - description - properties: - id: - type: integer - description: The unique ID of the Collection. - createTime: - type: string - format: date-time - updateTime: - type: string - format: date-time - creator: - $ref: "#/components/schemas/Person" - updatedBy: - $ref: "#/components/schemas/Person" - itemCount: - type: integer - description: The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - childCount: - type: integer - description: The number of children Collections. Separated from the actual children so we can grab the count without children. - items: - type: array - items: - $ref: "#/components/schemas/CollectionItem" - description: The items in this Collection. - pinMetadata: - $ref: "#/components/schemas/CollectionPinnedMetadata" - description: Metadata having what categories this Collection is pinned to and the eligible categories to pin to - shortcuts: - type: array - items: - type: string - description: The names of the shortcuts (Go Links) that point to this Collection. - children: - type: array - items: - $ref: "#/components/schemas/Collection" - description: The children Collections of this Collection. - roles: - type: array - description: A list of user roles for the Collection. - items: - $ref: "#/components/schemas/UserRoleSpecification" - CollectionItem: - allOf: - - $ref: "#/components/schemas/CollectionItemMutableProperties" - - type: object - required: - - collectionId - - itemType - properties: - collectionId: - type: integer - description: The Collection ID of the Collection that this CollectionItem belongs in. - documentId: - type: string - description: If this CollectionItem is indexed, the Glean Document ID of that document. - url: - type: string - description: The URL of this CollectionItem. - itemId: - type: string - description: Unique identifier for the item within the Collection it belongs to. - createdBy: - $ref: "#/components/schemas/Person" - description: The person who added this Collection item. - createdAt: - type: string - format: date-time - description: Unix timestamp for when the item was first added (in seconds since epoch UTC). - document: - $ref: "#/components/schemas/Document" - description: The Document this CollectionItem corresponds to (omitted if item is a non-indexed URL). - shortcut: - $ref: "#/components/schemas/Shortcut" - description: The Shortcut this CollectionItem corresponds to (only included if item URL is for a Go Link). - collection: - $ref: "#/components/schemas/Collection" - description: The Collection this CollectionItem corresponds to (only included if item type is COLLECTION). - itemType: - type: string - enum: - - DOCUMENT - - TEXT - - URL - - COLLECTION - CollectionPinnableCategories: - type: string - description: Categories a Collection can be pinned to. - enum: - - COMPANY_RESOURCE - - DEPARTMENT_RESOURCE - - TEAM_RESOURCE - CollectionPinnableTargets: - type: string - description: What targets can a Collection be pinned to. - enum: - - RESOURCE_CARD - - TEAM_PROFILE_PAGE - CollectionPinTarget: - required: - - category - properties: - category: - $ref: "#/components/schemas/CollectionPinnableCategories" - value: - type: string - description: Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on. - target: - $ref: "#/components/schemas/CollectionPinnableTargets" - CollectionPinMetadata: - required: - - id - - target - properties: - id: - type: integer - description: The ID of the Collection. - target: - $ref: "#/components/schemas/CollectionPinTarget" - CollectionPinnedMetadata: - required: - - pinnedCategories - - eligibleCategoriesForPinning - properties: - existingPins: - type: array - items: - $ref: "#/components/schemas/CollectionPinTarget" - description: List of targets this Collection is pinned to. - eligiblePins: - type: array - items: - $ref: "#/components/schemas/CollectionPinMetadata" - description: List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - Answer: - allOf: - - $ref: "#/components/schemas/AnswerId" - - $ref: "#/components/schemas/AnswerDocId" - - $ref: "#/components/schemas/AnswerMutableProperties" - - $ref: "#/components/schemas/PermissionedObject" - - type: object - required: - - id - properties: - combinedAnswerText: - $ref: "#/components/schemas/StructuredText" - likes: - $ref: "#/components/schemas/AnswerLikes" - author: - $ref: "#/components/schemas/Person" - createTime: - type: string - format: date-time - description: The time the answer was created in ISO format (ISO 8601). - updateTime: - type: string - format: date-time - description: The time the answer was last updated in ISO format (ISO 8601). - updatedBy: - $ref: "#/components/schemas/Person" - verification: - $ref: "#/components/schemas/Verification" - board: - $ref: "#/components/schemas/AnswerBoard" - description: The parent board this answer is in. - collections: - type: array - description: The collections to which the answer belongs. - items: - $ref: "#/components/schemas/Collection" - documentCategory: - type: string - description: The document's document_category(.proto). - sourceDocument: - $ref: "#/components/schemas/Document" - FollowupAction: - description: A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately. - properties: - actionRunId: - type: string - description: Unique identifier for this actionRun recommendation event. - actionInstanceId: - type: string - description: The ID of the action instance that will be invoked. - actionId: - type: string - description: The ID of the associated action. - recommendationText: - type: string - description: Text to be displayed to the user when recommending the action instance. - actionLabel: - type: string - description: The label to be used when displaying a button to execute this action instance. - userConfirmationRequired: - type: boolean - description: Whether user confirmation is needed before executing this action instance. - GeneratedQna: - properties: - question: - type: string - description: Search query rephrased into a question. - answer: - type: string - description: Answer generated for the given query or the generated question. - followUpPrompts: - type: array - items: - type: string - description: List of all follow-up prompts generated for the given query or the generated question. - followupActions: - description: List of follow-up actions generated for the given query or the generated question. - type: array - items: - $ref: "#/components/schemas/FollowupAction" - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: Answer subsections to mark with special formatting (citations, bolding etc) - status: - type: string - enum: - - COMPUTING - - DISABLED - - FAILED - - NO_ANSWER - - SKIPPED - - STREAMING - - SUCCEEDED - - TIMEOUT - description: Status of backend generating the answer - cursor: - type: string - description: An opaque cursor representing the search request - trackingToken: - type: string - description: An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - SearchResult: - required: - - url - allOf: - - $ref: "#/components/schemas/Result" - - type: object - properties: - document: - $ref: "#/components/schemas/Document" - title: - type: string - url: - type: string - nativeAppUrl: - type: string - description: A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - snippets: - type: array - items: - $ref: "#/components/schemas/SearchResultSnippet" - description: Text content from the result document which contains search query terms, if available. - fullText: - type: string - description: The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - fullTextList: - type: array - description: The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - items: - type: string - relatedResults: - type: array - items: - $ref: "#/components/schemas/RelatedDocuments" - description: A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP. - clusteredResults: - type: array - description: A list of results that should be displayed as associated with this result. - items: - $ref: "#/components/schemas/SearchResult" - allClusteredResults: - type: array - description: A list of results that should be displayed as associated with this result. - items: - $ref: "#/components/schemas/ClusterGroup" - attachmentCount: - type: integer - description: The total number of attachments. - attachments: - type: array - description: A (potentially partial) list of results representing documents attached to the main result document. - items: - $ref: "#/components/schemas/SearchResult" - backlinkResults: - type: array - description: A list of results that should be displayed as backlinks of this result in reverse chronological order. - items: - $ref: "#/components/schemas/SearchResult" - clusterType: - $ref: "#/components/schemas/ClusterTypeEnum" - mustIncludeSuggestions: - $ref: "#/components/schemas/QuerySuggestionList" - querySuggestion: - $ref: "#/components/schemas/QuerySuggestion" - prominence: - $ref: "#/components/schemas/SearchResultProminenceEnum" - attachmentContext: - type: string - description: Additional context for the relationship between the result and the document it's attached to. - pins: - type: array - description: A list of pins associated with this search result. - items: - $ref: "#/components/schemas/PinDocument" - example: - snippets: - - snippet: snippet - mimeType: mimeType - metadata: - container: container - createTime: "2000-01-23T04:56:07.000Z" - datasource: datasource - author: - name: name - documentId: documentId - updateTime: "2000-01-23T04:56:07.000Z" - mimeType: mimeType - objectType: objectType - title: title - url: https://example.com/foo/bar - nativeAppUrl: slack://foo/bar - mustIncludeSuggestions: - - missingTerm: container - query: container - ExtractedQnA: - properties: - heading: - type: string - description: Heading text that was matched to produce this result. - question: - type: string - description: Question text that was matched to produce this result. - questionResult: - $ref: "#/components/schemas/SearchResult" - CalendarAttendee: - required: - - person - properties: - isOrganizer: - type: boolean - description: Whether or not this attendee is an organizer. - isInGroup: - type: boolean - description: Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility. - person: - $ref: "#/components/schemas/Person" - groupAttendees: - type: array - description: If this attendee is a group, represents the list of individual attendees in the group. - items: - $ref: "#/components/schemas/CalendarAttendee" - responseStatus: - type: string - enum: - - ACCEPTED - - DECLINED - - NO_RESPONSE - - TENTATIVE - CalendarAttendees: - properties: - people: - type: array - items: - $ref: "#/components/schemas/CalendarAttendee" - description: Full details of some of the attendees of this event - isLimit: - type: boolean - description: Whether the total count of the people returned is at the retrieval limit. - total: - type: integer - description: Total number of attendees in this event. - numAccepted: - type: integer - description: Total number of attendees who have accepted this event. - numDeclined: - type: integer - description: Total number of attendees who have declined this event. - numNoResponse: - type: integer - description: Total number of attendees who have not responded to this event. - numTentative: - type: integer - description: Total number of attendees who have responded tentatively (i.e. responded maybe) to this event. - Meeting: - properties: - id: - type: string - title: - type: string - description: - type: string - url: - type: string - startTime: - type: string - format: date-time - endTime: - type: string - format: date-time - attendees: - $ref: "#/components/schemas/CalendarAttendees" - description: The attendee list, including their response status - AppResult: - required: - - datasource - properties: - datasource: - type: string - description: The app or other repository type this represents - docType: - type: string - description: The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - mimeType: - type: string - description: Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive) - iconUrl: - type: string - description: If there is available icon URL. - CodeLine: - properties: - lineNumber: - type: integer - content: - type: string - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: Index ranges depicting matched sections of the line - Code: - properties: - repoName: - type: string - fileName: - type: string - fileUrl: - type: string - lines: - type: array - items: - $ref: "#/components/schemas/CodeLine" - isLastMatch: - type: boolean - description: Last file match for a repo - example: - repoName: scio - fileName: README.md - matches: - - lineNumber: 1 - content: Welcome to the beginning - ranges: [] - - lineNumber: 2 - content: Second line of the file - ranges: [] - - lineNumber: 3 - content: hello world hello world - ranges: - - startindex: 0 - endIndex: 5 - - startIndex: 12 - endIndex: 17 - QuerySuggestionList: - properties: - suggestions: - type: array - items: - $ref: "#/components/schemas/QuerySuggestion" - person: - $ref: "#/components/schemas/Person" - RelatedDocuments: - properties: - relation: - type: string - description: How this document relates to the including entity. - enum: - - ATTACHMENT - - CANONICAL - - CASE - - contact - - CONTACT - - CONVERSATION_MESSAGES - - EXPERT - - FROM - - HIGHLIGHT - - opportunity - - OPPORTUNITY - - RECENT - - SOURCE - - TICKET - - TRANSCRIPT - - WITH - x-enumDescriptions: - CANONICAL: Canonical documents for the entity, such as overview docs, architecture docs elastic. - associatedEntityId: - type: string - description: Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - querySuggestion: - $ref: "#/components/schemas/QuerySuggestion" - documents: - type: array - items: - $ref: "#/components/schemas/Document" - description: A truncated list of documents with this relation. TO BE DEPRECATED. - deprecated: true - results: - type: array - items: - $ref: "#/components/schemas/SearchResult" - description: A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - RelatedQuestion: - properties: - question: - type: string - description: The text of the related question - answer: - type: string - description: The answer for the related question - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: Subsections of the answer string to which some special formatting should be applied (eg. bold) - EntityType: - type: string - description: The type of entity. - x-include-enum-class-prefix: true - enum: - - PERSON - - PROJECT - - CUSTOMER - Disambiguation: - type: object - description: A disambiguation between multiple entities with the same name - properties: - name: - type: string - description: Name of the ambiguous entity - id: - type: string - description: The unique id of the entity in the knowledge graph - type: - $ref: "#/components/schemas/EntityType" - SearchResultSnippet: - required: - - snippet - properties: - mimeType: - type: string - description: The mime type of the snippets, currently either text/plain or text/html. - text: - type: string - description: A matching snippet from the document with no highlights. - snippetTextOrdering: - type: integer - description: Used for sorting based off the snippet's location within all_snippetable_text - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: The bolded ranges within text. - url: - type: string - description: A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. - snippet: - type: string - deprecated: true - description: A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. - example: - snippet: snippet - mimeType: mimeType - StructuredResult: - description: A single object that can support any object in the work graph. Only a single object will be populated. - properties: - document: - $ref: "#/components/schemas/Document" - person: - $ref: "#/components/schemas/Person" - customer: - $ref: "#/components/schemas/Customer" - team: - $ref: "#/components/schemas/Team" - customEntity: - $ref: "#/components/schemas/CustomEntity" - answer: - $ref: "#/components/schemas/Answer" - generatedQna: - $ref: "#/components/schemas/GeneratedQna" - extractedQnA: - $ref: "#/components/schemas/ExtractedQnA" - meeting: - $ref: "#/components/schemas/Meeting" - app: - $ref: "#/components/schemas/AppResult" - collection: - $ref: "#/components/schemas/Collection" - answerBoard: - $ref: "#/components/schemas/AnswerBoard" - code: - $ref: "#/components/schemas/Code" - shortcut: - $ref: "#/components/schemas/Shortcut" - querySuggestions: - $ref: "#/components/schemas/QuerySuggestionList" - relatedDocuments: - type: array - items: - $ref: "#/components/schemas/RelatedDocuments" - description: A list of documents related to this structured result. - relatedQuestion: - $ref: "#/components/schemas/RelatedQuestion" - disambiguation: - $ref: "#/components/schemas/Disambiguation" - snippets: - description: Any snippets associated to the populated object. - type: array - items: - $ref: "#/components/schemas/SearchResultSnippet" - trackingToken: - type: string - description: An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - prominence: - type: string - description: The level of visual distinction that should be given to a result. - x-enumDescriptions: - HERO: A high-confidence result that should feature prominently on the page. - PROMOTED: May not be the best result but should be given additional visual distinction. - STANDARD: Should not be distinct from any other results. - enum: - - HERO - - PROMOTED - - STANDARD - source: - type: string - description: Source context for this result. Possible values depend on the result type. - enum: - - EXPERT_DETECTION - - ENTITY_NLQ - Result: - properties: - structuredResults: - type: array - description: An array of entities in the work graph retrieved via a data request. - items: - $ref: "#/components/schemas/StructuredResult" - trackingToken: - type: string - description: An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - ClusterTypeEnum: - type: string - description: The reason for inclusion of clusteredResults. - enum: - - SIMILAR - - FRESHNESS - - TITLE - - CONTENT - - NONE - - THREAD_REPLY - - THREAD_ROOT - - PREFIX - - SUFFIX - - AUTHOR_PREFIX - - AUTHOR_SUFFIX - ClusterGroup: - required: - - visibleCountHint - properties: - clusteredResults: - type: array - description: A list of results that should be displayed as associated with this result. - items: - $ref: "#/components/schemas/SearchResult" - clusterType: - $ref: "#/components/schemas/ClusterTypeEnum" - visibleCountHint: - type: integer - description: The default number of results to display before truncating and showing a "see more" link - SearchResultProminenceEnum: - type: string - description: | - The level of visual distinction that should be given to a result. - x-enumDescriptions: - HERO: A high-confidence result that should feature prominently on the page. - PROMOTED: May not be the best result but should be given additional visual distinction. - STANDARD: Should not be distinct from any other results. - enum: - - HERO - - PROMOTED - - STANDARD - PinDocumentMutableProperties: - properties: - queries: - type: array - description: The query strings for which the pinned result will show. - items: - type: string - audienceFilters: - type: array - description: Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - items: - $ref: "#/components/schemas/FacetFilter" - PinDocument: - allOf: - - $ref: "#/components/schemas/PinDocumentMutableProperties" - - type: object - required: - - documentId - properties: - id: - type: string - description: The opaque id of the pin. - documentId: - type: string - description: The document which should be a pinned result. - audienceFilters: - type: array - description: Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - items: - $ref: "#/components/schemas/FacetFilter" - attribution: - $ref: "#/components/schemas/Person" - updatedBy: - $ref: "#/components/schemas/Person" - createTime: - type: string - format: date-time - updateTime: - type: string - format: date-time - PersonTeam: - description: Use `id` if you index teams via Glean, and use `name` and `externalLink` if you want to use your own team pages - properties: - id: - type: string - description: Unique identifier - name: - type: string - description: Team name - externalLink: - type: string - format: uri - description: Link to a team page on the internet or your company's intranet - relationship: - type: string - description: The team member's relationship to the team. This defaults to MEMBER if not set. - default: MEMBER - enum: - - MEMBER - - MANAGER - - LEAD - - POINT_OF_CONTACT - - OTHER - joinDate: - type: string - format: date-time - description: The team member's start date - StructuredLocation: - type: object - description: Detailed location with information about country, state, city etc. - properties: - deskLocation: - type: string - description: Desk number. - timezone: - type: string - description: Location's timezone, e.g. UTC, PST. - address: - type: string - description: Office address or name. - city: - type: string - description: Name of the city. - state: - type: string - description: State code. - region: - type: string - description: Region information, e.g. NORAM, APAC. - zipCode: - type: string - description: ZIP Code for the address. - country: - type: string - description: Country name. - countryCode: - type: string - description: Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - SocialNetwork: - required: - - name - - profileUrl - properties: - name: - type: string - description: Possible values are "twitter", "linkedin". - profileName: - type: string - description: Human-readable profile name. - profileUrl: - type: string - format: url - description: Link to profile. - PersonDistance: - required: - - name - - obfuscatedId - - distance - properties: - name: - type: string - description: The display name. - obfuscatedId: - type: string - description: An opaque identifier that can be used to request metadata for a Person. - distance: - type: number - format: float - description: Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - CommunicationChannel: - type: string - enum: - - COMMUNICATION_CHANNEL_EMAIL - - COMMUNICATION_CHANNEL_SLACK - ChannelInviteInfo: - description: Information regarding the invite status of a person for a particular channel. - properties: - channel: - description: Channel through which the invite was sent - $ref: "#/components/schemas/CommunicationChannel" - isAutoInvite: - description: Bit that tracks if this invite was automatically sent or user-sent - type: boolean - inviter: - description: The person that invited this person. - $ref: "#/components/schemas/Person" - inviteTime: - type: string - format: date-time - description: The time this person was invited in ISO format (ISO 8601). - reminderTime: - type: string - format: date-time - description: The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - InviteInfo: - description: Information regarding the invite status of a person. - properties: - signUpTime: - type: string - format: date-time - description: The time this person signed up in ISO format (ISO 8601). - invites: - type: array - items: - $ref: "#/components/schemas/ChannelInviteInfo" - description: Latest invites received by the user for each channel - inviter: - deprecated: true - description: The person that invited this person. - $ref: "#/components/schemas/Person" - inviteTime: - deprecated: true - type: string - format: date-time - description: The time this person was invited in ISO format (ISO 8601). - reminderTime: - deprecated: true - type: string - format: date-time - description: The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - ReadPermission: - description: Describes the read permission level that a user has for a specific feature - properties: - scopeType: - $ref: "#/components/schemas/ScopeType" - ReadPermissions: - description: Describes the read permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - additionalProperties: - type: array - description: List of read permissions (for different scopes but same feature) - items: - $ref: "#/components/schemas/ReadPermission" - WritePermissions: - description: Describes the write permissions levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - additionalProperties: - type: array - description: List of write permissions (for different scopes but same feature) - items: - $ref: "#/components/schemas/WritePermission" - GrantPermission: - description: Describes the grant permission level that a user has for a specific feature - properties: - scopeType: - $ref: "#/components/schemas/ScopeType" - GrantPermissions: - description: Describes the grant permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject - additionalProperties: - type: array - description: List of grant permissions (for different scopes but same feature) - items: - $ref: "#/components/schemas/GrantPermission" - Permissions: - description: |- - Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. - When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes. - properties: - canAdminSearch: - type: boolean - description: TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - canAdminClientApiGlobalTokens: - type: boolean - description: TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - canDlp: - type: boolean - description: TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - read: - $ref: "#/components/schemas/ReadPermissions" - write: - $ref: "#/components/schemas/WritePermissions" - grant: - $ref: "#/components/schemas/GrantPermissions" - role: - type: string - description: The roleId of the canonical role a user has. The displayName is equal to the roleId. - roles: - type: array - description: The roleIds of the roles a user has. - items: - type: string - TimeInterval: - required: - - start - - end - properties: - start: - type: string - description: The RFC3339 timestamp formatted start time of this event. - end: - type: string - description: The RFC3339 timestamp formatted end time of this event. - AnonymousEvent: - description: A generic, light-weight calendar event. - type: object - properties: - time: - $ref: "#/components/schemas/TimeInterval" - eventType: - description: The nature of the event, for example "out of office". - type: string - enum: - - DEFAULT - - OUT_OF_OFFICE - IconConfig: - description: Defines how to render an icon - properties: - generatedBackgroundColorKey: - type: string - backgroundColor: - type: string - color: - type: string - key: - type: string - iconType: - enum: - - COLLECTION - - CUSTOM - - DATASOURCE - - DATASOURCE_INSTANCE - - FAVICON - - FILE_TYPE - - GENERATED_BACKGROUND - - GLYPH - - MIME_TYPE - - NO_ICON - - PERSON - - REACTIONS - - URL - masked: - type: boolean - description: Whether the icon should be masked based on current theme. - name: - type: string - description: The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - url: - type: string - description: The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - example: - color: "#343CED" - key: person_icon - iconType: GLYPH - name: user - Badge: - type: object - description: Displays a user's accomplishment or milestone - properties: - key: - type: string - description: An auto generated unique identifier. - displayName: - type: string - description: The badge name displayed to users - iconConfig: - $ref: "#/components/schemas/IconConfig" - pinned: - type: boolean - description: The badge should be shown on the PersonAttribution - example: - key: deployment_name_new_hire - displayName: New hire - iconConfig: - color: "#343CED" - key: person_icon - iconType: GLYPH - name: user - PersonMetadata: - properties: - type: - type: string - x-enumDescriptions: - FULL_TIME: The person is a current full-time employee of the company. - CONTRACTOR: The person is a current contractor of the company. - NON_EMPLOYEE: The person object represents a non-human actor such as a service or admin account. - FORMER_EMPLOYEE: The person is a previous employee of the company. - enum: - - FULL_TIME - - CONTRACTOR - - NON_EMPLOYEE - - FORMER_EMPLOYEE - example: FULL_TIME - firstName: - type: string - description: The first name of the person - lastName: - type: string - description: The last name of the person - title: - type: string - description: Job title. - businessUnit: - type: string - description: Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - department: - type: string - description: An organizational unit where everyone has a similar task, e.g. `Engineering`. - teams: - description: Info about the employee's team(s). - type: array - items: - $ref: "#/components/schemas/PersonTeam" - departmentCount: - type: integer - description: The number of people in this person's department. - email: - type: string - description: The user's primary email address - aliasEmails: - type: array - description: Additional email addresses of this user beyond the primary, if any. - items: - type: string - location: - type: string - description: User facing string representing the person's location. - structuredLocation: - $ref: "#/components/schemas/StructuredLocation" - externalProfileLink: - type: string - description: Link to a customer's internal profile page. This is set to '#' when no link is desired. - manager: - $ref: "#/components/schemas/Person" - managementChain: - description: The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - type: array - items: - $ref: "#/components/schemas/Person" - phone: - type: string - description: Phone number as a number string. - timezone: - type: string - description: The timezone of the person. E.g. "Pacific Daylight Time". - timezoneOffset: - type: integer - format: int64 - description: The offset of the person's timezone in seconds from UTC. - photoUrl: - type: string - format: url - description: The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - uneditedPhotoUrl: - type: string - format: url - description: The original photo URL of the person's avatar before any edits they made are applied - bannerUrl: - type: string - format: url - description: The URL of the person's banner photo. - reports: - type: array - items: - $ref: "#/components/schemas/Person" - startDate: - type: string - description: The date when the employee started. - format: date - endDate: - type: string - format: date - description: If a former employee, the last date of employment. - bio: - type: string - description: Short biography or mission statement of the employee. - pronoun: - type: string - description: She/her, He/his or other pronoun. - orgSizeCount: - type: integer - description: The total recursive size of the people reporting to this person, or 1 - directReportsCount: - type: integer - description: The total number of people who directly report to this person, or 0 - preferredName: - type: string - description: The preferred name of the person, or a nickname. - socialNetwork: - description: List of social network profiles. - type: array - items: - $ref: "#/components/schemas/SocialNetwork" - datasourceProfile: - type: array - description: List of profiles this user has in different datasources / tools that they use. - items: - $ref: "#/components/schemas/DatasourceProfile" - querySuggestions: - $ref: "#/components/schemas/QuerySuggestionList" - peopleDistance: - type: array - items: - $ref: "#/components/schemas/PersonDistance" - description: List of people and distances to those people from this person. Optionally with metadata. - inviteInfo: - $ref: "#/components/schemas/InviteInfo" - isSignedUp: - type: boolean - description: Whether the user has signed into Glean at least once. - lastExtensionUse: - type: string - format: date-time - description: The last time the user has used the Glean extension in ISO 8601 format. - permissions: - $ref: "#/components/schemas/Permissions" - customFields: - type: array - description: User customizable fields for additional people information. - items: - $ref: "#/components/schemas/CustomFieldData" - loggingId: - type: string - description: The logging id of the person used in scrubbed logs, tracking GA metrics. - startDatePercentile: - type: number - format: float - description: Percentage of the company that started strictly after this person. Between [0,100). - busyEvents: - type: array - items: - $ref: "#/components/schemas/AnonymousEvent" - description: Intervals of busy time for this person, along with the type of event they're busy with. - profileBoolSettings: - type: object - additionalProperties: - type: boolean - description: flag settings to indicate user profile settings for certain items - badges: - type: array - items: - $ref: "#/components/schemas/Badge" - description: The badges that a user has earned over their lifetime. - isOrgRoot: - type: boolean - description: Whether this person is a "root" node in their organization's hierarchy. - example: - department: Movies - email: george@example.com - location: Hollywood, CA - phone: 6505551234 - photoUrl: https://example.com/george.jpg - startDate: "2000-01-23" - title: Actor - DocumentVisibility: - type: string - description: The level of visibility of the document as understood by our system. - x-enumDescriptions: - PRIVATE: Only one person is able to see the document. - SPECIFIC_PEOPLE_AND_GROUPS: Only specific people and/or groups can see the document. - DOMAIN_LINK: Anyone in the domain with the link can see the document. - DOMAIN_VISIBLE: Anyone in the domain can search for the document. - PUBLIC_LINK: Anyone with the link can see the document. - PUBLIC_VISIBLE: Anyone on the internet can search for the document. - enum: - - PRIVATE - - SPECIFIC_PEOPLE_AND_GROUPS - - DOMAIN_LINK - - DOMAIN_VISIBLE - - PUBLIC_LINK - - PUBLIC_VISIBLE - Reaction: - properties: - type: - type: string - count: - type: integer - description: The count of the reaction type on the document. - reactors: - type: array - items: - $ref: "#/components/schemas/Person" - reactedByViewer: - type: boolean - description: Whether the user in context reacted with this type to the document. - Share: - description: Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip - required: - - numDaysAgo - properties: - numDaysAgo: - type: integer - description: The number of days that has passed since the share happened - sharer: - $ref: "#/components/schemas/Person" - sharingDocument: - $ref: "#/components/schemas/Document" - DocumentInteractions: - properties: - numComments: - type: integer - description: The count of comments (thread replies in the case of slack). - numReactions: - type: integer - description: The count of reactions on the document. - reactions: - type: array - description: To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document. - deprecated: true - items: - type: string - reacts: - type: array - items: - $ref: "#/components/schemas/Reaction" - shares: - type: array - items: - $ref: "#/components/schemas/Share" - description: Describes instances of someone posting a link to this document in one of our indexed datasources. - visitorCount: - $ref: "#/components/schemas/CountInfo" - ViewerInfo: - properties: - role: - type: string - enum: - - ANSWER_MODERATOR - - OWNER - - VIEWER - description: DEPRECATED - use permissions instead. Viewer's role on the specific document. - deprecated: true - lastViewedTime: - type: string - format: date-time - IndexStatus: - properties: - lastCrawledTime: - description: When the document was last crawled - type: string - format: date-time - lastIndexedTime: - description: When the document was last indexed - type: string - format: date-time - DocumentMetadata: - properties: - datasource: - type: string - datasourceInstance: - type: string - description: The datasource instance from which the document was extracted. - objectType: - type: string - description: The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - container: - type: string - description: The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - containerId: - type: string - description: The Glean Document ID of the container. Uniquely identifies the container. - superContainerId: - type: string - description: The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - parentId: - type: string - description: The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - mimeType: - type: string - documentId: - type: string - description: The index-wide unique identifier. - loggingId: - type: string - description: A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - documentIdHash: - type: string - description: Hash of the Glean Document ID. - createTime: - type: string - format: date-time - updateTime: - type: string - format: date-time - author: - $ref: "#/components/schemas/Person" - owner: - $ref: "#/components/schemas/Person" - mentionedPeople: - type: array - items: - $ref: "#/components/schemas/Person" - description: A list of people mentioned in the document. - visibility: - $ref: "#/components/schemas/DocumentVisibility" - components: - type: array - description: A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).) - items: - type: string - status: - type: string - description: The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix). - statusCategory: - type: string - description: The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource. - pins: - type: array - description: A list of stars associated with this result. "Pin" is an older name. - items: - $ref: "#/components/schemas/PinDocument" - priority: - type: string - description: The document priority. Interpretation is datasource specific. - assignedTo: - $ref: "#/components/schemas/Person" - updatedBy: - $ref: "#/components/schemas/Person" - labels: - type: array - description: A list of tags for the document. Interpretation is datasource specific. - items: - type: string - collections: - type: array - description: A list of collections that the document belongs to. - items: - $ref: "#/components/schemas/Collection" - datasourceId: - type: string - description: The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number). - interactions: - $ref: "#/components/schemas/DocumentInteractions" - verification: - $ref: "#/components/schemas/Verification" - viewerInfo: - $ref: "#/components/schemas/ViewerInfo" - permissions: - $ref: "#/components/schemas/ObjectPermissions" - visitCount: - $ref: "#/components/schemas/CountInfo" - shortcuts: - type: array - description: A list of shortcuts of which destination URL is for the document. - items: - $ref: "#/components/schemas/Shortcut" - path: - type: string - description: For file datasources like onedrive/github etc this has the path to the file - customData: - $ref: "#/components/schemas/CustomData" - documentCategory: - type: string - description: The document's document_category(.proto). - contactPerson: - $ref: "#/components/schemas/Person" - thumbnail: - $ref: "#/components/schemas/Thumbnail" - description: A thumbnail image representing this document. - indexStatus: - $ref: "#/components/schemas/IndexStatus" - ancestors: - type: array - description: A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list. - items: - $ref: "#/components/schemas/Document" - example: - container: container - parentId: JIRA_EN-1337 - createTime: "2000-01-23T04:56:07.000Z" - datasource: datasource - author: - name: name - documentId: documentId - updateTime: "2000-01-23T04:56:07.000Z" - mimeType: mimeType - objectType: Feature Request - components: - - Backend - - Networking - status: - - Done - customData: - someCustomField: someCustomValue - DocumentSection: - type: object - properties: - title: - type: string - description: The title of the document section (e.g. the section header). - url: - type: string - description: The permalink of the document section. - StructuredTextItem: - properties: - link: - type: string - example: https://en.wikipedia.org/wiki/Diffuse_sky_radiation - document: - deprecated: true - description: Deprecated. To be gradually migrated to structuredResult. - $ref: "#/components/schemas/Document" - text: - type: string - example: Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue. - structuredResult: - $ref: "#/components/schemas/StructuredResult" - AnnouncementMutableProperties: - properties: - startTime: - type: string - format: date-time - description: The date and time at which the announcement becomes active. - endTime: - type: string - format: date-time - description: The date and time at which the announcement expires. - title: - type: string - description: The headline of the announcement. - body: - $ref: "#/components/schemas/StructuredText" - emoji: - type: string - description: An emoji used to indicate the nature of the announcement. - thumbnail: - $ref: "#/components/schemas/Thumbnail" - banner: - $ref: "#/components/schemas/Thumbnail" - description: Optional variant of thumbnail cropped for header background. - audienceFilters: - type: array - description: Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. - items: - $ref: "#/components/schemas/FacetFilter" - sourceDocumentId: - type: string - description: The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - hideAttribution: - type: boolean - description: Whether or not to hide an author attribution. - channel: - type: string - enum: - - MAIN - - SOCIAL_FEED - description: This determines whether this is a Social Feed post or a regular announcement. - postType: - type: string - enum: - - TEXT - - LINK - description: This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - isPrioritized: - type: boolean - description: Used by the Social Feed to pin posts to the front of the feed. - viewUrl: - type: string - description: URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - CreateAnnouncementRequest: - allOf: - - $ref: "#/components/schemas/AnnouncementMutableProperties" - - type: object - required: - - title - - startTime - - endTime - DraftProperties: - properties: - draftId: - type: integer - description: The opaque id of the associated draft. - example: - draftId: 342 - Announcement: - allOf: - - $ref: "#/components/schemas/AnnouncementMutableProperties" - - $ref: "#/components/schemas/DraftProperties" - - $ref: "#/components/schemas/PermissionedObject" - - type: object - properties: - id: - type: integer - description: The opaque id of the announcement. - author: - $ref: "#/components/schemas/Person" - createTimestamp: - type: integer - description: Server Unix timestamp of the creation time (in seconds since epoch UTC). - lastUpdateTimestamp: - type: integer - description: Server Unix timestamp of the last update time (in seconds since epoch UTC). - updatedBy: - $ref: "#/components/schemas/Person" - viewerInfo: - type: object - properties: - isDismissed: - type: boolean - description: Whether the viewer has dismissed the announcement. - isRead: - type: boolean - description: Whether the viewer has read the announcement. - sourceDocument: - $ref: "#/components/schemas/Document" - description: The source document if the announcement is created from one. - isPublished: - type: boolean - description: Whether or not the announcement is published. - DeleteAnnouncementRequest: - required: - - id - properties: - id: - type: integer - description: The opaque id of the announcement to be deleted. - UpdateAnnouncementRequest: - allOf: - - $ref: "#/components/schemas/AnnouncementMutableProperties" - - type: object - required: - - id - - title - - startTime - - endTime - properties: - id: - type: integer - description: The opaque id of the announcement. - AddedCollections: - properties: - addedCollections: - type: array - items: - type: integer - description: IDs of Collections to which a document is added. - AnswerCreationData: - allOf: - - $ref: "#/components/schemas/AnswerMutableProperties" - - $ref: "#/components/schemas/AddedCollections" - - type: object - properties: - combinedAnswerText: - $ref: "#/components/schemas/StructuredTextMutableProperties" - CreateAnswerRequest: - required: - - data - properties: - data: - $ref: "#/components/schemas/AnswerCreationData" - DeleteAnswerRequest: - allOf: - - $ref: "#/components/schemas/AnswerId" - - $ref: "#/components/schemas/AnswerDocId" - - type: object - required: - - id - RemovedCollections: - properties: - removedCollections: - type: array - items: - type: integer - description: IDs of Collections from which a document is removed. - EditAnswerRequest: - allOf: - - $ref: "#/components/schemas/AnswerId" - - $ref: "#/components/schemas/AnswerDocId" - - $ref: "#/components/schemas/AnswerMutableProperties" - - $ref: "#/components/schemas/AddedCollections" - - $ref: "#/components/schemas/RemovedCollections" - - type: object - required: - - id - properties: - combinedAnswerText: - $ref: "#/components/schemas/StructuredTextMutableProperties" - GetAnswerRequest: - allOf: - - $ref: "#/components/schemas/AnswerId" - - $ref: "#/components/schemas/AnswerDocId" - AnswerResult: - required: - - answer - properties: - answer: - $ref: "#/components/schemas/Answer" - trackingToken: - type: string - description: An opaque token that represents this particular Answer. To be used for `/feedback` reporting. - GetAnswerError: - properties: - errorType: - type: string - enum: - - NO_PERMISSION - - INVALID_ID - answerAuthor: - $ref: "#/components/schemas/Person" - GetAnswerResponse: - properties: - answerResult: - $ref: "#/components/schemas/AnswerResult" - error: - $ref: "#/components/schemas/GetAnswerError" - ListAnswersRequest: - properties: - boardId: - type: integer - description: The Answer Board Id to list answers on. - ListAnswersResponse: - required: - - answers - - answerResults - properties: - answerResults: - type: array - items: - $ref: "#/components/schemas/AnswerResult" - description: List of answers with tracking tokens. - CreateAuthTokenResponse: - required: - - token - - expirationTime - properties: - token: - type: string - description: An authentication token that can be passed to any endpoint via Bearer Authentication - expirationTime: - description: Unix timestamp for when this token expires (in seconds since epoch UTC). - type: integer - format: int64 - AgentConfig: - description: Describes the agent that executes the request. - properties: - agent: - type: string - description: Name of the agent. - x-enumDescriptions: - DEFAULT: Integrates with your company's knowledge. - GPT: Communicates directly with the LLM. - UNIVERSAL: Uses both company and web knowledge. - enum: - - DEFAULT - - GPT - - UNIVERSAL - mode: - type: string - description: Top level modes to run GleanChat in. - x-enumDescriptions: - DEFAULT: Used if no mode supplied. - QUICK: Deprecated. - enum: - - DEFAULT - - QUICK - ChatFileStatus: - type: string - description: Current status of the file. - x-include-enum-class-prefix: true - enum: - - PROCESSING - - PROCESSED - - FAILED - - DELETED - ChatFileFailureReason: - type: string - description: Reason for failed status. - x-include-enum-class-prefix: true - enum: - - PARSE_FAILED - - AV_SCAN_FAILED - - FILE_TOO_SMALL - - FILE_TOO_LARGE - - FILE_EXTENSION_UNSUPPORTED - - FILE_METADATA_VALIDATION_FAIL - - FILE_PROCESSING_TIMED_OUT - ChatFileMetadata: - type: object - description: Metadata of a file uploaded by a user for Chat. - properties: - status: - $ref: "#/components/schemas/ChatFileStatus" - uploadTime: - type: integer - format: int64 - description: Upload time, in epoch seconds. - processedSize: - type: integer - format: int64 - description: Size of the processed file in bytes. - failureReason: - $ref: "#/components/schemas/ChatFileFailureReason" - mimeType: - description: MIME type of the file. - type: string - ChatFile: - type: object - description: Structure for file uploaded by a user for Chat. - properties: - id: - type: string - description: Unique identifier of the file. - example: FILE_1234 - url: - type: string - description: Url of the file. - example: www.google.com - name: - type: string - description: Name of the uploaded file. - example: sample.pdf - metadata: - $ref: "#/components/schemas/ChatFileMetadata" - ReferenceRange: - description: Each text range from the response can correspond to an array of snippets from the citation source. - properties: - textRange: - $ref: "#/components/schemas/TextRange" - snippets: - type: array - items: - $ref: "#/components/schemas/SearchResultSnippet" - ChatMessageCitation: - description: Information about the source for a ChatMessage. - properties: - trackingToken: - type: string - description: An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - sourceDocument: - $ref: "#/components/schemas/Document" - sourceFile: - $ref: "#/components/schemas/ChatFile" - sourcePerson: - $ref: "#/components/schemas/Person" - referenceRanges: - description: Each reference range and its corresponding snippets - type: array - items: - $ref: "#/components/schemas/ReferenceRange" - displayName: - description: Human understandable name of the tool. Max 50 characters. - type: string - logoUrl: - type: string - description: URL used to fetch the logo. - objectName: - type: string - description: Name of the generated object. This will be used to indicate to the end user what the generated object contains. - example: - - HR ticket - - Email - - Chat message - PersonObject: - required: - - name - - obfuscatedId - properties: - name: - type: string - description: The display name. - obfuscatedId: - type: string - description: An opaque identifier that can be used to request metadata for a Person. - AuthConfig: - description: Config for tool's authentication method. - type: object - properties: - isOnPrem: - type: boolean - description: Whether or not this tool is hosted on-premise. - usesCentralAuth: - type: boolean - description: Whether or not this uses central auth. - type: - type: string - enum: - - NONE - - OAUTH_USER - - OAUTH_ADMIN - - API_KEY - - BASIC_AUTH - - DWD - description: | - The type of authentication being used. - Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - 'OAUTH_USER' uses individual user tokens for external API calls. - 'DWD' refers to domain wide delegation. - grantType: - type: string - enum: - - AUTH_CODE - - CLIENT_CREDENTIALS - description: The type of grant type being used. - status: - type: string - description: Auth status of the tool. - enum: - - AWAITING_AUTH - - AUTHORIZED - - AUTH_DISABLED - client_url: - type: string - format: url - description: The URL where users will be directed to start the OAuth flow. - scopes: - type: array - items: - type: string - description: A list of strings denoting the different scopes or access levels required by the tool. - audiences: - type: array - items: - type: string - description: A list of strings denoting the different audience which can access the tool. - authorization_url: - type: string - format: url - description: The OAuth provider's endpoint, where access tokens are requested. - lastAuthorizedAt: - type: string - format: date-time - description: The time the tool was last authorized in ISO format (ISO 8601). - ToolMetadata: - description: The manifest for a tool that can be used to augment Glean Assistant. - required: - - type - - name - - displayName - - displayDescription - properties: - type: - description: The type of tool. - type: string - enum: - - RETRIEVAL - - ACTION - name: - description: Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool. - type: string - displayName: - $ref: "#/components/schemas/displayName" - toolId: - type: string - description: An opaque id which is unique identifier for the tool. - displayDescription: - description: Description of the tool meant for a human. - type: string - logoUrl: - $ref: "#/components/schemas/logoUrl" - objectName: - $ref: "#/components/schemas/objectName" - knowledgeType: - type: string - description: Indicates the kind of knowledge a tool would access or modify. - enum: - - NEUTRAL_KNOWLEDGE - - COMPANY_KNOWLEDGE - - WORLD_KNOWLEDGE - createdBy: - $ref: "#/components/schemas/PersonObject" - lastUpdatedBy: - $ref: "#/components/schemas/PersonObject" - createdAt: - type: string - format: date-time - description: The time the tool was created in ISO format (ISO 8601) - lastUpdatedAt: - type: string - format: date-time - description: The time the tool was last updated in ISO format (ISO 8601) - writeActionType: - type: string - description: Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. - enum: - - REDIRECT - - EXECUTION - authType: - type: string - enum: - - NONE - - OAUTH_USER - - OAUTH_ADMIN - - API_KEY - - BASIC_AUTH - - DWD - description: | - The type of authentication being used. - Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. - 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. - 'OAUTH_USER' uses individual user tokens for external API calls. - 'DWD' refers to domain wide delegation. - auth: - deprecated: true - $ref: "#/components/schemas/AuthConfig" - permissions: - deprecated: true - $ref: "#/components/schemas/ObjectPermissions" - usageInstructions: - description: Usage instructions for the LLM to use this action. - type: string - isSetupFinished: - type: boolean - description: Whether this action has been fully configured and validated. - PossibleValue: - type: object - description: Possible value of a specific parameter - properties: - value: - type: string - description: Possible value - label: - type: string - description: User-friendly label associated with the value - WriteActionParameter: - type: object - properties: - type: - type: string - description: The type of the value (e.g., integer, string, boolean, etc.) - enum: - - UNKNOWN - - INTEGER - - STRING - - BOOLEAN - displayName: - type: string - description: Human readable display name for the key. - value: - type: string - description: The value of the field. - isRequired: - type: boolean - description: Is the parameter a required field. - description: - type: string - description: Description of the parameter. - possibleValues: - type: array - items: - $ref: "#/components/schemas/PossibleValue" - description: Possible values that the parameter can take. - ToolInfo: - type: object - properties: - metadata: - $ref: "#/components/schemas/ToolMetadata" - parameters: - type: object - description: Parameters supported by the tool. - additionalProperties: - $ref: "#/components/schemas/WriteActionParameter" - ChatMessageFragment: - description: Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation or file. - allOf: - - $ref: "#/components/schemas/Result" - - type: object - properties: - text: - type: string - querySuggestion: - description: The search queries issued while responding. - $ref: "#/components/schemas/QuerySuggestion" - file: - description: Files referenced in the message fragment. This is used to construct rich-text messages with file references. - $ref: "#/components/schemas/ChatFile" - action: - description: Basic information about an action. This can be used to construct rich-text messages with action references. - $ref: "#/components/schemas/ToolInfo" - citation: - description: Inline citation. - $ref: "#/components/schemas/ChatMessageCitation" - ChatMessage: - description: A message that is rendered as one coherent unit with one given sender. - properties: - agentConfig: - $ref: "#/components/schemas/AgentConfig" - description: Describes the agent config that generated this message. Populated on responses and not required on requests. - author: - default: USER - enum: - - USER - - GLEAN_AI - citations: - type: array - items: - $ref: "#/components/schemas/ChatMessageCitation" - description: A list of Citations that were used to generate the response. - uploadedFileIds: - type: array - items: - type: string - description: IDs of files uploaded in the message that are referenced to generate the answer. - fragments: - type: array - description: A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - items: - $ref: "#/components/schemas/ChatMessageFragment" - ts: - type: string - description: Response timestamp of the message. - messageId: - type: string - description: A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - messageTrackingToken: - type: string - description: Opaque tracking token generated server-side. - messageType: - type: string - default: CONTENT - description: Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - x-enumDescriptions: - UPDATE: An intermediate state message for progress updates. - CONTENT: A user query or response message. - CONTEXT: A message providing context in addition to the user query. - DEBUG: A debug message. Strictly used internally. - DEBUG_EXTERNAL: A debug message to be used while debugging Action creation. - ERROR: A message that describes an error while processing the request. - HEADING: A heading message used to distinguish different sections of the holistic response. - WARNING: A warning message to be shown to the user. - SERVER_TOOL: A message used to for server-side tool auth/use, for request and response. - enum: - - UPDATE - - CONTENT - - CONTEXT - - DEBUG - - DEBUG_EXTERNAL - - ERROR - - HEADING - - WARNING - - SERVER_TOOL - hasMoreFragments: - deprecated: true - type: boolean - description: Signals there are additional response fragments incoming. - ChatRestrictionFilters: - allOf: - - $ref: "#/components/schemas/RestrictionFilters" - - type: object - properties: - documentSpecs: - type: array - items: - $ref: "#/components/schemas/DocumentSpec" - datasourceInstances: - type: array - items: - type: string - ChatRequest: - required: - - messages - properties: - saveChat: - type: boolean - description: Save the current interaction as a Chat for the user to access and potentially continue later. - chatId: - type: string - description: The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true. - messages: - type: array - description: A list of chat messages, from most recent to least recent. At least one message must specify a USER author. - items: - $ref: "#/components/schemas/ChatMessage" - agentConfig: - $ref: "#/components/schemas/AgentConfig" - description: Describes the agent that will execute the request. - inclusions: - $ref: "#/components/schemas/ChatRestrictionFilters" - description: A list of filters which only allows chat to access certain content. - exclusions: - $ref: "#/components/schemas/ChatRestrictionFilters" - description: A list of filters which disallows chat from accessing certain content. If content is in both inclusions and exclusions, it'll be excluded. - timeoutMillis: - type: integer - description: Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - example: 30000 - sessionInfo: - description: Optional object for tracking the session used by the client and for debugging purposes. - $ref: "#/components/schemas/SessionInfo" - applicationId: - type: string - description: The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used. - agentId: - type: string - description: The ID of the Agent that should process this chat request. Only Agents with trigger set to 'User chat message' are invokable through this API. If not specified, the default chat experience will be used. - stream: - type: boolean - description: If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be. - ChatResponse: - description: A single response from the /chat backend. - properties: - messages: - type: array - items: - $ref: "#/components/schemas/ChatMessage" - chatId: - type: string - description: The id of the associated Chat the messages belong to, if one exists. - followUpPrompts: - type: array - items: - type: string - description: Follow-up prompts for the user to potentially use - backendTimeMillis: - type: integer - format: int64 - description: Time in milliseconds the backend took to respond to the request. - example: 1100 - chatSessionTrackingToken: - type: string - description: A token that is used to track the session. - DeleteChatsRequest: - required: - - ids - properties: - ids: - type: array - items: - type: string - description: A non-empty list of ids of the Chats to be deleted. - GetChatRequest: - required: - - id - properties: - id: - type: string - description: The id of the Chat to be retrieved. - ChatMetadata: - description: Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - properties: - id: - type: string - description: The opaque id of the Chat. - createTime: - type: integer - description: Server Unix timestamp of the creation time (in seconds since epoch UTC). - createdBy: - $ref: "#/components/schemas/Person" - description: The user who created this Chat. - updateTime: - type: integer - description: Server Unix timestamp of the update time (in seconds since epoch UTC). - name: - type: string - description: The name of the Chat. - applicationId: - type: string - description: The ID of the AI App that this Chat is associated to. - applicationName: - type: string - description: The display name of the AI App that this Chat is associated to. - icon: - $ref: "#/components/schemas/IconConfig" - Chat: - description: A historical representation of a series of chat messages a user had with Glean Assistant. - allOf: - - $ref: "#/components/schemas/ChatMetadata" - - $ref: "#/components/schemas/PermissionedObject" - properties: - messages: - type: array - items: - $ref: "#/components/schemas/ChatMessage" - description: The chat messages within a Chat. - roles: - type: array - items: - $ref: "#/components/schemas/UserRoleSpecification" - description: A list of roles for this Chat. - ChatResult: - properties: - chat: - $ref: "#/components/schemas/Chat" - trackingToken: - type: string - description: An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - GetChatResponse: - properties: - chatResult: - $ref: "#/components/schemas/ChatResult" - ChatMetadataResult: - properties: - chat: - $ref: "#/components/schemas/ChatMetadata" - trackingToken: - type: string - description: An opaque token that represents this particular Chat. To be used for `/feedback` reporting. - ListChatsResponse: - properties: - chatResults: - type: array - items: - $ref: "#/components/schemas/ChatMetadataResult" - x-includeEmpty: true - GetChatApplicationRequest: - required: - - id - properties: - id: - type: string - description: The id of the Chat application to be retrieved. - ChatApplicationDetails: {} - GetChatApplicationResponse: - properties: - application: - $ref: "#/components/schemas/ChatApplicationDetails" - UploadChatFilesRequest: - required: - - files - properties: - files: - type: array - items: - type: string - format: binary - description: Raw files to be uploaded for chat in binary format. - UploadChatFilesResponse: - properties: - files: - type: array - items: - $ref: "#/components/schemas/ChatFile" - description: Files uploaded for chat. - GetChatFilesRequest: - required: - - fileIds - properties: - fileIds: - type: array - items: - type: string - description: IDs of files to fetch. - chatId: - type: string - description: The ID of the chat that contains the chat file. - GetChatFilesResponse: - properties: - files: - description: A map of file IDs to ChatFile structs. - type: object - additionalProperties: - $ref: "#/components/schemas/ChatFile" - DeleteChatFilesRequest: - required: - - fileIds - properties: - fileIds: - type: array - items: - type: string - description: IDs of files to delete. - Agent: - title: Agent - type: object - required: - - agent_id - - name - - capabilities - properties: - agent_id: - type: string - title: Agent Id - description: The ID of the agent. - example: mho4lwzylcozgoc2 - name: - type: string - title: Agent Name - description: The name of the agent - example: HR Policy Agent - description: - type: string - title: Description - description: The description of the agent. - example: This agent answers questions about the current company HR policies. - metadata: - type: object - title: Metadata - description: The agent metadata. Currently not implemented. - capabilities: - type: object - title: Agent Capabilities - description: |- - Describes features that the agent supports. example: { - "ap.io.messages": true, - "ap.io.streaming": true - } - properties: - ap.io.messages: - type: boolean - title: Messages - description: Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent. - ap.io.streaming: - type: boolean - title: Streaming - description: Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming. - additionalProperties: true - ErrorResponse: - type: string - title: ErrorResponse - description: Error message returned from the server - AgentSchemas: - properties: - agent_id: - type: string - title: Agent Id - description: The ID of the agent. - example: mho4lwzylcozgoc2 - input_schema: - type: object - title: Input Schema - description: The schema for the agent input. In JSON Schema format. - output_schema: - type: object - title: Output Schema - description: The schema for the agent output. In JSON Schema format. - type: object - required: - - agent_id - - input_schema - - output_schema - title: AgentSchemas - description: Defines the structure and properties of an agent. - SearchAgentsRequest: - type: object - properties: - name: - type: string - description: Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter. - example: HR Policy Agent - SearchAgentsResponse: - type: object - title: Response Search Agents - properties: - agents: - type: array - items: - $ref: "#/components/schemas/Agent" - ContentType: - type: string - enum: - - text - Message: - type: object - properties: - role: - type: string - title: Role - description: The role of the message. - example: USER - content: - title: Content - description: The content of the message. - type: array - items: - type: object - properties: - text: - type: string - type: - $ref: "#/components/schemas/ContentType" - required: - - text - - type - title: MessageTextBlock - AgentRunCreate: - description: Payload for creating a run. - type: object - required: - - agent_id - properties: - agent_id: - type: string - title: Agent Id - description: The ID of the agent to run. - input: - type: object - title: Input - description: The input to the agent. - additionalProperties: true - messages: - type: array - items: - $ref: "#/components/schemas/Message" - title: Messages - description: The messages to pass an input to the agent. - metadata: - type: object - title: Metadata - description: The metadata to pass to the agent. - additionalProperties: true - AgentExecutionStatus: - description: The status of the run. One of 'error', 'success'. - type: string - enum: - - error - - success - title: AgentExecutionStatus - AgentRun: - allOf: - - $ref: "#/components/schemas/AgentRunCreate" - - type: object - properties: - status: - $ref: "#/components/schemas/AgentExecutionStatus" - AgentRunWaitResponse: - type: object - properties: - run: - $ref: "#/components/schemas/AgentRun" - title: Run - description: The run information. - messages: - type: array - items: - $ref: "#/components/schemas/Message" - title: Messages - description: The messages returned by the run. - CollectionItemDescriptor: - allOf: - - $ref: "#/components/schemas/CollectionItemMutableProperties" - properties: - url: - type: string - description: The URL of the item being added. - documentId: - type: string - description: The Glean Document ID of the item being added if it's an indexed document. - newNextItemId: - type: string - description: The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection - itemType: - type: string - enum: - - DOCUMENT - - TEXT - - URL - AddCollectionItemsRequest: - required: - - collectionId - properties: - collectionId: - type: number - description: The ID of the Collection to add items to. - addedCollectionItemDescriptors: - type: array - items: - $ref: "#/components/schemas/CollectionItemDescriptor" - description: The CollectionItemDescriptors of the items being added. - AddCollectionItemsError: - properties: - errorType: - type: string - enum: - - EXISTING_ITEM - AddCollectionItemsResponse: - properties: - collection: - $ref: "#/components/schemas/Collection" - description: The modified Collection. Only CollectionItemMutableProperties are set for each item. - error: - $ref: "#/components/schemas/AddCollectionItemsError" - CreateCollectionRequest: - allOf: - - $ref: "#/components/schemas/CollectionMutableProperties" - - type: object - properties: - newNextItemId: - type: string - description: The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified. - CollectionError: - required: - - errorCode - properties: - errorCode: - type: string - enum: - - NAME_EXISTS - - NOT_FOUND - - COLLECTION_PINNED - - CONCURRENT_HIERARCHY_EDIT - - HEIGHT_VIOLATION - - WIDTH_VIOLATION - - NO_PERMISSIONS - CreateCollectionResponse: - allOf: - - type: object - anyOf: - - required: - - collection - - required: - - error - properties: - collection: - $ref: "#/components/schemas/Collection" - error: - $ref: "#/components/schemas/CollectionError" - DeleteCollectionRequest: - required: - - ids - properties: - ids: - type: array - items: - type: integer - description: The IDs of the Collections to delete. - allowedDatasource: - type: string - description: The datasource allowed in the Collection to be deleted. - DeleteCollectionItemRequest: - required: - - collectionId - - itemId - properties: - collectionId: - type: number - description: The ID of the Collection to remove an item in. - itemId: - type: string - description: The item ID of the CollectionItem to remove from this Collection. - documentId: - type: string - description: The (optional) Glean Document ID of the CollectionItem to remove from this Collection if this is an indexed document. - DeleteCollectionItemResponse: - properties: - collection: - $ref: "#/components/schemas/Collection" - description: The modified Collection. Only CollectionItemMutableProperties are set for each item. - EditCollectionRequest: - allOf: - - $ref: "#/components/schemas/CollectionMutableProperties" - - type: object - required: - - id - properties: - id: - type: integer - description: The ID of the Collection to modify. - EditCollectionResponse: - allOf: - - $ref: "#/components/schemas/Collection" - - $ref: "#/components/schemas/CollectionError" - - type: object - properties: - collection: - $ref: "#/components/schemas/Collection" - error: - $ref: "#/components/schemas/CollectionError" - EditCollectionItemRequest: - required: - - collectionId - - itemId - allOf: - - $ref: "#/components/schemas/CollectionItemMutableProperties" - - type: object - properties: - collectionId: - type: integer - description: The ID of the Collection to edit CollectionItems in. - itemId: - type: string - description: The ID of the CollectionItem to edit. - EditCollectionItemResponse: - properties: - collection: - $ref: "#/components/schemas/Collection" - description: The modified Collection. Only CollectionItemMutableProperties are set for each item. - GetCollectionRequest: - required: - - id - properties: - id: - type: integer - description: The ID of the Collection to be retrieved. - withItems: - type: boolean - description: Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive. - withHierarchy: - type: boolean - description: Whether or not to include the top level Collection in this Collection's hierarchy. - allowedDatasource: - type: string - description: The datasource allowed in the Collection returned. - GetCollectionResponse: - properties: - collection: - $ref: "#/components/schemas/Collection" - rootCollection: - $ref: "#/components/schemas/Collection" - trackingToken: - type: string - description: An opaque token that represents this particular Collection. To be used for `/feedback` reporting. - error: - $ref: "#/components/schemas/CollectionError" - ListCollectionsRequest: - properties: - includeAudience: - type: boolean - description: Whether to include the audience filters with the listed Collections. - includeRoles: - type: boolean - description: Whether to include the editor roles with the listed Collections. - allowedDatasource: - type: string - description: |- - The datasource type this Collection can hold. - ANSWERS - for Collections representing answer boards - ListCollectionsResponse: - required: - - collections - properties: - collections: - type: array - items: - $ref: "#/components/schemas/Collection" - description: List of all Collections, no Collection items are fetched. - GetDocPermissionsRequest: - type: object - properties: - documentId: - type: string - description: The Glean Document ID to retrieve permissions for. - GetDocPermissionsResponse: - type: object - properties: - allowedUserEmails: - type: array - items: - type: string - description: A list of emails of users who have access to the document. If the document is visible to all Glean users, a list with only a single value of 'VISIBLE_TO_ALL'. - GetDocumentsRequest: - required: - - documentSpecs - properties: - documentSpecs: - type: array - items: - $ref: "#/components/schemas/DocumentSpec" - description: The specification for the documents to be retrieved. - includeFields: - description: List of Document fields to return (that aren't returned by default) - type: array - items: - type: string - enum: - - LAST_VIEWED_AT - - VISITORS_COUNT - - RECENT_SHARES - - DOCUMENT_CONTENT - DocumentOrError: - oneOf: - - $ref: "#/components/schemas/Document" - - type: object - properties: - error: - type: string - description: The text for error, reason. - GetDocumentsResponse: - properties: - documents: - type: object - additionalProperties: - $ref: "#/components/schemas/DocumentOrError" - description: The document details or the error if document is not found. - GetDocumentsByFacetsRequest: - required: - - filterSets - properties: - datasourcesFilter: - type: array - items: - type: string - description: Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - filterSets: - type: array - items: - $ref: "#/components/schemas/FacetFilterSet" - description: A list of facet filter sets that will be OR'ed together. An AND is assumed between different filters in each set. - cursor: - type: string - description: Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - GetDocumentsByFacetsResponse: - properties: - documents: - type: array - items: - $ref: "#/components/schemas/Document" - description: The document details, ordered by score. - hasMoreResults: - type: boolean - description: Whether more results are available. Use cursor to retrieve them. - cursor: - type: string - description: Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - InsightsAiAppRequestOptions: - type: object - properties: - aiAppIds: - type: array - items: - type: string - description: IDs of the AI Apps for which Insights should be returned. An empty array signifies all. - InsightsAgentsRequestOptions: - type: object - properties: - agentIds: - type: array - items: - type: string - description: IDs of the Agents for which Insights should be returned. An empty array signifies all. - DownloadInsightsRequest: - required: - - categories - properties: - categories: - type: array - items: - type: string - enum: - - AGENTS - - AI - - AI_APPS - - ANNOUNCEMENTS - - ANSWERS - - COLLECTIONS - - CONTENT - - GLEAN_ASSIST - - QUERIES - - SHORTCUTS - - USERS - description: Categories of data requested. Request can include single or multiple types. - departments: - type: array - items: - type: string - description: Departments that the data is requested for. If this is empty, corresponds to whole company. - dayRange: - $ref: "#/components/schemas/Period" - aiAppRequestOptions: - $ref: "#/components/schemas/InsightsAiAppRequestOptions" - agentsRequestOptions: - $ref: "#/components/schemas/InsightsAgentsRequestOptions" - InsightsRequest: - allOf: - - $ref: "#/components/schemas/DownloadInsightsRequest" - - type: object - properties: - assistantActivityTypes: - type: array - items: - type: string - enum: - - GLEAN_CHAT - - AI_SUMMARY - - AI_ANSWER - - GLEANBOT_RESPONSE - description: Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category. - disablePerUserInsights: - type: boolean - description: If true, suppresses the generation of per-user Insights in the response. Default is false. - LabeledCountInfo: - required: - - label - properties: - label: - type: string - description: Label for the included count information. - countInfo: - type: array - items: - $ref: "#/components/schemas/CountInfo" - description: List of data points for counts for a given date period. - UserActivityInsight: - required: - - user - - activity - properties: - user: - $ref: "#/components/schemas/Person" - activity: - type: string - enum: - - ALL - - SEARCH - description: Activity e.g. search, home page visit or all. - lastActivityTimestamp: - type: integer - description: Unix timestamp of the last activity (in seconds since epoch UTC). - activityCount: - $ref: "#/components/schemas/CountInfo" - activeDayCount: - $ref: "#/components/schemas/CountInfo" - UserInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - activityInsights: - type: array - items: - $ref: "#/components/schemas/UserActivityInsight" - description: Insights for all active users with respect to set of actions. - inactiveInsights: - type: array - items: - $ref: "#/components/schemas/UserActivityInsight" - description: Insights for all in inactive users with respect to set of actions and time period. Activity count will be set to 0. - totalTeammates: - type: integer - description: Total number of teammates that have logged in to the product, that are still valid teammates. - totalActiveUsers: - type: integer - description: Total number of active users in the requested period. - departments: - type: array - items: - type: string - description: list of departments applicable for users tab. - DocumentInsight: - required: - - document - properties: - document: - $ref: "#/components/schemas/Document" - viewCount: - $ref: "#/components/schemas/CountInfo" - visitorCount: - $ref: "#/components/schemas/CountInfo" - ContentInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - documentInsights: - type: array - items: - $ref: "#/components/schemas/DocumentInsight" - description: Insights for documents. - departments: - type: array - items: - type: string - description: list of departments applicable for contents tab. - minDepartmentSizeThreshold: - type: integer - description: Min threshold in size of departments while populating results, otherwise 0. - minVisitorThreshold: - type: integer - description: Minimum number of visitors to a document required to be included in insights. - QueryInsight: - required: - - query - properties: - query: - type: string - description: The query string the information is about. - searchCount: - $ref: "#/components/schemas/CountInfo" - searchorCount: - $ref: "#/components/schemas/CountInfo" - searchWithClickCount: - $ref: "#/components/schemas/CountInfo" - clickCount: - $ref: "#/components/schemas/CountInfo" - similarQueries: - type: array - items: - $ref: "#/components/schemas/QueryInsight" - description: list of similar queries to current one. - QueryInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - queryInsights: - type: array - items: - $ref: "#/components/schemas/QueryInsight" - description: Insights for queries. - lowPerformingQueryInsights: - type: array - items: - $ref: "#/components/schemas/QueryInsight" - description: Insights for low performing queries without good results. - departments: - type: array - items: - type: string - description: list of departments applicable for queries tab. - minVisitorThreshold: - type: integer - description: Min threshold in number of visitors while populating results, otherwise 0. - ShortcutInsight: - required: - - shortcut - properties: - shortcut: - $ref: "#/components/schemas/Shortcut" - visitCount: - $ref: "#/components/schemas/CountInfo" - visitorCount: - $ref: "#/components/schemas/CountInfo" - ShortcutInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - shortcutInsights: - type: array - items: - $ref: "#/components/schemas/ShortcutInsight" - description: Insights for shortcuts. - departments: - type: array - items: - type: string - description: list of departments applicable for shortcuts tab. - minVisitorThreshold: - type: integer - description: Min threshold in number of visitors while populating results, otherwise 0. - AiInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - assistantInsights: - type: array - items: - $ref: "#/components/schemas/UserActivityInsight" - totalActiveAssistantUsers: - type: integer - description: Total number of Active Assistant users (chat, summary, AIA) in requested period. - totalChatMessages: - type: integer - description: Total number of Chat messages sent in requested period. - totalAiSummarizations: - type: integer - description: Total number of AI Document Summarizations invoked in the requested period. - totalAiAnswers: - type: integer - description: Total number of AI Answers generated in the requested period. - totalUpvotes: - type: integer - description: Total number of Chat messages which received upvotes by the user. - totalDownvotes: - type: integer - description: Total number of Chat messages which received downvotes by the user. - totalGleanbotResponses: - type: integer - description: Total number of Gleanbot responses, both proactive and reactive. - totalGleanbotResponsesShared: - type: integer - description: Total number of Gleanbot responses shared publicly (upvoted). - totalGleanbotResponsesNotHelpful: - type: integer - description: Total number of Glean responses rejected as not helpful (downvoted). - departments: - type: array - items: - type: string - description: list of departments applicable for users tab. - AiAppActionCounts: - type: object - additionalProperties: - type: integer - description: Map from action to frequency. - properties: - totalSlackbotResponses: - type: integer - description: Total number of Slackbot responses, both proactive and reactive. - totalSlackbotResponsesShared: - type: integer - description: Total number of Slackbot responses shared publicly (upvoted). - totalSlackbotResponsesNotHelpful: - type: integer - description: Total number of Slackbot responses rejected as not helpful (downvoted). - totalChatMessages: - type: integer - description: Total number of Chat messages sent in requested period. - totalUpvotes: - type: integer - description: Total number of Chat messages which received upvotes by the user. - totalDownvotes: - type: integer - description: Total number of Chat messages which received downvotes by the user. - AiAppsInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - aiAppInsights: - type: array - items: - $ref: "#/components/schemas/UserActivityInsight" - totalActiveUsers: - type: integer - description: Total number of active users on the Ai App in the requested period. - actionCounts: - $ref: "#/components/schemas/AiAppActionCounts" - departments: - type: array - items: - type: string - description: list of departments applicable for users tab. - GleanAssistInsightsResponse: - properties: - lastLogTimestamp: - type: integer - description: Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - activityInsights: - type: array - items: - $ref: "#/components/schemas/UserActivityInsight" - description: Insights for all active users with respect to set of actions. - totalActiveUsers: - type: integer - description: Total number of active users in the requested period. - datasourceInstances: - type: array - items: - type: string - description: List of datasource instances for which glean assist is enabled. - departments: - type: array - items: - type: string - description: List of departments applicable for users tab. - InsightsResponse: - properties: - timeseries: - type: array - items: - $ref: "#/components/schemas/LabeledCountInfo" - description: List of timeseries to make charts (if applicable). - users: - $ref: "#/components/schemas/UserInsightsResponse" - content: - $ref: "#/components/schemas/ContentInsightsResponse" - queries: - $ref: "#/components/schemas/QueryInsightsResponse" - collections: - $ref: "#/components/schemas/ContentInsightsResponse" - collectionsV2: - $ref: "#/components/schemas/ContentInsightsResponse" - shortcuts: - $ref: "#/components/schemas/ShortcutInsightsResponse" - announcements: - $ref: "#/components/schemas/ContentInsightsResponse" - answers: - $ref: "#/components/schemas/ContentInsightsResponse" - ai: - $ref: "#/components/schemas/AiInsightsResponse" - aiApps: - $ref: "#/components/schemas/AiAppsInsightsResponse" - gleanAssist: - $ref: "#/components/schemas/GleanAssistInsightsResponse" - departments: - type: array - items: - type: string - description: list of all departments. - MessagesRequest: - required: - - id - - idType - properties: - idType: - type: string - enum: - - CHANNEL_NAME - - THREAD_ID - - CONVERSATION_ID - description: Type of the id in the incoming request. - id: - type: string - description: ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID. - workspaceId: - type: string - description: Id for the for the workspace in case of multiple workspaces. - direction: - type: string - enum: - - OLDER - - NEWER - description: The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. - timestampMillis: - type: integer - format: int64 - description: Timestamp in millis of the reference message. Only applicable when using a message_id. - includeRootMessage: - type: boolean - description: Whether to include root message in response. - datasource: - type: string - enum: - - SLACK - - MICROSOFTTEAMS - - FACEBOOKWORKPLACE - description: The type of the data source. Missing field defaults to SLACK. - datasourceInstanceDisplayName: - type: string - description: The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances. - InvalidOperatorValueError: - properties: - key: - description: The operator key that has an invalid value. - type: string - value: - description: The invalid operator value. - type: string - ErrorMessage: - properties: - source: - description: The datasource this message relates to. - type: string - errorMessage: - type: string - ErrorInfo: - properties: - badGmailToken: - type: boolean - description: Indicates the gmail results could not be fetched due to bad token. - badOutlookToken: - type: boolean - description: Indicates the outlook results could not be fetched due to bad token. - invalidOperators: - type: array - description: Indicates results could not be fetched due to invalid operators in the query. - items: - $ref: "#/components/schemas/InvalidOperatorValueError" - errorMessages: - type: array - items: - $ref: "#/components/schemas/ErrorMessage" - x-speakeasy-name-override: GleanDataError - ResultsResponse: - properties: - trackingToken: - type: string - description: A token that should be passed for additional requests related to this request (such as more results requests). - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - results: - type: array - items: - $ref: "#/components/schemas/SearchResult" - structuredResults: - type: array - items: - $ref: "#/components/schemas/StructuredResult" - generatedQnaResult: - $ref: "#/components/schemas/GeneratedQna" - errorInfo: - $ref: "#/components/schemas/ErrorInfo" - requestID: - type: string - description: A platform-generated request ID to correlate backend logs. - backendTimeMillis: - type: integer - format: int64 - description: Time in milliseconds the backend took to respond to the request. - example: 1100 - BackendExperimentsContext: - properties: - experimentIds: - type: array - items: - type: integer - format: int64 - description: List of experiment ids for the corresponding request. - SearchWarning: - required: - - warningType - properties: - warningType: - type: string - enum: - - LONG_QUERY - - QUOTED_PUNCTUATION - - PUNCTUATION_ONLY - - COPYPASTED_QUOTES - - INVALID_OPERATOR - - MAYBE_INVALID_FACET_QUERY - - TOO_MANY_DATASOURCE_GROUPS - description: The type of the warning. - lastUsedTerm: - type: string - description: The last term we considered in the user's long query. - quotesIgnoredQuery: - type: string - description: The query after ignoring/removing quotes. - ignoredTerms: - type: array - items: - type: string - description: A list of query terms that were ignored when generating search results, if any. For example, terms containing invalid filters such as "updated:invalid_date" will be ignored. - SearchResponseMetadata: - properties: - rewrittenQuery: - type: string - description: A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators. - searchedQuery: - type: string - description: The actual query used to perform search and return results. - searchedQueryWithoutNegation: - type: string - description: The query used to perform search and return results, with negated terms and facets removed. - x-includeEmpty: true - searchedQueryRanges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: The bolded ranges within the searched query. - originalQuery: - type: string - description: The query text sent by the client in the request. - querySuggestion: - $ref: "#/components/schemas/QuerySuggestion" - description: An alternative query to the one provided that may give better results, e.g. a spelling suggestion. - additionalQuerySuggestions: - $ref: "#/components/schemas/QuerySuggestionList" - description: Other alternative queries that may provide better or more specific results than the original query. - negatedTerms: - type: array - items: - type: string - description: A list of terms that were negated when processing the query. - modifiedQueryWasUsed: - type: boolean - description: A different query was performed than the one requested. - originalQueryHadNoResults: - type: boolean - description: No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based. - searchWarning: - $ref: "#/components/schemas/SearchWarning" - triggeredExpertDetection: - type: boolean - description: Whether the query triggered expert detection results in the People tab. - isNoQuotesSuggestion: - type: boolean - description: Whether the query was modified to remove quotes - FacetValue: - properties: - stringValue: - type: string - example: engineering - description: The value that should be set in the FacetFilter when applying this filter to a search request. - integerValue: - type: integer - example: 5 - displayLabel: - type: string - example: engineering - description: An optional user-friendly label to display in place of the facet value. - iconConfig: - $ref: "#/components/schemas/IconConfig" - FacetBucket: - properties: - count: - type: integer - description: Estimated number of results in this facet. - example: 1 - datasource: - type: string - example: jira - description: The datasource the value belongs to. This will be used by the all tab to show types across all datasources. - percentage: - type: integer - description: Estimated percentage of results in this facet. - example: 5 - value: - $ref: "#/components/schemas/FacetValue" - FacetResult: - properties: - sourceName: - type: string - description: The source of this facet (e.g. container_name, type, last_updated_at). - example: container_name - operatorName: - type: string - description: How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'. - example: SelectMultiple - buckets: - type: array - description: A list of unique buckets that exist within this result set. - items: - $ref: "#/components/schemas/FacetBucket" - hasMoreBuckets: - type: boolean - description: Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize. - example: false - groupName: - type: string - description: For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource) - example: Service Cloud - ResultTab: - properties: - id: - type: string - description: The unique ID of the tab. Can be passed in a search request to get results for that tab. - count: - type: integer - description: The number of results in this tab for the current query. - datasource: - type: string - description: The datasource associated with the tab, if any. - datasourceInstance: - type: string - description: The datasource instance associated with the tab, if any. - ResultsDescription: - properties: - text: - type: string - description: Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab. - iconConfig: - $ref: "#/components/schemas/IconConfig" - description: The config for the icon that's displayed with this description - SearchResponse: - allOf: - - $ref: "#/components/schemas/ResultsResponse" - - $ref: "#/components/schemas/BackendExperimentsContext" - - type: object - properties: - metadata: - $ref: "#/components/schemas/SearchResponseMetadata" - facetResults: - type: array - items: - $ref: "#/components/schemas/FacetResult" - resultTabs: - type: array - items: - $ref: "#/components/schemas/ResultTab" - description: All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. - resultTabIds: - type: array - items: - type: string - description: The unique IDs of the result tabs to which this response belongs. - resultsDescription: - $ref: "#/components/schemas/ResultsDescription" - rewrittenFacetFilters: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - description: The actual applied facet filters based on the operators and facetFilters in the query. Useful for mapping typed operators to visual facets. - cursor: - type: string - description: Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. - hasMoreResults: - type: boolean - description: Whether more results are available. Use cursor to retrieve them. - example: - trackingToken: trackingToken - suggestedSpellCorrectedQuery: suggestedSpellCorrectedQuery - hasMoreResults: true - errorInfo: - errorMessages: - - source: gmail - errorMessage: invalid token - - source: slack - errorMessage: expired token - requestID: 5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100 - results: - - snippets: - - snippet: snippet - mimeType: mimeType - metadata: - container: container - createTime: "2000-01-23T04:56:07.000Z" - datasource: datasource - author: - name: name - documentId: documentId - updateTime: "2000-01-23T04:56:07.000Z" - mimeType: mimeType - objectType: objectType - title: title - url: https://www.example.com/ - - snippets: - - snippet: snippet - mimeType: mimeType - metadata: - container: container - createTime: "2000-01-23T04:56:07.000Z" - datasource: datasource - author: - name: name - documentId: documentId - updateTime: "2000-01-23T04:56:07.000Z" - mimeType: mimeType - objectType: objectType - title: title - url: https://www.example.com/ - facetResults: - - buckets: - - percentage: 5 - count: 1 - value: - stringValue: stringValue - integerValue: 5 - - percentage: 5 - count: 1 - value: - stringValue: stringValue - integerValue: 5 - sourceName: sourceName - operatorName: operatorName - objectType: objectType - - buckets: - - percentage: 5 - count: 1 - value: - stringValue: stringValue - integerValue: 5 - - percentage: 5 - count: 1 - value: - stringValue: stringValue - integerValue: 5 - sourceName: sourceName - operatorName: operatorName - objectType: objectType - rewrittenQuery: rewrittenQuery - rewrittenFacetFilters: - - fieldName: fieldName - values: - - fieldValues - - fieldValues - - fieldName: fieldName - values: - - fieldValues - - fieldValues - MessagesResponse: - required: - - hasMore - properties: - hasMore: - type: boolean - description: Whether there are more results for client to continue requesting. - searchResponse: - $ref: "#/components/schemas/SearchResponse" - rootMessage: - $ref: "#/components/schemas/SearchResult" - EditPinRequest: - allOf: - - $ref: "#/components/schemas/PinDocumentMutableProperties" - - type: object - properties: - id: - type: string - description: The opaque id of the pin to be edited. - GetPinRequest: - properties: - id: - type: string - description: The opaque id of the pin to be fetched. - GetPinResponse: - properties: - pin: - $ref: "#/components/schemas/PinDocument" - ListPinsResponse: - required: - - pins - properties: - pins: - type: array - items: - $ref: "#/components/schemas/PinDocument" - description: List of pinned documents. - PinRequest: - allOf: - - $ref: "#/components/schemas/PinDocumentMutableProperties" - - type: object - properties: - documentId: - type: string - description: The document to be pinned. - Unpin: - properties: - id: - type: string - description: The opaque id of the pin to be unpinned. - ResultsRequest: - properties: - timestamp: - type: string - description: The ISO 8601 timestamp associated with the client request. - format: date-time - trackingToken: - type: string - description: A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - sourceDocument: - $ref: "#/components/schemas/Document" - description: The document from which the ResultsRequest is issued, if any. - pageSize: - type: integer - example: 100 - description: Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. - maxSnippetSize: - type: integer - description: Hint to the server about how many characters long a snippet may be. Server may return less or more. - example: 400 - SearchRequest: - required: - - query - allOf: - - $ref: "#/components/schemas/ResultsRequest" - - type: object - properties: - query: - type: string - description: The search terms. - example: vacation policy - cursor: - type: string - description: Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - resultTabIds: - type: array - items: - type: string - description: The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict. - inputDetails: - $ref: "#/components/schemas/SearchRequestInputDetails" - requestOptions: - $ref: "#/components/schemas/SearchRequestOptions" - timeoutMillis: - type: integer - description: Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - example: 5000 - disableSpellcheck: - type: boolean - description: Whether or not to disable spellcheck. - example: - trackingToken: trackingToken - query: vacation policy - pageSize: 10 - requestOptions: - facetFilters: - - fieldName: type - values: - - value: article - relationType: EQUALS - - value: document - relationType: EQUALS - - fieldName: department - values: - - value: engineering - relationType: EQUALS - AutocompleteRequest: - type: object - properties: - trackingToken: - type: string - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - query: - type: string - description: Partially typed query. - example: San Fra - datasourcesFilter: - type: array - items: - type: string - description: Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing. - datasource: - type: string - description: Filter to only return results relevant to the given datasource. - resultTypes: - type: array - description: Filter to only return results of the given type(s). All types may be returned if omitted. - items: - type: string - enum: - - ADDITIONAL_DOCUMENT - - APP - - BROWSER_HISTORY - - DATASOURCE - - DOCUMENT - - ENTITY - - GOLINK - - HISTORY - - NEW_CHAT - - OPERATOR - - OPERATOR_VALUE - - QUICKLINK - - SUGGESTION - resultSize: - type: integer - description: | - Maximum number of results to be returned. If no value is provided, the backend will cap at 200. - example: 10 - authTokens: - type: array - description: Auth tokens which may be used for federated results. - items: - $ref: "#/components/schemas/AuthToken" - example: - trackingToken: trackingToken - query: what is a que - datasource: GDRIVE - resultSize: 10 - OperatorScope: - properties: - datasource: - type: string - docType: - type: string - OperatorMetadata: - required: - - name - properties: - name: - type: string - isCustom: - type: boolean - description: Whether this operator is supported by default or something that was created within a workplace app (e.g. custom jira field). - operatorType: - type: string - enum: - - TEXT - - DOUBLE - - DATE - - USER - helpText: - type: string - scopes: - type: array - items: - $ref: "#/components/schemas/OperatorScope" - value: - type: string - description: Raw/canonical value of the operator. Only applies when result is an operator value. - displayValue: - type: string - description: Human readable value of the operator that can be shown to the user. Only applies when result is an operator value. - example: - name: Last Updated - operatorType: DATE - scopes: - - datasource: GDRIVE - docType: Document - - datasource: ZENDESK - Quicklink: - description: An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira. - properties: - name: - type: string - description: Full action name. Used in autocomplete. - shortName: - type: string - description: Shortened name. Used in app cards. - url: - type: string - description: The URL of the action. - iconConfig: - $ref: "#/components/schemas/IconConfig" - description: The config for the icon for this quicklink - id: - type: string - description: Unique identifier of this quicklink - scopes: - type: array - description: The scopes for which this quicklink is applicable - items: - type: string - enum: - - APP_CARD - - AUTOCOMPLETE_EXACT_MATCH - - AUTOCOMPLETE_FUZZY_MATCH - - AUTOCOMPLETE_ZERO_QUERY - - NEW_TAB_PAGE - AutocompleteResult: - required: - - result - - result_type - properties: - result: - type: string - keywords: - type: array - items: - type: string - description: A list of all possible keywords for given result. - resultType: - type: string - enum: - - ADDITIONAL_DOCUMENT - - APP - - BROWSER_HISTORY - - DATASOURCE - - DOCUMENT - - ENTITY - - GOLINK - - HISTORY - - NEW_CHAT - - OPERATOR - - OPERATOR_VALUE - - QUICKLINK - - SUGGESTION - score: - type: number - description: Higher indicates a more confident match. - operatorMetadata: - $ref: "#/components/schemas/OperatorMetadata" - quicklink: - $ref: "#/components/schemas/Quicklink" - document: - $ref: "#/components/schemas/Document" - url: - type: string - structuredResult: - $ref: "#/components/schemas/StructuredResult" - trackingToken: - type: string - description: A token to be passed in /feedback events associated with this autocomplete result. - ranges: - type: array - items: - $ref: "#/components/schemas/TextRange" - description: Subsections of the result string to which some special formatting should be applied (eg. bold) - example: - result: sample result - resultType: DOCUMENT - score: 4.56 - url: https://www.example.com/ - trackingToken: abcd - metadata: - - datasource: confluence - - objectType: page - AutocompleteResultGroup: - description: A subsection of the results list from which distinct sections should be created. - properties: - startIndex: - type: integer - description: The inclusive start index of the range. - endIndex: - type: integer - description: The exclusive end index of the range. - title: - type: string - description: The title of the result group to be displayed. Empty means no title. - AutocompleteResponse: - allOf: - - $ref: "#/components/schemas/BackendExperimentsContext" - - type: object - properties: - trackingToken: - type: string - description: An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting. - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - results: - type: array - items: - $ref: "#/components/schemas/AutocompleteResult" - groups: - type: array - items: - $ref: "#/components/schemas/AutocompleteResultGroup" - description: Subsections of the results list from which distinct sections should be created. - errorInfo: - $ref: "#/components/schemas/ErrorInfo" - backendTimeMillis: - type: integer - format: int64 - description: Time in milliseconds the backend took to respond to the request. - example: 1100 - example: - trackingToken: trackingToken - ChatZeroStateSuggestionOptions: - properties: - applicationId: - type: string - description: The Chat Application ID this feed request should be scoped to. Empty means there is no Chat Application ID.. - FeedRequestOptions: - required: - - resultSize - properties: - resultSize: - type: integer - description: Number of results asked in response. If a result is a collection, counts as one. - timezoneOffset: - type: integer - description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - categoryToResultSize: - type: object - additionalProperties: - type: object - properties: - resultSize: - type: integer - description: Mapping from category to number of results asked for the category. - datasourceFilter: - type: array - items: - type: string - description: Datasources for which content should be included. Empty is for all. - chatZeroStateSuggestionOptions: - $ref: "#/components/schemas/ChatZeroStateSuggestionOptions" - FeedRequest: - required: - - refreshType - properties: - categories: - type: array - items: - type: string - enum: - - DOCUMENT_SUGGESTION - - DOCUMENT_SUGGESTION_SCENARIO - - TRENDING_DOCUMENT - - VERIFICATION_REMINDER - - EVENT - - ANNOUNCEMENT - - MENTION - - DATASOURCE_AFFINITY - - RECENT - - COMPANY_RESOURCE - - EXPERIMENTAL - - PEOPLE_CELEBRATIONS - - DISPLAYABLE_LIST - - SOCIAL_LINK - - EXTERNAL_TASKS - - WORKFLOW_COLLECTIONS - - ZERO_STATE_CHAT_SUGGESTION - - ZERO_STATE_CHAT_TOOL_SUGGESTION - - ZERO_STATE_WORKFLOW_CREATED_BY_ME - - ZERO_STATE_WORKFLOW_FAVORITES - - ZERO_STATE_WORKFLOW_POPULAR - - ZERO_STATE_WORKFLOW_SUGGESTION - - PERSONALIZED_CHAT_SUGGESTION - - DAILY_DIGEST - description: Categories of content requested. An allowlist gives flexibility to request content separately or together. - requestOptions: - $ref: "#/components/schemas/FeedRequestOptions" - timeoutMillis: - type: integer - description: Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - example: 5000 - sessionInfo: - $ref: "#/components/schemas/SessionInfo" - DisplayableListFormat: - properties: - format: - type: string - enum: - - LIST - description: defines how to render this particular displayable list card - DisplayableListItemUIConfig: - type: object - description: UI configurations for each item of the list - properties: - showNewIndicator: - type: boolean - description: show a "New" pill next to the item - ConferenceData: - required: - - provider - - uri - properties: - provider: - type: string - enum: - - ZOOM - - HANGOUTS - uri: - type: string - description: A permalink for the conference. - source: - type: string - enum: - - NATIVE_CONFERENCE - - LOCATION - - DESCRIPTION - EventClassificationName: - description: The name for a generated classification of an event. - type: string - enum: - - External Event - EventStrategyName: - type: string - description: The name of method used to surface relevant data for a given calendar event. - enum: - - customerCard - - news - - call - - email - - meetingNotes - - linkedIn - - relevantDocuments - - chatFollowUps - - conversations - EventClassification: - description: A generated classification of a given event. - properties: - name: - $ref: "#/components/schemas/EventClassificationName" - strategies: - type: array - items: - $ref: "#/components/schemas/EventStrategyName" - StructuredLink: - description: The display configuration for a link. - properties: - name: - type: string - description: The display name for the link - url: - type: string - description: The URL for the link. - iconConfig: - $ref: "#/components/schemas/IconConfig" - GeneratedAttachmentContent: - description: Content that has been generated or extrapolated from the documents present in the document field. - properties: - displayHeader: - description: The header describing the generated content. - type: string - text: - description: The content that has been generated. - type: string - example: - displayHeader: Action Items - content: You said you'd send over the design document after the meeting. - GeneratedAttachment: - description: These are attachments that aren't natively present on the event, and have been smartly suggested. - properties: - strategyName: - $ref: "#/components/schemas/EventStrategyName" - documents: - type: array - items: - $ref: "#/components/schemas/Document" - person: - $ref: "#/components/schemas/Person" - customer: - $ref: "#/components/schemas/Customer" - externalLinks: - description: A list of links to external sources outside of Glean. - type: array - items: - $ref: "#/components/schemas/StructuredLink" - content: - type: array - items: - $ref: "#/components/schemas/GeneratedAttachmentContent" - CalendarEvent: - required: - - id - - url - allOf: - - $ref: "#/components/schemas/AnonymousEvent" - - type: object - properties: - id: - type: string - description: The calendar event id - url: - type: string - description: A permalink for this calendar event - attendees: - $ref: "#/components/schemas/CalendarAttendees" - location: - type: string - description: The location that this event is taking place at. - conferenceData: - $ref: "#/components/schemas/ConferenceData" - description: - type: string - description: The HTML description of the event. - datasource: - type: string - description: The app or other repository type from which the event was extracted - hasTranscript: - type: boolean - description: The event has a transcript associated with it enabling features like summarization - transcriptUrl: - type: string - description: A link to the transcript of the event - classifications: - type: array - items: - $ref: "#/components/schemas/EventClassification" - generatedAttachments: - type: array - items: - $ref: "#/components/schemas/GeneratedAttachment" - SectionType: - type: string - description: Type of the section. This defines how the section should be interpreted and rendered in the digest. - x-enumDescriptions: - CHANNEL: A standard section for channel-based digests (e.g. from Slack, Teams). - MENTIONS: A dedicated section that surfaces user mentions (actionable, informative, or all). - TOPIC: A section driven by a generic topic, not tied to any specific channel or instance. - enum: - - CHANNEL - - MENTIONS - - TOPIC - UpdateType: - type: string - description: Optional type classification for the update. - x-enumDescriptions: - ACTIONABLE: Updates that require user attention or action - INFORMATIVE: Updates that are purely informational - enum: - - ACTIONABLE - - INFORMATIVE - DigestUpdate: - type: object - properties: - url: - type: string - description: URL link to the content or document. - title: - type: string - description: Title or headline of the update. - datasource: - type: string - description: Name or identifier of the data source (e.g., slack, confluence, etc.). - summary: - type: string - description: Brief summary or description of the update content. - type: - $ref: "#/components/schemas/UpdateType" - DigestSection: - type: object - required: - - id - - type - - updates - properties: - id: - type: string - description: Unique identifier for the digest section. - type: - $ref: "#/components/schemas/SectionType" - displayName: - type: string - description: Human-readable name for the digest section. - channelName: - type: string - description: Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. - instanceId: - type: string - description: Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. - url: - type: string - description: Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. - updates: - type: array - items: - $ref: "#/components/schemas/DigestUpdate" - description: List of updates within this digest section. - Digest: - type: object - properties: - podcastFileId: - type: string - description: Identifier for the podcast file generated from this digest content. - podcastDuration: - type: number - format: float - description: Duration of the podcast file in seconds. - digestDate: - type: string - description: The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available. - example: "2025-09-03" - sections: - type: array - items: - $ref: "#/components/schemas/DigestSection" - description: Array of digest sections from which the podcast was created. - ChatSuggestion: - properties: - query: - type: string - description: The actionable chat query to run when the user selects this suggestion. - feature: - type: string - description: Targeted Glean Chat feature for the suggestion. - PromptTemplateMutableProperties: - required: - - template - properties: - name: - type: string - description: The user-given identifier for this prompt template. - template: - type: string - description: The actual template string. - applicationId: - type: string - description: The Application Id the prompt template should be created under. Empty for default assistant. - inclusions: - $ref: "#/components/schemas/ChatRestrictionFilters" - description: A list of filters which only allows the prompt template to access certain content. - addedRoles: - type: array - description: A list of added user roles for the Workflow. - items: - $ref: "#/components/schemas/UserRoleSpecification" - removedRoles: - type: array - description: A list of removed user roles for the Workflow. - items: - $ref: "#/components/schemas/UserRoleSpecification" - AttributionProperties: {} - PromptTemplate: - allOf: - - $ref: "#/components/schemas/PromptTemplateMutableProperties" - - $ref: "#/components/schemas/PermissionedObject" - - $ref: "#/components/schemas/AttributionProperties" - - type: object - properties: - id: - type: string - description: Opaque id for this prompt template - author: - $ref: "#/components/schemas/Person" - createTimestamp: - type: integer - description: Server Unix timestamp of the creation time. - lastUpdateTimestamp: - type: integer - description: Server Unix timestamp of the last update time. - lastUpdatedBy: - $ref: "#/components/schemas/Person" - roles: - type: array - description: A list of roles for this prompt template explicitly granted. - items: - $ref: "#/components/schemas/UserRoleSpecification" - UgcType: - enum: - - ANNOUNCEMENTS_TYPE - - ANSWERS_TYPE - - COLLECTIONS_TYPE - - SHORTCUTS_TYPE - - WORKFLOWS_TYPE - - PROMPT_TEMPLATES_TYPE - FavoriteInfo: - type: object - properties: - ugcType: - $ref: "#/components/schemas/UgcType" - id: - type: string - description: Opaque id of the UGC. - count: - type: integer - x-includeEmpty: true - description: Number of users this object has been favorited by. - favoritedByUser: - type: boolean - x-includeEmpty: true - description: If the requesting user has favorited this object. - PromptTemplateResult: - properties: - promptTemplate: - $ref: "#/components/schemas/PromptTemplate" - trackingToken: - type: string - description: An opaque token that represents this prompt template - favoriteInfo: - $ref: "#/components/schemas/FavoriteInfo" - runCount: - $ref: "#/components/schemas/CountInfo" - description: This tracks how many times this prompt template was run. If user runs a prompt template after modifying the original one, it still counts as a run for the original template. - WorkflowDraftableProperties: - properties: - name: - type: string - description: The name of the workflow. - WorkflowMutableProperties: - type: object - allOf: - - $ref: "#/components/schemas/WorkflowDraftableProperties" - - type: object - WorkflowMetadata: - allOf: - - type: object - properties: - author: - $ref: "#/components/schemas/Person" - createTimestamp: - type: integer - description: Server Unix timestamp of the creation time. - lastUpdateTimestamp: - type: integer - description: Server Unix timestamp of the last update time. - lastUpdatedBy: - $ref: "#/components/schemas/Person" - Workflow: - allOf: - - $ref: "#/components/schemas/PermissionedObject" - - $ref: "#/components/schemas/WorkflowMutableProperties" - - $ref: "#/components/schemas/WorkflowMetadata" - - $ref: "#/components/schemas/AttributionProperties" - - type: object - properties: - id: - type: string - description: The ID of the workflow. - WorkflowResult: - type: object - required: - - workflow - properties: - workflow: - $ref: "#/components/schemas/Workflow" - UserActivity: - properties: - actor: - $ref: "#/components/schemas/Person" - timestamp: - type: integer - description: Unix timestamp of the activity (in seconds since epoch UTC). - action: - type: string - enum: - - ADD - - ADD_REMINDER - - CLICK - - COMMENT - - DELETE - - DISMISS - - EDIT - - MENTION - - MOVE - - OTHER - - RESTORE - - UNKNOWN - - VERIFY - - VIEW - description: The action for the activity - aggregateVisitCount: - $ref: "#/components/schemas/CountInfo" - FeedEntry: - required: - - title - properties: - entryId: - type: string - description: optional ID associated with a single feed entry (displayable_list_id) - title: - type: string - description: Title for the result. Can be document title, event title and so on. - thumbnail: - $ref: "#/components/schemas/Thumbnail" - createdBy: - $ref: "#/components/schemas/Person" - uiConfig: - allOf: - - $ref: "#/components/schemas/DisplayableListFormat" - - type: object - properties: - additionalFlags: - $ref: "#/components/schemas/DisplayableListItemUIConfig" - justificationType: - type: string - enum: - - FREQUENTLY_ACCESSED - - RECENTLY_ACCESSED - - TRENDING_DOCUMENT - - VERIFICATION_REMINDER - - SUGGESTED_DOCUMENT - - EMPTY_STATE_SUGGESTION - - FRECENCY_SCORED - - SERVER_GENERATED - - USE_CASE - - UPDATE_SINCE_LAST_VIEW - - RECENTLY_STARTED - - EVENT - - USER_MENTION - - ANNOUNCEMENT - - EXTERNAL_ANNOUNCEMENT - - POPULARITY_BASED_TRENDING - - COMPANY_RESOURCE - - EVENT_DOCUMENT_FROM_CONTENT - - EVENT_DOCUMENT_FROM_SEARCH - - VISIT_AFFINITY_SCORED - - SUGGESTED_APP - - SUGGESTED_PERSON - - ACTIVITY_HIGHLIGHT - - SAVED_SEARCH - - SUGGESTED_CHANNEL - - PEOPLE_CELEBRATIONS - - SOCIAL_LINK - - ZERO_STATE_CHAT_SUGGESTION - - ZERO_STATE_CHAT_TOOL_SUGGESTION - - ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION - - ZERO_STATE_STATIC_WORKFLOW_SUGGESTION - - ZERO_STATE_AGENT_SUGGESTION - - PERSONALIZED_CHAT_SUGGESTION - - DAILY_DIGEST - description: Type of the justification. - justification: - type: string - description: Server side generated justification string if server provides one. - trackingToken: - type: string - description: An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - viewUrl: - type: string - description: View URL for the entry if based on links that are not documents in Glean. - document: - $ref: "#/components/schemas/Document" - event: - $ref: "#/components/schemas/CalendarEvent" - announcement: - $ref: "#/components/schemas/Announcement" - digest: - $ref: "#/components/schemas/Digest" - collection: - $ref: "#/components/schemas/Collection" - collectionItem: - $ref: "#/components/schemas/CollectionItem" - person: - $ref: "#/components/schemas/Person" - app: - $ref: "#/components/schemas/AppResult" - chatSuggestion: - $ref: "#/components/schemas/ChatSuggestion" - promptTemplate: - $ref: "#/components/schemas/PromptTemplateResult" - workflow: - $ref: "#/components/schemas/WorkflowResult" - activities: - type: array - items: - $ref: "#/components/schemas/UserActivity" - description: List of activity where each activity has user, action, timestamp. - documentVisitorCount: - $ref: "#/components/schemas/CountInfo" - FeedResult: - required: - - category - - primaryEntry - properties: - category: - type: string - enum: - - DOCUMENT_SUGGESTION - - DOCUMENT_SUGGESTION_SCENARIO - - TRENDING_DOCUMENT - - USE_CASE - - VERIFICATION_REMINDER - - EVENT - - ANNOUNCEMENT - - MENTION - - DATASOURCE_AFFINITY - - RECENT - - COMPANY_RESOURCE - - EXPERIMENTAL - - PEOPLE_CELEBRATIONS - - SOCIAL_LINK - - EXTERNAL_TASKS - - DISPLAYABLE_LIST - - ZERO_STATE_CHAT_SUGGESTION - - ZERO_STATE_CHAT_TOOL_SUGGESTION - - ZERO_STATE_WORKFLOW_CREATED_BY_ME - - ZERO_STATE_WORKFLOW_FAVORITES - - ZERO_STATE_WORKFLOW_POPULAR - - ZERO_STATE_WORKFLOW_SUGGESTION - - PERSONALIZED_CHAT_SUGGESTION - - DAILY_DIGEST - description: Category of the result, one of the requested categories in incoming request. - primaryEntry: - $ref: "#/components/schemas/FeedEntry" - secondaryEntries: - type: array - items: - $ref: "#/components/schemas/FeedEntry" - description: Secondary entries for the result e.g. suggested docs for the calendar, carousel. - rank: - type: integer - description: Rank of the result. Rank is suggested by server. Client side rank may differ. - FeedResponse: - required: - - serverTimestamp - allOf: - - $ref: "#/components/schemas/BackendExperimentsContext" - - type: object - properties: - trackingToken: - type: string - description: An opaque token that represents this particular feed response. - serverTimestamp: - type: integer - description: Server unix timestamp (in seconds since epoch UTC). - results: - type: array - items: - $ref: "#/components/schemas/FeedResult" - facetResults: - type: object - additionalProperties: - type: array - items: - $ref: "#/components/schemas/FacetResult" - description: Map from category to the list of facets that can be used to filter the entry's content. - mentionsTimeWindowInHours: - type: integer - description: The time window (in hours) used for generating user mentions. - RecommendationsRequestOptions: - properties: - datasourceFilter: - type: string - description: Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - datasourcesFilter: - type: array - items: - type: string - description: Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). All results are returned if missing. - facetFilterSets: - type: array - items: - $ref: "#/components/schemas/FacetFilterSet" - description: A list of facet filter sets that will be OR'ed together. - context: - $ref: "#/components/schemas/Document" - description: Content for either a new or unindexed document, or additional content for an indexed document, which may be used to generate recommendations. - resultProminence: - description: The types of prominence wanted in results returned. Default is any type. - type: array - items: - $ref: "#/components/schemas/SearchResultProminenceEnum" - RecommendationsRequest: - allOf: - - $ref: "#/components/schemas/ResultsRequest" - - type: object - properties: - recommendationDocumentSpec: - $ref: "#/components/schemas/DocumentSpec" - description: Retrieve recommendations for this document. Glean Document ID is preferred over URL. - requestOptions: - $ref: "#/components/schemas/RecommendationsRequestOptions" - description: Options for adjusting the request for recommendations. - RecommendationsResponse: - allOf: - - $ref: "#/components/schemas/ResultsResponse" - SortOptions: - type: object - properties: - orderBy: - type: string - enum: - - ASC - - DESC - sortBy: - type: string - ListEntitiesRequest: - type: object - properties: - filter: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - sort: - description: Use EntitiesSortOrder enum for SortOptions.sortBy - type: array - items: - $ref: "#/components/schemas/SortOptions" - entityType: - type: string - default: PEOPLE - enum: - - PEOPLE - - TEAMS - - CUSTOM_ENTITIES - datasource: - type: string - description: The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES - query: - type: string - description: A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities. - includeFields: - description: List of entity fields to return (that aren't returned by default) - type: array - items: - type: string - enum: - - PEOPLE - - TEAMS - - PEOPLE_DISTANCE - - PERMISSIONS - - FACETS - - INVITE_INFO - - LAST_EXTENSION_USE - - MANAGEMENT_DETAILS - - UNPROCESSED_TEAMS - pageSize: - type: integer - example: 100 - description: Hint to the server about how many results to send back. Server may return less. - cursor: - type: string - description: Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - source: - type: string - description: A string denoting the search surface from which the endpoint is called. - requestType: - type: string - default: STANDARD - description: The type of request being made. - x-enumDescriptions: - STANDARD: Used by default for all requests and satisfies all standard use cases for list requests. Limited to 10000 entities. - FULL_DIRECTORY: Used exclusively to return a comprehensive list of all people entities in the organization, typically for audit like purposes. The recommended approach is to sort by FIRST_NAME or LAST_NAME, and use pagination for large organizations. - enum: - - STANDARD - - FULL_DIRECTORY - EntitiesSortOrder: - type: string - description: Different ways of sorting entities - enum: - - ENTITY_NAME - - FIRST_NAME - - LAST_NAME - - ORG_SIZE_COUNT - - START_DATE - - TEAM_SIZE - - RELEVANCE - ListEntitiesResponse: - type: object - properties: - results: - type: array - items: - $ref: "#/components/schemas/Person" - teamResults: - type: array - items: - $ref: "#/components/schemas/Team" - customEntityResults: - type: array - items: - $ref: "#/components/schemas/CustomEntity" - facetResults: - type: array - items: - $ref: "#/components/schemas/FacetResult" - cursor: - type: string - description: Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. - totalCount: - type: integer - description: The total number of entities available - hasMoreResults: - type: boolean - description: Whether or not more entities can be fetched. - sortOptions: - type: array - description: Sort options from EntitiesSortOrder supported for this response. Default is empty list. - items: - $ref: "#/components/schemas/EntitiesSortOrder" - customFacetNames: - type: array - description: list of Person attributes that are custom setup by deployment - items: - type: string - PeopleRequest: - type: object - properties: - timezoneOffset: - type: integer - description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - obfuscatedIds: - type: array - items: - type: string - description: The Person IDs to retrieve. If no IDs are requested, the current user's details are returned. - emailIds: - type: array - items: - type: string - description: The email IDs to retrieve. The result is the deduplicated union of emailIds and obfuscatedIds. - includeFields: - description: List of PersonMetadata fields to return (that aren't returned by default) - type: array - items: - type: string - enum: - - BADGES - - BUSY_EVENTS - - DOCUMENT_ACTIVITY - - INVITE_INFO - - PEOPLE_DISTANCE - - PERMISSIONS - - PEOPLE_DETAILS - - MANAGEMENT_DETAILS - - PEOPLE_PROFILE_SETTINGS - - PEOPLE_WITHOUT_MANAGER - includeTypes: - description: The types of people entities to include in the response in addition to those returned by default. - x-enumDescriptions: - PEOPLE_WITHOUT_MANAGER: Returns all people without a manager apart from the requested IDs. - INVALID_ENTITIES: Includes invalid entities in the response if any of the requested IDs are invalid. - type: array - items: - type: string - enum: - - PEOPLE_WITHOUT_MANAGER - - INVALID_ENTITIES - source: - type: string - description: A string denoting the search surface from which the endpoint is called. - example: - obfuscatedIds: - - abc123 - - abc456 - PeopleResponse: - properties: - results: - type: array - items: - $ref: "#/components/schemas/Person" - description: A Person for each ID in the request, each with PersonMetadata populated. - relatedDocuments: - type: array - items: - $ref: "#/components/schemas/RelatedDocuments" - description: A list of documents related to this people response. This is only included if DOCUMENT_ACTIVITY is requested and only 1 person is included in the request. - errors: - type: array - items: - type: string - description: A list of IDs that could not be found. - CreateShortcutRequest: - required: - - data - properties: - data: - $ref: "#/components/schemas/ShortcutMutableProperties" - ShortcutError: - properties: - errorType: - type: string - enum: - - NO_PERMISSION - - INVALID_ID - - EXISTING_SHORTCUT - - INVALID_CHARS - CreateShortcutResponse: - properties: - shortcut: - $ref: "#/components/schemas/Shortcut" - error: - $ref: "#/components/schemas/ShortcutError" - DeleteShortcutRequest: - allOf: - - $ref: "#/components/schemas/UserGeneratedContentId" - - type: object - required: - - id - GetShortcutRequest: - oneOf: - - $ref: "#/components/schemas/UserGeneratedContentId" - - type: object - required: - - alias - properties: - alias: - type: string - description: The alias for the shortcut, including any arguments for variable shortcuts. - GetShortcutResponse: - properties: - shortcut: - $ref: "#/components/schemas/Shortcut" - description: Shortcut given the input alias with any provided arguments substituted into the destination URL. - error: - $ref: "#/components/schemas/ShortcutError" - ListShortcutsPaginatedRequest: - required: - - pageSize - properties: - includeFields: - description: Array of fields/data to be included in response that are not included by default - type: array - items: - type: string - enum: - - FACETS - - PEOPLE_DETAILS - pageSize: - type: integer - example: 10 - cursor: - type: string - description: A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination) - filters: - type: array - items: - $ref: "#/components/schemas/FacetFilter" - description: A list of filters for the query. An AND is assumed between different filters. We support filters on Go Link name, author, department and type. - sort: - $ref: "#/components/schemas/SortOptions" - description: Specifies fieldname to sort on and order (ASC|DESC) to sort in - query: - type: string - description: Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts. - ShortcutsPaginationMetadata: - properties: - cursor: - type: string - description: Cursor indicates the start of the next page of results - hasNextPage: - type: boolean - totalItemCount: - type: integer - ListShortcutsPaginatedResponse: - required: - - shortcuts - - meta - properties: - shortcuts: - type: array - items: - $ref: "#/components/schemas/Shortcut" - description: List of all shortcuts accessible to the user - facetResults: - type: array - items: - $ref: "#/components/schemas/FacetResult" - meta: - $ref: "#/components/schemas/ShortcutsPaginationMetadata" - description: Contains metadata like total item count and whether next page exists - UpdateShortcutRequest: - allOf: - - $ref: "#/components/schemas/UserGeneratedContentId" - - $ref: "#/components/schemas/ShortcutMutableProperties" - - type: object - required: - - id - UpdateShortcutResponse: - properties: - shortcut: - $ref: "#/components/schemas/Shortcut" - error: - $ref: "#/components/schemas/ShortcutError" - SummarizeRequest: - description: Summary of the document - required: - - documentSpecs - properties: - timestamp: - type: string - description: The ISO 8601 timestamp associated with the client request. - format: date-time - query: - type: string - description: Optional query that the summary should be about - preferredSummaryLength: - type: integer - description: Optional length of summary output. If not given, defaults to 500 chars. - documentSpecs: - type: array - items: - $ref: "#/components/schemas/DocumentSpec" - description: Specifications of documents to summarize - trackingToken: - type: string - description: An opaque token that represents this particular result. To be used for /feedback reporting. - Summary: - properties: - text: - type: string - followUpPrompts: - type: array - items: - type: string - description: Follow-up prompts based on the summarized doc - SummarizeResponse: - properties: - error: - type: object - properties: - message: - type: string - summary: - $ref: "#/components/schemas/Summary" - trackingToken: - type: string - description: An opaque token that represents this summary in this particular query. To be used for /feedback reporting. - ReminderRequest: - required: - - documentId - properties: - documentId: - type: string - description: The document which the verification is for new reminders and/or update. - assignee: - type: string - description: The obfuscated id of the person this verification is assigned to. - remindInDays: - type: integer - description: Reminder for the next verifications in terms of days. For deletion, this will be omitted. - reason: - type: string - description: An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect"). - VerificationFeed: - properties: - documents: - type: array - items: - $ref: "#/components/schemas/Verification" - description: List of document infos that include verification related information for them. - VerifyRequest: - required: - - documentId - properties: - documentId: - type: string - description: The document which is verified. - action: - type: string - enum: - - VERIFY - - DEPRECATE - - UNVERIFY - description: The verification action requested. - ToolParameter: - type: object - properties: - type: - type: string - description: Parameter type (string, number, boolean, object, array) - enum: - - string - - number - - boolean - - object - - array - name: - type: string - description: The name of the parameter - description: - type: string - description: The description of the parameter - isRequired: - type: boolean - description: Whether the parameter is required - possibleValues: - type: array - description: The possible values for the parameter. Can contain only primitive values or arrays of primitive values. - items: - type: string - items: - type: object - description: When type is 'array', this describes the structure of the item in the array. - $ref: "#/components/schemas/ToolParameter" - properties: - type: object - description: When type is 'object', this describes the structure of the object. - additionalProperties: - $ref: "#/components/schemas/ToolParameter" - Tool: - type: object - properties: - type: - type: string - description: Type of tool (READ, WRITE) - enum: - - READ - - WRITE - name: - type: string - description: Unique identifier for the tool - displayName: - type: string - description: Human-readable name - description: - type: string - description: LLM friendly description of the tool - parameters: - type: object - description: The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - additionalProperties: - $ref: "#/components/schemas/ToolParameter" - ToolsListResponse: - type: object - properties: - tools: - type: array - items: - $ref: "#/components/schemas/Tool" - ToolsCallParameter: - type: object - required: - - name - - value - properties: - name: - type: string - description: The name of the parameter - value: - type: string - description: The value of the parameter (for primitive types) - items: - type: array - description: The value of the parameter (for array types) - items: - $ref: "#/components/schemas/ToolsCallParameter" - properties: - type: object - description: The value of the parameter (for object types) - additionalProperties: - $ref: "#/components/schemas/ToolsCallParameter" - ToolsCallRequest: - type: object - required: - - name - - parameters - properties: - name: - type: string - description: Required name of the tool to execute - parameters: - type: object - description: The parameters for the tool. Each key is the name of the parameter and the value is the parameter object. - additionalProperties: - $ref: "#/components/schemas/ToolsCallParameter" - ToolsCallResponse: - type: object - properties: - rawResponse: - additionalProperties: true - type: object - description: The raw response from the tool - error: - type: string - description: The error message if applicable - IndexDocumentRequest: - type: object - description: Describes the request body of the /indexdocument API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - document: - description: Document being added/updated - $ref: "#/components/schemas/DocumentDefinition" - required: - - document - IndexDocumentsRequest: - type: object - description: Describes the request body of the /indexdocuments API call - properties: - uploadId: - type: string - description: Optional id parameter to identify and track a batch of documents. - datasource: - type: string - description: Datasource of the documents - documents: - description: Batch of documents being added/updated - type: array - items: - $ref: "#/components/schemas/DocumentDefinition" - required: - - documents - - datasource - UpdatePermissionsRequest: - type: object - description: Describes the request body of the /updatepermissions API call - properties: - datasource: - type: string - objectType: - type: string - description: The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - id: - type: string - description: The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - viewURL: - type: string - description: | - The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**' - permissions: - $ref: "#/components/schemas/DocumentPermissionsDefinition" - description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details. - required: - - permissions - - datasource - GetDocumentCountRequest: - type: object - description: Describes the request body of the /getdocumentcount API call - properties: - datasource: - type: string - description: Datasource name for which document count is needed. - required: - - datasource - GetDocumentCountResponse: - type: object - description: Describes the response body of the /getdocumentcount API call - properties: - documentCount: - type: integer - description: Number of documents corresponding to the specified custom datasource. - GetDocumentStatusRequest: - type: object - description: Describes the request body for /getdocumentstatus API call - properties: - datasource: - type: string - description: Datasource to get fetch document status for - objectType: - type: string - description: Object type of the document to get the status for - docId: - type: string - description: Glean Document ID within the datasource to get the status for. - required: - - datasource - - objectType - - docId - GetDocumentStatusResponse: - type: object - description: Describes the response body of the /getdocumentstatus API call - properties: - uploadStatus: - type: string - description: Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - lastUploadedAt: - type: integer - format: int64 - description: Time of last successful upload, in epoch seconds - indexingStatus: - type: string - description: Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - lastIndexedAt: - type: integer - format: int64 - description: Time of last successful indexing, in epoch seconds - BulkIndexRequest: - type: object - description: Describes the request body of a bulk upload API call - required: - - uploadId - properties: - uploadId: - type: string - description: Unique id that must be used for this bulk upload instance - isFirstPage: - type: boolean - description: true if this is the first page of the upload. Defaults to false - isLastPage: - type: boolean - description: true if this is the last page of the upload. Defaults to false - forceRestartUpload: - type: boolean - description: Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - BulkIndexTeamsRequest: - type: object - description: Describes the request body of the /bulkindexteams API call - allOf: - - $ref: "#/components/schemas/BulkIndexRequest" - - type: object - properties: - teams: - description: Batch of team information - type: array - items: - $ref: "#/components/schemas/TeamInfoDefinition" - required: - - teams - BulkIndexEmployeesRequest: - type: object - description: Describes the request body of the /bulkindexemployees API call - allOf: - - $ref: "#/components/schemas/BulkIndexRequest" - - type: object - properties: - employees: - description: Batch of employee information - type: array - items: - $ref: "#/components/schemas/EmployeeInfoDefinition" - disableStaleDataDeletionCheck: - type: boolean - description: True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when `isLastPage = true` - required: - - employees - BulkIndexDocumentsRequest: - type: object - description: Describes the request body of the /bulkindexdocuments API call - allOf: - - $ref: "#/components/schemas/BulkIndexRequest" - - type: object - properties: - datasource: - type: string - description: Datasource of the documents - documents: - description: Batch of documents for the datasource - type: array - items: - $ref: "#/components/schemas/DocumentDefinition" - disableStaleDocumentDeletionCheck: - type: boolean - description: True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when `isLastPage = true` - required: - - datasource - - documents - ProcessAllDocumentsRequest: - type: object - description: Describes the request body of the /processalldocuments API call - properties: - datasource: - type: string - description: If provided, process documents only for this custom datasource. Otherwise all uploaded documents are processed. - DeleteDocumentRequest: - type: object - description: Describes the request body of the /deletedocument API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: datasource of the document - objectType: - type: string - description: object type of the document - id: - type: string - description: The id of the document - required: - - datasource - - id - - objectType - IndexUserRequest: - type: object - description: Describes the request body of the /indexuser API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the user is added - user: - description: The user to be added or updated - $ref: "#/components/schemas/DatasourceUserDefinition" - required: - - datasource - - user - GetUserCountRequest: - type: object - description: Describes the request body of the /getusercount API call - properties: - datasource: - type: string - description: Datasource name for which user count is needed. - required: - - datasource - GetUserCountResponse: - type: object - description: Describes the response body of the /getusercount API call - properties: - userCount: - type: integer - description: Number of users corresponding to the specified custom datasource. - BulkIndexUsersRequest: - type: object - description: Describes the request body for the /bulkindexusers API call - properties: - uploadId: - type: string - description: Unique id that must be used for this instance of datasource users upload - isFirstPage: - type: boolean - description: true if this is the first page of the upload. Defaults to false - isLastPage: - type: boolean - description: true if this is the last page of the upload. Defaults to false - forceRestartUpload: - type: boolean - description: Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - datasource: - type: string - description: datasource of the users - users: - description: batch of users for the datasource - type: array - items: - $ref: "#/components/schemas/DatasourceUserDefinition" - disableStaleDataDeletionCheck: - type: boolean - description: True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - required: - - uploadId - - datasource - - users - GreenlistUsersRequest: - type: object - description: Describes the request body of the /betausers API call - properties: - datasource: - type: string - description: Datasource which needs to be made visible to users specified in the `emails` field. - emails: - type: array - description: The emails of the beta users - items: - type: string - format: email - required: - - datasource - - emails - DatasourceUserDefinition: - type: object - description: describes a user in the datasource - properties: - email: - type: string - userId: - description: To be supplied if the user id in the datasource is not the email - type: string - name: - type: string - isActive: - type: boolean - description: set to false if the user is a former employee or a bot - required: - - email - - name - IndexGroupRequest: - type: object - description: Describes the request body of the /indexgroup API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the group is added - group: - description: The group to be added or updated - $ref: "#/components/schemas/DatasourceGroupDefinition" - required: - - datasource - - group - BulkIndexGroupsRequest: - type: object - description: Describes the request body for the /bulkindexgroups API call - properties: - uploadId: - type: string - description: Unique id that must be used for this instance of datasource groups upload - isFirstPage: - type: boolean - description: true if this is the first page of the upload. Defaults to false - isLastPage: - type: boolean - description: true if this is the last page of the upload. Defaults to false - forceRestartUpload: - type: boolean - description: Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - datasource: - type: string - description: datasource of the groups - groups: - description: batch of groups for the datasource - type: array - items: - $ref: "#/components/schemas/DatasourceGroupDefinition" - disableStaleDataDeletionCheck: - type: boolean - description: True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true` - required: - - uploadId - - datasource - - groups - DatasourceGroupDefinition: - type: object - description: describes a group in the datasource - properties: - name: - type: string - description: name of the group. Should be unique among all groups for the datasource, and cannot have spaces. - required: - - name - IndexMembershipRequest: - type: object - description: Describes the request body of the /indexmembership API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the membership is added - membership: - description: The membership to be added or updated - $ref: "#/components/schemas/DatasourceMembershipDefinition" - required: - - datasource - - membership - BulkIndexMembershipsRequest: - type: object - description: Describes the request body for the /bulkindexmemberships API call - properties: - uploadId: - type: string - description: Unique id that must be used for this instance of datasource group memberships upload - isFirstPage: - type: boolean - description: true if this is the first page of the upload. Defaults to false - isLastPage: - type: boolean - description: true if this is the last page of the upload. Defaults to false - forceRestartUpload: - type: boolean - description: Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true - datasource: - type: string - description: datasource of the memberships - group: - type: string - description: group who's memberships are specified - memberships: - description: batch of memberships for the group - type: array - items: - $ref: "#/components/schemas/DatasourceBulkMembershipDefinition" - required: - - uploadId - - datasource - - memberships - ProcessAllMembershipsRequest: - type: object - description: Describes the request body of the /processallmemberships API call - properties: - datasource: - type: string - description: If provided, process group memberships only for this custom datasource. Otherwise all uploaded memberships are processed. - DatasourceMembershipDefinition: - type: object - description: describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified. - properties: - groupName: - description: The group for which the membership is specified - type: string - memberUserId: - description: If the member is a user, then the email or datasource id for the user - type: string - memberGroupName: - description: If the member is a group, then the name of the member group - type: string - required: - - groupName - DatasourceBulkMembershipDefinition: - type: object - description: describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified. - properties: - memberUserId: - description: If the member is a user, then the email or datasource id for the user - type: string - memberGroupName: - description: If the member is a group, then the name of the member group - type: string - DeleteUserRequest: - type: object - description: Describes the request body of the /deleteuser API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the user is removed - email: - description: The email of the user to be deleted - type: string - required: - - datasource - - email - DeleteGroupRequest: - type: object - description: Describes the request body of the /deletegroup API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the group is removed - groupName: - description: the name of the group to be deleted - type: string - required: - - datasource - - groupName - DeleteMembershipRequest: - type: object - description: Describes the request body of the /deletemembership API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - datasource: - type: string - description: The datasource for which the membership is removed - membership: - description: the name of the membership to be deleted - $ref: "#/components/schemas/DatasourceMembershipDefinition" - required: - - datasource - - membership - DeleteEmployeeRequest: - type: object - description: Describes the request body of the /deleteemployee API call - properties: - version: - type: integer - format: int64 - description: Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done. - employeeEmail: - description: The deleted employee's email - type: string - required: - - employeeEmail - DeleteTeamRequest: - type: object - description: Describes the request body of the /deleteteam API call - properties: - id: - description: The deleted team's id - type: string - required: - - id - DocumentDefinition: - type: object - description: Indexable document structure - properties: - title: - type: string - description: Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. - filename: - type: string - description: Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file. - container: - type: string - description: The container name for the content (Folder for example for file content). - containerDatasourceId: - type: string - description: This represents the datasource sepcific id of the container. - containerObjectType: - type: string - description: This represents the object type of the container. It cannot have spaces or _ - datasource: - type: string - objectType: - type: string - description: The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ - viewURL: - type: string - description: | - The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**' - id: - type: string - description: The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. - summary: - $ref: "#/components/schemas/ContentDefinition" - body: - $ref: "#/components/schemas/ContentDefinition" - author: - $ref: "#/components/schemas/UserReferenceDefinition" - owner: - $ref: "#/components/schemas/UserReferenceDefinition" - description: The current owner of the document, if not the author. - permissions: - $ref: "#/components/schemas/DocumentPermissionsDefinition" - description: The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/indexing/documents/permissions) for more details. - createdAt: - type: integer - format: int64 - description: The creation time, in epoch seconds. - updatedAt: - type: integer - format: int64 - description: The last update time, in epoch seconds. - updatedBy: - $ref: "#/components/schemas/UserReferenceDefinition" - tags: - type: array - items: - type: string - description: Labels associated with the document. - interactions: - $ref: "#/components/schemas/DocumentInteractionsDefinition" - status: - type: string - additionalUrls: - type: array - items: - type: string - description: Additional variations of the URL that this document points to. - comments: - type: array - items: - $ref: "#/components/schemas/CommentDefinition" - description: Comments associated with the document. - customProperties: - type: array - items: - $ref: "#/components/schemas/CustomProperty" - description: Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets). - required: - - datasource - CommentDefinition: - type: object - description: Describes a comment on a document - properties: - id: - type: string - description: The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length. - author: - $ref: "#/components/schemas/UserReferenceDefinition" - description: The author of the comment. - content: - $ref: "#/components/schemas/ContentDefinition" - description: The content of the comment. - createdAt: - type: integer - format: int64 - description: The creation time, in epoch seconds. - updatedAt: - type: integer - format: int64 - description: The last updated time, in epoch seconds. - updatedBy: - $ref: "#/components/schemas/UserReferenceDefinition" - description: The user who last updated the comment. - required: - - id - ContentDefinition: - type: object - description: Describes text content or base64 encoded binary content - properties: - mimeType: - type: string - textContent: - type: string - description: text content. Only one of textContent or binary content can be specified - binaryContent: - type: string - description: base64 encoded binary content. Only one of textContent or binary content can be specified - required: - - mimeType - UserReferenceDefinition: - type: object - description: Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id. - properties: - email: - type: string - datasourceUserId: - type: string - description: some datasources refer to the user by the datasource user id in the document - name: - type: string - PermissionsGroupIntersectionDefinition: - type: object - description: describes a list of groups that are all required in a permissions constraint - properties: - requiredGroups: - type: array - items: - type: string - DocumentPermissionsDefinition: - type: object - description: describes the access control details of the document - properties: - allowedUsers: - description: List of users who can view the document - type: array - items: - $ref: "#/components/schemas/UserReferenceDefinition" - allowedGroups: - description: List of groups that can view the document - type: array - items: - type: string - allowedGroupIntersections: - description: List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ... - type: array - items: - $ref: "#/components/schemas/PermissionsGroupIntersectionDefinition" - allowAnonymousAccess: - description: If true, then any Glean user can view the document - type: boolean - allowAllDatasourceUsersAccess: - description: If true, then any user who has an account in the datasource can view the document. - type: boolean - DocumentInteractionsDefinition: - type: object - description: describes the interactions on the document - properties: - numViews: - type: integer - numLikes: - type: integer - numComments: - type: integer - CheckDocumentAccessRequest: - type: object - description: Describes the request body of the /checkdocumentaccess API call - properties: - datasource: - type: string - description: Datasource of document to check access for. - objectType: - type: string - description: Object type of document to check access for. - docId: - type: string - description: Glean Document ID to check access for. - userEmail: - type: string - description: Email of user to check access for. - required: - - datasource - - objectType - - docId - - userEmail - CheckDocumentAccessResponse: - type: object - description: Describes the response body of the /checkdocumentaccess API call - properties: - hasAccess: - type: boolean - description: If true, user has access to document for search - CustomProperty: - type: object - description: Describes the custom properties of the object. - properties: - name: - type: string - value: - description: Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this. - DatasourceConfig: - $ref: "#/components/schemas/SharedDatasourceConfig" - GetDatasourceConfigRequest: - type: object - description: Describes the request body of the /getdatasourceconfig API call - properties: - datasource: - type: string - description: Datasource name for which config is needed. - required: - - datasource - DatasourceConfigList: - description: List of datasource configurations. - required: - - datasourceConfig - properties: - datasourceConfig: - type: array - description: Datasource configuration. - items: - $ref: "#/components/schemas/SharedDatasourceConfig" - RotateTokenResponse: - description: Describes the response body of the /rotatetoken API call - properties: - rawSecret: - type: string - description: New raw secret - createdAt: - type: integer - format: int64 - description: Unix timestamp in seconds when the new secret value is assigned to the token. The token needs to be rotated before `rotationPeriodMinutes` past the createdAt timestamp otherwise it would be rendered unusable. - rotationPeriodMinutes: - type: integer - format: int64 - description: Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified `rotationPeriodMinutes` after each `/rotatetoken` call, otherwise the tokens would expire. Note that the token would still expire at `expiresAt` timestamp provided during token creation even if the token is being regularly rotated. `rotationPeriodMinutes` property is inherited from the parent token being rotated - IndexEmployeeRequest: - type: object - description: Info about an employee and optional version for that info - properties: - employee: - description: Info about the employee - $ref: "#/components/schemas/EmployeeInfoDefinition" - version: - description: Version number for the employee object. If absent or 0 then no version checks are done - type: integer - format: int64 - required: - - employee - IndexEmployeeListRequest: - type: object - description: Describes the request body of the /indexemployeelist API call - properties: - employees: - description: List of employee info and version. - type: array - items: - $ref: "#/components/schemas/IndexEmployeeRequest" - SocialNetworkDefinition: - type: object - description: Employee's social network profile - properties: - name: - type: string - description: Possible values are "twitter", "linkedin". - profileName: - type: string - description: Human-readable profile name. - profileUrl: - type: string - description: Link to profile. - AdditionalFieldDefinition: - type: object - description: Additional information about the employee or team. - properties: - key: - type: string - description: Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores. - value: - type: array - description: | - List of type string or HypertextField. - - HypertextField is defined as - ``` - { - anchor: string, // Anchor text for the hypertext field. - hyperlink: string, // URL for the hypertext field. - } - ``` - Example: ```{"anchor":"Glean","hyperlink":"https://glean.com"}``` - - When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs. - - **Note**: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored. - Example: ```"languages": [{"lang":"English","lang":"Spanish",...}]```. In this case, the key "lang" will be ignored and can even be passed in as an empty string. - items: - type: object - description: Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs. - HypertextField: - type: object - properties: - anchor: - type: string - description: Anchor text for the hypertext field. - hyperlink: - type: string - description: URL for the hypertext field. - EmployeeInfoDefinition: - type: object - description: Describes employee info - properties: - email: - type: string - description: The employee's email - firstName: - type: string - description: | - The first name of the employee. **Note**: The value cannot be empty - lastName: - type: string - description: | - The last name of the employee. **Note**: The value cannot be empty - preferredName: - type: string - description: The preferred name or nickname of the employee - id: - type: string - description: | - **[Advanced]** A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`. - phoneNumber: - type: string - description: The employee's phone number. - location: - type: string - description: The employee's location (city/office name etc). - deprecated: true - structuredLocation: - description: Detailed location with information about country, state, city etc. - $ref: "#/components/schemas/StructuredLocation" - title: - type: string - description: The employee's role title. - photoUrl: - type: string - format: uri - description: The employee's profile pic - businessUnit: - type: string - description: Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - department: - type: string - description: An organizational unit where everyone has a similar task, e.g. `Engineering`. - datasourceProfiles: - type: array - description: The datasource profiles of the employee, e.g. `Slack`,`Github`. - items: - $ref: "#/components/schemas/DatasourceProfile" - teams: - type: array - description: Info about the employee's team(s) - items: - $ref: "#/components/schemas/EmployeeTeamInfo" - startDate: - type: string - format: date - description: The date when the employee started - endDate: - type: string - format: date - description: If a former employee, the last date of employment. - bio: - type: string - description: Short biography or mission statement of the employee. - pronoun: - type: string - description: She/her, He/his or other pronoun. - alsoKnownAs: - type: array - description: Other names associated with the employee. - items: - type: string - profileUrl: - type: string - description: Link to internal company person profile. - socialNetworks: - type: array - description: List of social network profiles. - items: - $ref: "#/components/schemas/SocialNetworkDefinition" - managerEmail: - type: string - description: The email of the employee's manager - managerId: - type: string - description: | - **[Advanced]** A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`. - type: - type: string - description: The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE` - default: FULL_TIME - relationships: - type: array - description: List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile. - items: - $ref: "#/components/schemas/EntityRelationship" - status: - type: string - description: The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` - default: CURRENT - additionalFields: - type: array - description: List of additional fields with more information about the employee. - items: - $ref: "#/components/schemas/AdditionalFieldDefinition" - required: - - department - - email - EmployeeAndVersionDefinition: - type: object - description: describes info about an employee and optional version for that info - properties: - employee: - description: Info about the employee - $ref: "#/components/schemas/EmployeeInfoDefinition" - version: - description: Version number for the employee object. If absent or 0 then no version checks are done - type: integer - format: int64 - required: - - info - EmployeeTeamInfo: - type: object - description: Information about which team an employee belongs to - properties: - id: - type: string - description: unique identifier for this team - name: - type: string - description: Team name - url: - type: string - format: uri - description: Link to internal company team page - EntityRelationship: - type: object - description: Describes a relationship edge between a source and destination entity - required: - - name - - email - properties: - name: - type: string - description: The title or type of relationship. Currently an enum of `CHIEF_OF_STAFF`, `EXECUTIVE_ASSISTANT` - email: - type: string - description: Email of the person with whom the relationship exists. Per the example above, either `B` or `C`'s email depending on the relationship. - TeamMember: - type: object - description: Information about a team's member - properties: - email: - type: string - description: The member's email - format: email - relationship: - type: string - description: The member's relationship to the team, an enum of `MEMBER`, `MANAGER`, `LEAD`, `POINT_OF_CONTACT`, `OTHER` - default: MEMBER - join_date: - type: string - format: date - description: The member's start date - required: - - email - TeamInfoDefinition: - type: object - description: Information about an employee's team - properties: - id: - type: string - description: The unique ID of the team - name: - type: string - description: Human-readable team name - description: - type: string - description: The description of this team - businessUnit: - type: string - description: Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - department: - type: string - description: An organizational unit where everyone has a similar task, e.g. `Engineering`. - photoUrl: - type: string - format: uri - description: A link to the team's photo - externalLink: - type: string - format: uri - description: | - A link to an external team page. If set, team results will link to it. - emails: - type: array - description: The emails of the team - items: - $ref: "#/components/schemas/TeamEmail" - datasourceProfiles: - type: array - description: The datasource profiles of the team, e.g. `Slack`,`Github`. - items: - $ref: "#/components/schemas/DatasourceProfile" - members: - type: array - description: The members of the team - items: - $ref: "#/components/schemas/TeamMember" - additionalFields: - type: array - description: List of additional fields with more information about the team. - items: - $ref: "#/components/schemas/AdditionalFieldDefinition" - required: - - id - - members - - name - IndexTeamRequest: - type: object - description: Info about a team and optional version for that info - properties: - team: - description: Info about the team - $ref: "#/components/schemas/TeamInfoDefinition" - version: - description: Version number for the team object. If absent or 0 then no version checks are done - type: integer - format: int64 - required: - - team - BulkIndexShortcutsRequest: - type: object - description: Describes the request body of the /bulkindexshortcuts API call - allOf: - - $ref: "#/components/schemas/BulkIndexRequest" - - type: object - properties: - shortcuts: - description: Batch of shortcuts information - type: array - items: - $ref: "#/components/schemas/ExternalShortcut" - required: - - shortcuts - UploadShortcutsRequest: - type: object - description: Describes the request body of the /uploadshortcuts API call - allOf: - - $ref: "#/components/schemas/BulkIndexRequest" - - type: object - properties: - shortcuts: - description: Batch of shortcuts information - type: array - items: - $ref: "#/components/schemas/IndexingShortcut" - required: - - shortcuts - DebugDatasourceStatusResponse: - type: object - description: Describes the response body of the /debug/{datasource}/status API call - properties: - documents: - type: object - properties: - bulkUploadHistory: - type: object - $ref: "#/components/schemas/BulkUploadHistoryEventList" - counts: - type: object - properties: - uploaded: - type: array - items: - $ref: "#/components/schemas/DatasourceObjectTypeDocumentCountEntry" - description: A list of object types and corresponding upload counts - indexed: - type: array - description: The number of documents indexed, grouped by objectType - items: - $ref: "#/components/schemas/DatasourceObjectTypeDocumentCountEntry" - processingHistory: - $ref: "#/components/schemas/ProcessingHistoryEventList" - identity: - type: object - properties: - processingHistory: - $ref: "#/components/schemas/ProcessingHistoryEventList" - users: - $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent" - groups: - $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent" - memberships: - $ref: "#/components/schemas/DebugDatasourceStatusIdentityResponseComponent" - datasourceVisibility: - type: string - description: The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE - enum: - - ENABLED_FOR_ALL - - ENABLED_FOR_TEST_GROUP - - NOT_ENABLED - example: ENABLED_FOR_ALL - DebugDatasourceStatusIdentityResponseComponent: - type: object - properties: - bulkUploadHistory: - type: object - $ref: "#/components/schemas/BulkUploadHistoryEventList" - counts: - type: object - properties: - uploaded: - type: integer - description: The number of users/groups/memberships uploaded - example: 15 - DatasourceObjectTypeDocumentCountEntry: - type: object - properties: - objectType: - type: string - description: The object type of the document - example: Article - count: - type: integer - description: The number of documents of the corresponding objectType - example: 15 - BulkUploadHistoryEvent: - type: object - description: Information about a successful bulk upload - properties: - uploadId: - type: string - description: The unique ID of the upload - example: upload-id-content-1707403081 - startTime: - type: string - description: The start time of the upload in ISO 8601 format - example: "2021-08-06T17:58:01.000Z" - endTime: - type: string - description: The end time of the upload in ISO 8601 format, 'NA' if the upload is still active - example: "2021-08-06T18:58:01.000Z" - status: - type: string - description: The status of the upload, an enum of ACTIVE, SUCCESSFUL - enum: - - ACTIVE - - SUCCESSFUL - example: SUCCESSFUL - processingState: - type: string - description: The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED - enum: - - UNAVAILABLE - - UPLOAD STARTED - - UPLOAD IN PROGRESS - - UPLOAD COMPLETED - - DELETION PAUSED - - INDEXING COMPLETED - example: UPLOAD COMPLETED - BulkUploadHistoryEventList: - description: Information about active and recent successful uploads for the datasource - type: array - items: - $ref: "#/components/schemas/BulkUploadHistoryEvent" - DebugDocumentRequest: - type: object - description: Describes the request body of the /debug/{datasource}/document API call. - properties: - objectType: - type: string - description: Object type of the document to get the status for. - example: Article - docId: - type: string - description: Glean Document ID within the datasource to get the status for. - example: art123 - required: - - objectType - - docId - DebugDocumentResponse: - type: object - description: Describes the response body of the /debug/{datasource}/document API call - properties: - status: - type: object - description: Upload and indexing status of the document - $ref: "#/components/schemas/DocumentStatusResponse" - uploadedPermissions: - $ref: "#/components/schemas/DocumentPermissionsDefinition" - DebugDocumentsRequest: - type: object - description: Describes the request body of the /debug/{datasource}/documents API call. - properties: - debugDocuments: - type: array - description: Documents to fetch debug information for - items: - $ref: "#/components/schemas/DebugDocumentRequest" - required: - - debugDocuments - DebugDocumentsResponseItem: - type: object - description: Describes the response body of a single document in the /debug/{datasource}/documents API call - properties: - docId: - type: string - description: Id of the document - objectType: - type: string - description: objectType of the document - debugInfo: - type: object - description: Debug information of the document - $ref: "#/components/schemas/DebugDocumentResponse" - DebugDocumentsResponse: - type: object - description: Describes the response body of a single document in the /debug/{datasource}/documents API call - properties: - documentStatuses: - type: array - description: List of document ids/urls and their debug information - items: - $ref: "#/components/schemas/DebugDocumentsResponseItem" - DocumentStatusResponse: - type: object - description: Describes the document status response body - properties: - uploadStatus: - type: string - description: Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - example: UPLOADED - lastUploadedAt: - type: string - description: Time of last successful upload for the document, in ISO 8601 format - example: "2021-08-06T17:58:01.000Z" - indexingStatus: - type: string - description: Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN - example: INDEXED - lastIndexedAt: - type: string - description: Time of last successful indexing for the document, in ISO 8601 format - example: "2021-08-06T17:58:01.000Z" - permissionIdentityStatus: - type: string - description: Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`. - example: UPLOADED - LifeCycleEvent: - type: object - properties: - event: - type: string - description: Type of event - enum: - - UPLOADED - - INDEXED - - DELETION_REQUESTED - - DELETED - example: INDEXED - timestamp: - type: string - description: Timestamp of the event - example: "2021-08-06T17:58:01.000Z" - ProcessingHistoryEvent: - type: object - description: Processing history event for a datasource - properties: - startTime: - type: string - description: The start time of the processing in ISO 8601 format - example: "2021-08-06T17:58:01.000Z" - endTime: - type: string - description: The end time of the processing in ISO 8601 format, 'NA' if still in progress - example: "2021-08-06T18:58:01.000Z" - ProcessingHistoryEventList: - description: Information about processing history for the datasource - type: array - items: - $ref: "#/components/schemas/ProcessingHistoryEvent" - DebugUserRequest: - type: object - description: Describes the request body of the /debug/{datasource}/user API call - properties: - email: - type: string - description: Email ID of the user to get the status for - example: u1@foo.com - required: - - email - DebugUserResponse: - type: object - description: Describes the response body of the /debug/{datasource}/user API call - properties: - status: - type: object - description: Upload and indexing status of the user - $ref: "#/components/schemas/UserStatusResponse" - uploadedGroups: - type: array - description: List of groups the user is a member of, as uploaded via permissions API. - items: - $ref: "#/components/schemas/DatasourceGroupDefinition" - UserStatusResponse: - type: object - description: Describes the user status response body - properties: - isActiveUser: - type: boolean - description: Whether the user is active or not - example: true - uploadStatus: - $ref: "#/components/schemas/UploadStatusEnum" - lastUploadedAt: - type: string - description: Time of last successful upload for the user, in ISO 8601 format - example: "2021-08-06T17:58:01.000Z" - UploadStatusEnum: - type: string - description: Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN - enum: - - UPLOADED - - NOT_UPLOADED - - STATUS_UNKNOWN - example: UPLOADED - PropertyDefinition: - properties: - name: - type: string - description: The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. - displayLabel: - type: string - description: The user friendly label for the property. - displayLabelPlural: - type: string - description: The user friendly label for the property that will be used if a plural context. - propertyType: - type: string - enum: - - TEXT - - DATE - - INT - - USERID - - PICKLIST - - TEXTLIST - - MULTIPICKLIST - description: The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. - uiOptions: - type: string - enum: - - NONE - - SEARCH_RESULT - - DOC_HOVERCARD - hideUiFacet: - type: boolean - description: If true then the property will not show up as a facet in the UI. - uiFacetOrder: - type: integer - description: Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. - skipIndexing: - type: boolean - description: If true then the property will not be indexed for retrieval and ranking. - group: - type: string - description: The unique identifier of the `PropertyGroup` to which this property belongs. - PropertyGroup: - description: A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI. - properties: - name: - type: string - description: The unique identifier of the group. - displayLabel: - type: string - description: The user-friendly group label to display. - ObjectDefinition: - description: The definition for an `DocumentMetadata.objectType` within a datasource. - properties: - name: - type: string - description: Unique identifier for this `DocumentMetadata.objectType`. If omitted, this definition is used as a default for all unmatched `DocumentMetadata.objectType`s in this datasource. - displayLabel: - type: string - description: The user-friendly name of the object for display. - docCategory: - type: string - enum: - - UNCATEGORIZED - - TICKETS - - CRM - - PUBLISHED_CONTENT - - COLLABORATIVE_CONTENT - - QUESTION_ANSWER - - MESSAGING - - CODE_REPOSITORY - - CHANGE_MANAGEMENT - - PEOPLE - - EMAIL - - SSO - - ATS - - KNOWLEDGE_HUB - - EXTERNAL_SHORTCUT - - ENTITY - - CALENDAR - - AGENTS - description: The document category of this object type. - propertyDefinitions: - type: array - items: - $ref: "#/components/schemas/PropertyDefinition" - propertyGroups: - type: array - description: A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI. - items: - $ref: "#/components/schemas/PropertyGroup" - summarizable: - description: Whether or not the object is summarizable - type: boolean - CanonicalizingRegexType: - description: Regular expression to apply to an arbitrary string to transform it into a canonical string. - properties: - matchRegex: - type: string - description: Regular expression to match to an arbitrary string. - rewriteRegex: - type: string - description: Regular expression to transform into a canonical string. - SharedDatasourceConfigNoInstance: - type: object - description: Structure describing shared config properties of a datasource with no multi-instance support. - required: - - name - properties: - name: - type: string - description: Unique identifier of datasource instance to which this config applies. - displayName: - type: string - description: The user-friendly instance label to display. If omitted, falls back to the title-cased `name`. - datasourceCategory: - type: string - enum: - - UNCATEGORIZED - - TICKETS - - CRM - - PUBLISHED_CONTENT - - COLLABORATIVE_CONTENT - - QUESTION_ANSWER - - MESSAGING - - CODE_REPOSITORY - - CHANGE_MANAGEMENT - - PEOPLE - - EMAIL - - SSO - - ATS - - KNOWLEDGE_HUB - - EXTERNAL_SHORTCUT - - ENTITY - - CALENDAR - - AGENTS - default: UNCATEGORIZED - description: The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. - urlRegex: - type: string - description: "Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.**" - example: https://example-company.datasource.com/.* - iconUrl: - type: string - description: The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - objectDefinitions: - type: array - description: The list of top-level `objectType`s for the datasource. - items: - $ref: "#/components/schemas/ObjectDefinition" - suggestionText: - type: string - description: Example text for what to search for in this datasource - homeUrl: - type: string - description: The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page. - crawlerSeedUrls: - type: array - description: This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling. - items: - type: string - iconDarkUrl: - type: string - description: The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - hideBuiltInFacets: - type: array - description: List of built-in facet types that should be hidden for the datasource. - items: - type: string - enum: - - TYPE - - TAG - - AUTHOR - - OWNER - canonicalizingURLRegex: - type: array - description: A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. - items: - $ref: "#/components/schemas/CanonicalizingRegexType" - canonicalizingTitleRegex: - type: array - description: A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results - items: - $ref: "#/components/schemas/CanonicalizingRegexType" - redlistTitleRegex: - type: string - description: A regex that identifies titles that should not be indexed - connectorType: - allOf: - - $ref: "#/components/schemas/ConnectorType" - type: string - quicklinks: - type: array - description: List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira - items: - $ref: "#/components/schemas/Quicklink" - renderConfigPreset: - type: string - description: The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details - aliases: - type: array - description: Aliases that can be used as `app` operator-values. - items: - type: string - isOnPrem: - type: boolean - description: Whether or not this datasource is hosted on-premise. - trustUrlRegexForViewActivity: - type: boolean - default: true - description: True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load. - includeUtmSource: - type: boolean - description: If true, a utm_source query param will be added to outbound links to this datasource within Glean. - stripFragmentInCanonicalUrl: - type: boolean - default: true - description: If true, the fragment part of the URL will be stripped when converting to a canonical url. - CustomDatasourceConfig: - description: Structure describing config properties of a custom datasource - allOf: - - $ref: "#/components/schemas/SharedDatasourceConfigNoInstance" - - type: object - properties: - identityDatasourceName: - type: string - description: If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already. - productAccessGroup: - type: string - description: If the datasource uses a specific product access group, then the name of that group. - isUserReferencedByEmail: - type: boolean - description: whether email is used to reference users in document ACLs and in group memberships. - isEntityDatasource: - type: boolean - default: false - description: True if this datasource is used to push custom entities. - isTestDatasource: - type: boolean - default: false - description: True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings. - ShortcutProperties: - properties: - inputAlias: - type: string - description: link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias. - description: - type: string - description: A short, plain text blurb to help people understand the intent of the shortcut. - destinationUrl: - type: string - format: url - description: destination URL for the shortcut. - createdBy: - type: string - description: Email of the user who created this shortcut. - createTime: - type: integer - format: int64 - description: The time the shortcut was created in epoch seconds. - updatedBy: - type: string - description: Email of the user who last updated this shortcut. - updateTime: - type: integer - format: int64 - description: The time the shortcut was updated in epoch seconds. - ExternalShortcut: - allOf: - - $ref: "#/components/schemas/ShortcutProperties" - - type: object - required: - - destinationUrl - - intermediateUrl - - createdBy - - inputAlias - properties: - title: - type: string - description: Title of the golink - intermediateUrl: - type: string - format: url - description: The URL from which the user is then redirected to the destination URL. - decayedVisitScore: - type: number - format: double - description: decayed visits score for ranking - editUrl: - type: string - format: url - description: The URL using which the user can access the edit page of the shortcut. - SharedDatasourceConfig: - description: Structure describing shared config properties of the datasource (including multi-instance support) - allOf: - - $ref: "#/components/schemas/SharedDatasourceConfigNoInstance" - - type: object - properties: - datasourceName: - type: string - description: The (non-unique) name of the datasource of which this config is an instance, e.g. "jira". - instanceOnlyName: - type: string - description: The instance of the datasource for this particular config, e.g. "onprem". - instanceDescription: - type: string - description: A human readable string identifying this instance as compared to its peers, e.g. "github.com/askscio" or "github.askscio.com" - IndexingShortcut: - allOf: - - $ref: "#/components/schemas/ShortcutProperties" - - type: object - required: - - destinationUrl - - createdBy - - inputAlias - properties: - unlisted: - type: boolean - description: Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author and admins only. - urlTemplate: - type: string - description: For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - SensitiveInfoType: - properties: - likelihoodThreshold: - deprecated: true - type: string - enum: - - LIKELY - - VERY_LIKELY - infoType: - description: Text representation of an info-type to scan for. - type: string - TimeRange: - properties: - startTime: - type: string - description: start time of the time range, applicable for the CUSTOM type. - format: date-time - endTime: - type: string - description: end time of the time range, applicable for the CUSTOM type. - format: date-time - lastNDaysValue: - type: integer - description: The number of days to look back from the current time, applicable for the LAST_N_DAYS type. - format: int64 - InputOptions: - description: Controls which data-sources and what time-range to include in scans. - properties: - urlGreenlist: - deprecated: true - type: array - description: list of url regex matching documents excluded from report - items: - type: string - datasourcesType: - type: string - description: The types of datasource for which to run the report/policy. - enum: - - ALL - - CUSTOM - datasources: - deprecated: true - type: array - description: List of datasources to consider for report. DEPRECATED - use datasourceInstances instead. - items: - type: string - datasourceInstances: - type: array - description: List of datasource instances to consider for report/policy. - items: - type: string - timePeriodType: - type: string - description: Type of time period for which to run the report/policy. PAST_DAY is deprecated. - enum: - - ALL_TIME - - PAST_YEAR - - PAST_DAY - - CUSTOM - - LAST_N_DAYS - customTimeRange: - $ref: "#/components/schemas/TimeRange" - SharingOptions: - description: Controls how "shared" a document must be to get picked for scans. - properties: - enabled: - deprecated: true - type: boolean - threshold: - description: The minimum number of users the document is shared with. - type: integer - thresholdEnabled: - description: Documents will be filtered based on how many people have access to it. - type: boolean - anyoneWithLinkEnabled: - deprecated: true - type: boolean - anyoneInternalEnabled: - description: Only users within the organization can access the document. - type: boolean - anonymousAccessEnabled: - description: Anyone on the internet can access the document. - type: boolean - userAccessEnabled: - description: Enable user access check - type: boolean - userIds: - type: array - description: Any one of the specified users can access the document. - items: - type: string - ExternalSharingOptions: - deprecated: true - allOf: - - description: DEPRECATED - use `broadSharingOptions` instead. - - $ref: "#/components/schemas/SharingOptions" - - type: object - properties: - domainAccessEnabled: - type: boolean - HotwordProximity: - properties: - windowBefore: - type: integer - windowAfter: - type: integer - Hotword: - properties: - regex: - type: string - proximity: - $ref: "#/components/schemas/HotwordProximity" - SensitiveExpression: - properties: - expression: - description: Sensitive word, phrase, or regular expression. - type: string - hotwords: - description: Zero to three proximate regular expressions necessary to consider an expression as sensitive content. - type: array - items: - $ref: "#/components/schemas/Hotword" - SensitiveContentOptions: - description: Options for defining sensitive content within scanned documents. - properties: - sensitiveInfoTypes: - description: Predefined categories of terms to consider as sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available types. - type: array - items: - $ref: "#/components/schemas/SensitiveInfoType" - sensitiveTerms: - description: list of words and phrases to consider as sensitive content - type: array - items: - $ref: "#/components/schemas/SensitiveExpression" - sensitiveRegexes: - description: list of regular expressions to consider as sensitive content - type: array - items: - $ref: "#/components/schemas/SensitiveExpression" - DlpPersonMetadata: - properties: - firstName: - type: string - description: The first name of the person - email: - type: string - description: The user's primary email address - DlpPerson: - description: Details about the person who created this report/policy. - required: - - name - - obfuscatedId - properties: - name: - type: string - description: The display name. - obfuscatedId: - type: string - description: An opaque identifier that can be used to request metadata for a Person. - metadata: - $ref: "#/components/schemas/DlpPersonMetadata" - AllowlistOptions: - description: Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation. - properties: - terms: - type: array - description: list of words and phrases to consider as whitelisted content - items: - type: string - DlpConfig: - description: Detailed configuration of what documents and sensitive content will be scanned. - properties: - version: - description: Synonymous with report/policy id. - type: integer - format: int64 - sensitiveInfoTypes: - deprecated: true - description: DEPRECATED - use `sensitiveContentOptions` instead. - type: array - items: - $ref: "#/components/schemas/SensitiveInfoType" - inputOptions: - description: Options for documents to include or exclude in a report - $ref: "#/components/schemas/InputOptions" - externalSharingOptions: - deprecated: true - description: DEPRECATED - use `broadSharingOptions` instead. - $ref: "#/components/schemas/ExternalSharingOptions" - broadSharingOptions: - description: Options for defining documents to scan for sensitive content. - $ref: "#/components/schemas/SharingOptions" - sensitiveContentOptions: - description: Options for defining sensitive content within scanned documents. - $ref: "#/components/schemas/SensitiveContentOptions" - reportName: - type: string - frequency: - description: Interval between scans. - type: string - createdBy: - description: Person who created this report/policy. - $ref: "#/components/schemas/DlpPerson" - createdAt: - description: Timestamp at which this configuration was created. - type: string - format: iso-date-time - redactQuote: - description: redact quote in findings of the report - type: boolean - autoHideDocs: - description: auto hide documents with findings in the report - type: boolean - allowlistOptions: - description: Options for defining whitelisting content within scanned documents - $ref: "#/components/schemas/AllowlistOptions" - DlpFrequency: - type: string - description: Interval between scans. DAILY is deprecated. - x-include-enum-class-prefix: true - enum: - - ONCE - - DAILY - - WEEKLY - - CONTINUOUS - - NONE - DlpReportStatus: - type: string - description: The status of the policy/report. Only ACTIVE status will be picked for scans. - x-include-enum-class-prefix: true - enum: - - ACTIVE - - INACTIVE - - CANCELLED - - NONE - DlpReport: - description: Full policy information that will be used for scans. - properties: - id: - type: string - name: - type: string - config: - description: All details of the policy that is needed for a scan. - $ref: "#/components/schemas/DlpConfig" - frequency: - description: The interval between scans. - $ref: "#/components/schemas/DlpFrequency" - status: - description: The status of the policy. - $ref: "#/components/schemas/DlpReportStatus" - createdBy: - description: Person who created this report. - $ref: "#/components/schemas/DlpPerson" - createdAt: - description: Timestamp at which the policy was created. - type: string - format: iso-date-time - lastUpdatedAt: - description: Timestamp at which the policy was last updated. - type: string - format: iso-date-time - autoHideDocs: - description: Auto hide documents with findings in the policy. - type: boolean - lastScanStatus: - type: string - enum: - - PENDING - - SUCCESS - - FAILURE - - CANCELLED - - CANCELLING - - ACTIVE - lastScanStartTime: - description: The timestamp at which the report's last run/scan began. - type: string - format: iso-date-time - updatedBy: - description: Person who last updated this report. - $ref: "#/components/schemas/DlpPerson" - GetDlpReportResponse: - properties: - report: - $ref: "#/components/schemas/DlpReport" - UpdateDlpReportRequest: - properties: - config: - description: The new configuration the policy will follow if provided. - $ref: "#/components/schemas/DlpConfig" - frequency: - description: The new frequency the policy will follow if provided. - $ref: "#/components/schemas/DlpFrequency" - status: - description: The new status the policy will be updated to if provided. - $ref: "#/components/schemas/DlpReportStatus" - autoHideDocs: - description: The new autoHideDoc boolean the policy will be updated to if provided. - type: boolean - reportName: - description: The new name of the policy if provided. - type: string - DlpSimpleResult: - type: string - enum: - - SUCCESS - - FAILURE - UpdateDlpReportResponse: - properties: - result: - $ref: "#/components/schemas/DlpSimpleResult" - ListDlpReportsResponse: - properties: - reports: - type: array - items: - $ref: "#/components/schemas/DlpReport" - CreateDlpReportRequest: - properties: - name: - description: Name of the policy being created. - type: string - config: - description: Details on the configuration used in the scans. - $ref: "#/components/schemas/DlpConfig" - frequency: - description: Interval between scans. - $ref: "#/components/schemas/DlpFrequency" - autoHideDocs: - description: Controls whether the policy should hide documents with violations. - type: boolean - CreateDlpReportResponse: - properties: - report: - $ref: "#/components/schemas/DlpReport" - UpdateDlpConfigRequest: - properties: - config: - $ref: "#/components/schemas/DlpConfig" - frequency: - description: Only "ONCE" is supported for reports. - type: string - UpdateDlpConfigResponse: - properties: - result: - $ref: "#/components/schemas/DlpSimpleResult" - reportId: - description: The id of the report that was just created and run. - type: string - ReportStatusResponse: - properties: - status: - type: string - enum: - - PENDING - - SUCCESS - - FAILURE - - CANCELLED - - CANCELLING - - ACTIVE - startTime: - description: The timestamp at which the report's run/scan began. - type: string - format: iso-date-time - DocumentVisibilityOverride: - properties: - docId: - type: string - override: - description: The visibility-override state of the document. - type: string - enum: - - NONE - - HIDE_FROM_ALL - - HIDE_FROM_GROUPS - - HIDE_FROM_ALL_EXCEPT_OWNER - GetDocumentVisibilityOverridesResponse: - properties: - visibilityOverrides: - type: array - items: - $ref: "#/components/schemas/DocumentVisibilityOverride" - UpdateDocumentVisibilityOverridesRequest: - properties: - visibilityOverrides: - type: array - items: - $ref: "#/components/schemas/DocumentVisibilityOverride" - DocumentVisibilityUpdateResult: - allOf: - - $ref: "#/components/schemas/DocumentVisibilityOverride" - - type: object - properties: - success: - description: Whether this document was successfully set to its desired visibility state. - type: boolean - UpdateDocumentVisibilityOverridesResponse: - properties: - results: - description: The documents and whether their visibility was successfully updated. - type: array - items: - $ref: "#/components/schemas/DocumentVisibilityUpdateResult" - ChatRequestStream: - required: - - messages - properties: - saveChat: - type: boolean - description: >- - Save the current interaction as a Chat for the user to access and potentially continue later. - chatId: - type: string - description: >- - The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true. - messages: - type: array - description: >- - A list of chat messages, from most recent to least recent. It can be assumed that the first chat message in the list is the user's most recent query. - items: - $ref: '#/components/schemas/ChatMessage' - agentConfig: - $ref: '#/components/schemas/AgentConfig' - description: Describes the agent that will execute the request. - inclusions: - $ref: '#/components/schemas/ChatRestrictionFilters' - description: >- - A list of filters which only allows chat to access certain content. - exclusions: - $ref: '#/components/schemas/ChatRestrictionFilters' - description: >- - A list of filters which disallows chat from accessing certain content. If content is in both inclusions and exclusions, it'll be excluded. - timeoutMillis: - type: integer - description: >- - Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - example: 30000 - applicationId: - type: string - description: >- - The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used. - stream: - type: boolean - description: >- - If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be. - default: true - parameters: - timezoneOffset: - name: timezoneOffset - in: query - description: The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - schema: - type: integer -x-tagGroups: - - name: Search & Generative AI - tags: - - Chat - - Search - - Summarize - - Tools - - name: Connected Content - tags: - - Calendar - - Documents - - Entities - - Messages - - name: User Generated Content - tags: - - Announcements - - Answers - - Collections - - Displayable Lists - - Images - - Pins - - Shortcuts - - Verification - - name: General - tags: - - Activity - - Authentication - - Insights - - User -tags: - - name: Datasources - description: Manage datasources. - - name: Documents - description: Index documents from a datasource. - - name: People - description: Index employee people data. - - name: Permissions - description: Manage users, groups and membership. - - name: Authentication - description: Manage indexing API tokens. diff --git a/examples/specs/mistral.yaml b/examples/specs/mistral.yaml deleted file mode 100644 index 52edfc1b2..000000000 --- a/examples/specs/mistral.yaml +++ /dev/null @@ -1,7938 +0,0 @@ -openapi: 3.1.0 -info: - title: Mistral AI API - description: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. - version: 1.0.0 -paths: - /v1/models: - get: - summary: List Models - description: List all models available to the user. - operationId: list_models_v1_models_get - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ModelList" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - models - /v1/models/{model_id}: - get: - summary: Retrieve Model - description: Retrieve information about a model. - operationId: retrieve_model_v1_models__model_id__get - x-codeSamples: - - lang: "cURL" - label: "My Example" - source: | - curl --request GET \ - --url 'https://api.mistral.ai/v1/models/{model_id}' \ - parameters: - - name: model_id - in: path - required: true - schema: - type: string - title: Model Id - example: ft:open-mistral-7b:587a6b29:20240514:7e773925 - description: The ID of the model to retrieve. - responses: - "200": - description: Successful Response - content: - application/json: - schema: - oneOf: - - $ref: "#/components/schemas/BaseModelCard" - - $ref: "#/components/schemas/FTModelCard" - discriminator: - propertyName: type - mapping: - base: "#/components/schemas/BaseModelCard" - fine-tuned: "#/components/schemas/FTModelCard" - title: Response Retrieve Model V1 Models Model Id Get - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - models - delete: - summary: Delete Model - description: Delete a fine-tuned model. - operationId: delete_model_v1_models__model_id__delete - parameters: - - name: model_id - in: path - required: true - schema: - type: string - title: Model Id - example: ft:open-mistral-7b:587a6b29:20240514:7e773925 - description: The ID of the model to delete. - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteModelOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - models - /v1/conversations: - post: - summary: Create a conversation and append entries to it. - description: Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - operationId: agents_api_v1_conversations_start - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationRequest" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - get: - summary: List all created conversations. - description: Retrieve a list of conversation entities sorted by creation time. - operationId: agents_api_v1_conversations_list - parameters: - - name: page - in: query - required: false - schema: - type: integer - default: 0 - title: Page - - name: page_size - in: query - required: false - schema: - type: integer - default: 100 - title: Page Size - responses: - "200": - description: Successful Response - content: - application/json: - schema: - type: array - items: - anyOf: - - $ref: "#/components/schemas/ModelConversation" - - $ref: "#/components/schemas/AgentConversation" - title: Response V1 Conversations List - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}: - get: - summary: Retrieve a conversation information. - description: Given a conversation_id retrieve a conversation entity with its attributes. - operationId: agents_api_v1_conversations_get - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the conversation from which we are fetching metadata. - title: Conversation Id - description: ID of the conversation from which we are fetching metadata. - responses: - "200": - description: Successful Response - content: - application/json: - schema: - anyOf: - - $ref: "#/components/schemas/ModelConversation" - - $ref: "#/components/schemas/AgentConversation" - title: Response V1 Conversations Get - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - post: - summary: Append new entries to an existing conversation. - description: Run completion on the history of the conversation and the user entries. Return the new created entries. - operationId: agents_api_v1_conversations_append - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the conversation to which we append entries. - title: Conversation Id - description: ID of the conversation to which we append entries. - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationAppendRequest" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}/history: - get: - summary: Retrieve all entries in a conversation. - description: Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. - operationId: agents_api_v1_conversations_history - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the conversation from which we are fetching entries. - title: Conversation Id - description: ID of the conversation from which we are fetching entries. - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationHistory" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}/messages: - get: - summary: Retrieve all messages in a conversation. - description: Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. - operationId: agents_api_v1_conversations_messages - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the conversation from which we are fetching messages. - title: Conversation Id - description: ID of the conversation from which we are fetching messages. - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationMessages" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}/restart: - post: - summary: Restart a conversation starting from a given entry. - description: Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - operationId: agents_api_v1_conversations_restart - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the original conversation which is being restarted. - title: Conversation Id - description: ID of the original conversation which is being restarted. - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationRestartRequest" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/agents: - post: - summary: Create a agent that can be used within a conversation. - description: Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. - operationId: agents_api_v1_agents_create - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/AgentCreationRequest" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/Agent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.agents - get: - summary: List agent entities. - description: Retrieve a list of agent entities sorted by creation time. - operationId: agents_api_v1_agents_list - parameters: - - name: page - in: query - required: false - schema: - type: integer - default: 0 - title: Page - - name: page_size - in: query - required: false - schema: - type: integer - default: 20 - title: Page Size - responses: - "200": - description: Successful Response - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Agent" - title: Response V1 Agents List - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.agents - /v1/agents/{agent_id}: - get: - summary: Retrieve an agent entity. - description: Given an agent retrieve an agent entity with its attributes. - operationId: agents_api_v1_agents_get - parameters: - - name: agent_id - in: path - required: true - schema: - type: string - title: Agent Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/Agent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.agents - patch: - summary: Update an agent entity. - description: Update an agent attributes and create a new version. - operationId: agents_api_v1_agents_update - parameters: - - name: agent_id - in: path - required: true - schema: - type: string - title: Agent Id - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/AgentUpdateRequest" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/Agent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.agents - /v1/agents/{agent_id}/version: - patch: - summary: Update an agent version. - description: Switch the version of an agent. - operationId: agents_api_v1_agents_update_version - parameters: - - name: agent_id - in: path - required: true - schema: - type: string - title: Agent Id - - name: version - in: query - required: true - schema: - type: integer - title: Version - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/Agent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.agents - /v1/conversations#stream: - post: - summary: Create a conversation and append entries to it. - description: Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. - operationId: agents_api_v1_conversations_start_stream - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationStreamRequest" - responses: - "200": - description: Successful Response - content: - text/event-stream: - schema: - $ref: "#/components/schemas/ConversationEvents" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}#stream: - post: - summary: Append new entries to an existing conversation. - description: Run completion on the history of the conversation and the user entries. Return the new created entries. - operationId: agents_api_v1_conversations_append_stream - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the conversation to which we append entries. - title: Conversation Id - description: ID of the conversation to which we append entries. - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationAppendStreamRequest" - responses: - "200": - description: Successful Response - content: - text/event-stream: - schema: - $ref: "#/components/schemas/ConversationEvents" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/conversations/{conversation_id}/restart#stream: - post: - summary: Restart a conversation starting from a given entry. - description: Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. - operationId: agents_api_v1_conversations_restart_stream - parameters: - - name: conversation_id - in: path - required: true - schema: - type: string - description: ID of the original conversation which is being restarted. - title: Conversation Id - description: ID of the original conversation which is being restarted. - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/ConversationRestartStreamRequest" - responses: - "200": - description: Successful Response - content: - text/event-stream: - schema: - $ref: "#/components/schemas/ConversationEvents" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.conversations - /v1/files: - post: - operationId: files_api_routes_upload_file - summary: Upload File - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadFileOut" - description: "Upload a file that can be used across various endpoints. - - - The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. - - - Please contact us if you need to increase these storage limits." - requestBody: - content: - multipart/form-data: - schema: - title: MultiPartBodyParams - type: object - properties: - purpose: - $ref: "#/components/schemas/FilePurpose" - file: - $ref: "#/components/schemas/File" - required: - - file - required: true - tags: - - files - get: - operationId: files_api_routes_list_files - summary: List Files - parameters: - - in: query - name: page - schema: - default: 0 - title: Page - type: integer - required: false - - in: query - name: page_size - schema: - default: 100 - title: Page Size - type: integer - required: false - - in: query - name: sample_type - schema: - anyOf: - - items: - $ref: "#/components/schemas/SampleType" - type: array - - type: "null" - title: Sample Type - required: false - - in: query - name: source - schema: - anyOf: - - items: - $ref: "#/components/schemas/Source" - type: array - - type: "null" - title: Source - required: false - - in: query - name: search - schema: - anyOf: - - type: string - - type: "null" - title: Search - required: false - - in: query - name: purpose - schema: - anyOf: - - $ref: "#/components/schemas/FilePurpose" - - type: "null" - required: false - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListFilesOut" - description: Returns a list of files that belong to the user's organization. - tags: - - files - /v1/files/{file_id}: - get: - operationId: files_api_routes_retrieve_file - summary: Retrieve File - parameters: - - in: path - name: file_id - schema: - format: uuid - title: File Id - type: string - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RetrieveFileOut" - description: Returns information about a specific file. - tags: - - files - delete: - operationId: files_api_routes_delete_file - summary: Delete File - parameters: - - in: path - name: file_id - schema: - format: uuid - title: File Id - type: string - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteFileOut" - description: Delete a file. - tags: - - files - /v1/files/{file_id}/content: - get: - operationId: files_api_routes_download_file - summary: Download File - parameters: - - in: path - name: file_id - schema: - format: uuid - title: File Id - type: string - required: true - responses: - "200": - description: OK - content: - application/octet-stream: - schema: - type: string - format: binary - description: Download a file - tags: - - files - /v1/files/{file_id}/url: - get: - operationId: files_api_routes_get_signed_url - summary: Get Signed Url - parameters: - - in: path - name: file_id - schema: - format: uuid - title: File Id - type: string - required: true - - in: query - name: expiry - schema: - default: 24 - description: Number of hours before the url becomes invalid. Defaults to 24h - title: Expiry - type: integer - required: false - description: Number of hours before the url becomes invalid. Defaults to 24h - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/FileSignedURL" - tags: - - files - /v1/fine_tuning/jobs: - get: - operationId: jobs_api_routes_fine_tuning_get_fine_tuning_jobs - summary: Get Fine Tuning Jobs - parameters: - - in: query - name: page - schema: - default: 0 - title: Page - type: integer - required: false - description: The page number of the results to be returned. - - in: query - name: page_size - schema: - default: 100 - title: Page Size - type: integer - required: false - description: The number of items to return per page. - - in: query - name: model - schema: - anyOf: - - type: string - - type: "null" - title: Model - required: false - description: The model name used for fine-tuning to filter on. When set, the other results are not displayed. - - in: query - name: created_after - schema: - anyOf: - - format: date-time - type: string - - type: "null" - title: Created After - required: false - description: The date/time to filter on. When set, the results for previous creation times are not displayed. - - in: query - name: created_before - schema: - anyOf: - - format: date-time - type: string - - type: "null" - title: Created Before - required: false - - in: query - name: created_by_me - schema: - default: false - title: Created By Me - type: boolean - required: false - description: When set, only return results for jobs created by the API caller. Other results are not displayed. - - in: query - name: status - schema: - anyOf: - - enum: - - QUEUED - - STARTED - - VALIDATING - - VALIDATED - - RUNNING - - FAILED_VALIDATION - - FAILED - - SUCCESS - - CANCELLED - - CANCELLATION_REQUESTED - type: string - - type: "null" - title: Status - required: false - description: The current job state to filter on. When set, the other results are not displayed. - - in: query - name: wandb_project - schema: - anyOf: - - type: string - - type: "null" - title: Wandb Project - required: false - description: The Weights and Biases project to filter on. When set, the other results are not displayed. - - in: query - name: wandb_name - schema: - anyOf: - - type: string - - type: "null" - title: Wandb Name - required: false - description: The Weight and Biases run name to filter on. When set, the other results are not displayed. - - in: query - name: suffix - schema: - anyOf: - - type: string - - type: "null" - title: Suffix - required: false - description: The model suffix to filter on. When set, the other results are not displayed. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/JobsOut" - description: Get a list of fine-tuning jobs for your organization and user. - tags: - - fine-tuning - post: - operationId: jobs_api_routes_fine_tuning_create_fine_tuning_job - summary: Create Fine Tuning Job - parameters: - - in: query - name: dry_run - schema: - anyOf: - - type: boolean - - type: "null" - title: Dry Run - required: false - description: "* If `true` the job is not spawned, instead the query returns a handful of useful metadata\n for the user to perform sanity checks (see `LegacyJobMetadataOut` response).\n* Otherwise, the job is started and the query returns the job ID along with some of the\n input parameters (see `JobOut` response).\n" - responses: - "200": - description: OK - content: - application/json: - schema: - anyOf: - - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierJobOut" - completion: "#/components/schemas/CompletionJobOut" - propertyName: job_type - oneOf: - - $ref: "#/components/schemas/CompletionJobOut" - - $ref: "#/components/schemas/ClassifierJobOut" - - $ref: "#/components/schemas/LegacyJobMetadataOut" - title: Response - description: Create a new fine-tuning job, it will be queued for processing. - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JobIn" - required: true - tags: - - fine-tuning - /v1/fine_tuning/jobs/{job_id}: - get: - operationId: jobs_api_routes_fine_tuning_get_fine_tuning_job - summary: Get Fine Tuning Job - parameters: - - in: path - name: job_id - schema: - format: uuid - title: Job Id - type: string - required: true - description: The ID of the job to analyse. - responses: - "200": - description: OK - content: - application/json: - schema: - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierDetailedJobOut" - completion: "#/components/schemas/CompletionDetailedJobOut" - propertyName: job_type - oneOf: - - $ref: "#/components/schemas/CompletionDetailedJobOut" - - $ref: "#/components/schemas/ClassifierDetailedJobOut" - title: Response - description: Get a fine-tuned job details by its UUID. - tags: - - fine-tuning - /v1/fine_tuning/jobs/{job_id}/cancel: - post: - operationId: jobs_api_routes_fine_tuning_cancel_fine_tuning_job - summary: Cancel Fine Tuning Job - parameters: - - in: path - name: job_id - schema: - format: uuid - title: Job Id - type: string - required: true - description: The ID of the job to cancel. - responses: - "200": - description: OK - content: - application/json: - schema: - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierDetailedJobOut" - completion: "#/components/schemas/CompletionDetailedJobOut" - propertyName: job_type - oneOf: - - $ref: "#/components/schemas/CompletionDetailedJobOut" - - $ref: "#/components/schemas/ClassifierDetailedJobOut" - title: Response - description: Request the cancellation of a fine tuning job. - tags: - - fine-tuning - /v1/fine_tuning/jobs/{job_id}/start: - post: - operationId: jobs_api_routes_fine_tuning_start_fine_tuning_job - summary: Start Fine Tuning Job - parameters: - - in: path - name: job_id - schema: - format: uuid - title: Job Id - type: string - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierDetailedJobOut" - completion: "#/components/schemas/CompletionDetailedJobOut" - propertyName: job_type - oneOf: - - $ref: "#/components/schemas/CompletionDetailedJobOut" - - $ref: "#/components/schemas/ClassifierDetailedJobOut" - title: Response - description: Request the start of a validated fine tuning job. - tags: - - fine-tuning - /v1/fine_tuning/models/{model_id}: - patch: - operationId: jobs_api_routes_fine_tuning_update_fine_tuned_model - summary: Update Fine Tuned Model - parameters: - - in: path - name: model_id - schema: - title: Model Id - type: string - required: true - example: ft:open-mistral-7b:587a6b29:20240514:7e773925 - description: The ID of the model to update. - responses: - "200": - description: OK - content: - application/json: - schema: - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierFTModelOut" - completion: "#/components/schemas/CompletionFTModelOut" - propertyName: model_type - oneOf: - - $ref: "#/components/schemas/CompletionFTModelOut" - - $ref: "#/components/schemas/ClassifierFTModelOut" - title: Response - description: Update a model name or description. - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateFTModelIn" - required: true - tags: - - models - /v1/fine_tuning/models/{model_id}/archive: - post: - operationId: jobs_api_routes_fine_tuning_archive_fine_tuned_model - summary: Archive Fine Tuned Model - parameters: - - in: path - name: model_id - schema: - title: Model Id - type: string - required: true - example: ft:open-mistral-7b:587a6b29:20240514:7e773925 - description: The ID of the model to archive. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ArchiveFTModelOut" - description: Archive a fine-tuned model. - tags: - - models - delete: - operationId: jobs_api_routes_fine_tuning_unarchive_fine_tuned_model - summary: Unarchive Fine Tuned Model - parameters: - - in: path - name: model_id - schema: - title: Model Id - type: string - required: true - example: ft:open-mistral-7b:587a6b29:20240514:7e773925 - description: The ID of the model to unarchive. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UnarchiveFTModelOut" - description: Un-archive a fine-tuned model. - tags: - - models - /v1/batch/jobs: - get: - operationId: jobs_api_routes_batch_get_batch_jobs - summary: Get Batch Jobs - parameters: - - in: query - name: page - schema: - default: 0 - title: Page - type: integer - required: false - - in: query - name: page_size - schema: - default: 100 - title: Page Size - type: integer - required: false - - in: query - name: model - schema: - anyOf: - - type: string - - type: "null" - title: Model - required: false - - in: query - name: agent_id - schema: - anyOf: - - type: string - - type: "null" - title: Agent Id - required: false - - in: query - name: metadata - schema: - anyOf: - - type: object - additionalProperties: true - - type: "null" - title: Metadata - required: false - - in: query - name: created_after - schema: - anyOf: - - format: date-time - type: string - - type: "null" - title: Created After - required: false - - in: query - name: created_by_me - schema: - default: false - title: Created By Me - type: boolean - required: false - - in: query - name: status - schema: - anyOf: - - items: - $ref: "#/components/schemas/BatchJobStatus" - type: array - - type: "null" - title: Status - required: false - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/BatchJobsOut" - description: Get a list of batch jobs for your organization and user. - tags: - - batch - post: - operationId: jobs_api_routes_batch_create_batch_job - summary: Create Batch Job - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/BatchJobOut" - description: Create a new batch job, it will be queued for processing. - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BatchJobIn" - required: true - tags: - - batch - /v1/batch/jobs/{job_id}: - get: - operationId: jobs_api_routes_batch_get_batch_job - summary: Get Batch Job - parameters: - - in: path - name: job_id - schema: - format: uuid - title: Job Id - type: string - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/BatchJobOut" - description: Get a batch job details by its UUID. - tags: - - batch - /v1/batch/jobs/{job_id}/cancel: - post: - operationId: jobs_api_routes_batch_cancel_batch_job - summary: Cancel Batch Job - parameters: - - in: path - name: job_id - schema: - format: uuid - title: Job Id - type: string - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/BatchJobOut" - description: Request the cancellation of a batch job. - tags: - - batch - /v1/chat/completions: - post: - summary: Chat Completion - operationId: chat_completion_v1_chat_completions_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ChatCompletionRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ChatCompletionResponse" } - text/event-stream: - schema: - $ref: "#/components/schemas/CompletionEvent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - chat - /v1/fim/completions: - post: - summary: Fim Completion - operationId: fim_completion_v1_fim_completions_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/FIMCompletionRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/FIMCompletionResponse" } - text/event-stream: - schema: - $ref: "#/components/schemas/CompletionEvent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - description: FIM completion. - tags: - - fim - /v1/agents/completions: - post: - summary: Agents Completion - operationId: agents_completion_v1_agents_completions_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AgentsCompletionRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ChatCompletionResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - agents - /v1/embeddings: - post: - summary: Embeddings - description: "Embeddings" - operationId: embeddings_v1_embeddings_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmbeddingRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/EmbeddingResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - embeddings - /v1/moderations: - post: - summary: Moderations - operationId: moderations_v1_moderations_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ClassificationRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ModerationResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - classifiers - /v1/chat/moderations: - post: - summary: Chat Moderations - operationId: chat_moderations_v1_chat_moderations_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ChatModerationRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ModerationResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - classifiers - /v1/ocr: - post: - summary: OCR - operationId: ocr_v1_ocr_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/OCRRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/OCRResponse" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - ocr - /v1/classifications: - post: - summary: Classifications - operationId: classifications_v1_classifications_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ClassificationRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ClassificationResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - classifiers - /v1/chat/classifications: - post: - summary: Chat Classifications - operationId: chat_classifications_v1_chat_classifications_post - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ChatClassificationRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: { $ref: "#/components/schemas/ClassificationResponse" } - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - classifiers - /v1/audio/transcriptions: - post: - summary: Create Transcription - operationId: audio_api_v1_transcriptions_post - requestBody: - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/AudioTranscriptionRequest" - required: true - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/TranscriptionResponse" - tags: - - audio.transcriptions - /v1/audio/transcriptions#stream: - post: - summary: Create streaming transcription (SSE) - operationId: audio_api_v1_transcriptions_post_stream - requestBody: - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/AudioTranscriptionRequestStream" - required: true - responses: - "200": - description: Stream of transcription events - content: - text/event-stream: - schema: - $ref: "#/components/schemas/TranscriptionStreamEvents" - tags: - - audio.transcriptions - /v1/libraries: - get: - summary: List all libraries you have access to. - description: List all libraries that you have created or have been shared with you. - operationId: libraries_list_v1 - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ListLibraryOut" - tags: - - beta.libraries - post: - summary: Create a new Library. - description: Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. - operationId: libraries_create_v1 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryIn" - required: true - responses: - "201": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries - /v1/libraries/{library_id}: - get: - summary: Detailed information about a specific Library. - description: Given a library id, details information about that Library. - operationId: libraries_get_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries - delete: - summary: Delete a library and all of it's document. - description: Given a library id, deletes it together with all documents that have been uploaded to that library. - operationId: libraries_delete_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries - put: - summary: Update a library. - description: Given a library id, you can update the name and description. - operationId: libraries_update_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryInUpdate" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/LibraryOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries - /v1/libraries/{library_id}/documents: - get: - summary: List document in a given library. - description: Given a library, lists the document that have been uploaded to that library. - operationId: libraries_documents_list_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: search - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Search - - name: page_size - in: query - required: false - schema: - type: integer - default: 100 - title: Page Size - - name: page - in: query - required: false - schema: - type: integer - default: 0 - title: Page - - name: sort_by - in: query - required: false - schema: - type: string - default: created_at - title: Sort By - - name: sort_order - in: query - required: false - schema: - type: string - default: desc - title: Sort Order - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ListDocumentOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - post: - summary: Upload a new document. - description: Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search - operationId: libraries_documents_upload_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - requestBody: - required: true - content: - multipart/form-data: - schema: - title: DocumentUpload - type: object - properties: - file: - $ref: "#/components/schemas/File" - required: - - file - responses: - "201": - description: Upload successful, returns the created document information's. - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentOut" - "200": - description: A document with the same hash was found in this library. Returns the existing document. - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/share: - get: - summary: List all of the access to this library. - description: Given a library, list all of the Entity that have access and to what level. - operationId: libraries_share_list_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ListSharingOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.accesses - put: - summary: Create or update an access level. - description: Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. - operationId: libraries_share_create_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/SharingIn" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/SharingOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.accesses - delete: - summary: Delete an access level. - description: Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours. - operationId: libraries_share_delete_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/SharingDelete" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/SharingOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.accesses - /v1/libraries/{library_id}/documents/{document_id}: - get: - summary: Retrieve the metadata of a specific document. - description: Given a library and a document in this library, you can retrieve the metadata of that document. - operationId: libraries_documents_get_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - put: - summary: Update the metadata of a specific document. - description: Given a library and a document in that library, update the name of that document. - operationId: libraries_documents_update_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentUpdateIn" - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - delete: - summary: Delete a document. - description: Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. - operationId: libraries_documents_delete_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "204": - description: Successful Response - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/documents/{document_id}/text_content: - get: - summary: Retrieve the text content of a specific document. - description: Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. - operationId: libraries_documents_get_text_content_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/DocumentTextContent" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/documents/{document_id}/status: - get: - summary: Retrieve the processing status of a specific document. - description: Given a library and a document in that library, retrieve the processing status of that document. - operationId: libraries_documents_get_status_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - $ref: "#/components/schemas/ProcessingStatusOut" - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/documents/{document_id}/signed-url: - get: - summary: Retrieve the signed URL of a specific document. - description: Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. - operationId: libraries_documents_get_signed_url_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - type: string - title: Response V1 Libraries Documents Get Signed Url - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url: - get: - summary: Retrieve the signed URL of text extracted from a given document. - description: Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. - operationId: libraries_documents_get_extracted_text_signed_url_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "200": - description: Successful Response - content: - application/json: - schema: - type: string - title: Response V1 Libraries Documents Get Extracted Text Signed Url - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents - /v1/libraries/{library_id}/documents/{document_id}/reprocess: - post: - summary: Reprocess a document. - description: Given a library and a document in that library, reprocess that document, it will be billed again. - operationId: libraries_documents_reprocess_v1 - parameters: - - name: library_id - in: path - required: true - schema: - type: string - format: uuid - title: Library Id - - name: document_id - in: path - required: true - schema: - type: string - format: uuid - title: Document Id - responses: - "204": - description: Successful Response - "422": - description: Validation Error - content: - application/json: - schema: - $ref: "#/components/schemas/HTTPValidationError" - tags: - - beta.libraries.documents -components: - schemas: - BaseModelCard: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - default: mistralai - capabilities: - $ref: "#/components/schemas/ModelCapabilities" - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - max_context_length: - type: integer - title: Max Context Length - default: 32768 - aliases: - items: - type: string - type: array - title: Aliases - default: [] - deprecation: - anyOf: - - type: string - format: date-time - - type: "null" - title: Deprecation - deprecation_replacement_model: - anyOf: - - type: string - - type: "null" - title: Deprecation Replacement Model - default_model_temperature: - anyOf: - - type: number - - type: "null" - title: Default Model Temperature - type: - type: string - const: base - title: Type - default: base - enum: - - base - type: object - required: - - id - - capabilities - title: BaseModelCard - DeleteModelOut: - properties: - id: - type: string - title: Id - description: The ID of the deleted model. - examples: - - ft:open-mistral-7b:587a6b29:20240514:7e773925 - object: - type: string - title: Object - default: model - description: The object type that was deleted - deleted: - type: boolean - title: Deleted - default: true - description: The deletion status - examples: - - true - type: object - required: - - id - title: DeleteModelOut - FTModelCard: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - default: mistralai - capabilities: - $ref: "#/components/schemas/ModelCapabilities" - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - max_context_length: - type: integer - title: Max Context Length - default: 32768 - aliases: - items: - type: string - type: array - title: Aliases - default: [] - deprecation: - anyOf: - - type: string - format: date-time - - type: "null" - title: Deprecation - deprecation_replacement_model: - anyOf: - - type: string - - type: "null" - title: Deprecation Replacement Model - default_model_temperature: - anyOf: - - type: number - - type: "null" - title: Default Model Temperature - type: - type: string - const: fine-tuned - title: Type - default: fine-tuned - enum: - - fine-tuned - job: - type: string - title: Job - root: - type: string - title: Root - archived: - type: boolean - title: Archived - default: false - type: object - required: - - id - - capabilities - - job - - root - title: FTModelCard - description: Extra fields for fine-tuned models. - HTTPValidationError: - properties: - detail: - items: - $ref: "#/components/schemas/ValidationError" - type: array - title: Detail - type: object - title: HTTPValidationError - ModelCapabilities: - properties: - completion_chat: - type: boolean - title: Completion Chat - default: true - completion_fim: - type: boolean - title: Completion Fim - default: false - function_calling: - type: boolean - title: Function Calling - default: true - fine_tuning: - type: boolean - title: Fine Tuning - default: false - vision: - type: boolean - title: Vision - default: false - classification: - type: boolean - title: Classification - default: false - type: object - title: ModelCapabilities - ModelList: - properties: - object: - type: string - title: Object - default: list - data: - items: - oneOf: - - $ref: "#/components/schemas/BaseModelCard" - - $ref: "#/components/schemas/FTModelCard" - discriminator: - propertyName: type - mapping: - base: "#/components/schemas/BaseModelCard" - fine-tuned: "#/components/schemas/FTModelCard" - type: array - title: Data - type: object - title: ModelList - ValidationError: - properties: - loc: - items: - anyOf: - - type: string - - type: integer - type: array - title: Location - msg: - type: string - title: Message - type: - type: string - title: Error Type - type: object - required: - - loc - - msg - - type - title: ValidationError - Agent: - properties: - instructions: - anyOf: - - type: string - - type: "null" - title: Instructions - description: Instruction prompt the model will follow during the conversation. - tools: - items: - oneOf: - - $ref: "#/components/schemas/FunctionTool" - - $ref: "#/components/schemas/WebSearchTool" - - $ref: "#/components/schemas/WebSearchPremiumTool" - - $ref: "#/components/schemas/CodeInterpreterTool" - - $ref: "#/components/schemas/ImageGenerationTool" - - $ref: "#/components/schemas/DocumentLibraryTool" - discriminator: - propertyName: type - mapping: - code_interpreter: "#/components/schemas/CodeInterpreterTool" - document_library: "#/components/schemas/DocumentLibraryTool" - function: "#/components/schemas/FunctionTool" - image_generation: "#/components/schemas/ImageGenerationTool" - web_search: "#/components/schemas/WebSearchTool" - web_search_premium: "#/components/schemas/WebSearchPremiumTool" - type: array - title: Tools - description: List of tools which are available to the model during the conversation. - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - model: - type: string - title: Model - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - handoffs: - anyOf: - - items: - type: string - type: array - minItems: 1 - - type: "null" - title: Handoffs - object: - type: string - enum: - - agent - title: Object - default: agent - id: - type: string - title: Id - version: - type: integer - title: Version - created_at: - type: string - format: date-time - title: Created At - updated_at: - type: string - format: date-time - title: Updated At - additionalProperties: false - type: object - required: - - model - - name - - id - - version - - created_at - - updated_at - title: Agent - AgentConversation: - properties: - name: - anyOf: - - type: string - - type: "null" - title: Name - description: Name given to the conversation. - description: - anyOf: - - type: string - - type: "null" - title: Description - description: Description of the what the conversation is about. - object: - type: string - enum: - - conversation - title: Object - default: conversation - id: - type: string - title: Id - created_at: - type: string - format: date-time - title: Created At - updated_at: - type: string - format: date-time - title: Updated At - agent_id: - type: string - title: Agent Id - additionalProperties: false - type: object - required: - - id - - created_at - - updated_at - - agent_id - title: AgentConversation - AgentCreationRequest: - properties: - instructions: - anyOf: - - type: string - - type: "null" - title: Instructions - description: Instruction prompt the model will follow during the conversation. - tools: - items: - oneOf: - - $ref: "#/components/schemas/FunctionTool" - - $ref: "#/components/schemas/WebSearchTool" - - $ref: "#/components/schemas/WebSearchPremiumTool" - - $ref: "#/components/schemas/CodeInterpreterTool" - - $ref: "#/components/schemas/ImageGenerationTool" - - $ref: "#/components/schemas/DocumentLibraryTool" - discriminator: - propertyName: type - mapping: - code_interpreter: "#/components/schemas/CodeInterpreterTool" - document_library: "#/components/schemas/DocumentLibraryTool" - function: "#/components/schemas/FunctionTool" - image_generation: "#/components/schemas/ImageGenerationTool" - web_search: "#/components/schemas/WebSearchTool" - web_search_premium: "#/components/schemas/WebSearchPremiumTool" - type: array - title: Tools - description: List of tools which are available to the model during the conversation. - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - model: - type: string - title: Model - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - handoffs: - anyOf: - - items: - type: string - type: array - minItems: 1 - - type: "null" - title: Handoffs - additionalProperties: false - type: object - required: - - model - - name - title: AgentCreationRequest - AgentHandoffEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - agent.handoff - title: Type - default: agent.handoff - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - previous_agent_id: - type: string - title: Previous Agent Id - previous_agent_name: - type: string - title: Previous Agent Name - next_agent_id: - type: string - title: Next Agent Id - next_agent_name: - type: string - title: Next Agent Name - additionalProperties: false - type: object - required: - - previous_agent_id - - previous_agent_name - - next_agent_id - - next_agent_name - title: AgentHandoffEntry - AgentUpdateRequest: - properties: - instructions: - anyOf: - - type: string - - type: "null" - title: Instructions - description: Instruction prompt the model will follow during the conversation. - tools: - items: - oneOf: - - $ref: "#/components/schemas/FunctionTool" - - $ref: "#/components/schemas/WebSearchTool" - - $ref: "#/components/schemas/WebSearchPremiumTool" - - $ref: "#/components/schemas/CodeInterpreterTool" - - $ref: "#/components/schemas/ImageGenerationTool" - - $ref: "#/components/schemas/DocumentLibraryTool" - discriminator: - propertyName: type - mapping: - code_interpreter: "#/components/schemas/CodeInterpreterTool" - document_library: "#/components/schemas/DocumentLibraryTool" - function: "#/components/schemas/FunctionTool" - image_generation: "#/components/schemas/ImageGenerationTool" - web_search: "#/components/schemas/WebSearchTool" - web_search_premium: "#/components/schemas/WebSearchPremiumTool" - type: array - title: Tools - description: List of tools which are available to the model during the conversation. - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - model: - anyOf: - - type: string - - type: "null" - title: Model - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - handoffs: - anyOf: - - items: - type: string - type: array - minItems: 1 - - type: "null" - title: Handoffs - additionalProperties: false - type: object - title: AgentUpdateRequest - BuiltInConnectors: - type: string - enum: - - web_search - - web_search_premium - - code_interpreter - - image_generation - - document_library - title: BuiltInConnectors - CodeInterpreterTool: - properties: - type: - type: string - enum: - - code_interpreter - title: Type - default: code_interpreter - additionalProperties: false - type: object - title: CodeInterpreterTool - CompletionArgs: - properties: - stop: - $ref: "#/components/schemas/CompletionArgsStop" - presence_penalty: - anyOf: - - type: number - maximum: 2 - minimum: -2 - - type: "null" - title: Presence Penalty - frequency_penalty: - anyOf: - - type: number - maximum: 2 - minimum: -2 - - type: "null" - title: Frequency Penalty - temperature: - anyOf: - - type: number - maximum: 1 - minimum: 0 - - type: "null" - title: Temperature - top_p: - anyOf: - - type: number - maximum: 1 - minimum: 0 - - type: "null" - title: Top P - max_tokens: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Max Tokens - random_seed: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Random Seed - prediction: - anyOf: - - $ref: "#/components/schemas/Prediction" - - type: "null" - response_format: - anyOf: - - $ref: "#/components/schemas/ResponseFormat" - - type: "null" - tool_choice: - $ref: "#/components/schemas/ToolChoiceEnum" - default: auto - additionalProperties: false - type: object - title: CompletionArgs - description: White-listed arguments from the completion API - ConversationAppendRequest: - allOf: - - $ref: "#/components/schemas/ConversationAppendRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - false - default: false - ConversationHistory: - properties: - object: - type: string - enum: - - conversation.history - title: Object - default: conversation.history - conversation_id: - type: string - title: Conversation Id - entries: - items: - anyOf: - - $ref: "#/components/schemas/MessageInputEntry" - - $ref: "#/components/schemas/MessageOutputEntry" - - $ref: "#/components/schemas/FunctionResultEntry" - - $ref: "#/components/schemas/FunctionCallEntry" - - $ref: "#/components/schemas/ToolExecutionEntry" - - $ref: "#/components/schemas/AgentHandoffEntry" - type: array - title: Entries - additionalProperties: false - type: object - required: - - conversation_id - - entries - title: ConversationHistory - description: Retrieve all entries in a conversation. - ConversationMessages: - properties: - object: - type: string - enum: - - conversation.messages - title: Object - default: conversation.messages - conversation_id: - type: string - title: Conversation Id - messages: - $ref: "#/components/schemas/MessageEntries" - additionalProperties: false - type: object - required: - - conversation_id - - messages - title: ConversationMessages - description: Similar to the conversation history but only keep the messages - ConversationRestartRequest: - allOf: - - $ref: "#/components/schemas/ConversationRestartRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - false - default: false - DocumentLibraryTool: - properties: - type: - type: string - enum: - - document_library - title: Type - default: document_library - library_ids: - items: - type: string - type: array - minItems: 1 - title: Library Ids - description: Ids of the library in which to search. - additionalProperties: false - type: object - required: - - library_ids - title: DocumentLibraryTool - DocumentURLChunk: - properties: - document_url: - type: string - title: Document Url - document_name: - anyOf: - - type: string - - type: "null" - title: Document Name - description: The filename of the document - type: - type: string - enum: - - document_url - title: Type - default: document_url - additionalProperties: false - type: object - required: - - document_url - title: DocumentURLChunk - Function: - properties: - name: - type: string - title: Name - description: - type: string - title: Description - default: "" - strict: - type: boolean - title: Strict - default: false - parameters: - type: object - title: Parameters - additionalProperties: true - additionalProperties: false - type: object - required: - - name - - parameters - title: Function - FunctionCallEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - function.call - title: Type - default: function.call - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - tool_call_id: - type: string - title: Tool Call Id - name: - type: string - title: Name - arguments: - $ref: "#/components/schemas/FunctionCallEntryArguments" - additionalProperties: false - type: object - required: - - tool_call_id - - name - - arguments - title: FunctionCallEntry - FunctionResultEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - function.result - title: Type - default: function.result - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - tool_call_id: - type: string - title: Tool Call Id - result: - type: string - title: Result - additionalProperties: false - type: object - required: - - tool_call_id - - result - title: FunctionResultEntry - FunctionTool: - properties: - type: - type: string - enum: - - function - title: Type - default: function - function: - $ref: "#/components/schemas/Function" - additionalProperties: false - type: object - required: - - function - title: FunctionTool - ImageGenerationTool: - properties: - type: - type: string - enum: - - image_generation - title: Type - default: image_generation - additionalProperties: false - type: object - title: ImageGenerationTool - ImageURLChunk: - properties: - image_url: - anyOf: - - $ref: "#/components/schemas/ImageURL" - - type: string - title: Image Url - type: - type: string - enum: - - image_url - title: Type - default: image_url - additionalProperties: false - type: object - required: - - image_url - title: ImageURLChunk - description: '{"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0' - JsonSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - schema: - type: object - title: Schema - additionalProperties: true - x-speakeasy-name-override: schema_definition - strict: - type: boolean - title: Strict - default: false - additionalProperties: false - type: object - required: - - name - - schema - title: JsonSchema - MessageInputEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - message.input - title: Type - default: message.input - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - role: - type: string - enum: - - assistant - - user - title: Role - content: - anyOf: - - type: string - - $ref: "#/components/schemas/MessageInputContentChunks" - title: Content - prefix: - type: boolean - title: Prefix - default: false - additionalProperties: false - type: object - required: - - role - - content - title: MessageInputEntry - description: Representation of an input message inside the conversation. - MessageOutputEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - message.output - title: Type - default: message.output - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - agent_id: - anyOf: - - type: string - - type: "null" - title: Agent Id - model: - anyOf: - - type: string - - type: "null" - title: Model - role: - type: string - enum: - - assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - $ref: "#/components/schemas/MessageOutputContentChunks" - title: Content - additionalProperties: false - type: object - required: - - content - title: MessageOutputEntry - ModelConversation: - properties: - instructions: - anyOf: - - type: string - - type: "null" - title: Instructions - description: Instruction prompt the model will follow during the conversation. - tools: - items: - oneOf: - - $ref: "#/components/schemas/FunctionTool" - - $ref: "#/components/schemas/WebSearchTool" - - $ref: "#/components/schemas/WebSearchPremiumTool" - - $ref: "#/components/schemas/CodeInterpreterTool" - - $ref: "#/components/schemas/ImageGenerationTool" - - $ref: "#/components/schemas/DocumentLibraryTool" - discriminator: - propertyName: type - mapping: - code_interpreter: "#/components/schemas/CodeInterpreterTool" - document_library: "#/components/schemas/DocumentLibraryTool" - function: "#/components/schemas/FunctionTool" - image_generation: "#/components/schemas/ImageGenerationTool" - web_search: "#/components/schemas/WebSearchTool" - web_search_premium: "#/components/schemas/WebSearchPremiumTool" - type: array - title: Tools - description: List of tools which are available to the model during the conversation. - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - name: - anyOf: - - type: string - - type: "null" - title: Name - description: Name given to the conversation. - description: - anyOf: - - type: string - - type: "null" - title: Description - description: Description of the what the conversation is about. - object: - type: string - enum: - - conversation - title: Object - default: conversation - id: - type: string - title: Id - created_at: - type: string - format: date-time - title: Created At - updated_at: - type: string - format: date-time - title: Updated At - model: - type: string - title: Model - additionalProperties: false - type: object - required: - - id - - created_at - - updated_at - - model - title: ModelConversation - Prediction: - properties: - type: - type: string - const: content - title: Type - default: content - content: - type: string - title: Content - default: "" - additionalProperties: false - type: object - title: Prediction - ResponseFormat: - properties: - type: - $ref: "#/components/schemas/ResponseFormats" - default: text - json_schema: - anyOf: - - $ref: "#/components/schemas/JsonSchema" - - type: "null" - additionalProperties: false - type: object - title: ResponseFormat - ResponseFormats: - type: string - enum: - - text - - json_object - - json_schema - title: ResponseFormats - description: 'An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message.' - TextChunk: - properties: - text: - type: string - title: Text - type: - type: string - enum: - - text - title: Type - default: text - additionalProperties: false - type: object - required: - - text - title: TextChunk - ToolChoiceEnum: - type: string - enum: - - auto - - none - - any - - required - title: ToolChoiceEnum - ToolExecutionEntry: - properties: - object: - type: string - enum: - - entry - title: Object - default: entry - type: - type: string - enum: - - tool.execution - title: Type - default: tool.execution - created_at: - type: string - format: date-time - title: Created At - completed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Completed At - id: - type: string - title: Id - name: - $ref: "#/components/schemas/BuiltInConnectors" - arguments: - type: string - title: Arguments - info: - $ref: "#/components/schemas/ToolExecutionInfo" - additionalProperties: false - type: object - title: ToolExecutionEntry - required: - - name - - arguments - ToolFileChunk: - properties: - type: - type: string - enum: - - tool_file - title: Type - default: tool_file - tool: - $ref: "#/components/schemas/BuiltInConnectors" - file_id: - type: string - title: File Id - file_name: - anyOf: - - type: string - - type: "null" - title: File Name - file_type: - anyOf: - - type: string - - type: "null" - title: File Type - additionalProperties: false - type: object - required: - - tool - - file_id - title: ToolFileChunk - ToolReferenceChunk: - properties: - type: - type: string - enum: - - tool_reference - title: Type - default: tool_reference - tool: - $ref: "#/components/schemas/BuiltInConnectors" - title: - type: string - title: Title - url: - anyOf: - - type: string - - type: "null" - title: Url - favicon: - anyOf: - - type: string - - type: "null" - title: Favicon - description: - anyOf: - - type: string - - type: "null" - title: Description - additionalProperties: false - type: object - required: - - tool - - title - title: ToolReferenceChunk - WebSearchPremiumTool: - properties: - type: - type: string - enum: - - web_search_premium - title: Type - default: web_search_premium - additionalProperties: false - type: object - title: WebSearchPremiumTool - WebSearchTool: - properties: - type: - type: string - enum: - - web_search - title: Type - default: web_search - additionalProperties: false - type: object - title: WebSearchTool - ConversationUsageInfo: - additionalProperties: false - properties: - prompt_tokens: - default: 0 - title: Prompt Tokens - type: integer - completion_tokens: - default: 0 - title: Completion Tokens - type: integer - total_tokens: - default: 0 - title: Total Tokens - type: integer - connector_tokens: - anyOf: - - type: integer - - type: "null" - default: - title: Connector Tokens - connectors: - anyOf: - - additionalProperties: - type: integer - propertyNames: - $ref: "#/components/schemas/BuiltInConnectors" - type: object - - type: "null" - default: - title: Connectors - title: ConversationUsageInfo - type: object - ConversationResponse: - additionalProperties: false - description: The response after appending new entries to the conversation. - properties: - object: - default: conversation.response - enum: - - conversation.response - title: Object - type: string - conversation_id: - title: Conversation Id - type: string - outputs: - items: - anyOf: - - $ref: "#/components/schemas/MessageOutputEntry" - - $ref: "#/components/schemas/ToolExecutionEntry" - - $ref: "#/components/schemas/FunctionCallEntry" - - $ref: "#/components/schemas/AgentHandoffEntry" - title: Outputs - type: array - usage: - $ref: "#/components/schemas/ConversationUsageInfo" - required: - - conversation_id - - outputs - - usage - title: ConversationResponse - type: object - ConversationRequest: - allOf: - - $ref: "#/components/schemas/ConversationRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - false - default: false - AgentHandoffDoneEvent: - additionalProperties: false - properties: - type: - default: agent.handoff.done - enum: - - agent.handoff.done - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - next_agent_id: - title: Next Agent Id - type: string - next_agent_name: - title: Next Agent Name - type: string - required: - - id - - next_agent_id - - next_agent_name - title: AgentHandoffDoneEvent - type: object - AgentHandoffStartedEvent: - additionalProperties: false - properties: - type: - default: agent.handoff.started - enum: - - agent.handoff.started - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - previous_agent_id: - title: Previous Agent Id - type: string - previous_agent_name: - title: Previous Agent Name - type: string - required: - - id - - previous_agent_id - - previous_agent_name - title: AgentHandoffStartedEvent - type: object - FunctionCallEvent: - additionalProperties: false - properties: - type: - default: function.call.delta - enum: - - function.call.delta - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - name: - title: Name - type: string - tool_call_id: - title: Tool Call Id - type: string - arguments: - title: Arguments - type: string - required: - - id - - name - - tool_call_id - - arguments - title: FunctionCallEvent - type: object - MessageOutputEvent: - additionalProperties: false - properties: - type: - default: message.output.delta - enum: - - message.output.delta - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - content_index: - default: 0 - title: Content Index - type: integer - model: - anyOf: - - type: string - - type: "null" - default: - title: Model - agent_id: - anyOf: - - type: string - - type: "null" - default: - title: Agent Id - role: - default: assistant - enum: - - assistant - title: Role - type: string - content: - anyOf: - - type: string - - $ref: "#/components/schemas/OutputContentChunks" - title: Content - required: - - id - - content - title: MessageOutputEvent - type: object - ResponseDoneEvent: - additionalProperties: false - properties: - type: - default: conversation.response.done - enum: - - conversation.response.done - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - usage: - $ref: "#/components/schemas/ConversationUsageInfo" - required: - - usage - title: ResponseDoneEvent - type: object - ResponseErrorEvent: - additionalProperties: false - properties: - type: - default: conversation.response.error - enum: - - conversation.response.error - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - message: - title: Message - type: string - code: - title: Code - type: integer - required: - - message - - code - title: ResponseErrorEvent - type: object - ResponseStartedEvent: - additionalProperties: false - properties: - type: - default: conversation.response.started - enum: - - conversation.response.started - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - conversation_id: - title: Conversation Id - type: string - required: - - conversation_id - title: ResponseStartedEvent - type: object - SSETypes: - description: Server side events sent when streaming a conversation response. - enum: - - conversation.response.started - - conversation.response.done - - conversation.response.error - - message.output.delta - - tool.execution.started - - tool.execution.delta - - tool.execution.done - - agent.handoff.started - - agent.handoff.done - - function.call.delta - title: SSETypes - type: string - ToolExecutionDeltaEvent: - additionalProperties: false - properties: - type: - default: tool.execution.delta - enum: - - tool.execution.delta - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - name: - $ref: "#/components/schemas/BuiltInConnectors" - arguments: - title: Arguments - type: string - title: ToolExecutionDeltaEvent - type: object - required: - - id - - name - - arguments - ToolExecutionDoneEvent: - additionalProperties: false - properties: - type: - default: tool.execution.done - enum: - - tool.execution.done - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - name: - $ref: "#/components/schemas/BuiltInConnectors" - info: - $ref: "#/components/schemas/ToolExecutionInfo" - title: ToolExecutionDoneEvent - type: object - required: - - id - - name - ToolExecutionStartedEvent: - additionalProperties: false - properties: - type: - default: tool.execution.started - enum: - - tool.execution.started - title: Type - type: string - created_at: - format: date-time - title: Created At - type: string - output_index: - default: 0 - title: Output Index - type: integer - id: - title: Id - type: string - name: - $ref: "#/components/schemas/BuiltInConnectors" - arguments: - title: Arguments - type: string - title: ToolExecutionStartedEvent - type: object - required: - - id - - name - - arguments - ConversationEvents: - properties: - event: - $ref: "#/components/schemas/SSETypes" - data: - discriminator: - mapping: - agent.handoff.done: "#/components/schemas/AgentHandoffDoneEvent" - agent.handoff.started: "#/components/schemas/AgentHandoffStartedEvent" - conversation.response.done: "#/components/schemas/ResponseDoneEvent" - conversation.response.error: "#/components/schemas/ResponseErrorEvent" - conversation.response.started: "#/components/schemas/ResponseStartedEvent" - function.call.delta: "#/components/schemas/FunctionCallEvent" - message.output.delta: "#/components/schemas/MessageOutputEvent" - tool.execution.delta: "#/components/schemas/ToolExecutionDeltaEvent" - tool.execution.done: "#/components/schemas/ToolExecutionDoneEvent" - tool.execution.started: "#/components/schemas/ToolExecutionStartedEvent" - propertyName: type - oneOf: - - $ref: "#/components/schemas/ResponseStartedEvent" - - $ref: "#/components/schemas/ResponseDoneEvent" - - $ref: "#/components/schemas/ResponseErrorEvent" - - $ref: "#/components/schemas/ToolExecutionStartedEvent" - - $ref: "#/components/schemas/ToolExecutionDeltaEvent" - - $ref: "#/components/schemas/ToolExecutionDoneEvent" - - $ref: "#/components/schemas/MessageOutputEvent" - - $ref: "#/components/schemas/FunctionCallEvent" - - $ref: "#/components/schemas/AgentHandoffStartedEvent" - - $ref: "#/components/schemas/AgentHandoffDoneEvent" - title: Data - required: - - event - - data - title: ConversationEvents - type: object - MessageInputContentChunks: - items: - anyOf: - - $ref: "#/components/schemas/TextChunk" - - $ref: "#/components/schemas/ImageURLChunk" - - $ref: "#/components/schemas/ToolFileChunk" - - $ref: "#/components/schemas/DocumentURLChunk" - type: array - title: MessageInputContentChunks - MessageOutputContentChunks: - items: - anyOf: - - $ref: "#/components/schemas/TextChunk" - - $ref: "#/components/schemas/ImageURLChunk" - - $ref: "#/components/schemas/ToolFileChunk" - - $ref: "#/components/schemas/DocumentURLChunk" - - $ref: "#/components/schemas/ToolReferenceChunk" - type: array - title: MessageOutputContentChunks - OutputContentChunks: - anyOf: - - $ref: "#/components/schemas/TextChunk" - - $ref: "#/components/schemas/ImageURLChunk" - - $ref: "#/components/schemas/ToolFileChunk" - - $ref: "#/components/schemas/DocumentURLChunk" - - $ref: "#/components/schemas/ToolReferenceChunk" - title: OutputContentChunks - MessageEntries: - items: - anyOf: - - $ref: "#/components/schemas/MessageInputEntry" - - $ref: "#/components/schemas/MessageOutputEntry" - type: array - title: MessageEntries - InputEntries: - items: - anyOf: - - $ref: "#/components/schemas/MessageInputEntry" - - $ref: "#/components/schemas/MessageOutputEntry" - - $ref: "#/components/schemas/FunctionResultEntry" - - $ref: "#/components/schemas/FunctionCallEntry" - - $ref: "#/components/schemas/ToolExecutionEntry" - - $ref: "#/components/schemas/AgentHandoffEntry" - type: array - title: InputEntries - CompletionArgsStop: - anyOf: - - type: string - - items: - type: string - type: array - - type: "null" - title: CompletionArgsStop - FunctionCallEntryArguments: - anyOf: - - type: object - additionalProperties: true - - type: string - title: FunctionCallEntryArguments - ConversationInputs: - anyOf: - - type: string - - $ref: "#/components/schemas/InputEntries" - title: ConversationInputs - ToolExecutionInfo: - type: object - additionalProperties: true - title: ToolExecutionInfo - ConversationRequestBase: - properties: - inputs: - $ref: "#/components/schemas/ConversationInputs" - stream: - anyOf: - - type: boolean - - type: "null" - default: - title: Stream - store: - anyOf: - - type: boolean - - type: "null" - default: - title: Store - handoff_execution: - anyOf: - - enum: - - client - - server - type: string - - type: "null" - default: - title: Handoff Execution - instructions: - anyOf: - - type: string - - type: "null" - default: - title: Instructions - tools: - anyOf: - - items: - discriminator: - mapping: - code_interpreter: "#/components/schemas/CodeInterpreterTool" - document_library: "#/components/schemas/DocumentLibraryTool" - function: "#/components/schemas/FunctionTool" - image_generation: "#/components/schemas/ImageGenerationTool" - web_search: "#/components/schemas/WebSearchTool" - web_search_premium: "#/components/schemas/WebSearchPremiumTool" - propertyName: type - oneOf: - - $ref: "#/components/schemas/FunctionTool" - - $ref: "#/components/schemas/WebSearchTool" - - $ref: "#/components/schemas/WebSearchPremiumTool" - - $ref: "#/components/schemas/CodeInterpreterTool" - - $ref: "#/components/schemas/ImageGenerationTool" - - $ref: "#/components/schemas/DocumentLibraryTool" - type: array - - type: "null" - default: - title: Tools - completion_args: - anyOf: - - $ref: "#/components/schemas/CompletionArgs" - - type: "null" - default: - name: - anyOf: - - type: string - - type: "null" - default: - title: Name - description: - anyOf: - - type: string - - type: "null" - default: - title: Description - agent_id: - anyOf: - - type: string - - type: "null" - default: - title: Agent Id - model: - anyOf: - - type: string - - type: "null" - default: - title: Model - required: - - inputs - title: ConversationRequest - type: object - ConversationStreamRequest: - allOf: - - $ref: "#/components/schemas/ConversationRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - true - default: true - ConversationAppendRequestBase: - properties: - inputs: - $ref: "#/components/schemas/ConversationInputs" - stream: - type: boolean - title: Stream - description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - default: false - store: - type: boolean - title: Store - description: Whether to store the results into our servers or not. - default: true - handoff_execution: - type: string - enum: - - client - - server - title: Handoff Execution - default: server - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - additionalProperties: false - type: object - required: - - inputs - title: ConversationAppendRequest - ConversationAppendStreamRequest: - allOf: - - $ref: "#/components/schemas/ConversationAppendRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - true - default: true - ConversationRestartRequestBase: - properties: - inputs: - $ref: "#/components/schemas/ConversationInputs" - stream: - type: boolean - title: Stream - description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. - default: false - store: - type: boolean - title: Store - description: Whether to store the results into our servers or not. - default: true - handoff_execution: - type: string - enum: - - client - - server - title: Handoff Execution - default: server - completion_args: - $ref: "#/components/schemas/CompletionArgs" - description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. - from_entry_id: - type: string - title: From Entry Id - additionalProperties: false - type: object - required: - - inputs - - from_entry_id - title: ConversationRestartRequest - description: Request to restart a new conversation from a given entry in the conversation. - ConversationRestartStreamRequest: - allOf: - - $ref: "#/components/schemas/ConversationRestartRequestBase" - - type: object - properties: - stream: - type: boolean - enum: - - true - default: true - FilePurpose: - title: FilePurpose - type: string - enum: - - fine-tune - - batch - - ocr - SampleType: - title: SampleType - type: string - enum: - - pretrain - - instruct - - batch_request - - batch_result - - batch_error - Source: - enum: - - upload - - repository - - mistral - title: Source - type: string - UploadFileOut: - properties: - id: - format: uuid - title: Id - type: string - description: The unique identifier of the file. - examples: - - 497f6eca-6276-4993-bfeb-53cbbbba6f09 - object: - title: Object - type: string - description: The object type, which is always "file". - examples: - - file - bytes: - title: Bytes - type: integer - description: The size of the file, in bytes. - examples: - - 13000 - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) of the event. - examples: - - 1716963433 - filename: - title: Filename - type: string - description: The name of the uploaded file. - examples: - - files_upload.jsonl - purpose: - $ref: "#/components/schemas/FilePurpose" - description: The intended purpose of the uploaded file. Only accepts fine-tuning (`fine-tune`) for now. - examples: - - fine-tune - sample_type: - $ref: "#/components/schemas/SampleType" - num_lines: - anyOf: - - type: integer - - type: "null" - title: Num Lines - mimetype: - anyOf: - - type: string - - type: "null" - title: Mimetype - source: - $ref: "#/components/schemas/Source" - signature: - anyOf: - - type: string - - type: "null" - title: Signature - required: - - id - - object - - bytes - - created_at - - filename - - purpose - - sample_type - - source - title: UploadFileOut - type: object - FileSchema: - properties: - id: - format: uuid - title: Id - type: string - description: The unique identifier of the file. - examples: - - 497f6eca-6276-4993-bfeb-53cbbbba6f09 - object: - title: Object - type: string - description: The object type, which is always "file". - examples: - - file - bytes: - title: Bytes - type: integer - description: The size of the file, in bytes. - examples: - - 13000 - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) of the event. - examples: - - 1716963433 - filename: - title: Filename - type: string - description: The name of the uploaded file. - examples: - - files_upload.jsonl - purpose: - $ref: "#/components/schemas/FilePurpose" - description: The intended purpose of the uploaded file. Only accepts fine-tuning (`fine-tune`) for now. - examples: - - fine-tune - sample_type: - $ref: "#/components/schemas/SampleType" - num_lines: - anyOf: - - type: integer - - type: "null" - title: Num Lines - mimetype: - anyOf: - - type: string - - type: "null" - title: Mimetype - source: - $ref: "#/components/schemas/Source" - signature: - anyOf: - - type: string - - type: "null" - title: Signature - required: - - id - - object - - bytes - - created_at - - filename - - purpose - - sample_type - - source - title: FileSchema - type: object - ListFilesOut: - properties: - data: - items: - $ref: "#/components/schemas/FileSchema" - title: Data - type: array - object: - title: Object - type: string - total: - title: Total - type: integer - required: - - data - - object - - total - title: ListFilesOut - type: object - RetrieveFileOut: - properties: - id: - format: uuid - title: Id - type: string - description: The unique identifier of the file. - examples: - - 497f6eca-6276-4993-bfeb-53cbbbba6f09 - object: - title: Object - type: string - description: The object type, which is always "file". - examples: - - file - bytes: - title: Bytes - type: integer - description: The size of the file, in bytes. - examples: - - 13000 - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) of the event. - examples: - - 1716963433 - filename: - title: Filename - type: string - description: The name of the uploaded file. - examples: - - files_upload.jsonl - purpose: - $ref: "#/components/schemas/FilePurpose" - description: The intended purpose of the uploaded file. Only accepts fine-tuning (`fine-tune`) for now. - examples: - - fine-tune - sample_type: - $ref: "#/components/schemas/SampleType" - num_lines: - anyOf: - - type: integer - - type: "null" - title: Num Lines - mimetype: - anyOf: - - type: string - - type: "null" - title: Mimetype - source: - $ref: "#/components/schemas/Source" - signature: - anyOf: - - type: string - - type: "null" - title: Signature - deleted: - title: Deleted - type: boolean - required: - - id - - object - - bytes - - created_at - - filename - - purpose - - sample_type - - source - - deleted - title: RetrieveFileOut - type: object - DeleteFileOut: - properties: - id: - format: uuid - title: Id - type: string - description: The ID of the deleted file. - examples: - - 497f6eca-6276-4993-bfeb-53cbbbba6f09 - object: - title: Object - type: string - description: The object type that was deleted - examples: - - file - deleted: - title: Deleted - type: boolean - description: The deletion status. - examples: - - false - required: - - id - - object - - deleted - title: DeleteFileOut - type: object - FileSignedURL: - properties: - url: - title: Url - type: string - required: - - url - title: FileSignedURL - type: object - FineTuneableModelType: - enum: - - completion - - classifier - title: FineTuneableModelType - type: string - ClassifierJobOut: - properties: - id: - format: uuid - title: Id - type: string - description: The ID of the job. - auto_start: - title: Auto Start - type: boolean - model: - $ref: "#/components/schemas/FineTuneableModel" - status: - enum: - - QUEUED - - STARTED - - VALIDATING - - VALIDATED - - RUNNING - - FAILED_VALIDATION - - FAILED - - SUCCESS - - CANCELLED - - CANCELLATION_REQUESTED - title: Status - type: string - description: The current status of the fine-tuning job. - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) for when the fine-tuning job was created. - modified_at: - title: Modified At - type: integer - description: The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - training_files: - items: - format: uuid - type: string - title: Training Files - type: array - description: A list containing the IDs of uploaded files that contain training data. - validation_files: - anyOf: - - items: - format: uuid - type: string - type: array - - type: "null" - default: [] - title: Validation Files - description: A list containing the IDs of uploaded files that contain validation data. - object: - default: job - title: Object - type: string - description: The object type of the fine-tuning job. - enum: - - job - fine_tuned_model: - anyOf: - - type: string - - type: "null" - title: Fine Tuned Model - description: The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - suffix: - anyOf: - - type: string - - type: "null" - title: Suffix - description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - integrations: - anyOf: - - items: - discriminator: - mapping: - wandb: "#/components/schemas/WandbIntegrationOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/WandbIntegrationOut" - type: array - - type: "null" - title: Integrations - description: A list of integrations enabled for your fine-tuning job. - trained_tokens: - anyOf: - - type: integer - - type: "null" - title: Trained Tokens - description: Total number of tokens trained. - metadata: - anyOf: - - $ref: "#/components/schemas/JobMetadataOut" - - type: "null" - job_type: - default: classifier - title: Job Type - type: string - description: The type of job (`FT` for fine-tuning). - enum: - - classifier - hyperparameters: - $ref: "#/components/schemas/ClassifierTrainingParameters" - required: - - id - - auto_start - - model - - status - - created_at - - modified_at - - training_files - - hyperparameters - title: ClassifierJobOut - type: object - ClassifierTrainingParameters: - properties: - training_steps: - anyOf: - - minimum: 1 - type: integer - - type: "null" - title: Training Steps - learning_rate: - default: 0.0001 - maximum: 1 - minimum: 0.00000001 - title: Learning Rate - type: number - weight_decay: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.1 - title: Weight Decay - warmup_fraction: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.05 - title: Warmup Fraction - epochs: - anyOf: - - exclusiveMinimum: 0 - type: number - - type: "null" - title: Epochs - seq_len: - anyOf: - - minimum: 100 - type: integer - - type: "null" - title: Seq Len - title: ClassifierTrainingParameters - type: object - CompletionJobOut: - properties: - id: - format: uuid - title: Id - type: string - description: The ID of the job. - auto_start: - title: Auto Start - type: boolean - model: - $ref: "#/components/schemas/FineTuneableModel" - status: - enum: - - QUEUED - - STARTED - - VALIDATING - - VALIDATED - - RUNNING - - FAILED_VALIDATION - - FAILED - - SUCCESS - - CANCELLED - - CANCELLATION_REQUESTED - title: Status - type: string - description: The current status of the fine-tuning job. - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) for when the fine-tuning job was created. - modified_at: - title: Modified At - type: integer - description: The UNIX timestamp (in seconds) for when the fine-tuning job was last modified. - training_files: - items: - format: uuid - type: string - title: Training Files - type: array - description: A list containing the IDs of uploaded files that contain training data. - validation_files: - anyOf: - - items: - format: uuid - type: string - type: array - - type: "null" - default: [] - title: Validation Files - description: A list containing the IDs of uploaded files that contain validation data. - object: - default: job - title: Object - type: string - description: The object type of the fine-tuning job. - enum: - - job - fine_tuned_model: - anyOf: - - type: string - - type: "null" - title: Fine Tuned Model - description: The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running. - suffix: - anyOf: - - type: string - - type: "null" - title: Suffix - description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - integrations: - anyOf: - - items: - discriminator: - mapping: - wandb: "#/components/schemas/WandbIntegrationOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/WandbIntegrationOut" - type: array - - type: "null" - title: Integrations - description: A list of integrations enabled for your fine-tuning job. - trained_tokens: - anyOf: - - type: integer - - type: "null" - title: Trained Tokens - description: Total number of tokens trained. - metadata: - anyOf: - - $ref: "#/components/schemas/JobMetadataOut" - - type: "null" - job_type: - default: completion - title: Job Type - type: string - description: The type of job (`FT` for fine-tuning). - enum: - - completion - hyperparameters: - $ref: "#/components/schemas/CompletionTrainingParameters" - repositories: - default: [] - items: - discriminator: - mapping: - github: "#/components/schemas/GithubRepositoryOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/GithubRepositoryOut" - title: Repositories - type: array - required: - - id - - auto_start - - model - - status - - created_at - - modified_at - - training_files - - hyperparameters - title: CompletionJobOut - type: object - CompletionTrainingParameters: - properties: - training_steps: - anyOf: - - minimum: 1 - type: integer - - type: "null" - title: Training Steps - learning_rate: - default: 0.0001 - maximum: 1 - minimum: 0.00000001 - title: Learning Rate - type: number - weight_decay: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.1 - title: Weight Decay - warmup_fraction: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.05 - title: Warmup Fraction - epochs: - anyOf: - - exclusiveMinimum: 0 - type: number - - type: "null" - title: Epochs - seq_len: - anyOf: - - minimum: 100 - type: integer - - type: "null" - title: Seq Len - fim_ratio: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.9 - title: Fim Ratio - title: CompletionTrainingParameters - type: object - FineTuneableModel: - enum: - - ministral-3b-latest - - ministral-8b-latest - - open-mistral-7b - - open-mistral-nemo - - mistral-small-latest - - mistral-medium-latest - - mistral-large-latest - - pixtral-12b-latest - - codestral-latest - title: FineTuneableModel - type: string - description: The name of the model to fine-tune. - GithubRepositoryOut: - properties: - type: - default: github - title: Type - type: string - enum: - - github - name: - title: Name - type: string - owner: - title: Owner - type: string - ref: - anyOf: - - type: string - - type: "null" - title: Ref - weight: - default: 1.0 - exclusiveMinimum: 0 - title: Weight - type: number - commit_id: - maxLength: 40 - minLength: 40 - title: Commit Id - type: string - required: - - name - - owner - - commit_id - title: GithubRepositoryOut - type: object - JobMetadataOut: - properties: - expected_duration_seconds: - anyOf: - - type: integer - - type: "null" - title: Expected Duration Seconds - cost: - anyOf: - - type: number - - type: "null" - title: Cost - cost_currency: - anyOf: - - type: string - - type: "null" - title: Cost Currency - train_tokens_per_step: - anyOf: - - type: integer - - type: "null" - title: Train Tokens Per Step - train_tokens: - anyOf: - - type: integer - - type: "null" - title: Train Tokens - data_tokens: - anyOf: - - type: integer - - type: "null" - title: Data Tokens - estimated_start_time: - anyOf: - - type: integer - - type: "null" - title: Estimated Start Time - title: JobMetadataOut - type: object - JobsOut: - properties: - data: - default: [] - items: - discriminator: - mapping: - classifier: "#/components/schemas/ClassifierJobOut" - completion: "#/components/schemas/CompletionJobOut" - propertyName: job_type - oneOf: - - $ref: "#/components/schemas/CompletionJobOut" - - $ref: "#/components/schemas/ClassifierJobOut" - title: Data - type: array - object: - default: list - title: Object - type: string - enum: - - list - total: - title: Total - type: integer - required: - - total - title: JobsOut - type: object - WandbIntegrationOut: - properties: - type: - default: wandb - title: Type - type: string - enum: - - wandb - project: - title: Project - type: string - description: The name of the project that the new run will be created under. - name: - anyOf: - - type: string - - type: "null" - title: Name - description: A display name to set for the run. If not set, will use the job ID as the name. - run_name: - anyOf: - - type: string - - type: "null" - title: Run Name - url: - anyOf: - - type: string - - type: "null" - title: Url - required: - - project - title: WandbIntegrationOut - type: object - LegacyJobMetadataOut: - properties: - expected_duration_seconds: - anyOf: - - type: integer - - type: "null" - title: Expected Duration Seconds - description: The approximated time (in seconds) for the fine-tuning process to complete. - examples: - - 220 - cost: - anyOf: - - type: number - - type: "null" - title: Cost - description: The cost of the fine-tuning job. - examples: - - 10 - cost_currency: - anyOf: - - type: string - - type: "null" - title: Cost Currency - description: The currency used for the fine-tuning job cost. - examples: - - EUR - train_tokens_per_step: - anyOf: - - type: integer - - type: "null" - title: Train Tokens Per Step - description: The number of tokens consumed by one training step. - examples: - - 131072 - train_tokens: - anyOf: - - type: integer - - type: "null" - title: Train Tokens - description: The total number of tokens used during the fine-tuning process. - examples: - - 1310720 - data_tokens: - anyOf: - - type: integer - - type: "null" - title: Data Tokens - description: The total number of tokens in the training dataset. - examples: - - 305375 - estimated_start_time: - anyOf: - - type: integer - - type: "null" - title: Estimated Start Time - deprecated: - default: true - title: Deprecated - type: boolean - details: - title: Details - type: string - epochs: - anyOf: - - type: number - - type: "null" - title: Epochs - description: The number of complete passes through the entire training dataset. - examples: - - 4.2922 - training_steps: - anyOf: - - type: integer - - type: "null" - title: Training Steps - description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - examples: - - 10 - object: - default: job.metadata - title: Object - type: string - enum: - - job.metadata - required: - - details - title: LegacyJobMetadataOut - type: object - ClassifierTargetIn: - properties: - name: - title: Name - type: string - labels: - items: - type: string - title: Labels - type: array - weight: - default: 1.0 - minimum: 0 - title: Weight - type: number - loss_function: - anyOf: - - $ref: "#/components/schemas/FTClassifierLossFunction" - - type: "null" - required: - - name - - labels - title: ClassifierTargetIn - type: object - ClassifierTrainingParametersIn: - properties: - training_steps: - anyOf: - - minimum: 1 - type: integer - - type: "null" - title: Training Steps - description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - learning_rate: - default: 0.0001 - maximum: 1 - minimum: 0.00000001 - title: Learning Rate - type: number - description: A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - weight_decay: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.1 - title: Weight Decay - description: (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - warmup_fraction: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.05 - title: Warmup Fraction - description: (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - epochs: - anyOf: - - exclusiveMinimum: 0 - type: number - - type: "null" - title: Epochs - seq_len: - anyOf: - - minimum: 100 - type: integer - - type: "null" - title: Seq Len - title: ClassifierTrainingParametersIn - type: object - description: The fine-tuning hyperparameter settings used in a classifier fine-tune job. - CompletionTrainingParametersIn: - properties: - training_steps: - anyOf: - - minimum: 1 - type: integer - - type: "null" - title: Training Steps - description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset. - learning_rate: - default: 0.0001 - maximum: 1 - minimum: 0.00000001 - title: Learning Rate - type: number - description: A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process. - weight_decay: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.1 - title: Weight Decay - description: (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large. - warmup_fraction: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.05 - title: Warmup Fraction - description: (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune) - epochs: - anyOf: - - exclusiveMinimum: 0 - type: number - - type: "null" - title: Epochs - seq_len: - anyOf: - - minimum: 100 - type: integer - - type: "null" - title: Seq Len - fim_ratio: - anyOf: - - maximum: 1 - minimum: 0 - type: number - - type: "null" - default: 0.9 - title: Fim Ratio - title: CompletionTrainingParametersIn - type: object - description: The fine-tuning hyperparameter settings used in a fine-tune job. - FTClassifierLossFunction: - enum: - - single_class - - multi_class - title: FTClassifierLossFunction - type: string - GithubRepositoryIn: - properties: - type: - default: github - title: Type - type: string - enum: - - github - name: - title: Name - type: string - owner: - title: Owner - type: string - ref: - anyOf: - - type: string - - type: "null" - title: Ref - weight: - default: 1.0 - exclusiveMinimum: 0 - title: Weight - type: number - token: - title: Token - type: string - required: - - name - - owner - - token - title: GithubRepositoryIn - type: object - JobIn: - properties: - model: - $ref: "#/components/schemas/FineTuneableModel" - training_files: - default: [] - items: - $ref: "#/components/schemas/TrainingFile" - title: Training Files - type: array - validation_files: - anyOf: - - items: - format: uuid - type: string - type: array - - type: "null" - title: Validation Files - description: A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files. - suffix: - anyOf: - - maxLength: 18 - type: string - - type: "null" - title: Suffix - description: A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...` - integrations: - anyOf: - - items: - discriminator: - mapping: - wandb: "#/components/schemas/WandbIntegration" - propertyName: type - oneOf: - - $ref: "#/components/schemas/WandbIntegration" - type: array - - type: "null" - title: Integrations - description: A list of integrations to enable for your fine-tuning job. - auto_start: - description: This field will be required in a future release. - title: Auto Start - type: boolean - invalid_sample_skip_percentage: - default: 0 - maximum: 0.5 - minimum: 0 - title: Invalid Sample Skip Percentage - type: number - job_type: - anyOf: - - $ref: "#/components/schemas/FineTuneableModelType" - - type: "null" - hyperparameters: - anyOf: - - $ref: "#/components/schemas/CompletionTrainingParametersIn" - - $ref: "#/components/schemas/ClassifierTrainingParametersIn" - title: Hyperparameters - repositories: - anyOf: - - items: - discriminator: - mapping: - github: "#/components/schemas/GithubRepositoryIn" - propertyName: type - oneOf: - - $ref: "#/components/schemas/GithubRepositoryIn" - type: array - - type: "null" - title: Repositories - classifier_targets: - anyOf: - - items: - $ref: "#/components/schemas/ClassifierTargetIn" - type: array - - type: "null" - title: Classifier Targets - required: - - model - - hyperparameters - title: JobIn - type: object - TrainingFile: - properties: - file_id: - format: uuid - title: File Id - type: string - weight: - default: 1.0 - exclusiveMinimum: 0 - title: Weight - type: number - required: - - file_id - title: TrainingFile - type: object - WandbIntegration: - properties: - type: - default: wandb - title: Type - type: string - enum: - - wandb - project: - title: Project - type: string - description: The name of the project that the new run will be created under. - name: - anyOf: - - type: string - - type: "null" - title: Name - description: A display name to set for the run. If not set, will use the job ID as the name. - api_key: - maxLength: 40 - minLength: 40 - title: Api Key - type: string - description: The WandB API key to use for authentication. - run_name: - anyOf: - - type: string - - type: "null" - title: Run Name - required: - - project - - api_key - title: WandbIntegration - type: object - CheckpointOut: - properties: - metrics: - $ref: "#/components/schemas/MetricOut" - step_number: - title: Step Number - type: integer - description: The step number that the checkpoint was created at. - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) for when the checkpoint was created. - examples: - - 1716963433 - required: - - metrics - - step_number - - created_at - title: CheckpointOut - type: object - ClassifierDetailedJobOut: - properties: - id: - format: uuid - title: Id - type: string - auto_start: - title: Auto Start - type: boolean - model: - $ref: "#/components/schemas/FineTuneableModel" - status: - enum: - - QUEUED - - STARTED - - VALIDATING - - VALIDATED - - RUNNING - - FAILED_VALIDATION - - FAILED - - SUCCESS - - CANCELLED - - CANCELLATION_REQUESTED - title: Status - type: string - created_at: - title: Created At - type: integer - modified_at: - title: Modified At - type: integer - training_files: - items: - format: uuid - type: string - title: Training Files - type: array - validation_files: - anyOf: - - items: - format: uuid - type: string - type: array - - type: "null" - default: [] - title: Validation Files - object: - default: job - title: Object - type: string - enum: - - job - fine_tuned_model: - anyOf: - - type: string - - type: "null" - title: Fine Tuned Model - suffix: - anyOf: - - type: string - - type: "null" - title: Suffix - integrations: - anyOf: - - items: - discriminator: - mapping: - wandb: "#/components/schemas/WandbIntegrationOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/WandbIntegrationOut" - type: array - - type: "null" - title: Integrations - trained_tokens: - anyOf: - - type: integer - - type: "null" - title: Trained Tokens - metadata: - anyOf: - - $ref: "#/components/schemas/JobMetadataOut" - - type: "null" - job_type: - default: classifier - title: Job Type - type: string - enum: - - classifier - hyperparameters: - $ref: "#/components/schemas/ClassifierTrainingParameters" - events: - default: [] - items: - $ref: "#/components/schemas/EventOut" - title: Events - type: array - description: Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - checkpoints: - default: [] - items: - $ref: "#/components/schemas/CheckpointOut" - title: Checkpoints - type: array - classifier_targets: - items: - $ref: "#/components/schemas/ClassifierTargetOut" - title: Classifier Targets - type: array - required: - - id - - auto_start - - model - - status - - created_at - - modified_at - - training_files - - hyperparameters - - classifier_targets - title: ClassifierDetailedJobOut - type: object - ClassifierTargetOut: - properties: - name: - title: Name - type: string - labels: - items: - type: string - title: Labels - type: array - weight: - title: Weight - type: number - loss_function: - $ref: "#/components/schemas/FTClassifierLossFunction" - required: - - name - - labels - - weight - - loss_function - title: ClassifierTargetOut - type: object - CompletionDetailedJobOut: - properties: - id: - format: uuid - title: Id - type: string - auto_start: - title: Auto Start - type: boolean - model: - $ref: "#/components/schemas/FineTuneableModel" - status: - enum: - - QUEUED - - STARTED - - VALIDATING - - VALIDATED - - RUNNING - - FAILED_VALIDATION - - FAILED - - SUCCESS - - CANCELLED - - CANCELLATION_REQUESTED - title: Status - type: string - created_at: - title: Created At - type: integer - modified_at: - title: Modified At - type: integer - training_files: - items: - format: uuid - type: string - title: Training Files - type: array - validation_files: - anyOf: - - items: - format: uuid - type: string - type: array - - type: "null" - default: [] - title: Validation Files - object: - default: job - title: Object - type: string - enum: - - job - fine_tuned_model: - anyOf: - - type: string - - type: "null" - title: Fine Tuned Model - suffix: - anyOf: - - type: string - - type: "null" - title: Suffix - integrations: - anyOf: - - items: - discriminator: - mapping: - wandb: "#/components/schemas/WandbIntegrationOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/WandbIntegrationOut" - type: array - - type: "null" - title: Integrations - trained_tokens: - anyOf: - - type: integer - - type: "null" - title: Trained Tokens - metadata: - anyOf: - - $ref: "#/components/schemas/JobMetadataOut" - - type: "null" - job_type: - default: completion - title: Job Type - type: string - enum: - - completion - hyperparameters: - $ref: "#/components/schemas/CompletionTrainingParameters" - repositories: - default: [] - items: - discriminator: - mapping: - github: "#/components/schemas/GithubRepositoryOut" - propertyName: type - oneOf: - - $ref: "#/components/schemas/GithubRepositoryOut" - title: Repositories - type: array - events: - default: [] - items: - $ref: "#/components/schemas/EventOut" - title: Events - type: array - description: Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here. - checkpoints: - default: [] - items: - $ref: "#/components/schemas/CheckpointOut" - title: Checkpoints - type: array - required: - - id - - auto_start - - model - - status - - created_at - - modified_at - - training_files - - hyperparameters - title: CompletionDetailedJobOut - type: object - EventOut: - properties: - name: - title: Name - type: string - description: The name of the event. - data: - anyOf: - - type: object - additionalProperties: true - - type: "null" - title: Data - created_at: - title: Created At - type: integer - description: The UNIX timestamp (in seconds) of the event. - required: - - name - - created_at - title: EventOut - type: object - MetricOut: - properties: - train_loss: - anyOf: - - type: number - - type: "null" - title: Train Loss - valid_loss: - anyOf: - - type: number - - type: "null" - title: Valid Loss - valid_mean_token_accuracy: - anyOf: - - type: number - - type: "null" - title: Valid Mean Token Accuracy - title: MetricOut - type: object - description: Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase). - ClassifierFTModelOut: - properties: - id: - title: Id - type: string - object: - default: model - title: Object - type: string - enum: - - model - created: - title: Created - type: integer - owned_by: - title: Owned By - type: string - workspace_id: - title: Workspace Id - type: string - root: - title: Root - type: string - root_version: - title: Root Version - type: string - archived: - title: Archived - type: boolean - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - capabilities: - $ref: "#/components/schemas/FTModelCapabilitiesOut" - max_context_length: - default: 32768 - title: Max Context Length - type: integer - aliases: - default: [] - items: - type: string - title: Aliases - type: array - job: - format: uuid - title: Job - type: string - classifier_targets: - items: - $ref: "#/components/schemas/ClassifierTargetOut" - title: Classifier Targets - type: array - model_type: - default: classifier - title: Model Type - type: string - enum: - - classifier - required: - - id - - created - - owned_by - - workspace_id - - root - - root_version - - archived - - capabilities - - job - - classifier_targets - title: ClassifierFTModelOut - type: object - CompletionFTModelOut: - properties: - id: - title: Id - type: string - object: - default: model - title: Object - type: string - enum: - - model - created: - title: Created - type: integer - owned_by: - title: Owned By - type: string - workspace_id: - title: Workspace Id - type: string - root: - title: Root - type: string - root_version: - title: Root Version - type: string - archived: - title: Archived - type: boolean - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - capabilities: - $ref: "#/components/schemas/FTModelCapabilitiesOut" - max_context_length: - default: 32768 - title: Max Context Length - type: integer - aliases: - default: [] - items: - type: string - title: Aliases - type: array - job: - format: uuid - title: Job - type: string - model_type: - default: completion - title: Model Type - type: string - enum: - - completion - required: - - id - - created - - owned_by - - workspace_id - - root - - root_version - - archived - - capabilities - - job - title: CompletionFTModelOut - type: object - FTModelCapabilitiesOut: - properties: - completion_chat: - default: true - title: Completion Chat - type: boolean - completion_fim: - default: false - title: Completion Fim - type: boolean - function_calling: - default: false - title: Function Calling - type: boolean - fine_tuning: - default: false - title: Fine Tuning - type: boolean - classification: - default: false - title: Classification - type: boolean - title: FTModelCapabilitiesOut - type: object - UpdateFTModelIn: - properties: - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - title: UpdateFTModelIn - type: object - ArchiveFTModelOut: - properties: - id: - title: Id - type: string - object: - default: model - title: Object - type: string - enum: - - model - archived: - default: true - title: Archived - type: boolean - required: - - id - title: ArchiveFTModelOut - type: object - UnarchiveFTModelOut: - properties: - id: - title: Id - type: string - object: - default: model - title: Object - type: string - enum: - - model - archived: - default: false - title: Archived - type: boolean - required: - - id - title: UnarchiveFTModelOut - type: object - BatchJobStatus: - enum: - - QUEUED - - RUNNING - - SUCCESS - - FAILED - - TIMEOUT_EXCEEDED - - CANCELLATION_REQUESTED - - CANCELLED - title: BatchJobStatus - type: string - BatchError: - properties: - message: - title: Message - type: string - count: - default: 1 - title: Count - type: integer - required: - - message - title: BatchError - type: object - BatchJobOut: - properties: - id: - title: Id - type: string - object: - default: batch - title: Object - type: string - enum: - - batch - input_files: - items: - format: uuid - type: string - title: Input Files - type: array - metadata: - anyOf: - - type: object - additionalProperties: true - - type: "null" - title: Metadata - endpoint: - title: Endpoint - type: string - model: - anyOf: - - type: string - - type: "null" - title: Model - agent_id: - anyOf: - - type: string - - type: "null" - title: Agent Id - output_file: - anyOf: - - format: uuid - type: string - - type: "null" - title: Output File - error_file: - anyOf: - - format: uuid - type: string - - type: "null" - title: Error File - errors: - items: - $ref: "#/components/schemas/BatchError" - title: Errors - type: array - status: - $ref: "#/components/schemas/BatchJobStatus" - created_at: - title: Created At - type: integer - total_requests: - title: Total Requests - type: integer - completed_requests: - title: Completed Requests - type: integer - succeeded_requests: - title: Succeeded Requests - type: integer - failed_requests: - title: Failed Requests - type: integer - started_at: - anyOf: - - type: integer - - type: "null" - title: Started At - completed_at: - anyOf: - - type: integer - - type: "null" - title: Completed At - required: - - id - - input_files - - endpoint - - errors - - status - - created_at - - total_requests - - completed_requests - - succeeded_requests - - failed_requests - title: BatchJobOut - type: object - BatchJobsOut: - properties: - data: - default: [] - items: - $ref: "#/components/schemas/BatchJobOut" - title: Data - type: array - object: - default: list - title: Object - type: string - enum: - - list - total: - title: Total - type: integer - required: - - total - title: BatchJobsOut - type: object - ApiEndpoint: - title: ApiEndpoint - type: string - enum: - - /v1/chat/completions - - /v1/embeddings - - /v1/fim/completions - - /v1/moderations - - /v1/chat/moderations - BatchJobIn: - properties: - input_files: - items: - format: uuid - type: string - title: Input Files - type: array - endpoint: - $ref: "#/components/schemas/ApiEndpoint" - model: - anyOf: - - type: string - - type: "null" - title: Model - agent_id: - anyOf: - - type: string - - type: "null" - title: Agent Id - metadata: - anyOf: - - additionalProperties: - maxLength: 512 - minLength: 1 - type: string - propertyNames: - maxLength: 32 - minLength: 1 - type: object - - type: "null" - title: Metadata - timeout_hours: - default: 24 - title: Timeout Hours - type: integer - required: - - input_files - - endpoint - title: BatchJobIn - type: object - AssistantMessage: - properties: - content: - title: Content - anyOf: - - type: string - - type: "null" - - items: - $ref: "#/components/schemas/ContentChunk" - type: array - tool_calls: - anyOf: - - items: - $ref: "#/components/schemas/ToolCall" - type: array - - type: "null" - title: Tool Calls - prefix: - type: boolean - title: Prefix - default: false - description: Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. - role: - type: string - default: assistant - title: Role - enum: - - assistant - additionalProperties: false - type: object - title: AssistantMessage - AudioChunk: - properties: - input_audio: - anyOf: - - type: string - - type: string - format: binary - title: Input Audio - type: - type: string - enum: - - input_audio - title: Type - default: input_audio - additionalProperties: false - type: object - required: - - input_audio - title: AudioChunk - ChatCompletionRequest: - properties: - model: - title: Model - type: string - description: ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions. - examples: - - mistral-small-latest - temperature: - anyOf: - - type: number - maximum: 1.5 - minimum: 0 - - type: "null" - title: Temperature - description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - top_p: - type: number - maximum: 1 - minimum: 0 - title: Top P - default: 1.0 - description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - max_tokens: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Max Tokens - description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - stream: - type: boolean - title: Stream - default: false - description: "Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON." - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: Stop - description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - random_seed: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Random Seed - description: The seed to use for random sampling. If set, different calls will generate deterministic results. - messages: - items: - oneOf: - - $ref: "#/components/schemas/SystemMessage" - - $ref: "#/components/schemas/UserMessage" - - $ref: "#/components/schemas/AssistantMessage" - - $ref: "#/components/schemas/ToolMessage" - discriminator: - propertyName: role - mapping: - assistant: "#/components/schemas/AssistantMessage" - system: "#/components/schemas/SystemMessage" - tool: "#/components/schemas/ToolMessage" - user: "#/components/schemas/UserMessage" - type: array - title: Messages - description: The prompt(s) to generate completions for, encoded as a list of dict with role and content. - examples: - - - role: user - content: Who is the best French painter? Answer in one short sentence. - response_format: - $ref: "#/components/schemas/ResponseFormat" - tools: - anyOf: - - items: - $ref: "#/components/schemas/Tool" - type: array - - type: "null" - title: Tools - tool_choice: - anyOf: - - $ref: "#/components/schemas/ToolChoice" - - $ref: "#/components/schemas/ToolChoiceEnum" - title: Tool Choice - default: auto - presence_penalty: - type: number - maximum: 2 - minimum: -2 - title: Presence Penalty - default: 0.0 - description: presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - frequency_penalty: - type: number - maximum: 2 - minimum: -2 - title: Frequency Penalty - default: 0.0 - description: frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - n: - anyOf: - - type: integer - minimum: 1 - - type: "null" - title: N - description: Number of completions to return for each request, input tokens are only billed once. - prediction: - $ref: "#/components/schemas/Prediction" - default: - type: content - content: "" - description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results. - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: true - prompt_mode: - anyOf: - - $ref: "#/components/schemas/MistralPromptMode" - - type: "null" - description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - safe_prompt: - type: boolean - description: Whether to inject a safety prompt before all conversations. - default: false - additionalProperties: false - type: object - required: - - messages - - model - title: ChatCompletionRequest - ChatModerationRequest: - properties: - input: - anyOf: - - items: - oneOf: - - $ref: "#/components/schemas/SystemMessage" - - $ref: "#/components/schemas/UserMessage" - - $ref: "#/components/schemas/AssistantMessage" - - $ref: "#/components/schemas/ToolMessage" - discriminator: - propertyName: role - mapping: - assistant: "#/components/schemas/AssistantMessage" - system: "#/components/schemas/SystemMessage" - tool: "#/components/schemas/ToolMessage" - user: "#/components/schemas/UserMessage" - type: array - - items: - items: - oneOf: - - $ref: "#/components/schemas/SystemMessage" - - $ref: "#/components/schemas/UserMessage" - - $ref: "#/components/schemas/AssistantMessage" - - $ref: "#/components/schemas/ToolMessage" - discriminator: - propertyName: role - mapping: - assistant: "#/components/schemas/AssistantMessage" - system: "#/components/schemas/SystemMessage" - tool: "#/components/schemas/ToolMessage" - user: "#/components/schemas/UserMessage" - type: array - type: array - title: Input - description: Chat to classify - model: - title: Model - type: string - additionalProperties: false - type: object - required: - - input - - model - title: ChatModerationRequest - ClassificationRequest: - properties: - model: - title: Model - description: ID of the model to use. - type: string - input: - anyOf: - - type: string - - items: - type: string - type: array - title: Input - description: Text to classify. - additionalProperties: false - type: object - required: - - input - - model - - model - title: ClassificationRequest - EmbeddingDtype: - type: string - enum: - - float - - int8 - - uint8 - - binary - - ubinary - title: EmbeddingDtype - EmbeddingRequest: - properties: - model: - title: Model - type: string - description: ID of the model to use. - example: mistral-embed - input: - anyOf: - - type: string - - items: - type: string - type: array - title: Input - example: - - Embed this sentence. - - As well as this one. - description: Text to embed. - output_dimension: - anyOf: - - type: integer - exclusiveMinimum: 0 - - type: "null" - title: Output Dimension - description: The dimension of the output embeddings. - output_dtype: - $ref: "#/components/schemas/EmbeddingDtype" - description: The data type of the output embeddings. - default: float - additionalProperties: false - type: object - required: - - input - - model - title: EmbeddingRequest - FIMCompletionRequest: - properties: - model: - title: Model - default: codestral-2405 - type: string - description: "ID of the model to use. Only compatible for now with:\n - `codestral-2405`\n - `codestral-latest`" - examples: - - codestral-2405 - temperature: - anyOf: - - type: number - maximum: 1.5 - minimum: 0 - - type: "null" - title: Temperature - description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. - top_p: - type: number - maximum: 1 - minimum: 0 - title: Top P - default: 1.0 - description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. - max_tokens: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Max Tokens - description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - stream: - type: boolean - title: Stream - default: false - description: "Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON." - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: Stop - description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - random_seed: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Random Seed - description: The seed to use for random sampling. If set, different calls will generate deterministic results. - prompt: - type: string - title: Prompt - description: The text/code to complete. - examples: - - def - suffix: - anyOf: - - type: string - - type: "null" - title: Suffix - default: "" - description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. - examples: - - return a+b - min_tokens: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Min Tokens - description: The minimum number of tokens to generate in the completion. - additionalProperties: false - type: object - required: - - prompt - - model - title: FIMCompletionRequest - FileChunk: - properties: - type: - type: string - const: file - title: Type - default: file - file_id: - type: string - format: uuid - title: File Id - additionalProperties: false - type: object - required: - - file_id - title: FileChunk - FunctionCall: - properties: - name: - type: string - title: Name - arguments: - title: Arguments - anyOf: - - type: object - additionalProperties: true - - type: string - additionalProperties: false - type: object - required: - - name - - arguments - title: FunctionCall - FunctionName: - properties: - name: - type: string - title: Name - additionalProperties: false - type: object - required: - - name - title: FunctionName - description: this restriction of `Function` is used to select a specific function to call - ImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: "null" - title: Detail - additionalProperties: false - type: object - required: - - url - title: ImageURL - InstructRequest: - properties: - messages: - items: - oneOf: - - $ref: "#/components/schemas/SystemMessage" - - $ref: "#/components/schemas/UserMessage" - - $ref: "#/components/schemas/AssistantMessage" - - $ref: "#/components/schemas/ToolMessage" - discriminator: - propertyName: role - mapping: - assistant: "#/components/schemas/AssistantMessage" - system: "#/components/schemas/SystemMessage" - tool: "#/components/schemas/ToolMessage" - user: "#/components/schemas/UserMessage" - type: array - title: Messages - additionalProperties: false - type: object - required: - - messages - title: InstructRequest - MistralPromptMode: - type: string - title: MistralPromptMode - enum: - - reasoning - OCRImageObject: - properties: - id: - type: string - title: Id - description: Image ID for extracted image in a page - top_left_x: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Top Left X - description: X coordinate of top-left corner of the extracted image - top_left_y: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Top Left Y - description: Y coordinate of top-left corner of the extracted image - bottom_right_x: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Bottom Right X - description: X coordinate of bottom-right corner of the extracted image - bottom_right_y: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Bottom Right Y - description: Y coordinate of bottom-right corner of the extracted image - image_base64: - anyOf: - - type: string - - type: "null" - title: Image Base64 - description: Base64 string of the extracted image - image_annotation: - anyOf: - - type: string - - type: "null" - title: Image Annotation - description: Annotation of the extracted image in json str - additionalProperties: false - type: object - required: - - id - - top_left_x - - top_left_y - - bottom_right_x - - bottom_right_y - title: OCRImageObject - OCRPageDimensions: - properties: - dpi: - type: integer - minimum: 0 - title: Dpi - description: Dots per inch of the page-image - height: - type: integer - minimum: 0 - title: Height - description: Height of the image in pixels - width: - type: integer - minimum: 0 - title: Width - description: Width of the image in pixels - additionalProperties: false - type: object - required: - - dpi - - height - - width - title: OCRPageDimensions - OCRPageObject: - properties: - index: - type: integer - minimum: 0 - title: Index - description: The page index in a pdf document starting from 0 - markdown: - type: string - title: Markdown - description: The markdown string response of the page - images: - items: - $ref: "#/components/schemas/OCRImageObject" - type: array - title: Images - description: List of all extracted images in the page - dimensions: - anyOf: - - $ref: "#/components/schemas/OCRPageDimensions" - - type: "null" - description: The dimensions of the PDF Page's screenshot image - additionalProperties: false - type: object - required: - - index - - markdown - - images - - dimensions - title: OCRPageObject - OCRRequest: - properties: - model: - anyOf: - - type: string - - type: "null" - title: Model - id: - type: string - title: Id - document: - anyOf: - - $ref: "#/components/schemas/FileChunk" - - $ref: "#/components/schemas/DocumentURLChunk" - - $ref: "#/components/schemas/ImageURLChunk" - title: Document - description: Document to run OCR on - pages: - anyOf: - - items: - type: integer - type: array - - type: "null" - title: Pages - description: "Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0" - include_image_base64: - anyOf: - - type: boolean - - type: "null" - title: Include Image Base64 - description: Include image URLs in response - image_limit: - anyOf: - - type: integer - - type: "null" - title: Image Limit - description: Max images to extract - image_min_size: - anyOf: - - type: integer - - type: "null" - title: Image Min Size - description: Minimum height and width of image to extract - bbox_annotation_format: - anyOf: - - $ref: "#/components/schemas/ResponseFormat" - - type: "null" - description: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field - document_annotation_format: - anyOf: - - $ref: "#/components/schemas/ResponseFormat" - - type: "null" - description: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field - additionalProperties: false - type: object - required: - - document - - model - title: OCRRequest - OCRResponse: - properties: - pages: - items: - $ref: "#/components/schemas/OCRPageObject" - type: array - title: Pages - description: List of OCR info for pages. - model: - type: string - title: Model - description: The model used to generate the OCR. - document_annotation: - anyOf: - - type: string - - type: "null" - title: Document Annotation - description: Formatted response in the request_format if provided in json str - usage_info: - $ref: "#/components/schemas/OCRUsageInfo" - description: Usage info for the OCR request. - additionalProperties: false - type: object - required: - - pages - - model - - usage_info - title: OCRResponse - OCRUsageInfo: - properties: - pages_processed: - type: integer - minimum: 0 - title: Pages Processed - description: Number of pages processed - doc_size_bytes: - anyOf: - - type: integer - - type: "null" - title: Doc Size Bytes - description: Document size in bytes - additionalProperties: false - type: object - required: - - pages_processed - title: OCRUsageInfo - ReferenceChunk: - properties: - reference_ids: - items: - type: integer - type: array - title: Reference Ids - type: - type: string - enum: - - reference - title: Type - default: reference - additionalProperties: false - type: object - required: - - reference_ids - title: ReferenceChunk - SystemMessage: - properties: - content: - anyOf: - - type: string - - items: - $ref: "#/components/schemas/TextChunk" - type: array - title: Content - role: - type: string - default: system - enum: - - system - additionalProperties: false - type: object - required: - - content - title: SystemMessage - ThinkChunk: - properties: - thinking: - items: - anyOf: - - $ref: "#/components/schemas/ReferenceChunk" - - $ref: "#/components/schemas/TextChunk" - type: array - title: Thinking - closed: - type: boolean - title: Closed - description: Whether the thinking chunk is closed or not. Currently only used for prefixing. - default: true - type: - type: string - enum: - - thinking - title: Type - default: thinking - additionalProperties: false - type: object - required: - - thinking - title: ThinkChunk - Tool: - properties: - type: - $ref: "#/components/schemas/ToolTypes" - default: function - function: - $ref: "#/components/schemas/Function" - additionalProperties: false - type: object - required: - - function - title: Tool - ToolCall: - properties: - id: - type: string - title: Id - default: "null" - type: - $ref: "#/components/schemas/ToolTypes" - default: function - function: - $ref: "#/components/schemas/FunctionCall" - index: - type: integer - title: Index - default: 0 - additionalProperties: false - type: object - required: - - function - title: ToolCall - ToolChoice: - properties: - type: - $ref: "#/components/schemas/ToolTypes" - default: function - function: - $ref: "#/components/schemas/FunctionName" - additionalProperties: false - type: object - required: - - function - title: ToolChoice - description: ToolChoice is either a ToolChoiceEnum or a ToolChoice - ToolMessage: - properties: - content: - title: Content - anyOf: - - type: string - - type: "null" - - items: - $ref: "#/components/schemas/ContentChunk" - type: array - tool_call_id: - anyOf: - - type: string - - type: "null" - title: Tool Call Id - name: - anyOf: - - type: string - - type: "null" - title: Name - role: - type: string - default: tool - enum: - - tool - additionalProperties: false - type: object - required: - - content - title: ToolMessage - ToolTypes: - type: string - enum: - - function - title: ToolTypes - TranscriptionResponse: - properties: - model: - type: string - title: Model - text: - type: string - title: Text - language: - anyOf: - - type: string - pattern: ^\w{2}$ - - type: "null" - title: Language - segments: - items: - $ref: "#/components/schemas/TranscriptionSegmentChunk" - type: array - title: Segments - usage: - $ref: "#/components/schemas/UsageInfo" - additionalProperties: false - type: object - required: - - model - - text - - language - - usage - title: TranscriptionResponse - TranscriptionSegmentChunk: - properties: - text: - type: string - title: Text - start: - type: number - title: Start - end: - type: number - title: End - type: - type: string - default: transcription_segment - enum: - - transcription_segment - additionalProperties: false - type: object - required: - - text - - start - - end - title: TranscriptionSegmentChunk - UsageInfo: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - default: 0 - completion_tokens: - title: Completion Tokens - default: 0 - type: integer - total_tokens: - type: integer - title: Total Tokens - default: 0 - prompt_audio_seconds: - anyOf: - - type: integer - - type: "null" - title: Prompt Audio Seconds - additionalProperties: false - type: object - title: UsageInfo - required: - - prompt_tokens - - completion_tokens - - total_tokens - UserMessage: - properties: - content: - title: Content - anyOf: - - type: string - - type: "null" - - items: - $ref: "#/components/schemas/ContentChunk" - type: array - role: - type: string - default: user - enum: - - user - additionalProperties: false - type: object - required: - - content - title: UserMessage - File: - type: string - format: binary - title: File - description: "The File object (not file name) to be uploaded.\n To upload a file and specify a custom file name you should format your request as such:\n ```bash\n file=@path/to/your/file.jsonl;filename=custom_name.jsonl\n ```\n Otherwise, you can just keep the original file name:\n ```bash\n file=@path/to/your/file.jsonl\n ```" - TimestampGranularity: - type: string - enum: - - segment - title: TimestampGranularity - AudioTranscriptionRequest: - properties: - model: - title: Model - type: string - file: - anyOf: - - $ref: "#/components/schemas/File" - - type: "null" - default: - title: File - file_url: - anyOf: - - format: uri - maxLength: 2083 - minLength: 1 - type: string - - type: "null" - default: - description: Url of a file to be transcribed - title: File Url - file_id: - anyOf: - - type: string - - type: "null" - default: - description: ID of a file uploaded to /v1/files - title: File Id - language: - anyOf: - - pattern: ^\w{2}$ - type: string - - type: "null" - default: - description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - title: Language - temperature: - anyOf: - - type: number - - type: "null" - default: - title: Temperature - stream: - const: false - default: false - title: Stream - type: boolean - timestamp_granularities: - description: Granularities of timestamps to include in the response. - items: - $ref: "#/components/schemas/TimestampGranularity" - title: Timestamp Granularities - type: array - required: - - model - title: AudioTranscriptionRequest - type: object - AudioTranscriptionRequestStream: - properties: - model: - title: Model - type: string - file: - anyOf: - - $ref: "#/components/schemas/File" - - type: "null" - default: - title: File - file_url: - anyOf: - - format: uri - maxLength: 2083 - minLength: 1 - type: string - - type: "null" - default: - description: Url of a file to be transcribed - title: File Url - file_id: - anyOf: - - type: string - - type: "null" - default: - description: ID of a file uploaded to /v1/files - title: File Id - language: - anyOf: - - pattern: ^\w{2}$ - type: string - - type: "null" - default: - description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy. - title: Language - temperature: - anyOf: - - type: number - - type: "null" - default: - title: Temperature - stream: - const: true - default: true - title: Stream - type: boolean - timestamp_granularities: - description: Granularities of timestamps to include in the response. - items: - $ref: "#/components/schemas/TimestampGranularity" - title: Timestamp Granularities - type: array - required: - - model - title: AudioTranscriptionRequestStream - type: object - TranscriptionStreamLanguage: - additionalProperties: false - properties: - audio_language: - pattern: ^\w{2}$ - title: Audio Language - type: string - type: - type: string - default: transcription.language - enum: - - transcription.language - required: - - audio_language - title: TranscriptionStreamLanguage - type: object - TranscriptionStreamSegmentDelta: - additionalProperties: false - properties: - text: - title: Text - type: string - start: - title: Start - type: number - end: - title: End - type: number - type: - type: string - default: transcription.segment - enum: - - transcription.segment - required: - - text - - start - - end - title: TranscriptionStreamSegmentDelta - type: object - TranscriptionStreamTextDelta: - additionalProperties: false - properties: - text: - title: Text - type: string - type: - type: string - default: transcription.text.delta - enum: - - transcription.text.delta - required: - - text - title: TranscriptionStreamTextDelta - type: object - TranscriptionStreamDone: - additionalProperties: false - properties: - model: - title: Model - type: string - text: - title: Text - type: string - language: - anyOf: - - pattern: ^\w{2}$ - type: string - - type: "null" - title: Language - segments: - items: - $ref: "#/components/schemas/TranscriptionSegmentChunk" - title: Segments - type: array - usage: - $ref: "#/components/schemas/UsageInfo" - type: - type: string - default: transcription.done - enum: - - transcription.done - required: - - model - - text - - language - - usage - title: TranscriptionStreamDone - type: object - TranscriptionStreamEvents: - additionalProperties: false - properties: - event: - $ref: "#/components/schemas/TranscriptionStreamEventTypes" - data: - discriminator: - mapping: - transcription.done: "#/components/schemas/TranscriptionStreamDone" - transcription.language: "#/components/schemas/TranscriptionStreamLanguage" - transcription.segment: "#/components/schemas/TranscriptionStreamSegmentDelta" - transcription.text.delta: "#/components/schemas/TranscriptionStreamTextDelta" - propertyName: type - oneOf: - - $ref: "#/components/schemas/TranscriptionStreamTextDelta" - - $ref: "#/components/schemas/TranscriptionStreamLanguage" - - $ref: "#/components/schemas/TranscriptionStreamSegmentDelta" - - $ref: "#/components/schemas/TranscriptionStreamDone" - title: Data - required: - - event - - data - title: TranscriptionStreamEvents - type: object - TranscriptionStreamEventTypes: - enum: - - transcription.language - - transcription.segment - - transcription.text.delta - - transcription.done - title: TranscriptionStreamEventTypes - type: string - AgentsCompletionRequest: - properties: - max_tokens: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Max Tokens - description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. - stream: - type: boolean - title: Stream - default: false - description: "Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON." - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: Stop - description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array - random_seed: - anyOf: - - type: integer - minimum: 0 - - type: "null" - title: Random Seed - description: The seed to use for random sampling. If set, different calls will generate deterministic results. - messages: - items: - oneOf: - - $ref: "#/components/schemas/SystemMessage" - - $ref: "#/components/schemas/UserMessage" - - $ref: "#/components/schemas/AssistantMessage" - - $ref: "#/components/schemas/ToolMessage" - discriminator: - propertyName: role - mapping: - assistant: "#/components/schemas/AssistantMessage" - system: "#/components/schemas/SystemMessage" - tool: "#/components/schemas/ToolMessage" - user: "#/components/schemas/UserMessage" - type: array - title: Messages - description: The prompt(s) to generate completions for, encoded as a list of dict with role and content. - examples: - - - role: user - content: Who is the best French painter? Answer in one short sentence. - response_format: - $ref: "#/components/schemas/ResponseFormat" - tools: - anyOf: - - items: - $ref: "#/components/schemas/Tool" - type: array - - type: "null" - title: Tools - tool_choice: - anyOf: - - $ref: "#/components/schemas/ToolChoice" - - $ref: "#/components/schemas/ToolChoiceEnum" - title: Tool Choice - default: auto - presence_penalty: - type: number - maximum: 2 - minimum: -2 - title: Presence Penalty - default: 0.0 - description: presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. - frequency_penalty: - type: number - maximum: 2 - minimum: -2 - title: Frequency Penalty - default: 0.0 - description: frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. - n: - anyOf: - - type: integer - minimum: 1 - - type: "null" - title: N - description: Number of completions to return for each request, input tokens are only billed once. - prediction: - $ref: "#/components/schemas/Prediction" - default: - type: content - content: "" - description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results. - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: true - prompt_mode: - anyOf: - - $ref: "#/components/schemas/MistralPromptMode" - - type: "null" - description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. - agent_id: - type: string - description: The ID of the agent to use for this completion. - additionalProperties: false - type: object - required: - - messages - - agent_id - title: AgentsCompletionRequest - ClassificationResponse: - type: object - title: ClassificationResponse - properties: - id: - type: string - example: mod-e5cc70bb28c444948073e77776eb30ef - model: - type: string - results: - type: array - items: - type: object - title: ClassificationTargetResult - additionalProperties: - $ref: "#/components/schemas/ClassificationTargetResult" - required: - - id - - model - - results - ClassificationTargetResult: - type: object - title: ClassificationTargetResult - properties: - scores: - type: object - title: ClassifierTargetResultScores - additionalProperties: - type: number - required: - - scores - ModerationResponse: - type: object - title: ModerationResponse - properties: - id: - type: string - example: mod-e5cc70bb28c444948073e77776eb30ef - model: - type: string - results: - type: array - items: - $ref: "#/components/schemas/ModerationObject" - required: - - id - - model - - results - ModerationObject: - type: object - title: ModerationObject - properties: - categories: - description: Moderation result thresholds - type: object - additionalProperties: - type: boolean - category_scores: - description: Moderation result - type: object - additionalProperties: - type: number - ContentChunk: - oneOf: - - $ref: "#/components/schemas/TextChunk" - - $ref: "#/components/schemas/ImageURLChunk" - - $ref: "#/components/schemas/DocumentURLChunk" - - $ref: "#/components/schemas/ReferenceChunk" - - $ref: "#/components/schemas/FileChunk" - - $ref: "#/components/schemas/ThinkChunk" - - $ref: "#/components/schemas/AudioChunk" - discriminator: - propertyName: type - mapping: - image_url: "#/components/schemas/ImageURLChunk" - document_url: "#/components/schemas/DocumentURLChunk" - text: "#/components/schemas/TextChunk" - reference: "#/components/schemas/ReferenceChunk" - file: "#/components/schemas/FileChunk" - thinking: "#/components/schemas/ThinkChunk" - input_audio: "#/components/schemas/AudioChunk" - title: ContentChunk - ChatClassificationRequest: - properties: - model: - title: Model - type: string - input: - $ref: "#/components/schemas/ChatClassificationRequestInputs" - additionalProperties: false - type: object - required: - - input - - model - title: ChatClassificationRequest - ChatClassificationRequestInputs: - anyOf: - - $ref: "#/components/schemas/InstructRequest" - - items: - $ref: "#/components/schemas/InstructRequest" - type: array - title: ChatClassificationRequestInputs - description: Chat to classify - DocumentOut: - properties: - id: - type: string - format: uuid - title: Id - library_id: - type: string - format: uuid - title: Library Id - hash: - type: string - title: Hash - mime_type: - type: string - title: Mime Type - extension: - type: string - title: Extension - size: - type: integer - title: Size - name: - type: string - title: Name - summary: - anyOf: - - type: string - - type: "null" - title: Summary - created_at: - type: string - format: date-time - title: Created At - last_processed_at: - anyOf: - - type: string - format: date-time - - type: "null" - title: Last Processed At - number_of_pages: - anyOf: - - type: integer - - type: "null" - title: Number Of Pages - processing_status: - type: string - uploaded_by_id: - type: string - format: uuid - title: Uploaded By Id - uploaded_by_type: - type: string - tokens_processing_main_content: - anyOf: - - type: integer - - type: "null" - title: Tokens Processing Main Content - tokens_processing_summary: - anyOf: - - type: integer - - type: "null" - title: Tokens Processing Summary - tokens_processing_total: - type: integer - title: Tokens Processing Total - readOnly: true - type: object - required: - - id - - library_id - - hash - - mime_type - - extension - - size - - name - - created_at - - processing_status - - uploaded_by_id - - uploaded_by_type - - tokens_processing_total - title: DocumentOut - DocumentTextContent: - properties: - text: - type: string - title: Text - type: object - required: - - text - title: DocumentTextContent - DocumentUpdateIn: - properties: - name: - anyOf: - - type: string - - type: "null" - title: Name - type: object - title: DocumentUpdateIn - LibraryIn: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - chunk_size: - anyOf: - - type: integer - - type: "null" - title: Chunk Size - type: object - required: - - name - title: LibraryIn - LibraryInUpdate: - properties: - name: - anyOf: - - type: string - - type: "null" - title: Name - description: - anyOf: - - type: string - - type: "null" - title: Description - type: object - title: LibraryInUpdate - LibraryOut: - properties: - id: - type: string - format: uuid - title: Id - name: - type: string - title: Name - created_at: - type: string - format: date-time - title: Created At - updated_at: - type: string - format: date-time - title: Updated At - owner_id: - type: string - format: uuid - title: Owner Id - owner_type: - type: string - total_size: - type: integer - title: Total Size - nb_documents: - type: integer - title: Nb Documents - chunk_size: - anyOf: - - type: integer - - type: "null" - title: Chunk Size - emoji: - anyOf: - - type: string - - type: "null" - title: Emoji - description: - anyOf: - - type: string - - type: "null" - title: Description - generated_name: - anyOf: - - type: string - - type: "null" - title: Generated Name - generated_description: - anyOf: - - type: string - - type: "null" - title: Generated Description - explicit_user_members_count: - anyOf: - - type: integer - - type: "null" - title: Explicit User Members Count - explicit_workspace_members_count: - anyOf: - - type: integer - - type: "null" - title: Explicit Workspace Members Count - org_sharing_role: - anyOf: - - type: string - - type: "null" - type: object - required: - - id - - name - - created_at - - updated_at - - owner_id - - owner_type - - total_size - - nb_documents - - chunk_size - title: LibraryOut - ListDocumentOut: - properties: - pagination: - $ref: "#/components/schemas/PaginationInfo" - data: - items: - $ref: "#/components/schemas/DocumentOut" - type: array - title: Data - type: object - required: - - pagination - - data - title: ListDocumentOut - ListLibraryOut: - properties: - data: - items: - $ref: "#/components/schemas/LibraryOut" - type: array - title: Data - type: object - required: - - data - title: ListLibraryOut - ListSharingOut: - properties: - data: - items: - $ref: "#/components/schemas/SharingOut" - type: array - title: Data - type: object - required: - - data - title: ListSharingOut - PaginationInfo: - properties: - total_items: - type: integer - title: Total Items - total_pages: - type: integer - title: Total Pages - current_page: - type: integer - title: Current Page - page_size: - type: integer - title: Page Size - has_more: - type: boolean - title: Has More - type: object - required: - - total_items - - total_pages - - current_page - - page_size - - has_more - title: PaginationInfo - ProcessingStatusOut: - properties: - document_id: - type: string - format: uuid - title: Document Id - processing_status: - type: string - type: object - required: - - document_id - - processing_status - title: ProcessingStatusOut - ShareEnum: - type: string - enum: - - Viewer - - Editor - title: ShareEnum - x-speakeasy-unknown-values: allow - SharingDelete: - properties: - org_id: - type: string - format: uuid - title: Org Id - share_with_uuid: - type: string - format: uuid - description: The id of the entity (user, workspace or organization) to share with - share_with_type: - $ref: "#/components/schemas/EntityType" - type: object - title: SharingDelete - required: - - share_with_uuid - - share_with_type - - org_id - - level - SharingIn: - properties: - org_id: - type: string - format: uuid - title: Org Id - level: - $ref: "#/components/schemas/ShareEnum" - share_with_uuid: - type: string - format: uuid - description: The id of the entity (user, workspace or organization) to share with - share_with_type: - $ref: "#/components/schemas/EntityType" - type: object - title: SharingIn - required: - - share_with_uuid - - share_with_type - - org_id - - level - SharingOut: - properties: - library_id: - type: string - format: uuid - title: Library Id - user_id: - anyOf: - - type: string - format: uuid - - type: "null" - title: User Id - org_id: - type: string - format: uuid - title: Org Id - role: - type: string - share_with_type: - type: string - share_with_uuid: - type: string - format: uuid - title: Share With Uuid - type: object - required: - - library_id - - org_id - - role - - share_with_type - - share_with_uuid - title: SharingOut - EntityType: - type: string - title: EntityType - description: The type of entity, used to share a library. - enum: - - User - - Workspace - - Org - x-speakeasy-unknown-values: allow - CompletionEvent: - title: CompletionEvent - type: object - required: - - data - properties: - data: - $ref: "#/components/schemas/CompletionChunk" - CompletionChunk: - title: CompletionChunk - type: object - required: - - id - - model - - choices - properties: - id: - type: string - object: - type: string - created: - type: integer - model: - type: string - usage: - $ref: "#/components/schemas/UsageInfo" - choices: - type: array - items: - $ref: "#/components/schemas/CompletionResponseStreamChoice" - CompletionResponseStreamChoice: - title: CompletionResponseStreamChoice - type: object - required: - - index - - delta - - finish_reason - properties: - index: - type: integer - delta: - $ref: "#/components/schemas/DeltaMessage" - finish_reason: - type: - - string - - "null" - enum: - - stop - - length - - error - - tool_calls - - null - ResponseBase: - type: object - title: ResponseBase - properties: - id: - type: string - example: cmpl-e5cc70bb28c444948073e77776eb30ef - object: - type: string - example: chat.completion - model: - type: string - example: mistral-small-latest - usage: - $ref: "#/components/schemas/UsageInfo" - ChatCompletionChoice: - title: ChatCompletionChoice - type: object - required: - - index - - finish_reason - - message - properties: - index: - type: integer - example: 0 - message: - $ref: "#/components/schemas/AssistantMessage" - finish_reason: - type: string - enum: - - stop - - length - - model_length - - error - - tool_calls - example: stop - DeltaMessage: - title: DeltaMessage - type: object - properties: - role: - anyOf: - - type: string - - type: "null" - content: - anyOf: - - type: string - - type: "null" - - items: - $ref: "#/components/schemas/ContentChunk" - type: array - tool_calls: - anyOf: - - type: "null" - - type: array - items: - $ref: "#/components/schemas/ToolCall" - ChatCompletionResponseBase: - allOf: - - $ref: "#/components/schemas/ResponseBase" - - type: object - title: ChatCompletionResponseBase - properties: - created: - type: integer - example: 1702256327 - ChatCompletionResponse: - allOf: - - $ref: "#/components/schemas/ChatCompletionResponseBase" - - type: object - title: ChatCompletionResponse - properties: - choices: - type: array - items: - $ref: "#/components/schemas/ChatCompletionChoice" - required: - - id - - object - - data - - model - - usage - - created - - choices - FIMCompletionResponse: - allOf: - - $ref: "#/components/schemas/ChatCompletionResponse" - - type: object - properties: - model: - type: string - example: codestral-latest - EmbeddingResponseData: - title: EmbeddingResponseData - type: object - properties: - object: - type: string - example: embedding - embedding: - type: array - items: - type: number - example: - - 0.1 - - 0.2 - - 0.3 - index: - type: integer - example: 0 - examples: - - object: embedding - embedding: - - 0.1 - - 0.2 - - 0.3 - index: 0 - - object: embedding - embedding: - - 0.4 - - 0.5 - - 0.6 - index: 1 - EmbeddingResponse: - allOf: - - $ref: "#/components/schemas/ResponseBase" - - type: object - properties: - data: - type: array - items: - - $ref: "#/components/schemas/EmbeddingResponseData" - required: - - id - - object - - data - - model - - usage - securitySchemes: - ApiKey: - type: http - scheme: bearer -tags: - - name: chat - x-displayName: Chat - description: Chat Completion API. - - name: fim - x-displayName: FIM - description: Fill-in-the-middle API. - - name: agents - x-displayName: Agents - description: Agents API. - - name: embeddings - x-displayName: Embeddings - description: Embeddings API. - - name: classifiers - x-displayName: Classifiers - description: Classifiers API. - - name: files - x-displayName: Files - description: Files API - - name: fine-tuning - x-displayName: Fine Tuning - description: Fine-tuning API - - name: models - x-displayName: Models - description: Model Management API - - name: batch - x-displayName: Batch - description: Batch API - - name: ocr - x-displayName: OCR API - description: OCR API - - name: audio.transcriptions - x-displayName: Transcriptions API - description: API for audio transcription. - - name: beta.agents - x-displayName: (beta) Agents API - description: (beta) Agents API - - name: beta.conversations - x-displayName: (beta) Conversations API - description: (beta) Conversations API - - name: beta.libraries - x-displayName: (beta) Libraries API - Main - description: (beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - - name: beta.libraries.documents - x-displayName: (beta) Libraries API - Documents - description: (beta) Libraries API - manage documents in a library. - - name: beta.libraries.accesses - x-displayName: (beta) Libraries API - Access - description: (beta) Libraries API - manage access to a library. -security: - - ApiKey: [] -servers: - - url: https://api.mistral.ai - description: Production server diff --git a/examples/specs/pokeapi.yml b/examples/specs/pokeapi.yml deleted file mode 100644 index 9f1bf5f97..000000000 --- a/examples/specs/pokeapi.yml +++ /dev/null @@ -1,9433 +0,0 @@ -openapi: 3.1.0 -info: - title: PokéAPI - version: 2.7.0 - description: "All the Pokémon data you'll ever need in one place, easily accessible\ - \ through a modern free open-source RESTful API.\n\n## What is this?\n\nThis is\ - \ a full RESTful API linked to an extensive database detailing everything about\ - \ the Pokémon main game series.\n\nWe've covered everything from Pokémon to Berry\ - \ Flavors.\n\n## Where do I start?\n\nWe have awesome [documentation](https://pokeapi.co/docs/v2)\ - \ on how to use this API. It takes minutes to get started.\n\nThis API will always\ - \ be publicly available and will never require any extensive setup process to\ - \ consume.\n\nCreated by [**Paul Hallett**](https://github.com/phalt) and other\ - \ [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing)\ - \ around the world. Pokémon and Pokémon character names are trademarks of Nintendo.\n\ - \ " -paths: - /api/v2/ability/: - get: - operationId: api_v2_ability_list - description: Abilities provide passive effects for Pokémon in battle or in the - overworld. Pokémon have multiple possible abilities but can have only one - ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) - for greater detail. - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedAbilitySummaryList' - description: '' - /api/v2/ability/{id}/: - get: - operationId: api_v2_ability_retrieve - description: Abilities provide passive effects for Pokémon in battle or in the - overworld. Pokémon have multiple possible abilities but can have only one - ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) - for greater detail. - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AbilityDetail' - description: '' - /api/v2/berry/: - get: - operationId: api_v2_berry_list - description: Berries are small fruits that can provide HP and status condition - restoration, stat enhancement, and even damage negation when eaten by Pokémon. - Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater - detail. - summary: List berries - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedBerrySummaryList' - description: '' - /api/v2/berry/{id}/: - get: - operationId: api_v2_berry_retrieve - description: Berries are small fruits that can provide HP and status condition - restoration, stat enhancement, and even damage negation when eaten by Pokémon. - Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater - detail. - summary: Get a berry - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BerryDetail' - description: '' - /api/v2/berry-firmness/: - get: - operationId: api_v2_berry_firmness_list - description: Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) - for greater detail. - summary: List berry firmness - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedBerryFirmnessSummaryList' - description: '' - /api/v2/berry-firmness/{id}/: - get: - operationId: api_v2_berry_firmness_retrieve - description: Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) - for greater detail. - summary: Get berry by firmness - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BerryFirmnessDetail' - description: '' - /api/v2/berry-flavor/: - get: - operationId: api_v2_berry_flavor_list - description: Flavors determine whether a Pokémon will benefit or suffer from - eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) - for greater detail. - summary: List berry flavors - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedBerryFlavorSummaryList' - description: '' - /api/v2/berry-flavor/{id}/: - get: - operationId: api_v2_berry_flavor_retrieve - description: Flavors determine whether a Pokémon will benefit or suffer from - eating a berry based on their **nature**. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) - for greater detail. - summary: Get berries by flavor - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - berries - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BerryFlavorDetail' - description: '' - /api/v2/characteristic/: - get: - operationId: api_v2_characteristic_list - description: Characteristics indicate which stat contains a Pokémon's highest - IV. A Pokémon's Characteristic is determined by the remainder of its highest - IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) - for greater detail. - summary: List charecterictics - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedCharacteristicSummaryList' - description: '' - /api/v2/characteristic/{id}/: - get: - operationId: api_v2_characteristic_retrieve - description: Characteristics indicate which stat contains a Pokémon's highest - IV. A Pokémon's Characteristic is determined by the remainder of its highest - IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) - for greater detail. - summary: Get characteristic - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CharacteristicDetail' - description: '' - /api/v2/contest-type/: - get: - operationId: api_v2_contest_type_list - description: Contest types are categories judges used to weigh a Pokémon's condition - in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) - for greater detail. - summary: List contest types - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedContestTypeSummaryList' - description: '' - /api/v2/contest-type/{id}/: - get: - operationId: api_v2_contest_type_retrieve - description: Contest types are categories judges used to weigh a Pokémon's condition - in Pokémon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) - for greater detail. - summary: Get contest type - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ContestTypeDetail' - description: '' - /api/v2/contest-effect/: - get: - operationId: api_v2_contest_effect_list - description: Contest effects refer to the effects of moves when used in contests. - summary: List contest effects - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedContestEffectSummaryList' - description: '' - /api/v2/contest-effect/{id}/: - get: - operationId: api_v2_contest_effect_retrieve - description: Contest effects refer to the effects of moves when used in contests. - summary: Get contest effect - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ContestEffectDetail' - description: '' - /api/v2/egg-group/: - get: - operationId: api_v2_egg_group_list - description: Egg Groups are categories which determine which Pokémon are able - to interbreed. Pokémon may belong to either one or two Egg Groups. Check out - [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater - detail. - summary: List egg groups - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEggGroupSummaryList' - description: '' - /api/v2/egg-group/{id}/: - get: - operationId: api_v2_egg_group_retrieve - description: Egg Groups are categories which determine which Pokémon are able - to interbreed. Pokémon may belong to either one or two Egg Groups. Check out - [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater - detail. - summary: Get egg group - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EggGroupDetail' - description: '' - /api/v2/encounter-method/: - get: - operationId: api_v2_encounter_method_list - description: Methods by which the player might can encounter Pokémon in the - wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - summary: List encounter methods - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEncounterMethodSummaryList' - description: '' - /api/v2/encounter-method/{id}/: - get: - operationId: api_v2_encounter_method_retrieve - description: Methods by which the player might can encounter Pokémon in the - wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail. - summary: Get encounter method - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EncounterMethodDetail' - description: '' - /api/v2/encounter-condition/: - get: - operationId: api_v2_encounter_condition_list - description: Conditions which affect what pokemon might appear in the wild, - e.g., day or night. - summary: List encounter conditions - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEncounterConditionSummaryList' - description: '' - /api/v2/encounter-condition/{id}/: - get: - operationId: api_v2_encounter_condition_retrieve - description: Conditions which affect what pokemon might appear in the wild, - e.g., day or night. - summary: Get encounter condition - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EncounterConditionDetail' - description: '' - /api/v2/encounter-condition-value/: - get: - operationId: api_v2_encounter_condition_value_list - description: Encounter condition values are the various states that an encounter - condition can have, i.e., time of day can be either day or night. - summary: List encounter condition values - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEncounterConditionValueSummaryList' - description: '' - /api/v2/encounter-condition-value/{id}/: - get: - operationId: api_v2_encounter_condition_value_retrieve - description: Encounter condition values are the various states that an encounter - condition can have, i.e., time of day can be either day or night. - summary: Get encounter condition value - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EncounterConditionValueDetail' - description: '' - /api/v2/evolution-chain/: - get: - operationId: api_v2_evolution_chain_list - description: Evolution chains are essentially family trees. They start with - the lowest stage within a family and detail evolution conditions for each - as well as Pokémon they can evolve into up through the hierarchy. - summary: List evolution chains - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - evolution - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEvolutionChainSummaryList' - description: '' - /api/v2/evolution-chain/{id}/: - get: - operationId: api_v2_evolution_chain_retrieve - description: Evolution chains are essentially family trees. They start with - the lowest stage within a family and detail evolution conditions for each - as well as Pokémon they can evolve into up through the hierarchy. - summary: Get evolution chain - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - evolution - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EvolutionChainDetail' - description: '' - /api/v2/evolution-trigger/: - get: - operationId: api_v2_evolution_trigger_list - description: Evolution triggers are the events and conditions that cause a Pokémon - to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) - for greater detail. - summary: List evolution triggers - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - evolution - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEvolutionTriggerSummaryList' - description: '' - /api/v2/evolution-trigger/{id}/: - get: - operationId: api_v2_evolution_trigger_retrieve - description: Evolution triggers are the events and conditions that cause a Pokémon - to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) - for greater detail. - summary: Get evolution trigger - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - evolution - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EvolutionTriggerDetail' - description: '' - /api/v2/generation/: - get: - operationId: api_v2_generation_list - description: A generation is a grouping of the Pokémon games that separates - them based on the Pokémon they include. In each generation, a new set of Pokémon, - Moves, Abilities and Types that did not exist in the previous generation are - released. - summary: List genrations - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedGenerationSummaryList' - description: '' - /api/v2/generation/{id}/: - get: - operationId: api_v2_generation_retrieve - description: A generation is a grouping of the Pokémon games that separates - them based on the Pokémon they include. In each generation, a new set of Pokémon, - Moves, Abilities and Types that did not exist in the previous generation are - released. - summary: Get genration - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GenerationDetail' - description: '' - /api/v2/gender/: - get: - operationId: api_v2_gender_list - description: Genders were introduced in Generation II for the purposes of breeding - Pokémon but can also result in visual differences or even different evolutionary - lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) - for greater detail. - summary: List genders - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedGenderSummaryList' - description: '' - /api/v2/gender/{id}/: - get: - operationId: api_v2_gender_retrieve - description: Genders were introduced in Generation II for the purposes of breeding - Pokémon but can also result in visual differences or even different evolutionary - lines. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Gender) - for greater detail. - summary: Get gender - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GenderDetail' - description: '' - /api/v2/growth-rate/: - get: - operationId: api_v2_growth_rate_list - description: Growth rates are the speed with which Pokémon gain levels through - experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) - for greater detail. - summary: List growth rates - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedGrowthRateSummaryList' - description: '' - /api/v2/growth-rate/{id}/: - get: - operationId: api_v2_growth_rate_retrieve - description: Growth rates are the speed with which Pokémon gain levels through - experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) - for greater detail. - summary: Get growth rate - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GrowthRateDetail' - description: '' - /api/v2/item/: - get: - operationId: api_v2_item_list - description: An item is an object in the games which the player can pick up, - keep in their bag, and use in some manner. They have various uses, including - healing, powering up, helping catch Pokémon, or to access a new area. - summary: List items - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedItemSummaryList' - description: '' - /api/v2/item/{id}/: - get: - operationId: api_v2_item_retrieve - description: An item is an object in the games which the player can pick up, - keep in their bag, and use in some manner. They have various uses, including - healing, powering up, helping catch Pokémon, or to access a new area. - summary: Get item - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemDetail' - description: '' - /api/v2/item-category/: - get: - operationId: api_v2_item_category_list - description: Item categories determine where items will be placed in the players - bag. - summary: List item categories - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedItemCategorySummaryList' - description: '' - /api/v2/item-category/{id}/: - get: - operationId: api_v2_item_category_retrieve - description: Item categories determine where items will be placed in the players - bag. - summary: Get item category - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemCategoryDetail' - description: '' - /api/v2/item-attribute/: - get: - operationId: api_v2_item_attribute_list - description: Item attributes define particular aspects of items, e.g."usable - in battle" or "consumable". - summary: List item attributes - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedItemAttributeSummaryList' - description: '' - /api/v2/item-attribute/{id}/: - get: - operationId: api_v2_item_attribute_retrieve - description: Item attributes define particular aspects of items, e.g."usable - in battle" or "consumable". - summary: Get item attribute - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemAttributeDetail' - description: '' - /api/v2/item-fling-effect/: - get: - operationId: api_v2_item_fling_effect_list - description: The various effects of the move"Fling" when used with different - items. - summary: List item fling effects - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedItemFlingEffectSummaryList' - description: '' - /api/v2/item-fling-effect/{id}/: - get: - operationId: api_v2_item_fling_effect_retrieve - description: The various effects of the move"Fling" when used with different - items. - summary: Get item fling effect - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemFlingEffectDetail' - description: '' - /api/v2/item-pocket/: - get: - operationId: api_v2_item_pocket_list - description: Pockets within the players bag used for storing items by category. - summary: List item pockets - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedItemPocketSummaryList' - description: '' - /api/v2/item-pocket/{id}/: - get: - operationId: api_v2_item_pocket_retrieve - description: Pockets within the players bag used for storing items by category. - summary: Get item pocket - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - items - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ItemPocketDetail' - description: '' - /api/v2/language/: - get: - operationId: api_v2_language_list - description: Languages for translations of API resource information. - summary: List languages - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - utility - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedLanguageSummaryList' - description: '' - /api/v2/language/{id}/: - get: - operationId: api_v2_language_retrieve - description: Languages for translations of API resource information. - summary: Get language - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - utility - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LanguageDetail' - description: '' - /api/v2/location/: - get: - operationId: api_v2_location_list - description: Locations that can be visited within the games. Locations make - up sizable portions of regions, like cities or routes. - summary: List locations - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedLocationSummaryList' - description: '' - /api/v2/location/{id}/: - get: - operationId: api_v2_location_retrieve - description: Locations that can be visited within the games. Locations make - up sizable portions of regions, like cities or routes. - summary: Get location - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocationDetail' - description: '' - /api/v2/location-area/: - get: - operationId: api_v2_location_area_list - description: Location areas are sections of areas, such as floors in a building - or cave. Each area has its own set of possible Pokémon encounters. - summary: List location areas - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedLocationAreaSummaryList' - description: '' - /api/v2/location-area/{id}/: - get: - operationId: api_v2_location_area_retrieve - description: Location areas are sections of areas, such as floors in a building - or cave. Each area has its own set of possible Pokémon encounters. - summary: Get location area - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this location area. - required: true - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocationAreaDetail' - description: '' - /api/v2/machine/: - get: - operationId: api_v2_machine_list - description: Machines are the representation of items that teach moves to Pokémon. - They vary from version to version, so it is not certain that one specific - TM or HM corresponds to a single Machine. - summary: List machines - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - machines - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMachineSummaryList' - description: '' - /api/v2/machine/{id}/: - get: - operationId: api_v2_machine_retrieve - description: Machines are the representation of items that teach moves to Pokémon. - They vary from version to version, so it is not certain that one specific - TM or HM corresponds to a single Machine. - summary: Get machine - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - machines - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MachineDetail' - description: '' - /api/v2/move/: - get: - operationId: api_v2_move_list - description: Moves are the skills of Pokémon in battle. In battle, a Pokémon - uses one move each turn. Some moves (including those learned by Hidden Machine) - can be used outside of battle as well, usually for the purpose of removing - obstacles or exploring new areas. - summary: List moves - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveSummaryList' - description: '' - /api/v2/move/{id}/: - get: - operationId: api_v2_move_retrieve - description: Moves are the skills of Pokémon in battle. In battle, a Pokémon - uses one move each turn. Some moves (including those learned by Hidden Machine) - can be used outside of battle as well, usually for the purpose of removing - obstacles or exploring new areas. - summary: Get move - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveDetail' - description: '' - /api/v2/move-ailment/: - get: - operationId: api_v2_move_ailment_list - description: Move Ailments are status conditions caused by moves used during - battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) - for greater detail. - summary: List move meta ailments - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveMetaAilmentSummaryList' - description: '' - /api/v2/move-ailment/{id}/: - get: - operationId: api_v2_move_ailment_retrieve - description: Move Ailments are status conditions caused by moves used during - battle. See [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Status_condition) - for greater detail. - summary: Get move meta ailment - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveMetaAilmentDetail' - description: '' - /api/v2/move-battle-style/: - get: - operationId: api_v2_move_battle_style_list - description: Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) - for greater detail. - summary: List move battle styles - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveBattleStyleSummaryList' - description: '' - /api/v2/move-battle-style/{id}/: - get: - operationId: api_v2_move_battle_style_retrieve - description: Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) - for greater detail. - summary: Get move battle style - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveBattleStyleDetail' - description: '' - /api/v2/move-category/: - get: - operationId: api_v2_move_category_list - description: Very general categories that loosely group move effects. - summary: List move meta categories - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveMetaCategorySummaryList' - description: '' - /api/v2/move-category/{id}/: - get: - operationId: api_v2_move_category_retrieve - description: Very general categories that loosely group move effects. - summary: Get move meta category - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveMetaCategoryDetail' - description: '' - /api/v2/move-damage-class/: - get: - operationId: api_v2_move_damage_class_list - description: Damage classes moves can have, e.g. physical, special, or non-damaging. - summary: List move damage classes - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveDamageClassSummaryList' - description: '' - /api/v2/move-damage-class/{id}/: - get: - operationId: api_v2_move_damage_class_retrieve - description: Damage classes moves can have, e.g. physical, special, or non-damaging. - summary: Get move damage class - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveDamageClassDetail' - description: '' - /api/v2/move-learn-method/: - get: - operationId: api_v2_move_learn_method_list - description: Methods by which Pokémon can learn moves. - summary: List move learn methods - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveLearnMethodSummaryList' - description: '' - /api/v2/move-learn-method/{id}/: - get: - operationId: api_v2_move_learn_method_retrieve - description: Methods by which Pokémon can learn moves. - summary: Get move learn method - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveLearnMethodDetail' - description: '' - /api/v2/move-target/: - get: - operationId: api_v2_move_target_list - description: Targets moves can be directed at during battle. Targets can be - Pokémon, environments or even other moves. - summary: List move targets - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedMoveTargetSummaryList' - description: '' - /api/v2/move-target/{id}/: - get: - operationId: api_v2_move_target_retrieve - description: Targets moves can be directed at during battle. Targets can be - Pokémon, environments or even other moves. - summary: Get move target - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - moves - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MoveTargetDetail' - description: '' - /api/v2/nature/: - get: - operationId: api_v2_nature_list - description: Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) - for greater detail. - summary: List natures - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedNatureSummaryList' - description: '' - /api/v2/nature/{id}/: - get: - operationId: api_v2_nature_retrieve - description: Natures influence how a Pokémon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) - for greater detail. - summary: Get nature - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/NatureDetail' - description: '' - /api/v2/pal-park-area/: - get: - operationId: api_v2_pal_park_area_list - description: Areas used for grouping Pokémon encounters in Pal Park. They're - like habitats that are specific to Pal Park. - summary: List pal park areas - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPalParkAreaSummaryList' - description: '' - /api/v2/pal-park-area/{id}/: - get: - operationId: api_v2_pal_park_area_retrieve - description: Areas used for grouping Pokémon encounters in Pal Park. They're - like habitats that are specific to Pal Park. - summary: Get pal park area - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PalParkAreaDetail' - description: '' - /api/v2/pokedex/: - get: - operationId: api_v2_pokedex_list - description: A Pokédex is a handheld electronic encyclopedia device; one which - is capable of recording and retaining information of the various Pokémon in - a given region with the exception of the national dex and some smaller dexes - related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) - for greater detail. - summary: List pokedex - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokedexSummaryList' - description: '' - /api/v2/pokedex/{id}/: - get: - operationId: api_v2_pokedex_retrieve - description: A Pokédex is a handheld electronic encyclopedia device; one which - is capable of recording and retaining information of the various Pokémon in - a given region with the exception of the national dex and some smaller dexes - related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) - for greater detail. - summary: Get pokedex - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokedexDetail' - description: '' - /api/v2/pokemon/: - get: - operationId: api_v2_pokemon_list - description: Pokémon are the creatures that inhabit the world of the Pokémon - games. They can be caught using Pokéballs and trained by battling with other - Pokémon. Each Pokémon belongs to a specific species but may take on a variant - which makes it differ from other Pokémon of the same species, such as base - stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) - for greater detail. - summary: List pokemon - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonSummaryList' - description: '' - /api/v2/pokemon/{id}/: - get: - operationId: api_v2_pokemon_retrieve - description: Pokémon are the creatures that inhabit the world of the Pokémon - games. They can be caught using Pokéballs and trained by battling with other - Pokémon. Each Pokémon belongs to a specific species but may take on a variant - which makes it differ from other Pokémon of the same species, such as base - stats, available abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) - for greater detail. - summary: Get pokemon - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonDetail' - examples: - pokemonDetail: - value: { - "id": 1, - "name": "Rambo", - "base_experience": 64, - "height": 7, - "is_legendary": false, - "is_mythical": false, - "order": 1, - "weight": 60 - } - description: '' - /api/v2/pokemon-color/: - get: - operationId: api_v2_pokemon_color_list - description: Colors used for sorting Pokémon in a Pokédex. The color listed - in the Pokédex is usually the color most apparent or covering each Pokémon's - body. No orange category exists; Pokémon that are primarily orange are listed - as red or brown. - summary: List pokemon colors - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonColorSummaryList' - description: '' - /api/v2/pokemon-color/{id}/: - get: - operationId: api_v2_pokemon_color_retrieve - description: Colors used for sorting Pokémon in a Pokédex. The color listed - in the Pokédex is usually the color most apparent or covering each Pokémon's - body. No orange category exists; Pokémon that are primarily orange are listed - as red or brown. - summary: Get pokemon color - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonColorDetail' - description: '' - /api/v2/pokemon-form/: - get: - operationId: api_v2_pokemon_form_list - description: Some Pokémon may appear in one of multiple, visually different - forms. These differences are purely cosmetic. For variations within a Pokémon - species, which do differ in more than just visuals, the 'Pokémon' entity is - used to represent such a variety. - summary: List pokemon forms - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonFormSummaryList' - description: '' - /api/v2/pokemon-form/{id}/: - get: - operationId: api_v2_pokemon_form_retrieve - description: Some Pokémon may appear in one of multiple, visually different - forms. These differences are purely cosmetic. For variations within a Pokémon - species, which do differ in more than just visuals, the 'Pokémon' entity is - used to represent such a variety. - summary: Get pokemon form - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonFormDetail' - description: '' - /api/v2/pokemon-habitat/: - get: - operationId: api_v2_pokemon_habitat_list - description: Habitats are generally different terrain Pokémon can be found in - but can also be areas designated for rare or legendary Pokémon. - summary: List pokemom habitas - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonHabitatSummaryList' - description: '' - /api/v2/pokemon-habitat/{id}/: - get: - operationId: api_v2_pokemon_habitat_retrieve - description: Habitats are generally different terrain Pokémon can be found in - but can also be areas designated for rare or legendary Pokémon. - summary: Get pokemom habita - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonHabitatDetail' - description: '' - /api/v2/pokemon-shape/: - get: - operationId: api_v2_pokemon_shape_list - description: Shapes used for sorting Pokémon in a Pokédex. - summary: List pokemon shapes - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonShapeSummaryList' - description: '' - /api/v2/pokemon-shape/{id}/: - get: - operationId: api_v2_pokemon_shape_retrieve - description: Shapes used for sorting Pokémon in a Pokédex. - summary: Get pokemon shape - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonShapeDetail' - description: '' - /api/v2/pokemon-species/: - get: - operationId: api_v2_pokemon_species_list - description: A Pokémon Species forms the basis for at least one Pokémon. Attributes - of a Pokémon species are shared across all varieties of Pokémon within the - species. A good example is Wormadam; Wormadam is the species which can be - found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - summary: List pokemon species - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokemonSpeciesSummaryList' - description: '' - /api/v2/pokemon-species/{id}/: - get: - operationId: api_v2_pokemon_species_retrieve - description: A Pokémon Species forms the basis for at least one Pokémon. Attributes - of a Pokémon species are shared across all varieties of Pokémon within the - species. A good example is Wormadam; Wormadam is the species which can be - found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant. - summary: Get pokemon species - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokemonSpeciesDetail' - description: '' - /api/v2/pokeathlon-stat/: - get: - operationId: api_v2_pokeathlon_stat_list - description: Pokeathlon Stats are different attributes of a Pokémon's performance - in Pokéathlons. In Pokéathlons, competitions happen on different courses; - one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) - for greater detail. - summary: List pokeathlon stats - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedPokeathlonStatSummaryList' - description: '' - /api/v2/pokeathlon-stat/{id}/: - get: - operationId: api_v2_pokeathlon_stat_retrieve - description: Pokeathlon Stats are different attributes of a Pokémon's performance - in Pokéathlons. In Pokéathlons, competitions happen on different courses; - one for each of the different Pokéathlon stats. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9athlon) - for greater detail. - summary: Get pokeathlon stat - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PokeathlonStatDetail' - description: '' - /api/v2/region/: - get: - operationId: api_v2_region_list - description: A region is an organized area of the Pokémon world. Most often, - the main difference between regions is the species of Pokémon that can be - encountered within them. - summary: List regions - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedRegionSummaryList' - description: '' - /api/v2/region/{id}/: - get: - operationId: api_v2_region_retrieve - description: A region is an organized area of the Pokémon world. Most often, - the main difference between regions is the species of Pokémon that can be - encountered within them. - summary: Get region - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - location - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RegionDetail' - description: '' - /api/v2/stat/: - get: - operationId: api_v2_stat_list - description: Stats determine certain aspects of battles. Each Pokémon has a - value for each stat which grows as they gain levels and can be altered momentarily - by effects in battles. - summary: List stats - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedStatSummaryList' - description: '' - /api/v2/stat/{id}/: - get: - operationId: api_v2_stat_retrieve - description: Stats determine certain aspects of battles. Each Pokémon has a - value for each stat which grows as they gain levels and can be altered momentarily - by effects in battles. - summary: Get stat - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StatDetail' - description: '' - /api/v2/super-contest-effect/: - get: - operationId: api_v2_super_contest_effect_list - description: Super contest effects refer to the effects of moves when used in - super contests. - summary: List super contest effects - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedSuperContestEffectSummaryList' - description: '' - /api/v2/super-contest-effect/{id}/: - get: - operationId: api_v2_super_contest_effect_retrieve - description: Super contest effects refer to the effects of moves when used in - super contests. - summary: Get super contest effect - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - contests - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SuperContestEffectDetail' - description: '' - /api/v2/type/: - get: - operationId: api_v2_type_list - description: 'Types are properties for Pokémon and their moves. Each type has - three properties: which types of Pokémon it is super effective against, which - types of Pokémon it is not very effective against, and which types of Pokémon - it is completely ineffective against.' - summary: List types - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedTypeSummaryList' - description: '' - /api/v2/type/{id}/: - get: - operationId: api_v2_type_retrieve - description: 'Types are properties for Pokémon and their moves. Each type has - three properties: which types of Pokémon it is super effective against, which - types of Pokémon it is not very effective against, and which types of Pokémon - it is completely ineffective against.' - summary: Get types - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - pokemon - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypeDetail' - description: '' - /api/v2/version/: - get: - operationId: api_v2_version_list - description: Versions of the games, e.g., Red, Blue or Yellow. - summary: List versions - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedVersionSummaryList' - description: '' - /api/v2/version/{id}/: - get: - operationId: api_v2_version_retrieve - description: Versions of the games, e.g., Red, Blue or Yellow. - summary: Get version - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VersionDetail' - description: '' - /api/v2/version-group/: - get: - operationId: api_v2_version_group_list - description: Version groups categorize highly similar versions of the games. - summary: List version groups - parameters: - - name: limit - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: offset - required: false - in: query - description: The initial index from which to return the results. - schema: - type: integer - - in: query - name: q - schema: - type: string - description: "> Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2)\n\ - Case-insensitive query applied on the `name` property. " - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedVersionGroupSummaryList' - description: '' - /api/v2/version-group/{id}/: - get: - operationId: api_v2_version_group_retrieve - description: Version groups categorize highly similar versions of the games. - summary: Get version group - parameters: - - in: path - name: id - schema: - type: string - description: This parameter can be a string or an integer. - required: true - tags: - - games - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/VersionGroupDetail' - description: '' - /api/v2/pokemon/{pokemon_id}/encounters: - get: - operationId: api_v2_pokemon_encounters_retrieve - description: Handles Pokemon Encounters as a sub-resource. - summary: Get pokemon encounter - parameters: - - in: path - name: pokemon_id - schema: - type: string - pattern: ^\d+$ - required: true - tags: - - encounters - security: - - cookieAuth: [] - - basicAuth: [] - - {} - responses: - '200': - content: - application/json: - schema: - type: array - items: - type: object - required: - - location_area - - version_details - properties: - location_area: - type: object - required: - - name - - url - properties: - name: - type: string - example: cerulean-city-area - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/location-area/281/ - version_details: - type: array - items: - type: object - required: - - encounter_details - - max_chance - - version - properties: - encounter_details: - type: array - items: - type: object - required: - - chance - - condition_values - - max_level - - method - - min_level - properties: - chance: - type: number - example: 100 - condition_values: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - example: story-progress-beat-red - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/encounter-condition-value/55/ - max_level: - type: number - example: 10 - method: - type: object - required: - - name - - url - properties: - name: - type: string - example: gift - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/encounter-method/18/ - min_level: - type: number - example: 10 - max_chance: - type: number - example: 100 - version: - type: object - required: - - name - - url - properties: - name: - type: string - example: red - url: - type: string - format: uri - example: https://pokeapi.co/api/v2/version/1/ - description: '' -components: - schemas: - AbilityChange: - type: object - properties: - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - effect_entries: - type: array - items: - $ref: '#/components/schemas/AbilityChangeEffectText' - readOnly: true - required: - - effect_entries - - version_group - AbilityChangeEffectText: - type: object - properties: - effect: - type: string - maxLength: 6000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - effect - - language - AbilityDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - is_main_series: - type: boolean - generation: - $ref: '#/components/schemas/GenerationSummary' - names: - type: array - items: - $ref: '#/components/schemas/AbilityName' - readOnly: true - effect_entries: - type: array - items: - $ref: '#/components/schemas/AbilityEffectText' - readOnly: true - effect_changes: - type: array - items: - $ref: '#/components/schemas/AbilityChange' - readOnly: true - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/AbilityFlavorText' - readOnly: true - pokemon: - type: array - items: - type: object - required: - - is_hidden - - slot - - pokemon - properties: - is_hidden: - type: boolean - slot: - type: integer - format: int32 - examples: - - 3 - pokemon: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - gloom - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon/44/ - readOnly: true - required: - - effect_changes - - effect_entries - - flavor_text_entries - - generation - - id - - name - - names - - pokemon - AbilityEffectText: - type: object - properties: - effect: - type: string - maxLength: 6000 - short_effect: - type: string - maxLength: 300 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - effect - - language - - short_effect - AbilityFlavorText: - type: object - properties: - flavor_text: - type: string - language: - $ref: '#/components/schemas/LanguageSummary' - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - required: - - flavor_text - - language - - version_group - AbilityName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - AbilitySummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - BerryDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - growth_time: - type: integer - max_harvest: - type: integer - natural_gift_power: - type: integer - size: - type: integer - smoothness: - type: integer - soil_dryness: - type: integer - firmness: - $ref: '#/components/schemas/BerryFirmnessSummary' - flavors: - type: array - items: - type: object - required: - - potency - - flavor - properties: - potency: - type: integer - examples: - - 10 - flavor: - type: object - require: - - name - - url - properties: - name: - type: string - description: The name of the flavor - examples: - - spicy - url: - type: string - format: uri - description: The URL to get more information about the flavor - examples: - - https://pokeapi.co/api/v2/berry-flavor/1/ - readOnly: true - item: - $ref: '#/components/schemas/ItemSummary' - natural_gift_type: - $ref: '#/components/schemas/TypeSummary' - required: - - firmness - - flavors - - growth_time - - id - - item - - max_harvest - - name - - natural_gift_power - - natural_gift_type - - size - - smoothness - - soil_dryness - BerryFirmnessDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - berries: - type: array - items: - $ref: '#/components/schemas/BerrySummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/BerryFirmnessName' - readOnly: true - required: - - berries - - id - - name - - names - BerryFirmnessName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - BerryFirmnessSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - BerryFlavorDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - berries: - type: array - items: - type: object - required: - - potency - - berry - properties: - potency: - type: integer - examples: - - 10 - berry: - type: object - require: - - name - - url - properties: - name: - type: string - description: The name of the berry - examples: - - rowap - url: - type: string - format: uri - description: The URL to get more information about the berry - examples: - - https://pokeapi.co/api/v2/berry/64/ - readOnly: true - contest_type: - $ref: '#/components/schemas/ContestTypeSummary' - names: - type: array - items: - $ref: '#/components/schemas/BerryFlavorName' - readOnly: true - required: - - berries - - contest_type - - id - - name - - names - BerryFlavorName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - BerryFlavorSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - BerrySummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - CharacteristicDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - CharacteristicDetail: - type: object - properties: - id: - type: integer - readOnly: true - gene_modulo: - type: integer - possible_values: - type: array - items: - type: integer - format: int32 - examples: - - - 0 - - 5 - - 10 - - 15 - - 20 - - 25 - - 30 - readOnly: true - highest_stat: - $ref: '#/components/schemas/StatSummary' - descriptions: - type: array - items: - $ref: '#/components/schemas/CharacteristicDescription' - readOnly: true - required: - - descriptions - - gene_modulo - - highest_stat - - id - - possible_values - CharacteristicSummary: - type: object - properties: - url: - type: string - format: uri - readOnly: true - required: - - url - ContestEffectDetail: - type: object - properties: - id: - type: integer - readOnly: true - appeal: - type: integer - jam: - type: integer - effect_entries: - type: array - items: - $ref: '#/components/schemas/ContestEffectEffectText' - readOnly: true - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/ContestEffectFlavorText' - readOnly: true - required: - - appeal - - effect_entries - - flavor_text_entries - - id - - jam - ContestEffectEffectText: - type: object - properties: - effect: - type: string - maxLength: 6000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - effect - - language - ContestEffectFlavorText: - type: object - properties: - flavor_text: - type: string - maxLength: 500 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - flavor_text - - language - ContestEffectSummary: - type: object - properties: - url: - type: string - format: uri - readOnly: true - required: - - url - ContestTypeDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - berry_flavor: - allOf: - - $ref: '#/components/schemas/BerryFlavorSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/ContestTypeName' - readOnly: true - required: - - berry_flavor - - id - - name - - names - ContestTypeName: - type: object - properties: - name: - type: string - maxLength: 200 - color: - type: string - maxLength: 10 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - color - - language - - name - ContestTypeSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - EggGroupDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/EggGroupName' - readOnly: true - pokemon_species: - type: array - items: - type: object - required: - - potency - - flavor - properties: - name: - type: string - description: Pokemon species name. - examples: - - bulbasaur - url: - type: string - format: uri - description: The URL to get more information about the species - examples: - - https://pokeapi.co/api/v2/pokemon-species/1/ - readOnly: true - required: - - id - - name - - names - - pokemon_species - EggGroupName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - EggGroupSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - EncounterConditionDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - values: - type: array - items: - $ref: '#/components/schemas/EncounterConditionValueSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/EncounterConditionName' - readOnly: true - required: - - id - - name - - names - - values - EncounterConditionName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - EncounterConditionSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - EncounterConditionValueDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - condition: - $ref: '#/components/schemas/EncounterConditionSummary' - names: - type: array - items: - $ref: '#/components/schemas/EncounterConditionValueName' - readOnly: true - required: - - condition - - id - - name - - names - EncounterConditionValueName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - EncounterConditionValueSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - EncounterMethodDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - order: - type: - - integer - - 'null' - names: - type: array - items: - $ref: '#/components/schemas/EncounterMethodName' - readOnly: true - required: - - id - - name - - names - EncounterMethodName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - EncounterMethodSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - EvolutionChainDetail: - type: object - properties: - id: - type: integer - readOnly: true - baby_trigger_item: - $ref: '#/components/schemas/ItemSummary' - chain: - type: object - required: - - evolution_details - - evolves_to - - is_baby - - species - properties: - evolution_details: - type: array - items: {} - examples: [] - evolves_to: - type: array - items: - type: object - required: - - evolution_details - - evolves_to - - is_baby - - species - properties: - evolution_details: - type: array - items: - type: object - required: - - gender - - held_item - - item - - known_move - - known_move_type - - location - - min_affection - - min_beauty - - min_happiness - - min_level - - needs_overworld_rain - - party_species - - party_type - - relative_physical_stats - - time_of_day - - trade_species - - trigger - - turn_upside_down - properties: - gender: - type: object - nullable: true - required: - - name - - url - properties: - name: - type: string - examples: - - 1 - url: - type: string - format: uri - examples: - - 2 - held_item: - type: object - nullable: true - required: - - name - - url - properties: - name: - type: string - examples: - - 1 - url: - type: string - format: uri - examples: - - 2 - item: - type: object - nullable: true - required: - - name - - url - properties: - name: - type: string - examples: - - 1 - url: - type: string - format: uri - examples: - - 2 - known_move: - type: '' - nullable: true - known_move_type: - type: '' - nullable: true - location: - type: object - nullable: true - required: - - name - - url - properties: - name: - type: string - url: - type: string - format: uri - min_affection: - type: integer - format: int32 - nullable: true - min_beauty: - type: integer - format: int32 - nullable: true - min_happiness: - type: integer - format: int32 - nullable: true - min_level: - type: integer - format: int32 - nullable: true - needs_overworld_rain: - type: boolean - nullable: true - party_species: - type: string - nullable: true - party_type: - type: string - nullable: true - relative_physical_stats: - type: string - nullable: true - time_of_day: - type: string - trade_species: - type: string - nullable: true - trigger: - type: object - required: - - name - - url - properties: - name: - type: string - url: - type: string - format: uri - turn_upside_down: - type: boolean - is_baby: - type: boolean - species: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - happiny - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/440/ - is_baby: - type: boolean - species: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - happiny - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/440/ - readOnly: true - required: - - baby_trigger_item - - chain - - id - EvolutionChainSummary: - type: object - properties: - url: - type: string - format: uri - readOnly: true - required: - - url - EvolutionTriggerDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/EvolutionTriggerName' - readOnly: true - pokemon_species: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - ivysaur - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/2/ - readOnly: true - required: - - id - - name - - names - - pokemon_species - EvolutionTriggerName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - EvolutionTriggerSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - Experience: - type: object - properties: - level: - type: integer - experience: - type: integer - required: - - experience - - level - GenderDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - pokemon_species_details: - type: array - items: - type: object - required: - - rate - - pokemon_species - properties: - rate: - type: integer - format: int32 - examples: - - 1 - pokemon_species: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bulbasaur - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/1/ - readOnly: true - required_for_evolution: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - wormadam - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/413/ - readOnly: true - required: - - id - - name - - pokemon_species_details - - required_for_evolution - GenderSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - GenerationDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - abilities: - type: array - items: - $ref: '#/components/schemas/AbilitySummary' - readOnly: true - main_region: - $ref: '#/components/schemas/RegionSummary' - moves: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/GenerationName' - readOnly: true - pokemon_species: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - readOnly: true - types: - type: array - items: - $ref: '#/components/schemas/TypeSummary' - readOnly: true - version_groups: - type: array - items: - $ref: '#/components/schemas/VersionGroupSummary' - readOnly: true - required: - - abilities - - id - - main_region - - moves - - name - - names - - pokemon_species - - types - - version_groups - GenerationName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - GenerationSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - GrowthRateDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - GrowthRateDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - formula: - type: string - maxLength: 500 - descriptions: - type: array - items: - $ref: '#/components/schemas/GrowthRateDescription' - readOnly: true - levels: - type: array - items: - $ref: '#/components/schemas/Experience' - readOnly: true - pokemon_species: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - readOnly: true - required: - - descriptions - - formula - - id - - levels - - name - - pokemon_species - GrowthRateSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - ItemAttributeDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - ItemAttributeDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - descriptions: - type: array - items: - $ref: '#/components/schemas/ItemAttributeDescription' - readOnly: true - items: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - master-ball - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/item/1/ - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/ItemAttributeName' - readOnly: true - required: - - descriptions - - id - - items - - name - - names - ItemAttributeName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - ItemAttributeSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - ItemCategoryDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - items: - type: array - items: - $ref: '#/components/schemas/ItemSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/ItemCategoryName' - readOnly: true - pocket: - $ref: '#/components/schemas/ItemPocketSummary' - required: - - id - - items - - name - - names - - pocket - ItemCategoryName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - ItemCategorySummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - ItemDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - cost: - type: - - integer - - 'null' - fling_power: - type: - - integer - - 'null' - fling_effect: - $ref: '#/components/schemas/ItemFlingEffectSummary' - attributes: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - countable - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/item-attribute/1/ - readOnly: true - category: - $ref: '#/components/schemas/ItemCategorySummary' - effect_entries: - type: array - items: - $ref: '#/components/schemas/ItemEffectText' - readOnly: true - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/ItemFlavorText' - readOnly: true - game_indices: - type: array - items: - $ref: '#/components/schemas/ItemGameIndex' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/ItemName' - readOnly: true - held_by_pokemon: - type: array - items: - type: object - required: - - pokemon - - version-details - properties: - pokemon: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - farfetchd - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon/83/ - version-details: - type: array - items: - type: object - required: - - rarity - - version - properties: - rarity: - type: integer - format: int32 - examples: - - 5 - version: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - ruby - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version/7/ - readOnly: true - sprites: - type: object - required: - - default - properties: - default: - type: string - format: uri - examples: - - https://pokeapi.co/media/sprites/items/master-ball.png - readOnly: true - baby_trigger_for: - type: object - required: - - url - properties: - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/evolution-chain/51/ - readOnly: true - machines: - type: array - items: - type: object - required: - - machine - - version_group - properties: - machine: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/machine/1/ - version_group: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - sword-shield - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/20/ - readOnly: true - required: - - attributes - - baby_trigger_for - - category - - effect_entries - - flavor_text_entries - - fling_effect - - game_indices - - held_by_pokemon - - id - - machines - - name - - names - - sprites - ItemEffectText: - type: object - properties: - effect: - type: string - maxLength: 6000 - short_effect: - type: string - maxLength: 300 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - effect - - language - - short_effect - ItemFlavorText: - type: object - properties: - text: - type: string - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - text - - version_group - ItemFlingEffectDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - effect_entries: - type: array - items: - $ref: '#/components/schemas/ItemFlingEffectEffectText' - readOnly: true - items: - type: array - items: - $ref: '#/components/schemas/ItemSummary' - readOnly: true - required: - - effect_entries - - id - - items - - name - ItemFlingEffectEffectText: - type: object - properties: - effect: - type: string - maxLength: 6000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - effect - - language - ItemFlingEffectSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - ItemGameIndex: - type: object - properties: - game_index: - type: integer - generation: - $ref: '#/components/schemas/GenerationSummary' - required: - - game_index - - generation - ItemName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - ItemPocketDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - categories: - type: array - items: - $ref: '#/components/schemas/ItemCategorySummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/ItemPocketName' - readOnly: true - required: - - categories - - id - - name - - names - ItemPocketName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - ItemPocketSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - ItemSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - LanguageDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - official: - type: boolean - iso639: - type: string - maxLength: 10 - iso3166: - type: string - maxLength: 2 - names: - type: array - items: - $ref: '#/components/schemas/LanguageName' - readOnly: true - required: - - id - - iso3166 - - iso639 - - name - - names - LanguageName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - LanguageSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - LocationAreaDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - game_index: - type: integer - encounter_method_rates: - type: array - items: - type: object - required: - - encounter_method - - version_details - properties: - encounter_method: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - old-rod - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/encounter-method/2/ - version_details: - type: array - items: - type: object - required: - - rate - - version - properties: - rate: - type: integer - format: int32 - examples: - - 5 - version: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - platinum - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version/14/ - readOnly: true - location: - $ref: '#/components/schemas/LocationSummary' - names: - type: array - items: - $ref: '#/components/schemas/LocationAreaName' - readOnly: true - pokemon_encounters: - type: array - items: - type: object - required: - - pokemon - - version_details - properties: - pokemon: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - tentacool - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon/72/ - version_details: - type: array - items: - type: object - required: - - version - - max_chance - - encounter_details - properties: - version: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - diamond - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version/12/ - max_chance: - type: integer - format: int32 - examples: - - 60 - encounter_details: - type: object - required: - - min_level - - max_level - - condition_value - - chance - - method - properties: - min_level: - type: integer - format: int32 - examples: - - 20 - max_level: - type: integer - format: int32 - examples: - - 30 - condition_values: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - slot2-sapphire - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/encounter-condition-value/10/ - chance: - type: integer - format: int32 - examples: - - 60 - method: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - surf - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/encounter-method/5/ - readOnly: true - required: - - encounter_method_rates - - game_index - - id - - location - - name - - names - - pokemon_encounters - LocationAreaName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - LocationAreaSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - LocationDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - region: - $ref: '#/components/schemas/RegionSummary' - names: - type: array - items: - $ref: '#/components/schemas/LocationName' - readOnly: true - game_indices: - type: array - items: - $ref: '#/components/schemas/LocationGameIndex' - readOnly: true - areas: - type: array - items: - $ref: '#/components/schemas/LocationAreaSummary' - readOnly: true - required: - - areas - - game_indices - - id - - name - - names - - region - LocationGameIndex: - type: object - properties: - game_index: - type: integer - generation: - $ref: '#/components/schemas/GenerationSummary' - required: - - game_index - - generation - LocationName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - LocationSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MachineDetail: - type: object - properties: - id: - type: integer - readOnly: true - item: - $ref: '#/components/schemas/ItemSummary' - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - move: - $ref: '#/components/schemas/MoveSummary' - required: - - id - - item - - move - - version_group - MachineSummary: - type: object - properties: - url: - type: string - format: uri - readOnly: true - required: - - url - MoveBattleStyleDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/MoveBattleStyleName' - readOnly: true - required: - - id - - name - - names - MoveBattleStyleName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveBattleStyleSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveChange: - type: object - properties: - accuracy: - type: - - integer - - 'null' - power: - type: - - integer - - 'null' - pp: - type: - - integer - - 'null' - effect_chance: - type: integer - effect_entries: - type: array - items: - type: object - required: - - effect - - short_effect - - language - properties: - effect: - type: string - examples: - - Inflicts [regular damage]{mechanic:regular-damage}. - short_effect: - type: string - examples: - - Inflicts regular damage with no additional effect. - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - readOnly: true - type: - $ref: '#/components/schemas/TypeSummary' - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - required: - - effect_chance - - effect_entries - - type - - version_group - MoveDamageClassDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - MoveDamageClassDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - descriptions: - type: array - items: - $ref: '#/components/schemas/MoveDamageClassDescription' - readOnly: true - moves: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/MoveDamageClassName' - readOnly: true - required: - - descriptions - - id - - moves - - name - - names - MoveDamageClassName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveDamageClassSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - accuracy: - type: - - integer - - 'null' - effect_chance: - type: integer - pp: - type: - - integer - - 'null' - priority: - type: - - integer - - 'null' - power: - type: - - integer - - 'null' - contest_combos: - type: object - required: - - normal - - super - properties: - normal: - type: object - required: - - use_before - - use_after - properties: - use_before: - type: array - nullable: true - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - fire-punch - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/7/ - use_after: - type: array - nullable: true - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - ice-punch - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/8/ - super: - type: object - required: - - use_before - - use_after - properties: - use_before: - type: array - nullable: true - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - night-slash - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/400/ - use_after: - type: array - nullable: true - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - focus-energy - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/116/ - readOnly: true - contest_type: - $ref: '#/components/schemas/ContestTypeSummary' - contest_effect: - $ref: '#/components/schemas/ContestEffectSummary' - damage_class: - $ref: '#/components/schemas/MoveDamageClassSummary' - effect_entries: - type: array - items: - type: object - required: - - effect - - short_effect - - language - properties: - effect: - type: string - examples: - - Inflicts [regular damage]{mechanic:regular-damage}. - short_effect: - type: string - examples: - - Inflicts regular damage with no additional effect. - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - readOnly: true - effect_changes: - type: array - items: - type: object - required: - - effect_entries - - version_group - properties: - effect_entries: - type: array - items: - type: object - required: - - effect - - language - properties: - effect: - type: string - examples: - - Hits Pokémon under the effects of dig and fly. - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - version_group: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - gold-silver - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/3/ - readOnly: true - generation: - $ref: '#/components/schemas/GenerationSummary' - meta: - allOf: - - $ref: '#/components/schemas/MoveMeta' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/MoveName' - readOnly: true - past_values: - type: array - items: - $ref: '#/components/schemas/MoveChange' - readOnly: true - stat_changes: - type: array - items: - type: object - required: - - change - - stat - properties: - change: - type: integer - format: int32 - examples: - - 2 - stat: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - attack - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/stat/1/ - readOnly: true - super_contest_effect: - $ref: '#/components/schemas/SuperContestEffectSummary' - target: - $ref: '#/components/schemas/MoveTargetSummary' - type: - $ref: '#/components/schemas/TypeSummary' - machines: - type: array - items: - type: object - required: - - machine - - version_group - properties: - machine: - type: object - required: - - url - properties: - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/machine/1/ - version_group: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - sword-shield - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/1/ - readOnly: true - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/MoveFlavorText' - readOnly: true - learned_by_pokemon: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - clefairy - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon/35/ - readOnly: true - required: - - contest_combos - - contest_effect - - contest_type - - damage_class - - effect_chance - - effect_changes - - effect_entries - - flavor_text_entries - - generation - - id - - learned_by_pokemon - - machines - - meta - - name - - names - - past_values - - stat_changes - - super_contest_effect - - target - - type - MoveFlavorText: - type: object - properties: - flavor_text: - type: string - language: - $ref: '#/components/schemas/LanguageSummary' - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - required: - - flavor_text - - language - - version_group - MoveLearnMethodDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - MoveLearnMethodDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/MoveLearnMethodName' - readOnly: true - descriptions: - type: array - items: - $ref: '#/components/schemas/MoveLearnMethodDescription' - readOnly: true - version_groups: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - red-blue - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/1/ - readOnly: true - required: - - descriptions - - id - - name - - names - - version_groups - MoveLearnMethodName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveLearnMethodSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveMeta: - type: object - properties: - ailment: - $ref: '#/components/schemas/MoveMetaAilmentSummary' - category: - $ref: '#/components/schemas/MoveMetaCategorySummary' - min_hits: - type: - - integer - - 'null' - max_hits: - type: - - integer - - 'null' - min_turns: - type: - - integer - - 'null' - max_turns: - type: - - integer - - 'null' - drain: - type: - - integer - - 'null' - healing: - type: - - integer - - 'null' - crit_rate: - type: - - integer - - 'null' - ailment_chance: - type: - - integer - - 'null' - flinch_chance: - type: - - integer - - 'null' - stat_chance: - type: - - integer - - 'null' - required: - - ailment - - category - MoveMetaAilmentDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - moves: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - thunder-punch - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/9/ - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/MoveMetaAilmentName' - readOnly: true - required: - - id - - moves - - name - - names - MoveMetaAilmentName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveMetaAilmentSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveMetaCategoryDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - MoveMetaCategoryDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - descriptions: - type: array - items: - $ref: '#/components/schemas/MoveMetaCategoryDescription' - readOnly: true - moves: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - sing - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/47/ - readOnly: true - required: - - descriptions - - id - - moves - - name - MoveMetaCategorySummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - MoveTargetDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - MoveTargetDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - descriptions: - type: array - items: - $ref: '#/components/schemas/MoveTargetDescription' - readOnly: true - moves: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/MoveTargetName' - readOnly: true - required: - - descriptions - - id - - moves - - name - - names - MoveTargetName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - MoveTargetSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - NatureBattleStylePreference: - type: object - properties: - low_hp_preference: - type: integer - high_hp_preference: - type: integer - move_battle_style: - $ref: '#/components/schemas/MoveBattleStyleSummary' - required: - - high_hp_preference - - low_hp_preference - - move_battle_style - NatureDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - decreased_stat: - $ref: '#/components/schemas/StatSummary' - increased_stat: - $ref: '#/components/schemas/StatSummary' - likes_flavor: - $ref: '#/components/schemas/BerryFlavorSummary' - hates_flavor: - $ref: '#/components/schemas/BerryFlavorSummary' - berries: - type: array - items: - $ref: '#/components/schemas/BerrySummary' - readOnly: true - pokeathlon_stat_changes: - type: array - items: - type: object - required: - - max_change - - pokeathlon_stat - properties: - max_change: - type: integer - format: int32 - examples: - - 1 - pokeathlon_stat: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - power - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokeathlon-stat/2/ - readOnly: true - move_battle_style_preferences: - type: array - items: - $ref: '#/components/schemas/NatureBattleStylePreference' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/NatureName' - readOnly: true - required: - - berries - - decreased_stat - - hates_flavor - - id - - increased_stat - - likes_flavor - - move_battle_style_preferences - - name - - names - - pokeathlon_stat_changes - NatureName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - NatureSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PaginatedAbilitySummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/AbilitySummary' - PaginatedBerryFirmnessSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/BerryFirmnessSummary' - PaginatedBerryFlavorSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/BerryFlavorSummary' - PaginatedBerrySummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/BerrySummary' - PaginatedCharacteristicSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/CharacteristicSummary' - PaginatedContestEffectSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ContestEffectSummary' - PaginatedContestTypeSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ContestTypeSummary' - PaginatedEggGroupSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EggGroupSummary' - PaginatedEncounterConditionSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EncounterConditionSummary' - PaginatedEncounterConditionValueSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EncounterConditionValueSummary' - PaginatedEncounterMethodSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EncounterMethodSummary' - PaginatedEvolutionChainSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EvolutionChainSummary' - PaginatedEvolutionTriggerSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/EvolutionTriggerSummary' - PaginatedGenderSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/GenderSummary' - PaginatedGenerationSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/GenerationSummary' - PaginatedGrowthRateSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/GrowthRateSummary' - PaginatedItemAttributeSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ItemAttributeSummary' - PaginatedItemCategorySummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ItemCategorySummary' - PaginatedItemFlingEffectSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ItemFlingEffectSummary' - PaginatedItemPocketSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ItemPocketSummary' - PaginatedItemSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/ItemSummary' - PaginatedLanguageSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/LanguageSummary' - PaginatedLocationAreaSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/LocationAreaSummary' - PaginatedLocationSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/LocationSummary' - PaginatedMachineSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MachineSummary' - PaginatedMoveBattleStyleSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveBattleStyleSummary' - PaginatedMoveDamageClassSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveDamageClassSummary' - PaginatedMoveLearnMethodSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveLearnMethodSummary' - PaginatedMoveMetaAilmentSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveMetaAilmentSummary' - PaginatedMoveMetaCategorySummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveMetaCategorySummary' - PaginatedMoveSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - PaginatedMoveTargetSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/MoveTargetSummary' - PaginatedNatureSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/NatureSummary' - PaginatedPalParkAreaSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PalParkAreaSummary' - PaginatedPokeathlonStatSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokeathlonStatSummary' - PaginatedPokedexSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokedexSummary' - PaginatedPokemonColorSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonColorSummary' - PaginatedPokemonFormSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonFormSummary' - PaginatedPokemonHabitatSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonHabitatSummary' - PaginatedPokemonShapeSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonShapeSummary' - PaginatedPokemonSpeciesSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - PaginatedPokemonSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/PokemonSummary' - PaginatedRegionSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/RegionSummary' - PaginatedStatSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/StatSummary' - PaginatedSuperContestEffectSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/SuperContestEffectSummary' - PaginatedTypeSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/TypeSummary' - PaginatedVersionGroupSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/VersionGroupSummary' - PaginatedVersionSummaryList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=400&limit=100 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?offset=200&limit=100 - results: - type: array - items: - $ref: '#/components/schemas/VersionSummary' - PalParkAreaDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/PalParkAreaName' - readOnly: true - pokemon_encounters: - type: array - items: - type: object - required: - - base_score - - pokemon-species - - rate - properties: - base_score: - type: integer - format: int32 - examples: - - 50 - pokemon-species: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bulbasaur - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/1/ - rate: - type: integer - format: int32 - examples: - - 30 - readOnly: true - required: - - id - - name - - names - - pokemon_encounters - PalParkAreaName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - PalParkAreaSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokeathlonStatDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - affecting_natures: - type: object - required: - - decrease - - increase - properties: - decrease: - type: array - items: - type: object - required: - - max_change - - nature - properties: - max_change: - type: integer - format: int32 - maximum: -1 - examples: - - -1 - nature: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - hardy - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/nature/1/ - increase: - type: array - items: - type: object - required: - - max_change - - nature - properties: - max_change: - type: integer - format: int32 - minimum: 1 - examples: - - 2 - nature: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - hardy - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/nature/1/ - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/PokeathlonStatName' - readOnly: true - required: - - affecting_natures - - id - - name - - names - PokeathlonStatName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - PokeathlonStatSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokedexDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - PokedexDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - is_main_series: - type: boolean - descriptions: - type: array - items: - $ref: '#/components/schemas/PokedexDescription' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/PokedexName' - readOnly: true - pokemon_entries: - type: array - items: - type: object - required: - - entry_number - - pokemon_species - properties: - entry_number: - type: integer - format: int32 - examples: - - 1 - pokemon_species: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bulbasaur - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon-species/1/ - readOnly: true - region: - $ref: '#/components/schemas/RegionSummary' - version_groups: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - the-teal-mask - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/26/ - readOnly: true - required: - - descriptions - - id - - name - - names - - pokemon_entries - - region - - version_groups - PokedexName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - PokedexSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonColorDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/PokemonColorName' - readOnly: true - pokemon_species: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - readOnly: true - required: - - id - - name - - names - - pokemon_species - PokemonColorName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - PokemonColorSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - base_experience: - type: - - integer - - 'null' - height: - type: - - integer - - 'null' - is_default: - type: boolean - order: - type: - - integer - - 'null' - weight: - type: - - integer - - 'null' - abilities: - type: array - items: - type: object - required: - - ability - - is_hidden - - slot - properties: - ability: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - sand-veil - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/ability/8/ - is_hidden: - type: boolean - slot: - type: integer - format: int32 - examples: - - 1 - readOnly: true - past_abilities: - type: array - items: - type: object - required: - - abilities - - generation - properties: - abilities: - type: array - items: - type: object - required: - - ability - - is_hidden - - slot - properties: - ability: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - levitate - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/ability/26/ - is_hidden: - type: boolean - slot: - type: integer - format: int32 - examples: - - 1 - generation: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - generation-vi - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/generation/6/ - readOnly: true - forms: - type: array - items: - $ref: '#/components/schemas/PokemonFormSummary' - readOnly: true - game_indices: - type: array - items: - $ref: '#/components/schemas/PokemonGameIndex' - readOnly: true - held_items: - type: array - items: - type: object - required: - - item - - version_details - properties: - item: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - soft-sand - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/item/214/ - version_details: - type: array - items: - type: object - required: - - rarity - - version - properties: - rarity: - type: integer - format: int32 - examples: - - 5 - version: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - diamond - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version/12/ - readOnly: true - location_area_encounters: - type: string - examples: - - https://pokeapi.co/api/v2/pokemon/1/encounters - readOnly: true - moves: - type: array - items: - type: object - required: - - move - - version_group_details - properties: - move: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - scratch - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/10/ - version_group_details: - type: array - items: - type: object - required: - - level_learned_at - - move_learn_method - - version_group - properties: - level_learned_at: - type: integer - format: int32 - examples: - - 1 - move_learn_method: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - level-up - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move-learn-method/1/ - version_group: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - red-blue - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/1/ - readOnly: true - species: - $ref: '#/components/schemas/PokemonSpeciesSummary' - sprites: - type: object - properties: - front_default: - type: string - format: uri - exmaple: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/1.png - additionalProperties: - type: string - format: uri - nullable: true - examples: - - https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/shiny/1.png - examples: - - back_default: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/1.png - back_female: null - back_shiny: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/shiny/1.png - back_shiny_female: null - front_default: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/1.png - front_female: null - front_shiny: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/shiny/1.png - front_shiny_female: null - readOnly: true - cries: - type: object - required: - - latest - - legacy - properties: - latest: - type: string - format: uri - examples: - - https://raw.githubusercontent.com/PokeAPI/cries/main/cries/pokemon/latest/50.ogg - legacy: - type: string - format: uri - examples: - - https://raw.githubusercontent.com/PokeAPI/cries/main/cries/pokemon/legacy/50.ogg - readOnly: true - stats: - type: array - items: - $ref: '#/components/schemas/PokemonStat' - readOnly: true - types: - type: array - items: - type: object - required: - - slot - - type - properties: - slot: - type: integer - format: int32 - examples: - - 1 - type: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - ghost - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/8/ - readOnly: true - past_types: - type: array - items: - type: object - required: - - generation - - types - properties: - generation: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - generation-v - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/generation/5/ - types: - type: array - items: - type: object - required: - - slot - - type - properties: - slot: - type: integer - format: int32 - examples: - - 1 - type: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - normal - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/1/ - readOnly: true - required: - - abilities - - cries - - forms - - game_indices - - held_items - - id - - location_area_encounters - - moves - - name - - past_abilities - - past_types - - species - - sprites - - stats - - types - PokemonDexEntry: - type: object - properties: - entry_number: - type: integer - pokedex: - $ref: '#/components/schemas/PokedexSummary' - required: - - entry_number - - pokedex - PokemonFormDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - order: - type: - - integer - - 'null' - form_order: - type: - - integer - - 'null' - is_default: - type: boolean - is_battle_only: - type: boolean - is_mega: - type: boolean - form_name: - type: string - maxLength: 30 - pokemon: - $ref: '#/components/schemas/PokemonSummary' - sprites: - type: object - properties: - default: - type: string - format: uri - examples: - - https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/412.png - additionalProperties: - type: string - format: uri - nullable: true - examples: - - https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/shiny/412.png - examples: - - back_default: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/412.png - back_female: null - back_shiny: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/shiny/412.png - back_shiny_female: null - front_default: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/412.png - front_female: null - front_shiny: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/shiny/412.png - front_shiny_female: null - readOnly: true - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - form_names: - type: array - items: - type: object - required: - - language - - name - properties: - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - name: - type: string - examples: - - Plant Cloak - readOnly: true - names: - type: array - items: - type: object - required: - - language - - name - properties: - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - name: - type: string - examples: - - Plant Cloak - readOnly: true - types: - type: array - items: - type: object - required: - - slot - - type - properties: - slot: - type: integer - format: int32 - examples: - - 1 - type: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bug - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/7/ - readOnly: true - required: - - form_name - - form_names - - id - - name - - names - - pokemon - - sprites - - types - - version_group - PokemonFormSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonGameIndex: - type: object - properties: - game_index: - type: integer - version: - $ref: '#/components/schemas/VersionSummary' - required: - - game_index - - version - PokemonHabitatDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/PokemonHabitatName' - readOnly: true - pokemon_species: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - readOnly: true - required: - - id - - name - - names - - pokemon_species - PokemonHabitatName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - PokemonHabitatSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonShapeDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - awesome_names: - type: array - items: - type: object - required: - - awesome_name - - language - properties: - awesome_name: - type: string - examples: - - Pomaceous - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - readOnly: true - names: - type: array - items: - type: object - required: - - url - - name - properties: - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - name: - type: string - examples: - - Ball - readOnly: true - pokemon_species: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesSummary' - readOnly: true - required: - - awesome_names - - id - - name - - names - - pokemon_species - PokemonShapeSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonSpeciesDescription: - type: object - properties: - description: - type: string - maxLength: 1000 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - PokemonSpeciesDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - order: - type: - - integer - - 'null' - gender_rate: - type: - - integer - - 'null' - capture_rate: - type: - - integer - - 'null' - base_happiness: - type: - - integer - - 'null' - is_baby: - type: boolean - is_legendary: - type: boolean - is_mythical: - type: boolean - hatch_counter: - type: - - integer - - 'null' - has_gender_differences: - type: boolean - forms_switchable: - type: boolean - growth_rate: - $ref: '#/components/schemas/GrowthRateSummary' - pokedex_numbers: - type: array - items: - $ref: '#/components/schemas/PokemonDexEntry' - readOnly: true - egg_groups: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - monster - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/egg-group/1/ - readOnly: true - color: - $ref: '#/components/schemas/PokemonColorSummary' - shape: - $ref: '#/components/schemas/PokemonShapeSummary' - evolves_from_species: - $ref: '#/components/schemas/PokemonSpeciesSummary' - evolution_chain: - $ref: '#/components/schemas/EvolutionChainSummary' - habitat: - $ref: '#/components/schemas/PokemonHabitatSummary' - generation: - $ref: '#/components/schemas/GenerationSummary' - names: - type: array - items: - type: object - required: - - language - - name - properties: - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - name: - type: string - examples: - - bulbasaur - readOnly: true - pal_park_encounters: - type: array - items: - type: object - required: - - area - - base_score - - rate - properties: - area: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - field - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pal-park-area/2/ - base_score: - type: integer - format: int32 - examples: - - 50 - rate: - type: integer - format: int32 - examples: - - 30 - readOnly: true - form_descriptions: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesDescription' - readOnly: true - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/PokemonSpeciesFlavorText' - readOnly: true - genera: - type: array - items: - type: object - required: - - genus - - language - properties: - genus: - type: string - examples: - - Seed Pokémon - language: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - en - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/language/9/ - readOnly: true - varieties: - type: array - items: - type: object - required: - - is_default - - pokemon - properties: - is_default: - type: boolean - pokemon: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bulbasaur - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokemon/1/ - readOnly: true - required: - - color - - egg_groups - - evolution_chain - - evolves_from_species - - flavor_text_entries - - form_descriptions - - genera - - generation - - growth_rate - - habitat - - id - - name - - names - - pal_park_encounters - - pokedex_numbers - - shape - - varieties - PokemonSpeciesFlavorText: - type: object - properties: - flavor_text: - type: string - language: - $ref: '#/components/schemas/LanguageSummary' - version: - $ref: '#/components/schemas/VersionSummary' - required: - - flavor_text - - language - - version - PokemonSpeciesSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - PokemonStat: - type: object - properties: - base_stat: - type: integer - effort: - type: integer - stat: - $ref: '#/components/schemas/StatSummary' - required: - - base_stat - - effort - - stat - PokemonSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - RegionDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - locations: - type: array - items: - $ref: '#/components/schemas/LocationSummary' - readOnly: true - main_generation: - allOf: - - $ref: '#/components/schemas/GenerationSummary' - readOnly: true - names: - type: array - items: - $ref: '#/components/schemas/RegionName' - readOnly: true - pokedexes: - type: array - items: - $ref: '#/components/schemas/PokedexSummary' - readOnly: true - version_groups: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - red-blue - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/version-group/1/ - readOnly: true - required: - - id - - locations - - main_generation - - name - - names - - pokedexes - - version_groups - RegionName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - RegionSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - StatDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - game_index: - type: integer - is_battle_only: - type: boolean - affecting_moves: - type: object - required: - - decrease - - increase - properties: - increase: - type: array - items: - type: object - required: - - change - - move - properties: - change: - type: integer - format: int32 - examples: - - -1 - move: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - swords-dance - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/14/ - decrease: - type: array - items: - type: object - required: - - change - - move - properties: - change: - type: integer - format: int32 - examples: - - 5 - move: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - growl - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move/45/ - readOnly: true - affecting_natures: - type: object - required: - - increase - - decrease - properties: - increase: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - lonely - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/nature/6/ - decrease: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bold - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/nature/2/ - readOnly: true - characteristics: - type: array - items: - $ref: '#/components/schemas/CharacteristicSummary' - readOnly: true - move_damage_class: - $ref: '#/components/schemas/MoveDamageClassSummary' - names: - type: array - items: - $ref: '#/components/schemas/StatName' - readOnly: true - required: - - affecting_moves - - affecting_natures - - characteristics - - game_index - - id - - move_damage_class - - name - - names - StatName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - StatSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - SuperContestEffectDetail: - type: object - properties: - id: - type: integer - readOnly: true - appeal: - type: integer - flavor_text_entries: - type: array - items: - $ref: '#/components/schemas/SuperContestEffectFlavorText' - readOnly: true - moves: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - readOnly: true - required: - - appeal - - flavor_text_entries - - id - - moves - SuperContestEffectFlavorText: - type: object - properties: - flavor_text: - type: string - maxLength: 500 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - flavor_text - - language - SuperContestEffectSummary: - type: object - properties: - url: - type: string - format: uri - readOnly: true - required: - - url - TypeDetail: - type: object - description: Serializer for the Type resource - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - damage_relations: - type: object - required: - - no_damage_to - - half_damage_to - - double_damage_to - - no_damage_from - - half_damage_from - - double_damage_from - properties: - no_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - flying - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/3/ - half_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bug - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/7/ - double_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - poison - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/4/ - no_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - electric - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/13/ - half_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - poison - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/4/ - double_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - water - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/11/ - readOnly: true - past_damage_relations: - type: array - items: - type: object - required: - - generation - - damage_relations - properties: - generation: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - generation-v - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/generation/5/ - damage_relations: - type: object - required: - - no_damage_to - - half_damage_to - - double_damage_to - - no_damage_from - - half_damage_from - - double_damage_from - properties: - no_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - flying - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/3/ - half_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - bug - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/7/ - double_damage_to: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - poison - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/4/ - no_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - electric - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/13/ - half_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - poison - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/4/ - double_damage_from: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - water - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/type/11/ - readOnly: true - game_indices: - type: array - items: - $ref: '#/components/schemas/TypeGameIndex' - readOnly: true - generation: - $ref: '#/components/schemas/GenerationSummary' - move_damage_class: - $ref: '#/components/schemas/MoveDamageClassSummary' - names: - type: array - items: - $ref: '#/components/schemas/AbilityName' - readOnly: true - pokemon: - type: array - items: - type: object - required: - - potency - - flavor - properties: - slot: - type: integer - examples: - - 1 - pokemon: - type: object - require: - - name - - url - properties: - name: - type: string - description: The name of the pokemon - examples: - - sandshrew - url: - type: string - format: uri - description: The URL to get more information about the pokemon - examples: - - https://pokeapi.co/api/v2/pokemon/27/ - readOnly: true - moves: - type: array - items: - $ref: '#/components/schemas/MoveSummary' - readOnly: true - sprites: - type: object - additionalProperties: - type: object - additionalProperties: - type: object - properties: - name-icon: - type: string - format: uri - examples: - - https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png - examples: - - colosseum: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png - examples: - - generation-ix: - scarlet-violet: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-ix/scarlet-violet/1.png - examples: - - sprites: - generation-iii: - colosseum: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/colosseum/1.png - emerald: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/emerald/1.png - firered-leafgreen: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/firered-leafgreen/1.png - ruby-saphire: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/ruby-saphire/1.png - xd: - name_icon: https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-iii/xd/1.png - readOnly: true - required: - - damage_relations - - game_indices - - generation - - id - - move_damage_class - - moves - - name - - names - - past_damage_relations - - pokemon - - sprites - TypeGameIndex: - type: object - properties: - game_index: - type: integer - generation: - $ref: '#/components/schemas/GenerationSummary' - required: - - game_index - - generation - TypeSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - VersionDetail: - type: object - description: |- - Should have a link to Version Group info but the Circular - dependency and compilation order fight eachother and I'm - not sure how to add anything other than a hyperlink - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - names: - type: array - items: - $ref: '#/components/schemas/VersionName' - readOnly: true - version_group: - $ref: '#/components/schemas/VersionGroupSummary' - required: - - id - - name - - names - - version_group - VersionGroupDetail: - type: object - properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 200 - order: - type: - - integer - - 'null' - generation: - $ref: '#/components/schemas/GenerationSummary' - move_learn_methods: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - level-up - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/move-learn-method/1/ - readOnly: true - pokedexes: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - kanto - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/pokedex/2/ - readOnly: true - regions: - type: array - items: - type: object - required: - - name - - url - properties: - name: - type: string - examples: - - kanto - url: - type: string - format: uri - examples: - - https://pokeapi.co/api/v2/region/1/ - readOnly: true - versions: - type: array - items: - $ref: '#/components/schemas/VersionSummary' - readOnly: true - required: - - generation - - id - - move_learn_methods - - name - - pokedexes - - regions - - versions - VersionGroupSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - VersionName: - type: object - properties: - name: - type: string - maxLength: 200 - language: - $ref: '#/components/schemas/LanguageSummary' - required: - - language - - name - VersionSummary: - type: object - properties: - name: - type: string - maxLength: 200 - url: - type: string - format: uri - readOnly: true - required: - - name - - url - securitySchemes: - basicAuth: - type: http - scheme: basic - cookieAuth: - type: apiKey - in: cookie - name: sessionid -servers: -- url: https://pokeapi.co -tags: -- name: pokemon - description: Pokémon are the creatures that inhabit the world of the Pokémon games. - They can be caught using Pokéballs and trained by battling with other Pokémon. - Each Pokémon belongs to a specific species but may take on a variant which makes - it differ from other Pokémon of the same species, such as base stats, available - abilities and typings. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_(species)) - for greater detail. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon -- name: evolution - description: Evolution is a process in which a Pokémon changes into a different - species of Pokémon. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Evolution -- name: berries - description: Berries can be soft or hard. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Category:Berries_by_firmness) - for greater detail. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Berry -- name: items - description: An item is an object in the games which the player can pick up, keep - in their bag, and use in some manner. They have various uses, including healing, - powering up, helping catch Pokémon, or to access a new area. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Item -- name: machines - description: Machines are the representation of items that teach moves to Pokémon. - They vary from version to version, so it is not certain that one specific TM or - HM corresponds to a single Machine. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/TM -- name: location - description: Locations that can be visited within the games. Locations make up sizable - portions of regions, like cities or routes. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_index_number -- name: contest - description: Pokémon Contests are a type of competition often contrasted with Pokémon - battles and held in Contest Halls - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_Contest -- name: moves - description: Moves are the skills of Pokémon in battle. In battle, a Pokémon uses - one move each turn. Some moves (including those learned by Hidden Machine) can - be used outside of battle as well, usually for the purpose of removing obstacles - or exploring new areas. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/List_of_locations_by_name -- name: encounters -- name: games - description: The Pokémon games are all video games in the Pokémon franchise. - externalDocs: - description: Find more info here - url: https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_games -- name: utility -externalDocs: - url: https://pokeapi.co/docs/v2 diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 5f535c534..0b83efe48 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -2,7 +2,7 @@ "name": "@speakeasy-api/docs-md", "version": "0.2.36", "author": "", - "license": "UNLICENSED", + "license": "Elastic-2.0", "description": "", "type": "module", "bin": { diff --git a/packages/react/LICENSE b/packages/react/LICENSE deleted file mode 100644 index b3411100c..000000000 --- a/packages/react/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2025 Speakeasy - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/packages/react/README.md b/packages/react/README.md index a0f88f5c7..0e7b5a714 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -70,32 +70,6 @@ There are two hooks that are used to get components assigned to slots: It's a little convoluted, and slightly hacky in the React world, but has proven powerful so far. -### Internal vs External Components - -Components are informally divided into two categories: - -- External components: These components are directly referenced by compiled MDX - code. -- Internal components: These components are used by other components in the - library, and not directly referenced in compiled MDX code. - -Both types of components are designed such that they can be overridden. To -support overriding internal components, any other component that references -internal components takes a prop with a component implementation, that defaults -to the internal component implementation. - -For example, the -[`ExpandableCell`](src/components/ExpandableCell/ExpandableCell.tsx) component -takes an -[`ExpandableCellIcon`](src/components/ExpandableCell/types.ts) -prop that defaults to the -[`ExpandableCellIcon`](src/components/ExpandableCellIcon/ExpandableCellIcon.tsx) -component. If you wish to provide a custom icon, you can pass in a custom -component to this prop. - -Most components are external components, a few are internal components, and -[`Pill`](src/components/Pill/Pill.tsx) is used both internally and externally. - ### Component-Specific Documentation See the source code for each component in the [src/components](src/components) diff --git a/packages/react/package.json b/packages/react/package.json index b9f467941..2328af73a 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -2,7 +2,7 @@ "name": "@speakeasy-api/docs-md-react", "version": "0.2.36", "author": "Speakeasy", - "license": "MIT", + "license": "Elastic-2.0", "description": "React components used with Speakeasy's DocsMD product", "type": "module", "exports": { diff --git a/packages/shared/package.json b/packages/shared/package.json index d7db3c5e6..ea2ff5366 100644 --- a/packages/shared/package.json +++ b/packages/shared/package.json @@ -2,7 +2,7 @@ "name": "@speakeasy-api/docs-md-shared", "version": "0.2.36", "author": "", - "license": "UNLICENSED", + "license": "Elastic-2.0", "description": "", "exports": { ".": { diff --git a/packages/web-components/package.json b/packages/web-components/package.json index 3b9a2d321..4141d744c 100644 --- a/packages/web-components/package.json +++ b/packages/web-components/package.json @@ -2,7 +2,7 @@ "name": "@speakeasy-api/docs-md-components", "version": "0.2.36", "author": "Speakeasy", - "license": "MIT", + "license": "Elastic-2.0", "description": "Web components used with Speakeasy's DocsMD product", "type": "module", "exports": { From cfc893cf79ad91b5cec457dc0d33ed8c033fea45 Mon Sep 17 00:00:00 2001 From: Adam Bull Date: Wed, 5 Nov 2025 16:40:56 +0000 Subject: [PATCH 2/2] feat: rm github --- .github/workflows/examples.yaml | 128 -------------------------------- .github/workflows/packages.yaml | 95 ------------------------ 2 files changed, 223 deletions(-) delete mode 100644 .github/workflows/examples.yaml delete mode 100644 .github/workflows/packages.yaml diff --git a/.github/workflows/examples.yaml b/.github/workflows/examples.yaml deleted file mode 100644 index fef9c3b62..000000000 --- a/.github/workflows/examples.yaml +++ /dev/null @@ -1,128 +0,0 @@ -name: Examples - -on: - push: - branches: [main] - pull_request: - branches: [main, new-try-it-now] - merge_group: - -jobs: - prepare-context: - name: Prepare Example Build Context - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - # Needed to copy the WASM file during Docs MD build - lfs: true - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: "24" - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "pypy3.9" - - name: Cache node_modules - id: cache-node-modules - uses: actions/cache@v4 - with: - path: "**/node_modules" - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - - name: Install dependencies - if: steps.cache-node-modules.outputs.cache-hit != 'true' - run: npm ci --ignore-scripts - - name: Cache pip - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - - name: Install Python dependencies - run: | - python -m pip install -r requirements.txt - - name: Build Packages - run: make build-packages - - name: Archive build artifacts - run: | - tar -czf build-artifacts.tar.gz packages/compiler/dist packages/react/dist packages/shared/dist - - name: Upload build artifacts - uses: actions/upload-artifact@v4 - with: - name: build-artifacts - path: build-artifacts.tar.gz - - verify-examples: - name: Verify ${{ matrix.display }} - runs-on: ubuntu-latest - needs: prepare-context - strategy: - fail-fast: true - matrix: - include: - - display: Docusaurus - workspace: examples/docusaurus - - display: Custom (Next.js) - workspace: examples/custom - - display: Nextra - workspace: examples/nextra - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - lfs: true - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: "24" - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "pypy3.9" - - name: Cache pip - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - - name: Install Python dependencies - run: | - python -m pip install -r requirements.txt - - name: Restore node_modules cache - uses: actions/cache/restore@v4 - with: - path: "**/node_modules" - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - - name: Download build artifacts - uses: actions/download-artifact@v4 - with: - name: build-artifacts - - name: Restore build artifacts - run: tar -xzf build-artifacts.tar.gz - # Re-run install to link local binaries after build - - name: Link local packages - run: npm install --workspace ${{ matrix.workspace }} - - name: Build example docs - run: npm run build-api-docs --workspace ${{ matrix.workspace }} - - name: Validate repository is clean - run: | - if ! git diff --exit-code --quiet ${{ matrix.workspace }}; then - git status ${{ matrix.workspace }} - git --no-pager diff ${{ matrix.workspace }} - echo "Example build out of date for ${{ matrix.workspace }}. Please run make build-api-docs and commit the results." - exit 1 - fi - - verify-examples-success: - name: Example Build Verification - runs-on: ubuntu-latest - needs: verify-examples - if: always() - steps: - - name: Check if example docs builds successful - if: needs.verify-examples.result != 'success' - run: exit 1 diff --git a/.github/workflows/packages.yaml b/.github/workflows/packages.yaml deleted file mode 100644 index 44ea6d61f..000000000 --- a/.github/workflows/packages.yaml +++ /dev/null @@ -1,95 +0,0 @@ -name: Packages - -on: - push: - branches: [main] - pull_request: - branches: [main, new-try-it-now] - merge_group: - -jobs: - lint-and-check: - name: Lint and Type Check - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - with: - lfs: true - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: "24" - cache: "npm" - - name: Install dependencies - run: npm ci - - name: Build packages - run: make build-packages - - name: Type check - run: make type-check-packages - - name: Lint - run: make lint-packages - - name: Check formatting - run: make check-formatting-packages - - name: Verify package versions - run: make verify-package-versions - - integration-tests: - name: Integration Tests - ${{ matrix.example }} - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - example: [docusaurus, nextra] - - steps: - - uses: actions/checkout@v4 - with: - # Needed to copy the WASM file during build - lfs: true - - name: Set up Node.js - uses: actions/setup-node@v4 - with: - node-version: "24" - cache: "npm" - - name: Install dependencies - run: npm ci - - name: Build packages - run: make build-packages - - name: Build example - run: npm run build --workspace examples/${{ matrix.example }} --ignore-scripts - - name: Get Playwright version - id: playwright-version - run: echo "version=$(npx playwright --version | sed 's/Version //')" >> $GITHUB_OUTPUT - working-directory: tests/integration/${{ matrix.example }} - - name: Cache Playwright browsers - uses: actions/cache@v4 - id: playwright-cache - with: - path: ~/.cache/ms-playwright - key: ${{ runner.os }}-playwright-${{ steps.playwright-version.outputs.version }} - - name: Install Playwright browsers - if: steps.playwright-cache.outputs.cache-hit != 'true' - run: npx playwright install --with-deps - working-directory: tests/integration/${{ matrix.example }} - - name: Run Playwright tests - run: npm test - working-directory: tests/integration/${{ matrix.example }} - - name: Upload test results - if: failure() - uses: actions/upload-artifact@v4 - with: - name: playwright-report-${{ matrix.example }} - path: tests/integration/${{ matrix.example }}/playwright-report/ - retention-days: 30 - - # Summary job for branch protection - packages-success: - name: Packages Build and Lint - runs-on: ubuntu-latest - needs: [lint-and-check, integration-tests] - if: always() - steps: - - name: Check if all jobs succeeded - if: needs.lint-and-check.result != 'success' || needs.integration-tests.result != 'success' - run: exit 1